Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
285
group___c_r_y_p___group8.html
Normal file
285
group___c_r_y_p___group8.html
Normal file
@@ -0,0 +1,285 @@
|
||||
<!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 DES 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">High Level DES 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___c_r_y_p.html">CRYP</a> » <a class="el" href="group___c_r_y_p___private___functions.html">CRYP_Private_Functions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>High Level DES functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for High Level DES functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___c_r_y_p___group8.png" border="0" alt="" usemap="#group______c__r__y__p______group8"/>
|
||||
<map name="group______c__r__y__p______group8" id="group______c__r__y__p______group8">
|
||||
<area shape="rect" id="node2" href="group___c_r_y_p___private___functions.html" title="CRYP_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:ga3b96b7608b39197209abed5f5845f590"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_y_p___group8.html#ga3b96b7608b39197209abed5f5845f590">CRYP_DES_ECB</a> (uint8_t Mode, uint8_t Key[8], uint8_t *Input, uint32_t Ilength, uint8_t *Output)</td></tr>
|
||||
<tr class="memdesc:ga3b96b7608b39197209abed5f5845f590"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt and decrypt using DES in ECB Mode. <a href="#ga3b96b7608b39197209abed5f5845f590">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga3b96b7608b39197209abed5f5845f590"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga75724391a8560c557e1152b805f5cad1"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_y_p___group8.html#ga75724391a8560c557e1152b805f5cad1">CRYP_DES_CBC</a> (uint8_t Mode, uint8_t Key[8], uint8_t InitVectors[8], uint8_t *Input, uint32_t Ilength, uint8_t *Output)</td></tr>
|
||||
<tr class="memdesc:ga75724391a8560c557e1152b805f5cad1"><td class="mdescLeft"> </td><td class="mdescRight">Encrypt and decrypt using DES in CBC Mode. <a href="#ga75724391a8560c557e1152b805f5cad1">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga75724391a8560c557e1152b805f5cad1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>High Level DES functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### High Level DES functions #####
|
||||
===============================================================================
|
||||
</pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga75724391a8560c557e1152b805f5cad1"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus CRYP_DES_CBC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>Mode</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>Key</em>[8], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>InitVectors</em>[8], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>Input</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>Ilength</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>Output</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Encrypt and decrypt using DES in CBC Mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Mode</td><td>encryption or decryption Mode. This parameter can be one of the following values: <ul>
|
||||
<li>MODE_ENCRYPT: Encryption </li>
|
||||
<li>MODE_DECRYPT: Decryption </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">Key</td><td>Key used for DES algorithm. </td></tr>
|
||||
<tr><td class="paramname">InitVectors</td><td>Initialisation Vectors used for DES algorithm. </td></tr>
|
||||
<tr><td class="paramname">Ilength</td><td>length of the Input buffer, must be a multiple of 8. </td></tr>
|
||||
<tr><td class="paramname">Input</td><td>pointer to the Input buffer. </td></tr>
|
||||
<tr><td class="paramname">Output</td><td>pointer to the returned buffer. </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: Operation done</li>
|
||||
<li>ERROR: Operation 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___c_r_y_p___group8_ga75724391a8560c557e1152b805f5cad1_cgraph.png" border="0" usemap="#group___c_r_y_p___group8_ga75724391a8560c557e1152b805f5cad1_cgraph" alt=""/></div>
|
||||
<map name="group___c_r_y_p___group8_ga75724391a8560c557e1152b805f5cad1_cgraph" id="group___c_r_y_p___group8_ga75724391a8560c557e1152b805f5cad1_cgraph">
|
||||
<area shape="rect" id="node2" href="group___c_r_y_p.html#gaeecd86b00d0d0137d97b06108789bcb2" title="Fills each CRYP_KeyInitStruct member with its default value. " alt="" coords="185,5,325,32"/><area shape="rect" id="node3" href="group___c_r_y_p.html#ga7b72c458d95581ab0a36be3e017fcf02" title="Initializes the CRYP peripheral according to the specified parameters in the CRYP_InitStruct. " alt="" coords="214,56,297,83"/><area shape="rect" id="node4" href="group___c_r_y_p.html#gad4baa3865415215cae07c9fbfa131cb9" title="Initializes the CRYP Keys according to the specified parameters in the CRYP_KeyInitStruct. " alt="" coords="203,107,308,133"/><area shape="rect" id="node5" href="group___c_r_y_p.html#ga133964b50a07db3a32864308f6355a8b" title="Initializes the CRYP Initialization Vectors(IV) according to the specified parameters in the CRYP_IVI..." alt="" coords="208,157,303,184"/><area shape="rect" id="node6" href="group___c_r_y_p.html#ga23ada9d9464e1362299d7612a1409a57" title="Flushes the IN and OUT FIFOs (that is read and write pointers of the FIFOs are reset) ..." alt="" coords="192,208,319,235"/><area shape="rect" id="node7" href="group___c_r_y_p.html#gad39ccd9b1f2e088e3a227d7a1c410d7c" title="Enables or disables the CRYP peripheral. " alt="" coords="209,259,301,285"/><area shape="rect" id="node8" href="group___c_r_y_p.html#gabe26186adf64660a4a573bd6a4368fee" title="Returns whether CRYP peripheral is enabled or disabled. " alt="" coords="180,309,331,336"/><area shape="rect" id="node9" href="group___c_r_y_p.html#ga16dc76244318d464357ee6ff208bf9a4" title="Writes data in the Data Input register (DIN). " alt="" coords="204,360,307,387"/><area shape="rect" id="node10" href="group___c_r_y_p.html#ga993d568b626a74b2973d4a6848a681f6" title="Checks whether the specified CRYP flag is set or not. " alt="" coords="181,411,330,437"/><area shape="rect" id="node11" href="group___c_r_y_p.html#gacbe5fcf4c7e4919192376fa615588b54" title="Returns the last data entered into the output FIFO. " alt="" coords="199,461,312,488"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga3b96b7608b39197209abed5f5845f590"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus CRYP_DES_ECB </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>Mode</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>Key</em>[8], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>Input</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>Ilength</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>Output</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Encrypt and decrypt using DES in ECB Mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Mode</td><td>encryption or decryption Mode. This parameter can be one of the following values: <ul>
|
||||
<li>MODE_ENCRYPT: Encryption </li>
|
||||
<li>MODE_DECRYPT: Decryption </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">Key</td><td>Key used for DES algorithm. </td></tr>
|
||||
<tr><td class="paramname">Ilength</td><td>length of the Input buffer, must be a multiple of 8. </td></tr>
|
||||
<tr><td class="paramname">Input</td><td>pointer to the Input buffer. </td></tr>
|
||||
<tr><td class="paramname">Output</td><td>pointer to the returned buffer. </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: Operation done</li>
|
||||
<li>ERROR: Operation 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___c_r_y_p___group8_ga3b96b7608b39197209abed5f5845f590_cgraph.png" border="0" usemap="#group___c_r_y_p___group8_ga3b96b7608b39197209abed5f5845f590_cgraph" alt=""/></div>
|
||||
<map name="group___c_r_y_p___group8_ga3b96b7608b39197209abed5f5845f590_cgraph" id="group___c_r_y_p___group8_ga3b96b7608b39197209abed5f5845f590_cgraph">
|
||||
<area shape="rect" id="node2" href="group___c_r_y_p.html#gaeecd86b00d0d0137d97b06108789bcb2" title="Fills each CRYP_KeyInitStruct member with its default value. " alt="" coords="185,5,325,32"/><area shape="rect" id="node3" href="group___c_r_y_p.html#ga7b72c458d95581ab0a36be3e017fcf02" title="Initializes the CRYP peripheral according to the specified parameters in the CRYP_InitStruct. " alt="" coords="214,56,297,83"/><area shape="rect" id="node4" href="group___c_r_y_p.html#gad4baa3865415215cae07c9fbfa131cb9" title="Initializes the CRYP Keys according to the specified parameters in the CRYP_KeyInitStruct. " alt="" coords="203,107,308,133"/><area shape="rect" id="node5" href="group___c_r_y_p.html#ga23ada9d9464e1362299d7612a1409a57" title="Flushes the IN and OUT FIFOs (that is read and write pointers of the FIFOs are reset) ..." alt="" coords="192,157,319,184"/><area shape="rect" id="node6" href="group___c_r_y_p.html#gad39ccd9b1f2e088e3a227d7a1c410d7c" title="Enables or disables the CRYP peripheral. " alt="" coords="209,208,301,235"/><area shape="rect" id="node7" href="group___c_r_y_p.html#gabe26186adf64660a4a573bd6a4368fee" title="Returns whether CRYP peripheral is enabled or disabled. " alt="" coords="180,259,331,285"/><area shape="rect" id="node8" href="group___c_r_y_p.html#ga16dc76244318d464357ee6ff208bf9a4" title="Writes data in the Data Input register (DIN). " alt="" coords="204,309,307,336"/><area shape="rect" id="node9" href="group___c_r_y_p.html#ga993d568b626a74b2973d4a6848a681f6" title="Checks whether the specified CRYP flag is set or not. " alt="" coords="181,360,330,387"/><area shape="rect" id="node10" href="group___c_r_y_p.html#gacbe5fcf4c7e4919192376fa615588b54" title="Returns the last data entered into the output FIFO. " alt="" coords="199,411,312,437"/></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:19 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