Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
526
group___r_t_c___group1.html
Normal file
526
group___r_t_c___group1.html
Normal file
@@ -0,0 +1,526 @@
|
||||
<!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___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>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___r_t_c___group1.png" border="0" alt="" usemap="#group______r__t__c______group1"/>
|
||||
<map name="group______r__t__c______group1" id="group______r__t__c______group1">
|
||||
<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:ga9777c6cc4a99c339ebc527a791b2ebe7"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga9777c6cc4a99c339ebc527a791b2ebe7">RTC_DeInit</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga9777c6cc4a99c339ebc527a791b2ebe7"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes the RTC registers to their default reset values. <a href="#ga9777c6cc4a99c339ebc527a791b2ebe7">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9777c6cc4a99c339ebc527a791b2ebe7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8eb747bf9698b2482ba6ef4d811de8e0"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga8eb747bf9698b2482ba6ef4d811de8e0">RTC_Init</a> (<a class="el" href="struct_r_t_c___init_type_def.html">RTC_InitTypeDef</a> *RTC_InitStruct)</td></tr>
|
||||
<tr class="memdesc:ga8eb747bf9698b2482ba6ef4d811de8e0"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the RTC registers according to the specified parameters in RTC_InitStruct. <a href="#ga8eb747bf9698b2482ba6ef4d811de8e0">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8eb747bf9698b2482ba6ef4d811de8e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab466f3348de3236976e9aec7d6025dff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#gab466f3348de3236976e9aec7d6025dff">RTC_StructInit</a> (<a class="el" href="struct_r_t_c___init_type_def.html">RTC_InitTypeDef</a> *RTC_InitStruct)</td></tr>
|
||||
<tr class="memdesc:gab466f3348de3236976e9aec7d6025dff"><td class="mdescLeft"> </td><td class="mdescRight">Fills each RTC_InitStruct member with its default value. <a href="#gab466f3348de3236976e9aec7d6025dff">More...</a><br /></td></tr>
|
||||
<tr class="separator:gab466f3348de3236976e9aec7d6025dff"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9d4bdfd3ae6957630d15d2497573b7c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga9d4bdfd3ae6957630d15d2497573b7c7">RTC_WriteProtectionCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:ga9d4bdfd3ae6957630d15d2497573b7c7"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the RTC registers write protection. <a href="#ga9d4bdfd3ae6957630d15d2497573b7c7">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9d4bdfd3ae6957630d15d2497573b7c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga679f8883cbfb267a53ffb1ab4cc5c8c5"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5">RTC_EnterInitMode</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga679f8883cbfb267a53ffb1ab4cc5c8c5"><td class="mdescLeft"> </td><td class="mdescRight">Enters the RTC Initialization mode. <a href="#ga679f8883cbfb267a53ffb1ab4cc5c8c5">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga679f8883cbfb267a53ffb1ab4cc5c8c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga87f86f3b794205f09a1eac51738d900f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f">RTC_ExitInitMode</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga87f86f3b794205f09a1eac51738d900f"><td class="mdescLeft"> </td><td class="mdescRight">Exits the RTC Initialization mode. <a href="#ga87f86f3b794205f09a1eac51738d900f">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga87f86f3b794205f09a1eac51738d900f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2938febeef6baf0d91cc066ca5caf095"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#ga2938febeef6baf0d91cc066ca5caf095">RTC_WaitForSynchro</a> (void)</td></tr>
|
||||
<tr class="memdesc:ga2938febeef6baf0d91cc066ca5caf095"><td class="mdescLeft"> </td><td class="mdescRight">Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock. <a href="#ga2938febeef6baf0d91cc066ca5caf095">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2938febeef6baf0d91cc066ca5caf095"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa60079ec257fb3a277d058ca8305533d"><td class="memItemLeft" align="right" valign="top">ErrorStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#gaa60079ec257fb3a277d058ca8305533d">RTC_RefClockCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:gaa60079ec257fb3a277d058ca8305533d"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the RTC reference clock detection. <a href="#gaa60079ec257fb3a277d058ca8305533d">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa60079ec257fb3a277d058ca8305533d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae5e7c682f15b8ae9ddd3b2a85a9df7db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group1.html#gae5e7c682f15b8ae9ddd3b2a85a9df7db">RTC_BypassShadowCmd</a> (FunctionalState NewState)</td></tr>
|
||||
<tr class="memdesc:gae5e7c682f15b8ae9ddd3b2a85a9df7db"><td class="mdescLeft"> </td><td class="mdescRight">Enables or Disables the Bypass Shadow feature. <a href="#gae5e7c682f15b8ae9ddd3b2a85a9df7db">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae5e7c682f15b8ae9ddd3b2a85a9df7db"><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 provide functions allowing to initialize and configure the RTC
|
||||
Prescaler (Synchronous and Asynchronous), RTC Hour format, disable RTC registers
|
||||
Write protection, enter and exit the RTC initialization mode, RTC registers
|
||||
synchronization check and reference clock detection enable.
|
||||
|
||||
(#) The RTC Prescaler is programmed to generate the RTC 1Hz time base. It is
|
||||
split into 2 programmable prescalers to minimize power consumption.
|
||||
(++) A 7-bit asynchronous prescaler and A 13-bit synchronous prescaler.
|
||||
(++) When both prescalers are used, it is recommended to configure the
|
||||
asynchronous prescaler to a high value to minimize consumption.
|
||||
|
||||
(#) All RTC registers are Write protected. Writing to the RTC registers
|
||||
is enabled by writing a key into the Write Protection register, RTC_WPR.
|
||||
|
||||
(#) To Configure the RTC Calendar, user application should enter initialization
|
||||
mode. In this mode, the calendar counter is stopped and its value can be
|
||||
updated. When the initialization sequence is complete, the calendar restarts
|
||||
counting after 4 RTCCLK cycles.
|
||||
|
||||
(#) To read the calendar through the shadow registers after Calendar initialization,
|
||||
calendar update or after wakeup from low power modes the software must first
|
||||
clear the RSF flag. The software must then wait until it is set again before
|
||||
reading the calendar, which means that the calendar registers have been
|
||||
correctly copied into the RTC_TR and RTC_DR shadow registers.
|
||||
The RTC_WaitForSynchro() function implements the above software sequence
|
||||
(RSF clear and RSF check).</pre> <h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gae5e7c682f15b8ae9ddd3b2a85a9df7db"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_BypassShadowCmd </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 Bypass Shadow feature. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter. </dd></dl>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the Bypass Shadow feature. 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="ga9777c6cc4a99c339ebc527a791b2ebe7"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_DeInit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Deinitializes the RTC registers to their default reset values. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>This function doesn't reset the RTC Clock source and RTC Backup Data registers. </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">An</td><td>ErrorStatus enumeration value:<ul>
|
||||
<li>SUCCESS: RTC registers are deinitialized</li>
|
||||
<li>ERROR: RTC registers are not deinitialized </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___group1_ga9777c6cc4a99c339ebc527a791b2ebe7_cgraph.png" border="0" usemap="#group___r_t_c___group1_ga9777c6cc4a99c339ebc527a791b2ebe7_cgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_ga9777c6cc4a99c339ebc527a791b2ebe7_cgraph" id="group___r_t_c___group1_ga9777c6cc4a99c339ebc527a791b2ebe7_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="147,5,281,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga2938febeef6baf0d91cc066ca5caf095" title="Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock..." alt="" coords="140,56,288,83"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga679f8883cbfb267a53ffb1ab4cc5c8c5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_EnterInitMode </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Enters the RTC Initialization mode. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>The RTC Initialization mode is write protected, use the RTC_WriteProtectionCmd(DISABLE) before calling this function. </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">An</td><td>ErrorStatus enumeration value:<ul>
|
||||
<li>SUCCESS: RTC is in Init mode</li>
|
||||
<li>ERROR: RTC is not in Init mode </li>
|
||||
</ul>
|
||||
</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___r_t_c___group1_ga679f8883cbfb267a53ffb1ab4cc5c8c5_icgraph.png" border="0" usemap="#group___r_t_c___group1_ga679f8883cbfb267a53ffb1ab4cc5c8c5_icgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_ga679f8883cbfb267a53ffb1ab4cc5c8c5_icgraph" id="group___r_t_c___group1_ga679f8883cbfb267a53ffb1ab4cc5c8c5_icgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga9777c6cc4a99c339ebc527a791b2ebe7" title="Deinitializes the RTC registers to their default reset values. " alt="" coords="225,5,311,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga8eb747bf9698b2482ba6ef4d811de8e0" title="Initializes the RTC registers according to the specified parameters in RTC_InitStruct. " alt="" coords="233,56,303,83"/><area shape="rect" id="node4" href="group___r_t_c___group1.html#gaa60079ec257fb3a277d058ca8305533d" title="Enables or disables the RTC reference clock detection. " alt="" coords="201,107,335,133"/><area shape="rect" id="node5" href="group___r_t_c___group2.html#ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6" title="Set the RTC current time. " alt="" coords="217,157,319,184"/><area shape="rect" id="node6" href="group___r_t_c___group2.html#ga69d08538147f3d89c818dcfabf50e362" title="Set the RTC current date. " alt="" coords="217,208,319,235"/><area shape="rect" id="node7" href="group___r_t_c___group7.html#gaa3bb10170a2c70ac9ce3e41c611bdd43" title="Configures the Coarse calibration parameters. " alt="" coords="188,259,348,285"/><area shape="rect" id="node8" href="group___r_t_c___group7.html#ga008ae7173b2befe876f5e76686bc9089" title="Enables or disables the Coarse calibration process. " alt="" coords="193,309,343,336"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga87f86f3b794205f09a1eac51738d900f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_ExitInitMode </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Exits the RTC Initialization mode. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>When the initialization sequence is complete, the calendar restarts counting after 4 RTCCLK cycles. </dd>
|
||||
<dd>
|
||||
The RTC Initialization mode is write protected, use the RTC_WriteProtectionCmd(DISABLE) before calling this function. </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>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the caller graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group___r_t_c___group1_ga87f86f3b794205f09a1eac51738d900f_icgraph.png" border="0" usemap="#group___r_t_c___group1_ga87f86f3b794205f09a1eac51738d900f_icgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_ga87f86f3b794205f09a1eac51738d900f_icgraph" id="group___r_t_c___group1_ga87f86f3b794205f09a1eac51738d900f_icgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga8eb747bf9698b2482ba6ef4d811de8e0" title="Initializes the RTC registers according to the specified parameters in RTC_InitStruct. " alt="" coords="225,5,295,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#gaa60079ec257fb3a277d058ca8305533d" title="Enables or disables the RTC reference clock detection. " alt="" coords="193,56,327,83"/><area shape="rect" id="node4" href="group___r_t_c___group2.html#ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6" title="Set the RTC current time. " alt="" coords="209,107,311,133"/><area shape="rect" id="node5" href="group___r_t_c___group2.html#ga69d08538147f3d89c818dcfabf50e362" title="Set the RTC current date. " alt="" coords="209,157,311,184"/><area shape="rect" id="node6" href="group___r_t_c___group7.html#gaa3bb10170a2c70ac9ce3e41c611bdd43" title="Configures the Coarse calibration parameters. " alt="" coords="180,208,340,235"/><area shape="rect" id="node7" href="group___r_t_c___group7.html#ga008ae7173b2befe876f5e76686bc9089" title="Enables or disables the Coarse calibration process. " alt="" coords="185,259,335,285"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga8eb747bf9698b2482ba6ef4d811de8e0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_Init </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_r_t_c___init_type_def.html">RTC_InitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>RTC_InitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initializes the RTC registers according to the specified parameters in RTC_InitStruct. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">RTC_InitStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___init_type_def.html" title="RTC Init structures definition. ">RTC_InitTypeDef</a> structure that contains the configuration information for the RTC peripheral. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section note"><dt>Note</dt><dd>The RTC Prescaler register is write protected and can be written in initialization mode only. </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 registers are initialized</li>
|
||||
<li>ERROR: RTC registers 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___group1_ga8eb747bf9698b2482ba6ef4d811de8e0_cgraph.png" border="0" usemap="#group___r_t_c___group1_ga8eb747bf9698b2482ba6ef4d811de8e0_cgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_ga8eb747bf9698b2482ba6ef4d811de8e0_cgraph" id="group___r_t_c___group1_ga8eb747bf9698b2482ba6ef4d811de8e0_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="124,5,259,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="128,56,255,83"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa60079ec257fb3a277d058ca8305533d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_RefClockCmd </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 reference clock detection. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the RTC reference clock. 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 reference clock detection is enabled</li>
|
||||
<li>ERROR: RTC reference clock detection is 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___group1_gaa60079ec257fb3a277d058ca8305533d_cgraph.png" border="0" usemap="#group___r_t_c___group1_gaa60079ec257fb3a277d058ca8305533d_cgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_gaa60079ec257fb3a277d058ca8305533d_cgraph" id="group___r_t_c___group1_gaa60079ec257fb3a277d058ca8305533d_cgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="187,5,321,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="191,56,317,83"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab466f3348de3236976e9aec7d6025dff"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_StructInit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="struct_r_t_c___init_type_def.html">RTC_InitTypeDef</a> * </td>
|
||||
<td class="paramname"><em>RTC_InitStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Fills each RTC_InitStruct member with its default value. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">RTC_InitStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___init_type_def.html" title="RTC Init structures definition. ">RTC_InitTypeDef</a> structure which will be initialized. </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="ga2938febeef6baf0d91cc066ca5caf095"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ErrorStatus RTC_WaitForSynchro </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>The RTC Resynchronization mode is write protected, use the RTC_WriteProtectionCmd(DISABLE) before calling this function. </dd>
|
||||
<dd>
|
||||
To read the calendar through the shadow registers after Calendar initialization, calendar update or after wakeup from low power modes the software must first clear the RSF flag. The software must then wait until it is set again before reading the calendar, which means that the calendar registers have been correctly copied into the RTC_TR and RTC_DR shadow registers. </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">An</td><td>ErrorStatus enumeration value:<ul>
|
||||
<li>SUCCESS: RTC registers are synchronised</li>
|
||||
<li>ERROR: RTC registers are not synchronised </li>
|
||||
</ul>
|
||||
</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___r_t_c___group1_ga2938febeef6baf0d91cc066ca5caf095_icgraph.png" border="0" usemap="#group___r_t_c___group1_ga2938febeef6baf0d91cc066ca5caf095_icgraph" alt=""/></div>
|
||||
<map name="group___r_t_c___group1_ga2938febeef6baf0d91cc066ca5caf095_icgraph" id="group___r_t_c___group1_ga2938febeef6baf0d91cc066ca5caf095_icgraph">
|
||||
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga9777c6cc4a99c339ebc527a791b2ebe7" title="Deinitializes the RTC registers to their default reset values. " alt="" coords="240,5,327,32"/><area shape="rect" id="node3" href="group___r_t_c___group2.html#ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6" title="Set the RTC current time. " alt="" coords="232,56,335,83"/><area shape="rect" id="node4" href="group___r_t_c___group2.html#ga69d08538147f3d89c818dcfabf50e362" title="Set the RTC current date. " alt="" coords="233,107,334,133"/><area shape="rect" id="node5" href="group___r_t_c___group12.html#gaad434ed2a268f05662f0613e8e9717f3" title="Configures the Synchronization Shift Control Settings. " alt="" coords="201,157,365,184"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga9d4bdfd3ae6957630d15d2497573b7c7"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void RTC_WriteProtectionCmd </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 registers write protection. </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>All the RTC registers are write protected except for RTC_ISR[13:8], RTC_TAFCR and RTC_BKPxR. </dd>
|
||||
<dd>
|
||||
Writing a wrong key reactivates the write protection. </dd>
|
||||
<dd>
|
||||
The protection mechanism is not affected by system reset. </dd></dl>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">NewState</td><td>new state of the write protection. 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