]> begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__CPSR.html
Update documentation for branch main
[cmsis] / main / Core_A / group__CMSIS__CPSR.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): Current Program Status Register (CPSR)</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__CPSR.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>  </div>
130   <div class="headertitle"><div class="title">Current Program Status Register (CPSR)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
131 </div><!--header-->
132 <div class="contents">
133
134 <p>The Current Program Status Register (CPSR) holds processor status and control information.  
135 <a href="#details">More...</a></p>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
138 Content</h2></td></tr>
139 <tr class="memitem:group__CMSIS__CPSR__BITS"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPSR__BITS.html">CPSR Bits</a></td></tr>
140 <tr class="memdesc:group__CMSIS__CPSR__BITS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit position and mask macros. <br /></td></tr>
141 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:group__CMSIS__CPSR__M"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPSR__M.html">CPSR M field values</a></td></tr>
143 <tr class="memdesc:group__CMSIS__CPSR__M"><td class="mdescLeft">&#160;</td><td class="mdescRight">Valid values for CPSR M field. <br /></td></tr>
144 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 </table><table class="memberdecls">
146 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
147 Data Structures</h2></td></tr>
148 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionCPSR__Type.html">CPSR_Type</a></td></tr>
149 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit field declaration for CPSR layout.  <a href="unionCPSR__Type.html#details">More...</a><br /></td></tr>
150 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 </table>
152 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
153 <p>The Current Program Status Register (CPSR) holds processor status and control information. </p>
154 <p>The individual register bits have the following meaning:</p>
155 <table class="markdownTable">
156 <tr class="markdownTableHead">
157 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
158 <tr class="markdownTableRowOdd">
159 <td class="markdownTableBodyLeft">[31]   </td><td class="markdownTableBodyLeft">N   </td><td class="markdownTableBodyLeft">Negative condition code flag    </td></tr>
160 <tr class="markdownTableRowEven">
161 <td class="markdownTableBodyLeft">[30]   </td><td class="markdownTableBodyLeft">Z   </td><td class="markdownTableBodyLeft">Zero condition code flag    </td></tr>
162 <tr class="markdownTableRowOdd">
163 <td class="markdownTableBodyLeft">[29]   </td><td class="markdownTableBodyLeft">C   </td><td class="markdownTableBodyLeft">Carry condition code flag    </td></tr>
164 <tr class="markdownTableRowEven">
165 <td class="markdownTableBodyLeft">[28]   </td><td class="markdownTableBodyLeft">V   </td><td class="markdownTableBodyLeft">Overflow condition code flag    </td></tr>
166 <tr class="markdownTableRowOdd">
167 <td class="markdownTableBodyLeft">[27]   </td><td class="markdownTableBodyLeft">Q   </td><td class="markdownTableBodyLeft">Cumulative saturation bit    </td></tr>
168 <tr class="markdownTableRowEven">
169 <td class="markdownTableBodyLeft">[26:25]   </td><td class="markdownTableBodyLeft">IT[1:0]   </td><td class="markdownTableBodyLeft">If-Then execution state bits for the Thumb IT (If-Then) instruction    </td></tr>
170 <tr class="markdownTableRowOdd">
171 <td class="markdownTableBodyLeft">[24]   </td><td class="markdownTableBodyLeft">J   </td><td class="markdownTableBodyLeft">Jazelle bit    </td></tr>
172 <tr class="markdownTableRowEven">
173 <td class="markdownTableBodyLeft">[19:16]   </td><td class="markdownTableBodyLeft">GE   </td><td class="markdownTableBodyLeft">Greater than or Equal flags    </td></tr>
174 <tr class="markdownTableRowOdd">
175 <td class="markdownTableBodyLeft">[15:10]   </td><td class="markdownTableBodyLeft">IT[7:2]   </td><td class="markdownTableBodyLeft">If-Then execution state bits for the Thumb IT (If-Then) instruction    </td></tr>
176 <tr class="markdownTableRowEven">
177 <td class="markdownTableBodyLeft">[9]   </td><td class="markdownTableBodyLeft">E   </td><td class="markdownTableBodyLeft">Endianness execution state bit: 0 - Little-endian, 1 - Big-endian    </td></tr>
178 <tr class="markdownTableRowOdd">
179 <td class="markdownTableBodyLeft">[8]   </td><td class="markdownTableBodyLeft">A   </td><td class="markdownTableBodyLeft">Asynchronous abort mask bit    </td></tr>
180 <tr class="markdownTableRowEven">
181 <td class="markdownTableBodyLeft">[7]   </td><td class="markdownTableBodyLeft">I   </td><td class="markdownTableBodyLeft">IRQ mask bit    </td></tr>
182 <tr class="markdownTableRowOdd">
183 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">F   </td><td class="markdownTableBodyLeft">FIRQ mask bit    </td></tr>
184 <tr class="markdownTableRowEven">
185 <td class="markdownTableBodyLeft">[5]   </td><td class="markdownTableBodyLeft">T   </td><td class="markdownTableBodyLeft">Thumb execution state bit    </td></tr>
186 <tr class="markdownTableRowOdd">
187 <td class="markdownTableBodyLeft">[4:0]   </td><td class="markdownTableBodyLeft">M   </td><td class="markdownTableBodyLeft"><a class="el" href="group__CMSIS__CPSR__M.html">Mode field</a>   </td></tr>
188 </table>
189 <p>Consider using <a class="el" href="group__CMSIS__Core__RegAccFunctions.html#gaa4bddbd2091b8fb234ae43d290e69e78">__get_CPSR</a> and <a class="el" href="group__CMSIS__Core__RegAccFunctions.html#ga48f0cfea7413b74bd90986762383c1cd">__set_CPSR</a> for accessing this register. </p>
190 </div><!-- contents -->
191 </div><!-- doc-content -->
192 <!-- start footer part -->
193 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
194   <ul>
195     <li class="footer">
196       <script type="text/javascript">
197         <!--
198         writeFooter.call(this);
199         //-->
200       </script> 
201     </li>
202   </ul>
203 </div>
204 </body>
205 </html>