Почетна Преглед Помоћ
Пријавите се
ARM-software
/
CMSIS_5
огледало од https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: a82c293bfb
Гране Ознаке
CMSIS_5
/
docs
/
RTOS2
/
html
/
group__CMSIS__RTOS__KernelCtrl.html

group__CMSIS__RTOS__KernelCtrl.html 61 KB
Историја Датотека

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809 
  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>Kernel Information and Control</title>
    7. 

  7. <title>CMSIS-RTOS2: Kernel Information and Control</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-RTOS2
    35. 

  35.    &#160;<span id="projectnumber">Version 2.1.3</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__KernelCtrl.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="#nested-classes">Data Structures</a> &#124;
    112. 

  112. <a href="#enum-members">Enumerations</a> &#124;
    113. 

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

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

  115. <div class="title">Kernel Information and Control<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a></div></div>  </div>
    116. 

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

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

  118. 

  119. <p>Provides version/system information and starts/controls the RTOS Kernel.  
    120. 

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

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

  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
    123. 

  123. Data Structures</h2></td></tr>
    124. 

  124. <tr class="memitem:structosVersion__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a></td></tr>
    125. 

  125. <tr class="memdesc:structosVersion__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Version information.  <a href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">More...</a><br/></td></tr>
    126. 

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

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

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

  129. Enumerations</h2></td></tr>
    130. 

  130. <tr class="memitem:ga08326469274b668140ca934b168a5ad4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> { <br/>
    131. 

  131. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995">osKernelInactive</a> = 0, 
    132. 

  132. <br/>
    133. 

  133. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24">osKernelReady</a> = 1, 
    134. 

  134. <br/>
    135. 

  135. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4a8e0b699fbe1c8bb66fefadd5911cb6ce">osKernelRunning</a> = 2, 
    136. 

  136. <br/>
    137. 

  137. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4a2fe382ad5ebab2257b35740414b28b01">osKernelLocked</a> = 3, 
    138. 

  138. <br/>
    139. 

  139. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4ad364464ad84d63b1413a9ac8a962390c">osKernelSuspended</a> = 4, 
    140. 

  140. <br/>
    141. 

  141. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a">osKernelError</a> = -1, 
    142. 

  142. <br/>
    143. 

  143. &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4ab0a47576defa29396a649d9173d4bc4b">osKernelReserved</a> = 0x7FFFFFFFU
    144. 

  144. <br/>
    145. 

  145.  }</td></tr>
    146. 

  146. <tr class="memdesc:ga08326469274b668140ca934b168a5ad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Kernel state.  <a href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">More...</a><br/></td></tr>
    147. 

  147. <tr class="separator:ga08326469274b668140ca934b168a5ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    148. 

  148. </table><table class="memberdecls">
    149. 

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

  150. Functions</h2></td></tr>
    151. 

  151. <tr class="memitem:gae818f6611d25ba3140bede410a52d659"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> (void)</td></tr>
    152. 

  152. <tr class="memdesc:gae818f6611d25ba3140bede410a52d659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the RTOS Kernel.  <a href="#gae818f6611d25ba3140bede410a52d659">More...</a><br/></td></tr>
    153. 

  153. <tr class="separator:gae818f6611d25ba3140bede410a52d659"><td class="memSeparator" colspan="2">&#160;</td></tr>
    154. 

  154. <tr class="memitem:ga6f7764e7250c5c5364c00c45a5d1d199"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> (<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *version, char *id_buf, uint32_t id_size)</td></tr>
    155. 

  155. <tr class="memdesc:ga6f7764e7250c5c5364c00c45a5d1d199"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get RTOS Kernel Information.  <a href="#ga6f7764e7250c5c5364c00c45a5d1d199">More...</a><br/></td></tr>
    156. 

  156. <tr class="separator:ga6f7764e7250c5c5364c00c45a5d1d199"><td class="memSeparator" colspan="2">&#160;</td></tr>
    157. 

  157. <tr class="memitem:ga48b69b81012fce051f639be288b243ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a> (void)</td></tr>
    158. 

  158. <tr class="memdesc:ga48b69b81012fce051f639be288b243ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current RTOS Kernel state.  <a href="#ga48b69b81012fce051f639be288b243ba">More...</a><br/></td></tr>
    159. 

  159. <tr class="separator:ga48b69b81012fce051f639be288b243ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
    160. 

  160. <tr class="memitem:ga9ae2cc00f0d89d7b6a307bba942b5221"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a> (void)</td></tr>
    161. 

  161. <tr class="memdesc:ga9ae2cc00f0d89d7b6a307bba942b5221"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the RTOS Kernel scheduler.  <a href="#ga9ae2cc00f0d89d7b6a307bba942b5221">More...</a><br/></td></tr>
    162. 

  162. <tr class="separator:ga9ae2cc00f0d89d7b6a307bba942b5221"><td class="memSeparator" colspan="2">&#160;</td></tr>
    163. 

  163. <tr class="memitem:ga948609ee930d9b38336b9e1c2a4dfe12"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> (void)</td></tr>
    164. 

  164. <tr class="memdesc:ga948609ee930d9b38336b9e1c2a4dfe12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock the RTOS Kernel scheduler.  <a href="#ga948609ee930d9b38336b9e1c2a4dfe12">More...</a><br/></td></tr>
    165. 

  165. <tr class="separator:ga948609ee930d9b38336b9e1c2a4dfe12"><td class="memSeparator" colspan="2">&#160;</td></tr>
    166. 

  166. <tr class="memitem:gaf401728b4657456198c33fe75f8d6720"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a> (void)</td></tr>
    167. 

  167. <tr class="memdesc:gaf401728b4657456198c33fe75f8d6720"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlock the RTOS Kernel scheduler.  <a href="#gaf401728b4657456198c33fe75f8d6720">More...</a><br/></td></tr>
    168. 

  168. <tr class="separator:gaf401728b4657456198c33fe75f8d6720"><td class="memSeparator" colspan="2">&#160;</td></tr>
    169. 

  169. <tr class="memitem:gae7d0a71b9586cbbb49fcbdf6a04f0289"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a> (int32_t lock)</td></tr>
    170. 

  170. <tr class="memdesc:gae7d0a71b9586cbbb49fcbdf6a04f0289"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the RTOS Kernel scheduler lock state.  <a href="#gae7d0a71b9586cbbb49fcbdf6a04f0289">More...</a><br/></td></tr>
    171. 

  171. <tr class="separator:gae7d0a71b9586cbbb49fcbdf6a04f0289"><td class="memSeparator" colspan="2">&#160;</td></tr>
    172. 

  172. <tr class="memitem:gae26683e1606ec633354a2876c68f0c1f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a> (void)</td></tr>
    173. 

  173. <tr class="memdesc:gae26683e1606ec633354a2876c68f0c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the RTOS Kernel scheduler.  <a href="#gae26683e1606ec633354a2876c68f0c1f">More...</a><br/></td></tr>
    174. 

  174. <tr class="separator:gae26683e1606ec633354a2876c68f0c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    175. 

  175. <tr class="memitem:ga8c4b4d7ed34cab73c001665d9176aced"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a> (uint32_t sleep_ticks)</td></tr>
    176. 

  176. <tr class="memdesc:ga8c4b4d7ed34cab73c001665d9176aced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume the RTOS Kernel scheduler.  <a href="#ga8c4b4d7ed34cab73c001665d9176aced">More...</a><br/></td></tr>
    177. 

  177. <tr class="separator:ga8c4b4d7ed34cab73c001665d9176aced"><td class="memSeparator" colspan="2">&#160;</td></tr>
    178. 

  178. <tr class="memitem:ga84bcdbf2fb76b10c8df4e439f0c7e11b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b">osKernelGetTickCount</a> (void)</td></tr>
    179. 

  179. <tr class="memdesc:ga84bcdbf2fb76b10c8df4e439f0c7e11b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel tick count.  <a href="#ga84bcdbf2fb76b10c8df4e439f0c7e11b">More...</a><br/></td></tr>
    180. 

  180. <tr class="separator:ga84bcdbf2fb76b10c8df4e439f0c7e11b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    181. 

  181. <tr class="memitem:ga7a8d7bd927eaaa58999f91d7d6310cee"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga7a8d7bd927eaaa58999f91d7d6310cee">osKernelGetTickFreq</a> (void)</td></tr>
    182. 

  182. <tr class="memdesc:ga7a8d7bd927eaaa58999f91d7d6310cee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel tick frequency.  <a href="#ga7a8d7bd927eaaa58999f91d7d6310cee">More...</a><br/></td></tr>
    183. 

  183. <tr class="separator:ga7a8d7bd927eaaa58999f91d7d6310cee"><td class="memSeparator" colspan="2">&#160;</td></tr>
    184. 

  184. <tr class="memitem:gae0fcaff6cecfb4013bb556c87afcd7d2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2">osKernelGetSysTimerCount</a> (void)</td></tr>
    185. 

  185. <tr class="memdesc:gae0fcaff6cecfb4013bb556c87afcd7d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel system timer count.  <a href="#gae0fcaff6cecfb4013bb556c87afcd7d2">More...</a><br/></td></tr>
    186. 

  186. <tr class="separator:gae0fcaff6cecfb4013bb556c87afcd7d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    187. 

  187. <tr class="memitem:ga4d69215a93220f72be3684cad582f16a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga4d69215a93220f72be3684cad582f16a">osKernelGetSysTimerFreq</a> (void)</td></tr>
    188. 

  188. <tr class="memdesc:ga4d69215a93220f72be3684cad582f16a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel system timer frequency.  <a href="#ga4d69215a93220f72be3684cad582f16a">More...</a><br/></td></tr>
    189. 

  189. <tr class="separator:ga4d69215a93220f72be3684cad582f16a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    190. 

  190. </table>
    191. 

  191. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    192. 

  192. <p>The kernel Information and Control function group allows to:</p>
    193. 

  193. <ul>
    194. 

  194. <li>obtain information about the system and the underlying kernel.</li>
    195. 

  195. <li>obtain version information about the CMSIS-RTOS API.</li>
    196. 

  196. <li>initialize of the RTOS kernel for creating objects.</li>
    197. 

  197. <li>start the RTOS kernel and thread switching.</li>
    198. 

  198. <li>check the execution status of the RTOS kernel.</li>
    199. 

  199. </ul>
    200. 

  200. <dl class="section note"><dt>Note</dt><dd>The kernel information and control functions cannot be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd>
    201. 

  201. <dd>
    202. 

  202. The kernel initialization for RTX5 is documented in <a class="el" href="theory_of_operation.html#SystemStartup">System Startup</a>.</dd></dl>
    203. 

  203. <p><b>Code Example</b> </p>
    204. 

  204. <div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
    205. 

  205. <div class="line"><span class="comment"> * Application main thread</span></div>
    206. 

  206. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
    207. 

  207. <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
    208. 

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

  209. <div class="line">  <span class="comment">// ...</span></div>
    210. 

  210. <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
    211. 

  211. <div class="line">}</div>
    212. 

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

  213. <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
    214. 

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

  215. <div class="line">  <span class="comment">// System Initialization</span></div>
    216. 

  216. <div class="line">  SystemCoreClockUpdate();</div>
    217. 

  217. <div class="line">  <span class="comment">// ...</span></div>
    218. 

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

  219. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>();                 <span class="comment">// Initialize CMSIS-RTOS</span></div>
    220. 

  220. <div class="line">  <a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(app_main, NULL, NULL);    <span class="comment">// Create application main thread</span></div>
    221. 

  221. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>();                      <span class="comment">// Start thread execution</span></div>
    222. 

  222. <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
    223. 

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

  224. </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
    225. 

  225. <a name="structosVersion__t" id="structosVersion__t"></a>
    226. 

  226. <div class="memitem">
    227. 

  227. <div class="memproto">
    228. 

  228.       <table class="memname">
    229. 

  229.         <tr>
    230. 

  230.           <td class="memname">struct osVersion_t</td>
    231. 

  231.         </tr>
    232. 

  232.       </table>
    233. 

  233. </div><div class="memdoc">
    234. 

  234. <div class="textblock"><p>Identifies the underlying RTOS kernel and API version number. The version is represented in a combined decimal number in the format: major.minor.rev: mmnnnrrrr</p>
    235. 

  235. <p>Use <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> to retrieve the version numbers. </p>
    236. 

  236. </div><table class="fieldtable">
    237. 

  237. <tr><th colspan="3">Data Fields</th></tr>
    238. 

  238. <tr><td class="fieldtype">
    239. 

  239. <a class="anchor" id="a76a1ef1a4d3d9bd3e70783051f22a6d3"></a>uint32_t</td>
    240. 

  240. <td class="fieldname">
    241. 

  241. api</td>
    242. 

  242. <td class="fielddoc">
    243. 

  243. API version (major.minor.rev: mmnnnrrrr dec). </td></tr>
    244. 

  244. <tr><td class="fieldtype">
    245. 

  245. <a class="anchor" id="ad8075d3f42141346ae2c56389358f9e7"></a>uint32_t</td>
    246. 

  246. <td class="fieldname">
    247. 

  247. kernel</td>
    248. 

  248. <td class="fielddoc">
    249. 

  249. Kernel version (major.minor.rev: mmnnnrrrr dec). </td></tr>
    250. 

  250. </table>
    251. 

  251. 

  252. </div>
    253. 

  253. </div>
    254. 

  254. <h2 class="groupheader">Enumeration Type Documentation</h2>
    255. 

  255. <a class="anchor" id="ga08326469274b668140ca934b168a5ad4"></a>
    256. 

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

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

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

  259.         <tr>
    260. 

  260.           <td class="memname">enum <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a></td>
    261. 

  261.         </tr>
    262. 

  262.       </table>
    263. 

  263. </div><div class="memdoc">
    264. 

  264. <p>State of the kernel as retrieved by <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a>. In case <b>osKernelGetState</b> fails or if it is called from an ISR, it will return <code>osKernelError</code>, otherwise it returns the kernel state. </p>
    265. 

  265. <table class="fieldtable">
    266. 

  266. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995"></a>osKernelInactive</em>&#160;</td><td class="fielddoc">
    267. 

  267. <p>Inactive. </p>
    268. 

  268. <p>The kernel is not ready yet. <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> needs to be executed successfully. </p>
    269. 

  269. </td></tr>
    270. 

  270. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24"></a>osKernelReady</em>&#160;</td><td class="fielddoc">
    271. 

  271. <p>Ready. </p>
    272. 

  272. <p>The kernel is not yet running. <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a> transfers the kernel to the running state. </p>
    273. 

  273. </td></tr>
    274. 

  274. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4a8e0b699fbe1c8bb66fefadd5911cb6ce"></a>osKernelRunning</em>&#160;</td><td class="fielddoc">
    275. 

  275. <p>Running. </p>
    276. 

  276. <p>The kernel is initialized and running. </p>
    277. 

  277. </td></tr>
    278. 

  278. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4a2fe382ad5ebab2257b35740414b28b01"></a>osKernelLocked</em>&#160;</td><td class="fielddoc">
    279. 

  279. <p>Locked. </p>
    280. 

  280. <p>The kernel was locked with <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a>. The functions <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a> unlocks it. </p>
    281. 

  281. </td></tr>
    282. 

  282. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4ad364464ad84d63b1413a9ac8a962390c"></a>osKernelSuspended</em>&#160;</td><td class="fielddoc">
    283. 

  283. <p>Suspended. </p>
    284. 

  284. <p>The kernel was suspended using <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a>. The function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a> returns to normal operation. </p>
    285. 

  285. </td></tr>
    286. 

  286. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a"></a>osKernelError</em>&#160;</td><td class="fielddoc">
    287. 

  287. <p>Error. </p>
    288. 

  288. <p>An error occurred. </p>
    289. 

  289. </td></tr>
    290. 

  290. <tr><td class="fieldname"><em><a class="anchor" id="ga08326469274b668140ca934b168a5ad4ab0a47576defa29396a649d9173d4bc4b"></a>osKernelReserved</em>&#160;</td><td class="fielddoc">
    291. 

  291. <p>Prevents enum down-size compiler optimization. </p>
    292. 

  292. <p>Reserved. </p>
    293. 

  293. </td></tr>
    294. 

  294. </table>
    295. 

  295. 

  296. </div>
    297. 

  297. </div>
    298. 

  298. <h2 class="groupheader">Function Documentation</h2>
    299. 

  299. <a class="anchor" id="gae818f6611d25ba3140bede410a52d659"></a>
    300. 

  300. <div class="memitem">
    301. 

  301. <div class="memproto">
    302. 

  302.       <table class="memname">
    303. 

  303.         <tr>
    304. 

  304.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelInitialize </td>
    305. 

  305.           <td>(</td>
    306. 

  306.           <td class="paramtype">void&#160;</td>
    307. 

  307.           <td class="paramname"></td><td>)</td>
    308. 

  308.           <td></td>
    309. 

  309.         </tr>
    310. 

  310.       </table>
    311. 

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

  312. <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
    313. 

  313. <p>The function <b>osKernelInitialize</b> initializes the RTOS Kernel. Before it is successfully executed, only the functions <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> and <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a> may be called.</p>
    314. 

  314. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    315. 

  315. <ul>
    316. 

  316. <li><em>osOK</em> in case of success.</li>
    317. 

  317. <li><em>osError</em> if an unspecific error occurred.</li>
    318. 

  318. <li><em>osErrorISR</em> if called from an <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
    319. 

  319. <li><em>osErrorNoMemory</em> if no memory could be reserved for the operation.</li>
    320. 

  320. </ul>
    321. 

  321. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    322. 

  322. <p><b> Code Example</b> </p>
    323. 

  323. <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;RTE_Components.h&quot;</span></div>
    324. 

  324. <div class="line"><span class="preprocessor">#include  CMSIS_device_header</span></div>
    325. 

  325. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span></div>
    326. 

  326. <div class="line"> </div>
    327. 

  327. <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
    328. 

  328. <div class="line"><span class="comment"> * Application main thread</span></div>
    329. 

  329. <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
    330. 

  330. <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
    331. 

  331. <div class="line"> </div>
    332. 

  332. <div class="line">  <span class="comment">// ...</span></div>
    333. 

  333. <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
    334. 

  334. <div class="line">}</div>
    335. 

  335. <div class="line"> </div>
    336. 

  336. <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
    337. 

  337. <div class="line"> </div>
    338. 

  338. <div class="line">  <span class="comment">// System Initialization</span></div>
    339. 

  339. <div class="line">  SystemCoreClockUpdate();</div>
    340. 

  340. <div class="line">  <span class="comment">// ...</span></div>
    341. 

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

  342. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>();                 <span class="comment">// Initialize CMSIS-RTOS</span></div>
    343. 

  343. <div class="line">  <a class="code" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(app_main, NULL, NULL);    <span class="comment">// Create application main thread</span></div>
    344. 

  344. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>();                      <span class="comment">// Start thread execution</span></div>
    345. 

  345. <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
    346. 

  346. <div class="line">}</div>
    347. 

  347. </div><!-- fragment --> 
    348. 

  348. </div>
    349. 

  349. </div>
    350. 

  350. <a class="anchor" id="ga6f7764e7250c5c5364c00c45a5d1d199"></a>
    351. 

  351. <div class="memitem">
    352. 

  352. <div class="memproto">
    353. 

  353.       <table class="memname">
    354. 

  354.         <tr>
    355. 

  355.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelGetInfo </td>
    356. 

  356.           <td>(</td>
    357. 

  357.           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *&#160;</td>
    358. 

  358.           <td class="paramname"><em>version</em>, </td>
    359. 

  359.         </tr>
    360. 

  360.         <tr>
    361. 

  361.           <td class="paramkey"></td>
    362. 

  362.           <td></td>
    363. 

  363.           <td class="paramtype">char *&#160;</td>
    364. 

  364.           <td class="paramname"><em>id_buf</em>, </td>
    365. 

  365.         </tr>
    366. 

  366.         <tr>
    367. 

  367.           <td class="paramkey"></td>
    368. 

  368.           <td></td>
    369. 

  369.           <td class="paramtype">uint32_t&#160;</td>
    370. 

  370.           <td class="paramname"><em>id_size</em>&#160;</td>
    371. 

  371.         </tr>
    372. 

  372.         <tr>
    373. 

  373.           <td></td>
    374. 

  374.           <td>)</td>
    375. 

  375.           <td></td><td></td>
    376. 

  376.         </tr>
    377. 

  377.       </table>
    378. 

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

  379. <dl class="params"><dt>Parameters</dt><dd>
    380. 

  380.   <table class="params">
    381. 

  381.     <tr><td class="paramdir">[out]</td><td class="paramname">version</td><td>pointer to buffer for retrieving version information. </td></tr>
    382. 

  382.     <tr><td class="paramdir">[out]</td><td class="paramname">id_buf</td><td>pointer to buffer for retrieving kernel identification string. </td></tr>
    383. 

  383.     <tr><td class="paramdir">[in]</td><td class="paramname">id_size</td><td>size of buffer for kernel identification string. </td></tr>
    384. 

  384.   </table>
    385. 

  385.   </dd>
    386. 

  386. </dl>
    387. 

  387. <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
    388. 

  388. <p>The function <b>osKernelGetInfo</b> retrieves the API and kernel version of the underlying RTOS kernel and a human readable identifier string for the kernel. It can be safely called before the RTOS is initialized or started (call to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>).</p>
    389. 

  389. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    390. 

  390. <ul>
    391. 

  391. <li><em>osOK</em> in case of success.</li>
    392. 

  392. <li><em>osError</em> if an unspecific error occurred.</li>
    393. 

  393. </ul>
    394. 

  394. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    395. 

  395. <p><b>Code Example</b> </p>
    396. 

  396. <div class="fragment"><div class="line"><span class="keywordtype">void</span> info (<span class="keywordtype">void</span>) {</div>
    397. 

  397. <div class="line">  <span class="keywordtype">char</span> infobuf[100];</div>
    398. 

  398. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> osv;</div>
    399. 

  399. <div class="line">  osStatus_t status;</div>
    400. 

  400. <div class="line"> </div>
    401. 

  401. <div class="line">  status = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a>(&amp;osv, infobuf, <span class="keyword">sizeof</span>(infobuf));</div>
    402. 

  402. <div class="line">  <span class="keywordflow">if</span>(status == <a class="code" href="cmsis__os2_8h.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f">osOK</a>) {</div>
    403. 

  403. <div class="line">    printf(<span class="stringliteral">&quot;Kernel Information: %s\r\n&quot;</span>, infobuf);</div>
    404. 

  404. <div class="line">    printf(<span class="stringliteral">&quot;Kernel Version    : %d\r\n&quot;</span>, osv.<a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ad8075d3f42141346ae2c56389358f9e7">kernel</a>);</div>
    405. 

  405. <div class="line">    printf(<span class="stringliteral">&quot;Kernel API Version: %d\r\n&quot;</span>, osv.<a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#a76a1ef1a4d3d9bd3e70783051f22a6d3">api</a>);</div>
    406. 

  406. <div class="line">  }</div>
    407. 

  407. <div class="line">}</div>
    408. 

  408. </div><!-- fragment --> 
    409. 

  409. </div>
    410. 

  410. </div>
    411. 

  411. <a class="anchor" id="ga48b69b81012fce051f639be288b243ba"></a>
    412. 

  412. <div class="memitem">
    413. 

  413. <div class="memproto">
    414. 

  414.       <table class="memname">
    415. 

  415.         <tr>
    416. 

  416.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> osKernelGetState </td>
    417. 

  417.           <td>(</td>
    418. 

  418.           <td class="paramtype">void&#160;</td>
    419. 

  419.           <td class="paramname"></td><td>)</td>
    420. 

  420.           <td></td>
    421. 

  421.         </tr>
    422. 

  422.       </table>
    423. 

  423. </div><div class="memdoc">
    424. 

  424. <dl class="section return"><dt>Returns</dt><dd>current RTOS Kernel state.</dd></dl>
    425. 

  425. <p>The function <b>osKernelGetState</b> returns the current state of the kernel and can be safely called before the RTOS is initialized or started (call to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>). In case it fails it will return <code>osKernelError</code>, otherwise it returns the kernel state (refer to <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> for the list of kernel states).</p>
    426. 

  426. <p>Possible <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> return values:</p>
    427. 

  427. <ul>
    428. 

  428. <li><a class="el" href="cmsis__os2_8h.html#ga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a">osKernelError</a> if an unspecific error occurred.</li>
    429. 

  429. <li>the actual kernel state otherwise.</li>
    430. 

  430. </ul>
    431. 

  431. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    432. 

  432. <p><b>Code Example</b> </p>
    433. 

  433. <div class="fragment"><div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
    434. 

  434. <div class="line">  <span class="comment">// System Initialization</span></div>
    435. 

  435. <div class="line">  SystemCoreClockUpdate();</div>
    436. 

  436. <div class="line">  <span class="comment">// ...</span></div>
    437. 

  437. <div class="line">  <span class="keywordflow">if</span>(<a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a>() == <a class="code" href="cmsis__os2_8h.html#ga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995">osKernelInactive</a>) {     <span class="comment">// Is the kernel initialized?</span></div>
    438. 

  438. <div class="line">     <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>();                         <span class="comment">// Initialize CMSIS-RTOS kernel</span></div>
    439. 

  439. <div class="line">  }</div>
    440. 

  440. <div class="line">  ;</div>
    441. 

  441. <div class="line">}</div>
    442. 

  442. </div><!-- fragment --> 
    443. 

  443. </div>
    444. 

  444. </div>
    445. 

  445. <a class="anchor" id="ga9ae2cc00f0d89d7b6a307bba942b5221"></a>
    446. 

  446. <div class="memitem">
    447. 

  447. <div class="memproto">
    448. 

  448.       <table class="memname">
    449. 

  449.         <tr>
    450. 

  450.           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelStart </td>
    451. 

  451.           <td>(</td>
    452. 

  452.           <td class="paramtype">void&#160;</td>
    453. 

  453.           <td class="paramname"></td><td>)</td>
    454. 

  454.           <td></td>
    455. 

  455.         </tr>
    456. 

  456.       </table>
    457. 

  457. </div><div class="memdoc">
    458. 

  458. <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
    459. 

  459. <p>The function <b>osKernelStart</b> starts the RTOS kernel and begins thread switching. It will not return to its calling function in case of success. Before it is successfully executed, only the functions <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a>, <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a>, and object creation functions (<b>osXxxNew</b>) may be called.</p>
    460. 

  460. <p>At least one initial thread should be created prior osKernelStart, see <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>.</p>
    461. 

  461. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    462. 

  462. <ul>
    463. 

  463. <li><em>osError</em> if an unspecific error occurred.</li>
    464. 

  464. <li><em>osErrorISR</em> if called from an <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
    465. 

  465. </ul>
    466. 

  466. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    467. 

  467. <p><b>Code Example</b> </p>
    468. 

  468. <div class="fragment"><div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
    469. 

  469. <div class="line">  <span class="comment">// System Initialization</span></div>
    470. 

  470. <div class="line">  SystemCoreClockUpdate();</div>
    471. 

  471. <div class="line">  <span class="comment">// ...</span></div>
    472. 

  472. <div class="line">  <span class="keywordflow">if</span>(<a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a>() == <a class="code" href="cmsis__os2_8h.html#ga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995">osKernelInactive</a>) {</div>
    473. 

  473. <div class="line">    <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>();</div>
    474. 

  474. <div class="line">  }</div>
    475. 

  475. <div class="line">  ; <span class="comment">// ... Start Threads</span></div>
    476. 

  476. <div class="line">  <span class="keywordflow">if</span> (<a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba">osKernelGetState</a>() == <a class="code" href="cmsis__os2_8h.html#ga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24">osKernelReady</a>) {        <span class="comment">// If kernel is ready to run...</span></div>
    477. 

  477. <div class="line">    <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>();                                <span class="comment">// ... start thread execution</span></div>
    478. 

  478. <div class="line">    }</div>
    479. 

  479. <div class="line">  </div>
    480. 

  480. <div class="line">  <span class="keywordflow">while</span>(1);                                         <span class="comment">// only reached in case of error</span></div>
    481. 

  481. <div class="line">}</div>
    482. 

  482. </div><!-- fragment --> 
    483. 

  483. </div>
    484. 

  484. </div>
    485. 

  485. <a class="anchor" id="ga948609ee930d9b38336b9e1c2a4dfe12"></a>
    486. 

  486. <div class="memitem">
    487. 

  487. <div class="memproto">
    488. 

  488.       <table class="memname">
    489. 

  489.         <tr>
    490. 

  490.           <td class="memname">int32_t osKernelLock </td>
    491. 

  491.           <td>(</td>
    492. 

  492.           <td class="paramtype">void&#160;</td>
    493. 

  493.           <td class="paramname"></td><td>)</td>
    494. 

  494.           <td></td>
    495. 

  495.         </tr>
    496. 

  496.       </table>
    497. 

  497. </div><div class="memdoc">
    498. 

  498. <dl class="section return"><dt>Returns</dt><dd>previous lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
    499. 

  499. <p>The function <b>osKernelLock</b> allows to lock all task switches. It returns the previous value of the lock state (<span class="XML-Token">1</span> if it was locked, <span class="XML-Token">0</span> if it was unlocked), or a negative number representing an error code otherwise (refer to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>).</p>
    500. 

  500. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    501. 

  501. <ul>
    502. 

  502. <li><em>osError</em> if an unspecific error occurred.</li>
    503. 

  503. <li><em>osErrorISR</em> if called from an <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
    504. 

  504. </ul>
    505. 

  505. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    506. 

  506. <p><b>Code Example</b> </p>
    507. 

  507. <div class="fragment"><div class="line">int32_t state = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a>();</div>
    508. 

  508. <div class="line"><span class="comment">// ... critical code</span></div>
    509. 

  509. <div class="line">osKernelRestore(state);</div>
    510. 

  510. </div><!-- fragment --> 
    511. 

  511. </div>
    512. 

  512. </div>
    513. 

  513. <a class="anchor" id="gaf401728b4657456198c33fe75f8d6720"></a>
    514. 

  514. <div class="memitem">
    515. 

  515. <div class="memproto">
    516. 

  516.       <table class="memname">
    517. 

  517.         <tr>
    518. 

  518.           <td class="memname">int32_t osKernelUnlock </td>
    519. 

  519.           <td>(</td>
    520. 

  520.           <td class="paramtype">void&#160;</td>
    521. 

  521.           <td class="paramname"></td><td>)</td>
    522. 

  522.           <td></td>
    523. 

  523.         </tr>
    524. 

  524.       </table>
    525. 

  525. </div><div class="memdoc">
    526. 

  526. <dl class="section return"><dt>Returns</dt><dd>previous lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
    527. 

  527. <p>The function <b>osKernelUnlock</b> resumes from <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a>. It returns the previous value of the lock state (<span class="XML-Token">1</span> if it was locked, <span class="XML-Token">0</span> if it was unlocked), or a negative number representing an error code otherwise (refer to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>).</p>
    528. 

  528. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    529. 

  529. <ul>
    530. 

  530. <li><em>osError</em> if an unspecific error occurred.</li>
    531. 

  531. <li><em>osErrorISR</em> if called from an <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
    532. 

  532. </ul>
    533. 

  533. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    534. 

  534. <p><b>Code Example</b> </p>
    535. 

  535. <div class="fragment"><div class="line">int32_t sl = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a>();</div>
    536. 

  536. <div class="line"><span class="comment">// ... critical code</span></div>
    537. 

  537. <div class="line">{</div>
    538. 

  538. <div class="line">  int32_t su = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>();</div>
    539. 

  539. <div class="line">  <span class="comment">// ... uncritical code</span></div>
    540. 

  540. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a>(su);</div>
    541. 

  541. <div class="line">}</div>
    542. 

  542. <div class="line"><span class="comment">// ... critical code</span></div>
    543. 

  543. <div class="line"><a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a>(sl);</div>
    544. 

  544. </div><!-- fragment --> 
    545. 

  545. </div>
    546. 

  546. </div>
    547. 

  547. <a class="anchor" id="gae7d0a71b9586cbbb49fcbdf6a04f0289"></a>
    548. 

  548. <div class="memitem">
    549. 

  549. <div class="memproto">
    550. 

  550.       <table class="memname">
    551. 

  551.         <tr>
    552. 

  552.           <td class="memname">int32_t osKernelRestoreLock </td>
    553. 

  553.           <td>(</td>
    554. 

  554.           <td class="paramtype">int32_t&#160;</td>
    555. 

  555.           <td class="paramname"><em>lock</em></td><td>)</td>
    556. 

  556.           <td></td>
    557. 

  557.         </tr>
    558. 

  558.       </table>
    559. 

  559. </div><div class="memdoc">
    560. 

  560. <dl class="params"><dt>Parameters</dt><dd>
    561. 

  561.   <table class="params">
    562. 

  562.     <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>lock state obtained by <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>. </td></tr>
    563. 

  563.   </table>
    564. 

  564.   </dd>
    565. 

  565. </dl>
    566. 

  566. <dl class="section return"><dt>Returns</dt><dd>new lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
    567. 

  567. <p>The function <b>osKernelRestoreLock</b> restores the previous lock state after <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>.</p>
    568. 

  568. <p>The argument <em>lock</em> specifies the lock state as obtained by <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a> or <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>.</p>
    569. 

  569. <p>The function returns the new value of the lock state (<span class="XML-Token">1</span> if it was locked, <span class="XML-Token">0</span> if it was unlocked), or a negative number representing an error code otherwise (refer to <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>).</p>
    570. 

  570. <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p>
    571. 

  571. <ul>
    572. 

  572. <li><em>osError</em> if an unspecific error occurred.</li>
    573. 

  573. <li><em>osErrorISR</em> if called from an <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
    574. 

  574. </ul>
    575. 

  575. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    576. 

  576. <p><b>Code Example</b> </p>
    577. 

  577. <div class="fragment"><div class="line">int32_t sl = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a>();</div>
    578. 

  578. <div class="line"><span class="comment">// ... critical code</span></div>
    579. 

  579. <div class="line">{</div>
    580. 

  580. <div class="line">  int32_t su = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a>();</div>
    581. 

  581. <div class="line">  <span class="comment">// ... uncritical code</span></div>
    582. 

  582. <div class="line">  <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a>(su);</div>
    583. 

  583. <div class="line">}</div>
    584. 

  584. <div class="line"><span class="comment">// ... critical code</span></div>
    585. 

  585. <div class="line"><a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a>(sl);</div>
    586. 

  586. </div><!-- fragment --> 
    587. 

  587. </div>
    588. 

  588. </div>
    589. 

  589. <a class="anchor" id="gae26683e1606ec633354a2876c68f0c1f"></a>
    590. 

  590. <div class="memitem">
    591. 

  591. <div class="memproto">
    592. 

  592.       <table class="memname">
    593. 

  593.         <tr>
    594. 

  594.           <td class="memname">uint32_t osKernelSuspend </td>
    595. 

  595.           <td>(</td>
    596. 

  596.           <td class="paramtype">void&#160;</td>
    597. 

  597.           <td class="paramname"></td><td>)</td>
    598. 

  598.           <td></td>
    599. 

  599.         </tr>
    600. 

  600.       </table>
    601. 

  601. </div><div class="memdoc">
    602. 

  602. <dl class="section return"><dt>Returns</dt><dd>time in ticks, for how long the system can sleep or power-down.</dd></dl>
    603. 

  603. <p>CMSIS-RTOS provides extension for tick-less operation which is useful for applications that use extensively low-power modes where the SysTick timer is also disabled. To provide a time-tick in such power-saving modes a wake-up timer is used to derive timer intervals. The function <b>osKernelSuspend</b> suspends the RTX kernel scheduler and thus enables sleep modes.</p>
    604. 

  604. <p>The return value can be used to determine the amount of system ticks until the next tick-based kernel event will occure, i.e. a delayed thread becomed ready again. It is recommended to set up the low power timer to generate a wake-up interrupt based on this return value.</p>
    605. 

  605. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    606. 

  606. <p><b>Code Example</b> </p>
    607. 

  607. <div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="group__rtx5__specific__functions.html#ga074068b8efa7074cee68a71481d0b072">osRtxIdleThread</a> (<span class="keywordtype">void</span>) {</div>
    608. 

  608. <div class="line">                                               <span class="comment">/* The idle thread is running</span></div>
    609. 

  609. <div class="line"><span class="comment">                                                  when no other thread is ready</span></div>
    610. 

  610. <div class="line"><span class="comment">                                                  to run.                      */</span></div>
    611. 

  611. <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sleep;</div>
    612. 

  612. <div class="line"> </div>
    613. 

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

  614. <div class="line">                                               <span class="comment">/* HERE: include optional user</span></div>
    615. 

  615. <div class="line"><span class="comment">                                                  code to be executed when no</span></div>
    616. 

  616. <div class="line"><span class="comment">                                                  task runs.                   */</span></div>
    617. 

  617. <div class="line">    sleep = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a>();                 <span class="comment">/* Suspend RTX thread scheduler */</span></div>
    618. 

  618. <div class="line"> </div>
    619. 

  619. <div class="line">    <span class="keywordflow">if</span> (sleep) {                               <span class="comment">/* How long can we sleep?       */</span></div>
    620. 

  620. <div class="line">                                               <span class="comment">/* &quot;sleep&quot; is in RTX Timer Ticks</span></div>
    621. 

  621. <div class="line"><span class="comment">                                                  which is 1ms in this</span></div>
    622. 

  622. <div class="line"><span class="comment">                                                  configuration                */</span></div>
    623. 

  623. <div class="line">       </div>
    624. 

  624. <div class="line">                                               <span class="comment">/* Setup wake-up e.g. watchdog  */</span></div>
    625. 

  625. <div class="line"> </div>
    626. 

  626. <div class="line">      __WFE();                                 <span class="comment">/* Enter Power-down mode        */</span></div>
    627. 

  627. <div class="line">      </div>
    628. 

  628. <div class="line">                                               <span class="comment">/* After Wake-up                */</span></div>
    629. 

  629. <div class="line">      sleep = tc;                              <span class="comment">/* Adjust with cycles slept     */</span>  </div>
    630. 

  630. <div class="line">    }</div>
    631. 

  631. <div class="line"> </div>
    632. 

  632. <div class="line">    <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a>(sleep);                     <span class="comment">/* Resume thread scheduler      */</span></div>
    633. 

  633. <div class="line">  }</div>
    634. 

  634. <div class="line">}</div>
    635. 

  635. </div><!-- fragment --> 
    636. 

  636. </div>
    637. 

  637. </div>
    638. 

  638. <a class="anchor" id="ga8c4b4d7ed34cab73c001665d9176aced"></a>
    639. 

  639. <div class="memitem">
    640. 

  640. <div class="memproto">
    641. 

  641.       <table class="memname">
    642. 

  642.         <tr>
    643. 

  643.           <td class="memname">void osKernelResume </td>
    644. 

  644.           <td>(</td>
    645. 

  645.           <td class="paramtype">uint32_t&#160;</td>
    646. 

  646.           <td class="paramname"><em>sleep_ticks</em></td><td>)</td>
    647. 

  647.           <td></td>
    648. 

  648.         </tr>
    649. 

  649.       </table>
    650. 

  650. </div><div class="memdoc">
    651. 

  651. <dl class="params"><dt>Parameters</dt><dd>
    652. 

  652.   <table class="params">
    653. 

  653.     <tr><td class="paramdir">[in]</td><td class="paramname">sleep_ticks</td><td>time in ticks for how long the system was in sleep or power-down mode.</td></tr>
    654. 

  654.   </table>
    655. 

  655.   </dd>
    656. 

  656. </dl>
    657. 

  657. <p>CMSIS-RTOS provides extension for tick-less operation which is useful for applications that use extensively low-power modes where the SysTick timer is also disabled. To provide a time-tick in such power-saving modes a wake-up timer is used to derive timer intervals. The function <b>osKernelResume</b> enables the RTX kernel scheduler and thus wakes up the system from sleep mode.</p>
    658. 

  658. <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    659. 

  659. <p><b>Code Example</b> </p>
    660. 

  660. <div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="group__rtx5__specific__functions.html#ga074068b8efa7074cee68a71481d0b072">osRtxIdleThread</a> (<span class="keywordtype">void</span>) {</div>
    661. 

  661. <div class="line">                                               <span class="comment">/* The idle thread is running</span></div>
    662. 

  662. <div class="line"><span class="comment">                                                  when no other thread is ready</span></div>
    663. 

  663. <div class="line"><span class="comment">                                                  to run.                      */</span></div>
    664. 

  664. <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sleep;</div>
    665. 

  665. <div class="line"> </div>
    666. 

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

  667. <div class="line">                                               <span class="comment">/* HERE: include optional user</span></div>
    668. 

  668. <div class="line"><span class="comment">                                                  code to be executed when no</span></div>
    669. 

  669. <div class="line"><span class="comment">                                                  task runs.                   */</span></div>
    670. 

  670. <div class="line">    sleep = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a>();                 <span class="comment">/* Suspend RTX thread scheduler */</span></div>
    671. 

  671. <div class="line"> </div>
    672. 

  672. <div class="line">    <span class="keywordflow">if</span> (sleep) {                               <span class="comment">/* How long can we sleep?       */</span></div>
    673. 

  673. <div class="line">                                               <span class="comment">/* &quot;sleep&quot; is in RTX Timer Ticks</span></div>
    674. 

  674. <div class="line"><span class="comment">                                                  which is 1ms in this</span></div>
    675. 

  675. <div class="line"><span class="comment">                                                  configuration                */</span></div>
    676. 

  676. <div class="line">       </div>
    677. 

  677. <div class="line">                                               <span class="comment">/* Setup wake-up e.g. watchdog  */</span></div>
    678. 

  678. <div class="line"> </div>
    679. 

  679. <div class="line">      __WFE();                                 <span class="comment">/* Enter Power-down mode        */</span></div>
    680. 

  680. <div class="line">      </div>
    681. 

  681. <div class="line">                                               <span class="comment">/* After Wake-up                */</span></div>
    682. 

  682. <div class="line">      sleep = tc;                              <span class="comment">/* Adjust with cycles slept     */</span>  </div>
    683. 

  683. <div class="line">    }</div>
    684. 

  684. <div class="line"> </div>
    685. 

  685. <div class="line">    <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a>(sleep);                     <span class="comment">/* Resume thread scheduler      */</span></div>
    686. 

  686. <div class="line">  }</div>
    687. 

  687. <div class="line">}</div>
    688. 

  688. </div><!-- fragment --> 
    689. 

  689. </div>
    690. 

  690. </div>
    691. 

  691. <a class="anchor" id="ga84bcdbf2fb76b10c8df4e439f0c7e11b"></a>
    692. 

  692. <div class="memitem">
    693. 

  693. <div class="memproto">
    694. 

  694.       <table class="memname">
    695. 

  695.         <tr>
    696. 

  696.           <td class="memname">uint32_t osKernelGetTickCount </td>
    697. 

  697.           <td>(</td>
    698. 

  698.           <td class="paramtype">void&#160;</td>
    699. 

  699.           <td class="paramname"></td><td>)</td>
    700. 

  700.           <td></td>
    701. 

  701.         </tr>
    702. 

  702.       </table>
    703. 

  703. </div><div class="memdoc">
    704. 

  704. <dl class="section return"><dt>Returns</dt><dd>RTOS kernel current tick count.</dd></dl>
    705. 

  705. <p>The function <b>osKernelGetTickCount</b> returns the current RTOS kernel tick count.</p>
    706. 

  706. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
    707. 

  707. <p><b>Code</b> <b>Example</b> </p>
    708. 

  708. <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>
    709. 

  709. <div class="line"> </div>
    710. 

  710. <div class="line"><span class="keywordtype">void</span> Thread_1 (<span class="keywordtype">void</span> *arg)  {                <span class="comment">// Thread function</span></div>
    711. 

  711. <div class="line">  uint32_t tick;</div>
    712. 

  712. <div class="line"></div>
    713. 

  713. <div class="line">  tick = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b">osKernelGetTickCount</a>();            <span class="comment">// retrieve the number of system ticks</span></div>
    714. 

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

  715. <div class="line">    tick += 1000;                           <span class="comment">// delay 1000 ticks periodically</span></div>
    716. 

  716. <div class="line">    <a class="code" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1">osDelayUntil</a>(tick);</div>
    717. 

  717. <div class="line">    <span class="comment">// ...</span></div>
    718. 

  718. <div class="line">  }</div>
    719. 

  719. <div class="line">}</div>
    720. 

  720. </div><!-- fragment --><p>Due to the limited value range used for the tick count it may overflow during runtime, i.e. after 2<sup>32</sup> ticks which are roughly 49days @ 1ms. Typically one has not to take special care of this unless a monotonic counter is needed. For such a case an additional 64bit tick counter can be implemented as follows. The given example needs GetTick() called at least twice per tick overflow to work properly.</p>
    721. 

  721. <p><b>Code</b> <b>Example</b> </p>
    722. 

  722. <div class="fragment"><div class="line">uint64_t GetTick(<span class="keywordtype">void</span>) {</div>
    723. 

  723. <div class="line">  <span class="keyword">static</span> uint32_t tick_h = 0U;</div>
    724. 

  724. <div class="line">  <span class="keyword">static</span> uint32_t tick_l = 0U;</div>
    725. 

  725. <div class="line">         uint32_t tick;</div>
    726. 

  726. <div class="line"></div>
    727. 

  727. <div class="line">  tick = <a class="code" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b">osKernelGetTickCount</a>();</div>
    728. 

  728. <div class="line">  <span class="keywordflow">if</span> (tick &lt; tick_l) {</div>
    729. 

  729. <div class="line">    tick_h++;</div>
    730. 

  730. <div class="line">  }</div>
    731. 

  731. <div class="line">  tick_l = tick;</div>
    732. 

  732. <div class="line"></div>
    733. 

  733. <div class="line">  <span class="keywordflow">return</span> (((uint64_t)tick_h &lt;&lt; 32) | tick_l);</div>
    734. 

  734. <div class="line">}</div>
    735. 

  735. </div><!-- fragment --> 
    736. 

  736. </div>
    737. 

  737. </div>
    738. 

  738. <a class="anchor" id="ga7a8d7bd927eaaa58999f91d7d6310cee"></a>
    739. 

  739. <div class="memitem">
    740. 

  740. <div class="memproto">
    741. 

  741.       <table class="memname">
    742. 

  742.         <tr>
    743. 

  743.           <td class="memname">uint32_t osKernelGetTickFreq </td>
    744. 

  744.           <td>(</td>
    745. 

  745.           <td class="paramtype">void&#160;</td>
    746. 

  746.           <td class="paramname"></td><td>)</td>
    747. 

  747.           <td></td>
    748. 

  748.         </tr>
    749. 

  749.       </table>
    750. 

  750. </div><div class="memdoc">
    751. 

  751. <dl class="section return"><dt>Returns</dt><dd>frequency of the kernel tick in hertz, i.e. kernel ticks per second.</dd></dl>
    752. 

  752. <p>The function <b>osKernelGetTickFreq</b> returns the frequency of the current RTOS kernel tick.</p>
    753. 

  753. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
    754. 

  754. 

  755. </div>
    756. 

  756. </div>
    757. 

  757. <a class="anchor" id="gae0fcaff6cecfb4013bb556c87afcd7d2"></a>
    758. 

  758. <div class="memitem">
    759. 

  759. <div class="memproto">
    760. 

  760.       <table class="memname">
    761. 

  761.         <tr>
    762. 

  762.           <td class="memname">uint32_t osKernelGetSysTimerCount </td>
    763. 

  763.           <td>(</td>
    764. 

  764.           <td class="paramtype">void&#160;</td>
    765. 

  765.           <td class="paramname"></td><td>)</td>
    766. 

  766.           <td></td>
    767. 

  767.         </tr>
    768. 

  768.       </table>
    769. 

  769. </div><div class="memdoc">
    770. 

  770. <dl class="section return"><dt>Returns</dt><dd>RTOS kernel current system timer count as 32-bit value.</dd></dl>
    771. 

  771. <p>The function <b>osKernelGetSysTimerCount</b> returns the current RTOS kernel system timer as a 32-bit value.</p>
    772. 

  772. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
    773. 

  773. 

  774. </div>
    775. 

  775. </div>
    776. 

  776. <a class="anchor" id="ga4d69215a93220f72be3684cad582f16a"></a>
    777. 

  777. <div class="memitem">
    778. 

  778. <div class="memproto">
    779. 

  779.       <table class="memname">
    780. 

  780.         <tr>
    781. 

  781.           <td class="memname">uint32_t osKernelGetSysTimerFreq </td>
    782. 

  782.           <td>(</td>
    783. 

  783.           <td class="paramtype">void&#160;</td>
    784. 

  784.           <td class="paramname"></td><td>)</td>
    785. 

  785.           <td></td>
    786. 

  786.         </tr>
    787. 

  787.       </table>
    788. 

  788. </div><div class="memdoc">
    789. 

  789. <dl class="section return"><dt>Returns</dt><dd>frequency of the system timer in hertz, i.e. timer ticks per second.</dd></dl>
    790. 

  790. <p>The function <b>osKernelGetSysTimerFreq</b> returns the frequency of the current RTOS kernel system timer.</p>
    791. 

  791. <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="theory_of_operation.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
    792. 

  792. 

  793. </div>
    794. 

  794. </div>
    795. 

  795. </div><!-- contents -->
    796. 

  796. </div><!-- doc-content -->
    797. 

  797. <!-- start footer part -->
    798. 

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

  799.   <ul>
    800. 

  800.     <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
    801. 

  801. 	<!--
    802. 

  802.     <a href="http://www.doxygen.org/index.html">
    803. 

  803.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    804. 

  804. 	-->
    805. 

  805. 	</li>
    806. 

  806.   </ul>
    807. 

  807. </div>
    808. 

  808. </body>
    809. 

  809. </html>
    810.