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__bb__i.html

818 lines
47 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_bb_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__bb__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="#pri-attribs">Private Attributes</a> &#124;

  93. <a href="classutl_1_1i2c__bb__i-members.html">List of all members</a>  </div>

  94.   <div class="headertitle">

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

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

  97. <div class="contents">

  98. 

  99. <p>A bit banking implementation of i2c bus inherited from <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> base class.  

  100.  <a href="classutl_1_1i2c__bb__i.html#details">More...</a></p>

  101. 

  102. <p><code>#include &lt;<a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>&gt;</code></p>

  103. <div class="dynheader">

  104. Inheritance diagram for utl::i2c_bb_i&lt; impl_t &gt;:</div>

  105. <div class="dyncontent">

  106.  <div class="center">

  107.   <img src="classutl_1_1i2c__bb__i.png" usemap="#utl::i2c_5Fbb_5Fi_3C_20impl_5Ft_20_3E_map" alt=""/>

  108.   <map id="utl::i2c_5Fbb_5Fi_3C_20impl_5Ft_20_3E_map" name="utl::i2c_5Fbb_5Fi_3C_20impl_5Ft_20_3E_map">

  109. <area href="classutl_1_1i2c__i.html" alt="utl::i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;" shape="rect" coords="0,0,186,24"/>

  110. </map>

  111.  </div></div>

  112. <table class="memberdecls">

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

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

  115. <tr class="memitem:a4369b434fde250d503bfdc07d5c6a26d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26d">SDAMode</a> { <a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26daa84cc046d48610b05c21fd3670d0c829">SDAMode::INPUT</a> =0, 

  116. <a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26da50a87f0d71f7221582dad4bf507a0f34">SDAMode::OUTPUT</a>

  117.  }</td></tr>

  118. <tr class="memdesc:a4369b434fde250d503bfdc07d5c6a26d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SDA pin direction enumerator.  <a href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26d">More...</a><br /></td></tr>

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

  120. <tr class="memitem:a428c847d950993fa2cd005416edfb720"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a428c847d950993fa2cd005416edfb720">type</a> = <a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a>&lt; impl_t &gt;</td></tr>

  121. <tr class="memdesc:a428c847d950993fa2cd005416edfb720"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export type as identity meta-function.  <a href="#a428c847d950993fa2cd005416edfb720">More...</a><br /></td></tr>

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

  123. <tr class="memitem:ad2872b7e17116f8379144488fe135052"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a> = typename <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a>&lt; <a class="el" href="classutl_1_1i2c__bb__i.html#a428c847d950993fa2cd005416edfb720">type</a> &gt;::<a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a></td></tr>

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

  125. <tr class="inherit_header pub_types_classutl_1_1i2c__i"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classutl_1_1i2c__i')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;</a></td></tr>

  126. <tr class="memitem:a7e2dde443c6c9bde4a2293beb22950c5 inherit pub_types_classutl_1_1i2c__i"><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> </td></tr>

  127. <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>

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

  129. <tr class="memitem:aa9267a8602702b78f188e0cf61b68a55 inherit pub_types_classutl_1_1i2c__i"><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; <a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a>&lt; impl_t &gt; &gt;</td></tr>

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

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

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

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

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

  135. <tr class="memitem:ac2d9b97778a5dd57eb5e6425b4b0833c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#ac2d9b97778a5dd57eb5e6425b4b0833c">~i2c_bb_i</a> () noexcept=default</td></tr>

  136. <tr class="memdesc:ac2d9b97778a5dd57eb5e6425b4b0833c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor, allow destructor from derived only.  <a href="#ac2d9b97778a5dd57eb5e6425b4b0833c">More...</a><br /></td></tr>

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

  138. <tr class="memitem:ab657379ca2e4b3624e2d4520542a9464"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#ab657379ca2e4b3624e2d4520542a9464">i2c_bb_i</a> (uint32_t clk) noexcept</td></tr>

  139. <tr class="memdesc:ab657379ca2e4b3624e2d4520542a9464"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default constructor.  <a href="#ab657379ca2e4b3624e2d4520542a9464">More...</a><br /></td></tr>

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

  141. <tr class="inherit_header pro_methods_classutl_1_1i2c__i"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classutl_1_1i2c__i')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;</a></td></tr>

  142. <tr class="memitem:a84375c05d1c40d9992aa1290dd488410 inherit pro_methods_classutl_1_1i2c__i"><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>

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

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

  145. <tr class="memitem:adff01408628f58b7c6ce9b0cd63d70df inherit pro_methods_classutl_1_1i2c__i"><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 inherit pro_methods_classutl_1_1i2c__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">No copies.  <a href="classutl_1_1i2c__i.html#adff01408628f58b7c6ce9b0cd63d70df">More...</a><br /></td></tr>

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

  148. <tr class="memitem:a6a07d19db8974ad606031b60a6079957 inherit pro_methods_classutl_1_1i2c__i"><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>

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

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

  151. <tr class="memitem:aee83d11e02c3a0639dd3ed1ea440ed24 inherit pro_methods_classutl_1_1i2c__i"><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>

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

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

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

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

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

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

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

  159. <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>

  160. </div></td></tr>

  161. <tr class="memitem:aa197be76016b82fd6f8b66875430d922"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#aa197be76016b82fd6f8b66875430d922">SDA</a> (<a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26d">SDAMode</a> mode, bool st)</td></tr>

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

  163. <tr class="memitem:a0c9f7d9fc10ac2ceaef93cb6daf8a699"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a0c9f7d9fc10ac2ceaef93cb6daf8a699">SCL</a> (uint8_t st)</td></tr>

  164. <tr class="memdesc:a0c9f7d9fc10ac2ceaef93cb6daf8a699"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementers's scl pin function.  <a href="#a0c9f7d9fc10ac2ceaef93cb6daf8a699">More...</a><br /></td></tr>

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

  166. <tr class="memitem:a18db1fab1be2aafbb2612242df2667f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a18db1fab1be2aafbb2612242df2667f1">delay</a> (uint32_t usec)</td></tr>

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

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

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

  170. Private Attributes</h2></td></tr>

  171. <tr class="memitem:a9932eded730c8f9a7b1d15988082b699"><td class="memItemLeft" align="right" valign="top">friend&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a9932eded730c8f9a7b1d15988082b699">i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;</a></td></tr>

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

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

  174. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>

  175. Implementation of base requirements</h2></td></tr>

  176. <tr class="memitem:a8bd3726104fc91eb8f283d7ffec71cee"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__bb__i.html#a8bd3726104fc91eb8f283d7ffec71cee">usec_</a></td></tr>

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

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

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

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

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

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

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

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

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

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

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

  188. <tr class="memitem:a3a459ded18fe55460ae438e312c22110"><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__bb__i.html#a3a459ded18fe55460ae438e312c22110">_rx_data</a> (bool ack, <a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a> seq)</td></tr>

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

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

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

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

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

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

  195. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>

  196. Additional Inherited Members</h2></td></tr>

  197. <tr class="inherit_header pub_methods_classutl_1_1i2c__i"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classutl_1_1i2c__i')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;</a></td></tr>

  198. <tr class="memitem:aac5fed816701cc4543acd717ec804ac0 inherit pub_methods_classutl_1_1i2c__i"><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>

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

  200. <tr class="memitem:ae4c59938aeeb1f0726195d425a4c0083 inherit pub_methods_classutl_1_1i2c__i"><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>

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

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

  203. <tr class="memitem:a3591683e5fbf17b582f6ac1f79af871d inherit pub_methods_classutl_1_1i2c__i"><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>

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

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

  206. <tr class="memitem:a1310b52ac908b8c37059fb253cc3f56e inherit pub_methods_classutl_1_1i2c__i"><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>

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

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

  209. <tr class="memitem:ab2f6a579096b4872f5dfd1530e200eda inherit pub_methods_classutl_1_1i2c__i"><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=Sequence::BYTEnACK)</td></tr>

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

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

  212. <tr class="memitem:aaf0b0ceec57fd8014ea3e6b58e9bfe3d inherit pub_methods_classutl_1_1i2c__i"><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=Sequence::BYTEnACK)</td></tr>

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

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

  215. </table>

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

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

  218. class utl::i2c_bb_i&lt; impl_t &gt;</h3>

  219. 

  220. <p>A bit banking implementation of i2c bus inherited from <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> base class. </p>

  221. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classutl_1_1i2c__i.html" title="Abstract base class for i2c bus. ">i2c_i</a></dd></dl>

  222. <p>I2C bit banking interface template class providing an I2C using bit banking using CRTP. </p><dl class="params"><dt>Parameters</dt><dd>

  223.   <table class="params">

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

  225.   </table>

  226.   </dd>

  227. </dl>

  228. 

  229. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00047">47</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

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

  231. <a id="ad2872b7e17116f8379144488fe135052"></a>

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

  233. 

  234. <div class="memitem">

  235. <div class="memproto">

  236. <div class="memtemplate">

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

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">using <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a> =  typename <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a>&lt;<a class="el" href="classutl_1_1i2c__bb__i.html#a428c847d950993fa2cd005416edfb720">type</a>&gt;::<a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a></td>

  241.         </tr>

  242.       </table>

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

  244. 

  245. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00053">53</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  246. 

  247. </div>

  248. </div>

  249. <a id="a428c847d950993fa2cd005416edfb720"></a>

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

  251. 

  252. <div class="memitem">

  253. <div class="memproto">

  254. <div class="memtemplate">

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

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">using <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__bb__i.html#a428c847d950993fa2cd005416edfb720">type</a> =  <a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a>&lt;impl_t&gt;</td>

  259.         </tr>

  260.       </table>

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

  262. 

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

  264. 

  265. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00052">52</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  266. 

  267. </div>

  268. </div>

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

  270. <a id="a4369b434fde250d503bfdc07d5c6a26d"></a>

  271. <h2 class="memtitle"><span class="permalink"><a href="#a4369b434fde250d503bfdc07d5c6a26d">&#9670;&nbsp;</a></span>SDAMode</h2>

  272. 

  273. <div class="memitem">

  274. <div class="memproto">

  275. <div class="memtemplate">

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

  277. <table class="mlabels">

  278.   <tr>

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

  280.       <table class="memname">

  281.         <tr>

  282.           <td class="memname">enum <a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26d">utl::i2c_bb_i::SDAMode</a></td>

  283.         </tr>

  284.       </table>

  285.   </td>

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

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

  288.   </tr>

  289. </table>

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

  291. 

  292. <p>SDA pin direction enumerator. </p>

  293. <table class="fieldtable">

  294. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4369b434fde250d503bfdc07d5c6a26daa84cc046d48610b05c21fd3670d0c829"></a>INPUT&#160;</td><td class="fielddoc"></td></tr>

  295. <tr><td class="fieldname"><a id="a4369b434fde250d503bfdc07d5c6a26da50a87f0d71f7221582dad4bf507a0f34"></a>OUTPUT&#160;</td><td class="fielddoc"></td></tr>

  296. </table>

  297. 

  298. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00055">55</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  299. 

  300. </div>

  301. </div>

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

  303. <a id="ac2d9b97778a5dd57eb5e6425b4b0833c"></a>

  304. <h2 class="memtitle"><span class="permalink"><a href="#ac2d9b97778a5dd57eb5e6425b4b0833c">&#9670;&nbsp;</a></span>~i2c_bb_i()</h2>

  305. 

  306. <div class="memitem">

  307. <div class="memproto">

  308. <div class="memtemplate">

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

  310. <table class="mlabels">

  311.   <tr>

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

  313.       <table class="memname">

  314.         <tr>

  315.           <td class="memname"><a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::~<a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a> </td>

  316.           <td>(</td>

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

  318.           <td></td>

  319.         </tr>

  320.       </table>

  321.   </td>

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

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

  324.   </tr>

  325. </table>

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

  327. 

  328. <p>A default destructor, allow destructor from derived only. </p>

  329. 

  330. </div>

  331. </div>

  332. <a id="ab657379ca2e4b3624e2d4520542a9464"></a>

  333. <h2 class="memtitle"><span class="permalink"><a href="#ab657379ca2e4b3624e2d4520542a9464">&#9670;&nbsp;</a></span>i2c_bb_i()</h2>

  334. 

  335. <div class="memitem">

  336. <div class="memproto">

  337. <div class="memtemplate">

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

  339. <table class="mlabels">

  340.   <tr>

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

  342.       <table class="memname">

  343.         <tr>

  344.           <td class="memname"><a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a> </td>

  345.           <td>(</td>

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

  347.           <td class="paramname"><em>clk</em></td><td>)</td>

  348.           <td></td>

  349.         </tr>

  350.       </table>

  351.   </td>

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

  353. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span>  </td>

  354.   </tr>

  355. </table>

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

  357. 

  358. <p>A default constructor. </p>

  359. 

  360. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00068">68</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  361. 

  362. </div>

  363. </div>

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

  365. <a id="a1f491d6ccadce71fa6cc59eebc74e82f"></a>

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

  367. 

  368. <div class="memitem">

  369. <div class="memproto">

  370. <div class="memtemplate">

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

  372. <table class="mlabels">

  373.   <tr>

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

  375.       <table class="memname">

  376.         <tr>

  377.           <td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_clock </td>

  378.           <td>(</td>

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

  380.           <td> const</td>

  381.         </tr>

  382.       </table>

  383.   </td>

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

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

  386.   </tr>

  387. </table>

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

  389. 

  390. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00095">95</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  391. 

  392. </div>

  393. </div>

  394. <a id="aef4db6e89447b2f0921df5b291b86232"></a>

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

  396. 

  397. <div class="memitem">

  398. <div class="memproto">

  399. <div class="memtemplate">

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

  401. <table class="mlabels">

  402.   <tr>

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

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">void <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_clock </td>

  407.           <td>(</td>

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

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

  410.           <td></td>

  411.         </tr>

  412.       </table>

  413.   </td>

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

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

  416.   </tr>

  417. </table>

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

  419. 

  420. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00096">96</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  421. 

  422. </div>

  423. </div>

  424. <a id="a5c9f28c59f87ebb8a937abb039e11150"></a>

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

  426. 

  427. <div class="memitem">

  428. <div class="memproto">

  429. <div class="memtemplate">

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

  431. <table class="mlabels">

  432.   <tr>

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

  434.       <table class="memname">

  435.         <tr>

  436.           <td class="memname"><a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_CRTP_IMPL </td>

  437.           <td>(</td>

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

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

  440.           <td></td>

  441.         </tr>

  442.       </table>

  443.   </td>

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

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

  446.   </tr>

  447. </table>

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

  449. 

  450. </div>

  451. </div>

  452. <a id="a3a459ded18fe55460ae438e312c22110"></a>

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

  454. 

  455. <div class="memitem">

  456. <div class="memproto">

  457. <div class="memtemplate">

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

  459. <table class="mlabels">

  460.   <tr>

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

  462.       <table class="memname">

  463.         <tr>

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

  465.           <td>(</td>

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

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

  468.         </tr>

  469.         <tr>

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

  471.           <td></td>

  472.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a>&#160;</td>

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

  474.         </tr>

  475.         <tr>

  476.           <td></td>

  477.           <td>)</td>

  478.           <td></td><td></td>

  479.         </tr>

  480.       </table>

  481.   </td>

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

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

  484.   </tr>

  485. </table>

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

  487. 

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

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

  490.   <table class="params">

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

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

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

  494. </ul>

  495. </td></tr>

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

  497. <li>Sequence::BYTE Receive only the byte, do not send ack clock </li>

  498. <li>Sequence::ACK Send only the ack bit </li>

  499. <li>Sequence::BYTEnACK Receive the byte and send the ack bit </li>

  500. </ul>

  501. </td></tr>

  502.   </table>

  503.   </dd>

  504. </dl>

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

  506. 

  507. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00154">154</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  508. 

  509. </div>

  510. </div>

  511. <a id="a2f4df606609ef7465109990d9fc0f1da"></a>

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

  513. 

  514. <div class="memitem">

  515. <div class="memproto">

  516. <div class="memtemplate">

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

  518. <table class="mlabels">

  519.   <tr>

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

  521.       <table class="memname">

  522.         <tr>

  523.           <td class="memname">void <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_start </td>

  524.           <td>(</td>

  525.           <td class="paramtype">void&#160;</td>

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

  527.           <td></td>

  528.         </tr>

  529.       </table>

  530.   </td>

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

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

  533.   </tr>

  534. </table>

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

  536. 

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

  538. <p>Send a START bit to the bus.</p>

  539. <dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

  540. 

  541. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00115">115</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  542. 

  543. </div>

  544. </div>

  545. <a id="ade9235a9d8ccfd7233494631d66ba07e"></a>

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

  547. 

  548. <div class="memitem">

  549. <div class="memproto">

  550. <div class="memtemplate">

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

  552. <table class="mlabels">

  553.   <tr>

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

  555.       <table class="memname">

  556.         <tr>

  557.           <td class="memname">void <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_stop </td>

  558.           <td>(</td>

  559.           <td class="paramtype">void&#160;</td>

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

  561.           <td></td>

  562.         </tr>

  563.       </table>

  564.   </td>

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

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

  567.   </tr>

  568. </table>

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

  570. 

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

  572. <p>Send a START bit to the bus.</p>

  573. <dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

  574. 

  575. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00131">131</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  576. 

  577. </div>

  578. </div>

  579. <a id="a085e38e545049ac64cd745b08e0be18f"></a>

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

  581. 

  582. <div class="memitem">

  583. <div class="memproto">

  584. <div class="memtemplate">

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

  586. <table class="mlabels">

  587.   <tr>

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

  589.       <table class="memname">

  590.         <tr>

  591.           <td class="memname">bool <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::_tx_data </td>

  592.           <td>(</td>

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

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

  595.         </tr>

  596.         <tr>

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

  598.           <td></td>

  599.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__bb__i.html#ad2872b7e17116f8379144488fe135052">Sequence</a>&#160;</td>

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

  601.         </tr>

  602.         <tr>

  603.           <td></td>

  604.           <td>)</td>

  605.           <td></td><td></td>

  606.         </tr>

  607.       </table>

  608.   </td>

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

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

  611.   </tr>

  612. </table>

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

  614. 

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

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

  617.   <table class="params">

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

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

  620. <li>Sequence::BYTE Transmit only the byte, do not read ack bit </li>

  621. <li>Sequence::ACK Read only the ack bit </li>

  622. <li>Sequence::BYTEnACK Transmit the byte and read the ack bit </li>

  623. </ul>

  624. </td></tr>

  625.   </table>

  626.   </dd>

  627. </dl>

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

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

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

  631. </ul>

  632. </dd></dl>

  633. 

  634. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00194">194</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  635. 

  636. </div>

  637. </div>

  638. <a id="a18db1fab1be2aafbb2612242df2667f1"></a>

  639. <h2 class="memtitle"><span class="permalink"><a href="#a18db1fab1be2aafbb2612242df2667f1">&#9670;&nbsp;</a></span>delay()</h2>

  640. 

  641. <div class="memitem">

  642. <div class="memproto">

  643. <div class="memtemplate">

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

  645. <table class="mlabels">

  646.   <tr>

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

  648.       <table class="memname">

  649.         <tr>

  650.           <td class="memname">void <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::delay </td>

  651.           <td>(</td>

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

  653.           <td class="paramname"><em>usec</em></td><td>)</td>

  654.           <td></td>

  655.         </tr>

  656.       </table>

  657.   </td>

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

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

  660.   </tr>

  661. </table>

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

  663. <p>Implementers's usec delay function </p>

  664. 

  665. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00087">87</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  666. 

  667. </div>

  668. </div>

  669. <a id="a0c9f7d9fc10ac2ceaef93cb6daf8a699"></a>

  670. <h2 class="memtitle"><span class="permalink"><a href="#a0c9f7d9fc10ac2ceaef93cb6daf8a699">&#9670;&nbsp;</a></span>SCL()</h2>

  671. 

  672. <div class="memitem">

  673. <div class="memproto">

  674. <div class="memtemplate">

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

  676. <table class="mlabels">

  677.   <tr>

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

  679.       <table class="memname">

  680.         <tr>

  681.           <td class="memname">void <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::SCL </td>

  682.           <td>(</td>

  683.           <td class="paramtype">uint8_t&#160;</td>

  684.           <td class="paramname"><em>st</em></td><td>)</td>

  685.           <td></td>

  686.         </tr>

  687.       </table>

  688.   </td>

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

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

  691.   </tr>

  692. </table>

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

  694. 

  695. <p>Implementers's scl pin function. </p>

  696. 

  697. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00086">86</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  698. 

  699. </div>

  700. </div>

  701. <a id="aa197be76016b82fd6f8b66875430d922"></a>

  702. <h2 class="memtitle"><span class="permalink"><a href="#aa197be76016b82fd6f8b66875430d922">&#9670;&nbsp;</a></span>SDA()</h2>

  703. 

  704. <div class="memitem">

  705. <div class="memproto">

  706. <div class="memtemplate">

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

  708. <table class="mlabels">

  709.   <tr>

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

  711.       <table class="memname">

  712.         <tr>

  713.           <td class="memname">bool <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::SDA </td>

  714.           <td>(</td>

  715.           <td class="paramtype"><a class="el" href="classutl_1_1i2c__bb__i.html#a4369b434fde250d503bfdc07d5c6a26d">SDAMode</a>&#160;</td>

  716.           <td class="paramname"><em>mode</em>, </td>

  717.         </tr>

  718.         <tr>

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

  720.           <td></td>

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

  722.           <td class="paramname"><em>st</em>&#160;</td>

  723.         </tr>

  724.         <tr>

  725.           <td></td>

  726.           <td>)</td>

  727.           <td></td><td></td>

  728.         </tr>

  729.       </table>

  730.   </td>

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

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

  733.   </tr>

  734. </table>

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

  736. <p>Implementers's sda pin function </p><dl class="params"><dt>Parameters</dt><dd>

  737.   <table class="params">

  738.     <tr><td class="paramname">st</td><td>In SDA_OUTPUT mode, selects the pin output state </td></tr>

  739.   </table>

  740.   </dd>

  741. </dl>

  742. <dl class="section return"><dt>Returns</dt><dd>In SDA_INPUT mode return the pin input state </dd></dl>

  743. 

  744. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00085">85</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  745. 

  746. </div>

  747. </div>

  748. <h2 class="groupheader">Member Data Documentation</h2>

  749. <a id="a9932eded730c8f9a7b1d15988082b699"></a>

  750. <h2 class="memtitle"><span class="permalink"><a href="#a9932eded730c8f9a7b1d15988082b699">&#9670;&nbsp;</a></span>i2c_i&lt; i2c_bb_i&lt; impl_t &gt; &gt;</h2>

  751. 

  752. <div class="memitem">

  753. <div class="memproto">

  754. <div class="memtemplate">

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

  756. <table class="mlabels">

  757.   <tr>

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

  759.       <table class="memname">

  760.         <tr>

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

  762.         </tr>

  763.       </table>

  764.   </td>

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

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

  767.   </tr>

  768. </table>

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

  770. 

  771. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00049">49</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  772. 

  773. </div>

  774. </div>

  775. <a id="a8bd3726104fc91eb8f283d7ffec71cee"></a>

  776. <h2 class="memtitle"><span class="permalink"><a href="#a8bd3726104fc91eb8f283d7ffec71cee">&#9670;&nbsp;</a></span>usec_</h2>

  777. 

  778. <div class="memitem">

  779. <div class="memproto">

  780. <div class="memtemplate">

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

  782. <table class="mlabels">

  783.   <tr>

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

  785.       <table class="memname">

  786.         <tr>

  787.           <td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__bb__i.html">utl::i2c_bb_i</a>&lt; impl_t &gt;::usec_</td>

  788.         </tr>

  789.       </table>

  790.   </td>

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

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

  793.   </tr>

  794. </table>

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

  796. <p>half period of I2C bus </p>

  797. 

  798. <p class="definition">Definition at line <a class="el" href="i2c__bb_8h_source.html#l00102">102</a> of file <a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a>.</p>

  799. 

  800. </div>

  801. </div>

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

  803. <li>include/utl/com/<a class="el" href="i2c__bb_8h_source.html">i2c_bb.h</a></li>

  804. </ul>

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

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

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

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

  809.   <ul>

  810.     <li class="navelem"><a class="el" href="namespaceutl.html">utl</a></li><li class="navelem"><a class="el" href="classutl_1_1i2c__bb__i.html">i2c_bb_i</a></li>

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

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

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

  814.   </ul>

  815. </div>

  816. </body>

  817. </html>