为自建代码目录补齐 README,建立目录级导航体系

- 新增 26 份目录 README:App/(+log,task,util,protocol)、Drivers/BSP/(+8子系统)、
  Src/、Inc/、scripts/、tools/(+6子工具)、test/、MDK-ARM/、simulator/(+sim,tests)
- 每份含:定位、文件清单表、关键约束/陷阱、指向 docs 权威文档
- 第三方库与生成代码目录排除(CMSIS/HAL/Middlewares/Lib/SDL2)
- docs/文档规范.md 新增 §1.1b 代码目录 README 约定;根 README 目录结构加入说明
This commit is contained in:
2026-09-26 12:25:36 +08:00
parent 8d86fb1149
commit 39bd06adea
31 changed files with 1149 additions and 0 deletions
+33
View File
@@ -0,0 +1,33 @@
# Inc/ — CubeMX 生成的头文件
> ⚠️ **本目录文件由 STM32CubeMX 生成**(`.ioc` 重生成会覆盖),**不是自研代码**。
> 允许在 `USER CODE BEGIN/END` 标记区之间写自定义内容。
## 文件一览
| 文件 | 生成 | 作用 |
|---|---|---|
| `main.h` | CubeMX | 主头文件:引脚宏定义(`xxx_Pin` / `xxx_GPIO_Port`) |
| `FreeRTOSConfig.h` | CubeMX | **FreeRTOS 内核配置**(堆大小、tick、优先级位数等) |
| `stm32f4xx_hal_conf.h` | CubeMX | HAL 模块裁剪开关(启用/禁用各外设 HAL 模块) |
| `stm32f4xx_it.h` | CubeMX | 中断服务函数声明 |
| `gpio.h` / `dma.h` / `spi.h` / `i2c.h` / `usart.h` | CubeMX | 各外设初始化函数声明 |
## ⚠️ 修改约定
- 自定义内容只写 `USER CODE BEGIN xxx` / `USER CODE END xxx` 标记区之间
- 引脚宏(如 `CH395F_CS_Pin`)在 `main.h` 中定义,**改引脚须在 CubeMX 中改后重新生成**
## 关键配置速查
| 配置 | 值 | 位置 |
|---|---|---|
| FreeRTOS 堆 | `configTOTAL_HEAP_SIZE`(已迁 CCM) | `FreeRTOSConfig.h` |
| 栈溢出检查 | `configCHECK_FOR_STACK_OVERFLOW = 2` | `FreeRTOSConfig.h` |
| HAL 时基 | TIM7(`HAL_TIMEBASE` 覆盖) | `stm32f4xx_hal_conf.h` + `Src/` |
| NVIC 分组 | 4 位优先级 | CubeMX 配置 |
## 相关文档
- 内存/堆预算:`docs/内存管理/RAM使用分析与优化方案.md`
- 硬件引脚:根 `README.md`「外设接口」表