begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__TTBR.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): Translation Table Base Registers (TTBR0/TTBR1)</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__TTBR.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="#func-members">Functions</a>  </div>
 129   <div class="headertitle"><div class="title">Translation Table Base Registers (TTBR0/TTBR1)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <p>TTBRn holds the base address of translation table n, and information about the memory it occupies.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 137 Functions</h2></td></tr>
 138 <tr class="memitem:ga678997bc01f6d8d48b1d407cec24809d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__TTBR.html#ga678997bc01f6d8d48b1d407cec24809d">__get_TTBR0</a> (void)</td></tr>
 139 <tr class="memdesc:ga678997bc01f6d8d48b1d407cec24809d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get TTBR0.  <br /></td></tr>
 140 <tr class="separator:ga678997bc01f6d8d48b1d407cec24809d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:gad2ccad052f77c18897c5ceaaf307711e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__TTBR.html#gad2ccad052f77c18897c5ceaaf307711e">__set_TTBR0</a> (uint32_t ttbr0)</td></tr>
 142 <tr class="memdesc:gad2ccad052f77c18897c5ceaaf307711e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set TTBR0.  <br /></td></tr>
 143 <tr class="separator:gad2ccad052f77c18897c5ceaaf307711e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 </table>
 145 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 146 <p>TTBRn holds the base address of translation table n, and information about the memory it occupies. </p>
 147 <p><b>32-bit TTBR format</b> </p><table class="markdownTable">
 148 <tr class="markdownTableHead">
 149 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
 150 <tr class="markdownTableRowOdd">
 151 <td class="markdownTableBodyLeft">[31:x]   </td><td class="markdownTableBodyLeft">BADDR   </td><td class="markdownTableBodyLeft">Translation table base address, bits[31:x].    </td></tr>
 152 <tr class="markdownTableRowEven">
 153 <td class="markdownTableBodyLeft">[x-1:7]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
 154 <tr class="markdownTableRowOdd">
 155 <td class="markdownTableBodyLeft">[6]   </td><td class="markdownTableBodyLeft">IRGN[0]   </td><td class="markdownTableBodyLeft">Inner region bit 0.    </td></tr>
 156 <tr class="markdownTableRowEven">
 157 <td class="markdownTableBodyLeft">[5]   </td><td class="markdownTableBodyLeft">NOS   </td><td class="markdownTableBodyLeft">Not Outer Shareable bit.    </td></tr>
 158 <tr class="markdownTableRowOdd">
 159 <td class="markdownTableBodyLeft">[4:3]   </td><td class="markdownTableBodyLeft">RGN   </td><td class="markdownTableBodyLeft">Region bits.    </td></tr>
 160 <tr class="markdownTableRowEven">
 161 <td class="markdownTableBodyLeft">[2]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
 162 <tr class="markdownTableRowOdd">
 163 <td class="markdownTableBodyLeft">[1]   </td><td class="markdownTableBodyLeft">S   </td><td class="markdownTableBodyLeft">Shareable bit.    </td></tr>
 164 <tr class="markdownTableRowEven">
 165 <td class="markdownTableBodyLeft">[0]   </td><td class="markdownTableBodyLeft">C/IRGN[1]   </td><td class="markdownTableBodyLeft">Cacheable bit. / Inner region bit 1.   </td></tr>
 166 </table>
 167 <dl class="section note"><dt>Note</dt><dd>The width of TTBR0 BADDR field depends on the setting in TTBCR N field, giving <code>x=14-N</code>. </dd>
 168 <dd>
 169 The width of TTBR1 BADDR field is fixed at <code>x=14</code>.</dd></dl>
 170 <p><b>64-bit TTBR format</b> </p><table class="markdownTable">
 171 <tr class="markdownTableHead">
 172 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
 173 <tr class="markdownTableRowOdd">
 174 <td class="markdownTableBodyLeft">[63:56]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
 175 <tr class="markdownTableRowEven">
 176 <td class="markdownTableBodyLeft">[55:48]   </td><td class="markdownTableBodyLeft">ASID   </td><td class="markdownTableBodyLeft">An ASID for the translation table base address.    </td></tr>
 177 <tr class="markdownTableRowOdd">
 178 <td class="markdownTableBodyLeft">[47:40]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
 179 <tr class="markdownTableRowEven">
 180 <td class="markdownTableBodyLeft">[39:x]   </td><td class="markdownTableBodyLeft">BADDR   </td><td class="markdownTableBodyLeft">Translation table base address, bits[39:x].    </td></tr>
 181 <tr class="markdownTableRowOdd">
 182 <td class="markdownTableBodyLeft">[x-1:0]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.   </td></tr>
 183 </table>
 184 <dl class="section note"><dt>Note</dt><dd>The width of TBBR0/TBBR1 BADDR fields depends on the settings in TTBCR T0SZ/T1SZ fields respectively, giving <code>x=14-TnSZ</code>.</dd></dl>
 185 <p>Consider using <a class="el" href="group__CMSIS__TTBR.html#ga678997bc01f6d8d48b1d407cec24809d">__get_TTBR0</a> and <a class="el" href="group__CMSIS__TTBR.html#gad2ccad052f77c18897c5ceaaf307711e">__set_TTBR0</a> for accessing TTBR0 register. </p>
 186 <h2 class="groupheader">Function Documentation</h2>
 187 <a id="ga678997bc01f6d8d48b1d407cec24809d" name="ga678997bc01f6d8d48b1d407cec24809d"></a>
 188 <h2 class="memtitle"><span class="permalink"><a href="#ga678997bc01f6d8d48b1d407cec24809d">&#9670;&#160;</a></span>__get_TTBR0()</h2>
 189
 190 <div class="memitem">
 191 <div class="memproto">
 192       <table class="memname">
 193         <tr>
 194           <td class="memname">__STATIC_INLINE uint32_t __get_TTBR0 </td>
 195           <td>(</td>
 196           <td class="paramtype">void&#160;</td>
 197           <td class="paramname"></td><td>)</td>
 198           <td></td>
 199         </tr>
 200       </table>
 201 </div><div class="memdoc">
 202
 203 <p>Get TTBR0. </p>
 204 <p>This function returns the value of the Translation Table Base Register 0.</p>
 205 <dl class="section return"><dt>Returns</dt><dd>Translation Table Base Register 0 value</dd></dl>
 206 <p>This function returns the value of the Translation Table Base Register 0. </p>
 207
 208 </div>
 209 </div>
 210 <a id="gad2ccad052f77c18897c5ceaaf307711e" name="gad2ccad052f77c18897c5ceaaf307711e"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#gad2ccad052f77c18897c5ceaaf307711e">&#9670;&#160;</a></span>__set_TTBR0()</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">__STATIC_INLINE void __set_TTBR0 </td>
 218           <td>(</td>
 219           <td class="paramtype">uint32_t&#160;</td>
 220           <td class="paramname"><em>ttbr0</em></td><td>)</td>
 221           <td></td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>Set TTBR0. </p>
 227 <p>This function assigns the given value to the Translation Table Base Register 0.</p>
 228 <dl class="params"><dt>Parameters</dt><dd>
 229   <table class="params">
 230     <tr><td class="paramdir">[in]</td><td class="paramname">ttbr0</td><td>Translation Table Base Register 0 value to set</td></tr>
 231   </table>
 232   </dd>
 233 </dl>
 234 <p>This function assigns the given value to the Translation Table Base Register 0. </p>
 235
 236 </div>
 237 </div>
 238 </div><!-- contents -->
 239 </div><!-- doc-content -->
 240 <!-- start footer part -->
 241 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 242   <ul>
 243     <li class="footer">
 244       <script type="text/javascript">
 245         <!--
 246         writeFooter.call(this);
 247         //-->
 248       </script>
 249     </li>
 250   </ul>
 251 </div>
 252 </body>
 253 </html>