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 <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-Core (Cortex-A)
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__PTM__timer__functions.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#nested-classes">Data Structures</a> &#124;
 132 <a href="#define-members">Macros</a> &#124;
 133 <a href="#func-members">Functions</a>  </div>
 134   <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>
 135 </div><!--header-->
 136 <div class="contents">
 137
 138 <p>Private Timer Functions controls private timer registers present on Cortex-A5 and A9 class devices.<br  />
 139 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>.
 140 <a href="#details">More...</a></p>
 141 <table class="memberdecls">
 142 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 143 Data Structures</h2></td></tr>
 144 <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>
 145 <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>
 146 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table><table class="memberdecls">
 148 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 149 Macros</h2></td></tr>
 150 <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>
 151 <tr class="memdesc:gaaaf976e808e92970c4853195f46f86aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer register struct.  <br /></td></tr>
 152 <tr class="separator:gaaaf976e808e92970c4853195f46f86aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table><table class="memberdecls">
 154 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 155 Functions</h2></td></tr>
 156 <tr class="memitem:ga30516fed24977be8eecf3efd8b6a2fea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> 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>
 157 <tr class="memdesc:ga30516fed24977be8eecf3efd8b6a2fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the load value to timers LOAD register.  <br /></td></tr>
 158 <tr class="separator:ga30516fed24977be8eecf3efd8b6a2fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:gacca3bf92e93c69e538ff4618317f7bfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> 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>
 160 <tr class="memdesc:gacca3bf92e93c69e538ff4618317f7bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the load value from timers LOAD register.  <br /></td></tr>
 161 <tr class="separator:gacca3bf92e93c69e538ff4618317f7bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:gaaccd88ab7931c379817f71d7c0183586"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> 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>
 163 <tr class="memdesc:gaaccd88ab7931c379817f71d7c0183586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current counter value from timers COUNTER register.  <br /></td></tr>
 164 <tr class="separator:gaaccd88ab7931c379817f71d7c0183586"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:gaabc1dba029389fe0e2a6297952df7972"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> 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>
 166 <tr class="memdesc:gaabc1dba029389fe0e2a6297952df7972"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the timer using its CONTROL register.  <br /></td></tr>
 167 <tr class="separator:gaabc1dba029389fe0e2a6297952df7972"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:ga34f0ceea142a4be1479cb552bf8bc4d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> 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>
 169 <tr class="separator:ga34f0ceea142a4be1479cb552bf8bc4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:ga59dca62df390bc4bce18559fc7d28578"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PTM__timer__functions.html#ga59dca62df390bc4bce18559fc7d28578">PTIM_ClearEventFlag</a> (void)</td></tr>
 171 <tr class="separator:ga59dca62df390bc4bce18559fc7d28578"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 </table>
 173 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 174 <p>Private Timer Functions controls private timer registers present on Cortex-A5 and A9 class devices.<br  />
 175 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>
 176 <h2 class="groupheader">Macro Definition Documentation</h2>
 177 <a id="gaaaf976e808e92970c4853195f46f86aa" name="gaaaf976e808e92970c4853195f46f86aa"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#gaaaf976e808e92970c4853195f46f86aa">&#9670;&#160;</a></span>PTIM</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">#define PTIM&#160;&#160;&#160;((<a class="el" href="structTimer__Type.html">Timer_Type</a> *) TIMER_BASE )</td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>Timer register struct. </p>
 190
 191 </div>
 192 </div>
 193 <h2 class="groupheader">Function Documentation</h2>
 194 <a id="ga59dca62df390bc4bce18559fc7d28578" name="ga59dca62df390bc4bce18559fc7d28578"></a>
 195 <h2 class="memtitle"><span class="permalink"><a href="#ga59dca62df390bc4bce18559fc7d28578">&#9670;&#160;</a></span>PTIM_ClearEventFlag()</h2>
 196
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PTIM_ClearEventFlag </td>
 202           <td>(</td>
 203           <td class="paramtype">void&#160;</td>
 204           <td class="paramname"></td><td>)</td>
 205           <td></td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209 <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>
 210
 211 </div>
 212 </div>
 213 <a id="ga34f0ceea142a4be1479cb552bf8bc4d1" name="ga34f0ceea142a4be1479cb552bf8bc4d1"></a>
 214 <h2 class="memtitle"><span class="permalink"><a href="#ga34f0ceea142a4be1479cb552bf8bc4d1">&#9670;&#160;</a></span>PTIM_GetControl()</h2>
 215
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t PTIM_GetControl </td>
 221           <td>(</td>
 222           <td class="paramtype">void&#160;</td>
 223           <td class="paramname"></td><td>)</td>
 224           <td></td>
 225         </tr>
 226       </table>
 227 </div><div class="memdoc">
 228 <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>
 229
 230 </div>
 231 </div>
 232 <a id="gaaccd88ab7931c379817f71d7c0183586" name="gaaccd88ab7931c379817f71d7c0183586"></a>
 233 <h2 class="memtitle"><span class="permalink"><a href="#gaaccd88ab7931c379817f71d7c0183586">&#9670;&#160;</a></span>PTIM_GetCurrentValue()</h2>
 234
 235 <div class="memitem">
 236 <div class="memproto">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t PTIM_GetCurrentValue </td>
 240           <td>(</td>
 241           <td class="paramtype">void&#160;</td>
 242           <td class="paramname"></td><td>)</td>
 243           <td></td>
 244         </tr>
 245       </table>
 246 </div><div class="memdoc">
 247
 248 <p>Get current counter value from timers COUNTER register. </p>
 249 <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>
 250
 251 </div>
 252 </div>
 253 <a id="gacca3bf92e93c69e538ff4618317f7bfa" name="gacca3bf92e93c69e538ff4618317f7bfa"></a>
 254 <h2 class="memtitle"><span class="permalink"><a href="#gacca3bf92e93c69e538ff4618317f7bfa">&#9670;&#160;</a></span>PTIM_GetLoadValue()</h2>
 255
 256 <div class="memitem">
 257 <div class="memproto">
 258       <table class="memname">
 259         <tr>
 260           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t PTIM_GetLoadValue </td>
 261           <td>(</td>
 262           <td class="paramtype">void&#160;</td>
 263           <td class="paramname"></td><td>)</td>
 264           <td></td>
 265         </tr>
 266       </table>
 267 </div><div class="memdoc">
 268
 269 <p>Get the load value from timers LOAD register. </p>
 270 <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>
 271
 272 </div>
 273 </div>
 274 <a id="gaabc1dba029389fe0e2a6297952df7972" name="gaabc1dba029389fe0e2a6297952df7972"></a>
 275 <h2 class="memtitle"><span class="permalink"><a href="#gaabc1dba029389fe0e2a6297952df7972">&#9670;&#160;</a></span>PTIM_SetControl()</h2>
 276
 277 <div class="memitem">
 278 <div class="memproto">
 279       <table class="memname">
 280         <tr>
 281           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PTIM_SetControl </td>
 282           <td>(</td>
 283           <td class="paramtype">uint32_t&#160;</td>
 284           <td class="paramname"><em>value</em></td><td>)</td>
 285           <td></td>
 286         </tr>
 287       </table>
 288 </div><div class="memdoc">
 289
 290 <p>Configure the timer using its CONTROL register. </p>
 291 <dl class="params"><dt>Parameters</dt><dd>
 292   <table class="params">
 293     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The new configuration value to be set. </td></tr>
 294   </table>
 295   </dd>
 296 </dl>
 297
 298 </div>
 299 </div>
 300 <a id="ga30516fed24977be8eecf3efd8b6a2fea" name="ga30516fed24977be8eecf3efd8b6a2fea"></a>
 301 <h2 class="memtitle"><span class="permalink"><a href="#ga30516fed24977be8eecf3efd8b6a2fea">&#9670;&#160;</a></span>PTIM_SetLoadValue()</h2>
 302
 303 <div class="memitem">
 304 <div class="memproto">
 305       <table class="memname">
 306         <tr>
 307           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PTIM_SetLoadValue </td>
 308           <td>(</td>
 309           <td class="paramtype">uint32_t&#160;</td>
 310           <td class="paramname"><em>value</em></td><td>)</td>
 311           <td></td>
 312         </tr>
 313       </table>
 314 </div><div class="memdoc">
 315
 316 <p>Set the load value to timers LOAD register. </p>
 317 <dl class="params"><dt>Parameters</dt><dd>
 318   <table class="params">
 319     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The load value to be set. </td></tr>
 320   </table>
 321   </dd>
 322 </dl>
 323
 324 </div>
 325 </div>
 326 </div><!-- contents -->
 327 </div><!-- doc-content -->
 328 <!-- start footer part -->
 329 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 330   <ul>
 331     <li class="footer">
 332       <script type="text/javascript">
 333         <!--
 334         writeFooter.call(this);
 335         //-->
 336       </script>
 337     </li>
 338   </ul>
 339 </div>
 340 </body>
 341 </html>