sdk-ameba-v4.0b_without_nda.../doc/api_doc/sys__api_8h.html

152 lines
12 KiB
HTML
Raw Normal View History

2017-10-15 06:36:37 +00:00
<!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>SDK4.0: sys_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">SDK4.0
</div>
<div id="projectbrief">This document shows Ameba SDK 4.0 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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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="headertitle">
<div class="title">sys_api.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This file provides following mbed system API: -JTAG OFF -LOGUART ON/OFF -OTA image switch -System Reset.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;device.h&quot;</code><br />
</div><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:ga66c275f823ad53fe71b785b89fd03ce2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga66c275f823ad53fe71b785b89fd03ce2">sys_jtag_off</a> (void)</td></tr>
<tr class="memdesc:ga66c275f823ad53fe71b785b89fd03ce2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turn off the JTAG function. <a href="group__sys.html#ga66c275f823ad53fe71b785b89fd03ce2">More...</a><br /></td></tr>
<tr class="separator:ga66c275f823ad53fe71b785b89fd03ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dd2ff152bfeef84b569aa8257b6f88e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga9dd2ff152bfeef84b569aa8257b6f88e">sys_clear_ota_signature</a> (void)</td></tr>
<tr class="memdesc:ga9dd2ff152bfeef84b569aa8257b6f88e"><td class="mdescLeft">&#160;</td><td class="mdescRight">switch OTA image if the othe OTA image is valid <a href="group__sys.html#ga9dd2ff152bfeef84b569aa8257b6f88e">More...</a><br /></td></tr>
<tr class="separator:ga9dd2ff152bfeef84b569aa8257b6f88e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e67851723b154a1470f58c8bf1879aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga8e67851723b154a1470f58c8bf1879aa">sys_recover_ota_signature</a> (void)</td></tr>
<tr class="memdesc:ga8e67851723b154a1470f58c8bf1879aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">switch OTA image if the othe OTA image is valid <a href="group__sys.html#ga8e67851723b154a1470f58c8bf1879aa">More...</a><br /></td></tr>
<tr class="separator:ga8e67851723b154a1470f58c8bf1879aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec7a0be648a4bfa30d2ee0884456e6cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#gaec7a0be648a4bfa30d2ee0884456e6cd">sys_log_uart_on</a> (void)</td></tr>
<tr class="memdesc:gaec7a0be648a4bfa30d2ee0884456e6cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">open log uart <a href="group__sys.html#gaec7a0be648a4bfa30d2ee0884456e6cd">More...</a><br /></td></tr>
<tr class="separator:gaec7a0be648a4bfa30d2ee0884456e6cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd88d03a3f149d035e7e9263d6ec90f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#gabd88d03a3f149d035e7e9263d6ec90f6">sys_log_uart_off</a> (void)</td></tr>
<tr class="memdesc:gabd88d03a3f149d035e7e9263d6ec90f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">close log uart <a href="group__sys.html#gabd88d03a3f149d035e7e9263d6ec90f6">More...</a><br /></td></tr>
<tr class="separator:gabd88d03a3f149d035e7e9263d6ec90f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4850cee0aa58f450fab06598ec6f281b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga4850cee0aa58f450fab06598ec6f281b">sys_adc_calibration</a> (u8 write, u16 *offset, u16 *gain)</td></tr>
<tr class="memdesc:ga4850cee0aa58f450fab06598ec6f281b"><td class="mdescLeft">&#160;</td><td class="mdescRight">store or load adc calibration parameter <a href="group__sys.html#ga4850cee0aa58f450fab06598ec6f281b">More...</a><br /></td></tr>
<tr class="separator:ga4850cee0aa58f450fab06598ec6f281b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b1ed233a180d3991b4832e9de38e176"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga2b1ed233a180d3991b4832e9de38e176">sys_reset</a> (void)</td></tr>
<tr class="memdesc:ga2b1ed233a180d3991b4832e9de38e176"><td class="mdescLeft">&#160;</td><td class="mdescRight">system software reset <a href="group__sys.html#ga2b1ed233a180d3991b4832e9de38e176">More...</a><br /></td></tr>
<tr class="separator:ga2b1ed233a180d3991b4832e9de38e176"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Ameba1 Only</div></td></tr>
<tr class="memitem:ga08d16f06a2890265dfef734c95952577"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga08d16f06a2890265dfef734c95952577">sys_is_sdram_power_on</a> (void)</td></tr>
<tr class="memdesc:ga08d16f06a2890265dfef734c95952577"><td class="mdescLeft">&#160;</td><td class="mdescRight">check whether is sdram power on <a href="group__sys.html#ga08d16f06a2890265dfef734c95952577">More...</a><br /></td></tr>
<tr class="separator:ga08d16f06a2890265dfef734c95952577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga106919e7d57b3674cc788e16d80aa7b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#ga106919e7d57b3674cc788e16d80aa7b7">sys_sdram_off</a> (void)</td></tr>
<tr class="memdesc:ga106919e7d57b3674cc788e16d80aa7b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">sdram power off <a href="group__sys.html#ga106919e7d57b3674cc788e16d80aa7b7">More...</a><br /></td></tr>
<tr class="separator:ga106919e7d57b3674cc788e16d80aa7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">AmebaZ Only</div></td></tr>
<tr class="memitem:gad754d2c29aec7cf2c69cc74e1f1622ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys.html#gad754d2c29aec7cf2c69cc74e1f1622ff">sys_cpu_reset</a> (void)</td></tr>
<tr class="memdesc:gad754d2c29aec7cf2c69cc74e1f1622ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">vector reset <a href="group__sys.html#gad754d2c29aec7cf2c69cc74e1f1622ff">More...</a><br /></td></tr>
<tr class="separator:gad754d2c29aec7cf2c69cc74e1f1622ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file provides following mbed system API: -JTAG OFF -LOGUART ON/OFF -OTA image switch -System Reset. </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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>