begriffs open source - cmsis/blob - main/Core_A/group__comp__cntrl__gr.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-A): Compiler Control</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Core (Cortex-A)
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__comp__cntrl__gr.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 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)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 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>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">Compiler Control</div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Compiler agnostic #define symbols for generic C/C++ source code.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:gaee91bdfb2b6986731af09835bc9c6e74"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaee91bdfb2b6986731af09835bc9c6e74">__ARM_ARCH_7A__</a></td></tr>
 142 <tr class="memdesc:gaee91bdfb2b6986731af09835bc9c6e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to 1 when generating code for Armv7-A (Cortex-A7)  <br /></td></tr>
 143 <tr class="separator:gaee91bdfb2b6986731af09835bc9c6e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga1378040bcf22428955c6e3ce9c2053cd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a>&#160;&#160;&#160;__asm</td></tr>
 145 <tr class="memdesc:ga1378040bcf22428955c6e3ce9c2053cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass information from the compiler to the assembler.  <br /></td></tr>
 146 <tr class="separator:ga1378040bcf22428955c6e3ce9c2053cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gade2d8d7118f8ff49547f60aa0c3382bb">__INLINE</a>&#160;&#160;&#160;__inline</td></tr>
 148 <tr class="memdesc:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recommend that function should be inlined by the compiler.  <br /></td></tr>
 149 <tr class="separator:gade2d8d7118f8ff49547f60aa0c3382bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a>&#160;&#160;&#160;static __inline</td></tr>
 151 <tr class="memdesc:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define a static function should be inlined by the compiler.  <br /></td></tr>
 152 <tr class="separator:gaba87361bfad2ae52cfe2f40c1a1dbf9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:gab904513442afdf77d4f8c74f23cbb040"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a></td></tr>
 154 <tr class="memdesc:gab904513442afdf77d4f8c74f23cbb040"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define a static function that should be always inlined by the compiler.  <br /></td></tr>
 155 <tr class="separator:gab904513442afdf77d4f8c74f23cbb040"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga153a4a31b276a9758959580538720a51"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga153a4a31b276a9758959580538720a51">__NO_RETURN</a>&#160;&#160;&#160;__attribute__((__noreturn__))</td></tr>
 157 <tr class="memdesc:ga153a4a31b276a9758959580538720a51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform the compiler that a function does not return.  <br /></td></tr>
 158 <tr class="separator:ga153a4a31b276a9758959580538720a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga3e40e4c553fc11588f7a4c2a19e789e0">__USED</a>&#160;&#160;&#160;__attribute__((used))</td></tr>
 160 <tr class="memdesc:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform that a variable shall be retained in executable image.  <br /></td></tr>
 161 <tr class="separator:ga3e40e4c553fc11588f7a4c2a19e789e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:gac607bf387b29162be6a9b77fc7999539"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gac607bf387b29162be6a9b77fc7999539">__WEAK</a>&#160;&#160;&#160;__attribute__((weak))</td></tr>
 163 <tr class="memdesc:gac607bf387b29162be6a9b77fc7999539"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export a function or variable weakly to allow overwrites.  <br /></td></tr>
 164 <tr class="separator:gac607bf387b29162be6a9b77fc7999539"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">__ALIGNED</a>(x)&#160;&#160;&#160;__attribute__((aligned(x)))</td></tr>
 166 <tr class="memdesc:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum alignment for a variable.  <br /></td></tr>
 167 <tr class="separator:gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:gabe8996d3d985ee1529475443cc635bf1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabe8996d3d985ee1529475443cc635bf1">__PACKED</a>&#160;&#160;&#160;__attribute__((packed, aligned(1)))</td></tr>
 169 <tr class="memdesc:gabe8996d3d985ee1529475443cc635bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request smallest possible alignment.  <br /></td></tr>
 170 <tr class="separator:gabe8996d3d985ee1529475443cc635bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:ga4dbb70fab85207c27b581ecb6532b314"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga4dbb70fab85207c27b581ecb6532b314">__PACKED_STRUCT</a></td></tr>
 172 <tr class="memdesc:ga4dbb70fab85207c27b581ecb6532b314"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request smallest possible alignment for a structure.  <br /></td></tr>
 173 <tr class="separator:ga4dbb70fab85207c27b581ecb6532b314"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:ga27fd2ec6767ca1ab66d36b5cc0103268"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga27fd2ec6767ca1ab66d36b5cc0103268">__UNALIGNED_UINT32</a></td></tr>
 175 <tr class="memdesc:ga27fd2ec6767ca1ab66d36b5cc0103268"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer for unaligned access of a uint32_t variable.  <br /></td></tr>
 176 <tr class="separator:ga27fd2ec6767ca1ab66d36b5cc0103268"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:gabe8693a7200e573101551d49a1772fb9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabe8693a7200e573101551d49a1772fb9">__UNALIGNED_UINT16_READ</a></td></tr>
 178 <tr class="memdesc:gabe8693a7200e573101551d49a1772fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer for unaligned read of a uint16_t variable.  <br /></td></tr>
 179 <tr class="separator:gabe8693a7200e573101551d49a1772fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:gadb9cd73446f7e11e92383cd327a23407"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gadb9cd73446f7e11e92383cd327a23407">__UNALIGNED_UINT16_WRITE</a></td></tr>
 181 <tr class="memdesc:gadb9cd73446f7e11e92383cd327a23407"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer for unaligned write of a uint16_t variable.  <br /></td></tr>
 182 <tr class="separator:gadb9cd73446f7e11e92383cd327a23407"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:ga254322c344d954c9f829719a50a88e87"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#ga254322c344d954c9f829719a50a88e87">__UNALIGNED_UINT32_READ</a></td></tr>
 184 <tr class="memdesc:ga254322c344d954c9f829719a50a88e87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer for unaligned read of a uint32_t variable.  <br /></td></tr>
 185 <tr class="separator:ga254322c344d954c9f829719a50a88e87"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:gabb2180285c417aa9120a360c51f64b4b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__comp__cntrl__gr.html#gabb2180285c417aa9120a360c51f64b4b">__UNALIGNED_UINT32_WRITE</a></td></tr>
 187 <tr class="memdesc:gabb2180285c417aa9120a360c51f64b4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer for unaligned write of a uint32_t variable.  <br /></td></tr>
 188 <tr class="separator:gabb2180285c417aa9120a360c51f64b4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 </table>
 190 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 191 <p>Compiler agnostic #define symbols for generic C/C++ source code. </p>
 192 <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>
 193 <h2 class="groupheader">Macro Definition Documentation</h2>
 194 <a id="gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55" name="gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55"></a>
 195 <h2 class="memtitle"><span class="permalink"><a href="#gaa65ef8f7a5e8b7a6ea6c1d48b4c78e55">&#9670;&#160;</a></span>__ALIGNED</h2>
 196
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">#define __ALIGNED</td>
 202           <td>(</td>
 203           <td class="paramtype">&#160;</td>
 204           <td class="paramname">x</td><td>)</td>
 205           <td>&#160;&#160;&#160;__attribute__((aligned(x)))</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>Minimum alignment for a variable. </p>
 211 <p>Specifies a minimum alignment for a variable or structure field, measured in bytes.</p>
 212 <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>
 213 <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>
 214 </div><!-- fragment -->
 215 </div>
 216 </div>
 217 <a id="gaee91bdfb2b6986731af09835bc9c6e74" name="gaee91bdfb2b6986731af09835bc9c6e74"></a>
 218 <h2 class="memtitle"><span class="permalink"><a href="#gaee91bdfb2b6986731af09835bc9c6e74">&#9670;&#160;</a></span>__ARM_ARCH_7A__</h2>
 219
 220 <div class="memitem">
 221 <div class="memproto">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname">#define __ARM_ARCH_7A__</td>
 225         </tr>
 226       </table>
 227 </div><div class="memdoc">
 228
 229 <p>Set to 1 when generating code for Armv7-A (Cortex-A7) </p>
 230 <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>
 231
 232 </div>
 233 </div>
 234 <a id="ga1378040bcf22428955c6e3ce9c2053cd" name="ga1378040bcf22428955c6e3ce9c2053cd"></a>
 235 <h2 class="memtitle"><span class="permalink"><a href="#ga1378040bcf22428955c6e3ce9c2053cd">&#9670;&#160;</a></span>__ASM</h2>
 236
 237 <div class="memitem">
 238 <div class="memproto">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname">#define __ASM&#160;&#160;&#160;__asm</td>
 242         </tr>
 243       </table>
 244 </div><div class="memdoc">
 245
 246 <p>Pass information from the compiler to the assembler. </p>
 247 <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>
 248 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// Reverse bit order of value</span></div>
 249 <div class="line"> </div>
 250 <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>
 251 <div class="line">{</div>
 252 <div class="line">  uint32_t result;</div>
 253 <div class="line"> </div>
 254 <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">&quot;rbit %0, %1&quot;</span> : <span class="stringliteral">&quot;=r&quot;</span> (result) : <span class="stringliteral">&quot;r&quot;</span> (value) );</div>
 255 <div class="line">   <span class="keywordflow">return</span>(result);</div>
 256 <div class="line">}</div>
 257 <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:219</div></div>
 258 <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>
 259 <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>
 260 </div><!-- fragment -->
 261 </div>
 262 </div>
 263 <a id="gade2d8d7118f8ff49547f60aa0c3382bb" name="gade2d8d7118f8ff49547f60aa0c3382bb"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#gade2d8d7118f8ff49547f60aa0c3382bb">&#9670;&#160;</a></span>__INLINE</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">#define __INLINE&#160;&#160;&#160;__inline</td>
 271         </tr>
 272       </table>
 273 </div><div class="memdoc">
 274
 275 <p>Recommend that function should be inlined by the compiler. </p>
 276 <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>
 277 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">const</span> uint32_t led_mask[] = {1U &lt;&lt; 4, 1U &lt;&lt; 5, 1U &lt;&lt; 6, 1U &lt;&lt; 7};</div>
 278 <div class="line"> </div>
 279 <div class="line"><span class="comment">//------------------------------------------------------------------------------</span></div>
 280 <div class="line"><span class="comment">// Switch on LEDs</span></div>
 281 <div class="line"><span class="comment">//------------------------------------------------------------------------------</span></div>
 282 <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>
 283 <div class="line"> </div>
 284 <div class="line">  PTD-&gt;PCOR   = led_mask[led];</div>
 285 <div class="line">}</div>
 286 <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>
 287 </div><!-- fragment -->
 288 </div>
 289 </div>
 290 <a id="ga153a4a31b276a9758959580538720a51" name="ga153a4a31b276a9758959580538720a51"></a>
 291 <h2 class="memtitle"><span class="permalink"><a href="#ga153a4a31b276a9758959580538720a51">&#9670;&#160;</a></span>__NO_RETURN</h2>
 292
 293 <div class="memitem">
 294 <div class="memproto">
 295       <table class="memname">
 296         <tr>
 297           <td class="memname">#define __NO_RETURN&#160;&#160;&#160;__attribute__((__noreturn__))</td>
 298         </tr>
 299       </table>
 300 </div><div class="memdoc">
 301
 302 <p>Inform the compiler that a function does not return. </p>
 303 <p>Informs the compiler that the function does not return. The compiler can then perform optimizations by removing code that is never reached.</p>
 304 <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>
 305 <div class="line"> </div>
 306 <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>
 307 <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>
 308 </div><!-- fragment -->
 309 </div>
 310 </div>
 311 <a id="gabe8996d3d985ee1529475443cc635bf1" name="gabe8996d3d985ee1529475443cc635bf1"></a>
 312 <h2 class="memtitle"><span class="permalink"><a href="#gabe8996d3d985ee1529475443cc635bf1">&#9670;&#160;</a></span>__PACKED</h2>
 313
 314 <div class="memitem">
 315 <div class="memproto">
 316       <table class="memname">
 317         <tr>
 318           <td class="memname">#define __PACKED&#160;&#160;&#160;__attribute__((packed, aligned(1)))</td>
 319         </tr>
 320       </table>
 321 </div><div class="memdoc">
 322
 323 <p>Request smallest possible alignment. </p>
 324 <p>Specifies that a type must have the smallest possible alignment.</p>
 325 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="keyword">struct </span>foo {</div>
 326 <div class="line">  uint8_t  u8;</div>
 327 <div class="line">  uint32_t u32[2] <a class="code hl_define" href="group__comp__cntrl__gr.html#gabe8996d3d985ee1529475443cc635bf1">__PACKED</a>;</div>
 328 <div class="line">};</div>
 329 <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>
 330 </div><!-- fragment -->
 331 </div>
 332 </div>
 333 <a id="ga4dbb70fab85207c27b581ecb6532b314" name="ga4dbb70fab85207c27b581ecb6532b314"></a>
 334 <h2 class="memtitle"><span class="permalink"><a href="#ga4dbb70fab85207c27b581ecb6532b314">&#9670;&#160;</a></span>__PACKED_STRUCT</h2>
 335
 336 <div class="memitem">
 337 <div class="memproto">
 338       <table class="memname">
 339         <tr>
 340           <td class="memname">#define __PACKED_STRUCT</td>
 341         </tr>
 342       </table>
 343 </div><div class="memdoc">
 344
 345 <p>Request smallest possible alignment for a structure. </p>
 346 <p>Specifies that a structure must have the smallest possible alignment.</p>
 347 <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>
 348 <div class="line">  uint8_t   u8;</div>
 349 <div class="line">  uint32_t  u32;</div>
 350 <div class="line">  uint16_t  u16;</div>
 351 <div class="line">};</div>
 352 <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:62</div></div>
 353 </div><!-- fragment -->
 354 </div>
 355 </div>
 356 <a id="gab904513442afdf77d4f8c74f23cbb040" name="gab904513442afdf77d4f8c74f23cbb040"></a>
 357 <h2 class="memtitle"><span class="permalink"><a href="#gab904513442afdf77d4f8c74f23cbb040">&#9670;&#160;</a></span>__STATIC_FORCEINLINE</h2>
 358
 359 <div class="memitem">
 360 <div class="memproto">
 361       <table class="memname">
 362         <tr>
 363           <td class="memname">#define __STATIC_FORCEINLINE</td>
 364         </tr>
 365       </table>
 366 </div><div class="memdoc">
 367
 368 <p>Define a static function that should be always inlined by the compiler. </p>
 369 <p>Defines a static function that should be always inlined by the compiler.</p>
 370 <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>
 371 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">\\ Get Interrupt Vector</div>
 372 <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>
 373 <div class="line">{</div>
 374 <div class="line">    uint32_t *vectors = (uint32_t *) ((uintptr_t) SCB-&gt;VTOR);</div>
 375 <div class="line">    <span class="keywordflow">return</span> vectors[(int32_t)IRQn + NVIC_USER_IRQ_OFFSET];</div>
 376 <div class="line">}</div>
 377 <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:44</div></div>
 378 <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_IRQCtrl.txt:79</div></div>
 379 </div><!-- fragment -->
 380 </div>
 381 </div>
 382 <a id="gaba87361bfad2ae52cfe2f40c1a1dbf9c" name="gaba87361bfad2ae52cfe2f40c1a1dbf9c"></a>
 383 <h2 class="memtitle"><span class="permalink"><a href="#gaba87361bfad2ae52cfe2f40c1a1dbf9c">&#9670;&#160;</a></span>__STATIC_INLINE</h2>
 384
 385 <div class="memitem">
 386 <div class="memproto">
 387       <table class="memname">
 388         <tr>
 389           <td class="memname">#define __STATIC_INLINE&#160;&#160;&#160;static __inline</td>
 390         </tr>
 391       </table>
 392 </div><div class="memdoc">
 393
 394 <p>Define a static function should be inlined by the compiler. </p>
 395 <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>
 396 <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>
 397 <div class="line">{</div>
 398 <div class="line">  <span class="keywordflow">return</span>((uint32_t)<a class="code hl_define" href="group__GIC__functions.html#ga82e193c0016a9377274756b2673464a6">GICDistributor</a>-&gt;D_IPRIORITYR[((uint32_t)(int32_t)IRQn)]);</div>
 399 <div class="line">}</div>
 400 <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:1675</div></div>
 401 <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>
 402 </div><!-- fragment -->
 403 </div>
 404 </div>
 405 <a id="gabe8693a7200e573101551d49a1772fb9" name="gabe8693a7200e573101551d49a1772fb9"></a>
 406 <h2 class="memtitle"><span class="permalink"><a href="#gabe8693a7200e573101551d49a1772fb9">&#9670;&#160;</a></span>__UNALIGNED_UINT16_READ</h2>
 407
 408 <div class="memitem">
 409 <div class="memproto">
 410       <table class="memname">
 411         <tr>
 412           <td class="memname">#define __UNALIGNED_UINT16_READ</td>
 413         </tr>
 414       </table>
 415 </div><div class="memdoc">
 416
 417 <p>Pointer for unaligned read of a uint16_t variable. </p>
 418 <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>
 419 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16;</div>
 420 <div class="line"> </div>
 421 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
 422 <div class="line">   val16 = <a class="code hl_define" href="cmsis__armclang__a_8h.html#ab71b66e5ce403158d3dee62a59f9175f">__UNALIGNED_UINT16_READ</a>(ptr);</div>
 423 <div class="line">}</div>
 424 <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:78</div></div>
 425 </div><!-- fragment -->
 426 </div>
 427 </div>
 428 <a id="gadb9cd73446f7e11e92383cd327a23407" name="gadb9cd73446f7e11e92383cd327a23407"></a>
 429 <h2 class="memtitle"><span class="permalink"><a href="#gadb9cd73446f7e11e92383cd327a23407">&#9670;&#160;</a></span>__UNALIGNED_UINT16_WRITE</h2>
 430
 431 <div class="memitem">
 432 <div class="memproto">
 433       <table class="memname">
 434         <tr>
 435           <td class="memname">#define __UNALIGNED_UINT16_WRITE</td>
 436         </tr>
 437       </table>
 438 </div><div class="memdoc">
 439
 440 <p>Pointer for unaligned write of a uint16_t variable. </p>
 441 <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>
 442 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint16_t val16 = 0U;</div>
 443 <div class="line"> </div>
 444 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
 445 <div class="line">   <a class="code hl_define" href="cmsis__armclang__a_8h.html#a5103fb373cae9837cc4a384be55dc87f">__UNALIGNED_UINT16_WRITE</a>(ptr, val16);</div>
 446 <div class="line">}</div>
 447 <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:70</div></div>
 448 </div><!-- fragment -->
 449 </div>
 450 </div>
 451 <a id="ga27fd2ec6767ca1ab66d36b5cc0103268" name="ga27fd2ec6767ca1ab66d36b5cc0103268"></a>
 452 <h2 class="memtitle"><span class="permalink"><a href="#ga27fd2ec6767ca1ab66d36b5cc0103268">&#9670;&#160;</a></span>__UNALIGNED_UINT32</h2>
 453
 454 <div class="memitem">
 455 <div class="memproto">
 456       <table class="memname">
 457         <tr>
 458           <td class="memname">#define __UNALIGNED_UINT32</td>
 459         </tr>
 460       </table>
 461 </div><div class="memdoc">
 462
 463 <p>Pointer for unaligned access of a uint32_t variable. </p>
 464 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Do not use this macro. It has been superseded by <a class="el" href="cmsis__armclang__a_8h.html#a3b931f0b051b8c1a6377a3dcc7559b5e">__UNALIGNED_UINT32_READ</a>, <a class="el" href="cmsis__armclang__a_8h.html#a203f593d140ed88b81bc189edc861110">__UNALIGNED_UINT32_WRITE</a> and will be removed in the future. </dd></dl>
 465 <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/write operations. The compiler will generate the appropriate access (aligned or non-aligned) depending on the underlying Arm processor core and compiler settings.</p>
 466 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32;</div>
 467 <div class="line"> </div>
 468 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
 469 <div class="line">  <a class="code hl_define" href="group__comp__cntrl__gr.html#ga27fd2ec6767ca1ab66d36b5cc0103268">__UNALIGNED_UINT32</a>(ptr) = val32;</div>
 470 <div class="line">}</div>
 471 <div class="ttc" id="agroup__comp__cntrl__gr_html_ga27fd2ec6767ca1ab66d36b5cc0103268"><div class="ttname"><a href="group__comp__cntrl__gr.html#ga27fd2ec6767ca1ab66d36b5cc0103268">__UNALIGNED_UINT32</a></div><div class="ttdeci">#define __UNALIGNED_UINT32</div><div class="ttdoc">Pointer for unaligned access of a uint32_t variable.</div><div class="ttdef"><b>Definition:</b> Ref_CompilerControl.txt:230</div></div>
 472 </div><!-- fragment -->
 473 </div>
 474 </div>
 475 <a id="ga254322c344d954c9f829719a50a88e87" name="ga254322c344d954c9f829719a50a88e87"></a>
 476 <h2 class="memtitle"><span class="permalink"><a href="#ga254322c344d954c9f829719a50a88e87">&#9670;&#160;</a></span>__UNALIGNED_UINT32_READ</h2>
 477
 478 <div class="memitem">
 479 <div class="memproto">
 480       <table class="memname">
 481         <tr>
 482           <td class="memname">#define __UNALIGNED_UINT32_READ</td>
 483         </tr>
 484       </table>
 485 </div><div class="memdoc">
 486
 487 <p>Pointer for unaligned read of a uint32_t variable. </p>
 488 <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>
 489 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32;</div>
 490 <div class="line"> </div>
 491 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
 492 <div class="line">   val32 = <a class="code hl_define" href="cmsis__armclang__a_8h.html#a3b931f0b051b8c1a6377a3dcc7559b5e">__UNALIGNED_UINT32_READ</a>(ptr);</div>
 493 <div class="line">}</div>
 494 <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:93</div></div>
 495 </div><!-- fragment -->
 496 </div>
 497 </div>
 498 <a id="gabb2180285c417aa9120a360c51f64b4b" name="gabb2180285c417aa9120a360c51f64b4b"></a>
 499 <h2 class="memtitle"><span class="permalink"><a href="#gabb2180285c417aa9120a360c51f64b4b">&#9670;&#160;</a></span>__UNALIGNED_UINT32_WRITE</h2>
 500
 501 <div class="memitem">
 502 <div class="memproto">
 503       <table class="memname">
 504         <tr>
 505           <td class="memname">#define __UNALIGNED_UINT32_WRITE</td>
 506         </tr>
 507       </table>
 508 </div><div class="memdoc">
 509
 510 <p>Pointer for unaligned write of a uint32_t variable. </p>
 511 <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>
 512 <p><b> Code Example:</b> </p><div class="fragment"><div class="line">uint32_t val32 = 0U;</div>
 513 <div class="line"> </div>
 514 <div class="line"><span class="keywordtype">void</span> test (uint8_t *ptr) {</div>
 515 <div class="line">   <a class="code hl_define" href="cmsis__armclang__a_8h.html#a203f593d140ed88b81bc189edc861110">__UNALIGNED_UINT32_WRITE</a>(ptr, val32);</div>
 516 <div class="line">}</div>
 517 <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:86</div></div>
 518 </div><!-- fragment -->
 519 </div>
 520 </div>
 521 <a id="ga3e40e4c553fc11588f7a4c2a19e789e0" name="ga3e40e4c553fc11588f7a4c2a19e789e0"></a>
 522 <h2 class="memtitle"><span class="permalink"><a href="#ga3e40e4c553fc11588f7a4c2a19e789e0">&#9670;&#160;</a></span>__USED</h2>
 523
 524 <div class="memitem">
 525 <div class="memproto">
 526       <table class="memname">
 527         <tr>
 528           <td class="memname">#define __USED&#160;&#160;&#160;__attribute__((used))</td>
 529         </tr>
 530       </table>
 531 </div><div class="memdoc">
 532
 533 <p>Inform that a variable shall be retained in executable image. </p>
 534 <p>Definitions tagged with <b>__USED</b> in the source code should be not removed by the linker when detected as unused.</p>
 535 <p><b> Code Example:</b> </p><div class="fragment"><div class="line"><span class="comment">// Export following variables for debugging </span></div>
 536 <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>
 537 <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>
 538 <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>
 539 <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>
 540 <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>
 541 </div><!-- fragment -->
 542 </div>
 543 </div>
 544 <a id="gac607bf387b29162be6a9b77fc7999539" name="gac607bf387b29162be6a9b77fc7999539"></a>
 545 <h2 class="memtitle"><span class="permalink"><a href="#gac607bf387b29162be6a9b77fc7999539">&#9670;&#160;</a></span>__WEAK</h2>
 546
 547 <div class="memitem">
 548 <div class="memproto">
 549       <table class="memname">
 550         <tr>
 551           <td class="memname">#define __WEAK&#160;&#160;&#160;__attribute__((weak))</td>
 552         </tr>
 553       </table>
 554 </div><div class="memdoc">
 555
 556 <p>Export a function or variable weakly to allow overwrites. </p>
 557 <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>
 558 <p>Functions declared with <b>__WEAK</b> and then defined without <b>__WEAK</b> behave as non-weak functions.</p>
 559 <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>
 560 <div class="line">{</div>
 561 <div class="line">  SystemCoreSetup();</div>
 562 <div class="line">  SystemCoreClockSetup(); </div>
 563 <div class="line">}</div>
 564 <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>
 565 <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>
 566 </div><!-- fragment -->
 567 </div>
 568 </div>
 569 </div><!-- contents -->
 570 </div><!-- doc-content -->
 571 <!-- start footer part -->
 572 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 573   <ul>
 574     <li class="footer">
 575       <script type="text/javascript">
 576         <!--
 577         writeFooter.call(this);
 578         //-->
 579       </script>
 580     </li>
 581   </ul>
 582 </div>
 583 </body>
 584 </html>