Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
316
group___c_r_c___private___functions.html
Normal file
316
group___c_r_c___private___functions.html
Normal file
@@ -0,0 +1,316 @@
|
||||
<!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: CRC_Private_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">CRC_Private_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_c.html">CRC</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for CRC_Private_Functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___c_r_c___private___functions.png" border="0" alt="" usemap="#group______c__r__c______private______functions"/>
|
||||
<map name="group______c__r__c______private______functions" id="group______c__r__c______private______functions">
|
||||
<area shape="rect" id="node2" href="group___c_r_c.html" title="CRC driver modules. " alt="" coords="5,5,55,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:ga506467d5ef873a5a4ade4ae83cb110f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#ga506467d5ef873a5a4ade4ae83cb110f6">CRC_ResetDR</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga506467d5ef873a5a4ade4ae83cb110f6"><td class="mdescLeft"> </td><td class="mdescRight">Resets the CRC Data register (DR). <a href="#ga506467d5ef873a5a4ade4ae83cb110f6">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga506467d5ef873a5a4ade4ae83cb110f6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5407fdbb8e8c9be6322cc8856ae5db3b"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#ga5407fdbb8e8c9be6322cc8856ae5db3b">CRC_CalcCRC</a> (uint32_t Data)</td></tr>
|
||||
<tr class="memdesc:ga5407fdbb8e8c9be6322cc8856ae5db3b"><td class="mdescLeft"> </td><td class="mdescRight">Computes the 32-bit CRC of a given data word(32-bit). <a href="#ga5407fdbb8e8c9be6322cc8856ae5db3b">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga5407fdbb8e8c9be6322cc8856ae5db3b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab15ebf620615c360048fb4f45b15fae6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#gab15ebf620615c360048fb4f45b15fae6">CRC_CalcBlockCRC</a> (uint32_t pBuffer[], uint32_t BufferLength)</td></tr>
|
||||
<tr class="memdesc:gab15ebf620615c360048fb4f45b15fae6"><td class="mdescLeft"> </td><td class="mdescRight">Computes the 32-bit CRC of a given buffer of data word(32-bit). <a href="#gab15ebf620615c360048fb4f45b15fae6">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab15ebf620615c360048fb4f45b15fae6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab62db4561b0558f3c8ed53887fe7de8b"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#gab62db4561b0558f3c8ed53887fe7de8b">CRC_GetCRC</a> (void)</td></tr>
|
||||
<tr class="memdesc:gab62db4561b0558f3c8ed53887fe7de8b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current CRC value. <a href="#gab62db4561b0558f3c8ed53887fe7de8b">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab62db4561b0558f3c8ed53887fe7de8b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga769c9a42be57b972ae61bbada0f2e46a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#ga769c9a42be57b972ae61bbada0f2e46a">CRC_SetIDRegister</a> (uint8_t IDValue)</td></tr>
|
||||
<tr class="memdesc:ga769c9a42be57b972ae61bbada0f2e46a"><td class="mdescLeft"> </td><td class="mdescRight">Stores a 8-bit data in the Independent Data(ID) register. <a href="#ga769c9a42be57b972ae61bbada0f2e46a">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga769c9a42be57b972ae61bbada0f2e46a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaf869f6e9c3ca0ae0822cfad1abea7e5f"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_r_c___private___functions.html#gaf869f6e9c3ca0ae0822cfad1abea7e5f">CRC_GetIDRegister</a> (void)</td></tr>
|
||||
<tr class="memdesc:gaf869f6e9c3ca0ae0822cfad1abea7e5f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the 8-bit data stored in the Independent Data(ID) register. <a href="#gaf869f6e9c3ca0ae0822cfad1abea7e5f">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaf869f6e9c3ca0ae0822cfad1abea7e5f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gab15ebf620615c360048fb4f45b15fae6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t CRC_CalcBlockCRC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>pBuffer</em>[], </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>BufferLength</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Computes the 32-bit CRC of a given buffer of data word(32-bit). </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">pBuffer</td><td>pointer to the buffer containing the data to be computed </td></tr>
|
||||
<tr><td class="paramname">BufferLength</td><td>length of the buffer to be computed </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">32-bit</td><td>CRC </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga5407fdbb8e8c9be6322cc8856ae5db3b"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t CRC_CalcCRC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>Data</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Computes the 32-bit CRC of a given data word(32-bit). </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Data</td><td>data word(32-bit) to compute its CRC </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="retval"><dt>Return values</dt><dd>
|
||||
<table class="retval">
|
||||
<tr><td class="paramname">32-bit</td><td>CRC </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab62db4561b0558f3c8ed53887fe7de8b"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t CRC_GetCRC </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the current CRC value. </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">32-bit</td><td>CRC </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaf869f6e9c3ca0ae0822cfad1abea7e5f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint8_t CRC_GetIDRegister </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the 8-bit data stored in the Independent Data(ID) register. </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">8-bit</td><td>value of the ID register </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga506467d5ef873a5a4ade4ae83cb110f6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void CRC_ResetDR </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 CRC Data register (DR). </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>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga769c9a42be57b972ae61bbada0f2e46a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void CRC_SetIDRegister </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>IDValue</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Stores a 8-bit data in the Independent Data(ID) register. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">IDValue</td><td>8-bit value to be stored in the ID register </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: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