duc_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 <uhd/types/time_spec.hpp>
#include <boost/optional.hpp>
#include <optional>
 
namespace uhd { namespace rfnoc {

class UHD_API duc_block_control : public noc_block_base
{
public:
    RFNOC_DECLARE_BLOCK(duc_block_control)
 
    
    struct reg_addrs_t
    {
        uint16_t major_compat;
        uint16_t minor_compat;
        uint32_t num_hb;
        uint32_t cic_max_interp;
        std::optional<uint32_t> n_addr;
        std::optional<uint32_t> m_addr;
        std::optional<uint32_t> config_addr;
        uint32_t interp_addr;
        uint32_t freq_addr;
        uint32_t scale_iq_addr;
        uint32_t time_incr_addr;
    };
 
    // Compat register address (same across all versions)
    static const uint32_t REG_COMPAT_NUM;
    // Register addresses for version 0.x
    static const reg_addrs_t REG_ADDRS_V0;
    // Register addresses for version 1.x
    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.")]] virtual 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 double get_output_rate(const size_t chan) const = 0;

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

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

    virtual double set_input_rate(const double rate, const size_t chan) = 0;
};
 
}} // namespace uhd::rfnoc