<!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"/>
<title>GNU Radio 3.2.2 C++ API: usrp2.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('usrp2_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>usrp2.h</h1> </div>
</div>
<div class="contents">
<a href="usrp2_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2008,2009 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This program is free software: you can redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00007"></a>00007 <span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment"> * (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef INCLUDED_USRP2_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <boost/utility.hpp></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <vector></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <complex></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <usrp2/rx_sample_handler.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <usrp2/tune_result.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <usrp2/mimo_config.h></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="comment">/*</span>
<a name="l00031"></a>00031 <span class="comment"> * N.B., The interfaces described here are still in flux.</span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * We will keep all the code in the tree up-to-date with regard to changes</span>
<a name="l00034"></a>00034 <span class="comment"> * here, but reserve the right to change this on a whim.</span>
<a name="l00035"></a>00035 <span class="comment"> */</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>usrp2 {
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /*!</span>
<a name="l00040"></a>00040 <span class="comment"> * Structure to hold properties of USRP2 hardware devices.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a><a class="code" href="structusrp2_1_1props.html">00043</a> <span class="keyword">struct </span><a class="code" href="structusrp2_1_1props.html">props</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a><a class="code" href="structusrp2_1_1props.html#a68f808bb509f8e747ef158ca1deb6dd3">00045</a> std::string <a class="code" href="structusrp2_1_1props.html#a68f808bb509f8e747ef158ca1deb6dd3">addr</a>;
<a name="l00046"></a><a class="code" href="structusrp2_1_1props.html#a34d7a472bc6e086edf5ff4c2c8628eb7">00046</a> uint16_t <a class="code" href="structusrp2_1_1props.html#a34d7a472bc6e086edf5ff4c2c8628eb7">hw_rev</a>;
<a name="l00047"></a><a class="code" href="structusrp2_1_1props.html#ab3227a2e89df87d51103c33b5c435db0">00047</a> uint8_t <a class="code" href="structusrp2_1_1props.html#ab3227a2e89df87d51103c33b5c435db0">fpga_md5sum</a>[16];
<a name="l00048"></a><a class="code" href="structusrp2_1_1props.html#a80005b3cb1f7dc9e3719c0bc33210680">00048</a> uint8_t <a class="code" href="structusrp2_1_1props.html#a80005b3cb1f7dc9e3719c0bc33210680">sw_md5sum</a>[16];
<a name="l00049"></a>00049 };
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">typedef</span> <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<props></a> <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">props_vector_t</a>;
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /*!</span>
<a name="l00054"></a>00054 <span class="comment"> * \brief Search the ethernet for all USRP2s or for a specific USRP2.</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment"> * \param ifc is the name of the OS ethernet interface (e.g., "eth0")</span>
<a name="l00057"></a>00057 <span class="comment"> * \param mac_addr is the MAC address of the desired USRP2, or "" to search for all.</span>
<a name="l00058"></a>00058 <span class="comment"> * mac_addr must be either a zero length string, "", or must be of the form</span>
<a name="l00059"></a>00059 <span class="comment"> * "01:02:03:04:05:06" or "05:06".</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * \returns a vector of properties, 1 entry for each matching USRP2 found.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">props_vector_t</a> find(<span class="keyword">const</span> std::string &ifc, <span class="keyword">const</span> std::string &mac_addr=<span class="stringliteral">""</span>);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">class </span><a class="code" href="classusrp2_1_1tune__result.html">tune_result</a>;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// FIXME: get from firmware include</span>
<a name="l00068"></a>00068 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GPIO_TX_BANK = 0;
<a name="l00069"></a>00069 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GPIO_RX_BANK = 1;
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /*!</span>
<a name="l00072"></a>00072 <span class="comment"> * \brief standard C++ interface to USRP2</span>
<a name="l00073"></a>00073 <span class="comment"> * \ingroup usrp2</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a><a class="code" href="classusrp2_1_1usrp2.html">00075</a> <span class="keyword">class </span><a class="code" href="classusrp2_1_1usrp2.html" title="standard C++ interface to USRP2">usrp2</a> : boost::noncopyable
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <span class="keyword">public</span>:
<a name="l00078"></a><a class="code" href="classusrp2_1_1usrp2.html#a0e992c0ab2d8b0c8a99723ed9fe55d2e">00078</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1usrp2.html#a0e992c0ab2d8b0c8a99723ed9fe55d2e">MAX_CHAN</a> = 30;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /*!</span>
<a name="l00081"></a>00081 <span class="comment"> * Shared pointer to this class</span>
<a name="l00082"></a>00082 <span class="comment"> */</span>
<a name="l00083"></a><a class="code" href="classusrp2_1_1usrp2.html#a495be65b27a7096b8de897b0a033c3ab">00083</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<usrp2></a> <a class="code" href="classusrp2_1_1usrp2.html#a495be65b27a7096b8de897b0a033c3ab">sptr</a>;
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /*! </span>
<a name="l00086"></a>00086 <span class="comment"> * Static function to return an instance of usrp2 as a shared pointer</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> * \param ifc Network interface name, e.g., "eth0"</span>
<a name="l00089"></a>00089 <span class="comment"> * \param addr Network mac address, e.g., "01:23:45:67:89:ab", "89:ab" or "".</span>
<a name="l00090"></a>00090 <span class="comment"> * If \p addr is HH:HH, it's treated as if it were 00:50:c2:85:HH:HH</span>
<a name="l00091"></a>00091 <span class="comment"> * "" will autoselect a USRP2 if there is only a single one on the local ethernet.</span>
<a name="l00092"></a>00092 <span class="comment"> * \param rx_bufsize is the length in bytes of the kernel networking buffer to allocate.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html">sptr</a> <a class="code" href="classusrp2_1_1usrp2.html#aca00b5a1e9ff0b801e321bd6a3250d92">make</a>(<span class="keyword">const</span> std::string &ifc, <span class="keyword">const</span> std::string &addr=<span class="stringliteral">""</span>, <span class="keywordtype">size_t</span> rx_bufsize=0);
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment"> /*!</span>
<a name="l00097"></a>00097 <span class="comment"> * Class destructor</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 <a class="code" href="classusrp2_1_1usrp2.html#a40577de9cf7226d231e048bd8f66cbec">~usrp2</a>();
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /*!</span>
<a name="l00102"></a>00102 <span class="comment"> * Returns the MAC address associated with this USRP</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 std::string <a class="code" href="classusrp2_1_1usrp2.html#a94b9b36e7740874af7fae96198bbbb46">mac_addr</a>();
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /*!</span>
<a name="l00107"></a>00107 <span class="comment"> * Returns the GbE interface name associated with this USRP</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 std::string <a class="code" href="classusrp2_1_1usrp2.html#adaf0f547244415fc982a7b177358ca11">interface_name</a>();
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">/*</span>
<a name="l00112"></a>00112 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00113"></a>00113 <span class="comment"> * Rx configuration and control</span>
<a name="l00114"></a>00114 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /*!</span>
<a name="l00118"></a>00118 <span class="comment"> * Set receiver gain</span>
<a name="l00119"></a>00119 <span class="comment"> * \param gain in dB (more or less)</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#ac2726fe4d9071afeb5fde690d31fe7bc">set_rx_gain</a>(<span class="keywordtype">double</span> gain);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> //! return minimum Rx gain </span>
<a name="l00124"></a>00124 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#ac75be9cf7591eb34ee20a9c8a2bb7737" title="return minimum Rx gain">rx_gain_min</a>();
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment"> //! return maximum Rx gain </span>
<a name="l00127"></a>00127 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#ae371035411d10fab287fbcdac98ff5f5" title="return maximum Rx gain">rx_gain_max</a>();
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment"> //! return Rx gain db_per_step</span>
<a name="l00130"></a>00130 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a48a79f89af26ef21cfdb168527946b0b" title="return Rx gain db_per_step">rx_gain_db_per_step</a>();
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /*!</span>
<a name="l00133"></a>00133 <span class="comment"> * \brief Set receive daughterboard LO offset frequency</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a>00135 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a26ca99959366c7d2ceba3df8435a89e5" title="Set receive daughterboard LO offset frequency.">set_rx_lo_offset</a>(<span class="keywordtype">double</span> frequency);
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment"> /*!</span>
<a name="l00138"></a>00138 <span class="comment"> * Set receiver center frequency</span>
<a name="l00139"></a>00139 <span class="comment"> */</span>
<a name="l00140"></a>00140 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a64706690819e7d25c85a3c2bb3171100">set_rx_center_freq</a>(<span class="keywordtype">double</span> frequency, <a class="code" href="classusrp2_1_1tune__result.html">tune_result</a> *result);
<a name="l00141"></a>00141 <span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment"> //! return minimum Rx center frequency</span>
<a name="l00143"></a>00143 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a1acb81b5b6bcff145ab35be1c72d5114" title="return minimum Rx center frequency">rx_freq_min</a>();
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment"> //! return maximum Rx center frequency</span>
<a name="l00146"></a>00146 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#ac0bbc275573f647df2d898051fe60e8a" title="return maximum Rx center frequency">rx_freq_max</a>();
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment"> /*!</span>
<a name="l00149"></a>00149 <span class="comment"> * Set receiver sample rate decimation</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a0e4330e851a12f2de3044a9abeb5125f">set_rx_decim</a>(<span class="keywordtype">int</span> decimation_factor);
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment"> //! Return current decimation factor</span>
<a name="l00154"></a>00154 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1usrp2.html#a67b1f9df5af54a95db4e68adb85d53c3" title="Return current decimation factor.">rx_decim</a>();
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment"> /*!</span>
<a name="l00157"></a>00157 <span class="comment"> * Set receiver IQ magnitude scaling</span>
<a name="l00158"></a>00158 <span class="comment"> */</span>
<a name="l00159"></a>00159 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#ac77b97e74940641d531f204422656ea3">set_rx_scale_iq</a>(<span class="keywordtype">int</span> scale_i, <span class="keywordtype">int</span> scale_q);
<a name="l00160"></a>00160 <span class="comment"></span>
<a name="l00161"></a>00161 <span class="comment"> /*!</span>
<a name="l00162"></a>00162 <span class="comment"> * Set received sample format</span>
<a name="l00163"></a>00163 <span class="comment"> * </span>
<a name="l00164"></a>00164 <span class="comment"> * domain: complex or real</span>
<a name="l00165"></a>00165 <span class="comment"> * type: floating, fixed point, or raw</span>
<a name="l00166"></a>00166 <span class="comment"> * depth: bits per sample</span>
<a name="l00167"></a>00167 <span class="comment"> *</span>
<a name="l00168"></a>00168 <span class="comment"> * Sets format over the wire for samples from USRP2.</span>
<a name="l00169"></a>00169 <span class="comment"> */</span>
<a name="l00170"></a>00170 <span class="comment">// bool set_rx_format(...);</span>
<a name="l00171"></a>00171 <span class="comment"></span>
<a name="l00172"></a>00172 <span class="comment"> /*!</span>
<a name="l00173"></a>00173 <span class="comment"> * Start streaming receive mode. USRP2 will send a continuous stream of</span>
<a name="l00174"></a>00174 <span class="comment"> * DSP pipeline samples to host. Call rx_samples(...) to access.</span>
<a name="l00175"></a>00175 <span class="comment"> * </span>
<a name="l00176"></a>00176 <span class="comment"> * \param channel Stream channel number (0-30)</span>
<a name="l00177"></a>00177 <span class="comment"> * \param items_per_frame Number of 32-bit items per frame.</span>
<a name="l00178"></a>00178 <span class="comment"> */</span>
<a name="l00179"></a>00179 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a99811f59a38aa3097e0be6196cf3790a">start_rx_streaming</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel=0, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> items_per_frame=0);
<a name="l00180"></a>00180 <span class="comment"></span>
<a name="l00181"></a>00181 <span class="comment"> /*!</span>
<a name="l00182"></a>00182 <span class="comment"> * Stop streaming receive mode.</span>
<a name="l00183"></a>00183 <span class="comment"> */</span>
<a name="l00184"></a>00184 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a75c9dc7c14da792f8fb6a73b8caaabb1">stop_rx_streaming</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel=0);
<a name="l00185"></a>00185 <span class="comment"></span>
<a name="l00186"></a>00186 <span class="comment"> /*!</span>
<a name="l00187"></a>00187 <span class="comment"> * \brief Receive data from the specified channel</span>
<a name="l00188"></a>00188 <span class="comment"> * This method is used to receive all data: streaming or discrete.</span>
<a name="l00189"></a>00189 <span class="comment"> */</span>
<a name="l00190"></a>00190 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#adc5c23804bb1277b89ec51c519275c42" title="Receive data from the specified channel This method is used to receive all data: streaming or discret...">rx_samples</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel, <a class="code" href="classusrp2_1_1rx__sample__handler.html" title="Abstract function object called to handle received data blocks.An object derived from this class is p...">rx_sample_handler</a> *handler);
<a name="l00191"></a>00191 <span class="comment"></span>
<a name="l00192"></a>00192 <span class="comment"> /*!</span>
<a name="l00193"></a>00193 <span class="comment"> * Returns number of times receive overruns have occurred</span>
<a name="l00194"></a>00194 <span class="comment"> */</span>
<a name="l00195"></a>00195 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1usrp2.html#a268b49a605a2cc001e753052b91367a1">rx_overruns</a>();
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment"> /*!</span>
<a name="l00198"></a>00198 <span class="comment"> * Returns total number of missing frames from overruns.</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1usrp2.html#a4586604bf3d2614e5d7533e22549aaa9">rx_missing</a>();
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment">/*</span>
<a name="l00203"></a>00203 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00204"></a>00204 <span class="comment"> * Tx configuration and control</span>
<a name="l00205"></a>00205 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207 <span class="comment"></span>
<a name="l00208"></a>00208 <span class="comment"> /*!</span>
<a name="l00209"></a>00209 <span class="comment"> * Set transmitter gain</span>
<a name="l00210"></a>00210 <span class="comment"> */</span>
<a name="l00211"></a>00211 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a8f3512a284bcdb566e9f33d2b58eec7c">set_tx_gain</a>(<span class="keywordtype">double</span> gain);
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment"> //! return minimum Tx gain </span>
<a name="l00214"></a>00214 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a0534b619c93788c66686268983da34c7" title="return minimum Tx gain">tx_gain_min</a>();
<a name="l00215"></a>00215 <span class="comment"></span>
<a name="l00216"></a>00216 <span class="comment"> //! return maximum Tx gain </span>
<a name="l00217"></a>00217 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#abfd17a980f1450e4c6cb9bfb9a54d413" title="return maximum Tx gain">tx_gain_max</a>();
<a name="l00218"></a>00218 <span class="comment"></span>
<a name="l00219"></a>00219 <span class="comment"> //! return Tx gain db_per_step</span>
<a name="l00220"></a>00220 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a17abc39bc29e3d1d13e7d8082e1e577a" title="return Tx gain db_per_step">tx_gain_db_per_step</a>();
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="comment">/*</span>
<a name="l00223"></a>00223 <span class="comment"> * \brief Set transmit daughterboard LO offset frequency</span>
<a name="l00224"></a>00224 <span class="comment"> */</span>
<a name="l00225"></a>00225 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aca5cd4b1f1943c17b93e664c441d7126">set_tx_lo_offset</a>(<span class="keywordtype">double</span> frequency);
<a name="l00226"></a>00226 <span class="comment"></span>
<a name="l00227"></a>00227 <span class="comment"> /*!</span>
<a name="l00228"></a>00228 <span class="comment"> * Set transmitter center frequency</span>
<a name="l00229"></a>00229 <span class="comment"> */</span>
<a name="l00230"></a>00230 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a187858c2d829c319f44a1e3db6ca38d8">set_tx_center_freq</a>(<span class="keywordtype">double</span> frequency, <a class="code" href="classusrp2_1_1tune__result.html">tune_result</a> *result);
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment"> //! return minimum Tx center frequency</span>
<a name="l00233"></a>00233 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a23803477520e7d6a470c445c70a2c60b" title="return minimum Tx center frequency">tx_freq_min</a>();
<a name="l00234"></a>00234 <span class="comment"></span>
<a name="l00235"></a>00235 <span class="comment"> //! return maximum Tx center frequency</span>
<a name="l00236"></a>00236 <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classusrp2_1_1usrp2.html#a21a76cc4ab69185d796bf5602c9cb8ff" title="return maximum Tx center frequency">tx_freq_max</a>();
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment"> /*!</span>
<a name="l00239"></a>00239 <span class="comment"> * Set transmitter sample rate interpolation</span>
<a name="l00240"></a>00240 <span class="comment"> */</span>
<a name="l00241"></a>00241 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a97a89168fa7801f6681c499210cc08f3">set_tx_interp</a>(<span class="keywordtype">int</span> interpolation_factor);
<a name="l00242"></a>00242 <span class="comment"></span>
<a name="l00243"></a>00243 <span class="comment"> //! Return current interpolation factor</span>
<a name="l00244"></a>00244 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1usrp2.html#afcd40f8eb490f95f3b88e403beb95db7" title="Return current interpolation factor.">tx_interp</a>();
<a name="l00245"></a>00245
<a name="l00246"></a>00246 <span class="comment">/*</span>
<a name="l00247"></a>00247 <span class="comment"> * \brief Calculate default scale_iq for given interpolation rate</span>
<a name="l00248"></a>00248 <span class="comment"> */</span>
<a name="l00249"></a>00249 <span class="keywordtype">void</span> <a class="code" href="classusrp2_1_1usrp2.html#a4cf2cc57c170200e09b45da8f82b990b">default_tx_scale_iq</a>(<span class="keywordtype">int</span> interpolation_factor, <span class="keywordtype">int</span> *scale_i, <span class="keywordtype">int</span> *scale_q);
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment"> /*!</span>
<a name="l00252"></a>00252 <span class="comment"> * Set transmit IQ magnitude scaling</span>
<a name="l00253"></a>00253 <span class="comment"> */</span>
<a name="l00254"></a>00254 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aa458137a015f61fb400e626b594e2852">set_tx_scale_iq</a>(<span class="keywordtype">int</span> scale_i, <span class="keywordtype">int</span> scale_q);
<a name="l00255"></a>00255 <span class="comment"></span>
<a name="l00256"></a>00256 <span class="comment"> /*!</span>
<a name="l00257"></a>00257 <span class="comment"> * Set transmit sample format</span>
<a name="l00258"></a>00258 <span class="comment"> * </span>
<a name="l00259"></a>00259 <span class="comment"> * domain: complex or real</span>
<a name="l00260"></a>00260 <span class="comment"> * type: floating, fixed point, or raw</span>
<a name="l00261"></a>00261 <span class="comment"> * depth: bits per sample</span>
<a name="l00262"></a>00262 <span class="comment"> *</span>
<a name="l00263"></a>00263 <span class="comment"> * Sets format over the wire for samples to USRP2.</span>
<a name="l00264"></a>00264 <span class="comment"> */</span>
<a name="l00265"></a>00265 <span class="comment">// bool set_tx_format(...);</span>
<a name="l00266"></a>00266 <span class="comment"></span>
<a name="l00267"></a>00267 <span class="comment"> /*!</span>
<a name="l00268"></a>00268 <span class="comment"> * \brief transmit complex<float> samples to USRP2</span>
<a name="l00269"></a>00269 <span class="comment"> *</span>
<a name="l00270"></a>00270 <span class="comment"> * \param channel specifies the channel to send them to</span>
<a name="l00271"></a>00271 <span class="comment"> * \param samples are the samples to transmit. They should be in the range [-1.0, +1.0]</span>
<a name="l00272"></a>00272 <span class="comment"> * \param nsamples is the number of samples to transmit</span>
<a name="l00273"></a>00273 <span class="comment"> * \param metadata provides the timestamp and flags</span>
<a name="l00274"></a>00274 <span class="comment"> *</span>
<a name="l00275"></a>00275 <span class="comment"> * The complex<float> samples are converted to the appropriate </span>
<a name="l00276"></a>00276 <span class="comment"> * "on the wire" representation, depending on the current USRP2</span>
<a name="l00277"></a>00277 <span class="comment"> * configuration. Typically, this is big-endian 16-bit I & Q.</span>
<a name="l00278"></a>00278 <span class="comment"> */</span>
<a name="l00279"></a>00279 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a6a11fb6a5567d69e584cf16b02e510ca" title="transmit complex&lt;float&gt; samples to USRP2">tx_32fc</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel,
<a name="l00280"></a>00280 <span class="keyword">const</span> std::complex<float> *samples,
<a name="l00281"></a>00281 <span class="keywordtype">size_t</span> nsamples,
<a name="l00282"></a>00282 <span class="keyword">const</span> <a class="code" href="structusrp2_1_1tx__metadata.html" title="metadata associated with transmitted frames">tx_metadata</a> *metadata);
<a name="l00283"></a>00283 <span class="comment"></span>
<a name="l00284"></a>00284 <span class="comment"> /*!</span>
<a name="l00285"></a>00285 <span class="comment"> * \brief transmit complex<int16_t> samples to USRP2</span>
<a name="l00286"></a>00286 <span class="comment"> *</span>
<a name="l00287"></a>00287 <span class="comment"> * \param channel specifies the channel to send them to</span>
<a name="l00288"></a>00288 <span class="comment"> * \param samples are the samples to transmit</span>
<a name="l00289"></a>00289 <span class="comment"> * \param nsamples is the number of samples to transmit</span>
<a name="l00290"></a>00290 <span class="comment"> * \param metadata provides the timestamp and flags</span>
<a name="l00291"></a>00291 <span class="comment"> *</span>
<a name="l00292"></a>00292 <span class="comment"> * The complex<int16_t> samples are converted to the appropriate</span>
<a name="l00293"></a>00293 <span class="comment"> * "on the wire" representation, depending on the current USRP2</span>
<a name="l00294"></a>00294 <span class="comment"> * configuration. Typically, this is big-endian 16-bit I & Q.</span>
<a name="l00295"></a>00295 <span class="comment"> */</span>
<a name="l00296"></a>00296 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aa90bd651ad3c2750dccff12444b48282" title="transmit complex&lt;int16_t&gt; samples to USRP2">tx_16sc</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel,
<a name="l00297"></a>00297 <span class="keyword">const</span> std::complex<int16_t> *samples,
<a name="l00298"></a>00298 <span class="keywordtype">size_t</span> nsamples,
<a name="l00299"></a>00299 <span class="keyword">const</span> <a class="code" href="structusrp2_1_1tx__metadata.html" title="metadata associated with transmitted frames">tx_metadata</a> *metadata);
<a name="l00300"></a>00300 <span class="comment"></span>
<a name="l00301"></a>00301 <span class="comment"> /*!</span>
<a name="l00302"></a>00302 <span class="comment"> * \brief transmit raw uint32_t data items to USRP2</span>
<a name="l00303"></a>00303 <span class="comment"> *</span>
<a name="l00304"></a>00304 <span class="comment"> * The caller is responsible for ensuring that the items are</span>
<a name="l00305"></a>00305 <span class="comment"> * formatted appropriately for the USRP2 and its configuration.</span>
<a name="l00306"></a>00306 <span class="comment"> * This method is used primarily by the system itself. Users</span>
<a name="l00307"></a>00307 <span class="comment"> * should call tx_32fc or tx_16sc instead.</span>
<a name="l00308"></a>00308 <span class="comment"> *</span>
<a name="l00309"></a>00309 <span class="comment"> * \param channel specifies the channel to send them to</span>
<a name="l00310"></a>00310 <span class="comment"> * \param items are the data items to transmit</span>
<a name="l00311"></a>00311 <span class="comment"> * \param nitems is the number of items to transmit</span>
<a name="l00312"></a>00312 <span class="comment"> * \param metadata provides the timestamp and flags</span>
<a name="l00313"></a>00313 <span class="comment"> */</span>
<a name="l00314"></a>00314 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a9853a8439165f467814d472024c4c551" title="transmit raw uint32_t data items to USRP2">tx_raw</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel,
<a name="l00315"></a>00315 <span class="keyword">const</span> uint32_t *items,
<a name="l00316"></a>00316 <span class="keywordtype">size_t</span> nitems,
<a name="l00317"></a>00317 <span class="keyword">const</span> <a class="code" href="structusrp2_1_1tx__metadata.html" title="metadata associated with transmitted frames">tx_metadata</a> *metadata);
<a name="l00318"></a>00318
<a name="l00319"></a>00319 <span class="comment">/*</span>
<a name="l00320"></a>00320 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00321"></a>00321 <span class="comment"> * miscellaneous methods</span>
<a name="l00322"></a>00322 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00323"></a>00323 <span class="comment"> */</span>
<a name="l00324"></a>00324 <span class="comment"></span>
<a name="l00325"></a>00325 <span class="comment"> /*!</span>
<a name="l00326"></a>00326 <span class="comment"> * \brief MIMO configuration</span>
<a name="l00327"></a>00327 <span class="comment"> *</span>
<a name="l00328"></a>00328 <span class="comment"> * \param flags from usrp2_mimo_config.h</span>
<a name="l00329"></a>00329 <span class="comment"> *</span>
<a name="l00330"></a>00330 <span class="comment"> * <pre></span>
<a name="l00331"></a>00331 <span class="comment"> * one of these:</span>
<a name="l00332"></a>00332 <span class="comment"> *</span>
<a name="l00333"></a>00333 <span class="comment"> * MC_WE_DONT_LOCK</span>
<a name="l00334"></a>00334 <span class="comment"> * MC_WE_LOCK_TO_SMA</span>
<a name="l00335"></a>00335 <span class="comment"> * MC_WE_LOCK_TO_MIMO</span>
<a name="l00336"></a>00336 <span class="comment"> *</span>
<a name="l00337"></a>00337 <span class="comment"> * and optionally this:</span>
<a name="l00338"></a>00338 <span class="comment"> *</span>
<a name="l00339"></a>00339 <span class="comment"> * MC_PROVIDE_CLK_TO_MIMO</span>
<a name="l00340"></a>00340 <span class="comment"> * </pre></span>
<a name="l00341"></a>00341 <span class="comment"> */</span>
<a name="l00342"></a>00342 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a5a547f128bb1129445e90f029c36d63c" title="MIMO configuration.">config_mimo</a>(<span class="keywordtype">int</span> flags);
<a name="l00343"></a>00343
<a name="l00344"></a>00344 <span class="comment"></span>
<a name="l00345"></a>00345 <span class="comment"> //! Get frequency of master oscillator in Hz</span>
<a name="l00346"></a>00346 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a91771bfb13bb9e7e7534310204b9192e" title="Get frequency of master oscillator in Hz.">fpga_master_clock_freq</a>(<span class="keywordtype">long</span> *freq);
<a name="l00347"></a>00347
<a name="l00348"></a>00348 <span class="comment">// Get Sampling rate of A/D converter in Hz</span>
<a name="l00349"></a>00349 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a49bc0d8a533ad7259e5574acfd027d68">adc_rate</a>(<span class="keywordtype">long</span> *rate);
<a name="l00350"></a>00350
<a name="l00351"></a>00351 <span class="comment">// Get Sampling rate of D/A converter in Hz</span>
<a name="l00352"></a>00352 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#ac1e9dd22b54da3bd44fa6d46b43293b8">dac_rate</a>(<span class="keywordtype">long</span> *rate);
<a name="l00353"></a>00353 <span class="comment"></span>
<a name="l00354"></a>00354 <span class="comment"> /*!</span>
<a name="l00355"></a>00355 <span class="comment"> * \brief Get Tx daughterboard ID</span>
<a name="l00356"></a>00356 <span class="comment"> *</span>
<a name="l00357"></a>00357 <span class="comment"> * \param[out] dbid returns the daughterboard id.</span>
<a name="l00358"></a>00358 <span class="comment"> *</span>
<a name="l00359"></a>00359 <span class="comment"> * daughterboard id >= 0 if successful, -1 if no daugherboard installed,</span>
<a name="l00360"></a>00360 <span class="comment"> * -2 if invalid EEPROM on daughterboard.</span>
<a name="l00361"></a>00361 <span class="comment"> */</span>
<a name="l00362"></a>00362 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aef3c674c9f2c7495e197a5c6130a2cce" title="Get Tx daughterboard ID.">tx_daughterboard_id</a>(<span class="keywordtype">int</span> *dbid);
<a name="l00363"></a>00363 <span class="comment"></span>
<a name="l00364"></a>00364 <span class="comment"> /*!</span>
<a name="l00365"></a>00365 <span class="comment"> * \brief Get Rx daughterboard ID</span>
<a name="l00366"></a>00366 <span class="comment"> *</span>
<a name="l00367"></a>00367 <span class="comment"> * \param[out] dbid returns the daughterboard id.</span>
<a name="l00368"></a>00368 <span class="comment"> *</span>
<a name="l00369"></a>00369 <span class="comment"> * daughterboard id >= 0 if successful, -1 if no daugherboard installed,</span>
<a name="l00370"></a>00370 <span class="comment"> * -2 if invalid EEPROM on daughterboard.</span>
<a name="l00371"></a>00371 <span class="comment"> */</span>
<a name="l00372"></a>00372 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#acd497e686236e986d2a7c9708101fc94" title="Get Rx daughterboard ID.">rx_daughterboard_id</a>(<span class="keywordtype">int</span> *dbid);
<a name="l00373"></a>00373
<a name="l00374"></a>00374 <span class="comment">/*</span>
<a name="l00375"></a>00375 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00376"></a>00376 <span class="comment"> * Low level methods</span>
<a name="l00377"></a>00377 <span class="comment"> * ----------------------------------------------------------------</span>
<a name="l00378"></a>00378 <span class="comment"> */</span>
<a name="l00379"></a>00379 <span class="comment"></span>
<a name="l00380"></a>00380 <span class="comment"> /*!</span>
<a name="l00381"></a>00381 <span class="comment"> * Burn new mac address into EEPROM on USRP2</span>
<a name="l00382"></a>00382 <span class="comment"> *</span>
<a name="l00383"></a>00383 <span class="comment"> * \param new_addr Network mac address, e.g., "01:23:45:67:89:ab" or "89:ab".</span>
<a name="l00384"></a>00384 <span class="comment"> * If \p addr is HH:HH, it's treated as if it were 00:50:c2:85:HH:HH</span>
<a name="l00385"></a>00385 <span class="comment"> */</span>
<a name="l00386"></a>00386 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aa1e646a4b9695438a3175eb1c3b7a324">burn_mac_addr</a>(<span class="keyword">const</span> std::string &new_addr);
<a name="l00387"></a>00387 <span class="comment"></span>
<a name="l00388"></a>00388 <span class="comment"> /*!</span>
<a name="l00389"></a>00389 <span class="comment"> * Reset master time to 0 at next PPS edge</span>
<a name="l00390"></a>00390 <span class="comment"> */</span>
<a name="l00391"></a>00391 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a6407149eaf9535bac0642889d0c67a6f">sync_to_pps</a>();
<a name="l00392"></a>00392 <span class="comment"></span>
<a name="l00393"></a>00393 <span class="comment"> /*!</span>
<a name="l00394"></a>00394 <span class="comment"> * Reset master time to 0 at every PPS edge</span>
<a name="l00395"></a>00395 <span class="comment"> */</span>
<a name="l00396"></a>00396 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#ac57859c598d0b2f7fec17731fdf1f333">sync_every_pps</a>(<span class="keywordtype">bool</span> enable);
<a name="l00397"></a>00397 <span class="comment"></span>
<a name="l00398"></a>00398 <span class="comment"> /*!</span>
<a name="l00399"></a>00399 <span class="comment"> * Read memory from Wishbone bus as 32-bit words. Handles endian swapping if needed.</span>
<a name="l00400"></a>00400 <span class="comment"> *</span>
<a name="l00401"></a>00401 <span class="comment"> * \param addr 32-bit aligned address. Only the lower 16-bits are significant.</span>
<a name="l00402"></a>00402 <span class="comment"> * \param words Number of 32-bit words</span>
<a name="l00403"></a>00403 <span class="comment"> * </span>
<a name="l00404"></a>00404 <span class="comment"> * \returns Vector of 32-bit read values</span>
<a name="l00405"></a>00405 <span class="comment"> *</span>
<a name="l00406"></a>00406 <span class="comment"> * WARNING: Attempts to read memory from addresses that do not correspond to RAM or</span>
<a name="l00407"></a>00407 <span class="comment"> * memory-mapped peripherals may cause the USRP2 to hang, requiring a power cycle.</span>
<a name="l00408"></a>00408 <span class="comment"> * </span>
<a name="l00409"></a>00409 <span class="comment"> */</span>
<a name="l00410"></a>00410 <a class="code" href="classstd_1_1vector.html">std::vector<uint32_t></a> <a class="code" href="classusrp2_1_1usrp2.html#a3d89fc2845a564ab3b3077699f434e1a">peek32</a>(uint32_t addr, uint32_t words);
<a name="l00411"></a>00411 <span class="comment"></span>
<a name="l00412"></a>00412 <span class="comment"> /*!</span>
<a name="l00413"></a>00413 <span class="comment"> * Write memory to Wishbone bus as 32-bit words. Handles endian swapping if needed.</span>
<a name="l00414"></a>00414 <span class="comment"> *</span>
<a name="l00415"></a>00415 <span class="comment"> * \param addr 32-bit aligned address. Only the lower 16-bits are significant</span>
<a name="l00416"></a>00416 <span class="comment"> * \param data Vector of 32-bit values to write.</span>
<a name="l00417"></a>00417 <span class="comment"> *</span>
<a name="l00418"></a>00418 <span class="comment"> * \returns true iff successful</span>
<a name="l00419"></a>00419 <span class="comment"> *</span>
<a name="l00420"></a>00420 <span class="comment"> * WARNING: Attempts to read memory from addresses that do not correspond to RAM or</span>
<a name="l00421"></a>00421 <span class="comment"> * memory-mapped peripherals may cause the USRP2 to hang, requiring a power cycle.</span>
<a name="l00422"></a>00422 <span class="comment"> * </span>
<a name="l00423"></a>00423 <span class="comment"> */</span>
<a name="l00424"></a>00424 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#a8f386b5781d5a675eaa647cc0b2c54fe">poke32</a>(uint32_t addr, <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<uint32_t></a> &data);
<a name="l00425"></a>00425 <span class="comment"></span>
<a name="l00426"></a>00426 <span class="comment"> /*!</span>
<a name="l00427"></a>00427 <span class="comment"> * Set daughterboard GPIO data direction register.</span>
<a name="l00428"></a>00428 <span class="comment"> *</span>
<a name="l00429"></a>00429 <span class="comment"> * \param bank GPIO_TX_BANK or GPIO_RX_BANK</span>
<a name="l00430"></a>00430 <span class="comment"> * \param value 16-bits, 0=FPGA input, 1=FPGA output</span>
<a name="l00431"></a>00431 <span class="comment"> * \param mask 16-bits, 0=ignore, 1=set</span>
<a name="l00432"></a>00432 <span class="comment"> *</span>
<a name="l00433"></a>00433 <span class="comment"> * \returns true iff successful</span>
<a name="l00434"></a>00434 <span class="comment"> *</span>
<a name="l00435"></a>00435 <span class="comment"> * WARNING: Improper usage of this function may result in damage to the USRP2</span>
<a name="l00436"></a>00436 <span class="comment"> *</span>
<a name="l00437"></a>00437 <span class="comment"> */</span>
<a name="l00438"></a>00438 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aee3d2e654c22198430c7626ee65676e1">set_gpio_ddr</a>(<span class="keywordtype">int</span> bank, uint16_t value, uint16_t mask);
<a name="l00439"></a>00439 <span class="comment"></span>
<a name="l00440"></a>00440 <span class="comment"> /*!</span>
<a name="l00441"></a>00441 <span class="comment"> * Set daughterboard GPIO output selection register. For those GPIO pins that</span>
<a name="l00442"></a>00442 <span class="comment"> * are configured as outputs in the DDR, this settings configures the source</span>
<a name="l00443"></a>00443 <span class="comment"> * of the pin value.</span>
<a name="l00444"></a>00444 <span class="comment"> *</span>
<a name="l00445"></a>00445 <span class="comment"> * \param bank GPIO_TX_BANK or GPIO_RX_BANK</span>
<a name="l00446"></a>00446 <span class="comment"> * \param sels Exactly 16 character MSB->LSB string. For each position:</span>
<a name="l00447"></a>00447 <span class="comment"> * '.' = ignore this bit, i.e., leave current value</span>
<a name="l00448"></a>00448 <span class="comment"> * 'a' = Output ATR value</span>
<a name="l00449"></a>00449 <span class="comment"> * 's' = Output host software controlled value</span>
<a name="l00450"></a>00450 <span class="comment"> * '0' = Output FPGA debug bus 0 value</span>
<a name="l00451"></a>00451 <span class="comment"> * '1' = Output FPGA debug bus 1 value</span>
<a name="l00452"></a>00452 <span class="comment"> *</span>
<a name="l00453"></a>00453 <span class="comment"> * \returns true iff successful</span>
<a name="l00454"></a>00454 <span class="comment"> *</span>
<a name="l00455"></a>00455 <span class="comment"> * WARNING: Improper usage of this function may result in damage to the USRP2</span>
<a name="l00456"></a>00456 <span class="comment"> *</span>
<a name="l00457"></a>00457 <span class="comment"> */</span>
<a name="l00458"></a>00458 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#af2893ac8a6f56e62b05fc486740ffacb">set_gpio_sels</a>(<span class="keywordtype">int</span> bank, std::string sels);
<a name="l00459"></a>00459 <span class="comment"></span>
<a name="l00460"></a>00460 <span class="comment"> /*!</span>
<a name="l00461"></a>00461 <span class="comment"> * Set daughterboard GPIO pin values.</span>
<a name="l00462"></a>00462 <span class="comment"> *</span>
<a name="l00463"></a>00463 <span class="comment"> * \param bank GPIO_TX_BANK or GPIO_RX_BANK</span>
<a name="l00464"></a>00464 <span class="comment"> * \param value 16 bits, 0=low, 1=high</span>
<a name="l00465"></a>00465 <span class="comment"> * \param mask 16 bits, 0=ignore, 1=set</span>
<a name="l00466"></a>00466 <span class="comment"> *</span>
<a name="l00467"></a>00467 <span class="comment"> * \returns true iff successful</span>
<a name="l00468"></a>00468 <span class="comment"> *</span>
<a name="l00469"></a>00469 <span class="comment"> * WARNING: Improper usage of this function may result in damage to the USRP2</span>
<a name="l00470"></a>00470 <span class="comment"> *</span>
<a name="l00471"></a>00471 <span class="comment"> */</span>
<a name="l00472"></a>00472 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#ac4f19c8609dfde67d0b1cfbb80f9d90c">write_gpio</a>(<span class="keywordtype">int</span> bank, uint16_t value, uint16_t mask);
<a name="l00473"></a>00473 <span class="comment"></span>
<a name="l00474"></a>00474 <span class="comment"> /*!</span>
<a name="l00475"></a>00475 <span class="comment"> * Read daughterboard GPIO pin values</span>
<a name="l00476"></a>00476 <span class="comment"> *</span>
<a name="l00477"></a>00477 <span class="comment"> * \param bank GPIO_TX_BANK or GPIO_RX_BANK</span>
<a name="l00478"></a>00478 <span class="comment"> * \param value pointer to uint16_t to hold read results</span>
<a name="l00479"></a>00479 <span class="comment"> *</span>
<a name="l00480"></a>00480 <span class="comment"> * \returns true iff successful</span>
<a name="l00481"></a>00481 <span class="comment"> *</span>
<a name="l00482"></a>00482 <span class="comment"> */</span>
<a name="l00483"></a>00483 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#aef356a85afe76aa2938b022b73c38ddd">read_gpio</a>(<span class="keywordtype">int</span> bank, uint16_t *value);
<a name="l00484"></a>00484 <span class="comment"></span>
<a name="l00485"></a>00485 <span class="comment"> /*!</span>
<a name="l00486"></a>00486 <span class="comment"> * Set GPIO streaming mode</span>
<a name="l00487"></a>00487 <span class="comment"> *</span>
<a name="l00488"></a>00488 <span class="comment"> * Individually enables streaming GPIO pins through LSBs of DSP</span>
<a name="l00489"></a>00489 <span class="comment"> * samples.</span>
<a name="l00490"></a>00490 <span class="comment"> *</span>
<a name="l00491"></a>00491 <span class="comment"> * On receive, io_rx[15] replaces I[0], io_rx[14] replaces Q[0]</span>
<a name="l00492"></a>00492 <span class="comment"> * On transmit, I[0] maps to io_tx[15], Q[0] maps to io_tx[14]</span>
<a name="l00493"></a>00493 <span class="comment"> * (Transmit streaming is not yet implemented.)</span>
<a name="l00494"></a>00494 <span class="comment"> *</span>
<a name="l00495"></a>00495 <span class="comment"> * The selected GPIO pins must have been set as inputs or outputs</span>
<a name="l00496"></a>00496 <span class="comment"> * and, for transmit, set to software control.</span>
<a name="l00497"></a>00497 <span class="comment"> *</span>
<a name="l00498"></a>00498 <span class="comment"> * When enabled, the replaced DSP sample LSBs become 0.</span>
<a name="l00499"></a>00499 <span class="comment"> *</span>
<a name="l00500"></a>00500 <span class="comment"> * \param bank GPIO_TX_BANK or GPIO_RX_BANK</span>
<a name="l00501"></a>00501 <span class="comment"> * \param enable enable[0] controls I channel LSB</span>
<a name="l00502"></a>00502 <span class="comment"> * enable[1] controls Q channel LSB</span>
<a name="l00503"></a>00503 <span class="comment"> *</span>
<a name="l00504"></a>00504 <span class="comment"> * \returns true iff successful</span>
<a name="l00505"></a>00505 <span class="comment"> *</span>
<a name="l00506"></a>00506 <span class="comment"> * WARNING: Improper usage of this function may result in damage to the USRP2</span>
<a name="l00507"></a>00507 <span class="comment"> *</span>
<a name="l00508"></a>00508 <span class="comment"> */</span>
<a name="l00509"></a>00509 <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1usrp2.html#acf667cea17739ba8b8ede8cf162a7272">enable_gpio_streaming</a>(<span class="keywordtype">int</span> bank, <span class="keywordtype">int</span> enable);
<a name="l00510"></a>00510
<a name="l00511"></a>00511 <span class="preprocessor">#if 0 // not yet implemented</span>
<a name="l00512"></a>00512 <span class="preprocessor"></span><span class="comment"> /*!</span>
<a name="l00513"></a>00513 <span class="comment"> * \brief Write EEPROM on motherboard or any daughterboard.</span>
<a name="l00514"></a>00514 <span class="comment"> * \param i2c_addr I2C bus address of EEPROM</span>
<a name="l00515"></a>00515 <span class="comment"> * \param eeprom_offset byte offset in EEPROM to begin writing</span>
<a name="l00516"></a>00516 <span class="comment"> * \param buf the data to write</span>
<a name="l00517"></a>00517 <span class="comment"> * \returns true iff sucessful</span>
<a name="l00518"></a>00518 <span class="comment"> */</span>
<a name="l00519"></a>00519 <span class="keywordtype">bool</span> write_eeprom (<span class="keywordtype">int</span> i2c_addr, <span class="keywordtype">int</span> eeprom_offset, <span class="keyword">const</span> std::string &buf);
<a name="l00520"></a>00520 <span class="comment"></span>
<a name="l00521"></a>00521 <span class="comment"> /*!</span>
<a name="l00522"></a>00522 <span class="comment"> * \brief Read EEPROM on motherboard or any daughterboard.</span>
<a name="l00523"></a>00523 <span class="comment"> * \param i2c_addr I2C bus address of EEPROM</span>
<a name="l00524"></a>00524 <span class="comment"> * \param eeprom_offset byte offset in EEPROM to begin reading</span>
<a name="l00525"></a>00525 <span class="comment"> * \param len number of bytes to read</span>
<a name="l00526"></a>00526 <span class="comment"> * \returns the data read if successful, else a zero length string.</span>
<a name="l00527"></a>00527 <span class="comment"> */</span>
<a name="l00528"></a>00528 std::string read_eeprom (<span class="keywordtype">int</span> i2c_addr, <span class="keywordtype">int</span> eeprom_offset, <span class="keywordtype">int</span> len);
<a name="l00529"></a>00529 <span class="comment"></span>
<a name="l00530"></a>00530 <span class="comment"> /*!</span>
<a name="l00531"></a>00531 <span class="comment"> * \brief Write to I2C peripheral</span>
<a name="l00532"></a>00532 <span class="comment"> * \param i2c_addr I2C bus address (7-bits)</span>
<a name="l00533"></a>00533 <span class="comment"> * \param buf the data to write</span>
<a name="l00534"></a>00534 <span class="comment"> * \returns true iff successful</span>
<a name="l00535"></a>00535 <span class="comment"> * Writes are limited to a maximum of of 64 bytes.</span>
<a name="l00536"></a>00536 <span class="comment"> */</span>
<a name="l00537"></a>00537 <span class="keywordtype">bool</span> write_i2c (<span class="keywordtype">int</span> i2c_addr, <span class="keyword">const</span> std::string &buf);
<a name="l00538"></a>00538 <span class="comment"></span>
<a name="l00539"></a>00539 <span class="comment"> /*!</span>
<a name="l00540"></a>00540 <span class="comment"> * \brief Read from I2C peripheral</span>
<a name="l00541"></a>00541 <span class="comment"> * \param i2c_addr I2C bus address (7-bits)</span>
<a name="l00542"></a>00542 <span class="comment"> * \param len number of bytes to read</span>
<a name="l00543"></a>00543 <span class="comment"> * \returns the data read if successful, else a zero length string.</span>
<a name="l00544"></a>00544 <span class="comment"> * Reads are limited to a maximum of 64 bytes.</span>
<a name="l00545"></a>00545 <span class="comment"> */</span>
<a name="l00546"></a>00546 std::string read_i2c (<span class="keywordtype">int</span> i2c_addr, <span class="keywordtype">int</span> len);
<a name="l00547"></a>00547 <span class="comment"></span>
<a name="l00548"></a>00548 <span class="comment"> /*!</span>
<a name="l00549"></a>00549 <span class="comment"> * \brief Write data to SPI bus peripheral.</span>
<a name="l00550"></a>00550 <span class="comment"> *</span>
<a name="l00551"></a>00551 <span class="comment"> * \param optional_header 0,1 or 2 bytes to write before buf.</span>
<a name="l00552"></a>00552 <span class="comment"> * \param enables bitmask of peripherals to write. See usrp_spi_defs.h</span>
<a name="l00553"></a>00553 <span class="comment"> * \param format transaction format. See usrp_spi_defs.h SPI_FMT_*</span>
<a name="l00554"></a>00554 <span class="comment"> * \param buf the data to write</span>
<a name="l00555"></a>00555 <span class="comment"> * \returns true iff successful</span>
<a name="l00556"></a>00556 <span class="comment"> * Writes are limited to a maximum of 64 bytes.</span>
<a name="l00557"></a>00557 <span class="comment"> *</span>
<a name="l00558"></a>00558 <span class="comment"> * If \p format specifies that optional_header bytes are present, they are</span>
<a name="l00559"></a>00559 <span class="comment"> * written to the peripheral immediately prior to writing \p buf.</span>
<a name="l00560"></a>00560 <span class="comment"> */</span>
<a name="l00561"></a>00561 <span class="keywordtype">bool</span> write_spi (<span class="keywordtype">int</span> optional_header, <span class="keywordtype">int</span> enables, <span class="keywordtype">int</span> format, <span class="keyword">const</span> std::string &buf);
<a name="l00562"></a>00562
<a name="l00563"></a>00563 <span class="comment">/*</span>
<a name="l00564"></a>00564 <span class="comment"> * \brief Read data from SPI bus peripheral.</span>
<a name="l00565"></a>00565 <span class="comment"> *</span>
<a name="l00566"></a>00566 <span class="comment"> * \param optional_header 0,1 or 2 bytes to write before buf.</span>
<a name="l00567"></a>00567 <span class="comment"> * \param enables bitmask of peripheral to read. See usrp_spi_defs.h</span>
<a name="l00568"></a>00568 <span class="comment"> * \param format transaction format. See usrp_spi_defs.h SPI_FMT_*</span>
<a name="l00569"></a>00569 <span class="comment"> * \param len number of bytes to read. Must be in [0,64].</span>
<a name="l00570"></a>00570 <span class="comment"> * \returns the data read if sucessful, else a zero length string.</span>
<a name="l00571"></a>00571 <span class="comment"> *</span>
<a name="l00572"></a>00572 <span class="comment"> * Reads are limited to a maximum of 64 bytes.</span>
<a name="l00573"></a>00573 <span class="comment"> *</span>
<a name="l00574"></a>00574 <span class="comment"> * If \p format specifies that optional_header bytes are present, they</span>
<a name="l00575"></a>00575 <span class="comment"> * are written to the peripheral first. Then \p len bytes are read from</span>
<a name="l00576"></a>00576 <span class="comment"> * the peripheral and returned.</span>
<a name="l00577"></a>00577 <span class="comment"> */</span>
<a name="l00578"></a>00578 std::string read_spi (<span class="keywordtype">int</span> optional_header, <span class="keywordtype">int</span> enables, <span class="keywordtype">int</span> format, <span class="keywordtype">int</span> len);
<a name="l00579"></a>00579 <span class="preprocessor">#endif</span>
<a name="l00580"></a>00580 <span class="preprocessor"></span>
<a name="l00581"></a>00581
<a name="l00582"></a>00582 <span class="keyword">class </span><a class="code" href="classusrp2_1_1usrp2_1_1impl.html">impl</a>; <span class="comment">// implementation details</span>
<a name="l00583"></a>00583
<a name="l00584"></a>00584 <span class="keyword">private</span>:
<a name="l00585"></a>00585 <span class="comment">// Static function to retrieve or create usrp2 instance</span>
<a name="l00586"></a>00586 <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html">sptr</a> find_existing_or_make_new(<span class="keyword">const</span> std::string &ifc, <a class="code" href="structusrp2_1_1props.html">props</a> *p, <span class="keywordtype">size_t</span> rx_bufsize);
<a name="l00587"></a>00587
<a name="l00588"></a>00588 <span class="comment">// Only class members can instantiate this class</span>
<a name="l00589"></a>00589 <a class="code" href="classusrp2_1_1usrp2.html" title="standard C++ interface to USRP2">usrp2</a>(<span class="keyword">const</span> std::string &ifc, <a class="code" href="structusrp2_1_1props.html">props</a> *p, <span class="keywordtype">size_t</span> rx_bufsize);
<a name="l00590"></a>00590
<a name="l00591"></a>00591 <span class="comment">// All private state is held in opaque pointer</span>
<a name="l00592"></a>00592 std::auto_ptr<impl> d_impl;
<a name="l00593"></a>00593 };
<a name="l00594"></a>00594
<a name="l00595"></a>00595 };
<a name="l00596"></a>00596
<a name="l00597"></a>00597 std::ostream& <a class="code" href="gr__basic__block_8h.html#acb2f610728a7f3cbd51a9a2eb60f059e">operator<<</a>(std::ostream &os, <span class="keyword">const</span> <a class="code" href="structusrp2_1_1props.html">usrp2::props</a> &x);
<a name="l00598"></a>00598
<a name="l00599"></a>00599
<a name="l00600"></a>00600 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP2_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="usrp2_8h.html">usrp2.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
7184
