uhd/host/lib/include/uhdlib/usrp/common/x400_rfdc_control.hpp

118 lines
4.0 KiB
C++

//
// Copyright 2020 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#pragma once
#include <uhd/types/memmap_iface.hpp>
#include <uhd/types/time_spec.hpp>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
namespace uhd { namespace rfnoc { namespace x400 {
//! Control class for the RFDC components of a single daughterboard
//
// This class controls the NCOs and other RFDC settings. The corresponding FPGA
// module is rfdc_timing_control.sv.
class rfdc_control
{
public:
using sptr = std::shared_ptr<rfdc_control>;
//! Default SYSREF wait time for an NCO reset, in SYSREF cycles
static constexpr uint32_t DEFAULT_SYSREF_WAIT_CYCLES = 14;
struct regmap
{
//! Address of the NCO reset register
static constexpr uint32_t NCO_RESET = 0;
//! Bit position of reset-start bit (w)
static constexpr uint32_t NCO_RESET_START_MSB = 0;
//! Bit position of reset-done bit (r)
static constexpr uint32_t NCO_RESET_DONE_MSB = 1;
//! Bit position of nco-sync-failed bit (r)
static constexpr uint32_t NCO_SYNC_FAILED_MSB = 8;
//! Bit position of sysref wait time register(w)
static constexpr uint32_t SYSREF_WAIT_LSB = 16;
//! Bit position of sysref-wait-write-enable bit (w)
static constexpr uint32_t WRITE_SYSREF_WAIT = 24;
//! Address of the gearbox reset register
static constexpr uint32_t GEARBOX_RESET = 4;
//! Bit position of ADC gearbox reset
static constexpr uint32_t ADC_RESET_MSB = 0;
//! Bit position of DAC gearbox reset
static constexpr uint32_t DAC_RESET_MSB = 1;
};
//! Identify the NCOs/ADCs/DACs available to this radio control
enum class rfdc_type { RX0, RX1, RX2, RX3, TX0, TX1, TX2, TX3 };
rfdc_control(uhd::memmap32_iface_timed&& iface, const std::string& log_id);
//! Reset the listed NCOs
//
// All NCOs that are listed in \p ncos are reset synchronously.
//
// \param ncos A list of NCOs that shall be reset at the given time
// \param time The time at which the reset shall occur
void reset_ncos(const std::vector<rfdc_type>& ncos, const uhd::time_spec_t& time);
//! Reset the listed gearboxes
//
// All gearboxes that are listed in \p gearboxes are reset synchronously.
//
// \param gearboxes A list of gearboxes that shall be reset at the given time
// \param time The time at which the reset shall occur. Note: If \p time is
// set to ASAP, the resets will still occur synchronously, but
// at a non-deterministic time. This will suffice for synchronizing
// gearboxes on a single device.
void reset_gearboxes(
const std::vector<rfdc_type>& gearboxes, const uhd::time_spec_t& time);
//! Return true if the NCO is out of reset
bool get_nco_reset_done();
//! Set an NCO to a specific frequency
//
// \param nco Which NCO to re-tune
// \param freq the new frequency to tune it to (in Hz)
double set_nco_freq(const rfdc_type nco, const double freq);
private:
//! Peek/poke interface
memmap32_iface_timed _iface;
//! Prefix for log messages
const std::string _log_id;
};
constexpr std::initializer_list<rfdc_control::rfdc_type> RX_RFDC = {
rfdc_control::rfdc_type::RX0,
rfdc_control::rfdc_type::RX1,
rfdc_control::rfdc_type::RX2,
rfdc_control::rfdc_type::RX3};
constexpr std::initializer_list<rfdc_control::rfdc_type> TX_RFDC = {
rfdc_control::rfdc_type::TX0,
rfdc_control::rfdc_type::TX1,
rfdc_control::rfdc_type::TX2,
rfdc_control::rfdc_type::TX3};
template <typename T, typename F>
void indexed_for(const T& range, const size_t limit, F&& func)
{
std::size_t i = 0;
for (auto it = std::begin(range); it != std::end(range); ++it) {
if (i < limit) {
func(*it, i++);
} else {
break;
}
}
}
}}} // namespace uhd::rfnoc::x400