<!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.8"/>
<title>UHD: uhd::i2c_iface Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">UHD
 <span id="projectnumber">003.007.002-0-unknown</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="classuhd_1_1i2c__iface.html">i2c_iface</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classuhd_1_1i2c__iface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::i2c_iface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="serial_8hpp_source.html">serial.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::i2c_iface:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1i2c__iface.png" usemap="#uhd::i2c_iface_map" alt=""/>
<map id="uhd::i2c_iface_map" name="uhd::i2c_iface_map">
<area href="classuhd_1_1usrp_1_1dboard__iface.html" alt="uhd::usrp::dboard_iface" shape="rect" coords="0,56,145,80"/>
</map>
</div></div>
<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:a65140bfd1527b10f13cb1e5a37f3a3e9"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
< <a class="el" href="classuhd_1_1i2c__iface.html">i2c_iface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#a65140bfd1527b10f13cb1e5a37f3a3e9">sptr</a></td></tr>
<tr class="separator:a65140bfd1527b10f13cb1e5a37f3a3e9"><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 class="memitem:a9c84f3853f743914395e7036f940d6f0"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#a9c84f3853f743914395e7036f940d6f0">~i2c_iface</a> (void)</td></tr>
<tr class="separator:a9c84f3853f743914395e7036f940d6f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb67ce0ae3254672299cc6b1333e7643"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuhd_1_1i2c__iface.html#a65140bfd1527b10f13cb1e5a37f3a3e9">i2c_iface::sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#abb67ce0ae3254672299cc6b1333e7643">eeprom16</a> (void)</td></tr>
<tr class="memdesc:abb67ce0ae3254672299cc6b1333e7643"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="classuhd_1_1i2c__iface.html">i2c_iface</a> than can talk to 16 bit addressable EEPROMS. <a href="#abb67ce0ae3254672299cc6b1333e7643">More...</a><br /></td></tr>
<tr class="separator:abb67ce0ae3254672299cc6b1333e7643"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bfa577ef3bb00b23e0f5a75f8f0eb02"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#a7bfa577ef3bb00b23e0f5a75f8f0eb02">write_i2c</a> (boost::uint16_t addr, const <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> &buf)=0</td></tr>
<tr class="separator:a7bfa577ef3bb00b23e0f5a75f8f0eb02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a842bbd12a36944ab535d261de4c7351f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#a842bbd12a36944ab535d261de4c7351f">read_i2c</a> (boost::uint16_t addr, size_t num_bytes)=0</td></tr>
<tr class="separator:a842bbd12a36944ab535d261de4c7351f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abba85e1ebfb81b9f97c3fa48b3c90d05"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#abba85e1ebfb81b9f97c3fa48b3c90d05">write_eeprom</a> (boost::uint16_t addr, boost::uint16_t offset, const <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> &buf)</td></tr>
<tr class="separator:abba85e1ebfb81b9f97c3fa48b3c90d05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc006c74f60aecbbcfbe099f44cc257c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1i2c__iface.html#afc006c74f60aecbbcfbe099f44cc257c">read_eeprom</a> (boost::uint16_t addr, boost::uint16_t offset, size_t num_bytes)</td></tr>
<tr class="separator:afc006c74f60aecbbcfbe099f44cc257c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The i2c interface class: Provides i2c and eeprom functionality. A subclass should only have to implement the i2c routines. An eeprom implementation comes for free with the interface.</p>
<p>The eeprom routines are implemented on top of i2c. The built in eeprom implementation only does single byte reads and byte writes over the i2c interface, so it should be portable across multiple eeproms. Override the eeprom routines if this is not acceptable. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a65140bfd1527b10f13cb1e5a37f3a3e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::shared_ptr<<a class="el" href="classuhd_1_1i2c__iface.html">i2c_iface</a>> <a class="el" href="classuhd_1_1i2c__iface.html#a65140bfd1527b10f13cb1e5a37f3a3e9">uhd::i2c_iface::sptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9c84f3853f743914395e7036f940d6f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uhd::i2c_iface::~i2c_iface </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abb67ce0ae3254672299cc6b1333e7643"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuhd_1_1i2c__iface.html#a65140bfd1527b10f13cb1e5a37f3a3e9">i2c_iface::sptr</a> uhd::i2c_iface::eeprom16 </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an <a class="el" href="classuhd_1_1i2c__iface.html">i2c_iface</a> than can talk to 16 bit addressable EEPROMS. </p>
</div>
</div>
<a class="anchor" id="afc006c74f60aecbbcfbe099f44cc257c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> uhd::i2c_iface::read_eeprom </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_bytes</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read bytes from an eeprom. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>the address </td></tr>
<tr><td class="paramname">offset</td><td>byte offset </td></tr>
<tr><td class="paramname">num_bytes</td><td>number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a vector of bytes </dd></dl>
</div>
</div>
<a class="anchor" id="a842bbd12a36944ab535d261de4c7351f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> uhd::i2c_iface::read_i2c </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_bytes</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read bytes over the i2c. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>the address </td></tr>
<tr><td class="paramname">num_bytes</td><td>number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a vector of bytes </dd></dl>
</div>
</div>
<a class="anchor" id="abba85e1ebfb81b9f97c3fa48b3c90d05"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uhd::i2c_iface::write_eeprom </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> & </td>
<td class="paramname"><em>buf</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write bytes to an eeprom. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>the address </td></tr>
<tr><td class="paramname">offset</td><td>byte offset </td></tr>
<tr><td class="paramname">buf</td><td>the vector of bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7bfa577ef3bb00b23e0f5a75f8f0eb02"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uhd::i2c_iface::write_i2c </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceuhd.html#ae9056b4bb9e7a6c9ed57bf5bb4b8e893">byte_vector_t</a> & </td>
<td class="paramname"><em>buf</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write bytes over the i2c. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>the address </td></tr>
<tr><td class="paramname">buf</td><td>the vector of bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/types/<a class="el" href="serial_8hpp_source.html">serial.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
