ptp_types.h

Go to the documentation of this file.

 
#ifndef FLEXPTP_PTP_TYPES_H_
#define FLEXPTP_PTP_TYPES_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "FreeRTOS.h"
#include "event.h"
#include "ptp_defs.h"
#include "timers.h"
#include "timeutils.h"
 
#include "ptp_sync_cycle_data.h"
 
#include <flexptp_options.h>
 
typedef enum PTPMessageType {
    PTP_MT_Sync = 0,                   
    PTP_MT_Delay_Req = 1,              
    PTP_MT_PDelay_Req = 2,             
    PTP_MT_PDelay_Resp = 3,            
    PTP_MT_Follow_Up = 8,              
    PTP_MT_Delay_Resp = 9,             
    PTP_MT_PDelay_Resp_Follow_Up = 10, 
    PTP_MT_Announce = 11               
} PtpMessageType;
 
typedef enum PTPControl {
    PTP_CON_Sync = 0,       
    PTP_CON_Delay_Req = 1,  
    PTP_CON_Follow_Up = 2,  
    PTP_CON_Delay_Resp = 3, 
    PTP_CON_Other = 5       
} PtpControl;
 
typedef struct {
    bool PTP_SECURITY;          
    bool PTP_ProfileSpecific_2; 
    bool PTP_ProfileSpecific_1; 
    bool PTP_UNICAST;           
    bool PTP_TWO_STEP;          
    bool PTP_ALTERNATE_MASTER;  
    bool FREQUENCY_TRACEABLE;   
    bool TIME_TRACEABLE;        
    bool PTP_TIMESCALE;         
    bool PTP_UTC_REASONABLE;    
    bool PTP_LI_59;             
    bool PTP_LI_61;             
} PtpFlags;
 
typedef struct
{
    // 0.
    uint8_t messageType;       
    uint8_t transportSpecific; 
 
    // 1.
    uint8_t versionPTP; 
    uint8_t minorVersionPTP;
 
    // 2-3.
    uint16_t messageLength; 
 
    // 4.
    uint8_t domainNumber; 
 
    // 5.
    uint8_t _r2;
 
    // 6-7.
    PtpFlags flags; 
 
    // 8-15.
    uint64_t correction_ns;    
    uint32_t correction_subns; 
 
    // 16-19.
    uint32_t _r3;
 
    // 20-27.
    uint64_t clockIdentity; 
 
    // 28-29
    uint16_t sourcePortID; 
 
    // 30-31.
    uint16_t sequenceID; 
 
    // 32.
    uint8_t control; 
 
    // 33.
    int8_t logMessagePeriod; // Logarithmic Message Period
} PtpHeader;
 
typedef struct {
    uint64_t requestingSourceClockIdentity; 
    uint16_t requestingSourcePortIdentity;  
} PtpDelay_RespIdentification;
 
typedef enum {
    PTP_TP_IPv4 = 0, 
    PTP_TP_802_3 = 1 
} PtpTransportType;
 
typedef enum {
    PTP_DM_E2E = 0, 
    PTP_DM_P2P = 1  
} PtpDelayMechanism;
 
typedef enum {
    PTP_TSPEC_UNKNOWN_DEF = 0, 
    PTP_TSPEC_GPTP_8021AS = 1, 
} PtpTransportSpecific;
 
typedef enum {
    PTP_MC_EVENT = 0,  
    PTP_MC_GENERAL = 1 
} PtpMessageClass;
 
#define MAX_PTP_MSG_SIZE (128) 
 
typedef struct RawPtpMessage_ {
    TimestampI ts; 
    uint32_t size; 
 
    // --- transmit related ---
    TimestampI *pTs;                                  
    void (*pTxCb)(const struct RawPtpMessage_ *pMsg); 
    PtpDelayMechanism tx_dm;                          
    PtpMessageClass tx_mc;                            
 
    // --- data ---
    uint8_t data[MAX_PTP_MSG_SIZE]; 
} RawPtpMessage;
 
typedef enum {
    PTP_CC_PRIMARY_REFERENCE = 6,               
    PTP_CC_PRIMARY_REFERENCE_HOLDOVER = 7,      
    PTP_CC_APPLICATION_SPECIFIC = 13,           
    PTP_CC_APPLICAION_SPECIFIC_HOLDOVER = 14,   
    PTP_CC_PRIMARY_REFERENCE_DEGRAD_A = 52,     
    PTP_CC_APPLICATION_SPECIFIC_DEGRAD_A = 58,  
    PTP_CC_PRIMARY_REFERENCE_DEGRAD_B = 187,    
    PTP_CC_APPLICATION_SPECIFIC_DEGRAD_B = 193, 
    PTP_CC_DEFAULT = 248,                       
    PTP_CC_SLAVE_ONLY = 255                     
} PtpClockClass;
 
typedef enum {
    PTP_CA_25NS = 0x20,    
    PTP_CA_100NS,          
    PTP_CA_250NS,          
    PTP_CA_1US,            
    PTP_CA_2_5US,          
    PTP_CA_10US,           
    PTP_CA_25US,           
    PTP_CA_100US,          
    PTP_CA_250US,          
    PTP_CA_1MS,            
    PTP_CA_2_5MS,          
    PTP_CA_10MS,           
    PTP_CA_25MS,           
    PTP_CA_100MS,          
    PTP_CA_250MS,          
    PTP_CA_1S,             
    PTP_CA_10S,            
    PTP_CA_GT10S,          
    PTP_CA_UNKNOWN = 0xFE, 
} PtpClockAccuracy;
 
typedef enum {
    PTP_TSRC_ATOMIC_CLOCK = 0x10,       
    PTP_TSRC_GPS = 0x20,                
    PTP_TSRC_TERRESTRIAL_RADIO = 0x30,  
    PTP_TSRC_PTP = 0x40,                
    PTP_TSRC_NTP = 0x50,                
    PTP_TSRC_HAND_SET = 0x60,           
    PTP_TSRC_OTHER = 0x90,              
    PTP_TSRC_INTERNAL_OSCILLATOR = 0xA0 
} PtpTimeSource;
 
#define PTP_VARIANCE_HAS_NOT_BEEN_COMPUTED (0xFFFF)
 
typedef struct {
    uint16_t currentUTCOffset;         
    uint8_t priority1;                 
    uint8_t grandmasterClockClass;     
    uint8_t grandmasterClockAccuracy;  
    uint16_t grandmasterClockVariance; 
    uint8_t priority2;                 
    uint64_t grandmasterClockIdentity; 
    uint16_t localStepsRemoved;        
    uint8_t timeSource;                
} PtpAnnounceBody;
 
typedef PtpAnnounceBody PtpMasterProperties;
 
typedef enum PtpM2SState {
    SIdle,        
    SWaitFollowUp 
} PtpM2SState;
 
typedef enum {
    BMCA_NO_MASTER = 0, 
    BMCA_MASTER_REMOTE, 
    BMCA_MASTER_ME,     
} BmcaMasterState;
 
typedef enum {
    BMCA_NO_CANDIDATE = 0,    
    BMCA_CANDIDATE_COLLECTION 
} BmcaCandidateState;
 
typedef enum {
    PTP_LOGPER_MIN = -3,         
    PTP_LOGPER_MAX = 4,          
    PTP_LOGPER_SYNCMATCHED = 127 
} PtpLogMsgPeriods;
 
typedef enum {
    PTP_BMCA_INITIALIZING = 0x00,
    PTP_BMCA_LISTENING,
    PTP_BMCA_PRE_MASTER,
    PTP_BMCA_MASTER,
    PTP_BMCA_SLAVE,
    PTP_BMCA_PASSIVE,
    PTP_BMCA_UNCALIBRATED,
    PTP_BMCA_FAULTY,
    PTP_BMCA_DISABLED
} PtpBmcaFsmState;
 
typedef struct {
    PtpBmcaFsmState state;           
    PtpMasterProperties masterProps; 
    uint16_t masterAnnPer_ms;        
    uint16_t masterTOCntr;           
    uint32_t stateDuration;          
    bool preventMasterSwitchOver;    
} PtpBmcaState;
 
typedef struct _PtpProfileAdditionalData {
    const void *data;                       
    uint16_t size;                          
    PtpMessageType msgType;                 
    struct _PtpProfileAdditionalData *next; 
} PtpProfileTlvElement;
 
typedef enum {
    PTP_PF_NONE = 0x00,                                       
    PTP_PF_ISSUE_SYNC_FOR_COMPLIANT_SLAVE_ONLY_IN_P2P = 0x01, 
    PTP_PF_SLAVE_ONLY = 0x02,                                 
    PTP_PF_N                                                  
} PtpProfileFlags;
 
typedef struct {
    PtpTransportType transportType;                  
    PtpTransportSpecific transportSpecific;          
    PtpDelayMechanism delayMechanism;                
    int8_t logDelayReqPeriod;                        
    int8_t logSyncPeriod;                            
    int8_t logAnnouncePeriod;                        
    uint8_t domainNumber;                            
    uint8_t flags;                                   
    char tlvSet[PTP_MAX_TLV_PRESET_NAME_LENGTH + 1]; 
} PtpProfile;
 
typedef enum {
    /* Standard TLVs */
    PTP_TLV_MANAGEMENT = 0x01,       
    PTP_TLV_MANAGEMENT_ERROR_STATUS, 
    PTP_TLV_ORGANIZATION_EXTENSION,  
 
    /* Optional unicast message negotitation TLVs */
    PTP_TLV_REQUEST_UNICAST_TRANSMISSION = 0x04,
    PTP_TLV_GRANT_UNICAST_TRANSMISSION,
    PTP_TLV_CANCEL_UNICAST_TRANSMISSION,
    PTP_TLV_ACKNOWLEDGE_CANCEL_UNICAST_TRANSMISSION,
 
    /* Optional path trace mechanism TLV */
    PTP_TLV_PATH_TRACE = 0x08,
 
    /* Optional alternate timescale TLV */
    PTP_TLV_ALTERNATE_TIME_OFFSET_INDICATOR = 0x09,
 
    /* Security TLVs */
    PTP_TLV_AUTHENTICATION = 0x2000,
    PTP_TLV_AUTHENTICATION_CHALLENGE = 0x2001,
    PTP_TLV_SECURITY_ASSOCIATION_UPDATE = 0x2002,
 
    /* Cumulative frequency scale factor offset */
    PTP_TLV_CUM_FREQ_SCALE_FACTOR_OFFSET = 0x2003
} PtpTlvType;
 
#define PTP_TLV_HEADER                       \
    uint16_t type;    \
    uint16_t length; 
typedef struct {
    PTP_TLV_HEADER
} PtpTlvHeader;
 
typedef struct {
    uint16_t sequenceID, delay_reqSequenceID; 
    uint16_t lastRespondedDelReqId;           
    PtpM2SState m2sState;                     
    int8_t logSyncPeriod;                     
    uint16_t syncPeriodMs;                    
} PtpSlaveMessagingState;
 
typedef struct {
    uint16_t syncSequenceID;     
    uint16_t announceSequenceID; 
} PtpMasterMessagingState;
 
typedef enum {
    PTP_P2PSS_NONE = 0,   
    PTP_P2PSS_CANDIDATE,  
    PTP_P2PSS_ESTABLISHED 
} PtpP2PSlaveState;
 
typedef struct {
    PtpP2PSlaveState state; 
    uint64_t identity;      
    uint16_t reportCount;   
    uint16_t dropoutCntr;   
} PtpP2PSlaveInfo;
 
typedef struct {
    uint32_t addend; 
} PtpHWClockState;
 
typedef struct {
    TimestampI meanPathDelay; 
} PtpNetworkState;
 
typedef struct {
    double filtTimeErr; 
    bool locked;        
} PtpStats;
 
typedef void (*PtpSyncCallback)(int64_t time_error, const PtpSyncCycleData *pSCD, uint32_t freqCodeWord);
 
typedef void (*PtpUserEventCallback)(PtpUserEventCode uev);
 
typedef struct {
    PtpProfile profile;               
    PtpMasterProperties capabilities; 
 
    PtpHWClockState hwclock; 
 
    struct {
        TimestampI offset;      
        uint64_t clockIdentity; 
    } hwoptions;                
 
    PtpBmcaState bmca;       
    PtpNetworkState network; 
 
    // Logging
    struct {
        bool def;        
        bool corr;       
        bool timestamps; 
        bool info;       
        bool locked;     
        bool bmca;       
    } logging;           
 
    PtpStats stats;                   
    PtpUserEventCallback userEventCb; 
 
    struct {
        TimerHandle_t heartbeat; 
    } timers;                    
 
    /* ---- SLAVE ----- */
 
    struct {
        bool enabled; 
 
        PtpSlaveMessagingState messaging; 
        PtpSyncCycleData scd;             
        TimestampI prevSyncMa;            
        uint64_t coarseLimit;             
 
        uint32_t delReqTickPeriod; 
        uint32_t delReqTmr;        
 
        PtpSyncCallback syncCb; 
    } slave;
 
    /* ---- MASTER ----- */
 
    struct {
        bool enabled; 
 
        PtpP2PSlaveInfo p2pSlave;      
        uint32_t pdelay_reqSequenceID; 
        PtpSyncCycleData scd;          
 
        PtpMasterMessagingState messaging; 
 
        uint32_t syncTickPeriod;      
        uint32_t syncTmr;             
        uint32_t announceTickPeriod;  
        uint32_t announceTmr;         
        uint32_t pdelayReqTickPeriod; 
        uint32_t pdelayReqTmr;        
    } master;
} PtpCoreState;
 
#endif /* FLEXPTP_PTP_TYPES_H_ */