flash_main.cpp File Reference

Detailed Description

Higher-level logic of saving data into internal flash memory.

Date

Sep 19, 2013

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file flash_main.cpp.

Functions
void	writeToFlashNow ()
void	setNeedToWriteConfiguration ()
bool	settingsLtftRequestWriteToFlash ()
bool	writeToFlashNowImpl ()
static StorageStatus	validatePersistentState ()
static StorageStatus	readConfiguration ()
void	readFromFlash ()
static void	doWriteConfigurationToFlash ()
static void	doResetConfiguration ()
static void	doRewriteConfig ()
static void	doWriteLTFT ()
void	initFlash ()

Function Documentation

doResetConfiguration()

static void doResetConfiguration ( )

static

Definition at line 151 of file flash_main.cpp.

                                   {
    resetConfigurationExt(engineConfiguration->engineType);
}

Referenced by doRewriteConfig(), and initFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

doRewriteConfig()

static void doRewriteConfig ( )

static

Definition at line 155 of file flash_main.cpp.

                              {
    doResetConfiguration();
    // force settings write to storage
    writeToFlashNow();
}

Referenced by initFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

doWriteConfigurationToFlash()

static void doWriteConfigurationToFlash ( )

static

Definition at line 146 of file flash_main.cpp.

                                          {
    // force settings write to storage
    writeToFlashNow();
}

Referenced by initFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

doWriteLTFT()

static void doWriteLTFT ( )

static

Definition at line 161 of file flash_main.cpp.

                          {
    settingsLtftRequestWriteToFlash();
}

Referenced by initFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

initFlash()

void initFlash

(

)

This would write NOW (you should not be doing this while connected to real engine)

This would schedule write to flash once the engine is stopped

Definition at line 165 of file flash_main.cpp.

                 {
    // Init storage(s) if any
    // Note: may take some time
    initStorage();
 
    addConsoleAction("readconfig", readFromFlash);
    /**
     * This would write NOW (you should not be doing this while connected to real engine)
     */
    addConsoleAction(CMD_WRITECONFIG, doWriteConfigurationToFlash);
 
    addConsoleAction("ltftwrite", doWriteLTFT);
#if EFI_TUNER_STUDIO
    /**
     * This would schedule write to flash once the engine is stopped
     */
    addConsoleAction(CMD_BURNCONFIG, requestBurn);
#endif
    addConsoleAction("resetconfig", doResetConfiguration);
    addConsoleAction("rewriteconfig", doRewriteConfig);
}

Referenced by initHardwareNoConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

readConfiguration()

static StorageStatus readConfiguration ( )

static

this method could and should be executed before we have any connectivity so no console output here

in this method we read first copy of configuration in flash. if that first copy has CRC or other issues we read second copy.

Definition at line 96 of file flash_main.cpp.

                                         {
    auto firstCopy = storageRead(EFI_SETTINGS_RECORD_ID, (uint8_t *)&persistentState, sizeof(persistentState));
    if (firstCopy == StorageStatus::Ok) {
        firstCopy = validatePersistentState();
        if (firstCopy == StorageStatus::Ok) {
            return StorageStatus::Ok;
        }
    }
 
    auto secondCopy = storageRead(EFI_SETTINGS_BACKUP_RECORD_ID, (uint8_t *)&persistentState, sizeof(persistentState));
    if (secondCopy == StorageStatus::Ok) {
        secondCopy = validatePersistentState();
        if (secondCopy == StorageStatus::Ok) {
            return StorageStatus::Ok;
        }
    }
 
    return firstCopy;
}

Referenced by readFromFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

readFromFlash()

void readFromFlash

(

)

Definition at line 116 of file flash_main.cpp.

                     {
    StorageStatus result = readConfiguration();
 
    switch (result) {
        case StorageStatus::CrcFailed:
            warning(ObdCode::CUSTOM_ERR_FLASH_CRC_FAILED, "flash CRC failed");
            efiPrintf("Need to reset flash to default due to CRC mismatch");
            [[fallthrough]];
        case StorageStatus::NotFound:
        case StorageStatus::Failed:
        case StorageStatus::NotSupported:
            resetConfigurationExt(DEFAULT_ENGINE_TYPE);
            break;
        case StorageStatus::IncompatibleVersion:
            // Preserve engine type from old config
            efiPrintf("Resetting due to version mismatch but preserving engine type [%d]", (int)engineConfiguration->engineType);
            resetConfigurationExt(engineConfiguration->engineType);
            break;
        case StorageStatus::Ok:
            // At this point we know that CRC and version number is what we expect. Safe to assume it's a valid configuration.
            applyNonPersistentConfiguration();
            efiPrintf("Read valid configuration from flash!");
            break;
    }
 
    // we can only change the state after the CRC check
    engineConfiguration->byFirmwareVersion = getRusEfiVersion();
    engine->preCalculate();
}

Referenced by initFlash(), and loadConfiguration().

Here is the call graph for this function:

Here is the caller graph for this function:

setNeedToWriteConfiguration()

void setNeedToWriteConfiguration

(

)

Definition at line 43 of file flash_main.cpp.

                                   {
    efiPrintf("Scheduling write");
 
    storageRequestWriteID(EFI_SETTINGS_RECORD_ID, false);
}

Referenced by LongTermIdleTrim::checkIfShouldSave(), and requestBurn().

Here is the call graph for this function:

Here is the caller graph for this function:

settingsLtftRequestWriteToFlash()

bool settingsLtftRequestWriteToFlash

(

)

Definition at line 49 of file flash_main.cpp.

                                       {
    return storageRequestWriteID(EFI_LTFT_RECORD_ID, false);
}

Referenced by doWriteLTFT(), and LtftState::load().

Here is the call graph for this function:

Here is the caller graph for this function:

validatePersistentState()

static StorageStatus validatePersistentState ( )

static

Definition at line 73 of file flash_main.cpp.

                                               {
    auto flashCrc = persistentState.getCrc();
 
    if (flashCrc != persistentState.crc) {
        // If the stored crc is all 1s, that probably means the flash is actually blank, not that the crc failed.
        if (persistentState.crc == ((decltype(persistentState.crc))-1)) {
            return StorageStatus::NotFound;
        } else {
            return StorageStatus::CrcFailed;
        }
    } else if (persistentState.version != FLASH_DATA_VERSION || persistentState.size != sizeof(persistentState)) {
        return StorageStatus::IncompatibleVersion;
    } else {
        return StorageStatus::Ok;
    }
}

Referenced by readConfiguration().

Here is the call graph for this function:

Here is the caller graph for this function:

writeToFlashNow()

void writeToFlashNow

(

)

Because of hardware-related issues, some stm32f4/7 chips are totally frozen while we are writing to internal flash. Writing the configuration takes about 1-2 seconds, we cannot afford to do that while the engine is running so we postpone the write until the engine is stopped.

Definition at line 37 of file flash_main.cpp.

                       {
    efiPrintf("Scheduling FORCED write");
 
    storageRequestWriteID(EFI_SETTINGS_RECORD_ID, true);
}

Referenced by doRewriteConfig(), doWriteConfigurationToFlash(), handleCommandX14(), loadConfiguration(), and setEngineType().

Here is the call graph for this function:

Here is the caller graph for this function:

writeToFlashNowImpl()

bool writeToFlashNowImpl

(

)

Definition at line 54 of file flash_main.cpp.

                           {
    engine->configBurnTimer.reset();
 
    // Set up the container
    persistentState.size = sizeof(persistentState);
    persistentState.version = FLASH_DATA_VERSION;
    persistentState.crc = persistentState.getCrc();
 
    // Do actual write
    auto result1 = storageWrite(EFI_SETTINGS_RECORD_ID, (uint8_t *)&persistentState, sizeof(persistentState));
    auto result2 = storageWrite(EFI_SETTINGS_BACKUP_RECORD_ID, (uint8_t *)&persistentState, sizeof(persistentState));
 
    resetMaxValues();
 
    // Some MCU have no enough flash to store two copies. First one is mandatory.
    return ((result1 == StorageStatus::Ok) &&
            ((result2 == StorageStatus::Ok) || (result2 == StorageStatus::NotSupported)));
}

Referenced by storageWriteID().

Here is the call graph for this function:

Here is the caller graph for this function:

Go to the source code of this file.