doxygen

Author: pschatzmann

docs/html/_audio_board_8h_source.html

@@ -135,7 +135,7 @@
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver API for the wm8994 codec chip.  <a href="classaudio__driver_1_1_audio_driver_w_m8994_class.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S configuration and defition of input and output with default values.  <a href="classaudio__driver_1_1_codec_config.html#details">More...</a><br /></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S configuration and definition of input and output with default values.  <a href="classaudio__driver_1_1_codec_config.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_no_driver_class.html">NoDriverClass</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dummy Driver which does nothing.  <a href="classaudio__driver_1_1_no_driver_class.html#details">More...</a><br /></td></tr>

docs/html/_driver_8h.html

@@ -78,6 +78,9 @@
 </div><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
+<tr class="memitem:af875a59327f98cb9ae843ede8587fef3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_i2_c_8cpp.html#af875a59327f98cb9ae843ede8587fef3">i2c_bus_check</a> (<a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr)</td></tr>
+<tr class="memdesc:af875a59327f98cb9ae843ede8587fef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests ACK from I2C device.  <a href="_i2_c_8cpp.html#af875a59327f98cb9ae843ede8587fef3">More...</a><br /></td></tr>
+<tr class="separator:af875a59327f98cb9ae843ede8587fef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_i2_c_8cpp.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a> (<a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr, uint8_t *reg, int reglen, uint8_t *outdata, int datalen)</td></tr>
 <tr class="memdesc:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is used.  <a href="_i2_c_8cpp.html#ac55a996bcf945a17aa3ddfb1525e1e8e">More...</a><br /></td></tr>
 <tr class="separator:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -86,6 +89,48 @@
 <tr class="separator:a071b982589bd609053db3ab22cfd4f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function Documentation</h2>
+<a id="af875a59327f98cb9ae843ede8587fef3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af875a59327f98cb9ae843ede8587fef3">&#9670;&nbsp;</a></span>i2c_bus_check()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> i2c_bus_check </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a>&#160;</td>
+          <td class="paramname"><em>bus</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>addr</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Requests ACK from I2C device. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">bus</td><td>I2C bus handle </td></tr>
+    <tr><td class="paramname">addr</td><td>The address of the device</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><ul>
+<li>NULL Fail</li>
+<li>Others Success </li>
+</ul>
+</dd></dl>
+
+</div>
+</div>
 <a id="ac55a996bcf945a17aa3ddfb1525e1e8e"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac55a996bcf945a17aa3ddfb1525e1e8e">&#9670;&nbsp;</a></span>i2c_bus_read_bytes()</h2>
 

docs/html/_driver_8h_source.html

@@ -78,6 +78,9 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
+<tr class="memitem:af875a59327f98cb9ae843ede8587fef3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_i2_c_8h.html#af875a59327f98cb9ae843ede8587fef3">i2c_bus_check</a> (<a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr)</td></tr>
+<tr class="memdesc:af875a59327f98cb9ae843ede8587fef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests ACK from I2C device.  <a href="_i2_c_8h.html#af875a59327f98cb9ae843ede8587fef3">More...</a><br /></td></tr>
+<tr class="separator:af875a59327f98cb9ae843ede8587fef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a> (<a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, int addr, uint8_t *reg, int reglen, uint8_t *outdata, int datalen)</td></tr>
 <tr class="memdesc:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bytes to I2C bus.  <a href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">More...</a><br /></td></tr>
 <tr class="separator:ac55a996bcf945a17aa3ddfb1525e1e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -86,6 +89,48 @@
 <tr class="separator:a33733ea17940e828fc5aa7ed9aa3034a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function Documentation</h2>
+<a id="af875a59327f98cb9ae843ede8587fef3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af875a59327f98cb9ae843ede8587fef3">&#9670;&nbsp;</a></span>i2c_bus_check()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> i2c_bus_check </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a>&#160;</td>
+          <td class="paramname"><em>bus</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>addr</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Requests ACK from I2C device. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">bus</td><td>I2C bus handle </td></tr>
+    <tr><td class="paramname">addr</td><td>The address of the device</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><ul>
+<li>NULL Fail</li>
+<li>Others Success </li>
+</ul>
+</dd></dl>
+
+</div>
+</div>
 <a id="ac55a996bcf945a17aa3ddfb1525e1e8e"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac55a996bcf945a17aa3ddfb1525e1e8e">&#9670;&nbsp;</a></span>i2c_bus_read_bytes()</h2>
 

docs/html/_driver_pins_8h_source.html

@@ -81,19 +81,22 @@
 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160; </div>
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<a class="code" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> <a class="code" href="_i2_c_8h.html#a33733ea17940e828fc5aa7ed9aa3034a">i2c_bus_write_bytes</a>(<a class="code" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, <span class="keywordtype">int</span> addr, uint8_t *reg, <span class="keywordtype">int</span> regLen, uint8_t *data, <span class="keywordtype">int</span> datalen);</div>
 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
-<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
-<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<a class="code" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> <a class="code" href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a>(<a class="code" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, <span class="keywordtype">int</span> addr, uint8_t *reg, <span class="keywordtype">int</span> reglen, uint8_t *outdata, <span class="keywordtype">int</span> datalen);</div>
-<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; </div>
-<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
-<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
-<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;}</div>
-<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
+<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<a class="code" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> <a class="code" href="_i2_c_8h.html#af875a59327f98cb9ae843ede8587fef3">i2c_bus_check</a>(<a class="code" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, <span class="keywordtype">int</span> addr);</div>
+<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
+<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
+<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<a class="code" href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a> <a class="code" href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a>(<a class="code" href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a> bus, <span class="keywordtype">int</span> addr, uint8_t *reg, <span class="keywordtype">int</span> reglen, uint8_t *outdata, <span class="keywordtype">int</span> datalen);</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160; </div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;}</div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160; </div>
 <div class="ttc" id="a_common_8h_html"><div class="ttname"><a href="_common_8h.html">Common.h</a></div></div>
 <div class="ttc" id="a_common_8h_html_a7031876dbed79a4a0cf1a5f82970275c"><div class="ttname"><a href="_common_8h.html#a7031876dbed79a4a0cf1a5f82970275c">i2c_bus_handle_t</a></div><div class="ttdeci">void * i2c_bus_handle_t</div><div class="ttdef"><b>Definition:</b> Common.h:40</div></div>
 <div class="ttc" id="a_common_8h_html_a9ad6b2dc3cbff040775e79656fe8e1a3"><div class="ttname"><a href="_common_8h.html#a9ad6b2dc3cbff040775e79656fe8e1a3">error_t</a></div><div class="ttdeci">int error_t</div><div class="ttdef"><b>Definition:</b> Common.h:39</div></div>
 <div class="ttc" id="a_i2_c_8h_html_a33733ea17940e828fc5aa7ed9aa3034a"><div class="ttname"><a href="_i2_c_8h.html#a33733ea17940e828fc5aa7ed9aa3034a">i2c_bus_write_bytes</a></div><div class="ttdeci">error_t i2c_bus_write_bytes(i2c_bus_handle_t bus, int addr, uint8_t *reg, int regLen, uint8_t *data, int datalen)</div><div class="ttdoc">Write bytes to I2C bus.</div><div class="ttdef"><b>Definition:</b> I2C.cpp:7</div></div>
-<div class="ttc" id="a_i2_c_8h_html_ac55a996bcf945a17aa3ddfb1525e1e8e"><div class="ttname"><a href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a></div><div class="ttdeci">error_t i2c_bus_read_bytes(i2c_bus_handle_t bus, int addr, uint8_t *reg, int reglen, uint8_t *outdata, int datalen)</div><div class="ttdoc">Read bytes to I2C bus.</div><div class="ttdef"><b>Definition:</b> I2C.cpp:34</div></div>
+<div class="ttc" id="a_i2_c_8h_html_ac55a996bcf945a17aa3ddfb1525e1e8e"><div class="ttname"><a href="_i2_c_8h.html#ac55a996bcf945a17aa3ddfb1525e1e8e">i2c_bus_read_bytes</a></div><div class="ttdeci">error_t i2c_bus_read_bytes(i2c_bus_handle_t bus, int addr, uint8_t *reg, int reglen, uint8_t *outdata, int datalen)</div><div class="ttdoc">Read bytes to I2C bus.</div><div class="ttdef"><b>Definition:</b> I2C.cpp:49</div></div>
+<div class="ttc" id="a_i2_c_8h_html_af875a59327f98cb9ae843ede8587fef3"><div class="ttname"><a href="_i2_c_8h.html#af875a59327f98cb9ae843ede8587fef3">i2c_bus_check</a></div><div class="ttdeci">error_t i2c_bus_check(i2c_bus_handle_t bus, int addr)</div><div class="ttdoc">Requests ACK from I2C device.</div><div class="ttdef"><b>Definition:</b> I2C.cpp:33</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/_i2_c_8cpp.html

@@ -83,7 +83,7 @@
 <tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_audio_driver_t_a_s5805_m_class.html" target="_self">AudioDriverTAS5805MClass</a></td><td class="desc">Driver API for TAS5805M codec chip </td></tr>
 <tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_audio_driver_w_m8960_class.html" target="_self">AudioDriverWM8960Class</a></td><td class="desc">Driver API for WM8990 codec chip </td></tr>
 <tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_audio_driver_w_m8994_class.html" target="_self">AudioDriverWM8994Class</a></td><td class="desc">Driver API for the wm8994 codec chip </td></tr>
-<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_codec_config.html" target="_self">CodecConfig</a></td><td class="desc">I2S configuration and defition of input and output with default values </td></tr>
+<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_codec_config.html" target="_self">CodecConfig</a></td><td class="desc">I2S configuration and definition of input and output with default values </td></tr>
 <tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_driver_pins.html" target="_self">DriverPins</a></td><td class="desc">All pins for i2s, spi, i2c and other pins </td></tr>
 <tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_no_driver_class.html" target="_self">NoDriverClass</a></td><td class="desc">Dummy Driver which does nothing </td></tr>
 <tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__driver_1_1_optional.html" target="_self">Optional</a></td><td class="desc">A simple optonal implementation </td></tr>