begriffs open source - cmsis/blob - main/RTOS2/html/group__CMSIS__RTOS__EventFlags.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-RTOS2: Event Flags</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System API</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__EventFlags.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#nested-classes">Data Structures</a> &#124;
 132 <a href="#typedef-members">Typedefs</a> &#124;
 133 <a href="#func-members">Functions</a>  </div>
 134   <div class="headertitle"><div class="title">Event Flags<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a></div></div></div>
 135 </div><!--header-->
 136 <div class="contents">
 137
 138 <p>Synchronize threads using event flags.
 139 <a href="#details">More...</a></p>
 140 <table class="memberdecls">
 141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 142 Data Structures</h2></td></tr>
 143 <tr class="memitem:structosEventFlagsAttr__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a></td></tr>
 144 <tr class="memdesc:structosEventFlagsAttr__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attributes structure for event flags.  <a href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">More...</a><br /></td></tr>
 145 <tr class="separator:structosEventFlagsAttr__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 </table><table class="memberdecls">
 147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 148 Typedefs</h2></td></tr>
 149 <tr class="memitem:gafdbab933146d6d81d7cca7287e267a50"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a></td></tr>
 150 <tr class="separator:gafdbab933146d6d81d7cca7287e267a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 </table><table class="memberdecls">
 152 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 153 Functions</h2></td></tr>
 154 <tr class="memitem:gab14b1caeb12ffa42cce1bfe889cd07df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a> (const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> *attr)</td></tr>
 155 <tr class="memdesc:gab14b1caeb12ffa42cce1bfe889cd07df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and Initialize an Event Flags object.  <br /></td></tr>
 156 <tr class="separator:gab14b1caeb12ffa42cce1bfe889cd07df"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga33b71d14cecf90b4e72639dd19f23a5e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags)</td></tr>
 158 <tr class="memdesc:ga33b71d14cecf90b4e72639dd19f23a5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the specified Event Flags.  <br /></td></tr>
 159 <tr class="separator:ga33b71d14cecf90b4e72639dd19f23a5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga93bf258ca0007c6641fbe8e4f2b8a1e5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id, uint32_t flags)</td></tr>
 161 <tr class="memdesc:ga93bf258ca0007c6641fbe8e4f2b8a1e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the specified Event Flags.  <br /></td></tr>
 162 <tr class="separator:ga93bf258ca0007c6641fbe8e4f2b8a1e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:ga8bda3185f46bfd278cea8a6cf357677d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga8bda3185f46bfd278cea8a6cf357677d">osEventFlagsGet</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
 164 <tr class="memdesc:ga8bda3185f46bfd278cea8a6cf357677d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current Event Flags.  <br /></td></tr>
 165 <tr class="separator:ga8bda3185f46bfd278cea8a6cf357677d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:ga52acb34a8322e58020227344fe662b4e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</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>
 167 <tr class="memdesc:ga52acb34a8322e58020227344fe662b4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for one or more Event Flags to become signaled.  <br /></td></tr>
 168 <tr class="separator:ga52acb34a8322e58020227344fe662b4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:ga7c4acf2fb0d506ec82905dee53fb5435"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga7c4acf2fb0d506ec82905dee53fb5435">osEventFlagsDelete</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
 170 <tr class="memdesc:ga7c4acf2fb0d506ec82905dee53fb5435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete an Event Flags object.  <br /></td></tr>
 171 <tr class="separator:ga7c4acf2fb0d506ec82905dee53fb5435"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:ga59f4ddf0ee8c395b1672bb978d1cfc88"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga59f4ddf0ee8c395b1672bb978d1cfc88">osEventFlagsGetName</a> (<a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> ef_id)</td></tr>
 173 <tr class="memdesc:ga59f4ddf0ee8c395b1672bb978d1cfc88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name of an Event Flags object.  <br /></td></tr>
 174 <tr class="separator:ga59f4ddf0ee8c395b1672bb978d1cfc88"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 </table>
 176 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 177 <p>The event flags management functions in CMSIS-RTOS allow you to control or wait for event flags. Each signal has up to 31 event flags.</p>
 178 <p>A thread</p><ul>
 179 <li>can wait for event flags to be set (using <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a>). Using this function, it enters the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state.</li>
 180 <li>may set one or more flags in any other given thread (using <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>).</li>
 181 <li>may clear its own signals or the signals of other threads (using <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a>).</li>
 182 </ul>
 183 <p>When a thread wakes up and resumes execution, its signal flags are automatically cleared (unless event flags option <a class="el" href="group__CMSIS__RTOS__Definitions.html#gaade844a42237d8c37569d4d9b16b9f1c">osFlagsNoClear</a> is specified).</p>
 184 <dl class="section note"><dt>Note</dt><dd>The functions <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>, <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a>, <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga8bda3185f46bfd278cea8a6cf357677d">osEventFlagsGet</a>, and <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> can be called from Interrupt Service Routines. </dd>
 185 <dd>
 186 Refer to eventFlagsConfig for RTX5 configuration options.</dd></dl>
 187 <h2><a class="anchor" id="autotoc_md2"></a>
 188 Working with Events</h2>
 189 <p>Here is a simple example that shows how two thread can communicate with each others using event flags:</p>
 190 <div class="image">
 191 <img src="simple_signal.png" alt=""/>
 192 <div class="caption">
 193 Simple event communication</div></div>
 194 <p>The following steps are required to use event flags:</p><ol type="1">
 195 <li>In the thread that is supposed to send a event with id sig1_id, call the set function: <div class="fragment"><div class="line"><a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(1000U);                                           <span class="comment">// wait for 1 second</span></div>
 196 <div class="line"><a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>(sig1_id, 0x0001U);                        <span class="comment">// set the flag 0x0001U for event sig1_id</span></div>
 197 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_ga33b71d14cecf90b4e72639dd19f23a5e"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></div><div class="ttdeci">uint32_t osEventFlagsSet(osEventFlagsId_t ef_id, uint32_t flags)</div><div class="ttdoc">Set the specified Event Flags.</div></div>
 198 <div class="ttc" id="agroup__CMSIS__RTOS__Wait_html_gaf6055a51390ef65b6b6edc28bf47322e"><div class="ttname"><a href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a></div><div class="ttdeci">osStatus_t osDelay(uint32_t ticks)</div><div class="ttdoc">Wait for Timeout (Time Delay).</div></div>
 199 </div><!-- fragment --></li>
 200 <li>In another thread (or threads) that are supposed to wait for the event, call the wait function: <div class="fragment"><div class="line"><a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a>(sig1_id, 0x0001U, NULL, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>);  <span class="comment">// wait forever for any flag</span></div>
 201 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_ga9eb9a7a797a42e4b55eb171ecc609ddb"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a></div><div class="ttdeci">#define osWaitForever</div><div class="ttdoc">Wait forever timeout value.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:193</div></div>
 202 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_ga52acb34a8322e58020227344fe662b4e"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a></div><div class="ttdeci">uint32_t osEventFlagsWait(osEventFlagsId_t ef_id, uint32_t flags, uint32_t options, uint32_t timeout)</div><div class="ttdoc">Wait for one or more Event Flags to become signaled.</div></div>
 203 </div><!-- fragment --></li>
 204 </ol>
 205 <p>The following complete example code can be directly used with the "CMSIS-RTOS2 main template" and is also provided as a stand-alone template for RTX5:</p>
 206 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 207 <div class="line"> </div>
 208 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 209 <div class="line"><span class="comment"> *  Event Flags creation &amp; usage</span></div>
 210 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 211 <div class="line"> </div>
 212 <div class="line"><span class="preprocessor">#define FLAGS_MSK1 0x00000001U</span></div>
 213 <div class="line"> </div>
 214 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> evt_id;                        <span class="comment">// event flags id</span></div>
 215 <div class="line"> </div>
 216 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid_Thread_EventSender;            <span class="comment">// thread id 1</span></div>
 217 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid_Thread_EventReceiver;          <span class="comment">// thread id 2</span></div>
 218 <div class="line"> </div>
 219 <div class="line"><span class="keywordtype">void</span> Thread_EventSender   (<span class="keywordtype">void</span> *argument);     <span class="comment">// thread function 1</span></div>
 220 <div class="line"><span class="keywordtype">void</span> Thread_EventReceiver (<span class="keywordtype">void</span> *argument);     <span class="comment">// thread function 2</span></div>
 221 <div class="line"> </div>
 222 <div class="line"><span class="keywordtype">int</span> Init_Events (<span class="keywordtype">void</span>) {</div>
 223 <div class="line"> </div>
 224 <div class="line">  evt_id = <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>(NULL);</div>
 225 <div class="line">  <span class="keywordflow">if</span> (evt_id == NULL) {</div>
 226 <div class="line">    ; <span class="comment">// Event Flags object not created, handle failure</span></div>
 227 <div class="line">  }</div>
 228 <div class="line"> </div>
 229 <div class="line">  tid_Thread_EventSender = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(Thread_EventSender, NULL, NULL);</div>
 230 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_EventSender == NULL) {</div>
 231 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 232 <div class="line">  }</div>
 233 <div class="line">  tid_Thread_EventReceiver = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(Thread_EventReceiver, NULL, NULL);</div>
 234 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_EventReceiver == NULL) {</div>
 235 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 236 <div class="line">  }</div>
 237 <div class="line"> </div>
 238 <div class="line">  <span class="keywordflow">return</span>(0);</div>
 239 <div class="line">}</div>
 240 <div class="line"> </div>
 241 <div class="line"><span class="keywordtype">void</span> Thread_EventSender (<span class="keywordtype">void</span> *argument) {</div>
 242 <div class="line"> </div>
 243 <div class="line">  <span class="keywordflow">while</span> (1) {    </div>
 244 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>(evt_id, FLAGS_MSK1);</div>
 245 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2">osThreadYield</a>();                            <span class="comment">// suspend thread</span></div>
 246 <div class="line">  }</div>
 247 <div class="line">}</div>
 248 <div class="line"> </div>
 249 <div class="line"><span class="keywordtype">void</span> Thread_EventReceiver (<span class="keywordtype">void</span> *argument) {</div>
 250 <div class="line">  uint32_t flags;</div>
 251 <div class="line"> </div>
 252 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 253 <div class="line">    flags = <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a>(evt_id, FLAGS_MSK1, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012">osFlagsWaitAny</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>);</div>
 254 <div class="line">    <span class="comment">//handle event</span></div>
 255 <div class="line">  }</div>
 256 <div class="line">}</div>
 257 <div class="ttc" id="acmsis__os2_8h_html"><div class="ttname"><a href="cmsis__os2_8h.html">cmsis_os2.h</a></div></div>
 258 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_ga18e63587b8450d5b8798b6f6ec04e012"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012">osFlagsWaitAny</a></div><div class="ttdeci">#define osFlagsWaitAny</div><div class="ttdoc">Wait for any flag (default).</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:196</div></div>
 259 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_gab14b1caeb12ffa42cce1bfe889cd07df"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a></div><div class="ttdeci">osEventFlagsId_t osEventFlagsNew(const osEventFlagsAttr_t *attr)</div><div class="ttdoc">Create and Initialize an Event Flags object.</div></div>
 260 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_gafdbab933146d6d81d7cca7287e267a50"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a></div><div class="ttdeci">void * osEventFlagsId_t</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:266</div></div>
 261 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_ga48d68b8666d99d28fa646ee1d2182b8f"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a></div><div class="ttdeci">osThreadId_t osThreadNew(osThreadFunc_t func, void *argument, const osThreadAttr_t *attr)</div><div class="ttdoc">Create a thread and add it to Active Threads.</div></div>
 262 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_gaa6c32fe2a3e0a2e01f212d55b02e51c7"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a></div><div class="ttdeci">void * osThreadId_t</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:260</div></div>
 263 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_gad01c7ec26535b1de6b018bb9466720e2"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2">osThreadYield</a></div><div class="ttdeci">osStatus_t osThreadYield(void)</div><div class="ttdoc">Pass control to next thread that is in state READY.</div></div>
 264 </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 265 <a name="structosEventFlagsAttr__t" id="structosEventFlagsAttr__t"></a>
 266 <h2 class="memtitle"><span class="permalink"><a href="#structosEventFlagsAttr__t">&#9670;&#160;</a></span>osEventFlagsAttr_t</h2>
 267
 268 <div class="memitem">
 269 <div class="memproto">
 270       <table class="memname">
 271         <tr>
 272           <td class="memname">struct osEventFlagsAttr_t</td>
 273         </tr>
 274       </table>
 275 </div><div class="memdoc">
 276 <div class="textblock"><p>Attributes to configure an event flag set.</p>
 277 <p>Refer to <a class="el" href="group__CMSIS__RTOS__MemoryMgmt.html">Memory Management</a> for details about usage of</p><ul>
 278 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#a1e100dc33d403841ed3c344e3397868e" title="memory for control block">osEventFlagsAttr_t::cb_mem</a></li>
 279 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#aa55a4335d12dc2785dc00fdc292d1159" title="size of provided memory for control block">osEventFlagsAttr_t::cb_size</a> </li>
 280 </ul>
 281 </div><table class="fieldtable">
 282 <tr><th colspan="3">Data Fields</th></tr>
 283 <tr><td class="fieldtype">
 284 <a id="ab74e6bf80237ddc4109968cedc58c151" name="ab74e6bf80237ddc4109968cedc58c151"></a>const char *</td>
 285 <td class="fieldname">
 286 name</td>
 287 <td class="fielddoc">
 288 name of the event flags <p>Pointer to a constant string with a human readable name (displayed during debugging) of the event flag object.</p>
 289 <p>Default: <span class="XML-Token">NULL</span> no name specified. </p>
 290 </td></tr>
 291 <tr><td class="fieldtype">
 292 <a id="a6e93b49cb79c12f768d72580c7731f30" name="a6e93b49cb79c12f768d72580c7731f30"></a>uint32_t</td>
 293 <td class="fieldname">
 294 attr_bits</td>
 295 <td class="fielddoc">
 296 attribute bits <p>Reserved for future use (must be set to '0' for future compatibility). </p>
 297 </td></tr>
 298 <tr><td class="fieldtype">
 299 <a id="a1e100dc33d403841ed3c344e3397868e" name="a1e100dc33d403841ed3c344e3397868e"></a>void *</td>
 300 <td class="fieldname">
 301 cb_mem</td>
 302 <td class="fielddoc">
 303 memory for control block <p>Pointer to a memory for the event flag control block object. Refer to StaticObjectMemory for more information.</p>
 304 <p>Default: <span class="XML-Token">NULL</span> to use <a class="el" href="group__CMSIS__RTOS__MemoryMgmt.html#CMSIS_RTOS_MemoryMgmt_Automatic">Automatic Dynamic Allocation</a> for the event flag control block. </p>
 305 </td></tr>
 306 <tr><td class="fieldtype">
 307 <a id="aa55a4335d12dc2785dc00fdc292d1159" name="aa55a4335d12dc2785dc00fdc292d1159"></a>uint32_t</td>
 308 <td class="fieldname">
 309 cb_size</td>
 310 <td class="fielddoc">
 311 size of provided memory for control block <p>The size (in bytes) of memory block passed with <a class="el" href="group__CMSIS__RTOS__EventFlags.html#a1e100dc33d403841ed3c344e3397868e">cb_mem</a>. For RTX, the minimum value is defined with osRtxEventFlagsCbSize (higher values are permitted).</p>
 312 <p>Default: <span class="XML-Token">0</span> as the default is no memory provided with <a class="el" href="group__CMSIS__RTOS__EventFlags.html#a1e100dc33d403841ed3c344e3397868e">cb_mem</a>. </p>
 313 </td></tr>
 314 </table>
 315
 316 </div>
 317 </div>
 318 <h2 class="groupheader">Typedef Documentation</h2>
 319 <a id="gafdbab933146d6d81d7cca7287e267a50" name="gafdbab933146d6d81d7cca7287e267a50"></a>
 320 <h2 class="memtitle"><span class="permalink"><a href="#gafdbab933146d6d81d7cca7287e267a50">&#9670;&#160;</a></span>osEventFlagsId_t</h2>
 321
 322 <div class="memitem">
 323 <div class="memproto">
 324       <table class="memname">
 325         <tr>
 326           <td class="memname"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a></td>
 327         </tr>
 328       </table>
 329 </div><div class="memdoc">
 330 <p>Event Flags ID identifies the event flags.</p>
 331 <p>Returned by:</p><ul>
 332 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a> </li>
 333 </ul>
 334
 335 </div>
 336 </div>
 337 <h2 class="groupheader">Function Documentation</h2>
 338 <a id="gab14b1caeb12ffa42cce1bfe889cd07df" name="gab14b1caeb12ffa42cce1bfe889cd07df"></a>
 339 <h2 class="memtitle"><span class="permalink"><a href="#gab14b1caeb12ffa42cce1bfe889cd07df">&#9670;&#160;</a></span>osEventFlagsNew()</h2>
 340
 341 <div class="memitem">
 342 <div class="memproto">
 343       <table class="memname">
 344         <tr>
 345           <td class="memname"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> osEventFlagsNew </td>
 346           <td>(</td>
 347           <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a> *&#160;</td>
 348           <td class="paramname"><em>attr</em></td><td>)</td>
 349           <td></td>
 350         </tr>
 351       </table>
 352 </div><div class="memdoc">
 353 <dl class="params"><dt>Parameters</dt><dd>
 354   <table class="params">
 355     <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>event flags attributes; NULL: default values. </td></tr>
 356   </table>
 357   </dd>
 358 </dl>
 359 <dl class="section return"><dt>Returns</dt><dd>event flags ID for reference by other functions or NULL in case of error.</dd></dl>
 360 <p>The function <b>osEventFlagsNew</b> creates a new event flags object that is used to send events across threads and returns the pointer to the event flags object identifier or <span class="XML-Token">NULL</span> in case of an error. It can be safely called before the RTOS is started (call to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>), but not before it is initialized (call to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>).</p>
 361 <p>The parameter <em>attr</em> sets the event flags attributes (refer to <a class="el" href="group__CMSIS__RTOS__EventFlags.html#structosEventFlagsAttr__t">osEventFlagsAttr_t</a>). Default attributes will be used if set to <span class="XML-Token">NULL</span>, i.e. kernel memory allocation is used for the event control block.</p>
 362 <dl class="section note"><dt>Note</dt><dd>Cannot be called from Interrupt Service Routines.</dd></dl>
 363 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 364 <div class="line"> </div>
 365 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> evt_id;                        <span class="comment">// message queue id</span></div>
 366 <div class="line"> </div>
 367 <div class="line"><span class="keywordtype">int</span> Init_Events (<span class="keywordtype">void</span>) {</div>
 368 <div class="line"> </div>
 369 <div class="line">  evt_id = <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>(NULL);</div>
 370 <div class="line">  <span class="keywordflow">if</span> (evt_id == NULL) {</div>
 371 <div class="line">    ; <span class="comment">// Event Flags object not created, handle failure</span></div>
 372 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 373 <div class="line">  }</div>
 374 <div class="line"> </div>
 375 <div class="line">  <span class="keywordflow">return</span>(0);</div>
 376 <div class="line">}</div>
 377 </div><!-- fragment -->
 378 </div>
 379 </div>
 380 <a id="ga33b71d14cecf90b4e72639dd19f23a5e" name="ga33b71d14cecf90b4e72639dd19f23a5e"></a>
 381 <h2 class="memtitle"><span class="permalink"><a href="#ga33b71d14cecf90b4e72639dd19f23a5e">&#9670;&#160;</a></span>osEventFlagsSet()</h2>
 382
 383 <div class="memitem">
 384 <div class="memproto">
 385       <table class="memname">
 386         <tr>
 387           <td class="memname">uint32_t osEventFlagsSet </td>
 388           <td>(</td>
 389           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 390           <td class="paramname"><em>ef_id</em>, </td>
 391         </tr>
 392         <tr>
 393           <td class="paramkey"></td>
 394           <td></td>
 395           <td class="paramtype">uint32_t&#160;</td>
 396           <td class="paramname"><em>flags</em>&#160;</td>
 397         </tr>
 398         <tr>
 399           <td></td>
 400           <td>)</td>
 401           <td></td><td></td>
 402         </tr>
 403       </table>
 404 </div><div class="memdoc">
 405 <dl class="params"><dt>Parameters</dt><dd>
 406   <table class="params">
 407     <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>
 408     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags that shall be set. </td></tr>
 409   </table>
 410   </dd>
 411 </dl>
 412 <dl class="section return"><dt>Returns</dt><dd>event flags after setting or error code if highest bit set.</dd></dl>
 413 <p>The function <b>osEventFlagsSet</b> sets the event flags specified by the parameter <em>flags</em> in an event flags object specified by parameter <em>ef_id</em>.</p>
 414 <p>The threads with highest priority waiting for the flag(s) set will be notified to resume from <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state. The function returns the event flags stored in the event control block or an error code (highest bit is set, refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>). Further threads may be wakened in priority order when the option <b>osFlagsNoClear</b> is given to the <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> call.</p>
 415 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 416 <li><em>osFlagsErrorUnknown:</em> unspecified error.</li>
 417 <li><em>osFlagsErrorParameter:</em> parameter <em>ef_id</em> does not identify a valid event flags object or <em>flags</em> has highest bit set.</li>
 418 <li><em>osFlagsErrorResource:</em> the event flags object is in an invalid state.</li>
 419 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified event flags object.</li>
 420 </ul>
 421 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines.</dd></dl>
 422 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 423 <div class="line"> </div>
 424 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> evt_id;                        <span class="comment">// event flags id</span></div>
 425 <div class="line"> </div>
 426 <div class="line"><span class="keywordtype">void</span> Thread_EventSender (<span class="keywordtype">void</span> *argument) {</div>
 427 <div class="line"> </div>
 428 <div class="line">  <span class="keywordflow">while</span> (1) {    </div>
 429 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a>(evt_id, 0x00000001U);</div>
 430 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2">osThreadYield</a>();                            <span class="comment">// suspend thread</span></div>
 431 <div class="line">  }</div>
 432 <div class="line">}</div>
 433 </div><!-- fragment -->
 434 </div>
 435 </div>
 436 <a id="ga93bf258ca0007c6641fbe8e4f2b8a1e5" name="ga93bf258ca0007c6641fbe8e4f2b8a1e5"></a>
 437 <h2 class="memtitle"><span class="permalink"><a href="#ga93bf258ca0007c6641fbe8e4f2b8a1e5">&#9670;&#160;</a></span>osEventFlagsClear()</h2>
 438
 439 <div class="memitem">
 440 <div class="memproto">
 441       <table class="memname">
 442         <tr>
 443           <td class="memname">uint32_t osEventFlagsClear </td>
 444           <td>(</td>
 445           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 446           <td class="paramname"><em>ef_id</em>, </td>
 447         </tr>
 448         <tr>
 449           <td class="paramkey"></td>
 450           <td></td>
 451           <td class="paramtype">uint32_t&#160;</td>
 452           <td class="paramname"><em>flags</em>&#160;</td>
 453         </tr>
 454         <tr>
 455           <td></td>
 456           <td>)</td>
 457           <td></td><td></td>
 458         </tr>
 459       </table>
 460 </div><div class="memdoc">
 461 <dl class="params"><dt>Parameters</dt><dd>
 462   <table class="params">
 463     <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>
 464     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags that shall be cleared. </td></tr>
 465   </table>
 466   </dd>
 467 </dl>
 468 <dl class="section return"><dt>Returns</dt><dd>event flags before clearing or error code if highest bit set.</dd></dl>
 469 <p>The function <b>osEventFlagsClear</b> clears the event flags specified by the parameter <em>flags</em> in an event flags object specified by parameter <em>ef_id</em>. The function returns the event flags before clearing or an error code (highest bit is set, refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>).</p>
 470 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 471 <li><em>osFlagsErrorUnknown:</em> unspecified error.</li>
 472 <li><em>osFlagsErrorParameter:</em> parameter <em>ef_id</em> does not identify a valid event flags object or <em>flags</em> has highest bit set.</li>
 473 <li><em>osFlagsErrorResource:</em> the event flags object is in an invalid state.</li>
 474 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified event flags object.</li>
 475 </ul>
 476 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 477
 478 </div>
 479 </div>
 480 <a id="ga8bda3185f46bfd278cea8a6cf357677d" name="ga8bda3185f46bfd278cea8a6cf357677d"></a>
 481 <h2 class="memtitle"><span class="permalink"><a href="#ga8bda3185f46bfd278cea8a6cf357677d">&#9670;&#160;</a></span>osEventFlagsGet()</h2>
 482
 483 <div class="memitem">
 484 <div class="memproto">
 485       <table class="memname">
 486         <tr>
 487           <td class="memname">uint32_t osEventFlagsGet </td>
 488           <td>(</td>
 489           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 490           <td class="paramname"><em>ef_id</em></td><td>)</td>
 491           <td></td>
 492         </tr>
 493       </table>
 494 </div><div class="memdoc">
 495 <dl class="params"><dt>Parameters</dt><dd>
 496   <table class="params">
 497     <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>
 498   </table>
 499   </dd>
 500 </dl>
 501 <dl class="section return"><dt>Returns</dt><dd>current event flags.</dd></dl>
 502 <p>The function <b>osEventFlagsGet</b> returns the event flags currently set in an event flags object specified by parameter <em>ef_id</em> or <span class="XML-Token">0</span> in case of an error.</p>
 503 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 504
 505 </div>
 506 </div>
 507 <a id="ga52acb34a8322e58020227344fe662b4e" name="ga52acb34a8322e58020227344fe662b4e"></a>
 508 <h2 class="memtitle"><span class="permalink"><a href="#ga52acb34a8322e58020227344fe662b4e">&#9670;&#160;</a></span>osEventFlagsWait()</h2>
 509
 510 <div class="memitem">
 511 <div class="memproto">
 512       <table class="memname">
 513         <tr>
 514           <td class="memname">uint32_t osEventFlagsWait </td>
 515           <td>(</td>
 516           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 517           <td class="paramname"><em>ef_id</em>, </td>
 518         </tr>
 519         <tr>
 520           <td class="paramkey"></td>
 521           <td></td>
 522           <td class="paramtype">uint32_t&#160;</td>
 523           <td class="paramname"><em>flags</em>, </td>
 524         </tr>
 525         <tr>
 526           <td class="paramkey"></td>
 527           <td></td>
 528           <td class="paramtype">uint32_t&#160;</td>
 529           <td class="paramname"><em>options</em>, </td>
 530         </tr>
 531         <tr>
 532           <td class="paramkey"></td>
 533           <td></td>
 534           <td class="paramtype">uint32_t&#160;</td>
 535           <td class="paramname"><em>timeout</em>&#160;</td>
 536         </tr>
 537         <tr>
 538           <td></td>
 539           <td>)</td>
 540           <td></td><td></td>
 541         </tr>
 542       </table>
 543 </div><div class="memdoc">
 544 <dl class="params"><dt>Parameters</dt><dd>
 545   <table class="params">
 546     <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>
 547     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags to wait for. </td></tr>
 548     <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>specifies flags options (osFlagsXxxx). </td></tr>
 549     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>CMSIS_RTOS_TimeOutValue or 0 in case of no time-out. </td></tr>
 550   </table>
 551   </dd>
 552 </dl>
 553 <dl class="section return"><dt>Returns</dt><dd>event flags before clearing or error code if highest bit set.</dd></dl>
 554 <p>The function <b>osEventFlagsWait</b> suspends the execution of the currently <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">RUNNING</a> thread until any or all event flags specified by the parameter <em>flags</em> in the event object specified by parameter <em>ef_id</em> are set. When these event flags are already set, the function returns instantly. Otherwise, the thread is put into the state <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a>.</p>
 555 <p>The <em>options</em> parameter specifies the wait condition: </p><table class="markdownTable">
 556 <tr class="markdownTableHead">
 557 <th class="markdownTableHeadNone">Option   </th><th class="markdownTableHeadNone"></th></tr>
 558 <tr class="markdownTableRowOdd">
 559 <td class="markdownTableBodyNone"><b>osFlagsWaitAny</b>   </td><td class="markdownTableBodyNone">Wait for any flag (default).    </td></tr>
 560 <tr class="markdownTableRowEven">
 561 <td class="markdownTableBodyNone"><b>osFlagsWaitAll</b>   </td><td class="markdownTableBodyNone">Wait for all flags.    </td></tr>
 562 <tr class="markdownTableRowOdd">
 563 <td class="markdownTableBodyNone"><b>osFlagsNoClear</b>   </td><td class="markdownTableBodyNone">Do not clear flags which have been specified to wait for.   </td></tr>
 564 </table>
 565 <p>If <code>osFlagsNoClear</code> is set in the options <a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a> can be used to clear flags manually.</p>
 566 <p>The parameter <em>timeout</em> specifies how long the system waits for event flags. While the system waits, the thread that is calling this function is put into the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state. The parameter timeout can have the following values:</p><ul>
 567 <li>when <em>timeout</em> is <span class="XML-Token">0</span>, the function returns instantly (i.e. try semantics).</li>
 568 <li>when <em>timeout</em> is set to <b>osWaitForever</b> the function will wait for an infinite time until the event flags become available (i.e. wait semantics).</li>
 569 <li>all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).</li>
 570 </ul>
 571 <p>The function returns the event flags before clearing or an error code (highest bit is set, refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>).</p>
 572 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 573 <li><em>osFlagsErrorUnknown:</em> unspecified error.</li>
 574 <li><em>osFlagsErrorTimeout:</em> awaited flags have not been set in the given time.</li>
 575 <li><em>osFlagsErrorResource:</em> awaited flags have not been set when no <em>timeout</em> was specified.</li>
 576 <li><em>osFlagsErrorParameter:</em> parameter <em>ef_id</em> does not identify a valid event flags object or <em>flags</em> has highest bit set.</li>
 577 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified event flags object.</li>
 578 </ul>
 579 <dl class="section note"><dt>Note</dt><dd>May be called from Interrupt Service Routines if the parameter <em>timeout</em> is set to <span class="XML-Token">0</span>.</dd></dl>
 580 <p><b>Code</b> <b>Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 581 <div class="line"> </div>
 582 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> evt_id;                        <span class="comment">// event flags id</span></div>
 583 <div class="line"> </div>
 584 <div class="line"><span class="keywordtype">void</span> Thread_EventReceiver (<span class="keywordtype">void</span> *argument) {</div>
 585 <div class="line">  uint32_t flags;</div>
 586 <div class="line"> </div>
 587 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 588 <div class="line">    flags = <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a>(evt_id, 0x00000001U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012">osFlagsWaitAny</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>);</div>
 589 <div class="line">    <span class="comment">//handle event</span></div>
 590 <div class="line">  }</div>
 591 <div class="line">}</div>
 592 </div><!-- fragment -->
 593 </div>
 594 </div>
 595 <a id="ga7c4acf2fb0d506ec82905dee53fb5435" name="ga7c4acf2fb0d506ec82905dee53fb5435"></a>
 596 <h2 class="memtitle"><span class="permalink"><a href="#ga7c4acf2fb0d506ec82905dee53fb5435">&#9670;&#160;</a></span>osEventFlagsDelete()</h2>
 597
 598 <div class="memitem">
 599 <div class="memproto">
 600       <table class="memname">
 601         <tr>
 602           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osEventFlagsDelete </td>
 603           <td>(</td>
 604           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 605           <td class="paramname"><em>ef_id</em></td><td>)</td>
 606           <td></td>
 607         </tr>
 608       </table>
 609 </div><div class="memdoc">
 610 <dl class="params"><dt>Parameters</dt><dd>
 611   <table class="params">
 612     <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>
 613   </table>
 614   </dd>
 615 </dl>
 616 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 617 <p>The function <b>osEventFlagsDelete</b> deletes the event flags object specified by parameter <em>ef_id</em> and releases the internal memory obtained for the event flags handling. After this call, the <em>ef_id</em> is no longer valid and cannot be used. This can cause starvation of threads that are waiting for flags of this event object. The <em>ef_id</em> may be created again using the function <a class="el" href="group__CMSIS__RTOS__EventFlags.html#gab14b1caeb12ffa42cce1bfe889cd07df">osEventFlagsNew</a>.</p>
 618 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 619 <li><em>osOK:</em> the specified event flags object has been deleted.</li>
 620 <li><em>osErrorISR:</em> <b>osEventFlagsDelete</b> cannot be called from interrupt service routines.</li>
 621 <li><em>osErrorParameter:</em> parameter <em>ef_id</em> is <span class="XML-Token">NULL</span> or invalid.</li>
 622 <li><em>osErrorResource:</em> the event flags object is in an invalid state.</li>
 623 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified event flags object.</li>
 624 </ul>
 625 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines. </dd></dl>
 626
 627 </div>
 628 </div>
 629 <a id="ga59f4ddf0ee8c395b1672bb978d1cfc88" name="ga59f4ddf0ee8c395b1672bb978d1cfc88"></a>
 630 <h2 class="memtitle"><span class="permalink"><a href="#ga59f4ddf0ee8c395b1672bb978d1cfc88">&#9670;&#160;</a></span>osEventFlagsGetName()</h2>
 631
 632 <div class="memitem">
 633 <div class="memproto">
 634       <table class="memname">
 635         <tr>
 636           <td class="memname">const char * osEventFlagsGetName </td>
 637           <td>(</td>
 638           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a>&#160;</td>
 639           <td class="paramname"><em>ef_id</em></td><td>)</td>
 640           <td></td>
 641         </tr>
 642       </table>
 643 </div><div class="memdoc">
 644 <dl class="params"><dt>Parameters</dt><dd>
 645   <table class="params">
 646     <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>
 647   </table>
 648   </dd>
 649 </dl>
 650 <dl class="section return"><dt>Returns</dt><dd>name as null-terminated string.</dd></dl>
 651 <p>The function <b>osEventFlagsGetName</b> returns the pointer to the name string of the event flags object identified by parameter <em>ef_id</em> or <span class="XML-Token">NULL</span> in case of an error.</p>
 652 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines.</dd></dl>
 653 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 654 <div class="line"> </div>
 655 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__EventFlags.html#gafdbab933146d6d81d7cca7287e267a50">osEventFlagsId_t</a> evt_id;                        <span class="comment">// event flasg id</span></div>
 656 <div class="line"> </div>
 657 <div class="line"><span class="keywordtype">void</span> EvtFlagsGetName_example (<span class="keywordtype">void</span>)  {</div>
 658 <div class="line">  <span class="keywordtype">char</span> *name;</div>
 659 <div class="line">   </div>
 660 <div class="line">  name = <a class="code hl_function" href="group__CMSIS__RTOS__EventFlags.html#ga59f4ddf0ee8c395b1672bb978d1cfc88">osEventFlagsGetName</a>(evt_id);</div>
 661 <div class="line">  <span class="keywordflow">if</span> (name == NULL) {</div>
 662 <div class="line">    <span class="comment">// Failed to get the event flags object name</span></div>
 663 <div class="line">  }</div>
 664 <div class="line">}</div>
 665 <div class="ttc" id="agroup__CMSIS__RTOS__EventFlags_html_ga59f4ddf0ee8c395b1672bb978d1cfc88"><div class="ttname"><a href="group__CMSIS__RTOS__EventFlags.html#ga59f4ddf0ee8c395b1672bb978d1cfc88">osEventFlagsGetName</a></div><div class="ttdeci">const char * osEventFlagsGetName(osEventFlagsId_t ef_id)</div><div class="ttdoc">Get name of an Event Flags object.</div></div>
 666 </div><!-- fragment -->
 667 </div>
 668 </div>
 669 </div><!-- contents -->
 670 </div><!-- doc-content -->
 671 <!-- start footer part -->
 672 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 673   <ul>
 674     <li class="footer">
 675       <script type="text/javascript">
 676         <!--
 677         writeFooter.call(this);
 678         //-->
 679       </script>
 680     </li>
 681   </ul>
 682 </div>
 683 </body>
 684 </html>