GNU Radio C++ API
microtune_4937.h
Go to the documentation of this file.
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_4937_H
24 #define INCLUDED_MICROTUNE_4937_H
25 
26 #include <gr_core_api.h>
27 #include <microtune_xxxx.h>
28 
29 /*!
30  * \brief class for controlling microtune 4937 tuner module
31  * \ingroup hardware
32  */
34 public:
35  microtune_4937 (i2c_sptr i2c, int i2c_addr = 0x61);
36  virtual ~microtune_4937 ();
37 
38  /*!
39  * \brief select RF frequency to be tuned to output frequency.
40  * \p freq is the requested frequency in Hz, \p actual_freq
41  * is set to the actual frequency tuned. It takes about 100 ms
42  * for the PLL to settle.
43  *
44  * \returns true iff sucessful.
45  */
46  bool set_RF_freq (double freq, double *actual_freq);
47 
48  /*!
49  * \returns true iff PLL is locked
50  */
51  bool pll_locked_p ();
52 
53  /*!
54  * \returns the output frequency (IF center freq) of the tuner in Hz.
55  */
56  double get_output_freq ();
57 
58  private:
59 
60  i2c_sptr d_i2c;
61  int d_i2c_addr;
62  int d_reference_divider;
63  bool d_fast_tuning_p; /* if set, higher charge pump current:
64  faster tuning, worse phase noise
65  for distance < 10kHz to the carrier */
66 };
67 
68 #endif /* INCLUDED_MICROTUNE_4937_H */