Files
chrg/docs/协议板Boot_YMODEM上位机实现规则.md
T
wrh 9a7950d122 修复了短路测试下由于发送运行时间太短导致1~2持续抢占南向发送
修复了V_ON在运行状态下不能发送新的设置值的问题

chore: 更新版本号并新增运行中修改V_On功能

1. 更新多个文件的版本号至V1.1.14~V1.1.15
2. 新增Sink通道运行中修改V_On时下发Eload_Start_V_ON逻辑
3. 新增Sink电压判定可选来源配置,支持协议板或功率板电压
4. 优化chrg_sink_parse函数,新增实际电压读取和序号更新
5. 调整短路测试补发周期至50ms,移除冗余宏定义
6. 更新修改日志文档,新增V1.1.15版本变更记录
7. 新增协议板YMODEM升级文档
2026-09-09 20:37:09 +08:00

8.1 KiB
Raw Blame History

协议板 Boot:YMODEM 上位机实现规则

1. 适用范围

本文适用于 PC 上位机通过 USART1 直连协议板 Boot,传输协议为 YMODEM + CRC16。

不适用于“协议板 App 通过南向 Modbus 0x20 转发功率板 Boot”的链路;该链路的报文封装、应答和状态机需要独立实现。

2. 基本要求

项目 规则
串口 USART1,115200 bps,8N1,无校验、无流控
升级文件 必须发送已由现有打包工具生成的完整 .upk 文件
不支持的文件 裸 .bin,以及自行封装/加密但不符合工程 UPK 格式的文件
启动依据 等待 Boot 发出 ASCII C(0x43)后再开始传输
Boot 上电等待 首次等待主机开始约 5 秒;超时后可能跳转 App
传输中的帧间等待 Boot 约 10 秒;上位机不得使相邻有效帧间隔达到 10 秒

Boot 每约 1 秒发送一次 C。若没有收到 C,上位机不可直接发送 YMODEM 首帧;应提示设备未进入 Boot,或重新复位/触发其进入 Boot。

3. YMODEM 常量与帧格式

名称 值 含义
SOH 0x01 128 字节数据包
STX 0x02 1024 字节数据包
EOT 0x04 数据结束
ACK 0x06 接收成功
NAK 0x15 接收失败/请求重发
CAN 0x18 取消传输
C 0x43 请求以 CRC16 模式发送

数据包格式:

Header + PacketNo + (~PacketNo) + Data + CRC16_H + CRC16_L
包类型 Data 长度 总长度
SOH 128 133
STX 1024 1029

CRC 算法必须为 CRC-16/XMODEM:

poly=0x1021, init=0x0000, RefIn=false, RefOut=false, XorOut=0x0000

CRC 覆盖 Data 的全部固定长度字节(128 或 1024),并按 高字节、低字节 放在帧尾。

4. 包序号与数据填充

  1. 元数据包必须使用 SOH,PacketNo=0x00,反码为 0xFF。
  2. 首个文件数据包使用 PacketNo=0x01;每得到 ACK 后序号加 1,按 8 位自然回绕。
  3. 数据包正常使用 STX(1024 字节);最后一包不足 1024 字节时仍应补齐到 1024 字节,建议补 0x1A。
  4. Boot 校验包号、包号反码、帧长度与 CRC。任一校验失败会回复 NAK。
  5. 收到 NAK 时,必须重发原完整帧,包号不得递增。该 Boot 不将“前一帧重复包”当作成功帧,因此不能依赖重复包自动 ACK。

5. 元数据包规则

第一个包固定是包号 0 的 SOH 包,128 字节 Data 的内容为:

ASCII 文件名 + 0x00 + ASCII 十进制文件大小 + 0x00 + 其余补 0x00

示例(文件名仅用于协议描述,实际可使用真实 .upk 文件名):

protocol_v1.2.upk\0 123456\0 [其余填 0]

文件大小必须是待传输 .upk 的实际字节数。传输结束包也是 SOH/包号 0,但其 128 字节 Data 必须全部为 0x00。

6. .upk 文件要求

Boot 在接收数据后按 UPK 格式处理,而不是把它当作裸固件。

  • 头部标识必须为 UPK_IDENTIFIER=0x006B7075("upk")。
  • UPK 头为 1 字节对齐、总计 96 字节,包含版本、目标分区、原始/包体大小、CRC 等字段。
  • 工程当前启用 AES-256-CBC 解密;上位机职责仅为原样传输既有打包工具产生的 .upk,无需也不得自行改变加密、CRC 或头内容。
  • Boot 根据 UPK 头确定下载与安装流程;当前配置会先写 download 分区,再更新 app 分区。

7. 完整正常时序

Boot -> PC : C                         (每秒一次,等待开始)
PC   -> Boot: SOH, 00, FF, 元数据, CRC
Boot -> PC : ACK
Boot -> PC : C                         (必须等待此 C)

PC   -> Boot: STX/SOH, 01, FE, 数据块, CRC
Boot -> PC : ACK
PC   -> Boot: STX/SOH, 02, FD, 数据块, CRC
Boot -> PC : ACK
...                                    (直至全部 .upk 数据发送完成)

PC   -> Boot: EOT
Boot -> PC : NAK
PC   -> Boot: EOT
Boot -> PC : ACK
Boot -> PC : C
PC   -> Boot: SOH, 00, FF, 128 字节全 0, CRC
Boot -> PC : ACK

Boot      : 校验 UPK、写 Flash、安装 App、校验 App,并可能跳转 App

关键点:

  • 元数据 ACK 后,必须等 Boot 的第二个 C 才能发送数据包。
  • 第一个 EOT 后,必须等 NAK;第二个 EOT 后,必须等 ACK。
  • 第二个 EOT 的 ACK 后,必须等 C,再发送结束空包。
  • Boot 处理擦除和 Flash 写入期间,ACK 可能延迟;PC 的单帧 ACK 等待建议设为 3~10 秒。

8. 上位机状态机(可直接实现)

WAIT_C_START
  收到 C -> SEND_META

SEND_META
  发送包号 0 元数据 -> WAIT_META_ACK

WAIT_META_ACK
  ACK -> WAIT_C_DATA
  NAK/超时 -> 重发元数据

WAIT_C_DATA
  C -> SEND_DATA(包号=1)

SEND_DATA
  发送当前数据包 -> WAIT_DATA_ACK

WAIT_DATA_ACK
  ACK -> 若还有数据:包号+1,SEND_DATA;否则 SEND_EOT_1
  NAK/超时 -> 重发当前数据包

SEND_EOT_1
  发送 EOT -> WAIT_EOT_NAK

WAIT_EOT_NAK
  NAK -> SEND_EOT_2
  超时 -> 重发 EOT(保持本状态)

SEND_EOT_2
  发送 EOT -> WAIT_EOT_ACK

WAIT_EOT_ACK
  ACK -> WAIT_C_END
  NAK/超时 -> 重发 EOT

WAIT_C_END
  C -> SEND_END_PACKET

SEND_END_PACKET
  发送包号 0 的全 0 SOH 包 -> WAIT_END_ACK

WAIT_END_ACK
  ACK -> TRANSFER_FINISHED
  NAK/超时 -> 重发结束空包

9. 超时、重发、取消与结果判定

事件 上位机处理
收到 ACK 仅推进到下一协议状态;数据包 ACK 后才递增包号
收到 NAK 立即重发当前完整帧,不改变包号和文件偏移
单帧等待超时 重发当前完整帧;建议最多连续 3 次
重发次数耗尽 发送 CAN 两次,标记升级传输失败
收到 CAN 立即停止,标记 Boot 取消升级
用户取消 发送 CAN 两次,停止发送后续字节
无 C 不开始发送,提示设备未进入 Boot 或串口参数/连线错误

Boot 对单个 CAN 会进入取消流程并回 ACK;上位机仍建议按标准发送两个 CAN,并接受可能出现的 ACK。

WAIT_*_ACK 的建议超时为 3~10 秒,元数据后的 WAIT_C_DATA、结束阶段的 WAIT_C_END 建议为 10 秒。上位机可将串口接收设计为持续缓存并按字节解析,忽略调试文本或仅识别 C/ACK/NAK/CAN 控制字符,避免因分段到达造成误判。

10. 成功判定与日志

结束空包得到 ACK 仅表示 YMODEM 文件传输完成,不是最终“固件安装成功”的结构化回码。随后 Boot 仍需校验 .upk、写下载区、安装 App、校验 App。

上位机应分两级显示结果:

  1. 传输完成:收到结束空包 ACK。
  2. 升级确认成功:设备重启并进入 App 后,通过应用通信读取新固件版本(推荐)或观察 Boot/App 启动日志确认。

建议记录:开始时间、文件名/大小、每个包号、重试次数、控制字符、异常原因、传输完成时间和最终版本读取结果。

11. 与功率板 Boot 转发升级的边界

若上位机目标是功率板,而物理串口只连接协议板 App,则不能直接把本 YMODEM 原始字节流写到串口。需要按协议板 App 已实现/约定的 Modbus 扩展功能码 0x20 封装,再由 App 南向转发给功率板 Boot,并处理 App 的转发 ACK、C、NAK、超时和重发。

本文件可作为功率板转发方案中“YMODEM 内层状态机”的依据;外层 Modbus 0x20 帧格式和升级进入/退出控制需以 apps/chrg/applications/thread/chrg_comm.c、chrg_comm.h 的实际实现为准,不能与协议板 Boot 直连流程混用。

12. 代码依据

  • apps/boot/application/main.c:USART1/USART2 初始化及 Boot 启动。
  • apps/boot/application/func/transfer.c:USART1 接收传输层。
  • apps/boot/application/include/ymodem.h:YMODEM 常量、包定义。
  • apps/boot/application/func/ymodem.c:YMODEM 状态机、C/ACK/NAK/EOT 时序和超时。
  • apps/boot/application/func/app.c:UPK 接收、校验、写入和安装流程。
  • apps/boot/application/include/firmware.h:UPK 头和分区相关定义。
  • apps/boot/application/func/utils.c:CRC-16/XMODEM 实现。
  • apps/boot/application/include/app_config.h:超时、分区和 AES 配置。