Single output pin reference and state. More...

#include <efi_output.h>

Inheritance diagram for OutputPin:

[legend]

Collaboration diagram for OutputPin:

[legend]

Public Member Functions
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
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
void	setDefaultPinState (pin_output_mode_e mode)

void	setOnchipValue (int electricalValue)

Private Attributes
pin_output_mode_e	mode = OM_DEFAULT

Detailed Description

Single output pin reference and state.

Definition at line 50 of file efi_output.h.

Member Function Documentation

◆ deInit()

void OutputPin::deInit ( )

Definition at line 781 of file efi_gpio.cpp.

                        {
     // Unregister under lock - we don't want other threads mucking with the pin while we're trying to turn it off
     chibios_rt::CriticalSectionLocker csl;
  
     // nothing to do if not registered in the first place
     if (!isBrainPinValid(brainPin)) {
         return;
     }
  
 #if (BOARD_EXT_GPIOCHIPS > 0)
     ext = false;
 #endif // (BOARD_EXT_GPIOCHIPS > 0)
  
     efiPrintf("unregistering %s", hwPortname(brainPin));
  
 #if EFI_GPIO_HARDWARE && EFI_PROD_CODE
     efiSetPadUnused(brainPin);
 #endif /* EFI_GPIO_HARDWARE */
  
     // Clear the pin so that it won't get set any more
     brainPin = Gpio::Unassigned;
 }

Referenced by initPin(), luaDeInitPins(), stopHip9001_pins(), stopTriggerEmulatorPins(), stopVvtControlPins(), and RegisteredOutputPin::unregister().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAndSet()

bool OutputPin::getAndSet ( int logicValue )

Definition at line 552 of file efi_gpio.cpp.

                                         {
     bool oldValue = getLogicValue();
     setValue(logicValue);
     return oldValue;
 }

Referenced by disengageStarterIfNeeded(), and onStartStopButtonToggle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDiag()

brain_pin_diag_e OutputPin::getDiag ( ) const

Definition at line 657 of file efi_gpio.cpp.

                                           {
 #if EFI_PROD_CODE
 #if BOARD_EXT_GPIOCHIPS > 0
     if (!brain_pin_is_onchip(brainPin)) {
         return gpiochips_getDiag(brainPin);
     }
 #endif
 #endif /* EFI_PROD_CODE */
     // TODO: add hook to board code for custom diagnostic, like it is done on S105
     return PIN_UNKNOWN;
 }

Referenced by benchOff(), and SensorChecker::onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogicValue()

bool OutputPin::getLogicValue ( ) const

Definition at line 646 of file efi_gpio.cpp.

                                     {
     // Compare against 1 since it could also be INITIAL_PIN_STATE (which means logical 0, but we haven't initialized the pin yet)
     return currentLogicValue == 1;
 }

Referenced by canDashboardHaltech(), getAndSet(), getHellenBoardEnabled(), IdleController::getRunningOpenLoop(), Engine::isMainRelayEnabled(), lua_fan(), populateFrame(), slowStartStopButtonCallback(), NamedOutputPin::stop(), toggle(), updateFlags(), and updateTunerStudioState().

Here is the caller graph for this function:

◆ initPin() [1/2]

void OutputPin::initPin	(	const char *	msg,
		brain_pin_e	brainPin
	)

Definition at line 686 of file efi_gpio.cpp.

                                                                  {
     initPin(p_msg, p_brainPin, OM_DEFAULT);
 }

Here is the call graph for this function:

◆ initPin() [2/2]

void OutputPin::initPin	(	const char *	msg,
		brain_pin_e	brainPin,
		pin_output_mode_e	outputMode,
		bool	forceInitWithFatalError = `false`
	)

Definition at line 690 of file efi_gpio.cpp.

                                                                                                                            {
 #if EFI_UNIT_TEST
     pinToggleCounter = 0;
 #endif
  
     if (!isBrainPinValid(p_brainPin)) {
         return;
     }
  
     // Enter a critical section so that other threads can't change the pin state out from underneath us
     chibios_rt::CriticalSectionLocker csl;
  
     if (!forceInitWithFatalError && hasFirmwareError()) {
         // Don't allow initializing more pins if we have a fatal error.
         // Pins should have just been reset, so we shouldn't try to init more.
         return;
     }
  
     // Check that this OutputPin isn't already assigned to another pin (reinit is allowed to change mode)
     // To avoid this error, call deInit() first
     if (isBrainPinValid(brainPin) && brainPin != p_brainPin) {
         firmwareError(ObdCode::CUSTOM_OBD_PIN_CONFLICT, "outputPin [%s] already assigned, cannot reassign without unregister first", msg);
         return;
     }
  
     if (outputMode > OM_OPENDRAIN_INVERTED) {
         firmwareError(ObdCode::CUSTOM_INVALID_MODE_SETTING, "%s invalid pin_output_mode_e %d %s",
                 msg,
                 outputMode,
                 hwPortname(p_brainPin)
                 );
         return;
     }
  
 #if EFI_GPIO_HARDWARE && EFI_PROD_CODE
     iomode_t l_mode = (outputMode == OM_DEFAULT || outputMode == OM_INVERTED) ?
         PAL_MODE_OUTPUT_PUSHPULL : PAL_MODE_OUTPUT_OPENDRAIN;
  
     #if (BOARD_EXT_GPIOCHIPS > 0)
         this->ext = false;
     #endif
     if (brain_pin_is_onchip(p_brainPin)) {
         m_port = getHwPort(msg, p_brainPin);
         m_pin = getHwPin(msg, p_brainPin);
  
         // Validate port
         if (m_port == GPIO_NULL) {
             criticalError("OutputPin::initPin got invalid port for pin idx %d", static_cast<int>(p_brainPin));
             return;
         }
     }
     #if (BOARD_EXT_GPIOCHIPS > 0)
         else {
             this->ext = true;
         }
     #endif
 #endif // briefly leave the include guard because we need to set default state in tests
  
     brainPin = p_brainPin;
  
     // The order of the next two calls may look strange, which is a good observation.
     // We call them in this order so that the pin is set to a known state BEFORE
     // it's enabled.  Enabling the pin then setting it could result in a (brief)
     // mystery state being driven on the pin (potentially dangerous).
     setDefaultPinState(outputMode);
  
 #if EFI_GPIO_HARDWARE && EFI_PROD_CODE
     efiSetPadMode(msg, brainPin, l_mode);
     if (brain_pin_is_onchip(brainPin)) {
         // todo: handle OM_OPENDRAIN and OM_OPENDRAIN_INVERTED as well
         if (outputMode == OM_DEFAULT || outputMode == OM_INVERTED) {
 #ifndef DISABLE_PIN_STATE_VALIDATION
             int actualValue = palReadPad(m_port, m_pin);
             // we had enough drama with pin configuration in board.h and else that we shall self-check
  
             const int logicalValue =
                 (outputMode == OM_INVERTED)
                 ? !actualValue
                 : actualValue;
  
             // if the pin was set to logical 1, then set an error and disable the pin so that things don't catch fire
             if (logicalValue) {
                 criticalError("HARDWARE VALIDATION FAILED %s: unexpected startup pin state %s actual value=%d logical value=%d mode=%s", msg, hwPortname(brainPin), actualValue, logicalValue, getPin_output_mode_e(outputMode));
                 OutputPin::deInit();
             }
 #endif
         }
     }
 #endif /* EFI_GPIO_HARDWARE */
 }

Referenced by boardInitHardware(), configureHellenCanTerminator(), hellenMegaAccelerometerPreInitCS2Pin(), RegisteredOutputPin::init(), SimpleTransmissionController::init(), Generic4TransmissionController::init(), Gm4l6xTransmissionController::init(), initAccelerometer(), initErrorLed(), initGpPwm(), StepDirectionStepper::initialize(), initMiscOutputPins(), initPin(), initStatusLeds(), initWarningRunningPins(), nm_bus_init(), portInitAdc(), runSchedulingPrecisionTestIfNeeded(), setHellenEnPin(), DcHardware::start(), EnginePins::startAuxValves(), startHip9001_pins(), EnginePins::startIgnitionPins(), EnginePins::startInjectionPins(), startSimplePwmExt(), startSmartCsPins(), and startTriggerEmulatorPins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInitialized()

bool OutputPin::isInitialized ( ) const

Definition at line 536 of file efi_gpio.cpp.

                                     {
 #if EFI_GPIO_HARDWARE && EFI_PROD_CODE
 #if (BOARD_EXT_GPIOCHIPS > 0)
     if (ext)
         return true;
 #endif /* (BOARD_EXT_GPIOCHIPS > 0) */
     return m_port != NULL;
 #else /* EFI_GPIO_HARDWARE */
     return true;
 #endif /* EFI_GPIO_HARDWARE */
 }

Referenced by assertPinAssigned(), hellenMegaAccelerometerPreInitCS2Pin(), initAccelerometer(), isGdiEngine(), HpfpController::onFastCallback(), HpfpController::scheduleNextCycle(), NamedOutputPin::stop(), and InjectionEvent::update().

Here is the caller graph for this function:

◆ resetToggleStats()

void OutputPin::resetToggleStats ( )

Definition at line 575 of file efi_gpio.cpp.

                                  {
     durationsInStateMs[0] = durationsInStateMs[1] = 0;
     pinToggleCounter = 0;
 }

Referenced by resetPinStats().

Here is the caller graph for this function:

◆ setDefaultPinState()

void OutputPin::setDefaultPinState ( pin_output_mode_e mode )

private

we track current pin status so that we do not touch the actual hardware if we want to write new pin bit which is same as current pin value. This maybe helps in case of status leds, but maybe it's a total over-engineering

Definition at line 651 of file efi_gpio.cpp.

                                                                {
     assertOMode(mode);
     this->mode = outputMode;
     setValue(false, /*force*/true); // initial state
 }

Referenced by initPin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOnchipValue()

void OutputPin::setOnchipValue ( int electricalValue )

private

Definition at line 560 of file efi_gpio.cpp.

                                                   {
     if (brainPin == Gpio::Unassigned || brainPin == Gpio::Invalid) {
         // todo: make 'setOnchipValue' or 'reportsetOnchipValueError' virtual and override for NamedOutputPin?
         warning(ObdCode::CUSTOM_ERR_6586, "attempting to change unassigned pin");
         return;
     }
     palWritePad(m_port, m_pin, electricalValue);
 }

Referenced by setValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue() [1/2]

void OutputPin::setValue	(	const char *	msg,
		int	logicValue,
		bool	isForce = `false`
	)

Definition at line 583 of file efi_gpio.cpp.

                                                                       {
     UNUSED(msg);
     if ((qcDirectPinControlMode || getOutputOnTheBenchTest() == this) && !isForce) {
         return;
     }
  
 #if ENABLE_PERF_TRACE
 // todo: https://github.com/rusefi/rusefi/issues/1638
 //  ScopePerf perf(PE::OutputPinSetValue);
 #endif // ENABLE_PERF_TRACE
  
 #if EFI_UNIT_TEST
     if (currentLogicValue != logicValue) {
         pinToggleCounter++;
     }
 #endif // EFI_UNIT_TEST
  
 #if EFI_SIMULATOR
     if (currentLogicValue != logicValue) {
         if (pinToggleCounter > 0) {
             durationsInStateMs[0] = durationsInStateMs[1];
             durationsInStateMs[1] = pinToggleTimer.getElapsedUs() / 1000;
         }
         pinToggleCounter++;
         pinToggleTimer.reset();
     }
 #endif // EFI_SIMULATOR
  
 #if EFI_UNIT_TEST
     if (verboseMode) {
         efiPrintf("pin goes %d", logicValue);
     }
 #endif // EFI_UNIT_TEST
  
     // Always store the current logical value of the pin (so it can be
     // used internally even if not connected to a real hardware pin)
     currentLogicValue = logicValue;
  
     // Nothing else to do if not configured
     if (!isBrainPinValid(brainPin)) {
         return;
     }
  
     efiAssertVoid(ObdCode::CUSTOM_ERR_6622, mode <= OM_OPENDRAIN_INVERTED, "invalid pin_output_mode_e");
     int electricalValue = getElectricalValue(logicValue, mode);
  
 #if EFI_PROD_CODE
     #if (BOARD_EXT_GPIOCHIPS > 0)
         if (!this->ext) {
             setOnchipValue(electricalValue);
         } else {
             /* external pin */
             gpiochips_writePad(this->brainPin, logicValue);
             /* TODO: check return value */
         }
     #else
         setOnchipValue(electricalValue);
     #endif
 #else /* EFI_PROD_CODE */
     setMockState(brainPin, electricalValue);
 #endif /* EFI_PROD_CODE */
 }

Referenced by applyPinState(), PwmConfig::applyPwmValue(), benchOff(), benchOn(), blink_digits(), boardOnConfigurationChange(), configureHellenCanTerminator(), TwoPinDcMotor::disable(), TwoPinDcMotor::enable(), firmwareError(), getAndSet(), hellenDisableEn(), hellenEnableEn(), hellenMegaAccelerometerPreInitCS2Pin(), hipThread(), StepDirectionStepper::initialize(), nm_bus_init(), AcController::onSlowCallback(), FuelPumpController::onSlowCallback(), HarleyAcr::onSlowCallback(), MainRelayController::onSlowCallback(), Engine::OnTriggerSynchronization(), Engine::periodicSlowCallback(), StepDirectionStepper::pulse(), readSlowAnalogInputs(), InjectorOutputPin::reset(), runSchedulingPrecisionTestIfNeeded(), TwoPinDcMotor::set(), setDefaultPinState(), StepDirectionStepper::setDirection(), NamedOutputPin::setHigh(), NamedOutputPin::setLow(), GppwmChannel::setOutput(), PwmWrapper::setSimplePwmDutyCycle(), Generic4TransmissionController::setTccState(), setValue(), DcHardware::start(), startSmartCsPins(), NamedOutputPin::stop(), toggle(), turnAllPinsOff(), and SimpleTransmissionController::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue() [2/2]

void OutputPin::setValue	(	int	logicValue,
		bool	isForce = `false`
	)

Definition at line 570 of file efi_gpio.cpp.

                                                      {
     setValue(nullptr, logicValue, isForce);
 }

Here is the call graph for this function:

◆ toggle()

void OutputPin::toggle ( )

Definition at line 548 of file efi_gpio.cpp.

                        {
     setValue("toggle", !getLogicValue());
 }

Referenced by TriggerDecoderBase::decodeTriggerEvent(), and toggleTestAndScheduleNext().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ brainPin

brain_pin_e OutputPin::brainPin = Gpio::Unassigned

Definition at line 87 of file efi_output.h.

Referenced by deInit(), getDiag(), initPin(), SensorChecker::onSlowCallback(), runBench(), setOnchipValue(), and setValue().

◆ currentLogicValue

int8_t OutputPin::currentLogicValue = INITIAL_PIN_STATE

Definition at line 94 of file efi_output.h.

Referenced by EnginePins::debug(), fireSparkBySettingPinLow(), getLogicValue(), InjectorOutputPin::reset(), setValue(), and startDwellByTurningSparkPinHigh().

◆ durationsInStateMs

uint32_t OutputPin::durationsInStateMs[2]

Definition at line 82 of file efi_output.h.

Referenced by resetToggleStats(), runBench(), sendPinStatePackets(), and setValue().

◆ ext

bool OutputPin::ext = false

Definition at line 91 of file efi_output.h.

Referenced by deInit(), initPin(), isInitialized(), and setValue().

◆ m_pin

uint8_t OutputPin::m_pin = 0

Definition at line 73 of file efi_output.h.

Referenced by initPin(), nm_bus_init(), and setOnchipValue().

◆ m_port

ioportid_t OutputPin::m_port = 0

Definition at line 72 of file efi_output.h.

Referenced by initPin(), isInitialized(), nm_bus_init(), and setOnchipValue().

◆ mode

pin_output_mode_e OutputPin::mode = OM_DEFAULT

private

Definition at line 105 of file efi_output.h.

Referenced by setDefaultPinState(), and setValue().

◆ pinToggleCounter

int OutputPin::pinToggleCounter = 0

Definition at line 77 of file efi_output.h.

Referenced by initPin(), resetToggleStats(), runBench(), sendPinStatePackets(), and setValue().

◆ pinToggleTimer

Timer OutputPin::pinToggleTimer

Definition at line 81 of file efi_output.h.

Referenced by setValue().

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

controllers/system/efi_output.h
controllers/system/efi_gpio.cpp

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ deInit()

◆ getAndSet()

◆ getDiag()

◆ getLogicValue()

◆ initPin() [1/2]

◆ initPin() [2/2]

◆ isInitialized()

◆ resetToggleStats()

◆ setDefaultPinState()

◆ setOnchipValue()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ toggle()

Field Documentation

◆ brainPin

◆ currentLogicValue

◆ durationsInStateMs

◆ ext

◆ m_pin

◆ m_port

◆ mode

◆ pinToggleCounter

◆ pinToggleTimer