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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2001,2003 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_4702_H
  24 #define INCLUDED_MICROTUNE_4702_H
  25
  26 #include <microtune_xxxx.h>
  27
  28 /*!
  29  * \brief class for controlling microtune 4702 tuner module
  30  * \ingroup hardware
  31  */
  32
  33 class microtune_4702 : public microtune_xxxx   {
  34 public:
  35   microtune_4702 (i2c_sptr i2c, int i2c_addr);
  36
  37   virtual ~microtune_4702 ();
  38
  39   /*!
  40    * \brief select RF frequency to be tuned to output frequency.
  41    * \p freq is the requested frequency in Hz, \p actual_freq
  42    * is set to the actual frequency tuned.  It takes about 100 ms
  43    * for the PLL to settle.
  44    *
  45    * \returns true iff sucessful.
  46    */
  47   bool set_RF_freq (double freq, double *actual_freq);
  48
  49   /*!
  50    * \returns true iff PLL is locked
  51    */
  52   bool pll_locked_p ();
  53
  54   /*!
  55    * \returns the output frequency of the tuner in Hz.
  56    */
  57   double get_output_freq ();
  58
  59  private:
  60
  61   i2c_sptr      d_i2c;
  62   int           d_i2c_addr;
  63   int           d_reference_divider;
  64   bool          d_prescaler;    /* if set, higher charge pump current:
  65                                    faster tuning, worse phase noise
  66                                    for distance < 10kHz to the carrier */
  67 };
  68
  69 #endif /* INCLUDED_MICROTUNE_4702_H */
  70