storage.h File Reference

Detailed Description

Date

Jan 4, 2025

Author

Andrey Gusakov

Definition in file storage.h.

Data Structures
class	SettingStorageBase

Enumerations
enum class	StorageStatus {   Ok , CrcFailed , IncompatibleVersion , NotSupported ,   NotFound , Failed }
enum	StorageType {   STORAGE_INT_FLASH = 0 , STORAGE_MFS_INT_FLASH = 1 , STORAGE_MFS_EXT_FLASH = 2 , STORAGE_SD_CARD = 3 ,   STORAGE_TOTAL }
enum	StorageItemId { EFI_SETTINGS_RECORD_ID = 1 , EFI_SETTINGS_BACKUP_RECORD_ID = 2 , EFI_LTFT_RECORD_ID = 3 , EFI_STORAGE_TOTAL_ITEMS }

Functions
bool	storageAllowWriteID (StorageItemId id)
StorageStatus	storageWrite (StorageItemId id, const uint8_t *ptr, size_t size)
StorageStatus	storageRead (StorageItemId id, uint8_t *ptr, size_t size)
bool	storageRequestWriteID (StorageItemId id, bool forced)
bool	storageReqestReadID (StorageItemId id)
bool	storageRegisterStorage (StorageType type, SettingStorageBase *storage)
bool	storageUnregisterStorage (StorageType type)
bool	storageIsStorageRegistered (StorageType type)
bool	storagRequestRegisterStorage (StorageType id)
bool	storagRequestUnregisterStorage (StorageType id)
bool	getNeedToWriteConfiguration ()
void	initStorage ()

Enumeration Type Documentation

StorageItemId

enum StorageItemId

Enumerator
EFI_SETTINGS_RECORD_ID
EFI_SETTINGS_BACKUP_RECORD_ID
EFI_LTFT_RECORD_ID
EFI_STORAGE_TOTAL_ITEMS

Definition at line 47 of file storage.h.

                   {
    /* 0 is reserved due to MFS limitation */
    EFI_SETTINGS_RECORD_ID = 1,
    EFI_SETTINGS_BACKUP_RECORD_ID = 2,
    EFI_LTFT_RECORD_ID = 3,
 
    EFI_STORAGE_TOTAL_ITEMS
};

StorageStatus

enum class StorageStatus

strong

Enumerator
Ok
CrcFailed
IncompatibleVersion
NotSupported
NotFound
Failed

Definition at line 12 of file storage.h.

                         {
    Ok,
    CrcFailed,
    IncompatibleVersion,
    NotSupported,
    // all is well, but we're on a fresh chip with blank memory
    NotFound,
    // Write failed
    Failed
};

StorageType

enum StorageType

Enumerator
STORAGE_INT_FLASH
STORAGE_MFS_INT_FLASH
STORAGE_MFS_EXT_FLASH
STORAGE_SD_CARD
STORAGE_TOTAL

Definition at line 37 of file storage.h.

                 {
    STORAGE_INT_FLASH = 0,
    STORAGE_MFS_INT_FLASH = 1,
    STORAGE_MFS_EXT_FLASH = 2,
    STORAGE_SD_CARD = 3,
 
    STORAGE_TOTAL
};

Function Documentation

getNeedToWriteConfiguration()

bool getNeedToWriteConfiguration

(

)

Returns

true if an persistentState write is pending

Definition at line 353 of file storage.cpp.

                                   {
    return (pendingWrites & BIT(EFI_SETTINGS_RECORD_ID)) != 0;
}

Referenced by updateFlags().

Here is the caller graph for this function:

initStorage()

void initStorage

(

)

Definition at line 357 of file storage.cpp.

                   {
    bool settingsStorageReady = false;
    // may be unused
    (void)settingsStorageReady;
 
#if EFI_STORAGE_INT_FLASH == TRUE
    settingsStorageReady = initStorageFlash();
#endif // EFI_STORAGE_INT_FLASH
 
#if EFI_STORAGE_MFS == TRUE
    if (settingsStorageReady) {
        // Skip MFS if internal storage is used for persistentState
        // Init of MFS may take significant time, lets postpone it until storage manager thread
        storagRequestRegisterStorage(STORAGE_MFS_EXT_FLASH);
    } else {
        // Set long timeout to watchdog as this code is called before any thread is started
        // and no one is feeding watchdog
        startWatchdog(WATCHDOG_MFS_START_TIMEOUT_MS);
 
        initStorageMfs();
 
        // restart the watchdog with the default timeout
        startWatchdog();
    }
#endif // EFI_STORAGE_MFS
 
    chThdCreateStatic(storageManagerThreadStack, sizeof(storageManagerThreadStack), PRIO_STORAGE_MANAGER, storageManagerThread, nullptr);
}

Referenced by initFlash().

Here is the call graph for this function:

Here is the caller graph for this function:

storageAllowWriteID()

bool storageAllowWriteID

(

StorageItemId

id

)

Definition at line 19 of file storage.cpp.

{
#if (EFI_STORAGE_INT_FLASH == TRUE) || defined(EFI_UNIT_TEST)
    if ((id == EFI_SETTINGS_RECORD_ID) ||
        (id == EFI_SETTINGS_BACKUP_RECORD_ID)) {
        // special case, settings can be stored in internal flash
 
        // writing internal flash can cause cpu freeze
        // check if HW support flash writing while executing
        if (mcuCanFlashWhileRunning()) {
            return true;
        }
 
#if EFI_SHAFT_POSITION_INPUT
        // MCU does not support write while executing, check if engine is stopped
        if (engine->triggerCentral.directSelfStimulation || engine->rpmCalculator.isStopped()) {
            return true;
        } else {
            // rusEfi usually runs on hardware which halts execution while writing to internal flash, so we
            // postpone writes to until engine is stopped. Writes in case of self-stimulation are fine.
            return false;
        }
#endif // EFI_SHAFT_POSITION_INPUT
    }
#endif // EFI_STORAGE_INT_FLASH
 
    // TODO: we expect every other ID to be stored in external flash...
    return true;
}

Referenced by storageManagerThread().

Here is the call graph for this function:

Here is the caller graph for this function:

storageIsStorageRegistered()

bool storageIsStorageRegistered

(

StorageType

type

)

Definition at line 230 of file storage.cpp.

                                                  {
    if (type >= STORAGE_TOTAL) {
        return false;
    }
 
    return (storages[type] != nullptr);
}

Referenced by hellenDisableEn(), storageRegisterStorage(), and storageUnregisterStorage().

Here is the caller graph for this function:

storageRead()

StorageStatus storageRead	(	StorageItemId	id,
		uint8_t *	ptr,
		size_t	size
	)

Definition at line 160 of file storage.cpp.

                                                                       {
    bool success = false;
    StorageStatus status = StorageStatus::NotSupported;
 
    for_all_storages {
        if ((!storage->isReady()) || (!storage->isIdSupported(id))) {
            continue;
        }
 
        status = storage->read(id, ptr, size);
        if (status == StorageStatus::Ok) {
            success = true;
        }
    }
 
    return (success ? StorageStatus::Ok : status);
}

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

Here is the caller graph for this function:

storageRegisterStorage()

bool storageRegisterStorage	(	StorageType	type,
		SettingStorageBase *	storage
	)

Definition at line 194 of file storage.cpp.

                                                                           {
    if (type >= STORAGE_TOTAL) {
        return false;
    }
 
    if (storageIsStorageRegistered(type)) {
        /* already registered */
        efiPrintf("Trying to register already exist storage %s", storageTypeToName(type));
        return false;
    }
 
    storages[type] = storage;
    efiPrintf("Storage %s registered", storageTypeToName(type));
 
    storageManagerSendCmd(MSG_CMD_PING, 0);
 
    return true;
}

Referenced by initStorageFlash(), initStorageMfs(), and initStorageSD().

Here is the call graph for this function:

Here is the caller graph for this function:

storageReqestReadID()

bool storageReqestReadID

(

StorageItemId

id

)

Definition at line 190 of file storage.cpp.

                                           {
    return storageManagerSendCmd(MSG_CMD_READ, (uint32_t)id);
}

Referenced by LtftState::load().

Here is the call graph for this function:

Here is the caller graph for this function:

storageRequestWriteID()

bool storageRequestWriteID	(	StorageItemId	id,
		bool	forced
	)

Definition at line 186 of file storage.cpp.

                                                          {
    return storageManagerSendCmd(forced ? MSG_CMD_WRITE_NOW : MSG_CMD_WRITE, (uint32_t)id);
}

Referenced by setNeedToWriteConfiguration(), settingsLtftRequestWriteToFlash(), and writeToFlashNow().

Here is the call graph for this function:

Here is the caller graph for this function:

storageUnregisterStorage()

bool storageUnregisterStorage

(

StorageType

type

)

Definition at line 213 of file storage.cpp.

                                                {
    if (type >= STORAGE_TOTAL) {
        return false;
    }
 
    if (!storageIsStorageRegistered(type)) {
        /* already unregistered */
        efiPrintf("Trying to unregister non-exist storage %s", storageTypeToName(type));
        return false;
    }
 
    storages[type] = nullptr;
    efiPrintf("Storage %s unregistered", storageTypeToName(type));
 
    return true;
}

Referenced by deinitStorageSD(), and storageManagerThread().

Here is the call graph for this function:

Here is the caller graph for this function:

storageWrite()

StorageStatus storageWrite	(	StorageItemId	id,
		const uint8_t *	ptr,
		size_t	size
	)

Definition at line 142 of file storage.cpp.

                                                                              {
    bool success = false;
    StorageStatus status = StorageStatus::NotSupported;
 
    for_all_storages {
        if ((!storage->isReady()) || (!storage->isIdSupported(id))) {
            continue;
        }
 
        status = storage->store(id, ptr, size);
        if (status == StorageStatus::Ok) {
            success = true;
        }
    }
 
    return (success ? StorageStatus::Ok : status);
}

Referenced by LtftState::save(), and writeToFlashNowImpl().

Here is the caller graph for this function:

storagRequestRegisterStorage()

bool storagRequestRegisterStorage

(

StorageType

id

)

Definition at line 238 of file storage.cpp.

{
    return storageManagerSendCmd(MSG_CMD_REG, (uint32_t)id);
}

Referenced by hellenEnableEn(), and initStorage().

Here is the call graph for this function:

Here is the caller graph for this function:

storagRequestUnregisterStorage()

bool storagRequestUnregisterStorage

(

StorageType

id

)

Definition at line 243 of file storage.cpp.

{
    return storageManagerSendCmd(MSG_CMD_UNREG, (uint32_t)id);
}

Referenced by hellenDisableEn().

Here is the call graph for this function:

Here is the caller graph for this function:

Go to the source code of this file.