854 lines
42 KiB
HTML
854 lines
42 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uTL: utl::i2c_i< impl_t > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">uTL
|
|
</div>
|
|
<div id="projectbrief">micro Template library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classutl_1_1i2c__i.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="classutl_1_1i2c__i-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">utl::i2c_i< impl_t > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Abstract base class for i2c bus.
|
|
<a href="classutl_1_1i2c__i.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="i2c_8h_source.html">i2c.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a7e2dde443c6c9bde4a2293beb22950c5"><td class="memItemLeft" align="right" valign="top">enum  </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,
|
|
<a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5">Sequence::ACK</a>,
|
|
<a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a7e2dde443c6c9bde4a2293beb22950c5"><td class="mdescLeft"> </td><td class="mdescRight">I2C transmit/receive sequence. <a href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e2dde443c6c9bde4a2293beb22950c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9267a8602702b78f188e0cf61b68a55"><td class="memItemLeft" align="right" valign="top">using </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>< impl_t ></td></tr>
|
|
<tr class="separator:aa9267a8602702b78f188e0cf61b68a55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Get/Set functions</div></td></tr>
|
|
<tr class="memitem:aac5fed816701cc4543acd717ec804ac0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aac5fed816701cc4543acd717ec804ac0">clock</a> () const</td></tr>
|
|
<tr class="separator:aac5fed816701cc4543acd717ec804ac0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4c59938aeeb1f0726195d425a4c0083"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#ae4c59938aeeb1f0726195d425a4c0083">clock</a> (uint32_t f)</td></tr>
|
|
<tr class="memdesc:ae4c59938aeeb1f0726195d425a4c0083"><td class="mdescLeft"> </td><td class="mdescRight">set clock frequency of the bus <a href="#ae4c59938aeeb1f0726195d425a4c0083">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4c59938aeeb1f0726195d425a4c0083"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">User functions</div></td></tr>
|
|
<tr class="memitem:a3591683e5fbf17b582f6ac1f79af871d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a3591683e5fbf17b582f6ac1f79af871d">start</a> ()</td></tr>
|
|
<tr class="memdesc:a3591683e5fbf17b582f6ac1f79af871d"><td class="mdescLeft"> </td><td class="mdescRight">Send start functionality. <a href="#a3591683e5fbf17b582f6ac1f79af871d">More...</a><br /></td></tr>
|
|
<tr class="separator:a3591683e5fbf17b582f6ac1f79af871d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1310b52ac908b8c37059fb253cc3f56e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a1310b52ac908b8c37059fb253cc3f56e">stop</a> ()</td></tr>
|
|
<tr class="memdesc:a1310b52ac908b8c37059fb253cc3f56e"><td class="mdescLeft"> </td><td class="mdescRight">Send stop functionality. <a href="#a1310b52ac908b8c37059fb253cc3f56e">More...</a><br /></td></tr>
|
|
<tr class="separator:a1310b52ac908b8c37059fb253cc3f56e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2f6a579096b4872f5dfd1530e200eda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </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>
|
|
<tr class="memdesc:ab2f6a579096b4872f5dfd1530e200eda"><td class="mdescLeft"> </td><td class="mdescRight">Receive a byte from the i2c bus. <a href="#ab2f6a579096b4872f5dfd1530e200eda">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2f6a579096b4872f5dfd1530e200eda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="memItemLeft" align="right" valign="top">bool </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>
|
|
<tr class="memdesc:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="mdescLeft"> </td><td class="mdescRight">Transmit a byte to the i2c bus. <a href="#aaf0b0ceec57fd8014ea3e6b58e9bfe3d">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf0b0ceec57fd8014ea3e6b58e9bfe3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Object lifetime</div></td></tr>
|
|
<tr class="memitem:a84375c05d1c40d9992aa1290dd488410"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a84375c05d1c40d9992aa1290dd488410">i2c_i</a> ()=default</td></tr>
|
|
<tr class="memdesc:a84375c05d1c40d9992aa1290dd488410"><td class="mdescLeft"> </td><td class="mdescRight">Allow constructor from derived only. <a href="#a84375c05d1c40d9992aa1290dd488410">More...</a><br /></td></tr>
|
|
<tr class="separator:a84375c05d1c40d9992aa1290dd488410"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a07d19db8974ad606031b60a6079957"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a6a07d19db8974ad606031b60a6079957">~i2c_i</a> ()=default</td></tr>
|
|
<tr class="memdesc:a6a07d19db8974ad606031b60a6079957"><td class="mdescLeft"> </td><td class="mdescRight">Allow destructor from derived only. <a href="#a6a07d19db8974ad606031b60a6079957">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a07d19db8974ad606031b60a6079957"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adff01408628f58b7c6ce9b0cd63d70df"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
|
|
<tr class="memdesc:adff01408628f58b7c6ce9b0cd63d70df"><td class="mdescLeft"> </td><td class="mdescRight">No copies. <a href="#adff01408628f58b7c6ce9b0cd63d70df">More...</a><br /></td></tr>
|
|
<tr class="separator:adff01408628f58b7c6ce9b0cd63d70df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee83d11e02c3a0639dd3ed1ea440ed24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> & </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> &)=delete</td></tr>
|
|
<tr class="separator:aee83d11e02c3a0639dd3ed1ea440ed24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a054b6bc43f22e14d4e9feb0772f7ada5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#a054b6bc43f22e14d4e9feb0772f7ada5">_CRTP_IMPL</a> (impl_t)</td></tr>
|
|
<tr class="separator:a054b6bc43f22e14d4e9feb0772f7ada5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Implementation requirements</div></td></tr>
|
|
<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>
|
|
</div></td></tr>
|
|
<tr class="memitem:aefdea61282b9282ae10384951bb4ea51"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aefdea61282b9282ae10384951bb4ea51">_clock</a> () const</td></tr>
|
|
<tr class="memdesc:aefdea61282b9282ae10384951bb4ea51"><td class="mdescLeft"> </td><td class="mdescRight">clock frequency of the bus [Hz] <a href="#aefdea61282b9282ae10384951bb4ea51">More...</a><br /></td></tr>
|
|
<tr class="separator:aefdea61282b9282ae10384951bb4ea51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa0b1552f8fc7c971456fab1ad01242d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#afa0b1552f8fc7c971456fab1ad01242d">_clock</a> (uint32_t c)</td></tr>
|
|
<tr class="memdesc:afa0b1552f8fc7c971456fab1ad01242d"><td class="mdescLeft"> </td><td class="mdescRight">set clock frequency of the bus [Hz] <a href="#afa0b1552f8fc7c971456fab1ad01242d">More...</a><br /></td></tr>
|
|
<tr class="separator:afa0b1552f8fc7c971456fab1ad01242d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af060d656c685c1ab5dd6981c5c88b26d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#af060d656c685c1ab5dd6981c5c88b26d">_start</a> ()</td></tr>
|
|
<tr class="memdesc:af060d656c685c1ab5dd6981c5c88b26d"><td class="mdescLeft"> </td><td class="mdescRight">Send start functionality. <a href="#af060d656c685c1ab5dd6981c5c88b26d">More...</a><br /></td></tr>
|
|
<tr class="separator:af060d656c685c1ab5dd6981c5c88b26d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6202c6c7c1282071ae962fa6bb0f195"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1i2c__i.html#aa6202c6c7c1282071ae962fa6bb0f195">_stop</a> ()</td></tr>
|
|
<tr class="memdesc:aa6202c6c7c1282071ae962fa6bb0f195"><td class="mdescLeft"> </td><td class="mdescRight">Send stop functionality. <a href="#aa6202c6c7c1282071ae962fa6bb0f195">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6202c6c7c1282071ae962fa6bb0f195"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03a25367cdec7ceb76f8de9d5b3145fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </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>
|
|
<tr class="separator:a03a25367cdec7ceb76f8de9d5b3145fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2b164d2c085d5331b627ba711bbb2c9"><td class="memItemLeft" align="right" valign="top">bool </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>
|
|
<tr class="separator:ae2b164d2c085d5331b627ba711bbb2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename impl_t><br />
|
|
class utl::i2c_i< impl_t ></h3>
|
|
|
|
<p>Abstract base class for i2c bus. </p>
|
|
<p>this class force a common interface for I2C communication protocol implementations using CRTP </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">impl_t</td><td>The CRTP type (the derived/implementation class typename). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<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>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="aa9267a8602702b78f188e0cf61b68a55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9267a8602702b78f188e0cf61b68a55">◆ </a></span>type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::<a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> = <a class="el" href="classutl_1_1i2c__i.html">i2c_i</a><impl_t></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Export type as identity meta-function </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a7e2dde443c6c9bde4a2293beb22950c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e2dde443c6c9bde4a2293beb22950c5">◆ </a></span>Sequence</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">utl::i2c_i::Sequence</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>I2C transmit/receive sequence. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5ae409eb2ba6eb6801f52763ae370c350e"></a>BYTE </td><td class="fielddoc"><p>Only read/write byte [8 clocks]. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5a0fc437bc317835cad5faafc12a83fad5"></a>ACK </td><td class="fielddoc"><p>Only send/receive ack [1 clock]. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce"></a>BYTEnACK </td><td class="fielddoc"><p>Read/Write byte and ack [9 clocks]. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a84375c05d1c40d9992aa1290dd488410"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84375c05d1c40d9992aa1290dd488410">◆ </a></span>i2c_i() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allow constructor from derived only. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a07d19db8974ad606031b60a6079957"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a07d19db8974ad606031b60a6079957">◆ </a></span>~i2c_i()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::~<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allow destructor from derived only. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adff01408628f58b7c6ce9b0cd63d70df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adff01408628f58b7c6ce9b0cd63d70df">◆ </a></span>i2c_i() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::<a class="el" href="classutl_1_1i2c__i.html">i2c_i</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No copies. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aefdea61282b9282ae10384951bb4ea51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefdea61282b9282ae10384951bb4ea51">◆ </a></span>_clock() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_clock </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>clock frequency of the bus [Hz] </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa0b1552f8fc7c971456fab1ad01242d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa0b1552f8fc7c971456fab1ad01242d">◆ </a></span>_clock() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_clock </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>c</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set clock frequency of the bus [Hz] </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a054b6bc43f22e14d4e9feb0772f7ada5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a054b6bc43f22e14d4e9feb0772f7ada5">◆ </a></span>_CRTP_IMPL()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_CRTP_IMPL </td>
|
|
<td>(</td>
|
|
<td class="paramtype">impl_t </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03a25367cdec7ceb76f8de9d5b3145fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03a25367cdec7ceb76f8de9d5b3145fb">◆ </a></span>_rx_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<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>< impl_t >::_rx_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ack</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> </td>
|
|
<td class="paramname"><em>seq</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af060d656c685c1ab5dd6981c5c88b26d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af060d656c685c1ab5dd6981c5c88b26d">◆ </a></span>_start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_start </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send start functionality. </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6202c6c7c1282071ae962fa6bb0f195"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6202c6c7c1282071ae962fa6bb0f195">◆ </a></span>_stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_stop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send stop functionality. </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2b164d2c085d5331b627ba711bbb2c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2b164d2c085d5331b627ba711bbb2c9">◆ </a></span>_tx_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::_tx_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </td>
|
|
<td class="paramname"><em>byte</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> </td>
|
|
<td class="paramname"><em>seq</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac5fed816701cc4543acd717ec804ac0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac5fed816701cc4543acd717ec804ac0">◆ </a></span>clock() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::clock </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>clock frequency of the bus </dd></dl>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4c59938aeeb1f0726195d425a4c0083"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4c59938aeeb1f0726195d425a4c0083">◆ </a></span>clock() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::clock </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>f</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set clock frequency of the bus </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee83d11e02c3a0639dd3ed1ea440ed24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee83d11e02c3a0639dd3ed1ea440ed24">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a>& <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classutl_1_1i2c__i.html#aa9267a8602702b78f188e0cf61b68a55">type</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2f6a579096b4872f5dfd1530e200eda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2f6a579096b4872f5dfd1530e200eda">◆ </a></span>rx_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<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>< impl_t >::rx_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ack</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> </td>
|
|
<td class="paramname"><em>seq</em> = <code><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive a byte from the i2c bus. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ack</td><td>Optional ack bit. <ul>
|
|
<li>1 ACK the reception </li>
|
|
<li>0 Don't ACK the reception. </li>
|
|
</ul>
|
|
</td></tr>
|
|
<tr><td class="paramname">seq</td><td>The operation sequence to execute <ul>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The byte received. </dd></dl>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3591683e5fbf17b582f6ac1f79af871d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3591683e5fbf17b582f6ac1f79af871d">◆ </a></span>start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::start </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send start functionality. </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1310b52ac908b8c37059fb253cc3f56e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1310b52ac908b8c37059fb253cc3f56e">◆ </a></span>stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::stop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send stop functionality. </p>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf0b0ceec57fd8014ea3e6b58e9bfe3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf0b0ceec57fd8014ea3e6b58e9bfe3d">◆ </a></span>tx_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename impl_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classutl_1_1i2c__i.html">utl::i2c_i</a>< impl_t >::tx_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </td>
|
|
<td class="paramname"><em>byte</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5">Sequence</a> </td>
|
|
<td class="paramname"><em>seq</em> = <code><a class="el" href="classutl_1_1i2c__i.html#a7e2dde443c6c9bde4a2293beb22950c5a01af7e5aa5863a91810dd4e5d0e383ce">Sequence::BYTEnACK</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Transmit a byte to the i2c bus. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">byte</td><td>The byte to send. </td></tr>
|
|
<tr><td class="paramname">seq</td><td>The operation sequence to execute <ul>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Slave's ACK bit <ul>
|
|
<li>false Slave didn't ACK </li>
|
|
<li>true Slave did ACK </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/utl/com/<a class="el" href="i2c_8h_source.html">i2c.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<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>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|