git.gag.com Git - debian/gnuradio/blob - gr-usrp2/src/usrp2_source_base.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008,2009 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_USRP2_SOURCE_BASE_H
  24 #define INCLUDED_USRP2_SOURCE_BASE_H
  25
  26 #include <usrp2_base.h>
  27
  28 /*!
  29  * Base class for all USRP2 source blocks
  30  */
  31 class usrp2_source_base : public usrp2_base
  32 {
  33 protected:
  34   usrp2_source_base(const char *name,
  35                     gr_io_signature_sptr output_signature,
  36                     const std::string &ifc,
  37                     const std::string &mac)
  38     throw (std::runtime_error);
  39
  40 public:
  41   ~usrp2_source_base();
  42
  43   /*!
  44    * \brief Set receiver gain
  45    */
  46   bool set_gain(double gain);
  47
  48   /*!
  49    * \brief Set receive LO offset frequency
  50    */
  51   bool set_lo_offset(double frequency);
  52
  53   /*!
  54    * \brief Set receiver center frequency
  55    */
  56   bool set_center_freq(double frequency, usrp2::tune_result *tr);
  57
  58   /*!
  59    * \brief Set receive decimation rate
  60    */
  61   bool set_decim(int decimation_factor);
  62
  63   /*!
  64    * \brief Set receive IQ scale factors
  65    */
  66   bool set_scale_iq(int scale_i, int scale_q);
  67
  68   /*!
  69    * \brief Get receive decimation rate
  70    */
  71   int decim();
  72
  73   /*!
  74    * \brief Get the ADC sample rate
  75    */
  76   bool adc_rate(long *rate);
  77
  78   /*!
  79    * \brief Returns minimum Rx gain
  80    */
  81   double gain_min();
  82
  83   /*!
  84    * \brief Returns maximum Rx gain
  85    */
  86   double gain_max();
  87
  88   /*!
  89    * \brief Returns Rx gain db_per_step
  90    */
  91   double gain_db_per_step();
  92
  93   /*!
  94    * \brief Returns minimum Rx center frequency
  95    */
  96   double freq_min();
  97
  98   /*!
  99    * \brief Returns maximum Rx center frequency
 100    */
 101   double freq_max();
 102
 103   /*!
 104    * \brief Get Rx daughterboard ID
 105    *
 106    * \param[out] dbid returns the daughterboard id.
 107    *
 108    * daughterboard id >= 0 if successful, -1 if no daugherboard installed,
 109    * -2 if invalid EEPROM on daughterboard.
 110    */
 111   bool daughterboard_id(int *dbid);
 112
 113   /*!
 114    * \brief Returns number of receiver overruns
 115    */
 116   unsigned int overruns();
 117
 118   /*!
 119    * \brief Returns number of missing sequence numbers
 120    */
 121   unsigned int missing();
 122
 123   /*!
 124    * \brief Called by scheduler when starting flowgraph
 125    */
 126   virtual bool start();
 127
 128   /*!
 129    * \brief Called by scheduler when stopping flowgraph
 130    */
 131   virtual bool stop();
 132
 133   /*!
 134    * \brief Set daughterboard GPIO data direction register.
 135    */
 136   bool set_gpio_ddr(uint16_t value, uint16_t mask);
 137
 138   /*!
 139    * \brief Set daughterboard GPIO output selection register.
 140    */
 141   bool set_gpio_sels(std::string sels);
 142
 143   /*!
 144    * \brief Set daughterboard GPIO pin values.
 145    */
 146   bool write_gpio(uint16_t value, uint16_t mask);
 147
 148   /*!
 149    * \brief Read daughterboard GPIO pin values
 150    */
 151   bool read_gpio(uint16_t *value);
 152
 153   /*!
 154    * \brief Enable streaming GPIO in sample LSBs
 155    */
 156   bool enable_gpio_streaming(int enable);
 157 };
 158
 159 #endif /* INCLUDED_USRP2_SOURCE_BASE_H */