begriffs open source - cmsis/blob - dev/v6.0.0-dev35/Core_A/html/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 <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);
  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 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__CMSIS__CPSR.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#groups">Content</a> &#124;
 132 <a href="#nested-classes">Data Structures</a> &#124;
 133 <a href="#func-members">Functions</a>  </div>
 134   <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>
 135 </div><!--header-->
 136 <div class="contents">
 137
 138 <p>The Current Program Status Register (CPSR) holds processor status and control information.
 139 <a href="#details">More...</a></p>
 140 <table class="memberdecls">
 141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
 142 Content</h2></td></tr>
 143 <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>
 144 <tr class="memdesc:group__CMSIS__CPSR__BITS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bit position and mask macros. <br /></td></tr>
 145 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <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>
 147 <tr class="memdesc:group__CMSIS__CPSR__M"><td class="mdescLeft">&#160;</td><td class="mdescRight">Valid values for CPSR M field. <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="nested-classes" name="nested-classes"></a>
 151 Data Structures</h2></td></tr>
 152 <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>
 153 <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>
 154 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table><table class="memberdecls">
 156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 157 Functions</h2></td></tr>
 158 <tr class="memitem:ga0308d7d313bced36c3d1a4c2f9741186"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPSR.html#ga0308d7d313bced36c3d1a4c2f9741186">__get_CPSR</a> (void)</td></tr>
 159 <tr class="memdesc:ga0308d7d313bced36c3d1a4c2f9741186"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get CPSR (Current Program Status Register)  <br /></td></tr>
 160 <tr class="separator:ga0308d7d313bced36c3d1a4c2f9741186"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:gaf87faa3453333bcac5667fb1ccfc7f61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__CPSR.html#gaf87faa3453333bcac5667fb1ccfc7f61">__set_CPSR</a> (uint32_t cpsr)</td></tr>
 162 <tr class="memdesc:gaf87faa3453333bcac5667fb1ccfc7f61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set CPSR (Current Program Status Register)  <br /></td></tr>
 163 <tr class="separator:gaf87faa3453333bcac5667fb1ccfc7f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 </table>
 165 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 166 <p>The individual register bits have the following meaning:</p>
 167 <table class="markdownTable">
 168 <tr class="markdownTableHead">
 169 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
 170 <tr class="markdownTableRowOdd">
 171 <td class="markdownTableBodyLeft">[31]   </td><td class="markdownTableBodyLeft">N   </td><td class="markdownTableBodyLeft">Negative condition code flag    </td></tr>
 172 <tr class="markdownTableRowEven">
 173 <td class="markdownTableBodyLeft">[30]   </td><td class="markdownTableBodyLeft">Z   </td><td class="markdownTableBodyLeft">Zero condition code flag    </td></tr>
 174 <tr class="markdownTableRowOdd">
 175 <td class="markdownTableBodyLeft">[29]   </td><td class="markdownTableBodyLeft">C   </td><td class="markdownTableBodyLeft">Carry condition code flag    </td></tr>
 176 <tr class="markdownTableRowEven">
 177 <td class="markdownTableBodyLeft">[28]   </td><td class="markdownTableBodyLeft">V   </td><td class="markdownTableBodyLeft">Overflow condition code flag    </td></tr>
 178 <tr class="markdownTableRowOdd">
 179 <td class="markdownTableBodyLeft">[27]   </td><td class="markdownTableBodyLeft">Q   </td><td class="markdownTableBodyLeft">Cumulative saturation bit    </td></tr>
 180 <tr class="markdownTableRowEven">
 181 <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>
 182 <tr class="markdownTableRowOdd">
 183 <td class="markdownTableBodyLeft">[24]   </td><td class="markdownTableBodyLeft">J   </td><td class="markdownTableBodyLeft">Jazelle bit    </td></tr>
 184 <tr class="markdownTableRowEven">
 185 <td class="markdownTableBodyLeft">[19:16]   </td><td class="markdownTableBodyLeft">GE   </td><td class="markdownTableBodyLeft">Greater than or Equal flags    </td></tr>
 186 <tr class="markdownTableRowOdd">
 187 <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>
 188 <tr class="markdownTableRowEven">
 189 <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>
 190 <tr class="markdownTableRowOdd">
 191 <td class="markdownTableBodyLeft">[8]   </td><td class="markdownTableBodyLeft">A   </td><td class="markdownTableBodyLeft">Asynchronous abort mask bit    </td></tr>
 192 <tr class="markdownTableRowEven">
 193 <td class="markdownTableBodyLeft">[7]   </td><td class="markdownTableBodyLeft">I   </td><td class="markdownTableBodyLeft">IRQ mask bit    </td></tr>
 194 <tr class="markdownTableRowOdd">
 195 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">F   </td><td class="markdownTableBodyLeft">FIRQ mask bit    </td></tr>
 196 <tr class="markdownTableRowEven">
 197 <td class="markdownTableBodyLeft">[5]   </td><td class="markdownTableBodyLeft">T   </td><td class="markdownTableBodyLeft">Thumb execution state bit    </td></tr>
 198 <tr class="markdownTableRowOdd">
 199 <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>
 200 </table>
 201 <p>Consider using <a class="el" href="group__CMSIS__CPSR.html#ga0308d7d313bced36c3d1a4c2f9741186">__get_CPSR</a> and <a class="el" href="group__CMSIS__CPSR.html#gaf87faa3453333bcac5667fb1ccfc7f61">__set_CPSR</a> for accessing this register. </p>
 202 <h2 class="groupheader">Function Documentation</h2>
 203 <a id="ga0308d7d313bced36c3d1a4c2f9741186" name="ga0308d7d313bced36c3d1a4c2f9741186"></a>
 204 <h2 class="memtitle"><span class="permalink"><a href="#ga0308d7d313bced36c3d1a4c2f9741186">&#9670;&#160;</a></span>__get_CPSR()</h2>
 205
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_CPSR </td>
 211           <td>(</td>
 212           <td class="paramtype">void&#160;</td>
 213           <td class="paramname"></td><td>)</td>
 214           <td></td>
 215         </tr>
 216       </table>
 217 </div><div class="memdoc">
 218 <dl class="section return"><dt>Returns</dt><dd>CPSR Register value</dd></dl>
 219 <p>This function returns the content of the <a class="el" href="group__CMSIS__CPSR.html">Current Program Status Register (CPSR)</a>. </p>
 220
 221 </div>
 222 </div>
 223 <a id="gaf87faa3453333bcac5667fb1ccfc7f61" name="gaf87faa3453333bcac5667fb1ccfc7f61"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#gaf87faa3453333bcac5667fb1ccfc7f61">&#9670;&#160;</a></span>__set_CPSR()</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void __set_CPSR </td>
 231           <td>(</td>
 232           <td class="paramtype">uint32_t&#160;</td>
 233           <td class="paramname"><em>cpsr</em></td><td>)</td>
 234           <td></td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238 <dl class="params"><dt>Parameters</dt><dd>
 239   <table class="params">
 240     <tr><td class="paramdir">[in]</td><td class="paramname">cpsr</td><td>CPSR value to set</td></tr>
 241   </table>
 242   </dd>
 243 </dl>
 244 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__CPSR.html">Current Program Status Register (CPSR)</a>. </p>
 245
 246 </div>
 247 </div>
 248 </div><!-- contents -->
 249 </div><!-- doc-content -->
 250 <!-- start footer part -->
 251 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 252   <ul>
 253     <li class="footer">
 254       <script type="text/javascript">
 255         <!--
 256         writeFooter.call(this);
 257         //-->
 258       </script>
 259     </li>
 260   </ul>
 261 </div>
 262 </body>
 263 </html>