]> begriffs open source - cmsis/blob - main/Core/html/using_VTOR_pg.html
Update documentation for branch main
[cmsis] / main / Core / html / using_VTOR_pg.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-M): Using Interrupt Vector Remap</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-M)
47    &#160;<span id="projectnumber"><script type="text/javascript">
48      <!--
49      writeHeader.call(this);
50      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-M)");
51      //-->
52     </script>
53    </span>
54    </div>
55    <div id="projectbrief">CMSIS-Core support for Cortex-M 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 <!-- 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('using_VTOR_pg.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><div class="header">
127   <div class="headertitle"><div class="title">Using Interrupt Vector Remap </div></div>
128 </div><!--header-->
129 <div class="contents">
130 <div class="textblock"><p>Most Cortex-M processors provide VTOR register for remapping interrupt vectors. The following example shows a typical use case where the interrupt vectors are copied to RAM and the SysTick_Handler is replaced.</p>
131 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;ARMCM3.h&quot;</span>                     <span class="comment">// Device header</span></div>
132 <div class="line"> </div>
133 <div class="line"><span class="preprocessor">#define VECTORTABLE_SIZE        (240)    </span><span class="comment">/* size of the used vector tables    */</span><span class="preprocessor"></span></div>
134 <div class="line">                                         <span class="comment">/* see startup file startup_ARMCM3.c */</span></div>
135 <div class="line"><span class="preprocessor">#define VECTORTABLE_ALIGNMENT   (0x100U) </span><span class="comment">/* 16 Cortex + 32 ARMCM3 = 48 words  */</span><span class="preprocessor"></span></div>
136 <div class="line">                                         <span class="comment">/* next power of 2 = 256             */</span></div>
137 <div class="line"> </div>
138 <div class="line"><span class="comment">/* externals from startup_ARMCM3.c */</span></div>
139 <div class="line"><span class="keyword">extern</span> uint32_t <a class="code hl_define" href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a>[VECTORTABLE_SIZE];        <span class="comment">/* vector table ROM  */</span></div>
140 <div class="line"> </div>
141 <div class="line"><span class="comment">/* new vector table in RAM, same size as vector table in ROM */</span></div>
142 <div class="line">uint32_t vectorTable_RAM[VECTORTABLE_SIZE] __attribute__(( aligned (VECTORTABLE_ALIGNMENT) ));</div>
143 <div class="line"> </div>
144 <div class="line"> </div>
145 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
146 <div class="line"><span class="comment">  SysTick_Handler</span></div>
147 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
148 <div class="line"><span class="keyword">volatile</span> uint32_t msTicks = 0;                        <span class="comment">/* counts 1ms timeTicks */</span></div>
149 <div class="line"><span class="keywordtype">void</span> SysTick_Handler(<span class="keywordtype">void</span>) {</div>
150 <div class="line">  msTicks++;                                             <span class="comment">/* increment counter */</span></div>
151 <div class="line">}</div>
152 <div class="line"> </div>
153 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
154 <div class="line"><span class="comment">  SysTick_Handler (RAM)</span></div>
155 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
156 <div class="line"><span class="keyword">volatile</span> uint32_t msTicks_RAM = 0;                    <span class="comment">/* counts 1ms timeTicks */</span></div>
157 <div class="line"><span class="keywordtype">void</span> SysTick_Handler_RAM(<span class="keywordtype">void</span>) {</div>
158 <div class="line">  msTicks_RAM++;                                         <span class="comment">/* increment counter */</span></div>
159 <div class="line">}</div>
160 <div class="line"> </div>
161 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
162 <div class="line"><span class="comment">  MAIN function</span></div>
163 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
164 <div class="line"><span class="keywordtype">int</span> main (<span class="keywordtype">void</span>) {</div>
165 <div class="line">  uint32_t i;</div>
166 <div class="line">   </div>
167 <div class="line">  <span class="keywordflow">for</span> (i = 0; i &lt; VECTORTABLE_SIZE; i++) {</div>
168 <div class="line">    vectorTable_RAM[i] = <a class="code hl_define" href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a>[i];       <span class="comment">/* copy vector table to RAM */</span></div>
169 <div class="line">  }</div>
170 <div class="line">                                                   <span class="comment">/* replace SysTick Handler */</span></div>
171 <div class="line">  vectorTable_RAM[<a class="code hl_enumvalue" href="group__NVIC__gr.html#gga7e1129cd8a196f4284d41db3e82ad5c8a6dbff8f8543325f3474cbae2446776e7">SysTick_IRQn</a> + 16] = (uint32_t)SysTick_Handler_RAM;</div>
172 <div class="line">  </div>
173 <div class="line">  <span class="comment">/* relocate vector table */</span> </div>
174 <div class="line">  <a class="code hl_function" href="group__Core__Register__gr.html#gaeb8e5f7564a8ea23678fe3c987b04013">__disable_irq</a>();</div>
175 <div class="line">    SCB-&gt;VTOR = (uint32_t)&amp;vectorTable_RAM;</div>
176 <div class="line">  <a class="code hl_function" href="group__intrinsic__CPU__gr.html#gacb2a8ca6eae1ba4b31161578b720c199">__DSB</a>();</div>
177 <div class="line">  <a class="code hl_function" href="group__Core__Register__gr.html#ga0f98dfbd252b89d12564472dbeba9c27">__enable_irq</a>();</div>
178 <div class="line"> </div>
179 <div class="line">  <a class="code hl_function" href="group__system__init__gr.html#gae0c36a9591fe6e9c45ecb21a794f0f0f">SystemCoreClockUpdate</a>();                        <span class="comment">/* Get Core Clock Frequency */</span></div>
180 <div class="line">  <a class="code hl_function" href="group__SysTick__gr.html#gabe47de40e9b0ad465b752297a9d9f427">SysTick_Config</a>(<a class="code hl_variable" href="group__system__init__gr.html#gaa3cd3e43291e81e795d642b79b6088e6">SystemCoreClock</a> / 1000ul); <span class="comment">/* Setup SysTick Timer for 1 msec */</span></div>
181 <div class="line">   </div>
182 <div class="line">  <span class="keywordflow">while</span>(1);</div>
183 <div class="line">}</div>
184 <div class="ttc" id="agroup__Core__Register__gr_html_ga0f98dfbd252b89d12564472dbeba9c27"><div class="ttname"><a href="group__Core__Register__gr.html#ga0f98dfbd252b89d12564472dbeba9c27">__enable_irq</a></div><div class="ttdeci">void __enable_irq(void)</div><div class="ttdoc">Globally enables interrupts and configurable fault handlers.</div></div>
185 <div class="ttc" id="agroup__Core__Register__gr_html_gaeb8e5f7564a8ea23678fe3c987b04013"><div class="ttname"><a href="group__Core__Register__gr.html#gaeb8e5f7564a8ea23678fe3c987b04013">__disable_irq</a></div><div class="ttdeci">void __disable_irq(void)</div><div class="ttdoc">Globally disables interrupts and configurable fault handlers.</div></div>
186 <div class="ttc" id="agroup__NVIC__gr_html_gga7e1129cd8a196f4284d41db3e82ad5c8a6dbff8f8543325f3474cbae2446776e7"><div class="ttname"><a href="group__NVIC__gr.html#gga7e1129cd8a196f4284d41db3e82ad5c8a6dbff8f8543325f3474cbae2446776e7">SysTick_IRQn</a></div><div class="ttdeci">@ SysTick_IRQn</div><div class="ttdoc">Exception 15: System Tick Interrupt.</div><div class="ttdef"><b>Definition:</b> Ref_NVIC.txt:398</div></div>
187 <div class="ttc" id="agroup__SysTick__gr_html_gabe47de40e9b0ad465b752297a9d9f427"><div class="ttname"><a href="group__SysTick__gr.html#gabe47de40e9b0ad465b752297a9d9f427">SysTick_Config</a></div><div class="ttdeci">uint32_t SysTick_Config(uint32_t ticks)</div><div class="ttdoc">System Tick Timer Configuration.</div></div>
188 <div class="ttc" id="agroup__compiler__conntrol__gr_html_gab94ebeb20055f1848d7b707d3c7cfc5d"><div class="ttname"><a href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a></div><div class="ttdeci">#define __VECTOR_TABLE</div><div class="ttdoc">Symbol name used for the (static) interrupt vector table.</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:531</div></div>
189 <div class="ttc" id="agroup__intrinsic__CPU__gr_html_gacb2a8ca6eae1ba4b31161578b720c199"><div class="ttname"><a href="group__intrinsic__CPU__gr.html#gacb2a8ca6eae1ba4b31161578b720c199">__DSB</a></div><div class="ttdeci">void __DSB(void)</div><div class="ttdoc">Data Synchronization Barrier.</div></div>
190 <div class="ttc" id="agroup__system__init__gr_html_gaa3cd3e43291e81e795d642b79b6088e6"><div class="ttname"><a href="group__system__init__gr.html#gaa3cd3e43291e81e795d642b79b6088e6">SystemCoreClock</a></div><div class="ttdeci">uint32_t SystemCoreClock</div><div class="ttdoc">Variable to hold the system core clock value.</div><div class="ttdef"><b>Definition:</b> Ref_SystemAndClock.txt:68</div></div>
191 <div class="ttc" id="agroup__system__init__gr_html_gae0c36a9591fe6e9c45ecb21a794f0f0f"><div class="ttname"><a href="group__system__init__gr.html#gae0c36a9591fe6e9c45ecb21a794f0f0f">SystemCoreClockUpdate</a></div><div class="ttdeci">void SystemCoreClockUpdate(void)</div><div class="ttdoc">Function to update the variable SystemCoreClock.</div></div>
192 </div><!-- fragment --> </div></div><!-- contents -->
193 </div><!-- PageDoc -->
194 </div><!-- doc-content -->
195 <!-- start footer part -->
196 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
197   <ul>
198     <li class="footer">
199       <script type="text/javascript">
200         <!--
201         writeFooter.call(this);
202         //-->
203       </script> 
204     </li>
205   </ul>
206 </div>
207 </body>
208 </html>