For USRP2, implement auto scaling of TX pipeline such that [-1.0 1.0] input to
[debian/gnuradio] / gr-usrp2 / src / usrp2_sink_base.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008 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_USRP2_SINK_BASE_H
24 #define INCLUDED_USRP2_SINK_BASE_H
25
26 #include <usrp2_base.h>
27
28 /*!
29  * Base class for all USRP2 transmit blocks
30  */
31 class usrp2_sink_base : public usrp2_base 
32 {
33 protected:
34   usrp2_sink_base(const char *name,
35                   gr_io_signature_sptr input_signature,
36                   const std::string &ifc,
37                   const std::string &mac)
38     throw (std::runtime_error);
39
40 public:
41   ~usrp2_sink_base();
42
43   /*!
44    * \brief Set transmitter gain
45    */
46   bool set_gain(double gain);
47
48   /*!
49    * \brief Set transmitter center frequency
50    */
51   bool set_center_freq(double frequency, usrp2::tune_result *tr);
52    
53   /*!
54    * \brief Set transmit interpolation rate
55    */
56   bool set_interp(int interp_factor);
57
58   /*!
59    * \brief Calculate default scale_iq for given interpolation factor
60    */
61   void default_scale_iq(int interpolation_factor, int *scale_i, int *scale_q);
62
63   /*!
64    * \brief Set transmit IQ scale factors
65    */
66   bool set_scale_iq(int scale_i, int scale_q);
67
68   /*!
69    * \brief Get transmit interpolation rate
70    */
71   int interp();
72
73   /*!
74    * \brief Get DAC sample rate in Hz 
75    */
76   bool dac_rate(long *rate);
77
78   /*!
79    * \brief Returns minimum Tx gain 
80    */
81   double gain_min();
82
83   /*!
84    * \brief Returns maximum Tx gain 
85    */
86   double gain_max();
87   
88   /*!
89    * \brief Returns Tx gain db_per_step
90    */
91   double gain_db_per_step();
92
93   /*!
94    * \brief Returns minimum Tx center frequency
95    */
96   double freq_min();
97
98   /*!
99    * \brief Returns maximum Tx center frequency
100    */
101   double freq_max();
102
103   /*!
104    * \brief Get Tx daughterboard ID
105    *
106    * \param[out] dbid returns the daughterboard id.
107    *
108    * daughterboard id >= 0 if successful, -1 if no daugherboard installed,
109    * -2 if invalid EEPROM on daughterboard.
110    */
111   bool daughterboard_id(int *dbid);
112 };
113
114 #endif /* INCLUDED_USRP2_SINK_BASE_H */