usrp: created multi-usrp (multi chan, multi board), and deprecated mimo-usrp

4 files changed, 429 insertions, 4 deletions

diff --git a/host/lib/usrp/CMakeLists.txt b/host/lib/usrp/CMakeLists.txt
index 69a190bfa..d8898caff 100644
--- a/host/lib/usrp/CMakeLists.txt
+++ b/host/lib/usrp/CMakeLists.txt
@@ -25,6 +25,7 @@ LIBUHD_APPEND_SOURCES(
     ${CMAKE_SOURCE_DIR}/lib/usrp/dsp_utils.cpp
     ${CMAKE_SOURCE_DIR}/lib/usrp/mimo_usrp.cpp
     ${CMAKE_SOURCE_DIR}/lib/usrp/misc_utils.cpp
+    ${CMAKE_SOURCE_DIR}/lib/usrp/multi_usrp.cpp
     ${CMAKE_SOURCE_DIR}/lib/usrp/simple_usrp.cpp
     ${CMAKE_SOURCE_DIR}/lib/usrp/single_usrp.cpp
     ${CMAKE_SOURCE_DIR}/lib/usrp/subdev_spec.cpp
diff --git a/host/lib/usrp/mimo_usrp.cpp b/host/lib/usrp/mimo_usrp.cpp
index 08618c288..f5a80a3e6 100644
--- a/host/lib/usrp/mimo_usrp.cpp
+++ b/host/lib/usrp/mimo_usrp.cpp
@@ -347,5 +347,11 @@ private:
  * The Make Function
  **********************************************************************/
 mimo_usrp::sptr mimo_usrp::make(const device_addr_t &dev_addr){
+    uhd::print_warning(
+        "The mimo USRP interface has been deprecated.\n"
+        "Please switch to the multi USRP interface.\n"
+        "#include <uhd/usrp/multi_usrp.hpp>\n"
+        "multi_usrp::sptr sdev = multi_usrp::make(args);\n"
+    );
     return sptr(new mimo_usrp_impl(dev_addr));
 }
diff --git a/host/lib/usrp/multi_usrp.cpp b/host/lib/usrp/multi_usrp.cpp
new file mode 100644
index 000000000..d0fc5c0f6
--- /dev/null
+++ b/host/lib/usrp/multi_usrp.cpp
@@ -0,0 +1,422 @@
+//
+// 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/>.
+//
+
+#include <uhd/usrp/multi_usrp.hpp>
+#include <uhd/usrp/tune_helper.hpp>
+#include <uhd/utils/assert.hpp>
+#include <uhd/utils/warning.hpp>
+#include <uhd/utils/gain_group.hpp>
+#include <uhd/usrp/subdev_props.hpp>
+#include <uhd/usrp/mboard_props.hpp>
+#include <uhd/usrp/device_props.hpp>
+#include <uhd/usrp/dboard_props.hpp>
+#include <uhd/usrp/dsp_props.hpp>
+#include <boost/thread.hpp>
+#include <boost/foreach.hpp>
+#include <boost/format.hpp>
+#include <stdexcept>
+#include <iostream>
+
+using namespace uhd;
+using namespace uhd::usrp;
+
+static inline freq_range_t add_dsp_shift(const freq_range_t &range, wax::obj dsp){
+    double codec_rate = dsp[DSP_PROP_CODEC_RATE].as<double>();
+    return freq_range_t(range.min - codec_rate/2.0, range.max + codec_rate/2.0);
+}
+
+/***********************************************************************
+ * Simple USRP Implementation
+ **********************************************************************/
+class multi_usrp_impl : public multi_usrp{
+public:
+    multi_usrp_impl(const device_addr_t &addr){
+        _dev = device::make(addr);
+    }
+
+    device::sptr get_device(void){
+        return _dev;
+    }
+
+    /*******************************************************************
+     * Mboard methods
+     ******************************************************************/
+    std::string get_pp_string(void){
+        std::string buff = str(boost::format(
+            "Multi USRP:\n"
+            "  Device: %s\n"
+        )
+            % (*_dev)[DEVICE_PROP_NAME].as<std::string>()
+        );
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            buff += str(boost::format(
+                "  Mboard %d: %s\n"
+            ) % m
+                % _mboard(m)[MBOARD_PROP_NAME].as<std::string>()
+            );
+        }
+
+        //----------- rx side of life ----------------------------------
+        for (size_t m = 0, chan = 0; m < get_num_mboards(); m++){
+            buff += str(boost::format(
+                "  RX DSP %d: %s\n"
+            ) % m
+                % _rx_dsp(m)[DSP_PROP_NAME].as<std::string>()
+            );
+            for (; chan < (m + 1)*get_rx_subdev_spec(m).size(); chan++){
+                buff += str(boost::format(
+                    "  RX Channel: %u\n"
+                    "    RX Dboard: %s\n"
+                    "    RX Subdev: %s\n"
+                ) % chan
+                    % _rx_dboard(chan)[DBOARD_PROP_NAME].as<std::string>()
+                    % _rx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>()
+                );
+            }
+        }
+
+        //----------- tx side of life ----------------------------------
+        for (size_t m = 0, chan = 0; m < get_num_mboards(); m++){
+            buff += str(boost::format(
+                "  TX DSP %d: %s\n"
+            ) % m
+                % _tx_dsp(m)[DSP_PROP_NAME].as<std::string>()
+            );
+            for (; chan < (m + 1)*get_tx_subdev_spec(m).size(); chan++){
+                buff += str(boost::format(
+                    "  TX Channel: %u\n"
+                    "    TX Dboard: %s\n"
+                    "    TX Subdev: %s\n"
+                ) % chan
+                    % _tx_dboard(chan)[DBOARD_PROP_NAME].as<std::string>()
+                    % _tx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>()
+                );
+            }
+        }
+
+        return buff;
+    }
+
+    std::string get_mboard_name(size_t mboard){
+        return _mboard(mboard)[MBOARD_PROP_NAME].as<std::string>();
+    }
+
+    time_spec_t get_time_now(void){
+        return _mboard(0)[MBOARD_PROP_TIME_NOW].as<time_spec_t>();
+    }
+
+    void set_time_next_pps(const time_spec_t &time_spec){
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            _mboard(m)[MBOARD_PROP_TIME_NEXT_PPS] = time_spec;
+        }
+    }
+
+    void set_time_unknown_pps(const time_spec_t &time_spec){
+        std::cout << "Set time with unknown pps edge:" << std::endl;
+        std::cout << "    1) set times next pps (race condition)" << std::endl;
+        set_time_next_pps(time_spec);
+        boost::this_thread::sleep(boost::posix_time::seconds(1));
+
+        std::cout << "    2) catch seconds rollover at pps edge" << std::endl;
+        time_t last_secs = 0, curr_secs = 0;
+        while(curr_secs == last_secs){
+            last_secs = curr_secs;
+            curr_secs = get_time_now().get_full_secs();
+        }
+
+        std::cout << "    3) set times next pps (synchronously)" << std::endl;
+        set_time_next_pps(time_spec);
+        boost::this_thread::sleep(boost::posix_time::seconds(1));
+
+        //verify that the time registers are read to be within a few RTT
+        for (size_t m = 1; m < get_num_mboards(); m++){
+            time_spec_t time_0 = _mboard(0)[MBOARD_PROP_TIME_NOW].as<time_spec_t>();
+            time_spec_t time_i = _mboard(m)[MBOARD_PROP_TIME_NOW].as<time_spec_t>();
+            if (time_i < time_0 or (time_i - time_0) > time_spec_t(0.01)){ //10 ms: greater than RTT but not too big
+                uhd::print_warning(str(boost::format(
+                    "Detected time deviation between board %d and board 0.\n"
+                    "Board 0 time is %f seconds.\n"
+                    "Board %d time is %f seconds.\n"
+                ) % m % time_0.get_real_secs() % m % time_i.get_real_secs()));
+            }
+        }
+    }
+
+    void issue_stream_cmd(const stream_cmd_t &stream_cmd){
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            _mboard(m)[MBOARD_PROP_STREAM_CMD] = stream_cmd;
+        }
+    }
+
+    void set_clock_config(const clock_config_t &clock_config, size_t mboard){
+        if (mboard != ALL_MBOARDS){
+            _mboard(mboard)[MBOARD_PROP_CLOCK_CONFIG] = clock_config;
+            return;
+        }
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            set_clock_config(clock_config, m);
+        }
+    }
+
+    size_t get_num_mboards(void){
+        return (*_dev)[DEVICE_PROP_MBOARD_NAMES].as<prop_names_t>().size();
+    }
+
+    /*******************************************************************
+     * RX methods
+     ******************************************************************/
+    void set_rx_subdev_spec(const subdev_spec_t &spec, size_t mboard){
+        if (mboard != ALL_MBOARDS){
+            _mboard(mboard)[MBOARD_PROP_RX_SUBDEV_SPEC] = spec;
+            return;
+        }
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            set_rx_subdev_spec(spec, m);
+        }
+    }
+
+    subdev_spec_t get_rx_subdev_spec(size_t mboard){
+        return _mboard(mboard)[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>();
+    }
+
+    size_t get_rx_num_channels(void){
+        size_t nchan = get_rx_subdev_spec(0).size();
+        for (size_t m = 1; m < get_num_mboards(); m++){
+            if (nchan != get_rx_subdev_spec(m).size()){
+                throw std::runtime_error("rx subdev spec size inconsistent across all mboards");
+            }
+        }
+        return nchan;
+    }
+
+    std::string get_rx_subdev_name(size_t chan){
+        return _rx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>();
+    }
+
+    void set_rx_rate(double rate){
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            _rx_dsp(m)[DSP_PROP_HOST_RATE] = rate;
+        }
+    }
+
+    double get_rx_rate(void){
+        return _rx_dsp(0)[DSP_PROP_HOST_RATE].as<double>();
+    }
+
+    tune_result_t set_rx_freq(double target_freq, size_t chan){
+        size_t nchan = get_rx_num_channels();
+        return tune_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(nchan/chan), nchan%chan, target_freq);
+    }
+
+    tune_result_t set_rx_freq(double target_freq, double lo_off, size_t chan){
+        size_t nchan = get_rx_num_channels();
+        return tune_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(nchan/chan), nchan%chan, target_freq, lo_off);
+    }
+
+    double get_rx_freq(size_t chan){
+        size_t nchan = get_rx_num_channels();
+        return derive_freq_from_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(nchan/chan), nchan%chan);
+    }
+
+    freq_range_t get_rx_freq_range(size_t chan){
+        size_t nchan = get_rx_num_channels();
+        return add_dsp_shift(_rx_subdev(chan)[SUBDEV_PROP_FREQ_RANGE].as<freq_range_t>(), _rx_dsp(nchan/chan));
+    }
+
+    void set_rx_gain(float gain, size_t chan){
+        return _rx_gain_group(chan)->set_value(gain);
+    }
+
+    float get_rx_gain(size_t chan){
+        return _rx_gain_group(chan)->get_value();
+    }
+
+    gain_range_t get_rx_gain_range(size_t chan){
+        return _rx_gain_group(chan)->get_range();
+    }
+
+    void set_rx_antenna(const std::string &ant, size_t chan){
+        _rx_subdev(chan)[SUBDEV_PROP_ANTENNA] = ant;
+    }
+
+    std::string get_rx_antenna(size_t chan){
+        return _rx_subdev(chan)[SUBDEV_PROP_ANTENNA].as<std::string>();
+    }
+
+    std::vector<std::string> get_rx_antennas(size_t chan){
+        return _rx_subdev(chan)[SUBDEV_PROP_ANTENNA_NAMES].as<prop_names_t>();
+    }
+
+    bool get_rx_lo_locked(size_t chan){
+        return _rx_subdev(chan)[SUBDEV_PROP_LO_LOCKED].as<bool>();
+    }
+
+    float read_rssi(size_t chan){
+        return _rx_subdev(chan)[SUBDEV_PROP_RSSI].as<float>();
+    }
+
+    dboard_iface::sptr get_rx_dboard_iface(size_t chan){
+        return _rx_dboard(chan)[DBOARD_PROP_DBOARD_IFACE].as<dboard_iface::sptr>();
+    }
+    
+    void set_rx_bandwidth(float bandwidth, size_t chan) {
+        _rx_subdev(chan)[SUBDEV_PROP_BANDWIDTH] = bandwidth;
+    }
+
+    /*******************************************************************
+     * TX methods
+     ******************************************************************/
+    void set_tx_subdev_spec(const subdev_spec_t &spec, size_t mboard){
+        if (mboard != ALL_MBOARDS){
+            _mboard(mboard)[MBOARD_PROP_TX_SUBDEV_SPEC] = spec;
+            return;
+        }
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            set_tx_subdev_spec(spec, m);
+        }
+    }
+
+    subdev_spec_t get_tx_subdev_spec(size_t mboard){
+        return _mboard(mboard)[MBOARD_PROP_TX_SUBDEV_SPEC].as<subdev_spec_t>();
+    }
+
+    std::string get_tx_subdev_name(size_t chan){
+        return _tx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>();
+    }
+
+    size_t get_tx_num_channels(void){
+        size_t nchan = get_tx_subdev_spec(0).size();
+        for (size_t m = 1; m < get_num_mboards(); m++){
+            if (nchan != get_tx_subdev_spec(m).size()){
+                throw std::runtime_error("tx subdev spec size inconsistent across all mboards");
+            }
+        }
+        return nchan;
+    }
+
+    void set_tx_rate(double rate){
+        for (size_t m = 0; m < get_num_mboards(); m++){
+            _tx_dsp(m)[DSP_PROP_HOST_RATE] = rate;
+        }
+    }
+
+    double get_tx_rate(void){
+        return _tx_dsp(0)[DSP_PROP_HOST_RATE].as<double>();
+    }
+
+    tune_result_t set_tx_freq(double target_freq, size_t chan){
+        size_t nchan = get_tx_num_channels();
+        return tune_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(nchan/chan), nchan%chan, target_freq);
+    }
+
+    tune_result_t set_tx_freq(double target_freq, double lo_off, size_t chan){
+        size_t nchan = get_tx_num_channels();
+        return tune_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(nchan/chan), nchan%chan, target_freq, lo_off);
+    }
+
+    double get_tx_freq(size_t chan){
+        size_t nchan = get_tx_num_channels();
+        return derive_freq_from_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(nchan/chan), nchan%chan);
+    }
+
+    freq_range_t get_tx_freq_range(size_t chan){
+        size_t nchan = get_tx_num_channels();
+        return add_dsp_shift(_tx_subdev(chan)[SUBDEV_PROP_FREQ_RANGE].as<freq_range_t>(), _tx_dsp(nchan/chan));
+    }
+
+    void set_tx_gain(float gain, size_t chan){
+        return _tx_gain_group(chan)->set_value(gain);
+    }
+
+    float get_tx_gain(size_t chan){
+        return _tx_gain_group(chan)->get_value();
+    }
+
+    gain_range_t get_tx_gain_range(size_t chan){
+        return _tx_gain_group(chan)->get_range();
+    }
+
+    void set_tx_antenna(const std::string &ant, size_t chan){
+        _tx_subdev(chan)[SUBDEV_PROP_ANTENNA] = ant;
+    }
+
+    std::string get_tx_antenna(size_t chan){
+        return _tx_subdev(chan)[SUBDEV_PROP_ANTENNA].as<std::string>();
+    }
+
+    std::vector<std::string> get_tx_antennas(size_t chan){
+        return _tx_subdev(chan)[SUBDEV_PROP_ANTENNA_NAMES].as<prop_names_t>();
+    }
+
+    bool get_tx_lo_locked(size_t chan){
+        return _tx_subdev(chan)[SUBDEV_PROP_LO_LOCKED].as<bool>();
+    }
+
+    dboard_iface::sptr get_tx_dboard_iface(size_t chan){
+        return _tx_dboard(chan)[DBOARD_PROP_DBOARD_IFACE].as<dboard_iface::sptr>();
+    }
+
+private:
+    device::sptr _dev;
+    wax::obj _mboard(size_t mboard){
+        std::string mb_name = (*_dev)[DEVICE_PROP_MBOARD_NAMES].as<prop_names_t>().at(mboard);
+        return (*_dev)[named_prop_t(DEVICE_PROP_MBOARD, mb_name)];
+    }
+    wax::obj _rx_dsp(size_t mboard){
+        return _mboard(mboard)[MBOARD_PROP_RX_DSP];
+    }
+    wax::obj _tx_dsp(size_t mboard){
+        return _mboard(mboard)[MBOARD_PROP_TX_DSP];
+    }
+    wax::obj _rx_dboard(size_t chan){
+        size_t nchan = get_rx_num_channels();
+        std::string db_name = get_rx_subdev_spec(chan/nchan).at(chan%nchan).db_name;
+        return _mboard(chan/nchan)[named_prop_t(MBOARD_PROP_RX_DBOARD, db_name)];
+    }
+    wax::obj _tx_dboard(size_t chan){
+        size_t nchan = get_tx_num_channels();
+        std::string db_name = get_tx_subdev_spec(chan/nchan).at(chan%nchan).db_name;
+        return _mboard(chan/nchan)[named_prop_t(MBOARD_PROP_TX_DBOARD, db_name)];
+    }
+    wax::obj _rx_subdev(size_t chan){
+        size_t nchan = get_rx_num_channels();
+        std::string sd_name = get_rx_subdev_spec(chan/nchan).at(chan%nchan).sd_name;
+        return _rx_dboard(chan)[named_prop_t(DBOARD_PROP_SUBDEV, sd_name)];
+    }
+    wax::obj _tx_subdev(size_t chan){
+        size_t nchan = get_tx_num_channels();
+        std::string sd_name = get_tx_subdev_spec(chan/nchan).at(chan%nchan).sd_name;
+        return _tx_dboard(chan)[named_prop_t(DBOARD_PROP_SUBDEV, sd_name)];
+    }
+    gain_group::sptr _rx_gain_group(size_t chan){
+        size_t nchan = get_rx_num_channels();
+        std::string sd_name = get_rx_subdev_spec(chan/nchan).at(chan%nchan).sd_name;
+        return _rx_dboard(chan)[named_prop_t(DBOARD_PROP_GAIN_GROUP, sd_name)].as<gain_group::sptr>();
+    }
+    gain_group::sptr _tx_gain_group(size_t chan){
+        size_t nchan = get_tx_num_channels();
+        std::string sd_name = get_tx_subdev_spec(chan/nchan).at(chan%nchan).sd_name;
+        return _tx_dboard(chan)[named_prop_t(DBOARD_PROP_GAIN_GROUP, sd_name)].as<gain_group::sptr>();
+    }
+};
+
+/***********************************************************************
+ * The Make Function
+ **********************************************************************/
+multi_usrp::sptr multi_usrp::make(const device_addr_t &dev_addr){
+    return sptr(new multi_usrp_impl(dev_addr));
+}
diff --git a/host/lib/usrp/single_usrp.cpp b/host/lib/usrp/single_usrp.cpp
index 7d053535e..fba04cd60 100644
--- a/host/lib/usrp/single_usrp.cpp
+++ b/host/lib/usrp/single_usrp.cpp
@@ -46,10 +46,6 @@ public:
         _dev = device::make(addr);
     }
 
-    ~single_usrp_impl(void){
-        /* NOP */
-    }
-
     device::sptr get_device(void){
         return _dev;
     }