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:
@@ -35,24 +35,34 @@ OF SUCH DAMAGE.
|
||||
#include "gd32c10x_rcu.h"
|
||||
|
||||
/* define clock source */
|
||||
/** @brief SEL_IRC8M 宏定义 */
|
||||
#define SEL_IRC8M ((uint16_t)0U) /* IRC8M is selected as CK_SYS */
|
||||
/** @brief SEL_HXTAL 宏定义 */
|
||||
#define SEL_HXTAL ((uint16_t)1U) /* HXTAL is selected as CK_SYS */
|
||||
/** @brief SEL_PLL 宏定义 */
|
||||
#define SEL_PLL ((uint16_t)2U) /* PLL is selected as CK_SYS */
|
||||
|
||||
/* define startup timeout count */
|
||||
/** @brief OSC_STARTUP_TIMEOUT 宏定义 */
|
||||
#define OSC_STARTUP_TIMEOUT ((uint32_t)0x000FFFFFU)
|
||||
/** @brief LXTAL_STARTUP_TIMEOUT 宏定义 */
|
||||
#define LXTAL_STARTUP_TIMEOUT ((uint32_t)0x03FFFFFFU)
|
||||
|
||||
/* ADC clock prescaler offset */
|
||||
/** @brief RCU_ADC_PSC_OFFSET 宏定义 */
|
||||
#define RCU_ADC_PSC_OFFSET ((uint32_t)14U)
|
||||
|
||||
/* RCU IRC8M adjust value mask and offset*/
|
||||
/** @brief RCU_IRC8M_ADJUST_MASK 宏定义 */
|
||||
#define RCU_IRC8M_ADJUST_MASK ((uint8_t)0x1FU)
|
||||
/** @brief RCU_IRC8M_ADJUST_OFFSET 宏定义 */
|
||||
#define RCU_IRC8M_ADJUST_OFFSET ((uint32_t)3U)
|
||||
|
||||
/* RCU PLL1 clock multiplication factor offset */
|
||||
/** @brief RCU_CFG1_PLL1MF_OFFSET 宏定义 */
|
||||
#define RCU_CFG1_PLL1MF_OFFSET ((uint32_t)8U)
|
||||
/* RCU PREDV1 division factor offset*/
|
||||
/** @brief RCU_CFG1_PREDV1_OFFSET 宏定义 */
|
||||
#define RCU_CFG1_PREDV1_OFFSET ((uint32_t)4U)
|
||||
|
||||
/*!
|
||||
@@ -115,6 +125,11 @@ void rcu_deinit(void)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_periph_clock_enable 函数
|
||||
* @param[in] periph 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_periph_clock_enable(rcu_periph_enum periph)
|
||||
{
|
||||
RCU_REG_VAL(periph) |= BIT(RCU_BIT_POS(periph));
|
||||
@@ -146,6 +161,11 @@ void rcu_periph_clock_enable(rcu_periph_enum periph)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_periph_clock_disable 函数
|
||||
* @param[in] periph 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_periph_clock_disable(rcu_periph_enum periph)
|
||||
{
|
||||
RCU_REG_VAL(periph) &= ~BIT(RCU_BIT_POS(periph));
|
||||
@@ -201,6 +221,11 @@ void rcu_periph_clock_sleep_disable(rcu_periph_sleep_enum periph)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_periph_reset_enable 函数
|
||||
* @param[in] periph_reset 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_periph_reset_enable(rcu_periph_reset_enum periph_reset)
|
||||
{
|
||||
RCU_REG_VAL(periph_reset) |= BIT(RCU_BIT_POS(periph_reset));
|
||||
@@ -228,6 +253,11 @@ void rcu_periph_reset_enable(rcu_periph_reset_enum periph_reset)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_periph_reset_disable 函数
|
||||
* @param[in] periph_reset 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_periph_reset_disable(rcu_periph_reset_enum periph_reset)
|
||||
{
|
||||
RCU_REG_VAL(periph_reset) &= ~BIT(RCU_BIT_POS(periph_reset));
|
||||
@@ -371,6 +401,11 @@ void rcu_apb2_clock_config(uint32_t ck_apb2)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_ckout0_config 函数
|
||||
* @param[in] ckout0_src 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_ckout0_config(uint32_t ckout0_src)
|
||||
{
|
||||
uint32_t reg;
|
||||
@@ -520,6 +555,11 @@ void rcu_pll2_config(uint32_t pll_mul)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_adc_clock_config 函数
|
||||
* @param[in] adc_psc 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_adc_clock_config(uint32_t adc_psc)
|
||||
{
|
||||
uint32_t reg0,reg1;
|
||||
@@ -577,6 +617,11 @@ void rcu_adc_clock_config(uint32_t adc_psc)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_usb_clock_config 函数
|
||||
* @param[in] usb_psc 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_usb_clock_config(uint32_t usb_psc)
|
||||
{
|
||||
uint32_t reg;
|
||||
@@ -688,6 +733,11 @@ void rcu_ck48m_clock_config(uint32_t ck48m_clock_source)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_flag_get 函数
|
||||
* @param[in] flag 参数
|
||||
* @return FlagStatus 返回值
|
||||
*/
|
||||
FlagStatus rcu_flag_get(rcu_flag_enum flag)
|
||||
{
|
||||
FlagStatus rcu_flag = RESET;
|
||||
@@ -729,6 +779,11 @@ void rcu_all_reset_flag_clear(void)
|
||||
\param[out] none
|
||||
\retval FlagStatus: SET or RESET
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_interrupt_flag_get 函数
|
||||
* @param[in] int_flag 参数
|
||||
* @return FlagStatus 返回值
|
||||
*/
|
||||
FlagStatus rcu_interrupt_flag_get(rcu_int_flag_enum int_flag)
|
||||
{
|
||||
FlagStatus rcu_int_flag = RESET;
|
||||
@@ -759,6 +814,11 @@ FlagStatus rcu_interrupt_flag_get(rcu_int_flag_enum int_flag)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_interrupt_flag_clear 函数
|
||||
* @param[in] int_flag_clear 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_interrupt_flag_clear(rcu_int_flag_clear_enum int_flag_clear)
|
||||
{
|
||||
RCU_REG_VAL(int_flag_clear) |= BIT(RCU_BIT_POS(int_flag_clear));
|
||||
@@ -779,6 +839,11 @@ void rcu_interrupt_flag_clear(rcu_int_flag_clear_enum int_flag_clear)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_interrupt_enable 函数
|
||||
* @param[in] stab_int 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_interrupt_enable(rcu_int_enum stab_int)
|
||||
{
|
||||
RCU_REG_VAL(stab_int) |= BIT(RCU_BIT_POS(stab_int));
|
||||
@@ -799,6 +864,11 @@ void rcu_interrupt_enable(rcu_int_enum stab_int)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_interrupt_disable 函数
|
||||
* @param[in] stab_int 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_interrupt_disable(rcu_int_enum stab_int)
|
||||
{
|
||||
RCU_REG_VAL(stab_int) &= ~BIT(RCU_BIT_POS(stab_int));
|
||||
@@ -841,6 +911,11 @@ void rcu_lxtal_drive_capability_config(uint32_t lxtal_dricap)
|
||||
\param[out] none
|
||||
\retval ErrStatus: SUCCESS or ERROR
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_osci_stab_wait 函数
|
||||
* @param[in] osci 参数
|
||||
* @return ErrStatus 返回值
|
||||
*/
|
||||
ErrStatus rcu_osci_stab_wait(rcu_osci_type_enum osci)
|
||||
{
|
||||
uint32_t stb_cnt = 0U;
|
||||
@@ -974,6 +1049,11 @@ ErrStatus rcu_osci_stab_wait(rcu_osci_type_enum osci)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_osci_on 函数
|
||||
* @param[in] osci 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_osci_on(rcu_osci_type_enum osci)
|
||||
{
|
||||
RCU_REG_VAL(osci) |= BIT(RCU_BIT_POS(osci));
|
||||
@@ -994,6 +1074,11 @@ void rcu_osci_on(rcu_osci_type_enum osci)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief rcu_osci_off 函数
|
||||
* @param[in] osci 参数
|
||||
* @return void
|
||||
*/
|
||||
void rcu_osci_off(rcu_osci_type_enum osci)
|
||||
{
|
||||
RCU_REG_VAL(osci) &= ~BIT(RCU_BIT_POS(osci));
|
||||
|
||||
Reference in New Issue
Block a user