Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
284
group___h_a_s_h___group1.html
Normal file
284
group___h_a_s_h___group1.html
Normal file
@@ -0,0 +1,284 @@
|
||||
<!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: Initialization and Configuration 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 Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related 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">Initialization and Configuration functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> » <a class="el" href="group___h_a_s_h.html">HASH</a> » <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>Initialization and Configuration functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Initialization and Configuration functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___h_a_s_h___group1.png" border="0" alt="" usemap="#group______h__a__s__h______group1"/>
|
||||
<map name="group______h__a__s__h______group1" id="group______h__a__s__h______group1">
|
||||
<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:ga88717fe3a4f557182841a958e1dcd9c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group1.html#ga88717fe3a4f557182841a958e1dcd9c7">HASH_DeInit</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga88717fe3a4f557182841a958e1dcd9c7"><td class="mdescLeft"> </td><td class="mdescRight">De-initializes the HASH peripheral registers to their default reset values. <a href="#ga88717fe3a4f557182841a958e1dcd9c7">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga88717fe3a4f557182841a958e1dcd9c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga4a7d33f0954ac0463a6cda81121635cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group1.html#ga4a7d33f0954ac0463a6cda81121635cf">HASH_Init</a> (<a class="el" href="struct_h_a_s_h___init_type_def.html">HASH_InitTypeDef</a> *HASH_InitStruct)</td></tr>
|
||||
<tr class="memdesc:ga4a7d33f0954ac0463a6cda81121635cf"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the HASH peripheral according to the specified parameters in the HASH_InitStruct structure. <a href="#ga4a7d33f0954ac0463a6cda81121635cf">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga4a7d33f0954ac0463a6cda81121635cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9cfaaa73eafec40a06154f58d48adeb5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group1.html#ga9cfaaa73eafec40a06154f58d48adeb5">HASH_StructInit</a> (<a class="el" href="struct_h_a_s_h___init_type_def.html">HASH_InitTypeDef</a> *HASH_InitStruct)</td></tr>
|
||||
<tr class="memdesc:ga9cfaaa73eafec40a06154f58d48adeb5"><td class="mdescLeft"> </td><td class="mdescRight">Fills each HASH_InitStruct member with its default value. <a href="#ga9cfaaa73eafec40a06154f58d48adeb5">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9cfaaa73eafec40a06154f58d48adeb5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga11745813cf85a08b2058aac3bd026e4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group1.html#ga11745813cf85a08b2058aac3bd026e4d">HASH_Reset</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga11745813cf85a08b2058aac3bd026e4d"><td class="mdescLeft"> </td><td class="mdescRight">Resets the HASH processor core, so that the HASH will be ready to compute the message digest of a new message. <a href="#ga11745813cf85a08b2058aac3bd026e4d">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga11745813cf85a08b2058aac3bd026e4d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Initialization and Configuration functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### Initialization and Configuration functions #####
|
||||
===============================================================================
|
||||
[..] This section provides functions allowing to
|
||||
(+) Initialize the HASH peripheral
|
||||
(+) Configure the HASH Processor
|
||||
(+) MD5/SHA1,
|
||||
(+) HASH/HMAC,
|
||||
(+) datatype
|
||||
(+) HMAC Key (if mode = HMAC)
|
||||
(+) Reset the HASH Processor </pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga88717fe3a4f557182841a958e1dcd9c7"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_DeInit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>De-initializes the HASH peripheral registers to their default reset values. </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 call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_cgraph.png" border="0" usemap="#group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_cgraph" alt=""/></div>
|
||||
<map name="group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_cgraph" id="group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_c_c.html#gafb119d6d1955d1b8c361e8140845ac5a" title="Forces or releases AHB2 peripheral reset. " alt="" coords="152,5,340,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
<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___group1_ga88717fe3a4f557182841a958e1dcd9c7_icgraph.png" border="0" usemap="#group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_icgraph" alt=""/></div>
|
||||
<map name="group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_icgraph" id="group___h_a_s_h___group1_ga88717fe3a4f557182841a958e1dcd9c7_icgraph">
|
||||
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="157,5,249,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="155,56,250,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="153,107,252,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="152,157,253,184"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga4a7d33f0954ac0463a6cda81121635cf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_Init </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_h_a_s_h___init_type_def.html">HASH_InitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>HASH_InitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initializes the HASH peripheral according to the specified parameters in the HASH_InitStruct structure. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>the hash processor is reset when calling this function so that the HASH will be ready to compute the message digest of a new message. There is no need to call <a class="el" href="group___h_a_s_h___group1.html#ga11745813cf85a08b2058aac3bd026e4d" title="Resets the HASH processor core, so that the HASH will be ready to compute the message digest of a new...">HASH_Reset()</a> function. </dd></dl>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_InitStruct</td><td>pointer to a <a class="el" href="struct_h_a_s_h___init_type_def.html" title="HASH Init structure definition. ">HASH_InitTypeDef</a> structure that contains the configuration information for the HASH peripheral. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section note"><dt>Note</dt><dd>The field HASH_HMACKeyType in <a class="el" href="struct_h_a_s_h___init_type_def.html" title="HASH Init structure definition. ">HASH_InitTypeDef</a> must be filled only if the algorithm mode is 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___group1_ga4a7d33f0954ac0463a6cda81121635cf_icgraph.png" border="0" usemap="#group___h_a_s_h___group1_ga4a7d33f0954ac0463a6cda81121635cf_icgraph" alt=""/></div>
|
||||
<map name="group___h_a_s_h___group1_ga4a7d33f0954ac0463a6cda81121635cf_icgraph" id="group___h_a_s_h___group1_ga4a7d33f0954ac0463a6cda81121635cf_icgraph">
|
||||
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="141,5,233,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="139,56,234,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="137,107,236,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="136,157,237,184"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga11745813cf85a08b2058aac3bd026e4d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_Reset </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Resets the HASH processor core, so that the HASH will be ready to compute the message digest of a new message. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>Calling this function will clear the HASH_SR_DCIS (Digest calculation completion interrupt status) bit corresponding to HASH_IT_DCI interrupt and HASH_FLAG_DCIS flag. </dd></dl>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9cfaaa73eafec40a06154f58d48adeb5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_StructInit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_h_a_s_h___init_type_def.html">HASH_InitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>HASH_InitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Fills each HASH_InitStruct member with its default value. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_InitStruct</td><td>: pointer to a <a class="el" href="struct_h_a_s_h___init_type_def.html" title="HASH Init structure definition. ">HASH_InitTypeDef</a> structure which will be initialized. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section note"><dt>Note</dt><dd>The default values set are : Processor mode is HASH, Algorithm selected is SHA1, Data type selected is 32b and HMAC Key Type is short key. </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>
|
||||
|
||||
</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  <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>
|
||||
Reference in New Issue
Block a user