mngTlvs.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later
   SPDX-FileCopyrightText: Copyright © 2021 Erez Geva <ErezGeva2@gmail.com> */
 
#ifndef __PTPMGMT_C_PROC_H
#define __PTPMGMT_C_PROC_H
 
#include <stdlib.h>
#include "c/types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ptpmgmt_CLOCK_DESCRIPTION_t  {
    uint16_t clockType; 
    struct ptpmgmt_PTPText_t physicalLayerProtocol; 
    UInteger16_t physicalAddressLength; 
    uint8_t *physicalAddress; 
    struct ptpmgmt_PortAddress_t protocolAddress; 
    Octet_t manufacturerIdentity[3]; 
    struct ptpmgmt_PTPText_t productDescription; 
    struct ptpmgmt_PTPText_t revisionData; 
    struct ptpmgmt_PTPText_t userDescription; 
    Octet_t profileIdentity[6]; 
};
struct ptpmgmt_USER_DESCRIPTION_t  {
    struct ptpmgmt_PTPText_t userDescription; 
};
static const uint16_t PTPMGMT_INITIALIZE_EVENT = 0x0000;
struct ptpmgmt_INITIALIZE_t  {
    uint16_t initializationKey; 
};
struct ptpmgmt_FAULT_LOG_t  {
    UInteger16_t numberOfFaultRecords; 
    struct ptpmgmt_FaultRecord_t *faultRecords; 
};
struct ptpmgmt_DEFAULT_DATA_SET_t  {
    uint8_t flags;
    UInteger16_t numberPorts; 
    UInteger8_t priority1; 
    struct ptpmgmt_ClockQuality_t clockQuality; 
    UInteger8_t priority2; 
    struct ptpmgmt_ClockIdentity_t clockIdentity; 
    UInteger8_t domainNumber; 
};
struct ptpmgmt_CURRENT_DATA_SET_t  {
    UInteger16_t stepsRemoved; 
    struct ptpmgmt_TimeInterval_t offsetFromMaster;
    struct ptpmgmt_TimeInterval_t meanPathDelay;
};
struct ptpmgmt_PARENT_DATA_SET_t  {
    struct ptpmgmt_PortIdentity_t parentPortIdentity; 
    uint8_t flags;
    UInteger16_t observedParentOffsetScaledLogVariance;
    Integer32_t observedParentClockPhaseChangeRate;
    UInteger8_t grandmasterPriority1; 
    struct ptpmgmt_ClockQuality_t grandmasterClockQuality;
    UInteger8_t grandmasterPriority2; 
    struct ptpmgmt_ClockIdentity_t grandmasterIdentity; 
};
struct ptpmgmt_TIME_PROPERTIES_DATA_SET_t  {
    Integer16_t currentUtcOffset; 
    uint8_t flags;
    enum ptpmgmt_timeSource_e timeSource; 
};
struct ptpmgmt_PORT_DATA_SET_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    enum ptpmgmt_portState_e portState; 
    Integer8_t logMinDelayReqInterval;
    struct ptpmgmt_TimeInterval_t peerMeanPathDelay; 
    Integer8_t logAnnounceInterval;
    UInteger8_t announceReceiptTimeout;
    Integer8_t logSyncInterval;
    enum ptpmgmt_delayMechanism_e delayMechanism;
    Integer8_t logMinPdelayReqInterval;
    Nibble_t versionNumber;
};
struct ptpmgmt_PRIORITY1_t  {
    UInteger8_t priority1; 
};
struct ptpmgmt_PRIORITY2_t  {
    UInteger8_t priority2; 
};
struct ptpmgmt_DOMAIN_t  {
    UInteger8_t domainNumber; 
};
struct ptpmgmt_SLAVE_ONLY_t  {
    uint8_t flags;
};
struct ptpmgmt_LOG_ANNOUNCE_INTERVAL_t  {
    Integer8_t logAnnounceInterval;
};
struct ptpmgmt_ANNOUNCE_RECEIPT_TIMEOUT_t  {
    UInteger8_t announceReceiptTimeout;
};
struct ptpmgmt_LOG_SYNC_INTERVAL_t  {
    Integer8_t logSyncInterval;
};
struct ptpmgmt_VERSION_NUMBER_t  {
    Nibble_t versionNumber;
};
struct ptpmgmt_TIME_t  {
    struct ptpmgmt_Timestamp_t currentTime; 
};
struct ptpmgmt_CLOCK_ACCURACY_t  {
    enum ptpmgmt_clockAccuracy_e clockAccuracy; 
};
struct ptpmgmt_UTC_PROPERTIES_t  {
    Integer16_t currentUtcOffset; 
    uint8_t flags;
};
struct ptpmgmt_TRACEABILITY_PROPERTIES_t  {
    uint8_t flags;
};
struct ptpmgmt_TIMESCALE_PROPERTIES_t  {
    uint8_t flags;
    enum ptpmgmt_timeSource_e timeSource; 
};
struct ptpmgmt_UNICAST_NEGOTIATION_ENABLE_t  {
    uint8_t flags;
};
struct ptpmgmt_PATH_TRACE_LIST_t  {
    struct ptpmgmt_ClockIdentity_t *pathSequence; 
    size_t actualTableSize; 
};
struct ptpmgmt_PATH_TRACE_ENABLE_t  {
    uint8_t flags;
};
struct ptpmgmt_GRANDMASTER_CLUSTER_TABLE_t  {
    Integer8_t logQueryInterval;
    UInteger8_t actualTableSize; 
    struct ptpmgmt_PortAddress_t *PortAddress;
};
struct ptpmgmt_UNICAST_MASTER_TABLE_t  {
    Integer8_t logQueryInterval;
    UInteger16_t actualTableSize; 
    struct ptpmgmt_PortAddress_t *PortAddress;
};
struct ptpmgmt_UNICAST_MASTER_MAX_TABLE_SIZE_t  {
    UInteger16_t maxTableSize;
};
struct ptpmgmt_ACCEPTABLE_MASTER_TABLE_t  {
    Integer16_t actualTableSize; 
    struct ptpmgmt_AcceptableMaster_t *list;
};
struct ptpmgmt_ACCEPTABLE_MASTER_TABLE_ENABLED_t  {
    uint8_t flags;
};
struct ptpmgmt_ACCEPTABLE_MASTER_MAX_TABLE_SIZE_t  {
    UInteger16_t maxTableSize;
};
struct ptpmgmt_ALTERNATE_MASTER_t  {
    uint8_t flags;
    Integer8_t logAlternateMulticastSyncInterval;
    UInteger8_t numberOfAlternateMasters;
};
struct ptpmgmt_ALTERNATE_TIME_OFFSET_ENABLE_t  {
    UInteger8_t keyField; 
    uint8_t flags;
};
struct ptpmgmt_ALTERNATE_TIME_OFFSET_NAME_t  {
    UInteger8_t keyField; 
    struct ptpmgmt_PTPText_t displayName;
};
struct ptpmgmt_ALTERNATE_TIME_OFFSET_MAX_KEY_t  {
    UInteger8_t maxKey; 
};
struct ptpmgmt_ALTERNATE_TIME_OFFSET_PROPERTIES_t  {
    UInteger8_t keyField; 
    Integer32_t currentOffset; 
    Integer32_t jumpSeconds; 
    UInteger48_t timeOfNextJump; 
};
struct ptpmgmt_TRANSPARENT_CLOCK_PORT_DATA_SET_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    uint8_t flags;
    Integer8_t logMinPdelayReqInterval;
    struct ptpmgmt_TimeInterval_t peerMeanPathDelay; 
};
struct ptpmgmt_LOG_MIN_PDELAY_REQ_INTERVAL_t  {
    Integer8_t logMinPdelayReqInterval;
};
struct ptpmgmt_TRANSPARENT_CLOCK_DEFAULT_DATA_SET_t  {
    struct ptpmgmt_ClockIdentity_t clockIdentity; 
    UInteger16_t numberPorts; 
    enum ptpmgmt_delayMechanism_e delayMechanism;
    UInteger8_t primaryDomain; 
};
struct ptpmgmt_PRIMARY_DOMAIN_t  {
    UInteger8_t primaryDomain; 
};
struct ptpmgmt_DELAY_MECHANISM_t  {
    enum ptpmgmt_delayMechanism_e delayMechanism;
};
struct ptpmgmt_EXTERNAL_PORT_CONFIGURATION_ENABLED_t  {
    uint8_t flags;
};
struct ptpmgmt_MASTER_ONLY_t  {
    uint8_t flags;
};
struct ptpmgmt_HOLDOVER_UPGRADE_ENABLE_t  {
    uint8_t flags;
};
struct ptpmgmt_EXT_PORT_CONFIG_PORT_DATA_SET_t  {
    uint8_t flags;
    enum ptpmgmt_portState_e desiredState; 
};
static const float_nanoseconds PTPMGMT_P41 = 1ULL << 41;
struct ptpmgmt_TIME_STATUS_NP_t  {
    int64_t master_offset; 
    int64_t ingress_time;  
    Integer32_t cumulativeScaledRateOffset;
    Integer32_t scaledLastGmPhaseChange;
    UInteger16_t gmTimeBaseIndicator;
    uint16_t nanoseconds_msb;
    uint64_t nanoseconds_lsb;
    uint16_t fractional_nanoseconds;
    Integer32_t gmPresent; 
    struct ptpmgmt_ClockIdentity_t gmIdentity; 
};
struct ptpmgmt_GRANDMASTER_SETTINGS_NP_t  {
    struct ptpmgmt_ClockQuality_t clockQuality; 
    Integer16_t currentUtcOffset; 
    uint8_t flags;
    enum ptpmgmt_timeSource_e timeSource; 
};
struct ptpmgmt_PORT_DATA_SET_NP_t  {
    UInteger32_t neighborPropDelayThresh;
    Integer32_t asCapable; 
};
#define LIBPTPMGMT_EVENT_BITMASK_CNT (64)
static const int PTPMGMT_NOTIFY_PORT_STATE = 0;
static const int PTPMGMT_NOTIFY_TIME_SYNC = 1;
static const int PTPMGMT_NOTIFY_PARENT_DATA_SET = 2;
static const int PTPMGMT_NOTIFY_CMLDS = 3;
struct ptpmgmt_SUBSCRIBE_EVENTS_NP_t  {
    uint16_t duration; 
    uint8_t bitmask[LIBPTPMGMT_EVENT_BITMASK_CNT]; 
};
void ptpmgmt_setEvent_lnp(struct ptpmgmt_SUBSCRIBE_EVENTS_NP_t *tlv, int event);
void ptpmgmt_clearEvent_lnp(struct ptpmgmt_SUBSCRIBE_EVENTS_NP_t *tlv,
    int event);
void ptpmgmt_clearAll_lnp(struct ptpmgmt_SUBSCRIBE_EVENTS_NP_t *tlv);
bool ptpmgmt_getEvent_lnp(const struct ptpmgmt_SUBSCRIBE_EVENTS_NP_t *tlv,
    int event);
struct ptpmgmt_PORT_PROPERTIES_NP_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    enum ptpmgmt_portState_e portState; 
    enum ptpmgmt_linuxptpTimeStamp_e timestamping;
    struct ptpmgmt_PTPText_t interface; 
};
#define LIBPTPMGMT_MAX_MESSAGE_TYPES (16)
static const int PTPMGMT_STAT_SYNC = 0;
static const int PTPMGMT_STAT_DELAY_REQ = 1;
static const int PTPMGMT_STAT_PDELAY_REQ = 2;
static const int PTPMGMT_STAT_PDELAY_RESP = 3;
static const int PTPMGMT_STAT_FOLLOW_UP = 8;
static const int PTPMGMT_STAT_DELAY_RESP = 9;
static const int PTPMGMT_STAT_PDELAY_RESP_FOLLOW_UP = 10;
static const int PTPMGMT_STAT_ANNOUNCE = 11;
static const int PTPMGMT_STAT_SIGNALING = 12;
static const int PTPMGMT_STAT_MANAGEMENT = 13;
struct ptpmgmt_PORT_STATS_NP_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    uint64_t rxMsgType[LIBPTPMGMT_MAX_MESSAGE_TYPES];
    uint64_t txMsgType[LIBPTPMGMT_MAX_MESSAGE_TYPES];
};
static const uint8_t PTPMGMT_SYNC_UNCERTAIN_FALSE = 0;
static const uint8_t PTPMGMT_SYNC_UNCERTAIN_TRUE = 1;
static const uint8_t PTPMGMT_SYNC_UNCERTAIN_DONTCARE = 0xff;
struct ptpmgmt_SYNCHRONIZATION_UNCERTAIN_NP_t  {
    uint8_t val;
};
struct ptpmgmt_PORT_SERVICE_STATS_NP_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    uint64_t announce_timeout; 
    uint64_t sync_timeout; 
    uint64_t delay_timeout; 
    uint64_t unicast_service_timeout;
    uint64_t unicast_request_timeout;
    uint64_t master_announce_timeout;
    uint64_t master_sync_timeout; 
    uint64_t qualification_timeout; 
    uint64_t sync_mismatch; 
    uint64_t followup_mismatch; 
};
struct ptpmgmt_UNICAST_MASTER_TABLE_NP_t  {
    Integer16_t actualTableSize; 
    struct ptpmgmt_LinuxptpUnicastMaster_t *unicastMasters;
};
struct ptpmgmt_PORT_HWCLOCK_NP_t  {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    Integer32_t phc_index; 
    UInteger8_t flags; 
};
struct ptpmgmt_POWER_PROFILE_SETTINGS_NP_t  {
    enum ptpmgmt_linuxptpPowerProfileVersion_e version;
    UInteger16_t grandmasterID; 
    UInteger32_t grandmasterTimeInaccuracy; 
    UInteger32_t networkTimeInaccuracy; 
    UInteger32_t totalTimeInaccuracy; 
};
struct ptpmgmt_CMLDS_INFO_NP_t  {
    struct ptpmgmt_TimeInterval_t meanLinkDelay; 
    Integer32_t scaledNeighborRateRatio;
    uint32_t as_capable; 
};
struct ptpmgmt_PORT_CORRECTIONS_NP_t  {
    Integer64_t egressLatency; 
    Integer64_t ingressLatency; 
    Integer64_t delayAsymmetry; 
};
struct ptpmgmt_EXTERNAL_GRANDMASTER_PROPERTIES_NP_t  {
    struct ptpmgmt_ClockIdentity_t gmIdentity; 
    UInteger16_t stepsRemoved; 
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PTPMGMT_C_PROC_H */