scom_frame.c

Go to the documentation of this file.

#define HAL_LOG_CHANNEL SCOM
#define HAL_LOG_SUBCHANNEL FRAME

#include "scom_frame.h"
#include "scom_crc.h"
#include "hal.h"
// --------------------------------------------------------------------------------------
//  SCOMFrame_GetTotalFrameSize
// --------------------------------------------------------------------------------------
uint16_t SCOMFrame_GetTotalFrameSize(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                // Calculate total frame size which is a sum of all frame fields
                uint16_t size = sizeof(frame->sync) + sizeof(frame->sof) + SCOMFrame_GetPacketControlSize();

                // for multiframes add multiframe descriptor size
                if (SCOMFrame_IsMultiframe(frame)){
                        size += sizeof(frame->payload.multiframe.multi_id) + sizeof(frame->payload.multiframe.offset)
                                                                                                                                                                        + sizeof(frame->payload.multiframe.total_size);
                }

                // Include payload size
                size += frame->size;
                return size;
        }
        return 0;
} /* SCOMFrame_GetTotalFrameSize */


// --------------------------------------------------------------------------------------
//  SCOMFrame_SetType
// --------------------------------------------------------------------------------------
bool SCOMFrame_SetType(SCOMFrame* const frame, const uint8_t type) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                HAL_ASSERT_AND_EXECUTE(type <= 240) {
                        frame->type = type;
                        return true;
                }
        }
        return false;
} /* SCOMFrame_SetType */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetType
// --------------------------------------------------------------------------------------
uint8_t SCOMFrame_GetType(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return frame->type;
        }
        return 0xff;
} /* SCOMFrame_GetType */


// --------------------------------------------------------------------------------------
//  SCOMFrame_SetPriority
// --------------------------------------------------------------------------------------
bool SCOMFrame_SetPriority(SCOMFrame* const frame, const uint8_t priority) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                HAL_ASSERT_AND_EXECUTE(priority <= 7) {
                        frame->ctrl &= ~SCOM_FRAME_CTRL_FRAME_PRIORITY_MASK; // Clear priority
                        frame->ctrl |= priority << 4; //set new priority
                        return true;
                }
        }
        return false;
} /* SCOMFrame_SetPriority */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetPriority
// --------------------------------------------------------------------------------------
uint8_t SCOMFrame_GetPriority(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return (frame->ctrl & SCOM_FRAME_CTRL_FRAME_PRIORITY_MASK) >> 4;
        }
        return 0xff;
} /* SCOMFrame_GetPriority */


// --------------------------------------------------------------------------------------
//  SCOMFrame_SetFrameNumber
// --------------------------------------------------------------------------------------
bool SCOMFrame_SetFrameNumber(SCOMFrame* const frame, const uint8_t number) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                HAL_ASSERT_AND_EXECUTE(number <= SCOM_FRAME_CTRL_FRAME_NUMBER_MASK) {
                        frame->ctrl &= ~SCOM_FRAME_CTRL_FRAME_NUMBER_MASK; // Clear old number
                        frame->ctrl |= number; // Set new number
                        return true;
                }
        }
        return false;
} /* SCOMFrame_SetFrameNumber */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetFrameNumber
// --------------------------------------------------------------------------------------
uint8_t SCOMFrame_GetFrameNumber(const SCOMFrame * const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return frame->ctrl & SCOM_FRAME_CTRL_FRAME_NUMBER_MASK;
        }
        return 0xff;
} /* SCOMFrame_GetFrameNumber */


// --------------------------------------------------------------------------------------
//  SCOMFrame_SetPayloadSize
// --------------------------------------------------------------------------------------
bool SCOMFrame_SetPayloadSize(SCOMFrame* const frame, const uint8_t size) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                HAL_ASSERT_AND_EXECUTE(size <= SCOM_MAX_DATA_LENGTH) {
                        frame->size = size;
                        return true;
                }
        }
        return false;
} /* SCOMFrame_SetPayloadSize */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetPayloadSize
// --------------------------------------------------------------------------------------
uint8_t SCOMFrame_GetPayloadSize(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return frame->size;
        }
        return 0xff;
} /* SCOMFrame_GetPayloadSize */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetPayloadPtr
// --------------------------------------------------------------------------------------
uint8_t* SCOMFrame_GetPayloadPtr(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return (frame->ctrl & SCOM_FRAME_CTRL_MULTI_ID_MASK) ? (uint8_t*)frame->payload.multiframe.data : (uint8_t*)frame->payload.singleframe.data;
        }
        return NULL;
} /* SCOMFrame_GetPayloadPtr */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetTotalPayloadSize
// --------------------------------------------------------------------------------------
uint32_t SCOMFrame_GetTotalPayloadSize(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                return (frame->ctrl & SCOM_FRAME_CTRL_MULTI_ID_MASK) ? frame->payload.multiframe.total_size : (uint32_t)frame->size;
        }
        return 0;
} /* SCOMFrame_GetTotalPayloadSize */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetMultiId
// --------------------------------------------------------------------------------------
uint32_t SCOMFrame_GetMultiId(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                if (frame->ctrl & SCOM_FRAME_CTRL_MULTI_ID_MASK) {
                        return frame->payload.multiframe.multi_id; // if this is a mluti-frame
                }
        }
        return 0;
} /* SCOMFrame_GetMultiId */


// --------------------------------------------------------------------------------------
//  SCOMFrame_GetMultiOffset
// --------------------------------------------------------------------------------------
uint32_t SCOMFrame_GetMultiOffset(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                if (frame->ctrl & SCOM_FRAME_CTRL_MULTI_ID_MASK) {
                        return frame->payload.multiframe.offset; // if this is a mluti-frame
                }
        }
        return 0;
} /* SCOMFrame_GetMultiOffset */


// --------------------------------------------------------------------------------------
//  SCOMFrame_SetAcknowledgement
// --------------------------------------------------------------------------------------
bool SCOMFrame_SetAcknowledgement(SCOMFrame* const frame, const bool ack) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                if (true == ack) {
                        frame->ctrl &= ~(SCOM_FRAME_CTRL_NOACK_MASK);
                } else {
                        frame->ctrl |= SCOM_FRAME_CTRL_NOACK_MASK;
                }
                return true;
        }
        return false;
} /* SCOMFrame_SetAcknowledgement */


// --------------------------------------------------------------------------------------
//  SCOMFrame_IsMultiframe
// --------------------------------------------------------------------------------------
bool SCOMFrame_IsMultiframe(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                if (frame->ctrl & SCOM_FRAME_CTRL_MULTI_ID_MASK) {
                        return true;
                }
        }
        return false;
} /* SCOMFrame_IsMultiframe */


// --------------------------------------------------------------------------------------
//  SCOMFrame_IsAcknowledged
// --------------------------------------------------------------------------------------
bool SCOMFrame_IsAcknowledged(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                if (frame->ctrl & SCOM_FRAME_CTRL_NOACK_MASK) {
                        return false;
                }
        }
        return true;
} /* SCOMFrame_IsAcknowledged */


// --------------------------------------------------------------------------------------
//  SCOMFrame_CalculateCRC
// --------------------------------------------------------------------------------------
uint16_t SCOMFrame_CalculateCRC(const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                uint16_t crc = CRC16_InitCRC();
                crc = CRC16_UpdateCRC_Byte(frame->ctrl, crc);
                crc = CRC16_UpdateCRC_Byte(frame->type, crc);
                crc = CRC16_UpdateCRC_Byte(frame->size, crc);

                const uint8_t* const begin = frame->payload.singleframe.data;
                const uint8_t* const end = begin + frame->size;

                for(const uint8_t* it = begin; it < end; ++it) {
                        crc = CRC16_UpdateCRC_Byte(*it, crc);
                }
                return crc;
        }
        return 0;
} /* SCOMFrame_CalculateCRC */