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:
@@ -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 */
|
||||
Reference in New Issue
Block a user