begriffs open source - cmsis/blob - main/Core_A/group__PL1__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): Generic Physical 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__PL1__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="#func-members">Functions</a>  </div>
 130   <div class="headertitle"><div class="title">Generic Physical Timer Functions<div class="ingroups"><a class="el" href="group__CMSIS__Core__FunctionInterface.html">Core Peripherals</a></div></div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133
 134 <p>Generic Physical Timer Functions allow to control privilege level 1 physical timer registers on Generic Timer for Cortex-A7 class devices.<br  />
 135 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0464f/index.html">Cortex-A7 MPCore Technical Reference Manual</a>.
 136 <a href="#details">More...</a></p>
 137 <table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 139 Data Structures</h2></td></tr>
 140 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionCNTP__CTL__Type.html">CNTP_CTL_Type</a></td></tr>
 141 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Physical Timer Control register.  <a href="unionCNTP__CTL__Type.html#details">More...</a><br /></td></tr>
 142 <tr class="separator:"><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="func-members" name="func-members"></a>
 145 Functions</h2></td></tr>
 146 <tr class="memitem:gac09f09327fde6a6adffe0e6298eaa1db"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#gac09f09327fde6a6adffe0e6298eaa1db">PL1_SetCounterFrequency</a> (uint32_t value)</td></tr>
 147 <tr class="memdesc:gac09f09327fde6a6adffe0e6298eaa1db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the frequency the timer shall run at.  <br /></td></tr>
 148 <tr class="separator:gac09f09327fde6a6adffe0e6298eaa1db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:gae4edcfbdaf901a59a81d1fbf9845d9f7"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#gae4edcfbdaf901a59a81d1fbf9845d9f7">PL1_SetLoadValue</a> (uint32_t value)</td></tr>
 150 <tr class="memdesc:gae4edcfbdaf901a59a81d1fbf9845d9f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the reset value of the timer.  <br /></td></tr>
 151 <tr class="separator:gae4edcfbdaf901a59a81d1fbf9845d9f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga8a212e9457005edfb9f14afbf937ebf9"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#ga8a212e9457005edfb9f14afbf937ebf9">PL1_GetCurrentValue</a> ()</td></tr>
 153 <tr class="memdesc:ga8a212e9457005edfb9f14afbf937ebf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current counter value.  <br /></td></tr>
 154 <tr class="separator:ga8a212e9457005edfb9f14afbf937ebf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:gac66bd336d2353f70aa8ebfc73aa3fc43"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#gac66bd336d2353f70aa8ebfc73aa3fc43">PL1_GetCurrentPhysicalValue</a> (void)</td></tr>
 156 <tr class="memdesc:gac66bd336d2353f70aa8ebfc73aa3fc43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current physical counter value.  <br /></td></tr>
 157 <tr class="separator:gac66bd336d2353f70aa8ebfc73aa3fc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:gab34067824971064a829e17b791070643"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#gab34067824971064a829e17b791070643">PL1_SetPhysicalCompareValue</a> (uint64_t value)</td></tr>
 159 <tr class="memdesc:gab34067824971064a829e17b791070643"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the physical compare value.  <br /></td></tr>
 160 <tr class="separator:gab34067824971064a829e17b791070643"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga341ae7d1ae29f4dc5dae6310fa453164"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#ga341ae7d1ae29f4dc5dae6310fa453164">PL1_GetPhysicalCompareValue</a> (void)</td></tr>
 162 <tr class="memdesc:ga341ae7d1ae29f4dc5dae6310fa453164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the physical compare value.  <br /></td></tr>
 163 <tr class="separator:ga341ae7d1ae29f4dc5dae6310fa453164"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:ga2e2ea7eac12a90c6243000172bf774e1"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#ga2e2ea7eac12a90c6243000172bf774e1">PL1_SetControl</a> (uint32_t value)</td></tr>
 165 <tr class="memdesc:ga2e2ea7eac12a90c6243000172bf774e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the timer by setting the control value.  <br /></td></tr>
 166 <tr class="separator:ga2e2ea7eac12a90c6243000172bf774e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:gaf7fda3fe3452565fbe46cb0ea53a9f8a"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PL1__timer__functions.html#gaf7fda3fe3452565fbe46cb0ea53a9f8a">PL1_GetControl</a> ()</td></tr>
 168 <tr class="memdesc:gaf7fda3fe3452565fbe46cb0ea53a9f8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the control value.  <br /></td></tr>
 169 <tr class="separator:gaf7fda3fe3452565fbe46cb0ea53a9f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 </table>
 171 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 172 <p>Generic Physical Timer Functions allow to control privilege level 1 physical timer registers on Generic Timer for Cortex-A7 class devices.<br  />
 173 Reference: <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0464f/index.html">Cortex-A7 MPCore Technical Reference Manual</a>. </p>
 174 <h2 class="groupheader">Function Documentation</h2>
 175 <a id="gaf7fda3fe3452565fbe46cb0ea53a9f8a" name="gaf7fda3fe3452565fbe46cb0ea53a9f8a"></a>
 176 <h2 class="memtitle"><span class="permalink"><a href="#gaf7fda3fe3452565fbe46cb0ea53a9f8a">&#9670;&#160;</a></span>PL1_GetControl()</h2>
 177
 178 <div class="memitem">
 179 <div class="memproto">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">__STATIC_INLINE uint32_t PL1_GetControl </td>
 183           <td>(</td>
 184           <td class="paramtype">void&#160;</td>
 185           <td class="paramname"></td><td>)</td>
 186           <td></td>
 187         </tr>
 188       </table>
 189 </div><div class="memdoc">
 190
 191 <p>Get the control value. </p>
 192 <p>Get the timer control value. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="unionCNTP__CTL__Type.html">CNTP_CTL_Type</a> Timer control value.</dd>
 193 <dd>
 194 Control value. </dd></dl>
 195
 196 </div>
 197 </div>
 198 <a id="gac66bd336d2353f70aa8ebfc73aa3fc43" name="gac66bd336d2353f70aa8ebfc73aa3fc43"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#gac66bd336d2353f70aa8ebfc73aa3fc43">&#9670;&#160;</a></span>PL1_GetCurrentPhysicalValue()</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">__STATIC_INLINE uint64_t PL1_GetCurrentPhysicalValue </td>
 206           <td>(</td>
 207           <td class="paramtype">void&#160;</td>
 208           <td class="paramname"></td><td>)</td>
 209           <td></td>
 210         </tr>
 211       </table>
 212 </div><div class="memdoc">
 213
 214 <p>Get the current physical counter value. </p>
 215 <dl class="section return"><dt>Returns</dt><dd>Current physical counter value. </dd></dl>
 216
 217 </div>
 218 </div>
 219 <a id="ga8a212e9457005edfb9f14afbf937ebf9" name="ga8a212e9457005edfb9f14afbf937ebf9"></a>
 220 <h2 class="memtitle"><span class="permalink"><a href="#ga8a212e9457005edfb9f14afbf937ebf9">&#9670;&#160;</a></span>PL1_GetCurrentValue()</h2>
 221
 222 <div class="memitem">
 223 <div class="memproto">
 224       <table class="memname">
 225         <tr>
 226           <td class="memname">__STATIC_INLINE uint32_t PL1_GetCurrentValue </td>
 227           <td>(</td>
 228           <td class="paramtype">void&#160;</td>
 229           <td class="paramname"></td><td>)</td>
 230           <td></td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234
 235 <p>Get the current counter value. </p>
 236 <p>Get the current counter value. </p><dl class="section return"><dt>Returns</dt><dd>Current counter value.</dd>
 237 <dd>
 238 Current counter value. </dd></dl>
 239
 240 </div>
 241 </div>
 242 <a id="ga341ae7d1ae29f4dc5dae6310fa453164" name="ga341ae7d1ae29f4dc5dae6310fa453164"></a>
 243 <h2 class="memtitle"><span class="permalink"><a href="#ga341ae7d1ae29f4dc5dae6310fa453164">&#9670;&#160;</a></span>PL1_GetPhysicalCompareValue()</h2>
 244
 245 <div class="memitem">
 246 <div class="memproto">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname">__STATIC_INLINE uint64_t PL1_GetPhysicalCompareValue </td>
 250           <td>(</td>
 251           <td class="paramtype">void&#160;</td>
 252           <td class="paramname"></td><td>)</td>
 253           <td></td>
 254         </tr>
 255       </table>
 256 </div><div class="memdoc">
 257
 258 <p>Get the physical compare value. </p>
 259 <dl class="section return"><dt>Returns</dt><dd>Physical compare value. </dd></dl>
 260
 261 </div>
 262 </div>
 263 <a id="ga2e2ea7eac12a90c6243000172bf774e1" name="ga2e2ea7eac12a90c6243000172bf774e1"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#ga2e2ea7eac12a90c6243000172bf774e1">&#9670;&#160;</a></span>PL1_SetControl()</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">__STATIC_INLINE void PL1_SetControl </td>
 271           <td>(</td>
 272           <td class="paramtype">uint32_t&#160;</td>
 273           <td class="paramname"><em>value</em></td><td>)</td>
 274           <td></td>
 275         </tr>
 276       </table>
 277 </div><div class="memdoc">
 278
 279 <p>Configure the timer by setting the control value. </p>
 280 <p>Configure the timer by setting the control value.</p>
 281 <dl class="params"><dt>Parameters</dt><dd>
 282   <table class="params">
 283     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>New timer control value. </td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287
 288 </div>
 289 </div>
 290 <a id="gac09f09327fde6a6adffe0e6298eaa1db" name="gac09f09327fde6a6adffe0e6298eaa1db"></a>
 291 <h2 class="memtitle"><span class="permalink"><a href="#gac09f09327fde6a6adffe0e6298eaa1db">&#9670;&#160;</a></span>PL1_SetCounterFrequency()</h2>
 292
 293 <div class="memitem">
 294 <div class="memproto">
 295       <table class="memname">
 296         <tr>
 297           <td class="memname">__STATIC_INLINE void PL1_SetCounterFrequency </td>
 298           <td>(</td>
 299           <td class="paramtype">uint32_t&#160;</td>
 300           <td class="paramname"><em>value</em></td><td>)</td>
 301           <td></td>
 302         </tr>
 303       </table>
 304 </div><div class="memdoc">
 305
 306 <p>Configures the frequency the timer shall run at. </p>
 307 <p>Configures the frequency the timer shall run at.</p>
 308 <dl class="params"><dt>Parameters</dt><dd>
 309   <table class="params">
 310     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The timer frequency in Hz. </td></tr>
 311   </table>
 312   </dd>
 313 </dl>
 314
 315 </div>
 316 </div>
 317 <a id="gae4edcfbdaf901a59a81d1fbf9845d9f7" name="gae4edcfbdaf901a59a81d1fbf9845d9f7"></a>
 318 <h2 class="memtitle"><span class="permalink"><a href="#gae4edcfbdaf901a59a81d1fbf9845d9f7">&#9670;&#160;</a></span>PL1_SetLoadValue()</h2>
 319
 320 <div class="memitem">
 321 <div class="memproto">
 322       <table class="memname">
 323         <tr>
 324           <td class="memname">__STATIC_INLINE void PL1_SetLoadValue </td>
 325           <td>(</td>
 326           <td class="paramtype">uint32_t&#160;</td>
 327           <td class="paramname"><em>value</em></td><td>)</td>
 328           <td></td>
 329         </tr>
 330       </table>
 331 </div><div class="memdoc">
 332
 333 <p>Sets the reset value of the timer. </p>
 334 <p>Sets the reset value of the timer.</p>
 335 <dl class="params"><dt>Parameters</dt><dd>
 336   <table class="params">
 337     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value the timer is loaded with. </td></tr>
 338   </table>
 339   </dd>
 340 </dl>
 341
 342 </div>
 343 </div>
 344 <a id="gab34067824971064a829e17b791070643" name="gab34067824971064a829e17b791070643"></a>
 345 <h2 class="memtitle"><span class="permalink"><a href="#gab34067824971064a829e17b791070643">&#9670;&#160;</a></span>PL1_SetPhysicalCompareValue()</h2>
 346
 347 <div class="memitem">
 348 <div class="memproto">
 349       <table class="memname">
 350         <tr>
 351           <td class="memname">__STATIC_INLINE void PL1_SetPhysicalCompareValue </td>
 352           <td>(</td>
 353           <td class="paramtype">uint64_t&#160;</td>
 354           <td class="paramname"><em>value</em></td><td>)</td>
 355           <td></td>
 356         </tr>
 357       </table>
 358 </div><div class="memdoc">
 359
 360 <p>Set the physical compare value. </p>
 361 <dl class="params"><dt>Parameters</dt><dd>
 362   <table class="params">
 363     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>New physical timer compare value. </td></tr>
 364   </table>
 365   </dd>
 366 </dl>
 367
 368 </div>
 369 </div>
 370 </div><!-- contents -->
 371 </div><!-- doc-content -->
 372 <!-- start footer part -->
 373 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 374   <ul>
 375     <li class="footer">
 376       <script type="text/javascript">
 377         <!--
 378         writeFooter.call(this);
 379         //-->
 380       </script>
 381     </li>
 382   </ul>
 383 </div>
 384 </body>
 385 </html>