aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added doxygen output of current emulator branch.

Browse Source
This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

330
group___h_a_s_h___group2.html Normal file
View File

@@ -0,0 +1,330 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>discoverpixy: Message Digest generation functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Message Digest generation functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> &raquo; <a class="el" href="group___h_a_s_h.html">HASH</a> &raquo; <a class="el" href="group___h_a_s_h___private___functions.html">HASH_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Message Digest generation functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Message Digest generation functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___h_a_s_h___group2.png" border="0" alt="" usemap="#group______h__a__s__h______group2"/>
<map name="group______h__a__s__h______group2" id="group______h__a__s__h______group2">
<area shape="rect" id="node1" href="group___h_a_s_h___private___functions.html" title="HASH_Private_Functions" alt="" coords="5,13,173,39"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac4d1fa51c9240ad0287b371564b5d2a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group2.html#gac4d1fa51c9240ad0287b371564b5d2a6">HASH_SetLastWordValidBitsNbr</a> (uint16_t ValidNumber)</td></tr>
<tr class="memdesc:gac4d1fa51c9240ad0287b371564b5d2a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the Number of valid bits in last word of the message. <a href="#gac4d1fa51c9240ad0287b371564b5d2a6">More...</a><br /></td></tr>
<tr class="separator:gac4d1fa51c9240ad0287b371564b5d2a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c4c0cebdeb1ce2631dd2eeab82107ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group2.html#ga9c4c0cebdeb1ce2631dd2eeab82107ef">HASH_DataIn</a> (uint32_t Data)</td></tr>
<tr class="memdesc:ga9c4c0cebdeb1ce2631dd2eeab82107ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes data in the Data Input FIFO. <a href="#ga9c4c0cebdeb1ce2631dd2eeab82107ef">More...</a><br /></td></tr>
<tr class="separator:ga9c4c0cebdeb1ce2631dd2eeab82107ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37bec5e637a57124f3179185d03537ab"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group2.html#ga37bec5e637a57124f3179185d03537ab">HASH_GetInFIFOWordsNbr</a> (void)</td></tr>
<tr class="memdesc:ga37bec5e637a57124f3179185d03537ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of words already pushed into the IN FIFO. <a href="#ga37bec5e637a57124f3179185d03537ab">More...</a><br /></td></tr>
<tr class="separator:ga37bec5e637a57124f3179185d03537ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23018d770837d6ab9f46941f105cc017"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group2.html#ga23018d770837d6ab9f46941f105cc017">HASH_GetDigest</a> (<a class="el" href="struct_h_a_s_h___msg_digest.html">HASH_MsgDigest</a> *HASH_MessageDigest)</td></tr>
<tr class="memdesc:ga23018d770837d6ab9f46941f105cc017"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the message digest result. <a href="#ga23018d770837d6ab9f46941f105cc017">More...</a><br /></td></tr>
<tr class="separator:ga23018d770837d6ab9f46941f105cc017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga84ac2b64179fd37b75c4d5f665126e93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group2.html#ga84ac2b64179fd37b75c4d5f665126e93">HASH_StartDigest</a> (void)</td></tr>
<tr class="memdesc:ga84ac2b64179fd37b75c4d5f665126e93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the message padding and calculation of the final message. <a href="#ga84ac2b64179fd37b75c4d5f665126e93">More...</a><br /></td></tr>
<tr class="separator:ga84ac2b64179fd37b75c4d5f665126e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Message Digest generation functions. </p>
<pre class="fragment"> ===============================================================================
##### Message Digest generation functions #####
===============================================================================
[..] This section provides functions allowing the generation of message digest:
(+) Push data in the IN FIFO : using HASH_DataIn()
(+) Get the number of words set in IN FIFO, use HASH_GetInFIFOWordsNbr()
(+) set the last word valid bits number using HASH_SetLastWordValidBitsNbr()
(+) start digest calculation : using HASH_StartDigest()
(+) Get the Digest message : using HASH_GetDigest()</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9c4c0cebdeb1ce2631dd2eeab82107ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_DataIn </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes data in the Data Input FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Data</td><td>new data of the message to be processed. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group2_ga9c4c0cebdeb1ce2631dd2eeab82107ef_icgraph.png" border="0" usemap="#group___h_a_s_h___group2_ga9c4c0cebdeb1ce2631dd2eeab82107ef_icgraph" alt=""/></div>
<map name="group___h_a_s_h___group2_ga9c4c0cebdeb1ce2631dd2eeab82107ef_icgraph" id="group___h_a_s_h___group2_ga9c4c0cebdeb1ce2631dd2eeab82107ef_icgraph">
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="161,5,253,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="159,56,254,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="157,107,256,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="156,157,257,184"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga23018d770837d6ab9f46941f105cc017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_GetDigest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h_a_s_h___msg_digest.html">HASH_MsgDigest</a> *&#160;</td>
<td class="paramname"><em>HASH_MessageDigest</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the message digest result. </p>
<dl class="section note"><dt>Note</dt><dd>In MD5 mode, Data[7] to Data[4] filed of <a class="el" href="struct_h_a_s_h___msg_digest.html" title="HASH message digest result structure definition. ">HASH_MsgDigest</a> structure is not used and is read as zero. In SHA-1 mode, Data[7] to Data[5] filed of <a class="el" href="struct_h_a_s_h___msg_digest.html" title="HASH message digest result structure definition. ">HASH_MsgDigest</a> structure is not used and is read as zero. In SHA-224 mode, Data[7] filed of <a class="el" href="struct_h_a_s_h___msg_digest.html" title="HASH message digest result structure definition. ">HASH_MsgDigest</a> structure is not used and is read as zero. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">HASH_MessageDigest</td><td>pointer to a <a class="el" href="struct_h_a_s_h___msg_digest.html" title="HASH message digest result structure definition. ">HASH_MsgDigest</a> structure which will hold the message digest result </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group2_ga23018d770837d6ab9f46941f105cc017_icgraph.png" border="0" usemap="#group___h_a_s_h___group2_ga23018d770837d6ab9f46941f105cc017_icgraph" alt=""/></div>
<map name="group___h_a_s_h___group2_ga23018d770837d6ab9f46941f105cc017_icgraph" id="group___h_a_s_h___group2_ga23018d770837d6ab9f46941f105cc017_icgraph">
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="181,5,273,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="179,56,274,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="177,107,276,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="176,157,277,184"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga37bec5e637a57124f3179185d03537ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t HASH_GetInFIFOWordsNbr </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of words already pushed into the IN FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">The</td><td>value of words already pushed into the IN FIFO. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac4d1fa51c9240ad0287b371564b5d2a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_SetLastWordValidBitsNbr </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>ValidNumber</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the Number of valid bits in last word of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ValidNumber</td><td>Number of valid bits in last word of the message. This parameter must be a number between 0 and 0x1F.<ul>
<li>0x00: All 32 bits of the last data written are valid</li>
<li>0x01: Only bit [0] of the last data written is valid</li>
<li>0x02: Only bits[1:0] of the last data written are valid</li>
<li>0x03: Only bits[2:0] of the last data written are valid</li>
<li>...</li>
<li>0x1F: Only bits[30:0] of the last data written are valid </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The Number of valid bits must be set before to start the message digest competition (in Hash and HMAC) and key treatment(in HMAC). </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group2_gac4d1fa51c9240ad0287b371564b5d2a6_icgraph.png" border="0" usemap="#group___h_a_s_h___group2_gac4d1fa51c9240ad0287b371564b5d2a6_icgraph" alt=""/></div>
<map name="group___h_a_s_h___group2_gac4d1fa51c9240ad0287b371564b5d2a6_icgraph" id="group___h_a_s_h___group2_gac4d1fa51c9240ad0287b371564b5d2a6_icgraph">
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="270,5,362,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="269,56,363,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="267,107,365,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="265,157,367,184"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga84ac2b64179fd37b75c4d5f665126e93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_StartDigest </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the message padding and calculation of the final message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">None</td><td></td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group2_ga84ac2b64179fd37b75c4d5f665126e93_icgraph.png" border="0" usemap="#group___h_a_s_h___group2_ga84ac2b64179fd37b75c4d5f665126e93_icgraph" alt=""/></div>
<map name="group___h_a_s_h___group2_ga84ac2b64179fd37b75c4d5f665126e93_icgraph" id="group___h_a_s_h___group2_ga84ac2b64179fd37b75c4d5f665126e93_icgraph">
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="189,5,281,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="187,56,282,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="185,107,284,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="184,157,285,184"/></map>
</div>
</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:20 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>