dsh-stm32 0.1.2 → 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 +59 -21
- package/README_EN.md +59 -21
- package/docs/development-notes.md +374 -3
- package/docs/reading-guide.md +87 -66
- package/lib/data/chips.js +38 -51
- package/lib/data/cmsis-sources.js +27 -1
- package/lib/data/device-facts.js +201 -0
- package/lib/data/stm32f1.js +94 -150
- package/lib/data/svd.js +627 -0
- package/lib/engine/assets.js +924 -0
- package/lib/engine/breakpoints.js +242 -0
- package/lib/engine/debug-session.js +153 -5
- package/lib/engine/debug.js +75 -41
- package/lib/engine/doctor.js +2 -2
- package/lib/engine/flash.js +31 -59
- package/lib/engine/ioc-plan.js +5 -5
- package/lib/engine/probe-error.js +212 -0
- package/lib/engine/probe-session.js +311 -0
- package/lib/engine/register-template.js +32 -8
- package/lib/engine/regs.js +2 -0
- package/lib/engine/rtt.js +600 -0
- package/lib/index.js +8 -0
- package/lib/tools/assets.js +341 -0
- package/lib/tools/cache.js +8 -0
- package/lib/tools/debug-session.js +40 -5
- package/lib/tools/debug.js +41 -11
- package/lib/tools/doctor.js +11 -0
- package/lib/tools/flash.js +15 -6
- 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 +3 -0
- package/lib/tools/project-create.js +24 -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 +1 -1
- package/templates/register/CMakeLists.txt +7 -1
- package/templates/register/Core/Inc/rtt.h +103 -0
- package/templates/register/Core/Src/main.c +25 -0
- 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/lib/data/f1-ram.generated.js +0 -34
|
@@ -0,0 +1,600 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RTT(Real Time Transfer)引擎:固件把日志写进 RAM 里的环,openocd 用 rtt 命令把环
|
|
3
|
+
* 暴露成一个 TCP 端口,这里连上去把字节流解成一条条记录。
|
|
4
|
+
*
|
|
5
|
+
* 分工:
|
|
6
|
+
* - 控制块按 SEGGER 的约定(首 10 字节是 "SEGGER RTT"),这样 openocd 原生的
|
|
7
|
+
* rtt setup / rtt start 能直接认;
|
|
8
|
+
* - 通道 0 的记录格式是我们自己的(不抄 SEGGER:它没有级别和时间戳):
|
|
9
|
+
* [4B 长度 LE][1B 级别][8B 时间戳 ms LE][payload UTF-8]
|
|
10
|
+
* 长度字段 = 9 + payload 字节数,不含这 4 字节本身;
|
|
11
|
+
* - 级别 1..4 = error / warn / info / debug,dump 的 level 是"保留到哪一级"的上限。
|
|
12
|
+
*
|
|
13
|
+
* 所有失败都走 ProbeError 的形状(kind 只用 unknown / timeout),hint 专门讲 RTT 这边
|
|
14
|
+
* 该怎么办:端口被占、连不上通道、目标里没有控制块、帧对不上……
|
|
15
|
+
*/
|
|
16
|
+
import { createConnection } from "node:net";
|
|
17
|
+
import { isPortBusy } from "./debug.js";
|
|
18
|
+
import { formatProbeError } from "./probe-error.js";
|
|
19
|
+
import { normalizeWordAddress, parseMdwReply, sessionInfo, tclRoundTrip, touch } from "./probe-session.js";
|
|
20
|
+
/** RTT 通道的 TCP 端口缺省值(openocd 的 rtt server 监听这个端口)。 */
|
|
21
|
+
export const DEFAULT_RTT_PORT = 9090;
|
|
22
|
+
/** 控制块预留的字节数缺省值;真正用的是模板里那块内存的大小。 */
|
|
23
|
+
export const DEFAULT_RTT_SIZE = 0x400;
|
|
24
|
+
/** 一次 dump 的采集窗口(秒)。 */
|
|
25
|
+
export const DEFAULT_DUMP_SECONDS = 3;
|
|
26
|
+
/** 一次 dump 最多返回多少条记录。 */
|
|
27
|
+
export const DEFAULT_MAX_RECORDS = 200;
|
|
28
|
+
/** 单条记录的 payload 上限,超了就认为通道里不是我们的帧。 */
|
|
29
|
+
export const DEFAULT_MAX_FRAME_BYTES = 4096;
|
|
30
|
+
/** 连 RTT 通道端口的超时。 */
|
|
31
|
+
export const DEFAULT_CONNECT_TIMEOUT_MS = 3_000;
|
|
32
|
+
/** 4B 长度 + 1B 级别 + 8B 时间戳。 */
|
|
33
|
+
export const RTT_FRAME_HEADER_BYTES = 13;
|
|
34
|
+
/** 长度字段允许的最小值:1B 级别 + 8B 时间戳(空 payload)。 */
|
|
35
|
+
export const RTT_MIN_FRAME_BYTES = 9;
|
|
36
|
+
/** 控制块的魔数文本(与 SEGGER 兼容,openocd 靠它找控制块)。 */
|
|
37
|
+
export const RTT_MAGIC_TEXT = "SEGGER RTT";
|
|
38
|
+
/** 魔数第 0 个字:小端读出来是 "SEGG"。 */
|
|
39
|
+
export const RTT_MAGIC_WORD_0 = 0x47474553;
|
|
40
|
+
/** 魔数第 1 个字:小端读出来是 "ER R"。 */
|
|
41
|
+
export const RTT_MAGIC_WORD_1 = 0x52205245;
|
|
42
|
+
/** 魔数第 2 个字的低 16 位是 "TT"(0x5454),高 16 位由模板自己决定(后面就是通道描述符)。 */
|
|
43
|
+
export const RTT_MAGIC_WORD_2_LOW = 0x5454;
|
|
44
|
+
export const RTT_MIN_LEVEL = 1;
|
|
45
|
+
export const RTT_MAX_LEVEL = 4;
|
|
46
|
+
/** 级别名;模板端写记录时用同一张表。 */
|
|
47
|
+
export const RTT_LEVEL_NAMES = { 1: "error", 2: "warn", 3: "info", 4: "debug" };
|
|
48
|
+
const HINT_ADDR = "addr 要写成 32 位十六进制(例如 0x20000000),填控制块的起始地址,不是通道缓冲区的地址。";
|
|
49
|
+
const HINT_NO_SESSION = "先起一个调试会话:stm32_debug_session action=start;也可以直接 stm32_rtt action=start,工具会自动起一个。";
|
|
50
|
+
const HINT_NO_TCL = "会话没有 Tcl RPC 端口(openocd 启动日志里没有 tcl 那一行):确认 openocd 版本支持 tcl(0.11 以上默认开),再重启会话。";
|
|
51
|
+
const HINT_NO_BLOCK = "目标内存里没有 RTT 控制块:在模板里加最小实现——控制块头 10 字节放 SEGGER RTT 魔数,把它链接到固定 RAM 地址(例如 .noinit 段,地址和 addr 一致),通道 0 按 [4B 长度|1B 级别|8B 时间戳|UTF-8] 写记录;然后核对 addr/size。";
|
|
52
|
+
const HINT_MAGIC = "控制块魔数不符:核对 addr 是不是控制块起始地址(不是通道缓冲区地址),并确认模板里的控制块真的被链接进 RAM(查 .map 文件)。";
|
|
53
|
+
const HINT_PORT_BUSY = "RTT 端口被占用:换一个 rttPort,或关掉占着它的进程(另一个 RTT 客户端 / 上次没停的 rtt server)。";
|
|
54
|
+
const HINT_CONNECT = "连不上 RTT 通道:确认 start 成功(openocd 的 rtt server 已在监听该端口),端口没被防火墙挡住;换个 rttPort 或加大 timeoutMs 再试。";
|
|
55
|
+
const HINT_NOT_RUNNING = "RTT 还没启动:先 stm32_rtt action=start,addr 填模板里控制块的地址。";
|
|
56
|
+
const HINT_SETUP = "openocd 拒绝了 RTT 命令:看 evidence 里 openocd 的原话;常见原因是控制块地址/长度不对,或者目标没在跑(rtt start 需要目标在跑)。";
|
|
57
|
+
const HINT_TCL_TIMEOUT = "openocd 的 Tcl 口超时:确认调试会话还在(stm32_debug_session action=status),必要时重启会话再试。";
|
|
58
|
+
const HINT_FRAME = "通道字节流不符合我们的帧约定([4B 长度|1B 级别|8B 时间戳|UTF-8]):核对模板里写通道 0 的函数,或先 stop 再 start 重来。";
|
|
59
|
+
const HINT_CANCEL = "已取消:重新调用同一个工具即可,RTT 状态不会被这次取消弄坏。";
|
|
60
|
+
function initialState() {
|
|
61
|
+
return {
|
|
62
|
+
running: false,
|
|
63
|
+
addr: "",
|
|
64
|
+
size: DEFAULT_RTT_SIZE,
|
|
65
|
+
banner: "",
|
|
66
|
+
port: DEFAULT_RTT_PORT,
|
|
67
|
+
tclPort: 0,
|
|
68
|
+
startedAt: 0,
|
|
69
|
+
runningMs: 0,
|
|
70
|
+
records: 0,
|
|
71
|
+
bytes: 0,
|
|
72
|
+
dropped: 0,
|
|
73
|
+
socketOpen: false,
|
|
74
|
+
lastError: null,
|
|
75
|
+
socket: null,
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
let state = initialState();
|
|
79
|
+
/** 组一个结构化错误:形状与 probe-error 的 ProbeError 一致,hint 是 RTT 专用的。 */
|
|
80
|
+
function rttError(kind, cause, hint, evidence = []) {
|
|
81
|
+
return { kind, cause, hint, evidence, retryable: kind === "timeout" };
|
|
82
|
+
}
|
|
83
|
+
function clampNumber(value, min, max) {
|
|
84
|
+
if (!Number.isFinite(value))
|
|
85
|
+
return min;
|
|
86
|
+
return Math.min(max, Math.max(min, value));
|
|
87
|
+
}
|
|
88
|
+
function addWords(address, delta) {
|
|
89
|
+
const base = Number.parseInt(address.replace(/^0x/iu, ""), 16);
|
|
90
|
+
return "0x" + (base + delta).toString(16).padStart(8, "0");
|
|
91
|
+
}
|
|
92
|
+
/** 从 mdw 的回复里取 32 位值;地址对不上(回复错位)也返回 null。 */
|
|
93
|
+
function wordFromReply(reply, address) {
|
|
94
|
+
const parsed = parseMdwReply(reply);
|
|
95
|
+
if (parsed === null)
|
|
96
|
+
return null;
|
|
97
|
+
if (parsed.address !== "") {
|
|
98
|
+
const expected = normalizeWordAddress(address);
|
|
99
|
+
if (expected !== null && parsed.address !== expected)
|
|
100
|
+
return null;
|
|
101
|
+
}
|
|
102
|
+
const value = Number.parseInt(parsed.value.replace(/^0x/iu, ""), 16);
|
|
103
|
+
return Number.isFinite(value) ? value : null;
|
|
104
|
+
}
|
|
105
|
+
/** 找出 openocd 回复里第一条像错误的;没有就返回 null。 */
|
|
106
|
+
function firstErrorReply(replies) {
|
|
107
|
+
for (const reply of replies) {
|
|
108
|
+
const text = String(reply ?? "").trim();
|
|
109
|
+
if (text === "")
|
|
110
|
+
continue;
|
|
111
|
+
if (/^(error|invalid|unknown|no\s)/iu.test(text) || /unknown command|not found|no such|can't|cannot|failed/iu.test(text)) {
|
|
112
|
+
return text;
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
return null;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* 解析 RTT 通道字节流。返回解出来的记录、剩下的半个帧字节,以及失步错误。
|
|
119
|
+
* 纯函数:单测直接喂 Buffer 就能验帧格式,不用起 openocd。
|
|
120
|
+
*/
|
|
121
|
+
export function parseRttFrames(buffer, maxFrameBytes = DEFAULT_MAX_FRAME_BYTES) {
|
|
122
|
+
const records = [];
|
|
123
|
+
let offset = 0;
|
|
124
|
+
while (buffer.length - offset >= 4) {
|
|
125
|
+
const length = buffer.readUInt32LE(offset);
|
|
126
|
+
if (length < RTT_MIN_FRAME_BYTES) {
|
|
127
|
+
return {
|
|
128
|
+
records,
|
|
129
|
+
rest: Buffer.from(buffer.subarray(offset)),
|
|
130
|
+
error: "帧长度字段 " + String(length) + " 不合法(最小 " + String(RTT_MIN_FRAME_BYTES) + " = 1B 级别 + 8B 时间戳)",
|
|
131
|
+
};
|
|
132
|
+
}
|
|
133
|
+
if (length > maxFrameBytes) {
|
|
134
|
+
return {
|
|
135
|
+
records,
|
|
136
|
+
rest: Buffer.from(buffer.subarray(offset)),
|
|
137
|
+
error: "帧长度 " + String(length) + " 超过上限 " + String(maxFrameBytes) + ",通道里很可能不是我们的帧",
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
if (buffer.length - offset - 4 < length)
|
|
141
|
+
break;
|
|
142
|
+
const level = buffer.readUInt8(offset + 4);
|
|
143
|
+
if (level < RTT_MIN_LEVEL || level > RTT_MAX_LEVEL) {
|
|
144
|
+
return {
|
|
145
|
+
records,
|
|
146
|
+
rest: Buffer.from(buffer.subarray(offset)),
|
|
147
|
+
error: "级别字段 " + String(level) + " 越界(约定 1..4:1=error 2=warn 3=info 4=debug)",
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
const t = Number(buffer.readBigUInt64LE(offset + 5));
|
|
151
|
+
const text = buffer.toString("utf8", offset + RTT_FRAME_HEADER_BYTES, offset + 4 + length);
|
|
152
|
+
records.push({ t, level, text });
|
|
153
|
+
offset += 4 + length;
|
|
154
|
+
}
|
|
155
|
+
return { records, rest: Buffer.from(buffer.subarray(offset)), error: null };
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* 按同一套约定编一帧。引擎自己不用它(记录是固件写的),但它是帧格式的可执行参考:
|
|
159
|
+
* 模板端的 C 实现和单测都对着它写。
|
|
160
|
+
*/
|
|
161
|
+
export function encodeRttFrame(record) {
|
|
162
|
+
const payload = Buffer.from(record.text, "utf8");
|
|
163
|
+
const frame = Buffer.alloc(RTT_FRAME_HEADER_BYTES + payload.length);
|
|
164
|
+
frame.writeUInt32LE(RTT_MIN_FRAME_BYTES + payload.length, 0);
|
|
165
|
+
frame.writeUInt8(record.level, 4);
|
|
166
|
+
frame.writeBigUInt64LE(BigInt(Math.max(0, Math.floor(record.t))), 5);
|
|
167
|
+
payload.copy(frame, RTT_FRAME_HEADER_BYTES);
|
|
168
|
+
return frame;
|
|
169
|
+
}
|
|
170
|
+
/** 读控制块的头三个字,用来判断目标里到底有没有 RTT 控制块。 */
|
|
171
|
+
async function readControlBlock(addr, tclPort, timeoutMs, signal) {
|
|
172
|
+
const addresses = [addr, addWords(addr, 4), addWords(addr, 8)];
|
|
173
|
+
const commands = addresses.map((address) => "mdw " + address);
|
|
174
|
+
const round = await tclRoundTrip(tclPort, commands, timeoutMs, signal);
|
|
175
|
+
if (!round.ok)
|
|
176
|
+
return { ok: false, words: null, error: round.error ?? "读控制块失败", output: round.output };
|
|
177
|
+
touch();
|
|
178
|
+
const values = [];
|
|
179
|
+
for (let index = 0; index < addresses.length; index += 1) {
|
|
180
|
+
const value = wordFromReply(round.replies[index] ?? "", addresses[index] ?? "");
|
|
181
|
+
if (value === null)
|
|
182
|
+
return { ok: false, words: null, error: "控制块读取的回复解析不了:" + JSON.stringify(round.replies[index] ?? ""), output: round.output };
|
|
183
|
+
values.push(value >>> 0);
|
|
184
|
+
}
|
|
185
|
+
return { ok: true, words: { word0: values[0] ?? 0, word1: values[1] ?? 0, word2: values[2] ?? 0 }, error: null, output: round.output };
|
|
186
|
+
}
|
|
187
|
+
function describeWords(words) {
|
|
188
|
+
const hex = (value) => "0x" + (value >>> 0).toString(16).padStart(8, "0");
|
|
189
|
+
return "控制块三个字:" + hex(words.word0) + " " + hex(words.word1) + " " + hex(words.word2);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* 启动 RTT:先用 mdw 确认目标里真有控制块,再依次发 rtt setup / rtt start /
|
|
193
|
+
* rtt server start,最后记下通道端口供 dumpRtt 连。
|
|
194
|
+
*/
|
|
195
|
+
export async function startRtt(request) {
|
|
196
|
+
const startedAt = Date.now();
|
|
197
|
+
const addr = normalizeWordAddress(typeof request.addr === "string" ? request.addr : "") ?? "";
|
|
198
|
+
const size = Math.round(clampNumber(request.size ?? DEFAULT_RTT_SIZE, 16, 0x4000));
|
|
199
|
+
const banner = typeof request.banner === "string" ? request.banner.trim() : "";
|
|
200
|
+
const port = Math.round(clampNumber(request.port ?? DEFAULT_RTT_PORT, 1, 65_535));
|
|
201
|
+
const tclTimeout = Math.round(clampNumber(request.timeoutMs ?? 5_000, 500, 60_000));
|
|
202
|
+
const checkBusy = request.checkPortBusy ?? isPortBusy;
|
|
203
|
+
const base = {
|
|
204
|
+
ok: false,
|
|
205
|
+
started: false,
|
|
206
|
+
addr,
|
|
207
|
+
size,
|
|
208
|
+
banner,
|
|
209
|
+
port,
|
|
210
|
+
tclPort: 0,
|
|
211
|
+
command: [],
|
|
212
|
+
output: "",
|
|
213
|
+
words: null,
|
|
214
|
+
durationMs: 0,
|
|
215
|
+
probeError: null,
|
|
216
|
+
message: "",
|
|
217
|
+
notes: [],
|
|
218
|
+
};
|
|
219
|
+
if (addr === "") {
|
|
220
|
+
const probeError = rttError("unknown", "addr 不是合法的 32 位地址:" + JSON.stringify(String(request.addr ?? "")), HINT_ADDR);
|
|
221
|
+
return { ...base, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
222
|
+
}
|
|
223
|
+
if (request.signal?.aborted === true) {
|
|
224
|
+
const probeError = rttError("unknown", "已取消", HINT_CANCEL);
|
|
225
|
+
return { ...base, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
226
|
+
}
|
|
227
|
+
const session = sessionInfo();
|
|
228
|
+
if (session === null) {
|
|
229
|
+
const probeError = rttError("unknown", "没有活跃的调试会话(RTT 要走 openocd 的 Tcl RPC)", HINT_NO_SESSION);
|
|
230
|
+
return { ...base, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
231
|
+
}
|
|
232
|
+
if (session.tclPort <= 0) {
|
|
233
|
+
const probeError = rttError("unknown", "会话没有 Tcl 端口(openocd 日志里没有 tcl 那一行)", HINT_NO_TCL);
|
|
234
|
+
return { ...base, tclPort: session.tclPort, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
235
|
+
}
|
|
236
|
+
const tclPort = session.tclPort;
|
|
237
|
+
if (await checkBusy(port)) {
|
|
238
|
+
const probeError = rttError("unknown", "RTT 通道端口 " + String(port) + " 已被占用", HINT_PORT_BUSY, ["rtt port " + String(port) + " busy"]);
|
|
239
|
+
return { ...base, tclPort, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
240
|
+
}
|
|
241
|
+
const block = await readControlBlock(addr, tclPort, tclTimeout, request.signal);
|
|
242
|
+
if (!block.ok) {
|
|
243
|
+
const timeout = /超时|timeout/iu.test(block.error ?? "");
|
|
244
|
+
const probeError = rttError(timeout ? "timeout" : "unknown", "读控制块失败:" + (block.error ?? "未知原因"), timeout ? HINT_TCL_TIMEOUT : HINT_NO_BLOCK, [block.error ?? ""]);
|
|
245
|
+
return { ...base, tclPort, output: block.output, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
246
|
+
}
|
|
247
|
+
const words = block.words;
|
|
248
|
+
if (words === null) {
|
|
249
|
+
const probeError = rttError("unknown", "读不到控制块", HINT_NO_BLOCK);
|
|
250
|
+
return { ...base, tclPort, output: block.output, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
251
|
+
}
|
|
252
|
+
const zero = words.word0 === 0 && words.word1 === 0 && words.word2 === 0;
|
|
253
|
+
const magicOk = words.word0 === RTT_MAGIC_WORD_0 && words.word1 === RTT_MAGIC_WORD_1 && (words.word2 & 0xffff) === RTT_MAGIC_WORD_2_LOW;
|
|
254
|
+
if (zero || !magicOk) {
|
|
255
|
+
const probeError = rttError("unknown", zero ? "控制块是空的(三个字全是 0),目标里没有 RTT 控制块" : "控制块魔数不符,目标里那块内存不是 RTT 控制块", zero ? HINT_NO_BLOCK : HINT_MAGIC, [describeWords(words), "期望 magic " + RTT_MAGIC_TEXT + " = 0x47474553 0x52205245 0x????5454"]);
|
|
256
|
+
return { ...base, tclPort, output: block.output, words, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
257
|
+
}
|
|
258
|
+
// openocd 0.12 的 rtt setup 要求三个参数:<address> <size> <ID>,ID 是控制块里的标识字符串
|
|
259
|
+
// (SEGGER RTT)。只给两个参数会被当成参数缺失,命令不生效却不一定报错——实测踩过。
|
|
260
|
+
const controlBlockId = banner === "" ? RTT_MAGIC_TEXT : banner;
|
|
261
|
+
const setup = "rtt setup " + addr + " " + String(size) + " \"" + controlBlockId + "\"";
|
|
262
|
+
const commands = [setup, "rtt start", "rtt server start " + String(port) + " 0"];
|
|
263
|
+
const round = await tclRoundTrip(tclPort, commands, tclTimeout, request.signal);
|
|
264
|
+
const output = round.output;
|
|
265
|
+
if (!round.ok) {
|
|
266
|
+
const timeout = /超时|timeout/iu.test(round.error ?? "");
|
|
267
|
+
const probeError = rttError(timeout ? "timeout" : "unknown", "RTT 命令没发出去:" + (round.error ?? "未知原因"), timeout ? HINT_TCL_TIMEOUT : HINT_SETUP, [round.error ?? ""]);
|
|
268
|
+
return { ...base, tclPort, command: commands, output, words, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
269
|
+
}
|
|
270
|
+
touch();
|
|
271
|
+
const bad = firstErrorReply(round.replies);
|
|
272
|
+
if (bad !== null) {
|
|
273
|
+
const probeError = rttError("unknown", "openocd 拒绝了 RTT 命令:" + bad, HINT_SETUP, [bad, "commands: " + commands.join("; ")]);
|
|
274
|
+
return { ...base, tclPort, command: commands, output, words, durationMs: Date.now() - startedAt, probeError, message: formatProbeError(probeError) };
|
|
275
|
+
}
|
|
276
|
+
state = {
|
|
277
|
+
running: true,
|
|
278
|
+
addr,
|
|
279
|
+
size,
|
|
280
|
+
banner,
|
|
281
|
+
port,
|
|
282
|
+
tclPort,
|
|
283
|
+
startedAt: Date.now(),
|
|
284
|
+
runningMs: 0,
|
|
285
|
+
records: 0,
|
|
286
|
+
bytes: 0,
|
|
287
|
+
dropped: 0,
|
|
288
|
+
socketOpen: false,
|
|
289
|
+
lastError: null,
|
|
290
|
+
socket: null,
|
|
291
|
+
};
|
|
292
|
+
return {
|
|
293
|
+
ok: true,
|
|
294
|
+
started: true,
|
|
295
|
+
addr,
|
|
296
|
+
size,
|
|
297
|
+
banner,
|
|
298
|
+
port,
|
|
299
|
+
tclPort,
|
|
300
|
+
command: commands,
|
|
301
|
+
output,
|
|
302
|
+
words,
|
|
303
|
+
durationMs: Date.now() - startedAt,
|
|
304
|
+
probeError: null,
|
|
305
|
+
message: "RTT 已启动:控制块 " + addr + "(" + String(size) + " 字节),通道端口 " + String(port) + ";dump 用 stm32_rtt action=dump",
|
|
306
|
+
notes: [describeWords(words)],
|
|
307
|
+
};
|
|
308
|
+
}
|
|
309
|
+
/** 连上 RTT 通道端口,采 seconds 秒(或直到 maxRecords / 通道关闭 / 出错)。 */
|
|
310
|
+
async function collectFromPort(port, options) {
|
|
311
|
+
return await new Promise((resolve) => {
|
|
312
|
+
const startedAt = Date.now();
|
|
313
|
+
const records = [];
|
|
314
|
+
const notes = [];
|
|
315
|
+
let dropped = 0;
|
|
316
|
+
let bytes = 0;
|
|
317
|
+
let carry = Buffer.alloc(0);
|
|
318
|
+
let truncated = false;
|
|
319
|
+
let stopped = false;
|
|
320
|
+
let settled = false;
|
|
321
|
+
let connected = false;
|
|
322
|
+
let error = null;
|
|
323
|
+
let failureKind = "unknown";
|
|
324
|
+
let failureHint = HINT_FRAME;
|
|
325
|
+
const socket = createConnection({ host: "127.0.0.1", port });
|
|
326
|
+
state.socket = socket;
|
|
327
|
+
socket.setNoDelay(true);
|
|
328
|
+
const finish = (reason, detail) => {
|
|
329
|
+
if (settled)
|
|
330
|
+
return;
|
|
331
|
+
settled = true;
|
|
332
|
+
clearTimeout(connectTimer);
|
|
333
|
+
if (windowTimer !== null)
|
|
334
|
+
clearTimeout(windowTimer);
|
|
335
|
+
options.signal?.removeEventListener("abort", onAbort);
|
|
336
|
+
if (state.socket === socket)
|
|
337
|
+
state.socket = null;
|
|
338
|
+
socket.removeAllListeners();
|
|
339
|
+
socket.on("error", () => undefined);
|
|
340
|
+
socket.destroy();
|
|
341
|
+
if (reason === "closed")
|
|
342
|
+
stopped = true;
|
|
343
|
+
if (reason === "truncated") {
|
|
344
|
+
truncated = true;
|
|
345
|
+
notes.push("达到 maxRecords=" + String(options.maxRecords) + " 提前收尾,后面的记录没读");
|
|
346
|
+
}
|
|
347
|
+
if (reason === "error") {
|
|
348
|
+
error = detail ?? "读 RTT 通道时出错";
|
|
349
|
+
failureKind = "unknown";
|
|
350
|
+
failureHint = HINT_FRAME;
|
|
351
|
+
}
|
|
352
|
+
if (reason === "connect-failed") {
|
|
353
|
+
error = detail ?? "连不上 RTT 通道";
|
|
354
|
+
failureKind = "timeout";
|
|
355
|
+
failureHint = HINT_CONNECT;
|
|
356
|
+
}
|
|
357
|
+
if (reason === "aborted") {
|
|
358
|
+
error = "已取消";
|
|
359
|
+
failureKind = "unknown";
|
|
360
|
+
failureHint = HINT_CANCEL;
|
|
361
|
+
}
|
|
362
|
+
if (reason === "window" && carry.length > 0) {
|
|
363
|
+
notes.push("窗口结束时尾部还有 " + String(carry.length) + " 字节的半个帧,没算进 records");
|
|
364
|
+
}
|
|
365
|
+
resolve({
|
|
366
|
+
ok: error === null,
|
|
367
|
+
records,
|
|
368
|
+
dropped,
|
|
369
|
+
bytes,
|
|
370
|
+
truncated,
|
|
371
|
+
stopped,
|
|
372
|
+
error,
|
|
373
|
+
probeError: error === null ? null : rttError(failureKind, error, failureHint),
|
|
374
|
+
notes,
|
|
375
|
+
durationMs: Date.now() - startedAt,
|
|
376
|
+
});
|
|
377
|
+
};
|
|
378
|
+
const onAbort = () => {
|
|
379
|
+
finish("aborted", null);
|
|
380
|
+
};
|
|
381
|
+
const connectTimer = setTimeout(() => {
|
|
382
|
+
finish("connect-failed", "连不上 RTT 通道端口 " + String(port) + "(" + String(options.connectTimeoutMs) + " ms 内没建立连接)");
|
|
383
|
+
}, options.connectTimeoutMs);
|
|
384
|
+
let windowTimer = null;
|
|
385
|
+
socket.on("connect", () => {
|
|
386
|
+
connected = true;
|
|
387
|
+
clearTimeout(connectTimer);
|
|
388
|
+
windowTimer = setTimeout(() => {
|
|
389
|
+
finish("window", null);
|
|
390
|
+
}, Math.round(options.seconds * 1000));
|
|
391
|
+
});
|
|
392
|
+
socket.on("data", (chunk) => {
|
|
393
|
+
if (settled)
|
|
394
|
+
return;
|
|
395
|
+
bytes += chunk.length;
|
|
396
|
+
state.bytes += chunk.length;
|
|
397
|
+
carry = Buffer.concat([carry, chunk]);
|
|
398
|
+
const parsed = parseRttFrames(carry, options.maxFrameBytes);
|
|
399
|
+
carry = parsed.rest;
|
|
400
|
+
if (parsed.error !== null) {
|
|
401
|
+
// 环形缓冲回绕后,通道字节流尾部经常剩半条记录;只要已经解出过记录,
|
|
402
|
+
// 就当「窗口结束 + 尾部丢半帧」,不要把整次 dump 判失败(实测 C8T6 上必现)。
|
|
403
|
+
if (records.length > 0) {
|
|
404
|
+
state.lastError = parsed.error;
|
|
405
|
+
notes.push("RTT 通道尾部有半条记录(多半是环形缓冲回绕),已丢弃:" + parsed.error);
|
|
406
|
+
finish("window", null);
|
|
407
|
+
return;
|
|
408
|
+
}
|
|
409
|
+
state.lastError = parsed.error;
|
|
410
|
+
finish("error", parsed.error);
|
|
411
|
+
return;
|
|
412
|
+
}
|
|
413
|
+
for (const record of parsed.records) {
|
|
414
|
+
if (record.level > options.level) {
|
|
415
|
+
dropped += 1;
|
|
416
|
+
state.dropped += 1;
|
|
417
|
+
continue;
|
|
418
|
+
}
|
|
419
|
+
if (records.length >= options.maxRecords) {
|
|
420
|
+
finish("truncated", null);
|
|
421
|
+
return;
|
|
422
|
+
}
|
|
423
|
+
records.push(record);
|
|
424
|
+
state.records += 1;
|
|
425
|
+
}
|
|
426
|
+
});
|
|
427
|
+
socket.on("close", () => {
|
|
428
|
+
finish("closed", null);
|
|
429
|
+
});
|
|
430
|
+
socket.on("error", (err) => {
|
|
431
|
+
if (settled)
|
|
432
|
+
return;
|
|
433
|
+
if (!connected) {
|
|
434
|
+
finish("connect-failed", "连不上 RTT 通道端口 " + String(port) + ":" + err.message);
|
|
435
|
+
return;
|
|
436
|
+
}
|
|
437
|
+
if (bytes === 0) {
|
|
438
|
+
finish("error", "读 RTT 通道时出错:" + err.message);
|
|
439
|
+
return;
|
|
440
|
+
}
|
|
441
|
+
finish("closed", null);
|
|
442
|
+
});
|
|
443
|
+
options.signal?.addEventListener("abort", onAbort, { once: true });
|
|
444
|
+
if (options.signal?.aborted === true)
|
|
445
|
+
onAbort();
|
|
446
|
+
});
|
|
447
|
+
}
|
|
448
|
+
/** dump:从通道 0 读一段时间的记录;level 是保留上限(默认 4 = 全要)。 */
|
|
449
|
+
export async function dumpRtt(request = {}) {
|
|
450
|
+
const rawSeconds = request.seconds ?? DEFAULT_DUMP_SECONDS;
|
|
451
|
+
const seconds = clampNumber(rawSeconds, 0.2, 60);
|
|
452
|
+
const level = Math.round(clampNumber(request.level ?? RTT_MAX_LEVEL, RTT_MIN_LEVEL, RTT_MAX_LEVEL));
|
|
453
|
+
const maxRecords = Math.round(clampNumber(request.maxRecords ?? DEFAULT_MAX_RECORDS, 1, 5_000));
|
|
454
|
+
const maxFrameBytes = Math.round(clampNumber(request.maxFrameBytes ?? DEFAULT_MAX_FRAME_BYTES, RTT_MIN_FRAME_BYTES, 65_536));
|
|
455
|
+
const connectTimeoutMs = Math.round(clampNumber(request.timeoutMs ?? DEFAULT_CONNECT_TIMEOUT_MS, 100, 60_000));
|
|
456
|
+
const port = state.port;
|
|
457
|
+
const addr = state.addr;
|
|
458
|
+
const base = {
|
|
459
|
+
ok: false,
|
|
460
|
+
records: [],
|
|
461
|
+
dropped: 0,
|
|
462
|
+
bytes: 0,
|
|
463
|
+
truncated: false,
|
|
464
|
+
stopped: false,
|
|
465
|
+
port,
|
|
466
|
+
addr,
|
|
467
|
+
seconds,
|
|
468
|
+
level,
|
|
469
|
+
maxRecords,
|
|
470
|
+
durationMs: 0,
|
|
471
|
+
error: null,
|
|
472
|
+
probeError: null,
|
|
473
|
+
message: "",
|
|
474
|
+
notes: [],
|
|
475
|
+
};
|
|
476
|
+
if (!state.running) {
|
|
477
|
+
const probeError = rttError("unknown", "RTT 没在跑(当前没有活动的 RTT 通道)", HINT_NOT_RUNNING);
|
|
478
|
+
return { ...base, probeError, error: probeError.cause, message: formatProbeError(probeError) };
|
|
479
|
+
}
|
|
480
|
+
if (request.signal?.aborted === true) {
|
|
481
|
+
const probeError = rttError("unknown", "已取消", HINT_CANCEL);
|
|
482
|
+
return { ...base, probeError, error: probeError.cause, message: formatProbeError(probeError) };
|
|
483
|
+
}
|
|
484
|
+
const outcome = await collectFromPort(port, { seconds, level, maxRecords, maxFrameBytes, connectTimeoutMs, ...(request.signal === undefined ? {} : { signal: request.signal }) });
|
|
485
|
+
const notes = [...outcome.notes];
|
|
486
|
+
if (seconds !== rawSeconds)
|
|
487
|
+
notes.push("seconds=" + String(rawSeconds) + " 超出 0.2..60,按 " + String(seconds) + " s 收;要更长的窗口就分多次 dump");
|
|
488
|
+
if (outcome.error !== null)
|
|
489
|
+
state.lastError = outcome.error;
|
|
490
|
+
let message;
|
|
491
|
+
if (outcome.ok) {
|
|
492
|
+
message = "dump 到 " + String(outcome.records.length) + " 条 RTT 记录(端口 " + String(port) + ",窗口 " + String(seconds) + " s,收 " + String(outcome.bytes) + " 字节)";
|
|
493
|
+
if (outcome.dropped > 0)
|
|
494
|
+
message += ",按级别过滤掉 " + String(outcome.dropped) + " 条";
|
|
495
|
+
if (outcome.truncated)
|
|
496
|
+
message += ",达到 maxRecords 提前收尾";
|
|
497
|
+
if (outcome.stopped)
|
|
498
|
+
message += ",通道在窗口内被关掉(目标复位或 rtt stop)";
|
|
499
|
+
}
|
|
500
|
+
else {
|
|
501
|
+
const probeError = outcome.probeError ?? rttError("unknown", outcome.error ?? "未知原因", HINT_FRAME);
|
|
502
|
+
message = formatProbeError(probeError);
|
|
503
|
+
}
|
|
504
|
+
return {
|
|
505
|
+
ok: outcome.ok,
|
|
506
|
+
records: outcome.records,
|
|
507
|
+
dropped: outcome.dropped,
|
|
508
|
+
bytes: outcome.bytes,
|
|
509
|
+
truncated: outcome.truncated,
|
|
510
|
+
stopped: outcome.stopped,
|
|
511
|
+
port,
|
|
512
|
+
addr,
|
|
513
|
+
seconds,
|
|
514
|
+
level,
|
|
515
|
+
maxRecords,
|
|
516
|
+
durationMs: outcome.durationMs,
|
|
517
|
+
error: outcome.error,
|
|
518
|
+
probeError: outcome.probeError,
|
|
519
|
+
message,
|
|
520
|
+
notes,
|
|
521
|
+
};
|
|
522
|
+
}
|
|
523
|
+
function resetState() {
|
|
524
|
+
state = initialState();
|
|
525
|
+
}
|
|
526
|
+
/** 停 RTT:先断掉正在读的通道,再让 openocd 收掉 rtt server 和 rtt 轮询。 */
|
|
527
|
+
export async function stopRtt() {
|
|
528
|
+
const startedAt = Date.now();
|
|
529
|
+
const wasRunning = state.running;
|
|
530
|
+
const port = state.port;
|
|
531
|
+
const records = state.records;
|
|
532
|
+
const bytes = state.bytes;
|
|
533
|
+
const dropped = state.dropped;
|
|
534
|
+
const base = { ok: false, stopped: false, port, records, bytes, dropped, durationMs: 0, error: null, probeError: null, message: "", notes: [] };
|
|
535
|
+
if (state.socket !== null) {
|
|
536
|
+
const socket = state.socket;
|
|
537
|
+
state.socket = null;
|
|
538
|
+
socket.destroy();
|
|
539
|
+
}
|
|
540
|
+
const session = sessionInfo();
|
|
541
|
+
let tclError = null;
|
|
542
|
+
if (session === null) {
|
|
543
|
+
tclError = "没有活跃的调试会话(本地 RTT 状态已经清掉,openocd 那边可能还开着 rtt server)";
|
|
544
|
+
}
|
|
545
|
+
else if (session.tclPort <= 0) {
|
|
546
|
+
tclError = "会话没有 Tcl 端口,没法让 openocd 收掉 rtt server(本地状态已清)";
|
|
547
|
+
}
|
|
548
|
+
else {
|
|
549
|
+
const commands = ["rtt server stop " + String(port), "rtt stop"];
|
|
550
|
+
const round = await tclRoundTrip(session.tclPort, commands, 3_000);
|
|
551
|
+
if (!round.ok)
|
|
552
|
+
tclError = round.error ?? "rtt stop 没发出去";
|
|
553
|
+
else {
|
|
554
|
+
const bad = firstErrorReply(round.replies);
|
|
555
|
+
if (bad !== null)
|
|
556
|
+
tclError = bad;
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
resetState();
|
|
560
|
+
const notes = [];
|
|
561
|
+
if (!wasRunning)
|
|
562
|
+
notes.push("本来就没在跑,这次只做了清理");
|
|
563
|
+
if (tclError !== null)
|
|
564
|
+
notes.push(tclError);
|
|
565
|
+
const ok = wasRunning && tclError === null;
|
|
566
|
+
const message = ok
|
|
567
|
+
? "RTT 已停(通道端口 " + String(port) + ",这一轮收 " + String(records) + " 条 / " + String(bytes) + " 字节)"
|
|
568
|
+
: "RTT 已从本地停掉(通道端口 " + String(port) + ",这一轮收 " + String(records) + " 条 / " + String(bytes) + " 字节)" + (tclError === null ? "" : ";openocd 那边没收干净:" + tclError);
|
|
569
|
+
return {
|
|
570
|
+
ok,
|
|
571
|
+
stopped: wasRunning,
|
|
572
|
+
port,
|
|
573
|
+
records,
|
|
574
|
+
bytes,
|
|
575
|
+
dropped,
|
|
576
|
+
durationMs: Date.now() - startedAt,
|
|
577
|
+
error: tclError,
|
|
578
|
+
probeError: tclError === null ? null : rttError("unknown", tclError, HINT_NOT_RUNNING),
|
|
579
|
+
message,
|
|
580
|
+
notes,
|
|
581
|
+
};
|
|
582
|
+
}
|
|
583
|
+
/** 当前 RTT 状态快照(status 动作与报告都从这里取)。 */
|
|
584
|
+
export function rttStatus() {
|
|
585
|
+
return {
|
|
586
|
+
running: state.running,
|
|
587
|
+
addr: state.addr,
|
|
588
|
+
size: state.size,
|
|
589
|
+
banner: state.banner,
|
|
590
|
+
port: state.port,
|
|
591
|
+
tclPort: state.tclPort,
|
|
592
|
+
startedAt: state.startedAt,
|
|
593
|
+
runningMs: state.running && state.startedAt > 0 ? Date.now() - state.startedAt : 0,
|
|
594
|
+
records: state.records,
|
|
595
|
+
bytes: state.bytes,
|
|
596
|
+
dropped: state.dropped,
|
|
597
|
+
socketOpen: state.socket !== null,
|
|
598
|
+
lastError: state.lastError,
|
|
599
|
+
};
|
|
600
|
+
}
|
package/lib/index.js
CHANGED
|
@@ -12,7 +12,9 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import { registerCommands } from "./commands/register.js";
|
|
14
14
|
import { debugSessions } from "./engine/debug-session.js";
|
|
15
|
+
import { stopRtt } from "./engine/rtt.js";
|
|
15
16
|
import { registerStm32Skill } from "./skill/stm32-workflow.js";
|
|
17
|
+
import { registerAssets } from "./tools/assets.js";
|
|
16
18
|
import { registerBuild } from "./tools/build.js";
|
|
17
19
|
import { registerCache } from "./tools/cache.js";
|
|
18
20
|
import { registerCodePatch } from "./tools/code-patch.js";
|
|
@@ -31,6 +33,7 @@ import { registerProjectCreate } from "./tools/project-create.js";
|
|
|
31
33
|
import { registerProjectExport } from "./tools/project-export.js";
|
|
32
34
|
import { registerRegsRead } from "./tools/regs.js";
|
|
33
35
|
import { registerRoutePlan } from "./tools/route-plan.js";
|
|
36
|
+
import { registerRtt } from "./tools/rtt.js";
|
|
34
37
|
import { registerWebRoutes } from "./engine/web-routes.js";
|
|
35
38
|
export const name = "dsh-stm32";
|
|
36
39
|
export const inject = ["tools", "subprocess", "jobs"];
|
|
@@ -77,6 +80,8 @@ export function apply(ctx) {
|
|
|
77
80
|
registerDebugSession(ctx);
|
|
78
81
|
registerRegsRead(ctx);
|
|
79
82
|
registerRoutePlan(ctx);
|
|
83
|
+
registerRtt(ctx);
|
|
84
|
+
registerAssets(ctx);
|
|
80
85
|
registerCache(ctx);
|
|
81
86
|
registerDoctor(ctx);
|
|
82
87
|
// 设置面板的宿主 API(浏览器端 lib/client.js 用)。宿主没 webServer 服务时静默跳过。
|
|
@@ -99,6 +104,9 @@ export function apply(ctx) {
|
|
|
99
104
|
ctx.on("session/event", (session, event) => {
|
|
100
105
|
if (event?.type !== "turn/end")
|
|
101
106
|
return;
|
|
107
|
+
// RTT 的 rtt server 挂在同一个 openocd 上:会话一关它也跟着没了,本地状态不能继续
|
|
108
|
+
// 报 running。先收 RTT 再收会话,顺序只影响日志好不好看。
|
|
109
|
+
void stopRtt();
|
|
102
110
|
// A9:只关这条会话自己开的调试会话。事件结构宿主没公开,所以按可能的位置逐个试;
|
|
103
111
|
// 全都取不到就传空串,debug-session 会退回原来的「无条件关」行为。
|
|
104
112
|
const owner = callerIdOf(event, session);
|