LibXR::CH32GPIO Class Reference

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

#include <ch32_gpio.hpp>

Inheritance diagram for LibXR::CH32GPIO:

Collaboration diagram for LibXR::CH32GPIO:

Public Member Functions
	CH32GPIO (GPIO_TypeDef *port, uint16_t pin, GPIO::Direction direction=GPIO::Direction::OUTPUT_PUSH_PULL, GPIO::Pull pull=GPIO::Pull::NONE, IRQn_Type irq=NonMaskableInt_IRQn)
	构造 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.
void	OnInterrupt ()
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	CheckInterrupt (uint32_t line)

Static Public Attributes
static CH32GPIO *	map_ [16] = {nullptr}
	EXTI 线路映射表 / EXTI line map.

Private Member Functions
void	ConfigureEXTI (EXTITrigger_TypeDef trigger)

Static Private Member Functions
static uint8_t	GetEXTIID (uint16_t pin)

Private Attributes
GPIO_TypeDef *	port_
uint16_t	pin_
IRQn_Type	irq_

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<>
Data Fields inherited from LibXR::GPIO
Callback	callback_
	GPIO 事件的回调函数。Callback function for GPIO events.

Detailed Description

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

Definition at line 48 of file ch32_gpio.hpp.

Constructor & Destructor Documentation

CH32GPIO()

CH32GPIO::CH32GPIO	(	GPIO_TypeDef *	port,
		uint16_t	pin,
		GPIO::Direction	direction = GPIO::Direction::OUTPUT_PUSH_PULL,
		GPIO::Pull	pull = GPIO::Pull::NONE,
		IRQn_Type	irq = NonMaskableInt_IRQn )

构造 GPIO 对象 / Construct GPIO object

Definition at line 95 of file ch32_gpio.cpp.

    : port_(port), pin_(pin), irq_(irq)
{
  if (irq_ != NonMaskableInt_IRQn)
  {
    map_[GetEXTIID(pin)] = this;
  }
 
  RCC_APB2PeriphClockCmd(ch32_get_gpio_periph(port_), ENABLE);
 
  GPIO_InitTypeDef gpio_init = {};
  gpio_init.GPIO_Pin = pin_;
  gpio_init.GPIO_Speed = GPIO_Speed_50MHz;
 
  switch (direction)
  {
    case Direction::RISING_INTERRUPT:
    case Direction::FALL_INTERRUPT:
    case Direction::FALL_RISING_INTERRUPT:
    case Direction::INPUT:
      gpio_init.GPIO_Mode = (pull == Pull::UP)     ? GPIO_Mode_IPU
                            : (pull == Pull::DOWN) ? GPIO_Mode_IPD
                                                   : GPIO_Mode_IN_FLOATING;
      break;
    case Direction::OUTPUT_PUSH_PULL:
      gpio_init.GPIO_Mode = GPIO_Mode_Out_PP;
      break;
    case Direction::OUTPUT_OPEN_DRAIN:
      gpio_init.GPIO_Mode = GPIO_Mode_Out_OD;
      break;
  }
 
  GPIO_Init(port_, &gpio_init);
 
  switch (direction)
  {
    case Direction::RISING_INTERRUPT:
      ConfigureEXTI(EXTI_Trigger_Rising);
      break;
    case Direction::FALL_INTERRUPT:
      ConfigureEXTI(EXTI_Trigger_Falling);
      break;
    case Direction::FALL_RISING_INTERRUPT:
      ConfigureEXTI(EXTI_Trigger_Rising_Falling);
      break;
    default:
      break;
  }
}

Member Function Documentation

CheckInterrupt()

void CH32GPIO::CheckInterrupt ( uint32_t line )

static

Definition at line 166 of file ch32_gpio.cpp.

{
  if (EXTI_GetITStatus(line) != RESET)
  {
    EXTI_ClearITPendingBit(line);
 
    const uint8_t ID = GetEXTIID(static_cast<uint16_t>(line));
    if (auto* gpio = map_[ID])
    {
      gpio->OnInterrupt();
    }
  }
}

ConfigureEXTI()

void CH32GPIO::ConfigureEXTI ( EXTITrigger_TypeDef trigger )

private

Definition at line 180 of file ch32_gpio.cpp.

{
  EXTI_InitTypeDef exti = {};
  uint8_t pin_source = GetEXTIID(pin_);
  uint8_t port_source = 0xFF;
 
#if defined(GPIOA)
  if (port_ == GPIOA)
  {
    port_source = GPIO_PortSourceGPIOA;
#endif
#if defined(GPIOB)
  }
  else if (port_ == GPIOB)
  {
    port_source = GPIO_PortSourceGPIOB;
  }
#endif
#if defined(GPIOC)
  else if (port_ == GPIOC)
  {
    port_source = GPIO_PortSourceGPIOC;
  }
#endif
#if defined(GPIOD)
  else if (port_ == GPIOD)
  {
    port_source = GPIO_PortSourceGPIOD;
  }
#endif
#if defined(GPIOE)
  else if (port_ == GPIOE)
  {
    port_source = GPIO_PortSourceGPIOE;
  }
#endif
#if defined(GPIOF)
  else if (port_ == GPIOF)
  {
    port_source = GPIO_PortSourceGPIOF;
  }
#endif
#if defined(GPIOG)
  else if (port_ == GPIOG)
  {
    port_source = GPIO_PortSourceGPIOG;
  }
#endif
#if defined(GPIOH)
  else if (port_ == GPIOH)
  {
    port_source = GPIO_PortSourceGPIOH;
  }
#endif
#if defined(GPIOI)
  else if (port_ == GPIOI)
  {
    port_source = GPIO_PortSourceGPIOI;
  }
#endif
 
  ASSERT(port_source != 0xFF);
 
  RCC_APB2PeriphClockCmd(RCC_APB2Periph_AFIO, ENABLE);
  GPIO_EXTILineConfig(port_source, pin_source);
 
  exti.EXTI_Line = 1 << pin_source;
  exti.EXTI_Mode = EXTI_Mode_Interrupt;
  exti.EXTI_Trigger = trigger;
  exti.EXTI_LineCmd = ENABLE;
  EXTI_Init(&exti);
 
  NVIC_EnableIRQ(irq_);
}

DisableInterrupt()

ErrorCode CH32GPIO::DisableInterrupt ( )

overridevirtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 152 of file ch32_gpio.cpp.

{
  EXTI->INTENR &= ~static_cast<uint32_t>(pin_);
  return ErrorCode::OK;
}

EnableInterrupt()

ErrorCode CH32GPIO::EnableInterrupt ( )

overridevirtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 146 of file ch32_gpio.cpp.

{
  EXTI->INTENR |= static_cast<uint32_t>(pin_);
  return ErrorCode::OK;
}

GetEXTIID()

uint8_t CH32GPIO::GetEXTIID ( uint16_t pin )

staticprivate

Definition at line 255 of file ch32_gpio.cpp.

{
  ASSERT(pin != 0 && (pin & static_cast<uint16_t>(pin - 1)) == 0);
  return __builtin_ctz(pin);
}

OnInterrupt()

void CH32GPIO::OnInterrupt

(

)

Definition at line 158 of file ch32_gpio.cpp.

{
  if (!callback_.Empty())
  {
    callback_.Run(true);
  }
}

Read()

bool LibXR::CH32GPIO::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 58 of file ch32_gpio.hpp.

{ return (port_->INDR & pin_) != (uint32_t)Bit_RESET; }

SetConfig()

ErrorCode LibXR::CH32GPIO::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 76 of file ch32_gpio.hpp.

  {
    GPIO_InitTypeDef gpio_init = {};
    gpio_init.GPIO_Pin = pin_;
    gpio_init.GPIO_Speed = GPIO_Speed_50MHz;
 
    switch (config.direction)
    {
      case Direction::INPUT:
      case Direction::RISING_INTERRUPT:
      case Direction::FALL_INTERRUPT:
      case Direction::FALL_RISING_INTERRUPT:
        gpio_init.GPIO_Mode = (config.pull == Pull::UP)     ? GPIO_Mode_IPU
                              : (config.pull == Pull::DOWN) ? GPIO_Mode_IPD
                                                            : GPIO_Mode_IN_FLOATING;
        break;
 
      case Direction::OUTPUT_PUSH_PULL:
        gpio_init.GPIO_Mode = GPIO_Mode_Out_PP;
        break;
 
      case Direction::OUTPUT_OPEN_DRAIN:
        gpio_init.GPIO_Mode = GPIO_Mode_Out_OD;
        break;
    }
 
    GPIO_Init(port_, &gpio_init);
 
    switch (config.direction)
    {
      case Direction::RISING_INTERRUPT:
        ConfigureEXTI(EXTI_Trigger_Rising);
        break;
      case Direction::FALL_INTERRUPT:
        ConfigureEXTI(EXTI_Trigger_Falling);
        break;
      case Direction::FALL_RISING_INTERRUPT:
        ConfigureEXTI(EXTI_Trigger_Rising_Falling);
        break;
      default:
        break;
    }
 
    return ErrorCode::OK;
  }

Write()

void LibXR::CH32GPIO::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 60 of file ch32_gpio.hpp.

  {
    if (value)
    {
      port_->BSHR = pin_;
    }
    else
    {
      port_->BCR = pin_;
    }
  }

Field Documentation

irq_

IRQn_Type LibXR::CH32GPIO::irq_

private

Definition at line 132 of file ch32_gpio.hpp.

map_

CH32GPIO* LibXR::CH32GPIO::map_[16] = {nullptr}

inlinestatic

EXTI 线路映射表 / EXTI line map.

Definition at line 127 of file ch32_gpio.hpp.

{nullptr};

pin_

uint16_t LibXR::CH32GPIO::pin_

private

Definition at line 131 of file ch32_gpio.hpp.

port_

GPIO_TypeDef* LibXR::CH32GPIO::port_

private

Definition at line 130 of file ch32_gpio.hpp.

---

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

• driver/ch/ch32_gpio.hpp
• driver/ch/ch32_gpio.cpp