Ana Sayfa Keşfet Yardım
Giriş Yap
ARM-software
/
CMSIS_5
şunun yansıması https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Çatalla 0
Dosyalar Sorunlar 0 Wiki
Ağaç: a82c293bfb
Dallar Biçim İmleri
CMSIS_5
/
docs
/
RTOS
/
html
/
group__CMSIS__RTOS__PoolMgmt.html

group__CMSIS__RTOS__PoolMgmt.html 31 KB
Geçmiş Ham

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Memory Pool</title>
    7. 

  7. <title>CMSIS-RTOS: Memory Pool</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-RTOS
    35. 

  35.    &#160;<span id="projectnumber">Version 1.03</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation.</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('group__CMSIS__RTOS__PoolMgmt.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  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. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="summary">
    111. 

  111. <a href="#define-members">Macros</a> &#124;
    112. 

  112. <a href="#func-members">Functions</a>  </div>
    113. 

  113.   <div class="headertitle">
    114. 

  114. <div class="title">Memory Pool<div class="ingroups"><a class="el" href="group__CMSIS__RTOS__InterThread.html">Inter-Thread Communication and Resource Sharing</a></div></div>  </div>
    115. 

  115. </div><!--header-->
    116. 

  116. <div class="contents">
    117. 

  117. 

  118. <p>Manage thread-safe fixed-size blocks of dynamic memory.  
    119. 

  119. <a href="#details">More...</a></p>
    120. 

  120. <table class="memberdecls">
    121. 

  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
    122. 

  122. Macros</h2></td></tr>
    123. 

  123. <tr class="memitem:gadd84b683001de327894851b428587caa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa">osFeature_Pool</a>&#160;&#160;&#160;1</td></tr>
    124. 

  124. <tr class="memdesc:gadd84b683001de327894851b428587caa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Memory Pools: 1=available, 0=not available.  <a href="#gadd84b683001de327894851b428587caa">More...</a><br/></td></tr>
    125. 

  125. <tr class="separator:gadd84b683001de327894851b428587caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    126. 

  126. <tr class="memitem:ga87b471d4fe2d5dbd0040708edd52771b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a>(name, no, type)</td></tr>
    127. 

  127. <tr class="memdesc:ga87b471d4fe2d5dbd0040708edd52771b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define a Memory Pool.  <a href="#ga87b471d4fe2d5dbd0040708edd52771b">More...</a><br/></td></tr>
    128. 

  128. <tr class="separator:ga87b471d4fe2d5dbd0040708edd52771b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129. 

  129. <tr class="memitem:ga5f0b204a82327533d420210125c90697"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a>(name)&#160;&#160;&#160;&amp;os_pool_def_##name</td></tr>
    130. 

  130. <tr class="memdesc:ga5f0b204a82327533d420210125c90697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access a Memory Pool definition.  <a href="#ga5f0b204a82327533d420210125c90697">More...</a><br/></td></tr>
    131. 

  131. <tr class="separator:ga5f0b204a82327533d420210125c90697"><td class="memSeparator" colspan="2">&#160;</td></tr>
    132. 

  132. </table><table class="memberdecls">
    133. 

  133. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    134. 

  134. Functions</h2></td></tr>
    135. 

  135. <tr class="memitem:ga34af5c4f4ab38f4138ea7f1f9ece3a1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a> (const <a class="el" href="cmsis__os_8h.html#structosPoolDef__t">osPoolDef_t</a> *pool_def)</td></tr>
    136. 

  136. <tr class="memdesc:ga34af5c4f4ab38f4138ea7f1f9ece3a1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and Initialize a memory pool.  <a href="#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">More...</a><br/></td></tr>
    137. 

  137. <tr class="separator:ga34af5c4f4ab38f4138ea7f1f9ece3a1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    138. 

  138. <tr class="memitem:gaa0b2994f1a866c19e0d11e6e0d44f543"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543">osPoolAlloc</a> (<a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a> pool_id)</td></tr>
    139. 

  139. <tr class="memdesc:gaa0b2994f1a866c19e0d11e6e0d44f543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a memory block from a memory pool.  <a href="#gaa0b2994f1a866c19e0d11e6e0d44f543">More...</a><br/></td></tr>
    140. 

  140. <tr class="separator:gaa0b2994f1a866c19e0d11e6e0d44f543"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. <tr class="memitem:ga9f129fcad4730fbd1048ad4fa262f36a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a">osPoolCAlloc</a> (<a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a> pool_id)</td></tr>
    142. 

  142. <tr class="memdesc:ga9f129fcad4730fbd1048ad4fa262f36a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a memory block from a memory pool and set memory block to zero.  <a href="#ga9f129fcad4730fbd1048ad4fa262f36a">More...</a><br/></td></tr>
    143. 

  143. <tr class="separator:ga9f129fcad4730fbd1048ad4fa262f36a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    144. 

  144. <tr class="memitem:ga4a861e9c469c9d0daf5721bf174f8e54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e">osStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga4a861e9c469c9d0daf5721bf174f8e54">osPoolFree</a> (<a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a> pool_id, void *block)</td></tr>
    145. 

  145. <tr class="memdesc:ga4a861e9c469c9d0daf5721bf174f8e54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an allocated memory block back to a specific memory pool.  <a href="#ga4a861e9c469c9d0daf5721bf174f8e54">More...</a><br/></td></tr>
    146. 

  146. <tr class="separator:ga4a861e9c469c9d0daf5721bf174f8e54"><td class="memSeparator" colspan="2">&#160;</td></tr>
    147. 

  147. </table>
    148. 

  148. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    149. 

  149. <p><b>Memory</b> <b>pools</b> are fixed-size blocks of memory that are thread-safe. They operate much faster than the dynamically allocated heap and do not suffer from fragmentation. Being thread-safe, they can be accessed from threads and ISRs alike.</p>
    150. 

  150. <p><b>Shared</b> <b>memory</b> is one of the basic models to exchange information between threads. Using memory pools for exchanging data, you can share more complex objects between threads if compared to a <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a>. Memory pool management functions are used to define and manage such fixed-sized memory pools.</p>
    151. 

  151. <h2>Working with Memory Pools </h2>
    152. 

  152. <p>Follow these steps to create and use a memory pool:</p>
    153. 

  153. <ol type="1">
    154. 

  154. <li>Declare a data structure that combines a number of elements: <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
    155. 

  155. <div class="line">  uint32_t length;</div>
    156. 

  156. <div class="line">  uint32_t width;</div>
    157. 

  157. <div class="line">  uint32_t height;</div>
    158. 

  158. <div class="line">  uint32_t weight;</div>
    159. 

  159. <div class="line">} properties_t;</div>
    160. 

  160. </div><!-- fragment --></li>
    161. 

  161. <li>Declare a memory pool of these objects as a block of memory: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a> (object_pool, 10, properties_t);  <span class="comment">// Declare memory pool</span></div>
    162. 

  162. <div class="line"><a class="code" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>  (object_pool_id);                 <span class="comment">// Memory pool ID</span></div>
    163. 

  163. </div><!-- fragment --></li>
    164. 

  164. <li>Then, create the memory pool in a thread: <div class="fragment"><div class="line">object_pool_id = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a>(<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a>(object_pool));</div>
    165. 

  165. </div><!-- fragment --></li>
    166. 

  166. <li>Allocate the pool within a thread and fill it with data: <div class="fragment"><div class="line">properties_t *object_data;</div>
    167. 

  167. <div class="line"> object_data = (properties_t *) <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543">osPoolAlloc</a>(object_pool_id);</div>
    168. 

  168. <div class="line"> </div>
    169. 

  169. <div class="line">object_data-&gt;length = 100;</div>
    170. 

  170. <div class="line">object_data-&gt;width  = 10;</div>
    171. 

  171. <div class="line">object_data-&gt;height = 23;</div>
    172. 

  172. <div class="line">object_data-&gt;weight = 1000;</div>
    173. 

  173. </div><!-- fragment --> </li>
    174. 

  174. </ol>
    175. 

  175. <h2 class="groupheader">Macro Definition Documentation</h2>
    176. 

  176. <a class="anchor" id="gadd84b683001de327894851b428587caa"></a>
    177. 

  177. <div class="memitem">
    178. 

  178. <div class="memproto">
    179. 

  179.       <table class="memname">
    180. 

  180.         <tr>
    181. 

  181.           <td class="memname">#define osFeature_Pool&#160;&#160;&#160;1</td>
    182. 

  182.         </tr>
    183. 

  183.       </table>
    184. 

  184. </div><div class="memdoc">
    185. 

  185. <p>A CMSIS-RTOS implementation may support fixed-size memory pools.</p>
    186. 

  186. <ul>
    187. 

  187. <li>When <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa">osFeature_Pool</a> is 1 memory pools are supported.</li>
    188. 

  188. <li>When <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gadd84b683001de327894851b428587caa">osFeature_Pool</a> is 0 no memory pools are supported.</li>
    189. 

  189. </ul>
    190. 

  190. <p><a class="el" href="rtxImplementation.html">CMSIS-RTOS RTX</a> Setting: <b>osFeature_Pool</b> is 1 </p>
    191. 

  191. 

  192. </div>
    193. 

  193. </div>
    194. 

  194. <a class="anchor" id="ga5f0b204a82327533d420210125c90697"></a>
    195. 

  195. <div class="memitem">
    196. 

  196. <div class="memproto">
    197. 

  197.       <table class="memname">
    198. 

  198.         <tr>
    199. 

  199.           <td class="memname">#define osPool</td>
    200. 

  200.           <td>(</td>
    201. 

  201.           <td class="paramtype">&#160;</td>
    202. 

  202.           <td class="paramname">name</td><td>)</td>
    203. 

  203.           <td>&#160;&#160;&#160;&amp;os_pool_def_##name</td>
    204. 

  204.         </tr>
    205. 

  205.       </table>
    206. 

  206. </div><div class="memdoc">
    207. 

  207. <p>Access a memory pool for the functions <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a>.</p>
    208. 

  208. <dl class="params"><dt>Parameters</dt><dd>
    209. 

  209.   <table class="params">
    210. 

  210.     <tr><td class="paramname">name</td><td>name of the memory pool </td></tr>
    211. 

  211.   </table>
    212. 

  212.   </dd>
    213. 

  213. </dl>
    214. 

  214. <dl class="section note"><dt>Note</dt><dd>CAN BE CHANGED: The parameter to <b>osPool</b> shall be consistent but the macro body is implementation specific in every CMSIS-RTOS. </dd></dl>
    215. 

  215. 

  216. </div>
    217. 

  217. </div>
    218. 

  218. <a class="anchor" id="ga87b471d4fe2d5dbd0040708edd52771b"></a>
    219. 

  219. <div class="memitem">
    220. 

  220. <div class="memproto">
    221. 

  221.       <table class="memname">
    222. 

  222.         <tr>
    223. 

  223.           <td class="memname">#define osPoolDef</td>
    224. 

  224.           <td>(</td>
    225. 

  225.           <td class="paramtype">&#160;</td>
    226. 

  226.           <td class="paramname">name, </td>
    227. 

  227.         </tr>
    228. 

  228.         <tr>
    229. 

  229.           <td class="paramkey"></td>
    230. 

  230.           <td></td>
    231. 

  231.           <td class="paramtype">&#160;</td>
    232. 

  232.           <td class="paramname">no, </td>
    233. 

  233.         </tr>
    234. 

  234.         <tr>
    235. 

  235.           <td class="paramkey"></td>
    236. 

  236.           <td></td>
    237. 

  237.           <td class="paramtype">&#160;</td>
    238. 

  238.           <td class="paramname">type&#160;</td>
    239. 

  239.         </tr>
    240. 

  240.         <tr>
    241. 

  241.           <td></td>
    242. 

  242.           <td>)</td>
    243. 

  243.           <td></td><td></td>
    244. 

  244.         </tr>
    245. 

  245.       </table>
    246. 

  246. </div><div class="memdoc">
    247. 

  247. <p>Define a memory pool that is referenced by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a>.</p>
    248. 

  248. <dl class="params"><dt>Parameters</dt><dd>
    249. 

  249.   <table class="params">
    250. 

  250.     <tr><td class="paramname">name</td><td>name of the memory pool. </td></tr>
    251. 

  251.     <tr><td class="paramname">no</td><td>maximum number of blocks (objects) in the memory pool. </td></tr>
    252. 

  252.     <tr><td class="paramname">type</td><td>data type of a single block (object). </td></tr>
    253. 

  253.   </table>
    254. 

  254.   </dd>
    255. 

  255. </dl>
    256. 

  256. <dl class="section note"><dt>Note</dt><dd>CAN BE CHANGED: The parameter to <b>osPoolDef</b> shall be consistent but the macro body is implementation specific in every CMSIS-RTOS. </dd></dl>
    257. 

  257. 

  258. </div>
    259. 

  259. </div>
    260. 

  260. <h2 class="groupheader">Function Documentation</h2>
    261. 

  261. <a class="anchor" id="gaa0b2994f1a866c19e0d11e6e0d44f543"></a>
    262. 

  262. <div class="memitem">
    263. 

  263. <div class="memproto">
    264. 

  264.       <table class="memname">
    265. 

  265.         <tr>
    266. 

  266.           <td class="memname">void * osPoolAlloc </td>
    267. 

  267.           <td>(</td>
    268. 

  268.           <td class="paramtype"><a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>&#160;</td>
    269. 

  269.           <td class="paramname"><em>pool_id</em></td><td>)</td>
    270. 

  270.           <td></td>
    271. 

  271.         </tr>
    272. 

  272.       </table>
    273. 

  273. </div><div class="memdoc">
    274. 

  274. <dl class="params"><dt>Parameters</dt><dd>
    275. 

  275.   <table class="params">
    276. 

  276.     <tr><td class="paramdir">[in]</td><td class="paramname">pool_id</td><td>memory pool ID obtain referenced with <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a>. </td></tr>
    277. 

  277.   </table>
    278. 

  278.   </dd>
    279. 

  279. </dl>
    280. 

  280. <dl class="section return"><dt>Returns</dt><dd>address of the allocated memory block or NULL in case of no memory available. </dd></dl>
    281. 

  281. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osPoolAlloc</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    282. 

  282. <p>Allocate a memory block from the memory pool.</p>
    283. 

  283. <dl class="section note"><dt>Note</dt><dd><a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> can call this function.</dd></dl>
    284. 

  284. <p><b>Code Example</b> </p>
    285. 

  285. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os_8h.html">cmsis_os.h</a>&quot;</span></div>
    286. 

  286. <div class="line"> </div>
    287. 

  287. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
    288. 

  288. <div class="line">  uint8_t Buf[32];</div>
    289. 

  289. <div class="line">  uint8_t Idx;</div>
    290. 

  290. <div class="line">} MEM_BLOCK;</div>
    291. 

  291. <div class="line"> </div>
    292. 

  292. <div class="line"><a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a> (MemPool, 8, MEM_BLOCK);</div>
    293. 

  293. <div class="line"> </div>
    294. 

  294. <div class="line"><span class="keywordtype">void</span> AlocMemoryPoolBlock (<span class="keywordtype">void</span>)  {</div>
    295. 

  295. <div class="line">  <a class="code" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>   MemPool_Id;</div>
    296. 

  296. <div class="line">  MEM_BLOCK *addr;</div>
    297. 

  297. <div class="line"> </div>
    298. 

  298. <div class="line">  MemPool_Id = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a> (<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a> (MemPool));</div>
    299. 

  299. <div class="line">  <span class="keywordflow">if</span> (MemPool_Id != NULL)  {</div>
    300. 

  300. <div class="line">    :</div>
    301. 

  301. <div class="line">    <span class="comment">// allocate a memory block</span></div>
    302. 

  302. <div class="line">    addr = (MEM_BLOCK *)<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#gaa0b2994f1a866c19e0d11e6e0d44f543">osPoolAlloc</a> (MemPool_Id);</div>
    303. 

  303. <div class="line">    </div>
    304. 

  304. <div class="line">    <span class="keywordflow">if</span> (addr != NULL) {</div>
    305. 

  305. <div class="line">      <span class="comment">// memory block was allocated</span></div>
    306. 

  306. <div class="line">      :</div>
    307. 

  307. <div class="line">    }</div>
    308. 

  308. <div class="line">  }</div>
    309. 

  309. <div class="line">}</div>
    310. 

  310. </div><!-- fragment --> 
    311. 

  311. </div>
    312. 

  312. </div>
    313. 

  313. <a class="anchor" id="ga9f129fcad4730fbd1048ad4fa262f36a"></a>
    314. 

  314. <div class="memitem">
    315. 

  315. <div class="memproto">
    316. 

  316.       <table class="memname">
    317. 

  317.         <tr>
    318. 

  318.           <td class="memname">void * osPoolCAlloc </td>
    319. 

  319.           <td>(</td>
    320. 

  320.           <td class="paramtype"><a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>&#160;</td>
    321. 

  321.           <td class="paramname"><em>pool_id</em></td><td>)</td>
    322. 

  322.           <td></td>
    323. 

  323.         </tr>
    324. 

  324.       </table>
    325. 

  325. </div><div class="memdoc">
    326. 

  326. <dl class="params"><dt>Parameters</dt><dd>
    327. 

  327.   <table class="params">
    328. 

  328.     <tr><td class="paramdir">[in]</td><td class="paramname">pool_id</td><td>memory pool ID obtain referenced with <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a>. </td></tr>
    329. 

  329.   </table>
    330. 

  330.   </dd>
    331. 

  331. </dl>
    332. 

  332. <dl class="section return"><dt>Returns</dt><dd>address of the allocated memory block or NULL in case of no memory available. </dd></dl>
    333. 

  333. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osPoolCAlloc</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    334. 

  334. <p>Allocate a memory block from the memory pool. The block is initialized to zero.</p>
    335. 

  335. <dl class="section note"><dt>Note</dt><dd><a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> can call this function.</dd></dl>
    336. 

  336. <p><b>Code Example</b> </p>
    337. 

  337. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os_8h.html">cmsis_os.h</a>&quot;</span></div>
    338. 

  338. <div class="line"> </div>
    339. 

  339. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
    340. 

  340. <div class="line">  uint8_t Buf[32];</div>
    341. 

  341. <div class="line">  uint8_t Idx;</div>
    342. 

  342. <div class="line">} MEM_BLOCK;</div>
    343. 

  343. <div class="line"> </div>
    344. 

  344. <div class="line"><a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a> (MemPool, 8, MEM_BLOCK);</div>
    345. 

  345. <div class="line"> </div>
    346. 

  346. <div class="line"><span class="keywordtype">void</span> CAlocMemoryPoolBlock (<span class="keywordtype">void</span>)  {</div>
    347. 

  347. <div class="line">  <a class="code" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>   MemPool_Id;</div>
    348. 

  348. <div class="line">  MEM_BLOCK *addr;</div>
    349. 

  349. <div class="line"> </div>
    350. 

  350. <div class="line">  MemPool_Id = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a> (<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a> (MemPool));</div>
    351. 

  351. <div class="line">  <span class="keywordflow">if</span> (MemPool_Id != NULL)  {</div>
    352. 

  352. <div class="line">    :</div>
    353. 

  353. <div class="line">    <span class="comment">// allocate a memory block</span></div>
    354. 

  354. <div class="line">    addr = (MEM_BLOCK *)<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a">osPoolCAlloc</a> (MemPool_Id);</div>
    355. 

  355. <div class="line">    </div>
    356. 

  356. <div class="line">    <span class="keywordflow">if</span> (addr != NULL) {</div>
    357. 

  357. <div class="line">      <span class="comment">// memory block was allocated</span></div>
    358. 

  358. <div class="line">      :</div>
    359. 

  359. <div class="line">    }</div>
    360. 

  360. <div class="line">  }</div>
    361. 

  361. <div class="line">}</div>
    362. 

  362. </div><!-- fragment --> 
    363. 

  363. </div>
    364. 

  364. </div>
    365. 

  365. <a class="anchor" id="ga34af5c4f4ab38f4138ea7f1f9ece3a1a"></a>
    366. 

  366. <div class="memitem">
    367. 

  367. <div class="memproto">
    368. 

  368.       <table class="memname">
    369. 

  369.         <tr>
    370. 

  370.           <td class="memname"><a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a> osPoolCreate </td>
    371. 

  371.           <td>(</td>
    372. 

  372.           <td class="paramtype">const <a class="el" href="cmsis__os_8h.html#structosPoolDef__t">osPoolDef_t</a> *&#160;</td>
    373. 

  373.           <td class="paramname"><em>pool_def</em></td><td>)</td>
    374. 

  374.           <td></td>
    375. 

  375.         </tr>
    376. 

  376.       </table>
    377. 

  377. </div><div class="memdoc">
    378. 

  378. <dl class="params"><dt>Parameters</dt><dd>
    379. 

  379.   <table class="params">
    380. 

  380.     <tr><td class="paramdir">[in]</td><td class="paramname">pool_def</td><td>memory pool definition referenced with <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a>. </td></tr>
    381. 

  381.   </table>
    382. 

  382.   </dd>
    383. 

  383. </dl>
    384. 

  384. <dl class="section return"><dt>Returns</dt><dd>memory pool ID for reference by other functions or NULL in case of error. </dd></dl>
    385. 

  385. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osPoolCreate</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    386. 

  386. <p>Create and initialize a memory pool.</p>
    387. 

  387. <dl class="section note"><dt>Note</dt><dd>Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    388. 

  388. <p><b>Code Example</b> </p>
    389. 

  389. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os_8h.html">cmsis_os.h</a>&quot;</span></div>
    390. 

  390. <div class="line"> </div>
    391. 

  391. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
    392. 

  392. <div class="line">  uint8_t Buf[32];</div>
    393. 

  393. <div class="line">  uint8_t Idx;</div>
    394. 

  394. <div class="line">} MEM_BLOCK;</div>
    395. 

  395. <div class="line"> </div>
    396. 

  396. <div class="line"><a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a> (MemPool, 8, MEM_BLOCK);</div>
    397. 

  397. <div class="line">  </div>
    398. 

  398. <div class="line"><span class="keywordtype">void</span> CreateMemoryPool (<span class="keywordtype">void</span>)  {</div>
    399. 

  399. <div class="line"><a class="code" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a> MemPool_Id;</div>
    400. 

  400. <div class="line"> </div>
    401. 

  401. <div class="line">  MemPool_Id = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a> (<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a> (MemPool));</div>
    402. 

  402. <div class="line">  <span class="keywordflow">if</span> (MemPool_Id != NULL)  {</div>
    403. 

  403. <div class="line">    <span class="comment">// memory pool created</span></div>
    404. 

  404. <div class="line">  }</div>
    405. 

  405. <div class="line">}</div>
    406. 

  406. </div><!-- fragment --> 
    407. 

  407. </div>
    408. 

  408. </div>
    409. 

  409. <a class="anchor" id="ga4a861e9c469c9d0daf5721bf174f8e54"></a>
    410. 

  410. <div class="memitem">
    411. 

  411. <div class="memproto">
    412. 

  412.       <table class="memname">
    413. 

  413.         <tr>
    414. 

  414.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e">osStatus</a> osPoolFree </td>
    415. 

  415.           <td>(</td>
    416. 

  416.           <td class="paramtype"><a class="el" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>&#160;</td>
    417. 

  417.           <td class="paramname"><em>pool_id</em>, </td>
    418. 

  418.         </tr>
    419. 

  419.         <tr>
    420. 

  420.           <td class="paramkey"></td>
    421. 

  421.           <td></td>
    422. 

  422.           <td class="paramtype">void *&#160;</td>
    423. 

  423.           <td class="paramname"><em>block</em>&#160;</td>
    424. 

  424.         </tr>
    425. 

  425.         <tr>
    426. 

  426.           <td></td>
    427. 

  427.           <td>)</td>
    428. 

  428.           <td></td><td></td>
    429. 

  429.         </tr>
    430. 

  430.       </table>
    431. 

  431. </div><div class="memdoc">
    432. 

  432. <dl class="params"><dt>Parameters</dt><dd>
    433. 

  433.   <table class="params">
    434. 

  434.     <tr><td class="paramdir">[in]</td><td class="paramname">pool_id</td><td>memory pool ID obtain referenced with <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a>. </td></tr>
    435. 

  435.     <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block that is returned to the memory pool. </td></tr>
    436. 

  436.   </table>
    437. 

  437.   </dd>
    438. 

  438. </dl>
    439. 

  439. <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function. </dd></dl>
    440. 

  440. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osPoolFree</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    441. 

  441. <p>Return a memory block to a memory pool.</p>
    442. 

  442. <p><b><a class="el" href="group__CMSIS__RTOS__Status.html">Status and Error Codes</a></b><br/>
    443. 

  443. </p>
    444. 

  444. <ul>
    445. 

  445. <li><em>osOK:</em> the memory block is released.</li>
    446. 

  446. <li><em>osErrorValue:</em> <em>block</em> does not belong to the memory pool.</li>
    447. 

  447. <li><em>osErrorParameter:</em> a parameter is invalid or outside of a permitted range.</li>
    448. 

  448. </ul>
    449. 

  449. <dl class="section note"><dt>Note</dt><dd><a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> can call this function.</dd></dl>
    450. 

  450. <p><b>Code Example</b> </p>
    451. 

  451. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os_8h.html">cmsis_os.h</a>&quot;</span></div>
    452. 

  452. <div class="line"> </div>
    453. 

  453. <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
    454. 

  454. <div class="line">  uint8_t Buf[32];</div>
    455. 

  455. <div class="line">  uint8_t Idx;</div>
    456. 

  456. <div class="line">} MEM_BLOCK;</div>
    457. 

  457. <div class="line"> </div>
    458. 

  458. <div class="line"><a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga87b471d4fe2d5dbd0040708edd52771b">osPoolDef</a> (MemPool, 8, MEM_BLOCK);</div>
    459. 

  459. <div class="line">  </div>
    460. 

  460. <div class="line"><span class="keywordtype">void</span> CAlocMemoryPoolBlock (<span class="keywordtype">void</span>)  {</div>
    461. 

  461. <div class="line">  <a class="code" href="cmsis__os_8h.html#a08d2e20fd9bbd96220fe068d420f3686">osPoolId</a>   MemPool_Id;</div>
    462. 

  462. <div class="line">  MEM_BLOCK *addr;</div>
    463. 

  463. <div class="line">  <a class="code" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e">osStatus</a>   status;</div>
    464. 

  464. <div class="line">  </div>
    465. 

  465. <div class="line">  MemPool_Id = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga34af5c4f4ab38f4138ea7f1f9ece3a1a">osPoolCreate</a> (<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga5f0b204a82327533d420210125c90697">osPool</a> (MemPool));</div>
    466. 

  466. <div class="line">  <span class="keywordflow">if</span> (MemPool_Id != NULL)  {</div>
    467. 

  467. <div class="line">    addr = (MEM_BLOCK *)<a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga9f129fcad4730fbd1048ad4fa262f36a">osPoolCAlloc</a> (MemPool_Id);</div>
    468. 

  468. <div class="line">    <span class="keywordflow">if</span> (addr != NULL) {</div>
    469. 

  469. <div class="line">      :</div>
    470. 

  470. <div class="line">      <span class="comment">// return a memory block back to pool</span></div>
    471. 

  471. <div class="line">      status = <a class="code" href="group__CMSIS__RTOS__PoolMgmt.html#ga4a861e9c469c9d0daf5721bf174f8e54">osPoolFree</a> (MemPool_Id, addr);</div>
    472. 

  472. <div class="line">      <span class="keywordflow">if</span> (status==<a class="code" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99ea9e1c9e2550bb4de8969a935acffc968f">osOK</a>)  {</div>
    473. 

  473. <div class="line">        <span class="comment">// handle status code</span></div>
    474. 

  474. <div class="line">      }</div>
    475. 

  475. <div class="line">    }</div>
    476. 

  476. <div class="line">  }</div>
    477. 

  477. <div class="line">}</div>
    478. 

  478. </div><!-- fragment --> 
    479. 

  479. </div>
    480. 

  480. </div>
    481. 

  481. </div><!-- contents -->
    482. 

  482. </div><!-- doc-content -->
    483. 

  483. <!-- start footer part -->
    484. 

  484. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    485. 

  485.   <ul>
    486. 

  486.     <li class="footer">Generated on Mon Mar 18 2019 16:06:29 for CMSIS-RTOS by Arm Ltd. All rights reserved.
    487. 

  487. 	<!--
    488. 

  488.     <a href="http://www.doxygen.org/index.html">
    489. 

  489.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    490. 

  490. 	-->
    491. 

  491. 	</li>
    492. 

  492.   </ul>
    493. 

  493. </div>
    494. 

  494. </body>
    495. 

  495. </html>
    496.