scom_ack_frame.c

Go to the documentation of this file.

#define HAL_LOG_CHANNEL SCOM
#define HAL_LOG_SUBCHANNEL FRAME

#include "hal.h"
#include "scom_ack_frame.h"
#include "scom_crc.h"

// --------------------------------------------------------------------------------------
//  SCOMFrame_GetTotalFrameSize
// --------------------------------------------------------------------------------------
bool SCOMAckFrame_Initialize(SCOMAckFrame* const ackFrame, const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(ackFrame != NULL) {
                HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                        *ackFrame = (SCOMAckFrame) {
                                .sync = 0xFF,
                                .soack = 0x3b,
                                .ctrl = frame->ctrl,
                                .type = frame->type,
                                .frame_crc = frame->crc
                        };
                        return true;
                }
        }
        return false;
} /* SCOMAckFrame_Initialize */

// --------------------------------------------------------------------------------------
//  SCOMAckFrame_IsValidAck
// --------------------------------------------------------------------------------------
bool SCOMAckFrame_IsValidAck(const SCOMAckFrame* const ackFrame, const SCOMFrame* const frame) {
        HAL_ASSERT_AND_EXECUTE(ackFrame != NULL) {
                HAL_ASSERT_AND_EXECUTE(frame != NULL) {
                        if((ackFrame->type == frame->type) && ((ackFrame->ctrl & SCOM_FRAME_CTRL_FRAME_NUMBER_MASK) == (frame->ctrl & SCOM_FRAME_CTRL_FRAME_NUMBER_MASK)) && (ackFrame->frame_crc == frame->crc)) {
                                // this ACK was expected
                                return true;
                        }
                }
        }
        return false;
} /* SCOMAckFrame_IsValidAck */

// --------------------------------------------------------------------------------------
//  SCOMAckFrame_CalculateCRC
// --------------------------------------------------------------------------------------
uint16_t SCOMAckFrame_CalculateCRC(const SCOMAckFrame* const ackFrame) {
        HAL_ASSERT_AND_EXECUTE(ackFrame != NULL) {
                uint16_t crc = CRC16_InitCRC();
                for(uint_fast8_t i = 0; i < (sizeof(SCOMAckFrame) - sizeof(ackFrame->sync) - sizeof(ackFrame->crc)); ++i) {
                        crc = CRC16_UpdateCRC_Byte(*(&ackFrame->soack + i), crc);
                }
                return crc;
        }
        return -1;
} /* SCOMAckFrame_CalculateCRC */