begriffs open source - cmsis/blob - main/Core_A/group__PTM__timer__functions.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-Core (Cortex-A): Private Timer Functions</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-Core (Cortex-A)
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</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__PTM__timer__functions.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#nested-classes">Data Structures</a> &#124;
 129 <a href="#define-members">Macros</a> &#124;
 130 <a href="#func-members">Functions</a>  </div>
 131   <div class="headertitle"><div class="title">Private Timer Functions<div class="ingroups"><a class="el" href="group__CMSIS__Core__FunctionInterface.html">Core Peripherals</a></div></div></div>
 132 </div><!--header-->
 133 <div class="contents">
 134
 135 <p>Private Timer Functions controls private timer registers present on Cortex-A5 and A9 class devices.<br  />
 136 References: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0434c/index.html">Cortex-A5 MPCore Technical Reference Manual</a>, <a href="http://infocenter.arm.com/help/topic/com.arm.doc.100486_0401_10_en/index.html">Cortex-A9 MPCore Technical Reference Manual</a>.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 140 Data Structures</h2></td></tr>
 141 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimer__Type.html">Timer_Type</a></td></tr>
 142 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure type to access the Private Timer.  <a href="structTimer__Type.html#details">More...</a><br /></td></tr>
 143 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 </table><table class="memberdecls">
 145 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 146 Macros</h2></td></tr>
 147 <tr class="memitem:gaaaf976e808e92970c4853195f46f86aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#gaaaf976e808e92970c4853195f46f86aa">PTIM</a>&#160;&#160;&#160;((<a class="el" href="structTimer__Type.html">Timer_Type</a> *) TIMER_BASE )</td></tr>
 148 <tr class="memdesc:gaaaf976e808e92970c4853195f46f86aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer register struct.  <br /></td></tr>
 149 <tr class="separator:gaaaf976e808e92970c4853195f46f86aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table><table class="memberdecls">
 151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 152 Functions</h2></td></tr>
 153 <tr class="memitem:ga30516fed24977be8eecf3efd8b6a2fea"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#ga30516fed24977be8eecf3efd8b6a2fea">PTIM_SetLoadValue</a> (uint32_t value)</td></tr>
 154 <tr class="memdesc:ga30516fed24977be8eecf3efd8b6a2fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the load value to timers LOAD register.  <br /></td></tr>
 155 <tr class="separator:ga30516fed24977be8eecf3efd8b6a2fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:gacca3bf92e93c69e538ff4618317f7bfa"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#gacca3bf92e93c69e538ff4618317f7bfa">PTIM_GetLoadValue</a> (void)</td></tr>
 157 <tr class="memdesc:gacca3bf92e93c69e538ff4618317f7bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the load value from timers LOAD register.  <br /></td></tr>
 158 <tr class="separator:gacca3bf92e93c69e538ff4618317f7bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:gaaccd88ab7931c379817f71d7c0183586"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#gaaccd88ab7931c379817f71d7c0183586">PTIM_GetCurrentValue</a> (void)</td></tr>
 160 <tr class="memdesc:gaaccd88ab7931c379817f71d7c0183586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current counter value from timers COUNTER register.  <br /></td></tr>
 161 <tr class="separator:gaaccd88ab7931c379817f71d7c0183586"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:gaabc1dba029389fe0e2a6297952df7972"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#gaabc1dba029389fe0e2a6297952df7972">PTIM_SetControl</a> (uint32_t value)</td></tr>
 163 <tr class="memdesc:gaabc1dba029389fe0e2a6297952df7972"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the timer using its CONTROL register.  <br /></td></tr>
 164 <tr class="separator:gaabc1dba029389fe0e2a6297952df7972"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ga34f0ceea142a4be1479cb552bf8bc4d1"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#ga34f0ceea142a4be1479cb552bf8bc4d1">PTIM_GetControl</a> (void)</td></tr>
 166 <tr class="separator:ga34f0ceea142a4be1479cb552bf8bc4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ga59dca62df390bc4bce18559fc7d28578"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#ga59dca62df390bc4bce18559fc7d28578">PTIM_ClearEventFlag</a> (void)</td></tr>
 168 <tr class="separator:ga59dca62df390bc4bce18559fc7d28578"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 </table>
 170 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 171 <p>Private Timer Functions controls private timer registers present on Cortex-A5 and A9 class devices.<br  />
 172 References: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0434c/index.html">Cortex-A5 MPCore Technical Reference Manual</a>, <a href="http://infocenter.arm.com/help/topic/com.arm.doc.100486_0401_10_en/index.html">Cortex-A9 MPCore Technical Reference Manual</a>. </p>
 173 <h2 class="groupheader">Macro Definition Documentation</h2>
 174 <a id="gaaaf976e808e92970c4853195f46f86aa" name="gaaaf976e808e92970c4853195f46f86aa"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#gaaaf976e808e92970c4853195f46f86aa">&#9670;&#160;</a></span>PTIM</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">#define PTIM&#160;&#160;&#160;((<a class="el" href="structTimer__Type.html">Timer_Type</a> *) TIMER_BASE )</td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>Timer register struct. </p>
 187
 188 </div>
 189 </div>
 190 <h2 class="groupheader">Function Documentation</h2>
 191 <a id="ga59dca62df390bc4bce18559fc7d28578" name="ga59dca62df390bc4bce18559fc7d28578"></a>
 192 <h2 class="memtitle"><span class="permalink"><a href="#ga59dca62df390bc4bce18559fc7d28578">&#9670;&#160;</a></span>PTIM_ClearEventFlag()</h2>
 193
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">__STATIC_INLINE void PTIM_ClearEventFlag </td>
 199           <td>(</td>
 200           <td class="paramtype">void&#160;</td>
 201           <td class="paramname"></td><td>)</td>
 202           <td></td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206 <p>ref <a class="el" href="structTimer__Type.html#a91845c88231f4f337be2810d73bc79e4" title="Offset: 0x008 (R/W) Private Timer Control Register.">Timer_Type::CONTROL</a> Clears the event flag in timers ISR register. </p>
 207
 208 </div>
 209 </div>
 210 <a id="ga34f0ceea142a4be1479cb552bf8bc4d1" name="ga34f0ceea142a4be1479cb552bf8bc4d1"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#ga34f0ceea142a4be1479cb552bf8bc4d1">&#9670;&#160;</a></span>PTIM_GetControl()</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">__STATIC_INLINE uint32_t PTIM_GetControl </td>
 218           <td>(</td>
 219           <td class="paramtype">void&#160;</td>
 220           <td class="paramname"></td><td>)</td>
 221           <td></td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225 <p>ref <a class="el" href="structTimer__Type.html#a91845c88231f4f337be2810d73bc79e4" title="Offset: 0x008 (R/W) Private Timer Control Register.">Timer_Type::CONTROL</a> Get the current timer configuration from its CONTROL register. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="structTimer__Type.html#a91845c88231f4f337be2810d73bc79e4" title="Offset: 0x008 (R/W) Private Timer Control Register.">Timer_Type::CONTROL</a> </dd></dl>
 226
 227 </div>
 228 </div>
 229 <a id="gaaccd88ab7931c379817f71d7c0183586" name="gaaccd88ab7931c379817f71d7c0183586"></a>
 230 <h2 class="memtitle"><span class="permalink"><a href="#gaaccd88ab7931c379817f71d7c0183586">&#9670;&#160;</a></span>PTIM_GetCurrentValue()</h2>
 231
 232 <div class="memitem">
 233 <div class="memproto">
 234       <table class="memname">
 235         <tr>
 236           <td class="memname">__STATIC_INLINE uint32_t PTIM_GetCurrentValue </td>
 237           <td>(</td>
 238           <td class="paramtype">void&#160;</td>
 239           <td class="paramname"></td><td>)</td>
 240           <td></td>
 241         </tr>
 242       </table>
 243 </div><div class="memdoc">
 244
 245 <p>Get current counter value from timers COUNTER register. </p>
 246 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structTimer__Type.html#ac933977724591e6ca87d91848fc7a6b6" title="Offset: 0x004 (R/W) Private Timer Counter Register.">Timer_Type::COUNTER</a> </dd></dl>
 247
 248 </div>
 249 </div>
 250 <a id="gacca3bf92e93c69e538ff4618317f7bfa" name="gacca3bf92e93c69e538ff4618317f7bfa"></a>
 251 <h2 class="memtitle"><span class="permalink"><a href="#gacca3bf92e93c69e538ff4618317f7bfa">&#9670;&#160;</a></span>PTIM_GetLoadValue()</h2>
 252
 253 <div class="memitem">
 254 <div class="memproto">
 255       <table class="memname">
 256         <tr>
 257           <td class="memname">__STATIC_INLINE uint32_t PTIM_GetLoadValue </td>
 258           <td>(</td>
 259           <td class="paramtype">void&#160;</td>
 260           <td class="paramname"></td><td>)</td>
 261           <td></td>
 262         </tr>
 263       </table>
 264 </div><div class="memdoc">
 265
 266 <p>Get the load value from timers LOAD register. </p>
 267 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structTimer__Type.html#a073457d2d18c2eff93fd12aec81ef20b" title="Offset: 0x000 (R/W) Private Timer Load Register.">Timer_Type::LOAD</a> </dd></dl>
 268
 269 </div>
 270 </div>
 271 <a id="gaabc1dba029389fe0e2a6297952df7972" name="gaabc1dba029389fe0e2a6297952df7972"></a>
 272 <h2 class="memtitle"><span class="permalink"><a href="#gaabc1dba029389fe0e2a6297952df7972">&#9670;&#160;</a></span>PTIM_SetControl()</h2>
 273
 274 <div class="memitem">
 275 <div class="memproto">
 276       <table class="memname">
 277         <tr>
 278           <td class="memname">__STATIC_INLINE void PTIM_SetControl </td>
 279           <td>(</td>
 280           <td class="paramtype">uint32_t&#160;</td>
 281           <td class="paramname"><em>value</em></td><td>)</td>
 282           <td></td>
 283         </tr>
 284       </table>
 285 </div><div class="memdoc">
 286
 287 <p>Configure the timer using its CONTROL register. </p>
 288 <dl class="params"><dt>Parameters</dt><dd>
 289   <table class="params">
 290     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The new configuration value to be set. </td></tr>
 291   </table>
 292   </dd>
 293 </dl>
 294
 295 </div>
 296 </div>
 297 <a id="ga30516fed24977be8eecf3efd8b6a2fea" name="ga30516fed24977be8eecf3efd8b6a2fea"></a>
 298 <h2 class="memtitle"><span class="permalink"><a href="#ga30516fed24977be8eecf3efd8b6a2fea">&#9670;&#160;</a></span>PTIM_SetLoadValue()</h2>
 299
 300 <div class="memitem">
 301 <div class="memproto">
 302       <table class="memname">
 303         <tr>
 304           <td class="memname">__STATIC_INLINE void PTIM_SetLoadValue </td>
 305           <td>(</td>
 306           <td class="paramtype">uint32_t&#160;</td>
 307           <td class="paramname"><em>value</em></td><td>)</td>
 308           <td></td>
 309         </tr>
 310       </table>
 311 </div><div class="memdoc">
 312
 313 <p>Set the load value to timers LOAD register. </p>
 314 <dl class="params"><dt>Parameters</dt><dd>
 315   <table class="params">
 316     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The load value to be set. </td></tr>
 317   </table>
 318   </dd>
 319 </dl>
 320
 321 </div>
 322 </div>
 323 </div><!-- contents -->
 324 </div><!-- doc-content -->
 325 <!-- start footer part -->
 326 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 327   <ul>
 328     <li class="footer">
 329       <script type="text/javascript">
 330         <!--
 331         writeFooter.call(this);
 332         //-->
 333       </script>
 334     </li>
 335   </ul>
 336 </div>
 337 </body>
 338 </html>