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-A): Compiler Control</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&dn=expat.txt MIT */
24 $(document).ready(function() { init_search(); });
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>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
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  <span id="projectnumber"><script type="text/javascript">
46 writeHeader.call(this);
47 writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
52 <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
54 <td> <div id="MSearchBox" class="MSearchBoxInactive">
56 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
66 <!--END !PROJECT_NAME-->
71 <!-- end header part -->
72 <div id="CMSISnav" class="tabs1">
74 <script type="text/javascript">
75 writeComponentTabs.call(this);
79 <script type="text/javascript">
80 writeSubComponentTabs.call(this);
82 <!-- Generated by Doxygen 1.9.6 -->
83 <script type="text/javascript">
84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
85 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
101 $(document).ready(function(){initNavTree('group__comp__cntrl__gr.html',''); initResizable(); });
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)">
112 <!-- iframe showing the search results (closed by default) -->
113 <div id="MSearchResultsWindow">
114 <div id="MSearchResults">
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>
127 <div class="summary">
128 <a href="#define-members">Macros</a> </div>
129 <div class="headertitle"><div class="title">Compiler Control</div></div>
131 <div class="contents">
133 <p>Compiler agnostic #define symbols for generic C/C++ source code.
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
137 Macros</h2></td></tr>
138 <tr class="memitem:gaee91bdfb2b6986731af09835bc9c6e74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaee91bdfb2b6986731af09835bc9c6e74">__ARM_ARCH_7A__</a></td></tr>
139 <tr class="memdesc:gaee91bdfb2b6986731af09835bc9c6e74"><td class="mdescLeft"> </td><td class="mdescRight">Set to 1 when generating code for Armv7-A (Cortex-A7) <br /></td></tr>
140 <tr class="separator:gaee91bdfb2b6986731af09835bc9c6e74"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:gab904513442afdf77d4f8c74f23cbb040"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a></td></tr>
142 <tr class="memdesc:gab904513442afdf77d4f8c74f23cbb040"><td class="mdescLeft"> </td><td class="mdescRight">Define a static function that should be always inlined by the compiler. <br /></td></tr>
143 <tr class="separator:gab904513442afdf77d4f8c74f23cbb040"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:ga4dbb70fab85207c27b581ecb6532b314"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a></td></tr>
145 <tr class="memdesc:ga4dbb70fab85207c27b581ecb6532b314"><td class="mdescLeft"> </td><td class="mdescRight">Request smallest possible alignment for a structure. <br /></td></tr>
146 <tr class="separator:ga4dbb70fab85207c27b581ecb6532b314"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:gabe8693a7200e573101551d49a1772fb9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabe8693a7200e573101551d49a1772fb9">__UNALIGNED_UINT16_READ</a></td></tr>
148 <tr class="memdesc:gabe8693a7200e573101551d49a1772fb9"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned read of a uint16_t variable. <br /></td></tr>
149 <tr class="separator:gabe8693a7200e573101551d49a1772fb9"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:gadb9cd73446f7e11e92383cd327a23407"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gadb9cd73446f7e11e92383cd327a23407">__UNALIGNED_UINT16_WRITE</a></td></tr>
151 <tr class="memdesc:gadb9cd73446f7e11e92383cd327a23407"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned write of a uint16_t variable. <br /></td></tr>
152 <tr class="separator:gadb9cd73446f7e11e92383cd327a23407"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:ga254322c344d954c9f829719a50a88e87"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga254322c344d954c9f829719a50a88e87">__UNALIGNED_UINT32_READ</a></td></tr>
154 <tr class="memdesc:ga254322c344d954c9f829719a50a88e87"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned read of a uint32_t variable. <br /></td></tr>
155 <tr class="separator:ga254322c344d954c9f829719a50a88e87"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:gabb2180285c417aa9120a360c51f64b4b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabb2180285c417aa9120a360c51f64b4b">__UNALIGNED_UINT32_WRITE</a></td></tr>
157 <tr class="memdesc:gabb2180285c417aa9120a360c51f64b4b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned write of a uint32_t variable. <br /></td></tr>
158 <tr class="separator:gabb2180285c417aa9120a360c51f64b4b"><td class="memSeparator" colspan="2"> </td></tr>
160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
161 <p>Compiler agnostic #define symbols for generic C/C++ source code. </p>
162 <p>The CMSIS-Core provides the header file <b>cmsis_compiler.h</b> with consistent #define symbols to generate C or C++ source files that should be compiler agnostic. Each CMSIS compliant compiler should support the functionality described in this section. </p>
163 <h2 class="groupheader">Macro Definition Documentation</h2>
164 <a id="gaee91bdfb2b6986731af09835bc9c6e74" name="gaee91bdfb2b6986731af09835bc9c6e74"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#gaee91bdfb2b6986731af09835bc9c6e74">◆ </a></span>__ARM_ARCH_7A__</h2>
167 <div class="memitem">
168 <div class="memproto">
169 <table class="memname">
171 <td class="memname">#define __ARM_ARCH_7A__</td>
174 </div><div class="memdoc">
176 <p>Set to 1 when generating code for Armv7-A (Cortex-A7) </p>
177 <p>The <b>#define</b> <b>ARM_ARCH_7A</b> is set to 1 when generating code for the Armv7-A architecture. This architecture is for example used by the Cortex-A7 processor. </p>
181 <a id="ga4dbb70fab85207c27b581ecb6532b314" name="ga4dbb70fab85207c27b581ecb6532b314"></a>
182 <h2 class="memtitle"><span class="permalink"><a href="#ga4dbb70fab85207c27b581ecb6532b314">◆ </a></span>__PACKED_STRUCT</h2>
184 <div class="memitem">
185 <div class="memproto">
186 <table class="memname">
188 <td class="memname">#define __PACKED_STRUCT</td>
191 </div><div class="memdoc">
193 <p>Request smallest possible alignment for a structure. </p>
194 <p>Specifies that a structure must have the smallest possible alignment.</p>
195 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a> foo {</div>
196 <div class="line"> uint8_t u8;</div>
197 <div class="line"> uint32_t u32;</div>
198 <div class="line"> uint16_t u16;</div>
199 <div class="line">};</div>
200 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga4dbb70fab85207c27b581ecb6532b314"><div class="ttname"><a href="group__comp__cntrl__gr.html#ga4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a></div><div class="ttdeci">#define __PACKED_STRUCT</div><div class="ttdoc">Request smallest possible alignment for a structure.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:200</div></div>
201 </div><!-- fragment -->
204 <a id="gab904513442afdf77d4f8c74f23cbb040" name="gab904513442afdf77d4f8c74f23cbb040"></a>
205 <h2 class="memtitle"><span class="permalink"><a href="#gab904513442afdf77d4f8c74f23cbb040">◆ </a></span>__STATIC_FORCEINLINE</h2>
207 <div class="memitem">
208 <div class="memproto">
209 <table class="memname">
211 <td class="memname">#define __STATIC_FORCEINLINE</td>
214 </div><div class="memdoc">
216 <p>Define a static function that should be always inlined by the compiler. </p>
217 <p>Defines a static function that should be always inlined by the compiler.</p>
218 <dl class="section note"><dt>Note</dt><dd>For compilers that do not allow to force function inlining, the macro maps to __STATIC_INLINE.</dd></dl>
219 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">\\ Get Interrupt Vector</div>
220 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t NVIC_GetVector(<a class="code hl_enumeration" href="group__irq__ctrl__gr.html#ga7e1129cd8a196f4284d41db3e82ad5c8">IRQn_Type</a> IRQn)</div>
221 <div class="line">{</div>
222 <div class="line"> uint32_t *vectors = (uint32_t *) ((uintptr_t) SCB->VTOR);</div>
223 <div class="line"> <span class="keywordflow">return</span> vectors[(int32_t)IRQn + NVIC_USER_IRQ_OFFSET];</div>
224 <div class="line">}</div>
225 <div class="ttc" id="agroup__comp__cntrl__gr_html_gab904513442afdf77d4f8c74f23cbb040"><div class="ttname"><a href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a></div><div class="ttdeci">#define __STATIC_FORCEINLINE</div><div class="ttdoc">Define a static function that should be always inlined by the compiler.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:103</div></div>
226 <div class="ttc" id="agroup__irq__ctrl__gr_html_ga7e1129cd8a196f4284d41db3e82ad5c8"><div class="ttname"><a href="group__irq__ctrl__gr.html#ga7e1129cd8a196f4284d41db3e82ad5c8">IRQn_Type</a></div><div class="ttdeci">IRQn_Type</div><div class="ttdoc">Definition of IRQn numbers.</div><div class="ttdef"><b>Definition:</b> ref_irq_ctrl.txt:79</div></div>
227 </div><!-- fragment -->
230 <a id="gabe8693a7200e573101551d49a1772fb9" name="gabe8693a7200e573101551d49a1772fb9"></a>
231 <h2 class="memtitle"><span class="permalink"><a href="#gabe8693a7200e573101551d49a1772fb9">◆ </a></span>__UNALIGNED_UINT16_READ</h2>
233 <div class="memitem">
234 <div class="memproto">
235 <table class="memname">
237 <td class="memname">#define __UNALIGNED_UINT16_READ</td>
240 </div><div class="memdoc">
242 <p>Pointer for unaligned read of a uint16_t variable. </p>
243 <p>Defines a pointer to a uint16_t from an address that does not need to be aligned. This can then be used in read operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.</p>
244 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16;</div>
245 <div class="line"> </div>
246 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
247 <div class="line"> val16 = <a class="code hl_define" href="group__comp__cntrl__gr.html#gabe8693a7200e573101551d49a1772fb9">__UNALIGNED_UINT16_READ</a>(ptr);</div>
248 <div class="line">}</div>
249 <div class="ttc" id="agroup__comp__cntrl__gr_html_gabe8693a7200e573101551d49a1772fb9"><div class="ttname"><a href="group__comp__cntrl__gr.html#gabe8693a7200e573101551d49a1772fb9">__UNALIGNED_UINT16_READ</a></div><div class="ttdeci">#define __UNALIGNED_UINT16_READ</div><div class="ttdoc">Pointer for unaligned read of a uint16_t variable.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:221</div></div>
250 </div><!-- fragment -->
253 <a id="gadb9cd73446f7e11e92383cd327a23407" name="gadb9cd73446f7e11e92383cd327a23407"></a>
254 <h2 class="memtitle"><span class="permalink"><a href="#gadb9cd73446f7e11e92383cd327a23407">◆ </a></span>__UNALIGNED_UINT16_WRITE</h2>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
260 <td class="memname">#define __UNALIGNED_UINT16_WRITE</td>
263 </div><div class="memdoc">
265 <p>Pointer for unaligned write of a uint16_t variable. </p>
266 <p>Defines a pointer to a uint16_t from an address that does not need to be aligned. This can then be used in write operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.</p>
267 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16 = 0U;</div>
268 <div class="line"> </div>
269 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
270 <div class="line"> <a class="code hl_define" href="group__comp__cntrl__gr.html#gadb9cd73446f7e11e92383cd327a23407">__UNALIGNED_UINT16_WRITE</a>(ptr, val16);</div>
271 <div class="line">}</div>
272 <div class="ttc" id="agroup__comp__cntrl__gr_html_gadb9cd73446f7e11e92383cd327a23407"><div class="ttname"><a href="group__comp__cntrl__gr.html#gadb9cd73446f7e11e92383cd327a23407">__UNALIGNED_UINT16_WRITE</a></div><div class="ttdeci">#define __UNALIGNED_UINT16_WRITE</div><div class="ttdoc">Pointer for unaligned write of a uint16_t variable.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:242</div></div>
273 </div><!-- fragment -->
276 <a id="ga254322c344d954c9f829719a50a88e87" name="ga254322c344d954c9f829719a50a88e87"></a>
277 <h2 class="memtitle"><span class="permalink"><a href="#ga254322c344d954c9f829719a50a88e87">◆ </a></span>__UNALIGNED_UINT32_READ</h2>
279 <div class="memitem">
280 <div class="memproto">
281 <table class="memname">
283 <td class="memname">#define __UNALIGNED_UINT32_READ</td>
286 </div><div class="memdoc">
288 <p>Pointer for unaligned read of a uint32_t variable. </p>
289 <p>Defines a pointer to a uint32_t from an address that does not need to be aligned. This can then be used in read operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.</p>
290 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32;</div>
291 <div class="line"> </div>
292 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
293 <div class="line"> val32 = <a class="code hl_define" href="group__comp__cntrl__gr.html#ga254322c344d954c9f829719a50a88e87">__UNALIGNED_UINT32_READ</a>(ptr);</div>
294 <div class="line">}</div>
295 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga254322c344d954c9f829719a50a88e87"><div class="ttname"><a href="group__comp__cntrl__gr.html#ga254322c344d954c9f829719a50a88e87">__UNALIGNED_UINT32_READ</a></div><div class="ttdeci">#define __UNALIGNED_UINT32_READ</div><div class="ttdoc">Pointer for unaligned read of a uint32_t variable.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:263</div></div>
296 </div><!-- fragment -->
299 <a id="gabb2180285c417aa9120a360c51f64b4b" name="gabb2180285c417aa9120a360c51f64b4b"></a>
300 <h2 class="memtitle"><span class="permalink"><a href="#gabb2180285c417aa9120a360c51f64b4b">◆ </a></span>__UNALIGNED_UINT32_WRITE</h2>
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
306 <td class="memname">#define __UNALIGNED_UINT32_WRITE</td>
309 </div><div class="memdoc">
311 <p>Pointer for unaligned write of a uint32_t variable. </p>
312 <p>Defines a pointer to a uint32_t from an address that does not need to be aligned. This can then be used in write operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.</p>
313 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32 = 0U;</div>
314 <div class="line"> </div>
315 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
316 <div class="line"> <a class="code hl_define" href="group__comp__cntrl__gr.html#gabb2180285c417aa9120a360c51f64b4b">__UNALIGNED_UINT32_WRITE</a>(ptr, val32);</div>
317 <div class="line">}</div>
318 <div class="ttc" id="agroup__comp__cntrl__gr_html_gabb2180285c417aa9120a360c51f64b4b"><div class="ttname"><a href="group__comp__cntrl__gr.html#gabb2180285c417aa9120a360c51f64b4b">__UNALIGNED_UINT32_WRITE</a></div><div class="ttdeci">#define __UNALIGNED_UINT32_WRITE</div><div class="ttdoc">Pointer for unaligned write of a uint32_t variable.</div><div class="ttdef"><b>Definition:</b> ref_compiler_ctrl.txt:284</div></div>
319 </div><!-- fragment -->
322 </div><!-- contents -->
323 </div><!-- doc-content -->
324 <!-- start footer part -->
325 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
328 <script type="text/javascript">
330 writeFooter.call(this);