为自建代码目录补齐 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:
@@ -0,0 +1,69 @@
|
||||
# MDK-ARM/ — Keil MDK-ARM v5 工程与构建/烧录/探针脚本
|
||||
|
||||
> **唯一工具链**:Keil MDK-ARM v5(ARMCC,C99)。本目录含工程文件、启动文件、
|
||||
> 命令行构建/烧录脚本,以及**台架探针与判读脚本**。
|
||||
|
||||
## 关键文件
|
||||
|
||||
| 文件/目录 | 作用 |
|
||||
|---|---|
|
||||
| `STM32F407-Demo.uvprojx` | **Keil 工程文件**(源文件清单、编译选项、目标配置) |
|
||||
| `STM32F407-Demo.uvoptx` | Keil 用户选项(调试器、断点等) |
|
||||
| `startup_stm32f407xx.s` | 启动文件(**`Heap_Size EQU 0x200`(512B)在此限定**) |
|
||||
| `build.bat` | **`@build` 命令行编译**(退出码 0=0 错 0 警;日志 `build_log.txt`) |
|
||||
| `download.bat` | 烧录(UV4 路径) |
|
||||
| `reset.bat` | **复位/烧录**(`ST-LINK_CLI`,见下) |
|
||||
|
||||
## 构建与烧录
|
||||
|
||||
```bash
|
||||
# 编译(相对路径,勿用绝对路径)
|
||||
& "MDK-ARM\build.bat" # 退出码 0 = 0 errors, 0 warnings
|
||||
|
||||
# 烧录 + 复位运行(推荐路径)
|
||||
& "MDK-ARM\reset.bat" flash <文件.hex|.bin>
|
||||
|
||||
# 仅复位
|
||||
& "MDK-ARM\reset.bat"
|
||||
```
|
||||
|
||||
### ⚠️ 烧录铁律
|
||||
|
||||
- `reset.bat flash` = `ST-LINK_CLI -c SWD -P <文件> -Rst -Run`——**`-Rst -Run` 不可省略**!
|
||||
裸 `-P` 会报 `Programming Complete`,但目标核处于异常状态时写入并不落地(芯片内容不变)
|
||||
- 烧录后**必须回读校验**:`ST-LINK_CLI -c SWD -CmpFile <文件> 0x08000000`(`No difference found` 才算真写入)
|
||||
- 本机 3 线接线(nRST 未接),**只重启不烧录**用 `reset.bat` 无参
|
||||
|
||||
## 台架探针与判读脚本
|
||||
|
||||
| 脚本 | 作用 |
|
||||
|---|---|
|
||||
| `bench_verdict.py` | 台架判读(把运行结果判为 PASS/FAIL) |
|
||||
| `ftp_freeze_probe.py` | FTP 上传+回读哈希(真实路径冻结探针) |
|
||||
| `ftp_abort_probe.py` | FTP 中止场景探针(Trap 23) |
|
||||
| `ftp_retr_abort_probe.py` | FTP RETR 中止探针 |
|
||||
| `tcp_reconnect_probe.py` | TCP 快速复连探针(Trap 22) |
|
||||
| `audit_runs.py` / `audit_tcpclient.py` | 运行记录审计 / TCP 客户端审计 |
|
||||
| `check_crecipe_content.py` | 检查创建配方内容 |
|
||||
|
||||
## 子目录
|
||||
|
||||
| 目录 | 内容 |
|
||||
|---|---|
|
||||
| `RTE/` | Keil Run-Time Environment 配置 |
|
||||
| `DebugConfig/` | 调试会话配置 |
|
||||
| `STM32F407-Demo/` | 构建输出(`.o`/`.axf`/`.map` 等,**产物不提交**) |
|
||||
| `bench_diag/` | 台架诊断数据 |
|
||||
| `retracted_bench_20260922/` | 已撤回的台架数据(存证) |
|
||||
|
||||
## ⚠️ 注意
|
||||
|
||||
- `build.bat` **硬编码本机 Keil 路径** `C:\Keil_v5\UV4\UV4.exe`(换机需改)
|
||||
- 本目录被 pre-commit 门禁**排除**
|
||||
- 启动文件的 `Heap_Size = 512B` 是**自研代码禁用 `malloc` 的根因**(见 `AGENTS.md`)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- 烧录/复位:`docs/测试说明/ST-LINK_CLI_复位使用说明.md`
|
||||
- 构建与验证:根 `AGENTS.md`「构建与验证」章
|
||||
- 测试流程:`docs/测试说明/自动化测试流程.md`
|
||||
Reference in New Issue
Block a user