Added doxygen output of current emulator branch.

This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions

434
group___r_t_c___group2.html Normal file
View File

@@ -0,0 +1,434 @@
<!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: Time and Date 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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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">Time and Date configuration functions<div class="ingroups"><a class="el" href="group___s_t_m32_f4xx___std_periph___driver.html">STM32F4xx_StdPeriph_Driver</a> &raquo; <a class="el" href="group___r_t_c.html">RTC</a> &raquo; <a class="el" href="group___r_t_c___private___functions.html">RTC_Private_Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Time and Date configuration functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Time and Date configuration functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___r_t_c___group2.png" border="0" alt="" usemap="#group______r__t__c______group2"/>
<map name="group______r__t__c______group2" id="group______r__t__c______group2">
<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:ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6"><td class="memItemLeft" align="right" valign="top">ErrorStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6">RTC_SetTime</a> (uint32_t RTC_Format, <a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *RTC_TimeStruct)</td></tr>
<tr class="memdesc:ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the RTC current time. <a href="#ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6">More...</a><br /></td></tr>
<tr class="separator:ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0404db6e0c70e5a6bbbe4fa58a577365"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga0404db6e0c70e5a6bbbe4fa58a577365">RTC_TimeStructInit</a> (<a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *RTC_TimeStruct)</td></tr>
<tr class="memdesc:ga0404db6e0c70e5a6bbbe4fa58a577365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each RTC_TimeStruct member with its default value (Time = 00h:00min:00sec). <a href="#ga0404db6e0c70e5a6bbbe4fa58a577365">More...</a><br /></td></tr>
<tr class="separator:ga0404db6e0c70e5a6bbbe4fa58a577365"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fcc101339c77aebd25ec3621fd1b61a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga1fcc101339c77aebd25ec3621fd1b61a">RTC_GetTime</a> (uint32_t RTC_Format, <a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *RTC_TimeStruct)</td></tr>
<tr class="memdesc:ga1fcc101339c77aebd25ec3621fd1b61a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTC current Time. <a href="#ga1fcc101339c77aebd25ec3621fd1b61a">More...</a><br /></td></tr>
<tr class="separator:ga1fcc101339c77aebd25ec3621fd1b61a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae59c33fb19e36b6abab0bad58072c01a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#gae59c33fb19e36b6abab0bad58072c01a">RTC_GetSubSecond</a> (void)</td></tr>
<tr class="memdesc:gae59c33fb19e36b6abab0bad58072c01a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the RTC current Calendar Sub seconds value. <a href="#gae59c33fb19e36b6abab0bad58072c01a">More...</a><br /></td></tr>
<tr class="separator:gae59c33fb19e36b6abab0bad58072c01a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga69d08538147f3d89c818dcfabf50e362"><td class="memItemLeft" align="right" valign="top">ErrorStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga69d08538147f3d89c818dcfabf50e362">RTC_SetDate</a> (uint32_t RTC_Format, <a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *RTC_DateStruct)</td></tr>
<tr class="memdesc:ga69d08538147f3d89c818dcfabf50e362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the RTC current date. <a href="#ga69d08538147f3d89c818dcfabf50e362">More...</a><br /></td></tr>
<tr class="separator:ga69d08538147f3d89c818dcfabf50e362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e4e99be910d7759f8910056a2985056"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga6e4e99be910d7759f8910056a2985056">RTC_DateStructInit</a> (<a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *RTC_DateStruct)</td></tr>
<tr class="memdesc:ga6e4e99be910d7759f8910056a2985056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each RTC_DateStruct member with its default value (Monday, January 01 xx00). <a href="#ga6e4e99be910d7759f8910056a2985056">More...</a><br /></td></tr>
<tr class="separator:ga6e4e99be910d7759f8910056a2985056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga582645d554cdd4a316213e90f0b4c8ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group2.html#ga582645d554cdd4a316213e90f0b4c8ae">RTC_GetDate</a> (uint32_t RTC_Format, <a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *RTC_DateStruct)</td></tr>
<tr class="memdesc:ga582645d554cdd4a316213e90f0b4c8ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTC current date. <a href="#ga582645d554cdd4a316213e90f0b4c8ae">More...</a><br /></td></tr>
<tr class="separator:ga582645d554cdd4a316213e90f0b4c8ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Time and Date configuration functions. </p>
<pre class="fragment"> ===============================================================================
##### Time and Date configuration functions #####
===============================================================================
[..] This section provide functions allowing to program and read the RTC Calendar
(Time and Date).</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6e4e99be910d7759f8910056a2985056"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_DateStructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_DateStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each RTC_DateStruct member with its default value (Monday, January 01 xx00). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_DateStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___date_type_def.html" title="RTC Date structure definition. ">RTC_DateTypeDef</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="ga582645d554cdd4a316213e90f0b4c8ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_GetDate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_DateStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the RTC current date. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Format</td><td>specifies the format of the returned parameters. This parameter can be one of the following values: <ul>
<li>RTC_Format_BIN: Binary data format </li>
<li>RTC_Format_BCD: BCD data format </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_DateStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___date_type_def.html" title="RTC Date structure definition. ">RTC_DateTypeDef</a> structure that will contain the returned current date configuration. </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="gae59c33fb19e36b6abab0bad58072c01a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t RTC_GetSubSecond </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the RTC current Calendar Sub seconds value. </p>
<dl class="section note"><dt>Note</dt><dd>This function freeze the Time and Date registers after reading the SSR register. </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">RTC</td><td>current Calendar Sub seconds value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1fcc101339c77aebd25ec3621fd1b61a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_GetTime </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_TimeStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the RTC current Time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Format</td><td>specifies the format of the returned parameters. This parameter can be one of the following values: <ul>
<li>RTC_Format_BIN: Binary data format </li>
<li>RTC_Format_BCD: BCD data format </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_TimeStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___time_type_def.html" title="RTC Time structure definition. ">RTC_TimeTypeDef</a> structure that will contain the returned current time configuration. </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="ga69d08538147f3d89c818dcfabf50e362"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ErrorStatus RTC_SetDate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___date_type_def.html">RTC_DateTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_DateStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the RTC current date. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Format</td><td>specifies the format of the entered parameters. This parameter can be one of the following values: <ul>
<li>RTC_Format_BIN: Binary data format </li>
<li>RTC_Format_BCD: BCD data format </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_DateStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___date_type_def.html" title="RTC Date structure definition. ">RTC_DateTypeDef</a> structure that contains the date configuration information for the RTC. </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 Date register is configured</li>
<li>ERROR: RTC Date register is not configured </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___group2_ga69d08538147f3d89c818dcfabf50e362_cgraph.png" border="0" usemap="#group___r_t_c___group2_ga69d08538147f3d89c818dcfabf50e362_cgraph" alt=""/></div>
<map name="group___r_t_c___group2_ga69d08538147f3d89c818dcfabf50e362_cgraph" id="group___r_t_c___group2_ga69d08538147f3d89c818dcfabf50e362_cgraph">
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="161,5,296,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="165,56,292,83"/><area shape="rect" id="node4" 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="155,107,303,133"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ErrorStatus RTC_SetTime </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_TimeStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the RTC current time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Format</td><td>specifies the format of the entered parameters. This parameter can be one of the following values: <ul>
<li>RTC_Format_BIN: Binary data format </li>
<li>RTC_Format_BCD: BCD data format </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_TimeStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___time_type_def.html" title="RTC Time structure definition. ">RTC_TimeTypeDef</a> structure that contains the time configuration information for the RTC. </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 Time register is configured</li>
<li>ERROR: RTC Time register is not configured </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___group2_ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6_cgraph.png" border="0" usemap="#group___r_t_c___group2_ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6_cgraph" alt=""/></div>
<map name="group___r_t_c___group2_ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6_cgraph" id="group___r_t_c___group2_ga9f9df80cfa82f7a4dd9f4d0cf2ffb3a6_cgraph">
<area shape="rect" id="node2" href="group___r_t_c___group1.html#ga679f8883cbfb267a53ffb1ab4cc5c8c5" title="Enters the RTC Initialization mode. " alt="" coords="163,5,297,32"/><area shape="rect" id="node3" href="group___r_t_c___group1.html#ga87f86f3b794205f09a1eac51738d900f" title="Exits the RTC Initialization mode. " alt="" coords="167,56,293,83"/><area shape="rect" id="node4" 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="156,107,304,133"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga0404db6e0c70e5a6bbbe4fa58a577365"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TimeStructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_r_t_c___time_type_def.html">RTC_TimeTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_TimeStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each RTC_TimeStruct member with its default value (Time = 00h:00min:00sec). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_TimeStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___time_type_def.html" title="RTC Time structure definition. ">RTC_TimeTypeDef</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>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:20 for discoverpixy by &#160;<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>