begriffs open source - cmsis/blob - main/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, "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 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__ThreadFlagsMgmt.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#func-members">Functions</a>  </div>
 129   <div class="headertitle"><div class="title">Thread Flags<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>Synchronize threads using flags.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 137 Functions</h2></td></tr>
 138 <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>
 139 <tr class="memdesc:ga6f89ef9caded1d9963c7b12b0f6412c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the specified Thread Flags of a thread.  <br /></td></tr>
 140 <tr class="separator:ga6f89ef9caded1d9963c7b12b0f6412c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <tr class="memdesc:ga656abc1c862c5b9a2b13584c42cc0bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the specified Thread Flags of current running thread.  <br /></td></tr>
 143 <tr class="separator:ga656abc1c862c5b9a2b13584c42cc0bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:ga85c8d2c89466e25abbcb545d9ddd71ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current Thread Flags of current running thread.  <br /></td></tr>
 146 <tr class="separator:ga85c8d2c89466e25abbcb545d9ddd71ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <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>
 149 <tr class="separator:gac11542ad6300b600f872fc96e340ec2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 152 <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>
 153 <dl class="section note"><dt>Note</dt><dd>Thread flag management functions cannot be called from Interrupt Service Routines, except for <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>.</dd></dl>
 154 <p><b>Usage Example</b></p>
 155 <p>The following (incomplete) code excerpt sketches the usage principals for <b>Thread Flags</b>.</p>
 156 <p>The behavior is the following:</p><ul>
 157 <li>app_main starts executing</li>
 158 <li>statement A sets thread flags to 0x02 (flags = 0x02 – after set)</li>
 159 <li>app_main enters delay</li>
 160 <li>execution switches to threadX</li>
 161 <li>statement B waits for flag 0x01 and blocks since flag is not set</li>
 162 <li>execution switches to app_main</li>
 163 <li>statement C sets thread flags to 0x07</li>
 164 <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>
 165 <li>statement C returns with flags = 0x06</li>
 166 <li>app_main enters delay</li>
 167 <li>execution switches to threadX</li>
 168 <li>statement B returns with flagsX = 0x07</li>
 169 </ul>
 170 <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></div>
 171 <div class="line"> </div>
 172 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid;</div>
 173 <div class="line">uint32_t     flagsX;</div>
 174 <div class="line">uint32_t     flags;</div>
 175 <div class="line"> </div>
 176 <div class="line"><span class="keywordtype">void</span> threadX (<span class="keywordtype">void</span> *argument) {</div>
 177 <div class="line">  </div>
 178 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(1U);</div>
 179 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 180 <div class="line">    flagsX = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a>(0x0001U, <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>); <span class="comment">/* B */</span></div>
 181 <div class="line">  }</div>
 182 <div class="line">}</div>
 183 <div class="line"> </div>
 184 <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
 185 <div class="line"> </div>
 186 <div class="line">  tid = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(threadX, NULL, NULL);</div>
 187 <div class="line"> </div>
 188 <div class="line">  flags = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>(tid, 0x0002U); <span class="comment">/* A */</span></div>
 189 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(2U);</div>
 190 <div class="line">  flags = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>(tid, 0x0005U); <span class="comment">/* C */</span></div>
 191 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(2U);</div>
 192 <div class="line"> </div>
 193 <div class="line">  <span class="keywordflow">for</span>(;;);</div>
 194 <div class="line">}</div>
 195 <div class="ttc" id="acmsis__os2_8h_html"><div class="ttname"><a href="cmsis__os2_8h.html">cmsis_os2.h</a></div></div>
 196 <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>
 197 <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>
 198 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadFlagsMgmt_html_ga6f89ef9caded1d9963c7b12b0f6412c9"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></div><div class="ttdeci">uint32_t osThreadFlagsSet(osThreadId_t thread_id, uint32_t flags)</div><div class="ttdoc">Set the specified Thread Flags of a thread.</div></div>
 199 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadFlagsMgmt_html_gac11542ad6300b600f872fc96e340ec2b"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></div><div class="ttdeci">uint32_t osThreadFlagsWait(uint32_t flags, uint32_t options, uint32_t timeout)</div><div class="ttdoc">Wait for one or more Thread Flags of the current running thread to become signaled.</div></div>
 200 <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>
 201 <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>
 202 <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>
 203 </div><!-- fragment --> <h2 class="groupheader">Function Documentation</h2>
 204 <a id="ga6f89ef9caded1d9963c7b12b0f6412c9" name="ga6f89ef9caded1d9963c7b12b0f6412c9"></a>
 205 <h2 class="memtitle"><span class="permalink"><a href="#ga6f89ef9caded1d9963c7b12b0f6412c9">&#9670;&#160;</a></span>osThreadFlagsSet()</h2>
 206
 207 <div class="memitem">
 208 <div class="memproto">
 209       <table class="memname">
 210         <tr>
 211           <td class="memname">uint32_t osThreadFlagsSet </td>
 212           <td>(</td>
 213           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a>&#160;</td>
 214           <td class="paramname"><em>thread_id</em>, </td>
 215         </tr>
 216         <tr>
 217           <td class="paramkey"></td>
 218           <td></td>
 219           <td class="paramtype">uint32_t&#160;</td>
 220           <td class="paramname"><em>flags</em>&#160;</td>
 221         </tr>
 222         <tr>
 223           <td></td>
 224           <td>)</td>
 225           <td></td><td></td>
 226         </tr>
 227       </table>
 228 </div><div class="memdoc">
 229 <dl class="params"><dt>Parameters</dt><dd>
 230   <table class="params">
 231     <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>
 232     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags of the thread that shall be set. </td></tr>
 233   </table>
 234   </dd>
 235 </dl>
 236 <dl class="section return"><dt>Returns</dt><dd>thread flags after setting or error code if highest bit set.</dd></dl>
 237 <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>
 238 <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>
 239 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 240 <li><em>osFlagsErrorUnknown:</em> unspecified error.</li>
 241 <li><em>osFlagsErrorParameter:</em> parameter <em>thread_id</em> is not a valid thread or <em>flags</em> has highest bit set.</li>
 242 <li><em>osFlagsErrorResource:</em> the thread is in invalid state.</li>
 243 <li><em>osFlagsErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified thread.</li>
 244 </ul>
 245 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines.</dd></dl>
 246 <p><b>Code</b> <b>Example</b> </p><div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 247 <div class="line"><span class="comment"> *      Function &#39;signal_func&#39; called from multiple threads</span></div>
 248 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 249 <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>
 250 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">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">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">osThreadFlagsSet</a>(tid_clock, 0x0100U);     <span class="comment">/* set signal to clock thread    */</span></div>
 253 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(500U);                            <span class="comment">/* delay 500ms                   */</span></div>
 254 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a>(tid, 0x0001U);           <span class="comment">/* set signal to thread &#39;thread&#39; */</span></div>
 255 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#gaf6055a51390ef65b6b6edc28bf47322e">osDelay</a>(500U);                            <span class="comment">/* delay 500ms                   */</span></div>
 256 <div class="line">}</div>
 257 </div><!-- fragment --><p><b>Usage</b> <b>Examples</b> </p>
 258 <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>
 259 <div class="mscgraph">
 260 <img src="msc_inline_mscgraph_1.png" alt="msc_inline_mscgraph_1" border="0"/>
 261 </div>
 262 <p>Depending on thread scheduling, the flag status can be modified before returning:</p>
 263 <div class="mscgraph">
 264 <img src="msc_inline_mscgraph_2.png" alt="msc_inline_mscgraph_2" border="0"/>
 265 </div>
 266  <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>
 267
 268 </div>
 269 </div>
 270 <a id="ga656abc1c862c5b9a2b13584c42cc0bfa" name="ga656abc1c862c5b9a2b13584c42cc0bfa"></a>
 271 <h2 class="memtitle"><span class="permalink"><a href="#ga656abc1c862c5b9a2b13584c42cc0bfa">&#9670;&#160;</a></span>osThreadFlagsClear()</h2>
 272
 273 <div class="memitem">
 274 <div class="memproto">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">uint32_t osThreadFlagsClear </td>
 278           <td>(</td>
 279           <td class="paramtype">uint32_t&#160;</td>
 280           <td class="paramname"><em>flags</em></td><td>)</td>
 281           <td></td>
 282         </tr>
 283       </table>
 284 </div><div class="memdoc">
 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 Interrupt Service Routines. </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 <dl class="section return"><dt>Returns</dt><dd>current thread flags.</dd></dl>
 318 <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>
 319 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines. </dd></dl>
 320
 321 </div>
 322 </div>
 323 <a id="gac11542ad6300b600f872fc96e340ec2b" name="gac11542ad6300b600f872fc96e340ec2b"></a>
 324 <h2 class="memtitle"><span class="permalink"><a href="#gac11542ad6300b600f872fc96e340ec2b">&#9670;&#160;</a></span>osThreadFlagsWait()</h2>
 325
 326 <div class="memitem">
 327 <div class="memproto">
 328       <table class="memname">
 329         <tr>
 330           <td class="memname">uint32_t osThreadFlagsWait </td>
 331           <td>(</td>
 332           <td class="paramtype">uint32_t&#160;</td>
 333           <td class="paramname"><em>flags</em>, </td>
 334         </tr>
 335         <tr>
 336           <td class="paramkey"></td>
 337           <td></td>
 338           <td class="paramtype">uint32_t&#160;</td>
 339           <td class="paramname"><em>options</em>, </td>
 340         </tr>
 341         <tr>
 342           <td class="paramkey"></td>
 343           <td></td>
 344           <td class="paramtype">uint32_t&#160;</td>
 345           <td class="paramname"><em>timeout</em>&#160;</td>
 346         </tr>
 347         <tr>
 348           <td></td>
 349           <td>)</td>
 350           <td></td><td></td>
 351         </tr>
 352       </table>
 353 </div><div class="memdoc">
 354 <dl class="params"><dt>Parameters</dt><dd>
 355   <table class="params">
 356     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>specifies the flags to wait for. </td></tr>
 357     <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>specifies flags options (osFlagsXxxx). </td></tr>
 358     <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>
 359   </table>
 360   </dd>
 361 </dl>
 362 <dl class="section return"><dt>Returns</dt><dd>thread flags before clearing or error code if highest bit set.</dd></dl>
 363 <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>
 364 <p>The parameter <em>options</em> specifies the wait condition: </p><table class="markdownTable">
 365 <tr class="markdownTableHead">
 366 <th class="markdownTableHeadNone">Option   </th><th class="markdownTableHeadNone"></th></tr>
 367 <tr class="markdownTableRowOdd">
 368 <td class="markdownTableBodyNone"><b>osFlagsWaitAny</b>   </td><td class="markdownTableBodyNone">Wait for any flag (default).    </td></tr>
 369 <tr class="markdownTableRowEven">
 370 <td class="markdownTableBodyNone"><b>osFlagsWaitAll</b>   </td><td class="markdownTableBodyNone">Wait for all flags.    </td></tr>
 371 <tr class="markdownTableRowOdd">
 372 <td class="markdownTableBodyNone"><b>osFlagsNoClear</b>   </td><td class="markdownTableBodyNone">Do not clear flags which have been specified to wait for.   </td></tr>
 373 </table>
 374 <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>
 375 <p>The parameter timeout 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>
 376 <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>
 377 <p>Possible <a class="el" href="group__flags__error__codes.html">Flags Functions Error Codes</a> return values:</p><ul>
 378 <li><em>osFlagsErrorUnknown:</em> unspecified error, i.e. not called from a running threads context.</li>
 379 <li><em>osFlagsErrorTimeout:</em> awaited flags have not been set in the given time.</li>
 380 <li><em>osFlagsErrorResource:</em> awaited flags have not been set when no <em>timeout</em> was specified.</li>
 381 <li><em>osFlagsErrorParameter:</em> Parameter <em>flags</em> has highest bit set.</li>
 382 </ul>
 383 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines.</dd></dl>
 384 <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></div>
 385 <div class="line"> </div>
 386 <div class="line"><span class="keywordtype">void</span> Thread (<span class="keywordtype">void</span>* arg) {</div>
 387 <div class="line">  ;</div>
 388 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a>(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>); <span class="comment">// Wait forever until thread flag 1 is set.</span></div>
 389 <div class="line">  ;</div>
 390 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a>(0x00000003U, <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>); <span class="comment">// Wait forever until either thread flag 0 or 1 is set.</span></div>
 391 <div class="line">  ;</div>
 392 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a>(0x00000003U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24">osFlagsWaitAll</a>, 10U); <span class="comment">// Wait for 10 timer ticks until thread flags 0 and 1 are set. Timeout afterwards.</span></div>
 393 <div class="line">  ;</div>
 394 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a>(0x00000003U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24">osFlagsWaitAll</a> | <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#gaade844a42237d8c37569d4d9b16b9f1c">osFlagsNoClear</a>, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>); <span class="comment">// Same as the above, but the flags will not be cleared.</span></div>
 395 <div class="line">}</div>
 396 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_ga8b6f562736fbfb5428940e0c017dec24"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#ga8b6f562736fbfb5428940e0c017dec24">osFlagsWaitAll</a></div><div class="ttdeci">#define osFlagsWaitAll</div><div class="ttdoc">Wait for all flags.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:197</div></div>
 397 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_gaade844a42237d8c37569d4d9b16b9f1c"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#gaade844a42237d8c37569d4d9b16b9f1c">osFlagsNoClear</a></div><div class="ttdeci">#define osFlagsNoClear</div><div class="ttdoc">Do not clear flags which have been specified to wait for.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:198</div></div>
 398 </div><!-- fragment -->
 399 </div>
 400 </div>
 401 </div><!-- contents -->
 402 </div><!-- doc-content -->
 403 <!-- start footer part -->
 404 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 405   <ul>
 406     <li class="footer">
 407       <script type="text/javascript">
 408         <!--
 409         writeFooter.call(this);
 410         //-->
 411       </script>
 412     </li>
 413   </ul>
 414 </div>
 415 </body>
 416 </html>