LibXR::ESP32GPIO Class Reference

ESP32 GPIO 驱动实现 / ESP32 GPIO driver implementation. More...

#include <esp_gpio.hpp>

Inheritance diagram for LibXR::ESP32GPIO:

Collaboration diagram for LibXR::ESP32GPIO:

Public Member Functions
	ESP32GPIO (gpio_num_t gpio_num)
	构造 GPIO 对象 / Construct GPIO object
bool	Read () override
	读取 GPIO 引脚状态 / Reads the GPIO pin state.
void	Write (bool value) override
	写入 GPIO 引脚状态 / Writes the GPIO pin state.
ErrorCode	EnableInterrupt () override
	使能 GPIO 引脚中断 / Enables the GPIO pin interrupt.
ErrorCode	DisableInterrupt () override
	禁用 GPIO 引脚中断 / Disables the GPIO pin interrupt.
ErrorCode	SetConfig (Configuration config) override
	配置 GPIO 引脚参数 / Configures the GPIO pin settings.
Public Member Functions inherited from LibXR::GPIO
	GPIO ()
	默认构造函数 / Default constructor.
virtual	~GPIO ()=default
	虚析构函数 / Virtual destructor.
ErrorCode	RegisterCallback (Callback callback)
	注册 GPIO 事件回调函数 / Registers a callback function for GPIO events.

Static Public Member Functions
static void	InterruptDispatcher (void *arg)

Additional Inherited Members
Public Types inherited from LibXR::GPIO
enum class	Direction : uint8_t {   INPUT , OUTPUT_PUSH_PULL , OUTPUT_OPEN_DRAIN , FALL_INTERRUPT ,   RISING_INTERRUPT , FALL_RISING_INTERRUPT }
	定义 GPIO 引脚的方向类型 / Defines the direction types for GPIO pins. More...
enum class	Pull : uint8_t { NONE , UP , DOWN }
	定义 GPIO 引脚的上拉/下拉模式。 Defines the pull-up/pull-down configurations for GPIO pins. More...
using	Callback = LibXR::Callback<>
Public Attributes inherited from LibXR::GPIO
Callback	callback_
	GPIO 事件的回调函数 / Callback function for GPIO events.

Detailed Description

ESP32 GPIO 驱动实现 / ESP32 GPIO driver implementation.

Definition at line 17 of file esp_gpio.hpp.

Constructor & Destructor Documentation

ESP32GPIO()

LibXR::ESP32GPIO::ESP32GPIO ( gpio_num_t gpio_num )

inlineexplicit

构造 GPIO 对象 / Construct GPIO object

Parameters

gpio_num

GPIO 编号 / GPIO number

Definition at line 24 of file esp_gpio.hpp.

                                          : gpio_num_(gpio_num)
  {
    const bool valid = (gpio_num_ >= 0) && (gpio_num_ < GPIO_NUM_MAX);
    ASSERT(valid);
    if (valid)
    {
      map_[gpio_num_] = this;
    }
  }

Member Function Documentation

DisableInterrupt()

ErrorCode LibXR::ESP32GPIO::DisableInterrupt ( )

inlineoverridevirtual

禁用 GPIO 引脚中断 / Disables the GPIO pin interrupt.

Returns

操作结果的错误码 / Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 94 of file esp_gpio.hpp.

  {
    if (!GPIO_IS_VALID_GPIO(gpio_num_))
    {
      return ErrorCode::ARG_ERR;
    }
 
    if (!isr_handler_added_)
    {
      return ErrorCode::OK;
    }
 
    if (gpio_intr_disable(gpio_num_) != ESP_OK)
    {
      return ErrorCode::FAILED;
    }
    return ErrorCode::OK;
  }

EnableInterrupt()

ErrorCode LibXR::ESP32GPIO::EnableInterrupt ( )

inlineoverridevirtual

使能 GPIO 引脚中断 / Enables the GPIO pin interrupt.

Returns

操作结果的错误码 / Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 60 of file esp_gpio.hpp.

  {
    if (!GPIO_IS_VALID_GPIO(gpio_num_))
    {
      return ErrorCode::ARG_ERR;
    }
 
    if (!isr_service_installed_)
    {
      if (gpio_install_isr_service(0) != ESP_OK)
      {
        return ErrorCode::INIT_ERR;
      }
      isr_service_installed_ = true;
    }
 
    if (!isr_handler_added_)
    {
      if (gpio_isr_handler_add(
              gpio_num_, ESP32GPIO::InterruptDispatcher,
              reinterpret_cast<void*>(static_cast<uintptr_t>(gpio_num_))) != ESP_OK)
      {
        return ErrorCode::INIT_ERR;
      }
      isr_handler_added_ = true;
    }
 
    if (gpio_intr_enable(gpio_num_) != ESP_OK)
    {
      return ErrorCode::FAILED;
    }
    return ErrorCode::OK;
  }

InterruptDispatcher()

void IRAM_ATTR LibXR::ESP32GPIO::InterruptDispatcher ( void * arg )

static

Definition at line 6 of file esp_gpio.cpp.

{
  auto gpio_num = static_cast<gpio_num_t>(reinterpret_cast<uintptr_t>(arg));
  const bool valid = (gpio_num >= 0) && (gpio_num < GPIO_NUM_MAX);
  DEV_ASSERT_FROM_CALLBACK(valid, true);
  if (!valid)
  {
    return;
  }
 
  auto gpio = map_[gpio_num];
  if (gpio)
  {
    gpio->callback_.Run(true);
  }
}

Read()

bool LibXR::ESP32GPIO::Read ( )

inlineoverridevirtual

读取 GPIO 引脚状态 / Reads the GPIO pin state.

Returns

返回引脚状态，true 表示高电平，false 表示低电平。 Returns the pin state, true for high, false for low.

Implements LibXR::GPIO.

Definition at line 34 of file esp_gpio.hpp.

  {
    const bool valid = (gpio_num_ >= 0) && (gpio_num_ < GPIO_NUM_MAX);
    ASSERT(valid);
    if (!valid)
    {
      return false;
    }
 
    gpio_hal_context_t hal = {.dev = LibXREspGpioHw()};
    return gpio_hal_get_level(&hal, gpio_num_) != 0;
  }

SetConfig()

ErrorCode LibXR::ESP32GPIO::SetConfig ( Configuration config )

inlineoverridevirtual

配置 GPIO 引脚参数 / Configures the GPIO pin settings.

Parameters

config

需要应用的 GPIO 配置 / The GPIO configuration to apply.

Returns

操作结果的错误码 / Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 113 of file esp_gpio.hpp.

  {
    if (!GPIO_IS_VALID_GPIO(gpio_num_))
    {
      return ErrorCode::ARG_ERR;
    }
 
    gpio_hal_context_t hal = {.dev = LibXREspGpioHw()};
 
    // Align with ST/CH reconfigure semantics: no full reset, only re-apply mode fields.
    gpio_hal_set_output_enable_ctrl(&hal, gpio_num_, false, false);
    gpio_hal_func_sel(&hal, gpio_num_, PIN_FUNC_GPIO);
 
    gpio_hal_pullup_dis(&hal, gpio_num_);
    gpio_hal_pulldown_dis(&hal, gpio_num_);
    gpio_hal_od_disable(&hal, gpio_num_);
    gpio_hal_set_intr_type(&hal, gpio_num_, GPIO_INTR_DISABLE);
 
    switch (config.pull)
    {
      case Pull::NONE:
        break;
      case Pull::UP:
        gpio_hal_pullup_en(&hal, gpio_num_);
        break;
      case Pull::DOWN:
        gpio_hal_pulldown_en(&hal, gpio_num_);
        break;
    }
 
    switch (config.direction)
    {
      case Direction::INPUT:
        gpio_hal_input_enable(&hal, gpio_num_);
        gpio_hal_output_disable(&hal, gpio_num_);
        break;
      case Direction::OUTPUT_PUSH_PULL:
        gpio_hal_input_disable(&hal, gpio_num_);
        gpio_hal_matrix_out_default(&hal, gpio_num_);
        gpio_hal_output_enable(&hal, gpio_num_);
        break;
      case Direction::OUTPUT_OPEN_DRAIN:
        gpio_hal_input_enable(&hal, gpio_num_);
        gpio_hal_matrix_out_default(&hal, gpio_num_);
        gpio_hal_output_enable(&hal, gpio_num_);
        gpio_hal_od_enable(&hal, gpio_num_);
        break;
      case Direction::FALL_INTERRUPT:
        gpio_hal_input_enable(&hal, gpio_num_);
        gpio_hal_output_disable(&hal, gpio_num_);
        gpio_hal_set_intr_type(&hal, gpio_num_, GPIO_INTR_NEGEDGE);
        break;
      case Direction::RISING_INTERRUPT:
        gpio_hal_input_enable(&hal, gpio_num_);
        gpio_hal_output_disable(&hal, gpio_num_);
        gpio_hal_set_intr_type(&hal, gpio_num_, GPIO_INTR_POSEDGE);
        break;
      case Direction::FALL_RISING_INTERRUPT:
        gpio_hal_input_enable(&hal, gpio_num_);
        gpio_hal_output_disable(&hal, gpio_num_);
        gpio_hal_set_intr_type(&hal, gpio_num_, GPIO_INTR_ANYEDGE);
        break;
    }
 
    return ErrorCode::OK;
  }

Write()

void LibXR::ESP32GPIO::Write ( bool value )

inlineoverridevirtual

写入 GPIO 引脚状态 / Writes the GPIO pin state.

Parameters

value

要写入的状态，true 表示高电平，false 表示低电平。 The value to write, true for high, false for low.

Implements LibXR::GPIO.

Definition at line 47 of file esp_gpio.hpp.

  {
    const bool valid = (gpio_num_ >= 0) && (gpio_num_ < GPIO_NUM_MAX);
    ASSERT(valid);
    if (!valid)
    {
      return;
    }
 
    gpio_hal_context_t hal = {.dev = LibXREspGpioHw()};
    gpio_hal_set_level(&hal, gpio_num_, value ? 1 : 0);
  }

---

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

• driver/esp/esp_gpio.hpp
• driver/esp/esp_gpio.cpp