Struct containing the parameters required for calculating the CRC of a data block. Default values can be set with CRC_Params_init. More...

#include <CRC.h>

Collaboration diagram for CRC_Params:

[legend]

Data Fields
CRC_ReturnBehavior	returnBehavior

CRC_CallbackFxn	callbackFxn

uint32_t	timeout

void *	custom

uint32_t	seed

CRC_Polynomial	polynomial

uint32_t	programmablePoly

uint32_t	programmablePolyOrder

CRC_DataSize	dataSize

CRC_ByteSwap	byteSwapInput

uint8_t	reverseInputBits

uint8_t	invertOutputBits

uint8_t	reverseOutputBits

uint32_t	finalXorValue

Detailed Description

Struct containing the parameters required for calculating the CRC of a data block. Default values can be set with CRC_Params_init.

Field Documentation

§ returnBehavior

CRC_ReturnBehavior CRC_Params::returnBehavior

Blocking, callback, or polling return behavior

§ callbackFxn

CRC_CallbackFxn CRC_Params::callbackFxn

Callback function pointer

§ timeout

uint32_t CRC_Params::timeout

Maximum time in ticks the driver will wait for hardware to become available. Also limits maximum operation time, but only in BLOCKING mode.

§ custom

void* CRC_Params::custom

Custom argument used by driver implementation

§ seed

uint32_t CRC_Params::seed

Typically 0x0000... or 0xFFFF... This value should always be the width of the polynomial.

§ polynomial

CRC_Polynomial CRC_Params::polynomial

Which polynomial to use for calculation

See also: CRC_Polynomial

§ programmablePoly

uint32_t CRC_Params::programmablePoly

If programmable polynomials are supported, set the polynomial here

§ programmablePolyOrder

uint32_t CRC_Params::programmablePolyOrder

If programmable polynomials are supported, set the order of the polynomial here

§ dataSize

CRC_DataSize CRC_Params::dataSize

Determines the width of the operation (i.e. is data consumed in 8, 16 or 32-bit blocks). Does not impact the width of the result, which is always the same as the polynomial order.

§ byteSwapInput

CRC_ByteSwap CRC_Params::byteSwapInput

If endianness processing is needed on the input.

See also: CRC_ByteSwap

§ reverseInputBits

uint8_t CRC_Params::reverseInputBits

This reverses the bits in the input register

§ invertOutputBits

uint8_t CRC_Params::invertOutputBits

This inverts the output bits of the final result

§ reverseOutputBits

uint8_t CRC_Params::reverseOutputBits

This reverses the bits of the final result

§ finalXorValue

uint32_t CRC_Params::finalXorValue

After calculation is complete, the result will be XORed with this field

The documentation for this struct was generated from the following file:

CRC.h

Data Fields