]> begriffs open source - cmsis/blob - main/Core_A/html/group__CMSIS__CPACR.html
Update documentation for branch main
[cmsis] / main / Core_A / html / group__CMSIS__CPACR.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): Coprocessor Access Control Register (CPACR)</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__CPACR.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">Coprocessor Access Control Register (CPACR)<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 CPACR controls access to coprocessors CP0 to CP13.  
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__CPACR__BITS"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPACR__BITS.html">CPACR Bits</a></td></tr>
141 <tr class="memdesc:group__CMSIS__CPACR__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 <tr class="memitem:group__CMSIS__CPACR__CP"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPACR__CP.html">CPACR CP field values</a></td></tr>
144 <tr class="memdesc:group__CMSIS__CPACR__CP"><td class="mdescLeft">&#160;</td><td class="mdescRight">Valid values for CPACR CP field. <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="nested-classes" name="nested-classes"></a>
148 Data Structures</h2></td></tr>
149 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionCPACR__Type.html">CPACR_Type</a></td></tr>
150 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit field declaration for CPACR layout.  <a href="unionCPACR__Type.html#details">More...</a><br /></td></tr>
151 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 </table><table class="memberdecls">
153 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
154 Functions</h2></td></tr>
155 <tr class="memitem:gadb152ab7a893135695e608ecaa5b0c4e"><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__CPACR.html#gadb152ab7a893135695e608ecaa5b0c4e">__get_CPACR</a> (void)</td></tr>
156 <tr class="memdesc:gadb152ab7a893135695e608ecaa5b0c4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get CPACR.  <br /></td></tr>
157 <tr class="separator:gadb152ab7a893135695e608ecaa5b0c4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:ga8bf7e1cfb0f28bc3bff3be7fec057668"><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__CPACR.html#ga8bf7e1cfb0f28bc3bff3be7fec057668">__set_CPACR</a> (uint32_t cpacr)</td></tr>
159 <tr class="memdesc:ga8bf7e1cfb0f28bc3bff3be7fec057668"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set CPACR.  <br /></td></tr>
160 <tr class="separator:ga8bf7e1cfb0f28bc3bff3be7fec057668"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
163 <p>The CPACR characteristics are:</p>
164 <table class="markdownTable">
165 <tr class="markdownTableHead">
166 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
167 <tr class="markdownTableRowOdd">
168 <td class="markdownTableBodyLeft">[31]   </td><td class="markdownTableBodyLeft">ASEDIS   </td><td class="markdownTableBodyLeft">Disable Advanced SIMD functionality.    </td></tr>
169 <tr class="markdownTableRowEven">
170 <td class="markdownTableBodyLeft">[30]   </td><td class="markdownTableBodyLeft">D32DIS   </td><td class="markdownTableBodyLeft">Disable use of D16-D31 of the Floating-point Extension register file.    </td></tr>
171 <tr class="markdownTableRowOdd">
172 <td class="markdownTableBodyLeft">[29]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
173 <tr class="markdownTableRowEven">
174 <td class="markdownTableBodyLeft">[28]   </td><td class="markdownTableBodyLeft">TRCDIS   </td><td class="markdownTableBodyLeft">Disable CP14 access to trace registers.    </td></tr>
175 <tr class="markdownTableRowOdd">
176 <td class="markdownTableBodyLeft">[27:26]   </td><td class="markdownTableBodyLeft">CP13   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 13.    </td></tr>
177 <tr class="markdownTableRowEven">
178 <td class="markdownTableBodyLeft">[25:24]   </td><td class="markdownTableBodyLeft">CP12   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 12.    </td></tr>
179 <tr class="markdownTableRowOdd">
180 <td class="markdownTableBodyLeft">[23:22]   </td><td class="markdownTableBodyLeft">CP11   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 11.    </td></tr>
181 <tr class="markdownTableRowEven">
182 <td class="markdownTableBodyLeft">[21:20]   </td><td class="markdownTableBodyLeft">CP10   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 10.    </td></tr>
183 <tr class="markdownTableRowOdd">
184 <td class="markdownTableBodyLeft">[19:18]   </td><td class="markdownTableBodyLeft">CP9   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 9.    </td></tr>
185 <tr class="markdownTableRowEven">
186 <td class="markdownTableBodyLeft">[17:16]   </td><td class="markdownTableBodyLeft">CP8   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 8.    </td></tr>
187 <tr class="markdownTableRowOdd">
188 <td class="markdownTableBodyLeft">[15:14]   </td><td class="markdownTableBodyLeft">CP7   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 7.    </td></tr>
189 <tr class="markdownTableRowEven">
190 <td class="markdownTableBodyLeft">[13:12]   </td><td class="markdownTableBodyLeft">CP6   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 6.    </td></tr>
191 <tr class="markdownTableRowOdd">
192 <td class="markdownTableBodyLeft">[11:10]   </td><td class="markdownTableBodyLeft">CP5   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 5.    </td></tr>
193 <tr class="markdownTableRowEven">
194 <td class="markdownTableBodyLeft">[9:8]   </td><td class="markdownTableBodyLeft">CP4   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 4.    </td></tr>
195 <tr class="markdownTableRowOdd">
196 <td class="markdownTableBodyLeft">[7:6]   </td><td class="markdownTableBodyLeft">CP3   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 3.    </td></tr>
197 <tr class="markdownTableRowEven">
198 <td class="markdownTableBodyLeft">[5:4]   </td><td class="markdownTableBodyLeft">CP2   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 2.    </td></tr>
199 <tr class="markdownTableRowOdd">
200 <td class="markdownTableBodyLeft">[3:2]   </td><td class="markdownTableBodyLeft">CP1   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 1.    </td></tr>
201 <tr class="markdownTableRowEven">
202 <td class="markdownTableBodyLeft">[1:0]   </td><td class="markdownTableBodyLeft">CP0   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPACR__CP.html">Access rights</a> for coprocessor 0.   </td></tr>
203 </table>
204 <p>Consider <a class="el" href="group__CMSIS__CPACR.html#gadb152ab7a893135695e608ecaa5b0c4e">__get_CPACR</a> and <a class="el" href="group__CMSIS__CPACR.html#ga8bf7e1cfb0f28bc3bff3be7fec057668">__set_CPACR</a> to access this register. </p>
205 <h2 class="groupheader">Function Documentation</h2>
206 <a id="gadb152ab7a893135695e608ecaa5b0c4e" name="gadb152ab7a893135695e608ecaa5b0c4e"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#gadb152ab7a893135695e608ecaa5b0c4e">&#9670;&#160;</a></span>__get_CPACR()</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_CPACR </td>
214           <td>(</td>
215           <td class="paramtype">void&#160;</td>
216           <td class="paramname"></td><td>)</td>
217           <td></td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221 <dl class="section return"><dt>Returns</dt><dd>Coprocessor Access Control register value</dd></dl>
222 <p>This function returns the current value of the <a class="el" href="group__CMSIS__CPACR.html">Coprocessor Access Control Register (CPACR)</a>. </p>
223
224 </div>
225 </div>
226 <a id="ga8bf7e1cfb0f28bc3bff3be7fec057668" name="ga8bf7e1cfb0f28bc3bff3be7fec057668"></a>
227 <h2 class="memtitle"><span class="permalink"><a href="#ga8bf7e1cfb0f28bc3bff3be7fec057668">&#9670;&#160;</a></span>__set_CPACR()</h2>
228
229 <div class="memitem">
230 <div class="memproto">
231       <table class="memname">
232         <tr>
233           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void __set_CPACR </td>
234           <td>(</td>
235           <td class="paramtype">uint32_t&#160;</td>
236           <td class="paramname"><em>cpacr</em></td><td>)</td>
237           <td></td>
238         </tr>
239       </table>
240 </div><div class="memdoc">
241 <dl class="params"><dt>Parameters</dt><dd>
242   <table class="params">
243     <tr><td class="paramdir">[in]</td><td class="paramname">cpacr</td><td>Coprocessor Access Control value to set</td></tr>
244   </table>
245   </dd>
246 </dl>
247 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__CPACR.html">Coprocessor Access Control Register (CPACR)</a>. </p>
248
249 </div>
250 </div>
251 </div><!-- contents -->
252 </div><!-- doc-content -->
253 <!-- start footer part -->
254 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
255   <ul>
256     <li class="footer">
257       <script type="text/javascript">
258         <!--
259         writeFooter.call(this);
260         //-->
261       </script> 
262     </li>
263   </ul>
264 </div>
265 </body>
266 </html>