backup_ram.h File Reference

Detailed Description

Non-volatile backup-RAM registers support.

Date

Dec 19, 2017

Definition in file backup_ram.h.

Data Structures
struct	BackupSramData

Enumerations
enum class	backup_ram_e { StepperPosition , IgnCounter , BACKUP_RAM_NUM }

Functions
uint32_t	backupRamLoad (backup_ram_e idx)
void	backupRamSave (backup_ram_e idx, uint32_t value)
void	backupRamFlush (void)
BackupSramData *	getBackupSram ()

Enumeration Type Documentation

backup_ram_e

enum class backup_ram_e

strong

Enumerator
StepperPosition	IAC Stepper motor position, 16-bit (stored in BKP0R 0..15) Used in stepper.cpp
IgnCounter	Ignition switch counter, 8-bit (stored in BKP0R 16..23) The counter stores the number of times the ignition switch is turned on. Used for prime injection pulse. We need a protection against 'fake' ignition switch on and off (i.e. no engine started), to avoid repeated prime pulses. So we check and update the ignition switch counter in non-volatile backup-RAM. See startPrimeInjectionPulse() in controllers/trigger/main_trigger_callback.cpp
BACKUP_RAM_NUM

Definition at line 14 of file backup_ram.h.

                        {
    /**
     * IAC Stepper motor position, 16-bit (stored in BKP0R 0..15)
     * Used in stepper.cpp
     */
    StepperPosition,
    /**
     * Ignition switch counter, 8-bit (stored in BKP0R 16..23)
     * The counter stores the number of times the ignition switch is turned on. Used for prime injection pulse.
     * We need a protection against 'fake' ignition switch on and off (i.e. no engine started), to avoid repeated prime pulses.
     * So we check and update the ignition switch counter in non-volatile backup-RAM.
     * See startPrimeInjectionPulse() in controllers/trigger/main_trigger_callback.cpp
     */
    IgnCounter,
 
    /* The number of stored backup variables */
    BACKUP_RAM_NUM,
};

Function Documentation

backupRamFlush()

void backupRamFlush

(

void

)

Definition at line 61 of file backup_ram.cpp.

                          {
 
    // todo: implement an incremental "append-to-the-end" algorithm to minimize sector erasings?
 
    // Enter the critical zone
    syssts_t sts = chSysGetStatusAndLockX();
 
    // rewrite the whole sector
    intFlashErase((flashaddr_t)BACKUP_FLASH_ADDR, BACKUP_FLASH_SIZE);
    // mark the data as valid & saved
    backupRam[(int)backupStateOffset] = BACKUP_SAVED;
    // save the data to the flash
    intFlashWrite((flashaddr_t)BACKUP_FLASH_ADDR, (char *)backupRam, backupSize);
 
    // Leaving the critical zone
    chSysRestoreStatusX(sts);
 
    // there should not be any backup-RAM activity after this call
    // but if there is, at least try to reinitialize...
    wasLoaded = false;
}

Here is the call graph for this function:

backupRamLoad()

uint32_t backupRamLoad

(

backup_ram_e

idx

)

Definition at line 43 of file backup_ram.cpp.

                                         {
    // this is executed only once during the firmware init
    if (!wasLoaded) {
        backupInit();
    }
 
    return backupRam[(int)idx + backupDataOffset];
}

Referenced by PrimeController::getKeyCycleCounter(), and StepperMotorBase::loadStepperPos().

Here is the call graph for this function:

Here is the caller graph for this function:

backupRamSave()

void backupRamSave	(	backup_ram_e	idx,
		uint32_t	value
	)

Definition at line 52 of file backup_ram.cpp.

                                                     {
    // this is executed only once during the firmware init
    if (!wasLoaded) {
        backupInit();
    }
 
    backupRam[(int)idx + backupDataOffset] = value;
}

Referenced by PrimeController::onSlowCallback(), StepperMotorBase::saveStepperPos(), and PrimeController::setKeyCycleCounter().

Here is the call graph for this function:

Here is the caller graph for this function:

getBackupSram()

BackupSramData * getBackupSram

(

)

Definition at line 52 of file backup_ram.cpp.

                                {
    return &backupSramData;
}

Referenced by chDbgPanic3(), errorHandlerInit(), firmwareErrorV(), and logHardFault().

Here is the caller graph for this function:

Go to the source code of this file.