web/docs/riscv__platform__timer_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/hardware/riscv_platform_timer.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('riscv__platform__timer_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">riscv_platform_timer.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="riscv__platform__timer_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="preprocessor">#ifndef _HARDWARE_RISCV_PLATFORM_TIMER_</span></div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define _HARDWARE_RISCV_PLATFORM_TIMER_</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="preprocessor">#endif</span></div>
 114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span> </div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include &quot;hardware/structs/sio.h&quot;</span></div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
 118 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#ga2afc7ae3feafc019abd3883a3f2fe04f">   33</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#ga2afc7ae3feafc019abd3883a3f2fe04f">riscv_timer_set_enabled</a>(<span class="keywordtype">bool</span> enabled) {</div>
 119 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <span class="keywordflow">if</span> (enabled) {</div>
 120 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>        <span class="comment">// Note atomic rwtype is not supported on SIO</span></div>
 121 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>        sio_hw-&gt;mtime_ctrl |=  SIO_MTIME_CTRL_EN_BITS;</div>
 122 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    } <span class="keywordflow">else</span> {</div>
 123 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>        sio_hw-&gt;mtime_ctrl &amp;= ~SIO_MTIME_CTRL_EN_BITS;</div>
 124 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    }</div>
 125 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>}</div>
 126 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
 127 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#gacdd646c3b36c51473a16c07a799f9eec">   49</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#gacdd646c3b36c51473a16c07a799f9eec">riscv_timer_set_fullspeed</a>(<span class="keywordtype">bool</span> fullspeed) {</div>
 128 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>    <span class="keywordflow">if</span> (fullspeed) {</div>
 129 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>        sio_hw-&gt;mtime_ctrl |=  SIO_MTIME_CTRL_FULLSPEED_BITS;</div>
 130 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    } <span class="keywordflow">else</span> {</div>
 131 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>        sio_hw-&gt;mtime_ctrl &amp;= ~SIO_MTIME_CTRL_FULLSPEED_BITS;</div>
 132 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    }</div>
 133 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>}</div>
 134 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
 135 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#gab016600bb8fc7553da83a90501371693">   62</a></span><span class="keyword">static</span> <span class="keyword">inline</span> uint64_t <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#gab016600bb8fc7553da83a90501371693">riscv_timer_get_mtime</a>(<span class="keywordtype">void</span>) {</div>
 136 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <span class="comment">// Read procedure from RISC-V ISA manual to avoid being off by 2**32 on</span></div>
 137 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    <span class="comment">// low half rollover -- note this loop generally executes only once, and</span></div>
 138 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>    <span class="comment">// should never execute more than twice:</span></div>
 139 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>    uint32_t h0, l, h1;</div>
 140 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    <span class="keywordflow">do</span> {</div>
 141 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>        h0 = sio_hw-&gt;mtimeh;</div>
 142 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>        l  = sio_hw-&gt;mtime;</div>
 143 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>        h1 = sio_hw-&gt;mtimeh;</div>
 144 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>    } <span class="keywordflow">while</span> (h0 != h1);</div>
 145 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    <span class="keywordflow">return</span> l | (uint64_t)h1 &lt;&lt; 32;</div>
 146 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>}</div>
 147 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
 148 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#ga96285c497dceb9126e6ea3130be72bcb">   85</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#ga96285c497dceb9126e6ea3130be72bcb">riscv_timer_set_mtime</a>(uint64_t mtime) {</div>
 149 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>    <span class="comment">// This ought really only be done when the timer is stopped, but we can</span></div>
 150 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>    <span class="comment">// make things a bit safer by clearing the low half of the counter, then</span></div>
 151 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>    <span class="comment">// writing high half, then low half. This protects against the low half</span></div>
 152 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    <span class="comment">// rolling over, and largely avoids getting an intermediate value that is</span></div>
 153 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>    <span class="comment">// higher than either the original or new value, if the timer is running.</span></div>
 154 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>    <span class="comment">//</span></div>
 155 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>    <span class="comment">// Note that on RP2350, mtime is shared between the two cores!(mtimcemp is</span></div>
 156 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>    <span class="comment">// core-local however.)</span></div>
 157 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>    sio_hw-&gt;mtime  = 0;</div>
 158 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    sio_hw-&gt;mtimeh = mtime &gt;&gt; 32;</div>
 159 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    sio_hw-&gt;mtime  = mtime &amp; 0xffffffffu;</div>
 160 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>}</div>
 161 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
 162 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#ga148695c3ff3dce3222934040cfc77d91">  108</a></span><span class="keyword">static</span> <span class="keyword">inline</span> uint64_t <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#ga148695c3ff3dce3222934040cfc77d91">riscv_timer_get_mtimecmp</a>(<span class="keywordtype">void</span>) {</div>
 163 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    <span class="comment">// Use the same procedure as reading mtime, which should be safe assuming</span></div>
 164 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>    <span class="comment">// mtimecmp increases monotonically with successive interrupts.</span></div>
 165 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    uint32_t h0, l, h1;</div>
 166 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>    <span class="keywordflow">do</span> {</div>
 167 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>        h0 = sio_hw-&gt;mtimecmph;</div>
 168 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>        l  = sio_hw-&gt;mtimecmp;</div>
 169 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>        h1 = sio_hw-&gt;mtimecmph;</div>
 170 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>    } <span class="keywordflow">while</span> (h0 != h1);</div>
 171 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>    <span class="keywordflow">return</span> l | (uint64_t)h1 &lt;&lt; 32;</div>
 172 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>}</div>
 173 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span> </div>
 174 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="group__hardware__riscv__platform__timer.html#ga7003005e0d2142e95ce53f2ceee29fdd">  130</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__riscv__platform__timer.html#ga7003005e0d2142e95ce53f2ceee29fdd">riscv_timer_set_mtimecmp</a>(uint64_t mtimecmp) {</div>
 175 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>    <span class="comment">// Use write procedure from RISC-V ISA manual to avoid causing a spurious</span></div>
 176 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>    <span class="comment">// interrupt when updating the two halves of mtimecmp.</span></div>
 177 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>    <span class="comment">// No lower than original:</span></div>
 178 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    sio_hw-&gt;mtimecmp  = -1u;</div>
 179 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>    <span class="comment">// No lower than original, no lower than new (assuming new &gt;= original):</span></div>
 180 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>    sio_hw-&gt;mtimecmph = mtimecmp &gt;&gt; 32;</div>
 181 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>    <span class="comment">// Equal to new:</span></div>
 182 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>    sio_hw-&gt;mtimecmp  = mtimecmp &amp; 0xffffffffu;</div>
 183 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>}</div>
 184 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
 185 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 186 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>}</div>
 187 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="preprocessor">#endif</span></div>
 188 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
 189 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="preprocessor">#endif</span></div>
 190 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_ga148695c3ff3dce3222934040cfc77d91"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#ga148695c3ff3dce3222934040cfc77d91">riscv_timer_get_mtimecmp</a></div><div class="ttdeci">static uint64_t riscv_timer_get_mtimecmp(void)</div><div class="ttdoc">Get the current RISC-V platform timer mtimecmp value for this core.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:108</div></div>
 191 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_ga2afc7ae3feafc019abd3883a3f2fe04f"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#ga2afc7ae3feafc019abd3883a3f2fe04f">riscv_timer_set_enabled</a></div><div class="ttdeci">static void riscv_timer_set_enabled(bool enabled)</div><div class="ttdoc">Enable or disable the RISC-V platform timer.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:33</div></div>
 192 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_ga7003005e0d2142e95ce53f2ceee29fdd"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#ga7003005e0d2142e95ce53f2ceee29fdd">riscv_timer_set_mtimecmp</a></div><div class="ttdeci">static void riscv_timer_set_mtimecmp(uint64_t mtimecmp)</div><div class="ttdoc">Set a new RISC-V platform timer interrupt comparison value (mtimecmp) for this core.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:130</div></div>
 193 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_ga96285c497dceb9126e6ea3130be72bcb"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#ga96285c497dceb9126e6ea3130be72bcb">riscv_timer_set_mtime</a></div><div class="ttdeci">static void riscv_timer_set_mtime(uint64_t mtime)</div><div class="ttdoc">Update the RISC-V platform timer.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:85</div></div>
 194 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_gab016600bb8fc7553da83a90501371693"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#gab016600bb8fc7553da83a90501371693">riscv_timer_get_mtime</a></div><div class="ttdeci">static uint64_t riscv_timer_get_mtime(void)</div><div class="ttdoc">Read the RISC-V platform timer.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:62</div></div>
 195 <div class="ttc" id="agroup__hardware__riscv__platform__timer_html_gacdd646c3b36c51473a16c07a799f9eec"><div class="ttname"><a href="group__hardware__riscv__platform__timer.html#gacdd646c3b36c51473a16c07a799f9eec">riscv_timer_set_fullspeed</a></div><div class="ttdeci">static void riscv_timer_set_fullspeed(bool fullspeed)</div><div class="ttdoc">Configure the RISC-V platform timer to run at full system clock speed.</div><div class="ttdef"><b>Definition:</b> riscv_platform_timer.h:49</div></div>
 196 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 197 </div><!-- fragment --></div><!-- contents -->
 198 </div><!-- doc-content -->
 199
 200         <script src="main.js"></script>
 201 </body>
 202 </html>