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">
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): Startup File startup_<Device>.c</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&dn=expat.txt MIT */
28 $(document).ready(function() { init_search(); });
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>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
49 writeHeader.call(this);
50 writeVersionDropdown.call(this);
55 <div id="projectbrief">CMSIS-Core support for Cortex-M processor-based devices</div>
57 <td> <div id="MSearchBox" class="MSearchBoxInactive">
59 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
69 <!--END !PROJECT_NAME-->
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
77 <script type="text/javascript">
78 writeComponentTabs.call(this);
82 <script type="text/javascript">
83 writeSubComponentTabs.call(this);
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
94 <div id="nav-tree-contents">
95 <div id="nav-sync" class="sync"></div>
98 <div id="splitbar" style="-moz-user-select:none;"
99 class="ui-resizable-handle">
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('startup_c_pg.html',''); initResizable(); });
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)">
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
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>
129 <div><div class="header">
130 <div class="headertitle"><div class="title">Startup File startup_<Device>.c </div></div>
132 <div class="contents">
133 <div class="textblock"><p><a class="anchor" id="md_src_core_startup_c"></a> The startup file defines device exceptions and interrupts, and provides their initial (weak) handler functions. The file has a naming convention <code>startup_<Device>.c</code> where <code><Device></code> corresponds to the device name.</p>
134 <p>Specifically, following functionalities are provided in the startup file:</p><ul>
135 <li>The reset handler <code>Reset_Handler</code> which is executed upon CPU reset and typically calls the <code><a class="el" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2" title="Function to Initialize the system.">SystemInit()</a></code> function. After the system init the control is transferred to the C/C++ run-time library which performs initialization and calls the <code>main</code> function in the user code.</li>
136 <li>The setup values for the Main Stack Pointer (MSP).</li>
137 <li>Exception vectors of the Cortex-M Processor with weak functions that implement default routines.</li>
138 <li>Interrupt vectors that are device specific with weak functions that implement default routines.</li>
140 <p>To adapt the file to a specific device only the interrupt vector table needs to be extended with the device-specific interrupt handlers. The naming convention for the interrupt handler names is <code><interrupt_name>_IRQHandler</code>. This table needs to be consistent with <a class="el" href="group__NVIC__gr.html#ga7e1129cd8a196f4284d41db3e82ad5c8">IRQn_Type</a> that defines all the IRQ numbers for each interrupt.</p>
141 <p>Additional application-specific adaptations may be required in the startup code and therefore so the startup file shall be located in the application project. <a class="el" href="cmsis_files_dfps.html">Delivery in CMSIS-Packs</a> explains how this can be achieved when device support is provided in <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">CMSIS pack format</a>.</p>
142 <p><b>Example:</b></p>
143 <p>The following example shows the extension of the interrupt vector table for the LPC1100 device family.</p>
144 <div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
145 <div class="line"><span class="comment"> Exception / Interrupt Handler</span></div>
146 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
147 <div class="line"><span class="comment">/* Exceptions */</span></div>
148 <div class="line"><span class="keywordtype">void</span> WAKEUP0_IRQHandler (<span class="keywordtype">void</span>) __attribute__ ((weak, alias(<span class="stringliteral">"Default_Handler"</span>)));</div>
149 <div class="line"><span class="keywordtype">void</span> WAKEUP1_IRQHandler (<span class="keywordtype">void</span>) __attribute__ ((weak, alias(<span class="stringliteral">"Default_Handler"</span>)));</div>
150 <div class="line"><span class="keywordtype">void</span> WAKEUP2_IRQHandler (<span class="keywordtype">void</span>) __attribute__ ((weak, alias(<span class="stringliteral">"Default_Handler"</span>)));</div>
151 <div class="line"><span class="comment">// :</span></div>
152 <div class="line"><span class="comment">// :</span></div>
153 <div class="line"><span class="keywordtype">void</span> EINT1_IRQHandler (<span class="keywordtype">void</span>) __attribute__ ((weak, alias(<span class="stringliteral">"Default_Handler"</span>)));</div>
154 <div class="line"><span class="keywordtype">void</span> EINT2_IRQHandler (<span class="keywordtype">void</span>) __attribute__ ((weak, alias(<span class="stringliteral">"Default_Handler"</span>)));</div>
155 <div class="line"><span class="comment">// :</span></div>
156 <div class="line"><span class="comment">// :</span></div>
157 <div class="line"> </div>
158 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
159 <div class="line"><span class="comment"> Exception / Interrupt Vector table</span></div>
160 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
161 <div class="line"><span class="keyword">extern</span> <span class="keyword">const</span> pFunc <a class="code hl_define" href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a>[240];</div>
162 <div class="line"> <span class="keyword">const</span> pFunc <a class="code hl_define" href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a>[240] <a class="code hl_define" href="group__compiler__conntrol__gr.html#ga4f65c96effa79fbd610fea43ee7d745b">__VECTOR_TABLE_ATTRIBUTE</a> = {</div>
163 <div class="line"> (pFunc)(&<a class="code hl_define" href="group__compiler__conntrol__gr.html#ga1002e751427b1189f92787d4e4eef965">__INITIAL_SP</a>), <span class="comment">/* Initial Stack Pointer */</span></div>
164 <div class="line"> Reset_Handler, <span class="comment">/* Reset Handler */</span></div>
165 <div class="line"> NMI_Handler, <span class="comment">/* -14 NMI Handler */</span></div>
166 <div class="line"> HardFault_Handler, <span class="comment">/* -13 Hard Fault Handler */</span></div>
167 <div class="line"> MemManage_Handler, <span class="comment">/* -12 MPU Fault Handler */</span></div>
168 <div class="line"> BusFault_Handler, <span class="comment">/* -11 Bus Fault Handler */</span></div>
169 <div class="line"> UsageFault_Handler, <span class="comment">/* -10 Usage Fault Handler */</span></div>
170 <div class="line"> 0, <span class="comment">/* Reserved */</span></div>
171 <div class="line"> 0, <span class="comment">/* Reserved */</span></div>
172 <div class="line"> 0, <span class="comment">/* Reserved */</span></div>
173 <div class="line"> 0, <span class="comment">/* Reserved */</span></div>
174 <div class="line"> SVC_Handler, <span class="comment">/* -5 SVC Handler */</span></div>
175 <div class="line"> DebugMon_Handler, <span class="comment">/* -4 Debug Monitor Handler */</span></div>
176 <div class="line"> 0, <span class="comment">/* Reserved */</span></div>
177 <div class="line"> PendSV_Handler, <span class="comment">/* -2 PendSV Handler */</span></div>
178 <div class="line"> SysTick_Handler, <span class="comment">/* -1 SysTick Handler */</span></div>
179 <div class="line"> </div>
180 <div class="line"> <span class="comment">/* Interrupts */</span></div>
181 <div class="line"> WAKEUP0_IRQHandler, <span class="comment">/* 0 Wakeup PIO0.0 */</span></div>
182 <div class="line"> WAKEUP1_IRQHandler, <span class="comment">/* 1 Wakeup PIO0.1 */</span></div>
183 <div class="line"> WAKEUP2_IRQHandler, <span class="comment">/* 2 Wakeup PIO0.2 */</span></div>
184 <div class="line"> <span class="comment">// :</span></div>
185 <div class="line"> <span class="comment">// :</span></div>
186 <div class="line"> EINT1_IRQHandler, <span class="comment">/* 30 PIO INT1 */</span></div>
187 <div class="line"> EINT2_IRQHandler, <span class="comment">/* 31 PIO INT2 */</span></div>
188 <div class="line"> <span class="comment">// :</span></div>
189 <div class="line"> <span class="comment">// :</span></div>
190 <div class="line">};</div>
191 <div class="ttc" id="agroup__compiler__conntrol__gr_html_ga1002e751427b1189f92787d4e4eef965"><div class="ttname"><a href="group__compiler__conntrol__gr.html#ga1002e751427b1189f92787d4e4eef965">__INITIAL_SP</a></div><div class="ttdeci">#define __INITIAL_SP</div><div class="ttdoc">Compiler/linker symbol specifying the location of the main stack (MSP).</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:495</div></div>
192 <div class="ttc" id="agroup__compiler__conntrol__gr_html_ga4f65c96effa79fbd610fea43ee7d745b"><div class="ttname"><a href="group__compiler__conntrol__gr.html#ga4f65c96effa79fbd610fea43ee7d745b">__VECTOR_TABLE_ATTRIBUTE</a></div><div class="ttdeci">#define __VECTOR_TABLE_ATTRIBUTE</div><div class="ttdoc">Additional decl specs to be used when defining the (static) interrupt vector table.</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:544</div></div>
193 <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>
194 </div><!-- fragment --><h1><a class="anchor" id="startup_c_sec"></a>
195 startup_Device.c Template File</h1>
196 <p>CMSIS-Core <a class="el" href="cmsis_device_files.html#cmsis_template_files">Device Template Files</a> include a <code>startup_Device.c</code> file that can be used as a starting point for chip vendors to implement own device-specific startup file.</p>
197 <p>The C startup file relys on certain compiler specific preprocessor defines specified in CMSIS compiler headers:</p><ul>
198 <li><a class="el" href="group__compiler__conntrol__gr.html#ga1002e751427b1189f92787d4e4eef965">__INITIAL_SP</a></li>
199 <li><a class="el" href="group__compiler__conntrol__gr.html#ga84b0bad4aa39632d3faea46aa1e102a8">__STACK_LIMIT</a></li>
200 <li><a class="el" href="group__compiler__conntrol__gr.html#ga72db8b026c5e100254080fefabd9fd88">__PROGRAM_START</a></li>
201 <li><a class="el" href="group__compiler__conntrol__gr.html#gab94ebeb20055f1848d7b707d3c7cfc5d">__VECTOR_TABLE</a></li>
202 <li><a class="el" href="group__compiler__conntrol__gr.html#ga4f65c96effa79fbd610fea43ee7d745b">__VECTOR_TABLE_ATTRIBUTE</a></li>
203 <li><a class="el" href="group__stacksealing__support__trustzone__functions.html#gacc36ddac1642fe80a690364911542d79">__STACK_SEAL</a> (for Armv8-M/v8.1-M)</li>
204 <li><a class="el" href="group__stacksealing__support__trustzone__functions.html#ga87d2473a3adebb73941065366feec690">__TZ_set_STACKSEAL_S</a> (for Armv8-M/v8.1-M)</li>
206 <p>The stack sealing and the initialization for the Stack Limit register is done in function <code>Reset_Handler(void)</code>:</p>
207 <div class="fragment"><div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
208 <div class="line"><span class="comment"> Reset Handler called on controller reset</span></div>
209 <div class="line"><span class="comment"> *----------------------------------------------------------------------------*/</span></div>
210 <div class="line"><a class="code hl_define" href="group__compiler__conntrol__gr.html#ga153a4a31b276a9758959580538720a51">__NO_RETURN</a> <span class="keywordtype">void</span> Reset_Handler(<span class="keywordtype">void</span>)</div>
211 <div class="line">{</div>
212 <div class="line"> <a class="code hl_function" href="group__Core__Register__gr.html#ga48e5853f417e17a8a65080f6a605b743">__set_PSP</a>((uint32_t)(&<a class="code hl_define" href="group__compiler__conntrol__gr.html#ga1002e751427b1189f92787d4e4eef965">__INITIAL_SP</a>));</div>
213 <div class="line"> </div>
214 <div class="line"> <a class="code hl_function" href="group__Core__Register__gr.html#ga6809a07c5cb7410e361f3fba57f72172">__set_MSPLIM</a>((uint32_t)(&<a class="code hl_define" href="group__compiler__conntrol__gr.html#ga84b0bad4aa39632d3faea46aa1e102a8">__STACK_LIMIT</a>));</div>
215 <div class="line"> <a class="code hl_function" href="group__Core__Register__gr.html#ga4348d14fc5eefbfd34ab8c51be44a81b">__set_PSPLIM</a>((uint32_t)(&<a class="code hl_define" href="group__compiler__conntrol__gr.html#ga84b0bad4aa39632d3faea46aa1e102a8">__STACK_LIMIT</a>));</div>
216 <div class="line"> </div>
217 <div class="line"><span class="preprocessor">#if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U)</span></div>
218 <div class="line"> <a class="code hl_function" href="group__stacksealing__support__trustzone__functions.html#ga87d2473a3adebb73941065366feec690">__TZ_set_STACKSEAL_S</a>((uint32_t *)(&<a class="code hl_define" href="group__stacksealing__support__trustzone__functions.html#gacc36ddac1642fe80a690364911542d79">__STACK_SEAL</a>));</div>
219 <div class="line"><span class="preprocessor">#endif</span></div>
220 <div class="line"> </div>
221 <div class="line"> <a class="code hl_function" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2">SystemInit</a>(); <span class="comment">/* CMSIS System Initialization */</span></div>
222 <div class="line"> <a class="code hl_define" href="group__compiler__conntrol__gr.html#ga72db8b026c5e100254080fefabd9fd88">__PROGRAM_START</a>(); <span class="comment">/* Enter PreMain (C library entry point) */</span></div>
223 <div class="line">}</div>
224 <div class="ttc" id="agroup__Core__Register__gr_html_ga4348d14fc5eefbfd34ab8c51be44a81b"><div class="ttname"><a href="group__Core__Register__gr.html#ga4348d14fc5eefbfd34ab8c51be44a81b">__set_PSPLIM</a></div><div class="ttdeci">void __set_PSPLIM(uint32_t ProcStackPtrLimit)</div><div class="ttdoc">Set Process Stack Pointer Limit Devices without Armv8-M Main Extensions (i.e. Cortex-M23) lack the no...</div></div>
225 <div class="ttc" id="agroup__Core__Register__gr_html_ga48e5853f417e17a8a65080f6a605b743"><div class="ttname"><a href="group__Core__Register__gr.html#ga48e5853f417e17a8a65080f6a605b743">__set_PSP</a></div><div class="ttdeci">void __set_PSP(uint32_t topOfProcStack)</div><div class="ttdoc">Set the PSP register.</div></div>
226 <div class="ttc" id="agroup__Core__Register__gr_html_ga6809a07c5cb7410e361f3fba57f72172"><div class="ttname"><a href="group__Core__Register__gr.html#ga6809a07c5cb7410e361f3fba57f72172">__set_MSPLIM</a></div><div class="ttdeci">__set_MSPLIM(uint32_t MainStackPtrLimit)</div><div class="ttdoc">Set Main Stack Pointer Limit Devices without Armv8-M Main Extensions (i.e. Cortex-M23) lack the non-s...</div></div>
227 <div class="ttc" id="agroup__compiler__conntrol__gr_html_ga153a4a31b276a9758959580538720a51"><div class="ttname"><a href="group__compiler__conntrol__gr.html#ga153a4a31b276a9758959580538720a51">__NO_RETURN</a></div><div class="ttdeci">#define __NO_RETURN</div><div class="ttdoc">Inform the compiler that a function does not return.</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:171</div></div>
228 <div class="ttc" id="agroup__compiler__conntrol__gr_html_ga72db8b026c5e100254080fefabd9fd88"><div class="ttname"><a href="group__compiler__conntrol__gr.html#ga72db8b026c5e100254080fefabd9fd88">__PROGRAM_START</a></div><div class="ttdeci">#define __PROGRAM_START</div><div class="ttdoc">Entry function into the user application or library startup.</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:483</div></div>
229 <div class="ttc" id="agroup__compiler__conntrol__gr_html_ga84b0bad4aa39632d3faea46aa1e102a8"><div class="ttname"><a href="group__compiler__conntrol__gr.html#ga84b0bad4aa39632d3faea46aa1e102a8">__STACK_LIMIT</a></div><div class="ttdeci">#define __STACK_LIMIT</div><div class="ttdoc">Compiler/linker symbol specifying the limit of the main stack (MSP).</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:518</div></div>
230 <div class="ttc" id="agroup__stacksealing__support__trustzone__functions_html_ga87d2473a3adebb73941065366feec690"><div class="ttname"><a href="group__stacksealing__support__trustzone__functions.html#ga87d2473a3adebb73941065366feec690">__TZ_set_STACKSEAL_S</a></div><div class="ttdeci">void __TZ_set_STACKSEAL_S(uint32_t *stackTop)</div><div class="ttdoc">Set stack seal at given address (secure)</div></div>
231 <div class="ttc" id="agroup__stacksealing__support__trustzone__functions_html_gacc36ddac1642fe80a690364911542d79"><div class="ttname"><a href="group__stacksealing__support__trustzone__functions.html#gacc36ddac1642fe80a690364911542d79">__STACK_SEAL</a></div><div class="ttdeci">#define __STACK_SEAL</div><div class="ttdoc">Compiler/linker symbol specifying the location of the stack seal.</div><div class="ttdef"><b>Definition:</b> Ref_Trustzone.txt:411</div></div>
232 <div class="ttc" id="agroup__system__init__gr_html_ga93f514700ccf00d08dbdcff7f1224eb2"><div class="ttname"><a href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2">SystemInit</a></div><div class="ttdeci">void SystemInit(void)</div><div class="ttdoc">Function to Initialize the system.</div></div>
233 </div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>Stack Sealing also requires the application project to use a scatter file (or a linker script) as explained in <a class="el" href="using_TrustZone_pg.html#RTOS_TrustZone_stacksealing">Stack Sealing</a> section. </dd></dl>
234 </div></div><!-- contents -->
235 </div><!-- PageDoc -->
236 </div><!-- doc-content -->
237 <!-- start footer part -->
238 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
241 <script type="text/javascript">
243 writeFooter.call(this);