web/docs/hazard3_8h.html

   1 <!-- HTML header for doxygen 1.8.20-->
   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">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/hardware/hazard3.h File Reference</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('hazard3_8h.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#define-members">Macros</a>  </div>
 107   <div class="headertitle"><div class="title">hazard3.h File Reference</div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 111 <code>#include &quot;<a class="el" href="riscv_8h_source.html">hardware/riscv.h</a>&quot;</code><br />
 112 <code>#include &quot;hardware/regs/rvcsr.h&quot;</code><br />
 113 </div><div class="textblock"><div class="dynheader">
 114 Include dependency graph for hazard3.h:</div>
 115 <div class="dyncontent">
 116 <div class="center"><img src="hazard3_8h__incl.png" border="0" usemap="#ainclude_2hardware_2hazard3_8h" alt=""/></div>
 117 <map name="ainclude_2hardware_2hazard3_8h" id="ainclude_2hardware_2hazard3_8h">
 118 <area shape="rect" title=" " alt="" coords="409,5,611,32"/>
 119 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="411,155,473,181"/>
 120 <area shape="rect" href="riscv_8h.html" title=" " alt="" coords="445,80,575,107"/>
 121 <area shape="rect" title=" " alt="" coords="514,155,677,181"/>
 122 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,379,259,405"/>
 123 <area shape="rect" title=" " alt="" coords="252,229,365,256"/>
 124 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="390,229,494,256"/>
 125 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,229,717,256"/>
 126 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,229,836,256"/>
 127 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,453,111,480"/>
 128 <area shape="rect" title=" " alt="" coords="74,528,157,555"/>
 129 <area shape="rect" title=" " alt="" coords="211,453,281,480"/>
 130 <area shape="rect" title=" " alt="" coords="306,453,381,480"/>
 131 <area shape="rect" title=" " alt="" coords="173,304,337,331"/>
 132 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,304,543,331"/>
 133 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,304,746,331"/>
 134 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,304,930,331"/>
 135 <area shape="rect" title=" " alt="" coords="954,304,1165,331"/>
 136 <area shape="rect" title=" " alt="" coords="1189,304,1340,331"/>
 137 <area shape="rect" title=" " alt="" coords="357,379,548,405"/>
 138 </map>
 139 </div>
 140 </div>
 141 <p><a href="hazard3_8h_source.html">Go to the source code of this file.</a></p>
 142 <table class="memberdecls">
 143 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 144 Macros</h2></td></tr>
 145 <tr class="memitem:ae9895c66b2defc029b71a0e485267f11"><td class="memItemLeft" align="right" valign="top"><a id="ae9895c66b2defc029b71a0e485267f11" name="ae9895c66b2defc029b71a0e485267f11"></a>
 146 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_extension_xh3power</b></td></tr>
 147 <tr class="separator:ae9895c66b2defc029b71a0e485267f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:a011a21bf38d8fc9d17a28130cdf43847"><td class="memItemLeft" align="right" valign="top"><a id="a011a21bf38d8fc9d17a28130cdf43847" name="a011a21bf38d8fc9d17a28130cdf43847"></a>
 149 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_extension_xh3bextm</b></td></tr>
 150 <tr class="separator:a011a21bf38d8fc9d17a28130cdf43847"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:a64dcdecbc4977425fca4fa9641c6e68f"><td class="memItemLeft" align="right" valign="top"><a id="a64dcdecbc4977425fca4fa9641c6e68f" name="a64dcdecbc4977425fca4fa9641c6e68f"></a>
 152 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_extension_xh3irq</b></td></tr>
 153 <tr class="separator:a64dcdecbc4977425fca4fa9641c6e68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:abce417faa621efafd5d0b417744b8191"><td class="memItemLeft" align="right" valign="top"><a id="abce417faa621efafd5d0b417744b8191" name="abce417faa621efafd5d0b417744b8191"></a>
 155 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_extension_xh3pmpm</b></td></tr>
 156 <tr class="separator:abce417faa621efafd5d0b417744b8191"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:acd761061485e7ebd4637d8317ed295e7"><td class="memItemLeft" align="right" valign="top"><a id="acd761061485e7ebd4637d8317ed295e7" name="acd761061485e7ebd4637d8317ed295e7"></a>
 158 #define&#160;</td><td class="memItemRight" valign="bottom"><b>hazard3_irqarray_read</b>(csr,  index)&#160;&#160;&#160;(riscv_read_set_csr(csr, (index)) &gt;&gt; 16)</td></tr>
 159 <tr class="separator:acd761061485e7ebd4637d8317ed295e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:aad89690e9061a1dd63a0b6b7072f1d56"><td class="memItemLeft" align="right" valign="top"><a id="aad89690e9061a1dd63a0b6b7072f1d56" name="aad89690e9061a1dd63a0b6b7072f1d56"></a>
 161 #define&#160;</td><td class="memItemRight" valign="bottom"><b>hazard3_irqarray_write</b>(csr,  index,  data)&#160;&#160;&#160;(riscv_write_csr(csr, (index) | ((uint32_t)(data) &lt;&lt; 16)))</td></tr>
 162 <tr class="separator:aad89690e9061a1dd63a0b6b7072f1d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:a5d084dd6af165cf78ffef3c41ba237af"><td class="memItemLeft" align="right" valign="top"><a id="a5d084dd6af165cf78ffef3c41ba237af" name="a5d084dd6af165cf78ffef3c41ba237af"></a>
 164 #define&#160;</td><td class="memItemRight" valign="bottom"><b>hazard3_irqarray_set</b>(csr,  index,  data)&#160;&#160;&#160;(riscv_set_csr(csr, (index) | ((uint32_t)(data) &lt;&lt; 16)))</td></tr>
 165 <tr class="separator:a5d084dd6af165cf78ffef3c41ba237af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:a9424fec1ed71548aef9cefdc6eda62a0"><td class="memItemLeft" align="right" valign="top"><a id="a9424fec1ed71548aef9cefdc6eda62a0" name="a9424fec1ed71548aef9cefdc6eda62a0"></a>
 167 #define&#160;</td><td class="memItemRight" valign="bottom"><b>hazard3_irqarray_clear</b>(csr,  index,  data)&#160;&#160;&#160;(riscv_clear_csr(csr, (index) | ((uint32_t)(data) &lt;&lt; 16)))</td></tr>
 168 <tr class="separator:a9424fec1ed71548aef9cefdc6eda62a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:a6d8ac7d839588d3b7523fa782f803599"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hazard3_8h.html#a6d8ac7d839588d3b7523fa782f803599">__hazard3_bextm</a>(nbits,  rs1,  rs2)</td></tr>
 170 <tr class="separator:a6d8ac7d839588d3b7523fa782f803599"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:a7f03f11deee59c515b3f79856a65314f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hazard3_8h.html#a7f03f11deee59c515b3f79856a65314f">__hazard3_bextmi</a>(nbits,  rs1,  shamt)</td></tr>
 172 <tr class="separator:a7f03f11deee59c515b3f79856a65314f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:a176212b3202c09d8393033f92f75c30c"><td class="memItemLeft" align="right" valign="top"><a id="a176212b3202c09d8393033f92f75c30c" name="a176212b3202c09d8393033f92f75c30c"></a>
 174 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_block</b>()&#160;&#160;&#160;asm volatile (&quot;slt x0, x0, x0&quot; : : : &quot;memory&quot;)</td></tr>
 175 <tr class="separator:a176212b3202c09d8393033f92f75c30c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:ab05ce2878e6de823c43cdac42d01d900"><td class="memItemLeft" align="right" valign="top"><a id="ab05ce2878e6de823c43cdac42d01d900" name="ab05ce2878e6de823c43cdac42d01d900"></a>
 177 #define&#160;</td><td class="memItemRight" valign="bottom"><b>__hazard3_unblock</b>()&#160;&#160;&#160;asm volatile (&quot;slt x0, x0, x1&quot; : : : &quot;memory&quot;)</td></tr>
 178 <tr class="separator:ab05ce2878e6de823c43cdac42d01d900"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 </table>
 180 <h2 class="groupheader">Macro Definition Documentation</h2>
 181 <a id="a6d8ac7d839588d3b7523fa782f803599" name="a6d8ac7d839588d3b7523fa782f803599"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#a6d8ac7d839588d3b7523fa782f803599">&#9670;&nbsp;</a></span>__hazard3_bextm</h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname">#define __hazard3_bextm</td>
 189           <td>(</td>
 190           <td class="paramtype">&#160;</td>
 191           <td class="paramname">nbits, </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype">&#160;</td>
 197           <td class="paramname">rs1, </td>
 198         </tr>
 199         <tr>
 200           <td class="paramkey"></td>
 201           <td></td>
 202           <td class="paramtype">&#160;</td>
 203           <td class="paramname">rs2&#160;</td>
 204         </tr>
 205         <tr>
 206           <td></td>
 207           <td>)</td>
 208           <td></td><td></td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212 <b>Value:</b><div class="fragment"><div class="line">    ({\</div>
 213 <div class="line">    uint32_t __h3_bextm_rd; \</div>
 214 <div class="line">    asm (<span class="stringliteral">&quot;.insn r 0x0b, 0, %3, %0, %1, %2&quot;</span>\</div>
 215 <div class="line">        : <span class="stringliteral">&quot;=r&quot;</span> (__h3_bextm_rd) \</div>
 216 <div class="line">        : <span class="stringliteral">&quot;r&quot;</span> (rs1), <span class="stringliteral">&quot;r&quot;</span> (rs2), <span class="stringliteral">&quot;i&quot;</span> ((((nbits) - 1) &amp; 0x7) &lt;&lt; 1)\</div>
 217 <div class="line">    ); \</div>
 218 <div class="line">    __h3_bextm_rd; \</div>
 219 <div class="line">})</div>
 220 </div><!-- fragment -->
 221 </div>
 222 </div>
 223 <a id="a7f03f11deee59c515b3f79856a65314f" name="a7f03f11deee59c515b3f79856a65314f"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#a7f03f11deee59c515b3f79856a65314f">&#9670;&nbsp;</a></span>__hazard3_bextmi</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">#define __hazard3_bextmi</td>
 231           <td>(</td>
 232           <td class="paramtype">&#160;</td>
 233           <td class="paramname">nbits, </td>
 234         </tr>
 235         <tr>
 236           <td class="paramkey"></td>
 237           <td></td>
 238           <td class="paramtype">&#160;</td>
 239           <td class="paramname">rs1, </td>
 240         </tr>
 241         <tr>
 242           <td class="paramkey"></td>
 243           <td></td>
 244           <td class="paramtype">&#160;</td>
 245           <td class="paramname">shamt&#160;</td>
 246         </tr>
 247         <tr>
 248           <td></td>
 249           <td>)</td>
 250           <td></td><td></td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254 <b>Value:</b><div class="fragment"><div class="line">    ({\</div>
 255 <div class="line">    uint32_t __h3_bextmi_rd; \</div>
 256 <div class="line">    asm (<span class="stringliteral">&quot;.insn i 0x0b, 0x4, %0, %1, %2&quot;</span>\</div>
 257 <div class="line">        : <span class="stringliteral">&quot;=r&quot;</span> (__h3_bextmi_rd) \</div>
 258 <div class="line">        : <span class="stringliteral">&quot;r&quot;</span> (rs1), <span class="stringliteral">&quot;i&quot;</span> ((((nbits) - 1) &amp; 0x7) &lt;&lt; 6 | ((shamt) &amp; 0x1f)) \</div>
 259 <div class="line">    ); \</div>
 260 <div class="line">    __h3_bextmi_rd; \</div>
 261 <div class="line">})</div>
 262 </div><!-- fragment -->
 263 </div>
 264 </div>
 265 </div><!-- contents -->
 266 </div><!-- doc-content -->
 267
 268         <script src="main.js"></script>
 269 </body>
 270 </html>