LibXR::LinuxGPIO Class Reference

基于 Linux GPIO character device uAPI 的 Linux GPIO 实现 Linux GPIO implementation based on the Linux GPIO character-device uAPI More...

#include <linux_gpio.hpp>

Inheritance diagram for LibXR::LinuxGPIO:

Collaboration diagram for LibXR::LinuxGPIO:

Public Member Functions
	LinuxGPIO (const std::string &chip_path, unsigned int line_offset)
	LinuxGPIO (const LinuxGPIO &)=delete
LinuxGPIO &	operator= (const LinuxGPIO &)=delete
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.

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

基于 Linux GPIO character device uAPI 的 Linux GPIO 实现 Linux GPIO implementation based on the Linux GPIO character-device uAPI

Note

优先使用 GPIO chardev v2；旧内核仅在需要时回退到 v1。

Prefer GPIO chardev v2; fall back to v1 only on older kernels.

当前运行级验证聚焦在 chardev v2；v1 fallback 目前仅作为兼容路径保留。

Runtime validation currently focuses on chardev v2; the v1 fallback is kept as a compatibility path.

Definition at line 25 of file linux_gpio.hpp.

Constructor & Destructor Documentation

LinuxGPIO()

LibXR::LinuxGPIO::LinuxGPIO	(	const std::string &	chip_path,
		unsigned int	line_offset )

Definition at line 295 of file linux_gpio.cpp.

    : chip_path_(chip_path), line_offset_(line_offset)
{
  UNUSED(InitInterruptWakePipe());
  UNUSED(OpenChip());
}

~LinuxGPIO()

LibXR::LinuxGPIO::~LinuxGPIO ( )

override

Definition at line 302 of file linux_gpio.cpp.

{
  interrupt_thread_exit_.store(true);
  request_kind_.store(RequestKind::NONE);
  interrupt_enabled_.store(false);
  NotifyInterruptThread();
  WaitForInterruptThreadStopped();
  CloseRequest();
  CloseChip();
  CloseInterruptWakePipe();
}

Member Function Documentation

DisableInterrupt()

ErrorCode LibXR::LinuxGPIO::DisableInterrupt ( )

overridevirtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 421 of file linux_gpio.cpp.

{
  if (EnsureConfigured() != ErrorCode::OK)
  {
    return ErrorCode::STATE_ERR;
  }
 
  if (!IsInterruptDirection(current_config_.direction))
  {
    return ErrorCode::ARG_ERR;
  }
 
  if (!interrupt_enabled_.load())
  {
    return ErrorCode::OK;
  }
 
  const Configuration inactive_config = ResolveRequestConfig(current_config_, false);
  ErrorCode ec = ErrorCode::OK;
  if (NeedsRequestReopen(inactive_config))
  {
    ec = ReopenRequest(inactive_config);
  }
  else if (abi_version_.load() == AbiVersion::V2)
  {
    ec = ReconfigureRequestV2(inactive_config);
  }
  else
  {
    ec = ReconfigureRequestV1(inactive_config);
  }
  if (ec != ErrorCode::OK)
  {
    return ec;
  }
 
  has_config_ = true;
  interrupt_enabled_.store(false);
  return ErrorCode::OK;
}

EnableInterrupt()

ErrorCode LibXR::LinuxGPIO::EnableInterrupt ( )

overridevirtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 380 of file linux_gpio.cpp.

{
  if (EnsureConfigured() != ErrorCode::OK)
  {
    return ErrorCode::STATE_ERR;
  }
 
  if (!IsInterruptDirection(current_config_.direction))
  {
    return ErrorCode::ARG_ERR;
  }
 
  if (interrupt_enabled_.load())
  {
    return ErrorCode::OK;
  }
 
  ErrorCode ec = ErrorCode::OK;
  if (NeedsRequestReopen(current_config_))
  {
    ec = ReopenRequest(current_config_);
  }
  else if (abi_version_.load() == AbiVersion::V2)
  {
    ec = ReconfigureRequestV2(current_config_);
  }
  else
  {
    ec = ReconfigureRequestV1(current_config_);
  }
  if (ec != ErrorCode::OK)
  {
    return ec;
  }
 
  has_config_ = true;
  interrupt_enabled_.store(true);
  StartInterruptThread();
  return ErrorCode::OK;
}

Read()

bool LibXR::LinuxGPIO::Read ( )

overridevirtual

读取 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 314 of file linux_gpio.cpp.

{
  if (EnsureConfigured() != ErrorCode::OK)
  {
    return false;
  }
 
  const int request_fd = request_fd_.load();
  if (abi_version_.load() == AbiVersion::V2)
  {
#if XR_LINUX_GPIO_HAS_V2
    gpio_v2_line_values values = {};
    values.mask = 1ULL;
    if (ioctl(request_fd, GPIO_V2_LINE_GET_VALUES_IOCTL, &values) < 0)
    {
      XR_LOG_ERROR("Failed to read GPIO value: %s", std::strerror(errno));
      return false;
    }
    return (values.bits & 1ULL) != 0U;
#else
    return false;
#endif
  }
 
  gpiohandle_data values = {};
  if (ioctl(request_fd, GPIOHANDLE_GET_LINE_VALUES_IOCTL, &values) < 0)
  {
    XR_LOG_ERROR("Failed to read GPIO value: %s", std::strerror(errno));
    return false;
  }
 
  return values.values[0] != 0U;
}

SetConfig()

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

overridevirtual

配置 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 462 of file linux_gpio.cpp.

{
  const ErrorCode chip_ready = OpenChip();
  if (chip_ready != ErrorCode::OK)
  {
    return chip_ready;
  }
 
  const bool keep_interrupt_enabled =
      interrupt_enabled_.load() && IsInterruptDirection(config.direction);
  const Configuration request_config =
      ResolveRequestConfig(config, keep_interrupt_enabled);
 
  ErrorCode ec = ErrorCode::OK;
  if (request_fd_.load() < 0)
  {
    ec = ReopenRequest(request_config);
  }
  else if (NeedsRequestReopen(request_config))
  {
    ec = ReopenRequest(request_config);
  }
  else if (abi_version_.load() == AbiVersion::V2)
  {
    ec = ReconfigureRequestV2(request_config);
  }
  else
  {
    ec = ReconfigureRequestV1(request_config);
  }
 
  if (ec != ErrorCode::OK)
  {
    return ec;
  }
 
  current_config_ = config;
  has_config_ = true;
  interrupt_enabled_.store(keep_interrupt_enabled);
  if (keep_interrupt_enabled)
  {
    StartInterruptThread();
  }
  return ErrorCode::OK;
}

Write()

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

overridevirtual

写入 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 348 of file linux_gpio.cpp.

{
  if (EnsureConfigured() != ErrorCode::OK)
  {
    return;
  }
 
  const int request_fd = request_fd_.load();
  if (abi_version_.load() == AbiVersion::V2)
  {
#if XR_LINUX_GPIO_HAS_V2
    gpio_v2_line_values values = {};
    values.mask = 1ULL;
    values.bits = value ? 1ULL : 0ULL;
    if (ioctl(request_fd, GPIO_V2_LINE_SET_VALUES_IOCTL, &values) < 0)
    {
      XR_LOG_WARN("Failed to write GPIO value: %s", std::strerror(errno));
    }
    return;
#else
    return;
#endif
  }
 
  gpiohandle_data values = {};
  values.values[0] = value ? 1U : 0U;
  if (ioctl(request_fd, GPIOHANDLE_SET_LINE_VALUES_IOCTL, &values) < 0)
  {
    XR_LOG_WARN("Failed to write GPIO value: %s", std::strerror(errno));
  }
}

---

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

• driver/linux/linux_gpio.hpp
• driver/linux/linux_gpio.cpp