]> begriffs open source - cmsis/blob - main/Core/linker_sct_pg.html
Update documentation for branch main
[cmsis] / main / Core / linker_sct_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): Scatter-Loading description file &lt;device&gt;_ac6.sct</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-M)
44    &#160;<span id="projectnumber"><script type="text/javascript">
45      <!--
46      writeHeader.call(this);
47      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-M)");
48      //-->
49     </script>
50    </span>
51    </div>
52    <div id="projectbrief">CMSIS-Core support for Cortex-M 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('linker_sct_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">Scatter-Loading description file &lt;device&gt;_ac6.sct </div></div>
128 </div><!--header-->
129 <div class="contents">
130 <div class="textblock"><p><a class="anchor" id="md_src_core_linker_sct"></a> A scatter file for linking is required when using a <a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a>.</p>
131 <p>The <a class="el" href="linker_sct_pg.html">Scatter-Loading description file &lt;device&gt;_ac6.sct</a> contains regions for:</p>
132 <ul>
133 <li>Code (read-only data, execute-only data)</li>
134 <li>RAM (read/write data, zero-initialized data)</li>
135 <li>Stack</li>
136 <li>Heap</li>
137 <li>Stack seal (for Armv8-M/v8.1-M)</li>
138 <li>CMSE veneer (for Armv8-M/v8.1-M)</li>
139 </ul>
140 <p>Within the scatter file, the user needs to specify a set of macros. The scatter file is passed through the C preprocessor which uses these macros to calculate the start address and the size of the different regions.</p>
141 <div class="fragment"><div class="line">/*--------------------- Flash Configuration ----------------------------------</div>
142 <div class="line">; &lt;h&gt; Flash Configuration</div>
143 <div class="line">;   &lt;o0&gt; Flash Base Address &lt;0x0-0xFFFFFFFF:8&gt;</div>
144 <div class="line">;   &lt;o1&gt; Flash Size (in Bytes) &lt;0x0-0xFFFFFFFF:8&gt;</div>
145 <div class="line">; &lt;/h&gt;</div>
146 <div class="line"> *----------------------------------------------------------------------------*/</div>
147 <div class="line">#define __ROM_BASE      0x00000000</div>
148 <div class="line">#define __ROM_SIZE      0x00080000</div>
149 <div class="line"> </div>
150 <div class="line">/*--------------------- Embedded RAM Configuration ---------------------------</div>
151 <div class="line">; &lt;h&gt; RAM Configuration</div>
152 <div class="line">;   &lt;o0&gt; RAM Base Address    &lt;0x0-0xFFFFFFFF:8&gt;</div>
153 <div class="line">;   &lt;o1&gt; RAM Size (in Bytes) &lt;0x0-0xFFFFFFFF:8&gt;</div>
154 <div class="line">; &lt;/h&gt;</div>
155 <div class="line"> *----------------------------------------------------------------------------*/</div>
156 <div class="line">#define __RAM_BASE      0x20000000</div>
157 <div class="line">#define __RAM_SIZE      0x00040000</div>
158 <div class="line"> </div>
159 <div class="line">/*--------------------- Stack / Heap Configuration ---------------------------</div>
160 <div class="line">; &lt;h&gt; Stack / Heap Configuration</div>
161 <div class="line">;   &lt;o0&gt; Stack Size (in Bytes) &lt;0x0-0xFFFFFFFF:8&gt;</div>
162 <div class="line">;   &lt;o1&gt; Heap Size (in Bytes) &lt;0x0-0xFFFFFFFF:8&gt;</div>
163 <div class="line">; &lt;/h&gt;</div>
164 <div class="line"> *----------------------------------------------------------------------------*/</div>
165 <div class="line">#define __STACK_SIZE    0x00000200</div>
166 <div class="line">#define __HEAP_SIZE     0x00000C00</div>
167 <div class="line"> </div>
168 <div class="line">/*--------------------- CMSE Veneer Configuration ---------------------------</div>
169 <div class="line">; &lt;h&gt; CMSE Veneer Configuration</div>
170 <div class="line">;   &lt;o0&gt;  CMSE Veneer Size (in Bytes) &lt;0x0-0xFFFFFFFF:32&gt;</div>
171 <div class="line">; &lt;/h&gt;</div>
172 <div class="line"> *----------------------------------------------------------------------------*/</div>
173 <div class="line">#define __CMSEVENEER_SIZE    0x200</div>
174 </div><!-- fragment --><blockquote class="doxtable">
175 <p>&zwj;<b>Note</b></p><ul>
176 <li>The stack is placed at the end of the available RAM and is growing downwards whereas the Heap is placed after the application data and growing upwards. </li>
177 </ul>
178 </blockquote>
179 <h1><a class="anchor" id="linker_sct_preproc_sec"></a>
180 Preprocessor command</h1>
181 <p>The scatter file uses following preprocessor command for Arm Compiler v6</p>
182 <div class="fragment"><div class="line">#! armclang -E --target=arm-arm-none-eabi -mcpu=&amp;lt;mcpu&amp;gt; -xc</div>
183 </div><!-- fragment --> </div></div><!-- contents -->
184 </div><!-- PageDoc -->
185 </div><!-- doc-content -->
186 <!-- start footer part -->
187 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
188   <ul>
189     <li class="footer">
190       <script type="text/javascript">
191         <!--
192         writeFooter.call(this);
193         //-->
194       </script> 
195     </li>
196   </ul>
197 </div>
198 </body>
199 </html>