refactor(FOC): 添加Doxygen文档注释并优化SVPWM算法性能

添加了完整的Doxygen文档注释到FOC算法模块的所有函数、类和变量,提升了代码可读性和维护性。同时优化了SVPWM算法实现,将atan2f替换为符号法扇区判断,显著提升计算效率(约15周期vs atan2f 300周期),并改进了arm_sin_cos_f32替代sqrtf提高性能。

feat(FOC): 统一电气角度计算避免重复运算

重构代码以统一电气角度计算,在各个控制循环中只计算一次电气角度并传递给需要的函数,避免了多次重复的fmodf运算和角度归一化操作,提升了实时控制性能。

refactor(Filter): 改进α-β观测器角度处理精度

修改角度卡尔曼滤波器在归一化角度空间[0,360)内工作,避免大累积角度的浮点精度损失问题,确保静止状态下不会产生虚假速度,同时保持与下游代码的兼容性。

refactor: 为算法模块添加完整文档注释

为所有算法模块(FOC、Filter、pid、thermal)添加了详细的Doxygen文档注释,包括函数说明、参数描述、返回值说明等,便于代码理解和API文档生成。
This commit is contained in:
cbb
2026-05-23 22:46:32 +08:00
parent bec7c11b87
commit 4c4e47e9e3
62 changed files with 10367 additions and 126 deletions
+175 -1
View File
@@ -1,3 +1,9 @@
/**
* @file sys/config.h
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#ifndef __CONFIG_H
#define __CONFIG_H
#include "gd32c10x_eval.h"
@@ -6,41 +12,71 @@
// 如果使用 CMSIS DSP 库,需要定义 ARM_MATH_CM4
#define ARM_MATH_CM4
/** @brief EEP_DEBUG 宏定义 */
#define EEP_DEBUG 0
/** @brief OTA_DEBUG 宏定义 */
#define OTA_DEBUG 0
/** @brief SLEEP_DEBUG 宏定义 */
#define SLEEP_DEBUG 0
/** @brief ANG_SENS_DEBUG 宏定义 */
#define ANG_SENS_DEBUG 0
/** @brief CAN_DEBUG 宏定义 */
#define CAN_DEBUG 0
/** @brief MAIN_DEBUG 宏定义 */
#define MAIN_DEBUG 0
/** @brief FOC_DEBUG 宏定义 */
#define FOC_DEBUG 0
// 版本号定义 - 可根据实际项目进行调整
/** @brief SOFTWARE_VERSION_MAJOR 常量定义 */
constexpr u16 SOFTWARE_VERSION_MAJOR = 26;
/** @brief SOFTWARE_VERSION_MINOR 常量定义 */
constexpr u16 SOFTWARE_VERSION_MINOR = 5;
/** @brief SOFTWARE_VERSION_PATCH 常量定义 */
constexpr u16 SOFTWARE_VERSION_PATCH = 19;
/** @brief SOFTWARE_VERSION_BUILD 常量定义 */
constexpr u16 SOFTWARE_VERSION_BUILD = 2;
/** @brief HARDWARE_VERSION_MAJOR 常量定义 */
constexpr u16 HARDWARE_VERSION_MAJOR = 25;
/** @brief HARDWARE_VERSION_MINOR 常量定义 */
constexpr u16 HARDWARE_VERSION_MINOR = 12;
/** @brief HARDWARE_VERSION_PATCH 常量定义 */
constexpr u16 HARDWARE_VERSION_PATCH = 01;
/** @brief HARDWARE_VERSION_BUILD 常量定义 */
constexpr u16 HARDWARE_VERSION_BUILD = 0;
/** @brief BOOT_VERSION_MAJOR 常量定义 */
constexpr u16 BOOT_VERSION_MAJOR = 26;
/** @brief BOOT_VERSION_MINOR 常量定义 */
constexpr u16 BOOT_VERSION_MINOR = 1;
/** @brief BOOT_VERSION_PATCH 常量定义 */
constexpr u16 BOOT_VERSION_PATCH = 12;
/** @brief BOOT_VERSION_BUILD 常量定义 */
constexpr u16 BOOT_VERSION_BUILD = 0;
// Flash 分区配置
/** @brief BOOTLOADER_SIZE 常量定义 */
constexpr u32 BOOTLOADER_SIZE = 0x6000; // 24KB
/** @brief BOOTLOADER_START_ADDR 常量定义 */
constexpr u32 BOOTLOADER_START_ADDR = 0x08000000; // BOOT 起始地址
/** @brief APPLATEST_START_ADDR 常量定义 */
constexpr u32 APPLATEST_START_ADDR = 0x08012000; // APP 起始地址
/** @brief APPBACK_START_ADDR 常量定义 */
constexpr u32 APPBACK_START_ADDR = 0x08006000; // APPBACK 起始地址
/** @brief APP_MAX_SIZE 常量定义 */
constexpr u32 APP_MAX_SIZE = 0xC000; // 48KB
/** @brief FMC_PAGE_SIZE 常量定义 */
constexpr u32 FMC_PAGE_SIZE = 0x400; // 1KB
/** @brief SLEEP_CONFIG_START 常量定义 */
constexpr u32 SLEEP_CONFIG_START = 0x0801E400; // 睡眠配置起始地址
/** @brief SLEEP_CONFIG_END 常量定义 */
constexpr u32 SLEEP_CONFIG_END = 0x0801E800; // 睡眠配置结束地址
/** @brief FLASH_EMPTY 常量定义 */
constexpr u32 FLASH_EMPTY = 0xFFFFFFFF; // 空数据
/** @brief SLEEP_ENABLE 常量定义 */
constexpr u32 SLEEP_ENABLE = 0x11111111; // 睡眠使能
/** @brief SLEEP_DISABLE 常量定义 */
constexpr u32 SLEEP_DISABLE = 0x00000000; // 睡眠禁止
// 节点 ID 配置 (用于多电机 CAN 总线隔离)
@@ -52,12 +88,19 @@ constexpr u32 SLEEP_DISABLE = 0x00000000; // 睡眠禁止
// - 采用双重备份机制 (主备份 + 备用备份)
// - 使用魔数 (NODE_ID_MAGIC) 验证数据有效性,防止位翻转导致错读
// - 使用写入计数器区分最新数据
/** @brief NODE_ID_PAGE_ADDR 常量定义 */
constexpr u32 NODE_ID_PAGE_ADDR = 0x0801E800; // 节点 ID 存储页 (1KB,独立区域)
/** @brief NODE_ID_PRIMARY_ADDR 常量定义 */
constexpr u32 NODE_ID_PRIMARY_ADDR = 0x0801E800; // 主存储地址
/** @brief NODE_ID_BACKUP_ADDR 常量定义 */
constexpr u32 NODE_ID_BACKUP_ADDR = 0x0801E840; // 备份存储地址 (偏移64字节)
/** @brief NODE_ID_MAGIC 常量定义 */
constexpr u32 NODE_ID_MAGIC = 0x4E4F4445; // 魔数 'NODE' 用于验证数据有效性
/** @brief DEFAULT_NODE_ID 常量定义 */
constexpr u16 DEFAULT_NODE_ID = 1; // 默认节点 ID
/** @brief BROADCAST_NODE_ID 常量定义 */
constexpr u16 BROADCAST_NODE_ID = 0x1FFF; // 广播 ID (所有节点响应)
/** @brief MAX_NODE_ID 常量定义 */
constexpr u16 MAX_NODE_ID = 0x1FFE; // 最大有效节点 ID (0~0x1FFE)
// 节点 ID 存储结构 (存储在Flash中的格式)
@@ -66,174 +109,296 @@ constexpr u16 MAX_NODE_ID = 0x1FFE; // 最大有效节点 ID (0~0x1FFE)
// 地址偏移 0x06: 保留 (u16,填充为0xFFFF)
// 地址偏移 0x08: 写入计数器 (u32,用于区分最新数据)
// 地址偏移 0x0C: CRC32 校验 (u32)
/** @brief NODE_ID_STRUCT_SIZE 常量定义 */
constexpr u8 NODE_ID_STRUCT_SIZE = 0x10; // 结构体大小 16 字节
/** @brief NODE_ID_MAGIC_OFFSET 常量定义 */
constexpr u8 NODE_ID_MAGIC_OFFSET = 0x00; // 魔数偏移
/** @brief NODE_ID_VALUE_OFFSET 常量定义 */
constexpr u8 NODE_ID_VALUE_OFFSET = 0x04; // 节点ID值偏移
/** @brief NODE_ID_COUNTER_OFFSET 常量定义 */
constexpr u8 NODE_ID_COUNTER_OFFSET = 0x08; // 写入计数器偏移
/** @brief NODE_ID_CRC_OFFSET 常量定义 */
constexpr u8 NODE_ID_CRC_OFFSET = 0x0C; // CRC偏移
// BOOT 相关
/** @brief OTA_CONFIG_NUM 常量定义 */
constexpr u32 OTA_CONFIG_NUM = 6;
/** @brief n_APP_LATEST_AVAL_ADDR 常量定义 */
constexpr u32 n_APP_LATEST_AVAL_ADDR = 0x0801E000; // 最新 APP 可用地址
/** @brief n_APP_BACKUP_AVAL_ADDR 常量定义 */
constexpr u32 n_APP_BACKUP_AVAL_ADDR = 0x0801E004; // 备份 APP 可用地址
/** @brief n_APP_LATEST_EN_ADDR 常量定义 */
constexpr u32 n_APP_LATEST_EN_ADDR = 0x0801E008; // 最新 APP 激活
/** @brief n_APP_BACKUP_EN_ADDR 常量定义 */
constexpr u32 n_APP_BACKUP_EN_ADDR = 0x0801E00C; // 备份 APP 激活
/** @brief n_APP_LATEST_CHECK_ADDR 常量定义 */
constexpr u32 n_APP_LATEST_CHECK_ADDR = 0x0801E010; // 最新 APP 校验
/** @brief n_APP_BACKUP_CHECK_ADDR 常量定义 */
constexpr u32 n_APP_BACKUP_CHECK_ADDR = 0x0801E014; // 备份 APP 校验
/** @brief OTA_NOT_AVAL 常量定义 */
constexpr u32 OTA_NOT_AVAL = 0xFFFFFFFF;
/** @brief OTA_AVAL 常量定义 */
constexpr u32 OTA_AVAL = 0x00000000; // 全零表示可用
// 参数配置
/** @brief PP 常量定义 */
constexpr u8 PP = 11;
/** @brief DIR 常量定义 */
constexpr float DIR = 1.0f; // 默认方向:-1.0f 反转,1.0f 正转
/** @brief REDUCTION_RATIO 常量定义 */
constexpr u16 REDUCTION_RATIO = 25;
/** @brief CURRENT_OFFSET 常量定义 */
constexpr float CURRENT_OFFSET = -3.31f / 2.0f; // 当前电流传感器的零点偏移
/** @brief HOLD_PWM_DUTY 常量定义 */
constexpr float HOLD_PWM_DUTY = 0.1f;
/** @brief ANGLESENS_OFFSET 常量定义 */
constexpr u16 ANGLESENS_OFFSET = 0;
/** @brief ANGLESENS_CALIBRATION_ANGLE 常量定义 */
constexpr float ANGLESENS_CALIBRATION_ANGLE = 83.0f;
/** @brief KE_FACTOR 常量定义 */
constexpr float KE_FACTOR = 0.0f;
// 角度/速度 α-β 观测器参数
/** @brief ANGLE_KALMAN_INITIAL_STATE 常量定义 */
constexpr float ANGLE_KALMAN_INITIAL_STATE = 0.0f;
/** @brief ANGLE_KALMAN_INITIAL_COVARIANCE 常量定义 */
constexpr float ANGLE_KALMAN_INITIAL_COVARIANCE = 0.0f;
/** @brief ANGLE_KALMAN_PROCESS_NOISE_Q 常量定义 */
constexpr float ANGLE_KALMAN_PROCESS_NOISE_Q = 0.0f;
/** @brief ANGLE_KALMAN_MEASUREMENT_NOISE_R 常量定义 */
constexpr float ANGLE_KALMAN_MEASUREMENT_NOISE_R = 0.0f;
/** @brief ANGLE_OBSERVER_ALPHA 常量定义 */
constexpr float ANGLE_OBSERVER_ALPHA = 0.75f; // 角度校正增益,越大越跟测量
/** @brief ANGLE_OBSERVER_BETA 常量定义 */
constexpr float ANGLE_OBSERVER_BETA = 0.002f; // 速度校正增益,原0.001微调至0.002
// 旧速度 Kalman 参数保留用于接口兼容;主速度输出现在直接来自 α-β 观测器
/** @brief VELOCITY_KALMAN_INITIAL_STATE 常量定义 */
constexpr float VELOCITY_KALMAN_INITIAL_STATE = 0.0f;
/** @brief VELOCITY_KALMAN_INITIAL_COVARIANCE 常量定义 */
constexpr float VELOCITY_KALMAN_INITIAL_COVARIANCE = 1e-3f;
/** @brief VELOCITY_KALMAN_PROCESS_NOISE_Q 常量定义 */
constexpr float VELOCITY_KALMAN_PROCESS_NOISE_Q =
5e-4f; // 略增大,减少拖尾
/** @brief VELOCITY_KALMAN_MEASUREMENT_NOISE_R 常量定义 */
constexpr float VELOCITY_KALMAN_MEASUREMENT_NOISE_R =
0.05f; // 明显小于旧值,避免压得太死
// 电流卡尔曼滤波器参数
/** @brief CURRENT_KALMAN_INITIAL_STATE 常量定义 */
constexpr float CURRENT_KALMAN_INITIAL_STATE = 0.0f;
/** @brief CURRENT_KALMAN_INITIAL_COVARIANCE 常量定义 */
constexpr float CURRENT_KALMAN_INITIAL_COVARIANCE = 100.0f; // 增大初始协方差
/** @brief CURRENT_KALMAN_PROCESS_NOISE_Q 常量定义 */
constexpr float CURRENT_KALMAN_PROCESS_NOISE_Q = 10.0f; // 降低过程噪声
/** @brief CURRENT_KALMAN_MEASUREMENT_NOISE_R 常量定义 */
constexpr float CURRENT_KALMAN_MEASUREMENT_NOISE_R = 5e-5f; // 增大测量噪声
// PID 配置
/** @brief DEFAULT_current_loop_p 常量定义 */
constexpr float DEFAULT_current_loop_p = 0.1f / 100 * 12; // 电流 P
/** @brief current_loop_Ki 常量定义 */
constexpr float current_loop_Ki = 0.55f; // 电流 P
/** @brief current_loop_Kd 常量定义 */
constexpr float current_loop_Kd = 3e-4f; // 电流 P
/** @brief DEFAULT_vel_loop_p 常量定义 */
constexpr float DEFAULT_vel_loop_p = 0.018f / 100 * 12; // 速度 P
/** @brief vel_loop_Ku 常量定义 */
constexpr float vel_loop_Ku = 3.600000e-03 * 0.7 * 100 / 12;
/** @brief vel_loop_Tu 常量定义 */
constexpr float vel_loop_Tu = 17.0f * 1e-3f;
/** @brief vel_loop_Ki 常量定义 */
constexpr float vel_loop_Ki = 1.2 * vel_loop_Ku / vel_loop_Tu;
/** @brief vel_loop_Kd 常量定义 */
constexpr float vel_loop_Kd = 0.075 * vel_loop_Ku * vel_loop_Tu * 2;
/** @brief DEFAULT_vel_angloop_p 常量定义 */
constexpr float DEFAULT_vel_angloop_p = 0.4f / 100; // 速度 速度 - 角度 P
/** @brief vel_angloop_Ki 常量定义 */
constexpr float vel_angloop_Ki = 5.0f; // 速度 速度 - 角度 I
/** @brief vel_angloop_Kd 常量定义 */
constexpr float vel_angloop_Kd = 5e-05f; // 速度 速度 - 角度 D
/** @brief DEFAULT_angle_angloop_p 常量定义 */
constexpr float DEFAULT_angle_angloop_p =
150.0f / 100 * 12; // 角度 速度 - 角度 P
/** @brief ang_angloop_Ki 常量定义 */
constexpr float ang_angloop_Ki = 0.00f; // 角度 速度 - 角度 I
/** @brief ang_angloop_Kd 常量定义 */
constexpr float ang_angloop_Kd = 8e-04f; // 角度 速度 - 角度 D
/** @brief DEFAULT_angle_loop_p 常量定义 */
constexpr float DEFAULT_angle_loop_p = 60.0f / 100 * 12; // 角度 P
/** @brief DEFAULT_angle_MIT_p 常量定义 */
constexpr float DEFAULT_angle_MIT_p = 100.0f / 100 * 12; // 角度 MIT P
/** @brief angle_MIT_Ki 常量定义 */
constexpr float angle_MIT_Ki = 0.0f;
/** @brief angle_MIT_Kd 常量定义 */
constexpr float angle_MIT_Kd = 8e-04f;
/** @brief DEFAULT_vel_MIT_p 常量定义 */
constexpr float DEFAULT_vel_MIT_p = 5.0f / 100; // 速度 MIT P
/** @brief vel_MIT_Ki 常量定义 */
constexpr float vel_MIT_Ki = 15.0f;
/** @brief vel_MIT_Kd 常量定义 */
constexpr float vel_MIT_Kd = 1e-04f;
/** @brief DEFAULT_current_MIT_p 常量定义 */
constexpr float DEFAULT_current_MIT_p = 0.2f / 100 * 12; // 电流 MIT P
/** @brief current_MIT_Ki 常量定义 */
constexpr float current_MIT_Ki = 0.1f;
/** @brief current_MIT_Kd 常量定义 */
constexpr float current_MIT_Kd = 3e-4f;
// 常量定义
/** @brief SIZE_FLOAT 常量定义 */
constexpr u8 SIZE_FLOAT = sizeof(float);
/** @brief SIZE_U32 常量定义 */
constexpr u8 SIZE_U32 = sizeof(uint32_t);
/** @brief ADC_MAX 常量定义 */
constexpr float ADC_MAX = 65536.0f;
/** @brief PI 常量定义 */
constexpr float PI = 3.14159265358979323846f;
/** @brief INV_PI_3 常量定义 */
constexpr float INV_PI_3 = 3.0f / PI;
/** @brief PI_3 常量定义 */
constexpr float PI_3 = PI / 3.0f;
/** @brief _1_SQRT3 常量定义 */
constexpr float _1_SQRT3 = 0.57735026919f; // 1/sqrt(3)
/** @brief _3PI_2 常量定义 */
constexpr float _3PI_2 = 4.71238898038f;
/** @brief SQRT3 常量定义 */
constexpr float SQRT3 = 1.7320508075688772f;
/** @brief SQRT3DV2 常量定义 */
constexpr float SQRT3DV2 = 0.8660254037844386f; // sqrt(3)/2
/** @brief COS_PI_3 常量定义 */
constexpr float COS_PI_3 = 0.5f;
/** @brief ANGLE_FACTOR 常量定义 */
constexpr float ANGLE_FACTOR = 25.0f / 180.0f * PI;
/** @brief DEG2RAD 常量定义 */
constexpr float DEG2RAD = 1.0f / 180.0f * PI;
/** @brief RAD2DEG 常量定义 */
constexpr float RAD2DEG = 180.0f / PI; // 修正 RAD2DEG 定义,应该是 180/π
/** @brief DEFAULT_VALUE 常量定义 */
constexpr u8 DEFAULT_VALUE = 0;
/** @brief CONFIG_SAVED_NUM 常量定义 */
constexpr u8 CONFIG_SAVED_NUM = 6;
// 三角函数快速计算 LUT
/** @brief LUT_SIZE 常量定义 */
constexpr u16 LUT_SIZE = 1024;
/** @brief LUT_MASK 常量定义 */
constexpr u16 LUT_MASK = (LUT_SIZE - 1);
/** @brief LUT_SCALE 常量定义 */
constexpr u16 LUT_SCALE = (LUT_SIZE / (2.0f * PI));
// CAN 相关
// 注意:以下为 CAN 基础 ID(只保留低 16 位),实际发送/接收时会自动叠加节点 ID
// 到高 16 位 格式:[节点 ID(16 位)][基础 ID(16 位)] 例如:节点 ID=1,发送命令
// ID = (1 << 16) | CANFD_CMD_ID = 0x00010200
/** @brief DEV_CAN0_ID 常量定义 */
constexpr u16 DEV_CAN0_ID = 0x0000;
/** @brief DEV_CAN0_MASK 常量定义 */
constexpr u16 DEV_CAN0_MASK = 0x0000;
/** @brief DEV_CAN_LOOPBACK_ID 常量定义 */
constexpr u16 DEV_CAN_LOOPBACK_ID = 0x0000;
// 反馈基础 ID
/** @brief CANFD_STATUS_ID 常量定义 */
constexpr u16 CANFD_STATUS_ID = 0x0100; // 状态反馈基础 ID
/** @brief CANFD_CONFIG_ID 常量定义 */
constexpr u16 CANFD_CONFIG_ID = 0x0101; // 配置信息基础 ID
/** @brief CANFD_VERSION_ID 常量定义 */
constexpr u16 CANFD_VERSION_ID = 0x00FF; // 版本信息基础 ID
// 命令基础 ID
/** @brief CANFD_CMD_ID 常量定义 */
constexpr u16 CANFD_CMD_ID = 0x0200; // 控制命令基础 ID
/** @brief CANFD_RESET_ID 常量定义 */
constexpr u16 CANFD_RESET_ID = 0x0301; // 重置命令基础 ID
// 节点 ID 管理基础 ID
/** @brief CANFD_SET_NODE_ID 常量定义 */
constexpr u16 CANFD_SET_NODE_ID = 0x0400; // 设置节点 ID 基础 ID
/** @brief CANFD_GET_NODE_ID 常量定义 */
constexpr u16 CANFD_GET_NODE_ID = 0x0401; // 查询节点 ID 基础 ID
// OTA 相关基础 ID 不受到node ID影响
/** @brief CANFD_BOOT_ID 常量定义 */
constexpr u16 CANFD_BOOT_ID = 0x0000; // BOOT 模式基础 ID (进入 BOOT 使用此 ID)
/** @brief CANFD_OTA_REQ_ID 常量定义 */
constexpr u16 CANFD_OTA_REQ_ID = 0x0100; // OTA 请求基础 ID
/** @brief CANFD_OTA_DATA_ID 常量定义 */
constexpr u16 CANFD_OTA_DATA_ID = 0x0101; // OTA 数据基础 ID
/** @brief CANFD_OTA_ACK_ID 常量定义 */
constexpr u16 CANFD_OTA_ACK_ID = 0x0102; // OTA 确认基础 ID
/** @brief CANFD_OTA_WAIT_ID 常量定义 */
constexpr u16 CANFD_OTA_WAIT_ID = 0x0103; // OTA 等待基础 ID
// ADC
/** @brief ADC_FILTER_SIZE 常量定义 */
constexpr u8 ADC_FILTER_SIZE = 6;
/** @brief BLOCK_SIZE 常量定义 */
constexpr u8 BLOCK_SIZE = ADC_FILTER_SIZE * SIZE_FLOAT;
/** @brief ERROR_ADC_VAL 常量定义 */
constexpr float ERROR_ADC_VAL = 255.0f;
/** @brief MAX_TEMP 常量定义 */
constexpr float MAX_TEMP = 150.0f;
/** @brief MIN_TEMP 常量定义 */
constexpr float MIN_TEMP = -40.0f;
/** @brief MAX_CURRENT 常量定义 */
constexpr float MAX_CURRENT = 40.0f;
/** @brief MIN_CURRENT 常量定义 */
constexpr float MIN_CURRENT = -40.0f;
/** @brief MAX_VCC 常量定义 */
constexpr float MAX_VCC = 65.0f;
/** @brief MIN_VCC 常量定义 */
constexpr float MIN_VCC = -0.1f;
// ang_sensor
/** @brief VEL_FILTER_SIZE 常量定义 */
constexpr u16 VEL_FILTER_SIZE = 4;
/** @brief DEFAULT_COMMAND 常量定义 */
constexpr u16 DEFAULT_COMMAND = 0x0000;
/** @brief FAULT_RECEIVE 常量定义 */
constexpr u16 FAULT_RECEIVE = 0xFFFF;
/** @brief ANGLE_WRAP_THRESHOLD 常量定义 */
constexpr float ANGLE_WRAP_THRESHOLD = 300.0f;
/** @brief ANGLE_WRAP_VALUE 常量定义 */
constexpr float ANGLE_WRAP_VALUE = 360.0f;
/** @brief RAD_FACTOR 常量定义 */
constexpr float RAD_FACTOR = 1.0f / ADC_MAX * 2.0f * PI;
/** @brief ANGLESENS_FACTOR 常量定义 */
constexpr float ANGLESENS_FACTOR = 1.0f / ADC_MAX * 360.0f;
// TIMER2-任务调度
/** @brief TIMER2_PRESCALER 常量定义 */
constexpr int TIMER2_PRESCALER = 119; // 120MHz / 120 = 1MHz
/** @brief TIMER2_PERIOD 常量定义 */
constexpr int TIMER2_PERIOD = 49; // 1 / 1MHz * 50 = 50us
/** @brief MOTOR_PERIOD 常量定义 */
constexpr int MOTOR_PERIOD = 1; // 控制每50us执行一次,无分频
/** @brief TIME_SLICE 常量定义 */
constexpr float TIME_SLICE =
(TIMER2_PERIOD + 1) * (TIMER2_PRESCALER + 1) / 120000000.0f; // 周期
/** @brief TIMER2_FREQUENCY 常量定义 */
constexpr float TIMER2_FREQUENCY = 1 / TIME_SLICE; // 频率
/** @brief MOTOR_FREQUENCY 常量定义 */
constexpr float MOTOR_FREQUENCY = 1 / TIME_SLICE / MOTOR_PERIOD; // 频率
// TIMER1-PWM
/** @brief TIMER1_PRESCALER 常量定义 */
constexpr int TIMER1_PRESCALER = 0; // 不分频,计数器时钟为 120MHz
/** @brief TIMER1_PERIOD 常量定义 */
constexpr int TIMER1_PERIOD = 2999; // 120MHz / (0+1) / (2999+1) = 40kHz计数, 中心对齐实际PWM 20kHz
/** @brief TIMER1_DEFAULT_PULSE 常量定义 */
constexpr int TIMER1_DEFAULT_PULSE = 0;
/** @brief TIMER1_CH3_COMPARE_VALUE 常量定义 */
constexpr int TIMER1_CH3_COMPARE_VALUE =
(TIMER1_PERIOD + 1) * 0.41 - 1; // PWM 周期 41% 位置触发ADC采样
// 齿槽转矩补偿
/** @brief COGGING_TABLE_SIZE 常量定义 */
constexpr u16 COGGING_TABLE_SIZE = 128; // 每电周期采样点数
/** @brief COGGING_COMP_SCALE 常量定义 */
constexpr float COGGING_COMP_SCALE = 0.005f; // 补偿换算系数 V/mA,40mA × 0.005 = 0.2V
// 电压检测参数(基于跌幅检测,不依赖固定额定电压)
@@ -244,9 +409,18 @@ constexpr float COGGING_COMP_SCALE = 0.005f; // 补偿换算系数 V/mA,40mA
// 慢速管理层(power_manage,~10ms周期):
// - 执行Flash保存
// - 状态恢复判断(电压恢复到基准电压的90%以上)
/** @brief VBUS_DROP_THRESHOLD 常量定义 */
constexpr float VBUS_DROP_THRESHOLD = 5.0f; // 电压跌幅阈值 (V)
/** @brief VBUS_ABSOLUTE_MIN 常量定义 */
constexpr float VBUS_ABSOLUTE_MIN = 12.0f; // 绝对最低电压 (V)
/** @brief VBUS_DEBOUNCE_COUNT 常量定义 */
constexpr u32 VBUS_DEBOUNCE_COUNT = 5; // 快速检测:防抖计数 (5次×100us = 500us)
/** @brief VBUS_RECOVERY_RATIO 常量定义 */
constexpr float VBUS_RECOVERY_RATIO = 0.9f; // 恢复比例(基准电压的90%)
#endif
#endif
+17
View File
@@ -1,3 +1,9 @@
/**
* @file sys/flash.cpp
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#include "flash.h"
#include "FOC.h"
#include "ang_sensor.h"
@@ -12,15 +18,19 @@
// EEP 调试宏定义
#if EEP_DEBUG
/** @brief EEP_DEBUG_PRINT 宏定义 */
#define EEP_DEBUG_PRINT(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
/** @brief EEP_DEBUG_PRINT 宏定义 */
#define EEP_DEBUG_PRINT(fmt, ...) ((void)0)
#endif
// OTA 调试宏定义
#if OTA_DEBUG
/** @brief OTA_DEBUG_PRINT 宏定义 */
#define OTA_DEBUG_PRINT(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
/** @brief OTA_DEBUG_PRINT 宏定义 */
#define OTA_DEBUG_PRINT(fmt, ...) ((void)0)
#endif
@@ -29,6 +39,12 @@ extern angle_sensor KTH7823;
extern CAN_transmiter CAN0_transmiter;
extern FOC_Controller FOC; // FOC 控制
/**
* @brief 写入 write_ADDRESS 相关数据
* @param[in] address 参数
* @param[in] data 参数
* @return fmc_state_enum 返回值
*/
fmc_state_enum write_ADDRESS(u32 address, u32 data) {
fmc_unlock();
fmc_flag_clear(FMC_FLAG_PGERR | FMC_FLAG_PGAERR | FMC_FLAG_WPERR);
@@ -665,6 +681,7 @@ FlashEepromStatus FlashEEPROM::writeNodeId(u16 node_id) {
}
// 写入并校验,最多3次
/** @brief MAX_WRITE_RETRY 宏定义 */
#define MAX_WRITE_RETRY 3
for (u8 retry = 0; retry < MAX_WRITE_RETRY; retry++) {
// 写入主存储区
+92
View File
@@ -1,3 +1,9 @@
/**
* @file sys/flash.h
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#ifndef __FLASH_H
#define __FLASH_H
@@ -5,9 +11,13 @@
#include <cstdint>
// 修改后 - 强制4字节对齐
/** @brief ALIGN_4BYTE 宏定义 */
#define ALIGN_4BYTE(addr) ((addr) & 0xFFFFFFFC) // 4字节对齐
// EEPROM操作状态
/**
* @brief 匿名枚举 枚举定义
*/
typedef enum {
FLASH_EEPROM_OK = 0, // 操作成功
FLASH_EEPROM_WRITE_ERROR, // 写入错误
@@ -20,6 +30,9 @@ typedef enum {
} FlashEepromStatus;
// Flash EEPROM类
/**
* @brief FlashEEPROM 类或结构体
*/
class FlashEEPROM {
public:
// EEPROM emulation constants
@@ -49,39 +62,118 @@ class FlashEEPROM {
FlashEEPROM();
// 初始化Flash EEPROM模拟
/**
* @brief 初始化对象或模块
* @return u8 返回值
*/
u8 init();
// 从Flash EEPROM中读取数据
/**
* @brief 读取数据
* @param[in] virtualAddr 参数
* @param[in] data 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus read(u8 virtualAddr, u16 *data) const;
// 向Flash EEPROM写入数据
/**
* @brief 写入数据
* @param[in] virtualAddr 参数
* @param[in] data 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus write(u8 virtualAddr, u16 data);
// Float数据读相关函数
/**
* @brief 从 Flash EEPROM 读取浮点数据
* @param[in] virtualAddr 参数
* @param[in] data 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus readFloat(u8 virtualAddr, float *data) const;
// Float数据存储相关函数
/**
* @brief 向 Flash EEPROM 写入浮点数据
* @param[in] virtualAddr 参数
* @param[in] data 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus writeFloat(u8 virtualAddr, float data);
// 格式化Flash EEPROM页面
/**
* @brief 格式化存储区域
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus format();
/**
* @brief 保存系统配置参数
* @param[in] saved 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus save_system_config(bool saved);
/**
* @brief 读取已保存的系统配置参数
* @return u8 返回值
*/
u8 read_saved_system_config(void);
/**
* @brief 读取保存的角度值
* @return float 返回值
*/
float read_angle();
// 节点 ID 独立读写函数(使用魔数+双重备份+计数器机制)
// 从 Flash 读取节点 ID(带魔数验证和双重备份回退)
/**
* @brief 读取节点 ID 配置
* @param[in] node_id 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus readNodeId(u16 *node_id) const;
// 保存节点 ID 到 Flash(写入主备份和备用备份)
/**
* @brief 写入节点 ID 配置
* @param[in] node_id 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus writeNodeId(u16 node_id);
// 擦除节点 ID 存储区(恢复默认值)
/**
* @brief 擦除节点 ID 配置
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus eraseNodeId();
private:
/**
* @brief 写入 writeCRC 相关数据
* @param[in] CRC_NUM 参数
* @param[in] saved 参数
* @return FlashEepromStatus 返回值
*/
FlashEepromStatus writeCRC(u32 CRC_NUM, bool saved);
};
/**
* @brief flash_eeprom_example_main 函数
* @return void
*/
void flash_eeprom_example_main(void);
u8 OTA_SET(u32 addr, u32 data);
/**
* @brief move_app_data 函数
* @return fmc_state_enum 返回值
*/
fmc_state_enum move_app_data(void);
/**
* @brief 写入 write_ADDRESS 相关数据
* @param[in] address 参数
* @param[in] data 参数
* @return fmc_state_enum 返回值
*/
fmc_state_enum write_ADDRESS(u32 address, u32 data);
#endif /* __FLASH_H */
+8
View File
@@ -1,3 +1,9 @@
/**
* @file sys/health.cpp
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#include "health.h"
#include "config.h"
#include "Can.h"
@@ -12,8 +18,10 @@ extern FOC_Controller FOC;
extern FlashEEPROM flashEEP;
ThermalController thermalController; // 热量控制器初始化
/** @brief max 宏定义 */
#define max(a, b, c) \
((a) > (b) ? ((a) > (c) ? (a) : (c)) : ((b) > (c) ? (b) : (c)))
/** @brief PROTECT_TIME 常量定义 */
constexpr u16 PROTECT_TIME = 6000; // 过热保护时间,单位*10ms
// 电压管理状态机
+33
View File
@@ -1,22 +1,39 @@
/**
* @file sys/health.h
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#ifndef _HEALTH_H
#define _HEALTH_H
#include <cstdint>
typedef int32_t q16_16_t; // Q16.16格式
// 定点数运算宏
/** @brief Q16_16_ONE 宏定义 */
#define Q16_16_ONE 65536 // 1.0 in Q16.16
/** @brief FLOAT_TO_Q16_16 宏定义 */
#define FLOAT_TO_Q16_16(x) ((q16_16_t)((x) * Q16_16_ONE))
/** @brief Q16_16_TO_FLOAT 宏定义 */
#define Q16_16_TO_FLOAT(x) ((float)(x) / Q16_16_ONE)
/** @brief Q16_16_MUL 宏定义 */
#define Q16_16_MUL(a, b) ((q16_16_t)(((int64_t)(a) * (b)) >> 16))
/** @brief Q16_16_SQUARE 宏定义 */
#define Q16_16_SQUARE(x) Q16_16_MUL((x), (x))
// 电压监测状态机状态
/**
* @brief VoltageState 枚举定义
*/
enum class VoltageState : uint8_t {
NORMAL, // 正常运行
VOLTAGE_DROP, // 电压跌落检测中(防抖等待)
SHUTDOWN_SAVE // 已关机,等待保存
};
/**
* @brief ThermalController 类或结构体
*/
class ThermalController {
private:
u8 temperature;
@@ -34,14 +51,30 @@ class ThermalController {
ThermalController()
: thermalRate(FLOAT_TO_Q16_16(0.995f)),
recoveryRate(FLOAT_TO_Q16_16(0.33f)) {}
/**
* @brief 更新对象内部状态或采样数据
* @return u32 返回值
*/
u32 update();
/**
* @brief 复位对象内部状态
* @return void
*/
void reset() {
thermal_value = 0;
remainingTime10Ms = 0;
}
};
/**
* @brief angsens_MG_check 函数
* @return void
*/
void angsens_MG_check(void);
/**
* @brief power_manage 函数
* @return void
*/
void power_manage(void);
#endif
+66
View File
@@ -1,3 +1,9 @@
/**
* @file sys/initial.cpp
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#include "initial.h"
#include "Can.h"
#include "config.h"
@@ -13,15 +19,19 @@
// OTA 调试宏定义
#if OTA_DEBUG
/** @brief OTA_DEBUG_PRINT 宏定义 */
#define OTA_DEBUG_PRINT(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
/** @brief OTA_DEBUG_PRINT 宏定义 */
#define OTA_DEBUG_PRINT(fmt, ...) ((void)0)
#endif
// EEP 调试宏定义
#if EEP_DEBUG
/** @brief EEP_DEBUG_PRINT 宏定义 */
#define EEP_DEBUG_PRINT(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
/** @brief EEP_DEBUG_PRINT 宏定义 */
#define EEP_DEBUG_PRINT(fmt, ...) ((void)0)
#endif
@@ -38,18 +48,38 @@ VersionManager::VersionManager() {
BOOT_VERSION_BUILD);
}
/**
* @brief 获取 getSoftwareVersion 对应的数据或状态
* @return VersionManager::VersionInfo 返回值
*/
VersionManager::VersionInfo VersionManager::getSoftwareVersion() const {
return softwareVersion;
}
/**
* @brief 获取 getHardwareVersion 对应的数据或状态
* @return VersionManager::VersionInfo 返回值
*/
VersionManager::VersionInfo VersionManager::getHardwareVersion() const {
return hardwareVersion;
}
/**
* @brief 获取 getBootVersion 对应的数据或状态
* @return VersionManager::VersionInfo 返回值
*/
VersionManager::VersionInfo VersionManager::getBootVersion() const {
return bootVersion;
}
/**
* @brief 设置 setSoftwareVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void VersionManager::setSoftwareVersion(u16 major, u16 minor, u16 patch,
u16 build) {
softwareVersion.major = major;
@@ -58,6 +88,14 @@ void VersionManager::setSoftwareVersion(u16 major, u16 minor, u16 patch,
softwareVersion.build = build;
}
/**
* @brief 设置 setHardwareVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void VersionManager::setHardwareVersion(u16 major, u16 minor, u16 patch,
u16 build) {
hardwareVersion.major = major;
@@ -66,6 +104,14 @@ void VersionManager::setHardwareVersion(u16 major, u16 minor, u16 patch,
hardwareVersion.build = build;
}
/**
* @brief 设置 setBootVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void VersionManager::setBootVersion(u16 major, u16 minor, u16 patch,
u16 build) {
bootVersion.major = major;
@@ -86,6 +132,10 @@ char *VersionManager::versionToString(const VersionInfo &version, char *buffer,
return buffer;
}
/**
* @brief sendVersionInfoViaCan 函数
* @return void
*/
void VersionManager::sendVersionInfoViaCan() const {
// 准备发送版本信息 (ID: CANFD_VERSION_ID)
// 只使用必要的字节数(24 字节)来传输三个版本的信息(每个版本 6 字节)
@@ -128,6 +178,10 @@ void VersionManager::sendVersionInfoViaCan() const {
CAN0_transmiter.build_can_id(CANFD_VERSION_ID), 24, versionData);
}
/**
* @brief printVersions 函数
* @return void
*/
void VersionManager::printVersions() const {
char versionStr[32];
@@ -143,6 +197,10 @@ void VersionManager::printVersions() const {
}
/* retarget the C library printf function to the USART */
/**
* @brief 初始化 USART0 调试串口
* @return u8 返回值
*/
u8 USART0_init() {
gd_eval_com_init(EVAL_COM0);
return 1;
@@ -170,6 +228,10 @@ int fputc(int ch, FILE *f) throw() {
return ch;
}
/**
* @brief 初始化未使用引脚状态
* @return void
*/
void unused_pin_init() {
rcu_periph_clock_enable(RCU_GPIOA); // 使能 GPIOA 时钟
rcu_periph_clock_enable(RCU_GPIOB); // 使能 GPIOB 时钟
@@ -227,6 +289,10 @@ u16 get_reset_cause(void) {
return cause;
}
/**
* @brief 初始化 OTA 与 A/B 分区状态
* @return void
*/
void OTA_initial(void) {
#if OTA_DEBUG
u32 temp_val[6];
+87
View File
@@ -1,3 +1,9 @@
/**
* @file sys/initial.h
* @brief 系统服务与平台支持源文件
* @note 本文件仅补充 Doxygen 文档注释,不改变代码逻辑。
*/
#ifndef _INITIAL_H
#define _INITIAL_H
@@ -11,6 +17,9 @@ extern "C" {
#include <cstdio>
// 任务标志定义
/**
* @brief 匿名枚举 枚举定义
*/
typedef enum {
TASK_MOTOR_CONTROL = 0,
TASK_CURRENT_UPDATE,
@@ -25,14 +34,45 @@ typedef enum {
TASK_COUNT
} SystemTask;
/**
* @brief rcu_config 函数
* @return void
*/
void rcu_config(void);
static volatile uint32_t timer_delay_count = 0; // volatile 很重要!
/**
* @brief fputc 函数
* @param[in] ch 参数
* @param[in] f 参数
* @return int 返回值
*/
int fputc(int ch, FILE *f); // 声明fputc函数以重载标准库实现
/**
* @brief 初始化 USART0 调试串口
* @return u8 返回值
*/
u8 USART0_init(void);
/**
* @brief 初始化独立看门狗
* @param[in] time 参数
* @return u8 返回值
*/
u8 watchdog_init(u32 time);
/**
* @brief 获取复位原因
* @return u16 返回值
*/
u16 get_reset_cause(void);
/**
* @brief 初始化未使用引脚状态
* @return void
*/
void unused_pin_init();
/**
* @brief 初始化 OTA 与 A/B 分区状态
* @return void
*/
void OTA_initial(void);
// 任务管理结构
@@ -41,6 +81,9 @@ typedef struct {
} TaskScheduler;
// 版本管理类
/**
* @brief VersionManager 类或结构体
*/
class VersionManager {
public:
// 版本信息结构体
@@ -55,21 +98,57 @@ class VersionManager {
VersionManager();
// 获取软件版本
/**
* @brief 获取 getSoftwareVersion 对应的数据或状态
* @return VersionInfo 返回值
*/
VersionInfo getSoftwareVersion() const;
// 获取硬件版本
/**
* @brief 获取 getHardwareVersion 对应的数据或状态
* @return VersionInfo 返回值
*/
VersionInfo getHardwareVersion() const;
// 获取BOOT版本
/**
* @brief 获取 getBootVersion 对应的数据或状态
* @return VersionInfo 返回值
*/
VersionInfo getBootVersion() const;
// 设置软件版本
/**
* @brief 设置 setSoftwareVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void setSoftwareVersion(u16 major, u16 minor, u16 patch, u16 build);
// 设置硬件版本
/**
* @brief 设置 setHardwareVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void setHardwareVersion(u16 major, u16 minor, u16 patch, u16 build);
// 设置BOOT版本
/**
* @brief 设置 setBootVersion 对应的参数或状态
* @param[in] major 参数
* @param[in] minor 参数
* @param[in] patch 参数
* @param[in] build 参数
* @return void
*/
void setBootVersion(u16 major, u16 minor, u16 patch, u16 build);
// 将版本信息转换为字符串
@@ -77,9 +156,17 @@ class VersionManager {
size_t bufSize) const;
// 打印所有版本信息
/**
* @brief printVersions 函数
* @return void
*/
void printVersions() const;
// 通过CAN发送版本信息
/**
* @brief sendVersionInfoViaCan 函数
* @return void
*/
void sendVersionInfoViaCan() const;
private:
+6
View File
@@ -43,8 +43,10 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// SLEEP 调试宏定义
#if SLEEP_DEBUG
/** @brief SLEEP_DEBUG_PRINT 宏定义 */
#define SLEEP_DEBUG_PRINT(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
/** @brief SLEEP_DEBUG_PRINT 宏定义 */
#define SLEEP_DEBUG_PRINT(fmt, ...) ((void)0)
#endif
@@ -208,6 +210,10 @@ void busy_task_exit(void) {
}
}
/**
* @brief 获取 CPU 使用率
* @return uint8_t 返回值
*/
uint8_t get_cpu_usage(void) { return cpu_usage; }
/*!
+51
View File
@@ -41,28 +41,79 @@ extern "C" {
#include <cstdint>
/* configure systick */
/**
* @brief 配置 SysTick 定时器
* @return void
*/
void systick_config(void);
/* get system tick time in milliseconds */
/**
* @brief 获取系统毫秒计数
* @return uint32_t 返回值
*/
uint32_t get_systick_ms(void);
/* delay a time in milliseconds */
/**
* @brief 毫秒级阻塞延时
* @param[in] count 参数
* @return void
*/
void delay_1ms(uint32_t count);
/* delay a time in seconds */
/**
* @brief 秒级阻塞延时
* @param[in] count 参数
* @return void
*/
void delay_1s(uint32_t count);
/* delay decrement */
/**
* @brief 递减延时计数器
* @return void
*/
void delay_decrement(void);
/* 空闲任务计数(兼容接口,DWT 版本无需操作) */
/**
* @brief 记录空闲任务计数
* @return void
*/
void idle_task_count(void);
/* do_task 入口调用,记录忙碌起始周期 */
/**
* @brief 记录忙碌任务开始周期
* @return void
*/
void busy_task_enter(void);
/* do_task 出口调用,累加忙碌周期 */
/**
* @brief 记录忙碌任务结束并累加周期
* @return void
*/
void busy_task_exit(void);
/* 获取CPU使用率 */
/**
* @brief 获取 CPU 使用率
* @return uint8_t 返回值
*/
uint8_t get_cpu_usage(void);
/* 系统软复位 */
/**
* @brief 执行系统软复位
* @return void
*/
void system_soft_reset(void);
/* 准备进入低功耗模式 */
/**
* @brief 准备进入应用低功耗模式
* @param[in] save_data 参数
* @return void
*/
void app_prepare_deep_sleep(bool save_data);
/* 中断唤醒 */
/**
* @brief EXTI5_9 中断处理函数
* @return void
*/
void EXTI5_9_IRQHandler(void);
#ifdef __cplusplus