scom_ack_frame.h File Reference

SCOMAckFrame definition. More...

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

Go to the source code of this file.

Data Structures
struct	HAL_PACKED
	SCOM version record. More...

Typedefs
typedef struct HAL_PACKED	SCOMAckFrame
	Definition of an SCOM acknowledgment frame. More...

Enumerations
enum	{ SCOM_ACK_SOF_CHARACTER = 0x3b }

Functions
bool	SCOMAckFrame_Initialize (SCOMAckFrame *const ackFrame, const SCOMFrame *const frame)
bool	SCOMAckFrame_IsValidAck (const SCOMAckFrame *const ackFrame, const SCOMFrame *const frame)
uint16_t	SCOMAckFrame_CalculateCRC (const SCOMAckFrame *const ackFrame)

Detailed Description

SCOMAckFrame definition.

License: $License$

Copyright

$Copyright$

Version

Revision

426

Purpose: SCOM serial communication protocol

Definition in file scom_ack_frame.h.

Typedef Documentation

typedef struct HAL_PACKED SCOMAckFrame

Definition of an SCOM acknowledgment frame.

Enumeration Type Documentation

anonymous enum

Enumerator
SCOM_ACK_SOF_CHARACTER	Start of frame character.

Definition at line 29 of file scom_ack_frame.h.

Function Documentation

uint16_t SCOMAckFrame_CalculateCRC

(

const SCOMAckFrame *const

ackFrame

)

Calculates CRC for the given acknowledgement frame.

Parameters

[in]

ackFrame

acknowledgement frame

Returns

calculated CRC (0xffff is returned if NULL frame was passed)

Definition at line 54 of file scom_ack_frame.c.

References HAL_PACKED::crc, CRC16_InitCRC, CRC16_UpdateCRC_Byte, HAL_PACKED::soack, and HAL_PACKED::sync.

Referenced by SCOM_Proc().

bool SCOMAckFrame_Initialize	(	SCOMAckFrame *const	ackFrame,
		const SCOMFrame *const	frame
	)

Initializes an acknowledgement frame.

Parameters

[in,out]	ackFrame	acknowledgement frame
[in]	frame	SCOMFrame to acknowledge

Returns

Definition at line 20 of file scom_ack_frame.c.

References HAL_PACKED::crc, HAL_PACKED::ctrl, HAL_PACKED::sync, and HAL_PACKED::type.

Referenced by SCOM_Proc().

bool SCOMAckFrame_IsValidAck	(	const SCOMAckFrame *const	ackFrame,
		const SCOMFrame *const	frame
	)

Checks if a given acknowledgement frame matches the given SCOM frame.

Parameters

[in]	ackFrame	acknowledgement frame
[in]	frame	SCOMFrame

Return values

true	if ACK matches SCOM frame
false	if ACK does not matches the SCOM frame or other error occurred

Definition at line 39 of file scom_ack_frame.c.

References HAL_PACKED::crc, HAL_PACKED::ctrl, HAL_PACKED::frame_crc, SCOM_FRAME_CTRL_FRAME_NUMBER_MASK, and HAL_PACKED::type.

Referenced by SCOM_Proc().