mirror of
https://github.com/jialexd/sdk-ameba-v4.0c_180328.git
synced 2024-11-25 15:34:20 +00:00
163 lines
14 KiB
HTML
163 lines
14 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: sleep_ex_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_adf298d7cff763ecf28c97eaa1fb8ba3.html">hal_ext</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#nested-classes">Data Structures</a> |
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">sleep_ex_api.h File Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>This file provides mbed API for SLEEP.
|
||
|
|
<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="struct___s_l_e_e_p___w_k_u_p___e_v_e_n_t__.html">_SLEEP_WKUP_EVENT_</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct___s_l_e_e_p___w_k_u_p___e_v_e_n_t__.html">_SLEEP_WKUP_EVENT_</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 class="memitem:gad65d777333881159b786f5de0789ebde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gad65d777333881159b786f5de0789ebde">deepsleep_ex</a> (uint32_t wakeup_event, uint32_t sleep_duration)</td></tr>
|
||
|
|
<tr class="memdesc:gad65d777333881159b786f5de0789ebde"><td class="mdescLeft"> </td><td class="mdescRight">To make the system entering the Deep Sleep power saving mode. The CPU, memory and peripheral power is off when entering deep sleep power saving mode. The program needs to be reload and all peripheral needs be re-configure when system resume. <a href="group__sleep__ex.html#gad65d777333881159b786f5de0789ebde">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gad65d777333881159b786f5de0789ebde"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gaa5f3ff69148b38477bc0c5c1504d8cd4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gaa5f3ff69148b38477bc0c5c1504d8cd4">standby_wakeup_event_del</a> (uint32_t wakeup_event)</td></tr>
|
||
|
|
<tr class="memdesc:gaa5f3ff69148b38477bc0c5c1504d8cd4"><td class="mdescLeft"> </td><td class="mdescRight">To delete a wake up event for wakeing up the system from the deep standby power saving mode. <a href="group__sleep__ex.html#gaa5f3ff69148b38477bc0c5c1504d8cd4">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gaa5f3ff69148b38477bc0c5c1504d8cd4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr><td colspan="2"><div class="groupHeader">Ameba Common</div></td></tr>
|
||
|
|
<tr class="memitem:gad4d449c4cb94b1db597594779d59b7d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gad4d449c4cb94b1db597594779d59b7d0">sleep_ex</a> (uint32_t wakeup_event, uint32_t sleep_duration)</td></tr>
|
||
|
|
<tr class="memdesc:gad4d449c4cb94b1db597594779d59b7d0"><td class="mdescLeft"> </td><td class="mdescRight">To make the system entering the Clock Gated power saving. This function just make the system to enter the clock gated power saving mode and pending on wake up event waitting. The user application need to configure the peripheral to generate system wake up event, like GPIO interrupt, G-Timer timeout, etc. befor entering power saving mode. <a href="group__sleep__ex.html#gad4d449c4cb94b1db597594779d59b7d0">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gad4d449c4cb94b1db597594779d59b7d0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gadd8b28252d4c529fdc5beb3db6c023b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gadd8b28252d4c529fdc5beb3db6c023b2">sleep_ex_selective</a> (uint32_t wakeup_event, uint32_t sleep_duration, uint32_t clk_sourec_enable, uint32_t sdr_enable)</td></tr>
|
||
|
|
<tr class="memdesc:gadd8b28252d4c529fdc5beb3db6c023b2"><td class="mdescLeft"> </td><td class="mdescRight">To make the system entering the Clock Gated power saving. This function just make the system to enter the clock gated power saving mode and pending on wake up event waitting. The user application need to configure the peripheral to generate system wake up event, like GPIO interrupt , G-Timer timeout, etc. befor entering power saving mode. <a href="group__sleep__ex.html#gadd8b28252d4c529fdc5beb3db6c023b2">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gadd8b28252d4c529fdc5beb3db6c023b2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr><td colspan="2"><div class="groupHeader">AmebaZ Only</div></td></tr>
|
||
|
|
<tr class="memitem:gac303f28059f7dafb72cc9bdd780a415f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gac303f28059f7dafb72cc9bdd780a415f">deepstandby_ex</a> (uint32_t sleep_duration_ms)</td></tr>
|
||
|
|
<tr class="memdesc:gac303f28059f7dafb72cc9bdd780a415f"><td class="mdescLeft"> </td><td class="mdescRight">To make the system entering the Deep Standby power saving. The CPU, memory and part fo peripheral power is off when entering deep standby power saving mode. The program needs to be reload from the flash at system resume. <a href="group__sleep__ex.html#gac303f28059f7dafb72cc9bdd780a415f">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gac303f28059f7dafb72cc9bdd780a415f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga37da777f9d57ebb429f03dd830681f0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#ga37da777f9d57ebb429f03dd830681f0a">standby_wakeup_event_add</a> (uint32_t wakeup_event, uint32_t gpio_active)</td></tr>
|
||
|
|
<tr class="memdesc:ga37da777f9d57ebb429f03dd830681f0a"><td class="mdescLeft"> </td><td class="mdescRight">To add a wake up event to wake up the system from the deep standby power saving mode. <a href="group__sleep__ex.html#ga37da777f9d57ebb429f03dd830681f0a">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga37da777f9d57ebb429f03dd830681f0a"><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>
|
||
|
|
Ameba1 Only</h2></td></tr>
|
||
|
|
<tr class="memitem:gac9e1fab9bc098befc811583d8095b449"><td class="memItemLeft" align="right" valign="top">
|
||
|
|
typedef struct <a class="el" href="struct___s_l_e_e_p___w_k_u_p___e_v_e_n_t__.html">_SLEEP_WKUP_EVENT_</a> </td><td class="memItemRight" valign="bottom"><b>SLEEP_WAKEUP_EVENT</b></td></tr>
|
||
|
|
<tr class="separator:gac9e1fab9bc098befc811583d8095b449"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gadef508882a286eba1083ab0626781db6"><td class="memItemLeft" align="right" valign="top">
|
||
|
|
typedef struct <a class="el" href="struct___s_l_e_e_p___w_k_u_p___e_v_e_n_t__.html">_SLEEP_WKUP_EVENT_</a> * </td><td class="memItemRight" valign="bottom"><b>PSLEEP_WAKEUP_EVENT</b></td></tr>
|
||
|
|
<tr class="separator:gadef508882a286eba1083ab0626781db6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gabb5d5ab57b78c67cca30d616bb00935c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#gabb5d5ab57b78c67cca30d616bb00935c">deepstandby_ex</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:gabb5d5ab57b78c67cca30d616bb00935c"><td class="mdescLeft"> </td><td class="mdescRight">To make the system entering the Deep Standby power saving. The CPU, memory and part fo peripheral power is off when entering deep standby power saving mode. The program needs to be reload from the flash at system resume. <a href="group__sleep__ex.html#gabb5d5ab57b78c67cca30d616bb00935c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gabb5d5ab57b78c67cca30d616bb00935c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga61b6fa80941e0754db9dcd7cb38ac809"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sleep__ex.html#ga61b6fa80941e0754db9dcd7cb38ac809">standby_wakeup_event_add</a> (uint32_t wakeup_event, uint32_t sleep_duration_ms, uint32_t gpio_active)</td></tr>
|
||
|
|
<tr class="memdesc:ga61b6fa80941e0754db9dcd7cb38ac809"><td class="mdescLeft"> </td><td class="mdescRight">To add a wake up event to wake up the system from the deep standby power saving mode. <a href="group__sleep__ex.html#ga61b6fa80941e0754db9dcd7cb38ac809">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga61b6fa80941e0754db9dcd7cb38ac809"><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 API for SLEEP. </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>
|