begriffs open source - cmsis/blob - v6.0.0/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 <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__TickAPI.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="#func-members">Functions</a>  </div>
 129   <div class="headertitle"><div class="title">OS Tick API</div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>System tick timer interface for periodic RTOS Kernel Ticks defined in <b>os_tick.h</b>
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 137 Functions</h2></td></tr>
 138 <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>
 139 <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>
 140 <tr class="separator:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <tr class="memdesc:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable OS Tick timer interrupt.  <br /></td></tr>
 143 <tr class="separator:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable OS Tick timer interrupt.  <br /></td></tr>
 146 <tr class="separator:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <tr class="memdesc:ga14c430d2b363ebd9f904b0822a9314e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acknowledge execution of OS Tick timer interrupt.  <br /></td></tr>
 149 <tr class="separator:ga14c430d2b363ebd9f904b0822a9314e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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>
 151 <tr class="memdesc:gaa8b4eca23e3ffe2df403291958cdc905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer IRQ number.  <br /></td></tr>
 152 <tr class="separator:gaa8b4eca23e3ffe2df403291958cdc905"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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>
 154 <tr class="memdesc:ga936217ea28236fb57648973e0d8f627a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer clock frequency.  <br /></td></tr>
 155 <tr class="separator:ga936217ea28236fb57648973e0d8f627a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <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>
 157 <tr class="memdesc:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer interval reload value.  <br /></td></tr>
 158 <tr class="separator:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <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>
 160 <tr class="memdesc:gaa64a145a554f1e5077848938d7f39c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer counter value.  <br /></td></tr>
 161 <tr class="separator:gaa64a145a554f1e5077848938d7f39c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <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>
 163 <tr class="memdesc:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer overflow status.  <br /></td></tr>
 164 <tr class="separator:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 </table>
 166 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 167 <p>System tick timer interface for periodic RTOS Kernel Ticks defined in <b>os_tick.h</b> </p>
 168 <p>The <b>OS Tick API</b> is an interface to a system timer that generates the Kernel Ticks.</p>
 169 <p>All Cortex-M processors provide an unified System Tick Timer that is typically used to generate the RTOS Kernel Tick.</p>
 170 <p>The Cortex-A processors do not implement an unified system timer and required a device specific implementation. </p>
 171 <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>
 172 <table class="markdownTable">
 173 <tr class="markdownTableHead">
 174 <th class="markdownTableHeadLeft">Filename   </th><th class="markdownTableHeadLeft">OS Tick Implementation for...    </th></tr>
 175 <tr class="markdownTableRowOdd">
 176 <td class="markdownTableBodyLeft"><b>os_systick.c</b>   </td><td class="markdownTableBodyLeft">Cortex-M SysTick timer   </td></tr>
 177 </table>
 178 <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>
 179 <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>
 180 <h2 class="groupheader">Function Documentation</h2>
 181 <a id="ga5eeffb4d9dc6c6802fee8898096d9a59" name="ga5eeffb4d9dc6c6802fee8898096d9a59"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#ga5eeffb4d9dc6c6802fee8898096d9a59">&#9670;&#160;</a></span>OS_Tick_Setup()</h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">int32_t OS_Tick_Setup </td>
 189           <td>(</td>
 190           <td class="paramtype">uint32_t&#160;</td>
 191           <td class="paramname"><em>freq</em>, </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype">IRQHandler_t&#160;</td>
 197           <td class="paramname"><em>handler</em>&#160;</td>
 198         </tr>
 199         <tr>
 200           <td></td>
 201           <td>)</td>
 202           <td></td><td></td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206
 207 <p>Setup OS Tick timer to generate periodic RTOS Kernel Ticks. </p>
 208 <dl class="params"><dt>Parameters</dt><dd>
 209   <table class="params">
 210     <tr><td class="paramdir">[in]</td><td class="paramname">freq</td><td>tick frequency in Hz </td></tr>
 211     <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>tick IRQ handler </td></tr>
 212   </table>
 213   </dd>
 214 </dl>
 215 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error.</dd></dl>
 216 <p>Setup OS Tick timer to generate periodic RTOS Kernel Ticks.</p>
 217 <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>
 218 <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>
 219 <p><b>Cortex-M SysTick implementation:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#ifndef SYSTICK_IRQ_PRIORITY</span></div>
 220 <div class="line"><span class="preprocessor">#define SYSTICK_IRQ_PRIORITY    0xFFU</span></div>
 221 <div class="line"><span class="preprocessor">#endif</span></div>
 222 <div class="line"> </div>
 223 <div class="line"><span class="keyword">static</span> uint8_t PendST;</div>
 224 <div class="line"> </div>
 225 <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>
 226 <div class="line">  (void)handler;</div>
 227 <div class="line">  uint32_t load;</div>
 228 <div class="line"> </div>
 229 <div class="line">  <span class="keywordflow">if</span> (freq == 0U) {</div>
 230 <div class="line">    <span class="keywordflow">return</span> (-1);</div>
 231 <div class="line">  }</div>
 232 <div class="line"> </div>
 233 <div class="line">  load = (SystemCoreClock / freq) - 1U;</div>
 234 <div class="line">  <span class="keywordflow">if</span> (load &gt; 0x00FFFFFFU) {</div>
 235 <div class="line">    <span class="keywordflow">return</span> (-1);</div>
 236 <div class="line">  }</div>
 237 <div class="line"> </div>
 238 <div class="line">  NVIC_SetPriority(SysTick_IRQn, SYSTICK_IRQ_PRIORITY);</div>
 239 <div class="line"> </div>
 240 <div class="line">  SysTick-&gt;CTRL =  SysTick_CTRL_CLKSOURCE_Msk | SysTick_CTRL_TICKINT_Msk;</div>
 241 <div class="line">  SysTick-&gt;LOAD =  load;</div>
 242 <div class="line">  SysTick-&gt;VAL  =  0U;</div>
 243 <div class="line"> </div>
 244 <div class="line">  PendST = 0U;</div>
 245 <div class="line"> </div>
 246 <div class="line">  <span class="keywordflow">return</span> (0);</div>
 247 <div class="line">}</div>
 248 </div><!-- fragment -->
 249 </div>
 250 </div>
 251 <a id="gaaa0d6ddef6816e8e5650fde3daf191e7" name="gaaa0d6ddef6816e8e5650fde3daf191e7"></a>
 252 <h2 class="memtitle"><span class="permalink"><a href="#gaaa0d6ddef6816e8e5650fde3daf191e7">&#9670;&#160;</a></span>OS_Tick_Enable()</h2>
 253
 254 <div class="memitem">
 255 <div class="memproto">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">void OS_Tick_Enable </td>
 259           <td>(</td>
 260           <td class="paramtype">void&#160;</td>
 261           <td class="paramname"></td><td>)</td>
 262           <td></td>
 263         </tr>
 264       </table>
 265 </div><div class="memdoc">
 266
 267 <p>Enable OS Tick timer interrupt. </p>
 268 <p>Enable OS Tick timer interrupt.</p>
 269 <p>Enable and start the OS Tick timer to generate periodic RTOS Kernel Tick interrupts.</p>
 270 <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>
 271 <div class="line"> </div>
 272 <div class="line">  <span class="keywordflow">if</span> (PendST != 0U) {</div>
 273 <div class="line">    PendST = 0U;</div>
 274 <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTSET_Msk;</div>
 275 <div class="line">  }</div>
 276 <div class="line"> </div>
 277 <div class="line">  SysTick-&gt;CTRL |=  SysTick_CTRL_ENABLE_Msk;</div>
 278 <div class="line"> </div>
 279 <div class="line">}</div>
 280 </div><!-- fragment -->
 281 </div>
 282 </div>
 283 <a id="ga50fc040b66fabd1945d2bd1d0d05661d" name="ga50fc040b66fabd1945d2bd1d0d05661d"></a>
 284 <h2 class="memtitle"><span class="permalink"><a href="#ga50fc040b66fabd1945d2bd1d0d05661d">&#9670;&#160;</a></span>OS_Tick_Disable()</h2>
 285
 286 <div class="memitem">
 287 <div class="memproto">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname">void OS_Tick_Disable </td>
 291           <td>(</td>
 292           <td class="paramtype">void&#160;</td>
 293           <td class="paramname"></td><td>)</td>
 294           <td></td>
 295         </tr>
 296       </table>
 297 </div><div class="memdoc">
 298
 299 <p>Disable OS Tick timer interrupt. </p>
 300 <p>Disable OS Tick timer interrupt.</p>
 301 <p>Stop the OS Tick timer and disable generation of RTOS Kernel Tick interrupts.</p>
 302 <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>
 303 <div class="line"> </div>
 304 <div class="line">  SysTick-&gt;CTRL &amp;= ~SysTick_CTRL_ENABLE_Msk;</div>
 305 <div class="line"> </div>
 306 <div class="line">  <span class="keywordflow">if</span> ((SCB-&gt;ICSR &amp; SCB_ICSR_PENDSTSET_Msk) != 0U) {</div>
 307 <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTCLR_Msk;</div>
 308 <div class="line">    PendST = 1U;</div>
 309 <div class="line">  }</div>
 310 <div class="line"> </div>
 311 <div class="line">}</div>
 312 </div><!-- fragment -->
 313 </div>
 314 </div>
 315 <a id="ga14c430d2b363ebd9f904b0822a9314e7" name="ga14c430d2b363ebd9f904b0822a9314e7"></a>
 316 <h2 class="memtitle"><span class="permalink"><a href="#ga14c430d2b363ebd9f904b0822a9314e7">&#9670;&#160;</a></span>OS_Tick_AcknowledgeIRQ()</h2>
 317
 318 <div class="memitem">
 319 <div class="memproto">
 320       <table class="memname">
 321         <tr>
 322           <td class="memname">void OS_Tick_AcknowledgeIRQ </td>
 323           <td>(</td>
 324           <td class="paramtype">void&#160;</td>
 325           <td class="paramname"></td><td>)</td>
 326           <td></td>
 327         </tr>
 328       </table>
 329 </div><div class="memdoc">
 330
 331 <p>Acknowledge execution of OS Tick timer interrupt. </p>
 332 <p>Acknowledge execution of OS Tick timer interrupt.</p>
 333 <p>Acknowledge the execution of the OS Tick timer interrupt function, for example clear the pending flag.</p>
 334 <p><b>Cortex-M SysTick implementation:</b></p>
 335 <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>
 336 <div class="line"> </div>
 337 <div class="line">  (void)SysTick-&gt;CTRL;</div>
 338 <div class="line"> </div>
 339 <div class="line">}</div>
 340 </div><!-- fragment -->
 341 </div>
 342 </div>
 343 <a id="gaa8b4eca23e3ffe2df403291958cdc905" name="gaa8b4eca23e3ffe2df403291958cdc905"></a>
 344 <h2 class="memtitle"><span class="permalink"><a href="#gaa8b4eca23e3ffe2df403291958cdc905">&#9670;&#160;</a></span>OS_Tick_GetIRQn()</h2>
 345
 346 <div class="memitem">
 347 <div class="memproto">
 348       <table class="memname">
 349         <tr>
 350           <td class="memname">int32_t OS_Tick_GetIRQn </td>
 351           <td>(</td>
 352           <td class="paramtype">void&#160;</td>
 353           <td class="paramname"></td><td>)</td>
 354           <td></td>
 355         </tr>
 356       </table>
 357 </div><div class="memdoc">
 358
 359 <p>Get OS Tick timer IRQ number. </p>
 360 <dl class="section return"><dt>Returns</dt><dd>OS Tick IRQ number</dd></dl>
 361 <p>Get OS Tick timer IRQ number.</p>
 362 <p>Return the numeric value that identifies the interrupt called by the OS Tick timer.</p>
 363 <p><b>Cortex-M SysTick implementation:</b></p>
 364 <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>
 365 <div class="line">  <span class="keywordflow">return</span> ((int32_t)SysTick_IRQn);</div>
 366 <div class="line">}</div>
 367 </div><!-- fragment -->
 368 </div>
 369 </div>
 370 <a id="ga936217ea28236fb57648973e0d8f627a" name="ga936217ea28236fb57648973e0d8f627a"></a>
 371 <h2 class="memtitle"><span class="permalink"><a href="#ga936217ea28236fb57648973e0d8f627a">&#9670;&#160;</a></span>OS_Tick_GetClock()</h2>
 372
 373 <div class="memitem">
 374 <div class="memproto">
 375       <table class="memname">
 376         <tr>
 377           <td class="memname">uint32_t OS_Tick_GetClock </td>
 378           <td>(</td>
 379           <td class="paramtype">void&#160;</td>
 380           <td class="paramname"></td><td>)</td>
 381           <td></td>
 382         </tr>
 383       </table>
 384 </div><div class="memdoc">
 385
 386 <p>Get OS Tick timer clock frequency. </p>
 387 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer clock frequency in Hz</dd></dl>
 388 <p>Get OS Tick timer clock frequency.</p>
 389 <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>
 390 <p><b>Cortex-M SysTick implementation:</b></p>
 391 <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>
 392 <div class="line">  <span class="keywordflow">return</span> (SystemCoreClock);</div>
 393 <div class="line">}</div>
 394 </div><!-- fragment -->
 395 </div>
 396 </div>
 397 <a id="ga123151dc19d5a94a68f12cdbf61a9bb5" name="ga123151dc19d5a94a68f12cdbf61a9bb5"></a>
 398 <h2 class="memtitle"><span class="permalink"><a href="#ga123151dc19d5a94a68f12cdbf61a9bb5">&#9670;&#160;</a></span>OS_Tick_GetInterval()</h2>
 399
 400 <div class="memitem">
 401 <div class="memproto">
 402       <table class="memname">
 403         <tr>
 404           <td class="memname">uint32_t OS_Tick_GetInterval </td>
 405           <td>(</td>
 406           <td class="paramtype">void&#160;</td>
 407           <td class="paramname"></td><td>)</td>
 408           <td></td>
 409         </tr>
 410       </table>
 411 </div><div class="memdoc">
 412
 413 <p>Get OS Tick timer interval reload value. </p>
 414 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer interval reload value</dd></dl>
 415 <p>Get OS Tick timer interval reload value.</p>
 416 <p>Return the number of counter ticks between to periodic OS Tick timer interrupts.</p>
 417 <p><b>Cortex-M SysTick implementation:</b></p>
 418 <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>
 419 <div class="line">  <span class="keywordflow">return</span> (SysTick-&gt;LOAD + 1U);</div>
 420 <div class="line">}</div>
 421 </div><!-- fragment -->
 422 </div>
 423 </div>
 424 <a id="gaa64a145a554f1e5077848938d7f39c92" name="gaa64a145a554f1e5077848938d7f39c92"></a>
 425 <h2 class="memtitle"><span class="permalink"><a href="#gaa64a145a554f1e5077848938d7f39c92">&#9670;&#160;</a></span>OS_Tick_GetCount()</h2>
 426
 427 <div class="memitem">
 428 <div class="memproto">
 429       <table class="memname">
 430         <tr>
 431           <td class="memname">uint32_t OS_Tick_GetCount </td>
 432           <td>(</td>
 433           <td class="paramtype">void&#160;</td>
 434           <td class="paramname"></td><td>)</td>
 435           <td></td>
 436         </tr>
 437       </table>
 438 </div><div class="memdoc">
 439
 440 <p>Get OS Tick timer counter value. </p>
 441 <dl class="section return"><dt>Returns</dt><dd>OS Tick timer counter value</dd></dl>
 442 <p>Get OS Tick timer counter value.</p>
 443 <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>
 444 <p><b>Cortex-M SysTick implementation:</b></p>
 445 <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>
 446 <div class="line">  uint32_t val;</div>
 447 <div class="line">  uint32_t count;</div>
 448 <div class="line"> </div>
 449 <div class="line">  val = SysTick-&gt;VAL;</div>
 450 <div class="line">  <span class="keywordflow">if</span> (val != 0U) {</div>
 451 <div class="line">    count = (SysTick-&gt;LOAD - val) + 1U;</div>
 452 <div class="line">  } <span class="keywordflow">else</span> {</div>
 453 <div class="line">    count = 0U;</div>
 454 <div class="line">  }</div>
 455 <div class="line"> </div>
 456 <div class="line">  <span class="keywordflow">return</span> (count);</div>
 457 <div class="line">}</div>
 458 </div><!-- fragment -->
 459 </div>
 460 </div>
 461 <a id="ga1f9a593126b7f0b66fc526c2cebd6192" name="ga1f9a593126b7f0b66fc526c2cebd6192"></a>
 462 <h2 class="memtitle"><span class="permalink"><a href="#ga1f9a593126b7f0b66fc526c2cebd6192">&#9670;&#160;</a></span>OS_Tick_GetOverflow()</h2>
 463
 464 <div class="memitem">
 465 <div class="memproto">
 466       <table class="memname">
 467         <tr>
 468           <td class="memname">OS_Tick_GetOverflow </td>
 469           <td>(</td>
 470           <td class="paramtype">void&#160;</td>
 471           <td class="paramname"></td><td>)</td>
 472           <td></td>
 473         </tr>
 474       </table>
 475 </div><div class="memdoc">
 476
 477 <p>Get OS Tick timer overflow status. </p>
 478 <dl class="section return"><dt>Returns</dt><dd>OS Tick overflow status (1 - overflow, 0 - no overflow).</dd></dl>
 479 <p>Get OS Tick timer overflow status.</p>
 480 <p>Return the state of OS Tick timer interrupt pending bit that indicates timer overflows to adjust SysTimer calculations.</p>
 481 <p><b>Cortex-M SysTick implementation:</b></p>
 482 <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>
 483 <div class="line">  <span class="keywordflow">return</span> ((SCB-&gt;ICSR &amp; SCB_ICSR_PENDSTSET_Msk) &gt;&gt; SCB_ICSR_PENDSTSET_Pos);</div>
 484 <div class="line">}</div>
 485 </div><!-- fragment -->
 486 </div>
 487 </div>
 488 </div><!-- contents -->
 489 </div><!-- doc-content -->
 490 <!-- start footer part -->
 491 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 492   <ul>
 493     <li class="footer">
 494       <script type="text/javascript">
 495         <!--
 496         writeFooter.call(this);
 497         //-->
 498       </script>
 499     </li>
 500   </ul>
 501 </div>
 502 </body>
 503 </html>