diff --git a/README.md b/README.md index f1ec269..0b61f0a 100644 --- a/README.md +++ b/README.md @@ -108,39 +108,165 @@ --- -## 板级配置 +## 板级配置(`Inc/board_config.h`) -编辑 `Inc/board_config.h` 可切换以下功能: +所有功能开关和引脚定义集中在 `Inc/board_config.h`。以下为完整的宏开关说明和推荐使用方式。 + +### 功能开关速查表 + +| 宏 | 作用 | 默认值 | Release 建议 | +|---|------|:---:|:---:| +| `SOFTWARE_IIC` | I2C 实现方式 | ❌ 硬件 | 硬件 | +| `DEBUG_MODE` | printf 串口输出 | ❌ 关闭 | ❌ | +| `COM_DEBUG` | 命令帧调试打印 | ❌ 关闭 | ❌ | +| `DEBUG_VERBOSE` | 详细调试信息 | ❌ 关闭 | ❌ | +| `SEGGER_RTT_DETECTION` | SEGGER RTT 支持 | ✅ 开启 | ❌ | + +--- + +### `SOFTWARE_IIC` — I2C 实现方式 + +选择 I2C 使用硬件外设还是软件 GPIO 模拟。 ```c -/* I2C 类型:软件 I2C 或 硬件 I2C */ -// #define SOFTWARE_IIC +// 使用软件 I2C(GPIO 模拟) +#define SOFTWARE_IIC + +// 使用硬件 I2C(外设 I2C0) —— 默认 #undef SOFTWARE_IIC +``` -/* 调试模式:开启 printf 输出 */ -// #define DEBUG_MODE +| 选项 | 优点 | 缺点 | +|------|------|------| +| 硬件 I2C | DMA 支持、CPU 占用低 | 仅限固定引脚、调试复杂 | +| 软件 I2C | 任意 GPIO、移植方便 | CPU 占用高、速率受限 | + +> 切换后需同步修改下方 I2C 引脚定义。 + +--- + +### `DEBUG_MODE` — 调试模式 + +开启后 USART0 输出 printf 调试信息。**Release 固件必须关闭。** + +```c +// 开启调试输出 +#define DEBUG_MODE + +// 关闭 —— 默认 #undef DEBUG_MODE +``` -/* 调试详细模式:I2C 扫描等额外信息 */ -// #define DEBUG_VERBOSE +**影响范围:** +- 使能 `USART0` 初始化和 `printf` 重定向到串口 +- 会占用 PA2/PA3 引脚和 USART0 硬件资源 +- 增加 ROM 约 2~4KB(取决于 printf 调用量) + +--- + +### `COM_DEBUG` — 命令帧调试打印 + +开启后串口命令解析过程打印每帧的详细内容(地址、长度、数据、校验)。**仅调试通信协议时开启。** + +```c +// 开启命令帧调试 +#define COM_DEBUG + +// 关闭 —— 默认 +#undef COM_DEBUG +``` + +**依赖:** 需要先开启 `DEBUG_MODE`,否则输出无法外发。 + +**输出示例:** +```text +[CMD] ADDR=01 LEN=05 DATA: AA BB CC DD EE CHK=OK +``` + +> ⚠️ Release 必须关闭,否则大量串口输出会严重拖慢主循环。 + +--- + +### `DEBUG_VERBOSE` — 详细调试信息 + +在 `DEBUG_MODE` 基础上输出更底层的信息,如 I2C 总线扫描结果、MCU 型号识别等。 + +```c +// 开启详细调试 +#define DEBUG_VERBOSE + +// 关闭 —— 默认 #undef DEBUG_VERBOSE ``` -引脚定义集中在同一文件中,按需修改: +**额外输出:** +- 启动时打印 MCU Flash 容量检测结果 +- I2C 初始化时扫描总线上的设备地址 +- 其他诊断信息 + +> 依赖 `DEBUG_MODE`,开启后 ROM 进一步增加约 1~2KB。 + +--- + +### `SEGGER_RTT_DETECTION` — SEGGER RTT 支持 + +RTT(Real-Time Transfer)是 SEGGER 的调试通道技术,通过 SWD 接口传输数据,不占用串口引脚,速度远超 UART。 ```c +// 启用 RTT —— 默认 +#define SEGGER_RTT_DETECTION + +// 禁用 +#undef SEGGER_RTT_DETECTION +``` + +**启用时:** +- 自动包含 `SEGGER_RTT.h`,提供 `RTT_printf` / `RTT_WriteString` / `RTT_PutChar` 宏 +- `SDK/SEGGER_RTT/` 模块参与编译和链接 +- 可用 J-Link RTT Viewer 或 VSCode + cortex-debug 查看实时日志 + +**禁用时:** +- RTT 宏展开为空操作,零开销 +- SEGGER_RTT 模块不参与编译 + +> **Release 建议关闭** — RTT 依赖调试器连接,量产固件中无意义且占用 ROM。 + +**依赖关系总览:** +``` +COM_DEBUG ──── 依赖 ──→ DEBUG_MODE +DEBUG_VERBOSE ─ 依赖 ──→ DEBUG_MODE +SEGGER_RTT_DETECTION ─ 独立,与 DEBUG_MODE 并行 +``` + +--- + +### 引脚定义 + +所有引脚宏集中在 `board_config.h` 尾部,按需修改: + +```c +/* I2C */ #define I2C_SCL_PORT GPIOF #define I2C_SCL_PIN GPIO_PIN_1 #define I2C_SDA_PORT GPIOF #define I2C_SDA_PIN GPIO_PIN_0 -#define LED_PORT GPIOA -#define LED_PIN GPIO_PIN_7 +/* LED */ +#define LED_RCU RCU_GPIOB +#define LED_PORT GPIOB +#define LED_PIN GPIO_PIN_1 +/* UART */ +#define UART_GPIO_PORT GPIOA #define UART_TX_PIN GPIO_PIN_2 #define UART_RX_PIN GPIO_PIN_3 +#define UART_BAUDRATE 115200U ``` +### MCU 型号自动检测 + +`board_config.c` 中的 `mcu_detect_and_config()` 上电自动识别 GD32E230 的 Flash 容量(F4=16K / F6=32K / F8=64K),结果存入全局变量 `g_mcu_flash_size`,并自动选择对应的 UART 外设(USART0 或 USART1)。 + --- ## Flash 偏移配置(配合 Bootloader)