]> begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__Core__RegAccFunctions.html
Update documentation for branch main
[cmsis] / main / Core_A / group__CMSIS__Core__RegAccFunctions.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): CMSIS Core Register Access Functions</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__Core__RegAccFunctions.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="#func-members">Functions</a>  </div>
130   <div class="headertitle"><div class="title">CMSIS Core Register Access Functions<div class="ingroups"><a class="el" href="group__CMSIS__Core__FunctionInterface.html">Core Peripherals</a></div></div></div>
131 </div><!--header-->
132 <div class="contents">
133 <table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
135 Content</h2></td></tr>
136 <tr class="memitem:group__CMSIS__SIMD__intrinsics"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__SIMD__intrinsics.html">CMSIS SIMD Intrinsics</a></td></tr>
137 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:group__CMSIS__Core__intrinsics"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__intrinsics.html">CMSIS Core Intrinsics</a></td></tr>
139 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 </table><table class="memberdecls">
141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
142 Functions</h2></td></tr>
143 <tr class="memitem:gae84bf4e95944e61937f4ed2453e5ef23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gae84bf4e95944e61937f4ed2453e5ef23">__enable_irq</a> (void)</td></tr>
144 <tr class="memdesc:gae84bf4e95944e61937f4ed2453e5ef23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable IRQ Interrupts.  <br /></td></tr>
145 <tr class="separator:gae84bf4e95944e61937f4ed2453e5ef23"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:ga2299877e4ba3e162ca9dbabd6e0abef6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga2299877e4ba3e162ca9dbabd6e0abef6">__disable_irq</a> (void)</td></tr>
147 <tr class="memdesc:ga2299877e4ba3e162ca9dbabd6e0abef6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable IRQ Interrupts.  <br /></td></tr>
148 <tr class="separator:ga2299877e4ba3e162ca9dbabd6e0abef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:gadccd32ddc2337a9a944c2da9c485a81d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gadccd32ddc2337a9a944c2da9c485a81d">__enable_fault_irq</a> (void)</td></tr>
150 <tr class="memdesc:gadccd32ddc2337a9a944c2da9c485a81d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable FIQ.  <br /></td></tr>
151 <tr class="separator:gadccd32ddc2337a9a944c2da9c485a81d"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:ga6f1d7bf2b8b84502e8de12f0c288e117"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga6f1d7bf2b8b84502e8de12f0c288e117">__disable_fault_irq</a> (void)</td></tr>
153 <tr class="memdesc:ga6f1d7bf2b8b84502e8de12f0c288e117"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable FIQ.  <br /></td></tr>
154 <tr class="separator:ga6f1d7bf2b8b84502e8de12f0c288e117"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:ga6a275172e274ea7ce6c22030d07c6c64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga6a275172e274ea7ce6c22030d07c6c64">__get_FPSCR</a> (void)</td></tr>
156 <tr class="memdesc:ga6a275172e274ea7ce6c22030d07c6c64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FPSCR.  <br /></td></tr>
157 <tr class="separator:ga6a275172e274ea7ce6c22030d07c6c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:ga17c6ff443c52c74125fefef7de5fee1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga17c6ff443c52c74125fefef7de5fee1d">__set_FPSCR</a> (uint32_t fpscr)</td></tr>
159 <tr class="memdesc:ga17c6ff443c52c74125fefef7de5fee1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FPSCR.  <br /></td></tr>
160 <tr class="separator:ga17c6ff443c52c74125fefef7de5fee1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
163 <h2 class="groupheader">Function Documentation</h2>
164 <a id="ga6f1d7bf2b8b84502e8de12f0c288e117" name="ga6f1d7bf2b8b84502e8de12f0c288e117"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#ga6f1d7bf2b8b84502e8de12f0c288e117">&#9670;&#160;</a></span>__disable_fault_irq()</h2>
166
167 <div class="memitem">
168 <div class="memproto">
169       <table class="memname">
170         <tr>
171           <td class="memname"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __disable_fault_irq </td>
172           <td>(</td>
173           <td class="paramtype">void&#160;</td>
174           <td class="paramname"></td><td>)</td>
175           <td></td>
176         </tr>
177       </table>
178 </div><div class="memdoc">
179
180 <p>Disable FIQ. </p>
181 <p>Disables FIQ interrupts by setting special-purpose register FAULTMASK. Can only be executed in Privileged modes. </p>
182
183 </div>
184 </div>
185 <a id="ga2299877e4ba3e162ca9dbabd6e0abef6" name="ga2299877e4ba3e162ca9dbabd6e0abef6"></a>
186 <h2 class="memtitle"><span class="permalink"><a href="#ga2299877e4ba3e162ca9dbabd6e0abef6">&#9670;&#160;</a></span>__disable_irq()</h2>
187
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __disable_irq </td>
193           <td>(</td>
194           <td class="paramtype">void&#160;</td>
195           <td class="paramname"></td><td>)</td>
196           <td></td>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200
201 <p>Disable IRQ Interrupts. </p>
202 <p>Disables IRQ interrupts by setting the I-bit in the CPSR. Can only be executed in Privileged modes. </p>
203
204 </div>
205 </div>
206 <a id="gadccd32ddc2337a9a944c2da9c485a81d" name="gadccd32ddc2337a9a944c2da9c485a81d"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#gadccd32ddc2337a9a944c2da9c485a81d">&#9670;&#160;</a></span>__enable_fault_irq()</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __enable_fault_irq </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
222 <p>Enable FIQ. </p>
223 <p>Enables FIQ interrupts by clearing special-purpose register FAULTMASK. Can only be executed in Privileged modes. </p>
224
225 </div>
226 </div>
227 <a id="gae84bf4e95944e61937f4ed2453e5ef23" name="gae84bf4e95944e61937f4ed2453e5ef23"></a>
228 <h2 class="memtitle"><span class="permalink"><a href="#gae84bf4e95944e61937f4ed2453e5ef23">&#9670;&#160;</a></span>__enable_irq()</h2>
229
230 <div class="memitem">
231 <div class="memproto">
232       <table class="memname">
233         <tr>
234           <td class="memname"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __enable_irq </td>
235           <td>(</td>
236           <td class="paramtype">void&#160;</td>
237           <td class="paramname"></td><td>)</td>
238           <td></td>
239         </tr>
240       </table>
241 </div><div class="memdoc">
242
243 <p>Enable IRQ Interrupts. </p>
244 <p>Enables IRQ interrupts by clearing the I-bit in the CPSR. Can only be executed in Privileged modes. </p>
245
246 </div>
247 </div>
248 <a id="ga6a275172e274ea7ce6c22030d07c6c64" name="ga6a275172e274ea7ce6c22030d07c6c64"></a>
249 <h2 class="memtitle"><span class="permalink"><a href="#ga6a275172e274ea7ce6c22030d07c6c64">&#9670;&#160;</a></span>__get_FPSCR()</h2>
250
251 <div class="memitem">
252 <div class="memproto">
253       <table class="memname">
254         <tr>
255           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_FPSCR </td>
256           <td>(</td>
257           <td class="paramtype">void&#160;</td>
258           <td class="paramname"></td><td>)</td>
259           <td></td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263
264 <p>Get FPSCR. </p>
265 <p>Returns the current value of the Floating Point Status/Control register. </p><dl class="section return"><dt>Returns</dt><dd>Floating Point Status/Control register value</dd></dl>
266 <p>This function returns the current value of the <a class="el" href="group__CMSIS__FPSCR.html">Floating-point Status and Control Register (FPSCR)</a>. </p>
267
268 </div>
269 </div>
270 <a id="ga17c6ff443c52c74125fefef7de5fee1d" name="ga17c6ff443c52c74125fefef7de5fee1d"></a>
271 <h2 class="memtitle"><span class="permalink"><a href="#ga17c6ff443c52c74125fefef7de5fee1d">&#9670;&#160;</a></span>__set_FPSCR()</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_FPSCR </td>
278           <td>(</td>
279           <td class="paramtype">uint32_t&#160;</td>
280           <td class="paramname"><em>fpscr</em></td><td>)</td>
281           <td></td>
282         </tr>
283       </table>
284 </div><div class="memdoc">
285
286 <p>Set FPSCR. </p>
287 <p>Assigns the given value to the Floating Point Status/Control register. </p><dl class="params"><dt>Parameters</dt><dd>
288   <table class="params">
289     <tr><td class="paramdir">[in]</td><td class="paramname">fpscr</td><td>Floating Point Status/Control value to set</td></tr>
290   </table>
291   </dd>
292 </dl>
293 <p>Assigns the given value to the <a class="el" href="group__CMSIS__FPSCR.html">Floating-point Status and Control Register (FPSCR)</a>. </p>
294
295 </div>
296 </div>
297 </div><!-- contents -->
298 </div><!-- doc-content -->
299 <!-- start footer part -->
300 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
301   <ul>
302     <li class="footer">
303       <script type="text/javascript">
304         <!--
305         writeFooter.call(this);
306         //-->
307       </script> 
308     </li>
309   </ul>
310 </div>
311 </body>
312 </html>