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,25 +35,37 @@ OF SUCH DAMAGE.
|
||||
#include "gd32c10x_adc.h"
|
||||
|
||||
/* discontinuous mode macro*/
|
||||
/** @brief ADC_CHANNEL_LENGTH_SUBTRACT_ONE 宏定义 */
|
||||
#define ADC_CHANNEL_LENGTH_SUBTRACT_ONE ((uint8_t)1U)
|
||||
|
||||
/* ADC regular channel macro */
|
||||
/** @brief ADC_REGULAR_CHANNEL_RANK_SIX 宏定义 */
|
||||
#define ADC_REGULAR_CHANNEL_RANK_SIX ((uint8_t)6U)
|
||||
/** @brief ADC_REGULAR_CHANNEL_RANK_TWELVE 宏定义 */
|
||||
#define ADC_REGULAR_CHANNEL_RANK_TWELVE ((uint8_t)12U)
|
||||
/** @brief ADC_REGULAR_CHANNEL_RANK_SIXTEEN 宏定义 */
|
||||
#define ADC_REGULAR_CHANNEL_RANK_SIXTEEN ((uint8_t)16U)
|
||||
/** @brief ADC_REGULAR_CHANNEL_RANK_LENGTH 宏定义 */
|
||||
#define ADC_REGULAR_CHANNEL_RANK_LENGTH ((uint8_t)5U)
|
||||
|
||||
/* ADC sampling time macro */
|
||||
/** @brief ADC_CHANNEL_SAMPLE_TEN 宏定义 */
|
||||
#define ADC_CHANNEL_SAMPLE_TEN ((uint8_t)10U)
|
||||
/** @brief ADC_CHANNEL_SAMPLE_EIGHTEEN 宏定义 */
|
||||
#define ADC_CHANNEL_SAMPLE_EIGHTEEN ((uint8_t)18U)
|
||||
/** @brief ADC_CHANNEL_SAMPLE_LENGTH 宏定义 */
|
||||
#define ADC_CHANNEL_SAMPLE_LENGTH ((uint8_t)3U)
|
||||
|
||||
/* ADC inserted channel macro */
|
||||
/** @brief ADC_INSERTED_CHANNEL_RANK_LENGTH 宏定义 */
|
||||
#define ADC_INSERTED_CHANNEL_RANK_LENGTH ((uint8_t)5U)
|
||||
/** @brief ADC_INSERTED_CHANNEL_SHIFT_LENGTH 宏定义 */
|
||||
#define ADC_INSERTED_CHANNEL_SHIFT_LENGTH ((uint8_t)15U)
|
||||
|
||||
/* ADC inserted channel offset macro */
|
||||
/** @brief ADC_OFFSET_LENGTH 宏定义 */
|
||||
#define ADC_OFFSET_LENGTH ((uint8_t)3U)
|
||||
/** @brief ADC_OFFSET_SHIFT_LENGTH 宏定义 */
|
||||
#define ADC_OFFSET_SHIFT_LENGTH ((uint8_t)4U)
|
||||
|
||||
/*!
|
||||
@@ -97,6 +109,11 @@ void adc_deinit(uint32_t adc_periph)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_mode_config 函数
|
||||
* @param[in] mode 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_mode_config(uint32_t mode)
|
||||
{
|
||||
ADC_CTL0(ADC0) &= ~(ADC_CTL0_SYNCM);
|
||||
@@ -286,6 +303,14 @@ void adc_resolution_config(uint32_t adc_periph , uint32_t resolution)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_oversample_mode_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] mode 参数
|
||||
* @param[in] shift 参数
|
||||
* @param[in] ratio 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_oversample_mode_config(uint32_t adc_periph, uint32_t mode, uint16_t shift, uint8_t ratio)
|
||||
{
|
||||
if(ADC_OVERSAMPLING_ONE_CONVERT == mode){
|
||||
@@ -357,6 +382,13 @@ void adc_dma_mode_disable(uint32_t adc_periph)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_discontinuous_mode_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] adc_channel_group 参数
|
||||
* @param[in] length 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_discontinuous_mode_config(uint32_t adc_periph, uint8_t adc_channel_group, uint8_t length)
|
||||
{
|
||||
/* disable discontinuous mode of regular & inserted channel */
|
||||
@@ -393,6 +425,13 @@ void adc_discontinuous_mode_config(uint32_t adc_periph, uint8_t adc_channel_grou
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_channel_length_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] adc_channel_group 参数
|
||||
* @param[in] length 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_channel_length_config(uint32_t adc_periph, uint8_t adc_channel_group, uint32_t length)
|
||||
{
|
||||
switch(adc_channel_group){
|
||||
@@ -431,6 +470,14 @@ void adc_channel_length_config(uint32_t adc_periph, uint8_t adc_channel_group, u
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_regular_channel_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] rank 参数
|
||||
* @param[in] adc_channel 参数
|
||||
* @param[in] sample_time 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_regular_channel_config(uint32_t adc_periph , uint8_t rank , uint8_t adc_channel , uint32_t sample_time)
|
||||
{
|
||||
uint32_t rsq,sampt;
|
||||
@@ -499,6 +546,14 @@ void adc_regular_channel_config(uint32_t adc_periph , uint8_t rank , uint8_t adc
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_inserted_channel_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] rank 参数
|
||||
* @param[in] adc_channel 参数
|
||||
* @param[in] sample_time 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_inserted_channel_config(uint32_t adc_periph , uint8_t rank , uint8_t adc_channel , uint32_t sample_time)
|
||||
{
|
||||
uint8_t inserted_length;
|
||||
@@ -544,6 +599,13 @@ void adc_inserted_channel_config(uint32_t adc_periph , uint8_t rank , uint8_t ad
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_inserted_channel_offset_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] inserted_channel 参数
|
||||
* @param[in] offset 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_inserted_channel_offset_config(uint32_t adc_periph , uint8_t inserted_channel , uint16_t offset)
|
||||
{
|
||||
uint8_t inserted_length;
|
||||
@@ -592,6 +654,13 @@ void adc_inserted_channel_offset_config(uint32_t adc_periph , uint8_t inserted_c
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_external_trigger_source_config 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] adc_channel_group 参数
|
||||
* @param[in] external_trigger_source 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_external_trigger_source_config(uint32_t adc_periph, uint8_t adc_channel_group, uint32_t external_trigger_source)
|
||||
{
|
||||
switch(adc_channel_group){
|
||||
@@ -817,6 +886,12 @@ void adc_watchdog_threshold_config(uint32_t adc_periph , uint16_t low_threshold
|
||||
\param[out] none
|
||||
\retval FlagStatus: SET or RESET
|
||||
*/
|
||||
/**
|
||||
* @brief adc_flag_get 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] adc_flag 参数
|
||||
* @return FlagStatus 返回值
|
||||
*/
|
||||
FlagStatus adc_flag_get(uint32_t adc_periph , uint32_t adc_flag)
|
||||
{
|
||||
FlagStatus reval = RESET;
|
||||
@@ -839,6 +914,12 @@ FlagStatus adc_flag_get(uint32_t adc_periph , uint32_t adc_flag)
|
||||
\param[out] none
|
||||
\retval none
|
||||
*/
|
||||
/**
|
||||
* @brief adc_flag_clear 函数
|
||||
* @param[in] adc_periph 参数
|
||||
* @param[in] adc_flag 参数
|
||||
* @return void
|
||||
*/
|
||||
void adc_flag_clear(uint32_t adc_periph , uint32_t adc_flag)
|
||||
{
|
||||
ADC_STAT(adc_periph) &= ~((uint32_t)adc_flag);
|
||||
|
||||
Reference in New Issue
Block a user