CRC Library

1.简介

Crc Library 包括了常用8位、16位、32位CRC校验的函数库。

1.1目录结构

crclib 软件包目录结构如下所示：

crclib
├───inc                         // 头文件目录
│   │   crc.h                   // API 接口头文件
│   │   crc_cfg.h               // 配置头文件
│   │   typedef.h               // 数据类型定义头文件
│   │   crc8.h                  // 8位crc模块头文件
│   │   crc16.h                 // 16位crc模块头文件
│   │   crc32.h                 // 32位crc模块头文件
│   │   crc8_ex.h               // 8位crc扩展模块头文件
│   │   crc16_ex.h              // 16位crc扩展模块头文件
│   │   crc32_ex.h              // 32位crc扩展模块头文件
│   │   crc_hw_hc32.h           // hc32硬件crc模块头文件
│   │   crc_hw_n32.h            // n32硬件crc模块头文件
│   │   crc_hw_stm32.h          // stm32硬件crc模块头文件
│   │   crc_hw_sample.h         // 硬件crc使用示例头文件
│   └───crc16_ex_sample.h       // 16位crc扩展使用示例头文件
├───src                         // 源码目录
│   │   crc8.c                  // 8位crc模块
│   │   crc16.c                 // 16位crc模块
│   │   crc32.c                 // 32位crc模块
│   │   crc8_ex.c               // 8位crc扩展模块
│   │   crc16_ex.c              // 16位crc模块
│   │   crc32_ex.c              // 32位crc模块
│   │   crc_hw_hc32.c           // hc32硬件crc模块
│   │   crc_hw_n32.c            // n32硬件crc模块
│   │   crc_hw_stm32.c          // stm32硬件crc模块
│   │   crc_hw_sample.c         // 硬件crc使用示例
│   └───crc16_ex_sample.c       // 16位crc扩展使用示例
│   license                     // 软件包许可证
│   readme.md                   // 软件包使用说明
└───SConscript                  // RT-Thread 默认的构建脚本

1.2许可证

crclib package 遵循 LGPLv2.1 许可，详见 LICENSE 文件。

1.3依赖

• 无

2.使用

2.1接口函数说明

void crc8_table_init(void);

• 功能 ：初始化8位crc校验表
• 参数 ：无
• 返回 ：无

u8 crc8_cyc_cal(u8 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算8位crc校验值
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：8位crc计算结果

u8 crc8_cal(u8 *pdata, u32 len);

• 功能 ：计算8位crc校验值，初始值为0xFF，输出结果为计算值与0xFF的异或结果
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：8位crc计算结果

void crc16_table_init(void);

• 功能 ：初始化16位crc校验表
• 参数 ：无
• 返回 ：无

u16 crc16_cyc_cal(u16 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算16位crc校验值
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：16位crc计算结果

u16 crc16_cal(u8 *pdata, u32 len);

• 功能 ：计算16位crc校验值，初始值为0xFFFF，输出结果为计算值与0xFFFF的异或结果
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：16位crc计算结果

void crc32_table_init(void);

• 功能 ：初始化32位crc校验表
• 参数 ：无
• 返回 ：无

u32 crc32_cyc_cal(u32 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算32位crc校验值
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：32位crc计算结果

u32 crc32_cal(u8 *pdata, u32 len);

• 功能 ：计算32位crc校验值，初始值为0xFFFFFFFF，输出结果为计算值与0xFFFFFFFF的异或结果
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：32位crc计算结果

void crc8_ex_init(crc8_ex_inst_t *hinst, u8 poly);

• 功能 ：初始化8位crc扩展实例
• 参数 ：hinst--实例句柄
• 参数 ：poly--crc校验多项式
• 返回 ：无

u8 crc8_ex_cyc_cal(crc8_ex_inst_t *hinst, u8 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算8位crc校验值
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：8位crc计算结果

u8 crc8_ex_cal(crc8_ex_inst_t *hinst, u8 *pdata, u32 len);

• 功能 ：计算8位crc校验值，初始值为0xFF，输出结果为计算值与0xFF的异或结果
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：8位crc计算结果

void crc16_ex_init(crc16_ex_inst_t *hinst, u16 poly);

• 功能 ：初始化16位crc扩展实例
• 参数 ：hinst--实例句柄
• 参数 ：poly--crc校验多项式
• 返回 ：无

u16 crc16_ex_cyc_cal(crc16_ex_inst_t *hinst, u16 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算16位crc校验值
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：16位crc计算结果

u16 crc16_ex_cal(crc16_ex_inst_t *hinst, u8 *pdata, u32 len);

• 功能 ：计算16位crc校验值，初始值为0xFFFF，输出结果为计算值与0xFFFF的异或结果
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：16位crc计算结果

void crc32_ex_init(crc32_ex_inst_t *hinst, u32 poly);

• 功能 ：初始化32位crc扩展实例
• 参数 ：hinst--实例句柄
• 参数 ：poly--crc校验多项式
• 返回 ：无

u32 crc32_ex_cyc_cal(crc32_ex_inst_t *hinst, u32 init_val, u8 *pdata, u32 len);

• 功能 ：循环计算32位crc校验值
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：32位crc计算结果

u32 crc32_ex_cal(crc32_ex_inst_t *hinst, u8 *pdata, u32 len);

• 功能 ：计算32位crc校验值，初始值为0xFFFFFFFF，输出结果为计算值与0xFFFFFFFF的异或结果
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：32位crc计算结果

void crc_hw_init(crc_hw_inst_t *hinst, u32 poly);

• 功能 ：初始化硬件crc实例
• 参数 ：hinst--实例句柄
• 参数 ：poly--crc校验多项式
• 返回 ：无

u32 crc_hw_cyc_cal(crc_hw_inst_t *hinst, u32 init_val, u8 *pdata, u32 len);

• 功能 ：驱动硬件循环计算crc校验值
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：crc计算结果

u32 crc_hw_cal(crc_hw_inst_t *hinst, u8 *pdata, u32 len);

• 功能 ：驱动硬件计算crc校验值，初始值为0xFFFFFFFF，输出结果为计算值与0xFFFFFFFF的异或结果
• 参数 ：hinst--实例句柄
• 参数 ：init_val--计算初始值
• 参数 ：pdata--数据缓冲区指针
• 参数 ：len--数据长度
• 返回 ：crc计算结果

2.2获取组件

• 方式1： 通过 Env配置工具 或 RT-Thread studio 开启软件包，根据需要配置各项参数；配置路径为 RT-Thread online packages -> miscellaneous packages -> crc library

2.3配置参数说明

参数宏	说明
CRCLIB_USING_CRC8	使用8位CRC
CRCLIB_USING_CRC16	使用16位CRC
CRCLIB_USING_CRC32	使用32位CRC
CRC8_USING_CONST_TABLE	使用8位CRC常量校验表
CRC8_POLY	8位CRC校验多项式
CRC8_INIT_VAL	8位CRC校验初始值
CRC16_USING_CONST_TABLE	使用16位CRC常量校验表
CRC16_POLY	16位CRC校验多项式
CRC16_INIT_VAL	16位CRC校验初始值
CRC32_USING_CONST_TABLE	使用32位CRC常量校验表
CRC32_POLY	32位CRC校验多项式
CRC32_INIT_VAL	32位CRC校验初始值
CRCLIB_USING_CRC8_EX	使用8位CRC扩展模块
CRCLIB_USING_CRC16_EX	使用16位CRC扩展模块
CRCLIB_USING_CRC32_EX	使用32位CRC扩展模块
CRCLIB_USING_CRC16_EX_SAMPLE	使用16位CRC扩展模块使用示例
CRCLIB_USING_CRC_HW	使用硬件CRC模块
CRCLIB_USING_CRC_HW_SAMPLE	使用硬件CRC模块使用示例

3. 联系方式

• 维护：qiyongzhong
• 主页：https://gitee.com/qiyongzhong0/crclib