LibXR::STM32GPIO Class Reference

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)
bool	Read ()
	读取 GPIO 引脚状态。Reads the GPIO pin state.
ErrorCode	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.
ErrorCode	RegisterCallback (Callback callback)
	注册 GPIO 事件回调函数。Registers a callback function for GPIO events.

Static Public Attributes
static STM32GPIO *	map [STM32_GPIO_EXTI_NUMBER] = {nullptr}

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

Definition at line 33 of file stm32_gpio.hpp.

Constructor & Destructor Documentation

STM32GPIO()

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

Definition at line 58 of file stm32_gpio.cpp.

    : port_(port), pin_(pin), irq_(irq)
{
  if (irq_ != NonMaskableInt_IRQn)
  {
    map[STM32_GPIO_EXTI_GetID(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 82 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 75 of file stm32_gpio.cpp.

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

Read()

bool STM32GPIO::Read ( )

virtual

读取 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 67 of file stm32_gpio.cpp.

{ return HAL_GPIO_ReadPin(port_, pin_) == GPIO_PIN_SET; }

SetConfig()

ErrorCode STM32GPIO::SetConfig ( Configuration config )

virtual

配置 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 89 of file stm32_gpio.cpp.

{
  GPIO_InitTypeDef gpio_init = {};
 
  HAL_GPIO_DeInit(port_, pin_);
 
  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()

ErrorCode STM32GPIO::Write ( bool value )

virtual

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

Parameters

value

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

Returns

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

Implements LibXR::GPIO.

Definition at line 69 of file stm32_gpio.cpp.

{
  HAL_GPIO_WritePin(port_, pin_, value ? GPIO_PIN_SET : GPIO_PIN_RESET);
  return ErrorCode::OK;
}

Field Documentation

irq_

IRQn_Type LibXR::STM32GPIO::irq_

private

Definition at line 53 of file stm32_gpio.hpp.

map

STM32GPIO * STM32GPIO::map = {nullptr}

static

Definition at line 48 of file stm32_gpio.hpp.

pin_

uint16_t LibXR::STM32GPIO::pin_

private

Definition at line 52 of file stm32_gpio.hpp.

port_

GPIO_TypeDef* LibXR::STM32GPIO::port_

private

Definition at line 51 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