begriffs open source - cmsis-freertos/blob - v11.0.1/group__freertos__evr__heap.html

   1 <!-- HTML header for doxygen 1.9.2-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-FreeRTOS: Heap Functions</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="footer.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20 <script type="text/javascript">
  21 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  22   $(document).ready(function() { init_search(); });
  23 /* @license-end */
  24 </script>
  25 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  26 <link href="version.css" rel="stylesheet" type="text/css" />
  27 <script type="text/javascript" src="../version.js"></script>
  28 </head>
  29 <body>
  30 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  31 <div id="titlearea">
  32 <table cellspacing="0" cellpadding="0">
  33  <tbody>
  34  <tr style="height: 55px;">
  35   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  36   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  37    <div id="projectname">CMSIS-FreeRTOS
  38    &#160;<span id="projectnumber"><script type="text/javascript">
  39      <!--
  40      writeHeader.call(this);
  41      writeVersionDropdown(this);
  42      //-->
  43     </script>
  44    </span>
  45    </div>
  46    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  47   </td>
  48   <!--END !PROJECT_NAME-->
  49    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  50         <span class="left">
  51           <img id="MSearchSelect" src="search/mag_sel.svg"
  52                onmouseover="return searchBox.OnSearchSelectShow()"
  53                onmouseout="return searchBox.OnSearchSelectHide()"
  54                alt=""/>
  55           <input type="text" id="MSearchField" value="Search" accesskey="S"
  56                onfocus="searchBox.OnSearchFieldFocus(true)"
  57                onblur="searchBox.OnSearchFieldFocus(false)"
  58                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  59           </span><span class="right">
  60             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  61           </span>
  62         </div>
  63 </td>
  64  </tr>
  65  </tbody>
  66 </table>
  67 </div>
  68 <!-- end header part -->
  69 <!-- Generated by Doxygen 1.9.2 -->
  70 <script type="text/javascript">
  71 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  72 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  73 /* @license-end */
  74 </script>
  75 </div><!-- top -->
  76 <div id="side-nav" class="ui-resizable side-nav-resizable">
  77   <div id="nav-tree">
  78     <div id="nav-tree-contents">
  79       <div id="nav-sync" class="sync"></div>
  80     </div>
  81   </div>
  82   <div id="splitbar" style="-moz-user-select:none;"
  83        class="ui-resizable-handle">
  84   </div>
  85 </div>
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 $(document).ready(function(){initNavTree('group__freertos__evr__heap.html',''); initResizable(); });
  89 /* @license-end */
  90 </script>
  91 <div id="doc-content">
  92 <!-- window showing the filter options -->
  93 <div id="MSearchSelectWindow"
  94      onmouseover="return searchBox.OnSearchSelectShow()"
  95      onmouseout="return searchBox.OnSearchSelectHide()"
  96      onkeydown="return searchBox.OnSearchSelectKey(event)">
  97 </div>
  98
  99 <!-- iframe showing the search results (closed by default) -->
 100 <div id="MSearchResultsWindow">
 101 <iframe src="javascript:void(0)" frameborder="0"
 102         name="MSearchResults" id="MSearchResults">
 103 </iframe>
 104 </div>
 105
 106 <div class="header">
 107   <div class="summary">
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">Heap Functions<div class="ingroups"><a class="el" href="group__freertos__specific.html">CMSIS-FreeRTOS Specifics</a> &raquo; <a class="el" href="group__freertos__evr.html">Event functions</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>Events generated by heap functions.
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 117 Functions</h2></td></tr>
 118 <tr class="memitem:gabf9e533034d251bde5d30956cc7b3ce4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__heap.html#gabf9e533034d251bde5d30956cc7b3ce4">EvrFreeRTOSHeap_Malloc</a> (void *pvAddress, uint32_t uiSize)</td></tr>
 119 <tr class="memdesc:gabf9e533034d251bde5d30956cc7b3ce4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on heap memory block allocation (Op)  <a href="group__freertos__evr__heap.html#gabf9e533034d251bde5d30956cc7b3ce4">More...</a><br /></td></tr>
 120 <tr class="separator:gabf9e533034d251bde5d30956cc7b3ce4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:gac36dd2e9cc21058419c5c7eb31ab2a84"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__heap.html#gac36dd2e9cc21058419c5c7eb31ab2a84">EvrFreeRTOSHeap_Free</a> (void *pvAddress, uint32_t uiSize)</td></tr>
 122 <tr class="memdesc:gac36dd2e9cc21058419c5c7eb31ab2a84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on heap memory block free (Op)  <a href="group__freertos__evr__heap.html#gac36dd2e9cc21058419c5c7eb31ab2a84">More...</a><br /></td></tr>
 123 <tr class="separator:gac36dd2e9cc21058419c5c7eb31ab2a84"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 </table>
 125 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 126 <p >Events generated by heap functions. </p>
 127 <h2 class="groupheader">Function Documentation</h2>
 128 <a id="gac36dd2e9cc21058419c5c7eb31ab2a84" name="gac36dd2e9cc21058419c5c7eb31ab2a84"></a>
 129 <h2 class="memtitle"><span class="permalink"><a href="#gac36dd2e9cc21058419c5c7eb31ab2a84">&#9670;&nbsp;</a></span>EvrFreeRTOSHeap_Free()</h2>
 130
 131 <div class="memitem">
 132 <div class="memproto">
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">void EvrFreeRTOSHeap_Free </td>
 136           <td>(</td>
 137           <td class="paramtype">void *&#160;</td>
 138           <td class="paramname"><em>pvAddress</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype">uint32_t&#160;</td>
 144           <td class="paramname"><em>uiSize</em>&#160;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td>
 150         </tr>
 151       </table>
 152 </div><div class="memdoc">
 153
 154 <p>Event on heap memory block free (Op) </p>
 155 <dl class="params"><dt>Parameters</dt><dd>
 156   <table class="params">
 157     <tr><td class="paramdir">[in]</td><td class="paramname">pvAddress</td><td>pointer to memory block. </td></tr>
 158     <tr><td class="paramdir">[in]</td><td class="paramname">uiSize</td><td>memory block size.</td></tr>
 159   </table>
 160   </dd>
 161 </dl>
 162 <p>The event <b>Heap_Free</b> is generated when a memory block previously allocated by malloc is deallocated.</p>
 163 <p ><b>Value</b> in the Event Recorder shows:</p><ul>
 164 <li><b>pvAddress</b> : pointer to deallocated memory block.</li>
 165 <li><b>uiSize</b> : memory block size in bytes. </li>
 166 </ul>
 167
 168 </div>
 169 </div>
 170 <a id="gabf9e533034d251bde5d30956cc7b3ce4" name="gabf9e533034d251bde5d30956cc7b3ce4"></a>
 171 <h2 class="memtitle"><span class="permalink"><a href="#gabf9e533034d251bde5d30956cc7b3ce4">&#9670;&nbsp;</a></span>EvrFreeRTOSHeap_Malloc()</h2>
 172
 173 <div class="memitem">
 174 <div class="memproto">
 175       <table class="memname">
 176         <tr>
 177           <td class="memname">void EvrFreeRTOSHeap_Malloc </td>
 178           <td>(</td>
 179           <td class="paramtype">void *&#160;</td>
 180           <td class="paramname"><em>pvAddress</em>, </td>
 181         </tr>
 182         <tr>
 183           <td class="paramkey"></td>
 184           <td></td>
 185           <td class="paramtype">uint32_t&#160;</td>
 186           <td class="paramname"><em>uiSize</em>&#160;</td>
 187         </tr>
 188         <tr>
 189           <td></td>
 190           <td>)</td>
 191           <td></td><td></td>
 192         </tr>
 193       </table>
 194 </div><div class="memdoc">
 195
 196 <p>Event on heap memory block allocation (Op) </p>
 197 <dl class="params"><dt>Parameters</dt><dd>
 198   <table class="params">
 199     <tr><td class="paramdir">[in]</td><td class="paramname">pvAddress</td><td>pointer to memory block. </td></tr>
 200     <tr><td class="paramdir">[in]</td><td class="paramname">uiSize</td><td>memory block size.</td></tr>
 201   </table>
 202   </dd>
 203 </dl>
 204 <p>The event <b>Heap_Malloc</b> is generated when a heap memory block is successfully allocated.</p>
 205 <p ><b>Value</b> in the Event Recorder shows:</p><ul>
 206 <li><b>pvAddress</b> : pointer to allocated memory block.</li>
 207 <li><b>uiSize</b> : memory block size in bytes. </li>
 208 </ul>
 209
 210 </div>
 211 </div>
 212 </div><!-- contents -->
 213 </div><!-- doc-content -->
 214 <!-- start footer part -->
 215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 216   <ul>
 217     <li class="footer">
 218       <script type="text/javascript">
 219         <!--
 220         writeFooter.call(this);
 221         //-->
 222       </script>
 223     </li>
 224   </ul>
 225 </div>
 226 </body>
 227 </html>