mirror of
https://github.com/jialexd/sdk-ameba-v4.0c_180328.git
synced 2024-12-28 08:35:17 +00:00
156 lines
12 KiB
HTML
156 lines
12 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.11"/>
|
||
|
|
<title>SDK3.5: rtc_api.h File Reference</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 id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">SDK3.5
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">This document shows Ameba SDK 3.5 APIs</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
||
|
|
<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="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||
|
|
<li class="current"><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 id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
||
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<!-- 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 id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_59865070466a2d887ccae359ce349522.html">sdk-ameba</a></li><li class="navelem"><a class="el" href="dir_bb17c7c1f6b5d4e42018e46e245402cf.html">project</a></li><li class="navelem"><a class="el" href="dir_4d8a5561b87cbdbe66a2580ebcb931d0.html">realtek_8195a_gen_project</a></li><li class="navelem"><a class="el" href="dir_d55a6639c0ef2e769c54f3d73fdcd6ae.html">rtl8195a</a></li><li class="navelem"><a class="el" href="dir_218701c72f38a637f56ccea9eb201b28.html">sw</a></li><li class="navelem"><a class="el" href="dir_467016183711ec67a0924a03f0be9cbd.html">lib</a></li><li class="navelem"><a class="el" href="dir_91cf82b8388ba308ddfe17c7b1476a41.html">sw_lib</a></li><li class="navelem"><a class="el" href="dir_d752387d37b25b2ddfb0bd02d399f93a.html">mbed</a></li><li class="navelem"><a class="el" href="dir_0ab723912218eac66c7f4e14b04376cf.html">hal</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#nested-classes">Data Structures</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">rtc_api.h File Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>This file provides mbed RTC API.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
<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:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structalarm__s.html">alarm_s</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="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr><td colspan="2"><div class="groupHeader">Ameba Common</div></td></tr>
|
||
|
|
<tr class="memitem:gacf9024748b942a7ae375cf75951afa9c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gacf9024748b942a7ae375cf75951afa9c">rtc_init</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:gacf9024748b942a7ae375cf75951afa9c"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the RTC device, include clock, RTC registers and function. <a href="group__rtc.html#gacf9024748b942a7ae375cf75951afa9c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gacf9024748b942a7ae375cf75951afa9c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaff89a06474197687978319e11ccfbd8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gaff89a06474197687978319e11ccfbd8a">rtc_free</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:gaff89a06474197687978319e11ccfbd8a"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes the RTC device. <a href="group__rtc.html#gaff89a06474197687978319e11ccfbd8a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gaff89a06474197687978319e11ccfbd8a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga8d49d48e7cc7804e34305a99f34aa450"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga8d49d48e7cc7804e34305a99f34aa450">rtc_isenabled</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ga8d49d48e7cc7804e34305a99f34aa450"><td class="mdescLeft"> </td><td class="mdescRight">This function tells whether RTC is enabled or not. <a href="group__rtc.html#ga8d49d48e7cc7804e34305a99f34aa450">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga8d49d48e7cc7804e34305a99f34aa450"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga8c6e23c64ed14aa23f4d524720350228"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga8c6e23c64ed14aa23f4d524720350228">rtc_read</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ga8c6e23c64ed14aa23f4d524720350228"><td class="mdescLeft"> </td><td class="mdescRight">Get current timestamp in seconds from RTC. <a href="group__rtc.html#ga8c6e23c64ed14aa23f4d524720350228">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga8c6e23c64ed14aa23f4d524720350228"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaa3c98f2c275d1ecbafcdba6b6c6032e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gaa3c98f2c275d1ecbafcdba6b6c6032e7">rtc_write</a> (time_t t)</td></tr>
|
||
|
|
<tr class="memdesc:gaa3c98f2c275d1ecbafcdba6b6c6032e7"><td class="mdescLeft"> </td><td class="mdescRight">Set the specified timestamp in seconds to RTC. <a href="group__rtc.html#gaa3c98f2c275d1ecbafcdba6b6c6032e7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gaa3c98f2c275d1ecbafcdba6b6c6032e7"><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>
|
||
|
|
AmebaZ Only</h2></td></tr>
|
||
|
|
<tr class="memitem:ga3cfaf4fb7016e51e1e760e3f0197dce7"><td class="memItemLeft" align="right" valign="top">
|
||
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><b>alarm_irq_handler</b>) (void)</td></tr>
|
||
|
|
<tr class="separator:ga3cfaf4fb7016e51e1e760e3f0197dce7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gabb5d0c4995b9b00eb1159f92613ef98b"><td class="memItemLeft" align="right" valign="top">
|
||
|
|
typedef struct <a class="el" href="structalarm__s.html">alarm_s</a> </td><td class="memItemRight" valign="bottom"><b>alarm_t</b></td></tr>
|
||
|
|
<tr class="separator:gabb5d0c4995b9b00eb1159f92613ef98b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaceaa01d3f109ffbda1a81c48081cf6f9"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#gaceaa01d3f109ffbda1a81c48081cf6f9">rtc_set_alarm</a> (<a class="el" href="structalarm__s.html">alarm_t</a> *alrm, alarm_irq_handler alarmHandler)</td></tr>
|
||
|
|
<tr class="memdesc:gaceaa01d3f109ffbda1a81c48081cf6f9"><td class="mdescLeft"> </td><td class="mdescRight">Set the specified RTC Alarm and interrupt. <a href="group__rtc.html#gaceaa01d3f109ffbda1a81c48081cf6f9">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gaceaa01d3f109ffbda1a81c48081cf6f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga718b866eab2ba73221d37f7d15ba9737"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtc.html#ga718b866eab2ba73221d37f7d15ba9737">rtc_disable_alarm</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ga718b866eab2ba73221d37f7d15ba9737"><td class="mdescLeft"> </td><td class="mdescRight">Disable RTC Alarm and function. <a href="group__rtc.html#ga718b866eab2ba73221d37f7d15ba9737">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga718b866eab2ba73221d37f7d15ba9737"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>This file provides mbed RTC API. </p>
|
||
|
|
<p>mbed Microcontroller Library</p>
|
||
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
||
|
|
<dl class="section version"><dt>Version</dt><dd>V1.0.0 </dd></dl>
|
||
|
|
<dl class="section attention"><dt>Attention</dt><dd></dd></dl>
|
||
|
|
<p>Copyright (c) 2006-2013 ARM Limited</p>
|
||
|
|
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at </p><pre class="fragment">http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
</pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </p>
|
||
|
|
</div></div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.11
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|