aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added doxygen output of current emulator branch.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

431
group___r_t_c___group3.html Normal file
View File

@@ -0,0 +1,431 @@
<!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: Alarms 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">Alarms 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>Alarms (Alarm A and Alarm B) configuration functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Alarms configuration functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___r_t_c___group3.png" border="0" alt="" usemap="#group______r__t__c______group3"/>
<map name="group______r__t__c______group3" id="group______r__t__c______group3">
<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:ga44e3334f8e882df9b8a59b47f0857395"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#ga44e3334f8e882df9b8a59b47f0857395">RTC_SetAlarm</a> (uint32_t RTC_Format, uint32_t RTC_Alarm, <a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *RTC_AlarmStruct)</td></tr>
<tr class="memdesc:ga44e3334f8e882df9b8a59b47f0857395"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the specified RTC Alarm. <a href="#ga44e3334f8e882df9b8a59b47f0857395">More...</a><br /></td></tr>
<tr class="separator:ga44e3334f8e882df9b8a59b47f0857395"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36ab6199e21fb415ab1ec4d7aa48ba45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#ga36ab6199e21fb415ab1ec4d7aa48ba45">RTC_AlarmStructInit</a> (<a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *RTC_AlarmStruct)</td></tr>
<tr class="memdesc:ga36ab6199e21fb415ab1ec4d7aa48ba45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills each RTC_AlarmStruct member with its default value (Time = 00h:00mn:00sec / Date = 1st day of the month/Mask = all fields are masked). <a href="#ga36ab6199e21fb415ab1ec4d7aa48ba45">More...</a><br /></td></tr>
<tr class="separator:ga36ab6199e21fb415ab1ec4d7aa48ba45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e2888d2fd2e3ecb4ec50f5c955b362b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#ga6e2888d2fd2e3ecb4ec50f5c955b362b">RTC_GetAlarm</a> (uint32_t RTC_Format, uint32_t RTC_Alarm, <a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *RTC_AlarmStruct)</td></tr>
<tr class="memdesc:ga6e2888d2fd2e3ecb4ec50f5c955b362b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the RTC Alarm value and masks. <a href="#ga6e2888d2fd2e3ecb4ec50f5c955b362b">More...</a><br /></td></tr>
<tr class="separator:ga6e2888d2fd2e3ecb4ec50f5c955b362b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2c08f1aeeb664d3d245cb5aca1b8ca8"><td class="memItemLeft" align="right" valign="top">ErrorStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#gac2c08f1aeeb664d3d245cb5aca1b8ca8">RTC_AlarmCmd</a> (uint32_t RTC_Alarm, FunctionalState NewState)</td></tr>
<tr class="memdesc:gac2c08f1aeeb664d3d245cb5aca1b8ca8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the specified RTC Alarm. <a href="#gac2c08f1aeeb664d3d245cb5aca1b8ca8">More...</a><br /></td></tr>
<tr class="separator:gac2c08f1aeeb664d3d245cb5aca1b8ca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b3e4e9e39262e9b0d1aadd895394e46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#ga7b3e4e9e39262e9b0d1aadd895394e46">RTC_AlarmSubSecondConfig</a> (uint32_t RTC_Alarm, uint32_t RTC_AlarmSubSecondValue, uint32_t RTC_AlarmSubSecondMask)</td></tr>
<tr class="memdesc:ga7b3e4e9e39262e9b0d1aadd895394e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the RTC AlarmA/B Sub seconds value and mask.*. <a href="#ga7b3e4e9e39262e9b0d1aadd895394e46">More...</a><br /></td></tr>
<tr class="separator:ga7b3e4e9e39262e9b0d1aadd895394e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7b5e7146be2710d619c8ed3cca464ad"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group3.html#gae7b5e7146be2710d619c8ed3cca464ad">RTC_GetAlarmSubSecond</a> (uint32_t RTC_Alarm)</td></tr>
<tr class="memdesc:gae7b5e7146be2710d619c8ed3cca464ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the RTC Alarm Sub seconds value. <a href="#gae7b5e7146be2710d619c8ed3cca464ad">More...</a><br /></td></tr>
<tr class="separator:gae7b5e7146be2710d619c8ed3cca464ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Alarms (Alarm A and Alarm B) configuration functions. </p>
<pre class="fragment"> ===============================================================================
##### Alarms A and B configuration functions #####
===============================================================================
[..] This section provide functions allowing to program and read the RTC Alarms.</pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gac2c08f1aeeb664d3d245cb5aca1b8ca8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ErrorStatus RTC_AlarmCmd </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the specified RTC Alarm. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Alarm</td><td>specifies the alarm to be configured. This parameter can be any combination of the following values: <ul>
<li>RTC_Alarm_A: to select Alarm A </li>
<li>RTC_Alarm_B: to select Alarm B </li>
</ul>
</td></tr>
<tr><td class="paramname">NewState</td><td>new state of the specified alarm. 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 Alarm is enabled/disabled</li>
<li>ERROR: RTC Alarm is not enabled/disabled </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga36ab6199e21fb415ab1ec4d7aa48ba45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_AlarmStructInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_AlarmStruct</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills each RTC_AlarmStruct member with its default value (Time = 00h:00mn:00sec / Date = 1st day of the month/Mask = all fields are masked). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_AlarmStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</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="ga7b3e4e9e39262e9b0d1aadd895394e46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_AlarmSubSecondConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_AlarmSubSecondValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_AlarmSubSecondMask</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the RTC AlarmA/B Sub seconds value and mask.*. </p>
<dl class="section note"><dt>Note</dt><dd>This function is performed only when the Alarm is disabled. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Alarm</td><td>specifies the alarm to be configured. This parameter can be one of the following values: <ul>
<li>RTC_Alarm_A: to select Alarm A </li>
<li>RTC_Alarm_B: to select Alarm B </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_AlarmSubSecondValue</td><td>specifies the Sub seconds value. This parameter can be a value from 0 to 0x00007FFF. </td></tr>
<tr><td class="paramname">RTC_AlarmSubSecondMask</td><td>specifies the Sub seconds Mask. This parameter can be any combination of the following values: <ul>
<li>RTC_AlarmSubSecondMask_All : All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm. </li>
<li>RTC_AlarmSubSecondMask_SS14_1 : SS[14:1] are don't care in Alarm comparison. Only SS[0] is compared </li>
<li>RTC_AlarmSubSecondMask_SS14_2 : SS[14:2] are don't care in Alarm comparison. Only SS[1:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_3 : SS[14:3] are don't care in Alarm comparison. Only SS[2:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_4 : SS[14:4] are don't care in Alarm comparison. Only SS[3:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_5 : SS[14:5] are don't care in Alarm comparison. Only SS[4:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_6 : SS[14:6] are don't care in Alarm comparison. Only SS[5:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_7 : SS[14:7] are don't care in Alarm comparison. Only SS[6:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_8 : SS[14:8] are don't care in Alarm comparison. Only SS[7:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_9 : SS[14:9] are don't care in Alarm comparison. Only SS[8:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_10: SS[14:10] are don't care in Alarm comparison. Only SS[9:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_11: SS[14:11] are don't care in Alarm comparison. Only SS[10:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_12: SS[14:12] are don't care in Alarm comparison. Only SS[11:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14_13: SS[14:13] are don't care in Alarm comparison. Only SS[12:0] are compared </li>
<li>RTC_AlarmSubSecondMask_SS14 : SS[14] is don't care in Alarm comparison. Only SS[13:0] are compared </li>
<li>RTC_AlarmSubSecondMask_None : SS[14:0] are compared and must match to activate alarm </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="ga6e2888d2fd2e3ecb4ec50f5c955b362b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_GetAlarm </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">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_AlarmStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the RTC Alarm value and masks. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Format</td><td>specifies the format of the output 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_Alarm</td><td>specifies the alarm to be read. This parameter can be one of the following values: <ul>
<li>RTC_Alarm_A: to select Alarm A </li>
<li>RTC_Alarm_B: to select Alarm B </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_AlarmStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___alarm_type_def.html" title="RTC Alarm structure definition. ">RTC_AlarmTypeDef</a> structure that will contains the output alarm configuration values. </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="gae7b5e7146be2710d619c8ed3cca464ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t RTC_GetAlarmSubSecond </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Alarm</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the RTC Alarm Sub seconds value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Alarm</td><td>specifies the alarm to be read. This parameter can be one of the following values: <ul>
<li>RTC_Alarm_A: to select Alarm A </li>
<li>RTC_Alarm_B: to select Alarm B </li>
</ul>
</td></tr>
<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>Alarm Sub seconds value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga44e3334f8e882df9b8a59b47f0857395"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_SetAlarm </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">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_r_t_c___alarm_type_def.html">RTC_AlarmTypeDef</a> *&#160;</td>
<td class="paramname"><em>RTC_AlarmStruct</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the specified RTC Alarm. </p>
<dl class="section note"><dt>Note</dt><dd>The Alarm register can only be written when the corresponding Alarm is disabled (Use the RTC_AlarmCmd(DISABLE)). </dd></dl>
<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_Alarm</td><td>specifies the alarm to be configured. This parameter can be one of the following values: <ul>
<li>RTC_Alarm_A: to select Alarm A </li>
<li>RTC_Alarm_B: to select Alarm B </li>
</ul>
</td></tr>
<tr><td class="paramname">RTC_AlarmStruct</td><td>pointer to a <a class="el" href="struct_r_t_c___alarm_type_def.html" title="RTC Alarm structure definition. ">RTC_AlarmTypeDef</a> structure that contains the alarm configuration parameters. </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>