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">
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&dn=expat.txt MIT */
28 $(document).ready(function() { init_search(); });
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>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
49 writeHeader.call(this);
50 writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
55 <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
57 <td> <div id="MSearchBox" class="MSearchBoxInactive">
59 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
69 <!--END !PROJECT_NAME-->
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
77 <script type="text/javascript">
78 writeComponentTabs.call(this);
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__PL1__timer__functions.html',''); initResizable(); });
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)">
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
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>
127 <div class="summary">
128 <a href="#nested-classes">Data Structures</a> |
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>
132 <div class="contents">
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  </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"> </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"> </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"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void </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"> </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"> </td></tr>
149 <tr class="memitem:gae4edcfbdaf901a59a81d1fbf9845d9f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void </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"> </td><td class="mdescRight">Sets the reset value of the timer. <br /></td></tr>
151 <tr class="separator:gae4edcfbdaf901a59a81d1fbf9845d9f7"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:ga8a212e9457005edfb9f14afbf937ebf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t </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"> </td><td class="mdescRight">Get the current counter value. <br /></td></tr>
154 <tr class="separator:ga8a212e9457005edfb9f14afbf937ebf9"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:gac66bd336d2353f70aa8ebfc73aa3fc43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint64_t </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"> </td><td class="mdescRight">Get the current physical counter value. <br /></td></tr>
157 <tr class="separator:gac66bd336d2353f70aa8ebfc73aa3fc43"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:gab34067824971064a829e17b791070643"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void </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"> </td><td class="mdescRight">Set the physical compare value. <br /></td></tr>
160 <tr class="separator:gab34067824971064a829e17b791070643"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:ga341ae7d1ae29f4dc5dae6310fa453164"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint64_t </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"> </td><td class="mdescRight">Get the physical compare value. <br /></td></tr>
163 <tr class="separator:ga341ae7d1ae29f4dc5dae6310fa453164"><td class="memSeparator" colspan="2"> </td></tr>
164 <tr class="memitem:ga2e2ea7eac12a90c6243000172bf774e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void </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"> </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"> </td></tr>
167 <tr class="memitem:gaf7fda3fe3452565fbe46cb0ea53a9f8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t </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"> </td><td class="mdescRight">Get the control value. <br /></td></tr>
169 <tr class="separator:gaf7fda3fe3452565fbe46cb0ea53a9f8a"><td class="memSeparator" colspan="2"> </td></tr>
171 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
172 <h2 class="groupheader">Function Documentation</h2>
173 <a id="gaf7fda3fe3452565fbe46cb0ea53a9f8a" name="gaf7fda3fe3452565fbe46cb0ea53a9f8a"></a>
174 <h2 class="memtitle"><span class="permalink"><a href="#gaf7fda3fe3452565fbe46cb0ea53a9f8a">◆ </a></span>PL1_GetControl()</h2>
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
180 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t PL1_GetControl </td>
182 <td class="paramtype">void </td>
183 <td class="paramname"></td><td>)</td>
187 </div><div class="memdoc">
188 <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>
190 Control value. </dd></dl>
194 <a id="gac66bd336d2353f70aa8ebfc73aa3fc43" name="gac66bd336d2353f70aa8ebfc73aa3fc43"></a>
195 <h2 class="memtitle"><span class="permalink"><a href="#gac66bd336d2353f70aa8ebfc73aa3fc43">◆ </a></span>PL1_GetCurrentPhysicalValue()</h2>
197 <div class="memitem">
198 <div class="memproto">
199 <table class="memname">
201 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint64_t PL1_GetCurrentPhysicalValue </td>
203 <td class="paramtype">void </td>
204 <td class="paramname"></td><td>)</td>
208 </div><div class="memdoc">
209 <dl class="section return"><dt>Returns</dt><dd>Current physical counter value. </dd></dl>
213 <a id="ga8a212e9457005edfb9f14afbf937ebf9" name="ga8a212e9457005edfb9f14afbf937ebf9"></a>
214 <h2 class="memtitle"><span class="permalink"><a href="#ga8a212e9457005edfb9f14afbf937ebf9">◆ </a></span>PL1_GetCurrentValue()</h2>
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
220 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t PL1_GetCurrentValue </td>
222 <td class="paramtype">void </td>
223 <td class="paramname"></td><td>)</td>
227 </div><div class="memdoc">
228 <p>Get the current counter value. </p><dl class="section return"><dt>Returns</dt><dd>Current counter value.</dd>
230 Current counter value. </dd></dl>
234 <a id="ga341ae7d1ae29f4dc5dae6310fa453164" name="ga341ae7d1ae29f4dc5dae6310fa453164"></a>
235 <h2 class="memtitle"><span class="permalink"><a href="#ga341ae7d1ae29f4dc5dae6310fa453164">◆ </a></span>PL1_GetPhysicalCompareValue()</h2>
237 <div class="memitem">
238 <div class="memproto">
239 <table class="memname">
241 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint64_t PL1_GetPhysicalCompareValue </td>
243 <td class="paramtype">void </td>
244 <td class="paramname"></td><td>)</td>
248 </div><div class="memdoc">
249 <dl class="section return"><dt>Returns</dt><dd>Physical compare value. </dd></dl>
253 <a id="ga2e2ea7eac12a90c6243000172bf774e1" name="ga2e2ea7eac12a90c6243000172bf774e1"></a>
254 <h2 class="memtitle"><span class="permalink"><a href="#ga2e2ea7eac12a90c6243000172bf774e1">◆ </a></span>PL1_SetControl()</h2>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
260 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PL1_SetControl </td>
262 <td class="paramtype">uint32_t </td>
263 <td class="paramname"><em>value</em></td><td>)</td>
267 </div><div class="memdoc">
268 <p>Configure the timer by setting the control value. </p><dl class="params"><dt>Parameters</dt><dd>
269 <table class="params">
270 <tr><td class="paramdir"></td><td class="paramname">value</td><td>New <a class="el" href="unionCNTP__CTL__Type.html">timer control value</a>.</td></tr>
271 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>New timer control value. </td></tr>
278 <a id="gac09f09327fde6a6adffe0e6298eaa1db" name="gac09f09327fde6a6adffe0e6298eaa1db"></a>
279 <h2 class="memtitle"><span class="permalink"><a href="#gac09f09327fde6a6adffe0e6298eaa1db">◆ </a></span>PL1_SetCounterFrequency()</h2>
281 <div class="memitem">
282 <div class="memproto">
283 <table class="memname">
285 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PL1_SetCounterFrequency </td>
287 <td class="paramtype">uint32_t </td>
288 <td class="paramname"><em>value</em></td><td>)</td>
292 </div><div class="memdoc">
293 <p>Configures the frequency the timer shall run at. </p><dl class="params"><dt>Parameters</dt><dd>
294 <table class="params">
295 <tr><td class="paramdir"></td><td class="paramname">value</td><td>The timer frequency in Hz.</td></tr>
296 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The timer frequency in Hz. </td></tr>
303 <a id="gae4edcfbdaf901a59a81d1fbf9845d9f7" name="gae4edcfbdaf901a59a81d1fbf9845d9f7"></a>
304 <h2 class="memtitle"><span class="permalink"><a href="#gae4edcfbdaf901a59a81d1fbf9845d9f7">◆ </a></span>PL1_SetLoadValue()</h2>
306 <div class="memitem">
307 <div class="memproto">
308 <table class="memname">
310 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PL1_SetLoadValue </td>
312 <td class="paramtype">uint32_t </td>
313 <td class="paramname"><em>value</em></td><td>)</td>
317 </div><div class="memdoc">
318 <p>Sets the reset value of the timer. </p><dl class="params"><dt>Parameters</dt><dd>
319 <table class="params">
320 <tr><td class="paramdir"></td><td class="paramname">value</td><td>The value the timer is loaded with.</td></tr>
321 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value the timer is loaded with. </td></tr>
328 <a id="gab34067824971064a829e17b791070643" name="gab34067824971064a829e17b791070643"></a>
329 <h2 class="memtitle"><span class="permalink"><a href="#gab34067824971064a829e17b791070643">◆ </a></span>PL1_SetPhysicalCompareValue()</h2>
331 <div class="memitem">
332 <div class="memproto">
333 <table class="memname">
335 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void PL1_SetPhysicalCompareValue </td>
337 <td class="paramtype">uint64_t </td>
338 <td class="paramname"><em>value</em></td><td>)</td>
342 </div><div class="memdoc">
343 <dl class="params"><dt>Parameters</dt><dd>
344 <table class="params">
345 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>New physical timer compare value. </td></tr>
352 </div><!-- contents -->
353 </div><!-- doc-content -->
354 <!-- start footer part -->
355 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
358 <script type="text/javascript">
360 writeFooter.call(this);