multi_usrp.hpp

Go to the documentation of this file.

//
// Copyright 2010-2012,2014-2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_USRP_MULTI_USRP_HPP
#define INCLUDED_UHD_USRP_MULTI_USRP_HPP

// define API capabilities for compile time detection of new features
#define UHD_USRP_MULTI_USRP_REF_SOURCES_API
#define UHD_USRP_MULTI_USRP_GET_RATES_API
#define UHD_USRP_MULTI_USRP_FRONTEND_CAL_API
#define UHD_USRP_MULTI_USRP_FRONTEND_IQ_AUTO_API
#define UHD_USRP_MULTI_USRP_COMMAND_TIME_API
#define UHD_USRP_MULTI_USRP_BW_RANGE_API
#define UHD_USRP_MULTI_USRP_USER_REGS_API
#define UHD_USRP_MULTI_USRP_GET_USRP_INFO_API
#define UHD_USRP_MULTI_USRP_NORMALIZED_GAIN
#define UHD_USRP_MULTI_USRP_GPIO_API
#define UHD_USRP_MULTI_USRP_REGISTER_API
#define UHD_USRP_MULTI_USRP_FILTER_API
#define UHD_USRP_MULTI_USRP_LO_CONFIG_API
#define UHD_USRP_MULTI_USRP_TX_LO_CONFIG_API

#include <uhd/config.hpp>
#include <uhd/deprecated.hpp>
#include <uhd/device.hpp>
#include <uhd/types/filters.hpp>
#include <uhd/types/ranges.hpp>
#include <uhd/types/sensors.hpp>
#include <uhd/types/stream_cmd.hpp>
#include <uhd/types/tune_request.hpp>
#include <uhd/types/tune_result.hpp>
#include <uhd/types/wb_iface.hpp>
#include <uhd/usrp/dboard_iface.hpp>
#include <uhd/usrp/subdev_spec.hpp>
#include <boost/shared_ptr.hpp>
#include <uhd/utils/noncopyable.hpp>
#include <complex>
#include <string>
#include <vector>

namespace uhd {
class device3;

namespace usrp {

class UHD_API multi_usrp : uhd::noncopyable
{
public:
    typedef boost::shared_ptr<multi_usrp> sptr;

    virtual ~multi_usrp(void) = 0;

    static const size_t ALL_MBOARDS;

    static const size_t ALL_CHANS;

    static const std::string ALL_GAINS;

    static const std::string ALL_LOS;

    static sptr make(const device_addr_t& dev_addr);

    virtual device::sptr get_device(void) = 0;

    virtual bool is_device3(void) = 0;

    virtual boost::shared_ptr<uhd::device3> get_device3(void) = 0;

    virtual rx_streamer::sptr get_rx_stream(const stream_args_t& args) = 0;

    virtual tx_streamer::sptr get_tx_stream(const stream_args_t& args) = 0;

    virtual dict<std::string, std::string> get_usrp_rx_info(size_t chan = 0) = 0;

    virtual dict<std::string, std::string> get_usrp_tx_info(size_t chan = 0) = 0;

    /*******************************************************************
     * Mboard methods
     ******************************************************************/

    virtual void set_master_clock_rate(double rate, size_t mboard = ALL_MBOARDS) = 0;

    virtual double get_master_clock_rate(size_t mboard = 0) = 0;

    virtual meta_range_t get_master_clock_rate_range(const size_t mboard = 0) = 0;

    virtual std::string get_pp_string(void) = 0;

    virtual std::string get_mboard_name(size_t mboard = 0) = 0;

    virtual time_spec_t get_time_now(size_t mboard = 0) = 0;

    virtual time_spec_t get_time_last_pps(size_t mboard = 0) = 0;

    virtual void set_time_now(
        const time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;

    virtual void set_time_next_pps(
        const time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;

    virtual void set_time_unknown_pps(const time_spec_t& time_spec) = 0;

    virtual bool get_time_synchronized(void) = 0;

    virtual void set_command_time(
        const uhd::time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;

    virtual void clear_command_time(size_t mboard = ALL_MBOARDS) = 0;

    virtual void issue_stream_cmd(
        const stream_cmd_t& stream_cmd, size_t chan = ALL_CHANS) = 0;

    virtual void set_clock_config(
        const clock_config_t& clock_config, size_t mboard = ALL_MBOARDS) = 0;

    virtual void set_time_source(
        const std::string& source, const size_t mboard = ALL_MBOARDS) = 0;

    virtual std::string get_time_source(const size_t mboard) = 0;

    virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;

    virtual void set_clock_source(
        const std::string& source, const size_t mboard = ALL_MBOARDS) = 0;

    virtual std::string get_clock_source(const size_t mboard) = 0;

    virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;

    virtual void set_sync_source(const std::string& clock_source,
        const std::string& time_source,
        const size_t mboard = ALL_MBOARDS) = 0;

    virtual void set_sync_source(
        const device_addr_t& sync_source, const size_t mboard = ALL_MBOARDS) = 0;

    virtual device_addr_t get_sync_source(const size_t mboard) = 0;

    virtual std::vector<device_addr_t> get_sync_sources(const size_t mboard) = 0;

    virtual void set_clock_source_out(
        const bool enb, const size_t mboard = ALL_MBOARDS) = 0;

    virtual void set_time_source_out(
        const bool enb, const size_t mboard = ALL_MBOARDS) = 0;

    virtual size_t get_num_mboards(void) = 0;

    virtual sensor_value_t get_mboard_sensor(
        const std::string& name, size_t mboard = 0) = 0;

    virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;

    virtual void set_user_register(
        const uint8_t addr, const uint32_t data, size_t mboard = ALL_MBOARDS) = 0;

    virtual uhd::wb_iface::sptr get_user_settings_iface(const size_t chan = 0) = 0;

    /*******************************************************************
     * RX methods
     ******************************************************************/
    virtual void set_rx_subdev_spec(
        const uhd::usrp::subdev_spec_t& spec, size_t mboard = ALL_MBOARDS) = 0;

    virtual uhd::usrp::subdev_spec_t get_rx_subdev_spec(size_t mboard = 0) = 0;

    virtual size_t get_rx_num_channels(void) = 0;

    virtual std::string get_rx_subdev_name(size_t chan = 0) = 0;

    virtual void set_rx_rate(double rate, size_t chan = ALL_CHANS) = 0;

    virtual double get_rx_rate(size_t chan = 0) = 0;

    virtual meta_range_t get_rx_rates(size_t chan = 0) = 0;

    virtual tune_result_t set_rx_freq(
        const tune_request_t& tune_request, size_t chan = 0) = 0;

    virtual double get_rx_freq(size_t chan = 0) = 0;

    virtual freq_range_t get_rx_freq_range(size_t chan = 0) = 0;

    virtual freq_range_t get_fe_rx_freq_range(size_t chan = 0) = 0;

    /**************************************************************************
     * LO controls
     *************************************************************************/
    virtual std::vector<std::string> get_rx_lo_names(size_t chan = 0) = 0;

    virtual void set_rx_lo_source(
        const std::string& src, const std::string& name = ALL_LOS, size_t chan = 0) = 0;

    virtual const std::string get_rx_lo_source(
        const std::string& name = ALL_LOS, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_rx_lo_sources(
        const std::string& name = ALL_LOS, size_t chan = 0) = 0;

    virtual void set_rx_lo_export_enabled(
        bool enabled, const std::string& name = ALL_LOS, size_t chan = 0) = 0;

    virtual bool get_rx_lo_export_enabled(
        const std::string& name = ALL_LOS, size_t chan = 0) = 0;

    virtual double set_rx_lo_freq(
        double freq, const std::string& name, size_t chan = 0) = 0;

    virtual double get_rx_lo_freq(const std::string& name, size_t chan = 0) = 0;

    virtual freq_range_t get_rx_lo_freq_range(
        const std::string& name, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_tx_lo_names(size_t chan = 0) = 0;

    virtual void set_tx_lo_source(const std::string& src,
        const std::string& name = ALL_LOS,
        const size_t chan       = 0) = 0;

    virtual const std::string get_tx_lo_source(
        const std::string& name = ALL_LOS, const size_t chan = 0) = 0;

    virtual std::vector<std::string> get_tx_lo_sources(
        const std::string& name = ALL_LOS, const size_t chan = 0) = 0;

    virtual void set_tx_lo_export_enabled(
        const bool enabled, const std::string& name = ALL_LOS, const size_t chan = 0) = 0;

    virtual bool get_tx_lo_export_enabled(
        const std::string& name = ALL_LOS, const size_t chan = 0) = 0;

    virtual double set_tx_lo_freq(
        const double freq, const std::string& name, const size_t chan = 0) = 0;

    virtual double get_tx_lo_freq(const std::string& name, const size_t chan = 0) = 0;

    virtual freq_range_t get_tx_lo_freq_range(
        const std::string& name, const size_t chan = 0) = 0;

    /**************************************************************************
     * Gain controls
     *************************************************************************/
    virtual void set_rx_gain(double gain, const std::string& name, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_rx_gain_profile_names(const size_t chan = 0) = 0;

    virtual void set_rx_gain_profile(
        const std::string& profile, const size_t chan = 0) = 0;

    virtual std::string get_rx_gain_profile(const size_t chan = 0) = 0;

    void set_rx_gain(double gain, size_t chan = 0)
    {
        return this->set_rx_gain(gain, ALL_GAINS, chan);
    }

    virtual void set_normalized_rx_gain(double gain, size_t chan = 0) = 0;

    virtual void set_rx_agc(bool enable, size_t chan = 0) = 0;

    virtual double get_rx_gain(const std::string& name, size_t chan = 0) = 0;

    double get_rx_gain(size_t chan = 0)
    {
        return this->get_rx_gain(ALL_GAINS, chan);
    }

    virtual double get_normalized_rx_gain(size_t chan = 0) = 0;

    virtual gain_range_t get_rx_gain_range(const std::string& name, size_t chan = 0) = 0;

    gain_range_t get_rx_gain_range(size_t chan = 0)
    {
        return this->get_rx_gain_range(ALL_GAINS, chan);
    }

    virtual std::vector<std::string> get_rx_gain_names(size_t chan = 0) = 0;

    virtual void set_rx_antenna(const std::string& ant, size_t chan = 0) = 0;

    virtual std::string get_rx_antenna(size_t chan = 0) = 0;

    virtual std::vector<std::string> get_rx_antennas(size_t chan = 0) = 0;

    virtual void set_rx_bandwidth(double bandwidth, size_t chan = 0) = 0;

    virtual double get_rx_bandwidth(size_t chan = 0) = 0;

    virtual meta_range_t get_rx_bandwidth_range(size_t chan = 0) = 0;

    virtual dboard_iface::sptr get_rx_dboard_iface(size_t chan = 0) = 0;

    virtual sensor_value_t get_rx_sensor(const std::string& name, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_rx_sensor_names(size_t chan = 0) = 0;

    virtual void set_rx_dc_offset(const bool enb, size_t chan = ALL_CHANS) = 0;

    virtual void set_rx_dc_offset(
        const std::complex<double>& offset, size_t chan = ALL_CHANS) = 0;

    virtual meta_range_t get_rx_dc_offset_range(size_t chan = 0) = 0;

    virtual void set_rx_iq_balance(const bool enb, size_t chan) = 0;

    virtual void set_rx_iq_balance(
        const std::complex<double>& correction, size_t chan = ALL_CHANS) = 0;

    /*******************************************************************
     * TX methods
     ******************************************************************/
    virtual void set_tx_subdev_spec(
        const uhd::usrp::subdev_spec_t& spec, size_t mboard = ALL_MBOARDS) = 0;

    virtual uhd::usrp::subdev_spec_t get_tx_subdev_spec(size_t mboard = 0) = 0;

    virtual size_t get_tx_num_channels(void) = 0;

    virtual std::string get_tx_subdev_name(size_t chan = 0) = 0;

    virtual void set_tx_rate(double rate, size_t chan = ALL_CHANS) = 0;

    virtual double get_tx_rate(size_t chan = 0) = 0;

    virtual meta_range_t get_tx_rates(size_t chan = 0) = 0;

    virtual tune_result_t set_tx_freq(
        const tune_request_t& tune_request, size_t chan = 0) = 0;

    virtual double get_tx_freq(size_t chan = 0) = 0;

    virtual freq_range_t get_tx_freq_range(size_t chan = 0) = 0;

    virtual freq_range_t get_fe_tx_freq_range(size_t chan = 0) = 0;

    virtual void set_tx_gain(double gain, const std::string& name, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_tx_gain_profile_names(const size_t chan = 0) = 0;

    virtual void set_tx_gain_profile(
        const std::string& profile, const size_t chan = 0) = 0;

    virtual std::string get_tx_gain_profile(const size_t chan = 0) = 0;

    void set_tx_gain(double gain, size_t chan = 0)
    {
        return this->set_tx_gain(gain, ALL_GAINS, chan);
    }

    virtual void set_normalized_tx_gain(double gain, size_t chan = 0) = 0;

    virtual double get_tx_gain(const std::string& name, size_t chan = 0) = 0;

    double get_tx_gain(size_t chan = 0)
    {
        return this->get_tx_gain(ALL_GAINS, chan);
    }

    virtual double get_normalized_tx_gain(size_t chan = 0) = 0;

    virtual gain_range_t get_tx_gain_range(const std::string& name, size_t chan = 0) = 0;

    gain_range_t get_tx_gain_range(size_t chan = 0)
    {
        return this->get_tx_gain_range(ALL_GAINS, chan);
    }

    virtual std::vector<std::string> get_tx_gain_names(size_t chan = 0) = 0;

    virtual void set_tx_antenna(const std::string& ant, size_t chan = 0) = 0;

    virtual std::string get_tx_antenna(size_t chan = 0) = 0;

    virtual std::vector<std::string> get_tx_antennas(size_t chan = 0) = 0;

    virtual void set_tx_bandwidth(double bandwidth, size_t chan = 0) = 0;

    virtual double get_tx_bandwidth(size_t chan = 0) = 0;

    virtual meta_range_t get_tx_bandwidth_range(size_t chan = 0) = 0;

    virtual dboard_iface::sptr get_tx_dboard_iface(size_t chan = 0) = 0;

    virtual sensor_value_t get_tx_sensor(const std::string& name, size_t chan = 0) = 0;

    virtual std::vector<std::string> get_tx_sensor_names(size_t chan = 0) = 0;

    virtual void set_tx_dc_offset(
        const std::complex<double>& offset, size_t chan = ALL_CHANS) = 0;

    virtual meta_range_t get_tx_dc_offset_range(size_t chan = 0) = 0;

    virtual void set_tx_iq_balance(
        const std::complex<double>& correction, size_t chan = ALL_CHANS) = 0;

    /*******************************************************************
     * GPIO methods
     ******************************************************************/

    virtual std::vector<std::string> get_gpio_banks(const size_t mboard) = 0;

    virtual void set_gpio_attr(const std::string& bank,
        const std::string& attr,
        const uint32_t value,
        const uint32_t mask = 0xffffffff,
        const size_t mboard = 0) = 0;

    virtual void set_gpio_attr(const std::string& bank,
        const std::string& attr,
        const std::string& value,
        const uint32_t mask = 0xffffffff,
        const size_t mboard = 0) = 0;

    virtual uint32_t get_gpio_attr(
        const std::string& bank, const std::string& attr, const size_t mboard = 0) = 0;

    virtual std::vector<std::string> get_gpio_string_attr(
        const std::string& bank, const std::string& attr, const size_t mboard = 0) = 0;

    /*******************************************************************
     * Register IO methods
     ******************************************************************/
    struct register_info_t
    {
        size_t bitwidth;
        bool readable;
        bool writable;
    };

    virtual std::vector<std::string> enumerate_registers(const size_t mboard = 0) = 0;

    virtual register_info_t get_register_info(
        const std::string& path, const size_t mboard = 0) = 0;

    virtual void write_register(const std::string& path,
        const uint32_t field,
        const uint64_t value,
        const size_t mboard = 0) = 0;

    virtual uint64_t read_register(
        const std::string& path, const uint32_t field, const size_t mboard = 0) = 0;

    /*******************************************************************
     * Filter API methods
     ******************************************************************/

    virtual std::vector<std::string> get_filter_names(
        const std::string& search_mask = "") = 0;

    virtual filter_info_base::sptr get_filter(const std::string& path) = 0;

    virtual void set_filter(const std::string& path, filter_info_base::sptr filter) = 0;
};

} // namespace usrp
} // namespace uhd

#endif /* INCLUDED_UHD_USRP_MULTI_USRP_HPP */