fosphor_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>

namespace uhd { namespace rfnoc {

enum class fosphor_waterfall_mode { MAX_HOLD, AVERAGE };
enum class fosphor_waterfall_predivision_ratio {
    RATIO_1_1,
    RATIO_1_8,
    RATIO_1_64,
    RATIO_1_256
};

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

    // Block registers
    static const uint32_t REG_ENABLE_ADDR;
    static const uint32_t REG_CLEAR_ADDR;
    static const uint32_t REG_RANDOM_ADDR;
    static const uint32_t REG_DECIM_ADDR;
    static const uint32_t REG_OFFSET_ADDR;
    static const uint32_t REG_SCALE_ADDR;
    static const uint32_t REG_TRISE_ADDR;
    static const uint32_t REG_TDECAY_ADDR;
    static const uint32_t REG_ALPHA_ADDR;
    static const uint32_t REG_EPSILON_ADDR;
    static const uint32_t REG_WF_CTRL_ADDR;
    static const uint32_t REG_WF_DECIM_ADDR;

    virtual void set_enable_histogram(const bool enable_histogram) = 0;

    virtual bool get_enable_histogram() const = 0;

    virtual void set_enable_waterfall(const bool enable_waterfall) = 0;

    virtual bool get_enable_waterfall() const = 0;

    virtual void clear_history() = 0;

    virtual void set_enable_dither(const bool enable_dither) = 0;

    virtual bool get_enable_dither() const = 0;

    virtual void set_enable_noise(const bool enable_noise) = 0;

    virtual bool get_enable_noise() const = 0;

    virtual void set_histogram_decimation(const uint16_t decimation) = 0;

    virtual uint16_t get_histogram_decimation() const = 0;

    virtual void set_histogram_offset(const uint16_t offset) = 0;

    virtual uint16_t get_histogram_offset() const = 0;

    virtual void set_histogram_scale(const uint16_t scale) = 0;

    virtual uint16_t get_histogram_scale() const = 0;

    virtual void set_histogram_rise_rate(const uint16_t rise_rate) = 0;

    virtual uint16_t get_histogram_rise_rate() const = 0;

    virtual void set_histogram_decay_rate(const uint16_t decay_rate) = 0;

    virtual uint16_t get_histogram_decay_rate() const = 0;

    virtual void set_spectrum_alpha(const uint16_t alpha) = 0;

    virtual uint16_t get_spectrum_alpha() const = 0;

    virtual void set_spectrum_max_hold_decay(const uint16_t epsilon) = 0;

    virtual uint16_t get_spectrum_max_hold_decay() const = 0;

    virtual void set_waterfall_predivision(
        const fosphor_waterfall_predivision_ratio waterfall_predivision) = 0;

    virtual fosphor_waterfall_predivision_ratio get_waterfall_predivision() const = 0;

    virtual void set_waterfall_mode(const fosphor_waterfall_mode waterfall_mode) = 0;

    virtual fosphor_waterfall_mode get_waterfall_mode() const = 0;

    virtual void set_waterfall_decimation(const uint16_t waterfall_decimation) = 0;

    virtual uint16_t get_waterfall_decimation() const = 0;
};

}} // namespace uhd::rfnoc