USRP Hardware Driver and USRP Manual: siggen_block_control.hpp Source File

| USRP Hardware Driver and USRP Manual Version: 4.9.0.makepkg-0-g9ec1f582 UHD and USRP Manual |

Loading...
Searching...
No Matches
siggen_block_control.hpp
Go to the documentation of this file.
1//
2// Copyright 2020 Ettus Research, a National Instruments Brand
3//
4// SPDX-License-Identifier: GPL-3.0-or-later
5//
6
7#pragma once
8
9#include <uhd/config.hpp>
10#include <uhd/rfnoc/noc_block_base.hpp>
11#include <uhd/utils/math.hpp>
12#include <complex>
13
14namespace uhd { namespace rfnoc {
15
16 enum class siggen_waveform { CONSTANT, SINE_WAVE, NOISE };
17
28 class UHD_API siggen_block_control : public noc_block_base
29{
30public:
31 RFNOC_DECLARE_BLOCK(siggen_block_control);
32
33 static const uint32_t REG_BLOCK_SIZE;
34 static const uint32_t REG_ENABLE_OFFSET;
35 static const uint32_t REG_SPP_OFFSET;
36 static const uint32_t REG_WAVEFORM_OFFSET;
37 static const uint32_t REG_GAIN_OFFSET;
38 static const uint32_t REG_CONSTANT_OFFSET;
39 static const uint32_t REG_PHASE_INC_OFFSET;
40 static const uint32_t REG_CARTESIAN_OFFSET;
41
50 virtual void set_enable(const bool enable, const size_t port) = 0;
51
60 virtual bool get_enable(const size_t port) const = 0;
61
70 virtual void set_waveform(const siggen_waveform type, const size_t port) = 0;
71
79 virtual siggen_waveform get_waveform(const size_t port) const = 0;
80
99 virtual void set_amplitude(const double amplitude, const size_t port) = 0;
100
111 virtual double get_amplitude(const size_t port) const = 0;
112
126 virtual void set_constant(const std::complex<double> constant, const size_t port) = 0;
127
137 virtual std::complex<double> get_constant(const size_t port) const = 0;
138
148 virtual void set_sine_phase_increment(const double phase_inc, const size_t port) = 0;
149
159 virtual double get_sine_phase_increment(const size_t port) const = 0;
160
170 virtual void set_samples_per_packet(const size_t spp, const size_t port) = 0;
171
180 virtual size_t get_samples_per_packet(const size_t port) const = 0;
181
192 inline void set_sine_frequency(
193 const double frequency, const double sample_rate, const size_t port)
194 {
195 if (sample_rate <= 0.0) {
196 throw uhd::value_error("sample_rate must be > 0.0");
197 }
198 const double phase_inc = (frequency / sample_rate) * 2.0 * uhd::math::PI;
199 if (phase_inc < -uhd::math::PI || phase_inc > uhd::math::PI) {
200 throw uhd::value_error("frequency must be in [-samp_rate/2, samp_rate/2]");
201 }
202 set_sine_phase_increment(phase_inc, port);
203 }
204};
205
206}} // namespace uhd::rfnoc
uhd::rfnoc::noc_block_base::noc_block_base
noc_block_base(make_args_ptr make_args)
uhd::rfnoc::siggen_block_control
Definition siggen_block_control.hpp:29
uhd::rfnoc::siggen_block_control::set_enable
virtual void set_enable(const bool enable, const size_t port)=0
uhd::rfnoc::siggen_block_control::REG_BLOCK_SIZE
static const uint32_t REG_BLOCK_SIZE
Definition siggen_block_control.hpp:33
uhd::rfnoc::siggen_block_control::REG_PHASE_INC_OFFSET
static const uint32_t REG_PHASE_INC_OFFSET
Definition siggen_block_control.hpp:39
uhd::rfnoc::siggen_block_control::set_sine_frequency
void set_sine_frequency(const double frequency, const double sample_rate, const size_t port)
Definition siggen_block_control.hpp:192
uhd::rfnoc::siggen_block_control::get_samples_per_packet
virtual size_t get_samples_per_packet(const size_t port) const =0
uhd::rfnoc::siggen_block_control::get_constant
virtual std::complex< double > get_constant(const size_t port) const =0
uhd::rfnoc::siggen_block_control::set_amplitude
virtual void set_amplitude(const double amplitude, const size_t port)=0
uhd::rfnoc::siggen_block_control::REG_SPP_OFFSET
static const uint32_t REG_SPP_OFFSET
Definition siggen_block_control.hpp:35
uhd::rfnoc::siggen_block_control::get_sine_phase_increment
virtual double get_sine_phase_increment(const size_t port) const =0
uhd::rfnoc::siggen_block_control::REG_CARTESIAN_OFFSET
static const uint32_t REG_CARTESIAN_OFFSET
Definition siggen_block_control.hpp:40
uhd::rfnoc::siggen_block_control::REG_GAIN_OFFSET
static const uint32_t REG_GAIN_OFFSET
Definition siggen_block_control.hpp:37
uhd::rfnoc::siggen_block_control::REG_WAVEFORM_OFFSET
static const uint32_t REG_WAVEFORM_OFFSET
Definition siggen_block_control.hpp:36
uhd::rfnoc::siggen_block_control::get_amplitude
virtual double get_amplitude(const size_t port) const =0
uhd::rfnoc::siggen_block_control::get_waveform
virtual siggen_waveform get_waveform(const size_t port) const =0
uhd::rfnoc::siggen_block_control::set_constant
virtual void set_constant(const std::complex< double > constant, const size_t port)=0
uhd::rfnoc::siggen_block_control::get_enable
virtual bool get_enable(const size_t port) const =0
uhd::rfnoc::siggen_block_control::set_samples_per_packet
virtual void set_samples_per_packet(const size_t spp, const size_t port)=0
uhd::rfnoc::siggen_block_control::set_sine_phase_increment
virtual void set_sine_phase_increment(const double phase_inc, const size_t port)=0
uhd::rfnoc::siggen_block_control::REG_ENABLE_OFFSET
static const uint32_t REG_ENABLE_OFFSET
Definition siggen_block_control.hpp:34
uhd::rfnoc::siggen_block_control::RFNOC_DECLARE_BLOCK
RFNOC_DECLARE_BLOCK(siggen_block_control)
uhd::rfnoc::siggen_block_control::REG_CONSTANT_OFFSET
static const uint32_t REG_CONSTANT_OFFSET
Definition siggen_block_control.hpp:38
uhd::rfnoc::siggen_block_control::set_waveform
virtual void set_waveform(const siggen_waveform type, const size_t port)=0
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
math.hpp
uhd::rfnoc
Definition actions.hpp:24
uhd::rfnoc::siggen_waveform
siggen_waveform
Definition siggen_block_control.hpp:16
uhd::rfnoc::siggen_waveform::SINE_WAVE
@ SINE_WAVE
Definition siggen_block_control.hpp:16
uhd::rfnoc::siggen_waveform::NOISE
@ NOISE
Definition siggen_block_control.hpp:16
uhd::rfnoc::siggen_waveform::CONSTANT
@ CONSTANT
Definition siggen_block_control.hpp:16
uhd
Definition build_info.hpp:12
noc_block_base.hpp
uhd::value_error
Definition exception.hpp:108