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