Loading...
Searching...
No Matches
ref_clk_calibration_iface.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/features/discoverable_feature.hpp>
#include <cstdint>
#include <memory>
namespace uhd { namespace features {
class UHD_API ref_clk_calibration_iface : public discoverable_feature
{
public:
using sptr = std::shared_ptr<ref_clk_calibration_iface>;
static discoverable_feature::feature_id_t get_feature_id()
{
return discoverable_feature::REF_CLK_CALIBRATION;
}
std::string get_feature_name() const
{
return "Ref Clk Calibration";
}
virtual ~ref_clk_calibration_iface() = default;
virtual void set_ref_clk_tuning_word(uint32_t tuning_word) = 0;
virtual uint32_t get_ref_clk_tuning_word() = 0;
virtual void store_ref_clk_tuning_word(uint32_t tuning_word) = 0;
};
}} // namespace uhd::features
uhd::features::discoverable_feature
Definition discoverable_feature.hpp:26
uhd::features::discoverable_feature::feature_id_t
feature_id_t
An enum of all features supported by the driver. When creating a new.
Definition discoverable_feature.hpp:32
uhd::features::discoverable_feature::REF_CLK_CALIBRATION
@ REF_CLK_CALIBRATION
Definition discoverable_feature.hpp:37
uhd::features::ref_clk_calibration_iface
Definition ref_clk_calibration_iface.hpp:22
uhd::features::ref_clk_calibration_iface::store_ref_clk_tuning_word
virtual void store_ref_clk_tuning_word(uint32_t tuning_word)=0
Writes the reference clock tuning word to the clocking board EEPROM.
uhd::features::ref_clk_calibration_iface::~ref_clk_calibration_iface
virtual ~ref_clk_calibration_iface()=default
uhd::features::ref_clk_calibration_iface::get_feature_name
std::string get_feature_name() const
Returns a human-readable string name of this feature.
Definition ref_clk_calibration_iface.hpp:31
uhd::features::ref_clk_calibration_iface::get_feature_id
static discoverable_feature::feature_id_t get_feature_id()
Definition ref_clk_calibration_iface.hpp:26
uhd::features::ref_clk_calibration_iface::set_ref_clk_tuning_word
virtual void set_ref_clk_tuning_word(uint32_t tuning_word)=0
Set the tuning word to be configured on the internal reference clock DAC.
uhd::features::ref_clk_calibration_iface::get_ref_clk_tuning_word
virtual uint32_t get_ref_clk_tuning_word()=0
Returns the tuning word configured on the internal reference clock DAC.
uhd::features::ref_clk_calibration_iface::sptr
std::shared_ptr< ref_clk_calibration_iface > sptr
Definition ref_clk_calibration_iface.hpp:24
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
discoverable_feature.hpp
uhd::features
Definition adc_self_calibration_iface.hpp:16
uhd
Definition build_info.hpp:12