122 lines
10 KiB
HTML
122 lines
10 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>RTOS_MSPM0: RTOS_Labs_common/heap.h Source File</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="RobotSensors.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">RTOS_MSPM0
|
||
|
|
 <span id="projectnumber">1.1</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">ECE445M starter code</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_d9737668015ddda3d9b152d7c8d1103c.html">RTOS_Labs_common</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">heap.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="heap_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
|
||
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef HEAP_H</span></div>
|
||
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define HEAP_H</span></div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <stdint.h></span></div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// struct for holding statistics on the state of the heap</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structheap__stats.html"> 19</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structheap__stats.html">heap_stats</a> {</div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  uint32_t size; <span class="comment">// heap size (in bytes)</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  uint32_t used; <span class="comment">// number of bytes used/allocated</span></div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  uint32_t free; <span class="comment">// number of bytes available to allocate</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> } <a class="code" href="structheap__stats.html">heap_stats_t</a>;</div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="heap_8h.html#a927f9f9522b87a3ccaee6c68efbf2081"> 33</a></span> int32_t <a class="code" href="heap_8h.html#a927f9f9522b87a3ccaee6c68efbf2081">Heap_Init</a>(<span class="keywordtype">void</span>);</div>
|
||
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="heap_8h.html#a178556e87b1f3e4c72b419d2c02cd1d4"> 43</a></span> <span class="keywordtype">void</span>* <a class="code" href="heap_8h.html#a178556e87b1f3e4c72b419d2c02cd1d4">Heap_Malloc</a>(int32_t desiredBytes);</div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="heap_8h.html#a2844e924abca6846ed9407e57ed828ab"> 53</a></span> <span class="keywordtype">void</span>* <a class="code" href="heap_8h.html#a2844e924abca6846ed9407e57ed828ab">Heap_Calloc</a>(int32_t desiredBytes);</div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="heap_8h.html#af02282279b1745e0e1485c5bc7d19098"> 65</a></span> <span class="keywordtype">void</span>* <a class="code" href="heap_8h.html#af02282279b1745e0e1485c5bc7d19098">Heap_Realloc</a>(<span class="keywordtype">void</span>* oldBlock, int32_t desiredBytes);</div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
||
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="heap_8h.html#a0c2946e20398909f89ebf1bc344b9f60"> 75</a></span> int32_t <a class="code" href="heap_8h.html#a0c2946e20398909f89ebf1bc344b9f60">Heap_Free</a>(<span class="keywordtype">void</span>* pointer);</div>
|
||
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="heap_8h.html#a9c528dbd61f8df446f759961e3c09396"> 84</a></span> int32_t <a class="code" href="heap_8h.html#a9c528dbd61f8df446f759961e3c09396">Heap_Stats</a>(<a class="code" href="structheap__stats.html">heap_stats_t</a> *stats);</div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
||
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif </span><span class="comment">//#ifndef HEAP_H</span></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_a0c2946e20398909f89ebf1bc344b9f60"><div class="ttname"><a href="heap_8h.html#a0c2946e20398909f89ebf1bc344b9f60">Heap_Free</a></div><div class="ttdeci">int32_t Heap_Free(void *pointer)</div><div class="ttdoc">Free memory.</div></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_a178556e87b1f3e4c72b419d2c02cd1d4"><div class="ttname"><a href="heap_8h.html#a178556e87b1f3e4c72b419d2c02cd1d4">Heap_Malloc</a></div><div class="ttdeci">void * Heap_Malloc(int32_t desiredBytes)</div><div class="ttdoc">Allocate memory.</div></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_a2844e924abca6846ed9407e57ed828ab"><div class="ttname"><a href="heap_8h.html#a2844e924abca6846ed9407e57ed828ab">Heap_Calloc</a></div><div class="ttdeci">void * Heap_Calloc(int32_t desiredBytes)</div><div class="ttdoc">Zero-allocate memory.</div></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_a927f9f9522b87a3ccaee6c68efbf2081"><div class="ttname"><a href="heap_8h.html#a927f9f9522b87a3ccaee6c68efbf2081">Heap_Init</a></div><div class="ttdeci">int32_t Heap_Init(void)</div><div class="ttdoc">Initializes/resets the heap to a clean state where no memory is allocated.</div></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_a9c528dbd61f8df446f759961e3c09396"><div class="ttname"><a href="heap_8h.html#a9c528dbd61f8df446f759961e3c09396">Heap_Stats</a></div><div class="ttdeci">int32_t Heap_Stats(heap_stats_t *stats)</div><div class="ttdoc">Get heap usage.</div></div>
|
||
|
|
<div class="ttc" id="aheap_8h_html_af02282279b1745e0e1485c5bc7d19098"><div class="ttname"><a href="heap_8h.html#af02282279b1745e0e1485c5bc7d19098">Heap_Realloc</a></div><div class="ttdeci">void * Heap_Realloc(void *oldBlock, int32_t desiredBytes)</div><div class="ttdoc">Grow/shrink memory.</div></div>
|
||
|
|
<div class="ttc" id="astructheap__stats_html"><div class="ttname"><a href="structheap__stats.html">heap_stats</a></div><div class="ttdef"><b>Definition:</b> heap.h:19</div></div>
|
||
|
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|