web/docs/rand_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/rand.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('rand_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">rand.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="rand_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) 2022 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="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _PICO_RAND_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_RAND_H</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#endif</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
 123 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">// ---------------</span></div>
 124 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">// ENTROPY SOURCES</span></div>
 125 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">// ---------------</span></div>
 126 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
 127 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">// PICO_CONFIG: PICO_RAND_ENTROPY_SRC_ROSC, Enable/disable use of ROSC as an entropy source, type=bool, default=1 if no hardware TRNG, group=pico_rand</span></div>
 128 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">#ifndef PICO_RAND_ENTROPY_SRC_ROSC</span></div>
 129 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">#if !HAS_RP2350_TRNG</span></div>
 130 <div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">#define PICO_RAND_ENTROPY_SRC_ROSC 1</span></div>
 131 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">#endif</span></div>
 132 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">#endif</span></div>
 133 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
 134 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">// PICO_CONFIG: PICO_RAND_ENTROPY_SRC_TRNG, Enable/disable use of hardware TRNG as an entropy source, type=bool, default=1 if no hardware TRNG, group=pico_rand</span></div>
 135 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="preprocessor">#ifndef PICO_RAND_ENTROPY_SRC_TRNG</span></div>
 136 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="preprocessor">#if HAS_RP2350_TRNG</span></div>
 137 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="preprocessor">#define PICO_RAND_ENTROPY_SRC_TRNG 1</span></div>
 138 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="preprocessor">#endif</span></div>
 139 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="preprocessor">#endif</span></div>
 140 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
 141 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">// PICO_CONFIG: PICO_RAND_ENTROPY_SRC_TIME, Enable/disable use of hardware timestamp as an entropy source, type=bool, default=1, group=pico_rand</span></div>
 142 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="preprocessor">#ifndef PICO_RAND_ENTROPY_SRC_TIME</span></div>
 143 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#define PICO_RAND_ENTROPY_SRC_TIME 1</span></div>
 144 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#endif</span></div>
 145 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span> </div>
 146 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">// PICO_CONFIG: PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER, Enable/disable use of a bus performance counter as an entropy source, type=bool, default=1 if no hardware TRNG, group=pico_rand</span></div>
 147 <div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="preprocessor">#ifndef PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER</span></div>
 148 <div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="preprocessor">#if !HAS_RP2350_TRNG</span></div>
 149 <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="preprocessor">#define PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER 1</span></div>
 150 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="preprocessor">#endif</span></div>
 151 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="preprocessor">#endif</span></div>
 152 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
 153 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">// --------------------</span></div>
 154 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">// SEED ENTROPY SOURCES</span></div>
 155 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">// --------------------</span></div>
 156 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span> </div>
 157 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_ROSC, Enable/disable use of ROSC as an entropy source for the random seed, type=bool, default=PICO_RAND_ENTROPY_SRC_ROSC, group=pico_rand</span></div>
 158 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_ROSC</span></div>
 159 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_ROSC PICO_RAND_ENTROPY_SRC_ROSC</span></div>
 160 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="preprocessor">#endif</span></div>
 161 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
 162 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_TRNG, Enable/disable use of hardware TRNG as an entropy source for the random seed, type=bool, default=PICO_RAND_ENTROPY_SRC_TRNG, group=pico_rand</span></div>
 163 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="preprocessor">#if !defined(PICO_RAND_SEED_ENTROPY_SRC_TRNG) &amp;&amp; HAS_RP2350_TRNG</span></div>
 164 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_TRNG PICO_RAND_ENTROPY_SRC_TRNG</span></div>
 165 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="preprocessor">#endif</span></div>
 166 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span> </div>
 167 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_TIME, Enable/disable use of hardware timestamp as an entropy source for the random seed, type=bool, default=PICO_RAND_ENTROPY_SRC_TIME, group=pico_rand</span></div>
 168 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_TIME</span></div>
 169 <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_TIME PICO_RAND_ENTROPY_SRC_TIME</span></div>
 170 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="preprocessor">#endif</span></div>
 171 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
 172 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_BUF_PERF_COUNTER, Enable/disable use of a bus performance counter as an entropy source for the random seed, type=bool, default=PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER, group=pico_rand</span></div>
 173 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_BUF_PERF_COUNTER</span></div>
 174 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_BUF_PERF_COUNTER PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER</span></div>
 175 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="preprocessor">#endif</span></div>
 176 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span> </div>
 177 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM, Enable/disable use of the per boot random number as an entropy source for the random seed, type=bool, default=0 on RP2040 which has none, group=pico_rand</span></div>
 178 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM</span></div>
 179 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="preprocessor">#if !PICO_RP2040</span></div>
 180 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM 1</span></div>
 181 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="preprocessor">#endif</span></div>
 182 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="preprocessor">#endif</span></div>
 183 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span> </div>
 184 <div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID, Enable/disable use of board id as part of the random seed, type=bool, default=not PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM, group=pico_rand</span></div>
 185 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID</span></div>
 186 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID (!PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM)</span></div>
 187 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="preprocessor">#endif</span></div>
 188 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span> </div>
 189 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">// PICO_CONFIG: PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH, Enable/disable use of a RAM hash as an entropy source for the random seed, type=bool, default=1 if no hardware TRNG, group=pico_rand</span></div>
 190 <div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="preprocessor">#ifndef PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH</span></div>
 191 <div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="preprocessor">#if !HAS_RP2350_TRNG</span></div>
 192 <div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="preprocessor">#define PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH 1</span></div>
 193 <div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="preprocessor">#endif</span></div>
 194 <div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="preprocessor">#endif</span></div>
 195 <div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span> </div>
 196 <div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">// ---------------------------------</span></div>
 197 <div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">// PICO_RAND_ENTROPY_SRC_ROSC CONFIG</span></div>
 198 <div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">// ---------------------------------</span></div>
 199 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span> </div>
 200 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">// PICO_CONFIG: PICO_RAND_ROSC_BIT_SAMPLE_COUNT, Number of samples to take of the ROSC random bit per random number generation , min=1, max=64, default=1, group=pico_rand</span></div>
 201 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="preprocessor">#ifndef PICO_RAND_ROSC_BIT_SAMPLE_COUNT</span></div>
 202 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="preprocessor">#define PICO_RAND_ROSC_BIT_SAMPLE_COUNT 1</span></div>
 203 <div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="preprocessor">#endif</span></div>
 204 <div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
 205 <div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">// PICO_CONFIG: PICO_RAND_MIN_ROSC_BIT_SAMPLE_TIME_US, Define a default minimum time between sampling the ROSC random bit, min=5, max=20, default=10, group=pico_rand</span></div>
 206 <div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="preprocessor">#ifndef PICO_RAND_MIN_ROSC_BIT_SAMPLE_TIME_US</span></div>
 207 <div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">// (Arbitrary / tested) minimum time between sampling the ROSC random bit</span></div>
 208 <div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="preprocessor">#define PICO_RAND_MIN_ROSC_BIT_SAMPLE_TIME_US 10u</span></div>
 209 <div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="preprocessor">#endif</span></div>
 210 <div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span> </div>
 211 <div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">// ---------------------------------------------</span></div>
 212 <div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">// PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER CONFIG</span></div>
 213 <div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">// ---------------------------------------------</span></div>
 214 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span> </div>
 215 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">// PICO_CONFIG: PICO_RAND_BUS_PERF_COUNTER_INDEX, Bus performance counter index to use for sourcing entropy, min=0, max=3, default=Undefined meaning pick one that is not counting any valid event already, group=pico_rand</span></div>
 216 <div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">// this is deliberately undefined by default, meaning the code will pick that appears unused</span></div>
 217 <div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="preprocessor">#if 0 </span><span class="comment">// make tooling checks happy</span></div>
 218 <div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="preprocessor">#define PICO_RAND_BUS_PERF_COUNTER_INDEX 0</span></div>
 219 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="preprocessor">#endif</span></div>
 220 <div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span> </div>
 221 <div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">// PICO_CONFIG: PICO_RAND_BUS_PERF_COUNTER_EVENT, Bus performance counter event to use for sourcing entropy, default=arbiter_sram5_perf_event_access, group=pico_rand</span></div>
 222 <div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="preprocessor">#ifndef PICO_RAND_BUS_PERF_COUNTER_EVENT</span></div>
 223 <div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="preprocessor">#define PICO_RAND_BUS_PERF_COUNTER_EVENT arbiter_sram5_perf_event_access</span></div>
 224 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="preprocessor">#endif</span></div>
 225 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span> </div>
 226 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">// ------------------------------------------</span></div>
 227 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">// PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH CONFIG</span></div>
 228 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">// ------------------------------------------</span></div>
 229 <div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span> </div>
 230 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">// PICO_CONFIG: PICO_RAND_RAM_HASH_END, End of address in RAM (non-inclusive) to hash during pico_rand seed initialization, default=SRAM_END, group=pico_rand</span></div>
 231 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="preprocessor">#ifndef PICO_RAND_RAM_HASH_END</span></div>
 232 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="preprocessor">#define PICO_RAND_RAM_HASH_END     SRAM_END</span></div>
 233 <div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="preprocessor">#endif</span></div>
 234 <div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">// PICO_CONFIG: PICO_RAND_RAM_HASH_START, Start of address in RAM (inclusive) to hash during pico_rand seed initialization, default=PICO_RAND_RAM_HASH_END - 1024, group=pico_rand</span></div>
 235 <div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="preprocessor">#ifndef PICO_RAND_RAM_HASH_START</span></div>
 236 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="preprocessor">#define PICO_RAND_RAM_HASH_START   (PICO_RAND_RAM_HASH_END - 1024u)</span></div>
 237 <div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="preprocessor">#endif</span></div>
 238 <div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span> </div>
 239 <div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">// We provide a maximum of 128 bits entropy in one go</span></div>
 240 <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"><a class="line" href="structrng__128.html">  179</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structrng__128.html">rng_128</a> {</div>
 241 <div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>    uint64_t r[2];</div>
 242 <div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>} <a class="code hl_struct" href="structrng__128.html">rng_128_t</a>;</div>
 243 <div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
 244 <div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__pico__rand.html#ga97a9544b527a3ba865ab70142bdd5d1b">get_rand_128</a>(<a class="code hl_struct" href="structrng__128.html">rng_128_t</a> *rand128);</div>
 245 <div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span> </div>
 246 <div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>uint64_t <a class="code hl_function" href="group__pico__rand.html#ga783185fba81c03eb0c1d687d322b0112">get_rand_64</a>(<span class="keywordtype">void</span>);</div>
 247 <div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span> </div>
 248 <div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span>uint32_t <a class="code hl_function" href="group__pico__rand.html#gac446d739bd6818ee25b5c8644ef7c8e8">get_rand_32</a>(<span class="keywordtype">void</span>);</div>
 249 <div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span> </div>
 250 <div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 251 <div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>}</div>
 252 <div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="preprocessor">#endif</span></div>
 253 <div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
 254 <div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="preprocessor">#endif</span></div>
 255 <div class="ttc" id="agroup__pico__rand_html_ga783185fba81c03eb0c1d687d322b0112"><div class="ttname"><a href="group__pico__rand.html#ga783185fba81c03eb0c1d687d322b0112">get_rand_64</a></div><div class="ttdeci">uint64_t get_rand_64(void)</div><div class="ttdoc">Get 64-bit random number.</div><div class="ttdef"><b>Definition:</b> rand.c:320</div></div>
 256 <div class="ttc" id="agroup__pico__rand_html_ga97a9544b527a3ba865ab70142bdd5d1b"><div class="ttname"><a href="group__pico__rand.html#ga97a9544b527a3ba865ab70142bdd5d1b">get_rand_128</a></div><div class="ttdeci">void get_rand_128(rng_128_t *rand128)</div><div class="ttdoc">Get 128-bit random number.</div><div class="ttdef"><b>Definition:</b> rand.c:374</div></div>
 257 <div class="ttc" id="agroup__pico__rand_html_gac446d739bd6818ee25b5c8644ef7c8e8"><div class="ttname"><a href="group__pico__rand.html#gac446d739bd6818ee25b5c8644ef7c8e8">get_rand_32</a></div><div class="ttdeci">uint32_t get_rand_32(void)</div><div class="ttdoc">Get 32-bit random number.</div><div class="ttdef"><b>Definition:</b> rand.c:379</div></div>
 258 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 259 <div class="ttc" id="astructrng__128_html"><div class="ttname"><a href="structrng__128.html">rng_128</a></div><div class="ttdef"><b>Definition:</b> rand.h:179</div></div>
 260 </div><!-- fragment --></div><!-- contents -->
 261 </div><!-- doc-content -->
 262
 263         <script src="main.js"></script>
 264 </body>
 265 </html>