begriffs open source - cmsis/blob - main/RTOS2/html/os__tick_8h.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.h File Reference</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, "CMSIS-RTOS2");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</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 <!-- 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('os__tick_8h.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="#define-members">Macros</a> &#124;
 129 <a href="#typedef-members">Typedefs</a> &#124;
 130 <a href="#func-members">Functions</a>  </div>
 131   <div class="headertitle"><div class="title">os_tick.h File Reference</div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>CMSIS OS Tick header file.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 139 Macros</h2></td></tr>
 140 <tr class="memitem:aed032df21f11e8715f5c4deeeb56cc36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__tick_8h.html#aed032df21f11e8715f5c4deeeb56cc36">IRQHANDLER_T</a></td></tr>
 141 <tr class="memdesc:aed032df21f11e8715f5c4deeeb56cc36"><td class="mdescLeft">&#160;</td><td class="mdescRight">IRQ Handler.  <br /></td></tr>
 142 <tr class="separator:aed032df21f11e8715f5c4deeeb56cc36"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table><table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 145 Typedefs</h2></td></tr>
 146 <tr class="memitem:a27589275c894aa295615df4764404b98"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__tick_8h.html#a27589275c894aa295615df4764404b98">IRQHandler_t</a>) (void)</td></tr>
 147 <tr class="separator:a27589275c894aa295615df4764404b98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 </table><table class="memberdecls">
 149 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 150 Functions</h2></td></tr>
 151 <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#a27589275c894aa295615df4764404b98">IRQHandler_t</a> handler)</td></tr>
 152 <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>
 153 <tr class="separator:ga5eeffb4d9dc6c6802fee8898096d9a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <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>
 155 <tr class="memdesc:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable OS Tick timer interrupt.  <br /></td></tr>
 156 <tr class="separator:gaaa0d6ddef6816e8e5650fde3daf191e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <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>
 158 <tr class="memdesc:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable OS Tick timer interrupt.  <br /></td></tr>
 159 <tr class="separator:ga50fc040b66fabd1945d2bd1d0d05661d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <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>
 161 <tr class="memdesc:ga14c430d2b363ebd9f904b0822a9314e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acknowledge execution of OS Tick timer interrupt.  <br /></td></tr>
 162 <tr class="separator:ga14c430d2b363ebd9f904b0822a9314e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <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>
 164 <tr class="memdesc:gaa8b4eca23e3ffe2df403291958cdc905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer IRQ number.  <br /></td></tr>
 165 <tr class="separator:gaa8b4eca23e3ffe2df403291958cdc905"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <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>
 167 <tr class="memdesc:ga936217ea28236fb57648973e0d8f627a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer clock frequency.  <br /></td></tr>
 168 <tr class="separator:ga936217ea28236fb57648973e0d8f627a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <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>
 170 <tr class="memdesc:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer interval reload value.  <br /></td></tr>
 171 <tr class="separator:ga123151dc19d5a94a68f12cdbf61a9bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <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>
 173 <tr class="memdesc:gaa64a145a554f1e5077848938d7f39c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer counter value.  <br /></td></tr>
 174 <tr class="separator:gaa64a145a554f1e5077848938d7f39c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <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>
 176 <tr class="memdesc:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get OS Tick timer overflow status.  <br /></td></tr>
 177 <tr class="separator:ga1f9a593126b7f0b66fc526c2cebd6192"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 </table>
 179 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 180 <div class="textblock"><dl class="section version"><dt>Version</dt><dd>V1.0.2 </dd></dl>
 181 <dl class="section date"><dt>Date</dt><dd>19. March 2021 </dd></dl>
 182 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 183 <a id="aed032df21f11e8715f5c4deeeb56cc36" name="aed032df21f11e8715f5c4deeeb56cc36"></a>
 184 <h2 class="memtitle"><span class="permalink"><a href="#aed032df21f11e8715f5c4deeeb56cc36">&#9670;&#160;</a></span>IRQHANDLER_T</h2>
 185
 186 <div class="memitem">
 187 <div class="memproto">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname">#define IRQHANDLER_T</td>
 191         </tr>
 192       </table>
 193 </div><div class="memdoc">
 194
 195 </div>
 196 </div>
 197 <h2 class="groupheader">Typedef Documentation</h2>
 198 <a id="a27589275c894aa295615df4764404b98" name="a27589275c894aa295615df4764404b98"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#a27589275c894aa295615df4764404b98">&#9670;&#160;</a></span>IRQHandler_t</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">typedef void(* IRQHandler_t) (void)</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 </div>
 211 </div>
 212 </div><!-- contents -->
 213 </div><!-- doc-content -->
 214 <!-- start footer part -->
 215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 216   <ul>
 217     <li class="navelem"><a class="el" href="dir_a43355fbfff7212ac2193223a73d577c.html">RTOS2</a></li><li class="navelem"><a class="el" href="dir_f5870d36a7061bb81e1a64a750696f2d.html">Include</a></li><li class="navelem"><a class="el" href="os__tick_8h.html">os_tick.h</a></li>
 218     <li class="footer">
 219       <script type="text/javascript">
 220         <!--
 221         writeFooter.call(this);
 222         //-->
 223       </script>
 224     </li>
 225   </ul>
 226 </div>
 227 </body>
 228 </html>