begriffs open source - cmsis/blob - dev/v6.0.0-dev53/RTOS2/html/group__CMSIS__RTOS__ThreadFlagsMgmt.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: Thread 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);
  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__ThreadFlagsMgmt.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="#func-members">Functions</a>  </div>
 132   <div class="headertitle"><div class="title">Thread Flags<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS2 API</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Synchronize threads using flags.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 140 Functions</h2></td></tr>
 141 <tr class="memitem:ga6f89ef9caded1d9963c7b12b0f6412c9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a> (<a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> thread_id, uint32_t flags)</td></tr>
 142 <tr class="memdesc:ga6f89ef9caded1d9963c7b12b0f6412c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the specified Thread Flags of a thread.  <br /></td></tr>
 143 <tr class="separator:ga6f89ef9caded1d9963c7b12b0f6412c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga656abc1c862c5b9a2b13584c42cc0bfa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> (uint32_t flags)</td></tr>
 145 <tr class="memdesc:ga656abc1c862c5b9a2b13584c42cc0bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the specified Thread Flags of current running thread.  <br /></td></tr>
 146 <tr class="separator:ga656abc1c862c5b9a2b13584c42cc0bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga85c8d2c89466e25abbcb545d9ddd71ba"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga85c8d2c89466e25abbcb545d9ddd71ba">osThreadFlagsGet</a> (void)</td></tr>
 148 <tr class="memdesc:ga85c8d2c89466e25abbcb545d9ddd71ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current Thread Flags of current running thread.  <br /></td></tr>
 149 <tr class="separator:ga85c8d2c89466e25abbcb545d9ddd71ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gac11542ad6300b600f872fc96e340ec2b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> (uint32_t flags, uint32_t options, uint32_t timeout)</td></tr>
 151 <tr class="memdesc:gac11542ad6300b600f872fc96e340ec2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for one or more Thread Flags of the current running thread to become signaled.  <br /></td></tr>
 152 <tr class="separator:gac11542ad6300b600f872fc96e340ec2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>Synchronize threads using flags. </p>
 156 <p>Thread Flags are a more specialized version of the Event Flags. See <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a>. While Event Flags can be used to globally signal a number of threads, thread flags are only send to a single specific thread. Every thread instance can receive thread flags without any additional allocation of a thread flags object.</p>
 157 <dl class="section note"><dt>Note</dt><dd>Thread flag management functions cannot be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>, except for <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>.</dd></dl>
 158 <p><b>Usage Example</b></p>
 159 <p>The following (incomplete) code excerpt sketches the usage principals for <b>Thread Flags</b>.</p>
 160 <p>The behavior is the following:</p><ul>
 161 <li>app_main starts executing</li>
 162 <li>statement A sets thread flags to 0x02 (flags = 0x02 – after set)</li>
 163 <li>app_main enters delay</li>
 164 <li>execution switches to threadX</li>
 165 <li>statement B waits for flag 0x01 and blocks since flag is not set</li>
 166 <li>execution switches to app_main</li>
 167 <li>statement C sets thread flags to 0x07</li>
 168 <li>threadX wakes-up and clears flag 0x01, thread flags = 0x06, return value set to 0x07 (before clear), note: all this happens during statement C</li>
 169 <li>statement C returns with flags = 0x06</li>
 170 <li>app_main enters delay</li>
 171 <li>execution switches to threadX</li>
 172 <li>statement B returns with flagsX = 0x07</li>
 173 </ul>
 174 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 175 <div class="line"> </div>
 176 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid;</div>
 177 <div class="line">uint32_t     flagsX;</div>
 178 <div class="line">uint32_t     flags;</div>
 179 <div class="line"> </div>
 180 <div class="line"><span class="keywordtype">void</span> threadX (<span class="keywordtype">void</span> *argument) {</div>
 181 <div class="line">  </div>
 182 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(1U);</div>
 183 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 184 <div class="line">    flagsX = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled.">osThreadFlagsWait</a>(0x0001U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012" title="Wait for any flag (default).">osFlagsWaitAny</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb" title="Wait forever timeout value.">osWaitForever</a>); <span class="comment">/* B */</span></div>
 185 <div class="line">  }</div>
 186 <div class="line">}</div>
 187 <div class="line"> </div>
 188 <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
 189 <div class="line"> </div>
 190 <div class="line">  tid = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads.">osThreadNew</a>(threadX, NULL, NULL);</div>
 191 <div class="line"> </div>
 192 <div class="line">  flags = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread.">osThreadFlagsSet</a>(tid, 0x0002U); <span class="comment">/* A */</span></div>
 193 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(2U);</div>
 194 <div class="line">  flags = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread.">osThreadFlagsSet</a>(tid, 0x0005U); <span class="comment">/* C */</span></div>
 195 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(2U);</div>
 196 <div class="line"> </div>
 197 <div class="line">  <span class="keywordflow">for</span>(;;);</div>
 198 <div class="line">}</div>
 199 </div><!-- fragment --> <h2 class="groupheader">Function Documentation</h2>
 200 <a id="ga6f89ef9caded1d9963c7b12b0f6412c9" name="ga6f89ef9caded1d9963c7b12b0f6412c9"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#ga6f89ef9caded1d9963c7b12b0f6412c9">&#9670;&#160;</a></span>osThreadFlagsSet()</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">uint32_t osThreadFlagsSet </td>
 208           <td>(</td>
 209           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
 210           <td class="paramname"><em>thread_id</em>, </td>
 211         </tr>
 212         <tr>
 213           <td class="paramkey"></td>
 214           <td></td>
 215           <td class="paramtype">uint32_t&#160;</td>
 216           <td class="paramname"><em>flags</em>&#160;</td>
 217         </tr>
 218         <tr>
 219           <td></td>
 220           <td>)</td>
 221           <td></td><td></td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>Set the specified Thread Flags of a thread. </p>
 227 <dl class="params"><dt>Parameters</dt><dd>
 228   <table class="params">
 229     <tr><td class="paramdir">[in]</td><td class="paramname">thread_id</td><td>thread ID obtained by <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga8df03548e89fbc56402a5cd584a505da">osThreadGetId</a>. </td></tr>
 230     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags of the thread that shall be set. </td></tr>
 231   </table>
 232   </dd>
 233 </dl>
 234 <dl class="section return"><dt>Returns</dt><dd>thread flags after setting or error code if highest bit set.</dd></dl>
 235 <p>The function <b>osThreadFlagsSet</b> sets the thread flags for a thread specified by parameter <em>thread_id</em>. The thread returns the flags stored in the thread control block, or an error code if highest bit is set (refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>). Refer to <b>Usage</b> <b>Examples</b> below to understand how the return value is computed.</p>
 236 <p>The target thread waiting for a flag to be set will resume from <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state.</p>
 237 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 238 <li><em>osFlagsErrorUnknown:</em> unspecified error.</li>
 239 <li><em>osFlagsErrorParameter:</em> parameter <em>thread_id</em> is not a valid thread or <em>flags</em> has highest bit set.</li>
 240 <li><em>osFlagsErrorResource:</em> the thread is in invalid state.</li>
 241 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified thread.</li>
 242 </ul>
 243 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 244 <p><b>Code</b> <b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 245 <div class="line"><span class="comment"> *      Function &#39;signal_func&#39; called from multiple threads</span></div>
 246 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 247 <div class="line"><span class="keywordtype">void</span> signal_func (<a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid)  {</div>
 248 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread.">osThreadFlagsSet</a>(tid_clock, 0x0100U);     <span class="comment">/* set signal to clock thread    */</span></div>
 249 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(500U);                            <span class="comment">/* delay 500ms                   */</span></div>
 250 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread.">osThreadFlagsSet</a>(tid_clock, 0x0100U);     <span class="comment">/* set signal to clock thread    */</span></div>
 251 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(500U);                            <span class="comment">/* delay 500ms                   */</span></div>
 252 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9" title="Set the specified Thread Flags of a thread.">osThreadFlagsSet</a>(tid, 0x0001U);           <span class="comment">/* set signal to thread &#39;thread&#39; */</span></div>
 253 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e" title="Wait for Timeout (Time Delay).">osDelay</a>(500U);                            <span class="comment">/* delay 500ms                   */</span></div>
 254 <div class="line">}</div>
 255 </div><!-- fragment --><p><b>Usage</b> <b>Examples</b> </p>
 256 <p>The following diagram assumes that in the control block of Thread1 the flag 1 is already set. Thread2 now sets flag 2 and Thread1 returns the updated value immediately:</p>
 257 <div class="mscgraph">
 258 <img src="msc_inline_mscgraph_1.png" alt="msc_inline_mscgraph_1" border="0"/>
 259 </div>
 260 <p>Depending on thread scheduling, the flag status can be modified before returning:</p>
 261 <div class="mscgraph">
 262 <img src="msc_inline_mscgraph_2.png" alt="msc_inline_mscgraph_2" border="0"/>
 263 </div>
 264  <dl class="section note"><dt>Note</dt><dd>* In this case <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a> auto-clears the flag. </dd></dl>
 265
 266 </div>
 267 </div>
 268 <a id="ga656abc1c862c5b9a2b13584c42cc0bfa" name="ga656abc1c862c5b9a2b13584c42cc0bfa"></a>
 269 <h2 class="memtitle"><span class="permalink"><a href="#ga656abc1c862c5b9a2b13584c42cc0bfa">&#9670;&#160;</a></span>osThreadFlagsClear()</h2>
 270
 271 <div class="memitem">
 272 <div class="memproto">
 273       <table class="memname">
 274         <tr>
 275           <td class="memname">uint32_t osThreadFlagsClear </td>
 276           <td>(</td>
 277           <td class="paramtype">uint32_t&#160;</td>
 278           <td class="paramname"><em>flags</em></td><td>)</td>
 279           <td></td>
 280         </tr>
 281       </table>
 282 </div><div class="memdoc">
 283
 284 <p>Clear the specified Thread Flags of current running thread. </p>
 285 <dl class="params"><dt>Parameters</dt><dd>
 286   <table class="params">
 287     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags of the thread that shall be cleared. </td></tr>
 288   </table>
 289   </dd>
 290 </dl>
 291 <dl class="section return"><dt>Returns</dt><dd>thread flags before clearing or error code if highest bit set.</dd></dl>
 292 <p>The function <b>osThreadFlagsClear</b> clears the specified flags for the currently running thread. It returns the flags before clearing, or an error code if highest bit is set (refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>).</p>
 293 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 294 <li><em>osFlagsErrorUnknown:</em> unspecified error, i.e. not called from a running threads context.</li>
 295 <li><em>osFlagsErrorParameter:</em> parameter <em>flags</em> has highest bit set.</li>
 296 <li><em>osFlagsErrorISR:</em> the function <b>osThreadFlagsClear</b> cannot be called from interrupt service routines.</li>
 297 </ul>
 298 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 299
 300 </div>
 301 </div>
 302 <a id="ga85c8d2c89466e25abbcb545d9ddd71ba" name="ga85c8d2c89466e25abbcb545d9ddd71ba"></a>
 303 <h2 class="memtitle"><span class="permalink"><a href="#ga85c8d2c89466e25abbcb545d9ddd71ba">&#9670;&#160;</a></span>osThreadFlagsGet()</h2>
 304
 305 <div class="memitem">
 306 <div class="memproto">
 307       <table class="memname">
 308         <tr>
 309           <td class="memname">uint32_t osThreadFlagsGet </td>
 310           <td>(</td>
 311           <td class="paramtype">void&#160;</td>
 312           <td class="paramname"></td><td>)</td>
 313           <td></td>
 314         </tr>
 315       </table>
 316 </div><div class="memdoc">
 317
 318 <p>Get the current Thread Flags of current running thread. </p>
 319 <dl class="section return"><dt>Returns</dt><dd>current thread flags.</dd></dl>
 320 <p>The function <b>osThreadFlagsGet</b> returns the flags currently set for the currently running thread. If called without a active and currently running thread <b>osThreadFlagsGet</b> return zero.</p>
 321 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 322
 323 </div>
 324 </div>
 325 <a id="gac11542ad6300b600f872fc96e340ec2b" name="gac11542ad6300b600f872fc96e340ec2b"></a>
 326 <h2 class="memtitle"><span class="permalink"><a href="#gac11542ad6300b600f872fc96e340ec2b">&#9670;&#160;</a></span>osThreadFlagsWait()</h2>
 327
 328 <div class="memitem">
 329 <div class="memproto">
 330       <table class="memname">
 331         <tr>
 332           <td class="memname">uint32_t osThreadFlagsWait </td>
 333           <td>(</td>
 334           <td class="paramtype">uint32_t&#160;</td>
 335           <td class="paramname"><em>flags</em>, </td>
 336         </tr>
 337         <tr>
 338           <td class="paramkey"></td>
 339           <td></td>
 340           <td class="paramtype">uint32_t&#160;</td>
 341           <td class="paramname"><em>options</em>, </td>
 342         </tr>
 343         <tr>
 344           <td class="paramkey"></td>
 345           <td></td>
 346           <td class="paramtype">uint32_t&#160;</td>
 347           <td class="paramname"><em>timeout</em>&#160;</td>
 348         </tr>
 349         <tr>
 350           <td></td>
 351           <td>)</td>
 352           <td></td><td></td>
 353         </tr>
 354       </table>
 355 </div><div class="memdoc">
 356
 357 <p>Wait for one or more Thread Flags of the current running thread to become signaled. </p>
 358 <dl class="params"><dt>Parameters</dt><dd>
 359   <table class="params">
 360     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags to wait for. </td></tr>
 361     <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>specifies flags options (osFlagsXxxx). </td></tr>
 362     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">Timeout Values</a> or 0 in case of no time-out. </td></tr>
 363   </table>
 364   </dd>
 365 </dl>
 366 <dl class="section return"><dt>Returns</dt><dd>thread flags before clearing or error code if highest bit set.</dd></dl>
 367 <p>The function <b>osThreadFlagsWait</b> suspends the execution of the currently <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">RUNNING</a> thread until any or all of the thread flags specified with the parameter <em>flags</em> are set. When these thread 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>
 368 <p>The parameter <em>options</em> specifies the wait condition: </p><table class="markdownTable">
 369 <tr class="markdownTableHead">
 370 <th class="markdownTableHeadNone">Option   </th><th class="markdownTableHeadNone"></th></tr>
 371 <tr class="markdownTableRowOdd">
 372 <td class="markdownTableBodyNone"><b>osFlagsWaitAny</b>   </td><td class="markdownTableBodyNone">Wait for any flag (default).    </td></tr>
 373 <tr class="markdownTableRowEven">
 374 <td class="markdownTableBodyNone"><b>osFlagsWaitAll</b>   </td><td class="markdownTableBodyNone">Wait for all flags.    </td></tr>
 375 <tr class="markdownTableRowOdd">
 376 <td class="markdownTableBodyNone"><b>osFlagsNoClear</b>   </td><td class="markdownTableBodyNone">Do not clear flags which have been specified to wait for.   </td></tr>
 377 </table>
 378 <p>If <code>osFlagsNoClear</code> is set in the options <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a> can be used to clear flags manually. Otherwise <b>osThreadFlagsWait</b> automatically clears the flags waited for.</p>
 379 <p>The parameter <a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">timeout</a> represents a number of timer ticks and is an upper bound. The exact time delay depends on the actual time elapsed since the last timer tick.</p>
 380 <p>The function returns the flags before clearing, or an error code if highest bit is set (refer to <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a>).</p>
 381 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 382 <li><em>osFlagsErrorUnknown:</em> unspecified error, i.e. not called from a running threads context.</li>
 383 <li><em>osFlagsErrorTimeout:</em> awaited flags have not been set in the given time.</li>
 384 <li><em>osFlagsErrorResource:</em> awaited flags have not been set when no <em>timeout</em> was specified.</li>
 385 <li><em>osFlagsErrorParameter:</em> Parameter <em>flags</em> has highest bit set.</li>
 386 </ul>
 387 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 388 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 389 <div class="line"> </div>
 390 <div class="line"><span class="keywordtype">void</span> Thread (<span class="keywordtype">void</span>* arg) {</div>
 391 <div class="line">  ;</div>
 392 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled.">osThreadFlagsWait</a>(0x00000001U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012" title="Wait for any flag (default).">osFlagsWaitAny</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb" title="Wait forever timeout value.">osWaitForever</a>); <span class="comment">// Wait forever until thread flag 1 is set.</span></div>
 393 <div class="line">  ;</div>
 394 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled.">osThreadFlagsWait</a>(0x00000003U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga18e63587b8450d5b8798b6f6ec04e012" title="Wait for any flag (default).">osFlagsWaitAny</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb" title="Wait forever timeout value.">osWaitForever</a>); <span class="comment">// Wait forever until either thread flag 0 or 1 is set.</span></div>
 395 <div class="line">  ;</div>
 396 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled.">osThreadFlagsWait</a>(0x00000003U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24" title="Wait for all flags.">osFlagsWaitAll</a>, 10U); <span class="comment">// Wait for 10 timer ticks until thread flags 0 and 1 are set. Timeout afterwards.</span></div>
 397 <div class="line">  ;</div>
 398 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b" title="Wait for one or more Thread Flags of the current running thread to become signaled.">osThreadFlagsWait</a>(0x00000003U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24" title="Wait for all flags.">osFlagsWaitAll</a> | <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#gaade844a42237d8c37569d4d9b16b9f1c" title="Do not clear flags which have been specified to wait for.">osFlagsNoClear</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb" title="Wait forever timeout value.">osWaitForever</a>); <span class="comment">// Same as the above, but the flags will not be cleared.</span></div>
 399 <div class="line">}</div>
 400 </div><!-- fragment -->
 401 </div>
 402 </div>
 403 </div><!-- contents -->
 404 </div><!-- doc-content -->
 405 <!-- start footer part -->
 406 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 407   <ul>
 408     <li class="footer">
 409       <script type="text/javascript">
 410         <!--
 411         writeFooter.call(this);
 412         //-->
 413       </script>
 414     </li>
 415   </ul>
 416 </div>
 417 </body>
 418 </html>