MCB1700_Welcome/Doxygen/html/heap__1_8c.html

340 lines
17 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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: heap_1.c File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('heap__1_8c.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">heap_1.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;<a class="el" href="_free_r_t_o_s_8h_source.html">FreeRTOS.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="task_8h_source.html">task.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for heap_1.c:</div>
<div class="dyncontent">
<div class="center"><img src="heap__1_8c__incl.png" border="0" usemap="#aheap__1_8c" alt=""/></div>
<map name="heap__1_8c" id="aheap__1_8c">
<area shape="rect" title=" " alt="" coords="275,5,349,32"/>
<area shape="rect" title=" " alt="" coords="176,80,240,107"/>
<area shape="rect" href="_free_r_t_o_s_8h.html" title=" " alt="" coords="265,80,359,107"/>
<area shape="rect" href="task_8h.html" title=" " alt="" coords="495,80,553,107"/>
<area shape="rect" title=" " alt="" coords="5,155,75,181"/>
<area shape="rect" title=" " alt="" coords="99,155,165,181"/>
<area shape="rect" href="_free_r_t_o_s_config_8h.html" title=" " alt="" coords="189,155,323,181"/>
<area shape="rect" href="projdefs_8h.html" title=" " alt="" coords="347,155,426,181"/>
<area shape="rect" href="portable_8h.html" title=" " alt="" coords="451,155,531,181"/>
<area shape="rect" title=" " alt="" coords="99,229,186,256"/>
<area shape="rect" title=" " alt="" coords="211,229,301,256"/>
<area shape="rect" href="deprecated__definitions_8h.html" title=" " alt="" coords="325,229,488,256"/>
<area shape="rect" href="portmacro_8h.html" title=" " alt="" coords="513,229,605,256"/>
<area shape="rect" href="mpu__wrappers_8h.html" title=" " alt="" coords="629,229,747,256"/>
<area shape="rect" href="list_8h.html" title=" " alt="" coords="555,155,605,181"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ab622d8c674f2a417a666a7ed89109e79"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#ab622d8c674f2a417a666a7ed89109e79">MPU_WRAPPERS_INCLUDED_FROM_API_FILE</a></td></tr>
<tr class="separator:ab622d8c674f2a417a666a7ed89109e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e68bebe7509a99550e1358cbca8e23f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a3e68bebe7509a99550e1358cbca8e23f">configADJUSTED_HEAP_SIZE</a>&#160;&#160;&#160;( <a class="el" href="_free_r_t_o_s_config_8h.html#a9f213227674effff0122a75d94d87938">configTOTAL_HEAP_SIZE</a> - <a class="el" href="portmacro_8h.html#ab9091ce3940d8bd93ec850122a2c6a1c">portBYTE_ALIGNMENT</a> )</td></tr>
<tr class="separator:a3e68bebe7509a99550e1358cbca8e23f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0379669d07d76cc81e3028123113b271"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a0379669d07d76cc81e3028123113b271">pvPortMalloc</a> (size_t xWantedSize)</td></tr>
<tr class="separator:a0379669d07d76cc81e3028123113b271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e7cea2fd1bc894ea3b5f5e8179d259b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a1e7cea2fd1bc894ea3b5f5e8179d259b">vPortFree</a> (void *pv)</td></tr>
<tr class="separator:a1e7cea2fd1bc894ea3b5f5e8179d259b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bf103ce32ce8473574e9920af8b4eec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a8bf103ce32ce8473574e9920af8b4eec">vPortInitialiseBlocks</a> (void)</td></tr>
<tr class="separator:a8bf103ce32ce8473574e9920af8b4eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c28a12b313bc248be0cb7a37ed81bb7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a0c28a12b313bc248be0cb7a37ed81bb7">xPortGetFreeHeapSize</a> (void)</td></tr>
<tr class="separator:a0c28a12b313bc248be0cb7a37ed81bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a286aa29b13471f0d9f5a7ce688682694"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a286aa29b13471f0d9f5a7ce688682694">ucHeap</a> [<a class="el" href="_free_r_t_o_s_config_8h.html#a9f213227674effff0122a75d94d87938">configTOTAL_HEAP_SIZE</a>]</td></tr>
<tr class="separator:a286aa29b13471f0d9f5a7ce688682694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f84d71523e492ed69679829b2d827c4"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="heap__1_8c.html#a9f84d71523e492ed69679829b2d827c4">xNextFreeByte</a> = ( size_t ) 0</td></tr>
<tr class="separator:a9f84d71523e492ed69679829b2d827c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a3e68bebe7509a99550e1358cbca8e23f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e68bebe7509a99550e1358cbca8e23f">&#9670;&nbsp;</a></span>configADJUSTED_HEAP_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define configADJUSTED_HEAP_SIZE&#160;&#160;&#160;( <a class="el" href="_free_r_t_o_s_config_8h.html#a9f213227674effff0122a75d94d87938">configTOTAL_HEAP_SIZE</a> - <a class="el" href="portmacro_8h.html#ab9091ce3940d8bd93ec850122a2c6a1c">portBYTE_ALIGNMENT</a> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab622d8c674f2a417a666a7ed89109e79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab622d8c674f2a417a666a7ed89109e79">&#9670;&nbsp;</a></span>MPU_WRAPPERS_INCLUDED_FROM_API_FILE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0379669d07d76cc81e3028123113b271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0379669d07d76cc81e3028123113b271">&#9670;&nbsp;</a></span>pvPortMalloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* pvPortMalloc </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>xWantedSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="heap__1_8c_a0379669d07d76cc81e3028123113b271_cgraph.png" border="0" usemap="#aheap__1_8c_a0379669d07d76cc81e3028123113b271_cgraph" alt=""/></div>
<map name="heap__1_8c_a0379669d07d76cc81e3028123113b271_cgraph" id="aheap__1_8c_a0379669d07d76cc81e3028123113b271_cgraph">
<area shape="rect" title=" " alt="" coords="5,31,104,57"/>
<area shape="rect" href="task_8h.html#a366b302eba79d10b5ee2a3756f0fcc43" title=" " alt="" coords="152,5,275,32"/>
<area shape="rect" href="task_8h.html#a003f8ae6d649225abd030cc76e1c7d0e" title=" " alt="" coords="153,56,273,83"/>
<area shape="rect" href="tasks_8c.html#ad1b2e4995f863a99cf980836efe330d7" title=" " alt="" coords="323,5,531,32"/>
<area shape="rect" href="list_8c.html#a274fdced76bbdd9d8a4c4840ded2920c" title=" " alt="" coords="579,81,683,108"/>
<area shape="rect" href="tasks_8c.html#a54f31e9aef0eb7b87e48c7d68ecc84c1" title=" " alt="" coords="357,107,497,133"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="heap__1_8c_a0379669d07d76cc81e3028123113b271_icgraph.png" border="0" usemap="#aheap__1_8c_a0379669d07d76cc81e3028123113b271_icgraph" alt=""/></div>
<map name="heap__1_8c_a0379669d07d76cc81e3028123113b271_icgraph" id="aheap__1_8c_a0379669d07d76cc81e3028123113b271_icgraph">
<area shape="rect" title=" " alt="" coords="244,56,343,83"/>
<area shape="rect" href="event__groups_8c.html#a2e8622ce280fff2f60ad867dff0a4519" title=" " alt="" coords="33,5,169,32"/>
<area shape="rect" href="queue_8c.html#ac999cdfbb09fff396fa818bb9a30b4e5" title=" " alt="" coords="25,56,176,83"/>
<area shape="rect" href="stream__buffer_8h.html#a7a613c6fa11323c871ce7991db214096" title=" " alt="" coords="5,107,196,133"/>
</map>
</div>
</div>
</div>
<a id="a1e7cea2fd1bc894ea3b5f5e8179d259b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e7cea2fd1bc894ea3b5f5e8179d259b">&#9670;&nbsp;</a></span>vPortFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vPortFree </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>pv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="heap__1_8c_a1e7cea2fd1bc894ea3b5f5e8179d259b_icgraph.png" border="0" usemap="#aheap__1_8c_a1e7cea2fd1bc894ea3b5f5e8179d259b_icgraph" alt=""/></div>
<map name="heap__1_8c_a1e7cea2fd1bc894ea3b5f5e8179d259b_icgraph" id="aheap__1_8c_a1e7cea2fd1bc894ea3b5f5e8179d259b_icgraph">
<area shape="rect" title=" " alt="" coords="673,107,753,133"/>
<area shape="rect" href="tasks_8c.html#ad538c599036f7914942471780230ffa6" title=" " alt="" coords="500,31,607,57"/>
<area shape="rect" href="event__groups_8h.html#a50cb52d1c81b063fd8d94f5293dcfea9" title=" " alt="" coords="486,81,621,108"/>
<area shape="rect" href="queue_8h.html#a707cbcfe3aed6b877b6aa6d9d75a3f22" title=" " alt="" coords="501,132,606,159"/>
<area shape="rect" href="stream__buffer_8h.html#a05dc9d2ae220a050526a062eddf6d7a2" title=" " alt="" coords="481,183,625,209"/>
<area shape="rect" href="tasks_8c.html#a903096c962a2bc907f4b902a7d42302a" title=" " alt="" coords="209,5,433,32"/>
<area shape="rect" href="tasks_8c.html#af9cf8dedc1248f4351d3cb5910e33d7a" title=" " alt="" coords="274,56,369,83"/>
<area shape="rect" href="tasks_8c.html#a36c7cc58985d41c2cb1b263563dbbaa1" title=" " alt="" coords="5,5,161,32"/>
</map>
</div>
</div>
</div>
<a id="a8bf103ce32ce8473574e9920af8b4eec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bf103ce32ce8473574e9920af8b4eec">&#9670;&nbsp;</a></span>vPortInitialiseBlocks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vPortInitialiseBlocks </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0c28a12b313bc248be0cb7a37ed81bb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c28a12b313bc248be0cb7a37ed81bb7">&#9670;&nbsp;</a></span>xPortGetFreeHeapSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t xPortGetFreeHeapSize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a286aa29b13471f0d9f5a7ce688682694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a286aa29b13471f0d9f5a7ce688682694">&#9670;&nbsp;</a></span>ucHeap</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t ucHeap[<a class="el" href="_free_r_t_o_s_config_8h.html#a9f213227674effff0122a75d94d87938">configTOTAL_HEAP_SIZE</a>]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9f84d71523e492ed69679829b2d827c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f84d71523e492ed69679829b2d827c4">&#9670;&nbsp;</a></span>xNextFreeByte</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t xNextFreeByte = ( size_t ) 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="heap__1_8c.html">heap_1.c</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>