Skip to content

Commit 1e5dbf9

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent 2e14a9c commit 1e5dbf9

File tree

270 files changed

+12937
-5842
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

270 files changed

+12937
-5842
lines changed

‎docs/html/_a_p_i___i2_c_8h.html

+304
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,304 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>arduino-audio-driver: src/Platforms/API_I2C.h File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">arduino-audio-driver
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
<div id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_03d7d17aa0ae13f975c2241883b8df3e.html">Platforms</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="summary">
69+
<a href="#nested-classes">Classes</a> &#124;
70+
<a href="#typedef-members">Typedefs</a> &#124;
71+
<a href="#func-members">Functions</a> </div>
72+
<div class="headertitle">
73+
<div class="title">API_I2C.h File Reference</div> </div>
74+
</div><!--header-->
75+
<div class="contents">
76+
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
77+
<code>#include &quot;<a class="el" href="_driver_common_8h_source.html">DriverCommon.h</a>&quot;</code><br />
78+
</div>
79+
<p><a href="_a_p_i___i2_c_8h_source.html">Go to the source code of this file.</a></p>
80+
<table class="memberdecls">
81+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
82+
Classes</h2></td></tr>
83+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_i2_c_config.html">I2CConfig</a></td></tr>
84+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
85+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_two_wire.html">TwoWire</a></td></tr>
86+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
87+
</table><table class="memberdecls">
88+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
89+
Typedefs</h2></td></tr>
90+
<tr class="memitem:abdf74e3c0806040d87d21f1e1534c4a6"><td class="memItemLeft" align="right" valign="top">typedef int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p_i___i2_c_8h.html#abdf74e3c0806040d87d21f1e1534c4a6">GpioPin</a></td></tr>
91+
<tr class="separator:abdf74e3c0806040d87d21f1e1534c4a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
92+
</table><table class="memberdecls">
93+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
94+
Functions</h2></td></tr>
95+
<tr class="memitem:a13e072fadce8c4c23c4cdd7ec38b2a6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p_i___i2_c_8h.html#a13e072fadce8c4c23c4cdd7ec38b2a6d">i2c_bus_create</a> (struct <a class="el" href="struct_i2_c_config.html">I2CConfig</a> *pin)</td></tr>
96+
<tr class="separator:a13e072fadce8c4c23c4cdd7ec38b2a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
97+
<tr class="memitem:ac71925ddde3beef2f78d27fadfdbf72f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p_i___i2_c_8h.html#ac71925ddde3beef2f78d27fadfdbf72f">i2c_bus_delete</a> (<a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus)</td></tr>
98+
<tr class="separator:ac71925ddde3beef2f78d27fadfdbf72f"><td class="memSeparator" colspan="2">&#160;</td></tr>
99+
<tr class="memitem:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p_i___i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a> (<a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr, uint8_t *reg, int reglen, uint8_t *outdata, int datalen)</td></tr>
100+
<tr class="memdesc:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bytes to I2C bus. <a href="_a_p_i___i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">More...</a><br /></td></tr>
101+
<tr class="separator:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
102+
<tr class="memitem:a33733ea17940e828fc5aa7ed9aa3034a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p_i___i2_c_8h.html#a33733ea17940e828fc5aa7ed9aa3034a">i2c_bus_write_bytes</a> (<a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr, uint8_t *reg, int regLen, uint8_t *data, int datalen)</td></tr>
103+
<tr class="memdesc:a33733ea17940e828fc5aa7ed9aa3034a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write bytes to I2C bus. <a href="_a_p_i___i2_c_8h.html#a33733ea17940e828fc5aa7ed9aa3034a">More...</a><br /></td></tr>
104+
<tr class="separator:a33733ea17940e828fc5aa7ed9aa3034a"><td class="memSeparator" colspan="2">&#160;</td></tr>
105+
</table>
106+
<h2 class="groupheader">Typedef Documentation</h2>
107+
<a id="abdf74e3c0806040d87d21f1e1534c4a6"></a>
108+
<h2 class="memtitle"><span class="permalink"><a href="#abdf74e3c0806040d87d21f1e1534c4a6">&#9670;&nbsp;</a></span>GpioPin</h2>
109+
110+
<div class="memitem">
111+
<div class="memproto">
112+
<table class="memname">
113+
<tr>
114+
<td class="memname">typedef int16_t <a class="el" href="_a_p_i___i2_c_8h.html#abdf74e3c0806040d87d21f1e1534c4a6">GpioPin</a></td>
115+
</tr>
116+
</table>
117+
</div><div class="memdoc">
118+
119+
</div>
120+
</div>
121+
<h2 class="groupheader">Function Documentation</h2>
122+
<a id="a13e072fadce8c4c23c4cdd7ec38b2a6d"></a>
123+
<h2 class="memtitle"><span class="permalink"><a href="#a13e072fadce8c4c23c4cdd7ec38b2a6d">&#9670;&nbsp;</a></span>i2c_bus_create()</h2>
124+
125+
<div class="memitem">
126+
<div class="memproto">
127+
<table class="memname">
128+
<tr>
129+
<td class="memname"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> i2c_bus_create </td>
130+
<td>(</td>
131+
<td class="paramtype">struct <a class="el" href="struct_i2_c_config.html">I2CConfig</a> *&#160;</td>
132+
<td class="paramname"><em>pin</em></td><td>)</td>
133+
<td></td>
134+
</tr>
135+
</table>
136+
</div><div class="memdoc">
137+
138+
</div>
139+
</div>
140+
<a id="ac71925ddde3beef2f78d27fadfdbf72f"></a>
141+
<h2 class="memtitle"><span class="permalink"><a href="#ac71925ddde3beef2f78d27fadfdbf72f">&#9670;&nbsp;</a></span>i2c_bus_delete()</h2>
142+
143+
<div class="memitem">
144+
<div class="memproto">
145+
<table class="memname">
146+
<tr>
147+
<td class="memname">void i2c_bus_delete </td>
148+
<td>(</td>
149+
<td class="paramtype"><a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a>&#160;</td>
150+
<td class="paramname"><em>bus</em></td><td>)</td>
151+
<td></td>
152+
</tr>
153+
</table>
154+
</div><div class="memdoc">
155+
156+
</div>
157+
</div>
158+
<a id="ac55a996bcf945a17aa3ddfb1525e1e8e"></a>
159+
<h2 class="memtitle"><span class="permalink"><a href="#ac55a996bcf945a17aa3ddfb1525e1e8e">&#9670;&nbsp;</a></span>i2c_bus_read_bytes()</h2>
160+
161+
<div class="memitem">
162+
<div class="memproto">
163+
<table class="memname">
164+
<tr>
165+
<td class="memname"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> i2c_bus_read_bytes </td>
166+
<td>(</td>
167+
<td class="paramtype"><a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a>&#160;</td>
168+
<td class="paramname"><em>bus</em>, </td>
169+
</tr>
170+
<tr>
171+
<td class="paramkey"></td>
172+
<td></td>
173+
<td class="paramtype">int&#160;</td>
174+
<td class="paramname"><em>addr</em>, </td>
175+
</tr>
176+
<tr>
177+
<td class="paramkey"></td>
178+
<td></td>
179+
<td class="paramtype">uint8_t *&#160;</td>
180+
<td class="paramname"><em>reg</em>, </td>
181+
</tr>
182+
<tr>
183+
<td class="paramkey"></td>
184+
<td></td>
185+
<td class="paramtype">int&#160;</td>
186+
<td class="paramname"><em>reglen</em>, </td>
187+
</tr>
188+
<tr>
189+
<td class="paramkey"></td>
190+
<td></td>
191+
<td class="paramtype">uint8_t *&#160;</td>
192+
<td class="paramname"><em>outdata</em>, </td>
193+
</tr>
194+
<tr>
195+
<td class="paramkey"></td>
196+
<td></td>
197+
<td class="paramtype">int&#160;</td>
198+
<td class="paramname"><em>datalen</em>&#160;</td>
199+
</tr>
200+
<tr>
201+
<td></td>
202+
<td>)</td>
203+
<td></td><td></td>
204+
</tr>
205+
</table>
206+
</div><div class="memdoc">
207+
208+
<p>Read bytes to I2C bus. </p>
209+
<dl class="params"><dt>Parameters</dt><dd>
210+
<table class="params">
211+
<tr><td class="paramname">bus</td><td>I2C bus handle </td></tr>
212+
<tr><td class="paramname">addr</td><td>The address of the device </td></tr>
213+
<tr><td class="paramname">reg</td><td>The register of the device </td></tr>
214+
<tr><td class="paramname">regLen</td><td>The length of register </td></tr>
215+
<tr><td class="paramname">outdata</td><td>The outdata pointer </td></tr>
216+
<tr><td class="paramname">datalen</td><td>The length of outdata</td></tr>
217+
</table>
218+
</dd>
219+
</dl>
220+
<dl class="section return"><dt>Returns</dt><dd><ul>
221+
<li>NULL Fail</li>
222+
<li>Others Success </li>
223+
</ul>
224+
</dd></dl>
225+
226+
</div>
227+
</div>
228+
<a id="a33733ea17940e828fc5aa7ed9aa3034a"></a>
229+
<h2 class="memtitle"><span class="permalink"><a href="#a33733ea17940e828fc5aa7ed9aa3034a">&#9670;&nbsp;</a></span>i2c_bus_write_bytes()</h2>
230+
231+
<div class="memitem">
232+
<div class="memproto">
233+
<table class="memname">
234+
<tr>
235+
<td class="memname"><a class="el" href="_driver_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> i2c_bus_write_bytes </td>
236+
<td>(</td>
237+
<td class="paramtype"><a class="el" href="_driver_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a>&#160;</td>
238+
<td class="paramname"><em>bus</em>, </td>
239+
</tr>
240+
<tr>
241+
<td class="paramkey"></td>
242+
<td></td>
243+
<td class="paramtype">int&#160;</td>
244+
<td class="paramname"><em>addr</em>, </td>
245+
</tr>
246+
<tr>
247+
<td class="paramkey"></td>
248+
<td></td>
249+
<td class="paramtype">uint8_t *&#160;</td>
250+
<td class="paramname"><em>reg</em>, </td>
251+
</tr>
252+
<tr>
253+
<td class="paramkey"></td>
254+
<td></td>
255+
<td class="paramtype">int&#160;</td>
256+
<td class="paramname"><em>regLen</em>, </td>
257+
</tr>
258+
<tr>
259+
<td class="paramkey"></td>
260+
<td></td>
261+
<td class="paramtype">uint8_t *&#160;</td>
262+
<td class="paramname"><em>data</em>, </td>
263+
</tr>
264+
<tr>
265+
<td class="paramkey"></td>
266+
<td></td>
267+
<td class="paramtype">int&#160;</td>
268+
<td class="paramname"><em>datalen</em>&#160;</td>
269+
</tr>
270+
<tr>
271+
<td></td>
272+
<td>)</td>
273+
<td></td><td></td>
274+
</tr>
275+
</table>
276+
</div><div class="memdoc">
277+
278+
<p>Write bytes to I2C bus. </p>
279+
<dl class="params"><dt>Parameters</dt><dd>
280+
<table class="params">
281+
<tr><td class="paramname">bus</td><td>I2C bus handle </td></tr>
282+
<tr><td class="paramname">addr</td><td>The address of the device </td></tr>
283+
<tr><td class="paramname">reg</td><td>The register of the device </td></tr>
284+
<tr><td class="paramname">regLen</td><td>The length of register </td></tr>
285+
<tr><td class="paramname">data</td><td>The data pointer </td></tr>
286+
<tr><td class="paramname">datalen</td><td>The length of data</td></tr>
287+
</table>
288+
</dd>
289+
</dl>
290+
<dl class="section return"><dt>Returns</dt><dd><ul>
291+
<li>NULL Fail</li>
292+
<li>Others Success </li>
293+
</ul>
294+
</dd></dl>
295+
296+
</div>
297+
</div>
298+
</div><!-- contents -->
299+
<!-- start footer part -->
300+
<hr class="footer"/><address class="footer"><small>
301+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
302+
</small></address>
303+
</body>
304+
</html>

0 commit comments

Comments
 (0)