sbgEComBinaryLogUtc.h

Go to the documentation of this file.

#ifndef __SBG_ECOM_BINARY_LOG_UTC_H__
#define __SBG_ECOM_BINARY_LOG_UTC_H__

#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>

//----------------------------------------------------------------------//
//- Clock status definitions                                           -//
//----------------------------------------------------------------------//

#define SBG_ECOM_CLOCK_STATUS_SHIFT                     (1u)                                    
#define SBG_ECOM_CLOCK_STATUS_MASK                      (0x000Fu)                               
#define SBG_ECOM_CLOCK_UTC_STATUS_SHIFT         (6u)                                    
#define SBG_ECOM_CLOCK_UTC_STATUS_MASK          (0x000Fu)                               
#define SBG_ECOM_CLOCK_STABLE_INPUT                     (0x0001u << 0)                  
#define SBG_ECOM_CLOCK_UTC_SYNC                         (0x0001u << 5)                  
typedef enum _SbgEComClockStatus
{
        SBG_ECOM_CLOCK_ERROR                    = 0,                                                    
        SBG_ECOM_CLOCK_FREE_RUNNING             = 1,                                                    
        SBG_ECOM_CLOCK_STEERING                 = 2,                                                    
        SBG_ECOM_CLOCK_VALID                    = 3                                                             
} SbgEComClockStatus;

typedef enum _SbgEComClockUtcStatus
{
        SBG_ECOM_UTC_INVALID                    = 0,                                                    
        SBG_ECOM_UTC_NO_LEAP_SEC                = 1,                                                    
        SBG_ECOM_UTC_VALID                              = 2                                                             
} SbgEComClockUtcStatus;

//----------------------------------------------------------------------//
//- Clock status helpers methods                                       -//
//----------------------------------------------------------------------//

SBG_INLINE SbgEComClockStatus sbgEComLogUtcGetClockStatus(uint16_t status)
{
        return (SbgEComClockStatus)((status >> SBG_ECOM_CLOCK_STATUS_SHIFT) & SBG_ECOM_CLOCK_STATUS_MASK);
}

SBG_INLINE SbgEComClockUtcStatus sbgEComLogUtcGetClockUtcStatus(uint16_t status)
{
        return (SbgEComClockUtcStatus)((status >> SBG_ECOM_CLOCK_UTC_STATUS_SHIFT) & SBG_ECOM_CLOCK_UTC_STATUS_MASK);
}

SBG_INLINE uint16_t sbgEComLogUtcBuildClockStatus(SbgEComClockStatus clockStatus, SbgEComClockUtcStatus utcStatus, uint16_t masks)
{
        //
        // Create the combined status field
        //
        return  ((((uint16_t)clockStatus)&SBG_ECOM_CLOCK_STATUS_MASK) << SBG_ECOM_CLOCK_STATUS_SHIFT) |
                        ((((uint16_t)utcStatus)&SBG_ECOM_CLOCK_UTC_STATUS_MASK) << SBG_ECOM_CLOCK_UTC_STATUS_SHIFT) | masks;
}

//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgLogUtcData
{
        uint32_t        timeStamp;                                      
        uint16_t        status;                                         
        uint16_t        year;                                           
        int8_t  month;                                          
        int8_t  day;                                            
        int8_t  hour;                                           
        int8_t  minute;                                         
        int8_t  second;                                         
        int32_t nanoSecond;                                     
        uint32_t        gpsTimeOfWeek;                          
} SbgLogUtcData;

//----------------------------------------------------------------------//
//- Operations                                                         -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComBinaryLogParseUtcData(SbgStreamBuffer *pInputStream, SbgLogUtcData *pOutputData);

SbgErrorCode sbgEComBinaryLogWriteUtcData(SbgStreamBuffer *pOutputStream, const SbgLogUtcData *pInputData);

#endif