dsh-stm32 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +98 -31
- package/README_EN.md +96 -29
- package/docs/development-notes.md +837 -4
- package/docs/reading-guide.md +759 -0
- package/lib/commands/register.js +49 -0
- package/lib/data/chips.js +147 -30
- package/lib/data/clock-f1.js +158 -0
- package/lib/data/cmsis-sources.js +237 -42
- package/lib/data/device-facts.js +201 -0
- package/lib/data/stm32f1.js +130 -0
- package/lib/data/svd.js +627 -0
- package/lib/engine/assets.js +924 -0
- package/lib/engine/breakpoints.js +242 -0
- package/lib/engine/build.js +115 -16
- package/lib/engine/cache.js +56 -0
- package/lib/engine/clock-plan.js +608 -0
- package/lib/engine/cmake-sources.js +428 -0
- package/lib/engine/debug-session.js +153 -5
- package/lib/engine/debug.js +114 -15
- package/lib/engine/doctor.js +395 -4
- package/lib/engine/fetch.js +174 -30
- package/lib/engine/flash.js +70 -9
- package/lib/engine/generate.js +11 -0
- package/lib/engine/hal-chip.js +230 -0
- package/lib/engine/ioc-plan.js +33 -7
- package/lib/engine/msys2-install.js +332 -61
- package/lib/engine/probe-error.js +212 -0
- package/lib/engine/probe-session.js +311 -0
- package/lib/engine/project-export.js +129 -0
- package/lib/engine/register-clock.js +132 -0
- package/lib/engine/register-linker.js +129 -0
- package/lib/engine/register-template.js +115 -20
- package/lib/engine/regs.js +2 -0
- package/lib/engine/rtt.js +600 -0
- package/lib/engine/scaffold.js +104 -28
- package/lib/engine/zip.js +142 -0
- package/lib/index.js +10 -0
- package/lib/skill/stm32-workflow.js +3 -3
- package/lib/tools/assets.js +341 -0
- package/lib/tools/build.js +12 -0
- package/lib/tools/cache.js +47 -8
- package/lib/tools/debug-session.js +40 -5
- package/lib/tools/debug.js +41 -4
- package/lib/tools/doctor.js +22 -2
- package/lib/tools/flash.js +15 -3
- package/lib/tools/generate.js +3 -0
- package/lib/tools/ioc-apply.js +2 -0
- package/lib/tools/ioc-inspect.js +2 -0
- package/lib/tools/ioc-plan.js +198 -4
- package/lib/tools/project-create.js +50 -1
- package/lib/tools/project-export.js +100 -0
- package/lib/tools/regs.js +453 -61
- package/lib/tools/route-plan.js +3 -0
- package/lib/tools/rtt.js +347 -0
- package/package.json +5 -3
- package/templates/register/CMakeLists.txt +25 -6
- package/templates/register/Core/Inc/rtt.h +103 -0
- package/templates/register/Core/Src/main.c +43 -9
- package/templates/register/Core/Src/rtt.c +297 -0
- package/templates/scaffold/RTT.md +86 -0
- package/templates/scaffold/cmake/user/CMakeLists.txt +7 -0
- package/templates/scaffold/openocd.cfg +8 -0
package/README.md
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
# dsh-stm32
|
|
2
2
|
|
|
3
|
-
> 让 DSH 接管
|
|
3
|
+
> 让 DSH 接管 **STM32F1 全系**(F100/101/102/103/105/107)的整条开发链:探测工具链 → 建工程 → 改 .ioc(含时钟) → 生成代码 → 编译 → 调试 → 烧录。
|
|
4
4
|
|
|
5
|
-
**English:**
|
|
5
|
+
**English:** STM32F1 toolchain (F100/101/102/103/105/107) for DeepSeek Harness — probe the toolchain, scaffold a CMake project, edit .ioc as a transaction, build, flash without starting a debug session, and debug only when you ask for it.
|
|
6
6
|
|
|
7
7
|
[English](./README_EN.md) · [快速开始](#快速开始最小验证空目录到灯在闪) · [功能一览](#功能一览) · [工具参考](#工具参考) · [斜杠命令](#斜杠命令) · [设计要点](#设计要点) · [已知限制](#已知限制) · [排错](#排错) · [规格书](docs/dsh-stm32-plugin-规格.md)
|
|
8
8
|
|
|
9
9
|
[](https://github.com/JingYu-er/dsh-stm32)
|
|
10
10
|
[](LICENSE)
|
|
11
11
|
[](#已知限制)
|
|
12
|
-
[](#已知限制)
|
|
13
|
+
[](https://github.com/JingYu-er/dsh-stm32/releases)
|
|
14
14
|
|
|
15
|
-
这是一个 [DeepSeek Harness (DSH)](https://github.com/deepseek-ai/deepseek-harness) **插件**:注册
|
|
15
|
+
这是一个 [DeepSeek Harness (DSH)](https://github.com/deepseek-ai/deepseek-harness) **插件**:注册 21 个工具、7 条斜杠命令和 1 个随插件下发的 SKILL,让模型能直接探测工具链、建cubemx cmake工程、改 `.ioc`、跑 CubeMX、编译、烧录和调试,烧完再把寄存器里的状态读回来确认——实现更彻底的面向DSH硬件编程。
|
|
16
16
|
|
|
17
17
|
## 为什么需要它
|
|
18
18
|
|
|
19
19
|
大多数「让 AI 帮忙写 STM32」的做法停在代码层:它给你一段 `main.c`,至于这段代码能不能编译、烧进去灯到底闪没闪,还是你自己开 CubeMX、切终端、按 F5。**模型看不到板子,也就没法对自己的代码负责。**
|
|
20
20
|
|
|
21
|
-
这个插件把硬件侧也接到 DSH 上:`.ioc` 能读能改(事务 + 回滚)、代码落在 `USER CODE` 块里、生成和编译能拿到真实的报错行、烧录是一条**不经过调试器**的独立路径、烧完还能用寄存器把状态读回来。每一步都返回结构化证据(`planId`、`file:line:col`、`Verified OK`、`
|
|
21
|
+
这个插件把硬件侧也接到 DSH 上:`.ioc` 能读能改(事务 + 回滚)、代码落在 `USER CODE` 块里、生成和编译能拿到真实的报错行、烧录是一条**不经过调试器**的独立路径、烧完还能用寄存器把状态读回来。每一步都返回结构化证据(`planId`、`file:line:col`、`Verified OK`、`GPIOC.ODR` 的 bit13(有 SVD 时报告直接写 `ODR13=1`)),模型据此决定下一步,而不是猜。
|
|
22
22
|
|
|
23
23
|
这就是「更彻底的面向 DSH 硬件编程」:**模型不只是写代码——它能把代码烧进板子,再把板子上的状态从寄存器里读回来跟自己的预期对账。**
|
|
24
24
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
| 写代码 | 整文件编辑,一不小心写进生成区,重新生成就没了 | `stm32_code_patch` 只写 `USER CODE` 块,块外逐字节不动 |
|
|
30
30
|
| 编译 | 使用keil编译或使用vscode插件编写cmake文件 | DSH 通过/stm32-build [dir] [--clean] 自动编译 |
|
|
31
31
|
| 烧录 | 使用keil烧录或自己写 `tasks.json` 调 openocd | DSH 通过/stm32-debug [dir]自动烧录 |
|
|
32
|
-
| 验证 | 断点调试,自己查看寄存器的值 | 烧完用 `stm32_regs_read` 把状态读回来:`
|
|
32
|
+
| 验证 | 断点调试,自己查看寄存器的值 | 烧完用 `stm32_regs_read` 把状态读回来:`GPIOC.ODR` 两次采样看计数器递增(有 SVD 时直接显示 `ODR5=1`),`AFIO.MAPR` 确认 SWD 没被固件关掉 |
|
|
33
33
|
| 调试 | `F5` + 手动下断点、看完再关会话 | `stm32_debug_run` 停在 `main` 抓一次现场即释放;要连续调才开 `stm32_debug_session`,空闲自动关 |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -56,7 +56,9 @@ dsh plugin --profile desktop add github:JingYu-er/dsh-stm32#main
|
|
|
56
56
|
|
|
57
57
|
`dsh plugin` 做的事就是在 profile 目录里跑 `pnpm add`。装完它会把 `dsh-stm32` 写进该 profile 的 `dsh.profile.bundles`,重启 dsh 即生效(把 `desktop` 换成 `web` 就装到 web profile)。
|
|
58
58
|
|
|
59
|
-
装完确认:`dsh plugin --profile desktop why dsh-stm32` 应显示 `0.1.
|
|
59
|
+
装完确认:`dsh plugin --profile desktop why dsh-stm32` 应显示 `0.1.3`;重启后 `/stm32-doctor` 有输出。
|
|
60
|
+
|
|
61
|
+
> **首次使用要联网拉一次资源包**:插件不内置任何芯片表,设备事实(型号 → 启动文件 / 设备宏 / Flash·RAM 容量)在第一次用到时由 `stm32_assets` 自动装一次(`profile: "core"`,30 个文件约 237 KiB:芯片表 + 内存布局 + `.ioc` 模板 + 链接脚本)。装好之后整条链离线可用,换版本才会再联网。
|
|
60
62
|
|
|
61
63
|
|
|
62
64
|
**卸载**:`dsh plugin --profile desktop remove dsh-stm32`,重启 dsh。
|
|
@@ -68,7 +70,9 @@ git clone https://github.com/JingYu-er/dsh-stm32.git
|
|
|
68
70
|
cd dsh-stm32
|
|
69
71
|
npm install --no-audit --no-fund # 只装 typescript
|
|
70
72
|
npm run build # tsc -> lib/(提交前必须跑)
|
|
71
|
-
npm test # 可选:
|
|
73
|
+
npm test # 可选:497 个离线用例、34 个套件,不需要板子
|
|
74
|
+
npm run test:pack # 打包 tarball → 解包 → 用解包出来的 lib 真建一次寄存器工程
|
|
75
|
+
npm run test:size # 包体护栏:tarball ≤1.2 MB、templates ≤60 KB、包内不许二进制/图表
|
|
72
76
|
```
|
|
73
77
|
|
|
74
78
|
挂进 dsh 的 profile——**改代码时必须用 `link:`,不要用 `file:`**:
|
|
@@ -94,7 +98,9 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
94
98
|
| 3 | 按 `.ioc` 无头跑 CubeMX,产物落到 `Core/` | `stm32_generate` | 首次 130–175 s;之后再跑,`.ioc` 与产物都没变会**直接跳过**(<1 s) |
|
|
95
99
|
| 4 | 编译(首次自动 `cmake --preset`) | `stm32_build` | 配置 ~5 s + 编译 3 s |
|
|
96
100
|
| 5 | **只烧录**:program + verify + reset | `stm32_flash` | 2.1–2.6 s |
|
|
97
|
-
| 6 | 读回 `
|
|
101
|
+
| 6 | 读回 `GPIOC.ODR`(或地址 `0x4001100C`),确认状态确实在翻 | `stm32_regs_read` | 0.4–1.3 s |
|
|
102
|
+
|
|
103
|
+
> 第 6 步用的是符号写法(`GPIOC.ODR`)。它靠资源包里的 SVD 表:`stm32_assets action="refresh" profile="full"`(128 个文件,其中 SVD 1.71 MiB)。只装了 `core` 也能读——但要写地址 `0x4001100C`,报告里没有寄存器名,也没有位域解释。
|
|
98
104
|
|
|
99
105
|
模型侧就是一句话:「在 `D:\work\blink` 建一个 STM32F103C8T6 的闪灯工程,编译并烧进去」。想自己敲就:
|
|
100
106
|
|
|
@@ -105,6 +111,7 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
105
111
|
/stm32-flash # 只烧录,不进调试会话
|
|
106
112
|
/stm32-debug # 烧录 + 停在 main
|
|
107
113
|
/stm32-stop # 关掉调试会话,把探针还给 VS Code
|
|
114
|
+
/stm32-setup # 体检 + 安装计划(说「装」才真装)
|
|
108
115
|
```
|
|
109
116
|
|
|
110
117
|
### 这只是最小验证,不是能力上限
|
|
@@ -118,10 +125,10 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
118
125
|
| 多源文件、自己写的模块 | 写进 `cmake/user/CMakeLists.txt`,模板已留好位置 | 位置就位;未单独实测 |
|
|
119
126
|
| 业务代码 | `stm32_code_patch` 按块写入,重新生成时按标签搬回 | 已实测(append / replace / 标签写错会列出全部可用标签) |
|
|
120
127
|
| 调参数、改时钟 | `.ioc` 事务:先 diff → SHA 校验 → 备份 → 失败回滚 | 已实测 |
|
|
121
|
-
| 烧完确认外设真的在动 | `stm32_regs_read`
|
|
128
|
+
| 烧完确认外设真的在动 | `stm32_regs_read` 读任意外设寄存器——符号名 `TIM2.CNT` / `USART1.SR` / `ADC1.DR`…或物理地址 `0x40000024`;只写外设名 `GPIOC` 就把它的 7 个寄存器整体 dump。也可以 `stm32_debug_eval` 读变量 | 地址写法已上板实测(`0x4001100C` / `0x40010004`);符号名与位域解释用真实资源包 + 假探针验证,**真机待复测**(开发笔记 §31.11) |
|
|
122
129
|
| 出问题要看现场 | `stm32_debug_run` 停在 `main` 抓一次;要连续调就开 `stm32_debug_session` + `stm32_debug_eval` | 已实测(停在 `main () at main.c:67`) |
|
|
123
130
|
|
|
124
|
-
所以闪灯是验收用的最小样例,不是这套工具的能力上限:**它覆盖的是整条工程链,而不是一个 demo。** 真正的边界在[已知限制](#已知限制)
|
|
131
|
+
所以闪灯是验收用的最小样例,不是这套工具的能力上限:**它覆盖的是整条工程链,而不是一个 demo。** 真正的边界在[已知限制](#已知限制)里——芯片支持 F1 全系(F100/101/102/103/105/107,本机验证板是 C8T6)但只到 F1、宿主只在 Windows 上验证、探针默认 CMSIS-DAP,以及上面那条「新增外设要手工补 HAL 源」。外设种类本身不受工具限制:`.ioc` 里配得出来的,生成、编译、烧录、读回都走同一条链;只是除闪灯外还没有逐项上板实测,正式开项目前先跑一遍 `stm32_doctor`。
|
|
125
132
|
|
|
126
133
|
## 功能一览
|
|
127
134
|
|
|
@@ -131,14 +138,17 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
131
138
|
| 开工前门禁 | 每个会动工具链的工具先过 `ensureToolchain`:缺件就拦住并写清装什么、缺了会怎样;`envCheck: "block"`(默认)/ `"warn"` / `"off"` 由调用方决定 |
|
|
132
139
|
| 装工具链 | `stm32_env_install`:先只出计划(下载什么、多大、要改哪条 PATH),你点头才真装 MSYS2 + 5 个 pacman 包 + 用户级 PATH,装完自己写进配置文件 |
|
|
133
140
|
| 选技术路线 | `stm32_route_plan`:先按**这个工程**的需求,把每个外设的 HAL 版与寄存器版代价摆出来(效率 / 可读性 / 排错),再告诉你缺的是「能代装的」还是「只能人装的」(CubeMX 是 GUI 向导 + 要 ST 账号、固件包只由 CubeMX 包管理器维护) |
|
|
134
|
-
|
|
|
141
|
+
| 设备事实(型号 → 启动文件 / 设备宏 / 容量) | 插件**不内置芯片表**:型号、启动文件、设备宏、Flash/RAM 这些事实只从本地资源包缓存读(`~/.dsh-stm32/assets/<版本>/device/f1/chips.json`,`DSH_STM32_ASSETS` 可换根目录),第一次用到时自动装一次(`stm32_assets` 的 `refresh`),装好之后离线可用。没网又没缓存时 `stm32_project_create` / `stm32_doctor` 会明说「先跑 stm32_assets refresh,或检查网络」,不会拿内置表凑一个可能错的启动文件名 |
|
|
142
|
+
| 从零建工程 | `stm32_project_create`:`route: "hal"` 用模板快照 + 固件包 Drivers(与 CubeMX GUI 新建的工程逐字节一致);`route: "register"` 建不用 CubeMX 的寄存器版工程,CMSIS 模板首次从网上下到缓存、之后复用(每个文件都钉了上游 sha256,改过就拒绝落盘);`mcu` 指定型号(两条路线都吃;HAL 路线按型号渲染启动文件 / 设备宏 / `<DeviceId>_FLASH.ld`);两条路线都会带一份 `openocd.cfg`(CMSIS-DAP + `hla_swd` + 2 MHz) |
|
|
143
|
+
| 导出工程 | `stm32_project_export`:源码打成一个 zip(默认不带 `build/`、`.dsh-stm32/`、`node_modules/`、`.git/`),可选把 `.elf` 一起带上,并写一份开箱 README |
|
|
135
144
|
| `.ioc` 事务 | `stm32_ioc_inspect`(只读解析)→ `stm32_ioc_plan`(算 diff,不写盘)→ `stm32_ioc_apply`(SHA 校验 + 备份 + 回滚) |
|
|
136
145
|
| 只改 USER CODE | `stm32_code_patch`:只写 `/* USER CODE BEGIN X */` 与 `END X` 之间,块外逐字节不动 |
|
|
137
146
|
| 生成代码 | `stm32_generate`:无头 CubeMX + 按 ST 结构落位 + USER CODE 按标签搬回 |
|
|
138
|
-
| 编译 | `stm32_build`:构建目录与 `.elf` 自动推断、错误去重、链接后解析 RAM/FLASH
|
|
139
|
-
| 烧录 | `stm32_flash`:openocd `program verify reset exit`,烧完释放探针;烧前检查 `.ioc` 是否开了 Serial Wire |
|
|
147
|
+
| 编译 | `stm32_build`:构建目录与 `.elf` 自动推断、错误去重、链接后解析 RAM/FLASH 占用;`artifacts` 里要 `hex` / `bin` 就用同一套 `arm-none-eabi-objcopy` 转出来 |
|
|
148
|
+
| 烧录 | `stm32_flash`:openocd `program verify reset exit`,烧完释放探针;烧前检查 `.ioc` 是否开了 Serial Wire;失败时给结构化 `probeError`(`kind` / `cause` / `hint` / `evidence` / `retryable`,`kind` 收 8 类) |
|
|
140
149
|
| 调试 | `stm32_debug_run` / `stm32_debug_session` / `stm32_debug_eval` / `stm32_debug_stop` |
|
|
141
|
-
| 验证"真的在跑" | `stm32_regs_read
|
|
150
|
+
| 验证"真的在跑" | `stm32_regs_read`:按地址或符号名(`GPIOC.ODR`)把任意外设寄存器读回来,有 SVD 时顺带解位域(`→ ODR5=1`);halt 读值后 `resume`,不复位芯片 |
|
|
151
|
+
| 固件日志(RTT) | `stm32_rtt`:控制块按 SEGGER 约定放在 RAM,openocd 的 `rtt setup/start/server start` 把通道 0 搬成 TCP 流,再按 13 字节头解出级别与时间戳——不接串口、不改接线 |
|
|
142
152
|
| 给模型的工作纪律 | 随插件下发 SKILL `stm32-workflow`(只改 USER CODE、不动生成区、烧录与调试分开、结论要带寄存器证据) |
|
|
143
153
|
|
|
144
154
|
## 工具参考
|
|
@@ -151,8 +161,10 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
151
161
|
| `stm32_env_install` | 缺工具链时的一条龙:`dryRun`(默认)只给计划——官方 MSYS2 安装包多大、要装哪 5 个包、PATH 会加哪一条;`dryRun: false` + `confirm: true` 才真干活(下载 → 装 MSYS2 → `pacman -S` → 写 **用户级** PATH → 自检 → 写 `~/.dsh-stm32/config.json`)。已装 msys64 时只补包。不做卸载 |
|
|
152
162
|
| `stm32_route_plan` | 动手前先把路线问清楚:`requirement` 必填(如「按键控制 LED,串口每秒打印一次状态」),返回 `verdict`(`register-ok` / `both-viable` / `hal-only` / `unclear`)、逐外设的 `halEffort`/`regEffort` 与 `advice`、两种写法的差别、落地的下一步、工具链缺件(每条标 `installability`:`auto` 可代装 / `manual` 只能人装)与手动安装指引全文。不做通用对照表——结论只对当前需求成立 |
|
|
153
163
|
| `stm32_doctor` | 一次回答三件事:工具链齐不齐、探针被谁占(`openocd.exe` / gdb 进程 / 3333 端口)、这个工程能不能烧 |
|
|
154
|
-
| `stm32_project_create` | 空目录 → 完整 CMake 工程。`route: "hal"`(默认)走 CubeMX 那套(含 `.vscode` 里"① 只烧录 / ② 烧录并调试"两份配置);`route: "register"` 建**不用 CubeMX、不用 HAL** 的寄存器版工程(`mcu`
|
|
164
|
+
| `stm32_project_create` | 空目录 → 完整 CMake 工程。`route: "hal"`(默认)走 CubeMX 那套(含 `.vscode` 里"① 只烧录 / ② 烧录并调试"两份配置);`route: "register"` 建**不用 CubeMX、不用 HAL** 的寄存器版工程(`mcu` 指定型号——F1 全系都吃;寄存器版从缓存取 CMSIS 头与启动文件,HAL 版按型号渲染启动文件 / 设备宏 / `.ld`)。目标目录非空默认拒绝,`overwrite: true` 才覆盖 |
|
|
165
|
+
| `stm32_assets` | 管**设备事实资源包**(芯片表 / 内存布局 / .ioc 模板 / 链接脚本 / SVD,不是 CMSIS 下载缓存):`action: "refresh"`(默认 `profile: "core"`,30 个文件约 237 KiB;已装同版本直接复用;`profile: "full"` 是 128 个文件,多加 SVD 等表)从 GitHub → jsDelivr → gitcode 多源拉 `manifest.json`,逐文件钉 sha256 装到 `~/.dsh-stm32/assets/<版本>/`;`list` / `verify` / `prune` 管各版本。**插件不再内置任何芯片表**,设备事实只从这里读,第一次用要联网装一次,装好后离线可用 |
|
|
155
166
|
| `stm32_cache` | 看 / 验 / 拉 / 清下载缓存:`action: "list"`(默认)列条目、`"verify"` 逐文件校验、`"fetch"` 按 `mcu` 拉一次模板(已缓存则直接复用,不联网)、`"purge"` 删条目(不给 `id` 就清空)。缓存里放的是"不属于插件、但建工程要用"的 CMSIS 设备头 + 启动文件 + 内核头,第一次用时才下载,之后一直复用 |
|
|
167
|
+
| `stm32_project_export` | 把工程打成一个 zip 交给别人:默认收源码、CMake、`.vscode`、`.ioc`,跳过 `build/`、`.dsh-stm32/`、`node_modules/`、`.git/`;`includePrebuilt: true` 把 `.elf` 一起带上,`readme: false` 不写包内 README,`outDir` 指定落点(默认工程同级的 `<name>-export.zip`) |
|
|
156
168
|
| `stm32_firmware_install` | 缺固件包时的一条龙:`dryRun`(默认)只出计划——装到哪、下哪两个源码仓、几条自检判据;`dryRun: false` + `confirm: true` 才真下(GitHub 上 HAL 驱动与 CMSIS 设备支持两个源码包 + 内核头,合计约 2 MB),组装成与官方同构的 `STM32Cube_FW_<族>_V<版本>` 包(自写 `package.xml`)并过五条自检。已有官方包时什么都不做;默认装到 `<CubeMX 根>/dsh-firmware`(不是 `Repository`——塞自造版本号会被 CubeMX 静默忽略),生成时由 `stm32_generate` 用 `setCustomFWPath` 指过去 |
|
|
157
169
|
|
|
158
170
|
### .ioc:只读与事务
|
|
@@ -160,7 +172,7 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
160
172
|
| 工具 | 作用 |
|
|
161
173
|
| --- | --- |
|
|
162
174
|
| `stm32_ioc_inspect` | 解析 MCU 型号、引脚/信号/标签、外设与中断、时钟树、工程设置;会报「没开 Serial Wire 会生成 `SWJ_DISABLE`」这类致命风险 |
|
|
163
|
-
| `stm32_ioc_plan` | 改 `.ioc` 的第一步:算出逐键 diff 与源 SHA-256,返回 `planId`,**不动源文件**。支持改键、删键、按引脚表加 GPIO、一键补 Serial Wire |
|
|
175
|
+
| `stm32_ioc_plan` | 改 `.ioc` 的第一步:算出逐键 diff 与源 SHA-256,返回 `planId`,**不动源文件**。支持改键、删键、按引脚表加 GPIO、一键补 Serial Wire、按目标频率改时钟(`clock: { targetHz }`,就近取档 + 派生键重算 + 逐外设频率) |
|
|
164
176
|
| `stm32_ioc_apply` | 必须带 `planId`;写盘前再核 SHA(中途被手改就拒绝),备份后原子替换,写完重新解析校验,不过自动回滚。支持 `rollbackFrom` |
|
|
165
177
|
|
|
166
178
|
### 代码与构建
|
|
@@ -169,18 +181,46 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
169
181
|
| --- | --- |
|
|
170
182
|
| `stm32_code_patch` | 只在 `USER CODE` 块内 replace/append;块外字节(含 CRLF)原样保留;写前备份、临时文件 + rename 原子替换。标签写错会把该文件所有可用标签列给你 |
|
|
171
183
|
| `stm32_generate` | 无头跑 `java -jar STM32CubeMX.exe -q`,成功后落位到 `Core/Src`、`Core/Inc`,旧文件的 USER CODE 按标签搬进新内容。默认后台 job。**`.ioc`、CubeMX 版本、产物 hash 都没变时直接复用上次结果**(`skipped: true`,约 1 s;传 `skipIfUnchanged: false` 或删 `.dsh-stm32/generate-cache.json` 可强制重跑)。工程没用 X-CUBE 扩展包时(`Mcu.ThirdPartyNb=0`)会自动把 `~/.stm32cubemx/thirdparties/pdsc` 临时停放、跑完还原,省约 25 s;要保留索引传 `thirdpartyPacks: "keep"`。**要不要索引不靠关键词猜**:`.ioc` 里的 `Mcu.ThirdParty0=STMicroelectronics.X-CUBE-ALGOBUILD.1.4.0` 会跟内置的 X-CUBE 包目录(67 个包,`scripts/gen-xcube-catalog.mjs` 生成)对名字,本机缺这个包会提前在 notes 里警告 |
|
|
172
|
-
| `stm32_build` | `cmake --build`,构建目录从 `CMakePresets.json` 与 `build/*/CMakeCache.txt` 推断;首次构建自动 configure;会拦住"CMakeCache 目录不一致但 ninja 退出码 0"
|
|
184
|
+
| `stm32_build` | `cmake --build`,构建目录从 `CMakePresets.json` 与 `build/*/CMakeCache.txt` 推断;首次构建自动 configure;会拦住"CMakeCache 目录不一致但 ninja 退出码 0"的假成功。`artifacts: ["hex","bin"]` 时链接后用 `arm-none-eabi-objcopy` 转出,转换失败只记 note、不判编译失败 |
|
|
173
185
|
|
|
174
186
|
### 烧录与调试
|
|
175
187
|
|
|
176
188
|
| 工具 | 作用 |
|
|
177
189
|
| --- | --- |
|
|
178
|
-
| `stm32_flash` | **烧录**:openocd `program verify reset exit`,不建调试会话、不停 `main`。烧前读 `.ioc`,调试口没开就拒绝(见 [设计要点](#设计要点)
|
|
179
|
-
| `stm32_debug_run` | 起 openocd + gdb,`break main` → `continue` → 抓 pc/sp/lr/bt/locals → `reset run` + `detach`,不写 Flash
|
|
190
|
+
| `stm32_flash` | **烧录**:openocd `program verify reset exit`,不建调试会话、不停 `main`。烧前读 `.ioc`,调试口没开就拒绝(见 [设计要点](#设计要点))。失败会带结构化 `probeError`:`kind`(`no-probe` / `probe-busy` / `swd-locked` / `flash-protected` / `no-power` / `target-mismatch` / `timeout` / `unknown` 共 8 类)、`cause`(一句话根因)、`hint`(可执行的下一步,每类都有专属建议)、`evidence`(原始日志行)、`retryable`(照 hint 处理完再调一次有没有意义);成功时这个字段根本不出现。日志里找不到设备时,还会把 USB 形态(这台机器没有 USB / 没插探针 / 驱动异常)写进 notes |
|
|
191
|
+
| `stm32_debug_run` | 起 openocd + gdb,`break main` → `continue` → 抓 pc/sp/lr/bt/locals → `reset run` + `detach`,不写 Flash、不常驻。硬件断点 / 观察点超芯片上限(F1 是 6 个断点 / 4 个观察点)会在起 openocd **之前**就报错,不占探针 |
|
|
180
192
|
| `stm32_debug_session` | 常驻 openocd 会话(`.elf` 自动解析),空闲 90 s 自动关、硬上限 10 min |
|
|
181
193
|
| `stm32_debug_eval` | 在会话里执行 gdb 命令或读表达式(如 `g_led_blink_count`),读完立刻 `resume` + `detach` |
|
|
182
194
|
| `stm32_debug_stop` | 立刻释放探针,幂等 |
|
|
183
|
-
| `stm32_regs_read` |
|
|
195
|
+
| `stm32_regs_read` | 读寄存器,`addresses` 五种写法:物理地址 `0x4001100C` / `4001100C`、符号名 `GPIOC.ODR` / `GPIOC->ODR`、只写外设名 `GPIOC`(按偏移升序把它的 7 个寄存器整体 dump,上限 64 条)。装了资源包的 `full` profile 时,每条样本带规范化名与**置位位域**(`GPIOC.ODR (0x4001100C) = 0x00000020 → ODR5=1`);未知外设会列出可用的前 10 个(共 53 个),未知寄存器会列出该外设的已知寄存器;没有 SVD 时纯地址照读(只是没有名字与位域),符号名报错并提示 `stm32_assets refresh --profile full`。收尾用 `resume` 而不是 `reset run`,避免读一眼就把固件状态清零;连读时复用常驻 openocd 会话(毫秒级,不另起进程),没有会话才起一次并保留 90 s |
|
|
196
|
+
| `stm32_rtt` | **RTT 日志**(不占串口):`action: "start"` 先用 `mdw` 读三个字确认 RAM 里真有 `SEGGER RTT` 控制块(`addr` 填控制块起始地址,不是通道缓冲地址),再发 `rtt setup/start/server start`;没有活跃会话时自己起一个。`action: "dump"` 读 `seconds`(默认 3 s)或 `maxRecords`(默认 200 条),返回 `records[{ t, level, text }]`——`level` 是**保留到哪一级**(1 error / 2 warn / 3 info / 4 debug,默认 4 全要),`dropped` / `truncated` 如实报。`action: "stop"` 幂等(turn 结束也会自动停),`action: "status"` 看端口与已运行时长。目标必须**真在跑**(`rtt start` 读的是运行时 RAM)。失败带 `probeError`:控制块全 0 = 固件没调 `rtt_init()`、魔数不符 = `addr` 填错、连不上 = 会话掉了或 9090 端口被占 |
|
|
197
|
+
|
|
198
|
+
### 固件里怎么加 RTT(最短示例)
|
|
199
|
+
|
|
200
|
+
寄存器版工程(`route: "register"`)已经把 `Core/Src/rtt.c` 与 `Core/Inc/rtt.h` 建好,但**默认没启用**:没人引用时 `--gc-sections` 会把它们连同 3 KB 环形缓冲一起丢掉(默认固件 1576 B RAM / 1368 B FLASH,`nm` 里没有 `_SEGGER_RTT`)。要开日志,只往 USER CODE 块里加三行:
|
|
201
|
+
|
|
202
|
+
```c
|
|
203
|
+
/* USER CODE BEGIN 2 */ /* 必须在时钟初始化之后:时间戳按 SystemCoreClock 换算 */
|
|
204
|
+
rtt_init();
|
|
205
|
+
rtt_printf(RTT_LEVEL_INFO, "boot: sysclk=%lu", (unsigned long)SystemCoreClock);
|
|
206
|
+
/* USER CODE END 2 */
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
(`rtt.h` 已经在 `Core/Inc` 里,也可以再显式写一行 `#include "rtt.h"` 到 `USER CODE BEGIN Includes`。)编译后在宿主侧取控制块地址:
|
|
210
|
+
|
|
211
|
+
```powershell
|
|
212
|
+
arm-none-eabi-nm build/Debug/<工程名>.elf | findstr _SEGGER_RTT
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
然后让模型跑这三步(下面是 `stm32_rtt` 的三次工具调用,参数名与工具 schema 一致):
|
|
216
|
+
|
|
217
|
+
```text
|
|
218
|
+
stm32_rtt action=start addr=0x20000DE0 # 控制块地址,来自上面那行 nm
|
|
219
|
+
stm32_rtt action=dump seconds=3 level=3 # 读 3 秒内 info 及以上级别
|
|
220
|
+
stm32_rtt action=stop # 释放端口;turn 结束也会自动停
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
启用后 RAM 从 1576 B 涨到 5232 B(3 个 1 KB 环 + 控制块,约占 C8T6 20 KB 的 1/4),FLASH 随 `rtt_printf` 变大(大头是 newlib 的 `vsnprintf`;只要纯文本就改用 `rtt_write` 可以省掉它)。HAL 工程不自带这份源:按 `templates/scaffold/RTT.md` 把 `templates/register/Core/Src/rtt.c` 拷成 `App/rtt.c`、挂进 `cmake/user/CMakeLists.txt`,再照上面三行放进 USER CODE 块。环满时是**整条丢弃**(不写半条),固件侧 `rtt_dropped_count()` 能查丢了多少。
|
|
184
224
|
|
|
185
225
|
## 斜杠命令
|
|
186
226
|
|
|
@@ -189,6 +229,7 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
189
229
|
| 命令 | 做什么 | 会不会动板子 |
|
|
190
230
|
| --- | --- | --- |
|
|
191
231
|
| `/stm32-doctor` | 体检:工具链、被占用的调试进程、端口、`.elf`、`.ioc` 告警 | 否 |
|
|
232
|
+
| `/stm32-setup` | 体检 + 安装计划一次跑完;命令里带「装」字才真装(例如 `/stm32-setup 装上缺的`) | 否 |
|
|
192
233
|
| `/stm32-env` | 看四项能力(编译 / 烧录 / 调试 / 生成代码)各缺什么、装什么、装完怎么自检;缺件也照常出卡片 | 否 |
|
|
193
234
|
| `/stm32-build [dir] [--clean]` | 编译,打印内存占用 / `.elf` / 错误 | 否 |
|
|
194
235
|
| `/stm32-flash [dir]` | **烧录**:program + verify + reset,不建调试会话、不下断点 | 是 |
|
|
@@ -205,6 +246,12 @@ pnpm add "link:D:\path\to\dsh-stm32"
|
|
|
205
246
|
- **烧前守卫。** 如果 `.ioc` 的 SYS 调试口不是 Serial Wire(PA13/PA14 缺失或被设成 `No_Debug`),CubeMX 会生成 `__HAL_AFIO_REMAP_SWJ_DISABLE()`——烧进去 SWD 立刻失联,只能 BOOT0 救砖。这种工程 `stm32_flash` 直接拒绝;确实要烧得显式传 `allowNoDebug: true`。
|
|
206
247
|
- **探针只有一块。** 烧录、调试、后台会话同一时刻只能有一个;`build` / `flash` / `debug_run` / `generate` 开跑前会先把占着探针的会话关掉。
|
|
207
248
|
|
|
249
|
+
## 芯片、链接脚本与时钟
|
|
250
|
+
|
|
251
|
+
- **型号是参数,不是常量。** `stm32_project_create` / `stm32_generate` 按 `mcu` 一起换三样:启动文件(`startup_stm32f103xe.s`)、设备宏(`STM32F103xE`)、链接脚本(`STM32F103RCTx_FLASH.ld`)。HAL 路线走 `src/engine/hal-chip.ts`(`resolveHalChip()` + `renderStartupAndDefine` / `renderLinkerScript` / `renderIoc`),寄存器路线走 `src/data/stm32f1.ts`(`resolveF1Chip()`,14 个容量档,每个启动文件都钉了上游 sha256)。认不出的型号直接给原因,不猜一个上游不存在的启动文件名。
|
|
252
|
+
- **链接脚本按 `DeviceId` 命名:`<DeviceId>_FLASH.ld`。** C8T6 → `STM32F103C8Tx_FLASH.ld`(64 KiB Flash / 20 KiB RAM),RCT6 → `STM32F103RCTx_FLASH.ld`(256 / 48),F107VCT6 → `STM32F107VCTx_FLASH.ld`(256 / 64)。模板里那份旧的 `STM32F103XX_FLASH.ld` 只作 C8T6 的兼容副本;CMake 的 `-T` 一律指向按型号渲染的那份(`pointLinkerFlagAt()` 把工具链文件里的旧名改指过去,避免两个 `-T` 让 ld 取错脚本)。
|
|
253
|
+
- **时钟就近,不可达就明说。** `stm32_ioc_plan` 的 `clock: { targetHz }`(也可 `pllMul` 钉死倍频、`pllSource` 选 HSE / HSI)枚举全部可行的 PLL 组合,取 |SYSCLK − 目标| 最小的一档,并把差距写进结论:要 60 MHz 时 F1 的 PLL 只能整数倍频、HSE 8 MHz 拼不出这一档,于是选 64 MHz 并标注「不可达,已选 64 MHz(+4 MHz)」(同距取更高档)。同一次 plan 里把 `SYSCLKFreq_VALUE` / `HCLKFre` / `PLLMUL` / APB1·APB2·ADC 分频这些派生键**全量重算**——只改 SYSCLK 不动它们,CubeMX 会按旧值重算或干脆不认;同时列出逐外设频率、UART 波特率的整除误差与几个备选档。超限(SYSCLK > 72 MHz、APB1 > 36 MHz、ADC > 14 MHz、USB 要 48 MHz 却不在 PLLCLK/1.5 这条路上)时**一个键都不写**。
|
|
254
|
+
- **烧前五项一致。** `stm32_doctor` 核对「`.ioc` 型号 ↔ 启动文件名 ↔ cmake 里的设备宏 ↔ `.ld` 的 MEMORY 容量 ↔ `.elf` 的 Flash 占用」,任一错配报 blocker。`.elf` 那份占用是读 ELF program header 的 `p_filesz` 累加,不是文件大小——带 `-g3` 时 20 KiB 固件的 `.elf` 能有 600 KB,按文件大小判会误报「超 Flash」。
|
|
208
255
|
## 配置
|
|
209
256
|
|
|
210
257
|
### 用户配置文件(`~/.dsh-stm32/config.json`)
|
|
@@ -311,21 +358,25 @@ source [find target/stm32f1x.cfg]
|
|
|
311
358
|
| 限制 | 说明 | 有没有办法 |
|
|
312
359
|
| --- | --- | --- |
|
|
313
360
|
| 只在 **Windows** 上验证 | `stm32_generate` 依赖 `<CubeMX>/STM32CubeMX.exe` + `jre/bin/java.exe`,Linux/macOS 上的 CubeMX 不是这个形态 | 暂无;烧录/调试/读寄存器在 Linux 上若 openocd 与 gdb 齐全可能可用,但未验证 |
|
|
314
|
-
|
|
|
361
|
+
| 只覆盖 **STM32F1 全系** | 型号 → 启动文件 / 设备宏 / 链接脚本的映射只做了 F1(`src/data/stm32f1.ts` + `src/engine/hal-chip.ts`,14 个容量档);时钟树也只认 F1(HSE 8 MHz、PLL ×2..×16、SYSCLK ≤72 MHz) | 加其它族要补真实仓库名与逐文件实测 sha256(`src/data/cmsis-sources.ts`、`src/data/firmware-packages.ts`)并补一份时钟上限表;引脚表可由本机 CubeMX `db/mcu/*.xml` 派生(`deriveChipPinTable`) |
|
|
315
362
|
| 默认探针是 **CMSIS-DAP** | 没有 `openocd.cfg` 时回退 cmsis-dap | 用 `openocd.cfg` 换 `interface/stlink.cfg`(见上) |
|
|
316
363
|
| 新增外设要**手工补 HAL 源** | 插件只落位 CubeMX 的 `Src/` 与 `Inc/`(→ `Core/Src`、`Core/Inc`),CubeMX 生成的 `cmake/stm32cubemx/CMakeLists.txt` 不搬;开了定时器/串口/ADC 之后要自己把 `stm32f1xx_hal_<外设>.c` 加进源清单 | 改工程里 `cmake/stm32cubemx/CMakeLists.txt` 的 `STM32_Drivers_Src`,或写进 `cmake/user/CMakeLists.txt` 的 `target_sources` |
|
|
317
364
|
| 生成/建工程需要 **CubeMX + F1 固件包** | 固件包版本默认 `STM32Cube_FW_F1_V1.8.7` | 换版本传 `firmwarePackage` |
|
|
318
365
|
| 未在别人的机器上验证 | 本机:Windows 10 + MSYS2 UCRT64 + DAPLink + 蓝丸;其余组合靠反馈 | 遇到问题请附 `stm32_doctor` 的完整输出开 issue |
|
|
366
|
+
| **RTT 只有通道 0**,帧是我们自己的约定 | `stm32_rtt` 只解析通道 0,头是 13 字节(4 B 长度 + 1 B 级别 + 8 B 时间戳 + UTF-8 正文);既不是 defmt,也不是 SEGGER 原生裸字节——原生客户端(RTT Viewer / J-Link RTT Client)读通道 0 会把这 13 字节当正文。RTT 还依赖目标 RAM:不调 `rtt_init()` 就没有控制块,环满时整条丢 | 级别当过滤(`level: 3` 只看 info 以上),结构化内容塞进 `text` 里自己放 JSON;通道数与环大小改 `rtt.h` 的 `RTT_UP_CHANNELS` / `RTT_BUF_SIZE`(默认 3×1 KB = 3 KB `.bss`,C8T6 只有 20 KB);要 defmt 解码或原生 RTT 输出是另一个功能 |
|
|
367
|
+
| **寄存器符号名与位域解释要靠资源包的 `full` profile** | `GPIOC.ODR` / `GPIOC->ODR` 与外设 dump(只写 `GPIOC`)都从 `device/f1/svd/<line>.json` 解析,这份数据由 ST 的 SVD 派生(ST EULA,1.71 MiB),`core`(30 个文件约 237 KiB)里没有;覆盖线只有 100/101/102/103/105/107。没有 SVD 时纯地址照读,只是没有名字和位域;符号名会报错并提示怎么补 | `stm32_assets action="refresh" profile="full"`(128 个文件);不想装就写 `0x` 开头的地址 |
|
|
319
368
|
|
|
320
369
|
## 排错
|
|
321
370
|
|
|
322
371
|
| 现象 | 原因与处理 |
|
|
323
372
|
| --- | --- |
|
|
373
|
+
| 装插件时 `ERR_PNPM_GIT_UNKNOWN_ERROR … connect ETIMEDOUT …:443` | 这是**取包这一跳**连不上 GitHub(`dsh plugin add github:…` 会走 git 去拉仓库),跟 pnpm 11 的 `allowBuilds` 白名单、包体签名、包本身都没关系——换个网络就能装上。三条路按省事程度排:① 用 npm 上的正式包:`dsh plugin --profile desktop add dsh-stm32`(走 npm registry,不碰 GitHub);② 一定要从 GitHub 装,就只给这一条命令挂代理,用进程级 `GIT_CONFIG_*` 临时生效、**不动你的全局 git 配置**:`$env:GIT_CONFIG_COUNT="1"; $env:GIT_CONFIG_KEY_0="http.https://github.com.proxy"; $env:GIT_CONFIG_VALUE_0="http://127.0.0.1:7890"; dsh plugin --profile desktop add github:JingYu-er/dsh-stm32#main`(端口换成你自己的);③ 绕开 git、直接吃 HTTPS 包:`dsh plugin --profile desktop add https://codeload.github.com/JingYu-er/dsh-stm32/tar.gz/refs/heads/main`。**装最新**永远用 `github:JingYu-er/dsh-stm32#main`,已经 publish 的版本用 `dsh-stm32@latest`——两者内容一致,后者不依赖 GitHub |
|
|
324
374
|
| 烧完连不上、SWD 失联 | 固件里生成了 `__HAL_AFIO_REMAP_SWJ_DISABLE()`。按住 BOOT0 上电进系统 bootloader 重烧,然后把 SYS 设回 Serial Wire——`stm32_flash` 现在会先拦这种情况 |
|
|
325
375
|
| `Error: No device found` / `transfer count mismatch` | 探针被别的进程占着。先 `/stm32-stop`,再用 `stm32_doctor` 看 openocd / gdb 进程与 3333 端口。调试会话开着时读寄存器不会再有这个问题:`stm32_regs_read` 复用会话的 openocd,不另起第二个 |
|
|
326
|
-
| 调试会话开着时读寄存器,`report.command` 是一条 `gdb-multiarch … target extended-remote 127.0.0.1:3333` | 这是「复用会话」的正常形态:`stm32_debug_session` 活着时,`stm32_regs_read`
|
|
376
|
+
| 调试会话开着时读寄存器,`report.command` 是一条 `gdb-multiarch … target extended-remote 127.0.0.1:3333` | 这是「复用会话」的正常形态:`stm32_debug_session` 活着时,`stm32_regs_read` 借用会话里那个 openocd,notes 会写清「复用调试会话(gdb 端口 N,tcl 端口 M),没有另起 openocd」。B3 之后默认走 **Tcl RPC 直读**(一条 TCP 连接:halt → 读 pc → 连续 `mdw` → resume,毫秒级),所以 `report.command` 是 `gdb-multiarch …` 只说明 Tcl 快路径没成、回退到了会话里的 gdb,原因写在 notes 里;只有没有会话时才另起 openocd。旧版在这里会报 `CMSIS-DAP transfer count mismatch: expected N, got M` |
|
|
327
377
|
| 编译"成功"但跑的是旧固件 | 复制或改名过带 `build/` 的工程:CMakeCache 里的目录对不上,ninja 仍退出 0。`stm32_build` 会判失败;按提示 clean 或删 `build/Debug` |
|
|
328
378
|
| 工具直接回「缺 arm-none-eabi-gcc…,这次没有开始编译」 | 这是开工前门禁(`envCheck` 默认 `block`)拦下来的,不是 bug:它比跑到一半才发现省时间。回一句「装」,模型调 `stm32_env_install` 出计划;确认后装好并写配置文件,**下一条命令就能用,不必重启**。想先看全貌就 `/stm32-env`;只想先跑起来就传 `envCheck: "warn"`(照做但写警告)或 `"off"`(不查) |
|
|
379
|
+
| 第一次建工程回「设备事实还没就绪……先跑 stm32_assets refresh,或检查网络」 | 插件不内置芯片表:型号 → 启动文件 / 设备宏 / Flash / RAM 的事实只从本地资源包缓存(`~/.dsh-stm32/assets/<版本>/`)读。联网跑一次 `stm32_assets`(`action: "refresh"`,默认 `profile: "core"`,30 个文件约 237 KiB),装好后离线可用;`DSH_STM32_ASSETS` 可换根目录 |
|
|
329
380
|
| `stm32_doctor` 说找不到 gcc / openocd | 先看 doctor 的 notes / 报错里的「查过 …」列表与自动发现结果;装上后还找不到就设 `STM32_BIN_DIRS` 或给工具传 `binDirs`。**不知道装什么就先跑 `stm32_env_probe`**:每条缺失项都带 `impact`(缺了影响哪些功能)、`install`(推荐装法,第一条最省事)、`verify`(装完自检),顶层 `recommendations` 给出安装顺序,还会问要不要帮你装 |
|
|
330
381
|
| `stm32_generate` 很慢或像卡住 | 首次(冷启动、无缓存)3.5–4 分钟属正常,之后 .ioc 与产物没变会直接跳过(<1 s)。默认后台 job,用 `job_output` 看进度,或传 `foreground: true` 同步等。想确认是不是漏命中缓存,看返回里的 `skipped` 与 notes 给的 reason |
|
|
331
382
|
| 生成没变化却每次都跑满 3 分钟 | 缓存键里含 CubeMX 的 size+mtime 与产物 hash:换过 CubeMX、改过生成区文件、或改过落位布局都会失效。看 notes 里的 reason,或删 `.dsh-stm32/generate-cache.json` 从干净状态重来 |
|
|
@@ -337,12 +388,25 @@ source [find target/stm32f1x.cfg]
|
|
|
337
388
|
|
|
338
389
|
```powershell
|
|
339
390
|
npm run build # tsc -> lib/(lib/ 入库,改完 src 必须重建后一起提交)
|
|
340
|
-
npm test #
|
|
391
|
+
npm test # 34 个离线套件、497 个用例;不需要板子、CubeMX、工具链
|
|
392
|
+
npm run test:pack # 把包打成 tarball、解开、用解包出来的 lib 真建一次寄存器工程
|
|
393
|
+
npm run test:size # 包体护栏:tarball ≤1.2 MB、templates ≤60 KB、包内不许二进制/图表
|
|
341
394
|
```
|
|
342
395
|
|
|
343
|
-
CI(`.github/workflows/ci.yml`)在每次 push / PR 上跑 `npm ci → build → 检查提交的 lib/ 是否与 src/ 同步 → npm test`(windows-latest)。
|
|
396
|
+
CI(`.github/workflows/ci.yml`)在每次 push / PR 上跑 `npm ci → build → 检查提交的 lib/ 是否与 src/ 同步 → npm test → test:pack → test:size`(windows-latest)。
|
|
397
|
+
|
|
398
|
+
GitHub runner 上没有 msys64 / CubeMX,所以有两条依赖真固件包的脚手架用例会 skip:CI 上是 **495 pass + 2 skipped**,开发机上是 497 全跑。离线套件只读仓库自带的 [`test/fixtures/`](test/fixtures/README.md);会话类用例用 `fakeBinDirs()` 在临时目录造空文件占位的 openocd / gdb,不依赖本机装了什么。
|
|
399
|
+
|
|
400
|
+
### 发布形态三分法(先把东西放哪想清楚,再写包)
|
|
401
|
+
|
|
402
|
+
| 放哪 | 内容 | 量级 |
|
|
403
|
+
| --- | --- | --- |
|
|
404
|
+
| 随包(npm tarball) | `lib/**`(含 `lib/client.js`)、`client/client.js`、`templates/scaffold/**`、`cordis.patch.yml`、两份 README、`LICENSE`、`docs/*.md` | 99 个文件 / 525.7 KB,解包 1538.3 KB;其中 `templates/**` 38.5 KB |
|
|
405
|
+
| 进 git 不进包 | `src/**`、`test/**`、`scripts/**`、`docs/diagrams/**`(两张可交互 HTML) | diagrams 2 MB 原始 / 891 KB gz;`package.json` 的 `files` 把 `docs` 收窄成 `docs/*.md` |
|
|
406
|
+
| 远端按需下载 | CMSIS 设备头 / 启动文件 / 内核头(寄存器版首次用时下到缓存,逐文件钉 sha256);HAL 固件包;**设备事实资源包**(chips.json / memory.json / .ioc 模板 / .ld / SVD,core 30 个文件约 237 KiB、full 128 个文件——SVD 在 full 里;插件不再内置芯片表,首次使用要联网拉一次 `stm32_assets refresh`,之后离线可用) | 缓存可用 `stm32_cache list/verify/purge` 与 `stm32_assets list/verify/prune` 管 |
|
|
407
|
+
| 现造 | `.ioc` 内容(`renderIoc`)、`.ld` 的 MEMORY(`renderLinkerScript`)、cmake 源清单 | 按型号渲染,模板里不落盘 |
|
|
344
408
|
|
|
345
|
-
|
|
409
|
+
护栏是 `scripts/pack-size.mjs`(`npm run test:size`):tarball ≤ 1.2 MB(1 200 000 B)、`templates/**` ≤ 60 KB、包内禁止 `.png/.jpg/.gif/.webp/.bmp/.pdf/.html/.zip/.7z/.exe/.dll`,且必须含 `README.md` / `README_EN.md` / `LICENSE` / `cordis.patch.yml` / `docs/reading-guide.md`。
|
|
346
410
|
|
|
347
411
|
真机 e2e 会写板子,需要你指一个能构建的工程:
|
|
348
412
|
|
|
@@ -358,20 +422,23 @@ node test\e2e-flash.mjs
|
|
|
358
422
|
```text
|
|
359
423
|
src/
|
|
360
424
|
index.ts 插件入口(name / inject / apply)
|
|
361
|
-
tools/
|
|
425
|
+
tools/ 21 个工具的 L3 层(参数 schema + 输出契约 + 渲染)
|
|
362
426
|
engine/ 纯逻辑与工作流(generate / build / flash / debug / ioc / scaffold …)
|
|
363
|
-
commands/register.ts
|
|
427
|
+
commands/register.ts 7 条斜杠命令
|
|
364
428
|
skill/stm32-workflow.ts 随插件下发的 SKILL
|
|
365
429
|
data/ 路径与芯片数据(路径是数据不是逻辑)
|
|
366
430
|
templates/scaffold/ 建工程用的模板快照(CMake / .ld / .vscode / .ioc)
|
|
367
|
-
test/
|
|
368
|
-
|
|
431
|
+
test/ 离线套件(36 个,run-units 登记)+ fixtures + 真机 e2e
|
|
432
|
+
scripts/ 护栏与生成脚本(pack-size / pack-smoke / gen-xcube-catalog / copy-client)
|
|
433
|
+
docs/ 规格书 + 开发笔记 + 精读指南 + diagrams/(不进 npm 包)
|
|
369
434
|
```
|
|
370
435
|
|
|
371
436
|
## 文档
|
|
372
437
|
|
|
373
438
|
- [规格书](docs/dsh-stm32-plugin-规格.md):工具契约、状态机、验收 A1–A13 的判定标准
|
|
374
439
|
- [开发笔记](docs/development-notes.md):里程碑、宿主契约踩坑、每个工具的实现细节与实测数据
|
|
440
|
+
- [源码精读指南](docs/reading-guide.md):分层阅读顺序、每个文件的职责与关键导出、14 张流程图、23 条不变量
|
|
441
|
+
- 可视化:[架构总览](docs/diagrams/dsh-stm32-architecture.html) / [主线旅程](docs/diagrams/dsh-stm32-journey.html)(单文件 HTML,离线可开,可导出 PNG/SVG)
|
|
375
442
|
|
|
376
443
|
## 许可证
|
|
377
444
|
|