taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-29 08:32:07 +10:00
parent 64da24bbf6
commit 100a18a956
931 changed files with 1212 additions and 75896 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
RNG_8h_source.html
View File

@@ -133,51 +133,50 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classRNGClass.html#a49e3231ba65a5e4b045bc90976e0a659">available</a>(<span class="keywordtype">size_t</span> len) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">stir</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> credit = 0);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">stir</a>(<a class="code" href="classNoiseSource.html">NoiseSource</a> &amp;source);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a139584fb249148e2058d1d645d090db7">save</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13">loop</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a9901367d86f2303a59bbc12fe91cad00">destroy</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2"> 54</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2">SEED_SIZE</a> = 49;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint32_t block[16];</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uint32_t stream[16];</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">int</span> address;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint16_t credits : 15;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint16_t firstSave : 1;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timer;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="classNoiseSource.html">NoiseSource</a> *noiseSources[4];</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint8_t count;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> rekey();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keyword">extern</span> <a class="code" href="classRNGClass.html">RNGClass</a> RNG;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classRNGClass_html_a139584fb249148e2058d1d645d090db7"><div class="ttname"><a href="classRNGClass.html#a139584fb249148e2058d1d645d090db7">RNGClass::save</a></div><div class="ttdeci">void save()</div><div class="ttdoc">Saves the random seed to EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00488">RNG.cpp:488</a></div></div>
<div class="ttc" id="classRNGClass_html_a418a833cf18198fd7e5d6dbd78c99c29"><div class="ttname"><a href="classRNGClass.html#a418a833cf18198fd7e5d6dbd78c99c29">RNGClass::rand</a></div><div class="ttdeci">void rand(uint8_t *data, size_t len)</div><div class="ttdoc">Generates random bytes into a caller-supplied buffer. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00297">RNG.cpp:297</a></div></div>
<div class="ttc" id="classRNGClass_html_a7f1aab3c324f8e8a424d683425e0fcf8"><div class="ttname"><a href="classRNGClass.html#a7f1aab3c324f8e8a424d683425e0fcf8">RNGClass::begin</a></div><div class="ttdeci">void begin(const char *tag, int eepromAddress)</div><div class="ttdoc">Initializes the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00203">RNG.cpp:203</a></div></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a139584fb249148e2058d1d645d090db7">save</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13">loop</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRNGClass.html#a9901367d86f2303a59bbc12fe91cad00">destroy</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2"> 53</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2">SEED_SIZE</a> = 49;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint32_t block[16];</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint32_t stream[16];</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">int</span> address;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; uint16_t credits : 15;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint16_t firstSave : 1;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timer;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classNoiseSource.html">NoiseSource</a> *noiseSources[4];</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint8_t count;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> rekey();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;};</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keyword">extern</span> <a class="code" href="classRNGClass.html">RNGClass</a> RNG;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classRNGClass_html_a139584fb249148e2058d1d645d090db7"><div class="ttname"><a href="classRNGClass.html#a139584fb249148e2058d1d645d090db7">RNGClass::save</a></div><div class="ttdeci">void save()</div><div class="ttdoc">Saves the random seed to EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00475">RNG.cpp:475</a></div></div>
<div class="ttc" id="classRNGClass_html_a418a833cf18198fd7e5d6dbd78c99c29"><div class="ttname"><a href="classRNGClass.html#a418a833cf18198fd7e5d6dbd78c99c29">RNGClass::rand</a></div><div class="ttdeci">void rand(uint8_t *data, size_t len)</div><div class="ttdoc">Generates random bytes into a caller-supplied buffer. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00296">RNG.cpp:296</a></div></div>
<div class="ttc" id="classRNGClass_html_a7f1aab3c324f8e8a424d683425e0fcf8"><div class="ttname"><a href="classRNGClass.html#a7f1aab3c324f8e8a424d683425e0fcf8">RNGClass::begin</a></div><div class="ttdeci">void begin(const char *tag, int eepromAddress)</div><div class="ttdoc">Initializes the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00202">RNG.cpp:202</a></div></div>
<div class="ttc" id="classNoiseSource_html"><div class="ttname"><a href="classNoiseSource.html">NoiseSource</a></div><div class="ttdoc">Abstract base class for random noise sources. </div><div class="ttdef"><b>Definition:</b> <a href="NoiseSource_8h_source.html#l00029">NoiseSource.h:29</a></div></div>
<div class="ttc" id="classRNGClass_html_aef3ee2fb14a39caf650dc90a0226dd31"><div class="ttname"><a href="classRNGClass.html#aef3ee2fb14a39caf650dc90a0226dd31">RNGClass::~RNGClass</a></div><div class="ttdeci">~RNGClass()</div><div class="ttdoc">Destroys this random number generator instance. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00180">RNG.cpp:180</a></div></div>
<div class="ttc" id="classRNGClass_html_aacf23b192b0e4cc8726d9abe05f5a9db"><div class="ttname"><a href="classRNGClass.html#aacf23b192b0e4cc8726d9abe05f5a9db">RNGClass::addNoiseSource</a></div><div class="ttdeci">void addNoiseSource(NoiseSource &amp;source)</div><div class="ttdoc">Adds a noise source to the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00250">RNG.cpp:250</a></div></div>
<div class="ttc" id="classRNGClass_html_aacf23b192b0e4cc8726d9abe05f5a9db"><div class="ttname"><a href="classRNGClass.html#aacf23b192b0e4cc8726d9abe05f5a9db">RNGClass::addNoiseSource</a></div><div class="ttdeci">void addNoiseSource(NoiseSource &amp;source)</div><div class="ttdoc">Adds a noise source to the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00249">RNG.cpp:249</a></div></div>
<div class="ttc" id="classRNGClass_html_acbcf327242f51ae2d9209aeaa45e30e9"><div class="ttname"><a href="classRNGClass.html#acbcf327242f51ae2d9209aeaa45e30e9">RNGClass::RNGClass</a></div><div class="ttdeci">RNGClass()</div><div class="ttdoc">Constructs a new random number generator instance. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00167">RNG.cpp:167</a></div></div>
<div class="ttc" id="classRNGClass_html_a9901367d86f2303a59bbc12fe91cad00"><div class="ttname"><a href="classRNGClass.html#a9901367d86f2303a59bbc12fe91cad00">RNGClass::destroy</a></div><div class="ttdeci">void destroy()</div><div class="ttdoc">Destroys the data in the random number pool and the saved seed in EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00537">RNG.cpp:537</a></div></div>
<div class="ttc" id="classRNGClass_html_a49e3231ba65a5e4b045bc90976e0a659"><div class="ttname"><a href="classRNGClass.html#a49e3231ba65a5e4b045bc90976e0a659">RNGClass::available</a></div><div class="ttdeci">bool available(size_t len) const </div><div class="ttdoc">Determine if there is sufficient entropy available for a specific request size. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00374">RNG.cpp:374</a></div></div>
<div class="ttc" id="classRNGClass_html_a8cb91e39f0c4591de5bf98b1e2880b13"><div class="ttname"><a href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13">RNGClass::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Run periodic housekeeping tasks on the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00506">RNG.cpp:506</a></div></div>
<div class="ttc" id="classRNGClass_html_a9901367d86f2303a59bbc12fe91cad00"><div class="ttname"><a href="classRNGClass.html#a9901367d86f2303a59bbc12fe91cad00">RNGClass::destroy</a></div><div class="ttdeci">void destroy()</div><div class="ttdoc">Destroys the data in the random number pool and the saved seed in EEPROM. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00523">RNG.cpp:523</a></div></div>
<div class="ttc" id="classRNGClass_html_a49e3231ba65a5e4b045bc90976e0a659"><div class="ttname"><a href="classRNGClass.html#a49e3231ba65a5e4b045bc90976e0a659">RNGClass::available</a></div><div class="ttdeci">bool available(size_t len) const </div><div class="ttdoc">Determine if there is sufficient entropy available for a specific request size. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00373">RNG.cpp:373</a></div></div>
<div class="ttc" id="classRNGClass_html_a8cb91e39f0c4591de5bf98b1e2880b13"><div class="ttname"><a href="classRNGClass.html#a8cb91e39f0c4591de5bf98b1e2880b13">RNGClass::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Run periodic housekeeping tasks on the random number generator. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00493">RNG.cpp:493</a></div></div>
<div class="ttc" id="classRNGClass_html"><div class="ttname"><a href="classRNGClass.html">RNGClass</a></div><div class="ttdoc">Pseudo random number generator suitable for cryptography. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8h_source.html#l00031">RNG.h:31</a></div></div>
<div class="ttc" id="classRNGClass_html_ae3a013bfc73795fd26ee36e70d89f4c2"><div class="ttname"><a href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2">RNGClass::SEED_SIZE</a></div><div class="ttdeci">static const int SEED_SIZE</div><div class="ttdoc">Size of a saved random number seed in EEPROM space. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8h_source.html#l00054">RNG.h:54</a></div></div>
<div class="ttc" id="classRNGClass_html_ad99535ea23ae2fec55bdebb8c24def02"><div class="ttname"><a href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">RNGClass::stir</a></div><div class="ttdeci">void stir(const uint8_t *data, size_t len, unsigned int credit=0)</div><div class="ttdoc">Stirs additional entropy data into the random pool. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00407">RNG.cpp:407</a></div></div>
<div class="ttc" id="classRNGClass_html_a5848e87a5f2f0302c88b0377f0e3366d"><div class="ttname"><a href="classRNGClass.html#a5848e87a5f2f0302c88b0377f0e3366d">RNGClass::setAutoSaveTime</a></div><div class="ttdeci">void setAutoSaveTime(uint16_t minutes)</div><div class="ttdoc">Sets the amount of time between automatic seed saves. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00273">RNG.cpp:273</a></div></div>
<div class="ttc" id="classRNGClass_html_ae3a013bfc73795fd26ee36e70d89f4c2"><div class="ttname"><a href="classRNGClass.html#ae3a013bfc73795fd26ee36e70d89f4c2">RNGClass::SEED_SIZE</a></div><div class="ttdeci">static const int SEED_SIZE</div><div class="ttdoc">Size of a saved random number seed in EEPROM space. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8h_source.html#l00053">RNG.h:53</a></div></div>
<div class="ttc" id="classRNGClass_html_ad99535ea23ae2fec55bdebb8c24def02"><div class="ttname"><a href="classRNGClass.html#ad99535ea23ae2fec55bdebb8c24def02">RNGClass::stir</a></div><div class="ttdeci">void stir(const uint8_t *data, size_t len, unsigned int credit=0)</div><div class="ttdoc">Stirs additional entropy data into the random pool. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00406">RNG.cpp:406</a></div></div>
<div class="ttc" id="classRNGClass_html_a5848e87a5f2f0302c88b0377f0e3366d"><div class="ttname"><a href="classRNGClass.html#a5848e87a5f2f0302c88b0377f0e3366d">RNGClass::setAutoSaveTime</a></div><div class="ttdeci">void setAutoSaveTime(uint16_t minutes)</div><div class="ttdoc">Sets the amount of time between automatic seed saves. </div><div class="ttdef"><b>Definition:</b> <a href="RNG_8cpp_source.html#l00272">RNG.cpp:272</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2015 19:36:07 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Mar 29 2015 08:30:13 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>