CRC

Modules
	CRC_Registers

Data Structures
struct	mxc_crc_req_t

Enumerations
enum	mxc_crc_bitorder_t

Functions
int	MXC_CRC_Init (void)
int	MXC_CRC_Shutdown (void)
void	MXC_CRC_Handler (int ch, int error)
void	MXC_CRC_SetDirection (mxc_crc_bitorder_t bitOrder)
mxc_crc_bitorder_t	MXC_CRC_GetDirection (void)
void	MXC_CRC_SwapDataIn (mxc_crc_bitorder_t bitOrder)
void	MXC_CRC_SwapDataOut (mxc_crc_bitorder_t bitOrder)
void	MXC_CRC_SetPoly (uint32_t poly)
uint32_t	MXC_CRC_GetPoly (void)
uint32_t	MXC_CRC_GetResult (void)
int	MXC_CRC_Compute (mxc_crc_req_t *req)
int	MXC_CRC_ComputeAsync (mxc_crc_req_t *req)

Detailed Description

---

Data Structure Documentation

mxc_crc_req_t

struct mxc_crc_req_t

Structure used to set up CRC request.

Data Fields
uint32_t *	dataBuffer
uint32_t	dataLen
uint32_t	resultCRC

Function Documentation

MXC_CRC_Compute()

int MXC_CRC_Compute

(

mxc_crc_req_t *

req

)

Perform a CRC computation.

Note

The result of the CRC calculation will be placed in the mxc_crc_req_t structure

Parameters

req	Structure containing the data for calculation

Returns

see Error Codes for a list of return codes.

MXC_CRC_ComputeAsync()

int MXC_CRC_ComputeAsync

(

mxc_crc_req_t *

req

)

Perform a CRC computation using DMA.

Note

The result of the CRC calculation will be placed in the mxc_crc_req_t structure. The user must call MXC_DMA_Handler() in the ISR

Parameters

req	Structure containing the data for calculation

Returns

see Error Codes for a list of return codes.

MXC_CRC_GetDirection()

mxc_crc_bitorder_t MXC_CRC_GetDirection

(

void

)

Set the bit-order of CRC calculation.

Returns

The direction of calculation, 1 for MSB first, 0 for LSB first

MXC_CRC_GetPoly()

uint32_t MXC_CRC_GetPoly

(

void

)

Get the polynomial for CRC calculation.

Returns

The polynomial used in calculation

MXC_CRC_GetResult()

uint32_t MXC_CRC_GetResult

(

void

)

Get the result of a CRC calculation.

Returns

The calculated CRC value

MXC_CRC_Handler()

void MXC_CRC_Handler	(	int	ch,
		int	error
	)

This function should be called from the CRC ISR Handler when using Async functions.

Parameters

ch	DMA channel
error	error

MXC_CRC_Init()

int MXC_CRC_Init

(

void

)

Enable portions of the CRC.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CRC_SetDirection()

void MXC_CRC_SetDirection

(

mxc_crc_bitorder_t

bitOrder

)

Set the bit-order of CRC calculation.

Parameters

bitOrder

The direction to perform CRC calculation in

MXC_CRC_SetPoly()

void MXC_CRC_SetPoly

(

uint32_t

poly

)

Set the Polynomial for CRC calculation.

Parameters

poly	The polynomial to use for CRC calculation

MXC_CRC_Shutdown()

int MXC_CRC_Shutdown

(

void

)

Disable and reset portions of the CRC.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_CRC_SwapDataIn()

void MXC_CRC_SwapDataIn

(

mxc_crc_bitorder_t

bitOrder

)

Byte Swap CRC Data Input.

Parameters

bitOrder

The direction to perform CRC calculation in

MXC_CRC_SwapDataOut()

void MXC_CRC_SwapDataOut

(

mxc_crc_bitorder_t

bitOrder

)

Byte Swap CRC Data output.

Parameters

bitOrder

The direction to perform CRC calculation in