صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
ARM-software
/
CMSIS_5
mirrorاز https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: c5ff98f525
شاخه‌ها تگ‌ها
CMSIS_5
/
docs
/
RTOS
/
html
/
group__CMSIS__RTOS__SignalMgmt.html

group__CMSIS__RTOS__SignalMgmt.html 26 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Signal Events</title>
    7. 

  7. <title>CMSIS-RTOS: Signal Events</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-RTOS
    35. 

  35.    &#160;<span id="projectnumber">Version 1.03</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation.</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('group__CMSIS__RTOS__SignalMgmt.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
    101. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="summary">
    111. 

  111. <a href="#define-members">Macros</a> &#124;
    112. 

  112. <a href="#func-members">Functions</a>  </div>
    113. 

  113.   <div class="headertitle">
    114. 

  114. <div class="title">Signal Events<div class="ingroups"><a class="el" href="group__CMSIS__RTOS__InterThread.html">Inter-Thread Communication and Resource Sharing</a></div></div>  </div>
    115. 

  115. </div><!--header-->
    116. 

  116. <div class="contents">
    117. 

  117. 

  118. <p>Synchronize threads using signals.  
    119. 

  119. <a href="#details">More...</a></p>
    120. 

  120. <table class="memberdecls">
    121. 

  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
    122. 

  122. Macros</h2></td></tr>
    123. 

  123. <tr class="memitem:ga01edde265710d883b6e237d34a6ef4a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga01edde265710d883b6e237d34a6ef4a6">osFeature_Signals</a>&#160;&#160;&#160;8</td></tr>
    124. 

  124. <tr class="memdesc:ga01edde265710d883b6e237d34a6ef4a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">maximum number of Signal Flags available per thread  <a href="#ga01edde265710d883b6e237d34a6ef4a6">More...</a><br/></td></tr>
    125. 

  125. <tr class="separator:ga01edde265710d883b6e237d34a6ef4a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    126. 

  126. </table><table class="memberdecls">
    127. 

  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    128. 

  128. Functions</h2></td></tr>
    129. 

  129. <tr class="memitem:ga3de2730654589d6c3559c4b9e2825553"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga3de2730654589d6c3559c4b9e2825553">osSignalSet</a> (<a class="el" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> thread_id, int32_t signals)</td></tr>
    130. 

  130. <tr class="memdesc:ga3de2730654589d6c3559c4b9e2825553"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the specified Signal Flags of an active thread.  <a href="#ga3de2730654589d6c3559c4b9e2825553">More...</a><br/></td></tr>
    131. 

  131. <tr class="separator:ga3de2730654589d6c3559c4b9e2825553"><td class="memSeparator" colspan="2">&#160;</td></tr>
    132. 

  132. <tr class="memitem:ga87283a6ebc31ce9ed42baf3ea7e4eab6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga87283a6ebc31ce9ed42baf3ea7e4eab6">osSignalClear</a> (<a class="el" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> thread_id, int32_t signals)</td></tr>
    133. 

  133. <tr class="memdesc:ga87283a6ebc31ce9ed42baf3ea7e4eab6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the specified Signal Flags of an active thread.  <a href="#ga87283a6ebc31ce9ed42baf3ea7e4eab6">More...</a><br/></td></tr>
    134. 

  134. <tr class="separator:ga87283a6ebc31ce9ed42baf3ea7e4eab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    135. 

  135. <tr class="memitem:ga38860acda96df47da6923348d96fc4c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#structosEvent">osEvent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a> (int32_t signals, uint32_t millisec)</td></tr>
    136. 

  136. <tr class="memdesc:ga38860acda96df47da6923348d96fc4c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for one or more Signal Flags to become signaled for the current <b>RUNNING</b> thread.  <a href="#ga38860acda96df47da6923348d96fc4c9">More...</a><br/></td></tr>
    137. 

  137. <tr class="separator:ga38860acda96df47da6923348d96fc4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    138. 

  138. </table>
    139. 

  139. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    140. 

  140. <p>Signals are used to trigger execution states between threads. The signal management functions in CMSIS-RTOS allow you to control or wait for signal flags. Each thread has up to 31 assigned signal flags. The maximum number of signal flags is defined in the <a class="el" href="cmsis__os_8h.html">cmsis_os.h</a> file (<b>#define osFeature_Signals</b>).</p>
    141. 

  141. <p>A thread</p>
    142. 

  142. <ul>
    143. 

  143. <li>can wait for signals to be set (using <a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a>). Using this function, it enters the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">WAITING</a> state. The <a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a> parameter <em>signals</em> defines the signals that are required to put the thread back into <b>READY</b> state.</li>
    144. 

  144. <li>may set one or more flags in any other given thread (using <a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga3de2730654589d6c3559c4b9e2825553">osSignalSet</a>).</li>
    145. 

  145. <li>may clear its own signals or the signals of other threads (using <a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga87283a6ebc31ce9ed42baf3ea7e4eab6">osSignalClear</a>).</li>
    146. 

  146. </ul>
    147. 

  147. <p>When a thread wakes up and resumes execution, its signal flags are automatically cleared.</p>
    148. 

  148. <h2>Working with Signals </h2>
    149. 

  149. <p>Here is a simple example that shows how two thread can communicate with each others using signals:</p>
    150. 

  150. <div class="image">
    151. 

  151. <img src="simple_signal.png" alt="simple_signal.png"/>
    152. 

  152. <div class="caption">
    153. 

  153. Simple signal event communication</div></div>
    154. 

  154. <p> The following steps are required to use signals:</p>
    155. 

  155. <ol type="1">
    156. 

  156. <li>In the thread (for example thread ID <code>tid_thread1</code>) that is supposed to wait for a signal, call the wait function: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a> (0x0001, <a class="code" href="cmsis__os_8h.html#a9eb9a7a797a42e4b55eb171ecc609ddb">osWaitForever</a>); <span class="comment">// wait forever for the signal 0x0001</span></div>
    157. 

  157. </div><!-- fragment --></li>
    158. 

  158. <li>In another thread (or threads) that are supposed to wake the waiting thread up call: <div class="fragment"><div class="line"><a class="code" href="group__CMSIS__RTOS__SignalMgmt.html#ga3de2730654589d6c3559c4b9e2825553">osSignalSet</a> (tid_thread1, 0x0001);    <span class="comment">// set the signal 0x0001 for thread tid_thread1</span></div>
    159. 

  159. <div class="line"><a class="code" href="group__CMSIS__RTOS__Wait.html#ga02e19d5e723bfb06ba9324d625162255">osDelay</a> (1000);                       <span class="comment">// wait for 1 second</span></div>
    160. 

  160. </div><!-- fragment --> </li>
    161. 

  161. </ol>
    162. 

  162. <h2 class="groupheader">Macro Definition Documentation</h2>
    163. 

  163. <a class="anchor" id="ga01edde265710d883b6e237d34a6ef4a6"></a>
    164. 

  164. <div class="memitem">
    165. 

  165. <div class="memproto">
    166. 

  166.       <table class="memname">
    167. 

  167.         <tr>
    168. 

  168.           <td class="memname">#define osFeature_Signals&#160;&#160;&#160;8</td>
    169. 

  169.         </tr>
    170. 

  170.       </table>
    171. 

  171. </div><div class="memdoc">
    172. 

  172. <p>The CMSIS-RTOS API may support a variable number of signal flags. This define specifies the number of signal flags available per thread. The maximum value is 32 signal flags per thread.</p>
    173. 

  173. <p><a class="el" href="rtxImplementation.html">CMSIS-RTOS RTX</a> Setting: <b>osFeature_Signals</b> is 16 </p>
    174. 

  174. 

  175. </div>
    176. 

  176. </div>
    177. 

  177. <h2 class="groupheader">Function Documentation</h2>
    178. 

  178. <a class="anchor" id="ga87283a6ebc31ce9ed42baf3ea7e4eab6"></a>
    179. 

  179. <div class="memitem">
    180. 

  180. <div class="memproto">
    181. 

  181.       <table class="memname">
    182. 

  182.         <tr>
    183. 

  183.           <td class="memname">int32_t osSignalClear </td>
    184. 

  184.           <td>(</td>
    185. 

  185.           <td class="paramtype"><a class="el" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a>&#160;</td>
    186. 

  186.           <td class="paramname"><em>thread_id</em>, </td>
    187. 

  187.         </tr>
    188. 

  188.         <tr>
    189. 

  189.           <td class="paramkey"></td>
    190. 

  190.           <td></td>
    191. 

  191.           <td class="paramtype">int32_t&#160;</td>
    192. 

  192.           <td class="paramname"><em>signals</em>&#160;</td>
    193. 

  193.         </tr>
    194. 

  194.         <tr>
    195. 

  195.           <td></td>
    196. 

  196.           <td>)</td>
    197. 

  197.           <td></td><td></td>
    198. 

  198.         </tr>
    199. 

  199.       </table>
    200. 

  200. </div><div class="memdoc">
    201. 

  201. <dl class="params"><dt>Parameters</dt><dd>
    202. 

  202.   <table class="params">
    203. 

  203.     <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#gac59b5713cb083702dce759c73fd90dff">osThreadCreate</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gab1df2a28925862ef8f9cf4e1c995c5a7">osThreadGetId</a>. </td></tr>
    204. 

  204.     <tr><td class="paramdir">[in]</td><td class="paramname">signals</td><td>specifies the signal flags of the thread that shall be cleared. </td></tr>
    205. 

  205.   </table>
    206. 

  206.   </dd>
    207. 

  207. </dl>
    208. 

  208. <dl class="section return"><dt>Returns</dt><dd>previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters or call from ISR. </dd></dl>
    209. 

  209. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osSignalClear</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    210. 

  210. <p>Clear the signal flags of an active thread.</p>
    211. 

  211. <dl class="section note"><dt>Note</dt><dd>Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    212. 

  212. <p><b>Code Example</b> </p>
    213. 

  213. <div class="fragment"><div class="line"><span class="keywordtype">void</span> Thread_2 (<span class="keywordtype">void</span> <span class="keyword">const</span> *arg);</div>
    214. 

  214. <div class="line"></div>
    215. 

  215. <div class="line"><a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaee93d929beb350f16e5cc7fa602e229f">osThreadDef</a> (Thread_2, <a class="code" href="cmsis__os_8h.html#ga7f2b42f1983b9107775ec2a1c69a849aa914433934143a9ba767e59577c56e6c2">osPriorityHigh</a>, 1, 0);</div>
    216. 

  216. <div class="line"> </div>
    217. 

  217. <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> EX_Signal_1 (<span class="keywordtype">void</span>)  {</div>
    218. 

  218. <div class="line">  int32_t  signals;</div>
    219. 

  219. <div class="line">  <a class="code" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> thread_id;</div>
    220. 

  220. <div class="line">  </div>
    221. 

  221. <div class="line">  thread_id = <a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gac59b5713cb083702dce759c73fd90dff">osThreadCreate</a> (<a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaf0c7c6b5e09f8be198312144b5c9e453">osThread</a>(Thread_2), NULL);</div>
    222. 

  222. <div class="line">  <span class="keywordflow">if</span> (thread_id == NULL)  {</div>
    223. 

  223. <div class="line">    <span class="comment">// Failed to create a thread.</span></div>
    224. 

  224. <div class="line">  }</div>
    225. 

  225. <div class="line">  <span class="keywordflow">else</span>  {</div>
    226. 

  226. <div class="line">f    :</div>
    227. 

  227. <div class="line">    signals = <a class="code" href="group__CMSIS__RTOS__SignalMgmt.html#ga87283a6ebc31ce9ed42baf3ea7e4eab6">osSignalClear</a> (thread_id, 0x01);</div>
    228. 

  228. <div class="line">  }</div>
    229. 

  229. <div class="line">}</div>
    230. 

  230. </div><!-- fragment --> 
    231. 

  231. </div>
    232. 

  232. </div>
    233. 

  233. <a class="anchor" id="ga3de2730654589d6c3559c4b9e2825553"></a>
    234. 

  234. <div class="memitem">
    235. 

  235. <div class="memproto">
    236. 

  236.       <table class="memname">
    237. 

  237.         <tr>
    238. 

  238.           <td class="memname">int32_t osSignalSet </td>
    239. 

  239.           <td>(</td>
    240. 

  240.           <td class="paramtype"><a class="el" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a>&#160;</td>
    241. 

  241.           <td class="paramname"><em>thread_id</em>, </td>
    242. 

  242.         </tr>
    243. 

  243.         <tr>
    244. 

  244.           <td class="paramkey"></td>
    245. 

  245.           <td></td>
    246. 

  246.           <td class="paramtype">int32_t&#160;</td>
    247. 

  247.           <td class="paramname"><em>signals</em>&#160;</td>
    248. 

  248.         </tr>
    249. 

  249.         <tr>
    250. 

  250.           <td></td>
    251. 

  251.           <td>)</td>
    252. 

  252.           <td></td><td></td>
    253. 

  253.         </tr>
    254. 

  254.       </table>
    255. 

  255. </div><div class="memdoc">
    256. 

  256. <dl class="params"><dt>Parameters</dt><dd>
    257. 

  257.   <table class="params">
    258. 

  258.     <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#gac59b5713cb083702dce759c73fd90dff">osThreadCreate</a> or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#gab1df2a28925862ef8f9cf4e1c995c5a7">osThreadGetId</a>. </td></tr>
    259. 

  259.     <tr><td class="paramdir">[in]</td><td class="paramname">signals</td><td>specifies the signal flags of the thread that should be set. </td></tr>
    260. 

  260.   </table>
    261. 

  261.   </dd>
    262. 

  262. </dl>
    263. 

  263. <dl class="section return"><dt>Returns</dt><dd>previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters. </dd></dl>
    264. 

  264. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osSignalSet</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    265. 

  265. <p>Set the signal flags of an active thread. This function may be used also within interrupt service routines.</p>
    266. 

  266. <dl class="section note"><dt>Note</dt><dd><a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> can call this function.</dd></dl>
    267. 

  267. <p><b>Code Example</b> </p>
    268. 

  268. <div class="fragment"><div class="line"><span class="keywordtype">void</span> Thread_2 (<span class="keywordtype">void</span> <span class="keyword">const</span> *arg);</div>
    269. 

  269. <div class="line"> </div>
    270. 

  270. <div class="line"><a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaee93d929beb350f16e5cc7fa602e229f">osThreadDef</a> (Thread_2, <a class="code" href="cmsis__os_8h.html#ga7f2b42f1983b9107775ec2a1c69a849aa914433934143a9ba767e59577c56e6c2">osPriorityHigh</a>, 1, 0);</div>
    271. 

  271. <div class="line"> </div>
    272. 

  272. <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> EX_Signal_1 (<span class="keywordtype">void</span>)  {</div>
    273. 

  273. <div class="line">  int32_t signals;</div>
    274. 

  274. <div class="line">  uint32_t exec;</div>
    275. 

  275. <div class="line">  <a class="code" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> thread_id;</div>
    276. 

  276. <div class="line">  </div>
    277. 

  277. <div class="line">  thread_id = <a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gac59b5713cb083702dce759c73fd90dff">osThreadCreate</a> (<a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaf0c7c6b5e09f8be198312144b5c9e453">osThread</a>(Thread_2), NULL);</div>
    278. 

  278. <div class="line">  <span class="keywordflow">if</span> (thread_id == NULL)  {</div>
    279. 

  279. <div class="line">    <span class="comment">// Failed to create a thread.</span></div>
    280. 

  280. <div class="line">  }</div>
    281. 

  281. <div class="line">  <span class="keywordflow">else</span>  {</div>
    282. 

  282. <div class="line">    signals = <a class="code" href="group__CMSIS__RTOS__SignalMgmt.html#ga3de2730654589d6c3559c4b9e2825553">osSignalSet</a> (thread_id, 0x00000005);         <span class="comment">// Send signals to the created thread</span></div>
    283. 

  283. <div class="line">  }</div>
    284. 

  284. <div class="line">}</div>
    285. 

  285. </div><!-- fragment --> 
    286. 

  286. </div>
    287. 

  287. </div>
    288. 

  288. <a class="anchor" id="ga38860acda96df47da6923348d96fc4c9"></a>
    289. 

  289. <div class="memitem">
    290. 

  290. <div class="memproto">
    291. 

  291.       <table class="memname">
    292. 

  292.         <tr>
    293. 

  293.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#structosEvent">osEvent</a> osSignalWait </td>
    294. 

  294.           <td>(</td>
    295. 

  295.           <td class="paramtype">int32_t&#160;</td>
    296. 

  296.           <td class="paramname"><em>signals</em>, </td>
    297. 

  297.         </tr>
    298. 

  298.         <tr>
    299. 

  299.           <td class="paramkey"></td>
    300. 

  300.           <td></td>
    301. 

  301.           <td class="paramtype">uint32_t&#160;</td>
    302. 

  302.           <td class="paramname"><em>millisec</em>&#160;</td>
    303. 

  303.         </tr>
    304. 

  304.         <tr>
    305. 

  305.           <td></td>
    306. 

  306.           <td>)</td>
    307. 

  307.           <td></td><td></td>
    308. 

  308.         </tr>
    309. 

  309.       </table>
    310. 

  310. </div><div class="memdoc">
    311. 

  311. <dl class="params"><dt>Parameters</dt><dd>
    312. 

  312.   <table class="params">
    313. 

  313.     <tr><td class="paramdir">[in]</td><td class="paramname">signals</td><td>wait until all specified signal flags set or 0 for any single signal flag. </td></tr>
    314. 

  314.     <tr><td class="paramdir">[in]</td><td class="paramname">millisec</td><td><a class="el" href="functionOverview.html#CMSIS_RTOS_TimeOutValue">Timout Value</a> or 0 in case of no time-out. </td></tr>
    315. 

  315.   </table>
    316. 

  316.   </dd>
    317. 

  317. </dl>
    318. 

  318. <dl class="section return"><dt>Returns</dt><dd>event flag information or error code. </dd></dl>
    319. 

  319. <dl class="section note"><dt>Note</dt><dd>MUST REMAIN UNCHANGED: <b>osSignalWait</b> shall be consistent in every CMSIS-RTOS.</dd></dl>
    320. 

  320. <p>Suspend the execution of the current <b>RUNNING</b> thread until all specified signal flags with the parameter <em>signals</em> are set. When the parameter <em>signals</em> is 0 the current <b>RUNNING</b> thread is suspended until any signal is set. When these signal flags are already set, the function returns instantly. Otherwise the thread is put into the state <b>WAITING</b>. Signal flags that are reported as event are automatically cleared.</p>
    321. 

  321. <p>The argument <em>millisec</em> specifies how long the system waits for the specified signal flags. While the system waits the thread calling this function is put into the state <b>WAITING</b>. The timeout value can have the following values:</p>
    322. 

  322. <ul>
    323. 

  323. <li>when <em>millisec</em> is 0, the function returns instantly.</li>
    324. 

  324. <li>when <em>millisec</em> is set to <b>osWaitForever</b> the function will wait for an infinite time until a specified signal is set.</li>
    325. 

  325. <li>all other values specify a time in millisecond for a timeout.</li>
    326. 

  326. </ul>
    327. 

  327. <p><b><a class="el" href="group__CMSIS__RTOS__Status.html">Status and Error Codes</a></b><br/>
    328. 

  328. </p>
    329. 

  329. <ul>
    330. 

  330. <li><em>osOK:</em> no signal received when the timeout value <em>millisec</em> was 0.</li>
    331. 

  331. <li><em>osEventTimeout:</em> signal not occurred within timeout</li>
    332. 

  332. <li><em>osEventSignal:</em> signal occurred, <em>value.signals</em> contains the signal flags; these signal flags are cleared.</li>
    333. 

  333. <li><em>osErrorValue:</em> the value <em>signals</em> is outside of the permitted range.</li>
    334. 

  334. <li><em>osErrorISR:</em> <a class="el" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a> cannot be called from interrupt service routines.</li>
    335. 

  335. </ul>
    336. 

  336. <dl class="section note"><dt>Note</dt><dd>Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    337. 

  337. <p><b>Code Example</b> </p>
    338. 

  338. <div class="fragment"><div class="line"><span class="keywordtype">void</span> Thread_2 (<span class="keywordtype">void</span> <span class="keyword">const</span> *arg);</div>
    339. 

  339. <div class="line">  </div>
    340. 

  340. <div class="line"><a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaee93d929beb350f16e5cc7fa602e229f">osThreadDef</a> (Thread_2, <a class="code" href="cmsis__os_8h.html#ga7f2b42f1983b9107775ec2a1c69a849aa914433934143a9ba767e59577c56e6c2">osPriorityHigh</a>, 1, 0);</div>
    341. 

  341. <div class="line">   </div>
    342. 

  342. <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> EX_Signal_1 (<span class="keywordtype">void</span>)  {</div>
    343. 

  343. <div class="line">  <a class="code" href="cmsis__os_8h.html#adfeb153a84a81309e2d958268197617f">osThreadId</a> thread_id;</div>
    344. 

  344. <div class="line">  <a class="code" href="group__CMSIS__RTOS__Definitions.html#structosEvent">osEvent</a> evt;</div>
    345. 

  345. <div class="line">    </div>
    346. 

  346. <div class="line">  thread_id = <a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gac59b5713cb083702dce759c73fd90dff">osThreadCreate</a> (<a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#gaf0c7c6b5e09f8be198312144b5c9e453">osThread</a>(Thread_2), NULL);</div>
    347. 

  347. <div class="line">  <span class="keywordflow">if</span> (thread_id == NULL)  {</div>
    348. 

  348. <div class="line">    <span class="comment">// Failed to create a thread.</span></div>
    349. 

  349. <div class="line">  }</div>
    350. 

  350. <div class="line">  <span class="keywordflow">else</span>  {</div>
    351. 

  351. <div class="line">    :</div>
    352. 

  352. <div class="line">    <span class="comment">// wait for a signal</span></div>
    353. 

  353. <div class="line">    evt = <a class="code" href="group__CMSIS__RTOS__SignalMgmt.html#ga38860acda96df47da6923348d96fc4c9">osSignalWait</a> (0x01, 100);</div>
    354. 

  354. <div class="line">    <span class="keywordflow">if</span> (evt.<a class="code" href="group__CMSIS__RTOS__Definitions.html#ad477a289f1f03ac45407b64268d707d3">status</a> == <a class="code" href="group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99ea5df7e9643aa8a2f5f3a6f6ec59758518">osEventSignal</a>)  {</div>
    355. 

  355. <div class="line">          <span class="comment">// handle event status</span></div>
    356. 

  356. <div class="line">    }</div>
    357. 

  357. <div class="line">  }</div>
    358. 

  358. <div class="line">}</div>
    359. 

  359. </div><!-- fragment --> 
    360. 

  360. </div>
    361. 

  361. </div>
    362. 

  362. </div><!-- contents -->
    363. 

  363. </div><!-- doc-content -->
    364. 

  364. <!-- start footer part -->
    365. 

  365. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    366. 

  366.   <ul>
    367. 

  367.     <li class="footer">Generated on Thu Apr 9 2020 15:49:56 for CMSIS-RTOS Version 1.03 by Arm Ltd. All rights reserved.
    368. 

  368. 	<!--
    369. 

  369.     <a href="http://www.doxygen.org/index.html">
    370. 

  370.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    371. 

  371. 	-->
    372. 

  372. 	</li>
    373. 

  373.   </ul>
    374. 

  374. </div>
    375. 

  375. </body>
    376. 

  376. </html>
    377.