#include <uart.h>

类 DRIVER_UART::Uart 继承关系图:

DRIVER_UART::Uart 的协作图:

Public 成员函数
virtual void	open (int32_t index)=0
	打开UART通道

virtual void	close (int32_t index)=0
	关闭UART通道

virtual string_t	read (int32_t index, uint32_t len)=0
	读取UART数据

virtual string_t	select_read (int32_t index, uint32_t len, uint32_t timeout)=0
	阻塞读取UART数据

virtual int32_t	write (int32_t index, const string_view_t &val)=0
	写UART数据

virtual void	send_break (int32_t index, int32_t duration)=0
	发送UART break信号

virtual void	set_baud_rate (int32_t index, uint32_t baud)=0
	设置UART波特率

virtual void	set_parity (int32_t index, char parity)=0
	设置UART校验位

virtual void	set_data_bits (int32_t index, uint8_t bits)=0
	设置UART数据位位数

virtual void	set_stop_bits (int32_t index, uint8_t bits)=0
	设置UART停止位位数

virtual uint32_t	query_uart_connection (int32_t index)=0
	查询串口链接的UART编号

virtual uint32_t	query_port_connection (int32_t index)=0
	查询UART连接的Port

virtual uint32_t	get_host_baud_rate (int32_t index)
	获取HOST的波特率

virtual void	uart_connect_uart (uint32_t src_uart, uint32_t dst_uart)
	连接UART与UART

virtual void	uart_connect_port (uint32_t src_uart, uint32_t dst_port)
	连接UART与PORT

virtual void	port_connect_port (uint32_t src_port, uint32_t dst_port)
	连接PORT与PORT

Public 成员函数继承自 bcal::IDriver
	~IDriver ()
	BCAL驱动析构

virtual void	free (void)
	BCAL驱动析构

virtual void	init (void *args, uint32_t size)=0
	BCAL驱动初始化接口

virtual void	config (int32_t index, void *config, uint32_t size)=0
	驱动实例初始化配置

virtual void	lock (int32_t index)=0
	驱动实例加锁读写锁

virtual void	unlock (int32_t index)=0
	驱动实例解锁

virtual string_t	get_version (void)=0
	获取驱动版本信息

详细描述

UART接口类

成员函数说明

◆ close()

virtual void DRIVER_UART::Uart::close ( int32_t index )

pure virtual

关闭UART通道

参数

index UART控制器编号

◆ get_host_baud_rate()

virtual uint32_t DRIVER_UART::Uart::get_host_baud_rate ( int32_t index )

virtual

获取HOST的波特率

参数

index UART控制器编号

返回: uint32_t 波特率

◆ open()

virtual void DRIVER_UART::Uart::open ( int32_t index )

pure virtual

打开UART通道

参数

index UART控制器编号

◆ port_connect_port()

virtual void DRIVER_UART::Uart::port_connect_port	(	uint32_t	src_port,
		uint32_t	dst_port
	)

virtual

连接PORT与PORT

参数

src_port	源PORT端口号
dst_port	目标PORT端口号

◆ query_port_connection()

virtual uint32_t DRIVER_UART::Uart::query_port_connection ( int32_t index )

pure virtual

查询UART连接的Port

参数

index UART控制器编号

返回: uint32_t 连接的PORT端口号

◆ query_uart_connection()

virtual uint32_t DRIVER_UART::Uart::query_uart_connection ( int32_t index )

pure virtual

查询串口链接的UART编号

参数

index UART控制器编号

返回: uint32_t 连接的UART控制器编号

◆ read()

virtual string_t DRIVER_UART::Uart::read	(	int32_t	index,
		uint32_t	len
	)

pure virtual

读取UART数据

参数

index	UART控制器编号
len	读取数据的长度，单位: 字节

返回: string_t 读取到的数据字符串

◆ select_read()

virtual string_t DRIVER_UART::Uart::select_read	(	int32_t	index,
		uint32_t	len,
		uint32_t	timeout
	)

pure virtual

阻塞读取UART数据

参数

index	UART控制器编号
len	读取数据的长度，单位: 字节
timeout	阻塞读取的超时时间，单位: ms

返回: string_t 读取到的数据字符串

◆ send_break()

virtual void DRIVER_UART::Uart::send_break	(	int32_t	index,
		int32_t	duration
	)

pure virtual

发送UART break信号

参数

index	UART控制器编号
duration	break信号持续时间，单位ms

◆ set_baud_rate()

virtual void DRIVER_UART::Uart::set_baud_rate	(	int32_t	index,
		uint32_t	baud
	)

pure virtual

设置UART波特率

参数

index	UART控制器编号
baud	波特率

◆ set_data_bits()

virtual void DRIVER_UART::Uart::set_data_bits	(	int32_t	index,
		uint8_t	bits
	)

pure virtual

设置UART数据位位数

参数

index	UART控制器编号
bits	数据位，通常为5、6、7、8

◆ set_parity()

virtual void DRIVER_UART::Uart::set_parity	(	int32_t	index,
		char	parity
	)

pure virtual

设置UART校验位

参数

index	UART控制器编号
parity	校验位类型，'O' 奇校验，'E' 偶校验，'M' MARK校验，'S' SPACE校验，'N' 不校验

◆ set_stop_bits()

virtual void DRIVER_UART::Uart::set_stop_bits	(	int32_t	index,
		uint8_t	bits
	)

pure virtual

设置UART停止位位数

参数

index	UART控制器编号
bits	停止位，通常为1、2

◆ uart_connect_port()

virtual void DRIVER_UART::Uart::uart_connect_port	(	uint32_t	src_uart,
		uint32_t	dst_port
	)

virtual

连接UART与PORT

参数

src_uart	源串口号
dst_port	目标PORT端口号

◆ uart_connect_uart()

virtual void DRIVER_UART::Uart::uart_connect_uart	(	uint32_t	src_uart,
		uint32_t	dst_uart
	)

virtual

连接UART与UART

参数

src_uart	源串口号
dst_uart	目标串口号

◆ write()

virtual int32_t DRIVER_UART::Uart::write	(	int32_t	index,
		const string_view_t &	val
	)

pure virtual

写UART数据

参数

index	UART控制器编号
val	需要写入的数据字符串

返回: int32_t 0: 写入成功, -1: 写入失败

该类的文档由以下文件生成:

include/bcal/uart.h

Public 成员函数

详细描述

成员函数说明

◆ close()

◆ get_host_baud_rate()

◆ open()

◆ port_connect_port()

◆ query_port_connection()

◆ query_uart_connection()

◆ read()

◆ select_read()

◆ send_break()

◆ set_baud_rate()

◆ set_data_bits()

◆ set_parity()

◆ set_stop_bits()

◆ uart_connect_port()

◆ uart_connect_uart()

◆ write()