LibXR::ESP32UART Class Reference

Inheritance diagram for LibXR::ESP32UART:

Collaboration diagram for LibXR::ESP32UART:

Public Member Functions
	ESP32UART (uart_port_t port, int tx_pin, int rx_pin, uint32_t buffer_size=256, uint32_t rx_thread_stack_depth=1024, uint32_t rx_thread_priority=10)
ErrorCode	SetConfig (UART::Configuration config) override
	设置 UART 配置 / Sets the UART configuration
Public Member Functions inherited from LibXR::UART
template<typename ReadPortType = ReadPort, typename WritePortType = WritePort>
	UART (ReadPortType *read_port, WritePortType *write_port)
	UART 构造函数 / UART constructor.
template<typename OperationType , typename = std::enable_if_t<std::is_base_of_v< WriteOperation, std::decay_t<OperationType>>>>
ErrorCode	Write (ConstRawData data, OperationType &&op)
template<typename OperationType , typename = std::enable_if_t<std::is_base_of_v< ReadOperation, std::decay_t<OperationType>>>>
ErrorCode	Read (RawData data, OperationType &&op)

Static Public Member Functions
static ErrorCode	WriteFun (WritePort &port)
static ErrorCode	ReadFun (ReadPort &port)

Private Member Functions
void	HandleEvent (const uart_event_t &event)

Static Private Member Functions
static void	RxTask (void *param)
static void	TxTask (void *param)

Private Attributes
uart_port_t	port_
QueueHandle_t	event_queue_
RawData	rx_buff_
RawData	tx_buff_
ESP32UARTReadPort	_read_port
ESP32UARTWritePort	_write_port

Friends
class	ESP32UARTReadPort
class	ESP32UARTWritePort

Additional Inherited Members
Public Types inherited from LibXR::UART
enum class	Parity : uint8_t { NO_PARITY = 0 , EVEN = 1 , ODD = 2 }
	奇偶校验模式 / Parity mode More...
Data Fields inherited from LibXR::UART
ReadPort *	read_port_
	读取端口 / Read port
WritePort *	write_port_
	写入端口 / Write port

Detailed Description

Definition at line 56 of file esp_uart.hpp.

Constructor & Destructor Documentation

ESP32UART()

ESP32UART::ESP32UART	(	uart_port_t	port,
		int	tx_pin,
		int	rx_pin,
		uint32_t	buffer_size = 256,
		uint32_t	rx_thread_stack_depth = 1024,
		uint32_t	rx_thread_priority = 10 )

Definition at line 56 of file esp_uart.cpp.

    : UART(&_read_port, &_write_port),
      port_(port),
      rx_buff_(new uint8_t[buffer_size], buffer_size),
      tx_buff_(new uint8_t[buffer_size], buffer_size),
      _read_port(0, this),
      _write_port(1, 0, this)
{
  uart_config_t config = {};
  config.baud_rate = 115200;
  config.data_bits = UART_DATA_8_BITS;
  config.parity = UART_PARITY_DISABLE;
  config.stop_bits = UART_STOP_BITS_1;
  config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
  config.source_clk = UART_SCLK_APB;
 
  ESP_ERROR_CHECK(uart_param_config(port_, &config));
  ESP_ERROR_CHECK(
      uart_set_pin(port_, tx_pin, rx_pin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE));
  ESP_ERROR_CHECK(
      uart_driver_install(port_, rx_buff_.size_, tx_buff_.size_, 20, &event_queue_, 0));
 
  _read_port = ReadFun;
  _write_port = WriteFun;
 
  xTaskCreate(RxTask, "uart_rx_task", rx_thread_stack_depth, this, rx_thread_priority,
              nullptr);
}

Member Function Documentation

HandleEvent()

void ESP32UART::HandleEvent ( const uart_event_t & event )

private

Definition at line 99 of file esp_uart.cpp.

{
  switch (event.type)
  {
    case UART_DATA:
    {
      read_port_->ProcessPendingReads(false);
      break;
    }
    case UART_BUFFER_FULL:
    case UART_FIFO_OVF:
    case UART_FRAME_ERR:
    case UART_PARITY_ERR:
    {
      LibXR::Mutex::LockGuard guard(read_port_->mutex_);
 
      if (read_port_->busy_.load(std::memory_order_relaxed) ==
          LibXR::ReadPort::BusyState::Pending)
      {
        read_port_->info_.op.UpdateStatus(false, ErrorCode::FAILED);
      }
      uart_flush_input(port_);
      read_port_->Reset();
      write_port_->Reset();
      break;
    }
    default:
      break;
  }
}

ReadFun()

ErrorCode ESP32UART::ReadFun ( ReadPort & port )

static

Definition at line 153 of file esp_uart.cpp.

{
  ESP32UART *self = CONTAINER_OF(&port, ESP32UART, _read_port);
  UNUSED(self);
 
  if (port.Size() >= port.info_.data.size_)
  {
    int len =
        uart_read_bytes(self->port_, port.info_.data.addr_, port.info_.data.size_, 0);
 
    port.read_size_ = len;
    if (len == port.info_.data.size_)
    {
      return ErrorCode::OK;
    }
  }
 
  return ErrorCode::EMPTY;
}

RxTask()

void ESP32UART::RxTask ( void * param )

staticprivate

Definition at line 86 of file esp_uart.cpp.

{
  auto *self = static_cast<ESP32UART *>(param);
  uart_event_t event;
  while (true)
  {
    if (xQueueReceive(self->event_queue_, &event, portMAX_DELAY))
    {
      self->HandleEvent(event);
    }
  }
}

SetConfig()

ErrorCode ESP32UART::SetConfig ( UART::Configuration config )

overridevirtual

设置 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.

Implements LibXR::UART.

Definition at line 173 of file esp_uart.cpp.

{
  uart_config_t uart_cfg = {};
 
  uart_cfg.baud_rate = static_cast<int>(config.baudrate);
  uart_cfg.data_bits = UART_DATA_8_BITS;
  uart_cfg.parity = UART_PARITY_DISABLE;
  uart_cfg.stop_bits = UART_STOP_BITS_1;
  uart_cfg.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
  uart_cfg.source_clk = UART_SCLK_APB;
 
  switch (config.parity)
  {
    case UART::Parity::NO_PARITY:
      uart_cfg.parity = UART_PARITY_DISABLE;
      uart_cfg.data_bits = UART_DATA_8_BITS;
      break;
    case UART::Parity::EVEN:
      uart_cfg.parity = UART_PARITY_EVEN;
      uart_cfg.data_bits = UART_DATA_8_BITS;
      break;
    case UART::Parity::ODD:
      uart_cfg.parity = UART_PARITY_ODD;
      uart_cfg.data_bits = UART_DATA_8_BITS;
      break;
    default:
      return ErrorCode::ARG_ERR;
  }
 
  switch (config.stop_bits)
  {
    case 1:
      uart_cfg.stop_bits = UART_STOP_BITS_1;
      break;
    case 2:
      uart_cfg.stop_bits = UART_STOP_BITS_2;
      break;
    default:
      return ErrorCode::ARG_ERR;
  }
 
  if (uart_param_config(port_, &uart_cfg) != ESP_OK)
  {
    return ErrorCode::FAILED;
  }
 
  return ErrorCode::OK;
}

WriteFun()

ErrorCode ESP32UART::WriteFun ( WritePort & port )

static

Definition at line 130 of file esp_uart.cpp.

{
  ESP32UART *self = CONTAINER_OF(&port, ESP32UART, _write_port);
  WriteInfoBlock info;
  if (port.queue_info_->Pop(info) != ErrorCode::OK)
  {
    return ErrorCode::EMPTY;
  }
 
  size_t space = 0;
 
  uart_get_tx_buffer_free_size(self->port_, &space);
  if (space < info.data.size_)
  {
    return ErrorCode::FULL;
  }
 
  uart_write_bytes(self->port_, static_cast<const char *>(info.data.addr_),
                   info.data.size_);
 
  return ErrorCode::OK;
}

Friends And Related Symbol Documentation

ESP32UARTReadPort

friend class ESP32UARTReadPort

friend

Definition at line 67 of file esp_uart.hpp.

ESP32UARTWritePort

friend class ESP32UARTWritePort

friend

Definition at line 68 of file esp_uart.hpp.

Field Documentation

_read_port

ESP32UARTReadPort LibXR::ESP32UART::_read_port

private

Definition at line 80 of file esp_uart.hpp.

_write_port

ESP32UARTWritePort LibXR::ESP32UART::_write_port

private

Definition at line 81 of file esp_uart.hpp.

event_queue_

QueueHandle_t LibXR::ESP32UART::event_queue_

private

Definition at line 76 of file esp_uart.hpp.

port_

uart_port_t LibXR::ESP32UART::port_

private

Definition at line 75 of file esp_uart.hpp.

rx_buff_

RawData LibXR::ESP32UART::rx_buff_

private

Definition at line 77 of file esp_uart.hpp.

tx_buff_

RawData LibXR::ESP32UART::tx_buff_

private

Definition at line 78 of file esp_uart.hpp.

---

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

• driver/esp/esp_uart.hpp
• driver/esp/esp_uart.cpp