Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hal template update #214

Closed
wants to merge 17 commits into from
Closed

Hal template update #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
4779edc
[hal/driver/vsf_template_adc] fix typo
liangyongxiang Feb 12, 2025
f060b6d
[hal/driver/vsf_template_dac] fix typo
liangyongxiang Feb 12, 2025
1dff2e2
[hal/driver/vsf_template_dma] fix typo
liangyongxiang Feb 12, 2025
9b14d6d
[hal/driver/vsf_template_flash] fix typo
liangyongxiang Feb 12, 2025
8ab450e
[hal/driver/vsf_template_gpio] fix typo
liangyongxiang Feb 12, 2025
dfa173b
[hal/driver/vsf_template_i2s] fix typo
liangyongxiang Feb 12, 2025
aa8aa73
[hal/driver/vsf_template_pm] fix typo
liangyongxiang Feb 12, 2025
6048d84
[hal/driver/vsf_template_pwm] fix typo
liangyongxiang Feb 12, 2025
808ed6b
[hal/driver/vsf_template_rng] fix typo
liangyongxiang Feb 12, 2025
7fbcad6
[hal/driver/vsf_template_rtc] fix typo
liangyongxiang Feb 12, 2025
165c30f
[hal/driver/vsf_template_sdio] fix typo
liangyongxiang Feb 12, 2025
098fde9
[hal/driver/vsf_template_wdt] fix typo and add more comment
liangyongxiang Feb 12, 2025
0683e62
[hal/driver/vsf_template_usart] fix typo and add more comment
liangyongxiang Feb 12, 2025
8712688
[hal/driver/vsf_template_instance_declaration.h] fix typo
liangyongxiang Feb 12, 2025
c9b3130
[hal/driver/vsf_template_i2c] add slave api and fifo api
liangyongxiang Feb 12, 2025
6f6ea68
[hal/driver/vsf_template_instance_declaration.h] add spi ctrl api
liangyongxiang Feb 12, 2025
78e617a
[hal/driver/vsf_template_timer] update channel api
liangyongxiang Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions source/hal/driver/common/template/vsf_template_adc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ===========================*/
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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

Expand All @@ -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,
Expand Down
10 changes: 5 additions & 5 deletions source/hal/driver/common/template/vsf_template_dac.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ===========================*/
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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 , 否则返回负数。
*/
Expand Down
14 changes: 7 additions & 7 deletions source/hal/driver/common/template/vsf_template_dma.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ===========================*/
Expand Down Expand Up @@ -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),
Expand All @@ -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),

Expand Down Expand Up @@ -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,

Expand Down Expand Up @@ -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;
Expand Down
18 changes: 9 additions & 9 deletions source/hal/driver/common/template/vsf_template_flash.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ===========================*/
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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);

Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
25 changes: 12 additions & 13 deletions source/hal/driver/common/template/vsf_template_gpio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -754,15 +753,15 @@ 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

\~chinese
@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);
Expand Down Expand Up @@ -818,15 +817,15 @@ 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 实例的一个或者多个引脚的方向为输出高电平
@param[in] gpio_ptr: 结构体 vsf_gpio_t 的指针，参考 @ref vsf_gpio_t
@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);

Expand All @@ -839,15 +838,15 @@ 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 实例的一个或者多个引脚的方向为输出低电平
@param[in] gpio_ptr: 结构体 vsf_gpio_t 的指针，参考 @ref vsf_gpio_t
@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);

Expand Down
Loading
Loading