通用异步收发传输（UART）基类 / Abstract base class for Universal Asynchronous Receiver-Transmitter (UART) More...

#include <uart.hpp>

Inheritance diagram for LibXR::UART:

[legend]

Collaboration diagram for LibXR::UART:

[legend]

Data Structures
struct	Configuration
	UART 配置结构体 / UART configuration structure. More...

Public Types
enum class	Parity : uint8_t { NO_PARITY = 0 , EVEN = 1 , ODD = 2 }
	奇偶校验模式 / Parity mode More...

Public Member Functions
	UART (size_t rx_queue_size, size_t rx_buffer_size, size_t tx_queue_size, size_t tx_buffer_size)
	UART 构造函数 / UART constructor.

virtual ErrorCode	SetConfig (Configuration config)=0
	设置 UART 配置 / Sets the UART configuration

Data Fields
ReadPort	read_port_
	读取端口 / Read port

WritePort	write_port_
	写入端口 / Write port

Detailed Description

通用异步收发传输（UART）基类 / Abstract base class for Universal Asynchronous Receiver-Transmitter (UART)

该类定义了 UART 设备的基本接口，包括配置和数据传输端口。 This class defines the basic interface for a UART device, including configuration and data transmission ports.

Definition at line 18 of file uart.hpp.

Member Enumeration Documentation

◆ Parity

enum class LibXR::UART::Parity : uint8_t

strong

奇偶校验模式 / Parity mode

指定 UART 传输时的奇偶校验模式。 Specifies the parity mode used in UART transmission.

Enumerator
NO_PARITY	无校验 / No parity
EVEN	偶校验 / Even parity
ODD	奇校验 / Odd parity

Definition at line 28 of file uart.hpp.

  {
    NO_PARITY = 0,  
    EVEN = 1,       
    ODD = 2         
  };

Constructor & Destructor Documentation

◆ UART()

LibXR::UART::UART	(	size_t	rx_queue_size,
		size_t	rx_buffer_size,
		size_t	tx_queue_size,
		size_t	tx_buffer_size
	)

inline

UART 构造函数 / UART constructor.

Parameters

rx_queue_size	接收队列大小 / Receive queue size
rx_buffer_size	接收缓冲区大小 / Receive buffer size
tx_queue_size	发送队列大小 / Transmit queue size
tx_buffer_size	发送缓冲区大小 / Transmit buffer size

该构造函数初始化 UART 的读取和写入端口。 This constructor initializes the read and write ports of the UART.

Definition at line 64 of file uart.hpp.

      : read_port_(rx_queue_size, rx_buffer_size),
        write_port_(tx_queue_size, tx_buffer_size)
  {
  }

Member Function Documentation

◆ SetConfig()

virtual ErrorCode LibXR::UART::SetConfig ( Configuration config )

pure virtual

设置 UART 配置 / Sets the UART configuration

Parameters

config UART 配置信息 / UART configuration settings

Returns: 返回操作状态，成功时返回 ErrorCode::OK，否则返回相应错误码 / Returns the operation status, ErrorCode::OK if successful, otherwise an error code

该方法为纯虚函数，子类必须实现具体的 UART 配置逻辑。 This is a pure virtual function. Subclasses must implement the specific UART configuration logic.

Implemented in LibXR::STM32UART, LibXR::STM32VirtualUART, and LibXR::LinuxUART.

Field Documentation

◆ read_port_

ReadPort LibXR::UART::read_port_

读取端口 / Read port

Definition at line 51 of file uart.hpp.

◆ write_port_

WritePort LibXR::UART::write_port_

写入端口 / Write port

Definition at line 52 of file uart.hpp.

The documentation for this class was generated from the following file:

src/driver/uart.hpp

Data Structures

Public Types

Public Member Functions

Data Fields