group__rtx__evr__memory.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Memory Functions</title>
  7. <title>CMSIS-RTOS2: Memory Functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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="printComponentTabs.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="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__rtx__evr__memory.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Memory Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Events generated memory functions.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  118. Functions</h2></td></tr>
  119. <tr class="memitem:ga15078f1251744140d90761e05c0fe1f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga15078f1251744140d90761e05c0fe1f2">EvrRtxMemoryInit</a> (void *mem, uint32_t size, uint32_t result)</td></tr>
  120. <tr class="memdesc:ga15078f1251744140d90761e05c0fe1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory initialization (Op) <a href="#ga15078f1251744140d90761e05c0fe1f2">More...</a><br/></td></tr>
  121. <tr class="separator:ga15078f1251744140d90761e05c0fe1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gae1818917a5e085f92a03039ffaf2bad4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#gae1818917a5e085f92a03039ffaf2bad4">EvrRtxMemoryAlloc</a> (void *mem, uint32_t size, uint32_t type, void *block)</td></tr>
  123. <tr class="memdesc:gae1818917a5e085f92a03039ffaf2bad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory allocate (Op) <a href="#gae1818917a5e085f92a03039ffaf2bad4">More...</a><br/></td></tr>
  124. <tr class="separator:gae1818917a5e085f92a03039ffaf2bad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga9227b18f5ea44d7caa8fadd4d539af9c">EvrRtxMemoryFree</a> (void *mem, void *block, uint32_t result)</td></tr>
  126. <tr class="memdesc:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory free (Op) <a href="#ga9227b18f5ea44d7caa8fadd4d539af9c">More...</a><br/></td></tr>
  127. <tr class="separator:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#gac71421bbf537f2f8c9255f9f51cf7d54">EvrRtxMemoryBlockInit</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, uint32_t block_count, uint32_t block_size, void *block_mem)</td></tr>
  129. <tr class="memdesc:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block initialization (Op) <a href="#gac71421bbf537f2f8c9255f9f51cf7d54">More...</a><br/></td></tr>
  130. <tr class="separator:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga71c0df6f932436b54d7d641a440586db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga71c0df6f932436b54d7d641a440586db">EvrRtxMemoryBlockAlloc</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, void *block)</td></tr>
  132. <tr class="memdesc:ga71c0df6f932436b54d7d641a440586db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block alloc (Op) <a href="#ga71c0df6f932436b54d7d641a440586db">More...</a><br/></td></tr>
  133. <tr class="separator:ga71c0df6f932436b54d7d641a440586db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ga69c2139620def7c5e59f6b1249857949"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga69c2139620def7c5e59f6b1249857949">EvrRtxMemoryBlockFree</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, void *block, int32_t status)</td></tr>
  135. <tr class="memdesc:ga69c2139620def7c5e59f6b1249857949"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block free (Op) <a href="#ga69c2139620def7c5e59f6b1249857949">More...</a><br/></td></tr>
  136. <tr class="separator:ga69c2139620def7c5e59f6b1249857949"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  139. <h2 class="groupheader">Function Documentation</h2>
  140. <a class="anchor" id="ga15078f1251744140d90761e05c0fe1f2"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">void EvrRtxMemoryInit </td>
  146. <td>(</td>
  147. <td class="paramtype">void *&#160;</td>
  148. <td class="paramname"><em>mem</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">uint32_t&#160;</td>
  154. <td class="paramname"><em>size</em>, </td>
  155. </tr>
  156. <tr>
  157. <td class="paramkey"></td>
  158. <td></td>
  159. <td class="paramtype">uint32_t&#160;</td>
  160. <td class="paramname"><em>result</em>&#160;</td>
  161. </tr>
  162. <tr>
  163. <td></td>
  164. <td>)</td>
  165. <td></td><td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <dl class="params"><dt>Parameters</dt><dd>
  170. <table class="params">
  171. <tr><td class="paramdir">[in]</td><td class="paramname">mem</td><td>pointer to memory pool. </td></tr>
  172. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>size of a memory pool in bytes. </td></tr>
  173. <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>execution status: 1 - success, 0 - failure.</td></tr>
  174. </table>
  175. </dd>
  176. </dl>
  177. <p>The event <b>MemoryInit</b> is generated when initialization of a variable size memory block completes.</p>
  178. <p><b>Value</b> in the Event Recorder shows:</p>
  179. <ul>
  180. <li><b>mem</b> : memory address of memory pool.</li>
  181. <li><b>size</b> : size of a memory pool in bytes.</li>
  182. <li><b>result</b> : execution status: 1 - success, 0 - failure. </li>
  183. </ul>
  184. </div>
  185. </div>
  186. <a class="anchor" id="gae1818917a5e085f92a03039ffaf2bad4"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">void EvrRtxMemoryAlloc </td>
  192. <td>(</td>
  193. <td class="paramtype">void *&#160;</td>
  194. <td class="paramname"><em>mem</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">uint32_t&#160;</td>
  200. <td class="paramname"><em>size</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">uint32_t&#160;</td>
  206. <td class="paramname"><em>type</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype">void *&#160;</td>
  212. <td class="paramname"><em>block</em>&#160;</td>
  213. </tr>
  214. <tr>
  215. <td></td>
  216. <td>)</td>
  217. <td></td><td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <tr><td class="paramdir">[in]</td><td class="paramname">mem</td><td>pointer to memory pool. </td></tr>
  224. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>size of a memory block in bytes. </td></tr>
  225. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>memory block type: 0 - generic, 1 - control block. </td></tr>
  226. <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>pointer to allocated memory block or NULL in case of no memory is available.</td></tr>
  227. </table>
  228. </dd>
  229. </dl>
  230. <p>The event <b>MemoryAlloc</b> is generated when allocation of a variable size memory block completes.</p>
  231. <p><b>Value</b> in the Event Recorder shows:</p>
  232. <ul>
  233. <li><b>mem</b> : memory address of memory pool.</li>
  234. <li><b>size</b> : size of a memory block in bytes.</li>
  235. <li><b>type</b> : memory block type: 0 - generic, 1 - control block</li>
  236. <li><b>block</b> : memory address of allocated memory block or 0 in case of no memory is available. </li>
  237. </ul>
  238. </div>
  239. </div>
  240. <a class="anchor" id="ga9227b18f5ea44d7caa8fadd4d539af9c"></a>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">void EvrRtxMemoryFree </td>
  246. <td>(</td>
  247. <td class="paramtype">void *&#160;</td>
  248. <td class="paramname"><em>mem</em>, </td>
  249. </tr>
  250. <tr>
  251. <td class="paramkey"></td>
  252. <td></td>
  253. <td class="paramtype">void *&#160;</td>
  254. <td class="paramname"><em>block</em>, </td>
  255. </tr>
  256. <tr>
  257. <td class="paramkey"></td>
  258. <td></td>
  259. <td class="paramtype">uint32_t&#160;</td>
  260. <td class="paramname"><em>result</em>&#160;</td>
  261. </tr>
  262. <tr>
  263. <td></td>
  264. <td>)</td>
  265. <td></td><td></td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <dl class="params"><dt>Parameters</dt><dd>
  270. <table class="params">
  271. <tr><td class="paramdir">[in]</td><td class="paramname">mem</td><td>pointer to memory pool. </td></tr>
  272. <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>memory block to be returned to the memory pool. </td></tr>
  273. <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>execution status: 1 - success, 0 - failure.</td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <p>The event <b>MemoryFree</b> is generated when deallocation of a variable size memory block completes.</p>
  278. <p><b>Value</b> in the Event Recorder shows:</p>
  279. <ul>
  280. <li><b>mem</b> : memory address of memory pool.</li>
  281. <li><b>block</b> : memory address of block to be returned to the memory pool.</li>
  282. <li><b>result</b> : execution status: 1 - success, 0 - failure. </li>
  283. </ul>
  284. </div>
  285. </div>
  286. <a class="anchor" id="gac71421bbf537f2f8c9255f9f51cf7d54"></a>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname">void EvrRtxMemoryBlockInit </td>
  292. <td>(</td>
  293. <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
  294. <td class="paramname"><em>mp_info</em>, </td>
  295. </tr>
  296. <tr>
  297. <td class="paramkey"></td>
  298. <td></td>
  299. <td class="paramtype">uint32_t&#160;</td>
  300. <td class="paramname"><em>block_count</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">uint32_t&#160;</td>
  306. <td class="paramname"><em>block_size</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">void *&#160;</td>
  312. <td class="paramname"><em>block_mem</em>&#160;</td>
  313. </tr>
  314. <tr>
  315. <td></td>
  316. <td>)</td>
  317. <td></td><td></td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <dl class="params"><dt>Parameters</dt><dd>
  322. <table class="params">
  323. <tr><td class="paramdir">[in]</td><td class="paramname">mp_info</td><td>memory pool info. </td></tr>
  324. <tr><td class="paramdir">[in]</td><td class="paramname">block_count</td><td>maximum number of memory blocks in memory pool. </td></tr>
  325. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>size of a memory block in bytes. </td></tr>
  326. <tr><td class="paramdir">[in]</td><td class="paramname">block_mem</td><td>pointer to memory for block storage.</td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <p>The event <b>MemoryBlockInit</b> is generated when initialization of a fixed size memory block completes.</p>
  331. <p><b>Value</b> in the Event Recorder shows:</p>
  332. <ul>
  333. <li><b>mp_info</b> : memory address of memory pool info.</li>
  334. <li><b>block_count</b> : maximum number of memory blocks in memory pool.</li>
  335. <li><b>block_size</b> : size of a memory block in bytes.</li>
  336. <li><b>block_mem</b> : memory address of memory for block storage. </li>
  337. </ul>
  338. </div>
  339. </div>
  340. <a class="anchor" id="ga71c0df6f932436b54d7d641a440586db"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">void EvrRtxMemoryBlockAlloc </td>
  346. <td>(</td>
  347. <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
  348. <td class="paramname"><em>mp_info</em>, </td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey"></td>
  352. <td></td>
  353. <td class="paramtype">void *&#160;</td>
  354. <td class="paramname"><em>block</em>&#160;</td>
  355. </tr>
  356. <tr>
  357. <td></td>
  358. <td>)</td>
  359. <td></td><td></td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <dl class="params"><dt>Parameters</dt><dd>
  364. <table class="params">
  365. <tr><td class="paramdir">[in]</td><td class="paramname">mp_info</td><td>memory pool info. </td></tr>
  366. <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block or NULL in case of no memory is available.</td></tr>
  367. </table>
  368. </dd>
  369. </dl>
  370. <p>The event <b>MemoryBlockAlloc</b> is generated when allocation of a fixed size memory block completes.</p>
  371. <p><b>Value</b> in the Event Recorder shows:</p>
  372. <ul>
  373. <li><b>mp_info</b> : memory address of memory pool info.</li>
  374. <li><b>block</b> : memory address of the allocated memory block or 0 in case of no memory is available. </li>
  375. </ul>
  376. </div>
  377. </div>
  378. <a class="anchor" id="ga69c2139620def7c5e59f6b1249857949"></a>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">void EvrRtxMemoryBlockFree </td>
  384. <td>(</td>
  385. <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
  386. <td class="paramname"><em>mp_info</em>, </td>
  387. </tr>
  388. <tr>
  389. <td class="paramkey"></td>
  390. <td></td>
  391. <td class="paramtype">void *&#160;</td>
  392. <td class="paramname"><em>block</em>, </td>
  393. </tr>
  394. <tr>
  395. <td class="paramkey"></td>
  396. <td></td>
  397. <td class="paramtype">int32_t&#160;</td>
  398. <td class="paramname"><em>status</em>&#160;</td>
  399. </tr>
  400. <tr>
  401. <td></td>
  402. <td>)</td>
  403. <td></td><td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <dl class="params"><dt>Parameters</dt><dd>
  408. <table class="params">
  409. <tr><td class="paramdir">[in]</td><td class="paramname">mp_info</td><td>memory pool info. </td></tr>
  410. <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block to be returned to the memory pool. </td></tr>
  411. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <p>The event <b>MemoryBlockFree</b> is generated when deallocation of a fixed size memory block completes.</p>
  416. <p><b>Value</b> in the Event Recorder shows:</p>
  417. <ul>
  418. <li><b>mp_info</b> : memory address of memory pool info.</li>
  419. <li><b>block</b> : memory address of the allocated memory block to be returned to the memory pool.</li>
  420. <li><b>status</b> : execution status <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> </li>
  421. </ul>
  422. </div>
  423. </div>
  424. </div><!-- contents -->
  425. </div><!-- doc-content -->
  426. <!-- start footer part -->
  427. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  428. <ul>
  429. <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  430. <!--
  431. <a href="http://www.doxygen.org/index.html">
  432. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  433. -->
  434. </li>
  435. </ul>
  436. </div>
  437. </body>
  438. </html>