sbgEComBinaryLogStatus.h

Go to the documentation of this file.

#ifndef __SBG_ECOM_BINARY_LOG_STATUS_H__
#define __SBG_ECOM_BINARY_LOG_STATUS_H__

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

//----------------------------------------------------------------------//
//- General status definitions                                         -//
//----------------------------------------------------------------------//
#define SBG_ECOM_GENERAL_MAIN_POWER_OK          (0x0001u << 0)                  
#define SBG_ECOM_GENERAL_IMU_POWER_OK           (0x0001u << 1)                  
#define SBG_ECOM_GENERAL_GPS_POWER_OK           (0x0001u << 2)                  
#define SBG_ECOM_GENERAL_SETTINGS_OK            (0x0001u << 3)                  
#define SBG_ECOM_GENERAL_TEMPERATURE_OK         (0x0001u << 4)                  
#define SBG_ECOM_GENERAL_DATALOGGER_OK          (0x0001u << 5)                  
#define SBG_ECOM_GENERAL_CPU_OK                         (0x0001u << 6)                  
//----------------------------------------------------------------------//
//- Communication status definitions                                   -//
//----------------------------------------------------------------------//

#define SBG_ECOM_CAN_STATUS_SHIFT                       (28u)                                   
#define SBG_ECOM_CAN_STATUS_MASK                        (0x00000007u)                   
#define SBG_ECOM_PORTA_VALID                            (0x00000001u << 0)              
#define SBG_ECOM_PORTB_VALID                            (0x00000001u << 1)              
#define SBG_ECOM_PORTC_VALID                            (0x00000001u << 2)              
#define SBG_ECOM_PORTD_VALID                            (0x00000001u << 3)              
#define SBG_ECOM_PORTE_VALID                            (0x00000001u << 4)              
#define SBG_ECOM_PORTA_RX_OK                            (0x00000001u << 5)              
#define SBG_ECOM_PORTA_TX_OK                            (0x00000001u << 6)              
#define SBG_ECOM_PORTB_RX_OK                            (0x00000001u << 7)              
#define SBG_ECOM_PORTB_TX_OK                            (0x00000001u << 8)              
#define SBG_ECOM_PORTC_RX_OK                            (0x00000001u << 9)              
#define SBG_ECOM_PORTC_TX_OK                            (0x00000001u << 10)             
#define SBG_ECOM_PORTD_RX_OK                            (0x00000001u << 11)             
#define SBG_ECOM_PORTD_TX_OK                            (0x00000001u << 12)             
#define SBG_ECOM_PORTE_RX_OK                            (0x00000001u << 13)             
#define SBG_ECOM_PORTE_TX_OK                            (0x00000001u << 14)             
#define SBG_ECOM_ETH0_VALID                                     (0x00000001u << 15)             
#define SBG_ECOM_ETH1_VALID                                     (0x00000001u << 16)             
#define SBG_ECOM_ETH2_VALID                                     (0x00000001u << 17)             
#define SBG_ECOM_ETH3_VALID                                     (0x00000001u << 18)             
#define SBG_ECOM_ETH4_VALID                                     (0x00000001u << 19)             
#define SBG_ECOM_CAN_VALID                                      (0x00000001u << 25)             
#define SBG_ECOM_CAN_RX_OK                                      (0x00000001u << 26)             
#define SBG_ECOM_CAN_TX_OK                                      (0x00000001u << 27)             
typedef enum _SbgEComCanBusStatus
{
        SBG_ECOM_CAN_BUS_OFF            = 0,                                                            
        SBG_ECOM_CAN_BUS_TX_RX_ERR      = 1,                                                            
        SBG_ECOM_CAN_BUS_OK                     = 2,                                                            
        SBG_ECOM_CAN_BUS_ERROR          = 3                                                                     
} SbgEComCanBusStatus;

//----------------------------------------------------------------------//
//- Aiding status definitions                                          -//
//----------------------------------------------------------------------//
#define SBG_ECOM_AIDING_GPS1_POS_RECV           (0x00000001u << 0)              
#define SBG_ECOM_AIDING_GPS1_VEL_RECV           (0x00000001u << 1)              
#define SBG_ECOM_AIDING_GPS1_HDT_RECV           (0x00000001u << 2)              
#define SBG_ECOM_AIDING_GPS1_UTC_RECV           (0x00000001u << 3)              
#define SBG_ECOM_AIDING_GPS2_POS_RECV           (0x00000001u << 4)              
#define SBG_ECOM_AIDING_GPS2_VEL_RECV           (0x00000001u << 5)              
#define SBG_ECOM_AIDING_GPS2_HDT_RECV           (0x00000001u << 6)              
#define SBG_ECOM_AIDING_GPS2_UTC_RECV           (0x00000001u << 7)              
#define SBG_ECOM_AIDING_MAG_RECV                        (0x00000001u << 8)              
#define SBG_ECOM_AIDING_ODO_RECV                        (0x00000001u << 9)              
#define SBG_ECOM_AIDING_DVL_RECV                        (0x00000001u << 10)             
#define SBG_ECOM_AIDING_USBL_RECV                       (0x00000001u << 11)             
#define SBG_ECOM_AIDING_DEPTH_RECV                      (0x00000001u << 12)             
#define SBG_ECOM_AIDING_AIR_DATA_RECV           (0x00000001u << 13)             
#define SBG_ECOM_AIDING_USER_POS_RECV           (0x00000001u << 14)             
#define SBG_ECOM_AIDING_USER_VEL_RECV           (0x00000001u << 15)             
#define SBG_ECOM_AIDING_USER_HEADING_RECV       (0x00000001u << 16)             
//----------------------------------------------------------------------//
//- Status definitions                                                 -//
//----------------------------------------------------------------------//

typedef struct _SbgLogStatusData
{
        uint32_t        timeStamp;                                                                                              
        uint16_t        generalStatus;                                                                                  
        uint16_t        reserved1;                                                                                              
        uint32_t        comStatus;                                                                                              
        uint32_t        aidingStatus;                                                                                   
        uint32_t        reserved2;                                                                                              
        uint16_t        reserved3;                                                                                              
        uint32_t        uptime;                                                                                                 
} SbgLogStatusData;

//----------------------------------------------------------------------//
//- Communication status helpers methods                               -//
//----------------------------------------------------------------------//

SBG_INLINE SbgEComCanBusStatus sbgEComLogStatusGetCanStatus(uint32_t status)
{
        return (SbgEComCanBusStatus)((status >> SBG_ECOM_CAN_STATUS_SHIFT) & SBG_ECOM_CAN_STATUS_MASK);
}

SBG_INLINE uint32_t sbgEComLogStatusBuildCommunicationStatus(SbgEComCanBusStatus canStatus, uint32_t masks)
{
        //
        // Create the combined status field
        //
        return  ((((uint32_t)canStatus)&SBG_ECOM_CAN_STATUS_MASK) << SBG_ECOM_CAN_STATUS_SHIFT) | masks;
}

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

SbgErrorCode sbgEComBinaryLogParseStatusData(SbgStreamBuffer *pInputStream, SbgLogStatusData *pOutputData);

SbgErrorCode sbgEComBinaryLogWriteStatusData(SbgStreamBuffer *pOutputStream, const SbgLogStatusData *pInputData);

#endif