group__rtx__evr__thread__flags.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Thread Flags Functions</title>
  7. <title>CMSIS-RTOS2: Thread Flags Functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__rtx__evr__thread__flags.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Thread Flags Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Events generated by thread flags functions.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  118. Functions</h2></td></tr>
  119. <tr class="memitem:gad3609bfc41e1bee23b41973281096ed6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gad3609bfc41e1bee23b41973281096ed6">EvrRtxThreadFlagsError</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, int32_t status)</td></tr>
  120. <tr class="memdesc:gad3609bfc41e1bee23b41973281096ed6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on thread flags error (Error) <a href="#gad3609bfc41e1bee23b41973281096ed6">More...</a><br/></td></tr>
  121. <tr class="separator:gad3609bfc41e1bee23b41973281096ed6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gac356c777af86c2d8d9250cbffc516e1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gac356c777af86c2d8d9250cbffc516e1d">EvrRtxThreadFlagsSet</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t flags)</td></tr>
  123. <tr class="memdesc:gac356c777af86c2d8d9250cbffc516e1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on thread flags set (API) <a href="#gac356c777af86c2d8d9250cbffc516e1d">More...</a><br/></td></tr>
  124. <tr class="separator:gac356c777af86c2d8d9250cbffc516e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gabd447773c02e235a8d0bb96dd9bb1c4f">EvrRtxThreadFlagsSetDone</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t thread_flags)</td></tr>
  126. <tr class="memdesc:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful thread flags set (Op) <a href="#gabd447773c02e235a8d0bb96dd9bb1c4f">More...</a><br/></td></tr>
  127. <tr class="separator:gabd447773c02e235a8d0bb96dd9bb1c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gac8ddc747c72f7fc5cfa58edcee56b82d">EvrRtxThreadFlagsClear</a> (uint32_t flags)</td></tr>
  129. <tr class="memdesc:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on thread flags clear (API) <a href="#gac8ddc747c72f7fc5cfa58edcee56b82d">More...</a><br/></td></tr>
  130. <tr class="separator:gac8ddc747c72f7fc5cfa58edcee56b82d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:gaad13b17507cc07a4a1e37a5653489943"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaad13b17507cc07a4a1e37a5653489943">EvrRtxThreadFlagsClearDone</a> (uint32_t thread_flags)</td></tr>
  132. <tr class="memdesc:gaad13b17507cc07a4a1e37a5653489943"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful thread flags clear (Op) <a href="#gaad13b17507cc07a4a1e37a5653489943">More...</a><br/></td></tr>
  133. <tr class="separator:gaad13b17507cc07a4a1e37a5653489943"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaab1a30a0ac3dfa588ededbfad52bae30">EvrRtxThreadFlagsGet</a> (uint32_t thread_flags)</td></tr>
  135. <tr class="memdesc:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on thread flags retrieve (API) <a href="#gaab1a30a0ac3dfa588ededbfad52bae30">More...</a><br/></td></tr>
  136. <tr class="separator:gaab1a30a0ac3dfa588ededbfad52bae30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:gaad860c571b9b083ff2889fb76fb619f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gaad860c571b9b083ff2889fb76fb619f1">EvrRtxThreadFlagsWait</a> (uint32_t flags, uint32_t options, uint32_t timeout)</td></tr>
  138. <tr class="memdesc:gaad860c571b9b083ff2889fb76fb619f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on wait for thread flags (API) <a href="#gaad860c571b9b083ff2889fb76fb619f1">More...</a><br/></td></tr>
  139. <tr class="separator:gaad860c571b9b083ff2889fb76fb619f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:gad09ec9317a4440e5228870b750e9860e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gad09ec9317a4440e5228870b750e9860e">EvrRtxThreadFlagsWaitPending</a> (uint32_t flags, uint32_t options, uint32_t timeout)</td></tr>
  141. <tr class="memdesc:gad09ec9317a4440e5228870b750e9860e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending wait for thread flags (Op) <a href="#gad09ec9317a4440e5228870b750e9860e">More...</a><br/></td></tr>
  142. <tr class="separator:gad09ec9317a4440e5228870b750e9860e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gae45ec48e082608d2ba72ce7c695899c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gae45ec48e082608d2ba72ce7c695899c6">EvrRtxThreadFlagsWaitTimeout</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr>
  144. <tr class="memdesc:gae45ec48e082608d2ba72ce7c695899c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on wait timeout for thread flags (Op) <a href="#gae45ec48e082608d2ba72ce7c695899c6">More...</a><br/></td></tr>
  145. <tr class="separator:gae45ec48e082608d2ba72ce7c695899c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#ga5e00be70234d0ca3b0d4d99fb58295bc">EvrRtxThreadFlagsWaitCompleted</a> (uint32_t flags, uint32_t options, uint32_t thread_flags, <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id)</td></tr>
  147. <tr class="memdesc:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful wait for thread flags (Op) <a href="#ga5e00be70234d0ca3b0d4d99fb58295bc">More...</a><br/></td></tr>
  148. <tr class="separator:ga5e00be70234d0ca3b0d4d99fb58295bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__thread__flags.html#gadf6b9f4882f62a65b4e06e1b3e5c9c5b">EvrRtxThreadFlagsWaitNotCompleted</a> (uint32_t flags, uint32_t options)</td></tr>
  150. <tr class="memdesc:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful wait for thread flags (Op) <a href="#gadf6b9f4882f62a65b4e06e1b3e5c9c5b">More...</a><br/></td></tr>
  151. <tr class="separator:gadf6b9f4882f62a65b4e06e1b3e5c9c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  154. <h2 class="groupheader">Function Documentation</h2>
  155. <a class="anchor" id="gad3609bfc41e1bee23b41973281096ed6"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">void EvrRtxThreadFlagsError </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
  163. <td class="paramname"><em>thread_id</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">int32_t&#160;</td>
  169. <td class="paramname"><em>status</em>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <dl class="params"><dt>Parameters</dt><dd>
  179. <table class="params">
  180. <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a> or NULL when ID is unknown. </td></tr>
  181. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  182. </table>
  183. </dd>
  184. </dl>
  185. <p>The event <b>ThreadFlagsError</b> is generated when <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> routines complete their execution due to an error.</p>
  186. <p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p>
  187. <table class="doxtable">
  188. <tr>
  189. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  190. <tr>
  191. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  192. <tr>
  193. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  194. <tr>
  195. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  196. <tr>
  197. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  198. <tr>
  199. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  200. <tr>
  201. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  202. <tr>
  203. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  204. <tr>
  205. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  206. <tr>
  207. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  208. <tr>
  209. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  210. <tr>
  211. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  212. <tr>
  213. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  214. <tr>
  215. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  216. <tr>
  217. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  218. <tr>
  219. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  220. <tr>
  221. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  222. </table>
  223. <p><b>Value</b> in the Event Recorder shows:</p>
  224. <ul>
  225. <li><b>thread_id</b> : thread ID.</li>
  226. <li><b>status</b> : execution status code. </li>
  227. </ul>
  228. </div>
  229. </div>
  230. <a class="anchor" id="gac356c777af86c2d8d9250cbffc516e1d"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">void EvrRtxThreadFlagsSet </td>
  236. <td>(</td>
  237. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
  238. <td class="paramname"><em>thread_id</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype">uint32_t&#160;</td>
  244. <td class="paramname"><em>flags</em>&#160;</td>
  245. </tr>
  246. <tr>
  247. <td></td>
  248. <td>)</td>
  249. <td></td><td></td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <dl class="params"><dt>Parameters</dt><dd>
  254. <table class="params">
  255. <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>. </td></tr>
  256. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags of the thread that shall be set.</td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <p>The event <b>ThreadFlagsSet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a> is called.</p>
  261. <p><b>Value</b> in the Event Recorder shows:</p>
  262. <ul>
  263. <li><b>thread_id</b> : thread ID.</li>
  264. <li><b>flags</b> : flags that shall be set. </li>
  265. </ul>
  266. </div>
  267. </div>
  268. <a class="anchor" id="gabd447773c02e235a8d0bb96dd9bb1c4f"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">void EvrRtxThreadFlagsSetDone </td>
  274. <td>(</td>
  275. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
  276. <td class="paramname"><em>thread_id</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">uint32_t&#160;</td>
  282. <td class="paramname"><em>thread_flags</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <dl class="params"><dt>Parameters</dt><dd>
  292. <table class="params">
  293. <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>. </td></tr>
  294. <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>thread flags after setting.</td></tr>
  295. </table>
  296. </dd>
  297. </dl>
  298. <p>The event <b>ThreadFlagsSetDone</b> is generated when thread flags are successfully set.</p>
  299. <p><b>Value</b> in the Event Recorder shows:</p>
  300. <ul>
  301. <li><b>thread_id</b> : thread ID.</li>
  302. <li><b>thread_flags</b> : thread flags after setting. </li>
  303. </ul>
  304. </div>
  305. </div>
  306. <a class="anchor" id="gac8ddc747c72f7fc5cfa58edcee56b82d"></a>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">void EvrRtxThreadFlagsClear </td>
  312. <td>(</td>
  313. <td class="paramtype">uint32_t&#160;</td>
  314. <td class="paramname"><em>flags</em></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <dl class="params"><dt>Parameters</dt><dd>
  320. <table class="params">
  321. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags of the thread that shall be cleared.</td></tr>
  322. </table>
  323. </dd>
  324. </dl>
  325. <p>The event <b>ThreadFlagsClear</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> is called.</p>
  326. <p><b>Value</b> in the Event Recorder shows:</p>
  327. <ul>
  328. <li><b>flags</b> : flags that shall be cleared. </li>
  329. </ul>
  330. </div>
  331. </div>
  332. <a class="anchor" id="gaad13b17507cc07a4a1e37a5653489943"></a>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">void EvrRtxThreadFlagsClearDone </td>
  338. <td>(</td>
  339. <td class="paramtype">uint32_t&#160;</td>
  340. <td class="paramname"><em>thread_flags</em></td><td>)</td>
  341. <td></td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <dl class="params"><dt>Parameters</dt><dd>
  346. <table class="params">
  347. <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>thread flags before clearing.</td></tr>
  348. </table>
  349. </dd>
  350. </dl>
  351. <p>The event <b>ThreadFlagsClearDone</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> successfully clears thread flags.</p>
  352. <p><b>Value</b> in the Event Recorder shows:</p>
  353. <ul>
  354. <li><b>thread_flags</b> : thread flags before clearing. </li>
  355. </ul>
  356. </div>
  357. </div>
  358. <a class="anchor" id="gaab1a30a0ac3dfa588ededbfad52bae30"></a>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">void EvrRtxThreadFlagsGet </td>
  364. <td>(</td>
  365. <td class="paramtype">uint32_t&#160;</td>
  366. <td class="paramname"><em>thread_flags</em></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <dl class="params"><dt>Parameters</dt><dd>
  372. <table class="params">
  373. <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>current thread flags.</td></tr>
  374. </table>
  375. </dd>
  376. </dl>
  377. <p>The event <b>ThreadFlagsGet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga85c8d2c89466e25abbcb545d9ddd71ba">osThreadFlagsGet</a> is called and its execution result is known.</p>
  378. <p><b>Value</b> in the Event Recorder shows:</p>
  379. <ul>
  380. <li><b>thread_flags</b> : current thread flags. </li>
  381. </ul>
  382. </div>
  383. </div>
  384. <a class="anchor" id="gaad860c571b9b083ff2889fb76fb619f1"></a>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">void EvrRtxThreadFlagsWait </td>
  390. <td>(</td>
  391. <td class="paramtype">uint32_t&#160;</td>
  392. <td class="paramname"><em>flags</em>, </td>
  393. </tr>
  394. <tr>
  395. <td class="paramkey"></td>
  396. <td></td>
  397. <td class="paramtype">uint32_t&#160;</td>
  398. <td class="paramname"><em>options</em>, </td>
  399. </tr>
  400. <tr>
  401. <td class="paramkey"></td>
  402. <td></td>
  403. <td class="paramtype">uint32_t&#160;</td>
  404. <td class="paramname"><em>timeout</em>&#160;</td>
  405. </tr>
  406. <tr>
  407. <td></td>
  408. <td>)</td>
  409. <td></td><td></td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <dl class="params"><dt>Parameters</dt><dd>
  414. <table class="params">
  415. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  416. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  417. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  418. </table>
  419. </dd>
  420. </dl>
  421. <p>The event <b>ThreadFlagsWait</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> is called.</p>
  422. <p><b>Value</b> in the Event Recorder shows:</p>
  423. <ul>
  424. <li><b>flags</b> : flags to wait for.</li>
  425. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li>
  426. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  427. </ul>
  428. </div>
  429. </div>
  430. <a class="anchor" id="gad09ec9317a4440e5228870b750e9860e"></a>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">void EvrRtxThreadFlagsWaitPending </td>
  436. <td>(</td>
  437. <td class="paramtype">uint32_t&#160;</td>
  438. <td class="paramname"><em>flags</em>, </td>
  439. </tr>
  440. <tr>
  441. <td class="paramkey"></td>
  442. <td></td>
  443. <td class="paramtype">uint32_t&#160;</td>
  444. <td class="paramname"><em>options</em>, </td>
  445. </tr>
  446. <tr>
  447. <td class="paramkey"></td>
  448. <td></td>
  449. <td class="paramtype">uint32_t&#160;</td>
  450. <td class="paramname"><em>timeout</em>&#160;</td>
  451. </tr>
  452. <tr>
  453. <td></td>
  454. <td>)</td>
  455. <td></td><td></td>
  456. </tr>
  457. </table>
  458. </div><div class="memdoc">
  459. <dl class="params"><dt>Parameters</dt><dd>
  460. <table class="params">
  461. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  462. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  463. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  464. </table>
  465. </dd>
  466. </dl>
  467. <p>The event <b>ThreadFlagsWaitPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> starts waiting for thread flags to become signaled.</p>
  468. <p><b>Value</b> in the Event Recorder shows:</p>
  469. <ul>
  470. <li><b>flags</b> : flags to wait for.</li>
  471. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li>
  472. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  473. </ul>
  474. </div>
  475. </div>
  476. <a class="anchor" id="gae45ec48e082608d2ba72ce7c695899c6"></a>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname">void EvrRtxThreadFlagsWaitTimeout </td>
  482. <td>(</td>
  483. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
  484. <td class="paramname"><em>thread_id</em></td><td>)</td>
  485. <td></td>
  486. </tr>
  487. </table>
  488. </div><div class="memdoc">
  489. <dl class="params"><dt>Parameters</dt><dd>
  490. <table class="params">
  491. <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>.</td></tr>
  492. </table>
  493. </dd>
  494. </dl>
  495. <p>The event <b>ThreadFlagsWaitTimeout</b> is generated when wait for thread flags to become signaled is aborted due to expired wait timeout.</p>
  496. <p><b>Value</b> in the Event Recorder shows:</p>
  497. <ul>
  498. <li><b>thread_id</b> : thread ID. </li>
  499. </ul>
  500. </div>
  501. </div>
  502. <a class="anchor" id="ga5e00be70234d0ca3b0d4d99fb58295bc"></a>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname">void EvrRtxThreadFlagsWaitCompleted </td>
  508. <td>(</td>
  509. <td class="paramtype">uint32_t&#160;</td>
  510. <td class="paramname"><em>flags</em>, </td>
  511. </tr>
  512. <tr>
  513. <td class="paramkey"></td>
  514. <td></td>
  515. <td class="paramtype">uint32_t&#160;</td>
  516. <td class="paramname"><em>options</em>, </td>
  517. </tr>
  518. <tr>
  519. <td class="paramkey"></td>
  520. <td></td>
  521. <td class="paramtype">uint32_t&#160;</td>
  522. <td class="paramname"><em>thread_flags</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
  528. <td class="paramname"><em>thread_id</em>&#160;</td>
  529. </tr>
  530. <tr>
  531. <td></td>
  532. <td>)</td>
  533. <td></td><td></td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  540. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  541. <tr><td class="paramdir">[in]</td><td class="paramname">thread_flags</td><td>thread flags before clearing. </td></tr>
  542. <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>.</td></tr>
  543. </table>
  544. </dd>
  545. </dl>
  546. <p>The event <b>ThreadFlagsWaitCompleted</b> is generated when waiting for thread flags ends because requested flags were signaled.</p>
  547. <p><b>Value</b> in the Event Recorder shows:</p>
  548. <ul>
  549. <li><b>flags</b> : flags thread was waiting for.</li>
  550. <li><b>option</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>).</li>
  551. <li><b>thread_flags</b> : thread flags before clearing.</li>
  552. <li><b>thread_id</b> : thread ID. </li>
  553. </ul>
  554. </div>
  555. </div>
  556. <a class="anchor" id="gadf6b9f4882f62a65b4e06e1b3e5c9c5b"></a>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname">void EvrRtxThreadFlagsWaitNotCompleted </td>
  562. <td>(</td>
  563. <td class="paramtype">uint32_t&#160;</td>
  564. <td class="paramname"><em>flags</em>, </td>
  565. </tr>
  566. <tr>
  567. <td class="paramkey"></td>
  568. <td></td>
  569. <td class="paramtype">uint32_t&#160;</td>
  570. <td class="paramname"><em>options</em>&#160;</td>
  571. </tr>
  572. <tr>
  573. <td></td>
  574. <td>)</td>
  575. <td></td><td></td>
  576. </tr>
  577. </table>
  578. </div><div class="memdoc">
  579. <dl class="params"><dt>Parameters</dt><dd>
  580. <table class="params">
  581. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  582. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx).</td></tr>
  583. </table>
  584. </dd>
  585. </dl>
  586. <p>The event <b>ThreadFlagsWaitNotCompleted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> returns without timeout and specified thread flags were not signaled.</p>
  587. <p><b>Value</b> in the Event Recorder shows:</p>
  588. <ul>
  589. <li><b>flags</b> : flags thread was waiting for.</li>
  590. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">thread flags options</a>). </li>
  591. </ul>
  592. </div>
  593. </div>
  594. </div><!-- contents -->
  595. </div><!-- doc-content -->
  596. <!-- start footer part -->
  597. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  598. <ul>
  599. <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  600. <!--
  601. <a href="http://www.doxygen.org/index.html">
  602. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  603. -->
  604. </li>
  605. </ul>
  606. </div>
  607. </body>
  608. </html>