sbgEComLogPtp.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_PTP_H
#define SBG_ECOM_LOG_PTP_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Enumeration definitions                                            -//
//----------------------------------------------------------------------//

typedef enum _SbgEComLogPtpState
{
    SBG_ECOM_LOG_PTP_STATE_DISABLED          = 0,                        
    SBG_ECOM_LOG_PTP_STATE_FAULTY          = 1,                        
    SBG_ECOM_LOG_PTP_STATE_MASTER          = 2,                        
    SBG_ECOM_LOG_PTP_STATE_PASSIVE            = 3,                        
} SbgEComLogPtpState;

typedef enum _SbgEComLogPtpTransport
{
    SBG_ECOM_LOG_PTP_TRANSPORT_UDP            = 0,                        
    SBG_ECOM_LOG_PTP_TRANSPORT_ETHERNET      = 1,                        
} SbgEComLogPtpTransport;

typedef enum _SbgEComLogPtpTimeScale
{
    SBG_ECOM_LOG_PTP_TIME_SCALE_TAI          = 0,                        
    SBG_ECOM_LOG_PTP_TIME_SCALE_UTC          = 1,                        
    SBG_ECOM_LOG_PTP_TIME_SCALE_GPS          = 2,                        
} SbgEComLogPtpTimeScale;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogPtp
{
    uint32_t                             timeStamp;                        
    uint16_t                             status;                      
 
    double                               timeScaleOffset;                
 
    uint64_t                             localClockIdentity;          
    uint8_t                              localClockPriority1;            
    uint8_t                              localClockPriority2;            
    uint8_t                              localClockClass;                
    uint8_t                              localClockAccuracy;          
    uint16_t                             localClockLog2Variance;      
    uint8_t                              localClockTimeSource;          
 
    uint64_t                             masterClockIdentity;            
    uint8_t                              masterClockPriority1;          
    uint8_t                              masterClockPriority2;          
    uint8_t                              masterClockClass;              
    uint8_t                              masterClockAccuracy;            
    uint16_t                             masterClockLog2Variance;        
    uint8_t                              masterClockTimeSource;            
    uint32_t                             masterIpAddress;                
 
    float                                meanPathDelay;                    
    float                                meanPathDelayStdDev;            
    double                               clockOffset;                    
    float                                clockOffsetStdDev;                
    float                                clockFreqOffset;                
    float                                clockFreqOffsetStdDev;            
 
    uint8_t                              masterMacAddress[6];           
} SbgEComLogPtp;
 
//----------------------------------------------------------------------//
//- Public functions                                                   -//
//----------------------------------------------------------------------//

void sbgEComLogPtpZeroInit(SbgEComLogPtp *pLogData);

SbgErrorCode sbgEComLogPtpReadFromStream(SbgEComLogPtp *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogPtpWriteToStream(const SbgEComLogPtp *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

void sbgEComLogPtpSetState(SbgEComLogPtp *pLogData, SbgEComLogPtpState state);

SbgEComLogPtpState sbgEComLogPtpGetState(const SbgEComLogPtp *pLogData);

void sbgEComLogPtpSetTransport(SbgEComLogPtp *pLogData, SbgEComLogPtpTransport transport);

SbgEComLogPtpTransport sbgEComLogPtpGetTransport(const SbgEComLogPtp *pLogData);

void sbgEComLogPtpSetTimeScale(SbgEComLogPtp *pLogData, SbgEComLogPtpTimeScale timeScale);

SbgEComLogPtpTimeScale sbgEComLogPtpGetTimeScale(const SbgEComLogPtp *pLogData);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_PTP_H