صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
ARM-software
/
CMSIS_5
mirrorاز https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: a65b7c9a3e
شاخه‌ها تگ‌ها
CMSIS_5
/
docs
/
RTOS2
/
html
/
group__CMSIS__RTOS__TickAPI.html

group__CMSIS__RTOS__TickAPI.html 26 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>OS Tick API</title>
    7. 

  7. <title>CMSIS-RTOS2: OS Tick API</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-RTOS2
    35. 

  35.    &#160;<span id="projectnumber">Version 2.1.3</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('group__CMSIS__RTOS__TickAPI.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
    101. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="summary">
    111. 

  111. <a href="#func-members">Functions</a>  </div>
    112. 

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

  113. <div class="title">OS Tick API</div>  </div>
    114. 

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

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

  116. 

  117. <p>System tick timer interface for periodic RTOS Kernel Ticks defined in <b>os_tick.h</b>  
    118. 

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

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

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

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

  122. <tr class="memitem: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, <a class="el" href="os__tick_8h.html#afbfa2180a9b6208f34891d539e9e2d52">IRQHandler_t</a> handler)</td></tr>
    123. 

  123. <tr class="memdesc:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup OS Tick timer to generate periodic RTOS Kernel Ticks.  <a href="#ga5eeffb4d9dc6c6802fee8898096d9a59">More...</a><br/></td></tr>
    124. 

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

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

  126. <tr class="memdesc:ga3e47971bf3a02599d9ecb32208adafec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable OS Tick timer interrupt.  <a href="#ga3e47971bf3a02599d9ecb32208adafec">More...</a><br/></td></tr>
    127. 

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

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

  129. <tr class="memdesc:ga5e325c304fef5003b1dc31906f6a3056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable OS Tick timer interrupt.  <a href="#ga5e325c304fef5003b1dc31906f6a3056">More...</a><br/></td></tr>
    130. 

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

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

  132. <tr class="memdesc:ga57065ec4b281504ad4de13a419870b4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acknowledge execution of OS Tick timer interrupt.  <a href="#ga57065ec4b281504ad4de13a419870b4f">More...</a><br/></td></tr>
    133. 

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

  134. <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>
    135. 

  135. <tr class="memdesc:gaa8b4eca23e3ffe2df403291958cdc905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer IRQ number.  <a href="#gaa8b4eca23e3ffe2df403291958cdc905">More...</a><br/></td></tr>
    136. 

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

  137. <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>
    138. 

  138. <tr class="memdesc:ga936217ea28236fb57648973e0d8f627a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer clock frequency.  <a href="#ga936217ea28236fb57648973e0d8f627a">More...</a><br/></td></tr>
    139. 

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

  140. <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>
    141. 

  141. <tr class="memdesc:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer interval reload value.  <a href="#ga123151dc19d5a94a68f12cdbf61a9bb5">More...</a><br/></td></tr>
    142. 

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

  143. <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>
    144. 

  144. <tr class="memdesc:gaa64a145a554f1e5077848938d7f39c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer counter value.  <a href="#gaa64a145a554f1e5077848938d7f39c92">More...</a><br/></td></tr>
    145. 

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

  146. <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>
    147. 

  147. <tr class="memdesc:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer overflow status.  <a href="#ga1f9a593126b7f0b66fc526c2cebd6192">More...</a><br/></td></tr>
    148. 

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

  149. </table>
    150. 

  150. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    151. 

  151. <p>The <b>OS Tick API</b> is an interface to a system timer that generates the Kernel Ticks.</p>
    152. 

  152. <p>All Cortex-M processors provide an unified System Tick Timer that is typically used to generate the RTOS Kernel Tick. The Cortex-A processors do not implement an unified system timer and required a device specific implementation.</p>
    153. 

  153. <p>CMSIS-RTOS2 provides in the directory <a class="el" href="index.html#directory">CMSIS/RTOS2/Source</a> the several OS Tick implementations that can be used by any RTOS kernel.</p>
    154. 

  154. <table class="doxtable">
    155. 

  155. <tr>
    156. 

  156. <th align="left">Filename </th><th align="left">OS Tick Implementation for...  </th></tr>
    157. 

  157. <tr>
    158. 

  158. <td align="left"><b>os_systick.c</b> </td><td align="left">Cortex-M SysTick timer </td></tr>
    159. 

  159. <tr>
    160. 

  160. <td align="left"><b>os_tick_gtim.c</b> </td><td align="left">Cortex-A Generic Timer (available in some devices) </td></tr>
    161. 

  161. <tr>
    162. 

  162. <td align="left"><b>os_tick_ptim.c</b> </td><td align="left">Cortex-A Private Timer (available in some devices) </td></tr>
    163. 

  163. </table>
    164. 

  164. <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>
    165. 

  165. <h2 class="groupheader">Function Documentation</h2>
    166. 

  166. <a class="anchor" id="ga5eeffb4d9dc6c6802fee8898096d9a59"></a>
    167. 

  167. <div class="memitem">
    168. 

  168. <div class="memproto">
    169. 

  169.       <table class="memname">
    170. 

  170.         <tr>
    171. 

  171.           <td class="memname">int32_t OS_Tick_Setup </td>
    172. 

  172.           <td>(</td>
    173. 

  173.           <td class="paramtype">uint32_t&#160;</td>
    174. 

  174.           <td class="paramname"><em>freq</em>, </td>
    175. 

  175.         </tr>
    176. 

  176.         <tr>
    177. 

  177.           <td class="paramkey"></td>
    178. 

  178.           <td></td>
    179. 

  179.           <td class="paramtype"><a class="el" href="os__tick_8h.html#afbfa2180a9b6208f34891d539e9e2d52">IRQHandler_t</a>&#160;</td>
    180. 

  180.           <td class="paramname"><em>handler</em>&#160;</td>
    181. 

  181.         </tr>
    182. 

  182.         <tr>
    183. 

  183.           <td></td>
    184. 

  184.           <td>)</td>
    185. 

  185.           <td></td><td></td>
    186. 

  186.         </tr>
    187. 

  187.       </table>
    188. 

  188. </div><div class="memdoc">
    189. 

  189. <dl class="params"><dt>Parameters</dt><dd>
    190. 

  190.   <table class="params">
    191. 

  191.     <tr><td class="paramdir">[in]</td><td class="paramname">freq</td><td>tick frequency in Hz </td></tr>
    192. 

  192.     <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>tick IRQ handler </td></tr>
    193. 

  193.   </table>
    194. 

  194.   </dd>
    195. 

  195. </dl>
    196. 

  196. <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error.</dd></dl>
    197. 

  197. <p>Setup OS Tick timer to generate periodic RTOS Kernel Ticks.</p>
    198. 

  198. <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>
    199. 

  199. <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#ga3e47971bf3a02599d9ecb32208adafec">OS_Tick_Enable</a> to start the timer interrupts.</p>
    200. 

  200. <p><b>Cortex-M SysTick implementation:</b> </p>
    201. 

  201. <div class="fragment"><div class="line"><span class="preprocessor">#ifndef SYSTICK_IRQ_PRIORITY</span></div>
    202. 

  202. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define SYSTICK_IRQ_PRIORITY    0xFFU</span></div>
    203. 

  203. <div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
    204. 

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

  205. <div class="line"><span class="keyword">static</span> uint8_t PendST;</div>
    206. 

  206. <div class="line"></div>
    207. 

  207. <div class="line">int32_t  <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga5eeffb4d9dc6c6802fee8898096d9a59">OS_Tick_Setup</a> (uint32_t freq, <a class="code" href="os__tick_8h.html#afbfa2180a9b6208f34891d539e9e2d52">IRQHandler_t</a> handler) {</div>
    208. 

  208. <div class="line">  (void)handler;</div>
    209. 

  209. <div class="line">  uint32_t load;</div>
    210. 

  210. <div class="line"></div>
    211. 

  211. <div class="line">  <span class="keywordflow">if</span> (freq == 0U) {</div>
    212. 

  212. <div class="line">    <span class="keywordflow">return</span> (-1);</div>
    213. 

  213. <div class="line">  }</div>
    214. 

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

  215. <div class="line">  load = (SystemCoreClock / freq) - 1U;</div>
    216. 

  216. <div class="line">  <span class="keywordflow">if</span> (load &gt; 0x00FFFFFFU) {</div>
    217. 

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

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

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

  220. <div class="line">  NVIC_SetPriority(SysTick_IRQn, SYSTICK_IRQ_PRIORITY);</div>
    221. 

  221. <div class="line"></div>
    222. 

  222. <div class="line">  SysTick-&gt;CTRL =  SysTick_CTRL_CLKSOURCE_Msk | SysTick_CTRL_TICKINT_Msk;</div>
    223. 

  223. <div class="line">  SysTick-&gt;LOAD =  load;</div>
    224. 

  224. <div class="line">  SysTick-&gt;VAL  =  0U;</div>
    225. 

  225. <div class="line"></div>
    226. 

  226. <div class="line">  PendST = 0U;</div>
    227. 

  227. <div class="line"></div>
    228. 

  228. <div class="line">  <span class="keywordflow">return</span> (0);</div>
    229. 

  229. <div class="line">}</div>
    230. 

  230. </div><!-- fragment --> 
    231. 

  231. </div>
    232. 

  232. </div>
    233. 

  233. <a class="anchor" id="ga3e47971bf3a02599d9ecb32208adafec"></a>
    234. 

  234. <div class="memitem">
    235. 

  235. <div class="memproto">
    236. 

  236.       <table class="memname">
    237. 

  237.         <tr>
    238. 

  238.           <td class="memname">int32_t OS_Tick_Enable </td>
    239. 

  239.           <td>(</td>
    240. 

  240.           <td class="paramtype">void&#160;</td>
    241. 

  241.           <td class="paramname"></td><td>)</td>
    242. 

  242.           <td></td>
    243. 

  243.         </tr>
    244. 

  244.       </table>
    245. 

  245. </div><div class="memdoc">
    246. 

  246. <p>Enable OS Tick timer interrupt.</p>
    247. 

  247. <p>Enable and start the OS Tick timer to generate periodic RTOS Kernel Tick interrupts.</p>
    248. 

  248. <p><b>Cortex-M SysTick implementation:</b> </p>
    249. 

  249. <div class="fragment"><div class="line">int32_t  <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga3e47971bf3a02599d9ecb32208adafec">OS_Tick_Enable</a> (<span class="keywordtype">void</span>) {</div>
    250. 

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

  251. <div class="line">  <span class="keywordflow">if</span> (PendST != 0U) {</div>
    252. 

  252. <div class="line">    PendST = 0U;</div>
    253. 

  253. <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTSET_Msk;</div>
    254. 

  254. <div class="line">  }</div>
    255. 

  255. <div class="line"></div>
    256. 

  256. <div class="line">  SysTick-&gt;CTRL |=  SysTick_CTRL_ENABLE_Msk;</div>
    257. 

  257. <div class="line"></div>
    258. 

  258. <div class="line">  <span class="keywordflow">return</span> (0);</div>
    259. 

  259. <div class="line">}</div>
    260. 

  260. </div><!-- fragment --> 
    261. 

  261. </div>
    262. 

  262. </div>
    263. 

  263. <a class="anchor" id="ga5e325c304fef5003b1dc31906f6a3056"></a>
    264. 

  264. <div class="memitem">
    265. 

  265. <div class="memproto">
    266. 

  266.       <table class="memname">
    267. 

  267.         <tr>
    268. 

  268.           <td class="memname">int32_t OS_Tick_Disable </td>
    269. 

  269.           <td>(</td>
    270. 

  270.           <td class="paramtype">void&#160;</td>
    271. 

  271.           <td class="paramname"></td><td>)</td>
    272. 

  272.           <td></td>
    273. 

  273.         </tr>
    274. 

  274.       </table>
    275. 

  275. </div><div class="memdoc">
    276. 

  276. <p>Disable OS Tick timer interrupt.</p>
    277. 

  277. <p>Stop the OS Tick timer and disable generation of RTOS Kernel Tick interrupts.</p>
    278. 

  278. <p><b>Cortex-M SysTick implementation:</b> </p>
    279. 

  279. <div class="fragment"><div class="line">int32_t  <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga5e325c304fef5003b1dc31906f6a3056">OS_Tick_Disable</a> (<span class="keywordtype">void</span>) {</div>
    280. 

  280. <div class="line"></div>
    281. 

  281. <div class="line">  SysTick-&gt;CTRL &amp;= ~SysTick_CTRL_ENABLE_Msk;</div>
    282. 

  282. <div class="line"></div>
    283. 

  283. <div class="line">  <span class="keywordflow">if</span> ((SCB-&gt;ICSR &amp; SCB_ICSR_PENDSTSET_Msk) != 0U) {</div>
    284. 

  284. <div class="line">    SCB-&gt;ICSR = SCB_ICSR_PENDSTCLR_Msk;</div>
    285. 

  285. <div class="line">    PendST = 1U;</div>
    286. 

  286. <div class="line">  }</div>
    287. 

  287. <div class="line"></div>
    288. 

  288. <div class="line">  <span class="keywordflow">return</span> (0);</div>
    289. 

  289. <div class="line">}</div>
    290. 

  290. </div><!-- fragment --> 
    291. 

  291. </div>
    292. 

  292. </div>
    293. 

  293. <a class="anchor" id="ga57065ec4b281504ad4de13a419870b4f"></a>
    294. 

  294. <div class="memitem">
    295. 

  295. <div class="memproto">
    296. 

  296.       <table class="memname">
    297. 

  297.         <tr>
    298. 

  298.           <td class="memname">int32_t OS_Tick_AcknowledgeIRQ </td>
    299. 

  299.           <td>(</td>
    300. 

  300.           <td class="paramtype">void&#160;</td>
    301. 

  301.           <td class="paramname"></td><td>)</td>
    302. 

  302.           <td></td>
    303. 

  303.         </tr>
    304. 

  304.       </table>
    305. 

  305. </div><div class="memdoc">
    306. 

  306. <p>Acknowledge execution of OS Tick timer interrupt.</p>
    307. 

  307. <p>Acknowledge the execution of the OS Tick timer interrupt function, for example clear the pending flag.</p>
    308. 

  308. <p><b>Cortex-M SysTick implementation:</b></p>
    309. 

  309. <div class="fragment"><div class="line">int32_t  <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga57065ec4b281504ad4de13a419870b4f">OS_Tick_AcknowledgeIRQ</a> (<span class="keywordtype">void</span>) {</div>
    310. 

  310. <div class="line">  (void)SysTick-&gt;CTRL;</div>
    311. 

  311. <div class="line">  return (0);</div>
    312. 

  312. <div class="line">}</div>
    313. 

  313. </div><!-- fragment --> 
    314. 

  314. </div>
    315. 

  315. </div>
    316. 

  316. <a class="anchor" id="gaa8b4eca23e3ffe2df403291958cdc905"></a>
    317. 

  317. <div class="memitem">
    318. 

  318. <div class="memproto">
    319. 

  319.       <table class="memname">
    320. 

  320.         <tr>
    321. 

  321.           <td class="memname">int32_t OS_Tick_GetIRQn </td>
    322. 

  322.           <td>(</td>
    323. 

  323.           <td class="paramtype">void&#160;</td>
    324. 

  324.           <td class="paramname"></td><td>)</td>
    325. 

  325.           <td></td>
    326. 

  326.         </tr>
    327. 

  327.       </table>
    328. 

  328. </div><div class="memdoc">
    329. 

  329. <dl class="section return"><dt>Returns</dt><dd>OS Tick IRQ number</dd></dl>
    330. 

  330. <p>Get OS Tick timer IRQ number.</p>
    331. 

  331. <p>Return the numeric value that identifies the interrupt called by the OS Tick timer.</p>
    332. 

  332. <p><b>Cortex-M SysTick implementation:</b></p>
    333. 

  333. <div class="fragment"><div class="line">int32_t  <a class="code" href="group__CMSIS__RTOS__TickAPI.html#gaa8b4eca23e3ffe2df403291958cdc905">OS_Tick_GetIRQn</a> (<span class="keywordtype">void</span>) {</div>
    334. 

  334. <div class="line">  <span class="keywordflow">return</span> (SysTick_IRQn);</div>
    335. 

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

  336. </div><!-- fragment --> 
    337. 

  337. </div>
    338. 

  338. </div>
    339. 

  339. <a class="anchor" id="ga936217ea28236fb57648973e0d8f627a"></a>
    340. 

  340. <div class="memitem">
    341. 

  341. <div class="memproto">
    342. 

  342.       <table class="memname">
    343. 

  343.         <tr>
    344. 

  344.           <td class="memname">uint32_t OS_Tick_GetClock </td>
    345. 

  345.           <td>(</td>
    346. 

  346.           <td class="paramtype">void&#160;</td>
    347. 

  347.           <td class="paramname"></td><td>)</td>
    348. 

  348.           <td></td>
    349. 

  349.         </tr>
    350. 

  350.       </table>
    351. 

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

  352. <dl class="section return"><dt>Returns</dt><dd>OS Tick timer clock frequency in Hz</dd></dl>
    353. 

  353. <p>Get OS Tick timer clock frequency.</p>
    354. 

  354. <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>
    355. 

  355. <p><b>Cortex-M SysTick implementation:</b></p>
    356. 

  356. <div class="fragment"><div class="line">uint32_t <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga936217ea28236fb57648973e0d8f627a">OS_Tick_GetClock</a> (<span class="keywordtype">void</span>) {</div>
    357. 

  357. <div class="line">  <span class="keywordflow">return</span> (SystemCoreClock);</div>
    358. 

  358. <div class="line">}</div>
    359. 

  359. </div><!-- fragment --> 
    360. 

  360. </div>
    361. 

  361. </div>
    362. 

  362. <a class="anchor" id="ga123151dc19d5a94a68f12cdbf61a9bb5"></a>
    363. 

  363. <div class="memitem">
    364. 

  364. <div class="memproto">
    365. 

  365.       <table class="memname">
    366. 

  366.         <tr>
    367. 

  367.           <td class="memname">uint32_t OS_Tick_GetInterval </td>
    368. 

  368.           <td>(</td>
    369. 

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

  370.           <td class="paramname"></td><td>)</td>
    371. 

  371.           <td></td>
    372. 

  372.         </tr>
    373. 

  373.       </table>
    374. 

  374. </div><div class="memdoc">
    375. 

  375. <dl class="section return"><dt>Returns</dt><dd>OS Tick timer interval reload value</dd></dl>
    376. 

  376. <p>Get OS Tick timer interval reload value.</p>
    377. 

  377. <p>Return the number of counter ticks between to periodic OS Tick timer interrupts.</p>
    378. 

  378. <p><b>Cortex-M SysTick implementation:</b></p>
    379. 

  379. <div class="fragment"><div class="line">uint32_t <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga123151dc19d5a94a68f12cdbf61a9bb5">OS_Tick_GetInterval</a> (<span class="keywordtype">void</span>) {</div>
    380. 

  380. <div class="line">  <span class="keywordflow">return</span> (SysTick-&gt;LOAD + 1U);</div>
    381. 

  381. <div class="line">}</div>
    382. 

  382. </div><!-- fragment --> 
    383. 

  383. </div>
    384. 

  384. </div>
    385. 

  385. <a class="anchor" id="gaa64a145a554f1e5077848938d7f39c92"></a>
    386. 

  386. <div class="memitem">
    387. 

  387. <div class="memproto">
    388. 

  388.       <table class="memname">
    389. 

  389.         <tr>
    390. 

  390.           <td class="memname">uint32_t OS_Tick_GetCount </td>
    391. 

  391.           <td>(</td>
    392. 

  392.           <td class="paramtype">void&#160;</td>
    393. 

  393.           <td class="paramname"></td><td>)</td>
    394. 

  394.           <td></td>
    395. 

  395.         </tr>
    396. 

  396.       </table>
    397. 

  397. </div><div class="memdoc">
    398. 

  398. <dl class="section return"><dt>Returns</dt><dd>OS Tick timer counter value</dd></dl>
    399. 

  399. <p>Get OS Tick timer counter value.</p>
    400. 

  400. <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>
    401. 

  401. <p><b>Cortex-M SysTick implementation:</b></p>
    402. 

  402. <div class="fragment"><div class="line">uint32_t <a class="code" href="group__CMSIS__RTOS__TickAPI.html#gaa64a145a554f1e5077848938d7f39c92">OS_Tick_GetCount</a> (<span class="keywordtype">void</span>) {</div>
    403. 

  403. <div class="line">  uint32_t load = SysTick-&gt;LOAD;</div>
    404. 

  404. <div class="line">  <span class="keywordflow">return</span>  (load - SysTick-&gt;VAL);</div>
    405. 

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

  406. </div><!-- fragment --> 
    407. 

  407. </div>
    408. 

  408. </div>
    409. 

  409. <a class="anchor" id="ga1f9a593126b7f0b66fc526c2cebd6192"></a>
    410. 

  410. <div class="memitem">
    411. 

  411. <div class="memproto">
    412. 

  412.       <table class="memname">
    413. 

  413.         <tr>
    414. 

  414.           <td class="memname">OS_Tick_GetOverflow </td>
    415. 

  415.           <td>(</td>
    416. 

  416.           <td class="paramtype">void&#160;</td>
    417. 

  417.           <td class="paramname"></td><td>)</td>
    418. 

  418.           <td></td>
    419. 

  419.         </tr>
    420. 

  420.       </table>
    421. 

  421. </div><div class="memdoc">
    422. 

  422. <dl class="section return"><dt>Returns</dt><dd>OS Tick overflow status (1 - overflow, 0 - no overflow).</dd></dl>
    423. 

  423. <p>Get OS Tick timer overflow status.</p>
    424. 

  424. <p>Return the state of OS Tick timer interrupt pending bit that indicates timer overflows to adjust SysTimer calculations.</p>
    425. 

  425. <p><b>Cortex-M SysTick implementation:</b></p>
    426. 

  426. <div class="fragment"><div class="line">uint32_t <a class="code" href="group__CMSIS__RTOS__TickAPI.html#ga1f9a593126b7f0b66fc526c2cebd6192">OS_Tick_GetOverflow</a> (<span class="keywordtype">void</span>) {</div>
    427. 

  427. <div class="line">  <span class="keywordflow">return</span> ((SysTick-&gt;CTRL &gt;&gt; 16) &amp; 1U);</div>
    428. 

  428. <div class="line">}</div>
    429. 

  429. </div><!-- fragment --> 
    430. 

  430. </div>
    431. 

  431. </div>
    432. 

  432. </div><!-- contents -->
    433. 

  433. </div><!-- doc-content -->
    434. 

  434. <!-- start footer part -->
    435. 

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

  436.   <ul>
    437. 

  437.     <li class="footer">Generated on Thu Apr 9 2020 15:50:01 for CMSIS-RTOS2 Version 2.1.3 by Arm Ltd. All rights reserved.
    438. 

  438. 	<!--
    439. 

  439.     <a href="http://www.doxygen.org/index.html">
    440. 

  440.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    441. 

  441. 	-->
    442. 

  442. 	</li>
    443. 

  443.   </ul>
    444. 

  444. </div>
    445. 

  445. </body>
    446. 

  446. </html>
    447.