1444 lines
73 KiB
HTML
1444 lines
73 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.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: RTC: Real Time Clock</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.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 id="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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>API Reference</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 -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('a00047.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="#files">Files</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RTC: Real Time Clock</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>The MCUXpresso SDK provides a driver for the Real Time Clock (RTC).</p>
|
|
<h1><a class="anchor" id="RTCFunc"></a>
|
|
Function groups</h1>
|
|
<p>The RTC driver supports operating the module as a time counter.</p>
|
|
<h2><a class="anchor" id="RTCInit"></a>
|
|
Initialization and deinitialization</h2>
|
|
<p>The function <a class="el" href="a00047.html#gaa39b6b86a1f4c82bc8b1cf86366cabc5" title="Un-gate the RTC clock and enable the RTC oscillator. ">RTC_Init()</a> initializes the RTC with specified configurations. The function RTC_GetDefaultConfig() gets the default configurations.</p>
|
|
<p>The function <a class="el" href="a00047.html#ga0f365b0df0c2e61b07a7e178bd0f1581" title="Stop the timer and gate the RTC clock. ">RTC_Deinit()</a> disables the RTC timer and disables the module clock.</p>
|
|
<h2><a class="anchor" id="RTCDatetime"></a>
|
|
Set & Get Datetime</h2>
|
|
<p>The function <a class="el" href="a00047.html#ga5ddf5a972712795ee53468c3cc35b2de" title="Set the RTC date and time according to the given time structure. ">RTC_SetDatetime()</a> sets the timer period in seconds. User passes in the details in date & time format by using the below data structure.</p>
|
|
<p>Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/rtc The function <a class="el" href="a00047.html#gabd709e50b2b6129bd429352282890720" title="Get the RTC time and stores it in the given time structure. ">RTC_GetDatetime()</a> reads the current timer value in seconds, converts it to date & time format and stores it into a datetime structure passed in by the user.</p>
|
|
<h2><a class="anchor" id="RTCAlarm"></a>
|
|
Set & Get Alarm</h2>
|
|
<p>The function <a class="el" href="a00047.html#gab2d6ccb1f963f5c38166bfe0a3e90955" title="Set the RTC alarm time. ">RTC_SetAlarm()</a> sets the alarm time period in seconds. User passes in the details in date & time format by using the datetime data structure.</p>
|
|
<p>The function <a class="el" href="a00047.html#ga197e1135863c96d064eb1828a32487b2" title="Return the RTC alarm time. ">RTC_GetAlarm()</a> reads the alarm time in seconds, converts it to date & time format and stores it into a datetime structure passed in by the user.</p>
|
|
<h2><a class="anchor" id="RTCStart"></a>
|
|
Start & Stop timer</h2>
|
|
<p>The function <a class="el" href="a00047.html#gae8e7b09ad38776c0e360debf20145d78" title="Starts the RTC time counter. ">RTC_StartTimer()</a> starts the RTC time counter.</p>
|
|
<p>The function <a class="el" href="a00047.html#ga57f9d747f6972fd0a20e6ddccb42f084" title="Stops the RTC time counter. ">RTC_StopTimer()</a> stops the RTC time counter.</p>
|
|
<h2><a class="anchor" id="RTCStatus"></a>
|
|
Status</h2>
|
|
<p>Provides functions to get and clear the RTC status.</p>
|
|
<h2><a class="anchor" id="RTCInterrupt"></a>
|
|
Interrupt</h2>
|
|
<p>Provides functions to enable/disable RTC interrupts and get current enabled interrupts.</p>
|
|
<h2><a class="anchor" id="RTCHighResolution"></a>
|
|
High resolution timer</h2>
|
|
<p>Provides functions to enable high resolution timer and set and get the wake time.</p>
|
|
<h1><a class="anchor" id="RTCUseCase"></a>
|
|
Typical use case</h1>
|
|
<h2><a class="anchor" id="RTCTick"></a>
|
|
RTC tick example</h2>
|
|
<p>Example to set the RTC current time and trigger an alarm. Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/rtc </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:a00199"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00199.html">fsl_rtc.h</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00386"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a00386">_rtc_datetime</a></td></tr>
|
|
<tr class="memdesc:a00386"><td class="mdescLeft"> </td><td class="mdescRight">Structure is used to hold the date and time. <a href="a00047.html#a00386">More...</a><br/></td></tr>
|
|
<tr class="separator:a00386"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gaeb1b859adba89d7257893319b166dfd6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeb1b859adba89d7257893319b166dfd6"></a>
|
|
typedef enum <a class="el" href="a00047.html#ga0ce98b2ee8ea8a560a84942f64d13f82">_rtc_interrupt_enable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaeb1b859adba89d7257893319b166dfd6">rtc_interrupt_enable_t</a></td></tr>
|
|
<tr class="memdesc:gaeb1b859adba89d7257893319b166dfd6"><td class="mdescLeft"> </td><td class="mdescRight">List of RTC interrupts. <br/></td></tr>
|
|
<tr class="separator:gaeb1b859adba89d7257893319b166dfd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga07906a0d5dd00ca074b4b5cea7cd1fa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga07906a0d5dd00ca074b4b5cea7cd1fa1"></a>
|
|
typedef enum <a class="el" href="a00047.html#gae3955525f31772c51bf9c70289058b8f">_rtc_status_flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga07906a0d5dd00ca074b4b5cea7cd1fa1">rtc_status_flags_t</a></td></tr>
|
|
<tr class="memdesc:ga07906a0d5dd00ca074b4b5cea7cd1fa1"><td class="mdescLeft"> </td><td class="mdescRight">List of RTC flags. <br/></td></tr>
|
|
<tr class="separator:ga07906a0d5dd00ca074b4b5cea7cd1fa1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1c92d4d0732e176d854c9bd6acfddf54"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1c92d4d0732e176d854c9bd6acfddf54"></a>
|
|
typedef struct <a class="el" href="a00047.html#a00386">_rtc_datetime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a></td></tr>
|
|
<tr class="memdesc:ga1c92d4d0732e176d854c9bd6acfddf54"><td class="mdescLeft"> </td><td class="mdescRight">Structure is used to hold the date and time. <br/></td></tr>
|
|
<tr class="separator:ga1c92d4d0732e176d854c9bd6acfddf54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga0ce98b2ee8ea8a560a84942f64d13f82"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga0ce98b2ee8ea8a560a84942f64d13f82">_rtc_interrupt_enable</a> { <br/>
|
|
  <a class="el" href="a00047.html#gga0ce98b2ee8ea8a560a84942f64d13f82abd7ca2093bc2df536c828d8c8ea3dab4">kRTC_AlarmInterruptEnable</a> = RTC_CTRL_ALARMDPD_EN_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00047.html#gga0ce98b2ee8ea8a560a84942f64d13f82a85150e978eefb18549c8766d3614f294">kRTC_WakeupInterruptEnable</a> = RTC_CTRL_WAKEDPD_EN_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga0ce98b2ee8ea8a560a84942f64d13f82"><td class="mdescLeft"> </td><td class="mdescRight">List of RTC interrupts. <a href="a00047.html#ga0ce98b2ee8ea8a560a84942f64d13f82">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0ce98b2ee8ea8a560a84942f64d13f82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae3955525f31772c51bf9c70289058b8f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gae3955525f31772c51bf9c70289058b8f">_rtc_status_flags</a> { <br/>
|
|
  <a class="el" href="a00047.html#ggae3955525f31772c51bf9c70289058b8fa12101de586ebe90b1662305f467d88b2">kRTC_AlarmFlag</a> = RTC_CTRL_ALARM1HZ_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00047.html#ggae3955525f31772c51bf9c70289058b8fa769a7e3c726d0b2fe51b203e312656e3">kRTC_WakeupFlag</a> = RTC_CTRL_WAKE1KHZ_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gae3955525f31772c51bf9c70289058b8f"><td class="mdescLeft"> </td><td class="mdescRight">List of RTC flags. <a href="a00047.html#gae3955525f31772c51bf9c70289058b8f">More...</a><br/></td></tr>
|
|
<tr class="separator:gae3955525f31772c51bf9c70289058b8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga188f38518206b9b8ad1fd51985be4f63"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga188f38518206b9b8ad1fd51985be4f63">RTC_SetSecondsTimerMatch</a> (RTC_Type *base, uint32_t matchValue)</td></tr>
|
|
<tr class="memdesc:ga188f38518206b9b8ad1fd51985be4f63"><td class="mdescLeft"> </td><td class="mdescRight">Set the RTC seconds timer (1HZ) MATCH value. <a href="#ga188f38518206b9b8ad1fd51985be4f63">More...</a><br/></td></tr>
|
|
<tr class="separator:ga188f38518206b9b8ad1fd51985be4f63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab204de09391b29bb847c62ddf32692c8"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gab204de09391b29bb847c62ddf32692c8">RTC_GetSecondsTimerMatch</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gab204de09391b29bb847c62ddf32692c8"><td class="mdescLeft"> </td><td class="mdescRight">Read actual RTC seconds timer (1HZ) MATCH value. <a href="#gab204de09391b29bb847c62ddf32692c8">More...</a><br/></td></tr>
|
|
<tr class="separator:gab204de09391b29bb847c62ddf32692c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe684949b43219d9b8ace6e1b82cf03e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gafe684949b43219d9b8ace6e1b82cf03e">RTC_SetSecondsTimerCount</a> (RTC_Type *base, uint32_t countValue)</td></tr>
|
|
<tr class="memdesc:gafe684949b43219d9b8ace6e1b82cf03e"><td class="mdescLeft"> </td><td class="mdescRight">Set the RTC seconds timer (1HZ) COUNT value. <a href="#gafe684949b43219d9b8ace6e1b82cf03e">More...</a><br/></td></tr>
|
|
<tr class="separator:gafe684949b43219d9b8ace6e1b82cf03e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga86c4ffa8ccc89407fa6027b3fed96659"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga86c4ffa8ccc89407fa6027b3fed96659">RTC_GetSecondsTimerCount</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga86c4ffa8ccc89407fa6027b3fed96659"><td class="mdescLeft"> </td><td class="mdescRight">Read the actual RTC seconds timer (1HZ) COUNT value. <a href="#ga86c4ffa8ccc89407fa6027b3fed96659">More...</a><br/></td></tr>
|
|
<tr class="separator:ga86c4ffa8ccc89407fa6027b3fed96659"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3ee2c1fffebf80d9ee6813f6259240f3"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga3ee2c1fffebf80d9ee6813f6259240f3">RTC_SetWakeupCount</a> (RTC_Type *base, uint16_t wakeupValue)</td></tr>
|
|
<tr class="memdesc:ga3ee2c1fffebf80d9ee6813f6259240f3"><td class="mdescLeft"> </td><td class="mdescRight">Enable the RTC wake-up timer (1KHZ) and set countdown value to the RTC WAKE register. <a href="#ga3ee2c1fffebf80d9ee6813f6259240f3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3ee2c1fffebf80d9ee6813f6259240f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad8858374c7b3a191adb31274a4707c9c"><td class="memItemLeft" align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gad8858374c7b3a191adb31274a4707c9c">RTC_GetWakeupCount</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gad8858374c7b3a191adb31274a4707c9c"><td class="mdescLeft"> </td><td class="mdescRight">Read the actual value from the WAKE register value in RTC wake-up timer (1KHZ) <a href="#gad8858374c7b3a191adb31274a4707c9c">More...</a><br/></td></tr>
|
|
<tr class="separator:gad8858374c7b3a191adb31274a4707c9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5bf2f1b9b635918d74c5f4bb5b027d6c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga5bf2f1b9b635918d74c5f4bb5b027d6c">RTC_Reset</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga5bf2f1b9b635918d74c5f4bb5b027d6c"><td class="mdescLeft"> </td><td class="mdescRight">Perform a software reset on the RTC module. <a href="#ga5bf2f1b9b635918d74c5f4bb5b027d6c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5bf2f1b9b635918d74c5f4bb5b027d6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:gaea33cb4ca030fb967d99babaec611ff9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaea33cb4ca030fb967d99babaec611ff9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaea33cb4ca030fb967d99babaec611ff9">FSL_RTC_DRIVER_VERSION</a>   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 2, 0))</td></tr>
|
|
<tr class="memdesc:gaea33cb4ca030fb967d99babaec611ff9"><td class="mdescLeft"> </td><td class="mdescRight">Version 2.2.0. <br/></td></tr>
|
|
<tr class="separator:gaea33cb4ca030fb967d99babaec611ff9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Initialization and deinitialization</h2></td></tr>
|
|
<tr class="memitem:gaa39b6b86a1f4c82bc8b1cf86366cabc5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaa39b6b86a1f4c82bc8b1cf86366cabc5">RTC_Init</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gaa39b6b86a1f4c82bc8b1cf86366cabc5"><td class="mdescLeft"> </td><td class="mdescRight">Un-gate the RTC clock and enable the RTC oscillator. <a href="#gaa39b6b86a1f4c82bc8b1cf86366cabc5">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa39b6b86a1f4c82bc8b1cf86366cabc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0f365b0df0c2e61b07a7e178bd0f1581"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga0f365b0df0c2e61b07a7e178bd0f1581">RTC_Deinit</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga0f365b0df0c2e61b07a7e178bd0f1581"><td class="mdescLeft"> </td><td class="mdescRight">Stop the timer and gate the RTC clock. <a href="#ga0f365b0df0c2e61b07a7e178bd0f1581">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0f365b0df0c2e61b07a7e178bd0f1581"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Current Time & Alarm</h2></td></tr>
|
|
<tr class="memitem:ga5ddf5a972712795ee53468c3cc35b2de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga5ddf5a972712795ee53468c3cc35b2de">RTC_SetDatetime</a> (RTC_Type *base, const <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> *datetime)</td></tr>
|
|
<tr class="memdesc:ga5ddf5a972712795ee53468c3cc35b2de"><td class="mdescLeft"> </td><td class="mdescRight">Set the RTC date and time according to the given time structure. <a href="#ga5ddf5a972712795ee53468c3cc35b2de">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5ddf5a972712795ee53468c3cc35b2de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabd709e50b2b6129bd429352282890720"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gabd709e50b2b6129bd429352282890720">RTC_GetDatetime</a> (RTC_Type *base, <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> *datetime)</td></tr>
|
|
<tr class="memdesc:gabd709e50b2b6129bd429352282890720"><td class="mdescLeft"> </td><td class="mdescRight">Get the RTC time and stores it in the given time structure. <a href="#gabd709e50b2b6129bd429352282890720">More...</a><br/></td></tr>
|
|
<tr class="separator:gabd709e50b2b6129bd429352282890720"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab2d6ccb1f963f5c38166bfe0a3e90955"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gab2d6ccb1f963f5c38166bfe0a3e90955">RTC_SetAlarm</a> (RTC_Type *base, const <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> *alarmTime)</td></tr>
|
|
<tr class="memdesc:gab2d6ccb1f963f5c38166bfe0a3e90955"><td class="mdescLeft"> </td><td class="mdescRight">Set the RTC alarm time. <a href="#gab2d6ccb1f963f5c38166bfe0a3e90955">More...</a><br/></td></tr>
|
|
<tr class="separator:gab2d6ccb1f963f5c38166bfe0a3e90955"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga197e1135863c96d064eb1828a32487b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga197e1135863c96d064eb1828a32487b2">RTC_GetAlarm</a> (RTC_Type *base, <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> *datetime)</td></tr>
|
|
<tr class="memdesc:ga197e1135863c96d064eb1828a32487b2"><td class="mdescLeft"> </td><td class="mdescRight">Return the RTC alarm time. <a href="#ga197e1135863c96d064eb1828a32487b2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga197e1135863c96d064eb1828a32487b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
RTC wake-up timer (1KHZ) Enable</h2></td></tr>
|
|
<tr class="memitem:ga35e5568341bcfd02ca90a8f8ef5dcc07"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga35e5568341bcfd02ca90a8f8ef5dcc07">RTC_EnableWakeupTimer</a> (RTC_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:ga35e5568341bcfd02ca90a8f8ef5dcc07"><td class="mdescLeft"> </td><td class="mdescRight">Enable the RTC wake-up timer (1KHZ). <a href="#ga35e5568341bcfd02ca90a8f8ef5dcc07">More...</a><br/></td></tr>
|
|
<tr class="separator:ga35e5568341bcfd02ca90a8f8ef5dcc07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5f1bd209ad9641a86e1579408ec2c6ad"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga5f1bd209ad9641a86e1579408ec2c6ad">RTC_GetEnabledWakeupTimer</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga5f1bd209ad9641a86e1579408ec2c6ad"><td class="mdescLeft"> </td><td class="mdescRight">Get the enabled status of the RTC wake-up timer (1KHZ). <a href="#ga5f1bd209ad9641a86e1579408ec2c6ad">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5f1bd209ad9641a86e1579408ec2c6ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
SUBSEC counter</h2></td></tr>
|
|
<tr class="memitem:gac386a159ffeff836df4db5a59bed8b84"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gac386a159ffeff836df4db5a59bed8b84">RTC_EnableSubsecCounter</a> (RTC_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:gac386a159ffeff836df4db5a59bed8b84"><td class="mdescLeft"> </td><td class="mdescRight">Enable the RTC Sub-second counter (32KHZ). <a href="#gac386a159ffeff836df4db5a59bed8b84">More...</a><br/></td></tr>
|
|
<tr class="separator:gac386a159ffeff836df4db5a59bed8b84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab2d752f81e12da85ebfbcf4122e243d3"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gab2d752f81e12da85ebfbcf4122e243d3">RTC_GetSubsecValue</a> (const RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gab2d752f81e12da85ebfbcf4122e243d3"><td class="mdescLeft"> </td><td class="mdescRight">A read of 32KHZ sub-seconds counter. <a href="#gab2d752f81e12da85ebfbcf4122e243d3">More...</a><br/></td></tr>
|
|
<tr class="separator:gab2d752f81e12da85ebfbcf4122e243d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Interrupt Interface</h2></td></tr>
|
|
<tr class="memitem:gad8f82ea89d228efba39020973f2a7696"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gad8f82ea89d228efba39020973f2a7696">RTC_EnableWakeUpTimerInterruptFromDPD</a> (RTC_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:gad8f82ea89d228efba39020973f2a7696"><td class="mdescLeft"> </td><td class="mdescRight">Enable the wake-up timer interrupt from deep power down mode. <a href="#gad8f82ea89d228efba39020973f2a7696">More...</a><br/></td></tr>
|
|
<tr class="separator:gad8f82ea89d228efba39020973f2a7696"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga68e28fcbceafad7d7edf0100c2f703ca"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga68e28fcbceafad7d7edf0100c2f703ca">RTC_EnableAlarmTimerInterruptFromDPD</a> (RTC_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:ga68e28fcbceafad7d7edf0100c2f703ca"><td class="mdescLeft"> </td><td class="mdescRight">Enable the alarm timer interrupt from deep power down mode. <a href="#ga68e28fcbceafad7d7edf0100c2f703ca">More...</a><br/></td></tr>
|
|
<tr class="separator:ga68e28fcbceafad7d7edf0100c2f703ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac7de16884fa268bf9d1d1f4b983fc2d4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gac7de16884fa268bf9d1d1f4b983fc2d4">RTC_EnableInterrupts</a> (RTC_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:gac7de16884fa268bf9d1d1f4b983fc2d4"><td class="mdescLeft"> </td><td class="mdescRight">Enables the selected RTC interrupts. <a href="#gac7de16884fa268bf9d1d1f4b983fc2d4">More...</a><br/></td></tr>
|
|
<tr class="separator:gac7de16884fa268bf9d1d1f4b983fc2d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad12d4e10c5601f53d1626a5ae71691b9"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gad12d4e10c5601f53d1626a5ae71691b9">RTC_DisableInterrupts</a> (RTC_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:gad12d4e10c5601f53d1626a5ae71691b9"><td class="mdescLeft"> </td><td class="mdescRight">Disables the selected RTC interrupts. <a href="#gad12d4e10c5601f53d1626a5ae71691b9">More...</a><br/></td></tr>
|
|
<tr class="separator:gad12d4e10c5601f53d1626a5ae71691b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad0a0f005f9deff51c6a686901b62cf56"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gad0a0f005f9deff51c6a686901b62cf56">RTC_GetEnabledInterrupts</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gad0a0f005f9deff51c6a686901b62cf56"><td class="mdescLeft"> </td><td class="mdescRight">Get the enabled RTC interrupts. <a href="#gad0a0f005f9deff51c6a686901b62cf56">More...</a><br/></td></tr>
|
|
<tr class="separator:gad0a0f005f9deff51c6a686901b62cf56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Status Interface</h2></td></tr>
|
|
<tr class="memitem:ga8e0dbfd23fc268adfcaa5c6d0c7b6650"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga8e0dbfd23fc268adfcaa5c6d0c7b6650">RTC_GetStatusFlags</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga8e0dbfd23fc268adfcaa5c6d0c7b6650"><td class="mdescLeft"> </td><td class="mdescRight">Get the RTC status flags. <a href="#ga8e0dbfd23fc268adfcaa5c6d0c7b6650">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8e0dbfd23fc268adfcaa5c6d0c7b6650"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga69bd3151f6c6b8cf21a74cc11a9f4900"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga69bd3151f6c6b8cf21a74cc11a9f4900">RTC_ClearStatusFlags</a> (RTC_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga69bd3151f6c6b8cf21a74cc11a9f4900"><td class="mdescLeft"> </td><td class="mdescRight">Clear the RTC status flags. <a href="#ga69bd3151f6c6b8cf21a74cc11a9f4900">More...</a><br/></td></tr>
|
|
<tr class="separator:ga69bd3151f6c6b8cf21a74cc11a9f4900"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Timer Enable</h2></td></tr>
|
|
<tr class="memitem:gaa75afda17ce70757d012cd42a0bd714b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gaa75afda17ce70757d012cd42a0bd714b">RTC_EnableTimer</a> (RTC_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:gaa75afda17ce70757d012cd42a0bd714b"><td class="mdescLeft"> </td><td class="mdescRight">Enable the RTC timer counter. <a href="#gaa75afda17ce70757d012cd42a0bd714b">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa75afda17ce70757d012cd42a0bd714b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae8e7b09ad38776c0e360debf20145d78"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#gae8e7b09ad38776c0e360debf20145d78">RTC_StartTimer</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:gae8e7b09ad38776c0e360debf20145d78"><td class="mdescLeft"> </td><td class="mdescRight">Starts the RTC time counter. <a href="#gae8e7b09ad38776c0e360debf20145d78">More...</a><br/></td></tr>
|
|
<tr class="separator:gae8e7b09ad38776c0e360debf20145d78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga57f9d747f6972fd0a20e6ddccb42f084"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ga57f9d747f6972fd0a20e6ddccb42f084">RTC_StopTimer</a> (RTC_Type *base)</td></tr>
|
|
<tr class="memdesc:ga57f9d747f6972fd0a20e6ddccb42f084"><td class="mdescLeft"> </td><td class="mdescRight">Stops the RTC time counter. <a href="#ga57f9d747f6972fd0a20e6ddccb42f084">More...</a><br/></td></tr>
|
|
<tr class="separator:ga57f9d747f6972fd0a20e6ddccb42f084"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00386" id="a00386"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _rtc_datetime</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:aa155139d886c469e6f9398415b1edc46"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#aa155139d886c469e6f9398415b1edc46">year</a></td></tr>
|
|
<tr class="memdesc:aa155139d886c469e6f9398415b1edc46"><td class="mdescLeft"> </td><td class="mdescRight">Range from 1970 to 2099. <a href="#aa155139d886c469e6f9398415b1edc46">More...</a><br/></td></tr>
|
|
<tr class="separator:aa155139d886c469e6f9398415b1edc46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade946b33023c232bd0f0a1d09636cf8d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ade946b33023c232bd0f0a1d09636cf8d">month</a></td></tr>
|
|
<tr class="memdesc:ade946b33023c232bd0f0a1d09636cf8d"><td class="mdescLeft"> </td><td class="mdescRight">Range from 1 to 12. <a href="#ade946b33023c232bd0f0a1d09636cf8d">More...</a><br/></td></tr>
|
|
<tr class="separator:ade946b33023c232bd0f0a1d09636cf8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62c6014b1eaad0c2bacd71bf2c8b58e0"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a62c6014b1eaad0c2bacd71bf2c8b58e0">day</a></td></tr>
|
|
<tr class="memdesc:a62c6014b1eaad0c2bacd71bf2c8b58e0"><td class="mdescLeft"> </td><td class="mdescRight">Range from 1 to 31 (depending on month). <a href="#a62c6014b1eaad0c2bacd71bf2c8b58e0">More...</a><br/></td></tr>
|
|
<tr class="separator:a62c6014b1eaad0c2bacd71bf2c8b58e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad050219d2bdc3d361fb729eaca91778b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ad050219d2bdc3d361fb729eaca91778b">hour</a></td></tr>
|
|
<tr class="memdesc:ad050219d2bdc3d361fb729eaca91778b"><td class="mdescLeft"> </td><td class="mdescRight">Range from 0 to 23. <a href="#ad050219d2bdc3d361fb729eaca91778b">More...</a><br/></td></tr>
|
|
<tr class="separator:ad050219d2bdc3d361fb729eaca91778b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0095b8527a2dcba7199cbce4f585736a"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a0095b8527a2dcba7199cbce4f585736a">minute</a></td></tr>
|
|
<tr class="memdesc:a0095b8527a2dcba7199cbce4f585736a"><td class="mdescLeft"> </td><td class="mdescRight">Range from 0 to 59. <a href="#a0095b8527a2dcba7199cbce4f585736a">More...</a><br/></td></tr>
|
|
<tr class="separator:a0095b8527a2dcba7199cbce4f585736a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cd2e85b4d09c10bd2049cf3cefca715"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a2cd2e85b4d09c10bd2049cf3cefca715">second</a></td></tr>
|
|
<tr class="memdesc:a2cd2e85b4d09c10bd2049cf3cefca715"><td class="mdescLeft"> </td><td class="mdescRight">Range from 0 to 59. <a href="#a2cd2e85b4d09c10bd2049cf3cefca715">More...</a><br/></td></tr>
|
|
<tr class="separator:a2cd2e85b4d09c10bd2049cf3cefca715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="aa155139d886c469e6f9398415b1edc46"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t _rtc_datetime::year</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ade946b33023c232bd0f0a1d09636cf8d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _rtc_datetime::month</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a62c6014b1eaad0c2bacd71bf2c8b58e0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _rtc_datetime::day</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad050219d2bdc3d361fb729eaca91778b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _rtc_datetime::hour</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0095b8527a2dcba7199cbce4f585736a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _rtc_datetime::minute</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2cd2e85b4d09c10bd2049cf3cefca715"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _rtc_datetime::second</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga0ce98b2ee8ea8a560a84942f64d13f82"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00047.html#ga0ce98b2ee8ea8a560a84942f64d13f82">_rtc_interrupt_enable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga0ce98b2ee8ea8a560a84942f64d13f82abd7ca2093bc2df536c828d8c8ea3dab4"></a>kRTC_AlarmInterruptEnable</em> </td><td class="fielddoc">
|
|
<p>Alarm interrupt. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0ce98b2ee8ea8a560a84942f64d13f82a85150e978eefb18549c8766d3614f294"></a>kRTC_WakeupInterruptEnable</em> </td><td class="fielddoc">
|
|
<p>Wake-up interrupt. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae3955525f31772c51bf9c70289058b8f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00047.html#gae3955525f31772c51bf9c70289058b8f">_rtc_status_flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggae3955525f31772c51bf9c70289058b8fa12101de586ebe90b1662305f467d88b2"></a>kRTC_AlarmFlag</em> </td><td class="fielddoc">
|
|
<p>Alarm flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggae3955525f31772c51bf9c70289058b8fa769a7e3c726d0b2fe51b203e312656e3"></a>kRTC_WakeupFlag</em> </td><td class="fielddoc">
|
|
<p>1kHz wake-up timer flag </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaa39b6b86a1f4c82bc8b1cf86366cabc5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This API should be called at the beginning of the application using the RTC driver.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0f365b0df0c2e61b07a7e178bd0f1581"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5ddf5a972712795ee53468c3cc35b2de"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> RTC_SetDatetime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> * </td>
|
|
<td class="paramname"><em>datetime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The RTC counter must be stopped prior to calling this function as writes to the RTC seconds register will fail if the RTC counter is running.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">datetime</td><td>Pointer to structure where the date and time details to set are stored</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success: Success in setting the time and starting the RTC kStatus_InvalidArgument: Error because the datetime format is incorrect </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabd709e50b2b6129bd429352282890720"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_GetDatetime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> * </td>
|
|
<td class="paramname"><em>datetime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">datetime</td><td>Pointer to structure where the date and time details are stored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab2d6ccb1f963f5c38166bfe0a3e90955"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> RTC_SetAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> * </td>
|
|
<td class="paramname"><em>alarmTime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The function checks whether the specified alarm time is greater than the present time. If not, the function does not set the alarm and returns an error.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">alarmTime</td><td>Pointer to structure where the alarm time is stored.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success: success in setting the RTC alarm kStatus_InvalidArgument: Error because the alarm datetime format is incorrect kStatus_Fail: Error because the alarm time has already passed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga197e1135863c96d064eb1828a32487b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RTC_GetAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00047.html#ga1c92d4d0732e176d854c9bd6acfddf54">rtc_datetime_t</a> * </td>
|
|
<td class="paramname"><em>datetime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">datetime</td><td>Pointer to structure where the alarm date and time details are stored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga35e5568341bcfd02ca90a8f8ef5dcc07"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableWakeupTimer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>After calling this function, the RTC driver will use/un-use the RTC wake-up (1KHZ) at the same time.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Use/Un-use the RTC wake-up timer.<ul>
|
|
<li>true: Use RTC wake-up timer at the same time.</li>
|
|
<li>false: Un-use RTC wake-up timer, RTC only use the normal seconds timer by default. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5f1bd209ad9641a86e1579408ec2c6ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetEnabledWakeupTimer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The enabled status of RTC wake-up timer (1KHZ). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac386a159ffeff836df4db5a59bed8b84"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableSubsecCounter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>Only enable sub-second counter after RTC_ENA bit has been set to 1.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Enable/Disable RTC sub-second counter.<ul>
|
|
<li>true: Enable RTC sub-second counter.</li>
|
|
<li>false: Disable RTC sub-second counter. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab2d752f81e12da85ebfbcf4122e243d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetSubsecValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current value of the SUBSEC register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga188f38518206b9b8ad1fd51985be4f63"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_SetSecondsTimerMatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>matchValue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">matchValue</td><td>The value to be set into the RTC MATCH register </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab204de09391b29bb847c62ddf32692c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetSecondsTimerMatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The actual RTC seconds timer (1HZ) MATCH value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafe684949b43219d9b8ace6e1b82cf03e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_SetSecondsTimerCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>countValue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">countValue</td><td>The value to be loaded into the RTC COUNT register </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga86c4ffa8ccc89407fa6027b3fed96659"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetSecondsTimerCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The actual RTC seconds timer (1HZ) COUNT value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3ee2c1fffebf80d9ee6813f6259240f3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_SetWakeupCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>wakeupValue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">wakeupValue</td><td>The value to be loaded into the WAKE register in RTC wake-up timer (1KHZ). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad8858374c7b3a191adb31274a4707c9c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint16_t RTC_GetWakeupCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Read the WAKE register twice and compare the result, if the value match,the time can be used.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The actual value of the WAKE register value in RTC wake-up timer (1KHZ). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad8f82ea89d228efba39020973f2a7696"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableWakeUpTimerInterruptFromDPD </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Enable/Disable wake-up timer interrupt from deep power down mode.<ul>
|
|
<li>true: Enable wake-up timer interrupt from deep power down mode.</li>
|
|
<li>false: Disable wake-up timer interrupt from deep power down mode. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga68e28fcbceafad7d7edf0100c2f703ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableAlarmTimerInterruptFromDPD </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Enable/Disable alarm timer interrupt from deep power down mode.<ul>
|
|
<li>true: Enable alarm timer interrupt from deep power down mode.</li>
|
|
<li>false: Disable alarm timer interrupt from deep power down mode. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac7de16884fa268bf9d1d1f4b983fc2d4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="a00296.html#_deprecated000006">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="a00047.html#ga68e28fcbceafad7d7edf0100c2f703ca">RTC_EnableAlarmTimerInterruptFromDPD</a> and RTC_EnableWakeUpTimerInterruptFromDPD</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The interrupts to enable. This is a logical OR of members of the enumeration <a class="el" href="a00047.html#gaeb1b859adba89d7257893319b166dfd6" title="List of RTC interrupts. ">rtc_interrupt_enable_t</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad12d4e10c5601f53d1626a5ae71691b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_DisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="a00296.html#_deprecated000007">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="a00047.html#ga68e28fcbceafad7d7edf0100c2f703ca">RTC_EnableAlarmTimerInterruptFromDPD</a> and RTC_EnableWakeUpTimerInterruptFromDPD</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The interrupts to enable. This is a logical OR of members of the enumeration <a class="el" href="a00047.html#gaeb1b859adba89d7257893319b166dfd6" title="List of RTC interrupts. ">rtc_interrupt_enable_t</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad0a0f005f9deff51c6a686901b62cf56"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetEnabledInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="a00296.html#_deprecated000008">Deprecated:</a></b></dt><dd>Do not use this function. It will be deleted in next release version.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The enabled interrupts. This is the logical OR of members of the enumeration <a class="el" href="a00047.html#gaeb1b859adba89d7257893319b166dfd6" title="List of RTC interrupts. ">rtc_interrupt_enable_t</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8e0dbfd23fc268adfcaa5c6d0c7b6650"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t RTC_GetStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags. This is the logical OR of members of the enumeration <a class="el" href="a00047.html#ga07906a0d5dd00ca074b4b5cea7cd1fa1" title="List of RTC flags. ">rtc_status_flags_t</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga69bd3151f6c6b8cf21a74cc11a9f4900"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_ClearStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The status flags to clear. This is a logical OR of members of the enumeration <a class="el" href="a00047.html#ga07906a0d5dd00ca074b4b5cea7cd1fa1" title="List of RTC flags. ">rtc_status_flags_t</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa75afda17ce70757d012cd42a0bd714b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_EnableTimer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>After calling this function, the RTC inner counter increments once a second when only using the RTC seconds timer (1hz), while the RTC inner wake-up timer countdown once a millisecond when using RTC wake-up timer (1KHZ) at the same time. RTC timer contain two timers, one is the RTC normal seconds timer, the other one is the RTC wake-up timer, the RTC enable bit is the master switch for the whole RTC timer, so user can use the RTC seconds (1HZ) timer independly, but they can't use the RTC wake-up timer (1KHZ) independently.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Enable/Disable RTC Timer counter.<ul>
|
|
<li>true: Enable RTC Timer counter.</li>
|
|
<li>false: Disable RTC Timer counter. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae8e7b09ad38776c0e360debf20145d78"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_StartTimer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="a00296.html#_deprecated000009">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="a00047.html#gaa75afda17ce70757d012cd42a0bd714b">RTC_EnableTimer</a></dd></dl>
|
|
<p>After calling this function, the timer counter increments once a second provided SR[TOF] or SR[TIF] are not set.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga57f9d747f6972fd0a20e6ddccb42f084"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_StopTimer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="a00296.html#_deprecated000010">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="a00047.html#gaa75afda17ce70757d012cd42a0bd714b">RTC_EnableTimer</a></dd></dl>
|
|
<p>RTC's seconds register can be written to only when the timer is stopped.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5bf2f1b9b635918d74c5f4bb5b027d6c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void RTC_Reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RTC_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This resets all RTC registers to their reset value. The bit is cleared by software explicitly clearing it.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>RTC peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|