3 * Copyright 2001,2003,2004 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
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.
23 #ifndef INCLUDED_MICROTUNE_XXXX_H
24 #define INCLUDED_MICROTUNE_XXXX_H
26 #include <boost/shared_ptr.hpp>
29 typedef boost::shared_ptr<i2c> i2c_sptr;
32 * \brief abstract class for controlling microtune {4937,4702} tuner modules
34 class microtune_xxxx {
37 virtual ~microtune_xxxx ();
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.
45 * \returns true iff sucessful.
47 virtual bool set_RF_freq (double freq, double *actual_freq) = 0;
49 // returns actual freq or 0 if error (easier interface for SWIG)
50 double set_RF_freq (double freq);
53 * \returns true iff PLL is locked
55 virtual bool pll_locked_p () = 0;
58 * \returns the output frequency (IF center freq) of the tuner in Hz.
60 virtual double get_output_freq () = 0;
64 #endif /* INCLUDED_MICROTUNE_XXXX_H */