Parametric GPIO input class. More...

#include <Esp32Gpio.hxx>

Inheritance diagram for GpioInputPin< Base, ACTIVE_HIGH >:

Static Public Member Functions
static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static bool	get ()
	Get the current pin state.

static constexpr const Gpio *	instance ()

static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static bool	is_output ()

static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static bool	get ()

static bool	is_output ()

static constexpr const Gpio *	instance ()

static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static bool	is_output ()

static void	hw_init ()
	Initializes the hardware pin.

static void	hw_set_to_safe ()
	Sets the hardware pin to a safe state.

static const Gpio *	instance ()

static bool	get ()

Static Public Member Functions inherited from GpioShared< Defs >
static void	unlock ()
	Used to unlock special consideration pins such as JTAG or NMI pins.

static void	lock ()
	Used to lock special consideration pins such as JTAG or NMI pins.

static void	set (bool value)
	Sets the output pin to a specified value;.

static bool	get ()

static void	toggle ()
	Changes the value of an output pin.

static constexpr uint32_t	ptr_address ()

static constexpr const Gpio *	instance ()

Detailed Description

template<class Base, bool ACTIVE_HIGH = true>
struct GpioInputPin< Base, ACTIVE_HIGH >

Parametric GPIO input class.

Generic input pin.

Common class for GPIO input pins.

Parameters

Defs	is the GPIO pin's definition base class, supplied by the GPIO_PIN macro.
PUEN	is true if the pull-up should be enabled.
PDEN	is true if the pull-down should be enabled.

Definition at line 259 of file LinuxGpio.hxx.

Member Function Documentation

◆ get() [1/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::get ( )

inlinestatic

Get the current pin state.

Returns: true if the pin input is seeing HIGH.

Definition at line 370 of file Esp32Gpio.hxx.

◆ get() [2/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::get ( )

inlinestatic

Returns: true if the pin input is seeing HIGH.

Definition at line 281 of file CC3200GPIO.hxx.

◆ get() [3/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::get ( )

inlinestatic

Definition at line 278 of file LinuxGpio.hxx.

◆ hw_init() [1/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 341 of file Esp32Gpio.hxx.

◆ hw_init() [2/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 159 of file Lpc17xx40xxGPIO.hxx.

◆ hw_init() [3/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 169 of file Stm32Gpio.hxx.

◆ hw_init() [4/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 270 of file CC3200GPIO.hxx.

◆ hw_init() [5/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 345 of file TivaGPIO.hxx.

◆ hw_init() [6/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_init ( )

inlinestatic

Initializes the hardware pin.

Definition at line 263 of file LinuxGpio.hxx.

◆ hw_set_to_safe() [1/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 363 of file Esp32Gpio.hxx.

◆ hw_set_to_safe() [2/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 166 of file Lpc17xx40xxGPIO.hxx.

◆ hw_set_to_safe() [3/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 179 of file Stm32Gpio.hxx.

◆ hw_set_to_safe() [4/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 276 of file CC3200GPIO.hxx.

◆ hw_set_to_safe() [5/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 352 of file TivaGPIO.hxx.

◆ hw_set_to_safe() [6/6]

template<class Base , bool ACTIVE_HIGH = true>

static void GpioInputPin< Base, ACTIVE_HIGH >::hw_set_to_safe ( )

inlinestatic

Sets the hardware pin to a safe state.

Definition at line 269 of file LinuxGpio.hxx.

◆ instance() [1/3]

template<class Base , bool ACTIVE_HIGH = true>

static constexpr const Gpio * GpioInputPin< Base, ACTIVE_HIGH >::instance ( )

inlinestaticconstexpr

Returns: static Gpio object instance that controls this output pin.

Definition at line 376 of file Esp32Gpio.hxx.

◆ instance() [2/3]

template<class Base , bool ACTIVE_HIGH = true>

static constexpr const Gpio * GpioInputPin< Base, ACTIVE_HIGH >::instance ( )

inlinestaticconstexpr

Returns: the static Gpio instance controlling this pin.

Definition at line 293 of file CC3200GPIO.hxx.

◆ instance() [3/3]

template<class Base , bool ACTIVE_HIGH = true>

static const Gpio * GpioInputPin< Base, ACTIVE_HIGH >::instance ( )

inlinestatic

Returns: the static Gpio instance.

Definition at line 274 of file LinuxGpio.hxx.

◆ is_output() [1/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::is_output ( )

inlinestatic

Returns: true if the pin is set to drive an output.

Definition at line 184 of file Stm32Gpio.hxx.

◆ is_output() [2/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::is_output ( )

inlinestatic

Returns: true if the pin is set to an output.

Definition at line 288 of file CC3200GPIO.hxx.

◆ is_output() [3/3]

template<class Base , bool ACTIVE_HIGH = true>

static bool GpioInputPin< Base, ACTIVE_HIGH >::is_output ( )

inlinestatic

Returns: true if the pin is set to an output.

Definition at line 357 of file TivaGPIO.hxx.

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ hw_init() [1/6]

◆ hw_init() [2/6]

◆ hw_init() [3/6]

◆ hw_init() [4/6]

◆ hw_init() [5/6]

◆ hw_init() [6/6]

◆ hw_set_to_safe() [1/6]

◆ hw_set_to_safe() [2/6]

◆ hw_set_to_safe() [3/6]

◆ hw_set_to_safe() [4/6]

◆ hw_set_to_safe() [5/6]

◆ hw_set_to_safe() [6/6]

◆ instance() [1/3]

◆ instance() [2/3]

◆ instance() [3/3]

◆ is_output() [1/3]

◆ is_output() [2/3]

◆ is_output() [3/3]