begriffs open source - cmsis/blob - main/RTOS2/group__CMSIS__RTOS__KernelCtrl.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-RTOS2: Kernel Information and Control</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-RTOS2
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">Real-Time Operating System API</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__KernelCtrl.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#nested-classes">Data Structures</a> &#124;
 129 <a href="#enum-members">Enumerations</a> &#124;
 130 <a href="#func-members">Functions</a>  </div>
 131   <div class="headertitle"><div class="title">Kernel Information and Control<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS2 API</a></div></div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Provides version/system information and starts/controls the RTOS Kernel.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 139 Data Structures</h2></td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:structosVersion__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table><table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 145 Enumerations</h2></td></tr>
 146 <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 />
 147 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995">osKernelInactive</a> = 0
 148 , <br />
 149 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24">osKernelReady</a> = 1
 150 , <br />
 151 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a8e0b699fbe1c8bb66fefadd5911cb6ce">osKernelRunning</a> = 2
 152 , <br />
 153 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a2fe382ad5ebab2257b35740414b28b01">osKernelLocked</a> = 3
 154 , <br />
 155 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4ad364464ad84d63b1413a9ac8a962390c">osKernelSuspended</a> = 4
 156 , <br />
 157 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a">osKernelError</a> = -1
 158 , <br />
 159 &#160;&#160;<a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4ab0a47576defa29396a649d9173d4bc4b">osKernelReserved</a> = 0x7FFFFFFF
 160 <br />
 161  }</td></tr>
 162 <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>
 163 <tr class="separator:ga08326469274b668140ca934b168a5ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 </table><table class="memberdecls">
 165 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 166 Functions</h2></td></tr>
 167 <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>
 168 <tr class="memdesc:gae818f6611d25ba3140bede410a52d659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the RTOS Kernel.  <br /></td></tr>
 169 <tr class="separator:gae818f6611d25ba3140bede410a52d659"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <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>
 171 <tr class="memdesc:ga6f7764e7250c5c5364c00c45a5d1d199"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get RTOS Kernel Information.  <br /></td></tr>
 172 <tr class="separator:ga6f7764e7250c5c5364c00c45a5d1d199"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <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>
 174 <tr class="memdesc:ga48b69b81012fce051f639be288b243ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current RTOS Kernel state.  <br /></td></tr>
 175 <tr class="separator:ga48b69b81012fce051f639be288b243ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <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>
 177 <tr class="memdesc:ga9ae2cc00f0d89d7b6a307bba942b5221"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the RTOS Kernel scheduler.  <br /></td></tr>
 178 <tr class="separator:ga9ae2cc00f0d89d7b6a307bba942b5221"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <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>
 180 <tr class="memdesc:ga948609ee930d9b38336b9e1c2a4dfe12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock the RTOS Kernel scheduler.  <br /></td></tr>
 181 <tr class="separator:ga948609ee930d9b38336b9e1c2a4dfe12"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <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>
 183 <tr class="memdesc:gaf401728b4657456198c33fe75f8d6720"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlock the RTOS Kernel scheduler.  <br /></td></tr>
 184 <tr class="separator:gaf401728b4657456198c33fe75f8d6720"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <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>
 186 <tr class="memdesc:gae7d0a71b9586cbbb49fcbdf6a04f0289"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the RTOS Kernel scheduler lock state.  <br /></td></tr>
 187 <tr class="separator:gae7d0a71b9586cbbb49fcbdf6a04f0289"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 <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>
 189 <tr class="memdesc:gae26683e1606ec633354a2876c68f0c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the RTOS Kernel scheduler.  <br /></td></tr>
 190 <tr class="separator:gae26683e1606ec633354a2876c68f0c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <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>
 192 <tr class="memdesc:ga8c4b4d7ed34cab73c001665d9176aced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume the RTOS Kernel scheduler.  <br /></td></tr>
 193 <tr class="separator:ga8c4b4d7ed34cab73c001665d9176aced"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 <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>
 195 <tr class="memdesc:ga84bcdbf2fb76b10c8df4e439f0c7e11b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel tick count.  <br /></td></tr>
 196 <tr class="separator:ga84bcdbf2fb76b10c8df4e439f0c7e11b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 <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>
 198 <tr class="memdesc:ga7a8d7bd927eaaa58999f91d7d6310cee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel tick frequency.  <br /></td></tr>
 199 <tr class="separator:ga7a8d7bd927eaaa58999f91d7d6310cee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 <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>
 201 <tr class="memdesc:gae0fcaff6cecfb4013bb556c87afcd7d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel system timer count.  <br /></td></tr>
 202 <tr class="separator:gae0fcaff6cecfb4013bb556c87afcd7d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 <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>
 204 <tr class="memdesc:ga4d69215a93220f72be3684cad582f16a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTOS kernel system timer frequency.  <br /></td></tr>
 205 <tr class="separator:ga4d69215a93220f72be3684cad582f16a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 206 <tr class="memitem:gac7e3b012c15c55bda68e0dd96ad9cd72"><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#gac7e3b012c15c55bda68e0dd96ad9cd72">osKernelProtect</a> (uint32_t safety_class)</td></tr>
 207 <tr class="memdesc:gac7e3b012c15c55bda68e0dd96ad9cd72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protect the RTOS Kernel scheduler access.  <br /></td></tr>
 208 <tr class="separator:gac7e3b012c15c55bda68e0dd96ad9cd72"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 <tr class="memitem:ga2065364d1bc805a40e749430377df1e1"><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#ga2065364d1bc805a40e749430377df1e1">osKernelDestroyClass</a> (uint32_t safety_class, uint32_t mode)</td></tr>
 210 <tr class="memdesc:ga2065364d1bc805a40e749430377df1e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy objects for specified safety classes.  <br /></td></tr>
 211 <tr class="separator:ga2065364d1bc805a40e749430377df1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 212 <tr class="memitem:ga91b400b21a9093f7751fc45613c12110"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga91b400b21a9093f7751fc45613c12110">osFaultResume</a> (void)</td></tr>
 213 <tr class="memdesc:ga91b400b21a9093f7751fc45613c12110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume normal operation when exiting exception faults.  <br /></td></tr>
 214 <tr class="separator:ga91b400b21a9093f7751fc45613c12110"><td class="memSeparator" colspan="2">&#160;</td></tr>
 215 </table>
 216 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 217 <p>Provides version/system information and starts/controls the RTOS Kernel. </p>
 218 <p>The kernel Information and Control function group allows to:</p><ul>
 219 <li>obtain information about the system and the underlying kernel.</li>
 220 <li>obtain version information about the CMSIS-RTOS API.</li>
 221 <li>initialize of the RTOS kernel for creating objects.</li>
 222 <li>start the RTOS kernel and thread switching.</li>
 223 <li>check the execution status of the RTOS kernel.</li>
 224 </ul>
 225 <dl class="section note"><dt>Note</dt><dd>The kernel information and control functions cannot be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd>
 226 <dd>
 227 The kernel initialization is documented in <a class="el" href="usingOS2.html#SystemStartup">System Startup</a>.</dd></dl>
 228 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 229 <div class="line"><span class="comment"> * Application main thread</span></div>
 230 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 231 <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
 232 <div class="line"> </div>
 233 <div class="line">  <span class="comment">// ...</span></div>
 234 <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
 235 <div class="line">}</div>
 236 <div class="line"> </div>
 237 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 238 <div class="line"> </div>
 239 <div class="line">  <span class="comment">// System Initialization</span></div>
 240 <div class="line">  SystemCoreClockUpdate();</div>
 241 <div class="line">  <span class="comment">// ...</span></div>
 242 <div class="line"> </div>
 243 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659" title="Initialize the RTOS Kernel.">osKernelInitialize</a>();                 <span class="comment">// Initialize CMSIS-RTOS</span></div>
 244 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads.">osThreadNew</a>(app_main, NULL, NULL);    <span class="comment">// Create application main thread</span></div>
 245 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221" title="Start the RTOS Kernel scheduler.">osKernelStart</a>();                      <span class="comment">// Start thread execution</span></div>
 246 <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
 247 <div class="line">}</div>
 248 </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 249 <a name="structosVersion__t" id="structosVersion__t"></a>
 250 <h2 class="memtitle"><span class="permalink"><a href="#structosVersion__t">&#9670;&#160;</a></span>osVersion_t</h2>
 251
 252 <div class="memitem">
 253 <div class="memproto">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">struct osVersion_t</td>
 257         </tr>
 258       </table>
 259 </div><div class="memdoc">
 260 <div class="textblock"><p>Version information. </p>
 261 <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>
 262 <p>Use <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199">osKernelGetInfo</a> to retrieve the version numbers. </p>
 263 </div><table class="fieldtable">
 264 <tr><th colspan="3">Data Fields</th></tr>
 265 <tr><td class="fieldtype">
 266 <a id="a76a1ef1a4d3d9bd3e70783051f22a6d3" name="a76a1ef1a4d3d9bd3e70783051f22a6d3"></a>uint32_t</td>
 267 <td class="fieldname">
 268 api</td>
 269 <td class="fielddoc">
 270 API version (major.minor.rev: mmnnnrrrr dec). </td></tr>
 271 <tr><td class="fieldtype">
 272 <a id="ad8075d3f42141346ae2c56389358f9e7" name="ad8075d3f42141346ae2c56389358f9e7"></a>uint32_t</td>
 273 <td class="fieldname">
 274 kernel</td>
 275 <td class="fielddoc">
 276 Kernel version (major.minor.rev: mmnnnrrrr dec). </td></tr>
 277 </table>
 278
 279 </div>
 280 </div>
 281 <h2 class="groupheader">Enumeration Type Documentation</h2>
 282 <a id="ga08326469274b668140ca934b168a5ad4" name="ga08326469274b668140ca934b168a5ad4"></a>
 283 <h2 class="memtitle"><span class="permalink"><a href="#ga08326469274b668140ca934b168a5ad4">&#9670;&#160;</a></span>osKernelState_t</h2>
 284
 285 <div class="memitem">
 286 <div class="memproto">
 287       <table class="memname">
 288         <tr>
 289           <td class="memname">enum <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a></td>
 290         </tr>
 291       </table>
 292 </div><div class="memdoc">
 293
 294 <p>Kernel state. </p>
 295 <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>
 296 <table class="fieldtable">
 297 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995" name="gga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995"></a>osKernelInactive&#160;</td><td class="fielddoc"><p>Inactive. </p>
 298 <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>
 299 </td></tr>
 300 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24" name="gga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24"></a>osKernelReady&#160;</td><td class="fielddoc"><p>Ready. </p>
 301 <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>
 302 </td></tr>
 303 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4a8e0b699fbe1c8bb66fefadd5911cb6ce" name="gga08326469274b668140ca934b168a5ad4a8e0b699fbe1c8bb66fefadd5911cb6ce"></a>osKernelRunning&#160;</td><td class="fielddoc"><p>Running. </p>
 304 <p>The kernel is initialized and running. </p>
 305 </td></tr>
 306 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4a2fe382ad5ebab2257b35740414b28b01" name="gga08326469274b668140ca934b168a5ad4a2fe382ad5ebab2257b35740414b28b01"></a>osKernelLocked&#160;</td><td class="fielddoc"><p>Locked. </p>
 307 <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>
 308 </td></tr>
 309 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4ad364464ad84d63b1413a9ac8a962390c" name="gga08326469274b668140ca934b168a5ad4ad364464ad84d63b1413a9ac8a962390c"></a>osKernelSuspended&#160;</td><td class="fielddoc"><p>Suspended. </p>
 310 <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>
 311 </td></tr>
 312 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a" name="gga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a"></a>osKernelError&#160;</td><td class="fielddoc"><p>Error. </p>
 313 <p>An error occurred. </p>
 314 </td></tr>
 315 <tr><td class="fieldname"><a id="gga08326469274b668140ca934b168a5ad4ab0a47576defa29396a649d9173d4bc4b" name="gga08326469274b668140ca934b168a5ad4ab0a47576defa29396a649d9173d4bc4b"></a>osKernelReserved&#160;</td><td class="fielddoc"><p>Prevents enum down-size compiler optimization. </p>
 316 <p>Reserved. </p>
 317 </td></tr>
 318 </table>
 319
 320 </div>
 321 </div>
 322 <h2 class="groupheader">Function Documentation</h2>
 323 <a id="gae818f6611d25ba3140bede410a52d659" name="gae818f6611d25ba3140bede410a52d659"></a>
 324 <h2 class="memtitle"><span class="permalink"><a href="#gae818f6611d25ba3140bede410a52d659">&#9670;&#160;</a></span>osKernelInitialize()</h2>
 325
 326 <div class="memitem">
 327 <div class="memproto">
 328       <table class="memname">
 329         <tr>
 330           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelInitialize </td>
 331           <td>(</td>
 332           <td class="paramtype">void&#160;</td>
 333           <td class="paramname"></td><td>)</td>
 334           <td></td>
 335         </tr>
 336       </table>
 337 </div><div class="memdoc">
 338
 339 <p>Initialize the RTOS Kernel. </p>
 340 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 341 <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>
 342 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 343 <li><em>osOK</em> in case of success.</li>
 344 <li><em>osError</em> if an unspecific error occurred.</li>
 345 <li><em>osErrorISR</em> if called from an <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
 346 <li><em>osErrorNoMemory</em> if no memory could be reserved for the operation.</li>
 347 </ul>
 348 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 349 <p><b> Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;RTE_Components.h&quot;</span></div>
 350 <div class="line"><span class="preprocessor">#include  CMSIS_device_header</span></div>
 351 <div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 352 <div class="line"> </div>
 353 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 354 <div class="line"><span class="comment"> * Application main thread</span></div>
 355 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 356 <div class="line"><span class="keywordtype">void</span> app_main (<span class="keywordtype">void</span> *argument) {</div>
 357 <div class="line"> </div>
 358 <div class="line">  <span class="comment">// ...</span></div>
 359 <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
 360 <div class="line">}</div>
 361 <div class="line"> </div>
 362 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 363 <div class="line"> </div>
 364 <div class="line">  <span class="comment">// System Initialization</span></div>
 365 <div class="line">  SystemCoreClockUpdate();</div>
 366 <div class="line">  <span class="comment">// ...</span></div>
 367 <div class="line"> </div>
 368 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659" title="Initialize the RTOS Kernel.">osKernelInitialize</a>();                 <span class="comment">// Initialize CMSIS-RTOS</span></div>
 369 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads.">osThreadNew</a>(app_main, NULL, NULL);    <span class="comment">// Create application main thread</span></div>
 370 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221" title="Start the RTOS Kernel scheduler.">osKernelStart</a>();                      <span class="comment">// Start thread execution</span></div>
 371 <div class="line">  <span class="keywordflow">for</span> (;;) {}</div>
 372 <div class="line">}</div>
 373 </div><!-- fragment -->
 374 </div>
 375 </div>
 376 <a id="ga6f7764e7250c5c5364c00c45a5d1d199" name="ga6f7764e7250c5c5364c00c45a5d1d199"></a>
 377 <h2 class="memtitle"><span class="permalink"><a href="#ga6f7764e7250c5c5364c00c45a5d1d199">&#9670;&#160;</a></span>osKernelGetInfo()</h2>
 378
 379 <div class="memitem">
 380 <div class="memproto">
 381       <table class="memname">
 382         <tr>
 383           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelGetInfo </td>
 384           <td>(</td>
 385           <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t">osVersion_t</a> *&#160;</td>
 386           <td class="paramname"><em>version</em>, </td>
 387         </tr>
 388         <tr>
 389           <td class="paramkey"></td>
 390           <td></td>
 391           <td class="paramtype">char *&#160;</td>
 392           <td class="paramname"><em>id_buf</em>, </td>
 393         </tr>
 394         <tr>
 395           <td class="paramkey"></td>
 396           <td></td>
 397           <td class="paramtype">uint32_t&#160;</td>
 398           <td class="paramname"><em>id_size</em>&#160;</td>
 399         </tr>
 400         <tr>
 401           <td></td>
 402           <td>)</td>
 403           <td></td><td></td>
 404         </tr>
 405       </table>
 406 </div><div class="memdoc">
 407
 408 <p>Get RTOS Kernel Information. </p>
 409 <dl class="params"><dt>Parameters</dt><dd>
 410   <table class="params">
 411     <tr><td class="paramdir">[out]</td><td class="paramname">version</td><td>pointer to buffer for retrieving version information. </td></tr>
 412     <tr><td class="paramdir">[out]</td><td class="paramname">id_buf</td><td>pointer to buffer for retrieving kernel identification string. </td></tr>
 413     <tr><td class="paramdir">[in]</td><td class="paramname">id_size</td><td>size of buffer for kernel identification string. </td></tr>
 414   </table>
 415   </dd>
 416 </dl>
 417 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 418 <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>
 419 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 420 <li><em>osOK</em> in case of success.</li>
 421 <li><em>osError</em> if an unspecific error occurred.</li>
 422 </ul>
 423 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 424 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> info (<span class="keywordtype">void</span>) {</div>
 425 <div class="line">  <span class="keywordtype">char</span> infobuf[100];</div>
 426 <div class="line">  <a class="code hl_struct" href="group__CMSIS__RTOS__KernelCtrl.html#structosVersion__t" title="Version information.">osVersion_t</a> osv;</div>
 427 <div class="line">  <a class="code hl_enumeration" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions.">osStatus_t</a> status;</div>
 428 <div class="line"> </div>
 429 <div class="line">  status = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga6f7764e7250c5c5364c00c45a5d1d199" title="Get RTOS Kernel Information.">osKernelGetInfo</a>(&amp;osv, infobuf, <span class="keyword">sizeof</span>(infobuf));</div>
 430 <div class="line">  <span class="keywordflow">if</span>(status == <a class="code hl_enumvalue" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda" title="Operation completed successfully.">osOK</a>) {</div>
 431 <div class="line">    printf(<span class="stringliteral">&quot;Kernel Information: %s\r\n&quot;</span>, infobuf);</div>
 432 <div class="line">    printf(<span class="stringliteral">&quot;Kernel Version    : %d\r\n&quot;</span>, osv.<a class="code hl_variable" href="group__CMSIS__RTOS__KernelCtrl.html#ad8075d3f42141346ae2c56389358f9e7" title="Kernel version (major.minor.rev: mmnnnrrrr dec).">kernel</a>);</div>
 433 <div class="line">    printf(<span class="stringliteral">&quot;Kernel API Version: %d\r\n&quot;</span>, osv.<a class="code hl_variable" href="group__CMSIS__RTOS__KernelCtrl.html#a76a1ef1a4d3d9bd3e70783051f22a6d3" title="API version (major.minor.rev: mmnnnrrrr dec).">api</a>);</div>
 434 <div class="line">  }</div>
 435 <div class="line">}</div>
 436 </div><!-- fragment -->
 437 </div>
 438 </div>
 439 <a id="ga48b69b81012fce051f639be288b243ba" name="ga48b69b81012fce051f639be288b243ba"></a>
 440 <h2 class="memtitle"><span class="permalink"><a href="#ga48b69b81012fce051f639be288b243ba">&#9670;&#160;</a></span>osKernelGetState()</h2>
 441
 442 <div class="memitem">
 443 <div class="memproto">
 444       <table class="memname">
 445         <tr>
 446           <td class="memname"><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> osKernelGetState </td>
 447           <td>(</td>
 448           <td class="paramtype">void&#160;</td>
 449           <td class="paramname"></td><td>)</td>
 450           <td></td>
 451         </tr>
 452       </table>
 453 </div><div class="memdoc">
 454
 455 <p>Get the current RTOS Kernel state. </p>
 456 <dl class="section return"><dt>Returns</dt><dd>current RTOS Kernel state.</dd></dl>
 457 <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>
 458 <p>Possible <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga08326469274b668140ca934b168a5ad4">osKernelState_t</a> return values:</p><ul>
 459 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a0545c92c18ce8e6b24e82a0d694a0b4a">osKernelError</a> if an unspecific error occurred.</li>
 460 <li>the actual kernel state otherwise.</li>
 461 </ul>
 462 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 463 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 464 <div class="line">  <span class="comment">// System Initialization</span></div>
 465 <div class="line">  SystemCoreClockUpdate();</div>
 466 <div class="line">  <span class="comment">// ...</span></div>
 467 <div class="line">  <span class="keywordflow">if</span>(<a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba" title="Get the current RTOS Kernel state.">osKernelGetState</a>() == <a class="code hl_enumvalue" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995" title="Inactive.">osKernelInactive</a>) {     <span class="comment">// Is the kernel initialized?</span></div>
 468 <div class="line">     <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659" title="Initialize the RTOS Kernel.">osKernelInitialize</a>();                         <span class="comment">// Initialize CMSIS-RTOS kernel</span></div>
 469 <div class="line">  }</div>
 470 <div class="line">  ;</div>
 471 <div class="line">}</div>
 472 </div><!-- fragment -->
 473 </div>
 474 </div>
 475 <a id="ga9ae2cc00f0d89d7b6a307bba942b5221" name="ga9ae2cc00f0d89d7b6a307bba942b5221"></a>
 476 <h2 class="memtitle"><span class="permalink"><a href="#ga9ae2cc00f0d89d7b6a307bba942b5221">&#9670;&#160;</a></span>osKernelStart()</h2>
 477
 478 <div class="memitem">
 479 <div class="memproto">
 480       <table class="memname">
 481         <tr>
 482           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelStart </td>
 483           <td>(</td>
 484           <td class="paramtype">void&#160;</td>
 485           <td class="paramname"></td><td>)</td>
 486           <td></td>
 487         </tr>
 488       </table>
 489 </div><div class="memdoc">
 490
 491 <p>Start the RTOS Kernel scheduler. </p>
 492 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 493 <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>
 494 <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>
 495 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 496 <li><em>osError</em> if an unspecific error occurred.</li>
 497 <li><em>osErrorISR</em> if called from an <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
 498 </ul>
 499 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 500 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
 501 <div class="line">  <span class="comment">// System Initialization</span></div>
 502 <div class="line">  SystemCoreClockUpdate();</div>
 503 <div class="line">  <span class="comment">// ...</span></div>
 504 <div class="line">  <span class="keywordflow">if</span>(<a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba" title="Get the current RTOS Kernel state.">osKernelGetState</a>() == <a class="code hl_enumvalue" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a2ad3e5912db47b497529d036c89e7995" title="Inactive.">osKernelInactive</a>) {</div>
 505 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659" title="Initialize the RTOS Kernel.">osKernelInitialize</a>();</div>
 506 <div class="line">  }</div>
 507 <div class="line">  ; <span class="comment">// ... Start Threads</span></div>
 508 <div class="line">  <span class="keywordflow">if</span> (<a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga48b69b81012fce051f639be288b243ba" title="Get the current RTOS Kernel state.">osKernelGetState</a>() == <a class="code hl_enumvalue" href="group__CMSIS__RTOS__KernelCtrl.html#gga08326469274b668140ca934b168a5ad4a0596c6e14113447604753656417c9a24" title="Ready.">osKernelReady</a>) {        <span class="comment">// If kernel is ready to run...</span></div>
 509 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221" title="Start the RTOS Kernel scheduler.">osKernelStart</a>();                                <span class="comment">// ... start thread execution</span></div>
 510 <div class="line">    }</div>
 511 <div class="line">  </div>
 512 <div class="line">  <span class="keywordflow">while</span>(1);                                         <span class="comment">// only reached in case of error</span></div>
 513 <div class="line">}</div>
 514 </div><!-- fragment -->
 515 </div>
 516 </div>
 517 <a id="ga948609ee930d9b38336b9e1c2a4dfe12" name="ga948609ee930d9b38336b9e1c2a4dfe12"></a>
 518 <h2 class="memtitle"><span class="permalink"><a href="#ga948609ee930d9b38336b9e1c2a4dfe12">&#9670;&#160;</a></span>osKernelLock()</h2>
 519
 520 <div class="memitem">
 521 <div class="memproto">
 522       <table class="memname">
 523         <tr>
 524           <td class="memname">int32_t osKernelLock </td>
 525           <td>(</td>
 526           <td class="paramtype">void&#160;</td>
 527           <td class="paramname"></td><td>)</td>
 528           <td></td>
 529         </tr>
 530       </table>
 531 </div><div class="memdoc">
 532
 533 <p>Lock the RTOS Kernel scheduler. </p>
 534 <dl class="section return"><dt>Returns</dt><dd>previous lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
 535 <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>
 536 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 537 <li><em>osError</em> if an unspecific error occurred.</li>
 538 <li><em>osErrorISR</em> if called from an <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
 539 <li><em>osErrorSafetyClass</em> if the calling thread safety class is lower than the kernel protect safety class.</li>
 540 </ul>
 541 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 542 <p><b>Code Example</b> </p><div class="fragment"><div class="line">int32_t state = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12" title="Lock the RTOS Kernel scheduler.">osKernelLock</a>();</div>
 543 <div class="line"><span class="comment">// ... critical code</span></div>
 544 <div class="line">osKernelRestore(state);</div>
 545 </div><!-- fragment -->
 546 </div>
 547 </div>
 548 <a id="gaf401728b4657456198c33fe75f8d6720" name="gaf401728b4657456198c33fe75f8d6720"></a>
 549 <h2 class="memtitle"><span class="permalink"><a href="#gaf401728b4657456198c33fe75f8d6720">&#9670;&#160;</a></span>osKernelUnlock()</h2>
 550
 551 <div class="memitem">
 552 <div class="memproto">
 553       <table class="memname">
 554         <tr>
 555           <td class="memname">int32_t osKernelUnlock </td>
 556           <td>(</td>
 557           <td class="paramtype">void&#160;</td>
 558           <td class="paramname"></td><td>)</td>
 559           <td></td>
 560         </tr>
 561       </table>
 562 </div><div class="memdoc">
 563
 564 <p>Unlock the RTOS Kernel scheduler. </p>
 565 <dl class="section return"><dt>Returns</dt><dd>previous lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
 566 <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>
 567 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 568 <li><em>osError</em> if an unspecific error occurred.</li>
 569 <li><em>osErrorISR</em> if called from an <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
 570 </ul>
 571 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 572 <p><b>Code Example</b> </p><div class="fragment"><div class="line">int32_t sl = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12" title="Lock the RTOS Kernel scheduler.">osKernelLock</a>();</div>
 573 <div class="line"><span class="comment">// ... critical code</span></div>
 574 <div class="line">{</div>
 575 <div class="line">  int32_t su = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720" title="Unlock the RTOS Kernel scheduler.">osKernelUnlock</a>();</div>
 576 <div class="line">  <span class="comment">// ... uncritical code</span></div>
 577 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289" title="Restore the RTOS Kernel scheduler lock state.">osKernelRestoreLock</a>(su);</div>
 578 <div class="line">}</div>
 579 <div class="line"><span class="comment">// ... critical code</span></div>
 580 <div class="line"><a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289" title="Restore the RTOS Kernel scheduler lock state.">osKernelRestoreLock</a>(sl);</div>
 581 </div><!-- fragment -->
 582 </div>
 583 </div>
 584 <a id="gae7d0a71b9586cbbb49fcbdf6a04f0289" name="gae7d0a71b9586cbbb49fcbdf6a04f0289"></a>
 585 <h2 class="memtitle"><span class="permalink"><a href="#gae7d0a71b9586cbbb49fcbdf6a04f0289">&#9670;&#160;</a></span>osKernelRestoreLock()</h2>
 586
 587 <div class="memitem">
 588 <div class="memproto">
 589       <table class="memname">
 590         <tr>
 591           <td class="memname">int32_t osKernelRestoreLock </td>
 592           <td>(</td>
 593           <td class="paramtype">int32_t&#160;</td>
 594           <td class="paramname"><em>lock</em></td><td>)</td>
 595           <td></td>
 596         </tr>
 597       </table>
 598 </div><div class="memdoc">
 599
 600 <p>Restore the RTOS Kernel scheduler lock state. </p>
 601 <dl class="params"><dt>Parameters</dt><dd>
 602   <table class="params">
 603     <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>
 604   </table>
 605   </dd>
 606 </dl>
 607 <dl class="section return"><dt>Returns</dt><dd>new lock state (1 - locked, 0 - not locked, error code if negative).</dd></dl>
 608 <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>
 609 <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>
 610 <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>
 611 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 612 <li><em>osError</em> if an unspecific error occurred.</li>
 613 <li><em>osErrorISR</em> if called from interrupt other than fault or <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga5a02770aaf65c7a3c7562c109884176a">osWatchdogAlarm_Handler</a>.</li>
 614 <li><em>osErrorSafetyClass</em> if the calling thread safety class is lower than the kernel protect safety class.</li>
 615 </ul>
 616 <p><b>Code Example</b> </p><div class="fragment"><div class="line">int32_t sl = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12" title="Lock the RTOS Kernel scheduler.">osKernelLock</a>();</div>
 617 <div class="line"><span class="comment">// ... critical code</span></div>
 618 <div class="line">{</div>
 619 <div class="line">  int32_t su = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720" title="Unlock the RTOS Kernel scheduler.">osKernelUnlock</a>();</div>
 620 <div class="line">  <span class="comment">// ... uncritical code</span></div>
 621 <div class="line">  <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289" title="Restore the RTOS Kernel scheduler lock state.">osKernelRestoreLock</a>(su);</div>
 622 <div class="line">}</div>
 623 <div class="line"><span class="comment">// ... critical code</span></div>
 624 <div class="line"><a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289" title="Restore the RTOS Kernel scheduler lock state.">osKernelRestoreLock</a>(sl);</div>
 625 </div><!-- fragment -->
 626 </div>
 627 </div>
 628 <a id="gae26683e1606ec633354a2876c68f0c1f" name="gae26683e1606ec633354a2876c68f0c1f"></a>
 629 <h2 class="memtitle"><span class="permalink"><a href="#gae26683e1606ec633354a2876c68f0c1f">&#9670;&#160;</a></span>osKernelSuspend()</h2>
 630
 631 <div class="memitem">
 632 <div class="memproto">
 633       <table class="memname">
 634         <tr>
 635           <td class="memname">uint32_t osKernelSuspend </td>
 636           <td>(</td>
 637           <td class="paramtype">void&#160;</td>
 638           <td class="paramname"></td><td>)</td>
 639           <td></td>
 640         </tr>
 641       </table>
 642 </div><div class="memdoc">
 643
 644 <p>Suspend the RTOS Kernel scheduler. </p>
 645 <dl class="section return"><dt>Returns</dt><dd>time in ticks, for how long the system can sleep or power-down.</dd></dl>
 646 <p>CMSIS-RTOS2 provides extension for tick-less operation which is useful for applications that use extensively low-power modes where the SysTick timer is also disabled.</p>
 647 <p>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 RTOS kernel scheduler and thus enables sleep modes.</p>
 648 <p>The return value can be used to determine the amount of system ticks until the next tick-based kernel event will occur, i.e. a delayed thread becomes ready again. It is recommended to set up the low power timer to generate a wake-up interrupt based on this return value.</p>
 649 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 650 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> osRtxIdleThread (<span class="keywordtype">void</span>) {</div>
 651 <div class="line">                                               <span class="comment">/* The idle thread is running</span></div>
 652 <div class="line"><span class="comment">                                                  when no other thread is ready</span></div>
 653 <div class="line"><span class="comment">                                                  to run.                      */</span></div>
 654 <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sleep;</div>
 655 <div class="line"> </div>
 656 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 657 <div class="line">                                               <span class="comment">/* HERE: include optional user</span></div>
 658 <div class="line"><span class="comment">                                                  code to be executed when no</span></div>
 659 <div class="line"><span class="comment">                                                  task runs.                   */</span></div>
 660 <div class="line">    sleep = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f" title="Suspend the RTOS Kernel scheduler.">osKernelSuspend</a>();                 <span class="comment">/* Suspend RTOS kernel scheduler */</span></div>
 661 <div class="line"> </div>
 662 <div class="line">    <span class="keywordflow">if</span> (sleep) {                               <span class="comment">/* How long can we sleep?       */</span></div>
 663 <div class="line">                                               <span class="comment">/* &quot;sleep&quot; is in kernel Timer Ticks</span></div>
 664 <div class="line"><span class="comment">                                                  which is 1ms in this</span></div>
 665 <div class="line"><span class="comment">                                                  configuration                */</span></div>
 666 <div class="line">       </div>
 667 <div class="line">                                               <span class="comment">/* Setup wake-up e.g. watchdog  */</span></div>
 668 <div class="line"> </div>
 669 <div class="line">      __WFE();                                 <span class="comment">/* Enter Power-down mode        */</span></div>
 670 <div class="line">      </div>
 671 <div class="line">                                               <span class="comment">/* After Wake-up                */</span></div>
 672 <div class="line">      sleep = tc;                              <span class="comment">/* Adjust with cycles slept     */</span>  </div>
 673 <div class="line">    }</div>
 674 <div class="line"> </div>
 675 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced" title="Resume the RTOS Kernel scheduler.">osKernelResume</a>(sleep);                     <span class="comment">/* Resume thread scheduler      */</span></div>
 676 <div class="line">  }</div>
 677 <div class="line">}</div>
 678 </div><!-- fragment -->
 679 </div>
 680 </div>
 681 <a id="ga8c4b4d7ed34cab73c001665d9176aced" name="ga8c4b4d7ed34cab73c001665d9176aced"></a>
 682 <h2 class="memtitle"><span class="permalink"><a href="#ga8c4b4d7ed34cab73c001665d9176aced">&#9670;&#160;</a></span>osKernelResume()</h2>
 683
 684 <div class="memitem">
 685 <div class="memproto">
 686       <table class="memname">
 687         <tr>
 688           <td class="memname">void osKernelResume </td>
 689           <td>(</td>
 690           <td class="paramtype">uint32_t&#160;</td>
 691           <td class="paramname"><em>sleep_ticks</em></td><td>)</td>
 692           <td></td>
 693         </tr>
 694       </table>
 695 </div><div class="memdoc">
 696
 697 <p>Resume the RTOS Kernel scheduler. </p>
 698 <dl class="params"><dt>Parameters</dt><dd>
 699   <table class="params">
 700     <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>
 701   </table>
 702   </dd>
 703 </dl>
 704 <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.</p>
 705 <p>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 RTOS kernel scheduler and thus wakes up the system from sleep mode.</p>
 706 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 707 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> osRtxIdleThread (<span class="keywordtype">void</span>) {</div>
 708 <div class="line">                                               <span class="comment">/* The idle thread is running</span></div>
 709 <div class="line"><span class="comment">                                                  when no other thread is ready</span></div>
 710 <div class="line"><span class="comment">                                                  to run.                      */</span></div>
 711 <div class="line">  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sleep;</div>
 712 <div class="line"> </div>
 713 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 714 <div class="line">                                               <span class="comment">/* HERE: include optional user</span></div>
 715 <div class="line"><span class="comment">                                                  code to be executed when no</span></div>
 716 <div class="line"><span class="comment">                                                  task runs.                   */</span></div>
 717 <div class="line">    sleep = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f" title="Suspend the RTOS Kernel scheduler.">osKernelSuspend</a>();                 <span class="comment">/* Suspend RTOS kernel scheduler */</span></div>
 718 <div class="line"> </div>
 719 <div class="line">    <span class="keywordflow">if</span> (sleep) {                               <span class="comment">/* How long can we sleep?       */</span></div>
 720 <div class="line">                                               <span class="comment">/* &quot;sleep&quot; is in Kernel Timer Ticks</span></div>
 721 <div class="line"><span class="comment">                                                  which is 1ms in this</span></div>
 722 <div class="line"><span class="comment">                                                  configuration                */</span></div>
 723 <div class="line">       </div>
 724 <div class="line">                                               <span class="comment">/* Setup wake-up e.g. watchdog  */</span></div>
 725 <div class="line"> </div>
 726 <div class="line">      __WFE();                                 <span class="comment">/* Enter Power-down mode        */</span></div>
 727 <div class="line">      </div>
 728 <div class="line">                                               <span class="comment">/* After Wake-up                */</span></div>
 729 <div class="line">      sleep = tc;                              <span class="comment">/* Adjust with cycles slept     */</span>  </div>
 730 <div class="line">    }</div>
 731 <div class="line"> </div>
 732 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced" title="Resume the RTOS Kernel scheduler.">osKernelResume</a>(sleep);                     <span class="comment">/* Resume thread scheduler      */</span></div>
 733 <div class="line">  }</div>
 734 <div class="line">}</div>
 735 </div><!-- fragment -->
 736 </div>
 737 </div>
 738 <a id="ga84bcdbf2fb76b10c8df4e439f0c7e11b" name="ga84bcdbf2fb76b10c8df4e439f0c7e11b"></a>
 739 <h2 class="memtitle"><span class="permalink"><a href="#ga84bcdbf2fb76b10c8df4e439f0c7e11b">&#9670;&#160;</a></span>osKernelGetTickCount()</h2>
 740
 741 <div class="memitem">
 742 <div class="memproto">
 743       <table class="memname">
 744         <tr>
 745           <td class="memname">uint32_t osKernelGetTickCount </td>
 746           <td>(</td>
 747           <td class="paramtype">void&#160;</td>
 748           <td class="paramname"></td><td>)</td>
 749           <td></td>
 750         </tr>
 751       </table>
 752 </div><div class="memdoc">
 753
 754 <p>Get the RTOS kernel tick count. </p>
 755 <dl class="section return"><dt>Returns</dt><dd>RTOS kernel current tick count.</dd></dl>
 756 <p>The function <b>osKernelGetTickCount</b> returns the current RTOS kernel tick count.</p>
 757 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 758 <p><b>Code</b> <b>Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 759 <div class="line"> </div>
 760 <div class="line"><span class="keywordtype">void</span> Thread_1 (<span class="keywordtype">void</span> *arg)  {                <span class="comment">// Thread function</span></div>
 761 <div class="line">  uint32_t tick;</div>
 762 <div class="line"> </div>
 763 <div class="line">  tick = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b" title="Get the RTOS kernel tick count.">osKernelGetTickCount</a>();            <span class="comment">// retrieve the number of system ticks</span></div>
 764 <div class="line">  <span class="keywordflow">for</span> (;;) {</div>
 765 <div class="line">    tick += 1000;                           <span class="comment">// delay 1000 ticks periodically</span></div>
 766 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__Wait.html#ga3c807924c2d6d43bc2ffb49da3f7f3a1" title="Wait until specified time.">osDelayUntil</a>(tick);</div>
 767 <div class="line">    <span class="comment">// ...</span></div>
 768 <div class="line">  }</div>
 769 <div class="line">}</div>
 770 </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>
 771 <p><b>Code</b> <b>Example</b> </p><div class="fragment"><div class="line">uint64_t GetTick(<span class="keywordtype">void</span>) {</div>
 772 <div class="line">  <span class="keyword">static</span> uint32_t tick_h = 0U;</div>
 773 <div class="line">  <span class="keyword">static</span> uint32_t tick_l = 0U;</div>
 774 <div class="line">         uint32_t tick;</div>
 775 <div class="line"> </div>
 776 <div class="line">  tick = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga84bcdbf2fb76b10c8df4e439f0c7e11b" title="Get the RTOS kernel tick count.">osKernelGetTickCount</a>();</div>
 777 <div class="line">  <span class="keywordflow">if</span> (tick &lt; tick_l) {</div>
 778 <div class="line">    tick_h++;</div>
 779 <div class="line">  }</div>
 780 <div class="line">  tick_l = tick;</div>
 781 <div class="line"> </div>
 782 <div class="line">  <span class="keywordflow">return</span> (((uint64_t)tick_h &lt;&lt; 32) | tick_l);</div>
 783 <div class="line">}</div>
 784 </div><!-- fragment -->
 785 </div>
 786 </div>
 787 <a id="ga7a8d7bd927eaaa58999f91d7d6310cee" name="ga7a8d7bd927eaaa58999f91d7d6310cee"></a>
 788 <h2 class="memtitle"><span class="permalink"><a href="#ga7a8d7bd927eaaa58999f91d7d6310cee">&#9670;&#160;</a></span>osKernelGetTickFreq()</h2>
 789
 790 <div class="memitem">
 791 <div class="memproto">
 792       <table class="memname">
 793         <tr>
 794           <td class="memname">uint32_t osKernelGetTickFreq </td>
 795           <td>(</td>
 796           <td class="paramtype">void&#160;</td>
 797           <td class="paramname"></td><td>)</td>
 798           <td></td>
 799         </tr>
 800       </table>
 801 </div><div class="memdoc">
 802
 803 <p>Get the RTOS kernel tick frequency. </p>
 804 <dl class="section return"><dt>Returns</dt><dd>frequency of the kernel tick in hertz, i.e. kernel ticks per second.</dd></dl>
 805 <p>The function <b>osKernelGetTickFreq</b> returns the frequency of the current RTOS kernel tick.</p>
 806 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 807
 808 </div>
 809 </div>
 810 <a id="gae0fcaff6cecfb4013bb556c87afcd7d2" name="gae0fcaff6cecfb4013bb556c87afcd7d2"></a>
 811 <h2 class="memtitle"><span class="permalink"><a href="#gae0fcaff6cecfb4013bb556c87afcd7d2">&#9670;&#160;</a></span>osKernelGetSysTimerCount()</h2>
 812
 813 <div class="memitem">
 814 <div class="memproto">
 815       <table class="memname">
 816         <tr>
 817           <td class="memname">uint32_t osKernelGetSysTimerCount </td>
 818           <td>(</td>
 819           <td class="paramtype">void&#160;</td>
 820           <td class="paramname"></td><td>)</td>
 821           <td></td>
 822         </tr>
 823       </table>
 824 </div><div class="memdoc">
 825
 826 <p>Get the RTOS kernel system timer count. </p>
 827 <dl class="section return"><dt>Returns</dt><dd>RTOS kernel current system timer count as 32-bit value.</dd></dl>
 828 <p>The function <b>osKernelGetSysTimerCount</b> returns the current RTOS kernel system timer as a 32-bit value. The value is a rolling 32-bit counter that is composed of the kernel system interrupt timer value and the counter that counts these interrupts (RTOS kernel ticks).</p>
 829 <p>This function allows the implementation of very short timeout checks below the RTOS tick granularity. Such checks might be required when checking for a busy status in a device or peripheral initialization routine, see code example below.</p>
 830 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 831 <p><b>Code Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 832 <div class="line"> </div>
 833 <div class="line"><span class="keywordtype">void</span> SetupDevice (<span class="keywordtype">void</span>)  {</div>
 834 <div class="line">  uint32_t tick;</div>
 835 <div class="line">  </div>
 836 <div class="line">  <span class="comment">// Calculating 100us timeout in system timer ticks</span></div>
 837 <div class="line">  <span class="keyword">const</span> uint32_t timeout = 100U * <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga4d69215a93220f72be3684cad582f16a" title="Get the RTOS kernel system timer frequency.">osKernelGetSysTimerFreq</a>() / 1000000u;</div>
 838 <div class="line">  </div>
 839 <div class="line">  tick = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2" title="Get the RTOS kernel system timer count.">osKernelGetSysTimerCount</a>();             <span class="comment">// get start value of the Kernel system tick</span></div>
 840 <div class="line">  Device.Setup ();                               <span class="comment">// initialize a device or peripheral</span></div>
 841 <div class="line">  <span class="keywordflow">do</span> {                                           <span class="comment">// poll device busy status for 100 microseconds</span></div>
 842 <div class="line">    <span class="keywordflow">if</span> (!Device.Busy) <span class="keywordflow">break</span>;                     <span class="comment">// check if device is correctly initialized</span></div>
 843 <div class="line">  } <span class="keywordflow">while</span> ((<a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2" title="Get the RTOS kernel system timer count.">osKernelGetSysTimerCount</a>() - tick) &lt; timeout));</div>
 844 <div class="line">  <span class="keywordflow">if</span> (Device.Busy)  {              </div>
 845 <div class="line">    ;                                            <span class="comment">// in case device still busy, signal error</span></div>
 846 <div class="line">  }</div>
 847 <div class="line">                                                 <span class="comment">// start interacting with device</span></div>
 848 <div class="line">}</div>
 849 </div><!-- fragment -->
 850 </div>
 851 </div>
 852 <a id="ga4d69215a93220f72be3684cad582f16a" name="ga4d69215a93220f72be3684cad582f16a"></a>
 853 <h2 class="memtitle"><span class="permalink"><a href="#ga4d69215a93220f72be3684cad582f16a">&#9670;&#160;</a></span>osKernelGetSysTimerFreq()</h2>
 854
 855 <div class="memitem">
 856 <div class="memproto">
 857       <table class="memname">
 858         <tr>
 859           <td class="memname">uint32_t osKernelGetSysTimerFreq </td>
 860           <td>(</td>
 861           <td class="paramtype">void&#160;</td>
 862           <td class="paramname"></td><td>)</td>
 863           <td></td>
 864         </tr>
 865       </table>
 866 </div><div class="memdoc">
 867
 868 <p>Get the RTOS kernel system timer frequency. </p>
 869 <dl class="section return"><dt>Returns</dt><dd>frequency of the system timer in hertz, i.e. timer ticks per second.</dd></dl>
 870 <p>The function <b>osKernelGetSysTimerFreq</b> returns the frequency of the current RTOS kernel system timer.</p>
 871 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 872
 873 </div>
 874 </div>
 875 <a id="gac7e3b012c15c55bda68e0dd96ad9cd72" name="gac7e3b012c15c55bda68e0dd96ad9cd72"></a>
 876 <h2 class="memtitle"><span class="permalink"><a href="#gac7e3b012c15c55bda68e0dd96ad9cd72">&#9670;&#160;</a></span>osKernelProtect()</h2>
 877
 878 <div class="memitem">
 879 <div class="memproto">
 880       <table class="memname">
 881         <tr>
 882           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelProtect </td>
 883           <td>(</td>
 884           <td class="paramtype">uint32_t&#160;</td>
 885           <td class="paramname"><em>safety_class</em></td><td>)</td>
 886           <td></td>
 887         </tr>
 888       </table>
 889 </div><div class="memdoc">
 890
 891 <p>Protect the RTOS Kernel scheduler access. </p>
 892 <dl class="params"><dt>Parameters</dt><dd>
 893   <table class="params">
 894     <tr><td class="paramdir">[in]</td><td class="paramname">safety_class</td><td>safety class. </td></tr>
 895   </table>
 896   </dd>
 897 </dl>
 898 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 899 <p>The function <b>osKernelProtect</b> configures kernel access protection. After its successful execution, only threads with safety class equal or higher than the <em>safety_class</em> specified in the argument can execute kernel control functions.</p><ul>
 900 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga948609ee930d9b38336b9e1c2a4dfe12">osKernelLock</a></li>
 901 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gaf401728b4657456198c33fe75f8d6720">osKernelUnlock</a></li>
 902 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae7d0a71b9586cbbb49fcbdf6a04f0289">osKernelRestoreLock</a></li>
 903 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae26683e1606ec633354a2876c68f0c1f">osKernelSuspend</a></li>
 904 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga8c4b4d7ed34cab73c001665d9176aced">osKernelResume</a></li>
 905 <li><a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gac7e3b012c15c55bda68e0dd96ad9cd72">osKernelProtect</a></li>
 906 </ul>
 907 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 908 <li><em>osOK</em> in case of success.</li>
 909 <li><em>osErrorParameter</em> if <em>safety_class</em> is invalid.</li>
 910 <li><em>osError</em> if kernel is not in ready or running state.</li>
 911 <li><em>osErrorISR</em> if called from an <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routine</a>.</li>
 912 <li><em>osErrorSafetyClass</em> if the calling thread safety class is lower than the kernel protect safety class.</li>
 913 </ul>
 914 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 915 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 916 <div class="line"> </div>
 917 <div class="line"><span class="keywordtype">void</span> ProtectKernelControlFunctions (<span class="keywordtype">void</span>) {</div>
 918 <div class="line">  <a class="code hl_enumeration" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions.">osStatus_t</a> status;</div>
 919 <div class="line"> </div>
 920 <div class="line">  status = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#gac7e3b012c15c55bda68e0dd96ad9cd72" title="Protect the RTOS Kernel scheduler access.">osKernelProtect</a>(4U); <span class="comment">// Enable Kernel Control for threads with safety class 4 or higher</span></div>
 921 <div class="line">  <span class="comment">// verify status value here.</span></div>
 922 <div class="line">}</div>
 923 </div><!-- fragment -->
 924 </div>
 925 </div>
 926 <a id="ga2065364d1bc805a40e749430377df1e1" name="ga2065364d1bc805a40e749430377df1e1"></a>
 927 <h2 class="memtitle"><span class="permalink"><a href="#ga2065364d1bc805a40e749430377df1e1">&#9670;&#160;</a></span>osKernelDestroyClass()</h2>
 928
 929 <div class="memitem">
 930 <div class="memproto">
 931       <table class="memname">
 932         <tr>
 933           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osKernelDestroyClass </td>
 934           <td>(</td>
 935           <td class="paramtype">uint32_t&#160;</td>
 936           <td class="paramname"><em>safety_class</em>, </td>
 937         </tr>
 938         <tr>
 939           <td class="paramkey"></td>
 940           <td></td>
 941           <td class="paramtype">uint32_t&#160;</td>
 942           <td class="paramname"><em>mode</em>&#160;</td>
 943         </tr>
 944         <tr>
 945           <td></td>
 946           <td>)</td>
 947           <td></td><td></td>
 948         </tr>
 949       </table>
 950 </div><div class="memdoc">
 951
 952 <p>Destroy objects for specified safety classes. </p>
 953 <dl class="params"><dt>Parameters</dt><dd>
 954   <table class="params">
 955     <tr><td class="paramdir">[in]</td><td class="paramname">safety_class</td><td>safety class. </td></tr>
 956     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>safety mode. </td></tr>
 957   </table>
 958   </dd>
 959 </dl>
 960 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 961 <p>The function <b>osKernelDestroyClass</b> destroys RTOS objects based on safety class assignment. <em>safety_class</em> provides the reference safety class value, while <em>mode</em> is considered as a bitmap that additionally specifies the safety classes to be destroyed.</p>
 962 <p>If <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga7abd2d95425d9e02672778b3464b2eaa">osSafetyWithSameClass</a> is set in <em>mode</em> than the RTOS objects with safety class value equal to <em>safety_class</em> will be destroyed. <br  />
 963  If <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga8c77ee126b9215425fc004ee13cdc6de">osSafetyWithLowerClass</a> is set in <em>mode</em> than the RTOS objects with safety class value lower than <em>safety_class</em> will be destroyed.</p>
 964 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 965 <li><em>osOK</em> in case of success.</li>
 966 <li><em>osErrorParameter</em> if <em>safety_class</em> is invalid.</li>
 967 <li><em>osErrorResource</em> if no other <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">READY</a> thread exists.</li>
 968 <li><em>osErrorISR</em> if called from interrupt other than <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ga5a02770aaf65c7a3c7562c109884176a">osWatchdogAlarm_Handler</a>.</li>
 969 <li><em>osErrorSafetyClass</em> if the calling thread safety class is lower than the kernel protect safety class.</li>
 970 </ul>
 971 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span></div>
 972 <div class="line"> </div>
 973 <div class="line"><span class="keywordtype">void</span> DestroyNonCriticalClasses (<span class="keywordtype">void</span>) {</div>
 974 <div class="line">  <a class="code hl_enumeration" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions.">osStatus_t</a> status;</div>
 975 <div class="line"> </div>
 976 <div class="line">  status = <a class="code hl_function" href="group__CMSIS__RTOS__KernelCtrl.html#ga2065364d1bc805a40e749430377df1e1" title="Destroy objects for specified safety classes.">osKernelDestroyClass</a>(4U, <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga7abd2d95425d9e02672778b3464b2eaa" title="Objects with same safety class.">osSafetyWithSameClass</a> | <a class="code hl_define" href="group__CMSIS__RTOS__Definitions.html#ga8c77ee126b9215425fc004ee13cdc6de" title="Objects with lower safety class.">osSafetyWithLowerClass</a>); <span class="comment">// Destroy objects with safety class 4 or lower</span></div>
 977 <div class="line">  <span class="comment">// verify status value here.</span></div>
 978 <div class="line">}</div>
 979 </div><!-- fragment -->
 980 </div>
 981 </div>
 982 <a id="ga91b400b21a9093f7751fc45613c12110" name="ga91b400b21a9093f7751fc45613c12110"></a>
 983 <h2 class="memtitle"><span class="permalink"><a href="#ga91b400b21a9093f7751fc45613c12110">&#9670;&#160;</a></span>osFaultResume()</h2>
 984
 985 <div class="memitem">
 986 <div class="memproto">
 987       <table class="memname">
 988         <tr>
 989           <td class="memname">void osFaultResume </td>
 990           <td>(</td>
 991           <td class="paramtype">void&#160;</td>
 992           <td class="paramname"></td><td>)</td>
 993           <td></td>
 994         </tr>
 995       </table>
 996 </div><div class="memdoc">
 997
 998 <p>Resume normal operation when exiting exception faults. </p>
 999 <p>Resume normal RTOS operation when exiting exception faults.</p>
1000 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> HardFault_Handler (<span class="keywordtype">void</span>) {</div>
1001 <div class="line">  __ASM <span class="keyword">volatile</span> (</div>
1002 <div class="line">    <span class="stringliteral">&quot;...                          \n\t&quot;</span> <span class="comment">// Enter assembly and handle faults</span></div>
1003 <div class="line">    <span class="stringliteral">&quot;...                          \n\t&quot;</span></div>
1004 <div class="line">    <span class="stringliteral">&quot;ldr  r0,=osFaultResume       \n\t&quot;</span> <span class="comment">// Before exiting the handler load and</span></div>
1005 <div class="line">    <span class="stringliteral">&quot;bx   r0                      \n\t&quot;</span> <span class="comment">// jump to osFaultResume</span></div>
1006 <div class="line">  );</div>
1007 <div class="line">}</div>
1008 </div><!-- fragment -->
1009 </div>
1010 </div>
1011 </div><!-- contents -->
1012 </div><!-- doc-content -->
1013 <!-- start footer part -->
1014 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1015   <ul>
1016     <li class="footer">
1017       <script type="text/javascript">
1018         <!--
1019         writeFooter.call(this);
1020         //-->
1021       </script>
1022     </li>
1023   </ul>
1024 </div>
1025 </body>
1026 </html>