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:ga1378040bcf22428955c6e3ce9c2053cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a>   __asm</td></tr>
142 <tr class="memdesc:ga1378040bcf22428955c6e3ce9c2053cd"><td class="mdescLeft"> </td><td class="mdescRight">Pass information from the compiler to the assembler. <br /></td></tr>
143 <tr class="separator:ga1378040bcf22428955c6e3ce9c2053cd"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gade2d8d7118f8ff49547f60aa0c3382bb">__INLINE</a>   inline</td></tr>
145 <tr class="memdesc:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="mdescLeft"> </td><td class="mdescRight">Recommend that function should be inlined by the compiler. <br /></td></tr>
146 <tr class="separator:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a>   static inline</td></tr>
148 <tr class="memdesc:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="mdescLeft"> </td><td class="mdescRight">Define a static function should be inlined by the compiler. <br /></td></tr>
149 <tr class="separator:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="memSeparator" colspan="2"> </td></tr>
150 <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>
151 <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>
152 <tr class="separator:gab904513442afdf77d4f8c74f23cbb040"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:ga153a4a31b276a9758959580538720a51"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga153a4a31b276a9758959580538720a51">__NO_RETURN</a>   __attribute__((__noreturn__))</td></tr>
154 <tr class="memdesc:ga153a4a31b276a9758959580538720a51"><td class="mdescLeft"> </td><td class="mdescRight">Inform the compiler that a function does not return. <br /></td></tr>
155 <tr class="separator:ga153a4a31b276a9758959580538720a51"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a>   __attribute__((used))</td></tr>
157 <tr class="memdesc:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="mdescLeft"> </td><td class="mdescRight">Inform that a variable shall be retained in executable image. <br /></td></tr>
158 <tr class="separator:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:gac607bf387b29162be6a9b77fc7999539"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gac607bf387b29162be6a9b77fc7999539">__WEAK</a>   __attribute__((weak))</td></tr>
160 <tr class="memdesc:gac607bf387b29162be6a9b77fc7999539"><td class="mdescLeft"> </td><td class="mdescRight">Export a function or variable weakly to allow overwrites. <br /></td></tr>
161 <tr class="separator:gac607bf387b29162be6a9b77fc7999539"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">__ALIGNED</a>(x)   __attribute__((aligned(x)))</td></tr>
163 <tr class="memdesc:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="mdescLeft"> </td><td class="mdescRight">Minimum alignment for a variable. <br /></td></tr>
164 <tr class="separator:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="memSeparator" colspan="2"> </td></tr>
165 <tr class="memitem:gabe8996d3d985ee1529475443cc635bf1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabe8996d3d985ee1529475443cc635bf1">__PACKED</a>   __attribute__((packed, aligned(1)))</td></tr>
166 <tr class="memdesc:gabe8996d3d985ee1529475443cc635bf1"><td class="mdescLeft"> </td><td class="mdescRight">Request smallest possible alignment. <br /></td></tr>
167 <tr class="separator:gabe8996d3d985ee1529475443cc635bf1"><td class="memSeparator" colspan="2"> </td></tr>
168 <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>
169 <tr class="memdesc:ga4dbb70fab85207c27b581ecb6532b314"><td class="mdescLeft"> </td><td class="mdescRight">Request smallest possible alignment for a structure. <br /></td></tr>
170 <tr class="separator:ga4dbb70fab85207c27b581ecb6532b314"><td class="memSeparator" colspan="2"> </td></tr>
171 <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>
172 <tr class="memdesc:gabe8693a7200e573101551d49a1772fb9"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned read of a uint16_t variable. <br /></td></tr>
173 <tr class="separator:gabe8693a7200e573101551d49a1772fb9"><td class="memSeparator" colspan="2"> </td></tr>
174 <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>
175 <tr class="memdesc:gadb9cd73446f7e11e92383cd327a23407"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned write of a uint16_t variable. <br /></td></tr>
176 <tr class="separator:gadb9cd73446f7e11e92383cd327a23407"><td class="memSeparator" colspan="2"> </td></tr>
177 <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>
178 <tr class="memdesc:ga254322c344d954c9f829719a50a88e87"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned read of a uint32_t variable. <br /></td></tr>
179 <tr class="separator:ga254322c344d954c9f829719a50a88e87"><td class="memSeparator" colspan="2"> </td></tr>
180 <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>
181 <tr class="memdesc:gabb2180285c417aa9120a360c51f64b4b"><td class="mdescLeft"> </td><td class="mdescRight">Pointer for unaligned write of a uint32_t variable. <br /></td></tr>
182 <tr class="separator:gabb2180285c417aa9120a360c51f64b4b"><td class="memSeparator" colspan="2"> </td></tr>
184 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
185 <p>Compiler agnostic #define symbols for generic C/C++ source code. </p>
186 <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>
187 <h2 class="groupheader">Macro Definition Documentation</h2>
188 <a id="gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55" name="gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">◆ </a></span>__ALIGNED</h2>
191 <div class="memitem">
192 <div class="memproto">
193 <table class="memname">
195 <td class="memname">#define __ALIGNED</td>
197 <td class="paramtype"> </td>
198 <td class="paramname">x</td><td>)</td>
199 <td>   __attribute__((aligned(x)))</td>
202 </div><div class="memdoc">
204 <p>Minimum alignment for a variable. </p>
205 <p>Specifies a minimum alignment for a variable or structure field, measured in bytes.</p>
206 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t stack_space[0x100] <a class="code hl_define" href="group__comp__cntrl__gr.html#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">__ALIGNED</a>(8); <span class="comment">// 8-byte alignment required</span></div>
207 <div class="ttc" id="agroup__comp__cntrl__gr_html_gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><div class="ttname"><a href="group__comp__cntrl__gr.html#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">__ALIGNED</a></div><div class="ttdeci">#define __ALIGNED(x)</div><div class="ttdoc">Minimum alignment for a variable.</div></div>
208 </div><!-- fragment -->
211 <a id="gaee91bdfb2b6986731af09835bc9c6e74" name="gaee91bdfb2b6986731af09835bc9c6e74"></a>
212 <h2 class="memtitle"><span class="permalink"><a href="#gaee91bdfb2b6986731af09835bc9c6e74">◆ </a></span>__ARM_ARCH_7A__</h2>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="memname">
218 <td class="memname">#define __ARM_ARCH_7A__</td>
221 </div><div class="memdoc">
223 <p>Set to 1 when generating code for Armv7-A (Cortex-A7) </p>
224 <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>
228 <a id="ga1378040bcf22428955c6e3ce9c2053cd" name="ga1378040bcf22428955c6e3ce9c2053cd"></a>
229 <h2 class="memtitle"><span class="permalink"><a href="#ga1378040bcf22428955c6e3ce9c2053cd">◆ </a></span>__ASM</h2>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="memname">
235 <td class="memname">#define __ASM   __asm</td>
238 </div><div class="memdoc">
240 <p>Pass information from the compiler to the assembler. </p>
241 <p>The <b>__ASM</b> keyword can declare or define an embedded assembly function or incorporate inline assembly into a function (shown in the code example below).</p>
242 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// Reverse bit order of value</span></div>
243 <div class="line"> </div>
244 <div class="line">__attribute__( ( always_inline ) ) <a class="code hl_define" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t <a class="code hl_define" href="cmsis__armclang__a_8h.html#ab83768933a612816fad669db5488366f">__RBIT</a>(uint32_t value)</div>
245 <div class="line">{</div>
246 <div class="line"> uint32_t result;</div>
247 <div class="line"> </div>
248 <div class="line"> <a class="code hl_define" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> <span class="keyword">volatile</span> (<span class="stringliteral">"rbit %0, %1"</span> : <span class="stringliteral">"=r"</span> (result) : <span class="stringliteral">"r"</span> (value) );</div>
249 <div class="line"> <span class="keywordflow">return</span>(result);</div>
250 <div class="line">}</div>
251 <div class="ttc" id="acmsis__armclang__a_8h_html_ab83768933a612816fad669db5488366f"><div class="ttname"><a href="cmsis__armclang__a_8h.html#ab83768933a612816fad669db5488366f">__RBIT</a></div><div class="ttdeci">#define __RBIT</div><div class="ttdoc">Reverse bit order of value.</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:214</div></div>
252 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga1378040bcf22428955c6e3ce9c2053cd"><div class="ttname"><a href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a></div><div class="ttdeci">#define __ASM</div><div class="ttdoc">Pass information from the compiler to the assembler.</div></div>
253 <div class="ttc" id="agroup__comp__cntrl__gr_html_gaba87361bfad2ae52cfe2f40c1a1dbf9c"><div class="ttname"><a href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a></div><div class="ttdeci">#define __STATIC_INLINE</div><div class="ttdoc">Define a static function should be inlined by the compiler.</div></div>
254 </div><!-- fragment -->
257 <a id="gade2d8d7118f8ff49547f60aa0c3382bb" name="gade2d8d7118f8ff49547f60aa0c3382bb"></a>
258 <h2 class="memtitle"><span class="permalink"><a href="#gade2d8d7118f8ff49547f60aa0c3382bb">◆ </a></span>__INLINE</h2>
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
264 <td class="memname">#define __INLINE   inline</td>
267 </div><div class="memdoc">
269 <p>Recommend that function should be inlined by the compiler. </p>
270 <p>Inline functions offer a trade-off between code size and performance. By default, the compiler decides during optimization whether to inline code or not. The <b>__INLINE</b> attribute gives the compiler an hint to inline this function. Still, the compiler may decide not to inline the function. As the function is global an callable function is also generated.</p>
271 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">const</span> uint32_t led_mask[] = {1U << 4, 1U << 5, 1U << 6, 1U << 7};</div>
272 <div class="line"> </div>
273 <div class="line"><span class="comment">//------------------------------------------------------------------------------</span></div>
274 <div class="line"><span class="comment">// Switch on LEDs</span></div>
275 <div class="line"><span class="comment">//------------------------------------------------------------------------------</span></div>
276 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#gade2d8d7118f8ff49547f60aa0c3382bb">__INLINE</a> <span class="keyword">static</span> <span class="keywordtype">void</span> LED_On (uint32_t led) {</div>
277 <div class="line"> </div>
278 <div class="line"> PTD->PCOR = led_mask[led];</div>
279 <div class="line">}</div>
280 <div class="ttc" id="agroup__comp__cntrl__gr_html_gade2d8d7118f8ff49547f60aa0c3382bb"><div class="ttname"><a href="group__comp__cntrl__gr.html#gade2d8d7118f8ff49547f60aa0c3382bb">__INLINE</a></div><div class="ttdeci">#define __INLINE</div><div class="ttdoc">Recommend that function should be inlined by the compiler.</div></div>
281 </div><!-- fragment -->
284 <a id="ga153a4a31b276a9758959580538720a51" name="ga153a4a31b276a9758959580538720a51"></a>
285 <h2 class="memtitle"><span class="permalink"><a href="#ga153a4a31b276a9758959580538720a51">◆ </a></span>__NO_RETURN</h2>
287 <div class="memitem">
288 <div class="memproto">
289 <table class="memname">
291 <td class="memname">#define __NO_RETURN   __attribute__((__noreturn__))</td>
294 </div><div class="memdoc">
296 <p>Inform the compiler that a function does not return. </p>
297 <p>Informs the compiler that the function does not return. The compiler can then perform optimizations by removing code that is never reached.</p>
298 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// OS idle demon (running when no other thread is ready to run).</span></div>
299 <div class="line"> </div>
300 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga153a4a31b276a9758959580538720a51">__NO_RETURN</a> <span class="keywordtype">void</span> os_idle_demon (<span class="keywordtype">void</span>);</div>
301 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga153a4a31b276a9758959580538720a51"><div class="ttname"><a href="group__comp__cntrl__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>
302 </div><!-- fragment -->
305 <a id="gabe8996d3d985ee1529475443cc635bf1" name="gabe8996d3d985ee1529475443cc635bf1"></a>
306 <h2 class="memtitle"><span class="permalink"><a href="#gabe8996d3d985ee1529475443cc635bf1">◆ </a></span>__PACKED</h2>
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
312 <td class="memname">#define __PACKED   __attribute__((packed, aligned(1)))</td>
315 </div><div class="memdoc">
317 <p>Request smallest possible alignment. </p>
318 <p>Specifies that a type must have the smallest possible alignment.</p>
319 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">struct </span>foo {</div>
320 <div class="line"> uint8_t u8;</div>
321 <div class="line"> uint32_t u32[2] <a class="code hl_define" href="group__comp__cntrl__gr.html#gabe8996d3d985ee1529475443cc635bf1">__PACKED</a>;</div>
322 <div class="line">};</div>
323 <div class="ttc" id="agroup__comp__cntrl__gr_html_gabe8996d3d985ee1529475443cc635bf1"><div class="ttname"><a href="group__comp__cntrl__gr.html#gabe8996d3d985ee1529475443cc635bf1">__PACKED</a></div><div class="ttdeci">#define __PACKED</div><div class="ttdoc">Request smallest possible alignment.</div></div>
324 </div><!-- fragment -->
327 <a id="ga4dbb70fab85207c27b581ecb6532b314" name="ga4dbb70fab85207c27b581ecb6532b314"></a>
328 <h2 class="memtitle"><span class="permalink"><a href="#ga4dbb70fab85207c27b581ecb6532b314">◆ </a></span>__PACKED_STRUCT</h2>
330 <div class="memitem">
331 <div class="memproto">
332 <table class="memname">
334 <td class="memname">#define __PACKED_STRUCT</td>
337 </div><div class="memdoc">
339 <p>Request smallest possible alignment for a structure. </p>
340 <p>Specifies that a structure must have the smallest possible alignment.</p>
341 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><a class="code hl_define" href="cmsis__armclang__a_8h.html#a4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a> foo {</div>
342 <div class="line"> uint8_t u8;</div>
343 <div class="line"> uint32_t u32;</div>
344 <div class="line"> uint16_t u16;</div>
345 <div class="line">};</div>
346 <div class="ttc" id="acmsis__armclang__a_8h_html_a4dbb70fab85207c27b581ecb6532b314"><div class="ttname"><a href="cmsis__armclang__a_8h.html#a4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a></div><div class="ttdeci">#define __PACKED_STRUCT</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:54</div></div>
347 </div><!-- fragment -->
350 <a id="gab904513442afdf77d4f8c74f23cbb040" name="gab904513442afdf77d4f8c74f23cbb040"></a>
351 <h2 class="memtitle"><span class="permalink"><a href="#gab904513442afdf77d4f8c74f23cbb040">◆ </a></span>__STATIC_FORCEINLINE</h2>
353 <div class="memitem">
354 <div class="memproto">
355 <table class="memname">
357 <td class="memname">#define __STATIC_FORCEINLINE</td>
360 </div><div class="memdoc">
362 <p>Define a static function that should be always inlined by the compiler. </p>
363 <p>Defines a static function that should be always inlined by the compiler.</p>
364 <dl class="section note"><dt>Note</dt><dd>For compilers that do not allow to force function inlining, the macro maps to <a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a>.</dd></dl>
365 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">\\ Get Interrupt Vector</div>
366 <div class="line"><a class="code hl_define" href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t NVIC_GetVector(<a class="code hl_enumeration" href="group__irq__ctrl__gr.html#ga7e1129cd8a196f4284d41db3e82ad5c8">IRQn_Type</a> IRQn)</div>
367 <div class="line">{</div>
368 <div class="line"> uint32_t *vectors = (uint32_t *) ((uintptr_t) SCB->VTOR);</div>
369 <div class="line"> <span class="keywordflow">return</span> vectors[(int32_t)IRQn + NVIC_USER_IRQ_OFFSET];</div>
370 <div class="line">}</div>
371 <div class="ttc" id="acmsis__armclang__a_8h_html_ab904513442afdf77d4f8c74f23cbb040"><div class="ttname"><a href="cmsis__armclang__a_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a></div><div class="ttdeci">#define __STATIC_FORCEINLINE</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:39</div></div>
372 <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>
373 </div><!-- fragment -->
376 <a id="gaba87361bfad2ae52cfe2f40c1a1dbf9c" name="gaba87361bfad2ae52cfe2f40c1a1dbf9c"></a>
377 <h2 class="memtitle"><span class="permalink"><a href="#gaba87361bfad2ae52cfe2f40c1a1dbf9c">◆ </a></span>__STATIC_INLINE</h2>
379 <div class="memitem">
380 <div class="memproto">
381 <table class="memname">
383 <td class="memname">#define __STATIC_INLINE   static inline</td>
386 </div><div class="memdoc">
388 <p>Define a static function should be inlined by the compiler. </p>
389 <p>Defines a static function that may be inlined by the compiler. If the compiler generates inline code for all calls to this functions, no additional function implementation is generated which may further optimize space.</p>
390 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t <a class="code hl_function" href="group__GIC__functions.html#ga397048004654f792649742f95bf8ae67">GIC_GetPriority</a>(<a class="code hl_enumeration" href="group__irq__ctrl__gr.html#ga7e1129cd8a196f4284d41db3e82ad5c8">IRQn_Type</a> IRQn)</div>
391 <div class="line">{</div>
392 <div class="line"> <span class="keywordflow">return</span>((uint32_t)<a class="code hl_define" href="group__GIC__functions.html#ga82e193c0016a9377274756b2673464a6">GICDistributor</a>->D_IPRIORITYR[((uint32_t)(int32_t)IRQn)]);</div>
393 <div class="line">}</div>
394 <div class="ttc" id="agroup__GIC__functions_html_ga397048004654f792649742f95bf8ae67"><div class="ttname"><a href="group__GIC__functions.html#ga397048004654f792649742f95bf8ae67">GIC_GetPriority</a></div><div class="ttdeci">__STATIC_INLINE uint32_t GIC_GetPriority(IRQn_Type IRQn)</div><div class="ttdoc">Read the current interrupt priority from GIC's IPRIORITYR register.</div><div class="ttdef"><b>Definition:</b> core_ca.h:1664</div></div>
395 <div class="ttc" id="agroup__GIC__functions_html_ga82e193c0016a9377274756b2673464a6"><div class="ttname"><a href="group__GIC__functions.html#ga82e193c0016a9377274756b2673464a6">GICDistributor</a></div><div class="ttdeci">#define GICDistributor</div><div class="ttdoc">GIC Distributor register set access pointer.</div></div>
396 </div><!-- fragment -->
399 <a id="gabe8693a7200e573101551d49a1772fb9" name="gabe8693a7200e573101551d49a1772fb9"></a>
400 <h2 class="memtitle"><span class="permalink"><a href="#gabe8693a7200e573101551d49a1772fb9">◆ </a></span>__UNALIGNED_UINT16_READ</h2>
402 <div class="memitem">
403 <div class="memproto">
404 <table class="memname">
406 <td class="memname">#define __UNALIGNED_UINT16_READ</td>
409 </div><div class="memdoc">
411 <p>Pointer for unaligned read of a uint16_t variable. </p>
412 <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>
413 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16;</div>
414 <div class="line"> </div>
415 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
416 <div class="line"> val16 = <a class="code hl_define" href="cmsis__armclang__a_8h.html#ab71b66e5ce403158d3dee62a59f9175f">__UNALIGNED_UINT16_READ</a>(ptr);</div>
417 <div class="line">}</div>
418 <div class="ttc" id="acmsis__armclang__a_8h_html_ab71b66e5ce403158d3dee62a59f9175f"><div class="ttname"><a href="cmsis__armclang__a_8h.html#ab71b66e5ce403158d3dee62a59f9175f">__UNALIGNED_UINT16_READ</a></div><div class="ttdeci">#define __UNALIGNED_UINT16_READ(addr)</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:71</div></div>
419 </div><!-- fragment -->
422 <a id="gadb9cd73446f7e11e92383cd327a23407" name="gadb9cd73446f7e11e92383cd327a23407"></a>
423 <h2 class="memtitle"><span class="permalink"><a href="#gadb9cd73446f7e11e92383cd327a23407">◆ </a></span>__UNALIGNED_UINT16_WRITE</h2>
425 <div class="memitem">
426 <div class="memproto">
427 <table class="memname">
429 <td class="memname">#define __UNALIGNED_UINT16_WRITE</td>
432 </div><div class="memdoc">
434 <p>Pointer for unaligned write of a uint16_t variable. </p>
435 <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>
436 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16 = 0U;</div>
437 <div class="line"> </div>
438 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
439 <div class="line"> <a class="code hl_define" href="cmsis__armclang__a_8h.html#a5103fb373cae9837cc4a384be55dc87f">__UNALIGNED_UINT16_WRITE</a>(ptr, val16);</div>
440 <div class="line">}</div>
441 <div class="ttc" id="acmsis__armclang__a_8h_html_a5103fb373cae9837cc4a384be55dc87f"><div class="ttname"><a href="cmsis__armclang__a_8h.html#a5103fb373cae9837cc4a384be55dc87f">__UNALIGNED_UINT16_WRITE</a></div><div class="ttdeci">#define __UNALIGNED_UINT16_WRITE(addr, val)</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:64</div></div>
442 </div><!-- fragment -->
445 <a id="ga254322c344d954c9f829719a50a88e87" name="ga254322c344d954c9f829719a50a88e87"></a>
446 <h2 class="memtitle"><span class="permalink"><a href="#ga254322c344d954c9f829719a50a88e87">◆ </a></span>__UNALIGNED_UINT32_READ</h2>
448 <div class="memitem">
449 <div class="memproto">
450 <table class="memname">
452 <td class="memname">#define __UNALIGNED_UINT32_READ</td>
455 </div><div class="memdoc">
457 <p>Pointer for unaligned read of a uint32_t variable. </p>
458 <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>
459 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32;</div>
460 <div class="line"> </div>
461 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
462 <div class="line"> val32 = <a class="code hl_define" href="cmsis__armclang__a_8h.html#a3b931f0b051b8c1a6377a3dcc7559b5e">__UNALIGNED_UINT32_READ</a>(ptr);</div>
463 <div class="line">}</div>
464 <div class="ttc" id="acmsis__armclang__a_8h_html_a3b931f0b051b8c1a6377a3dcc7559b5e"><div class="ttname"><a href="cmsis__armclang__a_8h.html#a3b931f0b051b8c1a6377a3dcc7559b5e">__UNALIGNED_UINT32_READ</a></div><div class="ttdeci">#define __UNALIGNED_UINT32_READ(addr)</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:85</div></div>
465 </div><!-- fragment -->
468 <a id="gabb2180285c417aa9120a360c51f64b4b" name="gabb2180285c417aa9120a360c51f64b4b"></a>
469 <h2 class="memtitle"><span class="permalink"><a href="#gabb2180285c417aa9120a360c51f64b4b">◆ </a></span>__UNALIGNED_UINT32_WRITE</h2>
471 <div class="memitem">
472 <div class="memproto">
473 <table class="memname">
475 <td class="memname">#define __UNALIGNED_UINT32_WRITE</td>
478 </div><div class="memdoc">
480 <p>Pointer for unaligned write of a uint32_t variable. </p>
481 <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>
482 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32 = 0U;</div>
483 <div class="line"> </div>
484 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
485 <div class="line"> <a class="code hl_define" href="cmsis__armclang__a_8h.html#a203f593d140ed88b81bc189edc861110">__UNALIGNED_UINT32_WRITE</a>(ptr, val32);</div>
486 <div class="line">}</div>
487 <div class="ttc" id="acmsis__armclang__a_8h_html_a203f593d140ed88b81bc189edc861110"><div class="ttname"><a href="cmsis__armclang__a_8h.html#a203f593d140ed88b81bc189edc861110">__UNALIGNED_UINT32_WRITE</a></div><div class="ttdeci">#define __UNALIGNED_UINT32_WRITE(addr, val)</div><div class="ttdef"><b>Definition:</b> cmsis_armclang_a.h:78</div></div>
488 </div><!-- fragment -->
491 <a id="ga3e40e4c553fc11588f7a4c2a19e789e0" name="ga3e40e4c553fc11588f7a4c2a19e789e0"></a>
492 <h2 class="memtitle"><span class="permalink"><a href="#ga3e40e4c553fc11588f7a4c2a19e789e0">◆ </a></span>__USED</h2>
494 <div class="memitem">
495 <div class="memproto">
496 <table class="memname">
498 <td class="memname">#define __USED   __attribute__((used))</td>
501 </div><div class="memdoc">
503 <p>Inform that a variable shall be retained in executable image. </p>
504 <p>Definitions tagged with <b>__USED</b> in the source code should be not removed by the linker when detected as unused.</p>
505 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// Export following variables for debugging </span></div>
506 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a> uint32_t <span class="keyword">const</span> CMSIS_RTOS_API_Version = osCMSIS;</div>
507 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a> uint32_t <span class="keyword">const</span> CMSIS_RTOS_RTX_Version = osCMSIS_RTX;</div>
508 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a> uint32_t <span class="keyword">const</span> os_clockrate = OS_TICK;</div>
509 <div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a> uint32_t <span class="keyword">const</span> os_timernum = 0;</div>
510 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga3e40e4c553fc11588f7a4c2a19e789e0"><div class="ttname"><a href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a></div><div class="ttdeci">#define __USED</div><div class="ttdoc">Inform that a variable shall be retained in executable image.</div></div>
511 </div><!-- fragment -->
514 <a id="gac607bf387b29162be6a9b77fc7999539" name="gac607bf387b29162be6a9b77fc7999539"></a>
515 <h2 class="memtitle"><span class="permalink"><a href="#gac607bf387b29162be6a9b77fc7999539">◆ </a></span>__WEAK</h2>
517 <div class="memitem">
518 <div class="memproto">
519 <table class="memname">
521 <td class="memname">#define __WEAK   __attribute__((weak))</td>
524 </div><div class="memdoc">
526 <p>Export a function or variable weakly to allow overwrites. </p>
527 <p>Functions defined with <b>__WEAK</b> export their symbols weakly. A function defined weak behaves like a normal defined function unless a non-weak function with the same name is linked into the same image. If both a non-weak function and a weak defined function exist in the same image, then all calls to the function resolve to the non-weak function.</p>
528 <p>Functions declared with <b>__WEAK</b> and then defined without <b>__WEAK</b> behave as non-weak functions.</p>
529 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><a class="code hl_define" href="group__comp__cntrl__gr.html#gac607bf387b29162be6a9b77fc7999539">__WEAK</a> <span class="keywordtype">void</span> <a class="code hl_function" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2">SystemInit</a>(<span class="keywordtype">void</span>)</div>
530 <div class="line">{</div>
531 <div class="line"> SystemCoreSetup();</div>
532 <div class="line"> SystemCoreClockSetup(); </div>
533 <div class="line">}</div>
534 <div class="ttc" id="agroup__comp__cntrl__gr_html_gac607bf387b29162be6a9b77fc7999539"><div class="ttname"><a href="group__comp__cntrl__gr.html#gac607bf387b29162be6a9b77fc7999539">__WEAK</a></div><div class="ttdeci">#define __WEAK</div><div class="ttdoc">Export a function or variable weakly to allow overwrites.</div></div>
535 <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>
536 </div><!-- fragment -->
539 </div><!-- contents -->
540 </div><!-- doc-content -->
541 <!-- start footer part -->
542 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
545 <script type="text/javascript">
547 writeFooter.call(this);