aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/usrp/usrp2/usrp2_impl.hpp
blob: bb4554e8da71e7d41751968caa610135e81f3711 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef INCLUDED_USRP2_IMPL_HPP
#define INCLUDED_USRP2_IMPL_HPP

#include "usrp2_iface.hpp"
#include "clock_ctrl.hpp"
#include "codec_ctrl.hpp"
#include "serdes_ctrl.hpp"
#include <uhd/usrp/usrp2.hpp>
#include <uhd/types/dict.hpp>
#include <uhd/types/otw_type.hpp>
#include <uhd/types/stream_cmd.hpp>
#include <uhd/types/clock_config.hpp>
#include <uhd/usrp/dboard_eeprom.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <uhd/transport/vrt.hpp>
#include <uhd/transport/udp_zero_copy.hpp>
#include <uhd/usrp/dboard_manager.hpp>

/*!
 * Make a usrp2 dboard interface.
 * \param iface the usrp2 interface object
 * \param clk_ctrl the clock control object
 * \return a sptr to a new dboard interface
 */
uhd::usrp::dboard_iface::sptr make_usrp2_dboard_iface(
    usrp2_iface::sptr iface,
    clock_ctrl::sptr clk_ctrl
);

/*!
 * Simple wax obj proxy class:
 * Provides a wax obj interface for a set and a get function.
 * This allows us to create nested properties structures
 * while maintaining flattened code within the implementation.
 */
class wax_obj_proxy : public wax::obj{
public:
    typedef boost::function<void(const wax::obj &, wax::obj &)>       get_t;
    typedef boost::function<void(const wax::obj &, const wax::obj &)> set_t;
    typedef boost::shared_ptr<wax_obj_proxy> sptr;

    static sptr make(const get_t &get, const set_t &set){
        return sptr(new wax_obj_proxy(get, set));
    }

    ~wax_obj_proxy(void){
        /* NOP */
    }

private:
    get_t _get;
    set_t _set;

    wax_obj_proxy(const get_t &get, const set_t &set){
        _get = get;
        _set = set;
    };

    void get(const wax::obj &key, wax::obj &val){
        return _get(key, val);
    }

    void set(const wax::obj &key, const wax::obj &val){
        return _set(key, val);
    }
};

/*!
 * USRP2 implementation guts:
 * The implementation details are encapsulated here.
 * Handles properties on the mboard, dboard, dsps...
 */
class usrp2_impl : public uhd::device{
public:
    /*!
     * Create a new usrp2 impl base.
     * \param ctrl_transport the udp transport for control
     * \param data_transport the udp transport for data
     */
    usrp2_impl(
        uhd::transport::udp_simple::sptr ctrl_transport,
        uhd::transport::udp_zero_copy::sptr data_transport
    );

    ~usrp2_impl(void);

    //the io interface
    size_t get_max_send_samps_per_packet(void) const{
        return _max_tx_bytes_per_packet/_tx_otw_type.get_sample_size();
    }
    size_t send(
        const boost::asio::const_buffer &,
        const uhd::tx_metadata_t &,
        const uhd::io_type_t &,
        uhd::device::send_mode_t
    );
    size_t get_max_recv_samps_per_packet(void) const{
        return _max_rx_bytes_per_packet/_rx_otw_type.get_sample_size();
    }
    size_t recv(
        const boost::asio::mutable_buffer &,
        uhd::rx_metadata_t &,
        const uhd::io_type_t &,
        uhd::device::recv_mode_t
    );

private:
    double get_master_clock_freq(void){
        return _iface->get_master_clock_freq();
    }

    //device properties interface
    void get(const wax::obj &, wax::obj &);
    void set(const wax::obj &, const wax::obj &);

    //interfaces
    usrp2_iface::sptr _iface;
    clock_ctrl::sptr _clock_ctrl;
    codec_ctrl::sptr _codec_ctrl;
    serdes_ctrl::sptr _serdes_ctrl;

    /*******************************************************************
     * Deal with the rx and tx packet sizes
     ******************************************************************/
    static const size_t _mtu = 1500; //FIXME we have no idea
    static const size_t _hdrs = (2 + 14 + 20 + 8); //size of headers (pad, eth, ip, udp)
    static const size_t _max_rx_bytes_per_packet =
        _mtu - _hdrs -
        USRP2_HOST_RX_VRT_HEADER_WORDS32*sizeof(boost::uint32_t) -
        USRP2_HOST_RX_VRT_TRAILER_WORDS32*sizeof(boost::uint32_t)
    ;
    static const size_t _max_tx_bytes_per_packet =
        _mtu - _hdrs -
        uhd::transport::vrt::max_header_words32*sizeof(boost::uint32_t)
    ;

    uhd::otw_type_t _rx_otw_type, _tx_otw_type;
    struct io_impl; boost::shared_ptr<io_impl> _io_impl;
    void io_init(void);

    //udp transports for control and data
    uhd::transport::udp_zero_copy::sptr _data_transport;

    //methods and shadows for clock configuration
    uhd::clock_config_t _clock_config;
    void init_clock_config(void);
    void update_clock_config(void);
    void set_time_spec(const uhd::time_spec_t &time_spec, bool now);

    //rx and tx dboard methods and objects
    uhd::usrp::dboard_manager::sptr _dboard_manager;
    uhd::usrp::dboard_iface::sptr _dboard_iface;
    void dboard_init(void);

    //properties for the mboard
    void mboard_init(void);
    void mboard_get(const wax::obj &, wax::obj &);
    void mboard_set(const wax::obj &, const wax::obj &);
    wax_obj_proxy::sptr _mboard_proxy;

    //properties interface for rx dboard
    void rx_dboard_get(const wax::obj &, wax::obj &);
    void rx_dboard_set(const wax::obj &, const wax::obj &);
    wax_obj_proxy::sptr _rx_dboard_proxy;
    uhd::prop_names_t _rx_subdevs_in_use;
    uhd::usrp::dboard_eeprom_t _rx_db_eeprom;

    //properties interface for tx dboard
    void tx_dboard_get(const wax::obj &, wax::obj &);
    void tx_dboard_set(const wax::obj &, const wax::obj &);
    wax_obj_proxy::sptr _tx_dboard_proxy;
    uhd::prop_names_t _tx_subdevs_in_use;
    uhd::usrp::dboard_eeprom_t _tx_db_eeprom;
    void update_rx_mux_config(void);
    void update_tx_mux_config(void);

    //methods and shadows for the ddc dsp
    std::vector<size_t> _allowed_decim_and_interp_rates;
    size_t _ddc_decim;
    double _ddc_freq;
    void init_ddc_config(void);
    void update_ddc_config(void);
    void issue_ddc_stream_cmd(const uhd::stream_cmd_t &stream_cmd);

    //methods and shadows for the duc dsp
    size_t _duc_interp;
    double _duc_freq;
    void init_duc_config(void);
    void update_duc_config(void);

    //properties interface for ddc
    void ddc_get(const wax::obj &, wax::obj &);
    void ddc_set(const wax::obj &, const wax::obj &);
    wax_obj_proxy::sptr _rx_dsp_proxy;

    //properties interface for duc
    void duc_get(const wax::obj &, wax::obj &);
    void duc_set(const wax::obj &, const wax::obj &);
    wax_obj_proxy::sptr _tx_dsp_proxy;

};

#endif /* INCLUDED_USRP2_IMPL_HPP */