Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
GpioShared< Defs > Struct Template Reference

Shared class that defines static functions used by both GpioInputPin, GpioOutputPin and GpioHwPin. More...

#include <TivaGPIO.hxx>

Inheritance diagram for GpioShared< Defs >:
GpioInputPin< Defs, true > GpioInputPin< Defs, false > GpioInputPin< Defs, false, false > GpioInputPin< Defs, IOCON_MODE_INACT > GpioInputPin< Defs, GPIO_NOPULL > GpioInputPin< Defs, GPIO_PIN_TYPE_STD > GpioInputPin< Defs, false, true > GpioInputPin< Defs, IOCON_MODE_PULLDOWN > GpioInputPin< Defs, GPIO_PULLDOWN > GpioInputPin< Defs, GPIO_PIN_TYPE_STD_WPD > GpioInputPin< Defs, true, false > GpioInputPin< Defs, IOCON_MODE_PULLUP > GpioInputPin< Defs, GPIO_PULLUP > GpioInputPin< Defs, GPIO_PIN_TYPE_STD_WPU > GpioInputPin< Defs, true, true > GpioInputPin< Defs, IOCON_MODE_REPEATER > GpioOutputPin< Defs, SAFE_VALUE > GpioOutputPin< Defs, true > GpioOutputPin< Defs, true, true > GpioOutputPin< Defs, false > GpioOutputPin< Defs, false, true > GpioHwPin< Defs > GpioInputOutputPin< Defs > GpioInputPin< Base, ACTIVE_HIGH > GpioOutputPin< Base, SAFE_VALUE, INVERT >

Static Public Member Functions

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 Defs>
struct GpioShared< Defs >

Shared class that defines static functions used by both GpioInputPin, GpioOutputPin and GpioHwPin.

Definition at line 155 of file TivaGPIO.hxx.

Member Function Documentation

◆ get()

template<class Defs >
static bool GpioShared< Defs >::get ( )
inlinestatic
Returns
current value of an input pin, if true HIGH, of false LOW.

Definition at line 186 of file TivaGPIO.hxx.

◆ instance()

template<class Defs >
static constexpr const Gpio * GpioShared< Defs >::instance ( )
inlinestaticconstexpr
Returns
static Gpio ovject instance that controls this output pin.

Definition at line 203 of file TivaGPIO.hxx.

◆ lock()

template<class Defs >
static void GpioShared< Defs >::lock ( )
inlinestatic

Used to lock special consideration pins such as JTAG or NMI pins.

Definition at line 171 of file TivaGPIO.hxx.

◆ ptr_address()

template<class Defs >
static constexpr uint32_t GpioShared< Defs >::ptr_address ( )
inlinestaticconstexpr
Returns
the IO address of the port that controls the specific pin.

Definition at line 197 of file TivaGPIO.hxx.

◆ set()

template<class Defs >
static void GpioShared< Defs >::set ( bool  value)
inlinestatic

Sets the output pin to a specified value;.

Parameters
valueif true, output is set to HIGH otherwise LOW.

Definition at line 181 of file TivaGPIO.hxx.

◆ toggle()

template<class Defs >
static void GpioShared< Defs >::toggle ( )
inlinestatic

Changes the value of an output pin.

Definition at line 191 of file TivaGPIO.hxx.

◆ unlock()

template<class Defs >
static void GpioShared< Defs >::unlock ( )
inlinestatic

Used to unlock special consideration pins such as JTAG or NMI pins.

Definition at line 162 of file TivaGPIO.hxx.

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