ptp_interface.h

// Copyright 2023-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// Generic API for network ports that support PTP
 
#pragma once
 
#include <satcat5/types.h>
 
namespace satcat5 {
    namespace ptp {
        enum class PacketType {NON_PTP, PTP_L2, PTP_L3};
 
        class Interface {
        public:
            inline void ptp_callback(satcat5::poll::OnDemand* obj)
                { m_ptp_callback = obj; }
 
            virtual satcat5::ptp::Time ptp_time_now() = 0;
 
            virtual satcat5::ptp::Time ptp_tx_start() = 0;
 
            virtual satcat5::io::Writeable* ptp_tx_write() = 0;
 
            virtual satcat5::ptp::Time ptp_tx_timestamp() = 0;
 
            virtual satcat5::io::Readable* ptp_rx_read() = 0;
 
            virtual satcat5::ptp::Time ptp_rx_timestamp() = 0;
 
            inline satcat5::ptp::PacketType ptp_rx_type() const
                { return m_ptp_rx_type; }
 
        protected:
            Interface()
                : m_ptp_callback(0)
                , m_ptp_rx_type(PacketType::NON_PTP) {}
 
            bool ptp_dispatch(const u8* peek, unsigned length);
 
            inline void ptp_notify_now()    {m_ptp_callback->poll_demand();}
 
            inline void ptp_notify_req()    {m_ptp_callback->request_poll();}
 
        private:
            satcat5::poll::OnDemand* m_ptp_callback;
            satcat5::ptp::PacketType m_ptp_rx_type;
        };
    }
}