✨ feat(system-overview): 创建系统总览文档 - 描述项目背景与硬件平台配置 - 提供 FreeRTOS 任务拓扑表(任务优先级、栈大小、职责) - 详细说明系统启动序列和初始化依赖关系 - 绘制 2D/1D 状态机完整流程图 - 解释 TEMP_REQ 辅助通道工作机制 - 说明任务间同步机制(Frame_Ready_Flag、双缓冲 TX) ✨ feat(dvp-module-design): 创建 DVP 模块设计文档 - 提供 DVP 硬件连接引脚映射表 - 描述 DVP 时序配置(信号极性、工作模式) - 解释 DMA ping-pong 行缓冲机制和切换逻辑 - 说明 DVP IRQ 帧组装流程(STR_FRM/ROW_DONE) - 定义 FrameBuffer 数据格式和像素访问方式 - 说明 TMP 模式温度换算公式和字节序要求 ✨ feat(qdx-protocol-design): 创建 QDX 协议设计文档 - 描述完整 TLV 帧结构(FrameHeader + TLV + CRC) - 列出所有 Class/Type 映射表和用途说明 - 解释零拷贝 TX 缓冲区架构(HeadOffset 机制) - 说明分片机制和最大载荷限制 - 定义 Flags 字段各位含义和使用场景 ✨ feat(tcp-module-design): 创建 TCP 通信模块设计文档 - 描述双流连接架构(控制流 5511 / 数据流 5512) - 说明握手流程和连接建立时序 - 解释心跳机制和 TCP Keepalive 配置 - 描述配置下发与缓存机制 - 说明数据发送队列和背压处理策略 - 解释 WCHNET 网络栈驱动任务工作机制 ✨ feat(integration-guide): 创建对接集成指南 - 提供网络接入参数表(IP、端口、协议) - 详细说明握手流程和配置下发格式 - 提供 2D/1D 温度帧解析方法和示例代码 - 说明检测结果上报和 NG 响应机制 - 解释 TEMP_REQ 按需截图工作方式 - 列出错误码表和对接故障排查步骤
1.8 KiB
1.8 KiB
Proposal: CH32V307 固件系统软件设计文档
Why
项目已完成核心功能开发,但缺乏系统级软件设计文档:内部无法快速理解任务拓扑和状态机逻辑,外部对接方缺乏集成参考。当前文档仅覆盖配置和协议层面,未形成完整的设计视图。
What Changes
- 新增 系统总览文档:FreeRTOS 任务拓扑(任务职责、优先级、通信方式)、2D/1D 双状态机完整流程图、网络栈初始化与运行流程
- 新增 DVP 采集模块设计文档:DVP 硬件配置原理、DMA ping-pong 机制、IRQ 帧组装逻辑、FrameBuffer 数据格式
- 新增 QDX 协议模块设计文档:TLV 帧结构、所有 Type 定义与用途、零拷贝 TX 缓冲区架构、分片机制
- 新增 TCP 通信模块设计文档:双流(5511 控制 / 5512 数据)连接管理、心跳机制、配置下发与缓存、数据发送队列
- 新增 对接集成文档:供上位机/ConfigServer 开发方参考的接入指南(握手流程、配置下发、数据帧解析、错误码)
Capabilities
New Capabilities
system-overview: FreeRTOS 任务拓扑、2D 状态机、1D 状态机、系统启动序列dvp-module-design: DVP 硬件初始化、DMA ping-pong 行采集、帧组装、FrameBuffer 格式qdx-protocol-design: TLV 帧格式、Class/Type 定义、零拷贝 TX 架构、CRC、分片tcp-module-design: 双流连接管理、心跳、配置缓存、发送队列integration-guide: 外部对接方集成手册(握手、配置、数据解析、错误处理)
Modified Capabilities
(无,本变更仅新增文档,不修改现有规范)
Impact
- 新增文档目录:
Doc/设计文档/或各模块独立文件 - 不涉及任何代码修改
- 影响范围:内部开发参考、外部对接方(ConfigServer 开发团队)