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