web/docs/platform_8h_source.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/pico/platform.h Source File</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('platform_8h_source.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="headertitle"><div class="title">platform.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="platform_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
 114 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#ifndef _PICO_PLATFORM_H</span></div>
 115 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="preprocessor">#define _PICO_PLATFORM_H</span></div>
 116 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
 117 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#ifndef _PICO_H</span></div>
 118 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#error pico/platform.h should not be included directly; include pico.h instead</span></div>
 119 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#endif</span></div>
 120 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
 121 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;pico/platform/compiler.h&quot;</span></div>
 122 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;pico/platform/sections.h&quot;</span></div>
 123 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;pico/platform/panic.h&quot;</span></div>
 124 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;hardware/regs/addressmap.h&quot;</span></div>
 125 <div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;hardware/regs/sio.h&quot;</span></div>
 126 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#ifdef __riscv</span></div>
 127 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;hardware/regs/rvcsr.h&quot;</span></div>
 128 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#endif</span></div>
 129 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
 130 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">// PICO_CONFIG: PICO_RP2350A, Whether the current board has an RP2350 in an A (30 GPIO) package, type=bool, default=Usually provided via board header, group=pico_platform</span></div>
 131 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
 132 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">// PICO_CONFIG: PICO_STACK_SIZE, Minimum amount of stack space reserved in the linker script for each core. See also PICO_CORE1_STACK_SIZE, min=0x100, default=0x800, advanced=true, group=pico_platform</span></div>
 133 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#ifndef PICO_STACK_SIZE</span></div>
 134 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#define PICO_STACK_SIZE _u(0x800)</span></div>
 135 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#endif</span></div>
 136 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
 137 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">// PICO_CONFIG: PICO_HEAP_SIZE, Minimum amount of heap space reserved by the linker script, min=0x100, default=0x800, advanced=true, group=pico_platform</span></div>
 138 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="preprocessor">#ifndef PICO_HEAP_SIZE</span></div>
 139 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="preprocessor">#define PICO_HEAP_SIZE _u(0x800)</span></div>
 140 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">#endif</span></div>
 141 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
 142 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">// PICO_CONFIG: PICO_NO_RAM_VECTOR_TABLE, Enable/disable the RAM vector table, type=bool, default=0, advanced=true, group=pico_platform</span></div>
 143 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#ifndef PICO_NO_RAM_VECTOR_TABLE</span></div>
 144 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">#define PICO_NO_RAM_VECTOR_TABLE 0</span></div>
 145 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#endif</span></div>
 146 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
 147 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#ifndef PICO_RAM_VECTOR_TABLE_SIZE</span></div>
 148 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">#define PICO_RAM_VECTOR_TABLE_SIZE (VTABLE_FIRST_IRQ + NUM_IRQS)</span></div>
 149 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">#endif</span></div>
 150 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
 151 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">// PICO_CONFIG: PICO_USE_STACK_GUARDS, Enable/disable stack guards, type=bool, default=0, advanced=true, group=pico_platform</span></div>
 152 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#ifndef PICO_USE_STACK_GUARDS</span></div>
 153 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#define PICO_USE_STACK_GUARDS 0</span></div>
 154 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#endif</span></div>
 155 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
 156 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">#ifndef __ASSEMBLER__</span></div>
 157 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
 158 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">   67</a></span><span class="keyword">static</span> <a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a>(<span class="keywordtype">void</span>) {}</div>
 159 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
 160 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga49c4fc3b5d3fbe9f2f6f7bc500b9db4f">   83</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__platform.html#ga49c4fc3b5d3fbe9f2f6f7bc500b9db4f">busy_wait_at_least_cycles</a>(uint32_t minimum_cycles) {</div>
 161 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>    pico_default_asm_volatile (</div>
 162 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>#ifdef __riscv</div>
 163 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>            <span class="comment">// Note the range is halved on RISC-V due to signed comparison (no carry flag)</span></div>
 164 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>            <span class="stringliteral">&quot;.option push\n&quot;</span></div>
 165 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>            <span class="stringliteral">&quot;.option norvc\n&quot;</span> <span class="comment">// force 32 bit addi, so branch prediction guaranteed</span></div>
 166 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>            <span class="stringliteral">&quot;.p2align 2\n&quot;</span></div>
 167 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>            <span class="stringliteral">&quot;1: \n&quot;</span></div>
 168 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>            <span class="stringliteral">&quot;addi %0, %0, -2 \n&quot;</span></div>
 169 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>            <span class="stringliteral">&quot;bgez %0, 1b\n&quot;</span></div>
 170 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>            <span class="stringliteral">&quot;.option pop&quot;</span></div>
 171 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>#<span class="keywordflow">else</span></div>
 172 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="stringliteral">&quot;1: subs %0, #3\n&quot;</span></div>
 173 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    <span class="stringliteral">&quot;bcs 1b\n&quot;</span></div>
 174 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>#endif</div>
 175 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>    : <span class="stringliteral">&quot;+r&quot;</span> (minimum_cycles) : : <span class="stringliteral">&quot;cc&quot;</span>, <span class="stringliteral">&quot;memory&quot;</span></div>
 176 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>    );</div>
 177 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>}</div>
 178 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span> </div>
 179 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">// PICO_CONFIG: PICO_NO_FPGA_CHECK, Remove the FPGA platform check for small code size reduction, type=bool, default=platform dependent, advanced=true, group=pico_runtime</span></div>
 180 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#ifndef PICO_NO_FPGA_CHECK</span></div>
 181 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="preprocessor">#if !PICO_RP2040</span></div>
 182 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="preprocessor">#define PICO_NO_FPGA_CHECK 1</span></div>
 183 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#endif</span></div>
 184 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#endif</span></div>
 185 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span> </div>
 186 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">// PICO_CONFIG: PICO_NO_SIM_CHECK, Remove the SIM platform check for small code size reduction, type=bool, default=1, advanced=true, group=pico_runtime</span></div>
 187 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="preprocessor">#ifndef PICO_NO_SIM_CHECK</span></div>
 188 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="preprocessor">#define PICO_NO_SIM_CHECK 1</span></div>
 189 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#endif</span></div>
 190 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span> </div>
 191 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="preprocessor">#if PICO_NO_FPGA_CHECK</span></div>
 192 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> running_on_fpga(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> <span class="keyword">false</span>;}</div>
 193 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="preprocessor">#else</span></div>
 194 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="keywordtype">bool</span> running_on_fpga(<span class="keywordtype">void</span>);</div>
 195 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="preprocessor">#endif</span></div>
 196 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="preprocessor">#if PICO_NO_SIM_CHECK</span></div>
 197 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> running_in_sim(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> <span class="keyword">false</span>;}</div>
 198 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="preprocessor">#else</span></div>
 199 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="keywordtype">bool</span> running_in_sim(<span class="keywordtype">void</span>);</div>
 200 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="preprocessor">#endif</span></div>
 201 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span> </div>
 202 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga9837dbd9fd5cc43d4f0fc1f26d046955">  128</a></span><span class="keyword">static</span> <a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__platform.html#ga9837dbd9fd5cc43d4f0fc1f26d046955">__breakpoint</a>(<span class="keywordtype">void</span>) {</div>
 203 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#ifdef __riscv</span></div>
 204 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>    __asm (<span class="stringliteral">&quot;ebreak&quot;</span>);</div>
 205 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="preprocessor">#else</span></div>
 206 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>    pico_default_asm_volatile (<span class="stringliteral">&quot;bkpt #0&quot;</span> : : : <span class="stringliteral">&quot;memory&quot;</span>);</div>
 207 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="preprocessor">#endif</span></div>
 208 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>}</div>
 209 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
 210 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga58434ad816f519308ee02c639b7965bc">  141</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> uint <a class="code hl_function" href="group__pico__platform.html#ga58434ad816f519308ee02c639b7965bc">get_core_num</a>(<span class="keywordtype">void</span>) {</div>
 211 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>    <span class="keywordflow">return</span> (*(uint32_t *) (SIO_BASE + SIO_CPUID_OFFSET));</div>
 212 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>}</div>
 213 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
 214 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga1ebeac462e038d7e2ce341df8054f894">  158</a></span><span class="keyword">static</span> <a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> uint <a class="code hl_function" href="group__pico__platform.html#ga1ebeac462e038d7e2ce341df8054f894">__get_current_exception</a>(<span class="keywordtype">void</span>) {</div>
 215 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="preprocessor">#ifdef __riscv</span></div>
 216 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>    uint32_t meicontext;</div>
 217 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>    pico_default_asm_volatile (</div>
 218 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>            <span class="stringliteral">&quot;csrr %0, %1\n&quot;</span></div>
 219 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>    : <span class="stringliteral">&quot;=r&quot;</span> (meicontext) : <span class="stringliteral">&quot;i&quot;</span> (RVCSR_MEICONTEXT_OFFSET)</div>
 220 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    );</div>
 221 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>    <span class="keywordflow">if</span> (meicontext &amp; RVCSR_MEICONTEXT_NOIRQ_BITS) {</div>
 222 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>        <span class="keywordflow">return</span> 0;</div>
 223 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>    } <span class="keywordflow">else</span> {</div>
 224 <div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>        <span class="keywordflow">return</span> VTABLE_FIRST_IRQ + (</div>
 225 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>                (meicontext &amp; RVCSR_MEICONTEXT_IRQ_BITS) &gt;&gt; RVCSR_MEICONTEXT_IRQ_LSB</div>
 226 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>        );</div>
 227 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>    }</div>
 228 <div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="preprocessor">#else</span></div>
 229 <div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>    uint exception;</div>
 230 <div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>    pico_default_asm_volatile (</div>
 231 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>        <span class="stringliteral">&quot;mrs %0, ipsr\n&quot;</span></div>
 232 <div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>        <span class="stringliteral">&quot;uxtb %0, %0\n&quot;</span></div>
 233 <div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>        : <span class="stringliteral">&quot;=l&quot;</span> (exception)</div>
 234 <div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>    );</div>
 235 <div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>    <span class="keywordflow">return</span> exception;</div>
 236 <div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="preprocessor">#endif</span></div>
 237 <div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>}</div>
 238 <div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
 239 <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga66edd7569f5a42b0a2da43a5926cf064">  188</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__pico__platform.html#ga66edd7569f5a42b0a2da43a5926cf064">pico_processor_state_is_nonsecure</a>(<span class="keywordtype">void</span>) {</div>
 240 <div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="preprocessor">#ifndef __riscv</span></div>
 241 <div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>    <span class="comment">// todo add a define to disable NS checking at all?</span></div>
 242 <div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>    <span class="comment">// IDAU-Exempt addresses return S=1 when tested in the Secure state,</span></div>
 243 <div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>    <span class="comment">// whereas executing a tt in the NonSecure state will always return S=0.</span></div>
 244 <div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>    uint32_t tt;</div>
 245 <div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>    pico_default_asm_volatile (</div>
 246 <div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>        <span class="stringliteral">&quot;movs %0, #0\n&quot;</span></div>
 247 <div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>        <span class="stringliteral">&quot;tt %0, %0\n&quot;</span></div>
 248 <div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>        : <span class="stringliteral">&quot;=r&quot;</span> (tt) : : <span class="stringliteral">&quot;cc&quot;</span></div>
 249 <div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span>    );</div>
 250 <div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>    <span class="keywordflow">return</span> !(tt &amp; (1u &lt;&lt; 22));</div>
 251 <div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="preprocessor">#else</span></div>
 252 <div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>    <span class="comment">// NonSecure is an Arm concept, there is nothing meaningful to return</span></div>
 253 <div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span>    <span class="comment">// here. Note it&#39;s not possible in general to detect whether you are</span></div>
 254 <div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>    <span class="comment">// executing in U-mode as, for example, M-mode is classically</span></div>
 255 <div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>    <span class="comment">// virtualisable in U-mode.</span></div>
 256 <div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
 257 <div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="preprocessor">#endif</span></div>
 258 <div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span>}</div>
 259 <div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span> </div>
 260 <div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="preprocessor">#define host_safe_hw_ptr(x) ((uintptr_t)(x))</span></div>
 261 <div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="preprocessor">#define native_safe_hw_ptr(x) host_safe_hw_ptr(x)</span></div>
 262 <div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span> </div>
 263 <div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>uint8_t <a class="code hl_function" href="group__pico__platform.html#ga21200eb89a299a9b121d028ad1725fe3">rp2350_chip_version</a>(<span class="keywordtype">void</span>);</div>
 264 <div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span> </div>
 265 <div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="group__pico__platform.html#gac157772e2fa6f4c64e1c3e4d761089d9">  222</a></span><span class="keyword">static</span> <span class="keyword">inline</span> uint8_t <a class="code hl_function" href="group__pico__platform.html#gac157772e2fa6f4c64e1c3e4d761089d9">rp2040_chip_version</a>(<span class="keywordtype">void</span>) {</div>
 266 <div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>    <span class="keywordflow">return</span> 2;</div>
 267 <div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span>}</div>
 268 <div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span> </div>
 269 <div class="line"><a id="l00230" name="l00230"></a><span class="lineno"><a class="line" href="group__pico__platform.html#gadcb55b507bb15fbe5a71bcb2f222b6e2">  230</a></span><span class="keyword">static</span> <span class="keyword">inline</span> uint8_t <a class="code hl_function" href="group__pico__platform.html#gadcb55b507bb15fbe5a71bcb2f222b6e2">rp2040_rom_version</a>(<span class="keywordtype">void</span>) {</div>
 270 <div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>    GCC_Pragma(<span class="stringliteral">&quot;GCC diagnostic push&quot;</span>)</div>
 271 <div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>    GCC_Pragma(<span class="stringliteral">&quot;GCC diagnostic ignored \&quot;-Warray-bounds\&quot;&quot;</span>)</div>
 272 <div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span>    <span class="keywordflow">return</span> *(uint8_t*)0x13;</div>
 273 <div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span>    GCC_Pragma(<span class="stringliteral">&quot;GCC diagnostic pop&quot;</span>)</div>
 274 <div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>}</div>
 275 <div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span> </div>
 276 <div class="line"><a id="l00247" name="l00247"></a><span class="lineno"><a class="line" href="group__pico__platform.html#gab68b1653c84bff361bff5dc2baf2e7ea">  247</a></span><a class="code hl_define" href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a> <span class="keyword">static</span> int32_t <a class="code hl_function" href="group__pico__platform.html#gab68b1653c84bff361bff5dc2baf2e7ea">__mul_instruction</a>(int32_t a, int32_t b) {</div>
 277 <div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="preprocessor">#ifdef __riscv</span></div>
 278 <div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>    __asm (<span class="stringliteral">&quot;mul %0, %0, %1&quot;</span> : <span class="stringliteral">&quot;+l&quot;</span> (a) : <span class="stringliteral">&quot;l&quot;</span> (b) : );</div>
 279 <div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="preprocessor">#else</span></div>
 280 <div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>    pico_default_asm (<span class="stringliteral">&quot;muls %0, %1&quot;</span>     : <span class="stringliteral">&quot;+l&quot;</span> (a) : <span class="stringliteral">&quot;l&quot;</span> (b) : <span class="stringliteral">&quot;cc&quot;</span>);</div>
 281 <div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="preprocessor">#endif</span></div>
 282 <div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span>    <span class="keywordflow">return</span> a;</div>
 283 <div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span>}</div>
 284 <div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span> </div>
 285 <div class="line"><a id="l00269" name="l00269"></a><span class="lineno"><a class="line" href="group__pico__platform.html#ga1f7eafa00361375ec15412f634ad67b7">  269</a></span><span class="preprocessor">#define __fast_mul(a, b) __builtin_choose_expr(__builtin_constant_p(b) &amp;&amp; !__builtin_constant_p(a), \</span></div>
 286 <div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="preprocessor">    (__builtin_popcount(b) &gt;= 2 ? __mul_instruction(a,b) : (a)*(b)), \</span></div>
 287 <div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="preprocessor">    (a)*(b))</span></div>
 288 <div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span> </div>
 289 <div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="preprocessor">#endif </span><span class="comment">// __ASSEMBLER__</span></div>
 290 <div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span> </div>
 291 <div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="preprocessor">#endif</span></div>
 292 <div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span> </div>
 293 <div class="ttc" id="agroup__pico__platform_html_ga1ebeac462e038d7e2ce341df8054f894"><div class="ttname"><a href="group__pico__platform.html#ga1ebeac462e038d7e2ce341df8054f894">__get_current_exception</a></div><div class="ttdeci">static __force_inline uint __get_current_exception(void)</div><div class="ttdoc">Get the current exception level on this core.</div><div class="ttdef"><b>Definition:</b> platform.h:158</div></div>
 294 <div class="ttc" id="agroup__pico__platform_html_ga21200eb89a299a9b121d028ad1725fe3"><div class="ttname"><a href="group__pico__platform.html#ga21200eb89a299a9b121d028ad1725fe3">rp2350_chip_version</a></div><div class="ttdeci">uint8_t rp2350_chip_version(void)</div><div class="ttdoc">Returns the RP2350 chip revision number.</div><div class="ttdef"><b>Definition:</b> platform.c:34</div></div>
 295 <div class="ttc" id="agroup__pico__platform_html_ga23eadd8d1642fb8fe4600708c36e116a"><div class="ttname"><a href="group__pico__platform.html#ga23eadd8d1642fb8fe4600708c36e116a">__force_inline</a></div><div class="ttdeci">#define __force_inline</div><div class="ttdoc">Attribute to force inlining of a function regardless of optimization level.</div><div class="ttdef"><b>Definition:</b> compiler.h:125</div></div>
 296 <div class="ttc" id="agroup__pico__platform_html_ga49c4fc3b5d3fbe9f2f6f7bc500b9db4f"><div class="ttname"><a href="group__pico__platform.html#ga49c4fc3b5d3fbe9f2f6f7bc500b9db4f">busy_wait_at_least_cycles</a></div><div class="ttdeci">static void busy_wait_at_least_cycles(uint32_t minimum_cycles)</div><div class="ttdoc">Helper method to busy-wait for at least the given number of cycles.</div><div class="ttdef"><b>Definition:</b> platform.h:83</div></div>
 297 <div class="ttc" id="agroup__pico__platform_html_ga58434ad816f519308ee02c639b7965bc"><div class="ttname"><a href="group__pico__platform.html#ga58434ad816f519308ee02c639b7965bc">get_core_num</a></div><div class="ttdeci">static __force_inline uint get_core_num(void)</div><div class="ttdoc">Get the current core number.</div><div class="ttdef"><b>Definition:</b> platform.h:141</div></div>
 298 <div class="ttc" id="agroup__pico__platform_html_ga66edd7569f5a42b0a2da43a5926cf064"><div class="ttname"><a href="group__pico__platform.html#ga66edd7569f5a42b0a2da43a5926cf064">pico_processor_state_is_nonsecure</a></div><div class="ttdeci">static __force_inline bool pico_processor_state_is_nonsecure(void)</div><div class="ttdoc">Return true if executing in the NonSecure state (Arm-only)</div><div class="ttdef"><b>Definition:</b> platform.h:188</div></div>
 299 <div class="ttc" id="agroup__pico__platform_html_ga9837dbd9fd5cc43d4f0fc1f26d046955"><div class="ttname"><a href="group__pico__platform.html#ga9837dbd9fd5cc43d4f0fc1f26d046955">__breakpoint</a></div><div class="ttdeci">static __force_inline void __breakpoint(void)</div><div class="ttdoc">Execute a breakpoint instruction.</div><div class="ttdef"><b>Definition:</b> platform.h:128</div></div>
 300 <div class="ttc" id="agroup__pico__platform_html_gab0d1ba75ceb64131e19f613d7a5313c9"><div class="ttname"><a href="group__pico__platform.html#gab0d1ba75ceb64131e19f613d7a5313c9">tight_loop_contents</a></div><div class="ttdeci">static __force_inline void tight_loop_contents(void)</div><div class="ttdoc">No-op function for the body of tight loops.</div><div class="ttdef"><b>Definition:</b> platform.h:67</div></div>
 301 <div class="ttc" id="agroup__pico__platform_html_gab68b1653c84bff361bff5dc2baf2e7ea"><div class="ttname"><a href="group__pico__platform.html#gab68b1653c84bff361bff5dc2baf2e7ea">__mul_instruction</a></div><div class="ttdeci">static __force_inline int32_t __mul_instruction(int32_t a, int32_t b)</div><div class="ttdoc">Multiply two integers using an assembly MUL instruction.</div><div class="ttdef"><b>Definition:</b> platform.h:247</div></div>
 302 <div class="ttc" id="agroup__pico__platform_html_gac157772e2fa6f4c64e1c3e4d761089d9"><div class="ttname"><a href="group__pico__platform.html#gac157772e2fa6f4c64e1c3e4d761089d9">rp2040_chip_version</a></div><div class="ttdeci">static uint8_t rp2040_chip_version(void)</div><div class="ttdoc">Returns the RP2040 chip revision number for compatibility.</div><div class="ttdef"><b>Definition:</b> platform.h:222</div></div>
 303 <div class="ttc" id="agroup__pico__platform_html_gadcb55b507bb15fbe5a71bcb2f222b6e2"><div class="ttname"><a href="group__pico__platform.html#gadcb55b507bb15fbe5a71bcb2f222b6e2">rp2040_rom_version</a></div><div class="ttdeci">static uint8_t rp2040_rom_version(void)</div><div class="ttdoc">Returns the RP2040 rom version number.</div><div class="ttdef"><b>Definition:</b> platform.h:230</div></div>
 304 </div><!-- fragment --></div><!-- contents -->
 305 </div><!-- doc-content -->
 306
 307         <script src="main.js"></script>
 308 </body>
 309 </html>