sbgEComProtocol.h

Go to the documentation of this file.

#ifndef __SBG_ECOM_PROTOCOL_H__
#define __SBG_ECOM_PROTOCOL_H__

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

//----------------------------------------------------------------------//
//- Global definitions                                                 -//
//----------------------------------------------------------------------//
#define SBG_ECOM_MAX_BUFFER_SIZE                                (4096)                                                  
#define SBG_ECOM_MAX_PAYLOAD_SIZE                               (4086)                                                  
#define SBG_ECOM_SYNC_1                                                 (0xFF)                                                  
#define SBG_ECOM_SYNC_2                                                 (0x5A)                                                  
#define SBG_ECOM_ETX                                                    (0x33)                                                  
#define SBG_ECOM_RX_TIME_OUT                                    (450)                                                   
//----------------------------------------------------------------------//
//- Communication protocol structs and definitions                     -//
//----------------------------------------------------------------------//

typedef struct _SbgEComProtocol
{
        SbgInterface            *pLinkedInterface;                                                      
        uint8                            rxBuffer[SBG_ECOM_MAX_BUFFER_SIZE];            
        size_t                           rxBufferSize;                                                          
} SbgEComProtocol;

//----------------------------------------------------------------------//
//- Communication protocol operations                                  -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComProtocolInit(SbgEComProtocol *pHandle, SbgInterface *pInterface);

SbgErrorCode sbgEComProtocolClose(SbgEComProtocol *pHandle);

SbgErrorCode sbgEComProtocolSend(SbgEComProtocol *pHandle, uint8 msgClass, uint8 msg, const void *pData, size_t size);

SbgErrorCode sbgEComProtocolReceive(SbgEComProtocol *pHandle, uint8 *pMsgClass, uint8 *pMsg, void *pData, size_t *pSize, size_t maxSize);

//----------------------------------------------------------------------//
//- Frame generation to stream buffer                                  -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComStartFrameGeneration(SbgStreamBuffer *pOutputStream, uint8 msgClass, uint8 msg);

SbgErrorCode sbgEComFinalizeFrameGeneration(SbgStreamBuffer *pOutputStream);

#endif