LibXR::STM32GPIO Class Reference

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

#include <stm32_gpio.hpp>

Inheritance diagram for LibXR::STM32GPIO:

Collaboration diagram for LibXR::STM32GPIO:

Public Member Functions
	STM32GPIO (GPIO_TypeDef *port, uint16_t pin, IRQn_Type irq=NonMaskableInt_IRQn)
	构造 GPIO 对象 / Construct GPIO object
bool	Read ()
	读取 GPIO 引脚状态 / Reads the GPIO pin state.
void	Write (bool value)
	写入 GPIO 引脚状态 / Writes the GPIO pin state.
ErrorCode	EnableInterrupt ()
	使能 GPIO 引脚中断 / Enables the GPIO pin interrupt.
ErrorCode	DisableInterrupt ()
	禁用 GPIO 引脚中断 / Disables the GPIO pin interrupt.
ErrorCode	SetConfig (Configuration config)
	配置 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 Attributes
static STM32GPIO *	map [16] = {nullptr}

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

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

Definition at line 61 of file stm32_gpio.hpp.

Constructor & Destructor Documentation

STM32GPIO()

STM32GPIO::STM32GPIO	(	GPIO_TypeDef *	port,
		uint16_t	pin,
		IRQn_Type	irq = NonMaskableInt_IRQn )

构造 GPIO 对象 / Construct GPIO object

Definition at line 17 of file stm32_gpio.cpp.

    : port_(port), pin_(pin), irq_(irq)
{
  if (irq_ != NonMaskableInt_IRQn)
  {
    map[STM32_GPIO_PinToLine(pin)] = this;
  }
}

Member Function Documentation

DisableInterrupt()

ErrorCode STM32GPIO::DisableInterrupt ( )

virtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 33 of file stm32_gpio.cpp.

{
  ASSERT(irq_ != NonMaskableInt_IRQn);
  HAL_NVIC_DisableIRQ(irq_);
  return ErrorCode::OK;
}

EnableInterrupt()

ErrorCode STM32GPIO::EnableInterrupt ( )

virtual

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

Returns

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

Implements LibXR::GPIO.

Definition at line 26 of file stm32_gpio.cpp.

{
  ASSERT(irq_ != NonMaskableInt_IRQn);
  HAL_NVIC_EnableIRQ(irq_);
  return ErrorCode::OK;
}

Read()

bool LibXR::STM32GPIO::Read ( )

inlinevirtual

读取 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 69 of file stm32_gpio.hpp.

{ return (port_->IDR & pin_) != 0u; }

SetConfig()

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

inlinevirtual

配置 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 87 of file stm32_gpio.hpp.

  {
    const bool IS_NON_IRQ_DIRECTION =
        static_cast<uint8_t>(config.direction) <=
        static_cast<uint8_t>(LibXR::GPIO::Direction::OUTPUT_OPEN_DRAIN);
 
    if (IS_NON_IRQ_DIRECTION)
    {
      const uint32_t PIN_POS = static_cast<uint32_t>(__builtin_ctz(pin_));
 
#if XR_STM32_GPIO_HAS_F1_LAYOUT
      // 寄存器快路径（F1 类）：CRL/CRH 格式 / Register fast path (F1 class): CRL/CRH.
      volatile uint32_t* cr = (PIN_POS < 8u) ? &port_->CRL : &port_->CRH;
      const uint32_t SHIFT = (PIN_POS & 0x7u) * 4u;
      uint32_t mode_cnf = 0u;
 
      if (config.direction == Direction::INPUT)
      {
        if (config.pull == Pull::UP || config.pull == Pull::DOWN)
        {
          // MODE=00, CNF=10（上拉/下拉输入）/ Input with pull-up/pull-down.
          mode_cnf = 0x8u;
          if (config.pull == Pull::UP)
          {
            port_->BSRR = static_cast<uint32_t>(pin_);
          }
          else
          {
            port_->BSRR = static_cast<uint32_t>(pin_) << 16u;
          }
        }
        else
        {
          // MODE=00, CNF=01（浮空输入）/ Floating input.
          mode_cnf = 0x4u;
        }
      }
      else if (config.direction == Direction::OUTPUT_PUSH_PULL)
      {
        // MODE=11(50MHz), CNF=00（推挽输出）/ General purpose output push-pull.
        mode_cnf = 0x3u;
      }
      else
      {
        // MODE=11(50MHz), CNF=01（开漏输出）/ General purpose output open-drain.
        mode_cnf = 0x7u;
      }
 
      uint32_t reg = *cr;
      reg &= ~(0xFu << SHIFT);
      reg |= (mode_cnf << SHIFT);
      *cr = reg;
      return ErrorCode::OK;
 
#elif XR_STM32_GPIO_HAS_MODER_LAYOUT
      // 寄存器快路径（MODER 类）：MODER/OTYPER/PUPDR/OSPEEDR / Register fast path (MODER
      // class).
      const uint32_t SHIFT = PIN_POS * 2u;
      const uint32_t MASK2 = 0x3u << SHIFT;
 
      uint32_t moder = port_->MODER;
      moder &= ~MASK2;
      if (config.direction != Direction::INPUT)
      {
        moder |= (0x1u << SHIFT);  // MODER=01：通用输出 / General purpose output.
      }
      port_->MODER = moder;
 
      if (config.direction != Direction::INPUT)
      {
        const uint32_t PIN_MASK = 0x1u << PIN_POS;
        if (config.direction == Direction::OUTPUT_OPEN_DRAIN)
        {
          port_->OTYPER |= PIN_MASK;
        }
        else
        {
          port_->OTYPER &= ~PIN_MASK;
        }
 
#if XR_STM32_GPIO_HAS_OSPEEDR
        uint32_t ospeedr = port_->OSPEEDR;
        ospeedr &= ~MASK2;
        ospeedr |= (0x3u << SHIFT);  // SWD 方向切换用最高速率 / Fastest slew for SWD.
        port_->OSPEEDR = ospeedr;
#endif
      }
 
      uint32_t pupdr = port_->PUPDR;
      pupdr &= ~MASK2;
      if (config.pull == Pull::UP)
      {
        pupdr |= (0x1u << SHIFT);
      }
      else if (config.pull == Pull::DOWN)
      {
        pupdr |= (0x2u << SHIFT);
      }
      port_->PUPDR = pupdr;
      return ErrorCode::OK;
#endif
    }
 
    GPIO_InitTypeDef gpio_init = {};
 
    gpio_init.Pin = pin_;
 
    switch (config.direction)
    {
      case Direction::INPUT:
        gpio_init.Mode = GPIO_MODE_INPUT;
        break;
      case Direction::OUTPUT_PUSH_PULL:
        gpio_init.Mode = GPIO_MODE_OUTPUT_PP;
        break;
      case Direction::OUTPUT_OPEN_DRAIN:
        gpio_init.Mode = GPIO_MODE_OUTPUT_OD;
        break;
      case Direction::FALL_INTERRUPT:
        gpio_init.Mode = GPIO_MODE_IT_FALLING;
        break;
      case Direction::RISING_INTERRUPT:
        gpio_init.Mode = GPIO_MODE_IT_RISING;
        break;
      case Direction::FALL_RISING_INTERRUPT:
        gpio_init.Mode = GPIO_MODE_IT_RISING_FALLING;
        break;
    }
 
    switch (config.pull)
    {
      case Pull::NONE:
        gpio_init.Pull = GPIO_NOPULL;
        break;
      case Pull::UP:
        gpio_init.Pull = GPIO_PULLUP;
        break;
      case Pull::DOWN:
        gpio_init.Pull = GPIO_PULLDOWN;
        break;
    }
 
    gpio_init.Speed = GPIO_SPEED_FREQ_HIGH;
 
    HAL_GPIO_Init(port_, &gpio_init);
 
    return ErrorCode::OK;
  }

Write()

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

inlinevirtual

写入 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 71 of file stm32_gpio.hpp.

  {
    if (value)
    {
      port_->BSRR = static_cast<uint32_t>(pin_);
    }
    else
    {
      port_->BSRR = static_cast<uint32_t>(pin_) << 16;
    }
  }

Member Data Documentation

map

STM32GPIO * STM32GPIO::map = {nullptr}

static

Definition at line 236 of file stm32_gpio.hpp.

---

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

• driver/st/stm32_gpio.hpp
• driver/st/stm32_gpio.cpp