Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
357
group___r_t_c___group7.html
Normal file
357
group___r_t_c___group7.html
Normal file
@@ -0,0 +1,357 @@
|
||||
<!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: Digital Calibration 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">Digital Calibration 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___r_t_c.html">RTC</a> » <a class="el" href="group___r_t_c___private___functions.html">RTC_Private_Functions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Coarse Calibration configuration functions.
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for Digital Calibration configuration functions:</div>
|
||||
<div class="dyncontent">
|
||||
<center><table><tr><td><img src="group___r_t_c___group7.png" border="0" alt="" usemap="#group______r__t__c______group7"/>
|
||||
<map name="group______r__t__c______group7" id="group______r__t__c______group7">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___private___functions.html" title="RTC_Private_Functions" alt="" coords="5,13,163,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:gaa3bb10170a2c70ac9ce3e41c611bdd43"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group7.html#gaa3bb10170a2c70ac9ce3e41c611bdd43">RTC_CoarseCalibConfig</a> (uint32_t RTC_CalibSign, uint32_t Value)</td></tr>
|
||||
<tr class="memdesc:gaa3bb10170a2c70ac9ce3e41c611bdd43"><td class="mdescLeft"> </td><td class="mdescRight">Configures the Coarse calibration parameters. <a href="#gaa3bb10170a2c70ac9ce3e41c611bdd43">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa3bb10170a2c70ac9ce3e41c611bdd43"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga008ae7173b2befe876f5e76686bc9089"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group7.html#ga008ae7173b2befe876f5e76686bc9089">RTC_CoarseCalibCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga008ae7173b2befe876f5e76686bc9089"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the Coarse calibration process. <a href="#ga008ae7173b2befe876f5e76686bc9089">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga008ae7173b2befe876f5e76686bc9089"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga25eaa2de5ee858a4572d5fb1eb146ff8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group7.html#ga25eaa2de5ee858a4572d5fb1eb146ff8">RTC_CalibOutputCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga25eaa2de5ee858a4572d5fb1eb146ff8"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the RTC clock to be output through the relative pin. <a href="#ga25eaa2de5ee858a4572d5fb1eb146ff8">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga25eaa2de5ee858a4572d5fb1eb146ff8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2139adc802bdb6882904c0b855d50b29"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group7.html#ga2139adc802bdb6882904c0b855d50b29">RTC_CalibOutputConfig</a> (uint32_t RTC_CalibOutput)</td></tr>
|
||||
<tr class="memdesc:ga2139adc802bdb6882904c0b855d50b29"><td class="mdescLeft"> </td><td class="mdescRight">Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). <a href="#ga2139adc802bdb6882904c0b855d50b29">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2139adc802bdb6882904c0b855d50b29"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga91a28dcc7d45340a469dd8b8c029f841"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group7.html#ga91a28dcc7d45340a469dd8b8c029f841">RTC_SmoothCalibConfig</a> (uint32_t RTC_SmoothCalibPeriod, uint32_t RTC_SmoothCalibPlusPulses, uint32_t RTC_SmouthCalibMinusPulsesValue)</td></tr>
|
||||
<tr class="memdesc:ga91a28dcc7d45340a469dd8b8c029f841"><td class="mdescLeft"> </td><td class="mdescRight">Configures the Smooth Calibration Settings. <a href="#ga91a28dcc7d45340a469dd8b8c029f841">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga91a28dcc7d45340a469dd8b8c029f841"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Coarse Calibration configuration functions. </p>
|
||||
<pre class="fragment"> ===============================================================================
|
||||
##### Digital Calibration configuration functions #####
|
||||
=============================================================================== </pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga25eaa2de5ee858a4572d5fb1eb146ff8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_CalibOutputCmd </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">FunctionalState </td>
|
||||
<td class="paramname"><em>NewState</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enables or disables the RTC clock to be output through the relative pin. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the digital calibration Output. 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>
|
||||
<a class="anchor" id="ga2139adc802bdb6882904c0b855d50b29"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_CalibOutputConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>RTC_CalibOutput</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">RTC_CalibOutput</td><td>: Select the Calibration output Selection . This parameter can be one of the following values: <ul>
|
||||
<li>RTC_CalibOutput_512Hz: A signal has a regular waveform at 512Hz. </li>
|
||||
<li>RTC_CalibOutput_1Hz : A signal has a regular waveform at 1Hz. </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="ga008ae7173b2befe876f5e76686bc9089"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_CoarseCalibCmd </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">FunctionalState </td>
|
||||
<td class="paramname"><em>NewState</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enables or disables the Coarse calibration process. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the Coarse calibration. 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">An</td><td>ErrorStatus enumeration value:<ul>
|
||||
<li>SUCCESS: RTC Coarse calibration are enabled/disabled</li>
|
||||
<li>ERROR: RTC Coarse calibration are not enabled/disabled </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___r_t_c___group7_ga008ae7173b2befe876f5e76686bc9089_cgraph.png" border="0" usemap="#group___r_t_c___group7_ga008ae7173b2befe876f5e76686bc9089_cgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group7_ga008ae7173b2befe876f5e76686bc9089_cgraph" id="group___r_t_c___group7_ga008ae7173b2befe876f5e76686bc9089_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="204,5,339,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="208,56,335,83"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa3bb10170a2c70ac9ce3e41c611bdd43"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_CoarseCalibConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>RTC_CalibSign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>Value</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Configures the Coarse calibration parameters. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">RTC_CalibSign</td><td>specifies the sign of the coarse calibration value. This parameter can be one of the following values: <ul>
|
||||
<li>RTC_CalibSign_Positive: The value sign is positive </li>
|
||||
<li>RTC_CalibSign_Negative: The value sign is negative </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">Value</td><td>value of coarse calibration expressed in ppm (coded on 5 bits).</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section note"><dt>Note</dt><dd>This Calibration value should be between 0 and 63 when using negative sign with a 2-ppm step.</dd>
|
||||
<dd>
|
||||
This Calibration value should be between 0 and 126 when using positive sign with a 4-ppm step.</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: RTC Coarse calibration are initialized</li>
|
||||
<li>ERROR: RTC Coarse calibration are not initialized </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___r_t_c___group7_gaa3bb10170a2c70ac9ce3e41c611bdd43_cgraph.png" border="0" usemap="#group___r_t_c___group7_gaa3bb10170a2c70ac9ce3e41c611bdd43_cgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group7_gaa3bb10170a2c70ac9ce3e41c611bdd43_cgraph" id="group___r_t_c___group7_gaa3bb10170a2c70ac9ce3e41c611bdd43_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="213,5,348,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="217,56,344,83"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga91a28dcc7d45340a469dd8b8c029f841"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_SmoothCalibConfig </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>RTC_SmoothCalibPeriod</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>RTC_SmoothCalibPlusPulses</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>RTC_SmouthCalibMinusPulsesValue</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Configures the Smooth Calibration Settings. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">RTC_SmoothCalibPeriod</td><td>: Select the Smooth Calibration Period. This parameter can be can be one of the following values: <ul>
|
||||
<li>RTC_SmoothCalibPeriod_32sec : The smooth calibration period is 32s. </li>
|
||||
<li>RTC_SmoothCalibPeriod_16sec : The smooth calibration period is 16s. </li>
|
||||
<li>RTC_SmoothCalibPeriod_8sec : The smooth calibartion period is 8s. </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">RTC_SmoothCalibPlusPulses</td><td>: Select to Set or reset the CALP bit. This parameter can be one of the following values: <ul>
|
||||
<li>RTC_SmoothCalibPlusPulses_Set : Add one RTCCLK puls every 2**11 pulses. </li>
|
||||
<li>RTC_SmoothCalibPlusPulses_Reset: No RTCCLK pulses are added. </li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
<tr><td class="paramname">RTC_SmouthCalibMinusPulsesValue</td><td>Select the value of CALM[8:0] bits. This parameter can be one any value from 0 to 0x000001FF. </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: RTC Calib registers are configured</li>
|
||||
<li>ERROR: RTC Calib registers are not configured </li>
|
||||
</ul>
|
||||
</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