web/docs/rand_8h.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/pico/rand.h File Reference</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('rand_8h.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#nested-classes">Data Structures</a> &#124;
 107 <a href="#define-members">Macros</a> &#124;
 108 <a href="#typedef-members">Typedefs</a> &#124;
 109 <a href="#func-members">Functions</a>  </div>
 110   <div class="headertitle"><div class="title">rand.h File Reference</div></div>
 111 </div><!--header-->
 112 <div class="contents">
 113 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 114 </div><div class="textblock"><div class="dynheader">
 115 Include dependency graph for rand.h:</div>
 116 <div class="dyncontent">
 117 <div class="center"><img src="rand_8h__incl.png" border="0" usemap="#ainclude_2pico_2rand_8h" alt=""/></div>
 118 <map name="ainclude_2pico_2rand_8h" id="ainclude_2pico_2rand_8h">
 119 <area shape="rect" title=" " alt="" coords="369,5,515,32"/>
 120 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="411,80,473,107"/>
 121 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,304,259,331"/>
 122 <area shape="rect" title=" " alt="" coords="252,155,365,181"/>
 123 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="390,155,494,181"/>
 124 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="596,155,717,181"/>
 125 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="741,155,836,181"/>
 126 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,379,111,405"/>
 127 <area shape="rect" title=" " alt="" coords="74,453,157,480"/>
 128 <area shape="rect" title=" " alt="" coords="211,379,281,405"/>
 129 <area shape="rect" title=" " alt="" coords="306,379,381,405"/>
 130 <area shape="rect" title=" " alt="" coords="173,229,337,256"/>
 131 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,229,543,256"/>
 132 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,229,746,256"/>
 133 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,229,930,256"/>
 134 <area shape="rect" title=" " alt="" coords="954,229,1165,256"/>
 135 <area shape="rect" title=" " alt="" coords="1189,229,1340,256"/>
 136 <area shape="rect" title=" " alt="" coords="357,304,548,331"/>
 137 </map>
 138 </div>
 139 </div><div class="textblock"><div class="dynheader">
 140 This graph shows which files directly or indirectly include this file:</div>
 141 <div class="dyncontent">
 142 <div class="center"><img src="rand_8h__dep__incl.png" border="0" usemap="#ainclude_2pico_2rand_8hdep" alt=""/></div>
 143 <map name="ainclude_2pico_2rand_8hdep" id="ainclude_2pico_2rand_8hdep">
 144 <area shape="rect" title=" " alt="" coords="5,5,151,32"/>
 145 <area shape="rect" href="cc_8h_source.html" title=" " alt="" coords="13,80,143,107"/>
 146 </map>
 147 </div>
 148 </div>
 149 <p><a href="rand_8h_source.html">Go to the source code of this file.</a></p>
 150 <table class="memberdecls">
 151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 152 Data Structures</h2></td></tr>
 153 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrng__128.html">rng_128</a></td></tr>
 154 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table><table class="memberdecls">
 156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 157 Macros</h2></td></tr>
 158 <tr class="memitem:a6d68829b2aab447cc0ac75b3feb4d88e"><td class="memItemLeft" align="right" valign="top"><a id="a6d68829b2aab447cc0ac75b3feb4d88e" name="a6d68829b2aab447cc0ac75b3feb4d88e"></a>
 159 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_ENTROPY_SRC_ROSC</b>&#160;&#160;&#160;1</td></tr>
 160 <tr class="separator:a6d68829b2aab447cc0ac75b3feb4d88e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:a16fa252c444473360900cc3f7781d2b9"><td class="memItemLeft" align="right" valign="top"><a id="a16fa252c444473360900cc3f7781d2b9" name="a16fa252c444473360900cc3f7781d2b9"></a>
 162 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_ENTROPY_SRC_TIME</b>&#160;&#160;&#160;1</td></tr>
 163 <tr class="separator:a16fa252c444473360900cc3f7781d2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:a7bf0a952ec6d01b64b74b37ee2da7125"><td class="memItemLeft" align="right" valign="top"><a id="a7bf0a952ec6d01b64b74b37ee2da7125" name="a7bf0a952ec6d01b64b74b37ee2da7125"></a>
 165 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER</b>&#160;&#160;&#160;1</td></tr>
 166 <tr class="separator:a7bf0a952ec6d01b64b74b37ee2da7125"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:ab9f79e53d0fbd6e68118eac014673b17"><td class="memItemLeft" align="right" valign="top"><a id="ab9f79e53d0fbd6e68118eac014673b17" name="ab9f79e53d0fbd6e68118eac014673b17"></a>
 168 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_SEED_ENTROPY_SRC_ROSC</b>&#160;&#160;&#160;PICO_RAND_ENTROPY_SRC_ROSC</td></tr>
 169 <tr class="separator:ab9f79e53d0fbd6e68118eac014673b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:ac1d3e35b63eae69481aa9f5a83a7de6c"><td class="memItemLeft" align="right" valign="top"><a id="ac1d3e35b63eae69481aa9f5a83a7de6c" name="ac1d3e35b63eae69481aa9f5a83a7de6c"></a>
 171 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_SEED_ENTROPY_SRC_TIME</b>&#160;&#160;&#160;PICO_RAND_ENTROPY_SRC_TIME</td></tr>
 172 <tr class="separator:ac1d3e35b63eae69481aa9f5a83a7de6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:ade6facffab9919340149541bdca1d824"><td class="memItemLeft" align="right" valign="top"><a id="ade6facffab9919340149541bdca1d824" name="ade6facffab9919340149541bdca1d824"></a>
 174 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_SEED_ENTROPY_SRC_BUF_PERF_COUNTER</b>&#160;&#160;&#160;PICO_RAND_ENTROPY_SRC_BUS_PERF_COUNTER</td></tr>
 175 <tr class="separator:ade6facffab9919340149541bdca1d824"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:a3dc0efe5678a480576780c96c334b026"><td class="memItemLeft" align="right" valign="top"><a id="a3dc0efe5678a480576780c96c334b026" name="a3dc0efe5678a480576780c96c334b026"></a>
 177 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_SEED_ENTROPY_SRC_BOARD_ID</b>&#160;&#160;&#160;(!PICO_RAND_SEED_ENTROPY_SRC_BOOT_RANDOM)</td></tr>
 178 <tr class="separator:a3dc0efe5678a480576780c96c334b026"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <tr class="memitem:a413241512da98d1c5b4c8fa85cb7be26"><td class="memItemLeft" align="right" valign="top"><a id="a413241512da98d1c5b4c8fa85cb7be26" name="a413241512da98d1c5b4c8fa85cb7be26"></a>
 180 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_SEED_ENTROPY_SRC_RAM_HASH</b>&#160;&#160;&#160;1</td></tr>
 181 <tr class="separator:a413241512da98d1c5b4c8fa85cb7be26"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <tr class="memitem:a01ec243380eb962a426593912df08092"><td class="memItemLeft" align="right" valign="top"><a id="a01ec243380eb962a426593912df08092" name="a01ec243380eb962a426593912df08092"></a>
 183 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_ROSC_BIT_SAMPLE_COUNT</b>&#160;&#160;&#160;1</td></tr>
 184 <tr class="separator:a01ec243380eb962a426593912df08092"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <tr class="memitem:aeff32bff7c000d760faece8abbba50c9"><td class="memItemLeft" align="right" valign="top"><a id="aeff32bff7c000d760faece8abbba50c9" name="aeff32bff7c000d760faece8abbba50c9"></a>
 186 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_MIN_ROSC_BIT_SAMPLE_TIME_US</b>&#160;&#160;&#160;10u</td></tr>
 187 <tr class="separator:aeff32bff7c000d760faece8abbba50c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 <tr class="memitem:a23c8ad464cd02005909e83084dd06a24"><td class="memItemLeft" align="right" valign="top"><a id="a23c8ad464cd02005909e83084dd06a24" name="a23c8ad464cd02005909e83084dd06a24"></a>
 189 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_BUS_PERF_COUNTER_EVENT</b>&#160;&#160;&#160;arbiter_sram5_perf_event_access</td></tr>
 190 <tr class="separator:a23c8ad464cd02005909e83084dd06a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <tr class="memitem:a29bc3dc0b41e9aef6ba0a42b8b51ce54"><td class="memItemLeft" align="right" valign="top"><a id="a29bc3dc0b41e9aef6ba0a42b8b51ce54" name="a29bc3dc0b41e9aef6ba0a42b8b51ce54"></a>
 192 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_RAM_HASH_END</b>&#160;&#160;&#160;SRAM_END</td></tr>
 193 <tr class="separator:a29bc3dc0b41e9aef6ba0a42b8b51ce54"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 <tr class="memitem:abf4d6fa8ce14aec5c30e97c384321c83"><td class="memItemLeft" align="right" valign="top"><a id="abf4d6fa8ce14aec5c30e97c384321c83" name="abf4d6fa8ce14aec5c30e97c384321c83"></a>
 195 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_RAND_RAM_HASH_START</b>&#160;&#160;&#160;(PICO_RAND_RAM_HASH_END - 1024u)</td></tr>
 196 <tr class="separator:abf4d6fa8ce14aec5c30e97c384321c83"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 </table><table class="memberdecls">
 198 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 199 Typedefs</h2></td></tr>
 200 <tr class="memitem:af6c69a65fa0468e9af74d1271445c85d"><td class="memItemLeft" align="right" valign="top"><a id="af6c69a65fa0468e9af74d1271445c85d" name="af6c69a65fa0468e9af74d1271445c85d"></a>
 201 typedef struct <a class="el" href="structrng__128.html">rng_128</a>&#160;</td><td class="memItemRight" valign="bottom"><b>rng_128_t</b></td></tr>
 202 <tr class="separator:af6c69a65fa0468e9af74d1271445c85d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 </table><table class="memberdecls">
 204 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 205 Functions</h2></td></tr>
 206 <tr class="memitem:ga97a9544b527a3ba865ab70142bdd5d1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__rand.html#ga97a9544b527a3ba865ab70142bdd5d1b">get_rand_128</a> (<a class="el" href="structrng__128.html">rng_128_t</a> *rand128)</td></tr>
 207 <tr class="memdesc:ga97a9544b527a3ba865ab70142bdd5d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get 128-bit random number.  <a href="group__pico__rand.html#ga97a9544b527a3ba865ab70142bdd5d1b">More...</a><br /></td></tr>
 208 <tr class="separator:ga97a9544b527a3ba865ab70142bdd5d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 <tr class="memitem:ga783185fba81c03eb0c1d687d322b0112"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__rand.html#ga783185fba81c03eb0c1d687d322b0112">get_rand_64</a> (void)</td></tr>
 210 <tr class="memdesc:ga783185fba81c03eb0c1d687d322b0112"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get 64-bit random number.  <a href="group__pico__rand.html#ga783185fba81c03eb0c1d687d322b0112">More...</a><br /></td></tr>
 211 <tr class="separator:ga783185fba81c03eb0c1d687d322b0112"><td class="memSeparator" colspan="2">&#160;</td></tr>
 212 <tr class="memitem:gac446d739bd6818ee25b5c8644ef7c8e8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__rand.html#gac446d739bd6818ee25b5c8644ef7c8e8">get_rand_32</a> (void)</td></tr>
 213 <tr class="memdesc:gac446d739bd6818ee25b5c8644ef7c8e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get 32-bit random number.  <a href="group__pico__rand.html#gac446d739bd6818ee25b5c8644ef7c8e8">More...</a><br /></td></tr>
 214 <tr class="separator:gac446d739bd6818ee25b5c8644ef7c8e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 215 </table>
 216 </div><!-- contents -->
 217 </div><!-- doc-content -->
 218
 219         <script src="main.js"></script>
 220 </body>
 221 </html>