# LUT CRC CodeGen

**Repository Path**: Ficusdx/lut-crc-code-gen

## Basic Information

- **Project Name**: LUT CRC CodeGen
- **Description**: 专注于LUT CRC代码生成的开源项目，提供高效的CRC算法实现和优化工具，支持多种硬件平台，助力开发者快速集成CRC校验功能。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-14
- **Last Updated**: 2026-01-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: CRC, Generator

## README

# CRC代码生成配置文件

```ini
# *.ini
[CRC_FUNC_NAME]     ; Crc_function name
WIDTH       = 1     ; CRC calculate Width
TABLE_WIDTH = 8     ; Table Width
POLYNOMIAL  = 0x1   ; Polynomial(except the most bit)
REFLECT_IN  = false ; Reflect input
REFLECT_OUT = true  ; Reflect output
XOR_OUT     = 0x0   ; Output XOR
```

# 配置文件说明

| 必须设置的变量    | 可设置的值 | 描述|
|------------   |------------| ----|
| CRC_FUNC_NAME   | string   | 生成的函数名称 |
| WIDTH         | 1 ~ 32     | CRC 宽度|
| TABLE_WIDTH   | 4 \| 8     | CRC Table 计算宽度|
| POLYNOMIAL    | uint32_t   | 多项式  |
| REFLECT_IN    | true \| false| 是否反转输入|
| REFLECT_OUT   | true \| false| 是否反转输出|
| XOR_OUT       | uint32_t| 输出异或值|

```ini
;uint32_t 支持2种写法
POLYNOMIAL = 0xaaaa
POLYNOMIAL = 1234
```

# help

```bat
> lut-crc-codegen.exe <input_file_path> [-o<output_directory>]
```

# build 说明

1. make BUILD_TYPE=DEBUG all
    1. 生成 Debug 版 exe

2. make BUILD_TYPE=RELEASE all
    1. 生成 Release 版 exe

2. make BUILD_TYPE=RELEASE_TEST all
    1. 生成 Release 版 exe，附带测试代码生成功能
    2. 生成 test 使用的库

# 已测试环境
1. x86_64-windows11-gnu