hoo2
/
utl
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Micro template library A library for building device drivers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 Commits
3 Branches
5.6 MiB
 
 
 
 
Tree: bebb193278
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bebb193278'
${ noResults }
utl/doc/html/classutl_1_1i2c__i.html

854 lines
42 KiB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>uTL: utl::i2c_i&lt; impl_t &gt; Class Template 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="navtree.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="resize.js"></script>

  14. <script type="text/javascript" src="navtreedata.js"></script>

  15. <script type="text/javascript" src="navtree.js"></script>

  16. <script type="text/javascript">

  17. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  18.   $(document).ready(initResizable);

  19. /* @license-end */</script>

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  21. <script type="text/javascript" src="search/searchdata.js"></script>

  22. <script type="text/javascript" src="search/search.js"></script>

  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  24. </head>

  25. <body>

  26. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  27. <div id="titlearea">

  28. <table cellspacing="0" cellpadding="0">

  29.  <tbody>

  30.  <tr style="height: 56px;">

  31.   <td id="projectalign" style="padding-left: 0.5em;">

  32.    <div id="projectname">uTL

  33.    </div>

  34.    <div id="projectbrief">micro Template library</div>

  35.   </td>

  36.  </tr>

  37.  </tbody>

  38. </table>

  39. </div>

  40. <!-- end header part -->

  41. <!-- Generated by Doxygen 1.8.14 -->

  42. <script type="text/javascript">

  43. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  44. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  45. /* @license-end */

  46. </script>

  47. <script type="text/javascript" src="menudata.js"></script>

  48. <script type="text/javascript" src="menu.js"></script>

  49. <script type="text/javascript">

  50. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  51. $(function() {

  52.   initMenu('',true,false,'search.php','Search');

  53.   $(document).ready(function() { init_search(); });

  54. });

  55. /* @license-end */</script>

  56. <div id="main-nav"></div>

  57. </div><!-- top -->

  58. <div id="side-nav" class="ui-resizable side-nav-resizable">

  59.   <div id="nav-tree">

  60.     <div id="nav-tree-contents">

  61.       <div id="nav-sync" class="sync"></div>

  62.     </div>

  63.   </div>

  64.   <div id="splitbar" style="-moz-user-select:none;" 

  65.        class="ui-resizable-handle">

  66.   </div>

  67. </div>

  68. <script type="text/javascript">

  69. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  70. $(document).ready(function(){initNavTree('classutl_1_1i2c__i.html','');});

  71. /* @license-end */

  72. </script>

  73. <div id="doc-content">

  74. <!-- window showing the filter options -->

  75. <div id="MSearchSelectWindow"

  76.      onmouseover="return searchBox.OnSearchSelectShow()"

  77.      onmouseout="return searchBox.OnSearchSelectHide()"

  78.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  79. </div>

  80. 

  81. <!-- iframe showing the search results (closed by default) -->

  82. <div id="MSearchResultsWindow">

  83. <iframe src="javascript:void(0)" frameborder="0" 

  84.         name="MSearchResults" id="MSearchResults">

  85. </iframe>

  86. </div>

  87. 

  88. <div class="header">

  89.   <div class="summary">

  90. <a href="#pub-types">Public Types</a> &#124;

  91. <a href="#pri-methods">Private Member Functions</a> &#124;

  92. <a href="classutl_1_1i2c__i-members.html">List of all members</a>  </div>

  93.   <div class="headertitle">

  94. <div class="title">utl::i2c_i&lt; impl_t &gt; Class Template Reference</div>  </div>

  95. </div><!--header-->

  96. <div class="contents">

  97. 

  98. <p>Abstract base class for i2c bus.  

  99.  <a href="classutl_1_1i2c__i.html#details">More...</a></p>

  100. 

  101. <p><code>#include &lt;<a class="el" href="i2c_8h_source.html">i2c.h</a>&gt;</code></p>

  102. <table class="memberdecls">

  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>

  104. Public Types</h2></td></tr>

  105. <tr class="memitem:a7e2dde443c6c9bde4a2293beb22950c5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> { <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5ae409eb2ba6eb6801f52763ae370c350e">Sequence::BYTE</a> =0, 

  106. <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5">Sequence::ACK</a>, 

  107. <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a>

  108.  }</td></tr>

  109. <tr class="memdesc:a7e2dde443c6c9bde4a2293beb22950c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2C transmit/receive sequence.  <a href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">More...</a><br /></td></tr>

  110. <tr class="separator:a7e2dde443c6c9bde4a2293beb22950c5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:aa9267a8602702b78f188e0cf61b68a55"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> = <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a>&lt; impl_t &gt;</td></tr>

  112. <tr class="separator:aa9267a8602702b78f188e0cf61b68a55"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. </table><table class="memberdecls">

  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  115. Public Member Functions</h2></td></tr>

  116. <tr><td colspan="2"><div class="groupHeader">Get/Set functions</div></td></tr>

  117. <tr class="memitem:aac5fed816701cc4543acd717ec804ac0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aac5fed816701cc4543acd717ec804ac0">clock</a> () const</td></tr>

  118. <tr class="separator:aac5fed816701cc4543acd717ec804ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <tr class="memitem:ae4c59938aeeb1f0726195d425a4c0083"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#ae4c59938aeeb1f0726195d425a4c0083">clock</a> (uint32_t f)</td></tr>

  120. <tr class="memdesc:ae4c59938aeeb1f0726195d425a4c0083"><td class="mdescLeft">&#160;</td><td class="mdescRight">set clock frequency of the bus  <a href="#ae4c59938aeeb1f0726195d425a4c0083">More...</a><br /></td></tr>

  121. <tr class="separator:ae4c59938aeeb1f0726195d425a4c0083"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr><td colspan="2"><div class="groupHeader">User functions</div></td></tr>

  123. <tr class="memitem:a3591683e5fbf17b582f6ac1f79af871d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a3591683e5fbf17b582f6ac1f79af871d">start</a> ()</td></tr>

  124. <tr class="memdesc:a3591683e5fbf17b582f6ac1f79af871d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send start functionality.  <a href="#a3591683e5fbf17b582f6ac1f79af871d">More...</a><br /></td></tr>

  125. <tr class="separator:a3591683e5fbf17b582f6ac1f79af871d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <tr class="memitem:a1310b52ac908b8c37059fb253cc3f56e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a1310b52ac908b8c37059fb253cc3f56e">stop</a> ()</td></tr>

  127. <tr class="memdesc:a1310b52ac908b8c37059fb253cc3f56e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send stop functionality.  <a href="#a1310b52ac908b8c37059fb253cc3f56e">More...</a><br /></td></tr>

  128. <tr class="separator:a1310b52ac908b8c37059fb253cc3f56e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  129. <tr class="memitem:ab2f6a579096b4872f5dfd1530e200eda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#ab2f6a579096b4872f5dfd1530e200eda">rx_data</a> (bool ack, <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> seq=<a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a>)</td></tr>

  130. <tr class="memdesc:ab2f6a579096b4872f5dfd1530e200eda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a byte from the i2c bus.  <a href="#ab2f6a579096b4872f5dfd1530e200eda">More...</a><br /></td></tr>

  131. <tr class="separator:ab2f6a579096b4872f5dfd1530e200eda"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aaf0b0ceec57fd8014ea3e6b58e9bfe3d">tx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> byte, <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> seq=<a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a>)</td></tr>

  133. <tr class="memdesc:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit a byte to the i2c bus.  <a href="#aaf0b0ceec57fd8014ea3e6b58e9bfe3d">More...</a><br /></td></tr>

  134. <tr class="separator:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. </table><table class="memberdecls">

  136. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  137. Protected Member Functions</h2></td></tr>

  138. <tr><td colspan="2"><div class="groupHeader">Object lifetime</div></td></tr>

  139. <tr class="memitem:a84375c05d1c40d9992aa1290dd488410"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a84375c05d1c40d9992aa1290dd488410">i2c_i</a> ()=default</td></tr>

  140. <tr class="memdesc:a84375c05d1c40d9992aa1290dd488410"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow constructor from derived only.  <a href="#a84375c05d1c40d9992aa1290dd488410">More...</a><br /></td></tr>

  141. <tr class="separator:a84375c05d1c40d9992aa1290dd488410"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:a6a07d19db8974ad606031b60a6079957"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a6a07d19db8974ad606031b60a6079957">~i2c_i</a> ()=default</td></tr>

  143. <tr class="memdesc:a6a07d19db8974ad606031b60a6079957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow destructor from derived only.  <a href="#a6a07d19db8974ad606031b60a6079957">More...</a><br /></td></tr>

  144. <tr class="separator:a6a07d19db8974ad606031b60a6079957"><td class="memSeparator" colspan="2">&#160;</td></tr>

  145. <tr class="memitem:adff01408628f58b7c6ce9b0cd63d70df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#adff01408628f58b7c6ce9b0cd63d70df">i2c_i</a> (const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> &amp;)=delete</td></tr>

  146. <tr class="memdesc:adff01408628f58b7c6ce9b0cd63d70df"><td class="mdescLeft">&#160;</td><td class="mdescRight">No copies.  <a href="#adff01408628f58b7c6ce9b0cd63d70df">More...</a><br /></td></tr>

  147. <tr class="separator:adff01408628f58b7c6ce9b0cd63d70df"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:aee83d11e02c3a0639dd3ed1ea440ed24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aee83d11e02c3a0639dd3ed1ea440ed24">operator=</a> (const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> &amp;)=delete</td></tr>

  149. <tr class="separator:aee83d11e02c3a0639dd3ed1ea440ed24"><td class="memSeparator" colspan="2">&#160;</td></tr>

  150. </table><table class="memberdecls">

  151. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>

  152. Private Member Functions</h2></td></tr>

  153. <tr class="memitem:a054b6bc43f22e14d4e9feb0772f7ada5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a054b6bc43f22e14d4e9feb0772f7ada5">_CRTP_IMPL</a> (impl_t)</td></tr>

  154. <tr class="separator:a054b6bc43f22e14d4e9feb0772f7ada5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  155. <tr><td colspan="2"><div class="groupHeader">Implementation requirements</div></td></tr>

  156. <tr><td colspan="2"><div class="groupText"><dl class="section note"><dt>Note</dt><dd>In order for the implementation to have the following as private members it also need to declare this class as friend </dd></dl>

  157. </div></td></tr>

  158. <tr class="memitem:aefdea61282b9282ae10384951bb4ea51"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aefdea61282b9282ae10384951bb4ea51">_clock</a> () const</td></tr>

  159. <tr class="memdesc:aefdea61282b9282ae10384951bb4ea51"><td class="mdescLeft">&#160;</td><td class="mdescRight">clock frequency of the bus [Hz]  <a href="#aefdea61282b9282ae10384951bb4ea51">More...</a><br /></td></tr>

  160. <tr class="separator:aefdea61282b9282ae10384951bb4ea51"><td class="memSeparator" colspan="2">&#160;</td></tr>

  161. <tr class="memitem:afa0b1552f8fc7c971456fab1ad01242d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#afa0b1552f8fc7c971456fab1ad01242d">_clock</a> (uint32_t c)</td></tr>

  162. <tr class="memdesc:afa0b1552f8fc7c971456fab1ad01242d"><td class="mdescLeft">&#160;</td><td class="mdescRight">set clock frequency of the bus [Hz]  <a href="#afa0b1552f8fc7c971456fab1ad01242d">More...</a><br /></td></tr>

  163. <tr class="separator:afa0b1552f8fc7c971456fab1ad01242d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  164. <tr class="memitem:af060d656c685c1ab5dd6981c5c88b26d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#af060d656c685c1ab5dd6981c5c88b26d">_start</a> ()</td></tr>

  165. <tr class="memdesc:af060d656c685c1ab5dd6981c5c88b26d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send start functionality.  <a href="#af060d656c685c1ab5dd6981c5c88b26d">More...</a><br /></td></tr>

  166. <tr class="separator:af060d656c685c1ab5dd6981c5c88b26d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  167. <tr class="memitem:aa6202c6c7c1282071ae962fa6bb0f195"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aa6202c6c7c1282071ae962fa6bb0f195">_stop</a> ()</td></tr>

  168. <tr class="memdesc:aa6202c6c7c1282071ae962fa6bb0f195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send stop functionality.  <a href="#aa6202c6c7c1282071ae962fa6bb0f195">More...</a><br /></td></tr>

  169. <tr class="separator:aa6202c6c7c1282071ae962fa6bb0f195"><td class="memSeparator" colspan="2">&#160;</td></tr>

  170. <tr class="memitem:a03a25367cdec7ceb76f8de9d5b3145fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a03a25367cdec7ceb76f8de9d5b3145fb">_rx_data</a> (bool ack, <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> seq)</td></tr>

  171. <tr class="separator:a03a25367cdec7ceb76f8de9d5b3145fb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  172. <tr class="memitem:ae2b164d2c085d5331b627ba711bbb2c9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#ae2b164d2c085d5331b627ba711bbb2c9">_tx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> byte, <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> seq)</td></tr>

  173. <tr class="separator:ae2b164d2c085d5331b627ba711bbb2c9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  174. </table>

  175. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  176. <div class="textblock"><h3>template&lt;typename impl_t&gt;<br />

  177. class utl::i2c_i&lt; impl_t &gt;</h3>

  178. 

  179. <p>Abstract base class for i2c bus. </p>

  180. <p>this class force a common interface for I2C communication protocol implementations using CRTP </p><dl class="params"><dt>Parameters</dt><dd>

  181.   <table class="params">

  182.     <tr><td class="paramname">impl_t</td><td>The CRTP type (the derived/implementation class typename). </td></tr>

  183.   </table>

  184.   </dd>

  185. </dl>

  186. 

  187. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00043">43</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  188. </div><h2 class="groupheader">Member Typedef Documentation</h2>

  189. <a id="aa9267a8602702b78f188e0cf61b68a55"></a>

  190. <h2 class="memtitle"><span class="permalink"><a href="#aa9267a8602702b78f188e0cf61b68a55">&#9670;&nbsp;</a></span>type</h2>

  191. 

  192. <div class="memitem">

  193. <div class="memproto">

  194. <div class="memtemplate">

  195. template&lt;typename impl_t&gt; </div>

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">using <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> =  <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a>&lt;impl_t&gt;</td>

  199.         </tr>

  200.       </table>

  201. </div><div class="memdoc">

  202. <p>Export type as identity meta-function </p>

  203. 

  204. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00047">47</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  205. 

  206. </div>

  207. </div>

  208. <h2 class="groupheader">Member Enumeration Documentation</h2>

  209. <a id="a7e2dde443c6c9bde4a2293beb22950c5"></a>

  210. <h2 class="memtitle"><span class="permalink"><a href="#a7e2dde443c6c9bde4a2293beb22950c5">&#9670;&nbsp;</a></span>Sequence</h2>

  211. 

  212. <div class="memitem">

  213. <div class="memproto">

  214. <div class="memtemplate">

  215. template&lt;typename impl_t&gt; </div>

  216. <table class="mlabels">

  217.   <tr>

  218.   <td class="mlabels-left">

  219.       <table class="memname">

  220.         <tr>

  221.           <td class="memname">enum <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">utl::i2c_i::Sequence</a></td>

  222.         </tr>

  223.       </table>

  224.   </td>

  225.   <td class="mlabels-right">

  226. <span class="mlabels"><span class="mlabel">strong</span></span>  </td>

  227.   </tr>

  228. </table>

  229. </div><div class="memdoc">

  230. 

  231. <p>I2C transmit/receive sequence. </p>

  232. <table class="fieldtable">

  233. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5ae409eb2ba6eb6801f52763ae370c350e"></a>BYTE&#160;</td><td class="fielddoc"><p>Only read/write byte [8 clocks]. </p>

  234. </td></tr>

  235. <tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5"></a>ACK&#160;</td><td class="fielddoc"><p>Only send/receive ack [1 clock]. </p>

  236. </td></tr>

  237. <tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce"></a>BYTEnACK&#160;</td><td class="fielddoc"><p>Read/Write byte and ack [9 clocks]. </p>

  238. </td></tr>

  239. </table>

  240. 

  241. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00049">49</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  242. 

  243. </div>

  244. </div>

  245. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  246. <a id="a84375c05d1c40d9992aa1290dd488410"></a>

  247. <h2 class="memtitle"><span class="permalink"><a href="#a84375c05d1c40d9992aa1290dd488410">&#9670;&nbsp;</a></span>i2c_i() <span class="overload">[1/2]</span></h2>

  248. 

  249. <div class="memitem">

  250. <div class="memproto">

  251. <div class="memtemplate">

  252. template&lt;typename impl_t&gt; </div>

  253. <table class="mlabels">

  254.   <tr>

  255.   <td class="mlabels-left">

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>

  259.           <td>(</td>

  260.           <td class="paramname"></td><td>)</td>

  261.           <td></td>

  262.         </tr>

  263.       </table>

  264.   </td>

  265.   <td class="mlabels-right">

  266. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>

  267.   </tr>

  268. </table>

  269. </div><div class="memdoc">

  270. 

  271. <p>Allow constructor from derived only. </p>

  272. 

  273. </div>

  274. </div>

  275. <a id="a6a07d19db8974ad606031b60a6079957"></a>

  276. <h2 class="memtitle"><span class="permalink"><a href="#a6a07d19db8974ad606031b60a6079957">&#9670;&nbsp;</a></span>~i2c_i()</h2>

  277. 

  278. <div class="memitem">

  279. <div class="memproto">

  280. <div class="memtemplate">

  281. template&lt;typename impl_t&gt; </div>

  282. <table class="mlabels">

  283.   <tr>

  284.   <td class="mlabels-left">

  285.       <table class="memname">

  286.         <tr>

  287.           <td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::~<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>

  288.           <td>(</td>

  289.           <td class="paramname"></td><td>)</td>

  290.           <td></td>

  291.         </tr>

  292.       </table>

  293.   </td>

  294.   <td class="mlabels-right">

  295. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>

  296.   </tr>

  297. </table>

  298. </div><div class="memdoc">

  299. 

  300. <p>Allow destructor from derived only. </p>

  301. 

  302. </div>

  303. </div>

  304. <a id="adff01408628f58b7c6ce9b0cd63d70df"></a>

  305. <h2 class="memtitle"><span class="permalink"><a href="#adff01408628f58b7c6ce9b0cd63d70df">&#9670;&nbsp;</a></span>i2c_i() <span class="overload">[2/2]</span></h2>

  306. 

  307. <div class="memitem">

  308. <div class="memproto">

  309. <div class="memtemplate">

  310. template&lt;typename impl_t&gt; </div>

  311. <table class="mlabels">

  312.   <tr>

  313.   <td class="mlabels-left">

  314.       <table class="memname">

  315.         <tr>

  316.           <td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>

  317.           <td>(</td>

  318.           <td class="paramtype">const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> &amp;&#160;</td>

  319.           <td class="paramname"></td><td>)</td>

  320.           <td></td>

  321.         </tr>

  322.       </table>

  323.   </td>

  324.   <td class="mlabels-right">

  325. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>

  326.   </tr>

  327. </table>

  328. </div><div class="memdoc">

  329. 

  330. <p>No copies. </p>

  331. 

  332. </div>

  333. </div>

  334. <h2 class="groupheader">Member Function Documentation</h2>

  335. <a id="aefdea61282b9282ae10384951bb4ea51"></a>

  336. <h2 class="memtitle"><span class="permalink"><a href="#aefdea61282b9282ae10384951bb4ea51">&#9670;&nbsp;</a></span>_clock() <span class="overload">[1/2]</span></h2>

  337. 

  338. <div class="memitem">

  339. <div class="memproto">

  340. <div class="memtemplate">

  341. template&lt;typename impl_t&gt; </div>

  342. <table class="mlabels">

  343.   <tr>

  344.   <td class="mlabels-left">

  345.       <table class="memname">

  346.         <tr>

  347.           <td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_clock </td>

  348.           <td>(</td>

  349.           <td class="paramname"></td><td>)</td>

  350.           <td> const</td>

  351.         </tr>

  352.       </table>

  353.   </td>

  354.   <td class="mlabels-right">

  355. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  356.   </tr>

  357. </table>

  358. </div><div class="memdoc">

  359. 

  360. <p>clock frequency of the bus [Hz] </p>

  361. 

  362. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00074">74</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  363. 

  364. </div>

  365. </div>

  366. <a id="afa0b1552f8fc7c971456fab1ad01242d"></a>

  367. <h2 class="memtitle"><span class="permalink"><a href="#afa0b1552f8fc7c971456fab1ad01242d">&#9670;&nbsp;</a></span>_clock() <span class="overload">[2/2]</span></h2>

  368. 

  369. <div class="memitem">

  370. <div class="memproto">

  371. <div class="memtemplate">

  372. template&lt;typename impl_t&gt; </div>

  373. <table class="mlabels">

  374.   <tr>

  375.   <td class="mlabels-left">

  376.       <table class="memname">

  377.         <tr>

  378.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_clock </td>

  379.           <td>(</td>

  380.           <td class="paramtype">uint32_t&#160;</td>

  381.           <td class="paramname"><em>c</em></td><td>)</td>

  382.           <td></td>

  383.         </tr>

  384.       </table>

  385.   </td>

  386.   <td class="mlabels-right">

  387. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  388.   </tr>

  389. </table>

  390. </div><div class="memdoc">

  391. 

  392. <p>set clock frequency of the bus [Hz] </p>

  393. 

  394. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00075">75</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  395. 

  396. </div>

  397. </div>

  398. <a id="a054b6bc43f22e14d4e9feb0772f7ada5"></a>

  399. <h2 class="memtitle"><span class="permalink"><a href="#a054b6bc43f22e14d4e9feb0772f7ada5">&#9670;&nbsp;</a></span>_CRTP_IMPL()</h2>

  400. 

  401. <div class="memitem">

  402. <div class="memproto">

  403. <div class="memtemplate">

  404. template&lt;typename impl_t&gt; </div>

  405. <table class="mlabels">

  406.   <tr>

  407.   <td class="mlabels-left">

  408.       <table class="memname">

  409.         <tr>

  410.           <td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_CRTP_IMPL </td>

  411.           <td>(</td>

  412.           <td class="paramtype">impl_t&#160;</td>

  413.           <td class="paramname"></td><td>)</td>

  414.           <td></td>

  415.         </tr>

  416.       </table>

  417.   </td>

  418.   <td class="mlabels-right">

  419. <span class="mlabels"><span class="mlabel">private</span></span>  </td>

  420.   </tr>

  421. </table>

  422. </div><div class="memdoc">

  423. 

  424. </div>

  425. </div>

  426. <a id="a03a25367cdec7ceb76f8de9d5b3145fb"></a>

  427. <h2 class="memtitle"><span class="permalink"><a href="#a03a25367cdec7ceb76f8de9d5b3145fb">&#9670;&nbsp;</a></span>_rx_data()</h2>

  428. 

  429. <div class="memitem">

  430. <div class="memproto">

  431. <div class="memtemplate">

  432. template&lt;typename impl_t&gt; </div>

  433. <table class="mlabels">

  434.   <tr>

  435.   <td class="mlabels-left">

  436.       <table class="memname">

  437.         <tr>

  438.           <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_rx_data </td>

  439.           <td>(</td>

  440.           <td class="paramtype">bool&#160;</td>

  441.           <td class="paramname"><em>ack</em>, </td>

  442.         </tr>

  443.         <tr>

  444.           <td class="paramkey"></td>

  445.           <td></td>

  446.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a>&#160;</td>

  447.           <td class="paramname"><em>seq</em>&#160;</td>

  448.         </tr>

  449.         <tr>

  450.           <td></td>

  451.           <td>)</td>

  452.           <td></td><td></td>

  453.         </tr>

  454.       </table>

  455.   </td>

  456.   <td class="mlabels-right">

  457. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  458.   </tr>

  459. </table>

  460. </div><div class="memdoc">

  461. 

  462. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00078">78</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  463. 

  464. </div>

  465. </div>

  466. <a id="af060d656c685c1ab5dd6981c5c88b26d"></a>

  467. <h2 class="memtitle"><span class="permalink"><a href="#af060d656c685c1ab5dd6981c5c88b26d">&#9670;&nbsp;</a></span>_start()</h2>

  468. 

  469. <div class="memitem">

  470. <div class="memproto">

  471. <div class="memtemplate">

  472. template&lt;typename impl_t&gt; </div>

  473. <table class="mlabels">

  474.   <tr>

  475.   <td class="mlabels-left">

  476.       <table class="memname">

  477.         <tr>

  478.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_start </td>

  479.           <td>(</td>

  480.           <td class="paramname"></td><td>)</td>

  481.           <td></td>

  482.         </tr>

  483.       </table>

  484.   </td>

  485.   <td class="mlabels-right">

  486. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  487.   </tr>

  488. </table>

  489. </div><div class="memdoc">

  490. 

  491. <p>Send start functionality. </p>

  492. 

  493. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00076">76</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  494. 

  495. </div>

  496. </div>

  497. <a id="aa6202c6c7c1282071ae962fa6bb0f195"></a>

  498. <h2 class="memtitle"><span class="permalink"><a href="#aa6202c6c7c1282071ae962fa6bb0f195">&#9670;&nbsp;</a></span>_stop()</h2>

  499. 

  500. <div class="memitem">

  501. <div class="memproto">

  502. <div class="memtemplate">

  503. template&lt;typename impl_t&gt; </div>

  504. <table class="mlabels">

  505.   <tr>

  506.   <td class="mlabels-left">

  507.       <table class="memname">

  508.         <tr>

  509.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_stop </td>

  510.           <td>(</td>

  511.           <td class="paramname"></td><td>)</td>

  512.           <td></td>

  513.         </tr>

  514.       </table>

  515.   </td>

  516.   <td class="mlabels-right">

  517. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  518.   </tr>

  519. </table>

  520. </div><div class="memdoc">

  521. 

  522. <p>Send stop functionality. </p>

  523. 

  524. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00077">77</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  525. 

  526. </div>

  527. </div>

  528. <a id="ae2b164d2c085d5331b627ba711bbb2c9"></a>

  529. <h2 class="memtitle"><span class="permalink"><a href="#ae2b164d2c085d5331b627ba711bbb2c9">&#9670;&nbsp;</a></span>_tx_data()</h2>

  530. 

  531. <div class="memitem">

  532. <div class="memproto">

  533. <div class="memtemplate">

  534. template&lt;typename impl_t&gt; </div>

  535. <table class="mlabels">

  536.   <tr>

  537.   <td class="mlabels-left">

  538.       <table class="memname">

  539.         <tr>

  540.           <td class="memname">bool <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::_tx_data </td>

  541.           <td>(</td>

  542.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>

  543.           <td class="paramname"><em>byte</em>, </td>

  544.         </tr>

  545.         <tr>

  546.           <td class="paramkey"></td>

  547.           <td></td>

  548.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a>&#160;</td>

  549.           <td class="paramname"><em>seq</em>&#160;</td>

  550.         </tr>

  551.         <tr>

  552.           <td></td>

  553.           <td>)</td>

  554.           <td></td><td></td>

  555.         </tr>

  556.       </table>

  557.   </td>

  558.   <td class="mlabels-right">

  559. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  560.   </tr>

  561. </table>

  562. </div><div class="memdoc">

  563. 

  564. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00079">79</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  565. 

  566. </div>

  567. </div>

  568. <a id="aac5fed816701cc4543acd717ec804ac0"></a>

  569. <h2 class="memtitle"><span class="permalink"><a href="#aac5fed816701cc4543acd717ec804ac0">&#9670;&nbsp;</a></span>clock() <span class="overload">[1/2]</span></h2>

  570. 

  571. <div class="memitem">

  572. <div class="memproto">

  573. <div class="memtemplate">

  574. template&lt;typename impl_t&gt; </div>

  575. <table class="mlabels">

  576.   <tr>

  577.   <td class="mlabels-left">

  578.       <table class="memname">

  579.         <tr>

  580.           <td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::clock </td>

  581.           <td>(</td>

  582.           <td class="paramname"></td><td>)</td>

  583.           <td> const</td>

  584.         </tr>

  585.       </table>

  586.   </td>

  587.   <td class="mlabels-right">

  588. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  589.   </tr>

  590. </table>

  591. </div><div class="memdoc">

  592. <dl class="section return"><dt>Returns</dt><dd>clock frequency of the bus </dd></dl>

  593. 

  594. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00087">87</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  595. 

  596. </div>

  597. </div>

  598. <a id="ae4c59938aeeb1f0726195d425a4c0083"></a>

  599. <h2 class="memtitle"><span class="permalink"><a href="#ae4c59938aeeb1f0726195d425a4c0083">&#9670;&nbsp;</a></span>clock() <span class="overload">[2/2]</span></h2>

  600. 

  601. <div class="memitem">

  602. <div class="memproto">

  603. <div class="memtemplate">

  604. template&lt;typename impl_t&gt; </div>

  605. <table class="mlabels">

  606.   <tr>

  607.   <td class="mlabels-left">

  608.       <table class="memname">

  609.         <tr>

  610.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::clock </td>

  611.           <td>(</td>

  612.           <td class="paramtype">uint32_t&#160;</td>

  613.           <td class="paramname"><em>f</em></td><td>)</td>

  614.           <td></td>

  615.         </tr>

  616.       </table>

  617.   </td>

  618.   <td class="mlabels-right">

  619. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  620.   </tr>

  621. </table>

  622. </div><div class="memdoc">

  623. 

  624. <p>set clock frequency of the bus </p>

  625. 

  626. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00088">88</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  627. 

  628. </div>

  629. </div>

  630. <a id="aee83d11e02c3a0639dd3ed1ea440ed24"></a>

  631. <h2 class="memtitle"><span class="permalink"><a href="#aee83d11e02c3a0639dd3ed1ea440ed24">&#9670;&nbsp;</a></span>operator=()</h2>

  632. 

  633. <div class="memitem">

  634. <div class="memproto">

  635. <div class="memtemplate">

  636. template&lt;typename impl_t&gt; </div>

  637. <table class="mlabels">

  638.   <tr>

  639.   <td class="mlabels-left">

  640.       <table class="memname">

  641.         <tr>

  642.           <td class="memname"><a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a>&amp; <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::operator= </td>

  643.           <td>(</td>

  644.           <td class="paramtype">const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> &amp;&#160;</td>

  645.           <td class="paramname"></td><td>)</td>

  646.           <td></td>

  647.         </tr>

  648.       </table>

  649.   </td>

  650.   <td class="mlabels-right">

  651. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>

  652.   </tr>

  653. </table>

  654. </div><div class="memdoc">

  655. 

  656. </div>

  657. </div>

  658. <a id="ab2f6a579096b4872f5dfd1530e200eda"></a>

  659. <h2 class="memtitle"><span class="permalink"><a href="#ab2f6a579096b4872f5dfd1530e200eda">&#9670;&nbsp;</a></span>rx_data()</h2>

  660. 

  661. <div class="memitem">

  662. <div class="memproto">

  663. <div class="memtemplate">

  664. template&lt;typename impl_t&gt; </div>

  665. <table class="mlabels">

  666.   <tr>

  667.   <td class="mlabels-left">

  668.       <table class="memname">

  669.         <tr>

  670.           <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::rx_data </td>

  671.           <td>(</td>

  672.           <td class="paramtype">bool&#160;</td>

  673.           <td class="paramname"><em>ack</em>, </td>

  674.         </tr>

  675.         <tr>

  676.           <td class="paramkey"></td>

  677.           <td></td>

  678.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a>&#160;</td>

  679.           <td class="paramname"><em>seq</em> = <code><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a></code>&#160;</td>

  680.         </tr>

  681.         <tr>

  682.           <td></td>

  683.           <td>)</td>

  684.           <td></td><td></td>

  685.         </tr>

  686.       </table>

  687.   </td>

  688.   <td class="mlabels-right">

  689. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  690.   </tr>

  691. </table>

  692. </div><div class="memdoc">

  693. 

  694. <p>Receive a byte from the i2c bus. </p>

  695. <dl class="params"><dt>Parameters</dt><dd>

  696.   <table class="params">

  697.     <tr><td class="paramname">ack</td><td>Optional ack bit. <ul>

  698. <li>1 ACK the reception </li>

  699. <li>0 Don't ACK the reception. </li>

  700. </ul>

  701. </td></tr>

  702.     <tr><td class="paramname">seq</td><td>The operation sequence to execute <ul>

  703. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5ae409eb2ba6eb6801f52763ae370c350e" title="Only read/write byte [8 clocks]. ">Sequence::BYTE</a> Receive only the byte, do not send ack clock </li>

  704. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5" title="Only send/receive ack [1 clock]. ">Sequence::ACK</a> Send only the ack bit </li>

  705. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce" title="Read/Write byte and ack [9 clocks]. ">Sequence::BYTEnACK</a> Receive the byte and send the ack bit </li>

  706. </ul>

  707. </td></tr>

  708.   </table>

  709.   </dd>

  710. </dl>

  711. <dl class="section return"><dt>Returns</dt><dd>The byte received. </dd></dl>

  712. 

  713. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00111">111</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  714. 

  715. </div>

  716. </div>

  717. <a id="a3591683e5fbf17b582f6ac1f79af871d"></a>

  718. <h2 class="memtitle"><span class="permalink"><a href="#a3591683e5fbf17b582f6ac1f79af871d">&#9670;&nbsp;</a></span>start()</h2>

  719. 

  720. <div class="memitem">

  721. <div class="memproto">

  722. <div class="memtemplate">

  723. template&lt;typename impl_t&gt; </div>

  724. <table class="mlabels">

  725.   <tr>

  726.   <td class="mlabels-left">

  727.       <table class="memname">

  728.         <tr>

  729.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::start </td>

  730.           <td>(</td>

  731.           <td class="paramname"></td><td>)</td>

  732.           <td></td>

  733.         </tr>

  734.       </table>

  735.   </td>

  736.   <td class="mlabels-right">

  737. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  738.   </tr>

  739. </table>

  740. </div><div class="memdoc">

  741. 

  742. <p>Send start functionality. </p>

  743. 

  744. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00096">96</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  745. 

  746. </div>

  747. </div>

  748. <a id="a1310b52ac908b8c37059fb253cc3f56e"></a>

  749. <h2 class="memtitle"><span class="permalink"><a href="#a1310b52ac908b8c37059fb253cc3f56e">&#9670;&nbsp;</a></span>stop()</h2>

  750. 

  751. <div class="memitem">

  752. <div class="memproto">

  753. <div class="memtemplate">

  754. template&lt;typename impl_t&gt; </div>

  755. <table class="mlabels">

  756.   <tr>

  757.   <td class="mlabels-left">

  758.       <table class="memname">

  759.         <tr>

  760.           <td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::stop </td>

  761.           <td>(</td>

  762.           <td class="paramname"></td><td>)</td>

  763.           <td></td>

  764.         </tr>

  765.       </table>

  766.   </td>

  767.   <td class="mlabels-right">

  768. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  769.   </tr>

  770. </table>

  771. </div><div class="memdoc">

  772. 

  773. <p>Send stop functionality. </p>

  774. 

  775. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00097">97</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  776. 

  777. </div>

  778. </div>

  779. <a id="aaf0b0ceec57fd8014ea3e6b58e9bfe3d"></a>

  780. <h2 class="memtitle"><span class="permalink"><a href="#aaf0b0ceec57fd8014ea3e6b58e9bfe3d">&#9670;&nbsp;</a></span>tx_data()</h2>

  781. 

  782. <div class="memitem">

  783. <div class="memproto">

  784. <div class="memtemplate">

  785. template&lt;typename impl_t&gt; </div>

  786. <table class="mlabels">

  787.   <tr>

  788.   <td class="mlabels-left">

  789.       <table class="memname">

  790.         <tr>

  791.           <td class="memname">bool <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>&lt; impl_t &gt;::tx_data </td>

  792.           <td>(</td>

  793.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>

  794.           <td class="paramname"><em>byte</em>, </td>

  795.         </tr>

  796.         <tr>

  797.           <td class="paramkey"></td>

  798.           <td></td>

  799.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a>&#160;</td>

  800.           <td class="paramname"><em>seq</em> = <code><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a></code>&#160;</td>

  801.         </tr>

  802.         <tr>

  803.           <td></td>

  804.           <td>)</td>

  805.           <td></td><td></td>

  806.         </tr>

  807.       </table>

  808.   </td>

  809.   <td class="mlabels-right">

  810. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  811.   </tr>

  812. </table>

  813. </div><div class="memdoc">

  814. 

  815. <p>Transmit a byte to the i2c bus. </p>

  816. <dl class="params"><dt>Parameters</dt><dd>

  817.   <table class="params">

  818.     <tr><td class="paramname">byte</td><td>The byte to send. </td></tr>

  819.     <tr><td class="paramname">seq</td><td>The operation sequence to execute <ul>

  820. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5ae409eb2ba6eb6801f52763ae370c350e" title="Only read/write byte [8 clocks]. ">Sequence::BYTE</a> Transmit only the byte, do not read ack bit </li>

  821. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5" title="Only send/receive ack [1 clock]. ">Sequence::ACK</a> Read only the ack bit </li>

  822. <li><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce" title="Read/Write byte and ack [9 clocks]. ">Sequence::BYTEnACK</a> Transmit the byte and read the ack bit </li>

  823. </ul>

  824. </td></tr>

  825.   </table>

  826.   </dd>

  827. </dl>

  828. <dl class="section return"><dt>Returns</dt><dd>Slave's ACK bit <ul>

  829. <li>false Slave didn't ACK </li>

  830. <li>true Slave did ACK </li>

  831. </ul>

  832. </dd></dl>

  833. 

  834. <p class="definition">Definition at line <a class="el" href="i2c_8h_source.html#l00127">127</a> of file <a class="el" href="i2c_8h_source.html">i2c.h</a>.</p>

  835. 

  836. </div>

  837. </div>

  838. <hr/>The documentation for this class was generated from the following file:<ul>

  839. <li>include/utl/com/<a class="el" href="i2c_8h_source.html">i2c.h</a></li>

  840. </ul>

  841. </div><!-- contents -->

  842. </div><!-- doc-content -->

  843. <!-- start footer part -->

  844. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

  845.   <ul>

  846.     <li class="navelem"><a class="el" href="namespaceutl.html">utl</a></li><li class="navelem"><a class="el" href="classutl_1_1i2c__i.html">i2c_i</a></li>

  847.     <li class="footer">Generated by

  848.     <a href="http://www.doxygen.org/index.html">

  849.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>

  850.   </ul>

  851. </div>

  852. </body>

  853. </html>