scom_frame.h

Go to the documentation of this file.

#ifndef SCOM_FRAME_H_
#define SCOM_FRAME_H_


#include "hal.h"
#include <stdbool.h>
#include <stdint.h>


#ifndef SCOM_MAX_DATA_LENGTH

#define SCOM_MAX_DATA_LENGTH                            UINT8_C(255)
#else
  #if defined __arm__
    #warning custom SCOM_MAX_DATA_LENGTH defined.
  #else
    #pragma message "warning: custom SCOM_MAX_DATA_LENGTH defined"
  #endif
#endif


#define SCOM_SOF_CHARACTER                                              UINT8_C(0x3a) 
#define SCOM_FRAME_CTRL_FRAME_NUMBER_MASK                       UINT8_C(0x07) 
#define SCOM_FRAME_CTRL_NOACK_MASK                                      UINT8_C(0x08) 
#define SCOM_FRAME_CTRL_FRAME_PRIORITY_MASK             UINT8_C(0x70) 
#define SCOM_FRAME_CTRL_MULTI_ID_MASK                           UINT8_C(0x80) 


typedef enum {
        SCOM_FRAMETYPE_PING     = 250, 
        SCOM_FRAMETYPE_PONG     = 251, 
        SCOM_FRAMETYPE_IDENTIFY = 252, 
} SCOMFrameType;


typedef struct HAL_PACKED {
        uint8_t sync; 
        uint8_t sof; 
        uint8_t ctrl; 
        uint8_t type; 
        uint8_t size; 
        uint8_t null;//only for alignment
        uint16_t crc; 
        union{
                struct {
                        uint8_t data[SCOM_MAX_DATA_LENGTH]; 
                } singleframe;
                struct {
                        uint32_t multi_id; 
                        uint32_t offset; 
                        uint32_t total_size; 
                        uint8_t data[SCOM_MAX_DATA_LENGTH - 12]; 
                } multiframe;
                struct {
                        uint8_t primitive_id; 
                        uint8_t data[SCOM_MAX_DATA_LENGTH - 1]; 
                } serviceframe;
                struct {
                        uint32_t multi_id; 
                        uint32_t offset; 
                        uint32_t total_size; 
                        uint8_t primitive_id; 
                        uint8_t data[SCOM_MAX_DATA_LENGTH - 13]; 
                } servicemultiframe;
        } payload;

#if true == SCOM_RECEIVED_FRAME_TIMESTAMP
    uint32_t received_timestamp;
#endif
} SCOMFrame;


uint16_t SCOMFrame_GetTotalFrameSize(const SCOMFrame* const frame);

static HAL_INLINE uint8_t SCOMFrame_GetPacketControlSize(void) {
        SCOMFrame *frame;
        (void)frame;
        return sizeof(frame->ctrl) + sizeof(frame->type) + sizeof(frame->size)
                        + sizeof(frame->crc);
}

bool SCOMFrame_SetType(SCOMFrame* const frame, const uint8_t type);

uint8_t SCOMFrame_GetType(const SCOMFrame* const frame);


bool SCOMFrame_SetPriority(SCOMFrame* const frame, const uint8_t priority);

uint8_t SCOMFrame_GetPriority(const SCOMFrame* const frame);

bool SCOMFrame_SetFrameNumber(SCOMFrame* const frame, const uint8_t number);

uint8_t SCOMFrame_GetFrameNumber(const SCOMFrame * const frame);

bool SCOMFrame_SetPayloadSize(SCOMFrame* const frame, const uint8_t size);

uint8_t SCOMFrame_GetPayloadSize(const SCOMFrame* const frame);

uint8_t* SCOMFrame_GetPayloadPtr(const SCOMFrame* const frame);


uint32_t SCOMFrame_GetTotalPayloadSize(const SCOMFrame* const frame);

uint32_t SCOMFrame_GetMultiId(const SCOMFrame* const frame);

uint32_t SCOMFrame_GetMultiOffset(const SCOMFrame* const frame);

bool SCOMFrame_SetAcknowledgement(SCOMFrame* const frame, const bool ack);

bool SCOMFrame_IsMultiframe(const SCOMFrame* const frame);

bool SCOMFrame_IsAcknowledged(const SCOMFrame* const frame);

uint16_t SCOMFrame_CalculateCRC(const SCOMFrame* const frame);

static HAL_INLINE size_t SCOMFrame_GetMaxSingleframePayloadSize(void) {
        return SCOM_MAX_DATA_LENGTH;
}

static HAL_INLINE size_t SCOMFrame_GetMaxMultiframePayloadSize(void) {
        return SCOM_MAX_DATA_LENGTH - 12;
}

static HAL_INLINE size_t SCOMFrame_GetMaxServiceMultiframePayloadSize(void) {
        return SCOM_MAX_DATA_LENGTH - 13;
}


#endif /* SCOM_FRAME_H */