]> begriffs open source - cmsis/blob - main/Core_A/html/group__CMSIS__ACTLR.html
Update documentation for branch main
[cmsis] / main / Core_A / html / group__CMSIS__ACTLR.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): Auxiliary Control Register (ACTLR)</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 <!-- 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__ACTLR.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="#groups">Content</a> &#124;
129 <a href="#nested-classes">Data Structures</a> &#124;
130 <a href="#func-members">Functions</a>  </div>
131   <div class="headertitle"><div class="title">Auxiliary Control Register (ACTLR)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
132 </div><!--header-->
133 <div class="contents">
134
135 <p>The ACTLR provides IMPLEMENTATION DEFINED configuration and control options.  
136 <a href="#details">More...</a></p>
137 <table class="memberdecls">
138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
139 Content</h2></td></tr>
140 <tr class="memitem:group__CMSIS__ACTLR__BITS"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__ACTLR__BITS.html">ACTLR Bits</a></td></tr>
141 <tr class="memdesc:group__CMSIS__ACTLR__BITS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit position and mask macros. <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="nested-classes" name="nested-classes"></a>
145 Data Structures</h2></td></tr>
146 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionACTLR__Type.html">ACTLR_Type</a></td></tr>
147 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit field declaration for ACTLR layout.  <a href="unionACTLR__Type.html#details">More...</a><br /></td></tr>
148 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 </table><table class="memberdecls">
150 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
151 Functions</h2></td></tr>
152 <tr class="memitem:gabe7491eac1652f740050bd905baea187"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armcc_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__ACTLR.html#gabe7491eac1652f740050bd905baea187">__set_ACTRL</a> (uint32_t actrl)</td></tr>
153 <tr class="memdesc:gabe7491eac1652f740050bd905baea187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set ACTRL.  <br /></td></tr>
154 <tr class="separator:gabe7491eac1652f740050bd905baea187"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:gae75d412bfd6fe873ade00b021aefcab3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armcc_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__ACTLR.html#gae75d412bfd6fe873ade00b021aefcab3">__get_ACTLR</a> (void)</td></tr>
156 <tr class="memdesc:gae75d412bfd6fe873ade00b021aefcab3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get ACTLR.  <br /></td></tr>
157 <tr class="separator:gae75d412bfd6fe873ade00b021aefcab3"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 </table>
159 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
160 <p>The ACTLR characteristics are differs between various Armv7-A implementations.</p>
161 <p><b>Cortex-A5</b></p>
162 <table class="markdownTable">
163 <tr class="markdownTableHead">
164 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
165 <tr class="markdownTableRowOdd">
166 <td class="markdownTableBodyLeft">[31:29]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
167 <tr class="markdownTableRowEven">
168 <td class="markdownTableBodyLeft">[28]   </td><td class="markdownTableBodyLeft">DBDI   </td><td class="markdownTableBodyLeft">Disable Branch Dual Issue    </td></tr>
169 <tr class="markdownTableRowOdd">
170 <td class="markdownTableBodyLeft">[27:19]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
171 <tr class="markdownTableRowEven">
172 <td class="markdownTableBodyLeft">[18]   </td><td class="markdownTableBodyLeft">BTDIS   </td><td class="markdownTableBodyLeft">Disable indirect Branch Target Address Cache (BTAC).    </td></tr>
173 <tr class="markdownTableRowOdd">
174 <td class="markdownTableBodyLeft">[17]   </td><td class="markdownTableBodyLeft">RSDIS   </td><td class="markdownTableBodyLeft">Disable return stack operation.    </td></tr>
175 <tr class="markdownTableRowEven">
176 <td class="markdownTableBodyLeft">[16:15]   </td><td class="markdownTableBodyLeft">BP   </td><td class="markdownTableBodyLeft">Branch prediction policy.    </td></tr>
177 <tr class="markdownTableRowOdd">
178 <td class="markdownTableBodyLeft">[14:13]   </td><td class="markdownTableBodyLeft">L1PCTL   </td><td class="markdownTableBodyLeft">L1 Data prefetch control.    </td></tr>
179 <tr class="markdownTableRowEven">
180 <td class="markdownTableBodyLeft">[12]   </td><td class="markdownTableBodyLeft">RADIS   </td><td class="markdownTableBodyLeft">Disable Data Cache read-allocate mode.    </td></tr>
181 <tr class="markdownTableRowOdd">
182 <td class="markdownTableBodyLeft">[11]   </td><td class="markdownTableBodyLeft">DWBST   </td><td class="markdownTableBodyLeft">Disable AXI data write bursts to Normal memory.    </td></tr>
183 <tr class="markdownTableRowEven">
184 <td class="markdownTableBodyLeft">[10]   </td><td class="markdownTableBodyLeft">DODMBS   </td><td class="markdownTableBodyLeft">Disable optimized data memory barrier behavior.    </td></tr>
185 <tr class="markdownTableRowOdd">
186 <td class="markdownTableBodyLeft">[9:8]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
187 <tr class="markdownTableRowEven">
188 <td class="markdownTableBodyLeft">[7]   </td><td class="markdownTableBodyLeft">EXCL   </td><td class="markdownTableBodyLeft">Exclusive L1/L2 cache control.    </td></tr>
189 <tr class="markdownTableRowOdd">
190 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">SMP   </td><td class="markdownTableBodyLeft">Enables coherent requests to the processor.    </td></tr>
191 <tr class="markdownTableRowEven">
192 <td class="markdownTableBodyLeft">[5:1]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
193 <tr class="markdownTableRowOdd">
194 <td class="markdownTableBodyLeft">[0]   </td><td class="markdownTableBodyLeft">FW   </td><td class="markdownTableBodyLeft">Cache and TLB maintenance broadcast.   </td></tr>
195 </table>
196 <p><b>Cortex-A7</b></p>
197 <table class="markdownTable">
198 <tr class="markdownTableHead">
199 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
200 <tr class="markdownTableRowOdd">
201 <td class="markdownTableBodyLeft">[31:29]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
202 <tr class="markdownTableRowEven">
203 <td class="markdownTableBodyLeft">[28]   </td><td class="markdownTableBodyLeft">DDI   </td><td class="markdownTableBodyLeft">Disable Dual Issue    </td></tr>
204 <tr class="markdownTableRowOdd">
205 <td class="markdownTableBodyLeft">[27:16]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
206 <tr class="markdownTableRowEven">
207 <td class="markdownTableBodyLeft">[15]   </td><td class="markdownTableBodyLeft">DDVM   </td><td class="markdownTableBodyLeft">Disable Distributed Virtual Memory transactions.    </td></tr>
208 <tr class="markdownTableRowOdd">
209 <td class="markdownTableBodyLeft">[14:13]   </td><td class="markdownTableBodyLeft">L1PCTL   </td><td class="markdownTableBodyLeft">L1 Data prefetch control.    </td></tr>
210 <tr class="markdownTableRowEven">
211 <td class="markdownTableBodyLeft">[12]   </td><td class="markdownTableBodyLeft">L1RADIS   </td><td class="markdownTableBodyLeft">L1 Data Cache read-allocate mode disable.    </td></tr>
212 <tr class="markdownTableRowOdd">
213 <td class="markdownTableBodyLeft">[11]   </td><td class="markdownTableBodyLeft">L2RADIS   </td><td class="markdownTableBodyLeft">L2 Data Cache read-allocate mode disable.    </td></tr>
214 <tr class="markdownTableRowEven">
215 <td class="markdownTableBodyLeft">[10]   </td><td class="markdownTableBodyLeft">DODMBS   </td><td class="markdownTableBodyLeft">Disable optimized data memory barrier behavior.    </td></tr>
216 <tr class="markdownTableRowOdd">
217 <td class="markdownTableBodyLeft">[9:7]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
218 <tr class="markdownTableRowEven">
219 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">SMP   </td><td class="markdownTableBodyLeft">Enables coherent requests to the processor.    </td></tr>
220 <tr class="markdownTableRowOdd">
221 <td class="markdownTableBodyLeft">[5:0]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.   </td></tr>
222 </table>
223 <p><b>Cortex-A9</b></p>
224 <table class="markdownTable">
225 <tr class="markdownTableHead">
226 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
227 <tr class="markdownTableRowOdd">
228 <td class="markdownTableBodyLeft">[31:10]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
229 <tr class="markdownTableRowEven">
230 <td class="markdownTableBodyLeft">[9]   </td><td class="markdownTableBodyLeft">PARITY   </td><td class="markdownTableBodyLeft">Support for parity checking, if implemented.    </td></tr>
231 <tr class="markdownTableRowOdd">
232 <td class="markdownTableBodyLeft">[8]   </td><td class="markdownTableBodyLeft">AOW   </td><td class="markdownTableBodyLeft">Enable allocation in one cache way only.    </td></tr>
233 <tr class="markdownTableRowEven">
234 <td class="markdownTableBodyLeft">[7]   </td><td class="markdownTableBodyLeft">EXCL   </td><td class="markdownTableBodyLeft">Exclusive L1/L2 cache control.    </td></tr>
235 <tr class="markdownTableRowOdd">
236 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">SMP   </td><td class="markdownTableBodyLeft">Enables coherent requests to the processor.    </td></tr>
237 <tr class="markdownTableRowEven">
238 <td class="markdownTableBodyLeft">[5:4]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
239 <tr class="markdownTableRowOdd">
240 <td class="markdownTableBodyLeft">[3]   </td><td class="markdownTableBodyLeft">WFLZM   </td><td class="markdownTableBodyLeft">Enable write full line of zeros modea.    </td></tr>
241 <tr class="markdownTableRowEven">
242 <td class="markdownTableBodyLeft">[2]   </td><td class="markdownTableBodyLeft">L1PE   </td><td class="markdownTableBodyLeft">Dside prefetch.    </td></tr>
243 <tr class="markdownTableRowOdd">
244 <td class="markdownTableBodyLeft">[1]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
245 <tr class="markdownTableRowEven">
246 <td class="markdownTableBodyLeft">[0]   </td><td class="markdownTableBodyLeft">FW   </td><td class="markdownTableBodyLeft">Cache and TLB maintenance broadcast.   </td></tr>
247 </table>
248 <p>Consider using <a class="el" href="group__CMSIS__ACTLR.html#gae75d412bfd6fe873ade00b021aefcab3">__get_ACTLR</a> and <a class="el" href="group__CMSIS__ACTLR.html#gabe7491eac1652f740050bd905baea187">__set_ACTRL</a> to access ACTRL register. </p>
249 <h2 class="groupheader">Function Documentation</h2>
250 <a id="gae75d412bfd6fe873ade00b021aefcab3" name="gae75d412bfd6fe873ade00b021aefcab3"></a>
251 <h2 class="memtitle"><span class="permalink"><a href="#gae75d412bfd6fe873ade00b021aefcab3">&#9670;&#160;</a></span>__get_ACTLR()</h2>
252
253 <div class="memitem">
254 <div class="memproto">
255       <table class="memname">
256         <tr>
257           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_ACTLR </td>
258           <td>(</td>
259           <td class="paramtype">void&#160;</td>
260           <td class="paramname"></td><td>)</td>
261           <td></td>
262         </tr>
263       </table>
264 </div><div class="memdoc">
265 <dl class="section return"><dt>Returns</dt><dd>Auxiliary Control register value</dd></dl>
266 <p>This function returns the value of the <a class="el" href="group__CMSIS__ACTLR.html">Auxiliary Control Register (ACTLR)</a>. </p>
267
268 </div>
269 </div>
270 <a id="gabe7491eac1652f740050bd905baea187" name="gabe7491eac1652f740050bd905baea187"></a>
271 <h2 class="memtitle"><span class="permalink"><a href="#gabe7491eac1652f740050bd905baea187">&#9670;&#160;</a></span>__set_ACTRL()</h2>
272
273 <div class="memitem">
274 <div class="memproto">
275       <table class="memname">
276         <tr>
277           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void __set_ACTRL </td>
278           <td>(</td>
279           <td class="paramtype">uint32_t&#160;</td>
280           <td class="paramname"><em>actrl</em></td><td>)</td>
281           <td></td>
282         </tr>
283       </table>
284 </div><div class="memdoc">
285 <dl class="params"><dt>Parameters</dt><dd>
286   <table class="params">
287     <tr><td class="paramdir">[in]</td><td class="paramname">actrl</td><td>Auxiliary Control Register value to set</td></tr>
288   </table>
289   </dd>
290 </dl>
291 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__ACTLR.html">Auxiliary Control Register (ACTLR)</a>. </p>
292
293 </div>
294 </div>
295 </div><!-- contents -->
296 </div><!-- doc-content -->
297 <!-- start footer part -->
298 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
299   <ul>
300     <li class="footer">
301       <script type="text/javascript">
302         <!--
303         writeFooter.call(this);
304         //-->
305       </script> 
306     </li>
307   </ul>
308 </div>
309 </body>
310 </html>