aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-10-21 15:29:03 -0700
committerJosh Blum <josh@joshknows.com>2010-10-21 15:29:03 -0700
commit1e57eec9999e1a9d0a735c04173c78164ce8afcd (patch)
treee34b3e52fe4c7a34a6588e15efbb8416b29d81b5 /host/include
parent5bf9e60baf7b85db3da0d41b97d9fe4e9b3e64bd (diff)
parente2f76bddae7845024056b479658651c6da2b0f4d (diff)
downloaduhd-1e57eec9999e1a9d0a735c04173c78164ce8afcd.tar.gz
uhd-1e57eec9999e1a9d0a735c04173c78164ce8afcd.tar.bz2
uhd-1e57eec9999e1a9d0a735c04173c78164ce8afcd.zip
Merge branch 'master' into flow_ctrl
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/config.hpp5
-rw-r--r--host/include/uhd/types/time_spec.hpp4
-rw-r--r--host/include/uhd/usrp/CMakeLists.txt1
-rw-r--r--host/include/uhd/usrp/dboard_id.hpp6
-rw-r--r--host/include/uhd/usrp/mimo_usrp.hpp347
-rw-r--r--host/include/uhd/usrp/misc_utils.hpp3
-rw-r--r--host/include/uhd/usrp/multi_usrp.hpp535
-rw-r--r--host/include/uhd/usrp/simple_usrp.hpp214
-rw-r--r--host/include/uhd/usrp/single_usrp.hpp298
-rw-r--r--host/include/uhd/utils/gain_group.hpp43
10 files changed, 1427 insertions, 29 deletions
diff --git a/host/include/uhd/config.hpp b/host/include/uhd/config.hpp
index dacd3a96b..2918c2340 100644
--- a/host/include/uhd/config.hpp
+++ b/host/include/uhd/config.hpp
@@ -31,11 +31,12 @@
# pragma warning(disable: 4251) // class 'A<T>' needs to have dll-interface to be used by clients of class 'B'
//# pragma warning(disable: 4127) // conditional expression is constant
//# pragma warning(disable: 4290) // C++ exception specification ignored except to ...
-# pragma warning(disable: 4180) // qualifier applied to function type has no meaning; ignored
+//# pragma warning(disable: 4180) // qualifier applied to function type has no meaning; ignored
# pragma warning(disable: 4275) // non dll-interface class ... used as base for dll-interface class ...
//# pragma warning(disable: 4267) // 'var' : conversion from 'size_t' to 'type', possible loss of data
//# pragma warning(disable: 4511) // 'class' : copy constructor could not be generated
-# pragma warning(disable: 4250) // 'class' : inherits 'method' via dominance
+//# pragma warning(disable: 4250) // 'class' : inherits 'method' via dominance
+# pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
#endif
// define logical operators
diff --git a/host/include/uhd/types/time_spec.hpp b/host/include/uhd/types/time_spec.hpp
index 59b85f4b7..57d002d48 100644
--- a/host/include/uhd/types/time_spec.hpp
+++ b/host/include/uhd/types/time_spec.hpp
@@ -59,7 +59,7 @@ namespace uhd{
* \param tick_count the fractional seconds tick count
* \param tick_rate the number of ticks per second
*/
- time_spec_t(time_t full_secs, size_t tick_count, double tick_rate);
+ time_spec_t(time_t full_secs, long tick_count, double tick_rate);
/*!
* Convert the fractional seconds to clock ticks.
@@ -67,7 +67,7 @@ namespace uhd{
* \param tick_rate the number of ticks per second
* \return the fractional seconds tick count
*/
- size_t get_tick_count(double tick_rate) const;
+ long get_tick_count(double tick_rate) const;
/*!
* Get the time as a real-valued seconds count.
diff --git a/host/include/uhd/usrp/CMakeLists.txt b/host/include/uhd/usrp/CMakeLists.txt
index f973e401a..abddf3951 100644
--- a/host/include/uhd/usrp/CMakeLists.txt
+++ b/host/include/uhd/usrp/CMakeLists.txt
@@ -42,6 +42,7 @@ INSTALL(FILES
simple_usrp.hpp
single_usrp.hpp
mimo_usrp.hpp
+ multi_usrp.hpp
DESTINATION ${INCLUDE_DIR}/uhd/usrp
)
diff --git a/host/include/uhd/usrp/dboard_id.hpp b/host/include/uhd/usrp/dboard_id.hpp
index 4c45e4334..1fda8182e 100644
--- a/host/include/uhd/usrp/dboard_id.hpp
+++ b/host/include/uhd/usrp/dboard_id.hpp
@@ -67,6 +67,12 @@ namespace uhd{ namespace usrp{
std::string to_string(void) const;
/*!
+ * Get the dboard id represented as a canonical name.
+ * \return the canonical string representation
+ */
+ std::string to_cname(void) const;
+
+ /*!
* Get the pretty print representation of this dboard id.
* \return a string with the dboard name and id number
*/
diff --git a/host/include/uhd/usrp/mimo_usrp.hpp b/host/include/uhd/usrp/mimo_usrp.hpp
index bdd84a148..78833e24e 100644
--- a/host/include/uhd/usrp/mimo_usrp.hpp
+++ b/host/include/uhd/usrp/mimo_usrp.hpp
@@ -32,12 +32,12 @@
namespace uhd{ namespace usrp{
/*!
- * The MIMO USRP device class:
+ * The MIMO USRP device class (DEPRECATED):
* A mimo usrp facilitates ease-of-use for multi-usrp scenarios.
* The wrapper provides convenience functions to control the group
* of underlying devices as if they consisted of a single device.
*/
-class UHD_API mimo_usrp : boost::noncopyable{
+class UHD_API UHD_DEPRECATED mimo_usrp : boost::noncopyable{
public:
typedef boost::shared_ptr<mimo_usrp> sptr;
@@ -179,4 +179,347 @@ public:
}}
+#include <uhd/utils/warning.hpp>
+#include <uhd/usrp/tune_helper.hpp>
+#include <uhd/utils/assert.hpp>
+#include <uhd/utils/gain_group.hpp>
+#include <uhd/utils/algorithm.hpp>
+#include <uhd/utils/warning.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/foreach.hpp>
+#include <boost/format.hpp>
+#include <boost/thread.hpp>
+#include <stdexcept>
+#include <iostream>
+
+namespace uhd{ namespace usrp{ namespace /*anon*/{
+
+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);
+}
+
+/***********************************************************************
+ * MIMO USRP Implementation
+ **********************************************************************/
+class mimo_usrp_impl : public mimo_usrp{
+public:
+ mimo_usrp_impl(const device_addr_t &addr){
+ _dev = device::make(addr);
+
+ //set the clock config across all mboards (TODO set through api)
+ clock_config_t clock_config;
+ clock_config.ref_source = clock_config_t::REF_SMA;
+ clock_config.pps_source = clock_config_t::PPS_SMA;
+ for (size_t chan = 0; chan < get_num_channels(); chan++){
+ _mboard(chan)[MBOARD_PROP_CLOCK_CONFIG] = clock_config;
+ }
+ }
+
+ ~mimo_usrp_impl(void){
+ /* NOP */
+ }
+
+ device::sptr get_device(void){
+ return _dev;
+ }
+
+ std::string get_pp_string(void){
+ std::string buff = str(boost::format(
+ "MIMO USRP:\n"
+ " Device: %s\n"
+ )
+ % (*_dev)[DEVICE_PROP_NAME].as<std::string>()
+ );
+ for (size_t chan = 0; chan < get_num_channels(); chan++){
+ buff += str(boost::format(
+ " Channel: %u\n"
+ " Mboard: %s\n"
+ " RX DSP: %s\n"
+ " RX Dboard: %s\n"
+ " RX Subdev: %s\n"
+ " TX DSP: %s\n"
+ " TX Dboard: %s\n"
+ " TX Subdev: %s\n"
+ ) % chan
+ % _mboard(chan)[MBOARD_PROP_NAME].as<std::string>()
+ % _rx_dsp(chan)[DSP_PROP_NAME].as<std::string>()
+ % _rx_dboard(chan)[DBOARD_PROP_NAME].as<std::string>()
+ % _rx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>()
+ % _tx_dsp(chan)[DSP_PROP_NAME].as<std::string>()
+ % _tx_dboard(chan)[DBOARD_PROP_NAME].as<std::string>()
+ % _tx_subdev(chan)[SUBDEV_PROP_NAME].as<std::string>()
+ );
+ }
+ return buff;
+ }
+
+ size_t get_num_channels(void){
+ return (*_dev)[DEVICE_PROP_MBOARD_NAMES].as<prop_names_t>().size();
+ }
+
+ /*******************************************************************
+ * Misc
+ ******************************************************************/
+ time_spec_t get_time_now(void){
+ //the time on the first mboard better be the same on all
+ 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 chan = 0; chan < get_num_channels(); chan++){
+ _mboard(chan)[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 chan = 1; chan < get_num_channels(); chan++){
+ time_spec_t time_0 = _mboard(0)[MBOARD_PROP_TIME_NOW].as<time_spec_t>();
+ time_spec_t time_i = _mboard(chan)[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"
+ ) % chan % time_0.get_real_secs() % chan % time_i.get_real_secs()));
+ }
+ }
+ }
+
+ void issue_stream_cmd(const stream_cmd_t &stream_cmd){
+ for (size_t chan = 0; chan < get_num_channels(); chan++){
+ _mboard(chan)[MBOARD_PROP_STREAM_CMD] = stream_cmd;
+ }
+ }
+
+ /*******************************************************************
+ * RX methods
+ ******************************************************************/
+ void set_rx_subdev_spec(size_t chan, const subdev_spec_t &spec){
+ UHD_ASSERT_THROW(spec.size() <= 1);
+ _mboard(chan)[MBOARD_PROP_RX_SUBDEV_SPEC] = spec;
+ }
+
+ subdev_spec_t get_rx_subdev_spec(size_t chan){
+ return _mboard(chan)[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>();
+ }
+
+ void set_rx_rate_all(double rate){
+ std::vector<double> _actual_rates;
+ for (size_t chan = 0; chan < get_num_channels(); chan++){
+ _rx_dsp(chan)[DSP_PROP_HOST_RATE] = rate;
+ _actual_rates.push_back(_rx_dsp(chan)[DSP_PROP_HOST_RATE].as<double>());
+ }
+ _rx_rate = _actual_rates.front();
+ if (std::count(_actual_rates, _rx_rate) != _actual_rates.size()) throw std::runtime_error(
+ "MIMO configuratio error: rx rate inconsistent across mboards"
+ );
+ }
+
+ double get_rx_rate_all(void){
+ return _rx_rate;
+ }
+
+ tune_result_t set_rx_freq(size_t chan, double target_freq){
+ return tune_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(chan), 0, target_freq);
+ }
+
+ tune_result_t set_rx_freq(size_t chan, double target_freq, double lo_off){
+ return tune_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(chan), 0, target_freq, lo_off);
+ }
+
+ double get_rx_freq(size_t chan){
+ return derive_freq_from_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(chan), 0);
+ }
+
+ freq_range_t get_rx_freq_range(size_t chan){
+ return add_dsp_shift(_rx_subdev(chan)[SUBDEV_PROP_FREQ_RANGE].as<freq_range_t>(), _rx_dsp(chan));
+ }
+
+ void set_rx_gain(size_t chan, float gain){
+ 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(size_t chan, const std::string &ant){
+ _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>();
+ }
+
+ void set_rx_bandwidth(size_t chan, float bandwidth){
+ _rx_subdev(chan)[SUBDEV_PROP_BANDWIDTH] = bandwidth;
+ }
+
+ /*******************************************************************
+ * TX methods
+ ******************************************************************/
+ void set_tx_subdev_spec(size_t chan, const subdev_spec_t &spec){
+ UHD_ASSERT_THROW(spec.size() <= 1);
+ _mboard(chan)[MBOARD_PROP_TX_SUBDEV_SPEC] = spec;
+ }
+
+ subdev_spec_t get_tx_subdev_spec(size_t chan){
+ return _mboard(chan)[MBOARD_PROP_TX_SUBDEV_SPEC].as<subdev_spec_t>();
+ }
+
+ void set_tx_rate_all(double rate){
+ std::vector<double> _actual_rates;
+ for (size_t chan = 0; chan < get_num_channels(); chan++){
+ _tx_dsp(chan)[DSP_PROP_HOST_RATE] = rate;
+ _actual_rates.push_back(_tx_dsp(chan)[DSP_PROP_HOST_RATE].as<double>());
+ }
+ _tx_rate = _actual_rates.front();
+ if (std::count(_actual_rates, _tx_rate) != _actual_rates.size()) throw std::runtime_error(
+ "MIMO configuratio error: tx rate inconsistent across mboards"
+ );
+ }
+
+ double get_tx_rate_all(void){
+ return _tx_rate;
+ }
+
+ tune_result_t set_tx_freq(size_t chan, double target_freq){
+ return tune_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(chan), 0, target_freq);
+ }
+
+ tune_result_t set_tx_freq(size_t chan, double target_freq, double lo_off){
+ return tune_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(chan), 0, target_freq, lo_off);
+ }
+
+ double get_tx_freq(size_t chan){
+ return derive_freq_from_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(chan), 0);
+ }
+
+ freq_range_t get_tx_freq_range(size_t chan){
+ return add_dsp_shift(_tx_subdev(chan)[SUBDEV_PROP_FREQ_RANGE].as<freq_range_t>(), _tx_dsp(chan));
+ }
+
+ void set_tx_gain(size_t chan, float gain){
+ 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(size_t chan, const std::string &ant){
+ _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>();
+ }
+
+private:
+ device::sptr _dev;
+ wax::obj _mboard(size_t chan){
+ prop_names_t names = (*_dev)[DEVICE_PROP_MBOARD_NAMES].as<prop_names_t>();
+ return (*_dev)[named_prop_t(DEVICE_PROP_MBOARD, names.at(chan))];
+ }
+ wax::obj _rx_dsp(size_t chan){
+ return _mboard(chan)[MBOARD_PROP_RX_DSP];
+ }
+ wax::obj _tx_dsp(size_t chan){
+ return _mboard(chan)[MBOARD_PROP_TX_DSP];
+ }
+ wax::obj _rx_dboard(size_t chan){
+ std::string db_name = _mboard(chan)[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>().front().db_name;
+ return _mboard(chan)[named_prop_t(MBOARD_PROP_RX_DBOARD, db_name)];
+ }
+ wax::obj _tx_dboard(size_t chan){
+ std::string db_name = _mboard(chan)[MBOARD_PROP_TX_SUBDEV_SPEC].as<subdev_spec_t>().front().db_name;
+ return _mboard(chan)[named_prop_t(MBOARD_PROP_TX_DBOARD, db_name)];
+ }
+ wax::obj _rx_subdev(size_t chan){
+ std::string sd_name = _mboard(chan)[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>().front().sd_name;
+ return _rx_dboard(chan)[named_prop_t(DBOARD_PROP_SUBDEV, sd_name)];
+ }
+ wax::obj _tx_subdev(size_t chan){
+ std::string sd_name = _mboard(chan)[MBOARD_PROP_TX_SUBDEV_SPEC].as<subdev_spec_t>().front().sd_name;
+ return _tx_dboard(chan)[named_prop_t(DBOARD_PROP_SUBDEV, sd_name)];
+ }
+ gain_group::sptr _rx_gain_group(size_t chan){
+ std::string sd_name = _mboard(chan)[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>().front().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){
+ std::string sd_name = _mboard(chan)[MBOARD_PROP_TX_SUBDEV_SPEC].as<subdev_spec_t>().front().sd_name;
+ return _tx_dboard(chan)[named_prop_t(DBOARD_PROP_GAIN_GROUP, sd_name)].as<gain_group::sptr>();
+ }
+
+ //shadows
+ double _rx_rate, _tx_rate;
+};
+}}}
+
+namespace uhd{ namespace usrp{
+/***********************************************************************
+ * The Make Function
+ **********************************************************************/
+inline 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));
+}
+}}
+
#endif /* INCLUDED_UHD_USRP_MIMO_USRP_HPP */
diff --git a/host/include/uhd/usrp/misc_utils.hpp b/host/include/uhd/usrp/misc_utils.hpp
index 2af9f5b40..37860a1a5 100644
--- a/host/include/uhd/usrp/misc_utils.hpp
+++ b/host/include/uhd/usrp/misc_utils.hpp
@@ -20,6 +20,7 @@
#include <uhd/config.hpp>
#include <uhd/wax.hpp>
+#include <uhd/usrp/dboard_id.hpp>
#include <uhd/usrp/subdev_spec.hpp>
#include <uhd/utils/gain_group.hpp>
@@ -35,11 +36,13 @@ namespace uhd{ namespace usrp{
/*!
* Create a gain group that represents the subdevice and its codec.
+ * \param dboard_id the dboard id for this subdevice
* \param subdev the object with subdevice properties
* \param codec the object with codec properties
* \param gain_group_policy the policy to use
*/
UHD_API gain_group::sptr make_gain_group(
+ const dboard_id_t &dboard_id,
wax::obj subdev, wax::obj codec,
gain_group_policy_t gain_group_policy
);
diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp
new file mode 100644
index 000000000..2f71f80b1
--- /dev/null
+++ b/host/include/uhd/usrp/multi_usrp.hpp
@@ -0,0 +1,535 @@
+//
+// 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_UHD_USRP_MULTI_USRP_HPP
+#define INCLUDED_UHD_USRP_MULTI_USRP_HPP
+
+#include <uhd/config.hpp>
+#include <uhd/device.hpp>
+#include <uhd/types/ranges.hpp>
+#include <uhd/types/stream_cmd.hpp>
+#include <uhd/types/clock_config.hpp>
+#include <uhd/types/tune_result.hpp>
+#include <uhd/usrp/subdev_spec.hpp>
+#include <uhd/usrp/dboard_iface.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/utility.hpp>
+#include <vector>
+
+namespace uhd{ namespace usrp{
+
+/*!
+ * The multi-USRP device class:
+ * A multi-USRP facilitates ease-of-use for multiple USRP scenarios.
+ * The wrapper provides convenience functions to control the group
+ * of underlying devices as if they consisted of a single device.
+ *
+ * A few notes about a multi-USRP configuration:
+ * - All boards share a common RX sample rate
+ * - All boards share a common TX sample rate
+ * - All boards share a common RX subdevice specification size
+ * - All boards share a common TX subdevice specification size
+ * - All boards must have synchronized times (see the set_time_*() calls)
+ *
+ * Example to setup channel mapping:
+ * <pre>
+ *
+ * //create a multi_usrp with two boards in the configuration
+ * device_addr_t dev_addr;
+ * dev_addr["addr"] = "192.168.10.2 192.168.10.3";
+ * multi_usrp::sptr dev = multi_usrp::make(dev_addr);
+ *
+ * //set the board on 10.2 to use the A RX subdevice (RX channel 0)
+ * dev->set_rx_subdev_spec(":A", 0);
+ *
+ * //set the board on 10.3 to use the B RX subdevice (RX channel 1)
+ * dev->set_rx_subdev_spec(":B", 1);
+ *
+ * //set both boards to use the AB TX subdevice (TX channels 0 and 1)
+ * dev->set_tx_subdev_spec(":AB", multi_usrp::ALL_MBOARDS);
+ *
+ * //now that all the channels are mapped, continue with configuration...
+ *
+ * </pre>
+ */
+class UHD_API multi_usrp : boost::noncopyable{
+public:
+ typedef boost::shared_ptr<multi_usrp> sptr;
+
+ //! A wildcard motherboard index
+ static const size_t ALL_MBOARDS = size_t(~0);
+
+ //! A wildcard gain element name
+ static const std::string ALL_GAINS;
+
+ /*!
+ * Make a new multi usrp from the device address.
+ * \param dev_addr the device address
+ * \return a new single usrp object
+ */
+ static sptr make(const device_addr_t &dev_addr);
+
+ /*!
+ * Get the underlying device object.
+ * This is needed to get access to the streaming API and properties.
+ * \return the device object within this single usrp
+ */
+ virtual device::sptr get_device(void) = 0;
+
+ /*******************************************************************
+ * Mboard methods
+ ******************************************************************/
+ /*!
+ * Get a printable summary for this USRP configuration.
+ * \return a printable string
+ */
+ virtual std::string get_pp_string(void) = 0;
+
+ /*!
+ * Get canonical name for this USRP motherboard.
+ * \param mboard which motherboard to query
+ * \return a string representing the name
+ */
+ virtual std::string get_mboard_name(size_t mboard) = 0;
+
+ /*!
+ * Gets the current time in the usrp time registers.
+ * \return a timespec representing current usrp time
+ */
+ virtual time_spec_t get_time_now(void) = 0;
+
+ /*!
+ * Set the time registers on the usrp at the next pps tick.
+ * The values will not be latched in until the pulse occurs.
+ * It is recommended that the user sleep(1) after calling to ensure
+ * that the time registers will be in a known state prior to use.
+ *
+ * Note: Because this call sets the time on the "next" pps,
+ * the seconds in the time spec should be current seconds + 1.
+ *
+ * \param time_spec the time to latch into the usrp device
+ */
+ virtual void set_time_next_pps(const time_spec_t &time_spec) = 0;
+
+ /*!
+ * Synchronize the times across all motherboards in this configuration.
+ * Use this method to sync the times when the edge of the PPS is unknown.
+ *
+ * Ex: Host machine is not attached to serial port of GPSDO
+ * and can therefore not query the GPSDO for the PPS edge.
+ *
+ * This is a 3-step process, and will take at most 3 seconds to complete.
+ * Upon completion, the times will be synchronized to the time provided.
+ *
+ * - Step1: set the time at the next pps (potential race condition)
+ * - Step2: wait for the seconds to rollover to catch the pps edge
+ * - Step3: set the time at the next pps (synchronous for all boards)
+ *
+ * \param time_spec the time to latch into the usrp device
+ */
+ virtual void set_time_unknown_pps(const time_spec_t &time_spec) = 0;
+
+ /*!
+ * Issue a stream command to the usrp device.
+ * This tells the usrp to send samples into the host.
+ * See the documentation for stream_cmd_t for more info.
+ * \param stream_cmd the stream command to issue
+ */
+ virtual void issue_stream_cmd(const stream_cmd_t &stream_cmd) = 0;
+
+ /*!
+ * Set the clock configuration for the usrp device.
+ * This tells the usrp how to get a 10Mhz reference and PPS clock.
+ * See the documentation for clock_config_t for more info.
+ * \param clock_config the clock configuration to set
+ * \param mboard which motherboard to set the config
+ */
+ virtual void set_clock_config(const clock_config_t &clock_config, size_t mboard) = 0;
+
+ /*!
+ * Get the number of USRP motherboards in this configuration.
+ */
+ virtual size_t get_num_mboards(void) = 0;
+
+ /*******************************************************************
+ * RX methods
+ ******************************************************************/
+ /*!
+ * Set the RX subdevice specification:
+ * The subdev spec maps a physical part of a daughter-board to a channel number.
+ * Set the subdev spec before calling into any methods with a channel number.
+ * The subdev spec must be the same size across all motherboards.
+ * \param spec the new subdevice specification
+ * \param mboard the motherboard index 0 to M-1
+ */
+ virtual void set_rx_subdev_spec(const uhd::usrp::subdev_spec_t &spec, size_t mboard) = 0;
+
+ /*!
+ * Get the RX subdevice specification.
+ * \param mboard the motherboard index 0 to M-1
+ * \return the subdevice specification in use
+ */
+ virtual uhd::usrp::subdev_spec_t get_rx_subdev_spec(size_t mboard) = 0;
+
+ /*!
+ * Get the number of RX channels in this configuration.
+ * This is the number of USRPs times the number of RX channels per board,
+ * where the number of RX channels per board is homogeneous among all USRPs.
+ */
+ virtual size_t get_rx_num_channels(void) = 0;
+
+ /*!
+ * Get the name of the RX subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the subdevice name
+ */
+ virtual std::string get_rx_subdev_name(size_t chan) = 0;
+
+ /*!
+ * Set the RX sample rate across all channels.
+ * \param rate the rate in Sps
+ */
+ virtual void set_rx_rate(double rate) = 0;
+
+ /*!
+ * Gets the RX sample rate for all channels.
+ * \return the rate in Sps
+ */
+ virtual double get_rx_rate(void) = 0;
+
+ /*!
+ * Set the RX center frequency.
+ * \param freq the frequency in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
+ virtual tune_result_t set_rx_freq(double freq, size_t chan) = 0;
+
+ /*!
+ * Set the RX center frequency.
+ * \param freq the frequency in Hz
+ * \param lo_off an LO offset in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
+ virtual tune_result_t set_rx_freq(double freq, double lo_off, size_t chan) = 0;
+
+ /*!
+ * Get the RX center frequency.
+ * \param chan the channel index 0 to N-1
+ * \return the frequency in Hz
+ */
+ virtual double get_rx_freq(size_t chan) = 0;
+
+ /*!
+ * Get the RX center frequency range.
+ * \param chan the channel index 0 to N-1
+ * \return a frequency range object
+ */
+ virtual freq_range_t get_rx_freq_range(size_t chan) = 0;
+
+ /*!
+ * Set the RX gain value for the specified gain element.
+ * For an empty name, distribute across all gain elements.
+ * \param gain the gain in dB
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_rx_gain(float gain, const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for setting overall RX gain
+ void set_rx_gain(float gain, size_t chan){
+ return this->set_rx_gain(gain, ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the RX gain value for the specified gain element.
+ * For an empty name, sum across all gain elements.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return the gain in dB
+ */
+ virtual float get_rx_gain(const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for getting overall RX gain
+ float get_rx_gain(size_t chan){
+ return this->get_rx_gain(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the RX gain range for the specified gain element.
+ * For an empty name, calculate the overall gain range.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return a gain range object
+ */
+ virtual gain_range_t get_rx_gain_range(const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for getting overall RX gain range
+ gain_range_t get_rx_gain_range(size_t chan){
+ return this->get_rx_gain_range(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the names of the gain elements in the RX chain.
+ * Gain elements are ordered from antenna to FPGA.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of gain element names
+ */
+ virtual std::vector<std::string> get_rx_gain_names(size_t chan) = 0;
+
+ /*!
+ * Select the RX antenna on the subdevice.
+ * \param ant the antenna name
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_rx_antenna(const std::string &ant, size_t chan) = 0;
+
+ /*!
+ * Get the selected RX antenna on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the antenna name
+ */
+ virtual std::string get_rx_antenna(size_t chan) = 0;
+
+ /*!
+ * Get a list of possible RX antennas on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of antenna names
+ */
+ virtual std::vector<std::string> get_rx_antennas(size_t chan) = 0;
+
+ /*!
+ * Get the locked status of the LO on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return true for locked
+ */
+ virtual bool get_rx_lo_locked(size_t chan) = 0;
+
+ /*!
+ * Set the RX bandwidth on the subdevice.
+ * \param bandwidth the bandwidth in Hz
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_rx_bandwidth(double bandwidth, size_t chan) = 0;
+
+ /*!
+ * Get the RX bandwidth on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the bandwidth in Hz
+ */
+ virtual double get_rx_bandwidth(size_t chan) = 0;
+
+ /*!
+ * Read the RSSI value on the RX subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the rssi in dB
+ * \throw exception if RSSI readback not supported
+ */
+ virtual float read_rssi(size_t chan) = 0;
+
+ /*!
+ * Get the dboard interface object for the RX subdevice.
+ * The dboard interface gives access to GPIOs, SPI, I2C, low-speed ADC and DAC.
+ * Use at your own risk!
+ * \param chan the channel index 0 to N-1
+ * \return the dboard interface sptr
+ */
+ virtual dboard_iface::sptr get_rx_dboard_iface(size_t chan) = 0;
+
+ /*******************************************************************
+ * TX methods
+ ******************************************************************/
+ /*!
+ * Set the TX subdevice specification:
+ * The subdev spec maps a physical part of a daughter-board to a channel number.
+ * Set the subdev spec before calling into any methods with a channel number.
+ * The subdev spec must be the same size across all motherboards.
+ * \param spec the new subdevice specification
+ * \param mboard the motherboard index 0 to M-1
+ */
+ virtual void set_tx_subdev_spec(const uhd::usrp::subdev_spec_t &spec, size_t mboard) = 0;
+
+ /*!
+ * Get the TX subdevice specification.
+ * \param mboard the motherboard index 0 to M-1
+ * \return the subdevice specification in use
+ */
+ virtual uhd::usrp::subdev_spec_t get_tx_subdev_spec(size_t mboard) = 0;
+
+ /*!
+ * Get the number of TX channels in this configuration.
+ * This is the number of USRPs times the number of TX channels per board,
+ * where the number of TX channels per board is homogeneous among all USRPs.
+ */
+ virtual size_t get_tx_num_channels(void) = 0;
+
+ /*!
+ * Get the name of the TX subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the subdevice name
+ */
+ virtual std::string get_tx_subdev_name(size_t chan) = 0;
+
+ /*!
+ * Set the TX sample rate across all channels.
+ * \param rate the rate in Sps
+ */
+ virtual void set_tx_rate(double rate) = 0;
+
+ /*!
+ * Gets the TX sample rate for all channels.
+ * \return the rate in Sps
+ */
+ virtual double get_tx_rate(void) = 0;
+
+ /*!
+ * Set the TX center frequency.
+ * \param freq the frequency in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
+ virtual tune_result_t set_tx_freq(double freq, size_t chan) = 0;
+
+ /*!
+ * Set the TX center frequency.
+ * \param freq the frequency in Hz
+ * \param lo_off an LO offset in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
+ virtual tune_result_t set_tx_freq(double freq, double lo_off, size_t chan) = 0;
+
+ /*!
+ * Get the TX center frequency.
+ * \param chan the channel index 0 to N-1
+ * \return the frequency in Hz
+ */
+ virtual double get_tx_freq(size_t chan) = 0;
+
+ /*!
+ * Get the TX center frequency range.
+ * \param chan the channel index 0 to N-1
+ * \return a frequency range object
+ */
+ virtual freq_range_t get_tx_freq_range(size_t chan) = 0;
+
+ /*!
+ * Set the TX gain value for the specified gain element.
+ * For an empty name, distribute across all gain elements.
+ * \param gain the gain in dB
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_tx_gain(float gain, const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for setting overall TX gain
+ void set_tx_gain(float gain, size_t chan){
+ return this->set_tx_gain(gain, ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the TX gain value for the specified gain element.
+ * For an empty name, sum across all gain elements.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return the gain in dB
+ */
+ virtual float get_tx_gain(const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for getting overall TX gain
+ float get_tx_gain(size_t chan){
+ return this->get_tx_gain(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the TX gain range for the specified gain element.
+ * For an empty name, calculate the overall gain range.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return a gain range object
+ */
+ virtual gain_range_t get_tx_gain_range(const std::string &name, size_t chan) = 0;
+
+ //! A convenience wrapper for getting overall TX gain range
+ gain_range_t get_tx_gain_range(size_t chan){
+ return this->get_tx_gain_range(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the names of the gain elements in the TX chain.
+ * Gain elements are ordered from antenna to FPGA.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of gain element names
+ */
+ virtual std::vector<std::string> get_tx_gain_names(size_t chan) = 0;
+
+ /*!
+ * Select the TX antenna on the subdevice.
+ * \param ant the antenna name
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_tx_antenna(const std::string &ant, size_t chan) = 0;
+
+ /*!
+ * Get the selected TX antenna on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the antenna name
+ */
+ virtual std::string get_tx_antenna(size_t chan) = 0;
+
+ /*!
+ * Get a list of possible TX antennas on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of antenna names
+ */
+ virtual std::vector<std::string> get_tx_antennas(size_t chan) = 0;
+
+ /*!
+ * Get the locked status of the LO on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return true for locked
+ */
+ virtual bool get_tx_lo_locked(size_t chan) = 0;
+
+ /*!
+ * Set the TX bandwidth on the subdevice.
+ * \param bandwidth the bandwidth in Hz
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_tx_bandwidth(double bandwidth, size_t chan) = 0;
+
+ /*!
+ * Get the TX bandwidth on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the bandwidth in Hz
+ */
+ virtual double get_tx_bandwidth(size_t chan) = 0;
+
+ /*!
+ * Get the dboard interface object for the TX subdevice.
+ * The dboard interface gives access to GPIOs, SPI, I2C, low-speed ADC and DAC.
+ * Use at your own risk!
+ * \param chan the channel index 0 to N-1
+ * \return the dboard interface sptr
+ */
+ virtual dboard_iface::sptr get_tx_dboard_iface(size_t chan) = 0;
+};
+
+}}
+
+#endif /* INCLUDED_UHD_USRP_MULTI_USRP_HPP */
diff --git a/host/include/uhd/usrp/simple_usrp.hpp b/host/include/uhd/usrp/simple_usrp.hpp
index 6f3597ed7..22f4d64ba 100644
--- a/host/include/uhd/usrp/simple_usrp.hpp
+++ b/host/include/uhd/usrp/simple_usrp.hpp
@@ -171,4 +171,218 @@ public:
}}
+#include <uhd/usrp/single_usrp.hpp>
+#include <uhd/utils/warning.hpp>
+
+namespace uhd{ namespace usrp{ namespace /*anon*/{
+
+/***********************************************************************
+ * Simple USRP Implementation
+ **********************************************************************/
+class simple_usrp_impl : public simple_usrp{
+public:
+ simple_usrp_impl(const device_addr_t &addr){
+ _sdev = single_usrp::make(addr);
+ }
+
+ ~simple_usrp_impl(void){
+ /* NOP */
+ }
+
+ device::sptr get_device(void){
+ return _sdev->get_device();
+ }
+
+ std::string get_pp_string(void){
+ return _sdev->get_pp_string();
+ }
+
+ /*******************************************************************
+ * Misc
+ ******************************************************************/
+ time_spec_t get_time_now(void){
+ return _sdev->get_time_now();
+ }
+
+ void set_time_now(const time_spec_t &time_spec){
+ return _sdev->set_time_now(time_spec);
+ }
+
+ void set_time_next_pps(const time_spec_t &time_spec){
+ return _sdev->set_time_next_pps(time_spec);
+ }
+
+ void issue_stream_cmd(const stream_cmd_t &stream_cmd){
+ return _sdev->issue_stream_cmd(stream_cmd);
+ }
+
+ void set_clock_config(const clock_config_t &clock_config){
+ return _sdev->set_clock_config(clock_config);
+ }
+
+ /*******************************************************************
+ * RX methods
+ ******************************************************************/
+ void set_rx_subdev_spec(const subdev_spec_t &spec){
+ return _sdev->set_rx_subdev_spec(spec);
+ }
+
+ subdev_spec_t get_rx_subdev_spec(void){
+ return _sdev->get_rx_subdev_spec();
+ }
+
+ void set_rx_rate(double rate){
+ return _sdev->set_rx_rate(rate);
+ }
+
+ double get_rx_rate(void){
+ return _sdev->get_rx_rate();
+ }
+
+ tune_result_t set_rx_freq(double target_freq){
+ return _sdev->set_rx_freq(target_freq);
+ }
+
+ tune_result_t set_rx_freq(double target_freq, double lo_off){
+ return _sdev->set_rx_freq(target_freq, lo_off);
+ }
+
+ double get_rx_freq(void){
+ return _sdev->get_rx_freq();
+ }
+
+ freq_range_t get_rx_freq_range(void){
+ return _sdev->get_rx_freq_range();
+ }
+
+ void set_rx_gain(float gain){
+ return _sdev->set_rx_gain(gain);
+ }
+
+ float get_rx_gain(void){
+ return _sdev->get_rx_gain();
+ }
+
+ gain_range_t get_rx_gain_range(void){
+ return _sdev->get_rx_gain_range();
+ }
+
+ void set_rx_antenna(const std::string &ant){
+ return _sdev->set_rx_antenna(ant);
+ }
+
+ std::string get_rx_antenna(void){
+ return _sdev->get_rx_antenna();
+ }
+
+ std::vector<std::string> get_rx_antennas(void){
+ return _sdev->get_rx_antennas();
+ }
+
+ bool get_rx_lo_locked(void){
+ return _sdev->get_rx_lo_locked();
+ }
+
+ float read_rssi(void){
+ return _sdev->read_rssi();
+ }
+
+ dboard_iface::sptr get_rx_dboard_iface(void){
+ return _sdev->get_rx_dboard_iface();
+ }
+
+ void set_rx_bandwidth(float bandwidth) {
+ return _sdev->set_rx_bandwidth(bandwidth);
+ }
+
+ /*******************************************************************
+ * TX methods
+ ******************************************************************/
+ void set_tx_subdev_spec(const subdev_spec_t &spec){
+ return _sdev->set_tx_subdev_spec(spec);
+ }
+
+ subdev_spec_t get_tx_subdev_spec(void){
+ return _sdev->get_tx_subdev_spec();
+ }
+
+ void set_tx_rate(double rate){
+ return _sdev->set_tx_rate(rate);
+ }
+
+ double get_tx_rate(void){
+ return _sdev->get_tx_rate();
+ }
+
+ tune_result_t set_tx_freq(double target_freq){
+ return _sdev->set_tx_freq(target_freq);
+ }
+
+ tune_result_t set_tx_freq(double target_freq, double lo_off){
+ return _sdev->set_tx_freq(target_freq, lo_off);
+ }
+
+ double get_tx_freq(void){
+ return _sdev->get_tx_freq();
+ }
+
+ freq_range_t get_tx_freq_range(void){
+ return _sdev->get_tx_freq_range();
+ }
+
+ void set_tx_gain(float gain){
+ return _sdev->set_tx_gain(gain);
+ }
+
+ float get_tx_gain(void){
+ return _sdev->get_tx_gain();
+ }
+
+ gain_range_t get_tx_gain_range(void){
+ return _sdev->get_tx_gain_range();
+ }
+
+ void set_tx_antenna(const std::string &ant){
+ return _sdev->set_tx_antenna(ant);
+ }
+
+ std::string get_tx_antenna(void){
+ return _sdev->get_tx_antenna();
+ }
+
+ std::vector<std::string> get_tx_antennas(void){
+ return _sdev->get_tx_antennas();
+ }
+
+ bool get_tx_lo_locked(void){
+ return _sdev->get_tx_lo_locked();
+ }
+
+ dboard_iface::sptr get_tx_dboard_iface(void){
+ return _sdev->get_tx_dboard_iface();
+ }
+
+private:
+ single_usrp::sptr _sdev;
+};
+
+}}}
+
+namespace uhd{ namespace usrp{
+
+/***********************************************************************
+ * The Make Function
+ **********************************************************************/
+inline simple_usrp::sptr simple_usrp::make(const device_addr_t &dev_addr){
+ uhd::print_warning(
+ "The simple USRP interface has been deprecated.\n"
+ "Please switch to the single USRP interface.\n"
+ "#include <uhd/usrp/single_usrp.hpp>\n"
+ "single_usrp::sptr sdev = single_usrp::make(args);\n"
+ );
+ return sptr(new simple_usrp_impl(dev_addr));
+}
+
+}}
+
#endif /* INCLUDED_UHD_USRP_SIMPLE_USRP_HPP */
diff --git a/host/include/uhd/usrp/single_usrp.hpp b/host/include/uhd/usrp/single_usrp.hpp
index fa6498d13..a068fbed8 100644
--- a/host/include/uhd/usrp/single_usrp.hpp
+++ b/host/include/uhd/usrp/single_usrp.hpp
@@ -33,8 +33,8 @@
namespace uhd{ namespace usrp{
/*!
- * The single USRP device class:
- * A single usrp facilitates ease-of-use for most use-case scenarios.
+ * The single-USRP device class:
+ * A single-USRP facilitates ease-of-use for most use-case scenarios.
* The wrapper provides convenience functions to tune the devices
* as well as to set the dboard gains, antennas, and other properties.
* This wrapper supports multi-channel configurations per motherboard.
@@ -43,6 +43,9 @@ class UHD_API single_usrp : boost::noncopyable{
public:
typedef boost::shared_ptr<single_usrp> sptr;
+ //! A wildcard gain element name
+ static const std::string ALL_GAINS;
+
/*!
* Make a new single usrp from the device address.
* \param dev_addr the device address
@@ -61,7 +64,7 @@ public:
* Mboard methods
******************************************************************/
/*!
- * Get a printable name for this usrp.
+ * Get a printable summary for this USRP configuration.
* \return a printable string
*/
virtual std::string get_pp_string(void) = 0;
@@ -120,40 +123,174 @@ public:
* Set the RX subdevice specification:
* The subdev spec maps a physical part of a daughter-board to a channel number.
* Set the subdev spec before calling into any methods with a channel number.
+ * \param spec the new subdevice specification
*/
virtual void set_rx_subdev_spec(const uhd::usrp::subdev_spec_t &spec) = 0;
+
+ /*!
+ * Get the RX subdevice specification.
+ * \return the subdevice specification in use
+ */
virtual uhd::usrp::subdev_spec_t get_rx_subdev_spec(void) = 0;
+ /*!
+ * Get the name of the RX subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the subdevice name
+ */
virtual std::string get_rx_subdev_name(size_t chan = 0) = 0;
+ /*!
+ * Set the RX sample rate across all channels.
+ * \param rate the rate in Sps
+ */
virtual void set_rx_rate(double rate) = 0;
+
+ /*!
+ * Gets the RX sample rate for all channels.
+ * \return the rate in Sps
+ */
virtual double get_rx_rate(void) = 0;
+ /*!
+ * Set the RX center frequency.
+ * \param freq the frequency in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
virtual tune_result_t set_rx_freq(double freq, size_t chan = 0) = 0;
+
+ /*!
+ * Set the RX center frequency.
+ * \param freq the frequency in Hz
+ * \param lo_off an LO offset in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
virtual tune_result_t set_rx_freq(double freq, double lo_off, size_t chan = 0) = 0;
+
+ /*!
+ * Get the RX center frequency.
+ * \param chan the channel index 0 to N-1
+ * \return the frequency in Hz
+ */
virtual double get_rx_freq(size_t chan = 0) = 0;
+
+ /*!
+ * Get the RX center frequency range.
+ * \param chan the channel index 0 to N-1
+ * \return a frequency range object
+ */
virtual freq_range_t get_rx_freq_range(size_t chan = 0) = 0;
- virtual void set_rx_gain(float gain, size_t chan = 0) = 0;
- virtual float get_rx_gain(size_t chan = 0) = 0;
- virtual gain_range_t get_rx_gain_range(size_t chan = 0) = 0;
+ /*!
+ * Set the RX gain value for the specified gain element.
+ * For an empty name, distribute across all gain elements.
+ * \param gain the gain in dB
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_rx_gain(float gain, const std::string &name, size_t chan = 0) = 0;
+
+ //! A convenience wrapper for setting overall RX gain
+ void set_rx_gain(float gain, size_t chan = 0){
+ return this->set_rx_gain(gain, ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the RX gain value for the specified gain element.
+ * For an empty name, sum across all gain elements.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return the gain in dB
+ */
+ virtual float get_rx_gain(const std::string &name, size_t chan = 0) = 0;
+
+ //! A convenience wrapper for getting overall RX gain
+ float get_rx_gain(size_t chan = 0){
+ return this->get_rx_gain(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the RX gain range for the specified gain element.
+ * For an empty name, calculate the overall gain range.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return a gain range object
+ */
+ virtual gain_range_t get_rx_gain_range(const std::string &name, size_t chan = 0) = 0;
+
+ //! A convenience wrapper for getting overall RX gain range
+ gain_range_t get_rx_gain_range(size_t chan = 0){
+ return this->get_rx_gain_range(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the names of the gain elements in the RX chain.
+ * Gain elements are ordered from antenna to FPGA.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of gain element names
+ */
+ virtual std::vector<std::string> get_rx_gain_names(size_t chan = 0) = 0;
+ /*!
+ * Select the RX antenna on the subdevice.
+ * \param ant the antenna name
+ * \param chan the channel index 0 to N-1
+ */
virtual void set_rx_antenna(const std::string &ant, size_t chan = 0) = 0;
+
+ /*!
+ * Get the selected RX antenna on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the antenna name
+ */
virtual std::string get_rx_antenna(size_t chan = 0) = 0;
+
+ /*!
+ * Get a list of possible RX antennas on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of antenna names
+ */
virtual std::vector<std::string> get_rx_antennas(size_t chan = 0) = 0;
+ /*!
+ * Get the locked status of the LO on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return true for locked
+ */
virtual bool get_rx_lo_locked(size_t chan = 0) = 0;
/*!
- * Read the RSSI value from a usrp device.
- * Or throw if the dboard does not support an RSSI readback.
+ * Set the RX bandwidth on the subdevice.
+ * \param bandwidth the bandwidth in Hz
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_rx_bandwidth(double bandwidth, size_t chan = 0) = 0;
+
+ /*!
+ * Get the RX bandwidth on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the bandwidth in Hz
+ */
+ virtual double get_rx_bandwidth(size_t chan = 0) = 0;
+
+ /*!
+ * Read the RSSI value on the RX subdevice.
+ * \param chan the channel index 0 to N-1
* \return the rssi in dB
+ * \throw exception if RSSI readback not supported
*/
virtual float read_rssi(size_t chan = 0) = 0;
+ /*!
+ * Get the dboard interface object for the RX subdevice.
+ * The dboard interface gives access to GPIOs, SPI, I2C, low-speed ADC and DAC.
+ * Use at your own risk!
+ * \param chan the channel index 0 to N-1
+ * \return the dboard interface sptr
+ */
virtual dboard_iface::sptr get_rx_dboard_iface(size_t chan = 0) = 0;
-
- virtual void set_rx_bandwidth(float bandwidth, size_t chan = 0) = 0;
/*******************************************************************
* TX methods
@@ -162,30 +299,165 @@ public:
* Set the TX subdevice specification:
* The subdev spec maps a physical part of a daughter-board to a channel number.
* Set the subdev spec before calling into any methods with a channel number.
+ * \param spec the new subdevice specification
*/
virtual void set_tx_subdev_spec(const uhd::usrp::subdev_spec_t &spec) = 0;
+
+ /*!
+ * Get the TX subdevice specification.
+ * \return the subdevice specification in use
+ */
virtual uhd::usrp::subdev_spec_t get_tx_subdev_spec(void) = 0;
+ /*!
+ * Get the name of the TX subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the subdevice name
+ */
virtual std::string get_tx_subdev_name(size_t chan = 0) = 0;
+ /*!
+ * Set the TX sample rate across all channels.
+ * \param rate the rate in Sps
+ */
virtual void set_tx_rate(double rate) = 0;
+
+ /*!
+ * Gets the TX sample rate for all channels.
+ * \return the rate in Sps
+ */
virtual double get_tx_rate(void) = 0;
+ /*!
+ * Set the TX center frequency.
+ * \param freq the frequency in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
virtual tune_result_t set_tx_freq(double freq, size_t chan = 0) = 0;
+
+ /*!
+ * Set the TX center frequency.
+ * \param freq the frequency in Hz
+ * \param lo_off an LO offset in Hz
+ * \param chan the channel index 0 to N-1
+ * \return a tune result object
+ */
virtual tune_result_t set_tx_freq(double freq, double lo_off, size_t chan = 0) = 0;
+
+ /*!
+ * Get the TX center frequency.
+ * \param chan the channel index 0 to N-1
+ * \return the frequency in Hz
+ */
virtual double get_tx_freq(size_t chan = 0) = 0;
+
+ /*!
+ * Get the TX center frequency range.
+ * \param chan the channel index 0 to N-1
+ * \return a frequency range object
+ */
virtual freq_range_t get_tx_freq_range(size_t chan = 0) = 0;
- virtual void set_tx_gain(float gain, size_t chan = 0) = 0;
- virtual float get_tx_gain(size_t chan = 0) = 0;
- virtual gain_range_t get_tx_gain_range(size_t chan = 0) = 0;
+ /*!
+ * Set the TX gain value for the specified gain element.
+ * For an empty name, distribute across all gain elements.
+ * \param gain the gain in dB
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_tx_gain(float gain, const std::string &name, size_t chan = 0) = 0;
+
+ //! A convenience wrapper for setting overall TX gain
+ void set_tx_gain(float gain, size_t chan = 0){
+ return this->set_tx_gain(gain, ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the TX gain value for the specified gain element.
+ * For an empty name, sum across all gain elements.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return the gain in dB
+ */
+ virtual float get_tx_gain(const std::string &name, size_t chan = 0) = 0;
+ //! A convenience wrapper for getting overall TX gain
+ float get_tx_gain(size_t chan = 0){
+ return this->get_tx_gain(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the TX gain range for the specified gain element.
+ * For an empty name, calculate the overall gain range.
+ * \param name the name of the gain element
+ * \param chan the channel index 0 to N-1
+ * \return a gain range object
+ */
+ virtual gain_range_t get_tx_gain_range(const std::string &name, size_t chan = 0) = 0;
+
+ //! A convenience wrapper for getting overall TX gain range
+ gain_range_t get_tx_gain_range(size_t chan = 0){
+ return this->get_tx_gain_range(ALL_GAINS, chan);
+ }
+
+ /*!
+ * Get the names of the gain elements in the TX chain.
+ * Gain elements are ordered from antenna to FPGA.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of gain element names
+ */
+ virtual std::vector<std::string> get_tx_gain_names(size_t chan = 0) = 0;
+
+ /*!
+ * Select the TX antenna on the subdevice.
+ * \param ant the antenna name
+ * \param chan the channel index 0 to N-1
+ */
virtual void set_tx_antenna(const std::string &ant, size_t chan = 0) = 0;
+
+ /*!
+ * Get the selected TX antenna on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the antenna name
+ */
virtual std::string get_tx_antenna(size_t chan = 0) = 0;
+
+ /*!
+ * Get a list of possible TX antennas on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return a vector of antenna names
+ */
virtual std::vector<std::string> get_tx_antennas(size_t chan = 0) = 0;
+ /*!
+ * Get the locked status of the LO on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return true for locked
+ */
virtual bool get_tx_lo_locked(size_t chan = 0) = 0;
+ /*!
+ * Set the TX bandwidth on the subdevice.
+ * \param bandwidth the bandwidth in Hz
+ * \param chan the channel index 0 to N-1
+ */
+ virtual void set_tx_bandwidth(double bandwidth, size_t chan = 0) = 0;
+
+ /*!
+ * Get the TX bandwidth on the subdevice.
+ * \param chan the channel index 0 to N-1
+ * \return the bandwidth in Hz
+ */
+ virtual double get_tx_bandwidth(size_t chan = 0) = 0;
+
+ /*!
+ * Get the dboard interface object for the TX subdevice.
+ * The dboard interface gives access to GPIOs, SPI, I2C, low-speed ADC and DAC.
+ * Use at your own risk!
+ * \param chan the channel index 0 to N-1
+ * \return the dboard interface sptr
+ */
virtual dboard_iface::sptr get_tx_dboard_iface(size_t chan = 0) = 0;
};
diff --git a/host/include/uhd/utils/gain_group.hpp b/host/include/uhd/utils/gain_group.hpp
index 3955dfa9a..c863248ce 100644
--- a/host/include/uhd/utils/gain_group.hpp
+++ b/host/include/uhd/utils/gain_group.hpp
@@ -23,6 +23,8 @@
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <boost/utility.hpp>
+#include <vector>
+#include <string>
namespace uhd{
@@ -40,36 +42,57 @@ public:
typedef boost::shared_ptr<gain_group> sptr;
/*!
- * Get the overall gain range for this group.
+ * Get the gain range for the gain element specified by name.
+ * For an empty name, get the overall gain range for this group.
* Overall step is defined as the minimum step size.
+ * \param name name of the gain element (optional)
* \return a gain range with overall min, max, step
*/
- virtual gain_range_t get_range(void) = 0;
+ virtual gain_range_t get_range(const std::string &name = "") = 0;
/*!
- * Get the overall gain value for this group.
- * \return a summation of all the gain values
+ * Get the gain value for the gain element specified by name.
+ * For an empty name, get the overall gain value for this group.
+ * \param name name of the gain element (optional)
+ * \return a gain value of the element or all elements
*/
- virtual float get_value(void) = 0;
+ virtual float get_value(const std::string &name = "") = 0;
/*!
- * Set the overall gain value for this group.
+ * Set the gain value for the gain element specified by name.
+ * For an empty name, set the overall gain value for this group.
* The power will be distributed across individual gain elements.
* The semantics of how to do this are determined by the priority.
- * \param gain the gain to set across the group
+ * \param gain the gain to set for the lement or across the group
+ * \param name name of the gain element (optional)
*/
- virtual void set_value(float gain) = 0;
+ virtual void set_value(float gain, const std::string &name = "") = 0;
/*!
- * Register a set of gain functions into this group.
+ * Get a list of names of registered gain elements.
+ * The names are in the order that they were registered.
+ * \return a vector of gain name strings
+ */
+ virtual const std::vector<std::string> get_names(void) = 0;
+
+ /*!
+ * Register a set of gain functions into this group:
+ *
+ * The name should be a unique and non-empty name.
+ * Othwerwise, the implementation will rename it.
+ *
* Priority determines how power will be distributed
* with higher priorities getting the power first,
* and lower priorities getting the remainder power.
+ *
+ * \param name the name of the gain element
* \param gain_fcns the set of gain functions
* \param priority the priority of the gain element
*/
virtual void register_fcns(
- const gain_fcns_t &gain_fcns, size_t priority = 0
+ const std::string &name,
+ const gain_fcns_t &gain_fcns,
+ size_t priority = 0
) = 0;
/*!