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>
#include <optional>
 
namespace uhd { namespace rfnoc {

class UHD_API ddc_block_control : public noc_block_base
{
public:
    RFNOC_DECLARE_BLOCK(ddc_block_control)
 
    
    struct reg_addrs_t
    {
        uint16_t major_compat; 
        uint16_t minor_compat; 
        // Readback addresses
        uint32_t rb_num_hb; 
        uint32_t rb_cic_max_decim; 
        std::optional<uint32_t> rb_spc;
        // Per-channel write addresses
        uint32_t sr_decim_addr; 
        uint32_t sr_freq_addr; 
        uint32_t sr_scale_iq_addr; 
        std::optional<uint32_t> sr_n_addr; 
        std::optional<uint32_t> sr_m_addr; 
        uint32_t sr_time_incr_addr; 
        // Single-sample-only registers (not poked by block controller, exposed for
        // external callers). std::nullopt for V1.
        std::optional<uint32_t> sr_config_addr;
        std::optional<uint32_t> sr_mux_addr;
        std::optional<uint32_t> sr_coeffs_addr;
        uint32_t reg_chan_offset;
    };

    static const uint32_t RB_COMPAT_NUM;
    static const reg_addrs_t REG_ADDRS_V0;
    static const reg_addrs_t REG_ADDRS_V1;

    virtual double set_freq(const double freq,
        const size_t chan,
        const std::optional<uhd::time_spec_t> time = {}) = 0;
 
    double set_freq(const double freq, const size_t chan, const uhd::time_spec_t time)
    {
        return set_freq(freq, chan, std::make_optional(time));
    }
 
    [[deprecated("Prefer std::optional over boost::optional.")]] double set_freq(
        const double freq,
        const size_t chan,
        const boost::optional<uhd::time_spec_t> time)
    {
        return set_freq(
            freq, chan, bool(time) ? std::make_optional(*time) : std::nullopt);
    }

    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