370 lines
17 KiB
HTML
370 lines
17 KiB
HTML
<!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: Interrupts and flags management 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">Interrupts and flags management 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>Interrupts and flags management functions.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Interrupts and flags management functions:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group___r_t_c___group13.png" border="0" alt="" usemap="#group______r__t__c______group13"/>
|
|
<map name="group______r__t__c______group13" id="group______r__t__c______group13">
|
|
<area shape="rect" id="node1" 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:gaa8469b33b3a99025baf52f007683b925"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group13.html#gaa8469b33b3a99025baf52f007683b925">RTC_ITConfig</a> (uint32_t RTC_IT, FunctionalState NewState)</td></tr>
|
|
<tr class="memdesc:gaa8469b33b3a99025baf52f007683b925"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the specified RTC interrupts. <a href="#gaa8469b33b3a99025baf52f007683b925">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa8469b33b3a99025baf52f007683b925"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf2a7f11aa7160e95650fd10845e7780b"><td class="memItemLeft" align="right" valign="top">FlagStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group13.html#gaf2a7f11aa7160e95650fd10845e7780b">RTC_GetFlagStatus</a> (uint32_t RTC_FLAG)</td></tr>
|
|
<tr class="memdesc:gaf2a7f11aa7160e95650fd10845e7780b"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified RTC flag is set or not. <a href="#gaf2a7f11aa7160e95650fd10845e7780b">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf2a7f11aa7160e95650fd10845e7780b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9be3325e05418d05c8c5a5ad369c7d50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group13.html#ga9be3325e05418d05c8c5a5ad369c7d50">RTC_ClearFlag</a> (uint32_t RTC_FLAG)</td></tr>
|
|
<tr class="memdesc:ga9be3325e05418d05c8c5a5ad369c7d50"><td class="mdescLeft"> </td><td class="mdescRight">Clears the RTC's pending flags. <a href="#ga9be3325e05418d05c8c5a5ad369c7d50">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9be3325e05418d05c8c5a5ad369c7d50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaab81adc6d2a5a5c1e37a49707c6bf640"><td class="memItemLeft" align="right" valign="top">ITStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group13.html#gaab81adc6d2a5a5c1e37a49707c6bf640">RTC_GetITStatus</a> (uint32_t RTC_IT)</td></tr>
|
|
<tr class="memdesc:gaab81adc6d2a5a5c1e37a49707c6bf640"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the specified RTC interrupt has occurred or not. <a href="#gaab81adc6d2a5a5c1e37a49707c6bf640">More...</a><br /></td></tr>
|
|
<tr class="separator:gaab81adc6d2a5a5c1e37a49707c6bf640"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacac6accc75ae54f1b799fa8e7e83ccdb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_t_c___group13.html#gacac6accc75ae54f1b799fa8e7e83ccdb">RTC_ClearITPendingBit</a> (uint32_t RTC_IT)</td></tr>
|
|
<tr class="memdesc:gacac6accc75ae54f1b799fa8e7e83ccdb"><td class="mdescLeft"> </td><td class="mdescRight">Clears the RTC's interrupt pending bits. <a href="#gacac6accc75ae54f1b799fa8e7e83ccdb">More...</a><br /></td></tr>
|
|
<tr class="separator:gacac6accc75ae54f1b799fa8e7e83ccdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Interrupts and flags management functions. </p>
|
|
<pre class="fragment"> ===============================================================================
|
|
##### Interrupts and flags management functions #####
|
|
===============================================================================
|
|
[..] All RTC interrupts are connected to the EXTI controller.
|
|
|
|
(+) To enable the RTC Alarm interrupt, the following sequence is required:
|
|
(++) Configure and enable the EXTI Line 17 in interrupt mode and select
|
|
the rising edge sensitivity using the EXTI_Init() function.
|
|
(++) Configure and enable the RTC_Alarm IRQ channel in the NVIC using the
|
|
NVIC_Init() function.
|
|
(++) Configure the RTC to generate RTC alarms (Alarm A and/or Alarm B) using
|
|
the RTC_SetAlarm() and RTC_AlarmCmd() functions.
|
|
|
|
(+) To enable the RTC Wakeup interrupt, the following sequence is required:
|
|
(++) Configure and enable the EXTI Line 22 in interrupt mode and select the
|
|
rising edge sensitivity using the EXTI_Init() function.
|
|
(++) Configure and enable the RTC_WKUP IRQ channel in the NVIC using the
|
|
NVIC_Init() function.
|
|
(++) Configure the RTC to generate the RTC wakeup timer event using the
|
|
RTC_WakeUpClockConfig(), RTC_SetWakeUpCounter() and RTC_WakeUpCmd()
|
|
functions.
|
|
|
|
(+) To enable the RTC Tamper interrupt, the following sequence is required:
|
|
(++) Configure and enable the EXTI Line 21 in interrupt mode and select
|
|
the rising edge sensitivity using the EXTI_Init() function.
|
|
(++) Configure and enable the TAMP_STAMP IRQ channel in the NVIC using the
|
|
NVIC_Init() function.
|
|
(++) Configure the RTC to detect the RTC tamper event using the
|
|
RTC_TamperTriggerConfig() and RTC_TamperCmd() functions.
|
|
|
|
(+) To enable the RTC TimeStamp interrupt, the following sequence is required:
|
|
(++) Configure and enable the EXTI Line 21 in interrupt mode and select the
|
|
rising edge sensitivity using the EXTI_Init() function.
|
|
(++) Configure and enable the TAMP_STAMP IRQ channel in the NVIC using the
|
|
NVIC_Init() function.
|
|
(++) Configure the RTC to detect the RTC time stamp event using the
|
|
RTC_TimeStampCmd() functions.</pre> <h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga9be3325e05418d05c8c5a5ad369c7d50"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_ClearFlag </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>RTC_FLAG</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the RTC's pending flags. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RTC_FLAG</td><td>specifies the RTC flag to clear. This parameter can be any combination of the following values: <ul>
|
|
<li>RTC_FLAG_TAMP1F: Tamper 1 event flag </li>
|
|
<li>RTC_FLAG_TSOVF: Time Stamp Overflow flag </li>
|
|
<li>RTC_FLAG_TSF: Time Stamp event flag </li>
|
|
<li>RTC_FLAG_WUTF: WakeUp Timer flag </li>
|
|
<li>RTC_FLAG_ALRBF: Alarm B flag </li>
|
|
<li>RTC_FLAG_ALRAF: Alarm A flag </li>
|
|
<li>RTC_FLAG_RSF: Registers Synchronized flag </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="gacac6accc75ae54f1b799fa8e7e83ccdb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_ClearITPendingBit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>RTC_IT</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the RTC's interrupt pending bits. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RTC_IT</td><td>specifies the RTC interrupt pending bit to clear. This parameter can be any combination of the following values: <ul>
|
|
<li>RTC_IT_TS: Time Stamp interrupt </li>
|
|
<li>RTC_IT_WUT: WakeUp Timer interrupt </li>
|
|
<li>RTC_IT_ALRB: Alarm B interrupt </li>
|
|
<li>RTC_IT_ALRA: Alarm A interrupt </li>
|
|
<li>RTC_IT_TAMP1: Tamper 1 event interrupt </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="gaf2a7f11aa7160e95650fd10845e7780b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FlagStatus RTC_GetFlagStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>RTC_FLAG</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether the specified RTC flag is set or not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RTC_FLAG</td><td>specifies the flag to check. This parameter can be one of the following values: <ul>
|
|
<li>RTC_FLAG_RECALPF: RECALPF event flag. </li>
|
|
<li>RTC_FLAG_TAMP1F: Tamper 1 event flag </li>
|
|
<li>RTC_FLAG_TSOVF: Time Stamp OverFlow flag </li>
|
|
<li>RTC_FLAG_TSF: Time Stamp event flag </li>
|
|
<li>RTC_FLAG_WUTF: WakeUp Timer flag </li>
|
|
<li>RTC_FLAG_ALRBF: Alarm B flag </li>
|
|
<li>RTC_FLAG_ALRAF: Alarm A flag </li>
|
|
<li>RTC_FLAG_INITF: Initialization mode flag </li>
|
|
<li>RTC_FLAG_RSF: Registers Synchronized flag </li>
|
|
<li>RTC_FLAG_INITS: Registers Configured flag </li>
|
|
<li>RTC_FLAG_SHPF: Shift operation pending flag. </li>
|
|
<li>RTC_FLAG_WUTWF: WakeUp Timer Write flag </li>
|
|
<li>RTC_FLAG_ALRBWF: Alarm B Write flag </li>
|
|
<li>RTC_FLAG_ALRAWF: Alarm A write flag </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">The</td><td>new state of RTC_FLAG (SET or RESET). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaab81adc6d2a5a5c1e37a49707c6bf640"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ITStatus RTC_GetITStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>RTC_IT</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether the specified RTC interrupt has occurred or not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RTC_IT</td><td>specifies the RTC interrupt source to check. This parameter can be one of the following values: <ul>
|
|
<li>RTC_IT_TS: Time Stamp interrupt </li>
|
|
<li>RTC_IT_WUT: WakeUp Timer interrupt </li>
|
|
<li>RTC_IT_ALRB: Alarm B interrupt </li>
|
|
<li>RTC_IT_ALRA: Alarm A interrupt </li>
|
|
<li>RTC_IT_TAMP1: Tamper 1 event interrupt </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">The</td><td>new state of RTC_IT (SET or RESET). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa8469b33b3a99025baf52f007683b925"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_ITConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>RTC_IT</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FunctionalState </td>
|
|
<td class="paramname"><em>NewState</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables or disables the specified RTC interrupts. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RTC_IT</td><td>specifies the RTC interrupt sources to be enabled or disabled. This parameter can be any combination of the following values: <ul>
|
|
<li>RTC_IT_TS: Time Stamp interrupt mask </li>
|
|
<li>RTC_IT_WUT: WakeUp Timer interrupt mask </li>
|
|
<li>RTC_IT_ALRB: Alarm B interrupt mask </li>
|
|
<li>RTC_IT_ALRA: Alarm A interrupt mask </li>
|
|
<li>RTC_IT_TAMP: Tamper event interrupt mask </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">NewState</td><td>new state of the specified RTC interrupts. 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>
|