Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
371
group___h_a_s_h___group5.html
Normal file
371
group___h_a_s_h___group5.html
Normal file
@@ -0,0 +1,371 @@
|
||||
<!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: Interrupts and flags management 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">Interrupts and flags management 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>Interrupts and flags management functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Interrupts and flags management functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___h_a_s_h___group5.png" border="0" alt="" usemap="#group______h__a__s__h______group5"/>
|
||||
<map name="group______h__a__s__h______group5" id="group______h__a__s__h______group5">
|
||||
<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:ga2559847a2b44be3c66e1155500810059"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group5.html#ga2559847a2b44be3c66e1155500810059">HASH_ITConfig</a> (uint32_t HASH_IT, FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga2559847a2b44be3c66e1155500810059"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the specified HASH interrupts. <a href="#ga2559847a2b44be3c66e1155500810059">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2559847a2b44be3c66e1155500810059"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga826f7bbe15d07c123446cc3d30959f72"><td class="memItemLeft" align="right" valign="top">FlagStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group5.html#ga826f7bbe15d07c123446cc3d30959f72">HASH_GetFlagStatus</a> (uint32_t HASH_FLAG)</td></tr>
|
||||
<tr class="memdesc:ga826f7bbe15d07c123446cc3d30959f72"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified HASH flag is set or not. <a href="#ga826f7bbe15d07c123446cc3d30959f72">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga826f7bbe15d07c123446cc3d30959f72"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae5a1d3897008d8923913b052e511ec0d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group5.html#gae5a1d3897008d8923913b052e511ec0d">HASH_ClearFlag</a> (uint32_t HASH_FLAG)</td></tr>
|
||||
<tr class="memdesc:gae5a1d3897008d8923913b052e511ec0d"><td class="mdescLeft"> </td><td class="mdescRight">Clears the HASH flags. <a href="#gae5a1d3897008d8923913b052e511ec0d">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae5a1d3897008d8923913b052e511ec0d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab20c96ef920c62f6fa5efb72cfad95f6"><td class="memItemLeft" align="right" valign="top">ITStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group5.html#gab20c96ef920c62f6fa5efb72cfad95f6">HASH_GetITStatus</a> (uint32_t HASH_IT)</td></tr>
|
||||
<tr class="memdesc:gab20c96ef920c62f6fa5efb72cfad95f6"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified HASH interrupt has occurred or not. <a href="#gab20c96ef920c62f6fa5efb72cfad95f6">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab20c96ef920c62f6fa5efb72cfad95f6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga1c75ffce3992eced01403dd429a673fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h_a_s_h___group5.html#ga1c75ffce3992eced01403dd429a673fd">HASH_ClearITPendingBit</a> (uint32_t HASH_IT)</td></tr>
|
||||
<tr class="memdesc:ga1c75ffce3992eced01403dd429a673fd"><td class="mdescLeft"> </td><td class="mdescRight">Clears the HASH interrupt pending bit(s). <a href="#ga1c75ffce3992eced01403dd429a673fd">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga1c75ffce3992eced01403dd429a673fd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Interrupts and flags management functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### Interrupts and flags management functions #####
|
||||
===============================================================================
|
||||
|
||||
[..] This section provides functions allowing to configure the HASH Interrupts and
|
||||
to get the status and clear flags and Interrupts pending bits.
|
||||
|
||||
[..] The HASH provides 2 Interrupts sources and 5 Flags:
|
||||
|
||||
*** Flags : ***
|
||||
===============
|
||||
[..]
|
||||
(#) HASH_FLAG_DINIS : set when 16 locations are free in the Data IN FIFO
|
||||
which means that a new block (512 bit) can be entered into the input buffer.
|
||||
|
||||
(#) HASH_FLAG_DCIS : set when Digest calculation is complete
|
||||
|
||||
(#) HASH_FLAG_DMAS : set when HASH's DMA interface is enabled (DMAE=1) or
|
||||
a transfer is ongoing. This Flag is cleared only by hardware.
|
||||
|
||||
(#) HASH_FLAG_BUSY : set when The hash core is processing a block of data
|
||||
This Flag is cleared only by hardware.
|
||||
|
||||
(#) HASH_FLAG_DINNE : set when Data IN FIFO is not empty which means that
|
||||
the Data IN FIFO contains at least one word of data. This Flag is cleared
|
||||
only by hardware.
|
||||
|
||||
*** Interrupts : ***
|
||||
====================
|
||||
[..]
|
||||
(#) HASH_IT_DINI : if enabled, this interrupt source is pending when 16
|
||||
locations are free in the Data IN FIFO which means that a new block (512 bit)
|
||||
can be entered into the input buffer. This interrupt source is cleared using
|
||||
HASH_ClearITPendingBit(HASH_IT_DINI) function.
|
||||
|
||||
(#) HASH_IT_DCI : if enabled, this interrupt source is pending when Digest
|
||||
calculation is complete. This interrupt source is cleared using
|
||||
HASH_ClearITPendingBit(HASH_IT_DCI) function.
|
||||
|
||||
*** Managing the HASH controller events : ***
|
||||
=============================================
|
||||
[..] The user should identify which mode will be used in his application to manage
|
||||
the HASH controller events: Polling mode or Interrupt mode.
|
||||
|
||||
(#) In the Polling Mode it is advised to use the following functions:
|
||||
(++) HASH_GetFlagStatus() : to check if flags events occur.
|
||||
(++) HASH_ClearFlag() : to clear the flags events.
|
||||
|
||||
(#) In the Interrupt Mode it is advised to use the following functions:
|
||||
(++) HASH_ITConfig() : to enable or disable the interrupt source.
|
||||
(++) HASH_GetITStatus() : to check if Interrupt occurs.
|
||||
(++) HASH_ClearITPendingBit() : to clear the Interrupt pending Bit
|
||||
(corresponding Flag). </pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gae5a1d3897008d8923913b052e511ec0d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_ClearFlag </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>HASH_FLAG</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the HASH flags. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_FLAG</td><td>specifies the flag to clear. This parameter can be any combination of the following values: <ul>
|
||||
<li>HASH_FLAG_DINIS: Data Input Flag </li>
|
||||
<li>HASH_FLAG_DCIS: Digest Calculation Completion Flag </li>
|
||||
</ul>
|
||||
</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="ga1c75ffce3992eced01403dd429a673fd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_ClearITPendingBit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>HASH_IT</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Clears the HASH interrupt pending bit(s). </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_IT</td><td>specifies the HASH interrupt pending bit(s) to clear. This parameter can be any combination of the following values: <ul>
|
||||
<li>HASH_IT_DINI: Data Input interrupt </li>
|
||||
<li>HASH_IT_DCI: Digest Calculation Completion Interrupt </li>
|
||||
</ul>
|
||||
</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="ga826f7bbe15d07c123446cc3d30959f72"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">FlagStatus HASH_GetFlagStatus </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>HASH_FLAG</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified HASH flag is set or not. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_FLAG</td><td>specifies the HASH flag to check. This parameter can be one of the following values: <ul>
|
||||
<li>HASH_FLAG_DINIS: Data input interrupt status flag </li>
|
||||
<li>HASH_FLAG_DCIS: Digest calculation completion interrupt status flag </li>
|
||||
<li>HASH_FLAG_BUSY: Busy flag </li>
|
||||
<li>HASH_FLAG_DMAS: DMAS Status flag </li>
|
||||
<li>HASH_FLAG_DINNE: Data Input register (DIN) not empty status flag </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">The</td><td>new state of HASH_FLAG (SET or RESET) </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___group5_ga826f7bbe15d07c123446cc3d30959f72_icgraph.png" border="0" usemap="#group___h_a_s_h___group5_ga826f7bbe15d07c123446cc3d30959f72_icgraph" alt=""/></div>
|
||||
<map name="group___h_a_s_h___group5_ga826f7bbe15d07c123446cc3d30959f72_icgraph" id="group___h_a_s_h___group5_ga826f7bbe15d07c123446cc3d30959f72_icgraph">
|
||||
<area shape="rect" id="node2" href="group___h_a_s_h___group7.html#ga82a155884e458cc6b7c1a4565c1ac8e9" title="Compute the HASH MD5 digest. " alt="" coords="207,5,299,32"/><area shape="rect" id="node3" href="group___h_a_s_h___group7.html#gac61733e7aa66bdd2f21be4b34165b5be" title="Compute the HMAC MD5 digest. " alt="" coords="206,56,301,83"/><area shape="rect" id="node4" href="group___h_a_s_h___group6.html#ga2728c02c36de6d800e1ede56ea7789cb" title="Compute the HASH SHA1 digest. " alt="" coords="204,107,303,133"/><area shape="rect" id="node5" href="group___h_a_s_h___group6.html#ga2e38e900ca7838c1cea17cef19953a5e" title="Compute the HMAC SHA1 digest. " alt="" coords="203,157,304,184"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab20c96ef920c62f6fa5efb72cfad95f6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ITStatus HASH_GetITStatus </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>HASH_IT</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Checks whether the specified HASH interrupt has occurred or not. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_IT</td><td>specifies the HASH interrupt source to check. This parameter can be one of the following values: <ul>
|
||||
<li>HASH_IT_DINI: Data Input interrupt </li>
|
||||
<li>HASH_IT_DCI: Digest Calculation Completion Interrupt </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">The</td><td>new state of HASH_IT (SET or RESET). </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga2559847a2b44be3c66e1155500810059"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HASH_ITConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>HASH_IT</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">FunctionalState </td>
|
||||
<td class="paramname"><em>NewState</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enables or disables the specified HASH interrupts. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">HASH_IT</td><td>specifies the HASH interrupt source to be enabled or disabled. This parameter can be any combination of the following values: <ul>
|
||||
<li>HASH_IT_DINI: Data Input interrupt </li>
|
||||
<li>HASH_IT_DCI: Digest Calculation Completion Interrupt </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">NewState</td><td>new state of the specified HASH interrupt. This parameter can be: ENABLE or DISABLE. </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>
|
||||
</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