types.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_TYPES_H
#define __PTPMGMT_C_TYPES_H
 
#ifdef __PTPMGMT_HAVE_SYS_TYPES_H
#include <sys/types.h>
#else
typedef long ssize_t;
#endif /* __PTPMGMT_HAVE_SYS_TYPES_H */
#include "c/mngIds.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef INT48_MIN
static const int64_t INT48_MIN = -INT64_C(0x7fffffffffff) - 1;
#endif
#ifndef INT48_MAX
static const int64_t INT48_MAX = INT64_C(0x7fffffffffff);
#endif
#ifndef UINT48_MAX
static const uint64_t UINT48_MAX = UINT64_C(0xffffffffffff);
#endif
 
typedef uint8_t Nibble_t;
typedef uint8_t UInteger8_t;
typedef uint16_t UInteger16_t;
typedef uint32_t UInteger32_t;
typedef uint64_t UInteger48_t;
static const size_t ptpmgmt_sizeof_UInteger48_t = 6;
typedef uint64_t UInteger64_t;
typedef int8_t   Integer8_t;
typedef int16_t  Integer16_t;
typedef int32_t  Integer32_t;
typedef int64_t Integer48_t;
static const size_t ptpmgmt_sizeof_Integer48_t = 6;
typedef int64_t Integer64_t;
typedef uint8_t Octet_t;
typedef double Float64_t;
typedef long double float_seconds;
typedef long double float_nanoseconds;
 
enum ptpmgmt_MNG_PARSE_ERROR_e {
    PTPMGMT_MNG_PARSE_ERROR_OK,
    PTPMGMT_MNG_PARSE_ERROR_MSG,
    PTPMGMT_MNG_PARSE_ERROR_SIG,
    PTPMGMT_MNG_PARSE_ERROR_SMPTE,
    PTPMGMT_MNG_PARSE_ERROR_INVALID_ID,
    PTPMGMT_MNG_PARSE_ERROR_INVALID_TLV,
    PTPMGMT_MNG_PARSE_ERROR_MISMATCH_TLV,
    PTPMGMT_MNG_PARSE_ERROR_SIZE_MISS,
    PTPMGMT_MNG_PARSE_ERROR_TOO_SMALL,
    PTPMGMT_MNG_PARSE_ERROR_SIZE,
    PTPMGMT_MNG_PARSE_ERROR_VAL,
    PTPMGMT_MNG_PARSE_ERROR_HEADER,
    PTPMGMT_MNG_PARSE_ERROR_ACTION,
    PTPMGMT_MNG_PARSE_ERROR_UNSUPPORT,
    PTPMGMT_MNG_PARSE_ERROR_MEM,
    PTPMGMT_MNG_PARSE_ERROR_AUTH,
    PTPMGMT_MNG_PARSE_ERROR_AUTH_NONE,
    PTPMGMT_MNG_PARSE_ERROR_AUTH_WRONG,
    PTPMGMT_MNG_PARSE_ERROR_AUTH_NOKEY,
};
enum ptpmgmt_msgType_e {
    /* Event messages */
    ptpmgmt_Sync                    = 0,
    ptpmgmt_Delay_Req               = 1,
    ptpmgmt_Pdelay_Req              = 2,
    ptpmgmt_Pdelay_Resp             = 3,
    /* General messages */
    ptpmgmt_Follow_Up               = 0x8,
    ptpmgmt_Delay_Resp              = 0x9,
    ptpmgmt_Pdelay_Resp_Follow_Up   = 0xa,
    ptpmgmt_Announce                = 0xb,
    ptpmgmt_Signaling               = 0xc,
    ptpmgmt_Management              = 0xd,
};
enum ptpmgmt_tlvType_e {
    PTPMGMT_MANAGEMENT                              = 0x0001,
    PTPMGMT_MANAGEMENT_ERROR_STATUS                 = 0x0002,
    PTPMGMT_ORGANIZATION_EXTENSION                  = 0x0003,
    PTPMGMT_REQUEST_UNICAST_TRANSMISSION            = 0x0004,
    PTPMGMT_GRANT_UNICAST_TRANSMISSION              = 0x0005,
    PTPMGMT_CANCEL_UNICAST_TRANSMISSION             = 0x0006,
    PTPMGMT_ACKNOWLEDGE_CANCEL_UNICAST_TRANSMISSION = 0x0007,
    PTPMGMT_PATH_TRACE                              = 0x0008,
    PTPMGMT_ALTERNATE_TIME_OFFSET_INDICATOR         = 0x0009,
    /* Obsolete valuse 2000, 2001, 2002, 2003 */
    PTPMGMT_ORGANIZATION_EXTENSION_PROPAGATE        = 0x4000,
    PTPMGMT_ENHANCED_ACCURACY_METRICS               = 0x4001,
    PTPMGMT_ORGANIZATION_EXTENSION_DO_NOT_PROPAGATE = 0x8000,
    PTPMGMT_L1_SYNC                                 = 0x8001,
    PTPMGMT_PORT_COMMUNICATION_AVAILABILITY         = 0x8002,
    PTPMGMT_PROTOCOL_ADDRESS                        = 0x8003,
    PTPMGMT_SLAVE_RX_SYNC_TIMING_DATA               = 0x8004,
    PTPMGMT_SLAVE_RX_SYNC_COMPUTED_DATA             = 0x8005,
    PTPMGMT_SLAVE_TX_EVENT_TIMESTAMPS               = 0x8006,
    PTPMGMT_CUMULATIVE_RATE_RATIO                   = 0x8007,
    PTPMGMT_TLV_PAD                                 = 0x8008,
    PTPMGMT_AUTHENTICATION                          = 0x8009,
    PTPMGMT_SLAVE_DELAY_TIMING_DATA_NP              = 0x7f00,
};
enum ptpmgmt_actionField_e {
    PTPMGMT_GET = 0,            
    PTPMGMT_SET = 1,            
    PTPMGMT_RESPONSE = 2,       
    PTPMGMT_COMMAND = 3,        
    PTPMGMT_ACKNOWLEDGE = 4,    
};
enum ptpmgmt_managementErrorId_e {
    PTPMGMT_RESPONSE_TOO_BIG = 0x0001, 
    PTPMGMT_NO_SUCH_ID       = 0x0002, 
    PTPMGMT_WRONG_LENGTH     = 0x0003, 
    PTPMGMT_WRONG_VALUE      = 0x0004, 
    PTPMGMT_NOT_SETABLE      = 0x0005, 
    PTPMGMT_NOT_SUPPORTED    = 0x0006, 
    PTPMGMT_GENERAL_ERROR    = 0xfffe, 
};
enum ptpmgmt_clockType_e {
    ptpmgmt_ordinaryClock       = 0x8000, 
    ptpmgmt_boundaryClock       = 0x4000, 
    ptpmgmt_p2pTransparentClock = 0x2000, 
    ptpmgmt_e2eTransparentClock = 0x1000, 
    ptpmgmt_managementClock     = 0x0800, 
};
enum ptpmgmt_networkProtocol_e {
    ptpmgmt_UDP_IPv4   = 1, 
    ptpmgmt_UDP_IPv6   = 2, 
    ptpmgmt_IEEE_802_3 = 3, 
    ptpmgmt_DeviceNet  = 4, 
    ptpmgmt_ControlNet = 5, 
    ptpmgmt_PROFINET   = 6, 
};
enum ptpmgmt_clockAccuracy_e {
    ptpmgmt_Accurate_within_1ps   = 0x17, 
    ptpmgmt_Accurate_within_2_5ps = 0x18, 
    ptpmgmt_Accurate_within_10ps  = 0x19, 
    ptpmgmt_Accurate_within_25ps  = 0x1a, 
    ptpmgmt_Accurate_within_100ps = 0x1b, 
    ptpmgmt_Accurate_within_250ps = 0x1c, 
    ptpmgmt_Accurate_within_1ns   = 0x1d, 
    ptpmgmt_Accurate_within_2_5ns = 0x1e, 
    ptpmgmt_Accurate_within_10ns  = 0x1f, 
    ptpmgmt_Accurate_within_25ns  = 0x20, 
    ptpmgmt_Accurate_within_100ns = 0x21, 
    ptpmgmt_Accurate_within_250ns = 0x22, 
    ptpmgmt_Accurate_within_1us   = 0x23, 
    ptpmgmt_Accurate_within_2_5us = 0x24, 
    ptpmgmt_Accurate_within_10us  = 0x25, 
    ptpmgmt_Accurate_within_25us  = 0x26, 
    ptpmgmt_Accurate_within_100us = 0x27, 
    ptpmgmt_Accurate_within_250us = 0x28, 
    ptpmgmt_Accurate_within_1ms   = 0x29, 
    ptpmgmt_Accurate_within_2_5ms = 0x2a, 
    ptpmgmt_Accurate_within_10ms  = 0x2b, 
    ptpmgmt_Accurate_within_25ms  = 0x2c, 
    ptpmgmt_Accurate_within_100ms = 0x2d, 
    ptpmgmt_Accurate_within_250ms = 0x2e, 
    ptpmgmt_Accurate_within_1s    = 0x2f, 
    ptpmgmt_Accurate_within_10s   = 0x30, 
    ptpmgmt_Accurate_more_10s     = 0x31, 
    ptpmgmt_Accurate_Unknown      = 0xfe, 
};
enum ptpmgmt_faultRecord_e {
    ptpmgmt_F_Emergency     = 0x00, 
    ptpmgmt_F_Alert         = 0x01, 
    ptpmgmt_F_Critical      = 0x02, 
    ptpmgmt_F_Error         = 0x03, 
    ptpmgmt_F_Warning       = 0x04, 
    ptpmgmt_F_Notice        = 0x05, 
    ptpmgmt_F_Informational = 0x06, 
    ptpmgmt_F_Debug         = 0x07, 
};
enum ptpmgmt_timeSource_e {
    PTPMGMT_ATOMIC_CLOCK        = 0x10, 
    PTPMGMT_GNSS                = 0x20, 
    PTPMGMT_GPS                 = 0x20, 
    PTPMGMT_TERRESTRIAL_RADIO   = 0x30, 
    PTPMGMT_SERIAL_TIME_CODE    = 0x39, 
    PTPMGMT_PTP                 = 0x40, 
    PTPMGMT_NTP                 = 0x50, 
    PTPMGMT_HAND_SET            = 0x60, 
    PTPMGMT_OTHER               = 0x90, 
    PTPMGMT_INTERNAL_OSCILLATOR = 0xa0, 
};
enum ptpmgmt_portState_e {
    PTPMGMT_INITIALIZING         = 1, 
    PTPMGMT_FAULTY               = 2, 
    PTPMGMT_DISABLED             = 3, 
    PTPMGMT_LISTENING            = 4, 
    PTPMGMT_PRE_MASTER           = 5, 
    PTPMGMT_PRE_TIME_TRANSMITTER = 5, 
    PTPMGMT_MASTER               = 6, 
    PTPMGMT_TIME_TRANSMITTER     = 6, 
    PTPMGMT_PASSIVE              = 7, 
    PTPMGMT_UNCALIBRATED         = 8, 
    PTPMGMT_SLAVE                = 9, 
    PTPMGMT_TIME_RECEIVER        = 9, 
};
enum ptpmgmt_delayMechanism_e {
    PTPMGMT_AUTO          = 0,
    PTPMGMT_E2E           = 1,
    PTPMGMT_P2P           = 2,
    PTPMGMT_NO_MECHANISM  = 0xfe,
    PTPMGMT_COMMON_P2P    = 3,
    PTPMGMT_SPECIAL       = 4,
};
enum ptpmgmt_implementSpecific_e {
    ptpmgmt_noImplementSpecific, 
    ptpmgmt_linuxptp,            
};
enum ptpmgmt_SMPTEmasterLockingStatus_e {
    PTPMGMT_SMPTE_NOT_IN_USE   = 0, 
    PTPMGMT_SMPTE_FREE_RUN     = 1, 
    PTPMGMT_SMPTE_COLD_LOCKING = 2,
    PTPMGMT_SMPTE_WARM_LOCKING = 3,
    PTPMGMT_SMPTE_LOCKED       = 4, 
};
enum ptpmgmt_linuxptpTimeStamp_e {
    PTPMGMT_TS_SOFTWARE,
    PTPMGMT_TS_HARDWARE,
    PTPMGMT_TS_LEGACY_HW,
    PTPMGMT_TS_ONESTEP,
    PTPMGMT_TS_P2P1STEP,
};
enum ptpmgmt_linuxptpPowerProfileVersion_e {
    PTPMGMT_IEEE_C37_238_VERSION_NONE,
    PTPMGMT_IEEE_C37_238_VERSION_2011,
    PTPMGMT_IEEE_C37_238_VERSION_2017,
};
enum ptpmgmt_linuxptpUnicastState_e {
    PTPMGMT_UC_WAIT, 
    PTPMGMT_UC_HAVE_ANN, 
    PTPMGMT_UC_NEED_SYDY, 
    PTPMGMT_UC_HAVE_SYDY, 
};
enum {
    PTPMGMT_F_LI_61 = (1 << 0),
    PTPMGMT_F_LI_59 = (1 << 1),
    PTPMGMT_F_UTCV  = (1 << 2),
    PTPMGMT_F_PTP   = (1 << 3),
    PTPMGMT_F_TTRA  = (1 << 4),
    PTPMGMT_F_FTRA  = (1 << 5),
};
struct ptpmgmt_TimeInterval_t {
    Integer64_t scaledNanoseconds; 
};
struct ptpmgmt_Timestamp_t {
    UInteger48_t secondsField; 
    UInteger32_t nanosecondsField; 
};
struct ptpmgmt_ClockIdentity_t {
    Octet_t v[8]; 
};
struct ptpmgmt_PortIdentity_t {
    struct ptpmgmt_ClockIdentity_t clockIdentity; 
    UInteger16_t portNumber; 
};
struct ptpmgmt_PortAddress_t {
    enum ptpmgmt_networkProtocol_e networkProtocol; 
    UInteger16_t addressLength;
    uint8_t *addressField; 
};
struct ptpmgmt_ClockQuality_t {
    UInteger8_t clockClass; 
    enum ptpmgmt_clockAccuracy_e clockAccuracy; 
    uint16_t offsetScaledLogVariance; 
};
struct ptpmgmt_PTPText_t {
    uint8_t lengthField;
    const char *textField; 
};
struct ptpmgmt_FaultRecord_t {
    uint16_t faultRecordLength; 
    struct ptpmgmt_Timestamp_t faultTime; 
    enum ptpmgmt_faultRecord_e severityCode; 
    struct ptpmgmt_PTPText_t faultName; 
    struct ptpmgmt_PTPText_t faultValue; 
    struct ptpmgmt_PTPText_t faultDescription; 
};
struct ptpmgmt_AcceptableMaster_t {
    struct ptpmgmt_PortIdentity_t acceptablePortIdentity; 
    uint8_t alternatePriority1; 
};
 
enum ptpmgmt_MsgParams_RcvAuth_e {
    PTPMGMT_RCV_AUTH_NONE = 0, 
    PTPMGMT_RCV_AUTH_MNG = (1 << 0),
    PTPMGMT_RCV_AUTH_SIG_LAST = (1 << 1),
    PTPMGMT_RCV_AUTH_SIG_ALL = (1 << 2),
    PTPMGMT_RCV_AUTH_ALL = 0x7, 
    PTPMGMT_RCV_AUTH_IGNORE = (1 << 3),
};
 
typedef struct ptpmgmt_MsgParams *ptpmgmt_pMsgParams;
typedef const struct ptpmgmt_MsgParams *ptpmgmt_cpMsgParams;
 
ptpmgmt_pMsgParams ptpmgmt_MsgParams_alloc();
 
struct ptpmgmt_MsgParams {
    void *_this; 
    uint8_t transportSpecific; 
    uint8_t domainNumber; 
    uint8_t boundaryHops; 
    uint8_t minorVersion; 
    bool isUnicast; 
    enum ptpmgmt_implementSpecific_e implementSpecific;
    struct ptpmgmt_PortIdentity_t target; 
    struct ptpmgmt_PortIdentity_t self_id; 
    bool useZeroGet; 
    bool rcvSignaling; 
    bool filterSignaling; 
    bool rcvSMPTEOrg; 
    bool sendAuth;
    uint8_t rcvAuth;
    void (*allowSigTlv)(ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type);
    void (*removeSigTlv)(ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type);
    bool (*isSigTlv)(ptpmgmt_cpMsgParams m, enum ptpmgmt_tlvType_e type);
    size_t (*countSigTlvs)(ptpmgmt_cpMsgParams m);
    void (*free)(ptpmgmt_pMsgParams mp);
};
struct ptpmgmt_LinuxptpUnicastMaster_t {
    struct ptpmgmt_PortIdentity_t portIdentity; 
    struct ptpmgmt_ClockQuality_t clockQuality; 
    uint8_t selected; 
    enum ptpmgmt_linuxptpUnicastState_e portState;
    UInteger8_t priority1; 
    UInteger8_t priority2; 
    struct ptpmgmt_PortAddress_t portAddress; 
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PTPMGMT_C_TYPES_H */