RegisteredOutputPin Class Reference

#include <efi_gpio.h>

Inheritance diagram for RegisteredOutputPin:

Collaboration diagram for RegisteredOutputPin:

Public Member Functions
	RegisteredOutputPin (const char *registrationName, size_t pinOffset, size_t pinModeOffset)
	RegisteredOutputPin (const char *registrationName, size_t pinOffset)
void	init ()
void	unregister ()
const char *	getRegistrationName () const
Public Member Functions inherited from OutputPin
void	initPin (const char *msg, brain_pin_e brainPin, pin_output_mode_e outputMode, bool forceInitWithFatalError=false)
void	initPin (const char *msg, brain_pin_e brainPin)
void	deInit ()
bool	isInitialized () const
bool	getAndSet (int logicValue)
void	setValue (const char *msg, int logicValue, bool isForce=false)
TEST_VIRTUAL void	setValue (int logicValue, bool isForce=false)
void	toggle ()
bool	getLogicValue () const
brain_pin_diag_e	getDiag () const
void	resetToggleStats ()

Data Fields
RegisteredOutputPin *const	next
Data Fields inherited from OutputPin
ioportid_t	m_port = 0
uint8_t	m_pin = 0
int	pinToggleCounter = 0
Timer	pinToggleTimer
uint32_t	durationsInStateMs [2]
brain_pin_e	brainPin = Gpio::Unassigned
bool	ext = false
int8_t	currentLogicValue = INITIAL_PIN_STATE

Private Member Functions
bool	isPinConfigurationChanged ()

Private Attributes
const char *const	registrationName
const uint16_t	m_pinOffset
const bool	m_hasPinMode
const uint16_t	m_pinModeOffset

Detailed Description

OutputPin with semi-automated init/deinit on configuration change

Definition at line 42 of file efi_gpio.h.

Constructor & Destructor Documentation

RegisteredOutputPin() [1/2]

RegisteredOutputPin::RegisteredOutputPin	(	const char *	registrationName,
		size_t	pinOffset,
		size_t	pinModeOffset
	)

Definition at line 74 of file efi_gpio.cpp.

    : next(registeredOutputHead)
    , registrationName(p_registrationName)
    , m_pinOffset(static_cast<uint16_t>(pinOffset))
    , m_hasPinMode(true)
    , m_pinModeOffset(static_cast<uint16_t>(pinModeOffset))
{
    // adding into head of the list is so easy and since we do not care about order that's what we shall do
    registeredOutputHead = this;
}

RegisteredOutputPin() [2/2]

RegisteredOutputPin::RegisteredOutputPin	(	const char *	registrationName,
		size_t	pinOffset
	)

Definition at line 86 of file efi_gpio.cpp.

    : next(registeredOutputHead)
    , registrationName(p_registrationName)
    , m_pinOffset(static_cast<uint16_t>(pinOffset))
    , m_hasPinMode(false)
    , m_pinModeOffset(-1)
{
    // adding into head of the list is so easy and since we do not care about order that's what we shall do
    registeredOutputHead = this;
}

Member Function Documentation

getRegistrationName()

const char * RegisteredOutputPin::getRegistrationName ( ) const

inline

Definition at line 49 of file efi_gpio.h.

                                            {
        return registrationName;
    }

init()

void RegisteredOutputPin::init

(

)

Definition at line 111 of file efi_gpio.cpp.

                               {
    brain_pin_e        newPin = *(brain_pin_e       *) ((void *) (&((char*) engineConfiguration)[m_pinOffset]));
 
    pin_output_mode_e newMode;
    if (m_hasPinMode) {
        newMode = *(pin_output_mode_e *) ((void *) (&((char*) engineConfiguration)[m_pinModeOffset]));
    } else {
        newMode = OM_DEFAULT;
    }
 
    if (isPinConfigurationChanged()) {
        this->initPin(registrationName, newPin, newMode);
    }
}

Referenced by EnginePins::startPins().

Here is the call graph for this function:

Here is the caller graph for this function:

isPinConfigurationChanged()

bool RegisteredOutputPin::isPinConfigurationChanged ( )

private

Definition at line 97 of file efi_gpio.cpp.

                                                    {
    brain_pin_e        curPin = *(brain_pin_e       *) ((void *) (&((char*)&activeConfiguration)[m_pinOffset]));
    brain_pin_e        newPin = *(brain_pin_e       *) ((void *) (&((char*) engineConfiguration)[m_pinOffset]));
    bool pinChanged = curPin != newPin;
 
    if (!m_hasPinMode) {
        return pinChanged;
    }
 
    pin_output_mode_e curMode = *(pin_output_mode_e *) ((void *) (&((char*)&activeConfiguration)[m_pinModeOffset]));
    pin_output_mode_e newMode = *(pin_output_mode_e *) ((void *) (&((char*) engineConfiguration)[m_pinModeOffset]));
    return pinChanged || curMode != newMode;
}

Referenced by init(), and unregister().

Here is the caller graph for this function:

unregister()

void RegisteredOutputPin::unregister

(

)

Definition at line 126 of file efi_gpio.cpp.

                                     {
    if (isPinConfigurationChanged()) {
        OutputPin::deInit();
    }
}

Referenced by EnginePins::unregisterPins().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

m_hasPinMode

const bool RegisteredOutputPin::m_hasPinMode

private

Definition at line 55 of file efi_gpio.h.

Referenced by init(), and isPinConfigurationChanged().

m_pinModeOffset

const uint16_t RegisteredOutputPin::m_pinModeOffset

private

Definition at line 56 of file efi_gpio.h.

Referenced by init(), and isPinConfigurationChanged().

m_pinOffset

const uint16_t RegisteredOutputPin::m_pinOffset

private

Definition at line 54 of file efi_gpio.h.

Referenced by init(), and isPinConfigurationChanged().

next

RegisteredOutputPin* const RegisteredOutputPin::next

Definition at line 48 of file efi_gpio.h.

registrationName

const char* const RegisteredOutputPin::registrationName

private

Definition at line 53 of file efi_gpio.h.

Referenced by getRegistrationName(), and init().

---

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

• controllers/system/efi_gpio.h
• controllers/system/efi_gpio.cpp