CRC library. More...

Enumerations
enum	CRCLength { CRC_LENGTH_8 , CRC_LENGTH_16 , CRC_LENGTH_32 , NUM_CRC_LENGTHS }
	CRC Length. More...

Functions
StatusCode	crc_init (CRCLength crc_length)
	Initilize the CRC API with default values. More...

uint32_t	crc_calculate (const uint32_t *data, size_t length)
	Calculate the CRC-32/16/8 checksum for a buffer of 32-bit values. More...

void	crc_reset (void)
	Reset the CRC hardware peripheral. More...

Detailed Description

CRC library.

Enumeration Type Documentation

◆ CRCLength

enum CRCLength

CRC Length.

Enumerator
CRC_LENGTH_8	CRC Length of 8 bits
CRC_LENGTH_16	CRC Length of 16 bits
CRC_LENGTH_32	CRC Length of 32 bits
NUM_CRC_LENGTHS	Number of CRC Length

Function Documentation

◆ crc_calculate()

uint32_t crc_calculate	(	const uint32_t *	data,
		size_t	length
	)

Calculate the CRC-32/16/8 checksum for a buffer of 32-bit values.

This expects the user to determine the number of CRC-length sized words in the data array. For example, if CRC is initialized with length 16, the user must divide the total size of the array by 2, for the number of 16-bit words

Parameters

data	Pointer to the buffer of 32-bit words
length	Number of CRC-length words in the buffer

Returns: Computed CRC-32 checksum

◆ crc_init()

StatusCode crc_init ( CRCLength crc_length )

Initilize the CRC API with default values.

Parameters

crc_length Number of bits in the CRC

Returns: STATUS_CODE_INVALID_ARGS if invalid crc_length is entered.; STATUS_CODE_INTERNAL_ERROR if CRC initialization failed, possibly due to invalid parameters, hardware issues, or improper clock configuration.; STATUS_CODE_OK is returned if CRC API was initilized successfully

◆ crc_reset()

void crc_reset ( void )

Reset the CRC hardware peripheral.

This function forces a reset of the CRC peripheral and then releases the reset, ensuring that all CRC registers are cleared and reset to their default state.

Enumerations