Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7192

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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_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('usrp2__base_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>usrp2_base.h</h1>  </div>
</div>
<div class="contents">
<a href="usrp2__base_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 file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_USRP2_BASE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_BASE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;gr_sync_block.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;usrp2/usrp2.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="comment">// BIG ASS FIXME: get from lower layer MTU calculation</span>
<a name="l00031"></a><a class="code" href="usrp2__base_8h.html#af2fd4e6826f944250cc94c7814488ae3">00031</a> <span class="preprocessor">#define USRP2_MIN_RX_SAMPLES 371</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/*!</span>
<a name="l00034"></a>00034 <span class="comment"> * Base class for all USRP2 blocks</span>
<a name="l00035"></a>00035 <span class="comment"> */</span>
<a name="l00036"></a><a class="code" href="classusrp2__base.html">00036</a> <span class="keyword">class </span><a class="code" href="classusrp2__base.html">usrp2_base</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">protected</span>:
<a name="l00039"></a>00039   <a class="code" href="classusrp2__base.html#a14b16d411557ca85c86e98103a897639">usrp2_base</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>,
<a name="l00040"></a>00040              <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="l00041"></a>00041              <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>,
<a name="l00042"></a>00042              <span class="keyword">const</span> std::string &amp;ifc,
<a name="l00043"></a>00043              <span class="keyword">const</span> std::string &amp;mac)
<a name="l00044"></a>00044     <span class="keywordflow">throw</span> (std::runtime_error);
<a name="l00045"></a>00045 
<a name="l00046"></a><a class="code" href="classusrp2__base.html#a49c7166ecd4154f69f059c6c6ab18569">00046</a>   <a class="code" href="classboost_1_1shared__ptr.html">usrp2::usrp2::sptr</a> <a class="code" href="classusrp2__base.html#a49c7166ecd4154f69f059c6c6ab18569">d_u2</a>;
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049   <a class="code" href="classusrp2__base.html#a159a4198dc8ae413404f14c101af9d5e">~usrp2_base</a>();
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">  /*!</span>
<a name="l00052"></a>00052 <span class="comment">   * \brief Get USRP2 hardware MAC address</span>
<a name="l00053"></a>00053 <span class="comment">   */</span>
<a name="l00054"></a>00054   std::string <a class="code" href="classusrp2__base.html#aa80f40999e5a4bd008331ecf98fe635b" title="Get USRP2 hardware MAC address.">mac_addr</a>() <span class="keyword">const</span>;
<a name="l00055"></a>00055   <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">  /*!</span>
<a name="l00057"></a>00057 <span class="comment">   * \brief Get interface name used to communicat with USRP2</span>
<a name="l00058"></a>00058 <span class="comment">   */</span>
<a name="l00059"></a>00059   std::string <a class="code" href="classusrp2__base.html#a2068b65254153051e48227726f99d376" title="Get interface name used to communicat with USRP2.">interface_name</a>() <span class="keyword">const</span>;
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">  /*!</span>
<a name="l00062"></a>00062 <span class="comment">   * \brief Get USRP2 master clock rate</span>
<a name="l00063"></a>00063 <span class="comment">   */</span>
<a name="l00064"></a>00064   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#aeb6f787e406c46f4953bdbaf23f23937" title="Get USRP2 master clock rate.">fpga_master_clock_freq</a>(<span class="keywordtype">long</span> *freq) <span class="keyword">const</span>;
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">  /*!</span>
<a name="l00067"></a>00067 <span class="comment">   * \brief MIMO configuration</span>
<a name="l00068"></a>00068 <span class="comment">   */</span>
<a name="l00069"></a>00069   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#a64b8af14f2a15d4c8c02ebc0c0ad38ba" title="MIMO configuration.">config_mimo</a>(<span class="keywordtype">int</span> flags);
<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 Set master time to 0 at next PPS rising edge</span>
<a name="l00073"></a>00073 <span class="comment">   */</span>
<a name="l00074"></a>00074   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#a6c8abac86ef5d8b0815e892980d14e3f" title="Set master time to 0 at next PPS rising edge.">sync_to_pps</a>();
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">  /*!</span>
<a name="l00077"></a>00077 <span class="comment">   * Reset master time to 0 at every PPS edge</span>
<a name="l00078"></a>00078 <span class="comment">   */</span>
<a name="l00079"></a>00079   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#ac8225ecb6bec4e1256e7db7516f42c79">sync_every_pps</a>(<span class="keywordtype">bool</span> enable);
<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 Read memory from Wishbone bus as words</span>
<a name="l00083"></a>00083 <span class="comment">   */</span>
<a name="l00084"></a>00084   <a class="code" href="classstd_1_1vector.html">std::vector&lt;uint32_t&gt;</a> <a class="code" href="classusrp2__base.html#a957ee3d7cea7c05476036e4d714646fd" title="Read memory from Wishbone bus as words.">peek32</a>(uint32_t addr, uint32_t words);
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment">  /*!</span>
<a name="l00087"></a>00087 <span class="comment">   * \brief Write memory to Wishbone bus as words</span>
<a name="l00088"></a>00088 <span class="comment">   */</span>
<a name="l00089"></a>00089   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#a29a88baa072e1c35e77d715543474aa3" title="Write memory to Wishbone bus as words.">poke32</a>(uint32_t addr, <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;uint32_t&gt;</a> &amp;data);
<a name="l00090"></a>00090 <span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment">  /*!</span>
<a name="l00092"></a>00092 <span class="comment">   * \brief Called by scheduler when starting flowgraph</span>
<a name="l00093"></a>00093 <span class="comment">   */</span>
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#acba2abb76b13eaf7be15d787244bdf6b" title="Called by scheduler when starting flowgraph.">start</a>();
<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">   * \brief Called by scheduler when stopping flowgraph</span>
<a name="l00098"></a>00098 <span class="comment">   */</span>
<a name="l00099"></a>00099   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2__base.html#a7f92359dc1760ac40f201da01886b14f" title="Called by scheduler when stopping flowgraph.">stop</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">   * \brief Derived class must override this</span>
<a name="l00103"></a>00103 <span class="comment">   */</span>
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2__base.html#ab1cd79d541b22ec545e75f3c37956858" title="Derived class must override this.">work</a>(<span class="keywordtype">int</span> noutput_items,
<a name="l00105"></a>00105                    <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items,
<a name="l00106"></a>00106                    <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items) = 0;
<a name="l00107"></a>00107 };
<a name="l00108"></a>00108 
<a name="l00109"></a>00109 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP2_BASE_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="usrp2__base_8h.html">usrp2_base.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>