791 lines
41 KiB
HTML
791 lines
41 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SemiDrive SSDK Appication Program Interface: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/sdrv_btm.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>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">SemiDrive SSDK Appication Program Interface<span id="projectnumber"> PTG3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></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_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_ee023d43c33bfccc31aa50a48a76892b.html">include</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">sdrv_btm.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <types.h></code><br />
|
|
<code>#include <compiler.h></code><br />
|
|
<code>#include <<a class="el" href="sdrv__common_8h_source.html">sdrv_common.h</a>></code><br />
|
|
<code>#include "../source/btm/sdrv_btm_hw.h"</code><br />
|
|
</div>
|
|
<p><a href="sdrv__btm_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" 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="structsdrv__btm__cfg.html">sdrv_btm_cfg</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="structsdrv__btm.html">sdrv_btm</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="structsdrv__btm__controller__module.html">sdrv_btm_controller_module</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 id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ab4ab1d48af7273393cd0b39055ca2fcc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#ab4ab1d48af7273393cd0b39055ca2fcc">sdrv_btm_init</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, <a class="el" href="sdrv__btm_8h.html#ac9e8cc2497869d8aee5e05f0c8eafdc1">sdrv_btm_cfg_t</a> *cfg)</td></tr>
|
|
<tr class="separator:ab4ab1d48af7273393cd0b39055ca2fcc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb9dea794309db088e40d148331fac42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#adb9dea794309db088e40d148331fac42">sdrv_btm_deinit</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:adb9dea794309db088e40d148331fac42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa194b73407b687e50bc625d414e7fd05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#aa194b73407b687e50bc625d414e7fd05">sdrv_btm_start</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, <a class="el" href="sdrv__btm_8h.html#ab2f973da0ad94cc315a9b024efc2133d">btm_type_t</a> <a class="el" href="sdrv__btm_8h.html#a81e44f594ea221e36e8823483ef34f5a">btm_type</a>, <a class="el" href="sdrv__btm_8h.html#abc7e8479256169497da080429ddaea4a">btm_time_type_t</a> time_type, uint32_t time_out)</td></tr>
|
|
<tr class="separator:aa194b73407b687e50bc625d414e7fd05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55703be2b141056cc3aa1bba004c67ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a55703be2b141056cc3aa1bba004c67ef">sdrv_btm_stop</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a55703be2b141056cc3aa1bba004c67ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0df9273591054b2117d1df758921ec25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a0df9273591054b2117d1df758921ec25">sdrv_btm_set_callback</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, <a class="el" href="sdrv__btm_8h.html#a3d472317dd6948946f0b28e94b403dbb">btm_callback</a> callback, void *arg)</td></tr>
|
|
<tr class="separator:a0df9273591054b2117d1df758921ec25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a061064df1b606dd93a38ccf83ac422fc"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a061064df1b606dd93a38ccf83ac422fc">sdrv_btm_get_current_time</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a061064df1b606dd93a38ccf83ac422fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a676d578f940c72af9b62f060d6ab42dd"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a676d578f940c72af9b62f060d6ab42dd">sdrv_btm_get_current_time_ex</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, <a class="el" href="sdrv__btm_8h.html#abc7e8479256169497da080429ddaea4a">btm_time_type_t</a> time_type)</td></tr>
|
|
<tr class="separator:a676d578f940c72af9b62f060d6ab42dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6078e1edf5b6593b6d69aa702a3b3f03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a6078e1edf5b6593b6d69aa702a3b3f03">sdrv_btm_pause</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a6078e1edf5b6593b6d69aa702a3b3f03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6115c9c1f9f8b4c2408818b6913b8c6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a6115c9c1f9f8b4c2408818b6913b8c6e">sdrv_btm_continue</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a6115c9c1f9f8b4c2408818b6913b8c6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36b2f69c57acccca7ae54624b2f38d35"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a36b2f69c57acccca7ae54624b2f38d35">sdrv_btm_get_counter</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a36b2f69c57acccca7ae54624b2f38d35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab261132997250a30e7a84e1b639258da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#ab261132997250a30e7a84e1b639258da">sdrv_btm_set_overflow</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, uint32_t val)</td></tr>
|
|
<tr class="separator:ab261132997250a30e7a84e1b639258da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad20c7e070d288d4b1d75117a46b8935"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#aad20c7e070d288d4b1d75117a46b8935">sdrv_btm_force_reload</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:aad20c7e070d288d4b1d75117a46b8935"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81dd239713c77923729bf2661a821510"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a81dd239713c77923729bf2661a821510">sdrv_btm_is_overflowed</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a81dd239713c77923729bf2661a821510"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefbbe185d7415acada34303679eb9944"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#aefbbe185d7415acada34303679eb9944">sdrv_btm_clear_intr</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:aefbbe185d7415acada34303679eb9944"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37597bfae517cf36ee50373f4b497132"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__btm_8h.html#a37597bfae517cf36ee50373f4b497132">sdrv_btm_count_to_us</a> (<a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> *ctrl, uint32_t cnt)</td></tr>
|
|
<tr class="separator:a37597bfae517cf36ee50373f4b497132"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2022 Semidrive Semiconductor. All rights reserved.</dd></dl>
|
|
<h2><a class="anchor" id="autotoc_md4"></a>
|
|
Revision History:</h2>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a3d472317dd6948946f0b28e94b403dbb" name="a3d472317dd6948946f0b28e94b403dbb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d472317dd6948946f0b28e94b403dbb">◆ </a></span>btm_callback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* btm_callback) (void *arg)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab7c1e8def0d93aca6e3b152b31d5aac6" name="ab7c1e8def0d93aca6e3b152b31d5aac6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab7c1e8def0d93aca6e3b152b31d5aac6">◆ </a></span>btm_status_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef __BEGIN_CDECLS enum <a class="el" href="sdrv__btm_8h.html#a013655a844541693b2ef681da36026da">btm_status</a> <a class="el" href="sdrv__btm_8h.html#ab7c1e8def0d93aca6e3b152b31d5aac6">btm_status_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc7e8479256169497da080429ddaea4a" name="abc7e8479256169497da080429ddaea4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc7e8479256169497da080429ddaea4a">◆ </a></span>btm_time_type_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__btm_8h.html#a787d577cf4033a815fdf9d492e6099a2">btm_time_type</a> <a class="el" href="sdrv__btm_8h.html#abc7e8479256169497da080429ddaea4a">btm_time_type_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2f973da0ad94cc315a9b024efc2133d" name="ab2f973da0ad94cc315a9b024efc2133d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2f973da0ad94cc315a9b024efc2133d">◆ </a></span>btm_type_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="sdrv__btm_8h.html#a81e44f594ea221e36e8823483ef34f5a">btm_type</a> <a class="el" href="sdrv__btm_8h.html#ab2f973da0ad94cc315a9b024efc2133d">btm_type_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9e8cc2497869d8aee5e05f0c8eafdc1" name="ac9e8cc2497869d8aee5e05f0c8eafdc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9e8cc2497869d8aee5e05f0c8eafdc1">◆ </a></span>sdrv_btm_cfg_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__btm__cfg.html">sdrv_btm_cfg</a> <a class="el" href="sdrv__btm_8h.html#ac9e8cc2497869d8aee5e05f0c8eafdc1">sdrv_btm_cfg_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a542afcd61416d3e594edb204ce02e617" name="a542afcd61416d3e594edb204ce02e617"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a542afcd61416d3e594edb204ce02e617">◆ </a></span>sdrv_btm_controller_module_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__btm__controller__module.html">sdrv_btm_controller_module</a> <a class="el" href="sdrv__btm_8h.html#a542afcd61416d3e594edb204ce02e617">sdrv_btm_controller_module_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aedf2e9d921dae2d69bb4a6203e675d41" name="aedf2e9d921dae2d69bb4a6203e675d41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aedf2e9d921dae2d69bb4a6203e675d41">◆ </a></span>sdrv_btm_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__btm.html">sdrv_btm</a> <a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a013655a844541693b2ef681da36026da" name="a013655a844541693b2ef681da36026da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a013655a844541693b2ef681da36026da">◆ </a></span>btm_status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__btm_8h.html#a013655a844541693b2ef681da36026da">btm_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a013655a844541693b2ef681da36026daa4425dca0f0bd7240e913406a98cb2169" name="a013655a844541693b2ef681da36026daa4425dca0f0bd7240e913406a98cb2169"></a>BTM_STATUS_NULL </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a013655a844541693b2ef681da36026daa237a468cedfc58e9148d6f8be2d710c2" name="a013655a844541693b2ef681da36026daa237a468cedfc58e9148d6f8be2d710c2"></a>BTM_STATUS_IDLE </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a013655a844541693b2ef681da36026daa70d0098d56885068d2e6e790c1055683" name="a013655a844541693b2ef681da36026daa70d0098d56885068d2e6e790c1055683"></a>BTM_STATUS_BUSY </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a013655a844541693b2ef681da36026daa68d01cb5f8d2f5d374800a1d8b71e420" name="a013655a844541693b2ef681da36026daa68d01cb5f8d2f5d374800a1d8b71e420"></a>BTM_STATUS_ERR </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a787d577cf4033a815fdf9d492e6099a2" name="a787d577cf4033a815fdf9d492e6099a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a787d577cf4033a815fdf9d492e6099a2">◆ </a></span>btm_time_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__btm_8h.html#a787d577cf4033a815fdf9d492e6099a2">btm_time_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a787d577cf4033a815fdf9d492e6099a2a166afdff4f2359b1a66720ee02ea3409" name="a787d577cf4033a815fdf9d492e6099a2a166afdff4f2359b1a66720ee02ea3409"></a>BTM_TIME_MS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a787d577cf4033a815fdf9d492e6099a2a7a2ff5e61196fb496d9b6dc840566d23" name="a787d577cf4033a815fdf9d492e6099a2a7a2ff5e61196fb496d9b6dc840566d23"></a>BTM_TIME_US </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a787d577cf4033a815fdf9d492e6099a2a34d1d1c0cfb97865889301fb5d170985" name="a787d577cf4033a815fdf9d492e6099a2a34d1d1c0cfb97865889301fb5d170985"></a>BTM_TIME_NS </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81e44f594ea221e36e8823483ef34f5a" name="a81e44f594ea221e36e8823483ef34f5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81e44f594ea221e36e8823483ef34f5a">◆ </a></span>btm_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__btm_8h.html#a81e44f594ea221e36e8823483ef34f5a">btm_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a81e44f594ea221e36e8823483ef34f5aa200e72b54ef6447bf29f032911ce0f7e" name="a81e44f594ea221e36e8823483ef34f5aa200e72b54ef6447bf29f032911ce0f7e"></a>BTM_TYPE_ONESHOT </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a81e44f594ea221e36e8823483ef34f5aa9ed6c3c11d46da05b690e36f1b108c65" name="a81e44f594ea221e36e8823483ef34f5aa9ed6c3c11d46da05b690e36f1b108c65"></a>BTM_TYPE_PERIOD </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a81e44f594ea221e36e8823483ef34f5aa9229412a1742b17e04519a8aef5b22c9" name="a81e44f594ea221e36e8823483ef34f5aa9229412a1742b17e04519a8aef5b22c9"></a>BTM_TYPE_ERR </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aefbbe185d7415acada34303679eb9944" name="aefbbe185d7415acada34303679eb9944"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefbbe185d7415acada34303679eb9944">◆ </a></span>sdrv_btm_clear_intr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_clear_intr </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm clear interupt status </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6115c9c1f9f8b4c2408818b6913b8c6e" name="a6115c9c1f9f8b4c2408818b6913b8c6e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6115c9c1f9f8b4c2408818b6913b8c6e">◆ </a></span>sdrv_btm_continue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_continue </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm continue </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37597bfae517cf36ee50373f4b497132" name="a37597bfae517cf36ee50373f4b497132"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37597bfae517cf36ee50373f4b497132">◆ </a></span>sdrv_btm_count_to_us()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t sdrv_btm_count_to_us </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>cnt</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm convert count to time in us </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>btm count value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>time in microseconds. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb9dea794309db088e40d148331fac42" name="adb9dea794309db088e40d148331fac42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb9dea794309db088e40d148331fac42">◆ </a></span>sdrv_btm_deinit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm deinit </p>
|
|
<p >Deinitial btm module instance.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad20c7e070d288d4b1d75117a46b8935" name="aad20c7e070d288d4b1d75117a46b8935"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad20c7e070d288d4b1d75117a46b8935">◆ </a></span>sdrv_btm_force_reload()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_force_reload </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm force reset counter value </p>
|
|
<p >Btm force reset counter value to 0.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36b2f69c57acccca7ae54624b2f38d35" name="a36b2f69c57acccca7ae54624b2f38d35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36b2f69c57acccca7ae54624b2f38d35">◆ </a></span>sdrv_btm_get_counter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t sdrv_btm_get_counter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get btm counter value </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>btm counter value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a061064df1b606dd93a38ccf83ac422fc" name="a061064df1b606dd93a38ccf83ac422fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a061064df1b606dd93a38ccf83ac422fc">◆ </a></span>sdrv_btm_get_current_time()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t sdrv_btm_get_current_time </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get btm Elapsed time (us) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>btm Elapsed time (us) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a676d578f940c72af9b62f060d6ab42dd" name="a676d578f940c72af9b62f060d6ab42dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a676d578f940c72af9b62f060d6ab42dd">◆ </a></span>sdrv_btm_get_current_time_ex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t sdrv_btm_get_current_time_ex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#abc7e8479256169497da080429ddaea4a">btm_time_type_t</a> </td>
|
|
<td class="paramname"><em>time_type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get btm Elapsed time (extend) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">time_type</td><td>time type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>btm Elapsed time (us) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4ab1d48af7273393cd0b39055ca2fcc" name="ab4ab1d48af7273393cd0b39055ca2fcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4ab1d48af7273393cd0b39055ca2fcc">◆ </a></span>sdrv_btm_init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#ac9e8cc2497869d8aee5e05f0c8eafdc1">sdrv_btm_cfg_t</a> * </td>
|
|
<td class="paramname"><em>cfg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm init </p>
|
|
<p >Initial btm module instance.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>btm config </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81dd239713c77923729bf2661a821510" name="a81dd239713c77923729bf2661a821510"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81dd239713c77923729bf2661a821510">◆ </a></span>sdrv_btm_is_overflowed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdrv_btm_is_overflowed </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>is btm overflow. </p>
|
|
<p >Check btm overflow status.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true:overflow fail:not overflow </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6078e1edf5b6593b6d69aa702a3b3f03" name="a6078e1edf5b6593b6d69aa702a3b3f03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6078e1edf5b6593b6d69aa702a3b3f03">◆ </a></span>sdrv_btm_pause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_pause </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm pause </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0df9273591054b2117d1df758921ec25" name="a0df9273591054b2117d1df758921ec25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0df9273591054b2117d1df758921ec25">◆ </a></span>sdrv_btm_set_callback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_set_callback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#a3d472317dd6948946f0b28e94b403dbb">btm_callback</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>arg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm setup callback funciton </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>user callback function </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab261132997250a30e7a84e1b639258da" name="ab261132997250a30e7a84e1b639258da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab261132997250a30e7a84e1b639258da">◆ </a></span>sdrv_btm_set_overflow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_set_overflow </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set btm overflow value </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>btm overflow value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa194b73407b687e50bc625d414e7fd05" name="aa194b73407b687e50bc625d414e7fd05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa194b73407b687e50bc625d414e7fd05">◆ </a></span>sdrv_btm_start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_start </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#ab2f973da0ad94cc315a9b024efc2133d">btm_type_t</a> </td>
|
|
<td class="paramname"><em>btm_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#abc7e8479256169497da080429ddaea4a">btm_time_type_t</a> </td>
|
|
<td class="paramname"><em>time_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>time_out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm start </p>
|
|
<p >In one-short mode, btm will auto stop while reaches overflow value. In continuous mode, btm will reset to 0 and restart once reaches overflow value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">btm_type</td><td>timer type </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">time_type</td><td>timeout time unit </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">time_out</td><td>timeout </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55703be2b141056cc3aa1bba004c67ef" name="a55703be2b141056cc3aa1bba004c67ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55703be2b141056cc3aa1bba004c67ef">◆ </a></span>sdrv_btm_stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_btm_stop </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__btm_8h.html#aedf2e9d921dae2d69bb4a6203e675d41">sdrv_btm_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>btm stop </p>
|
|
<p >BTM stop to count.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>btm ctrl instance </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>succeed:0 fail:other </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|