]> begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__CNTP__CTL.html
Update documentation for branch main
[cmsis] / main / Core_A / group__CMSIS__CNTP__CTL.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): PL1 Physical Timer Control register (CNTP_CTL)</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__CMSIS__CNTP__CTL.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="#func-members">Functions</a>  </div>
129   <div class="headertitle"><div class="title">PL1 Physical Timer Control register (CNTP_CTL)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
130 </div><!--header-->
131 <div class="contents">
132
133 <p>The control register for the physical timer.  
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
137 Functions</h2></td></tr>
138 <tr class="memitem:ga2d0441a0266268a063cb7577b8873c65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CNTP__CTL.html#ga2d0441a0266268a063cb7577b8873c65">__set_CNTP_CTL</a> (uint32_t value)</td></tr>
139 <tr class="memdesc:ga2d0441a0266268a063cb7577b8873c65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set CNTP_CTL.  <br /></td></tr>
140 <tr class="separator:ga2d0441a0266268a063cb7577b8873c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga42340ef4a099480a9d4aef28c4bf8dd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CNTP__CTL.html#ga42340ef4a099480a9d4aef28c4bf8dd0">__get_CNTP_CTL</a> (void)</td></tr>
142 <tr class="memdesc:ga42340ef4a099480a9d4aef28c4bf8dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get CNTP_CTL register.  <br /></td></tr>
143 <tr class="separator:ga42340ef4a099480a9d4aef28c4bf8dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table>
145 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
146 <p>The control register for the physical timer. </p>
147 <table class="markdownTable">
148 <tr class="markdownTableHead">
149 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
150 <tr class="markdownTableRowOdd">
151 <td class="markdownTableBodyLeft">[31:3]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
152 <tr class="markdownTableRowEven">
153 <td class="markdownTableBodyLeft">[2]   </td><td class="markdownTableBodyLeft">ISTATUS   </td><td class="markdownTableBodyLeft">The status of the timer.    </td></tr>
154 <tr class="markdownTableRowOdd">
155 <td class="markdownTableBodyLeft">[1]   </td><td class="markdownTableBodyLeft">IMASK   </td><td class="markdownTableBodyLeft">Timer output signal mask bit.    </td></tr>
156 <tr class="markdownTableRowEven">
157 <td class="markdownTableBodyLeft">[0]   </td><td class="markdownTableBodyLeft">ENABLE   </td><td class="markdownTableBodyLeft">Enables the timer.   </td></tr>
158 </table>
159 <p>Consider <a class="el" href="group__CMSIS__CNTP__CTL.html#ga42340ef4a099480a9d4aef28c4bf8dd0">__get_CNTP_CTL</a> and <a class="el" href="group__CMSIS__CNTP__CTL.html#ga2d0441a0266268a063cb7577b8873c65">__set_CNTP_CTL</a> to access this register.</p>
160 <p>Consider using <a class="el" href="group__PL1__timer__functions.html">Generic Physical Timer Functions</a> for controlling the PL1 Timer instead. </p>
161 <h2 class="groupheader">Function Documentation</h2>
162 <a id="ga42340ef4a099480a9d4aef28c4bf8dd0" name="ga42340ef4a099480a9d4aef28c4bf8dd0"></a>
163 <h2 class="memtitle"><span class="permalink"><a href="#ga42340ef4a099480a9d4aef28c4bf8dd0">&#9670;&#160;</a></span>__get_CNTP_CTL()</h2>
164
165 <div class="memitem">
166 <div class="memproto">
167       <table class="memname">
168         <tr>
169           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t __get_CNTP_CTL </td>
170           <td>(</td>
171           <td class="paramtype">void&#160;</td>
172           <td class="paramname"></td><td>)</td>
173           <td></td>
174         </tr>
175       </table>
176 </div><div class="memdoc">
177
178 <p>Get CNTP_CTL register. </p>
179 <dl class="section return"><dt>Returns</dt><dd>CNTP_CTL Register value</dd></dl>
180 <p>This function returns the value of the PL1 Physical Timer Control Register. (CNTP_CTL). </p>
181
182 </div>
183 </div>
184 <a id="ga2d0441a0266268a063cb7577b8873c65" name="ga2d0441a0266268a063cb7577b8873c65"></a>
185 <h2 class="memtitle"><span class="permalink"><a href="#ga2d0441a0266268a063cb7577b8873c65">&#9670;&#160;</a></span>__set_CNTP_CTL()</h2>
186
187 <div class="memitem">
188 <div class="memproto">
189       <table class="memname">
190         <tr>
191           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __set_CNTP_CTL </td>
192           <td>(</td>
193           <td class="paramtype">uint32_t&#160;</td>
194           <td class="paramname"><em>value</em></td><td>)</td>
195           <td></td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Set CNTP_CTL. </p>
201 <p>This function assigns the given value to PL1 Physical Timer Control Register (CNTP_CTL).</p>
202 <dl class="params"><dt>Parameters</dt><dd>
203   <table class="params">
204     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>CNTP_CTL Register value to set</td></tr>
205   </table>
206   </dd>
207 </dl>
208 <p>This function assigns the given value to PL1 Physical Timer Control Register (CNTP_CTL). </p>
209
210 </div>
211 </div>
212 </div><!-- contents -->
213 </div><!-- doc-content -->
214 <!-- start footer part -->
215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
216   <ul>
217     <li class="footer">
218       <script type="text/javascript">
219         <!--
220         writeFooter.call(this);
221         //-->
222       </script> 
223     </li>
224   </ul>
225 </div>
226 </body>
227 </html>