861 lines
45 KiB
HTML
861 lines
45 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_i2c.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_i2c.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <types.h></code><br />
|
|
<code>#include <<a class="el" href="sdrv__common_8h_source.html">sdrv_common.h</a>></code><br />
|
|
</div>
|
|
<p><a href="sdrv__i2c_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__i2c__cfg.html">sdrv_i2c_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__i2cdrv__mctrl.html">sdrv_i2cdrv_mctrl</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__i2c.html">sdrv_i2c</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:a1d7a67c1a3b6b0444d3076c0da7c28a0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__i2c_8h.html#a1d7a67c1a3b6b0444d3076c0da7c28a0">sdrv_i2c_set_transmode</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, <a class="el" href="sdrv__i2c_8h.html#ac6ffa127b6a252e337bd64ec07f36dc9">sdrv_i2cdrv_tsmode_t</a> tsmode)</td></tr>
|
|
<tr class="separator:a1d7a67c1a3b6b0444d3076c0da7c28a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e3616ede370ed99e52ce6bef0185067"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__i2c_8h.html#a0e3616ede370ed99e52ce6bef0185067">sdrv_i2c_set_speedmode</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, <a class="el" href="sdrv__i2c_8h.html#ada3d5dd12df244e13b359788dc9c5e12">sdrv_i2cdrv_speed_t</a> speed)</td></tr>
|
|
<tr class="separator:a0e3616ede370ed99e52ce6bef0185067"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa69ae283f4dd75ddd01bae567c543cdb"><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__i2c_8h.html#aa69ae283f4dd75ddd01bae567c543cdb">sdrv_i2c_init_ctrl</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:aa69ae283f4dd75ddd01bae567c543cdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfb72fa7a2f5e8c4c6bcace1595d374c"><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__i2c_8h.html#acfb72fa7a2f5e8c4c6bcace1595d374c">sdrv_i2c_write</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, uint16_t addr, uint8_t *wbuf, uint16_t wlen, uint32_t timeout, bool need_stop)</td></tr>
|
|
<tr class="separator:acfb72fa7a2f5e8c4c6bcace1595d374c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a979d1e5a83783e278d29d4ecac13c5"><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__i2c_8h.html#a2a979d1e5a83783e278d29d4ecac13c5">sdrv_i2c_read</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, uint16_t addr, uint8_t *rbuf, uint16_t rlen, uint32_t timeout, bool need_stop)</td></tr>
|
|
<tr class="separator:a2a979d1e5a83783e278d29d4ecac13c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11188c471ea35c715fb32ade512b250b"><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__i2c_8h.html#a11188c471ea35c715fb32ade512b250b">sdrv_i2c_write_async</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, uint16_t addr, uint8_t *wbuf, uint16_t wlen, bool need_stop, <a class="el" href="sdrv__i2c_8h.html#af6f93c41ea6539cfc33972029213f010">sdrv_i2c_cb_t</a> cb, void *cb_param)</td></tr>
|
|
<tr class="separator:a11188c471ea35c715fb32ade512b250b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8753fb897da019267b3702508476dcca"><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__i2c_8h.html#a8753fb897da019267b3702508476dcca">sdrv_i2c_read_async</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, uint16_t addr, uint8_t *rbuf, uint16_t rlen, bool need_stop, <a class="el" href="sdrv__i2c_8h.html#af6f93c41ea6539cfc33972029213f010">sdrv_i2c_cb_t</a> cb, void *cb_param)</td></tr>
|
|
<tr class="separator:a8753fb897da019267b3702508476dcca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c77ac185e5cfb2f81c57f32e67d913d"><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__i2c_8h.html#a8c77ac185e5cfb2f81c57f32e67d913d">sdrv_i2c_get_trans_stat</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a8c77ac185e5cfb2f81c57f32e67d913d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6ad921fe07d0a817752731f34ea0938"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__i2c_8h.html#ad2b726fb2fc4bc75694ace5936f7b12a">sdrv_i2cdrv_bus_stat_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__i2c_8h.html#ab6ad921fe07d0a817752731f34ea0938">sdrv_i2c_get_bus_stat</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:ab6ad921fe07d0a817752731f34ea0938"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af288a4308df1479bfe71f71bbe301e0d"><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__i2c_8h.html#af288a4308df1479bfe71f71bbe301e0d">sdrv_i2c_set_bus_stat</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, <a class="el" href="sdrv__i2c_8h.html#ad2b726fb2fc4bc75694ace5936f7b12a">sdrv_i2cdrv_bus_stat_t</a> bus_stat)</td></tr>
|
|
<tr class="separator:af288a4308df1479bfe71f71bbe301e0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dbfbf0de8a6dd4b4daecb81fde0300e"><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__i2c_8h.html#a6dbfbf0de8a6dd4b4daecb81fde0300e">sdrv_i2c_lock_bus</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a6dbfbf0de8a6dd4b4daecb81fde0300e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5df688cbc421702c60ed64319eb70072"><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__i2c_8h.html#a5df688cbc421702c60ed64319eb70072">sdrv_i2c_unlock_bus</a> (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl)</td></tr>
|
|
<tr class="separator:a5df688cbc421702c60ed64319eb70072"><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>(c) 2022 Semidrive Semiconductor. @All rights reserved. </dd></dl>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="af6f93c41ea6539cfc33972029213f010" name="af6f93c41ea6539cfc33972029213f010"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6f93c41ea6539cfc33972029213f010">◆ </a></span>sdrv_i2c_cb_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* sdrv_i2c_cb_t) (<a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> *ctrl, void *param, <a class="el" href="sdrv__i2c_8h.html#a37266884ebb0003424058c2e34399536">sdrv_i2cdrv_trans_stat_t</a> stat)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a05b65283e5b70fb5fa6d3ea2b3721148" name="a05b65283e5b70fb5fa6d3ea2b3721148"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a05b65283e5b70fb5fa6d3ea2b3721148">◆ </a></span>sdrv_i2c_cfg_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__i2c__cfg.html">sdrv_i2c_cfg</a> <a class="el" href="sdrv__i2c_8h.html#a05b65283e5b70fb5fa6d3ea2b3721148">sdrv_i2c_cfg_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a922dddabb6a259852660e418b6f30689" name="a922dddabb6a259852660e418b6f30689"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a922dddabb6a259852660e418b6f30689">◆ </a></span>sdrv_i2c_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__i2c.html">sdrv_i2c</a> <a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f335de1e305f914811cfae7005a2f5f" name="a6f335de1e305f914811cfae7005a2f5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f335de1e305f914811cfae7005a2f5f">◆ </a></span>sdrv_i2cdrv_mctrl_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structsdrv__i2cdrv__mctrl.html">sdrv_i2cdrv_mctrl</a> <a class="el" href="sdrv__i2c_8h.html#a6f335de1e305f914811cfae7005a2f5f">sdrv_i2cdrv_mctrl_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37266884ebb0003424058c2e34399536" name="a37266884ebb0003424058c2e34399536"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37266884ebb0003424058c2e34399536">◆ </a></span>sdrv_i2cdrv_trans_stat_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="el" href="sdrv__i2c_8h.html#a37266884ebb0003424058c2e34399536">sdrv_i2cdrv_trans_stat_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a0ed680fdb405e7195d9f14032851eebb" name="a0ed680fdb405e7195d9f14032851eebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ed680fdb405e7195d9f14032851eebb">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>i2c controller supported errcode </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebba1eedb1a4c81525305b8551c0294e3c52" name="a0ed680fdb405e7195d9f14032851eebba1eedb1a4c81525305b8551c0294e3c52"></a>SDRV_I2CDRV_TRANS_OK </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebbaa6dda7b79b6478b04f7d9c94c8152681" name="a0ed680fdb405e7195d9f14032851eebbaa6dda7b79b6478b04f7d9c94c8152681"></a>SDRV_I2CDRV_TRANS_GO </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebba83706e12ad81afc260c45e6aaeb32742" name="a0ed680fdb405e7195d9f14032851eebba83706e12ad81afc260c45e6aaeb32742"></a>SDRV_I2CDRV_TRANS_NAK </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebba8b3857f1f102b7a585ad8a3ab1a5fb19" name="a0ed680fdb405e7195d9f14032851eebba8b3857f1f102b7a585ad8a3ab1a5fb19"></a>SDRV_I2CDRV_TRANS_ERR </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebbacfa06da5677ee8cecb0263d806ae9829" name="a0ed680fdb405e7195d9f14032851eebbacfa06da5677ee8cecb0263d806ae9829"></a>SDRV_I2CDRV_TRANS_ABORT </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a0ed680fdb405e7195d9f14032851eebba05e952b2cf9a112a8b0392b0edca492a" name="a0ed680fdb405e7195d9f14032851eebba05e952b2cf9a112a8b0392b0edca492a"></a>SDRV_I2CDRV_TRANS_TIMEOUT </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2b726fb2fc4bc75694ace5936f7b12a" name="ad2b726fb2fc4bc75694ace5936f7b12a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2b726fb2fc4bc75694ace5936f7b12a">◆ </a></span>sdrv_i2cdrv_bus_stat_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__i2c_8h.html#ad2b726fb2fc4bc75694ace5936f7b12a">sdrv_i2cdrv_bus_stat_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>i2c bus stat(only applicable for master mode) </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad2b726fb2fc4bc75694ace5936f7b12aafb58656bbbf0ca2b82872c5c592908a0" name="ad2b726fb2fc4bc75694ace5936f7b12aafb58656bbbf0ca2b82872c5c592908a0"></a>SDRV_I2CDRV_BUS_IDLE </td><td class="fielddoc"><p >i2c bus is idle </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ad2b726fb2fc4bc75694ace5936f7b12aa778845708e960e469783597e8c3992dd" name="ad2b726fb2fc4bc75694ace5936f7b12aa778845708e960e469783597e8c3992dd"></a>SDRV_I2CDRV_BUS_BUSY </td><td class="fielddoc"><p >i2c bus is busy </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae249f73c582dd668ad753e66ad7f6c4d" name="ae249f73c582dd668ad753e66ad7f6c4d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae249f73c582dd668ad753e66ad7f6c4d">◆ </a></span>sdrv_i2cdrv_opmode_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__i2c_8h.html#ae249f73c582dd668ad753e66ad7f6c4d">sdrv_i2cdrv_opmode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>i2c controller supported operation mode </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae249f73c582dd668ad753e66ad7f6c4da26ae9689604d6e39d4aba577e964b5bb" name="ae249f73c582dd668ad753e66ad7f6c4da26ae9689604d6e39d4aba577e964b5bb"></a>SDRV_I2CDRV_MASTER </td><td class="fielddoc"><p >i2c controller master mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae249f73c582dd668ad753e66ad7f6c4dade3b4f91f61016e15ffc4158a60472cb" name="ae249f73c582dd668ad753e66ad7f6c4dade3b4f91f61016e15ffc4158a60472cb"></a>SDRV_I2CDRV_SLAVE </td><td class="fielddoc"><p >i2c controller slave mode </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada3d5dd12df244e13b359788dc9c5e12" name="ada3d5dd12df244e13b359788dc9c5e12"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada3d5dd12df244e13b359788dc9c5e12">◆ </a></span>sdrv_i2cdrv_speed_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__i2c_8h.html#ada3d5dd12df244e13b359788dc9c5e12">sdrv_i2cdrv_speed_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>i2c controller supported speed mode </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ada3d5dd12df244e13b359788dc9c5e12a0d57cbfeddaf4121ba93e4db794ba970" name="ada3d5dd12df244e13b359788dc9c5e12a0d57cbfeddaf4121ba93e4db794ba970"></a>SDRV_I2CDRV_SSPEED </td><td class="fielddoc"><p >100kHz </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ada3d5dd12df244e13b359788dc9c5e12a8136c53fe6f975ab6acd4ea4abe14044" name="ada3d5dd12df244e13b359788dc9c5e12a8136c53fe6f975ab6acd4ea4abe14044"></a>SDRV_I2CDRV_FSPEED </td><td class="fielddoc"><p >400kHz </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ada3d5dd12df244e13b359788dc9c5e12ad70e6af02e02e56614c65f0229476651" name="ada3d5dd12df244e13b359788dc9c5e12ad70e6af02e02e56614c65f0229476651"></a>SDRV_I2CDRV_PSPEED </td><td class="fielddoc"><p >1MHz </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ada3d5dd12df244e13b359788dc9c5e12a8b1b383882e512ab41bfdda4c09ac28f" name="ada3d5dd12df244e13b359788dc9c5e12a8b1b383882e512ab41bfdda4c09ac28f"></a>SDRV_I2CDRV_HSPEED </td><td class="fielddoc"><p >3.4MHz </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ada3d5dd12df244e13b359788dc9c5e12ab262e64ffd801206ce4e61ff93a077ee" name="ada3d5dd12df244e13b359788dc9c5e12ab262e64ffd801206ce4e61ff93a077ee"></a>SDRV_I2CDRV_USPEED </td><td class="fielddoc"><p >5MHz </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6ffa127b6a252e337bd64ec07f36dc9" name="ac6ffa127b6a252e337bd64ec07f36dc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6ffa127b6a252e337bd64ec07f36dc9">◆ </a></span>sdrv_i2cdrv_tsmode_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="sdrv__i2c_8h.html#ac6ffa127b6a252e337bd64ec07f36dc9">sdrv_i2cdrv_tsmode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>i2c controller supported transfer mode (only applicable for master mode) </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac6ffa127b6a252e337bd64ec07f36dc9a478a31abbc27ed09e2d732ec89bcffe9" name="ac6ffa127b6a252e337bd64ec07f36dc9a478a31abbc27ed09e2d732ec89bcffe9"></a>SDRV_I2CDRV_POLL </td><td class="fielddoc"><p >polling mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ac6ffa127b6a252e337bd64ec07f36dc9a41d4258737eb3e71af706b8d01399073" name="ac6ffa127b6a252e337bd64ec07f36dc9a41d4258737eb3e71af706b8d01399073"></a>SDRV_I2CDRV_INTP </td><td class="fielddoc"><p >interrupt mode </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ab6ad921fe07d0a817752731f34ea0938" name="ab6ad921fe07d0a817752731f34ea0938"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6ad921fe07d0a817752731f34ea0938">◆ </a></span>sdrv_i2c_get_bus_stat()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__i2c_8h.html#ad2b726fb2fc4bc75694ace5936f7b12a">sdrv_i2cdrv_bus_stat_t</a> sdrv_i2c_get_bus_stat </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get bus stat(only applicable for master). @this api will abandon,please use sdrv_i2c_lock_bus/sdrv_i2c_unlock_bus instead. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_I2CDRV_BUS_IDLE/SDRV_I2CDRV_BUS_BUSY </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c77ac185e5cfb2f81c57f32e67d913d" name="a8c77ac185e5cfb2f81c57f32e67d913d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c77ac185e5cfb2f81c57f32e67d913d">◆ </a></span>sdrv_i2c_get_trans_stat()</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_i2c_get_trans_stat </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get transfer stat(only applicable for master). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_I2CDRV_TRANS_OK SDRV_I2CDRV_TRANS_GO SDRV_I2CDRV_TRANS_ERR SDRV_I2CDRV_TRANS_NAK SDRV_I2CDRV_TRANS_ABORT SDRV_I2CDRV_TRANS_TIMEOUT </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa69ae283f4dd75ddd01bae567c543cdb" name="aa69ae283f4dd75ddd01bae567c543cdb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa69ae283f4dd75ddd01bae567c543cdb">◆ </a></span>sdrv_i2c_init_ctrl()</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_i2c_init_ctrl </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Init the i2c controller. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dbfbf0de8a6dd4b4daecb81fde0300e" name="a6dbfbf0de8a6dd4b4daecb81fde0300e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dbfbf0de8a6dd4b4daecb81fde0300e">◆ </a></span>sdrv_i2c_lock_bus()</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_i2c_lock_bus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Lock bus stat(only applicable for master). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a979d1e5a83783e278d29d4ecac13c5" name="a2a979d1e5a83783e278d29d4ecac13c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a979d1e5a83783e278d29d4ecac13c5">◆ </a></span>sdrv_i2c_read()</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_i2c_read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>rbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>rlen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>need_stop</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read data from slave device use poll blocking format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>slave device 7bit addr not include LSB read/write bit </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">rbuf</td><td>point to data buf for receive </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rlen</td><td>data buf len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>timeout in milliseconds to wait (0 = wait forever) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">need_stop</td><td>whether send stop signal or hold sda after finish read</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8753fb897da019267b3702508476dcca" name="a8753fb897da019267b3702508476dcca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8753fb897da019267b3702508476dcca">◆ </a></span>sdrv_i2c_read_async()</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_i2c_read_async </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>rbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>rlen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>need_stop</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#af6f93c41ea6539cfc33972029213f010">sdrv_i2c_cb_t</a> </td>
|
|
<td class="paramname"><em>cb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>cb_param</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read data from slave device use interrupt non-blocking format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>slave device 7bit addr not include LSB read/write bit </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">rbuf</td><td>point to data buf for receive </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rlen</td><td>data buf len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">need_stop</td><td>whether send stop signal or hold sda after complete read </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>callback function pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cb_param</td><td>callback user parameter</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af288a4308df1479bfe71f71bbe301e0d" name="af288a4308df1479bfe71f71bbe301e0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af288a4308df1479bfe71f71bbe301e0d">◆ </a></span>sdrv_i2c_set_bus_stat()</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_i2c_set_bus_stat </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_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__i2c_8h.html#ad2b726fb2fc4bc75694ace5936f7b12a">sdrv_i2cdrv_bus_stat_t</a> </td>
|
|
<td class="paramname"><em>bus_stat</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set bus stat(only applicable for master). @this api will abandon,please use sdrv_i2c_lock_bus/sdrv_i2c_unlock_bus instead. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">bus_stat</td><td>bus stat to be set</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e3616ede370ed99e52ce6bef0185067" name="a0e3616ede370ed99e52ce6bef0185067"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e3616ede370ed99e52ce6bef0185067">◆ </a></span>sdrv_i2c_set_speedmode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_i2c_set_speedmode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_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__i2c_8h.html#ada3d5dd12df244e13b359788dc9c5e12">sdrv_i2cdrv_speed_t</a> </td>
|
|
<td class="paramname"><em>speed</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set i2c controller speed mode. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This API is deprecated. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>speed mode to be set</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d7a67c1a3b6b0444d3076c0da7c28a0" name="a1d7a67c1a3b6b0444d3076c0da7c28a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d7a67c1a3b6b0444d3076c0da7c28a0">◆ </a></span>sdrv_i2c_set_transmode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> sdrv_i2c_set_transmode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_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__i2c_8h.html#ac6ffa127b6a252e337bd64ec07f36dc9">sdrv_i2cdrv_tsmode_t</a> </td>
|
|
<td class="paramname"><em>tsmode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set i2c controller transfer mode. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This API is deprecated. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tsmode</td><td>transmode to be set</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5df688cbc421702c60ed64319eb70072" name="a5df688cbc421702c60ed64319eb70072"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5df688cbc421702c60ed64319eb70072">◆ </a></span>sdrv_i2c_unlock_bus()</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_i2c_unlock_bus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unlock bus stat(only applicable for master). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acfb72fa7a2f5e8c4c6bcace1595d374c" name="acfb72fa7a2f5e8c4c6bcace1595d374c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acfb72fa7a2f5e8c4c6bcace1595d374c">◆ </a></span>sdrv_i2c_write()</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_i2c_write </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>wbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>wlen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>need_stop</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write data to slave device use poll blocking format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>slave device 7bit addr not include LSB read/write bit </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">wbuf</td><td>point to data buf for send </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">wlen</td><td>data buf len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>timeout in milliseconds to wait (0 = wait forever) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">need_stop</td><td>whether send stop signal or hold sda after finish write</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11188c471ea35c715fb32ade512b250b" name="a11188c471ea35c715fb32ade512b250b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11188c471ea35c715fb32ade512b250b">◆ </a></span>sdrv_i2c_write_async()</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_i2c_write_async </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#a922dddabb6a259852660e418b6f30689">sdrv_i2c_t</a> * </td>
|
|
<td class="paramname"><em>ctrl</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>wbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>wlen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>need_stop</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__i2c_8h.html#af6f93c41ea6539cfc33972029213f010">sdrv_i2c_cb_t</a> </td>
|
|
<td class="paramname"><em>cb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>cb_param</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write data to slave device use interrupt non-blocking format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctrl</td><td>i2c controller instance pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>slave device 7bit addr not include LSB read/write bit </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">wbuf</td><td>point to data buf for send </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">wlen</td><td>data buf len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">need_stop</td><td>whether send stop signal or hold sda after finish write </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>callback function pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cb_param</td><td>callback user parameter</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK/SDRV_STATUS_FAIL </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>
|