netease
/
esp8266-std
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
esp8266-std/ESP8266_RTOS_SDK/documents/html/group__HW__Timer__APIs.html

198 lines
8.3 KiB
HTML
Raw Blame History

<!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.10"/>
<title>ESP8266_RTOS_SDK: Hardware timer APIs</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">ESP8266_RTOS_SDK
&#160;<span id="projectnumber">v1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<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><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Hardware timer APIs<div class="ingroups"><a class="el" href="group__Driver__APIs.html">Driver APIs</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Hardware timer APIs.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga09f8d1ed286cb02bfe47bc5f6c67b570"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__HW__Timer__APIs.html#ga09f8d1ed286cb02bfe47bc5f6c67b570">hw_timer_init</a> (uint8 req)</td></tr>
<tr class="memdesc:ga09f8d1ed286cb02bfe47bc5f6c67b570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the hardware ISR timer. <a href="#ga09f8d1ed286cb02bfe47bc5f6c67b570">More...</a><br /></td></tr>
<tr class="separator:ga09f8d1ed286cb02bfe47bc5f6c67b570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace64c59d338a9d785bd5730029086553"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__HW__Timer__APIs.html#gace64c59d338a9d785bd5730029086553">hw_timer_arm</a> (uint32 val)</td></tr>
<tr class="memdesc:gace64c59d338a9d785bd5730029086553"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a trigger timer delay to enable this timer. <a href="#gace64c59d338a9d785bd5730029086553">More...</a><br /></td></tr>
<tr class="separator:gace64c59d338a9d785bd5730029086553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78c91a9ec46aa9fb5b9fae9d357e9957"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__HW__Timer__APIs.html#ga78c91a9ec46aa9fb5b9fae9d357e9957">hw_timer_set_func</a> (void(*user_hw_timer_cb_set)(void))</td></tr>
<tr class="memdesc:ga78c91a9ec46aa9fb5b9fae9d357e9957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set timer callback function. <a href="#ga78c91a9ec46aa9fb5b9fae9d357e9957">More...</a><br /></td></tr>
<tr class="separator:ga78c91a9ec46aa9fb5b9fae9d357e9957"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Hardware timer APIs. </p>
<dl class="section attention"><dt>Attention</dt><dd>Hardware timer can not interrupt other ISRs. </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gace64c59d338a9d785bd5730029086553"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hw_timer_arm </td>
<td>(</td>
<td class="paramtype">uint32&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a trigger timer delay to enable this timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uint32</td><td>val : Timing<ul>
<li>In autoload mode, range : 50 ~ 0x7fffff</li>
<li>In non-autoload mode, range : 10 ~ 0x7fffff</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
</div>
</div>
<a class="anchor" id="ga09f8d1ed286cb02bfe47bc5f6c67b570"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hw_timer_init </td>
<td>(</td>
<td class="paramtype">uint8&#160;</td>
<td class="paramname"><em>req</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the hardware ISR timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uint8</td><td>req : 0, not autoload; 1, autoload mode.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
</div>
</div>
<a class="anchor" id="ga78c91a9ec46aa9fb5b9fae9d357e9957"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hw_timer_set_func </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>user_hw_timer_cb_set</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set timer callback function. </p>
<p>For enabled timer, timer callback has to be set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uint32</td><td>val : Timing<ul>
<li>In autoload mode, range : 50 ~ 0x7fffff</li>
<li>In non-autoload mode, range : 10 ~ 0x7fffff</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink