Acasă Explorează Ajutor
Autentificare
ARM-software
/
CMSIS_5
oglindă de https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Arbore: 5.7.0
Ramuri Etichete
CMSIS_5
/
docs
/
RTOS2
/
html
/
os2MigrationFunctions.html

os2MigrationFunctions.html 50 KB
Permalink Istoric Crud

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766 
  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>Detailed API Function Differences</title>
    7. 

  7. <title>CMSIS-RTOS2: Detailed API Function Differences</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-RTOS2
    35. 

  35.    &#160;<span id="projectnumber">Version 2.1.3</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 class="current"><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('os2MigrationFunctions.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="headertitle">
    111. 

  111. <div class="title">Detailed API Function Differences </div>  </div>
    112. 

  112. </div><!--header-->
    113. 

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

  114. <div class="textblock"><p>This section lists the CMSIS-RTOS API v1 and API v2 functions along with the differences in functionality. The list is sorted alphabetically by API v2 function names and is structured the following way:</p>
    115. 

  115. <ul>
    116. 

  116. <li>RTOS API v2 function prototype</li>
    117. 

  117. <li>RTOS API v1 function prototype that is equivalent or provides similar functionality</li>
    118. 

  118. <li>Brief description of the RTOS v2 function.</li>
    119. 

  119. <li>Description of the difference.</li>
    120. 

  120. </ul>
    121. 

  121. <p>The background color indicates:</p>
    122. 

  122. <ul>
    123. 

  123. <li><div class="new">Green: New functions in API v2 that are not available in API v1 </div></li>
    124. 

  124. <li><div class="mod">Amber: Functions that are modified or replaced in API v2 compared to API v1 </div></li>
    125. 

  125. <li><div class="del">Red: Functions in API v1 that are deprecated in API v2 </div></li>
    126. 

  126. </ul>
    127. 

  127. <h1><a class="anchor" id="mig_kernel"></a>
    128. 

  128. Kernel Information and Control</h1>
    129. 

  129. <hr/>
    130. 

  130. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199" title="Get RTOS Kernel Information. ">osKernelGetInfo</a> (osVersion_t* version, char* id_buf, uint32_t id_size)</code> <br/>
    131. 

  131.  <em>none</em> <br/>
    132. 

  132.  <br/>
    133. 

  133.  Get RTOS Kernel Information. <br/>
    134. 

  134.  New function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199" title="Get RTOS Kernel Information. ">osKernelGetInfo</a>. </div><hr/>
    135. 

  135. <div class="mod"> <code>osKernelState_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba" title="Get the current RTOS Kernel state. ">osKernelGetState</a> (void)</code> <br/>
    136. 

  136.  <code>int32_t &#160; &#160; &#160; &#160; osKernelRunning (void)</code> <br/>
    137. 

  137.  <br/>
    138. 

  138.  Get the current RTOS Kernel state. <br/>
    139. 

  139. </p>
    140. 

  140. <ul>
    141. 

  141. <li>The function <b>osKernelGetState</b> replaces the RTOS v1 function <b>osKernelRunning</b>.</li>
    142. 

  142. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a>.</li>
    143. 

  143. </ul>
    144. 

  144. </div><div class="mod"> </div><hr/>
    145. 

  145. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b" title="Get the RTOS kernel tick count. ">osKernelGetTickCount</a> (void)</code> <br/>
    146. 

  146.  <em>none</em> <br/>
    147. 

  147.  <br/>
    148. 

  148.  Get the RTOS kernel tick count. <br/>
    149. 

  149.  New function. </div><hr/>
    150. 

  150. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga7a8d7bd927eaaa58999f91d7d6310cee" title="Get the RTOS kernel tick frequency. ">osKernelGetTickFreq</a> (void)</code> <br/>
    151. 

  151.  <em>none</em> <br/>
    152. 

  152.  <br/>
    153. 

  153.  Get the RTOS kernel tick frequency. <br/>
    154. 

  154. </p>
    155. 

  155. <ul>
    156. 

  156. <li>The function <b>osKernelGetTickFreq</b> replaces the RTOS v1 macro <b>osKernelTickMicroSec</b>.</li>
    157. 

  157. </ul>
    158. 

  158. </div><div class="new"> </div><hr/>
    159. 

  159. <div class="mod"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2" title="Get the RTOS kernel system timer count. ">osKernelGetSysTimerCount</a> (void)</code> <br/>
    160. 

  160.  <code>uint32_t osKernelSysTick (void)</code> <br/>
    161. 

  161.  <br/>
    162. 

  162.  Get the RTOS kernel system timer count. <br/>
    163. 

  163. </p>
    164. 

  164. <ul>
    165. 

  165. <li>The function <b>osKernelGetSysTimerCount</b> replaces the RTOS v1 function <b>osKernelSysTick</b>.</li>
    166. 

  166. </ul>
    167. 

  167. </div><div class="mod"> </div><hr/>
    168. 

  168. <div class="new"> <code>uint64_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga4d69215a93220f72be3684cad582f16a" title="Get the RTOS kernel system timer frequency. ">osKernelGetSysTimerFreq</a> (void)</code> <br/>
    169. 

  169.  <em>none</em> <br/>
    170. 

  170.  <br/>
    171. 

  171.  Get the RTOS kernel system timer frequency. <br/>
    172. 

  172.  New function. </div><hr/>
    173. 

  173. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659" title="Initialize the RTOS Kernel. ">osKernelInitialize</a> (void)</code> <br/>
    174. 

  174.  <code>osStatus &#160; osKernelInitialize (void)</code> <br/>
    175. 

  175.  <br/>
    176. 

  176.  Initialize the RTOS Kernel. <br/>
    177. 

  177. </p>
    178. 

  178. <ul>
    179. 

  179. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>.</li>
    180. 

  180. </ul>
    181. 

  181. </div><div class="mod"> </div><hr/>
    182. 

  182. <div class="new"> <code>int32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12" title="Lock the RTOS Kernel scheduler. ">osKernelLock</a> (void)</code> <br/>
    183. 

  183.  <em>none</em> <br/>
    184. 

  184.  <br/>
    185. 

  185.  Lock the RTOS Kernel scheduler. <br/>
    186. 

  186.  New function. </div><hr/>
    187. 

  187. <div class="new"> <code>int32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720" title="Unlock the RTOS Kernel scheduler. ">osKernelUnlock</a> (void)</code> <br/>
    188. 

  188.  <em>none</em> <br/>
    189. 

  189.  <br/>
    190. 

  190.  Unlock the RTOS Kernel scheduler. <br/>
    191. 

  191.  New function. </div><hr/>
    192. 

  192. <div class="new"> <code>void <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289" title="Restore the RTOS Kernel scheduler lock state. ">osKernelRestoreLock</a> (void)</code> <br/>
    193. 

  193.  <em>none</em> <br/>
    194. 

  194.  <br/>
    195. 

  195.  Restore the RTOS Kernel scheduler lock state. <br/>
    196. 

  196.  New function. </div><hr/>
    197. 

  197. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221" title="Start the RTOS Kernel scheduler. ">osKernelStart</a> (void)</code> <br/>
    198. 

  198.  <code>osStatus &#160; osKernelStart (void)</code> <br/>
    199. 

  199.  <br/>
    200. 

  200.  Start the RTOS Kernel scheduler. <br/>
    201. 

  201. </p>
    202. 

  202. <ul>
    203. 

  203. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>.</li>
    204. 

  204. </ul>
    205. 

  205. </div><div class="mod"> </div><hr/>
    206. 

  206. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f" title="Suspend the RTOS Kernel scheduler. ">osKernelSuspend</a> (void)</code> <br/>
    207. 

  207.  <em>none</em> <br/>
    208. 

  208.  <br/>
    209. 

  209.  Suspend the RTOS Kernel scheduler. <br/>
    210. 

  210.  New function. </div><hr/>
    211. 

  211. <div class="new"> <code>void <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced" title="Resume the RTOS Kernel scheduler. ">osKernelResume</a> (uint32_t sleep_time)</code> <br/>
    212. 

  212.  <em>none</em> <br/>
    213. 

  213.  <br/>
    214. 

  214.  Resume the RTOS Kernel scheduler. <br/>
    215. 

  215.  New function. </div><h1><a class="anchor" id="mig_threadMgmt"></a>
    216. 

  216. Thread Management</h1>
    217. 

  217. <hr/>
    218. 

  218. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaaad14cd9547341ea8109dc4e8540f1dc" title="Detach a thread (thread storage can be reclaimed when thread terminates). ">osThreadDetach</a> (osThreadId_t thread_id)</code> <br/>
    219. 

  219.  <em>none</em> <br/>
    220. 

  220.  <br/>
    221. 

  221.  Detach a thread (thread storage can be reclaimed when thread terminates). <br/>
    222. 

  222.  New function. </div><hr/>
    223. 

  223. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga5606604d56e21ece1a654664be877439" title="Enumerate active threads. ">osThreadEnumerate</a> (osThreadId_t *thread_array, uint32_t array_items)</code> <br/>
    224. 

  224.  <em>none</em> <br/>
    225. 

  225.  <br/>
    226. 

  226.  Enumerate active threads. <br/>
    227. 

  227.  New function. </div><hr/>
    228. 

  228. <div class="new"> <code>__NO_RETURN void <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaddaa452dd7610e4096647a566d3556fc" title="Terminate execution of current running thread. ">osThreadExit</a> (void)</code> <br/>
    229. 

  229.  <em>none</em> <br/>
    230. 

  230.  <br/>
    231. 

  231.  Terminate execution of current running thread. <br/>
    232. 

  232.  New function. </div><hr/>
    233. 

  233. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga495b3f812224e7301f23a691793765db" title="Get number of active threads. ">osThreadGetCount</a> (osThreadId_t thread_id)</code> <br/>
    234. 

  234.  <em>none</em> <br/>
    235. 

  235.  <br/>
    236. 

  236.  Get number of active threads. <br/>
    237. 

  237.  New function. </div><hr/>
    238. 

  238. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gac3230f3a55a297514b013ebf38f27e0a" title="Get name of a thread. ">osThreadGetName</a> (osThreadId_t thread_id)</code> <br/>
    239. 

  239.  <em>none</em> <br/>
    240. 

  240.  <br/>
    241. 

  241.  Get name of a thread. <br/>
    242. 

  242.  New function. </div><hr/>
    243. 

  243. <div class="mod"> <code>osThreadId_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da" title="Return the thread ID of the current running thread. ">osThreadGetId</a> (void)</code> <br/>
    244. 

  244.  <code>osThreadId &#160; osThreadGetId (void)</code> <br/>
    245. 

  245.  <br/>
    246. 

  246.  Return the thread ID of the current running thread. <br/>
    247. 

  247. </p>
    248. 

  248. <ul>
    249. 

  249. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>.</li>
    250. 

  250. </ul>
    251. 

  251. </div><div class="mod"> </div><hr/>
    252. 

  252. <div class="mod"> <code>osPriority_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga0aeaf349604f456e68e78f9d3b42e44b" title="Get current priority of a thread. ">osThreadGetPriority</a> (osThreadId_t thread_id)</code> <br/>
    253. 

  253.  <code>osPriority &#160; osThreadGetPriority (osThreadId thread_id)</code> <br/>
    254. 

  254.  <br/>
    255. 

  255.  Get current priority of a thread. <br/>
    256. 

  256. </p>
    257. 

  257. <ul>
    258. 

  258. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec" title="Priority values. ">osPriority_t</a>.</li>
    259. 

  259. <li>Parameter type changed to <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>.</li>
    260. 

  260. </ul>
    261. 

  261. </div><div class="mod"> </div><hr/>
    262. 

  262. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gab9f8bd715d671c6ee27644867bc1bf65" title="Get stack size of a thread. ">osThreadGetStackSize</a> (osThreadId_t thread_id)</code> <br/>
    263. 

  263.  <em>none</em> <br/>
    264. 

  264.  <br/>
    265. 

  265.  Get stack size of a thread. <br/>
    266. 

  266.  New function. </div><hr/>
    267. 

  267. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga9c83bd5dd8de329701775d6ef7012720" title="Get available stack space of a thread based on stack watermark recording during execution. ">osThreadGetStackSpace</a> (osThreadId_t thread_id)</code> <br/>
    268. 

  268.  <em>none</em> <br/>
    269. 

  269.  <br/>
    270. 

  270.  Get available stack space of a thread based on stack watermark recording during execution. <br/>
    271. 

  271.  New function. </div><hr/>
    272. 

  272. <div class="new"> <code>osThreadState_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gacc0a98b42f0a5928e12dc91dc76866b9" title="Get current thread state of a thread. ">osThreadGetState</a> (osThreadId_t thread_id)</code> <br/>
    273. 

  273.  <em>none</em> <br/>
    274. 

  274.  <br/>
    275. 

  275.  Get current thread state of a thread. <br/>
    276. 

  276.  New function. </div><hr/>
    277. 

  277. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga3fca90fb0679afeb968aa8c3d5874487" title="Wait for specified thread to terminate. ">osThreadJoin</a> (osThreadId_t thread_id)</code> <br/>
    278. 

  278.  <em>none</em> <br/>
    279. 

  279.  <br/>
    280. 

  280.  Wait for specified thread to terminate. <br/>
    281. 

  281.  New function. </div><hr/>
    282. 

  282. <div class="mod"> <code>osThreadId_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads. ">osThreadNew</a> (osThreadFunc_t function, void *argument, const <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t" title="Attributes structure for thread. ">osThreadAttr_t</a> *attr)</code> <br/>
    283. 

  283.  <code>osThreadId &#160; osThreadCreate (const osThreadDef_t *thread_def, void *argument)</code> <br/>
    284. 

  284.  <br/>
    285. 

  285.  Create a thread and add it to Active Threads. <br/>
    286. 

  286. </p>
    287. 

  287. <ul>
    288. 

  288. <li>The function <b>osThreadNew</b> replaces the RTOS v1 function <b>osThreadCreate</b>.</li>
    289. 

  289. <li>Options are now passed using a <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#structosThreadAttr__t">osThreadAttr_t</a> struct, replacing the <b>osThreadDef</b> macro.</li>
    290. 

  290. <li>New function prototype is <code>void func (void *arg)</code>, before: <code>void func (const void *arg)</code>.</li>
    291. 

  291. </ul>
    292. 

  292. </div><div class="mod"> </div><hr/>
    293. 

  293. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga3dbad90eff394b02de76a452c84c5d80" title="Resume execution of a thread. ">osThreadResume</a> (osThreadId_t thread_id)</code> <br/>
    294. 

  294.  <em>none</em> <br/>
    295. 

  295.  <br/>
    296. 

  296.  Resume execution of a thread. <br/>
    297. 

  297.  New function. </div><hr/>
    298. 

  298. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga861a420fb2d643115b06622903fb3bfb" title="Change priority of a thread. ">osThreadSetPriority</a> (osThreadId_t thread_id, osPriority_t priority)</code> <br/>
    299. 

  299.  <code>osStatus &#160; osThreadSetPriority (osThreadId thread_id, osPriority priority)</code> <br/>
    300. 

  300.  <br/>
    301. 

  301.  Change priority of a thread. <br/>
    302. 

  302. </p>
    303. 

  303. <ul>
    304. 

  304. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    305. 

  305. <li>Parameter types changed to <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> and <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad4e3e0971b41f2d17584a8c6837342ec" title="Priority values. ">osPriority_t</a>.</li>
    306. 

  306. </ul>
    307. 

  307. </div><div class="mod"> </div><hr/>
    308. 

  308. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa9de419d0152bf77e9bbcd1f369fb990" title="Suspend execution of a thread. ">osThreadSuspend</a> (osThreadId_t thread_id)</code> <br/>
    309. 

  309.  <em>none</em> <br/>
    310. 

  310.  <br/>
    311. 

  311.  Suspend execution of a thread. <br/>
    312. 

  312.  New function. </div><hr/>
    313. 

  313. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga2f8ba6dba6e9c065a6e236ffd410d74a" title="Terminate execution of a thread. ">osThreadTerminate</a> (osThreadId_t thread_id)</code> <br/>
    314. 

  314.  <code>osStatus &#160; osThreadTerminate (osThreadId thread_id)</code> <br/>
    315. 

  315.  <br/>
    316. 

  316.  Terminate execution of a thread. <br/>
    317. 

  317. </p>
    318. 

  318. <ul>
    319. 

  319. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    320. 

  320. <li>Parameter type changed to <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>.</li>
    321. 

  321. </ul>
    322. 

  322. </div><div class="mod"> </div><hr/>
    323. 

  323. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2" title="Pass control to next thread that is in state READY. ">osThreadYield</a> (void)</code> <br/>
    324. 

  324.  <code>osStatus &#160; osThreadYield (void)</code> <br/>
    325. 

  325.  <br/>
    326. 

  326.  Pass control to next thread that is in state <b>READY</b>. <br/>
    327. 

  327. </p>
    328. 

  328. <ul>
    329. 

  329. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    330. 

  330. </ul>
    331. 

  331. </div><div class="mod"> </div><h1><a class="anchor" id="mig_threadFlags"></a>
    332. 

  332. Thread Flags</h1>
    333. 

  333. <p>New section to synchronize threads using flags. Thread flags and the more flexible <a class="el" href="os2MigrationFunctions.html#mig_eventFlags">Event Flags</a> are replacing the RTOS v1 <b>Signal Events</b>. Refer to <a class="el" href="os2MigrationFunctions.html#mig_signalEvents">Signal Events</a> for a list of deprecated functions. Refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> for details.</p>
    334. 

  334. <hr/>
    335. 

  335. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread. ">osThreadFlagsSet</a> (osThreadId_t thread_id, uint32_t flags)</code> <br/>
    336. 

  336.  <em>none</em> <br/>
    337. 

  337.  <br/>
    338. 

  338.  Set the specified Thread Flags of a thread. <br/>
    339. 

  339.  New function. </div><hr/>
    340. 

  340. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa" title="Clear the specified Thread Flags of current running thread. ">osThreadFlagsClear</a> (uint32_t flags)</code> <br/>
    341. 

  341.  <em>none</em> <br/>
    342. 

  342.  <br/>
    343. 

  343.  Clear the specified Thread Flags of current running thread. <br/>
    344. 

  344.  New function. </div><hr/>
    345. 

  345. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga85c8d2c89466e25abbcb545d9ddd71ba" title="Get the current Thread Flags of current running thread. ">osThreadFlagsGet</a> (void)</code> <br/>
    346. 

  346.  <em>none</em> <br/>
    347. 

  347.  <br/>
    348. 

  348.  Get the current Thread Flags of current running thread. <br/>
    349. 

  349.  New function. </div><hr/>
    350. 

  350. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled. ">osThreadFlagsWait</a> (uint32_t flags, uint32_t options, uint32_t timeout)</code> <br/>
    351. 

  351.  <em>none</em> <br/>
    352. 

  352.  <br/>
    353. 

  353.  Wait for one or more Thread Flags of the current running thread to become signaled. <br/>
    354. 

  354.  New function. </div><h1><a class="anchor" id="mig_eventFlags"></a>
    355. 

  355. Event Flags</h1>
    356. 

  356. <p>New section to synchronize events using flags. Event flags and thread flags are replacing the RTOS v1 <b>Signal Events</b>. All functions listed in the RTOS v1 <b>Signal Events</b> have been deprecated. Refer to <a class="el" href="os2MigrationFunctions.html#mig_signalEvents">Signal Events</a> for a list of deprecated functions. Refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> for details about the new function.</p>
    357. 

  357. <hr/>
    358. 

  358. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5" title="Clear the specified Event Flags. ">osEventFlagsClear</a> (osEventFlagsId_t ef_id, uint32_t flags)</code> <br/>
    359. 

  359.  <em>none</em> <br/>
    360. 

  360.  <br/>
    361. 

  361.  Clear the specified Event Flags. <br/>
    362. 

  362.  New function. </div><hr/>
    363. 

  363. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga59f4ddf0ee8c395b1672bb978d1cfc88" title="Get name of an Event Flags object. ">osEventFlagsGetName</a> (osEventFlagsId_t ef_id)</code> <br/>
    364. 

  364.  <em>none</em> <br/>
    365. 

  365.  <br/>
    366. 

  366.  Get name of an Event Flags object. <br/>
    367. 

  367.  New function. </div><hr/>
    368. 

  368. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga7c4acf2fb0d506ec82905dee53fb5435" title="Delete an Event Flags object. ">osEventFlagsDelete</a> (osEventFlagsId_t ef_id)</code> <br/>
    369. 

  369.  <em>none</em> <br/>
    370. 

  370.  <br/>
    371. 

  371.  Delete an Event Flags object. <br/>
    372. 

  372.  New function. </div><hr/>
    373. 

  373. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga8bda3185f46bfd278cea8a6cf357677d" title="Get the current Event Flags. ">osEventFlagsGet</a> (osEventFlagsId_t ef_id)</code> <br/>
    374. 

  374.  <em>none</em> <br/>
    375. 

  375.  <br/>
    376. 

  376.  Get the current Event Flags. <br/>
    377. 

  377.  New function. </div><hr/>
    378. 

  378. <div class="new"> <code>osEventFlagsId_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df" title="Create and Initialize an Event Flags object. ">osEventFlagsNew</a> (const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t" title="Attributes structure for event flags. ">osEventFlagsAttr_t</a> *attr)</code> <br/>
    379. 

  379.  <em>none</em> <br/>
    380. 

  380.  <br/>
    381. 

  381.  Create and Initialize an Event Flags object. <br/>
    382. 

  382.  New function. </div><hr/>
    383. 

  383. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e" title="Set the specified Event Flags. ">osEventFlagsSet</a> (osEventFlagsId_t ef_id, uint32_t flags)</code> <br/>
    384. 

  384.  <em>none</em> <br/>
    385. 

  385.  <br/>
    386. 

  386.  Set the specified Event Flags. <br/>
    387. 

  387.  New function. </div><hr/>
    388. 

  388. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e" title="Wait for one or more Event Flags to become signaled. ">osEventFlagsWait</a> (osEventFlagsId_t ef_id, uint32_t flags, uint32_t options, uint32_t timeout)</code> <br/>
    389. 

  389.  <em>none</em> <br/>
    390. 

  390.  <br/>
    391. 

  391.  Wait for one or more Event Flags to become signaled. <br/>
    392. 

  392.  New function. </div><h1><a class="anchor" id="mig_wait"></a>
    393. 

  393. Generic Wait Functions</h1>
    394. 

  394. <p>Refer to <a class="el" href="group__CMSIS__RTOS__Wait.html">Generic Wait Functions</a> for details.</p>
    395. 

  395. <hr/>
    396. 

  396. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay). ">osDelay</a> (uint32_t ticks)</code> <br/>
    397. 

  397.  <code>osStatus &#160; osDelay (uint32_t timeout)</code> <br/>
    398. 

  398.  <br/>
    399. 

  399.  Wait for Timeout (Time Delay). <br/>
    400. 

  400. </p>
    401. 

  401. <ul>
    402. 

  402. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    403. 

  403. </ul>
    404. 

  404. </div><div class="mod"> </div><hr/>
    405. 

  405. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1" title="Wait until specified time. ">osDelayUntil</a> (uint32_t ticks)</code> <br/>
    406. 

  406.  <em>none</em> <br/>
    407. 

  407.  <br/>
    408. 

  408.  Wait until specified time. <br/>
    409. 

  409.  New function. </div><hr/>
    410. 

  410. <div class="del"> <em>none</em> <br/>
    411. 

  411.  <code>osEvent osWait (uint32_t millisec)</code> <br/>
    412. 

  412.  <br/>
    413. 

  413. Deprecated. </div><h1><a class="anchor" id="mig_timer"></a>
    414. 

  414. Timer Management</h1>
    415. 

  415. <p>Refer to <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html">Timer Management</a> for details.</p>
    416. 

  416. <hr/>
    417. 

  417. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad0001dd74721ab461789324806db2453" title="Delete a timer. ">osTimerDelete</a> (osTimerId_t timer_id)</code> <br/>
    418. 

  418.  <code>osStatus &#160; osTimerDelete (osTimerId timer_id)</code> <br/>
    419. 

  419.  <br/>
    420. 

  420.  Delete a timer. <br/>
    421. 

  421. </p>
    422. 

  422. <ul>
    423. 

  423. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    424. 

  424. <li>The parameter type has changed to <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>.</li>
    425. 

  425. </ul>
    426. 

  426. </div><div class="mod"> </div><hr/>
    427. 

  427. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga4f82a98eee4d9ea79507e44340d3d319" title="Get name of a timer. ">osTimerGetName</a> (osTimerId_t timer_id)</code> <br/>
    428. 

  428.  <em>none</em> <br/>
    429. 

  429.  <br/>
    430. 

  430.  Get name of a timer. <br/>
    431. 

  431.  New function. </div><hr/>
    432. 

  432. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#ga69d3589f54194022c30dd01e45ec6741" title="Check if a timer is running. ">osTimerIsRunning</a> (osTimerId_t timer_id)</code> <br/>
    433. 

  433.  <em>none</em> <br/>
    434. 

  434.  <br/>
    435. 

  435.  Check if a timer is running. <br/>
    436. 

  436.  New function. </div><hr/>
    437. 

  437. <div class="mod"> <code>osTimerId_t <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gad4e7f785c5f700a509f55a3bf6a62bec" title="Create and Initialize a timer. ">osTimerNew</a> (osTimerFunc_t func, osTimerType_t type, void *argument, const <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#structosTimerAttr__t" title="Attributes structure for timer. ">osTimerAttr_t</a> *attr)</code> <br/>
    438. 

  438.  <code>osTimerId &#160; osTimerCreate (const osTimerDef_t *timer_def, os_timer_type type, void *argument)</code> <br/>
    439. 

  439.  <br/>
    440. 

  440.  Create and Initialize a timer. <br/>
    441. 

  441. </p>
    442. 

  442. <ul>
    443. 

  443. <li>The function <b>osTimerNew</b> replaces the RTOS v1 function <b>osTimerCreate</b>.</li>
    444. 

  444. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>.</li>
    445. 

  445. <li>The parameter list and types have changed.</li>
    446. 

  446. </ul>
    447. 

  447. </div><div class="mod"> </div><hr/>
    448. 

  448. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gab6ee2859ea657641b7adfac599b8121d" title="Start or restart a timer. ">osTimerStart</a> (osTimerId_t timer_id, uint32_t ticks)</code> <br/>
    449. 

  449.  <code>osStatus &#160; osTimerStart (osTimerId timer_id, uint32_t timeout)</code> <br/>
    450. 

  450.  <br/>
    451. 

  451.  Start or restart a timer. <br/>
    452. 

  452. </p>
    453. 

  453. <ul>
    454. 

  454. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    455. 

  455. <li>The first parameter type has changed to <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>.</li>
    456. 

  456. </ul>
    457. 

  457. </div><div class="mod"> </div><hr/>
    458. 

  458. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gabd7a89356da7717293eb0bc5d87b8ac9" title="Stop a timer. ">osTimerStop</a> (osTimerId_t timer_id)</code> <br/>
    459. 

  459.  <code>osStatus &#160; osTimerStop (osTimerId timer_id)</code> <br/>
    460. 

  460.  <br/>
    461. 

  461.  Stop a timer. <br/>
    462. 

  462. </p>
    463. 

  463. <ul>
    464. 

  464. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    465. 

  465. <li>The parameter type has changed to <a class="el" href="group__CMSIS__RTOS__TimerMgmt.html#gaad5409379689ee27bb0a0b56ea4a4b34">osTimerId_t</a>.</li>
    466. 

  466. </ul>
    467. 

  467. </div><div class="mod"> </div><h1><a class="anchor" id="mig_mutex"></a>
    468. 

  468. Mutexes</h1>
    469. 

  469. <p>Refer to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html">Mutex Management</a> for details.</p>
    470. 

  470. <hr/>
    471. 

  471. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924" title="Acquire a Mutex or timeout if it is locked. ">osMutexAcquire</a> (osMutexId_t mutex_id, uint32_t timeout)</code> <br/>
    472. 

  472.  <code>osStatus &#160; osMutexWait (osMutexId mutex_id, uint32_t timeout)</code> <br/>
    473. 

  473.  <br/>
    474. 

  474.  Acquire a Mutex or timeout if it is locked. <br/>
    475. 

  475. </p>
    476. 

  476. <ul>
    477. 

  477. <li>The function <b>osMutexAcquire</b> replaces the RTOS v1 function <b>osMutexWait</b>.</li>
    478. 

  478. <li>Return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>.</li>
    479. 

  479. <li>First parameter type changed to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a>.</li>
    480. 

  480. </ul>
    481. 

  481. </div><div class="mod"> </div><hr/>
    482. 

  482. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabee73ad227ba4587d3db12ef9bd582bc" title="Delete a Mutex object. ">osMutexDelete</a> (osMutexId_t mutex_id)</code> <br/>
    483. 

  483.  <code>osStatus &#160; osMutexDelete (osMutexId mutex_id)</code> <br/>
    484. 

  484.  <br/>
    485. 

  485.  Delete a Mutex object. <br/>
    486. 

  486. </p>
    487. 

  487. <ul>
    488. 

  488. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>.</li>
    489. 

  489. <li>The parameter type changed to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a>.</li>
    490. 

  490. </ul>
    491. 

  491. </div><div class="mod"> </div><hr/>
    492. 

  492. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga00b5e58cd247a412d1afd18732d8b752" title="Get name of a Mutex object. ">osMutexGetName</a> (osMutexId_t mutex_id)</code> <br/>
    493. 

  493.  <em>none</em> <br/>
    494. 

  494.  <br/>
    495. 

  495.  Get name of a Mutex object. <br/>
    496. 

  496.  New function. </div><hr/>
    497. 

  497. <div class="new"> <code>osThreadId_t <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga7f9a7666df0978738cd570cb700b83fb" title="Get Thread which owns a Mutex object. ">osMutexGetOwner</a> (osMutexId_t mutex_id)</code> <br/>
    498. 

  498.  <em>none</em> <br/>
    499. 

  499.  <br/>
    500. 

  500.  Get Thread which owns a Mutex object. <br/>
    501. 

  501.  New function. </div><hr/>
    502. 

  502. <div class="mod"> <code>osMutexId_t <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gab90920022ab944296821368ef6bb52f8" title="Create and Initialize a Mutex object. ">osMutexNew</a> (const <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#structosMutexAttr__t" title="Attributes structure for mutex. ">osMutexAttr_t</a> *attr)</code> <br/>
    503. 

  503.  <code>osMutexId &#160; osMutexCreate (const osMutexDef_t *mutex_def)</code> <br/>
    504. 

  504.  <br/>
    505. 

  505.  Create and Initialize a Mutex object. <br/>
    506. 

  506. </p>
    507. 

  507. <ul>
    508. 

  508. <li>The function <b>osMutexNew</b> replaces the RTOS v1 function <b>osMutexCreate</b>.</li>
    509. 

  509. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a>.</li>
    510. 

  510. <li>The parameter type changed to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#structosMutexAttr__t">osMutexAttr_t</a>.</li>
    511. 

  511. </ul>
    512. 

  512. </div><div class="mod"> </div><hr/>
    513. 

  513. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gaea629705703580ff58776bf73c8db915" title="Release a Mutex that was acquired by osMutexAcquire. ">osMutexRelease</a> (osMutexId_t mutex_id)</code> <br/>
    514. 

  514.  <code>osStatus &#160; osMutexRelease (osMutexId mutex_id)</code> <br/>
    515. 

  515.  <br/>
    516. 

  516.  Release a Mutex that was acquired by <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#gabc54686ea0fc281823b1763422d2a924">osMutexAcquire</a>. <br/>
    517. 

  517. </p>
    518. 

  518. <ul>
    519. 

  519. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>.</li>
    520. 

  520. <li>The parameter type changed to <a class="el" href="group__CMSIS__RTOS__MutexMgmt.html#ga313801836c62deb23055efb55a420e42">osMutexId_t</a>.</li>
    521. 

  521. </ul>
    522. 

  522. </div><div class="mod"> </div><h1><a class="anchor" id="mig_sem"></a>
    523. 

  523. Semaphores</h1>
    524. 

  524. <p>Refer to <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html">Semaphores</a> for details.</p>
    525. 

  525. <hr/>
    526. 

  526. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b" title="Acquire a Semaphore token or timeout if no tokens are available. ">osSemaphoreAcquire</a> (osSemaphoreId_t semaphore_id, uint32_t timeout)</code> <br/>
    527. 

  527.  <em>none</em> <br/>
    528. 

  528.  <br/>
    529. 

  529.  Acquire a Semaphore token or timeout if no tokens are available. <br/>
    530. 

  530.  New function. Replaces <code>osSemaphoreWait</code>. </div><hr/>
    531. 

  531. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga81258ce9c67fa89f07cc49d2e136cd88" title="Delete a Semaphore object. ">osSemaphoreDelete</a> (osSemaphoreId_t semaphore_id)</code> <br/>
    532. 

  532.  <code>osStatus &#160; osSemaphoreDelete (osSemaphoreId semaphore_id)</code> <br/>
    533. 

  533.  <br/>
    534. 

  534.  Delete a Semaphore object. <br/>
    535. 

  535. </p>
    536. 

  536. <ul>
    537. 

  537. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    538. 

  538. <li>The parameter type has changed to <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a>.</li>
    539. 

  539. </ul>
    540. 

  540. </div><div class="mod"> </div><hr/>
    541. 

  541. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7559d4dff3cda9992fc5ab5de3e74c70" title="Get current Semaphore token count. ">osSemaphoreGetCount</a> (osSemaphoreId_t semaphore_id)</code> <br/>
    542. 

  542.  <em>none</em> <br/>
    543. 

  543.  <br/>
    544. 

  544.  Get current Semaphore token count. <br/>
    545. 

  545.  New function. </div><hr/>
    546. 

  546. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga9586952051f00285f1482dbe6695bbc4" title="Get name of a Semaphore object. ">osSemaphoreGetName</a> (osSemaphoreId_t semaphore_id)</code> <br/>
    547. 

  547.  <em>none</em> <br/>
    548. 

  548.  <br/>
    549. 

  549.  Get name of a Semaphore object. <br/>
    550. 

  550.  New function. </div><hr/>
    551. 

  551. <div class="mod"> <code>osSemaphoreId_t <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga2a39806ace781a0008a4374ca701b14a" title="Create and Initialize a Semaphore object. ">osSemaphoreNew</a> (uint32_t max_count, uint32_t initial_count, const <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#structosSemaphoreAttr__t" title="Attributes structure for semaphore. ">osSemaphoreAttr_t</a> *attr)</code> <br/>
    552. 

  552.  <code>osSemaphoreId &#160; osSemaphoreCreate (const osSemaphoreDef_t *semaphore_def, int32_t count)</code> <br/>
    553. 

  553.  <br/>
    554. 

  554.  Create and Initialize a Semaphore object. <br/>
    555. 

  555. </p>
    556. 

  556. <ul>
    557. 

  557. <li>The function <b>osSemaphoreNew</b> replaces the RTOS v1 function <b>osSemaphoreCreate</b>.</li>
    558. 

  558. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a>.</li>
    559. 

  559. <li>The parameter list and types have changed.</li>
    560. 

  560. </ul>
    561. 

  561. </div><div class="mod"> </div><hr/>
    562. 

  562. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga0abcee1b5449d7a6928fb9248c690bb6" title="Release a Semaphore token up to the initial maximum count. ">osSemaphoreRelease</a> (osSemaphoreId_t semaphore_id)</code> <br/>
    563. 

  563.  <code>osStatus &#160; osSemaphoreRelease (osSemaphoreId semaphore_id)</code> <br/>
    564. 

  564.  <br/>
    565. 

  565.  Release a Semaphore token up to the initial maximum count. <br/>
    566. 

  566. </p>
    567. 

  567. <ul>
    568. 

  568. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    569. 

  569. <li>The parameter type has changed to <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga6e1c1c4b04175bb92b013c8f37249f40">osSemaphoreId_t</a>.</li>
    570. 

  570. </ul>
    571. 

  571. </div><div class="mod"> </div><hr/>
    572. 

  572. <div class="del"> <em>none</em> <br/>
    573. 

  573.  <code>int32_t osSemaphoreWait (osSemaphoreId semaphore_id, uint32_t timeout)</code> <br/>
    574. 

  574.  <br/>
    575. 

  575. Deprecated. Replaced by <a class="el" href="group__CMSIS__RTOS__SemaphoreMgmt.html#ga7e94c8b242a0c81f2cc79ec22895c87b" title="Acquire a Semaphore token or timeout if no tokens are available. ">osSemaphoreAcquire</a>. </div><h1><a class="anchor" id="mig_memPool"></a>
    576. 

  576. Memory Pool</h1>
    577. 

  577. <hr/>
    578. 

  578. <div class="mod"> <code>void * <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe" title="Allocate a memory block from a Memory Pool. ">osMemoryPoolAlloc</a> (osMemoryPoolId_t mp_id, uint32_t timeout)</code> <br/>
    579. 

  579.  <code>void * osPoolAlloc &#160;(osPoolId pool_id)</code> <br/>
    580. 

  580.  <br/>
    581. 

  581.  Allocate a memory block from a Memory Pool. <br/>
    582. 

  582. </p>
    583. 

  583. <ul>
    584. 

  584. <li>The function <b>osMemoryPoolAlloc</b> replaces both RTOS v1 functions <b>osPoolAlloc</b>.</li>
    585. 

  585. <li>The parameter list and types changed.</li>
    586. 

  586. </ul>
    587. 

  587. </div><div class="mod"> </div><hr/>
    588. 

  588. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8c39e7e5cd2b9eda907466808e59d62e" title="Delete a Memory Pool object. ">osMemoryPoolDelete</a> (osMemoryPoolId_t mp_id)</code> <br/>
    589. 

  589.  <em>none</em> <br/>
    590. 

  590.  <br/>
    591. 

  591.  Delete a Memory Pool object. <br/>
    592. 

  592.  New function. </div><hr/>
    593. 

  593. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16" title="Return an allocated memory block back to a Memory Pool. ">osMemoryPoolFree</a> (osMemoryPoolId_t mp_id, void * block)</code> <br/>
    594. 

  594.  <code>osStatus &#160; osPoolFree (osPoolId pool_id, void * block)</code> <br/>
    595. 

  595.  <br/>
    596. 

  596.  Return an allocated memory block back to a Memory Pool. <br/>
    597. 

  597. </p>
    598. 

  598. <ul>
    599. 

  599. <li>The function <b>osMemoryPoolFree</b> replaces the RTOS v1 function <b>osPoolFree</b>.</li>
    600. 

  600. <li>The first parameter type <b>osMemoryPoolId_t</b> replaces the ROTS v1 type <b>osPoolId</b>.</li>
    601. 

  601. </ul>
    602. 

  602. </div><div class="mod"> </div><hr/>
    603. 

  603. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab2bf059b7fa7679c3cccdaeec60b6c0e" title="Get memory block size in a Memory Pool. ">osMemoryPoolGetBlockSize</a> (osMemoryPoolId_t mp_id)</code> <br/>
    604. 

  604.  <em>none</em> <br/>
    605. 

  605.  <br/>
    606. 

  606.  Get memory block size in a Memory Pool. <br/>
    607. 

  607.  New function. </div><hr/>
    608. 

  608. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gad696e94bfbe28f0b6613f9303fdf6a37" title="Get maximum number of memory blocks in a Memory Pool. ">osMemoryPoolGetCapacity</a> (osMemoryPoolId_t mp_id)</code> <br/>
    609. 

  609.  <em>none</em> <br/>
    610. 

  610.  <br/>
    611. 

  611.  Get maximum number of memory blocks in a Memory Pool. <br/>
    612. 

  612.  New function. </div><hr/>
    613. 

  613. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga958a9449bff8c95ce213de98eef5739d" title="Get number of memory blocks used in a Memory Pool. ">osMemoryPoolGetCount</a> (osMemoryPoolId_t mp_id)</code> <br/>
    614. 

  614.  <em>none</em> <br/>
    615. 

  615.  <br/>
    616. 

  616.  Get number of memory blocks used in a Memory Pool. <br/>
    617. 

  617.  New function. </div><hr/>
    618. 

  618. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab414a1e138205a55820acfa277c8f386" title="Get name of a Memory Pool object. ">osMemoryPoolGetName</a> (osMemoryPoolId_t mp_id)</code> <br/>
    619. 

  619.  <em>none</em> <br/>
    620. 

  620.  <br/>
    621. 

  621.  Get name of a Memory Pool object. <br/>
    622. 

  622.  New function. </div><hr/>
    623. 

  623. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga0394cffa9479a7994e3b03c79c1cb909" title="Get number of memory blocks available in a Memory Pool. ">osMemoryPoolGetSpace</a> (osMemoryPoolId_t mp_id)</code> <br/>
    624. 

  624.  <em>none</em> <br/>
    625. 

  625.  <br/>
    626. 

  626.  Get number of memory blocks available in a Memory Pool. <br/>
    627. 

  627.  New function. </div><hr/>
    628. 

  628. <div class="mod"> <code>osMemoryPoolId_t <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc" title="Create and Initialize a Memory Pool object. ">osMemoryPoolNew</a> (uint32_t block_count, uint32_t block_size, const <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t" title="Attributes structure for memory pool. ">osMemoryPoolAttr_t</a> *attr)</code> <br/>
    629. 

  629.  <code>osPoolId &#160; &#160; &#160; &#160; osPoolCreate (const osPoolDef_t * pool_def)</code> <br/>
    630. 

  630.  <br/>
    631. 

  631.  Get number of memory blocks available in a Memory Pool. <br/>
    632. 

  632. </p>
    633. 

  633. <ul>
    634. 

  634. <li>The function <b>osMemoryPoolNew</b> replaces the RTOS v1 function <b>osPoolCreate</b>.</li>
    635. 

  635. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a>.</li>
    636. 

  636. <li>Parameter list and parameter types have changed.</li>
    637. 

  637. </ul>
    638. 

  638. </div><div class="mod"> </div><h1><a class="anchor" id="mig_msgQueue"></a>
    639. 

  639. Message Queue</h1>
    640. 

  640. <p>In general, messages are now using fixed size memory instead of being 32-bit values. Refer to <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> for details.</p>
    641. 

  641. <hr/>
    642. 

  642. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe" title="Delete a Message Queue object. ">osMessageQueueDelete</a> (osMessageQueueId_t mq_id)</code> <br/>
    643. 

  643.  <em>none</em> <br/>
    644. 

  644.  <br/>
    645. 

  645.  Delete a Message Queue object. <br/>
    646. 

  646.  New function. </div><hr/>
    647. 

  647. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e" title="Get a Message from a Queue or timeout if Queue is empty. ">osMessageQueueGet</a> (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout)</code> <br/>
    648. 

  648.  <code>osEvent &#160;&#160; osMessageGet (osMessageQId queue_id, uint32_t timeout)</code> <br/>
    649. 

  649.  <br/>
    650. 

  650.  Get a Message from a Queue or timeout if Queue is empty. <br/>
    651. 

  651. </p>
    652. 

  652. <ul>
    653. 

  653. <li>The function <b>osMessageQueueGet</b> replaces the RTOS v1 function <b>osMessageGet</b>.</li>
    654. 

  654. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    655. 

  655. <li>The parameter list and parameter types have changed.</li>
    656. 

  656. </ul>
    657. 

  657. </div><div class="mod"> </div><hr/>
    658. 

  658. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__Message.html#gac24f87d4f395e9e9c900c320e45ade8a" title="Get maximum number of messages in a Message Queue. ">osMessageQueueGetCapacity</a> (osMessageQueueId_t mq_id)</code> <br/>
    659. 

  659.  <em>none</em> <br/>
    660. 

  660.  <br/>
    661. 

  661.  Get maximum number of messages in a Message Queue. <br/>
    662. 

  662.  New function. </div><hr/>
    663. 

  663. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__Message.html#ga6a32ac394fcff568b251c160cc3014b2" title="Get number of queued messages in a Message Queue. ">osMessageQueueGetCount</a> (osMessageQueueId_t mq_id)</code> <br/>
    664. 

  664.  <em>none</em> <br/>
    665. 

  665.  <br/>
    666. 

  666.  Get number of queued messages in a Message Queue. <br/>
    667. 

  667.  New function. </div><hr/>
    668. 

  668. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__Message.html#ga96d3d84069b20359de48109e28a1a89e" title="Get maximum message size in a Memory Pool. ">osMessageQueueGetMsgSize</a> (osMessageQueueId_t mq_id)</code> <br/>
    669. 

  669.  <em>none</em> <br/>
    670. 

  670.  <br/>
    671. 

  671.  Get maximum message size in a Memory Pool. <br/>
    672. 

  672.  New function. </div><hr/>
    673. 

  673. <div class="new"> <code>const char *<a class="el" href="group__CMSIS__RTOS__Message.html#gae7cf7bf2b97a5ae481fb60fcce99247a" title="Get name of a Message Queue object. ">osMessageQueueGetName</a> (osMessageQueueId_t mq_id)</code> <br/>
    674. 

  674.  <em>none</em> <br/>
    675. 

  675.  <br/>
    676. 

  676.  Get name of a Message Queue object. <br/>
    677. 

  677.  New function. </div><hr/>
    678. 

  678. <div class="new"> <code>uint32_t <a class="el" href="group__CMSIS__RTOS__Message.html#gaddf0904427436dd3880d46263c2dc9fa" title="Get number of available slots for messages in a Message Queue. ">osMessageQueueGetSpace</a> (osMessageQueueId_t mq_id)</code> <br/>
    679. 

  679.  <em>none</em> <br/>
    680. 

  680.  <br/>
    681. 

  681.  Get number of available slots for messages in a Message Queue. <br/>
    682. 

  682.  New function. </div><hr/>
    683. 

  683. <div class="mod"> <code>osMessageQueueId_t <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed" title="Create and Initialize a Message Queue object. ">osMessageQueueNew</a> (uint32_t msg_count, uint32_t msg_size, const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t" title="Attributes structure for message queue. ">osMessageQueueAttr_t</a> *attr)</code> <br/>
    684. 

  684.  <code>osMessageQId &#160; &#160; &#160; osMessageCreate (const osMessageQDef_t *queue_def, osThreadId thread_id)</code> <br/>
    685. 

  685.  <br/>
    686. 

  686.  Create and Initialize a Message Queue object. <br/>
    687. 

  687. </p>
    688. 

  688. <ul>
    689. 

  689. <li>The function <b>osMessageQueueNew</b> replaces the RTOS v1 function <b>osMessageCreate</b>.</li>
    690. 

  690. <li>The return type changed to <a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>.</li>
    691. 

  691. <li>The parameter list and parameter types have changed.</li>
    692. 

  692. </ul>
    693. 

  693. </div><div class="mod"> </div><hr/>
    694. 

  694. <div class="mod"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc" title="Put a Message into a Queue or timeout if Queue is full. ">osMessageQueuePut</a> (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)</code> <br/>
    695. 

  695.  <code>osStatus &#160; osMessagePut (osMessageQId queue_id, uint32_t info, uint32_t timeout)</code> <br/>
    696. 

  696.  <br/>
    697. 

  697.  Put a Message into a Queue or timeout if Queue is full. <br/>
    698. 

  698. </p>
    699. 

  699. <ul>
    700. 

  700. <li>The function <b>osMessageQueuePut</b> replaces the RTOS v1 function <b>osMessagePut</b>.</li>
    701. 

  701. <li>The return type changed to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions. ">osStatus_t</a>.</li>
    702. 

  702. <li>The parameter list and parameter types have changed.</li>
    703. 

  703. </ul>
    704. 

  704. </div><div class="mod"> </div><hr/>
    705. 

  705. <div class="new"> <code>osStatus_t <a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4" title="Reset a Message Queue to initial empty state. ">osMessageQueueReset</a> (osMessageQueueId_t mq_id)</code> <br/>
    706. 

  706.  <em>none</em> <br/>
    707. 

  707.  <br/>
    708. 

  708.  Reset a Message Queue to initial empty state. <br/>
    709. 

  709.  New function. </div><h1><a class="anchor" id="mig_mailQueue"></a>
    710. 

  710. Mail Queue</h1>
    711. 

  711. <p>The <b>Mail Queue</b> RTOS v1 functions have been deprecated. Use the functionality of the <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> instead. Differences are listed under <a class="el" href="os2MigrationFunctions.html#mig_msgQueue">Message Queue</a>.</p>
    712. 

  712. <hr/>
    713. 

  713. <div class="del"> <em>none</em> <br/>
    714. 

  714.  <code>void * osMailAlloc (osMailQId queue_id, uint32_t timeout)</code> <br/>
    715. 

  715.  <br/>
    716. 

  716. Deprecated. </div><hr/>
    717. 

  717. <div class="del"> <em>none</em> <br/>
    718. 

  718.  <code>void * osMailCAlloc (osMailQId queue_id, uint32_t timeout)</code> <br/>
    719. 

  719.  <br/>
    720. 

  720. Deprecated. </div><hr/>
    721. 

  721. <div class="del"> <em>none</em> <br/>
    722. 

  722.  <code>osMailQId osMailCreate (const osMailQDef_t *queue_def, osThreadId thread_id)</code> <br/>
    723. 

  723.  <br/>
    724. 

  724. Deprecated. </div><hr/>
    725. 

  725. <div class="del"> <em>none</em> <br/>
    726. 

  726.  <code>osStatus osMailFree (osMailQId queue_id, void *mail)</code> <br/>
    727. 

  727.  <br/>
    728. 

  728. Deprecated. </div><hr/>
    729. 

  729. <div class="del"> <em>none</em> <br/>
    730. 

  730.  <code>osEvent osMailGet (osMailQId queue_id, uint32_t timeout)</code> <br/>
    731. 

  731.  <br/>
    732. 

  732. Deprecated. </div><hr/>
    733. 

  733. <div class="del"> <em>none</em> <br/>
    734. 

  734.  <code>osStatus osMailPut (osMailQId queue_id, void *mail)</code> <br/>
    735. 

  735.  <br/>
    736. 

  736. Deprecated. </div><h1><a class="anchor" id="mig_signalEvents"></a>
    737. 

  737. Signal Events</h1>
    738. 

  738. <p>The section RTOS v1 <b>Signal Events</b> has been deprecated. Use the functions listed under <a class="el" href="os2MigrationFunctions.html#mig_threadFlags">Thread Flags</a> instead.</p>
    739. 

  739. <hr/>
    740. 

  740. <div class="del"> <em>none</em> <br/>
    741. 

  741.  <code>int32_t osSignalClear (osThreadId thread_id, int32_t signals)</code> <br/>
    742. 

  742.  <br/>
    743. 

  743. Deprecated. </div><hr/>
    744. 

  744. <div class="del"> <em>none</em> <br/>
    745. 

  745.  <code>int32_t osSignalSet (osThreadId thread_id, int32_t signals)</code> <br/>
    746. 

  746.  <br/>
    747. 

  747. Deprecated. </div><hr/>
    748. 

  748. <div class="del"> <em>none</em> <br/>
    749. 

  749.  <code>osEvent osSignalWait (int32_t signals, uint32_t timeout)</code> <br/>
    750. 

  750.  <br/>
    751. 

  751. Deprecated. </div> </div></div><!-- contents -->
    752. 

  752. </div><!-- doc-content -->
    753. 

  753. <!-- start footer part -->
    754. 

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

  755.   <ul>
    756. 

  756.     <li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="os2Migration.html">Migration from API v1 to API v2</a></li>
    757. 

  757.     <li class="footer">Generated on Thu Apr 9 2020 15:49:59 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved.
    758. 

  758. 	<!--
    759. 

  759.     <a href="http://www.doxygen.org/index.html">
    760. 

  760.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    761. 

  761. 	-->
    762. 

  762. 	</li>
    763. 

  763.   </ul>
    764. 

  764. </div>
    765. 

  765. </body>
    766. 

  766. </html>
    767.