ddc_block_control.hpp

Go to the documentation of this file.

//
// Copyright 2019 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.hpp>
#include <uhd/rfnoc/noc_block_base.hpp>
#include <uhd/types/ranges.hpp>
#include <boost/optional.hpp>

namespace uhd { namespace rfnoc {

class UHD_API ddc_block_control : public noc_block_base
{
public:
    RFNOC_DECLARE_BLOCK(ddc_block_control)

    static const uint16_t MAJOR_COMPAT;
    static const uint16_t MINOR_COMPAT;
    // Readback addresses
    static const uint32_t RB_COMPAT_NUM;
    static const uint32_t RB_NUM_HB;
    static const uint32_t RB_CIC_MAX_DECIM;
    // Write addresses
    static const uint32_t SR_N_ADDR;
    static const uint32_t SR_M_ADDR;
    static const uint32_t SR_CONFIG_ADDR;
    static const uint32_t SR_FREQ_ADDR;
    static const uint32_t SR_SCALE_IQ_ADDR;
    static const uint32_t SR_DECIM_ADDR;
    static const uint32_t SR_MUX_ADDR;
    static const uint32_t SR_COEFFS_ADDR;
    static const uint32_t SR_TIME_INCR_ADDR;

    virtual double set_freq(const double freq,
        const size_t chan,
        const boost::optional<uhd::time_spec_t> time = boost::none) = 0;

    virtual double get_freq(const size_t chan) const = 0;

    virtual uhd::freq_range_t get_frequency_range(const size_t chan) const = 0;

    virtual double get_input_rate(const size_t chan) const = 0;

    virtual void set_input_rate(const double rate, const size_t chan) = 0;

    virtual double get_output_rate(const size_t chan) const = 0;

    virtual uhd::meta_range_t get_output_rates(const size_t chan) const = 0;

    virtual double set_output_rate(const double rate, const size_t chan) = 0;

    /**************************************************************************
     * Streaming-Related API Calls
     *************************************************************************/
    virtual void issue_stream_cmd(
        const uhd::stream_cmd_t& stream_cmd, const size_t port) = 0;
};

}} // namespace uhd::rfnoc