<!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::spi_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_1spi__iface.html">spi_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_1spi__iface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::spi_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>
<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:a5c449b4d49d7d0bb616d6d840eda403f"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
< <a class="el" href="classuhd_1_1spi__iface.html">spi_iface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1spi__iface.html#a5c449b4d49d7d0bb616d6d840eda403f">sptr</a></td></tr>
<tr class="separator:a5c449b4d49d7d0bb616d6d840eda403f"><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:a5bf64a423056fdbf68b4f2450fc23527"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1spi__iface.html#a5bf64a423056fdbf68b4f2450fc23527">~spi_iface</a> (void)</td></tr>
<tr class="separator:a5bf64a423056fdbf68b4f2450fc23527"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd38a61ccfb059cbe554c1cecc7a9c17"><td class="memItemLeft" align="right" valign="top">virtual boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1spi__iface.html#acd38a61ccfb059cbe554c1cecc7a9c17">transact_spi</a> (int which_slave, const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> &config, boost::uint32_t data, size_t num_bits, bool readback)=0</td></tr>
<tr class="separator:acd38a61ccfb059cbe554c1cecc7a9c17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb4374ac666a4db6e8c3ede07a2f61a3"><td class="memItemLeft" align="right" valign="top">virtual boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1spi__iface.html#afb4374ac666a4db6e8c3ede07a2f61a3">read_spi</a> (int which_slave, const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> &config, boost::uint32_t data, size_t num_bits)</td></tr>
<tr class="separator:afb4374ac666a4db6e8c3ede07a2f61a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7203e52487d0493b3305e2bf45cbc88c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1spi__iface.html#a7203e52487d0493b3305e2bf45cbc88c">write_spi</a> (int which_slave, const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> &config, boost::uint32_t data, size_t num_bits)</td></tr>
<tr class="separator:a7203e52487d0493b3305e2bf45cbc88c"><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 SPI interface class. Provides routines to transact SPI and do other useful things which haven't been defined yet. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a5c449b4d49d7d0bb616d6d840eda403f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::shared_ptr<<a class="el" href="classuhd_1_1spi__iface.html">spi_iface</a>> <a class="el" href="classuhd_1_1spi__iface.html#a5c449b4d49d7d0bb616d6d840eda403f">uhd::spi_iface::sptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5bf64a423056fdbf68b4f2450fc23527"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uhd::spi_iface::~spi_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="afb4374ac666a4db6e8c3ede07a2f61a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::uint32_t uhd::spi_iface::read_spi </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_slave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> & </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_bits</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 from the SPI bus. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">which_slave</td><td>the slave device number </td></tr>
<tr><td class="paramname">config</td><td>spi config args </td></tr>
<tr><td class="paramname">data</td><td>the bits to write out (be sure to set write bit) </td></tr>
<tr><td class="paramname">num_bits</td><td>how many bits in data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>spi data </dd></dl>
</div>
</div>
<a class="anchor" id="acd38a61ccfb059cbe554c1cecc7a9c17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::uint32_t uhd::spi_iface::transact_spi </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_slave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> & </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_bits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>readback</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>Perform a spi transaction. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">which_slave</td><td>the slave device number </td></tr>
<tr><td class="paramname">config</td><td>spi config args </td></tr>
<tr><td class="paramname">data</td><td>the bits to write </td></tr>
<tr><td class="paramname">num_bits</td><td>how many bits in data </td></tr>
<tr><td class="paramname">readback</td><td>true to readback a value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>spi data if readback set </dd></dl>
</div>
</div>
<a class="anchor" id="a7203e52487d0493b3305e2bf45cbc88c"></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::spi_iface::write_spi </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_slave</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structuhd_1_1spi__config__t.html">spi_config_t</a> & </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_bits</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 to the SPI bus. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">which_slave</td><td>the slave device number </td></tr>
<tr><td class="paramname">config</td><td>spi config args </td></tr>
<tr><td class="paramname">data</td><td>the bits to write </td></tr>
<tr><td class="paramname">num_bits</td><td>how many bits in data </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>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
eb4b034508697cc17e7c9cfffe7f772b
>
files
>
73
