UART驱动API描述

hal_status_t hal_uart_init(uart_handle_t *p_uart)

根据uart_init_t中的指定参数初始化UART模式，并初始化相关句柄。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

hal_status_t hal_uart_deinit(uart_handle_t *p_uart)

反初始化UART外设。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

void hal_uart_msp_init(uart_handle_t *p_uart)

初始化UART所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该API为weak类型的空函数，开发者需要重写该API完成GPIO引脚复用、NVIC中断、DMA通道的初始化。

void hal_uart_msp_deinit(uart_handle_t *p_uart)

反初始化UART所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该API为weak类型的空函数，开发者需重写该API完成GPIO引脚复用、NVIC中断、DMA通道的反初始化。

hal_status_t hal_uart_transmit(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size, uint32_t timeout)

发送大量数据，轮询方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

timout：超时时间。

HAL状态。

hal_status_t hal_uart_receive(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size, uint32_t timeout)

接收大量数据，轮询方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

timout：超时时间。

HAL状态。

hal_status_t hal_uart_transmit_it(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size)

发送大量数据，中断方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态。

hal_status_t hal_uart_receive_it(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size)

接收大量数据，中断方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_uart_transmit_dma(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size)

发送大量数据，DMA方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态。

hal_status_t hal_uart_receive_dma(uart_handle_t *p_uart, uint8_t *p_data, uint16_t size)

接收大量数据，DMA方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_uart_dma_pause(uart_handle_t *p_uart)

暂停UART DMA传输。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

hal_status_t hal_uart_dma_resume(uart_handle_t *p_uart)

恢复UART DMA传输。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

hal_status_t hal_uart_dma_stop(uart_handle_t *p_uart)

停止UART DMA传输。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

hal_status_t hal_uart_abort(uart_handle_t *p_uart)

中止中断及DMA方式下的数据收发，轮询方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据收发，该函数执行如下操作：

• 禁用TX中断和RX中断
• 中止DMA传输
• 设置p_uart中的state为HAL_UART_STATE_READY

hal_status_t hal_uart_abort_transmit(uart_handle_t *p_uart)

中止中断及DMA方式下的数据发送，轮询方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据发送，该函数执行如下操作：

• 禁用TX中断
• 中止DMA传输
• 设置p_uart中的state为HAL_UART_STATE_READY

hal_status_t hal_uart_abort_receive(uart_handle_t *p_uart)

中止中断及DMA方式下的数据接收，轮询方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据接收，该函数执行如下操作：

• 禁用RX中断
• 中止DMA传输
• 设置p_uart中的state为HAL_UART_STATE_READY

hal_status_t hal_uart_abort_it(uart_handle_t *p_uart)

中止中断及DMA方式下的数据收发，中断方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据收发，该函数执行如下操作：

• 禁用TX中断和RX中断；
• 中止DMA传输；
• 设置p_uart中的state为HAL_UART_STATE_READY

中止完成后，hal_uart_abort_cplt_callback()会被调用。

hal_status_t hal_uart_abort_transmit_it(uart_handle_t *p_uart)

中止中断及DMA方式下的数据发送，中断方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据发送，该函数执行如下操作：

• 禁用TX中断
• 中止DMA传输
• 设置p_uart中的state为HAL_UART_STATE_READY

中止完成后，hal_uart_abort_transmit_cplt_callback()会被调用。

hal_status_t hal_uart_abort_receive_it(uart_handle_t *p_uart)

中止中断及DMA方式下的数据接收，中断方式。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

HAL状态。

该函数可用于中止中断方式或DMA方式的数据接收，该函数执行如下操作：

• 禁用RX中断
• 中止DMA传输
• 设置p_uart中的state为HAL_UART_STATE_READY

中止完成后，hal_uart_abort_receive_cplt_callback()会被调用。

void hal_uart_irq_handler(uart_handle_t *p_uart)

处理UART中断请求。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

void hal_uart_tx_cplt_callback(uart_handle_t *p_uart)

发送完成中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_uart_rx_cplt_callback(uart_handle_t *p_uart)

接收完成中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_uart_error_callback(uart_handle_t *p_uart)

UART错误中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_uart_abort_cplt_callback(uart_handle_t *p_uart)

UART中止完成中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_uart_abort_tx_cplt_callback(uart_handle_t *p_uart)

UART中止发送完成中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_uart_abort_rx_cplt_callback(uart_handle_t *p_uart)

UART中止接收完成中断回调函数。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

无

hal_uart_state_t hal_uart_get_state(uart_handle_t *p_uart)

获取UART运行状态。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

UART运行状态，值可以是下面中的任意一个：

• HAL_UART_STATE_RESET（未初始化）
• HAL_UART_STATE_READY（已初始化且空闲）
• HAL_UART_STATE_BUSY（忙）
• HAL_UART_STATE_BUSY_TX（正在发送）
• HAL_UART_STATE_BUSY_RX （正在接收）
• HAL_UART_STATE_TIMEOUT（超时）
• HAL_UART_STATE_ERROR（错误）

uint32_t hal_uart_get_error(uart_handle_t *p_uart)

获取UART错误码。

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

UART错误码，值可以是下面中的任意一个：

• HAL_UART_ERROR_NONE（无错误）
• HAL_UART_ERROR_PE（校验位错误）
• HAL_UART_ERROR_FE（帧错误）
• HAL_UART_ERROR_OE（溢出错误）
• HAL_UART_ERROR_BI（Line Break错误）
• HAL_UART_ERROR_DMA（DMA传输错误）
• HAL_UART_ERROR_BUSY（忙）

hal_status_t hal_uart_suspend_reg(uart_handle_t *p_uart)

睡眠之前挂起和UART配置相关的寄存器

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。

hal_status_t hal_uart_resume_reg(uart_handle_t *p_uart)

唤醒时恢复和UART配置相关的寄存器

p_uart：指向uart_handle_t结构体变量的指针，该结构体变量包含指定的UART的配置信息。