ptp_tlv.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/list.h>
#include <satcat5/types.h>
 
namespace satcat5 {
    namespace ptp {
        constexpr u16
            TLVTYPE_NONE        = 0x0000,
            TLVTYPE_MANAGEMENT  = 0x0001,
            TLVTYPE_ORG_EXT     = 0x0003,
            TLVTYPE_PATH_TRACE  = 0x0008,
            TLVTYPE_DOPPLER     = 0x20AE,   // Experimental / SatCat5 only
            TLVTYPE_ORG_EXT_P   = 0x4000,
            TLVTYPE_ORG_EXT_NP  = 0x8000,
            TLVTYPE_PAD         = 0x8008,
            TLVTYPE_AUTH        = 0x8009;
 
        struct TlvHeader {
            u16 type;       // (All) tlvType
            u16 length;     // (All) Length of dataField or valueField
            u32 org_id;     // (Org) organizationId (zero = disabled)
            u32 org_sub;    // (Org) organizationSubType (zero = disabled)
 
            // Explicitly declare default constructor and assignment methods.
            TlvHeader() = default;
            TlvHeader(const TlvHeader& t) = default;
            TlvHeader& operator=(const TlvHeader& t) = default;
 
            bool match(const satcat5::ptp::TlvHeader& other) const;
 
            bool propagate() const;
 
            inline constexpr unsigned len_header() const
                {return (org_id || org_sub) ? 10 : 4;}
            inline constexpr unsigned len_total() const
                {return len_header() + length;}
 
            void write_to(satcat5::io::Writeable* wr) const;
            bool read_from(satcat5::io::Readable* rd);
        };
 
        constexpr satcat5::ptp::TlvHeader TLV_HEADER_NONE = {0, 0, 0, 0};
 
        class TlvHandler {
        public:
            virtual bool tlv_rcvd(
                const satcat5::ptp::Header& hdr,    // Received message header
                const satcat5::ptp::TlvHeader& tlv, // Received TLV header
                satcat5::io::LimitedRead& rd);      // Received TLV data
 
            virtual unsigned tlv_send(
                const satcat5::ptp::Header& hdr,    // Received message header
                satcat5::io::Writeable* wr);
 
            virtual void tlv_meas(satcat5::ptp::Measurement& meas);
 
        protected:
            explicit TlvHandler(satcat5::ptp::Client* client);
            ~TlvHandler();
 
            satcat5::ptp::Client* const m_client;
 
        private:
            // Linked list pointer to the next registered TlvHandler.
            friend satcat5::util::ListCore;
            satcat5::ptp::TlvHandler* m_next;
        };
    }
}