]> begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__VBAR.html
Update main branch documentation
[cmsis] / main / Core_A / group__CMSIS__VBAR.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): Vector Base Address Register (VBAR)</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__VBAR.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">Vector Base Address Register (VBAR)<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>When high exception vectors are not selected, the VBAR holds the exception base address for exceptions that are not taken to Monitor mode or to Hyp mode.  
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:ga8abf5c92597d8e7d403aa26d8246387c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__VBAR.html#ga8abf5c92597d8e7d403aa26d8246387c">__get_VBAR</a> (void)</td></tr>
142 <tr class="memdesc:ga8abf5c92597d8e7d403aa26d8246387c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get VBAR.  <br /></td></tr>
143 <tr class="separator:ga8abf5c92597d8e7d403aa26d8246387c"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ga582f9a60f7b090ae5a4e8f60ef3b79f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__VBAR.html#ga582f9a60f7b090ae5a4e8f60ef3b79f8">__set_VBAR</a> (uint32_t vbar)</td></tr>
145 <tr class="memdesc:ga582f9a60f7b090ae5a4e8f60ef3b79f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set VBAR.  <br /></td></tr>
146 <tr class="separator:ga582f9a60f7b090ae5a4e8f60ef3b79f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 </table>
148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
149 <p>When high exception vectors are not selected, the VBAR holds the exception base address for exceptions that are not taken to Monitor mode or to Hyp mode. </p>
150 <table class="markdownTable">
151 <tr class="markdownTableHead">
152 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
153 <tr class="markdownTableRowOdd">
154 <td class="markdownTableBodyLeft">[31:5]   </td><td class="markdownTableBodyLeft">VBA   </td><td class="markdownTableBodyLeft">Bits[31:5] of the base address of the low exception vectors.    </td></tr>
155 <tr class="markdownTableRowEven">
156 <td class="markdownTableBodyLeft">[4:0]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.   </td></tr>
157 </table>
158 <p>Consider using <a class="el" href="group__CMSIS__VBAR.html#ga8abf5c92597d8e7d403aa26d8246387c">__get_VBAR</a> and <a class="el" href="group__CMSIS__VBAR.html#ga582f9a60f7b090ae5a4e8f60ef3b79f8">__set_VBAR</a> for accessing this register. </p>
159 <h2 class="groupheader">Function Documentation</h2>
160 <a id="ga8abf5c92597d8e7d403aa26d8246387c" name="ga8abf5c92597d8e7d403aa26d8246387c"></a>
161 <h2 class="memtitle"><span class="permalink"><a href="#ga8abf5c92597d8e7d403aa26d8246387c">&#9670;&#160;</a></span>__get_VBAR()</h2>
162
163 <div class="memitem">
164 <div class="memproto">
165       <table class="memname">
166         <tr>
167           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_VBAR </td>
168           <td>(</td>
169           <td class="paramtype">void&#160;</td>
170           <td class="paramname"></td><td>)</td>
171           <td></td>
172         </tr>
173       </table>
174 </div><div class="memdoc">
175
176 <p>Get VBAR. </p>
177 <p>This function returns the value of the Vector Base Address Register.</p>
178 <dl class="section return"><dt>Returns</dt><dd>Vector Base Address Register</dd></dl>
179 <p>This function returns the value of the <a class="el" href="group__CMSIS__VBAR.html">Vector Base Address Register (VBAR)</a>. </p>
180
181 </div>
182 </div>
183 <a id="ga582f9a60f7b090ae5a4e8f60ef3b79f8" name="ga582f9a60f7b090ae5a4e8f60ef3b79f8"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#ga582f9a60f7b090ae5a4e8f60ef3b79f8">&#9670;&#160;</a></span>__set_VBAR()</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> void __set_VBAR </td>
191           <td>(</td>
192           <td class="paramtype">uint32_t&#160;</td>
193           <td class="paramname"><em>vbar</em></td><td>)</td>
194           <td></td>
195         </tr>
196       </table>
197 </div><div class="memdoc">
198
199 <p>Set VBAR. </p>
200 <p>This function assigns the given value to the Vector Base Address Register.</p>
201 <dl class="params"><dt>Parameters</dt><dd>
202   <table class="params">
203     <tr><td class="paramdir">[in]</td><td class="paramname">vbar</td><td>Vector Base Address Register value to set</td></tr>
204   </table>
205   </dd>
206 </dl>
207 <p>This function assigns the given value to the <a class="el" href="group__CMSIS__VBAR.html">Vector Base Address Register (VBAR)</a>. </p>
208
209 </div>
210 </div>
211 </div><!-- contents -->
212 </div><!-- doc-content -->
213 <!-- start footer part -->
214 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
215   <ul>
216     <li class="footer">
217       <script type="text/javascript">
218         <!--
219         writeFooter.call(this);
220         //-->
221       </script> 
222     </li>
223   </ul>
224 </div>
225 </body>
226 </html>