begriffs open source - cmsis/blob - main/Core_A/html/group__CMSIS__SP.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): Stack Pointer (SP/R13)</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 <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__SP.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="#func-members">Functions</a>  </div>
 132   <div class="headertitle"><div class="title">Stack Pointer (SP/R13)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>The processor uses SP as a pointer to the active stack.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 140 Functions</h2></td></tr>
 141 <tr class="memitem:ga6af63cb939bd108aef1c0f12622350cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> <a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__SP.html#ga6af63cb939bd108aef1c0f12622350cb">__set_SP</a> (uint32_t stack)</td></tr>
 142 <tr class="memdesc:ga6af63cb939bd108aef1c0f12622350cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Stack Pointer.  <br /></td></tr>
 143 <tr class="separator:ga6af63cb939bd108aef1c0f12622350cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:gabfe36eb17b6ae34633c7e155d132426e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> <a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__SP.html#gabfe36eb17b6ae34633c7e155d132426e">__set_SP_usr</a> (uint32_t topOfProcStack)</td></tr>
 145 <tr class="memdesc:gabfe36eb17b6ae34633c7e155d132426e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set USR/SYS Stack Pointer.  <br /></td></tr>
 146 <tr class="separator:gabfe36eb17b6ae34633c7e155d132426e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table>
 148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 149 <p>The Stack Pointer is banked per processor mode. Accessing the active stack pointer actually returns/modifies the stack pointer of the current processor execution mode.</p>
 150 <table class="markdownTable">
 151 <tr class="markdownTableHead">
 152 <th class="markdownTableHeadLeft">Mode   </th><th class="markdownTableHeadLeft">Actual SP    </th></tr>
 153 <tr class="markdownTableRowOdd">
 154 <td class="markdownTableBodyLeft">User/System   </td><td class="markdownTableBodyLeft">SP_usr    </td></tr>
 155 <tr class="markdownTableRowEven">
 156 <td class="markdownTableBodyLeft">Hypervisor   </td><td class="markdownTableBodyLeft">SP_hyp    </td></tr>
 157 <tr class="markdownTableRowOdd">
 158 <td class="markdownTableBodyLeft">Supervisor   </td><td class="markdownTableBodyLeft">SP_svc    </td></tr>
 159 <tr class="markdownTableRowEven">
 160 <td class="markdownTableBodyLeft">Abort   </td><td class="markdownTableBodyLeft">SP_abt    </td></tr>
 161 <tr class="markdownTableRowOdd">
 162 <td class="markdownTableBodyLeft">Undefined   </td><td class="markdownTableBodyLeft">SP_und    </td></tr>
 163 <tr class="markdownTableRowEven">
 164 <td class="markdownTableBodyLeft">Monitor   </td><td class="markdownTableBodyLeft">SP_mon    </td></tr>
 165 <tr class="markdownTableRowOdd">
 166 <td class="markdownTableBodyLeft">IRQ   </td><td class="markdownTableBodyLeft">SP_irq    </td></tr>
 167 <tr class="markdownTableRowEven">
 168 <td class="markdownTableBodyLeft">FIQ   </td><td class="markdownTableBodyLeft">SP_fiq   </td></tr>
 169 </table>
 170 <p>Consider <a class="el" href="group__CMSIS__SP.html#ga6af63cb939bd108aef1c0f12622350cb">__set_SP</a> and <a class="el" href="group__CMSIS__SP.html#gabfe36eb17b6ae34633c7e155d132426e">__set_SP_usr</a> to access this register. </p>
 171 <h2 class="groupheader">Function Documentation</h2>
 172 <a id="ga6af63cb939bd108aef1c0f12622350cb" name="ga6af63cb939bd108aef1c0f12622350cb"></a>
 173 <h2 class="memtitle"><span class="permalink"><a href="#ga6af63cb939bd108aef1c0f12622350cb">&#9670;&#160;</a></span>__set_SP()</h2>
 174
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> <a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> void __set_SP </td>
 180           <td>(</td>
 181           <td class="paramtype">uint32_t&#160;</td>
 182           <td class="paramname"><em>stack</em></td><td>)</td>
 183           <td></td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187 <dl class="params"><dt>Parameters</dt><dd>
 188   <table class="params">
 189     <tr><td class="paramdir">[in]</td><td class="paramname">stack</td><td>Stack Pointer value to set</td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193 <p>This function assigns the given value to the current stack pointer. </p>
 194
 195 </div>
 196 </div>
 197 <a id="gabfe36eb17b6ae34633c7e155d132426e" name="gabfe36eb17b6ae34633c7e155d132426e"></a>
 198 <h2 class="memtitle"><span class="permalink"><a href="#gabfe36eb17b6ae34633c7e155d132426e">&#9670;&#160;</a></span>__set_SP_usr()</h2>
 199
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> <a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> void __set_SP_usr </td>
 205           <td>(</td>
 206           <td class="paramtype">uint32_t&#160;</td>
 207           <td class="paramname"><em>topOfProcStack</em></td><td>)</td>
 208           <td></td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212 <dl class="params"><dt>Parameters</dt><dd>
 213   <table class="params">
 214     <tr><td class="paramdir">[in]</td><td class="paramname">topOfProcStack</td><td>USR/SYS Stack Pointer value to set</td></tr>
 215   </table>
 216   </dd>
 217 </dl>
 218 <p>This function assigns the given value to the User/System Stack Pointer (SP_usr). </p>
 219
 220 </div>
 221 </div>
 222 </div><!-- contents -->
 223 </div><!-- doc-content -->
 224 <!-- start footer part -->
 225 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 226   <ul>
 227     <li class="footer">
 228       <script type="text/javascript">
 229         <!--
 230         writeFooter.call(this);
 231         //-->
 232       </script>
 233     </li>
 234   </ul>
 235 </div>
 236 </body>
 237 </html>