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

namespace uhd { namespace rfnoc {

enum class fft_shift { NORMAL, REVERSE, NATURAL };
enum class fft_direction { REVERSE, FORWARD };
enum class fft_magnitude { COMPLEX, MAGNITUDE, MAGNITUDE_SQUARED };

// Custom property keys
static const std::string PROP_KEY_MAGNITUDE    = "magnitude";
static const std::string PROP_KEY_DIRECTION    = "direction";
static const std::string PROP_KEY_LENGTH       = "length";
static const std::string PROP_KEY_FFT_SCALING  = "fft_scaling";
static const std::string PROP_KEY_SHIFT_CONFIG = "shift_config";

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

    static const uint32_t REG_RESET_ADDR;
    static const uint32_t REG_LENGTH_LOG2_ADDR;
    static const uint32_t REG_MAGNITUDE_OUT_ADDR;
    static const uint32_t REG_DIRECTION_ADDR;
    static const uint32_t REG_SCALING_ADDR;
    static const uint32_t REG_SHIFT_CONFIG_ADDR;

    virtual void set_direction(const fft_direction direction) = 0;

    virtual fft_direction get_direction() const = 0;

    virtual void set_magnitude(const fft_magnitude magnitude) = 0;

    virtual fft_magnitude get_magnitude() const = 0;

    virtual void set_shift_config(const fft_shift shift) = 0;

    virtual fft_shift get_shift_config() const = 0;

    virtual void set_scaling(const uint16_t scaling) = 0;

    virtual uint16_t get_scaling() const = 0;

    virtual void set_length(const size_t length) = 0;

    virtual size_t get_length() const = 0;
};

}} // namespace uhd::rfnoc