ELEC-C7222
Libraries for ELEC C7222 Course Work
Loading...
Searching...
No Matches
c7222::GpioIn::Config Struct Reference

Configuration structure for input GPIO setup. More...

#include <gpio.hpp>

Collaboration diagram for c7222::GpioIn::Config:
Collaboration graph

Public Member Functions

 Config (uint32_t pin)
 Create config with a pin number.
 
bool Validate () const
 Validate configuration for basic constraints.
 
bool operator== (const Config &other) const
 

Public Attributes

uint32_t pin_
 GPIO pin number (non-negative integer).
 
GpioPullMode pull {GpioPullMode::None}
 Pull mode (default: None).
 
GpioInputEvent input_events {GpioInputEvent::None}
 Input events to trigger IRQ (default: None).
 
std::function< void(uint32_t)> irq_handler {}
 Optional IRQ handler callback. The function argument is bit field of events that triggered the IRQ.
 

Detailed Description

Configuration structure for input GPIO setup.

Constructor & Destructor Documentation

◆ Config()

c7222::GpioIn::Config::Config ( uint32_t  pin)
explicit

Create config with a pin number.

Parameters
pinGPIO number (non-negative).

Member Function Documentation

◆ operator==()

bool c7222::GpioIn::Config::operator== ( const Config other) const

◆ Validate()

bool c7222::GpioIn::Config::Validate ( ) const

Validate configuration for basic constraints.

Returns
true if configuration is valid.

Member Data Documentation

◆ input_events

GpioInputEvent c7222::GpioIn::Config::input_events {GpioInputEvent::None}

Input events to trigger IRQ (default: None).

◆ irq_handler

std::function<void(uint32_t)> c7222::GpioIn::Config::irq_handler {}

Optional IRQ handler callback. The function argument is bit field of events that triggered the IRQ.

◆ pin_

uint32_t c7222::GpioIn::Config::pin_

GPIO pin number (non-negative integer).

◆ pull

GpioPullMode c7222::GpioIn::Config::pull {GpioPullMode::None}

Pull mode (default: None).


The documentation for this struct was generated from the following file: