group__rtx__evr__event__flags.html 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  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>Event Flags Functions</title>
  7. <title>CMSIS-RTOS2: Event 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__event__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">Event 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 event flag 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:gaa281b7380c0fa725faa722badbeb2e5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gaa281b7380c0fa725faa722badbeb2e5f">EvrRtxEventFlagsError</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, int32_t status)</td></tr>
  120. <tr class="memdesc:gaa281b7380c0fa725faa722badbeb2e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags error (Error) <a href="#gaa281b7380c0fa725faa722badbeb2e5f">More...</a><br/></td></tr>
  121. <tr class="separator:gaa281b7380c0fa725faa722badbeb2e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gae798cdc4cb10ada732e592318037cba7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gae798cdc4cb10ada732e592318037cba7">EvrRtxEventFlagsNew</a> (const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> *attr)</td></tr>
  123. <tr class="memdesc:gae798cdc4cb10ada732e592318037cba7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags create and initialize (API) <a href="#gae798cdc4cb10ada732e592318037cba7">More...</a><br/></td></tr>
  124. <tr class="separator:gae798cdc4cb10ada732e592318037cba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gaa1f48b9787e3a7d4f56449ed1dd12f26">EvrRtxEventFlagsCreated</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, const char *name)</td></tr>
  126. <tr class="memdesc:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful event flags create (Op) <a href="#gaa1f48b9787e3a7d4f56449ed1dd12f26">More...</a><br/></td></tr>
  127. <tr class="separator:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gae9ebcbc09a1c15c719d95fe7b8c2ee18">EvrRtxEventFlagsGetName</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, const char *name)</td></tr>
  129. <tr class="memdesc:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags name retrieve (API) <a href="#gae9ebcbc09a1c15c719d95fe7b8c2ee18">More...</a><br/></td></tr>
  130. <tr class="separator:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga5e5c9bd8a0522fc9301782edd6e5ec1f">EvrRtxEventFlagsSet</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags)</td></tr>
  132. <tr class="memdesc:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags set (API) <a href="#ga5e5c9bd8a0522fc9301782edd6e5ec1f">More...</a><br/></td></tr>
  133. <tr class="separator:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ga5b1b471923918ad294d16255d43ab306"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga5b1b471923918ad294d16255d43ab306">EvrRtxEventFlagsSetDone</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t event_flags)</td></tr>
  135. <tr class="memdesc:ga5b1b471923918ad294d16255d43ab306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful event flags set (Op) <a href="#ga5b1b471923918ad294d16255d43ab306">More...</a><br/></td></tr>
  136. <tr class="separator:ga5b1b471923918ad294d16255d43ab306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:gab31f9da565b0170d8e89edf0e848f28b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gab31f9da565b0170d8e89edf0e848f28b">EvrRtxEventFlagsClear</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags)</td></tr>
  138. <tr class="memdesc:gab31f9da565b0170d8e89edf0e848f28b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags clear (API) <a href="#gab31f9da565b0170d8e89edf0e848f28b">More...</a><br/></td></tr>
  139. <tr class="separator:gab31f9da565b0170d8e89edf0e848f28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga9e4c4e5d45bc721439c1919621a49d5a">EvrRtxEventFlagsClearDone</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t event_flags)</td></tr>
  141. <tr class="memdesc:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful event flags clear (Op) <a href="#ga9e4c4e5d45bc721439c1919621a49d5a">More...</a><br/></td></tr>
  142. <tr class="separator:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ga113c32ff195c612ec2fb6a9dd5740184"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga113c32ff195c612ec2fb6a9dd5740184">EvrRtxEventFlagsGet</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t event_flags)</td></tr>
  144. <tr class="memdesc:ga113c32ff195c612ec2fb6a9dd5740184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags retrieve (API) <a href="#ga113c32ff195c612ec2fb6a9dd5740184">More...</a><br/></td></tr>
  145. <tr class="separator:ga113c32ff195c612ec2fb6a9dd5740184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:gac8361874ffdd854e3778f21d070fed24"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gac8361874ffdd854e3778f21d070fed24">EvrRtxEventFlagsWait</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags, uint32_t options, uint32_t timeout)</td></tr>
  147. <tr class="memdesc:gac8361874ffdd854e3778f21d070fed24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on wait for event flags (API) <a href="#gac8361874ffdd854e3778f21d070fed24">More...</a><br/></td></tr>
  148. <tr class="separator:gac8361874ffdd854e3778f21d070fed24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:gafd598e0b02a31083fb41626d68fa489e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#gafd598e0b02a31083fb41626d68fa489e">EvrRtxEventFlagsWaitPending</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags, uint32_t options, uint32_t timeout)</td></tr>
  150. <tr class="memdesc:gafd598e0b02a31083fb41626d68fa489e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending wait for event flags (Op) <a href="#gafd598e0b02a31083fb41626d68fa489e">More...</a><br/></td></tr>
  151. <tr class="separator:gafd598e0b02a31083fb41626d68fa489e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ga877235cbe04188b831b70a3c2237c827"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga877235cbe04188b831b70a3c2237c827">EvrRtxEventFlagsWaitTimeout</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
  153. <tr class="memdesc:ga877235cbe04188b831b70a3c2237c827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on wait timeout for event flags (Op) <a href="#ga877235cbe04188b831b70a3c2237c827">More...</a><br/></td></tr>
  154. <tr class="separator:ga877235cbe04188b831b70a3c2237c827"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ga7b446f241c971db432ebac5d176bd9de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga7b446f241c971db432ebac5d176bd9de">EvrRtxEventFlagsWaitCompleted</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags, uint32_t options, uint32_t event_flags)</td></tr>
  156. <tr class="memdesc:ga7b446f241c971db432ebac5d176bd9de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful wait for event flags (Op) <a href="#ga7b446f241c971db432ebac5d176bd9de">More...</a><br/></td></tr>
  157. <tr class="separator:ga7b446f241c971db432ebac5d176bd9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga66f32e4dddc68cdfd56c32b88b7f13ff">EvrRtxEventFlagsWaitNotCompleted</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags, uint32_t options)</td></tr>
  159. <tr class="memdesc:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful wait for event flags (Op) <a href="#ga66f32e4dddc68cdfd56c32b88b7f13ff">More...</a><br/></td></tr>
  160. <tr class="separator:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ga10e98e35999350e9e337c716ba4dc079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga10e98e35999350e9e337c716ba4dc079">EvrRtxEventFlagsDelete</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
  162. <tr class="memdesc:ga10e98e35999350e9e337c716ba4dc079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on event flags delete (API) <a href="#ga10e98e35999350e9e337c716ba4dc079">More...</a><br/></td></tr>
  163. <tr class="separator:ga10e98e35999350e9e337c716ba4dc079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:ga2ef153a6ee7a8d72375f81128454ede9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__event__flags.html#ga2ef153a6ee7a8d72375f81128454ede9">EvrRtxEventFlagsDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
  165. <tr class="memdesc:ga2ef153a6ee7a8d72375f81128454ede9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful event flags delete (Op) <a href="#ga2ef153a6ee7a8d72375f81128454ede9">More...</a><br/></td></tr>
  166. <tr class="separator:ga2ef153a6ee7a8d72375f81128454ede9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  169. <h2 class="groupheader">Function Documentation</h2>
  170. <a class="anchor" id="gaa281b7380c0fa725faa722badbeb2e5f"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void EvrRtxEventFlagsError </td>
  176. <td>(</td>
  177. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  178. <td class="paramname"><em>ef_id</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">int32_t&#160;</td>
  184. <td class="paramname"><em>status</em>&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <dl class="params"><dt>Parameters</dt><dd>
  194. <table class="params">
  195. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a> or NULL when ID is unknown. </td></tr>
  196. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200. <p>The event <b>EventFlagsError</b> is generated when <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> routines complete their execution due to an error.</p>
  201. <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>
  202. <table class="doxtable">
  203. <tr>
  204. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  205. <tr>
  206. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  207. <tr>
  208. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  209. <tr>
  210. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  211. <tr>
  212. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  213. <tr>
  214. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  215. <tr>
  216. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  217. <tr>
  218. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  219. <tr>
  220. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  221. <tr>
  222. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  223. <tr>
  224. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  225. <tr>
  226. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  227. <tr>
  228. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  229. <tr>
  230. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  231. <tr>
  232. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  233. <tr>
  234. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  235. <tr>
  236. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  237. </table>
  238. <p><b>Value</b> in the Event Recorder shows:</p>
  239. <ul>
  240. <li><b>ef_id</b> : event flags ID.</li>
  241. <li><b>status</b> : execution status code. </li>
  242. </ul>
  243. </div>
  244. </div>
  245. <a class="anchor" id="gae798cdc4cb10ada732e592318037cba7"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">void EvrRtxEventFlagsNew </td>
  251. <td>(</td>
  252. <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> *&#160;</td>
  253. <td class="paramname"><em>attr</em></td><td>)</td>
  254. <td></td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <dl class="params"><dt>Parameters</dt><dd>
  259. <table class="params">
  260. <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>event flags attributes.</td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <p>The event <b>EventFlagsNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a> is called.</p>
  265. <p><b>Value</b> in the Event Recorder shows:</p>
  266. <ul>
  267. <li><b>attr</b> : memory address of Event Flags attributes or 0 when they are not specified. </li>
  268. </ul>
  269. </div>
  270. </div>
  271. <a class="anchor" id="gaa1f48b9787e3a7d4f56449ed1dd12f26"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void EvrRtxEventFlagsCreated </td>
  277. <td>(</td>
  278. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  279. <td class="paramname"><em>ef_id</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const char *&#160;</td>
  285. <td class="paramname"><em>name</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <dl class="params"><dt>Parameters</dt><dd>
  295. <table class="params">
  296. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  297. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to event flags object name.</td></tr>
  298. </table>
  299. </dd>
  300. </dl>
  301. <p>The event <b>EventFlagsCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a> successfully creates a event flags object.</p>
  302. <p><b>Value</b> in the Event Recorder shows:</p>
  303. <ul>
  304. <li><b>ef_id</b> : event flags ID. </li>
  305. </ul>
  306. </div>
  307. </div>
  308. <a class="anchor" id="gae9ebcbc09a1c15c719d95fe7b8c2ee18"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">void EvrRtxEventFlagsGetName </td>
  314. <td>(</td>
  315. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  316. <td class="paramname"><em>ef_id</em>, </td>
  317. </tr>
  318. <tr>
  319. <td class="paramkey"></td>
  320. <td></td>
  321. <td class="paramtype">const char *&#160;</td>
  322. <td class="paramname"><em>name</em>&#160;</td>
  323. </tr>
  324. <tr>
  325. <td></td>
  326. <td>)</td>
  327. <td></td><td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  334. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to event flags object name.</td></tr>
  335. </table>
  336. </dd>
  337. </dl>
  338. <p>The event <b>EventFlagsGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga59f4ddf0ee8c395b1672bb978d1cfc88">osEventFlagsGetName</a> is called and its execution result is known.</p>
  339. <p><b>Value</b> in the Event Recorder shows:</p>
  340. <ul>
  341. <li><b>ef_id</b> : event flags ID.</li>
  342. <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
  343. </ul>
  344. </div>
  345. </div>
  346. <a class="anchor" id="ga5e5c9bd8a0522fc9301782edd6e5ec1f"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">void EvrRtxEventFlagsSet </td>
  352. <td>(</td>
  353. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  354. <td class="paramname"><em>ef_id</em>, </td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey"></td>
  358. <td></td>
  359. <td class="paramtype">uint32_t&#160;</td>
  360. <td class="paramname"><em>flags</em>&#160;</td>
  361. </tr>
  362. <tr>
  363. <td></td>
  364. <td>)</td>
  365. <td></td><td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <dl class="params"><dt>Parameters</dt><dd>
  370. <table class="params">
  371. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  372. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags that shall be set.</td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <p>The event <b>EventFlagsSet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a> is called.</p>
  377. <p><b>Value</b> in the Event Recorder shows:</p>
  378. <ul>
  379. <li><b>ef_id</b> : event flags ID.</li>
  380. <li><b>flags</b> : flags that shall be set. </li>
  381. </ul>
  382. </div>
  383. </div>
  384. <a class="anchor" id="ga5b1b471923918ad294d16255d43ab306"></a>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">void EvrRtxEventFlagsSetDone </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  392. <td class="paramname"><em>ef_id</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>event_flags</em>&#160;</td>
  399. </tr>
  400. <tr>
  401. <td></td>
  402. <td>)</td>
  403. <td></td><td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <dl class="params"><dt>Parameters</dt><dd>
  408. <table class="params">
  409. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  410. <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>event flags after setting.</td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <p>The event <b>EventFlagsSetDone</b> is generated when event flags are successfully set.</p>
  415. <p><b>Value</b> in the Event Recorder shows:</p>
  416. <ul>
  417. <li><b>ef_id</b> : event flags ID.</li>
  418. <li><b>event_flags</b> : event flags after setting. </li>
  419. </ul>
  420. </div>
  421. </div>
  422. <a class="anchor" id="gab31f9da565b0170d8e89edf0e848f28b"></a>
  423. <div class="memitem">
  424. <div class="memproto">
  425. <table class="memname">
  426. <tr>
  427. <td class="memname">void EvrRtxEventFlagsClear </td>
  428. <td>(</td>
  429. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  430. <td class="paramname"><em>ef_id</em>, </td>
  431. </tr>
  432. <tr>
  433. <td class="paramkey"></td>
  434. <td></td>
  435. <td class="paramtype">uint32_t&#160;</td>
  436. <td class="paramname"><em>flags</em>&#160;</td>
  437. </tr>
  438. <tr>
  439. <td></td>
  440. <td>)</td>
  441. <td></td><td></td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <dl class="params"><dt>Parameters</dt><dd>
  446. <table class="params">
  447. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  448. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags that shall be cleared.</td></tr>
  449. </table>
  450. </dd>
  451. </dl>
  452. <p>The event <b>EventFlagsClear</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a> is called.</p>
  453. <p><b>Value</b> in the Event Recorder shows:</p>
  454. <ul>
  455. <li><b>ef_id</b> : event flags ID.</li>
  456. <li><b>flags</b> : flags that shall be cleared. </li>
  457. </ul>
  458. </div>
  459. </div>
  460. <a class="anchor" id="ga9e4c4e5d45bc721439c1919621a49d5a"></a>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">void EvrRtxEventFlagsClearDone </td>
  466. <td>(</td>
  467. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  468. <td class="paramname"><em>ef_id</em>, </td>
  469. </tr>
  470. <tr>
  471. <td class="paramkey"></td>
  472. <td></td>
  473. <td class="paramtype">uint32_t&#160;</td>
  474. <td class="paramname"><em>event_flags</em>&#160;</td>
  475. </tr>
  476. <tr>
  477. <td></td>
  478. <td>)</td>
  479. <td></td><td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <dl class="params"><dt>Parameters</dt><dd>
  484. <table class="params">
  485. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  486. <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>event flags before clearing.</td></tr>
  487. </table>
  488. </dd>
  489. </dl>
  490. <p>The event <b>EventFlagsClearDone</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a> successfully clears the event flags.</p>
  491. <p><b>Value</b> in the Event Recorder shows:</p>
  492. <ul>
  493. <li><b>ef_id</b> : event flags ID.</li>
  494. <li><b>event_flags</b> : event flags before clearing. </li>
  495. </ul>
  496. </div>
  497. </div>
  498. <a class="anchor" id="ga113c32ff195c612ec2fb6a9dd5740184"></a>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">void EvrRtxEventFlagsGet </td>
  504. <td>(</td>
  505. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  506. <td class="paramname"><em>ef_id</em>, </td>
  507. </tr>
  508. <tr>
  509. <td class="paramkey"></td>
  510. <td></td>
  511. <td class="paramtype">uint32_t&#160;</td>
  512. <td class="paramname"><em>event_flags</em>&#160;</td>
  513. </tr>
  514. <tr>
  515. <td></td>
  516. <td>)</td>
  517. <td></td><td></td>
  518. </tr>
  519. </table>
  520. </div><div class="memdoc">
  521. <dl class="params"><dt>Parameters</dt><dd>
  522. <table class="params">
  523. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  524. <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>current event flags.</td></tr>
  525. </table>
  526. </dd>
  527. </dl>
  528. <p>The event <b>EventFlagsGet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga8bda3185f46bfd278cea8a6cf357677d">osEventFlagsGet</a> is called and its execution result is known.</p>
  529. <p><b>Value</b> in the Event Recorder shows:</p>
  530. <ul>
  531. <li><b>ef_id</b> : event flags ID.</li>
  532. <li><b>event_flags</b> : retrieved current event flags. </li>
  533. </ul>
  534. </div>
  535. </div>
  536. <a class="anchor" id="gac8361874ffdd854e3778f21d070fed24"></a>
  537. <div class="memitem">
  538. <div class="memproto">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname">void EvrRtxEventFlagsWait </td>
  542. <td>(</td>
  543. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  544. <td class="paramname"><em>ef_id</em>, </td>
  545. </tr>
  546. <tr>
  547. <td class="paramkey"></td>
  548. <td></td>
  549. <td class="paramtype">uint32_t&#160;</td>
  550. <td class="paramname"><em>flags</em>, </td>
  551. </tr>
  552. <tr>
  553. <td class="paramkey"></td>
  554. <td></td>
  555. <td class="paramtype">uint32_t&#160;</td>
  556. <td class="paramname"><em>options</em>, </td>
  557. </tr>
  558. <tr>
  559. <td class="paramkey"></td>
  560. <td></td>
  561. <td class="paramtype">uint32_t&#160;</td>
  562. <td class="paramname"><em>timeout</em>&#160;</td>
  563. </tr>
  564. <tr>
  565. <td></td>
  566. <td>)</td>
  567. <td></td><td></td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <dl class="params"><dt>Parameters</dt><dd>
  572. <table class="params">
  573. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  574. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  575. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  576. <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>
  577. </table>
  578. </dd>
  579. </dl>
  580. <p>The event <b>EventFlagsWait</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> is called.</p>
  581. <p><b>Value</b> in the Event Recorder shows:</p>
  582. <ul>
  583. <li><b>ef_id</b> : event flags ID.</li>
  584. <li><b>flags</b> : flags to wait for.</li>
  585. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li>
  586. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  587. </ul>
  588. </div>
  589. </div>
  590. <a class="anchor" id="gafd598e0b02a31083fb41626d68fa489e"></a>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="memname">
  594. <tr>
  595. <td class="memname">void EvrRtxEventFlagsWaitPending </td>
  596. <td>(</td>
  597. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  598. <td class="paramname"><em>ef_id</em>, </td>
  599. </tr>
  600. <tr>
  601. <td class="paramkey"></td>
  602. <td></td>
  603. <td class="paramtype">uint32_t&#160;</td>
  604. <td class="paramname"><em>flags</em>, </td>
  605. </tr>
  606. <tr>
  607. <td class="paramkey"></td>
  608. <td></td>
  609. <td class="paramtype">uint32_t&#160;</td>
  610. <td class="paramname"><em>options</em>, </td>
  611. </tr>
  612. <tr>
  613. <td class="paramkey"></td>
  614. <td></td>
  615. <td class="paramtype">uint32_t&#160;</td>
  616. <td class="paramname"><em>timeout</em>&#160;</td>
  617. </tr>
  618. <tr>
  619. <td></td>
  620. <td>)</td>
  621. <td></td><td></td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <dl class="params"><dt>Parameters</dt><dd>
  626. <table class="params">
  627. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  628. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  629. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  630. <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>
  631. </table>
  632. </dd>
  633. </dl>
  634. <p>The event <b>EventFlagsWaitPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> starts waiting for event flags to become signaled.</p>
  635. <p><b>Value</b> in the Event Recorder shows:</p>
  636. <ul>
  637. <li><b>ef_id</b> : event flags ID.</li>
  638. <li><b>flags</b> : flags to wait for.</li>
  639. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li>
  640. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  641. </ul>
  642. </div>
  643. </div>
  644. <a class="anchor" id="ga877235cbe04188b831b70a3c2237c827"></a>
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname">void EvrRtxEventFlagsWaitTimeout </td>
  650. <td>(</td>
  651. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  652. <td class="paramname"><em>ef_id</em></td><td>)</td>
  653. <td></td>
  654. </tr>
  655. </table>
  656. </div><div class="memdoc">
  657. <dl class="params"><dt>Parameters</dt><dd>
  658. <table class="params">
  659. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>.</td></tr>
  660. </table>
  661. </dd>
  662. </dl>
  663. <p>The event <b>EventFlagsWaitTimeout</b> is generated when wait for event flags to become signaled is aborted due to expired wait timeout.</p>
  664. <p><b>Value</b> in the Event Recorder shows:</p>
  665. <ul>
  666. <li><b>ef_id</b> : event flags ID. </li>
  667. </ul>
  668. </div>
  669. </div>
  670. <a class="anchor" id="ga7b446f241c971db432ebac5d176bd9de"></a>
  671. <div class="memitem">
  672. <div class="memproto">
  673. <table class="memname">
  674. <tr>
  675. <td class="memname">void EvrRtxEventFlagsWaitCompleted </td>
  676. <td>(</td>
  677. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  678. <td class="paramname"><em>ef_id</em>, </td>
  679. </tr>
  680. <tr>
  681. <td class="paramkey"></td>
  682. <td></td>
  683. <td class="paramtype">uint32_t&#160;</td>
  684. <td class="paramname"><em>flags</em>, </td>
  685. </tr>
  686. <tr>
  687. <td class="paramkey"></td>
  688. <td></td>
  689. <td class="paramtype">uint32_t&#160;</td>
  690. <td class="paramname"><em>options</em>, </td>
  691. </tr>
  692. <tr>
  693. <td class="paramkey"></td>
  694. <td></td>
  695. <td class="paramtype">uint32_t&#160;</td>
  696. <td class="paramname"><em>event_flags</em>&#160;</td>
  697. </tr>
  698. <tr>
  699. <td></td>
  700. <td>)</td>
  701. <td></td><td></td>
  702. </tr>
  703. </table>
  704. </div><div class="memdoc">
  705. <dl class="params"><dt>Parameters</dt><dd>
  706. <table class="params">
  707. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  708. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  709. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr>
  710. <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>event flags before clearing or 0 if specified flags have not been set.</td></tr>
  711. </table>
  712. </dd>
  713. </dl>
  714. <p>The event <b>EventFlagsWaitCompleted</b> is generated when waiting for event flags ends because requested flags were signaled.</p>
  715. <p><b>Value</b> in the Event Recorder shows:</p>
  716. <ul>
  717. <li><b>ef_id</b> : event flags ID.</li>
  718. <li><b>flags</b> : flags to wait for.</li>
  719. <li><b>options</b> : flags option (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li>
  720. <li><b>event_flags</b> : event flags before clearing or 0 if specified flags have not been set. </li>
  721. </ul>
  722. </div>
  723. </div>
  724. <a class="anchor" id="ga66f32e4dddc68cdfd56c32b88b7f13ff"></a>
  725. <div class="memitem">
  726. <div class="memproto">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname">void EvrRtxEventFlagsWaitNotCompleted </td>
  730. <td>(</td>
  731. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  732. <td class="paramname"><em>ef_id</em>, </td>
  733. </tr>
  734. <tr>
  735. <td class="paramkey"></td>
  736. <td></td>
  737. <td class="paramtype">uint32_t&#160;</td>
  738. <td class="paramname"><em>flags</em>, </td>
  739. </tr>
  740. <tr>
  741. <td class="paramkey"></td>
  742. <td></td>
  743. <td class="paramtype">uint32_t&#160;</td>
  744. <td class="paramname"><em>options</em>&#160;</td>
  745. </tr>
  746. <tr>
  747. <td></td>
  748. <td>)</td>
  749. <td></td><td></td>
  750. </tr>
  751. </table>
  752. </div><div class="memdoc">
  753. <dl class="params"><dt>Parameters</dt><dd>
  754. <table class="params">
  755. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>. </td></tr>
  756. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr>
  757. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx).</td></tr>
  758. </table>
  759. </dd>
  760. </dl>
  761. <p>The event <b>EventFlagsWaitNotCompleted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> returns without timeout and specified event flags were not signaled.</p>
  762. <p><b>Value</b> in the Event Recorder shows:</p>
  763. <ul>
  764. <li><b>ef_id</b> : event flags ID.</li>
  765. <li><b>flags</b> : flags to wait for.</li>
  766. <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>). </li>
  767. </ul>
  768. </div>
  769. </div>
  770. <a class="anchor" id="ga10e98e35999350e9e337c716ba4dc079"></a>
  771. <div class="memitem">
  772. <div class="memproto">
  773. <table class="memname">
  774. <tr>
  775. <td class="memname">void EvrRtxEventFlagsDelete </td>
  776. <td>(</td>
  777. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  778. <td class="paramname"><em>ef_id</em></td><td>)</td>
  779. <td></td>
  780. </tr>
  781. </table>
  782. </div><div class="memdoc">
  783. <dl class="params"><dt>Parameters</dt><dd>
  784. <table class="params">
  785. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>.</td></tr>
  786. </table>
  787. </dd>
  788. </dl>
  789. <p>The event <b>EventFlagsDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga7c4acf2fb0d506ec82905dee53fb5435">osEventFlagsDelete</a> is called.</p>
  790. <p><b>Value</b> in the Event Recorder shows:</p>
  791. <ul>
  792. <li><b>ef_id</b> : event flags ID. </li>
  793. </ul>
  794. </div>
  795. </div>
  796. <a class="anchor" id="ga2ef153a6ee7a8d72375f81128454ede9"></a>
  797. <div class="memitem">
  798. <div class="memproto">
  799. <table class="memname">
  800. <tr>
  801. <td class="memname">void EvrRtxEventFlagsDestroyed </td>
  802. <td>(</td>
  803. <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
  804. <td class="paramname"><em>ef_id</em></td><td>)</td>
  805. <td></td>
  806. </tr>
  807. </table>
  808. </div><div class="memdoc">
  809. <dl class="params"><dt>Parameters</dt><dd>
  810. <table class="params">
  811. <tr><td class="paramdir">[in]</td><td class="paramname">ef_id</td><td>event flags ID obtained by <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>.</td></tr>
  812. </table>
  813. </dd>
  814. </dl>
  815. <p>The event <b>EventFlagsDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga7c4acf2fb0d506ec82905dee53fb5435">osEventFlagsDelete</a> successfully deletes the event flags object.</p>
  816. <p><b>Value</b> in the Event Recorder shows:</p>
  817. <ul>
  818. <li><b>ef_id</b> : event flags ID. </li>
  819. </ul>
  820. </div>
  821. </div>
  822. </div><!-- contents -->
  823. </div><!-- doc-content -->
  824. <!-- start footer part -->
  825. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  826. <ul>
  827. <li class="footer">Generated on Thu Apr 9 2020 15:50:00 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved.
  828. <!--
  829. <a href="http://www.doxygen.org/index.html">
  830. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  831. -->
  832. </li>
  833. </ul>
  834. </div>
  835. </body>
  836. </html>