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 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="tabs.js"></script>
  13 <script type="text/javascript" src="footer.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="resize.js"></script>
  17 <script type="text/javascript" src="navtreedata.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  24   $(document).ready(function() { init_search(); });
  25 /* @license-end */
  26 </script>
  27 <script type="text/javascript" src="darkmode_toggle.js"></script>
  28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
  32 <link href="version.css" rel="stylesheet" type="text/css"/>
  33 <script type="text/javascript" src="../../version.js"></script>
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 55px;">
  41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  43    <div id="projectname">CMSIS-Core (Cortex-A)
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
  53   </td>
  54    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  57           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  58                onfocus="searchBox.OnSearchFieldFocus(true)"
  59                onblur="searchBox.OnSearchFieldFocus(false)"
  60                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  61           </span><span class="right">
  62             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  63           </span>
  64         </div>
  65 </td>
  66   <!--END !PROJECT_NAME-->
  67  </tr>
  68  </tbody>
  69 </table>
  70 </div>
  71 <!-- end header part -->
  72 <div id="CMSISnav" class="tabs1">
  73   <ul class="tablist">
  74     <script type="text/javascript">
  75       writeComponentTabs.call(this);
  76     </script>
  77   </ul>
  78 </div>
  79 <script type="text/javascript">
  80   writeSubComponentTabs.call(this);
  81 </script>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__CMSIS__Core__InstructionInterface.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a> &#124;
 129 <a href="#func-members">Functions</a>  </div>
 130   <div class="headertitle"><div class="title">Intrinsic Functions</div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133
 134 <p>Functions that generate specific Cortex-A CPU Instructions.
 135 <a href="#details">More...</a></p>
 136 <table class="memberdecls">
 137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 138 Macros</h2></td></tr>
 139 <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>
 140 <tr class="memdesc:gabd585ddc865fb9b7f2493af1eee1a572"><td class="mdescLeft">&#160;</td><td class="mdescRight">No Operation.  <br /></td></tr>
 141 <tr class="separator:gabd585ddc865fb9b7f2493af1eee1a572"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <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>
 143 <tr class="memdesc:gad23bf2b78a9a4524157c9de0d30b7448"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait For Interrupt.  <br /></td></tr>
 144 <tr class="separator:gad23bf2b78a9a4524157c9de0d30b7448"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <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>
 146 <tr class="memdesc:gaac6cc7dd4325d9cb40d3290fa5244b3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait For Event.  <br /></td></tr>
 147 <tr class="separator:gaac6cc7dd4325d9cb40d3290fa5244b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <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>
 149 <tr class="memdesc:gaab4f296d0022b4b10dc0976eb22052f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send Event.  <br /></td></tr>
 150 <tr class="separator:gaab4f296d0022b4b10dc0976eb22052f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <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>
 152 <tr class="memdesc:gaad233022e850a009fc6f7602be1182f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instruction Synchronization Barrier.  <br /></td></tr>
 153 <tr class="separator:gaad233022e850a009fc6f7602be1182f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <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>
 155 <tr class="memdesc:ga067d257a2b34565410acefb5afef2203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data Synchronization Barrier.  <br /></td></tr>
 156 <tr class="separator:ga067d257a2b34565410acefb5afef2203"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <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>
 158 <tr class="memdesc:ga671101179b5943990785f36f8c1e2269"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data Memory Barrier.  <br /></td></tr>
 159 <tr class="separator:ga671101179b5943990785f36f8c1e2269"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <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>
 161 <tr class="memdesc:ga15ea6bd3c507d3e81c3b3a1258e46397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Breakpoint.  <br /></td></tr>
 162 <tr class="separator:ga15ea6bd3c507d3e81c3b3a1258e46397"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 </table><table class="memberdecls">
 164 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 165 Functions</h2></td></tr>
 166 <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>
 167 <tr class="memdesc:ga4717abc17af5ba29b1e4c055e0a0d9b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (32 bit)  <br /></td></tr>
 168 <tr class="separator:ga4717abc17af5ba29b1e4c055e0a0d9b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <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>
 170 <tr class="memdesc:ga926d702cf1de59d54f4e62ab8e3c8b8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (16 bit)  <br /></td></tr>
 171 <tr class="separator:ga926d702cf1de59d54f4e62ab8e3c8b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <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>
 173 <tr class="memdesc:ga1ec006e6d79063363cb0c2a2e0b3adbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse byte order (16 bit)  <br /></td></tr>
 174 <tr class="separator:ga1ec006e6d79063363cb0c2a2e0b3adbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <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>
 176 <tr class="memdesc:gae05c1a2dac5bb7a399420c804c3048ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotate Right in unsigned value (32 bit)  <br /></td></tr>
 177 <tr class="separator:gae05c1a2dac5bb7a399420c804c3048ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <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>
 179 <tr class="memdesc:gad6f9f297f6b91a995ee199fbc796b863"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverse bit order of value.  <br /></td></tr>
 180 <tr class="separator:gad6f9f297f6b91a995ee199fbc796b863"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <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>
 182 <tr class="memdesc:ga90884c591ac5d73d6069334eba9d6c02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Count leading zeros.  <br /></td></tr>
 183 <tr class="separator:ga90884c591ac5d73d6069334eba9d6c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 </table>
 185 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 186 <p>Functions that generate specific Cortex-A CPU Instructions. </p>
 187 <h2 class="groupheader">Macro Definition Documentation</h2>
 188 <a id="ga15ea6bd3c507d3e81c3b3a1258e46397" name="ga15ea6bd3c507d3e81c3b3a1258e46397"></a>
 189 <h2 class="memtitle"><span class="permalink"><a href="#ga15ea6bd3c507d3e81c3b3a1258e46397">&#9670;&#160;</a></span>__BKPT</h2>
 190
 191 <div class="memitem">
 192 <div class="memproto">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname">#define __BKPT</td>
 196           <td>(</td>
 197           <td class="paramtype">&#160;</td>
 198           <td class="paramname">value</td><td>)</td>
 199           <td>&#160;&#160;&#160;<a class="el" href="group__comp__cntrl__gr.html#ga1378040bcf22428955c6e3ce9c2053cd">__ASM</a> volatile (&quot;bkpt &quot;#value)</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Breakpoint. </p>
 205 <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>
 206   <table class="params">
 207     <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>
 208   </table>
 209   </dd>
 210 </dl>
 211 <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>
 212
 213 </div>
 214 </div>
 215 <a id="ga671101179b5943990785f36f8c1e2269" name="ga671101179b5943990785f36f8c1e2269"></a>
 216 <h2 class="memtitle"><span class="permalink"><a href="#ga671101179b5943990785f36f8c1e2269">&#9670;&#160;</a></span>__DMB</h2>
 217
 218 <div class="memitem">
 219 <div class="memproto">
 220       <table class="memname">
 221         <tr>
 222           <td class="memname">#define __DMB</td>
 223           <td>(</td>
 224           <td class="paramname"></td><td>)</td>
 225           <td>&#160;&#160;&#160;__builtin_arm_dmb(0xF)</td>
 226         </tr>
 227       </table>
 228 </div><div class="memdoc">
 229
 230 <p>Data Memory Barrier. </p>
 231 <p>Ensures the apparent order of the explicit memory operations before and after the instruction, without ensuring their completion. </p>
 232
 233 </div>
 234 </div>
 235 <a id="ga067d257a2b34565410acefb5afef2203" name="ga067d257a2b34565410acefb5afef2203"></a>
 236 <h2 class="memtitle"><span class="permalink"><a href="#ga067d257a2b34565410acefb5afef2203">&#9670;&#160;</a></span>__DSB</h2>
 237
 238 <div class="memitem">
 239 <div class="memproto">
 240       <table class="memname">
 241         <tr>
 242           <td class="memname">#define __DSB</td>
 243           <td>(</td>
 244           <td class="paramname"></td><td>)</td>
 245           <td>&#160;&#160;&#160;__builtin_arm_dsb(0xF)</td>
 246         </tr>
 247       </table>
 248 </div><div class="memdoc">
 249
 250 <p>Data Synchronization Barrier. </p>
 251 <p>Acts as a special kind of Data Memory Barrier. It completes when all explicit memory accesses before this instruction complete. </p>
 252
 253 </div>
 254 </div>
 255 <a id="gaad233022e850a009fc6f7602be1182f6" name="gaad233022e850a009fc6f7602be1182f6"></a>
 256 <h2 class="memtitle"><span class="permalink"><a href="#gaad233022e850a009fc6f7602be1182f6">&#9670;&#160;</a></span>__ISB</h2>
 257
 258 <div class="memitem">
 259 <div class="memproto">
 260       <table class="memname">
 261         <tr>
 262           <td class="memname">#define __ISB</td>
 263           <td>(</td>
 264           <td class="paramname"></td><td>)</td>
 265           <td>&#160;&#160;&#160;__builtin_arm_isb(0xF)</td>
 266         </tr>
 267       </table>
 268 </div><div class="memdoc">
 269
 270 <p>Instruction Synchronization Barrier. </p>
 271 <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>
 272
 273 </div>
 274 </div>
 275 <a id="gabd585ddc865fb9b7f2493af1eee1a572" name="gabd585ddc865fb9b7f2493af1eee1a572"></a>
 276 <h2 class="memtitle"><span class="permalink"><a href="#gabd585ddc865fb9b7f2493af1eee1a572">&#9670;&#160;</a></span>__NOP</h2>
 277
 278 <div class="memitem">
 279 <div class="memproto">
 280       <table class="memname">
 281         <tr>
 282           <td class="memname">#define __NOP&#160;&#160;&#160;__builtin_arm_nop</td>
 283         </tr>
 284       </table>
 285 </div><div class="memdoc">
 286
 287 <p>No Operation. </p>
 288 <p>No Operation does nothing. This instruction can be used for code alignment purposes. </p>
 289
 290 </div>
 291 </div>
 292 <a id="gaab4f296d0022b4b10dc0976eb22052f9" name="gaab4f296d0022b4b10dc0976eb22052f9"></a>
 293 <h2 class="memtitle"><span class="permalink"><a href="#gaab4f296d0022b4b10dc0976eb22052f9">&#9670;&#160;</a></span>__SEV</h2>
 294
 295 <div class="memitem">
 296 <div class="memproto">
 297       <table class="memname">
 298         <tr>
 299           <td class="memname">#define __SEV&#160;&#160;&#160;__builtin_arm_sev</td>
 300         </tr>
 301       </table>
 302 </div><div class="memdoc">
 303
 304 <p>Send Event. </p>
 305 <p>Send Event is a hint instruction. It causes an event to be signaled to the CPU. </p>
 306
 307 </div>
 308 </div>
 309 <a id="gaac6cc7dd4325d9cb40d3290fa5244b3d" name="gaac6cc7dd4325d9cb40d3290fa5244b3d"></a>
 310 <h2 class="memtitle"><span class="permalink"><a href="#gaac6cc7dd4325d9cb40d3290fa5244b3d">&#9670;&#160;</a></span>__WFE</h2>
 311
 312 <div class="memitem">
 313 <div class="memproto">
 314       <table class="memname">
 315         <tr>
 316           <td class="memname">#define __WFE&#160;&#160;&#160;__builtin_arm_wfe</td>
 317         </tr>
 318       </table>
 319 </div><div class="memdoc">
 320
 321 <p>Wait For Event. </p>
 322 <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>
 323 <p>Wait For Event is a hint instruction that permits the processor to enter </p>
 324
 325 </div>
 326 </div>
 327 <a id="gad23bf2b78a9a4524157c9de0d30b7448" name="gad23bf2b78a9a4524157c9de0d30b7448"></a>
 328 <h2 class="memtitle"><span class="permalink"><a href="#gad23bf2b78a9a4524157c9de0d30b7448">&#9670;&#160;</a></span>__WFI</h2>
 329
 330 <div class="memitem">
 331 <div class="memproto">
 332       <table class="memname">
 333         <tr>
 334           <td class="memname">#define __WFI&#160;&#160;&#160;__builtin_arm_wfi</td>
 335         </tr>
 336       </table>
 337 </div><div class="memdoc">
 338
 339 <p>Wait For Interrupt. </p>
 340 <p>Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs. </p>
 341
 342 </div>
 343 </div>
 344 <h2 class="groupheader">Function Documentation</h2>
 345 <a id="ga90884c591ac5d73d6069334eba9d6c02" name="ga90884c591ac5d73d6069334eba9d6c02"></a>
 346 <h2 class="memtitle"><span class="permalink"><a href="#ga90884c591ac5d73d6069334eba9d6c02">&#9670;&#160;</a></span>__CLZ()</h2>
 347
 348 <div class="memitem">
 349 <div class="memproto">
 350       <table class="memname">
 351         <tr>
 352           <td class="memname">uint8_t __CLZ </td>
 353           <td>(</td>
 354           <td class="paramtype">uint32_t&#160;</td>
 355           <td class="paramname"><em>value</em></td><td>)</td>
 356           <td></td>
 357         </tr>
 358       </table>
 359 </div><div class="memdoc">
 360
 361 <p>Count leading zeros. </p>
 362 <p>Counts the number of leading zeros of a data value. </p><dl class="params"><dt>Parameters</dt><dd>
 363   <table class="params">
 364     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to count the leading zeros </td></tr>
 365   </table>
 366   </dd>
 367 </dl>
 368 <dl class="section return"><dt>Returns</dt><dd>number of leading zeros in value </dd></dl>
 369
 370 </div>
 371 </div>
 372 <a id="gad6f9f297f6b91a995ee199fbc796b863" name="gad6f9f297f6b91a995ee199fbc796b863"></a>
 373 <h2 class="memtitle"><span class="permalink"><a href="#gad6f9f297f6b91a995ee199fbc796b863">&#9670;&#160;</a></span>__RBIT()</h2>
 374
 375 <div class="memitem">
 376 <div class="memproto">
 377       <table class="memname">
 378         <tr>
 379           <td class="memname">uint32_t __RBIT </td>
 380           <td>(</td>
 381           <td class="paramtype">uint32_t&#160;</td>
 382           <td class="paramname"><em>value</em></td><td>)</td>
 383           <td></td>
 384         </tr>
 385       </table>
 386 </div><div class="memdoc">
 387
 388 <p>Reverse bit order of value. </p>
 389 <p>Reverses the bit order of the given value. </p><dl class="params"><dt>Parameters</dt><dd>
 390   <table class="params">
 391     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 392   </table>
 393   </dd>
 394 </dl>
 395 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 396
 397 </div>
 398 </div>
 399 <a id="ga4717abc17af5ba29b1e4c055e0a0d9b8" name="ga4717abc17af5ba29b1e4c055e0a0d9b8"></a>
 400 <h2 class="memtitle"><span class="permalink"><a href="#ga4717abc17af5ba29b1e4c055e0a0d9b8">&#9670;&#160;</a></span>__REV()</h2>
 401
 402 <div class="memitem">
 403 <div class="memproto">
 404       <table class="memname">
 405         <tr>
 406           <td class="memname">uint32_t __REV </td>
 407           <td>(</td>
 408           <td class="paramtype">uint32_t&#160;</td>
 409           <td class="paramname"><em>value</em></td><td>)</td>
 410           <td></td>
 411         </tr>
 412       </table>
 413 </div><div class="memdoc">
 414
 415 <p>Reverse byte order (32 bit) </p>
 416 <p>Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412. </p><dl class="params"><dt>Parameters</dt><dd>
 417   <table class="params">
 418     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 419   </table>
 420   </dd>
 421 </dl>
 422 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 423
 424 </div>
 425 </div>
 426 <a id="ga926d702cf1de59d54f4e62ab8e3c8b8d" name="ga926d702cf1de59d54f4e62ab8e3c8b8d"></a>
 427 <h2 class="memtitle"><span class="permalink"><a href="#ga926d702cf1de59d54f4e62ab8e3c8b8d">&#9670;&#160;</a></span>__REV16()</h2>
 428
 429 <div class="memitem">
 430 <div class="memproto">
 431       <table class="memname">
 432         <tr>
 433           <td class="memname">uint16_t __REV16 </td>
 434           <td>(</td>
 435           <td class="paramtype">uint16_t&#160;</td>
 436           <td class="paramname"><em>value</em></td><td>)</td>
 437           <td></td>
 438         </tr>
 439       </table>
 440 </div><div class="memdoc">
 441
 442 <p>Reverse byte order (16 bit) </p>
 443 <p>Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856. </p><dl class="params"><dt>Parameters</dt><dd>
 444   <table class="params">
 445     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 446   </table>
 447   </dd>
 448 </dl>
 449 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 450
 451 </div>
 452 </div>
 453 <a id="ga1ec006e6d79063363cb0c2a2e0b3adbe" name="ga1ec006e6d79063363cb0c2a2e0b3adbe"></a>
 454 <h2 class="memtitle"><span class="permalink"><a href="#ga1ec006e6d79063363cb0c2a2e0b3adbe">&#9670;&#160;</a></span>__REVSH()</h2>
 455
 456 <div class="memitem">
 457 <div class="memproto">
 458       <table class="memname">
 459         <tr>
 460           <td class="memname">int32_t __REVSH </td>
 461           <td>(</td>
 462           <td class="paramtype">int32_t&#160;</td>
 463           <td class="paramname"><em>value</em></td><td>)</td>
 464           <td></td>
 465         </tr>
 466       </table>
 467 </div><div class="memdoc">
 468
 469 <p>Reverse byte order (16 bit) </p>
 470 <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>
 471   <table class="params">
 472     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to reverse </td></tr>
 473   </table>
 474   </dd>
 475 </dl>
 476 <dl class="section return"><dt>Returns</dt><dd>Reversed value </dd></dl>
 477
 478 </div>
 479 </div>
 480 <a id="gae05c1a2dac5bb7a399420c804c3048ca" name="gae05c1a2dac5bb7a399420c804c3048ca"></a>
 481 <h2 class="memtitle"><span class="permalink"><a href="#gae05c1a2dac5bb7a399420c804c3048ca">&#9670;&#160;</a></span>__ROR()</h2>
 482
 483 <div class="memitem">
 484 <div class="memproto">
 485       <table class="memname">
 486         <tr>
 487           <td class="memname">uint32_t __ROR </td>
 488           <td>(</td>
 489           <td class="paramtype">uint32_t&#160;</td>
 490           <td class="paramname"><em>op1</em>, </td>
 491         </tr>
 492         <tr>
 493           <td class="paramkey"></td>
 494           <td></td>
 495           <td class="paramtype">uint32_t&#160;</td>
 496           <td class="paramname"><em>op2</em>&#160;</td>
 497         </tr>
 498         <tr>
 499           <td></td>
 500           <td>)</td>
 501           <td></td><td></td>
 502         </tr>
 503       </table>
 504 </div><div class="memdoc">
 505
 506 <p>Rotate Right in unsigned value (32 bit) </p>
 507 <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>
 508   <table class="params">
 509     <tr><td class="paramdir">[in]</td><td class="paramname">op1</td><td>Value to rotate </td></tr>
 510     <tr><td class="paramdir">[in]</td><td class="paramname">op2</td><td>Number of Bits to rotate </td></tr>
 511   </table>
 512   </dd>
 513 </dl>
 514 <dl class="section return"><dt>Returns</dt><dd>Rotated value </dd></dl>
 515
 516 </div>
 517 </div>
 518 </div><!-- contents -->
 519 </div><!-- doc-content -->
 520 <!-- start footer part -->
 521 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 522   <ul>
 523     <li class="footer">
 524       <script type="text/javascript">
 525         <!--
 526         writeFooter.call(this);
 527         //-->
 528       </script>
 529     </li>
 530   </ul>
 531 </div>
 532 </body>
 533 </html>