Ana Sayfa Keşfet Yardım
Giriş Yap
ARM-software
/
CMSIS_5
şunun yansıması https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Çatalla 0
Dosyalar Sorunlar 0 Wiki
Ağaç: a82c293bfb
Dallar Biçim İmleri
CMSIS_5
/
docs
/
RTOS
/
html
/
group__RTX__Global__Functions.html

group__RTX__Global__Functions.html 32 KB
Geçmiş Ham

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468 
  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>RTX Specific Functions</title>
    7. 

  7. <title>CMSIS-RTOS: RTX Specific Functions</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__RTX__Global__Functions.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="#func-members">Functions</a>  </div>
    112. 

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

  113. <div class="title">RTX Specific Functions</div>  </div>
    114. 

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

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

  116. 

  117. <p>This section describes the functions that are specific to CMSIS-RTOS RTX.  
    118. 

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

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

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

  121. Functions</h2></td></tr>
    122. 

  122. <tr class="memitem:gafb4dc4d3dff8343a393726d2860282e4"><td class="memItemLeft" align="right" valign="top">__NO_RETURN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#gafb4dc4d3dff8343a393726d2860282e4">os_idle_demon</a> (void)</td></tr>
    123. 

  123. <tr class="memdesc:gafb4dc4d3dff8343a393726d2860282e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">OS idle demon (running when no other thread is ready to run).  <a href="#gafb4dc4d3dff8343a393726d2860282e4">More...</a><br/></td></tr>
    124. 

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

  125. <tr class="memitem:ga145e7eafdd042bb522020cbb3b469d9c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga145e7eafdd042bb522020cbb3b469d9c">os_tick_init</a> (void)</td></tr>
    126. 

  126. <tr class="memdesc:ga145e7eafdd042bb522020cbb3b469d9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an alternative hardware timer as RTX kernel timer.  <a href="#ga145e7eafdd042bb522020cbb3b469d9c">More...</a><br/></td></tr>
    127. 

  127. <tr class="separator:ga145e7eafdd042bb522020cbb3b469d9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    128. 

  128. <tr class="memitem:ga567543bf38239a91f09751686c23017b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga567543bf38239a91f09751686c23017b">os_tick_val</a> (void)</td></tr>
    129. 

  129. <tr class="memdesc:ga567543bf38239a91f09751686c23017b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get alternative hardware timer's current value (0 .. OS_TRV)  <a href="#ga567543bf38239a91f09751686c23017b">More...</a><br/></td></tr>
    130. 

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

  131. <tr class="memitem:gad5deddec3fea0fb31798f571afc3c692"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#gad5deddec3fea0fb31798f571afc3c692">os_tick_ovf</a> (void)</td></tr>
    132. 

  132. <tr class="memdesc:gad5deddec3fea0fb31798f571afc3c692"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get alternative hardware timer's overflow flag.  <a href="#gad5deddec3fea0fb31798f571afc3c692">More...</a><br/></td></tr>
    133. 

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

  134. <tr class="memitem:ga85dab8408f27236c7341a69feb6258c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga85dab8408f27236c7341a69feb6258c7">os_tick_irqack</a> (void)</td></tr>
    135. 

  135. <tr class="memdesc:ga85dab8408f27236c7341a69feb6258c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acknowledge alternative hardware timer interrupt.  <a href="#ga85dab8408f27236c7341a69feb6258c7">More...</a><br/></td></tr>
    136. 

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

  137. <tr class="memitem:ga651ae76b3acf45f80bf0e0487b51d6e6"><td class="memItemLeft" align="right" valign="top">__NO_RETURN void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga651ae76b3acf45f80bf0e0487b51d6e6">os_error</a> (uint32_t error_code)</td></tr>
    138. 

  138. <tr class="memdesc:ga651ae76b3acf45f80bf0e0487b51d6e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">OS error callback (called when a runtime error is detected).  <a href="#ga651ae76b3acf45f80bf0e0487b51d6e6">More...</a><br/></td></tr>
    139. 

  139. <tr class="separator:ga651ae76b3acf45f80bf0e0487b51d6e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    140. 

  140. <tr class="memitem:ga3e9c57746ccbdfe90464ad50513c569e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga3e9c57746ccbdfe90464ad50513c569e">os_suspend</a> (void)</td></tr>
    141. 

  141. <tr class="memdesc:ga3e9c57746ccbdfe90464ad50513c569e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the RTX task scheduler.  <a href="#ga3e9c57746ccbdfe90464ad50513c569e">More...</a><br/></td></tr>
    142. 

  142. <tr class="separator:ga3e9c57746ccbdfe90464ad50513c569e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143. 

  143. <tr class="memitem:ga1b85a217d43e6b971ffcf24f8aae1c33"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RTX__Global__Functions.html#ga1b85a217d43e6b971ffcf24f8aae1c33">os_resume</a> (uint32_t sleep_time)</td></tr>
    144. 

  144. <tr class="memdesc:ga1b85a217d43e6b971ffcf24f8aae1c33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume the RTX task scheduler.  <a href="#ga1b85a217d43e6b971ffcf24f8aae1c33">More...</a><br/></td></tr>
    145. 

  145. <tr class="separator:ga1b85a217d43e6b971ffcf24f8aae1c33"><td class="memSeparator" colspan="2">&#160;</td></tr>
    146. 

  146. </table>
    147. 

  147. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    148. 

  148. <p>The RTX kernel can be customized for different application requirements:</p>
    149. 

  149. <ul>
    150. 

  150. <li>If you are depending on the <a class="el" href="lowPower.html">lowest power consumption</a> possible, you need to adapt the function <a class="el" href="group__RTX__Global__Functions.html#gafb4dc4d3dff8343a393726d2860282e4">os_idle_demon</a> to send the system to sleep mode as often as possible. In addition, use the <a class="el" href="lowPower.html#TickLess">low power RTX extensions</a> <a class="el" href="group__RTX__Global__Functions.html#ga3e9c57746ccbdfe90464ad50513c569e">os_suspend</a> and <a class="el" href="group__RTX__Global__Functions.html#ga1b85a217d43e6b971ffcf24f8aae1c33">os_resume</a> to suspend the RTX scheduler and to stop the SysTick timer.</li>
    151. 

  151. <li>If you need to specify an <a class="el" href="timerTick.html#AltTimer">alternate hardware timer</a> as the system tick timer, you need to<ol type="1">
    152. 

  152. <li>implement the functions <a class="el" href="group__RTX__Global__Functions.html#ga145e7eafdd042bb522020cbb3b469d9c">os_tick_init</a>, <a class="el" href="group__RTX__Global__Functions.html#gad5deddec3fea0fb31798f571afc3c692">os_tick_ovf</a>, <a class="el" href="group__RTX__Global__Functions.html#ga567543bf38239a91f09751686c23017b">os_tick_val</a>, and optionally the function <a class="el" href="group__RTX__Global__Functions.html#ga85dab8408f27236c7341a69feb6258c7">os_tick_irqack</a>.</li>
    153. 

  153. <li>replace the alternate timer interrupt vector with the <a class="el" href="timerTick.html#OS_Tick_Handler">OS_Tick_Handler</a> in the Interrupt Vector Table in startup file.</li>
    154. 

  154. </ol>
    155. 

  155. </li>
    156. 

  156. <li>If you try to find a <b>runtime</b> <b>error</b>, use the function <a class="el" href="group__RTX__Global__Functions.html#ga651ae76b3acf45f80bf0e0487b51d6e6">os_error</a> to debug the error. </li>
    157. 

  157. </ul>
    158. 

  158. <h2 class="groupheader">Function Documentation</h2>
    159. 

  159. <a class="anchor" id="ga651ae76b3acf45f80bf0e0487b51d6e6"></a>
    160. 

  160. <div class="memitem">
    161. 

  161. <div class="memproto">
    162. 

  162.       <table class="memname">
    163. 

  163.         <tr>
    164. 

  164.           <td class="memname">void os_error </td>
    165. 

  165.           <td>(</td>
    166. 

  166.           <td class="paramtype">uint32_t&#160;</td>
    167. 

  167.           <td class="paramname"><em>error_code</em></td><td>)</td>
    168. 

  168.           <td></td>
    169. 

  169.         </tr>
    170. 

  170.       </table>
    171. 

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

  172. <dl class="params"><dt>Parameters</dt><dd>
    173. 

  173.   <table class="params">
    174. 

  174.     <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>actual error code that has been detected.</td></tr>
    175. 

  175.   </table>
    176. 

  176.   </dd>
    177. 

  177. </dl>
    178. 

  178. <p>Some system error conditions can be detected during runtime. If the RTX kernel detects a runtime error, it calls the runtime error function <b>os_error</b>.</p>
    179. 

  179. <p>The argument <em>error_code</em> passes the actual error code to this function:</p>
    180. 

  180. <table class="doxtable">
    181. 

  181. <tr>
    182. 

  182. <th>Error Code </th><th>Description  </th></tr>
    183. 

  183. <tr>
    184. 

  184. <td>OS_ERROR_STACK_OVF</td><td>The stack checking has detected a stack overflow for the currently running thread. </td></tr>
    185. 

  185. <tr>
    186. 

  186. <td>OS_ERROR_FIFO_OVF </td><td>The ISR FIFO Queue buffer overflow is detected. </td></tr>
    187. 

  187. <tr>
    188. 

  188. <td>OS_ERROR_MBX_OVF </td><td>A mailbox overflow is detected for the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac0dcf462fc92de8ffaba6cc004514a6d">osMessagePut</a> or <a class="el" href="group__CMSIS__RTOS__Mail.html#ga485ef6f81854ebda8ffbce4832181e02">osMailPut</a>. </td></tr>
    189. 

  189. <tr>
    190. 

  190. <td>OS_ERROR_TIMER_OVF</td><td>The User Timer Callback Queue overflow is detected. </td></tr>
    191. 

  191. </table>
    192. 

  192. <p>The function <b>os_error</b> must contain an infinite loop to prevent further program execution. You can use an emulator to step over infinite loop and trace into the code introducing a runtime error. For the overflow errors this means you need to increase the size of the object causing an overflow.</p>
    193. 

  193. <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>
    194. 

  194. <p><b>Code</b> <b>Example</b> </p>
    195. 

  195. <div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#ga651ae76b3acf45f80bf0e0487b51d6e6">os_error</a> (uint32_t error_code) {</div>
    196. 

  196. <div class="line"> </div>
    197. 

  197. <div class="line">  <span class="comment">// HERE: include optional code to be executed on runtime error. </span></div>
    198. 

  198. <div class="line">  <span class="keywordflow">switch</span> (error_code) {</div>
    199. 

  199. <div class="line"> </div>
    200. 

  200. <div class="line">    <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#abf8311a7a239ec56c6d725f926ba766d">OS_ERROR_STACK_OVF</a>:</div>
    201. 

  201. <div class="line">      <span class="comment">// Stack overflow detected for the currently running task. </span></div>
    202. 

  202. <div class="line">      <span class="comment">// Thread can be identified by calling svcThreadGetId().   </span></div>
    203. 

  203. <div class="line">      <span class="keywordflow">break</span>;</div>
    204. 

  204. <div class="line"> </div>
    205. 

  205. <div class="line">    <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#a075d54df14c85a6afe32b7f5c99c9c29">OS_ERROR_FIFO_OVF</a>:</div>
    206. 

  206. <div class="line">      <span class="comment">// ISR FIFO Queue buffer overflow detected. </span></div>
    207. 

  207. <div class="line">      <span class="keywordflow">break</span>;</div>
    208. 

  208. <div class="line"> </div>
    209. 

  209. <div class="line">    <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#ab715d7d66c341c067ef0a97b55db8a10">OS_ERROR_MBX_OVF</a>:</div>
    210. 

  210. <div class="line">      <span class="comment">// Mailbox overflow detected. </span></div>
    211. 

  211. <div class="line">      <span class="keywordflow">break</span>;</div>
    212. 

  212. <div class="line"> </div>
    213. 

  213. <div class="line">    <span class="keywordflow">case</span> <a class="code" href="RTX__Conf__CM_8c.html#a79d7e388d951f11bd0dabd13f722cea8">OS_ERROR_TIMER_OVF</a>:</div>
    214. 

  214. <div class="line">      <span class="comment">// User Timer Callback Queue overflow detected. </span></div>
    215. 

  215. <div class="line">      <span class="keywordflow">break</span>;</div>
    216. 

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

  217. <div class="line">  <span class="keywordflow">for</span> (;;);</div>
    218. 

  218. <div class="line">}</div>
    219. 

  219. </div><!-- fragment --><p>OS error callback (called when a runtime error is detected).</p>
    220. 

  220. <dl class="params"><dt>Parameters</dt><dd>
    221. 

  221.   <table class="params">
    222. 

  222.     <tr><td class="paramdir">[in]</td><td class="paramname">error_code</td><td>actual error code that has been detected </td></tr>
    223. 

  223.   </table>
    224. 

  224.   </dd>
    225. 

  225. </dl>
    226. 

  226. 

  227. </div>
    228. 

  228. </div>
    229. 

  229. <a class="anchor" id="gafb4dc4d3dff8343a393726d2860282e4"></a>
    230. 

  230. <div class="memitem">
    231. 

  231. <div class="memproto">
    232. 

  232.       <table class="memname">
    233. 

  233.         <tr>
    234. 

  234.           <td class="memname">void os_idle_demon </td>
    235. 

  235.           <td>(</td>
    236. 

  236.           <td class="paramtype">void&#160;</td>
    237. 

  237.           <td class="paramname"></td><td>)</td>
    238. 

  238.           <td></td>
    239. 

  239.         </tr>
    240. 

  240.       </table>
    241. 

  241. </div><div class="memdoc">
    242. 

  242. <p>The function <b>os_idle_demon</b> is executed by the RTX kernel, when no other threads are ready to run. By default, this task is an empty end-less loop that does nothing. It only waits until another task becomes ready to run. You may change the code of the <b>os_idle_demon</b> function to put the CPU into a power-saving or idle mode.</p>
    243. 

  243. <p>The default stack size for this task is defined in the file <b>#<a class="el" href="RTX__Conf__CM_8c.html">RTX_Conf_CM.c</a></b>. Refer to <a class="el" href="threadConfig.html">Thread Configuration</a> entry <b>Default Thread stack size [bytes]</b>.</p>
    244. 

  244. <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>
    245. 

  245. <p><b>Code</b> <b>Example</b> </p>
    246. 

  246. <div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#gafb4dc4d3dff8343a393726d2860282e4">os_idle_demon</a> (<span class="keywordtype">void</span>) {</div>
    247. 

  247. <div class="line"> </div>
    248. 

  248. <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
    249. 

  249. <div class="line">  __WFI(); <span class="comment">// wait for interrupt</span></div>
    250. 

  250. <div class="line">  }</div>
    251. 

  251. <div class="line">}</div>
    252. 

  252. </div><!-- fragment --><p>OS idle demon (running when no other thread is ready to run). </p>
    253. 

  253. 

  254. </div>
    255. 

  255. </div>
    256. 

  256. <a class="anchor" id="ga1b85a217d43e6b971ffcf24f8aae1c33"></a>
    257. 

  257. <div class="memitem">
    258. 

  258. <div class="memproto">
    259. 

  259.       <table class="memname">
    260. 

  260.         <tr>
    261. 

  261.           <td class="memname">void os_resume </td>
    262. 

  262.           <td>(</td>
    263. 

  263.           <td class="paramtype">uint32_t&#160;</td>
    264. 

  264.           <td class="paramname"><em>sleep_time</em></td><td>)</td>
    265. 

  265.           <td></td>
    266. 

  266.         </tr>
    267. 

  267.       </table>
    268. 

  268. </div><div class="memdoc">
    269. 

  269. <dl class="params"><dt>Parameters</dt><dd>
    270. 

  270.   <table class="params">
    271. 

  271.     <tr><td class="paramdir">[in]</td><td class="paramname">sleep_time</td><td>specifies how long the system was in sleep or power-down mode.</td></tr>
    272. 

  272.   </table>
    273. 

  273.   </dd>
    274. 

  274. </dl>
    275. 

  275. <p>The function <b>os_resume</b> resumes the RTX task scheduler. You must call this function after you have called <a class="el" href="group__RTX__Global__Functions.html#ga3e9c57746ccbdfe90464ad50513c569e">os_suspend</a> to re-enable the task scheduler.</p>
    276. 

  276. <p>The argument <em>sleep_time</em> specifies how long the system was in sleep or power-down mode. It is measured in number of system intervals.</p>
    277. 

  277. <dl class="section note"><dt>Note</dt><dd><ul>
    278. 

  278. <li>You can call this function from the idle task only.</li>
    279. 

  279. <li>When the system is in power-down, the system tick timer is not running.</li>
    280. 

  280. <li>Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</li>
    281. 

  281. </ul>
    282. 

  282. </dd></dl>
    283. 

  283. <p>See <a class="el" href="group__RTX__Global__Functions.html#ga3e9c57746ccbdfe90464ad50513c569e">os_suspend</a> for a <b>Code</b> <b>Example</b>. </p>
    284. 

  284. 

  285. </div>
    286. 

  286. </div>
    287. 

  287. <a class="anchor" id="ga3e9c57746ccbdfe90464ad50513c569e"></a>
    288. 

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

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

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

  291.         <tr>
    292. 

  292.           <td class="memname">uint32_t os_suspend </td>
    293. 

  293.           <td>(</td>
    294. 

  294.           <td class="paramtype">void&#160;</td>
    295. 

  295.           <td class="paramname"></td><td>)</td>
    296. 

  296.           <td></td>
    297. 

  297.         </tr>
    298. 

  298.       </table>
    299. 

  299. </div><div class="memdoc">
    300. 

  300. <dl class="section return"><dt>Returns</dt><dd>number of ticks, for how long the system can sleep or power-down.</dd></dl>
    301. 

  301. <p>The function <b>os_suspend</b> suspends the RTX task scheduler. The function calculates the time, for how long the system is allowed to power-down, and locks the task scheduler. When the function returns, the task switches are disabled. For normal RTX operation, after calling <b>os_suspend</b>, you must call the <a class="el" href="group__RTX__Global__Functions.html#ga1b85a217d43e6b971ffcf24f8aae1c33">os_resume</a> function to re-enable the OS task scheduler.</p>
    302. 

  302. <dl class="section note"><dt>Note</dt><dd><ul>
    303. 

  303. <li>You can call this function from the idle task only.</li>
    304. 

  304. <li>When the system is in power-down, the system tick timer is not running.</li>
    305. 

  305. <li>Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</li>
    306. 

  306. </ul>
    307. 

  307. </dd></dl>
    308. 

  308. <p><b>Code</b> <b>Example</b> </p>
    309. 

  309. <p>The low power RTX is controlled from the <a class="el" href="group__RTX__Global__Functions.html#gafb4dc4d3dff8343a393726d2860282e4">os_idle_demon</a>. The peripheral wake-up timer must be initialized before the system enters an endless loop. <b>os_suspend</b> calculates the timeout until the first suspended task becomes ready, and returns the timeout to the user:</p>
    310. 

  310. <div class="fragment"><div class="line"><span class="keywordflow">for</span> (;;) {</div>
    311. 

  311. <div class="line">sleep = <a class="code" href="group__RTX__Global__Functions.html#ga3e9c57746ccbdfe90464ad50513c569e">os_suspend</a>();</div>
    312. 

  312. </div><!-- fragment --><p>The user sets-up a peripheral timer to sleep timeout and starts the timer. The timeout is measured in system ticks.</p>
    313. 

  313. <div class="fragment"><div class="line"><span class="keywordflow">if</span> (sleep) {</div>
    314. 

  314. <div class="line">  <span class="comment">// Setup the wake-up timer ... </span></div>
    315. 

  315. </div><!-- fragment --><p>When the wake-up timer is set-up and running, the user puts the system in power-down mode. The wake-up timer must run also in power-down mode. All other peripherals and the CPU may power-down to reduce power.</p>
    316. 

  316. <div class="fragment"><div class="line"><span class="comment">// Power-down the system ... </span></div>
    317. 

  317. <div class="line">SCB-&gt;SCR |= SCB_SCR_SLEEPDEEP_Msk;</div>
    318. 

  318. <div class="line">__WFE();</div>
    319. 

  319. </div><!-- fragment --><p>The wake-up timer, when expired, generates the interrupt and wakes-up the system. Hence, it must run also in power-down mode. The system resumes operation and needs to call the function <a class="el" href="group__RTX__Global__Functions.html#ga1b85a217d43e6b971ffcf24f8aae1c33">os_resume</a>. This function restores the RTX and re-enables the scheduler.</p>
    320. 

  320. <div class="fragment"><div class="line">  <span class="comment">// After Wake-up </span></div>
    321. 

  321. <div class="line">  sleep = (tc - LPC_WWDT-&gt;TV) / 250;</div>
    322. 

  322. <div class="line">}</div>
    323. 

  323. <div class="line"><a class="code" href="group__RTX__Global__Functions.html#ga1b85a217d43e6b971ffcf24f8aae1c33">os_resume</a>(sleep);</div>
    324. 

  324. </div><!-- fragment --><p>If, for any reason, the system does not wake up immediately after the wake-up interrupt, the actual sleep time is checked and adjusted. </p>
    325. 

  325. 

  326. </div>
    327. 

  327. </div>
    328. 

  328. <a class="anchor" id="ga145e7eafdd042bb522020cbb3b469d9c"></a>
    329. 

  329. <div class="memitem">
    330. 

  330. <div class="memproto">
    331. 

  331.       <table class="memname">
    332. 

  332.         <tr>
    333. 

  333.           <td class="memname">int os_tick_init </td>
    334. 

  334.           <td>(</td>
    335. 

  335.           <td class="paramtype">void&#160;</td>
    336. 

  336.           <td class="paramname"></td><td>)</td>
    337. 

  337.           <td></td>
    338. 

  338.         </tr>
    339. 

  339.       </table>
    340. 

  340. </div><div class="memdoc">
    341. 

  341. <dl class="section return"><dt>Returns</dt><dd>IRQ number of the alternative hardware timer</dd></dl>
    342. 

  342. <p>The function <b>os_tick_init</b> initializes an alternate hardware timer as the system tick timer and starts it. If you setup OS_SYSTICK to 0, this function will be available for adding the alternate timer. It returns the interrupt number of the alternative hardware timer.</p>
    343. 

  343. <dl class="section note"><dt>Note</dt><dd>- When using an alternate timer, you must enter the <a class="el" href="timerTick.html#OS_Tick_Handler">OS_Tick_Handler</a> in the interrupt vector table in the startup file.</dd>
    344. 

  344. <dd>
    345. 

  345. - Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    346. 

  346. <p><b>Code</b> <b>Example</b> </p>
    347. 

  347. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;LPC43xx.h&quot;</span>                    <span class="comment">// Device header</span></div>
    348. 

  348. <div class="line"> </div>
    349. 

  349. <div class="line"><span class="keywordtype">int</span> <a class="code" href="group__RTX__Global__Functions.html#ga145e7eafdd042bb522020cbb3b469d9c">os_tick_init</a> (<span class="keywordtype">void</span>) {</div>
    350. 

  350. <div class="line">  <span class="comment">// Initialize hardware timer as system tick timer. </span></div>
    351. 

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

  352. <div class="line">  LPC_CCU1-&gt;CLK_M4_RITIMER_CFG = (1UL &lt;&lt; 0);</div>
    353. 

  353. <div class="line"> </div>
    354. 

  354. <div class="line">  LPC_RITIMER-&gt;COMPVAL = <a class="code" href="RTX__Conf__CM_8c.html#a9d55a070ddb219165bd4287f08318d51">OS_TRV</a>;     <span class="comment">// Set match value</span></div>
    355. 

  355. <div class="line">  LPC_RITIMER-&gt;COUNTER = 0;          <span class="comment">// Set count value to 0</span></div>
    356. 

  356. <div class="line">  LPC_RITIMER-&gt;CTRL    = (1UL &lt;&lt; 3) |    <span class="comment">// Timer enable</span></div>
    357. 

  357. <div class="line">                         (1UL &lt;&lt; 2) |    <span class="comment">// Timer enable for debug</span></div>
    358. 

  358. <div class="line">                         (1UL &lt;&lt; 1) |    <span class="comment">// Timer enable clear on match</span></div>
    359. 

  359. <div class="line">                         (1UL &lt;&lt; 0);     <span class="comment">// Clear interrupt flag</span></div>
    360. 

  360. <div class="line">  </div>
    361. 

  361. <div class="line">  <span class="keywordflow">return</span> (M0_RITIMER_OR_WWDT_IRQn);  <span class="comment">// Return IRQ number of timer (0..239) </span></div>
    362. 

  362. <div class="line">}</div>
    363. 

  363. </div><!-- fragment --> 
    364. 

  364. </div>
    365. 

  365. </div>
    366. 

  366. <a class="anchor" id="ga85dab8408f27236c7341a69feb6258c7"></a>
    367. 

  367. <div class="memitem">
    368. 

  368. <div class="memproto">
    369. 

  369.       <table class="memname">
    370. 

  370.         <tr>
    371. 

  371.           <td class="memname">void os_tick_irqack </td>
    372. 

  372.           <td>(</td>
    373. 

  373.           <td class="paramtype">void&#160;</td>
    374. 

  374.           <td class="paramname"></td><td>)</td>
    375. 

  375.           <td></td>
    376. 

  376.         </tr>
    377. 

  377.       </table>
    378. 

  378. </div><div class="memdoc">
    379. 

  379. <p>The function <b>os_tick_irqack</b> acknowledges the peripheral timer interrupt.</p>
    380. 

  380. <dl class="section note"><dt>Note</dt><dd>- When using an alternate timer, you must enter the <a class="el" href="timerTick.html#OS_Tick_Handler">OS_Tick_Handler</a> in the interrupt vector table in the startup file. </dd>
    381. 

  381. <dd>
    382. 

  382. - Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    383. 

  383. <p><b>Code</b> <b>Example</b> </p>
    384. 

  384. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;LPC43xx.h&quot;</span>                    <span class="comment">// Device header</span></div>
    385. 

  385. <div class="line"> </div>
    386. 

  386. <div class="line"><span class="keywordtype">void</span> <a class="code" href="group__RTX__Global__Functions.html#ga85dab8408f27236c7341a69feb6258c7">os_tick_irqack</a> (<span class="keywordtype">void</span>) {</div>
    387. 

  387. <div class="line"> </div>
    388. 

  388. <div class="line">  LPC_RITIMER-&gt;CTRL |= (1UL &lt;&lt; 0);    <span class="comment">// Clear interrupt flag</span></div>
    389. 

  389. <div class="line">}</div>
    390. 

  390. </div><!-- fragment --> 
    391. 

  391. </div>
    392. 

  392. </div>
    393. 

  393. <a class="anchor" id="gad5deddec3fea0fb31798f571afc3c692"></a>
    394. 

  394. <div class="memitem">
    395. 

  395. <div class="memproto">
    396. 

  396.       <table class="memname">
    397. 

  397.         <tr>
    398. 

  398.           <td class="memname">uint32_t os_tick_ovf </td>
    399. 

  399.           <td>(</td>
    400. 

  400.           <td class="paramtype">void&#160;</td>
    401. 

  401.           <td class="paramname"></td><td>)</td>
    402. 

  402.           <td></td>
    403. 

  403.         </tr>
    404. 

  404.       </table>
    405. 

  405. </div><div class="memdoc">
    406. 

  406. <dl class="section return"><dt>Returns</dt><dd>Overflow flag<br/>
    407. 

  407. <ul>
    408. 

  408. <li>1 : overflow</li>
    409. 

  409. <li>0 : no overflow</li>
    410. 

  410. </ul>
    411. 

  411. </dd></dl>
    412. 

  412. <p>The function <b>os_tick_ovf</b> returns the overflow flag of the alternate hardware timer specified by os_tick_init.</p>
    413. 

  413. <dl class="section note"><dt>Note</dt><dd>- When using an alternate timer, you must enter the <a class="el" href="timerTick.html#OS_Tick_Handler">OS_Tick_Handler</a> in the interrupt vector table in the startup file. </dd>
    414. 

  414. <dd>
    415. 

  415. - Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    416. 

  416. <p><b>Code</b> <b>Example</b> </p>
    417. 

  417. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;LPC43xx.h&quot;</span>                    <span class="comment">// Device header</span></div>
    418. 

  418. <div class="line"> </div>
    419. 

  419. <div class="line">uint32_t <a class="code" href="group__RTX__Global__Functions.html#gad5deddec3fea0fb31798f571afc3c692">os_tick_ovf</a> (<span class="keywordtype">void</span>) {</div>
    420. 

  420. <div class="line"> </div>
    421. 

  421. <div class="line">  <span class="keywordflow">return</span> (LPC_RITIMER-&gt;CTRL);</div>
    422. 

  422. <div class="line">}</div>
    423. 

  423. </div><!-- fragment --> 
    424. 

  424. </div>
    425. 

  425. </div>
    426. 

  426. <a class="anchor" id="ga567543bf38239a91f09751686c23017b"></a>
    427. 

  427. <div class="memitem">
    428. 

  428. <div class="memproto">
    429. 

  429.       <table class="memname">
    430. 

  430.         <tr>
    431. 

  431.           <td class="memname">uint32_t os_tick_val </td>
    432. 

  432.           <td>(</td>
    433. 

  433.           <td class="paramtype">void&#160;</td>
    434. 

  434.           <td class="paramname"></td><td>)</td>
    435. 

  435.           <td></td>
    436. 

  436.         </tr>
    437. 

  437.       </table>
    438. 

  438. </div><div class="memdoc">
    439. 

  439. <dl class="section return"><dt>Returns</dt><dd>Current value of the alternative hardware timer</dd></dl>
    440. 

  440. <p>The function <b>os_tick_val</b> returns the current value of the alternate hardware timer specified by os_tick_init.</p>
    441. 

  441. <dl class="section note"><dt>Note</dt><dd>- When using an alternate timer, you must enter the <a class="el" href="timerTick.html#OS_Tick_Handler">OS_Tick_Handler</a> in the interrupt vector table in the startup file. </dd>
    442. 

  442. <dd>
    443. 

  443. - Cannot be called from <a class="el" href="functionOverview.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    444. 

  444. <p><b>Code</b> <b>Example</b> </p>
    445. 

  445. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;LPC43xx.h&quot;</span>                    <span class="comment">// Device header</span></div>
    446. 

  446. <div class="line"> </div>
    447. 

  447. <div class="line">uint32_t <a class="code" href="group__RTX__Global__Functions.html#ga567543bf38239a91f09751686c23017b">os_tick_val</a> (<span class="keywordtype">void</span>) {</div>
    448. 

  448. <div class="line"> </div>
    449. 

  449. <div class="line">  <span class="keywordflow">return</span> (LPC_RITIMER-&gt;COUNTER);</div>
    450. 

  450. <div class="line">}</div>
    451. 

  451. </div><!-- fragment --> 
    452. 

  452. </div>
    453. 

  453. </div>
    454. 

  454. </div><!-- contents -->
    455. 

  455. </div><!-- doc-content -->
    456. 

  456. <!-- start footer part -->
    457. 

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

  458.   <ul>
    459. 

  459.     <li class="footer">Generated on Mon Mar 18 2019 16:06:29 for CMSIS-RTOS by Arm Ltd. All rights reserved.
    460. 

  460. 	<!--
    461. 

  461.     <a href="http://www.doxygen.org/index.html">
    462. 

  462.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    463. 

  463. 	-->
    464. 

  464. 	</li>
    465. 

  465.   </ul>
    466. 

  466. </div>
    467. 

  467. </body>
    468. 

  468. </html>
    469.