| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <title>Event Flags Functions</title> |
| <title>CMSIS-RTOS2: Event Flags Functions</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="cmsis.css" rel="stylesheet" type="text/css" /> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <script type="text/javascript" src="printComponentTabs.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| $(window).load(resizeHeight); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 46px;"> |
| <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">CMSIS-RTOS2 |
|  <span id="projectnumber">Version 2.1.3</span> |
| </div> |
| <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <div id="CMSISnav" class="tabs1"> |
| <ul class="tablist"> |
| <script type="text/javascript"> |
| <!-- |
| writeComponentTabs.call(this); |
| //--> |
| </script> |
| </ul> |
| </div> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Usage and Description</span></a></li> |
| <li><a href="modules.html"><span>Reference</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('group__rtx__evr__event__flags.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Event Flags Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Events generated by event flag functions. |
| <a href="#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:gaa281b7380c0fa725faa722badbeb2e5f"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gaa281b7380c0fa725faa722badbeb2e5f"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags error (Error) <a href="#gaa281b7380c0fa725faa722badbeb2e5f">More...</a><br/></td></tr> |
| <tr class="separator:gaa281b7380c0fa725faa722badbeb2e5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae798cdc4cb10ada732e592318037cba7"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gae798cdc4cb10ada732e592318037cba7"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags create and initialize (API) <a href="#gae798cdc4cb10ada732e592318037cba7">More...</a><br/></td></tr> |
| <tr class="separator:gae798cdc4cb10ada732e592318037cba7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful event flags create (Op) <a href="#gaa1f48b9787e3a7d4f56449ed1dd12f26">More...</a><br/></td></tr> |
| <tr class="separator:gaa1f48b9787e3a7d4f56449ed1dd12f26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags name retrieve (API) <a href="#gae9ebcbc09a1c15c719d95fe7b8c2ee18">More...</a><br/></td></tr> |
| <tr class="separator:gae9ebcbc09a1c15c719d95fe7b8c2ee18"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags set (API) <a href="#ga5e5c9bd8a0522fc9301782edd6e5ec1f">More...</a><br/></td></tr> |
| <tr class="separator:ga5e5c9bd8a0522fc9301782edd6e5ec1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5b1b471923918ad294d16255d43ab306"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga5b1b471923918ad294d16255d43ab306"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful event flags set (Op) <a href="#ga5b1b471923918ad294d16255d43ab306">More...</a><br/></td></tr> |
| <tr class="separator:ga5b1b471923918ad294d16255d43ab306"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab31f9da565b0170d8e89edf0e848f28b"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gab31f9da565b0170d8e89edf0e848f28b"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags clear (API) <a href="#gab31f9da565b0170d8e89edf0e848f28b">More...</a><br/></td></tr> |
| <tr class="separator:gab31f9da565b0170d8e89edf0e848f28b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful event flags clear (Op) <a href="#ga9e4c4e5d45bc721439c1919621a49d5a">More...</a><br/></td></tr> |
| <tr class="separator:ga9e4c4e5d45bc721439c1919621a49d5a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga113c32ff195c612ec2fb6a9dd5740184"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga113c32ff195c612ec2fb6a9dd5740184"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags retrieve (API) <a href="#ga113c32ff195c612ec2fb6a9dd5740184">More...</a><br/></td></tr> |
| <tr class="separator:ga113c32ff195c612ec2fb6a9dd5740184"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac8361874ffdd854e3778f21d070fed24"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gac8361874ffdd854e3778f21d070fed24"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait for event flags (API) <a href="#gac8361874ffdd854e3778f21d070fed24">More...</a><br/></td></tr> |
| <tr class="separator:gac8361874ffdd854e3778f21d070fed24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafd598e0b02a31083fb41626d68fa489e"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:gafd598e0b02a31083fb41626d68fa489e"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending wait for event flags (Op) <a href="#gafd598e0b02a31083fb41626d68fa489e">More...</a><br/></td></tr> |
| <tr class="separator:gafd598e0b02a31083fb41626d68fa489e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga877235cbe04188b831b70a3c2237c827"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga877235cbe04188b831b70a3c2237c827"><td class="mdescLeft"> </td><td class="mdescRight">Event on wait timeout for event flags (Op) <a href="#ga877235cbe04188b831b70a3c2237c827">More...</a><br/></td></tr> |
| <tr class="separator:ga877235cbe04188b831b70a3c2237c827"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga7b446f241c971db432ebac5d176bd9de"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga7b446f241c971db432ebac5d176bd9de"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful wait for event flags (Op) <a href="#ga7b446f241c971db432ebac5d176bd9de">More...</a><br/></td></tr> |
| <tr class="separator:ga7b446f241c971db432ebac5d176bd9de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful wait for event flags (Op) <a href="#ga66f32e4dddc68cdfd56c32b88b7f13ff">More...</a><br/></td></tr> |
| <tr class="separator:ga66f32e4dddc68cdfd56c32b88b7f13ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga10e98e35999350e9e337c716ba4dc079"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga10e98e35999350e9e337c716ba4dc079"><td class="mdescLeft"> </td><td class="mdescRight">Event on event flags delete (API) <a href="#ga10e98e35999350e9e337c716ba4dc079">More...</a><br/></td></tr> |
| <tr class="separator:ga10e98e35999350e9e337c716ba4dc079"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga2ef153a6ee7a8d72375f81128454ede9"><td class="memItemLeft" align="right" valign="top">void </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> |
| <tr class="memdesc:ga2ef153a6ee7a8d72375f81128454ede9"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful event flags delete (Op) <a href="#ga2ef153a6ee7a8d72375f81128454ede9">More...</a><br/></td></tr> |
| <tr class="separator:ga2ef153a6ee7a8d72375f81128454ede9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Description</h2> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="gaa281b7380c0fa725faa722badbeb2e5f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsError </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>status</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <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> |
| <table class="doxtable"> |
| <tr> |
| <th align="left">Extended Status Code </th><th align="left">Description </th></tr> |
| <tr> |
| <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr> |
| <tr> |
| <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr> |
| </table> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>status</b> : execution status code. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gae798cdc4cb10ada732e592318037cba7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsNew </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> * </td> |
| <td class="paramname"><em>attr</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>event flags attributes.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>attr</b> : memory address of Event Flags attributes or 0 when they are not specified. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaa1f48b9787e3a7d4f56449ed1dd12f26"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsCreated </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to event flags object name.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gae9ebcbc09a1c15c719d95fe7b8c2ee18"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsGetName </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to event flags object name.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga5e5c9bd8a0522fc9301782edd6e5ec1f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsSet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags that shall be set.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags that shall be set. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga5b1b471923918ad294d16255d43ab306"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsSetDone </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>event_flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>event flags after setting.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>EventFlagsSetDone</b> is generated when event flags are successfully set.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>event_flags</b> : event flags after setting. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gab31f9da565b0170d8e89edf0e848f28b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsClear </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags that shall be cleared.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags that shall be cleared. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga9e4c4e5d45bc721439c1919621a49d5a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsClearDone </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>event_flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>event flags before clearing.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>event_flags</b> : event flags before clearing. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga113c32ff195c612ec2fb6a9dd5740184"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsGet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>event_flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">event_flags</td><td>current event flags.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>event_flags</b> : retrieved current event flags. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gac8361874ffdd854e3778f21d070fed24"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsWait </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>options</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>timeout</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags to wait for.</li> |
| <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li> |
| <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gafd598e0b02a31083fb41626d68fa489e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsWaitPending </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>options</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>timeout</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags to wait for.</li> |
| <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li> |
| <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga877235cbe04188b831b70a3c2237c827"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsWaitTimeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>EventFlagsWaitTimeout</b> is generated when wait for event flags to become signaled is aborted due to expired wait timeout.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga7b446f241c971db432ebac5d176bd9de"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsWaitCompleted </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>options</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>event_flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx). </td></tr> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>EventFlagsWaitCompleted</b> is generated when waiting for event flags ends because requested flags were signaled.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags to wait for.</li> |
| <li><b>options</b> : flags option (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>).</li> |
| <li><b>event_flags</b> : event flags before clearing or 0 if specified flags have not been set. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga66f32e4dddc68cdfd56c32b88b7f13ff"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsWaitNotCompleted </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>options</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>flags to wait for. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>flags options (osFlagsXxxx).</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID.</li> |
| <li><b>flags</b> : flags to wait for.</li> |
| <li><b>options</b> : flags options (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">event flags options</a>). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga10e98e35999350e9e337c716ba4dc079"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsDelete </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga2ef153a6ee7a8d72375f81128454ede9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxEventFlagsDestroyed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> </td> |
| <td class="paramname"><em>ef_id</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <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> |
| </table> |
| </dd> |
| </dl> |
| <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> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>ef_id</b> : event flags ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="footer">Generated on Wed Jul 10 2019 15:21:04 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved. |
| <!-- |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |
| --> |
| </li> |
| </ul> |
| </div> |
| </body> |
| </html> |