General Description

Functions
__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_Init (CRYPTO_Type *base, uint32_t polynomial, uint32_t dataReverse, uint32_t dataXor, uint32_t remReverse, uint32_t remXor)
	Initializes the CRC calculation. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc (CRYPTO_Type base, uint32_t crc, void const *data, uint32_t dataSize, uint32_t lfsrInitState)
	Performs the CRC calculation on a message. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_CalcInit (CRYPTO_Type *base, uint32_t width, uint32_t polynomial, uint32_t dataReverse, uint32_t dataXor, uint32_t remReverse, uint32_t remXor, uint32_t lfsrInitState)
	Initializes the CRC calculation. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_CalcStart (CRYPTO_Type *base, uint32_t width, uint32_t lfsrInitState)
	Prepares the CRC calculation by setting an initial seed value. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_CalcPartial (CRYPTO_Type base, void const data, uint32_t dataSize)
	Performs the CRC calculation of a message part. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_CalcFinish (CRYPTO_Type base, uint32_t width, uint32_t crc)
	Finalizes the CRC calculation. More...

__STATIC_INLINE cy_en_crypto_status_t	Cy_Crypto_Core_Crc_Calc (CRYPTO_Type base, uint32_t width, uint32_t crc, void const *data, uint32_t dataSize)
	Performs the CRC calculation on a message. More...

Function Documentation

◆ Cy_Crypto_Core_Crc_Init()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_Init	(	CRYPTO_Type *	base,
		uint32_t	polynomial,
		uint32_t	dataReverse,
		uint32_t	dataXor,
		uint32_t	remReverse,
		uint32_t	remXor
	)

Initializes the CRC calculation.

Call to initialize this encryption technique before using any associated functions. You must initialize this technique again after using any other encryption technique.

Below is the table with known polynomials with different parameters and their calculated CRCs from the string "123456789":

Name	Width	Poly	Init	Data Rev	Rem Rev	Rem XOR	Expected CRC
CRC-3 / ROHC	3	0x3	0x7	1	1	0x0	0x6
CRC-4 / ITU	4	0x3	0x0	1	1	0x0	0x7
CRC-5 / EPC	5	0x9	0x9	0	0	0x0	0x0
CRC-5 / ITU	5	0x15	0x0	1	1	0x0	0x7
CRC-5 / USB	5	0x5	0x1F	1	1	0x1F	0x19
CRC-6 / CDMA2000-A	6	0x27	0x3F	0	0	0x0	0xD
CRC-6 / CDMA2000-B	6	0x7	0x3F	0	0	0x0	0x3B
CRC-6 / DARC	6	0x19	0x0	1	1	0x0	0x26
CRC-6 / ITU	6	0x3	0x0	1	1	0x0	0x6
CRC-7	7	0x9	0x0	0	0	0x0	0x75
CRC-7 / ROHC	7	0x4F	0x7F	1	1	0x0	0x53
CRC-8	8	0x7	0x0	0	0	0x0	0xF4
CRC-8 / CDMA2000	8	0x9B	0xFF	0	0	0x0	0xDA
CRC-8 / DARC	8	0x39	0x0	1	1	0x0	0x15
CRC-8 / DVB-S2	8	0xD5	0x0	0	0	0x0	0xBC
CRC-8 / EBU	8	0x1D	0xFF	1	1	0x0	0x97
CRC-8 / I-CODE	8	0x1D	0xFD	0	0	0x0	0x7E
CRC-8 / ITU	8	0x7	0x0	0	0	0x55	0xA1
CRC-8 / MAXIM	8	0x31	0x0	1	1	0x0	0xA1
CRC-8 / ROHC	8	0x7	0xFF	1	1	0x0	0xD0
CRC-8 / WCDMA	8	0x9B	0x0	1	1	0x0	0x25
CRC-10	10	0x233	0x0	0	0	0x0	0x199
CRC-10 / CDMA2000	10	0x3D9	0x3FF	0	0	0x0	0x233
CRC-11	11	0x385	0x1A	0	0	0x0	0x5A3
CRC-12 / 3GPP	12	0x80F	0x0	0	1	0x0	0xDAF
CRC-12 / CDMA2000	12	0xF13	0xFFF	0	0	0x0	0xD4D
CRC-12 / DECT	12	0x80F	0x0	0	0	0x0	0xF5B
CRC-13 / BBC	13	0x1CF5	0x0	0	0	0x0	0x4FA
CRC-14 / DARC	14	0x805	0x0	1	1	0x0	0x82D
CRC-15	15	0x4599	0x0	0	0	0x0	0x59E
CRC-15 / MPT1327	15	0x6815	0x0	0	0	0x1	0x2566
CRC-24	24	0x0864CFB	0x00B704CE	0	0	0x0	0x21CF02
CRC-24 / FLEXRAY-A	24	0x05D6DCB	0x00FEDCBA	0	0	0x0	0x7979BD
CRC-24 / FLEXRAY-B	24	0x05D6DCB	0x00ABCDEF	0	0	0x0	0x1F23B8
CRC-31 / PHILIPS	31	0x4C11DB7	0x7FFFFFFF	0	0	0x7FFFFFFF	0xCE9E46C
CRC-16 / ARC	16	0x8005	0x0000	1	1	0x0000	0xBB3D
CRC-16 / AUG-CCITT	16	0x1021	0x1D0F	0	0	0x0000	0xE5CC
CRC-16 / BUYPASS	16	0x8005	0x0000	0	0	0x0000	0xFEE8
CRC-16 / CCITT-0	16	0x1021	0xFFFF	0	0	0x0000	0x29B1
CRC-16 / CDMA2000	16	0xC867	0xFFFF	0	0	0x0000	0x4C06
CRC-16 / DDS-110	16	0x8005	0x800D	0	0	0x0000	0x9ECF
CRC-16 / DECT-R	16	0x0589	0x0000	0	0	0x0001	0x007E
CRC-16 / DECT-X	16	0x0589	0x0000	0	0	0x0000	0x007F
CRC-16 / DNP	16	0x3D65	0x0000	1	1	0xFFFF	0xEA82
CRC-16 / EN-13757	16	0x3D65	0x0000	0	0	0xFFFF	0xC2B7
CRC-16 / GENIBUS	16	0x1021	0xFFFF	0	0	0xFFFF	0xD64E
CRC-16 / MAXIM	16	0x8005	0x0000	1	1	0xFFFF	0x44C2
CRC-16 / MCRF4XX	16	0x1021	0xFFFF	1	1	0x0000	0x6F91
CRC-16 / RIELLO	16	0x1021	0xB2AA	1	1	0x0000	0x63D0
CRC-16 / T10-DIF	16	0x8BB7	0x0000	0	0	0x0000	0xD0DB
CRC-16 / TELEDISK	16	0xA097	0x0000	0	0	0x0000	0x0FB3
CRC-16 / TMS37157	16	0x1021	0x89EC	1	1	0x0000	0x26B1
CRC-16 / USB	16	0x8005	0xFFFF	1	1	0xFFFF	0xB4C8
CRC-A	16	0x1021	0xC6C6	1	1	0x0000	0xBF05
CRC-16 / KERMIT	16	0x1021	0x0000	1	1	0x0000	0x2189
CRC-16 / MODBUS	16	0x8005	0xFFFF	1	1	0x0000	0x4B37
CRC-16 / X-25	16	0x1021	0xFFFF	1	1	0xFFFF	0x906E
CRC-16 / XMODEM	16	0x1021	0x0000	0	0	0x0000	0x31C3
CRC-32	32	0x04C11DB7	0xFFFFFFFF	1	1	0xFFFFFFFF	0xCBF43926
CRC-32 / BZIP2	32	0x04C11DB7	0xFFFFFFFF	0	0	0xFFFFFFFF	0xFC891918
CRC-32C	32	0x1EDC6F41	0xFFFFFFFF	1	1	0xFFFFFFFF	0xE3069283
CRC-32D	32	0xA833982B	0xFFFFFFFF	1	1	0xFFFFFFFF	0x87315576
CRC-32 / MPEG-2	32	0x04C11DB7	0xFFFFFFFF	0	0	0x00000000	0x0376E6E7
CRC-32 / POSIX	32	0x04C11DB7	0x00000000	0	0	0xFFFFFFFF	0x765E7680
CRC-32Q	32	0x814141AB	0x00000000	0	0	0x00000000	0x3010BF7F
CRC-32 / JAMCRC	32	0x04C11DB7	0xFFFFFFFF	1	1	0x00000000	0x340BC6D9
CRC-32 / XFER	32	0x000000AF	0x00000000	0	0	0x00000000	0xBD0BE338

Parameters

base	The pointer to the CRYPTO instance.
polynomial	The polynomial (specified using 32 bits) used in the computing CRC.
dataReverse	The order in which data bytes are processed. 0 - MSB first; 1- LSB first.
dataXor	The byte mask for XORing data.
remReverse	A remainder reverse: 0 means the remainder is not reversed. 1 means reversed.
remXor	Specifies the mask with which the LFSR32 register is XORed to produce a remainder.

Returns: cy_en_crypto_status_t

◆ Cy_Crypto_Core_Crc()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc	(	CRYPTO_Type *	base,
		uint32_t *	crc,
		void const *	data,
		uint32_t	dataSize,
		uint32_t	lfsrInitState
	)

Performs the CRC calculation on a message.

Parameters

base	The pointer to the CRYPTO instance.
crc	The pointer to a computed CRC value. Must be 4-byte aligned.
data	The pointer to the message whose CRC is being computed.
dataSize	The size of a message in bytes.
lfsrInitState	The initial state of the LFSR.

Returns: cy_en_crypto_status_t

◆ Cy_Crypto_Core_Crc_CalcInit()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_CalcInit	(	CRYPTO_Type *	base,
		uint32_t	width,
		uint32_t	polynomial,
		uint32_t	dataReverse,
		uint32_t	dataXor,
		uint32_t	remReverse,
		uint32_t	remXor,
		uint32_t	lfsrInitState
	)

Initializes the CRC calculation.

Parameters

base	The pointer to the CRYPTO instance.
width	The CRC width in bits.
polynomial	The polynomial (specified using 32 bits) used in the computing CRC.
dataReverse	The order in which data bytes are processed. 0 - MSB first; 1 - LSB first.
dataXor	The byte mask for XORing data
remReverse	A remainder reverse: 0 means the remainder is not reversed. 1 means reversed.
remXor	Specifies the mask with which the LFSR32 register is XORed to produce a remainder.
lfsrInitState	The initial state of the LFSR.

Returns: cy_en_crypto_status_t

Function Usage: /* CRC parameters for some CRC algorithms:
+---------------------+-----+------------+------------+------+------+-----+------------+------------+
| CRC algorithm Name | CRC | Polynom | Initial | Data | Data | Rem | Remainder | Expected |
| | len | | seed | REV | XOR | REV | XOR | CRC |
| ------------------- | --- | ---------- |----------- | ---- | ---- | --- | ---------- | ---------- |
| CRC-6 / CDMA2000-A | 6 | 0x27 | 0x3F | 0 | 0 | 0 | 0x00 | 0x0D |
| CRC-6 / CDMA2000-B | 6 | 0x07 | 0x3F | 0 | 0 | 0 | 0x00 | 0x3B |
| CRC-6 / DARC | 6 | 0x19 | 0x00 | 1 | 0 | 1 | 0x00 | 0x26 |
| CRC-6 / ITU | 6 | 0x03 | 0x00 | 1 | 0 | 1 | 0x00 | 0x06 |
| CRC-8 / ITU | 8 | 0x07 | 0x00 | 0 | 0 | 0 | 0x55 | 0xA1 |
| CRC-8 / MAXIM | 8 | 0x31 | 0x00 | 1 | 0 | 1 | 0x00 | 0xA1 |
| CRC-8 / ROHC | 8 | 0x07 | 0xFF | 1 | 0 | 1 | 0x00 | 0xD0 |
| CRC-8 / WCDMA | 8 | 0x9B | 0x00 | 1 | 0 | 1 | 0x00 | 0x25 |
| CRC-16 / CCITT-0 | 16 | 0x1021 | 0xFFFF | 0 | 0 | 0 | 0x0000 | 0x29B1 |
| CRC-16 / CDMA2000 | 16 | 0xC867 | 0xFFFF | 0 | 0 | 0 | 0x0000 | 0x4C06 |
| CRC-32 | 32 | 0x04C11DB7 | 0xFFFFFFFF | 1 | 0 | 1 | 0xFFFFFFFF | 0xCBF43926 |
| CRC-32 / BZIP2 | 32 | 0x04C11DB7 | 0xFFFFFFFF | 0 | 0 | 0 | 0xFFFFFFFF | 0xFC891918 |
+---------------------+-----+------------+------------+------+------+-----+------------+------------+
*/
/* Use "CRC-16/CCITT-0" calculation */
#define CRC16CCITT_WIDTH (16u)
#define CRC16CCITT_POLYNOMIAL (0x1021)
#define CRC16CCITT_LFSR_SEED (0xffff)
#define CRC16CCITT_DATA_REVERSE (0u)
#define CRC16CCITT_DATA_XOR (0u)
#define CRC16CCITT_REM_REVERSE (0u)
#define CRC16CCITT_REM_XOR (0x0000)
uint8_t message[9] = "123456789";
uint32_t calculatedCrc = 0;
cy_en_crypto_status_t cryptoStatus;
/* Initialization Crypto operation */
cryptoStatus = Cy_Crypto_Core_Crc_CalcInit(
CRYPTO_HW,
CRC16CCITT_WIDTH,
CRC16CCITT_POLYNOMIAL,
CRC16CCITT_DATA_REVERSE,
CRC16CCITT_DATA_XOR,
CRC16CCITT_REM_REVERSE,
CRC16CCITT_REM_XOR,
CRC16CCITT_LFSR_SEED);
/* ... check for errors... */
/* Calculate CRC */
cryptoStatus = Cy_Crypto_Core_Crc_Calc(
CRYPTO_HW, /* Pointer to Crypto instance */
CRC16CCITT_WIDTH, /* CRC width in bits*/
&calculatedCrc, /* Pointer to CRC result */
(void*)message, /* Pointer to message */
sizeof(message)); /* Size of message */
/* ... check for errors... */

◆ Cy_Crypto_Core_Crc_CalcStart()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_CalcStart	(	CRYPTO_Type *	base,
		uint32_t	width,
		uint32_t	lfsrInitState
	)

Prepares the CRC calculation by setting an initial seed value.

Parameters

base	The pointer to the CRYPTO instance.
width	The CRC width in bits.
lfsrInitState	The initial state of the LFSR.

Returns: cy_en_crypto_status_t

◆ Cy_Crypto_Core_Crc_CalcPartial()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_CalcPartial	(	CRYPTO_Type *	base,
		void const *	data,
		uint32_t	dataSize
	)

Performs the CRC calculation of a message part.

Parameters

base	The pointer to the CRYPTO instance.
data	The pointer to the message whose CRC is being computed.
dataSize	The size of a message in bytes.

Returns: cy_en_crypto_status_t

◆ Cy_Crypto_Core_Crc_CalcFinish()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_CalcFinish	(	CRYPTO_Type *	base,
		uint32_t	width,
		uint32_t *	crc
	)

Finalizes the CRC calculation.

Parameters

base	The pointer to the CRYPTO instance.
width	The CRC width in bits.
crc	The pointer to a computed CRC value. Must be 4-byte aligned.

Returns: cy_en_crypto_status_t

◆ Cy_Crypto_Core_Crc_Calc()

__STATIC_INLINE cy_en_crypto_status_t Cy_Crypto_Core_Crc_Calc	(	CRYPTO_Type *	base,
		uint32_t	width,
		uint32_t *	crc,
		void const *	data,
		uint32_t	dataSize
	)

Performs the CRC calculation on a message.

Parameters

base	The pointer to the CRYPTO instance.
width	The CRC width in bits.
crc	The pointer to a computed CRC value. Must be 4-byte aligned.
data	The pointer to the message whose CRC is being computed.
dataSize	The size of a message in bytes.

Returns: cy_en_crypto_status_t

Function Usage: /* CRC parameters for some CRC algorithms:
+---------------------+-----+------------+------------+------+------+-----+------------+------------+
| CRC algorithm Name | CRC | Polynom | Initial | Data | Data | Rem | Remainder | Expected |
| | len | | seed | REV | XOR | REV | XOR | CRC |
| ------------------- | --- | ---------- |----------- | ---- | ---- | --- | ---------- | ---------- |
| CRC-6 / CDMA2000-A | 6 | 0x27 | 0x3F | 0 | 0 | 0 | 0x00 | 0x0D |
| CRC-6 / CDMA2000-B | 6 | 0x07 | 0x3F | 0 | 0 | 0 | 0x00 | 0x3B |
| CRC-6 / DARC | 6 | 0x19 | 0x00 | 1 | 0 | 1 | 0x00 | 0x26 |
| CRC-6 / ITU | 6 | 0x03 | 0x00 | 1 | 0 | 1 | 0x00 | 0x06 |
| CRC-8 / ITU | 8 | 0x07 | 0x00 | 0 | 0 | 0 | 0x55 | 0xA1 |
| CRC-8 / MAXIM | 8 | 0x31 | 0x00 | 1 | 0 | 1 | 0x00 | 0xA1 |
| CRC-8 / ROHC | 8 | 0x07 | 0xFF | 1 | 0 | 1 | 0x00 | 0xD0 |
| CRC-8 / WCDMA | 8 | 0x9B | 0x00 | 1 | 0 | 1 | 0x00 | 0x25 |
| CRC-16 / CCITT-0 | 16 | 0x1021 | 0xFFFF | 0 | 0 | 0 | 0x0000 | 0x29B1 |
| CRC-16 / CDMA2000 | 16 | 0xC867 | 0xFFFF | 0 | 0 | 0 | 0x0000 | 0x4C06 |
| CRC-32 | 32 | 0x04C11DB7 | 0xFFFFFFFF | 1 | 0 | 1 | 0xFFFFFFFF | 0xCBF43926 |
| CRC-32 / BZIP2 | 32 | 0x04C11DB7 | 0xFFFFFFFF | 0 | 0 | 0 | 0xFFFFFFFF | 0xFC891918 |
+---------------------+-----+------------+------------+------+------+-----+------------+------------+
*/
/* Use "CRC-16/CCITT-0" calculation */
#define CRC16CCITT_WIDTH (16u)
#define CRC16CCITT_POLYNOMIAL (0x1021)
#define CRC16CCITT_LFSR_SEED (0xffff)
#define CRC16CCITT_DATA_REVERSE (0u)
#define CRC16CCITT_DATA_XOR (0u)
#define CRC16CCITT_REM_REVERSE (0u)
#define CRC16CCITT_REM_XOR (0x0000)
uint8_t message[9] = "123456789";
uint32_t calculatedCrc = 0;
cy_en_crypto_status_t cryptoStatus;
/* Initialization Crypto operation */
cryptoStatus = Cy_Crypto_Core_Crc_CalcInit(
CRYPTO_HW,
CRC16CCITT_WIDTH,
CRC16CCITT_POLYNOMIAL,
CRC16CCITT_DATA_REVERSE,
CRC16CCITT_DATA_XOR,
CRC16CCITT_REM_REVERSE,
CRC16CCITT_REM_XOR,
CRC16CCITT_LFSR_SEED);
/* ... check for errors... */
/* Calculate CRC */
cryptoStatus = Cy_Crypto_Core_Crc_Calc(
CRYPTO_HW, /* Pointer to Crypto instance */
CRC16CCITT_WIDTH, /* CRC width in bits*/
&calculatedCrc, /* Pointer to CRC result */
(void*)message, /* Pointer to message */
sizeof(message)); /* Size of message */
/* ... check for errors... */

General Description

Functions

Function Documentation

◆ Cy_Crypto_Core_Crc_Init()

◆ Cy_Crypto_Core_Crc()

◆ Cy_Crypto_Core_Crc_CalcInit()

◆ Cy_Crypto_Core_Crc_CalcStart()

◆ Cy_Crypto_Core_Crc_CalcPartial()

◆ Cy_Crypto_Core_Crc_CalcFinish()

◆ Cy_Crypto_Core_Crc_Calc()