diff options
| -rw-r--r-- | host/docs/coding.rst | 34 | ||||
| -rw-r--r-- | host/include/uhd/usrp/multi_usrp.hpp | 123 | ||||
| -rw-r--r-- | host/include/uhd/usrp/single_usrp.hpp | 435 | ||||
| -rw-r--r-- | host/lib/usrp/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | host/lib/usrp/multi_usrp.cpp | 13 | ||||
| -rw-r--r-- | host/lib/usrp/single_usrp.cpp | 339 |
6 files changed, 93 insertions, 852 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst index 7533445ea..ecca4e8b8 100644 --- a/host/docs/coding.rst +++ b/host/docs/coding.rst @@ -23,40 +23,10 @@ The device API provides ways to: See the documentation in *device.hpp* for reference. ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -High-Level: The single usrp -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The goal of the single usrp API is to wrap high level functions around the device properties. -The single usrp provides a fat interface to access the most common properties. -The single usrp provides ways to: - -* Set and get daughterboard gains. -* Set and get daughterboard antennas. -* Set and get the streaming rates. -* Tune the DSPs and daughterboards. -* Issue stream commands. -* Set the clock configuration. -* Set the usrp time registers. -* Get the underlying device (as discussed above). - -See the documentation in *usrp/single_usrp.hpp* for reference. - -^^^^^^^^^^^^^^^^^^^^^^^^^^^ High-Level: The multi usrp ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The multi usrp API provides a wrapper around a device that represents several motherboards. -This API provides convenience calls just like the single usrp, -however the calls either work across all channels in the configuration, -or take a channel argument to specify which channel to configure. -The multi usrp provides ways to: - -* Set and get the sample rate across all channels. -* Issue a stream command across all channels. -* Set the time registers across all channels. -* Set and get individual daughterboard gains. -* Set and get individual daughterboard antennas. -* Tune individual DSPs and daughterboards. -* Get the underlying device (as discussed above). - +The Multi-USRP class provides a FAT interface to a single USRP with +one or more channels, or multiple USRPs in a homogeneous setup. See the documentation in *usrp/multi_usrp.hpp* for reference. ------------------------------------------------------------------------ diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp index b603d4324..6e17c0ea8 100644 --- a/host/include/uhd/usrp/multi_usrp.hpp +++ b/host/include/uhd/usrp/multi_usrp.hpp @@ -34,19 +34,30 @@ 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. + * The Multi-USRP device class: * - * A few notes about a multi-USRP configuration: + * This class facilitates ease-of-use for most use-case scenarios. + * The wrapper provides convenience functions to tune the devices, + * set the dboard gains, antennas, filters, and other properties. + * This class can be used to interface with a single USRP with + * one or more channels, or multiple USRPs in a homogeneous setup. + * All members take an optional parameter for board number or channel number. + * In the single device, single channel case, these parameters can be unspecified. + * + * When using a single device with multiple channels: + * - Channel mapping is determined by the subdevice specifications + * - All channels share a common RX sample rate + * - All channels share a common TX sample rate + * + * When using multiple devices in a configuration: + * - Channel mapping is determined by the device address arguments * - 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: + * Example to setup channel mapping for multiple devices: * <pre> * * //create a multi_usrp with two boards in the configuration @@ -106,7 +117,7 @@ public: * \param mboard which motherboard to query * \return a string representing the name */ - virtual std::string get_mboard_name(size_t mboard) = 0; + virtual std::string get_mboard_name(size_t mboard = 0) = 0; /*! * Get the current time in the usrp time registers. @@ -121,6 +132,19 @@ public: virtual time_spec_t get_time_last_pps(void) = 0; /*! + * Sets the time registers on the usrp immediately. + * + * If only one MIMO master is present in your configuration, set_time_now is + * safe to use because the slave's time automatically follows the master's time. + * Otherwise, this call cannot set the time synchronously across multiple devices. + * Please use the set_time_next_pps or set_time_unknown_pps calls with a PPS signal. + * + * \param time_spec the time to latch into the usrp device + * \param mboard the motherboard index 0 to M-1 + */ + virtual void set_time_now(const time_spec_t &time_spec, size_t mboard = ALL_MBOARDS) = 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 @@ -162,6 +186,11 @@ public: * 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. + * + * With multiple devices, the first stream command in a chain of commands + * should have a time spec in the near future and stream_now = false; + * to ensure that the packets can be aligned by their time specs. + * * \param stream_cmd the stream command to issue */ virtual void issue_stream_cmd(const stream_cmd_t &stream_cmd) = 0; @@ -173,7 +202,7 @@ public: * \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; + virtual void set_clock_config(const clock_config_t &clock_config, size_t mboard = ALL_MBOARDS) = 0; /*! * Get the number of USRP motherboards in this configuration. @@ -191,14 +220,14 @@ public: * \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; + virtual void set_rx_subdev_spec(const uhd::usrp::subdev_spec_t &spec, size_t mboard = ALL_MBOARDS) = 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; + virtual uhd::usrp::subdev_spec_t get_rx_subdev_spec(size_t mboard = 0) = 0; /*! * Get the number of RX channels in this configuration. @@ -212,7 +241,7 @@ public: * \param chan the channel index 0 to N-1 * \return the subdevice name */ - virtual std::string get_rx_subdev_name(size_t chan) = 0; + virtual std::string get_rx_subdev_name(size_t chan = 0) = 0; /*! * Set the RX sample rate across all channels. @@ -241,14 +270,14 @@ public: * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ - virtual double get_rx_freq(size_t chan) = 0; + 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; + virtual freq_range_t get_rx_freq_range(size_t chan = 0) = 0; /*! * Set the RX gain value for the specified gain element. @@ -257,10 +286,10 @@ public: * \param name the name of the gain element * \param chan the channel index 0 to N-1 */ - virtual void set_rx_gain(double gain, const std::string &name, size_t chan) = 0; + virtual void set_rx_gain(double gain, const std::string &name, size_t chan = 0) = 0; //! A convenience wrapper for setting overall RX gain - void set_rx_gain(double gain, size_t chan){ + void set_rx_gain(double gain, size_t chan = 0){ return this->set_rx_gain(gain, ALL_GAINS, chan); } @@ -271,10 +300,10 @@ public: * \param chan the channel index 0 to N-1 * \return the gain in dB */ - virtual double get_rx_gain(const std::string &name, size_t chan) = 0; + virtual double get_rx_gain(const std::string &name, size_t chan = 0) = 0; //! A convenience wrapper for getting overall RX gain - double get_rx_gain(size_t chan){ + double get_rx_gain(size_t chan = 0){ return this->get_rx_gain(ALL_GAINS, chan); } @@ -285,10 +314,10 @@ public: * \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; + 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){ + gain_range_t get_rx_gain_range(size_t chan = 0){ return this->get_rx_gain_range(ALL_GAINS, chan); } @@ -298,49 +327,49 @@ public: * \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; + 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; + 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; + 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; + 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; + virtual bool get_rx_lo_locked(size_t chan = 0) = 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; + 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; + virtual double get_rx_bandwidth(size_t chan = 0) = 0; /*! * Read the RSSI value on the RX subdevice. @@ -348,7 +377,7 @@ public: * \return the rssi in dB * \throw exception if RSSI readback not supported */ - virtual double read_rssi(size_t chan) = 0; + virtual double read_rssi(size_t chan = 0) = 0; /*! * Get the dboard interface object for the RX subdevice. @@ -357,7 +386,7 @@ public: * \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; + virtual dboard_iface::sptr get_rx_dboard_iface(size_t chan = 0) = 0; /******************************************************************* * TX methods @@ -370,14 +399,14 @@ public: * \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; + virtual void set_tx_subdev_spec(const uhd::usrp::subdev_spec_t &spec, size_t mboard = ALL_MBOARDS) = 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; + virtual uhd::usrp::subdev_spec_t get_tx_subdev_spec(size_t mboard = 0) = 0; /*! * Get the number of TX channels in this configuration. @@ -391,7 +420,7 @@ public: * \param chan the channel index 0 to N-1 * \return the subdevice name */ - virtual std::string get_tx_subdev_name(size_t chan) = 0; + virtual std::string get_tx_subdev_name(size_t chan = 0) = 0; /*! * Set the TX sample rate across all channels. @@ -420,14 +449,14 @@ public: * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ - virtual double get_tx_freq(size_t chan) = 0; + 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; + virtual freq_range_t get_tx_freq_range(size_t chan = 0) = 0; /*! * Set the TX gain value for the specified gain element. @@ -436,10 +465,10 @@ public: * \param name the name of the gain element * \param chan the channel index 0 to N-1 */ - virtual void set_tx_gain(double gain, const std::string &name, size_t chan) = 0; + virtual void set_tx_gain(double gain, const std::string &name, size_t chan = 0) = 0; //! A convenience wrapper for setting overall TX gain - void set_tx_gain(double gain, size_t chan){ + void set_tx_gain(double gain, size_t chan = 0){ return this->set_tx_gain(gain, ALL_GAINS, chan); } @@ -450,10 +479,10 @@ public: * \param chan the channel index 0 to N-1 * \return the gain in dB */ - virtual double get_tx_gain(const std::string &name, size_t chan) = 0; + virtual double get_tx_gain(const std::string &name, size_t chan = 0) = 0; //! A convenience wrapper for getting overall TX gain - double get_tx_gain(size_t chan){ + double get_tx_gain(size_t chan = 0){ return this->get_tx_gain(ALL_GAINS, chan); } @@ -464,10 +493,10 @@ public: * \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; + 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){ + gain_range_t get_tx_gain_range(size_t chan = 0){ return this->get_tx_gain_range(ALL_GAINS, chan); } @@ -477,49 +506,49 @@ public: * \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; + 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; + 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; + 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; + 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; + 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; + 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; + virtual double get_tx_bandwidth(size_t chan = 0) = 0; /*! * Get the dboard interface object for the TX subdevice. @@ -528,7 +557,7 @@ public: * \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; + virtual dboard_iface::sptr get_tx_dboard_iface(size_t chan = 0) = 0; }; }} diff --git a/host/include/uhd/usrp/single_usrp.hpp b/host/include/uhd/usrp/single_usrp.hpp index d80999300..0520db162 100644 --- a/host/include/uhd/usrp/single_usrp.hpp +++ b/host/include/uhd/usrp/single_usrp.hpp @@ -18,441 +18,12 @@ #ifndef INCLUDED_UHD_USRP_SINGLE_USRP_HPP #define INCLUDED_UHD_USRP_SINGLE_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_request.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> +#include <uhd/usrp/multi_usrp.hpp> namespace uhd{ namespace usrp{ -/*! - * 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. - */ -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 - * \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. - * \return a string representing the name - */ - virtual std::string get_mboard_name(void) = 0; - - /*! - * Get the current time in the usrp time registers. - * \return a timespec representing current usrp time - */ - virtual time_spec_t get_time_now(void) = 0; - - /*! - * Get the time when the last pps pulse occured. - * \return a timespec representing the last pps - */ - virtual time_spec_t get_time_last_pps(void) = 0; - - /*! - * Sets the time registers on the usrp immediately. - * \param time_spec the time to latch into the usrp device - */ - virtual void set_time_now(const time_spec_t &time_spec) = 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; - - /*! - * 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 - */ - virtual void set_clock_config(const clock_config_t &clock_config) = 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. - * \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 tune_request tune request instructions - * \param chan the channel index 0 to N-1 - * \return a tune result object - */ - virtual tune_result_t set_rx_freq( - const tune_request_t &tune_request, 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; - - /*! - * 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(double gain, const std::string &name, size_t chan = 0) = 0; - - //! A convenience wrapper for setting overall RX gain - void set_rx_gain(double 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 double get_rx_gain(const std::string &name, size_t chan = 0) = 0; - - //! A convenience wrapper for getting overall RX gain - double 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; - - /*! - * 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 double 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; - - /******************************************************************* - * 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. - * \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 tune_request tune request instructions - * \param chan the channel index 0 to N-1 - * \return a tune result object - */ - virtual tune_result_t set_tx_freq( - const tune_request_t &tune_request, 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; - - /*! - * 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(double gain, const std::string &name, size_t chan = 0) = 0; - - //! A convenience wrapper for setting overall TX gain - void set_tx_gain(double 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 double get_tx_gain(const std::string &name, size_t chan = 0) = 0; - - //! A convenience wrapper for getting overall TX gain - double 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; -}; + //! Multi-USRP is a superset of Single-USRP + typedef multi_usrp single_usrp; }} diff --git a/host/lib/usrp/CMakeLists.txt b/host/lib/usrp/CMakeLists.txt index bd25aec2b..97a54a798 100644 --- a/host/lib/usrp/CMakeLists.txt +++ b/host/lib/usrp/CMakeLists.txt @@ -29,7 +29,6 @@ LIBUHD_APPEND_SOURCES( ${CMAKE_CURRENT_SOURCE_DIR}/mboard_eeprom.cpp ${CMAKE_CURRENT_SOURCE_DIR}/misc_utils.cpp ${CMAKE_CURRENT_SOURCE_DIR}/multi_usrp.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/single_usrp.cpp ${CMAKE_CURRENT_SOURCE_DIR}/subdev_spec.cpp ${CMAKE_CURRENT_SOURCE_DIR}/tune_helper.cpp ${CMAKE_CURRENT_SOURCE_DIR}/wrapper_utils.hpp diff --git a/host/lib/usrp/multi_usrp.cpp b/host/lib/usrp/multi_usrp.cpp index 48eec28c1..17458496b 100644 --- a/host/lib/usrp/multi_usrp.cpp +++ b/host/lib/usrp/multi_usrp.cpp @@ -55,9 +55,10 @@ public: ******************************************************************/ std::string get_pp_string(void){ std::string buff = str(boost::format( - "Multi USRP:\n" + "%s USRP:\n" " Device: %s\n" ) + % ((get_num_mboards() > 1)? "Multi" : "Single") % (*_dev)[DEVICE_PROP_NAME].as<std::string>() ); for (size_t m = 0; m < get_num_mboards(); m++){ @@ -121,6 +122,16 @@ public: return _mboard(0)[MBOARD_PROP_TIME_PPS].as<time_spec_t>(); } + void set_time_now(const time_spec_t &time_spec, size_t mboard){ + if (mboard != ALL_MBOARDS){ + _mboard(mboard)[MBOARD_PROP_TIME_NOW] = time_spec; + return; + } + for (size_t m = 0; m < get_num_mboards(); m++){ + set_time_now(time_spec, m); + } + } + 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_PPS] = time_spec; diff --git a/host/lib/usrp/single_usrp.cpp b/host/lib/usrp/single_usrp.cpp deleted file mode 100644 index c37449c5f..000000000 --- a/host/lib/usrp/single_usrp.cpp +++ /dev/null @@ -1,339 +0,0 @@ -// -// Copyright 2010-2011 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 "wrapper_utils.hpp" -#include <uhd/usrp/single_usrp.hpp> -#include <uhd/usrp/tune_helper.hpp> -#include <uhd/utils/assert.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/foreach.hpp> -#include <boost/format.hpp> -#include <stdexcept> -#include <iostream> - -using namespace uhd; -using namespace uhd::usrp; - -const std::string single_usrp::ALL_GAINS = ""; - -/*********************************************************************** - * Simple USRP Implementation - **********************************************************************/ -class single_usrp_impl : public single_usrp{ -public: - single_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( - "Single USRP:\n" - " Device: %s\n" - " Mboard: %s\n" - ) - % (*_dev)[DEVICE_PROP_NAME].as<std::string>() - % _mboard()[MBOARD_PROP_NAME].as<std::string>() - ); - - //----------- rx side of life ---------------------------------- - buff += str(boost::format( - " RX DSP: %s\n" - ) - % _rx_dsp()[DSP_PROP_NAME].as<std::string>() - ); - for (size_t chan = 0; chan < this->get_rx_subdev_spec().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 ---------------------------------- - buff += str(boost::format( - " TX DSP: %s\n" - ) - % _tx_dsp()[DSP_PROP_NAME].as<std::string>() - ); - for (size_t chan = 0; chan < this->get_tx_subdev_spec().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(void){ - return _mboard()[MBOARD_PROP_NAME].as<std::string>(); - } - - time_spec_t get_time_now(void){ - return _mboard()[MBOARD_PROP_TIME_NOW].as<time_spec_t>(); - } - - time_spec_t get_time_last_pps(void){ - return _mboard()[MBOARD_PROP_TIME_PPS].as<time_spec_t>(); - } - - void set_time_now(const time_spec_t &time_spec){ - _mboard()[MBOARD_PROP_TIME_NOW] = time_spec; - } - - void set_time_next_pps(const time_spec_t &time_spec){ - _mboard()[MBOARD_PROP_TIME_PPS] = time_spec; - } - - void issue_stream_cmd(const stream_cmd_t &stream_cmd){ - _mboard()[MBOARD_PROP_STREAM_CMD] = stream_cmd; - } - - void set_clock_config(const clock_config_t &clock_config){ - _mboard()[MBOARD_PROP_CLOCK_CONFIG] = clock_config; - } - - /******************************************************************* - * RX methods - ******************************************************************/ - void set_rx_subdev_spec(const subdev_spec_t &spec){ - _mboard()[MBOARD_PROP_RX_SUBDEV_SPEC] = spec; - } - - subdev_spec_t get_rx_subdev_spec(void){ - return _mboard()[MBOARD_PROP_RX_SUBDEV_SPEC].as<subdev_spec_t>(); - } - - 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){ - _rx_dsp()[DSP_PROP_HOST_RATE] = rate; - do_samp_rate_warning_message(rate, get_rx_rate(), "RX"); - } - - double get_rx_rate(void){ - return _rx_dsp()[DSP_PROP_HOST_RATE].as<double>(); - } - - tune_result_t set_rx_freq(const tune_request_t &tune_request, size_t chan){ - tune_result_t r = tune_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(), chan, tune_request); - do_tune_freq_warning_message(tune_request.target_freq, get_rx_freq(chan), "RX"); - return r; - } - - double get_rx_freq(size_t chan){ - return derive_freq_from_rx_subdev_and_dsp(_rx_subdev(chan), _rx_dsp(), chan); - } - - 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()); - } - - void set_rx_gain(double gain, const std::string &name, size_t chan){ - return _rx_gain_group(chan)->set_value(gain, name); - } - - double get_rx_gain(const std::string &name, size_t chan){ - return _rx_gain_group(chan)->get_value(name); - } - - gain_range_t get_rx_gain_range(const std::string &name, size_t chan){ - return _rx_gain_group(chan)->get_range(name); - } - - std::vector<std::string> get_rx_gain_names(size_t chan){ - return _rx_gain_group(chan)->get_names(); - } - - 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>(); - } - - void set_rx_bandwidth(double bandwidth, size_t chan){ - _rx_subdev(chan)[SUBDEV_PROP_BANDWIDTH] = bandwidth; - } - - double get_rx_bandwidth(size_t chan){ - return _rx_subdev(chan)[SUBDEV_PROP_BANDWIDTH].as<double>(); - } - - double read_rssi(size_t chan){ - return _rx_subdev(chan)[SUBDEV_PROP_RSSI].as<double>(); - } - - dboard_iface::sptr get_rx_dboard_iface(size_t chan){ - return _rx_dboard(chan)[DBOARD_PROP_DBOARD_IFACE].as<dboard_iface::sptr>(); - } - - /******************************************************************* - * TX methods - ******************************************************************/ - void set_tx_subdev_spec(const subdev_spec_t &spec){ - _mboard()[MBOARD_PROP_TX_SUBDEV_SPEC] = spec; - } - - subdev_spec_t get_tx_subdev_spec(void){ - return _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>(); - } - - void set_tx_rate(double rate){ - _tx_dsp()[DSP_PROP_HOST_RATE] = rate; - do_samp_rate_warning_message(rate, get_tx_rate(), "TX"); - } - - double get_tx_rate(void){ - return _tx_dsp()[DSP_PROP_HOST_RATE].as<double>(); - } - - tune_result_t set_tx_freq(const tune_request_t &tune_request, size_t chan){ - tune_result_t r = tune_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(), chan, tune_request); - do_tune_freq_warning_message(tune_request.target_freq, get_tx_freq(chan), "TX"); - return r; - } - - double get_tx_freq(size_t chan){ - return derive_freq_from_tx_subdev_and_dsp(_tx_subdev(chan), _tx_dsp(), chan); - } - - 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()); - } - - void set_tx_gain(double gain, const std::string &name, size_t chan){ - return _tx_gain_group(chan)->set_value(gain, name); - } - - double get_tx_gain(const std::string &name, size_t chan){ - return _tx_gain_group(chan)->get_value(name); - } - - gain_range_t get_tx_gain_range(const std::string &name, size_t chan){ - return _tx_gain_group(chan)->get_range(name); - } - - std::vector<std::string> get_tx_gain_names(size_t chan){ - return _tx_gain_group(chan)->get_names(); - } - - 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>(); - } - - void set_tx_bandwidth(double bandwidth, size_t chan){ - _tx_subdev(chan)[SUBDEV_PROP_BANDWIDTH] = bandwidth; - } - - double get_tx_bandwidth(size_t chan){ - return _tx_subdev(chan)[SUBDEV_PROP_BANDWIDTH].as<double>(); - } - - 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(void){ - return (*_dev)[DEVICE_PROP_MBOARD]; - } - wax::obj _rx_dsp(void){ - return _mboard()[MBOARD_PROP_RX_DSP]; - } - wax::obj _tx_dsp(void){ - return _mboard()[MBOARD_PROP_TX_DSP]; - } - wax::obj _rx_dboard(size_t chan){ - std::string db_name = this->get_rx_subdev_spec().at(chan).db_name; - return _mboard()[named_prop_t(MBOARD_PROP_RX_DBOARD, db_name)]; - } - wax::obj _tx_dboard(size_t chan){ - std::string db_name = this->get_tx_subdev_spec().at(chan).db_name; - return _mboard()[named_prop_t(MBOARD_PROP_TX_DBOARD, db_name)]; - } - wax::obj _rx_subdev(size_t chan){ - std::string sd_name = this->get_rx_subdev_spec().at(chan).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 = this->get_tx_subdev_spec().at(chan).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 = this->get_rx_subdev_spec().at(chan).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 = this->get_tx_subdev_spec().at(chan).sd_name; - return _tx_dboard(chan)[named_prop_t(DBOARD_PROP_GAIN_GROUP, sd_name)].as<gain_group::sptr>(); - } -}; - -/*********************************************************************** - * The Make Function - **********************************************************************/ -single_usrp::sptr single_usrp::make(const device_addr_t &dev_addr){ - return sptr(new single_usrp_impl(dev_addr)); -} |