keep_one_in_n_block_control.hpp

Go to the documentation of this file.

//
// Copyright 2020 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>

namespace uhd { namespace rfnoc {

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

    enum class mode { SAMPLE_MODE, PACKET_MODE };

    // Block registers
    static const uint32_t REG_N_OFFSET;
    static const uint32_t REG_MODE_OFFSET;
    static const uint32_t REG_WIDTH_N_OFFSET;

    virtual size_t get_max_n() const = 0;

    virtual size_t get_n(const size_t chan = 0) const = 0;

    virtual void set_n(const size_t n, const size_t chan = 0) = 0;

    virtual mode get_mode(const size_t chan = 0) const = 0;

    virtual void set_mode(const mode mode, const size_t chan = 0) = 0;
};

}} // namespace uhd::rfnoc