Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
GpioInputOutputPin< Defs > Struct Template Reference

Common class for GPIO input pins. More...

#include <CC3200GPIO.hxx>

Inheritance diagram for GpioInputOutputPin< Defs >:
GpioShared< Defs >

Static Public Member Functions

static void hw_init ()
 Initializes the hardware pin.
 
static void hw_set_to_safe ()
 Sets the output pin to a safe value.
 
static void set (bool value)
 Sets the output pin to a defined value.
 
static bool get ()
 
static void toggle ()
 Changes the value of an output pin.
 
static constexpr const Gpioinstance ()
 
static void set_direction (Gpio::Direction direction)
 Sets the direction of the I/O pin.
 
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 void set_direction (Gpio::Direction direction)
 Sets the direction of the I/O pin.
 
static bool is_output ()
 
- 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 Gpioinstance ()
 

Detailed Description

template<class Defs>
struct GpioInputOutputPin< Defs >

Common class for GPIO input pins.

Common class for GPIO input/output pins.

Definition at line 300 of file CC3200GPIO.hxx.

Member Function Documentation

◆ get()

template<class Defs >
static bool GpioInputOutputPin< Defs >::get ( )
inlinestatic
Returns
current value of the input pin: if true HIGH.

Definition at line 328 of file CC3200GPIO.hxx.

◆ hw_init() [1/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::hw_init ( )
inlinestatic

Initializes the hardware pin.

Definition at line 307 of file CC3200GPIO.hxx.

◆ hw_init() [2/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::hw_init ( )
inlinestatic

Initializes the hardware pin.

Definition at line 395 of file TivaGPIO.hxx.

◆ hw_set_to_safe() [1/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::hw_set_to_safe ( )
inlinestatic

Sets the output pin to a safe value.

Definition at line 313 of file CC3200GPIO.hxx.

◆ hw_set_to_safe() [2/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::hw_set_to_safe ( )
inlinestatic

Sets the hardware pin to a safe state.

Definition at line 403 of file TivaGPIO.hxx.

◆ instance()

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

Definition at line 341 of file CC3200GPIO.hxx.

◆ is_output() [1/2]

template<class Defs >
static bool GpioInputOutputPin< Defs >::is_output ( )
inlinestatic
Returns
true if this pin is an output pin.

Definition at line 356 of file CC3200GPIO.hxx.

◆ is_output() [2/2]

template<class Defs >
static bool GpioInputOutputPin< Defs >::is_output ( )
inlinestatic
Returns
true if the pin is set to an output.

Definition at line 416 of file TivaGPIO.hxx.

◆ set()

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

Sets the output pin to a defined value.

Parameters
valueif true, output will be set to HIGH, otherwise to LOW.

See note at the top of the file about barriers.

Definition at line 319 of file CC3200GPIO.hxx.

◆ set_direction() [1/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::set_direction ( Gpio::Direction  direction)
inlinestatic

Sets the direction of the I/O pin.

Parameters
directiondirection to set pin to

Definition at line 348 of file CC3200GPIO.hxx.

◆ set_direction() [2/2]

template<class Defs >
static void GpioInputOutputPin< Defs >::set_direction ( Gpio::Direction  direction)
inlinestatic

Sets the direction of the I/O pin.

Parameters
directiondirection to set pin to

Definition at line 409 of file TivaGPIO.hxx.

◆ toggle()

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

Changes the value of an output pin.

Definition at line 335 of file CC3200GPIO.hxx.


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