GRBL-Advanced/Libraries/CRC/CRC.h

88 wiersze
2.8 KiB
C

/*
CRC.h - Simple library to calculate 8-, 16-, and 32-Bit CRC
Copyright (c) 2018 Patrick F.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CRC_H_INCLUDED
#define CRC_H_INCLUDED
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
#define RUNTTIME 0
#define TABLE 1
#define HARDWARE 2
/* ---------- Defines for 8-bit SAE J1850 CRC calculation (Not reflected) ------------------------------------------------------- */
#define CRC_8_RESULT_WIDTH 8u
#define CRC_8_POLYNOMIAL 0x1Du
#define CRC_8_INIT_VALUE 0xFFu
#define CRC_8_XOR_VALUE 0xFFu
#define CRC_8_MODE TABLE
/* ---------- Defines for 16-bit CCITT CRC calculation (Not reflected) ---------------------------------------------------------- */
#define CRC_16_RESULT_WIDTH 16u
#define CRC_16_POLYNOMIAL 0x1021u
#define CRC_16_INIT_VALUE 0xFFFFu
#define CRC_16_XOR_VALUE 0x0000u
#define CRC_16_MODE RUNTTIME
/* ---------- Defines for 32-bit CCITT CRC calculation (Reflected) -------------------------------------------------------------- */
#define CRC_32_RESULT_WIDTH 32u
#define CRC_32_POLYNOMIAL 0x04C11DB7u
#define CRC_32_INIT_VALUE 0xFFFFFFFFu
#define CRC_32_XOR_VALUE 0xFFFFFFFFu
#define CRC_32_MODE RUNTTIME
void CRC_Init(void);
/**
* This function makes a CRC8 calculation on Length data bytes with SAEJ1850 parameters
*
* RETURN VALUE: 8 bit result of CRC calculation
*/
uint8_t CRC_CalculateCRC8(const uint8_t *Buffer, uint16_t Length);
/**
* This function makes a CRC16 calculation on Length data bytes
*
* RETURN VALUE: 16 bit result of CRC calculation
*/
uint16_t CRC_CalculateCRC16(const uint8_t *Buffer, uint16_t Length);
/**
* This function makes a CRC32 calculation on Length data bytes
*
* RETURN VALUE: 32 bit result of CRC calculation
*/
uint32_t CRC_CalculateCRC32(const uint8_t *Buffer, uint16_t Length);
#ifdef __cplusplus
}
#endif
#endif // CRC_H_INCLUDED