CN / EN

全部 创新产品 应用与设计 文档中心 工具与软件 开发者社区 关于汇顶
文档反馈
感谢关注汇顶文档，期待您的宝贵建议！
感谢您的反馈，祝您愉快！
无匹配项 共计114个匹配页面
文档中心 > GR5xx APP驱动用户手册/ APP驱动接口/ APP UART驱动/ 接口函数 Copy URL

接口函数

表 65 UART驱动接口函数
API 芯片
GR551x GR5526

app_uart_init

Y

Y

app_uart_deinit

Y

Y

app_uart_transmit_async

Y

Y

app_uart_transmit_sync

Y

Y

app_uart_receive_async

Y

Y

app_uart_receive_sync

Y

Y

app_uart_flush

Y

Y

app_uart_abort

Y

Y

app_uart_abort_transmit

Y

Y

app_uart_abort_receive

Y

Y

app_uart_get_handle

Y

Y

app_uart_init

表 66 app_uart_init接口
函数原型

uint16_t app_uart_init(app_uart_params_t *p_params, app_uart_evt_handler_t evt_handler, app_uart_tx_buf_t *tx_buffer)
功能说明

初始化UART
输入参数

  • p_params：初始化参数的结构体指针

  • evt_handler：用户自己实现的中断回调函数

  • tx_buffer：发送缓存
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

回调函数形式参照typedef void (*app_uart_evt_handler_t)(app_uart_evt_t *p_evt)；

注意轮询运行模式下可以不指定中断回调函数（即evt_handler的入参可为NULL）；且一次发送的数据量不应超过app_uart_tx_buf_t中定义的缓存大小；

HAL层已经实现中断标志位的清理，用户不用关心中断标志的清理，回调函数根据返回事件类型进行相应的处理即可。

app_uart_deinit

表 67 app_uart_deinit接口
函数原型

uint16_t app_uart_deinit(app_uart_id_t id)
功能说明

反初始化UART
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_transmit_async

表 68 app_uart_transmit_async接口
函数原型

uint16_t app_uart_transmit_async(app_uart_id_t id, uint8_t *p_data, uint16_t size)
功能说明

串口中断方式（异步）发送数据
输入参数

  • id：UART模块ID（见app_uart_id_t描述）

  • p_data：需要发送的数据

  • size：需要发送的数据长度，以Byte为单位，此长度不应大于初始化的tx_buffer长度
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_transmit_sync

表 69 app_uart_transmit_sync接口
函数原型

uint16_t app_uart_transmit_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
功能说明

串口轮询方式（同步）发送数据
输入参数

  • id：UART模块ID（见app_uart_id_t描述）

  • p_data：需要发送的数据

  • size：需要发送的数据长度，以Byte为单位，此长度不应大于初始化的tx_buffer长度

  • timeout：超时时间（单位：ms）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_receive_async

表 70 app_uart_receive_async接口
函数原型

uint16_t app_uart_receive_async(app_uart_id_t id, uint8_t *p_data, uint16_t size)
功能说明

串口中断方式（异步）接收数据
输入参数

  • id：UART模块ID（见app_uart_id_t描述）

  • p_data：存放接收到的数据

  • size：设置需要接收的数据长度，以Byte为单位
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_receive_sync

表 71 app_uart_receive_sync接口
函数原型

uint16_t app_uart_receive_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
功能说明

串口轮询方式（同步）接收数据
输入参数

  • id：UART模块ID（见app_uart_id_t描述）

  • p_data：存放接收到的数据

  • size：设置需要接收的数据长度，以Byte为单位

  • timeout：超时时间（单位：ms）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_flush

表 72 app_uart_flush接口
函数原型

void app_uart_flush(app_uart_id_t id)
功能说明

立即把TX_FIFO中的数据发送出去，该功能常用于在睡眠前，可能存在数据没有发送完毕的情况，此时需要把TX_FIFO中的数据立即发送出去
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

无

备注

app_uart_abort

表 73 app_uart_abort接口
函数原型

uint16_t app_uart_abort(app_uart_id_t id)
功能说明

中止串口的数据发送和接收，会产生abort中断，调用注册的回调函数，事件类型为APP_UART_EVT_ABORT_TXRX
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_abort_transmit

表 74 app_uart_abort_transmit接口
函数原型

uint16_t app_uart_abort_transmit(app_uart_id_t id)
功能说明

中止串口的数据发送，会产生abort中断，调用注册的回调函数，事件类型为APP_UART_EVT_ABORT_TX
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_abort_receive

表 75 app_uart_abort_receive接口
函数原型

uint16_t app_uart_abort_receive(app_uart_id_t id)
功能说明

中止串口的数据接收，会产生abort中断，调用注册的回调函数，事件类型为APP_UART_EVT_ABORT_RX
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

APP_DRV_xxx：详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_uart_get_handle

表 76 app_uart_get_handle接口
函数原型

uart_handle_t *app_uart_get_handle(app_uart_id_t id)
功能说明

获取串口句柄
输入参数

id：UART模块ID（见app_uart_id_t描述）
返回值

串口句柄指针
备注

扫描关注

打开微信，使用“扫一扫”即可关注。