radio_ctrl.hpp

Go to the documentation of this file.

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

#ifndef INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP
#define INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP

#include <uhd/rfnoc/rate_node_ctrl.hpp>
#include <uhd/rfnoc/scalar_node_ctrl.hpp>
#include <uhd/rfnoc/sink_block_ctrl_base.hpp>
#include <uhd/rfnoc/source_block_ctrl_base.hpp>
#include <uhd/rfnoc/terminator_node_ctrl.hpp>
#include <uhd/rfnoc/tick_node_ctrl.hpp>
#include <uhd/types/direction.hpp>
#include <uhd/types/ranges.hpp>

namespace uhd { namespace rfnoc {

class UHD_RFNOC_API radio_ctrl : public source_block_ctrl_base,
                                 public sink_block_ctrl_base,
                                 public rate_node_ctrl,
                                 public tick_node_ctrl,
                                 public terminator_node_ctrl
{
public:
    UHD_RFNOC_BLOCK_OBJECT(radio_ctrl)

    virtual ~radio_ctrl() {}


    static const size_t ALL_CHANS = size_t(~0);

    static const std::string ALL_GAINS;

    static const std::string ALL_LOS;

    /************************************************************************
     * API calls
     ***********************************************************************/
    virtual double get_rate() const = 0;

    virtual double set_rate(double rate) = 0;

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

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

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

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

    virtual double get_tx_frequency(const size_t chan) /* const */ = 0;

    virtual double set_tx_frequency(const double freq, size_t chan) = 0;

    virtual double get_rx_frequency(const size_t chan) /* const */ = 0;

    virtual double set_rx_frequency(const double freq, const size_t chan) = 0;

    virtual double get_tx_gain(const size_t chan) = 0;

    virtual double set_tx_gain(const double gain, const size_t chan) = 0;

    virtual double get_rx_gain(const size_t chan) = 0;

    virtual double set_rx_gain(const double gain, const size_t chan) = 0;

    virtual double get_tx_bandwidth(const size_t chan) = 0;

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

    virtual double get_rx_bandwidth(const size_t chan) = 0;

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

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

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

    virtual time_spec_t get_time_now() = 0;

    virtual time_spec_t get_time_last_pps() = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**************************************************************************
     * Time and clock control
     *************************************************************************/

    virtual void set_time_source(const std::string& source) = 0;

    virtual std::string get_time_source() = 0;

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

    virtual void set_clock_source(const std::string& source) = 0;

    virtual std::string get_clock_source() = 0;

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

    virtual size_t get_chan_from_dboard_fe(
        const std::string& fe, const uhd::direction_t dir) = 0;

    virtual std::string get_dboard_fe_from_chan(
        const size_t chan, const uhd::direction_t dir) = 0;

    virtual void enable_rx_timestamps(const bool enable, const size_t chan) = 0;
}; /* class radio_ctrl */

}} /* namespace uhd::rfnoc */

#endif /* INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP */