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

395
group___r_t_c___group9.html Normal file
View File

@@ -0,0 +1,395 @@
<!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: Tampers 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">Tampers 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>Tampers configuration functions.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Tampers configuration functions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___r_t_c___group9.png" border="0" alt="" usemap="#group______r__t__c______group9"/>
<map name="group______r__t__c______group9" id="group______r__t__c______group9">
<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:gad547d636cfc4fd8d4d673325571e0ffb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#gad547d636cfc4fd8d4d673325571e0ffb">RTC_TamperTriggerConfig</a> (uint32_t RTC_Tamper, uint32_t RTC_TamperTrigger)</td></tr>
<tr class="memdesc:gad547d636cfc4fd8d4d673325571e0ffb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the select Tamper pin edge. <a href="#gad547d636cfc4fd8d4d673325571e0ffb">More...</a><br /></td></tr>
<tr class="separator:gad547d636cfc4fd8d4d673325571e0ffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf85cc696d624da0de9fbe99779402833"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#gaf85cc696d624da0de9fbe99779402833">RTC_TamperCmd</a> (uint32_t RTC_Tamper, FunctionalState NewState)</td></tr>
<tr class="memdesc:gaf85cc696d624da0de9fbe99779402833"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or Disables the Tamper detection. <a href="#gaf85cc696d624da0de9fbe99779402833">More...</a><br /></td></tr>
<tr class="separator:gaf85cc696d624da0de9fbe99779402833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e87b9ae757ad12d7585e4fbcbf2c4b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#ga1e87b9ae757ad12d7585e4fbcbf2c4b8">RTC_TamperFilterConfig</a> (uint32_t RTC_TamperFilter)</td></tr>
<tr class="memdesc:ga1e87b9ae757ad12d7585e4fbcbf2c4b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the Tampers Filter. <a href="#ga1e87b9ae757ad12d7585e4fbcbf2c4b8">More...</a><br /></td></tr>
<tr class="separator:ga1e87b9ae757ad12d7585e4fbcbf2c4b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc7f33a31df80b5deac313fc8af8d7f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#gadc7f33a31df80b5deac313fc8af8d7f7">RTC_TamperSamplingFreqConfig</a> (uint32_t RTC_TamperSamplingFreq)</td></tr>
<tr class="memdesc:gadc7f33a31df80b5deac313fc8af8d7f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the Tampers Sampling Frequency. <a href="#gadc7f33a31df80b5deac313fc8af8d7f7">More...</a><br /></td></tr>
<tr class="separator:gadc7f33a31df80b5deac313fc8af8d7f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc176a013076a651862dc6a957286025"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#gafc176a013076a651862dc6a957286025">RTC_TamperPinsPrechargeDuration</a> (uint32_t RTC_TamperPrechargeDuration)</td></tr>
<tr class="memdesc:gafc176a013076a651862dc6a957286025"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the Tampers Pins input Precharge Duration. <a href="#gafc176a013076a651862dc6a957286025">More...</a><br /></td></tr>
<tr class="separator:gafc176a013076a651862dc6a957286025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29c82fceefd21a78dc55ccc5bcc1ed59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#ga29c82fceefd21a78dc55ccc5bcc1ed59">RTC_TimeStampOnTamperDetectionCmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:ga29c82fceefd21a78dc55ccc5bcc1ed59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or Disables the TimeStamp on Tamper Detection Event. <a href="#ga29c82fceefd21a78dc55ccc5bcc1ed59">More...</a><br /></td></tr>
<tr class="separator:ga29c82fceefd21a78dc55ccc5bcc1ed59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga981b9c654e521282a2020a81118c8c3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group9.html#ga981b9c654e521282a2020a81118c8c3c">RTC_TamperPullUpCmd</a> (FunctionalState NewState)</td></tr>
<tr class="memdesc:ga981b9c654e521282a2020a81118c8c3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or Disables the Precharge of Tamper pin. <a href="#ga981b9c654e521282a2020a81118c8c3c">More...</a><br /></td></tr>
<tr class="separator:ga981b9c654e521282a2020a81118c8c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Tampers configuration functions. </p>
<pre class="fragment"> ===============================================================================
##### Tampers configuration functions #####
=============================================================================== </pre> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf85cc696d624da0de9fbe99779402833"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperCmd </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Tamper</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 Tamper detection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Tamper</td><td>Selected tamper pin. This parameter can be RTC_Tamper_1. </td></tr>
<tr><td class="paramname">NewState</td><td>new state of the tamper pin. 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="ga1e87b9ae757ad12d7585e4fbcbf2c4b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperFilterConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_TamperFilter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the Tampers Filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_TamperFilter</td><td>Specifies the tampers filter. This parameter can be one of the following values: <ul>
<li>RTC_TamperFilter_Disable: Tamper filter is disabled. </li>
<li>RTC_TamperFilter_2Sample: Tamper is activated after 2 consecutive samples at the active level </li>
<li>RTC_TamperFilter_4Sample: Tamper is activated after 4 consecutive samples at the active level </li>
<li>RTC_TamperFilter_8Sample: Tamper is activated after 8 consecutive samples at the active level </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="gafc176a013076a651862dc6a957286025"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperPinsPrechargeDuration </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_TamperPrechargeDuration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the Tampers Pins input Precharge Duration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_TamperPrechargeDuration</td><td>Specifies the Tampers Pins input Precharge Duration. This parameter can be one of the following values: <ul>
<li>RTC_TamperPrechargeDuration_1RTCCLK: Tamper pins are precharged before sampling during 1 RTCCLK cycle </li>
<li>RTC_TamperPrechargeDuration_2RTCCLK: Tamper pins are precharged before sampling during 2 RTCCLK cycle </li>
<li>RTC_TamperPrechargeDuration_4RTCCLK: Tamper pins are precharged before sampling during 4 RTCCLK cycle </li>
<li>RTC_TamperPrechargeDuration_8RTCCLK: Tamper pins are precharged before sampling during 8 RTCCLK cycle </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="ga981b9c654e521282a2020a81118c8c3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperPullUpCmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or Disables the Precharge of Tamper pin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of tamper pull up. 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="gadc7f33a31df80b5deac313fc8af8d7f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperSamplingFreqConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_TamperSamplingFreq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the Tampers Sampling Frequency. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_TamperSamplingFreq</td><td>Specifies the tampers Sampling Frequency. This parameter can be one of the following values: <ul>
<li>RTC_TamperSamplingFreq_RTCCLK_Div32768: Each of the tamper inputs are sampled with a frequency = RTCCLK / 32768 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div16384: Each of the tamper inputs are sampled with a frequency = RTCCLK / 16384 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div8192: Each of the tamper inputs are sampled with a frequency = RTCCLK / 8192 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div4096: Each of the tamper inputs are sampled with a frequency = RTCCLK / 4096 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div2048: Each of the tamper inputs are sampled with a frequency = RTCCLK / 2048 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div1024: Each of the tamper inputs are sampled with a frequency = RTCCLK / 1024 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div512: Each of the tamper inputs are sampled with a frequency = RTCCLK / 512 </li>
<li>RTC_TamperSamplingFreq_RTCCLK_Div256: Each of the tamper inputs are sampled with a frequency = RTCCLK / 256 </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="gad547d636cfc4fd8d4d673325571e0ffb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TamperTriggerConfig </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_Tamper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>RTC_TamperTrigger</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the select Tamper pin edge. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RTC_Tamper</td><td>Selected tamper pin. This parameter can be RTC_Tamper_1. </td></tr>
<tr><td class="paramname">RTC_TamperTrigger</td><td>Specifies the trigger on the tamper pin that stimulates tamper event. This parameter can be one of the following values: <ul>
<li>RTC_TamperTrigger_RisingEdge: Rising Edge of the tamper pin causes tamper event. </li>
<li>RTC_TamperTrigger_FallingEdge: Falling Edge of the tamper pin causes tamper event. </li>
<li>RTC_TamperTrigger_LowLevel: Low Level of the tamper pin causes tamper event. </li>
<li>RTC_TamperTrigger_HighLevel: High Level of the tamper pin causes tamper event. </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="ga29c82fceefd21a78dc55ccc5bcc1ed59"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTC_TimeStampOnTamperDetectionCmd </td>
<td>(</td>
<td class="paramtype">FunctionalState&#160;</td>
<td class="paramname"><em>NewState</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or Disables the TimeStamp on Tamper Detection Event. </p>
<dl class="section note"><dt>Note</dt><dd>The timestamp is valid even the TSE bit in tamper control register is reset. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">NewState</td><td>new state of the timestamp on tamper event. 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 &#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>