error_handling.h File Reference

Detailed Description

Date

Mar 6, 2014

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file error_handling.h.

Data Structures
struct	backupErrorState

Typedefs
using	critical_msg_t = char[CRITICAL_BUFFER_SIZE]

Enumerations
enum class	ErrorCookie : uint32_t { None = 0 , FirmwareError = 0xcafebabe , HardFault = 0xdeadbeef , ChibiOsPanic = 0xdeadfa11 }

Functions
bool	warning (ObdCode code, const char *fmt,...)
bool	warningTsReport (ObdCode code, const char *fmt,...)
void	firmwareError (ObdCode code, const char *fmt,...)
const char *	getCriticalErrorMessage ()
void	configError (const char *fmt,...)
void	clearConfigErrorMessage ()
const char *	getConfigErrorMessage ()
bool	hasConfigError ()
bool	hasErrorReportFile ()
int	getRusEfiVersion ()
const char *	errorCookieToName (ErrorCookie cookie)
void	errorHandlerInit ()
bool	errorHandlerIsStartFromError ()
void	errorHandlerShowBootReasonAndErrors ()

Variables
bool	hasCriticalFirmwareErrorFlag

Typedef Documentation

critical_msg_t

using critical_msg_t = char[CRITICAL_BUFFER_SIZE]

Definition at line 27 of file error_handling.h.

Enumeration Type Documentation

ErrorCookie

enum class ErrorCookie : uint32_t

strong

Enumerator
None
FirmwareError
HardFault
ChibiOsPanic

Definition at line 88 of file error_handling.h.

                       : uint32_t {
    None = 0,
    FirmwareError = 0xcafebabe,
    HardFault = 0xdeadbeef,
    ChibiOsPanic = 0xdeadfa11,
};

Function Documentation

clearConfigErrorMessage()

void clearConfigErrorMessage

(

)

Definition at line 62 of file error_handling.cpp.

                               {
    hasConfigErrorFlag = false;
}

configError()

void configError	(	const char *	fmt,
			...
	)

Definition at line 593 of file error_handling.cpp.

                                       {
        va_list ap;
        va_start(ap, fmt);
        chvsnprintf(configErrorMessageBuffer, sizeof(configErrorMessageBuffer), fmt, ap);
        va_end(ap);
        hasConfigErrorFlag = true;
}

errorCookieToName()

const char * errorCookieToName

(

ErrorCookie

cookie

)

Definition at line 134 of file error_handling.cpp.

{
    switch (cookie) {
    case ErrorCookie::None:
        return "No error";
    case ErrorCookie::FirmwareError:
        return "firmware";
    case ErrorCookie::HardFault:
        return "HardFault";
    case ErrorCookie::ChibiOsPanic:
        return "ChibiOS panic";
    }
 
    return "Unknown";
}

errorHandlerInit()

void errorHandlerInit

(

)

Definition at line 77 of file error_handling.cpp.

                        {
#if EFI_BACKUP_SRAM
    /* copy error state from backup RAM and clear it in backup RAM.
     * so few users can access previous error state and we should not care about who sohuld clear backup ram. */
    auto sramState = getBackupSram();
    memcpy(&lastBootError, &sramState->err, sizeof(backupErrorState));
    memset(&sramState->err, 0x00, sizeof(sramState->err));
    // Reset cookie so we don't report it again.
    sramState->err.Cookie = ErrorCookie::None;
 
    // Cookie can be some random value at first power on
    // reset to None to avoid generating 'Unknown' fail report
    if ((lastBootError.Cookie != ErrorCookie::FirmwareError) &&
        (lastBootError.Cookie != ErrorCookie::HardFault) &&
        (lastBootError.Cookie != ErrorCookie::ChibiOsPanic)) {
        lastBootError.Cookie = ErrorCookie::None;
    }
 
    //bootcount
    if (sramState->BootCountCookie != 0xdeadbeef) {
        sramState->BootCountCookie = 0xdeadbeef;
        sramState->BootCount = 0;
    }
    // save current bootcounter
    bootCount = sramState->BootCount;
 
    sramState->BootCount++;
 
    if (engineConfiguration->rethrowHardFault) {
        backupErrorState *err = &lastBootError;
        if (err->Cookie == ErrorCookie::HardFault) {
            criticalError("Last boot had hard fault type: %lx addr: %lx CSFR: %lx",
                err->FaultType, err->FaultAddress, err->Csfr);
        }
    }
 
    Reset_Cause_t cause = getMCUResetCause();
    // if reset by watchdog, signal a fatal error
    if ((cause == Reset_Cause_IWatchdog) || (cause == Reset_Cause_WWatchdog)) {
        firmwareError(ObdCode::OBD_PCM_Processor_Fault, "Watchdog Reset detected! Check SD card for report file.");
    }
#endif // EFI_PROD_CODE
 
    // see https://github.com/rusefi/rusefi/wiki/Resilience
    addConsoleAction("chibi_fault", [](){ chDbgCheck(0); } );
    addConsoleAction("soft_fault", [](){ firmwareError(ObdCode::RUNTIME_CRITICAL_TEST_ERROR, "firmwareError: %d", getRusEfiVersion()); });
    addConsoleAction("hard_fault", [](){ causeHardFault(); } );
}

Referenced by runRusEfi().

Here is the call graph for this function:

Here is the caller graph for this function:

errorHandlerIsStartFromError()

bool errorHandlerIsStartFromError

(

)

Definition at line 126 of file error_handling.cpp.

                                    {
#if EFI_BACKUP_SRAM
    return (lastBootError.Cookie != ErrorCookie::None);
#else
    return 0;
#endif
}

errorHandlerShowBootReasonAndErrors()

void errorHandlerShowBootReasonAndErrors

(

)

Definition at line 232 of file error_handling.cpp.

                                           {
    //this is console print
    #define PRINT(...) efiPrintf(__VA_ARGS__)
 
    printResetReason();
    printWdResetCounter();
 
#if EFI_BACKUP_SRAM
    backupErrorState *err = &lastBootError;
    ErrorCookie cookie = err->Cookie;
 
    printErrorState();
    printErrorStack();
#endif // EFI_BACKUP_SRAM
    #undef PRINT
}

Referenced by runRusEfi().

Here is the caller graph for this function:

firmwareError()

void firmwareError	(	ObdCode	code,
		const char *	fmt,
			...
	)

Something really bad had happened - firmware cannot function, we cannot run the engine We definitely use this critical error approach in case of invalid configuration. If user sets a self-contradicting configuration we have to just put a hard stop on this.

see also warning()

Definition at line 670 of file error_handling.cpp.

                                                       {
    va_list ap;
    va_start(ap, fmt);
    firmwareErrorV(code, fmt, ap);
    va_end(ap);
}

Referenced by TriggerWaveform::addEvent(), applyUnknownEngineType(), TriggerScheduler::assertNotInList(), assertTimeIsLinear(), TriggerWaveform::calculateExpectedEventCounts(), calculateTriggerSynchPoint(), MultiChannelStateSequence::checkSwitchTimes(), TripOdometer::consumeFuel(), AemXSeriesWideband::decodeRusefiStandard(), TriggerDecoderBase::decodeTriggerEvent(), EtbImpl< TBase >::doAutocal(), doInitElectronicThrottle(), efiExtiEnablePin(), ensureArrayIsAscending(), errorHandlerInit(), SingleTimerExecutor::executeAllPendingActions(), findIndexMsg(), TriggerCentral::findNextTriggerToothAngle(), TriggerStimulatorHelper::findTriggerSyncPoint(), getAdcChannelBrainPin(), getAirmassModel(), getCylinderNumberAtIndex(), getFiringOrderLength(), getFiringOrderTable(), getHwPin(), getHwPort(), getIgnitionPinForIndex(), getInjectionModeDurationMultiplier(), getMapCfg(), getNumberOfInjections(), getNumberOfSparks(), getPortIndex(), getPortIndex(), getPortIndex(), getSpiDevice(), gpio_pin_markUsed(), PwmConfig::handleCycleStart(), initAuxValves(), initEgoSensor(), initHistogram(), initializeSkippedToothTrigger(), OutputPin::initPin(), look_up_rpm_can_id(), look_up_vss_can_id(), onCliCaseError(), onCliDuplicateError(), onCliOverflowError(), TachometerModule::onFastCallback(), FLStack< T, MAXSIZE >::pop(), portSetHardwareSchedulerTimer(), FLStack< T, MAXSIZE >::push(), recalculateAuxValveTiming(), EventQueue::remove(), runBench(), SingleTimerExecutor::schedule(), setHardwareSchedulerTimer(), GppwmChannel::setOutput(), startCanPins(), swapOutputBuffers(), timerCallback(), timerValidationCallback(), turnOnTriggerInputPin(), InjectionEvent::update(), validateHardwareTimer(), validateThermistorConfig(), and wrapAngle().

Here is the call graph for this function:

getConfigErrorMessage()

const char * getConfigErrorMessage

(

)

Definition at line 601 of file error_handling.cpp.

                                    {
    return configErrorMessageBuffer;
}

Referenced by handleGetConfigErorr().

Here is the caller graph for this function:

getCriticalErrorMessage()

const char * getCriticalErrorMessage

(

)

Definition at line 54 of file error_handling.cpp.

                                      {
    return criticalErrorMessageBuffer;
}

Referenced by handleGetConfigErorr(), handleTestCommand(), and updateDevConsoleState().

Here is the caller graph for this function:

getRusEfiVersion()

int getRusEfiVersion

(

)

See also SIGNATURE_HASH

Definition at line 766 of file engine_controller.cpp.

                       {
#if defined(EFI_BOOTLOADER_INCLUDE_CODE)
    // make bootloader code happy too
    if (initBootloader() != 0)
        return 123;
#endif /* EFI_BOOTLOADER_INCLUDE_CODE */
    return VCS_DATE;
}

Referenced by errorHandlerInit(), errorHandlerWriteReportFile(), firmwareErrorV(), handleGetVersion(), printVersionForConsole(), readFromFlash(), sayHello(), and updateTunerStudioState().

Here is the caller graph for this function:

hasConfigError()

bool hasConfigError

(

)

Definition at line 58 of file error_handling.cpp.

                      {
    return hasConfigErrorFlag;
}

Referenced by updateTunerStudioState().

Here is the caller graph for this function:

hasErrorReportFile()

bool hasErrorReportFile

(

)

Definition at line 66 of file error_handling.cpp.

                          {
    return hasReportFile;
}

Referenced by updateTunerStudioState().

Here is the caller graph for this function:

warning()

bool warning	(	ObdCode	code,
		const char *	fmt,
			...
	)

Something is wrong, but we can live with it: some minor sensor is disconnected or something like that

see also firmwareError()

Definition at line 528 of file error_handling.cpp.

                                                 {
    va_list args;
    va_start(args, fmt);
    bool ret = warningVA(code, false, fmt, args);
    va_end(args);
    return ret;
}

Referenced by TriggerWaveform::addEvent(), TriggerScheduler::assertNotInList(), assertPinAssigned(), TriggerStimulatorHelper::assertSyncPosition(), buildTimingMap(), check(), customTrigger(), CanTsListener::decodeFrame(), AemXSeriesWideband::decodeRusefiDiag(), Engine::efiWatchdog(), findIndexMsg(), fireSparkBySettingPinLow(), flexCallback(), IgnitionState::getAdvance(), SpeedDensityAirmass::getAirmass(), getBaroCorrection(), getCrankingFuel3(), getCylinderNumberAtIndex(), InjectorModelWithConfig::getFuelDifferentialPressure(), getInjectionOffset(), getInternalAdcValue(), getRunningAdvance(), IgnitionState::getSparkDwell(), IFuelComputer::getTCharge(), Pid::getUnclampedOutput(), TriggerCentral::handleShaftSignal(), handleVvtCamSignal(), interpolateMsg(), TriggerCentral::isToothExpectedNow(), mapAveragingAdcCallback(), PrimaryTriggerDecoder::onNotEnoughTeeth(), VvtTriggerDecoder::onNotEnoughTeeth(), SensorChecker::onSlowCallback(), PrimaryTriggerDecoder::onTooManyTeeth(), VvtTriggerDecoder::onTooManyTeeth(), onTriggerEventSparkLogic(), InjectionEvent::onTriggerTooth(), EngineState::periodicFastCallback(), prepareIgnitionSchedule(), readFromFlash(), sdFormat(), sdLoggerCreateFile(), setHardwareSchedulerTimer(), OutputPin::setOnchipValue(), SimplePwm::setSimplePwmDutyCycle(), startDwellByTurningSparkPinHigh(), startSimplePwm(), MapAverager::stop(), tooSoonToHandleSignal(), InjectionEvent::update(), LimpManager::updateState(), validateBaroMap(), and TriggerCentral::validateCamVvtCounters().

Here is the call graph for this function:

warningTsReport()

bool warningTsReport	(	ObdCode	code,
		const char *	fmt,
			...
	)

Same as above, but also report to user by pop-up window in TunerStudio

Definition at line 536 of file error_handling.cpp.

                                                         {
    va_list args;
    va_start(args, fmt);
    bool ret = warningVA(code, true, fmt, args);
    va_end(args);
    return ret;
}

Referenced by Engine::periodicSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

hasCriticalFirmwareErrorFlag

bool hasCriticalFirmwareErrorFlag

extern

Definition at line 35 of file error_handling.cpp.

Referenced by firmwareErrorV(), and warningVA().

Go to the source code of this file.