API for the qCRC Generic Cyclic Redundancy Check (CRC) calcULator. More...

Macros
#define	qCRC8(pData, length)
	CRC-8 with poly = 0x07 init = 0x00 refIn = false refOut = false xorOut= 0x00.

#define	qCRC8_CDMA2000(pData, length)
	CRC-8/CDMA2000 with poly = 0x9B init = 0xFF refIn = false refOut = false xorOut= 0x00.

#define	qCRC8_DARC(pData, length)
	CRC-8/CDMA2000 with poly = 0x39 init = 0x00 refIn = true refOut = true xorOut= 0x00.

#define	qCRC8_DVB_S2(pData, length)
	CRC-8/CDMA2000 with poly = 0xD5 init = 0x00 refIn = false refOut = false xorOut= 0x00.

#define	qCRC8_EBU(pData, length)
	CRC-8/EBU with poly = 0x1D init = 0xFF refIn = true refOut = true xorOut= 0x00.

#define	qCRC8_I_CODE(pData, length)
	CRC-8/I-CODE with poly = 0x1D init = 0xFD refIn = false refOut = false xorOut= 0x00.

#define	qCRC8_ITU(pData, length)
	CRC-8/ITU with poly = 0x07 init = 0x00 refIn = false refOut = false xorOut= 0x55.

#define	qCRC8_MAXIM(pData, length)
	CRC-8/MAXIM with poly = 0x31 init = 0x00 refIn = true refOut = true xorOut= 0x00.

#define	qCRC8_ROHC(pData, length)
	CRC-8/ROHC with poly = 0x07 init = 0xFF refIn = true refOut = true xorOut= 0x00.

#define	qCRC8_WCDMA(pData, length)
	CRC-8/WCDMA with poly = 0x9B init = 0x00 refIn = true refOut = true xorOut= 0x00.

#define	qCRC16_CCITT_FALSE(pData, length)
	CRC-16/CCITT-FALSE with poly = 0x1021 init = 0xFFFF refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_ARC(pData, length)
	CRC-16/ARC with poly = 0x8005 init = 0x0000 refIn = true r efOut = true xorOut= 0x0000.

#define	qCRC16_AUG_CCITT(pData, length)
	CRC-16/AUG-CCITT with poly = 0x1021 init = 0x1D0F refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_BUYPASS(pData, length)
	CRC-16/BUYPASS with poly = 0x8005 init = 0x0000 refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_CDMA2000(pData, length)
	CRC-16/CDMA2000 with poly = 0xC867 init = 0xFFFF refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_DDS_110(pData, length)
	CRC-16/DDS-110 with poly = 0x8005 init = 0x800D refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_DECT_R(pData, length)
	CRC-16/DECT-R with poly = 0x0589 init = 0x0000 refIn = false refOut = false xorOut= 0x0001.

#define	qCRC16_DECT_X(pData, length)
	CRC-16/DECT-X with poly = 0x0589 init = 0x0000 refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_DNP(pData, length)
	CRC-16/DNP with poly = 0x3D98 init = 0x0000 refIn = true refOut = true xorOut= 0xFFFF.

#define	qCRC16_EN_13757(pData, length)
	CRC-16/EN-13757 with poly = 0x3D65 init = 0x0000 refIn = false refOut = false xorOut= 0xFFFF.

#define	qCRC16_GENIBUS(pData, length)
	CRC-16/GENIBUS with poly = 0x1021 init = 0xFFFF refIn = false refOut = false xorOut= 0xFFFF.

#define	qCRC16_MAXIM(pData, length)
	CRC-16/MAXIM with poly = 0x8005 init = 0x0000 refIn = true refOut = true xorOut= 0xFFFF.

#define	qCRC16_MCRF4XX(pData, length)
	CRC-16/MCRF4XX with poly = 0x1021 init = 0xFFFF refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_RIELLO(pData, length)
	CRC-16/RIELLO with poly = 0x1021 init = 0xB2AA refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_T10_DIF(pData, length)
	CRC-16/DECT-X with poly = 0x8bb7 init = 0x0000 refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_TELEDISK(pData, length)
	CRC-16/TELEDISK with poly = 0xA097 init = 0x0000 refIn = false refOut = false xorOut= 0x0000.

#define	qCRC16_TMS37157(pData, length)
	CRC-16/TMS37157 with poly = 0x1021 init = 0x89EC refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_USB(pData, length)
	CRC-16/USB with poly = 0x8005 init = 0xFFFF refIn = true refOut = true xorOut= 0xFFFF.

#define	qCRC16_A(pData, length)
	CRC-A with poly = 0x1021 init = 0xC6C6 refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_KERMIT(pData, length)
	CRC-16/KERMIT with poly = 0x1021 init = 0x0000 refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_MODBUS(pData, length)
	CRC-16/MODBUS with poly = 0x8005 init = 0xFFFF refIn = true refOut = true xorOut= 0x0000.

#define	qCRC16_X_25(pData, length)
	CRC-16/X-25 with poly = 0x1021 init = 0xFFFF refIn = true refOut = true xorOut= 0xFFFF.

#define	qCRC16_XMODEM(pData, length)
	CRC-16/XMODEM with poly = 0x1021 init = 0x0000 refIn = false refOut = false xorOut= 0x0000.

#define	qCRC32(pData, length)
	CRC-32 with poly = 0x04C11DB7 init = 0xFFFFFFFF refIn = true refOut = true xorOut= 0xFFFFFFFF.

#define	qCRC32_BZIP2(pData, length)
	CRC-32/BZIP2 with poly = 0x04C11DB7 init = 0xFFFFFFFF refIn = false refOut = false xorOut= 0xFFFFFFFF.

#define	qCRC32_C(pData, length)
	CRC-32C with poly = 0x1EDC6F41 init = 0xFFFFFFFF refIn = true refOut = true xorOut= 0xFFFFFFFF.

#define	qCRC32_D(pData, length)
	CRC-32D with poly = 0xA833982B init = 0xFFFFFFFF refIn = true refOut = true xorOut= 0xFFFFFFFF.

#define	qCRC32_JAMCRC(pData, length)
	CRC-32/JAMCRC with poly = 0x04C11DB7 init = 0xFFFFFFFF refIn = true refOut = true xorOut= 0x00000000.

#define	qCRC32_MPEG2(pData, length)
	CRC-32/MPEG2 with poly = 0x04C11DB7 init = 0xFFFFFFFF refIn = false refOut = false xorOut= 0x00000000.

#define	qCRC32_POSIX(pData, length)
	CRC-32/POSIX with poly = 0x04C11DB7 init = 0x00000000 refIn = false refOut = false xorOut= 0xFFFFFFFF.

#define	qCRC32_Q(pData, length)
	CRC-32Q with poly = 0x814141AB init = 0x00000000 refIn = false refOut = false xorOut= 0x00000000.

#define	qCRC32_XFER(pData, length)
	CRC-32/XFER with poly = 0x000000AF init = 0x00000000 refIn = false refOut = false xorOut= 0x00000000.

Enumerations
enum	qCRC_Mode_t { QCRC8 , QCRC16 , QCRC32 }
	Enumeration with all the supported cyclic redundancy checks. More...

Functions
uint32_t	qCRCx (const qCRC_Mode_t mode, const void *const pData, const size_t length, uint32_t poly, const uint32_t init, const uint8_t refIn, const uint8_t refOut, uint32_t xorOut)
	CalcULates in one pass the common width bit CRC value for a block of data that is passed to the function together with a parameter indicating the length.

Detailed Description

API for the qCRC Generic Cyclic Redundancy Check (CRC) calcULator.

For a brief description of this module, please read Generic Cyclic Redundancy Check (CRC) calculator

Enumeration Type Documentation

◆ qCRC_Mode_t

enum qCRC_Mode_t

Enumeration with all the supported cyclic redundancy checks.

Enumerator
QCRC8	8-Bit Cyclic Redundancy Check
QCRC16	16-Bit Cyclic Redundancy Check
QCRC32	32-Bit Cyclic Redundancy Check

Function Documentation

◆ qCRCx()

uint32_t qCRCx	(	const qCRC_Mode_t	mode,
		const void *const	pData,
		const size_t	length,
		uint32_t	poly,
		const uint32_t	init,
		const uint8_t	refIn,
		const uint8_t	refOut,
		uint32_t	xorOut )

CalcULates in one pass the common width bit CRC value for a block of data that is passed to the function together with a parameter indicating the length.

Parameters

[in]	mode	To select the CRC calcULation mode. Only the following values are supported: QCRC8, QCRC16 and QCRC32.
[in]	pData	A pointer to the block of data.
[in]	length	The number of bytes in data.
[in]	poly	CRC polynomial value.
[in]	init	CRC initial value.
[in]	refIn	If true, the input data is reflected before processing.
[in]	refOut	If true, the CRC resULt is reflected before output.
[in]	xorOut	The final XOR value.

Returns: The CRC value for data.

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ qCRC_Mode_t

Function Documentation

◆ qCRCx()