begriffs open source - cmsis/blob - main/RTOS2/group__CMSIS__RTOS__TickAPI.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: OS Tick API</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System API</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__TickAPI.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#func-members">Functions</a>  </div>
 132   <div class="headertitle"><div class="title">OS Tick API</div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>System tick timer interface for periodic RTOS Kernel Ticks defined in <b>os_tick.h</b>
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 140 Functions</h2></td></tr>
 141 <tr class="memitem:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga5eeffb4d9dc6c6802fee8898096d9a59">OS_Tick_Setup</a> (uint32_t freq, IRQHandler_t handler)</td></tr>
 142 <tr class="memdesc:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup OS Tick timer to generate periodic RTOS Kernel Ticks.  <br /></td></tr>
 143 <tr class="separator:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#gaaa0d6ddef6816e8e5650fde3daf191e7">OS_Tick_Enable</a> (void)</td></tr>
 145 <tr class="memdesc:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable OS Tick timer interrupt.  <br /></td></tr>
 146 <tr class="separator:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga50fc040b66fabd1945d2bd1d0d05661d">OS_Tick_Disable</a> (void)</td></tr>
 148 <tr class="memdesc:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable OS Tick timer interrupt.  <br /></td></tr>
 149 <tr class="separator:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga14c430d2b363ebd9f904b0822a9314e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga14c430d2b363ebd9f904b0822a9314e7">OS_Tick_AcknowledgeIRQ</a> (void)</td></tr>
 151 <tr class="memdesc:ga14c430d2b363ebd9f904b0822a9314e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acknowledge execution of OS Tick timer interrupt.  <br /></td></tr>
 152 <tr class="separator:ga14c430d2b363ebd9f904b0822a9314e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:gaa8b4eca23e3ffe2df403291958cdc905"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#gaa8b4eca23e3ffe2df403291958cdc905">OS_Tick_GetIRQn</a> (void)</td></tr>
 154 <tr class="memdesc:gaa8b4eca23e3ffe2df403291958cdc905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer IRQ number.  <br /></td></tr>
 155 <tr class="separator:gaa8b4eca23e3ffe2df403291958cdc905"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga936217ea28236fb57648973e0d8f627a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga936217ea28236fb57648973e0d8f627a">OS_Tick_GetClock</a> (void)</td></tr>
 157 <tr class="memdesc:ga936217ea28236fb57648973e0d8f627a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer clock frequency.  <br /></td></tr>
 158 <tr class="separator:ga936217ea28236fb57648973e0d8f627a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga123151dc19d5a94a68f12cdbf61a9bb5">OS_Tick_GetInterval</a> (void)</td></tr>
 160 <tr class="memdesc:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer interval reload value.  <br /></td></tr>
 161 <tr class="separator:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:gaa64a145a554f1e5077848938d7f39c92"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#gaa64a145a554f1e5077848938d7f39c92">OS_Tick_GetCount</a> (void)</td></tr>
 163 <tr class="memdesc:gaa64a145a554f1e5077848938d7f39c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer counter value.  <br /></td></tr>
 164 <tr class="separator:gaa64a145a554f1e5077848938d7f39c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga1f9a593126b7f0b66fc526c2cebd6192">OS_Tick_GetOverflow</a> (void)</td></tr>
 166 <tr class="memdesc:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer overflow status.  <br /></td></tr>
 167 <tr class="separator:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 </table>
 169 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 170 <p>System tick timer interface for periodic RTOS Kernel Ticks defined in <b>os_tick.h</b> </p>
 171 <p>The <b>OS Tick API</b> is an interface to a system timer that generates the Kernel Ticks.</p>
 172 <p>All Cortex-M processors provide an unified System Tick Timer that is typically used to generate the RTOS Kernel Tick.</p>
 173 <p>The Cortex-A processors do not implement an unified system timer and required a device specific implementation. </p>
 174 <p>CMSIS-RTOS2 provides in the directory <a class="el" href="index.html#rtos2_access">CMSIS/RTOS2/Source</a> several OS Tick implementations that can be used by any RTOS kernel.</p>
 175 <table class="markdownTable">
 176 <tr class="markdownTableHead">
 177 <th class="markdownTableHeadLeft">Filename   </th><th class="markdownTableHeadLeft">OS Tick Implementation for...    </th></tr>
 178 <tr class="markdownTableRowOdd">
 179 <td class="markdownTableBodyLeft"><b>os_systick.c</b>   </td><td class="markdownTableBodyLeft">Cortex-M SysTick timer   </td></tr>
 180 </table>
 181 <p><b>os_tick_gtim.c</b> | Cortex-A Generic Timer (available in some devices) <b>os_tick_ptim.c</b> | Cortex-A Private Timer (available in some devices) </p>
 182 <dl class="section note"><dt>Note</dt><dd>The above OS Tick source files implement <code>weak</code> functions which may be overwritten by user-specific implementations. </dd></dl>
 183 <h2 class="groupheader">Function Documentation</h2>
 184 <a id="ga5eeffb4d9dc6c6802fee8898096d9a59" name="ga5eeffb4d9dc6c6802fee8898096d9a59"></a>
 185 <h2 class="memtitle"><span class="permalink"><a href="#ga5eeffb4d9dc6c6802fee8898096d9a59">&#9670;&#160;</a></span>OS_Tick_Setup()</h2>
 186
 187 <div class="memitem">
 188 <div class="memproto">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">int32_t OS_Tick_Setup </td>
 192           <td>(</td>
 193           <td class="paramtype">uint32_t&#160;</td>
 194           <td class="paramname"><em>freq</em>, </td>
 195         </tr>
 196         <tr>
 197           <td class="paramkey"></td>
 198           <td></td>
 199           <td class="paramtype">IRQHandler_t&#160;</td>
 200           <td class="paramname"><em>handler</em>&#160;</td>
 201         </tr>
 202         <tr>
 203           <td></td>
 204           <td>)</td>
 205           <td></td><td></td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>Setup OS Tick timer to generate periodic RTOS Kernel Ticks. </p>
 211 <dl class="params"><dt>Parameters</dt><dd>
 212   <table class="params">
 213     <tr><td class="paramdir">[in]</td><td class="paramname">freq</td><td>tick frequency in Hz </td></tr>
 214     <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>tick IRQ handler </td></tr>
 215   </table>
 216   </dd>
 217 </dl>
 218 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error.</dd></dl>
 219 <p>Setup OS Tick timer to generate periodic RTOS Kernel Ticks.</p>
 220 <p>The timer should be configured to generate periodic interrupts at frequency specified by <em>freq</em>. The parameter <em>handler</em> defines the interrupt handler function that is called.</p>
 221 <p>The timer should only be initialized and configured but must not be started to create interrupts. The RTOS kernel calls the function <a class="el" href="group__CMSIS__RTOS__TickAPI.html#gaaa0d6ddef6816e8e5650fde3daf191e7">OS_Tick_Enable</a> to start the timer interrupts.</p>
 222 <p><b>Cortex-M SysTick implementation:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#ifndef SYSTICK_IRQ_PRIORITY</span></div>
 223 <div class="line"><span class="preprocessor">#define SYSTICK_IRQ_PRIORITY    0xFFU</span></div>
 224 <div class="line"><span class="preprocessor">#endif</span></div>
 225 <div class="line"> </div>
 226 <div class="line"><span class="keyword">static</span> uint8_t PendST;</div>
 227 <div class="line"> </div>
 228 <div class="line">int32_t  <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga5eeffb4d9dc6c6802fee8898096d9a59" title="Setup OS Tick timer to generate periodic RTOS Kernel Ticks.">OS_Tick_Setup</a> (uint32_t freq, IRQHandler_t handler) {</div>
 229 <div class="line">  (void)handler;</div>
 230 <div class="line">  uint32_t load;</div>
 231 <div class="line"> </div>
 232 <div class="line">  <span class="keywordflow">if</span> (freq == 0U) {</div>
 233 <div class="line">    <span class="keywordflow">return</span> (-1);</div>
 234 <div class="line">  }</div>
 235 <div class="line"> </div>
 236 <div class="line">  load = (SystemCoreClock / freq) - 1U;</div>
 237 <div class="line">  <span class="keywordflow">if</span> (load &gt; 0x00FFFFFFU) {</div>
 238 <div class="line">    <span class="keywordflow">return</span> (-1);</div>
 239 <div class="line">  }</div>
 240 <div class="line"> </div>
 241 <div class="line">  NVIC_SetPriority(SysTick_IRQn, SYSTICK_IRQ_PRIORITY);</div>
 242 <div class="line"> </div>
 243 <div class="line">  SysTick-&gt;CTRL =  SysTick_CTRL_CLKSOURCE_Msk | SysTick_CTRL_TICKINT_Msk;</div>
 244 <div class="line">  SysTick-&gt;LOAD =  load;</div>
 245 <div class="line">  SysTick-&gt;VAL  =  0U;</div>
 246 <div class="line"> </div>
 247 <div class="line">  PendST = 0U;</div>
 248 <div class="line"> </div>
 249 <div class="line">  <span class="keywordflow">return</span> (0);</div>
 250 <div class="line">}</div>
 251 </div><!-- fragment -->
 252 </div>
 253 </div>
 254 <a id="gaaa0d6ddef6816e8e5650fde3daf191e7" name="gaaa0d6ddef6816e8e5650fde3daf191e7"></a>
 255 <h2 class="memtitle"><span class="permalink"><a href="#gaaa0d6ddef6816e8e5650fde3daf191e7">&#9670;&#160;</a></span>OS_Tick_Enable()</h2>
 256
 257 <div class="memitem">
 258 <div class="memproto">
 259       <table class="memname">
 260         <tr>
 261           <td class="memname">void OS_Tick_Enable </td>
 262           <td>(</td>
 263           <td class="paramtype">void&#160;</td>
 264           <td class="paramname"></td><td>)</td>
 265           <td></td>
 266         </tr>
 267       </table>
 268 </div><div class="memdoc">
 269
 270 <p>Enable OS Tick timer interrupt. </p>
 271 <p>Enable OS Tick timer interrupt.</p>
 272 <p>Enable and start the OS Tick timer to generate periodic RTOS Kernel Tick interrupts.</p>
 273 <p><b>Cortex-M SysTick implementation:</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span>  <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#gaaa0d6ddef6816e8e5650fde3daf191e7" title="Enable OS Tick timer interrupt.">OS_Tick_Enable</a> (<span class="keywordtype">void</span>) {</div>
 274 <div class="line"> </div>
 275 <div class="line">  <span class="keywordflow">if</span> (PendST != 0U) {</div>
 276 <div class="line">    PendST = 0U;</div>
 277 <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTSET_Msk;</div>
 278 <div class="line">  }</div>
 279 <div class="line"> </div>
 280 <div class="line">  SysTick-&gt;CTRL |=  SysTick_CTRL_ENABLE_Msk;</div>
 281 <div class="line"> </div>
 282 <div class="line">}</div>
 283 </div><!-- fragment -->
 284 </div>
 285 </div>
 286 <a id="ga50fc040b66fabd1945d2bd1d0d05661d" name="ga50fc040b66fabd1945d2bd1d0d05661d"></a>
 287 <h2 class="memtitle"><span class="permalink"><a href="#ga50fc040b66fabd1945d2bd1d0d05661d">&#9670;&#160;</a></span>OS_Tick_Disable()</h2>
 288
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname">void OS_Tick_Disable </td>
 294           <td>(</td>
 295           <td class="paramtype">void&#160;</td>
 296           <td class="paramname"></td><td>)</td>
 297           <td></td>
 298         </tr>
 299       </table>
 300 </div><div class="memdoc">
 301
 302 <p>Disable OS Tick timer interrupt. </p>
 303 <p>Disable OS Tick timer interrupt.</p>
 304 <p>Stop the OS Tick timer and disable generation of RTOS Kernel Tick interrupts.</p>
 305 <p><b>Cortex-M SysTick implementation:</b> </p><div class="fragment"><div class="line"><span class="keywordtype">void</span>  <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga50fc040b66fabd1945d2bd1d0d05661d" title="Disable OS Tick timer interrupt.">OS_Tick_Disable</a> (<span class="keywordtype">void</span>) {</div>
 306 <div class="line"> </div>
 307 <div class="line">  SysTick-&gt;CTRL &amp;= ~SysTick_CTRL_ENABLE_Msk;</div>
 308 <div class="line"> </div>
 309 <div class="line">  <span class="keywordflow">if</span> ((SCB-&gt;ICSR &amp; SCB_ICSR_PENDSTSET_Msk) != 0U) {</div>
 310 <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTCLR_Msk;</div>
 311 <div class="line">    PendST = 1U;</div>
 312 <div class="line">  }</div>
 313 <div class="line"> </div>
 314 <div class="line">}</div>
 315 </div><!-- fragment -->
 316 </div>
 317 </div>
 318 <a id="ga14c430d2b363ebd9f904b0822a9314e7" name="ga14c430d2b363ebd9f904b0822a9314e7"></a>
 319 <h2 class="memtitle"><span class="permalink"><a href="#ga14c430d2b363ebd9f904b0822a9314e7">&#9670;&#160;</a></span>OS_Tick_AcknowledgeIRQ()</h2>
 320
 321 <div class="memitem">
 322 <div class="memproto">
 323       <table class="memname">
 324         <tr>
 325           <td class="memname">void OS_Tick_AcknowledgeIRQ </td>
 326           <td>(</td>
 327           <td class="paramtype">void&#160;</td>
 328           <td class="paramname"></td><td>)</td>
 329           <td></td>
 330         </tr>
 331       </table>
 332 </div><div class="memdoc">
 333
 334 <p>Acknowledge execution of OS Tick timer interrupt. </p>
 335 <p>Acknowledge execution of OS Tick timer interrupt.</p>
 336 <p>Acknowledge the execution of the OS Tick timer interrupt function, for example clear the pending flag.</p>
 337 <p><b>Cortex-M SysTick implementation:</b></p>
 338 <div class="fragment"><div class="line"><span class="keywordtype">void</span>  <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga14c430d2b363ebd9f904b0822a9314e7" title="Acknowledge execution of OS Tick timer interrupt.">OS_Tick_AcknowledgeIRQ</a> (<span class="keywordtype">void</span>) {</div>
 339 <div class="line"> </div>
 340 <div class="line">  (void)SysTick-&gt;CTRL;</div>
 341 <div class="line"> </div>
 342 <div class="line">}</div>
 343 </div><!-- fragment -->
 344 </div>
 345 </div>
 346 <a id="gaa8b4eca23e3ffe2df403291958cdc905" name="gaa8b4eca23e3ffe2df403291958cdc905"></a>
 347 <h2 class="memtitle"><span class="permalink"><a href="#gaa8b4eca23e3ffe2df403291958cdc905">&#9670;&#160;</a></span>OS_Tick_GetIRQn()</h2>
 348
 349 <div class="memitem">
 350 <div class="memproto">
 351       <table class="memname">
 352         <tr>
 353           <td class="memname">int32_t OS_Tick_GetIRQn </td>
 354           <td>(</td>
 355           <td class="paramtype">void&#160;</td>
 356           <td class="paramname"></td><td>)</td>
 357           <td></td>
 358         </tr>
 359       </table>
 360 </div><div class="memdoc">
 361
 362 <p>Get OS Tick timer IRQ number. </p>
 363 <dl class="section return"><dt>Returns</dt><dd>OS Tick IRQ number</dd></dl>
 364 <p>Get OS Tick timer IRQ number.</p>
 365 <p>Return the numeric value that identifies the interrupt called by the OS Tick timer.</p>
 366 <p><b>Cortex-M SysTick implementation:</b></p>
 367 <div class="fragment"><div class="line">int32_t  <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#gaa8b4eca23e3ffe2df403291958cdc905" title="Get OS Tick timer IRQ number.">OS_Tick_GetIRQn</a> (<span class="keywordtype">void</span>) {</div>
 368 <div class="line">  <span class="keywordflow">return</span> ((int32_t)SysTick_IRQn);</div>
 369 <div class="line">}</div>
 370 </div><!-- fragment -->
 371 </div>
 372 </div>
 373 <a id="ga936217ea28236fb57648973e0d8f627a" name="ga936217ea28236fb57648973e0d8f627a"></a>
 374 <h2 class="memtitle"><span class="permalink"><a href="#ga936217ea28236fb57648973e0d8f627a">&#9670;&#160;</a></span>OS_Tick_GetClock()</h2>
 375
 376 <div class="memitem">
 377 <div class="memproto">
 378       <table class="memname">
 379         <tr>
 380           <td class="memname">uint32_t OS_Tick_GetClock </td>
 381           <td>(</td>
 382           <td class="paramtype">void&#160;</td>
 383           <td class="paramname"></td><td>)</td>
 384           <td></td>
 385         </tr>
 386       </table>
 387 </div><div class="memdoc">
 388
 389 <p>Get OS Tick timer clock frequency. </p>
 390 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer clock frequency in Hz</dd></dl>
 391 <p>Get OS Tick timer clock frequency.</p>
 392 <p>Return the input clock frequency of the OS Tick timer. This is the increment rate of the counter value returned by the function <a class="el" href="group__CMSIS__RTOS__TickAPI.html#gaa64a145a554f1e5077848938d7f39c92">OS_Tick_GetCount</a>. This function is used to by the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga4d69215a93220f72be3684cad582f16a">osKernelGetSysTimerFreq</a>.</p>
 393 <p><b>Cortex-M SysTick implementation:</b></p>
 394 <div class="fragment"><div class="line">uint32_t <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga936217ea28236fb57648973e0d8f627a" title="Get OS Tick timer clock frequency.">OS_Tick_GetClock</a> (<span class="keywordtype">void</span>) {</div>
 395 <div class="line">  <span class="keywordflow">return</span> (SystemCoreClock);</div>
 396 <div class="line">}</div>
 397 </div><!-- fragment -->
 398 </div>
 399 </div>
 400 <a id="ga123151dc19d5a94a68f12cdbf61a9bb5" name="ga123151dc19d5a94a68f12cdbf61a9bb5"></a>
 401 <h2 class="memtitle"><span class="permalink"><a href="#ga123151dc19d5a94a68f12cdbf61a9bb5">&#9670;&#160;</a></span>OS_Tick_GetInterval()</h2>
 402
 403 <div class="memitem">
 404 <div class="memproto">
 405       <table class="memname">
 406         <tr>
 407           <td class="memname">uint32_t OS_Tick_GetInterval </td>
 408           <td>(</td>
 409           <td class="paramtype">void&#160;</td>
 410           <td class="paramname"></td><td>)</td>
 411           <td></td>
 412         </tr>
 413       </table>
 414 </div><div class="memdoc">
 415
 416 <p>Get OS Tick timer interval reload value. </p>
 417 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer interval reload value</dd></dl>
 418 <p>Get OS Tick timer interval reload value.</p>
 419 <p>Return the number of counter ticks between to periodic OS Tick timer interrupts.</p>
 420 <p><b>Cortex-M SysTick implementation:</b></p>
 421 <div class="fragment"><div class="line">uint32_t <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga123151dc19d5a94a68f12cdbf61a9bb5" title="Get OS Tick timer interval reload value.">OS_Tick_GetInterval</a> (<span class="keywordtype">void</span>) {</div>
 422 <div class="line">  <span class="keywordflow">return</span> (SysTick-&gt;LOAD + 1U);</div>
 423 <div class="line">}</div>
 424 </div><!-- fragment -->
 425 </div>
 426 </div>
 427 <a id="gaa64a145a554f1e5077848938d7f39c92" name="gaa64a145a554f1e5077848938d7f39c92"></a>
 428 <h2 class="memtitle"><span class="permalink"><a href="#gaa64a145a554f1e5077848938d7f39c92">&#9670;&#160;</a></span>OS_Tick_GetCount()</h2>
 429
 430 <div class="memitem">
 431 <div class="memproto">
 432       <table class="memname">
 433         <tr>
 434           <td class="memname">uint32_t OS_Tick_GetCount </td>
 435           <td>(</td>
 436           <td class="paramtype">void&#160;</td>
 437           <td class="paramname"></td><td>)</td>
 438           <td></td>
 439         </tr>
 440       </table>
 441 </div><div class="memdoc">
 442
 443 <p>Get OS Tick timer counter value. </p>
 444 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer counter value</dd></dl>
 445 <p>Get OS Tick timer counter value.</p>
 446 <p>Return the current value of the OS Tick counter: 0 ... (reload value -1). The reload value is returned by the function <a class="el" href="group__CMSIS__RTOS__TickAPI.html#ga123151dc19d5a94a68f12cdbf61a9bb5">OS_Tick_GetInterval</a>. The OS Tick timer counter value is used to by the function <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae0fcaff6cecfb4013bb556c87afcd7d2">osKernelGetSysTimerCount</a>.</p>
 447 <p><b>Cortex-M SysTick implementation:</b></p>
 448 <div class="fragment"><div class="line">uint32_t <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#gaa64a145a554f1e5077848938d7f39c92" title="Get OS Tick timer counter value.">OS_Tick_GetCount</a> (<span class="keywordtype">void</span>) {</div>
 449 <div class="line">  uint32_t val;</div>
 450 <div class="line">  uint32_t count;</div>
 451 <div class="line"> </div>
 452 <div class="line">  val = SysTick-&gt;VAL;</div>
 453 <div class="line">  <span class="keywordflow">if</span> (val != 0U) {</div>
 454 <div class="line">    count = (SysTick-&gt;LOAD - val) + 1U;</div>
 455 <div class="line">  } <span class="keywordflow">else</span> {</div>
 456 <div class="line">    count = 0U;</div>
 457 <div class="line">  }</div>
 458 <div class="line"> </div>
 459 <div class="line">  <span class="keywordflow">return</span> (count);</div>
 460 <div class="line">}</div>
 461 </div><!-- fragment -->
 462 </div>
 463 </div>
 464 <a id="ga1f9a593126b7f0b66fc526c2cebd6192" name="ga1f9a593126b7f0b66fc526c2cebd6192"></a>
 465 <h2 class="memtitle"><span class="permalink"><a href="#ga1f9a593126b7f0b66fc526c2cebd6192">&#9670;&#160;</a></span>OS_Tick_GetOverflow()</h2>
 466
 467 <div class="memitem">
 468 <div class="memproto">
 469       <table class="memname">
 470         <tr>
 471           <td class="memname">OS_Tick_GetOverflow </td>
 472           <td>(</td>
 473           <td class="paramtype">void&#160;</td>
 474           <td class="paramname"></td><td>)</td>
 475           <td></td>
 476         </tr>
 477       </table>
 478 </div><div class="memdoc">
 479
 480 <p>Get OS Tick timer overflow status. </p>
 481 <dl class="section return"><dt>Returns</dt><dd>OS Tick overflow status (1 - overflow, 0 - no overflow).</dd></dl>
 482 <p>Get OS Tick timer overflow status.</p>
 483 <p>Return the state of OS Tick timer interrupt pending bit that indicates timer overflows to adjust SysTimer calculations.</p>
 484 <p><b>Cortex-M SysTick implementation:</b></p>
 485 <div class="fragment"><div class="line">uint32_t <a class="code hl_function" href="group__CMSIS__RTOS__TickAPI.html#ga1f9a593126b7f0b66fc526c2cebd6192" title="Get OS Tick timer overflow status.">OS_Tick_GetOverflow</a> (<span class="keywordtype">void</span>) {</div>
 486 <div class="line">  <span class="keywordflow">return</span> ((SCB-&gt;ICSR &amp; SCB_ICSR_PENDSTSET_Msk) &gt;&gt; SCB_ICSR_PENDSTSET_Pos);</div>
 487 <div class="line">}</div>
 488 </div><!-- fragment -->
 489 </div>
 490 </div>
 491 </div><!-- contents -->
 492 </div><!-- doc-content -->
 493 <!-- start footer part -->
 494 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 495   <ul>
 496     <li class="footer">
 497       <script type="text/javascript">
 498         <!--
 499         writeFooter.call(this);
 500         //-->
 501       </script>
 502     </li>
 503   </ul>
 504 </div>
 505 </body>
 506 </html>