cfgbus_ptpref.h

Go to the documentation of this file.

// Copyright 2022-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/ptp_filters.h>
#include <satcat5/ptp_tracking.h>
 
namespace satcat5 {
    namespace cfg {
        class PtpReference : public satcat5::ptp::TrackingClock {
        public:
            constexpr PtpReference(
                const satcat5::cfg::Register& reg,
                double ref_clk_hz, unsigned scale=40)
                : m_reg(reg), m_rate(ref_clk_hz, scale) {}
 
            // Implement rate-control only for the TrackingClock API.
            satcat5::ptp::Time clock_adjust(
                const satcat5::ptp::Time& amount) override;
            void clock_rate(s64 offset) override;
            satcat5::ptp::Time clock_now() override;
 
            void clock_rate_raw(s64 rate);
 
        protected:
            satcat5::cfg::Register m_reg;   // Control register
            const satcat5::ptp::RateConversion m_rate;
        };
 
        class PtpRealtime : public satcat5::ptp::TrackingClock {
        public:
            constexpr PtpRealtime(
                const satcat5::cfg::Register& reg,
                double ref_clk_hz, unsigned scale=40)
                : m_reg(reg), m_rate(ref_clk_hz, scale) {}
 
            // Implement the full TrackingClock API.
            satcat5::ptp::Time clock_adjust(
                const satcat5::ptp::Time& amount) override;
            void clock_rate(s64 offset) override;
            satcat5::ptp::Time clock_now() override;
 
            void clock_rate_raw(s64 rate);
 
            satcat5::ptp::Time clock_ext();
 
            void clock_set(const satcat5::ptp::Time& new_time);
 
        protected:
            void load(const satcat5::ptp::Time& time);
            satcat5::cfg::Register m_reg;   // Base control register
            const satcat5::ptp::RateConversion m_rate;
        };
    }
}