git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h

   1 /* -*- C++ -*- */
   2 /*
   3  * Copyright 2001,2004 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_MICROTUNE_XXXX_EVAL_BOARD_H
  24 #define INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H
  25
  26 #include <boost/shared_ptr.hpp>
  27
  28 class microtune_xxxx;
  29
  30 class ppio;
  31 typedef boost::shared_ptr<ppio> ppio_sptr;
  32
  33 class i2c;
  34 typedef boost::shared_ptr<i2c> i2c_sptr;
  35
  36 /*!
  37  * \brief abstract class for controlling microtune xxxx eval board
  38  * \ingroup hardware
  39  */
  40 class microtune_xxxx_eval_board {
  41 public:
  42   microtune_xxxx_eval_board (int which_pp = 0);
  43   virtual ~microtune_xxxx_eval_board ();
  44
  45   //! is the eval board present?
  46   bool board_present_p ();
  47
  48   /*!
  49    * \brief set RF and IF AGC control voltages ([0, 5] volts)
  50    */
  51   void set_RF_AGC_voltage (float volts);
  52   void set_IF_AGC_voltage (float volts);
  53
  54   /*!
  55    * \brief set RF and IF AGC levels together (scale [0, 1000])
  56    *
  57    * This provides a simple linear interface for adjusting both
  58    * the RF and IF gain in consort.  This is the easy to use interface.
  59    * 0 corresponds to minimum gain. 1000 corresponds to maximum gain.
  60    */
  61   virtual void set_AGC (float value_0_1000) = 0;
  62
  63   /*!
  64    * \brief select RF frequency to be tuned to output frequency.
  65    * \p freq is the requested frequency in Hz, \p actual_freq
  66    * is set to the actual frequency tuned.  It takes about 100 ms
  67    * for the PLL to settle.
  68    *
  69    * \returns true iff sucessful.
  70    */
  71   bool set_RF_freq (double freq, double *actual_freq);
  72
  73   // returns actual freq or 0 if error (easier interface for SWIG)
  74   double set_RF_freq (double freq);
  75
  76   /*!
  77    * \returns true iff PLL is locked
  78    */
  79   bool pll_locked_p ();
  80
  81   /*!
  82    * \returns the output frequency (IF center freq) of the tuner in Hz.
  83    */
  84   double get_output_freq ();
  85
  86
  87 private:
  88   void write_dac (int which, int value);
  89   void write_both_dacs (int val0, int val1);
  90
  91 protected:
  92   ppio_sptr             d_ppio;
  93   i2c_sptr              d_i2c;
  94   microtune_xxxx       *d_tuner;
  95 };
  96
  97 #endif /* INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H */