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