Merged r10383:10390 from jcorgan/u2-wip into trunk.
[debian/gnuradio] / usrp2 / host / lib / usrp2_impl.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008,2009 Free Software Foundation, Inc.
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef INCLUDED_USRP2_IMPL_H
20 #define INCLUDED_USRP2_IMPL_H
21
22 #include <usrp2/usrp2.h>
23 #include <usrp2/data_handler.h>
24 #include <usrp2_eth_packet.h>
25 #include <boost/scoped_ptr.hpp>
26 #include "control.h"
27 #include "ring.h"
28 #include <string>
29
30 #define MAX_SUBPKT_LEN 252
31
32 namespace usrp2 {
33   
34   class eth_buffer;
35   class pktfilter;
36   class usrp2_thread;
37   class usrp2_tune_result;
38   class pending_reply;
39   class ring;
40
41   //! High-level d'board info
42   struct db_info {
43     int         dbid;
44     double      freq_min;               // Hz
45     double      freq_max;               // Hz
46     double      gain_min;               // dB
47     double      gain_max;               // dB
48     double      gain_step_size;         // dB
49
50     db_info() : dbid(-1), freq_min(0), freq_max(0),
51                 gain_min(0), gain_max(0), gain_step_size(0) {}
52   };
53
54   class usrp2::impl : private data_handler
55   {
56     static const size_t NRIDS = 256;
57     static const size_t NCHANS = 32;
58
59     eth_buffer    *d_eth_buf;
60     pktfilter     *d_pf;
61     std::string    d_addr;       // FIXME: use u2_mac_addr_t instead
62     usrp2_thread  *d_bg_thread;
63     volatile bool  d_bg_running; // TODO: multistate if needed
64     
65     int            d_rx_seqno;
66     int            d_tx_seqno;
67     int            d_next_rid;
68     unsigned int   d_num_rx_frames;
69     unsigned int   d_num_rx_missing;
70     unsigned int   d_num_rx_overruns;
71     unsigned int   d_num_rx_bytes;
72
73     unsigned int   d_num_enqueued;
74     omni_mutex     d_enqueued_mutex;
75     omni_condition d_bg_pending_cond;
76
77     // all pending_replies are stack allocated, thus no possibility of leaking these
78     pending_reply *d_pending_replies[NRIDS]; // indexed by 8-bit reply id
79
80     std::vector<ring_sptr>   d_channel_rings; // indexed by 5-bit channel number
81
82     db_info        d_tx_db_info;
83     db_info        d_rx_db_info;
84
85     int            d_tx_interp;         // shadow tx interp 
86     int            d_rx_decim;          // shadow rx decim
87
88     void inc_enqueued() {
89       omni_mutex_lock l(d_enqueued_mutex);
90       d_num_enqueued++;
91     }
92     
93     void dec_enqueued() {
94       omni_mutex_lock l(d_enqueued_mutex);
95       if (--d_num_enqueued == 0)
96         d_bg_pending_cond.signal();
97     }
98     
99     static bool parse_mac_addr(const std::string &s, u2_mac_addr_t *p);
100     void init_et_hdrs(u2_eth_packet_t *p, const std::string &dst);
101     void init_etf_hdrs(u2_eth_packet_t *p, const std::string &dst,
102                        int word0_flags, int chan, uint32_t timestamp);
103     void stop_bg();
104     void init_config_rx_v2_cmd(op_config_rx_v2_cmd *cmd);
105     void init_config_tx_v2_cmd(op_config_tx_v2_cmd *cmd);
106     bool transmit_cmd(void *cmd, size_t len, pending_reply *p, double secs=0.0);
107     virtual data_handler::result operator()(const void *base, size_t len);
108     data_handler::result handle_control_packet(const void *base, size_t len);
109     data_handler::result handle_data_packet(const void *base, size_t len);
110     bool dboard_info();
111     bool reset_db();
112
113   public:
114     impl(const std::string &ifc, props *p);
115     ~impl();
116     
117     void bg_loop();
118
119     std::string mac_addr() const { return d_addr; } // FIXME: convert from u2_mac_addr_t
120
121     // Rx
122
123     bool set_rx_gain(double gain);
124     double rx_gain_min() { return d_rx_db_info.gain_min; }
125     double rx_gain_max() { return d_rx_db_info.gain_max; }
126     double rx_gain_db_per_step() { return d_rx_db_info.gain_step_size; }
127     bool set_rx_lo_offset(double frequency);
128     bool set_rx_center_freq(double frequency, tune_result *result);
129     double rx_freq_min() { return d_rx_db_info.freq_min; }
130     double rx_freq_max() { return d_rx_db_info.freq_max; }
131     bool set_rx_decim(int decimation_factor);
132     int rx_decim() { return d_rx_decim; }
133     bool set_rx_scale_iq(int scale_i, int scale_q);
134     bool start_rx_streaming(unsigned int channel, unsigned int items_per_frame);
135     bool rx_samples(unsigned int channel, rx_sample_handler *handler);
136     bool stop_rx_streaming(unsigned int channel);
137     unsigned int rx_overruns() const { return d_num_rx_overruns; }
138     unsigned int rx_missing() const { return d_num_rx_missing; }
139
140     // Tx
141
142     bool set_tx_gain(double gain);
143     double tx_gain_min() { return d_tx_db_info.gain_min; }
144     double tx_gain_max() { return d_tx_db_info.gain_max; }
145     double tx_gain_db_per_step() { return d_tx_db_info.gain_step_size; }
146     bool set_tx_lo_offset(double frequency);
147     bool set_tx_center_freq(double frequency, tune_result *result);
148     double tx_freq_min() { return d_tx_db_info.freq_min; }
149     double tx_freq_max() { return d_tx_db_info.freq_max; }
150     bool set_tx_interp(int interpolation_factor);
151     int tx_interp() { return d_tx_interp; }
152     void default_tx_scale_iq(int interpolation_factor, int *scale_i, int *scale_q);
153     bool set_tx_scale_iq(int scale_i, int scale_q);
154
155     bool tx_32fc(unsigned int channel,
156                  const std::complex<float> *samples,
157                  size_t nsamples,
158                  const tx_metadata *metadata);
159
160     bool tx_16sc(unsigned int channel,
161                  const std::complex<int16_t> *samples,
162                  size_t nsamples,
163                  const tx_metadata *metadata);
164
165     bool tx_raw(unsigned int channel,
166                 const uint32_t *items,
167                 size_t nitems,
168                 const tx_metadata *metadata);
169
170     // misc
171
172     bool config_mimo(int flags);
173     bool fpga_master_clock_freq(long *freq);
174     bool adc_rate(long *rate);
175     bool dac_rate(long *rate);
176     bool tx_daughterboard_id(int *dbid);
177     bool rx_daughterboard_id(int *dbid);
178
179     // low level
180
181     bool burn_mac_addr(const std::string &new_addr);
182     bool sync_to_pps();
183     std::vector<uint32_t> peek32(uint32_t addr, uint32_t words);
184     bool poke32(uint32_t addr, const std::vector<uint32_t> &data);
185   };
186   
187 } // namespace usrp2
188
189 #endif /* INCLUDED_USRP2_IMPL_H */