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): 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&dn=expat.txt MIT */
24 $(document).ready(function() { init_search(); });
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>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
46 writeHeader.call(this);
47 writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
52 <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
54 <td> <div id="MSearchBox" class="MSearchBoxInactive">
56 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
66 <!--END !PROJECT_NAME-->
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
74 <script type="text/javascript">
75 writeComponentTabs.call(this);
79 <script type="text/javascript">
80 writeSubComponentTabs.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__CMSIS__Core__RegAccFunctions.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="#func-members">Functions</a> </div>
129 <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 class="contents">
132 <table class="memberdecls">
133 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
134 Functions</h2></td></tr>
135 <tr class="memitem:gaa4bddbd2091b8fb234ae43d290e69e78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gaa4bddbd2091b8fb234ae43d290e69e78">__get_CPSR</a> (void)</td></tr>
136 <tr class="memdesc:gaa4bddbd2091b8fb234ae43d290e69e78"><td class="mdescLeft"> </td><td class="mdescRight">Get CPSR Register. <br /></td></tr>
137 <tr class="separator:gaa4bddbd2091b8fb234ae43d290e69e78"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:ga48f0cfea7413b74bd90986762383c1cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga48f0cfea7413b74bd90986762383c1cd">__set_CPSR</a> (uint32_t cpsr)</td></tr>
139 <tr class="memdesc:ga48f0cfea7413b74bd90986762383c1cd"><td class="mdescLeft"> </td><td class="mdescRight">Set CPSR Register. <br /></td></tr>
140 <tr class="separator:ga48f0cfea7413b74bd90986762383c1cd"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:ga4cf62691d82a3f3a0d844ae94718a5a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga4cf62691d82a3f3a0d844ae94718a5a9">__get_mode</a> (void)</td></tr>
142 <tr class="memdesc:ga4cf62691d82a3f3a0d844ae94718a5a9"><td class="mdescLeft"> </td><td class="mdescRight">Get Mode. <br /></td></tr>
143 <tr class="separator:ga4cf62691d82a3f3a0d844ae94718a5a9"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:ga7ad5710bc622794ffed1d31740f6be55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga7ad5710bc622794ffed1d31740f6be55">__set_mode</a> (uint32_t mode)</td></tr>
145 <tr class="memdesc:ga7ad5710bc622794ffed1d31740f6be55"><td class="mdescLeft"> </td><td class="mdescRight">Set Mode. <br /></td></tr>
146 <tr class="separator:ga7ad5710bc622794ffed1d31740f6be55"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:gaebea89632181454327b3dc0cf29ec358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gaebea89632181454327b3dc0cf29ec358">__get_SP</a> (void)</td></tr>
148 <tr class="memdesc:gaebea89632181454327b3dc0cf29ec358"><td class="mdescLeft"> </td><td class="mdescRight">Get Stack Pointer. <br /></td></tr>
149 <tr class="separator:gaebea89632181454327b3dc0cf29ec358"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:ga6d25d5770874bf1c824f892739bfdf41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga6d25d5770874bf1c824f892739bfdf41">__set_SP</a> (uint32_t stack)</td></tr>
151 <tr class="memdesc:ga6d25d5770874bf1c824f892739bfdf41"><td class="mdescLeft"> </td><td class="mdescRight">Set Stack Pointer. <br /></td></tr>
152 <tr class="separator:ga6d25d5770874bf1c824f892739bfdf41"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:ga7009688fca7a35b5e3ba6cf11cc74869"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga7009688fca7a35b5e3ba6cf11cc74869">__get_SP_usr</a> (void)</td></tr>
154 <tr class="memdesc:ga7009688fca7a35b5e3ba6cf11cc74869"><td class="mdescLeft"> </td><td class="mdescRight">Get USR/SYS Stack Pointer. <br /></td></tr>
155 <tr class="separator:ga7009688fca7a35b5e3ba6cf11cc74869"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:gaabb67304694380b52a86cdc77efdfbf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gaabb67304694380b52a86cdc77efdfbf9">__set_SP_usr</a> (uint32_t topOfProcStack)</td></tr>
157 <tr class="memdesc:gaabb67304694380b52a86cdc77efdfbf9"><td class="mdescLeft"> </td><td class="mdescRight">Set USR/SYS Stack Pointer. <br /></td></tr>
158 <tr class="separator:gaabb67304694380b52a86cdc77efdfbf9"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:gadde57667b9f81c468a49268513624b90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gadde57667b9f81c468a49268513624b90">__get_FPEXC</a> (void)</td></tr>
160 <tr class="memdesc:gadde57667b9f81c468a49268513624b90"><td class="mdescLeft"> </td><td class="mdescRight">Get FPEXC. <br /></td></tr>
161 <tr class="separator:gadde57667b9f81c468a49268513624b90"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:ga14ba90beb9b4712454f35ac453c45f5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga14ba90beb9b4712454f35ac453c45f5d">__set_FPEXC</a> (uint32_t fpexc)</td></tr>
163 <tr class="memdesc:ga14ba90beb9b4712454f35ac453c45f5d"><td class="mdescLeft"> </td><td class="mdescRight">Set FPEXC. <br /></td></tr>
164 <tr class="separator:ga14ba90beb9b4712454f35ac453c45f5d"><td class="memSeparator" colspan="2"> </td></tr>
166 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
167 <h2 class="groupheader">Function Documentation</h2>
168 <a id="gaa4bddbd2091b8fb234ae43d290e69e78" name="gaa4bddbd2091b8fb234ae43d290e69e78"></a>
169 <h2 class="memtitle"><span class="permalink"><a href="#gaa4bddbd2091b8fb234ae43d290e69e78">◆ </a></span>__get_CPSR()</h2>
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
175 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t __get_CPSR </td>
177 <td class="paramtype">void </td>
178 <td class="paramname"></td><td>)</td>
182 </div><div class="memdoc">
184 <p>Get CPSR Register. </p>
185 <dl class="section return"><dt>Returns</dt><dd>CPSR Register value</dd></dl>
186 <p>This function returns the content of the <a class="el" href="group__CMSIS__CPSR.html">Current Program Status Register (CPSR)</a>. </p>
190 <a id="gadde57667b9f81c468a49268513624b90" name="gadde57667b9f81c468a49268513624b90"></a>
191 <h2 class="memtitle"><span class="permalink"><a href="#gadde57667b9f81c468a49268513624b90">◆ </a></span>__get_FPEXC()</h2>
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
197 <td class="memname">__STATIC_INLINE uint32_t __get_FPEXC </td>
199 <td class="paramtype">void </td>
200 <td class="paramname"></td><td>)</td>
204 </div><div class="memdoc">
207 <dl class="section return"><dt>Returns</dt><dd>Floating Point Exception Control register value</dd></dl>
208 <p>This function returns the current value of the <a class="el" href="group__CMSIS__FPEXC.html">Floating-Point Exception Control register (FPEXC)</a>. </p>
212 <a id="ga4cf62691d82a3f3a0d844ae94718a5a9" name="ga4cf62691d82a3f3a0d844ae94718a5a9"></a>
213 <h2 class="memtitle"><span class="permalink"><a href="#ga4cf62691d82a3f3a0d844ae94718a5a9">◆ </a></span>__get_mode()</h2>
215 <div class="memitem">
216 <div class="memproto">
217 <table class="memname">
219 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t __get_mode </td>
221 <td class="paramtype">void </td>
222 <td class="paramname"></td><td>)</td>
226 </div><div class="memdoc">
229 <dl class="section return"><dt>Returns</dt><dd>Processor Mode </dd></dl>
233 <a id="gaebea89632181454327b3dc0cf29ec358" name="gaebea89632181454327b3dc0cf29ec358"></a>
234 <h2 class="memtitle"><span class="permalink"><a href="#gaebea89632181454327b3dc0cf29ec358">◆ </a></span>__get_SP()</h2>
236 <div class="memitem">
237 <div class="memproto">
238 <table class="memname">
240 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t __get_SP </td>
242 <td class="paramtype">void </td>
243 <td class="paramname"></td><td>)</td>
247 </div><div class="memdoc">
249 <p>Get Stack Pointer. </p>
250 <dl class="section return"><dt>Returns</dt><dd>Stack Pointer value </dd></dl>
254 <a id="ga7009688fca7a35b5e3ba6cf11cc74869" name="ga7009688fca7a35b5e3ba6cf11cc74869"></a>
255 <h2 class="memtitle"><span class="permalink"><a href="#ga7009688fca7a35b5e3ba6cf11cc74869">◆ </a></span>__get_SP_usr()</h2>
257 <div class="memitem">
258 <div class="memproto">
259 <table class="memname">
261 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t __get_SP_usr </td>
263 <td class="paramtype">void </td>
264 <td class="paramname"></td><td>)</td>
268 </div><div class="memdoc">
270 <p>Get USR/SYS Stack Pointer. </p>
271 <dl class="section return"><dt>Returns</dt><dd>USR/SYS Stack Pointer value </dd></dl>
275 <a id="ga48f0cfea7413b74bd90986762383c1cd" name="ga48f0cfea7413b74bd90986762383c1cd"></a>
276 <h2 class="memtitle"><span class="permalink"><a href="#ga48f0cfea7413b74bd90986762383c1cd">◆ </a></span>__set_CPSR()</h2>
278 <div class="memitem">
279 <div class="memproto">
280 <table class="memname">
282 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __set_CPSR </td>
284 <td class="paramtype">uint32_t </td>
285 <td class="paramname"><em>cpsr</em></td><td>)</td>
289 </div><div class="memdoc">
291 <p>Set CPSR Register. </p>
292 <dl class="params"><dt>Parameters</dt><dd>
293 <table class="params">
294 <tr><td class="paramdir">[in]</td><td class="paramname">cpsr</td><td>CPSR value to set</td></tr>
298 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__CPSR.html">Current Program Status Register (CPSR)</a>. </p>
302 <a id="ga14ba90beb9b4712454f35ac453c45f5d" name="ga14ba90beb9b4712454f35ac453c45f5d"></a>
303 <h2 class="memtitle"><span class="permalink"><a href="#ga14ba90beb9b4712454f35ac453c45f5d">◆ </a></span>__set_FPEXC()</h2>
305 <div class="memitem">
306 <div class="memproto">
307 <table class="memname">
309 <td class="memname">__STATIC_INLINE void __set_FPEXC </td>
311 <td class="paramtype">uint32_t </td>
312 <td class="paramname"><em>fpexc</em></td><td>)</td>
316 </div><div class="memdoc">
319 <dl class="params"><dt>Parameters</dt><dd>
320 <table class="params">
321 <tr><td class="paramdir">[in]</td><td class="paramname">fpexc</td><td>Floating Point Exception Control value to set</td></tr>
325 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__FPEXC.html">Floating-Point Exception Control register (FPEXC)</a>. </p>
329 <a id="ga7ad5710bc622794ffed1d31740f6be55" name="ga7ad5710bc622794ffed1d31740f6be55"></a>
330 <h2 class="memtitle"><span class="permalink"><a href="#ga7ad5710bc622794ffed1d31740f6be55">◆ </a></span>__set_mode()</h2>
332 <div class="memitem">
333 <div class="memproto">
334 <table class="memname">
336 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __set_mode </td>
338 <td class="paramtype">uint32_t </td>
339 <td class="paramname"><em>mode</em></td><td>)</td>
343 </div><div class="memdoc">
346 <dl class="params"><dt>Parameters</dt><dd>
347 <table class="params">
348 <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Mode value to set </td></tr>
355 <a id="ga6d25d5770874bf1c824f892739bfdf41" name="ga6d25d5770874bf1c824f892739bfdf41"></a>
356 <h2 class="memtitle"><span class="permalink"><a href="#ga6d25d5770874bf1c824f892739bfdf41">◆ </a></span>__set_SP()</h2>
358 <div class="memitem">
359 <div class="memproto">
360 <table class="memname">
362 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __set_SP </td>
364 <td class="paramtype">uint32_t </td>
365 <td class="paramname"><em>stack</em></td><td>)</td>
369 </div><div class="memdoc">
371 <p>Set Stack Pointer. </p>
372 <dl class="params"><dt>Parameters</dt><dd>
373 <table class="params">
374 <tr><td class="paramdir">[in]</td><td class="paramname">stack</td><td>Stack Pointer value to set</td></tr>
378 <p>This function assigns the given value to the current stack pointer. </p>
382 <a id="gaabb67304694380b52a86cdc77efdfbf9" name="gaabb67304694380b52a86cdc77efdfbf9"></a>
383 <h2 class="memtitle"><span class="permalink"><a href="#gaabb67304694380b52a86cdc77efdfbf9">◆ </a></span>__set_SP_usr()</h2>
385 <div class="memitem">
386 <div class="memproto">
387 <table class="memname">
389 <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void __set_SP_usr </td>
391 <td class="paramtype">uint32_t </td>
392 <td class="paramname"><em>topOfProcStack</em></td><td>)</td>
396 </div><div class="memdoc">
398 <p>Set USR/SYS Stack Pointer. </p>
399 <dl class="params"><dt>Parameters</dt><dd>
400 <table class="params">
401 <tr><td class="paramdir">[in]</td><td class="paramname">topOfProcStack</td><td>USR/SYS Stack Pointer value to set</td></tr>
405 <p>This function assigns the given value to the User/System Stack Pointer (SP_usr). </p>
409 </div><!-- contents -->
410 </div><!-- doc-content -->
411 <!-- start footer part -->
412 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
415 <script type="text/javascript">
417 writeFooter.call(this);