Static class for computing CRCs. More...

#include <CRC.h>

Classes
struct	Parameters
	CRC parameters. More...

struct	Table
	CRC lookup table. After construction, the CRC parameters are fixed. More...

Static Public Member Functions
template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	Calculate (const void *data, crcpp_size size, const Parameters< CRCType, CRCWidth > &parameters)
	Computes a CRC.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	Calculate (const void *data, crcpp_size size, const Parameters< CRCType, CRCWidth > &parameters, CRCType crc)
	Appends additional data to a previous CRC calculation.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	Calculate (const void *data, crcpp_size size, const Table< CRCType, CRCWidth > &lookupTable)
	Computes a CRC via a lookup table.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	Calculate (const void *data, crcpp_size size, const Table< CRCType, CRCWidth > &lookupTable, CRCType crc)
	Appends additional data to a previous CRC calculation using a lookup table.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	CalculateBits (const void *data, crcpp_size size, const Parameters< CRCType, CRCWidth > &parameters)
	Computes a CRC.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	CalculateBits (const void *data, crcpp_size size, const Parameters< CRCType, CRCWidth > &parameters, CRCType crc)
	Appends additional data to a previous CRC calculation.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	CalculateBits (const void *data, crcpp_size size, const Table< CRCType, CRCWidth > &lookupTable)
	Computes a CRC via a lookup table.

template<typename CRCType , crcpp_uint16 CRCWidth>
static CRCType	CalculateBits (const void *data, crcpp_size size, const Table< CRCType, CRCWidth > &lookupTable, CRCType crc)
	Appends additional data to a previous CRC calculation using a lookup table.

static const Parameters< crcpp_uint8, 8 > &	CRC_8 ()
	Returns a set of parameters for CRC-8 SMBus.

static const Parameters< crcpp_uint16, 16 > &	CRC_16_ARC ()
	Returns a set of parameters for CRC-16 ARC (aka CRC-16 IBM, CRC-16 LHA).

static const Parameters< crcpp_uint16, 16 > &	CRC_16_BUYPASS ()
	Returns a set of parameters for CRC-16 BUYPASS (aka CRC-16 VERIFONE, CRC-16 UMTS).

static const Parameters< crcpp_uint16, 16 > &	CRC_16_CCITTFALSE ()
	Returns a set of parameters for CRC-16 CCITT FALSE.

static const Parameters< crcpp_uint16, 16 > &	CRC_16_MCRF4XX ()
	Returns a set of parameters for CRC-16 MCRF4XX.

static const Parameters< crcpp_uint16, 16 > &	CRC_16_GENIBUS ()
	Returns a set of parameters for CRC-16 GENIBUS (aka CRC-16 EPC, CRC-16 I-CODE, CRC-16 DARC).

static const Parameters< crcpp_uint16, 16 > &	CRC_16_KERMIT ()
	Returns a set of parameters for CRC-16 KERMIT (aka CRC-16 CCITT, CRC-16 CCITT-TRUE).

static const Parameters< crcpp_uint16, 16 > &	CRC_16_X25 ()
	Returns a set of parameters for CRC-16 X-25 (aka CRC-16 IBM-SDLC, CRC-16 ISO-HDLC, CRC-16 B).

static const Parameters< crcpp_uint16, 16 > &	CRC_16_XMODEM ()
	Returns a set of parameters for CRC-16 XMODEM (aka CRC-16 ZMODEM, CRC-16 ACORN, CRC-16 LTE).

static const Parameters< crcpp_uint32, 32 > &	CRC_32 ()
	Returns a set of parameters for CRC-32 (aka CRC-32 ADCCP, CRC-32 PKZip).

static const Parameters< crcpp_uint32, 32 > &	CRC_32_BZIP2 ()
	Returns a set of parameters for CRC-32 BZIP2 (aka CRC-32 AAL5, CRC-32 DECT-B, CRC-32 B-CRC).

static const Parameters< crcpp_uint32, 32 > &	CRC_32_MPEG2 ()
	Returns a set of parameters for CRC-32 MPEG-2.

static const Parameters< crcpp_uint32, 32 > &	CRC_32_POSIX ()
	Returns a set of parameters for CRC-32 POSIX.

Detailed Description

Static class for computing CRCs.

Note: This class supports computation of full and multi-part CRCs, using a bit-by-bit algorithm or a byte-by-byte lookup table. The CRCs are calculated using as many optimizations as is reasonable. If compiling with C++11, the constexpr keyword is used liberally so that many calculations are performed at compile-time instead of at runtime.

Member Function Documentation

◆ Calculate() [1/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::Calculate	(	const void *	data,
		crcpp_size	size,
		const Parameters< CRCType, CRCWidth > &	parameters
	)

inlinestatic

Computes a CRC.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bytes
[in]	parameters	CRC parameters

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

Referenced by gr::satnogs::crc::append(), gr::satnogs::crc::check(), gr::satnogs::ax25::crc(), and gr::satnogs::ax25::crc_valid().

◆ Calculate() [2/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::Calculate	(	const void *	data,
		crcpp_size	size,
		const Parameters< CRCType, CRCWidth > &	parameters,
		CRCType	crc
	)

inlinestatic

Appends additional data to a previous CRC calculation.

Note: This function can be used to compute multi-part CRCs.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bytes
[in]	parameters	CRC parameters
[in]	crc	CRC from a previous calculation

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

◆ Calculate() [3/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::Calculate	(	const void *	data,
		crcpp_size	size,
		const Table< CRCType, CRCWidth > &	lookupTable
	)

inlinestatic

Computes a CRC via a lookup table.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bytes
[in]	lookupTable	CRC lookup table

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References CRC::Table< CRCType, CRCWidth >::GetParameters().

◆ Calculate() [4/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::Calculate	(	const void *	data,
		crcpp_size	size,
		const Table< CRCType, CRCWidth > &	lookupTable,
		CRCType	crc
	)

inlinestatic

Appends additional data to a previous CRC calculation using a lookup table.

Note: This function can be used to compute multi-part CRCs.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bytes
[in]	lookupTable	CRC lookup table
[in]	crc	CRC from a previous calculation

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References CRC::Table< CRCType, CRCWidth >::GetParameters().

◆ CalculateBits() [1/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::CalculateBits	(	const void *	data,
		crcpp_size	size,
		const Parameters< CRCType, CRCWidth > &	parameters
	)

inlinestatic

Computes a CRC.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bits
[in]	parameters	CRC parameters

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References crcpp_size.

◆ CalculateBits() [2/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::CalculateBits	(	const void *	data,
		crcpp_size	size,
		const Parameters< CRCType, CRCWidth > &	parameters,
		CRCType	crc
	)

inlinestatic

Appends additional data to a previous CRC calculation.

Note: This function can be used to compute multi-part CRCs.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bits
[in]	parameters	CRC parameters
[in]	crc	CRC from a previous calculation

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References crcpp_size.

◆ CalculateBits() [3/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::CalculateBits	(	const void *	data,
		crcpp_size	size,
		const Table< CRCType, CRCWidth > &	lookupTable
	)

inlinestatic

Computes a CRC via a lookup table.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bits
[in]	lookupTable	CRC lookup table

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References crcpp_size, and CRC::Table< CRCType, CRCWidth >::GetParameters().

◆ CalculateBits() [4/4]

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::CalculateBits	(	const void *	data,
		crcpp_size	size,
		const Table< CRCType, CRCWidth > &	lookupTable,
		CRCType	crc
	)

inlinestatic

Appends additional data to a previous CRC calculation using a lookup table.

Note: This function can be used to compute multi-part CRCs.

Parameters

[in]	data	Data over which CRC will be computed
[in]	size	Size of the data, in bits
[in]	lookupTable	CRC lookup table
[in]	crc	CRC from a previous calculation

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns: CRC

References crcpp_size, and CRC::Table< CRCType, CRCWidth >::GetParameters().

◆ CRC_16_ARC()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_ARC ( )

inlinestatic

Returns a set of parameters for CRC-16 ARC (aka CRC-16 IBM, CRC-16 LHA).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 ARC has the following parameters and check value:

polynomial = 0x8005
initial value = 0x0000
final XOR = 0x0000
reflect input = true
reflect output = true
check value = 0xBB3D

Returns: CRC-16 ARC parameters

◆ CRC_16_BUYPASS()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_BUYPASS ( )

inlinestatic

Returns a set of parameters for CRC-16 BUYPASS (aka CRC-16 VERIFONE, CRC-16 UMTS).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 BUYPASS has the following parameters and check value:

polynomial = 0x8005
initial value = 0x0000
final XOR = 0x0000
reflect input = false
reflect output = false
check value = 0xFEE8

Returns: CRC-16 BUYPASS parameters

◆ CRC_16_CCITTFALSE()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_CCITTFALSE ( )

inlinestatic

Returns a set of parameters for CRC-16 CCITT FALSE.

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 CCITT FALSE has the following parameters and check value:

polynomial = 0x1021
initial value = 0xFFFF
final XOR = 0x0000
reflect input = false
reflect output = false
check value = 0x29B1

Returns: CRC-16 CCITT FALSE parameters

◆ CRC_16_GENIBUS()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_GENIBUS ( )

inlinestatic

Returns a set of parameters for CRC-16 GENIBUS (aka CRC-16 EPC, CRC-16 I-CODE, CRC-16 DARC).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 GENIBUS has the following parameters and check value:

polynomial = 0x1021
initial value = 0xFFFF
final XOR = 0xFFFF
reflect input = false
reflect output = false
check value = 0xD64E

Returns: CRC-16 GENIBUS parameters

◆ CRC_16_KERMIT()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_KERMIT ( )

inlinestatic

Returns a set of parameters for CRC-16 KERMIT (aka CRC-16 CCITT, CRC-16 CCITT-TRUE).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 KERMIT has the following parameters and check value:

polynomial = 0x1021
initial value = 0x0000
final XOR = 0x0000
reflect input = true
reflect output = true
check value = 0x2189

Returns: CRC-16 KERMIT parameters

◆ CRC_16_MCRF4XX()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_MCRF4XX ( )

inlinestatic

Returns a set of parameters for CRC-16 MCRF4XX.

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 MCRF4XX has the following parameters and check value:

polynomial = 0x1021
initial value = 0xFFFF
final XOR = 0x0000
reflect input = true
reflect output = true
check value = 0x6F91

Returns: CRC-16 MCRF4XX parameters

◆ CRC_16_X25()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_X25 ( )

inlinestatic

Returns a set of parameters for CRC-16 X-25 (aka CRC-16 IBM-SDLC, CRC-16 ISO-HDLC, CRC-16 B).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 X-25 has the following parameters and check value:

polynomial = 0x1021
initial value = 0xFFFF
final XOR = 0xFFFF
reflect input = true
reflect output = true
check value = 0x906E

Returns: CRC-16 X-25 parameters

Referenced by gr::satnogs::ax25::crc(), and gr::satnogs::ax25::crc_valid().

◆ CRC_16_XMODEM()

const CRC::Parameters< crcpp_uint16, 16 > & CRC::CRC_16_XMODEM ( )

inlinestatic

Returns a set of parameters for CRC-16 XMODEM (aka CRC-16 ZMODEM, CRC-16 ACORN, CRC-16 LTE).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-16 XMODEM has the following parameters and check value:

polynomial = 0x1021
initial value = 0x0000
final XOR = 0x0000
reflect input = false
reflect output = false
check value = 0x31C3

Returns: CRC-16 XMODEM parameters

◆ CRC_32()

const CRC::Parameters< crcpp_uint32, 32 > & CRC::CRC_32 ( )

inlinestatic

Returns a set of parameters for CRC-32 (aka CRC-32 ADCCP, CRC-32 PKZip).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-32 has the following parameters and check value:

polynomial = 0x04C11DB7
initial value = 0xFFFFFFFF
final XOR = 0xFFFFFFFF
reflect input = true
reflect output = true
check value = 0xCBF43926

Returns: CRC-32 parameters

◆ CRC_32_BZIP2()

const CRC::Parameters< crcpp_uint32, 32 > & CRC::CRC_32_BZIP2 ( )

inlinestatic

Returns a set of parameters for CRC-32 BZIP2 (aka CRC-32 AAL5, CRC-32 DECT-B, CRC-32 B-CRC).

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-32 BZIP2 has the following parameters and check value:

polynomial = 0x04C11DB7
initial value = 0xFFFFFFFF
final XOR = 0xFFFFFFFF
reflect input = false
reflect output = false
check value = 0xFC891918

Returns: CRC-32 BZIP2 parameters

◆ CRC_32_MPEG2()

const CRC::Parameters< crcpp_uint32, 32 > & CRC::CRC_32_MPEG2 ( )

inlinestatic

Returns a set of parameters for CRC-32 MPEG-2.

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-32 MPEG-2 has the following parameters and check value:

polynomial = 0x04C11DB7
initial value = 0xFFFFFFFF
final XOR = 0x00000000
reflect input = false
reflect output = false
check value = 0x0376E6E7

Returns: CRC-32 MPEG-2 parameters

◆ CRC_32_POSIX()

const CRC::Parameters< crcpp_uint32, 32 > & CRC::CRC_32_POSIX ( )

inlinestatic

Returns a set of parameters for CRC-32 POSIX.

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-32 POSIX has the following parameters and check value:

polynomial = 0x04C11DB7
initial value = 0x00000000
final XOR = 0xFFFFFFFF
reflect input = false
reflect output = false
check value = 0x765E7680

Returns: CRC-32 POSIX parameters

◆ CRC_8()

const CRC::Parameters< crcpp_uint8, 8 > & CRC::CRC_8 ( )

inlinestatic

Returns a set of parameters for CRC-8 SMBus.

Note

The parameters are static and are delayed-constructed to reduce memory footprint.

CRC-8 SMBus has the following parameters and check value:

polynomial = 0x07
initial value = 0x00
final XOR = 0x00
reflect input = false
reflect output = false
check value = 0xF4

Returns: CRC-8 SMBus parameters

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

CRC.h

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Calculate() [1/4]

◆ Calculate() [2/4]

◆ Calculate() [3/4]

◆ Calculate() [4/4]

◆ CalculateBits() [1/4]

◆ CalculateBits() [2/4]

◆ CalculateBits() [3/4]

◆ CalculateBits() [4/4]

◆ CRC_16_ARC()

◆ CRC_16_BUYPASS()

◆ CRC_16_CCITTFALSE()

◆ CRC_16_GENIBUS()

◆ CRC_16_KERMIT()

◆ CRC_16_MCRF4XX()

◆ CRC_16_X25()

◆ CRC_16_XMODEM()

◆ CRC_32()

◆ CRC_32_BZIP2()

◆ CRC_32_MPEG2()

◆ CRC_32_POSIX()

◆ CRC_8()