通用异步收发传输器 (UART)

概述

嵌入式应用通常要求一个简单的并且占用系统资源少的方法来传输数据。通用异步收发传输器 (UART) 即可以满足这些要求，它能够灵活地与外部设备进行全双工数据交换。

功能描述

UART 模块具有以下功能：

配置 UART 参数
自动收取数据到缓冲区

API 参考

对应的头文件 uart.h

为用户提供以下接口

uart_init
uart_config (0.6.0后不再支持，请使用uart_configure)
uart_configure
uart_send_data
uart_send_data_dma
uart_send_data_dma_irq
uart_receive_data
uart_receive_data_dma
uart_receive_data_dma_irq
uart_irq_register
uart_irq_deregister
uart_set_work_mode
uart_set_rede_polarity
uart_set_rede_enable
uart_set_tat
uart_set_det
uart_debug_init
uart_handle_data_dma

uart_init

描述

初始化uart。

函数原型

void uart_init(uart_device_number_t channel)

参数

参数名称	描述	输入输出
channel	UART号	输入

返回值

无。

uart_configure

描述

设置UART相关参数。该函数已废弃，替代函数为uart_configure。

uart_configure

描述

设置UART相关参数。

函数原型

void uart_configure(uart_device_number_t channel, uint32_t baud_rate, uart_bitwidth_t data_width, uart_stopbit_t stopbit, uart_parity_t parity)

参数

参数名称	描述	输入输出
channel	UART 编号	输入
baud_rate	波特率	输入
data_width	数据位 (5-8)	输入
stopbit	停止位	输入
parity	校验位	输入

返回值

无。

uart_send_data

描述

通过UART发送数据。

函数原型

int uart_send_data(uart_device_number_t channel, const char *buffer, size_t buf_len)

参数

参数名称	描述	输入输出
channel	UART 编号	输入
buffer	待发送数据	输入
buf_len	待发送数据的长度	输入

返回值

已发送数据的长度。

uart_send_data_dma

描述

UART通过DMA发送数据。数据全部发送完毕后返回。

函数原型

void uart_send_data_dma(uart_device_number_t uart_channel, dmac_channel_number_t dmac_channel, const uint8_t *buffer, size_t buf_len)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
dmac_channel	DMA通道	输入
buffer	待发送数据	输入
buf_len	待发送数据的长度	输入

返回值

无。

uart_send_data_dma_irq

描述

UART通过DMA发送数据，并设置DMA发送完成中断函数，仅单次中断。

函数原型

void uart_send_data_dma_irq(uart_device_number_t uart_channel, dmac_channel_number_t dmac_channel,
                            const uint8_t *buffer, size_t buf_len, plic_irq_callback_t uart_callback,
                            void *ctx, uint32_t priority)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
dmac_channel	DMA通道	输入
buffer	待发送数据	输入
buf_len	待发送数据的长度	输入
uart_callback	DMA中断回调	输入
ctx	中断函数参数	输入
priority	中断优先级	输入

返回值

无。

uart_receive_data

描述

通过UART读取数据。

函数原型

int uart_receive_data(uart_device_number_t channel, char *buffer, size_t buf_len);

参数

参数名称	描述	输入输出
channel	UART 编号	输入
buffer	接收数据	输出
buf_len	接收数据的长度	输入

返回值

已接收到的数据长度。

uart_receive_data_dma

描述

UART通过DMA接收数据。

函数原型

void uart_receive_data_dma(uart_device_number_t uart_channel, dmac_channel_number_t dmac_channel, uint8_t *buffer, size_t buf_len)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
dmac_channel	DMA通道	输入
buffer	接收数据	输出
buf_len	接收数据的长度	输入

返回值

无。

uart_receive_data_dma_irq

描述

UART通过DMA接收数据，并注册DMA接收完成中断函数，仅单次中断。

函数原型

void uart_receive_data_dma_irq(uart_device_number_t uart_channel, dmac_channel_number_t dmac_channel,
                                     uint8_t *buffer, size_t buf_len, plic_irq_callback_t uart_callback,
                                     void *ctx, uint32_t priority)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
dmac_channel	DMA通道	输入
buffer	接收数据	输出
buf_len	接收数据的长度	输入
uart_callback	DMA中断回调	输入
ctx	中断函数参数	输入
priority	中断优先级	输入

返回值

无。

uart_irq_register

描述

注册UART中断函数。

函数原型

void uart_irq_register(uart_device_number_t channel, uart_interrupt_mode_t interrupt_mode, plic_irq_callback_t uart_callback, void *ctx, uint32_t priority)

参数

参数名称	描述	输入输出
channel	UART 编号	输入
interrupt_mode	中断类型	输入
uart_callback	中断回调	输入
ctx	中断函数参数	输入
priority	中断优先级	输入

返回值

无。

uart_irq_deregister

描述

注销UART中断函数。

函数原型

void uart_irq_deregister(uart_device_number_t channel, uart_interrupt_mode_t interrupt_mode)

参数

参数名称	描述	输入输出
channel	UART 编号	输入
interrupt_mode	中断类型	输入

返回值

无。

uart_set_work_mode

描述

设置uart工作模式。有四种模式：普通uart、红外、RS485全双工、RS485半双工。

函数原型

void uart_set_work_mode(uart_device_number_t uart_channel, uart_work_mode_t work_mode)

参数

参数名称	描述	输入输出
channel	UART 编号	输入
work_mode	工作模式，详细见uart_work_mode_t结构体说明	输入

返回值

无。

uart_set_rede_polarity

描述

设置RS485 re de 管脚有效时的极性。

函数原型

void uart_set_rede_polarity(uart_device_number_t uart_channel, uart_rs485_rede_t rede, uart_polarity_t polarity)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
rede	re 或de 管脚	输入
polarity	有效时极性	输入

返回值

无。

uart_set_rede_enable

描述

使能 re de管脚，主要用在rs485全双工模式，re和de必须手动控制。单双工模式不用调用该函数，单双工时硬件会自动设置re de。

函数原型

void uart_set_rede_enable(uart_device_number_t uart_channel, uart_rs485_rede_t rede, bool enable)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
rede	re 或de 管脚	输入
enable	是否有效	输入

返回值

无。

uart_set_tat

描述

配置re de互相的时间间隔，这个与外部的485模块有关。

函数原型

void uart_set_tat(uart_device_number_t uart_channel, uart_tat_mode_t tat_mode, size_t time)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
tat_mode	转换模式re到de或de到re	输入
time	时间（纳秒）	输入

返回值

无。

uart_set_det

描述

设置de 有效无效转换时数据的时间延时。

函数原型

void uart_set_det(uart_device_number_t uart_channel, uart_det_mode_t det_mode, size_t time)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
det_mode	转换模式，de无效转有效或有效转无效	输入
time	时间（纳秒）	输入

返回值

无。

uart_debug_init

描述

配置调试串口。系统默认使用UART3做为调试串口，调用该函数用户可以自定义使用哪个uart做为调试串口，如果使用UART1或UART2需要使用fpioa设置管脚。因此调试脚不局限于fpioa4、5。

函数原型

void uart_debug_init(uart_device_number_t uart_channel)

参数

参数名称	描述	输入输出
uart_channel	UART 编号，-1则默认使用上次设置的UART	输入

返回值

无。

uart_handle_data_dma

描述

UART通过DMA传输数据。

函数原型

void uart_handle_data_dma(uart_device_number_t uart_channel ,uart_data_t data, plic_interrupt_t *cb)

参数

参数名称	描述	输入输出
uart_channel	UART 编号	输入
data	UART数据相关的参数，详见i2c_data_t说明	输入
cb	dma中断回调函数，如果设置为NULL则为阻塞模式，直至传输完毕后退出函数	输入

返回值

无

举例

/* UART1 波特率115200, 8位数据， 1位停止位，无校验位 */
uart_init(UART_DEVICE_1);
uart_config(UART_DEVICE_1, 115200, UART_BITWIDTH_8BIT, UART_STOP_1, UART_PARITY_NONE);
char *v_hel = {"hello world!\n"};
/* 发送 hello world! */
uart_send_data(UART_DEVICE_1, hel, strlen(v_hel));
/* 接收数据 */
while(uart_receive_data(UART_DEVICE_1, &recv, 1))
{
    printf("%c ", recv);
}

数据类型

相关数据类型、数据结构定义如下：

uart_device_number_t：UART 编号。
uart_bitwidth_t：UART 数据位宽。
uart_stopbits_t：UART 停止位。
uart_parity_t：UART 校验位。
uart_interrupt_mode_t：UART中断类型，接收或发送。
uart_send_trigger_t：发送中断或DMA触发FIFO深度。
uart_receive_trigger_t：接收中断或DMA触发FIFO深度。
uart_data_t：使用dma传输时数据相关的参数。
uart_interrupt_mode_t：传输模式，发送或接收。
uart_work_mode_t：UART工作模式。
uart_rs485_rede_t：选择re de管脚。
uart_polarity_t：de re极性。
uart_tat_mode_t：de re转换选择。
uart_det_mode_t：de 有效无效选择。

uart_device_number_t

描述

UART编号。

定义

typedef enum _uart_device_number
{
    UART_DEVICE_1,
    UART_DEVICE_2,
    UART_DEVICE_3,
    UART_DEVICE_MAX,
} uart_device_number_t;

成员

成员名称	描述
UART_DEVICE_1	UART 1
UART_DEVICE_2	UART 2
UART_DEVICE_3	UART 3

uart_bitwidth_t

描述

UART数据位宽。

定义

typedef enum _uart_bitwidth
{
    UART_BITWIDTH_5BIT = 0,
    UART_BITWIDTH_6BIT,
    UART_BITWIDTH_7BIT,
    UART_BITWIDTH_8BIT,
} uart_bitwidth_t;

成员

成员名称	描述
UART_BITWIDTH_5BIT	5比特
UART_BITWIDTH_6BIT	6比特
UART_BITWIDTH_7BIT	7比特
UART_BITWIDTH_8BIT	8比特

uart_stopbits_t

描述

UART 停止位。

定义

typedef enum _uart_stopbits
{
    UART_STOP_1,
    UART_STOP_1_5,
    UART_STOP_2
} uart_stopbits_t;

成员

成员名称	描述
UART_STOP_1	1 个停止位
UART_STOP_1_5	1.5 个停止位
UART_STOP_2	2 个停止位

uart_parity_t

描述

UART 校验位。

定义

typedef enum _uart_parity
{
    UART_PARITY_NONE,
    UART_PARITY_ODD,
    UART_PARITY_EVEN
} uart_parity_t;

成员

成员名称	描述
UART_PARITY_NONE	无校验位
UART_PARITY_ODD	奇校验
UART_PARITY_EVEN	偶校验

uart_interrupt_mode_t

描述

UART中断类型，接收或发送。

定义

typedef enum _uart_interrupt_mode
{
    UART_SEND = 1,
    UART_RECEIVE = 2,
} uart_interrupt_mode_t;

成员

成员名称	描述
UART_SEND	UART 发送
UART_RECEIVE	UART 接收

uart_send_trigger_t

描述

发送中断或DMA触发FIFO深度。当FIFO中的数据小于等于该值时触发中断或DMA传输。FIFO的深度为16字节。

定义

typedef enum _uart_send_trigger
{
    UART_SEND_FIFO_0,
    UART_SEND_FIFO_2,
    UART_SEND_FIFO_4,
    UART_SEND_FIFO_8,
} uart_send_trigger_t;

成员

成员名称	描述
UART_SEND_FIFO_0	FIFO为空
UART_SEND_FIFO_2	FIFO剩余2字节
UART_SEND_FIFO_4	FIFO剩余4字节
UART_SEND_FIFO_8	FIFO剩余8字节

uart_receive_trigger_t

描述

接收中断或DMA触发FIFO深度。当FIFO中的数据大于等于该值时触发中断或DMA传输。FIFO的深度为16字节。

定义

typedef enum _uart_receive_trigger
{
    UART_RECEIVE_FIFO_1,
    UART_RECEIVE_FIFO_4,
    UART_RECEIVE_FIFO_8,
    UART_RECEIVE_FIFO_14,
} uart_receive_trigger_t;

成员

成员名称	描述
UART_RECEIVE_FIFO_1	FIFO剩余1字节
UART_RECEIVE_FIFO_4	FIFO剩余2字节
UART_RECEIVE_FIFO_8	FIFO剩余4字节
UART_RECEIVE_FIFO_14	FIFO剩余8字节

uart_data_t

描述

使用dma传输时数据相关的参数。

定义

typedef struct _uart_data_t
{
    dmac_channel_number_t tx_channel;
    dmac_channel_number_t rx_channel;
    uint32_t *tx_buf;
    size_t tx_len;
    uint32_t *rx_buf;
    size_t rx_len;
    uart_interrupt_mode_t transfer_mode;
} uart_data_t;

成员

成员名称	描述
tx_channel	发送时使用的DMA通道号
rx_channel	接收时使用的DMA通道号
tx_buf	发送的数据
tx_len	发送数据的长度
rx_buf	接收的数据
rx_len	接收数据长度
transfer_mode	传输模式，发送或接收

uart_interrupt_mode_t

描述

UART数据传输模式。

定义

typedef enum _uart_interrupt_mode
{
    UART_SEND = 1,
    UART_RECEIVE = 2,
} uart_interrupt_mode_t;

成员

成员名称	描述
UART_SEND	发送
UART_RECEIVE	接收

uart_work_mode_t

描述

UART工作模式。

定义

typedef enum _uart_work_mode
{
    UART_NORMAL,
    UART_IRDA,
    UART_RS485_FULL_DUPLEX,
    UART_RS485_HALF_DUPLEX,
} uart_work_mode_t;

成员

成员名称	描述
UART_NORMAL	普通UART
UART_IRDA	红外
UART_RS485_FULL_DUPLEX	全双工RS485
UART_RS485_HALF_DUPLEX	半双工RS485

uart_rs485_rede_t

描述

RS485 re de管脚。

定义

typedef enum _uart_rs485_rede
{
    UART_RS485_DE,
    UART_RS485_RE,
    UART_RS485_REDE,
} uart_rs485_rede_t;

成员

成员名称	描述
UART_RS485_DE	选择de管脚
UART_RS485_RE	选择re管脚
UART_RS485_REDE	同时选择de re管脚

uart_polarity_t

描述

re de 有效时的极性。

定义

typedef enum _uart_polarity
{
    UART_LOW,
    UART_HIGH,
} uart_polarity_t;

成员

成员名称	描述
UART_LOW	低电平
UART_HIGH	高电平

uart_tat_mode_t

描述

re de转换的模式。

定义

typedef enum _uart_tat_mode
{
    UART_DE_TO_RE,
    UART_RE_TO_DE,
    UART_TAT_ALL,
} uart_tat_mode_t;

成员

成员名称	描述
UART_DE_TO_RE	de 有效转 re有效
UART_RE_TO_DE	re 有效转 de有效
UART_TAT_ALL	de转re re转de

uart_det_mode_t

描述

de 有效无效选择。

定义

typedef enum _uart_det_mode
{
    UART_DE_ASSERTION,
    UART_DE_DE_ASSERTION,
    UART_DE_ALL,
} uart_det_mode_t;

成员

成员名称	描述
UART_DE_ASSERTION	de 有效
UART_DE_DE_ASSERTION	de 无效
UART_DE_ALL	de 有效无效

Files

UART.md

Latest commit

History

UART.md

File metadata and controls

通用异步收发传输器 (UART)

概述

功能描述

API 参考

uart_init

描述

函数原型

参数

返回值

uart_configure

描述

uart_configure

描述

函数原型

参数

返回值

uart_send_data

描述

函数原型

参数

返回值

uart_send_data_dma

描述

函数原型

参数

返回值

uart_send_data_dma_irq

描述

函数原型

参数

返回值

uart_receive_data

描述

函数原型

参数

返回值

uart_receive_data_dma

描述

函数原型

参数

返回值

uart_receive_data_dma_irq

描述

函数原型

参数

返回值

uart_irq_register

描述

函数原型

参数

返回值

uart_irq_deregister

描述

函数原型

参数

返回值

uart_set_work_mode

描述

函数原型

参数

返回值

uart_set_rede_polarity

描述

函数原型

参数

返回值

uart_set_rede_enable

描述

函数原型

参数

返回值

uart_set_tat

描述

函数原型