1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

This commit is contained in:
Rhys Weatherley
2016-03-13 08:28:23 +10:00
parent 443fa28b67
commit 11f16a223a
490 changed files with 12217 additions and 945 deletions

View File

@@ -69,7 +69,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
@@ -494,6 +494,83 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160; V[3] = htobe32(V3);</div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160;</div>
<div class="line"><a name="l00497"></a><span class="lineno"><a class="line" href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e"> 497</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e">GF128::dblXTS</a>(uint32_t V[4])</div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160;{</div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160;<span class="preprocessor">#if defined(__AVR__)</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160;<span class="preprocessor"></span> __asm__ __volatile__ (</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160; <span class="stringliteral">&quot;ld r16,Z\n&quot;</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160; <span class="stringliteral">&quot;ldd r17,Z+1\n&quot;</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160; <span class="stringliteral">&quot;ldd r18,Z+2\n&quot;</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160; <span class="stringliteral">&quot;ldd r19,Z+3\n&quot;</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160; <span class="stringliteral">&quot;lsl r16\n&quot;</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160; <span class="stringliteral">&quot;rol r17\n&quot;</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160; <span class="stringliteral">&quot;rol r18\n&quot;</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160; <span class="stringliteral">&quot;rol r19\n&quot;</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160; <span class="stringliteral">&quot;std Z+1,r17\n&quot;</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160; <span class="stringliteral">&quot;std Z+2,r18\n&quot;</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>&#160; <span class="stringliteral">&quot;std Z+3,r19\n&quot;</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160; <span class="stringliteral">&quot;ldd r17,Z+4\n&quot;</span></div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>&#160; <span class="stringliteral">&quot;ldd r18,Z+5\n&quot;</span></div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160; <span class="stringliteral">&quot;ldd r19,Z+6\n&quot;</span></div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160; <span class="stringliteral">&quot;ldd r20,Z+7\n&quot;</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160; <span class="stringliteral">&quot;rol r17\n&quot;</span></div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>&#160; <span class="stringliteral">&quot;rol r18\n&quot;</span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160; <span class="stringliteral">&quot;rol r19\n&quot;</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160; <span class="stringliteral">&quot;rol r20\n&quot;</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160; <span class="stringliteral">&quot;std Z+4,r17\n&quot;</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160; <span class="stringliteral">&quot;std Z+5,r18\n&quot;</span></div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>&#160; <span class="stringliteral">&quot;std Z+6,r19\n&quot;</span></div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160; <span class="stringliteral">&quot;std Z+7,r20\n&quot;</span></div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160; <span class="stringliteral">&quot;ldd r17,Z+8\n&quot;</span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160; <span class="stringliteral">&quot;ldd r18,Z+9\n&quot;</span></div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>&#160; <span class="stringliteral">&quot;ldd r19,Z+10\n&quot;</span></div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160; <span class="stringliteral">&quot;ldd r20,Z+11\n&quot;</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>&#160; <span class="stringliteral">&quot;rol r17\n&quot;</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160; <span class="stringliteral">&quot;rol r18\n&quot;</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160; <span class="stringliteral">&quot;rol r19\n&quot;</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160; <span class="stringliteral">&quot;rol r20\n&quot;</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>&#160; <span class="stringliteral">&quot;std Z+8,r17\n&quot;</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>&#160; <span class="stringliteral">&quot;std Z+9,r18\n&quot;</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>&#160; <span class="stringliteral">&quot;std Z+10,r19\n&quot;</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160; <span class="stringliteral">&quot;std Z+11,r20\n&quot;</span></div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160; <span class="stringliteral">&quot;ldd r17,Z+12\n&quot;</span></div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160; <span class="stringliteral">&quot;ldd r18,Z+13\n&quot;</span></div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160; <span class="stringliteral">&quot;ldd r19,Z+14\n&quot;</span></div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160; <span class="stringliteral">&quot;ldd r20,Z+15\n&quot;</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160; <span class="stringliteral">&quot;rol r17\n&quot;</span></div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160; <span class="stringliteral">&quot;rol r18\n&quot;</span></div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160; <span class="stringliteral">&quot;rol r19\n&quot;</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; <span class="stringliteral">&quot;rol r20\n&quot;</span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; <span class="stringliteral">&quot;std Z+12,r17\n&quot;</span></div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160; <span class="stringliteral">&quot;std Z+13,r18\n&quot;</span></div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160; <span class="stringliteral">&quot;std Z+14,r19\n&quot;</span></div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160; <span class="stringliteral">&quot;std Z+15,r20\n&quot;</span></div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160; <span class="stringliteral">&quot;mov r17,__zero_reg__\n&quot;</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; <span class="stringliteral">&quot;sbc r17,__zero_reg__\n&quot;</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160; <span class="stringliteral">&quot;andi r17,0x87\n&quot;</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160; <span class="stringliteral">&quot;eor r16,r17\n&quot;</span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160; <span class="stringliteral">&quot;st Z,r16\n&quot;</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160; : : <span class="stringliteral">&quot;z&quot;</span>(V)</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160; : <span class="stringliteral">&quot;r16&quot;</span>, <span class="stringliteral">&quot;r17&quot;</span>, <span class="stringliteral">&quot;r18&quot;</span>, <span class="stringliteral">&quot;r19&quot;</span>, <span class="stringliteral">&quot;r20&quot;</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160; );</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160;<span class="preprocessor"></span> uint32_t V0 = le32toh(V[0]);</div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span>&#160; uint32_t V1 = le32toh(V[1]);</div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160; uint32_t V2 = le32toh(V[2]);</div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160; uint32_t V3 = le32toh(V[3]);</div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160; uint32_t mask = ((~(V3 &gt;&gt; 31)) + 1) &amp; 0x00000087;</div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160; V3 = (V3 &lt;&lt; 1) | (V2 &gt;&gt; 31);</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160; V2 = (V2 &lt;&lt; 1) | (V1 &gt;&gt; 31);</div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160; V1 = (V1 &lt;&lt; 1) | (V0 &gt;&gt; 31);</div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160; V0 = (V0 &lt;&lt; 1) ^ mask;</div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160; V[0] = htole32(V0);</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160; V[1] = htole32(V1);</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160; V[2] = htole32(V2);</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160; V[3] = htole32(V3);</div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="preprocessor"></span>}</div>
<div class="ttc" id="classGF128_html_a3732c9471771c36ac1b518e974d46b3e"><div class="ttname"><a href="classGF128.html#a3732c9471771c36ac1b518e974d46b3e">GF128::dblXTS</a></div><div class="ttdeci">static void dblXTS(uint32_t V[4])</div><div class="ttdoc">Doubles a value in the GF(2^128) field using XTS conventions. </div><div class="ttdef"><b>Definition:</b> <a href="GF128_8cpp_source.html#l00497">GF128.cpp:497</a></div></div>
<div class="ttc" id="classGF128_html_a56000a4cd7d436de42360e9d43eecde4"><div class="ttname"><a href="classGF128.html#a56000a4cd7d436de42360e9d43eecde4">GF128::dblEAX</a></div><div class="ttdeci">static void dblEAX(uint32_t V[4])</div><div class="ttdoc">Doubles a value in the GF(2^128) field using EAX conventions. </div><div class="ttdef"><b>Definition:</b> <a href="GF128_8cpp_source.html#l00406">GF128.cpp:406</a></div></div>
<div class="ttc" id="classGF128_html_a7d9a341a1715d37d25feba21627bc3ab"><div class="ttname"><a href="classGF128.html#a7d9a341a1715d37d25feba21627bc3ab">GF128::mul</a></div><div class="ttdeci">static void mul(uint32_t Y[4], const uint32_t H[4])</div><div class="ttdoc">Perform a multiplication in the GF(2^128) field. </div><div class="ttdef"><b>Definition:</b> <a href="GF128_8cpp_source.html#l00090">GF128.cpp:90</a></div></div>
<div class="ttc" id="classGF128_html_aef22f6b7be5937f60ed2b7bcf831e52d"><div class="ttname"><a href="classGF128.html#aef22f6b7be5937f60ed2b7bcf831e52d">GF128::dbl</a></div><div class="ttdeci">static void dbl(uint32_t V[4])</div><div class="ttdoc">Doubles a value in the GF(2^128) field. </div><div class="ttdef"><b>Definition:</b> <a href="GF128_8cpp_source.html#l00314">GF128.cpp:314</a></div></div>
@@ -501,7 +578,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 14 2016 08:32:00 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Mar 13 2016 08:28:00 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>