diff --git a/.github/workflows/host-tests.yml b/.github/workflows/host-tests.yml new file mode 100644 index 0000000..d7f0dbe --- /dev/null +++ b/.github/workflows/host-tests.yml @@ -0,0 +1,25 @@ +# 主机侧检查(阶段 3 / 5):algorithm/ 单元测试、分层检查、接入引擎测试。固件要接 CubeMX 工程才能编: +# 生成结果的编译测试是 tools/tests/compile_test.py(要 ARM 工具链与 STM32CubeMX,本地跑)。 +name: host-tests + +on: + push: + pull_request: + +jobs: + host: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: 分层检查(下层不包含上层) + run: python3 tools/check_layers.py + - name: 接入清单自检(tools/manifest.json 的片段占位符、规则引用) + run: cd tools && python3 -m icbsp_tool.manifest + - name: 接入引擎测试(.ioc 解析 / 校验 / 生成快照 / 生成区同步) + run: cd tools && python3 -m unittest discover -s tests -v + - name: 构建主机单元测试 + run: | + cmake -S tests/host -B build/host + cmake --build build/host + - name: 运行 + run: ctest --test-dir build/host --output-on-failure diff --git a/CMakeLists.txt b/CMakeLists.txt index bf29abc..88b2558 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,10 +1,10 @@ # ------------------------------------------------------------------------------ -# stm32_framework:以 git submodule + add_subdirectory 方式接入 STM32H7 / STM32F4 CubeMX(CMake)工程的板级库 +# icbsp:以 git submodule + add_subdirectory 方式接入 STM32H7 / STM32F4 CubeMX(CMake)工程的板级库 # # 宿主工程(CubeMX 生成的根 CMakeLists.txt,##### User ##### 段): # -# add_subdirectory(third_party/stm32-framework) -# target_link_libraries(${CMAKE_PROJECT_NAME} stm32_framework) +# add_subdirectory(third_party/icbsp) +# target_link_libraries(${CMAKE_PROJECT_NAME} icbsp) # # 本仓库只提供库、模板和文档,不内置示例工程。 # ------------------------------------------------------------------------------ @@ -12,145 +12,137 @@ cmake_minimum_required(VERSION 3.22) if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) message(FATAL_ERROR - "stm32_framework 是库,不能单独配置。请在宿主工程里 add_subdirectory() 接入本库。") + "icbsp 是库,不能单独配置。请在宿主工程里 add_subdirectory() 接入本库。") endif() if(NOT TARGET stm32cubemx) message(FATAL_ERROR - "找不到 CubeMX 生成的 stm32cubemx 目标:请在 add_subdirectory(cmake/stm32cubemx) 之后再接入 stm32_framework") + "找不到 CubeMX 生成的 stm32cubemx 目标:请在 add_subdirectory(cmake/stm32cubemx) 之后再接入 icbsp") endif() enable_language(C CXX ASM) # OBJECT 库而不是 STATIC:库里有覆盖 HAL / FreeRTOS 弱符号的强定义(HAL_*Callback、fault_on_*), # 静态库成员不会因为“覆盖弱符号”被链接器拉进来,会静默失效。 -add_library(stm32_framework OBJECT) +add_library(icbsp OBJECT) -file(GLOB_RECURSE STM32_FRAMEWORK_SOURCES CONFIGURE_DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/code/bsp/*.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/code/service/*.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/code/tasks/*.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/code/device/*.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/code/protocol/*.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/code/algorithm/*.cpp +file(GLOB_RECURSE ICBSP_SOURCES CONFIGURE_DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/code/*.cpp ) -target_sources(stm32_framework PRIVATE ${STM32_FRAMEWORK_SOURCES}) +target_sources(icbsp PRIVATE ${ICBSP_SOURCES}) +# 包含路径只有 code/:库内外一律写成 #include "bsp/bsp_uart.hpp"、"device/motor/dji_motor.hpp", +# 分层关系从包含语句就看得出来(下层不出现上层路径),也不怕不同子目录里的文件重名。 # 库里不包含任何板级头文件:HAL 回调与库任务按 board_instances.hpp 的实例清单逐个展开 -target_include_directories(stm32_framework PUBLIC - ${CMAKE_CURRENT_SOURCE_DIR}/code/bsp - ${CMAKE_CURRENT_SOURCE_DIR}/code/service - ${CMAKE_CURRENT_SOURCE_DIR}/code/tasks - ${CMAKE_CURRENT_SOURCE_DIR}/code/device - ${CMAKE_CURRENT_SOURCE_DIR}/code/protocol - ${CMAKE_CURRENT_SOURCE_DIR}/code/algorithm +target_include_directories(icbsp PUBLIC + ${CMAKE_CURRENT_SOURCE_DIR}/code ) # HAL / CMSIS / FreeRTOS 的头文件与宏都来自 CubeMX 的 stm32cubemx(INTERFACE)目标 -target_link_libraries(stm32_framework PUBLIC stm32cubemx) +target_link_libraries(icbsp PUBLIC stm32cubemx) # 用户配置 hardware_config.h:唯一配置源,必须由宿主提供(模板 templates/user/board/hardware_config.h)。 -# 放在宿主 user/board/(推荐;宿主给 stm32_framework 加该包含路径)或 stm32cubemx 的包含目录里。 -get_target_property(_stm32_framework_mx_inc stm32cubemx INTERFACE_INCLUDE_DIRECTORIES) -set(_stm32_framework_cfg_dirs ${_stm32_framework_mx_inc}) -list(APPEND _stm32_framework_cfg_dirs "${CMAKE_SOURCE_DIR}/user/board") -set(_stm32_framework_cfg "") -foreach(_stm32_framework_dir IN LISTS _stm32_framework_cfg_dirs) - if(NOT _stm32_framework_cfg AND EXISTS "${_stm32_framework_dir}/hardware_config.h") - set(_stm32_framework_cfg "${_stm32_framework_dir}/hardware_config.h") +# 放在宿主 user/board/(推荐;宿主给 icbsp 加该包含路径)或 stm32cubemx 的包含目录里。 +get_target_property(_icbsp_mx_inc stm32cubemx INTERFACE_INCLUDE_DIRECTORIES) +set(_icbsp_cfg_dirs ${_icbsp_mx_inc}) +list(APPEND _icbsp_cfg_dirs "${CMAKE_SOURCE_DIR}/user/board") +set(_icbsp_cfg "") +foreach(_icbsp_dir IN LISTS _icbsp_cfg_dirs) + if(NOT _icbsp_cfg AND EXISTS "${_icbsp_dir}/hardware_config.h") + set(_icbsp_cfg "${_icbsp_dir}/hardware_config.h") endif() endforeach() -if(_stm32_framework_cfg) - message(STATUS "stm32_framework: 使用配置 ${_stm32_framework_cfg}") +if(_icbsp_cfg) + message(STATUS "icbsp: 使用配置 ${_icbsp_cfg}") else() - message(STATUS "stm32_framework: 没找到 hardware_config.h(必须由宿主提供,模板 templates/user/board/hardware_config.h)") + message(STATUS "icbsp: 没找到 hardware_config.h(必须由宿主提供,模板 templates/user/board/hardware_config.h)") endif() # 链接脚本检查:BspUartT 实例要进 .dma_buffer、fault_record 要进 .noinit。CubeMX 新建工程的链接脚本 # 没有这两段,缺了链接器只会把它们当孤儿段随便放(可能落进 DMA 访问不到的 DTCM),运行时才静默出错。 # 所以在配置阶段检查,并把链接脚本登记为配置依赖:它一变(手改、换模板、CubeMX 重新生成),下次构建就重新检查。 # 只认 CMAKE_EXE_LINKER_FLAGS 里的 -T(CubeMX 生成的工具链文件就是这样写的),找不到就跳过。 -string(REGEX MATCH "-T[ \t]*\"([^\"]+)\"" _stm32_framework_ld_match "${CMAKE_EXE_LINKER_FLAGS}") -set(_stm32_framework_ld "${CMAKE_MATCH_1}") -if(NOT _stm32_framework_ld) - string(REGEX MATCH "-T[ \t]*([^ \t\"]+)" _stm32_framework_ld_match "${CMAKE_EXE_LINKER_FLAGS}") - set(_stm32_framework_ld "${CMAKE_MATCH_1}") +string(REGEX MATCH "-T[ \t]*\"([^\"]+)\"" _icbsp_ld_match "${CMAKE_EXE_LINKER_FLAGS}") +set(_icbsp_ld "${CMAKE_MATCH_1}") +if(NOT _icbsp_ld) + string(REGEX MATCH "-T[ \t]*([^ \t\"]+)" _icbsp_ld_match "${CMAKE_EXE_LINKER_FLAGS}") + set(_icbsp_ld "${CMAKE_MATCH_1}") endif() # 系列探测:从 CubeMX 的包含目录里找 hal_conf.h。 # H7 需要 .dma_buffer + .noinit 两段;F4 主 SRAM 可直接被 DMA 访问,只需要 .noinit。 -set(_stm32_framework_series "") -foreach(_stm32_framework_dir IN LISTS _stm32_framework_mx_inc) - if(EXISTS "${_stm32_framework_dir}/stm32h7xx_hal_conf.h") - set(_stm32_framework_series "h7") - elseif(EXISTS "${_stm32_framework_dir}/stm32f4xx_hal_conf.h") - set(_stm32_framework_series "f4") +set(_icbsp_series "") +foreach(_icbsp_dir IN LISTS _icbsp_mx_inc) + if(EXISTS "${_icbsp_dir}/stm32h7xx_hal_conf.h") + set(_icbsp_series "h7") + elseif(EXISTS "${_icbsp_dir}/stm32f4xx_hal_conf.h") + set(_icbsp_series "f4") endif() endforeach() -if(_stm32_framework_ld AND EXISTS "${_stm32_framework_ld}" AND _stm32_framework_series STREQUAL "f4") +if(_icbsp_ld AND EXISTS "${_icbsp_ld}" AND _icbsp_series STREQUAL "f4") # F4:只查 .noinit(fault_record 靠它保留复位现场);.dma_buffer 在 F4 上不生成,不用查 - set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${_stm32_framework_ld}") - file(READ "${_stm32_framework_ld}" _stm32_framework_ld_text) - if(NOT _stm32_framework_ld_text MATCHES "\\.noinit[ \t]*(\\(NOLOAD\\))?[ \t\r\n]*:") + set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${_icbsp_ld}") + file(READ "${_icbsp_ld}" _icbsp_ld_text) + if(NOT _icbsp_ld_text MATCHES "\\.noinit[ \t]*(\\(NOLOAD\\))?[ \t\r\n]*:") message(FATAL_ERROR - "stm32_framework: 链接脚本 ${_stm32_framework_ld} 缺少 .noinit 段(fault_record 用它保留复位现场)。" + "icbsp: 链接脚本 ${_icbsp_ld} 缺少 .noinit 段(fault_record 用它保留复位现场)。" "请把 ${CMAKE_CURRENT_SOURCE_DIR}/templates/linker_sections.ld 里的 .noinit 段加进 SECTIONS。") endif() - message(STATUS "stm32_framework: 链接脚本检查通过(F4 只需要 .noinit):${_stm32_framework_ld}") -elseif(_stm32_framework_ld AND EXISTS "${_stm32_framework_ld}") - set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${_stm32_framework_ld}") - file(READ "${_stm32_framework_ld}" _stm32_framework_ld_text) - set(_stm32_framework_ld_missing "") - foreach(_stm32_framework_sec dma_buffer noinit) - if(NOT _stm32_framework_ld_text MATCHES "\\.${_stm32_framework_sec}[ \t]*(\\(NOLOAD\\))?[ \t\r\n]*:") - list(APPEND _stm32_framework_ld_missing ".${_stm32_framework_sec}") + message(STATUS "icbsp: 链接脚本检查通过(F4 只需要 .noinit):${_icbsp_ld}") +elseif(_icbsp_ld AND EXISTS "${_icbsp_ld}") + set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${_icbsp_ld}") + file(READ "${_icbsp_ld}" _icbsp_ld_text) + set(_icbsp_ld_missing "") + foreach(_icbsp_sec dma_buffer noinit) + if(NOT _icbsp_ld_text MATCHES "\\.${_icbsp_sec}[ \t]*(\\(NOLOAD\\))?[ \t\r\n]*:") + list(APPEND _icbsp_ld_missing ".${_icbsp_sec}") endif() endforeach() - if(_stm32_framework_ld_missing) - list(JOIN _stm32_framework_ld_missing "、" _stm32_framework_ld_missing) + if(_icbsp_ld_missing) + list(JOIN _icbsp_ld_missing "、" _icbsp_ld_missing) message(FATAL_ERROR - "stm32_framework: 链接脚本 ${_stm32_framework_ld} 缺少 ${_stm32_framework_ld_missing} 段" + "icbsp: 链接脚本 ${_icbsp_ld} 缺少 ${_icbsp_ld_missing} 段" "。请把 ${CMAKE_CURRENT_SOURCE_DIR}/templates/linker_sections.ld 里的段加进去(放在 SECTIONS 里 .data 之前)。") endif() # .dma_buffer 里是 constexpr 全局实例:必须是可加载段(AT> FLASH),否则句柄/波特率等初值丢失 - string(FIND "${_stm32_framework_ld_text}" "\n .dma_buffer" _stm32_framework_dma_pos) - if(_stm32_framework_dma_pos EQUAL -1) + string(FIND "${_icbsp_ld_text}" "\n .dma_buffer" _icbsp_dma_pos) + if(_icbsp_dma_pos EQUAL -1) message(FATAL_ERROR - "stm32_framework: ${_stm32_framework_ld} 里找不到缩进 2 空格的 .dma_buffer 段定义。" + "icbsp: ${_icbsp_ld} 里找不到缩进 2 空格的 .dma_buffer 段定义。" "请按 templates/linker_sections.ld 的格式手动加入。") endif() - string(SUBSTRING "${_stm32_framework_ld_text}" ${_stm32_framework_dma_pos} -1 _stm32_framework_dma_rest) - string(FIND "${_stm32_framework_dma_rest}" "\n .noinit" _stm32_framework_dma_len) - if(_stm32_framework_dma_len EQUAL -1) - string(LENGTH "${_stm32_framework_dma_rest}" _stm32_framework_dma_len) + string(SUBSTRING "${_icbsp_ld_text}" ${_icbsp_dma_pos} -1 _icbsp_dma_rest) + string(FIND "${_icbsp_dma_rest}" "\n .noinit" _icbsp_dma_len) + if(_icbsp_dma_len EQUAL -1) + string(LENGTH "${_icbsp_dma_rest}" _icbsp_dma_len) endif() - string(SUBSTRING "${_stm32_framework_dma_rest}" 0 ${_stm32_framework_dma_len} _stm32_framework_dma_block) - string(FIND "${_stm32_framework_dma_block}" "(NOLOAD)" _stm32_framework_dma_noload) - if(NOT _stm32_framework_dma_noload EQUAL -1) + string(SUBSTRING "${_icbsp_dma_rest}" 0 ${_icbsp_dma_len} _icbsp_dma_block) + string(FIND "${_icbsp_dma_block}" "(NOLOAD)" _icbsp_dma_noload) + if(NOT _icbsp_dma_noload EQUAL -1) message(FATAL_ERROR - "stm32_framework: ${_stm32_framework_ld} 的 .dma_buffer 写成了 NOLOAD,实例初值不会进 Flash。" + "icbsp: ${_icbsp_ld} 的 .dma_buffer 写成了 NOLOAD,实例初值不会进 Flash。" "请改成 `.dma_buffer : { ... } >RAM_D1 AT> FLASH`(见 templates/linker_sections.ld)。") endif() - string(FIND "${_stm32_framework_dma_block}" "AT>" _stm32_framework_dma_at) - if(_stm32_framework_dma_at EQUAL -1) + string(FIND "${_icbsp_dma_block}" "AT>" _icbsp_dma_at) + if(_icbsp_dma_at EQUAL -1) message(FATAL_ERROR - "stm32_framework: ${_stm32_framework_ld} 的 .dma_buffer 缺少 AT> FLASH 加载区。" + "icbsp: ${_icbsp_ld} 的 .dma_buffer 缺少 AT> FLASH 加载区。" "请参考 templates/linker_sections.ld,把初值放进 Flash。") endif() - message(STATUS "stm32_framework: 链接脚本检查通过(.dma_buffer 可加载、.noinit):${_stm32_framework_ld}") + message(STATUS "icbsp: 链接脚本检查通过(.dma_buffer 可加载、.noinit):${_icbsp_ld}") else() - message(STATUS "stm32_framework: CMAKE_EXE_LINKER_FLAGS 里没找到 -T 链接脚本,跳过 .dma_buffer / .noinit 检查") + message(STATUS "icbsp: CMAKE_EXE_LINKER_FLAGS 里没找到 -T 链接脚本,跳过 .dma_buffer / .noinit 检查") endif() -set_target_properties(stm32_framework PROPERTIES +set_target_properties(icbsp PROPERTIES CXX_STANDARD 20 CXX_STANDARD_REQUIRED ON CXX_EXTENSIONS OFF # 标准 C++20(-std=c++20),不依赖 GNU 扩展(评审 D3) ) # 库自己的警告选项:“0 warning”不再取决于宿主的编译参数(评审 D3)。只作用于库的源文件,不传给宿主。 -target_compile_options(stm32_framework PRIVATE +target_compile_options(icbsp PRIVATE $<$:-Wall -Wextra -Wshadow> ) # 第三方源码(VQF,MIT)保持上游原样,不为 -Wshadow 改它 diff --git a/LICENSE b/LICENSE index f0fd20a..c7351b5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) +Copyright (c) 2026 INVC & CUBOT Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ba78ff1..ae44d5c 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,151 @@ -# stm32-framework +# ICBSP -![GitHub Release](https://img.shields.io/github/v/release/cubot-refactor-code-plan/stm32-framework)[![License](https://img.shields.io/github/license/cubot-refactor-code-plan/stm32-framework.svg)](https://github.com/cubot-refactor-code-plan/stm32-framework/blob/main/LICENSE) -![](https://img.shields.io/badge/chip-STM32H7xx-blue.svg) ![](https://img.shields.io/badge/RTOS-FreeRTOS_CMSIS_V2-green.svg) ![](https://img.shields.io/badge/language-C++20-blue.svg) ![](https://img.shields.io/badge/ToolChain-CMake-blue.svg) +![GitHub Release](https://img.shields.io/github/v/release/cubot-refactor-code-plan/ICBSP) [![License](https://img.shields.io/github/license/cubot-refactor-code-plan/ICBSP.svg)](https://github.com/cubot-refactor-code-plan/ICBSP/blob/main/LICENSE) ![CopyRight](https://img.shields.io/badge/CopyRight-INVC%20&%20CUBOT-blue.svg) +![](https://img.shields.io/badge/chip-STM32H7xx%20%7C%20STM32F4xx-blue.svg) ![](https://img.shields.io/badge/RTOS-FreeRTOS_CMSIS_V2-green.svg) ![](https://img.shields.io/badge/language-C++20-blue.svg) ![](https://img.shields.io/badge/ToolChain-CMake-blue.svg) -面向 **STM32H7 + FreeRTOS(CMSIS-RTOS V2)+ CMake** 的板级库:BSP、Service、Device、Protocol、Algorithm 分层,宿主工程通过 git submodule 接入。 +面向 **STM32H7 / STM32F4 + FreeRTOS(CMSIS-RTOS V2)+ CMake** 的板级库:BSP、Service、Device、Algorithm、Tasks 分层,宿主工程通过 git submodule 接入。 -- 语言:**C++20**(`inline` 变量、指定初始化器) -- 构建:CMake ≥ 3.22,ARM GNU Toolchain -- 目标:任意 STM32H7 CubeMX(CMake)工程 -- 许可证:MIT,见根目录 `LICENSE` +- 语言:**C++20**(`inline` 变量、指定初始化器);库和宿主都按 C++20 编译 +- 构建:CMake ≥ 3.22,ARM GNU Toolchain;库是 CMake **OBJECT 库** `icbsp`(用强定义覆盖 HAL / FreeRTOS 的弱符号) +- 目标:STM32H7 CubeMX(Toolchain = CMake)工程;STM32F4 的移植只编译验证过,CAN 的任务 / 节点还没接上 +- 许可证:MIT,见根目录 `LICENSE`(版权人 INVC & CUBOT);例外见 [许可证](#许可证) +- 宏前缀:`ICBSP_`(配置宏、功能开关、实例清单、系列宏),CMake 目标 `icbsp` -> 当前状态:`User/` 的 BSP / Service / Device / Protocol(Emm_V5)/ Algorithm(PID)已合并进库。 -> BSP 层没有运行时登记表、基类、虚函数;实例由宿主的 `board_instances.hpp` 清单驱动。 -> `dm_mc02` 已通过 Debug / Release 编译(0 warning),实板验证尚未完成。 +> **当前状态(v1.0.0 之前)**:阶段 1~3 已完成——UART / CAN 回填、评审遗留问题、新功能(EventState 默认树、DmMotor 等), +> 并在 DM-MC02(STM32H723)上做了 Debug 与 -O2 两轮全面实板回归(服务层、状态树、UART(DMA / IT)、RS485、CAN、SPI + BMI088、 +> DJI / 达妙电机转动,含 5 分钟浸泡),记录见 [docs/bsp_test/phase3_2026-11-06.md](docs/bsp_test/phase3_2026-11-06.md)。 +> 哪些模块实测过、哪些只编译验证,见 [docs/code/README.md 的实测状态表](docs/code/README.md#4-实测状态)。路线与待办在 [undo.md](undo.md)。 ## 目录 ```text -stm32-framework/ -├─ code/ 库源码(分层见 docs/code/) -│ ├─ bsp/ CAN、UART、SPI、PWM、GPIO、Key、Encoder、DWT -│ ├─ service/ Status / EventState、Online、CAN 收发节点、fault_record、system -│ ├─ device/ DjiMotor、DeviceMotor、Servo、R9DS、Emm_V5、BMI088、Buzzer -│ ├─ protocol/ emmv5_protocol(帧编解码) -│ ├─ algorithm/ PID、QuaternionPID、VQF、Quaternion、Matrix、RLS -│ └─ tasks/ sys_task、can_rx_task、can_tx_task -├─ templates/ 宿主接入模板(board、app、链接脚本、FreeRTOS 钩子、.vscode、Flash) -├─ tools/ integrate.py(自动接入)、draw_diagrams.py(画架构图) -├─ docs/ 接入指南、常用接口、编辑器配置、代码层说明、架构图、器件手册 +ICBSP/ +├─ code/ 库源码(分层见 docs/code/;包含路径只加 code/,写成 "bsp/bsp_uart.hpp") +│ ├─ bsp/ CAN(FDCAN / bxCAN)、UART、SPI、PWM、GPIO、Key、Encoder、DWT;系列桥接、.dma_buffer 宏 +│ ├─ service/ +│ │ ├─ system/ 库入口、Status / EventState、默认状态树、fault_record、配置检查、newlib 锁 +│ │ ├─ comm/ CAN 收发节点 +│ │ ├─ monitor/ Online +│ │ └─ definition/ 电机 / IMU 数据定义 +│ ├─ device/ +│ │ ├─ motor/ DjiMotor、DmMotor、DeviceMotor、Emm_V5(含 emmv5_protocol 帧编解码) +│ │ ├─ sensor/ BMI088 +│ │ ├─ remote/ R9DS +│ │ └─ actuator/ Servo、Buzzer +│ ├─ algorithm/ PID、QuaternionPID、Quaternion、VQF、Matrix、RLS +│ └─ tasks/ sys_task、can_rx_task、can_tx_task +├─ templates/ 宿主接入模板(user/board、user/app、链接脚本、FreeRTOS / 中断钩子、.vscode、Flash) +├─ tools/ integrate.py(自动接入与生成)、manifest.json(生成清单)、web_ui/(图形界面)、check_layers.py、draw_diagrams.py +├─ tests/host/ algorithm/ 的主机侧单元测试(CI:.github/workflows/host-tests.yml);接入引擎的测试在 tools/tests/ +├─ docs/ 接入指南、常用接口、编码规范、代码层说明、架构图、实板测试记录、器件手册 └─ CMakeLists.txt ``` +## 克隆 + +建议将本仓库作为`submodule`克隆到目标宿主工程,以获得更新支持 +若目的仅为使用,建议浅克隆`main`分支 +```bash +$ git submodule add --depth 1 git@github.com:cubot-refactor-code-plan/ICBSP.git Middlewares/Third_Party/ # 浅克隆最近一次主分支内的提交 +``` + +若希望克隆特定分支 +```bash +$ git submodule add -b --depth git@github.com:cubot-refactor-code-plan/ICBSP.git +``` + + ## 快速接入 +### 直接使用python脚本 +![python_version](https://img.shields.io/badge/python-3.7-blue.svg) 在宿主工程根目录: ```bash -python3 third_party/stm32-framework/tools/integrate.py --dry-run # 只看将改什么 -python3 third_party/stm32-framework/tools/integrate.py # 执行 +python3 third_party/icbsp/tools/integrate.py --dry-run # 只看将改什么 +python3 third_party/icbsp/tools/integrate.py # 执行 ``` 脚本可重复执行,已完成的步骤会跳过。它会检查 CubeMX 前提、给链接脚本加 `.dma_buffer` / `.noinit`、 -接 `FreeRTOSConfig.h` 与 `freertos.c` 的 USER CODE 段、复制 `user/board` 与 `user/app` 模板、 +接 `FreeRTOSConfig.h`、`freertos.c`、`stm32h7xx_it.c` 的 USER CODE 段、复制 `user/board` 与 `user/app` 模板、 改根 `CMakeLists.txt`、生成 `.vscode/*`、复制 `Flash/` 烧录脚本。 -参数、每步的判定条件、排错见 **[docs/接入指南.md](docs/接入指南.md)**。 +### Nodejs图形化界面 +![](https://img.shields.io/badge/Node-v14.14.0-green.svg) +按 CubeMX 的 `.ioc` 生成外设实例和设备、校验并修改 `.ioc`,可以用图形界面(零依赖,不用 `npm install`): + +```bash +node third_party/icbsp/tools/web_ui/server.mjs # 浏览器打开 http://127.0.0.1:8765/ +``` + +参数、每步的判定条件、手动接入步骤、排错见 **[docs/接入指南.md](docs/接入指南.md)**。 ## 接入要求 -| 项目 | 要求 | -| -------- | -------------------------------------------------------- | -| 芯片 | STM32H7 系列 | -| 工具链 | CubeMX → Project Manager → Toolchain = **CMake** | -| RTOS | FreeRTOS,**CMSIS_V2**,tick **1 kHz** | -| HAL 时基 | 不用 SysTick;优先级没有要求(CubeMX 默认 15 即可,1.4 起实测) | -| FDCAN | 经典 CAN,RX FIFO0,开 FDCAN 中断 | -| UART | RX/TX DMA + 全局中断(驱动用 IDLE 断帧) | -| SPI | 全双工主机、软件 NSS、`MasterKeepIOState = ENABLE` | -| 链接脚本 | 必须有**可加载**的 `.dma_buffer` 与 `.noinit` | - -库按 `HAL_FDCAN_MODULE_ENABLED` / `HAL_UART_MODULE_ENABLED` / `HAL_SPI_MODULE_ENABLED` 等宏条件编译: -没开的外设不会生成对应驱动和任务。每项要求的原因、CubeMX 里怎么勾、接完怎么自查, -见 **[docs/接入指南.md](docs/接入指南.md)**。 +| 项目 | 要求 | +| -------- | ------------------------------------------------------------------------------------------ | +| 芯片 | STM32H7;STM32F4 只编译验证 | +| 工具链 | CubeMX → Project Manager → Toolchain = **CMake**;C++20 | +| RTOS | FreeRTOS,**CMSIS_V2**,tick **1 kHz**,`configCHECK_FOR_STACK_OVERFLOW = 2`、`configUSE_MALLOC_FAILED_HOOK = 1` | +| HAL 时基 | 不用 SysTick;优先级没有要求(CubeMX 默认 15 即可,1.4 起实测) | +| D-Cache | 保持关闭(库不做 Cache 维护) | +| FDCAN | 经典 CAN,RX FIFO0,开 FDCAN 中断 | +| UART | RX / TX DMA + 全局中断(RX DMA 由库改成循环模式,用 IDLE / 半满 / 写满事件投递);或中断模式 | +| SPI | 全双工主机、软件 NSS、`MasterKeepIOState = ENABLE` | +| 链接脚本 | 必须有**可加载**的 `.dma_buffer`(`>RAM_D1 AT> FLASH`)与 `.noinit`;CMake 配置阶段检查 | + +库按 `HAL_FDCAN_MODULE_ENABLED` / `HAL_UART_MODULE_ENABLED` / `HAL_SPI_MODULE_ENABLED` / `HAL_TIM_MODULE_ENABLED` 条件编译: +没开的外设不会生成对应驱动和任务。每项要求的原因、CubeMX 里怎么勾、接完怎么自查,见 **[docs/接入指南.md](docs/接入指南.md)**。 ## 文档 -| 文档 | 内容 | -| ----------------------------------------- | ------------------------------------------------------------------ | -| [docs/接入指南.md](docs/接入指南.md) | 硬性要求逐条解释、CubeMX 设置、自动/手动接入、自查清单、常见问题 | -| [docs/code/](docs/code/) | 代码层索引:分层依赖图、启动顺序图、依赖矩阵、六层文档 | -| [docs/常用接口.md](docs/常用接口.md) | UART / CAN / 电机 / PID / 系统状态的使用示例 | -| [docs/编辑器配置.md](docs/编辑器配置.md) | `.vscode/settings.json` 各项作用;outline++ 分区正则逐段拆解 | -| [docs/编码规范.md](docs/编码规范.md) | 命名、分层、注释格式 | -| [templates/README.md](templates/README.md) | 每个模板文件复制到宿主哪里;`.vscode` 与 `Flash/` 的占位符规则 | -| [docs/bsp_test/](docs/bsp_test/) | BSP 历史测试记录(旧 API 名称不代表当前接口) | +| 文档 | 内容 | +| ------------------------------------------ | ------------------------------------------------------------------- | +| [docs/接入指南.md](docs/接入指南.md) | 硬性要求逐条解释、CubeMX 设置、自动 / 手动接入、自查清单、常见问题 | +| [docs/code/](docs/code/) | 代码层索引:分层依赖图、启动顺序图、依赖矩阵、五层文档 | +| [docs/常用接口.md](docs/常用接口.md) | UART / CAN / 电机 / PID / 系统状态的使用示例 | +| [docs/编码规范.md](docs/编码规范.md) | 命名、分层、注释格式、C++20 规则 | +| [docs/编辑器配置.md](docs/编辑器配置.md) | `.vscode/settings.json` 各项作用;outline++ 分区正则逐段拆解 | +| [templates/README.md](templates/README.md) | 每个模板文件复制到宿主哪里;`.vscode` 与 `Flash/` 的占位符规则 | +| [docs/bsp_test/](docs/bsp_test/) | 实板测试记录(每份注明对应的代码版本;早期记录里的 API 名称是旧的) | +| [docs/service_test/](docs/service_test/) | EventState / Online 的实板测试记录(2026-11-01) | +| [docs/sheet/](docs/sheet/) | 器件手册(版权归各厂商,见其中 README) | +| [undo.md](undo.md) | v1.0.0 路线与待办 | +| `stm32_bsp_review.md`、`stm32_framework_对比评估.md` | 评审与合并方案(代码注释里的 F / A / I / D / N / Q 编号出自这两份) | ## 配置 -`user/board/hardware_config.h` 是**唯一配置源**:任务开关、优先级、栈深、队列深度、超时都在这里, -HAL 模块没开时对应开关会自动置 0。模板见 `templates/user/board/hardware_config.h`。 +宿主的 `hardware_config.h`(模板 `templates/user/board/hardware_config.h`)是**必须提供的完整配置**,库里没有默认值: +任务开关、优先级、栈深、队列深度、超时都在这里。库只经 `service/system/config_check.hpp` 读取它:缺宏 `#error`、 +开关依赖与取值范围 `static_assert`,HAL 模块没开时强制关掉对应开关。 ```c -#define SYS_TASK_ENABLE 1 -#define CAN_RX_ENABLE 1 -#define CAN_TX_ENABLE 1 -#define UART_PATROL_ENABLE 1 +#define ICBSP_SYS_TASK_ENABLE 1 +#define ICBSP_CAN_RX_ENABLE 1 +#define ICBSP_CAN_TX_ENABLE 1 +#define ICBSP_UART_PATROL_ENABLE 1 ``` ## 库任务 -`system_init()` 创建 `sys_task`(10 ms:DWT 计时、CAN Bus-Off 恢复、UART 巡检、`Online::update()`, -每 2 s 打印一次循环耗时)与 `can_rx_task`(按 ID 分发,未认领的进回退缓冲)。 +`system_init()` 创建 `sys_task`(10 ms:DWT 时间轴、CAN Bus-Off 恢复与发送兜底、UART 巡检、`Online::update()`、默认状态树巡检, +耗时统计写在 `sys_task_stats`;库本身不打印,宿主用 `system_set_report_hook()` 接打印)与 `can_rx_task`(1 ms,按 ID 分发,未认领的进回退缓冲)。 `system_start()` 检查发送节点,有节点才创建 `can_tx_task`(槽位聚合、保底心跳、指令有效期)。 -CAN 接收和发送保持两个独立任务,不合并。 +`DeviceBmi088` 默认在 `init()` 里建自己的刷新任务。库任务优先级按 `configMAX_PRIORITIES` 往下取(CAN −2 > BMI088 −3 > sys −4),业务任务要更低。 ## 已知限制 -- BSP 没有运行时登记表,`board_instances.hpp` 必须和 `board_cfg.*` 同步。实例漏写、或清单里两个实例绑同一句柄时,`BspUartT` / `BspCanT` / `BspSpi` 的 `init()` 返回 `BAD_ARG`(`board_init()` 里断言停机)。 -- 清单外的同类外设(宿主自己用 HAL 管的 UART / SPI / FDCAN)收到的 HAL 回调转到弱函数 `icbsp_unhandled_*()`,见 `docs/code/bsp.md`。 -- `BspUartT` 只有头文件,任意 Transport / 缓冲尺寸组合都不用在库里补显式实例化。 +- BSP 没有运行时登记表,`board_instances.hpp` 必须和 `board_cfg.*` 同步。实例漏写、或清单里两个实例绑同一句柄时,`BspUartT` / `BspCanT` / `BspSpi` 的 `init()` 返回 `BAD_ARG`(`board_init()` 里 `ICBSP_CHECK` 停机)。 +- 清单外的同类外设(宿主自己用 HAL 管的 UART / SPI / FDCAN)收到的 HAL 回调转到弱函数 `icbsp_unhandled_*()`,见 [docs/code/bsp.md](docs/code/bsp.md)。 +- UART 循环 DMA 接收:串口 / DMA 中断被挡住的时间要短于收满半个接收缓冲的时间(128 字节、921600 下约 0.69 ms),否则可能静默丢数据。 +- 库假定 D-Cache 关闭;RS485 只支持 UART 硬件 DE。 +- STM32F4:只编译验证;sys / can 任务与 CAN 节点目前只在 H7(FDCAN)下编译。 ## 许可证 -MIT,见根目录 [`LICENSE`](LICENSE)。 +MIT,见根目录 [`LICENSE`](LICENSE)。例外: + +- `code/algorithm/vqf.*`:第三方代码 VQF,MIT,版权 Daniel Laidig(文件头的 `SPDX-FileCopyrightText` / `SPDX-License-Identifier` 行,不要删);保持上游原样(CMake 里单独关了 `-Wshadow`)。 +- `code/algorithm/matrix.*`:移植自 USTC-RoboWalker(yssickjgd/damiao_mc02_bsp)的代码,原作者许可在 RoboMaster 赛事范围内使用,**不适用本仓库的 MIT**;超出这个范围请自行征求原作者意见。文件头的出处说明要保留。 +- `docs/sheet/` 下的器件手册:版权归各厂商,不属于本仓库的 MIT 许可,只为方便查阅;清单与官方渠道见 [docs/sheet/README.md](docs/sheet/README.md)。 diff --git a/boot/CMakeLists.txt b/boot/CMakeLists.txt new file mode 100644 index 0000000..971fcd4 --- /dev/null +++ b/boot/CMakeLists.txt @@ -0,0 +1,39 @@ +# ------------------------------------------------------------------------------ +# icbsp bootloader:外置 QSPI Flash 方案 A / B 的片内引导程序(0x08000000) +# +# 不单独使用:由宿主的 cmake/icbsp_flash.cmake 用 ExternalProject 编译,参数: +# ICBSP_BOOT_CONFIG 宿主的 icbsp_flash_config.h(引脚、芯片、分频,integrate.py 生成) +# ICBSP_BOOT_INCLUDES CMSIS 包含路径(来自宿主 stm32cubemx 目标,| 分隔) +# ICBSP_BOOT_DEFINES 芯片型号宏(如 STM32H750xx,| 分隔) +# +# 寄存器级实现,只依赖 CMSIS 头文件,不用 HAL。同一个 bootloader 同时支持方案 A 和 B +# (看 QSPI 镜像头里的 layout 字段),所以在 A / B 之间切换不用重烧 bootloader。 +# ------------------------------------------------------------------------------ +cmake_minimum_required(VERSION 3.22) +project(icbsp_boot C) + +foreach(_v ICBSP_BOOT_CONFIG ICBSP_BOOT_INCLUDES ICBSP_BOOT_DEFINES) + if(NOT ${_v}) + message(FATAL_ERROR "icbsp_boot: 缺少 ${_v}(应由宿主的 cmake/icbsp_flash.cmake 传入)") + endif() +endforeach() + +# 宿主的工具链文件把宿主的 -T 链接脚本和 -Map 写进了 CMAKE_EXE_LINKER_FLAGS,换成自己的 +string(REGEX REPLACE "-T[ \t]*\"[^\"]*\"" "" CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}") +string(REGEX REPLACE "-T[ \t]*[^ \t\"]+" "" CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}") +string(REGEX REPLACE "-Wl,-Map=[^ \t]*" "" CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}") + +add_executable(icbsp_boot main.c startup.c) +set_target_properties(icbsp_boot PROPERTIES SUFFIX ".elf") +target_include_directories(icbsp_boot PRIVATE ${ICBSP_BOOT_INCLUDES}) +target_compile_definitions(icbsp_boot PRIVATE + ${ICBSP_BOOT_DEFINES} + ICBSP_BOOT_CONFIG_HEADER="${ICBSP_BOOT_CONFIG}" +) +target_compile_options(icbsp_boot PRIVATE -Os -g3 -Wall -Wextra -Wshadow -std=gnu11) +target_link_options(icbsp_boot PRIVATE + "-T${CMAKE_CURRENT_SOURCE_DIR}/boot.ld" + -nostartfiles + "-Wl,-Map=${CMAKE_CURRENT_BINARY_DIR}/icbsp_boot.map" +) +set_property(TARGET icbsp_boot APPEND PROPERTY LINK_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/boot.ld") diff --git a/boot/boot.ld b/boot/boot.ld new file mode 100644 index 0000000..9b5a349 --- /dev/null +++ b/boot/boot.ld @@ -0,0 +1,50 @@ +/* icbsp bootloader:片内 Flash 0x08000000 运行,数据和栈放 DTCM(不碰 AXI SRAM 的 .noinit,也不碰 RAM_D3 的状态字以外区域) */ +ENTRY(Reset_Handler) + +MEMORY +{ + FLASH (rx) : ORIGIN = 0x08000000, LENGTH = 128K + DTCMRAM (xrw) : ORIGIN = 0x20000000, LENGTH = 128K +} + +_estack = ORIGIN(DTCMRAM) + LENGTH(DTCMRAM); + +SECTIONS +{ + .isr_vector : + { + KEEP(*(.isr_vector)) + } >FLASH + + .text : + { + . = ALIGN(4); + *(.text .text*) + *(.rodata .rodata*) + . = ALIGN(4); + } >FLASH + + .data : + { + . = ALIGN(4); + _sdata = .; + *(.data .data*) + . = ALIGN(4); + _edata = .; + } >DTCMRAM AT> FLASH + _sidata = LOADADDR(.data); + + .bss (NOLOAD) : + { + . = ALIGN(4); + _sbss = .; + *(.bss .bss* COMMON) + . = ALIGN(4); + _ebss = .; + } >DTCMRAM + + /DISCARD/ : + { + *(.ARM.exidx* .ARM.extab*) + } +} diff --git a/boot/icbsp_boot.h b/boot/icbsp_boot.h new file mode 100644 index 0000000..40cb03a --- /dev/null +++ b/boot/icbsp_boot.h @@ -0,0 +1,62 @@ +/** + * @file icbsp_boot.h + * @brief icbsp bootloader 与宿主 / 工具共用的格式:QSPI 镜像头、启动状态字 + * + * 镜像头的生成见 tools/qspi_image.py;两边改动必须同步。 + */ +#ifndef ICBSP_BOOT_H +#define ICBSP_BOOT_H + +#include + +#define ICBSP_IMAGE_MAGIC 0x49424349U ///< 'ICBI' +#define ICBSP_IMAGE_VERSION 1U +#define ICBSP_IMAGE_LAYOUT_RAM 1U ///< 方案 A:拷进 AXI SRAM 运行 +#define ICBSP_IMAGE_LAYOUT_XIP 2U ///< 方案 B:QSPI 上就地执行 +#define ICBSP_IMAGE_HEADER_SIZE 0x400U +#define ICBSP_QSPI_BASE 0x90000000U + +/** QSPI 0x90000000 处的镜像头(32 字节,后面补 0xFF 到 1 KB) */ +typedef struct +{ + uint32_t magic; + uint32_t version; + uint32_t layout; + uint32_t load_addr; + uint32_t vector_addr; + uint32_t size; ///< 载荷字节数(4 字节对齐),载荷从 0x90000400 开始 + uint32_t payload_crc; ///< CRC-32(zlib) + uint32_t header_crc; ///< 前 28 字节的 CRC-32 +} icbsp_image_header_t; + +/** 启动状态(bootloader 每次启动都整块重写;调试器读 ICBSP_BOOT_STATUS_ADDR) */ +typedef enum +{ + ICBSP_BOOT_STARTED = 1, + ICBSP_BOOT_QSPI_TIMEOUT = 2, ///< QUADSPI 命令超时(引脚 / 时钟 / 芯片没响应) + ICBSP_BOOT_JEDEC_MISMATCH = 3, ///< detail = 读到的 JEDEC ID + ICBSP_BOOT_QE_FAIL = 4, ///< 四线使能位写不进去 + ICBSP_BOOT_NO_IMAGE = 5, ///< 镜像头 magic / 头 CRC 不对(没烧镜像或被擦了) + ICBSP_BOOT_BAD_HEADER = 6, ///< 头字段越界(detail = 出错的字段序号) + ICBSP_BOOT_BAD_CRC = 7, ///< 载荷 CRC 不对(detail = 算出来的 CRC) + ICBSP_BOOT_BAD_VECTOR = 8, ///< 向量表里的栈顶 / 入口不合理 + ICBSP_BOOT_JUMP_RAM = 0x10, ///< 已跳转到方案 A 程序 + ICBSP_BOOT_JUMP_XIP = 0x11, ///< 已跳转到方案 B 程序 +} icbsp_boot_state_t; + +#define ICBSP_BOOT_STATUS_MAGIC 0x544F4F42U ///< 'BOOT' +#define ICBSP_BOOT_VERSION 1U + +typedef struct +{ + uint32_t magic; + uint32_t version; + uint32_t state; ///< icbsp_boot_state_t + uint32_t detail; ///< 见各状态说明 + uint32_t jedec; ///< 读到的 JEDEC ID(0xMMTTCC) + uint32_t layout; ///< 镜像头 layout + uint32_t size; ///< 镜像头 size + uint32_t qspi_cr; +} icbsp_boot_status_t; + +#endif diff --git a/boot/main.c b/boot/main.c new file mode 100644 index 0000000..353b2cd --- /dev/null +++ b/boot/main.c @@ -0,0 +1,524 @@ +/** + * @file main.c + * @brief icbsp bootloader:外置 QSPI Flash(W25Q 系列)引导程序,支持方案 A(拷进 AXI SRAM)和方案 B(XIP) + * + * 流程: + * 1. HSI 64 MHz 运行(不开 PLL:应用的 SystemClock_Config() 可以照常从复位状态配置时钟) + * 2. 配 QSPI 引脚和 QUADSPI;W25Q 软复位、核对 JEDEC ID、确保四线使能位 QE、>16 MB 进 4 字节地址 + * 3. 内存映射(0xEB 四线读);MPU 第 13 / 14 / 15 区:256 MB 窗口禁止访问、芯片容量只读可执行、 + * 芯片最后 4 KB 禁止访问(实测:内存映射读芯片最后一个字时 QUADSPI 预取越过芯片末尾,总线永久挂死, + * 连调试器都停不下内核;有了第 15 区,误读只会进 MemManage) + * 4. 校验 0x90000000 的镜像头和载荷 CRC(CRC 外设,zlib 算法) + * 5. 方案 A:载荷拷进 AXI SRAM,退出内存映射、复位 QUADSPI、清 MPU 区,跳转 + * 方案 B:保持内存映射和 MPU 区(应用的 MPU_Config() 只改它自己的区号,第 13~15 区保留),跳转 + * 失败时把原因写进 ICBSP_BOOT_STATUS_ADDR 处的状态字,然后原地循环(调试器可以直接连上读)。 + * + * QUADSPI 预分频按应用的最终 HCLK3 选(icbsp_flash_config.h 的 ICBSP_QSPI_PRESCALER): + * 方案 B 里应用把系统时钟拉到 480 MHz 后,QSPI 时钟 = 240 MHz / (预分频 + 1),不能超过芯片上限。 + */ +#include "icbsp_boot.h" + +#include ICBSP_BOOT_CONFIG_HEADER + +#include "stm32h7xx.h" + +#include +#include + +#ifndef ICBSP_QSPI_FLASH_SIZE +#error "icbsp_flash_config.h 缺少 ICBSP_QSPI_FLASH_SIZE" +#endif +#ifndef ICBSP_QSPI_PINS +#error "icbsp_flash_config.h 缺少 ICBSP_QSPI_PINS" +#endif +#ifndef ICBSP_BOOT_STATUS_ADDR +#define ICBSP_BOOT_STATUS_ADDR 0x3800FFE0U +#endif +#ifndef ICBSP_QSPI_CS_HIGH_CYCLES +#define ICBSP_QSPI_CS_HIGH_CYCLES 6 +#endif +#ifndef ICBSP_QSPI_SAMPLE_SHIFT +#define ICBSP_QSPI_SAMPLE_SHIFT 1 +#endif + +#define AXI_SRAM_BASE 0x24000000U +#define DTCM_BASE 0x20000000U +#define DTCM_SIZE 0x00020000U +#define MPU_REGION_GUARD 13U ///< 256 MB 窗口:禁止访问 +#define MPU_REGION_FLASH 14U ///< 芯片容量:只读、可执行、写通 cache +#define MPU_REGION_TAIL 15U ///< 芯片最后 4 KB:禁止访问(防 QUADSPI 预取越过芯片末尾挂死总线) +#define QSPI_TAIL_GUARD 0x1000U + +_Static_assert((ICBSP_QSPI_FLASH_SIZE & (ICBSP_QSPI_FLASH_SIZE - 1U)) == 0U, "QSPI 容量必须是 2 的幂"); +_Static_assert(ICBSP_QSPI_FLASH_SIZE >= 0x100000U && ICBSP_QSPI_FLASH_SIZE <= 0x10000000U, "QSPI 容量范围 1 MB~256 MB"); +_Static_assert(ICBSP_QSPI_ADDR_BYTES == 3 || ICBSP_QSPI_ADDR_BYTES == 4, "地址字节数只能是 3 或 4"); +_Static_assert(ICBSP_QSPI_ADDR_BYTES == 4 || ICBSP_QSPI_FLASH_SIZE <= 0x1000000U, ">16 MB 的芯片要用 4 字节地址"); +_Static_assert(ICBSP_QSPI_PRESCALER >= 0 && ICBSP_QSPI_PRESCALER <= 255, "预分频 0~255"); +_Static_assert(ICBSP_QSPI_CS_HIGH_CYCLES >= 1 && ICBSP_QSPI_CS_HIGH_CYCLES <= 8, "片选高电平 1~8 个周期"); + +static volatile icbsp_boot_status_t *const status = (volatile icbsp_boot_status_t *)ICBSP_BOOT_STATUS_ADDR; + +static void set_state(uint32_t state, uint32_t detail) +{ + status->state = state; + status->detail = detail; + __DSB(); +} + +/* ============================== QUADSPI ============================== */ + +#define CCR_LINES_NONE 0U +#define CCR_LINES_1 1U +#define CCR_LINES_4 3U +#define FMODE_WRITE 0U +#define FMODE_READ 1U +#define FMODE_MMAP 3U +#define TIMEOUT_LOOPS 4000000U ///< 约 0.2 s(64 MHz);W25Q 写状态寄存器最长 15 ms + +static uint32_t ccr(uint8_t inst, uint32_t imode, uint32_t admode, uint32_t adsize, uint32_t dmode, uint32_t fmode, + uint32_t dummy) +{ + return ((uint32_t)inst << QUADSPI_CCR_INSTRUCTION_Pos) | (imode << QUADSPI_CCR_IMODE_Pos) | + (admode << QUADSPI_CCR_ADMODE_Pos) | (adsize << QUADSPI_CCR_ADSIZE_Pos) | (dummy << QUADSPI_CCR_DCYC_Pos) | + (dmode << QUADSPI_CCR_DMODE_Pos) | (fmode << QUADSPI_CCR_FMODE_Pos); +} + +static bool wait_set(uint32_t flag) +{ + for (uint32_t n = 0; n < TIMEOUT_LOOPS; ++n) + { + if ((QUADSPI->SR & flag) != 0U) + { + return true; + } + } + return false; +} + +static bool wait_idle(void) +{ + for (uint32_t n = 0; n < TIMEOUT_LOOPS; ++n) + { + if ((QUADSPI->SR & QUADSPI_SR_BUSY) == 0U) + { + return true; + } + } + return false; +} + +/** 单线指令 + 可选单线数据(间接读 / 写);len = 0 表示只有指令 */ +static bool cmd(uint8_t inst, uint8_t *rx, const uint8_t *tx, uint32_t len) +{ + if (!wait_idle()) + { + return false; + } + QUADSPI->FCR = QUADSPI_FCR_CTEF | QUADSPI_FCR_CTCF | QUADSPI_FCR_CSMF | QUADSPI_FCR_CTOF; + if (len > 0U) + { + QUADSPI->DLR = len - 1U; + } + const uint32_t dmode = (len > 0U) ? CCR_LINES_1 : CCR_LINES_NONE; + QUADSPI->CCR = ccr(inst, CCR_LINES_1, CCR_LINES_NONE, 0U, dmode, (rx != NULL) ? FMODE_READ : FMODE_WRITE, 0U); + for (uint32_t i = 0; i < len; ++i) + { + if (!wait_set(QUADSPI_SR_FTF | QUADSPI_SR_TCF)) + { + return false; + } + if (rx != NULL) + { + rx[i] = *(volatile uint8_t *)&QUADSPI->DR; + } + else + { + *(volatile uint8_t *)&QUADSPI->DR = tx[i]; + } + } + if (!wait_set(QUADSPI_SR_TCF)) + { + return false; + } + QUADSPI->FCR = QUADSPI_FCR_CTCF; + return true; +} + +static void delay_loops(uint32_t n) +{ + for (volatile uint32_t i = 0; i < n; ++i) + { + } +} + +static void gpio_af(GPIO_TypeDef *port, uint32_t index, uint32_t pin, uint32_t af) +{ + RCC->AHB4ENR |= (1UL << index); + (void)RCC->AHB4ENR; + port->MODER = (port->MODER & ~(3UL << (pin * 2U))) | (2UL << (pin * 2U)); + port->OSPEEDR |= (3UL << (pin * 2U)); + port->OTYPER &= ~(1UL << pin); + port->PUPDR &= ~(3UL << (pin * 2U)); + volatile uint32_t *afr = &port->AFR[pin >> 3U]; + *afr = (*afr & ~(0xFUL << ((pin & 7U) * 4U))) | (af << ((pin & 7U) * 4U)); +} + +#define ICBSP_PORT_INDEX_A 0U +#define ICBSP_PORT_INDEX_B 1U +#define ICBSP_PORT_INDEX_C 2U +#define ICBSP_PORT_INDEX_D 3U +#define ICBSP_PORT_INDEX_E 4U +#define ICBSP_PORT_INDEX_F 5U +#define ICBSP_PORT_INDEX_G 6U +#define ICBSP_PORT_INDEX_H 7U +#define ICBSP_PIN_INIT(port, pin, af) gpio_af(GPIO##port, ICBSP_PORT_INDEX_##port, (pin), (af)); + +static uint32_t log2u(uint32_t v) +{ + return 31U - (uint32_t)__builtin_clz(v); +} + +static void qspi_init(void) +{ + ICBSP_QSPI_PINS(ICBSP_PIN_INIT) + + RCC->AHB3ENR |= RCC_AHB3ENR_QSPIEN; + (void)RCC->AHB3ENR; + RCC->AHB3RSTR |= RCC_AHB3RSTR_QSPIRST; + RCC->AHB3RSTR &= ~RCC_AHB3RSTR_QSPIRST; + + uint32_t cr = ((uint32_t)ICBSP_QSPI_PRESCALER << QUADSPI_CR_PRESCALER_Pos) | (3UL << QUADSPI_CR_FTHRES_Pos); +#if ICBSP_QSPI_SAMPLE_SHIFT + cr |= QUADSPI_CR_SSHIFT; +#endif +#if ICBSP_QSPI_BANK == 2 + cr |= QUADSPI_CR_FSEL; +#endif + QUADSPI->CR = cr; + QUADSPI->DCR = ((log2u(ICBSP_QSPI_FLASH_SIZE) - 1U) << QUADSPI_DCR_FSIZE_Pos) | + ((uint32_t)(ICBSP_QSPI_CS_HIGH_CYCLES - 1) << QUADSPI_DCR_CSHT_Pos); + QUADSPI->CR |= QUADSPI_CR_EN; +} + +static void qspi_shutdown(void) +{ + QUADSPI->CR |= QUADSPI_CR_ABORT; + for (uint32_t n = 0; n < TIMEOUT_LOOPS && (QUADSPI->CR & QUADSPI_CR_ABORT) != 0U; ++n) + { + } + QUADSPI->CR = 0U; + RCC->AHB3RSTR |= RCC_AHB3RSTR_QSPIRST; + RCC->AHB3RSTR &= ~RCC_AHB3RSTR_QSPIRST; + RCC->AHB3ENR &= ~RCC_AHB3ENR_QSPIEN; +} + +/* ============================== W25Q ============================== */ + +#define W25Q_ENABLE_RESET 0x66U +#define W25Q_RESET 0x99U +#define W25Q_JEDEC_ID 0x9FU +#define W25Q_READ_SR1 0x05U +#define W25Q_READ_SR2 0x35U +#define W25Q_WRITE_SR2 0x31U +#define W25Q_WRITE_ENABLE 0x06U +#define W25Q_VOLATILE_SR_WE 0x50U +#define W25Q_ENTER_4BYTE 0xB7U +#define W25Q_FAST_READ_QUAD_IO 0xEBU +#define W25Q_SR1_BUSY 0x01U +#define W25Q_SR2_QE 0x02U + +static bool w25q_wait_ready(void) +{ + for (uint32_t n = 0; n < 100000U; ++n) + { + uint8_t sr1 = 0xFFU; + if (!cmd(W25Q_READ_SR1, &sr1, NULL, 1U)) + { + return false; + } + if ((sr1 & W25Q_SR1_BUSY) == 0U) + { + return true; + } + } + return false; +} + +/** 返回 icbsp_boot_state_t(STARTED 表示成功) */ +static uint32_t w25q_prepare(void) +{ + if (!cmd(W25Q_ENABLE_RESET, NULL, NULL, 0U) || !cmd(W25Q_RESET, NULL, NULL, 0U)) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } + delay_loops(5000U); // tRST 最长 30 µs + + uint8_t id[3] = {0U, 0U, 0U}; + if (!cmd(W25Q_JEDEC_ID, id, NULL, 3U)) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } + const uint32_t jedec = ((uint32_t)id[0] << 16) | ((uint32_t)id[1] << 8) | id[2]; + status->jedec = jedec; + // 只核对厂商和容量(同一容量有 0x40 / 0x60 / 0x70 等不同类型码) + if (id[0] != ICBSP_QSPI_JEDEC_MANUFACTURER || id[2] != ICBSP_QSPI_JEDEC_CAPACITY) + { + set_state(ICBSP_BOOT_JEDEC_MISMATCH, jedec); + return ICBSP_BOOT_JEDEC_MISMATCH; + } + + uint8_t sr2 = 0U; + if (!cmd(W25Q_READ_SR2, &sr2, NULL, 1U)) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } + if ((sr2 & W25Q_SR2_QE) == 0U) + { + // 写非易失 QE:只在第一次(新芯片)发生,之后上电都保持 + const uint8_t v = (uint8_t)(sr2 | W25Q_SR2_QE); + if (!cmd(W25Q_WRITE_ENABLE, NULL, NULL, 0U) || !cmd(W25Q_WRITE_SR2, NULL, &v, 1U) || !w25q_wait_ready()) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } + if (!cmd(W25Q_READ_SR2, &sr2, NULL, 1U)) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } + if ((sr2 & W25Q_SR2_QE) == 0U) + { + set_state(ICBSP_BOOT_QE_FAIL, sr2); + return ICBSP_BOOT_QE_FAIL; + } + } +#if ICBSP_QSPI_ADDR_BYTES == 4 + if (!cmd(W25Q_ENTER_4BYTE, NULL, NULL, 0U)) + { + return ICBSP_BOOT_QSPI_TIMEOUT; + } +#endif + return ICBSP_BOOT_STARTED; +} + +/** 0xEB 四线读:指令单线,地址 / 模式字节 / 数据四线,模式字节 0xFF(不进连续读模式)+ 4 个空周期 */ +static bool w25q_memory_mapped(void) +{ + if (!wait_idle()) + { + return false; + } + QUADSPI->ABR = 0xFFU; + QUADSPI->CCR = ccr(W25Q_FAST_READ_QUAD_IO, CCR_LINES_1, CCR_LINES_4, ICBSP_QSPI_ADDR_BYTES - 1U, CCR_LINES_4, + FMODE_MMAP, 4U) | + (CCR_LINES_4 << QUADSPI_CCR_ABMODE_Pos) | (0U << QUADSPI_CCR_ABSIZE_Pos); + return true; +} + +/* ============================== MPU / CRC ============================== */ + +static void mpu_region(uint32_t number, uint32_t base, uint32_t rasr) +{ + MPU->RNR = number; + MPU->RBAR = base; + MPU->RASR = rasr; +} + +static void mpu_setup(void) +{ + MPU->CTRL = 0U; + __DSB(); + __ISB(); + // 第 14 区:256 MB 窗口禁止访问(防 M7 推测访问到芯片以外的地址把总线卡死) + mpu_region(MPU_REGION_GUARD, ICBSP_QSPI_BASE, + MPU_RASR_XN_Msk | (0U << MPU_RASR_AP_Pos) | ((28U - 1U) << MPU_RASR_SIZE_Pos) | MPU_RASR_ENABLE_Msk); + // 第 14 区:芯片容量,只读(AP=110)、可执行、Normal 写通(TEX=0 C=1 B=0) + mpu_region(MPU_REGION_FLASH, ICBSP_QSPI_BASE, + (6U << MPU_RASR_AP_Pos) | MPU_RASR_C_Msk | ((log2u(ICBSP_QSPI_FLASH_SIZE) - 1U) << MPU_RASR_SIZE_Pos) | + MPU_RASR_ENABLE_Msk); + // 第 15 区:芯片最后 4 KB 禁止访问(区号最大,优先级最高) + mpu_region(MPU_REGION_TAIL, ICBSP_QSPI_BASE + ICBSP_QSPI_FLASH_SIZE - QSPI_TAIL_GUARD, + MPU_RASR_XN_Msk | (0U << MPU_RASR_AP_Pos) | ((log2u(QSPI_TAIL_GUARD) - 1U) << MPU_RASR_SIZE_Pos) | + MPU_RASR_ENABLE_Msk); + MPU->CTRL = MPU_CTRL_PRIVDEFENA_Msk | MPU_CTRL_ENABLE_Msk; + __DSB(); + __ISB(); +} + +static void mpu_clear(void) +{ + MPU->CTRL = 0U; + mpu_region(MPU_REGION_GUARD, 0U, 0U); + mpu_region(MPU_REGION_FLASH, 0U, 0U); + mpu_region(MPU_REGION_TAIL, 0U, 0U); + __DSB(); + __ISB(); +} + +/** CRC-32(zlib:多项式 0x04C11DB7,输入按字反转、输出反转,初值与结果异或 0xFFFFFFFF);len 为 4 的倍数 */ +static uint32_t crc32_words(const volatile uint32_t *p, uint32_t len) +{ + CRC->POL = 0x04C11DB7U; + CRC->INIT = 0xFFFFFFFFU; + CRC->CR = CRC_CR_REV_OUT | (3UL << CRC_CR_REV_IN_Pos) | CRC_CR_RESET; + for (uint32_t i = 0; i < len / 4U; ++i) + { + CRC->DR = p[i]; + } + return CRC->DR ^ 0xFFFFFFFFU; +} + +/* ============================== 跳转 ============================== */ + +__attribute__((noreturn)) static void jump(uint32_t vtor) +{ + const uint32_t sp = ((const volatile uint32_t *)vtor)[0]; + const uint32_t pc = ((const volatile uint32_t *)vtor)[1]; + + __disable_irq(); + SysTick->CTRL = 0U; + SysTick->LOAD = 0U; + SysTick->VAL = 0U; + for (uint32_t i = 0; i < 8U; ++i) + { + NVIC->ICER[i] = 0xFFFFFFFFU; + NVIC->ICPR[i] = 0xFFFFFFFFU; + } + SCB->ICSR = SCB_ICSR_PENDSTCLR_Msk | SCB_ICSR_PENDSVCLR_Msk; + SCB_DisableICache(); // 应用 main() 里 SCB_EnableICache() 会重新作废并打开 + SCB->VTOR = vtor; + __DSB(); + __ISB(); + __enable_irq(); + __asm volatile("msr msp, %0\n" + "bx %1\n" ::"r"(sp), + "r"(pc) + : "memory"); + __builtin_unreachable(); +} + +static bool vector_ok(uint32_t vtor, uint32_t size) +{ + const uint32_t sp = ((const volatile uint32_t *)vtor)[0]; + const uint32_t pc = ((const volatile uint32_t *)vtor)[1]; + const bool sp_ok = (sp > DTCM_BASE && sp <= DTCM_BASE + DTCM_SIZE) || + (sp > AXI_SRAM_BASE && sp <= AXI_SRAM_BASE + ICBSP_AXI_SRAM_SIZE); + const bool pc_ok = (pc & 1U) != 0U && (pc & ~1U) >= vtor && (pc & ~1U) < vtor + size; + return sp_ok && pc_ok; +} + +static __attribute__((noreturn)) void fail(uint32_t state, uint32_t detail) +{ + if (state != ICBSP_BOOT_STARTED) + { + set_state(state, detail); + } + for (;;) + { + } +} + +int main(void) +{ + status->magic = ICBSP_BOOT_STATUS_MAGIC; + status->version = ICBSP_BOOT_VERSION; + status->jedec = 0U; + status->layout = 0U; + status->size = 0U; + set_state(ICBSP_BOOT_STARTED, 0U); + + SCB_EnableICache(); + RCC->AHB4ENR |= RCC_AHB4ENR_CRCEN; + (void)RCC->AHB4ENR; + + qspi_init(); + const uint32_t prep = w25q_prepare(); + if (prep != ICBSP_BOOT_STARTED) + { + fail(prep, status->detail); + } + if (!w25q_memory_mapped()) + { + fail(ICBSP_BOOT_QSPI_TIMEOUT, 1U); + } + status->qspi_cr = QUADSPI->CR; + mpu_setup(); + + const volatile icbsp_image_header_t *h = (const volatile icbsp_image_header_t *)ICBSP_QSPI_BASE; + if (h->magic != ICBSP_IMAGE_MAGIC || crc32_words((const volatile uint32_t *)h, 28U) != h->header_crc) + { + fail(ICBSP_BOOT_NO_IMAGE, h->magic); + } + const uint32_t layout = h->layout; + const uint32_t size = h->size; + const uint32_t load = h->load_addr; + status->layout = layout; + status->size = size; + if (h->version != ICBSP_IMAGE_VERSION) + { + fail(ICBSP_BOOT_BAD_HEADER, 1U); + } + if (size == 0U || (size & 3U) != 0U || size > ICBSP_QSPI_FLASH_SIZE - ICBSP_IMAGE_HEADER_SIZE - QSPI_TAIL_GUARD) + { + fail(ICBSP_BOOT_BAD_HEADER, 5U); + } + if (h->vector_addr != load) + { + fail(ICBSP_BOOT_BAD_HEADER, 4U); + } + if (layout == ICBSP_IMAGE_LAYOUT_RAM) + { + if (load != AXI_SRAM_BASE || size > ICBSP_AXI_SRAM_SIZE) + { + fail(ICBSP_BOOT_BAD_HEADER, 3U); + } + } + else if (layout == ICBSP_IMAGE_LAYOUT_XIP) + { + if (load != ICBSP_QSPI_BASE + ICBSP_IMAGE_HEADER_SIZE) + { + fail(ICBSP_BOOT_BAD_HEADER, 3U); + } + } + else + { + fail(ICBSP_BOOT_BAD_HEADER, 2U); + } + + const volatile uint32_t *payload = (const volatile uint32_t *)(ICBSP_QSPI_BASE + ICBSP_IMAGE_HEADER_SIZE); + const uint32_t crc = crc32_words(payload, size); + if (crc != h->payload_crc) + { + fail(ICBSP_BOOT_BAD_CRC, crc); + } + + if (layout == ICBSP_IMAGE_LAYOUT_RAM) + { + volatile uint32_t *dst = (volatile uint32_t *)AXI_SRAM_BASE; + for (uint32_t i = 0; i < size / 4U; ++i) + { + dst[i] = payload[i]; + } + if (!vector_ok(load, size)) + { + fail(ICBSP_BOOT_BAD_VECTOR, ((const volatile uint32_t *)load)[1]); + } + // 交还复位状态:应用会自己初始化 QUADSPI(MX_QUADSPI_Init)和 MPU + mpu_clear(); + qspi_shutdown(); + RCC->AHB4RSTR |= RCC_AHB4RSTR_CRCRST; + RCC->AHB4RSTR &= ~RCC_AHB4RSTR_CRCRST; + RCC->AHB4ENR &= ~RCC_AHB4ENR_CRCEN; + set_state(ICBSP_BOOT_JUMP_RAM, load); + } + else + { + if (!vector_ok(load, size)) + { + fail(ICBSP_BOOT_BAD_VECTOR, ((const volatile uint32_t *)load)[1]); + } + RCC->AHB4RSTR |= RCC_AHB4RSTR_CRCRST; + RCC->AHB4RSTR &= ~RCC_AHB4RSTR_CRCRST; + RCC->AHB4ENR &= ~RCC_AHB4ENR_CRCEN; + set_state(ICBSP_BOOT_JUMP_XIP, load); + } + jump(load); +} diff --git a/boot/startup.c b/boot/startup.c new file mode 100644 index 0000000..62a841e --- /dev/null +++ b/boot/startup.c @@ -0,0 +1,58 @@ +/** + * @file startup.c + * @brief icbsp bootloader 的启动代码:只有内核异常向量,不开任何外设中断 + */ +#include + +extern uint32_t _sidata, _sdata, _edata, _sbss, _ebss, _estack; +extern int main(void); + +void Reset_Handler(void); +void Default_Handler(void); + +void Reset_Handler(void) +{ + // 启用 FPU(工具链是 -mfloat-abi=hard,编译器可能生成浮点寄存器访问) + *(volatile uint32_t *)0xE000ED88U |= (0xFU << 20); + __asm volatile("dsb\n isb" ::: "memory"); + + for (uint32_t *src = &_sidata, *dst = &_sdata; dst < &_edata;) + { + *dst++ = *src++; + } + for (uint32_t *dst = &_sbss; dst < &_ebss;) + { + *dst++ = 0U; + } + (void)main(); + for (;;) + { + } +} + +/** 异常:停在这里,用调试器看 ICBSP_BOOT_STATUS_ADDR 处的状态字和 SCB->CFSR */ +void Default_Handler(void) +{ + for (;;) + { + } +} + +__attribute__((section(".isr_vector"), used)) static void (*const vectors[16])(void) = { + (void (*)(void))(&_estack), + Reset_Handler, + Default_Handler, // NMI + Default_Handler, // HardFault + Default_Handler, // MemManage + Default_Handler, // BusFault + Default_Handler, // UsageFault + 0, + 0, + 0, + 0, + Default_Handler, // SVC + Default_Handler, // DebugMon + 0, + Default_Handler, // PendSV + Default_Handler, // SysTick +}; diff --git a/cmake/icbsp_flash.cmake b/cmake/icbsp_flash.cmake new file mode 100644 index 0000000..2c9b583 --- /dev/null +++ b/cmake/icbsp_flash.cmake @@ -0,0 +1,190 @@ +# ------------------------------------------------------------------------------ +# icbsp:外置 QSPI Flash 布局切换 +# +# INTERNAL 程序全部在片内 Flash(CubeMX 生成的链接脚本,什么都不改) +# QSPI_RAM 方案 A:程序存 QSPI,开机由 bootloader 拷进 AXI SRAM 运行 +# QSPI_XIP 方案 B:程序在 QSPI 上就地执行(内存映射) +# +# 宿主根 CMakeLists.txt(integrate.py 生成,必须在 add_subdirectory() 之前): +# +# include(/cmake/icbsp_flash.cmake) +# icbsp_flash_layout(TARGET ${CMAKE_PROJECT_NAME} DEFAULT QSPI_RAM +# CONFIG ${CMAKE_CURRENT_SOURCE_DIR}/user/board/icbsp_flash_config.h) +# +# 切换方案只改缓存变量 ICBSP_FLASH_LAYOUT(或者用 CMakePresets 里的 *-QspiRam / *-QspiXip 预设), +# 不需要重新生成 CubeMX、不需要重跑 integrate.py。 +# +# 外置方案做的事: +# 1. 按模板生成链接脚本(templates/flash_layout/),替换 CMAKE_EXE_LINKER_FLAGS 里的 -T +# (在 add_subdirectory() 之前做,库的链接脚本检查看到的就是新脚本) +# 2. 给 stm32cubemx 目标加宏 ICBSP_FLASH_LAYOUT_QSPI_RAM / ICBSP_FLASH_LAYOUT_QSPI_XIP; +# 方案 A 另加 USER_VECT_TAB_ADDRESS + VECT_TAB_SRAM(SystemInit 把 VTOR 设到 AXI SRAM) +# 3. 用 ExternalProject 编译 bootloader(/boot,片内 Flash 0x08000000) +# 4. 构建后调用 tools/qspi_image.py 生成 <工程名>_qspi.bin / .hex(方案 B 还把镜像头写回 ELF) +# ------------------------------------------------------------------------------ +include_guard(GLOBAL) + +get_filename_component(ICBSP_ROOT "${CMAKE_CURRENT_LIST_DIR}/.." ABSOLUTE) +set(ICBSP_FLASH_LAYOUTS INTERNAL QSPI_RAM QSPI_XIP) + +# 从 CMAKE_EXE_LINKER_FLAGS 里找 -T(与库 CMakeLists.txt 的写法一致:带引号或不带引号) +function(_icbsp_find_ld flags out_path out_match) + string(REGEX MATCH "-T[ \t]*\"([^\"]+)\"" _m "${flags}") + set(_p "${CMAKE_MATCH_1}") + if(NOT _p) + string(REGEX MATCH "-T[ \t]*([^ \t\"]+)" _m "${flags}") + set(_p "${CMAKE_MATCH_1}") + endif() + set(${out_path} "${_p}" PARENT_SCOPE) + set(${out_match} "${_m}" PARENT_SCOPE) +endfunction() + +# 读 icbsp_flash_config.h 里的 #define(只认十进制 / 十六进制整数,可带 u / U 后缀) +function(_icbsp_config_int header name out) + file(STRINGS "${header}" _lines REGEX "^[ \t]*#[ \t]*define[ \t]+${name}[ \t]") + if(NOT _lines) + message(FATAL_ERROR "icbsp: ${header} 里没有 ${name}(请重新运行 integrate.py 生成)") + endif() + list(GET _lines 0 _line) + string(REGEX MATCH "define[ \t]+${name}[ \t]+\\(?(0[xX][0-9a-fA-F]+|[0-9]+)[uU]?" _m "${_line}") + if(NOT CMAKE_MATCH_1) + message(FATAL_ERROR "icbsp: ${header} 里 ${name} 不是整数常量:${_line}") + endif() + math(EXPR _v "${CMAKE_MATCH_1}" OUTPUT_FORMAT DECIMAL) + set(${out} "${_v}" PARENT_SCOPE) +endfunction() + +# 从宿主原链接脚本里取堆 / 栈大小(保持和 CubeMX 设置一致) +function(_icbsp_ld_symbol text name default out) + string(REGEX MATCH "${name}[ \t]*=[ \t]*(0[xX][0-9a-fA-F]+|[0-9]+)" _m "${text}") + if(CMAKE_MATCH_1) + set(${out} "${CMAKE_MATCH_1}" PARENT_SCOPE) + else() + set(${out} "${default}" PARENT_SCOPE) + endif() +endfunction() + +function(icbsp_flash_layout) + cmake_parse_arguments(ARG "" "TARGET;DEFAULT;CONFIG" "" ${ARGN}) + if(NOT ARG_TARGET) + message(FATAL_ERROR "icbsp_flash_layout: 需要 TARGET(宿主可执行目标)") + endif() + if(NOT ARG_DEFAULT) + set(ARG_DEFAULT INTERNAL) + endif() + set(ICBSP_FLASH_LAYOUT "${ARG_DEFAULT}" CACHE STRING "icbsp 程序存放方式:INTERNAL / QSPI_RAM / QSPI_XIP") + set_property(CACHE ICBSP_FLASH_LAYOUT PROPERTY STRINGS ${ICBSP_FLASH_LAYOUTS}) + if(NOT ICBSP_FLASH_LAYOUT IN_LIST ICBSP_FLASH_LAYOUTS) + message(FATAL_ERROR "icbsp: ICBSP_FLASH_LAYOUT=${ICBSP_FLASH_LAYOUT} 无效,可选 ${ICBSP_FLASH_LAYOUTS}") + endif() + if(ICBSP_FLASH_LAYOUT STREQUAL "INTERNAL") + message(STATUS "icbsp: 程序存放方式 INTERNAL(片内 Flash,使用 CubeMX 链接脚本)") + return() + endif() + + if(NOT ARG_CONFIG OR NOT EXISTS "${ARG_CONFIG}") + message(FATAL_ERROR + "icbsp: ICBSP_FLASH_LAYOUT=${ICBSP_FLASH_LAYOUT} 需要 icbsp_flash_config.h(${ARG_CONFIG})。" + "请用 integrate.py / Web UI 打开“外置 Flash”生成它。") + endif() + set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${ARG_CONFIG}") + _icbsp_config_int("${ARG_CONFIG}" ICBSP_QSPI_FLASH_SIZE _qspi_size) + _icbsp_config_int("${ARG_CONFIG}" ICBSP_AXI_SRAM_SIZE _axi_size) + + _icbsp_find_ld("${CMAKE_EXE_LINKER_FLAGS}" _host_ld _host_ld_match) + if(NOT _host_ld OR NOT EXISTS "${_host_ld}") + message(FATAL_ERROR "icbsp: CMAKE_EXE_LINKER_FLAGS 里找不到 -T 链接脚本,无法切换到 ${ICBSP_FLASH_LAYOUT}") + endif() + file(READ "${_host_ld}" _host_ld_text) + _icbsp_ld_symbol("${_host_ld_text}" "_Min_Heap_Size" "0x200" ICBSP_MIN_HEAP_SIZE) + _icbsp_ld_symbol("${_host_ld_text}" "_Min_Stack_Size" "0x400" ICBSP_MIN_STACK_SIZE) + set(ICBSP_QSPI_SIZE "${_qspi_size}") + set(ICBSP_AXI_SRAM_SIZE "${_axi_size}") + + if(ICBSP_FLASH_LAYOUT STREQUAL "QSPI_RAM") + set(_tpl "${ICBSP_ROOT}/templates/flash_layout/h7_qspi_ram.ld.in") + set(_kind ram) + else() + set(_tpl "${ICBSP_ROOT}/templates/flash_layout/h7_qspi_xip.ld.in") + set(_kind xip) + endif() + set(_ld "${CMAKE_BINARY_DIR}/icbsp_flash/icbsp_${_kind}.ld") + configure_file("${_tpl}" "${_ld}" @ONLY) + + string(REPLACE "${_host_ld_match}" "-T \"${_ld}\"" _flags "${CMAKE_EXE_LINKER_FLAGS}") + set(CMAKE_EXE_LINKER_FLAGS "${_flags}" PARENT_SCOPE) + message(STATUS "icbsp: 程序存放方式 ${ICBSP_FLASH_LAYOUT},链接脚本 ${_ld}(QSPI ${_qspi_size} 字节)") + + # 目标都建好之后(根目录处理完)再挂宏、bootloader 和构建后步骤 + cmake_language(EVAL CODE " + cmake_language(DEFER DIRECTORY [[${CMAKE_SOURCE_DIR}]] + CALL _icbsp_flash_setup [[${ARG_TARGET}]] [[${_kind}]] [[${ARG_CONFIG}]] [[${_qspi_size}]] [[${_axi_size}]])") +endfunction() + +function(_icbsp_flash_setup target kind config qspi_size axi_size) + if(NOT TARGET ${target}) + message(FATAL_ERROR "icbsp_flash_layout: 找不到目标 ${target}") + endif() + if(NOT TARGET stm32cubemx) + message(FATAL_ERROR "icbsp_flash_layout: 找不到 CubeMX 的 stm32cubemx 目标") + endif() + + # 宏:stm32cubemx 是 INTERFACE 目标,宿主、HAL(system_stm32h7xx.c)、icbsp 都能看到 + if(kind STREQUAL "ram") + target_compile_definitions(stm32cubemx INTERFACE + ICBSP_FLASH_LAYOUT_QSPI_RAM=1 USER_VECT_TAB_ADDRESS VECT_TAB_SRAM) + # 代码和数据同在 AXI SRAM,ld 会提示 RWX 段:方案 A 本来就是这样,不是错误 + target_link_options(${target} PRIVATE "LINKER:--no-warn-rwx-segments") + else() + target_compile_definitions(stm32cubemx INTERFACE ICBSP_FLASH_LAYOUT_QSPI_XIP=1) + endif() + + # bootloader:只需要 CMSIS 头文件与芯片型号宏(寄存器级实现,不用 HAL) + get_target_property(_incs stm32cubemx INTERFACE_INCLUDE_DIRECTORIES) + get_target_property(_defs stm32cubemx INTERFACE_COMPILE_DEFINITIONS) + set(_boot_incs "") + foreach(_i IN LISTS _incs) + if(_i MATCHES "CMSIS" AND NOT _i MATCHES "\\$<") + get_filename_component(_i "${_i}" ABSOLUTE) + list(APPEND _boot_incs "${_i}") + endif() + endforeach() + set(_boot_defs "") + foreach(_d IN LISTS _defs) + if(_d MATCHES "^STM32[A-Z0-9]+xx$") + list(APPEND _boot_defs "${_d}") + endif() + endforeach() + if(NOT _boot_incs OR NOT _boot_defs) + message(FATAL_ERROR "icbsp: 从 stm32cubemx 目标里找不到 CMSIS 包含路径或芯片型号宏,无法编译 bootloader") + endif() + list(JOIN _boot_incs "|" _boot_incs) + list(JOIN _boot_defs "|" _boot_defs) + + include(ExternalProject) + ExternalProject_Add(icbsp_boot + SOURCE_DIR "${ICBSP_ROOT}/boot" + BINARY_DIR "${CMAKE_BINARY_DIR}/icbsp_boot" + LIST_SEPARATOR "|" + CMAKE_ARGS + -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE} + -DCMAKE_BUILD_TYPE=Release + -DICBSP_BOOT_CONFIG=${config} + -DICBSP_BOOT_INCLUDES=${_boot_incs} + -DICBSP_BOOT_DEFINES=${_boot_defs} + BUILD_ALWAYS ON + INSTALL_COMMAND "" + BUILD_BYPRODUCTS "${CMAKE_BINARY_DIR}/icbsp_boot/icbsp_boot.elf" + USES_TERMINAL_BUILD ON + ) + add_dependencies(${target} icbsp_boot) + + find_package(Python3 COMPONENTS Interpreter REQUIRED) + add_custom_command(TARGET ${target} POST_BUILD + COMMAND "${Python3_EXECUTABLE}" -I "${ICBSP_ROOT}/tools/qspi_image.py" + --elf "$" --layout ${kind} + --qspi-size ${qspi_size} --ram-size ${axi_size} + COMMENT "icbsp: 生成 QSPI 镜像(${kind})" + VERBATIM + ) +endfunction() diff --git a/cmake/icbsp_options.cmake b/cmake/icbsp_options.cmake new file mode 100644 index 0000000..63b6e7e --- /dev/null +++ b/cmake/icbsp_options.cmake @@ -0,0 +1,67 @@ +# ------------------------------------------------------------------------------ +# icbsp:编译优化选项(integrate.py / Web UI 的“编译优化”生成) +# +# include(/cmake/icbsp_options.cmake) +# icbsp_optimization(TARGET ${CMAKE_PROJECT_NAME} +# Debug -Og RelWithDebInfo -O2 Release -Os +# VENDOR_OS) +# +# - 每个构建类型一个优化等级,作用于宿主目标、icbsp、CubeMX 生成的全部源码目标(HAL、FreeRTOS、USB…)。 +# 用 target_compile_options 追加:它排在工具链文件的 CMAKE__FLAGS_(如 -O0 -g3)之后, +# GCC 以最后一个 -O 为准,所以不用改 CubeMX 生成的工具链文件;-g 级别保持不变。 +# - VENDOR_OS:CubeMX 生成的源码目标(cmake/stm32cubemx 下的 HAL / FreeRTOS / USB 等)在所有构建类型下都用 -Os, +# Debug 时自己的代码仍按上面的等级(例如 -O0),可以省下二三十 KB。 +# - 没写的构建类型保持工具链文件原样。 +# ------------------------------------------------------------------------------ +include_guard(GLOBAL) + +set(ICBSP_OPT_LEVELS -O0 -Og -O1 -O2 -O3 -Os) + +function(icbsp_optimization) + cmake_parse_arguments(ARG "VENDOR_OS" "TARGET;Debug;Release;RelWithDebInfo;MinSizeRel" "" ${ARGN}) + if(NOT ARG_TARGET) + message(FATAL_ERROR "icbsp_optimization: 需要 TARGET(宿主可执行目标)") + endif() + set(_genex "") + set(_desc "") + foreach(_cfg Debug Release RelWithDebInfo MinSizeRel) + if(ARG_${_cfg}) + if(NOT ARG_${_cfg} IN_LIST ICBSP_OPT_LEVELS) + message(FATAL_ERROR "icbsp_optimization: ${_cfg} 的等级 ${ARG_${_cfg}} 无效,可选 ${ICBSP_OPT_LEVELS}") + endif() + string(APPEND _genex "$<$:${ARG_${_cfg}}>") + list(APPEND _desc "${_cfg}=${ARG_${_cfg}}") + endif() + endforeach() + list(JOIN _desc " " _desc) + if(ARG_VENDOR_OS) + string(APPEND _desc ",CubeMX 源码固定 -Os") + endif() + message(STATUS "icbsp: 编译优化 ${_desc}") + cmake_language(EVAL CODE " + cmake_language(DEFER DIRECTORY [[${CMAKE_SOURCE_DIR}]] + CALL _icbsp_optimization_apply [[${ARG_TARGET}]] [[${_genex}]] [[${ARG_VENDOR_OS}]])") +endfunction() + +function(_icbsp_optimization_apply target genex vendor_os) + set(_lang "$") + set(_own ${target}) + if(TARGET icbsp) + list(APPEND _own icbsp) + endif() + set(_vendor "") + if(EXISTS "${CMAKE_SOURCE_DIR}/cmake/stm32cubemx") + get_property(_vendor DIRECTORY "${CMAKE_SOURCE_DIR}/cmake/stm32cubemx" PROPERTY BUILDSYSTEM_TARGETS) + endif() + foreach(_t IN LISTS _own _vendor) + get_target_property(_type ${_t} TYPE) + if(_type STREQUAL "INTERFACE_LIBRARY" OR _type STREQUAL "UTILITY") + continue() + endif() + if(vendor_os AND _t IN_LIST _vendor) + target_compile_options(${_t} PRIVATE "$<${_lang}:-Os>") + elseif(genex) + target_compile_options(${_t} PRIVATE "$<${_lang}:${genex}>") + endif() + endforeach() +endfunction() diff --git a/code/algorithm/math_constants.hpp b/code/algorithm/math_constants.hpp new file mode 100644 index 0000000..a4e700a --- /dev/null +++ b/code/algorithm/math_constants.hpp @@ -0,0 +1,12 @@ +/** + * @file math_constants.hpp + * @brief 库共用的数学常量(带 ICBSP_ 前缀,不和 arm_math.h 等的 PI 宏冲突;评审 I6) + */ + +#ifndef __ALGORITHM_MATH_CONSTANTS_HPP__ +#define __ALGORITHM_MATH_CONSTANTS_HPP__ + +inline constexpr double ICBSP_PI = 3.14159265358979323846; ///< π(double) +inline constexpr float ICBSP_PI_F = 3.14159265358979323846f; ///< π(float,给 float 运算用,免得整式提升成 double) + +#endif // __ALGORITHM_MATH_CONSTANTS_HPP__ diff --git a/code/algorithm/matrix.cpp b/code/algorithm/matrix.cpp index cbf330b..be008ce 100644 --- a/code/algorithm/matrix.cpp +++ b/code/algorithm/matrix.cpp @@ -1,4 +1,4 @@ -#include "matrix.hpp" +#include "algorithm/matrix.hpp" /* ==================== 常用向量 ==================== */ diff --git a/code/algorithm/matrix.hpp b/code/algorithm/matrix.hpp index 915490d..96b3a46 100644 --- a/code/algorithm/matrix.hpp +++ b/code/algorithm/matrix.hpp @@ -1,6 +1,6 @@ /** * @file matrix.hpp - * @author yssickjgd (1345578933@qq.com)(原作 alg_matrix.h / alg_matrix.cpp);ChoseB(移植到 stm32_framework 并修改) + * @author yssickjgd (1345578933@qq.com)(原作 alg_matrix.h / alg_matrix.cpp);ChoseB(移植到 ICBSP 并修改) * @brief 定长单精度矩阵:四则运算、转置、求逆(报告奇异)、向量模长 / 归一化 / 点乘 / 叉乘、常用旋转矩阵 * @version 0.2 * @date 2026-10-31 @@ -279,8 +279,12 @@ class MatrixF32 /** @brief 取唯一的元素(只有 1×1 可调用,例如 vᵀ·A·v 的结果) */ float scalar() const; -public: - float _data[ROWS * COLS]; ///< 数据,行优先(公开以便不同尺寸的 MatrixF32 互访) +private: + // 不同尺寸的 MatrixF32 互为友元(乘法、转置、row() / col() 要访问别的尺寸的数据);外部用 data() / operator[] 访问(C23) + template + friend class MatrixF32; + + float _data[ROWS * COLS]; ///< 数据,行优先 }; /* ==================== */ diff --git a/code/algorithm/pid.cpp b/code/algorithm/pid.cpp index 6370d9e..2187a6c 100644 --- a/code/algorithm/pid.cpp +++ b/code/algorithm/pid.cpp @@ -1,4 +1,4 @@ -#include "pid.hpp" +#include "algorithm/pid.hpp" #include PID::PID(const Config& cfg) : _config(cfg) diff --git a/code/algorithm/pid.hpp b/code/algorithm/pid.hpp index a2e9c7e..a6aab1a 100644 --- a/code/algorithm/pid.hpp +++ b/code/algorithm/pid.hpp @@ -244,7 +244,7 @@ class PID * @param target 目标值 * @param feedback 反馈值 * @return float 输出 - * @note 输入不是有限值(NaN / Inf)时丢弃这一拍:状态不变、返回上一拍的输出,计入 nonfinite_count()(F1)。 + * @note 输入不是有限值(NaN / Inf)时丢弃这一拍:状态不变、返回上一拍的输出,计入 get_nonfinite_count()(F1)。 */ float calc(float target, float feedback); @@ -279,13 +279,7 @@ class PID Data get() const { return {_input.target, _input.feedback, _output}; } /** @brief 因输入不是有限值(NaN / Inf)而丢弃的 calc() / feed_forward() 次数 */ - uint32_t nonfinite_count() const { return _nonfinite_count; } - - /* ==================== */ - /* ==================== 数据接口 ==================== */ - - PidInput _input; ///< 输入缓存 - float _output = 0.0f; ///< 输出 + uint32_t get_nonfinite_count() const { return _nonfinite_count; } protected: /** @@ -311,6 +305,8 @@ class PID /* ==================== */ /* ==================== 私有成员变量 ==================== */ + PidInput _input; ///< 输入缓存(读用 get();评审 I6:原来是公有成员) + float _output = 0.0f; ///< 输出 Config _config; ///< PID 配置 PidTerm _term; ///< 各项计算值 DiffMode _diff_mode = DiffMode::DIFF_FEEDBACK; ///< 微分计算模式 diff --git a/code/algorithm/quaternion.cpp b/code/algorithm/quaternion.cpp index 243f8db..953674f 100644 --- a/code/algorithm/quaternion.cpp +++ b/code/algorithm/quaternion.cpp @@ -1,4 +1,4 @@ -#include "quaternion.hpp" +#include "algorithm/quaternion.hpp" #include @@ -232,7 +232,7 @@ void Quaternion::to_euler_zyx(double &yaw, double &pitch, double &roll) const double angle_wrap_pi(double rad) { - return remainder(rad, 2.0 * PI_D); // IEEE 余数:结果在 [-π, π],任意大小的输入一步到位 + return remainder(rad, 2.0 * ICBSP_PI); // IEEE 余数:结果在 [-π, π],任意大小的输入一步到位 } double angle_diff(double target, double current) diff --git a/code/algorithm/quaternion.hpp b/code/algorithm/quaternion.hpp index 484b086..003acb0 100644 --- a/code/algorithm/quaternion.hpp +++ b/code/algorithm/quaternion.hpp @@ -23,7 +23,7 @@ * Quaternion q = Quaternion::from_array(d.quaternion); * * // 2) 安装旋转:q_mount = 机构系 → 芯片系的固定旋转(例如芯片绕机构 y 轴转了 90°) - * const Quaternion q_mount = Quaternion::from_axis_angle({0.0, 1.0, 0.0}, PI_D / 2.0); + * const Quaternion q_mount = Quaternion::from_axis_angle({0.0, 1.0, 0.0}, ICBSP_PI / 2.0); * Quaternion q_body = q * q_mount; // 机构系 → 世界系 * * // 3) 云台:取枪管(机构 x 轴)在世界系的水平角与仰角,不算 roll,只有竖直朝天 / 朝地时奇异 @@ -43,7 +43,7 @@ #ifndef __QUATERNION_HPP__ #define __QUATERNION_HPP__ -constexpr double PI_D = 3.14159265358979323846; ///< 双精度 π(imu_definition.hpp 的 PI 是 float) +#include "algorithm/math_constants.hpp" // IWYU pragma: export(ICBSP_PI,原 PI_D) /** * @brief 三维向量(聚合类型,可 {x, y, z} 初始化) diff --git a/code/algorithm/quaternion_pid.cpp b/code/algorithm/quaternion_pid.cpp index ef48685..ac4e5c3 100644 --- a/code/algorithm/quaternion_pid.cpp +++ b/code/algorithm/quaternion_pid.cpp @@ -1,4 +1,4 @@ -#include "quaternion_pid.hpp" +#include "algorithm/quaternion_pid.hpp" /* ==================== QuaternionPID ==================== */ diff --git a/code/algorithm/quaternion_pid.hpp b/code/algorithm/quaternion_pid.hpp index ec89589..5d3b139 100644 --- a/code/algorithm/quaternion_pid.hpp +++ b/code/algorithm/quaternion_pid.hpp @@ -8,8 +8,8 @@ #include -#include "pid.hpp" -#include "quaternion.hpp" +#include "algorithm/pid.hpp" +#include "algorithm/quaternion.hpp" /** diff --git a/code/algorithm/rls.hpp b/code/algorithm/rls.hpp index 27ca11f..6f1181c 100644 --- a/code/algorithm/rls.hpp +++ b/code/algorithm/rls.hpp @@ -49,8 +49,8 @@ #include #include -#include "matrix.hpp" -#include "status_code.hpp" // 统一状态码(不依赖 RTOS,A6) +#include "algorithm/matrix.hpp" +#include "service/system/status_code.hpp" // 统一状态码(不依赖 RTOS,A6) /** * @brief 带遗忘因子的递归最小二乘 @@ -101,7 +101,7 @@ class Rls * @param x 回归向量(X_DIM×1) * @param y 观测(Y_DIM×1) * @return OK=已更新;NOT_INIT=init() 没成功过;BAD_ARG=x / y 含 NaN / inf 或本次结果非有限,样本被丢弃、状态不变 - * @note P 失去正定时自动重置为 p0·I 并继续本次更新(仍返回 OK),次数见 covariance_reset_count()。 + * @note P 失去正定时自动重置为 p0·I 并继续本次更新(仍返回 OK),次数见 get_covariance_reset_count()。 */ Status update(const MatrixF32 &x, const MatrixF32 &y); @@ -136,25 +136,25 @@ class Rls } /** @brief 成功更新的样本数 */ - uint32_t update_count() const + uint32_t get_update_count() const { return _update_cnt; } /** @brief 因非有限值被丢弃的样本数 */ - uint32_t reject_count() const + uint32_t get_reject_count() const { return _reject_cnt; } /** @brief P 失去正定而重置的次数;持续增加说明单精度不够或模型 / 数据有问题 */ - uint32_t covariance_reset_count() const + uint32_t get_covariance_reset_count() const { return _reset_cnt; } /** @brief tr(P) 触到上限而限制放大的次数;持续增加说明输入激励不足 */ - uint32_t trace_limit_count() const + uint32_t get_trace_limit_count() const { return _trace_limit_cnt; } diff --git a/code/algorithm/vqf.cpp b/code/algorithm/vqf.cpp index 4be221a..6d27a59 100644 --- a/code/algorithm/vqf.cpp +++ b/code/algorithm/vqf.cpp @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: MIT -#include "vqf.hpp" +#include "algorithm/vqf.hpp" #include #include diff --git a/code/bsp/bsp_can.cpp b/code/bsp/bsp_can.cpp index 9031002..4b2be34 100644 --- a/code/bsp/bsp_can.cpp +++ b/code/bsp/bsp_can.cpp @@ -1,10 +1,10 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // F4:bxCAN 的 HAL 回调(H7 的 FDCAN 回调在 bsp_fdcan.cpp) #if defined(HAL_CAN_MODULE_ENABLED) #include "board_instances.hpp" -#include "bsp_can.hpp" +#include "bsp/bsp_can.hpp" #include "FreeRTOS.h" // IWYU pragma: keep @@ -13,6 +13,9 @@ bool bsp_bxcan_is_listed(const void *self, const CAN_HandleTypeDef *hcan) { + // 实例清单为空时 X-macro 展开成空,参数用不到 + (void)self; + (void)hcan; bool listed = false; uint32_t same = 0U; // 清单里绑这个句柄的实例数 #define X(name) \ @@ -20,11 +23,11 @@ bool bsp_bxcan_is_listed(const void *self, const CAN_HandleTypeDef *hcan) { \ listed = true; \ } \ - if (name.handle() == hcan) \ + if (name.get_handle() == hcan) \ { \ same = same + 1U; \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X return listed && same == 1U; } @@ -32,7 +35,7 @@ bool bsp_bxcan_is_listed(const void *self, const CAN_HandleTypeDef *hcan) /* ==================== HAL 回调分发(bxCAN) ==================== */ -// 按句柄和 BSP_CAN_INSTANCES 清单逐个比对,清单外的 bxCAN 直接忽略。 +// 按句柄和 ICBSP_CAN_INSTANCES 清单逐个比对,清单外的 bxCAN 直接忽略。 extern "C" { /** @brief RX FIFO0 有新报文 */ @@ -43,11 +46,11 @@ extern "C" { } #define X(name) \ - else if (hcan == name.handle()) \ + else if (hcan == name.get_handle()) \ { \ name.process_fifo0_isr(0U, &woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -64,11 +67,11 @@ extern "C" { } #define X(name) \ - else if (hcan == name.handle()) \ + else if (hcan == name.get_handle()) \ { \ name.trigger_tx_from_isr(&woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -85,11 +88,11 @@ extern "C" { } #define X(name) \ - else if (hcan == name.handle()) \ + else if (hcan == name.get_handle()) \ { \ name.trigger_tx_from_isr(&woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -106,11 +109,11 @@ extern "C" { } #define X(name) \ - else if (hcan == name.handle()) \ + else if (hcan == name.get_handle()) \ { \ name.trigger_tx_from_isr(&woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -126,11 +129,11 @@ extern "C" { } #define X(name) \ - else if (hcan == name.handle()) \ + else if (hcan == name.get_handle()) \ { \ name.process_error_isr(hcan->ErrorCode); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { diff --git a/code/bsp/bsp_can.hpp b/code/bsp/bsp_can.hpp index b8aedb1..b476683 100644 --- a/code/bsp/bsp_can.hpp +++ b/code/bsp/bsp_can.hpp @@ -19,11 +19,11 @@ #ifndef __BSP_CAN_HPP__ #define __BSP_CAN_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(系列桥接) #if defined(HAL_FDCAN_MODULE_ENABLED) -# include "bsp_fdcan.hpp" +# include "bsp/bsp_fdcan.hpp" #elif defined(HAL_CAN_MODULE_ENABLED) @@ -52,17 +52,11 @@ #include "message_buffer.h" #include "task.h" // IWYU pragma: keep -#include "hardware_config.h" // CAN_RX_ENABLE、CAN_RX_RETURN_FRAMES、CAN_BUSOFF_RETRY_MS -#include "status.hpp" +#include "service/system/config_check.hpp" // ICBSP_CAN_RX_ENABLE、ICBSP_CAN_RX_RETURN_FRAMES、ICBSP_CAN_BUSOFF_RETRY_MS +#include "service/system/status_code.hpp" #include -#ifndef CAN_RX_RETURN_FRAMES -# error "hardware_config.h 缺少 CAN_RX_RETURN_FRAMES(回退缓冲深度,0 = 不建回退缓冲),见 templates/user/board/hardware_config.h" -#endif -#ifndef CAN_BUSOFF_RETRY_MS -# error "hardware_config.h 缺少 CAN_BUSOFF_RETRY_MS,见 templates/user/board/hardware_config.h" -#endif /* ==================== 帧结构(与 bsp_fdcan.hpp 的 FDCAN 版逐字相同) ==================== */ @@ -88,7 +82,7 @@ constexpr uint16_t CAN_DLC_MASK_8 = 1U << 8; ///< 只接受 8 字节帧(默 constexpr uint16_t CAN_DLC_MASK_ANY = 0x01FFU; ///< 接受 0~8 任意长度 /** - * @brief 实例是否在 board_instances.hpp 的 BSP_CAN_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_can.cpp) + * @brief 实例是否在 board_instances.hpp 的 ICBSP_CAN_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_can.cpp) */ bool bsp_bxcan_is_listed(const void *self, const CAN_HandleTypeDef *hcan); @@ -200,7 +194,7 @@ class BspCanT } /** @brief 底层句柄(供 HAL 回调分发) */ - CAN_HandleTypeDef *handle() const + CAN_HandleTypeDef *get_handle() const { return _hcan; } @@ -251,7 +245,7 @@ class BspCanT /* ==================== 成员 ==================== */ /** @brief 回退缓冲是否存在(有 can_rx_task 且深度非 0) */ - static constexpr bool HAS_RETURN = (CAN_RX_ENABLE != 0) && (CAN_RX_RETURN_FRAMES > 0); + static constexpr bool HAS_RETURN = (ICBSP_CAN_RX_ENABLE != 0) && (ICBSP_CAN_RX_RETURN_FRAMES > 0); /** @brief 发送邮箱个数(bxCAN 固定 3 个) */ static constexpr uint32_t MAILBOXES = 3U; @@ -259,7 +253,7 @@ class BspCanT CAN_HandleTypeDef *_hcan; const char *_name; MessageBufferHandle_t _tx_message_buffer = nullptr; ///< 写者:send()(临界区);读者:临界区里的任务侧或发送完成中断 - MessageBufferHandle_t _rx_message_buffer = nullptr; ///< 写者:FIFO0 中断;读者:can_rx_task(或 CAN_RX_ENABLE = 0 时的 receive()) + MessageBufferHandle_t _rx_message_buffer = nullptr; ///< 写者:FIFO0 中断;读者:can_rx_task(或 ICBSP_CAN_RX_ENABLE = 0 时的 receive()) MessageBufferHandle_t _rx_return_buffer = nullptr; ///< 写者:can_rx_task;读者:receive() TickType_t _recovery_started = 0U; TickType_t _recovery_attempted = 0U; @@ -419,7 +413,7 @@ Status BspCanT::init() _tx_message_buffer = xMessageBufferCreate((sizeof(CanTxMsg) + 4U) * TX_DEPTH); if (HAS_RETURN) { - _rx_return_buffer = xMessageBufferCreate((sizeof(CanRxMsg) + 4U) * static_cast(CAN_RX_RETURN_FRAMES > 0 ? CAN_RX_RETURN_FRAMES : 1)); + _rx_return_buffer = xMessageBufferCreate((sizeof(CanRxMsg) + 4U) * static_cast(ICBSP_CAN_RX_RETURN_FRAMES > 0 ? ICBSP_CAN_RX_RETURN_FRAMES : 1)); } if (_rx_message_buffer == nullptr || _tx_message_buffer == nullptr || (HAS_RETURN && _rx_return_buffer == nullptr)) { @@ -513,10 +507,10 @@ Status BspCanT::receive(CanRxMsg *msg, uint32_t timeout_ms) { return Status::BAD_ARG; } -#if CAN_RX_ENABLE +#if ICBSP_CAN_RX_ENABLE if (!HAS_RETURN) { - return Status::NOT_SUPPORTED; // CAN_RX_RETURN_FRAMES = 0:没人认领的帧不保留 + return Status::NOT_SUPPORTED; // ICBSP_CAN_RX_RETURN_FRAMES = 0:没人认领的帧不保留 } MessageBufferHandle_t buf = _rx_return_buffer; // 只读回退缓冲:原始缓冲只归 can_rx_task #else @@ -551,7 +545,7 @@ bool BspCanT::return_frame(const CanRxMsg &msg) diagnostics.rx_unclaimed = diagnostics.rx_unclaimed + 1U; if (_rx_return_buffer == nullptr) { - return false; // 没有回退缓冲(CAN_RX_RETURN_FRAMES = 0):只计数 + return false; // 没有回退缓冲(ICBSP_CAN_RX_RETURN_FRAMES = 0):只计数 } if (xMessageBufferSend(_rx_return_buffer, &msg, sizeof(msg), 0) != sizeof(msg)) { @@ -591,7 +585,7 @@ Status BspCanT::service_recovery() } const TickType_t now = xTaskGetTickCount(); - const TickType_t retry = pdMS_TO_TICKS(CAN_BUSOFF_RETRY_MS); + const TickType_t retry = pdMS_TO_TICKS(ICBSP_CAN_BUSOFF_RETRY_MS); taskENTER_CRITICAL(); const bool bus_off = (_hcan->Instance->ESR & CAN_ESR_BOFF) != 0U; if (bus_off && !diagnostics.recovering) diff --git a/code/bsp/bsp_dma_buffer.hpp b/code/bsp/bsp_dma_buffer.hpp index fff099d..5421270 100644 --- a/code/bsp/bsp_dma_buffer.hpp +++ b/code/bsp/bsp_dma_buffer.hpp @@ -17,7 +17,7 @@ #ifndef __BSP_DMA_BUFFER_HPP__ #define __BSP_DMA_BUFFER_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(ICBSP_DMA_BUFFER、DMA_HandleTypeDef、IS_BDMA_CHANNEL_INSTANCE) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(ICBSP_DMA_BUFFER、DMA_HandleTypeDef、IS_BDMA_CHANNEL_INSTANCE) #include diff --git a/code/bsp/bsp_dwt.cpp b/code/bsp/bsp_dwt.cpp index 3c720f3..38d75fd 100644 --- a/code/bsp/bsp_dwt.cpp +++ b/code/bsp/bsp_dwt.cpp @@ -1,4 +1,4 @@ -#include "bsp_dwt.hpp" +#include "bsp/bsp_dwt.hpp" /* ==================== 公共接口 ==================== */ @@ -15,7 +15,7 @@ Status BspDwt::init() { CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk; // 1. 总开关(脱机运行时必须自己置位) -#if BSP_SERIES_H7 +#if ICBSP_SERIES_H7 DWT->LAR = 0xC5ACCE55UL; // 2. Cortex-M7 的软件锁解锁 #endif // F4(CM4):DWT 结构里没有 LAR(这个 CMSIS 版本把 LAR 归到 ITM),也不需要解锁 @@ -148,7 +148,7 @@ uint64_t BspDwt::update_timeline() */ uint32_t BspDwt::get_cpu_clock_hz() { -#if BSP_SERIES_F4 +#if ICBSP_SERIES_F4 return HAL_RCC_GetHCLKFreq(); #else // D1CPRE 的编码与 AHB 预分频 HPRE 相同:0xx=/1,1000=/2 … 1111=/512 diff --git a/code/bsp/bsp_dwt.hpp b/code/bsp/bsp_dwt.hpp index eb0a7c3..80fb01d 100644 --- a/code/bsp/bsp_dwt.hpp +++ b/code/bsp/bsp_dwt.hpp @@ -9,7 +9,7 @@ * * @note CYCCNT 不占外设、不依赖中断,关中断期间仍可计时;分辨率 = 1 个 CPU 周期。 * CPU 频率由 init() 从 RCC 自动推算,不设 Config。 - * 回绕周期、精度对比与调用约束见 bsp_dwt.md。 + * 回绕周期与调用约束见下面 get_cycles() / delay_*() 的注释,用法见 docs/code/bsp.md 的 BspDwt 一节。 * * @warning get_delta_s() 的时间戳由调用方保存,同一个 last 不要跨任务共用。 * @warning CPU 进入 sleep/stop 时停止计数;32 位计数器会周期性回绕。 @@ -18,8 +18,8 @@ #ifndef __BSP_DWT_HPP__ #define __BSP_DWT_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(DWT / CoreDebug / RCC / HAL) -#include "status.hpp" // 统一状态码 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(DWT / CoreDebug / RCC / HAL) +#include "service/system/status_code.hpp" // 统一状态码 #include @@ -63,7 +63,7 @@ class BspDwt * @brief 当前绝对时间(秒,自 init() 起算) * @note 任何上下文都能调(任务 / ISR / 调度器启动前):回绕检测在一段很短的关中断区里做(C11)。 * @note 回绕要求两次调用间隔小于一圈(550 MHz 下 7.8 s):sys_task 每 10 ms 调一次 get_cycles() 保证这一点; - * SYS_TASK_ENABLE = 0 时由宿主自己定期调用。 + * ICBSP_SYS_TASK_ENABLE = 0 时由宿主自己定期调用。 */ double get_time_s(); @@ -77,7 +77,7 @@ class BspDwt uint64_t get_cycles(); /** @brief init() 是否成功(未成功时 delay_*() 不等待、时间恒为 0) */ - bool is_init() const + bool is_initialized() const { return _inited; } @@ -135,7 +135,7 @@ class BspDwt /** * @brief 库内唯一的 DWT 实例 * - * @note 定义在 `code/service/system.cpp`(与 `system_init()` 同一文件)。 + * @note 定义在 `code/service/system/system.cpp`(与 `system_init()` 同一文件)。 * 宿主**不要**再定义同名实例、也不要再调 `init()`:包含本头文件后直接使用即可 * (例如 `bsp_dwt.get_delta_s(&last)`)。 */ diff --git a/code/bsp/bsp_encoder.cpp b/code/bsp/bsp_encoder.cpp index 89e9310..35ee25c 100644 --- a/code/bsp/bsp_encoder.cpp +++ b/code/bsp/bsp_encoder.cpp @@ -1,9 +1,9 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "bsp_encoder.hpp" +#include "bsp/bsp_encoder.hpp" /* ==================== 公共接口 ==================== */ diff --git a/code/bsp/bsp_encoder.hpp b/code/bsp/bsp_encoder.hpp index 3cb036e..2c755a3 100644 --- a/code/bsp/bsp_encoder.hpp +++ b/code/bsp/bsp_encoder.hpp @@ -12,7 +12,7 @@ * 把 16 位计数换算成「增量」和「累计位置」,并处理 0/65535 的回绕。 * * @note 用法:init() 启动计数 → 在固定周期任务里调 read_delta() 取本周期增量, - * 或直接读 position() 取上电以来的累计位置(可正可负,int32)。 + * 或直接读 get_position() 取上电以来的累计位置(可正可负,int32)。 * * @note 增量靠 `(int16_t)(now - last)` 算:只要两次调用之间走过不到 32768 个计数, * 回绕就是自动正确的。所以调用周期越短越安全。 @@ -24,13 +24,13 @@ #ifndef __BSP_ENCODER_HPP__ #define __BSP_ENCODER_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "status.hpp" // 统一状态码 -#include "bsp_series.hpp" // IWYU pragma: keep(TIM_HandleTypeDef / __HAL_TIM_*) +#include "service/system/status_code.hpp" // 统一状态码 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(TIM_HandleTypeDef / __HAL_TIM_*) #include @@ -79,7 +79,7 @@ class BspEncoder Status init(); /** - * @brief 取上次调用以来的增量(按计数器位宽处理回绕),并累加进 position() + * @brief 取上次调用以来的增量(按计数器位宽处理回绕),并累加进 get_position() * * @return 本次增量,向前为正(invert 时定义相反) * @@ -88,7 +88,7 @@ class BspEncoder int32_t read_delta(); /** @brief 上电(或上次 reset())以来的累计位置,int32 多圈计数 */ - int32_t position() const { return _position; } + int32_t get_position() const { return _position; } /** @brief 计数器原始值,已按 invert 取反(16 位 TIM 为 -32768~32767,32 位 TIM 为 int32 全范围) */ int32_t read_raw() const; @@ -101,7 +101,7 @@ class BspEncoder void reset(); /** @brief 是否已成功 init() */ - bool initialized() const { return _initialized; } + bool is_initialized() const { return _initialized; } /* ==================== */ private: diff --git a/code/bsp/bsp_fdcan.cpp b/code/bsp/bsp_fdcan.cpp index ada3379..6d04164 100644 --- a/code/bsp/bsp_fdcan.cpp +++ b/code/bsp/bsp_fdcan.cpp @@ -1,10 +1,10 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // FDCAN 的 HAL 回调(H7);F4 的 bxCAN 回调在 bsp_can.cpp #if defined(HAL_FDCAN_MODULE_ENABLED) #include "board_instances.hpp" -#include "bsp_can.hpp" +#include "bsp/bsp_can.hpp" #include "FreeRTOS.h" // IWYU pragma: keep @@ -13,6 +13,9 @@ bool bsp_can_is_listed(const void *self, const FDCAN_HandleTypeDef *hfdcan) { + // 实例清单为空时 X-macro 展开成空,参数用不到 + (void)self; + (void)hfdcan; bool listed = false; uint32_t same = 0U; // 清单里绑这个句柄的实例数 #define X(name) \ @@ -20,11 +23,11 @@ bool bsp_can_is_listed(const void *self, const FDCAN_HandleTypeDef *hfdcan) { \ listed = true; \ } \ - if (name.handle() == hfdcan) \ + if (name.get_handle() == hfdcan) \ { \ same = same + 1U; \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X return listed && same == 1U; } @@ -32,7 +35,7 @@ bool bsp_can_is_listed(const void *self, const FDCAN_HandleTypeDef *hfdcan) /* ==================== HAL 回调分发 ==================== */ -// BspCanT 只有头文件,这里只放 HAL 回调:按句柄和 BSP_CAN_INSTANCES 清单逐个比对,清单外的 FDCAN 直接忽略。 +// BspCanT 只有头文件,这里只放 HAL 回调:按句柄和 ICBSP_CAN_INSTANCES 清单逐个比对,清单外的 FDCAN 直接忽略。 extern "C" { /** @@ -46,11 +49,11 @@ extern "C" { } #define X(name) \ - else if (hfdcan == name.handle()) \ + else if (hfdcan == name.get_handle()) \ { \ name.process_fifo0_isr(RxFifo0ITs, &woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -67,11 +70,11 @@ extern "C" { } #define X(name) \ - else if (hfdcan == name.handle()) \ + else if (hfdcan == name.get_handle()) \ { \ name.trigger_tx_from_isr(&woken); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { @@ -87,11 +90,11 @@ extern "C" { } #define X(name) \ - else if (hfdcan == name.handle()) \ + else if (hfdcan == name.get_handle()) \ { \ name.process_error_isr(ErrorStatusITs); \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) #undef X else { diff --git a/code/bsp/bsp_fdcan.hpp b/code/bsp/bsp_fdcan.hpp index 8a4c0af..d167275 100644 --- a/code/bsp/bsp_fdcan.hpp +++ b/code/bsp/bsp_fdcan.hpp @@ -8,26 +8,26 @@ * @copyright Copyright (c) 2026 * * @details 本层只做三件事:硬件收发、总线恢复、诊断计数。**只有头文件**(任意 `` 都能用); - * HAL 回调按 board_instances.hpp 的 BSP_CAN_INSTANCES 分发(bsp_can.cpp)。 + * HAL 回调按 board_instances.hpp 的 ICBSP_CAN_INSTANCES 分发(bsp_can.cpp)。 * * @note 发送:send() 非阻塞,帧进软件发送缓冲后立即尝试写进硬件 TX FIFO;硬件满时由 TX-FIFO-EMPTY 中断续发 * (该中断只在软件缓冲有帧时打开)。sys_task 每 10 ms 调 tx_recover() 兜底。 * “软件缓冲 → 硬件 FIFO”只发生在临界区(任务侧)或 FDCAN 中断里,发送缓冲只有一个写者、读者之间不会交错。 * send() 用任务级临界区,**不能在中断里调用**。 * @note 接收:FIFO0 中断把帧(只拷 DLC 个字节,其余为 0)投进原始接收缓冲。 - * - CAN_RX_ENABLE = 1:can_rx_task 每 1 ms 取走并分发给接收节点,没有节点认领的帧进回退缓冲, - * receive() 只读回退缓冲(深度 CAN_RX_RETURN_FRAMES,0 = 不建回退缓冲,没人认领的帧只计数); - * - CAN_RX_ENABLE = 0:没有 can_rx_task,receive() 直接读原始接收缓冲。 + * - ICBSP_CAN_RX_ENABLE = 1:can_rx_task 每 1 ms 取走并分发给接收节点,没有节点认领的帧进回退缓冲, + * receive() 只读回退缓冲(深度 ICBSP_CAN_RX_RETURN_FRAMES,0 = 不建回退缓冲,没人认领的帧只计数); + * - ICBSP_CAN_RX_ENABLE = 0:没有 can_rx_task,receive() 直接读原始接收缓冲。 * 同一条总线的 receive() **只允许一个任务调用**。 * @note 远程帧由硬件拒收;DLC > 8 的帧(FD 帧或经典帧 DLC 9~15)丢弃并计入 rx_len_drop。 - * @note Bus-Off:sys_task 每 10 ms 调 service_recovery(),按 CAN_BUSOFF_RETRY_MS 限流清 CCCR.INIT, + * @note Bus-Off:sys_task 每 10 ms 调 service_recovery(),按 ICBSP_CAN_BUSOFF_RETRY_MS 限流清 CCCR.INIT, * 进入 Bus-Off 时取消硬件里未发出的旧帧并清空软件发送缓冲(避免恢复瞬间发出过期指令)。 */ #ifndef __BSP_FDCAN_HPP__ #define __BSP_FDCAN_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 FDCAN(HAL_FDCAN_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_FDCAN_MODULE_ENABLED @@ -36,19 +36,13 @@ #include "message_buffer.h" #include "task.h" // IWYU pragma: keep -#include "hardware_config.h" // CAN_RX_ENABLE、CAN_RX_RETURN_FRAMES、CAN_BUSOFF_RETRY_MS -#include "status.hpp" +#include "service/system/config_check.hpp" // ICBSP_CAN_RX_ENABLE、ICBSP_CAN_RX_RETURN_FRAMES、ICBSP_CAN_BUSOFF_RETRY_MS +#include "service/system/status_code.hpp" #include #include #include -#ifndef CAN_RX_RETURN_FRAMES -# error "hardware_config.h 缺少 CAN_RX_RETURN_FRAMES(回退缓冲深度,0 = 不建回退缓冲),见 templates/user/board/hardware_config.h" -#endif -#ifndef CAN_BUSOFF_RETRY_MS -# error "hardware_config.h 缺少 CAN_BUSOFF_RETRY_MS,见 templates/user/board/hardware_config.h" -#endif /* ==================== 帧结构 ==================== */ @@ -74,7 +68,7 @@ constexpr uint16_t CAN_DLC_MASK_8 = 1U << 8; ///< 只接受 8 字节帧(默 constexpr uint16_t CAN_DLC_MASK_ANY = 0x01FFU; ///< 接受 0~8 任意长度 /** - * @brief 实例是否在 board_instances.hpp 的 BSP_CAN_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_can.cpp) + * @brief 实例是否在 board_instances.hpp 的 ICBSP_CAN_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_can.cpp) * @note HAL 回调与 can_rx / can_tx / sys_task 只认清单里的实例;init() 用它把“漏写清单 / 两个实例绑同一句柄”变成 BAD_ARG。 */ bool bsp_can_is_listed(const void *self, const FDCAN_HandleTypeDef *hfdcan); @@ -82,7 +76,7 @@ bool bsp_can_is_listed(const void *self, const FDCAN_HandleTypeDef *hfdcan); /** * @brief 清单外 FDCAN 的回调转调(弱函数,默认什么也不做;实现在 bsp_can.cpp) * @note 库占用了 HAL_FDCAN_RxFifo0Callback / HAL_FDCAN_TxFifoEmptyCallback / HAL_FDCAN_ErrorStatusCallback,宿主不能再定义它们。 - * 不在 BSP_CAN_INSTANCES 里的 FDCAN 的这三个回调转到下面三个函数,宿主按需定义同名强函数即可。 + * 不在 ICBSP_CAN_INSTANCES 里的 FDCAN 的这三个回调转到下面三个函数,宿主按需定义同名强函数即可。 */ extern "C" { @@ -119,7 +113,7 @@ inline uint32_t dlc_to_len(uint32_t dlc_code) * @note 用法(实例写在 board_cfg.hpp): * * inline BspCanT<16, 16> bsp_can1({.hfdcan = &hfdcan1, .name = "CAN1"}); - * // board_instances.hpp 的 BSP_CAN_INSTANCES 里加 X(bsp_can1);board_init() 里 ICBSP_CHECK(bsp_can1.init() == Status::OK); + * // board_instances.hpp 的 ICBSP_CAN_INSTANCES 里加 X(bsp_can1);board_init() 里 ICBSP_CHECK(bsp_can1.init() == Status::OK); * * uint8_t d[8] = {...}; * bsp_can1.send(0x200, d); // 标准帧 8 字节 @@ -155,7 +149,7 @@ class BspCanT volatile uint32_t rx_dropped = 0; ///< 原始接收缓冲满而丢弃的帧数 volatile uint32_t rx_lost = 0; ///< 硬件 RX FIFO0 溢出(RF0L)的次数 volatile uint32_t rx_len_drop = 0; ///< DLC > 8 而丢弃的帧数 - volatile uint32_t rx_unclaimed = 0; ///< 没有接收节点认领的帧数(CAN_RX_ENABLE = 1 时由 can_rx_task 计) + volatile uint32_t rx_unclaimed = 0; ///< 没有接收节点认领的帧数(ICBSP_CAN_RX_ENABLE = 1 时由 can_rx_task 计) volatile uint32_t rx_return_dropped = 0; ///< 没人认领、回退缓冲又满而丢弃的帧数 // 发送 volatile uint32_t tx_dropped = 0; ///< 写入硬件 TX FIFO 失败而丢弃的帧数 @@ -181,7 +175,7 @@ class BspCanT /** * @brief 停外设、关通知、清软件缓冲,再按 CubeMX 配置重新启动(可重复调用,失败回滚) - * @return OK;BAD_ARG=句柄为空、实例不在 BSP_CAN_INSTANCES 里或清单里另有实例绑了同一句柄; + * @return OK;BAD_ARG=句柄为空、实例不在 ICBSP_CAN_INSTANCES 里或清单里另有实例绑了同一句柄; * IO_ERROR=资源创建或硬件启动失败 * @note 初始化阶段调用(system_init() 之后、system_start() 之前);运行中重新调用时不能有任务阻塞在本实例的 receive() 上。 */ @@ -197,7 +191,7 @@ class BspCanT } /** @brief 底层句柄(供 HAL 回调分发) */ - FDCAN_HandleTypeDef *handle() const + FDCAN_HandleTypeDef *get_handle() const { return _hfdcan; } @@ -223,9 +217,9 @@ class BspCanT Status send_latest(uint32_t id, const uint8_t *data, uint8_t dlc = 8U, uint32_t id_type = FDCAN_STANDARD_ID); /** - * @brief 取一帧:CAN_RX_ENABLE = 1 时取没人认领的帧(回退缓冲),= 0 时取所有收到的帧 + * @brief 取一帧:ICBSP_CAN_RX_ENABLE = 1 时取没人认领的帧(回退缓冲),= 0 时取所有收到的帧 * @param timeout_ms 0=不等待,portMAX_DELAY=一直等 - * @return OK;TIMEOUT=没有数据;BAD_ARG;NOT_INIT;NOT_SUPPORTED=回退缓冲被关掉(CAN_RX_RETURN_FRAMES = 0) + * @return OK;TIMEOUT=没有数据;BAD_ARG;NOT_INIT;NOT_SUPPORTED=回退缓冲被关掉(ICBSP_CAN_RX_RETURN_FRAMES = 0) */ Status receive(CanRxMsg *msg, uint32_t timeout_ms = portMAX_DELAY); @@ -267,12 +261,12 @@ class BspCanT /* ==================== 成员 ==================== */ /** @brief 回退缓冲是否存在(有 can_rx_task 且深度非 0) */ - static constexpr bool HAS_RETURN = (CAN_RX_ENABLE != 0) && (CAN_RX_RETURN_FRAMES > 0); + static constexpr bool HAS_RETURN = (ICBSP_CAN_RX_ENABLE != 0) && (ICBSP_CAN_RX_RETURN_FRAMES > 0); FDCAN_HandleTypeDef *_hfdcan; const char *_name; MessageBufferHandle_t _tx_message_buffer = nullptr; ///< 写者:send()(临界区);读者:临界区里的任务侧或 FDCAN 中断 - MessageBufferHandle_t _rx_message_buffer = nullptr; ///< 写者:FIFO0 中断;读者:can_rx_task(或 CAN_RX_ENABLE = 0 时的 receive()) + MessageBufferHandle_t _rx_message_buffer = nullptr; ///< 写者:FIFO0 中断;读者:can_rx_task(或 ICBSP_CAN_RX_ENABLE = 0 时的 receive()) MessageBufferHandle_t _rx_return_buffer = nullptr; ///< 写者:can_rx_task;读者:receive() TickType_t _recovery_started = 0U; TickType_t _recovery_attempted = 0U; @@ -435,7 +429,7 @@ Status BspCanT::init() _tx_message_buffer = xMessageBufferCreate((sizeof(CanTxMsg) + 4U) * TX_DEPTH); if (HAS_RETURN) { - _rx_return_buffer = xMessageBufferCreate((sizeof(CanRxMsg) + 4U) * static_cast(CAN_RX_RETURN_FRAMES > 0 ? CAN_RX_RETURN_FRAMES : 1)); + _rx_return_buffer = xMessageBufferCreate((sizeof(CanRxMsg) + 4U) * static_cast(ICBSP_CAN_RX_RETURN_FRAMES > 0 ? ICBSP_CAN_RX_RETURN_FRAMES : 1)); } if (_rx_message_buffer == nullptr || _tx_message_buffer == nullptr || (HAS_RETURN && _rx_return_buffer == nullptr)) { @@ -529,10 +523,10 @@ Status BspCanT::receive(CanRxMsg *msg, uint32_t timeout_ms) { return Status::BAD_ARG; } -#if CAN_RX_ENABLE +#if ICBSP_CAN_RX_ENABLE if (!HAS_RETURN) { - return Status::NOT_SUPPORTED; // CAN_RX_RETURN_FRAMES = 0:没人认领的帧不保留 + return Status::NOT_SUPPORTED; // ICBSP_CAN_RX_RETURN_FRAMES = 0:没人认领的帧不保留 } MessageBufferHandle_t buf = _rx_return_buffer; // 只读回退缓冲:原始缓冲只归 can_rx_task(N21) #else @@ -567,7 +561,7 @@ bool BspCanT::return_frame(const CanRxMsg &msg) diagnostics.rx_unclaimed = diagnostics.rx_unclaimed + 1U; if (_rx_return_buffer == nullptr) { - return false; // 没有回退缓冲(CAN_RX_RETURN_FRAMES = 0):只计数 + return false; // 没有回退缓冲(ICBSP_CAN_RX_RETURN_FRAMES = 0):只计数 } if (xMessageBufferSend(_rx_return_buffer, &msg, sizeof(msg), 0) != sizeof(msg)) { @@ -607,7 +601,7 @@ Status BspCanT::service_recovery() } const TickType_t now = xTaskGetTickCount(); - const TickType_t retry = pdMS_TO_TICKS(CAN_BUSOFF_RETRY_MS); + const TickType_t retry = pdMS_TO_TICKS(ICBSP_CAN_BUSOFF_RETRY_MS); taskENTER_CRITICAL(); const bool bus_off = (_hfdcan->Instance->PSR & FDCAN_PSR_BO) != 0U; if (bus_off && !diagnostics.recovering) diff --git a/code/bsp/bsp_gpio.hpp b/code/bsp/bsp_gpio.hpp index b76d595..2215772 100644 --- a/code/bsp/bsp_gpio.hpp +++ b/code/bsp/bsp_gpio.hpp @@ -17,7 +17,7 @@ #ifndef __BSP_GPIO_HPP__ #define __BSP_GPIO_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep +#include "bsp/bsp_series.hpp" // IWYU pragma: keep #include @@ -65,8 +65,8 @@ class BspGpio bool get_level() const { return (HAL_GPIO_ReadPin(_port, _pin) != GPIO_PIN_RESET); } /** @brief 返回端口 / 引脚(供 SPI 片选等内部封装校验用) */ - GPIO_TypeDef *port() const { return _port; } - uint16_t pin() const { return _pin; } + GPIO_TypeDef *get_port() const { return _port; } + uint16_t get_pin() const { return _pin; } /* ==================== */ private: diff --git a/code/bsp/bsp_key.cpp b/code/bsp/bsp_key.cpp index a1d9630..0fc7de8 100644 --- a/code/bsp/bsp_key.cpp +++ b/code/bsp/bsp_key.cpp @@ -1,4 +1,4 @@ -#include "bsp_key.hpp" +#include "bsp/bsp_key.hpp" /* ==================== 初始化 ==================== */ diff --git a/code/bsp/bsp_key.hpp b/code/bsp/bsp_key.hpp index 4630c47..bfc5117 100644 --- a/code/bsp/bsp_key.hpp +++ b/code/bsp/bsp_key.hpp @@ -24,16 +24,16 @@ * 2. init() 以当前电平作为初始稳定状态:上电时若按键已被按住, * 不会产生 PRESS(防误触发),直接从"已按下"状态开始计时。 * 3. 未 init()(或 init() 失败)时,update() / read_raw() 安全返回,不会崩溃。 - * 状态机与用法见 bsp_key.md。 + * 状态机见下面 update() 的注释,用法见 docs/code/bsp.md 的 BspGpio / BspKey / BspEncoder 一节。 */ #ifndef __BSP_KEY_HPP__ #define __BSP_KEY_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep (GPIO_TypeDef, GPIO pins, HAL_GPIO_ReadPin) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep (GPIO_TypeDef, GPIO pins, HAL_GPIO_ReadPin) #include -#include "status.hpp" // 统一状态码 +#include "service/system/status_code.hpp" // 统一状态码 /** @@ -129,7 +129,7 @@ class BspKey * @note 专给「按住时要一直亮、松手就灭」这类显示用:事件只在跳变那一刻给一次, * 而本函数每拍都能问到当前状态。未 init() 时返回 false。 */ - bool pressed() const { return _last_stable; } + bool is_pressed() const { return _last_stable; } /* ==================== */ private: diff --git a/code/bsp/bsp_pwm.cpp b/code/bsp/bsp_pwm.cpp index bd974dc..ae0c210 100644 --- a/code/bsp/bsp_pwm.cpp +++ b/code/bsp/bsp_pwm.cpp @@ -1,9 +1,9 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "bsp_pwm.hpp" +#include "bsp/bsp_pwm.hpp" /* ==================== 公共接口 ==================== */ diff --git a/code/bsp/bsp_pwm.hpp b/code/bsp/bsp_pwm.hpp index e07c27f..65e37b7 100644 --- a/code/bsp/bsp_pwm.hpp +++ b/code/bsp/bsp_pwm.hpp @@ -11,7 +11,7 @@ * 定时器时钟、PSC、ARR 全部由使用方从 CubeMX 生成的配置里抄进 Config, * 驱动本身不写死任何硬件常量,换板子只改实例化处的参数。 * - * @note 换算式、计数单位与“同定时器共通道 ARR”的后果见 bsp_pwm.md。 + * @note 换算式见 docs/code/bsp.md 的 BspPwm 一节;“同定时器的通道共用 ARR”的后果见下面的 @warning,计数单位见 get_period_cnt() 的注释。 * * @warning 同一定时器的多个通道共用计数器与 ARR:set_freq() 会同时改变该定时器 * 所有通道的频率。 @@ -23,13 +23,13 @@ #ifndef __BSP_PWM_HPP__ #define __BSP_PWM_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "status.hpp" // 统一状态码 -#include "bsp_series.hpp" // IWYU pragma: keep(TIM_HandleTypeDef / TIM_CHANNEL_x) +#include "service/system/status_code.hpp" // 统一状态码 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(TIM_HandleTypeDef / TIM_CHANNEL_x) #include diff --git a/code/bsp/bsp_series.hpp b/code/bsp/bsp_series.hpp index 6aace3e..883b734 100644 --- a/code/bsp/bsp_series.hpp +++ b/code/bsp/bsp_series.hpp @@ -13,7 +13,7 @@ * 1. 按编译环境选一个系列,include 对应的 HAL 头 * 2. 给 F4 补上 H7 才有、但语义等价的宏/类型,让上层代码一行都不用改 * - * @note H7 侧一个宏都不定义、一个类型都不新增:所有补丁都在 `#if BSP_SERIES_F4` 里, + * @note H7 侧一个宏都不定义、一个类型都不新增:所有补丁都在 `#if ICBSP_SERIES_F4` 里, * H7 编译出来的东西与引入本文件之前完全一致(除了多一层 include guard)。 * * @note 系列判定用 `__has_include`:CubeMX 的 CMake 只把当前系列的 HAL 目录加进 include 路径, @@ -34,16 +34,16 @@ #if __has_include("stm32h7xx_hal.h") # include "stm32h7xx_hal.h" // IWYU pragma: keep(HAL 模块开关) -# define BSP_SERIES_H7 1 -# define BSP_SERIES_F4 0 -# define BSP_SERIES_NAME "STM32H7" +# define ICBSP_SERIES_H7 1 +# define ICBSP_SERIES_F4 0 +# define ICBSP_SERIES_NAME "STM32H7" #elif __has_include("stm32f4xx_hal.h") # include "stm32f4xx_hal.h" // IWYU pragma: keep(HAL 模块开关) -# define BSP_SERIES_H7 0 -# define BSP_SERIES_F4 1 -# define BSP_SERIES_NAME "STM32F4" +# define ICBSP_SERIES_H7 0 +# define ICBSP_SERIES_F4 1 +# define ICBSP_SERIES_NAME "STM32F4" #else @@ -55,7 +55,7 @@ /* ==================== */ /* ==================== ② F4 专属补丁 ==================== */ -#if BSP_SERIES_F4 +#if ICBSP_SERIES_F4 /* ---------- UART 寄存器位名 ---------- * F4 没有硬件 FIFO,寄存器位用的是不带 FIFO 后缀的旧名字,但**位号相同**: @@ -86,7 +86,7 @@ # endif /** @brief 本系列是否有 UART 硬件 FIFO(决定 `huart->FifoMode` / `HAL_UARTEx_EnableFifoMode` 能不能用) */ -# define BSP_UART_HAS_FIFO 0 +# define ICBSP_UART_HAS_FIFO 0 /* ---------- DMA 实例判定 ---------- * bsp_uart.hpp 用它区分「DMA1 / DMA2 的流」与「BDMA 之类」。 @@ -107,9 +107,9 @@ * 上层 service / tasks / device 统一看这一个宏,不再各自判断 HAL 模块名。 */ # ifdef HAL_CAN_MODULE_ENABLED -# define BSP_CAN_MODULE_ENABLED 1 +# define ICBSP_CAN_MODULE_ENABLED 1 # else -# define BSP_CAN_MODULE_ENABLED 0 +# define ICBSP_CAN_MODULE_ENABLED 0 # endif /* ---------- CAN 常量:让上层写法原样成立 ---------- @@ -161,15 +161,15 @@ typedef struct #else /* ==================== H7 ==================== */ /** @brief 本系列是否有 UART 硬件 FIFO */ -# define BSP_UART_HAS_FIFO 1 +# define ICBSP_UART_HAS_FIFO 1 # ifdef HAL_FDCAN_MODULE_ENABLED -# define BSP_CAN_MODULE_ENABLED 1 +# define ICBSP_CAN_MODULE_ENABLED 1 # else -# define BSP_CAN_MODULE_ENABLED 0 +# define ICBSP_CAN_MODULE_ENABLED 0 # endif -#endif /* BSP_SERIES_F4 */ +#endif /* ICBSP_SERIES_F4 */ /* ==================== */ @@ -191,7 +191,7 @@ inline bool dma_reachable(const void *addr) { const uintptr_t a = reinterpret_cast(addr); -#if BSP_SERIES_H7 +#if ICBSP_SERIES_H7 const bool itcm = a < 0x08000000U; const bool dtcm = a >= 0x20000000U && a < 0x24000000U; return !itcm && !dtcm; @@ -218,7 +218,7 @@ inline bool dma_reachable(const void *addr) * - system.cpp 那次「全局构造前拷贝初值」因找不到 __dma_buffer_* 弱符号而自动跳过 * - board_cfg.hpp 里 `inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT<...>` 一处都不用改 */ -#if BSP_SERIES_F4 +#if ICBSP_SERIES_F4 # define ICBSP_DMA_BUFFER(name) /* F4:主 SRAM 可 DMA,不需要专用段 */ #else # define ICBSP_DMA_BUFFER(name) __attribute__((section(".dma_buffer." #name))) diff --git a/code/bsp/bsp_spi.cpp b/code/bsp/bsp_spi.cpp index 11ca874..5f6a93e 100644 --- a/code/bsp/bsp_spi.cpp +++ b/code/bsp/bsp_spi.cpp @@ -1,10 +1,10 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 SPI(HAL_SPI_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_SPI_MODULE_ENABLED # include "board_instances.hpp" -# include "bsp_spi.hpp" +# include "bsp/bsp_spi.hpp" # include @@ -18,7 +18,7 @@ namespace /** * @brief 毫秒 → tick;portMAX_DELAY 原样保留(表示一直等) * - * @note pdMS_TO_TICKS(portMAX_DELAY) 会按 32 位溢出,不再是“一直等”(见 bsp_uart.cpp 同名函数)。 + * @note pdMS_TO_TICKS(portMAX_DELAY) 会按 32 位溢出,不再是“一直等”(与 bsp_uart.hpp 的 uart_detail::ms_to_ticks() 相同,N9)。 */ TickType_t ms_to_ticks(uint32_t ms) { @@ -44,7 +44,7 @@ extern "C" { /** * @brief DMA 全双工传输完成(SPI EOT 中断里由 HAL 调用) - * @note 只处理 BSP_SPI_INSTANCES 清单里的实例,清单外的 SPI 直接忽略。 + * @note 只处理 ICBSP_SPI_INSTANCES 清单里的实例,清单外的 SPI 直接忽略。 */ void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi) { @@ -54,11 +54,11 @@ extern "C" } # define X(name) \ - else if (hspi == name.handle()) \ + else if (hspi == name.get_handle()) \ { \ name.on_txrx_cplt_isr(&xHigherPriorityTaskWoken); \ } - BSP_SPI_INSTANCES(X) + ICBSP_SPI_INSTANCES(X) # undef X else { @@ -77,11 +77,11 @@ extern "C" } # define X(name) \ - else if (hspi == name.handle()) \ + else if (hspi == name.get_handle()) \ { \ name.on_error_isr(&xHigherPriorityTaskWoken); \ } - BSP_SPI_INSTANCES(X) + ICBSP_SPI_INSTANCES(X) # undef X else { @@ -106,6 +106,9 @@ extern "C" bool bsp_spi_is_listed(const void *self, const SPI_HandleTypeDef *hspi) { + // 实例清单为空时 X-macro 展开成空,参数用不到 + (void)self; + (void)hspi; bool listed = false; uint32_t same = 0U; // 清单里绑这个句柄的实例数 # define X(name) \ @@ -113,11 +116,11 @@ bool bsp_spi_is_listed(const void *self, const SPI_HandleTypeDef *hspi) { \ listed = true; \ } \ - if (name.handle() == hspi) \ + if (name.get_handle() == hspi) \ { \ same = same + 1U; \ } - BSP_SPI_INSTANCES(X) + ICBSP_SPI_INSTANCES(X) # undef X return listed && same == 1U; } @@ -188,7 +191,7 @@ Status BspSpi::init() return Status::OK; } -bool BspSpi::is_init() const +bool BspSpi::is_initialized() const { return _init; } @@ -248,7 +251,7 @@ Status BspSpi::transfer_locked(const uint8_t *tx, uint8_t *rx, size_t len, uint3 // 调用方缓冲 DMA 访问不到、必须中转(只计这种,填充 / 丢弃不算) const bool bounced = use_dma && ((tx != nullptr && !tx_direct) || (rx != nullptr && !rx_direct)); // 任一方向用弹跳缓冲,每段就不能超过它 - const size_t max_seg = (tx_direct && rx_direct) ? HAL_MAX_SEGMENT : SPI_DMA_BUFFER_SIZE; + const size_t max_seg = (tx_direct && rx_direct) ? HAL_MAX_SEGMENT : ICBSP_SPI_DMA_BUFFER_SIZE; size_t done = 0U; while (done < len) @@ -356,7 +359,7 @@ void BspSpi::on_error_isr(BaseType_t *pxHigherPriorityTaskWoken) } } -BspSpi::Diag BspSpi::diag() const +BspSpi::Diag BspSpi::get_diag() const { Diag d; d.poll_cnt = _poll_cnt; @@ -380,11 +383,11 @@ BspSpiDevice::BspSpiDevice(BspSpi &bus, const Config &cfg) : _bus(bus), _cs(BspG Status BspSpiDevice::init() { - if (!_bus.is_init()) + if (!_bus.is_initialized()) { return Status::NOT_INIT; } - if (_cs.port() == nullptr || _cs.pin() == 0U) + if (_cs.get_port() == nullptr || _cs.get_pin() == 0U) { return Status::BAD_ARG; } diff --git a/code/bsp/bsp_spi.hpp b/code/bsp/bsp_spi.hpp index 1c0a74d..68b7e1e 100644 --- a/code/bsp/bsp_spi.hpp +++ b/code/bsp/bsp_spi.hpp @@ -51,14 +51,14 @@ * @note 库假定 D-Cache 关闭,DMA 缓冲不做 Cache 维护。 * @note 所有超时参数单位都是毫秒;传 portMAX_DELAY 表示一直等。 * @note 总线锁不按先来后到:互斥量释放时不直接交给等待者,高优先级任务频繁访问同一总线时, - * 低优先级任务可能等锁超过默认的 SPI_TRANSFER_TIMEOUT_MS(实测 4 个任务争用时最低优先级者等过 9.3 ms 后超时)。 + * 低优先级任务可能等锁超过默认的 ICBSP_SPI_TRANSFER_TIMEOUT_MS(实测 4 个任务争用时最低优先级者等过 9.3 ms 后超时)。 * 低优先级的使用者应自己传更长的 timeout_ms(例如 50 ms,或 portMAX_DELAY);默认值按高优先级、周期性访问取值。 */ #ifndef __BSP_SPI_HPP__ #define __BSP_SPI_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 SPI(HAL_SPI_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_SPI_MODULE_ENABLED @@ -69,14 +69,14 @@ #include "FreeRTOS.h" // IWYU pragma: keep #include "semphr.h" // IWYU pragma: keep(总线锁、完成信号量) -#include "bsp_gpio.hpp" // 片选引脚 -#include "bsp_dma_buffer.hpp" // ICBSP_DMA_BUFFER -#include "hardware_config.h" // 唯一配置源(功能开关、队列深度等) -#include "status.hpp" // 统一状态码 +#include "bsp/bsp_gpio.hpp" // 片选引脚 +#include "bsp/bsp_dma_buffer.hpp" // ICBSP_DMA_BUFFER +#include "service/system/config_check.hpp" // 唯一配置源(功能开关、队列深度等) +#include "service/system/status_code.hpp" // 统一状态码 /** - * @brief 实例是否在 board_instances.hpp 的 BSP_SPI_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_spi.cpp) + * @brief 实例是否在 board_instances.hpp 的 ICBSP_SPI_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_spi.cpp) * @note HAL 回调只认清单里的实例:init() 用它把“漏写清单 / 两个实例绑同一句柄”变成 BAD_ARG(对比评估 N13)。 */ bool bsp_spi_is_listed(const void *self, const SPI_HandleTypeDef *hspi); @@ -84,7 +84,7 @@ bool bsp_spi_is_listed(const void *self, const SPI_HandleTypeDef *hspi); /** * @brief 清单外 SPI 的回调转调(弱函数,默认什么也不做;实现在 bsp_spi.cpp) * @note 库占用了 HAL_SPI_TxRxCpltCallback / HAL_SPI_ErrorCallback,宿主不能再定义它们; - * 不在 BSP_SPI_INSTANCES 里的 SPI 的这两个回调转到下面两个函数。 + * 不在 ICBSP_SPI_INSTANCES 里的 SPI 的这两个回调转到下面两个函数。 */ extern "C" { @@ -97,7 +97,7 @@ extern "C" /** * @brief SPI 总线(一路 SPI 外设,主机模式) * - * @note HAL 回调按 board_instances.hpp 里的 BSP_SPI_INSTANCES 清单逐个比对句柄, + * @note HAL 回调按 board_instances.hpp 里的 ICBSP_SPI_INSTANCES 清单逐个比对句柄, * 清单外的 SPI(宿主工程自己管的)直接忽略。 */ class BspSpi @@ -148,16 +148,16 @@ class BspSpi * 运行中重新调用时不能有任务正在使用或等待本总线(旧的锁会被删掉)。 * * @return OK=成功;IO_ERROR=资源创建失败; - * BAD_ARG=句柄为空、实例不在 BSP_SPI_INSTANCES 里或清单里另有实例绑了同一句柄、 + * BAD_ARG=句柄为空、实例不在 ICBSP_SPI_INSTANCES 里或清单里另有实例绑了同一句柄、 * use_dma 却没链接 RX / TX DMA、use_dma 却不在 DMA 可达的内存里(没放进 .dma_buffer) */ Status init(); - /** @brief 中止进行中的传输并释放锁与信号量;之后 is_init() 为 false,传输接口返回 NOT_INIT */ + /** @brief 中止进行中的传输并释放锁与信号量;之后 is_initialized() 为 false,传输接口返回 NOT_INIT */ void deinit(); /** @brief 是否已 init() 成功 */ - bool is_init() const; + bool is_initialized() const; /* ==================== */ /* ==================== 事务接口(多数情况用 BspSpiDevice,不直接调这些) ==================== */ @@ -168,7 +168,7 @@ class BspSpi * @param timeout_ms 最多等多久;portMAX_DELAY 表示一直等 * @return OK=拿到了(调度器启动前直接返回 OK);TIMEOUT=超时(计入 lock_timeout_cnt);NOT_INIT=未 init */ - Status lock(uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status lock(uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** @brief 放总线锁(调度器启动前为空操作) */ void unlock(); @@ -186,9 +186,9 @@ class BspSpi * @note len < dma_threshold、或 use_dma = false、或调度器未启动 → 轮询;否则 DMA。 * @note 两个方向各自决定:DMA 时缓冲在 DMA 可达内存里就直接用(零拷贝),在 DTCM(例如任务栈、默认 .bss) * 就经实例里的弹跳缓冲中转;tx / rx 为空时也用弹跳缓冲(填 0xFF / 收了丢掉)。任一方向用到弹跳缓冲时 - * 按 SPI_DMA_BUFFER_SIZE 分段,片选全程保持,对器件来说是一整帧。 + * 按 ICBSP_SPI_DMA_BUFFER_SIZE 分段,片选全程保持,对器件来说是一整帧。 */ - Status transfer_locked(const uint8_t *tx, uint8_t *rx, size_t len, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status transfer_locked(const uint8_t *tx, uint8_t *rx, size_t len, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /* ==================== */ /* ==================== ISR 入口(HAL 回调按句柄查表后调用) ==================== */ @@ -203,13 +203,13 @@ class BspSpi /* ==================== 查询 ==================== */ /** @brief 绑定的 SPI 句柄 */ - SPI_HandleTypeDef *handle() const + SPI_HandleTypeDef *get_handle() const { return _hspi; } /** @brief 读诊断计数 */ - Diag diag() const; + Diag get_diag() const; /* ==================== */ @@ -242,8 +242,8 @@ class BspSpi volatile uint32_t _error_cnt = 0; ///< 错误次数 volatile uint32_t _lock_timeout_cnt = 0; ///< 等锁超时次数 - uint8_t _tx_bounce[SPI_DMA_BUFFER_SIZE] = {}; ///< DMA 发送弹跳缓冲(也用来放 0xFF 填充) - uint8_t _rx_bounce[SPI_DMA_BUFFER_SIZE] = {}; ///< DMA 接收弹跳缓冲(也用来丢弃收到的字节) + uint8_t _tx_bounce[ICBSP_SPI_DMA_BUFFER_SIZE] = {}; ///< DMA 发送弹跳缓冲(也用来放 0xFF 填充) + uint8_t _rx_bounce[ICBSP_SPI_DMA_BUFFER_SIZE] = {}; ///< DMA 接收弹跳缓冲(也用来丢弃收到的字节) /* ==================== */ }; @@ -306,7 +306,7 @@ class BspSpiDevice * @param timeout_ms 等锁、以及每段等完成的上限 * @return OK;BAD_ARG=len 为 0;NOT_INIT=设备未 init;TIMEOUT=等锁或传输超时;IO_ERROR=HAL 错误 */ - Status transfer(const uint8_t *tx, uint8_t *rx, size_t len, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status transfer(const uint8_t *tx, uint8_t *rx, size_t len, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** * @brief 一次片选内先发 tx_len 字节、再收 rx_len 字节(收的时候发 0xFF) @@ -318,31 +318,31 @@ class BspSpiDevice * @param timeout_ms 同 transfer() * @return 同 transfer();tx / rx 为空或长度为 0 返回 BAD_ARG */ - Status write_then_read(const uint8_t *tx, size_t tx_len, uint8_t *rx, size_t rx_len, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status write_then_read(const uint8_t *tx, size_t tx_len, uint8_t *rx, size_t rx_len, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** * @brief 从 reg 起连读 len 字节(地址置 read_flag,自动跳过 read_dummy 个无效字节) * @return 同 transfer();data 为空或 len 为 0 返回 BAD_ARG */ - Status read_reg(uint8_t reg, uint8_t *data, size_t len, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status read_reg(uint8_t reg, uint8_t *data, size_t len, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** * @brief 从 reg 起连写 len 字节(地址清 read_flag) * @return 同 transfer();data 为空或 len 为 0 返回 BAD_ARG */ - Status write_reg(uint8_t reg, const uint8_t *data, size_t len, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status write_reg(uint8_t reg, const uint8_t *data, size_t len, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** @brief 读 1 个寄存器 */ - Status read_reg8(uint8_t reg, uint8_t &value, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status read_reg8(uint8_t reg, uint8_t &value, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** @brief 写 1 个寄存器 */ - Status write_reg8(uint8_t reg, uint8_t value, uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status write_reg8(uint8_t reg, uint8_t value, uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /* ==================== */ /* ==================== 手动事务用 ==================== */ - /** @brief 所在总线(手动事务:bus().lock() → select() → bus().transfer_locked() … → deselect() → bus().unlock()) */ - BspSpi &bus() const + /** @brief 所在总线(手动事务:get_bus().lock() → select() → get_bus().transfer_locked() … → deselect() → get_bus().unlock()) */ + BspSpi &get_bus() const { return _bus; } diff --git a/code/bsp/bsp_uart.cpp b/code/bsp/bsp_uart.cpp index 89f80ff..aecb4a5 100644 --- a/code/bsp/bsp_uart.cpp +++ b/code/bsp/bsp_uart.cpp @@ -1,10 +1,10 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 UART(HAL_UART_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_UART_MODULE_ENABLED #include "board_instances.hpp" -#include "bsp_uart.hpp" +#include "bsp/bsp_uart.hpp" #include "FreeRTOS.h" // IWYU pragma: keep @@ -13,6 +13,9 @@ bool bsp_uart_is_listed(const void *self, const UART_HandleTypeDef *huart) { + // 实例清单为空时 X-macro 展开成空,参数用不到 + (void)self; + (void)huart; bool listed = false; uint32_t same = 0U; // 清单里绑这个句柄的实例数 #define X(name) \ @@ -20,11 +23,11 @@ bool bsp_uart_is_listed(const void *self, const UART_HandleTypeDef *huart) { \ listed = true; \ } \ - if (name.handle() == huart) \ + if (name.get_handle() == huart) \ { \ same = same + 1U; \ } - BSP_UART_INSTANCES(X) + ICBSP_UART_INSTANCES(X) #undef X return listed && same == 1U; } @@ -32,7 +35,7 @@ bool bsp_uart_is_listed(const void *self, const UART_HandleTypeDef *huart) /* ==================== HAL 回调分发 ==================== */ -// BspUartT 只有头文件,这里只放 HAL 回调:HAL 的回调没有实例参数,按 huart 指针和 BSP_UART_INSTANCES 清单逐个比对。 +// BspUartT 只有头文件,这里只放 HAL 回调:HAL 的回调没有实例参数,按 huart 指针和 ICBSP_UART_INSTANCES 清单逐个比对。 // 清单外的串口(宿主自己用 HAL 管的)直接忽略。 extern "C" { @@ -44,11 +47,11 @@ extern "C" { } #define X(name) \ - else if (huart == name.handle()) \ + else if (huart == name.get_handle()) \ { \ name.on_idle_isr(Size, &woken); \ } - BSP_UART_INSTANCES(X) + ICBSP_UART_INSTANCES(X) #undef X else { @@ -65,11 +68,11 @@ extern "C" { } #define X(name) \ - else if (huart == name.handle()) \ + else if (huart == name.get_handle()) \ { \ name.start_transmission_from_isr(&woken); \ } - BSP_UART_INSTANCES(X) + ICBSP_UART_INSTANCES(X) #undef X else { @@ -85,11 +88,11 @@ extern "C" { } #define X(name) \ - else if (huart == name.handle()) \ + else if (huart == name.get_handle()) \ { \ name.on_error_isr(); \ } - BSP_UART_INSTANCES(X) + ICBSP_UART_INSTANCES(X) #undef X else { diff --git a/code/bsp/bsp_uart.hpp b/code/bsp/bsp_uart.hpp index a477124..0ff047b 100644 --- a/code/bsp/bsp_uart.hpp +++ b/code/bsp/bsp_uart.hpp @@ -9,12 +9,16 @@ * * @details 通用模板 BspUartT,**只有头文件**(任意缓冲尺寸都不用补显式实例化)。 * 流缓冲区、发送状态机、诊断计数与恢复流程共用,底层 DMA / 中断由 Transport 选择; - * HAL 回调按 board_instances.hpp 的 BSP_UART_INSTANCES 分发(bsp_uart.cpp)。 + * HAL 回调按 board_instances.hpp 的 ICBSP_UART_INSTANCES 分发(bsp_uart.cpp)。 * * @note 接收: * - uart_mode::dma:RX DMA 工作在**循环模式**(init() 自动把 hdmarx 改成 Circular + 直接模式)。 * HAL 的 IDLE / 半满(HT)/ 写满(TC)事件都不停 DMA,库按“上次读到的位置 → DMA 当前写到的位置” * 把新字节投进流缓冲区(处理回绕)。IDLE 路径从不调用阻塞版 HAL_DMA_Abort(),没有重新挂接收的空窗。 + * **前提:串口 / RX DMA 中断被挡住(临界区、更高优先级中断)的时间不超过收满半个 RX_SIZE 的时间** + * (RX_SIZE / 2 × 10 / 波特率,例如 128 字节、921600 下约 0.69 ms)。超过时 DMA 可能写满一圈、覆盖还没投递的数据, + * 这种丢失库的诊断计数察觉不到(阶段 3 实测 U19:屏蔽 0.45 圈无损,0.75 / 1.5 圈丢帧且计数为 0)。 + * 高波特率或长临界区的场合加大 RX_SIZE。 * - uart_mode::it:HAL 的 ReceiveToIdle_IT,每次 IDLE / 写满投递一包后立即重新挂接收。 * - 接收流缓冲区容量是 2 × RX_SIZE(给“写满投递 + 紧接着的 IDLE 投递”留余量)。 * - 线路错误(ORE / FE / NE / PE)时 HAL 在 DMA 模式下会中止接收;sys_task 每 10 ms 调 rx_recover() 重建。 @@ -26,14 +30,14 @@ * @note RS485:只支持 UART 硬件 DE(CubeMX 里 UART 选 RS485 模式)。库不提供软件 DE。 * * @warning 已知限制:TX DMA 开着 DMA FIFO(CubeMX 配置)时,DMA 预读进 FIFO 的字节已被剩余计数算作“发出”; - * init() 还会打开 UART 硬件 FIFO(UART_ENABLE_FIFO)。tx_recover() 中止卡死的发送后按剩余计数续发, + * init() 还会打开 UART 硬件 FIFO(ICBSP_UART_ENABLE_FIFO)。tx_recover() 中止卡死的发送后按剩余计数续发, * 这两个 FIFO 里的字节会丢。只影响“卡死后恢复”这条路径,正常发送不受影响。 */ #ifndef __BSP_UART_HPP__ #define __BSP_UART_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 UART(HAL_UART_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_UART_MODULE_ENABLED @@ -43,9 +47,9 @@ #include "stream_buffer.h" #include "task.h" // IWYU pragma: keep -#include "bsp_dma_buffer.hpp" // ICBSP_DMA_BUFFER -#include "hardware_config.h" // UART_ENABLE_FIFO -#include "status.hpp" // 统一状态码 +#include "bsp/bsp_dma_buffer.hpp" // ICBSP_DMA_BUFFER +#include "service/system/config_check.hpp" // ICBSP_UART_ENABLE_FIFO +#include "service/system/status_code.hpp" // 统一状态码 #include #include @@ -500,7 +504,7 @@ struct ItTransport { constexpr uint32_t BYTE_BITS = USART_CR1_RXNEIE_RXFNEIE | USART_CR1_IDLEIE; const bool byte_irq = (huart->Instance->CR1 & BYTE_BITS) == BYTE_BITS; -#if BSP_UART_HAS_FIFO +#if ICBSP_UART_HAS_FIFO if (huart->FifoMode == UART_FIFOMODE_ENABLE) { const bool fifo_irq = ((huart->Instance->CR3 & USART_CR3_RXFTIE) != 0U) && ((huart->Instance->CR1 & USART_CR1_IDLEIE) != 0U); @@ -514,7 +518,7 @@ struct ItTransport /** - * @brief 实例是否在 board_instances.hpp 的 BSP_UART_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_uart.cpp) + * @brief 实例是否在 board_instances.hpp 的 ICBSP_UART_INSTANCES 里,且是清单里唯一绑这个句柄的实例(实现在 bsp_uart.cpp) * @note HAL 回调与 sys_task 巡检只认清单里的实例:不在清单里的实例 init() 成功也收不到回调(对比评估 N13), * 两个实例绑同一个句柄时回调只会交给前一个。init() 用它把这两种配置错误变成 BAD_ARG。 */ @@ -523,7 +527,7 @@ bool bsp_uart_is_listed(const void *self, const UART_HandleTypeDef *huart); /** * @brief 清单外串口的回调转调(弱函数,默认什么也不做;实现在 bsp_uart.cpp) * @note 库占用了 HAL_UARTEx_RxEventCallback / HAL_UART_TxCpltCallback / HAL_UART_ErrorCallback,宿主不能再定义它们。 - * 宿主自己用 HAL 管的串口(不在 BSP_UART_INSTANCES 里)的这三个回调转到下面三个函数,宿主按需定义同名强函数即可。 + * 宿主自己用 HAL 管的串口(不在 ICBSP_UART_INSTANCES 里)的这三个回调转到下面三个函数,宿主按需定义同名强函数即可。 */ extern "C" { @@ -562,7 +566,7 @@ enum class UartDir : uint8_t * * inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1( * {.huart = &huart1, .mode = UartDir::TxRx, .baudrate = 115200U}); - * // board_instances.hpp 的 BSP_UART_INSTANCES 里加 X(bsp_uart1);board_init() 里 ICBSP_CHECK(bsp_uart1.init() == Status::OK); + * // board_instances.hpp 的 ICBSP_UART_INSTANCES 里加 X(bsp_uart1);board_init() 里 ICBSP_CHECK(bsp_uart1.init() == Status::OK); * * bsp_uart1.send(buf, 8); // 写进发送流缓冲区,自动发出去 * bsp_uart1.printf("v=%d\r\n", 42); // 格式化输出(10 ms 入队超时) @@ -577,6 +581,9 @@ class BspUartT public: /* ==================== 公有接口 ==================== */ + static constexpr size_t TX_CAPACITY = TX_SIZE; ///< 单次 send() 的上限(发送暂存区大小),设备层按它定自己的帧缓冲 + static constexpr size_t RX_CAPACITY = RX_SIZE; ///< 接收 DMA 缓冲大小 + /** * @brief 串口配置 * @note 聚合体:可用指定初始化器 `{.huart = &huartX, .mode = ..., .baudrate = ...}`(按声明顺序)。 @@ -619,7 +626,10 @@ class BspUartT uint32_t drop_bytes; ///< 入队失败(缓冲区满或超时)丢掉的字节数 uint32_t start_fail_cnt; ///< 启动发送失败的次数 uint32_t isr_skip_cnt; ///< 中断里发现通道不空闲,跳过续传的次数 - uint32_t stall_recover_cnt; ///< 巡检发现卡死并恢复成功的次数 + uint32_t stall_recover_cnt; ///< 巡检发现卡死并恢复成功的次数(含下面的 idle_kick_cnt) + uint32_t idle_kick_cnt; ///< 其中“通道空闲、却有数据没人启动”、由巡检补发的次数(漏唤醒;正常应为 0) + uint32_t idle_kick_uart_err; ///< 最近一次发现“空闲却有数据”时 huart->ErrorCode 的快照(定位漏唤醒的来源) + uint32_t idle_kick_dma_err; ///< 同上,hdmatx->ErrorCode 的快照(中断收发为 0) uint32_t error_cnt; ///< TX 触发错误回调的次数(最终由 tx_recover() 恢复) uint32_t dma_repair_cnt; ///< tx_recover() 发现 TX DMA 句柄卡在非 READY 并复位的次数 }; @@ -649,7 +659,7 @@ class BspUartT * * @return OK=成功;IO_ERROR=资源创建失败或接收没能启动; * BAD_ARG=句柄为空;DMA 模式下需要的 RX / TX DMA 没配,或实例不在 DMA 可达的内存里(没放进 .dma_buffer); - * 实例不在 BSP_UART_INSTANCES 清单里,或清单里有另一个实例绑了同一个句柄 + * 实例不在 ICBSP_UART_INSTANCES 清单里,或清单里有另一个实例绑了同一个句柄 */ Status init(); @@ -714,7 +724,7 @@ class BspUartT bool rx_recover(); /** @brief 底层 UART 句柄(供 HAL 回调分发) */ - UART_HandleTypeDef *handle() const + UART_HandleTypeDef *get_handle() const { return _huart; } @@ -762,6 +772,7 @@ class BspUartT static constexpr size_t RX_STREAM_SIZE = 2U * RX_SIZE; ///< 接收流缓冲区容量 static constexpr uint32_t PRINTF_TIMEOUT_MS = 10U; ///< printf() 取锁 / 入队的等待上限 + static constexpr uint32_t TX_STALL_MIN_MS = 10U; ///< 发送卡死判定阈值的下限 (ms),= sys_task 巡检周期 UART_HandleTypeDef *_huart; ///< UART 句柄 StreamBufferHandle_t _rx_stream_buffer = nullptr; ///< 接收流缓冲区(写者:接收中断;读者:receive()) @@ -797,6 +808,9 @@ class BspUartT volatile uint32_t _tx_stall_rec_cnt = 0U; volatile uint32_t _tx_error_cnt = 0U; volatile uint32_t _tx_dma_repair_cnt = 0U; + volatile uint32_t _tx_idle_kick_cnt = 0U; + uint32_t _tx_idle_kick_uart_err = 0U; ///< 只有 tx_recover() 写 + uint32_t _tx_idle_kick_dma_err = 0U; ///< 只有 tx_recover() 写 volatile TickType_t _tx_last_activity_tick = 0U; ///< 最近一次发送有推进(启动 / 剩余计数变化 / 串口在移位)的时刻 size_t _tx_last_remaining = 0U; ///< tx_recover() 上次看到的剩余计数(只有 tx_recover() 读写) @@ -807,7 +821,8 @@ class BspUartT volatile size_t _tx_chunk_len = 0U; ///< 这一段的长度;0 = 没有未发完的数据 volatile bool _tx_chunk_active = false; ///< true = 这一段已交给 Transport 在传;false = 启动失败、等待重发 - bool _tx_idle_pending_seen = false; ///< 上次 tx_recover() 是否已看到「通道空闲但有数据」(只有 tx_recover() 读写) + bool _tx_idle_pending_seen = false; ///< 上次 tx_recover() 是否已看到「通道空闲但有数据」(只有 tx_recover() 读写) + TickType_t _tx_idle_seen_activity = 0U; ///< 那次看到时的 _tx_last_activity_tick:之后有过启动就不算“没人启动”(只有 tx_recover() 读写) /* ==================== */ /* ==================== 内部实现 ==================== */ @@ -929,8 +944,8 @@ Status BspUartT::init() // 打开 UART 硬件 FIFO(16 字节)。CubeMX 默认关着,此时接收只有 RDR 一级缓冲:搬运稍晚一点下一个字节就 ORE。 // 2026-10-17 实测:不开 FIFO 时连续流在 2 Mbps 以上几乎全丢,开了之后 4 Mbps 也基本无损。 // 代价:tx_recover() 中止发送时会清掉 TX FIFO 里最多 16 字节(只在卡死恢复路径上)。 - // F4 没有硬件 FIFO(BSP_UART_HAS_FIFO = 0),也没有 HAL_UARTEx_EnableFifoMode(),整段不编译。 -#if UART_ENABLE_FIFO && BSP_UART_HAS_FIFO + // F4 没有硬件 FIFO(ICBSP_UART_HAS_FIFO = 0),也没有 HAL_UARTEx_EnableFifoMode(),整段不编译。 +#if ICBSP_UART_ENABLE_FIFO && ICBSP_UART_HAS_FIFO (void)HAL_UARTEx_EnableFifoMode(_huart); #endif @@ -1065,8 +1080,10 @@ bool BspUartT::tx_recover() return false; } - // 卡死判定阈值 (ms) = 一包发送耗时的 2 倍(向上取整):TX_SIZE × 10 bit ÷ 波特率 × 1000 × 2 - const uint32_t stall_ms = static_cast((static_cast(TX_SIZE) * 20000U + baud - 1U) / baud); + // 卡死判定阈值 (ms) = 一包发送耗时的 2 倍(向上取整):TX_SIZE × 10 bit ÷ 波特率 × 1000 × 2, + // 下限是巡检周期 TX_STALL_MIN_MS(Q5):tick 只有 1 ms 分辨率,阈值 1~2 ms 时刚开始的一次传输就可能被判成卡死并中止 + const uint32_t pack_ms = static_cast((static_cast(TX_SIZE) * 20000U + baud - 1U) / baud); + const uint32_t stall_ms = (pack_ms < TX_STALL_MIN_MS) ? TX_STALL_MIN_MS : pack_ms; if (xStreamBufferBytesAvailable(_tx_stream_buffer) == 0U && _tx_chunk_len == 0U) { @@ -1083,8 +1100,10 @@ bool BspUartT::tx_recover() bool restarted = false; if (_huart->gState == HAL_UART_STATE_READY) { - // ① 通道空闲却有数据:第一次只记下,下一次仍是这样才重新启动 - if (_tx_idle_pending_seen) + // ① 通道空闲却有数据:第一次只记下,下一次仍是这样、并且这期间没有任何一次启动,才重新启动。 + // 只看“两次都空闲且有数据”会误报:写者在“写进流缓冲区 → 拿 _tx_lock 启动”之间被本巡检抢占时也是这个样子, + // 短段连续发送时相隔 10 ms 的两次巡检都可能落进这个窗口(阶段 3 U21 实测,数据都是写者自己随后发出的) + if (_tx_idle_pending_seen && _tx_last_activity_tick == _tx_idle_seen_activity) { if (Transport::repair_tx(_huart)) { @@ -1092,10 +1111,17 @@ bool BspUartT::tx_recover() } restarted = start_chunk(false, nullptr); _tx_idle_pending_seen = false; + if (restarted) + { + _tx_idle_kick_cnt = _tx_idle_kick_cnt + 1U; + } } else { - _tx_idle_pending_seen = true; + _tx_idle_pending_seen = true; + _tx_idle_seen_activity = _tx_last_activity_tick; + _tx_idle_kick_uart_err = _huart->ErrorCode; + _tx_idle_kick_dma_err = (_huart->hdmatx != nullptr) ? _huart->hdmatx->ErrorCode : 0U; } } else @@ -1106,7 +1132,7 @@ bool BspUartT::tx_recover() // 只看计数不够:一段末尾计数已是 0、UART / DMA FIFO 里的字节还在发,相邻两次巡检都落在段尾会误判(实测)。 // 真卡死时两条都不成立:DMAT 被清 → 计数不动、移位完后 TC 置位;完成中断丢失 → 计数 0 且 TC 已置位。 const size_t remaining = Transport::tx_remaining(_huart); -#if BSP_SERIES_F4 +#if ICBSP_SERIES_F4 // F4:状态寄存器是 SR,TC 位宏是 USART_SR_TC const bool shifting = (_huart->Instance->SR & USART_SR_TC) == 0U; #else @@ -1335,6 +1361,9 @@ typename BspUartT::TxDiag BspUartT::arm_reception() } // 先清掉残留的 UART 错误标志:否则 HAL 会因为“启动前已有挂起的 ORE / FE / NE”拒绝启动 -#if BSP_SERIES_F4 +#if ICBSP_SERIES_F4 // F4 没有 ICR / UART_CLEAR_xxx:错误标志靠「先读 SR 再读 DR」清除 __HAL_UART_CLEAR_PEFLAG(_huart); __HAL_UART_CLEAR_FEFLAG(_huart); diff --git a/code/device/device_buzzer.cpp b/code/device/actuator/device_buzzer.cpp similarity index 93% rename from code/device/device_buzzer.cpp rename to code/device/actuator/device_buzzer.cpp index 6b2b09e..5dc5afc 100644 --- a/code/device/device_buzzer.cpp +++ b/code/device/actuator/device_buzzer.cpp @@ -1,10 +1,10 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_TIM_MODULE_ENABLED #include "FreeRTOS.h" // IWYU pragma: keep (vTaskDelay) -#include "device_buzzer.hpp" +#include "device/actuator/device_buzzer.hpp" #include "task.h" // IWYU pragma: keep (pdMS_TO_TICKS) diff --git a/code/device/device_buzzer.hpp b/code/device/actuator/device_buzzer.hpp similarity index 95% rename from code/device/device_buzzer.hpp rename to code/device/actuator/device_buzzer.hpp index 870da0f..4224fd2 100644 --- a/code/device/device_buzzer.hpp +++ b/code/device/actuator/device_buzzer.hpp @@ -17,12 +17,12 @@ #ifndef __DEVICE_BUZZER_HPP__ #define __DEVICE_BUZZER_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "bsp_pwm.hpp" // 被驱动的 PWM 通道 +#include "bsp/bsp_pwm.hpp" // 被驱动的 PWM 通道 #include diff --git a/code/device/device_servo.cpp b/code/device/actuator/device_servo.cpp similarity index 98% rename from code/device/device_servo.cpp rename to code/device/actuator/device_servo.cpp index da2bcd9..0bb7d85 100644 --- a/code/device/device_servo.cpp +++ b/code/device/actuator/device_servo.cpp @@ -1,9 +1,9 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "device_servo.hpp" +#include "device/actuator/device_servo.hpp" #include "FreeRTOS.h" // IWYU pragma: keep (configTICK_RATE_HZ) #include "task.h" // xTaskGetTickCount diff --git a/code/device/device_servo.hpp b/code/device/actuator/device_servo.hpp similarity index 97% rename from code/device/device_servo.hpp rename to code/device/actuator/device_servo.hpp index 0993063..c677fd8 100644 --- a/code/device/device_servo.hpp +++ b/code/device/actuator/device_servo.hpp @@ -25,7 +25,7 @@ * * @note 单写者模型:update() 是唯一的 PWM 写入者;set_pulse_us() 须与它同任务; * set_angle() / off() 只写两个 32 位变量,可从任意任务调用(成立前提:Cortex-M7 单核、 - * 32 位对齐读写是单条指令、D-Cache 未开)。接口分工与规划算法见 device_servo.md。 + * 32 位对齐读写是单条指令、D-Cache 未开)。用法见 docs/code/device.md 的 actuator/ 一节,规划算法见 update() 的注释。 * * @warning 每条 PWM 通道只由本类一个实例驱动;同一定时器的通道共用 ARR,本类不改频率。 * @warning 开环器件没有位置反馈:写出去的是"希望它到哪",不是"它真的在哪"。所以需要自己观测是否到达给延时 @@ -35,13 +35,13 @@ #ifndef __DEVICE_SERVO_HPP__ #define __DEVICE_SERVO_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "bsp_pwm.hpp" // 被驱动的 PWM 通道 -#include "status.hpp" +#include "bsp/bsp_pwm.hpp" // 被驱动的 PWM 通道 +#include "service/system/status.hpp" #include #include diff --git a/code/device/device_emmv5_group.hpp b/code/device/motor/device_emmv5_group.hpp similarity index 87% rename from code/device/device_emmv5_group.hpp rename to code/device/motor/device_emmv5_group.hpp index bcfb953..c9c90a3 100644 --- a/code/device/device_emmv5_group.hpp +++ b/code/device/motor/device_emmv5_group.hpp @@ -9,7 +9,7 @@ * * @note 一个实例 = 一路串口 + 若干个电机地址:按地址分发接收、把多条子命令攒成 * MMCL 总帧一次发出、汇总到位位图 / 位置 / 状态、维护每台电机的在线节点。 - * 扫描器与超时模型、MMCL 容量算术、线程与总线锁约束见 `device_emmv5_group.md`。 + * 用法、扫描器与总线锁约束见 docs/code/device.md 的 DeviceEmmv5GroupT 一节;MMCL 容量见下面 UART_BUFFER_SIZE / 子命令上限的注释。 * * @note **本类不创建任务**:字节搬运靠外部任务周期调 `update()`(建议 10 ms), * 与 `bsp_can` / `device_r9ds` / `dji_motor` 保持一致。 @@ -21,15 +21,17 @@ #ifndef __DEVICE_EMMV5_GROUP_HPP__ #define __DEVICE_EMMV5_GROUP_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 UART(HAL_UART_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_UART_MODULE_ENABLED -#include "bsp_uart.hpp" -#include "emmv5_protocol.hpp" -#include "online_check.hpp" -#include "status.hpp" +#include "bsp/bsp_uart.hpp" +#include "device/motor/emmv5_protocol.hpp" +#include "service/monitor/online_check.hpp" +#include "service/system/state_tree.hpp" // bus_state():默认树的总线节点 +#include "service/system/status.hpp" +#include "service/system/system.hpp" // sys_state #include "FreeRTOS.h" // IWYU pragma: keep #include "semphr.h" // IWYU pragma: keep(总线互斥锁) @@ -52,13 +54,15 @@ class DeviceEmmv5GroupT private: /* ==================== 内部常量 ==================== */ - static constexpr size_t UART_BUFFER_SIZE = 128U; ///< 与 board_cfg.cpp 的 DMA 串口发送缓冲区一致 + static constexpr size_t UART_BUFFER_SIZE = Uart::TX_CAPACITY; ///< 跟随串口实例的发送缓冲(BspUartT 的 TX_SIZE;原来写死 128) static constexpr size_t MAX_MOTORS = 8U; ///< 组内最大电机数 static constexpr uint16_t ONLINE_TIMEOUT_MS = 100U; ///< 超过 100 ms 无有效应答判离线 ///< 单帧入队等待上限:921600 下 13 B ≈ 0.14 ms,20 ms 足够;缓冲卡死时返回 TIMEOUT,不无限挂住调用任务 static constexpr uint32_t TX_TIMEOUT_MS = 20U; + static_assert(UART_BUFFER_SIZE > emmv5::MULTI_OVERHEAD + 13U, "DeviceEmmv5GroupT:串口发送缓冲太小,放不下一条 MMCL 总帧"); + ///< MMCL 子命令总字节上限:整帧不能超过串口发送缓冲 static constexpr size_t MULTI_PAYLOAD_MAX = UART_BUFFER_SIZE - emmv5::MULTI_OVERHEAD; @@ -76,8 +80,9 @@ class DeviceEmmv5GroupT */ struct Config { - Uart &uart; ///< bsp_uart 实例引用 - uint8_t addr[MAX_MOTORS] = {}; ///< 地址表(1~255,0 = 结尾) + Uart &uart; ///< bsp_uart 实例引用 + uint8_t addr[MAX_MOTORS] = {}; ///< 地址表(1~255,0 = 结尾) + emmv5::Checksum checksum = emmv5::Checksum::FIXED_6B; ///< 校验方式,必须和驱动器菜单 Checksum 一致(XOR 未实测,见 emmv5_protocol.hpp) }; /* ==================== */ @@ -154,7 +159,7 @@ class DeviceEmmv5GroupT Status set_position(uint8_t addr, emmv5::Direction dir, uint16_t rpm, uint8_t accel, int32_t pulses, emmv5::PositionMode mode); ///< 取最近一次 MMCL 总帧的字节(调试用;未发送过时长度 0) - const uint8_t *last_multi_frame(size_t &len) const; + const uint8_t *get_last_multi_frame(size_t &len) const; ///< 设置快速位置模式的运动参数 Status set_quick_position_params(uint8_t addr, uint16_t rpm, uint8_t accel, emmv5::PositionMode mode); @@ -231,14 +236,14 @@ class DeviceEmmv5GroupT * @brief 取走累计的到位位图并清零 * @return bit i = 下标 i 的电机自上次取走后至少到位过一次 */ - uint32_t get_in_position(); + uint32_t take_in_position(); /** * @brief 查询某个电机是否累计到位(不清零) * @param index 下标(0 ~ count()-1,顺序与 Config 里的地址表一致) - * @return true=自上次 get_in_position() 后至少到位过一次 + * @return true=自上次 take_in_position() 后至少到位过一次 */ - bool in_position(size_t index) const; + bool is_in_position(size_t index) const; /** * @brief 取走某台电机最近一次 0x36 位置 @@ -248,7 +253,7 @@ class DeviceEmmv5GroupT * * @note 读后清有效标志;数值与标志在短临界区内一起拷贝,允许在其他任务调用。 */ - bool get_position(uint8_t addr, int32_t &out); + bool take_position(uint8_t addr, int32_t &out); /** * @brief 取走某台电机最近一次 0x3A 状态字节 @@ -256,7 +261,7 @@ class DeviceEmmv5GroupT * @param out 状态字节(位定义见说明书 6.3.4) * @return true=有新数据;false=没有新数据或地址不在组内 */ - bool get_status(uint8_t addr, uint8_t &out); + bool take_status(uint8_t addr, uint8_t &out); /** * @brief 某台电机最近 100 ms 内是否收到过有效应答 @@ -267,6 +272,12 @@ class DeviceEmmv5GroupT */ bool is_online(uint8_t addr) const; + /** + * @brief 本组在 EventState 默认树里的节点(第三层,挂在所用串口的总线节点下) + * @return `is_running()` = init() 成功;`get_error_bits()` 里的 TIMEOUT = 有电机掉过线(粘滞) + */ + const EventState &get_state() const { return _state; } + /** * @brief 把串口里攒的字节读完并分发给组内电机 * @param timeout_ms 首块等待时间:0 = 非阻塞,N = 最多等 N ms(超时即返回) @@ -355,6 +366,9 @@ class DeviceEmmv5GroupT SemaphoreHandle_t _bus_lock = nullptr; ///< 半双工总线递归锁;init() 创建 + emmv5::Checksum _checksum = emmv5::Checksum::FIXED_6B; ///< 校验方式(Config::checksum) + EventState _state; ///< 本组在默认树里的节点(挂在所用串口的总线节点下,Q6) + /* ==================== */ }; @@ -369,7 +383,7 @@ class DeviceEmmv5GroupT /** @brief 只保存串口引用与地址表,地址个数由地址表的 0 结尾推导 */ template -DeviceEmmv5GroupT::DeviceEmmv5GroupT(const Config &cfg) : _uart(cfg.uart) +DeviceEmmv5GroupT::DeviceEmmv5GroupT(const Config &cfg) : _uart(cfg.uart), _checksum(cfg.checksum) { // 只把地址表拷进来;重复 / 为 0 的地址交给 init() 拒绝, // 总线锁也放到 init() 里建(构造函数里不碰 FreeRTOS API)。 @@ -390,8 +404,16 @@ DeviceEmmv5GroupT::DeviceEmmv5GroupT(const Config &cfg) : _uart(cfg.uart) template Status DeviceEmmv5GroupT::init() { + // 默认树第三层(Q6):节点挂在所用串口的总线节点下(串口不在清单里时挂 sys_state);重复调用无害 + if (_state.init() == Status::OK) + { + EventState *bus = bus_state(&_uart); + (void)_state.set_parent((bus != nullptr) ? *bus : sys_state); + } + if (_count == 0) { + (void)_state.init_error(Status::BAD_ARG); return Status::BAD_ARG; } @@ -400,6 +422,7 @@ Status DeviceEmmv5GroupT::init() { if (_motor[i].addr == 0) { + (void)_state.init_error(Status::BAD_ARG); return Status::BAD_ARG; } @@ -407,6 +430,7 @@ Status DeviceEmmv5GroupT::init() { if (_motor[j].addr == _motor[i].addr) { + (void)_state.init_error(Status::BAD_ARG); return Status::BAD_ARG; } } @@ -423,10 +447,20 @@ Status DeviceEmmv5GroupT::init() if (_bus_lock == nullptr) { + (void)_state.init_error(Status::FULL); return Status::FULL; // 堆不够 } } + for (size_t i = 0; i < _count; i++) + { + _motor[i].inpos_scanner.checksum = _checksum; + _motor[i].position_scanner.checksum = _checksum; + _motor[i].status_scanner.checksum = _checksum; + _motor[i].online.set_state(&_state); // 任意一台由在线变离线:本组节点记 TIMEOUT + } + (void)_state.complete_init(); + _ready = true; return Status::OK; @@ -483,7 +517,7 @@ Status DeviceEmmv5GroupT::lock_bus(uint32_t timeout_ms) } // timeout_ms = 0 相当于 try-lock;递归锁让同一任务可以层层嵌套而不会自锁 - if (xSemaphoreTakeRecursive(_bus_lock, pdMS_TO_TICKS(timeout_ms)) != pdTRUE) + if (xSemaphoreTakeRecursive(_bus_lock, uart_detail::ms_to_ticks(timeout_ms)) != pdTRUE) // portMAX_DELAY 原样保留(N33 / N9) { return Status::TIMEOUT; } @@ -511,7 +545,7 @@ Status DeviceEmmv5GroupT::_send_for(uint8_t addr, const emmv5::Frame &fram return Status::NOT_INIT; } - if (!_is_member(addr) || !frame.valid()) + if (!_is_member(addr) || !frame.is_valid()) { // frame 有效性由协议层保证:未封口 / 已溢出 / 空帧一律不发,避免把截断帧送上总线 return Status::BAD_ARG; @@ -524,8 +558,10 @@ Status DeviceEmmv5GroupT::_send_for(uint8_t addr, const emmv5::Frame &fram return ls; } - // 短帧入队:正常几 ms 内就排空,卡死时靠 TX_TIMEOUT_MS 退出 - const Status status = _uart.send(frame.data, frame.size, pdMS_TO_TICKS(TX_TIMEOUT_MS), nullptr); + // 按配置的校验方式封口;短帧入队:正常几 ms 内就排空,卡死时靠 TX_TIMEOUT_MS 退出(send() 收的就是毫秒,N33) + emmv5::Frame out = frame; + out.apply_checksum(_checksum); + const Status status = _uart.send(out.data, out.size, TX_TIMEOUT_MS, nullptr); unlock_bus(); return status; @@ -540,7 +576,7 @@ Status DeviceEmmv5GroupT::_queue_for(uint8_t addr, const emmv5::Frame &fra return Status::NOT_INIT; } - if (!_is_member(addr) || !frame.valid()) + if (!_is_member(addr) || !frame.is_valid()) { // 截断帧不能攒进总帧:否则整帧 MMCL 会带着半条子命令发出去 return Status::BAD_ARG; @@ -559,7 +595,10 @@ Status DeviceEmmv5GroupT::_queue_for(uint8_t addr, const emmv5::Frame &fra return ls; } + // 子命令各自带校验字节(按配置的方式) memcpy(_multi + emmv5::MULTI_PREFIX_SIZE + _multi_payload, frame.data, frame.size); + _multi[emmv5::MULTI_PREFIX_SIZE + _multi_payload + frame.size - 1U] = + emmv5::checksum_of(_multi + emmv5::MULTI_PREFIX_SIZE + _multi_payload, frame.size - 1U, _checksum); _multi_payload += frame.size; unlock_bus(); @@ -636,8 +675,9 @@ Status DeviceEmmv5GroupT::stop_all() return Status::NOT_INIT; } - const emmv5::Frame frame = emmv5::stop(emmv5::BROADCAST); - if (!frame.valid()) + emmv5::Frame frame = emmv5::stop(emmv5::BROADCAST); + frame.apply_checksum(_checksum); + if (!frame.is_valid()) { return Status::BAD_ARG; } @@ -648,7 +688,7 @@ Status DeviceEmmv5GroupT::stop_all() return ls; } - const Status status = _uart.send(frame.data, frame.size, pdMS_TO_TICKS(TX_TIMEOUT_MS), nullptr); + const Status status = _uart.send(frame.data, frame.size, TX_TIMEOUT_MS, nullptr); unlock_bus(); return status; @@ -707,7 +747,7 @@ Status DeviceEmmv5GroupT::request_status(uint8_t addr) /** @brief 取最近一次发出的 MMCL 字节(诊断用,长度写入 len) */ template -const uint8_t *DeviceEmmv5GroupT::last_multi_frame(size_t &len) const +const uint8_t *DeviceEmmv5GroupT::get_last_multi_frame(size_t &len) const { len = _last_frame_len; return _last_frame; @@ -739,7 +779,7 @@ Status DeviceEmmv5GroupT::multi_send(uint8_t target) return Status::OK; } - const size_t total = emmv5::build_multi_frame(target, _multi + emmv5::MULTI_PREFIX_SIZE, _multi_payload, _multi, sizeof(_multi)); + const size_t total = emmv5::build_multi_frame(target, _multi + emmv5::MULTI_PREFIX_SIZE, _multi_payload, _multi, sizeof(_multi), _checksum); if (total == 0) { return Status::BAD_ARG; // 理论上不会发生:_queue_for 已经保证整帧放得下 @@ -752,7 +792,7 @@ Status DeviceEmmv5GroupT::multi_send(uint8_t target) return ls; } - const Status status = _uart.send(_multi, total, pdMS_TO_TICKS(TX_TIMEOUT_MS), nullptr); + const Status status = _uart.send(_multi, total, TX_TIMEOUT_MS, nullptr); // 记下实际发出的字节,供控制台 dump 对账 _last_frame_len = (total < sizeof(_last_frame)) ? total : sizeof(_last_frame); @@ -909,7 +949,7 @@ uint32_t DeviceEmmv5GroupT::feed_rx(const uint8_t *data, size_t size) /** @brief 取走一台最近一次的 0x36 位置(读后清标志) */ template -bool DeviceEmmv5GroupT::get_position(uint8_t addr, int32_t &out) +bool DeviceEmmv5GroupT::take_position(uint8_t addr, int32_t &out) { if (!_ready) { @@ -938,7 +978,7 @@ bool DeviceEmmv5GroupT::get_position(uint8_t addr, int32_t &out) /** @brief 取走一台最近一次的 0x3A 状态(读后清标志) */ template -bool DeviceEmmv5GroupT::get_status(uint8_t addr, uint8_t &out) +bool DeviceEmmv5GroupT::take_status(uint8_t addr, uint8_t &out) { if (!_ready) { @@ -982,7 +1022,7 @@ bool DeviceEmmv5GroupT::is_online(uint8_t addr) const // 计时由 sys_task 里的 Online::update() 推进,这里只查锁存结果; // 所以本类不建任务,但要求调用方的刷新周期小于 ONLINE_TIMEOUT_MS。 - return _motor[index].online.is_online() == Status::OK; + return _motor[index].online.is_online(); } /** @brief 锁存位置并置有效标志(短临界区) */ @@ -1032,9 +1072,9 @@ bool DeviceEmmv5GroupT::_valid_direction(emmv5::Direction dir) /** @brief 只查该台的累计到位标志,不清零 */ template -bool DeviceEmmv5GroupT::in_position(size_t index) const +bool DeviceEmmv5GroupT::is_in_position(size_t index) const { - // 只查询不清零:给“看看这台到没到”用,不影响 get_in_position() 的位图 + // 只查询不清零:给“看看这台到没到”用,不影响 take_in_position() 的位图 if (!_ready || index >= _count) { return false; @@ -1048,7 +1088,7 @@ bool DeviceEmmv5GroupT::in_position(size_t index) const /** @brief 取走累计到位位图并清零 */ template -uint32_t DeviceEmmv5GroupT::get_in_position() +uint32_t DeviceEmmv5GroupT::take_in_position() { if (!_ready) { diff --git a/code/device/device_motor.cpp b/code/device/motor/device_motor.cpp similarity index 96% rename from code/device/device_motor.cpp rename to code/device/motor/device_motor.cpp index 46f38b2..e5e35a9 100644 --- a/code/device/device_motor.cpp +++ b/code/device/motor/device_motor.cpp @@ -1,9 +1,9 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "device_motor.hpp" +#include "device/motor/device_motor.hpp" #include @@ -42,7 +42,7 @@ Status DeviceMotor::init() return Status::BAD_ARG; // 编码器必须已在 board_init() 里启动过,否则 read_delta() 恒为 0、闭环会一路积分到限幅 - if (!_config.encoder->initialized()) + if (!_config.encoder->is_initialized()) return Status::NOT_INIT; // 输出轴每转计数 = 线数 × 倍频 × 减速比;每转行程 = π × 直径 @@ -155,7 +155,7 @@ bool DeviceMotor::update(float dt_s) } /** @brief JustFloat 组帧:按 fields 选择 1~3 个 PID 量,帧尾固定 00 00 80 7F */ -size_t DeviceMotor::pid_frame(uint8_t *buf, uint8_t fields) const +size_t DeviceMotor::get_pid_frame(uint8_t *buf, uint8_t fields) const { fields &= PID_ALL; if (buf == nullptr || fields == 0U) diff --git a/code/device/device_motor.hpp b/code/device/motor/device_motor.hpp similarity index 90% rename from code/device/device_motor.hpp rename to code/device/motor/device_motor.hpp index 6b1128d..3041bb4 100644 --- a/code/device/device_motor.hpp +++ b/code/device/motor/device_motor.hpp @@ -26,15 +26,15 @@ #ifndef __DEVICE_MOTOR_HPP__ #define __DEVICE_MOTOR_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 TIM(HAL_TIM_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_TIM_MODULE_ENABLED -#include "bsp_encoder.hpp" // 测速反馈 -#include "bsp_pwm.hpp" // H 桥两路输出 -#include "pid.hpp" // 速度环 -#include "status.hpp" // 统一状态码 +#include "bsp/bsp_encoder.hpp" // 测速反馈 +#include "bsp/bsp_pwm.hpp" // H 桥两路输出 +#include "algorithm/pid.hpp" // 速度环 +#include "service/system/status.hpp" // 统一状态码 #include #include @@ -43,7 +43,7 @@ * @brief 电机设备类 * * @note 生命周期:init() 一次 → 每拍 update(dt_s);init() 前 update() 安全返回 false。 - * @note 不绑定串口:JustFloat 帧由 pid_frame() 组好交给调用方,发送在 App 层做。 + * @note 不绑定串口:JustFloat 帧由 get_pid_frame() 组好交给调用方,发送在 App 层做。 */ class DeviceMotor { @@ -155,7 +155,7 @@ class DeviceMotor * * @note 帧尾固定 00 00 80 7F;本函数只组帧,发送由调用方负责。 */ - size_t pid_frame(uint8_t *buf, uint8_t fields = PID_ALL) const; + size_t get_pid_frame(uint8_t *buf, uint8_t fields = PID_ALL) const; /* ==================== */ /* ==================== 查询 ==================== */ @@ -164,22 +164,22 @@ class DeviceMotor bool is_bound() const { return _config.pwm_a != nullptr && _config.pwm_b != nullptr && _config.encoder != nullptr; } /** @brief 是否已成功 init() */ - bool initialized() const { return _initialized; } + bool is_initialized() const { return _initialized; } /** @brief 换算结果:每厘米多少个计数(由机械参数算出) */ - float counts_per_cm() const { return _counts_per_cm; } + float get_counts_per_cm() const { return _counts_per_cm; } /** @brief 最近一拍实测速度 (cm/s) */ - float speed_cm_s() const { return _speed_cm_s; } + float get_speed_cm_s() const { return _speed_cm_s; } /** @brief 最近一拍占空比(带符号,%):正 = pwm_a 出力,负 = pwm_b 出力 */ - float output_pct() const { return _output_pct; } + float get_output_pct() const { return _output_pct; } /** @brief 当前模式 */ - Mode mode() const { return _mode; } + Mode get_mode() const { return _mode; } /** @brief 当前目标速度 (cm/s) */ - float target_cm_s() const { return _target_cm_s; } + float get_target_cm_s() const { return _target_cm_s; } /* ==================== */ private: diff --git a/code/device/dji_motor.hpp b/code/device/motor/dji_motor.hpp similarity index 73% rename from code/device/dji_motor.hpp rename to code/device/motor/dji_motor.hpp index 952092c..8253237 100644 --- a/code/device/dji_motor.hpp +++ b/code/device/motor/dji_motor.hpp @@ -12,27 +12,33 @@ #ifndef __DJI_MOTOR_HPP__ #define __DJI_MOTOR_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" // taskENTER_CRITICAL(snapshot / DataUnpack 写回) -#include "hardware_config.h" +#include "service/system/config_check.hpp" // 宿主配置(经检查) // DjiMotor 同时依赖 CAN 接收和发送路径 -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_RX_ENABLE && CAN_TX_ENABLE +// 依赖(Q4):CubeMX 开了 CAN、却关了收发任一路径时,用到 DjiMotor 就直接报错,而不是静默变成空头文件 +#if defined(HAL_FDCAN_MODULE_ENABLED) && !(ICBSP_CAN_RX_ENABLE && ICBSP_CAN_TX_ENABLE) +# error "DjiMotor 需要 CAN 收发都开:hardware_config.h 里 ICBSP_CAN_RX_ENABLE 与 ICBSP_CAN_TX_ENABLE 都要为 1" +#endif -#include "bsp_can.hpp" -#include "motor_definition.hpp" -#include "online_check.hpp" -#include "can_tx_node.hpp" -#include "can_rx_node.hpp" +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_RX_ENABLE && ICBSP_CAN_TX_ENABLE + +#include "bsp/bsp_can.hpp" +#include "service/definition/motor_definition.hpp" +#include "service/monitor/online_check.hpp" +#include "service/comm/can_tx_node.hpp" +#include "service/comm/can_rx_node.hpp" #include -#include "system.hpp" +#include "service/system/state_tree.hpp" // bus_state():默认树的总线节点 +#include "service/system/system.hpp" #include #include #include -/** @todo 将以下临时协议常量迁移到按 MotorType 特化的 traits,随后删除宏。 */ +/** @todo 将以下临时协议常量迁移到按 DjiMotorType 特化的 traits,随后删除宏。 */ // #define K_ECD_TO_ANGLE 0.043945f ///< 编码器计数到机械角度的临时换算系数,单位:度/count // #define ECD_RANGE_FOR_3508 8191 ///< M3508 编码器原始值上限(包含 0,共 8192 个计数) // #define CURRENT_LIMIT_FOR_3508 16000 ///< M3508/C620 软件限制使用的原始电流指令绝对值 @@ -47,11 +53,11 @@ * * @note 电机型号用于选择反馈格式、合法 ID 范围、控制帧 ID、槽位和默认减速比。 */ -enum MotorType +enum class DjiMotorType : uint8_t { - Motor3508 = 0x00U, ///< M3508 电机配合 C620 电调 - Motor6020 = 0x01U, ///< GM6020 电机 - Motor2006 = 0x02U, ///< M2006 电机配合 C610 电调 + M3508 = 0x00U, ///< M3508 电机配合 C620 电调 + GM6020 = 0x01U, ///< GM6020 电机 + M2006 = 0x02U, ///< M2006 电机配合 C610 电调 }; /** @@ -85,7 +91,7 @@ struct DjiMotorParam uint16_t current_limit; ///< 原始控制指令允许的绝对值上限 }; -template +template class DjiMotor; /** @@ -96,7 +102,7 @@ class DjiMotor; * @details CanTxNode 聚合发送槽位,CanRxNode 按总线和反馈 ID 分发接收帧。 * @note 对象不可复制或移动,以保证在线检查节点和控制帧槽位的身份稳定。 */ -template +template class DjiMotor { private: @@ -104,6 +110,7 @@ class DjiMotor DjiMotorRawData _raw_data; ///< DJI 电调反馈协议原始数据 DjiMotorParam _param; ///< DJI 编码器和原始控制限幅参数 Online _online; ///< 由有效反馈帧刷新的在线检查对象 + EventState _state; ///< 本电机在默认树里的节点(挂在所用 CAN 的总线节点下,Q6) LuenbergerMotorData _lvbo_data; ///< 可选的 Luenberger 观测结果 CanT *_can_item; ///< 接收反馈所用的物理 CAN @@ -126,7 +133,7 @@ class DjiMotor * @return 内部 MotorData 的常量引用。 * @warning 返回实时引用而非快照:can_rx_task 随时可能在改它,跨任务读请用 snapshot()。 */ - const MotorData &data(void) const; + const MotorData &get_data(void) const; /** * @brief 拷贝一份同一帧的反馈(临界区内拷贝,跨任务读用它,F5) @@ -140,34 +147,40 @@ class DjiMotor * @return 内部 DjiMotorRawData 的常量引用。 * @warning 返回实时引用而非快照;跨任务读请用 snapshot()。 */ - const DjiMotorRawData &raw_data(void) const; + const DjiMotorRawData &get_raw_data(void) const; /** * @brief 获取 DJI 编码器和原始控制限幅参数 * @return 内部 DjiMotorParam 的常量引用,构造完成后不再修改。 */ - const DjiMotorParam ¶m(void) const; + const DjiMotorParam &get_param(void) const; /** * @brief 获取本电机的在线检查对象 - * @return Online 的常量引用,可用于调用 isOnline() 查询状态。 + * @return Online 的常量引用,可用于调用 is_online() 查询状态。 + */ + const Online &get_online(void) const; + + /** + * @brief 本电机在 EventState 默认树里的节点(第三层,挂在所用 CAN 实例的总线节点下) + * @return 节点的常量引用:`is_running()` = init() 成功;`get_error_bits()` 里的 TIMEOUT = 掉过线(粘滞,见 status.hpp) */ - const Online &online(void) const; + const EventState &get_state(void) const; /** * @brief 获取可选的 Luenberger 观测数据 * @return 内部 LuenbergerMotorData 的常量引用。 * @note 观测器未启用时,该数据不应作为有效控制依据。 */ - const LuenbergerMotorData &lvboData(void) const; + const LuenbergerMotorData &get_lvbo_data(void) const; /** * @brief 查询对象构造校验或初始化状态 * @return Status::OK 表示初始化成功;其他值表示未初始化或初始化错误。 - * @note 收发操作结果由 DataUnpack() 和 FillData() 的返回值提供,不更新此状态。 + * @note 收发操作结果由 unpack() 和 fill_data() 的返回值提供,不更新此状态。 * @warning 不得与 init() 并发调用。 */ - Status statu(void) const; + Status get_status(void) const; /** * @brief 构造单个 DJI 电机对象并校验参数 @@ -180,7 +193,7 @@ class DjiMotor * @param control_mode GM6020 的控制模式;其他电机型号忽略该参数 * @param online_timeout_ms 多久收不到有效反馈判离线(ms,默认 30,评审 I4) * - * @note 构造后调用 init() 注册收发节点;错误可通过 statu() 查询。 + * @note 构造后调用 init() 注册收发节点;错误可通过 get_status() 查询。 * @note 构造阶段不会调用 BspCanT::init() 或发送 CAN 帧。 */ DjiMotor(CanT &can_item, @@ -213,7 +226,7 @@ class DjiMotor * @note 首帧以绝对编码器位置初始化多圈角度;单圈角度为输出轴角度对 2π 取模。 * @note 不计算角加速度;通用数据中的 acceleration 保持初始零值,不代表实际角加速度。 */ - Status DataUnpack(const CanRxMsg &rx); + Status unpack(const CanRxMsg &rx); /** * @brief 设置下一周期发送的原始控制量 @@ -224,7 +237,7 @@ class DjiMotor * * @note 本函数只更新发送槽位,实际发送由 can_tx_task 统一完成。 */ - Status FillData(int16_t output); + Status fill_data(int16_t output); // 禁止复制/移动 DjiMotor(const DjiMotor &) = delete; @@ -239,7 +252,7 @@ class DjiMotor /* ==================== 成员函数定义(只有头文件:任意 CAN / UART 类型都能实例化,评审 N23) ==================== */ -template +template DjiMotor::DjiMotor(CanT &can_item, uint8_t motor_id, float ratio, @@ -261,7 +274,7 @@ _statu(Status::NOT_INIT), _total_ecd(0), _feedback_ready(false) { - if (sys_state.running()) // 只允许在初始化期使用 + if (sys_state.is_running()) // 只允许在初始化期使用 { return; } @@ -270,7 +283,7 @@ _feedback_ready(false) this->_statu = Status::BAD_ARG; return; } - else if ( motor_id == 8 && type == Motor6020 ) // 6020无ID8 + else if ( motor_id == 8 && type == DjiMotorType::GM6020 ) // 6020无ID8 { this->_statu = Status::BAD_ARG; return; @@ -284,15 +297,15 @@ _feedback_ready(false) if (ratio <= 0) // 按照说明书中的减速比配置默认减速比 { switch (type) { - case Motor2006:{ + case DjiMotorType::M2006:{ ratio = 36; break; } - case Motor3508:{ + case DjiMotorType::M3508:{ ratio = 3591.0f/187.0f; break; } - case Motor6020:{ + case DjiMotorType::GM6020:{ ratio = 1; break; } @@ -303,19 +316,19 @@ _feedback_ready(false) _data.param.offset = offset; _param.ecd_full_range = 8192; switch (type) { - case Motor3508: + case DjiMotorType::M3508: _param.current_limit = 16000; break; - case Motor2006: + case DjiMotorType::M2006: _param.current_limit = 10000; break; - case Motor6020: + case DjiMotorType::GM6020: _param.current_limit = _control_mode == DjiMotorControlMode::CURRENT ? 16384 : 25000; break; } } -template +template DjiMotor::~DjiMotor() { // 接收节点持有 this;必须在上下文销毁之前成功注销。 @@ -336,7 +349,7 @@ DjiMotor::~DjiMotor() configASSERT(result == Status::OK); if (result != Status::OK) { - (void)sys_state.error(result); + (void)_state.error(result); } _tx_node = nullptr; } @@ -344,7 +357,7 @@ DjiMotor::~DjiMotor() // _online 是成员对象,其析构函数会自动注销在线检查节点。 } -template +template Status DjiMotor::init() { // 系统事件未就绪时保留对象状态,允许初始化流程稍后重试。 @@ -352,7 +365,7 @@ Status DjiMotor::init() { return Status::NOT_INIT; } - if (sys_state.running()) // 只允许在初始化期使用 + if (sys_state.is_running()) // 只允许在初始化期使用 { return Status::NOT_SUPPORTED; } @@ -361,17 +374,28 @@ Status DjiMotor::init() { return Status::OK; } + + // 默认树第三层(Q6):节点挂在所用 CAN 实例的总线节点下;该实例不在清单里时(init() 会被 BAD_ARG 拦下, + // 这里只是兜底)直接挂 sys_state。init() / set_parent() 重复调用无害 + if (_state.init() != Status::OK) + { + (void)sys_state.init_error(Status::FULL); + return Status::FULL; + } + EventState *bus = bus_state(_can_item); + (void)_state.set_parent((bus != nullptr) ? *bus : sys_state); + if (_statu != Status::NOT_INIT) { - sys_state.init_error(_statu); + (void)_state.init_error(_statu); return _statu; } // 确定发送can id uint32_t tx_can_id = 0x00; switch (type) { - case Motor2006: - case Motor3508: + case DjiMotorType::M2006: + case DjiMotorType::M3508: { if (_motor_id <= 4 ) { @@ -383,7 +407,7 @@ Status DjiMotor::init() } break; } - case Motor6020: + case DjiMotorType::GM6020: { switch (_control_mode) { case DjiMotorControlMode::CURRENT: @@ -413,7 +437,7 @@ Status DjiMotor::init() default: { _statu = Status::BAD_ARG; - sys_state.init_error(_statu); + (void)_state.init_error(_statu); return _statu; } } @@ -422,7 +446,7 @@ Status DjiMotor::init() default: { _statu = Status::BAD_ARG; - sys_state.init_error(_statu); + (void)_state.init_error(_statu); return _statu; } } @@ -432,11 +456,11 @@ Status DjiMotor::init() if ( _tx_node == nullptr ) { _statu = Status::FULL; - sys_state.init_error(_statu); + (void)_state.init_error(_statu); return _statu; } - const uint32_t feedback_id = (type == Motor6020 ? 0x204U : 0x200U) + _motor_id; + const uint32_t feedback_id = (type == DjiMotorType::GM6020 ? 0x204U : 0x200U) + _motor_id; _rx_node = CanRxNodeT::regist(*_can_item, feedback_id, &DjiMotor::rx_callback, this); if (_rx_node == nullptr) { @@ -446,27 +470,30 @@ Status DjiMotor::init() (void)result; _tx_node = nullptr; _statu = Status::IO_ERROR; + (void)_state.init_error(_statu); return _statu; } + _online.set_state(&_state); // 由在线变离线时在本节点记 TIMEOUT + (void)_state.complete_init(); _statu = Status::OK; return _statu; } -template +template Status DjiMotor::rx_callback(void *context, const CanRxMsg &rx) { - return static_cast *>(context)->DataUnpack(rx); + return static_cast *>(context)->unpack(rx); } -template -Status DjiMotor::DataUnpack(const CanRxMsg &rx) +template +Status DjiMotor::unpack(const CanRxMsg &rx) { if (_tx_node == nullptr) { return Status::NOT_INIT; } - if (rx.header.Identifier != ((type == Motor6020 ? 0x204U : 0x200U) + _motor_id) || rx.header.IdType != FDCAN_STANDARD_ID || rx.header.RxFrameType != FDCAN_DATA_FRAME || rx.header.FDFormat != FDCAN_CLASSIC_CAN || rx.header.DataLength != FDCAN_DLC_BYTES_8) + if (rx.header.Identifier != ((type == DjiMotorType::GM6020 ? 0x204U : 0x200U) + _motor_id) || rx.header.IdType != FDCAN_STANDARD_ID || rx.header.RxFrameType != FDCAN_DATA_FRAME || rx.header.FDFormat != FDCAN_CLASSIC_CAN || rx.header.DataLength != FDCAN_DLC_BYTES_8) { return Status::BAD_ARG; } @@ -481,8 +508,8 @@ Status DjiMotor::DataUnpack(const CanRxMsg &rx) DjiMotorRawData raw = _raw_data; raw.rpm = static_cast((rx.data[2] << 8) | rx.data[3]); raw.torque_current = static_cast((rx.data[4] << 8) | rx.data[5]); - raw.temperature = type == Motor2006 ? 0U : rx.data[6]; - data.radian_data.velocity = raw.rpm / data.param.ratio * (PI / 30.0f); + raw.temperature = type == DjiMotorType::M2006 ? 0U : rx.data[6]; + data.radian_data.velocity = raw.rpm / data.param.ratio * (ICBSP_PI_F / 30.0f); if (!_feedback_ready) { @@ -506,12 +533,12 @@ Status DjiMotor::DataUnpack(const CanRxMsg &rx) raw.ecd = static_cast(ecd); // 保留双精度中间角度,避免多圈累计后单圈取模损失精度;多圈角度字段是 double,直接存(F11:原来先转 float 再存,精度还是 float) - const double angle = (static_cast(_total_ecd) * (2.0 * PI) / _param.ecd_full_range - data.param.offset) / data.param.ratio; + const double angle = (static_cast(_total_ecd) * (2.0 * ICBSP_PI) / _param.ecd_full_range - data.param.offset) / data.param.ratio; data.radian_data.angle_multi_round = angle; - data.radian_data.angle_single_round = static_cast(std::fmod(angle, 2.0 * PI)); + data.radian_data.angle_single_round = static_cast(std::fmod(angle, 2.0 * ICBSP_PI)); if (data.radian_data.angle_single_round < 0.0f) { - data.radian_data.angle_single_round += 2.0f * PI; + data.radian_data.angle_single_round += 2.0f * ICBSP_PI_F; } taskENTER_CRITICAL(); @@ -524,8 +551,8 @@ Status DjiMotor::DataUnpack(const CanRxMsg &rx) return Status::OK; } -template -Status DjiMotor::FillData(int16_t output) +template +Status DjiMotor::fill_data(int16_t output) { if (_statu != Status::OK ) { @@ -544,17 +571,17 @@ Status DjiMotor::FillData(int16_t output) tx_data[0] = static_cast(static_cast(output)>>8); tx_data[1] = static_cast(output); - return _tx_node->filldata(tx_data, _bus_slot); + return _tx_node->fill_data(tx_data, _bus_slot); } -template -const MotorData &DjiMotor::data(void) const +template +const MotorData &DjiMotor::get_data(void) const { return _data; } -template +template void DjiMotor::snapshot(MotorData &data, DjiMotorRawData *raw) const { taskENTER_CRITICAL(); @@ -566,36 +593,42 @@ void DjiMotor::snapshot(MotorData &data, DjiMotorRawData *raw) const taskEXIT_CRITICAL(); } -template -const DjiMotorRawData &DjiMotor::raw_data(void) const +template +const DjiMotorRawData &DjiMotor::get_raw_data(void) const { return _raw_data; } -template -const DjiMotorParam &DjiMotor::param(void) const +template +const DjiMotorParam &DjiMotor::get_param(void) const { return _param; } -template -const Online &DjiMotor::online(void) const +template +const Online &DjiMotor::get_online(void) const { return _online; } -template -const LuenbergerMotorData &DjiMotor::lvboData(void) const +template +const EventState &DjiMotor::get_state(void) const +{ + return _state; +} + +template +const LuenbergerMotorData &DjiMotor::get_lvbo_data(void) const { return _lvbo_data; } -template -Status DjiMotor::statu(void) const +template +Status DjiMotor::get_status(void) const { return _statu; } -#endif // HAL_FDCAN_MODULE_ENABLED && CAN_RX_ENABLE && CAN_TX_ENABLE +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_RX_ENABLE && ICBSP_CAN_TX_ENABLE #endif // __DJI_MOTOR_HPP__ diff --git a/code/device/motor/dm_motor.hpp b/code/device/motor/dm_motor.hpp new file mode 100644 index 0000000..41b52ed --- /dev/null +++ b/code/device/motor/dm_motor.hpp @@ -0,0 +1,735 @@ +/** + * @file dm_motor.hpp + * @brief 达妙(DAMIAO)CAN 电机:MIT / 位置速度 / 速度模式,使能、失能、清错误、设零点,反馈解包(阶段 2.9) + * + * @details 协议来源:《DM-J4310-2EC V1.2》《DM-J4340P-2EC V1.2 / V1.1》《DM-J8009P-2EC V1.3 / V1.1》说明书的“CAN 通信”一章 + * (库里 docs/sheet/),映射函数照 J4340P 说明书给出的 float_to_uint / uint_to_float(截断取整)。 + * + * **型号**:三个系列的 CAN 协议逐项相同(帧 ID、帧格式、映射、命令、ERR 状态码),不同的只是数值,所以不做成按型号的模板 + * (DJI 用模板是因为不同型号的反馈 / 控制帧 ID、ID 范围本身就不同)。型号经 `Config::model` 给出,用来查 + * `dm_model_info()` 的减速比 / 额定与峰值扭矩 / 空载转速,并把 MIT 前馈扭矩限在峰值扭矩以内。 + * 映射范围 P_MAX / V_MAX / T_MAX 是驱动器里**可改的寄存器**(实测 J4340P 是 12.5 / 10 / 28,不是说明书写的预设 12.5 / 30 / 10), + * 不能从型号推出来:要么在 Config 里填和调试助手一致的值,要么填 0、启动后调 `sync_ranges()` 从驱动器读。 + * + * | 帧 | 帧 ID | 数据 | + * | --- | --- | --- | + * | MIT 控制 | `can_id` | p_des 16 位、v_des / Kp / Kd / t_ff 各 12 位,按位拼进 8 字节 | + * | 位置速度控制 | `0x100 + can_id` | p_des、v_des 两个 float,低字节在前 | + * | 速度控制 | `0x200 + can_id` | v_des 一个 float(4 字节) | + * | 使能 / 失能 / 保存零点 / 清错误 | 当前模式的控制帧 ID | `FF ×7` + `FC` / `FD` / `FE` / `FB` | + * | 读 / 写寄存器 | `0x7FF` | `CANID_L CANID_H 0x33 RID`(读)/ `CANID_L CANID_H 0x55 RID` + 4 字节数据(写),回复发到 master_id | + * | 反馈 | `master_id`(调试助手里的 Master ID) | `ID|ERR<<4`、POS 16 位、VEL 12 位、T 12 位、T_MOS、T_Rotor | + * + * 位置 / 速度 / 扭矩按 [−P_MAX, P_MAX]、[−V_MAX, V_MAX]、[−T_MAX, T_MAX] 线性映射成无符号定点数, + * Kp 范围 [0, 500]、Kd 范围 [0, 5](说明书原文)。P_MAX / V_MAX / T_MAX 必须和驱动器里的一致,否则指令和反馈按比例缩放。 + * + * @note 用法(实例写在 board_cfg.hpp,init() 写在 board_init()): + * + * inline DmMotor yaw_motor(bsp_can2, {.model = DmModel::J4340P, .can_id = 0x02, .master_id = 0x12, + * .mode = DmMode::MIT}); // 映射范围留 0:启动后从驱动器读 + * ICBSP_CHECK(yaw_motor.init() == Status::OK); // board_init() 里,system_start() 之前 + * yaw_motor.sync_ranges(); // 任务里、system_start() 之后:读 PMAX / VMAX / TMAX / 控制模式 + * yaw_motor.enable(); // 上电后电机是失能态 + * yaw_motor.set_mit(0.0f, 0.0f, 0.0f, 1.0f, 0.0f); // 控制任务里每个周期发一次 + * DmMotorFeedback fb; yaw_motor.snapshot(fb); // 跨任务读反馈 + * + * @warning **控制帧不经过 CanTxNodeT**:发送节点的槽位过期会被清零,而 MIT 帧全 0 映射出来是 p = −P_MAX、t = −T_MAX, + * 等于给满负扭矩。控制帧由本类直接 `send_latest()` 发;**调用方要按控制周期持续调用 set_*()**, + * 停发后由电机自己的“通讯丢失”保护(调试助手里设的超时)退出使能。 + * @note 反馈是问询式的:电机只在收到发给自己的帧时回一帧反馈,所以不发控制帧时 is_online() 会变成 false。 + * @note 每台电机的 master_id 要不同(反馈帧按 master_id 分发到接收节点);反馈里的 ID 只有低 4 位 + * (高 4 位是 ERR),所以同一 master_id 下靠 can_id 低 4 位区分,本类只认 `can_id & 0x0F` 对得上的帧。 + * @warning **ID 冲突**:驱动器只核对帧 ID 的**低 8 位**(说明书原文)。同一总线上任何帧的 ID 低 8 位等于 can_id,电机都会回一帧反馈; + * 帧 ID 恰好等于当前模式的控制帧 ID 时还会被当成控制指令。实测(2026-11-06):CAN2 上 GM6020 ID 1 的反馈 0x205 + * 正好是 CAN_ID 0x05 的 DM 电机在速度模式下的控制帧 ID,DM 每收到一帧 6020 反馈就回一帧(约 1 kHz), + * 使能后会把 6020 的编码器 / 转速字节当成速度给定。与 DJI 电机同总线时,can_id 的低 8 位要避开 + * 0x01~0x0B(DJI 反馈 0x201~0x20B)和 0xFE / 0xFF / 0x00(DJI 控制帧 0x1FE / 0x1FF / 0x200 等),例如用 0x10 以上。 + * @note 默认树(Q6):本电机的节点挂在所用 CAN 的总线节点下;掉线记 TIMEOUT,反馈进入故障态(ERR 不是 0 / 1)记 IO_ERROR。 + * @note **只编译验证,未上板**(本工程没有达妙电机)。 + */ + +#ifndef __DM_MOTOR_HPP__ +#define __DM_MOTOR_HPP__ + +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "FreeRTOS.h" // IWYU pragma: keep +#include "task.h" // taskENTER_CRITICAL(snapshot / 反馈写回) +#include "service/system/config_check.hpp" // 宿主配置(经检查) + +// 依赖(Q4):反馈要靠接收节点分发,CubeMX 开了 CAN 却关了接收路径时,用到 DmMotor 就直接报错 +#if defined(HAL_FDCAN_MODULE_ENABLED) && !ICBSP_CAN_RX_ENABLE +# error "DmMotor 需要 CAN 接收路径:hardware_config.h 里 ICBSP_CAN_RX_ENABLE 要为 1(控制帧直接发,不需要 ICBSP_CAN_TX_ENABLE)" +#endif + +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_RX_ENABLE + +#include "bsp/bsp_can.hpp" +#include "service/comm/can_rx_node.hpp" +#include "service/monitor/online_check.hpp" +#include "service/system/state_tree.hpp" // bus_state():默认树的总线节点 +#include "service/system/status.hpp" +#include "service/system/system.hpp" + +#include +#include +#include +#include + +/** @brief 控制模式(驱动器 CTRL_MODE 寄存器 0x0A 的取值;力位混控 4 暂不支持) */ +enum class DmMode : uint8_t +{ + MIT = 1U, ///< MIT:p_des / v_des / Kp / Kd / t_ff + POS_VEL = 2U, ///< 位置速度:梯形加减速到 p_des,v_des 为匀速段速度 + VEL = 3U, ///< 速度 +}; + +/** @brief 反馈帧里的状态(ERR 字段) */ +enum class DmState : uint8_t +{ + DISABLED = 0x0U, ///< 失能 + ENABLED = 0x1U, ///< 使能 + SHAFT_CAL_ERR = 0x3U, ///< 输出轴校准异常(J4340P 说明书) + SENSOR_ERR = 0x4U, ///< 传感器输出异常(J4340P 说明书) + ENCODER_CAL_ERR = 0x5U, ///< 电机编码器校准异常(J4340P 说明书) + OVER_VOLTAGE = 0x8U, ///< 超压 + UNDER_VOLTAGE = 0x9U, ///< 欠压 + OVER_CURRENT = 0xAU, ///< 过电流 + MOS_OVER_TEMP = 0xBU, ///< MOS 过温 + COIL_OVER_TEMP = 0xCU, ///< 电机线圈过温 + COMM_LOST = 0xDU, ///< 通讯丢失 + OVERLOAD = 0xEU, ///< 过载 +}; + +/** + * @brief 达妙电机型号(只决定 dm_model_info() 的数值,协议都一样) + * @note J4310P 仓库里没有说明书,暂按 J4310 V1.2 的数值;P 型号的参数以厂家资料为准。 + */ +enum class DmModel : uint8_t +{ + UNKNOWN = 0, ///< 不限型号:不按峰值扭矩限幅,dm_model_info() 全 0 + J4310, ///< DM-J4310-2EC V1.2(也用于 J4310P,见上) + J4340P, ///< DM-J4340P-2EC(说明书 V1.2) + J4340P_V11, ///< DM-J4340P-2EC V1.1(说明书 V1.4,峰值扭矩更大) + J8009P, ///< DM-J8009P-2EC 与 V1.1(两版参数相同,只差编码器位数) +}; + +/** @brief 型号的说明书参数(24 V 版本,48 V 版本另列空载转速) */ +struct DmModelInfo +{ + const char *name; ///< 型号名 + float gear_ratio; ///< 减速比(输出轴 : 电机轴 = 1 : gear_ratio) + float rated_torque; ///< 额定扭矩 (N·m) + float peak_torque; ///< 峰值扭矩 (N·m),MIT 前馈扭矩按它限幅 + float no_load_rpm_24; ///< 24 V 空载最高转速 (rpm,输出轴) + float no_load_rpm_48; ///< 48 V 空载最高转速 (rpm,输出轴) +}; + +/** @brief 查型号参数(数值抄自各型号说明书的“特征参数”表) */ +constexpr DmModelInfo dm_model_info(DmModel model) +{ + switch (model) + { + case DmModel::J4310: + return {"DM-J4310-2EC", 10.0f, 3.5f, 12.5f, 200.0f, 450.0f}; + case DmModel::J4340P: + return {"DM-J4340P-2EC", 40.0f, 9.0f, 27.0f, 52.5f, 100.0f}; + case DmModel::J4340P_V11: + return {"DM-J4340P-2EC V1.1", 40.0f, 12.0f, 40.0f, 56.0f, 112.0f}; + case DmModel::J8009P: + return {"DM-J8009P-2EC", 9.0f, 20.0f, 40.0f, 168.0f, 335.0f}; + case DmModel::UNKNOWN: + default: + return {"unknown", 0.0f, 0.0f, 0.0f, 0.0f, 0.0f}; + } +} + +/** @brief 一帧反馈解出来的数据 */ +struct DmMotorFeedback +{ + bool valid = false; ///< 是否收到过有效反馈 + DmState state = DmState::DISABLED; + float position = 0.0f; ///< 输出轴位置 (rad),范围 [−P_MAX, P_MAX] + float velocity = 0.0f; ///< 输出轴速度 (rad/s) + float torque = 0.0f; ///< 扭矩 (N·m) + uint8_t t_mos = 0U; ///< 驱动 MOS 平均温度 (℃) + uint8_t t_rotor = 0U; ///< 电机线圈平均温度 (℃) + uint16_t raw_pos = 0U; ///< 原始定点值(16 位) + uint16_t raw_vel = 0U; ///< 原始定点值(12 位) + uint16_t raw_tor = 0U; ///< 原始定点值(12 位) +}; + +namespace dm +{ +constexpr float KP_MIN = 0.0f; ///< MIT Kp 下限(说明书) +constexpr float KP_MAX = 500.0f; ///< MIT Kp 上限(说明书) +constexpr float KD_MIN = 0.0f; ///< MIT Kd 下限 +constexpr float KD_MAX = 5.0f; ///< MIT Kd 上限 + +constexpr uint32_t PARAM_ID = 0x7FFU; ///< 读写寄存器的帧 ID +constexpr uint8_t CMD_READ_REG = 0x33U; ///< 读寄存器 +constexpr uint8_t CMD_WRITE_REG = 0x55U; ///< 写寄存器 +constexpr uint8_t RID_MST_ID = 0x07U; ///< 反馈 ID(uint32) +constexpr uint8_t RID_ESC_ID = 0x08U; ///< 接收 ID(uint32) +constexpr uint8_t RID_CTRL_MODE = 0x0AU; ///< 控制模式(uint32) +constexpr uint8_t RID_PMAX = 0x15U; ///< 位置映射范围(float) +constexpr uint8_t RID_VMAX = 0x16U; ///< 速度映射范围(float) +constexpr uint8_t RID_TMAX = 0x17U; ///< 扭矩映射范围(float) + +/** @brief 寄存器原始值(低字节在前的 4 字节)当 float 解释 */ +inline float reg_as_float(uint32_t raw) +{ + float f = 0.0f; + memcpy(&f, &raw, sizeof(f)); + return f; +} + +/** @brief 浮点 → 定点:先限幅到 [x_min, x_max],再按说明书的 float_to_uint 线性映射到 [0, 2^bits − 1](截断取整,与驱动器一致) */ +inline uint16_t float_to_uint(float x, float x_min, float x_max, uint8_t bits) +{ + const float top = static_cast((1U << bits) - 1U); + x = (x < x_min) ? x_min : ((x > x_max) ? x_max : x); + return static_cast((x - x_min) * top / (x_max - x_min)); +} + +/** @brief 定点 → 浮点:float_to_uint() 的逆映射 */ +inline float uint_to_float(uint32_t v, float x_min, float x_max, uint8_t bits) +{ + const float top = static_cast((1U << bits) - 1U); + return static_cast(v) * (x_max - x_min) / top + x_min; +} + +/** @brief float 按小端写进 4 字节 */ +inline void put_f32_le(uint8_t *out, float v) +{ + uint32_t u = 0U; + memcpy(&u, &v, sizeof(u)); + out[0] = static_cast(u); + out[1] = static_cast(u >> 8); + out[2] = static_cast(u >> 16); + out[3] = static_cast(u >> 24); +} +} // namespace dm + +/** + * @brief 达妙 CAN 电机 + * @tparam CanT 所在总线的 BspCanT 类型(`decltype(bsp_can1)`) + * @note 对象不可复制或移动(Online / EventState / 接收节点持有 this)。 + */ +template +class DmMotor +{ +public: + /** @brief 配置(聚合体,用指定初始化器写) */ + struct Config + { + DmModel model = DmModel::UNKNOWN; ///< 型号(查 dm_model_info();UNKNOWN = 不按峰值扭矩限幅) + uint16_t can_id = 0U; ///< 电机 CAN ID(1~0xFF;控制帧 ID 由它和模式决定) + uint16_t master_id = 0U; ///< 反馈帧 ID(调试助手里的 Master ID,每台不同,不能是 0x7FF) + DmMode mode = DmMode::MIT; ///< 驱动器当前的控制模式(决定控制帧 ID;sync_ranges() 会按驱动器的值改;要改驱动器用 switch_mode()) + float p_max = 0.0f; ///< 位置映射范围 P_MAX(rad),与驱动器一致;0 = 启动后用 sync_ranges() 从驱动器读 + float v_max = 0.0f; ///< 速度映射范围 V_MAX(rad/s);0 = 同上 + float t_max = 0.0f; ///< 扭矩映射范围 T_MAX(N·m);0 = 同上 + uint16_t online_timeout_ms = 30U; ///< 多久收不到反馈判离线 (ms) + }; + + /** @brief 运行诊断(只增不减) */ + struct Diag + { + uint32_t feedback_cnt; ///< 有效反馈帧数 + uint32_t reject_cnt; ///< 发到 master_id 但不当反馈解的帧数(ID 低 4 位不符 / 长度不对 / 不是本对象发起的寄存器回复) + uint32_t reg_reply_cnt; ///< 收到的写寄存器回复数 + uint32_t send_busy_cnt; ///< send_latest() 因同 ID 上一帧还没发出而丢掉的控制帧数 + uint32_t fault_cnt; ///< 反馈进入故障态(ERR 不是 0 / 1)的次数 + uint32_t range_mismatch; ///< sync_ranges() 发现 Config 里填的映射范围 / 模式和驱动器不一致的次数(之后以驱动器为准) + }; + + DmMotor(CanT &can, const Config &cfg) : + _can(can), _cfg(cfg), _mode(cfg.mode), _p_max(cfg.p_max), _v_max(cfg.v_max), _t_max(cfg.t_max), _online(cfg.online_timeout_ms) + { + } + /** @brief 注销反馈接收节点(运行态冻结后注销会失败:此时继续析构会留下悬空回调,直接 abort,同 DjiMotor) */ + ~DmMotor() + { + if (_rx_node != nullptr && CanRxNodeT::unregist(_can, _rx_node) != Status::OK) + { + std::abort(); + } + } + + DmMotor(const DmMotor &) = delete; + DmMotor &operator=(const DmMotor &) = delete; + + /** + * @brief 校验配置、注册反馈接收节点、挂到默认树 + * @return OK;BAD_ARG = 配置非法;FULL / BUSY = 接收节点注册失败(原因已记在 sys_state); + * NOT_INIT = system_init() 还没调;NOT_SUPPORTED = 系统已在运行(接收节点只能在初始化期注册) + * @note 只在初始化期调用(board_init());重复调用成功后无副作用。 + */ + Status init(); + + /** @brief 使能(上电后电机处于失能态,必须先使能才能控制) */ + Status enable() { return send_command(0xFCU); } + /** @brief 失能 */ + Status disable() { return send_command(0xFDU); } + /** @brief 把当前输出轴位置设为零点(位置给定同时清零) */ + Status save_zero() { return send_command(0xFEU); } + /** @brief 清除错误(过热等) */ + Status clear_error() { return send_command(0xFBU); } + + /** + * @brief MIT 模式控制 + * @param p 位置 (rad) @param v 速度 (rad/s) @param kp [0, 500] @param kd [0, 5] @param t 前馈扭矩 (N·m) + * @return OK;BAD_ARG = 有非有限值(不发);NOT_SUPPORTED = 当前不是 MIT 模式;BUSY = 上一帧还没发出(本帧丢弃);其余同 BspCanT::send() + * @note 超出映射范围的值限幅后再发。位置控制时 kd 不能为 0(说明书:会震荡甚至失控)。 + */ + Status set_mit(float p, float v, float kp, float kd, float t); + + /** @brief 位置速度模式控制:p 目标位置 (rad),v 匀速段速度 (rad/s) */ + Status set_pos_vel(float p, float v); + + /** @brief 速度模式控制:v 目标速度 (rad/s) */ + Status set_vel(float v); + + /** + * @brief 经 CAN 写 CTRL_MODE 寄存器切换控制模式(不存 flash,掉电恢复成上次保存的模式) + * @note 说明书:切换时电机清零位置 / 速度 / 扭矩 / Kp / Kd 指令,建议零速时切换。发出去之后本类就按新模式选帧 ID。 + */ + Status switch_mode(DmMode mode); + + /** + * @brief 读一个寄存器(阻塞等回复,只能在任务里、system_start() 之后调用:回复要靠 can_rx_task 分发) + * @param rid 寄存器地址(dm::RID_*,见说明书“寄存器列表及范围”) + * @param raw 回复里的 4 字节数据(低字节在前);float 寄存器用 dm::reg_as_float() 转 + * @param timeout_ms 最多等多久 + * @return OK;TIMEOUT = 没收到回复(ID 不对、电机没上电、总线不通);BUSY = 上一次寄存器操作还没完;其余同 send() + * @note 不需要使能,读寄存器不会让电机动作——用来确认通信、核对 PMAX / VMAX / TMAX / 控制模式。 + */ + Status read_register(uint8_t rid, uint32_t &raw, uint32_t timeout_ms = 20U); + + /** @brief 当前按哪个模式发控制帧 */ + DmMode get_mode() const { return _mode; } + + /** @brief 实时反馈(can_rx_task 随时会改;跨任务读用 snapshot()) */ + const DmMotorFeedback &get_feedback() const { return _fb; } + + /** @brief 在临界区里拷一份同一帧的反馈 */ + void snapshot(DmMotorFeedback &out) const + { + taskENTER_CRITICAL(); + out = _fb; + taskEXIT_CRITICAL(); + } + + /** @brief 是否在线(收到反馈后 online_timeout_ms 内) */ + bool is_online() const { return _online.is_online(); } + /** @brief 在线检查对象 */ + const Online &get_online() const { return _online; } + /** @brief 本电机在 EventState 默认树里的节点(第三层) */ + const EventState &get_state() const { return _state; } + /** @brief 初始化结果:OK = init() 成功,NOT_INIT = 还没 init,其余为失败原因 */ + Status get_status() const { return _statu; } + /** @brief 诊断计数 */ + Diag get_diag() const { return {_feedback_cnt, _reject_cnt, _reg_reply_cnt, _send_busy_cnt, _fault_cnt, _range_mismatch}; } + + /** + * @brief 从驱动器读 PMAX / VMAX / TMAX / CTRL_MODE,以驱动器的值为准更新本对象(只能在任务里、system_start() 之后调用) + * @return OK;其余同 read_register()(读失败时保持原来的值) + * @note Config 里填了非 0 的映射范围、或模式和驱动器不一致时,计入 Diag::range_mismatch,并在默认树节点上记 BAD_ARG。 + * @note 不需要使能,不会让电机动作。CTRL_MODE 是力位混控(4)等本类不支持的模式时返回 NOT_SUPPORTED,映射范围照常更新。 + */ + Status sync_ranges(uint32_t timeout_ms = 20U); + + /** @brief 映射范围是否已知(Config 填了,或 sync_ranges() 成功过);未知时 set_*() 返回 NOT_INIT、反馈只有原始值 */ + bool has_ranges() const { return _p_max > 0.0f && _v_max > 0.0f && _t_max > 0.0f; } + /** @brief 当前使用的映射范围 */ + float get_p_max() const { return _p_max; } + float get_v_max() const { return _v_max; } + float get_t_max() const { return _t_max; } + /** @brief 型号参数(Config::model) */ + DmModelInfo get_model_info() const { return dm_model_info(_cfg.model); } + + /** @brief 解一帧发到 master_id 的报文(接收节点回调;不属于本电机返回 BAD_ARG,帧进回退缓冲) */ + Status unpack(const CanRxMsg &rx); + +private: + uint32_t control_id() const + { + switch (_mode) + { + case DmMode::POS_VEL: + return 0x100U + _cfg.can_id; + case DmMode::VEL: + return 0x200U + _cfg.can_id; + case DmMode::MIT: + default: + return _cfg.can_id; + } + } + + Status send_command(uint8_t last) + { + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + const uint8_t d[8] = {0xFFU, 0xFFU, 0xFFU, 0xFFU, 0xFFU, 0xFFU, 0xFFU, last}; + return _can.send(control_id(), d, 8U); // 命令帧排队发,不被同 ID 的控制帧挤掉 + } + + Status send_control(const uint8_t *d, uint8_t dlc) + { + const Status st = _can.send_latest(control_id(), d, dlc); + if (st == Status::BUSY) + { + _send_busy_cnt = _send_busy_cnt + 1U; + } + return st; + } + + static Status rx_callback(void *context, const CanRxMsg &rx) { return static_cast(context)->unpack(rx); } + + CanT &_can; + Config _cfg; + DmMode _mode; + volatile float _p_max; ///< 当前映射范围(Config 或 sync_ranges();任务写、can_rx_task 读,32 位读写原子) + volatile float _v_max; + volatile float _t_max; + Status _statu = Status::NOT_INIT; + CanRxNodeT *_rx_node = nullptr; + Online _online; + EventState _state; + DmMotorFeedback _fb; + volatile bool _reg_pending = false; ///< 发过读 / 写寄存器、回复还没到(回复也走 master_id,要和反馈区分开) + volatile uint8_t _reg_cmd = 0U; ///< 挂起的是读(0x33)还是写(0x55) + volatile uint8_t _reg_rid = 0U; + volatile uint32_t _reg_value = 0U; ///< 最近一次寄存器回复的数据 + volatile uint32_t _feedback_cnt = 0U; + volatile uint32_t _reject_cnt = 0U; + volatile uint32_t _reg_reply_cnt = 0U; + volatile uint32_t _send_busy_cnt = 0U; + volatile uint32_t _fault_cnt = 0U; + volatile uint32_t _range_mismatch = 0U; +}; + +/* ==================== 成员函数定义(只有头文件) ==================== */ + +template +Status DmMotor::init() +{ + if (!sys_state.is_ready()) + { + return Status::NOT_INIT; + } + if (sys_state.is_running()) + { + return Status::NOT_SUPPORTED; // 接收节点只能在初始化期注册 + } + if (_statu == Status::OK) + { + return Status::OK; + } + + // 默认树第三层(Q6):挂在所用 CAN 实例的总线节点下(实例不在清单里时挂 sys_state) + if (_state.init() != Status::OK) + { + (void)sys_state.init_error(Status::FULL); + return Status::FULL; + } + EventState *bus = bus_state(&_can); + (void)_state.set_parent((bus != nullptr) ? *bus : sys_state); + + // 映射范围:0 = 启动后 sync_ranges() 再读;填了就必须是正的有限值 + const bool range_ok = std::isfinite(_cfg.p_max) && std::isfinite(_cfg.v_max) && std::isfinite(_cfg.t_max) && _cfg.p_max >= 0.0f && + _cfg.v_max >= 0.0f && _cfg.t_max >= 0.0f; + const bool mode_ok = _cfg.mode == DmMode::MIT || _cfg.mode == DmMode::POS_VEL || _cfg.mode == DmMode::VEL; + if (!range_ok || !mode_ok || _cfg.can_id == 0U || _cfg.can_id > 0xFFU || _cfg.master_id > 0x7FFU || _cfg.master_id == dm::PARAM_ID) + { + _statu = Status::BAD_ARG; + (void)_state.init_error(_statu); + return _statu; + } + + _rx_node = CanRxNodeT::regist(_can, _cfg.master_id, &DmMotor::rx_callback, this); + if (_rx_node == nullptr) + { + _statu = Status::BUSY; // 注册器已在 sys_state 上记了具体原因(ID 冲突 / 节点数满) + (void)_state.init_error(_statu); + return _statu; + } + + _online.set_state(&_state); // 由在线变离线时在本节点记 TIMEOUT + (void)_state.complete_init(); + _statu = Status::OK; + return _statu; +} + +template +Status DmMotor::set_mit(float p, float v, float kp, float kd, float t) +{ + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + if (_mode != DmMode::MIT) + { + return Status::NOT_SUPPORTED; + } + if (!std::isfinite(p) || !std::isfinite(v) || !std::isfinite(kp) || !std::isfinite(kd) || !std::isfinite(t)) + { + return Status::BAD_ARG; // 不把 NaN 映射成某个极值发出去 + } + if (!has_ranges()) + { + return Status::NOT_INIT; // 映射范围未知:调 sync_ranges() 或在 Config 里填 + } + const float peak = dm_model_info(_cfg.model).peak_torque; + if (peak > 0.0f) + { + t = (t > peak) ? peak : ((t < -peak) ? -peak : t); // 型号的峰值扭矩以内(映射范围可能被设得比它大) + } + const uint16_t pu = dm::float_to_uint(p, -_p_max, _p_max, 16U); + const uint16_t vu = dm::float_to_uint(v, -_v_max, _v_max, 12U); + const uint16_t kpu = dm::float_to_uint(kp, dm::KP_MIN, dm::KP_MAX, 12U); + const uint16_t kdu = dm::float_to_uint(kd, dm::KD_MIN, dm::KD_MAX, 12U); + const uint16_t tu = dm::float_to_uint(t, -_t_max, _t_max, 12U); + const uint8_t d[8] = {static_cast(pu >> 8), + static_cast(pu), + static_cast(vu >> 4), + static_cast(((vu & 0x0FU) << 4) | (kpu >> 8)), + static_cast(kpu), + static_cast(kdu >> 4), + static_cast(((kdu & 0x0FU) << 4) | (tu >> 8)), + static_cast(tu)}; + return send_control(d, 8U); +} + +template +Status DmMotor::set_pos_vel(float p, float v) +{ + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + if (_mode != DmMode::POS_VEL) + { + return Status::NOT_SUPPORTED; + } + if (!std::isfinite(p) || !std::isfinite(v)) + { + return Status::BAD_ARG; + } + uint8_t d[8]; + dm::put_f32_le(d, p); + dm::put_f32_le(d + 4, v); + return send_control(d, 8U); +} + +template +Status DmMotor::set_vel(float v) +{ + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + if (_mode != DmMode::VEL) + { + return Status::NOT_SUPPORTED; + } + if (!std::isfinite(v)) + { + return Status::BAD_ARG; + } + uint8_t d[4]; + dm::put_f32_le(d, v); + return send_control(d, 4U); +} + +template +Status DmMotor::switch_mode(DmMode mode) +{ + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + if (mode != DmMode::MIT && mode != DmMode::POS_VEL && mode != DmMode::VEL) + { + return Status::BAD_ARG; + } + uint8_t d[8] = {static_cast(_cfg.can_id), static_cast(_cfg.can_id >> 8), dm::CMD_WRITE_REG, dm::RID_CTRL_MODE, + static_cast(mode), 0U, 0U, 0U}; // uint32,低字节在 D4 + if (_reg_pending) + { + return Status::BUSY; + } + _reg_cmd = dm::CMD_WRITE_REG; + _reg_rid = dm::RID_CTRL_MODE; + _reg_pending = true; + const Status st = _can.send(dm::PARAM_ID, d, 8U); + if (st == Status::OK) + { + _mode = mode; + } + else + { + _reg_pending = false; + } + return st; +} + +template +Status DmMotor::read_register(uint8_t rid, uint32_t &raw, uint32_t timeout_ms) +{ + if (_statu != Status::OK) + { + return Status::NOT_INIT; + } + if (_reg_pending) + { + return Status::BUSY; + } + const uint8_t d[4] = {static_cast(_cfg.can_id), static_cast(_cfg.can_id >> 8), dm::CMD_READ_REG, rid}; + _reg_cmd = dm::CMD_READ_REG; + _reg_rid = rid; + _reg_pending = true; + const Status st = _can.send(dm::PARAM_ID, d, 4U); + if (st != Status::OK) + { + _reg_pending = false; + return st; + } + const TickType_t t0 = xTaskGetTickCount(); + while (_reg_pending) + { + if ((xTaskGetTickCount() - t0) >= pdMS_TO_TICKS(timeout_ms)) + { + _reg_pending = false; + return Status::TIMEOUT; + } + vTaskDelay(1U); + } + raw = _reg_value; + return Status::OK; +} + +template +Status DmMotor::sync_ranges(uint32_t timeout_ms) +{ + uint32_t p = 0U, v = 0U, t = 0U, m = 0U; + Status st = read_register(dm::RID_PMAX, p, timeout_ms); + if (st == Status::OK) + { + st = read_register(dm::RID_VMAX, v, timeout_ms); + } + if (st == Status::OK) + { + st = read_register(dm::RID_TMAX, t, timeout_ms); + } + if (st == Status::OK) + { + st = read_register(dm::RID_CTRL_MODE, m, timeout_ms); + } + if (st != Status::OK) + { + return st; + } + const float pf = dm::reg_as_float(p); + const float vf = dm::reg_as_float(v); + const float tf = dm::reg_as_float(t); + if (!(pf > 0.0f) || !(vf > 0.0f) || !(tf > 0.0f) || !std::isfinite(pf) || !std::isfinite(vf) || !std::isfinite(tf)) + { + return Status::IO_ERROR; // 读回来的不是合理的映射范围 + } + // Config 填了值却和驱动器不一致:说明配置写错了(指令 / 反馈会被按比例缩放),记一笔 + auto differs = [](float cfg, float drv) { return cfg > 0.0f && std::fabs(cfg - drv) > 1e-3f * drv; }; + const bool mode_known = m == static_cast(DmMode::MIT) || m == static_cast(DmMode::POS_VEL) || + m == static_cast(DmMode::VEL); + if (differs(_cfg.p_max, pf) || differs(_cfg.v_max, vf) || differs(_cfg.t_max, tf) || + (mode_known && static_cast(_cfg.mode) != m)) + { + _range_mismatch = _range_mismatch + 1U; + (void)_state.error(Status::BAD_ARG); + } + _p_max = pf; + _v_max = vf; + _t_max = tf; + if (!mode_known) + { + return Status::NOT_SUPPORTED; // 例如力位混控:本类不发这种控制帧 + } + _mode = static_cast(m); + return Status::OK; +} + +template +Status DmMotor::unpack(const CanRxMsg &rx) +{ + if (rx.header.IdType != FDCAN_STANDARD_ID || rx.header.RxFrameType != FDCAN_DATA_FRAME || rx.header.DataLength != FDCAN_DLC_BYTES_8) + { + _reject_cnt = _reject_cnt + 1U; + return Status::BAD_ARG; + } + const uint8_t *d = rx.data; + + // 读 / 写寄存器的回复也发到 master_id:CANID_L CANID_H 0x33/0x55 RID 数据,按挂起的那次操作对上了就吃掉,不当反馈解 + if (_reg_pending && d[0] == static_cast(_cfg.can_id) && d[1] == static_cast(_cfg.can_id >> 8) && + d[2] == _reg_cmd && d[3] == _reg_rid) + { + _reg_value = static_cast(d[4]) | (static_cast(d[5]) << 8) | (static_cast(d[6]) << 16) | + (static_cast(d[7]) << 24); + _reg_pending = false; + _reg_reply_cnt = _reg_reply_cnt + 1U; + return Status::OK; + } + + // 不是本对象发起的读 / 写 / 存储寄存器的回复(别的代码、上位机发的请求):同样发到 master_id,不能当反馈解, + // 否则控制回路里会出现一帧假位置(2026-11-06 实板扫描时发现)。代价:位置恰好落在 −PMAX 附近的极小区间 + // (POS[15:8] == CANID_H 且 POS[7:0] 是这三个值之一,约占量程的 3 / 65536)时丢一帧真反馈 + if (d[0] == static_cast(_cfg.can_id) && d[1] == static_cast(_cfg.can_id >> 8) && + (d[2] == dm::CMD_READ_REG || d[2] == dm::CMD_WRITE_REG || d[2] == 0xAAU)) + { + _reject_cnt = _reject_cnt + 1U; + return Status::OK; // 吃掉,不进回退缓冲 + } + + if ((d[0] & 0x0FU) != (_cfg.can_id & 0x0FU)) + { + _reject_cnt = _reject_cnt + 1U; + return Status::BAD_ARG; + } + + DmMotorFeedback fb; + fb.valid = true; + fb.state = static_cast(d[0] >> 4); + fb.raw_pos = static_cast((d[1] << 8) | d[2]); + fb.raw_vel = static_cast((d[3] << 4) | (d[4] >> 4)); + fb.raw_tor = static_cast(((d[4] & 0x0FU) << 8) | d[5]); + if (has_ranges()) // 映射范围未知时只留原始值 + { + fb.position = dm::uint_to_float(fb.raw_pos, -_p_max, _p_max, 16U); + fb.velocity = dm::uint_to_float(fb.raw_vel, -_v_max, _v_max, 12U); + fb.torque = dm::uint_to_float(fb.raw_tor, -_t_max, _t_max, 12U); + } + fb.t_mos = d[6]; + fb.t_rotor = d[7]; + + // 由正常态进入故障态(ERR 不是失能 / 使能)时计一次、在默认树节点上记 IO_ERROR + const bool was_fault = _fb.valid && _fb.state != DmState::DISABLED && _fb.state != DmState::ENABLED; + const bool fault = fb.state != DmState::DISABLED && fb.state != DmState::ENABLED; + + taskENTER_CRITICAL(); + _fb = fb; + taskEXIT_CRITICAL(); + + _feedback_cnt = _feedback_cnt + 1U; + (void)_online.refresh_task(); + if (fault && !was_fault) + { + _fault_cnt = _fault_cnt + 1U; + (void)_state.error(Status::IO_ERROR); + } + return Status::OK; +} + +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_RX_ENABLE + +#endif // __DM_MOTOR_HPP__ diff --git a/code/protocol/emmv5_protocol.cpp b/code/device/motor/emmv5_protocol.cpp similarity index 95% rename from code/protocol/emmv5_protocol.cpp rename to code/device/motor/emmv5_protocol.cpp index d220df0..733246c 100644 --- a/code/protocol/emmv5_protocol.cpp +++ b/code/device/motor/emmv5_protocol.cpp @@ -1,4 +1,4 @@ -#include "emmv5_protocol.hpp" +#include "device/motor/emmv5_protocol.hpp" #include // memmove @@ -116,7 +116,7 @@ bool InPositionScanner::feed(uint8_t addr, const uint8_t *data, size_t size) && window[0] == addr && window[1] == IN_POSITION_MARK1 && window[2] == IN_POSITION_MARK2 - && window[3] == IN_POSITION_MARK3) + && reply_checksum_ok(window, sizeof(window), checksum)) // 0x6B 模式下即 window[3] == IN_POSITION_MARK3 { length = 0; hit = true; @@ -160,7 +160,7 @@ bool PositionScanner::feed(uint8_t addr, const uint8_t *data, size_t size, int32 window[length++] = data[i]; - if (length == sizeof(window) && window[0] == addr && window[1] == 0x36 && window[7] == CHECKSUM) + if (length == sizeof(window) && window[0] == addr && window[1] == 0x36 && reply_checksum_ok(window, sizeof(window), checksum)) { const uint32_t magnitude = (static_cast(window[3]) << 24) | (static_cast(window[4]) << 16) | (static_cast(window[5]) << 8) | static_cast(window[6]); @@ -207,7 +207,7 @@ bool StatusScanner::feed(uint8_t addr, const uint8_t *data, size_t size, uint8_t window[length++] = data[i]; - if (length == sizeof(window) && window[0] == addr && window[1] == 0x3A && window[3] == CHECKSUM) + if (length == sizeof(window) && window[0] == addr && window[1] == 0x3A && reply_checksum_ok(window, sizeof(window), checksum)) { status = window[2]; length = 0; @@ -233,9 +233,9 @@ bool StatusScanner::feed(uint8_t addr, const uint8_t *data, size_t size, uint8_t * * @note 总帧布局:地址(1) + 0xAA(1) + 总长度(2, 大端) + 子命令(N) + 0x6B(1) * 总长度包含头尾 5 字节;子命令里的地址仍是各电机自己的地址。 - * 说明书要求总帧一次发完;发送流缓冲区 128 字节下子命令最多 123 字节。 + * 说明书要求总帧一次发完;子命令最多 = 串口发送缓冲 − 5 字节(设备层按 BspUartT::TX_CAPACITY 算)。 */ -size_t build_multi_frame(uint8_t target, const uint8_t *payload, size_t payload_size, uint8_t *out, size_t out_capacity) +size_t build_multi_frame(uint8_t target, const uint8_t *payload, size_t payload_size, uint8_t *out, size_t out_capacity, Checksum checksum) { if (payload == nullptr || payload_size == 0 || out == nullptr) { @@ -257,7 +257,7 @@ size_t build_multi_frame(uint8_t target, const uint8_t *payload, size_t payload_ // payload 可能就在 out+4(调用方把子命令直接攒在总帧缓冲里),必须用 memmove memmove(out + 4U, payload, payload_size); - out[4U + payload_size] = CHECKSUM; + out[4U + payload_size] = checksum_of(out, 4U + payload_size, checksum); return total; } diff --git a/code/protocol/emmv5_protocol.hpp b/code/device/motor/emmv5_protocol.hpp similarity index 79% rename from code/protocol/emmv5_protocol.hpp rename to code/device/motor/emmv5_protocol.hpp index 9fbbd3e..683d04a 100644 --- a/code/protocol/emmv5_protocol.hpp +++ b/code/device/motor/emmv5_protocol.hpp @@ -8,7 +8,7 @@ * @copyright Copyright (c) 2026 * * @note 只把语义参数编码成字节序列:不持有串口、不建任务、不读接收缓冲。 - * 帧格式、功能码表、MMCL 布局与扫描器行为见 `emmv5_protocol.md`。 + * 帧格式、MMCL 布局与扫描器见 docs/code/device.md 的“帧编解码”一段;功能码表在 emmv5_protocol.cpp。 */ #ifndef __EMMV5_PROTOCOL_HPP__ @@ -22,7 +22,43 @@ namespace emmv5 { /* ==================== 协议常量 ==================== */ -constexpr uint8_t CHECKSUM = 0x6B; ///< 每条命令固定校验字节 +constexpr uint8_t CHECKSUM = 0x6B; ///< 默认的固定校验字节 + +/** + * @brief 校验方式(驱动器菜单 Checksum,必须和驱动器上的设置一致;N33) + * + * @note 说明书(Emm_V5.0 Rev1.3 6.2.1):0x6B = 最后一个字节固定为 0x6B(默认);XOR = 最后一个字节是前面全部字节异或 + * (含地址字节,说明书例:01 06 45 → 42)。说明书没写回复帧在 XOR 模式下用哪种校验,所以 XOR 模式下解析回复时 + * 0x6B 与 XOR 都接受。**XOR 模式未实测。** + * @note CRC-8 没有实现:说明书没给多项式 / 初值 / 示例帧,不靠猜参数实现。 + */ +enum class Checksum : uint8_t +{ + FIXED_6B = 0, ///< 固定 0x6B(驱动器出厂默认) + XOR = 1, ///< 前面全部字节异或 +}; + +/** @brief 按校验方式算出 data[0..n) 后面应跟的校验字节 */ +inline uint8_t checksum_of(const uint8_t *data, size_t n, Checksum mode) +{ + if (mode != Checksum::XOR) + { + return CHECKSUM; + } + uint8_t x = 0U; + for (size_t i = 0U; i < n; ++i) + { + x = static_cast(x ^ data[i]); + } + return x; +} + +/** @brief 回复帧的校验字节是否可接受(frame 共 size 字节,最后一个是校验);XOR 模式下 0x6B 也接受,见 Checksum */ +inline bool reply_checksum_ok(const uint8_t *frame, size_t size, Checksum mode) +{ + const uint8_t last = frame[size - 1U]; + return (last == CHECKSUM) || (mode == Checksum::XOR && last == checksum_of(frame, size - 1U, Checksum::XOR)); +} constexpr uint8_t BROADCAST = 0x00; ///< 广播地址 constexpr size_t FRAME_MAX_SIZE = 32U; ///< 单条命令的最大字节数(最长约 20 字节) @@ -93,8 +129,8 @@ enum class SystemParam : uint8_t * @brief 协议帧(值类型,可直接返回、拷贝) * * @note 只提供顺序追加接口,多字节字段按协议要求写大端。 - * 越界写入或封口后继续写入会置 `overflow`,`valid()` 随即为 false; - * 设备层发送前会统一检查 `valid()`,不会把截断帧发上总线。 + * 越界写入或封口后继续写入会置 `overflow`,`is_valid()` 随即为 false; + * 设备层发送前会统一检查 `is_valid()`,不会把截断帧发上总线。 */ struct Frame { @@ -143,8 +179,17 @@ struct Frame sealed = true; } + ///< 按校验方式改写已封口帧的最后一个字节(命令构造函数一律先按 0x6B 封口,设备层发送前再换) + void apply_checksum(Checksum mode) + { + if (is_valid()) + { + data[size - 1U] = checksum_of(data, size - 1U, mode); + } + } + ///< 是否是可直接发送的完整帧 - bool valid() const + bool is_valid() const { return sealed && !overflow && (size > 0U); } @@ -164,6 +209,7 @@ struct InPositionScanner { uint8_t window[4] = {}; ///< 滑动窗口 uint8_t length = 0; ///< 窗口当前有效字节数 + Checksum checksum = Checksum::FIXED_6B; ///< 回复帧校验方式(设备 init() 时按 Config 设置) ///< 清空窗口 void reset(); @@ -194,6 +240,7 @@ struct PositionScanner { uint8_t window[8] = {}; ///< 滑动窗口 uint8_t length = 0; ///< 窗口当前有效字节数 + Checksum checksum = Checksum::FIXED_6B; ///< 回复帧校验方式(设备 init() 时按 Config 设置) ///< 清空窗口 void reset(); @@ -221,6 +268,7 @@ struct StatusScanner { uint8_t window[4] = {}; ///< 滑动窗口 uint8_t length = 0; ///< 窗口当前有效字节数 + Checksum checksum = Checksum::FIXED_6B; ///< 回复帧校验方式(设备 init() 时按 Config 设置) ///< 清空窗口 void reset(); @@ -255,7 +303,8 @@ constexpr size_t MULTI_OVERHEAD = MULTI_PREFIX_SIZE + 1U; ///< 再加校验 * * @note 长度字段是**总帧**字节数(含头尾),大端。 */ -size_t build_multi_frame(uint8_t target, const uint8_t *payload, size_t payload_size, uint8_t *out, size_t out_capacity); +size_t build_multi_frame(uint8_t target, const uint8_t *payload, size_t payload_size, uint8_t *out, size_t out_capacity, + Checksum checksum = Checksum::FIXED_6B); ///< checksum:总帧末尾的校验方式(子命令的校验字节由调用方入队前写好) /* ==================== */ diff --git a/code/device/device_r9ds.hpp b/code/device/remote/device_r9ds.hpp similarity index 90% rename from code/device/device_r9ds.hpp rename to code/device/remote/device_r9ds.hpp index 16fd0e7..b0db857 100644 --- a/code/device/device_r9ds.hpp +++ b/code/device/remote/device_r9ds.hpp @@ -16,11 +16,11 @@ * 串口参数在 CubeMX 里配,`init()` 只做兜底校验,一个字节都不改;接收机侧要拨到 SBUS 模式。 * * @note flags = frame[23]:bit0/bit1 是数字通道 17/18,bit2 = 本帧丢失,bit3 = 失控保护激活 - * (用 `frame_lost()` / `failsafe()` 暴露;失控时怎么处置是上层的事)。 + * (用 `is_frame_lost()` / `is_failsafe()` 暴露;失控时怎么处置是上层的事)。 * - * @note 两套量别混用:`raw_channels()` 是协议原始值(上 200 / 中 1000 / 下 1800); - * `rc()` 是遥控器语义值(连续通道 −100 ~ +100,开关给挡位),**写控制逻辑用这一套**。 - * 通道表、开关判挡与死区说明见 device_r9ds.md。 + * @note 两套量别混用:`get_raw_channels()` 是协议原始值(上 200 / 中 1000 / 下 1800); + * `get_rc()` 是遥控器语义值(连续通道 −100 ~ +100,开关给挡位),**写控制逻辑用这一套**。 + * 通道表与开关挡位见下面 Switch / Rc 的注释,用法见 docs/code/device.md 的 remote/ 一节。 * * @warning 不是线程安全的:update() 只允许由一个任务调用;查询接口返回实时引用, * 读取期间不得并发执行 update()。 @@ -31,23 +31,25 @@ #ifndef __DEVICE_R9DS_HPP__ #define __DEVICE_R9DS_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 UART(HAL_UART_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_UART_MODULE_ENABLED -#include "status.hpp" +#include "service/system/state_tree.hpp" // bus_state():默认树的总线节点 +#include "service/system/status.hpp" +#include "service/system/system.hpp" // sys_state #include #include "FreeRTOS.h" // IWYU pragma: keep (pdMS_TO_TICKS) -#include "bsp_uart.hpp" // IWYU pragma: keep(BspUartT 实例化与 UART 宏) +#include "bsp/bsp_uart.hpp" // IWYU pragma: keep(BspUartT 实例化与 UART 宏) #include "task.h" // xTaskGetTickCount /** * @brief R9DS 遥控接收机设备 * - * @note 不拥有串口、不创建任务、不创建 RTOS 资源、也不注册到 Online 链表:只解析调用方喂进来的 + * @note 不拥有串口、不创建任务、不注册到 Online 链表(唯一的 RTOS 资源是 init() 建的默认树节点事件组):只解析调用方喂进来的 * 时间片,在线判定自己按 tick 算。 */ template @@ -209,20 +211,26 @@ class DeviceR9dsT bool is_online(void) const; /** @brief 遥控器语义值(**控制逻辑用这个**),实时引用:update() 在别的任务里跑时请用 snapshot() */ - const Rc &rc(void) const; + const Rc &get_rc(void) const; /** @brief 最近一帧的 16 个原始通道值(协议侧:上 200 / 中 1000 / 下 1800),下标 = 通道号 - 1 */ - const uint16_t *raw_channels(void) const; + const uint16_t *get_raw_channels(void) const; /** @brief 最近一帧的「本帧丢失」标志(frame[23] 的 bit2) */ - bool frame_lost(void) const; + bool is_frame_lost(void) const; /** @brief 最近一帧的「失控保护激活」标志(frame[23] 的 bit3) */ - bool failsafe(void) const; + bool is_failsafe(void) const; /** @brief 诊断计数快照 */ Diag get_diag(void) const; + /** + * @brief 本接收机在 EventState 默认树里的节点(第三层,挂在所用串口的总线节点下) + * @return `is_running()` = init() 成功;`get_error_bits()` 里的 TIMEOUT = 掉过线(粘滞)。掉线在 update() 里检测 + */ + const EventState &get_state(void) const { return _state; } + /** * @brief 拷贝一份同一帧的遥控器数据(临界区内拷贝,跨任务读用它,F5) * @param rc 遥控器语义值 @@ -260,6 +268,8 @@ class DeviceR9dsT bool _frame_lost = false; ///< 最近一帧 flags 的 bit2:本帧丢失 bool _failsafe = false; ///< 最近一帧 flags 的 bit3:失控保护激活 Diag _diag {}; ///< 诊断计数(frame_cnt 顺带当“收到过帧吗”的标志用) + EventState _state; ///< 默认树节点(Q6) + bool _was_online = false; ///< 上一次 update() 结束时是否在线(检测由在线变离线) uint32_t _last_frame_tick = 0U; ///< 最近一帧的 tick,is_online() 拿它算“接收机静默了多久” /* ==================== */ }; @@ -298,11 +308,20 @@ DeviceR9dsT::DeviceR9dsT(Uart &uart) : _uart(uart) template Status DeviceR9dsT::init(void) { + // 默认树第三层(Q6):挂在所用串口的总线节点下(串口不在清单里时挂 sys_state);重复调用无害 + if (_state.init() == Status::OK) + { + EventState *bus = bus_state(&_uart); + (void)_state.set_parent((bus != nullptr) ? *bus : sys_state); + } + if (!_uart.check_format(100000U, UART_WORDLENGTH_9B, UART_PARITY_EVEN, UART_STOPBITS_2)) { + (void)_state.init_error(Status::BAD_ARG); return Status::BAD_ARG; } + (void)_state.complete_init(); return Status::OK; } @@ -326,7 +345,14 @@ void DeviceR9dsT::update(uint32_t timeout_ms) // 首字节按调用方给的超时等;一旦开始解帧就一律 0,把已有数据排空 if ((_uart.receive(&byte, 1U, wait_ms, &got) != Status::OK) || (got == 0U)) { - return; // 这一拍的字节取完了 + // 这一拍的字节取完了:由在线变离线时在本节点记 TIMEOUT(构造后从没上线过的不算) + const bool online = is_online(); + if (_was_online && !online) + { + (void)_state.error(Status::TIMEOUT); + } + _was_online = online; + return; } wait_ms = 0U; // 后续字节不再等待 @@ -395,28 +421,28 @@ bool DeviceR9dsT::is_online(void) const /** @brief 遥控器语义值(控制逻辑用这个返回值),实时引用 */ template -const typename DeviceR9dsT::Rc &DeviceR9dsT::rc(void) const +const typename DeviceR9dsT::Rc &DeviceR9dsT::get_rc(void) const { return _rc; } /** @brief 最近一帧的 16 个原始通道值(协议侧) */ template -const uint16_t *DeviceR9dsT::raw_channels(void) const +const uint16_t *DeviceR9dsT::get_raw_channels(void) const { return _raw; } /** @brief 最近一帧的「本帧丢失」标志 */ template -bool DeviceR9dsT::frame_lost(void) const +bool DeviceR9dsT::is_frame_lost(void) const { return _frame_lost; } /** @brief 最近一帧的「失控保护激活」标志 */ template -bool DeviceR9dsT::failsafe(void) const +bool DeviceR9dsT::is_failsafe(void) const { return _failsafe; } diff --git a/code/device/device_bmi088.cpp b/code/device/sensor/device_bmi088.cpp similarity index 83% rename from code/device/device_bmi088.cpp rename to code/device/sensor/device_bmi088.cpp index e241c6a..f9f9812 100644 --- a/code/device/device_bmi088.cpp +++ b/code/device/sensor/device_bmi088.cpp @@ -1,19 +1,19 @@ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 SPI(HAL_SPI_MODULE_ENABLED 未定义)时,本文件不参与编译 #ifdef HAL_SPI_MODULE_ENABLED -#include "device_bmi088.hpp" -#include "system.hpp" +#include "device/sensor/device_bmi088.hpp" +#include "service/system/system.hpp" #include -#include "bsp_dwt.hpp" // 调度器启动前的忙等 -#include "hardware_config.h" +#include "bsp/bsp_dwt.hpp" // 调度器启动前的忙等 +#include "service/system/state_tree.hpp" // bus_state():默认树的总线节点 +#include "service/system/config_check.hpp" // 宿主配置(经检查) -static_assert(BMI088_TASK_PRIORITY > tskIDLE_PRIORITY && BMI088_TASK_PRIORITY < configMAX_PRIORITIES, "BMI088_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); -#include "quaternion.hpp" -#include "vqf.hpp" +#include "algorithm/quaternion.hpp" +#include "algorithm/vqf.hpp" /* ==================== 寄存器表(BMI088 数据手册 BST-BMI088-DS001) ==================== */ @@ -60,7 +60,7 @@ constexpr double GYRO_ODR_HZ[] = {2000.0, 2000.0, 1000.0, 400.0, 200.0, 100.0, 2 /** @brief 一次刷新最多补积分的陀螺仪样本数:限住内部任务单次耗时,任务被长时间饿住后不一口气补几百次 */ constexpr uint32_t ATTITUDE_MAX_GYRO_STEPS = 10U; -constexpr double RAD_TO_DEG = 180.0 / PI_D; ///< imu_definition.hpp 的 PI 是 float,精度不够 +constexpr double RAD_TO_DEG = 180.0 / ICBSP_PI; } // namespace /* ==================== */ @@ -79,6 +79,13 @@ DeviceBmi088::DeviceBmi088(BspSpiDevice &acc, BspSpiDevice &gyro, const Config & */ Status DeviceBmi088::init() { + // 默认树第三层(Q6):挂在所用 SPI 的总线节点下(总线不在清单里时挂 sys_state);重复调用无害 + if (_state.init() == Status::OK) + { + EventState *bus = bus_state(&_acc.get_bus()); + (void)_state.set_parent((bus != nullptr) ? *bus : sys_state); + } + // 运行中重新 init():先拿到刷新锁,内部任务正在做的那一帧做完、之后的帧等 init() 结束(F8) const bool scheduler = xTaskGetSchedulerState() != taskSCHEDULER_NOT_STARTED; if (_run_lock == nullptr) @@ -86,6 +93,7 @@ Status DeviceBmi088::init() _run_lock = xSemaphoreCreateMutex(); if (_run_lock == nullptr) { + (void)_state.init_error(Status::FULL); return Status::IO_ERROR; } } @@ -98,6 +106,14 @@ Status DeviceBmi088::init() { (void)xSemaphoreGive(_run_lock); } + if (st == Status::OK) + { + (void)_state.complete_init(); + } + else + { + (void)_state.init_error(st); // 运行中重新 init() 失败时降级成 error(),不清运行位 + } return st; } @@ -113,25 +129,25 @@ Status DeviceBmi088::init_locked() st = _acc.read_reg8(ACC_CHIP_ID, id); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = _acc.write_reg8(ACC_SOFTRESET, SOFTRESET_CMD); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } delay_ms(1U); st = _acc.read_reg8(ACC_CHIP_ID, id); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } // 2) 陀螺仪软复位(复位后约 30 ms 可访问) st = _gyro.write_reg8(GYRO_SOFTRESET, SOFTRESET_CMD); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } delay_ms(30U); @@ -139,60 +155,60 @@ Status DeviceBmi088::init_locked() st = _acc.read_reg8(ACC_CHIP_ID, id); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } if (id != ACC_CHIP_ID_VALUE) { - return Status::IO_ERROR; + return init_fail(Status::IO_ERROR, __LINE__); } st = _gyro.read_reg8(GYRO_CHIP_ID, id); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } if (id != GYRO_CHIP_ID_VALUE) { - return Status::IO_ERROR; + return init_fail(Status::IO_ERROR, __LINE__); } // 4) 加速度计上电:打开后等 50 ms 再切到工作模式 st = write_verify(_acc, ACC_PWR_CTRL, 0x04U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } delay_ms(50U); st = write_verify(_acc, ACC_PWR_CONF, 0x00U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } // 5) 量程与数据率 st = write_verify(_acc, ACC_CONF, static_cast(0xA0U | static_cast(_cfg.acc_odr))); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_acc, ACC_RANGE, static_cast(_cfg.acc_range)); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_RANGE, static_cast(_cfg.gyro_range)); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_BANDWIDTH, static_cast(_cfg.gyro_odr), 0x7FU); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_LPM1, 0x00U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } // 6) 数据就绪中断:加速度计 INT1、陀螺仪 INT3,推挽、高有效 @@ -201,33 +217,33 @@ Status DeviceBmi088::init_locked() st = write_verify(_acc, ACC_INT1_IO_CTRL, 0x0AU); // bit3 输出使能、bit1 高有效、bit2 = 0 推挽 if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_acc, ACC_INT_MAP_DATA, 0x04U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_INT3_INT4_IO_CONF, 0x01U, 0x0FU); // 高 4 位保留 if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_INT3_INT4_IO_MAP, 0x01U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } st = write_verify(_gyro, GYRO_INT_CTRL, 0x80U); if (st != Status::OK) { - return st; + return init_fail(st, __LINE__); } } // 7) 换算系数:加速度计满量程 = 1.5 g × 2^(range+1) _acc_scale = 1.5f * static_cast(1U << (static_cast(_cfg.acc_range) + 1U)) * GRAVITY / 32768.0f; - _gyro_scale = GYRO_FULL_SCALE_DPS[static_cast(_cfg.gyro_range)] * (PI / 180.0f) / 32768.0f; + _gyro_scale = GYRO_FULL_SCALE_DPS[static_cast(_cfg.gyro_range)] * (ICBSP_PI_F / 180.0f) / 32768.0f; // 8) 姿态解算器(只有自动刷新任务用它):第一次分配,之后重复 init() 时清空状态、从头解算 if (_cfg.auto_update && _cfg.attitude) @@ -237,7 +253,7 @@ Status DeviceBmi088::init_locked() _vqf = new (std::nothrow) VQF(1.0 / GYRO_ODR_HZ[static_cast(_cfg.gyro_odr)]); if (_vqf == nullptr) { - return Status::IO_ERROR; + return init_fail(Status::IO_ERROR, __LINE__); } } else @@ -252,9 +268,9 @@ Status DeviceBmi088::init_locked() if (_cfg.auto_update && _worker == nullptr) { TaskHandle_t worker = nullptr; - if (xTaskCreate(task_entry, "imu", BMI088_TASK_STACK, this, BMI088_TASK_PRIORITY, &worker) != pdPASS) + if (xTaskCreate(task_entry, "imu", ICBSP_BMI088_TASK_STACK, this, ICBSP_BMI088_TASK_PRIORITY, &worker) != pdPASS) { - return Status::IO_ERROR; + return init_fail(Status::IO_ERROR, __LINE__); } _worker = worker; } @@ -281,6 +297,10 @@ Status DeviceBmi088::refresh(uint32_t timeout_ms, uint32_t gyro_steps) else { _update_fail_cnt = _update_fail_cnt + 1U; + if (_init) + { + (void)_state.error(st); // 读帧失败记在本节点(向上传到 SPI 总线节点与 sys_state,不动运行位) + } } _last_status = st; return st; @@ -399,17 +419,17 @@ void DeviceBmi088::convert(const Bmi088RawData &raw, ImuData &data, float &tempe data.acc.y = static_cast(raw.acc[1]) * _acc_scale; data.acc.z = static_cast(raw.acc[2]) * _acc_scale; - data.gyro.roll = static_cast(raw.gyro[0]) * _gyro_scale; - data.gyro.pitch = static_cast(raw.gyro[1]) * _gyro_scale; - data.gyro.yaw = static_cast(raw.gyro[2]) * _gyro_scale; + data.gyro.x = static_cast(raw.gyro[0]) * _gyro_scale; + data.gyro.y = static_cast(raw.gyro[1]) * _gyro_scale; + data.gyro.z = static_cast(raw.gyro[2]) * _gyro_scale; temperature = static_cast(raw.temp) * 0.125f + 23.0f; } void DeviceBmi088::solve_attitude(ImuData &data, uint32_t gyro_steps) { - // 轴对应见文件头:gyro.roll / pitch / yaw = 绕芯片 X / Y / Z - const vqf_real_t gyr[3] = {static_cast(data.gyro.roll), static_cast(data.gyro.pitch), static_cast(data.gyro.yaw)}; + // gyro.x / y / z = 绕芯片 X / Y / Z(本体系) + const vqf_real_t gyr[3] = {static_cast(data.gyro.x), static_cast(data.gyro.y), static_cast(data.gyro.z)}; const vqf_real_t acc[3] = {static_cast(data.acc.x), static_cast(data.acc.y), static_cast(data.acc.z)}; // 漏掉的样本没有读数,按本帧角速度补积分(VQF 每次 updateGyr() 固定积分一个 ODR 周期) @@ -476,7 +496,7 @@ void DeviceBmi088::run() steps = ATTITUDE_MAX_GYRO_STEPS; } } - const Status st = refresh(SPI_TRANSFER_TIMEOUT_MS, steps); + const Status st = refresh(ICBSP_SPI_TRANSFER_TIMEOUT_MS, steps); (void)xSemaphoreGive(_run_lock); if (st == Status::OK) { @@ -539,7 +559,7 @@ void DeviceBmi088::delay_ms(uint32_t ms) if (xTaskGetSchedulerState() == taskSCHEDULER_NOT_STARTED) { // 调度器启动前不用 HAL_Delay():xTaskCreate() 之后 BASEPRI 一直挡着优先级 ≥ 5 的中断,HAL 时基优先级低于它时 tick 不走、永远等不完(A3) - if (bsp_dwt.is_init()) + if (bsp_dwt.is_initialized()) { bsp_dwt.delay_ms(static_cast(ms)); } @@ -550,8 +570,10 @@ void DeviceBmi088::delay_ms(uint32_t ms) } else { - const TickType_t ticks = pdMS_TO_TICKS(ms); - vTaskDelay(ticks > 0U ? ticks : 1U); + // vTaskDelay(n) 只等到第 n 个 tick 边界,实际时长在 (n − 1, n] ms 之间:n = 1 时可能几乎不等。 + // 芯片时序要的是“至少 ms 毫秒”(例如加速度计软复位后 1 ms 才能切回 SPI),所以多等一个 tick。 + // 阶段 3 实测:原来的 vTaskDelay(1) 让 P04(连续 200 次 init)在两次完整回归里都有 48 次读错加速度计芯片 ID。 + vTaskDelay(pdMS_TO_TICKS(ms) + 1U); } } diff --git a/code/device/device_bmi088.hpp b/code/device/sensor/device_bmi088.hpp similarity index 86% rename from code/device/device_bmi088.hpp rename to code/device/sensor/device_bmi088.hpp index ed7b696..9a7d40b 100644 --- a/code/device/device_bmi088.hpp +++ b/code/device/sensor/device_bmi088.hpp @@ -10,8 +10,8 @@ * @details BMI088 是两颗独立的芯片:加速度计与陀螺仪各有片选、各有寄存器表,挂在同一条 SPI 总线上。 * 本类绑定两个 BspSpiDevice(不拥有),负责上电配置、读数换算、姿态解算与数据就绪中断计数。 * 与 DjiMotor 一样,读数存在对象内部并由库自动刷新:Config::auto_update = true(默认)时,init() 建一个内部任务, - * 每次陀螺仪数据就绪就刷新一帧;用户直接读 snapshot() / data()(IMU 通用数据 ImuData,imu_definition.hpp)、 - * raw_data()(寄存器原始值)、temperature()(芯片温度)。 + * 每次陀螺仪数据就绪就刷新一帧;用户直接读 snapshot() / get_data()(IMU 通用数据 ImuData,imu_definition.hpp)、 + * get_raw_data()(寄存器原始值)、get_temperature()(芯片温度)。 * Config::attitude = true(默认)时,内部任务每帧再用 VQF(algorithm/vqf.hpp,六轴:陀螺仪 + 加速度计,带陀螺仪零偏估计) * 解算姿态,和 gyro / acc 一起写进 ImuData 的 quaternion / euler_angle / euler_radian。 * 安装方向旋转、温控不在这里(属于上层)。 @@ -40,8 +40,8 @@ * * // 5) 取数据(任意任务):snapshot() 拷一份同一帧的数据 * ImuData d; - * imu_bmi088.snapshot(d); // d.gyro.yaw / pitch / roll rad/s,d.acc.x / y / z m/s²,d.euler_angle 度,d.quaternion w/x/y/z - * float t = imu_bmi088.temperature(); // °C + * imu_bmi088.snapshot(d); // d.gyro.x / y / z rad/s(本体系),d.acc.x / y / z m/s²,d.euler_angle 度,d.quaternion w/x/y/z + * float t = imu_bmi088.get_temperature(); // °C * * // 6) 想跟着数据节奏走(例如姿态解算):attach_task() 后,每刷新一次就收到 UPDATED_BIT * imu_bmi088.attach_task(xTaskGetCurrentTaskHandle()); @@ -50,21 +50,21 @@ * @note 手动刷新:Config::auto_update = false 时不建任务,attach_task() 的任务在数据就绪中断里收到 ACC_DRDY_BIT / GYRO_DRDY_BIT, * 由调用方自己 update()。临时对象(测试里切量程等)必须用手动模式。手动模式不解算姿态(update() 只刷新读数)。 * @note 自动刷新的负载:每次 update() 约 75 µs(-O2)~ 140 µs(-O0);默认陀螺仪 1000 Hz(HZ1000_BW116)时约占 CPU 7.5%~14%, - * 改成 2000 Hz(HZ2000_BW230 / HZ2000_BW532)翻倍,嫌高可以再调低。任务优先级 / 栈深见 BMI088_TASK_PRIORITY / BMI088_TASK_STACK。 + * 改成 2000 Hz(HZ2000_BW230 / HZ2000_BW532)翻倍,嫌高可以再调低。任务优先级 / 栈深见 ICBSP_BMI088_TASK_PRIORITY / ICBSP_BMI088_TASK_STACK。 * 姿态解算另加每帧一次 VQF 双精度更新(H7 有双精度 FPU)。 * @warning 自动刷新的对象 init() 成功后必须存活到系统停止(内部任务持有它的指针),和 DjiMotor 一样。 * * @note 姿态(Config::attitude): * - 坐标系:VQF 的六轴姿态,参考系 z 轴竖直向上、航向(yaw 零点)为上电时任意值;没有磁力计,yaw 会随零偏估计残差慢慢漂。 - * quaternion 为“芯片本体 → 参考系”的旋转(w / x / y / z),欧拉角按 Z-Y-X(yaw → pitch → roll)分解,与 gyro.yaw / pitch / roll 同轴。 + * quaternion 为“芯片本体 → 参考系”的旋转(w / x / y / z),欧拉角按 Z-Y-X(yaw → pitch → roll)分解,与 gyro.z / y / x 同轴。 * 注意 pitch 是绕芯片 Y 轴的右手转角:芯片 X 轴朝上抬时为负。pitch = ±90° 处 yaw / roll 万向节锁,控制请用四元数(algorithm/quaternion.hpp)。 * - 节奏:VQF 按陀螺仪 ODR 的周期积分,所以只在陀螺仪数据就绪中断唤醒的那一帧解算;没有中断(没开 drdy_int、宿主没转调 EXTI) - * 时内部任务每 10 ms 超时刷新一次读数,但姿态不更新。两次刷新之间漏掉的数据就绪按最新一帧补积分,漏帧数见 attitude_skip_count()。 + * 时内部任务每 10 ms 超时刷新一次读数,但姿态不更新。两次刷新之间漏掉的数据就绪按最新一帧补积分,漏帧数见 get_attitude_skip_count()。 * - 收敛:上电后倾角约在 tauAcc(3 s)量级内收敛;陀螺仪零偏在静止约 1.5 s 后开始快速估计,静止上电最稳。 - * - data().gyro 仍是未去零偏的原始换算值;姿态内部用的是去零偏后的角速度。 + * - get_data().gyro 仍是未去零偏的原始换算值;姿态内部用的是去零偏后的角速度。 * * @note 坐标轴为芯片本体坐标(数据手册 X / Y / Z),安装方向的旋转由上层处理: - * acc.x / y / z = 芯片 X / Y / Z;gyro.roll / pitch / yaw = 绕芯片 X / Y / Z 的角速度。 + * acc.x / y / z = 芯片 X / Y / Z;gyro.x / y / z = 绕芯片 X / Y / Z 的角速度。 * @note init() 需要等待芯片复位 / 上电(共约 100 ms):调度器启动前用 DWT 忙等(bsp_dwt,不依赖 HAL 时基中断的优先级,评审 A3),之后用 vTaskDelay()。 * @warning 读写接口内部要取 SPI 总线锁、阻塞等传输完成,只能在任务上下文调用(init() 也可在调度器启动前调用)。 */ @@ -72,7 +72,7 @@ #ifndef __DEVICE_BMI088_HPP__ #define __DEVICE_BMI088_HPP__ -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) // 宿主工程没在 CubeMX 里开 SPI(HAL_SPI_MODULE_ENABLED 未定义)时,本模块整体不参与编译 #ifdef HAL_SPI_MODULE_ENABLED @@ -83,9 +83,9 @@ #include "semphr.h" // IWYU pragma: keep(_run_lock) #include "task.h" // IWYU pragma: keep(TaskHandle_t) -#include "bsp_spi.hpp" // 两个片选设备 -#include "imu_definition.hpp" // IMU 通用数据 -#include "status.hpp" // 统一状态码 +#include "bsp/bsp_spi.hpp" // 两个片选设备 +#include "service/definition/imu_definition.hpp" // IMU 通用数据 +#include "service/system/status.hpp" // 统一状态码、EventState class VQF; // algorithm/vqf.hpp:姿态解算,只在 .cpp 里用 @@ -208,7 +208,7 @@ class DeviceBmi088 * 姿态只由自动刷新任务解算(见文件头“姿态”)。 * @note 自动模式下由内部任务调用,用户一般不用调;手动调用也安全(总线锁 + 临界区),但那一帧不进姿态解算。 */ - Status update(uint32_t timeout_ms = SPI_TRANSFER_TIMEOUT_MS); + Status update(uint32_t timeout_ms = ICBSP_SPI_TRANSFER_TIMEOUT_MS); /** * @brief 拷贝一份同一帧的数据(临界区内拷贝,跨任务读用它) @@ -224,7 +224,7 @@ class DeviceBmi088 * @return 内部 ImuData 的常量引用。 * @warning 返回实时引用而非快照:自动刷新时多个字段可能来自相邻两帧;需要同一帧的数据用 snapshot()。 */ - const ImuData &data() const + const ImuData &get_data() const { return _data; } @@ -232,15 +232,15 @@ class DeviceBmi088 /** * @brief 获取 BMI088 寄存器原始值 * @return 内部 Bmi088RawData 的常量引用。 - * @warning 同 data()。 + * @warning 同 get_data()。 */ - const Bmi088RawData &raw_data() const + const Bmi088RawData &get_raw_data() const { return _raw_data; } /** @brief 芯片温度,单位:°C(芯片约每 1.28 s 更新一次;update() 成功过之前为 0) */ - float temperature() const + float get_temperature() const { return _temperature; } @@ -249,31 +249,52 @@ class DeviceBmi088 * @brief 加速度计饱和帧数:update() 读到任一轴为 32767 / -32768 的累计次数(只增不减) * @note 剧烈冲击下持续增加说明量程不够(默认 ±24 g 已是最大档)。 */ - uint32_t acc_saturation_count() const + uint32_t get_acc_saturation_count() const { return _acc_sat_cnt; } /** @brief 陀螺仪饱和帧数(同上;±2000 °/s 是最大档) */ - uint32_t gyro_saturation_count() const + uint32_t get_gyro_saturation_count() const { return _gyro_sat_cnt; } /** @brief update() 成功次数(自动 + 手动,只增不减);自动模式下约等于陀螺仪数据就绪次数 */ - uint32_t update_count() const + uint32_t get_update_count() const { return _update_cnt; } /** @brief update() 失败次数(只增不减;重新 init 期间的 NOT_INIT 也算) */ - uint32_t update_fail_count() const + uint32_t get_update_fail_count() const { return _update_fail_cnt; } /** @brief 最近一次 update() 的返回值 */ - Status last_status() const + /** + * @brief 本 IMU 在 EventState 默认树里的节点(第三层,挂在所用 SPI 的总线节点下) + * @return `is_running()` = init() 成功;`get_error_bits()` 记着出过的读帧错误(粘滞) + */ + const EventState &get_state() const + { + return _state; + } + + /** + * @brief init() 失败的诊断:失败次数与最近一次失败处的源码行号(device_bmi088.cpp),定位是哪一步出错(阶段 3) + */ + uint32_t get_init_fail_count() const + { + return _init_fail_cnt; + } + uint32_t get_init_fail_line() const + { + return _init_fail_line; + } + + Status get_last_status() const { return _last_status; } @@ -282,7 +303,7 @@ class DeviceBmi088 * @brief 姿态漏帧数:自动刷新时两次刷新之间陀螺仪数据就绪多于 1 次的累计多出次数(只增不减) * @note 漏掉的样本按最新一帧补积分,偶尔几次无妨;持续增加说明内部任务跟不上 ODR(优先级太低或 ODR 太高)。 */ - uint32_t attitude_skip_count() const + uint32_t get_attitude_skip_count() const { return _attitude_skip_cnt; } @@ -292,7 +313,7 @@ class DeviceBmi088 * @note 没解算过时 ImuData 的四元数是单位四元数、欧拉角是 0,不代表实际姿态;姿态控制要先等它为 true(F1)。 * 手动模式、Config::attitude = false 或没有陀螺仪数据就绪中断时恒为 false。 */ - bool attitude_ready() const + bool is_attitude_ready() const { return _attitude_ready; } @@ -309,7 +330,7 @@ class DeviceBmi088 /** * @brief 加速度计数据就绪(INT1 上升沿,宿主 EXTI 回调里转调):计数;手动模式下通知绑定的任务 - * @note 自动模式只按陀螺仪节奏刷新,这个中断只计数(acc_drdy_count()):不需要计数时宿主可以不转调, + * @note 自动模式只按陀螺仪节奏刷新,这个中断只计数(get_acc_drdy_count()):不需要计数时宿主可以不转调, * 或者在 CubeMX 里不开 INT1 对应的 EXTI,省掉每秒约 1600 次中断(F8)。 */ void on_acc_drdy_isr(BaseType_t *pxHigherPriorityTaskWoken); @@ -318,13 +339,13 @@ class DeviceBmi088 void on_gyro_drdy_isr(BaseType_t *pxHigherPriorityTaskWoken); /** @brief 加速度计数据就绪中断累计次数 */ - uint32_t acc_drdy_count() const + uint32_t get_acc_drdy_count() const { return _acc_drdy_cnt; } /** @brief 陀螺仪数据就绪中断累计次数 */ - uint32_t gyro_drdy_count() const + uint32_t get_gyro_drdy_count() const { return _gyro_drdy_cnt; } @@ -332,7 +353,7 @@ class DeviceBmi088 /* ==================== */ private: - /** @brief 等 ms 毫秒:调度器启动前 DWT 忙等(bsp_dwt 没起来时退回 HAL_Delay()),之后 vTaskDelay() */ + /** @brief 至少等 ms 毫秒:调度器启动前 DWT 忙等(bsp_dwt 没起来时退回 HAL_Delay()),之后 vTaskDelay(ticks + 1)(vTaskDelay(n) 可能只等 n − 1 ms 多一点) */ static void delay_ms(uint32_t ms); /** @@ -379,6 +400,17 @@ class DeviceBmi088 volatile uint32_t _update_cnt = 0U; ///< update() 成功次数 volatile uint32_t _update_fail_cnt = 0U; ///< update() 失败次数 + EventState _state; ///< 默认树节点(Q6) + volatile uint32_t _init_fail_cnt = 0U; ///< init() 失败次数 + volatile uint32_t _init_fail_line = 0U; ///< 最近一次失败处的源码行号 + + /** @brief 记下失败位置后原样返回状态码 */ + Status init_fail(Status st, uint32_t line) + { + _init_fail_cnt = _init_fail_cnt + 1U; + _init_fail_line = line; + return st; + } volatile Status _last_status = Status::OK; ///< 最近一次 update() 的结果 volatile uint32_t _attitude_skip_cnt = 0U; ///< 姿态漏帧数 volatile bool _attitude_ready = false; ///< 自 init() 起是否解算过姿态 diff --git a/code/service/can_rx_node.hpp b/code/service/comm/can_rx_node.hpp similarity index 90% rename from code/service/can_rx_node.hpp rename to code/service/comm/can_rx_node.hpp index 55a11cb..0cfb4dc 100644 --- a/code/service/can_rx_node.hpp +++ b/code/service/comm/can_rx_node.hpp @@ -1,15 +1,15 @@ #ifndef CAN_RX_NODE_HPP #define CAN_RX_NODE_HPP -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) -#include "hardware_config.h" +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "service/system/config_check.hpp" // 宿主配置(经检查) -// 宿主工程没在 CubeMX 里开 FDCAN 或 CAN_RX_ENABLE=0 时,本模块整体不参与编译 -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_RX_ENABLE +// 宿主工程没在 CubeMX 里开 FDCAN 或 ICBSP_CAN_RX_ENABLE=0 时,本模块整体不参与编译 +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_RX_ENABLE -#include "bsp_can.hpp" -#include "status.hpp" -#include "system.hpp" +#include "bsp/bsp_can.hpp" +#include "service/system/status.hpp" +#include "service/system/system.hpp" #include @@ -92,7 +92,7 @@ CanRxNodeT *CanRxNodeT::regist(CanT &can_item, uint32_t can_id, Call return nullptr; } } - if (_num >= CAN_RX_NODE_MAX) + if (_num >= ICBSP_CAN_RX_NODE_MAX) { sys_state.init_error(Status::FULL); return nullptr; @@ -167,6 +167,6 @@ uint32_t CanRxNodeT::count_for(const CanT &can_item) return count; } -#endif // HAL_FDCAN_MODULE_ENABLED && CAN_RX_ENABLE +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_RX_ENABLE #endif // CAN_RX_NODE_HPP diff --git a/code/service/can_tx_node.hpp b/code/service/comm/can_tx_node.hpp similarity index 87% rename from code/service/can_tx_node.hpp rename to code/service/comm/can_tx_node.hpp index 8452a64..4b372d2 100644 --- a/code/service/can_tx_node.hpp +++ b/code/service/comm/can_tx_node.hpp @@ -1,15 +1,15 @@ #ifndef CAN_TX_NODE_HPP #define CAN_TX_NODE_HPP -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) -#include "hardware_config.h" +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "service/system/config_check.hpp" // 宿主配置(经检查) -// 宿主工程没在 CubeMX 里开 FDCAN 或 CAN_TX_ENABLE=0 时,本模块整体不参与编译 -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_TX_ENABLE +// 宿主工程没在 CubeMX 里开 FDCAN 或 ICBSP_CAN_TX_ENABLE=0 时,本模块整体不参与编译 +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_TX_ENABLE -#include "bsp_can.hpp" -#include "status.hpp" -#include "system.hpp" +#include "bsp/bsp_can.hpp" +#include "service/system/status.hpp" +#include "service/system/system.hpp" #include "FreeRTOS.h" // IWYU pragma: keep #include "semphr.h" @@ -18,9 +18,6 @@ #include #include -#ifndef CAN_TX_GATHER_MS -# error "hardware_config.h 缺少 CAN_TX_GATHER_MS(共帧槽位凑不齐时最多等多久就发),见 templates/user/board/hardware_config.h" -#endif /** * @brief CAN 发送节点:一帧 8 字节分成若干槽位,由不同设备分别填写,聚合成一帧发送(例如 4 个 M3508 共用 0x200) @@ -29,9 +26,9 @@ * * @note 发送时机(can_tx_task 每 1 ms 调 service()): * - **凑齐即发**:所有“有效”槽位都被重新填写过(过期的、注册了却从没填过的槽位不算,见下); - * - **凑不齐时限**:有槽位填了新数据、等了 CAN_TX_GATHER_MS 还没凑齐,也发(计入 partial_sends); - * - **保底心跳**:CAN_TX_HEARTBEAT_MS 内没发过就发一次当前内容(计入 heartbeat_sends)。 - * 槽位 CAN_CMD_EXPIRE_MS 没被刷新就清零并标为“过期”,过期槽位不再拖住“凑齐即发”(评审 F3)。 + * - **凑不齐时限**:有槽位填了新数据、等了 ICBSP_CAN_TX_GATHER_MS 还没凑齐,也发(计入 partial_sends); + * - **保底心跳**:ICBSP_CAN_TX_HEARTBEAT_MS 内没发过就发一次当前内容(计入 heartbeat_sends)。 + * 槽位 ICBSP_CAN_CMD_EXPIRE_MS 没被刷新就清零并标为“过期”,过期槽位不再拖住“凑齐即发”(评审 F3)。 * @note 发送用 send_latest():同 ID 的上一帧还没发出去时这一帧不入队(BUSY),下个周期发最新内容; * 总线被更高优先级流量占满时,一个节点最多在驱动里占一帧,不会堵住别的帧。 * @note 注册只在初始化阶段(system_start() 之前);运行态之后 regist() 直接返回 nullptr,不记初始化错误。 @@ -44,7 +41,7 @@ class CanTxNodeT struct Stats { uint32_t sent; ///< 发出的帧数 - uint32_t partial_sends; ///< 凑不齐、按 CAN_TX_GATHER_MS 时限发出的帧数(大于 0 说明同帧设备的刷新节拍不一致) + uint32_t partial_sends; ///< 凑不齐、按 ICBSP_CAN_TX_GATHER_MS 时限发出的帧数(大于 0 说明同帧设备的刷新节拍不一致) uint32_t heartbeat_sends; ///< 没有新数据、只靠保底心跳发出的帧数 uint32_t expired; ///< 槽位过期被清零的次数 }; @@ -79,7 +76,7 @@ class CanTxNodeT static void service(CanT &can_item); /** @brief 写入一个槽位的数据(8 / division 字节);返回 OK 表示已刷新 */ - Status filldata(uint8_t data[], uint8_t slot = 0); + Status fill_data(uint8_t data[], uint8_t slot = 0); /** @brief 发送统计 */ Stats get_stats() const @@ -103,7 +100,7 @@ class CanTxNodeT CanT *_can; CanTxNodeT *next; - static constexpr uint32_t CMD_EXPIRE_MS = CAN_CMD_EXPIRE_MS; + static constexpr uint32_t CMD_EXPIRE_MS = ICBSP_CAN_CMD_EXPIRE_MS; static inline CanTxNodeT *_head = nullptr; static inline uint32_t _num = 0U; @@ -192,12 +189,13 @@ CanTxNodeT *CanTxNodeT::regist(CanT &can_item, uint32_t can_id, uint node->bufferRegister |= static_cast(1U << slot); return node; } - sys_state.init_error(Status::FULL); + // 同一帧的槽位已被占用或分段数不一致:资源冲突,不是容量问题(评审 I7:原来报 FULL) + sys_state.init_error(Status::BUSY); return nullptr; } } - if (_num >= CAN_TX_NODE_MAX) + if (_num >= ICBSP_CAN_TX_NODE_MAX) { sys_state.init_error(Status::FULL); return nullptr; @@ -303,8 +301,8 @@ void CanTxNodeT::service(CanT &can_item) const uint8_t active = static_cast(node->bufferRegister & ~node->bufferExpired); // 在被刷新的槽位 const bool fresh = (node->bufferUnsend & node->bufferRegister) != 0U; const bool ready = active != 0U && (node->bufferUnsend & active) == active; - const bool timeout = fresh && now - node->first_unsend_tick >= pdMS_TO_TICKS(CAN_TX_GATHER_MS); - const bool due = now - node->last_send_tick >= pdMS_TO_TICKS(CAN_TX_HEARTBEAT_MS); + const bool timeout = fresh && now - node->first_unsend_tick >= pdMS_TO_TICKS(ICBSP_CAN_TX_GATHER_MS); + const bool due = now - node->last_send_tick >= pdMS_TO_TICKS(ICBSP_CAN_TX_HEARTBEAT_MS); if ((ready || timeout || due) && can_item.send_latest(node->txBuffer.id, node->txBuffer.data, node->txBuffer.dlc, node->txBuffer.id_type) == Status::OK) { @@ -328,7 +326,7 @@ void CanTxNodeT::service(CanT &can_item) } template -Status CanTxNodeT::filldata(uint8_t data[], uint8_t slot) +Status CanTxNodeT::fill_data(uint8_t data[], uint8_t slot) { if (_statu != Status::OK || !_registered) { @@ -360,6 +358,6 @@ Status CanTxNodeT::filldata(uint8_t data[], uint8_t slot) return Status::OK; } -#endif // HAL_FDCAN_MODULE_ENABLED && CAN_TX_ENABLE +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_TX_ENABLE #endif // CAN_TX_NODE_HPP diff --git a/code/service/imu_definition.hpp b/code/service/definition/imu_definition.hpp similarity index 75% rename from code/service/imu_definition.hpp rename to code/service/definition/imu_definition.hpp index 42e6dd3..30a94e9 100644 --- a/code/service/imu_definition.hpp +++ b/code/service/definition/imu_definition.hpp @@ -9,15 +9,13 @@ * 协议原始值和器件配置由具体 IMU 类型自行定义(如 BMI088 的 Bmi088RawData)。 * @note 不同器件能填的字段不同:自带姿态解算的器件全部字段都填;只有原始传感器的器件由驱动自己解算 * (BMI088 在自动刷新且 Config::attitude 时用 VQF 解算,否则只填 gyro / acc,欧拉角保持 0、四元数保持单位四元数,不代表实际姿态; - * BMI088 用 attitude_ready() 区分)。 + * BMI088 用 is_attitude_ready() 区分)。 * 温度等并非所有器件都有的数据,放在具体器件自己的数据里。 */ #ifndef __IMU_DEFINITION_HPP__ #define __IMU_DEFINITION_HPP__ -#ifndef PI -#define PI 3.1415926f -#endif // PI +#include "algorithm/math_constants.hpp" // IWYU pragma: export(ICBSP_PI / ICBSP_PI_F;原来的 PI 宏已删除,评审 I6) /** * @brief 单个 IMU 的通用数据 @@ -26,11 +24,16 @@ */ struct ImuData { - struct Gyro{ - double yaw; - double pitch; - double roll; - }gyro; // 角速度,单位:rad/s + /** + * @brief 角速度,单位:rad/s,**传感器本体系**(绕器件自己的 X / Y / Z 轴) + * @note 评审 I5:原来叫 yaw / pitch / roll,安装方向一旋转名字就和含义对不上;欧拉角速率请从姿态现算 + */ + struct Gyro + { + double x; ///< 绕本体 X 轴 + double y; ///< 绕本体 Y 轴 + double z; ///< 绕本体 Z 轴 + } gyro; struct Acceleration{ double x,y,z; diff --git a/code/service/motor_definition.hpp b/code/service/definition/motor_definition.hpp similarity index 93% rename from code/service/motor_definition.hpp rename to code/service/definition/motor_definition.hpp index 4f77fb9..f5e2ce5 100644 --- a/code/service/motor_definition.hpp +++ b/code/service/definition/motor_definition.hpp @@ -11,9 +11,7 @@ #ifndef __MOTOR_DEFINITION_HPP__ #define __MOTOR_DEFINITION_HPP__ -#ifndef PI -# define PI 3.1415926f -#endif // PI +#include "algorithm/math_constants.hpp" // IWYU pragma: export(ICBSP_PI / ICBSP_PI_F;原来的 PI 宏已删除,评审 I6) /** * @brief 单个电机经过机械传动换算后的通用运动学数据 diff --git a/code/service/online_check.cpp b/code/service/monitor/online_check.cpp similarity index 76% rename from code/service/online_check.cpp rename to code/service/monitor/online_check.cpp index 91b35fb..910fdbd 100644 --- a/code/service/online_check.cpp +++ b/code/service/monitor/online_check.cpp @@ -1,4 +1,4 @@ -#include "online_check.hpp" +#include "service/monitor/online_check.hpp" #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" @@ -117,13 +117,18 @@ Status Online::refresh_isr(void) } -Status Online::is_online(void) const +bool Online::is_online(void) const { const ScopedTaskCritical lock; - return _statu; + return _statu == Status::OK; } +void Online::set_state(EventState *state) +{ + _state = state; +} + Status Online::update(void) { // 链表只在任务里增删(构造 / 析构):挂起调度器就能安全遍历,中断照常响应。 @@ -136,10 +141,19 @@ Status Online::update(void) } for (Online *item = _head; item != nullptr; item = item->_next) { - const ScopedTaskCritical lock; - const TickType_t now = xTaskGetTickCount(); - const bool timed_out = (now - item->_last_refresh_tick) >= pdMS_TO_TICKS(item->_timeout_gap); - item->_statu = timed_out ? Status::TIMEOUT : Status::OK; + bool dropped = false; // 本轮由在线变成离线 + { + const ScopedTaskCritical lock; + const TickType_t now = xTaskGetTickCount(); + const bool timed_out = (now - item->_last_refresh_tick) >= pdMS_TO_TICKS(item->_timeout_gap); + dropped = timed_out && (item->_statu == Status::OK); + item->_statu = timed_out ? Status::TIMEOUT : Status::OK; + } + // 事件组 API 不能在临界区里调;挂起调度器时可以(它内部也是挂起调度器,可嵌套) + if (dropped && (item->_state != nullptr)) + { + (void)item->_state->error(Status::TIMEOUT); + } } if (scheduler) { diff --git a/code/service/online_check.hpp b/code/service/monitor/online_check.hpp similarity index 73% rename from code/service/online_check.hpp rename to code/service/monitor/online_check.hpp index cf7897d..894cace 100644 --- a/code/service/online_check.hpp +++ b/code/service/monitor/online_check.hpp @@ -17,7 +17,7 @@ #define __SERVICE_ONLINE_CHECK_HPP__ #include "FreeRTOS.h" // IWYU pragma: keep (TickType_t / pdMS_TO_TICKS) -#include "status.hpp" +#include "service/system/status.hpp" #include @@ -32,6 +32,7 @@ class Online TickType_t _last_refresh_tick; ///< 上次有效刷新的 tick uint16_t _timeout_gap; ///< 离线判定阈值,单位:毫秒 Status _statu; ///< Status::OK 表示在线,Status::TIMEOUT 表示离线 + EventState *_state = nullptr; ///< 设备的 EventState 节点(可选):由在线变离线时在它上面记 TIMEOUT Online *_next; ///< 内部单向链表的后继节点 static Online *_head; ///< 在线检查链表头 @@ -66,15 +67,26 @@ class Online /** * @brief 查询最近一次计算得到的在线状态 - * @return Status::OK 设备在线;Status::TIMEOUT 设备已超时离线 + * @return true = 在线;false = 已超时离线(构造后还没收到过数据也是 false) + * @note 阶段 2.7 前返回 Status(OK = 在线):`if (x.is_online())` 会在离线时成立,所以改成 bool(Q10:布尔查询用 is_) */ - Status is_online(void) const; + bool is_online(void) const; + + /** + * @brief 关联设备的 EventState 节点(默认树的第三层,Q6) + * @param state 设备节点;nullptr = 取消关联 + * @note 之后每次由在线变成离线,update() 在该节点上记一次 Status::TIMEOUT(向上传到总线节点与 sys_state,不动运行位)。 + * 构造后从没收到过数据的“离线”不算掉线,不记。节点必须比本对象活得久。 + * @note 只在初始化期调用(不与 update() 并发)。 + */ + void set_state(EventState *state); /** * @brief 推进全部在线检查节点的离线计时 * @return Status::OK 遍历完成 * @note 只能在单个周期任务中调用(当前为 sys_task,10 ms 一次),不能在 ISR 中调用。 * @note 遍历期间挂起调度器,每个节点单独进出一次临界区:关中断时间与节点数无关。 + * @note 掉线(由在线变离线)的节点若关联了 EventState,出临界区后在它上面记 TIMEOUT。 */ static Status update(void); diff --git a/code/service/system/config_check.hpp b/code/service/system/config_check.hpp new file mode 100644 index 0000000..4ad7a63 --- /dev/null +++ b/code/service/system/config_check.hpp @@ -0,0 +1,155 @@ +/** + * @file config_check.hpp + * @brief 库读取宿主配置的唯一入口:包含 hardware_config.h,补齐派生开关,检查缺宏、依赖和取值范围 + * + * @details + * 库内**不直接**包含 `hardware_config.h`,一律包含本文件(Q3)。这样: + * - 宿主少写了某个宏,报错直接说缺哪个、去哪里抄(库升级新增宏时同样适用); + * - 范围检查在库里,宿主把模板末尾的检查删掉也照样生效; + * - 对应 HAL 模块没开时,功能开关在这里强制置 0,库内各处只看开关本身。 + * + * 顺序:① 缺宏 `#error` → ② HAL 模块没开时强制关 → ③ 开关之间的依赖 → ④ 取值范围。 + * + * @note 分层:bsp 也要读配置,所以本文件和 `status_code.hpp` 一样,是各层都能包含的公共头 + * (`tools/check_layers.py` 的例外清单)。本文件只依赖 HAL(经 bsp_series.hpp)与 FreeRTOS 的配置头。 + */ + +#ifndef __SERVICE_CONFIG_CHECK_HPP__ +#define __SERVICE_CONFIG_CHECK_HPP__ + +#include "FreeRTOS.h" // IWYU pragma: keep(configMAX_PRIORITIES) +#include "task.h" // IWYU pragma: keep(tskIDLE_PRIORITY) + +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL_*_MODULE_ENABLED、ICBSP_CAN_MODULE_ENABLED、ICBSP_UART_HAS_FIFO) +#include "hardware_config.h" // IWYU pragma: export(宿主提供的唯一配置源) + +/* ==================== */ +/* ==================== ① 缺宏 ==================== */ + +#ifndef ICBSP_SYS_TASK_ENABLE +# error "hardware_config.h 缺少 ICBSP_SYS_TASK_ENABLE(功能开关:sys_task),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_RX_ENABLE +# error "hardware_config.h 缺少 ICBSP_CAN_RX_ENABLE(功能开关:CAN 接收路径),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TX_ENABLE +# error "hardware_config.h 缺少 ICBSP_CAN_TX_ENABLE(功能开关:CAN 发送路径),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_UART_PATROL_ENABLE +# error "hardware_config.h 缺少 ICBSP_UART_PATROL_ENABLE(功能开关:串口巡检),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_SYS_TASK_PRIORITY +# error "hardware_config.h 缺少 ICBSP_SYS_TASK_PRIORITY,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_SYS_TASK_STACK +# error "hardware_config.h 缺少 ICBSP_SYS_TASK_STACK,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TASK_PRIORITY +# error "hardware_config.h 缺少 ICBSP_CAN_TASK_PRIORITY,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TASK_STACK +# error "hardware_config.h 缺少 ICBSP_CAN_TASK_STACK,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_RX_RETURN_FRAMES +# error "hardware_config.h 缺少 ICBSP_CAN_RX_RETURN_FRAMES(回退缓冲深度,0 = 不建回退缓冲),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_RX_DISPATCH_PER_TICK +# error "hardware_config.h 缺少 ICBSP_CAN_RX_DISPATCH_PER_TICK,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_RX_NODE_MAX +# error "hardware_config.h 缺少 ICBSP_CAN_RX_NODE_MAX,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TX_NODE_MAX +# error "hardware_config.h 缺少 ICBSP_CAN_TX_NODE_MAX,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_CMD_EXPIRE_MS +# error "hardware_config.h 缺少 ICBSP_CAN_CMD_EXPIRE_MS,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TX_HEARTBEAT_MS +# error "hardware_config.h 缺少 ICBSP_CAN_TX_HEARTBEAT_MS,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_TX_GATHER_MS +# error "hardware_config.h 缺少 ICBSP_CAN_TX_GATHER_MS(共帧槽位凑不齐时最多等多久就发),见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_CAN_BUSOFF_RETRY_MS +# error "hardware_config.h 缺少 ICBSP_CAN_BUSOFF_RETRY_MS,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_UART_ENABLE_FIFO +# error "hardware_config.h 缺少 ICBSP_UART_ENABLE_FIFO,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_SPI_DMA_BUFFER_SIZE +# error "hardware_config.h 缺少 ICBSP_SPI_DMA_BUFFER_SIZE,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_SPI_TRANSFER_TIMEOUT_MS +# error "hardware_config.h 缺少 ICBSP_SPI_TRANSFER_TIMEOUT_MS,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_BMI088_TASK_PRIORITY +# error "hardware_config.h 缺少 ICBSP_BMI088_TASK_PRIORITY,见 templates/user/board/hardware_config.h" +#endif +#ifndef ICBSP_BMI088_TASK_STACK +# error "hardware_config.h 缺少 ICBSP_BMI088_TASK_STACK,见 templates/user/board/hardware_config.h" +#endif + +/* ==================== */ +/* ==================== ② HAL 模块没开时强制关 ==================== */ + +/* 取值先查一遍:后面要 #undef 重定义,宿主写的非法值(例如 2)在这之前拦下 */ +#ifdef __cplusplus +static_assert(ICBSP_SYS_TASK_ENABLE == 0 || ICBSP_SYS_TASK_ENABLE == 1, "hardware_config.h: ICBSP_SYS_TASK_ENABLE 取 0 或 1"); +static_assert(ICBSP_CAN_RX_ENABLE == 0 || ICBSP_CAN_RX_ENABLE == 1, "hardware_config.h: ICBSP_CAN_RX_ENABLE 取 0 或 1"); +static_assert(ICBSP_CAN_TX_ENABLE == 0 || ICBSP_CAN_TX_ENABLE == 1, "hardware_config.h: ICBSP_CAN_TX_ENABLE 取 0 或 1"); +static_assert(ICBSP_UART_PATROL_ENABLE == 0 || ICBSP_UART_PATROL_ENABLE == 1, "hardware_config.h: ICBSP_UART_PATROL_ENABLE 取 0 或 1"); +static_assert(ICBSP_UART_ENABLE_FIFO == 0 || ICBSP_UART_ENABLE_FIFO == 1, "hardware_config.h: ICBSP_UART_ENABLE_FIFO 取 0 或 1"); +#endif + +/* CubeMX 里没开 CAN(H7 的 FDCAN / F4 的 bxCAN):CAN 收发路径没有可用的外设 */ +#if !ICBSP_CAN_MODULE_ENABLED +# undef ICBSP_CAN_RX_ENABLE +# undef ICBSP_CAN_TX_ENABLE +# define ICBSP_CAN_RX_ENABLE 0 +# define ICBSP_CAN_TX_ENABLE 0 +#endif + +/* CubeMX 里没开 UART:没有可巡检的串口 */ +#ifndef HAL_UART_MODULE_ENABLED +# undef ICBSP_UART_PATROL_ENABLE +# define ICBSP_UART_PATROL_ENABLE 0 +#endif + +/* ==================== */ +/* ==================== ③ 开关之间的依赖 ==================== */ + +#ifdef __cplusplus +static_assert(ICBSP_SYS_TASK_ENABLE || !ICBSP_UART_PATROL_ENABLE, + "hardware_config.h: 串口巡检在 sys_task 里跑,ICBSP_UART_PATROL_ENABLE = 1 需要 ICBSP_SYS_TASK_ENABLE = 1"); +static_assert(ICBSP_UART_HAS_FIFO != 0 || ICBSP_UART_ENABLE_FIFO == 0, + "hardware_config.h: 本系列(F4)没有 UART 硬件 FIFO,ICBSP_UART_ENABLE_FIFO 必须为 0"); +#endif + +/* ==================== */ +/* ==================== ④ 取值范围 ==================== */ + +#ifdef __cplusplus +static_assert(ICBSP_SYS_TASK_PRIORITY > tskIDLE_PRIORITY && ICBSP_SYS_TASK_PRIORITY < configMAX_PRIORITIES, + "hardware_config.h: ICBSP_SYS_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); +static_assert(ICBSP_CAN_TASK_PRIORITY > tskIDLE_PRIORITY && ICBSP_CAN_TASK_PRIORITY < configMAX_PRIORITIES, + "hardware_config.h: ICBSP_CAN_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); +static_assert(ICBSP_CAN_TASK_PRIORITY > ICBSP_SYS_TASK_PRIORITY, "hardware_config.h: CAN 收发任务要比 sys_task 优先:1 kHz 节拍内必须跑完"); +static_assert(ICBSP_BMI088_TASK_PRIORITY > tskIDLE_PRIORITY && ICBSP_BMI088_TASK_PRIORITY < configMAX_PRIORITIES, + "hardware_config.h: ICBSP_BMI088_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); +static_assert(ICBSP_SYS_TASK_STACK >= 128 && ICBSP_CAN_TASK_STACK >= 128 && ICBSP_BMI088_TASK_STACK >= 128, + "hardware_config.h: 库任务栈深至少 128 字"); +static_assert(ICBSP_CAN_RX_RETURN_FRAMES >= 0, "hardware_config.h: ICBSP_CAN_RX_RETURN_FRAMES 不能为负(0 = 不建回退缓冲)"); +static_assert(ICBSP_CAN_RX_DISPATCH_PER_TICK >= 1 && ICBSP_CAN_RX_DISPATCH_PER_TICK <= 64, "hardware_config.h: ICBSP_CAN_RX_DISPATCH_PER_TICK 取 1~64"); +static_assert(ICBSP_CAN_RX_NODE_MAX >= 1 && ICBSP_CAN_RX_NODE_MAX <= 255, "hardware_config.h: ICBSP_CAN_RX_NODE_MAX 取 1~255"); +static_assert(ICBSP_CAN_TX_NODE_MAX >= 1 && ICBSP_CAN_TX_NODE_MAX <= 255, "hardware_config.h: ICBSP_CAN_TX_NODE_MAX 取 1~255"); +static_assert(ICBSP_CAN_TX_HEARTBEAT_MS >= 1, "hardware_config.h: ICBSP_CAN_TX_HEARTBEAT_MS 至少 1 ms"); +static_assert(ICBSP_CAN_CMD_EXPIRE_MS > ICBSP_CAN_TX_HEARTBEAT_MS, "hardware_config.h: 指令有效期必须长于保底心跳"); +static_assert(ICBSP_CAN_TX_GATHER_MS >= 1 && ICBSP_CAN_TX_GATHER_MS < ICBSP_CAN_TX_HEARTBEAT_MS, + "hardware_config.h: ICBSP_CAN_TX_GATHER_MS 取 1 ~ 心跳周期 - 1"); +static_assert(ICBSP_CAN_BUSOFF_RETRY_MS >= 10, "hardware_config.h: ICBSP_CAN_BUSOFF_RETRY_MS 至少 10 ms(sys_task 每 10 ms 检查一次)"); +static_assert(ICBSP_SPI_DMA_BUFFER_SIZE >= 16 && ICBSP_SPI_DMA_BUFFER_SIZE <= 65535, "hardware_config.h: ICBSP_SPI_DMA_BUFFER_SIZE 取 16~65535"); +static_assert(ICBSP_SPI_TRANSFER_TIMEOUT_MS >= 1, "hardware_config.h: ICBSP_SPI_TRANSFER_TIMEOUT_MS 至少 1 ms"); +#endif + +#endif // __SERVICE_CONFIG_CHECK_HPP__ diff --git a/code/service/fault_record.cpp b/code/service/system/fault_record.cpp similarity index 98% rename from code/service/fault_record.cpp rename to code/service/system/fault_record.cpp index bd4b6bd..eb4bda2 100644 --- a/code/service/fault_record.cpp +++ b/code/service/system/fault_record.cpp @@ -1,7 +1,7 @@ -#include "fault_record.hpp" +#include "service/system/fault_record.hpp" #include "FreeRTOS.h" // IWYU pragma: keep (taskDISABLE_INTERRUPTS / configMAX_TASK_NAME_LEN) -#include "bsp_series.hpp" // IWYU pragma: keep (CoreDebug / __BKPT / __get_IPSR) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep (CoreDebug / __BKPT / __get_IPSR) #include "task.h" #include // offsetof diff --git a/code/service/fault_record.hpp b/code/service/system/fault_record.hpp similarity index 100% rename from code/service/fault_record.hpp rename to code/service/system/fault_record.hpp diff --git a/code/service/newlib_lock.cpp b/code/service/system/newlib_lock.cpp similarity index 96% rename from code/service/newlib_lock.cpp rename to code/service/system/newlib_lock.cpp index fa5faf3..161160d 100644 --- a/code/service/newlib_lock.cpp +++ b/code/service/system/newlib_lock.cpp @@ -15,7 +15,7 @@ #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" -#include "bsp_series.hpp" // IWYU pragma: keep(__get_IPSR) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(__get_IPSR) struct _reent; diff --git a/code/service/system/state_tree.cpp b/code/service/system/state_tree.cpp new file mode 100644 index 0000000..538cfdb --- /dev/null +++ b/code/service/system/state_tree.cpp @@ -0,0 +1,160 @@ +#include "service/system/state_tree.hpp" + +#include "board_instances.hpp" +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关、ICBSP_CAN_MODULE_ENABLED) +#include "service/system/system.hpp" // sys_state + +#include + +// 三张清单按 HAL 模块开关取舍:没开的外设没有实例类型,清单也不能展开 +#if ICBSP_CAN_MODULE_ENABLED +# define TREE_CAN(X) ICBSP_CAN_INSTANCES(X) +#else +# define TREE_CAN(X) +#endif +#ifdef HAL_UART_MODULE_ENABLED +# define TREE_UART(X) ICBSP_UART_INSTANCES(X) +#else +# define TREE_UART(X) +#endif +#ifdef HAL_SPI_MODULE_ENABLED +# define TREE_SPI(X) ICBSP_SPI_INSTANCES(X) +#else +# define TREE_SPI(X) +#endif + +namespace +{ +#define TREE_COUNT_ONE(name) +1U +constexpr unsigned NODE_COUNT = 0U TREE_CAN(TREE_COUNT_ONE) TREE_UART(TREE_COUNT_ONE) TREE_SPI(TREE_COUNT_ONE); +#undef TREE_COUNT_ONE +constexpr unsigned NODE_SLOTS = (NODE_COUNT > 0U) ? NODE_COUNT : 1U; // 零长数组不合法 + +/** @brief 一个实例按错误码归类的计数和(只增不减,比较时用 != 处理回绕) */ +struct ErrCounts +{ + uint32_t io; + uint32_t full; + uint32_t timeout; + uint32_t busy; +}; + +EventState nodes[NODE_SLOTS]; ///< 总线节点,顺序 = CAN 清单、UART 清单、SPI 清单 +ErrCounts last_counts[NODE_SLOTS]; ///< 上一次 poll 时的计数 + +template ErrCounts can_counts(const Can &can) +{ + const auto &d = can.diagnostics; + return {d.bus_off_events, + d.rx_dropped + d.rx_lost + d.rx_return_dropped + d.tx_dropped + d.tx_buf_full + d.tx_flushed, + d.tx_stall_recover, + 0U}; +} + +template ErrCounts uart_counts(const Uart &uart) +{ + const auto rx = uart.get_rx_diag(); + const auto tx = uart.get_tx_diag(); + return {rx.hw_error_cnt + rx.error_cnt + tx.error_cnt, rx.drop_bytes + tx.drop_bytes, tx.stall_recover_cnt, 0U}; +} + +template ErrCounts spi_counts(const Spi &spi) +{ + const auto d = spi.get_diag(); + return {d.error_cnt, 0U, d.timeout_cnt, d.lock_timeout_cnt}; +} + +/** @brief 某一类计数涨了就在节点上记对应的错误码(向上传到 sys_state,不动运行位) */ +void check(unsigned index, const ErrCounts &now) +{ + ErrCounts &last = last_counts[index]; + if (now.io != last.io) + { + (void)nodes[index].error(Status::IO_ERROR); + } + if (now.full != last.full) + { + (void)nodes[index].error(Status::FULL); + } + if (now.timeout != last.timeout) + { + (void)nodes[index].error(Status::TIMEOUT); + } + if (now.busy != last.busy) + { + (void)nodes[index].error(Status::BUSY); + } + last = now; +} + +/** @brief 取全部实例的当前计数,按清单顺序交给 fn(index, counts) */ +template void for_each_counts(Fn fn) +{ + (void)fn; // 三张清单都为空时用不到 + unsigned index = 0U; +#define X(name) fn(index++, can_counts(name)); + TREE_CAN(X) +#undef X +#define X(name) fn(index++, uart_counts(name)); + TREE_UART(X) +#undef X +#define X(name) fn(index++, spi_counts(name)); + TREE_SPI(X) +#undef X + (void)index; +} +} // namespace + +EventState *bus_state(const void *bsp_instance) +{ + // 实例清单为空时 X-macro 展开成空,参数用不到 + (void)bsp_instance; + unsigned index = 0U; +#define X(name) \ + if (static_cast(&name) == bsp_instance) \ + { \ + return &nodes[index]; \ + } \ + ++index; + TREE_CAN(X) + TREE_UART(X) + TREE_SPI(X) +#undef X + (void)index; + return nullptr; +} + +unsigned bus_state_count(void) +{ + return NODE_COUNT; +} + +Status state_tree_init(void) +{ + for (unsigned i = 0U; i < NODE_COUNT; ++i) + { + const Status st = nodes[i].init(); + if (st != Status::OK) + { + return st; + } + (void)nodes[i].set_parent(sys_state); // 只会在重复调用时返回 BAD_ARG(父指针已设),无害 + } + return Status::OK; +} + +void state_tree_start(void) +{ + for (unsigned i = 0U; i < NODE_COUNT; ++i) + { + // 有初始化失败记录(设备 init_error 传上来)时返回 NOT_SUPPORTED;sys_state 同样带着失败位,由 system_start() 停机 + (void)nodes[i].complete_init(); + } + // 基线:初始化期的计数(例如 init 时启动接收失败后重试成功)不算运行期错误 + for_each_counts([](unsigned index, const ErrCounts &now) { last_counts[index] = now; }); +} + +void state_tree_poll(void) +{ + for_each_counts([](unsigned index, const ErrCounts &now) { check(index, now); }); +} diff --git a/code/service/system/state_tree.hpp b/code/service/system/state_tree.hpp new file mode 100644 index 0000000..5524f72 --- /dev/null +++ b/code/service/system/state_tree.hpp @@ -0,0 +1,66 @@ +/** + * @file state_tree.hpp + * @brief EventState 默认树:sys_state → 每个总线实例 → 挂在总线上的设备(Q6) + * + * @details + * 库默认建好前两层,宿主不用写任何代码: + * + * sys_state (system.cpp,根) + * ├─ bus_state(&bsp_can1) (ICBSP_CAN_INSTANCES 里每个实例一个) + * │ └─ DjiMotor::state() … (设备在自己的 init() 里挂上来) + * ├─ bus_state(&bsp_uart1) (ICBSP_UART_INSTANCES) + * └─ bus_state(&bsp_spi2) (ICBSP_SPI_INSTANCES) + * + * - 总线节点在 `system_init()` 里建好并挂到 `sys_state`,`system_start()` 时进入运行态。 + * - 运行期由 sys_task 每 10 ms 调 `state_tree_poll()`:比较各实例的诊断计数,哪类计数涨了就在该总线节点上 + * 记一个错误码(下表),错误随即向上传到 `sys_state`。 + * - 设备节点(第三层)由设备自己持有:init() 时 `set_parent(*bus_state(&总线))`,掉线(Online 由在线变离线) + * 记 `TIMEOUT`,初始化失败记 `init_error()`。 + * + * | 总线 | 计数涨了 | 记的错误码 | + * | ---- | ---------------------------------------------------------------- | ----------- | + * | CAN | `bus_off_events` | `IO_ERROR` | + * | CAN | `rx_dropped`、`rx_lost`、`rx_return_dropped`、`tx_dropped`、`tx_buf_full`、`tx_flushed` | `FULL` | + * | CAN | `tx_stall_recover` | `TIMEOUT` | + * | UART | RX `hw_error_cnt`、`error_cnt`,TX `error_cnt` | `IO_ERROR` | + * | UART | RX / TX `drop_bytes` | `FULL` | + * | UART | TX `stall_recover_cnt` | `TIMEOUT` | + * | SPI | `error_cnt` | `IO_ERROR` | + * | SPI | `timeout_cnt` | `TIMEOUT` | + * | SPI | `lock_timeout_cnt` | `BUSY` | + * + * @note 传播规则(Q6 / N16):子节点出错只置父节点的错误位,**不清 RUNNING**;`init_error()` 只在初始化期有效。 + * 错误码粘滞到 `clear_error()` / `clear_errors()`,只清本节点、不传播。查哪条总线出过什么错: + * `bus_state(&bsp_can1)->get_error_bits()`;整机有没有出过错:`sys_state.get_error_bits()`。 + * @note `ICBSP_SYS_TASK_ENABLE = 0` 时没有人调 `state_tree_poll()`,总线节点不会记运行期错误(设备掉线照常记)。 + */ + +#ifndef __SERVICE_STATE_TREE_HPP__ +#define __SERVICE_STATE_TREE_HPP__ + +#include "service/system/status.hpp" + +/** + * @brief 取某个总线实例的 EventState 节点 + * @param bsp_instance 总线实例的地址(`&bsp_can1`、`&bsp_uart1`、`&bsp_spi2` …) + * @return 节点指针;实例不在 ICBSP_CAN/UART/SPI_INSTANCES 清单里时返回 nullptr + * @note `system_init()` 之后才可用(之前返回的节点还没 init,set_parent() 会返回 NOT_INIT)。 + */ +EventState *bus_state(const void *bsp_instance); + +/** @brief 总线节点个数(三张实例清单合计) */ +unsigned bus_state_count(void); + +/** + * @brief 建总线节点并挂到 sys_state(`system_init()` 调用) + * @return OK;FULL = 事件组创建失败(堆不够) + */ +Status state_tree_init(void); + +/** @brief 总线节点进入运行态(`system_start()` 调用,先于 sys_state) */ +void state_tree_start(void); + +/** @brief 比较各总线实例的诊断计数,涨了就在对应节点记错误(sys_task 每 10 ms 调用) */ +void state_tree_poll(void); + +#endif // __SERVICE_STATE_TREE_HPP__ diff --git a/code/service/status.cpp b/code/service/system/status.cpp similarity index 95% rename from code/service/status.cpp rename to code/service/system/status.cpp index bdbdd6b..ef09b1e 100644 --- a/code/service/status.cpp +++ b/code/service/system/status.cpp @@ -1,4 +1,4 @@ -#include "status.hpp" +#include "service/system/status.hpp" #include "task.h" // IWYU pragma: keep(vTaskDelete) @@ -135,7 +135,7 @@ Status EventState::clear_error(Status statu) return Status::BAD_ARG; } (void)xEventGroupClearBits(_handle, status_bit(statu)); - if (error_bits() == 0U) + if (get_error_bits() == 0U) { (void)xEventGroupSetBits(_handle, status_bit(Status::OK)); } @@ -166,25 +166,25 @@ bool EventState::is_ready(void) const } /** @brief 本实例当前是否处于运行态 */ -bool EventState::running(void) const +bool EventState::is_running(void) const { return is_ready() && ((xEventGroupGetBits(_handle) & RUNNING_BIT) != 0U); } /** @brief 已记录的错误码位图 */ -uint32_t EventState::error_bits(void) const +uint32_t EventState::get_error_bits(void) const { return (_handle == nullptr) ? 0U : (static_cast(xEventGroupGetBits(_handle)) & ERROR_MASK); } /** @brief 已记录的最小错误码;按位号从小到大扫,取到的即枚举值最小的那个 */ -Status EventState::error_code(void) const +Status EventState::get_error_code(void) const { if (_handle == nullptr) { return Status::NOT_INIT; } - const uint32_t bits = error_bits(); + const uint32_t bits = get_error_bits(); for (uint32_t value = 1U; value < STATUS_MAX; ++value) { if ((bits & (1U << value)) != 0U) diff --git a/code/service/status.hpp b/code/service/system/status.hpp similarity index 92% rename from code/service/status.hpp rename to code/service/system/status.hpp index e0a57d5..a86f2de 100644 --- a/code/service/status.hpp +++ b/code/service/system/status.hpp @@ -19,10 +19,10 @@ * 未 init 时除 init() 外全部接口安全返回。 * * @note 分层:子节点用 set_parent() 挂到父节点。错误只向上传播,父节点不聚合 running; - * 要判断具体哪个子系统失败,查对应子节点的 error_code()。父节点必须比子节点活得久。 + * 要判断具体哪个子系统失败,查对应子节点的 get_error_code()。父节点必须比子节点活得久。 * - * @note 分层约定:只给「维护多个对象的系统」用;单个设备不许引用它,失败只 return Status。 - * 生命周期、错误传播与已知局限见同目录 status.md 与 Docs/guide/系统状态标志原理.md。 + * @note 默认树(Q6,见 state_tree.hpp):sys_state → 每个总线实例 → 挂在总线上的设备。设备的接口失败照常 + * return Status;EventState 只记初始化失败和运行期的“出过什么错”(例如掉线),给整机诊断用。 */ #ifndef __SERVICE_STATUS_HPP__ @@ -33,7 +33,7 @@ #include "FreeRTOS.h" // IWYU pragma: keep #include "event_groups.h" -#include "status_code.hpp" // IWYU pragma: export(Status、status_bit) +#include "service/system/status_code.hpp" // IWYU pragma: export(Status、status_bit) @@ -132,18 +132,18 @@ class EventState bool is_ready(void) const; /** @brief 本实例当前是否处于运行态 */ - bool running(void) const; + bool is_running(void) const; /** * @brief 已记录的错误码里枚举值最小的那个(不是最近一次的错误) * @return 错误状态码;没有未清的错误时返回 Status::OK;未 init 时返回 Status::NOT_INIT * @note 错误的生命周期:error() / init_error() 记下的码一直保留(粘滞),直到 clear_error() / clear_errors(); - * 多个错误并存时按枚举值从小到大取第一个。要知道具体有哪些错误,用 error_bits()。 + * 多个错误并存时按枚举值从小到大取第一个。要知道具体有哪些错误,用 get_error_bits()。 */ - Status error_code(void) const; + Status get_error_code(void) const; /** @brief 已记录的错误码位图(bit n = 状态码 n,掩码用 status_bit());未 init 时返回 0 */ - uint32_t error_bits(void) const; + uint32_t get_error_bits(void) const; /** * @brief 阻塞等待本实例进入运行态 diff --git a/code/service/status_code.hpp b/code/service/system/status_code.hpp similarity index 100% rename from code/service/status_code.hpp rename to code/service/system/status_code.hpp diff --git a/code/service/system.cpp b/code/service/system/system.cpp similarity index 57% rename from code/service/system.cpp rename to code/service/system/system.cpp index c033e4c..d454333 100644 --- a/code/service/system.cpp +++ b/code/service/system/system.cpp @@ -1,17 +1,18 @@ -#include "system.hpp" -#include "hardware_config.h" +#include "service/system/system.hpp" +#include "service/system/config_check.hpp" // 宿主配置(经检查) #include #include "FreeRTOS.h" // IWYU pragma: keep -#include "bsp_dwt.hpp" // 计时基准(库内实例,本文件负责 init) -#include "status.hpp" -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "bsp/bsp_dwt.hpp" // 计时基准(库内实例,本文件负责 init) +#include "service/system/state_tree.hpp" // EventState 默认树的总线层 +#include "service/system/status.hpp" +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) #include "task.h" -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_TX_ENABLE +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_TX_ENABLE # include "board_instances.hpp" -# include "can_tx_node.hpp" // CanTxNodeT::count_for() +# include "service/comm/can_tx_node.hpp" // CanTxNodeT::count_for() namespace { @@ -22,7 +23,7 @@ bool has_tx_nodes() { \ return true; \ } - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X return false; } @@ -30,10 +31,7 @@ bool has_tx_nodes() #endif -// 库任务优先级的取值检查放在库里:宿主删掉 hardware_config.h 里的检查也照样生效(评审 A2 / Q3) -static_assert(SYS_TASK_PRIORITY > tskIDLE_PRIORITY && SYS_TASK_PRIORITY < configMAX_PRIORITIES, "SYS_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); -static_assert(CAN_TASK_PRIORITY > tskIDLE_PRIORITY && CAN_TASK_PRIORITY < configMAX_PRIORITIES, "CAN_TASK_PRIORITY 取 1 ~ configMAX_PRIORITIES - 1"); -static_assert(CAN_TASK_PRIORITY > SYS_TASK_PRIORITY, "CAN 收发任务要比 sys_task 优先:1 kHz 节拍内必须跑完"); +// 库任务优先级等取值检查在 service/system/config_check.hpp(宿主删掉 hardware_config.h 里的检查也照样生效,评审 A2 / Q3) /* ==================== 全局系统状态 ==================== */ @@ -72,7 +70,8 @@ void init_dma_buffer() return; } const size_t size = static_cast(__dma_buffer_end - __dma_buffer_start); - if (size > 0U) + // 外置 Flash 方案 A(QSPI_RAM):整个程序已由 bootloader 拷进 AXI SRAM,加载地址就是运行地址 + if (size > 0U && static_cast(__dma_buffer_load) != static_cast(__dma_buffer_start)) { memcpy(__dma_buffer_start, __dma_buffer_load, size); } @@ -93,31 +92,39 @@ extern "C" void system_init(void) // 系统状态最先建:CAN 节点注册、任务入口的 wait_running() 都依赖它 ICBSP_CHECK(sys_state.init() == Status::OK); + // 默认树的总线层(Q6):每个清单里的 CAN / UART / SPI 实例一个节点,挂在 sys_state 下; + // 设备在 board_init() 里 init() 时挂到所用总线的节点下 + ICBSP_CHECK(state_tree_init() == Status::OK); + // 调度器启动前任务不会运行(CAN 收发任务还会先等运行态),所以可以早于用户的外设 init(); // 任务名受 configMAX_TASK_NAME_LEN(16)限制 -#if SYS_TASK_ENABLE - ICBSP_CHECK(xTaskCreate(sys_task, "sys", SYS_TASK_STACK, NULL, SYS_TASK_PRIORITY, NULL) == pdPASS); +#if ICBSP_SYS_TASK_ENABLE + ICBSP_CHECK(xTaskCreate(sys_task, "sys", ICBSP_SYS_TASK_STACK, NULL, ICBSP_SYS_TASK_PRIORITY, NULL) == pdPASS); #endif -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_RX_ENABLE - ICBSP_CHECK(xTaskCreate(can_rx_task, "can_rx", CAN_TASK_STACK, NULL, CAN_TASK_PRIORITY, NULL) == pdPASS); +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_RX_ENABLE + ICBSP_CHECK(xTaskCreate(can_rx_task, "can_rx", ICBSP_CAN_TASK_STACK, NULL, ICBSP_CAN_TASK_PRIORITY, NULL) == pdPASS); #endif } extern "C" void system_start(void) { -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_TX_ENABLE +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_TX_ENABLE // 发送节点在 board_init() 里注册完;任意一个实例有发送节点才创建 can_tx 任务 if (has_tx_nodes()) { - ICBSP_CHECK(xTaskCreate(can_tx_task, "can_tx", CAN_TASK_STACK, NULL, CAN_TASK_PRIORITY, NULL) == pdPASS); + ICBSP_CHECK(xTaskCreate(can_tx_task, "can_tx", ICBSP_CAN_TASK_STACK, NULL, ICBSP_CAN_TASK_PRIORITY, NULL) == pdPASS); } /* ==================== */ #endif - // 有初始化失败记录(各注册函数调过 sys_state.init_error)就在这里停机,fault_record 记下本行 + // 总线节点先进入运行态,并记下诊断计数的基线(之后计数再涨才算运行期错误) + state_tree_start(); + + // 有初始化失败记录(设备 / 注册函数的 init_error 一路传上来)就在这里停机,fault_record 记下本行; + // 具体是哪条总线下的设备,查 bus_state(&实例)->get_error_code() ICBSP_CHECK(sys_state.complete_init() == Status::OK); } diff --git a/code/service/system.hpp b/code/service/system/system.hpp similarity index 89% rename from code/service/system.hpp rename to code/service/system/system.hpp index e30b047..8bdb21c 100644 --- a/code/service/system.hpp +++ b/code/service/system/system.hpp @@ -1,7 +1,7 @@ /** * @file system.hpp * @author ChoseB - * @brief stm32_framework 的入口:建系统状态、创建库自带的后台任务、置运行态 + * @brief icbsp 的入口:建系统状态、创建库自带的后台任务、置运行态 * @version 0.1 * @date 2026-10-17 * @@ -29,8 +29,8 @@ #include #ifdef __cplusplus -#include "status.hpp" -#include "fault_record.hpp" // IWYU pragma: keep(ICBSP_CHECK) +#include "service/system/status.hpp" +#include "service/system/fault_record.hpp" // IWYU pragma: keep(ICBSP_CHECK) /** @brief 整个系统的状态(定义在 service/system.cpp) */ extern EventState sys_state; @@ -65,12 +65,12 @@ extern "C" uint32_t avg_us; ///< 最近 1 s(100 个周期)的平均维护耗时,每 1 s 更新一次 } SysTaskStats; - /** @brief sys_task 的循环耗时统计(定义在 tasks/sys_task.cpp;SYS_TASK_ENABLE = 0 时恒为 0) */ + /** @brief sys_task 的循环耗时统计(定义在 tasks/sys_task.cpp;ICBSP_SYS_TASK_ENABLE = 0 时恒为 0) */ extern volatile SysTaskStats sys_task_stats; /** * @brief 周期报告回调:在 sys_task 里调用,参数是当前统计的快照 - * @note 跑在 sys_task 的栈上(SYS_TASK_STACK);回调里打印要留够 vsnprintf 的栈,不要阻塞太久(会推迟 CAN 恢复和串口巡检)。 + * @note 跑在 sys_task 的栈上(ICBSP_SYS_TASK_STACK);回调里打印要留够 vsnprintf 的栈,不要阻塞太久(会推迟 CAN 恢复和串口巡检)。 */ typedef void (*SystemReportHook)(const SysTaskStats *stats); diff --git a/code/tasks/can_rx_task.cpp b/code/tasks/can_rx_task.cpp index 0342d92..a954b1c 100644 --- a/code/tasks/can_rx_task.cpp +++ b/code/tasks/can_rx_task.cpp @@ -1,17 +1,17 @@ -#include "hardware_config.h" -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "service/system/config_check.hpp" // 宿主配置(经检查) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) -// 宿主工程没在 CubeMX 里开 FDCAN 或 CAN_RX_ENABLE=0 时,本文件不参与编译 -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_RX_ENABLE +// 宿主工程没在 CubeMX 里开 FDCAN 或 ICBSP_CAN_RX_ENABLE=0 时,本文件不参与编译 +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_RX_ENABLE # include "board_instances.hpp" -# include "can_rx_node.hpp" -# include "system.hpp" +# include "service/comm/can_rx_node.hpp" +# include "service/system/system.hpp" template static void can_rx_service(CanT &can) { - for (uint32_t i = 0U; i < CAN_RX_DISPATCH_PER_TICK; ++i) + for (uint32_t i = 0U; i < ICBSP_CAN_RX_DISPATCH_PER_TICK; ++i) { CanRxMsg rx = {}; if (can.read_raw(&rx, 0U) != Status::OK) @@ -26,7 +26,7 @@ static void can_rx_service(CanT &can) consumed = CanRxNodeT::dispatch(can, rx); } - // 没有接收节点认领的帧:计入 rx_unclaimed;有回退缓冲(CAN_RX_RETURN_FRAMES > 0)就放进去,供 can.receive() 读取 + // 没有接收节点认领的帧:计入 rx_unclaimed;有回退缓冲(ICBSP_CAN_RX_RETURN_FRAMES > 0)就放进去,供 can.receive() 读取 if (!consumed) { (void)can.return_frame(rx); @@ -39,21 +39,21 @@ extern "C" void can_rx_task(void *argument) (void)argument; sys_state.wait_running(); # define X(name) CanRxNodeT::freeze(); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X static_assert(configTICK_RATE_HZ == 1000U, "can_rx_task requires a 1 kHz tick"); TickType_t wake_time = xTaskGetTickCount(); for (;;) { - if (sys_state.running()) + if (sys_state.is_running()) { # define X(name) can_rx_service(name); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X } vTaskDelayUntil(&wake_time, pdMS_TO_TICKS(1U)); } } -#endif // HAL_FDCAN_MODULE_ENABLED && CAN_RX_ENABLE +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_RX_ENABLE diff --git a/code/tasks/can_tx_task.cpp b/code/tasks/can_tx_task.cpp index 5b87466..fe3573e 100644 --- a/code/tasks/can_tx_task.cpp +++ b/code/tasks/can_tx_task.cpp @@ -1,12 +1,12 @@ -#include "hardware_config.h" -#include "bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) +#include "service/system/config_check.hpp" // 宿主配置(经检查) +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(HAL 模块开关 / 系列桥接) -// 宿主工程没在 CubeMX 里开 FDCAN 或 CAN_TX_ENABLE=0 时,本文件不参与编译 -#if defined(HAL_FDCAN_MODULE_ENABLED) && CAN_TX_ENABLE +// 宿主工程没在 CubeMX 里开 FDCAN 或 ICBSP_CAN_TX_ENABLE=0 时,本文件不参与编译 +#if defined(HAL_FDCAN_MODULE_ENABLED) && ICBSP_CAN_TX_ENABLE # include "board_instances.hpp" -# include "can_tx_node.hpp" -# include "system.hpp" +# include "service/comm/can_tx_node.hpp" +# include "service/system/system.hpp" extern "C" void can_tx_task(void *argument) { @@ -21,17 +21,17 @@ extern "C" void can_tx_task(void *argument) CanTxNodeT::freeze(); \ CanTxNodeT::init_send_ticks(name, start_tick); \ } while (0); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X TickType_t wake_time = start_tick; for (;;) { # define X(name) CanTxNodeT::service(name); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X vTaskDelayUntil(&wake_time, pdMS_TO_TICKS(1U)); } } -#endif // HAL_FDCAN_MODULE_ENABLED && CAN_TX_ENABLE +#endif // HAL_FDCAN_MODULE_ENABLED && ICBSP_CAN_TX_ENABLE diff --git a/code/tasks/sys_task.cpp b/code/tasks/sys_task.cpp index 1f1ac5a..d76148d 100644 --- a/code/tasks/sys_task.cpp +++ b/code/tasks/sys_task.cpp @@ -1,20 +1,21 @@ -#include "bsp_can.hpp" // 未开 FDCAN 时为空 -#include "bsp_dwt.hpp" -#include "bsp_uart.hpp" // 未开 UART 时为空 -#include "online_check.hpp" -#include "system.hpp" +#include "bsp/bsp_can.hpp" // 未开 FDCAN 时为空 +#include "bsp/bsp_dwt.hpp" +#include "bsp/bsp_uart.hpp" // 未开 UART 时为空 +#include "service/monitor/online_check.hpp" +#include "service/system/state_tree.hpp" // state_tree_poll() +#include "service/system/system.hpp" #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" #include #include "board_instances.hpp" -#include "hardware_config.h" +#include "service/system/config_check.hpp" // 宿主配置(经检查) // 维护周期:Online 计时、CAN 恢复、UART 巡检统一按这个节拍 constexpr uint32_t SYS_TASK_PERIOD_MS = 10U; -static_assert(CAN_BUSOFF_RETRY_MS >= SYS_TASK_PERIOD_MS, "hardware_config.h: CAN_BUSOFF_RETRY_MS 不能短于 sys_task 的 10 ms 节拍"); +static_assert(ICBSP_CAN_BUSOFF_RETRY_MS >= SYS_TASK_PERIOD_MS, "hardware_config.h: ICBSP_CAN_BUSOFF_RETRY_MS 不能短于 sys_task 的 10 ms 节拍"); extern "C" { @@ -35,7 +36,7 @@ extern "C" void system_set_report_hook(SystemReportHook hook, uint32_t period_ms report_hook = hook; } -#if SYS_TASK_ENABLE +#if ICBSP_SYS_TASK_ENABLE extern "C" void sys_task(void *argument) @@ -50,7 +51,7 @@ extern "C" void sys_task(void *argument) uint64_t window_sum = 0U; // 平均值窗口内的耗时和 (µs) constexpr uint32_t AVG_WINDOW = 1000U / SYS_TASK_PERIOD_MS; - vTaskDelayUntil(&wake_time, pdMS_TO_TICKS(1000)); + // 不等开机 1 s(Q5):Online 初始就是离线,Bus-Off 恢复与串口巡检在没出故障时什么都不做,上电立刻开始维护没有副作用 for (;;) { // 本轮计时基准(无状态,首次结果丢弃) @@ -60,27 +61,30 @@ extern "C" void sys_task(void *argument) // DWT 绝对时间的回绕跟踪:两次调用要短于一圈(550 MHz 下 7.8 s),这里每 10 ms 推进一次(C11) (void)bsp_dwt.get_cycles(); -# if defined(HAL_FDCAN_MODULE_ENABLED) && (CAN_RX_ENABLE || CAN_TX_ENABLE) +# if defined(HAL_FDCAN_MODULE_ENABLED) && (ICBSP_CAN_RX_ENABLE || ICBSP_CAN_TX_ENABLE) // CAN:Bus-Off 自恢复 + 发送兜底(软件缓冲有帧、TX-FIFO-EMPTY 中断却关着时补发,N27) # define X(name) \ (void)name.service_recovery(); \ (void)name.tx_recover(); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) # undef X # endif -# if defined(HAL_UART_MODULE_ENABLED) && UART_PATROL_ENABLE +# if defined(HAL_UART_MODULE_ENABLED) && ICBSP_UART_PATROL_ENABLE // 串口补救:卡死的发送续发 + 停摆的接收重建 # define X(name) \ (void)name.tx_recover(); \ (void)name.rx_recover(); - BSP_UART_INSTANCES(X) + ICBSP_UART_INSTANCES(X) # undef X # endif - // 在线情况更新 + // 在线情况更新(设备由在线变离线时,Online 在设备节点上记 TIMEOUT) (void)Online::update(); + // 默认树:总线实例的诊断计数涨了就在对应总线节点上记错误(Q6) + state_tree_poll(); + // 耗时统计(不含报告回调本身) const uint32_t cost_us = static_cast(bsp_dwt.get_delta_s(&mark) * 1000000.0); sys_task_stats.cycles = sys_task_stats.cycles + 1U; @@ -112,4 +116,4 @@ extern "C" void sys_task(void *argument) } } -#endif // SYS_TASK_ENABLE +#endif // ICBSP_SYS_TASK_ENABLE diff --git a/docs/bsp_test/README.md b/docs/bsp_test/README.md index ed297a0..43f8edb 100644 --- a/docs/bsp_test/README.md +++ b/docs/bsp_test/README.md @@ -1,26 +1,23 @@ -# stm32_framework 接口实机测试(2026-10-17) - -> **2026-11-04 注明**:本目录是从 STM32_BSP 原样带过来的,记录对应 **STM32_BSP @ 43a34cf 的旧实现**(`BspUart`、实例登记表、`SysFlag*`);UART、CAN 已分别在 1.1、1.2 回填并复测,见 `uart_backfill_2026-11-04.md`、`can_backfill_2026-11-04.md`;SPI / BMI088 在 1.3 复测,见 `arch_1_3_2026-11-04.md`。回填(`undo.md` 阶段 1.1 / 1.2)完成后在宿主 MC02_with_submodule 上复测,再更新这里。 - -> 本目录是宿主工程 `MC02_with_submodule` 的 `docs/bsp_test/` 的副本(2026-10-17,2026-10-28 补 SPI / BMI088)。文中的路径都以**宿主工程根目录**为准: -> `app/`、`Core/`、`CMakeLists.txt` 指宿主工程,`third_party/stm32-framework/` 即本库。测试代码在宿主工程 `app/test/`,不在本库里。 - -对 submodule `third_party/stm32-framework` 的 UART、RS485、CAN 接口在 DM-MC02 上做实机测试:常规用法、参数边界、满载、故障注入、长时间浸泡、物理插拔。 -测试中发现的库问题当场修复并回归(库改动未提交,见 `changes.md`);同时首次用 EmberProbe skill 烧写调试,与命令行方案对比(`flash_debug_eval.md`)。 - -| 文件 | 内容 | -| --- | --- | -| `uart_u7_u10.md` | UART U7 ⇄ U10:用例、方案、现象、结论,3 个专项诊断 | -| `can_backfill_2026-11-04.md` | **当前实现**:undo 1.2 CAN 回填后的 CAN 回归,以及 TX 队列模式同 ID 乱序的诊断 | -| `arch_1_3_2026-11-04.md` | **当前实现**:undo 1.3 架构问题修复后的回归(SPI / BMI088 组适配新库、新增服务层组 Y01 ~ Y05,-O2 全组) | -| `review_1_4_2026-11-04.md` | undo 1.4:评审遗留问题修复、TIM8 时基改回 15;服务层组 Y06 ~ Y12(含故意触发 BusFault 验证故障现场),Debug 与 -O2 全组回归 | -| `uart_backfill_2026-11-04.md` | **当前实现**:undo 1.1 UART 回填后的 UART / RS485 回归(Debug + -O2 浸泡),以及测试时钟回绕导致 R03 假超时的诊断 | -| `rs485_u2_u3.md` | RS485 U2 ⇄ U3 | -| `can1_can2.md` | CAN1 ⇄ CAN2 | -| `spi_bmi088.md` | SPI2 + 板载 BMI088(2026-10-28):基本功能、错误路径、故障注入、总线争用与浸泡 | -| `changes.md` | 所有代码与配置改动(CubeMX、测试代码、库修复 L1~L13)及原因 | -| `flash_debug_eval.md` | EmberProbe 与 OpenOCD / GDB / CubeMX 命令行的对比与今后分工 | -| `raw/` | 各轮原始结果表 | +# ICBSP 实板测试记录 + +本目录是回归宿主工程 `MC02_with_submodule`(DM-MC02,STM32H723)`docs/bsp_test/` 的副本:测试代码在宿主 `app/test/`,不在本库里; +文中的路径都以**宿主工程根目录**为准(`app/`、`Core/`、`CMakeLists.txt`;`third_party/stm32-framework/` / `third_party/icbsp/` 即本库)。 +阶段 3 及之后的原始结果表只在宿主的 `docs/bsp_test/raw/` 里。 + +**当前代码以 [phase3_2026-11-06.md](phase3_2026-11-06.md) 为准**;更早的记录对应的代码版本见下表,里面的类名、宏名、目录可能和现在不同。 + +| 记录 | 日期 | 对应的库代码 | API 名称 | +| --- | --- | --- | --- | +| [phase3_2026-11-06.md](phase3_2026-11-06.md) | 2026-11-06 ~ 07 | ICBSP `phase2` 分支:`68451b7`(单元测试)~ `d71421a`(UART 巡检修复);第 A 轮 `255250b`、第 B 轮 `ad1259b`、DMA 循环专项 `12ebd38`、F2 `d71421a` | 当前 | +| [review_1_4_2026-11-04.md](review_1_4_2026-11-04.md) | 2026-11-04 ~ 05 | stm32-framework `11c1fc2`(1.3 与 1.4 一起提交) | 旧(改名 ICBSP、目录重排之前) | +| [arch_1_3_2026-11-04.md](arch_1_3_2026-11-04.md) | 2026-11-04 | stm32-framework `5cf97d9` + 1.3 工作区改动(随 `11c1fc2` 提交) | 旧 | +| [can_backfill_2026-11-04.md](can_backfill_2026-11-04.md) | 2026-11-04 | stm32-framework `626260c` + 1.2 工作区改动(提交为 `5cf97d9`) | 旧 | +| [uart_backfill_2026-11-04.md](uart_backfill_2026-11-04.md) | 2026-11-04 | stm32-framework `bf8df28` + 1.1 工作区改动(提交为 `626260c`) | 旧 | +| [spi_bmi088.md](spi_bmi088.md) | 2026-10-28 | 旧库 STM32_BSP 工作区(提交为 `be91caf` / `a79e1ae`,2026-10-29) | 旧(`BspUart`、登记表) | +| [uart_u7_u10.md](uart_u7_u10.md)、[rs485_u2_u3.md](rs485_u2_u3.md)、[can1_can2.md](can1_can2.md)、[changes.md](changes.md) | 2026-10-17 | 旧库 STM32_BSP `97e138b` + 当天的修复(提交为 `d32a996`) | 旧 | +| [flash_debug_eval.md](flash_debug_eval.md) | 2026-10-17 | 与库版本无关(烧录 / 调试工具的评估) | — | + +另有 `../service_test/event_state_online.md`(2026-11-01,stm32-framework `d5221ea`,EventState / Online 81 条判据)。 ## 环境 diff --git a/docs/bsp_test/can1_can2.md b/docs/bsp_test/can1_can2.md index 8f8fcdb..5fb6812 100644 --- a/docs/bsp_test/can1_can2.md +++ b/docs/bsp_test/can1_can2.md @@ -1,5 +1,7 @@ # CAN1 ⇄ CAN2 测试记录 +> 对应代码:旧库 STM32_BSP `97e138b` + 当天的修复(提交为 `d32a996`)。API 名称是旧的;当前实现的 CAN 回归见 `phase3_2026-11-06.md`。 + - 硬件:DM-MC02 CAN1、CAN2 的 H–H、L–L 用短线对接,**没有 120 Ω 终端电阻**(用户确认);USB 供电(CAN 收发器 5 V)。 - 配置:经典 CAN,1 Mbps(FDCAN 内核 96 MHz,NBRP 6,TSEG1 11,TSEG2 4),RX FIFO0 16 帧,TX FIFO 16 帧,自动重发开。 - 实例:`bsp_can1`、`bsp_can2`(`BspCan`),库默认配置(RX / 回退 / TX 队列各 8 帧,节点上限 50,心跳 5 ms,指令有效期 100 ms)。 diff --git a/docs/bsp_test/external_flash_2026-11-10.md b/docs/bsp_test/external_flash_2026-11-10.md new file mode 100644 index 0000000..9501674 --- /dev/null +++ b/docs/bsp_test/external_flash_2026-11-10.md @@ -0,0 +1,89 @@ +# 外置 QSPI Flash 方案实测(2026-11-10) + +按 `undo.md` 阶段 6“小 Flash 型号的外置 Flash 支持”,在 H750 回归宿主上测方案 A(`QSPI_RAM`)与方案 B(`QSPI_XIP`)。 +范围按约定:外置 Flash 专项 + 冒烟,不移植 MC02 的 BSP 回归套件。原理与用法见 [../外置Flash.md](../外置Flash.md)。 + +## 环境 + +- 板:H750_FULL_TEST(STM32H750VBT6,HSE 8 MHz,480 MHz / HCLK 240 MHz),外置 W25Q128JV(JEDEC `EF 40 18`)接 QUADSPI Bank 2: + PB2 CLK、PC11 BK2_NCS、PE7~PE10 BK2_IO0~IO3。 +- 探针:CMSIS-DAP(Horco v0.2,SN 132004251478),OpenOCD 0.12.0+dev;arm-none-eabi-gcc 15.3。 +- 库:`phase2` 分支 `ac99b10` / `85dbbf0`(本次两个提交)。宿主用 `integrate.py --external-flash QSPI_RAM --flash-chip W25Q128` 接入。 +- 宿主配置(测试过程中的调整,见“宿主侧发现”):D-Cache 关、I-Cache 开;`defaultTask` 栈 512 字;BMI088 设备暂时从选择里去掉(SPI6 卡住,见下)。 +- QSPI 时钟:bootloader 阶段 HSI 64 MHz / 3 ≈ 21 MHz,应用阶段 240 MHz / 3 = 80 MHz(`ICBSP_QSPI_PRESCALER = 2`)。 + +## 编译 + +| 项 | 结果 | +| --- | --- | +| 宿主 9 个预设(Debug / RelWithDebInfo / Release × Internal / QspiRam / QspiXip) | 8 个 0 warning;`Debug-Internal`(-O0)片内 Flash 溢出,符合预期 | +| bootloader | 1976 B(片内 Flash 1.5%) | +| Debug(-O0)大小 | 方案 A:AXI SRAM 138 KB;方案 B:QSPI 136 KB(去掉 BMI088 之后) | +| `tools/tests/compile_test.py` | 3 / 3 通过:新增 `h750_qspi`(CubeMX 无界面生成 → `integrate.py` 开外置 Flash → Debug-QspiRam、Debug-QspiXip、RelWithDebInfo-Internal 均 0 warning),`mc02_full` / `mc02_alt` 不受影响 | +| `tools/tests`(unittest) | 35 / 35 通过(新增 `test_flash.py` 22 项:分析 / 生成 / 选择校验 / `#` 生成区 / 宿主计划步骤 / `qspi_image.py`) | +| `icbsp_optimization` | 宿主编译参数里自己的等级排在工具链的 `-O0` 之后(`-O0 -Og`、HAL `-O0 -Os`);片内 Debug + `VENDOR_OS` 95 KB、Debug=-Og 90 KB,都装得下 | + +## 实板 + +| 编号 | 内容 | 结果 | +| --- | --- | --- | +| H1 | OpenOCD `stmqspi` 探测、擦写校验 | 通过:`win w25q128fv/jv`、16 MiB;镜像擦写 + verify(57 KiB/s 写、≈ 900 KiB/s 校验);内存映射读 0x90000000 正常 | +| H2 | 方案 A / 方案 B 烧录、复位、**各掉电 3 次**(用户操作) | 通过:启动状态 `0x10`(跳到 0x24000000),1000 tick/s;掉电后 `fault_record` 被上电清零、`boot_rsr = 0x00FE0000`(含 POR),应用照常运行;方案 B 同样(状态 `0x11`,预先制造的 MemManage 记录被上电清零) | +| H3 | 方案 A 反例 | 通过:改镜像一个字节 → 状态 7(BAD_CRC,细节 = 算出的 CRC),应用不启动;擦掉镜像头扇区 → 状态 5(NO_IMAGE);重烧恢复 `0x10`。正常镜像能过,说明 CRC 外设配置与 zlib 一致 | +| H4 | 方案 A 调试迭代 | 通过:`OpenOCD_flash.sh --ram` 直接下载进 AXI SRAM 运行(不写 Flash);GDB 下进 RAM 后打 11 个**软件**断点(超过 8 个硬件断点)全部依次命中 | +| H5 | 方案 B 烧录与运行 | 通过:状态 `0x11`(跳到 0x90000400),PC 在 0x9001xxxx;`hqspi.State` 仍是 RESET(`MX_QUADSPI_Init()` 已跳过);QUADSPI_CR = 0x02000391、CCR = 0x0F10EDEB(0xEB 四线内存映射、4 个空周期);应用的 `SystemClock_Config()` 正常(PLL1 480 MHz,HCLK 240 MHz → QSPI 80 MHz);VS Code 同款流程:GDB `load` 经 stmqspi 写 QSPI,`main` / `MX_TIM6_Init` 自动用硬件断点命中 | +| H6 | 方案 B 健壮性 | MPU:应用 `MPU_Config()` 之后第 13~15 区仍在(RASR 0x10000037 / 0x0602002F / 末尾 4 KB 禁止);读 0x91000000 → MemManage(CFSR 0x82,MMFAR 0x91000000,`fault_record` kind = 5,处理函数在 QSPI 上执行);读 0x90FFE000 正常。浸泡:见下 | +| H7 | 性能(`sys_task_stats`,DWT 计时的 sys_task 一轮) | 见下表 | +| H8 | `fault_record` 复位保留 | 通过:A、B 下人为制造 MemManage 后复位,记录仍在(bootloader 拷贝不覆盖 `.noinit`),应用重新运行 | +| H9 | 只用预设切换 | 通过:Internal → A → B → A(Debug) → B(Debug) 依次烧录都能启动;从 Internal 切回外置方案时脚本发现 bootloader 被覆盖,自动重烧 | +| H10 | EmberProbe | `variables_read` 在 A / B 下都能读 RAM 变量,但按工作区配置的 ELF(`build/Debug/…`)解析地址,与板上实际的预设不一致时不报警(`firmwareConsistency: unknown`)——外置方案要把 EmberProbe 的 ELF 指到 `build/<预设>/`。`flash_program` 只接受 interface / target 脚本,不能用 `daplink_qspi.cfg`,写不了 QSPI(按接口判断,未实际执行) | +| — | USB CDC 冒烟 | 通过(复测):第一次枚举失败(`device not accepting address, error -71`,片内方案同样),原因是 `.ioc` 的 USB 时钟 PLL3Q = 60 MHz;用户把 DIVQ3 改成 20(48 MHz)后,方案 A、方案 B、片内三种都枚举成 `0483:5740 STM32 Virtual ComPort`(`cdc_acm` → `/dev/ttyACM1`),应用 1000 tick/s、无故障 | + +### H7 性能 + +| 构建 | avg | max | +| --- | --- | --- | +| RelWithDebInfo(-O2)片内 Flash | 10 µs | 11 µs | +| RelWithDebInfo 方案 A | **8 µs** | 9 µs | +| RelWithDebInfo 方案 B | **75 µs** | 169 µs | +| Debug(-O0)方案 A | 21 µs | 23 µs | +| Debug(-O0)方案 B | 108 µs | 239 µs | + +方案 A 比片内 Flash 还快一点(AXI SRAM 0 等待 vs Flash 4 个等待周期)。方案 B 慢 7~9 倍,比事先按 cache 命中率估计的严重:sys_task 每 10 ms 跑一轮, +其间 I-Cache 已被其他任务冲掉;D-Cache 关着,放在 QSPI 里的常量每次都走 QSPI。**时序敏感的回归只用方案 A。** + +### H6 浸泡(方案 B,Debug,30 min) + +- 第一次(20:15 起):前 12 分钟 1000 tick/s、`fault_record` 无;20:27 被另一个调试客户端(同时间 `build/Debug` 被重新编译,可能是 VS Code / EmberProbe) + 复位并停在 OpenOCD 的算法代码里(PC 0x2000002E、LR 0xFFFFFFFF、QUADSPI_CR 回到复位值),不算固件问题。 +- 第二次(20:53 起,独占探针):通过。30 次采样(每分钟一次,不停核读)全部 1000 ± 2 tick/s,31 分钟 tick 到 1864017,`fault_record` 一直为空,启动状态一直是 `0x11`(没有复位),FreeRTOS 堆最低余量 904 B 不变。原始记录:`raw/external_flash_soak_xip_2026-11-10.log` + +## 实测中发现并修掉的问题(库) + +1. **`templates/linker_sections.ld` 的 `__dma_buffer_load` 没算段内 `ALIGN(32)` 的偏移**:`.dma_buffer` 不在 RAM 区开头时(方案 A 里它排在代码后面), + `__dma_buffer_start` 比段首晚 0x18 字节而加载地址还是段首,启动拷贝错位,`bsp_uart1._huart` 变成空指针,`init()` 返回 `BAD_ARG`。 + 改成 `LOADADDR(.dma_buffer) + (__dma_buffer_start - ADDR(.dma_buffer))`(对齐时结果不变),`integrate.py` 会等价改写老宿主的这一行。 +2. **内存映射读 QSPI 芯片最后一个字会挂死总线**:QUADSPI 预取越过芯片末尾,内核停在那次读上,连调试器都停不下(DHCSR.S_HALT 一直是 0), + 只能复位。bootloader 加 MPU 第 15 区(芯片最后 4 KB 禁止访问)后变成 MemManage;镜像也不允许用到这 4 KB。 +3. **GDB 连上时 stmqspi 还没探测到芯片**:`daplink_qspi.cfg` 只在 `reset-init` 里初始化 QSPI,GDB 一连上就要内存映射,此时 bank 探测超时,0x90000000 不算 Flash, + `load` 退化成普通写内存而失败。加 `gdb-attach` 事件:先 `reset init` 再 `flash probe`。 +4. **`--ram` 路径**:OpenOCD 的 `verify_image` 会比对 ld 映射进 0x20000000 的“ELF 头段”而误报不一致;寄存器名是 `xpsr`(小写)。都已改。 +5. **`qspi_image.py`**:ld 会把 ELF 头映射进第一个 PT_LOAD,按 segment 取数据会把头字节当成程序 —— 改为按有内容的 ALLOC section 取。 + +## 宿主侧发现(不是外置 Flash 方案的问题,留给宿主处理) + +- **D-Cache**:测试期间宿主打开过 D-Cache,与库“D-Cache 关闭”的约定冲突(`dcache_off` 规则报错);按用户决定改回关闭(I-Cache 保持开)。 +- **`defaultTask` 栈**:CubeMX 把 `MX_USB_DEVICE_Init()` 放在 `defaultTask`,-O0 下 128 字栈溢出(tick 1 就进 `fault_on_stack_overflow`); + 256 字时只剩 4 字余量,改成 512 字。以前 Debug 构建装不进片内 Flash,从没在板上跑过,所以没暴露。 +- **SPI6 / BMI088**(已查明并修好):片内与方案 A 都卡在 `bmi088.init()` 的 SPI6 传输里(SPI6_SR = 0x10012:CSTART 已置、TXTF,收不到 RXP; + CFG1 = 0x70003 即 DSIZE = 3 —— **4 位帧**)。`.ioc` 没写 `SPI6.DataSize`,H7 的 CubeMX 默认 4 位;预分频 /2 → 60 MHz,也超过 BMI088 的 10 MHz。 + 库加规则 `spi_8bit`、`spi_bmi088_speed`(可自动修改),用 `--fix-ioc` 改成 8 位、/16(7.5 MHz)。随后又暴露 FreeRTOS 堆不够(15 KB, + BMI088 工作任务分配 2056 B 失败,kind = 3),堆改 64 KB(与 MC02 回归宿主一致)。之后 BMI088 正常:加速度 (−2.47, 0.17, 9.46) m/s²(模 9.78)、 + 陀螺 ≈ 0、温度 29.25 °C,每秒刷新 100 次、失败 0;板上没把 BMI088 的 INT 接成 EXTI,所以走 10 ms 定时刷新、不做姿态解算(`_attitude_ready` = false)。 +- **USB 时钟**:`.ioc` 里 USB 取 PLL3Q,HSE 8 MHz / M 1 × N 120 / Q 16 = 60 MHz;USB FS 要 48 MHz。主机端枚举失败(error -71),片内方案同样。用户已改成 Q = 20(48 MHz),复测三种方案都能枚举。 +- **调试器单写 AXI SRAM**:ECC 的写缓冲让单个 32 位写在复位后丢失,清 `fault_record` 要一次写 16 字节。 + +## 未做 + +- Windows `.bat` 脚本只做了逻辑同步,没在 Windows 上跑。 +- Web UI 用服务端 API 走查(扫描、选项改动后的预览 diff 正确);页面本身未在浏览器里点过。 diff --git a/docs/bsp_test/flash_debug_eval.md b/docs/bsp_test/flash_debug_eval.md index 6b0d1e6..e747359 100644 --- a/docs/bsp_test/flash_debug_eval.md +++ b/docs/bsp_test/flash_debug_eval.md @@ -1,5 +1,7 @@ # 烧写调试方式评估:EmberProbe skill vs 命令行(OpenOCD / GDB / CubeMX CLI) +> 与库代码版本无关:烧录 / 调试工具(EmberProbe、OpenOCD、GDB、CubeMX CLI)的评估。 + 环境:EmberProbe 0.8.6(VS Code 扩展,skill 装在 `.agents/skills/`,经 `.claude/skills` 软链接给 Claude Code)、 OpenOCD 0.12.0+dev(`/usr/local/bin/openocd`,配置 `Flash/daplink.cfg`)、CMSIS-DAP(Horco,SN 5335231732)、 STM32CubeMX 6.18.1、arm-none-eabi-gdb。本次测试共烧写 17 次(16 次 EmberProbe、1 次 OpenOCD 命令行),CubeMX 生成 2 次。 diff --git a/docs/bsp_test/phase3_2026-11-06.md b/docs/bsp_test/phase3_2026-11-06.md new file mode 100644 index 0000000..fe5264e --- /dev/null +++ b/docs/bsp_test/phase3_2026-11-06.md @@ -0,0 +1,148 @@ +# 阶段 3 功能全面测试(2026-11-06 ~ 11-07) + +按 `third_party/icbsp/undo.md` 阶段 3,在阶段 2 的代码(库改名 ICBSP、目录重排、EventState 默认树、DmMotor 等,分支 `phase2`)上做主机侧单元测试、编译矩阵和实板回归。 +实板分两轮换线:第 A 轮电机接在 CAN 上(不跑 CAN 回环),第 B 轮拔掉电机、CAN1 ⇄ CAN2 直连。 + +## 环境 + +- 板、UART / RS485 跳线、工具链同 `README.md`;宿主分支 `phase2`,submodule = ICBSP(`third_party/icbsp`)`phase2` 分支。 +- 第 A 轮 CAN 上的电机:CAN1 = M3508(ID 1)、DM-J4310P(CAN_ID 0x05 / MST_ID 0x06);CAN2 = GM6020(ID 1,电流模式)、DM-J4340P(0x02 / 0x12,从 CAN1 换到 CAN2:两个插座线序不同)。输出轴都空载、放置平稳,用户允许中幅转动。 + **J4310 不使能**:它的 CAN_ID 0x05 与 GM6020 的反馈 0x205 低 8 位冲突(达妙只比较帧 ID 低 8 位),用户决定不改 ID。 +- 第 B 轮:CAN1 H/L ↔ CAN2 H/L,无终端电阻。 +- FreeRTOS 堆 64 KB;HAL 时基 TIM8 优先级 15。全程没有启动 TIM3、没有写 PB1(BMI088 加热电阻),H00 / H99 与监视任务核对全部为 0。 +- 构建:Debug(-O0 -g3)与 RelWithDebInfo(-O2 -g),两者都 0 warning。 + +## 3.1 主机侧单元测试 + CI(库 `68451b7`) + +`third_party/icbsp/tests/host/`:不依赖硬件和 RTOS、不用第三方框架,主机编译器 `-Wall -Wextra -Wshadow -Werror` 编 `algorithm/` 的 PID / 四元数 / QuaternionPID / Matrix 源文件,45 条判据: + +| 组 | 内容 | +| --- | --- | +| PID | 纯 P 与输出限幅;F4(`i_max = 0` 时积分上限跟随 `out_max`,链式配置与 Config 配置一致,反向能退下来;显式 `i_max` 生效);NaN 输入丢弃、计数、输出保持、恢复后继续工作 | +| 四元数 | F1(默认 / 零模长 / NaN 退回单位四元数,单位四元数的旋转向量为 0,小角度不除零);绕 z 转 90° 的矩阵与 ZYX 欧拉角;旋转向量往返;q·conj(q);1 rad/s 积分 1 s;slerp 端点与中点 | +| Matrix | 乘法、转置、3×3 求逆与 `approx_equal`、迹、奇异矩阵求逆失败、范数 | +| RLS | 辨识 y = 2.5u − 1(200 步,误差 < 1e-3);非有限样本丢弃计数、参数不变;遗忘因子非法 `BAD_ARG`;激励不足时 tr(P) 被限住 | + +`.github/workflows/host-tests.yml`:push / PR 时跑 `tools/check_layers.py` 与 `ctest`。本机 45 / 45 通过。 + +## 3.2 编译矩阵(宿主 `tools/compile_matrix.sh`,`4d5c2fa`) + +在临时拷贝的工程里清空实例清单、板级配置只剩 `main.h`,只编库目标 `icbsp`,13 种配置全部符合预期: + +| 配置 | 期望 / 结果 | +| --- | --- | +| 全开;只关 HAL SPI / UART / FDCAN / TIM;四个全关 | 0 error、0 warning | +| `CAN_RX=0`、`CAN_TX=0`、两者都 0、`PATROL=0`、`SYS=0 + PATROL=0` | 0 error、0 warning | +| `SYS=0 + PATROL=1` | 按设计报依赖错(`static_assert`) | +| 关 HAL FDCAN 但 CAN 开关仍为 1 | 0 error、0 warning(`config_check.hpp` 强制关开关) | + +`CAN_RX_ENABLE = 0` 时实际跑 `receive()`(N28)见下面的 C12。 + +## 测试代码改动(宿主 `app/test/`) + +| 项 | 内容 | +| --- | --- | +| 电机组 `test_motor.cpp`(新) | M01~M06 探测(阶段 3 前置):DJI 反馈、DM 寄存器读写与 `sync_ranges()`、使能 / 失能、总线扫描;M07~M09 转动(开关 `BSP_TEST_MOTOR_MOTION`):M3508 速度闭环 ±60 rpm(转子 2500 rpm 中止)、GM6020 电流模式速度闭环 ±30 rpm(200 rpm 中止)、J4340P MIT 零力矩 → 阻尼速度 1 rad/s → 位置 +0.5 rad 斜坡与保持 → 回起点(> 3 rad/s 中止)。J4340P 所在总线用 `BSP_TEST_DM4340_BUS` 选 | +| UART IT 模式(`BSP_TEST_UART10_IT`) | U10 换成 `BspUartT`,UART 组变成 U7(DMA)⇄ U10(IT);`Port<>` 按实例类型实例化 | +| C11 | 加 `HAL_FDCAN_ErrorStatusCallback` 计数判据:CAN2 离线期间 CAN1 的 `err_passive` 增量 ≥ 1(`v[8] = warning << 16 \| passive`) | +| C12(N28) | 只在 `ICBSP_CAN_RX_ENABLE = 0` 的构建里编:CAN2 不经接收节点、直接 `receive()` 读原始缓冲;12 帧按序收全,再不读连发 20 帧核对溢出丢新帧与 `rx_dropped` | +| P04 | 记录 BMI088 `init()` 失败处的源码行号(`v[5]`)与累计次数(`v[6]`) | +| Y13(N13) | 清单外的 `BspCanT`(绑 hfdcan1)/ `BspUartT`(绑 huart7,放进 `.dma_buffer`)`init()` 返回 `BAD_ARG`,重复调用也一样;SPI 的同类检查在 S01 v6 / v7 | +| U16~U20(2026-11-07) | DMA 循环接收专项,见“结果”一节;`IPort` 加 `rx_cap()` | +| U21(2026-11-07) | F2 短段压力,见“结果”一节;`IPort` 加 `tx_idle_kick()` | +| `compile_probe.cpp` | DjiMotor / DmMotor / CAN 节点的实例化放进 `#if ICBSP_CAN_RX_ENABLE && ICBSP_CAN_TX_ENABLE` | + +## 发现并修复的问题 + +| # | 问题 | 处理 | +| --- | --- | --- | +| 1 | **BMI088 `init()` 偶发 IO_ERROR**(库):P04 连续 200 次 `init()`,第 A 轮 Debug 与第 B 轮第一次 Debug 各 48 次失败,失败行都在加速度计软复位后重读 `ACC_CHIP_ID` 处(`device_bmi088.cpp:162`)。`delay_ms(1)` 在调度器启动后调用 `vTaskDelay(1)`,只等到下一个 tick 边界,实际可能远不到 1 ms,不满足“软复位后 1 ms 才能切回 SPI” | `DeviceBmi088::delay_ms()` 改成 `vTaskDelay(pdMS_TO_TICKS(ms) + 1)`,至少等满(库 `ad1259b`)。之后 Debug / -O2 都 0 次失败,单次 `init()` 93 → 108 ms。另加 `get_init_fail_count()` / `get_init_fail_line()` 诊断(库 `255250b`) | +| 2 | **CAN 组整组没编进去**(测试代码):`test_can.cpp` 在包含配置之前写了 `#if ... && !ICBSP_CAN_RX_ENABLE`,宏未定义按 0 算,正常构建只编进 C12,C00~C11 全缺(第 A 轮 CAN 组是关的,没暴露;Flash 232660 → 246264 B 才发现) | 文件开头先包含 `service/system/config_check.hpp`,宏未定义 `#error`;其他测试文件核对过没有同样写法 | +| 3 | C11 新判据取初值太晚(测试代码):CAN2 离线后 CAN1 重发十几次(< 1 ms)就进了错误被动,初值在 40 ms 的离线发送之后才取,增量为 0 | 初值挪到 CAN2 离线之前;-O2 上 `v[8] = 0x10001`(警告 / 被动各 1 次)通过 | +| 4 | GM6020 / J4340P 第一次转动用例失败(M08 超速中止、M09 速度跟不上):6020 增益过大;4340 减速箱摩擦大 | 重新调参:6020 PID(15, 0.3, 0, 3000, 0, 2000);4340 阻尼段 Kd = 3、位置段 Kp = 20 / Kd = 1 | +| 5 | C12 第一次失败(测试代码):先连发 20 帧再读,超过 `bsp_can2` 的接收深度 16 帧,多出的 4 帧按设计丢弃并计 `rx_dropped`,库的行为是对的 | 拆成两段:12 帧(< 深度)全收;不读连发 20 帧,核对收到前 16 帧且 `rx_dropped` +4(顺带测了溢出计数) | +| 6 | **UART 发送巡检“空闲补发”误报**(库):U21 短段连续发送时,sys 任务抢占写者落在“写进流缓冲区 → 拿锁启动”之间,相隔 10 ms 的两次巡检都看到“空闲却有数据”,计成卡死恢复(数据无损) | `tx_recover()` 第二次观察时要求期间没有任何启动才补发;新增诊断 `TxDiag::idle_kick_cnt` / `idle_kick_uart_err` / `idle_kick_dma_err` | + +## 结果 + +### 第 A 轮(电机接着,不跑 CAN 回环) + +服务层 / EventState 与默认树 / UART / RS485 / SPI-BMI088 / 电机六组,SPI 压力 P01 / P02 各 10 分钟,浸泡 5 分钟。 + +| 构建 | 结果 | 原始表 | +| --- | --- | --- | +| Debug | 113 项:106 通过、6 失败、Y12 跳过。M08 / M09 = 问题 4(调参前);P04 = 问题 1;P01 / P02 / P05 = 板子被碰(见下) | `raw/2026-11-06_phase3_roundA_debug.txt` | +| -O2 | 113 项:**111 通过**、P01 失败(板子被碰)、Y12 跳过。P04 0 次失败 | `raw/2026-11-06_phase3_roundA_O2.txt` | +| Debug,UART IT 模式(U10 = IT,只开 UART + SPI 组,含 5 分钟 UART 浸泡) | 47 项**全部通过**;U14 浸泡 300000 / 300000 帧 | `raw/2026-11-06_phase3_uart10_it_debug.txt` | +| Debug,电机 + SPI 组复跑(调参后) | 31 项:30 通过、P05 跳过(浸泡关);M08 +29 / −29 rpm,M09 通过 | — | + +电机(-O2):M07 M3508 +59 / −59 rpm(目标 ±60);M08 GM6020 +29 / −29 rpm(目标 ±30);M09 J4340P 使能 ERR = 1、零力矩段反馈扭矩 ≤ 0.020 N·m、阻尼速度段 0.81 rad/s(目标 1,判据 ±0.3)、位置误差 −9 / +10 mrad(判据 30 mrad),5503 帧反馈;M05 只对 J4340P(J4310 不使能)。 + +### 第 B 轮(拔掉电机,CAN1 ⇄ CAN2 直连) + +服务层 / EventState 与默认树 / CAN / SPI-BMI088 四组,SPI 压力各 10 分钟,浸泡 5 分钟(UART / RS485 第 A 轮已覆盖)。 + +| 构建 | 结果 | 原始表 | +| --- | --- | --- | +| Debug(第一次) | 作废:CAN 组只编进了 C12(问题 2);P04 再次 48 次失败,定位到问题 1 | — | +| Debug | 81 项:77 通过、C11 失败(问题 3)、P02 失败(1 帧,见下)、C06c / Y12 跳过 | `raw/2026-11-06_phase3_roundB_debug.txt` | +| -O2 | 81 项:**78 通过**、P01 失败(振动,见下)、C06c / Y12 跳过。C11 通过 | `raw/2026-11-06_phase3_roundB_O2.txt` | +| Debug,服务层 + 状态树 + CAN 复跑(C11 / Y13) | 60 项:**58 通过**、C06c / Y12 跳过。C11 `v[8] = 0x10001`;Y13 四次 `init()` 都是 `BAD_ARG` | `raw/2026-11-07_phase3_roundB_can_debug.txt` | +| N28(`ICBSP_CAN_RX_ENABLE = 0`,只跑 C12) | 第一次失败(问题 5,用例设计);改后**通过**:12 / 12 帧按序收到;不读连发 20 帧收到前 16 帧、`rx_dropped` +4 | `raw/2026-11-07_phase3_n28_debug.txt` | + +CAN(-O2):C09 浸泡 300000 / 300000 帧 0 丢失;C07 无 ACK 时 TEC 到 128、进入错误被动、不进 Bus-Off,CAN2 恢复后积压 31 帧全部收到;C08 20 轮真实 Bus-Off(`bus_off_events` / `recovery_successes` 各 +138),恢复后链路复测 0 失败;C11(N27 / TX-empty 动态开关)关掉 TX FIFO 空中断后 `tx_stall_recover` +1、32 帧全部补发到、链路复测正常,错误状态回调计到警告 / 被动各 1 次。C06c 是 FIFO 模式按入队顺序发的固有限制(只记录)。 + +### DMA 循环接收专项(2026-11-07,U16~U20) + +补 undo“DMA 循环模式专项测试”。库的 `uart_mode::dma` 接收是循环 DMA:IDLE / HT / TC 都只是“有新数据了”,按“上次读到的位置 → DMA 当前写到的位置”投递,越过缓冲区末尾时分两段(`rx_drain()`);前提是两次事件之间 DMA 写不满一圈。新用例在 UART 组 U15 之后(U7 接收缓冲 R = 128、U10 R = 256;RAW 模式逐字节和 `pattern_byte(序号)` 比对): + +| 用例 | 内容 | Debug | -O2 | +| --- | --- | --- | --- | +| U16a / b 回绕位置全覆盖 | 段长 1、37、R/2±1、R/2、R−1、R、R+1(不超过发送容量)各发 R 段,段间留 ≥ 1 ms 空闲(每段由 IDLE 收尾),段起点落遍缓冲区每个位置 | 75008 / 78592 字节 0 错;覆盖 256 / 256、128 / 128 个起点;跨尾段 162 / 416 | 同左 | +| U17a / b 多圈连续流 | 4 Mbps 不间断发 1 MB(主要靠 HT / TC 推进) | 4096 / 8192 圈 0 错,约 39 万字节/秒 | 0 错,约 39.4 万字节/秒 | +| U18a / b IDLE 风暴 | 每次 1 字节、间隔 40 µs,每个字节单独一次 IDLE(约 1.5 万~2 万次/秒);核对 HAL tick(TIM8 = 15)与 RTOS tick | 2 万字节 0 错,tick 差 0 ms | 0 错,tick 差 0 / 1 ms | +| U19 中断延迟容限(U10 → U7) | 持续发最长帧,每 20 ms 进临界区忙等 D(屏蔽串口 / DMA 中断,25 次);T = U7 收满一圈 = 1388 µs,D = 25% / 45% / 75% / 150% T | 前两档 0 丢失;75%:丢 30 帧、150%:丢 83 帧,**库计数都是 0** | 前两档 0;后两档各丢 3 帧,计数 0 | +| U20 恢复路径压力(U7 → U10) | 持续发帧,50 次让发送端波特率错 25% 3 ms,接收端反复中止 / 重挂循环 DMA | 恢复 66 次、0 重复、tick 差 0、健康、之后无损;未卡死 | 恢复 65 次、0 重复、tick 差 1 ms;未卡死 | + +另跑 IT 模式(`BSP_TEST_UART10_IT = 1`,U10 中断收发,Debug):U16~U19 全部通过(U17a 按 921600,4 Mbps 中断收不过来;U19 四档都无损——发送端 U10 也被屏蔽,屏蔽期间自己停发,不会套圈)。U20 第一次判失败:判据要求恢复次数 > 0,但 HAL 中断接收遇 FE / NE / PE 只回调、不中止,库不需要恢复(计数 0 是对的);判据改成只对循环 DMA 接收端要求恢复,复跑见 `raw/2026-11-07_uart_circ_u10it_debug.txt`。 + +结论:回绕、多圈、IDLE 高频、反复中止重挂都正确,TIM8 = 15 下没有卡死、HAL tick 正常。**使用约束**:串口 / RX DMA 中断被挡住的时间要短于收满半个缓冲区的时间(`RX_SIZE / 2 × 10 / 波特率`,128 字节、921600 下约 0.69 ms),超过时可能被 DMA 套圈,丢失的数据库察觉不到;已写进 `bsp_uart.hpp` 文件头。 + +原始表:`raw/2026-11-07_uart_circ_debug.txt`、`raw/2026-11-07_uart_circ_O2.txt`、`raw/2026-11-07_uart_circ_u10it_debug.txt`。 + +### F2 短段压力(2026-11-07,U21)与巡检“空闲补发”误报的修复 + +评审 F2:任务侧启动 DMA 之后、标记“在传”之前被抢占,短段先发完,完成中断把同一段再发一遍。1.1 已改成先标记再启动。按评审给的条件回归:U21a / b 两端 4 Mbps,分别用 1 / 2 / 3 / 4 字节一次的 `send()` 各连续发 10 万个 pattern 字节,同时 3 个高于收发任务的干扰任务每个 tick 随机忙等 0~30 µs 抢占发送任务;接收端逐字节核对,多收 = 重复发送。 + +结果:Debug / -O2 / U10 IT 模式全部 **0 重复、0 丢失、0 错位**,F2 没有复现。 + +但发送端的“卡死恢复”计数涨了(Debug 17 / 15,-O2 4~11)。库里加了诊断(`TxDiag::idle_kick_cnt` 与当时 UART / DMA ErrorCode 快照)后看到全部是巡检的“通道空闲、却有数据没人启动 → 补发”,ErrorCode 都是 0。再临时加现场快照(不提交)定位:卡住时通道完全空闲(gState READY、DMA 停、NDTR 0、TC 置位),在传段为空,流缓冲区有 1~4 字节,上一次启动就在 1 ms 前;写者在这期间一直在调 `start_transmission()`。结论是**误报**:sys 任务(优先级高于写者)每个 tick 抢占写者,若正好落在 `send()` 的“写进流缓冲区 → 拿 `_tx_lock` 启动”之间,看到的就是“空闲却有数据”;短段连续发送时相隔 10 ms 的两次巡检都落进窗口的概率不低,每次是不同的新数据。数据随后由写者(或被巡检抢先)正常发出,所以没有丢失、重复或延迟,但计数会误报成故障。 + +修复(库 `bsp_uart.hpp` `tx_recover()`):第一次看到“空闲却有数据”时记下 `_tx_last_activity_tick`,第二次只有在这期间**没有任何一次启动**才补发。修后 Debug / -O2 / IT 模式 U21 的补发次数都是 0,整轮 UART 组 `idle_kick_cnt` = 0;U12a / U12b(真卡死)照常由“通道忙但不推进”路径恢复、0 丢帧。U12a 的恢复次数由 14 降到 8~12:修之前混有同样的误报(U12a 也是不间断发帧)。 + +原始表:`raw/2026-11-07_uart_f2_debug.txt`、`raw/2026-11-07_uart_f2_O2.txt`、`raw/2026-11-07_uart_f2_u10it_debug.txt`(都是修复之后的)。 + +### SPI / BMI088 的“不合理帧” + +P01 / P02 / P05 把 |acc| 不在 7~12 m/s² 的帧判为不合理。各轮的不合理帧都能归到机械原因,SPI 层面 0 错误(`errors = 0`、芯片 ID 复核 0 错): + +- 第 A 轮 Debug:成对或成簇出现,加速度最大 39 m/s²,角速度同时变大(板子被碰)。-O2:5 帧,静止孤立帧 0。 +- 第 B 轮 Debug P02:1 帧静止孤立帧,z 从 9.95 跳到 12.3 m/s²,三轴同时变化、角速度近 0;时间线被 P05 覆盖,不能完全排除读错,但数值是物理量级、不是全 0 / 全 1 / 字节错位。 +- 第 B 轮 -O2 P01:24 帧,其中 15 帧被判成“静止孤立”。它们集中在 6 个时刻(约 402 / 409 / 444 / 450 / 832 / 841 s),每次几毫秒内连续几帧在 5.7 与 14.6 m/s² 之间高低交替,前一帧本身也偏离 9.8,角速度都很小——是平动振动(时间上与用户回到桌边操作吻合),不是读错。 +- 测试的“静止”判据只看 |gyro| < 0.2 rad/s,挡不住平动振动;真正的读错应是单帧非物理值、前后帧都正常。今后要更准地区分,可再加“前后帧 |acc| 都在 9.8 ± 0.3”的条件。 + +## undo 阶段 3 对照 + +| 条目 | 结论 | +| --- | --- | +| 主机侧单元测试 + CI | 完成(3.1) | +| 编译矩阵;`CAN_RX_ENABLE = 0` 实际跑 `receive()`(N28) | 完成:矩阵(3.2);C12 实板通过 | +| BSP 实板回归 UART / RS485 / CAN / SPI + BMI088 + UART IT 模式,Debug 与 -O2,浸泡 | 完成(两轮) | +| DMA 循环模式专项(TIM8 = 15 不卡死);F2 短帧压力 | **DMA 循环模式专项完成**(2026-11-07,U16~U20,见上)。TIM8 = 15:UART 组(含 U09~U12 故障注入、U14 浸泡)全程在 TIM8 = 15 下跑,Debug / -O2 / IT 模式都没有卡死。**F2 短段压力完成**(U21,见上),顺带修了巡检“空闲补发”误报 | +| Service:EventState 树(81 条 + 默认树 + 不清 RUNNING)、Online 毫秒语义、N16、N13 | 完成:E01~E14 / O01~O11 / T01~T04 全部通过;N13 = Y13 + S01 | +| 新功能实板:TX-empty 动态开关、ErrorStatusCallback 计数 | 完成(C11) | +| DWT 并发、跨回绕 | Y08:两个任务并发 10 s、跨一次 7.8 s 回绕,0 倒退、0 跳变;每轮实板运行 40 分钟以上(300 圈以上),计时类用例无异常。没有专门跑满 10 圈的用例 | +| N30 转调钩子 | Y05:8 个回调各转调一次 | +| dm_motor / DJI 电机 | 实板:M3508、GM6020、J4340P 转动;J4310 只做了反馈与寄存器读(不使能) | +| 编码器、R9DS、舵机、Emm_V5、DeviceMotor | **只编译验证**(`compile_probe.cpp`,没有硬件) | +| 不打开加热电阻;结果存档 | 满足;本文件与 `raw/` | diff --git a/docs/bsp_test/raw/external_flash_soak_xip_2026-11-10.log b/docs/bsp_test/raw/external_flash_soak_xip_2026-11-10.log new file mode 100644 index 0000000..a3cec5d --- /dev/null +++ b/docs/bsp_test/raw/external_flash_soak_xip_2026-11-10.log @@ -0,0 +1,30 @@ +[20:54:53] Debug-QspiXip: tick 63153 -> 64153 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[20:55:55] Debug-QspiXip: tick 125218 -> 126218 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[20:56:57] Debug-QspiXip: tick 187280 -> 188280 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[20:57:59] Debug-QspiXip: tick 249344 -> 250345 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[20:59:01] Debug-QspiXip: tick 311406 -> 312406 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:00:03] Debug-QspiXip: tick 373468 -> 374468 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:01:05] Debug-QspiXip: tick 435531 -> 436532 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:02:07] Debug-QspiXip: tick 497597 -> 498598 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:03:09] Debug-QspiXip: tick 559659 -> 560660 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:04:11] Debug-QspiXip: tick 621723 -> 622723 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:05:13] Debug-QspiXip: tick 683785 -> 684786 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:06:15] Debug-QspiXip: tick 745846 -> 746848 (+1002/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:07:18] Debug-QspiXip: tick 807915 -> 808915 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:08:20] Debug-QspiXip: tick 869983 -> 870984 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:09:22] Debug-QspiXip: tick 932050 -> 933051 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:10:24] Debug-QspiXip: tick 994116 -> 995115 (+999/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:11:26] Debug-QspiXip: tick 1056182 -> 1057183 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:12:28] Debug-QspiXip: tick 1118246 -> 1119247 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:13:30] Debug-QspiXip: tick 1180313 -> 1181313 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:14:32] Debug-QspiXip: tick 1242377 -> 1243377 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:15:34] Debug-QspiXip: tick 1304440 -> 1305440 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:16:36] Debug-QspiXip: tick 1366506 -> 1367507 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:17:38] Debug-QspiXip: tick 1428570 -> 1429570 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:18:40] Debug-QspiXip: tick 1490634 -> 1491635 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:19:42] Debug-QspiXip: tick 1552699 -> 1553698 (+999/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:20:44] Debug-QspiXip: tick 1614764 -> 1615765 (+1001/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:21:46] Debug-QspiXip: tick 1676830 -> 1677830 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:22:49] Debug-QspiXip: tick 1738891 -> 1739891 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:23:51] Debug-QspiXip: tick 1800956 -> 1801955 (+999/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B +[21:24:53] Debug-QspiXip: tick 1863017 -> 1864017 (+1000/s);fault_record 无;boot 状态 0x00000011;堆最低余量 904 B diff --git a/docs/bsp_test/rs485_u2_u3.md b/docs/bsp_test/rs485_u2_u3.md index a3c8f66..19e805e 100644 --- a/docs/bsp_test/rs485_u2_u3.md +++ b/docs/bsp_test/rs485_u2_u3.md @@ -1,5 +1,7 @@ # RS485 U2 ⇄ U3 测试记录 +> 对应代码:旧库 STM32_BSP `97e138b` + 当天的修复(提交为 `d32a996`)。API 名称是旧的(含后来删掉的软件 DE);当前实现见 `phase3_2026-11-06.md`。 + - 硬件:DM-MC02 板载两路 RS485(引脚图:485-1 = USART2 TX PD5 / RX PD6 / DE PD4;485-2 = USART3 TX PD8 / RX PD9 / DE PB14), A–A、B–B 对接,无额外终端电阻。DE 由 USART 硬件控制(CubeMX “Hardware Flow Control (RS485)”,`HAL_RS485Ex_Init(DE 高有效, DEAT=0, DEDT=0)`)。 - CubeMX 改动见 `changes.md` 第 1 节(USART2 加 DMA / 中断,USART3 改到 PD8/PD9)。 diff --git a/docs/bsp_test/spi_bmi088.md b/docs/bsp_test/spi_bmi088.md index fa65e94..cf8d3b7 100644 --- a/docs/bsp_test/spi_bmi088.md +++ b/docs/bsp_test/spi_bmi088.md @@ -1,5 +1,7 @@ # SPI2 + 板载 BMI088 实机测试(2026-10-27 ~ 10-28) +> 对应代码:旧库 STM32_BSP 工作区(2026-10-29 提交为 `be91caf` / `a79e1ae`)。API 名称是旧的;当前实现的 SPI / BMI088 回归见 `phase3_2026-11-06.md`。 + 对库新增的 `bsp/bsp_spi`(`BspSpi` / `BspSpiDevice`)与 `device/device_bmi088`(`DeviceBmi088`,输出 `service/imu_definition.hpp` 的 `ImuData`) 在 DM-MC02 上做基本功能、错误路径、故障注入、压力 / 浸泡测试,以及人工碰板 / 剧烈晃动对照。自动用例不需要跳线。测试代码 `app/test/test_spi_imu.cpp`,开关 `BSP_TEST_SUITE_SPI_IMU`。 diff --git a/docs/bsp_test/uart_u7_u10.md b/docs/bsp_test/uart_u7_u10.md index 680d281..dbe786d 100644 --- a/docs/bsp_test/uart_u7_u10.md +++ b/docs/bsp_test/uart_u7_u10.md @@ -1,5 +1,7 @@ # UART U7 ⇄ U10 测试记录 +> 对应代码:旧库 STM32_BSP `97e138b` + 当天的修复(提交为 `d32a996`)。API 名称是旧的;当前实现的 UART 回归见 `phase3_2026-11-06.md`。 + - 硬件:DM-MC02,U7 TX PE8 → U10 RX PE2,U10 TX PE3 → U7 RX PE7,同板共地,杜邦线。 - 实例:`bsp_uart7` = `BspUart<128>`,`bsp_uart10` = `BspUart<256>`(同时覆盖两种模板实例),CubeMX 921600 8N1,RX DMA Normal(FIFO 关)、TX DMA(FIFO 开)。 - 代码:`app/test/test_uart.cpp`;结果读 `bsp_test_results[]`(字段含义见各用例注释)。 diff --git a/docs/code/README.md b/docs/code/README.md index 73cb897..8d8c2ac 100644 --- a/docs/code/README.md +++ b/docs/code/README.md @@ -1,61 +1,52 @@ # 代码层索引(code/) -[← README](../../README.md) · [接入指南](../接入指南.md) · [常用接口](../常用接口.md) · [编辑器配置](../编辑器配置.md) +[← README](../../README.md) · [接入指南](../接入指南.md) · [常用接口](../常用接口.md) · [编码规范](../编码规范.md) -源码在仓库根目录的 **`code/`** 下,按依赖关系分六层。本文是入口:先看分层图和依赖矩阵找到层, -再进该层的文档看文件表与接口。 +源码在仓库根目录的 **`code/`** 下,分五层;`service/`、`device/` 再按用途分子目录。本文是入口:先看分层图和依赖矩阵找到层, +再进该层的文档看文件表与接口。每层文档的章节和代码子目录一一对应。 ![分层依赖](../img/layers.png) -> 矢量版:[layers.svg](../img/layers.svg)(可无限放大,适合打印)。 -> 两张图都由 `tools/draw_diagrams.py` 生成,改坐标后重跑即可。 +> 矢量版:[layers.svg](../img/layers.svg)。三张图(分层、启动顺序、工具链)都由 `tools/draw_diagrams.py` 生成,改了代码结构就改脚本重跑。 --- -## 1. 六层各管什么 +## 1. 五层各管什么 -| 目录 | 一句话职责 | 不负责 | 文档 | +| 目录 | 子目录 / 内容 | 不负责 | 文档 | | --- | --- | --- | --- | -| `code/bsp/` | 一个外设怎么初始化、怎么收发(CAN / UART / SPI / PWM / GPIO / Key / Encoder / DWT) | 帧格式、设备语义、重连策略 | [bsp.md](bsp.md) | -| `code/service/` | 系统状态、在线检查、CAN 收发节点、故障记录、库入口 | 具体设备协议 | [service.md](service.md) | -| `code/device/` | 具体设备:DJI 电机、直流电机、舵机、R9DS 遥控、Emm_V5、BMI088、蜂鸣器 | 硬件时序细节(交给 bsp) | [device.md](device.md) | -| `code/protocol/` | 纯编解码:Emm_V5 帧格式与扫描器 | 串口怎么发(交给 device/app) | [protocol.md](protocol.md) | -| `code/algorithm/` | PID、四元数 PID、VQF、矩阵、RLS | 与硬件无关,不碰 HAL | [algorithm.md](algorithm.md) | -| `code/tasks/` | 三个库任务的任务体:sys / can_rx / can_tx | 任务创建(在 service/system.cpp) | [tasks.md](tasks.md) | +| `code/bsp/` | 一个外设怎么初始化、怎么收发:CAN(FDCAN)、UART、SPI、PWM、GPIO、Key、Encoder、DWT;`bsp_series.hpp`(按系列选 HAL 头)、`bsp_dma_buffer.hpp`(`.dma_buffer` 段宏) | 帧格式、设备语义 | [bsp.md](bsp.md) | +| `code/service/` | `system/`:库入口、EventState 与默认状态树、故障记录、配置检查、newlib 锁;`comm/`:CAN 收发节点;`monitor/`:在线检查;`definition/`:电机 / IMU 数据定义 | 具体设备协议 | [service.md](service.md) | +| `code/device/` | `motor/`:DJI 电机、达妙电机、直流电机、Emm_V5(含帧编解码 `emmv5_protocol`);`sensor/`:BMI088;`remote/`:R9DS;`actuator/`:舵机、蜂鸣器 | 硬件时序细节(交给 bsp) | [device.md](device.md) | +| `code/algorithm/` | PID、四元数 PID、四元数、VQF、矩阵、RLS | 与硬件无关,不碰 HAL / RTOS | [algorithm.md](algorithm.md) | +| `code/tasks/` | 三个库任务的任务体:sys / can_rx / can_tx | 任务创建(在 `service/system/system.cpp`) | [tasks.md](tasks.md) | -宿主侧的 `user/app`、`user/board`、`user/module` 不在库里,见 [接入指南 §4.2](../接入指南.md#42-userboard)。 +包含路径只有 `code/`,一律写全子目录:`#include "bsp/bsp_uart.hpp"`、`#include "device/motor/dji_motor.hpp"`。 + +宿主侧的 `user/app`、`user/board`(本库的模板放在 `templates/user/`)不在库里,见 [接入指南](../接入指南.md)。 --- ## 2. 依赖矩阵 -行 = 谁,列 = 依赖谁;`●` 直接 include,`○` 通过 X-macro 清单反向依赖。 - -| | board | bsp | service | device | protocol | algorithm | HAL/FreeRTOS | -| --- | --- | --- | --- | --- | --- | --- | --- | -| **app(宿主)** | ● | | ● | ○ | | | | -| **board(宿主)** | | ● | | ● | | | ● | -| **tasks** | ○ | ● | ● | | | | ● | -| **device** | | ● | ● | | ● | ● | ● | -| **service** | | ● | | | | | ● | -| **bsp** | ○ | | | | | | ● | -| **protocol** | | | | | | | | -| **algorithm** | | | ● | | | | | - -两条硬规则: +行 = 谁,列 = 可以包含谁;`●` 直接 include,`○` 经 X-macro 清单反向包含宿主头文件。库内各层的规则由 `tools/check_layers.py` 检查(CI 里跑)。 -1. **箭头只朝下**:上层依赖下层,下层永远不 include 上层。 -2. 唯一的例外是 `○`:`bsp/` 和 `tasks/` 会 include 宿主的 `board_instances.hpp`, - 靠 X-macro 在编译期把「板子上有哪几个实例」展开进来——没有运行时登记表。 - 这也是为什么漏写实例不会报错,只会「中断不分发」(见 [bsp.md](bsp.md#实例清单x-macro))。 +| | 宿主 board | bsp | service | device | algorithm | HAL / FreeRTOS | +| --- | --- | --- | --- | --- | --- | --- | +| **宿主 app** | ● | | ● | ● | | ● | +| **宿主 board** | | ● | ● | ● | | ● | +| **tasks** | ○ | ● | ● | | | ● | +| **device** | | ● | ● | | ● | ● | +| **service** | | ● | | | ● | ● | +| **bsp** | ○ | | | | | ● | +| **algorithm** | | | | | | | -跨层依赖(不在上面矩阵的相邻格里): +规则: -- `app → service`:`system_init()` / `system_start()` 直接在 `app_init()` 里调 -- `board → bsp`:外设实例在 `board_cfg.hpp` 里构造 -- `device → bsp`:初始化与收发都走 `BspCanT` / `BspUartT` / `BspSpi` -- `device → service`:向 `CanRxNodeT` / `CanTxNodeT` 注册自己 -- `tasks → bsp`:`sys_task` 做 Bus-Off 恢复与串口巡检 +1. **依赖只朝下**。device 和 tasks 互不包含(tasks 不认识任何设备);algorithm 只依赖 C++ 标准库。 +2. 两个头文件各层都能包含:`service/system/status_code.hpp`(纯状态码)、`service/system/config_check.hpp`(读宿主 `hardware_config.h` 的唯一入口:缺宏 `#error`、取值 `static_assert`)。 +3. 唯一的反向依赖是 `○`:`bsp/` 和 `tasks/` 包含宿主的 `board_instances.hpp`,靠 X-macro 在编译期把「板子上有哪几个实例」展开进 HAL 回调分发、巡检和 CAN 收发任务——没有运行时登记表。 + 漏写清单或清单里两个实例绑同一句柄时,对应实例的 `init()` 返回 `BAD_ARG`(`board_init()` 里 `ICBSP_CHECK` 停机),不会静默失效(见 [bsp.md](bsp.md#4-实例清单x-macro))。 --- @@ -68,29 +59,63 @@ ``` MX_FREERTOS_Init() freertos.c 的 USER CODE Init 段 └─ app_init() user/app/app_main.cpp - ├─ ① system_init() 建 sys_state,创建 sys_task / can_rx_task - ├─ ② board_init() 外设 init、设备 init、注册 CAN 节点 + ├─ ① system_init() sys_state、bsp_dwt,创建 sys_task / can_rx_task + ├─ ② board_init() 外设 init、设备 init(各自注册 CAN 节点、挂到默认状态树),每个一行 ICBSP_CHECK + ├─ 创建业务任务 入口先 sys_state.wait_running() └─ ③ system_start() 有发送节点才建 can_tx_task,置运行位 ``` 顺序是硬约束:`board_init()` 里注册的 CAN 节点必须**在 `system_init()` 之后**(要用 `sys_state`)、 -**在 `system_start()` 之前**(`can_tx_task` 按已注册节点决定建不建)。 +**在 `system_start()` 之前**(`can_tx_task` 按已注册节点决定建不建;运行期再注册会被拒绝)。 + +`ICBSP_CHECK(x)` 总会求值(不要写成 `configASSERT(x.init() == …)`,断言可能被定义成空);失败时把文件 / 行号写进 `.noinit` 段的 `fault_record` 再停机,复位后在调试器里 `print fault_record`。 三个任务的周期与职责见 [tasks.md](tasks.md)。 --- -## 4. 建议的阅读顺序 +## 4. 实测状态 + +“实测”= 在 DM-MC02(STM32H723)上按用例跑过,结果有记录;“只编译验证”= 没有硬件或没写用例,只保证 Debug / -O2 0 warning +(头文件模板由回归宿主的 `compile_probe.cpp` 显式实例化)。以阶段 3(ICBSP `phase2` 分支,2026-11-06 ~ 07)为准,用例编号见 +[phase3_2026-11-06.md](../bsp_test/phase3_2026-11-06.md) 与宿主 `app/test/`。 + +| 层 | 模块 | 状态 | 依据 | +| --- | --- | --- | --- | +| bsp | `BspCanT`(H7 FDCAN) | 实测 | C00~C12:收发、扩展帧 / DLC、Bus-Off、无 ACK、TX-empty 动态开关(N27)、错误状态回调、Queue / FIFO、5 分钟浸泡、`CAN_RX_ENABLE = 0`(N28) | +| bsp | `BspCanT`(F4 bxCAN) | 只编译验证 | Rh-i 的 F4 移植;本回归工程(H7)不编译这一分支 | +| bsp | `BspUartT`(DMA / IT) | 实测 | U01~U21、R01~R06:收发、边界、故障注入与恢复、循环 DMA 专项、F2 短段压力、RS485 硬件 DE、IT 模式、浸泡 | +| bsp | `BspSpi` / `BspSpiDevice` | 实测 | S01~S05、P01~P06(经 BMI088) | +| bsp | `BspPwm` | 实测 | Y11(ARR 预装载、`set_freq()` 边界);蜂鸣器开机提示音 | +| bsp | `BspDwt` | 实测 | Y08(两任务并发、跨一次 7.8 s 回绕);没有专门跑满 10 圈 | +| bsp | `icbsp_dma_reachable()` | 实测 | Y10(DTCM / AXI / SRAM4 × DMA1 / BDMA) | +| bsp | `BspGpio`、`BspKey`、`BspEncoder` | 只编译验证 | 没有用例 | +| service | `system`、EventState、默认状态树、`Online` | 实测 | Y01~Y04、E01~E14、O01~O11、T01~T04、Y13(N13) | +| service | `fault_record` | 实测 | Y12、1.4 故意触发 BusFault | +| service | `CanRxNodeT` / `CanTxNodeT` | 实测 | C03~C11 | +| service | `config_check`、功能开关 | 编译验证 | 宿主 `tools/compile_matrix.sh` 13 种配置 | +| service | `newlib_lock` | 只编译验证 | 没有并发浮点打印的用例 | +| device | `DjiMotor` | 实测(M3508、GM6020) | M01 / M02(反馈)、M07 / M08(速度闭环;GM6020 电流模式);M2006 没有实物 | +| device | `DmMotor` | 实测(J4340P) | M03(读寄存器、`sync_ranges()`)、M05(使能)、M09(MIT 零力矩 / 阻尼 / 位置);J4310 只做 M04 的读寄存器与反馈;J8009P 没有实物 | +| device | `DeviceBmi088`(含 VQF 姿态) | 实测 | I01~I07、P01~P06 | +| device | `DeviceBuzzer` | 上板使用 | 开机提示音,没有专门用例 | +| device | `DeviceMotor`、`DeviceServo`、`DeviceR9dsT`、`DeviceEmmv5GroupT`(含 `emmv5_protocol`) | 只编译验证 | 没有硬件;Emm_V5 的 XOR 校验未实测 | +| algorithm | `PID`、`Quaternion`、`MatrixF32`、`Rls` | 主机单元测试 | `tests/host/`(45 条判据);PID 另在 M07 / M08 上板 | +| algorithm | `QuaternionPID` | 只编译验证 | 没有用例 | +| algorithm | `VQF` | 实测 | BMI088 自动刷新任务里运行(I06、P 组) | +| tasks | sys / can_rx / can_tx | 实测 | 随上面各组用例运行 | + +--- -排查问题时的最短路径: +## 5. 建议的阅读顺序 | 想知道 | 看哪里 | | --- | --- | | 某个外设为什么收不到数据 | [bsp.md](bsp.md) 的「实例清单」与「常见坑」 | -| 电机不动 / 报文不对 | [device.md](device.md) → [protocol.md](protocol.md) | +| 电机不动 / 报文不对 | [device.md](device.md) 的 `motor/` 一节与「常见坑」 | | 系统起不来、卡在 `wait_running()` | [service.md](service.md) 的 EventState 与 [启动顺序](#3-启动顺序) | | 为什么会有 10 ms / 1 ms 这种周期 | [tasks.md](tasks.md) | | PID 输出怪 | [algorithm.md](algorithm.md) | -新增代码前先确认「放哪一层」:能只依赖 HAL 的放 `bsp`,涉及具体设备协议的放 `device`, -纯数学放 `algorithm`,跨设备的调度与状态放 `service`。 +新增代码前先确认「放哪一层」:只依赖 HAL 的放 `bsp`,涉及具体设备协议的放 `device` 的对应子目录, +纯数学放 `algorithm`,跨设备的调度与状态放 `service`。改完跑 `python3 tools/check_layers.py`。 diff --git a/docs/code/algorithm.md b/docs/code/algorithm.md index 0d8eda8..c6e5199 100644 --- a/docs/code/algorithm.md +++ b/docs/code/algorithm.md @@ -5,7 +5,8 @@ **职责**:纯数学。不 include HAL、不碰 FreeRTOS 任务、不知道外设存在。 **不负责**:什么时候算、算什么目标(→ `device/` 或 `app/`)。 -只依赖 `service/status_code.hpp` 的 `Status`(纯枚举,不包含 FreeRTOS 头文件;1.4 从 `status.hpp` 拆出来,评审 A6),主机上也能直接编译。 +只依赖 `service/system/status_code.hpp` 的 `Status`(纯枚举,不包含 FreeRTOS 头文件;1.4 从 `status.hpp` 拆出来,评审 A6),主机上也能直接编译: +`tests/host/` 是主机侧单元测试(PID、四元数、Matrix、RLS,CI 里跑;`cmake -S tests/host -B build/host && cmake --build build/host && ctest --test-dir build/host`)。 --- @@ -18,7 +19,8 @@ | `quaternion.hpp/.cpp` | 四元数与向量基础运算 | `Quaternion`、`Vector3` | | `vqf.hpp/.cpp` | VQF 姿态解算(陀螺 + 加速度 + 可选磁力计) | `VQF`、`VQFParams` | | `matrix.hpp/.cpp` | 定长矩阵,编译期维度 | `MatrixF32` | -| `rls.hpp` | 递推最小二乘 | `Rls` | +| `rls.hpp` | 递推最小二乘(只有头文件) | `Rls` | +| `math_constants.hpp` | 常量 | `ICBSP_PI`(double)、`ICBSP_PI_F`(float) | --- @@ -35,16 +37,16 @@ float out = speed.calc(target, feedback, delta_feedback); // 微分项外部直 speed.feed_forward(ff); // 前馈,叠加在输出上 speed.reset(); -PID::Data d = speed.get(); // {target, feedback, output},一次加锁取三个值 +PID::Data d = speed.get(); // {target, feedback, output}(不加锁:跨任务读时由调用方保证) ``` - `i_max = 0` 表示积分上限跟随 `out_max`,**计算时取**:构造后再用链式 `limit_output()` 改输出限幅,积分上限也跟着变(评审 F4)。 -- 输入(目标、反馈、增量、前馈)不是有限值(NaN / Inf)时丢弃这一拍:状态不变、输出保持上一拍,计入 `nonfinite_count()`。 +- 输入(目标、反馈、增量、前馈)不是有限值(NaN / Inf)时丢弃这一拍:状态不变、输出保持上一拍,计入 `get_nonfinite_count()`。 NaN 进了积分就永远出不来,所以在入口挡住(评审 F1)。 - `Quaternion::rotation_vector()` / `normalized()` 对零四元数、非有限值有防护(分别返回零向量 / 单位四元数)。 - `calc()` 每周期调一次,内部顺序是「算输入 → 算微分 → 算积分 → 限幅输出」 -- 输出限幅与积分限幅都在 `Config` 里,**积分抗饱和已内置**(限幅时回退积分) +- 抗饱和靠**积分项单独限幅**(`i_max`,0 = 跟随 `out_max`)和**积分分离**(`i_sep`:误差绝对值超过它时积分项**清零**、不是冻结,0 = 不分离);输出饱和时积分不会回退 - 想自己看波形:`get()` 返回的结构可以直接塞进 `DeviceMotor::pid_frame()` --- @@ -87,20 +89,22 @@ vqf.getQuat6D(out4); // 也提供 getQuat9D / getQuat3D ## 5. MatrixF32 / Rls ```cpp -MatrixF32<3, 3> A{ /* 初始化列表 */ }; +const float a[9] = {4, 7, 2, 3, 6, 1, 2, 5, 3}; +auto A = MatrixF32<3, 3>::from_array(a); // 按行;也有 identity()、transpose()、operator* MatrixF32<3, 3> inv; A.inverse(inv); // 奇异时返回 false A.norm(); A.normalized(); A.trace(); A.approx_equal(B, tol); ``` ```cpp -Rls rls; -rls.init(omega0); // 初始参数估计 -rls.update(x, y); // 递推一步 -rls.reject_count(); // 诊断:被剔除的异常点 +Rls<2, 1> rls(Rls<2, 1>::Config(0.99f, 1000.0f)); // 遗忘因子 λ ∈ (0, 1]、初始协方差 p0;只给一项时别用花括号(有二义性) +rls.init(); // 可传初始参数估计 omega0;参数非法返回 BAD_ARG +rls.update(x, y); // 递推一步;样本含 NaN / Inf 时丢弃并返回 BAD_ARG +rls.omega(); // 当前参数估计 +rls.get_reject_count(); // 诊断:丢弃的非有限样本;另有 get_update_count() / get_trace_limit_count() / get_covariance_reset_count() ``` -`Rls` 内部对协方差矩阵做迹检查与重置,避免长时间运行后数值发散。 +`Rls` 内部限制协方差矩阵的迹(激励不足时遗忘因子 < 1 会让 P 一直长大),P 失去正定时重置为 p0·I,避免长时间运行后数值发散。 --- @@ -109,7 +113,7 @@ rls.reject_count(); // 诊断:被剔除的异常点 | 现象 | 原因 | | --- | --- | | PID 输出在 0 附近高频抖 | 微分用差分且编码器有 ±1 抖动 → 改用 `calc(target, feedback, delta_feedback)` 喂陀螺仪 × 周期 / 滤波值 | -| 积分饱和退不回来 | 只设了输出限幅没设积分限幅(`Config` 两个都要给) | +| 积分饱和退不回来 | 显式给了比 `out_max` 大得多的 `i_max`;`i_max = 0` 时积分上限自动跟随 `out_max`(评审 F4) | | 姿态跟着电机转但方向反 | 四元数误差的轴向定义与实际机体轴不一致(检查轴的符号) | | VQF 越跑越偏 | `delta` 与真实采样周期不一致,或陀螺零偏没标定 | | `inverse()` 总返回 false | 矩阵奇异;RLS 里通常是激励不足(输入长期不变) | diff --git a/docs/code/bsp.md b/docs/code/bsp.md index 921c805..1da60f4 100644 --- a/docs/code/bsp.md +++ b/docs/code/bsp.md @@ -3,7 +3,7 @@ [← 代码层索引](README.md) · [service](service.md) · [device](device.md) **职责**:一个外设「怎么初始化、怎么收发、出错怎么恢复」。 -**不负责**:帧格式(→ `protocol/`)、设备语义(→ `device/`)、重连与调度策略(→ `service/`、`tasks/`)。 +**不负责**:帧格式(→ `device/motor/emmv5_protocol`)、设备语义(→ `device/`)、重连与调度策略(→ `service/`、`tasks/`)。 --- @@ -11,14 +11,17 @@ | 文件 | 职责 | 关键符号 | | --- | --- | --- | -| `bsp_can.hpp/.cpp` | 经典 CAN:收发队列、Bus-Off 恢复、错误中断 | `BspCanT`、`CanRxMsg`、`CanTxMsg` | +| `bsp_can.hpp/.cpp` | CAN 入口:H7 转给 `bsp_fdcan`;F4 在这里实现 bxCAN(回调在 `bsp_can.cpp`) | `BspCanT`、`CanRxMsg`、`CanTxMsg` | +| `bsp_fdcan.hpp/.cpp` | H7 的 FDCAN(经典 CAN 模式):收发缓冲、Bus-Off 恢复、错误状态、诊断计数;回调在 `.cpp` | 同上 | | `bsp_uart.hpp/.cpp` | 串口:IDLE 断帧 + DMA/中断收发 + FreeRTOS 流缓冲 | `BspUartT`、`UartDir`、`uart_mode::dma/it` | | `bsp_spi.hpp/.cpp` | SPI 主机 + 片选设备封装 | `BspSpi`、`BspSpiDevice` | | `bsp_pwm.hpp/.cpp` | PWM 输出(占空比 / 脉宽 / 频率) | `BspPwm` | | `bsp_gpio.hpp` | GPIO 读写(纯头文件,`constexpr` 构造) | `BspGpio` | | `bsp_key.hpp/.cpp` | 按键消抖 + 中断 | `BspKey` | | `bsp_encoder.hpp/.cpp` | 编码器(定时器编码器模式)增量读取 | `BspEncoder` | -| `bsp_dwt.hpp/.cpp` | DWT 计时:微秒/纳秒延时、周期耗时统计 | `BspDwt` | +| `bsp_dwt.hpp/.cpp` | DWT 计时:64 位时间轴、微秒 / 纳秒延时、周期耗时统计 | `BspDwt`、`bsp_dwt` | +| `bsp_series.hpp` | 库内唯一包含 HAL 的地方:按系列选 `stm32h7xx_hal.h` / `stm32f4xx_hal.h`,把 H7 / F4 的命名差异收成宏 | `ICBSP_SERIES_H7` / `ICBSP_SERIES_F4` | +| `bsp_dma_buffer.hpp` | `.dma_buffer` 段宏与 DMA 可达性判断 | `ICBSP_DMA_BUFFER(name)`、`icbsp_dma_reachable()` | --- @@ -26,8 +29,9 @@ ### 2.1 实例放哪 -实例**不在库里**,都在宿主的 `user/board/board_cfg.hpp` 里用 `inline` 定义(C++20 inline 变量), -库里通过 `board_instances.hpp` 的 X-macro 拿到名字。这样库不含任何板级信息,换板只改宿主。 +实例**不在库里**。构造是 constexpr 的(`BspCanT`、`BspUartT`、`BspSpi`、`BspPwm`、`BspGpio`)在宿主 `board_cfg.hpp` 里写成 `inline` 全局变量(C++20), +不是 constexpr 的(`BspSpiDevice` 等)定义在 `board_cfg.cpp`、头文件里 `extern`。库通过 `board_instances.hpp` 的 X-macro 拿到 CAN / UART / SPI 实例的名字。 +这样库不含任何板级信息,换板只改宿主。 ### 2.2 `init()` 一律返回 `Status` @@ -35,8 +39,8 @@ ICBSP_CHECK(bsp_can1.init() == Status::OK); ``` -失败不要在库里 `printf` 后继续,直接在 `board_init()` 里 `configASSERT` 停机: -`fault_record` 会记下调用行号,比静默半初始化好查得多。 +失败不要打印后继续:`board_init()` 里每个 `init()` 单独一行 `ICBSP_CHECK`(`service/system/fault_record.hpp`,总会求值), +失败时把文件 / 行号写进 `fault_record` 再停机,比静默半初始化好查得多。不要写成 `configASSERT(x.init() == …)`:断言可能被定义成空,`init()` 就不调了。 ### 2.3 `.dma_buffer` 段 @@ -62,17 +66,17 @@ inline BspCanT<16, 16> bsp_can1({.hfdcan = &hfdcan1, .name = "CAN1"}); | 方法 | 说明 | | --- | --- | -| `Status init()` / `void deinit()` | 停外设、清缓冲、按 CubeMX 配置重新启动(可重复调用,失败回滚);实例不在 `BSP_CAN_INSTANCES` 里或句柄重复 → `BAD_ARG` | +| `Status init()` / `void deinit()` | 停外设、清缓冲、按 CubeMX 配置重新启动(可重复调用,失败回滚);实例不在 `ICBSP_CAN_INSTANCES` 里或句柄重复 → `BAD_ARG` | | `bool is_ready() const` | 构造时是否给了句柄 | | `Status send(uint32_t id, const uint8_t *data, uint8_t dlc = 8, uint32_t id_type = FDCAN_STANDARD_ID)` | 标准帧 / 扩展帧,DLC 0~8;非阻塞,**只能在任务里调用** | -| `Status receive(CanRxMsg *msg, uint32_t timeout_ms)` | `CAN_RX_ENABLE = 1`:取没被节点认领的帧(回退缓冲,`CAN_RX_RETURN_FRAMES = 0` 时返回 `NOT_SUPPORTED`);`= 0`:取所有收到的帧 | +| `Status receive(CanRxMsg *msg, uint32_t timeout_ms)` | `ICBSP_CAN_RX_ENABLE = 1`:取没被节点认领的帧(回退缓冲,`ICBSP_CAN_RX_RETURN_FRAMES = 0` 时返回 `NOT_SUPPORTED`);`= 0`:取所有收到的帧 | | `Status send_latest(...)` | 参数同 `send()`;同 ID 的上一帧还在驱动里时不入队、返回 `BUSY`(周期帧用,发送节点内部就用它) | | `Status read_raw(...)` / `bool return_frame(...)` | `can_rx_task` 专用 | | `Status service_recovery()` / `bool tx_recover()` | `sys_task` 每 10 ms 调用:Bus-Off 恢复 / 发送兜底 | - `CanRxMsg` = `FDCAN_RxHeaderTypeDef header` + `uint8_t data[8]`(DLC 之后的字节为 0);`CanTxMsg` = `id` + `id_type` + `dlc` + `data[8]`。 -- 只有头文件;`bsp_can.cpp` 只放 HAL 回调。库占用 `HAL_FDCAN_RxFifo0Callback`、`HAL_FDCAN_TxFifoEmptyCallback`、`HAL_FDCAN_ErrorStatusCallback`,宿主不能再定义; - 不在 `BSP_CAN_INSTANCES` 里的 FDCAN 的这三个回调转到弱函数 `icbsp_unhandled_fdcan_*()`,宿主定义同名函数即可接收(见下文“清单外外设的回调”)。 +- 只有头文件。H7 的实现在 `bsp_fdcan.hpp`、HAL 回调在 `bsp_fdcan.cpp`;F4(bxCAN)的实现在 `bsp_can.hpp` 的 `#elif` 分支、回调在 `bsp_can.cpp`,Config 的句柄字段是 `hcan`(F4 分支只编译验证过)。H7 下库占用 `HAL_FDCAN_RxFifo0Callback`、`HAL_FDCAN_TxFifoEmptyCallback`、`HAL_FDCAN_ErrorStatusCallback`,宿主不能再定义; + 不在 `ICBSP_CAN_INSTANCES` 里的 FDCAN 的这三个回调转到弱函数 `icbsp_unhandled_fdcan_*()`,宿主定义同名函数即可接收(见下文“清单外外设的回调”)。 - 远程帧由硬件拒收;DLC > 8 的帧丢弃并计入 `diagnostics.rx_len_drop`。 - TX 队列模式(CubeMX `TxFifoQueueMode = Queue`)下,同一 ID 的帧保证按发送顺序上线(硬件里已有同 ID 的帧时,下一帧先在软件里等)。 - **总线上有更高优先级的流量、可能被占满时用 Queue 模式**:FIFO 模式严格按入队顺序发,排在前面的低优先级帧发不出去时,后面更高优先级的帧也只能等;Queue 模式按 ID 优先级发,配合发送节点的 `send_latest()`(一个周期 ID 最多占一个硬件缓冲),高优先级帧总能先发(实测 C06c / C06d)。 @@ -103,12 +107,14 @@ inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1( - `BspUartT` 只有头文件,`bsp_uart.cpp` 里只有 HAL 回调分发,任意 Transport / 缓冲尺寸都不用补显式实例化。 - `uart_mode::dma` 的接收是**循环 DMA**:`init()` 把 `hdmarx` 改成 Circular + 直接模式(CubeMX 里配 Normal 也可以), IDLE / 半满 / 写满事件只报告 DMA 写到的位置,接收路径不调用阻塞版 `HAL_DMA_Abort()`。接收流缓冲区是 `2 × RX_SIZE`。 -- `init()` 核对实例在 `BSP_UART_INSTANCES` 清单里、且是清单里唯一绑该句柄的实例,否则返回 `BAD_ARG`; +- `init()` 核对实例在 `ICBSP_UART_INSTANCES` 清单里、且是清单里唯一绑该句柄的实例,否则返回 `BAD_ARG`; DMA 模式下还要求配了用到的 RX / TX DMA、实例在 DMA 可达的内存里(`.dma_buffer`)。 - RS485 只支持 UART 硬件 DE(CubeMX 里选 RS485 模式),库不提供软件 DE。 - `receive()` **单读者**:同一个串口只能由一个任务读(FreeRTOS 流缓冲区的限制);`send()` / `printf()` 多写者安全。 - `RxDiag` 里 `pe_cnt` / `fe_cnt` / `ne_cnt` / `ore_cnt` 分别计数线路错误:DMA 模式下 FE / NE / PE 不会中止接收,坏字节照常进流缓冲区,只能靠它们发现(评审 F7)。 - `printf()`:取锁超时返回 `TIMEOUT`,空串返回 `OK`;`tx_recover()` 在 `Config::baudrate = 0` 时按 CubeMX 的波特率估算卡死阈值。 +- **循环接收的前提**:串口 / RX DMA 中断被挡住(临界区、更高优先级中断)的时间要短于收满半个 `RX_SIZE` 的时间(`RX_SIZE / 2 × 10 / 波特率`,128 字节、921600 下约 0.69 ms)。超过时 DMA 可能写满一圈、覆盖还没投递的数据,库的计数察觉不到(阶段 3 U19 实测)。高波特率或有长临界区时加大 `RX_SIZE`。 +- `TxDiag`:`stall_recover_cnt` 是巡检恢复发送的总次数;其中 `idle_kick_cnt` 是“通道空闲、却有数据没人启动”由巡检补发的次数(漏唤醒,正常应为 0),`idle_kick_uart_err` / `idle_kick_dma_err` 是当时 HAL ErrorCode 的快照。 - DMA 可达性按 DMA 控制器判断(`icbsp_dma_reachable()`,`bsp_dma_buffer.hpp`):DMA1 / DMA2 访问不到 ITCM / DTCM; BDMA(LPUART1、SPI6 等)只能访问 SRAM4,`.dma_buffer` 在 AXI SRAM,这些外设的实例 `init()` 会返回 `BAD_ARG`(评审 A4)。 @@ -118,20 +124,21 @@ inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1( inline ICBSP_DMA_BUFFER(bsp_spi2) BspSpi bsp_spi2( {.hspi = &hspi2, .use_dma = true, .dma_threshold = 16U}); -inline BspSpiDevice bmi088_acc_spi(bsp_spi2, - {.cs_port = GYRO_ACC_CS_GPIO_Port, .cs_pin = GYRO_ACC_CS_Pin, .read_flag = 0x80U, .read_dummy = 1U}); +// board_cfg.cpp(BspSpiDevice 的构造不是 constexpr) +BspSpiDevice bmi088_acc_spi(bsp_spi2, + {.cs_port = ACC_CS_GPIO_Port, .cs_pin = ACC_CS_Pin, .read_flag = 0x80U, .read_dummy = 1U}); ``` - `BspSpi` 管总线:`lock()/unlock()` 互斥、`transfer_locked()` 传输;引脚 NSS 必须是**软件**模式 - `BspSpi` 是 constexpr 构造、平凡析构,和 CAN / UART 一样写成 `board_cfg.hpp` 的 inline 实例;`init()` 可重复调用(先 `deinit()` 再重建, - 前提是没有任务正在用这条总线),`deinit()` 中止进行中的传输并释放资源。`init()` 核对实例在 `BSP_SPI_INSTANCES` 里、且清单里只有它绑这个句柄,否则 `BAD_ARG` + 前提是没有任务正在用这条总线),`deinit()` 中止进行中的传输并释放资源。`init()` 核对实例在 `ICBSP_SPI_INSTANCES` 里、且清单里只有它绑这个句柄,否则 `BAD_ARG` - `BspSpiDevice` 管片选与寄存器语义:`read_reg()` / `write_reg()` / `read_reg8()` / `write_reg8()`, 内部做 `select → 发命令 → dummy → 读 → deselect` - `.read_flag`:读命令要或上的位(BMI088 是 `0x80`);`.read_dummy`:读之前要先发的空字节数 ### 清单外外设的回调 -库占用了 UART / SPI / FDCAN 的若干 HAL 回调(宿主不能再定义它们)。宿主自己用 HAL 管、不在 `BSP_*_INSTANCES` 清单里的外设, +库占用了 UART / SPI / FDCAN 的若干 HAL 回调(宿主不能再定义它们)。宿主自己用 HAL 管、不在 `ICBSP_*_INSTANCES` 清单里的外设, 这些回调转到下面的弱函数(默认什么也不做),宿主定义同名强函数即可: | 库占用的回调 | 清单外转到 | @@ -165,8 +172,8 @@ inline BspPwm bsp_pwm_buzzer( | 类 | 构造 | 常用 | | --- | --- | --- | | `BspGpio` | `{port, pin}`,`constexpr` | `set() / reset() / toggle() / set_level(bool) / get_level()` | -| `BspKey` | `{port, pin, active_low, ...}` | `init()` 开中断,`pressed()` 读稳定态 | -| `BspEncoder` | `{htim, ...}` | `init()`,`read_delta()` 取本周期增量,`position()` 累计值,`reset()` 清零;增量按 16 位回绕算,CubeMX 的 Period 必须是 0xFFFF(32 位定时器 0xFFFFFFFF),否则 `init()` 返回 `BAD_ARG`(N37) | +| `BspKey` | `{port, pin, active_low, ...}` | `init()` 开中断,`is_pressed()` 读稳定态 | +| `BspEncoder` | `{htim, ...}` | `init()`,`read_delta()` 取本周期增量,`get_position()` 累计值,`reset()` 清零;增量按 16 位回绕算,CubeMX 的 Period 必须是 0xFFFF(32 位定时器 0xFFFFFFFF),否则 `init()` 返回 `BAD_ARG`(N37) | ### BspDwt @@ -174,7 +181,7 @@ inline BspPwm bsp_pwm_buzzer( bsp_dwt.get_delta_s(&last); // 实例在库内,system_init() 已经 init() 过 ``` -实例由库定义(`code/service/system.cpp`),`init()` 在 `system_init()` 里调用,宿主**不要**再定义或 `init()`。 +实例由库定义(`code/service/system/system.cpp`),`init()` 在 `system_init()` 里调用,宿主**不要**再定义或 `init()`。 CPU 频率由 `init()` 从 RCC 自动推算,**没有配置项**,全局一个实例就够。 | 方法 | 说明 | @@ -192,15 +199,16 @@ CPU 频率由 `init()` 从 RCC 自动推算,**没有配置项**,全局一个 库没有运行时登记表,靠宿主 `board_instances.hpp` 在编译期展开: ```cpp -#define BSP_CAN_INSTANCES(X) X(bsp_can1) // 中断里按这份清单分发 -#define BSP_UART_INSTANCES(X) X(bsp_uart1) // sys_task 串口巡检按此展开 -#define BSP_SPI_INSTANCES(X) /* 无 */ +#define ICBSP_CAN_INSTANCES(X) X(bsp_can1) // 中断里按这份清单分发 +#define ICBSP_UART_INSTANCES(X) X(bsp_uart1) // sys_task 串口巡检按此展开 +#define ICBSP_SPI_INSTANCES(X) /* 无 */ ``` -`code/bsp/bsp_can.cpp` 里三段 `BSP_CAN_INSTANCES(X)` 分别展开成「中断分发」「发送节拍」「恢复」。 +展开的地方:`bsp_fdcan.cpp` / `bsp_uart.cpp` / `bsp_spi.cpp` 的 HAL 回调分发与“是否在清单里”的核对,`can_rx_task` / `can_tx_task` 逐总线处理, +`sys_task` 的 Bus-Off 恢复与串口巡检,`state_tree` 给每个实例建总线节点。 -**漏写不会报错**:编译通过、运行也正常,只是那个实例的中断不会被分发、`sys_task` 也不巡检它。 -表现为「数据收不到」。所以加实例时 `board_cfg.hpp` 与 `board_instances.hpp` 必须一起改。 +**漏写会被 `init()` 拒绝**:实例不在清单里、或清单里两个实例绑同一句柄时,`init()` 返回 `BAD_ARG`(`board_init()` 的 `ICBSP_CHECK` 停机)。 +加实例时 `board_cfg.hpp`、`board_instances.hpp`、`board_cfg.cpp`(`init()`)三处一起改。 --- @@ -209,8 +217,9 @@ CPU 频率由 `init()` 从 RCC 自动推算,**没有配置项**,全局一个 | 现象 | 原因 | | --- | --- | | 串口参数上电变随机值 | `.dma_buffer` 写成 `NOLOAD`,或漏了 `AT> FLASH` | -| 串口 `init()` 返回 `BAD_ARG` | 实例没写进 `BSP_UART_INSTANCES` / 两个实例绑同一句柄 / DMA 模式没配 DMA / 实例不在 `.dma_buffer` | -| CAN 收不到帧 | FDCAN 中断没开 / 过滤器没放行 / 实例没写进 `BSP_CAN_INSTANCES` | +| 串口 `init()` 返回 `BAD_ARG` | 实例没写进 `ICBSP_UART_INSTANCES` / 两个实例绑同一句柄 / DMA 模式没配 DMA / 实例不在 `.dma_buffer` | +| CAN 收不到帧 | FDCAN 中断没开 / 过滤器没放行 / 没有接收节点认领(进了回退缓冲,`diagnostics.rx_unclaimed` 在涨) | +| `init()` 返回 `BAD_ARG` | 实例没写进 `ICBSP_*_INSTANCES`,或清单里两个实例绑同一句柄 | | 多个 SPI 设备互相踩数据 | 没用 `lock()` 包住整笔事务 | | 浮点打印空或乱码 | 宿主 CMake 少了 `-u _printf_float`(nano.specs) | | `get_delta_s()` 返回值离谱 | 两个任务共用了同一个 `last` | diff --git a/docs/code/device.md b/docs/code/device.md index e3c5067..112f26b 100644 --- a/docs/code/device.md +++ b/docs/code/device.md @@ -1,49 +1,78 @@ # device/ — 设备层 -[← 代码层索引](README.md) · [bsp](bsp.md) · [service](service.md) · [protocol](protocol.md) · [algorithm](algorithm.md) +[← 代码层索引](README.md) · [bsp](bsp.md) · [service](service.md) · [algorithm](algorithm.md) · [tasks](tasks.md) **职责**:把某个具体设备「绑定到哪个 BSP、注册到哪个节点、什么时候 init、怎么给指令」封成一个类。 -**不负责**:底层时序(→ `bsp/`)、帧字节布局(→ `protocol/`)、PID 数学(→ `algorithm/`)。 +**不负责**:底层时序(→ `bsp/`)、帧字节布局(→ `device/motor/emmv5_protocol`)、PID 数学(→ `algorithm/`)。 --- ## 1. 文件清单 +目录按设备种类分:`motor/`、`sensor/`、`remote/`、`actuator/`。只有头文件的是模板(按总线实例类型实例化)。 + | 文件 | 设备 | 依赖 | 关键类型 | | --- | --- | --- | --- | -| `dji_motor.hpp/.cpp` | DJI M3508 / M2006 / GM6020 | `BspCanT`、`CanRxNodeT`、`CanTxNodeT` | `DjiMotor` | -| `device_motor.hpp/.cpp` | 直流减速电机 + 编码器 + PID | `BspPwm`、`BspEncoder`、`PID` | `DeviceMotor` | -| `device_servo.hpp/.cpp` | 舵机(脉宽控制) | `BspPwm` | `DeviceServo` | -| `device_r9ds.hpp/.cpp` | R9DS 遥控接收机 | `BspUartT` | `DeviceR9dsT` | -| `device_emmv5_group.hpp/.cpp` | Emm_V5 步进闭环(多地址总线) | `BspUartT`、`emmv5` | `DeviceEmmv5GroupT` | -| `device_bmi088.hpp/.cpp` | BMI088 IMU + VQF 姿态 | `BspSpi`、`VQF` | `DeviceBmi088`、`Bmi088RawData` | -| `device_buzzer.hpp/.cpp` | 无源蜂鸣器 | `BspPwm` | `DeviceBuzzer` | - -设备实例都在宿主 `user/board/board_cfg.hpp` 里 `inline` 定义,init 在 `board_init()`。 +| `motor/dji_motor.hpp` | DJI M3508 / M2006 / GM6020 | `BspCanT`、`CanRxNodeT`、`CanTxNodeT` | `DjiMotor` | +| `motor/dm_motor.hpp` | 达妙 J4310 / J4340P / J8009P(MIT / 位置速度 / 速度) | `BspCanT`、`CanRxNodeT` | `DmMotor`、`DmModel`、`DmMotorFeedback` | +| `motor/device_motor.hpp/.cpp` | 直流减速电机 + 编码器 + PID | `BspPwm`、`BspEncoder`、`PID` | `DeviceMotor` | +| `motor/device_emmv5_group.hpp` | Emm_V5 步进闭环(一条 485 上多个地址) | `BspUartT`、`emmv5_protocol` | `DeviceEmmv5GroupT` | +| `motor/emmv5_protocol.hpp/.cpp` | Emm_V5 帧编解码(纯函数,不碰 HAL / bsp) | — | `emmv5::Frame`、`*Scanner` | +| `sensor/device_bmi088.hpp/.cpp` | BMI088 IMU + VQF 姿态 | `BspSpiDevice`、`VQF` | `DeviceBmi088`、`Bmi088RawData` | +| `remote/device_r9ds.hpp` | R9DS 遥控接收机(SBUS) | `BspUartT` | `DeviceR9dsT` | +| `actuator/device_servo.hpp/.cpp` | 舵机(脉宽控制) | `BspPwm` | `DeviceServo` | +| `actuator/device_buzzer.hpp/.cpp` | 无源蜂鸣器 | `BspPwm` | `DeviceBuzzer` | + +设备类的构造都不是 constexpr(构造时就要绑外设、查参数):实例推荐定义在宿主 `board_cfg.cpp`、头文件里 `extern`;下面示例里写成 `inline` 的也能用(动态初始化,只初始化一次)。`init()` 在 `board_init()` 里逐个 `ICBSP_CHECK`。 --- -## 2. DJI 电机 +## 2. motor/ — 电机 + +### DjiMotor(DJI 电机) ```cpp -enum MotorType { Motor3508 = 0x00, Motor6020 = 0x01, Motor2006 = 0x02 }; +enum class DjiMotorType : uint8_t { M3508 = 0x00, GM6020 = 0x01, M2006 = 0x02 }; -inline DjiMotor chassis_lf(bsp_can1, 1U); // 1 = 电调 ID +inline DjiMotor chassis_lf(bsp_can1, 1U); // 1 = 电调 ID ``` - 模板参数 `type` 决定:**合法 ID 范围**、反馈解析、控制帧映射、限幅、默认减速比 - 构造后必须 `init()`:内部会 `CanRxNodeT::regist()` 注册反馈帧、`CanTxNodeT` 申请发送槽位 - `DjiMotorControlMode::VOLTAGE` / `CURRENT` 只对 GM6020 有效(M3508/C620、M2006/C610 固定电流协议) -- 跨任务读反馈用 `snapshot(MotorData &, DjiMotorRawData *)`(临界区内拷贝同一帧);`data()` 是实时引用,can_rx_task 随时在改。 +- 跨任务读反馈用 `snapshot(MotorData &, DjiMotorRawData *)`(临界区内拷贝同一帧);`get_data()` 是实时引用,can_rx_task 随时在改。 原来的互斥锁去掉了(读者拿不到锁,try-lock 失败时反而把帧当成没人认领,评审 F5) - 构造函数最后一个参数 `online_timeout_ms`(默认 30):多久收不到有效反馈判离线(评审 I4) - 多圈角度 `angle_multi_round` 是 double,直接存双精度结果(评审 F11) - 对象**不可复制/移动**:在线检查节点与控制帧槽位靠对象地址标识 -- `DataUnpack(rx)` 由接收节点回调调用,`FillData(output)` 往发送槽位填值,一般业务只用 `statu()` 和设置输出 +- `unpack(rx)` 由接收节点回调调用,`fill_data(output)` 往发送槽位填值,一般业务只用 `get_status()` 和设置输出 ---- +### DmMotor(达妙电机) + +协议来自 J4310 / J4340P / J8009P 说明书的 CAN 通信一章(`docs/sheet/`),三个系列逐项相同,所以**不按型号做模板**: +型号经 `Config::model`(`DmModel::J4310` / `J4340P` / `J4340P_V11` / `J8009P`)查 `dm_model_info()`(减速比、额定 / 峰值扭矩、空载转速), +MIT 前馈扭矩按峰值扭矩限幅。映射范围是驱动器里可改的寄存器,不能从型号推出:实测 J4340P 是 12.5 / 10 / 28,不是说明书的预设 12.5 / 30 / 10。 + +实板(阶段 3,2026-11-06):J4340P(MIT)读寄存器、`sync_ranges()`、使能 / 失能、零力矩 / 阻尼速度 / 位置控制都通过(宿主 M05 / M09);J4310P 只做了读寄存器与状态反馈(它的 CAN_ID 与同总线 GM6020 冲突,没有使能);J8009P 没有实物,只按说明书核对。 -## 3. 直流电机(DeviceMotor) +```cpp +inline DmMotor yaw_motor(bsp_can2, {.model = DmModel::J4340P, .can_id = 0x02, .master_id = 0x12, + .mode = DmMode::MIT}); // 映射范围留 0 +ICBSP_CHECK(yaw_motor.init() == Status::OK); // board_init() +yaw_motor.sync_ranges(); // 任务里、system_start() 之后:从驱动器读 PMAX / VMAX / TMAX / 模式 +yaw_motor.enable(); // 上电是失能态 +yaw_motor.set_mit(p, v, kp, kd, t); // 控制任务每周期调用 +``` + +- `p_max` / `v_max` / `t_max`:填和驱动器一致的值,或留 0、启动后 `sync_ranges()` 从驱动器读(未知时 `set_*()` 返回 `NOT_INIT`)。填了但和驱动器不一致时 `sync_ranges()` 计入 `Diag::range_mismatch`、在默认树节点记 `BAD_ARG`,之后以驱动器为准;模式同理;Kp ∈ [0, 500]、Kd ∈ [0, 5],超范围限幅,非有限值返回 `BAD_ARG` 不发。 +- 控制帧**不经过 `CanTxNodeT`**:发送槽位过期清零后,MIT 帧全 0 映射成 p = −P_MAX、t = −T_MAX(满负扭矩)。控制帧由 `send_latest()` 直接发,调用方按控制周期持续调用;停发后靠电机自己的通讯丢失保护失能。使能 / 失能 / 清错误 / 设零点用 `send()` 排队发,不会被同 ID 的控制帧挤掉。 +- 反馈是问询式的(电机收到发给自己的帧才回),不发控制帧时会判离线。每台电机的 `master_id` 要不同;反馈里的 ID 只有低 4 位,本类只认 `can_id & 0x0F` 对得上的帧。 +- `switch_mode()` 写 CTRL_MODE 寄存器(不存 flash);写寄存器的回复也走 `master_id`,本类按挂起的那次写识别并吃掉,不当反馈解。 +- **ID 冲突**:驱动器只核对帧 ID 的低 8 位。和 DJI 电机同总线时 `can_id` 的低 8 位要避开 0x01~0x0B(DJI 反馈 0x201~0x20B)和 0xFE / 0xFF / 0x00(DJI 控制帧)。实测 CAN_ID 0x05(速度模式,控制帧 0x205)会把 GM6020 ID 1 的反馈 0x205 当成速度给定。 +- 只需要 `ICBSP_CAN_RX_ENABLE`(控制帧不走发送节点),关了接收路径时包含 `dm_motor.hpp` 会 `#error`。 +- 默认树:节点挂在 CAN 总线节点下,掉线记 `TIMEOUT`,反馈进入故障态(ERR 不是 0 失能 / 1 使能:校准 / 传感器异常、超压 / 欠压 / 过流 / 过温 / 通讯丢失 / 过载)记 `IO_ERROR`;`read_register()` 读寄存器(不用使能,可用来核对 PMAX / VMAX / TMAX / 控制模式)。 + +### DeviceMotor(直流电机) ```cpp inline DeviceMotor motor( @@ -74,68 +103,119 @@ DeviceMotor::PID_TARGET | DeviceMotor::PID_FEEDBACK | DeviceMotor::PID_OUTPUT | **为什么设备不持有串口**:波形发给上位机是调试需求,不是电机的一部分。App 拿 `pid_frame()` 的缓冲 用哪个串口发都行,换传输方式也不用改设备。 ---- - -## 4. 其它设备 +### DeviceEmmv5GroupT<Uart> -### DeviceServo +一条 485 总线上挂多个地址的 Emm_V5: ```cpp -inline DeviceServo servo({.pwm = &bsp_pwm_servo, - .pulse_min_us = 500.0f, // 角度 0 端的脉宽 - .pulse_max_us = 2500.0f, // range_deg 端的脉宽 - .range_deg = 270.0f, // 180° 舵机填 180 - .max_speed_dps = 300.0f, // 0 = 不限速 - .max_accel_dps2 = 1500.0f,// 0 = 不限加速度 - .reversed = false, - .trim_us = 0.0f}); +Status enable(uint8_t addr, bool on); +Status set_velocity(uint8_t addr, emmv5::Direction dir, uint16_t rpm, uint8_t accel); +Status set_position(uint8_t addr, emmv5::Direction dir, uint16_t rpm, uint8_t accel, + int32_t pulses, emmv5::PositionMode mode); +Status stop(uint8_t addr); ``` -`init()` 后 `set_angle(deg)` 设目标,`update()` 周期调用做缓动,`off()` 关输出。 -角度按 `range_deg` 限幅,`set_pulse_us(us)` 可直接给脉宽。PWM 通道必须已配成 50 Hz / 20 ms。 +`lock_bus()` / `unlock_bus()` 用于多条指令的原子性(多任务共用一条 485 时必须包起来)。 +每一帧的字节由 `device/motor/emmv5_protocol.hpp` 负责,设备层只管「发给谁、发什么参数、等不等回复」。 -### DeviceR9dsT<Uart> +- 回复的读取:`take_position()` / `take_status()` / `take_in_position()` **读完就清**(`take_`,N33);`is_in_position(i)` / `is_online(addr)` 只查不清。 +- 校验方式:`Config::checksum` 必须和驱动器菜单 Checksum 一致,支持 `emmv5::Checksum::FIXED_6B`(默认)和 `XOR`(**未实测**;回复帧两种都接受,因为说明书没写回复用哪种)。CRC-8 没有实现(说明书没给参数)。 +- 帧缓冲跟随串口实例的 `TX_SIZE`(`BspUartT::TX_CAPACITY`),MMCL 子命令最多 `TX_SIZE − 5` 字节。 -```cpp -inline DeviceR9dsT rc(bsp_uart3); +**帧编解码(`motor/emmv5_protocol`)** + +纯函数式:没有状态机以外的成员,不 include HAL / bsp;改协议只动它,改收发方式只动设备类。 + +帧布局(EmmV5.0 说明书第 6 章): + +```text +普通命令: 地址(1) + 功能码(1) + 参数(...) + 校验(1) +MMCL 总帧:地址(1) + 0xAA(1) + 总长度(2, 大端,含头尾) + 子命令串(N) + 校验(1) + 子命令 = 一条完整的普通命令(各自带校验字节) ``` -`init()` 注册串口帧处理,`update(timeout_ms)` 取最新通道值,`is_online()` / `frame_lost()` / `failsafe()`; -`update()` 在别的任务里跑时用 `snapshot(Rc &, uint16_t *raw)` 读(评审 F5)。诊断计数 `byte_cnt` / `frame_cnt` 是 `uint32_t`(N34) -用于失控保护。 +- 地址 0x00 是广播(`emmv5::BROADCAST`)。 +- 校验默认是固定字节 `0x6B`(`Checksum::FIXED_6B`);驱动器菜单选 XOR 时用 `Checksum::XOR`(前面全部字节的异或)。回复帧两种都接受。 -### DeviceEmmv5GroupT<Uart> +组帧用现成的函数,每个返回一帧封好口的 `emmv5::Frame`(`data[]` / `size` 是成员,`is_valid()` 检查有没有溢出): -一条 485 总线上挂多个地址的 Emm_V5: +```cpp +emmv5::Frame f = emmv5::enable(addr, true); // 也有 velocity / position / stop / zero_position / + // clear_protection / set_control_mode / quick_position* / read +f.apply_checksum(emmv5::Checksum::XOR); // 驱动器菜单选了 XOR 时 +if (f.is_valid()) { uart.send(f.data, f.size); } +size_t n = emmv5::build_multi_frame(emmv5::BROADCAST, sub, sub_len, out, sizeof(out)); // MMCL 总帧;0 = 放不下 +``` + +解析回复(流式):回复是「到位」「位置」「状态」之类的通知帧,字节流可能粘连 / 截断,所以用扫描器、不一次性解析: ```cpp -Status enable(uint8_t addr, bool on); -Status set_velocity(uint8_t addr, emmv5::Direction dir, uint16_t rpm, uint8_t accel); -Status set_position(uint8_t addr, emmv5::Direction dir, uint16_t rpm, uint8_t accel, - int32_t pulses, emmv5::PositionMode mode); -Status stop(uint8_t addr); +struct InPositionScanner { void reset(); bool feed(uint8_t addr, const uint8_t *data, size_t size); }; +struct PositionScanner { void reset(); bool feed(uint8_t addr, const uint8_t *data, size_t size, int32_t &position); }; +struct StatusScanner { void reset(); bool feed(uint8_t addr, const uint8_t *data, size_t size, uint8_t &status); }; + +emmv5::PositionScanner scanner; +if (scanner.feed(addr, buf, len, position)) { /* 凑满一帧:更新该地址的当前位置 */ } ``` -`lock_bus()` / `unlock_bus()` 用于多条指令的原子性(多任务共用一条 485 时必须包起来)。 -每一帧的字节由 `protocol/emmv5_protocol.hpp` 负责,设备层只管「发给谁、发什么参数、等不等回复」。 +扫描器内部保存半帧状态,**同一路总线的扫描器只能在一个任务里用**。 + +--- + +## 3. sensor/ — 传感器 ### DeviceBmi088 ```cpp -inline DeviceBmi088 imu(bsp_spi_acc, bsp_spi_gyro, - {.acc_range = DeviceBmi088::AccRange::G24, - .gyro_range = DeviceBmi088::GyroRange::DPS2000}); +// board_cfg.cpp(BspSpiDevice / DeviceBmi088 的构造不是 constexpr,不能写成 inline) +BspSpiDevice bmi088_acc_spi(bsp_spi2, {ACC_CS_GPIO_Port, ACC_CS_Pin, 0x80U, 1U}); // 读标志 0x80,加速度计多一个空字节 +BspSpiDevice bmi088_gyro_spi(bsp_spi2, {GYRO_CS_GPIO_Port, GYRO_CS_Pin, 0x80U, 0U}); +DeviceBmi088 imu(bmi088_acc_spi, bmi088_gyro_spi, {DeviceBmi088::AccRange::G24, DeviceBmi088::GyroRange::DPS2000}); ``` - `init()` 做自检与量程配置(加速度计和陀螺仪是两条独立片选) - `update(timeout_ms)` 读原始数据并跑 VQF,`snapshot(ImuData&, Bmi088RawData*)` 取一致的一份快照 -- 诊断计数:`acc_saturation_count()`、`gyro_saturation_count()`、`update_fail_count()`、`attitude_skip_count()` -- `attitude_ready()`:姿态解算过至少一帧才为真;之前 `ImuData` 的四元数是单位四元数(不是全 0),姿态控制要先等它(评审 F1) +- 诊断计数:`get_acc_saturation_count()`、`get_gyro_saturation_count()`、`get_update_fail_count()`、`get_attitude_skip_count()` +- `is_attitude_ready()`:姿态解算过至少一帧才为真;之前 `ImuData` 的四元数是单位四元数(不是全 0),姿态控制要先等它(评审 F1) - 运行中重新 `init()` 与内部刷新任务互斥(刷新锁),不会和正在解算的那一帧并发改 VQF / 芯片(评审 F8) - 调度器启动前的等待用 DWT 忙等,不依赖 HAL 时基中断的优先级(评审 A3) - 自动模式只按陀螺仪节奏刷新,加速度计 INT1 只计数:不需要时宿主可以不转调、或者不开对应 EXTI - `attach_task(handle)` 可绑定任务句柄,让中断/错误能唤醒该任务 +--- + +## 4. remote/ — 遥控接收机 + +### DeviceR9dsT<Uart> + +```cpp +inline DeviceR9dsT rc(bsp_uart3); +``` + +`init()` 注册串口帧处理,`update(timeout_ms)` 取最新通道值,`is_online()` / `is_frame_lost()` / `is_failsafe()`; +`update()` 在别的任务里跑时用 `snapshot(Rc &, uint16_t *raw)` 读(评审 F5)。诊断计数 `byte_cnt` / `frame_cnt` 是 `uint32_t`(N34) +用于失控保护。 + +--- + +## 5. actuator/ — 执行器 + +### DeviceServo + +```cpp +inline DeviceServo servo({.pwm = &bsp_pwm_servo, + .pulse_min_us = 500.0f, // 角度 0 端的脉宽 + .pulse_max_us = 2500.0f, // range_deg 端的脉宽 + .range_deg = 270.0f, // 180° 舵机填 180 + .max_speed_dps = 300.0f, // 0 = 不限速 + .max_accel_dps2 = 1500.0f,// 0 = 不限加速度 + .reversed = false, + .trim_us = 0.0f}); +``` + +`init()` 后 `set_angle(deg)` 设目标,`update()` 周期调用做缓动,`off()` 关输出。 +角度按 `range_deg` 限幅,`set_pulse_us(us)` 可直接给脉宽。PWM 通道必须已配成 50 Hz / 20 ms。 + ### DeviceBuzzer ```cpp @@ -146,14 +226,36 @@ buzzer.tone(1000, 50); // 持续音,音量 50% --- -## 5. 常见坑 +## 6. 默认树里的设备节点(Q6) + +挂在总线上的设备各有一个 EventState 节点,在自己的 `init()` 里挂到所用总线的节点下(`get_state()` 读取): + +| 设备 | 挂在 | 记什么 | +| --- | --- | --- | +| `DjiMotor` | CAN 总线节点 | 初始化失败;掉线(Online 由在线变离线)→ `TIMEOUT` | +| `DmMotor` | CAN 总线节点 | 初始化失败;掉线 → `TIMEOUT`;反馈进入故障态 → `IO_ERROR` | +| `DeviceEmmv5GroupT` | 串口总线节点 | 初始化失败;任一台电机掉线 → `TIMEOUT` | +| `DeviceR9dsT` | 串口总线节点 | 初始化失败;`update()` 发现由在线变离线 → `TIMEOUT` | +| `DeviceBmi088` | SPI 总线节点 | 初始化失败;读帧失败 → 读帧返回的错误码 | + +`DeviceMotor`、`DeviceServo`、`DeviceBuzzer` 不在总线上(PWM / 编码器),没有节点。 + +--- + +## 7. 常见坑 | 现象 | 原因 | | --- | --- | -| `DjiMotor` 编译报 ID 越界 | `Motor3508` 只接受 1–8,`Motor2006` 1–8,`Motor6020` 1–7(以头文件注释为准) | +| `DjiMotor::init()` 返回 `BAD_ARG` | 电调 ID 超范围:M3508 / M2006 是 1~8,GM6020 是 1~7(构造时检查) | +| GM6020 橙灯常亮、不转 | 电调在电流模式,却发了电压指令(0x1FF / 0x2FF);构造时传 `DjiMotorControlMode::CURRENT`(发 0x1FE / 0x2FE) | +| 达妙电机被“别人的帧”带动 | 驱动器只看帧 ID 低 8 位,和 DJI 电机同总线时 `can_id` 撞上了 0x01~0x0B 等(见上) | | 电机抖动不动 | `DeviceMotor` 的 `encoder_multiplier` 与 CubeMX 编码器模式不匹配(TI12 = 4,TI1 = 2) | | 电机低速嗡嗡响 | `deadband_cm_s` 太小,静止时的 ±1 计数被 P 放大成占空比抖动 | -| 多电机只动一个 | 同 ID 冲突,或没写进 `BSP_CAN_INSTANCES` | +| 多电机只动一个 | 同总线两台同 ID(DJI 电调拨码 / 达妙 can_id、master_id) | | Emm_V5 偶发丢指令 | 多任务共用 485 却没 `lock_bus()` | -| BMI088 姿态乱跳 | 片选 `read_dummy` 配错(陀螺仪 1、加速度计 0),或没开 `MasterKeepIOState` | +| BMI088 读数乱 / 芯片 ID 不对 | `BspSpiDevice` 的 `read_dummy` 配反(加速度计读寄存器多一个空字节 = 1,陀螺仪 = 0),或 CubeMX 没开 `MasterKeepIOState` | | 波形发不出去 | `pid_frame()` 只组帧;要在 App 里调 `bsp_uart1.send()` | +| Emm_V5 不响应 | 地址与驱动器设置不一致,或校验方式和驱动器菜单(Checksum)不一致 | +| Emm_V5 偶发丢回复 | 用「读一次就解析」而不是扫描器,遇到半帧就丢 | +| Emm_V5 位置值跳变 | `PositionScanner` 的 `addr` 传错,把别的电机回复当成自己的 | +| Emm_V5 多任务抢 485 | 扫描器状态被两个任务共享;应在 `DeviceEmmv5GroupT` 上 `lock_bus()` | diff --git a/docs/code/protocol.md b/docs/code/protocol.md deleted file mode 100644 index e6b61ca..0000000 --- a/docs/code/protocol.md +++ /dev/null @@ -1,106 +0,0 @@ -# protocol/ — 协议编解码层 - -[← 代码层索引](README.md) · [device](device.md) - -**职责**:把「一条指令」变成字节,或把字节流还原成「一条指令」。 -**不负责**:怎么发出去(→ `device/` 的 `BspUartT`)、发不发(→ `app/`)。 - -这一层是**纯函数式**的:没有状态机以外的成员,不 include HAL、不 include bsp。 - ---- - -## 1. 文件清单 - -| 文件 | 内容 | -| --- | --- | -| `emmv5_protocol.hpp/.cpp` | Emm_V5 步进闭环的帧结构、组装、扫描器 | - ---- - -## 2. Emm_V5 帧格式 - -总帧布局(见 `emmv5_protocol.cpp` 的文件头注释): - -```text -地址(1) + 0xAA(1) + 总长度(2, 大端) + 子命令(N) + 0x6B(1) - └─ 功能码(1) + 参数(...) ┘ -``` - -- 首字节是电机地址(总线多机时区分目标) -- `0xAA` 是帧头,`0x6B` 是固定尾字节 -- 长度字段是**大端**,包含子命令长度 - ---- - -## 3. 关键类型 - -```cpp -namespace emmv5 -{ - enum class Direction : uint8_t; // 正转 / 反转 - enum class PositionMode : uint8_t; // 相对 / 绝对 - enum class SystemParam : uint8_t; // 读写的系统参数项 - - struct Frame - { - void append_u8(uint8_t); - void append_u16(uint16_t); - void append_u32(uint32_t); - void seal(); // 补齐长度 + 尾字节,之后才能发 - bool valid() const; - }; - - struct InPositionScanner { void reset(); bool feed(uint8_t addr, const uint8_t *data, size_t size); }; - struct PositionScanner { void reset(); bool feed(uint8_t addr, const uint8_t *data, size_t size, int32_t &position); }; -} -``` - -### 组装一帧 - -```cpp -emmv5::Frame f; -f.append_u8(static_cast(emmv5::SystemParam::Enable)); -f.append_u8(1); // 使能 -f.seal(); // 长度为 0 时不要发,seal() 之后用 valid() 检查 - -uart.send(f.data(), f.size()); -``` - -### 解析回复(流式) - -Emm_V5 的回复是「位置到达」之类的通知帧,字节流可能有粘连/截断,所以用扫描器而不是一次性解析: - -```cpp -emmv5::PositionScanner scanner; - -// 每收到一段串口数据就喂进去;凑满一帧返回 true,位置写进 position -if (scanner.feed(addr, buf, len, position)) -{ - /* 更新该地址的当前位置 */ -} -``` - -扫描器内部保存半帧状态,**同一路总线的扫描器只能在一个任务里用**。 - ---- - -## 4. 为什么要单独一层 - -`device/device_emmv5_group.hpp` 里每个方法都在做「填参数 → 组帧 → 发 → 等回复」, -如果把字节布局也写在设备类里,改一个字段就要在设备代码里翻半天。 -分开以后: - -- 改协议:只动 `protocol/` -- 改收发方式(485 换成 CAN):只动 `device/` -- 加新指令:`protocol/` 加一个 `append_*` 序列,`device/` 加一个薄封装 - ---- - -## 5. 常见坑 - -| 现象 | 原因 | -| --- | --- | -| 电机不响应 | 忘了 `seal()`(长度字段还是 0),或地址与电机拨码不一致 | -| 偶发丢回复 | 用「读一次就解析」而不是扫描器,遇到半帧就丢 | -| 位置值跳变 | `PositionScanner` 的 `addr` 传错,把别的电机回复当成自己的 | -| 多任务抢 485 | 扫描器状态被两个任务共享;应在 `DeviceEmmv5GroupT` 上 `lock_bus()` | diff --git a/docs/code/service.md b/docs/code/service.md index dadd223..8fb270d 100644 --- a/docs/code/service.md +++ b/docs/code/service.md @@ -11,30 +11,37 @@ | 文件 | 职责 | 关键符号 | | --- | --- | --- | -| `system.hpp/.cpp` | 库入口 + 三个任务体声明;`.dma_buffer` 早期搬运 | `system_init()`、`system_start()`、`sys_state` | -| `status_code.hpp` | 状态码(纯定义,不依赖 RTOS,评审 A6) | `Status`、`status_bit()` | -| `status.hpp/.cpp` | 事件状态树(包含 `status_code.hpp`) | `EventState` | -| `online_check.hpp/.cpp` | 设备在线判定(内部单向链表) | `Online` | -| `can_rx_node.hpp/.cpp` | 按 ID 分发 CAN 帧 | `CanRxNodeT::regist/dispatch` | -| `can_tx_node.hpp/.cpp` | 发送槽位聚合 + 保底心跳 | `CanTxNodeT` | -| `fault_record.hpp/.cpp` | 停机现场(assert / 栈溢出 / 分配失败 / 故障异常) | `FaultKind`、`FaultRecord`、`fault_on_*()`、`ICBSP_CHECK()` | -| `newlib_lock.cpp` | newlib 堆的线程锁(弱符号,评审 A9) | `__malloc_lock` / `__malloc_unlock` | -| `motor_definition.hpp` | 电机通用数据结构 | 供 device / app 共用 | -| `imu_definition.hpp` | IMU 数据结构(`ImuData` 等) | 供 device / app 共用 | +| `system/system.hpp/.cpp` | 库入口、`sys_state` / `bsp_dwt` 实例、sys_task 统计与报告回调、三个任务体声明;`.dma_buffer` 早期搬运 | `system_init()`、`system_start()`、`system_set_report_hook()`、`sys_task_stats` | +| `system/config_check.hpp` | 库读宿主配置的唯一入口:缺宏 / 范围 / 依赖检查 | 包含 `hardware_config.h` | +| `system/status_code.hpp` | 状态码(纯定义,不依赖 RTOS,评审 A6) | `Status`、`status_bit()` | +| `system/status.hpp/.cpp` | 事件状态(包含 `status_code.hpp`) | `EventState` | +| `system/state_tree.hpp/.cpp` | 默认树的总线层:每个清单实例一个节点,按诊断计数记错 | `bus_state()`、`state_tree_poll()` | +| `system/fault_record.hpp/.cpp` | 停机现场(assert / 栈溢出 / 分配失败 / 故障异常) | `FaultKind`、`FaultRecord`、`fault_on_*()`、`ICBSP_CHECK()` | +| `system/newlib_lock.cpp` | newlib 堆的线程锁(弱符号,评审 A9) | `__malloc_lock` / `__malloc_unlock` | +| `monitor/online_check.hpp/.cpp` | 设备在线判定(内部单向链表;可关联设备的 EventState 节点) | `Online` | +| `comm/can_rx_node.hpp` | 按 ID 分发 CAN 帧 | `CanRxNodeT::regist/dispatch` | +| `comm/can_tx_node.hpp` | 发送槽位聚合 + 保底心跳 | `CanTxNodeT` | +| `definition/motor_definition.hpp` | 电机通用数据结构 | 供 device / app 共用 | +| `definition/imu_definition.hpp` | IMU 数据结构(`ImuData` 等) | 供 device / app 共用 | --- ## 2. 入口与生命周期 ```cpp -void system_init(void); // 建 sys_state,创建 sys_task / can_rx_task(调度器未启动,任务不会跑) +void system_init(void); // bsp_dwt、sys_state、默认树总线节点,创建 sys_task / can_rx_task(调度器未启动,任务不会跑) void system_start(void); // 有发送节点才建 can_tx_task;检查初始化错误;置运行位 extern EventState sys_state; +extern BspDwt bsp_dwt; // 库定义、system_init() 里 init(),宿主不要再定义 + +void system_set_report_hook(SystemReportHook hook, uint32_t period_ms); // 周期报告回调(默认没有,库不打印) +extern volatile SysTaskStats sys_task_stats; // cycles / last_us / max_us / avg_us(µs) ``` 调用顺序见 [启动顺序](README.md#3-启动顺序)。要点: -- `system_init()` 里所有失败都用 `configASSERT` 停机,不会「半初始化继续跑」 +- `system_init()` 里每一步都用 `ICBSP_CHECK` 检查,失败写 `fault_record` 停机,不会「半初始化继续跑」 +- sys_task 的耗时统计写在全局 `sys_task_stats`,调试器里直接读;要打印就用 `system_set_report_hook()` 接一个回调(跑在 sys_task 的栈上,回调里 `printf` 要留够 `ICBSP_SYS_TASK_STACK`) - `system_start()` 里 `sys_state.complete_init()` 会把 `board_init()` 阶段登记的 `init_error` 一次性检查 - `system.cpp` 里还有 `.dma_buffer` 的早期搬运(`constructor(101)`),必须在全局构造之前完成 @@ -56,9 +63,9 @@ enum class Status : uint8_t { OK, BUSY, TIMEOUT, FULL, IO_ERROR, BAD_ARG, NOT_IN | `Status error(Status)` | 运行期错误:只记码,不动运行位,**向上传播**到父节点 | | `Status init_error(Status)` | 初始化失败:记码 + 置粘滞失败位 + 清运行位,向上传播。**只在初始化期有效**:本实例已在运行时降级成 `error()`,返回 `NOT_SUPPORTED`(运行期的错误不能让系统停摆) | | `Status clear_error(Status)` / `Status clear_errors()` | 清一个 / 全部错误码;只清本实例、**不传播**,不动失败位与运行位 | -| `bool is_ready()` / `bool running()` | 阶段查询 | -| `Status error_code()` | 未清的错误码里**枚举值最小**的那个(不是最近一次);没有错误返回 `OK` | -| `uint32_t error_bits()` | 未清的错误码位图(`status_bit()` 掩码) | +| `bool is_ready()` / `bool is_running()` | 阶段查询 | +| `Status get_error_code()` | 未清的错误码里**枚举值最小**的那个(不是最近一次);没有错误返回 `OK` | +| `uint32_t get_error_bits()` | 未清的错误码位图(`status_bit()` 掩码) | | `void wait_running()` | 阻塞到运行位;**初始化失败时删除当前任务** | 父子关系只用于「错误向上传播」,**不聚合 running**:子系统 running 不代表父级 running。 @@ -66,6 +73,27 @@ enum class Status : uint8_t { OK, BUSY, TIMEOUT, FULL, IO_ERROR, BAD_ARG, NOT_IN 错误的生命周期:`error()` / `init_error()` 记下的码一直保留(粘滞),直到维护者调 `clear_error()`; 清子节点不会清父节点(父节点上的同一个码可能还来自别的子节点)。初始化失败位永不清除。 +### 默认树(Q6) + +库默认建好三层,宿主不用写代码(`service/system/state_tree.hpp`): + +``` +sys_state 根(system_init() 建) +├─ bus_state(&bsp_can1) 每个 ICBSP_CAN/UART/SPI_INSTANCES 实例一个(system_init() 建,system_start() 进入运行态) +│ └─ DjiMotor::get_state() 设备在自己的 init() 里挂到所用总线下 +├─ bus_state(&bsp_uart1) +└─ bus_state(&bsp_spi2) +``` + +| 谁记错 | 什么时候 | 记什么 | +| --- | --- | --- | +| sys_task(`state_tree_poll()`,10 ms) | 总线实例的诊断计数涨了 | CAN:Bus-Off → `IO_ERROR`,丢帧 / 缓冲满 → `FULL`,发送补救 → `TIMEOUT`;UART:线路 / 重建错误 → `IO_ERROR`,丢字节 → `FULL`,发送卡死恢复 → `TIMEOUT`;SPI:`IO_ERROR` / `TIMEOUT` / 等锁超时 `BUSY` | +| `Online::update()` | 关联了设备节点的 Online 由在线变离线(构造后从没上线过的不算) | 设备节点 `TIMEOUT` | +| 设备 `init()` | 初始化失败 | 设备节点 `init_error()`,一路传到根,`system_start()` 停机 | + +子节点出错只置父节点的错误位,**不清运行位**。查整机有没有出过错看 `sys_state.get_error_bits()`,查是哪条总线看 +`bus_state(&bsp_can1)->get_error_bits()`,查是哪个设备看设备的 `get_state()`。`ICBSP_SYS_TASK_ENABLE = 0` 时总线层不记运行期错误。 + 业务任务的标准开头: ```cpp @@ -89,7 +117,7 @@ public: explicit Online(uint16_t timeout_gap = 30); // 超过多少 ms 没刷新就判离线 Status refresh_task(); // 任务上下文:收到有效数据时刷新 Status refresh_isr(); // 中断上下文:同上,ISR 安全 - Status is_online() const;// OK=在线,TIMEOUT=离线 + bool is_online() const; // true = 在线(2.7 起;之前返回 Status) }; ``` @@ -116,23 +144,23 @@ static bool dispatch(CanT &can, const CanRxMsg &rx); // 有节点消费 - 在**初始化阶段**(`board_init()`)注册,同一 CAN + 帧类型 + ID 不允许重复 - `dispatch()` 由 `can_rx_task` 调用,回调里要短、不能阻塞,`rx` 只在回调期间有效 - `dlc_mask`:接受的数据长度位图(第 n 位 = DLC n),默认只收 8 字节帧,`CAN_DLC_MASK_ANY` 收 0~8;长度不符当作没人认领 -- 返回 `false` 表示没人认领:计入 `diagnostics.rx_unclaimed`,有回退缓冲(`CAN_RX_RETURN_FRAMES > 0`)就放进去,可通过 `BspCanT::receive()` 自己取 +- 返回 `false` 表示没人认领:计入 `diagnostics.rx_unclaimed`,有回退缓冲(`ICBSP_CAN_RX_RETURN_FRAMES > 0`)就放进去,可通过 `BspCanT::receive()` 自己取 ### 发送:`CanTxNodeT` ```cpp static CanTxNodeT *regist(CanT &can, uint32_t can_id, uint8_t division = 1, uint8_t slot = 0, uint32_t id_type = FDCAN_STANDARD_ID); -Status filldata(uint8_t data[], uint8_t slot = 0); // 往聚合缓冲的某个槽位填 8 / division 字节 +Status fill_data(uint8_t data[], uint8_t slot = 0); // 往聚合缓冲的某个槽位填 8 / division 字节 Stats get_stats() const; // sent / partial_sends / heartbeat_sends / expired ``` `can_tx_task` 每 1 ms 检查一次,满足任一条件就把这一帧发出: - **凑齐即发**:所有“有效”槽位都重新填过(过期的、注册了却从没填过的槽位不算); -- **凑不齐时限**:有槽位填了新数据,等了 `CAN_TX_GATHER_MS` 还没凑齐(计入 `partial_sends`,大于 0 说明同帧设备的刷新节拍不一致); -- **保底心跳**:`CAN_TX_HEARTBEAT_MS` 内没发过(计入 `heartbeat_sends`)。 +- **凑不齐时限**:有槽位填了新数据,等了 `ICBSP_CAN_TX_GATHER_MS` 还没凑齐(计入 `partial_sends`,大于 0 说明同帧设备的刷新节拍不一致); +- **保底心跳**:`ICBSP_CAN_TX_HEARTBEAT_MS` 内没发过(计入 `heartbeat_sends`)。 -槽位 `CAN_CMD_EXPIRE_MS` 没被刷新就清零并标为过期;槽位全部注销的节点不再发送。 +槽位 `ICBSP_CAN_CMD_EXPIRE_MS` 没被刷新就清零并标为过期;槽位全部注销的节点不再发送。 发送走 `send_latest()`:同 ID 的上一帧还没发出去时这一帧不入队、下个周期发最新内容,所以总线被占满时一个节点最多在驱动里占一帧。 --- diff --git a/docs/code/tasks.md b/docs/code/tasks.md index a377942..519de92 100644 --- a/docs/code/tasks.md +++ b/docs/code/tasks.md @@ -3,7 +3,7 @@ [← 代码层索引](README.md) · [service](service.md) · [bsp](bsp.md) **职责**:三个常驻任务的任务体。 -**不负责**:任务的创建(在 `code/service/system.cpp`)、周期/优先级/栈深的配置(在宿主 `user/board/hardware_config.h`)。 +**不负责**:任务的创建(在 `code/service/system/system.cpp`)、周期/优先级/栈深的配置(在宿主 `user/board/hardware_config.h`)。 任务体是**薄**的:每个周期只做一次遍历,真正的逻辑都在 `service/` 与 `bsp/` 里。 @@ -13,17 +13,19 @@ | 任务 | 文件 | 周期 | 优先级宏 | 栈深宏 | 谁创建 | 创建时机 | | --- | --- | --- | --- | --- | --- | --- | -| `sys_task` | `sys_task.cpp` | **10 ms**(`SYS_TASK_PERIOD_MS`) | `SYS_TASK_PRIORITY`(idle+6) | `SYS_TASK_STACK`(256 字) | `system_init()` | 无条件(`SYS_TASK_ENABLE`) | -| `can_rx_task` | `can_rx_task.cpp` | **1 ms** | `CAN_TASK_PRIORITY`(idle+8) | `CAN_TASK_STACK`(512 字) | `system_init()` | 开了 FDCAN 且 `CAN_RX_ENABLE` | -| `can_tx_task` | `can_tx_task.cpp` | **1 ms** | `CAN_TASK_PRIORITY` | `CAN_TASK_STACK` | `system_start()` | 板级**有发送节点**才建 | +| `sys_task` | `sys_task.cpp` | **10 ms**(`SYS_TASK_PERIOD_MS`) | `ICBSP_SYS_TASK_PRIORITY`(默认 `configMAX_PRIORITIES − 4`) | `ICBSP_SYS_TASK_STACK`(256 字) | `system_init()` | `ICBSP_SYS_TASK_ENABLE = 1` | +| `can_rx_task` | `can_rx_task.cpp` | **1 ms** | `ICBSP_CAN_TASK_PRIORITY`(默认 `configMAX_PRIORITIES − 2`) | `ICBSP_CAN_TASK_STACK`(512 字) | `system_init()` | 开了 `HAL_FDCAN_MODULE_ENABLED` 且 `ICBSP_CAN_RX_ENABLE = 1` | +| `can_tx_task` | `can_tx_task.cpp` | **1 ms** | `ICBSP_CAN_TASK_PRIORITY` | `ICBSP_CAN_TASK_STACK` | `system_start()` | `ICBSP_CAN_TX_ENABLE = 1` 且板级**有发送节点** | -创建代码在 `code/service/system.cpp`: +三个任务里的 CAN 部分目前只在 H7(`HAL_FDCAN_MODULE_ENABLED`)下编译;F4 的 bxCAN 驱动已有,但任务和节点还没接上。 + +创建代码在 `code/service/system/system.cpp`: ```cpp -system_init(): xTaskCreate(sys_task, "sys", SYS_TASK_STACK, NULL, SYS_TASK_PRIORITY, NULL); - xTaskCreate(can_rx_task, "can_rx", CAN_TASK_STACK, NULL, CAN_TASK_PRIORITY, NULL); +system_init(): xTaskCreate(sys_task, "sys", ICBSP_SYS_TASK_STACK, NULL, ICBSP_SYS_TASK_PRIORITY, NULL); + xTaskCreate(can_rx_task, "can_rx", ICBSP_CAN_TASK_STACK, NULL, ICBSP_CAN_TASK_PRIORITY, NULL); -system_start(): if (has_tx_nodes()) xTaskCreate(can_tx_task, "can_tx", CAN_TASK_STACK, NULL, CAN_TASK_PRIORITY, NULL); +system_start(): if (has_tx_nodes()) xTaskCreate(can_tx_task, "can_tx", ICBSP_CAN_TASK_STACK, NULL, ICBSP_CAN_TASK_PRIORITY, NULL); ``` `can_rx_task` / `can_tx_task` 进循环后第一句都是 `sys_state.wait_running()`: @@ -37,16 +39,19 @@ system_start(): if (has_tx_nodes()) xTaskCreate(can_tx_task, "can_tx", CAN_TASK static_assert(configTICK_RATE_HZ == 1000U, "sys_task requires a 1 kHz FreeRTOS tick"); ``` -每个周期做三件事,全部靠 X-macro 遍历板级实例,**没有运行时登记表**: +每个周期按顺序做下面几件事,总线部分靠 X-macro 遍历板级实例,**没有运行时登记表**: ```cpp -# define X(name) (void)name.service_recovery(); - BSP_CAN_INSTANCES(X) // ① CAN Bus-Off 自恢复 + bsp_dwt.get_cycles(); // ① DWT 64 位时间轴的回绕跟踪(两次调用要短于 7.8 s) + +# define X(name) (void)name.service_recovery(); (void)name.tx_recover(); + ICBSP_CAN_INSTANCES(X) // ② CAN:Bus-Off 自恢复 + 发送兜底(TX-FIFO-EMPTY 中断关着却有帧时补发,N27) -# define X(name) (void)name.rx_recover(); (void)name.tx_recover(); - BSP_UART_INSTANCES(X) // ② 串口收发卡死补救(UART_PATROL_ENABLE) +# define X(name) (void)name.tx_recover(); (void)name.rx_recover(); + ICBSP_UART_INSTANCES(X) // ③ 串口:卡死的发送续发、停摆的接收重建(ICBSP_UART_PATROL_ENABLE) - Online::update(); // ③ 在线计时:超过 timeout_gap 判离线 + Online::update(); // ④ 在线计时:超过 timeout_gap 判离线,关联了设备节点的记 TIMEOUT + state_tree_poll(); // ⑤ 默认树:总线实例的诊断计数涨了就在总线节点上记错 ``` 另外用 DWT 统计本轮耗时,写进全局 `sys_task_stats`(`cycles` / `last_us` / `avg_us`(最近 1 s)/ `max_us`), @@ -65,13 +70,13 @@ system_set_report_hook(app_sys_report, 5000U); // 每 5 s 在 sys_task 里调 for (;;) { # define X(name) can_rx_service(name); - BSP_CAN_INSTANCES(X) + ICBSP_CAN_INSTANCES(X) vTaskDelayUntil(&wake_time, pdMS_TO_TICKS(1U)); } ``` -`can_rx_service()` 每个 tick 最多取 `CAN_RX_DISPATCH_PER_TICK` 帧(防止一帧风暴饿死其它任务), -每帧先校验(标准/扩展帧、数据帧、经典 CAN、DLC=8),再交给 `CanRxNodeT::dispatch()`: +`can_rx_service()` 每个 tick 最多取 `ICBSP_CAN_RX_DISPATCH_PER_TICK` 帧(防止一帧风暴饿死其它任务), +每帧先校验(标准 / 扩展帧、数据帧、经典 CAN;远程帧由硬件拒收、DLC > 8 在中断里已丢弃),再交给 `CanRxNodeT::dispatch()`,长度合不合由各节点的 `dlc_mask` 决定: - 有节点认领:在**本任务里同步**执行回调(要短、不能阻塞) - 没人认领:`can.return_frame(rx)` 放回**回退缓冲**,业务可以用 `can.receive()` 自己取 @@ -84,19 +89,20 @@ for (;;) sys_state.wait_running(); # define X(name) CanTxNodeT::freeze(); CanTxNodeT::init_send_ticks(name, start_tick); - BSP_CAN_INSTANCES(X) // 冻结注册 + 记录起始 tick + ICBSP_CAN_INSTANCES(X) // 冻结注册 + 记录起始 tick for (;;) { # define X(name) CanTxNodeT::service(name); - BSP_CAN_INSTANCES(X) // 槽位聚合 + 保底心跳 + 有效期检查 + ICBSP_CAN_INSTANCES(X) // 槽位聚合 + 保底心跳 + 有效期检查 vTaskDelayUntil(&wake_time, pdMS_TO_TICKS(1U)); } ``` -- **槽位聚合**:同一路 CAN 上的控制帧合并成一帧(DJI 协议一帧带 4 个电机) -- **保底心跳**:100 ms 没有新指令也要重发上一次的值,避免电调超时保护 -- **指令有效期**:超过 100 ms 的旧指令视为失效,不再重复发 +- **槽位聚合**:同一个 ID 的控制帧由多个设备各填一段(DJI 协议一帧带 4 个电机),有效槽位都刷新过就发 +- **凑不齐时限**:有槽位填了新数据、等了 `ICBSP_CAN_TX_GATHER_MS`(默认 1 ms)还没凑齐也发 +- **保底心跳**:`ICBSP_CAN_TX_HEARTBEAT_MS`(默认 5 ms)内没发过就重发当前内容,避免电调超时保护 +- **指令有效期**:槽位 `ICBSP_CAN_CMD_EXPIRE_MS`(默认 100 ms)没被刷新就清零(DJI 电机 = 零输出)并标为过期;达妙电机因此不走发送节点(清零 = MIT 满负扭矩,见 [device.md](device.md)) --- @@ -105,21 +111,21 @@ for (;;) 全部在宿主 `user/board/hardware_config.h`: ```c -#define SYS_TASK_ENABLE 1 -#define SYS_TASK_PRIORITY (configMAX_PRIORITIES - 4) // CMSIS_V2 下 52 -#define SYS_TASK_STACK 256 -#define CAN_TASK_PRIORITY (configMAX_PRIORITIES - 2) // 54;BMI088_TASK_PRIORITY 默认 configMAX_PRIORITIES - 3 -#define CAN_TASK_STACK 512 -#define CAN_RX_ENABLE 1 -#define CAN_TX_ENABLE 1 -#define UART_PATROL_ENABLE 1 +#define ICBSP_SYS_TASK_ENABLE 1 +#define ICBSP_SYS_TASK_PRIORITY (configMAX_PRIORITIES - 4) // CMSIS_V2 下 52 +#define ICBSP_SYS_TASK_STACK 256 +#define ICBSP_CAN_TASK_PRIORITY (configMAX_PRIORITIES - 2) // 54;ICBSP_BMI088_TASK_PRIORITY 默认 configMAX_PRIORITIES - 3 +#define ICBSP_CAN_TASK_STACK 512 +#define ICBSP_CAN_RX_ENABLE 1 +#define ICBSP_CAN_TX_ENABLE 1 +#define ICBSP_UART_PATROL_ENABLE 1 ``` 库任务默认按 `configMAX_PRIORITIES` 往下取(评审 A2),**业务任务必须低于它们**:CubeMX 的 `osPriorityNormal`(24)、 `osPriorityHigh`(40)都可以。原来的 `tskIDLE_PRIORITY + 6~8` 比 `osPriorityNormal` 还低,按 CubeMX 习惯建的业务任务一忙, CAN 节拍、Bus-Off 恢复、串口巡检、Online 计时、IMU 刷新都会被推迟。库里有 `static_assert` 检查取值范围。 -`sys_task` 每 10 ms 还推进一次 DWT 绝对时间的回绕跟踪(`bsp_dwt.get_cycles()`,C11):`SYS_TASK_ENABLE = 0` 时宿主要自己定期调。 +`sys_task` 每 10 ms 还推进一次 DWT 绝对时间的回绕跟踪(`bsp_dwt.get_cycles()`,C11):`ICBSP_SYS_TASK_ENABLE = 0` 时宿主要自己定期调。 改这里不需要动库代码。`sys_task` 的 10 ms 是 `sys_task.cpp` 里的 `constexpr` (和 Online 计时、CAN 恢复节拍绑在一起),**不建议按板子改**。 @@ -132,6 +138,6 @@ CAN 节拍、Bus-Off 恢复、串口巡检、Online 计时、IMU 刷新都会被 | --- | --- | | 编译报 `static_assert configTICK_RATE_HZ == 1000` | CubeMX 里 tick 不是 1 kHz | | `can_tx_task` 没创建 | 板级没有注册任何发送节点(没建 `DjiMotor` 之类) | -| 电机过一会儿停一下 | 保底心跳被改短/改长,或 `can_tx_task` 优先级被业务任务压住 | +| 电机过一会儿停一下 | 控制任务刷新间隔超过了 `ICBSP_CAN_CMD_EXPIRE_MS`(槽位过期清零),或 `can_tx_task` 优先级被业务任务压住 | | 接收回调里卡死整个系统 | 回调里做了阻塞操作(等信号量/打印大段日志) | -| 串口偶发卡死 | `UART_PATROL_ENABLE = 0`,`sys_task` 不再做 `rx/tx_recover()` | +| 串口偶发卡死 | `ICBSP_UART_PATROL_ENABLE = 0`,`sys_task` 不再做 `rx/tx_recover()` | diff --git a/docs/img/layers.png b/docs/img/layers.png index 7354ea7..668e02f 100644 Binary files a/docs/img/layers.png and b/docs/img/layers.png differ diff --git a/docs/img/layers.svg b/docs/img/layers.svg index 04e0c59..9e88a97 100644 --- a/docs/img/layers.svg +++ b/docs/img/layers.svg @@ -1,195 +1,227 @@ - - - -宿主 app/ - -app_main.cpp(app_init) - -StartDefaultTask - -task/*.cpp - -宿主 board/ - -board_cfg.hpp - -board_cfg.cpp(board_init) - -board_instances.hpp - -hardware_config.h - -库 device/ - -dji_motor - -device_motor - -servo - -r9ds - -emmv5_group - -bmi088 - -buzzer - -库 tasks/ - -sys_task(10 ms) - -can_rx_task(1 ms) - -can_tx_task(按需建) - -库 service/ - -system - -status - -online_check - -can_rx_node - -can_tx_node - -fault_record - -库 bsp/ - -can - -uart - -spi - -pwm - -gpio - -key - -encoder - -dwt - -HAL · FreeRTOS · CubeMX 生成的句柄(hfdcan1 / huart1 / htim12 …) - -algorithm/ - -pid - -quaternion_pid - -vqf - -matrix - -rls - -protocol/ -emmv5_protocol(纯编解码) - - -app_init() 调 board_init() - - -board_cfg / board_instances(X-macro 清单) - - -device 用 PID / 四元数 / VQF / 帧编解码 - - -任务的在线状态、系统事件组 - - -service 收发都走 BspCan - - -用 - -依赖只朝下(上层依赖下层) -跨层依赖: -app → service(system_init / start) -board → bsp(实例在 board_cfg 构造) -device → bsp(初始化 / 收发) -device → service(注册 CanRx / CanTx 节点) -tasks → bsp(巡检 / Bus-Off 恢复) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -X-macro + + + +宿主 app/ + +app_main.cpp(app_init) + +app_default_task + +task/*.cpp + +宿主 board/ + +board_cfg.hpp + +board_cfg.cpp(board_init) + +board_instances.hpp + +hardware_config.h + +库 device/ + +dji_motor + +dm_motor + +device_motor + +emmv5_group + +bmi088 + +r9ds + +servo + +buzzer + +库 tasks/ + +sys_task + +can_rx_task + +can_tx_task +10 ms · 1 ms · 有发送节点才建 + +库 service/ + +system/:system + +status(EventState) + +state_tree + +fault_record + +config_check + +comm/:can_rx_node + +can_tx_node + +monitor/:online_check + +definition/:motor · imu + +库 bsp/ + +can + +uart + +spi + +pwm + +gpio + +key + +encoder + +dwt + +dma_buffer + +series + +HAL(按 HAL_*_MODULE_ENABLED 条件编译)· FreeRTOS · CubeMX 生成的句柄 + + +app_init() 调 board_init() + + +设备实例在 board_cfg 构造 + + +注册 CAN 节点 · 挂状态树 + + +巡检 · 分发 + + +收发都走 BspCanT / BspUartT / BspSpi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +X-macro + + + + + + +X-macro + +algorithm/(只依赖 C++ 标准库) + +pid + +quaternion_pid + +quaternion + +vqf + +matrix + +rls + + + + + +device 用 + + + +service 用 + +依赖只朝下(tools/check_layers.py 检查) +algorithm、bsp:只用本层 +service:+ bsp、algorithm +device:+ service、bsp、algorithm +tasks:+ service、bsp(不用 device) +各层都能包含:status_code.hpp、 + config_check.hpp(读宿主配置的入口) +反向只有 X-macro:bsp / tasks 包含 + 宿主 board_instances.hpp diff --git a/docs/img/startup.png b/docs/img/startup.png index d385f4a..81dfd44 100644 Binary files a/docs/img/startup.png and b/docs/img/startup.png differ diff --git a/docs/img/startup.svg b/docs/img/startup.svg index 653162a..e308953 100644 --- a/docs/img/startup.svg +++ b/docs/img/startup.svg @@ -44,7 +44,7 @@ -任何一路 init() 返回非 OK 就 configASSERT 停机,fault_record 记下调用行号,print_uart 能打出来 +每个 init() 一行 ICBSP_CHECK(x.init() == Status::OK):失败写 fault_record(.noinit)后停机,复位后 print fault_record 看 @@ -75,9 +75,9 @@ sys_task -10 ms 周期 · DWT 计时 +10 ms 周期 · Online::update() · 状态树巡检 CAN Bus-Off 恢复 · UART 巡检 -Online::update() · 每 2 s 打印 +耗时统计 · 报告回调(库不打印) can_rx_task 1 ms 周期 @@ -85,8 +85,8 @@ 未认领的进回退缓冲 can_tx_task -槽位聚合 · 保底心跳 -100 ms 指令有效期 +槽位聚合 · 保底心跳 5 ms +指令有效期 100 ms 没有发送节点就不创建 @@ -348,5 +348,7 @@ ③ system_start 有节点才创建 can_tx_task -优先级 / 栈深在宿主 hardware_config.h:CAN_TASK_PRIORITY 最高 + +库任务优先级在宿主 hardware_config.h,按 configMAX_PRIORITIES 取: +CAN −2 > BMI088 −3 > sys −4;业务任务要低于它们(osPriorityNormal 即可) diff --git a/docs/service_test/event_state_online.md b/docs/service_test/event_state_online.md index d9c8af7..b52a298 100644 --- a/docs/service_test/event_state_online.md +++ b/docs/service_test/event_state_online.md @@ -1,5 +1,7 @@ # EventState 父子树 / Online 运行时链表 实板测试(2026-11-01) +> 对应代码:stm32-framework `d5221ea`(本记录随它提交)。API 名称是旧的(`error_code()` 等,2.7 起改成 `get_` / `is_`);阶段 3 在当前代码上重跑了这 81 条判据(E01~E14、O01~O11),见 `../bsp_test/phase3_2026-11-06.md`。 + 对 `service/status`(`Status` + `EventState`)与 `service/online_check`(`Online`)在 DM-MC02 上做实板测试: 接口边界、错误传播、生命周期,以及 `Online` 的毫秒语义、多节点、运行期增删。 diff --git "a/docs/sheet/RM C610\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216 \345\217\221\345\270\203\347\211\210.pdf" "b/docs/sheet/DJI_Motor/RM C610\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216 \345\217\221\345\270\203\347\211\210.pdf" similarity index 100% rename from "docs/sheet/RM C610\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216 \345\217\221\345\270\203\347\211\210.pdf" rename to "docs/sheet/DJI_Motor/RM C610\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216 \345\217\221\345\270\203\347\211\210.pdf" diff --git "a/docs/sheet/RM M2006 P36\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216.pdf" "b/docs/sheet/DJI_Motor/RM M2006 P36\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216.pdf" similarity index 100% rename from "docs/sheet/RM M2006 P36\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216.pdf" rename to "docs/sheet/DJI_Motor/RM M2006 P36\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216.pdf" diff --git "a/docs/sheet/RoboMaster C620\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211V1.01.pdf" "b/docs/sheet/DJI_Motor/RoboMaster C620\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211V1.01.pdf" similarity index 100% rename from "docs/sheet/RoboMaster C620\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211V1.01.pdf" rename to "docs/sheet/DJI_Motor/RoboMaster C620\346\227\240\345\210\267\347\224\265\346\234\272\350\260\203\351\200\237\345\231\250\344\275\277\347\224\250\350\257\264\346\230\216\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211V1.01.pdf" diff --git "a/docs/sheet/RoboMaster GM6020\347\233\264\346\265\201\346\227\240\345\210\267\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\21620231013.pdf" "b/docs/sheet/DJI_Motor/RoboMaster GM6020\347\233\264\346\265\201\346\227\240\345\210\267\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\21620231013.pdf" similarity index 100% rename from "docs/sheet/RoboMaster GM6020\347\233\264\346\265\201\346\227\240\345\210\267\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\21620231013.pdf" rename to "docs/sheet/DJI_Motor/RoboMaster GM6020\347\233\264\346\265\201\346\227\240\345\210\267\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\21620231013.pdf" diff --git "a/docs/sheet/RoboMaster M3508\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216V1.0\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211.pdf" "b/docs/sheet/DJI_Motor/RoboMaster M3508\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216V1.0\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211.pdf" similarity index 100% rename from "docs/sheet/RoboMaster M3508\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216V1.0\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211.pdf" rename to "docs/sheet/DJI_Motor/RoboMaster M3508\347\233\264\346\265\201\346\227\240\345\210\267\345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216V1.0\357\274\210\344\270\255\350\213\261\346\227\245\357\274\211.pdf" diff --git a/docs/sheet/J4340P/DM-J4340P-2EC Geared Motor User Manual V1.2 2026-09-14.pdf b/docs/sheet/J4340P/DM-J4340P-2EC Geared Motor User Manual V1.2 2026-09-14.pdf new file mode 100644 index 0000000..9384205 Binary files /dev/null and b/docs/sheet/J4340P/DM-J4340P-2EC Geared Motor User Manual V1.2 2026-09-14.pdf differ diff --git a/docs/sheet/J4340P/DM-J4340P-2EC V1.1 Geared Motor User Manual V1.4 2026-09-14.pdf b/docs/sheet/J4340P/DM-J4340P-2EC V1.1 Geared Motor User Manual V1.4 2026-09-14.pdf new file mode 100644 index 0000000..8de2422 Binary files /dev/null and b/docs/sheet/J4340P/DM-J4340P-2EC V1.1 Geared Motor User Manual V1.4 2026-09-14.pdf differ diff --git "a/docs/sheet/J4340P/DM-J4340P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.4 2026-09-14.pdf" "b/docs/sheet/J4340P/DM-J4340P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.4 2026-09-14.pdf" new file mode 100644 index 0000000..027ab14 Binary files /dev/null and "b/docs/sheet/J4340P/DM-J4340P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.4 2026-09-14.pdf" differ diff --git "a/docs/sheet/J4340P/DM-J4340P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.2 2026-09-14.pdf" "b/docs/sheet/J4340P/DM-J4340P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.2 2026-09-14.pdf" new file mode 100644 index 0000000..0ee50b2 Binary files /dev/null and "b/docs/sheet/J4340P/DM-J4340P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\344\275\277\347\224\250\350\257\264\346\230\216\344\271\246V1.2 2026-09-14.pdf" differ diff --git a/docs/sheet/J8009P/DM-J8009P-2EC Gear Motor User Manual V1.3 2026-09-10.pdf b/docs/sheet/J8009P/DM-J8009P-2EC Gear Motor User Manual V1.3 2026-09-10.pdf new file mode 100644 index 0000000..0c97bbc Binary files /dev/null and b/docs/sheet/J8009P/DM-J8009P-2EC Gear Motor User Manual V1.3 2026-09-10.pdf differ diff --git a/docs/sheet/J8009P/DM-J8009P-2EC V1.1 Gear Motor User Manual V1.0 2026-09-10.pdf b/docs/sheet/J8009P/DM-J8009P-2EC V1.1 Gear Motor User Manual V1.0 2026-09-10.pdf new file mode 100644 index 0000000..8821c88 Binary files /dev/null and b/docs/sheet/J8009P/DM-J8009P-2EC V1.1 Gear Motor User Manual V1.0 2026-09-10.pdf differ diff --git "a/docs/sheet/J8009P/DM-J8009P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.0 2026-09-10.pdf" "b/docs/sheet/J8009P/DM-J8009P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.0 2026-09-10.pdf" new file mode 100644 index 0000000..d2fc3a7 Binary files /dev/null and "b/docs/sheet/J8009P/DM-J8009P-2EC V1.1 \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.0 2026-09-10.pdf" differ diff --git "a/docs/sheet/J8009P/DM-J8009P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.3 2026-09-10.pdf" "b/docs/sheet/J8009P/DM-J8009P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.3 2026-09-10.pdf" new file mode 100644 index 0000000..6e85e98 Binary files /dev/null and "b/docs/sheet/J8009P/DM-J8009P-2EC \345\207\217\351\200\237\347\224\265\346\234\272\350\257\264\346\230\216\344\271\246 V1.3 2026-09-10.pdf" differ diff --git a/docs/sheet/README.md b/docs/sheet/README.md new file mode 100644 index 0000000..007471f --- /dev/null +++ b/docs/sheet/README.md @@ -0,0 +1,27 @@ +# 器件手册(第三方资料) + +本目录放的是驱动开发时对照用的厂商说明书和板卡资料,**版权归各厂商所有,不属于本仓库的 MIT 许可**,放在这里只为方便查阅。 +请勿把它们当作本库的一部分再分发;以厂商官方渠道发布的最新版为准。厂商或权利人要求删除时,直接从仓库移除。 + +| 文件 | 厂商 / 来源 | 对应的库代码 | +| --- | --- | --- | +| `DJI_Motor/RoboMaster M3508直流无刷减速电机使用说明V1.0(中英日).pdf` | DJI RoboMaster | `device/motor/dji_motor.hpp`(M3508) | +| `DJI_Motor/RoboMaster C620无刷电机调速器使用说明(中英日)V1.01.pdf` | DJI RoboMaster | 同上(C620 电调协议) | +| `DJI_Motor/RM M2006 P36直流无刷减速电机使用说明.pdf` | DJI RoboMaster | `dji_motor.hpp`(M2006) | +| `DJI_Motor/RM C610无刷电机调速器使用说明 发布版.pdf` | DJI RoboMaster | 同上(C610 电调协议) | +| `DJI_Motor/RoboMaster GM6020直流无刷电机使用说明20231013.pdf` | DJI RoboMaster | `dji_motor.hpp`(GM6020,电压 / 电流模式) | +| `DM-J4310-2EC V1.2减速电机说明书V1.2定稿.pdf` | 达妙科技 | `device/motor/dm_motor.hpp`(J4310) | +| `J4340P/`(中 / 英,V1.2 与 V1.1 硬件的 V1.4) | 达妙科技 | `dm_motor.hpp`(J4340P / J4340P_V11) | +| `J8009P/`(中 / 英,V1.3 与 V1.1 硬件的 V1.0) | 达妙科技 | `dm_motor.hpp`(J8009P) | +| `达妙科技DM-MC-Board02电机开发板使用说明书V1.1.pdf`、`CtrBoard-H7管脚标注图.pdf`、`固件更新日志-3.1.docx` | 达妙科技 | 回归宿主用的 DM-MC02 开发板(STM32H723) | + +## 官方渠道 + +- DJI RoboMaster:[robomaster.com](https://www.robomaster.com/) 各组件产品页的下载栏(例如 [组件详情页](https://www.robomaster.com/en-US/products/components/detail/2696)); + C620 说明书在官方 CDN:[RM C620 无刷电机调速器使用说明 V1.01](https://cdn-hz.robomaster.com/robomasters/public/document/RM%20C620%E6%97%A0%E5%88%B7%E7%94%B5%E6%9C%BA%E8%B0%83%E9%80%9F%E5%99%A8%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E%EF%BC%88%E4%B8%AD%E8%8B%B1%E6%97%A5%EF%BC%89V1.01.pdf)。 + 调参 / 固件升级用 RoboMaster Assistant。 +- 达妙科技:向厂商的官方渠道(店铺、技术支持)索取最新版说明书与上位机;2026-11-07 检索时没有找到可以确认的官网下载链接。 + +## 本仓库自己的许可证例外 + +代码部分的许可证例外(VQF、Matrix)见根目录 [README 的“许可证”一节](../../README.md#许可证)。 diff --git "a/docs/\345\244\226\347\275\256Flash.md" "b/docs/\345\244\226\347\275\256Flash.md" new file mode 100644 index 0000000..b84fff4 --- /dev/null +++ "b/docs/\345\244\226\347\275\256Flash.md" @@ -0,0 +1,143 @@ +# 外置 QSPI Flash:小 Flash 型号的程序存放方式 + +STM32H750 / H7B0 / H730 片内只有 128 KB Flash。接入 ICBSP 后,Debug(-O0)构建通常装不下(H750 回归宿主实测 180 KB 链接失败)。 +本库提供三种程序存放方式,用一个 CMake 缓存变量切换,不用重新生成 CubeMX、不用重跑 `integrate.py`: + +| `ICBSP_FLASH_LAYOUT` | 程序在哪里运行 | 容量上限 | 速度 | 调试 | +| --- | --- | --- | --- | --- | +| `INTERNAL` | 片内 Flash(CubeMX 链接脚本,原样) | 片内 Flash | 基准 | 照旧 | +| `QSPI_RAM`(方案 A) | bootloader 从 QSPI 拷进 **AXI SRAM** 运行 | 约 400 KB(512 KB AXI SRAM 扣掉 `.dma_buffer`、`.noinit`) | 实测比片内 Flash 略快(sys_task 一轮 8 µs vs 10 µs) | 直接下载进 RAM,软件断点不限个数,不用写 Flash | +| `QSPI_XIP`(方案 B) | 在 QSPI 上**就地执行**(内存映射 0x90000000) | 芯片容量(W25Q128 = 16 MB,末尾 4 KB 除外) | 实测慢 7~9 倍(sys_task 一轮 75 µs,最长 169 µs;D-Cache 关着,常量也走 QSPI) | 只能硬件断点(8 个),GDB 自动选用 | + +**回归宿主推荐方案 A**:时序和 H723 在片内 Flash 上跑接近,回归数据能直接对比;日常调试不碰 QSPI。代码超过 RAM 能给的空间再用方案 B。 +只支持 **QUADSPI**(H742 / H743 / H750 / H753 等);OCTOSPI(H723 / H730 / H7B0)暂不支持。已实测芯片:W25Q128(W25Q64 / W25Q256 只做过编译验证)。 + +--- + +## 1. 启用 + +在 CubeMX 里先打开 QUADSPI(单 Flash:CLK + NCS + IO0~IO3,Bank 1 或 Bank 2 都行),然后: + +```bash +# 命令行:启用并把默认存放方式设为方案 A,芯片 W25Q128 +python3 third_party/icbsp/tools/integrate.py --external-flash QSPI_RAM --flash-chip W25Q128 +# 可选:.ioc 里 QUADSPI 的参数、引脚速度改成与芯片一致(只影响应用自己用 QSPI;bootloader 不读这些) +python3 third_party/icbsp/tools/integrate.py --fix-ioc qspi_params --regenerate +``` + +或者在 Web UI(`node third_party/icbsp/tools/web_ui/server.mjs`)的“外置 Flash”一节勾选。`.ioc` 有 QUADSPI 且片内 Flash ≤ 128 KB、 +或最近一次构建占片内 Flash ≥ 85%(链接溢出也算)时,脚本会给出 `[注意]`,Web UI 顶部会出现建议横幅。 + +`integrate.py` 写进宿主的东西: + +| 文件 | 内容 | +| --- | --- | +| 根 `CMakeLists.txt` | `# ` 生成区:`include(/cmake/icbsp_flash.cmake)` + `icbsp_flash_layout(TARGET … DEFAULT QSPI_RAM CONFIG …)`,放在 `add_subdirectory()` 之前 | +| `CMakePresets.json` | `RelWithDebInfo`,以及每个构建类型的 `-Internal` / `-QspiRam` / `-QspiXip`(只加缺的,原有预设不动) | +| `user/board/icbsp_flash_config.h` | 芯片容量、JEDEC、Bank、预分频、引脚与复用功能号(引脚取自 `.ioc`,复用号取自 CubeMX 生成的 `quadspi.c`)。整文件生成,重跑会覆盖 | +| `Core/Src/quadspi.c` | `USER CODE BEGIN QUADSPI_Init 0`:`#if defined(ICBSP_FLASH_LAYOUT_QSPI_XIP) return; #endif`——方案 B 时程序正在 QSPI 上执行,不能重新初始化 QUADSPI | +| `Flash/daplink_qspi.cfg` | OpenOCD:引脚 / QUADSPI 初始化 + `stmqspi` bank(只在外置 Flash 方案下用;日常的 `daplink.cfg` 照旧不注册外置 bank) | +| `Flash/OpenOCD_flash.*`、`JLink_flash.*` | 旧版不认存放方式时换成新版 | +| `.vscode/launch.json` | `cmsis-dap-debug (QSPI_RAM)`、`cmsis-dap-debug (QSPI_XIP)` 两个调试配置 | + +## 2. 切换 + +```bash +cmake --preset Debug-QspiRam && cmake --build --preset Debug-QspiRam # 方案 A +cmake --preset Debug-QspiXip && cmake --build --preset Debug-QspiXip # 方案 B +cmake --preset RelWithDebInfo-Internal && cmake --build --preset RelWithDebInfo-Internal # 片内(装得下时) +``` + +不带后缀的 `Debug` / `Release` 用生成区里的 `DEFAULT`。也可以 `-DICBSP_FLASH_LAYOUT=QSPI_XIP` 直接改缓存变量。 + +外置方案构建出来的东西(`build/<预设>/` 下): + +| 文件 | 用途 | +| --- | --- | +| `<工程名>.elf` | 方案 A:运行地址 = 加载地址 = AXI SRAM(调试器直接下载进 RAM);方案 B:在 0x90000400,0x90000000 的镜像头已填好 | +| `<工程名>_qspi.bin` / `.hex` | 写进 QSPI 0x90000000 的镜像(1 KB 镜像头 + 程序) | +| `icbsp_boot/icbsp_boot.elf` | bootloader(片内 Flash 0x08000000,约 2 KB);A、B 共用同一个,切换方案不用重烧 | + +## 3. 烧录与调试 + +```bash +bash Flash/OpenOCD_flash.sh Debug-QspiRam # bootloader(与板上不同才烧)+ QSPI 镜像 +bash Flash/OpenOCD_flash.sh Debug-QspiRam --ram # 方案 A:直接下载进 AXI SRAM 运行,不写任何 Flash(调试迭代用,掉电即失) +bash Flash/OpenOCD_flash.sh Debug-QspiXip --boot # 强制重烧 bootloader +``` + +脚本从构建目录的 `CMakeCache.txt` 读 `ICBSP_FLASH_LAYOUT`,`INTERNAL` 时和以前一样。J-Link 脚本只支持片内 Flash(遇到外置方案会提示改用 OpenOCD)。 + +VS Code(cortex-debug): + +- **`cmsis-dap-debug (QSPI_RAM)`**:`monitor reset halt` → `load`(写进 RAM)→ 按 0x24000000 的向量表设 `sp` / `pc`,不经过 bootloader。 + 软件断点不限个数(实测 11 个全部命中)。 +- **`cmsis-dap-debug (QSPI_XIP)`**:用 `Flash/daplink_qspi.cfg`,GDB 的 `load` 经 `stmqspi` 写进 QSPI,复位后由 bootloader 跳转;GDB 对只读区 + 自动改用硬件断点(最多 8 个)。`daplink_qspi.cfg` 在 GDB 连上时(`gdb-attach`)先复位并初始化 QSPI、探测芯片——否则 GDB 拿到的内存映射里 + 0x90000000 不是 Flash,`load` 会退化成普通写内存而失败。 +- 第一次用前先跑一遍 `OpenOCD_flash`(板上要有 bootloader)。 + +## 4. 原理 + +### 4.1 bootloader(`boot/`,寄存器级,不用 HAL) + +1. HSI 64 MHz 运行,不开 PLL(应用的 `SystemClock_Config()` 可以照常从复位状态配置时钟);只用 DTCM,不碰 AXI SRAM 的 `.noinit` +2. 配 QSPI 引脚和 QUADSPI;W25Q 软复位(66h / 99h)、核对 JEDEC 厂商与容量、四线使能位 QE 没置就写上、> 16 MB 进 4 字节地址 +3. 内存映射(0xEB 四线读,模式字节 0xFF + 4 个空周期),MPU 第 13~15 区(见 4.3) +4. 校验 0x90000000 的镜像头(magic、头 CRC、各字段范围)和程序 CRC-32(CRC 外设,与 `tools/qspi_image.py` 的 zlib 算法一致) +5. 方案 A:程序拷到 0x24000000,退出内存映射、复位 QUADSPI、清 MPU 区,跳转;方案 B:保持内存映射和 MPU 区,跳转 +6. 跳转前关 SysTick、清 NVIC 使能与挂起、关 I-Cache,设 VTOR / MSP + +**启动状态**写在 `0x3800FFE0`(RAM_D3 末尾 32 字节,外置方案的链接脚本让出了这块),调试器直接读: + +| 偏移 | 内容 | +| --- | --- | +| +0 | `0x544F4F42`('BOOT') | +| +8 | 状态:`0x10` 已跳到方案 A、`0x11` 已跳到方案 B;`2` QSPI 超时、`3` JEDEC 不符、`4` QE 写不进、`5` 没有镜像、`6` 镜像头字段越界、`7` CRC 不对、`8` 向量表不合理 | +| +12 | 细节(JEDEC 不符时是读到的 ID,CRC 不对时是算出来的 CRC,跳转时是程序地址) | +| +16 / +20 / +24 / +28 | JEDEC ID、镜像 layout、镜像大小、QUADSPI_CR | + +```bash +openocd -f Flash/daplink.cfg -c init -c "mdw 0x3800FFE0 8" -c shutdown +``` + +### 4.2 镜像头(`boot/icbsp_boot.h`、`tools/qspi_image.py`) + +0x90000000 起 32 字节(补 0xFF 到 1 KB),全部 uint32:magic `'ICBI'`、version、layout(1 = A,2 = B)、加载地址、向量表地址、程序大小、程序 CRC、头 CRC。 +程序从 0x90000400 开始(满足 VTOR 的 1 KB 对齐)。方案 B 的链接脚本在 0x90000000 预留了 `.icbsp_image_header` 段,构建后由 `qspi_image.py` +把长度和 CRC 写回 ELF,所以调试器直接下载 ELF 也是有效镜像。 + +### 4.3 MPU(区号 13~15 归 bootloader,应用别用) + +| 区 | 范围 | 属性 | 为什么 | +| --- | --- | --- | --- | +| 13 | 0x90000000,256 MB | 禁止访问、不可执行 | M7 会推测访问 Normal 区域;访问到芯片以外的地址会让 QUADSPI 把总线卡死 | +| 14 | 0x90000000,芯片容量 | 只读、可执行、写通 cache | 程序 / 常量所在 | +| 15 | 芯片最后 4 KB | 禁止访问 | **实测**:内存映射读芯片最后一个字时 QUADSPI 预取越过芯片末尾,总线永久挂死(调试器都停不下内核,只能复位);有了这一区只会进 MemManage | + +CubeMX 生成的 `MPU_Config()` 只改它自己的区号(默认第 0 区:0x60000000~0xDFFFFFFF 禁止访问),`HAL_MPU_Disable()` 不清区配置, +所以方案 B 下 13~15 区一直有效,**不用改 .ioc 的 MPU 设置**。方案 A 跳转前 bootloader 会把这三区清掉。 + +### 4.4 链接脚本(`templates/flash_layout/`,构建时生成到构建目录) + +- 方案 A:向量表、代码、常量、`.dma_buffer`(运行地址 = 加载地址)、`.data` 的初值都在 AXI SRAM 且排在最前;NOLOAD 段(`.noinit`、`.bss`)排在后面, + 所以 bootloader 拷贝时不会覆盖 `.noinit` 里的 `fault_record`。`.data` / `.bss` / 堆栈仍在 DTCM。 +- 方案 B:镜像头 + 代码 + 常量 + 初值在 QSPI,`.dma_buffer` / `.noinit` 在 AXI SRAM,`.data` / `.bss` / 堆栈在 DTCM。 +- 两者都带 `.dma_buffer` / `.noinit`,库的链接脚本检查照常通过;堆 / 栈大小取自宿主原来的 CubeMX 链接脚本。 + +## 5. 限制与注意 + +- 应用不能用 MPU 第 13~15 区;方案 B 下应用不能初始化 QUADSPI(`quadspi.c` 的 USER CODE 已处理),也不能擦写 QSPI(擦写时要退出内存映射, + 而程序正在 QSPI 上执行)。方案 A 没有这个限制:应用里 `MX_QUADSPI_Init()` 照常执行,可以把 QSPI 当存储用(注意别覆盖 0x90000000 起的镜像)。 +- QUADSPI 时钟 = HCLK3 / (预分频 + 1):预分频按应用的最终 HCLK3(240 MHz)选,默认 2 → 80 MHz;`integrate.py` 会拒绝超过芯片上限的设置。 +- 方案 A 的程序上限受 AXI SRAM 限制(约 400 KB);超过时链接器报 `RAM` 溢出,换方案 B。 +- OpenOCD 校验 ELF 时会对比 ld 映射进 0x20000000 的“ELF 头段”,在方案 A 的 `--ram` 下误报不一致,脚本因此不做 `verify_image`。 +- AXI SRAM 带 ECC:调试器单独写一个 32 位字会留在 ECC 写缓冲里,复位后丢失——清 `fault_record` 时一次写 16 字节(`mww <地址> 0 4`)。 +- Windows 的 `.bat` 与 Linux 的 `.sh` 逻辑相同,但只在 Linux 上实测过。 +- 方案 A 在 AXI SRAM 里打软件断点绝大多数情况正常(实测 11 个同时命中),但偶尔 OpenOCD 报 `can't add breakpoint: unknown reason`、 + GDB 报 `Cannot access memory`(`step` 的临时断点上遇到过两次);遇到时改用 `hbreak`(硬件断点),原因待查。 + +## 6. 实测记录 + +H750_FULL_TEST(STM32H750VBT6 + W25Q128JV,QUADSPI Bank 2:PB2 / PC11 / PE7~PE10)、CMSIS-DAP(Horco)、OpenOCD 0.12: +见 [bsp_test/external_flash_2026-11-10.md](bsp_test/external_flash_2026-11-10.md)。 diff --git "a/docs/\345\270\270\347\224\250\346\216\245\345\217\243.md" "b/docs/\345\270\270\347\224\250\346\216\245\345\217\243.md" index f48c40b..6fae7ad 100644 --- "a/docs/\345\270\270\347\224\250\346\216\245\345\217\243.md" +++ "b/docs/\345\270\270\347\224\250\346\216\245\345\217\243.md" @@ -22,7 +22,7 @@ UartDir::TxRx ``` - DMA 模式的实例必须放在 `.dma_buffer` 段:声明前加 `ICBSP_DMA_BUFFER(变量名)`(`bsp_dma_buffer.hpp`,展开成 `section(".dma_buffer.<变量名>")`,段名按变量唯一) -- `BspUartT` 只有头文件,缓冲区大小随便改,不用补显式实例化;实例必须写进 `board_instances.hpp` 的 `BSP_UART_INSTANCES`(`init()` 会核对) +- `BspUartT` 只有头文件,缓冲区大小随便改,不用补显式实例化;实例必须写进 `board_instances.hpp` 的 `ICBSP_UART_INSTANCES`(`init()` 会核对) - 调试打印走 `board_cfg.hpp` 里的 `print_uart(...)`,等价于 `bsp_uart1.printf(...)`(宿主自己的宏,库不引用;`sys_task` 的耗时报告用 `system_set_report_hook()` 接) ## CAN @@ -41,12 +41,12 @@ bsp_can1.send(0x1ABCDE, d, 4U, FDCAN_EXTENDED_ID); // 扩展帧 4 字节 `CanRxNodeT` / `CanTxNodeT` 负责按 ID 分发与槽位聚合,一般由 `DjiMotor` 等设备内部使用; 接收节点默认只收 8 字节帧,注册时传 `CAN_DLC_MASK_ANY` 可以收短帧。 -没有节点认领的帧进回退缓冲(深度 `CAN_RX_RETURN_FRAMES`,0 = 不保留),可以通过 `bsp_can1.receive()` 自己取;`send()` 只能在任务里调用。 +没有节点认领的帧进回退缓冲(深度 `ICBSP_CAN_RX_RETURN_FRAMES`,0 = 不保留),可以通过 `bsp_can1.receive()` 自己取;`send()` 只能在任务里调用。 ## DJI 电机 ```cpp -DjiMotor chassis_lf(bsp_can1, 1U); +DjiMotor chassis_lf(bsp_can1, 1U); ICBSP_CHECK(chassis_lf.init() == Status::OK); ``` @@ -61,7 +61,7 @@ DeviceMotor motor({.pwm_a = &bsp_pwm1, .pwm_b = &bsp_pwm2, .encoder = &bsp_encod ICBSP_CHECK(motor.init() == Status::OK); uint8_t frame[16]; -const size_t n = motor.pid_frame( +const size_t n = motor.get_pid_frame( frame, DeviceMotor::PID_TARGET | DeviceMotor::PID_OUTPUT); @@ -82,7 +82,7 @@ DeviceMotor::PID_ALL // 默认 ## 姿态 PID ```cpp -#include "quaternion_pid.hpp" +#include "algorithm/quaternion_pid.hpp" QuaternionPID attitude(cfg); Vector3 omega_ref = attitude.calc(q_ref, q, gyro); @@ -104,4 +104,4 @@ sys_state.init_error(Status::IO_ERROR); // 初始化失败 ## Emm_V5 -`code/protocol/emmv5_protocol.hpp` 只做帧编解码;串口收发由设备层 `DeviceEmmv5GroupT` 或 App 负责。 +`code/device/motor/emmv5_protocol.hpp` 只做帧编解码;串口收发由设备层 `DeviceEmmv5GroupT` 或 App 负责。 diff --git "a/docs/\346\216\245\345\205\245\346\214\207\345\215\227.md" "b/docs/\346\216\245\345\205\245\346\214\207\345\215\227.md" index b11638b..9662b37 100644 --- "a/docs/\346\216\245\345\205\245\346\214\207\345\215\227.md" +++ "b/docs/\346\216\245\345\205\245\346\214\207\345\215\227.md" @@ -17,14 +17,15 @@ | -------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | 芯片 | STM32H7 / STM32F4 | 只包含 `stm32h7xx_hal_conf.h`,DMA 可达区按 AXI SRAM(0x24000000);**F4**:只包含 `stm32f4xx_hal_conf.h`,DMA 可达区按主 SRAM(0x20000000),CCM RAM(0x10000000,64 KB)不可 DMA | | 工具链 | CubeMX → Project Manager → Toolchain = **CMake** | 脚本改的是 CubeMX 的 CMake 工程结构(`cmake/stm32cubemx/` + `CMakePresets.json`) | -| RTOS | FreeRTOS,接口 **CMSIS-RTOS V2** | 任务、队列、事件组都走 `cmsis_os2.h`;V1 没有 `osEventFlags` 等 | +| 语言 | **C++20**:库和宿主应用目标都 `cxx_std_20` | 板级实例是 `inline` 全局变量、Config 用指定初始化器(必须按字段声明顺序写);C++20 下 `volatile` 变量不能用 `++` / `+=`(写成 `x = x + 1U`),见 [编码规范](编码规范.md) | +| RTOS | FreeRTOS,接口 **CMSIS-RTOS V2** | 库内部直接用 FreeRTOS 原生 API(任务、事件组、流 / 消息缓冲),不经 `cmsis_os2.h`;要求 V2 是因为库任务优先级按 `configMAX_PRIORITIES` 往下取、业务任务按 V2 的 56 级(`osPriorityNormal` = 24)排在它们下面,V1 只有 7 级 | | tick | `configTICK_RATE_HZ = 1000` | `sys_task` 10 ms、`can_rx_task` 1 ms 都按 tick 折算,非 1 kHz 周期就错 | | 栈溢出检查 | `configCHECK_FOR_STACK_OVERFLOW = 2` | 钩子 `vApplicationStackOverflowHook()` 要把现场写进 `fault_record` | | 分配失败钩子 | `configUSE_MALLOC_FAILED_HOOK = 1` | 同上,`vApplicationMallocFailedHook()` | | HAL 时基 | SYS → Timebase Source 选一个空闲 TIM,**不用 SysTick** | SysTick 归 FreeRTOS;HAL 超时全靠这个时基 | -| 时基中断优先级 | 没有要求,CubeMX 默认的 15 即可(1.4 起;Debug 与 -O2 实测) | 库在调度器启动前不再依赖 HAL tick(DWT 忙等,评审 A3),串口接收中断路径不调 `HAL_DMA_Abort()`(1.1 循环 DMA);原来要求高于 UART / CAN 的两条理由都没有了 | -| CAN | **H7**:FDCAN 经典 CAN,RX FIFO0,开 FDCAN 中断;**F4**:bxCAN,Normal 模式,RX FIFO0 中断,`AutoBusOff = DISABLE`、`AutoRetransmission = ENABLE` | H7 驱动按 FIFO0 取帧、靠中断做 Bus-Off 自动恢复;F4 用 3 个发送邮箱,过滤器组 0 归驱动独占,恢复由 `service_recovery()` 统一管(所以关掉硬件 ABOM) | -| UART | 中断模式开全局中断 或者 DMA 模式再配 RX/TX DMA 与 DMA 中断 | 驱动用 IDLE 中断切帧,再把数据投进 FreeRTOS 流缓冲区;F4 没有硬件 FIFO,`UART_ENABLE_FIFO` 必须为 0 | +| 时基中断优先级 | 没有要求,CubeMX 默认的 15 即可(1.4 起;Debug 与 -O2 实测) | 原来要求高于 UART / CAN 的两条理由都已消除,宿主自己的代码还有一条注意事项,见 [2.3](#23-hal-时基) | +| CAN | **H7**:FDCAN 经典 CAN,RX FIFO0,开 FDCAN 中断,`AutoRetransmission = ENABLE`;**F4**:bxCAN,Normal 模式,RX FIFO0 中断,`AutoBusOff = DISABLE`、`AutoRetransmission = ENABLE` | H7 驱动按 FIFO0 取帧、靠中断做 Bus-Off 自动恢复;F4 用 3 个发送邮箱,过滤器组 0 归驱动独占,恢复由 `service_recovery()` 统一管(所以关掉硬件 ABOM) | +| UART | 中断模式开全局中断 或者 DMA 模式再配 RX/TX DMA 与 DMA 中断 | 驱动用 IDLE 中断切帧,再把数据投进 FreeRTOS 流缓冲区;F4 没有硬件 FIFO,`ICBSP_UART_ENABLE_FIFO` 必须为 0 | | SPI | 全双工主机、软件 NSS;H7 还要 `MasterKeepIOState = ENABLE` | 片选由 GPIO 手动控制,NSS 引脚不能自动释放总线;F4 的 `SPI_InitTypeDef` 没有 `MasterKeepIOState`,一次片选内多段传输是否出假时钟沿需实测 | | 链接脚本 | **H7**:**可加载**的 `.dma_buffer` + `.noinit`;**F4**:只要 `.noinit` | `.dma_buffer` 放 `BspUartT` 实例和 DMA 缓冲,H7 必须在 DMA 可达的 AXI SRAM(F4 上该段不生成);`.noinit` 放 `fault_record`,复位后不清零 | | D-Cache | **H7**:保持关闭(不调 `SCB_EnableDCache`);**F4**:无 D-Cache | 库假定 D-Cache 关闭;要开就得用 MPU 把 DMA 缓冲区配成 non-cacheable | @@ -33,6 +34,34 @@ 库按 HAL 的 `HAL_FDCAN_MODULE_ENABLED`(H7)/ `HAL_CAN_MODULE_ENABLED`(F4)/ `HAL_UART_MODULE_ENABLED` / `HAL_SPI_MODULE_ENABLED` 等宏条件编译, **没开的外设不会生成对应驱动和任务**——用不到的外设不配是受支持的状态。 +### 1.1 库对宿主的依赖:两个文件 + +库源码只包含宿主的两个文件(`target_include_directories(icbsp PRIVATE user/board)` 让库看得到它们),其余都是宿主自己的事: + +| 文件 | 谁包含 | 职责 | +| --- | --- | --- | +| `hardware_config.h` | 只经 `service/system/config_check.hpp` | **完整配置**:功能开关、任务优先级 / 栈深、队列深度、超时。库里没有默认值,缺宏 `#error`、取值与开关依赖 `static_assert`,HAL 模块没开时强制关掉对应开关 | +| `board_instances.hpp` | `bsp/` 的 HAL 回调分发、`tasks/`、`state_tree` | **实例清单**:`ICBSP_CAN_INSTANCES` / `ICBSP_UART_INSTANCES` / `ICBSP_SPI_INSTANCES` 三个 X-macro,展开成按实例处理的代码。它要包含 `board_cfg.hpp`(实例的定义),所以清单里的名字必须是 `board_cfg.hpp` 里看得见的全局实例 | + +`board_cfg.hpp` / `board_cfg.cpp`(实例定义与 `board_init()`)和 `app/` 只被宿主自己用,库不包含。 + +### 1.2 宿主不能再定义的回调 + +库用强定义接管了下面这些 HAL 回调(`icbsp` 是 OBJECT 库,强定义直接进最终链接)。宿主**不能再定义同名函数**,否则重复定义: + +| 外设 | 库占用的回调 | 不在清单里的同类外设 | +| --- | --- | --- | +| UART | `HAL_UARTEx_RxEventCallback`、`HAL_UART_TxCpltCallback`、`HAL_UART_ErrorCallback` | 转到弱函数 `icbsp_unhandled_uart_rx_event()` / `_tx_cplt()` / `_error()` | +| SPI | `HAL_SPI_TxRxCpltCallback`、`HAL_SPI_ErrorCallback` | 转到 `icbsp_unhandled_spi_txrx_cplt()` / `_error()` | +| FDCAN(H7) | `HAL_FDCAN_RxFifo0Callback`、`HAL_FDCAN_TxFifoEmptyCallback`、`HAL_FDCAN_ErrorStatusCallback` | 转到 `icbsp_unhandled_fdcan_rx_fifo0()` / `_tx_fifo_empty()` / `_error_status()` | +| bxCAN(F4) | `HAL_CAN_RxFifo0MsgPendingCallback`、`HAL_CAN_TxMailbox0/1/2CompleteCallback`、`HAL_CAN_ErrorCallback` | 直接忽略(没有转调) | + +宿主自己用 HAL 管的外设(不在 `ICBSP_*_INSTANCES` 清单里)要收这些回调时,定义同名的 `icbsp_unhandled_*()` 强函数即可(N30,声明在对应的 `bsp_*.hpp`)。 +库没占用的回调照常由宿主定义,例如 `HAL_UART_RxCpltCallback`、`HAL_SPI_TxCpltCallback`、**`HAL_GPIO_EXTI_Callback`**: +用 BMI088 的数据就绪中断时,宿主在 `HAL_GPIO_EXTI_Callback` 里按引脚转调 `imu.on_acc_drdy_isr(&woken)` / `imu.on_gyro_drdy_isr(&woken)`。 + +另外库定义了弱符号 `__malloc_lock` / `__malloc_unlock`(见 [2.10](#210-newlib));FreeRTOS 的栈溢出 / 分配失败钩子、故障异常处理在 CubeMX 生成的文件里,由 `integrate.py` 在 USER CODE 段转调库的 `fault_on_*()`。 + --- ## 2. CubeMX 逐项设置 @@ -59,16 +88,37 @@ Middleware → FreeRTOS: SYS → Timebase Source 选一个空闲定时器(如 `TIM6`),不要用 SysTick。 CubeMX 会因此生成 `Core/Src/stm32h7xx_hal_timebase_tim.c`;`integrate.py` 找不到会给 `[注意]`。 +时基中断优先级用 CubeMX 默认的 15 即可。1.4 之前要求它高于 UART / CAN(数值 < 5),有两条理由,现在都不成立了: + +1. **`HAL_DMA_Abort()` 的竞争**:HAL V1.11.6 的 `HAL_DMA_Abort()` 有读-改-写竞争,靠 HAL tick 计超时;旧驱动在串口 IDLE 中断里调它, + 命中竞争时 HAL tick 若不能抢占串口中断就整机卡死(-O2 必现)。1.1 起 RX 改成循环 DMA,中断路径上不再调 `HAL_DMA_Abort()`。 +2. **调度器启动前的延时**:第一次 `xTaskCreate()` 之后、调度器启动之前,FreeRTOS 用 BASEPRI 挡住优先级 ≥ `configMAX_SYSCALL_INTERRUPT_PRIORITY`(5)的中断, + 时基是 15 时 HAL tick 不走,`HAL_Delay()` 永远等不完。库在这段时间(`board_init()` 里 BMI088 复位等)改用 DWT 忙等(评审 A3)。 + +宿主仍要注意第 2 条:**`app_init()` / `board_init()` 里不要调 `HAL_Delay()` 或带超时的阻塞 HAL**,要延时用 `bsp_dwt.delay_ms()`; +中断里也不要调带超时的阻塞 HAL(它们靠 HAL tick 计时)。 + ### 2.4 FDCAN - 模式选 **Classic**(不是 FDCAN FD) -- 开 RX FIFO0 -- NVIC 勾上 `FDCANx RX FIFO0`,以及 Bus-Off / Error 相关中断(库用它们做自动恢复) +- 开 RX FIFO0;TX 的 FIFO / Queue 模式都支持。总线可能被占满、又要保证高优先级 ID 先发时选 **Queue**(按 ID 优先级发;FIFO 按入队顺序发,前面的低优先级帧发不出去会挡住后面的,见 [bsp.md](code/bsp.md))。DM-MC02 实测工程用 FIFO,Queue 在 C06d 里测过 +- **`Auto Retransmission = Enable`**:CubeMX 默认 Disable,`.ioc` 里不写就是关的。关着时帧在仲裁中输给别的节点(或出错)就不再重发、直接丢弃, + 驱动的诊断计数里一条都看不出来。H750 回归宿主实测:两路对发、每 1 ms 突发 0~5 帧时,ID 大的一路丢了 45%,打开后 0 丢失。 + `integrate.py` 的规则 `can_auto_retx` 会查出来并能自动修改 +- NVIC 勾上 `FDCANx interrupt 0`(库的收帧、续发、错误状态通知都在中断线 0) +- **`MessageRAMOffset`**:几路 FDCAN 共用一块 Message RAM(2560 字),CubeMX 默认每路都是 0,会互相覆盖。每路占用的字数 = + 标准过滤器数 × 1 + 扩展过滤器数 × 2 + RX FIFO0 元素数 × 4 + TX 元素数 × 4(8 字节数据时每个元素 4 字); + 例如 1 个标准过滤器、RX FIFO0 16、TX 16 是 129 字,三路就依次填 0 / 129 / 258 +- **`StdFiltersNbr`**:建议填 1。库只在它 > 0 时写一条“全部接收”的标准帧过滤器;填 0 时不写(写了会落到 RX FIFO0 的位置,评审 F9), + 靠全局过滤器“不匹配的帧也收进 FIFO0”同样能收到 ### 2.5 UART - NVIC 勾 `USARTx global interrupt`(IDLE 断帧依赖它) -- DMA 模式:RX、TX 各配一条 DMA,并勾对应 `DMAx streamx global interrupt` +- DMA 模式:RX、TX 各配一条 DMA,并勾对应 `DMAx streamx global interrupt`。RX DMA 配 Normal 也行,`init()` 会改成 Circular + 直接模式; + 循环接收要求串口 / DMA 中断被挡住的时间短于收满半个 `RX_SIZE` 的时间,见 [bsp.md](code/bsp.md) +- **BDMA 外设**(H7 的 LPUART1、SPI6、I2C4、SAI4 等 D3 域外设)只能访问 SRAM4,而 `.dma_buffer` 在 AXI SRAM:这些外设的实例用 DMA 时 + `init()` 返回 `BAD_ARG`(评审 A4)。要用就改中断模式(`uart_mode::it`),SPI 用轮询(`use_dma = false`) - 波特率要和 `user/board/board_cfg.cpp` 里 `BspUartT` 的 `baudrate` 一致 (`integrate.py` 会对比 CubeMX 生成的值,不一致给 `[注意]`) @@ -78,10 +128,13 @@ CubeMX 会因此生成 `Core/Src/stm32h7xx_hal_timebase_tim.c`;`integrate.py` - 需要中断 / DMA 时对应勾选(BMI088 驱动用中断 + DMA) - 片选单独拉一个 GPIO 输出,在 `board_cfg` 里传进去 -### 2.7 时钟 +### 2.7 时钟与定时器 `board_cfg.hpp` 里 PWM 的 `timer_clk_hz` 必须等于 CubeMX 时钟树里该定时器的输入时钟。 -脚本只能对比 prescaler / period,时钟源算不出来,会提示自己核对。 +脚本只能对比 prescaler / period,时钟源算不出来,会提示自己核对。PWM 的 ARR 预装载由 `BspPwm::init()` 打开,CubeMX 里不用管。 + +**编码器**(`BspEncoder`):定时器配成 Encoder Mode,**Period 必须是计数器最大值**——16 位定时器 `0xFFFF`、32 位定时器(TIM2 / 5 / 23 / 24)`0xFFFFFFFF`。 +增量按计数器位宽回绕计算,Period 不是最大值时 `init()` 返回 `BAD_ARG`(N37)。 ### 2.8 链接脚本 @@ -90,6 +143,21 @@ CubeMX 生成的 `*.ld` 没有 `.dma_buffer` / `.noinit`,由 `integrate.py` 放哪个内存区按「起始地址 0x24000000 的 AXI SRAM」自动找(各型号 CubeMX 里可能叫 `RAM_D1` 或 `RAM`), 也可以用 `--ram-region` 指定。细节见 [4.3](#43-链接脚本)。 +### 2.9 BMI088(用到时) + +两个片选各一个 GPIO 输出;两个数据就绪引脚配成 EXTI(上升沿),NVIC 打开,宿主在 `HAL_GPIO_EXTI_Callback` 里转调(见 [1.2](#12-宿主不能再定义的回调))。 +**不要启动板载加热电阻的定时器**(例如 DM-MC02 的 PB1 / TIM3_CH4):库不管加热,没有温控时容易损坏硬件。 + +### 2.10 newlib + +`BspUartT::printf()` 打印浮点(`%f`)会走 newlib 的 `malloc`;两个任务同时对不同串口打浮点时会并发进 `malloc`。 +库提供弱符号 `__malloc_lock` / `__malloc_unlock`(挂起调度器,评审 A9);宿主已有自己的锁(例如 CubeMX FreeRTOS 的 newlib 锁策略生成的 +`newlib_lock_glue.c`)时以宿主的为准。另外: + +- `configUSE_NEWLIB_REENTRANT = 1`(CubeMX 默认) +- 浮点打印要链接 `-u _printf_float`(nano.specs,见 [4.1](#41-cmake-根目录cmakelist文末添加)) +- 库用到两个堆:FreeRTOS 堆(`configTOTAL_HEAP_SIZE`,`xPortGetFreeHeapSize()` 统计的就是它)和 newlib 堆(链接脚本 `.bss` 之后到栈之间),后者 `xPortGetFreeHeapSize()` 统计不到 + --- ## 3. 自动接入 @@ -97,8 +165,8 @@ CubeMX 生成的 `*.ld` 没有 `.dma_buffer` / `.noinit`,由 `integrate.py` 在宿主工程根目录: ```bash -python3 third_party/stm32-framework/tools/integrate.py --dry-run # 只看将改什么 -python3 third_party/stm32-framework/tools/integrate.py # 执行 +python3 third_party/icbsp/tools/integrate.py --dry-run # 只看将改什么 +python3 third_party/icbsp/tools/integrate.py # 执行 ``` 脚本做的事(每一步都先判断是否已完成,可重复运行): @@ -115,6 +183,10 @@ python3 third_party/stm32-framework/tools/integrate.py # 执行 10. 复制 `Flash/` 烧录脚本 11. 宿主根目录生成 `.clang-format`(沿用库的那一份)与 `.clangd`(编译数据库 + 本机 `--query-driver`): 已存在不覆盖;`.clangd` 里有手写配置但没有 `CompileFlags` 时,只把这一段补在最前面 +12. 外置 QSPI Flash(启用时):根 `CMakeLists.txt` 的 `icbsp-options` 生成区、`CMakePresets.json` 的 `*-Internal / *-QspiRam / *-QspiXip`、 + `icbsp_flash_config.h`、`Flash/daplink_qspi.cfg`、`quadspi.c` 的方案 B 提前返回、`launch.json` 的两个调试配置,见 [3.2](#32-外置-flash编译优化与-gitignore) +13. 编译优化(启用时):同一个生成区里的 `icbsp_optimization(...)` +14. 示例 `.gitignore`:没有就复制 `templates/gitignore`,有就只追加缺的行 常用参数: @@ -129,6 +201,10 @@ python3 third_party/stm32-framework/tools/integrate.py # 执行 | `--no-hardware-config` | 不复制 `hardware_config.h` | | `--no-vscode` / `--no-flash` | 不动 `.vscode/*` / 不复制 `Flash/*` | | `--no-clang` | 不生成 `.clang-format` / `.clangd` | +| `--external-flash QSPI_RAM\|QSPI_XIP\|INTERNAL\|off` | 启用外置 QSPI Flash 并设默认存放方式(`off` 关闭),见 [3.2](#32-外置-flash编译优化与-gitignore) | +| `--flash-chip <名字>` / `--qspi-prescaler ` | 外置 Flash 芯片(`W25Q64` / `W25Q128` / `W25Q256`)、QUADSPI 预分频(默认 2 → 80 MHz) | +| `--opt 类型=等级` / `--vendor-os` / `--no-opt` | 编译优化:如 `--opt Debug=-Og`;CubeMX 源码固定 `-Os`;关闭 | +| `--no-gitignore` | 这次不复制 / 合并示例 `.gitignore` | 行为约定: @@ -137,6 +213,55 @@ python3 third_party/stm32-framework/tools/integrate.py # 执行 - 宿主已有的 `.vscode` 配置、`Flash/` 脚本、`.clang-format` / `.clangd` 不覆盖,只补缺失项(JSONC 注释也保留) - 工程名取 `CMAKE_PROJECT_NAME`;`device` / OpenOCD target 按 `.ioc` 的 `Mcu.Name` 推出来 + +### 3.1 按 .ioc 生成实例与设备(`--apply`、Web UI) + +除了复制模板,`integrate.py` 还能按 CubeMX 的 `.ioc` 生成板级代码:每个选中的外设一个库实例(FDCAN1 → `bsp_can1`,参数取自 `.ioc`, +H7 的 DMA 实例自动套 `ICBSP_DMA_BUFFER`)、`board_instances.hpp` 的清单、`init()`、`hardware_config.h` 的功能开关,以及可选设备 +(DJI / 达妙电机、BMI088、R9DS、Emm_V5、舵机、蜂鸣器、直流电机)的实例、`init()` 和 EXTI 转调。数据全部来自 `tools/manifest.json`。 + +**图形界面**(零依赖,不用 `npm install`): + +```bash +node third_party/icbsp/tools/web_ui/server.mjs # 然后浏览器打开 http://127.0.0.1:8765/ +# --host <宿主根目录> --port <端口> --python +``` + +页面逐条显示 `.ioc` 校验(能自动修改的可以勾选后修改 `.ioc`,并可选用 CubeMX 命令行重新生成),列出外设与参数、功能开关、可挂设备, +改选择后自动重新预览 diff,确认后写入。页面只负责展示和收集选择,逻辑都在 `integrate.py`;找不到 Python 3.8+ 时页面会提示。 + +**命令行**: + +| 参数 | 作用 | +| --- | --- | +| `--apply <选择.json>` | 按选择生成(格式见 `tools/icbsp_tool/selection.py` 文件头;只写部分键时按默认补齐) | +| `--json` | 只输出一个 JSON:检查结果、外设候选、可挂设备、完整选择、生成区状态、diff(Web UI 用) | +| `--plan` | 同 `--dry-run`:只给 diff,不写 | +| `--fix-ioc all\|规则id,…` | 把能自动修改的 `.ioc` 失败项写进 `.ioc`(先备份成 `.ioc.bak-时间`) | +| `--regenerate` / `--cubemx <目录>` | 用 STM32CubeMX 命令行无界面重新生成(桌面上别开着 CubeMX,会抢锁) | +| `--overwrite-edited` | 生成区被手改过也覆盖(默认停下) | + +**生成区**:生成的代码只写在 `// ` … `// ` 之间,区外的内容不动;结束标记里的哈希用来发现手改, +手改过的区默认拒绝覆盖。完整的选择存进板级目录的 `icbsp_selection.json`(随工程提交),下次扫描 / 打开页面从它开始。 +手写的板级文件没有生成区,`--apply` 会停下并提示把模板里的标记加进去。 + +### 3.2 外置 Flash、编译优化与 `.gitignore` + +这三项是工程级选项,存在 `icbsp_selection.json` 的 `external_flash` / `optimization` / `gitignore` 三个键里;命令行参数改了它们也会存回去, +下次运行、Web UI 都沿用。Web UI 里对应“外置 Flash”“编译优化”“工程文件”三节。 + +- **外置 Flash**:`.ioc` 启用了 QUADSPI,且片内 Flash ≤ 128 KB(H750 / H7B0 / H730)或最近一次构建占片内 Flash ≥ 85%(读 `build/` 下的 + ELF 或 `.map`,链接溢出时也算)时,脚本给出 `[注意]`、Web UI 顶部出现建议横幅,一键选方案 A / B。原理、两种方案的取舍、烧录与调试、 + bootloader 状态码、实测数据见 **[外置Flash.md](外置Flash.md)**。OCTOSPI(H723 / H730 / H7B0)暂不支持,脚本会说明。 +- **编译优化**:每个构建类型一个等级(`Debug` / `RelWithDebInfo` / `Release`),生成 `icbsp_optimization(...)`:用 `target_compile_options` + 追加在工具链文件的 `-O0 -g3` 等之后(GCC 以最后一个 `-O` 为准),不改 CubeMX 生成的工具链文件。`VENDOR_OS`(Web UI:“CubeMX 生成的源码 + 固定 -Os”)让 HAL / FreeRTOS / USB 在所有构建类型下都是 `-Os`,Debug 时自己的代码仍是 `-O0`,H750 上能省二三十 KB。 +- **`.gitignore`**:`templates/gitignore`(`build/`、`.cache/`、`compile_commands.json`、`*.su`、`__pycache__/`、`.vscode/.cortex-debug*`、 + `Flash/*.log`、`*.ioc.bak-*`)。宿主已有 `.gitignore` 时只把缺的行追加在 `# >>> icbsp` … `# <<< icbsp` 之间,原有内容不动。 + +这两项 CMake 内容写在根 `CMakeLists.txt` 的 `# ` 生成区(`#` 注释的生成区标记,规则同上), +放在 `add_subdirectory()` 之前:外置 Flash 要先换掉 `-T` 链接脚本,库的链接脚本检查才会检查新脚本。 + --- ## 4. 手动接入 @@ -146,9 +271,9 @@ python3 third_party/stm32-framework/tools/integrate.py # 执行 ### 4.1 CMake (根目录CMakeList文末添加) ```cmake -add_subdirectory(third_party/stm32-framework) -target_include_directories(stm32_framework PRIVATE user/board) -target_link_libraries(${CMAKE_PROJECT_NAME} stm32_framework) +add_subdirectory(third_party/icbsp) +target_include_directories(icbsp PRIVATE user/board) +target_link_libraries(${CMAKE_PROJECT_NAME} icbsp) target_compile_features(${CMAKE_PROJECT_NAME} PRIVATE cxx_std_20) target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE user/board user/app user/module) target_link_options(${CMAKE_PROJECT_NAME} PRIVATE -u _printf_float) @@ -163,8 +288,8 @@ target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE user) 要点: - `add_subdirectory` 必须在 `add_subdirectory(cmake/stm32cubemx)` **之后**(要拿到 HAL / FreeRTOS 目标) -- `stm32_framework` 是 **OBJECT 库**:HAL / FreeRTOS 的弱符号回调必须直接进入最终链接,不能做成静态库 -- `target_include_directories(stm32_framework PRIVATE user/board)`:库自身也要看到 `hardware_config.h` +- `icbsp` 是 **OBJECT 库**:HAL / FreeRTOS 的弱符号回调必须直接进入最终链接,不能做成静态库 +- `target_include_directories(icbsp PRIVATE user/board)`:库自身也要看到 `hardware_config.h` - `-u _printf_float`:`BspUartT::printf` 在 `nano.specs` 下打印浮点必须加,否则输出空 / 乱码 - 宿主应用目标也要 `cxx_std_20`,库的 `inline` 变量与指定初始化器依赖它 @@ -174,10 +299,22 @@ target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE user) | 文件 | 作用 | | ----------------------- | --------------------------------------------------------------------------------- | -| `hardware_config.h` | 唯一配置源:任务开关、优先级、栈深、队列深度、超时 | +| `hardware_config.h` | 唯一配置源:任务开关、优先级、栈深、队列深度、超时。只写 `#define`;缺宏、取值范围、开关依赖由库的 `config_check.hpp` 在编译期检查,报错会写明缺哪个宏 | | `board_cfg.hpp` | `inline` 外设实例、句柄、参数 | | `board_cfg.cpp` | 只放 `board_init()` | -| `board_instances.hpp` | `BSP_CAN_INSTANCES` / `BSP_UART_INSTANCES` / `BSP_SPI_INSTANCES` 实例名清单 | +| `board_instances.hpp` | `ICBSP_CAN_INSTANCES` / `ICBSP_UART_INSTANCES` / `ICBSP_SPI_INSTANCES` 实例名清单 | + +`hardware_config.h` 里的功能开关(取 0 / 1)。CubeMX 没开对应外设时库会强制置 0;关掉的模块不编译、对应任务不创建: + +| 开关 | 管什么 | 关掉(0)之后 | +| --- | --- | --- | +| `ICBSP_SYS_TASK_ENABLE` | `sys_task`(10 ms) | 没有 CAN Bus-Off 自动恢复与发送兜底、串口巡检、`Online` 掉线计时(`is_online()` 不再变化)、默认状态树总线层的运行期记错(设备掉线照常记)、`sys_task_stats` 与报告回调;DWT 时间轴的回绕跟踪要宿主每隔不到 7.8 s 调一次 `bsp_dwt.get_cycles()`。必须同时关 `ICBSP_UART_PATROL_ENABLE` | +| `ICBSP_CAN_RX_ENABLE` | `can_rx_task`(1 ms)+ `CanRxNodeT` | 不按 ID 分发;DjiMotor / DmMotor 不能用(包含头文件 `#error`);`BspCanT::receive()` 直接读原始接收缓冲(只允许一个任务读,C12 实测) | +| `ICBSP_CAN_TX_ENABLE` | `can_tx_task` + `CanTxNodeT` | 没有共帧发送、心跳、指令过期清零;DjiMotor 不能用(`#error`),DmMotor 不受影响;只剩 `send()` / `send_latest()` 直接发 | +| `ICBSP_UART_PATROL_ENABLE` | `sys_task` 里的串口巡检 | 串口发送卡死、接收停摆(DMA 出错、HAL 状态卡住)后不再自动恢复 | +| `ICBSP_UART_ENABLE_FIFO` | `init()` 打开 UART 硬件 FIFO | 默认就是 0:保持 CubeMX 的设置,没有损失;开了以后发送卡死恢复时会丢掉 TX FIFO 里最多 16 字节。F4 必须为 0 | + +各组合(含逐个关 HAL 模块)都由宿主的编译矩阵脚本验证过 0 error、0 warning(阶段 3)。 `board_cfg.hpp` 示例: @@ -208,13 +345,13 @@ inline BspPwm bsp_pwm_buzzer( `board_instances.hpp` 必须同步: ```cpp -#define BSP_CAN_INSTANCES(X) X(bsp_can1) -#define BSP_UART_INSTANCES(X) X(bsp_uart1) -#define BSP_SPI_INSTANCES(X) /* 无 SPI 实例 */ +#define ICBSP_CAN_INSTANCES(X) X(bsp_can1) +#define ICBSP_UART_INSTANCES(X) X(bsp_uart1) +#define ICBSP_SPI_INSTANCES(X) /* 无 SPI 实例 */ ``` -HAL 回调、`sys_task` 巡检、`can_rx` / `can_tx` 都按这份清单展开;新增实例只改这里和 `board_cfg.*`。 -**漏写实例不会报错,但对应中断不会分发。** +HAL 回调、`sys_task` 巡检、`can_rx` / `can_tx`、默认状态树都按这份清单展开;新增实例只改这里和 `board_cfg.*`。 +漏写实例、或清单里两个实例绑同一句柄时,该实例的 `init()` 返回 `BAD_ARG`,`board_init()` 的 `ICBSP_CHECK` 会停在那一行。 `board_cfg.cpp` 里每个外设都要断言: @@ -300,9 +437,19 @@ sys_state.wait_running(); | 报 `.dma_buffer` 缺段 / 是 `NOLOAD` / 缺 `AT>` | 链接脚本没按 [4.3](#43-链接脚本) 改 | | 串口参数上电变随机值 | 同上,`.dma_buffer` 必须是可加载段(`>RAM_D1 AT> FLASH`) | | `can_rx_task` 收不到帧 | FDCAN 中断没开,或过滤器没放行 | +| CAN 负载一高就丢帧(多是 ID 大的那一路),驱动的 `diagnostics` 全为 0 | FDCAN 的自动重发没开(CubeMX 默认 Disable),仲裁输掉的帧直接丢弃;见 [2.4](#24-fdcan)。`integrate.py --fix-ioc can_auto_retx --regenerate` | | 卡在 `wait_running()` | 某个 `init()` 返回非 `Status::OK`,看 `fault_record` 的行号 | | 浮点打印空 / 乱码 | 少了 `target_link_options(... -u _printf_float)` | -| 串口 `init()` 返回 `BAD_ARG` | 实例没写进 `BSP_UART_INSTANCES`、两个实例绑了同一句柄、DMA 模式没配 DMA,或实例不在 `.dma_buffer` | +| 串口 `init()` 返回 `BAD_ARG` | 实例没写进 `ICBSP_UART_INSTANCES`、两个实例绑了同一句柄、DMA 模式没配 DMA,或实例不在 `.dma_buffer` | | `integrate.py` 报「不是宿主工程根目录」 | 用 `--host` 指到有根 `CMakeLists.txt` 的目录 | | clangd 没有补全 / 跳转 | 先 `cmake --preset Debug` 生成 `compile_commands.json`,再 Restart language server | | Debug 一启动就报找不到 `runToEntryPoint` | 填的符号不存在(旧工程里可能是 `all_init`),改成 `main` | +| 烧录 / 复位后调试口卡死,要重新上电 | OpenOCD 配置里注册了外置 Flash bank(如 OCTOSPI2);删掉,见 `templates/Flash/README.md` 的实测经验 | +| 烧录脚本连不上 / 下载失败 | OpenOCD 用 0.12 及以上(`OPENOCD=<路径>` 指定);部分 CMSIS-DAP 探针要在 `daplink.cfg` 里打开 `cmsis-dap backend hid` | +| 刚烧完 `fault_record` 里有一条 HardFault(BFAR = 0x04C11DB7、tick 0) | OpenOCD 校验时在目标上跑 CRC 程序,被旧固件记下的,可以忽略 | +| H750 等小 Flash 型号链接报 `region FLASH overflowed` | 打开外置 Flash([3.2](#32-外置-flash编译优化与-gitignore)、[外置Flash.md](外置Flash.md)),或先用编译优化 `--opt Debug=-Og` / `--vendor-os` 顶着 | +| 外置 Flash:板子不跑,`0x3800FFE8` 的启动状态不是 0x10 / 0x11 | 按 [外置Flash.md](外置Flash.md) 的状态码表查:5 = QSPI 里没有镜像(先跑 `OpenOCD_flash`)、7 = CRC 不对、3 = JEDEC ID 不符 | +| `.dma_buffer` 里的实例初值错位(句柄为空、`init()` 返回 `BAD_ARG`),`.dma_buffer` 不在 RAM 区开头 | 链接脚本里 `__dma_buffer_load` 要写成 `LOADADDR(.dma_buffer) + (__dma_buffer_start - ADDR(.dma_buffer))`(段内 `ALIGN(32)` 会让起点后移;2026-11-10 起模板已改) | +| 卡在 `bmi088.init()`(SPI 传输不返回;SPIx_SR 里 TXTF 置位、一直没有 RXP) | H7 的 CubeMX 在 `.ioc` 不写 DataSize 时默认 **4 位帧**;改成 8 Bits。BMI088 的 SCK 还不能超过 10 MHz。`integrate.py` 的规则 `spi_8bit` / `spi_bmi088_speed` 会查出来并能自动修改(`--fix-ioc spi_8bit,spi_bmi088_speed --regenerate`) | +| 加了 BMI088 后 `fault_record` kind = 3(分配失败),堆最低余量只剩几百字节 | BMI088 的工作任务(`ICBSP_BMI088_TASK_STACK`)和 VQF 都从 FreeRTOS 堆分配:`configTOTAL_HEAP_SIZE` 调大(回归宿主用 64 KB) | +| Debug(-O0)下 `defaultTask` 栈溢出(`fault_record` kind = 2,tick 很小) | CubeMX 把 `MX_USB_DEVICE_Init()` 放在 `defaultTask` 里,-O0 下 128 字栈不够:FreeRTOS → Tasks → defaultTask 栈改成 512 字 | diff --git "a/docs/\347\274\226\347\240\201\350\247\204\350\214\203.md" "b/docs/\347\274\226\347\240\201\350\247\204\350\214\203.md" index 5404278..b948d0a 100644 --- "a/docs/\347\274\226\347\240\201\350\247\204\350\214\203.md" +++ "b/docs/\347\274\226\347\240\201\350\247\204\350\214\203.md" @@ -1,4 +1,4 @@ -# stm32-framework 编码风格规范 +# ICBSP 编码风格规范 > 本文档以 `code/bsp/bsp_uart.{hpp,cpp}` 为基准样板整理而成,是工程库统一遵循的标准。 > 格式类规则已固化在 `.clang-format` 中(保存时自动格式化),命名、注释、架构类规则需人工遵守。 @@ -9,13 +9,14 @@ | 规则 | 说明 | |---|---| -| 文件名 | 全小写 + 下划线:`bsp_uart.hpp`、`protocol_uart.cpp` | +| 文件名 | 全小写 + 下划线:`bsp_uart.hpp`、`dji_motor.hpp`、`pid.hpp` | | C++ 头后缀 | `.hpp` | | C++ 源后缀 | `.cpp` | -| C 调用 C++ 的转接头 | 用 `api_xxx.h`(纯 C 头,内含 `extern "C"`) | -| 正常 C++ 头 | `xxx_yyyy.hpp`(`xxx` 为 `bsp`/`alg`/`app` 等层级前缀) | +| C 调用 C++ 的转接头 | 纯 C 头,内含 `extern "C"`:宿主的 `app_main.h`(`app_init()`),库的 `service/system/system.hpp` | +| 正常 C++ 头 | 层由所在目录决定,文件名不强制带层前缀:BSP 沿用 `bsp_xxx`,设备用 `device_xxx` 或设备名(`dji_motor`),算法直接用名字(`pid`) | | 头文件保护 | `#ifndef __XXX_HPP__` + `#define` + 末尾 `#endif // __XXX_HPP__` | -| 库的 HAL 依赖 | 库内只包含 `stm32h7xx_hal.h`,不包含 CubeMX 按外设生成的 `main.h` / `fdcan.h` / `usart.h` / `tim.h`;依赖某个外设的模块整体包在 `#ifdef HAL_xxx_MODULE_ENABLED` 里(头文件在保护宏内、源文件整文件) | +| 包含路径 | 库只把 `code/` 加进包含路径,库头文件一律写全子目录(`#include "service/system/status.hpp"`),宿主文件(`hardware_config.h`、`board_instances.hpp`)写文件名;下层文件里不出现上层目录(层次:`algorithm`、`bsp` → `service` → `device` → `tasks`;例外是纯状态码 `service/system/status_code.hpp` 与配置入口 `service/system/config_check.hpp`,各层都能包含)。`python3 tools/check_layers.py` 检查 | +| 库的 HAL 依赖 | 库内只包含 `bsp/bsp_series.hpp`(由它按系列包含 `stm32h7xx_hal.h` / `stm32f4xx_hal.h`),不包含 CubeMX 按外设生成的 `main.h` / `fdcan.h` / `usart.h` / `tim.h`;依赖某个外设的模块整体包在 `#ifdef HAL_xxx_MODULE_ENABLED` 里(头文件在保护宏内、源文件整文件) | | 文件说明块 | 只写在头文件最顶部;源文件最顶部不放任何说明,直接以 `#include` 开头 | 间接使用的头文件在行尾加 `// IWYU pragma: keep`,规避 clangd 误报。 @@ -24,28 +25,43 @@ | 元素 | 规则 | 示例 | |---|---|---| -| 类名 | 大驼峰 | `BspUart`、`DmImu`、`JC2804` | -| 结构体 | 大驼峰,不加 `_t` 后缀 | `PidConfig`、`PidInput`、`ImuData` | +| 类名 | 大驼峰(模板类可加 `T` 后缀) | `BspUartT`、`DjiMotor`、`DeviceBmi088`、`EventState` | +| 结构体 | 大驼峰,不加 `_t` 后缀 | `ImuData`、`CanRxMsg`、`PID::Config` | | 方法 / 自由函数 | 小写蛇形| `init()`、`start_reception()`、`bsp_init()`、`calc()` | | 私有成员变量 | `_` 前缀 + 小写蛇形 | `_huart`、`_rx_stream_buffer`、`_diff_mode` | -| 枚举类型 | `enum class` + 大驼峰 | `ReceiveMode`、`DiffMode` | -| 枚举值 | 全大写蛇形 | `SINGLE_BUFFER`、`DIFF_TARGET` | -| 宏 / 常量 | 全大写蛇形 | `MAX_INSTANCES`、`DATA_PACK_MAX_LENGTH` | -| 模板参数 | 全大写蛇形 | `BUFFER_SIZE`、`MSG_SIZE` | +| 枚举类型 | `enum class` + 大驼峰 | `UartDir`、`DjiMotorType`、`DiffMode` | +| 枚举值 | 全大写蛇形(型号名照写) | `NOT_INIT`、`DIFF_TARGET`、`M3508`、`J4340P` | +| 宏 / 常量 | 全大写蛇形;宏带 `ICBSP_` 前缀 | `ICBSP_CAN_CMD_EXPIRE_MS`、`TX_CAPACITY` | +| 模板参数 | 全大写蛇形 | `RX_SIZE`、`TX_DEPTH` | | 全局实例 | 全小写蛇形 | `bsp_can1`、`bsp_uart1`、`imu_bmi088` | -| 类型别名 | 大驼峰(C 兼容 typedef) | `CanRxMsg`、`ProtocolFrame` | +| 类型别名 | 大驼峰(C 兼容 typedef) | `SysTaskStats`、`BoardUart` | 例外: - 1. 构造函数 / 析构函数必须与类名(大驼峰)一致,如 `BspUart::BspUart()` + 1. 构造函数 / 析构函数必须与类名(大驼峰)一致,如 `DeviceBmi088::DeviceBmi088()` 2. 外部库(HAL / FreeRTOS 等 C 库)强制要求固定名称的回调,如 `HAL_FDCAN_RxFifo0Callback`、`vApplicationStackOverflowHook`、`__io_putchar`、`_write` 3. CubeMX 生成的默认任务名(如 `StartDefaultTask`)保留原名,以便 CubeMX 重新生成时同名兼容 -### 2.1 库命名不与开发组织耦合 +### 2.1 查询、布尔与动作接口(Q10,阶段 2.7 起) -本库要作为 submodule 接入任意工程,名字里不能带开发组织 / 团队名(例如 `cubot`): +| 接口种类 | 规则 | 示例 | +|---|---|---| +| 查询(返回内部状态 / 数据,不改对象) | `get_` 前缀 | `get_data()`、`get_diag()`、`get_port()`、`get_position()`、`get_error_code()` | +| 布尔查询 | `is_` / `has_` 前缀,返回 `bool` | `is_online()`、`is_running()`、`is_initialized()`、`is_pressed()`、`is_failsafe()` | +| 动作 | 动词开头 | `init()`、`send()`、`update()`、`reset()`、`set_duty()`、`fill_data()`、`unpack()` | +| 读硬件 | `read_` 前缀(会访问外设寄存器,可能有副作用) | `read_delta()`、`read_raw()`、`read_reg()` | +| 取走(读完就清 / 消费掉的数据) | `take_` 前缀 | Emm_V5 的位置 / 状态回复(N33) | + +- 是否初始化成功统一叫 `is_initialized()`(不再有 `initialized()` / `is_init()`)。 +- 布尔查询必须返回 `bool`:`Online::is_online()` 原来返回 `Status`(`OK` = 0 = 在线),`if (x.is_online())` 恰好在离线时成立,2.7 起改成 `bool`。 +- 例外:`snapshot(...)`(在临界区里取一份一致的副本,名字表达“同一时刻”,保留);数学值类型(`Quaternion`、`MatrixF32`、`Vector3`)沿用数学名(`norm()`、`trace()`、`conj()`);`PID::get()`。 +- 全局常量带 `ICBSP_` 前缀(`ICBSP_PI` / `ICBSP_PI_F`,`algorithm/math_constants.hpp`),不定义 `PI` 这类通用宏;枚举一律 `enum class`(`DjiMotorType::M3508`)。 + +### 2.2 库命名不与开发组织耦合 + +本库要作为 submodule 接入任意工程,名字里不能带单个开发组织 / 团队名(例如 `cubot`);库名 **ICBSP**(INVC & CUBOT Board Support Package,两个组织共同署名)本身作为前缀使用: 1. **按功能命名**:文件、类型、函数、宏、CMake 目标、FreeRTOS 任务名、CMake 打印与报错文字,一律描述“它是做什么的”,不写“谁写的”。 -2. **功能名不够用时加 `STM32FRAMEWORK` 前缀**:按功能起的名字太通用、可能与宿主工程冲突时,宏用 `STM32FRAMEWORK_XXX`、函数用 `stm32_framework_xxx()`;CMake 目标为 `stm32_framework`,仓库名为 `stm32-framework`。 +2. **功能名不够用时加 `ICBSP` 前缀**:按功能起的名字太通用、可能与宿主工程冲突时,宏用 `ICBSP_XXX`、函数用 `icbsp_xxx()`;宿主提供给库的配置宏、功能开关、实例清单一律带 `ICBSP_`;CMake 目标为 `icbsp`,仓库名为 `ICBSP`。 3. **新全局名字先查重**:在宿主工程的 `Drivers/`(含全部 STM32H7 设备头文件与 HAL Legacy 头)、`Middlewares/`(FreeRTOS)、`Core/` 里 `grep -rw <名字>`,不能与 HAL / CMSIS / FreeRTOS / CubeMX 生成代码同名。 4. 只出现在 git 历史、提交说明里的旧名字不追改。 @@ -53,12 +69,12 @@ | 用途 | 名字 | | --- | --- | -| 用户配置文件(宿主 `user/board/`) | `hardware_config.h`,保护宏 `HARDWARE_CONFIG_H`;所有可调宏与范围检查都在这里 | -| 取配置 | 库与用户代码统一 `#include "hardware_config.h"`,不再有默认值头文件 | -| 配置宏 | 按功能分组:`SYS_TASK_*`、`CAN_TASK_*`、`CAN_*`、`UART_*`(如 `CAN_CMD_EXPIRE_MS`、`UART_ENABLE_FIFO`) | -| 库入口 | `code/service/system.hpp`:`system_init()`、`system_start()` | +| 用户配置文件(宿主 `user/board/`) | `hardware_config.h`,保护宏 `HARDWARE_CONFIG_H`;所有可调宏都在这里(缺宏、范围、依赖检查在库的 `service/system/config_check.hpp`) | +| 取配置 | 库内一律 `#include "service/system/config_check.hpp"`(它包含 `hardware_config.h` 并做检查;和 `status_code.hpp` 一样各层都能包含),不直接包含 `hardware_config.h`;宿主代码可以直接包含 `hardware_config.h`。没有默认值头文件。新增可调宏时在 `config_check.hpp` 里同时加缺宏 `#error` 和范围 `static_assert`,并同步模板 | +| 配置宏 | `ICBSP_` 前缀 + 按功能分组:`ICBSP_SYS_TASK_*`、`ICBSP_CAN_TASK_*`、`ICBSP_CAN_*`、`ICBSP_UART_*`(如 `ICBSP_CAN_CMD_EXPIRE_MS`、`ICBSP_UART_ENABLE_FIFO`);实例清单 `ICBSP_CAN/UART/SPI_INSTANCES` | +| 库入口 | `code/service/system/system.hpp`:`system_init()`、`system_start()` | | 库任务 | `sys_task`、`can_rx_task`、`can_tx_task`(FreeRTOS 任务名 `sys`、`can_rx`、`can_tx`) | -| CMake 目标 | `stm32_framework`(OBJECT 库) | +| CMake 目标 | `icbsp`(OBJECT 库) | ## 3. 注释规范(Doxygen) @@ -91,39 +107,52 @@ ## 4. 类设计模式 -1. **全局实例模式**:在 `xxx_cfg.cpp` 中实例化,`xxx_cfg.hpp` 中 `extern` 声明 -2. **登记表模式**:外设实例在 `init()` 时(打开中断之前)登记到类的静态表(`BspCan`、`BspUartBase`),HAL 回调按句柄查表分发,库的后台任务遍历登记表;库里不引用任何板级实例,也不 if-else 判断句柄 -3. **模板实例化**:模板类优先只有头文件(如 `BspUartT`,任意模板参数都能用);确实要把定义放进 `.cpp` 的,在该 `.cpp` 里显式实例化用到的组合 -4. **HAL 中断回调**:统一放在对应 BSP 的 `.cpp` 中,用 `extern "C"` 包裹,通过句柄分发 -5. **配置结构体统一模式(Config)**:所有类的初始化/构造参数一律收进类内的 `Config` 结构体(命名固定为 `Config`),构造函数 / `init()` 只接收 `const Config &`;禁止裸参数构造函数 -6. **匿名结构体传参**:调用处传入 `Config` 时用匿名临时结构体,只按顺序传数据、不创建具名变量;`Config` 必须提供"参数顺序 = 字段顺序"的构造函数(带默认参数),以支持 C++20 下的 `Config{...}` 花括号列表初始化: +1. **板级实例在宿主里**:库里不定义任何板级实例(`bsp_dwt`、`sys_state` 这类库自己的单例除外)。 + 外设类(`BspCanT`、`BspUartT`、`BspSpi`、`BspPwm`、`BspGpio`、`BspKey`、`BspEncoder`)的构造是 constexpr,在宿主 `board_cfg.hpp` 里写成 `inline` 全局变量; + 设备类(`DjiMotor`、`DmMotor`、`DeviceBmi088`、`DeviceMotor` …)和 `BspSpiDevice` 的构造不是 constexpr,推荐定义在 `board_cfg.cpp`、头文件里 `extern`。 + 设备写成 `inline` 也能用(C++17 起保证只初始化一次),代价是变成动态初始化:每个包含它的 TU 都有一份初始化代码,并注册析构。 +2. **实例清单(X-macro),没有登记表**:同类外设实例由宿主 `board_instances.hpp` 的 `ICBSP_CAN/UART/SPI_INSTANCES(X)` 列出,库的 HAL 回调分发、后台任务、 + 默认状态树都按清单在编译期展开(`if (h == name.get_handle()) …`)。`init()` 先核对“自己在清单里、且清单里只有自己绑这个句柄”,否则返回 `BAD_ARG`。 + 新增一类需要回调分发的外设时照此办理,不要再引入运行时登记表。 +3. **模板只有头文件**:模板类(`BspUartT`、`BspCanT`、`DjiMotor`、`DmMotor`、`Rls` …)把实现写在头文件里,任意模板参数都能用; + 回归宿主(DM-MC02 工程)的 `app/compile_probe.cpp` 显式实例化所有头文件模板,让没接这个设备的工程里接口改动也能被编译器检查到;新增头文件模板时在那里加一行。 +4. **HAL 中断回调**:放在对应 BSP 的 `.cpp` 里,`extern "C"` 包裹,按清单分发;清单外的同类外设转到弱函数 `icbsp_unhandled_*()`(N30)。 +5. **配置结构体 `Config`**:类的构造参数一律收进类内的 `Config` 结构体,构造函数只接收 `const Config &`,不写裸参数构造函数。 + `Config` 写成**聚合体**:字段带默认成员初始化,不写构造函数;调用处用 C++20 指定初始化器,只写要改的字段: ```cpp - BspGpio power_5v({POWER_5V_GPIO_Port, POWER_5V_Pin}); // 构造函数传入 - key_user.init({KEY_GPIO_Port, KEY_Pin, true, 1U, 5U}); // init 传入 - BspUart<128> bsp_uart1({&huart1, true, 115200U}); // 句柄、是否启用发送、波特率(与 CubeMX 一致) + inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1({.huart = &huart1, .mode = UartDir::TxRx, .baudrate = 115200U}); + DmMotor yaw_motor(bsp_can2, {.model = DmModel::J4340P, .can_id = 0x02, .master_id = 0x12}); // board_cfg.cpp ``` -7. **构造函数只做赋值**:能在构造函数传入的就在构造函数传,不能在构造时完成的就在 `init()` 中传入;任何 FreeRTOS 相关操作或需要运行的函数(`xTaskCreate`、`xSemaphoreCreate*`、`snprintf`、`memset`、注册表注册等)一律移入 `init()`,构造函数中只允许成员赋值 -8. **隐藏逻辑必须显式化**:如 `i_max == 0 → 跟随 out_max`,要写在构造函数里并注释 + 指定初始化器**必须按字段声明顺序写**(可以跳过,不能颠倒)。算法类的 `Config` 字段多、常按位置传(`PID::Config(kp, ki, kd, out_max)`、`Rls::Config(lambda, p0)`), + 可以保留“参数顺序 = 字段顺序”的带默认值构造函数;只传一个参数时别用花括号(`{0.99f}` 也能匹配拷贝构造,有二义性),写成 `X::Config(0.99f)`。 +6. **构造函数只做赋值;外设类 constexpr + 平凡析构**:构造函数里只允许成员赋值;任何 FreeRTOS 操作(`xTaskCreate`、`xSemaphoreCreate*`、流缓冲区)、 + `memset` / `snprintf`、清单核对都放进 `init()`,释放放进 `deinit()`。外设类的构造函数写成 `constexpr`、析构函数平凡(不写析构函数): + `inline` 全局实例这样才是常量初始化——不进静态构造顺序问题、每个 TU 不各生成一份构造代码,也不注册 `atexit` 析构(N32)。 + 宿主测试里用 `constinit` 与 `static_assert(std::is_trivially_destructible_v)` 检查。成员数组要写 `= {}`,否则构造不是常量表达式。 +7. **`init()` 可重复调用**:再次 `init()` 先停外设、释放旧资源再重建,失败时回滚;前提是没有任务正在用(例如 `BspSpi` 的 BMI088 刷新任务)。 +8. **隐藏逻辑必须显式化**:如 `i_max == 0 → 跟随 out_max`,要写在代码里并注释 ## 5. 分层架构 依赖方向(上层可用下层,禁止反向): ``` -App(应用层,api_xxx 转接) - └─ Module - └─ Protocol(协议层) - └─ Device(设备层,单设备驱动) - └─ Bsp(板载支持包,完全不考虑上层硬件细节) +宿主 app/(app_init、业务任务) + └─ 宿主 board/(实例、board_init、实例清单、配置) + ├─ device/(单设备驱动:motor / sensor / remote / actuator) tasks/(库任务体) + │ └──────────────┬──────────────────────────────────────────────┘ + └─ service/(system / comm / monitor / definition) + └─ bsp/(外设驱动,完全不考虑上层设备) algorithm/(纯数学,device / service 可用) ``` -- 每层文件前缀:`bsp_` / `device_`(或设备名) / `protocol_` / `alg_` / `api_` -- 跨层通信使用下一层暴露的全局实例,不直接操作 HAL +- 层由目录决定(`code/<层>/…`),规则见 [code/README.md](code/README.md#2-依赖矩阵),`python3 tools/check_layers.py` 检查 +- 唯一的反向依赖:`bsp/`、`tasks/` 经 X-macro 包含宿主的 `board_instances.hpp` +- 跨层通信使用下一层暴露的接口 / 实例;设备层不直接操作 HAL(走 bsp) ## 6. C/C++ 混编 - HAL / FreeRTOS 回调必须 `extern "C"`,防止名称修饰 -- C 调 C++ 只通过 `api_xxx.h` 转接 +- C 调 C++ 只通过 `extern "C"` 入口转接(宿主的 `app_init()`、任务入口;库的 `system_*()`) - 任务函数若被 FreeRTOS 以 C 方式调用,需要 `extern "C"` 且参数为 `void *pvParameters` ## 7. 格式类规则(.clang-format 已固化) @@ -142,16 +171,44 @@ App(应用层,api_xxx 转接) #define configASSERT( x ) do { if ((x) == 0) { fault_on_assert(__FILE__, __LINE__); } } while (0) ``` -**有副作用的检查用 `ICBSP_CHECK(expr)`,不要写进 `configASSERT(...)`**(`service/fault_record.hpp`):`configASSERT` 可能被定义成空 +**有副作用的检查用 `ICBSP_CHECK(expr)`,不要写进 `configASSERT(...)`**(`service/system/fault_record.hpp`):`configASSERT` 可能被定义成空 (FreeRTOS 默认就是空,发布构建关断言也很常见),写在里面的 `init()` / `xTaskCreate()` 会被整个删掉,系统静默什么都不做。 `ICBSP_CHECK` 总会求值,失败时走同一个 `fault_on_assert()`。纯条件检查(例如 `configASSERT(len > 0)`)照旧用 `configASSERT`。 -失败时由 `service/fault_record.cpp` 关中断、把种类 / 文件名 / 行号 / tick / IPSR / 任务名写进 `fault_record`(RAM_D1 的 `.noinit` 段,复位后保留),再停机:接着调试器时执行 `BKPT` 停在现场,没接就死循环。栈溢出与内存分配失败钩子(`freertos.c` 的 USER CODE 4 / 5)同样记录后停机。复位后用调试器 `print fault_record` 查看上一次故障。 +失败时由 `service/system/fault_record.cpp` 关中断、把种类 / 文件名 / 行号 / tick / IPSR / 任务名写进 `fault_record`(RAM_D1 的 `.noinit` 段,复位后保留),再停机:接着调试器时执行 `BKPT` 停在现场,没接就死循环。栈溢出与内存分配失败钩子(`freertos.c` 的 USER CODE 4 / 5)同样记录后停机。复位后用调试器 `print fault_record` 查看上一次故障。 -- **初始化失败用断言**:句柄为空、RTOS 对象创建失败、外设起不来、配置与实物不符,都是“代码 / 配置写错了”,在 `bsp_init()` / `device_init()` 里**每条 `init()` 单独一行** `ICBSP_CHECK(xxx.init() == Status::OK);`,记录里的行号直接指出是哪一路 +- **初始化失败用断言**:句柄为空、RTOS 对象创建失败、外设起不来、配置与实物不符,都是“代码 / 配置写错了”,在宿主的 `board_init()` 里**每条 `init()` 单独一行** `ICBSP_CHECK(xxx.init() == Status::OK);`,记录里的行号直接指出是哪一路 - **运行期可恢复的失败返回 `Status`**:总线上的非法帧、超时、缓冲满、外部输入越界交给上层决策,不要断言(一帧噪声不应让整车停机) - **注册阶段的失败**(`regist()` 等调用 `sys_state.init_error()`)不会当场停机,由初始化末尾的 `system_start()`(内含 `ICBSP_CHECK(sys_state.complete_init() == Status::OK)`)统一停机 - 任务入口先调 `sys_state.wait_running()`:等到运行位才放行;等到初始化失败位时任务自行退出,不会永久阻塞 - 中断里尽量不放断言:ISR 里只做最少校验,非法数据丢掉并计数即可 - 宿主链接脚本必须有 `.dma_buffer` / `.noinit` 段(`templates/linker_sections.ld`),缺了 CMake 配置阶段报错;CubeMX 6.18.1 重新生成会保留已有链接脚本内容,只改几行行尾(`git checkout` 还原即可) -- 库里的可调常量一律经 `hardware_config.h` 取(直接写实际值 + `static_assert` 范围检查),不要在库源文件里写死数字,也不要再引入默认值头文件 +- 库里的可调常量一律经 `hardware_config.h` 取(库内经 `config_check.hpp` 包含,范围检查写在 `config_check.hpp`),不要在库源文件里写死数字,也不要再引入默认值头文件 + +## 9. C++20 规则 + +库和宿主都按 C++20 编译(库目标 `-Wall -Wextra -Wshadow`,0 warning)。容易踩的几条: + +- **`volatile` 不能复合赋值**:`x++`、`x += n` 对 `volatile` 变量在 C++20 里弃用(会警告),写成 `x = x + 1U`。跨任务 / 中断共享的计数器、标志都是 `volatile`,这条最常见。 +- **指定初始化器按声明顺序**:`{.huart = …, .mode = …}` 的字段顺序必须和 `Config` 里的声明顺序一致,可以省略、不能颠倒;不能和位置初始化混用。 +- **聚合体 `Config`**:给了默认成员初始化的结构体在 C++20 里仍是聚合体,可以用指定初始化器;一旦写了用户构造函数就不再是聚合体(见第 4 节第 5 条)。 +- **constexpr 构造 + 平凡析构**:外设类的 `inline` 全局实例要能常量初始化(见第 4 节第 6 条);成员里有数组时写 `= {}`。 +- **`inline` 变量**:头文件里的全局实例写 `inline`(每个 TU 一份弱定义,链接时合并);放 `.dma_buffer` 的还要按变量名区分段名(见第 10 节)。 +- **`enum class`**、`static_assert`、`if constexpr`、`std::is_trivially_destructible_v` 等照常使用;库不依赖异常与 RTTI,不要在库里 `throw` / `dynamic_cast`; + 动态分配只在初始化期用 `new (std::nothrow)` 并检查返回值。 + +## 10. `.dma_buffer` 段 + +H7 的 DMA1 / DMA2 访问不到 DTCM,默认的 `.bss` / `.data` 又在 DTCM,所以 DMA 直接读写的对象(`uart_mode::dma` 的 `BspUartT` 实例、开 DMA 的 `BspSpi` 实例、 +宿主自己的 DMA 缓冲)必须放进 AXI SRAM 的 `.dma_buffer` 段: + +```cpp +#include "bsp/bsp_dma_buffer.hpp" +inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1({.huart = &huart1}); +``` + +- **一律用宏 `ICBSP_DMA_BUFFER(变量名)`**,它展开成 `__attribute__((section(".dma_buffer.<变量名>")))`。不要手写 `section(".dma_buffer")`: + `inline` 变量是 COMDAT,每个 TU 各有一份弱定义;段名相同时这些副本的数据会全部进同一个输出段(符号去重了、数据没去),段比实例总和大出几份,或被 `--gc-sections` 剔掉真数据。 +- 段是**可加载**的(`>RAM_D1 AT> FLASH`),库在 `constructor(101)` 里把初值从 Flash 拷进 RAM,所以放进去的对象可以有初值(句柄、波特率)。 +- 库在 `init()` 里核对:DMA 模式的实例不在 DMA 可达的内存里(`icbsp_dma_reachable()`,按 DMA1/2 与 BDMA 分别判断)就返回 `BAD_ARG`。 +- 库假定 D-Cache 关闭,DMA 缓冲不做 Cache 维护。 diff --git a/templates/Flash/JLink_flash.bat b/templates/Flash/JLink_flash.bat index 6f7afb2..1d19a0c 100644 --- a/templates/Flash/JLink_flash.bat +++ b/templates/Flash/JLink_flash.bat @@ -24,7 +24,7 @@ set "ELF_FILE=build\%BUILD_TYPE%\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" set "ELF_FILE=build\Debug\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" set "ELF_FILE=build\Release\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" ( - for /f "delims=" %%f in ('dir /b /s build\*.elf 2^>nul') do ( + for /f "delims=" %%f in ('dir /b /s build\*.elf 2^>nul ^| findstr /v /i "icbsp_boot"') do ( set "ELF_FILE=%%f" goto :found ) @@ -35,9 +35,20 @@ if not exist "!ELF_FILE!" ( echo Error: ELF not found under build\ - build first ^(task: Build^) exit /b 1 ) +for %%d in ("!ELF_FILE!") do set "BUILD_DIR=%%~dpd" +set "LAYOUT=INTERNAL" +if exist "!BUILD_DIR!CMakeCache.txt" ( + for /f "tokens=2 delims==" %%l in ('findstr /b /c:"ICBSP_FLASH_LAYOUT:" "!BUILD_DIR!CMakeCache.txt"') do set "LAYOUT=%%l" +) +if /i not "!LAYOUT!"=="INTERNAL" ( + echo Error: external flash layout !LAYOUT! - J-Link script supports internal flash only, use Flash\OpenOCD_flash.bat + exit /b 1 +) -where openocd >nul 2>nul -if errorlevel 1 ( +REM OpenOCD 建议 0.12 及以上(实测用 0.12);另装了新版时用环境变量指定:set OPENOCD=C:\path\to\openocd.exe +if not defined OPENOCD set "OPENOCD=openocd" +where "!OPENOCD!" >nul 2>nul +if errorlevel 1 if not exist "!OPENOCD!" ( echo Error: openocd not found; this script drives J-Link through OpenOCD's jlink adapter. exit /b 1 ) @@ -46,7 +57,7 @@ echo Project: !PROJECT_NAME! ^(!BUILD_TYPE!^) echo ELF : !ELF_FILE! echo Flashing via OpenOCD jlink adapter ^(SWD 4 MHz^)... -openocd -f Flash/jlink.cfg ^ +"!OPENOCD!" -f Flash/jlink.cfg ^ -c "gdb_port disabled" ^ -c "tcl_port disabled" ^ -c "telnet_port disabled" ^ diff --git a/templates/Flash/JLink_flash.sh b/templates/Flash/JLink_flash.sh index ad755f0..9fc0302 100755 --- a/templates/Flash/JLink_flash.sh +++ b/templates/Flash/JLink_flash.sh @@ -28,7 +28,7 @@ find_elf() { return 0 fi done - all="$(find build -type f -name '*.elf' 2>/dev/null | sort || true)" + all="$(find build -type f -name '*.elf' -not -path '*/icbsp_boot/*' 2>/dev/null | sort || true)" [ -n "$all" ] || return 1 picked="$(printf '%s\n' "$all" | grep -F "/${PROJECT_NAME}.elf" | head -n 1 || true)" [ -n "$picked" ] || picked="$(printf '%s\n' "$all" | head -n 1)" @@ -46,17 +46,29 @@ if [ -z "$ELF_FILE" ] || [ ! -f "$ELF_FILE" ]; then exit 1 fi ELF_FILE="$(realpath "$ELF_FILE")" +LAYOUT="$(sed -n 's/^ICBSP_FLASH_LAYOUT:[A-Z]*=//p' "$(dirname "$ELF_FILE")/CMakeCache.txt" 2>/dev/null | head -n 1 || true)" +if [ -n "$LAYOUT" ] && [ "$LAYOUT" != "INTERNAL" ]; then + echo "❌ 当前构建是外置 Flash 方案($LAYOUT):J-Link 脚本只支持片内 Flash,请用 Flash/OpenOCD_flash.sh(CMSIS-DAP)" + exit 1 +fi -if ! command -v openocd >/dev/null 2>&1; then +# OpenOCD 建议 0.12 及以上(实测用的是 0.12;0.11 没验证过)。系统包管理器装的常常是 0.11, +# 另装了新版时用环境变量指定:OPENOCD=/usr/local/bin/openocd bash Flash/OpenOCD_flash.sh +OPENOCD="${OPENOCD:-openocd}" +if ! command -v "$OPENOCD" >/dev/null 2>&1; then echo "❌ 未找到 openocd;本脚本通过 OpenOCD 的 jlink 适配器驱动 J-Link" exit 1 fi +OPENOCD_VER="$("$OPENOCD" --version 2>&1 | head -n 1 | grep -oE '[0-9]+\.[0-9]+' | head -n 1)" +case "$OPENOCD_VER" in + 0.[0-9]|0.1[01]) echo "⚠️ $OPENOCD 是 $OPENOCD_VER,建议用 0.12 及以上(用 OPENOCD=<路径> 指定新版)" ;; +esac echo "🔧 项目:$PROJECT_NAME($BUILD_TYPE)" echo "📦 ELF :$ELF_FILE" echo "⚡ 经 OpenOCD jlink 适配器烧录中(SWD 4 MHz)..." -openocd -f "$SCRIPT_DIR/jlink.cfg" \ +"$OPENOCD" -f "$SCRIPT_DIR/jlink.cfg" \ -c "gdb_port disabled" \ -c "tcl_port disabled" \ -c "telnet_port disabled" \ diff --git a/templates/Flash/OpenOCD_flash.bat b/templates/Flash/OpenOCD_flash.bat index 28cccf7..63a62e3 100644 --- a/templates/Flash/OpenOCD_flash.bat +++ b/templates/Flash/OpenOCD_flash.bat @@ -2,8 +2,12 @@ REM ------------------------------------------------------------------ REM OpenOCD + CMSIS-DAP(DAPLink)烧录脚本(Windows) REM 自动递归在 build\ 下找 .elf,不用传路径 +REM 按构建目录 CMakeCache.txt 的 ICBSP_FLASH_LAYOUT 决定烧法: +REM INTERNAL 烧 .elf 到片内 Flash(daplink.cfg) +REM QSPI_RAM / QSPI_XIP 片内烧 bootloader(与板上不同时才烧),QSPI 烧 <工程名>_qspi.bin(daplink_qspi.cfg) REM 对应 VS Code 任务:OpenOCD_flash -REM 用法:Flash\OpenOCD_flash.bat [BUILD_TYPE] +REM 用法:Flash\OpenOCD_flash.bat [预设名] [--boot] [--ram] +REM --boot 强制重烧 bootloader;--ram 只用于 QSPI_RAM:下载进 AXI SRAM 运行,不写 Flash REM ------------------------------------------------------------------ setlocal enabledelayedexpansion @@ -15,8 +19,15 @@ for %%i in ("%~dp0\..") do ( set "PROJECT_NAME={{PROJECT}}" if "%PROJECT_NAME%"=="" set "PROJECT_NAME=%FOLDER_NAME%" -set "BUILD_TYPE=%~1" -if "%BUILD_TYPE%"=="" set "BUILD_TYPE={{PRESET}}" +set "BUILD_TYPE={{PRESET}}" +set "FORCE_BOOT=0" +set "RAM_ONLY=0" +:args +if "%~1"=="" goto :args_done +if /i "%~1"=="--boot" (set "FORCE_BOOT=1") else if /i "%~1"=="--ram" (set "RAM_ONLY=1") else (set "BUILD_TYPE=%~1") +shift +goto :args +:args_done cd /d "%PROJECT_DIR%" || exit /b 1 @@ -24,7 +35,7 @@ set "ELF_FILE=build\%BUILD_TYPE%\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" set "ELF_FILE=build\Debug\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" set "ELF_FILE=build\Release\%PROJECT_NAME%.elf" if not exist "!ELF_FILE!" ( - for /f "delims=" %%f in ('dir /b /s build\*.elf 2^>nul') do ( + for /f "delims=" %%f in ('dir /b /s build\*.elf 2^>nul ^| findstr /v /i "icbsp_boot"') do ( set "ELF_FILE=%%f" goto :found ) @@ -35,23 +46,85 @@ if not exist "!ELF_FILE!" ( echo Error: ELF not found under build\ - build first ^(task: Build^) exit /b 1 ) +for %%d in ("!ELF_FILE!") do set "BUILD_DIR=%%~dpd" +set "LAYOUT=INTERNAL" +if exist "!BUILD_DIR!CMakeCache.txt" ( + for /f "tokens=2 delims==" %%l in ('findstr /b /c:"ICBSP_FLASH_LAYOUT:" "!BUILD_DIR!CMakeCache.txt"') do set "LAYOUT=%%l" +) -where openocd >nul 2>nul -if errorlevel 1 ( +REM OpenOCD 建议 0.12 及以上(实测用 0.12);另装了新版时用环境变量指定:set OPENOCD=C:\path\to\openocd.exe +if not defined OPENOCD set "OPENOCD=openocd" +where "!OPENOCD!" >nul 2>nul +if errorlevel 1 if not exist "!OPENOCD!" ( echo Error: openocd not found. Install it, or add it to PATH. exit /b 1 ) echo Project: !PROJECT_NAME! echo ELF : !ELF_FILE! -echo Flashing via OpenOCD ^(CMSIS-DAP^)... - -openocd -f Flash/daplink.cfg ^ - -c "gdb_port disabled" ^ - -c "tcl_port disabled" ^ - -c "telnet_port disabled" ^ - -c "program \"!ELF_FILE!\" verify reset exit" -if errorlevel 1 exit /b %errorlevel% +echo Layout : !LAYOUT! + +if /i "!LAYOUT!"=="INTERNAL" ( + if "!RAM_ONLY!"=="1" ( + echo Error: --ram is only for QSPI_RAM + exit /b 1 + ) + echo Flashing via OpenOCD ^(CMSIS-DAP, internal flash^)... + "!OPENOCD!" -f Flash/daplink.cfg ^ + -c "gdb_port disabled" -c "tcl_port disabled" -c "telnet_port disabled" ^ + -c "program \"!ELF_FILE:\=/!\" verify reset exit" + if errorlevel 1 exit /b !errorlevel! + echo Done. + exit /b 0 +) + +if not exist "Flash\daplink_qspi.cfg" ( + echo Error: Flash\daplink_qspi.cfg missing - enable external flash in integrate.py / Web UI + exit /b 1 +) +set "ELF_FWD=!ELF_FILE:\=/!" + +if "!RAM_ONLY!"=="1" ( + if /i not "!LAYOUT!"=="QSPI_RAM" ( + echo Error: --ram is only for QSPI_RAM, current layout is !LAYOUT! + exit /b 1 + ) + echo Loading into AXI SRAM ^(no flash write^)... + "!OPENOCD!" -f Flash/daplink.cfg ^ + -c "gdb_port disabled" -c "tcl_port disabled" -c "telnet_port disabled" ^ + -c "init" -c "reset halt" -c "load_image \"!ELF_FWD!\"" ^ + -c "set sp [read_memory 0x24000000 32 1]; set pc [read_memory 0x24000004 32 1]" ^ + -c "reg msp $sp; reg xpsr 0x01000000; resume [expr {$pc & ~1}]" -c "shutdown" + if errorlevel 1 exit /b !errorlevel! + echo Running from RAM. + exit /b 0 +) + +set "BOOT_ELF=!BUILD_DIR!icbsp_boot\icbsp_boot.elf" +set "IMAGE=!ELF_FILE:~0,-4!_qspi.bin" +if not exist "!BOOT_ELF!" ( + echo Error: !BOOT_ELF! not found - build first + exit /b 1 +) +if not exist "!IMAGE!" ( + echo Error: !IMAGE! not found - build first + exit /b 1 +) +set "BOOT_FWD=!BOOT_ELF:\=/!" +set "IMAGE_FWD=!IMAGE:\=/!" +set "BOOT_CMD=if {[catch {verify_image \"!BOOT_FWD!\"}]} { flash write_image erase \"!BOOT_FWD!\"; verify_image \"!BOOT_FWD!\" }" +if "!FORCE_BOOT!"=="1" set "BOOT_CMD=flash write_image erase \"!BOOT_FWD!\"; verify_image \"!BOOT_FWD!\"" + +echo Boot : !BOOT_ELF! +echo Image : !IMAGE! +echo Flashing via OpenOCD ^(bootloader to internal flash, image to QSPI 0x90000000^)... +"!OPENOCD!" -f Flash/daplink_qspi.cfg ^ + -c "gdb_port disabled" -c "tcl_port disabled" -c "telnet_port disabled" ^ + -c "init" -c "reset init" -c "!BOOT_CMD!" ^ + -c "flash write_image erase \"!IMAGE_FWD!\" 0x90000000 bin" ^ + -c "verify_image \"!IMAGE_FWD!\" 0x90000000 bin" ^ + -c "reset run" -c "shutdown" +if errorlevel 1 exit /b !errorlevel! echo Done. exit /b 0 diff --git a/templates/Flash/OpenOCD_flash.sh b/templates/Flash/OpenOCD_flash.sh index fad0fec..082b583 100755 --- a/templates/Flash/OpenOCD_flash.sh +++ b/templates/Flash/OpenOCD_flash.sh @@ -3,11 +3,17 @@ # OpenOCD + CMSIS-DAP(DAPLink)烧录脚本(Linux) # # - 自动定位工程根目录,递归在 build/ 下找 .elf(不用传路径) +# - 按构建目录 CMakeCache.txt 里的 ICBSP_FLASH_LAYOUT 决定烧法(外置 Flash 方案,见 docs/接入指南.md): +# INTERNAL 烧 .elf 到片内 Flash(daplink.cfg) +# QSPI_RAM 方案 A:片内烧 bootloader(与板上不同时才烧),QSPI 烧 <工程名>_qspi.bin(daplink_qspi.cfg) +# QSPI_XIP 方案 B:同上 # - 对应 VS Code 任务:OpenOCD_flash(.vscode/tasks.json) # -# 用法:bash Flash/OpenOCD_flash.sh [BUILD_TYPE] -# 省略 BUILD_TYPE 时依次尝试 build/{{PRESET}}/<工程名>.elf、build/Debug、build/Release, -# 都没有就在 build/ 下递归找,找到多个会提示实际用的是哪个。 +# 用法:bash Flash/OpenOCD_flash.sh [预设名] [--boot] [--ram] +# 预设名 build/<预设名>/ 下的构建,例如 Debug、Debug-QspiRam;省略时依次尝试 {{PRESET}}、Debug、Release, +# 都没有就在 build/ 下递归找,找到多个会提示实际用的是哪个 +# --boot 外置方案:不比较,强制重烧 bootloader +# --ram 只用于 QSPI_RAM:把程序直接下载进 AXI SRAM 运行,不写任何 Flash(调试迭代用,掉电即失) # ------------------------------------------------------------------ set -euo pipefail @@ -17,7 +23,18 @@ cd "$PROJECT_DIR" PROJECT_NAME="{{PROJECT}}" [ -n "$PROJECT_NAME" ] || PROJECT_NAME="$(basename "$PROJECT_DIR")" -BUILD_TYPE="${1:-{{PRESET}}}" +BUILD_TYPE="{{PRESET}}" +FORCE_BOOT=0 +RAM_ONLY=0 +for arg in "$@"; do + case "$arg" in + --boot) FORCE_BOOT=1 ;; + --ram) RAM_ONLY=1 ;; + -h|--help) sed -n '2,20p' "${BASH_SOURCE[0]}"; exit 0 ;; + -*) echo "❌ 不认识的参数 $arg(可用 --boot / --ram)"; exit 1 ;; + *) BUILD_TYPE="$arg" ;; + esac +done find_elf() { local candidate all picked count @@ -30,7 +47,7 @@ find_elf() { return 0 fi done - all="$(find build -type f -name '*.elf' 2>/dev/null | sort || true)" + all="$(find build -type f -name '*.elf' -not -path '*/icbsp_boot/*' 2>/dev/null | sort || true)" [ -n "$all" ] || return 1 picked="$(printf '%s\n' "$all" | grep -F "/${PROJECT_NAME}.elf" | head -n 1 || true)" [ -n "$picked" ] || picked="$(printf '%s\n' "$all" | head -n 1)" @@ -47,20 +64,88 @@ if [ -z "$ELF_FILE" ] || [ ! -f "$ELF_FILE" ]; then echo "❌ 找不到 .elf,请先编译(任务:Build)" exit 1 fi +BUILD_DIR="$(dirname "$ELF_FILE")" +LAYOUT="INTERNAL" +if [ -f "$BUILD_DIR/CMakeCache.txt" ]; then + LAYOUT="$(sed -n 's/^ICBSP_FLASH_LAYOUT:[A-Z]*=//p' "$BUILD_DIR/CMakeCache.txt" | head -n 1)" + [ -n "$LAYOUT" ] || LAYOUT="INTERNAL" +fi -if ! command -v openocd >/dev/null 2>&1; then +# OpenOCD 建议 0.12 及以上(实测用的是 0.12;0.11 没验证过)。系统包管理器装的常常是 0.11, +# 另装了新版时用环境变量指定:OPENOCD=/usr/local/bin/openocd bash Flash/OpenOCD_flash.sh +OPENOCD="${OPENOCD:-openocd}" +if ! command -v "$OPENOCD" >/dev/null 2>&1; then echo "❌ 未找到 openocd,请先安装:sudo apt install openocd" exit 1 fi +OPENOCD_VER="$("$OPENOCD" --version 2>&1 | head -n 1 | grep -oE '[0-9]+\.[0-9]+' | head -n 1)" +case "$OPENOCD_VER" in + 0.[0-9]|0.1[01]) echo "⚠️ $OPENOCD 是 $OPENOCD_VER,建议用 0.12 及以上(用 OPENOCD=<路径> 指定新版)" ;; +esac echo "🔧 项目:$PROJECT_NAME" echo "📦 ELF :$ELF_FILE" -echo "⚡ OpenOCD 烧录中(CMSIS-DAP)..." +echo "🗂 程序存放方式:$LAYOUT" + +QUIET=(-c "gdb_port disabled" -c "tcl_port disabled" -c "telnet_port disabled") -openocd -f "$SCRIPT_DIR/daplink.cfg" \ - -c "gdb_port disabled" \ - -c "tcl_port disabled" \ - -c "telnet_port disabled" \ +if [ "$LAYOUT" = "INTERNAL" ]; then + if [ "$RAM_ONLY" = 1 ]; then + echo "❌ --ram 只用于 QSPI_RAM(方案 A)" + exit 1 + fi + echo "⚡ OpenOCD 烧录中(CMSIS-DAP,片内 Flash)..." + "$OPENOCD" -f "$SCRIPT_DIR/daplink.cfg" "${QUIET[@]}" \ -c "program \"$ELF_FILE\" verify reset exit" + echo "✅ 烧录完成" + exit 0 +fi + +if [ ! -f "$SCRIPT_DIR/daplink_qspi.cfg" ]; then + echo "❌ 没有 Flash/daplink_qspi.cfg:用 integrate.py / Web UI 打开“外置 Flash”生成" + exit 1 +fi + +if [ "$RAM_ONLY" = 1 ]; then + if [ "$LAYOUT" != "QSPI_RAM" ]; then + echo "❌ --ram 只用于 QSPI_RAM(方案 A),当前是 $LAYOUT" + exit 1 + fi + echo "⚡ 下载进 AXI SRAM 运行(不写 Flash,掉电即失)..." + # 复位停住(bootloader 还没跑),下载 ELF,按 0x24000000 的向量表设栈和入口后运行。 + # 不做 verify_image:ld 把 ELF 头映射进了 0x20000000 的段(只有 .bss),OpenOCD 校验它会误报不一致 + "$OPENOCD" -f "$SCRIPT_DIR/daplink.cfg" "${QUIET[@]}" \ + -c "init" -c "reset halt" \ + -c "load_image \"$ELF_FILE\"" \ + -c "set sp [read_memory 0x24000000 32 1]; set pc [read_memory 0x24000004 32 1]" \ + -c "reg msp \$sp; reg xpsr 0x01000000; resume [expr {\$pc & ~1}]" \ + -c "shutdown" + echo "✅ 已在 RAM 中运行" + exit 0 +fi + +BOOT_ELF="$BUILD_DIR/icbsp_boot/icbsp_boot.elf" +IMAGE="${ELF_FILE%.elf}_qspi.bin" +for f in "$BOOT_ELF" "$IMAGE"; do + if [ ! -f "$f" ]; then + echo "❌ 找不到 $f,请先编译(外置 Flash 方案会同时生成 bootloader 和 QSPI 镜像)" + exit 1 + fi +done +echo "📦 boot:$BOOT_ELF" +echo "📦 镜像:$IMAGE" +echo "⚡ OpenOCD 烧录中(CMSIS-DAP,bootloader → 片内 Flash,镜像 → QSPI 0x90000000)..." + +# bootloader 与板上一致就不重烧(片内 Flash 只有一个 128 KB 扇区,每次擦写都要几秒) +BOOT_CMD="if {[catch {verify_image \"$BOOT_ELF\"}]} { echo \"bootloader 与板上不同,烧录\"; flash write_image erase \"$BOOT_ELF\"; verify_image \"$BOOT_ELF\" } else { echo \"bootloader 未变,跳过\" }" +if [ "$FORCE_BOOT" = 1 ]; then + BOOT_CMD="flash write_image erase \"$BOOT_ELF\"; verify_image \"$BOOT_ELF\"" +fi +"$OPENOCD" -f "$SCRIPT_DIR/daplink_qspi.cfg" "${QUIET[@]}" \ + -c "init" -c "reset init" \ + -c "$BOOT_CMD" \ + -c "flash write_image erase \"$IMAGE\" 0x90000000 bin" \ + -c "verify_image \"$IMAGE\" 0x90000000 bin" \ + -c "reset run" -c "shutdown" echo "✅ 烧录完成" diff --git a/templates/Flash/README.md b/templates/Flash/README.md index 0d91374..0348a7b 100644 --- a/templates/Flash/README.md +++ b/templates/Flash/README.md @@ -30,7 +30,9 @@ Flash\JLink_flash.bat Release Windows 上也可直接用 VS Code 任务 `OpenOCD_flash` / `JLink_flash`(`tasks.json` 里按平台自动选 `.sh` 或 `.bat`)。 -两个脚本都依赖 `openocd`;J-Link 版本还要求 OpenOCD 带 `jlink` 适配器(`openocd -c "adapter list" -c "shutdown"` 可确认)。 +两个脚本都依赖 `openocd`,**建议 0.12 及以上**(实测用的是 0.12;0.11 没验证过,脚本检测到旧版会提示)。 +系统包管理器装的常常是 0.11,另装了新版时用环境变量 `OPENOCD` 指定:`OPENOCD=/usr/local/bin/openocd bash Flash/OpenOCD_flash.sh`(Windows:`set OPENOCD=...`)。 +J-Link 版本还要求 OpenOCD 带 `jlink` 适配器(`openocd -c "adapter list" -c "shutdown"` 可确认)。 `.sh` 需要可执行权限:`chmod +x Flash/*.sh`。 ## 关于 SVD @@ -47,7 +49,25 @@ Keil 的 `STM32H7xx_DFP` 包,或 ST 官网下载,放到 `Flash/` 下即可 | 文件 | 用途 | | --- | --- | -| `daplink.cfg` | OpenOCD 的 CMSIS-DAP 配置(SWD + 目标芯片) | +| `daplink.cfg` | OpenOCD 的 CMSIS-DAP 配置(SWD + 目标芯片)。部分探针(Horco v0.2)bulk 端点不响应,要取消 `cmsis-dap backend hid` 的注释 | | `jlink.cfg` | OpenOCD 的 SEGGER J-Link 配置(`adapter driver jlink` + SWD 4 MHz) | +| `daplink_qspi.cfg` | 外置 QSPI Flash 方案专用:`reset-init` / `gdb-attach` 时配好 QSPI 引脚与 QUADSPI,注册 `stmqspi` bank。占位符 `{{QSPI_INIT}}` 由 `integrate.py` 按 `.ioc` 生成 | + +## 外置 QSPI Flash(`ICBSP_FLASH_LAYOUT` = `QSPI_RAM` / `QSPI_XIP`) + +`OpenOCD_flash.*` 从构建目录的 `CMakeCache.txt` 读存放方式:外置方案时用 `daplink_qspi.cfg`,bootloader(`icbsp_boot/icbsp_boot.elf`) +与板上不同才烧(`--boot` 强制),QSPI 写 `<工程名>_qspi.bin` 到 0x90000000;`--ram`(只用于 `QSPI_RAM`)直接下载进 AXI SRAM 运行、不写 Flash。 +J-Link 脚本只支持片内 Flash。详见 `docs/外置Flash.md`。 + +上面“不要注册外置 Flash bank”的经验对 `daplink.cfg` 仍然成立:外置 bank 只放在 `daplink_qspi.cfg` 里,并且它在 `reset-init` 与 `gdb-attach` +时先初始化 QSPI 再探测芯片,所以不会出现 MC02 上那种访问未初始化的外置 Flash 把调试口卡死的情况(H750 + W25Q128 实测)。 + +## 实测经验(DM-MC02 / STM32H723) + +- **不要注册外置 Flash bank**(OCTOSPI2 上的 W25Q64 等):注册后 OpenOCD 在 `program` / `reset` 时会访问 OCTOSPI2, + 固件没有重新初始化它时会把调试口卡死,只能重新上电。 +- OpenOCD 用 0.12 及以上(实测版本)。常见情况是系统包为 0.11、另装的 0.12 在 `/usr/local/bin`,用 `OPENOCD` 环境变量指定。 +- 烧录前 OpenOCD 会在目标上跑一段 CRC 校验程序,板上原来的固件若接了 `fault_on_exception()`,可能记下一条假的 HardFault + (BFAR = 0x04C11DB7,即 CRC-32 多项式;tick 0),复位后看 `fault_record` 时注意区分。 相关配置:`.vscode/tasks.json`(烧录任务)、`.vscode/launch.json`(调试配置)。 diff --git a/templates/Flash/daplink.cfg b/templates/Flash/daplink.cfg index 9575105..55ab409 100644 --- a/templates/Flash/daplink.cfg +++ b/templates/Flash/daplink.cfg @@ -1,7 +1,14 @@ # OpenOCD 配置:CMSIS-DAP(DAPLink)探针,SWD source [find interface/cmsis-dap.cfg] + +# 部分探针(实测:Horco v0.2)的 USB bulk 端点对 CMD_INFO 不响应,连不上时取消下一行注释改用 HID 后端 +# cmsis-dap backend hid + transport select swd # {{MCU}}:CubeMX 的 .ioc 里 Mcu.Name 决定,integrate.py 会自动填 source [find target/{{OPENOCD_TARGET}}] + +# 不要在这里注册外置 Flash bank(例如 DM-MC02 的 OCTOSPI2 W25Q64):注册后 OpenOCD 在 program / reset +# 时会访问 OCTOSPI2,固件没有重新初始化它时会把调试口卡死,只能重新上电。外置 Flash 要单独写脚本烧。 diff --git a/templates/Flash/daplink_qspi.cfg b/templates/Flash/daplink_qspi.cfg new file mode 100644 index 0000000..ca9a737 --- /dev/null +++ b/templates/Flash/daplink_qspi.cfg @@ -0,0 +1,34 @@ +# OpenOCD 配置:CMSIS-DAP(DAPLink)探针,SWD,外加外置 QSPI Flash({{QSPI_CHIP}},QUADSPI Bank {{QSPI_BANK}}) +# +# 只在外置 Flash 方案(ICBSP_FLASH_LAYOUT = QSPI_RAM / QSPI_XIP)写 QSPI、调试 XIP 程序时用; +# 日常烧片内 Flash 仍用 daplink.cfg(不注册外置 bank,见那里的说明)。 +# 由 integrate.py 按 .ioc 的 QUADSPI 引脚生成;改了引脚请重新运行 integrate.py。 +# +# reset-init(program / reset init 时执行)里用寄存器把 QSPI 引脚和 QUADSPI 配好、切到单线内存映射读, +# stmqspi 驱动在此基础上探测芯片(JEDEC ID)并擦写。此时 CPU 停在复位后,bootloader 还没跑。 + +source [find interface/cmsis-dap.cfg] + +# 部分探针(实测:Horco v0.2)的 USB bulk 端点对 CMD_INFO 不响应,连不上时取消下一行注释改用 HID 后端 +# cmsis-dap backend hid + +transport select swd + +set QUADSPI 1 +source [find target/{{OPENOCD_TARGET}}] + +proc icbsp_qspi_init {} { +{{QSPI_INIT}} +} + +$_CHIPNAME.cpu0 configure -event reset-init { + icbsp_qspi_init + adapter speed 4000 +} + +# GDB 连上时先复位并初始化 QSPI,再让 stmqspi 探测芯片:GDB 一连上就要内存映射(qXfer:memory-map), +# 这时 bank 没探测成功的话,0x90000000 不会被标成 Flash,load 会退化成普通写内存而失败 +$_CHIPNAME.cpu0 configure -event gdb-attach { + reset init + flash probe $::_QSPINAME +} diff --git a/templates/Flash/jlink.cfg b/templates/Flash/jlink.cfg index 5586358..8aef823 100644 --- a/templates/Flash/jlink.cfg +++ b/templates/Flash/jlink.cfg @@ -9,3 +9,5 @@ transport select swd # {{MCU}}:CubeMX 的 .ioc 里 Mcu.Name 决定,integrate.py 会自动填 source [find target/{{OPENOCD_TARGET}}] + +# 不要在这里注册外置 Flash bank(例如 DM-MC02 的 OCTOSPI2):理由见 daplink.cfg 末尾 diff --git a/templates/README.md b/templates/README.md index 82d4c1f..9f78bee 100644 --- a/templates/README.md +++ b/templates/README.md @@ -5,16 +5,20 @@ | 文件 | 放到哪里 | 作用 | | --- | --- | --- | | `linker_sections.ld` | 宿主链接脚本 `SECTIONS { }` 里、`.data` 之前 | 可加载的 `.dma_buffer`(串口 / SPI 实例,DMA 可达的 AXI SRAM,`AT> FLASH`)与 `.noinit`(`fault_record`,复位保留) | +| `flash_layout/h7_qspi_ram.ld.in`、`h7_qspi_xip.ld.in` | 不复制:`cmake/icbsp_flash.cmake` 构建时 `configure_file` 到构建目录 | 外置 QSPI Flash 方案 A(拷进 AXI SRAM 运行)/ 方案 B(XIP)的链接脚本,见 `docs/外置Flash.md` | +| `gitignore` | 宿主根 `.gitignore` | 示例忽略项:宿主没有就整份复制,有就只追加缺的行(`# >>> icbsp` … `# <<< icbsp`) | | `FreeRTOSConfig_user_code.h` | `Core/Inc/FreeRTOSConfig.h` 的 USER CODE 1 段 | `configASSERT` → `fault_on_assert()` | | `freertos_user_code.c` | `Core/Src/freertos.c` 的 Includes / 4 / 5 / Init 段 | 栈溢出与分配失败钩子;`MX_FREERTOS_Init()` 调 `app_init()` | | `user/board/hardware_config.h` | `user/board/` | 必选:唯一配置源,所有宏、功能开关与范围检查都在这里 | | `user/board/board_cfg.*` | `user/board/` | `board_cfg.hpp` 放 inline 外设实例,`board_cfg.cpp` 放 `board_init()` | -| `user/board/board_instances.hpp` | `user/board/` | `BSP_CAN_INSTANCES` / `BSP_UART_INSTANCES` / `BSP_SPI_INSTANCES` 实例名清单,库的 HAL 回调与任务按它展开 | +| `user/board/board_instances.hpp` | `user/board/` | `ICBSP_CAN_INSTANCES` / `ICBSP_UART_INSTANCES` / `ICBSP_SPI_INSTANCES` 实例名清单,库的 HAL 回调与任务按它展开 | | `user/app/app_main.*` | `user/app/` | `app_init()` 与默认任务体 `app_default_task()`(`freertos.c` 的 `StartDefaultTask()` 在 USER CODE 段里转调) | | `user/app/app_task.hpp` | `user/app/` | 示例任务声明(heartbeat / monitor) | | `user/app/task/demo_task.cpp` | `user/app/task/` | 示例任务实现,不自动创建 | | `vscode/settings.json`、`vscode/tasks.json`、`vscode/launch.json` | 宿主 `.vscode/` | 编译 / 烧录任务与调试配置,宿主没有才生成;有就只补缺失项 | -| `Flash/OpenOCD_flash.*`、`Flash/JLink_flash.*`、`Flash/*.cfg` | 宿主 `Flash/` | 烧录脚本,运行时按工程名在 `build/` 下递归找 `.elf`;`.sh` 自动加可执行权限 | +| `vscode/launch_qspi.json` | 合并进宿主 `.vscode/launch.json` | 外置 Flash 启用时加的两个调试配置:`cmsis-dap-debug (QSPI_RAM)`、`cmsis-dap-debug (QSPI_XIP)` | +| `Flash/OpenOCD_flash.*`、`Flash/JLink_flash.*`、`Flash/*.cfg` | 宿主 `Flash/` | 烧录脚本,运行时按工程名在 `build/` 下递归找 `.elf`,按构建目录的 `ICBSP_FLASH_LAYOUT` 决定烧法;`.sh` 自动加可执行权限 | +| `Flash/daplink_qspi.cfg` | 宿主 `Flash/`(外置 Flash 启用时,按 `.ioc` 的 QSPI 引脚生成) | OpenOCD:QSPI 引脚 / QUADSPI 初始化 + `stmqspi` bank,写 QSPI 和调试方案 B 用 | | `clang/.clangd` | 宿主根 `.clangd` | clangd 配置:`CompilationDatabase` 指向该预设的构建目录。缺了它,CubeMX 的 Cortex-M 工程在 clangd 里会满屏假错误。**`--query-driver` 不能写这里**(会被当编译器参数,报 `drv_unknown_argument`),它属于 `.vscode/settings.json` 的 `clangd.arguments` | | `clang/compile_flags.yaml` | 同上,插入宿主已有的 `.clangd` 顶部 | 只含 `CompileFlags` 一段:宿主已手写 `.clangd`(有 InlayHints / Diagnostics 等)时用它合并,不动原有配置 | | `clang/ignore_templates.yaml` | 同上,追加到 `.clangd` **末尾**(自带 `---` 分隔) | 让库的 `templates/` 不用宿主编译数据库、不进后台索引、不报诊断:模板与宿主有同名文件(`board_cfg.hpp` 等),留着会干扰补全与跳转 | @@ -26,15 +30,15 @@ `board_cfg.*` 用的是 `hfdcan1` / `huart1` / `htim12`,换成实际外设;没开的外设连同 `#include` 一起删。新增实例时同时改 `board_instances.hpp`,否则 HAL 回调找不到它。 -`hardware_config.h` 是唯一配置源:所有宏都写成实际值,顶部包含 HAL / FreeRTOS,`HAL_FDCAN_MODULE_ENABLED` / `HAL_UART_MODULE_ENABLED` 未定义时会自动关闭 `CAN_RX_ENABLE` / `CAN_TX_ENABLE` / `UART_PATROL_ENABLE`。不再有默认值头文件。 +`hardware_config.h` 是唯一配置源:所有宏都写成实际值,顶部包含 HAL / FreeRTOS,`HAL_FDCAN_MODULE_ENABLED` / `HAL_UART_MODULE_ENABLED` 未定义时会自动关闭 `ICBSP_CAN_RX_ENABLE` / `ICBSP_CAN_TX_ENABLE` / `ICBSP_UART_PATROL_ENABLE`。不再有默认值头文件。 SPI / BMI088 的写法在 `board_cfg.hpp` 注释里,开 SPI 后再取消注释;外设实例都是 `inline` 变量,`board_cfg.cpp` 只放 `board_init()`。 宿主 CMake 只需要包含路径和 `user/**/*.cpp` 收集: ```cmake -add_subdirectory(third_party/stm32-framework) -target_include_directories(stm32_framework PRIVATE user/board) # 库自身也要看到 hardware_config.h -target_link_libraries(${CMAKE_PROJECT_NAME} stm32_framework) +add_subdirectory(third_party/icbsp) +target_include_directories(icbsp PRIVATE user/board) # 库自身也要看到 hardware_config.h +target_link_libraries(${CMAKE_PROJECT_NAME} icbsp) target_compile_features(${CMAKE_PROJECT_NAME} PRIVATE cxx_std_20) target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE user/board user/app user/module) target_link_options(${CMAKE_PROJECT_NAME} PRIVATE -u _printf_float) diff --git a/templates/clang/.clangd b/templates/clang/.clangd index 4a4da77..f6121f9 100644 --- a/templates/clang/.clangd +++ b/templates/clang/.clangd @@ -1,4 +1,4 @@ -# .clangd —— 由 stm32-framework/tools/integrate.py 生成(工程 {{PROJECT}},预设 {{PRESET}}) +# .clangd —— 由 ICBSP/tools/integrate.py 生成(工程 {{PROJECT}},预设 {{PRESET}}) # # 为什么需要它:clangd 不会自己去 CMake 构建目录里找 compile_commands.json。 # 不给它,它就只能靠猜参数,于是 Cortex-M 相关的 -mcpu / -mfpu / 系统头全丢,头文件一路标红。 diff --git a/templates/clang/compile_flags.yaml b/templates/clang/compile_flags.yaml index 1fb749d..368aeeb 100644 --- a/templates/clang/compile_flags.yaml +++ b/templates/clang/compile_flags.yaml @@ -1,4 +1,4 @@ -# ---- stm32_framework(integrate.py 添加,可手动调整)------------------------------ +# ---- icbsp(integrate.py 添加,可手动调整)------------------------------ # clangd 不会自己去 CMake 构建目录找 compile_commands.json,必须在这里指明; # 少了它,Cortex-M 的 -mcpu / -mfpu 与系统头全丢,头文件会一路标红。 # - CompilationDatabase:相对宿主根目录的构建目录(取自 CMakePresets.json 的 binaryDir) diff --git a/templates/clang/ignore_templates.yaml b/templates/clang/ignore_templates.yaml index 691b315..6d0c199 100644 --- a/templates/clang/ignore_templates.yaml +++ b/templates/clang/ignore_templates.yaml @@ -1,5 +1,5 @@ --- -# ---- stm32_framework(integrate.py 添加):库的 templates/ 不是编译单元 ---- +# ---- icbsp(integrate.py 添加):库的 templates/ 不是编译单元 ---- # 里面的 .hpp / .cpp 只是给宿主抄的样例,不参与构建。若让 clangd 也按工程配置解析它们: # - 会冒出一堆假错误(模板没有你的 CubeMX 句柄、也没有宿主的上下文) # - 同名文件互相干扰:templates/user/board/board_cfg.hpp 与宿主 user/board/board_cfg.hpp diff --git a/templates/flash_layout/h7_qspi_ram.ld.in b/templates/flash_layout/h7_qspi_ram.ld.in new file mode 100644 index 0000000..9cdfedc --- /dev/null +++ b/templates/flash_layout/h7_qspi_ram.ld.in @@ -0,0 +1,215 @@ +/* + * icbsp:外置 QSPI Flash 方案 A(QSPI_RAM)—— 程序存在 QSPI,开机由 bootloader 拷进 AXI SRAM 运行 + * + * 由 cmake/icbsp_flash.cmake 从 templates/flash_layout/h7_qspi_ram.ld.in 生成到构建目录,不要手改生成结果。 + * 适用:STM32H742/H743/H750/H753(AXI SRAM 0x24000000,DTCM 0x20000000)。 + * + * 规则: + * - 所有可加载段(代码、常量、.dma_buffer 初值、.data 初值)都在 RAM(AXI SRAM)里且排在最前, + * tools/qspi_image.py 把它们拼成连续载荷;NOLOAD 段(.noinit、.bss 等)一律排在后面, + * bootloader 拷贝时不会覆盖 .noinit(fault_record 复位保留)。 + * - .data / .bss / 堆栈放 DTCM(与 CubeMX 默认一致);.dma_buffer 必须在 DMA 能访问的 AXI SRAM。 + * - RAM_D3 末尾 32 字节留给 bootloader 的状态字(ICBSP_BOOT_STATUS_ADDR)。 + */ + +ENTRY(Reset_Handler) + +MEMORY +{ + DTCMRAM (xrw) : ORIGIN = 0x20000000, LENGTH = 128K + RAM (xrw) : ORIGIN = 0x24000000, LENGTH = @ICBSP_AXI_SRAM_SIZE@ + RAM_D2 (xrw) : ORIGIN = 0x30000000, LENGTH = 288K + RAM_D3 (xrw) : ORIGIN = 0x38000000, LENGTH = 64K - 32 + ITCMRAM (xrw) : ORIGIN = 0x00000000, LENGTH = 64K + QSPI (rx) : ORIGIN = 0x90000000, LENGTH = @ICBSP_QSPI_SIZE@ +} + +_estack = ORIGIN(DTCMRAM) + LENGTH(DTCMRAM); +_sstack = _estack - _Min_Stack_Size; +_Min_Heap_Size = @ICBSP_MIN_HEAP_SIZE@; +_Min_Stack_Size = @ICBSP_MIN_STACK_SIZE@; + +SECTIONS +{ + .isr_vector : + { + . = ALIGN(4); + KEEP(*(.isr_vector)) + . = ALIGN(4); + } >RAM + + .text : + { + . = ALIGN(4); + *(.text) + *(.text*) + *(.glue_7) + *(.glue_7t) + *(.eh_frame) + *(.RamFunc) + *(.RamFunc*) + KEEP (*(.init)) + KEEP (*(.fini)) + . = ALIGN(4); + _etext = .; + } >RAM + + .rodata : + { + . = ALIGN(4); + *(.rodata) + *(.rodata*) + . = ALIGN(4); + } >RAM + + .ARM.extab (READONLY) : + { + . = ALIGN(4); + *(.ARM.extab* .gnu.linkonce.armextab.*) + . = ALIGN(4); + } >RAM + + .ARM (READONLY) : + { + . = ALIGN(4); + __exidx_start = .; + *(.ARM.exidx*) + __exidx_end = .; + . = ALIGN(4); + } >RAM + + .preinit_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__preinit_array_start = .); + KEEP (*(.preinit_array*)) + PROVIDE_HIDDEN (__preinit_array_end = .); + . = ALIGN(4); + } >RAM + + .init_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__init_array_start = .); + KEEP (*(SORT(.init_array.*))) + KEEP (*(.init_array*)) + PROVIDE_HIDDEN (__init_array_end = .); + . = ALIGN(4); + } >RAM + + .fini_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__fini_array_start = .); + KEEP (*(SORT(.fini_array.*))) + KEEP (*(.fini_array*)) + PROVIDE_HIDDEN (__fini_array_end = .); + . = ALIGN(4); + } >RAM + + /* icbsp:见 templates/linker_sections.ld。方案 A 里运行地址就是加载地址(同在 AXI SRAM), + system.cpp 的初值拷贝遇到地址相同会跳过 */ + .dma_buffer : + { + . = ALIGN(32); + __dma_buffer_start = .; + *(.dma_buffer) + *(.dma_buffer*) + . = ALIGN(32); + __dma_buffer_end = .; + } >RAM AT> RAM + __dma_buffer_load = LOADADDR(.dma_buffer) + (__dma_buffer_start - ADDR(.dma_buffer)); /* 段内 ALIGN(32) 会让起点后移,加载地址同样偏移 */ + + _sidata = LOADADDR(.data); + + .data : + { + . = ALIGN(4); + _sdata = .; + *(.data) + *(.data*) + . = ALIGN(4); + } >DTCMRAM AT> RAM + + .tdata : ALIGN(4) + { + *(.tdata .tdata.* .gnu.linkonce.td.*) + . = ALIGN(4); + _edata = .; + PROVIDE(__data_end = .); + PROVIDE(__tdata_end = .); + } >DTCMRAM AT> RAM + + /* 载荷到此为止:后面只能是 NOLOAD 段 */ + __icbsp_image_end = LOADADDR(.tdata) + SIZEOF(.tdata); + + PROVIDE( __tdata_start = ADDR(.tdata) ); + PROVIDE( __tdata_size = __tdata_end - __tdata_start ); + PROVIDE( __data_start = ADDR(.data) ); + PROVIDE( __data_size = __data_end - __data_start ); + PROVIDE( __tdata_source = LOADADDR(.tdata) ); + PROVIDE( __tdata_source_end = LOADADDR(.tdata) + SIZEOF(.tdata) ); + PROVIDE( __tdata_source_size = __tdata_source_end - __tdata_source ); + PROVIDE( __data_source = LOADADDR(.data) ); + PROVIDE( __data_source_end = __tdata_source_end ); + PROVIDE( __data_source_size = __data_source_end - __data_source ); + + .noinit (NOLOAD) : + { + . = ALIGN(4); + *(.noinit) + *(.noinit*) + . = ALIGN(4); + } >RAM + + .tbss (NOLOAD) : ALIGN(4) + { + _sbss = .; + __bss_start__ = _sbss; + *(.tbss .tbss.*) + . = ALIGN(4); + PROVIDE( __tbss_end = . ); + } >DTCMRAM + + PROVIDE( __tbss_start = ADDR(.tbss) ); + PROVIDE( __tbss_size = __tbss_end - __tbss_start ); + PROVIDE( __tbss_offset = ADDR(.tbss) - ADDR(.tdata) ); + PROVIDE( __tls_base = __tdata_start ); + PROVIDE( __tls_end = __tbss_end ); + PROVIDE( __tls_size = __tls_end - __tls_base ); + PROVIDE( __tls_align = MAX(ALIGNOF(.tdata), ALIGNOF(.tbss)) ); + PROVIDE( __tls_size_align = (__tls_size + __tls_align - 1) & ~(__tls_align - 1) ); + PROVIDE( __arm32_tls_tcb_offset = MAX(8, __tls_align) ); + PROVIDE( __arm64_tls_tcb_offset = MAX(16, __tls_align) ); + + .bss (NOLOAD) : ALIGN(4) + { + *(.bss) + *(.bss*) + *(COMMON) + . = ALIGN(4); + _ebss = .; + __bss_end__ = _ebss; + PROVIDE( __bss_end = .); + } >DTCMRAM + PROVIDE( __non_tls_bss_start = ADDR(.bss) ); + PROVIDE( __bss_start = __tbss_start ); + PROVIDE( __bss_size = __bss_end - __bss_start ); + + ._user_heap_stack (NOLOAD) : + { + . = ALIGN(8); + PROVIDE ( end = . ); + PROVIDE ( _end = . ); + . = . + _Min_Heap_Size; + . = . + _Min_Stack_Size; + . = ALIGN(8); + } >DTCMRAM + + /DISCARD/ : + { + libc.a:* ( * ) + libm.a:* ( * ) + libgcc.a:* ( * ) + } +} diff --git a/templates/flash_layout/h7_qspi_xip.ld.in b/templates/flash_layout/h7_qspi_xip.ld.in new file mode 100644 index 0000000..d0f902b --- /dev/null +++ b/templates/flash_layout/h7_qspi_xip.ld.in @@ -0,0 +1,229 @@ +/* + * icbsp:外置 QSPI Flash 方案 B(QSPI_XIP)—— 程序在 QSPI 上就地执行(内存映射,0x90000000) + * + * 由 cmake/icbsp_flash.cmake 从 templates/flash_layout/h7_qspi_xip.ld.in 生成到构建目录,不要手改生成结果。 + * 适用:STM32H742/H743/H750/H753(QUADSPI 内存映射窗口 0x90000000)。 + * + * 规则: + * - 0x90000000 起 1 KB 是镜像头(.icbsp_image_header),由 tools/qspi_image.py 在构建后填入长度和 CRC; + * 程序(向量表在最前)从 0x90000400 开始。 + * - 代码 / 常量 / 初值都在 QSPI;.data / .bss / 堆栈放 DTCM,.dma_buffer、.noinit 放 AXI SRAM。 + * - 应用不能再初始化 QUADSPI(quadspi.c 的 USER CODE 里按 ICBSP_FLASH_LAYOUT_QSPI_XIP 提前返回), + * MPU 必须放开 0x90000000 起的芯片容量(.ioc 的 MPU Region1,integrate.py --fix-ioc 处理)。 + * - RAM_D3 末尾 32 字节留给 bootloader 的状态字(ICBSP_BOOT_STATUS_ADDR)。 + */ + +ENTRY(Reset_Handler) + +MEMORY +{ + DTCMRAM (xrw) : ORIGIN = 0x20000000, LENGTH = 128K + RAM (xrw) : ORIGIN = 0x24000000, LENGTH = @ICBSP_AXI_SRAM_SIZE@ + RAM_D2 (xrw) : ORIGIN = 0x30000000, LENGTH = 288K + RAM_D3 (xrw) : ORIGIN = 0x38000000, LENGTH = 64K - 32 + ITCMRAM (xrw) : ORIGIN = 0x00000000, LENGTH = 64K + QSPI (rx) : ORIGIN = 0x90000000, LENGTH = @ICBSP_QSPI_SIZE@ +} + +_estack = ORIGIN(DTCMRAM) + LENGTH(DTCMRAM); +_sstack = _estack - _Min_Stack_Size; +_Min_Heap_Size = @ICBSP_MIN_HEAP_SIZE@; +_Min_Stack_Size = @ICBSP_MIN_STACK_SIZE@; + +SECTIONS +{ + /* 镜像头:内容占位,构建后由 tools/qspi_image.py 改写(长度、CRC) */ + .icbsp_image_header : + { + LONG(0x49424349) /* magic 'ICBI' */ + LONG(1) /* version */ + LONG(2) /* layout = QSPI_XIP */ + LONG(ORIGIN(QSPI) + 0x400) /* load_addr */ + LONG(ORIGIN(QSPI) + 0x400) /* vector_addr */ + LONG(0xFFFFFFFF) /* size(构建后填) */ + LONG(0xFFFFFFFF) /* payload_crc(构建后填) */ + LONG(0xFFFFFFFF) /* header_crc(构建后填) */ + . = 0x400; + } >QSPI =0xFF + + .isr_vector : + { + . = ALIGN(4); + KEEP(*(.isr_vector)) + . = ALIGN(4); + } >QSPI + + .text : + { + . = ALIGN(4); + *(.text) + *(.text*) + *(.glue_7) + *(.glue_7t) + *(.eh_frame) + KEEP (*(.init)) + KEEP (*(.fini)) + . = ALIGN(4); + _etext = .; + } >QSPI + + .rodata : + { + . = ALIGN(4); + *(.rodata) + *(.rodata*) + . = ALIGN(4); + } >QSPI + + .ARM.extab (READONLY) : + { + . = ALIGN(4); + *(.ARM.extab* .gnu.linkonce.armextab.*) + . = ALIGN(4); + } >QSPI + + .ARM (READONLY) : + { + . = ALIGN(4); + __exidx_start = .; + *(.ARM.exidx*) + __exidx_end = .; + . = ALIGN(4); + } >QSPI + + .preinit_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__preinit_array_start = .); + KEEP (*(.preinit_array*)) + PROVIDE_HIDDEN (__preinit_array_end = .); + . = ALIGN(4); + } >QSPI + + .init_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__init_array_start = .); + KEEP (*(SORT(.init_array.*))) + KEEP (*(.init_array*)) + PROVIDE_HIDDEN (__init_array_end = .); + . = ALIGN(4); + } >QSPI + + .fini_array (READONLY) : + { + . = ALIGN(4); + PROVIDE_HIDDEN (__fini_array_start = .); + KEEP (*(SORT(.fini_array.*))) + KEEP (*(.fini_array*)) + PROVIDE_HIDDEN (__fini_array_end = .); + . = ALIGN(4); + } >QSPI + + /* icbsp:见 templates/linker_sections.ld(运行在 AXI SRAM,初值放 QSPI) */ + .dma_buffer : + { + . = ALIGN(32); + __dma_buffer_start = .; + *(.dma_buffer) + *(.dma_buffer*) + . = ALIGN(32); + __dma_buffer_end = .; + } >RAM AT> QSPI + __dma_buffer_load = LOADADDR(.dma_buffer) + (__dma_buffer_start - ADDR(.dma_buffer)); /* 段内 ALIGN(32) 会让起点后移,加载地址同样偏移 */ + + _sidata = LOADADDR(.data); + + .data : + { + . = ALIGN(4); + _sdata = .; + *(.data) + *(.data*) + *(.RamFunc) /* 与 CubeMX 默认一致:随 .data 拷进 RAM */ + *(.RamFunc*) + . = ALIGN(4); + } >DTCMRAM AT> QSPI + + .tdata : ALIGN(4) + { + *(.tdata .tdata.* .gnu.linkonce.td.*) + . = ALIGN(4); + _edata = .; + PROVIDE(__data_end = .); + PROVIDE(__tdata_end = .); + } >DTCMRAM AT> QSPI + + /* 载荷到此为止:后面只能是 NOLOAD 段 */ + __icbsp_image_end = LOADADDR(.tdata) + SIZEOF(.tdata); + + PROVIDE( __tdata_start = ADDR(.tdata) ); + PROVIDE( __tdata_size = __tdata_end - __tdata_start ); + PROVIDE( __data_start = ADDR(.data) ); + PROVIDE( __data_size = __data_end - __data_start ); + PROVIDE( __tdata_source = LOADADDR(.tdata) ); + PROVIDE( __tdata_source_end = LOADADDR(.tdata) + SIZEOF(.tdata) ); + PROVIDE( __tdata_source_size = __tdata_source_end - __tdata_source ); + PROVIDE( __data_source = LOADADDR(.data) ); + PROVIDE( __data_source_end = __tdata_source_end ); + PROVIDE( __data_source_size = __data_source_end - __data_source ); + + .noinit (NOLOAD) : + { + . = ALIGN(4); + *(.noinit) + *(.noinit*) + . = ALIGN(4); + } >RAM + + .tbss (NOLOAD) : ALIGN(4) + { + _sbss = .; + __bss_start__ = _sbss; + *(.tbss .tbss.*) + . = ALIGN(4); + PROVIDE( __tbss_end = . ); + } >DTCMRAM + + PROVIDE( __tbss_start = ADDR(.tbss) ); + PROVIDE( __tbss_size = __tbss_end - __tbss_start ); + PROVIDE( __tbss_offset = ADDR(.tbss) - ADDR(.tdata) ); + PROVIDE( __tls_base = __tdata_start ); + PROVIDE( __tls_end = __tbss_end ); + PROVIDE( __tls_size = __tls_end - __tls_base ); + PROVIDE( __tls_align = MAX(ALIGNOF(.tdata), ALIGNOF(.tbss)) ); + PROVIDE( __tls_size_align = (__tls_size + __tls_align - 1) & ~(__tls_align - 1) ); + PROVIDE( __arm32_tls_tcb_offset = MAX(8, __tls_align) ); + PROVIDE( __arm64_tls_tcb_offset = MAX(16, __tls_align) ); + + .bss (NOLOAD) : ALIGN(4) + { + *(.bss) + *(.bss*) + *(COMMON) + . = ALIGN(4); + _ebss = .; + __bss_end__ = _ebss; + PROVIDE( __bss_end = .); + } >DTCMRAM + PROVIDE( __non_tls_bss_start = ADDR(.bss) ); + PROVIDE( __bss_start = __tbss_start ); + PROVIDE( __bss_size = __bss_end - __bss_start ); + + ._user_heap_stack (NOLOAD) : + { + . = ALIGN(8); + PROVIDE ( end = . ); + PROVIDE ( _end = . ); + . = . + _Min_Heap_Size; + . = . + _Min_Stack_Size; + . = ALIGN(8); + } >DTCMRAM + + /DISCARD/ : + { + libc.a:* ( * ) + libm.a:* ( * ) + libgcc.a:* ( * ) + } +} diff --git a/templates/gitignore b/templates/gitignore new file mode 100644 index 0000000..e138313 --- /dev/null +++ b/templates/gitignore @@ -0,0 +1,23 @@ +# icbsp:STM32CubeMX(CMake)宿主工程的示例忽略项 +# integrate.py / Web UI 的“复制示例 .gitignore”:宿主没有 .gitignore 时复制本文件;已有时只把缺的行追加到末尾。 + +# 构建产物(CMake 预设的 binaryDir 都在 build/ 下,含 bootloader 与 QSPI 镜像) +build/ +*.su + +# clangd 索引与编译数据库副本 +.cache/ +compile_commands.json + +# Python(integrate.py、Web UI) +__pycache__/ +*.pyc + +# VS Code 调试器的临时文件 +.vscode/.cortex-debug* + +# 烧录 / 调试日志 +Flash/*.log + +# integrate.py --fix-ioc 修改 .ioc 前的备份 +*.ioc.bak-* diff --git a/templates/linker_sections.ld b/templates/linker_sections.ld index b12dfa2..3c60699 100644 --- a/templates/linker_sections.ld +++ b/templates/linker_sections.ld @@ -1,8 +1,8 @@ /* - * stm32_framework 需要的链接段:加进宿主工程的链接脚本(CubeMX 生成的 STM32H7xxxx_FLASH.ld 或 + * icbsp 需要的链接段:加进宿主工程的链接脚本(CubeMX 生成的 STM32H7xxxx_FLASH.ld 或 * STM32F4xxxx_FLASH.ld),放在 SECTIONS { ... } 里、.fini_array 之后、.data 之前即可。 * - * CubeMX 新建工程的链接脚本没有这些段。stm32_framework 的 CMake 在配置阶段检查,缺了直接报错 + * CubeMX 新建工程的链接脚本没有这些段。icbsp 的 CMake 在配置阶段检查,缺了直接报错 * (链接脚本一变就会重新检查)。CubeMX 6.18.1 重新生成时保留已有链接脚本的内容(实测只改了几行行尾), * 其他版本未验证,重新生成后留意配置阶段的检查结果即可。 * @@ -37,7 +37,7 @@ . = ALIGN(32); __dma_buffer_end = .; } >RAM_D1 AT> FLASH - __dma_buffer_load = LOADADDR(.dma_buffer); + __dma_buffer_load = LOADADDR(.dma_buffer) + (__dma_buffer_start - ADDR(.dma_buffer)); /* 段内 ALIGN(32) 会让起点后移,加载地址同样偏移 */ .noinit (NOLOAD) : { diff --git a/templates/user/app/app_main.cpp b/templates/user/app/app_main.cpp index 81eb5ab..cc64d25 100644 --- a/templates/user/app/app_main.cpp +++ b/templates/user/app/app_main.cpp @@ -30,7 +30,7 @@ #include "app_task.hpp" #include "board_cfg.hpp" -#include "system.hpp" +#include "service/system/system.hpp" #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" @@ -58,7 +58,7 @@ extern "C" void app_default_task(void *argument) /** * @brief sys_task 的周期报告:每 5 s 把维护耗时打到调试串口(库本身不打印,见 system_set_report_hook()) - * @note 跑在 sys_task 的栈上;printf 的 vsnprintf 要栈,库任务栈 SYS_TASK_STACK 已按这个留了余量。 + * @note 跑在 sys_task 的栈上;printf 的 vsnprintf 要栈,库任务栈 ICBSP_SYS_TASK_STACK 已按这个留了余量。 */ static void sys_report(const SysTaskStats *stats) { @@ -92,7 +92,7 @@ extern "C" void app_init(void) // 优先级必须低于库任务(CAN / BMI088 / sys 默认是 configMAX_PRIORITIES - 2 / -3 / -4,见 hardware_config.h): // CubeMX 的 osPriorityNormal(24)、osPriorityHigh(40)都可以。 // - // monitor:每秒打印 heap / min / tasks / stack 四个值(实现见 task/demo_task.cpp)。 + // monitor:每 10 s 打印 heap / min / tasks / stack 四个值(实现见 task/demo_task.cpp)。 // 默认不建;栈给 384 字(1.5 KB)而不是 256,因为里面要跑 vsnprintf。 // ICBSP_CHECK(xTaskCreate(monitor_task, "monitor", 384, NULL, tskIDLE_PRIORITY + 3, NULL) == pdPASS); diff --git a/templates/user/app/app_task.hpp b/templates/user/app/app_task.hpp index d5d9ed0..7cd2fff 100644 --- a/templates/user/app/app_task.hpp +++ b/templates/user/app/app_task.hpp @@ -18,7 +18,7 @@ void heartbeat_task(void *argument); /** - * @brief 监视业务:每秒记录 FreeRTOS 堆余量与任务数到内部观察量 + * @brief 监视业务:每 10 s 记录 FreeRTOS 堆余量、任务数与本任务栈余量,并打印一行 * @param argument 未使用(NULL) */ void monitor_task(void *argument); diff --git a/templates/user/app/task/demo_task.cpp b/templates/user/app/task/demo_task.cpp index 18f2c02..732b555 100644 --- a/templates/user/app/task/demo_task.cpp +++ b/templates/user/app/task/demo_task.cpp @@ -1,7 +1,7 @@ #include "app_task.hpp" #include "board_cfg.hpp" // print_uart -#include "system.hpp" +#include "service/system/system.hpp" #include "FreeRTOS.h" // IWYU pragma: keep #include "task.h" @@ -19,7 +19,7 @@ struct UserMonitor }; static volatile uint32_t user_alive_count = 0U; ///< 心跳计数:每秒加一(GDB:print user_alive_count) -static volatile UserMonitor user_monitor = {}; ///< 运行监视结果,每秒刷新 +static volatile UserMonitor user_monitor = {}; ///< 运行监视结果,每 10 s 刷新 /* ==================== */ @@ -27,7 +27,7 @@ static volatile UserMonitor user_monitor = {}; ///< 运行监视结果,每 /** * @note 任务入口先等运行态:初始化失败时 sys_state.wait_running() 让任务自行退出,不会跑在半初始化的系统上。 - * @note 每秒一行,四个数分别是: + * @note heartbeat_task 每 1 s 加一次心跳计数;monitor_task 每 10 s 打印一行,四个数分别是: * heap = 当前 FreeRTOS 堆剩余字节;min = 开机以来最低剩余; * tasks = 当前任务数;stack = 本任务栈最低剩余(字,1 字 = 4 字节)。 * min 接近 0 → 加大 configTOTAL_HEAP_SIZE;stack 接近 0 → 加大本任务栈深。 diff --git a/templates/user/board/board_cfg.cpp b/templates/user/board/board_cfg.cpp index 5012be0..43dd21a 100644 --- a/templates/user/board/board_cfg.cpp +++ b/templates/user/board/board_cfg.cpp @@ -9,48 +9,60 @@ * - 加外设 / 改参数 → `board_cfg.hpp` + `board_instances.hpp` * - 改顺序 / 加设备 → 本文件 * - * 【为什么每行都 configASSERT】 - * `init()` 返回非 OK 说明硬件或参数不对(CubeMX 没生成句柄、DMA 没配、CAN 起不来、 - * 芯片 ID 读不到…)。就地停机后 `fault_record` 会记下**代码行号**, + * 【为什么每行都 ICBSP_CHECK】 + * `init()` 返回非 OK 说明硬件或参数不对(CubeMX 没生成句柄、DMA 没配、实例没写进清单、CAN 起不来、 + * 芯片 ID 读不到…)。`ICBSP_CHECK(x.init() == Status::OK)` 总会求值(不要写进 configASSERT:断言可能被定义成空), + * 失败就地停机,`fault_record` 会记下**代码行号**, * 一眼能看出是哪一路;继续跑下去只会在半初始化的系统上产生更难查的现象。 * 想改成“降级运行”也可以,但那样必须在 sys_state 里记错误: * `if (bsp_uart4.init() != Status::OK) { (void)sys_state.error(Status::IO_ERROR); }` * 这样 `system_start()` 才知道有子系统挂了(它的 waiting 逻辑依赖 sys_state)。 * * 【顺序有讲究(本文件的顺序不能乱)】 - * 1. **DWT 第一个**:sys_task 一开始就靠它算 10 ms 周期耗时 - * 2. CAN / UART / PWM 之间没有依赖,按 `board_cfg.hpp` 的定义顺序写即可 - * 3. **挂在 CAN 上的设备(电机、电调)放最后**: - * - 必须在 CAN `init()` 之后:它们要往 `CanRxNode` / `CanTxNode` 里注册 - * - 必须在 `system_start()` 之前:`can_tx_task` 是按“有没有发送节点”决定建不建的, - * 晚于 `system_start()` 注册的发送节点不会被 this 任务认领 + * 1. 计时基准 `bsp_dwt` 由库在 `system_init()` 里初始化,宿主不用管 + * 2. 总线与外设(CAN / UART / SPI / PWM)之间没有依赖,按 `board_cfg.hpp` 的定义顺序写即可 + * 3. **设备放在它用的总线之后**: + * - CAN 设备(DjiMotor、DmMotor)要往 `CanRxNodeT` / `CanTxNodeT` 里注册,并挂到总线的状态节点下 + * - 串口设备(R9DS、Emm_V5 组)、SPI 设备(BMI088)、PWM 设备(舵机、蜂鸣器)同理,放在各自的外设之后 + * 4. 全部在 `system_start()` 之前:`can_tx_task` 按“有没有发送节点”决定建不建,运行态之后再注册节点会被拒绝 */ #include "board_cfg.hpp" -#include "fault_record.hpp" // ICBSP_CHECK +#include "service/system/fault_record.hpp" // ICBSP_CHECK #include "FreeRTOS.h" // IWYU pragma: keep (configASSERT) +/* ==================== 设备实例(构造不是 constexpr,定义在这里,board_cfg.hpp 里 extern) ==================== */ +// +// + void board_init(void) { // ① 计时基准 `bsp_dwt` 已由 `system_init()` 内部 init(),这里不再重复初始化。 - // ② 总线与外设:失败会停在对应行号,fault_record 里能看到是哪一路。 -#if BSP_CAN_MODULE_ENABLED + // ② 总线与外设、生成的设备:失败会停在对应行号,fault_record 里能看到是哪一路。 + // +#if ICBSP_CAN_MODULE_ENABLED ICBSP_CHECK(bsp_can1.init() == Status::OK); #endif ICBSP_CHECK(bsp_uart1.init() == Status::OK); ICBSP_CHECK(bsp_pwm_buzzer.init() == Status::OK); + // - // ③ 设备层:包装上面已 init 的外设。蜂鸣器只是包了一个 PWM 通道,没有额外 init()。 + // ③ 手写的设备(不由 integrate.py 生成的)写在这里,生成区之外:包装上面已 init 的外设。蜂鸣器只是包了一个 PWM 通道,没有额外 init()。 // - // 这里开始是“挂了 CAN 的设备”的位置,例如(示例,按实际设备打开): - // ICBSP_CHECK(chassis_lf.init() == Status::OK); // DjiMotor - // ICBSP_CHECK(servo_yaw.init() == Status::OK); // DeviceServo - // ICBSP_CHECK(damiao.init() == Status::OK); // DeviceEmmv5Group + // 例如(示例,按实际设备打开): + // ICBSP_CHECK(chassis_lf.init() == Status::OK); // DjiMotor(CAN) + // ICBSP_CHECK(yaw_motor.init() == Status::OK); // DmMotor<...>(CAN,达妙) + // ICBSP_CHECK(servo_yaw.init() == Status::OK); // DeviceServo(PWM 舵机) + // ICBSP_CHECK(stepper.init() == Status::OK); // DeviceEmmv5GroupT<...>(串口,张大头 Emm_V5 步进) // - // 它们必须在 CAN init() 之后、system_start() 之前(原因见文件头第 3 条)。 - // 设备 init() 返回 FULL 通常意味着 CAN 节点名额不够: - // 去 hardware_config.h 加大 CAN_RX_NODE_MAX / CAN_TX_NODE_MAX。 + // 它们必须在所用总线的 init() 之后、system_start() 之前(原因见文件头第 3、4 条)。 + // CAN 设备 init() 返回 FULL 通常意味着节点名额不够: + // 去 hardware_config.h 加大 ICBSP_CAN_RX_NODE_MAX / ICBSP_CAN_TX_NODE_MAX。 } + +/* ==================== 中断转调(生成的设备用到 EXTI 时在这里生成 HAL_GPIO_EXTI_Callback;宿主别处就不要再定义它) ==================== */ +// +// diff --git a/templates/user/board/board_cfg.hpp b/templates/user/board/board_cfg.hpp index b8e5d7b..b45dc85 100644 --- a/templates/user/board/board_cfg.hpp +++ b/templates/user/board/board_cfg.hpp @@ -55,34 +55,38 @@ * 1. CubeMX:开 FDCAN2 的 RX FIFO0 中断,确认经典 CAN 模式,重新生成 * 2. 本文件「外设实例」分节下面加: * inline BspCanT<16, 16> bsp_can2({.hfdcan = &hfdcan2, .name = "CAN2"}); - * 3. `board_instances.hpp` 的 `BSP_CAN_INSTANCES` 里加 `X(bsp_can2)` + * 3. `board_instances.hpp` 的 `ICBSP_CAN_INSTANCES` 里加 `X(bsp_can2)` * 4. `board_cfg.cpp` 的 `board_init()` 里加一行 `ICBSP_CHECK(bsp_can2.init() == Status::OK);` */ #ifndef __BOARD_CFG_HPP__ #define __BOARD_CFG_HPP__ +// 下面三个生成区(includes / peripherals / devices)由 tools/integrate.py 按 .ioc 与接入选择生成,区外的内容不动。 +// 手写工程直接改;改过的生成区再用 integrate.py 生成会被拒绝(先删掉或恢复)。 // CubeMX 生成的句柄头文件:**按实际用到的外设增删**。 -#include "bsp_series.hpp" // IWYU pragma: keep(BSP_SERIES_F4) +// +#include "bsp/bsp_series.hpp" // IWYU pragma: keep(ICBSP_SERIES_F4) #include "main.h" // IWYU pragma: keep #include "tim.h" #include "usart.h" // CAN 句柄头:H7 是 FDCAN,F4 是 bxCAN。 // 没在 CubeMX 里开 CAN 时,连 can.h / fdcan.h 都不会生成,所以整段按模块开关条件化。 -#if BSP_CAN_MODULE_ENABLED -# if BSP_SERIES_F4 +#if ICBSP_CAN_MODULE_ENABLED +# if ICBSP_SERIES_F4 # include "can.h" # else # include "fdcan.h" # endif #endif -#include "bsp_can.hpp" -#include "bsp_dwt.hpp" -#include "bsp_pwm.hpp" -#include "bsp_uart.hpp" -#include "device_buzzer.hpp" +#include "bsp/bsp_can.hpp" +#include "bsp/bsp_dwt.hpp" +#include "bsp/bsp_pwm.hpp" +#include "bsp/bsp_uart.hpp" +#include "device/actuator/device_buzzer.hpp" +// /** @brief 板级初始化:各实例 init(),实现在 board_cfg.cpp */ void board_init(void); @@ -95,13 +99,14 @@ void board_init(void); // 否则每个包含本头文件的 .cpp 都会生成一份构造代码,还会注册 atexit。 // 需要释放资源时显式调 `deinit()`,不要写析构函数。 +// /** * CAN1:一条总线的收发(`BspCanT<收队列帧数, 发队列帧数>`) * * @note 两边的 BspCanT 接口完全一致,只有 Config 字段名不同:H7 写 `.hfdcan = &hfdcan1`,F4 写 `.hcan = &hcan1`。 */ -#if BSP_CAN_MODULE_ENABLED -# if BSP_SERIES_F4 +#if ICBSP_CAN_MODULE_ENABLED +# if ICBSP_SERIES_F4 inline BspCanT<16, 16> bsp_can1( {.hcan = &hcan1, .name = "CAN1"}); ///< CAN1,16 帧收 / 16 帧发 @@ -120,9 +125,9 @@ inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1( .mode = UartDir::TxRx, .baudrate = 115200U}); -#define UART_PRINT_ENABLE 1 +#define ICBSP_UART_PRINT_ENABLE 1 -#if UART_PRINT_ENABLE +#if ICBSP_UART_PRINT_ENABLE # define print_uart(...) bsp_uart1.printf(__VA_ARGS__) #else # define print_uart(...) ((void)0) @@ -131,8 +136,8 @@ inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1( /** * DWT 计时基准:**由库内部初始化** * - * 实例定义在 `stm32-framework/code/service/system.cpp`,与 `system_init()` 里的 `init()` 在同一文件; - * 这里只 `#include "bsp_dwt.hpp"` 后直接调用(如 `bsp_dwt.get_delta_s(&last)`)。 + * 实例定义在 `ICBSP/code/service/system/system.cpp`,与 `system_init()` 里的 `init()` 在同一文件; + * 这里只 `#include "bsp/bsp_dwt.hpp"` 后直接调用(如 `bsp_dwt.get_delta_s(&last)`)。 * 不要在这里再定义实例,也不要再调 `init()`。 */ @@ -148,6 +153,7 @@ inline BspPwm bsp_pwm_buzzer( .timer_clk_hz = 275000000UL, .prescaler = 23U, .period = 1999U}); ///< 蜂鸣器 PWM:TIM12_CH2 +// /* ==================== */ @@ -155,11 +161,13 @@ inline BspPwm bsp_pwm_buzzer( // 设备层:包装外设,提供“按物理量”的接口;不拥有下面的外设实例。 // 顺序要求:设备必须在本文件里外设实例之后定义,并且在 board_init() 里外设 init() 之后 init()。 +// /** * 无源蜂鸣器:包装上面的 PWM 通道 * */ inline DeviceBuzzer buzzer(bsp_pwm_buzzer); +// /* ==================== */ diff --git a/templates/user/board/board_instances.hpp b/templates/user/board/board_instances.hpp index 365ec17..703333c 100644 --- a/templates/user/board/board_instances.hpp +++ b/templates/user/board/board_instances.hpp @@ -10,16 +10,16 @@ * * | 宏 | 谁展开它 | 用来做什么 | * | -------------------- | ------------------------------------------- | -------------------------------- | - * | `BSP_CAN_INSTANCES` | `code/bsp/bsp_can.cpp` | FDCAN 的 HAL 回调按句柄找到实例 | - * | | `code/service/system.cpp` | 判断有没有发送节点、要不要建 can_tx | + * | `ICBSP_CAN_INSTANCES` | `code/bsp/bsp_can.cpp` | FDCAN 的 HAL 回调按句柄找到实例 | + * | | `code/service/system/system.cpp` | 判断有没有发送节点、要不要建 can_tx | * | | `code/tasks/can_rx_task.cpp` | 每条总线轮询取帧并分发 | * | | `code/tasks/can_tx_task.cpp` | 每条总线下发聚合帧 | * | | `code/tasks/sys_task.cpp` | 每条总线的 Bus-Off 恢复 | - * | `BSP_UART_INSTANCES` | `code/bsp/bsp_uart.cpp` | UART 的 HAL 回调按句柄找到实例 | + * | `ICBSP_UART_INSTANCES` | `code/bsp/bsp_uart.cpp` | UART 的 HAL 回调按句柄找到实例 | * | | `code/tasks/sys_task.cpp` | 串口收发补救巡检 | - * | `BSP_SPI_INSTANCES` | `code/bsp/bsp_spi.cpp` | SPI 的 HAL 回调按句柄找到实例 | + * | `ICBSP_SPI_INSTANCES` | `code/bsp/bsp_spi.cpp` | SPI 的 HAL 回调按句柄找到实例 | * - * 做法是编译期展开:`BSP_CAN_INSTANCES(X)` 展开成 `X(bsp_can1) X(bsp_can2)`, + * 做法是编译期展开:`ICBSP_CAN_INSTANCES(X)` 展开成 `X(bsp_can1) X(bsp_can2)`, * 调用方把 `X` 定义成一段代码,于是“对每个实例做同一件事”,中断里也没有间接跳转。 * * **好处**:零运行时开销、不占 RAM;**代价**:本文件与 `board_cfg.hpp` 必须手工保持一致。 @@ -27,15 +27,13 @@ * 【只写名字,不写类型】 * 类型由 `decltype` 从 `board_cfg.hpp` 推出来,所以改 `BspCanT` 的模板参数不用动这里。 * - * 【忘了同步会怎样】(最容易踩的坑) - * 不报错、不告警: - * - CAN / UART / SPI 实例漏写 → HAL 回调里遍历不到它,**数据收不到** - * - UART 实例漏写 → sys_task 不巡检它,卡死后不自愈 - * 表现都是“运行期没反应”,不是“编译失败”。加实例时一定两处一起改。 + * 【忘了同步会怎样】 + * 实例没写进清单、或清单里两个实例绑同一句柄时,该实例的 init() 返回 BAD_ARG, + * board_init() 里的 ICBSP_CHECK 停在那一行(fault_record 记下行号)。加实例时三处一起改。 * * 【加实例的三步(以 CAN2 为例)】 * 1. `board_cfg.hpp`:`inline BspCanT<16, 16> bsp_can2({.hfdcan = &hfdcan2, .name = "CAN2"});` - * 2. 本文件:`BSP_CAN_INSTANCES(X)` 里加一行 `X(bsp_can2)`(续行用反斜杠,**最后一项后面不加逗号**) + * 2. 本文件:`ICBSP_CAN_INSTANCES(X)` 里加一行 `X(bsp_can2)`(续行用反斜杠,**最后一项后面不加逗号**) * 3. `board_cfg.cpp`:`ICBSP_CHECK(bsp_can2.init() == Status::OK);` */ @@ -50,38 +48,30 @@ * 每个名字必须已在 `board_cfg.hpp` 里定义。 * * 两路 CAN 的写法: - * #define BSP_CAN_INSTANCES(X) \ + * #define ICBSP_CAN_INSTANCES(X) \ * X(bsp_can1) \ * X(bsp_can2) * * 注意:**这里列了几个,就要求每个都已 init()**——sys_task 的 Bus-Off 恢复和 * can_rx_task 的分发都会直接访问它们。 + * + * UART 清单:① HAL 的 UART 回调按句柄找到对应实例;② sys_task 每 10 ms 巡检它们的收发健康度。 + * SPI 清单:没有实例时宏体写成空注释,展开后什么都不产生。 + * 三个清单在下面的生成区里(tools/integrate.py 按接入选择生成;手写工程直接改)。 */ -#if BSP_CAN_MODULE_ENABLED -# define BSP_CAN_INSTANCES(X) \ +// +#if ICBSP_CAN_MODULE_ENABLED +# define ICBSP_CAN_INSTANCES(X) \ X(bsp_can1) #else /* 没在 CubeMX 里开 CAN(H7 的 FDCAN / F4 的 bxCAN):没有实例,展开为空 */ -# define BSP_CAN_INSTANCES(X) /* 无 */ +# define ICBSP_CAN_INSTANCES(X) /* 无 */ #endif -/** - * @brief UART 实例列表 - * - * 用途:① HAL 的 UART 回调按句柄找到对应实例;② sys_task 每 10 ms 巡检它们的收发健康度。 - */ -#define BSP_UART_INSTANCES(X) \ +#define ICBSP_UART_INSTANCES(X) \ X(bsp_uart1) -/** - * @brief SPI 实例列表 - * - * 本工程没有 SPI 实例,所以宏体写成空注释,展开后什么都不产生。 - * 打开 SPI 时改成: - * #define BSP_SPI_INSTANCES(X) - * X(bsp_spi2) - * - */ -#define BSP_SPI_INSTANCES(X) /* 无 */ +#define ICBSP_SPI_INSTANCES(X) /* 无 */ +// #endif // __BOARD_INSTANCES_HPP__ diff --git a/templates/user/board/hardware_config.h b/templates/user/board/hardware_config.h index b16f451..49e180a 100644 --- a/templates/user/board/hardware_config.h +++ b/templates/user/board/hardware_config.h @@ -5,11 +5,11 @@ * @details * * 【它是什么】 - * stm32_framework 里**没有**任何“默认值头文件”。库的每一个可调参数都是本文件里的 `#define`, - * 库源码通过 CMake 加的包含路径直接 `#include "hardware_config.h"`。 + * icbsp 里**没有**任何“默认值头文件”。库的每一个可调参数都是本文件里的 `#define`, + * 库源码经 `service/system/config_check.hpp` 包含它(宿主自己的代码可以直接包含本文件)。 * CMake 配置阶段会打印实际用的是哪一份: * - * -- stm32_framework: 使用配置 /…/user/board/hardware_config.h + * -- icbsp: 使用配置 /…/user/board/hardware_config.h * * 所以“改库的行为”= 改本文件的宏,不用改库源码;换板 = 换一份本文件。 * @@ -17,10 +17,13 @@ * ① 功能开关:决定“这段代码编不编译、这些任务建不建”——关掉省 Flash/RAM,但功能就没了 * ② 库任务:优先级与栈深——决定实时性和会不会栈溢出 * ③ 外设参数:队列深度、超时、缓冲区大小——决定吞吐、丢帧与阻塞时长 - * ④ 取值检查:只做编译期断言,不改任何行为 + * + * 【检查在库里】 + * 缺宏、取值范围、开关之间的依赖都由库的 `code/service/system/config_check.hpp` 检查(编译期,不改行为), + * CubeMX 没开对应 HAL 模块时库也会把开关强制置 0——本文件只需要写 `#define`。 * * 【不在这里的两项】 - * 1. 调试打印开关 `UART_PRINT_ENABLE` 与 `print_uart(...)` 定义在 `board_cfg.hpp`: + * 1. 调试打印开关 `ICBSP_UART_PRINT_ENABLE` 与 `print_uart(...)` 定义在 `board_cfg.hpp`: * 它们要绑定具体的串口实例,跟着实例放才不会互相牵连(本文件只放“不依赖实例”的宏)。 * 2. `BspUart::printf()` 的取锁 / 入队等待上限目前是**库内固定值**(各 10 ms,见 * code/bsp/bsp_uart.hpp 的 PRINTF_TIMEOUT_MS),没有做成可调宏——想要可调得先改库。 @@ -29,33 +32,37 @@ #ifndef HARDWARE_CONFIG_H #define HARDWARE_CONFIG_H -#include "FreeRTOS.h" // IWYU pragma: keep(configMAX_PRIORITIES) -#include "bsp_series.hpp" // IWYU pragma: keep(HAL_*_MODULE_ENABLED) -#include "task.h" // IWYU pragma: keep(configMAX_PRIORITIES) +#include "FreeRTOS.h" // IWYU pragma: keep(configMAX_PRIORITIES) +#include "task.h" // IWYU pragma: keep(configMAX_PRIORITIES) /* ==================== ① 功能开关:关掉就不编译对应代码、也不创建对应任务 ==================== */ +/* + * 取 0 或 1。CubeMX 没开对应外设(CAN / UART)时,库会把相关开关强制置 0,这里不用改。 + * 依赖:ICBSP_UART_PATROL_ENABLE 需要 ICBSP_SYS_TASK_ENABLE;DjiMotor 需要 CAN 收发都开,DmMotor 只需要接收路径(不满足时包含头文件直接 #error)。 + * 关掉的后果见下面的说明,汇总见 docs/接入指南.md 4.2。 + */ -/** @brief 系统维护任务 sys_task:CAN Bus-Off 恢复、串口补救、Online 计时 */ -#define SYS_TASK_ENABLE 1 -/** @brief CAN 接收路径:can_rx_task + CanRxNode */ -#define CAN_RX_ENABLE 1 -/** @brief CAN 发送路径:can_tx_task + CanTxNode */ -#define CAN_TX_ENABLE 1 -/** @brief sys_task 里的串口补救巡检 */ -#define UART_PATROL_ENABLE 1 - -/* 宿主没开 CAN(H7 的 FDCAN / F4 的 bxCAN)时强制关闭,避免任务引用不存在的类型 */ -#if !BSP_CAN_MODULE_ENABLED -# undef CAN_RX_ENABLE -# undef CAN_TX_ENABLE -# define CAN_RX_ENABLE 0 -# define CAN_TX_ENABLE 0 -#endif - -#ifndef HAL_UART_MODULE_ENABLED -# undef UART_PATROL_ENABLE -# define UART_PATROL_ENABLE 0 -#endif +/* + * 各开关关掉(0)的后果: + * ICBSP_SYS_TASK_ENABLE 系统维护任务 sys_task(10 ms)。会失去 CAN Bus-Off 自动恢复与发送卡死恢复、串口巡检、Online 掉线计时 + * (is_online() 不再变化)、默认状态树总线层的运行期记错(设备掉线照常记)、`sys_task_stats` 与 + * `system_set_report_hook()` 报告、DWT 绝对时间的回绕跟踪(此时宿主要每隔不到一圈(550 MHz 下 7.8 s) + * 调一次 `bsp_dwt.get_cycles()`,见 bsp_dwt.hpp) + * ICBSP_CAN_RX_ENABLE CAN 接收路径:can_rx_task(1 ms)+ CanRxNodeT。会失去按 ID 分发到接收节点;DjiMotor / DmMotor 不能用 + * (包含头文件 #error);`BspCanT::receive()` 改为直接读原始接收缓冲(同一条总线只允许一个任务读) + * ICBSP_CAN_TX_ENABLE CAN 发送路径:can_tx_task + CanTxNodeT。会失去共帧发送节点(多个设备拼一帧、心跳、指令过期清零); + * DjiMotor 不能用(#error),DmMotor 不受影响(控制帧本来就不走发送节点);只剩 `send()` / `send_latest()` 直接发 + * ICBSP_UART_PATROL_ENABLE sys_task 里的串口巡检。会失去串口接收 / 发送卡死后的自动恢复(DMA 出错、HAL 状态卡住时不再重建收发) + * + * 下面的生成区由 tools/integrate.py 按接入选择生成(手写工程直接改数值即可,但改了以后再用 integrate.py 生成会被拒绝, + * 要先把本区删掉或恢复)。 + */ +// +#define ICBSP_SYS_TASK_ENABLE 1 ///< 系统维护任务 sys_task +#define ICBSP_CAN_RX_ENABLE 1 ///< CAN 接收路径(can_rx_task + 接收节点) +#define ICBSP_CAN_TX_ENABLE 1 ///< CAN 发送路径(can_tx_task + 发送节点) +#define ICBSP_UART_PATROL_ENABLE 1 ///< sys_task 里的串口巡检 +// /* ==================== */ /* ==================== 库任务(system_init() 创建) ==================== */ @@ -66,90 +73,64 @@ * 原来的 tskIDLE_PRIORITY + 6~8 比 osPriorityNormal 还低,按 CubeMX 习惯建的业务任务一忙,CAN 节拍、Bus-Off 恢复、 * 串口巡检、Online 计时、IMU 刷新都会被推迟。 * @note sys_task 每 10 ms 只做几十微秒的维护(CAN 恢复 / 串口巡检 / Online 计时),放得高也不会占住 CPU。 */ -#define SYS_TASK_PRIORITY (configMAX_PRIORITIES - 4) +#define ICBSP_SYS_TASK_PRIORITY (configMAX_PRIORITIES - 4) /** @brief sys_task 栈深(字) */ -#define SYS_TASK_STACK 256 +#define ICBSP_SYS_TASK_STACK 256 /** @brief CAN 收 / 发任务的优先级(默认 configMAX_PRIORITIES - 2):库任务里最高,1 kHz 节拍内必须跑完 */ -#define CAN_TASK_PRIORITY (configMAX_PRIORITIES - 2) +#define ICBSP_CAN_TASK_PRIORITY (configMAX_PRIORITIES - 2) /** @brief CAN 收 / 发任务栈深(字):接收节点回调在 can_rx_task 里同步执行,回调用栈多就加大 */ -#define CAN_TASK_STACK 512 +#define ICBSP_CAN_TASK_STACK 512 /* ==================== */ /* ==================== CAN ==================== */ /** @brief 每路 CAN 的回退缓冲深度(帧):没有接收节点认领的帧放这里,供 BspCanT::receive() 读取; - * 0 = 不建回退缓冲(没人认领的帧只计入 diagnostics.rx_unclaimed,receive() 返回 NOT_SUPPORTED)。CAN_RX_ENABLE = 0 时不用 */ -#define CAN_RX_RETURN_FRAMES 16 + * 0 = 不建回退缓冲(没人认领的帧只计入 diagnostics.rx_unclaimed,receive() 返回 NOT_SUPPORTED)。ICBSP_CAN_RX_ENABLE = 0 时不用 */ +#define ICBSP_CAN_RX_RETURN_FRAMES 16 /** @brief can_rx_task 每 1 ms 每条总线最多分发的帧数(1~64) */ -#define CAN_RX_DISPATCH_PER_TICK 16 -/** @brief 接收节点总数上限(全部总线合计,≤255) */ -#define CAN_RX_NODE_MAX 50 -/** @brief 发送节点总数上限(全部总线合计,≤255) */ -#define CAN_TX_NODE_MAX 50 -/** @brief 控制指令有效期 (ms):发送槽位超过这么久没被 FillData() 刷新就清零(必须大于心跳) */ -#define CAN_CMD_EXPIRE_MS 100 +#define ICBSP_CAN_RX_DISPATCH_PER_TICK 16 +/** @brief 接收节点数上限(1~255):按 BspCanT 类型分别计数——模板参数相同的几条总线(如两路 BspCanT<16, 16>)合计,类型不同的各算各的 */ +#define ICBSP_CAN_RX_NODE_MAX 50 +/** @brief 发送节点数上限(1~255):计数方式同 ICBSP_CAN_RX_NODE_MAX */ +#define ICBSP_CAN_TX_NODE_MAX 50 +/** @brief 控制指令有效期 (ms):发送槽位超过这么久没被 fill_data() 刷新就清零(必须大于心跳) */ +#define ICBSP_CAN_CMD_EXPIRE_MS 100 /** @brief 保底心跳 (ms):发送节点至少这么久整帧发一次 */ -#define CAN_TX_HEARTBEAT_MS 5 +#define ICBSP_CAN_TX_HEARTBEAT_MS 5 /** @brief 共帧槽位凑不齐时最多等多久就发 (ms):有槽位填了新数据、其余槽位这么久还没刷新,也发出去(计入节点的 partial_sends) */ -#define CAN_TX_GATHER_MS 1 +#define ICBSP_CAN_TX_GATHER_MS 1 /** @brief Bus-Off 恢复的重试间隔 (ms),≥ 10(sys_task 每 10 ms 检查一次);每路 CAN 的收发队列深度由 BspCanT 的模板参数决定 */ -#define CAN_BUSOFF_RETRY_MS 100 +#define ICBSP_CAN_BUSOFF_RETRY_MS 100 /* ==================== */ /* ==================== UART ==================== */ -/** @brief BspUart::init() 打开 UART 硬件 FIFO(16 字节);0 = 保持 CubeMX 的设置 - * @note 默认关:开了以后 tx_recover() 中止发送会清掉 TX FIFO 里最多 16 字节(只在卡死恢复路径上)。 - * 要用就自己改成 1;F4 没有硬件 FIFO,本宏在 F4 上恒为 0(有 static_assert 拦)。 */ -#define UART_ENABLE_FIFO 0 +/** @brief BspUartT::init() 打开 UART 硬件 FIFO(16 字节);0 = 保持 CubeMX 的设置 + * @note 默认关:开了以后 tx_recover() 中止发送会清掉 TX FIFO 里最多 16 字节(只在卡死恢复路径上);关着时没有别的损失 + * (收发都走 DMA / IDLE,不依赖硬件 FIFO)。 + * 要用就自己改成 1;F4 没有硬件 FIFO,本宏在 F4 上必须为 0(库里有 static_assert 拦)。 */ +#define ICBSP_UART_ENABLE_FIFO 0 /* 注意:`BspUart::printf()` 的等待上限目前是**库内固定值**(取锁 10 ms / 入队 10 ms, - * 见 code/bsp/bsp_uart.hpp 的 PRINTF_TIMEOUT_MS),没有做成可调宏;调试打印开关 UART_PRINT_ENABLE 也在 + * 见 code/bsp/bsp_uart.hpp 的 PRINTF_TIMEOUT_MS),没有做成可调宏;调试打印开关 ICBSP_UART_PRINT_ENABLE 也在 * board_cfg.hpp(要绑串口实例)。详见文件头“不在这里的两项”。 */ /* ==================== */ /* ==================== SPI ==================== */ /** @brief 每个 BspSpi 实例的 DMA 弹跳缓冲(字节,收发各一份) */ -#define SPI_DMA_BUFFER_SIZE 256 +#define ICBSP_SPI_DMA_BUFFER_SIZE 256 /** @brief BspSpi / BspSpiDevice 传输接口的默认超时 (ms) */ -#define SPI_TRANSFER_TIMEOUT_MS 10 +#define ICBSP_SPI_TRANSFER_TIMEOUT_MS 10 /* ==================== */ /* ==================== BMI088 ==================== */ /** @brief DeviceBmi088 自动刷新任务的优先级(默认 configMAX_PRIORITIES - 3):低于 CAN 收发、高于 sys 与业务任务 */ -#define BMI088_TASK_PRIORITY (configMAX_PRIORITIES - 3) +#define ICBSP_BMI088_TASK_PRIORITY (configMAX_PRIORITIES - 3) /** @brief DeviceBmi088 自动刷新任务栈深(字):含 VQF 姿态解算 */ -#define BMI088_TASK_STACK 512 - -/* ==================== */ -/* ==================== 取值检查 ==================== */ - -#ifdef __cplusplus -static_assert(SYS_TASK_ENABLE == 0 || SYS_TASK_ENABLE == 1, "hardware_config.h: SYS_TASK_ENABLE 取 0 或 1"); -static_assert(CAN_RX_ENABLE == 0 || CAN_RX_ENABLE == 1, "hardware_config.h: CAN_RX_ENABLE 取 0 或 1"); -static_assert(CAN_TX_ENABLE == 0 || CAN_TX_ENABLE == 1, "hardware_config.h: CAN_TX_ENABLE 取 0 或 1"); -static_assert(UART_PATROL_ENABLE == 0 || UART_PATROL_ENABLE == 1, "hardware_config.h: UART_PATROL_ENABLE 取 0 或 1"); -static_assert(SYS_TASK_PRIORITY < configMAX_PRIORITIES, "hardware_config.h: SYS_TASK_PRIORITY 必须小于 configMAX_PRIORITIES"); -static_assert(CAN_TASK_PRIORITY < configMAX_PRIORITIES, "hardware_config.h: CAN_TASK_PRIORITY 必须小于 configMAX_PRIORITIES"); -static_assert(BMI088_TASK_PRIORITY < configMAX_PRIORITIES, "hardware_config.h: BMI088_TASK_PRIORITY 必须小于 configMAX_PRIORITIES"); -static_assert(SYS_TASK_STACK >= 128 && CAN_TASK_STACK >= 128, "hardware_config.h: 库任务栈深至少 128 字"); -static_assert(CAN_RX_RETURN_FRAMES >= 0, "hardware_config.h: CAN_RX_RETURN_FRAMES 不能为负(0 = 不建回退缓冲)"); -static_assert(CAN_RX_DISPATCH_PER_TICK >= 1 && CAN_RX_DISPATCH_PER_TICK <= 64, "hardware_config.h: CAN_RX_DISPATCH_PER_TICK 取 1~64"); -static_assert(CAN_RX_NODE_MAX >= 1 && CAN_RX_NODE_MAX <= 255, "hardware_config.h: CAN_RX_NODE_MAX 取 1~255(计数为 uint8_t)"); -static_assert(CAN_TX_NODE_MAX >= 1 && CAN_TX_NODE_MAX <= 255, "hardware_config.h: CAN_TX_NODE_MAX 取 1~255(计数为 uint8_t)"); -static_assert(CAN_TX_HEARTBEAT_MS >= 1, "hardware_config.h: CAN_TX_HEARTBEAT_MS 至少 1 ms"); -static_assert(CAN_CMD_EXPIRE_MS > CAN_TX_HEARTBEAT_MS, "hardware_config.h: 指令有效期必须长于保底心跳"); -static_assert(CAN_TX_GATHER_MS >= 1 && CAN_TX_GATHER_MS < CAN_TX_HEARTBEAT_MS, "hardware_config.h: CAN_TX_GATHER_MS 取 1 ~ 心跳周期 - 1"); -static_assert(CAN_BUSOFF_RETRY_MS >= 10, "hardware_config.h: CAN_BUSOFF_RETRY_MS 至少 10 ms(sys_task 每 10 ms 检查一次)"); -static_assert(UART_ENABLE_FIFO == 0 || UART_ENABLE_FIFO == 1, "hardware_config.h: UART_ENABLE_FIFO 取 0 或 1"); -static_assert(BSP_UART_HAS_FIFO != 0 || UART_ENABLE_FIFO == 0, "hardware_config.h: 本系列(F4)没有 UART 硬件 FIFO,UART_ENABLE_FIFO 必须为 0"); -static_assert(SPI_DMA_BUFFER_SIZE >= 16 && SPI_DMA_BUFFER_SIZE <= 65535, "hardware_config.h: SPI_DMA_BUFFER_SIZE 取 16~65535"); -static_assert(SPI_TRANSFER_TIMEOUT_MS >= 1, "hardware_config.h: SPI_TRANSFER_TIMEOUT_MS 至少 1 ms"); -static_assert(BMI088_TASK_STACK >= 128, "hardware_config.h: BMI088_TASK_STACK 至少 128 字"); -#endif +#define ICBSP_BMI088_TASK_STACK 512 /* ==================== */ diff --git a/templates/vscode/launch_qspi.json b/templates/vscode/launch_qspi.json new file mode 100644 index 0000000..1f5671d --- /dev/null +++ b/templates/vscode/launch_qspi.json @@ -0,0 +1,66 @@ +{ + // 外置 Flash 方案的调试配置(integrate.py 在打开“外置 Flash”时合并进 .vscode/launch.json)。 + // 第一次用之前先跑一遍 OpenOCD_flash 任务(烧 bootloader;方案 B 还要它把镜像写进 QSPI)。 + "version": "0.2.0", + "configurations": [ + { + // 方案 A:直接下载进 AXI SRAM 运行,不写 Flash;软件断点不限个数 + "cwd": "${workspaceFolder}", + "type": "cortex-debug", + "request": "launch", + "name": "cmsis-dap-debug (QSPI_RAM)", + "servertype": "openocd", + "executable": "build/{{PRESET}}-QspiRam/{{PROJECT}}.elf", + "configFiles": [ + "interface/cmsis-dap.cfg", + "target/{{OPENOCD_TARGET}}" + ], + "overrideLaunchCommands": [ + "monitor reset halt", + "load", + "set $sp = *(unsigned int *)0x24000000", + "set $pc = *(unsigned int *)0x24000004" + ], + "overrideRestartCommands": [ + "monitor reset halt", + "load", + "set $sp = *(unsigned int *)0x24000000", + "set $pc = *(unsigned int *)0x24000004" + ], + "runToEntryPoint": "main", + // SVD: 外设寄存器面板用,与调试器无关;宿主没有 SVD 时 integrate.py 会去掉这两行 + "svdFile": "Flash/{{SVD}}", + "liveWatch": { + "enabled": true, + "samplesPerSecond": 20 + } + }, + { + // 方案 B:GDB 的 load 经 stmqspi 把程序写进 QSPI,复位后由 bootloader 跳转;只能打硬件断点 + "cwd": "${workspaceFolder}", + "type": "cortex-debug", + "request": "launch", + "name": "cmsis-dap-debug (QSPI_XIP)", + "servertype": "openocd", + "executable": "build/{{PRESET}}-QspiXip/{{PROJECT}}.elf", + "configFiles": [ + "Flash/daplink_qspi.cfg" + ], + "overrideLaunchCommands": [ + "monitor reset init", + "load", + "monitor reset halt" + ], + "overrideRestartCommands": [ + "monitor reset halt" + ], + "runToEntryPoint": "main", + // SVD: 同上 + "svdFile": "Flash/{{SVD}}", + "liveWatch": { + "enabled": true, + "samplesPerSecond": 20 + } + } + ] +} diff --git a/templates/vscode/settings.json b/templates/vscode/settings.json index c3a4a8b..241de32 100644 --- a/templates/vscode/settings.json +++ b/templates/vscode/settings.json @@ -9,7 +9,8 @@ // 调试时变量按自然类型显示(寄存器位域不会显示成十进制大数) "cortex-debug.variableUseNaturalFormat": true, "cmake.useCMakePresets": "always", - // 状态栏按钮,对应 tasks.json 里的任务 label + // 状态栏按钮(Task Buttons 插件 spencerwmiles.vscode-task-buttons),对应 tasks.json 里的任务 label; + // 生成 Flash/ 时 integrate.py 再追加烧录按钮(templates/vscode/settings_flash.json) "VsCodeTaskButtons.showCounter": false, "VsCodeTaskButtons.tasks": [ { @@ -26,16 +27,6 @@ "label": "[🗑️ 清理]", "task": "Clean", "tooltip": "仅清理构建产物" - }, - { - "label": "[⚡ DAP烧录]", - "task": "OpenOCD_flash", - "tooltip": "OpenOCD + DAPLink 烧录" - }, - { - "label": "[🔌 JLink烧录]", - "task": "JLink_flash", - "tooltip": "经 OpenOCD 的 jlink 适配器烧录" } ], // 源码用两种注释分区:`// ---------------- 标题 ----------------`(.cpp 多用)和 diff --git a/templates/vscode/settings_flash.json b/templates/vscode/settings_flash.json new file mode 100644 index 0000000..46511ab --- /dev/null +++ b/templates/vscode/settings_flash.json @@ -0,0 +1,15 @@ +{ + // 烧录按钮(Task Buttons 插件),integrate.py 在生成 Flash/ 时合并进宿主 .vscode/settings.json 的 VsCodeTaskButtons.tasks + "VsCodeTaskButtons.tasks": [ + { + "label": "[⚡ DAP烧录]", + "task": "OpenOCD_flash", + "tooltip": "OpenOCD + DAPLink 烧录(外置 Flash 方案:bootloader + QSPI 镜像)" + }, + { + "label": "[🔌 JLink烧录]", + "task": "JLink_flash", + "tooltip": "经 OpenOCD 的 jlink 适配器烧录(只支持片内 Flash)" + } + ] +} diff --git a/templates/vscode/settings_qspi.json b/templates/vscode/settings_qspi.json new file mode 100644 index 0000000..59eaabd --- /dev/null +++ b/templates/vscode/settings_qspi.json @@ -0,0 +1,15 @@ +{ + // 外置 Flash 的按钮(Task Buttons 插件),integrate.py 在同时生成 Flash/、启用外置 Flash 时合并进 VsCodeTaskButtons.tasks + "VsCodeTaskButtons.tasks": [ + { + "label": "[🧠 RAM运行]", + "task": "OpenOCD_ram_run", + "tooltip": "方案 A:编译 -QspiRam 预设并下载进 AXI SRAM 运行,不写 Flash" + }, + { + "label": "[🥾 重烧boot]", + "task": "OpenOCD_flash_boot", + "tooltip": "强制重烧 bootloader,再写 QSPI 镜像" + } + ] +} diff --git a/templates/vscode/tasks.json b/templates/vscode/tasks.json index 155bcca..10410b3 100644 --- a/templates/vscode/tasks.json +++ b/templates/vscode/tasks.json @@ -84,36 +84,6 @@ "panel": "shared", "clear": true } - }, - /* ==================== 烧录 ==================== */ - // 脚本自己递归找 build/ 下的 .elf,不需要 VS Code 传路径 - { - "label": "OpenOCD_flash", - "detail": "OpenOCD + CMSIS-DAP 烧录", - "type": "process", - "command": "${workspaceFolder}/Flash/OpenOCD_flash.sh", - "windows": { - "command": "${workspaceFolder}\\Flash\\OpenOCD_flash.bat" - }, - "options": { - "cwd": "${workspaceFolder}" - }, - "group": "build", - "problemMatcher": [] - }, - { - "label": "JLink_flash", - "detail": "经 OpenOCD 的 jlink 适配器烧录", - "type": "process", - "command": "${workspaceFolder}/Flash/JLink_flash.sh", - "windows": { - "command": "${workspaceFolder}\\Flash\\JLink_flash.bat" - }, - "options": { - "cwd": "${workspaceFolder}" - }, - "group": "build", - "problemMatcher": [] } ] } diff --git a/templates/vscode/tasks_flash.json b/templates/vscode/tasks_flash.json new file mode 100644 index 0000000..64fb28a --- /dev/null +++ b/templates/vscode/tasks_flash.json @@ -0,0 +1,35 @@ +{ + // 烧录任务(integrate.py 在生成 Flash/ 时合并进宿主 .vscode/tasks.json)。 + // 脚本自己递归找 build/ 下的 .elf,并按构建目录的 ICBSP_FLASH_LAYOUT 决定烧法,不需要 VS Code 传路径 + "version": "2.0.0", + "tasks": [ + { + "label": "OpenOCD_flash", + "detail": "OpenOCD + CMSIS-DAP 烧录", + "type": "process", + "command": "${workspaceFolder}/Flash/OpenOCD_flash.sh", + "windows": { + "command": "${workspaceFolder}\\Flash\\OpenOCD_flash.bat" + }, + "options": { + "cwd": "${workspaceFolder}" + }, + "group": "build", + "problemMatcher": [] + }, + { + "label": "JLink_flash", + "detail": "经 OpenOCD 的 jlink 适配器烧录", + "type": "process", + "command": "${workspaceFolder}/Flash/JLink_flash.sh", + "windows": { + "command": "${workspaceFolder}\\Flash\\JLink_flash.bat" + }, + "options": { + "cwd": "${workspaceFolder}" + }, + "group": "build", + "problemMatcher": [] + } + ] +} diff --git a/templates/vscode/tasks_qspi.json b/templates/vscode/tasks_qspi.json new file mode 100644 index 0000000..aa4bff2 --- /dev/null +++ b/templates/vscode/tasks_qspi.json @@ -0,0 +1,35 @@ +{ + // 外置 Flash 的烧录任务(integrate.py 在同时生成 Flash/、启用外置 Flash 时合并进宿主 .vscode/tasks.json) + "version": "2.0.0", + "tasks": [ + { + "label": "OpenOCD_ram_run", + "detail": "方案 A:编译 {{PRESET}}-QspiRam 并直接下载进 AXI SRAM 运行(不写 Flash,掉电即失)", + "type": "shell", + "command": "cmake --build --preset {{PRESET}}-QspiRam && bash Flash/OpenOCD_flash.sh {{PRESET}}-QspiRam --ram", + "windows": { + "command": "cmake --build --preset {{PRESET}}-QspiRam && Flash\\OpenOCD_flash.bat {{PRESET}}-QspiRam --ram" + }, + "options": { + "cwd": "${workspaceFolder}" + }, + "group": "build", + "problemMatcher": [] + }, + { + "label": "OpenOCD_flash_boot", + "detail": "强制重烧 bootloader,再写 QSPI 镜像(默认预设 {{PRESET}})", + "type": "process", + "command": "${workspaceFolder}/Flash/OpenOCD_flash.sh", + "args": ["{{PRESET}}", "--boot"], + "windows": { + "command": "${workspaceFolder}\\Flash\\OpenOCD_flash.bat" + }, + "options": { + "cwd": "${workspaceFolder}" + }, + "group": "build", + "problemMatcher": [] + } + ] +} diff --git a/tests/host/CMakeLists.txt b/tests/host/CMakeLists.txt new file mode 100644 index 0000000..7283997 --- /dev/null +++ b/tests/host/CMakeLists.txt @@ -0,0 +1,26 @@ +# algorithm/ 的主机侧单元测试(阶段 3):不依赖硬件和 RTOS,用主机编译器构建 +# +# cmake -S tests/host -B build/host && cmake --build build/host && ctest --test-dir build/host --output-on-failure +# +# 只编 algorithm/ 里纯计算的源文件(vqf 是第三方代码,不在这里测)。 +cmake_minimum_required(VERSION 3.22) +project(icbsp_host_tests CXX) + +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_EXTENSIONS OFF) + +set(ICBSP_CODE ${CMAKE_CURRENT_SOURCE_DIR}/../../code) + +add_executable(icbsp_host_tests + test_main.cpp + ${ICBSP_CODE}/algorithm/pid.cpp + ${ICBSP_CODE}/algorithm/quaternion.cpp + ${ICBSP_CODE}/algorithm/quaternion_pid.cpp + ${ICBSP_CODE}/algorithm/matrix.cpp +) +target_include_directories(icbsp_host_tests PRIVATE ${ICBSP_CODE}) +target_compile_options(icbsp_host_tests PRIVATE -Wall -Wextra -Wshadow -Werror) + +enable_testing() +add_test(NAME algorithm COMMAND icbsp_host_tests) diff --git a/tests/host/test_main.cpp b/tests/host/test_main.cpp new file mode 100644 index 0000000..fc6f366 --- /dev/null +++ b/tests/host/test_main.cpp @@ -0,0 +1,229 @@ +/** + * @file test_main.cpp + * @brief algorithm/ 的主机侧单元测试(阶段 3):PID(F4、NaN)、四元数(F1、零模长)、Matrix、RLS + * + * @details 不依赖硬件、RTOS 和第三方测试框架:每条判据失败时打印文件 / 行号,进程返回失败条数。 + * 构建与运行见同目录 CMakeLists.txt(`cmake -S tests/host -B build/host && cmake --build build/host && ctest --test-dir build/host`)。 + */ + +#include "algorithm/matrix.hpp" +#include "algorithm/pid.hpp" +#include "algorithm/quaternion.hpp" +#include "algorithm/rls.hpp" + +#include +#include +#include + +namespace +{ +int g_fail = 0; +int g_check = 0; + +#define CHECK(cond) \ + do \ + { \ + ++g_check; \ + if (!(cond)) \ + { \ + ++g_fail; \ + std::printf("FAIL %s:%d %s\n", __FILE__, __LINE__, #cond); \ + } \ + } while (0) + +bool near(double a, double b, double tol) +{ + return std::fabs(a - b) <= tol; +} + +const float NaN = std::numeric_limits::quiet_NaN(); + +/* ==================== PID ==================== */ + +void test_pid_basic() +{ + PID p(PID::Config(2.0f, 0.0f, 0.0f, 100.0f)); + CHECK(near(p.calc(10.0f, 4.0f), 12.0f, 1e-6)); // 纯 P:2 × (10 − 4) + CHECK(near(p.calc(100.0f, 0.0f), 100.0f, 1e-6)); // 输出限幅 + CHECK(near(p.calc(-100.0f, 0.0f), -100.0f, 1e-6)); + const PID::Data d = p.get(); + CHECK(d.target == -100.0f && d.feedback == 0.0f && d.output == -100.0f); +} + +/** @brief F4:i_max = 0 时积分上限跟随 out_max,链式配置与 Config 配置一致 */ +void test_pid_f4() +{ + PID a(PID::Config(0.0f, 1.0f, 0.0f, 50.0f)); // Config 配置,i_max = 0 + PID b{PID::Config()}; + b.ki(1.0f).limit_output(50.0f); // 链式配置 + float oa = 0.0f; + float ob = 0.0f; + for (int i = 0; i < 1000; ++i) + { + oa = a.calc(10.0f, 0.0f); + ob = b.calc(10.0f, 0.0f); + } + CHECK(near(oa, 50.0f, 1e-4)); + CHECK(near(ob, 50.0f, 1e-4)); + // 反向:积分不会因为前面累积过头而迟迟退不下来(已钳位在 out_max) + float back = 0.0f; + for (int i = 0; i < 60; ++i) + { + back = a.calc(-10.0f, 0.0f); + } + CHECK(back < 0.0f); + // 显式 i_max 生效 + PID c(PID::Config(0.0f, 1.0f, 0.0f, 50.0f, 0.0f, 20.0f)); + float oc = 0.0f; + for (int i = 0; i < 1000; ++i) + { + oc = c.calc(10.0f, 0.0f); + } + CHECK(near(oc, 20.0f, 1e-4)); +} + +/** @brief 非有限输入丢弃并计数,输出保持上一次 */ +void test_pid_nan() +{ + PID p(PID::Config(1.0f, 0.1f, 0.0f, 100.0f)); + const float o1 = p.calc(5.0f, 0.0f); + const float o2 = p.calc(NaN, 0.0f); + const float o3 = p.calc(5.0f, NaN); + CHECK(std::isfinite(o2) && std::isfinite(o3)); + CHECK(o2 == o1 && o3 == o1); + CHECK(p.get_nonfinite_count() == 2U); + const float o4 = p.feed_forward(NaN); + CHECK(std::isfinite(o4)); + CHECK(p.get_nonfinite_count() == 3U); + const float o5 = p.calc(5.0f, 0.0f); // 恢复正常输入后继续工作 + CHECK(std::isfinite(o5) && o5 > o1); +} + +/* ==================== 四元数 ==================== */ + +/** @brief F1:默认 / 零模长 / NaN 都退回单位四元数,不产生 NaN */ +void test_quat_f1() +{ + const Quaternion id = Quaternion::identity(); + CHECK(id.w == 1.0 && id.x == 0.0 && id.y == 0.0 && id.z == 0.0); + const Quaternion z = Quaternion::from_array((const double[4]){0.0, 0.0, 0.0, 0.0}).normalized(); + CHECK(z.w == 1.0 && z.x == 0.0); + const Quaternion n = Quaternion::from_array((const double[4]){std::nan(""), 0.0, 0.0, 0.0}).normalized(); + CHECK(n.w == 1.0 && std::isfinite(n.x)); + const Vector3 rv = Quaternion::identity().rotation_vector(); + CHECK(rv.x == 0.0 && rv.y == 0.0 && rv.z == 0.0); + const Quaternion tiny = Quaternion::from_rotation_vector({1e-12, 0.0, 0.0}); // 小角度一阶近似,不除零 + CHECK(std::isfinite(tiny.w) && near(tiny.norm(), 1.0, 1e-9)); +} + +void test_quat_rotation() +{ + // 绕 z 转 90°:x 轴 → y 轴 + const Quaternion q = Quaternion::from_axis_angle({0.0, 0.0, 1.0}, ICBSP_PI / 2.0); + double r[3][3]; + q.to_matrix(r); + CHECK(near(r[0][0], 0.0, 1e-12) && near(r[1][0], 1.0, 1e-12)); + double yaw = 0.0, pitch = 0.0, roll = 0.0; + q.to_euler_zyx(yaw, pitch, roll); + CHECK(near(yaw, ICBSP_PI / 2.0, 1e-9) && near(pitch, 0.0, 1e-9) && near(roll, 0.0, 1e-9)); + // 旋转向量往返 + const Quaternion q2 = Quaternion::from_rotation_vector({0.3, -0.2, 0.5}); + const Vector3 v2 = q2.rotation_vector(); + CHECK(near(v2.x, 0.3, 1e-9) && near(v2.y, -0.2, 1e-9) && near(v2.z, 0.5, 1e-9)); + // q · conj(q) = 单位 + const Quaternion e = q2 * q2.conj(); + CHECK(near(e.w, 1.0, 1e-12) && near(e.x, 0.0, 1e-12)); + // 积分:绕 x 以 1 rad/s 积分 1 s(1000 步)≈ 转 1 rad + Quaternion s = Quaternion::identity(); + for (int i = 0; i < 1000; ++i) + { + s = s.integrate({1.0, 0.0, 0.0}, 0.001); + } + CHECK(near(s.rotation_vector().x, 1.0, 1e-6) && near(s.norm(), 1.0, 1e-12)); + // slerp 端点与中点 + const Quaternion a = Quaternion::identity(); + const Quaternion b = Quaternion::from_axis_angle({0.0, 1.0, 0.0}, 1.0); + CHECK(near(Quaternion::slerp(a, b, 0.0).dot(a), 1.0, 1e-9)); + CHECK(near(Quaternion::slerp(a, b, 1.0).dot(b), 1.0, 1e-9)); + CHECK(near(Quaternion::slerp(a, b, 0.5).rotation_vector().y, 0.5, 1e-9)); +} + +/* ==================== Matrix ==================== */ + +void test_matrix() +{ + const float ad[6] = {1, 2, 3, 4, 5, 6}; + const float bd[6] = {7, 8, 9, 10, 11, 12}; + const auto a = MatrixF32<2, 3>::from_array(ad); + const auto b = MatrixF32<3, 2>::from_array(bd); + const auto c = a * b; // [[58, 64], [139, 154]] + CHECK(c[0][0] == 58.0f && c[0][1] == 64.0f && c[1][0] == 139.0f && c[1][1] == 154.0f); + const auto at = a.transpose(); + CHECK(at[2][0] == 3.0f && at[0][1] == 4.0f); + const float md[9] = {4, 7, 2, 3, 6, 1, 2, 5, 3}; + const auto m = MatrixF32<3, 3>::from_array(md); + MatrixF32<3, 3> inv; + CHECK(m.inverse(inv)); + CHECK((m * inv).approx_equal(MatrixF32<3, 3>::identity(), 1e-4f)); + CHECK(near(m.trace(), 13.0, 1e-6)); + const float sd[9] = {1, 2, 3, 2, 4, 6, 1, 1, 1}; // 奇异 + MatrixF32<3, 3> sinv; + CHECK((!MatrixF32<3, 3>::from_array(sd).inverse(sinv))); + const float vd[3] = {3, 4, 0}; + CHECK(near(MatrixF32<3, 1>::from_array(vd).norm(), 5.0, 1e-6)); +} + +/* ==================== RLS ==================== */ + +void test_rls() +{ + // 辨识 y = 2.5·u − 1.0 + Rls<2, 1> rls(Rls<2, 1>::Config(1.0f, 1000.0f)); + CHECK(rls.init() == Status::OK); + uint32_t seed = 12345U; + for (int i = 0; i < 200; ++i) + { + seed = seed * 1664525U + 1013904223U; + const float u = static_cast(seed >> 8) / 16777216.0f * 4.0f - 2.0f; + const float xd[2] = {u, 1.0f}; + const float yd[1] = {2.5f * u - 1.0f}; + (void)rls.update(MatrixF32<2, 1>::from_array(xd), MatrixF32<1, 1>::from_array(yd)); + } + CHECK(near(rls.omega()[0][0], 2.5, 1e-3)); + CHECK(near(rls.omega()[1][0], -1.0, 1e-3)); + CHECK(rls.get_update_count() == 200U); + // 非有限样本:丢弃、计数、参数不变 + const float a0 = rls.omega()[0][0]; + const float xd[2] = {NaN, 1.0f}; + const float yd[1] = {0.0f}; + CHECK(rls.update(MatrixF32<2, 1>::from_array(xd), MatrixF32<1, 1>::from_array(yd)) == Status::BAD_ARG); + CHECK(rls.get_reject_count() == 1U); + CHECK(rls.omega()[0][0] == a0); + // 参数非法 + Rls<2, 1> bad(Rls<2, 1>::Config(1.5f, 1000.0f)); + CHECK(bad.init() == Status::BAD_ARG); + // 遗忘因子 < 1 且激励不足:tr(P) 被限住,不会溢出 + Rls<2, 1> forget(Rls<2, 1>::Config(0.9f, 10.0f)); + CHECK(forget.init() == Status::OK); + const float zx[2] = {0.0f, 0.0f}; + for (int i = 0; i < 2000; ++i) + { + (void)forget.update(MatrixF32<2, 1>::from_array(zx), MatrixF32<1, 1>::from_array(yd)); + } + CHECK(forget.get_trace_limit_count() > 0U); + CHECK(std::isfinite(forget.omega()[0][0])); +} +} // namespace + +int main() +{ + test_pid_basic(); + test_pid_f4(); + test_pid_nan(); + test_quat_f1(); + test_quat_rotation(); + test_matrix(); + test_rls(); + std::printf("%d checks, %d failed\n", g_check, g_fail); + return g_fail == 0 ? 0 : 1; +} diff --git a/tools/_readme_imgs.py b/tools/_readme_imgs.py index 96d4339..45e2627 100644 --- a/tools/_readme_imgs.py +++ b/tools/_readme_imgs.py @@ -6,7 +6,7 @@ ROOT = Path(__file__).resolve().parent.parent -OLD_TREE = """stm32-framework/ +OLD_TREE = """ICBSP/ ├─ bsp/ CAN、UART、SPI、PWM、GPIO、Key、Encoder、DWT ├─ service/ Status / EventState、Online、CAN 收发节点、fault_record、system ├─ tasks/ sys_task、can_rx_task、can_tx_task @@ -18,7 +18,7 @@ ├─ docs/ 接入指南、常用接口、编码规范、器件手册、历史测试记录 └─ CMakeLists.txt""" -NEW_TREE = """stm32-framework/ +NEW_TREE = """ICBSP/ ├─ code/ 库源码(分层见 docs/code/) │ ├─ bsp/ CAN、UART、SPI、PWM、GPIO、Key、Encoder、DWT │ ├─ service/ Status / EventState、Online、CAN 收发节点、fault_record、system diff --git a/tools/check_layers.py b/tools/check_layers.py new file mode 100644 index 0000000..5849985 --- /dev/null +++ b/tools/check_layers.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python3 +""" +分层检查:code/ 下每个文件只能包含本层或更低层的库头文件。 + + python3 tools/check_layers.py # 有违规时退出码 1 + +层次(低 → 高):algorithm、bsp → service → device → tasks。 +例外:`service/system/status_code.hpp`(纯状态码,不依赖 RTOS / HAL)与 `service/system/config_check.hpp` +(读宿主配置的唯一入口)各层都能包含。 +宿主文件(hardware_config.h、board_instances.hpp)和 HAL / FreeRTOS 头不在检查范围内。 +""" + +import pathlib +import re +import sys + +CODE = pathlib.Path(__file__).resolve().parent.parent / "code" + +# 每层允许包含的库目录 +ALLOWED = { + "algorithm": {"algorithm"}, + "bsp": {"bsp"}, + "service": {"service", "bsp", "algorithm"}, + "device": {"device", "service", "bsp", "algorithm"}, + "tasks": {"tasks", "service", "bsp"}, +} +SHARED = {"service/system/status_code.hpp", "service/system/config_check.hpp"} +INC = re.compile(r'^\s*#\s*include\s+"([^"]+)"', re.M) + + +def main() -> int: + bad = [] + for path in sorted(CODE.rglob("*")): + if path.suffix not in {".hpp", ".cpp", ".h"}: + continue + layer = path.relative_to(CODE).parts[0] + for target in INC.findall(path.read_text(encoding="utf-8")): + top = target.split("/", 1)[0] + if top not in ALLOWED or target in SHARED: + continue # 宿主 / 第三方头文件,或公共状态码 + if top not in ALLOWED[layer]: + bad.append(f"{path.relative_to(CODE)}: {layer}/ 不能包含 {target}") + elif not (CODE / target).is_file(): + bad.append(f"{path.relative_to(CODE)}: 找不到 {target}") + for line in bad: + print(line) + print(f"check_layers: {'OK' if not bad else f'{len(bad)} 处违规'}") + return 1 if bad else 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/tools/draw_diagrams.py b/tools/draw_diagrams.py index ea51797..9364993 100644 --- a/tools/draw_diagrams.py +++ b/tools/draw_diagrams.py @@ -326,67 +326,85 @@ def fig_toolchain(c): def fig_layers(c): left, right = 90, 1000 - rows = [ - ("宿主 app/", ["app_main.cpp(app_init)", "StartDefaultTask", "task/*.cpp"], "host"), - ("宿主 board/", ["board_cfg.hpp", "board_cfg.cpp(board_init)", "board_instances.hpp", "hardware_config.h"], "host"), - ("库 device/", ["dji_motor", "device_motor", "servo", "r9ds", "emmv5_group", "bmi088", "buzzer"], "lib"), - ("库 tasks/", ["sys_task(10 ms)", "can_rx_task(1 ms)", "can_tx_task(按需建)"], "lib"), - ("库 service/", ["system", "status", "online_check", "can_rx_node", "can_tx_node", "fault_record"], "lib"), - ("库 bsp/", ["can", "uart", "spi", "pwm", "gpio", "key", "encoder", "dwt"], "lib"), + # 宿主两行 + host_rows = [ + ("宿主 app/", ["app_main.cpp(app_init)", "app_default_task", "task/*.cpp"], 40), + ("宿主 board/", ["board_cfg.hpp", "board_cfg.cpp(board_init)", "board_instances.hpp", "hardware_config.h"], 160), ] - row_y = [60, 180, 300, 420, 540, 660] - row_h = 92 - - for (title, items, key), y in zip(rows, row_y): - box(c, (left, y, right, y + row_h), FILL[key], LINE[key], width=1.0) - text(c, (left + 92, y + row_h / 2), [title], size=14, bold=True) - chip_row(c, left + 190, y + 22, right - left - 214, row_h - 44, items, key) - - box(c, (left, 782, right, 862), FILL["hal"], LINE["hal"], width=1.0) - text(c, ((left + right) / 2, 822), ["HAL · FreeRTOS · CubeMX 生成的句柄(hfdcan1 / huart1 / htim12 …)"], size=13, fill=SUB) - - box(c, (1040, 300, 1390, 470), FILL["leaf"], LINE["leaf"], width=1.0) - text(c, (1215, 322), ["algorithm/"], size=14, bold=True) - chip_row(c, 1058, 340, 314, 42, ["pid", "quaternion_pid"], "leaf") - chip_row(c, 1058, 396, 314, 42, ["vqf", "matrix", "rls"], "leaf") - - box(c, (1040, 492, 1390, 560), FILL["leaf"], LINE["leaf"], width=1.0) - text(c, (1215, 512), ["protocol/"], size=14, bold=True) - text(c, (1215, 538), ["emmv5_protocol(纯编解码)"], size=12, fill=SUB) - - notes = [ - "app_init() 调 board_init()", - "board_cfg / board_instances(X-macro 清单)", - "device 用 PID / 四元数 / VQF / 帧编解码", - "—", - "任务的在线状态、系统事件组", - "service 收发都走 BspCan", - ] - for i, (y, msg) in enumerate(zip(row_y, notes)): - y_next = row_y[i + 1] if i + 1 < len(row_y) else 782 - if msg != "—": - arrow(c, [(520, y + row_h), (520, y_next)], ARROW) - label(c, (536, (y + row_h + y_next) / 2), msg) - - arrow(c, [(right, 346), (1040, 346)], LINE["leaf"]) - label(c, (1032, 322), "用", LINE["leaf"], anchor="rm") - - box(c, (1040, 660, 1390, 862), FILL["note"], LINE["note"], width=1.0) - text(c, (1215, 686), ["依赖只朝下(上层依赖下层)"], size=13, bold=True, fill=LINE["note"]) + for title, items, y in host_rows: + box(c, (left, y, right, y + 92), FILL["host"], LINE["host"], width=1.0) + text(c, (left + 92, y + 46), [title], size=14, bold=True) + chip_row(c, left + 190, y + 24, right - left - 214, 44, items, "host") + + # device 与 tasks 并列(互不依赖,都在 service 之上) + dy = 290 + box(c, (left, dy, 640, dy + 130), FILL["lib"], LINE["lib"], width=1.0) + text(c, (left + 70, dy + 65), ["库 device/"], size=14, bold=True) + chip_row(c, left + 140, dy + 16, 640 - left - 156, 44, ["dji_motor", "dm_motor", "device_motor", "emmv5_group"], "lib") + chip_row(c, left + 140, dy + 70, 640 - left - 156, 44, ["bmi088", "r9ds", "servo", "buzzer"], "lib") + box(c, (660, dy, right, dy + 130), FILL["lib"], LINE["lib"], width=1.0) + text(c, (830, dy + 22), ["库 tasks/"], size=14, bold=True) + chip_row(c, 676, dy + 44, right - 692, 34, ["sys_task", "can_rx_task", "can_tx_task"], "lib", size=11, gap=6) + text(c, (830, dy + 104), ["10 ms · 1 ms · 有发送节点才建"], size=11, fill=SUB) + + sy = 470 + box(c, (left, sy, right, sy + 130), FILL["lib"], LINE["lib"], width=1.0) + text(c, (left + 70, sy + 65), ["库 service/"], size=14, bold=True) + chip_row(c, left + 140, sy + 16, right - left - 156, 44, ["system/:system", "status(EventState)", "state_tree", "fault_record", "config_check"], "lib") + chip_row(c, left + 140, sy + 70, right - left - 156, 44, ["comm/:can_rx_node", "can_tx_node", "monitor/:online_check", "definition/:motor · imu"], "lib") + + by = 650 + box(c, (left, by, right, by + 92), FILL["lib"], LINE["lib"], width=1.0) + text(c, (left + 70, by + 46), ["库 bsp/"], size=14, bold=True) + chip_row(c, left + 140, by + 24, right - left - 156, 44, ["can", "uart", "spi", "pwm", "gpio", "key", "encoder", "dwt", "dma_buffer", "series"], "lib", size=11, gap=6) + + box(c, (left, 782, right, 852), FILL["hal"], LINE["hal"], width=1.0) + text(c, ((left + right) / 2, 817), ["HAL(按 HAL_*_MODULE_ENABLED 条件编译)· FreeRTOS · CubeMX 生成的句柄"], size=13, fill=SUB) + + # 层间箭头 + arrow(c, [(365, 132), (365, 160)], ARROW) + label(c, (380, 146), "app_init() 调 board_init()", size=11) + arrow(c, [(365, 252), (365, dy)], ARROW) + label(c, (380, 271), "设备实例在 board_cfg 构造", size=11) + arrow(c, [(365, dy + 130), (365, sy)], ARROW) + label(c, (380, dy + 150), "注册 CAN 节点 · 挂状态树", size=11) + arrow(c, [(830, dy + 130), (830, sy)], ARROW) + label(c, (845, dy + 150), "巡检 · 分发", size=11) + arrow(c, [(365, sy + 130), (365, by)], ARROW) + label(c, (380, sy + 150), "收发都走 BspCanT / BspUartT / BspSpi", size=11) + arrow(c, [(545, by + 92), (545, 782)], ARROW) + + # X-macro:bsp 与 tasks 反向包含宿主清单 + dash_line(c, [(60, 206), (60, by + 46), (90, by + 46)], LINE["host"], 1.3, 7) + label(c, (66, 452), "X-macro", LINE["host"], size=11) + dash_line(c, [(700, 252), (700, dy)], LINE["host"], 1.3, 7) + label(c, (708, 264), "X-macro", LINE["host"], size=11) + + # algorithm:叶子层,device / service 可用 + box(c, (1040, 290, 1390, 450), FILL["leaf"], LINE["leaf"], width=1.0) + text(c, (1215, 314), ["algorithm/(只依赖 C++ 标准库)"], size=13, bold=True) + chip_row(c, 1058, 338, 314, 42, ["pid", "quaternion_pid", "quaternion"], "leaf") + chip_row(c, 1058, 392, 314, 42, ["vqf", "matrix", "rls"], "leaf") + arrow(c, [(640, 300), (650, 300), (650, 280), (1215, 280), (1215, 290)], LINE["leaf"]) + label(c, (1060, 268), "device 用", LINE["leaf"]) + arrow(c, [(right, 535), (1215, 535), (1215, 450)], LINE["leaf"]) + label(c, (1228, 500), "service 用", LINE["leaf"]) + + box(c, (1040, 580, 1390, 852), FILL["note"], LINE["note"], width=1.0) + text(c, (1215, 606), ["依赖只朝下(tools/check_layers.py 检查)"], size=13, bold=True, fill=LINE["note"]) for i, line in enumerate( [ - "跨层依赖:", - "app → service(system_init / start)", - "board → bsp(实例在 board_cfg 构造)", - "device → bsp(初始化 / 收发)", - "device → service(注册 CanRx / CanTx 节点)", - "tasks → bsp(巡检 / Bus-Off 恢复)", + "algorithm、bsp:只用本层", + "service:+ bsp、algorithm", + "device:+ service、bsp、algorithm", + "tasks:+ service、bsp(不用 device)", + "各层都能包含:status_code.hpp、", + " config_check.hpp(读宿主配置的入口)", + "反向只有 X-macro:bsp / tasks 包含", + " 宿主 board_instances.hpp", ] ): - c.text(1058, 718 + i * 21, line, 11, False, SUB, "la") - - dash_line(c, [(60, 226), (60, 706), (90, 706)], LINE["host"], 1.3, 7) - label(c, (68, 452), "X-macro", LINE["host"], size=11) + c.text(1058, 640 + i * 25, line, 11, False, SUB, "la") # ==================== 图3:启动顺序与任务 ==================== @@ -412,7 +430,7 @@ def fig_startup(c): for y, msg in [ (296, "调度器还没启动:这里只是「创建」sys_task 与 can_rx_task,它们要等 vTaskStartScheduler() 才跑"), - (416, "任何一路 init() 返回非 OK 就 configASSERT 停机,fault_record 记下调用行号,print_uart 能打出来"), + (416, "每个 init() 一行 ICBSP_CHECK(x.init() == Status::OK):失败写 fault_record(.noinit)后停机,复位后 print fault_record 看"), (536, "板级没有发送节点就不建 can_tx;随后置运行位,唤醒所有在 wait_running() 上等待的任务"), ]: box(c, (560, y, 1330, y + ch), FILL["note"], LINE["note"], width=1.0) @@ -422,9 +440,9 @@ def fig_startup(c): tw, gap, ty = 380, 40, 872 for i, (name, lines) in enumerate( [ - ("sys_task", ["10 ms 周期 · DWT 计时", "CAN Bus-Off 恢复 · UART 巡检", "Online::update() · 每 2 s 打印"]), + ("sys_task", ["10 ms 周期 · Online::update() · 状态树巡检", "CAN Bus-Off 恢复 · UART 巡检", "耗时统计 · 报告回调(库不打印)"]), ("can_rx_task", ["1 ms 周期", "按 ID 分发", "未认领的进回退缓冲"]), - ("can_tx_task", ["槽位聚合 · 保底心跳", "100 ms 指令有效期", "没有发送节点就不创建"]), + ("can_tx_task", ["槽位聚合 · 保底心跳 5 ms", "指令有效期 100 ms", "没有发送节点就不创建"]), ] ): x = 100 + i * (tw + gap) @@ -438,14 +456,16 @@ def fig_startup(c): arrow(c, [(rail_b, 580), (rail_b, 838), (1035, 838), (1035, ty)], LINE["int"], dashed=True) label(c, (700, 846), "③ system_start 有节点才创建 can_tx_task", LINE["int"], size=11, anchor="la") - label(c, (100, 852), "优先级 / 栈深在宿主 hardware_config.h:CAN_TASK_PRIORITY 最高", SUB, size=11, anchor="la") + box(c, (560, 656, 1330, 744), FILL["note"], LINE["note"], width=1.0) + c.text(584, 686, "库任务优先级在宿主 hardware_config.h,按 configMAX_PRIORITIES 取:", 12, False, SUB, "lm") + c.text(584, 716, "CAN −2 > BMI088 −3 > sys −4;业务任务要低于它们(osPriorityNormal 即可)", 12, False, SUB, "lm") # ==================== 入口 ==================== FIGURES = [ ("toolchain", 1480, 1250, fig_toolchain), - ("layers", 1440, 940, fig_layers), + ("layers", 1440, 890, fig_layers), ("startup", 1400, 1010, fig_startup), ] diff --git a/tools/icbsp_tool/__init__.py b/tools/icbsp_tool/__init__.py new file mode 100644 index 0000000..45728cc --- /dev/null +++ b/tools/icbsp_tool/__init__.py @@ -0,0 +1 @@ +"""ICBSP 接入引擎的模块(integrate.py 用):清单、.ioc 解析与校验、生成、生成区同步、CubeMX 调用。""" diff --git a/tools/icbsp_tool/checks.py b/tools/icbsp_tool/checks.py new file mode 100644 index 0000000..41bcf56 --- /dev/null +++ b/tools/icbsp_tool/checks.py @@ -0,0 +1,284 @@ +""" +.ioc 校验:按 tools/manifest.json 的规则(级别、标题、修改方法)逐条判断,能自动修改的给出要改的 .ioc 键值。 + +规则分两类:全局规则(FreeRTOS、工具链、时基、D-Cache)对整个工程判断;外设规则只对用户选中的实例判断 +(选中的实例由 generate.py 的选择决定,没给时按 default_selection())。 + +每条结果是一个 dict: + id / level / title / target(如 "FDCAN2",全局规则为 "")/ ok / detail / fix / auto_fix / + changes:[{"key", "old", "new"}]——修复要写进 .ioc 的键值(ioc_fix.py 应用;auto_fix 为 False 时为空) +""" + +from . import flash +from .ioc import FDCAN_MSGRAM_WORDS, eval_int, fdcan_words + +NVIC_ON = "true:5:0:false:false:true:true:true:true:true" +BMI088_SPI_MAX_HZ = 10_000_000 # BMI088 数据手册:SPI 最高 10 MHz # CubeMX 打开一个外设中断时写的值(优先级 5) +H7_TIM32 = {2, 5, 23, 24} +F4_TIM32 = {2, 5} + + +def _nvic_on(ioc, irq): + v = ioc.get(f"NVIC.{irq}") + if v is None: + return NVIC_ON + f = v.split(":") + f[0] = "true" + return ":".join(f) + + +def _ip_param(ioc, ip, param, value): + """改 IP 参数时同步 .IPParameters(CubeMX 用它记哪些参数是用户改过的)""" + changes = [(f"{ip}.{param}", value)] + plist = ioc.get(f"{ip}.IPParameters") + names = plist.split(",") if plist else [] + if param not in names: + names.append(param) + changes.append((f"{ip}.IPParameters", ",".join(names))) + return changes + + +class Checker: + def __init__(self, ioc, manifest): + self.ioc = ioc + self.rules = manifest["rules"] + self.results = [] + + def add(self, rid, target, ok, detail="", changes=None): + r = self.rules[rid] + auto = bool(r.get("auto_fix")) and not ok and bool(changes) + self.results.append( + { + "id": rid, + "level": r["level"], + "title": r["title"], + "target": target, + "ok": ok, + "detail": detail, + "fix": r["fix"], + "auto_fix": auto, + "changes": [{"key": k, "old": self.ioc.get(k), "new": v} for k, v in (changes or [])] if auto else [], + } + ) + + # ---------- 全局 ---------- + + def check_global(self): + ioc = self.ioc + rt = ioc.freertos() + self.add("toolchain_cmake", "", ioc.get("ProjectManager.TargetToolchain") == "CMake", + f"当前 {ioc.get('ProjectManager.TargetToolchain')}", [("ProjectManager.TargetToolchain", "CMake")]) + if not rt["enabled"]: + self.add("rtos_cmsis_v2", "", False, "没有启用 FreeRTOS") + return + self.add("rtos_cmsis_v2", "", rt["cmsis_v2"], "" if rt["cmsis_v2"] else "接口不是 CMSIS_V2") + self.add("rtos_tick", "", rt["tick"] == 1000, f"当前 {rt['tick']} Hz", _ip_param(ioc, "FREERTOS", "configTICK_RATE_HZ", "1000")) + self.add("rtos_stack_check", "", rt["stack_check"] == 2, f"当前 {rt['stack_check']}", + _ip_param(ioc, "FREERTOS", "configCHECK_FOR_STACK_OVERFLOW", "2")) + self.add("rtos_malloc_hook", "", rt["malloc_hook"] == 1, f"当前 {rt['malloc_hook']}", + _ip_param(ioc, "FREERTOS", "configUSE_MALLOC_FAILED_HOOK", "1")) + dt = rt["default_task"] + fix = [] + if dt is not None and dt != "As weak": + tasks = [] + for t in rt["tasks_value"].split(";"): + f = t.split(",") + if f and f[0] == "defaultTask" and len(f) >= 5: + f[4] = "As weak" + tasks.append(",".join(f)) + fix = [("FREERTOS.Tasks01", ";".join(tasks))] + self.add("rtos_default_task", "", dt in (None, "As weak"), f"当前 {dt}", fix) + tb = ioc.timebase_tim() + self.add("timebase_tim", "", bool(tb), f"当前 {tb or 'SysTick'}") + if ioc.series == "h7": + dc = ioc.get("CORTEX_M7.CPU_DCache", "Disabled") + self.add("dcache_off", "", dc != "Enabled", f"当前 {dc}", _ip_param(ioc, "CORTEX_M7", "CPU_DCache", "Disabled")) + + # ---------- 外设 ---------- + + def check_can(self, selected): + ioc = self.ioc + cans = [c for c in ioc.can_instances() if c["ip"] in selected] + if ioc.series != "h7": + return # F4 bxCAN 的检查留给 integrate.py 的前提检查(没有 Message RAM / 帧格式) + for c in cans: + ip = c["ip"] + self.add("can_classic", ip, c["frame_format"] == "FDCAN_FRAME_CLASSIC", f"当前 {c['frame_format']}", + _ip_param(ioc, ip, "FrameFormat", "FDCAN_FRAME_CLASSIC")) + fix = [] + if c["rx_fifo0"] == 0: + fix += _ip_param(ioc, ip, "RxFifo0ElmtsNbr", "16") + if c["tx_fifo_queue"] + c["tx_buffers"] == 0: + fix += _ip_param(ioc, ip, "TxFifoQueueElmtsNbr", "16") + self.add("can_fifo", ip, not fix, f"RX FIFO0 = {c['rx_fifo0']},TX = {c['tx_fifo_queue'] + c['tx_buffers']}", fix) + # 关着时仲裁输掉的帧不重发、直接丢(H750 回归宿主实测:两路对发,ID 大的一路丢 45%,驱动计数全为 0) + self.add("can_auto_retx", ip, c["auto_retx"] == "ENABLE", f"当前 {c['auto_retx']}", + _ip_param(ioc, ip, "AutoRetransmission", "ENABLE")) + self.add("can_nvic", ip, c["nvic_it0"], "", [(f"NVIC.{ip}_IT0_IRQn", _nvic_on(ioc, f"{ip}_IT0_IRQn"))]) + self.add("can_std_filters", ip, c["std_filters"] >= 1, f"当前 {c['std_filters']}", _ip_param(ioc, ip, "StdFiltersNbr", "1")) + # Message RAM:所有 FDCAN(不只是选中的)都占 RAM;按“其他规则都修好之后”的元素数算 + allc = ioc.can_instances() + if not allc: + return + spans, overlap, offset, fix = [], [], 0, [] + for c in allc: + if c["rx_fifo0"] == 0: + c = dict(c, rx_fifo0=16) + if c["tx_fifo_queue"] + c["tx_buffers"] == 0: + c = dict(c, tx_fifo_queue=16) + if c["std_filters"] < 1: + c = dict(c, std_filters=1) # 按 can_std_filters 也修好之后算;不修的话只是空出 1 字,不会重叠 + w = fdcan_words(c) + spans.append((c["ip"], c["msgram_offset"], c["msgram_offset"] + w)) + if c["msgram_offset"] != offset: + fix += _ip_param(ioc, c["ip"], "MessageRAMOffset", str(offset)) + offset += w + for i, (a, s0, e0) in enumerate(spans): + for b, s1, e1 in spans[i + 1 :]: + if s0 < e1 and s1 < e0: + overlap.append(f"{a}[{s0},{e0}) 与 {b}[{s1},{e1})") + too_big = max(e for _, _, e in spans) > FDCAN_MSGRAM_WORDS or offset > FDCAN_MSGRAM_WORDS + detail = ";".join(overlap) or "、".join(f"{a}[{s},{e})" for a, s, e in spans) + if too_big: + detail += f";合计超过 {FDCAN_MSGRAM_WORDS} 字,要减少元素数(不能自动修改)" + fix = [] + self.add("can_msgram", "FDCAN", not overlap and not too_big, detail, fix) + + def check_uart(self, selected): + ioc = self.ioc + for u in ioc.uart_instances(): + ip = u["ip"] + if ip not in selected: + continue + mode = selected[ip].get("mode", "dma") + self.add("uart_nvic", ip, u["nvic"], "", [(f"NVIC.{ip}_IRQn", _nvic_on(ioc, f"{ip}_IRQn"))]) + if u["bdma"]: + self.add("uart_bdma", ip, mode != "dma", "LPUART 由 BDMA 服务,访问不到 .dma_buffer(AXI SRAM)") + if mode == "dma": + miss = [d for d, ok in (("RX", u["dma_rx"]), ("TX", u["dma_tx"])) if not ok] + width = [w for w in (u["dma_rx_width"], u["dma_tx_width"]) if w and "BYTE" not in w] + detail = ("没配 " + "、".join(miss) + " DMA" if miss else "") + (";数据宽度不是 Byte" if width else "") + self.add("uart_dma", ip, not miss and not width, detail.strip(";") or "") + + def check_spi(self, selected): + ioc = self.ioc + for s in ioc.spi_instances(): + ip = s["ip"] + if ip not in selected: + continue + ok = s["mode"] == "SPI_MODE_MASTER" and s["direction"] == "SPI_DIRECTION_2LINES" and "HARD" not in (s["nss"] + s["virtual_nss"]) + self.add("spi_master", ip, ok, f"Mode {s['mode']},Direction {s['direction']},NSS {s['nss']}") + # 库按字节收发;H7 的 CubeMX 默认是 4 位帧(.ioc 里不写 DataSize 时),传输会卡在 HAL 的收发循环里(H750 实测) + self.add("spi_8bit", ip, s["data_size"] == "SPI_DATASIZE_8BIT", f"当前 {s['data_size']}", + _ip_param(ioc, ip, "DataSize", "SPI_DATASIZE_8BIT")) + if ioc.series == "h7": + self.add("spi_keep_io", ip, s["keep_io"] == "SPI_MASTER_KEEP_IO_STATE_ENABLE", f"当前 {s['keep_io']}", + _ip_param(ioc, ip, "MasterKeepIOState", "SPI_MASTER_KEEP_IO_STATE_ENABLE")) + if selected[ip].get("use_dma", s["dma_rx"] and s["dma_tx"]): + self.add("spi_nvic", ip, s["nvic"], "", [(f"NVIC.{ip}_IRQn", _nvic_on(ioc, f"{ip}_IRQn"))]) + + def check_encoder(self, selected): + ioc = self.ioc + wide = H7_TIM32 if ioc.series == "h7" else F4_TIM32 + for n in ioc.encoder_timers(): + ip = f"TIM{n}" + if ip not in selected: + continue + want = 0xFFFFFFFF if n in wide else 0xFFFF + have = eval_int(ioc.tim_param(n, "Period", str(0xFFFFFFFF if n in wide else 0xFFFF))) + self.add("encoder_period", ip, have == want, f"当前 {have},要求 {want}", _ip_param(ioc, ip, "Period", str(want))) + + + def check_external_flash(self, ef, manifest): + """外置 Flash 启用时:QUADSPI 参数与芯片一致、引脚速度 Very High(只影响应用自己用 QSPI,bootloader 不读)""" + ioc = self.ioc + if not ef or not ef.get("enabled") or "QUADSPI" not in ioc.ips(): + return + chip = flash.chip_for(manifest, ef.get("chip")) + if chip is None: + return + # 键不存在 = CubeMX 默认值(QUADSPI 的 IP xml) + want = { + "FlashSize": (str(chip["size"].bit_length() - 2), "1"), + "ClockPrescaler": (str(int(ef.get("prescaler", 2))), "255"), + "SampleShifting": ("QSPI_SAMPLE_SHIFTING_HALFCYCLE", "QSPI_SAMPLE_SHIFTING_NONE"), + "ChipSelectHighTime": ("QSPI_CS_HIGH_TIME_6_CYCLE", "QSPI_CS_HIGH_TIME_1_CYCLE"), + } + fix, diff = [], [] + params = (ioc.get("QUADSPI.IPParameters") or "").split(",") + params = [x for x in params if x] + for k, (v, default) in want.items(): + have = ioc.get(f"QUADSPI.{k}", default) + if have != v: + diff.append(f"{k} {have}→{v}") + fix.append((f"QUADSPI.{k}", v)) + if k not in params: + params.append(k) + if fix: + fix.append(("QUADSPI.IPParameters", ",".join(params))) + for p in flash.qspi_signals(ioc): + pin = p["pin"] + if ioc.get(f"{pin}.GPIO_Speed") == "GPIO_SPEED_FREQ_VERY_HIGH": + continue + diff.append(f"{pin} 速度") + fix.append((f"{pin}.GPIO_Speed", "GPIO_SPEED_FREQ_VERY_HIGH")) + names = [x for x in (ioc.get(f"{pin}.GPIOParameters") or "").split(",") if x] + if "GPIO_Speed" not in names: + fix.append((f"{pin}.GPIOParameters", ",".join(names + ["GPIO_Speed"]))) + self.add("qspi_params", "QUADSPI", not diff, ";".join(diff), fix) + + + def check_device_spi_speed(self, devices): + """BMI088 的 SPI 时钟不能超过 10 MHz(数据手册):按 .ioc 的内核时钟 / 预分频算,超了就把预分频改到最小的够用值""" + ioc = self.ioc + spis = {s["ip"]: s for s in ioc.spi_instances()} + for d in devices or []: + if d.get("type") != "bmi088": + continue + ip = (d.get("needs") or {}).get("bus") + s = spis.get(ip) + if s is None: + continue + if not s["kernel_hz"]: + self.add("spi_bmi088_speed", ip, False, ".ioc 里没有这路 SPI 的内核时钟,算不出 SCK;请在 CubeMX 里确认 ≤ 10 MHz") + continue + sck = s["kernel_hz"] / s["prescaler"] + fix = [] + if sck > BMI088_SPI_MAX_HZ: + want = next((p for p in (2, 4, 8, 16, 32, 64, 128, 256) if s["kernel_hz"] / p <= BMI088_SPI_MAX_HZ), 256) + fix = _ip_param(ioc, ip, "BaudRatePrescaler", f"SPI_BAUDRATEPRESCALER_{want}") + self.add("spi_bmi088_speed", ip, sck <= BMI088_SPI_MAX_HZ, + f"内核 {s['kernel_hz'] / 1e6:g} MHz / {s['prescaler']} = {sck / 1e6:g} MHz({d.get('name')})", fix) + + +def usable(ioc): + """各外设实例能不能用作库的实例:{ip: (能用, 原因)}""" + out = {} + for s in ioc.spi_instances(): + if s["mode"] != "SPI_MODE_MASTER": + out[s["ip"]] = (False, "不是主机模式") + elif s["direction"] != "SPI_DIRECTION_2LINES": + out[s["ip"]] = (False, f"不是全双工({s['direction']})") + elif s["bdma"]: + out[s["ip"]] = (True, "SPI6 由 BDMA 服务:只能轮询(use_dma = false)") + else: + out[s["ip"]] = (True, "") + tb = ioc.timebase_tim() + for n, ch in ioc.pwm_channels(): + if f"TIM{n}" == tb: + out[f"TIM{n}_CH{ch}"] = (False, "是 HAL 时基") + return out + + +def run(ioc, manifest, selection, external_flash=None, devices=None): + """selection:{"can": {ip: {...}}, "uart": {...}, "spi": {...}, "encoder": {...}}(只看键); + external_flash:完整选择里的 external_flash(启用时检查 QUADSPI 参数);devices:完整选择里的设备(BMI088 的 SPI 速度)""" + c = Checker(ioc, manifest) + c.check_device_spi_speed(devices) + c.check_external_flash(external_flash, manifest) + c.check_global() + c.check_can(selection.get("can", {})) + c.check_uart(selection.get("uart", {})) + c.check_spi(selection.get("spi", {})) + c.check_encoder(selection.get("encoder", {})) + return c.results diff --git a/tools/icbsp_tool/cubemx.py b/tools/icbsp_tool/cubemx.py new file mode 100644 index 0000000..9026742 --- /dev/null +++ b/tools/icbsp_tool/cubemx.py @@ -0,0 +1,83 @@ +""" +.ioc 自动修改与 CubeMX 无界面重新生成。 + +修改:checks.py 给出的、能自动修改的失败项(changes)逐条写进 .ioc;写前把原文件备份成 <名字>.ioc.bak-<时间>。 +重新生成:用 STM32CubeMX 自带的 Java 跑命令行脚本(DM-MC02 工程上验证过的做法): + + cd && ./jre/bin/java -jar STM32CubeMX -q <脚本> + 脚本:config load <.ioc 的绝对路径> / project generate / exit + +注意:桌面上开着 CubeMX 界面时它会抢锁,命令行会一直等(这里有超时)。生成后看 git status: +CubeMX 可能改链接脚本的几行行尾、把 Drivers/CMSIS/DSP 拷回来(见宿主 CLAUDE.md)。 +""" + +import os +import shutil +import subprocess +import tempfile +import time +from pathlib import Path + +DEFAULT_DIRS = (Path.home() / "STM32CubeMX", Path("/opt/st/stm32cubemx"), Path("C:/Program Files/STMicroelectronics/STM32Cube/STM32CubeMX")) +TIMEOUT_S = 600 + + +def apply_fixes(ioc, results, ids): + """把 results 里 id 在 ids("all" = 全部)中、能自动修改的失败项写进 ioc 对象;返回实际改了的 [(规则, 目标, 键, 旧, 新)]""" + done = [] + for r in results: + if r["ok"] or not r["auto_fix"]: + continue + if ids != "all" and r["id"] not in ids: + continue + for c in r["changes"]: + old, new = ioc.set(c["key"], c["new"]) + done.append((r["id"], r["target"], c["key"], old, new)) + return done + + +def backup(path): + stamp = time.strftime("%Y%m%d-%H%M%S") + dst = path.with_name(f"{path.name}.bak-{stamp}") + shutil.copy2(path, dst) + return dst + + +def find_cubemx(explicit=None): + """返回 (java, jar) 或 None""" + cands = [] + if explicit: + cands.append(Path(explicit)) + if os.environ.get("ICBSP_CUBEMX"): + cands.append(Path(os.environ["ICBSP_CUBEMX"])) + cands += list(DEFAULT_DIRS) + for c in cands: + d = c.parent if c.is_file() else c + jar = d / "STM32CubeMX" + if not jar.is_file(): + jar = d / "STM32CubeMX.exe" + java = d / "jre" / "bin" / ("java.exe" if os.name == "nt" else "java") + if jar.is_file() and java.is_file(): + return java, jar + return None + + +def regenerate(ioc_path, cubemx=None, timeout=TIMEOUT_S): + """无界面重新生成;返回 (成功, 说明, 输出尾部)""" + found = find_cubemx(cubemx) + if found is None: + return False, "找不到 STM32CubeMX(--cubemx 指定目录,或设环境变量 ICBSP_CUBEMX):.ioc 已改好,请用 CubeMX 打开后点 Generate Code", "" + java, jar = found + with tempfile.NamedTemporaryFile("w", suffix=".txt", delete=False, encoding="utf-8") as f: + f.write(f"config load {Path(ioc_path).resolve()}\nproject generate\nexit\n") + script = f.name + try: + p = subprocess.run([str(java), "-jar", str(jar), "-q", script], cwd=str(jar.parent), capture_output=True, text=True, timeout=timeout) + except subprocess.TimeoutExpired: + return False, f"CubeMX {timeout} s 没有结束:桌面上是否开着 CubeMX 界面(会抢锁)?关掉后重试", "" + finally: + os.unlink(script) + tail = "\n".join((p.stdout + p.stderr).splitlines()[-15:]) + if p.returncode != 0: + return False, f"CubeMX 退出码 {p.returncode}", tail + return True, "CubeMX 已重新生成工程(看一下 git status:链接脚本行尾、Drivers/CMSIS/DSP 等)", tail diff --git a/tools/icbsp_tool/flash.py b/tools/icbsp_tool/flash.py new file mode 100644 index 0000000..e53eadf --- /dev/null +++ b/tools/icbsp_tool/flash.py @@ -0,0 +1,312 @@ +""" +外置 QSPI Flash:是否建议启用、引脚 / 芯片参数,以及生成 icbsp_flash_config.h 与 OpenOCD 的 QSPI 初始化脚本。 + +三种程序存放方式(cmake/icbsp_flash.cmake): + INTERNAL 片内 Flash + QSPI_RAM 方案 A:程序存 QSPI,bootloader 拷进 AXI SRAM 运行 + QSPI_XIP 方案 B:程序在 QSPI 上就地执行 + +目前只支持 QUADSPI(H742/H743/H750/H753 等);OCTOSPI(H723/H730/H7B0 等)识别出来但标为暂不支持。 +""" + +import re +import subprocess +from pathlib import Path + +LAYOUTS = ("INTERNAL", "QSPI_RAM", "QSPI_XIP") +H7_AXI_SRAM_SIZE = 512 * 1024 +BOOT_STATUS_ADDR = 0x3800FFE0 +SUGGEST_USAGE = 0.85 # 片内 Flash 占用超过这个比例就建议外置 Flash + +# 料号第 11 位(STM32H750VBT6 的 B)= 片内 Flash 容量 +FLASH_SIZE_CODE = {"8": 64, "B": 128, "Z": 192, "C": 256, "E": 512, "G": 1024, "I": 2048} + +# STM32H7 的 QUADSPI 引脚复用功能号(数据手册 Alternate function 表)。 +# 优先从 CubeMX 生成的 quadspi.c 读(GPIO_AFn_QUADSPI),读不到才用这张表。 +H7_QUADSPI_AF = { + "PB2": 9, "PF10": 9, # CLK + "PB6": 10, "PG6": 10, # BK1_NCS + "PF8": 10, "PC9": 9, "PD11": 9, # BK1_IO0 + "PF9": 10, "PC10": 9, "PD12": 9, # BK1_IO1 + "PF7": 9, "PE2": 9, # BK1_IO2 + "PF6": 9, "PA1": 9, "PD13": 9, # BK1_IO3 + "PC11": 9, # BK2_NCS + "PE7": 10, "PH2": 9, # BK2_IO0 + "PE8": 10, "PH3": 9, # BK2_IO1 + "PE9": 10, "PG9": 9, # BK2_IO2 + "PE10": 10, "PG14": 9, # BK2_IO3 +} +GPIO_BASE = 0x58020000 # GPIOA;每个端口 0x400 +RCC_AHB4ENR = 0x580244E0 +RCC_AHB3ENR = 0x580244D4 +QUADSPI_BASE = 0x52005000 +SIGNAL_ORDER = ("CLK", "NCS", "IO0", "IO1", "IO2", "IO3") + + +def internal_flash_kb(mcu): + """料号推片内 Flash 容量(KB);认不出返回 None""" + m = re.match(r"STM32[A-Z]\d{3}[A-Z0-9]([0-9A-Z])", (mcu or "").upper()) + return FLASH_SIZE_CODE.get(m.group(1)) if m else None + + +def qspi_signals(ioc): + """.ioc 里 QUADSPI 引脚:[{pin, port, num, signal, bank}](signal 为 CLK / NCS / IO0~3)""" + out = [] + for k, v in ioc.values.items(): + if not k.endswith(".Signal") or not v.startswith("QUADSPI_"): + continue + pin = k[: -len(".Signal")] + m = re.fullmatch(r"P([A-K])(\d+)", pin) + if not m: + continue + sig = v[len("QUADSPI_") :] + bank = None + b = re.match(r"BK(\d)_(.+)", sig) + if b: + bank, sig = int(b.group(1)), b.group(2) + out.append({"pin": pin, "port": m.group(1), "num": int(m.group(2)), "signal": sig, "bank": bank}) + out.sort(key=lambda p: SIGNAL_ORDER.index(p["signal"]) if p["signal"] in SIGNAL_ORDER else 99) + return out + + +def af_from_msp(quadspi_c): + """从 CubeMX 生成的 quadspi.c 读每个引脚的复用功能号:{"PB2": 9, ...}""" + if not quadspi_c or not Path(quadspi_c).exists(): + return {} + text = Path(quadspi_c).read_text(encoding="utf-8", errors="replace") + out = {} + blocks = re.findall( + r"GPIO_InitStruct\.Pin\s*=\s*([^;]+);.*?GPIO_InitStruct\.Alternate\s*=\s*GPIO_AF(\d+)_QUADSPI\s*;\s*HAL_GPIO_Init\(GPIO([A-K])", + text, + re.S, + ) + for pins, af, port in blocks: + for n in re.findall(r"GPIO_PIN_(\d+)", pins): + out[f"P{port}{n}"] = int(af) + return out + + +def chip_for(manifest, name): + for c in manifest.get("flash_chips", []): + if c["name"] == name: + return c + return None + + +def chip_by_size(manifest, size_log2): + """按 .ioc 的 QUADSPI.FlashSize(容量 = 2^(n+1))猜芯片""" + for c in manifest.get("flash_chips", []): + if c["size"] == 1 << (size_log2 + 1): + return c + return None + + +NOLOAD_SECTION = re.compile(r"bss|noinit|heap|stack", re.I) + + +def _map_flash_bytes(map_path): + """从 GNU ld 的 .map 统计放进片内 Flash(0x08000000 起)的字节:输出段起始地址或加载地址在 Flash 里的都算。 + 链接溢出时 ld 不产出 ELF,但 .map 仍会写出来,所以溢出时也能估算。""" + text = Path(map_path).read_text(encoding="utf-8", errors="replace") + text = text[text.find("Linker script and memory map") :] + used = 0 + for m in re.finditer(r"^(\.[\w.]+)\s+0x([0-9a-f]+)\s+0x([0-9a-f]+)(?:\s+load address 0x([0-9a-f]+))?", text, re.M): + if NOLOAD_SECTION.search(m.group(1)): + continue # NOLOAD 段在 .map 里也印 load address,但不占 Flash + addr = int(m.group(4) or m.group(2), 16) + if 0x08000000 <= addr < 0x08200000: + used += int(m.group(3), 16) + return used + + +def elf_usage(host, flash_kb): + """宿主 build/ 下最新一次构建的片内 Flash 占用:返回 (比例, 字节, 文件路径) 或 None。 + 优先用最新的 ELF(arm-none-eabi-size);.map 比 ELF 新(上次链接失败)时用 .map。""" + build = Path(host) / "build" + if not build.is_dir() or not flash_kb: + return None + skip = lambda p: "icbsp_boot" in p.parts or "CMakeFiles" in p.parts + elfs = [p for p in build.rglob("*.elf") if not skip(p)] + maps = [p for p in build.rglob("*.map") if not skip(p)] + elf = max(elfs, key=lambda p: p.stat().st_mtime) if elfs else None + mp = max(maps, key=lambda p: p.stat().st_mtime) if maps else None + used, src = 0, None + if mp is not None and (elf is None or mp.stat().st_mtime > elf.stat().st_mtime + 1): + used, src = _map_flash_bytes(mp), mp + elif elf is not None: + try: + r = subprocess.run(["arm-none-eabi-size", "-A", str(elf)], capture_output=True, text=True, timeout=10) + except (OSError, subprocess.TimeoutExpired): + return None + for line in r.stdout.splitlines(): + f = line.split() + if len(f) == 3 and f[1].isdigit() and f[2].isdigit() and 0x08000000 <= int(f[2]) < 0x08200000: + used += int(f[1]) + src = elf + if not used: + return None + return used / (flash_kb * 1024), used, str(src) + + +def analyze(ioc, host=None, manifest=None): + """外置 Flash 分析:是否支持、是否建议、引脚、芯片猜测""" + ips = ioc.ips() + mcu = ioc.mcu + kb = internal_flash_kb(mcu) + res = { + "peripheral": None, + "supported": False, + "suggest": False, + "reasons": [], + "internal_kb": kb, + "bank": None, + "pins": [], + "chip_guess": None, + "usage": None, + "note": "", + } + if ioc.series != "h7": + res["note"] = "外置 Flash 方案只支持 STM32H7" + return res + if "QUADSPI" in ips: + res["peripheral"] = "QUADSPI" + res["supported"] = True + res["reasons"].append(".ioc 启用了 QUADSPI") + pins = qspi_signals(ioc) + res["pins"] = pins + banks = sorted({p["bank"] for p in pins if p["bank"]}) + res["bank"] = banks[0] if len(banks) == 1 else None + if len(banks) > 1: + res["note"] = "QUADSPI 用了两个 Bank(双 Flash 模式):暂不支持" + res["supported"] = False + fs = ioc.get("QUADSPI.FlashSize") + if fs and fs.isdigit() and manifest and int(fs) > 1: + c = chip_by_size(manifest, int(fs)) + res["chip_guess"] = c["name"] if c else None + elif any(ip.startswith("OCTOSPI") for ip in ips): + res["peripheral"] = next(ip for ip in ips if ip.startswith("OCTOSPI")) + res["note"] = f"{res['peripheral']} 外置 Flash 暂不支持(只支持 QUADSPI)" + if kb is not None and kb <= 128: + res["reasons"].append(f"{mcu} 片内 Flash 只有 {kb} KB") + if host: + u = elf_usage(host, kb) + if u: + ratio, used, elf = u + res["usage"] = {"ratio": round(ratio, 3), "bytes": used, "elf": elf} + if ratio >= SUGGEST_USAGE: + res["reasons"].append(f"最近一次构建占片内 Flash {ratio * 100:.0f}%({used // 1024} KB,{Path(elf).name})") + res["suggest"] = res["supported"] and len(res["reasons"]) >= 2 # 有 QUADSPI,且容量小或占用高 + return res + + +# ---------------------------------------------------------------- 生成 + + +def pin_afs(ioc, quadspi_c): + """[(pin, port, num, af, signal)];拿不到复用功能号时抛 ValueError""" + from_msp = af_from_msp(quadspi_c) + out = [] + for p in qspi_signals(ioc): + af = from_msp.get(p["pin"], H7_QUADSPI_AF.get(p["pin"])) + if af is None: + raise ValueError(f"不知道 {p['pin']}(QUADSPI_{p['signal']})的复用功能号") + out.append((p["pin"], p["port"], p["num"], af, p["signal"])) + return out + + +def config_header(chip, bank, pins, prescaler, sample_shift=True, cs_high=6): + """icbsp_flash_config.h 的全文(CMake 用正则读其中的整数宏,只写整数常量)""" + rows = [] + for i, (_pin, port, num, af, sig) in enumerate(pins): + label = sig if sig == "CLK" else f"BK{bank}_{sig}" + cont = " \\" if i < len(pins) - 1 else "" + rows.append((f" X({port}, {num}, {af})".ljust(16) + f"/* {label} */".ljust(14) + cont).rstrip()) + lines = "\n".join(rows) + "\n" + mhz = 240 // (prescaler + 1) + return f"""/** + * @file icbsp_flash_config.h + * @brief icbsp 外置 QSPI Flash 配置(bootloader 与 cmake/icbsp_flash.cmake 共用) + * + * 由 integrate.py / Web UI 的“外置 Flash”生成:引脚取自 .ioc,芯片参数取自 manifest.json 的 flash_chips。 + * CMake 用正则读其中的整数宏,所以这里只能写整数常量(不要写表达式)。重新运行 integrate.py 会覆盖本文件。 + */ +#ifndef ICBSP_FLASH_CONFIG_H +#define ICBSP_FLASH_CONFIG_H + +/* 芯片:{chip['name']}({chip['size'] >> 20} MB) */ +#define ICBSP_QSPI_FLASH_SIZE 0x{chip['size']:08X}u +#define ICBSP_QSPI_ADDR_BYTES {chip['addr_bytes']} +#define ICBSP_QSPI_JEDEC_MANUFACTURER 0x{chip['jedec_manufacturer']:02X}u +#define ICBSP_QSPI_JEDEC_CAPACITY 0x{chip['jedec_capacity']:02X}u + +/* QUADSPI:Bank {bank};时钟 = HCLK3 / (PRESCALER + 1),应用 HCLK3 = 240 MHz 时为 {mhz} MHz(芯片上限 {chip['max_mhz']} MHz) */ +#define ICBSP_QSPI_BANK {bank} +#define ICBSP_QSPI_PRESCALER {prescaler} +#define ICBSP_QSPI_SAMPLE_SHIFT {1 if sample_shift else 0} +#define ICBSP_QSPI_CS_HIGH_CYCLES {cs_high} + +/* 引脚:X(端口, 引脚号, 复用功能号) */ +#define ICBSP_QSPI_PINS(X) \\ +{lines} +/* 片上存储 */ +#define ICBSP_AXI_SRAM_SIZE 0x{H7_AXI_SRAM_SIZE:08X}u +#define ICBSP_BOOT_STATUS_ADDR 0x{BOOT_STATUS_ADDR:08X}u + +#endif +""" + + +def openocd_qspi_init(chip, bank, pins): + """OpenOCD 的 TCL:开时钟、配引脚、QUADSPI 进单线内存映射读(stmqspi 驱动要求),HSI 64 MHz / 2 = 32 MHz""" + out = [ + f"\tmmw 0x{RCC_AHB4ENR:08X} 0x000007FF 0\t\t\t;# RCC_AHB4ENR:GPIOA~K 时钟", + f"\tmmw 0x{RCC_AHB3ENR:08X} 0x00004000 0\t\t\t;# RCC_AHB3ENR:QSPIEN", + "\tsleep 1", + ] + ports = {} + for _pin, port, num, af, _sig in pins: + ports.setdefault(port, []).append((num, af)) + for port, lst in sorted(ports.items()): + base = GPIO_BASE + 0x400 * (ord(port) - ord("A")) + moder_set = moder_clr = ospeed = afrl_set = afrl_clr = afrh_set = afrh_clr = pupd_clr = 0 + for num, af in lst: + moder_set |= 2 << (num * 2) + moder_clr |= 3 << (num * 2) + ospeed |= 3 << (num * 2) + pupd_clr |= 3 << (num * 2) + if num < 8: + afrl_set |= af << (num * 4) + afrl_clr |= 0xF << (num * 4) + else: + afrh_set |= af << ((num - 8) * 4) + afrh_clr |= 0xF << ((num - 8) * 4) + names = ", ".join(f"P{port}{n}:AF{a}" for n, a in lst) + out.append(f"\t# 端口 {port}:{names}") + out.append(f"\tmmw 0x{base:08X} 0x{moder_set:08X} 0x{moder_clr:08X}\t;# MODER") + out.append(f"\tmmw 0x{base + 0x08:08X} 0x{ospeed:08X} 0x00000000\t;# OSPEEDR") + out.append(f"\tmmw 0x{base + 0x0C:08X} 0x00000000 0x{pupd_clr:08X}\t;# PUPDR") + if afrl_clr: + out.append(f"\tmmw 0x{base + 0x20:08X} 0x{afrl_set:08X} 0x{afrl_clr:08X}\t;# AFRL") + if afrh_clr: + out.append(f"\tmmw 0x{base + 0x24:08X} 0x{afrh_set:08X} 0x{afrh_clr:08X}\t;# AFRH") + size_log2 = chip["size"].bit_length() - 1 + cr = (1 << 24) | (3 << 8) | (1 << 4) | ((1 << 7) if bank == 2 else 0) # PRESCALER=1、FTHRES=3、SSHIFT、FSEL + dcr = ((size_log2 - 1) << 16) | (5 << 8) # FSIZE、CSHT=6 个周期 + adsize = chip["addr_bytes"] - 1 + read_cmd = 0x13 if chip["addr_bytes"] == 4 else 0x03 + ccr = (3 << 26) | (1 << 24) | (adsize << 12) | (1 << 10) | (1 << 8) | read_cmd # 单线内存映射读 + out += [ + f"\tmww 0x{QUADSPI_BASE:08X} 0x{cr:08X}\t\t\t;# QUADSPI_CR:PRESCALER=1、FTHRES=3、SSHIFT{'、FSEL=Bank2' if bank == 2 else ''}", + f"\tmww 0x{QUADSPI_BASE + 4:08X} 0x{dcr:08X}\t\t\t;# QUADSPI_DCR:FSIZE={size_log2 - 1}、CSHT=5", + f"\tmww 0x{QUADSPI_BASE + 0x14:08X} 0x{ccr:08X}\t\t\t;# QUADSPI_CCR:单线内存映射读 0x{read_cmd:02X}", + f"\tmmw 0x{QUADSPI_BASE:08X} 0x00000001 0\t\t\t;# QUADSPI_CR:EN=1", + ] + if chip["addr_bytes"] == 4: + out += [ + f"\tmmw 0x{QUADSPI_BASE:08X} 0x00000002 0\t\t\t;# ABORT", + f"\tmww 0x{QUADSPI_BASE + 0x14:08X} 0x000001B7\t\t\t;# 0xB7:进 4 字节地址模式", + "\tsleep 1", + f"\tmmw 0x{QUADSPI_BASE:08X} 0x00000002 0\t\t\t;# ABORT", + f"\tmww 0x{QUADSPI_BASE + 0x14:08X} 0x{ccr:08X}\t\t\t;# 回到内存映射读", + ] + return "\n".join(out) diff --git a/tools/icbsp_tool/generate.py b/tools/icbsp_tool/generate.py new file mode 100644 index 0000000..94311f9 --- /dev/null +++ b/tools/icbsp_tool/generate.py @@ -0,0 +1,243 @@ +""" +按选择生成宿主板级文件里各“生成区”的内容(只算文本,不写盘;写盘见 regions.py / integrate.py)。 + + 文件 生成区 + board_cfg.hpp includes、peripherals、devices + board_instances.hpp instances + board_cfg.cpp devices、init、callbacks + hardware_config.h switches + +片段全部来自 tools/manifest.json。外设按种类(can、uart、spi、pwm、encoder)再按编号排序,设备按选择里的顺序; +init() 先外设、后设备(设备要用已 init 的外设)。 +""" + +import re + +from . import selection as S + +KIND_ORDER = ("can", "uart", "spi", "pwm", "encoder") +HEADER = "// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖" + + +def _lit(v, spec=None): + """参数值 → C++ 字面量(片段里的后缀 U / UL / f 由清单写好)""" + if isinstance(v, bool): + return "true" if v else "false" + t = (spec or {}).get("type") + if t == "float": + x = float(v) + return repr(x) if x != int(x) else f"{int(x)}.0" + if t == "int_list": + return ", ".join(str(int(e)) for e in v) + if t == "int" and (spec or {}).get("hex"): + return f"0x{int(v):02X}" + return str(v) + + +class Generator: + def __init__(self, ioc, manifest, sel): + self.ioc = ioc + self.m = manifest + self.sel = sel + self.series = ioc.series + self.cands = {c["ip"]: c for c in S.candidates(ioc, manifest)} + + # ---------- 外设 ---------- + + def periphs(self): + """选中的外设,按种类与编号排序:[(候选, 参数)]""" + out = [] + for ip, p in self.sel["peripherals"].items(): + if p["enabled"] and ip in self.cands: + out.append((self.cands[ip], p["params"])) + return sorted(out, key=lambda e: (KIND_ORDER.index(e[0]["kind"]), e[0]["n"], e[0]["ch"] or 0)) + + def periph_fmt(self, c, params): + spec = self.m["peripherals"][c["kind"]] + pspec = {p["key"]: p for p in spec["params"]} + f = {k: _lit(v, pspec.get(k)) for k, v in params.items()} + f.update(instance=c["instance"], handle=c["handle"], label=c["label"], n=c["n"], ch=c["ch"], kind=c["ukind"] or "") + dma = False + for k, v in (spec.get("dma_buffer_when") or {}).items(): + dma = params.get(k) == v + f["dma_attr"] = f"ICBSP_DMA_BUFFER({c['instance']}) " if dma and self.series == "h7" else "" + return f + + def instance_of(self, ip): + c = self.cands.get(ip) + return c["instance"] if c else ip + + # ---------- 各生成区 ---------- + + def includes(self): + kinds = [] + for c, _ in self.periphs(): + if c["kind"] not in kinds: + kinds.append(c["kind"]) + per = self.m["peripherals"] + cube = sorted({per[k]["cubemx_header"][self.series] for k in kinds}) + lib = sorted({per[k]["include"] for k in kinds} | {"bsp/bsp_dwt.hpp"} | {self.m["devices"][d["type"]]["include"] for d in self.devices()}) + lines = [HEADER, '#include "bsp/bsp_series.hpp" // IWYU pragma: keep', '#include "main.h" // IWYU pragma: keep(GPIO 标签宏)'] + lines += [f'#include "{h}"' for h in cube] + if any(self.periph_fmt(c, p)["dma_attr"] for c, p in self.periphs()): + lib = sorted(set(lib) | {"bsp/bsp_dma_buffer.hpp"}) + lines += [f'#include "{h}"' for h in lib] + return "\n".join(lines) + + def peripherals(self): + per = self.m["peripherals"] + lines = [HEADER] + for c, params in self.periphs(): + f = self.periph_fmt(c, params) + extra = f"({c['reason']})" if c["reason"] else "" + lines.append(f"/// {c['ip']}:{per[c['kind']]['title']}{extra}") + lines.append(per[c["kind"]]["declare"][self.series].format(**f)) + dbg = self.sel.get("debug_uart") + lines.append("") + if dbg: + lines += [ + f"/// 调试打印串口:{dbg}", + "#define ICBSP_UART_PRINT_ENABLE 1", + f"#define print_uart(...) {self.instance_of(dbg)}.printf(__VA_ARGS__)", + ] + else: + lines += ["/// 没有选调试打印串口", "#define ICBSP_UART_PRINT_ENABLE 0", "#define print_uart(...) ((void)0)"] + return "\n".join(lines) + + def instances(self): + lists = {} + for c, _ in self.periphs(): + macro = self.m["peripherals"][c["kind"]].get("list_macro") + if macro: + lists.setdefault(macro, []).append(c["instance"]) + lines = [HEADER] + for macro in ("ICBSP_CAN_INSTANCES", "ICBSP_UART_INSTANCES", "ICBSP_SPI_INSTANCES"): + names = lists.get(macro, []) + if not names: + lines.append(f"#define {macro}(X) /* 无 */") + continue + lines.append(f"#define {macro}(X) \\") + for i, n in enumerate(names): + lines.append(f" X({n})" + (" \\" if i < len(names) - 1 else "")) + return "\n".join(lines) + + def init(self): + lines = [HEADER] + for c, params in self.periphs(): + f = self.periph_fmt(c, params) + lines += [l.format(**f) for l in self.m["peripherals"][c["kind"]]["init"]] + lines += self.device_init() + return "\n".join(" " + l if l else "" for l in lines) + + def switches(self): + lines = [HEADER] + for sid, sw in self.m["switches"].items(): + lines.append(f"#define {sid} {int(self.sel['switches'].get(sid, sw['default']))} ///< {sw['title']}") + return "\n".join(lines) + + # ---------- 设备 ---------- + + def devices(self): + return [d for d in self.sel.get("devices", []) if self.m["devices"].get(d.get("type"), {}).get("status") != "planned"] + + def device_fmt(self, d): + spec = self.m["devices"][d["type"]] + f = {"name": d["name"]} + for prm in spec["params"]: + v = (d.get("params") or {}).get(prm["key"], prm.get("default")) + f[prm["key"]] = _lit(v, prm) + for need in spec["needs"]: + v = (d.get("needs") or {}).get(need["key"]) + if need["kind"] in ("gpio_out", "gpio_exti"): + f[need["key"]] = v or "" + else: + f[need["key"]] = self.instance_of(v) if v else "" + return f + + def device_init(self): + lines = [] + for d in self.devices(): + f = self.device_fmt(d) + lines += [l.format(**f) for l in self.m["devices"][d["type"]]["init"]] + return lines + + def device_externs(self): + lines = [HEADER] + for d in self.devices(): + spec = self.m["devices"][d["type"]] + f = self.device_fmt(d) + lines.append(f"/// {d['name']}:{spec['title']}") + lines += [l.format(**f) for l in spec["extern"]] + return "\n".join(lines) + + def device_defines(self): + lines = [HEADER] + for d in self.devices(): + spec = self.m["devices"][d["type"]] + f = self.device_fmt(d) + lines.append(f"/// {d['name']}:{spec['title']}") + lines += [l.format(**f) for l in spec["define"]] + return "\n".join(lines) + + def exti_calls(self): + """[(引脚标签, 调用)]""" + out = [] + for d in self.devices(): + f = self.device_fmt(d) + for e in self.m["devices"][d["type"]].get("exti", []): + pin = f.get(e["pin"]) + if pin: + out.append((pin, e["call"].format(**f))) + return out + + def callbacks(self): + calls = self.exti_calls() + lines = [HEADER] + if not calls: + return "\n".join(lines) + lines += [ + "/**", + " * @brief EXTI 回调:库不占用它,生成的设备的数据就绪中断由这里转给设备", + " * @note 宿主别处不要再定义 HAL_GPIO_EXTI_Callback(会重复定义);还要处理别的 EXTI 时,把本区删掉、手写一份。", + " */", + 'extern "C" void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin)', + "{", + " BaseType_t woken = pdFALSE;", + ] + for k, (pin, call) in enumerate(calls): + lines += [f" {'if' if k == 0 else 'else if'} (GPIO_Pin == {pin}_Pin)", " {", f" {call}", " }"] + lines += [" portYIELD_FROM_ISR(woken);", "}"] + return "\n".join(lines) + + def generated_names(self): + """生成区里定义的全部全局名字(外设实例、设备及其附属实例)""" + names = [c["instance"] for c, _ in self.periphs()] + for d in self.devices(): + f = self.device_fmt(d) + for l in self.m["devices"][d["type"]]["extern"]: + m = re.search(r"(\w+)\s*;\s*$", l.format(**f)) + if m: + names.append(m.group(1)) + return names + + def notes(self): + """生成后要提醒用户的事(不进代码)""" + out = [] + for d in self.devices(): + spec = self.m["devices"][d["type"]] + f = self.device_fmt(d) + out += [f"{d['name']}:{n.format(**f)}" for n in spec.get("notes", [])] + if spec["status"] == "compile_only": + out.append(f"{d['name']}:{spec['title']} 只编译验证过,没有实板测试") + return out + + # ---------- 汇总 ---------- + + def regions(self): + """{文件名: {生成区名: 内容}}""" + return { + "board_cfg.hpp": {"includes": self.includes(), "peripherals": self.peripherals(), "devices": self.device_externs()}, + "board_instances.hpp": {"instances": self.instances()}, + "board_cfg.cpp": {"devices": self.device_defines(), "init": self.init(), "callbacks": self.callbacks()}, + "hardware_config.h": {"switches": self.switches()}, + } diff --git a/tools/icbsp_tool/host_options.py b/tools/icbsp_tool/host_options.py new file mode 100644 index 0000000..9eff70b --- /dev/null +++ b/tools/icbsp_tool/host_options.py @@ -0,0 +1,343 @@ +""" +宿主工程级选项:外置 QSPI Flash、编译优化、示例 .gitignore(integrate.py 的计划步骤)。 + +选项存在选择(icbsp_selection.json)的 external_flash / optimization / gitignore 三个键里(见 selection.py)。 +写进宿主的东西: + + 根 CMakeLists.txt 生成区 icbsp-options(# 注释标记,放在 add_subdirectory() 之前): + include(cmake/icbsp_flash.cmake) + icbsp_flash_layout(...)、 + include(cmake/icbsp_options.cmake) + icbsp_optimization(...) + CMakePresets.json RelWithDebInfo,外置 Flash 启用时再加 <类型>-Internal / -QspiRam / -QspiXip + /icbsp_flash_config.h 引脚 / 芯片 / 分频(bootloader 与 CMake 共用;整文件生成) + Core/Src/quadspi.c USER CODE QUADSPI_Init 0:方案 B 时直接返回(程序正在 QSPI 上执行) + Flash/daplink_qspi.cfg OpenOCD 的 QSPI 初始化与 stmqspi bank(整文件生成) + .vscode/launch.json QSPI_RAM / QSPI_XIP 两个调试配置(由 integrate.py 的 JSONC 合并完成) + .gitignore templates/gitignore,已有时只追加缺的行 + +所有函数只往 plan 里登记修改,不直接写盘。 +""" + +import json +import re +from pathlib import Path + +from . import flash +from . import regions as R + +CMAKE_REGION = "icbsp-options" +LAYOUT_SUFFIX = {"INTERNAL": "Internal", "QSPI_RAM": "QspiRam", "QSPI_XIP": "QspiXip"} +QSPI_GUARD = ( + "#if defined(ICBSP_FLASH_LAYOUT_QSPI_XIP)\n" + " /* icbsp 外置 Flash 方案 B:程序正在 QSPI 上执行,bootloader 已配好内存映射,这里不能重新初始化 QUADSPI */\n" + " return;\n" + "#endif\n" +) +GITIGNORE_BEGIN = "# >>> icbsp(integrate.py 追加的示例忽略项)" +GITIGNORE_END = "# <<< icbsp" + + +def _rel(path, host): + return Path(path).relative_to(host).as_posix() + + +def _file(host, plan, text_file_cls, path): + """同一个文件在本次计划里可能已经被别的步骤改过:沿用那份,没有就新读""" + path = Path(path) + if path in plan.edits: + return plan.edits[path] + if path in plan.new_files and isinstance(plan.new_files[path], str): + return None + return text_file_cls(path) if path.exists() else None + + +# ---------------------------------------------------------------- 根 CMakeLists.txt + + +def cmake_region_body(sel, lib_rel, board_rel, manifest): + ef = sel.get("external_flash") or {} + op = sel.get("optimization") or {} + lines = [] + if ef.get("enabled") or op.get("enabled"): + lines.append("# icbsp:外置 Flash 与编译优化(integrate.py 按 " + board_rel + "/icbsp_selection.json 生成,改选择后重跑;") + lines.append("# 切换程序存放方式用预设 <类型>-Internal / -QspiRam / -QspiXip,或 -DICBSP_FLASH_LAYOUT=…,见 docs/接入指南.md)") + if ef.get("enabled"): + lines += [ + f"include({lib_rel}/cmake/icbsp_flash.cmake)", + f"icbsp_flash_layout(TARGET ${{CMAKE_PROJECT_NAME}} DEFAULT {ef.get('layout', 'QSPI_RAM')}", + f" CONFIG ${{CMAKE_CURRENT_SOURCE_DIR}}/{board_rel}/icbsp_flash_config.h)", + ] + if op.get("enabled"): + levels = " ".join(f"{bt} {op[bt]}" for bt in manifest.get("options", {}).get("build_types", []) if op.get(bt)) + vendor = " VENDOR_OS" if op.get("vendor_os") else "" + lines += [ + f"include({lib_rel}/cmake/icbsp_options.cmake)", + f"icbsp_optimization(TARGET ${{CMAKE_PROJECT_NAME}} {levels}{vendor})", + ] + return "\n".join(lines) + + +def plan_cmake_region(host, plan, rep, text_file_cls, sel, lib_rel, board_rel, manifest, overwrite_edited): + step = "CMakeLists.txt" + path = host / "CMakeLists.txt" + tf = _file(host, plan, text_file_cls, path) + if tf is None: + rep.error(step, "读不到根 CMakeLists.txt") + return + body = cmake_region_body(sel, lib_rel, board_rel, manifest) + regs, bad = R.parse(tf.text, "#") + if bad: + rep.error(step, "生成区标记有问题:" + ";".join(bad)) + return + if CMAKE_REGION in regs: + r = regs[CMAKE_REGION] + if r["recorded"] != r["actual"] and not overwrite_edited: + rep.error(step, f"生成区 {CMAKE_REGION} 被手改过:把改动挪到区外(或加 --overwrite-edited 覆盖)") + return + if r["body"] == body: + rep.skip(step, "外置 Flash / 编译优化生成区已是最新") + return + tf.text = R.replace(tf.text, CMAKE_REGION, body, "#") + plan.edit(tf) + rep.ok(step, "更新外置 Flash / 编译优化生成区" if body else "外置 Flash / 编译优化都已关闭:清空生成区") + return + if not body: + return + # 放在 add_subdirectory() 之前(连同它上面那行 icbsp 注释):icbsp_flash_layout 要先换掉 -T, + # 库的链接脚本检查才会检查新脚本 + lines = tf.text.split("\n") + at = next((i for i, l in enumerate(lines) if re.match(r"\s*add_subdirectory\(\s*" + re.escape(lib_rel) + r"\b", l)), None) + if at is None: + rep.error(step, f"根 CMakeLists.txt 里没有 add_subdirectory({lib_rel}),无法放外置 Flash / 编译优化生成区") + return + if at > 0 and lines[at - 1].lstrip().startswith("# icbsp"): + at -= 1 + lines[at:at] = R.block(CMAKE_REGION, body, "#").split("\n") + [""] + tf.text = "\n".join(lines) + plan.edit(tf) + rep.ok(step, f"在 add_subdirectory({lib_rel}) 之前加外置 Flash / 编译优化生成区") + + +# ---------------------------------------------------------------- CMakePresets.json + + +def plan_presets(host, plan, rep, text_file_cls, sel, manifest): + step = "CMakePresets.json" + path = host / "CMakePresets.json" + tf = _file(host, plan, text_file_cls, path) + if tf is None: + rep.warn(step, "没有 CMakePresets.json:跳过预设(切换存放方式用 cmake -DICBSP_FLASH_LAYOUT=…)") + return + try: + data = json.loads(tf.text) + except ValueError as e: + rep.warn(step, f"不是合法 JSON({e}),跳过;请手动加预设") + return + cfg = data.setdefault("configurePresets", []) + bld = data.setdefault("buildPresets", []) + have_cfg = {p.get("name") for p in cfg} + have_bld = {p.get("name") for p in bld} + base = "default" if "default" in have_cfg else None + added = [] + + def add(name, inherits, cache): + if name not in have_cfg: + p = {"name": name, "inherits": inherits} + if cache: + p["cacheVariables"] = cache + cfg.append(p) + have_cfg.add(name) + added.append(name) + if name not in have_bld: + bld.append({"name": name, "configurePreset": name}) + have_bld.add(name) + + if base and "RelWithDebInfo" not in have_cfg: + add("RelWithDebInfo", base, {"CMAKE_BUILD_TYPE": "RelWithDebInfo"}) + ef = sel.get("external_flash") or {} + if ef.get("enabled"): + for bt in manifest.get("options", {}).get("build_types", []): + if bt not in have_cfg: + continue + for layout, suffix in LAYOUT_SUFFIX.items(): + add(f"{bt}-{suffix}", bt, {"ICBSP_FLASH_LAYOUT": layout}) + if not added: + rep.skip(step, "预设已齐全") + return + indent = "\t" if "\n\t" in tf.text else 4 + tf.text = json.dumps(data, ensure_ascii=False, indent=indent) + "\n" + plan.edit(tf) + rep.ok(step, "加预设 " + "、".join(added)) + + +# ---------------------------------------------------------------- 外置 Flash 文件 + + +def plan_external_flash(host, plan, rep, text_file_cls, ioc, manifest, sel, board_dir, info, render, flash_scripts=True): + """icbsp_flash_config.h、quadspi.c 的 USER CODE、Flash/daplink_qspi.cfg、旧版烧录脚本升级""" + step = "外置 Flash" + ef = sel.get("external_flash") or {} + if not ef.get("enabled"): + return + chip = flash.chip_for(manifest, ef.get("chip")) + a = flash.analyze(ioc, None, manifest) + if chip is None or not a["supported"] or a["bank"] is None: + rep.error(step, a["note"] or "外置 Flash 配置不完整(芯片 / QUADSPI Bank)") + return + quadspi_c = host / "Core/Src/quadspi.c" + try: + pins = flash.pin_afs(ioc, quadspi_c) + except ValueError as e: + rep.error(step, str(e)) + return + if len(pins) != 6: + rep.error(step, f".ioc 里 QUADSPI 引脚是 {len(pins)} 个,单线 / 双线 / 双 Flash 模式暂不支持(要 CLK + NCS + IO0~IO3)") + return + + # 1. icbsp_flash_config.h(整文件生成) + header = flash.config_header(chip, a["bank"], pins, int(ef.get("prescaler", 2))) + _write_generated(host, plan, rep, text_file_cls, host / board_dir / "icbsp_flash_config.h", header, step) + + # 2. Flash/daplink_qspi.cfg(整文件生成) + cfg = render(Path(__file__).resolve().parents[2] / "templates/Flash/daplink_qspi.cfg", + {**info, "QSPI_CHIP": chip["name"], "QSPI_BANK": a["bank"], + "QSPI_INIT": flash.openocd_qspi_init(chip, a["bank"], pins)}) + _write_generated(host, plan, rep, text_file_cls, host / "Flash/daplink_qspi.cfg", cfg, step) + + # 3. quadspi.c:方案 B 不能重新初始化 QUADSPI + if not quadspi_c.exists(): + rep.warn(step, "没有 Core/Src/quadspi.c:方案 B 要保证应用不初始化 QUADSPI") + else: + tf = _file(host, plan, text_file_cls, quadspi_c) + span = _user_code(tf.text, "QUADSPI_Init 0") + if span is None: + rep.error(step, "quadspi.c 没有 USER CODE QUADSPI_Init 0 段") + else: + cur = tf.text[span[0] : span[1]] + if "ICBSP_FLASH_LAYOUT_QSPI_XIP" in cur: + rep.skip(step, "quadspi.c 已有方案 B 的提前返回") + elif cur.strip(): + rep.error(step, "quadspi.c 的 USER CODE QUADSPI_Init 0 已有自定义内容:请手动把 templates 里的方案 B 提前返回加在最前面") + else: + tf.text = tf.text[: span[0]] + QSPI_GUARD + "\n" + tf.text[span[1] :] + plan.edit(tf) + rep.ok(step, "quadspi.c:方案 B 时 MX_QUADSPI_Init() 直接返回") + + # 4. 旧版烧录脚本不认外置 Flash:换成新模板(不生成 Flash/ 时不动) + for name in ("OpenOCD_flash.sh", "OpenOCD_flash.bat", "JLink_flash.sh", "JLink_flash.bat") if flash_scripts else (): + dst = host / "Flash" / name + if not dst.exists() or dst in plan.new_files: + continue + tf = _file(host, plan, text_file_cls, dst) + if "ICBSP_FLASH_LAYOUT" in tf.text: + continue + tf.text = render(Path(__file__).resolve().parents[2] / "templates/Flash" / name, info) + plan.edit(tf) + rep.ok(step, f"Flash/{name} 换成认外置 Flash 的新版") + + mhz = 240 // (int(ef.get("prescaler", 2)) + 1) + rep.ok(step, f"{chip['name']},QUADSPI Bank {a['bank']},应用运行时 QSPI {mhz} MHz,默认存放方式 {ef.get('layout')}") + + +def _write_generated(host, plan, rep, text_file_cls, path, text, step): + if not path.exists(): + plan.create(path, text) + rep.ok(step, f"新建 {_rel(path, host)}") + return + tf = _file(host, plan, text_file_cls, path) + if tf.text == text: + rep.skip(step, f"{_rel(path, host)} 已是最新") + return + tf.text = text + plan.edit(tf) + rep.ok(step, f"重新生成 {_rel(path, host)}") + + +def _user_code(text, name): + begin = f"/* USER CODE BEGIN {name} */" + end = f"/* USER CODE END {name} */" + if text.count(begin) != 1 or text.count(end) != 1: + return None + start = text.index("\n", text.index(begin)) + 1 + stop = text.rfind("\n", 0, text.index(end)) + 1 + return start, stop + + +# ---------------------------------------------------------------- .gitignore + + +def gitignore_template(): + return (Path(__file__).resolve().parents[2] / "templates/gitignore").read_text(encoding="utf-8") + + +def plan_gitignore(host, plan, rep, text_file_cls): + step = ".gitignore" + path = host / ".gitignore" + tpl = gitignore_template() + if not path.exists(): + plan.create(path, tpl) + rep.ok(step, "复制示例 .gitignore(templates/gitignore)") + return + tf = _file(host, plan, text_file_cls, path) + have = {l.strip() for l in tf.text.split("\n")} + want = [l for l in tpl.split("\n") if l.strip() and not l.lstrip().startswith("#")] + missing = [l for l in want if l.strip() not in have] + if not missing: + rep.skip(step, ".gitignore 已包含示例里的全部条目") + return + if GITIGNORE_BEGIN in tf.text and GITIGNORE_END in tf.text: + before, rest = tf.text.split(GITIGNORE_BEGIN, 1) + inside, after = rest.split(GITIGNORE_END, 1) + inside = inside.rstrip("\n") + "\n" + "\n".join(missing) + "\n" + tf.text = before + GITIGNORE_BEGIN + inside + GITIGNORE_END + after + else: + tf.text = tf.text.rstrip("\n") + "\n\n" + GITIGNORE_BEGIN + "\n" + "\n".join(missing) + "\n" + GITIGNORE_END + "\n" + plan.edit(tf) + rep.ok(step, f"追加 {len(missing)} 条:{'、'.join(missing)}") + + +# ---------------------------------------------------------------- 选项来源(普通模式) + + +def cli_overrides(args, sel, manifest): + """把 --external-flash / --flash-chip / --qspi-prescaler / --opt / --vendor-os / --no-opt / --flash-scripts 合进选择;返回是否有改动""" + changed = False + ef = sel["external_flash"] + if args.external_flash: + if args.external_flash == "off": + changed |= ef.get("enabled") is not False + ef["enabled"] = False + else: + changed |= not ef.get("enabled") or ef.get("layout") != args.external_flash + ef["enabled"] = True + ef["layout"] = args.external_flash + if args.flash_chip: + changed |= ef.get("chip") != args.flash_chip + ef["chip"] = args.flash_chip + if args.qspi_prescaler is not None: + changed |= ef.get("prescaler") != args.qspi_prescaler + ef["prescaler"] = args.qspi_prescaler + op = sel["optimization"] + for item in args.opt or []: + for part in item.split(","): + if not part.strip(): + continue + bt, _, lv = part.partition("=") + bt, lv = bt.strip(), lv.strip() + if bt not in manifest["options"]["build_types"] or lv not in manifest["options"]["opt_levels"]: + raise ValueError(f"--opt {part}:格式 类型=等级,类型 {'/'.join(manifest['options']['build_types'])}," + f"等级 {' '.join(manifest['options']['opt_levels'])}") + changed |= op.get(bt) != lv or not op.get("enabled") + op[bt] = lv + op["enabled"] = True + if args.vendor_os: + changed |= not op.get("vendor_os") or not op.get("enabled") + op["vendor_os"] = True + op["enabled"] = True + if args.no_opt: + changed |= bool(op.get("enabled")) + op["enabled"] = False + if args.flash_scripts: + want = args.flash_scripts == "on" + changed |= sel.get("flash_scripts", True) != want + sel["flash_scripts"] = want + return changed diff --git a/tools/icbsp_tool/ioc.py b/tools/icbsp_tool/ioc.py new file mode 100644 index 0000000..8589ac1 --- /dev/null +++ b/tools/icbsp_tool/ioc.py @@ -0,0 +1,365 @@ +""" +CubeMX .ioc 的读取、查询与修改。 + +.ioc 是 Java properties:键值用 `=` 分隔;键里的空格写成 `\\ `,值里的冒号写成 `\\:`。CubeMX 不写默认值, +所以“键不存在”= CubeMX 的默认值(默认值取自 STM32CubeMX/db/mcu/IP/*.xml,见各函数注释)。 + +修改时保持原文件的行与顺序,只改动到的行;新键按字母序插到相邻位置(CubeMX 自己也按字母序保存)。 +""" + +import re +from pathlib import Path + +# H7:APB2 上的定时器(其余在 APB1)。时钟键名见 RCC-STM32H723_rcc_v1_0_Modes.xml: +# Tim1OutputFreq_Value = TIM2~7、12~14(APB1),Tim2OutputFreq_Value = TIM1、8、15~17(APB2) +H7_APB2_TIMERS = {1, 8, 15, 16, 17} +F4_APB2_TIMERS = {1, 8, 9, 10, 11} +CUBEMX_DEFAULT_TIM_CLOCK = 96000000 # H7 RCC xml 里两项的 DefaultValue +FDCAN_MSGRAM_WORDS = 2560 + + +def _unescape(s): + out, i = [], 0 + while i < len(s): + c = s[i] + if c == "\\" and i + 1 < len(s): + out.append(s[i + 1]) + i += 2 + continue + out.append(c) + i += 1 + return "".join(out) + + +def _escape_key(s): + return s.replace("\\", "\\\\").replace(" ", "\\ ").replace(":", "\\:").replace("=", "\\=") + + +def _escape_value(s): + return s.replace("\\", "\\\\").replace(":", "\\:") + + +def eval_int(expr): + """CubeMX 写的 PSC / ARR 形如 24-1、2000-1、10000、0xFFFF""" + if expr is None: + return None + expr = str(expr).strip() + if re.fullmatch(r"0[xX][0-9a-fA-F]+", expr): + return int(expr, 16) + if not re.fullmatch(r"[\d\s+\-]+", expr): + return None + total = 0 + for sign, num in re.findall(r"([+-]?)\s*(\d+)", expr): + total += -int(num) if sign == "-" else int(num) + return total + + +class Ioc: + def __init__(self, path): + self.path = Path(path) + raw = self.path.read_bytes() + self.crlf = b"\r\n" in raw + self.lines = raw.decode("utf-8").replace("\r\n", "\n").split("\n") + self.original = list(self.lines) + self._index() + + # ---------- 读写 ---------- + + def _index(self): + self.values = {} + self.pos = {} + for i, line in enumerate(self.lines): + if not line or line.startswith("#") or "=" not in line: + continue + k, v = self._split(line) + self.values[k] = v + self.pos[k] = i + + @staticmethod + def _split(line): + # 找第一个没被转义的 '=' + i = 0 + while i < len(line): + if line[i] == "\\": + i += 2 + continue + if line[i] == "=": + return _unescape(line[:i]), _unescape(line[i + 1 :]) + i += 1 + return _unescape(line), "" + + def get(self, key, default=None): + return self.values.get(key, default) + + def set(self, key, value): + """改一个键(没有就按字母序插入);返回 (旧值, 新值)""" + old = self.values.get(key) + line = f"{_escape_key(key)}={_escape_value(str(value))}" + if key in self.pos: + self.lines[self.pos[key]] = line + else: + keys = sorted(self.pos, key=lambda k: self.pos[k]) + at = len(self.lines) + for k in keys: + if k > key: + at = self.pos[k] + break + else: + # 放在最后一个键之后(文件末尾可能有空行) + at = (self.pos[keys[-1]] + 1) if keys else len(self.lines) + self.lines.insert(at, line) + self._index() + return old, str(value) + + def changed(self): + return self.lines != self.original + + def text(self): + return "\n".join(self.lines) + + def to_bytes(self): + t = self.text() + return (t.replace("\n", "\r\n") if self.crlf else t).encode("utf-8") + + # ---------- 基本信息 ---------- + + @property + def mcu(self): + return self.get("Mcu.UserName") or self.get("Mcu.Name") or "" + + @property + def series(self): + fam = (self.get("Mcu.Family") or self.mcu).upper() + if "STM32H7" in fam: + return "h7" + if "STM32F4" in fam: + return "f4" + return None + + def ips(self): + out = [] + for k, v in self.values.items(): + if re.fullmatch(r"Mcu\.IP\d+", k): + out.append(v) + return sorted(set(out), key=_natural) + + # ---------- 中断 / DMA / 引脚 ---------- + + def nvic(self, irq): + """返回 (是否打开, 抢占优先级);键不存在 = 没打开""" + v = self.get(f"NVIC.{irq}") + if v is None: + return False, None + f = v.split(":") + try: + return f[0] == "true", int(f[1]) + except (IndexError, ValueError): + return f[0] == "true", None + + def dma_requests(self): + return {v for k, v in self.values.items() if re.fullmatch(r"Dma\.Request\d+", k)} + + def dma_param(self, request, param): + for k, v in self.values.items(): + m = re.fullmatch(rf"Dma\.{re.escape(request)}\.\d+\.{re.escape(param)}", k) + if m: + return v + return None + + def labeled_pins(self): + """带 GPIO_Label 的引脚:{label: {pin, signal}}""" + out = {} + for k, v in self.values.items(): + if k.endswith(".GPIO_Label"): + pin = k[: -len(".GPIO_Label")] + out[v] = {"pin": pin, "signal": self.get(f"{pin}.Signal", "")} + return out + + def gpio_outputs(self): + return sorted(l for l, p in self.labeled_pins().items() if p["signal"] == "GPIO_Output") + + def gpio_exti(self): + return sorted(l for l, p in self.labeled_pins().items() if re.match(r"GP(IO_EXTI|XTI)\d+", p["signal"])) + + # ---------- 外设视图 ---------- + + def can_instances(self): + """H7 FDCANn / F4 CANn。默认值来自 FDCAN-fdcan1_v1_0_Cube_Modes.xml""" + out = [] + pat = r"FDCAN(\d+)" if self.series == "h7" else r"CAN(\d+)" + for ip in self.ips(): + m = re.fullmatch(pat, ip) + if not m: + continue + n = int(m.group(1)) + g = lambda p, d: self.get(f"{ip}.{p}", d) + out.append( + { + "ip": ip, + "n": n, + "frame_format": g("FrameFormat", "FDCAN_FRAME_CLASSIC"), + "auto_retx": g("AutoRetransmission", "DISABLE"), # CubeMX 默认 Disable,.ioc 里不写就是关的 + "msgram_offset": int(g("MessageRAMOffset", "0")), + "std_filters": int(g("StdFiltersNbr", "0")), + "ext_filters": int(g("ExtFiltersNbr", "0")), + "rx_fifo0": int(g("RxFifo0ElmtsNbr", "0")), + "rx_fifo0_size": g("RxFifo0ElmtSize", "FDCAN_DATA_BYTES_8"), + "rx_fifo1": int(g("RxFifo1ElmtsNbr", "0")), + "rx_fifo1_size": g("RxFifo1ElmtSize", "FDCAN_DATA_BYTES_8"), + "rx_buffers": int(g("RxBuffersNbr", "0")), + "rx_buffer_size": g("RxBufferSize", "FDCAN_DATA_BYTES_8"), + "tx_events": int(g("TxEventsNbr", "0")), + "tx_buffers": int(g("TxBuffersNbr", "0")), + "tx_fifo_queue": int(g("TxFifoQueueElmtsNbr", "0")), + "tx_size": g("TxElmtSize", "FDCAN_DATA_BYTES_8"), + "tx_mode": g("TxFifoQueueMode", "FDCAN_TX_FIFO_OPERATION"), + "nvic_it0": self.nvic(f"{ip}_IT0_IRQn")[0] if self.series == "h7" else self.nvic(f"{ip}_RX0_IRQn")[0], + } + ) + return out + + def uart_instances(self): + out = [] + reqs = self.dma_requests() + for ip in self.ips(): + m = re.fullmatch(r"(USART|UART|LPUART)(\d+)", ip) + if not m: + continue + kind = "lpuart" if m.group(1) == "LPUART" else "uart" + n = int(m.group(2)) + rs485 = any(k.startswith(f"{ip}.VirtualMode-Hardware Flow Control (RS485)") for k in self.values) + out.append( + { + "ip": ip, + "n": n, + "kind": kind, + "baudrate": int(self.get(f"{ip}.BaudRate", "115200")), + "rs485": rs485, + "dma_rx": f"{ip}_RX" in reqs, + "dma_tx": f"{ip}_TX" in reqs, + "dma_rx_width": self.dma_param(f"{ip}_RX", "MemDataAlignment"), + "dma_tx_width": self.dma_param(f"{ip}_TX", "MemDataAlignment"), + "nvic": self.nvic(f"{ip}_IRQn")[0], + "bdma": kind == "lpuart", + } + ) + return out + + def spi_instances(self): + out = [] + reqs = self.dma_requests() + for ip in self.ips(): + m = re.fullmatch(r"SPI(\d+)", ip) + if not m: + continue + n = int(m.group(1)) + out.append( + { + "ip": ip, + "n": n, + "mode": self.get(f"{ip}.Mode", "SPI_MODE_MASTER" if self.get(f"{ip}.VirtualType") == "VM_MASTER" else None), + "direction": self.get(f"{ip}.Direction", "SPI_DIRECTION_2LINES"), + "nss": self.get(f"{ip}.NSS", "SPI_NSS_SOFT"), + "virtual_nss": self.get(f"{ip}.VirtualNSS", ""), + "keep_io": self.get(f"{ip}.MasterKeepIOState", "SPI_MASTER_KEEP_IO_STATE_DISABLE"), + "dma_rx": f"{ip}_RX" in reqs, + "dma_tx": f"{ip}_TX" in reqs, + "nvic": self.nvic(f"{ip}_IRQn")[0], + "bdma": self.series == "h7" and n == 6, + # CubeMX 不写默认值:H7 的 SPI 默认 4 位帧(!),F4 默认 8 位;预分频默认 /2 + "data_size": self.get(f"{ip}.DataSize", "SPI_DATASIZE_4BIT" if self.series == "h7" else "SPI_DATASIZE_8BIT"), + "prescaler": self.spi_prescaler(ip), + "kernel_hz": self.spi_kernel_hz(n), + } + ) + return out + + def spi_prescaler(self, ip): + m = re.search(r"(\d+)$", self.get(f"{ip}.BaudRatePrescaler", "SPI_BAUDRATEPRESCALER_2")) + return int(m.group(1)) if m else 2 + + def spi_kernel_hz(self, n): + """SPI n 的内核时钟(Hz),.ioc 里没有对应键时返回 None""" + if self.series == "h7": + key = "RCC.SPI123Freq_Value" if n <= 3 else ("RCC.SPI45Freq_Value" if n <= 5 else "RCC.SPI6Freq_Value") + else: + key = "RCC.APB1Freq_Value" if n in (2, 3) else "RCC.APB2Freq_Value" + v = self.get(key) + return int(float(v)) if v else None + + def timer_clock(self, n): + """定时器 n 的输入时钟(Hz);键缺省时用 CubeMX 默认值,第二项为 False 表示是猜的""" + if self.series == "f4": + key = "RCC.APB2TimFreq_Value" if n in F4_APB2_TIMERS else "RCC.APB1TimFreq_Value" + default = 16000000 + else: + key = "RCC.Tim2OutputFreq_Value" if n in H7_APB2_TIMERS else "RCC.Tim1OutputFreq_Value" + default = CUBEMX_DEFAULT_TIM_CLOCK + v = self.get(key) + if v is None: + return default, False + return int(float(v)), True + + def timebase_tim(self): + return self.get("NVIC.TimeBaseIP") + + def pwm_channels(self): + """[(tim, ch)]:TIMn.Channel-PWM GenerationK CHk""" + out = [] + for k in self.values: + m = re.fullmatch(r"TIM(\d+)\.Channel-PWM Generation(\d) CH\d", k) + if m: + out.append((int(m.group(1)), int(m.group(2)))) + return sorted(set(out)) + + def encoder_timers(self): + """SH.S_TIMn_CHk.0=…,Encoder_Interface""" + out = set() + for k, v in self.values.items(): + m = re.fullmatch(r"SH\.S_TIM(\d+)_CH\d\.\d+", k) + if m and "Encoder_Interface" in v: + out.add(int(m.group(1))) + return sorted(out) + + def tim_param(self, n, param, default): + return self.get(f"TIM{n}.{param}", default) + + def freertos(self): + tasks = self.get("FREERTOS.Tasks01", "") + default_task = None + for t in tasks.split(";"): + f = t.split(",") + if f and f[0] == "defaultTask" and len(f) >= 5: + default_task = f[4] + return { + "enabled": "FREERTOS" in self.ips(), + "cmsis_v2": self.get("VP_FREERTOS_VS_CMSIS_V2.Mode") == "CMSIS_V2", + "tick": int(self.get("FREERTOS.configTICK_RATE_HZ", "1000")), + "stack_check": int(self.get("FREERTOS.configCHECK_FOR_STACK_OVERFLOW", "0")), + "malloc_hook": int(self.get("FREERTOS.configUSE_MALLOC_FAILED_HOOK", "0")), + "default_task": default_task, + "tasks_value": tasks, + } + + +def fdcan_words(c): + """一路 FDCAN 在 Message RAM 里占的字数(RM0468 Message RAM 一节;元素头 2 字 + 数据字数)""" + + def elem(size): + m = re.search(r"(\d+)$", size or "") + data = int(m.group(1)) if m else 8 + return 2 + (data + 3) // 4 + + return ( + c["std_filters"] * 1 + + c["ext_filters"] * 2 + + c["rx_fifo0"] * elem(c["rx_fifo0_size"]) + + c["rx_fifo1"] * elem(c["rx_fifo1_size"]) + + c["rx_buffers"] * elem(c["rx_buffer_size"]) + + c["tx_events"] * 2 + + (c["tx_buffers"] + c["tx_fifo_queue"]) * elem(c["tx_size"]) + ) + + +def _natural(s): + return [int(t) if t.isdigit() else t for t in re.split(r"(\d+)", s)] diff --git a/tools/icbsp_tool/manifest.py b/tools/icbsp_tool/manifest.py new file mode 100644 index 0000000..35c2a88 --- /dev/null +++ b/tools/icbsp_tool/manifest.py @@ -0,0 +1,159 @@ +""" +库侧清单 tools/manifest.json 的读取与自检。 + +清单是生成的唯一数据源:外设类型 → BSP 类与代码片段,设备目录 → 依赖、参数与片段,功能开关,校验规则。 +片段里的 {xxx} 用 str.format 替换,{{ }} 是字面花括号。validate() 检查每个占位符都有来源, +改了库的构造函数 / Config 却忘了同步清单时能在这里(以及快照测试的编译)发现。 +""" + +import json +import string +from pathlib import Path + +MANIFEST_PATH = Path(__file__).resolve().parent.parent / "manifest.json" +SERIES = ("h7", "f4") +PARAM_TYPES = {"int", "float", "bool", "enum", "int_list"} +NEED_KINDS = {"can", "uart", "spi", "pwm", "encoder", "gpio_out", "gpio_exti"} +DEVICE_STATUS = {"tested", "board_use", "compile_only", "planned"} +LEVELS = {"error", "warn"} + +# 外设片段可用的内建占位符(由 generate.py 提供) +PERIPH_BUILTINS = {"instance", "handle", "label", "n", "ch", "kind", "dma_attr"} +# 设备片段可用的内建占位符 +DEVICE_BUILTINS = {"name"} + + +def load(path=MANIFEST_PATH): + with open(path, encoding="utf-8") as f: + return json.load(f) + + +def _fields(fmt): + """str.format 片段里的占位符名""" + return {name for _, name, _, _ in string.Formatter().parse(fmt) if name} + + +def validate(m): + """返回问题列表(空 = 通过)""" + bad = [] + if m.get("manifest_version") != 1: + bad.append("manifest_version 应为 1") + rules = m.get("rules", {}) + for rid, r in rules.items(): + if r.get("level") not in LEVELS: + bad.append(f"rules.{rid}: level 只能是 {sorted(LEVELS)}") + for k in ("title", "fix"): + if not r.get(k): + bad.append(f"rules.{rid}: 缺 {k}") + for kind, p in m.get("peripherals", {}).items(): + where = f"peripherals.{kind}" + for k in ("title", "ioc_ip", "instance", "handle", "include", "declare", "init", "params"): + if k not in p: + bad.append(f"{where}: 缺 {k}") + keys = set() + for prm in p.get("params", []): + bad += _check_param(f"{where}.params", prm) + keys.add(prm.get("key")) + allowed = keys | PERIPH_BUILTINS + for s in SERIES: + for k in ("ioc_ip", "handle", "declare"): + if s not in p.get(k, {}): + bad.append(f"{where}.{k}: 缺 {s}") + frag = p.get("declare", {}).get(s, "") + for name in _fields(frag) - allowed: + bad.append(f"{where}.declare.{s}: 占位符 {{{name}}} 没有来源") + for frag in p.get("init", []): + for name in _fields(frag) - allowed: + bad.append(f"{where}.init: 占位符 {{{name}}} 没有来源") + for rid in p.get("rules", []): + if rid not in rules: + bad.append(f"{where}.rules: 规则 {rid} 不存在") + switches = m.get("switches", {}) + for sid, sw in switches.items(): + for dep in sw.get("requires", []): + if dep not in switches: + bad.append(f"switches.{sid}: 依赖的 {dep} 不存在") + for dev, d in m.get("devices", {}).items(): + where = f"devices.{dev}" + if d.get("status") not in DEVICE_STATUS: + bad.append(f"{where}: status 只能是 {sorted(DEVICE_STATUS)}") + for need in d.get("needs", []): + if need.get("kind") not in NEED_KINDS: + bad.append(f"{where}.needs: kind {need.get('kind')} 不认识") + if d.get("status") == "planned": + continue + for k in ("include", "define", "extern", "init", "params"): + if k not in d: + bad.append(f"{where}: 缺 {k}") + keys = {n["key"] for n in d.get("needs", [])} + for prm in d.get("params", []): + bad += _check_param(f"{where}.params", prm) + keys.add(prm.get("key")) + allowed = keys | DEVICE_BUILTINS + frags = d.get("define", []) + d.get("extern", []) + d.get("init", []) + [e["call"] for e in d.get("exti", [])] + for frag in frags + d.get("notes", []): + for name in _fields(frag) - allowed: + bad.append(f"{where}: 片段里的占位符 {{{name}}} 没有来源") + for e in d.get("exti", []): + if e.get("pin") not in keys: + bad.append(f"{where}.exti: pin {e.get('pin')} 不是 needs 里的键") + for sw in d.get("switches", []): + if sw not in switches: + bad.append(f"{where}.switches: {sw} 不是已知开关") + bad += _check_flash(m) + return bad + + +def _check_flash(m): + """flash_chips / options(外置 Flash 与编译优化)""" + bad = [] + names = set() + for i, c in enumerate(m.get("flash_chips", [])): + where = f"flash_chips[{i}]" + for k in ("name", "size", "addr_bytes", "jedec_manufacturer", "jedec_capacity", "max_mhz", "status"): + if k not in c: + bad.append(f"{where}: 缺 {k}") + size = c.get("size", 0) + if not isinstance(size, int) or size <= 0 or size & (size - 1): + bad.append(f"{where}: size 必须是 2 的幂(字节)") + elif c.get("addr_bytes") == 3 and size > 16 << 20: + bad.append(f"{where}: 超过 16 MB 要用 4 字节地址") + if c.get("addr_bytes") not in (3, 4): + bad.append(f"{where}: addr_bytes 只能是 3 或 4") + if c.get("status") not in DEVICE_STATUS: + bad.append(f"{where}: status 只能是 {sorted(DEVICE_STATUS)}") + if c.get("name") in names: + bad.append(f"{where}: 名字 {c.get('name')} 重复") + names.add(c.get("name")) + opt = m.get("options") + if opt is not None: + for k in ("flash_layouts", "build_types", "opt_levels", "opt_defaults", "qspi_prescaler_default"): + if k not in opt: + bad.append(f"options: 缺 {k}") + if set(opt.get("flash_layouts", {})) != {"INTERNAL", "QSPI_RAM", "QSPI_XIP"}: + bad.append("options.flash_layouts 必须正好是 INTERNAL / QSPI_RAM / QSPI_XIP") + for bt, lv in opt.get("opt_defaults", {}).items(): + if bt not in opt.get("build_types", []) or lv not in opt.get("opt_levels", []): + bad.append(f"options.opt_defaults.{bt}: 构建类型或等级不在列表里") + return bad + + +def _check_param(where, prm): + bad = [] + if not prm.get("key"): + bad.append(f"{where}: 参数缺 key") + if prm.get("type") not in PARAM_TYPES: + bad.append(f"{where}.{prm.get('key')}: type 只能是 {sorted(PARAM_TYPES)}") + if prm.get("type") == "enum" and not prm.get("values"): + bad.append(f"{where}.{prm.get('key')}: enum 缺 values") + if "default" not in prm and "default_from" not in prm: + bad.append(f"{where}.{prm.get('key')}: 缺 default / default_from") + if prm.get("type") == "enum" and "default" in prm and prm["default"] not in prm["values"]: + bad.append(f"{where}.{prm.get('key')}: 默认值不在 values 里") + return bad + + +if __name__ == "__main__": + problems = validate(load()) + print("\n".join(problems) or "manifest: OK") + raise SystemExit(1 if problems else 0) diff --git a/tools/icbsp_tool/regions.py b/tools/icbsp_tool/regions.py new file mode 100644 index 0000000..af386ea --- /dev/null +++ b/tools/icbsp_tool/regions.py @@ -0,0 +1,95 @@ +""" +宿主文件里的“生成区”: + + // + ……由 integrate.py 生成的内容…… + // + +结束标记里的 8 位十六进制是区内内容的 SHA-1 前缀(按 \\n 换行、去掉缩进前的原文计算)。重新生成时: +记录的哈希和区内实际内容对不上 = 有人手改过本区 → 停下来不覆盖(让用户把改动挪到区外,或删掉本区重新生成)。 +区外的内容一律不动。 + +CMake、.gitignore 等用 `#` 注释的文件把 prefix 传成 "#": + + # + …… + # +""" + +import hashlib +import re + + +def _patterns(prefix): + p = re.escape(prefix) + return ( + re.compile(rf"^([ \t]*){p} [ \t]*$"), + re.compile(rf"^[ \t]*{p} [ \t]*$"), + ) + + +BEGIN, END = _patterns("//") + + +def digest(body): + return hashlib.sha1(body.encode("utf-8")).hexdigest()[:8] + + +def parse(text, prefix="//"): + """返回 ({名字: 区信息}, [问题]);区信息:begin、end(行号)、indent、body、recorded、actual""" + begin_re, end_re = _patterns(prefix) + lines = text.split("\n") + found, bad, open_ = {}, [], None + for i, line in enumerate(lines): + mb = begin_re.match(line) + me = end_re.match(line) + if mb: + if open_: + bad.append(f"第 {i + 1} 行:生成区 {mb.group(2)} 开始时 {open_[1]} 还没结束") + open_ = (i, mb.group(2), mb.group(1)) + elif me: + if not open_ or open_[1] != me.group(1): + bad.append(f"第 {i + 1} 行:结束标记 {me.group(1)} 没有对应的开始标记") + open_ = None + continue + b, name, indent = open_ + body = "\n".join(lines[b + 1 : i]) + if name in found: + bad.append(f"生成区 {name} 出现了两次") + found[name] = {"begin": b, "end": i, "indent": indent, "body": body, "recorded": me.group(2), "actual": digest(body)} + open_ = None + if open_: + bad.append(f"生成区 {open_[1]} 没有结束标记") + return found, bad + + +def replace(text, name, body, prefix="//"): + """把生成区 name 的内容换成 body(body 已带缩进),返回新文本""" + regs, bad = parse(text, prefix) + if bad: + raise ValueError(";".join(bad)) + r = regs[name] + lines = text.split("\n") + new = [f"{r['indent']}{prefix} "] + (body.split("\n") if body else []) + [f"{r['indent']}{prefix} "] + return "\n".join(lines[: r["begin"]] + new + lines[r["end"] + 1 :]) + + +def block(name, body, prefix="//"): + """一个完整的生成区(开始标记 + 内容 + 带哈希的结束标记)""" + return "\n".join([f"{prefix} "] + (body.split("\n") if body else []) + [f"{prefix} "]) + + +def seal(text, prefix="//"): + """按区内现有内容重算所有结束标记的哈希(给模板用)""" + regs, bad = parse(text, prefix) + if bad: + raise ValueError(";".join(bad)) + for name in regs: + text = replace(text, name, parse(text, prefix)[0][name]["body"], prefix) + return text + + +def edited(text, prefix="//"): + """手改过的生成区名""" + regs, _ = parse(text, prefix) + return [n for n, r in regs.items() if r["recorded"] != r["actual"]] diff --git a/tools/icbsp_tool/selection.py b/tools/icbsp_tool/selection.py new file mode 100644 index 0000000..f854268 --- /dev/null +++ b/tools/icbsp_tool/selection.py @@ -0,0 +1,363 @@ +""" +从 .ioc 列出可做成库实例的外设(候选),算出每个参数的默认值;默认选择与选择的校验。 + +选择(selection)的格式,也是 `integrate.py --apply <选择.json>` 读的格式: + + { + "peripherals": { + "FDCAN1": {"kind": "can", "enabled": true, "params": {"rx_depth": 16, "tx_depth": 16}}, + "USART1": {"kind": "uart", "enabled": true, "params": {"mode": "dma", "dir": "TxRx", ...}}, + "TIM12_CH2": {"kind": "pwm", "enabled": true, "params": {...}} + }, + "devices": [ {"type": "dji_motor", "name": "chassis_lf", "needs": {"bus": "FDCAN1"}, "params": {"type": "M3508", "id": 1}} ], + "switches": {"ICBSP_CAN_RX_ENABLE": 1, ...}, + "debug_uart": "USART1", + "external_flash": {"enabled": true, "layout": "QSPI_RAM", "chip": "W25Q128", "prescaler": 2}, + "optimization": {"enabled": true, "Debug": "-Og", "RelWithDebInfo": "-O2", "Release": "-Os", "vendor_os": false}, + "gitignore": true, + "flash_scripts": true + } + +external_flash:外置 QSPI Flash(tools/icbsp_tool/flash.py、cmake/icbsp_flash.cmake)。layout 是写进根 CMakeLists.txt 的 +默认程序存放方式(INTERNAL / QSPI_RAM / QSPI_XIP),日常切换用 CMakePresets 的 *-Internal / *-QspiRam / *-QspiXip。 +optimization:各构建类型的优化等级(cmake/icbsp_options.cmake);vendor_os = CubeMX 生成的源码固定 -Os。 +gitignore:把 templates/gitignore 合并进宿主 .gitignore(只追加缺的行)。 +flash_scripts:生成 Flash/ 烧录脚本,同时给 .vscode 加烧录任务与 Task Buttons 状态栏按钮(外置 Flash 启用时再加 RAM 运行 / 重烧 boot)。 + +只出现部分键时按默认值补齐;PWM / 编码器默认不选(例如 DM-MC02 的 TIM3_CH4 是 BMI088 加热电阻,不能默认启动)。 +""" + +import re + +from . import checks +from . import flash + + +def candidates(ioc, manifest): + """[{ip, kind, instance, handle, label, n, ch, usable, reason, params(默认值), facts}]""" + s = ioc.series + per = manifest["peripherals"] + use = checks.usable(ioc) + out = [] + + def mk(kind, ip, n, extra, defaults_from, label=None, ch=None, ukind=None): + p = per[kind] + fmt = {"n": n, "ch": ch, "kind": ukind or ""} + ok, why = use.get(ip, (True, "")) + params = {} + for prm in p["params"]: + if "default" in prm: + params[prm["key"]] = prm["default"] + else: + params[prm["key"]] = defaults_from.get(prm["default_from"]) + out.append( + { + "ip": ip, + "kind": kind, + "instance": p["instance"].format(**fmt), + "handle": p["handle"][s].format(**fmt), + "label": label or ip, + "n": n, + "ch": ch, + "ukind": ukind, + "usable": ok, + "reason": why, + "params": params, + "facts": extra, + } + ) + + for c in ioc.can_instances(): + mk("can", c["ip"], c["n"], c, {}, label=f"CAN{c['n']}") + for u in ioc.uart_instances(): + both = u["dma_rx"] and u["dma_tx"] and not u["bdma"] + mk("uart", u["ip"], u["n"], u, {"uart_mode": "dma" if both else "it", "ioc_baudrate": u["baudrate"]}, ukind=u["kind"]) + for sp in ioc.spi_instances(): + mk("spi", sp["ip"], sp["n"], sp, {"spi_dma": bool(sp["dma_rx"] and sp["dma_tx"] and not sp["bdma"])}) + for n, ch in ioc.pwm_channels(): + clk, known = ioc.timer_clock(n) + psc = checks.eval_int(ioc.tim_param(n, "Prescaler", "0")) + arr = checks.eval_int(ioc.tim_param(n, "Period", "65535")) + mk("pwm", f"TIM{n}_CH{ch}", n, {"clock_known": known}, {"ioc_timer_clock": clk, "ioc_prescaler": psc, "ioc_period": arr}, ch=ch) + for n in ioc.encoder_timers(): + mk("encoder", f"TIM{n}", n, {}, {}) + return out + + +def default_selection(ioc, manifest): + sel = {"peripherals": {}, "devices": [], "switches": {}, "debug_uart": None} + for c in candidates(ioc, manifest): + on = c["usable"] and c["kind"] in ("can", "uart", "spi") + sel["peripherals"][c["ip"]] = {"kind": c["kind"], "enabled": on, "params": dict(c["params"])} + uarts = [ip for ip, p in sel["peripherals"].items() if p["kind"] == "uart" and p["enabled"]] + sel["debug_uart"] = "USART1" if "USART1" in uarts else (uarts[0] if uarts else None) + sel["switches"] = default_switches(manifest, sel) + sel.update(default_options(ioc, manifest)) + return sel + + +def default_options(ioc, manifest): + """外置 Flash / 编译优化 / .gitignore 的默认值(默认都不改宿主的构建方式,.gitignore 默认合并)""" + opt = manifest.get("options", {}) + guess = flash.analyze(ioc, None, manifest).get("chip_guess") + return { + "external_flash": { + "enabled": False, + "layout": "QSPI_RAM", + "chip": guess, + "prescaler": opt.get("qspi_prescaler_default", 2), + }, + "optimization": {"enabled": False, **opt.get("opt_defaults", {}), "vendor_os": False}, + "gitignore": True, + "flash_scripts": True, + } + + +OPTION_KEYS = ("external_flash", "optimization", "gitignore", "flash_scripts") + + +def merge_options(sel, user): + """把 user 里的选项键合并进 sel(字典逐键覆盖)""" + for key in OPTION_KEYS: + if key not in user: + continue + if isinstance(sel.get(key), dict) and isinstance(user[key], dict): + sel[key].update(user[key]) + else: + sel[key] = user[key] + return sel + + +def default_switches(manifest, sel): + kinds = {p["kind"] for p in sel["peripherals"].values() if p["enabled"]} + out = {} + for sid, sw in manifest["switches"].items(): + need = sw.get("needs_ip") + out[sid] = sw["default"] if (need is None or need in kinds) else 0 + return out + + +def merge(ioc, manifest, user): + """用户给的(可能不完整的)选择 + 默认值 → 完整选择""" + sel = default_selection(ioc, manifest) + for ip, p in (user.get("peripherals") or {}).items(): + if ip not in sel["peripherals"]: + sel["peripherals"][ip] = {"kind": p.get("kind"), "enabled": bool(p.get("enabled")), "params": dict(p.get("params") or {}), "unknown": True} + continue + cur = sel["peripherals"][ip] + if "enabled" in p: + cur["enabled"] = bool(p["enabled"]) + cur["params"].update(p.get("params") or {}) + if "devices" in user: + sel["devices"] = [dict(d) for d in user["devices"]] + if "debug_uart" in user: + sel["debug_uart"] = user["debug_uart"] + sel["switches"] = default_switches(manifest, sel) + sel["switches"].update(user.get("switches") or {}) + merge_options(sel, user) + return sel + + +def by_kind(sel): + """给 checks.run 用:{"can": {ip: params}, ...}(只含选中的)""" + out = {} + for ip, p in sel["peripherals"].items(): + if p["enabled"]: + out.setdefault(p["kind"], {})[ip] = p["params"] + return out + + +def validate(ioc, manifest, sel): + """选择本身的问题(参数越界、设备依赖缺失、名字冲突等):[(level, where, msg)]""" + bad = [] + cands = {c["ip"]: c for c in candidates(ioc, manifest)} + names = set() + for ip, p in sel["peripherals"].items(): + if not p["enabled"]: + continue + c = cands.get(ip) + if c is None: + bad.append(("error", ip, ".ioc 里没有这个外设(或 CubeMX 没把它配成库能用的模式)")) + continue + if not c["usable"]: + bad.append(("error", ip, f"不能用作库实例:{c['reason']}")) + spec = {prm["key"]: prm for prm in manifest["peripherals"][c["kind"]]["params"]} + for k, v in p["params"].items(): + if k in spec: + bad += [("error", f"{ip}.{k}", m) for m in check_value(spec[k], v)] + names.add(c["instance"]) + if c["kind"] == "uart" and "baudrate" in p["params"] and int(p["params"]["baudrate"]) != c["facts"]["baudrate"]: + bad.append(("warn", f"{ip}.baudrate", f"{p['params']['baudrate']} 与 CubeMX 的 {c['facts']['baudrate']} 不一致:线路按 CubeMX 跑,库按这里估算卡死阈值——改 .ioc 或这里")) + if sel.get("debug_uart") and not sel["peripherals"].get(sel["debug_uart"], {}).get("enabled"): + bad.append(("error", "debug_uart", f"调试串口 {sel['debug_uart']} 没有选中")) + devs = manifest["devices"] + for i, d in enumerate(sel["devices"]): + where = f"devices[{i}]" + spec = devs.get(d.get("type")) + if spec is None: + bad.append(("error", where, f"不认识的设备类型 {d.get('type')}")) + continue + if spec["status"] == "planned": + bad.append(("error", where, f"{spec['title']} 还没实现(计划中)")) + continue + name = d.get("name", "") + if not re.fullmatch(r"[a-z_][a-z0-9_]*", name): + bad.append(("error", where, f"实例名 {name!r} 不合法(小写字母、数字、下划线)")) + elif name in names: + bad.append(("error", where, f"实例名 {name} 重复")) + names.add(name) + for need in spec["needs"]: + v = (d.get("needs") or {}).get(need["key"]) + if not v: + if not need.get("optional"): + bad.append(("error", f"{where}.{need['key']}", f"缺 {need['title']}")) + continue + bad += [("error", f"{where}.{need['key']}", m) for m in check_need(ioc, sel, need, v)] + pspec = {prm["key"]: prm for prm in spec["params"]} + for k, v in (d.get("params") or {}).items(): + if k not in pspec: + bad.append(("error", f"{where}.{k}", "不认识的参数")) + else: + bad += [("error", f"{where}.{k}", m) for m in check_value(pspec[k], v)] + for sw in spec.get("switches", []): + if not sel["switches"].get(sw): + bad.append(("error", where, f"{spec['title']} 需要 {sw} = 1")) + if d.get("type") == "dji_motor": + prm = {**{p["key"]: p.get("default") for p in spec["params"]}, **(d.get("params") or {})} + if prm.get("type") == "GM6020" and int(prm.get("id", 1)) > 7: + bad.append(("error", f"{where}.id", "GM6020 的 ID 只能是 1~7")) + # PWM 通道、编码器、GPIO 只能给一个设备用(总线可以多个设备共用) + owner = {} + for i, d in enumerate(sel["devices"]): + spec = devs.get(d.get("type")) + if not spec or spec["status"] == "planned": + continue + for need in spec["needs"]: + v = (d.get("needs") or {}).get(need["key"]) + if v and need["kind"] in ("pwm", "encoder", "gpio_out", "gpio_exti"): + if v in owner: + bad.append(("error", f"devices[{i}].{need['key']}", f"{v} 已经给 {owner[v]} 用了")) + else: + owner[v] = f"{d.get('name')}.{need['key']}" + for sid, v in sel["switches"].items(): + sw = manifest["switches"].get(sid) + if sw is None: + bad.append(("error", sid, "不认识的开关")) + continue + if v not in (0, 1): + bad.append(("error", sid, "只能是 0 或 1")) + for dep in sw.get("requires", []): + if v and not sel["switches"].get(dep): + bad.append(("error", sid, f"需要 {dep} = 1")) + bad += validate_options(ioc, manifest, sel) + return bad + + +def validate_options(ioc, manifest, sel): + bad = [] + opt = manifest.get("options", {}) + ef = sel.get("external_flash") or {} + if ef.get("layout") not in flash.LAYOUTS: + bad.append(("error", "external_flash.layout", f"只能是 {'/'.join(flash.LAYOUTS)}")) + if ef.get("enabled"): + a = flash.analyze(ioc, None, manifest) + if not a["supported"]: + bad.append(("error", "external_flash", a["note"] or ".ioc 没有启用 QUADSPI(外置 Flash 只支持 QUADSPI)")) + chip = flash.chip_for(manifest, ef.get("chip")) + if chip is None: + names = "、".join(c["name"] for c in manifest.get("flash_chips", [])) + bad.append(("error", "external_flash.chip", f"选一个芯片:{names}")) + try: + pre = int(ef.get("prescaler")) + except (TypeError, ValueError): + pre = -1 + if not 0 <= pre <= 255: + bad.append(("error", "external_flash.prescaler", "预分频 0~255")) + elif chip is not None and 240 / (pre + 1) > chip["max_mhz"]: + bad.append(("error", "external_flash.prescaler", + f"QSPI 时钟 {240 / (pre + 1):.0f} MHz 超过 {chip['name']} 的 {chip['max_mhz']} MHz(按应用 HCLK3 = 240 MHz 算)")) + elif chip is not None and chip.get("status") != "tested": + bad.append(("warn", "external_flash.chip", f"{chip['name']} 只做过编译验证,没有上板实测")) + op = sel.get("optimization") or {} + for bt in opt.get("build_types", []): + if op.get(bt) not in opt.get("opt_levels", []): + bad.append(("error", f"optimization.{bt}", f"只能是 {' '.join(opt.get('opt_levels', []))}")) + for key in ("gitignore", "flash_scripts"): + if not isinstance(sel.get(key, True), bool): + bad.append(("error", key, "只能是 true / false")) + return bad + + +def check_value(spec, v): + t = spec["type"] + try: + if t == "int": + x = int(v) + elif t == "float": + x = float(v) + elif t == "bool": + return [] if isinstance(v, bool) else ["要填 true / false"] + elif t == "enum": + return [] if v in spec["values"] else [f"只能是 {', '.join(spec['values'])}"] + elif t == "int_list": + xs = [int(e) for e in v] + if not xs: + return ["至少一个"] + return [f"{e} 超出 {spec['min']}~{spec['max']}" for e in xs if not spec["min"] <= e <= spec["max"]] + else: + return [f"不认识的类型 {t}"] + except (TypeError, ValueError): + return [f"不是合法的 {t}"] + if "min" in spec and x < spec["min"] or "max" in spec and x > spec["max"]: + return [f"{x} 超出 {spec['min']}~{spec['max']}"] + return [] + + +def check_need(ioc, sel, need, v): + kind = need["kind"] + if kind == "gpio_out": + return [] if v in ioc.gpio_outputs() else [f"{v} 不是带标签的 GPIO 输出(CubeMX 里给引脚配 GPIO_Output 并起标签)"] + if kind == "gpio_exti": + return [] if v in ioc.gpio_exti() else [f"{v} 不是带标签的 EXTI 引脚"] + p = sel["peripherals"].get(v) + if p is None or p["kind"] != kind: + return [f"{v} 不是 {kind} 外设"] + if not p["enabled"]: + return [f"{v} 没有选中"] + return [] + + +def device_catalog(ioc, manifest, sel): + """可挂设备:[{type, title, status, status_note, available, reason, needs: [{key, kind, title, optional, options}], params}] + 设备只在它依赖的外设(已选中)与功能开关都满足时 available;计划中的设备列出但不可选。""" + enabled = {} + cands = {c["ip"]: c for c in candidates(ioc, manifest)} + for ip, p in sel["peripherals"].items(): + if p["enabled"] and ip in cands: + enabled.setdefault(p["kind"], []).append(ip) + out = [] + for dtype, spec in manifest["devices"].items(): + item = {"type": dtype, "title": spec["title"], "status": spec["status"], "status_note": spec.get("status_note", ""), + "params": spec.get("params", []), "needs": [], "available": True, "reason": ""} + why = [] + for need in spec.get("needs", []): + kind = need["kind"] + if kind == "gpio_out": + opts = ioc.gpio_outputs() + elif kind == "gpio_exti": + opts = ioc.gpio_exti() + else: + opts = enabled.get(kind, []) + item["needs"].append({**need, "options": opts}) + if not opts and not need.get("optional"): + why.append(f"没有可用的{need['title']}") + if spec["status"] == "planned": + why.insert(0, "计划中,还没实现") + for sw in spec.get("switches", []): + if not sel["switches"].get(sw): + why.append(f"需要 {sw} = 1") + if why: + item["available"] = False + item["reason"] = ";".join(why) + out.append(item) + return out diff --git a/tools/icbsp_tool/sync.py b/tools/icbsp_tool/sync.py new file mode 100644 index 0000000..8abf840 --- /dev/null +++ b/tools/icbsp_tool/sync.py @@ -0,0 +1,156 @@ +""" +把 generate.py 算出的生成区内容同步进宿主文件(只算修改,写盘由 integrate.py 的 Plan 统一做)。 + +规则: + - 只改生成区,区外一律不动;内容和现在一样的区不算修改(可以重复运行) + - 文件不存在:从库模板新建(模板里带生成区),再填生成区 + - 文件存在但缺某个生成区(手写的文件):报错停下,提示把模板里的标记加进去 + - 生成区被手改过(结束标记里的哈希对不上):报错停下;加 --overwrite-edited 才覆盖 + - 区外的冲突:宿主别处已经定义了要生成的 HAL_GPIO_EXTI_Callback、或区外手写了同名实例:报错停下 +""" + +import json +import re +from pathlib import Path + +from . import regions as R + +TEMPLATES = Path(__file__).resolve().parent.parent.parent / "templates" / "user" / "board" +STEP = "生成" +SELECTION_FILE = "icbsp_selection.json" + + +def saved_selection(host, board_dir): + p = host / board_dir / SELECTION_FILE + try: + return json.loads(p.read_text(encoding="utf-8")) if p.is_file() else None + except ValueError: + return None + + +def target_files(host, board_dir): + board = host / board_dir + hw = board / "hardware_config.h" + legacy = host / "Core/Inc/hardware_config.h" + if not hw.exists() and legacy.exists(): + hw = legacy + return { + "board_cfg.hpp": board / "board_cfg.hpp", + "board_cfg.cpp": board / "board_cfg.cpp", + "board_instances.hpp": board / "board_instances.hpp", + "hardware_config.h": hw, + } + + +def _strip_regions(text): + """去掉所有生成区(用来查区外的内容)""" + regs, _ = R.parse(text) + lines = text.split("\n") + drop = set() + for r in regs.values(): + drop.update(range(r["begin"], r["end"] + 1)) + return "\n".join(l for i, l in enumerate(lines) if i not in drop) + + +def plan(host, board_dir, plan_obj, rep, gen, text_file_cls, overwrite_edited=False): + """把生成结果登记进 plan_obj;返回是否成功(有错误时 rep 里已记 error)""" + files = target_files(host, board_dir) + contents = gen.regions() + ok = True + changed, created = [], [] + pending = {} # path -> (TextFile 或 None, 文本) + for fname, path in files.items(): + if path in plan_obj.new_files: + text = plan_obj.new_files[path] + text = text.decode("utf-8") if isinstance(text, bytes) else text + tf = None + elif path.exists(): + tf = text_file_cls(path) + text = tf.text + else: + text = (TEMPLATES / fname).read_text(encoding="utf-8").replace("\r\n", "\n") + tf = None + created.append(path) + regs, bad = R.parse(text) + rel = path.relative_to(host).as_posix() + if bad: + rep.error(STEP, f"{rel}:生成区标记不完整({';'.join(bad)})") + ok = False + continue + missing = [r for r in contents[fname] if r not in regs] + if missing: + rep.error(STEP, f"{rel} 没有生成区 {', '.join(missing)}(手写的文件):把 templates/user/board/{fname} 里对应的 " + f"`// ` 标记加进来,或把文件改名后让 integrate.py 重新生成") + ok = False + continue + edited = [r for r in contents[fname] if regs[r]["recorded"] != regs[r]["actual"]] + if edited and not overwrite_edited: + rep.error(STEP, f"{rel} 的生成区 {', '.join(edited)} 被手改过:把改动挪到生成区外(或删掉改动)后重新运行;确认要丢掉改动就加 --overwrite-edited") + ok = False + continue + new = text + for r, body in contents[fname].items(): + new = R.replace(new, r, body) + if new != text: + changed.append(rel) + pending[path] = (tf, new) + + if not ok: + return False + + # 区外冲突 + outside = {p: _strip_regions(t) for p, (_, t) in pending.items()} + gen_names = set(gen.generated_names()) + for p, t in outside.items(): + code = re.sub(r"//[^\n]*|/\*.*?\*/", "", t, flags=re.S) + for name in sorted(gen_names): + # 实例是对象,只会以 name.xxx / (name) 出现;区外出现“name(”就是又定义了一次 + if re.search(rf"(? {instance}({{.hfdcan = &{handle}, .name = \"{label}\"}});", + "f4": "inline BspCanT<{rx_depth}, {tx_depth}> {instance}({{.hcan = &{handle}, .name = \"{label}\"}});" + }, + "init": ["ICBSP_CHECK({instance}.init() == Status::OK);"], + "rules": ["can_classic", "can_fifo", "can_auto_retx", "can_nvic", "can_msgram", "can_std_filters"] + }, + "uart": { + "title": "串口", + "ioc_ip": { "h7": "USART{n}|UART{n}|LPUART{n}", "f4": "USART{n}|UART{n}" }, + "instance": "bsp_{kind}{n}", + "handle": { "h7": "h{kind}{n}", "f4": "h{kind}{n}" }, + "include": "bsp/bsp_uart.hpp", + "cubemx_header": { "h7": "usart.h", "f4": "usart.h" }, + "list_macro": "ICBSP_UART_INSTANCES", + "params": [ + { "key": "mode", "title": "收发方式", "type": "enum", "values": ["dma", "it"], "default_from": "uart_mode" }, + { "key": "dir", "title": "方向", "type": "enum", "values": ["TxRx", "RxOnly", "TxOnly"], "default": "TxRx" }, + { "key": "rx_size", "title": "接收缓冲(字节)", "type": "int", "min": 16, "max": 4096, "default": 128 }, + { "key": "tx_size", "title": "发送缓冲(字节)", "type": "int", "min": 16, "max": 4096, "default": 128 }, + { "key": "baudrate", "title": "波特率(与 CubeMX 一致)", "type": "int", "min": 300, "max": 20000000, "default_from": "ioc_baudrate" } + ], + "declare": { + "h7": "inline {dma_attr}BspUartT {instance}({{.huart = &{handle}, .mode = UartDir::{dir}, .baudrate = {baudrate}U}});", + "f4": "inline {dma_attr}BspUartT {instance}({{.huart = &{handle}, .mode = UartDir::{dir}, .baudrate = {baudrate}U}});" + }, + "dma_buffer_when": { "mode": "dma" }, + "init": ["ICBSP_CHECK({instance}.init() == Status::OK);"], + "rules": ["uart_nvic", "uart_dma", "uart_bdma"] + }, + "spi": { + "title": "SPI 主机", + "ioc_ip": { "h7": "SPI{n}", "f4": "SPI{n}" }, + "instance": "bsp_spi{n}", + "handle": { "h7": "hspi{n}", "f4": "hspi{n}" }, + "include": "bsp/bsp_spi.hpp", + "cubemx_header": { "h7": "spi.h", "f4": "spi.h" }, + "list_macro": "ICBSP_SPI_INSTANCES", + "params": [ + { "key": "use_dma", "title": "长传输走 DMA", "type": "bool", "default_from": "spi_dma" }, + { "key": "dma_threshold", "title": "走 DMA 的最小长度(字节)", "type": "int", "min": 1, "max": 1024, "default": 16 } + ], + "declare": { + "h7": "inline {dma_attr}BspSpi {instance}({{.hspi = &{handle}, .use_dma = {use_dma}, .dma_threshold = {dma_threshold}U}});", + "f4": "inline {dma_attr}BspSpi {instance}({{.hspi = &{handle}, .use_dma = {use_dma}, .dma_threshold = {dma_threshold}U}});" + }, + "dma_buffer_when": { "use_dma": true }, + "init": ["ICBSP_CHECK({instance}.init() == Status::OK);"], + "rules": ["spi_master", "spi_8bit", "spi_keep_io", "spi_nvic"] + }, + "pwm": { + "title": "PWM 通道", + "ioc_ip": { "h7": "TIM{n}", "f4": "TIM{n}" }, + "instance": "bsp_pwm_tim{n}_ch{ch}", + "handle": { "h7": "htim{n}", "f4": "htim{n}" }, + "include": "bsp/bsp_pwm.hpp", + "cubemx_header": { "h7": "tim.h", "f4": "tim.h" }, + "list_macro": null, + "params": [ + { "key": "timer_clk_hz", "title": "定时器输入时钟(Hz)", "type": "int", "min": 1, "max": 600000000, "default_from": "ioc_timer_clock" }, + { "key": "prescaler", "title": "PSC(CubeMX 值)", "type": "int", "min": 0, "max": 65535, "default_from": "ioc_prescaler", "readonly": true }, + { "key": "period", "title": "ARR(CubeMX 值)", "type": "int", "min": 0, "max": 4294967295, "default_from": "ioc_period", "readonly": true } + ], + "declare": { + "h7": "inline BspPwm {instance}({{.htim = &{handle}, .channel = TIM_CHANNEL_{ch}, .timer_clk_hz = {timer_clk_hz}UL, .prescaler = {prescaler}U, .period = {period}U}});", + "f4": "inline BspPwm {instance}({{.htim = &{handle}, .channel = TIM_CHANNEL_{ch}, .timer_clk_hz = {timer_clk_hz}UL, .prescaler = {prescaler}U, .period = {period}U}});" + }, + "init": ["ICBSP_CHECK({instance}.init() == Status::OK);"], + "rules": [] + }, + "encoder": { + "title": "编码器(定时器编码器模式)", + "ioc_ip": { "h7": "TIM{n}", "f4": "TIM{n}" }, + "instance": "bsp_encoder_tim{n}", + "handle": { "h7": "htim{n}", "f4": "htim{n}" }, + "include": "bsp/bsp_encoder.hpp", + "cubemx_header": { "h7": "tim.h", "f4": "tim.h" }, + "list_macro": null, + "params": [ + { "key": "invert", "title": "计数方向取反", "type": "bool", "default": false } + ], + "declare": { + "h7": "inline BspEncoder {instance}({{.htim = &{handle}, .invert = {invert}}});", + "f4": "inline BspEncoder {instance}({{.htim = &{handle}, .invert = {invert}}});" + }, + "init": ["ICBSP_CHECK({instance}.init() == Status::OK);"], + "rules": ["encoder_period"] + } + }, + + "devices": { + "dji_motor": { + "title": "DJI 电机(M3508 / M2006 / GM6020)", + "status": "tested", + "status_note": "M3508、GM6020 实测;M2006 没有实物", + "include": "device/motor/dji_motor.hpp", + "needs": [{ "key": "bus", "kind": "can", "title": "所在 CAN 总线" }], + "switches": ["ICBSP_CAN_RX_ENABLE", "ICBSP_CAN_TX_ENABLE"], + "params": [ + { "key": "type", "title": "型号", "type": "enum", "values": ["M3508", "M2006", "GM6020"], "default": "M3508" }, + { "key": "id", "title": "电调 ID(M3508 / M2006 1~8,GM6020 1~7)", "type": "int", "min": 1, "max": 8, "default": 1 }, + { "key": "control", "title": "GM6020 控制模式(另两种型号忽略)", "type": "enum", "values": ["VOLTAGE", "CURRENT"], "default": "VOLTAGE" } + ], + "define": ["DjiMotor {name}({bus}, {id}U, 0.0f, 0.0f, DjiMotorControlMode::{control});"], + "extern": ["extern DjiMotor {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"] + }, + "dm_motor": { + "title": "达妙电机(J4310 / J4340P / J8009P)", + "status": "tested", + "status_note": "J4340P 实测(MIT);J4310 只读寄存器与反馈;J8009P 没有实物", + "include": "device/motor/dm_motor.hpp", + "needs": [{ "key": "bus", "kind": "can", "title": "所在 CAN 总线" }], + "switches": ["ICBSP_CAN_RX_ENABLE"], + "params": [ + { "key": "model", "title": "型号", "type": "enum", "values": ["J4310", "J4340P", "J4340P_V11", "J8009P", "UNKNOWN"], "default": "J4340P" }, + { "key": "can_id", "title": "CAN_ID(与 DJI 电机同总线时避开 0x01~0x0B、0xFE、0xFF、0x00)", "type": "int", "min": 1, "max": 255, "default": 16, "hex": true }, + { "key": "master_id", "title": "MST_ID(反馈帧 ID,每台不同)", "type": "int", "min": 1, "max": 2046, "default": 32, "hex": true }, + { "key": "mode", "title": "驱动器控制模式", "type": "enum", "values": ["MIT", "POS_VEL", "VEL"], "default": "MIT" } + ], + "define": ["DmMotor {name}({bus}, {{.model = DmModel::{model}, .can_id = {can_id}U, .master_id = {master_id}U, .mode = DmMode::{mode}}});"], + "extern": ["extern DmMotor {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"], + "notes": ["映射范围留 0:在任务里、system_start() 之后调 {name}.sync_ranges() 从驱动器读", "控制帧不走发送节点:控制任务要按周期持续调 set_*()"] + }, + "bmi088": { + "title": "BMI088 IMU(含 VQF 姿态)", + "status": "tested", + "status_note": "DM-MC02 板载 BMI088 实测", + "include": "device/sensor/device_bmi088.hpp", + "needs": [ + { "key": "bus", "kind": "spi", "title": "SPI 总线" }, + { "key": "acc_cs", "kind": "gpio_out", "title": "加速度计片选(带标签的 GPIO 输出)" }, + { "key": "gyro_cs", "kind": "gpio_out", "title": "陀螺仪片选" }, + { "key": "acc_int", "kind": "gpio_exti", "title": "加速度计 INT1(EXTI,可不接)", "optional": true }, + { "key": "gyro_int", "kind": "gpio_exti", "title": "陀螺仪 INT3(EXTI,姿态解算需要)", "optional": true } + ], + "switches": [], + "params": [ + { "key": "acc_range", "title": "加速度计量程", "type": "enum", "values": ["G3", "G6", "G12", "G24"], "default": "G24" }, + { "key": "gyro_range", "title": "陀螺仪量程", "type": "enum", "values": ["DPS2000", "DPS1000", "DPS500", "DPS250", "DPS125"], "default": "DPS2000" } + ], + "define": [ + "BspSpiDevice {name}_acc_spi({bus}, {{{acc_cs}_GPIO_Port, {acc_cs}_Pin, 0x80U, 1U}});", + "BspSpiDevice {name}_gyro_spi({bus}, {{{gyro_cs}_GPIO_Port, {gyro_cs}_Pin, 0x80U, 0U}});", + "DeviceBmi088 {name}({name}_acc_spi, {name}_gyro_spi, {{.acc_range = DeviceBmi088::AccRange::{acc_range}, .gyro_range = DeviceBmi088::GyroRange::{gyro_range}}});" + ], + "extern": ["extern BspSpiDevice {name}_acc_spi;", "extern BspSpiDevice {name}_gyro_spi;", "extern DeviceBmi088 {name};"], + "init": [ + "ICBSP_CHECK({name}_acc_spi.init() == Status::OK);", + "ICBSP_CHECK({name}_gyro_spi.init() == Status::OK);", + "ICBSP_CHECK({name}.init() == Status::OK);" + ], + "exti": [ + { "pin": "acc_int", "call": "{name}.on_acc_drdy_isr(&woken);" }, + { "pin": "gyro_int", "call": "{name}.on_gyro_drdy_isr(&woken);" } + ], + "notes": ["不要启动板载加热电阻的定时器(DM-MC02 的 PB1 / TIM3_CH4)"] + }, + "r9ds": { + "title": "R9DS 遥控接收机(SBUS)", + "status": "compile_only", + "include": "device/remote/device_r9ds.hpp", + "needs": [{ "key": "bus", "kind": "uart", "title": "SBUS 串口(100000 bit/s、8E2、反相)" }], + "switches": [], + "params": [], + "define": ["DeviceR9dsT {name}({bus});"], + "extern": ["extern DeviceR9dsT {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"] + }, + "emmv5_group": { + "title": "张大头 Emm_V5 步进闭环(一路串口多地址)", + "status": "compile_only", + "include": "device/motor/device_emmv5_group.hpp", + "needs": [{ "key": "bus", "kind": "uart", "title": "串口(RS485 / TTL)" }], + "switches": [], + "params": [ + { "key": "addrs", "title": "电机地址(逗号分隔,1~255)", "type": "int_list", "min": 1, "max": 255, "default": [1] }, + { "key": "checksum", "title": "校验方式(与驱动器菜单一致)", "type": "enum", "values": ["FIXED_6B", "XOR"], "default": "FIXED_6B" } + ], + "define": ["DeviceEmmv5GroupT {name}({{.uart = {bus}, .addr = {{{addrs}}}, .checksum = emmv5::Checksum::{checksum}}});"], + "extern": ["extern DeviceEmmv5GroupT {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"] + }, + "servo": { + "title": "舵机(PWM 脉宽)", + "status": "compile_only", + "include": "device/actuator/device_servo.hpp", + "needs": [{ "key": "pwm", "kind": "pwm", "title": "PWM 通道(50 Hz / 20 ms)" }], + "switches": [], + "params": [ + { "key": "range_deg", "title": "行程(度)", "type": "float", "min": 1, "max": 360, "default": 180 }, + { "key": "pulse_min_us", "title": "0° 脉宽(µs)", "type": "float", "min": 100, "max": 3000, "default": 500 }, + { "key": "pulse_max_us", "title": "满行程脉宽(µs)", "type": "float", "min": 100, "max": 3000, "default": 2500 } + ], + "define": ["DeviceServo {name}({{.pwm = &{pwm}, .pulse_min_us = {pulse_min_us}f, .pulse_max_us = {pulse_max_us}f, .range_deg = {range_deg}f}});"], + "extern": ["extern DeviceServo {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"] + }, + "buzzer": { + "title": "无源蜂鸣器", + "status": "board_use", + "status_note": "开机提示音,没有专门用例", + "include": "device/actuator/device_buzzer.hpp", + "needs": [{ "key": "pwm", "kind": "pwm", "title": "PWM 通道" }], + "switches": [], + "params": [], + "define": ["DeviceBuzzer {name}({pwm});"], + "extern": ["extern DeviceBuzzer {name};"], + "init": [] + }, + "device_motor": { + "title": "直流减速电机(H 桥两路 PWM + 编码器)", + "status": "compile_only", + "include": "device/motor/device_motor.hpp", + "needs": [ + { "key": "pwm_a", "kind": "pwm", "title": "H 桥 IN1" }, + { "key": "pwm_b", "kind": "pwm", "title": "H 桥 IN2" }, + { "key": "encoder", "kind": "encoder", "title": "同轴编码器" } + ], + "switches": [], + "params": [ + { "key": "encoder_lines", "title": "编码器线数", "type": "float", "min": 1, "max": 100000, "default": 500 }, + { "key": "gear_ratio", "title": "减速比", "type": "float", "min": 1, "max": 10000, "default": 30 }, + { "key": "wheel_diameter_cm", "title": "轮径(cm)", "type": "float", "min": 0.1, "max": 1000, "default": 6.5 } + ], + "define": ["DeviceMotor {name}({{.pwm_a = &{pwm_a}, .pwm_b = &{pwm_b}, .encoder = &{encoder}, .encoder_lines = {encoder_lines}f, .gear_ratio = {gear_ratio}f, .wheel_diameter_cm = {wheel_diameter_cm}f}});"], + "extern": ["extern DeviceMotor {name};"], + "init": ["ICBSP_CHECK({name}.init() == Status::OK);"], + "notes": ["PID 参数默认全 0,要按实机标定后写进 Config.pid"] + }, + "dr16": { "title": "DR16 接收机(DT7 遥控器)", "status": "planned", "needs": [{ "key": "bus", "kind": "uart", "title": "DBUS 串口" }] }, + "et08": { "title": "ET08 接收机", "status": "planned", "needs": [{ "key": "bus", "kind": "uart", "title": "串口" }] } + }, + + "switches": { + "ICBSP_SYS_TASK_ENABLE": { "title": "系统维护任务 sys_task", "default": 1, "needs_ip": null }, + "ICBSP_CAN_RX_ENABLE": { "title": "CAN 接收路径(can_rx_task + 接收节点)", "default": 1, "needs_ip": "can" }, + "ICBSP_CAN_TX_ENABLE": { "title": "CAN 发送路径(can_tx_task + 发送节点)", "default": 1, "needs_ip": "can" }, + "ICBSP_UART_PATROL_ENABLE": { "title": "sys_task 里的串口巡检", "default": 1, "needs_ip": "uart", "requires": ["ICBSP_SYS_TASK_ENABLE"] } + }, + + "flash_chips": [ + { "name": "W25Q64", "size": 8388608, "addr_bytes": 3, "jedec_manufacturer": 239, "jedec_capacity": 23, "max_mhz": 133, "status": "compile_only" }, + { "name": "W25Q128", "size": 16777216, "addr_bytes": 3, "jedec_manufacturer": 239, "jedec_capacity": 24, "max_mhz": 133, "status": "tested" }, + { "name": "W25Q256", "size": 33554432, "addr_bytes": 4, "jedec_manufacturer": 239, "jedec_capacity": 25, "max_mhz": 133, "status": "compile_only" } + ], + + "options": { + "flash_layouts": { + "INTERNAL": "片内 Flash(CubeMX 链接脚本)", + "QSPI_RAM": "方案 A:程序存 QSPI,bootloader 拷进 AXI SRAM 运行(推荐:全速、软件断点可用、时序与片内 Flash 接近)", + "QSPI_XIP": "方案 B:程序在 QSPI 上就地执行(容量大;cache 未命中时慢,只能打硬件断点)" + }, + "qspi_prescaler_default": 2, + "build_types": ["Debug", "RelWithDebInfo", "Release"], + "opt_levels": ["-O0", "-Og", "-O1", "-O2", "-O3", "-Os"], + "opt_defaults": { "Debug": "-O0", "RelWithDebInfo": "-O2", "Release": "-Os" } + }, + + "rules": { + "rtos_cmsis_v2": { "level": "error", "title": "FreeRTOS 接口是 CMSIS_V2", "fix": "Middleware → FREERTOS → Interface 选 CMSIS_V2", "auto_fix": false }, + "rtos_tick": { "level": "error", "title": "FreeRTOS tick 1 kHz", "fix": "FREERTOS → Config parameters → TICK_RATE_HZ = 1000", "auto_fix": true }, + "rtos_stack_check":{ "level": "error", "title": "栈溢出检查 Option2", "fix": "FREERTOS → CHECK_FOR_STACK_OVERFLOW = Option2", "auto_fix": true }, + "rtos_malloc_hook":{ "level": "error", "title": "分配失败钩子", "fix": "FREERTOS → USE_MALLOC_FAILED_HOOK = Enabled", "auto_fix": true }, + "rtos_default_task":{ "level": "warn", "title": "defaultTask 是 As weak", "fix": "FREERTOS → Tasks and Queues → defaultTask 的 Code Generation Option = As weak(As external 时要自己定义 StartDefaultTask 并转调 app_default_task)", "auto_fix": true }, + "toolchain_cmake": { "level": "error", "title": "工具链 CMake", "fix": "Project Manager → Toolchain / IDE = CMake", "auto_fix": true }, + "timebase_tim": { "level": "warn", "title": "HAL 时基不是 SysTick", "fix": "SYS → Timebase Source 选一个空闲 TIM。时基优先级不再要求高于串口 / CAN(1.4 起默认 15 即可,原来的 TICK_INT_PRIORITY < 5 已不需要)", "auto_fix": false }, + "dcache_off": { "level": "error", "title": "D-Cache 关闭(H7)", "fix": "CORTEX_M7 → CPU DCache = Disabled(库不做 Cache 维护)", "auto_fix": true }, + "can_classic": { "level": "error", "title": "FDCAN 用经典 CAN 帧格式", "fix": "FDCANx → Frame Format = Classic mode", "auto_fix": true }, + "can_fifo": { "level": "error", "title": "FDCAN 的 RX FIFO0 与 TX 元素数不为 0", "fix": "FDCANx → Rx Fifo0 Elmts Nbr、Tx Fifo Queue Elmts Nbr 填 16(CubeMX 默认都是 0:收不到也发不出)", "auto_fix": true }, + "can_auto_retx": { "level": "error", "title": "FDCAN 自动重发打开", "fix": "FDCANx → Auto Retransmission = Enable(CubeMX 默认 Disable:两个节点同时发时,仲裁输掉的帧直接丢弃,驱动的诊断计数里看不出来)", "auto_fix": true }, + "can_nvic": { "level": "error", "title": "FDCAN 中断线 0 打开", "fix": "NVIC → FDCANx interrupt 0 勾上", "auto_fix": true }, + "can_msgram": { "level": "error", "title": "几路 FDCAN 的 Message RAM 不重叠", "fix": "FDCANx → Message RAM Offset 依次错开(按各路占用字数累加)", "auto_fix": true }, + "can_std_filters": { "level": "warn", "title": "FDCAN 标准过滤器数 ≥ 1", "fix": "FDCANx → Std Filters Nbr = 1(填 0 也能收,靠全局过滤器)", "auto_fix": true }, + "uart_nvic": { "level": "error", "title": "串口全局中断打开", "fix": "NVIC → USARTx global interrupt 勾上(IDLE 断帧依赖它)", "auto_fix": true }, + "uart_dma": { "level": "warn", "title": "DMA 模式的串口 RX / TX 都配了 DMA、字节对齐", "fix": "USARTx → DMA Settings 加 RX、TX 两条,Data Width = Byte(RX 配 Normal 即可,库会改成循环)", "auto_fix": false }, + "uart_bdma": { "level": "error", "title": "BDMA 外设(LPUART1 等)不能用 DMA 模式", "fix": "收发方式选 it(中断)", "auto_fix": false }, + "spi_master": { "level": "error", "title": "SPI 全双工主机、软件 NSS", "fix": "SPIx → Mode = Full-Duplex Master,Hardware NSS Signal = Disable", "auto_fix": false }, + "spi_8bit": { "level": "error", "title": "SPI 帧长 8 位", "fix": "SPIx → Data Size = 8 Bits(H7 的 CubeMX 默认是 4 Bits,传输会卡死)", "auto_fix": true }, + "spi_bmi088_speed":{ "level": "error", "title": "BMI088 的 SPI 时钟 ≤ 10 MHz", "fix": "SPIx → Prescaler (for Baud Rate) 调大,使 SCK ≤ 10 MHz(BMI088 数据手册上限)", "auto_fix": true }, + "spi_keep_io": { "level": "error", "title": "SPI Master Keep IO State = Enable(H7)", "fix": "SPIx → Advanced Parameters → Master Keep IO State = Enabled", "auto_fix": true }, + "spi_nvic": { "level": "warn", "title": "SPI 用 DMA 时开 SPI 全局中断", "fix": "NVIC → SPIx global interrupt 勾上", "auto_fix": true }, + "encoder_period": { "level": "error", "title": "编码器定时器的 Period 是计数器最大值", "fix": "TIMx → Counter Period = 0xFFFF(32 位定时器 0xFFFFFFFF)", "auto_fix": true }, + "qspi_params": { "level": "warn", "title": "QUADSPI 参数与外置 Flash 芯片一致", "fix": "QUADSPI → Flash Size、Clock Prescaler、Sample Shifting = Half Cycle、Chip Select High Time,QSPI 引脚速度 Very High(只影响应用自己用 QSPI;bootloader 不读这些)", "auto_fix": true } + } +} diff --git a/tools/qspi_image.py b/tools/qspi_image.py new file mode 100644 index 0000000..ef16d17 --- /dev/null +++ b/tools/qspi_image.py @@ -0,0 +1,224 @@ +#!/usr/bin/env python3 +"""icbsp:外置 QSPI Flash 镜像工具(构建后由 cmake/icbsp_flash.cmake 自动调用) + +镜像在 QSPI 里的布局(两种方案相同): + + 0x90000000 镜像头(32 字节有效,补 0xFF 到 1 KB) + 0x90000400 载荷:方案 A 是要拷进 AXI SRAM 的程序,方案 B 是就地执行的程序(向量表在开头) + +镜像头(小端,全部 uint32): + + 0 magic 'ICBI'(0x49424349) + 4 version 1 + 8 layout 1 = QSPI_RAM(方案 A),2 = QSPI_XIP(方案 B) + 12 load_addr 载荷要放到的地址(A:AXI SRAM 起点;B:0x90000400) + 16 vector_addr 向量表地址(= load_addr) + 20 size 载荷字节数(4 字节对齐) + 24 payload_crc 载荷的 CRC-32(zlib 算法,与 bootloader 里 CRC 外设的配置一致) + 28 header_crc 前 28 字节的 CRC-32 + +方案 A:ELF 的运行地址和加载地址都在 AXI SRAM(调试器可直接下载进 RAM),本工具另外生成 + <名字>_qspi.bin / .hex(头 + 载荷,地址 0x90000000)用于写 QSPI。 +方案 B:链接脚本在 0x90000000 预留了 .icbsp_image_header 段,本工具把算好的头写回 ELF, + 所以调试器直接下载 ELF 也能得到有效镜像;同样生成 _qspi.bin / .hex。 + +只用标准库;用法见 --help。 +""" +from __future__ import annotations + +import argparse +import struct +import sys +import zlib +from pathlib import Path + +MAGIC = 0x49424349 # b"ICBI" +VERSION = 1 +LAYOUTS = {"ram": 1, "xip": 2} +QSPI_BASE = 0x90000000 +HEADER_SIZE = 0x400 +HEADER_FMT = "<8I" +TAIL_GUARD = 0x1000 # 芯片最后 4 KB:bootloader 用 MPU 禁止访问(QUADSPI 预取越过芯片末尾会挂死总线) +PT_LOAD = 1 + + +class ImageError(Exception): + pass + + +# ---------------------------------------------------------------- ELF + + +SHT_NOBITS = 8 +SHF_ALLOC = 0x2 + + +def load_segments(elf: bytes) -> list[tuple[int, int, bytes]]: + """返回 [(加载地址 LMA, 文件偏移, 数据)](ELF32 小端)。 + + 按“有内容的 ALLOC 段(section)”取,再用所在 PT_LOAD 换算加载地址:ld 有时把 ELF 头本身映射进 + 第一个 PT_LOAD(例如 0x20000000 处只有 .bss 的段),按 segment 取会把这些头字节当成程序。 + """ + if elf[:4] != b"\x7fELF": + raise ImageError("不是 ELF 文件") + if elf[4] != 1 or elf[5] != 1: + raise ImageError("只支持 32 位小端 ELF") + (e_phoff, e_shoff) = struct.unpack_from(" 0: + phdrs.append((p_offset, p_filesz, p_paddr)) + segs = [] + for i in range(e_shnum): + _name, sh_type, sh_flags, _addr, sh_offset, sh_size = struct.unpack_from("<6I", elf, e_shoff + i * e_shentsize) + if not (sh_flags & SHF_ALLOC) or sh_type == SHT_NOBITS or sh_size == 0: + continue + for p_offset, p_filesz, p_paddr in phdrs: + if p_offset <= sh_offset and sh_offset + sh_size <= p_offset + p_filesz: + segs.append((p_paddr + (sh_offset - p_offset), sh_offset, elf[sh_offset : sh_offset + sh_size])) + break + else: + raise ImageError(f"有内容的段(文件偏移 0x{sh_offset:X})不在任何 PT_LOAD 里") + if not segs: + raise ImageError("ELF 里没有可加载的段") + return sorted(segs) + + +def flatten(segs, start: int, fill: int) -> bytes: + """把 [start, 最高地址) 范围内的段拼成连续字节,空隙用 fill 填充。""" + end = max(addr + len(data) for addr, _, data in segs) + out = bytearray([fill]) * (end - start) + for addr, _, data in segs: + if addr < start: + raise ImageError(f"段地址 0x{addr:08X} 低于载荷起点 0x{start:08X}") + out[addr - start : addr - start + len(data)] = data + while len(out) % 4: + out.append(fill) + return bytes(out) + + +# ---------------------------------------------------------------- 头 + + +def crc32(data: bytes) -> int: + return zlib.crc32(data) & 0xFFFFFFFF + + +def make_header(layout: int, load_addr: int, payload: bytes) -> bytes: + head = struct.pack("<7I", MAGIC, VERSION, layout, load_addr, load_addr, len(payload), crc32(payload)) + return head + struct.pack(" dict: + fields = struct.unpack_from(HEADER_FMT, raw, 0) + keys = ("magic", "version", "layout", "load_addr", "vector_addr", "size", "payload_crc", "header_crc") + h = dict(zip(keys, fields)) + h["header_ok"] = h["magic"] == MAGIC and crc32(raw[:28]) == h["header_crc"] + return h + + +# ---------------------------------------------------------------- 输出 + + +def intel_hex(data: bytes, base: int) -> str: + lines = [] + + def rec(rtype: int, addr: int, payload: bytes) -> str: + body = bytes([len(payload), (addr >> 8) & 0xFF, addr & 0xFF, rtype]) + payload + return ":" + body.hex().upper() + f"{(-sum(body)) & 0xFF:02X}" + + upper = None + for off in range(0, len(data), 16): + addr = base + off + if addr >> 16 != upper: + upper = addr >> 16 + lines.append(rec(4, 0, struct.pack(">H", upper))) + lines.append(rec(0, addr & 0xFFFF, data[off : off + 16])) + lines.append(rec(1, 0, b"")) + return "\n".join(lines) + "\n" + + +def build(elf_path: Path, layout_name: str, out_dir: Path, qspi_size: int, ram_base: int, ram_size: int) -> dict: + elf = bytearray(elf_path.read_bytes()) + segs = load_segments(bytes(elf)) + layout = LAYOUTS[layout_name] + + if layout_name == "ram": + lo = min(addr for addr, _, _ in segs) + for addr, _, data in segs: + if not (ram_base <= addr and addr + len(data) <= ram_base + ram_size): + raise ImageError( + f"方案 A 的 ELF 里有不在 AXI SRAM(0x{ram_base:08X}+{ram_size // 1024}K)的可加载段:" + f"0x{addr:08X},长度 {len(data)}" + ) + if lo != ram_base: + raise ImageError(f"方案 A 的向量表应在 0x{ram_base:08X},实际最低加载地址 0x{lo:08X}") + load_addr = ram_base + payload = flatten(segs, load_addr, 0x00) + if len(payload) > qspi_size - HEADER_SIZE - TAIL_GUARD: + raise ImageError(f"镜像 {len(payload)} 字节超出 QSPI 可用容量(末尾 4 KB 由 MPU 禁止访问)") + header = make_header(layout, load_addr, payload) + else: + load_addr = QSPI_BASE + HEADER_SIZE + head_seg = [s for s in segs if s[0] <= QSPI_BASE < s[0] + len(s[2])] + if not head_seg: + raise ImageError("方案 B 的 ELF 在 0x90000000 没有 .icbsp_image_header 段(链接脚本不对?)") + for addr, _, data in segs: + if addr < QSPI_BASE or addr + len(data) > QSPI_BASE + qspi_size: + raise ImageError(f"方案 B 的 ELF 里有不在 QSPI 的可加载段:0x{addr:08X},长度 {len(data)}") + # 从 0x90000000 拼成整块,前 1 KB 是镜像头(链接脚本里补到了 0x400),其后是载荷 + flat = flatten(segs, QSPI_BASE, 0xFF) + if len(flat) <= HEADER_SIZE: + raise ImageError("方案 B 的 ELF 在镜像头之后没有内容") + payload = flat[HEADER_SIZE:] + if len(payload) > qspi_size - HEADER_SIZE - TAIL_GUARD: + raise ImageError(f"镜像 {len(payload)} 字节超出 QSPI 可用容量(末尾 4 KB 由 MPU 禁止访问)") + header = make_header(layout, load_addr, payload) + paddr, off, _ = head_seg[0] + pos = off + (QSPI_BASE - paddr) + old = parse_header(bytes(elf[pos : pos + 32])) + if old["magic"] != MAGIC: + raise ImageError("0x90000000 处不是 icbsp 镜像头(magic 不对)") + elf[pos : pos + 32] = header + elf_path.write_bytes(bytes(elf)) + + image = header + b"\xff" * (HEADER_SIZE - len(header)) + payload + stem = elf_path.stem + "_qspi" + out_dir.mkdir(parents=True, exist_ok=True) + (out_dir / f"{stem}.bin").write_bytes(image) + (out_dir / f"{stem}.hex").write_text(intel_hex(image, QSPI_BASE), encoding="ascii") + h = parse_header(header) + h.update(bin=str(out_dir / f"{stem}.bin"), hex=str(out_dir / f"{stem}.hex"), layout_name=layout_name) + return h + + +def main(argv=None) -> int: + ap = argparse.ArgumentParser(description="生成 icbsp 外置 QSPI Flash 镜像(头 + 载荷)") + ap.add_argument("--elf", required=True, type=Path) + ap.add_argument("--layout", required=True, choices=sorted(LAYOUTS)) + ap.add_argument("--out-dir", type=Path, help="输出目录(默认与 ELF 相同)") + ap.add_argument("--qspi-size", type=lambda s: int(s, 0), default=16 << 20) + ap.add_argument("--ram-base", type=lambda s: int(s, 0), default=0x24000000) + ap.add_argument("--ram-size", type=lambda s: int(s, 0), default=512 << 10) + ap.add_argument("--quiet", action="store_true") + a = ap.parse_args(argv) + try: + h = build(a.elf, a.layout, a.out_dir or a.elf.parent, a.qspi_size, a.ram_base, a.ram_size) + except (ImageError, OSError) as e: + print(f"qspi_image: 错误:{e}", file=sys.stderr) + return 1 + if not a.quiet: + name = "QSPI_RAM(方案 A)" if h["layout"] == 1 else "QSPI_XIP(方案 B)" + print( + f"qspi_image: {name} 载荷 {h['size']} 字节 → 0x{h['load_addr']:08X}," + f"CRC 0x{h['payload_crc']:08X};{h['hex']}" + ) + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/tools/tests/cases/h750_qspi.json b/tools/tests/cases/h750_qspi.json new file mode 100644 index 0000000..3fc2c28 --- /dev/null +++ b/tools/tests/cases/h750_qspi.json @@ -0,0 +1,8 @@ +{ + "ioc": "h750_qspi.ioc", + "args": ["--external-flash", "QSPI_RAM", "--flash-chip", "W25Q128"], + "presets": ["Debug-QspiRam", "Debug-QspiXip", "RelWithDebInfo-Internal"], + "selection": { + "external_flash": { "enabled": true, "layout": "QSPI_RAM", "chip": "W25Q128", "prescaler": 2 } + } +} diff --git a/tools/tests/cases/mc02_alt.json b/tools/tests/cases/mc02_alt.json new file mode 100644 index 0000000..d694ec0 --- /dev/null +++ b/tools/tests/cases/mc02_alt.json @@ -0,0 +1,128 @@ +{ + "ioc": "mc02_h723.ioc", + "selection": { + "peripherals": { + "FDCAN2": { + "enabled": false + }, + "FDCAN1": { + "params": { + "rx_depth": 32, + "tx_depth": 8 + } + }, + "USART2": { + "enabled": false + }, + "USART3": { + "enabled": false + }, + "UART4": { + "enabled": false + }, + "UART7": { + "enabled": false + }, + "UART9": { + "enabled": false + }, + "USART10": { + "enabled": false + }, + "SPI2": { + "enabled": false + }, + "USART1": { + "params": { + "mode": "it", + "rx_size": 64, + "tx_size": 256 + } + }, + "UART5": { + "params": { + "dir": "RxOnly", + "baudrate": 100000 + } + }, + "TIM1_CH1": { + "enabled": true + }, + "TIM2_CH3": { + "enabled": true + } + }, + "devices": [ + { + "type": "dji_motor", + "name": "gimbal_yaw", + "needs": { + "bus": "FDCAN1" + }, + "params": { + "type": "GM6020", + "id": 2, + "control": "CURRENT" + } + }, + { + "type": "dm_motor", + "name": "joint", + "needs": { + "bus": "FDCAN3" + }, + "params": { + "model": "J8009P", + "can_id": 17, + "master_id": 33, + "mode": "POS_VEL" + } + }, + { + "type": "servo", + "name": "hatch", + "needs": { + "pwm": "TIM1_CH1" + }, + "params": { + "range_deg": 270, + "pulse_min_us": 500, + "pulse_max_us": 2500 + } + }, + { + "type": "buzzer", + "name": "beeper", + "needs": { + "pwm": "TIM2_CH3" + } + }, + { + "type": "r9ds", + "name": "rc", + "needs": { + "bus": "UART5" + } + }, + { + "type": "emmv5_group", + "name": "steppers", + "needs": { + "bus": "UART8" + }, + "params": { + "addrs": [ + 1, + 2, + 3 + ], + "checksum": "XOR" + } + } + ], + "switches": { + "ICBSP_UART_PATROL_ENABLE": 0 + }, + "debug_uart": "USART1" + } +} \ No newline at end of file diff --git a/tools/tests/cases/mc02_full.json b/tools/tests/cases/mc02_full.json new file mode 100644 index 0000000..fedddc0 --- /dev/null +++ b/tools/tests/cases/mc02_full.json @@ -0,0 +1,52 @@ +{ + "ioc": "mc02_h723.ioc", + "selection": { + "peripherals": { + "FDCAN3": { + "enabled": false + }, + "UART4": { + "enabled": false + }, + "UART5": { + "enabled": false + }, + "UART8": { + "enabled": false + }, + "UART9": { + "enabled": false + }, + "USART10": { + "params": { + "rx_size": 256, + "tx_size": 256 + } + }, + "TIM12_CH2": { + "enabled": true + } + }, + "devices": [ + { + "type": "bmi088", + "name": "imu_bmi088", + "needs": { + "bus": "SPI2", + "acc_cs": "GYRO_ACC_CS", + "gyro_cs": "GYRO_GYRO_CS", + "acc_int": "GYRO_ACC_INT", + "gyro_int": "GYRO_GYRO_INT" + } + }, + { + "type": "buzzer", + "name": "buzzer", + "needs": { + "pwm": "TIM12_CH2" + } + } + ], + "debug_uart": "USART1" + } +} \ No newline at end of file diff --git a/tools/tests/compile_test.py b/tools/tests/compile_test.py new file mode 100644 index 0000000..876e535 --- /dev/null +++ b/tools/tests/compile_test.py @@ -0,0 +1,92 @@ +#!/usr/bin/env python3 +""" +生成结果的编译测试(阶段 5.9):对每个用例 tests/cases/*.json, + 1. 把用例的 .ioc 放进空目录,用 STM32CubeMX 命令行生成一个全新工程(从没接入过本库); + 2. 把本库拷进 third_party/icbsp; + 3. integrate.py --apply <用例的选择> 从零完整接入(链接脚本、FreeRTOS、模板、CMake……)并生成板级代码; + 4. cmake --preset Debug && cmake --build --preset Debug,要求 0 error、0 warning。 + + python3 tools/tests/compile_test.py [工作目录] [--cubemx <目录>] [--case <名字>] + +需要:arm-none-eabi-gcc(PATH 或 /opt/arm-none-eabi/bin)、cmake、ninja、STM32CubeMX(桌面上别开着它)。退出码 = 失败的用例数。 +""" + +import argparse +import json +import os +import re +import shutil +import subprocess +import sys +import tempfile +from pathlib import Path + +HERE = Path(__file__).resolve().parent +LIB = HERE.parent.parent +sys.path.insert(0, str(HERE.parent)) +from icbsp_tool import cubemx # noqa: E402 + + +def sh(cmd, cwd, env=None): + p = subprocess.run(cmd, cwd=cwd, capture_output=True, text=True, env=env) + return p.returncode, p.stdout + p.stderr + + +def run_case(case, work, cubemx_dir): + c = json.loads(case.read_text(encoding="utf-8")) + name = case.stem + proj = work / name + if proj.exists(): + shutil.rmtree(proj) + proj.mkdir(parents=True) + ioc = proj / f"{name}.ioc" + text = (HERE / "fixtures" / c["ioc"]).read_text(encoding="utf-8") + text = re.sub(r"^ProjectManager\.ProjectName=.*$", f"ProjectManager.ProjectName={name}", text, flags=re.M) + text = re.sub(r"^ProjectManager\.ProjectFileName=.*$", f"ProjectManager.ProjectFileName={name}.ioc", text, flags=re.M) + ioc.write_text(text, encoding="utf-8") + ok, msg, tail = cubemx.regenerate(ioc, cubemx_dir) + if not ok or not (proj / "CMakeLists.txt").exists(): + return False, f"CubeMX 生成失败:{msg}\n{tail}" + shutil.copytree(LIB, proj / "third_party" / "icbsp", ignore=shutil.ignore_patterns(".git", "build", "__pycache__", "tests")) + sel = proj / "selection.json" + sel.write_text(json.dumps(c["selection"], ensure_ascii=False), encoding="utf-8") + code, out = sh([sys.executable, "third_party/icbsp/tools/integrate.py", "--host", str(proj), "--apply", str(sel), + "--no-vscode", "--no-flash", "--no-clang", *c.get("args", [])], proj) + if code != 0: + return False, f"integrate.py 失败({code}):\n{out[-3000:]}" + env = dict(os.environ, PATH="/opt/arm-none-eabi/bin:" + os.environ.get("PATH", "")) + sizes = [] + # presets:要编译的 CMake 预设(默认只编 Debug);外置 Flash 用例会编 *-QspiRam / *-QspiXip / *-Internal + for preset in c.get("presets", ["Debug"]): + code, out = sh(["cmake", "--preset", preset], proj, env) + if code != 0: + return False, f"{preset}:cmake 配置失败:\n{out[-3000:]}" + code, out = sh(["cmake", "--build", "--preset", preset], proj, env) + warn = sorted({l for l in out.splitlines() if re.search(r"\b(warning|error):", l)}) + if code != 0 or warn: + return False, f"{preset}:编译{'失败' if code else '有警告'}:\n" + "\n".join(warn[:30]) + ("" if warn else out[-3000:]) + used = re.findall(r"^\s+(FLASH|RAM|QSPI):\s+(\d+ B)", out, re.M) + sizes.append(f"{preset}(" + ",".join(f"{r} {b}" for r, b in used if b != "0 B") + ")") + return True, "0 error / 0 warning:" + ";".join(sizes) + + +def main(): + ap = argparse.ArgumentParser() + ap.add_argument("work", nargs="?", type=Path, default=Path(tempfile.gettempdir()) / f"icbsp_compile_{os.getpid()}") + ap.add_argument("--cubemx") + ap.add_argument("--case") + a = ap.parse_args() + cases = sorted((HERE / "cases").glob("*.json")) + if a.case: + cases = [c for c in cases if c.stem == a.case] + bad = 0 + for case in cases: + ok, msg = run_case(case, a.work.resolve(), a.cubemx) + print(f"{'PASS' if ok else 'FAIL'} {case.stem}: {msg}", flush=True) + bad += 0 if ok else 1 + print(f"工作目录:{a.work}") + return bad + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/tools/tests/fixtures/defaults_h723.ioc b/tools/tests/fixtures/defaults_h723.ioc new file mode 100644 index 0000000..4e0cad4 --- /dev/null +++ b/tools/tests/fixtures/defaults_h723.ioc @@ -0,0 +1,923 @@ +#MicroXplorer Configuration settings - do not modify +CAD.formats= +CAD.pinconfig= +CAD.provider= +CORTEX_M7.BaseAddress-Cortex_Memory_Protection_Unit_Region0_Settings=0x24000000 +CORTEX_M7.CPU_DCache=Disabled +CORTEX_M7.CPU_ICache=Disabled +CORTEX_M7.Enable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_REGION_ENABLE +CORTEX_M7.IPParameters=CPU_DCache,CPU_ICache,MPU_Control,Enable-Cortex_Memory_Protection_Unit_Region0_Settings,BaseAddress-Cortex_Memory_Protection_Unit_Region0_Settings,Size-Cortex_Memory_Protection_Unit_Region0_Settings,TypeExtField-Cortex_Memory_Protection_Unit_Region0_Settings,IsCacheable-Cortex_Memory_Protection_Unit_Region0_Settings,IsBufferable-Cortex_Memory_Protection_Unit_Region0_Settings +CORTEX_M7.IsBufferable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_ACCESS_BUFFERABLE +CORTEX_M7.IsCacheable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_ACCESS_CACHEABLE +CORTEX_M7.MPU_Control=__NULL +CORTEX_M7.Size-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_REGION_SIZE_512B +CORTEX_M7.TypeExtField-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_TEX_LEVEL1 +Dma.Request0=USART1_RX +Dma.Request1=USART1_TX +Dma.Request10=USART10_RX +Dma.Request11=USART10_TX +Dma.Request12=UART5_RX +Dma.Request13=USART3_RX +Dma.Request14=USART3_TX +Dma.Request2=UART4_RX +Dma.Request3=UART4_TX +Dma.Request4=UART7_RX +Dma.Request5=UART7_TX +Dma.Request6=SPI2_RX +Dma.Request7=SPI2_TX +Dma.Request8=USART2_RX +Dma.Request9=USART2_TX +Dma.RequestsNb=15 +Dma.SPI2_RX.6.Direction=DMA_PERIPH_TO_MEMORY +Dma.SPI2_RX.6.EventEnable=DISABLE +Dma.SPI2_RX.6.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.SPI2_RX.6.Instance=DMA1_Stream0 +Dma.SPI2_RX.6.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.SPI2_RX.6.MemInc=DMA_MINC_ENABLE +Dma.SPI2_RX.6.Mode=DMA_NORMAL +Dma.SPI2_RX.6.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.SPI2_RX.6.PeriphInc=DMA_PINC_DISABLE +Dma.SPI2_RX.6.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.SPI2_RX.6.Priority=DMA_PRIORITY_HIGH +Dma.SPI2_RX.6.RequestNumber=1 +Dma.SPI2_RX.6.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.SPI2_RX.6.SignalID=NONE +Dma.SPI2_RX.6.SyncEnable=DISABLE +Dma.SPI2_RX.6.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.SPI2_RX.6.SyncRequestNumber=1 +Dma.SPI2_RX.6.SyncSignalID=NONE +Dma.SPI2_TX.7.Direction=DMA_MEMORY_TO_PERIPH +Dma.SPI2_TX.7.EventEnable=DISABLE +Dma.SPI2_TX.7.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.SPI2_TX.7.Instance=DMA1_Stream7 +Dma.SPI2_TX.7.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.SPI2_TX.7.MemInc=DMA_MINC_ENABLE +Dma.SPI2_TX.7.Mode=DMA_NORMAL +Dma.SPI2_TX.7.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.SPI2_TX.7.PeriphInc=DMA_PINC_DISABLE +Dma.SPI2_TX.7.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.SPI2_TX.7.Priority=DMA_PRIORITY_LOW +Dma.SPI2_TX.7.RequestNumber=1 +Dma.SPI2_TX.7.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.SPI2_TX.7.SignalID=NONE +Dma.SPI2_TX.7.SyncEnable=DISABLE +Dma.SPI2_TX.7.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.SPI2_TX.7.SyncRequestNumber=1 +Dma.SPI2_TX.7.SyncSignalID=NONE +Dma.UART4_RX.2.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART4_RX.2.EventEnable=DISABLE +Dma.UART4_RX.2.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART4_RX.2.Instance=DMA1_Stream3 +Dma.UART4_RX.2.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_RX.2.MemInc=DMA_MINC_ENABLE +Dma.UART4_RX.2.Mode=DMA_NORMAL +Dma.UART4_RX.2.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_RX.2.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_RX.2.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_RX.2.Priority=DMA_PRIORITY_LOW +Dma.UART4_RX.2.RequestNumber=1 +Dma.UART4_RX.2.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_RX.2.SignalID=NONE +Dma.UART4_RX.2.SyncEnable=DISABLE +Dma.UART4_RX.2.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_RX.2.SyncRequestNumber=1 +Dma.UART4_RX.2.SyncSignalID=NONE +Dma.UART4_TX.3.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART4_TX.3.EventEnable=DISABLE +Dma.UART4_TX.3.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.UART4_TX.3.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.UART4_TX.3.Instance=DMA1_Stream4 +Dma.UART4_TX.3.MemBurst=DMA_MBURST_SINGLE +Dma.UART4_TX.3.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_TX.3.MemInc=DMA_MINC_ENABLE +Dma.UART4_TX.3.Mode=DMA_NORMAL +Dma.UART4_TX.3.PeriphBurst=DMA_PBURST_SINGLE +Dma.UART4_TX.3.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_TX.3.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_TX.3.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_TX.3.Priority=DMA_PRIORITY_LOW +Dma.UART4_TX.3.RequestNumber=1 +Dma.UART4_TX.3.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_TX.3.SignalID=NONE +Dma.UART4_TX.3.SyncEnable=DISABLE +Dma.UART4_TX.3.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_TX.3.SyncRequestNumber=1 +Dma.UART4_TX.3.SyncSignalID=NONE +Dma.UART5_RX.12.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART5_RX.12.EventEnable=DISABLE +Dma.UART5_RX.12.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART5_RX.12.Instance=DMA2_Stream5 +Dma.UART5_RX.12.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART5_RX.12.MemInc=DMA_MINC_ENABLE +Dma.UART5_RX.12.Mode=DMA_NORMAL +Dma.UART5_RX.12.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART5_RX.12.PeriphInc=DMA_PINC_DISABLE +Dma.UART5_RX.12.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART5_RX.12.Priority=DMA_PRIORITY_LOW +Dma.UART5_RX.12.RequestNumber=1 +Dma.UART5_RX.12.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART5_RX.12.SignalID=NONE +Dma.UART5_RX.12.SyncEnable=DISABLE +Dma.UART5_RX.12.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART5_RX.12.SyncRequestNumber=1 +Dma.UART5_RX.12.SyncSignalID=NONE +Dma.UART7_RX.4.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART7_RX.4.EventEnable=DISABLE +Dma.UART7_RX.4.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART7_RX.4.Instance=DMA1_Stream5 +Dma.UART7_RX.4.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART7_RX.4.MemInc=DMA_MINC_ENABLE +Dma.UART7_RX.4.Mode=DMA_NORMAL +Dma.UART7_RX.4.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART7_RX.4.PeriphInc=DMA_PINC_DISABLE +Dma.UART7_RX.4.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART7_RX.4.Priority=DMA_PRIORITY_LOW +Dma.UART7_RX.4.RequestNumber=1 +Dma.UART7_RX.4.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART7_RX.4.SignalID=NONE +Dma.UART7_RX.4.SyncEnable=DISABLE +Dma.UART7_RX.4.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART7_RX.4.SyncRequestNumber=1 +Dma.UART7_RX.4.SyncSignalID=NONE +Dma.UART7_TX.5.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART7_TX.5.EventEnable=DISABLE +Dma.UART7_TX.5.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.UART7_TX.5.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.UART7_TX.5.Instance=DMA1_Stream6 +Dma.UART7_TX.5.MemBurst=DMA_MBURST_SINGLE +Dma.UART7_TX.5.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART7_TX.5.MemInc=DMA_MINC_ENABLE +Dma.UART7_TX.5.Mode=DMA_NORMAL +Dma.UART7_TX.5.PeriphBurst=DMA_PBURST_SINGLE +Dma.UART7_TX.5.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART7_TX.5.PeriphInc=DMA_PINC_DISABLE +Dma.UART7_TX.5.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART7_TX.5.Priority=DMA_PRIORITY_LOW +Dma.UART7_TX.5.RequestNumber=1 +Dma.UART7_TX.5.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART7_TX.5.SignalID=NONE +Dma.UART7_TX.5.SyncEnable=DISABLE +Dma.UART7_TX.5.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART7_TX.5.SyncRequestNumber=1 +Dma.UART7_TX.5.SyncSignalID=NONE +Dma.USART10_RX.10.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART10_RX.10.EventEnable=DISABLE +Dma.USART10_RX.10.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART10_RX.10.Instance=DMA2_Stream3 +Dma.USART10_RX.10.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART10_RX.10.MemInc=DMA_MINC_ENABLE +Dma.USART10_RX.10.Mode=DMA_NORMAL +Dma.USART10_RX.10.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART10_RX.10.PeriphInc=DMA_PINC_DISABLE +Dma.USART10_RX.10.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART10_RX.10.Priority=DMA_PRIORITY_LOW +Dma.USART10_RX.10.RequestNumber=1 +Dma.USART10_RX.10.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART10_RX.10.SignalID=NONE +Dma.USART10_RX.10.SyncEnable=DISABLE +Dma.USART10_RX.10.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART10_RX.10.SyncRequestNumber=1 +Dma.USART10_RX.10.SyncSignalID=NONE +Dma.USART10_TX.11.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART10_TX.11.EventEnable=DISABLE +Dma.USART10_TX.11.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART10_TX.11.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART10_TX.11.Instance=DMA2_Stream4 +Dma.USART10_TX.11.MemBurst=DMA_MBURST_SINGLE +Dma.USART10_TX.11.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART10_TX.11.MemInc=DMA_MINC_ENABLE +Dma.USART10_TX.11.Mode=DMA_NORMAL +Dma.USART10_TX.11.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART10_TX.11.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART10_TX.11.PeriphInc=DMA_PINC_DISABLE +Dma.USART10_TX.11.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART10_TX.11.Priority=DMA_PRIORITY_LOW +Dma.USART10_TX.11.RequestNumber=1 +Dma.USART10_TX.11.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART10_TX.11.SignalID=NONE +Dma.USART10_TX.11.SyncEnable=DISABLE +Dma.USART10_TX.11.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART10_TX.11.SyncRequestNumber=1 +Dma.USART10_TX.11.SyncSignalID=NONE +Dma.USART1_RX.0.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART1_RX.0.EventEnable=DISABLE +Dma.USART1_RX.0.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART1_RX.0.Instance=DMA1_Stream1 +Dma.USART1_RX.0.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_RX.0.MemInc=DMA_MINC_ENABLE +Dma.USART1_RX.0.Mode=DMA_NORMAL +Dma.USART1_RX.0.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_RX.0.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_RX.0.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_RX.0.Priority=DMA_PRIORITY_LOW +Dma.USART1_RX.0.RequestNumber=1 +Dma.USART1_RX.0.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_RX.0.SignalID=NONE +Dma.USART1_RX.0.SyncEnable=DISABLE +Dma.USART1_RX.0.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_RX.0.SyncRequestNumber=1 +Dma.USART1_RX.0.SyncSignalID=NONE +Dma.USART1_TX.1.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART1_TX.1.EventEnable=DISABLE +Dma.USART1_TX.1.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART1_TX.1.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART1_TX.1.Instance=DMA1_Stream2 +Dma.USART1_TX.1.MemBurst=DMA_MBURST_SINGLE +Dma.USART1_TX.1.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_TX.1.MemInc=DMA_MINC_ENABLE +Dma.USART1_TX.1.Mode=DMA_NORMAL +Dma.USART1_TX.1.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART1_TX.1.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_TX.1.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_TX.1.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_TX.1.Priority=DMA_PRIORITY_LOW +Dma.USART1_TX.1.RequestNumber=1 +Dma.USART1_TX.1.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_TX.1.SignalID=NONE +Dma.USART1_TX.1.SyncEnable=DISABLE +Dma.USART1_TX.1.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_TX.1.SyncRequestNumber=1 +Dma.USART1_TX.1.SyncSignalID=NONE +Dma.USART2_RX.8.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART2_RX.8.EventEnable=DISABLE +Dma.USART2_RX.8.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART2_RX.8.Instance=DMA2_Stream1 +Dma.USART2_RX.8.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_RX.8.MemInc=DMA_MINC_ENABLE +Dma.USART2_RX.8.Mode=DMA_NORMAL +Dma.USART2_RX.8.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_RX.8.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_RX.8.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_RX.8.Priority=DMA_PRIORITY_LOW +Dma.USART2_RX.8.RequestNumber=1 +Dma.USART2_RX.8.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_RX.8.SignalID=NONE +Dma.USART2_RX.8.SyncEnable=DISABLE +Dma.USART2_RX.8.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_RX.8.SyncRequestNumber=1 +Dma.USART2_RX.8.SyncSignalID=NONE +Dma.USART2_TX.9.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART2_TX.9.EventEnable=DISABLE +Dma.USART2_TX.9.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART2_TX.9.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART2_TX.9.Instance=DMA2_Stream2 +Dma.USART2_TX.9.MemBurst=DMA_MBURST_SINGLE +Dma.USART2_TX.9.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_TX.9.MemInc=DMA_MINC_ENABLE +Dma.USART2_TX.9.Mode=DMA_NORMAL +Dma.USART2_TX.9.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART2_TX.9.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_TX.9.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_TX.9.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_TX.9.Priority=DMA_PRIORITY_LOW +Dma.USART2_TX.9.RequestNumber=1 +Dma.USART2_TX.9.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_TX.9.SignalID=NONE +Dma.USART2_TX.9.SyncEnable=DISABLE +Dma.USART2_TX.9.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_TX.9.SyncRequestNumber=1 +Dma.USART2_TX.9.SyncSignalID=NONE +Dma.USART3_RX.13.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART3_RX.13.EventEnable=DISABLE +Dma.USART3_RX.13.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART3_RX.13.Instance=DMA2_Stream6 +Dma.USART3_RX.13.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART3_RX.13.MemInc=DMA_MINC_ENABLE +Dma.USART3_RX.13.Mode=DMA_NORMAL +Dma.USART3_RX.13.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART3_RX.13.PeriphInc=DMA_PINC_DISABLE +Dma.USART3_RX.13.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART3_RX.13.Priority=DMA_PRIORITY_LOW +Dma.USART3_RX.13.RequestNumber=1 +Dma.USART3_RX.13.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART3_RX.13.SignalID=NONE +Dma.USART3_RX.13.SyncEnable=DISABLE +Dma.USART3_RX.13.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART3_RX.13.SyncRequestNumber=1 +Dma.USART3_RX.13.SyncSignalID=NONE +Dma.USART3_TX.14.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART3_TX.14.EventEnable=DISABLE +Dma.USART3_TX.14.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART3_TX.14.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART3_TX.14.Instance=DMA2_Stream7 +Dma.USART3_TX.14.MemBurst=DMA_MBURST_SINGLE +Dma.USART3_TX.14.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART3_TX.14.MemInc=DMA_MINC_ENABLE +Dma.USART3_TX.14.Mode=DMA_NORMAL +Dma.USART3_TX.14.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART3_TX.14.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART3_TX.14.PeriphInc=DMA_PINC_DISABLE +Dma.USART3_TX.14.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART3_TX.14.Priority=DMA_PRIORITY_LOW +Dma.USART3_TX.14.RequestNumber=1 +Dma.USART3_TX.14.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART3_TX.14.SignalID=NONE +Dma.USART3_TX.14.SyncEnable=DISABLE +Dma.USART3_TX.14.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART3_TX.14.SyncRequestNumber=1 +Dma.USART3_TX.14.SyncSignalID=NONE +FDCAN1.AutoRetransmission=ENABLE +FDCAN1.CalculateBaudRateNominal=1000000 +FDCAN1.CalculateTimeBitNominal=1000 +FDCAN1.CalculateTimeQuantumNominal=62.5 +FDCAN1.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,NominalPrescaler,StdFiltersNbr,NominalTimeSeg1,AutoRetransmission,NominalTimeSeg2 +FDCAN1.NominalPrescaler=6 +FDCAN1.NominalTimeSeg1=11 +FDCAN1.NominalTimeSeg2=4 +FDCAN2.AutoRetransmission=ENABLE +FDCAN2.CalculateBaudRateNominal=1000000 +FDCAN2.CalculateTimeBitNominal=1000 +FDCAN2.CalculateTimeQuantumNominal=62.5 +FDCAN2.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,AutoRetransmission,StdFiltersNbr,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,MessageRAMOffset,NominalPrescaler,NominalTimeSeg1,NominalTimeSeg2 +FDCAN2.NominalPrescaler=6 +FDCAN2.NominalTimeSeg1=11 +FDCAN2.NominalTimeSeg2=4 +FDCAN3.AutoRetransmission=ENABLE +FDCAN3.CalculateBaudRateNominal=1000000 +FDCAN3.CalculateTimeBitNominal=1000 +FDCAN3.CalculateTimeQuantumNominal=62.5 +FDCAN3.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,MessageRAMOffset,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,NominalPrescaler,StdFiltersNbr,AutoRetransmission,NominalTimeSeg1,NominalTimeSeg2 +FDCAN3.NominalPrescaler=6 +FDCAN3.NominalTimeSeg1=11 +FDCAN3.NominalTimeSeg2=4 +FREERTOS.FootprintOK=true +FREERTOS.INCLUDE_eTaskGetState=1 +FREERTOS.INCLUDE_uxTaskGetStackHighWaterMark=1 +FREERTOS.INCLUDE_vTaskDelayUntil=1 +FREERTOS.INCLUDE_xQueueGetMutexHolder=1 +FREERTOS.INCLUDE_xTaskGetCurrentTaskHandle=1 +FREERTOS.INCLUDE_xTimerPendFunctionCall=1 +FREERTOS.IPParameters=Tasks01,configCHECK_FOR_STACK_OVERFLOW,configUSE_MALLOC_FAILED_HOOK,configENABLE_FPU,configUSE_RECURSIVE_MUTEXES,configUSE_COUNTING_SEMAPHORES,INCLUDE_vTaskDelayUntil,INCLUDE_xQueueGetMutexHolder,INCLUDE_uxTaskGetStackHighWaterMark,INCLUDE_xTaskGetCurrentTaskHandle,INCLUDE_eTaskGetState,configUSE_TRACE_FACILITY,configUSE_TIMERS,INCLUDE_xTimerPendFunctionCall,configUSE_NEWLIB_REENTRANT,configTOTAL_HEAP_SIZE,FootprintOK +FREERTOS.Tasks01=defaultTask,24,512,StartDefaultTask,As weak,NULL,Dynamic,NULL,NULL +FREERTOS.configENABLE_FPU=1 +FREERTOS.configTOTAL_HEAP_SIZE=65536 +FREERTOS.configUSE_COUNTING_SEMAPHORES=1 +FREERTOS.configUSE_MALLOC_FAILED_HOOK=1 +FREERTOS.configUSE_NEWLIB_REENTRANT=1 +FREERTOS.configUSE_RECURSIVE_MUTEXES=1 +FREERTOS.configUSE_TIMERS=1 +FREERTOS.configUSE_TRACE_FACILITY=1 +File.Version=6 +GPIO.groupedBy=Group By Peripherals +KeepUserPlacement=false +MMTAppRegionsCount=0 +MMTConfigApplied=false +MMTSectionSuffix= +Mcu.CPN=STM32H723VGT6 +Mcu.Family=STM32H7 +Mcu.IP0=CORTEX_M7 +Mcu.IP1=DEBUG +Mcu.IP10=RCC +Mcu.IP11=SPI1 +Mcu.IP12=SPI2 +Mcu.IP13=SYS +Mcu.IP14=TIM1 +Mcu.IP15=TIM2 +Mcu.IP16=TIM3 +Mcu.IP17=TIM12 +Mcu.IP18=UART4 +Mcu.IP19=UART5 +Mcu.IP2=DMA +Mcu.IP20=UART7 +Mcu.IP21=UART8 +Mcu.IP22=UART9 +Mcu.IP23=USART1 +Mcu.IP24=USART2 +Mcu.IP25=USART3 +Mcu.IP26=USART10 +Mcu.IP27=USB_OTG_HS +Mcu.IP3=FDCAN1 +Mcu.IP4=FDCAN2 +Mcu.IP5=FDCAN3 +Mcu.IP6=FREERTOS +Mcu.IP7=MEMORYMAP +Mcu.IP8=NVIC +Mcu.IP9=OCTOSPI2 +Mcu.IPNb=28 +Mcu.Name=STM32H723VGTx +Mcu.Package=LQFP100 +Mcu.Pin0=PE2 +Mcu.Pin1=PE3 +Mcu.Pin10=PC3_C +Mcu.Pin11=PA0 +Mcu.Pin12=PA1 +Mcu.Pin13=PA2 +Mcu.Pin14=PA3 +Mcu.Pin15=PA7 +Mcu.Pin16=PB0 +Mcu.Pin17=PB1 +Mcu.Pin18=PB2 +Mcu.Pin19=PE7 +Mcu.Pin2=PC13 +Mcu.Pin20=PE8 +Mcu.Pin21=PE9 +Mcu.Pin22=PE10 +Mcu.Pin23=PE11 +Mcu.Pin24=PE12 +Mcu.Pin25=PE13 +Mcu.Pin26=PE14 +Mcu.Pin27=PE15 +Mcu.Pin28=PB10 +Mcu.Pin29=PB11 +Mcu.Pin3=PC14-OSC32_IN +Mcu.Pin30=PB13 +Mcu.Pin31=PB14 +Mcu.Pin32=PB15 +Mcu.Pin33=PD8 +Mcu.Pin34=PD9 +Mcu.Pin35=PD10 +Mcu.Pin36=PD11 +Mcu.Pin37=PD12 +Mcu.Pin38=PD13 +Mcu.Pin39=PD14 +Mcu.Pin4=PC15-OSC32_OUT +Mcu.Pin40=PD15 +Mcu.Pin41=PA9 +Mcu.Pin42=PA10 +Mcu.Pin43=PA11 +Mcu.Pin44=PA12 +Mcu.Pin45=PA13(JTMS/SWDIO) +Mcu.Pin46=PA14(JTCK/SWCLK) +Mcu.Pin47=PA15(JTDI) +Mcu.Pin48=PC12 +Mcu.Pin49=PD0 +Mcu.Pin5=PH0-OSC_IN +Mcu.Pin50=PD1 +Mcu.Pin51=PD2 +Mcu.Pin52=PD4 +Mcu.Pin53=PD5 +Mcu.Pin54=PD6 +Mcu.Pin55=PD7 +Mcu.Pin56=PB3(JTDO/TRACESWO) +Mcu.Pin57=PB5 +Mcu.Pin58=PB6 +Mcu.Pin59=PB8 +Mcu.Pin6=PH1-OSC_OUT +Mcu.Pin60=PB9 +Mcu.Pin61=PE0 +Mcu.Pin62=PE1 +Mcu.Pin63=VP_FREERTOS_VS_CMSIS_V2 +Mcu.Pin64=VP_OCTOSPI2_VS_quad +Mcu.Pin65=VP_SYS_VS_tim8 +Mcu.Pin66=VP_MEMORYMAP_VS_MEMORYMAP +Mcu.Pin7=PC0 +Mcu.Pin8=PC1 +Mcu.Pin9=PC2_C +Mcu.PinsNb=67 +Mcu.ThirdPartyNb=0 +Mcu.UserConstants= +Mcu.UserName=STM32H723VGTx +MxCube.Version=6.18.1 +MxDb.Version=DB.6.0.181 +NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.DMA1_Stream0_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream3_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream4_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream5_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream7_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream3_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream4_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream5_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream7_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.EXTI15_10_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN1_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN1_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN2_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN2_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN3_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN3_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.ForceEnableDMAVector=true +NVIC.HardFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.MemoryManagement_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.NonMaskableInt_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.PendSV_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:false\:false +NVIC.PriorityGroup=NVIC_PRIORITYGROUP_4 +NVIC.SPI2_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.SVCall_IRQn=true\:0\:0\:false\:false\:false\:false\:false\:false\:false +NVIC.SavedPendsvIrqHandlerGenerated=true +NVIC.SavedSvcallIrqHandlerGenerated=true +NVIC.SavedSystickIrqHandlerGenerated=true +NVIC.SysTick_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:true\:false +NVIC.TIM8_UP_TIM13_IRQn=true\:15\:0\:false\:false\:true\:false\:false\:true\:true +NVIC.TimeBase=TIM8_UP_TIM13_IRQn +NVIC.TimeBaseIP=TIM8 +NVIC.UART4_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART5_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART7_IRQn=true\:5\:0\:true\:false\:true\:true\:true\:true\:true +NVIC.UART8_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART9_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART10_IRQn=true\:5\:0\:true\:false\:true\:true\:true\:true\:true +NVIC.USART2_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART3_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UsageFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +OCTOSPI2.ClockMode=HAL_OSPI_CLOCK_MODE_3 +OCTOSPI2.ClockPrescaler=3 +OCTOSPI2.DeviceSize=23 +OCTOSPI2.DeviceType=SPI_DEVICE_FLASH +OCTOSPI2.FifoThreshold=8 +OCTOSPI2.IPParameters=FifoThreshold,DeviceSize,DeviceType,ClockMode,ClockPrescaler,SampleShifting +OCTOSPI2.SampleShifting=HAL_OSPI_SAMPLE_SHIFTING_HALFCYCLE +PA0.Locked=true +PA0.Signal=S_TIM2_CH1_ETR +PA1.Locked=true +PA1.Mode=OCTOSPI2_IOL_Port1L +PA1.Signal=OCTOSPIM_P1_IO3 +PA10.Locked=true +PA10.Mode=Asynchronous +PA10.Signal=USART1_RX +PA11.Mode=Device_Only_FS +PA11.Signal=USB_OTG_HS_DM +PA12.Mode=Device_Only_FS +PA12.Signal=USB_OTG_HS_DP +PA13(JTMS/SWDIO).Locked=true +PA13(JTMS/SWDIO).Mode=Serial_Wire +PA13(JTMS/SWDIO).Signal=DEBUG_JTMS-SWDIO +PA14(JTCK/SWCLK).Locked=true +PA14(JTCK/SWCLK).Mode=Serial_Wire +PA14(JTCK/SWCLK).Signal=DEBUG_JTCK-SWCLK +PA15(JTDI).GPIOParameters=GPIO_Label,GPIO_ModeDefaultEXTI +PA15(JTDI).GPIO_Label=KEY +PA15(JTDI).GPIO_ModeDefaultEXTI=GPIO_MODE_IT_RISING +PA15(JTDI).Locked=true +PA15(JTDI).Signal=GPXTI15 +PA2.Locked=true +PA2.Signal=S_TIM2_CH3 +PA3.Locked=true +PA3.Mode=OCTOSPI2_IOL_Port1L +PA3.Signal=OCTOSPIM_P1_IO2 +PA7.Locked=true +PA7.Signal=S_TIM14_CH1 +PA9.Locked=true +PA9.Mode=Asynchronous +PA9.Signal=USART1_TX +PB0.Locked=true +PB0.Mode=OCTOSPI2_IOL_Port1L +PB0.Signal=OCTOSPIM_P1_IO1 +PB1.Locked=true +PB1.Signal=S_TIM3_CH4 +PB10.GPIOParameters=GPIO_Label +PB10.GPIO_Label=LCD_BLK +PB10.Locked=true +PB10.Signal=GPIO_Output +PB11.GPIOParameters=GPIO_Label +PB11.GPIO_Label=LCD_RES +PB11.Locked=true +PB11.Signal=GPIO_Output +PB13.GPIOParameters=GPIO_Speed +PB13.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PB13.Locked=true +PB13.Mode=Full_Duplex_Master +PB13.Signal=SPI2_SCK +PB14.Mode=Hardware Flow Control (RS485) +PB14.Signal=USART3_DE +PB15.Locked=true +PB15.Signal=S_TIM12_CH2 +PB2.Locked=true +PB2.Mode=O2_P1_CLK +PB2.Signal=OCTOSPIM_P1_CLK +PB3(JTDO/TRACESWO).GPIOParameters=GPIO_Speed +PB3(JTDO/TRACESWO).GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PB3(JTDO/TRACESWO).Mode=TX_Only_Simplex_Unidirect_Master +PB3(JTDO/TRACESWO).Signal=SPI1_SCK +PB5.Locked=true +PB5.Mode=FDCAN_Activate +PB5.Signal=FDCAN2_RX +PB6.Mode=FDCAN_Activate +PB6.Signal=FDCAN2_TX +PB8.Locked=true +PB8.Mode=Asynchronous +PB8.Signal=UART4_RX +PB9.Locked=true +PB9.Mode=Asynchronous +PB9.Signal=UART4_TX +PC0.GPIOParameters=GPIO_Speed,PinState,GPIO_Label +PC0.GPIO_Label=GYRO_ACC_CS +PC0.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC0.Locked=true +PC0.PinState=GPIO_PIN_SET +PC0.Signal=GPIO_Output +PC1.GPIOParameters=GPIO_Speed +PC1.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC1.Mode=Full_Duplex_Master +PC1.Signal=SPI2_MOSI +PC12.Mode=Asynchronous +PC12.Signal=UART5_TX +PC13.GPIOParameters=PinState,GPIO_Label +PC13.GPIO_Label=POWER_24V_2 +PC13.Locked=true +PC13.PinState=GPIO_PIN_SET +PC13.Signal=GPIO_Output +PC14-OSC32_IN.GPIOParameters=PinState,GPIO_Label +PC14-OSC32_IN.GPIO_Label=POWER_24V_1 +PC14-OSC32_IN.Locked=true +PC14-OSC32_IN.PinState=GPIO_PIN_SET +PC14-OSC32_IN.Signal=GPIO_Output +PC15-OSC32_OUT.GPIOParameters=PinState,GPIO_Label +PC15-OSC32_OUT.GPIO_Label=POWER_5V +PC15-OSC32_OUT.Locked=true +PC15-OSC32_OUT.PinState=GPIO_PIN_SET +PC15-OSC32_OUT.Signal=GPIO_Output +PC2_C.GPIOParameters=GPIO_Speed +PC2_C.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC2_C.Mode=Full_Duplex_Master +PC2_C.Signal=SPI2_MISO +PC3_C.GPIOParameters=GPIO_Speed,PinState,GPIO_Label +PC3_C.GPIO_Label=GYRO_GYRO_CS +PC3_C.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC3_C.Locked=true +PC3_C.PinState=GPIO_PIN_SET +PC3_C.Signal=GPIO_Output +PD0.Mode=FDCAN_Activate +PD0.Signal=FDCAN1_RX +PD1.Locked=true +PD1.Mode=FDCAN_Activate +PD1.Signal=FDCAN1_TX +PD10.GPIOParameters=GPIO_Label +PD10.GPIO_Label=LCD_DC +PD10.Locked=true +PD10.Signal=GPIO_Output +PD11.Locked=true +PD11.Mode=OCTOSPI2_IOL_Port1L +PD11.Signal=OCTOSPIM_P1_IO0 +PD12.Mode=FDCAN_Activate +PD12.Signal=FDCAN3_RX +PD13.Locked=true +PD13.Mode=FDCAN_Activate +PD13.Signal=FDCAN3_TX +PD14.Mode=Asynchronous +PD14.Signal=UART9_RX +PD15.Mode=Asynchronous +PD15.Signal=UART9_TX +PD2.Locked=true +PD2.Mode=Asynchronous +PD2.Signal=UART5_RX +PD4.Mode=Hardware Flow Control (RS485) +PD4.Signal=USART2_DE +PD5.Mode=Asynchronous +PD5.Signal=USART2_TX +PD6.Mode=Asynchronous +PD6.Signal=USART2_RX +PD7.GPIOParameters=GPIO_Speed +PD7.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PD7.Locked=true +PD7.Mode=TX_Only_Simplex_Unidirect_Master +PD7.Signal=SPI1_MOSI +PD8.Locked=true +PD8.Mode=Asynchronous +PD8.Signal=USART3_TX +PD9.Locked=true +PD9.Mode=Asynchronous +PD9.Signal=USART3_RX +PE0.Mode=Asynchronous +PE0.Signal=UART8_RX +PE1.Mode=Asynchronous +PE1.Signal=UART8_TX +PE10.GPIOParameters=GPIO_Label +PE10.GPIO_Label=GYRO_ACC_INT +PE10.Locked=true +PE10.Signal=GPXTI10 +PE11.Locked=true +PE11.Mode=OCTOSPI2_Port1_NCS +PE11.Signal=OCTOSPIM_P1_NCS +PE12.GPIOParameters=GPIO_Label +PE12.GPIO_Label=GYRO_GYRO_INT +PE12.Locked=true +PE12.Signal=GPXTI12 +PE13.Signal=S_TIM1_CH3 +PE14.GPIOParameters=GPIO_Label +PE14.GPIO_Label=BTB_GPIO +PE14.Locked=true +PE14.Signal=GPIO_Output +PE15.GPIOParameters=GPIO_Label +PE15.GPIO_Label=LCD_CS +PE15.Locked=true +PE15.Signal=GPIO_Output +PE2.Mode=Asynchronous +PE2.Signal=USART10_RX +PE3.Mode=Asynchronous +PE3.Signal=USART10_TX +PE7.Mode=Asynchronous +PE7.Signal=UART7_RX +PE8.Mode=Asynchronous +PE8.Signal=UART7_TX +PE9.Locked=true +PE9.Signal=S_TIM1_CH1 +PH0-OSC_IN.Mode=HSE-External-Oscillator +PH0-OSC_IN.Signal=RCC_OSC_IN +PH1-OSC_OUT.Mode=HSE-External-Oscillator +PH1-OSC_OUT.Signal=RCC_OSC_OUT +PinOutPanel.RotationAngle=0 +ProjectManager.AskForMigrate=true +ProjectManager.BackupPrevious=false +ProjectManager.CompilerLinker=GCC +ProjectManager.CompilerOptimize=6 +ProjectManager.ComputerToolchain=false +ProjectManager.CoupleFile=true +ProjectManager.CustomerFirmwarePackage= +ProjectManager.DefaultFWLocation=true +ProjectManager.DeletePrevious=true +ProjectManager.DeviceId=STM32H723VGTx +ProjectManager.FirmwarePackage=STM32Cube FW_H7 V1.13.0 +ProjectManager.FreePins=false +ProjectManager.FreePinsContext= +ProjectManager.HalAssertFull=false +ProjectManager.HeapSize=0x800 +ProjectManager.KeepUserCode=true +ProjectManager.LastFirmware=true +ProjectManager.LibraryCopy=0 +ProjectManager.MainLocation=Core/Src +ProjectManager.NoMain=false +ProjectManager.PreviousToolchain= +ProjectManager.ProjectBuild=false +ProjectManager.ProjectFileName=MC02_with_submodule.ioc +ProjectManager.ProjectName=MC02_with_submodule +ProjectManager.ProjectStructure= +ProjectManager.RegisterCallBack= +ProjectManager.StackSize=0x800 +ProjectManager.TargetToolchain=CMake +ProjectManager.ToolChainLocation= +ProjectManager.UAScriptAfterPath= +ProjectManager.UAScriptBeforePath= +ProjectManager.UnderRoot=false +ProjectManager.functionlistsort=1-SystemClock_Config-RCC-false-HAL-false,2-MX_GPIO_Init-GPIO-false-HAL-true,3-MX_DMA_Init-DMA-false-HAL-true,4-MX_TIM12_Init-TIM12-false-HAL-true,5-MX_SPI1_Init-SPI1-false-HAL-true,6-MX_SPI2_Init-SPI2-false-HAL-true,7-MX_TIM3_Init-TIM3-false-HAL-true,8-MX_USART1_UART_Init-USART1-false-HAL-true,9-MX_UART7_Init-UART7-false-HAL-true,10-MX_USART10_UART_Init-USART10-false-HAL-true,11-MX_FDCAN1_Init-FDCAN1-false-HAL-true,12-MX_FDCAN2_Init-FDCAN2-false-HAL-true,13-MX_FDCAN3_Init-FDCAN3-false-HAL-true,14-MX_TIM1_Init-TIM1-false-HAL-true,15-MX_TIM2_Init-TIM2-false-HAL-true,16-MX_OCTOSPI2_Init-OCTOSPI2-false-HAL-true,17-MX_USB_OTG_HS_PCD_Init-USB_OTG_HS-false-HAL-true,18-MX_UART8_Init-UART8-false-HAL-true,19-MX_UART9_Init-UART9-false-HAL-true,20-MX_UART4_Init-UART4-false-HAL-true,21-MX_USART2_UART_Init-USART2-false-HAL-true,22-MX_USART3_UART_Init-USART3-false-HAL-true,23-MX_UART5_Init-UART5-false-HAL-true,0-MX_CORTEX_M7_Init-CORTEX_M7-false-HAL-true +RCC.ADCFreq_Value=96000000 +RCC.AHB12Freq_Value=275000000 +RCC.AHB4Freq_Value=275000000 +RCC.APB1Freq_Value=137500000 +RCC.APB2Freq_Value=137500000 +RCC.APB3Freq_Value=137500000 +RCC.APB4Freq_Value=137500000 +RCC.AXIClockFreq_Value=275000000 +RCC.CECFreq_Value=32000 +RCC.CKPERFreq_Value=64000000 +RCC.CortexFreq_Value=550000000 +RCC.CpuClockFreq_Value=550000000 +RCC.D1CPREFreq_Value=550000000 +RCC.D1PPRE=RCC_APB3_DIV2 +RCC.D2PPRE1=RCC_APB1_DIV2 +RCC.D2PPRE2=RCC_APB2_DIV2 +RCC.D3PPRE=RCC_APB4_DIV2 +RCC.DFSDMACLkFreq_Value=137500000 +RCC.DFSDMFreq_Value=137500000 +RCC.DIVM1=3 +RCC.DIVM2=2 +RCC.DIVN1=68 +RCC.DIVN2=16 +RCC.DIVP1=1 +RCC.DIVP1Freq_Value=550000000 +RCC.DIVP2Freq_Value=96000000 +RCC.DIVP3Freq_Value=48375000 +RCC.DIVQ1=4 +RCC.DIVQ1Freq_Value=137500000 +RCC.DIVQ2Freq_Value=96000000 +RCC.DIVQ3Freq_Value=48375000 +RCC.DIVR1Freq_Value=275000000 +RCC.DIVR2Freq_Value=96000000 +RCC.DIVR3Freq_Value=48375000 +RCC.FDCANCLockSelection=RCC_FDCANCLKSOURCE_PLL2 +RCC.FDCANFreq_Value=96000000 +RCC.FMCFreq_Value=275000000 +RCC.FamilyName=M +RCC.HCLK3ClockFreq_Value=275000000 +RCC.HCLKFreq_Value=275000000 +RCC.HPRE=RCC_HCLK_DIV2 +RCC.HSE_VALUE=24000000 +RCC.I2C123Freq_Value=137500000 +RCC.I2C4Freq_Value=137500000 +RCC.IPParameters=ADCFreq_Value,AHB12Freq_Value,AHB4Freq_Value,APB1Freq_Value,APB2Freq_Value,APB3Freq_Value,APB4Freq_Value,AXIClockFreq_Value,CECFreq_Value,CKPERFreq_Value,CortexFreq_Value,CpuClockFreq_Value,D1CPREFreq_Value,D1PPRE,D2PPRE1,D2PPRE2,D3PPRE,DFSDMACLkFreq_Value,DFSDMFreq_Value,DIVM1,DIVM2,DIVN1,DIVN2,DIVP1,DIVP1Freq_Value,DIVP2Freq_Value,DIVP3Freq_Value,DIVQ1,DIVQ1Freq_Value,DIVQ2Freq_Value,DIVQ3Freq_Value,DIVR1Freq_Value,DIVR2Freq_Value,DIVR3Freq_Value,FDCANCLockSelection,FDCANFreq_Value,FMCFreq_Value,FamilyName,HCLK3ClockFreq_Value,HCLKFreq_Value,HPRE,HSE_VALUE,I2C123Freq_Value,I2C4Freq_Value,LPTIM1Freq_Value,LPTIM2Freq_Value,LPTIM345Freq_Value,LPUART1Freq_Value,LTDCFreq_Value,MCO1PinFreq_Value,MCO2PinFreq_Value,PLL2FRACN,PLL2_VCI_Range-AdvancedSettings,PLL2_VCO_SEL-AdvancedSettings,PLL3FRACN,PLL3_VCI_Range-AdvancedSettings,PLL3_VCO_SEL-AdvancedSettings,PLLFRACN,PLLSourceVirtual,QSPIFreq_Value,RNGFreq_Value,RTCFreq_Value,SAI1Freq_Value,SAI4AFreq_Value,SAI4BFreq_Value,SDMMCFreq_Value,SPDIFRXFreq_Value,SPI123Freq_Value,SPI45Freq_Value,SPI6CLockSelection,SPI6Freq_Value,SWPMI1Freq_Value,SYSCLKFreq_VALUE,SYSCLKSource,Tim1OutputFreq_Value,Tim2OutputFreq_Value,TraceFreq_Value,USART16Freq_Value,USART234578Freq_Value,USBCLockSelection,USBFreq_Value,VCO1OutputFreq_Value,VCO2OutputFreq_Value,VCO3OutputFreq_Value,VCOInput1Freq_Value,VCOInput2Freq_Value,VCOInput3Freq_Value +RCC.LPTIM1Freq_Value=137500000 +RCC.LPTIM2Freq_Value=137500000 +RCC.LPTIM345Freq_Value=137500000 +RCC.LPUART1Freq_Value=137500000 +RCC.LTDCFreq_Value=48375000 +RCC.MCO1PinFreq_Value=64000000 +RCC.MCO2PinFreq_Value=550000000 +RCC.PLL2FRACN=0 +RCC.PLL2_VCI_Range-AdvancedSettings=RCC_PLL2VCIRANGE_0 +RCC.PLL2_VCO_SEL-AdvancedSettings=RCC_PLL2VCOMEDIUM +RCC.PLL3FRACN=0 +RCC.PLL3_VCI_Range-AdvancedSettings=RCC_PLL3VCIRANGE_3 +RCC.PLL3_VCO_SEL-AdvancedSettings=RCC_PLL3VCOMEDIUM +RCC.PLLFRACN=6144 +RCC.PLLSourceVirtual=RCC_PLLSOURCE_HSE +RCC.QSPIFreq_Value=275000000 +RCC.RNGFreq_Value=48000000 +RCC.RTCFreq_Value=32000 +RCC.SAI1Freq_Value=137500000 +RCC.SAI4AFreq_Value=137500000 +RCC.SAI4BFreq_Value=137500000 +RCC.SDMMCFreq_Value=137500000 +RCC.SPDIFRXFreq_Value=137500000 +RCC.SPI123Freq_Value=137500000 +RCC.SPI45Freq_Value=137500000 +RCC.SPI6CLockSelection=RCC_SPI6CLKSOURCE_HSE +RCC.SPI6Freq_Value=24000000 +RCC.SWPMI1Freq_Value=137500000 +RCC.SYSCLKFreq_VALUE=550000000 +RCC.SYSCLKSource=RCC_SYSCLKSOURCE_PLLCLK +RCC.Tim1OutputFreq_Value=275000000 +RCC.Tim2OutputFreq_Value=275000000 +RCC.TraceFreq_Value=275000000 +RCC.USART16Freq_Value=137500000 +RCC.USART234578Freq_Value=137500000 +RCC.USBCLockSelection=RCC_USBCLKSOURCE_HSI48 +RCC.USBFreq_Value=48000000 +RCC.VCO1OutputFreq_Value=550000000 +RCC.VCO2OutputFreq_Value=192000000 +RCC.VCO3OutputFreq_Value=96750000 +RCC.VCOInput1Freq_Value=8000000 +RCC.VCOInput2Freq_Value=12000000 +RCC.VCOInput3Freq_Value=750000 +SH.GPXTI10.0=GPIO_EXTI10 +SH.GPXTI10.ConfNb=1 +SH.GPXTI12.0=GPIO_EXTI12 +SH.GPXTI12.ConfNb=1 +SH.GPXTI15.0=GPIO_EXTI15 +SH.GPXTI15.ConfNb=1 +SH.S_TIM12_CH2.0=TIM12_CH2,PWM Generation2 CH2 +SH.S_TIM12_CH2.ConfNb=1 +SH.S_TIM14_CH1.0=TIM14_CH1 +SH.S_TIM14_CH1.ConfNb=1 +SH.S_TIM1_CH1.0=TIM1_CH1,PWM Generation1 CH1 +SH.S_TIM1_CH1.ConfNb=1 +SH.S_TIM1_CH3.0=TIM1_CH3,PWM Generation3 CH3 +SH.S_TIM1_CH3.ConfNb=1 +SH.S_TIM2_CH1_ETR.0=TIM2_CH1,PWM Generation1 CH1 +SH.S_TIM2_CH1_ETR.ConfNb=1 +SH.S_TIM2_CH3.0=TIM2_CH3,PWM Generation3 CH3 +SH.S_TIM2_CH3.ConfNb=1 +SH.S_TIM3_CH4.0=TIM3_CH4,PWM Generation4 CH4 +SH.S_TIM3_CH4.ConfNb=1 +SPI1.BaudRatePrescaler=SPI_BAUDRATEPRESCALER_4 +SPI1.CLKPolarity=SPI_POLARITY_HIGH +SPI1.CalculateBaudRate=34.375 MBits/s +SPI1.DataSize=SPI_DATASIZE_8BIT +SPI1.Direction=SPI_DIRECTION_2LINES_TXONLY +SPI1.IPParameters=VirtualType,Mode,Direction,CalculateBaudRate,DataSize,BaudRatePrescaler,CLKPolarity +SPI1.Mode=SPI_MODE_MASTER +SPI1.VirtualType=VM_MASTER +SPI2.BaudRatePrescaler=SPI_BAUDRATEPRESCALER_32 +SPI2.CLKPhase=SPI_PHASE_2EDGE +SPI2.CLKPolarity=SPI_POLARITY_HIGH +SPI2.CalculateBaudRate=4.296875 MBits/s +SPI2.DataSize=SPI_DATASIZE_8BIT +SPI2.Direction=SPI_DIRECTION_2LINES +SPI2.IPParameters=VirtualType,Mode,Direction,CalculateBaudRate,DataSize,BaudRatePrescaler,CLKPolarity,CLKPhase,MasterKeepIOState +SPI2.Mode=SPI_MODE_MASTER +SPI2.VirtualType=VM_MASTER +TIM1.Channel-PWM\ Generation1\ CH1=TIM_CHANNEL_1 +TIM1.Channel-PWM\ Generation3\ CH3=TIM_CHANNEL_3 +TIM1.IPParameters=Channel-PWM Generation3 CH3,Channel-PWM Generation1 CH1,Period,Pulse-PWM Generation1 CH1,Pulse-PWM Generation3 CH3,Prescaler +TIM1.Period=10000 +TIM1.Prescaler=24 +TIM1.Pulse-PWM\ Generation1\ CH1=5000 +TIM1.Pulse-PWM\ Generation3\ CH3=5000 +TIM12.Channel-PWM\ Generation2\ CH2=TIM_CHANNEL_2 +TIM12.IPParameters=Channel-PWM Generation2 CH2,Prescaler,Period +TIM12.Period=2000-1 +TIM12.Prescaler=24-1 +TIM2.Channel-PWM\ Generation1\ CH1=TIM_CHANNEL_1 +TIM2.Channel-PWM\ Generation3\ CH3=TIM_CHANNEL_3 +TIM2.IPParameters=Channel-PWM Generation1 CH1,Channel-PWM Generation3 CH3,Period,Pulse-PWM Generation1 CH1,Pulse-PWM Generation3 CH3,Prescaler +TIM2.Period=10000 +TIM2.Prescaler=24 +TIM2.Pulse-PWM\ Generation1\ CH1=5000 +TIM2.Pulse-PWM\ Generation3\ CH3=5000 +TIM3.AutoReloadPreload=TIM_AUTORELOAD_PRELOAD_ENABLE +TIM3.Channel-PWM\ Generation4\ CH4=TIM_CHANNEL_4 +TIM3.IPParameters=Channel-PWM Generation4 CH4,Prescaler,Period,AutoReloadPreload +TIM3.Period=10000-1 +TIM3.Prescaler=24-1 +UART7.BaudRate=921600 +UART7.IPParameters=BaudRate +USART1.BaudRate=115200 +USART1.IPParameters=VirtualMode-Asynchronous,BaudRate +USART1.VirtualMode-Asynchronous=VM_ASYNC +USART10.BaudRate=921600 +USART10.IPParameters=VirtualMode,BaudRate +USART10.VirtualMode=VM_ASYNC +USART2.IPParameters=VirtualMode-Asynchronous,VirtualMode-Hardware Flow Control (RS485) +USART2.VirtualMode-Asynchronous=VM_ASYNC +USART2.VirtualMode-Hardware\ Flow\ Control\ (RS485)=VM_ASYNC +USART3.IPParameters=VirtualMode-Asynchronous,VirtualMode-Hardware Flow Control (RS485) +USART3.VirtualMode-Asynchronous=VM_ASYNC +USART3.VirtualMode-Hardware\ Flow\ Control\ (RS485)=VM_ASYNC +USB_OTG_HS.IPParameters=VirtualMode-Device_Only_FS +USB_OTG_HS.VirtualMode-Device_Only_FS=Device_Only_FS +VP_FREERTOS_VS_CMSIS_V2.Mode=CMSIS_V2 +VP_FREERTOS_VS_CMSIS_V2.Signal=FREERTOS_VS_CMSIS_V2 +VP_MEMORYMAP_VS_MEMORYMAP.Mode=CurAppReg +VP_MEMORYMAP_VS_MEMORYMAP.Signal=MEMORYMAP_VS_MEMORYMAP +VP_OCTOSPI2_VS_quad.Mode=quad_mode +VP_OCTOSPI2_VS_quad.Signal=OCTOSPI2_VS_quad +VP_SYS_VS_tim8.Mode=TIM8 +VP_SYS_VS_tim8.Signal=SYS_VS_tim8 +board=custom +rtos.0.ip=FREERTOS diff --git a/tools/tests/fixtures/h750_qspi.ioc b/tools/tests/fixtures/h750_qspi.ioc new file mode 100644 index 0000000..f5c6c6b --- /dev/null +++ b/tools/tests/fixtures/h750_qspi.ioc @@ -0,0 +1,684 @@ +#MicroXplorer Configuration settings - do not modify +Bdma.Request0=SPI6_RX +Bdma.RequestsNb=1 +Bdma.SPI6_RX.0.Direction=DMA_PERIPH_TO_MEMORY +Bdma.SPI6_RX.0.EventEnable=DISABLE +Bdma.SPI6_RX.0.Instance=BDMA_Channel0 +Bdma.SPI6_RX.0.MemDataAlignment=DMA_MDATAALIGN_BYTE +Bdma.SPI6_RX.0.MemInc=DMA_MINC_ENABLE +Bdma.SPI6_RX.0.Mode=DMA_NORMAL +Bdma.SPI6_RX.0.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Bdma.SPI6_RX.0.PeriphInc=DMA_PINC_DISABLE +Bdma.SPI6_RX.0.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Bdma.SPI6_RX.0.Priority=DMA_PRIORITY_LOW +Bdma.SPI6_RX.0.RequestNumber=1 +Bdma.SPI6_RX.0.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Bdma.SPI6_RX.0.SignalID=NONE +Bdma.SPI6_RX.0.SyncEnable=DISABLE +Bdma.SPI6_RX.0.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Bdma.SPI6_RX.0.SyncRequestNumber=1 +Bdma.SPI6_RX.0.SyncSignalID=NONE +CAD.formats= +CAD.pinconfig= +CAD.provider= +CORTEX_M7.CPU_DCache=Disabled +CORTEX_M7.CPU_ICache=Enabled +CORTEX_M7.IPParameters=default_mode_Activation,CPU_ICache,CPU_DCache +CORTEX_M7.default_mode_Activation=1 +Dma.Request0=USART3_RX +Dma.Request1=USART1_RX +Dma.Request10=UART4_TX +Dma.Request2=USART1_TX +Dma.Request3=USART2_RX +Dma.Request4=USART2_TX +Dma.Request5=USART6_RX +Dma.Request6=USART6_TX +Dma.Request7=UART5_RX +Dma.Request8=UART5_TX +Dma.Request9=UART4_RX +Dma.RequestsNb=11 +Dma.UART4_RX.9.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART4_RX.9.EventEnable=DISABLE +Dma.UART4_RX.9.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART4_RX.9.Instance=DMA2_Stream1 +Dma.UART4_RX.9.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_RX.9.MemInc=DMA_MINC_ENABLE +Dma.UART4_RX.9.Mode=DMA_NORMAL +Dma.UART4_RX.9.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_RX.9.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_RX.9.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_RX.9.Priority=DMA_PRIORITY_LOW +Dma.UART4_RX.9.RequestNumber=1 +Dma.UART4_RX.9.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_RX.9.SignalID=NONE +Dma.UART4_RX.9.SyncEnable=DISABLE +Dma.UART4_RX.9.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_RX.9.SyncRequestNumber=1 +Dma.UART4_RX.9.SyncSignalID=NONE +Dma.UART4_TX.10.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART4_TX.10.EventEnable=DISABLE +Dma.UART4_TX.10.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART4_TX.10.Instance=DMA2_Stream2 +Dma.UART4_TX.10.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_TX.10.MemInc=DMA_MINC_ENABLE +Dma.UART4_TX.10.Mode=DMA_NORMAL +Dma.UART4_TX.10.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_TX.10.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_TX.10.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_TX.10.Priority=DMA_PRIORITY_LOW +Dma.UART4_TX.10.RequestNumber=1 +Dma.UART4_TX.10.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_TX.10.SignalID=NONE +Dma.UART4_TX.10.SyncEnable=DISABLE +Dma.UART4_TX.10.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_TX.10.SyncRequestNumber=1 +Dma.UART4_TX.10.SyncSignalID=NONE +Dma.UART5_RX.7.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART5_RX.7.EventEnable=DISABLE +Dma.UART5_RX.7.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART5_RX.7.Instance=DMA1_Stream7 +Dma.UART5_RX.7.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART5_RX.7.MemInc=DMA_MINC_ENABLE +Dma.UART5_RX.7.Mode=DMA_NORMAL +Dma.UART5_RX.7.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART5_RX.7.PeriphInc=DMA_PINC_DISABLE +Dma.UART5_RX.7.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART5_RX.7.Priority=DMA_PRIORITY_LOW +Dma.UART5_RX.7.RequestNumber=1 +Dma.UART5_RX.7.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART5_RX.7.SignalID=NONE +Dma.UART5_RX.7.SyncEnable=DISABLE +Dma.UART5_RX.7.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART5_RX.7.SyncRequestNumber=1 +Dma.UART5_RX.7.SyncSignalID=NONE +Dma.UART5_TX.8.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART5_TX.8.EventEnable=DISABLE +Dma.UART5_TX.8.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART5_TX.8.Instance=DMA2_Stream0 +Dma.UART5_TX.8.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART5_TX.8.MemInc=DMA_MINC_ENABLE +Dma.UART5_TX.8.Mode=DMA_NORMAL +Dma.UART5_TX.8.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART5_TX.8.PeriphInc=DMA_PINC_DISABLE +Dma.UART5_TX.8.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART5_TX.8.Priority=DMA_PRIORITY_LOW +Dma.UART5_TX.8.RequestNumber=1 +Dma.UART5_TX.8.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART5_TX.8.SignalID=NONE +Dma.UART5_TX.8.SyncEnable=DISABLE +Dma.UART5_TX.8.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART5_TX.8.SyncRequestNumber=1 +Dma.UART5_TX.8.SyncSignalID=NONE +Dma.USART1_RX.1.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART1_RX.1.EventEnable=DISABLE +Dma.USART1_RX.1.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART1_RX.1.Instance=DMA1_Stream1 +Dma.USART1_RX.1.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_RX.1.MemInc=DMA_MINC_ENABLE +Dma.USART1_RX.1.Mode=DMA_NORMAL +Dma.USART1_RX.1.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_RX.1.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_RX.1.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_RX.1.Priority=DMA_PRIORITY_LOW +Dma.USART1_RX.1.RequestNumber=1 +Dma.USART1_RX.1.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_RX.1.SignalID=NONE +Dma.USART1_RX.1.SyncEnable=DISABLE +Dma.USART1_RX.1.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_RX.1.SyncRequestNumber=1 +Dma.USART1_RX.1.SyncSignalID=NONE +Dma.USART1_TX.2.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART1_TX.2.EventEnable=DISABLE +Dma.USART1_TX.2.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART1_TX.2.Instance=DMA1_Stream2 +Dma.USART1_TX.2.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_TX.2.MemInc=DMA_MINC_ENABLE +Dma.USART1_TX.2.Mode=DMA_NORMAL +Dma.USART1_TX.2.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_TX.2.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_TX.2.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_TX.2.Priority=DMA_PRIORITY_LOW +Dma.USART1_TX.2.RequestNumber=1 +Dma.USART1_TX.2.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_TX.2.SignalID=NONE +Dma.USART1_TX.2.SyncEnable=DISABLE +Dma.USART1_TX.2.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_TX.2.SyncRequestNumber=1 +Dma.USART1_TX.2.SyncSignalID=NONE +Dma.USART2_RX.3.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART2_RX.3.EventEnable=DISABLE +Dma.USART2_RX.3.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART2_RX.3.Instance=DMA1_Stream3 +Dma.USART2_RX.3.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_RX.3.MemInc=DMA_MINC_ENABLE +Dma.USART2_RX.3.Mode=DMA_NORMAL +Dma.USART2_RX.3.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_RX.3.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_RX.3.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_RX.3.Priority=DMA_PRIORITY_LOW +Dma.USART2_RX.3.RequestNumber=1 +Dma.USART2_RX.3.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_RX.3.SignalID=NONE +Dma.USART2_RX.3.SyncEnable=DISABLE +Dma.USART2_RX.3.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_RX.3.SyncRequestNumber=1 +Dma.USART2_RX.3.SyncSignalID=NONE +Dma.USART2_TX.4.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART2_TX.4.EventEnable=DISABLE +Dma.USART2_TX.4.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART2_TX.4.Instance=DMA1_Stream4 +Dma.USART2_TX.4.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_TX.4.MemInc=DMA_MINC_ENABLE +Dma.USART2_TX.4.Mode=DMA_NORMAL +Dma.USART2_TX.4.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_TX.4.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_TX.4.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_TX.4.Priority=DMA_PRIORITY_LOW +Dma.USART2_TX.4.RequestNumber=1 +Dma.USART2_TX.4.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_TX.4.SignalID=NONE +Dma.USART2_TX.4.SyncEnable=DISABLE +Dma.USART2_TX.4.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_TX.4.SyncRequestNumber=1 +Dma.USART2_TX.4.SyncSignalID=NONE +Dma.USART3_RX.0.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART3_RX.0.EventEnable=DISABLE +Dma.USART3_RX.0.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART3_RX.0.Instance=DMA1_Stream0 +Dma.USART3_RX.0.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART3_RX.0.MemInc=DMA_MINC_ENABLE +Dma.USART3_RX.0.Mode=DMA_NORMAL +Dma.USART3_RX.0.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART3_RX.0.PeriphInc=DMA_PINC_DISABLE +Dma.USART3_RX.0.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART3_RX.0.Priority=DMA_PRIORITY_LOW +Dma.USART3_RX.0.RequestNumber=1 +Dma.USART3_RX.0.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART3_RX.0.SignalID=NONE +Dma.USART3_RX.0.SyncEnable=DISABLE +Dma.USART3_RX.0.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART3_RX.0.SyncRequestNumber=1 +Dma.USART3_RX.0.SyncSignalID=NONE +Dma.USART6_RX.5.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART6_RX.5.EventEnable=DISABLE +Dma.USART6_RX.5.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART6_RX.5.Instance=DMA1_Stream5 +Dma.USART6_RX.5.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART6_RX.5.MemInc=DMA_MINC_ENABLE +Dma.USART6_RX.5.Mode=DMA_NORMAL +Dma.USART6_RX.5.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART6_RX.5.PeriphInc=DMA_PINC_DISABLE +Dma.USART6_RX.5.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART6_RX.5.Priority=DMA_PRIORITY_LOW +Dma.USART6_RX.5.RequestNumber=1 +Dma.USART6_RX.5.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART6_RX.5.SignalID=NONE +Dma.USART6_RX.5.SyncEnable=DISABLE +Dma.USART6_RX.5.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART6_RX.5.SyncRequestNumber=1 +Dma.USART6_RX.5.SyncSignalID=NONE +Dma.USART6_TX.6.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART6_TX.6.EventEnable=DISABLE +Dma.USART6_TX.6.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART6_TX.6.Instance=DMA1_Stream6 +Dma.USART6_TX.6.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART6_TX.6.MemInc=DMA_MINC_ENABLE +Dma.USART6_TX.6.Mode=DMA_NORMAL +Dma.USART6_TX.6.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART6_TX.6.PeriphInc=DMA_PINC_DISABLE +Dma.USART6_TX.6.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART6_TX.6.Priority=DMA_PRIORITY_LOW +Dma.USART6_TX.6.RequestNumber=1 +Dma.USART6_TX.6.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART6_TX.6.SignalID=NONE +Dma.USART6_TX.6.SyncEnable=DISABLE +Dma.USART6_TX.6.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART6_TX.6.SyncRequestNumber=1 +Dma.USART6_TX.6.SyncSignalID=NONE +FDCAN1.AutoRetransmission=ENABLE +FDCAN1.CalculateBaudRateNominal=1000000 +FDCAN1.CalculateTimeBitNominal=1000 +FDCAN1.CalculateTimeQuantumNominal=25.0 +FDCAN1.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,NominalSyncJumpWidth,NominalPrescaler,NominalTimeSeg1,NominalTimeSeg2,StdFiltersNbr,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,AutoRetransmission +FDCAN1.NominalPrescaler=3 +FDCAN1.NominalSyncJumpWidth=8 +FDCAN1.NominalTimeSeg1=31 +FDCAN1.NominalTimeSeg2=8 +FDCAN1.RxFifo0ElmtsNbr=10 +FDCAN1.StdFiltersNbr=1 +FDCAN1.TxFifoQueueElmtsNbr=32 +FDCAN2.AutoRetransmission=ENABLE +FDCAN2.CalculateBaudRateNominal=1000000 +FDCAN2.CalculateTimeBitNominal=1000 +FDCAN2.CalculateTimeQuantumNominal=25.0 +FDCAN2.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,NominalPrescaler,NominalTimeSeg1,NominalTimeSeg2,NominalSyncJumpWidth,MessageRAMOffset,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,AutoRetransmission +FDCAN2.MessageRAMOffset=169 +FDCAN2.NominalPrescaler=3 +FDCAN2.NominalSyncJumpWidth=8 +FDCAN2.NominalTimeSeg1=31 +FDCAN2.NominalTimeSeg2=8 +FDCAN2.RxFifo0ElmtsNbr=10 +FDCAN2.TxFifoQueueElmtsNbr=32 +FREERTOS.IPParameters=Tasks01,configENABLE_FPU,configUSE_MALLOC_FAILED_HOOK,configCHECK_FOR_STACK_OVERFLOW,configGENERATE_RUN_TIME_STATS,configUSE_STATS_FORMATTING_FUNCTIONS,configTOTAL_HEAP_SIZE +FREERTOS.Tasks01=defaultTask,24,512,StartDefaultTask,As weak,NULL,Dynamic,NULL,NULL +FREERTOS.configCHECK_FOR_STACK_OVERFLOW=2 +FREERTOS.configENABLE_FPU=1 +FREERTOS.configGENERATE_RUN_TIME_STATS=1 +FREERTOS.configTOTAL_HEAP_SIZE=65536 +FREERTOS.configUSE_MALLOC_FAILED_HOOK=1 +FREERTOS.configUSE_STATS_FORMATTING_FUNCTIONS=1 +File.Version=6 +GPIO.groupedBy= +KeepUserPlacement=false +MMTAppRegionsCount=0 +MMTConfigApplied=false +MMTSectionSuffix= +Mcu.CPN=STM32H750VBT6 +Mcu.Family=STM32H7 +Mcu.IP0=BDMA +Mcu.IP1=CORTEX_M7 +Mcu.IP10=QUADSPI +Mcu.IP11=RCC +Mcu.IP12=SPI6 +Mcu.IP13=SYS +Mcu.IP14=TIM6 +Mcu.IP15=UART4 +Mcu.IP16=UART5 +Mcu.IP17=USART1 +Mcu.IP18=USART2 +Mcu.IP19=USART3 +Mcu.IP2=DEBUG +Mcu.IP20=USART6 +Mcu.IP21=USB_DEVICE +Mcu.IP22=USB_OTG_FS +Mcu.IP3=DMA +Mcu.IP4=FDCAN1 +Mcu.IP5=FDCAN2 +Mcu.IP6=FREERTOS +Mcu.IP7=MDMA +Mcu.IP8=MEMORYMAP +Mcu.IP9=NVIC +Mcu.IPNb=23 +Mcu.Name=STM32H750VBTx +Mcu.Package=LQFP100 +Mcu.Pin0=PE5 +Mcu.Pin1=PH0-OSC_IN (PH0) +Mcu.Pin10=PA7 +Mcu.Pin11=PC4 +Mcu.Pin12=PB2 +Mcu.Pin13=PE7 +Mcu.Pin14=PE8 +Mcu.Pin15=PE9 +Mcu.Pin16=PE10 +Mcu.Pin17=PB10 +Mcu.Pin18=PB11 +Mcu.Pin19=PB12 +Mcu.Pin2=PH1-OSC_OUT (PH1) +Mcu.Pin20=PB13 +Mcu.Pin21=PD15 +Mcu.Pin22=PC6 +Mcu.Pin23=PC7 +Mcu.Pin24=PA9 +Mcu.Pin25=PA10 +Mcu.Pin26=PA11 +Mcu.Pin27=PA12 +Mcu.Pin28=PA13 (JTMS/SWDIO) +Mcu.Pin29=PA14 (JTCK/SWCLK) +Mcu.Pin3=PA0 +Mcu.Pin30=PC11 +Mcu.Pin31=PD0 +Mcu.Pin32=PD1 +Mcu.Pin33=PB5 +Mcu.Pin34=PB6 +Mcu.Pin35=VP_FREERTOS_VS_CMSIS_V2 +Mcu.Pin36=VP_SYS_VS_tim14 +Mcu.Pin37=VP_TIM6_VS_ClockSourceINT +Mcu.Pin38=VP_USB_DEVICE_VS_USB_DEVICE_CDC_FS +Mcu.Pin39=VP_MEMORYMAP_VS_MEMORYMAP +Mcu.Pin4=PA1 +Mcu.Pin5=PA2 +Mcu.Pin6=PA3 +Mcu.Pin7=PA4 +Mcu.Pin8=PA5 +Mcu.Pin9=PA6 +Mcu.PinsNb=40 +Mcu.ThirdPartyNb=0 +Mcu.UserConstants= +Mcu.UserName=STM32H750VBTx +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.BlockCount=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.BlockDataLength=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.BufferTransferLength=1 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.CircularMode=MDMA_LINEAR_LIST +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DataAlignment=MDMA_DATAALIGN_PACKENABLE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DestBlockAddressOffset=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DestBurst=MDMA_DEST_BURST_SINGLE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DestDataSize=MDMA_DEST_DATASIZE_BYTE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DestinationInc=MDMA_DEST_INC_BYTE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.DstAddress=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.Endianness=MDMA_LITTLE_ENDIANNESS_PRESERVE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.Instance=MDMA_Channel0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.MaskAddress=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.MaskData=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.Priority=MDMA_PRIORITY_LOW +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.Rank=First +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.RequestParameters=Instance,CircularMode,TransferTriggerMode,Priority,Endianness,SourceInc,DestinationInc,SourceDataSize,DestDataSize,DataAlignment,BufferTransferLength,SourceBurst,DestBurst,SourceBlockAddressOffset,DestBlockAddressOffset,MaskAddress,MaskData,SrcAddress,DstAddress,BlockDataLength,BlockCount,Rank +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.SourceBlockAddressOffset=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.SourceBurst=MDMA_SOURCE_BURST_SINGLE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.SourceDataSize=MDMA_SRC_DATASIZE_BYTE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.SourceInc=MDMA_SRC_INC_BYTE +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.SrcAddress=0 +Mdma.MDMA_Channel0.QUADSPI_FIFO_TH.0.TransferTriggerMode=MDMA_BUFFER_TRANSFER +Mdma.MDMA_Channel0.Request0=QUADSPI_FIFO_TH +Mdma.MDMA_Channel0.RequestsNb=1 +Mdma.RequestSet0=MDMA_Channel0 +Mdma.RequestSetsNb=1 +MxCube.Version=6.18.1 +MxDb.Version=DB.6.0.181 +NVIC.BDMA_Channel0_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.DMA1_Stream0_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream3_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream4_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream5_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream7_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream0_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.FDCAN1_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN2_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.ForceEnableDMAVector=true +NVIC.HardFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.MDMA_IRQn=true\:5\:0\:false\:false\:true\:false\:false\:true\:true +NVIC.MemoryManagement_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.NonMaskableInt_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.OTG_FS_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.PendSV_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:false\:false +NVIC.PriorityGroup=NVIC_PRIORITYGROUP_4 +NVIC.QUADSPI_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.SPI6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.SVCall_IRQn=true\:0\:0\:false\:false\:false\:false\:false\:false\:false +NVIC.SavedPendsvIrqHandlerGenerated=true +NVIC.SavedSvcallIrqHandlerGenerated=true +NVIC.SavedSystickIrqHandlerGenerated=true +NVIC.SysTick_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:true\:false +NVIC.TIM8_TRG_COM_TIM14_IRQn=true\:15\:0\:false\:false\:true\:false\:false\:true\:true +NVIC.TimeBase=TIM8_TRG_COM_TIM14_IRQn +NVIC.TimeBaseIP=TIM14 +NVIC.UART4_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART5_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART2_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART3_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART6_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UsageFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +PA0.Mode=Asynchronous +PA0.Signal=UART4_TX +PA1.Mode=Asynchronous +PA1.Signal=UART4_RX +PA10.Locked=true +PA10.Mode=Asynchronous +PA10.Signal=USART1_RX +PA11.Locked=true +PA11.Mode=Device_Only +PA11.Signal=USB_OTG_FS_DM +PA12.Locked=true +PA12.Mode=Device_Only +PA12.Signal=USB_OTG_FS_DP +PA13\ (JTMS/SWDIO).Mode=Serial_Wire +PA13\ (JTMS/SWDIO).Signal=DEBUG_JTMS-SWDIO +PA14\ (JTCK/SWCLK).Mode=Serial_Wire +PA14\ (JTCK/SWCLK).Signal=DEBUG_JTCK-SWCLK +PA2.Mode=Asynchronous +PA2.Signal=USART2_TX +PA3.Mode=Asynchronous +PA3.Signal=USART2_RX +PA4.GPIOParameters=GPIO_Label +PA4.GPIO_Label=SPI6_CS_GYRO +PA4.Locked=true +PA4.Signal=GPIO_Output +PA5.Locked=true +PA5.Mode=Full_Duplex_Master +PA5.Signal=SPI6_SCK +PA6.Locked=true +PA6.Mode=Full_Duplex_Master +PA6.Signal=SPI6_MISO +PA7.Locked=true +PA7.Mode=Full_Duplex_Master +PA7.Signal=SPI6_MOSI +PA9.Locked=true +PA9.Mode=Asynchronous +PA9.Signal=USART1_TX +PB10.Mode=Asynchronous +PB10.Signal=USART3_TX +PB11.Locked=true +PB11.Mode=Asynchronous +PB11.Signal=USART3_RX +PB12.Mode=Asynchronous +PB12.Signal=UART5_RX +PB13.Mode=Asynchronous +PB13.Signal=UART5_TX +PB2.GPIOParameters=GPIO_Speed +PB2.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PB2.Locked=true +PB2.Mode=Single Bank 2 +PB2.Signal=QUADSPI_CLK +PB5.Locked=true +PB5.Mode=FDCAN_Activate +PB5.Signal=FDCAN2_RX +PB6.Locked=true +PB6.Mode=FDCAN_Activate +PB6.Signal=FDCAN2_TX +PC11.GPIOParameters=GPIO_Speed +PC11.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC11.Mode=Single Bank 2 +PC11.Signal=QUADSPI_BK2_NCS +PC4.GPIOParameters=GPIO_Label +PC4.GPIO_Label=SPI6_CS_ACCEL +PC4.Locked=true +PC4.Signal=GPIO_Output +PC6.Mode=Asynchronous +PC6.Signal=USART6_TX +PC7.Mode=Asynchronous +PC7.Signal=USART6_RX +PD0.Locked=true +PD0.Mode=FDCAN_Activate +PD0.Signal=FDCAN1_RX +PD1.Locked=true +PD1.Mode=FDCAN_Activate +PD1.Signal=FDCAN1_TX +PD15.GPIOParameters=GPIO_Label +PD15.GPIO_Label=USART6_DE +PD15.Locked=true +PD15.Signal=GPIO_Output +PE10.GPIOParameters=GPIO_Speed +PE10.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PE10.Locked=true +PE10.Mode=Single Bank 2 +PE10.Signal=QUADSPI_BK2_IO3 +PE5.Locked=true +PE5.Signal=GPIO_Output +PE7.GPIOParameters=GPIO_Speed +PE7.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PE7.Locked=true +PE7.Mode=Single Bank 2 +PE7.Signal=QUADSPI_BK2_IO0 +PE8.GPIOParameters=GPIO_Speed +PE8.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PE8.Locked=true +PE8.Mode=Single Bank 2 +PE8.Signal=QUADSPI_BK2_IO1 +PE9.GPIOParameters=GPIO_Speed +PE9.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PE9.Locked=true +PE9.Mode=Single Bank 2 +PE9.Signal=QUADSPI_BK2_IO2 +PH0-OSC_IN\ (PH0).Mode=HSE-External-Oscillator +PH0-OSC_IN\ (PH0).Signal=RCC_OSC_IN +PH1-OSC_OUT\ (PH1).Mode=HSE-External-Oscillator +PH1-OSC_OUT\ (PH1).Signal=RCC_OSC_OUT +PinOutPanel.RotationAngle=0 +ProjectManager.AskForMigrate=true +ProjectManager.BackupPrevious=false +ProjectManager.CompilerLinker=GCC +ProjectManager.CompilerOptimize=6 +ProjectManager.ComputerToolchain=false +ProjectManager.CoupleFile=true +ProjectManager.CustomerFirmwarePackage= +ProjectManager.DefaultFWLocation=true +ProjectManager.DeletePrevious=true +ProjectManager.DeviceId=STM32H750VBTx +ProjectManager.FirmwarePackage=STM32Cube FW_H7 V1.13.0 +ProjectManager.FreePins=false +ProjectManager.FreePinsContext= +ProjectManager.HalAssertFull=false +ProjectManager.HeapSize=0x200 +ProjectManager.KeepUserCode=true +ProjectManager.LastFirmware=true +ProjectManager.LibraryCopy=1 +ProjectManager.MainLocation=Core/Src +ProjectManager.NoMain=false +ProjectManager.PreviousToolchain= +ProjectManager.ProjectBuild=false +ProjectManager.ProjectFileName=H750_FULL_TEST.ioc +ProjectManager.ProjectName=H750_FULL_TEST +ProjectManager.ProjectStructure= +ProjectManager.RegisterCallBack= +ProjectManager.StackSize=0x400 +ProjectManager.TargetToolchain=CMake +ProjectManager.ToolChainLocation= +ProjectManager.UAScriptAfterPath= +ProjectManager.UAScriptBeforePath= +ProjectManager.UnderRoot=false +ProjectManager.functionlistsort=1-SystemClock_Config-RCC-false-HAL-false,2-MX_GPIO_Init-GPIO-false-HAL-true,3-MX_MDMA_Init-MDMA-false-HAL-true,4-MX_BDMA_Init-BDMA-false-HAL-true,5-MX_DMA_Init-DMA-false-HAL-true,6-MX_FDCAN1_Init-FDCAN1-false-HAL-true,7-MX_FDCAN2_Init-FDCAN2-false-HAL-true,8-MX_QUADSPI_Init-QUADSPI-false-HAL-true,9-MX_SPI6_Init-SPI6-false-HAL-true,10-MX_UART4_Init-UART4-false-HAL-true,11-MX_UART5_Init-UART5-false-HAL-true,12-MX_USART1_UART_Init-USART1-false-HAL-true,13-MX_USART2_UART_Init-USART2-false-HAL-true,14-MX_USART3_UART_Init-USART3-false-HAL-true,15-MX_USB_DEVICE_Init-USB_DEVICE-false-HAL-false,16-MX_USART6_UART_Init-USART6-false-HAL-true,17-MX_TIM6_Init-TIM6-false-HAL-true,0-MX_CORTEX_M7_Init-CORTEX_M7-false-HAL-true +QUADSPI.ChipSelectHighTime=QSPI_CS_HIGH_TIME_6_CYCLE +QUADSPI.ClockPrescaler=2 +QUADSPI.FlashSize=23 +QUADSPI.IPParameters=FlashSize,ClockPrescaler,SampleShifting,ChipSelectHighTime +QUADSPI.SampleShifting=QSPI_SAMPLE_SHIFTING_HALFCYCLE +RCC.ADCFreq_Value=16125000 +RCC.AHB12Freq_Value=240000000 +RCC.AHB4Freq_Value=240000000 +RCC.APB1Freq_Value=120000000 +RCC.APB2Freq_Value=120000000 +RCC.APB3Freq_Value=120000000 +RCC.APB4Freq_Value=120000000 +RCC.AXIClockFreq_Value=240000000 +RCC.CECFreq_Value=32000 +RCC.CKPERFreq_Value=8000000 +RCC.CKPERSourceSelection=RCC_CLKPSOURCE_HSE +RCC.CortexFreq_Value=480000000 +RCC.CpuClockFreq_Value=480000000 +RCC.D1CPREFreq_Value=480000000 +RCC.D1PPRE=RCC_APB3_DIV2 +RCC.D2PPRE1=RCC_APB1_DIV2 +RCC.D2PPRE2=RCC_APB2_DIV2 +RCC.D3PPRE=RCC_APB4_DIV2 +RCC.DFSDMACLkFreq_Value=120000000 +RCC.DFSDMFreq_Value=120000000 +RCC.DIVM1=1 +RCC.DIVM3=1 +RCC.DIVN1=120 +RCC.DIVN3=120 +RCC.DIVP1Freq_Value=480000000 +RCC.DIVP2Freq_Value=16125000 +RCC.DIVP3Freq_Value=480000000 +RCC.DIVQ1=8 +RCC.DIVQ1Freq_Value=120000000 +RCC.DIVQ2Freq_Value=16125000 +RCC.DIVQ3=20 +RCC.DIVQ3Freq_Value=48000000 +RCC.DIVR1=8 +RCC.DIVR1Freq_Value=120000000 +RCC.DIVR2Freq_Value=16125000 +RCC.DIVR3Freq_Value=480000000 +RCC.FDCANFreq_Value=120000000 +RCC.FMCFreq_Value=240000000 +RCC.FamilyName=M +RCC.HCLK3ClockFreq_Value=240000000 +RCC.HCLKFreq_Value=240000000 +RCC.HPRE=RCC_HCLK_DIV2 +RCC.HRTIMFreq_Value=240000000 +RCC.HSE_VALUE=8000000 +RCC.I2C123Freq_Value=120000000 +RCC.I2C4Freq_Value=120000000 +RCC.IPParameters=ADCFreq_Value,AHB12Freq_Value,AHB4Freq_Value,APB1Freq_Value,APB2Freq_Value,APB3Freq_Value,APB4Freq_Value,AXIClockFreq_Value,CECFreq_Value,CKPERFreq_Value,CKPERSourceSelection,CortexFreq_Value,CpuClockFreq_Value,D1CPREFreq_Value,D1PPRE,D2PPRE1,D2PPRE2,D3PPRE,DFSDMACLkFreq_Value,DFSDMFreq_Value,DIVM1,DIVM3,DIVN1,DIVN3,DIVP1Freq_Value,DIVP2Freq_Value,DIVP3Freq_Value,DIVQ1,DIVQ1Freq_Value,DIVQ2Freq_Value,DIVQ3,DIVQ3Freq_Value,DIVR1,DIVR1Freq_Value,DIVR2Freq_Value,DIVR3Freq_Value,FDCANFreq_Value,FMCFreq_Value,FamilyName,HCLK3ClockFreq_Value,HCLKFreq_Value,HPRE,HRTIMFreq_Value,HSE_VALUE,I2C123Freq_Value,I2C4Freq_Value,LPTIM1Freq_Value,LPTIM2Freq_Value,LPTIM345Freq_Value,LPUART1Freq_Value,LTDCFreq_Value,MCO1PinFreq_Value,MCO2PinFreq_Value,PLLFRACN,QSPIFreq_Value,RNGFreq_Value,RTCFreq_Value,SAI1Freq_Value,SAI23Freq_Value,SAI4AFreq_Value,SAI4BFreq_Value,SDMMCFreq_Value,SPDIFRXFreq_Value,SPI123Freq_Value,SPI45Freq_Value,SPI6Freq_Value,SWPMI1Freq_Value,SYSCLKFreq_VALUE,SYSCLKSource,Tim1OutputFreq_Value,Tim2OutputFreq_Value,TraceFreq_Value,USART16Freq_Value,USART234578Freq_Value,USBCLockSelection,USBFreq_Value,VCO1OutputFreq_Value,VCO2OutputFreq_Value,VCO3OutputFreq_Value,VCOInput1Freq_Value,VCOInput2Freq_Value,VCOInput3Freq_Value +RCC.LPTIM1Freq_Value=120000000 +RCC.LPTIM2Freq_Value=120000000 +RCC.LPTIM345Freq_Value=120000000 +RCC.LPUART1Freq_Value=120000000 +RCC.LTDCFreq_Value=480000000 +RCC.MCO1PinFreq_Value=64000000 +RCC.MCO2PinFreq_Value=480000000 +RCC.PLLFRACN=0 +RCC.QSPIFreq_Value=240000000 +RCC.RNGFreq_Value=48000000 +RCC.RTCFreq_Value=32000 +RCC.SAI1Freq_Value=120000000 +RCC.SAI23Freq_Value=120000000 +RCC.SAI4AFreq_Value=120000000 +RCC.SAI4BFreq_Value=120000000 +RCC.SDMMCFreq_Value=120000000 +RCC.SPDIFRXFreq_Value=120000000 +RCC.SPI123Freq_Value=120000000 +RCC.SPI45Freq_Value=120000000 +RCC.SPI6Freq_Value=120000000 +RCC.SWPMI1Freq_Value=120000000 +RCC.SYSCLKFreq_VALUE=480000000 +RCC.SYSCLKSource=RCC_SYSCLKSOURCE_PLLCLK +RCC.Tim1OutputFreq_Value=240000000 +RCC.Tim2OutputFreq_Value=240000000 +RCC.TraceFreq_Value=120000000 +RCC.USART16Freq_Value=120000000 +RCC.USART234578Freq_Value=120000000 +RCC.USBCLockSelection=RCC_USBCLKSOURCE_PLL3 +RCC.USBFreq_Value=48000000 +RCC.VCO1OutputFreq_Value=960000000 +RCC.VCO2OutputFreq_Value=32250000 +RCC.VCO3OutputFreq_Value=960000000 +RCC.VCOInput1Freq_Value=8000000 +RCC.VCOInput2Freq_Value=250000 +RCC.VCOInput3Freq_Value=8000000 +SPI6.BaudRatePrescaler=SPI_BAUDRATEPRESCALER_16 +SPI6.CalculateBaudRate=7.5 MBits/s +SPI6.DataSize=SPI_DATASIZE_8BIT +SPI6.Direction=SPI_DIRECTION_2LINES +SPI6.IPParameters=VirtualType,Mode,Direction,CalculateBaudRate,BaudRatePrescaler,MasterKeepIOState,DataSize +SPI6.MasterKeepIOState=SPI_MASTER_KEEP_IO_STATE_ENABLE +SPI6.Mode=SPI_MODE_MASTER +SPI6.VirtualType=VM_MASTER +TIM6.IPParameters=Prescaler,Period +TIM6.Period=1000-1 +TIM6.Prescaler=480-1 +USART1.IPParameters=VirtualMode-Asynchronous +USART1.VirtualMode-Asynchronous=VM_ASYNC +USART2.IPParameters=VirtualMode-Asynchronous +USART2.VirtualMode-Asynchronous=VM_ASYNC +USART3.BaudRate=100000 +USART3.IPParameters=VirtualMode-Asynchronous,BaudRate,WordLength,Parity +USART3.Parity=PARITY_EVEN +USART3.VirtualMode-Asynchronous=VM_ASYNC +USART3.WordLength=WORDLENGTH_9B +USART6.IPParameters=VirtualMode +USART6.VirtualMode=VM_ASYNC +USB_DEVICE.CLASS_NAME_FS=CDC +USB_DEVICE.IPParameters=VirtualMode-CDC_FS,VirtualModeFS,CLASS_NAME_FS +USB_DEVICE.VirtualMode-CDC_FS=Cdc +USB_DEVICE.VirtualModeFS=Cdc_FS +USB_OTG_FS.IPParameters=VirtualMode +USB_OTG_FS.VirtualMode=Device_Only +VP_FREERTOS_VS_CMSIS_V2.Mode=CMSIS_V2 +VP_FREERTOS_VS_CMSIS_V2.Signal=FREERTOS_VS_CMSIS_V2 +VP_MEMORYMAP_VS_MEMORYMAP.Mode=CurAppReg +VP_MEMORYMAP_VS_MEMORYMAP.Signal=MEMORYMAP_VS_MEMORYMAP +VP_SYS_VS_tim14.Mode=TIM14 +VP_SYS_VS_tim14.Signal=SYS_VS_tim14 +VP_TIM6_VS_ClockSourceINT.Mode=Enable_Timer +VP_TIM6_VS_ClockSourceINT.Signal=TIM6_VS_ClockSourceINT +VP_USB_DEVICE_VS_USB_DEVICE_CDC_FS.Mode=CDC_FS +VP_USB_DEVICE_VS_USB_DEVICE_CDC_FS.Signal=USB_DEVICE_VS_USB_DEVICE_CDC_FS +board=custom +rtos.0.ip=FREERTOS diff --git a/tools/tests/fixtures/mc02_h723.ioc b/tools/tests/fixtures/mc02_h723.ioc new file mode 100644 index 0000000..87e2b2c --- /dev/null +++ b/tools/tests/fixtures/mc02_h723.ioc @@ -0,0 +1,937 @@ +#MicroXplorer Configuration settings - do not modify +CAD.formats= +CAD.pinconfig= +CAD.provider= +CORTEX_M7.BaseAddress-Cortex_Memory_Protection_Unit_Region0_Settings=0x24000000 +CORTEX_M7.CPU_DCache=Disabled +CORTEX_M7.CPU_ICache=Disabled +CORTEX_M7.Enable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_REGION_ENABLE +CORTEX_M7.IPParameters=CPU_DCache,CPU_ICache,MPU_Control,Enable-Cortex_Memory_Protection_Unit_Region0_Settings,BaseAddress-Cortex_Memory_Protection_Unit_Region0_Settings,Size-Cortex_Memory_Protection_Unit_Region0_Settings,TypeExtField-Cortex_Memory_Protection_Unit_Region0_Settings,IsCacheable-Cortex_Memory_Protection_Unit_Region0_Settings,IsBufferable-Cortex_Memory_Protection_Unit_Region0_Settings +CORTEX_M7.IsBufferable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_ACCESS_BUFFERABLE +CORTEX_M7.IsCacheable-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_ACCESS_CACHEABLE +CORTEX_M7.MPU_Control=__NULL +CORTEX_M7.Size-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_REGION_SIZE_512B +CORTEX_M7.TypeExtField-Cortex_Memory_Protection_Unit_Region0_Settings=MPU_TEX_LEVEL1 +Dma.Request0=USART1_RX +Dma.Request1=USART1_TX +Dma.Request10=USART10_RX +Dma.Request11=USART10_TX +Dma.Request12=UART5_RX +Dma.Request13=USART3_RX +Dma.Request14=USART3_TX +Dma.Request2=UART4_RX +Dma.Request3=UART4_TX +Dma.Request4=UART7_RX +Dma.Request5=UART7_TX +Dma.Request6=SPI2_RX +Dma.Request7=SPI2_TX +Dma.Request8=USART2_RX +Dma.Request9=USART2_TX +Dma.RequestsNb=15 +Dma.SPI2_RX.6.Direction=DMA_PERIPH_TO_MEMORY +Dma.SPI2_RX.6.EventEnable=DISABLE +Dma.SPI2_RX.6.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.SPI2_RX.6.Instance=DMA1_Stream0 +Dma.SPI2_RX.6.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.SPI2_RX.6.MemInc=DMA_MINC_ENABLE +Dma.SPI2_RX.6.Mode=DMA_NORMAL +Dma.SPI2_RX.6.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.SPI2_RX.6.PeriphInc=DMA_PINC_DISABLE +Dma.SPI2_RX.6.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.SPI2_RX.6.Priority=DMA_PRIORITY_HIGH +Dma.SPI2_RX.6.RequestNumber=1 +Dma.SPI2_RX.6.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.SPI2_RX.6.SignalID=NONE +Dma.SPI2_RX.6.SyncEnable=DISABLE +Dma.SPI2_RX.6.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.SPI2_RX.6.SyncRequestNumber=1 +Dma.SPI2_RX.6.SyncSignalID=NONE +Dma.SPI2_TX.7.Direction=DMA_MEMORY_TO_PERIPH +Dma.SPI2_TX.7.EventEnable=DISABLE +Dma.SPI2_TX.7.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.SPI2_TX.7.Instance=DMA1_Stream7 +Dma.SPI2_TX.7.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.SPI2_TX.7.MemInc=DMA_MINC_ENABLE +Dma.SPI2_TX.7.Mode=DMA_NORMAL +Dma.SPI2_TX.7.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.SPI2_TX.7.PeriphInc=DMA_PINC_DISABLE +Dma.SPI2_TX.7.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.SPI2_TX.7.Priority=DMA_PRIORITY_LOW +Dma.SPI2_TX.7.RequestNumber=1 +Dma.SPI2_TX.7.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.SPI2_TX.7.SignalID=NONE +Dma.SPI2_TX.7.SyncEnable=DISABLE +Dma.SPI2_TX.7.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.SPI2_TX.7.SyncRequestNumber=1 +Dma.SPI2_TX.7.SyncSignalID=NONE +Dma.UART4_RX.2.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART4_RX.2.EventEnable=DISABLE +Dma.UART4_RX.2.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART4_RX.2.Instance=DMA1_Stream3 +Dma.UART4_RX.2.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_RX.2.MemInc=DMA_MINC_ENABLE +Dma.UART4_RX.2.Mode=DMA_NORMAL +Dma.UART4_RX.2.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_RX.2.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_RX.2.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_RX.2.Priority=DMA_PRIORITY_LOW +Dma.UART4_RX.2.RequestNumber=1 +Dma.UART4_RX.2.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_RX.2.SignalID=NONE +Dma.UART4_RX.2.SyncEnable=DISABLE +Dma.UART4_RX.2.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_RX.2.SyncRequestNumber=1 +Dma.UART4_RX.2.SyncSignalID=NONE +Dma.UART4_TX.3.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART4_TX.3.EventEnable=DISABLE +Dma.UART4_TX.3.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.UART4_TX.3.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.UART4_TX.3.Instance=DMA1_Stream4 +Dma.UART4_TX.3.MemBurst=DMA_MBURST_SINGLE +Dma.UART4_TX.3.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART4_TX.3.MemInc=DMA_MINC_ENABLE +Dma.UART4_TX.3.Mode=DMA_NORMAL +Dma.UART4_TX.3.PeriphBurst=DMA_PBURST_SINGLE +Dma.UART4_TX.3.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART4_TX.3.PeriphInc=DMA_PINC_DISABLE +Dma.UART4_TX.3.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART4_TX.3.Priority=DMA_PRIORITY_LOW +Dma.UART4_TX.3.RequestNumber=1 +Dma.UART4_TX.3.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART4_TX.3.SignalID=NONE +Dma.UART4_TX.3.SyncEnable=DISABLE +Dma.UART4_TX.3.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART4_TX.3.SyncRequestNumber=1 +Dma.UART4_TX.3.SyncSignalID=NONE +Dma.UART5_RX.12.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART5_RX.12.EventEnable=DISABLE +Dma.UART5_RX.12.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART5_RX.12.Instance=DMA2_Stream5 +Dma.UART5_RX.12.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART5_RX.12.MemInc=DMA_MINC_ENABLE +Dma.UART5_RX.12.Mode=DMA_NORMAL +Dma.UART5_RX.12.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART5_RX.12.PeriphInc=DMA_PINC_DISABLE +Dma.UART5_RX.12.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART5_RX.12.Priority=DMA_PRIORITY_LOW +Dma.UART5_RX.12.RequestNumber=1 +Dma.UART5_RX.12.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART5_RX.12.SignalID=NONE +Dma.UART5_RX.12.SyncEnable=DISABLE +Dma.UART5_RX.12.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART5_RX.12.SyncRequestNumber=1 +Dma.UART5_RX.12.SyncSignalID=NONE +Dma.UART7_RX.4.Direction=DMA_PERIPH_TO_MEMORY +Dma.UART7_RX.4.EventEnable=DISABLE +Dma.UART7_RX.4.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.UART7_RX.4.Instance=DMA1_Stream5 +Dma.UART7_RX.4.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART7_RX.4.MemInc=DMA_MINC_ENABLE +Dma.UART7_RX.4.Mode=DMA_NORMAL +Dma.UART7_RX.4.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART7_RX.4.PeriphInc=DMA_PINC_DISABLE +Dma.UART7_RX.4.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART7_RX.4.Priority=DMA_PRIORITY_LOW +Dma.UART7_RX.4.RequestNumber=1 +Dma.UART7_RX.4.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART7_RX.4.SignalID=NONE +Dma.UART7_RX.4.SyncEnable=DISABLE +Dma.UART7_RX.4.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART7_RX.4.SyncRequestNumber=1 +Dma.UART7_RX.4.SyncSignalID=NONE +Dma.UART7_TX.5.Direction=DMA_MEMORY_TO_PERIPH +Dma.UART7_TX.5.EventEnable=DISABLE +Dma.UART7_TX.5.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.UART7_TX.5.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.UART7_TX.5.Instance=DMA1_Stream6 +Dma.UART7_TX.5.MemBurst=DMA_MBURST_SINGLE +Dma.UART7_TX.5.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.UART7_TX.5.MemInc=DMA_MINC_ENABLE +Dma.UART7_TX.5.Mode=DMA_NORMAL +Dma.UART7_TX.5.PeriphBurst=DMA_PBURST_SINGLE +Dma.UART7_TX.5.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.UART7_TX.5.PeriphInc=DMA_PINC_DISABLE +Dma.UART7_TX.5.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.UART7_TX.5.Priority=DMA_PRIORITY_LOW +Dma.UART7_TX.5.RequestNumber=1 +Dma.UART7_TX.5.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.UART7_TX.5.SignalID=NONE +Dma.UART7_TX.5.SyncEnable=DISABLE +Dma.UART7_TX.5.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.UART7_TX.5.SyncRequestNumber=1 +Dma.UART7_TX.5.SyncSignalID=NONE +Dma.USART10_RX.10.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART10_RX.10.EventEnable=DISABLE +Dma.USART10_RX.10.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART10_RX.10.Instance=DMA2_Stream3 +Dma.USART10_RX.10.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART10_RX.10.MemInc=DMA_MINC_ENABLE +Dma.USART10_RX.10.Mode=DMA_NORMAL +Dma.USART10_RX.10.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART10_RX.10.PeriphInc=DMA_PINC_DISABLE +Dma.USART10_RX.10.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART10_RX.10.Priority=DMA_PRIORITY_LOW +Dma.USART10_RX.10.RequestNumber=1 +Dma.USART10_RX.10.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART10_RX.10.SignalID=NONE +Dma.USART10_RX.10.SyncEnable=DISABLE +Dma.USART10_RX.10.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART10_RX.10.SyncRequestNumber=1 +Dma.USART10_RX.10.SyncSignalID=NONE +Dma.USART10_TX.11.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART10_TX.11.EventEnable=DISABLE +Dma.USART10_TX.11.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART10_TX.11.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART10_TX.11.Instance=DMA2_Stream4 +Dma.USART10_TX.11.MemBurst=DMA_MBURST_SINGLE +Dma.USART10_TX.11.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART10_TX.11.MemInc=DMA_MINC_ENABLE +Dma.USART10_TX.11.Mode=DMA_NORMAL +Dma.USART10_TX.11.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART10_TX.11.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART10_TX.11.PeriphInc=DMA_PINC_DISABLE +Dma.USART10_TX.11.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART10_TX.11.Priority=DMA_PRIORITY_LOW +Dma.USART10_TX.11.RequestNumber=1 +Dma.USART10_TX.11.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART10_TX.11.SignalID=NONE +Dma.USART10_TX.11.SyncEnable=DISABLE +Dma.USART10_TX.11.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART10_TX.11.SyncRequestNumber=1 +Dma.USART10_TX.11.SyncSignalID=NONE +Dma.USART1_RX.0.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART1_RX.0.EventEnable=DISABLE +Dma.USART1_RX.0.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART1_RX.0.Instance=DMA1_Stream1 +Dma.USART1_RX.0.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_RX.0.MemInc=DMA_MINC_ENABLE +Dma.USART1_RX.0.Mode=DMA_NORMAL +Dma.USART1_RX.0.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_RX.0.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_RX.0.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_RX.0.Priority=DMA_PRIORITY_LOW +Dma.USART1_RX.0.RequestNumber=1 +Dma.USART1_RX.0.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_RX.0.SignalID=NONE +Dma.USART1_RX.0.SyncEnable=DISABLE +Dma.USART1_RX.0.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_RX.0.SyncRequestNumber=1 +Dma.USART1_RX.0.SyncSignalID=NONE +Dma.USART1_TX.1.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART1_TX.1.EventEnable=DISABLE +Dma.USART1_TX.1.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART1_TX.1.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART1_TX.1.Instance=DMA1_Stream2 +Dma.USART1_TX.1.MemBurst=DMA_MBURST_SINGLE +Dma.USART1_TX.1.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART1_TX.1.MemInc=DMA_MINC_ENABLE +Dma.USART1_TX.1.Mode=DMA_NORMAL +Dma.USART1_TX.1.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART1_TX.1.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART1_TX.1.PeriphInc=DMA_PINC_DISABLE +Dma.USART1_TX.1.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART1_TX.1.Priority=DMA_PRIORITY_LOW +Dma.USART1_TX.1.RequestNumber=1 +Dma.USART1_TX.1.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART1_TX.1.SignalID=NONE +Dma.USART1_TX.1.SyncEnable=DISABLE +Dma.USART1_TX.1.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART1_TX.1.SyncRequestNumber=1 +Dma.USART1_TX.1.SyncSignalID=NONE +Dma.USART2_RX.8.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART2_RX.8.EventEnable=DISABLE +Dma.USART2_RX.8.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART2_RX.8.Instance=DMA2_Stream1 +Dma.USART2_RX.8.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_RX.8.MemInc=DMA_MINC_ENABLE +Dma.USART2_RX.8.Mode=DMA_NORMAL +Dma.USART2_RX.8.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_RX.8.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_RX.8.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_RX.8.Priority=DMA_PRIORITY_LOW +Dma.USART2_RX.8.RequestNumber=1 +Dma.USART2_RX.8.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_RX.8.SignalID=NONE +Dma.USART2_RX.8.SyncEnable=DISABLE +Dma.USART2_RX.8.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_RX.8.SyncRequestNumber=1 +Dma.USART2_RX.8.SyncSignalID=NONE +Dma.USART2_TX.9.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART2_TX.9.EventEnable=DISABLE +Dma.USART2_TX.9.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART2_TX.9.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART2_TX.9.Instance=DMA2_Stream2 +Dma.USART2_TX.9.MemBurst=DMA_MBURST_SINGLE +Dma.USART2_TX.9.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART2_TX.9.MemInc=DMA_MINC_ENABLE +Dma.USART2_TX.9.Mode=DMA_NORMAL +Dma.USART2_TX.9.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART2_TX.9.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART2_TX.9.PeriphInc=DMA_PINC_DISABLE +Dma.USART2_TX.9.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART2_TX.9.Priority=DMA_PRIORITY_LOW +Dma.USART2_TX.9.RequestNumber=1 +Dma.USART2_TX.9.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART2_TX.9.SignalID=NONE +Dma.USART2_TX.9.SyncEnable=DISABLE +Dma.USART2_TX.9.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART2_TX.9.SyncRequestNumber=1 +Dma.USART2_TX.9.SyncSignalID=NONE +Dma.USART3_RX.13.Direction=DMA_PERIPH_TO_MEMORY +Dma.USART3_RX.13.EventEnable=DISABLE +Dma.USART3_RX.13.FIFOMode=DMA_FIFOMODE_DISABLE +Dma.USART3_RX.13.Instance=DMA2_Stream6 +Dma.USART3_RX.13.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART3_RX.13.MemInc=DMA_MINC_ENABLE +Dma.USART3_RX.13.Mode=DMA_NORMAL +Dma.USART3_RX.13.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART3_RX.13.PeriphInc=DMA_PINC_DISABLE +Dma.USART3_RX.13.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART3_RX.13.Priority=DMA_PRIORITY_LOW +Dma.USART3_RX.13.RequestNumber=1 +Dma.USART3_RX.13.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART3_RX.13.SignalID=NONE +Dma.USART3_RX.13.SyncEnable=DISABLE +Dma.USART3_RX.13.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART3_RX.13.SyncRequestNumber=1 +Dma.USART3_RX.13.SyncSignalID=NONE +Dma.USART3_TX.14.Direction=DMA_MEMORY_TO_PERIPH +Dma.USART3_TX.14.EventEnable=DISABLE +Dma.USART3_TX.14.FIFOMode=DMA_FIFOMODE_ENABLE +Dma.USART3_TX.14.FIFOThreshold=DMA_FIFO_THRESHOLD_HALFFULL +Dma.USART3_TX.14.Instance=DMA2_Stream7 +Dma.USART3_TX.14.MemBurst=DMA_MBURST_SINGLE +Dma.USART3_TX.14.MemDataAlignment=DMA_MDATAALIGN_BYTE +Dma.USART3_TX.14.MemInc=DMA_MINC_ENABLE +Dma.USART3_TX.14.Mode=DMA_NORMAL +Dma.USART3_TX.14.PeriphBurst=DMA_PBURST_SINGLE +Dma.USART3_TX.14.PeriphDataAlignment=DMA_PDATAALIGN_BYTE +Dma.USART3_TX.14.PeriphInc=DMA_PINC_DISABLE +Dma.USART3_TX.14.Polarity=HAL_DMAMUX_REQ_GEN_RISING +Dma.USART3_TX.14.Priority=DMA_PRIORITY_LOW +Dma.USART3_TX.14.RequestNumber=1 +Dma.USART3_TX.14.RequestParameters=Instance,Direction,PeriphInc,MemInc,PeriphDataAlignment,MemDataAlignment,Mode,Priority,FIFOMode,FIFOThreshold,MemBurst,PeriphBurst,SignalID,Polarity,RequestNumber,SyncSignalID,SyncPolarity,SyncEnable,EventEnable,SyncRequestNumber +Dma.USART3_TX.14.SignalID=NONE +Dma.USART3_TX.14.SyncEnable=DISABLE +Dma.USART3_TX.14.SyncPolarity=HAL_DMAMUX_SYNC_NO_EVENT +Dma.USART3_TX.14.SyncRequestNumber=1 +Dma.USART3_TX.14.SyncSignalID=NONE +FDCAN1.AutoRetransmission=ENABLE +FDCAN1.CalculateBaudRateNominal=1000000 +FDCAN1.CalculateTimeBitNominal=1000 +FDCAN1.CalculateTimeQuantumNominal=62.5 +FDCAN1.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,NominalPrescaler,StdFiltersNbr,NominalTimeSeg1,AutoRetransmission,NominalTimeSeg2 +FDCAN1.NominalPrescaler=6 +FDCAN1.NominalTimeSeg1=11 +FDCAN1.NominalTimeSeg2=4 +FDCAN1.RxFifo0ElmtsNbr=16 +FDCAN1.StdFiltersNbr=1 +FDCAN1.TxFifoQueueElmtsNbr=16 +FDCAN2.AutoRetransmission=ENABLE +FDCAN2.CalculateBaudRateNominal=1000000 +FDCAN2.CalculateTimeBitNominal=1000 +FDCAN2.CalculateTimeQuantumNominal=62.5 +FDCAN2.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,AutoRetransmission,StdFiltersNbr,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,MessageRAMOffset,NominalPrescaler,NominalTimeSeg1,NominalTimeSeg2 +FDCAN2.MessageRAMOffset=129 +FDCAN2.NominalPrescaler=6 +FDCAN2.NominalTimeSeg1=11 +FDCAN2.NominalTimeSeg2=4 +FDCAN2.RxFifo0ElmtsNbr=16 +FDCAN2.StdFiltersNbr=1 +FDCAN2.TxFifoQueueElmtsNbr=16 +FDCAN3.AutoRetransmission=ENABLE +FDCAN3.CalculateBaudRateNominal=1000000 +FDCAN3.CalculateTimeBitNominal=1000 +FDCAN3.CalculateTimeQuantumNominal=62.5 +FDCAN3.IPParameters=CalculateTimeQuantumNominal,CalculateTimeBitNominal,CalculateBaudRateNominal,MessageRAMOffset,RxFifo0ElmtsNbr,TxFifoQueueElmtsNbr,NominalPrescaler,StdFiltersNbr,AutoRetransmission,NominalTimeSeg1,NominalTimeSeg2 +FDCAN3.MessageRAMOffset=258 +FDCAN3.NominalPrescaler=6 +FDCAN3.NominalTimeSeg1=11 +FDCAN3.NominalTimeSeg2=4 +FDCAN3.RxFifo0ElmtsNbr=16 +FDCAN3.StdFiltersNbr=1 +FDCAN3.TxFifoQueueElmtsNbr=16 +FREERTOS.FootprintOK=true +FREERTOS.INCLUDE_eTaskGetState=1 +FREERTOS.INCLUDE_uxTaskGetStackHighWaterMark=1 +FREERTOS.INCLUDE_vTaskDelayUntil=1 +FREERTOS.INCLUDE_xQueueGetMutexHolder=1 +FREERTOS.INCLUDE_xTaskGetCurrentTaskHandle=1 +FREERTOS.INCLUDE_xTimerPendFunctionCall=1 +FREERTOS.IPParameters=Tasks01,configCHECK_FOR_STACK_OVERFLOW,configUSE_MALLOC_FAILED_HOOK,configENABLE_FPU,configUSE_RECURSIVE_MUTEXES,configUSE_COUNTING_SEMAPHORES,INCLUDE_vTaskDelayUntil,INCLUDE_xQueueGetMutexHolder,INCLUDE_uxTaskGetStackHighWaterMark,INCLUDE_xTaskGetCurrentTaskHandle,INCLUDE_eTaskGetState,configUSE_TRACE_FACILITY,configUSE_TIMERS,INCLUDE_xTimerPendFunctionCall,configUSE_NEWLIB_REENTRANT,configTOTAL_HEAP_SIZE,FootprintOK +FREERTOS.Tasks01=defaultTask,24,512,StartDefaultTask,As weak,NULL,Dynamic,NULL,NULL +FREERTOS.configCHECK_FOR_STACK_OVERFLOW=2 +FREERTOS.configENABLE_FPU=1 +FREERTOS.configTOTAL_HEAP_SIZE=65536 +FREERTOS.configUSE_COUNTING_SEMAPHORES=1 +FREERTOS.configUSE_MALLOC_FAILED_HOOK=1 +FREERTOS.configUSE_NEWLIB_REENTRANT=1 +FREERTOS.configUSE_RECURSIVE_MUTEXES=1 +FREERTOS.configUSE_TIMERS=1 +FREERTOS.configUSE_TRACE_FACILITY=1 +File.Version=6 +GPIO.groupedBy=Group By Peripherals +KeepUserPlacement=false +MMTAppRegionsCount=0 +MMTConfigApplied=false +MMTSectionSuffix= +Mcu.CPN=STM32H723VGT6 +Mcu.Family=STM32H7 +Mcu.IP0=CORTEX_M7 +Mcu.IP1=DEBUG +Mcu.IP10=RCC +Mcu.IP11=SPI1 +Mcu.IP12=SPI2 +Mcu.IP13=SYS +Mcu.IP14=TIM1 +Mcu.IP15=TIM2 +Mcu.IP16=TIM3 +Mcu.IP17=TIM12 +Mcu.IP18=UART4 +Mcu.IP19=UART5 +Mcu.IP2=DMA +Mcu.IP20=UART7 +Mcu.IP21=UART8 +Mcu.IP22=UART9 +Mcu.IP23=USART1 +Mcu.IP24=USART2 +Mcu.IP25=USART3 +Mcu.IP26=USART10 +Mcu.IP27=USB_OTG_HS +Mcu.IP3=FDCAN1 +Mcu.IP4=FDCAN2 +Mcu.IP5=FDCAN3 +Mcu.IP6=FREERTOS +Mcu.IP7=MEMORYMAP +Mcu.IP8=NVIC +Mcu.IP9=OCTOSPI2 +Mcu.IPNb=28 +Mcu.Name=STM32H723VGTx +Mcu.Package=LQFP100 +Mcu.Pin0=PE2 +Mcu.Pin1=PE3 +Mcu.Pin10=PC3_C +Mcu.Pin11=PA0 +Mcu.Pin12=PA1 +Mcu.Pin13=PA2 +Mcu.Pin14=PA3 +Mcu.Pin15=PA7 +Mcu.Pin16=PB0 +Mcu.Pin17=PB1 +Mcu.Pin18=PB2 +Mcu.Pin19=PE7 +Mcu.Pin2=PC13 +Mcu.Pin20=PE8 +Mcu.Pin21=PE9 +Mcu.Pin22=PE10 +Mcu.Pin23=PE11 +Mcu.Pin24=PE12 +Mcu.Pin25=PE13 +Mcu.Pin26=PE14 +Mcu.Pin27=PE15 +Mcu.Pin28=PB10 +Mcu.Pin29=PB11 +Mcu.Pin3=PC14-OSC32_IN +Mcu.Pin30=PB13 +Mcu.Pin31=PB14 +Mcu.Pin32=PB15 +Mcu.Pin33=PD8 +Mcu.Pin34=PD9 +Mcu.Pin35=PD10 +Mcu.Pin36=PD11 +Mcu.Pin37=PD12 +Mcu.Pin38=PD13 +Mcu.Pin39=PD14 +Mcu.Pin4=PC15-OSC32_OUT +Mcu.Pin40=PD15 +Mcu.Pin41=PA9 +Mcu.Pin42=PA10 +Mcu.Pin43=PA11 +Mcu.Pin44=PA12 +Mcu.Pin45=PA13(JTMS/SWDIO) +Mcu.Pin46=PA14(JTCK/SWCLK) +Mcu.Pin47=PA15(JTDI) +Mcu.Pin48=PC12 +Mcu.Pin49=PD0 +Mcu.Pin5=PH0-OSC_IN +Mcu.Pin50=PD1 +Mcu.Pin51=PD2 +Mcu.Pin52=PD4 +Mcu.Pin53=PD5 +Mcu.Pin54=PD6 +Mcu.Pin55=PD7 +Mcu.Pin56=PB3(JTDO/TRACESWO) +Mcu.Pin57=PB5 +Mcu.Pin58=PB6 +Mcu.Pin59=PB8 +Mcu.Pin6=PH1-OSC_OUT +Mcu.Pin60=PB9 +Mcu.Pin61=PE0 +Mcu.Pin62=PE1 +Mcu.Pin63=VP_FREERTOS_VS_CMSIS_V2 +Mcu.Pin64=VP_OCTOSPI2_VS_quad +Mcu.Pin65=VP_SYS_VS_tim8 +Mcu.Pin66=VP_MEMORYMAP_VS_MEMORYMAP +Mcu.Pin7=PC0 +Mcu.Pin8=PC1 +Mcu.Pin9=PC2_C +Mcu.PinsNb=67 +Mcu.ThirdPartyNb=0 +Mcu.UserConstants= +Mcu.UserName=STM32H723VGTx +MxCube.Version=6.18.1 +MxDb.Version=DB.6.0.181 +NVIC.BusFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.DMA1_Stream0_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream3_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream4_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream5_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA1_Stream7_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream1_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream2_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream3_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream4_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream5_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream6_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DMA2_Stream7_IRQn=true\:5\:0\:false\:false\:true\:true\:false\:true\:true +NVIC.DebugMonitor_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.EXTI15_10_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN1_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN1_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN2_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN2_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN3_IT0_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.FDCAN3_IT1_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.ForceEnableDMAVector=true +NVIC.HardFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.MemoryManagement_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.NonMaskableInt_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +NVIC.PendSV_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:false\:false +NVIC.PriorityGroup=NVIC_PRIORITYGROUP_4 +NVIC.SPI2_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.SVCall_IRQn=true\:0\:0\:false\:false\:false\:false\:false\:false\:false +NVIC.SavedPendsvIrqHandlerGenerated=true +NVIC.SavedSvcallIrqHandlerGenerated=true +NVIC.SavedSystickIrqHandlerGenerated=true +NVIC.SysTick_IRQn=true\:15\:0\:false\:false\:false\:true\:false\:true\:false +NVIC.TIM8_UP_TIM13_IRQn=true\:15\:0\:false\:false\:true\:false\:false\:true\:true +NVIC.TimeBase=TIM8_UP_TIM13_IRQn +NVIC.TimeBaseIP=TIM8 +NVIC.UART4_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART5_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART7_IRQn=true\:5\:0\:true\:false\:true\:true\:true\:true\:true +NVIC.UART8_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UART9_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART10_IRQn=true\:5\:0\:true\:false\:true\:true\:true\:true\:true +NVIC.USART1_IRQn=true\:5\:0\:true\:false\:true\:true\:true\:true\:true +NVIC.USART2_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.USART3_IRQn=true\:5\:0\:false\:false\:true\:true\:true\:true\:true +NVIC.UsageFault_IRQn=true\:0\:0\:false\:false\:true\:false\:false\:false\:false +OCTOSPI2.ClockMode=HAL_OSPI_CLOCK_MODE_3 +OCTOSPI2.ClockPrescaler=3 +OCTOSPI2.DeviceSize=23 +OCTOSPI2.DeviceType=SPI_DEVICE_FLASH +OCTOSPI2.FifoThreshold=8 +OCTOSPI2.IPParameters=FifoThreshold,DeviceSize,DeviceType,ClockMode,ClockPrescaler,SampleShifting +OCTOSPI2.SampleShifting=HAL_OSPI_SAMPLE_SHIFTING_HALFCYCLE +PA0.Locked=true +PA0.Signal=S_TIM2_CH1_ETR +PA1.Locked=true +PA1.Mode=OCTOSPI2_IOL_Port1L +PA1.Signal=OCTOSPIM_P1_IO3 +PA10.Locked=true +PA10.Mode=Asynchronous +PA10.Signal=USART1_RX +PA11.Mode=Device_Only_FS +PA11.Signal=USB_OTG_HS_DM +PA12.Mode=Device_Only_FS +PA12.Signal=USB_OTG_HS_DP +PA13(JTMS/SWDIO).Locked=true +PA13(JTMS/SWDIO).Mode=Serial_Wire +PA13(JTMS/SWDIO).Signal=DEBUG_JTMS-SWDIO +PA14(JTCK/SWCLK).Locked=true +PA14(JTCK/SWCLK).Mode=Serial_Wire +PA14(JTCK/SWCLK).Signal=DEBUG_JTCK-SWCLK +PA15(JTDI).GPIOParameters=GPIO_Label,GPIO_ModeDefaultEXTI +PA15(JTDI).GPIO_Label=KEY +PA15(JTDI).GPIO_ModeDefaultEXTI=GPIO_MODE_IT_RISING +PA15(JTDI).Locked=true +PA15(JTDI).Signal=GPXTI15 +PA2.Locked=true +PA2.Signal=S_TIM2_CH3 +PA3.Locked=true +PA3.Mode=OCTOSPI2_IOL_Port1L +PA3.Signal=OCTOSPIM_P1_IO2 +PA7.Locked=true +PA7.Signal=S_TIM14_CH1 +PA9.Locked=true +PA9.Mode=Asynchronous +PA9.Signal=USART1_TX +PB0.Locked=true +PB0.Mode=OCTOSPI2_IOL_Port1L +PB0.Signal=OCTOSPIM_P1_IO1 +PB1.Locked=true +PB1.Signal=S_TIM3_CH4 +PB10.GPIOParameters=GPIO_Label +PB10.GPIO_Label=LCD_BLK +PB10.Locked=true +PB10.Signal=GPIO_Output +PB11.GPIOParameters=GPIO_Label +PB11.GPIO_Label=LCD_RES +PB11.Locked=true +PB11.Signal=GPIO_Output +PB13.GPIOParameters=GPIO_Speed +PB13.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PB13.Locked=true +PB13.Mode=Full_Duplex_Master +PB13.Signal=SPI2_SCK +PB14.Mode=Hardware Flow Control (RS485) +PB14.Signal=USART3_DE +PB15.Locked=true +PB15.Signal=S_TIM12_CH2 +PB2.Locked=true +PB2.Mode=O2_P1_CLK +PB2.Signal=OCTOSPIM_P1_CLK +PB3(JTDO/TRACESWO).GPIOParameters=GPIO_Speed +PB3(JTDO/TRACESWO).GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PB3(JTDO/TRACESWO).Mode=TX_Only_Simplex_Unidirect_Master +PB3(JTDO/TRACESWO).Signal=SPI1_SCK +PB5.Locked=true +PB5.Mode=FDCAN_Activate +PB5.Signal=FDCAN2_RX +PB6.Mode=FDCAN_Activate +PB6.Signal=FDCAN2_TX +PB8.Locked=true +PB8.Mode=Asynchronous +PB8.Signal=UART4_RX +PB9.Locked=true +PB9.Mode=Asynchronous +PB9.Signal=UART4_TX +PC0.GPIOParameters=GPIO_Speed,PinState,GPIO_Label +PC0.GPIO_Label=GYRO_ACC_CS +PC0.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC0.Locked=true +PC0.PinState=GPIO_PIN_SET +PC0.Signal=GPIO_Output +PC1.GPIOParameters=GPIO_Speed +PC1.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC1.Mode=Full_Duplex_Master +PC1.Signal=SPI2_MOSI +PC12.Mode=Asynchronous +PC12.Signal=UART5_TX +PC13.GPIOParameters=PinState,GPIO_Label +PC13.GPIO_Label=POWER_24V_2 +PC13.Locked=true +PC13.PinState=GPIO_PIN_SET +PC13.Signal=GPIO_Output +PC14-OSC32_IN.GPIOParameters=PinState,GPIO_Label +PC14-OSC32_IN.GPIO_Label=POWER_24V_1 +PC14-OSC32_IN.Locked=true +PC14-OSC32_IN.PinState=GPIO_PIN_SET +PC14-OSC32_IN.Signal=GPIO_Output +PC15-OSC32_OUT.GPIOParameters=PinState,GPIO_Label +PC15-OSC32_OUT.GPIO_Label=POWER_5V +PC15-OSC32_OUT.Locked=true +PC15-OSC32_OUT.PinState=GPIO_PIN_SET +PC15-OSC32_OUT.Signal=GPIO_Output +PC2_C.GPIOParameters=GPIO_Speed +PC2_C.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC2_C.Mode=Full_Duplex_Master +PC2_C.Signal=SPI2_MISO +PC3_C.GPIOParameters=GPIO_Speed,PinState,GPIO_Label +PC3_C.GPIO_Label=GYRO_GYRO_CS +PC3_C.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PC3_C.Locked=true +PC3_C.PinState=GPIO_PIN_SET +PC3_C.Signal=GPIO_Output +PD0.Mode=FDCAN_Activate +PD0.Signal=FDCAN1_RX +PD1.Locked=true +PD1.Mode=FDCAN_Activate +PD1.Signal=FDCAN1_TX +PD10.GPIOParameters=GPIO_Label +PD10.GPIO_Label=LCD_DC +PD10.Locked=true +PD10.Signal=GPIO_Output +PD11.Locked=true +PD11.Mode=OCTOSPI2_IOL_Port1L +PD11.Signal=OCTOSPIM_P1_IO0 +PD12.Mode=FDCAN_Activate +PD12.Signal=FDCAN3_RX +PD13.Locked=true +PD13.Mode=FDCAN_Activate +PD13.Signal=FDCAN3_TX +PD14.Mode=Asynchronous +PD14.Signal=UART9_RX +PD15.Mode=Asynchronous +PD15.Signal=UART9_TX +PD2.Locked=true +PD2.Mode=Asynchronous +PD2.Signal=UART5_RX +PD4.Mode=Hardware Flow Control (RS485) +PD4.Signal=USART2_DE +PD5.Mode=Asynchronous +PD5.Signal=USART2_TX +PD6.Mode=Asynchronous +PD6.Signal=USART2_RX +PD7.GPIOParameters=GPIO_Speed +PD7.GPIO_Speed=GPIO_SPEED_FREQ_VERY_HIGH +PD7.Locked=true +PD7.Mode=TX_Only_Simplex_Unidirect_Master +PD7.Signal=SPI1_MOSI +PD8.Locked=true +PD8.Mode=Asynchronous +PD8.Signal=USART3_TX +PD9.Locked=true +PD9.Mode=Asynchronous +PD9.Signal=USART3_RX +PE0.Mode=Asynchronous +PE0.Signal=UART8_RX +PE1.Mode=Asynchronous +PE1.Signal=UART8_TX +PE10.GPIOParameters=GPIO_Label +PE10.GPIO_Label=GYRO_ACC_INT +PE10.Locked=true +PE10.Signal=GPXTI10 +PE11.Locked=true +PE11.Mode=OCTOSPI2_Port1_NCS +PE11.Signal=OCTOSPIM_P1_NCS +PE12.GPIOParameters=GPIO_Label +PE12.GPIO_Label=GYRO_GYRO_INT +PE12.Locked=true +PE12.Signal=GPXTI12 +PE13.Signal=S_TIM1_CH3 +PE14.GPIOParameters=GPIO_Label +PE14.GPIO_Label=BTB_GPIO +PE14.Locked=true +PE14.Signal=GPIO_Output +PE15.GPIOParameters=GPIO_Label +PE15.GPIO_Label=LCD_CS +PE15.Locked=true +PE15.Signal=GPIO_Output +PE2.Mode=Asynchronous +PE2.Signal=USART10_RX +PE3.Mode=Asynchronous +PE3.Signal=USART10_TX +PE7.Mode=Asynchronous +PE7.Signal=UART7_RX +PE8.Mode=Asynchronous +PE8.Signal=UART7_TX +PE9.Locked=true +PE9.Signal=S_TIM1_CH1 +PH0-OSC_IN.Mode=HSE-External-Oscillator +PH0-OSC_IN.Signal=RCC_OSC_IN +PH1-OSC_OUT.Mode=HSE-External-Oscillator +PH1-OSC_OUT.Signal=RCC_OSC_OUT +PinOutPanel.RotationAngle=0 +ProjectManager.AskForMigrate=true +ProjectManager.BackupPrevious=false +ProjectManager.CompilerLinker=GCC +ProjectManager.CompilerOptimize=6 +ProjectManager.ComputerToolchain=false +ProjectManager.CoupleFile=true +ProjectManager.CustomerFirmwarePackage= +ProjectManager.DefaultFWLocation=true +ProjectManager.DeletePrevious=true +ProjectManager.DeviceId=STM32H723VGTx +ProjectManager.FirmwarePackage=STM32Cube FW_H7 V1.13.0 +ProjectManager.FreePins=false +ProjectManager.FreePinsContext= +ProjectManager.HalAssertFull=false +ProjectManager.HeapSize=0x800 +ProjectManager.KeepUserCode=true +ProjectManager.LastFirmware=true +ProjectManager.LibraryCopy=0 +ProjectManager.MainLocation=Core/Src +ProjectManager.NoMain=false +ProjectManager.PreviousToolchain= +ProjectManager.ProjectBuild=false +ProjectManager.ProjectFileName=MC02_with_submodule.ioc +ProjectManager.ProjectName=MC02_with_submodule +ProjectManager.ProjectStructure= +ProjectManager.RegisterCallBack= +ProjectManager.StackSize=0x800 +ProjectManager.TargetToolchain=CMake +ProjectManager.ToolChainLocation= +ProjectManager.UAScriptAfterPath= +ProjectManager.UAScriptBeforePath= +ProjectManager.UnderRoot=false +ProjectManager.functionlistsort=1-SystemClock_Config-RCC-false-HAL-false,2-MX_GPIO_Init-GPIO-false-HAL-true,3-MX_DMA_Init-DMA-false-HAL-true,4-MX_TIM12_Init-TIM12-false-HAL-true,5-MX_SPI1_Init-SPI1-false-HAL-true,6-MX_SPI2_Init-SPI2-false-HAL-true,7-MX_TIM3_Init-TIM3-false-HAL-true,8-MX_USART1_UART_Init-USART1-false-HAL-true,9-MX_UART7_Init-UART7-false-HAL-true,10-MX_USART10_UART_Init-USART10-false-HAL-true,11-MX_FDCAN1_Init-FDCAN1-false-HAL-true,12-MX_FDCAN2_Init-FDCAN2-false-HAL-true,13-MX_FDCAN3_Init-FDCAN3-false-HAL-true,14-MX_TIM1_Init-TIM1-false-HAL-true,15-MX_TIM2_Init-TIM2-false-HAL-true,16-MX_OCTOSPI2_Init-OCTOSPI2-false-HAL-true,17-MX_USB_OTG_HS_PCD_Init-USB_OTG_HS-false-HAL-true,18-MX_UART8_Init-UART8-false-HAL-true,19-MX_UART9_Init-UART9-false-HAL-true,20-MX_UART4_Init-UART4-false-HAL-true,21-MX_USART2_UART_Init-USART2-false-HAL-true,22-MX_USART3_UART_Init-USART3-false-HAL-true,23-MX_UART5_Init-UART5-false-HAL-true,0-MX_CORTEX_M7_Init-CORTEX_M7-false-HAL-true +RCC.ADCFreq_Value=96000000 +RCC.AHB12Freq_Value=275000000 +RCC.AHB4Freq_Value=275000000 +RCC.APB1Freq_Value=137500000 +RCC.APB2Freq_Value=137500000 +RCC.APB3Freq_Value=137500000 +RCC.APB4Freq_Value=137500000 +RCC.AXIClockFreq_Value=275000000 +RCC.CECFreq_Value=32000 +RCC.CKPERFreq_Value=64000000 +RCC.CortexFreq_Value=550000000 +RCC.CpuClockFreq_Value=550000000 +RCC.D1CPREFreq_Value=550000000 +RCC.D1PPRE=RCC_APB3_DIV2 +RCC.D2PPRE1=RCC_APB1_DIV2 +RCC.D2PPRE2=RCC_APB2_DIV2 +RCC.D3PPRE=RCC_APB4_DIV2 +RCC.DFSDMACLkFreq_Value=137500000 +RCC.DFSDMFreq_Value=137500000 +RCC.DIVM1=3 +RCC.DIVM2=2 +RCC.DIVN1=68 +RCC.DIVN2=16 +RCC.DIVP1=1 +RCC.DIVP1Freq_Value=550000000 +RCC.DIVP2Freq_Value=96000000 +RCC.DIVP3Freq_Value=48375000 +RCC.DIVQ1=4 +RCC.DIVQ1Freq_Value=137500000 +RCC.DIVQ2Freq_Value=96000000 +RCC.DIVQ3Freq_Value=48375000 +RCC.DIVR1Freq_Value=275000000 +RCC.DIVR2Freq_Value=96000000 +RCC.DIVR3Freq_Value=48375000 +RCC.FDCANCLockSelection=RCC_FDCANCLKSOURCE_PLL2 +RCC.FDCANFreq_Value=96000000 +RCC.FMCFreq_Value=275000000 +RCC.FamilyName=M +RCC.HCLK3ClockFreq_Value=275000000 +RCC.HCLKFreq_Value=275000000 +RCC.HPRE=RCC_HCLK_DIV2 +RCC.HSE_VALUE=24000000 +RCC.I2C123Freq_Value=137500000 +RCC.I2C4Freq_Value=137500000 +RCC.IPParameters=ADCFreq_Value,AHB12Freq_Value,AHB4Freq_Value,APB1Freq_Value,APB2Freq_Value,APB3Freq_Value,APB4Freq_Value,AXIClockFreq_Value,CECFreq_Value,CKPERFreq_Value,CortexFreq_Value,CpuClockFreq_Value,D1CPREFreq_Value,D1PPRE,D2PPRE1,D2PPRE2,D3PPRE,DFSDMACLkFreq_Value,DFSDMFreq_Value,DIVM1,DIVM2,DIVN1,DIVN2,DIVP1,DIVP1Freq_Value,DIVP2Freq_Value,DIVP3Freq_Value,DIVQ1,DIVQ1Freq_Value,DIVQ2Freq_Value,DIVQ3Freq_Value,DIVR1Freq_Value,DIVR2Freq_Value,DIVR3Freq_Value,FDCANCLockSelection,FDCANFreq_Value,FMCFreq_Value,FamilyName,HCLK3ClockFreq_Value,HCLKFreq_Value,HPRE,HSE_VALUE,I2C123Freq_Value,I2C4Freq_Value,LPTIM1Freq_Value,LPTIM2Freq_Value,LPTIM345Freq_Value,LPUART1Freq_Value,LTDCFreq_Value,MCO1PinFreq_Value,MCO2PinFreq_Value,PLL2FRACN,PLL2_VCI_Range-AdvancedSettings,PLL2_VCO_SEL-AdvancedSettings,PLL3FRACN,PLL3_VCI_Range-AdvancedSettings,PLL3_VCO_SEL-AdvancedSettings,PLLFRACN,PLLSourceVirtual,QSPIFreq_Value,RNGFreq_Value,RTCFreq_Value,SAI1Freq_Value,SAI4AFreq_Value,SAI4BFreq_Value,SDMMCFreq_Value,SPDIFRXFreq_Value,SPI123Freq_Value,SPI45Freq_Value,SPI6CLockSelection,SPI6Freq_Value,SWPMI1Freq_Value,SYSCLKFreq_VALUE,SYSCLKSource,Tim1OutputFreq_Value,Tim2OutputFreq_Value,TraceFreq_Value,USART16Freq_Value,USART234578Freq_Value,USBCLockSelection,USBFreq_Value,VCO1OutputFreq_Value,VCO2OutputFreq_Value,VCO3OutputFreq_Value,VCOInput1Freq_Value,VCOInput2Freq_Value,VCOInput3Freq_Value +RCC.LPTIM1Freq_Value=137500000 +RCC.LPTIM2Freq_Value=137500000 +RCC.LPTIM345Freq_Value=137500000 +RCC.LPUART1Freq_Value=137500000 +RCC.LTDCFreq_Value=48375000 +RCC.MCO1PinFreq_Value=64000000 +RCC.MCO2PinFreq_Value=550000000 +RCC.PLL2FRACN=0 +RCC.PLL2_VCI_Range-AdvancedSettings=RCC_PLL2VCIRANGE_0 +RCC.PLL2_VCO_SEL-AdvancedSettings=RCC_PLL2VCOMEDIUM +RCC.PLL3FRACN=0 +RCC.PLL3_VCI_Range-AdvancedSettings=RCC_PLL3VCIRANGE_3 +RCC.PLL3_VCO_SEL-AdvancedSettings=RCC_PLL3VCOMEDIUM +RCC.PLLFRACN=6144 +RCC.PLLSourceVirtual=RCC_PLLSOURCE_HSE +RCC.QSPIFreq_Value=275000000 +RCC.RNGFreq_Value=48000000 +RCC.RTCFreq_Value=32000 +RCC.SAI1Freq_Value=137500000 +RCC.SAI4AFreq_Value=137500000 +RCC.SAI4BFreq_Value=137500000 +RCC.SDMMCFreq_Value=137500000 +RCC.SPDIFRXFreq_Value=137500000 +RCC.SPI123Freq_Value=137500000 +RCC.SPI45Freq_Value=137500000 +RCC.SPI6CLockSelection=RCC_SPI6CLKSOURCE_HSE +RCC.SPI6Freq_Value=24000000 +RCC.SWPMI1Freq_Value=137500000 +RCC.SYSCLKFreq_VALUE=550000000 +RCC.SYSCLKSource=RCC_SYSCLKSOURCE_PLLCLK +RCC.Tim1OutputFreq_Value=275000000 +RCC.Tim2OutputFreq_Value=275000000 +RCC.TraceFreq_Value=275000000 +RCC.USART16Freq_Value=137500000 +RCC.USART234578Freq_Value=137500000 +RCC.USBCLockSelection=RCC_USBCLKSOURCE_HSI48 +RCC.USBFreq_Value=48000000 +RCC.VCO1OutputFreq_Value=550000000 +RCC.VCO2OutputFreq_Value=192000000 +RCC.VCO3OutputFreq_Value=96750000 +RCC.VCOInput1Freq_Value=8000000 +RCC.VCOInput2Freq_Value=12000000 +RCC.VCOInput3Freq_Value=750000 +SH.GPXTI10.0=GPIO_EXTI10 +SH.GPXTI10.ConfNb=1 +SH.GPXTI12.0=GPIO_EXTI12 +SH.GPXTI12.ConfNb=1 +SH.GPXTI15.0=GPIO_EXTI15 +SH.GPXTI15.ConfNb=1 +SH.S_TIM12_CH2.0=TIM12_CH2,PWM Generation2 CH2 +SH.S_TIM12_CH2.ConfNb=1 +SH.S_TIM14_CH1.0=TIM14_CH1 +SH.S_TIM14_CH1.ConfNb=1 +SH.S_TIM1_CH1.0=TIM1_CH1,PWM Generation1 CH1 +SH.S_TIM1_CH1.ConfNb=1 +SH.S_TIM1_CH3.0=TIM1_CH3,PWM Generation3 CH3 +SH.S_TIM1_CH3.ConfNb=1 +SH.S_TIM2_CH1_ETR.0=TIM2_CH1,PWM Generation1 CH1 +SH.S_TIM2_CH1_ETR.ConfNb=1 +SH.S_TIM2_CH3.0=TIM2_CH3,PWM Generation3 CH3 +SH.S_TIM2_CH3.ConfNb=1 +SH.S_TIM3_CH4.0=TIM3_CH4,PWM Generation4 CH4 +SH.S_TIM3_CH4.ConfNb=1 +SPI1.BaudRatePrescaler=SPI_BAUDRATEPRESCALER_4 +SPI1.CLKPolarity=SPI_POLARITY_HIGH +SPI1.CalculateBaudRate=34.375 MBits/s +SPI1.DataSize=SPI_DATASIZE_8BIT +SPI1.Direction=SPI_DIRECTION_2LINES_TXONLY +SPI1.IPParameters=VirtualType,Mode,Direction,CalculateBaudRate,DataSize,BaudRatePrescaler,CLKPolarity +SPI1.Mode=SPI_MODE_MASTER +SPI1.VirtualType=VM_MASTER +SPI2.BaudRatePrescaler=SPI_BAUDRATEPRESCALER_32 +SPI2.CLKPhase=SPI_PHASE_2EDGE +SPI2.CLKPolarity=SPI_POLARITY_HIGH +SPI2.CalculateBaudRate=4.296875 MBits/s +SPI2.DataSize=SPI_DATASIZE_8BIT +SPI2.Direction=SPI_DIRECTION_2LINES +SPI2.IPParameters=VirtualType,Mode,Direction,CalculateBaudRate,DataSize,BaudRatePrescaler,CLKPolarity,CLKPhase,MasterKeepIOState +SPI2.MasterKeepIOState=SPI_MASTER_KEEP_IO_STATE_ENABLE +SPI2.Mode=SPI_MODE_MASTER +SPI2.VirtualType=VM_MASTER +TIM1.Channel-PWM\ Generation1\ CH1=TIM_CHANNEL_1 +TIM1.Channel-PWM\ Generation3\ CH3=TIM_CHANNEL_3 +TIM1.IPParameters=Channel-PWM Generation3 CH3,Channel-PWM Generation1 CH1,Period,Pulse-PWM Generation1 CH1,Pulse-PWM Generation3 CH3,Prescaler +TIM1.Period=10000 +TIM1.Prescaler=24 +TIM1.Pulse-PWM\ Generation1\ CH1=5000 +TIM1.Pulse-PWM\ Generation3\ CH3=5000 +TIM12.Channel-PWM\ Generation2\ CH2=TIM_CHANNEL_2 +TIM12.IPParameters=Channel-PWM Generation2 CH2,Prescaler,Period +TIM12.Period=2000-1 +TIM12.Prescaler=24-1 +TIM2.Channel-PWM\ Generation1\ CH1=TIM_CHANNEL_1 +TIM2.Channel-PWM\ Generation3\ CH3=TIM_CHANNEL_3 +TIM2.IPParameters=Channel-PWM Generation1 CH1,Channel-PWM Generation3 CH3,Period,Pulse-PWM Generation1 CH1,Pulse-PWM Generation3 CH3,Prescaler +TIM2.Period=10000 +TIM2.Prescaler=24 +TIM2.Pulse-PWM\ Generation1\ CH1=5000 +TIM2.Pulse-PWM\ Generation3\ CH3=5000 +TIM3.AutoReloadPreload=TIM_AUTORELOAD_PRELOAD_ENABLE +TIM3.Channel-PWM\ Generation4\ CH4=TIM_CHANNEL_4 +TIM3.IPParameters=Channel-PWM Generation4 CH4,Prescaler,Period,AutoReloadPreload +TIM3.Period=10000-1 +TIM3.Prescaler=24-1 +UART7.BaudRate=921600 +UART7.IPParameters=BaudRate +USART1.BaudRate=115200 +USART1.IPParameters=VirtualMode-Asynchronous,BaudRate +USART1.VirtualMode-Asynchronous=VM_ASYNC +USART10.BaudRate=921600 +USART10.IPParameters=VirtualMode,BaudRate +USART10.VirtualMode=VM_ASYNC +USART2.IPParameters=VirtualMode-Asynchronous,VirtualMode-Hardware Flow Control (RS485) +USART2.VirtualMode-Asynchronous=VM_ASYNC +USART2.VirtualMode-Hardware\ Flow\ Control\ (RS485)=VM_ASYNC +USART3.IPParameters=VirtualMode-Asynchronous,VirtualMode-Hardware Flow Control (RS485) +USART3.VirtualMode-Asynchronous=VM_ASYNC +USART3.VirtualMode-Hardware\ Flow\ Control\ (RS485)=VM_ASYNC +USB_OTG_HS.IPParameters=VirtualMode-Device_Only_FS +USB_OTG_HS.VirtualMode-Device_Only_FS=Device_Only_FS +VP_FREERTOS_VS_CMSIS_V2.Mode=CMSIS_V2 +VP_FREERTOS_VS_CMSIS_V2.Signal=FREERTOS_VS_CMSIS_V2 +VP_MEMORYMAP_VS_MEMORYMAP.Mode=CurAppReg +VP_MEMORYMAP_VS_MEMORYMAP.Signal=MEMORYMAP_VS_MEMORYMAP +VP_OCTOSPI2_VS_quad.Mode=quad_mode +VP_OCTOSPI2_VS_quad.Signal=OCTOSPI2_VS_quad +VP_SYS_VS_tim8.Mode=TIM8 +VP_SYS_VS_tim8.Signal=SYS_VS_tim8 +board=custom +rtos.0.ip=FREERTOS diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.cpp__callbacks.txt b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__callbacks.txt new file mode 100644 index 0000000..a39eecd --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__callbacks.txt @@ -0,0 +1 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.cpp__devices.txt b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__devices.txt new file mode 100644 index 0000000..a39eecd --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__devices.txt @@ -0,0 +1 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.cpp__init.txt b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__init.txt new file mode 100644 index 0000000..5bd92e7 --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.cpp__init.txt @@ -0,0 +1,10 @@ + // 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 + ICBSP_CHECK(bsp_can1.init() == Status::OK); + ICBSP_CHECK(bsp_can2.init() == Status::OK); + ICBSP_CHECK(bsp_uart1.init() == Status::OK); + ICBSP_CHECK(bsp_uart2.init() == Status::OK); + ICBSP_CHECK(bsp_uart3.init() == Status::OK); + ICBSP_CHECK(bsp_uart4.init() == Status::OK); + ICBSP_CHECK(bsp_uart5.init() == Status::OK); + ICBSP_CHECK(bsp_uart6.init() == Status::OK); + ICBSP_CHECK(bsp_spi6.init() == Status::OK); diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.hpp__devices.txt b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__devices.txt new file mode 100644 index 0000000..a39eecd --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__devices.txt @@ -0,0 +1 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.hpp__includes.txt b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__includes.txt new file mode 100644 index 0000000..16c1f3c --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__includes.txt @@ -0,0 +1,11 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep +#include "main.h" // IWYU pragma: keep(GPIO 标签宏) +#include "fdcan.h" +#include "spi.h" +#include "usart.h" +#include "bsp/bsp_can.hpp" +#include "bsp/bsp_dma_buffer.hpp" +#include "bsp/bsp_dwt.hpp" +#include "bsp/bsp_spi.hpp" +#include "bsp/bsp_uart.hpp" diff --git a/tools/tests/snapshots/h750_qspi/board_cfg.hpp__peripherals.txt b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__peripherals.txt new file mode 100644 index 0000000..db38814 --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_cfg.hpp__peripherals.txt @@ -0,0 +1,23 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// FDCAN1:CAN 总线 +inline BspCanT<16, 16> bsp_can1({.hfdcan = &hfdcan1, .name = "CAN1"}); +/// FDCAN2:CAN 总线 +inline BspCanT<16, 16> bsp_can2({.hfdcan = &hfdcan2, .name = "CAN2"}); +/// USART1:串口 +inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1({.huart = &huart1, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// USART2:串口 +inline ICBSP_DMA_BUFFER(bsp_uart2) BspUartT bsp_uart2({.huart = &huart2, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// USART3:串口 +inline BspUartT bsp_uart3({.huart = &huart3, .mode = UartDir::TxRx, .baudrate = 100000U}); +/// UART4:串口 +inline ICBSP_DMA_BUFFER(bsp_uart4) BspUartT bsp_uart4({.huart = &huart4, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// UART5:串口 +inline ICBSP_DMA_BUFFER(bsp_uart5) BspUartT bsp_uart5({.huart = &huart5, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// USART6:串口 +inline ICBSP_DMA_BUFFER(bsp_uart6) BspUartT bsp_uart6({.huart = &huart6, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// SPI6:SPI 主机(SPI6 由 BDMA 服务:只能轮询(use_dma = false)) +inline BspSpi bsp_spi6({.hspi = &hspi6, .use_dma = false, .dma_threshold = 16U}); + +/// 调试打印串口:USART1 +#define ICBSP_UART_PRINT_ENABLE 1 +#define print_uart(...) bsp_uart1.printf(__VA_ARGS__) diff --git a/tools/tests/snapshots/h750_qspi/board_instances.hpp__instances.txt b/tools/tests/snapshots/h750_qspi/board_instances.hpp__instances.txt new file mode 100644 index 0000000..db44dea --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/board_instances.hpp__instances.txt @@ -0,0 +1,13 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_CAN_INSTANCES(X) \ + X(bsp_can1) \ + X(bsp_can2) +#define ICBSP_UART_INSTANCES(X) \ + X(bsp_uart1) \ + X(bsp_uart2) \ + X(bsp_uart3) \ + X(bsp_uart4) \ + X(bsp_uart5) \ + X(bsp_uart6) +#define ICBSP_SPI_INSTANCES(X) \ + X(bsp_spi6) diff --git a/tools/tests/snapshots/h750_qspi/hardware_config.h__switches.txt b/tools/tests/snapshots/h750_qspi/hardware_config.h__switches.txt new file mode 100644 index 0000000..de0da06 --- /dev/null +++ b/tools/tests/snapshots/h750_qspi/hardware_config.h__switches.txt @@ -0,0 +1,5 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_SYS_TASK_ENABLE 1 ///< 系统维护任务 sys_task +#define ICBSP_CAN_RX_ENABLE 1 ///< CAN 接收路径(can_rx_task + 接收节点) +#define ICBSP_CAN_TX_ENABLE 1 ///< CAN 发送路径(can_tx_task + 发送节点) +#define ICBSP_UART_PATROL_ENABLE 1 ///< sys_task 里的串口巡检 diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.cpp__callbacks.txt b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__callbacks.txt new file mode 100644 index 0000000..a39eecd --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__callbacks.txt @@ -0,0 +1 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.cpp__devices.txt b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__devices.txt new file mode 100644 index 0000000..137b6c8 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__devices.txt @@ -0,0 +1,13 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// gimbal_yaw:DJI 电机(M3508 / M2006 / GM6020) +DjiMotor gimbal_yaw(bsp_can1, 2U, 0.0f, 0.0f, DjiMotorControlMode::CURRENT); +/// joint:达妙电机(J4310 / J4340P / J8009P) +DmMotor joint(bsp_can3, {.model = DmModel::J8009P, .can_id = 0x11U, .master_id = 0x21U, .mode = DmMode::POS_VEL}); +/// hatch:舵机(PWM 脉宽) +DeviceServo hatch({.pwm = &bsp_pwm_tim1_ch1, .pulse_min_us = 500.0f, .pulse_max_us = 2500.0f, .range_deg = 270.0f}); +/// beeper:无源蜂鸣器 +DeviceBuzzer beeper(bsp_pwm_tim2_ch3); +/// rc:R9DS 遥控接收机(SBUS) +DeviceR9dsT rc(bsp_uart5); +/// steppers:张大头 Emm_V5 步进闭环(一路串口多地址) +DeviceEmmv5GroupT steppers({.uart = bsp_uart8, .addr = {1, 2, 3}, .checksum = emmv5::Checksum::XOR}); diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.cpp__init.txt b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__init.txt new file mode 100644 index 0000000..4f62f7e --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.cpp__init.txt @@ -0,0 +1,13 @@ + // 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 + ICBSP_CHECK(bsp_can1.init() == Status::OK); + ICBSP_CHECK(bsp_can3.init() == Status::OK); + ICBSP_CHECK(bsp_uart1.init() == Status::OK); + ICBSP_CHECK(bsp_uart5.init() == Status::OK); + ICBSP_CHECK(bsp_uart8.init() == Status::OK); + ICBSP_CHECK(bsp_pwm_tim1_ch1.init() == Status::OK); + ICBSP_CHECK(bsp_pwm_tim2_ch3.init() == Status::OK); + ICBSP_CHECK(gimbal_yaw.init() == Status::OK); + ICBSP_CHECK(joint.init() == Status::OK); + ICBSP_CHECK(hatch.init() == Status::OK); + ICBSP_CHECK(rc.init() == Status::OK); + ICBSP_CHECK(steppers.init() == Status::OK); diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.hpp__devices.txt b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__devices.txt new file mode 100644 index 0000000..1069511 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__devices.txt @@ -0,0 +1,13 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// gimbal_yaw:DJI 电机(M3508 / M2006 / GM6020) +extern DjiMotor gimbal_yaw; +/// joint:达妙电机(J4310 / J4340P / J8009P) +extern DmMotor joint; +/// hatch:舵机(PWM 脉宽) +extern DeviceServo hatch; +/// beeper:无源蜂鸣器 +extern DeviceBuzzer beeper; +/// rc:R9DS 遥控接收机(SBUS) +extern DeviceR9dsT rc; +/// steppers:张大头 Emm_V5 步进闭环(一路串口多地址) +extern DeviceEmmv5GroupT steppers; diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.hpp__includes.txt b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__includes.txt new file mode 100644 index 0000000..8777b57 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__includes.txt @@ -0,0 +1,16 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep +#include "main.h" // IWYU pragma: keep(GPIO 标签宏) +#include "fdcan.h" +#include "tim.h" +#include "usart.h" +#include "bsp/bsp_can.hpp" +#include "bsp/bsp_dwt.hpp" +#include "bsp/bsp_pwm.hpp" +#include "bsp/bsp_uart.hpp" +#include "device/actuator/device_buzzer.hpp" +#include "device/actuator/device_servo.hpp" +#include "device/motor/device_emmv5_group.hpp" +#include "device/motor/dji_motor.hpp" +#include "device/motor/dm_motor.hpp" +#include "device/remote/device_r9ds.hpp" diff --git a/tools/tests/snapshots/mc02_alt/board_cfg.hpp__peripherals.txt b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__peripherals.txt new file mode 100644 index 0000000..d51a534 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_cfg.hpp__peripherals.txt @@ -0,0 +1,19 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// FDCAN1:CAN 总线 +inline BspCanT<32, 8> bsp_can1({.hfdcan = &hfdcan1, .name = "CAN1"}); +/// FDCAN3:CAN 总线 +inline BspCanT<16, 16> bsp_can3({.hfdcan = &hfdcan3, .name = "CAN3"}); +/// USART1:串口 +inline BspUartT bsp_uart1({.huart = &huart1, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// UART5:串口 +inline BspUartT bsp_uart5({.huart = &huart5, .mode = UartDir::RxOnly, .baudrate = 100000U}); +/// UART8:串口 +inline BspUartT bsp_uart8({.huart = &huart8, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// TIM1_CH1:PWM 通道 +inline BspPwm bsp_pwm_tim1_ch1({.htim = &htim1, .channel = TIM_CHANNEL_1, .timer_clk_hz = 275000000UL, .prescaler = 24U, .period = 10000U}); +/// TIM2_CH3:PWM 通道 +inline BspPwm bsp_pwm_tim2_ch3({.htim = &htim2, .channel = TIM_CHANNEL_3, .timer_clk_hz = 275000000UL, .prescaler = 24U, .period = 10000U}); + +/// 调试打印串口:USART1 +#define ICBSP_UART_PRINT_ENABLE 1 +#define print_uart(...) bsp_uart1.printf(__VA_ARGS__) diff --git a/tools/tests/snapshots/mc02_alt/board_instances.hpp__instances.txt b/tools/tests/snapshots/mc02_alt/board_instances.hpp__instances.txt new file mode 100644 index 0000000..0437653 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/board_instances.hpp__instances.txt @@ -0,0 +1,9 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_CAN_INSTANCES(X) \ + X(bsp_can1) \ + X(bsp_can3) +#define ICBSP_UART_INSTANCES(X) \ + X(bsp_uart1) \ + X(bsp_uart5) \ + X(bsp_uart8) +#define ICBSP_SPI_INSTANCES(X) /* 无 */ diff --git a/tools/tests/snapshots/mc02_alt/hardware_config.h__switches.txt b/tools/tests/snapshots/mc02_alt/hardware_config.h__switches.txt new file mode 100644 index 0000000..f94d674 --- /dev/null +++ b/tools/tests/snapshots/mc02_alt/hardware_config.h__switches.txt @@ -0,0 +1,5 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_SYS_TASK_ENABLE 1 ///< 系统维护任务 sys_task +#define ICBSP_CAN_RX_ENABLE 1 ///< CAN 接收路径(can_rx_task + 接收节点) +#define ICBSP_CAN_TX_ENABLE 1 ///< CAN 发送路径(can_tx_task + 发送节点) +#define ICBSP_UART_PATROL_ENABLE 0 ///< sys_task 里的串口巡检 diff --git a/tools/tests/snapshots/mc02_full/board_cfg.cpp__callbacks.txt b/tools/tests/snapshots/mc02_full/board_cfg.cpp__callbacks.txt new file mode 100644 index 0000000..658b28d --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.cpp__callbacks.txt @@ -0,0 +1,18 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/** + * @brief EXTI 回调:库不占用它,生成的设备的数据就绪中断由这里转给设备 + * @note 宿主别处不要再定义 HAL_GPIO_EXTI_Callback(会重复定义);还要处理别的 EXTI 时,把本区删掉、手写一份。 + */ +extern "C" void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin) +{ + BaseType_t woken = pdFALSE; + if (GPIO_Pin == GYRO_ACC_INT_Pin) + { + imu_bmi088.on_acc_drdy_isr(&woken); + } + else if (GPIO_Pin == GYRO_GYRO_INT_Pin) + { + imu_bmi088.on_gyro_drdy_isr(&woken); + } + portYIELD_FROM_ISR(woken); +} diff --git a/tools/tests/snapshots/mc02_full/board_cfg.cpp__devices.txt b/tools/tests/snapshots/mc02_full/board_cfg.cpp__devices.txt new file mode 100644 index 0000000..6dd4c9e --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.cpp__devices.txt @@ -0,0 +1,7 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// imu_bmi088:BMI088 IMU(含 VQF 姿态) +BspSpiDevice imu_bmi088_acc_spi(bsp_spi2, {GYRO_ACC_CS_GPIO_Port, GYRO_ACC_CS_Pin, 0x80U, 1U}); +BspSpiDevice imu_bmi088_gyro_spi(bsp_spi2, {GYRO_GYRO_CS_GPIO_Port, GYRO_GYRO_CS_Pin, 0x80U, 0U}); +DeviceBmi088 imu_bmi088(imu_bmi088_acc_spi, imu_bmi088_gyro_spi, {.acc_range = DeviceBmi088::AccRange::G24, .gyro_range = DeviceBmi088::GyroRange::DPS2000}); +/// buzzer:无源蜂鸣器 +DeviceBuzzer buzzer(bsp_pwm_tim12_ch2); diff --git a/tools/tests/snapshots/mc02_full/board_cfg.cpp__init.txt b/tools/tests/snapshots/mc02_full/board_cfg.cpp__init.txt new file mode 100644 index 0000000..96a47cd --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.cpp__init.txt @@ -0,0 +1,13 @@ + // 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 + ICBSP_CHECK(bsp_can1.init() == Status::OK); + ICBSP_CHECK(bsp_can2.init() == Status::OK); + ICBSP_CHECK(bsp_uart1.init() == Status::OK); + ICBSP_CHECK(bsp_uart2.init() == Status::OK); + ICBSP_CHECK(bsp_uart3.init() == Status::OK); + ICBSP_CHECK(bsp_uart7.init() == Status::OK); + ICBSP_CHECK(bsp_uart10.init() == Status::OK); + ICBSP_CHECK(bsp_spi2.init() == Status::OK); + ICBSP_CHECK(bsp_pwm_tim12_ch2.init() == Status::OK); + ICBSP_CHECK(imu_bmi088_acc_spi.init() == Status::OK); + ICBSP_CHECK(imu_bmi088_gyro_spi.init() == Status::OK); + ICBSP_CHECK(imu_bmi088.init() == Status::OK); diff --git a/tools/tests/snapshots/mc02_full/board_cfg.hpp__devices.txt b/tools/tests/snapshots/mc02_full/board_cfg.hpp__devices.txt new file mode 100644 index 0000000..6d4c643 --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.hpp__devices.txt @@ -0,0 +1,7 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// imu_bmi088:BMI088 IMU(含 VQF 姿态) +extern BspSpiDevice imu_bmi088_acc_spi; +extern BspSpiDevice imu_bmi088_gyro_spi; +extern DeviceBmi088 imu_bmi088; +/// buzzer:无源蜂鸣器 +extern DeviceBuzzer buzzer; diff --git a/tools/tests/snapshots/mc02_full/board_cfg.hpp__includes.txt b/tools/tests/snapshots/mc02_full/board_cfg.hpp__includes.txt new file mode 100644 index 0000000..7e15a93 --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.hpp__includes.txt @@ -0,0 +1,15 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#include "bsp/bsp_series.hpp" // IWYU pragma: keep +#include "main.h" // IWYU pragma: keep(GPIO 标签宏) +#include "fdcan.h" +#include "spi.h" +#include "tim.h" +#include "usart.h" +#include "bsp/bsp_can.hpp" +#include "bsp/bsp_dma_buffer.hpp" +#include "bsp/bsp_dwt.hpp" +#include "bsp/bsp_pwm.hpp" +#include "bsp/bsp_spi.hpp" +#include "bsp/bsp_uart.hpp" +#include "device/actuator/device_buzzer.hpp" +#include "device/sensor/device_bmi088.hpp" diff --git a/tools/tests/snapshots/mc02_full/board_cfg.hpp__peripherals.txt b/tools/tests/snapshots/mc02_full/board_cfg.hpp__peripherals.txt new file mode 100644 index 0000000..f4bcede --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_cfg.hpp__peripherals.txt @@ -0,0 +1,23 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +/// FDCAN1:CAN 总线 +inline BspCanT<16, 16> bsp_can1({.hfdcan = &hfdcan1, .name = "CAN1"}); +/// FDCAN2:CAN 总线 +inline BspCanT<16, 16> bsp_can2({.hfdcan = &hfdcan2, .name = "CAN2"}); +/// USART1:串口 +inline ICBSP_DMA_BUFFER(bsp_uart1) BspUartT bsp_uart1({.huart = &huart1, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// USART2:串口 +inline ICBSP_DMA_BUFFER(bsp_uart2) BspUartT bsp_uart2({.huart = &huart2, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// USART3:串口 +inline ICBSP_DMA_BUFFER(bsp_uart3) BspUartT bsp_uart3({.huart = &huart3, .mode = UartDir::TxRx, .baudrate = 115200U}); +/// UART7:串口 +inline ICBSP_DMA_BUFFER(bsp_uart7) BspUartT bsp_uart7({.huart = &huart7, .mode = UartDir::TxRx, .baudrate = 921600U}); +/// USART10:串口 +inline ICBSP_DMA_BUFFER(bsp_uart10) BspUartT bsp_uart10({.huart = &huart10, .mode = UartDir::TxRx, .baudrate = 921600U}); +/// SPI2:SPI 主机 +inline ICBSP_DMA_BUFFER(bsp_spi2) BspSpi bsp_spi2({.hspi = &hspi2, .use_dma = true, .dma_threshold = 16U}); +/// TIM12_CH2:PWM 通道 +inline BspPwm bsp_pwm_tim12_ch2({.htim = &htim12, .channel = TIM_CHANNEL_2, .timer_clk_hz = 275000000UL, .prescaler = 23U, .period = 1999U}); + +/// 调试打印串口:USART1 +#define ICBSP_UART_PRINT_ENABLE 1 +#define print_uart(...) bsp_uart1.printf(__VA_ARGS__) diff --git a/tools/tests/snapshots/mc02_full/board_instances.hpp__instances.txt b/tools/tests/snapshots/mc02_full/board_instances.hpp__instances.txt new file mode 100644 index 0000000..9521c4e --- /dev/null +++ b/tools/tests/snapshots/mc02_full/board_instances.hpp__instances.txt @@ -0,0 +1,12 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_CAN_INSTANCES(X) \ + X(bsp_can1) \ + X(bsp_can2) +#define ICBSP_UART_INSTANCES(X) \ + X(bsp_uart1) \ + X(bsp_uart2) \ + X(bsp_uart3) \ + X(bsp_uart7) \ + X(bsp_uart10) +#define ICBSP_SPI_INSTANCES(X) \ + X(bsp_spi2) diff --git a/tools/tests/snapshots/mc02_full/hardware_config.h__switches.txt b/tools/tests/snapshots/mc02_full/hardware_config.h__switches.txt new file mode 100644 index 0000000..de0da06 --- /dev/null +++ b/tools/tests/snapshots/mc02_full/hardware_config.h__switches.txt @@ -0,0 +1,5 @@ +// 由 tools/integrate.py 按 .ioc 与接入选择生成:要改就改选择后重新运行;手改本区会被检测到、拒绝覆盖 +#define ICBSP_SYS_TASK_ENABLE 1 ///< 系统维护任务 sys_task +#define ICBSP_CAN_RX_ENABLE 1 ///< CAN 接收路径(can_rx_task + 接收节点) +#define ICBSP_CAN_TX_ENABLE 1 ///< CAN 发送路径(can_tx_task + 发送节点) +#define ICBSP_UART_PATROL_ENABLE 1 ///< sys_task 里的串口巡检 diff --git a/tools/tests/test_flash.py b/tools/tests/test_flash.py new file mode 100644 index 0000000..7182653 --- /dev/null +++ b/tools/tests/test_flash.py @@ -0,0 +1,442 @@ +""" +外置 QSPI Flash / 编译优化 / .gitignore 的主机侧测试(不需要工具链和硬件)。 + + cd tools && python3 -m unittest discover -s tests -v + +夹具 fixtures/h750_qspi.ioc:H750_FULL_TEST 回归宿主的 .ioc(STM32H750VBTx,W25Q128 在 QUADSPI Bank 2,实板验证过)。 +""" + +import json +import re +import struct +import sys +import tempfile +import unittest +import zlib +from pathlib import Path + +HERE = Path(__file__).resolve().parent +sys.path.insert(0, str(HERE.parent)) + +import integrate # noqa: E402 +import qspi_image # noqa: E402 +from icbsp_tool import checks, flash, host_options, manifest, regions, selection # noqa: E402 +from icbsp_tool.ioc import Ioc # noqa: E402 + +MAN = manifest.load() +W25Q128 = flash.chip_for(MAN, "W25Q128") + + +def load(name): + return Ioc(HERE / "fixtures" / name) + + +class FlashAnalyzeTest(unittest.TestCase): + def test_flash_size_code(self): + self.assertEqual(flash.internal_flash_kb("STM32H750VBTx"), 128) + self.assertEqual(flash.internal_flash_kb("STM32H723VGTx"), 1024) + self.assertEqual(flash.internal_flash_kb("STM32H743VITx"), 2048) + self.assertEqual(flash.internal_flash_kb("STM32F407VGTx"), 1024) + self.assertIsNone(flash.internal_flash_kb("nonsense")) + + def test_h750_suggest(self): + a = flash.analyze(load("h750_qspi.ioc"), None, MAN) + self.assertEqual((a["peripheral"], a["supported"], a["bank"], a["internal_kb"]), ("QUADSPI", True, 2, 128)) + self.assertTrue(a["suggest"]) + self.assertEqual([p["signal"] for p in a["pins"]], ["CLK", "NCS", "IO0", "IO1", "IO2", "IO3"]) + self.assertEqual(a["chip_guess"], "W25Q128") # QUADSPI.FlashSize = 23 + + def test_octospi_not_supported(self): + a = flash.analyze(load("mc02_h723.ioc"), None, MAN) + self.assertFalse(a["supported"]) + self.assertTrue(a["peripheral"].startswith("OCTOSPI")) + self.assertIn("暂不支持", a["note"]) + self.assertFalse(a["suggest"]) + + def test_pin_af_table(self): + pins = flash.pin_afs(load("h750_qspi.ioc"), None) # 没有 quadspi.c 时用内置表 + self.assertEqual([(p[0], p[3]) for p in pins], + [("PB2", 9), ("PC11", 9), ("PE7", 10), ("PE8", 10), ("PE9", 10), ("PE10", 10)]) + + def test_af_from_msp(self): + with tempfile.TemporaryDirectory() as d: + p = Path(d) / "quadspi.c" + p.write_text(" GPIO_InitStruct.Pin = GPIO_PIN_7|GPIO_PIN_8;\n GPIO_InitStruct.Alternate = GPIO_AF10_QUADSPI;\n" + " HAL_GPIO_Init(GPIOE, &GPIO_InitStruct);\n", encoding="utf-8") + self.assertEqual(flash.af_from_msp(p), {"PE7": 10, "PE8": 10}) + + def test_map_usage_skips_noload(self): + with tempfile.TemporaryDirectory() as d: + m = Path(d) / "x.map" + m.write_text("Linker script and memory map\n\n" + ".text 0x08000000 0x1000\n" + ".data 0x20000000 0x100 load address 0x08001000\n" + ".bss 0x20000100 0x7000 load address 0x08001100\n" + "._user_heap_stack 0x20007100 0x600 load address 0x08001100\n", encoding="utf-8") + self.assertEqual(flash._map_flash_bytes(m), 0x1100) + + +class FlashGenerateTest(unittest.TestCase): + def setUp(self): + self.pins = flash.pin_afs(load("h750_qspi.ioc"), None) + + def test_config_header(self): + h = flash.config_header(W25Q128, 2, self.pins, 2) + # cmake/icbsp_flash.cmake 用正则读这两个整数宏 + for name, want in (("ICBSP_QSPI_FLASH_SIZE", 16 << 20), ("ICBSP_AXI_SRAM_SIZE", 512 << 10)): + m = re.search(rf"#define {name} \(?(0[xX][0-9a-fA-F]+|[0-9]+)[uU]?", h) + self.assertEqual(int(m.group(1), 0), want) + self.assertIn("#define ICBSP_QSPI_BANK 2", h) + self.assertIn("X(E, 10, 10)", h) + self.assertNotRegex(h, r"[ \t]+\n", "行尾不应有空格") + + def test_openocd_init(self): + tcl = flash.openocd_qspi_init(W25Q128, 2, self.pins) + self.assertIn("mww 0x52005000 0x01000390", tcl) # PRESCALER=1、FTHRES=3、FSEL、SSHIFT + self.assertIn("mww 0x52005004 0x00170500", tcl) # FSIZE=23、CSHT=5 + self.assertIn("mww 0x52005014 0x0D002503", tcl) # 单线内存映射读 0x03 + self.assertIn("mmw 0x58021024 0x00000AAA 0x00000FFF", tcl) # PE8~PE10 AF10 + + +class OptionsSelectionTest(unittest.TestCase): + def test_defaults(self): + s = selection.default_selection(load("h750_qspi.ioc"), MAN) + self.assertFalse(s["external_flash"]["enabled"]) + self.assertEqual(s["external_flash"]["chip"], "W25Q128") + self.assertFalse(s["optimization"]["enabled"]) + self.assertTrue(s["gitignore"]) + self.assertTrue(s["flash_scripts"]) + + def test_merge_and_validate(self): + ioc = load("h750_qspi.ioc") + s = selection.merge(ioc, MAN, {"external_flash": {"enabled": True, "prescaler": 0}}) + bad = selection.validate_options(ioc, MAN, s) + self.assertTrue(any(w == "external_flash.prescaler" and lv == "error" for lv, w, _ in bad)) # 240 MHz > 133 + s = selection.merge(ioc, MAN, {"external_flash": {"enabled": True, "prescaler": 2}}) + self.assertEqual([b for b in selection.validate_options(ioc, MAN, s) if b[0] == "error"], []) + s = selection.merge(ioc, MAN, {"optimization": {"enabled": True, "Debug": "-O7"}}) + self.assertTrue(any(w == "optimization.Debug" for _, w, _ in selection.validate_options(ioc, MAN, s))) + + def test_octospi_enabled_is_error(self): + ioc = load("mc02_h723.ioc") + s = selection.merge(ioc, MAN, {"external_flash": {"enabled": True, "chip": "W25Q64"}}) + self.assertTrue(any(lv == "error" and w == "external_flash" for lv, w, _ in selection.validate_options(ioc, MAN, s))) + + def test_qspi_params_rule(self): + ioc = load("h750_qspi.ioc") + ef = {"enabled": True, "chip": "W25Q128", "prescaler": 2} + r = [x for x in checks.run(ioc, MAN, {}, ef) if x["id"] == "qspi_params"] + self.assertEqual(len(r), 1) + self.assertTrue(r[0]["ok"], r[0]["detail"]) # 夹具已经按芯片改好 + ef["prescaler"] = 3 + r = [x for x in checks.run(ioc, MAN, {}, ef) if x["id"] == "qspi_params"][0] + self.assertFalse(r["ok"]) + self.assertIn({"key": "QUADSPI.ClockPrescaler", "old": "2", "new": "3"}, r["changes"]) + self.assertEqual([x for x in checks.run(ioc, MAN, {}, None) if x["id"] == "qspi_params"], []) + + +class SpiRulesTest(unittest.TestCase): + """H750 回归宿主的 BMI088 卡死:SPI6 没写 DataSize(H7 的 CubeMX 默认 4 位帧)、/2 分频 = 60 MHz""" + + BMI = [{"type": "bmi088", "name": "imu", "needs": {"bus": "SPI6"}}] + + def test_h750_spi6(self): + ioc = load("h750_qspi.ioc") # 夹具是改好之后的配置:8 位、/16 + r = {(x["id"], x["target"]): x for x in checks.run(ioc, MAN, {"spi": {"SPI6": {}}}, None, self.BMI)} + self.assertTrue(r[("spi_8bit", "SPI6")]["ok"]) + self.assertTrue(r[("spi_bmi088_speed", "SPI6")]["ok"], r[("spi_bmi088_speed", "SPI6")]["detail"]) + # 还原成出问题时的样子:没写 DataSize、/2 分频 + del ioc.values["SPI6.DataSize"] + ioc.values["SPI6.BaudRatePrescaler"] = "SPI_BAUDRATEPRESCALER_2" + s = {x["ip"]: x for x in ioc.spi_instances()}["SPI6"] + self.assertEqual((s["data_size"], s["prescaler"], s["kernel_hz"]), ("SPI_DATASIZE_4BIT", 2, 120000000)) + r = {(x["id"], x["target"]): x for x in checks.run(ioc, MAN, {"spi": {"SPI6": {}}}, None, self.BMI)} + bit = r[("spi_8bit", "SPI6")] + self.assertFalse(bit["ok"]) + self.assertIn({"key": "SPI6.DataSize", "old": None, "new": "SPI_DATASIZE_8BIT"}, bit["changes"]) + spd = r[("spi_bmi088_speed", "SPI6")] + self.assertFalse(spd["ok"]) + self.assertIn({"key": "SPI6.BaudRatePrescaler", "old": "SPI_BAUDRATEPRESCALER_2", "new": "SPI_BAUDRATEPRESCALER_16"}, spd["changes"]) + + def test_mc02_spi2_ok(self): + ioc = load("mc02_h723.ioc") + bmi = [{"type": "bmi088", "name": "imu", "needs": {"bus": "SPI2"}}] + r = {(x["id"], x["target"]): x for x in checks.run(ioc, MAN, {"spi": {"SPI2": {}}}, None, bmi)} + self.assertTrue(r[("spi_8bit", "SPI2")]["ok"]) + self.assertTrue(r[("spi_bmi088_speed", "SPI2")]["ok"], r[("spi_bmi088_speed", "SPI2")]["detail"]) + + +class CanRulesTest(unittest.TestCase): + """H750 回归宿主的 CAN 丢帧:.ioc 没写 AutoRetransmission(CubeMX 默认 Disable), + 两路对发时仲裁输掉的帧不重发,ID 大的一路丢 45%,驱动的诊断计数全为 0""" + + SEL = {"can": {"FDCAN1": {}, "FDCAN2": {}}} + + def results(self, ioc): + return {(x["id"], x["target"]): x for x in checks.run(ioc, MAN, self.SEL)} + + def test_h750_auto_retx(self): + ioc = load("h750_qspi.ioc") # 夹具是改好之后的配置:两路都 ENABLE + r = self.results(ioc) + for ip in ("FDCAN1", "FDCAN2"): + self.assertTrue(r[("can_auto_retx", ip)]["ok"], r[("can_auto_retx", ip)]["detail"]) + # 还原成出问题时的样子:不写 AutoRetransmission,IPParameters 里也没有它 + for ip in ("FDCAN1", "FDCAN2"): + del ioc.values[f"{ip}.AutoRetransmission"] + names = [n for n in ioc.values[f"{ip}.IPParameters"].split(",") if n != "AutoRetransmission"] + ioc.values[f"{ip}.IPParameters"] = ",".join(names) + self.assertEqual([c["auto_retx"] for c in ioc.can_instances()], ["DISABLE", "DISABLE"]) + r = self.results(ioc) + for ip in ("FDCAN1", "FDCAN2"): + x = r[("can_auto_retx", ip)] + self.assertFalse(x["ok"]) + self.assertEqual(x["level"], "error") + self.assertTrue(x["auto_fix"]) + self.assertIn({"key": f"{ip}.AutoRetransmission", "old": None, "new": "ENABLE"}, x["changes"]) + ipp = next(c for c in x["changes"] if c["key"] == f"{ip}.IPParameters") + self.assertIn("AutoRetransmission", ipp["new"].split(",")) + + def test_mc02_auto_retx_ok(self): + ioc = load("mc02_h723.ioc") + r = {(x["id"], x["target"]): x for x in checks.run(ioc, MAN, {"can": {"FDCAN1": {}, "FDCAN2": {}, "FDCAN3": {}}})} + for ip in ("FDCAN1", "FDCAN2", "FDCAN3"): + self.assertTrue(r[("can_auto_retx", ip)]["ok"]) + + +class HashRegionTest(unittest.TestCase): + def test_roundtrip(self): + t = "a\n" + regions.block("x", "foo", "#") + "\nb" + r = regions.parse(t, "#")[0]["x"] + self.assertEqual(r["recorded"], r["actual"]) + self.assertEqual(regions.parse(t)[0], {}) # // 标记不认 # + t2 = regions.replace(t, "x", "bar", "#") + self.assertEqual(regions.parse(t2, "#")[0]["x"]["body"], "bar") + self.assertEqual(regions.edited(t2.replace("bar", "baz"), "#"), ["x"]) + + +def fake_host(tmp): + host = Path(tmp) + (host / "CMakeLists.txt").write_text( + "project(demo)\nadd_subdirectory(cmake/stm32cubemx)\n\n" + "# icbsp:必须在 add_subdirectory(cmake/stm32cubemx) 之后接入\nadd_subdirectory(third_party/icbsp)\n", encoding="utf-8") + (host / "CMakePresets.json").write_text(json.dumps({ + "version": 3, + "configurePresets": [{"name": "default", "hidden": True}, {"name": "Debug", "inherits": "default"}, + {"name": "Release", "inherits": "default"}], + "buildPresets": [{"name": "Debug", "configurePreset": "Debug"}, {"name": "Release", "configurePreset": "Release"}], + }, indent=4), encoding="utf-8") + return host + + +class HostOptionsTest(unittest.TestCase): + def sel(self, **kw): + s = selection.default_selection(load("h750_qspi.ioc"), MAN) + selection.merge_options(s, kw) + return s + + def test_cmake_region(self): + with tempfile.TemporaryDirectory() as d: + host = fake_host(d) + plan, rep = integrate.Plan(), integrate.Report() + s = self.sel(external_flash={"enabled": True, "layout": "QSPI_XIP"}, + optimization={"enabled": True, "Debug": "-Og", "vendor_os": True}) + host_options.plan_cmake_region(host, plan, rep, integrate.TextFile, s, "third_party/icbsp", "user/board", MAN, False) + self.assertFalse(rep.has_error, rep.items) + text = plan.edits[host / "CMakeLists.txt"].text + self.assertLess(text.index(""), text.index("# icbsp:必须在")) + self.assertIn("DEFAULT QSPI_XIP", text) + self.assertIn("icbsp_optimization(TARGET ${CMAKE_PROJECT_NAME} Debug -Og RelWithDebInfo -O2 Release -Os VENDOR_OS)", text) + # 再跑一次:内容一致就跳过;关掉两项就清空生成区 + (host / "CMakeLists.txt").write_text(text, encoding="utf-8") + plan, rep = integrate.Plan(), integrate.Report() + host_options.plan_cmake_region(host, plan, rep, integrate.TextFile, s, "third_party/icbsp", "user/board", MAN, False) + self.assertTrue(plan.empty()) + off = self.sel() + host_options.plan_cmake_region(host, plan, rep, integrate.TextFile, off, "third_party/icbsp", "user/board", MAN, False) + self.assertNotIn("icbsp_flash_layout", plan.edits[host / "CMakeLists.txt"].text) + + def test_cmake_region_edited(self): + with tempfile.TemporaryDirectory() as d: + host = fake_host(d) + text = (host / "CMakeLists.txt").read_text(encoding="utf-8") + text = text.replace("# icbsp:必须在", regions.block("icbsp-options", "set(X 1)", "#").replace("set(X 1)", "set(X 2)") + "\n# icbsp:必须在") + (host / "CMakeLists.txt").write_text(text, encoding="utf-8") + plan, rep = integrate.Plan(), integrate.Report() + s = self.sel(optimization={"enabled": True}) + host_options.plan_cmake_region(host, plan, rep, integrate.TextFile, s, "third_party/icbsp", "user/board", MAN, False) + self.assertTrue(rep.has_error) + + def test_presets(self): + with tempfile.TemporaryDirectory() as d: + host = fake_host(d) + plan, rep = integrate.Plan(), integrate.Report() + host_options.plan_presets(host, plan, rep, integrate.TextFile, self.sel(external_flash={"enabled": True}), MAN) + data = json.loads(plan.edits[host / "CMakePresets.json"].text) + names = [p["name"] for p in data["configurePresets"]] + for n in ("RelWithDebInfo", "Debug-Internal", "Debug-QspiRam", "Debug-QspiXip", "Release-QspiXip", "RelWithDebInfo-QspiRam"): + self.assertIn(n, names) + p = next(p for p in data["configurePresets"] if p["name"] == "Debug-QspiXip") + self.assertEqual(p, {"name": "Debug-QspiXip", "inherits": "Debug", "cacheVariables": {"ICBSP_FLASH_LAYOUT": "QSPI_XIP"}}) + self.assertEqual(sorted(names), sorted({p["configurePreset"] for p in data["buildPresets"]} | {"default"})) + + def test_gitignore(self): + with tempfile.TemporaryDirectory() as d: + host = Path(d) + plan, rep = integrate.Plan(), integrate.Report() + host_options.plan_gitignore(host, plan, rep, integrate.TextFile) + self.assertIn("build/", plan.new_files[host / ".gitignore"]) + (host / ".gitignore").write_text("build/\n*.su\nmy_secret.txt\n", encoding="utf-8") + plan, rep = integrate.Plan(), integrate.Report() + host_options.plan_gitignore(host, plan, rep, integrate.TextFile) + text = plan.edits[host / ".gitignore"].text + self.assertTrue(text.startswith("build/\n*.su\nmy_secret.txt\n")) + self.assertIn(host_options.GITIGNORE_BEGIN, text) + self.assertEqual(text.count("build/"), 1) + (host / ".gitignore").write_text(text, encoding="utf-8") + plan, rep = integrate.Plan(), integrate.Report() + host_options.plan_gitignore(host, plan, rep, integrate.TextFile) + self.assertTrue(plan.empty()) + + +class VscodeExtrasTest(unittest.TestCase): + INFO = {"PRESET": "Debug", "PROJECT": "demo", "MCU": "STM32H750VBTx", "DEVICE": "STM32H750VB", "OPENOCD_TARGET": "stm32h7x.cfg", + "SVD": "", "COMPILE_COMMANDS_DIR": "build/Debug", "QUERY_DRIVER": "**/arm-none-eabi-*"} + + def run_plan(self, host, extras): + plan, rep = integrate.Plan(), integrate.Report() + integrate.plan_vscode(host, plan, rep, self.INFO, extras) + self.assertFalse(rep.has_error, rep.items) + return plan, rep + + @staticmethod + def text(plan, host, name): + p = host / ".vscode" / name + return plan.new_files[p] if p in plan.new_files else plan.edits[p].text + + def parsed(self, plan, host, name): + return json.loads(integrate.strip_jsonc(self.text(plan, host, name))) + + def test_new_host_without_flash(self): + with tempfile.TemporaryDirectory() as d: + host = Path(d) + plan, _ = self.run_plan(host, ()) + tasks = [t["label"] for t in self.parsed(plan, host, "tasks.json")["tasks"]] + buttons = [b["task"] for b in self.parsed(plan, host, "settings.json")["VsCodeTaskButtons.tasks"]] + self.assertEqual(tasks, ["Build", "Clean_Rebuild", "Clean"]) + self.assertEqual(buttons, ["Build", "Clean_Rebuild", "Clean"]) + + def test_new_host_with_flash_and_qspi(self): + with tempfile.TemporaryDirectory() as d: + host = Path(d) + plan, _ = self.run_plan(host, ("flash", "qspi")) + tasks = {t["label"]: t for t in self.parsed(plan, host, "tasks.json")["tasks"]} + buttons = [b["task"] for b in self.parsed(plan, host, "settings.json")["VsCodeTaskButtons.tasks"]] + self.assertEqual(buttons, ["Build", "Clean_Rebuild", "Clean", "OpenOCD_flash", "JLink_flash", "OpenOCD_ram_run", "OpenOCD_flash_boot"]) + self.assertIn("Debug-QspiRam --ram", tasks["OpenOCD_ram_run"]["command"]) + self.assertEqual(tasks["OpenOCD_flash_boot"]["args"], ["Debug", "--boot"]) + self.assertTrue(set(buttons) <= set(tasks), "每个按钮都要有对应的任务") + self.assertIn("// 状态栏按钮", self.text(plan, host, "settings.json"), "新建时保留模板注释") + + def test_existing_settings_get_buttons(self): + with tempfile.TemporaryDirectory() as d: + host = Path(d) + (host / ".vscode").mkdir() + (host / ".vscode" / "settings.json").write_text('{\n // 宿主自己的设置\n "editor.tabSize": 2\n}\n', encoding="utf-8") + plan, _ = self.run_plan(host, ("flash",)) + text = self.text(plan, host, "settings.json") + self.assertIn("// 宿主自己的设置", text) + data = json.loads(integrate.strip_jsonc(text)) + self.assertEqual(data["editor.tabSize"], 2) + self.assertEqual([b["task"] for b in data["VsCodeTaskButtons.tasks"]], ["Build", "Clean_Rebuild", "Clean", "OpenOCD_flash", "JLink_flash"]) + # 写回后再跑一次:不重复添加 + for name in ("settings.json", "tasks.json", "launch.json"): + (host / ".vscode" / name).write_text(self.text(plan, host, name), encoding="utf-8") + plan, _ = self.run_plan(host, ("flash",)) + self.assertTrue(plan.empty()) + # 之后关掉 Flash/:已有的烧录按钮不删,只提示 + plan, rep = self.run_plan(host, ()) + self.assertTrue(plan.empty()) + self.assertTrue(any("不会删除" in m for _, _, m in rep.items)) + + +# ---------------------------------------------------------------- qspi_image + + +def make_elf(sections): + """最小的 ELF32 小端:sections = [(lma, vma, data or size, nobits)];每段一个 PT_LOAD""" + ehsize, phentsize, shentsize = 52, 32, 40 + phnum = len(sections) + off = ehsize + phnum * phentsize + blobs, phdrs, shdrs = b"", [], [struct.pack("<10I", *([0] * 10))] + for lma, vma, data, nobits in sections: + size = data if nobits else len(data) + phdrs.append(struct.pack("<8I", 1, off, vma, lma, 0 if nobits else size, size, 6, 4)) + shdrs.append(struct.pack("<10I", 0, 8 if nobits else 1, 2, vma, off, size, 0, 0, 4, 0)) + if not nobits: + blobs += data + off += size + shoff = off + eh = b"\x7fELF" + bytes([1, 1, 1]) + bytes(9) + eh += struct.pack("/<文件>__<生成区>.txt 逐字比对。 +编译验证(生成结果 0 warning)见 compile_test.sh,需要 ARM 工具链与 STM32CubeMX。 +""" + +import json +import os +import sys +import unittest +from pathlib import Path + +HERE = Path(__file__).resolve().parent +sys.path.insert(0, str(HERE.parent)) + +from icbsp_tool import checks, generate, manifest, regions, selection # noqa: E402 +from icbsp_tool.ioc import Ioc, fdcan_words # noqa: E402 + +TEMPLATES = HERE.parent.parent / "templates" / "user" / "board" +UPDATE = os.environ.get("ICBSP_UPDATE_SNAPSHOTS") == "1" + + +def load(name): + return Ioc(HERE / "fixtures" / name) + + +class ManifestTest(unittest.TestCase): + def test_valid(self): + self.assertEqual(manifest.validate(manifest.load()), []) + + def test_templates_sealed(self): + for f in ("board_cfg.hpp", "board_cfg.cpp", "board_instances.hpp", "hardware_config.h"): + text = (TEMPLATES / f).read_text(encoding="utf-8") + regs, bad = regions.parse(text) + self.assertEqual(bad, [], f) + self.assertTrue(regs, f"{f} 没有生成区") + self.assertEqual(regions.edited(text), [], f"{f} 的生成区哈希不对(改模板后要重新 seal)") + + +class IocTest(unittest.TestCase): + def test_mc02_parse(self): + i = load("mc02_h723.ioc") + self.assertEqual((i.mcu, i.series, i.timebase_tim()), ("STM32H723VGTx", "h7", "TIM8")) + cans = i.can_instances() + self.assertEqual([c["msgram_offset"] for c in cans], [0, 129, 258]) + self.assertEqual([fdcan_words(c) for c in cans], [129, 129, 129]) + self.assertEqual(i.timer_clock(12), (275000000, True)) + self.assertIn("GYRO_ACC_CS", i.gpio_outputs()) + self.assertIn("GYRO_GYRO_INT", i.gpio_exti()) + self.assertIn((12, 2), i.pwm_channels()) + + def test_defaults(self): + i = load("defaults_h723.ioc") + c = i.can_instances()[0] + self.assertEqual((c["rx_fifo0"], c["tx_fifo_queue"], c["std_filters"], c["msgram_offset"]), (0, 0, 0, 0)) + self.assertEqual(i.freertos()["stack_check"], 0) + + def test_set_roundtrip(self): + i = load("mc02_h723.ioc") + i.set("TIM1.Channel-PWM Generation1 CH1", "TIM_CHANNEL_1") # 键里有空格 + self.assertFalse(i.changed()) + i.set("ZZZ.New", "a:b") + self.assertIn("ZZZ.New=a\\:b", i.text()) + self.assertEqual(Ioc.__new__(Ioc).__class__, Ioc) + + +class ChecksTest(unittest.TestCase): + def setUp(self): + self.m = manifest.load() + + def run_checks(self, name): + i = load(name) + sel = selection.default_selection(i, self.m) + return i, checks.run(i, self.m, selection.by_kind(sel)) + + def test_mc02_all_pass(self): + _, res = self.run_checks("mc02_h723.ioc") + self.assertEqual([r for r in res if not r["ok"]], []) + + def test_defaults_fail_and_fix(self): + i, res = self.run_checks("defaults_h723.ioc") + failed = {(r["id"], r["target"]) for r in res if not r["ok"]} + for want in [("can_fifo", "FDCAN1"), ("can_std_filters", "FDCAN2"), ("spi_keep_io", "SPI2"), ("uart_nvic", "USART1"), + ("rtos_stack_check", ""), ("can_msgram", "FDCAN")]: + self.assertIn(want, failed) + from icbsp_tool import cubemx + + cubemx.apply_fixes(i, res, "all") + sel = selection.default_selection(i, self.m) + again = checks.run(i, self.m, selection.by_kind(sel)) + self.assertEqual([(r["id"], r["target"]) for r in again if not r["ok"]], []) + self.assertEqual([c["msgram_offset"] for c in i.can_instances()], [0, 129, 258]) + + def test_usable(self): + u = checks.usable(load("mc02_h723.ioc")) + self.assertFalse(u["SPI1"][0]) # 只发送 + self.assertTrue(u["SPI2"][0]) + + +class SelectionTest(unittest.TestCase): + def setUp(self): + self.m = manifest.load() + self.i = load("mc02_h723.ioc") + + def errors(self, user): + sel = selection.merge(self.i, self.m, user) + return [w + " " + msg for _, w, msg in selection.validate(self.i, self.m, sel)] + + def test_default_has_no_pwm(self): + sel = selection.default_selection(self.i, self.m) + self.assertFalse(any(p["enabled"] for p in sel["peripherals"].values() if p["kind"] == "pwm")) + + def test_errors(self): + dev = lambda **k: {"peripherals": {"TIM12_CH2": {"enabled": True}}, "devices": [k]} + self.assertTrue(any("1~7" in e for e in self.errors(dev(type="dji_motor", name="m", needs={"bus": "FDCAN1"}, params={"type": "GM6020", "id": 8})))) + self.assertTrue(any("计划中" in e for e in self.errors(dev(type="dr16", name="rc", needs={"bus": "USART1"})))) + self.assertTrue(any("缺" in e for e in self.errors(dev(type="bmi088", name="imu", needs={"bus": "SPI2"})))) + two = {"peripherals": {"TIM12_CH2": {"enabled": True}}, + "devices": [{"type": "buzzer", "name": "a", "needs": {"pwm": "TIM12_CH2"}}, {"type": "servo", "name": "b", "needs": {"pwm": "TIM12_CH2"}}]} + self.assertTrue(any("已经给" in e for e in self.errors(two))) + dup = {"devices": [{"type": "r9ds", "name": "bsp_uart1", "needs": {"bus": "USART1"}}]} + self.assertTrue(any("重复" in e for e in self.errors(dup))) + self.assertTrue(any("没有选中" in e for e in self.errors({"peripherals": {"FDCAN1": {"enabled": False}}, + "devices": [{"type": "dm_motor", "name": "x", "needs": {"bus": "FDCAN1"}}]}))) + self.assertTrue(any("需要 ICBSP_SYS_TASK_ENABLE" in e for e in self.errors({"switches": {"ICBSP_SYS_TASK_ENABLE": 0}}))) + + def test_catalog(self): + sel = selection.default_selection(self.i, self.m) + cat = {d["type"]: d for d in selection.device_catalog(self.i, self.m, sel)} + self.assertTrue(cat["bmi088"]["available"]) + self.assertFalse(cat["device_motor"]["available"]) # 没有编码器 + self.assertFalse(cat["dr16"]["available"]) + + +class GenerateTest(unittest.TestCase): + def test_snapshots(self): + m = manifest.load() + for case in sorted((HERE / "cases").glob("*.json")): + c = json.loads(case.read_text(encoding="utf-8")) + i = load(c["ioc"]) + sel = selection.merge(i, m, c["selection"]) + self.assertEqual([b for b in selection.validate(i, m, sel) if b[0] == "error"], [], case.name) + out = generate.Generator(i, m, sel).regions() + snap = HERE / "snapshots" / case.stem + for f, regs in out.items(): + for r, body in regs.items(): + p = snap / f"{f}__{r}.txt" + if UPDATE: + p.parent.mkdir(parents=True, exist_ok=True) + p.write_text(body + "\n", encoding="utf-8") + with self.subTest(case=case.stem, file=f, region=r): + self.assertTrue(p.exists(), f"缺快照 {p}(ICBSP_UPDATE_SNAPSHOTS=1 生成)") + self.assertEqual(p.read_text(encoding="utf-8"), body + "\n") + + def test_fill_templates_idempotent(self): + m = manifest.load() + i = load("mc02_h723.ioc") + c = json.loads((HERE / "cases" / "mc02_full.json").read_text(encoding="utf-8")) + gen = generate.Generator(i, m, selection.merge(i, m, c["selection"])) + for f, regs in gen.regions().items(): + text = (TEMPLATES / f).read_text(encoding="utf-8") + for r, body in regs.items(): + text = regions.replace(text, r, body) + self.assertEqual(regions.edited(text), []) + again = text + for r, body in regs.items(): + again = regions.replace(again, r, body) + self.assertEqual(again, text, f) + hand = text.replace("ICBSP_CHECK(bsp_can1.init()", "ICBSP_CHECK(bsp_can9.init()") if f == "board_cfg.cpp" else None + if hand: + self.assertEqual(regions.edited(hand), ["init"]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/web_ui/app.js b/tools/web_ui/app.js new file mode 100644 index 0000000..ea80a5b --- /dev/null +++ b/tools/web_ui/app.js @@ -0,0 +1,390 @@ +// ICBSP 接入帮助页面:只展示 integrate.py --json 的结果、收集选择;不含任何接入逻辑。 +"use strict"; + +const $ = (id) => document.getElementById(id); +const esc = (s) => String(s ?? "").replace(/[&<>"]/g, (c) => ({ "&": "&", "<": "<", ">": ">", '"': """ })[c]); +const KIND_TITLE = { can: "CAN", uart: "串口", spi: "SPI", pwm: "PWM", encoder: "编码器" }; +const LEVEL = { ok: ["ok", "完成"], skip: ["muted", "跳过"], warn: ["warn-t", "注意"], error: ["err", "错误"] }; + +let state = { info: null, data: null, selection: null }; +let timer = null; + +// ---------- 与服务端交互 ---------- + +function opts() { + return { + board_dir: $("board_dir").value.trim() || undefined, + app_dir: $("app_dir").value.trim() || undefined, + ioc: $("ioc").value.trim() || undefined, + no_vscode: $("no_vscode").checked, + no_clang: $("no_clang").checked, + }; +} + +async function post(path, body) { + const r = await fetch(path, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify(body) }); + return r.json(); +} + +function banner(msg) { + const b = $("banner"); + b.textContent = msg || ""; + b.classList.toggle("hidden", !msg); +} + +async function scan() { + const d = await post("/api/scan", { ...opts(), selection: state.selection }); + if (d.fatal) { + banner(d.fatal + (d.stderr ? "\n" + d.stderr : "")); + return; + } + banner(""); + state.data = d; + if (d.selection) state.selection = d.selection; + render(); + if (d.selection_source === "default" && !state.noticed) { + state.noticed = true; + $("report").insertAdjacentHTML("afterbegin", `

没有找到保存的选择(板级目录下的 icbsp_selection.json),从默认选择开始;写入时会保存。

`); + } +} + +function rescanSoon() { + clearTimeout(timer); + timer = setTimeout(scan, 400); +} + +// ---------- 渲染 ---------- + +function render() { + const d = state.data; + $("project-info").innerHTML = `宿主:${esc(d.host)} 芯片:${esc(d.mcu || "未知")}(${esc(d.series || "-")}) .ioc:${esc(d.ioc || "没找到")}`; + renderChecks(d); + renderPeripherals(d); + renderSwitches(d); + renderFlash(d); + renderOptim(d); + renderHostFiles(d); + renderDevices(d); + renderGenerated(d); + renderReport(d); + renderPlan(d); +} + +function renderChecks(d) { + const rows = (d.ioc_checks || []).map((r, i) => { + const st = r.ok ? `通过` : `${r.level === "error" ? "不满足" : "建议"}`; + const box = !r.ok && r.auto_fix ? `` : ""; + return `${box}${st}${esc(r.target)}${esc(r.title)}${esc(r.detail)}${r.ok ? "" : esc(r.fix)}`; + }); + const failed = (d.ioc_checks || []).filter((r) => !r.ok).length; + $("checks").innerHTML = + `

${failed ? `${failed} 项不满足(勾选的项可以自动修改)` : `全部通过`},共 ${(d.ioc_checks || []).length} 项。

` + + `${rows.join("")}
修改结果对象检查现状怎么改
`; +} + +function paramInput(prm, value, onchange, disabled) { + const id = "p" + Math.random().toString(36).slice(2); + let html; + if (prm.type === "bool") html = ``; + else if (prm.type === "enum") html = ``; + else if (prm.type === "int_list") html = ``; + else html = ``; + setTimeout(() => { + const el = $(id); + if (!el) return; + el.disabled = !!disabled || !!prm.readonly; + el.addEventListener("change", () => { + let v; + if (prm.type === "bool") v = el.checked; + else if (prm.type === "enum") v = el.value; + else if (prm.type === "int_list") v = el.value.split(/[,\s]+/).filter(Boolean).map(Number); + else v = prm.type === "float" ? parseFloat(el.value) : parseInt(el.value, 10); + onchange(v); + }); + }); + return ``; +} + +function renderPeripherals(d) { + const sel = state.selection; + const kinds = d.peripheral_kinds || {}; + const byKind = {}; + for (const c of d.candidates || []) (byKind[c.kind] ||= []).push(c); + let html = ""; + for (const kind of Object.keys(KIND_TITLE)) { + const list = byKind[kind]; + if (!list) continue; + html += `

${KIND_TITLE[kind]}

`; + for (const c of list) { + const p = sel.peripherals[c.ip] || { enabled: false, params: {} }; + const box = ``; + const params = (kinds[kind]?.params || []).map((prm) => + paramInput(prm, p.params[prm.key], (v) => { p.params[prm.key] = v; rescanSoon(); }, !p.enabled)).join(""); + html += ``; + } + html += "
使用外设实例参数说明
${box}${esc(c.ip)}${esc(c.instance)}
${params}
${esc(c.reason)}
"; + } + $("peripherals").innerHTML = html || `

.ioc 里没有库能用的外设

`; + for (const el of document.querySelectorAll(".per-en")) { + el.addEventListener("change", () => { + sel.peripherals[el.dataset.ip].enabled = el.checked; + rescanSoon(); + }); + } + const uarts = (d.candidates || []).filter((c) => c.kind === "uart" && sel.peripherals[c.ip]?.enabled); + $("debug_uart").innerHTML = `` + uarts.map((c) => ``).join(""); + $("debug_uart").onchange = () => { sel.debug_uart = $("debug_uart").value || null; rescanSoon(); }; +} + +function renderSwitches(d) { + const sel = state.selection; + $("switches").innerHTML = Object.entries(d.switches || {}).map(([sid, sw]) => + ``).join(""); + for (const el of document.querySelectorAll(".sw")) { + el.addEventListener("change", () => { sel.switches[el.dataset.id] = el.checked ? 1 : 0; rescanSoon(); }); + } +} + +// ---------- 外置 Flash / 编译优化 / 工程文件(选择里的 external_flash / optimization / gitignore) ---------- + +function renderFlash(d) { + const sel = state.selection; + const a = d.external_flash; + const meta = d.options_meta || {}; + const layouts = (meta.options || {}).flash_layouts || {}; + const chips = meta.flash_chips || []; + if (!sel || !a || !sel.external_flash) { + $("flash").innerHTML = `

(integrate.py 没有返回外置 Flash 信息)

`; + $("suggest").classList.add("hidden"); + return; + } + const ef = sel.external_flash; + + // 建议横幅:.ioc 有 QUADSPI,且片内 Flash 小或最近一次构建占用高 + const sug = $("suggest"); + if (a.suggest && !ef.enabled) { + sug.innerHTML = `建议启用外置 Flash:${a.reasons.map(esc).join(";")}
+ + (启用后在“外置 Flash”一节选芯片,再预览、写入)`; + sug.classList.remove("hidden"); + for (const b of sug.querySelectorAll("button")) { + b.onclick = () => { + ef.enabled = true; + ef.layout = b.dataset.layout; + if (!ef.chip && chips.length) ef.chip = (chips.find((c) => c.status === "tested") || chips[0]).name; + rescanSoon(); + $("flash-sec").scrollIntoView({ behavior: "smooth" }); + }; + } + } else { + sug.classList.add("hidden"); + } + + if (!a.supported) { + $("flash").innerHTML = `

${esc(a.note || ".ioc 没有启用 QUADSPI:外置 Flash 需要先在 CubeMX 里打开 QUADSPI(单 Flash,CLK + NCS + IO0~IO3)")}

` + + (ef.enabled ? `

选择里启用了外置 Flash,但当前 .ioc 不支持

` : ""); + const off = $("ef-off"); + if (off) off.onclick = () => { ef.enabled = false; rescanSoon(); }; + return; + } + + const mhz = (p) => Math.floor(240 / (Number(p) + 1)); + const chip = chips.find((c) => c.name === ef.chip); + const pins = (a.pins || []).map((p) => `${esc(p.pin)}=${esc(p.bank ? "BK" + p.bank + "_" : "")}${esc(p.signal)}`).join(" "); + const usage = a.usage ? `最近一次构建占片内 Flash ${(a.usage.ratio * 100).toFixed(0)}%(${Math.round(a.usage.bytes / 1024)} KB)` : "没找到最近的构建"; + let html = `
${esc(a.peripheral)} Bank ${esc(a.bank ?? "?")}:${pins}
片内 Flash ${esc(a.internal_kb ?? "?")} KB;${esc(usage)}
+ `; + if (ef.enabled) { + html += `
默认程序存放方式` + Object.entries(layouts).map(([k, t]) => + ``).join("") + `
+
+ 芯片 + QSPI 预分频 + → 应用运行时 ${mhz(ef.prescaler)} MHz${chip ? `(${esc(chip.name)} 上限 ${chip.max_mhz} MHz)` : ""} +
`; + if (a.chip_guess && a.chip_guess !== ef.chip) html += `

按 .ioc 的 QUADSPI Flash Size 推测是 ${esc(a.chip_guess)}

`; + } + $("flash").innerHTML = html; + $("ef-enabled").onchange = (e) => { + ef.enabled = e.target.checked; + if (ef.enabled && !ef.chip && chips.length) ef.chip = (chips.find((c) => c.status === "tested") || chips[0]).name; + rescanSoon(); + }; + for (const r of document.querySelectorAll('input[name="ef-layout"]')) r.onchange = () => { ef.layout = r.value; rescanSoon(); }; + if ($("ef-chip")) $("ef-chip").onchange = (e) => { ef.chip = e.target.value || null; rescanSoon(); }; + if ($("ef-pre")) $("ef-pre").onchange = (e) => { ef.prescaler = Number(e.target.value); rescanSoon(); }; +} + +function renderOptim(d) { + const sel = state.selection; + const opt = (d.options_meta || {}).options || {}; + if (!sel || !sel.optimization) { $("optim").innerHTML = ""; return; } + const op = sel.optimization; + let html = ``; + if (op.enabled) { + html += `
` + (opt.build_types || []).map((bt) => + `${esc(bt)}`).join("") + `
+ `; + } + $("optim").innerHTML = html; + $("op-enabled").onchange = (e) => { op.enabled = e.target.checked; rescanSoon(); }; + for (const s of document.querySelectorAll(".op-level")) s.onchange = () => { op[s.dataset.bt] = s.value; rescanSoon(); }; + if ($("op-vendor")) $("op-vendor").onchange = (e) => { op.vendor_os = e.target.checked; rescanSoon(); }; +} + +function renderHostFiles(d) { + const sel = state.selection; + if (!sel) return; + const exists = d.gitignore_exists; + const flashOn = sel.flash_scripts !== false; + const extOn = !!(sel.external_flash && sel.external_flash.enabled); + const noVscode = $("no_vscode").checked; + const buttons = ["[⚡ DAP烧录]", "[🔌 JLink烧录]"].concat(extOn ? ["[🧠 RAM运行]", "[🥾 重烧boot]"] : []); + $("hostfiles").innerHTML = ` + +

${flashOn + ? (noVscode + ? "上面勾了“不处理 .vscode”,所以不会加烧录任务与按钮。" + : `同时在 .vscode/tasks.json 加烧录任务,在 settings.json 的 VsCodeTaskButtons.tasks(Task Buttons 插件)加状态栏按钮:${buttons.map(esc).join(" ")}`) + : "不生成 Flash/,也不加烧录任务与按钮;宿主已有的不会删除。"}

+ `; + $("flash_scripts").onchange = (e) => { sel.flash_scripts = e.target.checked; rescanSoon(); }; + $("gitignore").onchange = (e) => { sel.gitignore = e.target.checked; rescanSoon(); }; +} + +function renderDevices(d) { + const sel = state.selection; + const cat = Object.fromEntries((d.devices || []).map((x) => [x.type, x])); + $("devices").innerHTML = sel.devices.length + ? sel.devices.map((dev, i) => { + const spec = cat[dev.type] || { title: dev.type }; + const needs = Object.entries(dev.needs || {}).map(([k, v]) => `${esc(k)} = ${esc(v)}`).join(","); + const params = Object.entries(dev.params || {}).map(([k, v]) => `${esc(k)} = ${esc(JSON.stringify(v))}`).join(","); + return `
${esc(dev.name)} ${esc(spec.title)} ${esc(statusText(spec.status))} +
${needs}${params ? ";" + params : ""}
`; + }).join("") + : `

还没有设备

`; + for (const el of document.querySelectorAll(".del-dev")) { + el.addEventListener("click", () => { sel.devices.splice(Number(el.dataset.i), 1); rescanSoon(); }); + } + renderAddDevice(d); +} + +function statusText(s) { + return { tested: "已实测", board_use: "上板使用", compile_only: "只编译验证", planned: "计划中" }[s] || s || ""; +} + +function renderAddDevice(d) { + const list = d.devices || []; + const pick = $("add-type")?.value || (list.find((x) => x.available) || {}).type; + const opt = list.map((x) => ``).join(""); + const spec = list.find((x) => x.type === pick); + let html = `
`; + if (spec) html += ` ${esc(statusText(spec.status))} ${esc(spec.status_note)}`; + html += `
`; + const draft = { needs: {}, params: {} }; + if (spec && spec.available) { + html += `
`; + for (const n of spec.needs) { + draft.needs[n.key] = n.optional ? "" : n.options[0] || ""; + html += ``; + } + for (const prm of spec.params) { + draft.params[prm.key] = prm.default; + html += paramInput(prm, prm.default, (v) => { draft.params[prm.key] = v; }); + } + html += `
`; + } + $("add-device").innerHTML = html; + $("add-type").onchange = () => renderAddDevice(d); + for (const el of document.querySelectorAll(".add-need")) el.addEventListener("change", () => { draft.needs[el.dataset.need] = el.value; }); + const btn = $("add-btn"); + if (btn) btn.onclick = () => { + const needs = Object.fromEntries(Object.entries(draft.needs).filter(([, v]) => v)); + state.selection.devices.push({ type: spec.type, name: $("add-name").value.trim(), needs, params: { ...draft.params } }); + rescanSoon(); + }; +} + +function renderGenerated(d) { + const rows = Object.entries(d.generated || {}).map(([f, g]) => { + const st = !g.exists ? `还没有(会从模板新建)` + : !g.regions.length ? `没有生成区(手写的文件)` + : g.edited.length ? `生成区 ${esc(g.edited.join("、"))} 被手改过` + : `${esc(g.regions.join("、"))}`; + return `${esc(g.path)}${st}`; + }); + $("generated").innerHTML = `${rows.join("")}
文件生成区
`; +} + +function renderReport(d) { + $("report").innerHTML = (d.report || []).filter((r) => r.level !== "skip").map((r) => { + const [cls, txt] = LEVEL[r.level] || ["", r.level]; + return `
[${txt}] ${esc(r.step)}:${esc(r.msg)}
`; + }).join(""); +} + +function diffHtml(text) { + return text.split("\n").map((l) => { + const cls = l.startsWith("+++") || l.startsWith("---") || l.startsWith("@@") ? "h" : l.startsWith("+") ? "a" : l.startsWith("-") ? "d" : ""; + return cls ? `${esc(l)}` : esc(l); + }).join("\n"); +} + +function renderPlan(d) { + const plan = d.plan || []; + $("plan").innerHTML = d.ok === false + ? `

有错误,不能写入(见上面的报告)。

` + : plan.length + ? `

将修改 ${plan.length} 个文件:

` + plan.map((p) => `
${p.kind === "create" ? "新建" : "修改"} ${esc(p.path)}
${diffHtml(p.diff)}
`).join("") + : `

已经和选择一致,无需修改。

`; + $("apply").disabled = d.ok === false || !plan.length; +} + +// ---------- 动作 ---------- + +async function fixIoc(plan) { + const ids = [...document.querySelectorAll(".fix:checked")].map((el) => el.dataset.id); + if (!ids.length) return alert("没有勾选要修改的项"); + if (!plan && !confirm(`修改 .ioc 里的 ${ids.length} 项(原文件会备份)${$("regenerate").checked ? ",并用 CubeMX 重新生成工程(关掉桌面上的 CubeMX)" : ""}?`)) return; + const out = $("fix-out"); + out.classList.remove("hidden"); + out.textContent = plan ? "计算中…" : "修改中…(CubeMX 重新生成可能要几十秒)"; + const r = await post("/api/fix-ioc", { ids, plan, regenerate: !plan && $("regenerate").checked, cubemx: $("cubemx").value.trim() || undefined, ioc: opts().ioc, selection: state.selection }); + if (r.fatal) { out.textContent = r.fatal; return; } + const lines = (r.report || []).map((x) => `[${(LEVEL[x.level] || ["", x.level])[1]}] ${x.step}:${x.msg}`).join("\n"); + out.innerHTML = esc(lines) + (r.ioc_diff ? "\n\n" + diffHtml(r.ioc_diff) : "") + (r.cubemx_output ? "\n\nCubeMX 输出:\n" + esc(r.cubemx_output) : ""); + if (!plan) scan(); +} + +async function apply() { + if (!confirm("把预览里的修改写入宿主工程?")) return; + const r = await post("/api/apply", { ...opts(), selection: state.selection, overwrite_edited: $("overwrite").checked }); + const out = $("apply-out"); + if (r.fatal) { out.innerHTML = `

${esc(r.fatal)}

`; return; } + out.innerHTML = r.applied ? `

已写入。下一步:cmake --preset Debug && cmake --build --preset Debug

` : `

没有写入(见报告)。

`; + state.data = r; + if (r.selection) state.selection = r.selection; + render(); + setTimeout(scan, 300); +} + +async function init() { + const info = await (await fetch("/api/info")).json(); + state.info = info; + if (!info.python.ok) banner(info.python.error); + else if (!info.hostOk) banner(`${info.host} 不是宿主工程根目录(没有 CMakeLists.txt):用 --host 重新启动服务`); + for (const id of ["board_dir", "app_dir", "ioc", "no_vscode", "no_clang"]) $(id).addEventListener("change", rescanSoon); + $("rescan").onclick = scan; + $("fix-preview").onclick = () => fixIoc(true); + $("fix-apply").onclick = () => fixIoc(false); + $("apply").onclick = apply; + // 第一次不带选择:拿到存档(icbsp_selection.json)或默认选择;再带着它扫一次,预览里才有生成区的变化 + if (info.python.ok && info.hostOk) scan().then(() => state.selection && scan()); +} + +init(); diff --git a/tools/web_ui/index.html b/tools/web_ui/index.html new file mode 100644 index 0000000..7fcd96e --- /dev/null +++ b/tools/web_ui/index.html @@ -0,0 +1,102 @@ + + + + + +ICBSP 接入帮助 + + + +
+

ICBSP 接入帮助

+

按 CubeMX 的 .ioc 校验配置、生成板级实例与设备。接入逻辑在 tools/integrate.py,这个页面只负责展示和收集选择。

+
+ + + + +
+
+

工程

+
读取中…
+
+ + + +
+
+ + + +
+
+ +
+

CubeMX 配置校验

+
+
+ + + + +
+ +
+ +
+

外设

+

每个选中的外设生成一个库实例(如 FDCAN1 → bsp_can1)。PWM / 编码器默认不选。

+
+
+
+ +
+

功能开关

+
+
+ +
+

外置 Flash

+

片内 Flash 不够时把程序放到 QUADSPI 外置 Flash:方案 A 由 bootloader 拷进 AXI SRAM 运行,方案 B 在 QSPI 上就地执行(XIP)。 + 日常切换用 CMake 预设 <类型>-Internal / -QspiRam / -QspiXip,这里选的是默认方式。

+
+
+ +
+

编译优化

+

生成 icbsp_optimization(...):追加在工具链文件的优化等级之后(GCC 以最后一个 -O 为准),不改 CubeMX 生成的文件。

+
+
+ +
+

工程文件

+
+
+ +
+

设备

+
+

添加设备

+
+
+ +
+

宿主现有的生成区

+
+
+ +
+

预览与写入

+
+
+
+ + +
+
+
+
+ + + + diff --git a/tools/web_ui/server.mjs b/tools/web_ui/server.mjs new file mode 100644 index 0000000..b45ceda --- /dev/null +++ b/tools/web_ui/server.mjs @@ -0,0 +1,186 @@ +#!/usr/bin/env node +// ICBSP 接入帮助的 Web 前端:只做展示和收集选择,接入逻辑全在 tools/integrate.py(经 --json 调用)。 +// 零依赖:只用 Node 自带模块,不需要 npm install。 +// +// node third_party/icbsp/tools/web_ui/server.mjs [--host <宿主工程根目录>] [--port 8765] [--python ] +// +// 只监听 127.0.0.1。找不到 Python(>= 3.8)时页面上会给出提示。 + +import { createServer } from "node:http"; +import { spawnSync, spawn } from "node:child_process"; +import { readFile, writeFile, mkdtemp, rm } from "node:fs/promises"; +import { existsSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join, dirname, resolve, extname } from "node:path"; +import { fileURLToPath } from "node:url"; + +const HERE = dirname(fileURLToPath(import.meta.url)); +const INTEGRATE = resolve(HERE, "..", "integrate.py"); +const LIB_ROOT = resolve(HERE, "..", ".."); +const MIN_PY = [3, 8]; + +function arg(name, def) { + const i = process.argv.indexOf(name); + return i > 0 && i + 1 < process.argv.length ? process.argv[i + 1] : def; +} + +// ---------- Python ---------- + +function findPython() { + const tries = []; + if (arg("--python")) tries.push([arg("--python")]); + if (process.env.ICBSP_PYTHON) tries.push([process.env.ICBSP_PYTHON]); + tries.push(["python3"], ["python"]); + if (process.platform === "win32") tries.push(["py", "-3"]); + for (const cmd of tries) { + const r = spawnSync(cmd[0], [...cmd.slice(1), "-c", "import sys;print('%d.%d' % sys.version_info[:2])"], { encoding: "utf-8" }); + if (r.status === 0) { + const [ma, mi] = r.stdout.trim().split(".").map(Number); + const ok = ma > MIN_PY[0] || (ma === MIN_PY[0] && mi >= MIN_PY[1]); + return { cmd, version: r.stdout.trim(), ok, error: ok ? "" : `Python ${r.stdout.trim()} 太旧,需要 ${MIN_PY.join(".")} 及以上` }; + } + } + return { cmd: null, version: null, ok: false, error: "找不到 Python(试过 --python、环境变量 ICBSP_PYTHON、python3、python):安装 Python 3.8+,或用 --python 指定" }; +} + +const PY = findPython(); +const HOST = resolve(arg("--host", defaultHost())); +const PORT = Number(arg("--port", "8765")); + +function defaultHost() { + // 本库作为 submodule 时,宿主是 git superproject;否则当前目录 + const r = spawnSync("git", ["-C", LIB_ROOT, "rev-parse", "--show-superproject-working-tree"], { encoding: "utf-8" }); + const out = (r.stdout || "").trim(); + return out || process.cwd(); +} + +// ---------- 调 integrate.py ---------- + +let busy = false; + +async function integrate(extra, selection) { + if (!PY.ok) return { status: 500, body: { ok: false, fatal: PY.error } }; + if (busy) return { status: 409, body: { ok: false, fatal: "上一个请求还在运行(CubeMX 重新生成可能要几十秒)" } }; + busy = true; + let dir = null; + try { + const args = [...PY.cmd.slice(1), INTEGRATE, "--host", HOST, "--json", ...extra]; + if (selection) { + dir = await mkdtemp(join(tmpdir(), "icbsp-ui-")); + const f = join(dir, "selection.json"); + await writeFile(f, JSON.stringify(selection), "utf-8"); + args.push("--apply", f); + } + const { code, stdout, stderr } = await run(PY.cmd[0], args); + try { + const body = JSON.parse(stdout); + return { status: 200, body }; + } catch { + return { status: 500, body: { ok: false, fatal: `integrate.py 没有输出 JSON(退出码 ${code})`, stderr: stderr.slice(-4000), stdout: stdout.slice(-4000) } }; + } + } finally { + busy = false; + if (dir) await rm(dir, { recursive: true, force: true }); + } +} + +function run(cmd, args) { + return new Promise((res) => { + const p = spawn(cmd, args, { cwd: HOST }); + let stdout = "", stderr = ""; + p.stdout.on("data", (d) => (stdout += d)); + p.stderr.on("data", (d) => (stderr += d)); + p.on("close", (code) => res({ code, stdout, stderr })); + p.on("error", (e) => res({ code: -1, stdout, stderr: String(e) })); + }); +} + +function commonArgs(b) { + const a = []; + if (b.board_dir) a.push("--board-dir", String(b.board_dir)); + if (b.app_dir) a.push("--app-dir", String(b.app_dir)); + if (b.ioc) a.push("--ioc", String(b.ioc)); + if (b.no_vscode) a.push("--no-vscode"); + if (b.no_flash) a.push("--no-flash"); + if (b.no_clang) a.push("--no-clang"); + return a; +} + +// ---------- HTTP ---------- + +const STATIC = { "/": "index.html", "/index.html": "index.html", "/app.js": "app.js", "/style.css": "style.css" }; +const TYPES = { ".html": "text/html; charset=utf-8", ".js": "text/javascript; charset=utf-8", ".css": "text/css; charset=utf-8" }; + +function readBody(req, limit = 1 << 20) { + return new Promise((res, rej) => { + let n = 0; + const chunks = []; + req.on("data", (c) => { + n += c.length; + if (n > limit) { + rej(new Error("请求太大")); + req.destroy(); + } else chunks.push(c); + }); + req.on("end", () => { + try { + res(chunks.length ? JSON.parse(Buffer.concat(chunks).toString("utf-8")) : {}); + } catch (e) { + rej(e); + } + }); + }); +} + +function send(res, status, body) { + res.writeHead(status, { "Content-Type": "application/json; charset=utf-8", "Cache-Control": "no-store" }); + res.end(JSON.stringify(body)); +} + +const server = createServer(async (req, res) => { + try { + const url = new URL(req.url, "http://127.0.0.1"); + if (req.method === "GET" && STATIC[url.pathname]) { + const f = join(HERE, STATIC[url.pathname]); + res.writeHead(200, { "Content-Type": TYPES[extname(f)], "Cache-Control": "no-store" }); + res.end(await readFile(f)); + return; + } + if (req.method === "GET" && url.pathname === "/api/info") { + return send(res, 200, { host: HOST, library: LIB_ROOT, python: PY, hostOk: existsSync(join(HOST, "CMakeLists.txt")) }); + } + if (req.method === "POST" && url.pathname.startsWith("/api/")) { + const b = await readBody(req); + let r; + if (url.pathname === "/api/scan") { + // 只算不写:检查、候选、设备目录、diff 预览 + r = await integrate(["--plan", ...commonArgs(b)], b.selection || null); + } else if (url.pathname === "/api/apply") { + if (!b.selection) return send(res, 400, { ok: false, fatal: "缺少 selection" }); + const extra = [...commonArgs(b)]; + if (b.overwrite_edited) extra.push("--overwrite-edited"); + r = await integrate(extra, b.selection); + } else if (url.pathname === "/api/fix-ioc") { + const ids = Array.isArray(b.ids) && b.ids.length ? b.ids.join(",") : "all"; + const extra = ["--fix-ioc", ids]; + if (b.regenerate) extra.push("--regenerate"); + if (b.cubemx) extra.push("--cubemx", String(b.cubemx)); + if (b.plan) extra.push("--plan"); + if (b.ioc) extra.push("--ioc", String(b.ioc)); + r = await integrate(extra, b.selection || null); + } else { + return send(res, 404, { ok: false, fatal: "没有这个接口" }); + } + return send(res, r.status, r.body); + } + send(res, 404, { ok: false, fatal: "没有这个页面" }); + } catch (e) { + send(res, 500, { ok: false, fatal: String(e && e.message ? e.message : e) }); + } +}); + +server.listen(PORT, "127.0.0.1", () => { + console.log(`ICBSP 接入帮助:http://127.0.0.1:${PORT}/`); + console.log(`宿主工程:${HOST}`); + console.log(PY.ok ? `Python:${PY.cmd.join(" ")}(${PY.version})` : `【注意】${PY.error}`); +}); diff --git a/tools/web_ui/style.css b/tools/web_ui/style.css new file mode 100644 index 0000000..c8b474f --- /dev/null +++ b/tools/web_ui/style.css @@ -0,0 +1,46 @@ +:root { + --bg: #f7f8fa; --panel: #ffffff; --ink: #1f2933; --muted: #5f6b7a; --line: #d9dee5; + --ok: #1e7f4f; --warn: #a15c00; --err: #b42318; --accent: #2f5fb3; --add: #e8f5ec; --del: #fdecec; +} +@media (prefers-color-scheme: dark) { + :root { + --bg: #15181d; --panel: #1d2128; --ink: #e6e9ee; --muted: #9aa4b2; --line: #333a44; + --ok: #4cc38a; --warn: #f0b35a; --err: #ff7b72; --accent: #7aa2f7; --add: #183424; --del: #3a1d1d; + } +} +* { box-sizing: border-box; } +body { margin: 0; background: var(--bg); color: var(--ink); font: 14px/1.5 system-ui, "Noto Sans CJK SC", "Microsoft YaHei", sans-serif; } +header { padding: 20px 24px 8px; } +h1 { margin: 0; font-size: 22px; } +h2 { margin: 0 0 10px; font-size: 17px; } +h3 { margin: 16px 0 8px; font-size: 15px; } +.sub, .muted { color: var(--muted); } +main { padding: 0 24px 40px; display: grid; gap: 16px; max-width: 1200px; } +section { background: var(--panel); border: 1px solid var(--line); border-radius: 8px; padding: 16px; overflow-x: auto; } +.row { display: flex; flex-wrap: wrap; gap: 12px; align-items: center; margin-top: 10px; } +input, select, button { font: inherit; color: inherit; background: var(--bg); border: 1px solid var(--line); border-radius: 5px; padding: 4px 8px; } +input[type=number] { width: 9em; } +input[type=checkbox] { padding: 0; } +button { cursor: pointer; background: var(--panel); } +button.primary { background: var(--accent); border-color: var(--accent); color: #fff; } +button.warn { border-color: var(--warn); color: var(--warn); } +button:disabled { opacity: .5; cursor: not-allowed; } +table { border-collapse: collapse; width: 100%; } +th, td { text-align: left; padding: 5px 8px; border-bottom: 1px solid var(--line); vertical-align: top; } +th { color: var(--muted); font-weight: 600; white-space: nowrap; } +code, pre { font-family: ui-monospace, "JetBrains Mono", Consolas, monospace; font-size: 12.5px; } +.ok { color: var(--ok); } .warn-t { color: var(--warn); } .err { color: var(--err); } +.banner { margin: 0 24px 16px; padding: 10px 14px; border-radius: 6px; border: 1px solid var(--err); color: var(--err); background: var(--panel); } +.banner.info { border-color: var(--accent); color: var(--ink); } +.banner.info b { color: var(--accent); } +.banner.info button { margin: 6px 8px 0 0; } +.opt-grid { display: grid; grid-template-columns: max-content 1fr; gap: 6px 14px; align-items: center; margin-top: 8px; } +.layouts label { display: block; margin: 4px 0; } +.hidden { display: none; } +.diff { white-space: pre; overflow-x: auto; background: var(--bg); border: 1px solid var(--line); border-radius: 6px; padding: 8px; max-height: 420px; } +.diff .a { background: var(--add); display: block; } .diff .d { background: var(--del); display: block; } .diff .h { color: var(--muted); display: block; } +details { margin: 6px 0; } summary { cursor: pointer; } +.params { display: flex; flex-wrap: wrap; gap: 6px 14px; } +.params label { white-space: nowrap; } +.tag { display: inline-block; padding: 0 6px; border-radius: 4px; border: 1px solid var(--line); color: var(--muted); font-size: 12px; } +.card { border: 1px solid var(--line); border-radius: 6px; padding: 10px; margin: 8px 0; } diff --git a/undo.md b/undo.md index eb971d4..6782b9a 100644 --- a/undo.md +++ b/undo.md @@ -129,57 +129,129 @@ ## 阶段 2:加入新功能 -- [ ] 改名 **ICBSP**(Q15):仓库名、CMake 目标 `icbsp`、配置宏 / 开关加 `ICBSP_` 前缀、文档前缀、`LICENSE` 版权人 INVC & CUBOT -- [ ] 目录重排(Q13):`code/{bsp, service/{system,comm,monitor,definition}, device/{motor,sensor,remote,actuator}, algorithm, tasks}`,包含路径只加 `code/`(草案见对比评估 3.1) -- [ ] `examples/dm_mc02/Flash/README.md` 的经验(OpenOCD 0.12、不注册 OCTOSPI2 bank)补进 `templates/Flash` 和文档;README 的示例仓库链接先空着,阶段 6 再补(Q18) -- [ ] 配置检查(Q3):库内 `config_check.hpp`(范围 `static_assert` + 缺宏 `#error`),模板同步 -- [ ] 功能开关(Q4):放进 `hardware_config.h`,注释写清后果,依赖用 `static_assert` -- [ ] sys_task(Q5):10 ms;去掉开机 1 s 等待;`sys_task_stats`(DWT 计时)+ 可选回调;`CAN_BUSOFF_RETRY_MS` 等按 10 ms 粒度检查 -- [ ] EventState 默认树(Q6):`sys_state` → BSP 实例 → 设备;子节点错误只置父错误位、不清 RUNNING;照搬 fork 81 条判据并补建树用例 -- [ ] 命名统一(Q10):GPIO / Key / PWM 改名;编码规范写入“查询 `get_`、布尔 `is_` / `has_`”并扫一遍全部接口(GPIO 改回 `get_port/get_pin`) -- [ ] 编码器进核心库 `bsp/bsp_encoder`(Q11 更正),补 `HAL_TIM_MODULE_ENABLED` 保护 -- [ ] 设备并入核心(Q12 / Q17):DeviceMotor(`device/motor/`)、DeviceServo、DeviceR9dsT(加 `snapshot()`;诊断计数改 `uint32_t`,N34)、DeviceEmmv5GroupT(去掉写死的 128 字节串口缓冲尺寸;N33:`get_position/get_status` 改名 `take_`、超时统一 `ms_to_ticks()`、校验方式可配) -- [ ] **dm_motor(达妙)新写**:MIT / 位置速度 / 速度模式;使能、失能、清错误、设零点;反馈解包(ID、错误码、位置、速度、扭矩、温度);`P_MAX` / `V_MAX` / `T_MAX` 可配;Online、`snapshot()`;接口风格对齐 DjiMotor -- [ ] DR16 接收机(DT7 遥控器,DBUS) -- [ ] ET08 接收机 -- [ ] 保留 fork 已有的:UART 七项(Q8)、CAN 三项(Q9)、Online ms + `is_online`(Q7)、DWT(Q11)、`can_tx_task` 按需创建(C10)、QuaternionPID 拆文件、PID `get()`;Matrix `_data` 改回 private + `friend` -- [ ] 每加一项都补 HAL 模块保护(N24),对照附录 B 核对 N1~N37 +- [x] 改名 **ICBSP**(Q15):仓库名、CMake 目标 `icbsp`、配置宏 / 开关加 `ICBSP_` 前缀、文档前缀、`LICENSE` 版权人 INVC & CUBOT + - 2026-11-06:CMake 目标 `icbsp`;宿主提供的配置宏、功能开关、实例清单(`ICBSP_CAN/UART/SPI_INSTANCES`)和系列宏(`ICBSP_SERIES_H7/F4`、`ICBSP_CAN_MODULE_ENABLED`、`ICBSP_UART_HAS_FIFO`)加前缀;README / 文档 / integrate.py / 模板改名,`LICENSE` 版权人 INVC & CUBOT。类名(`BspUartT` 等)与头文件保护宏不改。历史记录(`docs/bsp_test/`、对比评估、评审、F4 移植计划)保持原文。**GitHub 仓库改名(stm32-framework → ICBSP)要在网页上做**,做完宿主 `.gitmodules` 的 url 跟着改 +- [x] 目录重排(Q13):`code/{bsp, service/{system,comm,monitor,definition}, device/{motor,sensor,remote,actuator}, algorithm, tasks}`,包含路径只加 `code/`(草案见对比评估 3.1) + - 2026-11-06(分支 `phase2`):按草案 `git mv`,`protocol/emmv5_protocol` 并进 `device/motor/`;包含语句全部写成 `"bsp/bsp_uart.hpp"` 形式(库、模板、宿主 `app/`)。bsp 改为只包含 `service/system/status_code.hpp`(原来经 `status.hpp` 间接带进 FreeRTOS 事件组),它是唯一允许各层包含的公共头;新增 `tools/check_layers.py` 检查分层。文档只改了目录描述,按新目录重写留到阶段 4 +- [x] `examples/dm_mc02/Flash/README.md` 的经验(OpenOCD 0.12、不注册 OCTOSPI2 bank)补进 `templates/Flash` 和文档;README 的示例仓库链接先空着,阶段 6 再补(Q18) + - 2026-11-06:`daplink.cfg` / `jlink.cfg` 注明不注册外置 Flash bank、HID 后端(注释掉,按探针打开);四个脚本支持 `OPENOCD` 环境变量,`.sh` 检测到 0.11 及以下时提示;`templates/Flash/README.md` 加实测经验(含烧录 CRC 造成的假 HardFault),接入指南常见问题加三条。README 没有示例仓库链接(保持空) +- [x] 配置检查(Q3):库内 `config_check.hpp`(范围 `static_assert` + 缺宏 `#error`),模板同步 + - 2026-11-06:`code/service/system/config_check.hpp` 是库读配置的唯一入口(库内不再直接包含 `hardware_config.h`),依次做缺宏 `#error`(21 个宏)→ HAL 模块没开时强制关开关 → 开关依赖 → 取值范围;`system.cpp` / `device_bmi088.cpp` 里零散的检查、`bsp_can` / `bsp_fdcan` / `can_tx_node` 里的缺宏检查并进来。模板删掉了检查段,宿主 `Core/Inc/hardware_config.h` 按模板重新同步。反向测试:缺宏、非法值、依赖不满足、关 CAN 发送后包含 DjiMotor 都会报错 +- [x] 功能开关(Q4):放进 `hardware_config.h`,注释写清后果,依赖用 `static_assert` + - 2026-11-06:模板里四个开关逐个写明关掉之后失去什么;依赖:`ICBSP_UART_PATROL_ENABLE` 需要 `ICBSP_SYS_TASK_ENABLE`(static_assert),DjiMotor 需要 CAN 收发都开(开了 CAN 外设却关了任一路径时 `#error`,没开 CAN 外设仍是空头文件) +- [x] sys_task(Q5):10 ms;去掉开机 1 s 等待;`sys_task_stats`(DWT 计时)+ 可选回调;`CAN_BUSOFF_RETRY_MS` 等按 10 ms 粒度检查 + - 10 ms、`sys_task_stats` + `system_set_report_hook()`、`ICBSP_CAN_BUSOFF_RETRY_MS ≥ 10` 在 1.3 / 1.4 已做;2026-11-06 去掉开机 1 s 等待;串口发送卡死阈值(一包耗时 × 2)加下限 10 ms(= 巡检周期;高波特率下阈值只有 1 tick 时,刚开始的传输可能被误判卡死并中止)。Online 的离线判定本来就按 ms,巡检周期只决定判定延迟,不用改 +- [x] EventState 默认树(Q6):`sys_state` → BSP 实例 → 设备;子节点错误只置父错误位、不清 RUNNING;照搬 fork 81 条判据并补建树用例 + - 2026-11-06:`service/system/state_tree.{hpp,cpp}`:`system_init()` 按三张实例清单给每个总线实例建节点挂到 `sys_state`,`system_start()` 进入运行态并记诊断计数基线;sys_task 每 10 ms `state_tree_poll()`,计数涨了就在总线节点记错(CAN / UART / SPI 的映射见头文件)。设备层:`Online::set_state()`,由在线变离线时在设备节点记 `TIMEOUT`;DjiMotor 有自己的节点(`get_state()`),init 失败改记在本节点(一路传到根)。其余设备(R9DS / Emm_V5 / BMI088)在 2.8 挂上来。宿主新增测试组 `test_state.cpp`:E01~E14 / O01~O11 按 fork 判据重建(E06 / E09 按 N16 之后的语义改了判据),T01~T04 测默认树;只验证编译,阶段 3 上板 +- [x] 命名统一(Q10):GPIO / Key / PWM 改名;编码规范写入“查询 `get_`、布尔 `is_` / `has_`”并扫一遍全部接口(GPIO 改回 `get_port/get_pin`) + - 2026-11-06:规则写进编码规范 2.1(查询 `get_`、布尔 `is_` / `has_` 且返回 bool、动作用动词、读硬件 `read_`、取走 `take_`;例外 `snapshot()`、数学值类型、`PID::get()`)。改名:GPIO `get_port/get_pin`、Key `is_pressed`、Encoder `get_position/is_initialized`、SPI `is_initialized/get_diag/get_handle/get_bus`、UART / CAN `get_handle`、DWT `is_initialized`、BMI088 `get_data/get_raw_data/get_temperature/get_last_status/is_attitude_ready/get_*_count`、DeviceMotor 全部查询、R9DS `get_rc/get_raw_channels/is_frame_lost/is_failsafe`、DjiMotor `get_data/get_raw_data/get_param/get_online/get_lvbo_data/get_status/unpack/fill_data`、CanTxNode `fill_data`、EventState `is_running/get_error_code/get_error_bits`、PID `get_nonfinite_count`、RLS 计数、emmv5 Frame `is_valid`。`Online::is_online()` 改返回 bool(原来返回 Status,`if (x.is_online())` 在离线时成立)。Emm_V5 组的改名随 2.8 的 N33 一起做。宿主新增 `app/compile_probe.cpp` 显式实例化 DjiMotor / R9DS / Emm_V5 / CAN 节点 / RLS,没用到的模板也参与编译 + - I5:`ImuData::gyro` 改 `x / y / z`(本体系);欧拉角度 / 弧度两份**保留**(度给人看、调参,弧度给控制,删一份反而要调用方自己换算);字段仍是 double(VQF 是 double) + - I6:`PI` 宏(两处,float 精度)删除,换成 `ICBSP_PI` / `ICBSP_PI_F`(`algorithm/math_constants.hpp`,原 `PI_D` 并入);`MotorType` 改 `enum class DjiMotorType { M3508, GM6020, M2006 }`;PID 的 `_input` / `_output` 改私有;`DataUnpack` / `FillData` / `lvboData` / `statu` / `isOnline` 都已改。**没做**:`Vector3` / `Quaternion` 等全局名字没放进命名空间(影响面太大,留到需要时再议);`BspCanT` 的 `trigger_tx_from_isr()` / `process_fifo0_isr()` 仍是 public(HAL 回调要调,改成私有要加 friend) + - I7:发送槽位冲突从 `FULL` 改报 `BUSY`(分配失败本来就是 `FULL`,fork 已改);PID 的 virtual / `print()` fork 已删;`BspPwm::set_freq()` 已返回 `Status`(1.4 F10)。**没做**:DjiMotor 接收节点注册失败仍报 `IO_ERROR`(注册器已在 sys_state 上记了具体原因,DjiMotor 拿不到);`BspPwm::set_duty()` / `DeviceBuzzer` 仍返回 void(只是写寄存器,没有失败路径) +- [x] 编码器进核心库 `bsp/bsp_encoder`(Q11 更正),补 `HAL_TIM_MODULE_ENABLED` 保护 + - 已在核心库(`code/bsp/bsp_encoder`),`HAL_TIM_MODULE_ENABLED` 保护 1.3(N24)已补;2.7 改名 `get_position()` / `is_initialized()` +- [x] 设备并入核心(Q12 / Q17):DeviceMotor(`device/motor/`)、DeviceServo、DeviceR9dsT(加 `snapshot()`;诊断计数改 `uint32_t`,N34)、DeviceEmmv5GroupT(去掉写死的 128 字节串口缓冲尺寸;N33:`get_position/get_status` 改名 `take_`、超时统一 `ms_to_ticks()`、校验方式可配) + - 2026-11-06:DeviceMotor / DeviceEmmv5GroupT 在 `device/motor/`、DeviceServo 在 `device/actuator/`、DeviceR9dsT 在 `device/remote/`(2.1);HAL 保护 1.3 已补;R9DS 的 `snapshot()` 与 N34 在 1.4 已做 + - Emm_V5:帧缓冲跟随 `Uart::TX_CAPACITY`(`BspUartT` 新增公开常量 `TX_CAPACITY` / `RX_CAPACITY`),缓冲太小 `static_assert`;N33 ① `take_position()` / `take_status()` / `take_in_position()`,`in_position()` → `is_in_position()`,`last_multi_frame()` → `get_last_multi_frame()`;② 三处 `send()` 不再把 tick 当毫秒传;③ `lock_bus()` 用 `uart_detail::ms_to_ticks()`;④ `Config::checksum`(`emmv5::Checksum::FIXED_6B` / `XOR`,命令按配置封口,XOR 模式下回复帧 0x6B 和 XOR 都接受)。**XOR 未实测;CRC-8 没做**(说明书 Rev1.3 只说“前面全部字节进行 CRC-8 计算”,没有多项式 / 初值 / 示例帧,见待排期) + - 默认树第三层(Q6):Emm_V5 组、R9DS、BMI088 也各有节点(`get_state()`),挂在所用总线下;DeviceMotor / Servo / Buzzer 不在总线上,没有节点 + - 宿主编译探针 `compile_probe.cpp` 用库的 `-Wextra -Wshadow` 编译,覆盖 Emm_V5 组 / R9DS 的全部成员 +- [x] **dm_motor(达妙)新写**:MIT / 位置速度 / 速度模式;使能、失能、清错误、设零点;反馈解包(ID、错误码、位置、速度、扭矩、温度);`P_MAX` / `V_MAX` / `T_MAX` 可配;Online、`snapshot()`;接口风格对齐 DjiMotor + - 2026-11-06:`code/device/motor/dm_motor.hpp`(`DmMotor`,只有头文件),协议按《DM-J4310-2EC V1.2 使用说明书》CAN 通信一章:MIT(`can_id`)、位置速度(`0x100+id`)、速度(`0x200+id`)、使能 / 失能 / 保存零点 / 清错误(`FF×7 + FC/FD/FE/FB`)、`switch_mode()`(`0x7FF` 写 CTRL_MODE),反馈解 ERR 状态、位置 / 速度 / 扭矩、MOS / 线圈温度;`P_MAX` / `V_MAX` / `T_MAX` 必填(说明书正文没给出厂默认值,不凭记忆填);Online、`snapshot()`、`get_state()`(默认树)。控制帧**不走 CanTxNodeT**(槽位过期清零 = MIT 满负扭矩),直接 `send_latest()`;命令帧 `send()`。只需要 CAN 接收路径(偏离 Q4 原文“收发都开”,因为不用发送节点)。主机侧抽出头文件里的映射 / 拼包 / 解包代码做了往返与边界测试;**只编译验证,未上板**(没有达妙电机)。力位混控模式(4)未做 +- DR16 / ET08 接收机:按 Q12 的回答不进 v1.0.0,2026-11-06 移到文末“待排期” +- [x] 保留 fork 已有的:UART 七项(Q8)、CAN 三项(Q9)、Online ms + `is_online`(Q7)、DWT(Q11)、`can_tx_task` 按需创建(C10)、QuaternionPID 拆文件、PID `get()`;Matrix `_data` 改回 private + `friend` + - 2026-11-06 核对都在:`uart_mode::it`、`UartDir`、RX / TX 尺寸分开、`hw_error_cnt`、`check_format()`、`deinit()`、`get_` 查询;`BspCanT`、TX-empty 动态开关、`HAL_FDCAN_ErrorStatusCallback`;Online 毫秒 + `is_online()`(2.7 起返回 bool);DWT;`can_tx_task` 按 `has_tx_nodes()` 创建;`quaternion_pid.*`;`PID::get()`。Matrix `_data` 改私有,不同尺寸互为友元(外部用 `data()` / `operator[]`) +- [x] 每加一项都补 HAL 模块保护(N24),对照附录 B 核对 N1~N37 + - 2026-11-06 编译矩阵(临时拷贝的工程、实例清单留空、只编库目标 `icbsp`):全开 / 只关 SPI / UART / FDCAN / TIM / 四个全关,0 error、0 warning;功能开关 `CAN_RX=0`、`CAN_TX=0`、两者都 0、`SYS=0 + PATROL=0`、`PATROL=0` 都 0 error / 0 warning,`SYS=0 + PATROL=1` 按设计报依赖错。顺带修了清单为空时 `*_is_listed()` / `bus_state()` 的未使用参数警告(1.3 之后才出现) + - 新代码对照附录 B:N9(Emm_V5 `lock_bus()` 改用 `ms_to_ticks()`)、N13(`bus_state()` 对清单外实例返回 nullptr,设备兜底挂 `sys_state`)、N16(默认树只置父错误位、不清运行位)、N24(上面的矩阵)、N33、N34(1.4)都满足;没有新增独占 HAL 回调(N30 不涉及) ## 阶段 3:功能全面测试 -- [ ] 主机侧单元测试:PID(F4、NaN)、四元数(F1、零模长)、Matrix、RLS,放进 CI -- [ ] 编译矩阵:功能开关 / HAL 模块(FDCAN、UART、SPI、TIM)逐个关,各组合 0 warning;`CAN_RX_ENABLE = 0` 时实际跑一次 `receive()`(N28) -- [ ] BSP 实板回归:`docs/bsp_test/` 的 UART / RS485 / CAN / SPI + BMI088 全部用例 + UART IT 模式,Debug 与 -O2 各一遍,加浸泡测试 -- [ ] DMA 循环模式专项测试(TIM8 = 15 不卡死);F2 短帧压力测试 -- [ ] Service:EventState 树(81 条 + 默认树传播 + 不清 RUNNING)、Online 毫秒语义、N16 回归、N13 回归(漏写实例时 `init()` 返回 `BAD_ARG`) -- [ ] 新功能实板:CAN TX-empty 动态开关(丢唤醒统计;先修 N27,再人为关一次中断,确认 `tx_stall_recover` 增加、总线恢复)、ErrorStatusCallback 计数、DWT(两个任务并发调 `get_time_s()`,跨 10 圈回绕不跳变)、编码器、N30 的转调钩子、R9DS / 舵机 / EmmV5 / dm_motor / DeviceMotor(没硬件的标“只编译验证”) -- [ ] 全程不打开 BMI088 加热电阻(PB1 / TIM3_CH4);结果按 `docs/bsp_test/` 的格式存档 +- [x] 主机侧单元测试:PID(F4、NaN)、四元数(F1、零模长)、Matrix、RLS,放进 CI + - 2026-11-06 `tests/host/`(45 条判据,主机编译器 `-Werror`)+ `.github/workflows/host-tests.yml`(同时跑 `check_layers.py`) +- [x] 编译矩阵:功能开关 / HAL 模块(FDCAN、UART、SPI、TIM)逐个关,各组合 0 warning;`CAN_RX_ENABLE = 0` 时实际跑一次 `receive()`(N28) + - 2026-11-06 宿主 `tools/compile_matrix.sh`,13 种配置全部符合预期;2026-11-07 实板 C12:不建接收节点时 `receive()` 按序收全,溢出丢新帧并计 `rx_dropped` +- [x] BSP 实板回归:`docs/bsp_test/` 的 UART / RS485 / CAN / SPI + BMI088 全部用例 + UART IT 模式,Debug 与 -O2 各一遍,加浸泡测试 + - 2026-11-06 ~ 07 两轮(宿主 `docs/bsp_test/phase3_2026-11-06.md`)。修了 `DeviceBmi088::delay_ms()`:`vTaskDelay(1)` 可能几乎不等,软复位后重读芯片 ID 偶发失败(P04 200 次里 48 次)。SPI 压力用例的不合理帧都是板子被碰 / 振动,SPI 层 0 错误 +- [x] DMA 循环模式专项测试(TIM8 = 15 不卡死);F2 短帧压力测试 + - 2026-11-07 **F2 短段压力完成**:宿主 U21(4 Mbps、1~4 字节 send()、3 个高优先级干扰任务,各 10 万字节),Debug / -O2 / IT 模式 0 重复 0 丢失。顺带发现并修了 `tx_recover()` 的“空闲补发”误报(巡检抢占写者落在“写缓冲区 → 拿锁启动”之间,两次都看到空闲却有数据):第二次观察要求期间没有任何启动;新增 `TxDiag::idle_kick_cnt` / `idle_kick_uart_err` / `idle_kick_dma_err` + - 2026-11-07 **DMA 循环模式专项完成**:宿主 U16~U20(回绕位置全覆盖、4 Mbps 1 MB 多圈连续流、IDLE 风暴、中断延迟容限、50 次中止 / 重挂恢复),Debug / -O2 / U10 IT 模式全部通过,HAL tick 正常、未卡死。U19 测出使用约束:串口 / RX DMA 中断被挡住超过收满半个 RX_SIZE 的时间会被 DMA 套圈、静默丢数据(库计数察觉不到),已写进 `bsp_uart.hpp` 文件头;检测手段记在“待排期” + - 2026-11-06 TIM8 = 15 部分完成:UART 组(含 U09~U12 故障注入、U14 浸泡)在 Debug / -O2 / IT 模式下都没有卡死。**F2 还没有专门的短帧压力用例**,只有间接覆盖(U02 全双工 8000 帧、U07 多写者、U14 30 万帧,序号校验 0 重复);补用例需要 U7 ⇄ U10 跳线 +- [x] Service:EventState 树(81 条 + 默认树传播 + 不清 RUNNING)、Online 毫秒语义、N16 回归、N13 回归(漏写实例时 `init()` 返回 `BAD_ARG`) + - 2026-11-06 实板 E01~E14 / O01~O11 / T01~T04 全部通过(Debug 与 -O2);N13 = 宿主 Y13(CAN / UART)+ S01(SPI) +- [x] 新功能实板:CAN TX-empty 动态开关(丢唤醒统计;先修 N27,再人为关一次中断,确认 `tx_stall_recover` 增加、总线恢复)、ErrorStatusCallback 计数、DWT(两个任务并发调 `get_time_s()`,跨 10 圈回绕不跳变)、编码器、N30 的转调钩子、R9DS / 舵机 / EmmV5 / dm_motor / DeviceMotor(没硬件的标“只编译验证”) + - 2026-11-06 C11:关 TX FIFO 空中断后 `tx_stall_recover` +1、积压帧全部补发、链路恢复;错误状态回调计到警告 / 被动。DWT:Y08 两个任务并发 10 s、跨 1 次回绕 0 倒退 / 0 跳变,没有专门跑满 10 圈(每轮实板 40 分钟以上、300 圈以上无异常)。N30:Y05。电机实板:M3508、GM6020(电流模式)、DM-J4340P(MIT)转动通过,J4310 只做反馈 / 寄存器读(ID 与 6020 冲突,不使能)。**只编译验证**:编码器、R9DS、舵机、Emm_V5、DeviceMotor +- [x] 全程不打开 BMI088 加热电阻(PB1 / TIM3_CH4);结果按 `docs/bsp_test/` 的格式存档 + - H00 / H99 与监视任务核对全部为 0;记录在宿主 `docs/bsp_test/phase3_2026-11-06.md` 与 `raw/2026-11-0[67]_phase3_*` ## 阶段 4:文档补全 -- [ ] 采用 fork 的文档结构(Q16),以 ICBSP 名字和新目录重写;`docs/code/` 跟随代码子目录,架构图用 `tools/draw_diagrams.py` 重画 -- [ ] 修掉 D2 和 N26 -- [ ] 修掉复核补进 N26 的不一致:README“每 2 s 打印”(实际 5 s)、`board_cfg.cpp` 头注释与示例(DWT 已由库初始化、舵机不是 CAN 设备、Emm_V5 不是达妙)、monitor“每秒”(实际 10 s)、`bsp_spi.cpp` 引用不存在的 `ms_to_ticks()`、`bsp_spi.hpp` 示例段名、`integrate.py` 收尾提示、`CAN_RX_NODE_MAX` 注释 -- [ ] 接入指南补齐:C++20;宿主两个文件的职责;宿主不能定义的 HAL 回调清单(含 `HAL_FDCAN_ErrorStatusCallback`)及 `icbsp_unhandled_*()` 转调(N30);编码器 ARR 要求(N37);FDCAN `MessageRAMOffset` / `StdFiltersNbr`;时基优先级的两条理由;newlib 锁;BDMA 外设限制 -- [ ] 功能开关逐个写明关掉之后的后果 -- [ ] 编码规范:`get_` / `is_` 规则、包含路径规则、C++20 规则(volatile、聚合体 Config、平凡析构)、`.dma_buffer` 宏 -- [ ] 每个模块如实标注“已实测 / 只编译验证”;`docs/bsp_test/` 注明对应的代码版本 -- [ ] 许可证说明(matrix 授权来源、VQF SPDX、厂商 PDF 去留) +- [x] 采用 fork 的文档结构(Q16),以 ICBSP 名字和新目录重写;`docs/code/` 跟随代码子目录,架构图用 `tools/draw_diagrams.py` 重画 + - 2026-11-07 `3c8ca7e`:README、docs/code 五层(device 按 motor / sensor / remote / actuator,protocol.md 并入 device.md)、依赖矩阵按 check_layers.py;draw_diagrams.py 重画分层图与启动图 +- [x] 修掉 D2 和 N26 + - 2026-11-07 `1492123`:7 处悬空文档引用、接入指南 CMSIS_V2 说法、编码规范旧分层与前缀;D2 其余条目已不存在 +- [x] 修掉复核补进 N26 的不一致:README“每 2 s 打印”(实际 5 s)、`board_cfg.cpp` 头注释与示例(DWT 已由库初始化、舵机不是 CAN 设备、Emm_V5 不是达妙)、monitor“每秒”(实际 10 s)、`bsp_spi.cpp` 引用不存在的 `ms_to_ticks()`、`bsp_spi.hpp` 示例段名、`integrate.py` 收尾提示、`CAN_RX_NODE_MAX` 注释 + - 2026-11-07 `d61090b`:board_cfg.cpp 模板、monitor 每 10 s、bsp_spi 的 ms_to_ticks 引用、NODE_MAX 说明;README / bsp_spi.hpp / integrate.py 三条之前已修 +- [x] 接入指南补齐:C++20;宿主两个文件的职责;宿主不能定义的 HAL 回调清单(含 `HAL_FDCAN_ErrorStatusCallback`)及 `icbsp_unhandled_*()` 转调(N30);编码器 ARR 要求(N37);FDCAN `MessageRAMOffset` / `StdFiltersNbr`;时基优先级的两条理由;newlib 锁;BDMA 外设限制 + - 2026-11-07 `c97bb88`:1.1 两个文件、1.2 回调清单与 icbsp_unhandled_*、2.3 时基两条理由与 HAL_Delay 注意事项、2.4 Message RAM / StdFiltersNbr、2.5 BDMA、2.7 编码器、2.10 newlib +- [x] 功能开关逐个写明关掉之后的后果 + - 2026-11-07 `f2e25a2`:模板注释 + 接入指南 4.2 汇总表 +- [x] 编码规范:`get_` / `is_` 规则、包含路径规则、C++20 规则(volatile、聚合体 Config、平凡析构)、`.dma_buffer` 宏 + - 2026-11-07 `b4d61a2`:第 4 节按现状重写,新增第 9 节 C++20、第 10 节 .dma_buffer;get_ / is_ 与包含路径阶段 2 已写 +- [x] 每个模块如实标注“已实测 / 只编译验证”;`docs/bsp_test/` 注明对应的代码版本 + - 2026-11-07 `ad098d4`:docs/code/README.md 实测状态表;bsp_test/README.md 记录 → 代码版本表,旧记录补版本说明 +- [x] 许可证说明(matrix 授权来源、VQF SPDX、厂商 PDF 去留) + - 2026-11-07:README 许可证一节(VQF SPDX、matrix 授权范围)、docs/sheet/README.md(厂商手册版权声明与官方渠道;按用户选择保留文件) ## 阶段 5:web_ui 接入帮助(Node.js 前端 + `integrate.py` 引擎,Q14 = A) -- [ ] `integrate.py` 合入 fork 扩展后加机器接口:`--json`(检查结果、外设、可挂设备)、`--plan` / `--dry-run`(diff)、`--apply <选择.json>` -- [ ] 库侧清单 `tools/manifest.json`(Python 读取):外设 → BSP 类、模板参数、必需的 CubeMX 设置;设备目录 → 依赖、参数、默认值、`init()` 顺序;校验规则 -- [ ] `.ioc` 校验:现有检查 + D1 缺的检查(`TICK_INT_PRIORITY < 5`、Message RAM 重叠、`StdFiltersNbr`、`MasterKeepIOState`、DMA 模式、D-Cache、NVIC、defaultTask As weak) -- [ ] 生成 `board_instances.hpp` + `board_cfg.hpp` 实例(can1 / can2 → `bsp_can1` / `bsp_can2`,参数取自 `.ioc`,自动套 `.dma_buffer` 宏)+ `init()` + `hardware_config.h`(开关按勾选生成) -- [ ] 可选设备:按外设列出可挂设备,勾选后生成实例、`init()`、回调转调;设备只在依赖的外设和开关都满足时出现;DR16 / ET08 标“计划中” -- [ ] 与宿主同步:只写生成区 / USER CODE 段,可重复运行,写盘前给 diff 预览,遇到手改内容就停下 -- [ ] Node 前端只做展示和收集选择,不复制接入逻辑;找不到 Python 时明确提示 -- [ ] 生成快照测试:MC02_with_submodule 的 `.ioc` + 一个全新工程,生成的代码 0 warning 编译 +- [x] `integrate.py` 合入 fork 扩展后加机器接口:`--json`(检查结果、外设、可挂设备)、`--plan` / `--dry-run`(diff)、`--apply <选择.json>` + - 2026-11-08 `fe4fa01`:--json(report、ioc_checks、candidates、selection、devices、generated、plan 的 diff)、--plan;--apply 在 `18a5d46` +- [x] 库侧清单 `tools/manifest.json`(Python 读取):外设 → BSP 类、模板参数、必需的 CubeMX 设置;设备目录 → 依赖、参数、默认值、`init()` 顺序;校验规则 + - 2026-11-08 `0fc979a`:外设 5 类、设备 8 种 + 计划中 2 种、开关、规则;manifest.py 自检占位符(CI) +- [x] `.ioc` 校验:现有检查 + D1 缺的检查(`TICK_INT_PRIORITY < 5`、Message RAM 重叠、`StdFiltersNbr`、`MasterKeepIOState`、DMA 模式、D-Cache、NVIC、defaultTask As weak) + - 2026-11-08 `8fd535a`:全局 + 外设规则,缺省键按 CubeMX 数据库默认值;时基优先级不再要求 < 5(1.4 起 15 即可,原文这条过时),新增 can_fifo(CubeMX 默认 FIFO / TX 元素数为 0) +- [x] `.ioc` 修改并重新生成功能: 当发现ioc校验未通过,可选择是否自动修改并重新生成工程 + - 2026-11-08 `0893c05`:--fix-ioc(先备份)、--regenerate(CubeMX 命令行,DM-MC02 拷贝上实测 31 s,结果与原工程一致) +- [x] 生成 `board_instances.hpp` + `board_cfg.hpp` 实例(can1 / can2 → `bsp_can1` / `bsp_can2`,参数取自 `.ioc`,自动套 `.dma_buffer` 宏)+ `init()` + `hardware_config.h`(开关按勾选生成) + - 2026-11-08 `432a085`:generate.py + 模板生成区(regions.py) +- [x] 可选设备:按外设列出可挂设备,勾选后生成实例、`init()`、回调转调;设备只在依赖的外设和开关都满足时出现;DR16 / ET08 标“计划中” + - 2026-11-08 `40b4a1a`:设备目录、实例 / extern / init / EXTI 转调;资源独占与参数校验 +- [x] 与宿主同步:只写生成区 / USER CODE 段,可重复运行,写盘前给 diff 预览,遇到手改内容就停下 + - 2026-11-08 `18a5d46`:只写生成区、哈希检测手改、区外冲突、diff 预览、可重复运行;选择存 icbsp_selection.json(`2f57793`) +- [x] Node 前端只做展示和收集选择,不复制接入逻辑;找不到 Python 时明确提示 + - 2026-11-08 `2f57793`:tools/web_ui(零依赖),找不到 Python 3.8+ 时提示;交互只在最小 DOM 里跑通,没在浏览器里实测 +- [x] 生成快照测试:MC02_with_submodule 的 `.ioc` + 一个全新工程,生成的代码 0 warning 编译 + - 2026-11-08 `690f230`:tools/tests(CI 13 项);compile_test.py 用 CubeMX 生成全新工程 + 从零接入 + 生成,两组用例 0 warning(另一个型号的全新工程留给阶段 6) ## 阶段 6:宿主接入回归测试 - [ ] 全新 CubeMX 工程:H723 + 至少一个其他型号(H743 / H750),分别用 `integrate.py` 和 Web UI 接入,0 warning(C++20),上板冒烟 +- [x] **小 Flash 型号的外置 Flash 支持**(2026-11-10,H750 回归宿主 `H750_FULL_TEST` 发现,阻塞上一条的 H750 部分) + - 2026-11-10 完成,三种存放方式 INTERNAL / QSPI_RAM(A)/ QSPI_XIP(B)用缓存变量 `ICBSP_FLASH_LAYOUT` 和预设 `*-Internal / *-QspiRam / *-QspiXip` 切换: + `cmake/icbsp_flash.cmake`、`templates/flash_layout/`、`boot/`(寄存器级 bootloader,A / B 共用)、`tools/qspi_image.py`、`Flash/daplink_qspi.cfg`、 + 烧录脚本按构建目录的存放方式烧;`integrate.py` 与 Web UI 加“外置 Flash”“编译优化”“工程文件(.gitignore)”。文档 `docs/外置Flash.md`, + 实测 `docs/bsp_test/external_flash_2026-11-10.md`。 + - 与原计划的出入:MPU 不改 `.ioc`(bootloader 用第 13~15 区,CubeMX 的 `MPU_Config()` 不碰);`.ioc` 的 QUADSPI 参数改由规则 `qspi_params` + (warn,可自动修改)负责;实测发现内存映射读芯片最后一个字会挂死总线,加了第 15 区(芯片末尾 4 KB 禁止访问)。 + - 顺带修掉:`templates/linker_sections.ld` 的 `__dma_buffer_load` 没算段内 `ALIGN(32)` 的偏移(`.dma_buffer` 不在 RAM 区开头时实例初值错位, + 方案 A 首次上板暴露);`integrate.py` 会把老宿主的这一行等价改写。 + - 现象:H750 片内 Flash 只有 128 KB,接入 ICBSP 后 Debug(-O0)占 180.6 KB,链接失败(超 48.4 KB)。-Og 占 117.1 KB、-Os 占 106.1 KB,能装下,但只剩 11~22 KB 余量;回归要求 Debug 和 -O2 都能编过,靠压代码量解决不了。-O0 的大头:HAL 65.6 KB、库 43.4 KB(`vqf.cpp` 14.5 KB)、FreeRTOS 20.0 KB、newlib + libm 21.5 KB + - 方案:片内 Flash 只放 bootloader(预计 8~16 KB),应用放到 QSPI Flash。应用有两种运行方式,bootloader、QSPI 驱动和烧写流程两者通用: + - **QSPI 存储 + AXI SRAM 运行(回归宿主首选)**:bootloader 把镜像从 QSPI 拷进 AXI SRAM(512 KB)再跳转。调试时 OpenOCD 直接把 ELF 下进 RAM,不用每轮都写 QSPI;全速执行,软件断点可用,时序和 H723 在片内 Flash 上运行时接近,回归数据可以对比。应用上限约 400 KB(要扣掉 `.dma_buffer` 和堆) + - **QSPI XIP(内存映射后直接执行)**:容量看 Flash 芯片(MB 级),适合大应用。代价:cache 未命中时变慢(-O0 下更明显);MPU 要把 0x90000000 起、超出芯片容量的地址设成不可访问,防止推测访问把总线卡死;只能打硬件断点,调试器还得注册外置 bank + - 芯片:**W25Q128**(16 MB),接在 Bank 2:PB2 CLK、PC11 NCS、PE7~PE10 IO0~IO3。参数:`FlashSize = 23`,3 字节地址;读用 `0xEB` Quad I/O,模式位加 dummy 共 6 个周期;目标频率 120 MHz(kernel 240 MHz 二分频,时钟上限 133 MHz,要实测,看情况开 `SampleShifting`);上电先查 SR2.QE,没置位就写上。擦除时间:4 KB 扇区典型 45 ms、最长 400 ms,64 KB 块最长 2 s + - [x] `.ioc` 里 QUADSPI 的占位值改成上面的参数(现在是 `FlashSize = 1`、预分频 255) + - **哪些代码放外置 Flash 可以选**,但只有 XIP / 混合放置才用得上;RAM 运行方案里代码都在 RAM,不存在这个选择: + - 前提:复位后在 `SystemInit()` 阶段,用寄存器级代码(不经过 HAL)打开 QSPI 内存映射。这样之后各模块放哪里只影响速度,不影响能不能跑。固定放片内的只有:向量表、启动代码、内存映射初始化、HardFault 等异常处理和 `fault_record`(QSPI 出故障时也要能留下记录) + - 选择的粒度:按库 / 目标文件(`*libm.a:*`、HAL 的 `.c`)最简单;按函数用属性宏(`ICBSP_FAST_CODE` → 片内或 ITCM)。BSP 和设备是 header-only 模板(I1 / N23),代码实例化在宿主的 `board_cfg.cpp` 等文件里,按文件分不开,只能按修饰名匹配(`*(.text._ZN*BspUart*)`)或者用属性宏 + - 硬约束:以后要往 W25Q128 写参数或日志,写 / 擦期间必须退出内存映射。这段时间里所有可能跑到的代码(包括**任意中断**)都不能在 QSPI 上,而一次擦除最长 2 s,不能靠关中断扛过去。混合放置会因此限制以后的存储功能;RAM 运行方案没有这个问题 + - 结论:回归宿主用 RAM 运行,不做放置选择;放置选择作为 XIP 版的可选项,由 `manifest.json` 记录模块 → 段匹配规则,`integrate.py` 生成链接脚本片段,再加一个链接后检查(扫 map,确认固定放片内的符号确实在片内) + - [x] `templates/` 加 bootloader 模板:初始化 QSPI 并切到内存映射;校验镜像(魔数、长度、CRC);跳转前 `HAL_RCC_DeInit()`、关中断、清掉挂起的中断(否则 PLL 还在用时,应用的 `SystemClock_Config()` 会失败) + - [x] 链接脚本模板出两版:RAM 运行版(代码和 `.data` 放 AXI SRAM,`.dma_buffer` 仍放在 DMA 能访问的区域)、XIP 版(FLASH 区起始 0x90000000)。应用侧通过 `USER_VECT_TAB_ADDRESS` 设置 `VTOR` + - [x] 应用不能再调 `MX_QUADSPI_Init()`(XIP 时会把正在执行的代码卡死),`integrate.py` 和 `.ioc` 校验里加这项检查 + - [x] 烧写:写 QSPI 用 OpenOCD `stmqspi` 的**单独配置文件**,日常用的 cfg 照旧不注册外置 bank(和 `templates/Flash/README.md` 里 MC02 的经验一致)。另外确认 EmberProbe `flash_program` 能不能写外置 Flash + - [x] `integrate.py` 遇到片内 Flash ≤ 128 KB 的型号(H750 / H7B0 / H730)时给出提示,并按用户选的运行方式生成上面这些文件 + - [x] 文档:接入指南加“小 Flash 型号”一节。本条做完之前,H750 回归先用 -Og 临时顶着 - [ ] 通过回归的 H723 测试宿主工程作为新的示例工程(Q18):整理后推到组织下,README 写上链接 - [ ] CubeMX 重新生成后再接入一次,确认幂等 - [ ] MC02_with_submodule 把 1.0 的分支合回 main,submodule 指向 ICBSP;更新宿主 `CLAUDE.md`(库路径 / 目录、回调清单加 ErrorStatusCallback、C++20、去掉 `examples/dm_mc02` 引用、烧录参照改 `templates/Flash`);跑阶段 3 的回归;clangd `--check` 0 诊断 @@ -193,3 +265,12 @@ - [ ] 打 tag `v1.0.0` + release notes(发布方 INVC & CUBOT;支持型号、已实测模块、已知限制) - [ ] 宿主更新 submodule 指针并提交;`STM32_BSP` 在 GitHub 上归档(Q19) +## 待排期(不进 v1.0.0) + +- [ ] DR16 接收机(DT7 遥控器,DBUS)设备驱动(Q12:放进待排期,不进 v1.0.0) +- [ ] ET08 接收机设备驱动(同上) +- [ ] UART 循环 DMA 被套圈的检测(阶段 3 U19):目前中断被挡住超过半圈时丢失无计数。可选做法:投递时用 DWT 记两次 `rx_drain()` 的间隔,超过 `RX_SIZE × 10 / 波特率` 记 `rx_lap_suspect`;或者开 TC 计数比对 +- [ ] 外置 Flash:OCTOSPI 后端(H723 / H730 / H7B0;可在 DM-MC02 的 OCTOSPI2 W25Q64 上实测),`flash.analyze` 现在只报“暂不支持” +- [ ] 外置 Flash:XIP 版的“哪些模块放片内 / ITCM”可选放置(manifest 记录模块 → 段匹配规则,integrate.py 生成链接脚本片段,链接后扫 map 校验) +- [ ] 外置 Flash:EmberProbe `flash_program` 只接受 interface / target 脚本,写不了 QSPI;需要它支持自定义 cfg(或 stmqspi bank)后才能用于外置方案 +- [ ] Emm_V5 的 CRC-8 校验:需要厂家给出多项式 / 初值 / 示例帧(或用上位机抓一帧反推)后再实现;XOR 模式上板实测