<!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: usrp_sink_base.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('usrp__sink__base_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>usrp_sink_base.h</h1> </div>
</div>
<div class="contents">
<a href="usrp__sink__base_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00003"></a>00003 <span class="comment">/*</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright 2004,2006,2008 Free Software Foundation, Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> * </span>
<a name="l00006"></a>00006 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00011"></a>00011 <span class="comment"> * any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> * </span>
<a name="l00013"></a>00013 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00020"></a>00020 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00021"></a>00021 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef INCLUDED_USRP_SINK_BASE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP_SINK_BASE_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="usrp__base_8h.html">usrp_base.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <stdexcept></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <usrp_tune_result.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <usrp_dbid.h></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classusrp__standard__tx.html" title="The C++ interface the transmit side of the USRPThis is the recommended interface to USRP transmit fun...">usrp_standard_tx</a>;
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/*!</span>
<a name="l00035"></a>00035 <span class="comment"> * \brief abstract interface to Universal Software Radio Peripheral Tx path (Rev 1)</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a><a class="code" href="classusrp__sink__base.html">00037</a> <span class="keyword">class </span><a class="code" href="classusrp__sink__base.html" title="abstract interface to Universal Software Radio Peripheral Tx path (Rev 1)">usrp_sink_base</a> : <span class="keyword">public</span> <a class="code" href="classusrp__base.html" title="base class for GNU Radio interface to the USRP">usrp_base</a> {
<a name="l00038"></a>00038 <span class="keyword">private</span>:
<a name="l00039"></a>00039 <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<usrp_standard_tx></a> d_usrp;
<a name="l00040"></a>00040 <span class="keywordtype">int</span> d_nunderruns;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">protected</span>:
<a name="l00043"></a>00043 <a class="code" href="classusrp__sink__base.html#a65f54ea873dd38a59524a72ee9dd836f">usrp_sink_base</a> (<span class="keyword">const</span> std::string &<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>,
<a name="l00044"></a>00044 <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>,
<a name="l00045"></a>00045 <span class="keywordtype">int</span> which_board,
<a name="l00046"></a>00046 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#a44e219f29ee82dda457858c406d2b6d7">interp_rate</a>,
<a name="l00047"></a>00047 <span class="keywordtype">int</span> nchan,
<a name="l00048"></a>00048 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#a540098dc9a0fa9b1be2a06ae4f5928c9">mux</a>,
<a name="l00049"></a>00049 <span class="keywordtype">int</span> fusb_block_size,
<a name="l00050"></a>00050 <span class="keywordtype">int</span> fusb_nblocks,
<a name="l00051"></a>00051 <span class="keyword">const</span> std::string fpga_filename,
<a name="l00052"></a>00052 <span class="keyword">const</span> std::string firmware_filename
<a name="l00053"></a>00053 ) <span class="keywordflow">throw</span> (std::runtime_error);
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /*!</span>
<a name="l00056"></a>00056 <span class="comment"> * \brief convert between input item format and usrp native format</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * \param[in] input_items stream(s) of input items</span>
<a name="l00059"></a>00059 <span class="comment"> * \param[in] input_index starting index in input_items</span>
<a name="l00060"></a>00060 <span class="comment"> * \param[in] input_items_available number of items available starting at item[index]</span>
<a name="l00061"></a>00061 <span class="comment"> * \param[out] input_items_consumed number of input items consumed by copy</span>
<a name="l00062"></a>00062 <span class="comment"> * \param[out] usrp_buffer destination buffer</span>
<a name="l00063"></a>00063 <span class="comment"> * \param[in] usrp_buffer_length \p usrp_buffer length in bytes</span>
<a name="l00064"></a>00064 <span class="comment"> * \param[out] bytes_written number of bytes written into \p usrp_buffer</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classusrp__sink__base.html#a028395de3df16fc8b40324ef4333787a" title="convert between input item format and usrp native format">copy_to_usrp_buffer</a> (<a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00067"></a>00067 <span class="keywordtype">int</span> input_index,
<a name="l00068"></a>00068 <span class="keywordtype">int</span> input_items_available,
<a name="l00069"></a>00069 <span class="keywordtype">int</span> &input_items_consumed,
<a name="l00070"></a>00070 <span class="keywordtype">void</span> *usrp_buffer,
<a name="l00071"></a>00071 <span class="keywordtype">int</span> usrp_buffer_length,
<a name="l00072"></a>00072 <span class="keywordtype">int</span> &bytes_written) = 0;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keyword">public</span>:
<a name="l00075"></a>00075 <a class="code" href="classusrp__sink__base.html#a7fb0b4533821551ace4f6a023edd39f1">~usrp_sink_base</a> ();
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#a6d8bffa2bfbc0e8346995aef494f4dfb" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a> (<span class="keywordtype">int</span> noutput_items,
<a name="l00078"></a>00078 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00079"></a>00079 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /*!</span>
<a name="l00082"></a>00082 <span class="comment"> * \brief Set interpolator rate. \p rate must be in [4, 1024] and a multiple of 4.</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * The final complex sample rate across the USB is</span>
<a name="l00085"></a>00085 <span class="comment"> * dac_freq () / interp_rate () * nchannels ()</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#ad067038823e8bc375f4ac414bd3b4516" title="Set interpolator rate. rate must be in [4, 1024] and a multiple of 4.">set_interp_rate</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> rate);
<a name="l00088"></a>00088 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#aa73c8375ca4af57115708f56461adb17">set_nchannels</a> (<span class="keywordtype">int</span> nchan);
<a name="l00089"></a>00089 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a6eeb3812216f5e3a8cd5c581586130c8">set_mux</a> (<span class="keywordtype">int</span> mux);
<a name="l00090"></a>00090 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#acf2b4ede145c832f91ff76bbacf46f3c">determine_tx_mux_value</a>(<a class="code" href="structusrp__subdev__spec.html" title="specify a daughterboard and subdevice on a daughterboard.">usrp_subdev_spec</a> ss);
<a name="l00091"></a>00091 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#acf2b4ede145c832f91ff76bbacf46f3c">determine_tx_mux_value</a>(<a class="code" href="structusrp__subdev__spec.html" title="specify a daughterboard and subdevice on a daughterboard.">usrp_subdev_spec</a> ss_a, <a class="code" href="structusrp__subdev__spec.html" title="specify a daughterboard and subdevice on a daughterboard.">usrp_subdev_spec</a> ss_b);
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /*!</span>
<a name="l00094"></a>00094 <span class="comment"> * \brief set the frequency of the digital up converter.</span>
<a name="l00095"></a>00095 <span class="comment"> *</span>
<a name="l00096"></a>00096 <span class="comment"> * \p channel must be 0. \p freq is the center frequency in Hz.</span>
<a name="l00097"></a>00097 <span class="comment"> * It must be in the range [-44M, 44M]. The frequency specified is</span>
<a name="l00098"></a>00098 <span class="comment"> * quantized. Use tx_freq to retrieve the actual value used.</span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a7d9be67e450b7198278a96d0cca581e4" title="set the frequency of the digital up converter.">set_tx_freq</a> (<span class="keywordtype">int</span> channel, <span class="keywordtype">double</span> freq);
<a name="l00101"></a>00101
<a name="l00102"></a><a class="code" href="classusrp__sink__base.html#ad9750e7eff9bb55536fa18cece8cc125">00102</a> <span class="keywordtype">long</span> <a class="code" href="classusrp__sink__base.html#ad9750e7eff9bb55536fa18cece8cc125">dac_rate</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classusrp__base.html#a4d9437597a0765bb108d4edb4a214a59" title="returns A/D or D/A converter rate in Hz">converter_rate</a>(); } <span class="comment">// alias</span>
<a name="l00103"></a><a class="code" href="classusrp__sink__base.html#a2e6e0e9afccfe67c3bb47eac18cb06bc">00103</a> <span class="keywordtype">long</span> <a class="code" href="classusrp__sink__base.html#a2e6e0e9afccfe67c3bb47eac18cb06bc">dac_freq</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classusrp__base.html#a4d9437597a0765bb108d4edb4a214a59" title="returns A/D or D/A converter rate in Hz">converter_rate</a>(); } <span class="comment">// deprecated alias</span>
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#a44e219f29ee82dda457858c406d2b6d7">interp_rate</a> () <span class="keyword">const</span>;
<a name="l00106"></a>00106 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#af9537cab6f2ddd28f9e6b3714713cd15">nchannels</a> () <span class="keyword">const</span>;
<a name="l00107"></a>00107 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#a540098dc9a0fa9b1be2a06ae4f5928c9">mux</a> () <span class="keyword">const</span>;
<a name="l00108"></a>00108 <span class="keywordtype">double</span> <a class="code" href="classusrp__sink__base.html#a3a471d075d6cf388f7cad5eb42fec35d">tx_freq</a> (<span class="keywordtype">int</span> channel) <span class="keyword">const</span>;
<a name="l00109"></a><a class="code" href="classusrp__sink__base.html#ab50fb41621309b2721fc2e5797c3d38f">00109</a> <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#ab50fb41621309b2721fc2e5797c3d38f">nunderruns</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_nunderruns; }
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a5d0e96c87025d683fa6a1f8f73f6669e">has_rx_halfband</a>();
<a name="l00112"></a>00112 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#aeb9c1185fbdcb73f8181d9dddcb166d2">has_tx_halfband</a>();
<a name="l00113"></a>00113 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#ae30308b409316771cb419f536d8c85ab">nddcs</a>();
<a name="l00114"></a>00114 <span class="keywordtype">int</span> <a class="code" href="classusrp__sink__base.html#ae2a0a8fb07ec0f9311e717c789ba8818">nducs</a>();
<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"> * \brief Called to enable drivers, etc for i/o devices.</span>
<a name="l00118"></a>00118 <span class="comment"> *</span>
<a name="l00119"></a>00119 <span class="comment"> * This allows a block to enable an associated driver to begin</span>
<a name="l00120"></a>00120 <span class="comment"> * transfering data just before we start to execute the scheduler.</span>
<a name="l00121"></a>00121 <span class="comment"> * The end result is that this reduces latency in the pipeline when</span>
<a name="l00122"></a>00122 <span class="comment"> * dealing with audio devices, usrps, etc.</span>
<a name="l00123"></a>00123 <span class="comment"> */</span>
<a name="l00124"></a>00124 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a85efc4fe8b2f93f8035a61c793562d74" title="Called to enable drivers, etc for i/o devices.">start</a>();
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment"> /*!</span>
<a name="l00127"></a>00127 <span class="comment"> * \brief Called to disable drivers, etc for i/o devices.</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a79a0f7db96a450be5bf86c5ab031d6de" title="Called to disable drivers, etc for i/o devices.">stop</a>();
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment"> /*!</span>
<a name="l00132"></a>00132 <span class="comment"> * \brief High-level "tune" method. Works for the single channel case.</span>
<a name="l00133"></a>00133 <span class="comment"> *</span>
<a name="l00134"></a>00134 <span class="comment"> * This method adjusts both the daughterboard LO and the DUC so that</span>
<a name="l00135"></a>00135 <span class="comment"> * DC in the complex baseband samples ends up at RF target_freq.</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * \param chan which DUC channel we're controlling (usually == which_side).</span>
<a name="l00138"></a>00138 <span class="comment"> * \param db the daughterboard we're controlling.</span>
<a name="l00139"></a>00139 <span class="comment"> * \param target_freq the RF frequency we want our baseband translated to.</span>
<a name="l00140"></a>00140 <span class="comment"> * \param[out] result details how the hardware was configured.</span>
<a name="l00141"></a>00141 <span class="comment"> *</span>
<a name="l00142"></a>00142 <span class="comment"> * \returns true iff everything was successful.</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 <span class="keywordtype">bool</span> <a class="code" href="classusrp__sink__base.html#a81ffd4685cfbc06aed92660cd9250f23" title="High-level &quot;tune&quot; method. Works for the single channel case.">tune</a>(<span class="keywordtype">int</span> chan, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">db_base_sptr</a> <a class="code" href="classusrp__base.html#adc92a29a1a00b5239170aab7d22be47a">db</a>, <span class="keywordtype">double</span> target_freq, <a class="code" href="classusrp__tune__result.html">usrp_tune_result</a> *result);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment"> /*!</span>
<a name="l00147"></a>00147 <span class="comment"> * \brief Select suitable Tx daughterboard</span>
<a name="l00148"></a>00148 <span class="comment"> */</span>
<a name="l00149"></a>00149 <a class="code" href="structusrp__subdev__spec.html" title="specify a daughterboard and subdevice on a daughterboard.">usrp_subdev_spec</a> <a class="code" href="classusrp__sink__base.html#a187d43db3cef8bfcc437ec224e13f4e1" title="Select suitable Tx daughterboard.">pick_tx_subdevice</a>();
<a name="l00150"></a>00150 };
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP_SINK_BASE_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="usrp__sink__base_8h.html">usrp_sink_base.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
>
7309
