diff --git a/source/hal/driver/common/template/vsf_template_adc.h b/source/hal/driver/common/template/vsf_template_adc.h index 470df5d15..e40db6dcc 100644 --- a/source/hal/driver/common/template/vsf_template_adc.h +++ b/source/hal/driver/common/template/vsf_template_adc.h @@ -90,8 +90,8 @@ extern "C" { # define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_ADC_CFG_INHERT_HAL_CAPABILITY -# define VSF_ADC_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_ADC_CFG_INHERIT_HAL_CAPABILITY +# define VSF_ADC_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -246,7 +246,7 @@ typedef struct vsf_adc_status_t { #if VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_adc_capability_t { -#if VSF_ADC_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_ADC_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_adc_irq_mask_t irq_mask; @@ -301,7 +301,6 @@ extern vsf_err_t vsf_adc_init(vsf_adc_t *adc_ptr, vsf_adc_cfg_t *cfg_ptr); \~chinese @brief 终止一个 adc 实例 @param[in] adc_ptr: 结构体 vsf_adc_t 的指针，参考 @ref vsf_adc_t - @param[in] cfg_ptr: 结构体 vsf_adc_cfg_t 的指针，参考 @ref vsf_adc_cfg_t @return 无。 */ extern void vsf_adc_fini(vsf_adc_t *adc_ptr); @@ -418,7 +417,7 @@ extern vsf_err_t vsf_adc_channel_request_once(vsf_adc_t *adc_ptr, @brief adc channel configuration @param[in] adc_ptr: a pointer to structure @ref vsf_adc_t @param[in] channel_cfgs_ptr: sampling channel configuration array - @param[in] channel_cfgs_ptr: the length of sampling channel configuration array + @param[in] channel_cfgs_cnt: the length of sampling channel configuration array @param[in] buffer_ptr: data buffer @return vsf_err_t: VSF_ERR_NONE if the adc request was successfully, or a negative error code @@ -443,10 +442,10 @@ extern vsf_err_t vsf_adc_channel_config(vsf_adc_t *adc_ptr, @return vsf_err_t: VSF_ERR_NONE if the adc request was successfully, or a negative error code \~chinese - @brief adc通道配置 + @brief adc通道请求 @param[in] adc_ptr: 结构体 vsf_adc_t 的指针，参考 @ref vsf_adc_t - @param[out] buffer_ptr: 采样通道配置数据数组 - @param[in] count: 采样通道配置数据数组的长度 + @param[out] buffer_ptr: 采样通道数据数组 + @param[in] count: 采样通道数据数组的长度 @return vsf_err_t: 如果 adc 请求成功返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_adc_channel_request(vsf_adc_t *adc_ptr, diff --git a/source/hal/driver/common/template/vsf_template_dac.h b/source/hal/driver/common/template/vsf_template_dac.h index 964939140..778cffe8f 100644 --- a/source/hal/driver/common/template/vsf_template_dac.h +++ b/source/hal/driver/common/template/vsf_template_dac.h @@ -82,8 +82,8 @@ extern "C" { # define VSF_DAC_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_DAC_CFG_INHERT_HAL_CAPABILITY -# define VSF_DAC_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_DAC_CFG_INHERIT_HAL_CAPABILITY +# define VSF_DAC_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -152,7 +152,7 @@ typedef struct vsf_dac_status_t { #if VSF_DAC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_dac_capability_t { -#if VSF_DAC_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_DAC_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_dac_irq_mask_t irq_mask; @@ -349,9 +349,9 @@ extern vsf_err_t vsf_dac_channel_config(vsf_dac_t *dac_ptr, @return vsf_err_t: VSF_ERR_NONE if the dac request was successfully, or a negative error code \~chinese - @brief dac 通道配置 + @brief dac 通道请求 @param[in] dac_ptr: 结构体 vsf_dac_t 的指针，参考 @ref vsf_dac_t - @param[out] buffer_ptr: 转换通道配置数据数组 + @param[out] buffer_ptr: 转换通道数据数组 @param[in] count: 转换通道配置数据数组的长度 @return vsf_err_t: 如果 dac 请求成功返回 VSF_ERR_NONE , 否则返回负数。 */ diff --git a/source/hal/driver/common/template/vsf_template_dma.h b/source/hal/driver/common/template/vsf_template_dma.h index 03d0b284b..cffb061c3 100644 --- a/source/hal/driver/common/template/vsf_template_dma.h +++ b/source/hal/driver/common/template/vsf_template_dma.h @@ -82,8 +82,8 @@ extern "C" { # define VSF_DMA_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_DMA_CFG_INHERT_HAL_CAPABILITY -# define VSF_DMA_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_DMA_CFG_INHERIT_HAL_CAPABILITY +# define VSF_DMA_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -138,7 +138,7 @@ typedef enum vsf_dma_channel_mode_t { VSF_DMA_SRC_BURST_LENGTH_16 = (0x04 << 14), VSF_DMA_SRC_BURST_LENGTH_32 = (0x05 << 14), VSF_DMA_SRC_BURST_LENGTH_64 = (0x05 << 14), - VSF_DMA_SRC_BURST_LENGTH_128 = (0x05 << 14), + VSF_DMA_SRC_BURST_LENGTH_128 = (0x06 << 14), VSF_DMA_DST_BURST_LENGTH_1 = (0x00 << 18), VSF_DMA_DST_BURST_LENGTH_2 = (0x01 << 18), @@ -147,11 +147,11 @@ typedef enum vsf_dma_channel_mode_t { VSF_DMA_DST_BURST_LENGTH_16 = (0x04 << 18), VSF_DMA_DST_BURST_LENGTH_32 = (0x05 << 18), VSF_DMA_DST_BURST_LENGTH_64 = (0x05 << 18), - VSF_DMA_DST_BURST_LENGTH_128 = (0x05 << 18), + VSF_DMA_DST_BURST_LENGTH_128 = (0x06 << 18), //prio VSF_DMA_PRIOPIRY_LOW = (0x00 << 22), - VSF_DMA_PRIOPIRY_MIDIUM = (0x01 << 22), + VSF_DMA_PRIOPIRY_MEDIUM = (0x01 << 22), VSF_DMA_PRIOPIRY_HIGH = (0x02 << 22), VSF_DMA_PRIOPIRY_VERY_HIGH = (0x03 << 22), @@ -214,7 +214,7 @@ enum { VSF_DMA_PRIOPIRY_COUNT = 4, VSF_DMA_PRIOPIRY_MASK = VSF_DMA_PRIOPIRY_LOW | - VSF_DMA_PRIOPIRY_MIDIUM | + VSF_DMA_PRIOPIRY_MEDIUM | VSF_DMA_PRIOPIRY_HIGH | VSF_DMA_PRIOPIRY_VERY_HIGH, @@ -279,7 +279,7 @@ typedef struct vsf_dma_channel_status_t { #if VSF_DMA_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_dma_capability_t { -#if VSF_DMA_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_DMA_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_dma_irq_mask_t irq_mask; diff --git a/source/hal/driver/common/template/vsf_template_flash.h b/source/hal/driver/common/template/vsf_template_flash.h index 153580d36..6eca66642 100644 --- a/source/hal/driver/common/template/vsf_template_flash.h +++ b/source/hal/driver/common/template/vsf_template_flash.h @@ -84,8 +84,8 @@ extern "C" { # define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_FLASH_CFG_INHERT_HAL_CAPABILITY -# define VSF_FLASH_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY +# define VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -162,7 +162,7 @@ typedef struct vsf_flash_status_t { #if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_flash_capability_t { -#if VSF_FLASH_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_flash_irq_mask_t irq_mask; @@ -269,7 +269,7 @@ extern fsm_rt_t vsf_flash_disable(vsf_flash_t *flash_ptr); \~chinese @brief 获取 flash 实例的状态 @param[in] flash_ptr: 结构体 vsf_flash_t 的指针，参考 @ref vsf_flash_t - @return vsf_flash_status_t: 返回当前 flash 的所有能力 @ref vsf_flash_status_t + @return vsf_flash_status_t: 返回当前 flash 的所有状态 @ref vsf_flash_status_t */ extern vsf_flash_status_t vsf_flash_status(vsf_flash_t *flash_ptr); @@ -330,7 +330,7 @@ extern void vsf_flash_irq_disable(vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t i \~chinese @brief flash 擦除一块扇区 @param[in] flash_ptr: 结构体 vsf_flash_t 的指针，参考 @ref vsf_flash_t - @param[in] offset_of_bytes: 被除扇区的地址，需要是最小可擦除扇区的整数倍 + @param[in] offset_of_bytes: 被擦除扇区的地址，需要是最小可擦除扇区的整数倍 @return 如果 flash 开始执行擦除返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_flash_erase_one_sector(vsf_flash_t *flash_ptr, @@ -383,9 +383,9 @@ extern vsf_err_t vsf_flash_erase_all(vsf_flash_t *flash_ptr); \~chinese @brief flash 写一个扇区 @param[in] flash_ptr: 结构体 vsf_flash_t 的指针，参考 @ref vsf_flash_t - @param[in] offset_of_bytes: 被写入扇区的地址, 部分 flash 需要是最小可擦除扇区大小的整数倍 + @param[in] offset_of_bytes: 被写入扇区的地址, 部分 flash 需要是最小可写入扇区大小的整数倍 @param[in] buffer: 数据的指针 - @param[in] size_of_bytes: 被写入扇区的长度，部分 flash 需要是最小可擦除扇区大小的整数倍 + @param[in] size_of_bytes: 被写入扇区的长度，部分 flash 需要是最小可写入扇区大小的整数倍 @return 如果 flash 开始执行写入返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_flash_write_one_sector(vsf_flash_t *flash_ptr, @@ -429,9 +429,9 @@ extern vsf_err_t vsf_flash_write_multi_sector(vsf_flash_t *flash_ptr, \~chinese @brief flash 读一个扇区 @param[in] flash_ptr: 结构体 vsf_flash_t 的指针，参考 @ref vsf_flash_t - @param[in] offset_of_bytes: 被读入扇区的地址, 部分 flash 需要是最小可擦除扇区大小的整数倍 + @param[in] offset_of_bytes: 被读入扇区的地址, 部分 flash 需要是最小可读入扇区大小的整数倍 @param[in] buffer: 数据的指针 - @param[in] size_of_bytes: 被读入扇区的长度，部分 flash 需要是最小可擦除扇区大小的整数倍 + @param[in] size_of_bytes: 被读入扇区的长度，部分 flash 需要是最小可读入扇区大小的整数倍 @return 如果 flash 开始执行读入返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_flash_read_one_sector(vsf_flash_t *flash_ptr, diff --git a/source/hal/driver/common/template/vsf_template_gpio.h b/source/hal/driver/common/template/vsf_template_gpio.h index b18e2a983..452cfbe69 100644 --- a/source/hal/driver/common/template/vsf_template_gpio.h +++ b/source/hal/driver/common/template/vsf_template_gpio.h @@ -196,8 +196,8 @@ extern "C" { #endif -#ifndef VSF_GPIO_CFG_INHERT_HAL_CAPABILITY -# define VSF_GPIO_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY +# define VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif #ifndef vsf_gpio_pin_mask_t @@ -440,7 +440,7 @@ typedef struct vsf_gpio_port_cfg_pins_t { #if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_gpio_capability_t { -#if VSF_GPIO_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif //! Asynchronous GPIO @@ -611,7 +611,6 @@ typedef enum vsf_io_port_pin_no_t { @param[in] cfg: a pointer to structure @ref vsf_gpio_cfg_t @return vsf_err_t: VSF_ERR_NONE if GPIO Configuration Successful, or a negative error code - \~chinese @brief 配置 gpio 实例的一个或者多个引脚 @param[in] gpio_ptr: 结构体 vsf_gpio_t 的指针，参考 @ref vsf_gpio_t @@ -699,7 +698,7 @@ extern vsf_gpio_pin_mask_t vsf_gpio_get_direction(vsf_gpio_t *gpio_ptr, \~english @brief Set the direction of one or more pins of the gpio instance to input @param[in] gpio_ptr: a pointer to structure @ref vsf_gpio_t - @param[in] Pin mask, each pin corresponds to one bit, the value of the bit 1 + @param[in] pin_mask: pin mask, each pin corresponds to one bit, the value of the bit 1 indicates the need to set to input \~chinese @@ -713,7 +712,7 @@ extern void vsf_gpio_set_input(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mas \~english @brief Set the direction of one or more pins of the gpio instance to output @param[in] gpio_ptr: a pointer to structure @ref vsf_gpio_t - @param[in] Pin mask, each pin corresponds to one bit, the value of the bit 1 + @param[in] pin_mask: pin mask, each pin corresponds to one bit, the value of the bit 1 indicates the need to set to output \~chinese @@ -727,7 +726,7 @@ extern void vsf_gpio_set_output(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_ma \~english @brief Toggle the orientation of one or more pins of a gpio instance @param[in] gpio_ptr: a pointer to structure @ref vsf_gpio_t - @param[in] Pin mask, each pin corresponds to one bit, the value of the bit 1 + @param[in] pin_mask: pin mask, each pin corresponds to one bit, the value of the bit 1 indicates the need to set to output \~chinese @@ -754,7 +753,7 @@ extern vsf_gpio_pin_mask_t vsf_gpio_read(vsf_gpio_t *gpio_ptr); \~english @brief set the value of one or more of the gpio instances @param[in] gpio_ptr: pointer to the structure vsf_gpio_t, refer to @ref vsf_gpio_t - @param[in] value: value of the pin, each pin corresponds to a bit, 1 means high, 0 means high + @param[in] value: value of the pin, each pin corresponds to a bit, 1 means high, 0 means low @param[in] pin_mask: pin mask, each pin corresponds to one bit, 1 means the bit needs to be written, 0 means the bit does not need to be updated @@ -762,7 +761,7 @@ extern vsf_gpio_pin_mask_t vsf_gpio_read(vsf_gpio_t *gpio_ptr); @brief 设置 gpio 实例的一个或者多个的值 @param[in] gpio_ptr: 结构体 vsf_gpio_t 的指针，参考 @ref vsf_gpio_t @param[in] pin_mask: 引脚掩码，每一个引脚对应一个位，1表示该位需要写入，0表示该位不需要更新 - @param[in] value: 引脚的值，每一个引脚对应一个位，1 表示高电平，0 表示高电平 + @param[in] value: 引脚的值，每一个引脚对应一个位，1 表示高电平，0 表示低电平 */ extern void vsf_gpio_write(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_pin_mask_t value); @@ -818,7 +817,7 @@ extern void vsf_gpio_toggle(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask); @note This API can be used when modifying the IO direction to output and set to high in order to avoid possible pulses. Note that it is not supported by all hardware. You can get if this mode is supported with vsf_gpio_capability() - (is_support_output_and_set) + (support_output_and_set) \~chinese @brief 设置 gpio 实例的一个或者多个引脚的方向为输出高电平 @@ -826,7 +825,7 @@ extern void vsf_gpio_toggle(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask); @param[in] pin_mask: 引脚掩码，每一个引脚对应一个位，1表示该位需要写入，0表示该位不需要更新 @note 修改IO方向为输出并且设置成高电平的时候，为了避免可能的脉冲，可以使用这个API。 需要注意的是，并不是所有硬件都支持。可以通过 vsf_gpio_capability() 获取是否支持该特性 - （ is_support_output_and_set ） + (support_output_and_set) */ extern void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask); @@ -839,7 +838,7 @@ extern void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pi @note This API can be used when modifying the IO direction to output and set to low in order to avoid possible pulses. Note that it is not supported by all hardware. You can get if this mode is supported with vsf_gpio_capability() - (is_support_output_and_set) + (support_output_and_clear) \~chinese @brief 设置 gpio 实例的一个或者多个引脚的方向为输出低电平 @@ -847,7 +846,7 @@ extern void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pi @param[in] pin_mask: 引脚掩码，每一个引脚对应一个位，1表示该位需要写入，0表示该位不需要更新 @note 修改IO方向为输出并且设置成低电平的时候，为了避免可能的脉冲，可以使用这个API。 需要注意的是，并不是所有硬件都支持。可以通过 vsf_gpio_capability() 获取是否支持该特性 - （ is_support_output_and_set ） + (support_output_and_clear) */ extern void vsf_gpio_output_and_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask); diff --git a/source/hal/driver/common/template/vsf_template_i2c.h b/source/hal/driver/common/template/vsf_template_i2c.h index d88e295c2..b52071738 100644 --- a/source/hal/driver/common/template/vsf_template_i2c.h +++ b/source/hal/driver/common/template/vsf_template_i2c.h @@ -77,6 +77,12 @@ extern "C" { # define VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS DISABLED #endif +//! In the specific hardware driver, we can enable +//! VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL to redefine vsf_i2c_ctrl_t as needed. +#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL +# define VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL DISABLED +#endif + //! Redefine struct vsf_i2c_cfg_t. The vsf_i2c_isr_handler_t type also needs to //! be redefined For compatibility, members should not be deleted when struct //! @ref vsf_i2c_cfg_t redefining. @@ -92,8 +98,8 @@ extern "C" { #endif -#ifndef VSF_I2C_CFG_INHERT_HAL_CAPABILITY -# define VSF_I2C_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_I2C_CFG_INHERIT_HAL_CAPABILITY +# define VSF_I2C_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -107,8 +113,17 @@ extern "C" { __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, i2c, irq_disable, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask) \ __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_i2c_status_t, i2c, status, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr) \ __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_i2c_capability_t, i2c, capability, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr) \ - __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, uint_fast32_t, i2c, get_transferred_count, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr) \ - __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, master_request, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, uint16_t address, vsf_i2c_cmd_t cmd, uint16_t count, uint8_t* buffer_ptr) + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, uint_fast32_t, i2c, master_get_transferred_count, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, master_fifo_transfer, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, uint16_t address, \ + vsf_i2c_cmd_t cmd, uint16_t count, uint8_t* buffer_ptr, vsf_i2c_cmd_t *cur_cmd_ptr, uint16_t *offset_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, master_request, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, uint16_t address, \ + vsf_i2c_cmd_t cmd, uint16_t count, uint8_t* buffer_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, uint_fast32_t, i2c, slave_get_transferred_count, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, slave_fifo_transfer, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, bool transmit_or_receive, \ + uint16_t count, uint8_t* buffer_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, slave_request, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, bool transmit_or_receive, \ + uint16_t count, uint8_t* buffer_ptr) \ + __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, i2c, ctrl, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, vsf_i2c_ctrl_t ctrl, void* param) /*============================ TYPES =========================================*/ @@ -155,11 +170,8 @@ typedef enum vsf_i2c_cmd_t { VSF_I2C_CMD_READ = (0x01ul << 0), VSF_I2C_CMD_START = (0x00ul << 28), - VSF_I2C_CMD_NO_START = (0x01ul << 28), - VSF_I2C_CMD_STOP = (0x00ul << 29), VSF_I2C_CMD_RESTART = (0x01ul << 30), - VSF_I2C_CMD_NO_STOP_RESTART = (0x01ul << 30), VSF_I2C_CMD_7_BITS = (0x00ul << 31), VSF_I2C_CMD_10_BITS = (0x01ul << 31), @@ -174,14 +186,6 @@ enum { VSF_I2C_CMD_BITS_MASK = VSF_I2C_CMD_7_BITS | VSF_I2C_CMD_10_BITS, - VSF_I2C_CMD_START_COUNT = 2, - VSF_I2C_CMD_START_MASK = VSF_I2C_CMD_START | VSF_I2C_CMD_NO_START, - - VSF_I2C_CMD_STOP_RESTART_COUNT = 3, - VSF_I2C_CMD_STOP_RESTART_MASK = VSF_I2C_CMD_STOP - | VSF_I2C_CMD_RESTART - | VSF_I2C_CMD_NO_STOP_RESTART, - VSF_I2C_CMD_MASK_COUNT = 5, VSF_I2C_CMD_ALL_BITS_MASK = VSF_I2C_CMD_RW_MASK | VSF_I2C_CMD_START @@ -192,16 +196,30 @@ enum { #if VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED typedef enum vsf_i2c_irq_mask_t { + // issued if VSF_I2C_CMD_START is set in cmd for vsf_i2c_master_request VSF_I2C_IRQ_MASK_MASTER_STARTED = (0x1ul << 0), + // issued if VSF_I2C_CMD_STOP is set in cmd for vsf_i2c_master_request VSF_I2C_IRQ_MASK_MASTER_STOPPED = (0x1ul << 1), - VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT = (0x1ul << 2), // for multi master - VSF_I2C_IRQ_MASK_MASTER_NACK_DETECT = (0x1ul << 4), - VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST = (0x1ul << 5), - VSF_I2C_IRQ_MASK_MASTER_TX_EMPTY = (0x1ul << 6), - VSF_I2C_IRQ_MASK_MASTER_ERROR = (0x1ul << 7), - - VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE = (0x1ul << 8), - VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK = (0x1ul << 9), + // TX/RX reach fifo threshold, threshold on some devices is bound to 1 + VSF_I2C_IRQ_MASK_MASTER_TX = (0x1ul << 2), + VSF_I2C_IRQ_MASK_MASTER_RX = (0x1ul << 3), + VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE = (0x1ul << 4), + // Hardware detects STOP signal (useful for multiple master) + VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT = (0x1ul << 5), + VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST = (0x1ul << 6), + VSF_I2C_IRQ_MASK_MASTER_NACK_DETECT = (0x1ul << 7), + VSF_I2C_IRQ_MASK_MASTER_ERR = (0x1ul << 8), + + VSF_I2C_IRQ_MASK_SLAVE_ADDRESS_WRITE = (0x1ul << 9), + VSF_I2C_IRQ_MASK_SLAVE_ADDRESS_READ = (0x1ul << 10), + VSF_I2C_IRQ_MASK_SLAVE_START_DETECT = (0x1ul << 11), + VSF_I2C_IRQ_MASK_SLAVE_RESTART_DETECT = (0x1ul << 12), + VSF_I2C_IRQ_MASK_SLAVE_STOP_DETECT = (0x1ul << 13), + // TX/RX reach fifo threshold, threshold on some devices is bound to 1 + VSF_I2C_IRQ_MASK_SLAVE_TX = (0x1ul << 14), + VSF_I2C_IRQ_MASK_SLAVE_RX = (0x1ul << 15), + VSF_I2C_IRQ_MASK_SLAVE_TRANSFER_COMPLETE = (0x1ul << 16), + VSF_I2C_IRQ_MASK_SLAVE_ERR = (0x1ul << 17), } vsf_i2c_irq_mask_t; #endif @@ -229,7 +247,7 @@ typedef struct vsf_i2c_status_t { #if VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_i2c_capability_t { -#if VSF_I2C_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_I2C_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_i2c_irq_mask_t irq_mask; @@ -301,7 +319,7 @@ typedef struct vsf_i2c_isr_t { void *target_ptr; //!< \~english pointer of user target //!< \~chinese 用户传入的指针 vsf_arch_prio_t prio; //!< \~english interrupt priority - //!< \~chinesh 中断优先级 + //!< \~chinese 中断优先级 } vsf_i2c_isr_t; /** @@ -323,6 +341,33 @@ typedef struct vsf_i2c_cfg_t { } vsf_i2c_cfg_t; #endif +#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED +/** + * \~english + * @brief Predefined VSF I2C control command that can be reimplemented in specific hal drivers. + * + * \~chinese + * @brief 预定义的 VSF I2C 控制命令，可以在具体的 HAL 驱动重新实现。 + * + */ +typedef enum vsf_i2c_ctrl_t { + /* + VSF_I2C_CTRL_MASTER_ABORT = (0x1ul << 3), + #define VSF_I2C_CTRL_MASTER_ABORT VSF_I2C_CTRL_MASTER_ABORT + VSF_I2C_CTRL_SLAVE_ABORT = (0x1ul << 4), + #define VSF_I2C_CTRL_SLAVE_ABORT VSF_I2C_CTRL_SLAVE_ABORT + + VSF_I2C_CTRL_ANALOG_FILTER = (0x1ul << 5) + #define VSF_I2C_CTRL_ANALOG_FILTER VSF_I2C_CTRL_ANALOG_FILTER + VSF_I2C_CTRL_DIGITAL_FILTER = (0x1ul << 6) + #define VSF_I2C_CTRL_DIGITAL_FILTER VSF_I2C_CTRL_DIGITAL_FILTER + */ + + // dummy for compile pass + __VSF_I2C_CTRL_DUMMP = 0, +} vsf_i2c_ctrl_t; +#endif + typedef struct vsf_i2c_op_t { #undef __VSF_HAL_TEMPLATE_API #define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP @@ -400,7 +445,7 @@ extern fsm_rt_t vsf_i2c_enable(vsf_i2c_t *i2c_ptr); is working without calling vsf_i2c_init() \~chinese - @brief禁能 i2c 实例 + @brief 禁能 i2c 实例 @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t @return fsm_rt_t: 如果禁能成功，返回 fsm_rt_cpl, 未完成初始化返回 fsm_rt_onging @note 需要确保在 vsf_i2c_disable() 之后调用 vsf_i2c_enable() 是可以正常工作的， @@ -429,7 +474,7 @@ extern void vsf_i2c_irq_enable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask); \~english @brief disable interrupt masks of i2c instance. @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t - @param[in] irq_mask: one or more value of enum vsf_i2c_irq_mask_t, @ref vsf_i2c_irq_mask_t + @param[in] irq_mask: one or more value of enum @ref vsf_i2c_irq_mask_t, @ref vsf_i2c_irq_mask_t @return none. \~chinese @@ -466,10 +511,62 @@ extern vsf_i2c_status_t vsf_i2c_status(vsf_i2c_t *i2c_ptr); */ extern vsf_i2c_capability_t vsf_i2c_capability(vsf_i2c_t *i2c_ptr); +/** + \~english + @brief i2c instance as master mode performs a FIFO transfer + @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t + @param[in] address: address of i2c transfer + @param[in] cmd: i2c cmd + @param[in] count: i2c transfer buffer count (in byte) + @param[in] buffer_ptr: i2c transfer buffer + @param[in] cur_cmd_ptr: i2c current cmd pointer, the caller needs to maintain the value + @param[in] offset_ptr: i2c current offset pointer, the caller needs to maintain the value + @return vsf_err_t: VSF_ERR_NONE if i2c was successfully, or a negative error code + + \~chinese + @brief i2c主机进行一次 FIFO 传输 + @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t + @param[in] address: i2c 传输的地址 + @param[in] cmd: i2c 命令 + @param[in] count: i2c 传输缓冲区长度 (单位：字节) + @param[in] buffer_ptr: i2c 传输缓冲区 + @param[in] cur_cmd_ptr: i2c 当前命令指针，调用者需要维护这个值 + @param[in] offset_ptr: i2c 当前偏移指针，调用者需要维护这个值 + @return vsf_err_t: 如果 i2c 主机请求成功完成返回 VSF_ERR_NONE , 否则返回负数。 + */ +extern vsf_err_t vsf_i2c_master_fifo_transfer(vsf_i2c_t *i2c_ptr, + uint16_t address, + vsf_i2c_cmd_t cmd, + uint16_t count, + uint8_t *buffer_ptr, + vsf_i2c_cmd_t *cur_cmd_ptr, + uint16_t *offset_ptr); + +/** + \~english + @brief i2c instance as slave mode performs a FIFO transfer + @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t + @param[in] transmit_or_receive: slave transmit if true, slave receive if false + @param[in] count: i2c transfer buffer count (in byte) + @param[in] buffer_ptr: i2c transfer buffer + @return vsf_err_t: VSF_ERR_NONE if i2c was successfully, or a negative error code + + \~chinese + @brief i2c从机进行一次 FIFO 传输 + @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t + @param[in] transmit_or_receive: true 表示从机发送数据，false 表示从机接收数据 + @param[in] count: i2c 传输缓冲区长度 (单位：字节) + @param[in] buffer_ptr: i2c 传输缓冲区 + @return vsf_err_t: 如果 i2c 从机请求成功完成返回 VSF_ERR_NONE , 否则返回负数。 + */ +extern vsf_err_t vsf_i2c_slave_fifo_transfer(vsf_i2c_t *i2c_ptr, + bool transmit_or_receive, + uint16_t count, + uint8_t *buffer_ptr); + /** \~english @brief i2c instance as master mode request a transfer - @note i2c_msg_ptr can be a local variable. @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t @param[in] address: address of i2c transfer @param[in] cmd: i2c cmd @@ -479,7 +576,6 @@ extern vsf_i2c_capability_t vsf_i2c_capability(vsf_i2c_t *i2c_ptr); \~chinese @brief i2c主机请求一次传输 - @note i2c_msg_ptr可以是局部变量。 @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t @param[in] address: i2c 传输的地址 @param[in] cmd: i2c 命令 @@ -495,7 +591,29 @@ extern vsf_err_t vsf_i2c_master_request(vsf_i2c_t *i2c_ptr, /** \~english - @brief get the counter of transfers for current request by the i2c master + @brief i2c instance as slave mode request a transfer + @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t + @param[in] transmit_or_receive: slave transmit if true, slave receive if false + @param[in] count: i2c transfer buffer count (in byte) + @param[in] buffer_ptr: i2c transfer buffer + @return vsf_err_t: VSF_ERR_NONE if i2c was successfully, or a negative error code + + \~chinese + @brief i2c从机请求一次传输 + @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t + @param[in] transmit_or_receive: true 表示从机发送数据，false 表示从机接收数据 + @param[in] count: i2c 传输缓冲区长度 (单位：字节) + @param[in] buffer_ptr: i2c 传输缓冲区 + @return vsf_err_t: 如果 i2c 从机请求成功完成返回 VSF_ERR_NONE , 否则返回负数。 + */ +extern vsf_err_t vsf_i2c_slave_request(vsf_i2c_t *i2c_ptr, + bool transmit_or_receive, + uint16_t count, + uint8_t *buffer_ptr); + +/** + \~english + @brief get the counter of transfers for current request by the i2c master @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t @return uint_fast32_t: counter of transferred @note This API can be used after the slave NAK and until the next transmission @@ -506,7 +624,38 @@ extern vsf_err_t vsf_i2c_master_request(vsf_i2c_t *i2c_ptr, @return uint_fast32_t: 已传输的数量 @note 在从机 NAK 的后到下一次传输之前都可以使用这个API */ -extern uint_fast32_t vsf_i2c_get_transferred_count(vsf_i2c_t *i2c_ptr); +extern uint_fast32_t vsf_i2c_master_get_transferred_count(vsf_i2c_t *i2c_ptr); + +/** + \~english + @brief get the counter of transfers for current request by the i2c slave + @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t + @return uint_fast32_t: counter of transferred + + \~chinese + @brief 获取 i2c 从机当前请求已经传输的数量 + @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t + @return uint_fast32_t: 已传输的数量 + */ +extern uint_fast32_t vsf_i2c_slave_get_transferred_count(vsf_i2c_t *i2c_ptr); + +/** + \~english + @brief Calls the specified i2c command + @param[in] i2c_ptr: a pointer to structure @ref vsf_i2c_t + @param[in] ctrl: i2c control command @ref vsf_i2c_ctrl_t. + @param[in] param: the parameter of the command, its use is determined by the command + @return vsf_err_t: returns the result of the i2c command when it is invoked, + success returns VSF_ERR_NONE + + \~chinese + @brief 调用指定的 i2c 命令 + @param[in] i2c_ptr: 结构体 vsf_i2c_t 的指针，参考 @ref vsf_i2c_t + @param[in] ctrl: i2c 控制命令，参考 @ref vsf_i2c_ctrl_t + @param[in] param: 命令的参数，其用途由命令决定 + @return vsf_err_t: 返回调用 i2c 命令的结果，成功返回 VSF_ERR_NONE + */ +extern vsf_err_t vsf_i2c_ctrl(vsf_i2c_t *i2c_ptr, vsf_i2c_ctrl_t ctrl, void * param); /*============================ INCLUDES ======================================*/ @@ -515,17 +664,22 @@ extern uint_fast32_t vsf_i2c_get_transferred_count(vsf_i2c_t *i2c_ptr); /*============================ MACROFIED FUNCTIONS ===========================*/ #if VSF_I2C_CFG_FUNCTION_RENAME == ENABLED -# define __vsf_i2c_t VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_t) -# define vsf_i2c_init(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_init) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) -# define vsf_i2c_fini(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_fini) ((__vsf_i2c_t *)(__I2C)) -# define vsf_i2c_enable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_enable) ((__vsf_i2c_t *)(__I2C)) -# define vsf_i2c_disable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_disable) ((__vsf_i2c_t *)(__I2C)) -# define vsf_i2c_irq_enable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_enable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) -# define vsf_i2c_irq_disable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_disable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) -# define vsf_i2c_status(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_status) ((__vsf_i2c_t *)(__I2C)) -# define vsf_i2c_capability(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_capability) ((__vsf_i2c_t *)(__I2C)) -# define vsf_i2c_master_request(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_request) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) -# define vsf_i2c_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_get_transferred_count) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define __vsf_i2c_t VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_t) +# define vsf_i2c_init(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_init) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_fini(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_fini) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_enable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_enable) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_disable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_disable) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_irq_enable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_enable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_irq_disable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_disable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_status(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_status) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_capability(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_capability) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_master_fifo_transfer(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_fifo_transfer) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_master_request(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_request) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_master_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_get_transferred_count) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_slave_fifo_transfer(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_slave_fifo_transfer) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_slave_request(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_slave_request) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) +# define vsf_i2c_slave_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_get_transferred_count) ((__vsf_i2c_t *)(__I2C)) +# define vsf_i2c_ctrl(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_ctrl) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__) #endif #ifdef __cplusplus diff --git a/source/hal/driver/common/template/vsf_template_i2s.h b/source/hal/driver/common/template/vsf_template_i2s.h index 2d324cba8..8b46cc974 100644 --- a/source/hal/driver/common/template/vsf_template_i2s.h +++ b/source/hal/driver/common/template/vsf_template_i2s.h @@ -83,8 +83,8 @@ extern "C" { # define VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_I2S_CFG_INHERT_HAL_CAPABILITY -# define VSF_I2S_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_I2S_CFG_INHERIT_HAL_CAPABILITY +# define VSF_I2S_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -179,7 +179,7 @@ typedef struct vsf_i2s_status_t { #if VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_i2s_capability_t { -#if VSF_I2S_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_I2S_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif struct { diff --git a/source/hal/driver/common/template/vsf_template_instance_declaration.h b/source/hal/driver/common/template/vsf_template_instance_declaration.h index 07c0263a7..6381f36cd 100644 --- a/source/hal/driver/common/template/vsf_template_instance_declaration.h +++ b/source/hal/driver/common/template/vsf_template_instance_declaration.h @@ -21,7 +21,7 @@ // #define VSF_HAL_TEMPLATE_DEC_NAME adc // #define VSF_HAL_TEMPLATE_DEC_UPCASE_NAME ADC -/**************************** prefex *******************************************/ +/**************************** prefix *******************************************/ #ifndef VSF_HAL_TEMPLATE_DEC_PREFIX # define VSF_HAL_TEMPLATE_DEC_PREFIX VSF_MCONNECT(VSF, VSF_HAL_TEMPLATE_DEC_UPCASE_NAME, _CFG_DEC_PREFIX) diff --git a/source/hal/driver/common/template/vsf_template_pm.h b/source/hal/driver/common/template/vsf_template_pm.h index 4b6744172..7900ee9f3 100644 --- a/source/hal/driver/common/template/vsf_template_pm.h +++ b/source/hal/driver/common/template/vsf_template_pm.h @@ -134,8 +134,8 @@ extern "C" { # define VSF_PM_CFG_REIMPLEMENT_TYPE_CLOCK_OUT_CFG DISABLED #endif -#ifndef VSF_PM_CFG_INHERT_HAL_CAPABILITY -# define VSF_PM_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_PM_CFG_INHERIT_HAL_CAPABILITY +# define VSF_PM_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -424,7 +424,7 @@ typedef struct vsf_pm_clock_out_cfg_t { #endif typedef struct vsf_pm_capability_t { -#if VSF_PM_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_PM_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif } vsf_pm_capability_t; diff --git a/source/hal/driver/common/template/vsf_template_pwm.h b/source/hal/driver/common/template/vsf_template_pwm.h index 12d0681cf..86e4f96f7 100644 --- a/source/hal/driver/common/template/vsf_template_pwm.h +++ b/source/hal/driver/common/template/vsf_template_pwm.h @@ -71,8 +71,8 @@ extern "C" { # define VSF_PWM_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_PWM_CFG_INHERT_HAL_CAPABILITY -# define VSF_PWM_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_PWM_CFG_INHERIT_HAL_CAPABILITY +# define VSF_PWM_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -99,7 +99,7 @@ typedef struct vsf_pwm_cfg_t { #if VSF_PWM_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_pwm_capability_t { -#if VSF_PWM_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_PWM_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif diff --git a/source/hal/driver/common/template/vsf_template_rng.h b/source/hal/driver/common/template/vsf_template_rng.h index ae3d4f634..09a160cd2 100644 --- a/source/hal/driver/common/template/vsf_template_rng.h +++ b/source/hal/driver/common/template/vsf_template_rng.h @@ -71,8 +71,8 @@ extern "C" { # define VSF_RNG_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_RNG_CFG_INHERT_HAL_CAPABILITY -# define VSF_RNG_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_RNG_CFG_INHERIT_HAL_CAPABILITY +# define VSF_RNG_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -90,7 +90,7 @@ typedef struct vsf_rng_t vsf_rng_t; typedef void vsf_rng_on_ready_callback_t(void *param, uint32_t *buffer, uint32_t num); typedef struct vsf_rng_capability_t { -#if VSF_RNG_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_RNG_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif } vsf_rng_capability_t; diff --git a/source/hal/driver/common/template/vsf_template_rtc.h b/source/hal/driver/common/template/vsf_template_rtc.h index fabffb8c4..9bbb8b730 100644 --- a/source/hal/driver/common/template/vsf_template_rtc.h +++ b/source/hal/driver/common/template/vsf_template_rtc.h @@ -79,8 +79,8 @@ extern "C" { # define VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_RTC_CFG_INHERT_HAL_CAPABILITY -# define VSF_RTC_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_RTC_CFG_INHERIT_HAL_CAPABILITY +# define VSF_RTC_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -141,7 +141,7 @@ typedef struct vsf_rtc_cfg_t { #if VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_rtc_capability_t { -#if VSF_RTC_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_RTC_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif diff --git a/source/hal/driver/common/template/vsf_template_sdio.h b/source/hal/driver/common/template/vsf_template_sdio.h index 37331f22f..02bae7617 100644 --- a/source/hal/driver/common/template/vsf_template_sdio.h +++ b/source/hal/driver/common/template/vsf_template_sdio.h @@ -83,8 +83,8 @@ extern "C" { # define VSF_SDIO_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_SDIO_CFG_INHERT_HAL_CAPABILITY -# define VSF_SDIO_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_SDIO_CFG_INHERIT_HAL_CAPABILITY +# define VSF_SDIO_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /* SD commands type argument response */ @@ -637,7 +637,7 @@ typedef struct vsf_sdio_status_t { #endif typedef struct vsf_sdio_capability_t { -#if VSF_SDIO_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_SDIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif enum { diff --git a/source/hal/driver/common/template/vsf_template_spi.h b/source/hal/driver/common/template/vsf_template_spi.h index 761f44d0c..ee015dd94 100644 --- a/source/hal/driver/common/template/vsf_template_spi.h +++ b/source/hal/driver/common/template/vsf_template_spi.h @@ -77,14 +77,20 @@ extern "C" { //! be redefined For compatibility, members should not be deleted when struct //! @ref vsf_spi_cfg_t redefining. #if VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG == DISABLED -# define VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG DISABLED +# define VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG DISABLED +#endif + +//! In the specific hardware driver, we can enable +//! VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL to redefine vsf_spi_ctrl_t as needed. +#ifndef VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL +# define VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL DISABLED #endif //! Redefine struct vsf_spi_capability_t. //! For compatibility, members should not be deleted when struct @ref //! vsf_spi_capability_t redefining. #if VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED -# define VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED +# define VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif //! In the specific hardware driver, we can enable @@ -108,30 +114,37 @@ extern "C" { # define VSF_SPI_CFG_REIMPLEMENT_DATA_BITS_TO_BYTES DISABLED #endif -#ifndef VSF_SPI_CFG_INHERT_HAL_CAPABILITY -# define VSF_SPI_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_SPI_CFG_INHERIT_HAL_CAPABILITY +# define VSF_SPI_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ #define VSF_SPI_APIS(__prefix_name) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, init, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, vsf_spi_cfg_t *cfg_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, fini, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, spi, enable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, spi, disable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, irq_enable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, vsf_spi_irq_mask_t irq_mask) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, irq_disable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, vsf_spi_irq_mask_t irq_mask) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_spi_status_t, spi, status, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_spi_capability_t, spi, capability, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, cs_active, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, uint_fast8_t index) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, cs_inactive, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, uint_fast8_t index) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, fifo_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ - void *out_buffer_ptr, uint_fast32_t *out_offset_ptr, \ - void *in_buffer_ptr, uint_fast32_t *in_offset_ptr, uint_fast32_t cnt) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, request_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, void *out_buffer_ptr, \ - void *in_buffer_ptr, uint_fast32_t count) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, cancel_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, get_transferred_count, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, uint_fast32_t * tx_count, uint_fast32_t *rx_count) + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, init, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + vsf_spi_cfg_t *cfg_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, fini, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, spi, enable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, spi, disable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, irq_enable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + vsf_spi_irq_mask_t irq_mask) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, irq_disable, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + vsf_spi_irq_mask_t irq_mask) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_spi_status_t, spi, status, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_spi_capability_t, spi, capability, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, cs_active, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + uint_fast8_t index) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, cs_inactive, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + uint_fast8_t index) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, fifo_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + void *out_buffer_ptr, uint_fast32_t *out_offset_ptr, void *in_buffer_ptr, uint_fast32_t *in_offset_ptr, uint_fast32_t cnt) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, request_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + void *out_buffer_ptr, void *in_buffer_ptr, uint_fast32_t count) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, cancel_transfer, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, spi, get_transferred_count, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + uint_fast32_t * tx_count, uint_fast32_t *rx_count) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, spi, ctrl, VSF_MCONNECT(__prefix_name, _spi_t) *spi_ptr, \ + vsf_spi_ctrl_t ctrl, void* param) /*============================ TYPES =========================================*/ @@ -315,12 +328,14 @@ typedef enum vsf_spi_mode_t { /* // Some hardware supports a different number of data line VSF_SPI_DATALINE_2_LINE_FULL_DUPLEX = (0x00ul << 16), // 2 line, full-duplex, standard spi - VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX = (0x01ul << 16), // 1 line, half-duplex - VSF_SPI_DATALINE_2_LINE_HALF_DUPLEX = (0x02ul << 16), // 2 line, half-duplex, dual spi - VSF_SPI_DATALINE_4_LINE_HALF_DUPLEX = (0x03ul << 16), // 4 line, half-duplex, qual spi - VSF_SPI_DATALINE_8_LINE_HALF_DUPLEX = (0x04ul << 16), // 8 line, half-duplex, octal spi + VSF_SPI_DATALINE_2_LINE_RX_ONLY = (0x01ul << 16), // 2 line, but rx only + VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX = (0x02ul << 16), // 1 line, half-duplex + VSF_SPI_DATALINE_2_LINE_HALF_DUPLEX = (0x03ul << 16), // 2 line, half-duplex, dual spi + VSF_SPI_DATALINE_4_LINE_HALF_DUPLEX = (0x04ul << 16), // 4 line, half-duplex, qual spi + VSF_SPI_DATALINE_8_LINE_HALF_DUPLEX = (0x05ul << 16), // 8 line, half-duplex, octal spi #define VSF_SPI_DATALINE_2_LINE_FULL_DUPLEX VSF_SPI_DATALINE_2_LINE_FULL_DUPLEX + #define VSF_SPI_DATALINE_2_LINE_RX_ONLY VSF_SPI_DATALINE_2_LINE_RX_ONLY #define VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX #define VSF_SPI_DATALINE_2_LINE_HALF_DUPLEX VSF_SPI_DATALINE_2_LINE_HALF_DUPLEX #define VSF_SPI_DATALINE_4_LINE_HALF_DUPLEX VSF_SPI_DATALINE_4_LINE_HALF_DUPLEX @@ -461,7 +476,6 @@ typedef enum vsf_spi_irq_mask_t { VSF_SPI_IRQ_MASK_CPL = 0x01ul << 3, VSF_SPI_IRQ_MASK_OVERFLOW_ERR = 0x01ul << 4, - VSF_SPI_IRQ_MASK_ERROR = 0x01ul << 5, } vsf_spi_irq_mask_t; #endif @@ -472,12 +486,15 @@ enum { //! For SPI transfers, send completion is definitely earlier than receive completion. VSF_SPI_IRQ_MASK_RX_CPL = VSF_SPI_IRQ_MASK_CPL, +#ifndef VSF_SPI_IRQ_MASK_ERR + VSF_SPI_IRQ_MASK_ERR = VSF_SPI_IRQ_MASK_OVERFLOW_ERR, +#endif + VSF_SPI_IRQ_ALL_BITS_MASK = VSF_SPI_IRQ_MASK_TX | VSF_SPI_IRQ_MASK_RX | VSF_SPI_IRQ_MASK_TX_CPL | VSF_SPI_IRQ_MASK_CPL - | VSF_SPI_IRQ_MASK_OVERFLOW_ERR - | VSF_SPI_IRQ_MASK_ERROR, + | VSF_SPI_IRQ_MASK_OVERFLOW_ERR, }; #if VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED @@ -493,7 +510,7 @@ typedef struct vsf_spi_status_t { #if VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_spi_capability_t { -#if VSF_SPI_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_SPI_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_spi_irq_mask_t irq_mask; @@ -530,6 +547,30 @@ typedef struct vsf_spi_cfg_t { } vsf_spi_cfg_t; #endif + +#if VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED +/** + * \~english + * @brief Predefined VSF SPI control command that can be reimplemented in specific hal drivers. + * + * \~chinese + * @brief 预定义的 VSF SPI 控制命令，可以在具体的 HAL 驱动重新实现。 + * + */ +typedef enum vsf_spi_ctrl_t { + /* + VSF_SPI_CTRL_REQUEST_PAUSE = (0x1ul << 0), + #define VSF_SPI_CTRL_REQUEST_PAUSE VSF_SPI_CTRL_REQUEST_PAUSE + + VSF_SPI_CTRL_REQUEST_RESUME = (0x1ul << 1), + #define VSF_SPI_CTRL_REQUEST_RESUME VSF_SPI_CTRL_REQUEST_RESUME + */ + + // dummy for compile pass + __VSF_SPI_CTRL_DUMMP = 0, +} vsf_spi_ctrl_t; +#endif + typedef struct vsf_spi_op_t { #undef __VSF_HAL_TEMPLATE_API #define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP @@ -569,7 +610,6 @@ extern vsf_err_t vsf_spi_init(vsf_spi_t *spi_ptr, vsf_spi_cfg_t *cfg_ptr); \~chinese @brief 终止一个 spi 实例 @param[in] spi_ptr: 结构体 vsf_spi_t 的指针，参考 @ref vsf_spi_t - @param[in] cfg_ptr: 结构体 vsf_spi_cfg_t 的指针，参考 @ref vsf_spi_cfg_t @return 无。 */ extern void vsf_spi_fini(vsf_spi_t *spi_ptr); @@ -578,12 +618,12 @@ extern void vsf_spi_fini(vsf_spi_t *spi_ptr); \~english @brief enable interrupt masks of spi instance. @param[in] spi_ptr: a pointer to structure @ref vsf_spi_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if spi was enabled, return FSM_RT_ON_GOING if spi wait for enable \~chinese @brief 使能 spi 实例的中断 @param[in] spi_ptr: 结构体 vsf_spi_t 的指针，参考 @ref vsf_spi_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 spi 已经使能，返回 FSM_RT_ON_GOING 如果 spi 等待使能 */ extern fsm_rt_t vsf_spi_enable(vsf_spi_t *spi_ptr); @@ -591,12 +631,12 @@ extern fsm_rt_t vsf_spi_enable(vsf_spi_t *spi_ptr); \~english @brief disable interrupt masks of spi instance. @param[in] spi_ptr: a pointer to structure @ref vsf_spi_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if spi was disabled, return FSM_RT_ON_GOING if spi wait for disable \~chinese @brief 禁能 spi 实例的中断 @param[in] spi_ptr: 结构体 vsf_spi_t 的指针，参考 @ref vsf_spi_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 spi 已经禁能，返回 FSM_RT_ON_GOING 如果 spi 等待禁能 */ extern fsm_rt_t vsf_spi_disable(vsf_spi_t *spi_ptr); @@ -744,12 +784,13 @@ extern vsf_err_t vsf_spi_request_transfer(vsf_spi_t *spi_ptr, void *out_buffer_p \~english @brief spi cancel transfer @param[in] spi_ptr: a pointer to structure @ref vsf_spi_t - @return vsf_err_t: VSF_ERR_NONE if spi cancel transfer successfully, or a negative error code + @return vsf_err_t: VSF_ERR_NONE if spi cancel transfer successfully, + VSF_ERR_NOT_READY if spi is not transmittingor, or a negative error code \~chinese @brief spi 取消传输 @param[in] spi_ptr: @ref vsf_spi_t 传输结构指针 - @return vsf_err_t: 如果 spi 取消传输成功返回 VSF_ERR_NONE, 否则返回负数 + @return vsf_err_t: 如果 spi 取消传输成功返回 VSF_ERR_NONE, 没有在传输返回 VSF_ERR_NOT_READY, 否则返回负数 */ extern vsf_err_t vsf_spi_cancel_transfer(vsf_spi_t *spi_ptr); @@ -757,18 +798,33 @@ extern vsf_err_t vsf_spi_cancel_transfer(vsf_spi_t *spi_ptr); \~english @brief spi get transferred counter @param[in] spi_ptr: a pointer to structure @ref vsf_spi_t - @param[out] send_count: a pointer to the number of spi data already sent + @param[out] sent_count: a pointer to the number of spi data already sent @param[out] received_count: a pointer to the number of spi data already received - @return vsf_err_t: VSF_ERR_NONE if spi cancel transfer successfully, or a negative error code \~chinese @brief spi 获取已传输的个数 @param[in] spi_ptr: @ref vsf_spi_t 传输结构指针 - @param[out] send_count: 已经发送的数据数量的指针 + @param[out] sent_count: 已经发送的数据数量的指针 @param[out] received_count: 已经接收的数据数量的指针 - @return vsf_err_t: 如果 spi 取消传输成功返回 VSF_ERR_NONE, 否则返回负数 */ -extern void vsf_spi_get_transferred_count(vsf_spi_t *spi_ptr, uint_fast32_t * sent_count, uint_fast32_t *received_count); +extern void vsf_spi_get_transferred_count(vsf_spi_t *spi_ptr, uint_fast32_t *sent_count, uint_fast32_t *received_count); + +/** + \~english + @brief Calls the specified spi command + @param[in] spi_ptr: a pointer to structure @ref vsf_spi_t + @param[in] ctrl: spi control command @ref vsf_spi_cmd_t. + @param[in] param: the parameter of the command, its use is determined by the command + @return vsf_err_t: returns the result of the spi command when it is invoked, + success returns VSF_ERR_NONE + + \~chinese + @brief 获取 spi 实例的状态 + @param[in] spi_ptr: 结构体 vsf_spi_t 的指针，参考 @ref vsf_spi_t + @param[in] ctrl: spi 控制命令，参考 @ref vsf_spi_cmd_t + @return vsf_err_t: 返回当调用 uart 命令的结果，成功返回 VSF_ERR_NONE + */ +extern vsf_err_t vsf_spi_ctrl(vsf_spi_t *spi_ptr, vsf_spi_ctrl_t ctrl, void * param); /*============================ INLINE FUNCTIONS ==============================*/ @@ -1059,7 +1115,8 @@ static inline uint8_t vsf_spi_mode_to_data_bytes(vsf_spi_mode_t mode) # define vsf_spi_fifo_transfer(__SPI, ...) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_fifo_transfer) ((__vsf_spi_t *)(__SPI), ##__VA_ARGS__) # define vsf_spi_request_transfer(__SPI, ...) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_request_transfer) ((__vsf_spi_t *)(__SPI), ##__VA_ARGS__) # define vsf_spi_cancel_transfer(__SPI) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_cancel_transfer) ((__vsf_spi_t *)(__SPI)) -# define vsf_spi_get_transferred_count(__SPI, ...) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_get_transferred_count) ((__vsf_spi_t *)(__SPI), ##__VA_ARGS__) +# define vsf_spi_get_transferred_count(__SPI, ...) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_get_transferred_count)((__vsf_spi_t *)(__SPI), ##__VA_ARGS__) +# define vsf_spi_ctrl(__SPI, ...) VSF_MCONNECT(VSF_SPI_CFG_PREFIX, _spi_ctrl) ((__vsf_spi_t *)(__SPI), ##__VA_ARGS__) #endif #ifdef __cplusplus diff --git a/source/hal/driver/common/template/vsf_template_timer.h b/source/hal/driver/common/template/vsf_template_timer.h index 6dc0c0083..1ada2c20e 100644 --- a/source/hal/driver/common/template/vsf_template_timer.h +++ b/source/hal/driver/common/template/vsf_template_timer.h @@ -31,97 +31,98 @@ extern "C" { // multi-class support enabled by default for maximum availability. #ifndef VSF_TIMER_CFG_MULTI_CLASS -# define VSF_TIMER_CFG_MULTI_CLASS ENABLED +# define VSF_TIMER_CFG_MULTI_CLASS ENABLED #endif #if defined(VSF_HW_TIMER_COUNT) && !defined(VSF_HW_TIMER_MASK) -# define VSF_HW_TIMER_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_TIMER_COUNT) +# define VSF_HW_TIMER_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_TIMER_COUNT) #endif #if defined(VSF_HW_TIMER_MASK) && !defined(VSF_HW_TIMER_COUNT) -# define VSF_HW_TIMER_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_TIMER_MASK) +# define VSF_HW_TIMER_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_TIMER_MASK) #endif // application code can redefine it #ifndef VSF_TIMER_CFG_PREFIX # if VSF_TIMER_CFG_MULTI_CLASS == ENABLED -# define VSF_TIMER_CFG_PREFIX vsf +# define VSF_TIMER_CFG_PREFIX vsf # elif defined(VSF_HW_TIMER_COUNT) && (VSF_HW_TIMER_COUNT != 0) -# define VSF_TIMER_CFG_PREFIX vsf_hw +# define VSF_TIMER_CFG_PREFIX vsf_hw # else -# define VSF_TIMER_CFG_PREFIX vsf +# define VSF_TIMER_CFG_PREFIX vsf # endif #endif #ifndef VSF_TIMER_CFG_FUNCTION_RENAME -# define VSF_TIMER_CFG_FUNCTION_RENAME ENABLED +# define VSF_TIMER_CFG_FUNCTION_RENAME ENABLED #endif #ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK -# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED +# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED #endif //! Redefine struct vsf_timer_cfg_t. The vsf_timer_isr_handler_t type also needs to //! be redefined For compatibility, members should not be deleted when struct //! @ref vsf_timer_cfg_t redefining. #if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG == DISABLED -# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG DISABLED +# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG DISABLED +#endif + +#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_MODE == DISABLED +# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_MODE DISABLED +#endif + +#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_CFG == DISABLED +# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_CFG DISABLED #endif //! Redefine struct vsf_timer_capability_t. //! For compatibility, members should not be deleted when struct @ref //! vsf_timer_capability_t redefining. #if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED -# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED +# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_TIMER_CFG_INHERT_HAL_CAPABILITY -# define VSF_TIMER_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY +# define VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ #define VSF_TIMER_APIS(__prefix_name) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, init, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_cfg_t *cfg_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, fini, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, enable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, disable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_enable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_disable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_timer_capability_t, timer, capability, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, set_period, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint32_t period) \ - __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, pwm_set, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel, uint32_t period, uint32_t pulse) + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, init, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_cfg_t *cfg_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, fini, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, enable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, disable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_enable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_disable, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_timer_capability_t, timer, capability, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, set_period, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint32_t period) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_config, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel, vsf_timer_channel_cfg_t *channel_cfg_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_start, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_stop, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_request_start, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel, vsf_timer_channel_request_t *request_ptr) \ + __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_request_stop, VSF_MCONNECT(__prefix_name, _timer_t) *timer_ptr, uint8_t channel) /*============================ TYPES =========================================*/ -// TODO: Add more feature support, for example match interrupt - -#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE == DISABLED -typedef enum vsf_timer_mode_t { - VSF_TIMER_MODE_ONESHOT = (0x00 << 0), - VSF_TIMER_MODE_CONTINUES = (0x01 << 0), - - VSF_TIMER_MODE_PWM = (0x01 << 1), - VSF_TIMER_MODE_NO_PWM = (0x00 << 1), -} vsf_timer_mode_t; -#endif - -enum { - VSF_TIMER_MODE_RESTART_COUNT = 2, - VSF_TIMER_MODE_RESTART_MASK = VSF_TIMER_MODE_ONESHOT | - VSF_TIMER_MODE_CONTINUES, - - VSF_TIMER_MODE_PWM_COUNT = 2, - VSF_TIMER_MODE_PWM_MASK = VSF_TIMER_MODE_PWM | - VSF_TIMER_MODE_NO_PWM, - - VSF_TIMER_MODE_MASK_COUNT = 3, - VSF_TIMER_MODE_ALL_BITS_MASK = VSF_TIMER_MODE_RESTART_MASK, -}; - #if VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED typedef enum vsf_timer_irq_mask_t { VSF_TIMER_IRQ_MASK_OVERFLOW = (0x01 << 0), + + VSF_TIMER_IRQ_MASK_CHANNEL_0_INPUT_CAPTURE = (0x01 << 1), + VSF_TIMER_IRQ_MASK_CHANNEL_0_OUTPUT_COMPARE = (0x01 << 2), + /* + // We can define more channel irq mask here + VSF_TIMER_IRQ_MASK_CHANNEL_1_INPUT_CAPTURE = (0x01 << 3), + #define VSF_TIMER_IRQ_MASK_CHANNEL_1_INPUT_CAPTURE VSF_TIMER_IRQ_MASK_CHANNEL_1_INPUT_CAPTURE + VSF_TIMER_IRQ_MASK_CHANNEL_1_OUTPUT_COMPARE = (0x01 << 4), + #define VSF_TIMER_IRQ_MASK_CHANNEL_1_OUTPUT_COMPARE VSF_TIMER_IRQ_MASK_CHANNEL_1_OUTPUT_COMPARE + VSF_TIMER_IRQ_MASK_CHANNEL_2_INPUT_CAPTURE = (0x01 << 5), + #define VSF_TIMER_IRQ_MASK_CHANNEL_2_INPUT_CAPTURE VSF_TIMER_IRQ_MASK_CHANNEL_2_INPUT_CAPTURE + VSF_TIMER_IRQ_MASK_CHANNEL_2_OUTPUT_COMPARE = (0x01 << 6), + #define VSF_TIMER_IRQ_MASK_CHANNEL_2_OUTPUT_COMPARE VSF_TIMER_IRQ_MASK_CHANNEL_2_OUTPUT_COMPARE + */ } vsf_timer_irq_mask_t; #endif @@ -145,31 +146,167 @@ typedef struct vsf_timer_isr_t { //! timer configuration typedef struct vsf_timer_cfg_t { - vsf_timer_mode_t mode; // counting period uint32_t period; union { uint32_t freq; uint32_t min_freq; }; - vsf_timer_isr_t isr; } vsf_timer_cfg_t; #endif + +#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_MODE == DISABLED +typedef enum vsf_timer_channel_mode_t { + // channel mode : different timer channel may support different mode + // Base Mode : The timer channel will be used as a base timer + VSF_TIMER_CHANNEL_MODE_BASE = (0x00 << 0), + // PWM(Pulse Width Modulation) Mode : The timer channel will be used as a + // PWM output, all channels's period should be the same + VSF_TIMER_CHANNEL_MODE_PWM = (0x01 << 0), + // Output Compare Mode: The timer channel will be used as a output compare, + // different channels can have different period (change pin level in + // interrupt) + VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE = (0x02 << 0), + // Input Capture Mode : The timer channel will be used as a input capture + VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE = (0x03 << 0), + // Encoder Mode : The timer channel will be used as a encoder + VSF_TIMER_CHANNEL_MODE_ENCODER = (0x04 << 0), + /* + // Some timer may support more channel mode like one pulse or hall encoder etc. + VSF_TIMER_CHANNEL_MODE_ONE_PULSE = (0x05 << 0), + #define VSF_TIMER_CHANNEL_MODE_ONE_PULSE VSF_TIMER_CHANNEL_MODE_ONE_PULSE + VSF_TIMER_CHANNEL_MODE_HALL_ENCODER = (0x06 << 0), + #define VSF_TIMER_CHANNEL_MODE_HALL_ENCODER VSF_TIMER_CHANNEL_MODE_HALL_ENCODER + */ + + /********************************************************************************/ + // The following mode only valid for VSF_TIMER_CHANNEL_MODE_BASE + // Counter Direction + // Counter Up : The timer will count up + VSF_TIMER_BASE_COUNTER_UP = (0x00 << 4), + // Counter Down : The timer will count down + VSF_TIMER_BASE_COUNTER_DOWN = (0x01 << 4), + /* + // Some timer may support more counter mode like center-aligned etc. + VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED1 = (0x02 << 4), + #define VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED1 VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED1 + VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED2 = (0x03 << 4), + #define VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED2 VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED2 + VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED3 = (0x04 << 4), + #define VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED3 VSF_TIMER_BASE_COUNTER_CENTER_ALIGNED3 + */ + + // Counter Mode + // Oneshot : The timer will stop after the first overflow + VSF_TIMER_BASE_ONESHOT = (0x00 << 5), + // Continues : The timer will continue to count after overflow + VSF_TIMER_BASE_CONTINUES = (0x01 << 5), + + + /********************************************************************************/ + // The following mode only valid for VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE + // Output Compare Mode + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_ACTIVE = (0x00 << 4), + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_INACTIVE = (0x01 << 4), + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_TOGGLE = (0x02 << 4), + /* + // Some timer may support more output compare mode like PWM etc. + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM1 = (0x03 << 4), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM1 VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM1 + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM2 = (0x04 << 4), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM2 VSF_TIMER_CHANNEL_OUTPUT_COMPARE_PWM2 + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_ACTIVE = (0x05 << 4), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_ACTIVE VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_ACTIVE + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_INACTIVE = (0x06 << 4), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_INACTIVE VSF_TIMER_CHANNEL_OUTPUT_COMPARE_FORCED_INACTIVE + */ + + /* + // Output Compare Polarity and N Polarity + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_HIGH = (0x00 << 8), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_HIGH VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_HIGH + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_LOW = (0x01 << 8), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_LOW VSF_TIMER_CHANNEL_OUTPUT_COMPARE_POLARITY_LOW + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_HIGH = (0x00 << 8), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_HIGH VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_HIGH + VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_LOW = (0x01 << 8), + #define VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_LOW VSF_TIMER_CHANNEL_OUTPUT_COMPARE_N_POLARITY_LOW + */ + + /********************************************************************************/ + // The following mode only valid for VSF_TIMER_CHANNEL_MODE_PWM + // PWM Mode + VSF_TIMER_PWM_OUTPUT_POLARITY_HIGH = (0x00 << 4), + VSF_TIMER_PWM_OUTPUT_POLARITY_LOW = (0x01 << 4), + + + /********************************************************************************/ + // The following mode only valid for VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE + VSF_TIMER_CHANNEL_INPUT_CAPTURE_POLARITY_RISING = (0x00 << 4), + VSF_TIMER_CHANNEL_INPUT_CAPTURE_POLARITY_FALLING = (0x01 << 4), + VSF_TIMER_CHANNEL_INPUT_CAPTURE_POLARITY_BOTH = (0x02 << 4), + + /* + VSF_TIMER_CHANNEL_INPUT_CAPTURE_FILTER_MASK = (0x0F << 4), + VSF_TIMER_CHANNEL_INPUT_CAPTURE_FILTER_OFFSET = 4, + */ + + /********************************************************************************/ + // The following mode only valid for VSF_TIMER_CHANNEL_MODE_ENCODER + // Encoder Mode + VSF_TIMER_CHANNEL_ENCODER_CHANNEL_A_POLARITY_RISING = (0x00 << 3), + VSF_TIMER_CHANNEL_ENCODER_CHANNEL_A_POLARITY_FALLING = (0x01 << 3), + VSF_TIMER_CHANNEL_ENCODER_CHANNEL_A_POLARITY_BOTH = (0x02 << 3), +} vsf_timer_channel_mode_t; +#endif + +#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_CFG == DISABLED +typedef struct vsf_timer_channel_cfg_t { + vsf_timer_channel_mode_t mode; + uint32_t pulse; +} vsf_timer_channel_cfg_t; +#endif + +#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNAL_CFG == DISABLED +typedef struct vsf_timer_channel_request_t { + uint16_t length; + union { + // for VSF_TIMER_CHANNEL_MODE_BASE mode + uint32_t *period_buffer; + // for VSF_TIMER_CHANNEL_MODE_PWM mode and VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE mode + uint32_t *pulse_buffer; + // for VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE mode + uint32_t *input_capture_buffer; + // for VSF_TIMER_CHANNEL_MODE_ENCODER mode + struct { + uint32_t *channal_a_buffer; + uint32_t *channal_b_buffer; + }; + }; +} vsf_timer_channel_request_t; +#endif + #if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_timer_capability_t { -#if VSF_TIMER_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif - + // support interrupt for timer vsf_timer_irq_mask_t irq_mask; + // timer bit length, like 16bit, 32bit etc. uint8_t timer_bitlen; - - uint8_t support_pwm : 1; - uint8_t pwm_channel_cnt; - + // timer channel count, like 1, 2, 4 etc. + uint8_t channel_cnt; + + // support different channel mode + // we can redefine it if different channel support different mode. + uint8_t support_pwm : 1; + uint8_t support_output_compare : 1; + uint8_t support_input_capture : 1; + uint8_t support_one_pulse : 1; } vsf_timer_capability_t; #endif @@ -223,20 +360,48 @@ extern vsf_err_t vsf_timer_init(vsf_timer_t *timer_ptr, vsf_timer_cfg_t *cfg_ptr */ extern void vsf_timer_fini(vsf_timer_t *timer_ptr); +/** + \~english + @brief enable a timer instance. + @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t + @return fsm_rt_t: return FSM_RT_CPL if timer was enabled, return FSM_RT_ONGOING if timer is enabling + + \~chinese + @brief 使能一个 timer 实例 + @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 timer 实例被使能，返回 FSM_RT_ONGOING 如果 timer 实例正在使能 + */ +extern fsm_rt_t vsf_timer_enable(vsf_timer_t *timer_ptr); + +/** + \~english + @brief disable a timer instance. + @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t + @return fsm_rt_t: return FSM_RT_CPL if timer was disabled, return FSM_RT_ONGOING if timer is disabling + + \~chinese + @brief 禁能一个 timer 实例 + @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 timer 实例被禁能，返回 FSM_RT_ONGOING 如果 timer 实例正在禁能 + */ +extern fsm_rt_t vsf_timer_disable(vsf_timer_t *timer_ptr); + /** \~english @brief enable interrupt masks of timer instance. @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t @param[in] irq_mask: one or more value of enum @ref vsf_timer_irq_mask_t @return none. + @note All pending interrupts should be cleared before interrupts are enabled. \~chinese @brief 使能 timer 实例的中断 @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t @param[in] irq_mask: 一个或者多个枚举 vsf_timer_irq_mask_t 的值的按位或，@ref vsf_timer_irq_mask_t @return 无。 + @note 在中断使能之前，应该清除所有悬挂的中断。 */ -extern fsm_rt_t vsf_timer_enable(vsf_timer_t *timer_ptr); +extern void vsf_timer_irq_enable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask); /** \~english @@ -251,7 +416,7 @@ extern fsm_rt_t vsf_timer_enable(vsf_timer_t *timer_ptr); @param[in] irq_mask: 一个或者多个枚举 vsf_timer_irq_mask_t 的值的按位或，@ref vsf_timer_irq_mask_t @return 无。 */ -extern fsm_rt_t vsf_timer_disable(vsf_timer_t *timer_ptr); +extern void vsf_timer_irq_disable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask); /** \~english @@ -268,83 +433,132 @@ extern vsf_timer_capability_t vsf_timer_capability(vsf_timer_t *timer_ptr); /** \~english - @brief enable interrupt masks of timer instance. + @brief timer set period (maximum count), used for change the period of timer dynamically @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t - @param[in] irq_mask: one or more value of enum @ref vsf_timer_irq_mask_t - @return none. - @note All pending interrupts should be cleared before interrupts are enabled. + @param[in] period: timer period width (in clock counter) + @return vsf_err_t: VSF_ERR_NONE if the timer set period was successfully, or a negative error code \~chinese - @brief 使能 timer 实例的中断 + @brief timer 设置一个定时器的周期（最大计数值）, 用于动态改变定时器的周期 @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t - @param[in] irq_mask: 一个或者多个枚举 vsf_timer_irq_mask_t 的值的按位或，@ref vsf_timer_irq_mask_t - @return 无。 - @note All pending interrupts should be cleared before interrupts are enabled. + @param[in] period: timer 周期宽度 (时钟计数) + @return vsf_err_t: 如果 timer 设置周期成功成功返回 VSF_ERR_NONE , 否则返回负数。 */ -extern void vsf_timer_irq_enable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask); +extern vsf_err_t vsf_timer_set_period(vsf_timer_t *timer_ptr, uint32_t period); /** \~english - @brief disable interrupt masks of timer instance. + @brief timer set the period width and pulse width for a channel @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t - @param[in] irq_mask: one or more value of enum vsf_timer_irq_mask_t, @ref vsf_timer_irq_mask_t - @return none. + @param[in] channel: timer channel + @param[in] channel_cfg_ptr: a pointer to structure @ref vsf_timer_channel_cfg_t + @return vsf_err_t: VSF_ERR_NONE if the timer channel set was successfully, or a negative error code \~chinese - @brief 禁能 timer 实例的中断 + @brief timer 通道 设置一个通道的周期和宽度 @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t - @param[in] irq_mask: 一个或者多个枚举 vsf_timer_irq_mask_t 的值的按位或，@ref vsf_timer_irq_mask_t - @return 无。 + @param[in] channel: timer 通道 + @param[in] channel_cfg_ptr: a pointer to structure @ref vsf_timer_channel_cfg_t + @return vsf_err_t: 如果 timer 通道设置成功成功返回 VSF_ERR_NONE, 否则返回负数。 */ -extern void vsf_timer_irq_disable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask); +extern vsf_err_t vsf_timer_channel_config(vsf_timer_t *timer_ptr, + uint8_t channel, + vsf_timer_channel_cfg_t *channel_cfg_ptr); /** \~english - @brief timer set period (maximum count) + @brief start a timer channel @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t - @param[in] period: timer period width (in clock counter) - @return vsf_err_t: VSF_ERR_NONE if the timer set period was successfully, or a negative error code + @param[in] channel: timer channel + @return vsf_err_t: VSF_ERR_NONE if the timer channel start was successfully, or a negative error code \~chinese - @brief timer 设置一个定时器的周期（最大计数值） + @brief 开始一个 timer 通道 @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t - @param[in] period: timer 周期宽度 (时钟计数) - @return vsf_err_t: 如果 timer 设置周期成功成功返回 VSF_ERR_NONE , 否则返回负数。 + @param[in] channel: timer 通道 + @return vsf_err_t: 如果 timer 通道开始成功返回 VSF_ERR_NONE, 否则返回负数。 */ -extern vsf_err_t vsf_timer_set_period(vsf_timer_t *timer_ptr, uint32_t period); +extern vsf_err_t vsf_timer_channel_start(vsf_timer_t *timer_ptr, uint8_t channel); + +/** + \~english + @brief stop a timer channel + @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t + @param[in] channel: timer channel + @return vsf_err_t: VSF_ERR_NONE if the timer channel stop was successfully, or a negative error code + + \~chinese + @brief 停止一个 timer 通道 + @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t + @param[in] channel: timer 通道 + @return vsf_err_t: 如果 timer 通道停止成功返回 VSF_ERR_NONE, 否则返回负数。 + */ +extern vsf_err_t vsf_timer_channel_stop(vsf_timer_t *timer_ptr, uint8_t channel); + +/** + \~english + @brief start a timer channel request (usually based on DMA) + @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t + @param[in] channel: timer channel + @param[in] request_ptr: a pointer to request structure @ref vsf_timer_channel_request_t + For VSF_TIMER_CHANNEL_MODE_BASE mode, period_buffer in structure + @ref vsf_timer_channel_request_t is array of period value to be set after each overflow. + For VSF_TIMER_CHANNEL_MODE_PWM mode, pwm_buffer in structure + @ref vsf_timer_channel_request_t is array of pulse value to be set after each overflow. + For VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE mode, pulse_buffer in structure + @ref vsf_timer_channel_request_t is array of pulse value to be set after each overflow. + For VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE mode, input_capture_buffer in structure + @ref vsf_timer_channel_request_t is array of input capture value. + For VSF_TIMER_CHANNEL_MODE_ENCODER mode, channal_a_buffer and channal_b_buffer in structure + @ref vsf_timer_channel_request_t is array of encoder value for channel A and channel B. + @return vsf_err_t: VSF_ERR_NONE if the timer channel start was successfully, or a negative error code + + \~chinese + @brief 开始一个 timer 通道的请求 (通常基于 DMA) + @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t + @param[in] channel: timer 通道 + @param[in] request_ptr: 结构体 vsf_timer_channel_request_t 的指针，参考 @ref vsf_timer_channel_request_t + 对于 VSF_TIMER_CHANNEL_MODE_BASE 模式, @ref vsf_timer_channel_request_t 中的 period_buffer 是每次溢出后要设置的周期值数组。 + 对于 VSF_TIMER_CHANNEL_MODE_PWM 模式, @ref vsf_timer_channel_request_t 中的 pwm_buffer 是每次溢出后要设置的脉冲值数组。 + 对于 VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE 模式, @ref vsf_timer_channel_request_t 中的 pulse_buffer 是每次溢出后要设置的脉冲值数组。 + 对于 VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE 模式, @ref vsf_timer_channel_request_t 中的 input_capture_buffer 是输入捕获值数组。 + 对于 VSF_TIMER_CHANNEL_MODE_ENCODER 模式, @ref vsf_timer_channel_request_t 中的 channal_a_buffer 和 channal_b_buffer 是通道 A 和通道 B 的编码器值数组。 + @return vsf_err_t: 如果 timer 通道开始成功返回 VSF_ERR_NONE, 否则返回负数。 + */ +extern vsf_err_t vsf_timer_channel_request_start(vsf_timer_t *timer_ptr, uint8_t channel, vsf_timer_channel_request_t *request_ptr); /** \~english - @brief timer pwm set the period width and pulse width for a channel + @brief stop a timer channel request. @param[in] timer_ptr: a pointer to structure @ref vsf_timer_t - @param[in] channel: timer pwm channel - @param[in] period: timer pwm period width (in clock counter) - @param[in] pulse: timer pwm pulse width (in clock counter) - @return vsf_err_t: VSF_ERR_NONE if the timer pwm set was successfully, or a negative error code + @param[in] channel: timer channel + @return vsf_err_t: VSF_ERR_NONE if the timer channel stop was successfully, or a negative error code \~chinese - @brief timer pwm 设置一个通道的周期和宽度 + @brief 停止一个 timer 通道的请求 @param[in] timer_ptr: 结构体 vsf_timer_t 的指针，参考 @ref vsf_timer_t - @param[in] channel: timer pwm 通道 - @param[in] period: timer pwm 周期宽度 (时钟计数) - @param[in] pulse: timer pwm 脉冲宽度 (时钟计数) - @return vsf_err_t: 如果 timer pwm 设置成功成功返回 VSF_ERR_NONE , 否则返回负数。 + @param[in] channel: timer 通道 + @return vsf_err_t: 如果 timer 通道停止成功返回 VSF_ERR_NONE, 否则返回负数。 */ -extern vsf_err_t vsf_timer_pwm_set(vsf_timer_t *timer_ptr, uint8_t channel, uint32_t period, uint32_t pulse); +extern vsf_err_t vsf_timer_channel_request_stop(vsf_timer_t *timer_ptr, uint8_t channel); /*============================ MACROFIED FUNCTIONS ===========================*/ #if VSF_TIMER_CFG_FUNCTION_RENAME == ENABLED -# define __vsf_timer_t VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_t) -# define vsf_timer_init(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_init) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) -# define vsf_timer_fini(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_fini) ((__vsf_timer_t *)(__TIME)) -# define vsf_timer_enable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_enable) ((__vsf_timer_t *)(__TIME)) -# define vsf_timer_disable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_disable) ((__vsf_timer_t *)(__TIME)) -# define vsf_timer_capability(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_capability) ((__vsf_timer_t *)(__TIME)) -# define vsf_timer_irq_enable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_enable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) -# define vsf_timer_irq_disable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_disable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) -# define vsf_timer_set_period(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_set_period) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) -# define vsf_timer_pwm_set(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_pwm_set) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define __vsf_timer_t VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_t) +# define vsf_timer_init(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_init) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_fini(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_fini) ((__vsf_timer_t *)(__TIME)) +# define vsf_timer_enable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_enable) ((__vsf_timer_t *)(__TIME)) +# define vsf_timer_disable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_disable) ((__vsf_timer_t *)(__TIME)) +# define vsf_timer_capability(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_capability) ((__vsf_timer_t *)(__TIME)) +# define vsf_timer_irq_enable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_enable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_irq_disable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_disable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_set_period(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_set_period) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_channel_config(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_config) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_channel_start(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_start) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_channel_stop(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_stop) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_channel_request_start(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_request_start)((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) +# define vsf_timer_channel_request_stop(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_request_stop) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__) #endif #ifdef __cplusplus diff --git a/source/hal/driver/common/template/vsf_template_usart.h b/source/hal/driver/common/template/vsf_template_usart.h index 6cce1d289..11a252a93 100644 --- a/source/hal/driver/common/template/vsf_template_usart.h +++ b/source/hal/driver/common/template/vsf_template_usart.h @@ -109,8 +109,8 @@ Dependency: VSF_USART_CFG_FUNCTION_RENAME enable # define VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_USART_CFG_INHERT_HAL_CAPABILITY -# define VSF_USART_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_USART_CFG_INHERIT_HAL_CAPABILITY +# define VSF_USART_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif #ifndef VSF_USART_CFG_REQUEST_API @@ -341,8 +341,8 @@ typedef enum vsf_usart_mode_t { VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = VSF_USART_TX_FIFO_THRESHOLD_4, VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = VSF_USART_TX_FIFO_THRESHOLD_8, */ - VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x0ul << 15), //!< TX FIFO becomes emtpy - VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = (0x1ul << 15), //!< TX FIFO becomes half emtpy + VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x0ul << 15), //!< TX FIFO becomes empty + VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = (0x1ul << 15), //!< TX FIFO becomes half empty //! TX FIFO maximum non-full threshold value, it can send at least one data. //! If the TX FIFO threshold cannot be set to the fifo maximum minus 1, //! then we can use the tx not full interrupt to accomplish this. @@ -384,7 +384,7 @@ typedef enum vsf_usart_mode_t { */ //! RX FIFO Minimum non-empty threshold, which should contain at least one data. //! If the threshold value of RX FIFO cannot be set to 1, then we can use the RX FIFO not empty interrupt to accomplish this. - VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = (0x0ul << 17), + VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = (0x0ul << 17), //!< RX FIFO Minimum non-empty threshold, which should contain at least one data. VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = (0x1ul << 17), //!< Half of the threshold for RX FIFO VSF_USART_RX_FIFO_THRESHOLD_FULL = (0x2ul << 17), //!< Full of the threshold for RX FIFO @@ -693,7 +693,7 @@ typedef struct vsf_usart_status_t { #endif typedef struct vsf_usart_capability_t { -#if VSF_USART_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_USART_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif vsf_usart_irq_mask_t irq_mask; @@ -766,27 +766,27 @@ extern void vsf_usart_fini(vsf_usart_t *usart_ptr); /** \~english - @brief enable interrupt masks of usart instance. + @brief enable a usart instance. @param[in] usart_ptr: a pointer to structure @ref vsf_usart_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if usart was enabled, return FSM_RT_ON_GOING if usart is enabling \~chinese - @brief 使能 usart 实例的中断 + @brief 使能一个 usart 实例 @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 usart 实例被使能，返回 FSM_RT_ON_GOING 如果 usart 实例正在使能 */ extern fsm_rt_t vsf_usart_enable(vsf_usart_t *usart_ptr); /** \~english - @brief disable interrupt masks of usart instance. + @brief disable a usart instance. @param[in] usart_ptr: a pointer to structure @ref vsf_usart_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if usart was disabled, return FSM_RT_ON_GOING if usart is disabling \~chinese - @brief 禁能 usart 实例的中断 + @brief 禁能一个 usart 实例 @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 usart 实例被禁能，返回 FSM_RT_ON_GOING 如果 usart 实例正在禁能 */ extern fsm_rt_t vsf_usart_disable(vsf_usart_t *usart_ptr); @@ -811,7 +811,7 @@ extern void vsf_usart_irq_enable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t ir \~english @brief disable interrupt masks of usart instance. @param[in] usart_ptr: a pointer to structure @ref vsf_usart_t - @param[in] irq_mask: one or more value of enum vsf_usart_irq_mask_t, @ref vsf_usart_irq_mask_t + @param[in] irq_mask: one or more value of enum @ref vsf_usart_irq_mask_t, @ref vsf_usart_irq_mask_t @return none. \~chinese @@ -909,8 +909,8 @@ extern uint_fast16_t vsf_usart_txfifo_get_free_count(vsf_usart_t *usart_ptr); @brief 尝试从 usart 发送队列里写入指定最大长度的数据 @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t @param[in] buffer_ptr: 数据缓冲区 - @param[in] count: 最大读取数量 - @return uint_fast16_t: 返回当前 usart 接收队列的实际读到的数量 + @param[in] count: 最大写入数量 + @return uint_fast16_t: 返回当前 usart 发送队列的实际写入数量 */ extern uint_fast16_t vsf_usart_txfifo_write(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast16_t count); @@ -952,13 +952,14 @@ extern vsf_err_t vsf_usart_request_tx(vsf_usart_t *usart_ptr, void *buffer_ptr, /** \~english - @brief cancel current current receive request + @brief cancel current receive request @param[in] usart_ptr: a pointer to structure @ref vsf_usart_t @return vsf_err_t: VSF_ERR_NONE if the usart request was successfully, or a negative error code @note: The request interface is usually implemented via DMA. \~chinese @brief 取消当前接收请求 + @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t @return vsf_err_t: 如果 usart 请求成功返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr); @@ -971,6 +972,7 @@ extern vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr); \~chinese @brief 取消当前发送请求 + @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t @return vsf_err_t: 如果 usart 请求成功返回 VSF_ERR_NONE , 否则返回负数。 */ extern vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr); @@ -984,6 +986,7 @@ extern vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr); \~chinese @brief 获取接收请求已经接收到的数量 + @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t @return int_fast32_t: 已经接收到的数量 @note: 只在当前接收请求没完成之前是有效的。 */ @@ -991,13 +994,14 @@ extern int_fast32_t vsf_usart_get_rx_count(vsf_usart_t *usart_ptr); /** \~english - @brief get the number of current send requests that have been sended + @brief get the number of current send requests that have been sent @param[in] usart_ptr: a pointer to structure @ref vsf_usart_t - @return int_fast32_t: number already send + @return int_fast32_t: number already sent @note: only valid until the current send request is completed. \~chinese @brief 获取发送请求已经发送到的数量 + @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t @return int_fast32_t: 已经发送到的数量 @note: 只在当前发送请求没完成之前是有效的。 */ @@ -1013,10 +1017,11 @@ extern int_fast32_t vsf_usart_get_tx_count(vsf_usart_t *usart_ptr); success returns VSF_ERR_NONE \~chinese - @brief 获取 usart 实例的状态 + @brief 调用指定的 usart 命令 @param[in] usart_ptr: 结构体 vsf_usart_t 的指针，参考 @ref vsf_usart_t - @param[in] duration: usart 传输一位的时间的倍数，如果 duration 等于0，表示使用硬件默认的时间 - @return vsf_err_t: 返回当调用 uart 命令的结果，成功返回 VSF_ERR_NONE + @param[in] cmd: usart 命令，参考 @ref vsf_usart_cmd_t + @param[in] param: 命令的参数，其用途由命令决定 + @return vsf_err_t: 返回调用 usart 命令的结果，成功返回 VSF_ERR_NONE */ extern vsf_err_t vsf_usart_cmd(vsf_usart_t *usart_ptr, vsf_usart_cmd_t cmd, void * param); diff --git a/source/hal/driver/common/template/vsf_template_wdt.h b/source/hal/driver/common/template/vsf_template_wdt.h index be1d897bf..683deca68 100644 --- a/source/hal/driver/common/template/vsf_template_wdt.h +++ b/source/hal/driver/common/template/vsf_template_wdt.h @@ -79,8 +79,8 @@ extern "C" { # define VSF_WDT_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED #endif -#ifndef VSF_WDT_CFG_INHERT_HAL_CAPABILITY -# define VSF_WDT_CFG_INHERT_HAL_CAPABILITY ENABLED +#ifndef VSF_WDT_CFG_INHERIT_HAL_CAPABILITY +# define VSF_WDT_CFG_INHERIT_HAL_CAPABILITY ENABLED #endif /*============================ MACROFIED FUNCTIONS ===========================*/ @@ -103,22 +103,25 @@ typedef enum vsf_wdt_mode_t { VSF_WDT_MODE_RESET_NONE = (0 << 1), VSF_WDT_MODE_RESET_CPU = (1 << 1), VSF_WDT_MODE_RESET_SOC = (2 << 1), + + /* + // optional: prescaler mode + VSF_WDT_MODE_PRESCALER_1 = (0 << 2), + VSF_WDT_MODE_PRESCALER_2 = (1 << 2), + VSF_WDT_MODE_PRESCALER_4 = (2 << 2), + VSF_WDT_MODE_PRESCALER_8 = (3 << 2), + #define VSF_WDT_MODE_PRESCALER_MASK (0x03 << 2) + */ } vsf_wdt_mode_t; #endif enum { - VSF_WDT_MODE_EARLY_WAKEUP_COUNT = 2, VSF_WDT_MODE_EARLY_WAKEUP_MASK = VSF_WDT_MODE_NO_EARLY_WAKEUP | VSF_WDT_MODE_EARLY_WAKEUP, - VSF_WDT_MODE_RESET_COUNT = 3, VSF_WDT_MODE_RESET_MASK = VSF_WDT_MODE_RESET_NONE | VSF_WDT_MODE_RESET_CPU | VSF_WDT_MODE_RESET_CPU, - - VSF_WDT_MODE_MASK_COUNT = 2, - VSF_WDT_MODE_ALL_BITS_MASK = VSF_WDT_MODE_EARLY_WAKEUP_MASK | - VSF_WDT_MODE_RESET_MASK, }; #if VSF_WDT_CFG_REIMPLEMENT_TYPE_CFG == DISABLED @@ -141,7 +144,7 @@ typedef struct vsf_wdt_cfg_t { #if VSF_WDT_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED typedef struct vsf_wdt_capability_t { -#if VSF_WDT_CFG_INHERT_HAL_CAPABILITY == ENABLED +#if VSF_WDT_CFG_INHERIT_HAL_CAPABILITY == ENABLED inherit(vsf_peripheral_capability_t) #endif @@ -199,38 +202,33 @@ extern vsf_err_t vsf_wdt_init(vsf_wdt_t *wdt_ptr, vsf_wdt_cfg_t *cfg_ptr); \~chinese @brief 终止一个 wdt 实例 @param[in] wdt_ptr: 结构体 vsf_wdt_t 的指针，参考 @ref vsf_wdt_t - @param[in] cfg_ptr: 结构体 vsf_wdt_cfg_t 的指针，参考 @ref vsf_wdt_cfg_t @return 无。 */ extern void vsf_wdt_fini(vsf_wdt_t *wdt_ptr); /** \~english - @brief enable interrupt masks of wdt instance. + @brief enable a wdt instance. @param[in] wdt_ptr: a pointer to structure @ref vsf_wdt_t - @param[in] irq_mask: one or more value of enum @ref vsf_wdt_irq_mask_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if wdt was enabled, return FSM_RT_ONGOING if wdt is enabling \~chinese - @brief 使能 wdt 实例的中断 + @brief 使能一个 wdt 实例 @param[in] wdt_ptr: 结构体 vsf_wdt_t 的指针，参考 @ref vsf_wdt_t - @param[in] irq_mask: 一个或者多个枚举 vsf_wdt_irq_mask_t 的值的按位或，@ref vsf_wdt_irq_mask_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 wdt 实例被使能，返回 FSM_RT_ONGOING 如果 wdt 实例正在使能 */ extern fsm_rt_t vsf_wdt_enable(vsf_wdt_t *wdt_ptr); /** \~english - @brief disable interrupt masks of wdt instance. + @brief disable a wdt instance. @param[in] wdt_ptr: a pointer to structure @ref vsf_wdt_t - @param[in] irq_mask: one or more value of enum vsf_wdt_irq_mask_t, @ref vsf_wdt_irq_mask_t - @return none. + @return fsm_rt_t: return FSM_RT_CPL if wdt was disabled, return FSM_RT_ONGOING if wdt is disabling \~chinese - @brief 禁能 wdt 实例的中断 + @brief 禁能一个 wdt 实例 @param[in] wdt_ptr: 结构体 vsf_wdt_t 的指针，参考 @ref vsf_wdt_t - @param[in] irq_mask: 一个或者多个枚举 vsf_wdt_irq_mask_t 的值的按位或，@ref vsf_wdt_irq_mask_t - @return 无。 + @return fsm_rt_t: 返回 FSM_RT_CPL 如果 wdt 实例被禁能，返回 FSM_RT_ONGOING 如果 wdt 实例正在禁能 */ extern fsm_rt_t vsf_wdt_disable(vsf_wdt_t *wdt_ptr);