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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008,2010 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_SINK_BASE_H
  24 #define INCLUDED_USRP2_SINK_BASE_H
  25
  26 #include <usrp2_base.h>
  27
  28 /*!
  29  * Base class for all USRP2 transmit blocks
  30  */
  31 class usrp2_sink_base : public usrp2_base
  32 {
  33 protected:
  34   usrp2_sink_base(const char *name,
  35                   gr_io_signature_sptr input_signature,
  36                   const std::string &ifc,
  37                   const std::string &mac)
  38     throw (std::runtime_error);
  39
  40   bool d_should_wait;
  41   usrp2::fpga_timestamp d_tx_time;
  42
  43 public:
  44   ~usrp2_sink_base();
  45
  46   /*!
  47    * \brief Set antenna
  48    */
  49   bool set_antenna(int ant);
  50
  51   /*!
  52    * \brief Set transmitter gain
  53    */
  54   bool set_gain(double gain);
  55
  56   /*!
  57    * \brief Set transmitter LO offset frequency
  58    */
  59   bool set_lo_offset(double frequency);
  60
  61   /*!
  62    * \brief Set transmitter center frequency
  63    */
  64   bool set_center_freq(double frequency, usrp2::tune_result *tr);
  65
  66   /*!
  67    * \brief Set transmit interpolation rate
  68    */
  69   bool set_interp(int interp_factor);
  70
  71   /*!
  72    * \brief Calculate default scale_iq for given interpolation factor
  73    */
  74   void default_scale_iq(int interpolation_factor, int *scale_i, int *scale_q);
  75
  76   /*!
  77    * \brief Set transmit IQ scale factors
  78    */
  79   bool set_scale_iq(int scale_i, int scale_q);
  80
  81   /*!
  82    * \brief Get transmit interpolation rate
  83    */
  84   int interp();
  85
  86   /*!
  87    * \brief Get DAC sample rate in Hz
  88    */
  89   bool dac_rate(long *rate);
  90
  91   /*!
  92    * \brief Returns minimum Tx gain
  93    */
  94   double gain_min();
  95
  96   /*!
  97    * \brief Returns maximum Tx gain
  98    */
  99   double gain_max();
 100
 101   /*!
 102    * \brief Returns Tx gain db_per_step
 103    */
 104   double gain_db_per_step();
 105
 106   /*!
 107    * \brief Returns minimum Tx center frequency
 108    */
 109   double freq_min();
 110
 111   /*!
 112    * \brief Returns maximum Tx center frequency
 113    */
 114   double freq_max();
 115
 116   /*!
 117    * \brief Get Tx daughterboard ID
 118    *
 119    * \param[out] dbid returns the daughterboard id.
 120    *
 121    * daughterboard id >= 0 if successful, -1 if no daugherboard installed,
 122    * -2 if invalid EEPROM on daughterboard.
 123    */
 124   bool daughterboard_id(int *dbid);
 125
 126   /*!
 127    * \brief Set daughterboard GPIO data direction register.
 128    */
 129   bool set_gpio_ddr(uint16_t value, uint16_t mask);
 130
 131   /*!
 132    * \brief Set daughterboard GPIO output selection register.
 133    */
 134   bool set_gpio_sels(std::string sels);
 135
 136   /*!
 137    * \brief Set daughterboard GPIO pin values.
 138    */
 139   bool write_gpio(uint16_t value, uint16_t mask);
 140
 141   /*!
 142    * \brief Read daughterboard GPIO pin values
 143    */
 144   bool read_gpio(uint16_t *value);
 145
 146   /*!
 147    * \brief First samples begin streaming to USRP2 at given time
 148    */
 149   bool start_streaming_at(usrp2::fpga_timestamp time);
 150 };
 151
 152 #endif /* INCLUDED_USRP2_SINK_BASE_H */