Added doxygen output of current emulator branch.

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

View File

@@ -0,0 +1,255 @@
<!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: High Level MD5 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">High Level MD5 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>High Level MD5 Hash and HMAC functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for High Level MD5 functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___h_a_s_h___group7.png" border="0" alt="" usemap="#group______h__a__s__h______group7"/>
<map name="group______h__a__s__h______group7" id="group______h__a__s__h______group7">
<area shape="rect" id="node1" href="group___h_a_s_h___private___functions.html" title="HASH_Private_Functions" alt="" coords="5,5,173,32"/></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:ga82a155884e458cc6b7c1a4565c1ac8e9"><td class="memItemLeft" align="right" valign="top">ErrorStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9">HASH_MD5</a> (uint8_t *Input, uint32_t Ilen, uint8_t Output[16])</td></tr>
<tr class="memdesc:ga82a155884e458cc6b7c1a4565c1ac8e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the HASH MD5 digest. <a href="#ga82a155884e458cc6b7c1a4565c1ac8e9">More...</a><br /></td></tr>
<tr class="separator:ga82a155884e458cc6b7c1a4565c1ac8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac61733e7aa66bdd2f21be4b34165b5be"><td class="memItemLeft" align="right" valign="top">ErrorStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be">HMAC_MD5</a> (uint8_t *Key, uint32_t Keylen, uint8_t *Input, uint32_t Ilen, uint8_t Output[16])</td></tr>
<tr class="memdesc:gac61733e7aa66bdd2f21be4b34165b5be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the HMAC MD5 digest. <a href="#gac61733e7aa66bdd2f21be4b34165b5be">More...</a><br /></td></tr>
<tr class="separator:gac61733e7aa66bdd2f21be4b34165b5be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>High Level MD5 Hash and HMAC functions. </p>
<pre class="fragment"> ===============================================================================
##### High Level MD5 Hash and HMAC functions #####
===============================================================================</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga82a155884e458cc6b7c1a4565c1ac8e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ErrorStatus HASH_MD5 </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>Input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Ilen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>Output</em>[16]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the HASH MD5 digest. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Input</td><td>pointer to the Input buffer to be treated. </td></tr>
<tr><td class="paramname">Ilen</td><td>length of the Input buffer. </td></tr>
<tr><td class="paramname">Output</td><td>the returned digest </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">An</td><td>ErrorStatus enumeration value:<ul>
<li>SUCCESS: digest computation done</li>
<li>ERROR: digest computation failed </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group7_ga82a155884e458cc6b7c1a4565c1ac8e9_cgraph.png" border="0" usemap="#group___h_a_s_h___group7_ga82a155884e458cc6b7c1a4565c1ac8e9_cgraph" alt=""/></div>
<map name="group___h_a_s_h___group7_ga82a155884e458cc6b7c1a4565c1ac8e9_cgraph" id="group___h_a_s_h___group7_ga82a155884e458cc6b7c1a4565c1ac8e9_cgraph">
<area shape="rect" id="node2" href="group___h_a_s_h.html#ga88717fe3a4f557182841a958e1dcd9c7" title="De&#45;initializes the HASH peripheral registers to their default reset values. " alt="" coords="202,5,301,32"/><area shape="rect" id="node4" href="group___h_a_s_h.html#ga4a7d33f0954ac0463a6cda81121635cf" title="Initializes the HASH peripheral according to the specified parameters in the HASH_InitStruct structur..." alt="" coords="210,56,293,83"/><area shape="rect" id="node5" href="group___h_a_s_h.html#gac4d1fa51c9240ad0287b371564b5d2a6" title="Configure the Number of valid bits in last word of the message. " alt="" coords="145,107,357,133"/><area shape="rect" id="node6" href="group___h_a_s_h.html#ga9c4c0cebdeb1ce2631dd2eeab82107ef" title="Writes data in the Data Input FIFO. " alt="" coords="200,157,303,184"/><area shape="rect" id="node7" href="group___h_a_s_h.html#ga84ac2b64179fd37b75c4d5f665126e93" title="Starts the message padding and calculation of the final message. " alt="" coords="186,208,317,235"/><area shape="rect" id="node8" href="group___h_a_s_h.html#ga826f7bbe15d07c123446cc3d30959f72" title="Checks whether the specified HASH flag is set or not. " alt="" coords="177,259,326,285"/><area shape="rect" id="node9" href="group___h_a_s_h.html#ga23018d770837d6ab9f46941f105cc017" title="Provides the message digest result. " alt="" coords="190,309,313,336"/><area shape="rect" id="node3" href="group___r_c_c.html#gafb119d6d1955d1b8c361e8140845ac5a" title="Forces or releases AHB2 peripheral reset. " alt="" coords="405,5,593,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gac61733e7aa66bdd2f21be4b34165b5be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ErrorStatus HMAC_MD5 </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Keylen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>Input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>Ilen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>Output</em>[16]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the HMAC MD5 digest. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>pointer to the Key used for HMAC. </td></tr>
<tr><td class="paramname">Keylen</td><td>length of the Key used for HMAC. </td></tr>
<tr><td class="paramname">Input</td><td>pointer to the Input buffer to be treated. </td></tr>
<tr><td class="paramname">Ilen</td><td>length of the Input buffer. </td></tr>
<tr><td class="paramname">Output</td><td>the returned digest </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">An</td><td>ErrorStatus enumeration value:<ul>
<li>SUCCESS: digest computation done</li>
<li>ERROR: digest computation failed </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group___h_a_s_h___group7_gac61733e7aa66bdd2f21be4b34165b5be_cgraph.png" border="0" usemap="#group___h_a_s_h___group7_gac61733e7aa66bdd2f21be4b34165b5be_cgraph" alt=""/></div>
<map name="group___h_a_s_h___group7_gac61733e7aa66bdd2f21be4b34165b5be_cgraph" id="group___h_a_s_h___group7_gac61733e7aa66bdd2f21be4b34165b5be_cgraph">
<area shape="rect" id="node2" href="group___h_a_s_h.html#ga88717fe3a4f557182841a958e1dcd9c7" title="De&#45;initializes the HASH peripheral registers to their default reset values. " alt="" coords="205,5,303,32"/><area shape="rect" id="node4" href="group___h_a_s_h.html#ga4a7d33f0954ac0463a6cda81121635cf" title="Initializes the HASH peripheral according to the specified parameters in the HASH_InitStruct structur..." alt="" coords="213,56,295,83"/><area shape="rect" id="node5" href="group___h_a_s_h.html#gac4d1fa51c9240ad0287b371564b5d2a6" title="Configure the Number of valid bits in last word of the message. " alt="" coords="148,107,360,133"/><area shape="rect" id="node6" href="group___h_a_s_h.html#ga9c4c0cebdeb1ce2631dd2eeab82107ef" title="Writes data in the Data Input FIFO. " alt="" coords="203,157,305,184"/><area shape="rect" id="node7" href="group___h_a_s_h.html#ga84ac2b64179fd37b75c4d5f665126e93" title="Starts the message padding and calculation of the final message. " alt="" coords="189,208,319,235"/><area shape="rect" id="node8" href="group___h_a_s_h.html#ga826f7bbe15d07c123446cc3d30959f72" title="Checks whether the specified HASH flag is set or not. " alt="" coords="179,259,329,285"/><area shape="rect" id="node9" href="group___h_a_s_h.html#ga23018d770837d6ab9f46941f105cc017" title="Provides the message digest result. " alt="" coords="193,309,315,336"/><area shape="rect" id="node3" href="group___r_c_c.html#gafb119d6d1955d1b8c361e8140845ac5a" title="Forces or releases AHB2 peripheral reset. " alt="" coords="408,5,596,32"/></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>