stmbl/shared/crc16.h

93 lines
2.4 KiB
C
Raw Permalink Normal View History

2015-11-09 09:20:38 +00:00
/**
2015-12-02 01:34:17 +00:00
* \file crc16.h
2015-11-09 09:20:38 +00:00
* Functions and types for CRC checks.
*
2015-12-02 01:34:17 +00:00
* Generated on Wed Dec 2 02:28:13 2015,
2015-11-09 09:20:38 +00:00
* by pycrc v0.8.3, https://pycrc.org
* using the configuration:
2015-12-02 01:34:17 +00:00
* Width = 16
* Poly = 0x8005
* XorIn = 0x0000
2015-11-09 09:20:38 +00:00
* ReflectIn = True
2015-12-02 01:34:17 +00:00
* XorOut = 0x0000
2015-11-09 09:20:38 +00:00
* ReflectOut = True
* Algorithm = table-driven
*****************************************************************************/
2015-12-02 01:34:17 +00:00
#ifndef __CRC16_H__
#define __CRC16_H__
2015-11-09 09:20:38 +00:00
2015-12-02 01:34:17 +00:00
#include <stdlib.h>
2015-11-09 09:20:38 +00:00
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* The definition of the used algorithm.
*
* This is not used anywhere in the generated code, but it may be used by the
* application code to call algoritm-specific code, is desired.
*****************************************************************************/
#define CRC_ALGO_TABLE_DRIVEN 1
/**
* The type of the CRC values.
*
2015-12-02 01:34:17 +00:00
* This type must be big enough to contain at least 16 bits.
2015-11-09 09:20:38 +00:00
*****************************************************************************/
2015-12-02 01:34:17 +00:00
typedef uint_fast16_t crc16_t;
2015-11-09 09:20:38 +00:00
/**
* Reflect all bits of a \a data word of \a data_len bytes.
*
* \param data The data word to be reflected.
* \param data_len The width of \a data expressed in number of bits.
* \return The reflected data.
*****************************************************************************/
2015-12-02 01:34:17 +00:00
crc16_t crc16_reflect(crc16_t data, size_t data_len);
2015-11-09 09:20:38 +00:00
/**
* Calculate the initial crc value.
*
* \return The initial crc value.
*****************************************************************************/
2015-12-02 01:34:17 +00:00
static inline crc16_t crc16_init(void)
2015-11-09 09:20:38 +00:00
{
2015-12-02 01:34:17 +00:00
return 0x0000;
2015-11-09 09:20:38 +00:00
}
/**
* Update the crc value with new data.
*
* \param crc The current crc value.
* \param data Pointer to a buffer of \a data_len bytes.
* \param data_len Number of bytes in the \a data buffer.
* \return The updated crc value.
*****************************************************************************/
2015-12-02 01:34:17 +00:00
crc16_t crc16_update(crc16_t crc, const void *data, size_t data_len);
2015-11-09 09:20:38 +00:00
/**
* Calculate the final crc value.
*
* \param crc The current crc value.
* \return The final crc value.
*****************************************************************************/
2015-12-02 01:34:17 +00:00
static inline crc16_t crc16_finalize(crc16_t crc)
2015-11-09 09:20:38 +00:00
{
2015-12-02 01:34:17 +00:00
return crc ^ 0x0000;
2015-11-09 09:20:38 +00:00
}
#ifdef __cplusplus
} /* closing brace for extern "C" */
#endif
2015-12-02 01:34:17 +00:00
#endif /* __CRC16_H__ */