begriffs open source - cmsis/blob - main/Core_A/group__CMSIS__Core__InstructionInterface.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): Intrinsic Functions</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);
  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__CMSIS__Core__InstructionInterface.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> &#124;
 132 <a href="#func-members">Functions</a>  </div>
 133   <div class="headertitle"><div class="title">Intrinsic Functions</div></div>
 134 </div><!--header-->
 135 <div class="contents">
 136
 137 <p>Functions that generate specific Cortex-A CPU Instructions.
 138 <a href="#details">More...</a></p>
 139 <table class="memberdecls">
 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 141 Macros</h2></td></tr>
 142 <tr class="memitem:gabd585ddc865fb9b7f2493af1eee1a572"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gabd585ddc865fb9b7f2493af1eee1a572">__NOP</a>&#160;&#160;&#160;__builtin_arm_nop</td></tr>
 143 <tr class="memdesc:gabd585ddc865fb9b7f2493af1eee1a572"><td class="mdescLeft">&#160;</td><td class="mdescRight">No Operation.  <br /></td></tr>
 144 <tr class="separator:gabd585ddc865fb9b7f2493af1eee1a572"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:gad23bf2b78a9a4524157c9de0d30b7448"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gad23bf2b78a9a4524157c9de0d30b7448">__WFI</a>&#160;&#160;&#160;__builtin_arm_wfi</td></tr>
 146 <tr class="memdesc:gad23bf2b78a9a4524157c9de0d30b7448"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait For Interrupt.  <br /></td></tr>
 147 <tr class="separator:gad23bf2b78a9a4524157c9de0d30b7448"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:gaac6cc7dd4325d9cb40d3290fa5244b3d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gaac6cc7dd4325d9cb40d3290fa5244b3d">__WFE</a>&#160;&#160;&#160;__builtin_arm_wfe</td></tr>
 149 <tr class="memdesc:gaac6cc7dd4325d9cb40d3290fa5244b3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait For Event.  <br /></td></tr>
 150 <tr class="separator:gaac6cc7dd4325d9cb40d3290fa5244b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:gaab4f296d0022b4b10dc0976eb22052f9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gaab4f296d0022b4b10dc0976eb22052f9">__SEV</a>&#160;&#160;&#160;__builtin_arm_sev</td></tr>
 152 <tr class="memdesc:gaab4f296d0022b4b10dc0976eb22052f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Event.  <br /></td></tr>
 153 <tr class="separator:gaab4f296d0022b4b10dc0976eb22052f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:gaad233022e850a009fc6f7602be1182f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gaad233022e850a009fc6f7602be1182f6">__ISB</a>()&#160;&#160;&#160;__builtin_arm_isb(0xF)</td></tr>
 155 <tr class="memdesc:gaad233022e850a009fc6f7602be1182f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instruction Synchronization Barrier.  <br /></td></tr>
 156 <tr class="separator:gaad233022e850a009fc6f7602be1182f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga067d257a2b34565410acefb5afef2203"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga067d257a2b34565410acefb5afef2203">__DSB</a>()&#160;&#160;&#160;__builtin_arm_dsb(0xF)</td></tr>
 158 <tr class="memdesc:ga067d257a2b34565410acefb5afef2203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data Synchronization Barrier.  <br /></td></tr>
 159 <tr class="separator:ga067d257a2b34565410acefb5afef2203"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga671101179b5943990785f36f8c1e2269"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga671101179b5943990785f36f8c1e2269">__DMB</a>()&#160;&#160;&#160;__builtin_arm_dmb(0xF)</td></tr>
 161 <tr class="memdesc:ga671101179b5943990785f36f8c1e2269"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data Memory Barrier.  <br /></td></tr>
 162 <tr class="separator:ga671101179b5943990785f36f8c1e2269"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:ga15ea6bd3c507d3e81c3b3a1258e46397"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga15ea6bd3c507d3e81c3b3a1258e46397">__BKPT</a>(value)&#160;&#160;&#160;<a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> volatile (&quot;bkpt &quot;#value)</td></tr>
 164 <tr class="memdesc:ga15ea6bd3c507d3e81c3b3a1258e46397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Breakpoint.  <br /></td></tr>
 165 <tr class="separator:ga15ea6bd3c507d3e81c3b3a1258e46397"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 </table><table class="memberdecls">
 167 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 168 Functions</h2></td></tr>
 169 <tr class="memitem:ga4717abc17af5ba29b1e4c055e0a0d9b8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga4717abc17af5ba29b1e4c055e0a0d9b8">__REV</a> (uint32_t value)</td></tr>
 170 <tr class="memdesc:ga4717abc17af5ba29b1e4c055e0a0d9b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (32 bit)  <br /></td></tr>
 171 <tr class="separator:ga4717abc17af5ba29b1e4c055e0a0d9b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:ga926d702cf1de59d54f4e62ab8e3c8b8d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga926d702cf1de59d54f4e62ab8e3c8b8d">__REV16</a> (uint16_t value)</td></tr>
 173 <tr class="memdesc:ga926d702cf1de59d54f4e62ab8e3c8b8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (16 bit)  <br /></td></tr>
 174 <tr class="separator:ga926d702cf1de59d54f4e62ab8e3c8b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:ga1ec006e6d79063363cb0c2a2e0b3adbe"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga1ec006e6d79063363cb0c2a2e0b3adbe">__REVSH</a> (int32_t value)</td></tr>
 176 <tr class="memdesc:ga1ec006e6d79063363cb0c2a2e0b3adbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (16 bit)  <br /></td></tr>
 177 <tr class="separator:ga1ec006e6d79063363cb0c2a2e0b3adbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:gae05c1a2dac5bb7a399420c804c3048ca"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gae05c1a2dac5bb7a399420c804c3048ca">__ROR</a> (uint32_t op1, uint32_t op2)</td></tr>
 179 <tr class="memdesc:gae05c1a2dac5bb7a399420c804c3048ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate Right in unsigned value (32 bit)  <br /></td></tr>
 180 <tr class="separator:gae05c1a2dac5bb7a399420c804c3048ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:gad6f9f297f6b91a995ee199fbc796b863"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#gad6f9f297f6b91a995ee199fbc796b863">__RBIT</a> (uint32_t value)</td></tr>
 182 <tr class="memdesc:gad6f9f297f6b91a995ee199fbc796b863"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse bit order of value.  <br /></td></tr>
 183 <tr class="separator:gad6f9f297f6b91a995ee199fbc796b863"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 <tr class="memitem:ga90884c591ac5d73d6069334eba9d6c02"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__Core__InstructionInterface.html#ga90884c591ac5d73d6069334eba9d6c02">__CLZ</a> (uint32_t value)</td></tr>
 185 <tr class="memdesc:ga90884c591ac5d73d6069334eba9d6c02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Count leading zeros.  <br /></td></tr>
 186 <tr class="separator:ga90884c591ac5d73d6069334eba9d6c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 </table>
 188 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 189 <p>Functions that generate specific Cortex-A CPU Instructions. </p>
 190 <h2 class="groupheader">Macro Definition Documentation</h2>
 191 <a id="ga15ea6bd3c507d3e81c3b3a1258e46397" name="ga15ea6bd3c507d3e81c3b3a1258e46397"></a>
 192 <h2 class="memtitle"><span class="permalink"><a href="#ga15ea6bd3c507d3e81c3b3a1258e46397">&#9670;&#160;</a></span>__BKPT</h2>
 193
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">#define __BKPT</td>
 199           <td>(</td>
 200           <td class="paramtype">&#160;</td>
 201           <td class="paramname">value</td><td>)</td>
 202           <td>&#160;&#160;&#160;<a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> volatile (&quot;bkpt &quot;#value)</td>
 203         </tr>
 204       </table>
 205 </div><div class="memdoc">
 206
 207 <p>Breakpoint. </p>
 208 <p>Causes the processor to enter Debug state. Debug tools can use this to investigate system state when the instruction at a particular address is reached. </p><dl class="params"><dt>Parameters</dt><dd>
 209   <table class="params">
 210     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is ignored by the processor. If required, a debugger can use it to store additional information about the breakpoint.</td></tr>
 211   </table>
 212   </dd>
 213 </dl>
 214 <p>Causes the processor to enter Debug state. Debug tools can use this to investigate system state when the instruction at a particular address is reached. </p>
 215
 216 </div>
 217 </div>
 218 <a id="ga671101179b5943990785f36f8c1e2269" name="ga671101179b5943990785f36f8c1e2269"></a>
 219 <h2 class="memtitle"><span class="permalink"><a href="#ga671101179b5943990785f36f8c1e2269">&#9670;&#160;</a></span>__DMB</h2>
 220
 221 <div class="memitem">
 222 <div class="memproto">
 223       <table class="memname">
 224         <tr>
 225           <td class="memname">#define __DMB</td>
 226           <td>(</td>
 227           <td class="paramname"></td><td>)</td>
 228           <td>&#160;&#160;&#160;__builtin_arm_dmb(0xF)</td>
 229         </tr>
 230       </table>
 231 </div><div class="memdoc">
 232
 233 <p>Data Memory Barrier. </p>
 234 <p>Ensures the apparent order of the explicit memory operations before and after the instruction, without ensuring their completion. </p>
 235
 236 </div>
 237 </div>
 238 <a id="ga067d257a2b34565410acefb5afef2203" name="ga067d257a2b34565410acefb5afef2203"></a>
 239 <h2 class="memtitle"><span class="permalink"><a href="#ga067d257a2b34565410acefb5afef2203">&#9670;&#160;</a></span>__DSB</h2>
 240
 241 <div class="memitem">
 242 <div class="memproto">
 243       <table class="memname">
 244         <tr>
 245           <td class="memname">#define __DSB</td>
 246           <td>(</td>
 247           <td class="paramname"></td><td>)</td>
 248           <td>&#160;&#160;&#160;__builtin_arm_dsb(0xF)</td>
 249         </tr>
 250       </table>
 251 </div><div class="memdoc">
 252
 253 <p>Data Synchronization Barrier. </p>
 254 <p>Acts as a special kind of Data Memory Barrier. It completes when all explicit memory accesses before this instruction complete. </p>
 255
 256 </div>
 257 </div>
 258 <a id="gaad233022e850a009fc6f7602be1182f6" name="gaad233022e850a009fc6f7602be1182f6"></a>
 259 <h2 class="memtitle"><span class="permalink"><a href="#gaad233022e850a009fc6f7602be1182f6">&#9670;&#160;</a></span>__ISB</h2>
 260
 261 <div class="memitem">
 262 <div class="memproto">
 263       <table class="memname">
 264         <tr>
 265           <td class="memname">#define __ISB</td>
 266           <td>(</td>
 267           <td class="paramname"></td><td>)</td>
 268           <td>&#160;&#160;&#160;__builtin_arm_isb(0xF)</td>
 269         </tr>
 270       </table>
 271 </div><div class="memdoc">
 272
 273 <p>Instruction Synchronization Barrier. </p>
 274 <p>Instruction Synchronization Barrier flushes the pipeline in the processor, so that all instructions following the ISB are fetched from cache or memory, after the instruction has been completed. </p>
 275
 276 </div>
 277 </div>
 278 <a id="gabd585ddc865fb9b7f2493af1eee1a572" name="gabd585ddc865fb9b7f2493af1eee1a572"></a>
 279 <h2 class="memtitle"><span class="permalink"><a href="#gabd585ddc865fb9b7f2493af1eee1a572">&#9670;&#160;</a></span>__NOP</h2>
 280
 281 <div class="memitem">
 282 <div class="memproto">
 283       <table class="memname">
 284         <tr>
 285           <td class="memname">#define __NOP&#160;&#160;&#160;__builtin_arm_nop</td>
 286         </tr>
 287       </table>
 288 </div><div class="memdoc">
 289
 290 <p>No Operation. </p>
 291 <p>No Operation does nothing. This instruction can be used for code alignment purposes. </p>
 292
 293 </div>
 294 </div>
 295 <a id="gaab4f296d0022b4b10dc0976eb22052f9" name="gaab4f296d0022b4b10dc0976eb22052f9"></a>
 296 <h2 class="memtitle"><span class="permalink"><a href="#gaab4f296d0022b4b10dc0976eb22052f9">&#9670;&#160;</a></span>__SEV</h2>
 297
 298 <div class="memitem">
 299 <div class="memproto">
 300       <table class="memname">
 301         <tr>
 302           <td class="memname">#define __SEV&#160;&#160;&#160;__builtin_arm_sev</td>
 303         </tr>
 304       </table>
 305 </div><div class="memdoc">
 306
 307 <p>Send Event. </p>
 308 <p>Send Event is a hint instruction. It causes an event to be signaled to the CPU. </p>
 309
 310 </div>
 311 </div>
 312 <a id="gaac6cc7dd4325d9cb40d3290fa5244b3d" name="gaac6cc7dd4325d9cb40d3290fa5244b3d"></a>
 313 <h2 class="memtitle"><span class="permalink"><a href="#gaac6cc7dd4325d9cb40d3290fa5244b3d">&#9670;&#160;</a></span>__WFE</h2>
 314
 315 <div class="memitem">
 316 <div class="memproto">
 317       <table class="memname">
 318         <tr>
 319           <td class="memname">#define __WFE&#160;&#160;&#160;__builtin_arm_wfe</td>
 320         </tr>
 321       </table>
 322 </div><div class="memdoc">
 323
 324 <p>Wait For Event. </p>
 325 <p>Wait For Event is a hint instruction that permits the processor to enter a low-power state until one of a number of events occurs.</p>
 326 <p>Wait For Event is a hint instruction that permits the processor to enter </p>
 327
 328 </div>
 329 </div>
 330 <a id="gad23bf2b78a9a4524157c9de0d30b7448" name="gad23bf2b78a9a4524157c9de0d30b7448"></a>
 331 <h2 class="memtitle"><span class="permalink"><a href="#gad23bf2b78a9a4524157c9de0d30b7448">&#9670;&#160;</a></span>__WFI</h2>
 332
 333 <div class="memitem">
 334 <div class="memproto">
 335       <table class="memname">
 336         <tr>
 337           <td class="memname">#define __WFI&#160;&#160;&#160;__builtin_arm_wfi</td>
 338         </tr>
 339       </table>
 340 </div><div class="memdoc">
 341
 342 <p>Wait For Interrupt. </p>
 343 <p>Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs. </p>
 344
 345 </div>
 346 </div>
 347 <h2 class="groupheader">Function Documentation</h2>
 348 <a id="ga90884c591ac5d73d6069334eba9d6c02" name="ga90884c591ac5d73d6069334eba9d6c02"></a>
 349 <h2 class="memtitle"><span class="permalink"><a href="#ga90884c591ac5d73d6069334eba9d6c02">&#9670;&#160;</a></span>__CLZ()</h2>
 350
 351 <div class="memitem">
 352 <div class="memproto">
 353       <table class="memname">
 354         <tr>
 355           <td class="memname">uint8_t __CLZ </td>
 356           <td>(</td>
 357           <td class="paramtype">uint32_t&#160;</td>
 358           <td class="paramname"><em>value</em></td><td>)</td>
 359           <td></td>
 360         </tr>
 361       </table>
 362 </div><div class="memdoc">
 363
 364 <p>Count leading zeros. </p>
 365 <p>Counts the number of leading zeros of a data value. </p><dl class="params"><dt>Parameters</dt><dd>
 366   <table class="params">
 367     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to count the leading zeros </td></tr>
 368   </table>
 369   </dd>
 370 </dl>
 371 <dl class="section return"><dt>Returns</dt><dd>number of leading zeros in value </dd></dl>
 372
 373 </div>
 374 </div>
 375 <a id="gad6f9f297f6b91a995ee199fbc796b863" name="gad6f9f297f6b91a995ee199fbc796b863"></a>
 376 <h2 class="memtitle"><span class="permalink"><a href="#gad6f9f297f6b91a995ee199fbc796b863">&#9670;&#160;</a></span>__RBIT()</h2>
 377
 378 <div class="memitem">
 379 <div class="memproto">
 380       <table class="memname">
 381         <tr>
 382           <td class="memname">uint32_t __RBIT </td>
 383           <td>(</td>
 384           <td class="paramtype">uint32_t&#160;</td>
 385           <td class="paramname"><em>value</em></td><td>)</td>
 386           <td></td>
 387         </tr>
 388       </table>
 389 </div><div class="memdoc">
 390
 391 <p>Reverse bit order of value. </p>
 392 <p>Reverses the bit order of the given value. </p><dl class="params"><dt>Parameters</dt><dd>
 393   <table class="params">
 394     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 395   </table>
 396   </dd>
 397 </dl>
 398 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 399
 400 </div>
 401 </div>
 402 <a id="ga4717abc17af5ba29b1e4c055e0a0d9b8" name="ga4717abc17af5ba29b1e4c055e0a0d9b8"></a>
 403 <h2 class="memtitle"><span class="permalink"><a href="#ga4717abc17af5ba29b1e4c055e0a0d9b8">&#9670;&#160;</a></span>__REV()</h2>
 404
 405 <div class="memitem">
 406 <div class="memproto">
 407       <table class="memname">
 408         <tr>
 409           <td class="memname">uint32_t __REV </td>
 410           <td>(</td>
 411           <td class="paramtype">uint32_t&#160;</td>
 412           <td class="paramname"><em>value</em></td><td>)</td>
 413           <td></td>
 414         </tr>
 415       </table>
 416 </div><div class="memdoc">
 417
 418 <p>Reverse byte order (32 bit) </p>
 419 <p>Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412. </p><dl class="params"><dt>Parameters</dt><dd>
 420   <table class="params">
 421     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 422   </table>
 423   </dd>
 424 </dl>
 425 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 426
 427 </div>
 428 </div>
 429 <a id="ga926d702cf1de59d54f4e62ab8e3c8b8d" name="ga926d702cf1de59d54f4e62ab8e3c8b8d"></a>
 430 <h2 class="memtitle"><span class="permalink"><a href="#ga926d702cf1de59d54f4e62ab8e3c8b8d">&#9670;&#160;</a></span>__REV16()</h2>
 431
 432 <div class="memitem">
 433 <div class="memproto">
 434       <table class="memname">
 435         <tr>
 436           <td class="memname">uint16_t __REV16 </td>
 437           <td>(</td>
 438           <td class="paramtype">uint16_t&#160;</td>
 439           <td class="paramname"><em>value</em></td><td>)</td>
 440           <td></td>
 441         </tr>
 442       </table>
 443 </div><div class="memdoc">
 444
 445 <p>Reverse byte order (16 bit) </p>
 446 <p>Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856. </p><dl class="params"><dt>Parameters</dt><dd>
 447   <table class="params">
 448     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 449   </table>
 450   </dd>
 451 </dl>
 452 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 453
 454 </div>
 455 </div>
 456 <a id="ga1ec006e6d79063363cb0c2a2e0b3adbe" name="ga1ec006e6d79063363cb0c2a2e0b3adbe"></a>
 457 <h2 class="memtitle"><span class="permalink"><a href="#ga1ec006e6d79063363cb0c2a2e0b3adbe">&#9670;&#160;</a></span>__REVSH()</h2>
 458
 459 <div class="memitem">
 460 <div class="memproto">
 461       <table class="memname">
 462         <tr>
 463           <td class="memname">int32_t __REVSH </td>
 464           <td>(</td>
 465           <td class="paramtype">int32_t&#160;</td>
 466           <td class="paramname"><em>value</em></td><td>)</td>
 467           <td></td>
 468         </tr>
 469       </table>
 470 </div><div class="memdoc">
 471
 472 <p>Reverse byte order (16 bit) </p>
 473 <p>Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000. </p><dl class="params"><dt>Parameters</dt><dd>
 474   <table class="params">
 475     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 476   </table>
 477   </dd>
 478 </dl>
 479 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 480
 481 </div>
 482 </div>
 483 <a id="gae05c1a2dac5bb7a399420c804c3048ca" name="gae05c1a2dac5bb7a399420c804c3048ca"></a>
 484 <h2 class="memtitle"><span class="permalink"><a href="#gae05c1a2dac5bb7a399420c804c3048ca">&#9670;&#160;</a></span>__ROR()</h2>
 485
 486 <div class="memitem">
 487 <div class="memproto">
 488       <table class="memname">
 489         <tr>
 490           <td class="memname">uint32_t __ROR </td>
 491           <td>(</td>
 492           <td class="paramtype">uint32_t&#160;</td>
 493           <td class="paramname"><em>op1</em>, </td>
 494         </tr>
 495         <tr>
 496           <td class="paramkey"></td>
 497           <td></td>
 498           <td class="paramtype">uint32_t&#160;</td>
 499           <td class="paramname"><em>op2</em>&#160;</td>
 500         </tr>
 501         <tr>
 502           <td></td>
 503           <td>)</td>
 504           <td></td><td></td>
 505         </tr>
 506       </table>
 507 </div><div class="memdoc">
 508
 509 <p>Rotate Right in unsigned value (32 bit) </p>
 510 <p>Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits. </p><dl class="params"><dt>Parameters</dt><dd>
 511   <table class="params">
 512     <tr><td class="paramdir">[in]</td><td class="paramname">op1</td><td>Value to rotate </td></tr>
 513     <tr><td class="paramdir">[in]</td><td class="paramname">op2</td><td>Number of Bits to rotate </td></tr>
 514   </table>
 515   </dd>
 516 </dl>
 517 <dl class="section return"><dt>Returns</dt><dd>Rotated value </dd></dl>
 518
 519 </div>
 520 </div>
 521 </div><!-- contents -->
 522 </div><!-- doc-content -->
 523 <!-- start footer part -->
 524 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 525   <ul>
 526     <li class="footer">
 527       <script type="text/javascript">
 528         <!--
 529         writeFooter.call(this);
 530         //-->
 531       </script>
 532     </li>
 533   </ul>
 534 </div>
 535 </body>
 536 </html>