group__rtx__evr__memory__pool.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891
  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 Pool Functions</title>
  7. <title>CMSIS-RTOS2: Memory Pool 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__pool.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 Pool 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 by memory pool 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:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga7e1a37b0c5dd0a97507c025ab1a62ec8">EvrRtxMemoryPoolError</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, int32_t status)</td></tr>
  120. <tr class="memdesc:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool error (Error) <a href="#ga7e1a37b0c5dd0a97507c025ab1a62ec8">More...</a><br/></td></tr>
  121. <tr class="separator:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf2fd4c91acf1379e93cd9886c515b9c5">EvrRtxMemoryPoolNew</a> (uint32_t block_count, uint32_t block_size, const <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t">osMemoryPoolAttr_t</a> *attr)</td></tr>
  123. <tr class="memdesc:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool create and initialize (API) <a href="#gaf2fd4c91acf1379e93cd9886c515b9c5">More...</a><br/></td></tr>
  124. <tr class="separator:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:gadad71c7b04493c03647ca0929ea087b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gadad71c7b04493c03647ca0929ea087b1">EvrRtxMemoryPoolCreated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, const char *name)</td></tr>
  126. <tr class="memdesc:gadad71c7b04493c03647ca0929ea087b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful memory pool create (Op) <a href="#gadad71c7b04493c03647ca0929ea087b1">More...</a><br/></td></tr>
  127. <tr class="separator:gadad71c7b04493c03647ca0929ea087b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gaeface1ee4957cdb59292e13c38a672d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaeface1ee4957cdb59292e13c38a672d7">EvrRtxMemoryPoolGetName</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, const char *name)</td></tr>
  129. <tr class="memdesc:gaeface1ee4957cdb59292e13c38a672d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool name retrieve (API) <a href="#gaeface1ee4957cdb59292e13c38a672d7">More...</a><br/></td></tr>
  130. <tr class="separator:gaeface1ee4957cdb59292e13c38a672d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga425c8a0e13c6fb13262d99a4dcabd507">EvrRtxMemoryPoolAlloc</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t timeout)</td></tr>
  132. <tr class="memdesc:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool allocation (API) <a href="#ga425c8a0e13c6fb13262d99a4dcabd507">More...</a><br/></td></tr>
  133. <tr class="separator:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga2fbd33e3d84b4f37e9f9b80576b26907">EvrRtxMemoryPoolAllocPending</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t timeout)</td></tr>
  135. <tr class="memdesc:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending memory pool allocation (Op) <a href="#ga2fbd33e3d84b4f37e9f9b80576b26907">More...</a><br/></td></tr>
  136. <tr class="separator:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ga0e144530d45959126018ad74bae7a6ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga0e144530d45959126018ad74bae7a6ed">EvrRtxMemoryPoolAllocTimeout</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr>
  138. <tr class="memdesc:ga0e144530d45959126018ad74bae7a6ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool allocation timeout (Op) <a href="#ga0e144530d45959126018ad74bae7a6ed">More...</a><br/></td></tr>
  139. <tr class="separator:ga0e144530d45959126018ad74bae7a6ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:gad05246ee7e1f95e7f9496716515daeed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gad05246ee7e1f95e7f9496716515daeed">EvrRtxMemoryPoolAllocated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr>
  141. <tr class="memdesc:gad05246ee7e1f95e7f9496716515daeed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful memory pool allocation (Op) <a href="#gad05246ee7e1f95e7f9496716515daeed">More...</a><br/></td></tr>
  142. <tr class="separator:gad05246ee7e1f95e7f9496716515daeed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaf511fce5389dde6fd3277e3469c72fd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf511fce5389dde6fd3277e3469c72fd9">EvrRtxMemoryPoolAllocFailed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr>
  144. <tr class="memdesc:gaf511fce5389dde6fd3277e3469c72fd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful memory pool allocation (Op) <a href="#gaf511fce5389dde6fd3277e3469c72fd9">More...</a><br/></td></tr>
  145. <tr class="separator:gaf511fce5389dde6fd3277e3469c72fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga46bc3ef3b1ca2e4cfb914f58d0efe92e">EvrRtxMemoryPoolFree</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr>
  147. <tr class="memdesc:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool free (API) <a href="#ga46bc3ef3b1ca2e4cfb914f58d0efe92e">More...</a><br/></td></tr>
  148. <tr class="separator:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga3e8e700baea20b88c3d13678fe7a7fb4">EvrRtxMemoryPoolDeallocated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr>
  150. <tr class="memdesc:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful memory pool free (Op) <a href="#ga3e8e700baea20b88c3d13678fe7a7fb4">More...</a><br/></td></tr>
  151. <tr class="separator:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gad75c377c00ae23caf7b4c3b77a0b46d1">EvrRtxMemoryPoolFreeFailed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr>
  153. <tr class="memdesc:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful memory pool free (Op) <a href="#gad75c377c00ae23caf7b4c3b77a0b46d1">More...</a><br/></td></tr>
  154. <tr class="separator:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:gaed36f26a548d40e2a3d5b81c8695f287"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaed36f26a548d40e2a3d5b81c8695f287">EvrRtxMemoryPoolGetCapacity</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t capacity)</td></tr>
  156. <tr class="memdesc:gaed36f26a548d40e2a3d5b81c8695f287"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool capacity retrieve (API) <a href="#gaed36f26a548d40e2a3d5b81c8695f287">More...</a><br/></td></tr>
  157. <tr class="separator:gaed36f26a548d40e2a3d5b81c8695f287"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf79f0e1eb41d42566ba9023be7e442c5">EvrRtxMemoryPoolGetBlockSize</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t block_size)</td></tr>
  159. <tr class="memdesc:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool block size retrieve (API) <a href="#gaf79f0e1eb41d42566ba9023be7e442c5">More...</a><br/></td></tr>
  160. <tr class="separator:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ga668bc3e627d9b74b6e8259a667e05846"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga668bc3e627d9b74b6e8259a667e05846">EvrRtxMemoryPoolGetCount</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t count)</td></tr>
  162. <tr class="memdesc:ga668bc3e627d9b74b6e8259a667e05846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on used memory pool blocks retrieve (API) <a href="#ga668bc3e627d9b74b6e8259a667e05846">More...</a><br/></td></tr>
  163. <tr class="separator:ga668bc3e627d9b74b6e8259a667e05846"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga4bee4e3e41bdef94046dc059f16ca7ce">EvrRtxMemoryPoolGetSpace</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t space)</td></tr>
  165. <tr class="memdesc:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on available memory pool blocks retrieve (API) <a href="#ga4bee4e3e41bdef94046dc059f16ca7ce">More...</a><br/></td></tr>
  166. <tr class="separator:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ga64ae703ad556f25b105e3eae85b582b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga64ae703ad556f25b105e3eae85b582b8">EvrRtxMemoryPoolDelete</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr>
  168. <tr class="memdesc:ga64ae703ad556f25b105e3eae85b582b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory pool delete (API) <a href="#ga64ae703ad556f25b105e3eae85b582b8">More...</a><br/></td></tr>
  169. <tr class="separator:ga64ae703ad556f25b105e3eae85b582b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ga853e1867a4b65aff3f12f7be1aee5ce4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga853e1867a4b65aff3f12f7be1aee5ce4">EvrRtxMemoryPoolDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr>
  171. <tr class="memdesc:ga853e1867a4b65aff3f12f7be1aee5ce4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful memory pool delete (Op) <a href="#ga853e1867a4b65aff3f12f7be1aee5ce4">More...</a><br/></td></tr>
  172. <tr class="separator:ga853e1867a4b65aff3f12f7be1aee5ce4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table>
  174. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  175. <h2 class="groupheader">Function Documentation</h2>
  176. <a class="anchor" id="ga7e1a37b0c5dd0a97507c025ab1a62ec8"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">void EvrRtxMemoryPoolError </td>
  182. <td>(</td>
  183. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  184. <td class="paramname"><em>mp_id</em>, </td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey"></td>
  188. <td></td>
  189. <td class="paramtype">int32_t&#160;</td>
  190. <td class="paramname"><em>status</em>&#160;</td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td>)</td>
  195. <td></td><td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <dl class="params"><dt>Parameters</dt><dd>
  200. <table class="params">
  201. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a> or NULL when ID is unknown. </td></tr>
  202. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  203. </table>
  204. </dd>
  205. </dl>
  206. <p>The event <b>MemoryPoolError</b> is generated when <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a> routines complete their execution due to an error.</p>
  207. <p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p>
  208. <table class="doxtable">
  209. <tr>
  210. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  211. <tr>
  212. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  213. <tr>
  214. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  215. <tr>
  216. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  217. <tr>
  218. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  219. <tr>
  220. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  221. <tr>
  222. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  223. <tr>
  224. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  225. <tr>
  226. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  227. <tr>
  228. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  229. <tr>
  230. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  231. <tr>
  232. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  233. <tr>
  234. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  235. <tr>
  236. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  237. <tr>
  238. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  239. <tr>
  240. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  241. <tr>
  242. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  243. </table>
  244. <p><b>Value</b> in the Event Recorder shows:</p>
  245. <ul>
  246. <li><b>mp_id</b> : memory pool ID.</li>
  247. <li><b>status</b> : execution status code. </li>
  248. </ul>
  249. </div>
  250. </div>
  251. <a class="anchor" id="gaf2fd4c91acf1379e93cd9886c515b9c5"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">void EvrRtxMemoryPoolNew </td>
  257. <td>(</td>
  258. <td class="paramtype">uint32_t&#160;</td>
  259. <td class="paramname"><em>block_count</em>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">uint32_t&#160;</td>
  265. <td class="paramname"><em>block_size</em>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t">osMemoryPoolAttr_t</a> *&#160;</td>
  271. <td class="paramname"><em>attr</em>&#160;</td>
  272. </tr>
  273. <tr>
  274. <td></td>
  275. <td>)</td>
  276. <td></td><td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <dl class="params"><dt>Parameters</dt><dd>
  281. <table class="params">
  282. <tr><td class="paramdir">[in]</td><td class="paramname">block_count</td><td>maximum number of memory blocks in memory pool. </td></tr>
  283. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>memory block size in bytes. </td></tr>
  284. <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>memory pool attributes; NULL: default values.</td></tr>
  285. </table>
  286. </dd>
  287. </dl>
  288. <p>The event <b>MemoryPoolNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a> is called.</p>
  289. <p><b>Value</b> in the Event Recorder shows:</p>
  290. <ul>
  291. <li><b>block_count</b> : maximum number of memory blocks in memory pool.</li>
  292. <li><b>block_size</b> : memory block size in bytes.</li>
  293. <li><b>attr</b> : memory address of Memory Pool attributes or 0 when they are not specified. </li>
  294. </ul>
  295. </div>
  296. </div>
  297. <a class="anchor" id="gadad71c7b04493c03647ca0929ea087b1"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">void EvrRtxMemoryPoolCreated </td>
  303. <td>(</td>
  304. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  305. <td class="paramname"><em>mp_id</em>, </td>
  306. </tr>
  307. <tr>
  308. <td class="paramkey"></td>
  309. <td></td>
  310. <td class="paramtype">const char *&#160;</td>
  311. <td class="paramname"><em>name</em>&#160;</td>
  312. </tr>
  313. <tr>
  314. <td></td>
  315. <td>)</td>
  316. <td></td><td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <dl class="params"><dt>Parameters</dt><dd>
  321. <table class="params">
  322. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  323. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to memory pool object name.</td></tr>
  324. </table>
  325. </dd>
  326. </dl>
  327. <p>The event <b>MemoryPoolCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a> successfully creates a memory pool object.</p>
  328. <p><b>Value</b> in the Event Recorder shows:</p>
  329. <ul>
  330. <li><b>mp_id</b> : memory pool ID. </li>
  331. </ul>
  332. </div>
  333. </div>
  334. <a class="anchor" id="gaeface1ee4957cdb59292e13c38a672d7"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">void EvrRtxMemoryPoolGetName </td>
  340. <td>(</td>
  341. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  342. <td class="paramname"><em>mp_id</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">const char *&#160;</td>
  348. <td class="paramname"><em>name</em>&#160;</td>
  349. </tr>
  350. <tr>
  351. <td></td>
  352. <td>)</td>
  353. <td></td><td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <dl class="params"><dt>Parameters</dt><dd>
  358. <table class="params">
  359. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  360. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to memory pool object name.</td></tr>
  361. </table>
  362. </dd>
  363. </dl>
  364. <p>The event <b>MemoryPoolGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab414a1e138205a55820acfa277c8f386">osMemoryPoolGetName</a> is called and its execution result is known.</p>
  365. <p><b>Value</b> in the Event Recorder shows:</p>
  366. <ul>
  367. <li><b>mp_id</b> : memory pool ID.</li>
  368. <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
  369. </ul>
  370. </div>
  371. </div>
  372. <a class="anchor" id="ga425c8a0e13c6fb13262d99a4dcabd507"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname">void EvrRtxMemoryPoolAlloc </td>
  378. <td>(</td>
  379. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  380. <td class="paramname"><em>mp_id</em>, </td>
  381. </tr>
  382. <tr>
  383. <td class="paramkey"></td>
  384. <td></td>
  385. <td class="paramtype">uint32_t&#160;</td>
  386. <td class="paramname"><em>timeout</em>&#160;</td>
  387. </tr>
  388. <tr>
  389. <td></td>
  390. <td>)</td>
  391. <td></td><td></td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <dl class="params"><dt>Parameters</dt><dd>
  396. <table class="params">
  397. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  398. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  399. </table>
  400. </dd>
  401. </dl>
  402. <p>The event <b>MemoryPoolAlloc</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> is called.</p>
  403. <p><b>Value</b> in the Event Recorder shows:</p>
  404. <ul>
  405. <li><b>mp_id</b> : memory pool ID.</li>
  406. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  407. </ul>
  408. </div>
  409. </div>
  410. <a class="anchor" id="ga2fbd33e3d84b4f37e9f9b80576b26907"></a>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">void EvrRtxMemoryPoolAllocPending </td>
  416. <td>(</td>
  417. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  418. <td class="paramname"><em>mp_id</em>, </td>
  419. </tr>
  420. <tr>
  421. <td class="paramkey"></td>
  422. <td></td>
  423. <td class="paramtype">uint32_t&#160;</td>
  424. <td class="paramname"><em>timeout</em>&#160;</td>
  425. </tr>
  426. <tr>
  427. <td></td>
  428. <td>)</td>
  429. <td></td><td></td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <dl class="params"><dt>Parameters</dt><dd>
  434. <table class="params">
  435. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  436. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <p>The event <b>MemoryPoolAllocPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> blocks current running thread and waits for memory block to become available.</p>
  441. <p><b>Value</b> in the Event Recorder shows:</p>
  442. <ul>
  443. <li><b>mp_id</b> : memory pool ID.</li>
  444. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  445. </ul>
  446. </div>
  447. </div>
  448. <a class="anchor" id="ga0e144530d45959126018ad74bae7a6ed"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">void EvrRtxMemoryPoolAllocTimeout </td>
  454. <td>(</td>
  455. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  456. <td class="paramname"><em>mp_id</em></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <dl class="params"><dt>Parameters</dt><dd>
  462. <table class="params">
  463. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr>
  464. </table>
  465. </dd>
  466. </dl>
  467. <p>The event <b>MemoryPoolAllocTimeout</b> is generated when wait for memory pool to become available is aborted due to expired wait timeout.</p>
  468. <p><b>Value</b> in the Event Recorder shows:</p>
  469. <ul>
  470. <li><b>mp_id</b> : memory pool ID. </li>
  471. </ul>
  472. </div>
  473. </div>
  474. <a class="anchor" id="gad05246ee7e1f95e7f9496716515daeed"></a>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname">void EvrRtxMemoryPoolAllocated </td>
  480. <td>(</td>
  481. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  482. <td class="paramname"><em>mp_id</em>, </td>
  483. </tr>
  484. <tr>
  485. <td class="paramkey"></td>
  486. <td></td>
  487. <td class="paramtype">void *&#160;</td>
  488. <td class="paramname"><em>block</em>&#160;</td>
  489. </tr>
  490. <tr>
  491. <td></td>
  492. <td>)</td>
  493. <td></td><td></td>
  494. </tr>
  495. </table>
  496. </div><div class="memdoc">
  497. <dl class="params"><dt>Parameters</dt><dd>
  498. <table class="params">
  499. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  500. <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block.</td></tr>
  501. </table>
  502. </dd>
  503. </dl>
  504. <p>The event <b>MemoryPoolAllocated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> successfully allocates the memory block.</p>
  505. <p><b>Value</b> in the Event Recorder shows:</p>
  506. <ul>
  507. <li><b>mp_id</b> : memory pool ID.</li>
  508. <li><b>block</b> : memory address of the allocated memory block. </li>
  509. </ul>
  510. </div>
  511. </div>
  512. <a class="anchor" id="gaf511fce5389dde6fd3277e3469c72fd9"></a>
  513. <div class="memitem">
  514. <div class="memproto">
  515. <table class="memname">
  516. <tr>
  517. <td class="memname">void EvrRtxMemoryPoolAllocFailed </td>
  518. <td>(</td>
  519. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  520. <td class="paramname"><em>mp_id</em></td><td>)</td>
  521. <td></td>
  522. </tr>
  523. </table>
  524. </div><div class="memdoc">
  525. <dl class="params"><dt>Parameters</dt><dd>
  526. <table class="params">
  527. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr>
  528. </table>
  529. </dd>
  530. </dl>
  531. <p>The event <b>MemoryPoolAllocFailed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> fails to allocate the memory block due to out of available memory.</p>
  532. <p><b>Value</b> in the Event Recorder shows:</p>
  533. <ul>
  534. <li><b>mp_id</b> : memory pool ID. </li>
  535. </ul>
  536. </div>
  537. </div>
  538. <a class="anchor" id="ga46bc3ef3b1ca2e4cfb914f58d0efe92e"></a>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname">void EvrRtxMemoryPoolFree </td>
  544. <td>(</td>
  545. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  546. <td class="paramname"><em>mp_id</em>, </td>
  547. </tr>
  548. <tr>
  549. <td class="paramkey"></td>
  550. <td></td>
  551. <td class="paramtype">void *&#160;</td>
  552. <td class="paramname"><em>block</em>&#160;</td>
  553. </tr>
  554. <tr>
  555. <td></td>
  556. <td>)</td>
  557. <td></td><td></td>
  558. </tr>
  559. </table>
  560. </div><div class="memdoc">
  561. <dl class="params"><dt>Parameters</dt><dd>
  562. <table class="params">
  563. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  564. <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>
  565. </table>
  566. </dd>
  567. </dl>
  568. <p>The event <b>MemoryPoolFree</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> is called.</p>
  569. <p><b>Value</b> in the Event Recorder shows:</p>
  570. <ul>
  571. <li><b>mp_id</b> : memory pool ID.</li>
  572. <li><b>block</b> : memory address of the memory block to be returned to the memory pool. </li>
  573. </ul>
  574. </div>
  575. </div>
  576. <a class="anchor" id="ga3e8e700baea20b88c3d13678fe7a7fb4"></a>
  577. <div class="memitem">
  578. <div class="memproto">
  579. <table class="memname">
  580. <tr>
  581. <td class="memname">void EvrRtxMemoryPoolDeallocated </td>
  582. <td>(</td>
  583. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  584. <td class="paramname"><em>mp_id</em>, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype">void *&#160;</td>
  590. <td class="paramname"><em>block</em>&#160;</td>
  591. </tr>
  592. <tr>
  593. <td></td>
  594. <td>)</td>
  595. <td></td><td></td>
  596. </tr>
  597. </table>
  598. </div><div class="memdoc">
  599. <dl class="params"><dt>Parameters</dt><dd>
  600. <table class="params">
  601. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  602. <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>
  603. </table>
  604. </dd>
  605. </dl>
  606. <p>The event <b>MemoryPoolDeallocated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> successfully deallocates the memory block.</p>
  607. <p><b>Value</b> in the Event Recorder shows:</p>
  608. <ul>
  609. <li><b>mp_id</b> : memory pool ID.</li>
  610. <li><b>block</b> : memory address of the memory block returned to the memory pool. </li>
  611. </ul>
  612. </div>
  613. </div>
  614. <a class="anchor" id="gad75c377c00ae23caf7b4c3b77a0b46d1"></a>
  615. <div class="memitem">
  616. <div class="memproto">
  617. <table class="memname">
  618. <tr>
  619. <td class="memname">void EvrRtxMemoryPoolFreeFailed </td>
  620. <td>(</td>
  621. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  622. <td class="paramname"><em>mp_id</em>, </td>
  623. </tr>
  624. <tr>
  625. <td class="paramkey"></td>
  626. <td></td>
  627. <td class="paramtype">void *&#160;</td>
  628. <td class="paramname"><em>block</em>&#160;</td>
  629. </tr>
  630. <tr>
  631. <td></td>
  632. <td>)</td>
  633. <td></td><td></td>
  634. </tr>
  635. </table>
  636. </div><div class="memdoc">
  637. <dl class="params"><dt>Parameters</dt><dd>
  638. <table class="params">
  639. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  640. <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>
  641. </table>
  642. </dd>
  643. </dl>
  644. <p>The event <b>MemoryPoolFreeFailed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> fails to deallocate the memory block.</p>
  645. <p><b>Value</b> in the Event Recorder shows:</p>
  646. <ul>
  647. <li><b>mp_id</b> : memory pool ID.</li>
  648. <li><b>block</b> : memory address of the memory block to be returned to the memory pool. </li>
  649. </ul>
  650. </div>
  651. </div>
  652. <a class="anchor" id="gaed36f26a548d40e2a3d5b81c8695f287"></a>
  653. <div class="memitem">
  654. <div class="memproto">
  655. <table class="memname">
  656. <tr>
  657. <td class="memname">void EvrRtxMemoryPoolGetCapacity </td>
  658. <td>(</td>
  659. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  660. <td class="paramname"><em>mp_id</em>, </td>
  661. </tr>
  662. <tr>
  663. <td class="paramkey"></td>
  664. <td></td>
  665. <td class="paramtype">uint32_t&#160;</td>
  666. <td class="paramname"><em>capacity</em>&#160;</td>
  667. </tr>
  668. <tr>
  669. <td></td>
  670. <td>)</td>
  671. <td></td><td></td>
  672. </tr>
  673. </table>
  674. </div><div class="memdoc">
  675. <dl class="params"><dt>Parameters</dt><dd>
  676. <table class="params">
  677. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  678. <tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>maximum number of memory blocks.</td></tr>
  679. </table>
  680. </dd>
  681. </dl>
  682. <p>The event <b>MemoryPoolGetCapacity</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gad696e94bfbe28f0b6613f9303fdf6a37">osMemoryPoolGetCapacity</a> is called and its execution result is known.</p>
  683. <p><b>Value</b> in the Event Recorder shows:</p>
  684. <ul>
  685. <li><b>mp_id</b> : memory pool ID.</li>
  686. <li><b>capacity</b> : retrieved maximum number of memory blocks (0 in case of a failure). </li>
  687. </ul>
  688. </div>
  689. </div>
  690. <a class="anchor" id="gaf79f0e1eb41d42566ba9023be7e442c5"></a>
  691. <div class="memitem">
  692. <div class="memproto">
  693. <table class="memname">
  694. <tr>
  695. <td class="memname">void EvrRtxMemoryPoolGetBlockSize </td>
  696. <td>(</td>
  697. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  698. <td class="paramname"><em>mp_id</em>, </td>
  699. </tr>
  700. <tr>
  701. <td class="paramkey"></td>
  702. <td></td>
  703. <td class="paramtype">uint32_t&#160;</td>
  704. <td class="paramname"><em>block_size</em>&#160;</td>
  705. </tr>
  706. <tr>
  707. <td></td>
  708. <td>)</td>
  709. <td></td><td></td>
  710. </tr>
  711. </table>
  712. </div><div class="memdoc">
  713. <dl class="params"><dt>Parameters</dt><dd>
  714. <table class="params">
  715. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  716. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>memory block size in bytes.</td></tr>
  717. </table>
  718. </dd>
  719. </dl>
  720. <p>The event <b>MemoryPoolGetBlockSize</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab2bf059b7fa7679c3cccdaeec60b6c0e">osMemoryPoolGetBlockSize</a> is called and its execution result is known.</p>
  721. <p><b>Value</b> in the Event Recorder shows:</p>
  722. <ul>
  723. <li><b>mp_id</b> : memory pool ID.</li>
  724. <li><b>block_size</b> : retrieved memory block size in bytes (0 in case of a failure). </li>
  725. </ul>
  726. </div>
  727. </div>
  728. <a class="anchor" id="ga668bc3e627d9b74b6e8259a667e05846"></a>
  729. <div class="memitem">
  730. <div class="memproto">
  731. <table class="memname">
  732. <tr>
  733. <td class="memname">void EvrRtxMemoryPoolGetCount </td>
  734. <td>(</td>
  735. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  736. <td class="paramname"><em>mp_id</em>, </td>
  737. </tr>
  738. <tr>
  739. <td class="paramkey"></td>
  740. <td></td>
  741. <td class="paramtype">uint32_t&#160;</td>
  742. <td class="paramname"><em>count</em>&#160;</td>
  743. </tr>
  744. <tr>
  745. <td></td>
  746. <td>)</td>
  747. <td></td><td></td>
  748. </tr>
  749. </table>
  750. </div><div class="memdoc">
  751. <dl class="params"><dt>Parameters</dt><dd>
  752. <table class="params">
  753. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  754. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>number of memory blocks used.</td></tr>
  755. </table>
  756. </dd>
  757. </dl>
  758. <p>The event <b>MemoryPoolGetCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga958a9449bff8c95ce213de98eef5739d">osMemoryPoolGetCount</a> is called and its execution result is known.</p>
  759. <p><b>Value</b> in the Event Recorder shows:</p>
  760. <ul>
  761. <li><b>mp_id</b> : memory pool ID.</li>
  762. <li><b>count</b> : retrieved number of memory block used (0 in case of a failure). </li>
  763. </ul>
  764. </div>
  765. </div>
  766. <a class="anchor" id="ga4bee4e3e41bdef94046dc059f16ca7ce"></a>
  767. <div class="memitem">
  768. <div class="memproto">
  769. <table class="memname">
  770. <tr>
  771. <td class="memname">void EvrRtxMemoryPoolGetSpace </td>
  772. <td>(</td>
  773. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  774. <td class="paramname"><em>mp_id</em>, </td>
  775. </tr>
  776. <tr>
  777. <td class="paramkey"></td>
  778. <td></td>
  779. <td class="paramtype">uint32_t&#160;</td>
  780. <td class="paramname"><em>space</em>&#160;</td>
  781. </tr>
  782. <tr>
  783. <td></td>
  784. <td>)</td>
  785. <td></td><td></td>
  786. </tr>
  787. </table>
  788. </div><div class="memdoc">
  789. <dl class="params"><dt>Parameters</dt><dd>
  790. <table class="params">
  791. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr>
  792. <tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>number of memory blocks available.</td></tr>
  793. </table>
  794. </dd>
  795. </dl>
  796. <p>The event <b>MemoryPoolGetSpace</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga0394cffa9479a7994e3b03c79c1cb909">osMemoryPoolGetSpace</a> is called and its execution result is known.</p>
  797. <p><b>Value</b> in the Event Recorder shows:</p>
  798. <ul>
  799. <li><b>mp_id</b> : memory pool ID.</li>
  800. <li><b>space</b> : retrieved number of memory blocks available (0 in case of a failure). </li>
  801. </ul>
  802. </div>
  803. </div>
  804. <a class="anchor" id="ga64ae703ad556f25b105e3eae85b582b8"></a>
  805. <div class="memitem">
  806. <div class="memproto">
  807. <table class="memname">
  808. <tr>
  809. <td class="memname">void EvrRtxMemoryPoolDelete </td>
  810. <td>(</td>
  811. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  812. <td class="paramname"><em>mp_id</em></td><td>)</td>
  813. <td></td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. <dl class="params"><dt>Parameters</dt><dd>
  818. <table class="params">
  819. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr>
  820. </table>
  821. </dd>
  822. </dl>
  823. <p>The event <b>MemoryPoolDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8c39e7e5cd2b9eda907466808e59d62e">osMemoryPoolDelete</a> is called.</p>
  824. <p><b>Value</b> in the Event Recorder shows:</p>
  825. <ul>
  826. <li><b>mp_id</b> : memory pool ID. </li>
  827. </ul>
  828. </div>
  829. </div>
  830. <a class="anchor" id="ga853e1867a4b65aff3f12f7be1aee5ce4"></a>
  831. <div class="memitem">
  832. <div class="memproto">
  833. <table class="memname">
  834. <tr>
  835. <td class="memname">void EvrRtxMemoryPoolDestroyed </td>
  836. <td>(</td>
  837. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>&#160;</td>
  838. <td class="paramname"><em>mp_id</em></td><td>)</td>
  839. <td></td>
  840. </tr>
  841. </table>
  842. </div><div class="memdoc">
  843. <dl class="params"><dt>Parameters</dt><dd>
  844. <table class="params">
  845. <tr><td class="paramdir">[in]</td><td class="paramname">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr>
  846. </table>
  847. </dd>
  848. </dl>
  849. <p>The event <b>MemoryPoolDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8c39e7e5cd2b9eda907466808e59d62e">osMemoryPoolDelete</a> successfully deletes the memory pool object.</p>
  850. <p><b>Value</b> in the Event Recorder shows:</p>
  851. <ul>
  852. <li><b>mp_id</b> : memory pool ID. </li>
  853. </ul>
  854. </div>
  855. </div>
  856. </div><!-- contents -->
  857. </div><!-- doc-content -->
  858. <!-- start footer part -->
  859. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  860. <ul>
  861. <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  862. <!--
  863. <a href="http://www.doxygen.org/index.html">
  864. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  865. -->
  866. </li>
  867. </ul>
  868. </div>
  869. </body>
  870. </html>