WDT驱动API描述
WDT驱动的API主要如下：
| API类别 | API名称 | 描述 |
|---|---|---|
|
初始化 |
hal_wdt_init() |
初始化WDT外设，配置计数初值等参数。 |
|
hal_wdt_deinit() |
反初始化WDT外设。 |
|
|
hal_wdt_msp_init() |
初始化WDT外设所使用的NVIC中断。 |
|
|
hal_wdt_msp_deinit() |
反初始化WDT外设所使用的NVIC中断。 |
|
|
IO操作 |
hal_wdt_refresh |
重载计数初值。 |
|
中断处理及回调函数 |
hal_wdt_irq_handler |
中断处理函数。 |
|
hal_wdt_period_elapsed_callback |
计数完成回调函数。 |
下面章节将对各API进行详细描述。
hal_wdt_init
| 函数原型 | hal_status_t hal_wdt_init(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 根据WDT句柄中的指定配置参数初始化WDT。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_wdt_deinit
| 函数原型 | hal_status_t hal_wdt_deinit(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 将WDT外设寄存器反初始化为它们的默认重置值。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_wdt_msp_init
| 函数原型 | void hal_wdt_msp_init(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 初始化WDT外设所使用的NVIC中断。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | 无 |
| 备注 | 该函数为weak类型的空函数，开发者需要重写该API以进行NVIC中断的初始化。 |
hal_wdt_msp_deinit
| 函数原型 | void hal_wdt_msp_deinit(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 反初始化WDT外设所使用的NVIC中断。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | 无 |
| 备注 | 该函数为weak类型的空函数，开发者需要重写该API以进行NVIC中断的反初始化。 |
hal_wdt_refresh
| 函数原型 | hal_status_t hal_wdt_refresh(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 刷新看门狗计数。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | HAL状态。 |
| 备注 |
hal_wdt_irq_handler
| 函数原型 | void hal_wdt_irq_handler(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | 处理WDT中断请求。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | 无 |
| 备注 |
hal_wdt_period_elapsed_callback
| 函数原型 | void hal_wdt_period_elapsed_callback(wdt_handle_t *p_wdt) |
|---|---|
| 功能说明 | WDT计数到0的中断回调函数。 |
| 输入参数 | p_wdt：指向wdt_handle_t结构体变量的指针，该结构体变量包含指定的WDT模块的配置信息。 |
| 返回值 | 无 |
| 备注 | 该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。 |
