sbgEComProtocol.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_PROTOCOL_H
#define SBG_ECOM_PROTOCOL_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <interfaces/sbgInterface.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Constant definitions                                               -//
//----------------------------------------------------------------------//
 
#define SBG_ECOM_MAX_BUFFER_SIZE                (4096)                  
#define SBG_ECOM_MAX_PAYLOAD_SIZE               (4086)                  
#define SBG_ECOM_MAX_EXTENDED_PAYLOAD_SIZE      (4081)                  
#define SBG_ECOM_SYNC_1                         (0xFF)                  
#define SBG_ECOM_SYNC_2                         (0x5A)                  
#define SBG_ECOM_ETX                            (0x33)                  
#define SBG_ECOM_RX_TIME_OUT                    (450)                   
//----------------------------------------------------------------------//
//- Callbacks definitions                                              -//
//----------------------------------------------------------------------//
 
typedef struct _SbgEComProtocol SbgEComProtocol;
 
typedef void (*SbgEComProtocolFrameCb)(SbgEComProtocol *pProtocol, uint8_t msgClass, uint8_t msgId, SbgStreamBuffer *pReceivedFrame, void *pUserArg);
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//
 
typedef struct _SbgEComProtocolPayload
{
    bool                                 allocated;                                 
    void                                *pBuffer;                                   
    size_t                               size;                                      
} SbgEComProtocolPayload;
 
struct _SbgEComProtocol
{
    SbgInterface                        *pLinkedInterface;                          
    uint8_t                              rxBuffer[SBG_ECOM_MAX_BUFFER_SIZE];        
    size_t                               rxBufferSize;                              
    size_t                               discardSize;                               
    uint8_t                              nextLargeTxId;                             
    //
    // Raw stream sbgECom frame reception callback
    //
    SbgEComProtocolFrameCb               pReceiveFrameCb;                           
    void                                *pUserArg;                                  
    //
    // Member variables related to large transfer reception.
    //
    uint8_t                             *pLargeBuffer;                              
    size_t                               largeBufferSize;                           
    uint8_t                              msgClass;                                  
    uint8_t                              msgId;                                     
    uint8_t                              transferId;                                
    uint16_t                             pageIndex;                                 
    uint16_t                             nrPages;                                   
};
 
//----------------------------------------------------------------------//
//- Public methods (SbgEComProtocolPayload)                            -//
//----------------------------------------------------------------------//
 
void sbgEComProtocolPayloadConstruct(SbgEComProtocolPayload *pPayload);
 
void sbgEComProtocolPayloadDestroy(SbgEComProtocolPayload *pPayload);
 
const void *sbgEComProtocolPayloadGetBuffer(const SbgEComProtocolPayload *pPayload);
 
size_t sbgEComProtocolPayloadGetSize(const SbgEComProtocolPayload *pPayload);
 
void *sbgEComProtocolPayloadMoveBuffer(SbgEComProtocolPayload *pPayload);
 
//----------------------------------------------------------------------//
//- Public methods (SbgEComProtocol)                                   -//
//----------------------------------------------------------------------//
 
SbgErrorCode sbgEComProtocolInit(SbgEComProtocol *pProtocol, SbgInterface *pInterface);
 
SbgErrorCode sbgEComProtocolClose(SbgEComProtocol *pProtocol);
 
SbgErrorCode sbgEComProtocolPurgeIncoming(SbgEComProtocol *pProtocol);
 
SbgErrorCode sbgEComProtocolSend(SbgEComProtocol *pProtocol, uint8_t msgClass, uint8_t msg, const void *pData, size_t size);
 
SbgErrorCode sbgEComProtocolReceive(SbgEComProtocol *pProtocol, uint8_t *pMsgClass, uint8_t *pMsgId, void *pData, size_t *pSize, size_t maxSize);
 
SbgErrorCode sbgEComProtocolReceive2(SbgEComProtocol *pProtocol, uint8_t *pMsgClass, uint8_t *pMsgId, SbgEComProtocolPayload *pPayload);
 
void sbgEComProtocolSetOnFrameReceivedCb(SbgEComProtocol *pProtocol, SbgEComProtocolFrameCb pOnFrameReceivedCb, void *pUserArg);
 
SbgErrorCode sbgEComStartFrameGeneration(SbgStreamBuffer *pOutputStream, uint8_t msgClass, uint8_t msg, size_t *pStreamCursor);
 
SbgErrorCode sbgEComFinalizeFrameGeneration(SbgStreamBuffer *pOutputStream, size_t streamCursor);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_PROTOCOL_H