flash_helpers.cpp

Go to the documentation of this file.

/*
 * flash_helpers.cpp
 *
 *  Created on: 31.01.2020
 *      Author: Yannick
 */
#include "flash_helpers.h"
#include "eeprom_addresses.h"
#include <vector>
#include "mutex.hpp"
#include <span>
 
cpp_freertos::MutexStandard flashMutex;
// Flash helpers
 
// TODO sometimes on F4 chips when writing HAL_FLASH_ERROR_PGS and HAL_FLASH_ERROR_PGP occur and it is not writing
 
 
#ifdef USE_EEPROM_EMULATION

static void Flash_InvalidateDataCache(){
    __HAL_FLASH_DATA_CACHE_DISABLE();
    __HAL_FLASH_DATA_CACHE_RESET();
    __HAL_FLASH_DATA_CACHE_ENABLE();
}
 
bool Flash_Format(){
    HAL_FLASH_Unlock();
    bool res = (EE_Format() == HAL_OK);
    Flash_InvalidateDataCache();
    HAL_FLASH_Lock();
    return res;
}

__weak bool Flash_Init(){
    HAL_FLASH_Unlock();
    // Clear all the error flags
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_EOP);
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_OPERR);
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_WRPERR);
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGAERR);
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGPERR);
    __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGSERR);
 
    bool state = (EE_Init() == EE_OK);
    Flash_InvalidateDataCache();
    HAL_FLASH_Lock();
    return state;
}
/*
 * Writes a variable to eeprom emulation adr
 * Returns true on success or false if variable is the same or error
 */
bool Flash_Write(uint16_t adr,uint16_t dat){
    //flashMutex.Lock();
    uint16_t buf;
    uint16_t readRes = EE_ReadVariable(adr, &buf);
    bool res = false;
    if(readRes == 1 || (readRes == 0 && buf != dat) ){ // Only write if var updated
        HAL_FLASH_Unlock();
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_EOP);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_OPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_WRPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGAERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGSERR);
        Flash_InvalidateDataCache(); // Invalidate before writing because EE_ReadVariable just cached the flash page
        if(EE_WriteVariable(adr, dat) == HAL_OK){
            res = true;
        }
        Flash_InvalidateDataCache();
        HAL_FLASH_Lock();
 
    }
    //flashMutex.Unlock();
    return res;
 
}
 
 
/*
 * Reads a variable from eeprom emulation and returns true on success
 */
bool Flash_Read(uint16_t adr,uint16_t *buf,bool checkempty){
    //flashMutex.Lock();
    bool res = EE_ReadVariable(adr, buf) == 0;
    //flashMutex.Unlock();
    return res;
}
 
/*
 * Reads a variable or if it does not exist default is written
 */
bool Flash_ReadWriteDefault(uint16_t adr,uint16_t *buf,uint16_t def){
    if(EE_ReadVariable(adr, buf) != 0){
        *buf = def;
        HAL_FLASH_Unlock();
        // Clear all the error flags
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_EOP);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_OPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_WRPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGAERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGPERR);
        __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_PGSERR);
        Flash_InvalidateDataCache(); // Invalidate before writing because EE_ReadVariable just cached the flash page
        EE_WriteVariable(adr, def);
        Flash_InvalidateDataCache();
        HAL_FLASH_Lock();
        return false;
    }
    return true;
}
 
#elif defined(I2C_PORT_EEPROM)
uint8_t i2cBufferEeprom[sizeof(uint16_t)] = {0};
#include "string.h" // Memcpy
#include "cassert"
#include <array>
#include "I2C.h"
I2CDevice i2cdeveeprom;
extern I2CPort i2cport_int;

bool I2C_EEPROM_Write16(uint16_t devAdr,uint16_t adr, uint16_t dat){
    uint16_t dataLength = sizeof(dat);
    memcpy(i2cBufferEeprom,&dat, dataLength);
    uint32_t adrAbs = adr;
    adrAbs *= sizeof(dat)/I2C_EEPROM_DATA_SIZE;
    uint32_t curAdr = adrAbs;
    assert(adrAbs < I2C_EEPROM_SIZE);
 
    // Do segmented writes
 
    bool res = false;
    while(curAdr < adrAbs+dataLength){
//      i2cport_int.isDeviceReady(i2cdeveeprom, I2C_EEPROM_ADR, 100, I2C_EEPROM_TIMEOUT,false)
        while(!i2cport_int.isDeviceReady(&i2cdeveeprom, devAdr, 100, I2C_EEPROM_TIMEOUT,false)){
            vTaskDelay(1);
        }
        uint16_t i2cAdr = devAdr;
        uint16_t writeAdr = curAdr;
        if(curAdr > 0xffff){
            writeAdr = curAdr & 0xffff;
            i2cAdr |= 0x02; // A17 bit
        }
        uint16_t wLen = std::min<uint16_t>(dataLength,I2C_EEPROM_PAGEWRITE_SIZE - (adrAbs % I2C_EEPROM_PAGEWRITE_SIZE));
        res = i2cport_int.writeMem(&i2cdeveeprom, i2cAdr, writeAdr, I2C_EEPROM_ADR_SIZE, i2cBufferEeprom, wLen, I2C_EEPROM_TIMEOUT, false);
        curAdr+=wLen;
        if(!res){
            break;
        }
    }
 
    return res;
}

bool I2C_EEPROM_Read16(uint16_t devAdr,uint16_t adr,uint16_t *buf, bool checkempty){
    uint32_t adrAbs = (adr * sizeof(*buf)/I2C_EEPROM_DATA_SIZE);
    assert(adrAbs < I2C_EEPROM_SIZE);
    while(!i2cport_int.isDeviceReady(&i2cdeveeprom, devAdr, 100, I2C_EEPROM_TIMEOUT,false)){
        vTaskDelay(1);
    }
    uint16_t i2cAdr = devAdr;
    uint16_t datAdr = adrAbs & 0xffff;
    if(adrAbs > 0xffff){
        i2cAdr |= 0x02; // If curAdr > 0xffff set bit 1 of addr high
    }
    bool res = i2cport_int.readMem(&i2cdeveeprom, i2cAdr, datAdr, I2C_EEPROM_ADR_SIZE, i2cBufferEeprom, 2, I2C_EEPROM_TIMEOUT, false);
 
    if(checkempty){
        bool empty = true;
        for(uint8_t i = 0;i<sizeof(i2cBufferEeprom);i++){
            if(i2cBufferEeprom[i] != I2C_EEPROM_ERASED){
                empty = false;
                break;
            }
        }
        res = empty ? false : res;
    }
    if(res) // Only copy if success
        memcpy(buf,i2cBufferEeprom,sizeof(i2cBufferEeprom));
    return res;
}
 
bool Flash_Write(uint16_t adr,uint16_t dat){
    return I2C_EEPROM_Write16(I2C_EEPROM_ADR,adr+I2C_EEPROM_OFS,dat);
}
bool Flash_ReadWriteDefault(uint16_t adr,uint16_t *buf,uint16_t def){
    if(!Flash_Read(adr,buf)){
        return Flash_Write(adr, def);
    }
    return true;
}

bool Flash_Read(uint16_t adr,uint16_t *buf, bool checkempty){
    return I2C_EEPROM_Read16(I2C_EEPROM_ADR,adr+I2C_EEPROM_OFS,buf,checkempty);
}

bool Flash_Format(){
    bool flag = true;
    std::array<uint8_t,I2C_EEPROM_PAGEWRITE_SIZE> eraseBuf;
    eraseBuf.fill(I2C_EEPROM_ERASED);
    for(uint32_t i=I2C_EEPROM_OFS;i<I2C_EEPROM_SIZE;i+=I2C_EEPROM_PAGEWRITE_SIZE){
        uint16_t datAdr = i & 0xffff;
        uint16_t devAdr = I2C_EEPROM_ADR;
        if(i > 0xffff){
            devAdr |= 0x02;
        }
        bool res = i2cport_int.writeMem(&i2cdeveeprom, devAdr, datAdr, I2C_EEPROM_ADR_SIZE,  eraseBuf.data(), std::min<int>(I2C_EEPROM_PAGEWRITE_SIZE,I2C_EEPROM_SIZE-i), I2C_EEPROM_TIMEOUT, false);
        if(!res){
            flag = false;
        }else{
            while(!i2cport_int.isDeviceReady(&i2cdeveeprom, I2C_EEPROM_ADR, 100, I2C_EEPROM_TIMEOUT,false)){
                vTaskDelay(1);
            }
        }
    }
    return flag;
}
bool Flash_Init(){
    return i2cport_int.isDeviceReady(&i2cdeveeprom, I2C_EEPROM_ADR, 50, I2C_EEPROM_TIMEOUT,false);
}
 
#else
// No flash mode defined
 
__weak bool Flash_Write(uint16_t adr,uint16_t dat){
    return true;
}
__weak bool Flash_ReadWriteDefault(uint16_t adr,uint16_t *buf,uint16_t def){
    return true;
}
__weak bool Flash_Read(uint16_t adr,uint16_t *buf){
    return false;
}
__weak bool Flash_Format(){
    return false;
}
__weak bool Flash_Init(){
    return true;
}
#endif
/*
 * Dumps all set variables from flash to a vector
 * does by default not include certain calibration constants that could break something if imported on a different board
 */
void Flash_Dump(std::vector<std::tuple<uint16_t,uint16_t>> *result,bool includeAll){
    uint16_t amount = NB_EXPORTABLE_ADR;
    const uint16_t* list = exportableFlashAddresses;
    if(includeAll){
        amount = NB_OF_VAR;
        list = VirtAddVarTab;
    }
    //extern uint16_t VirtAddVarTab[NB_OF_VAR];
    //std::vector<std::pair<uint16_t,uint16_t>> result;
 
    for(uint32_t i = 0;i<amount ; i++){
        uint16_t v;
        uint16_t adr = list[i];
 
        if(Flash_Read(adr,&v)){
            result->push_back(std::tuple<uint16_t,uint16_t>{adr,v});
        }
 
    }
}
 
 
/*
 * OTP Helper functions.
 * Some chips have internal OTP sections, others may need custom implementations
 * Page size and address required
 */
#if defined(FLASH_OTP_BASE) && defined(FLASH_OTP_END) && defined(OTPMEMORY)
// This chip has an OTP section in main flash.
 
__weak bool OTP_Write(uint16_t adroffset,uint64_t dat){
//  FLASH_OTP_BASE
//  FLASH_OTP_END
    uint32_t adr = (FLASH_OTP_BASE+adroffset*sizeof(uint64_t));
    if(adr > FLASH_OTP_END){
        return false; // Error
    }
    uint64_t curval = *(uint64_t*)adr;
    if(curval != 0xffffffffffffffff){
        return false;
    }
    if(HAL_FLASH_Unlock()!=HAL_OK) return false;
    //bool success = HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, adr, dat) == HAL_OK;
    bool success = HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, adr, (uint32_t)(dat)) == HAL_OK;
    success = HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, adr+4, (uint32_t)(dat >> 32)) == HAL_OK && success;
    HAL_FLASH_Lock();
    return success;
}
 
 
__weak bool OTP_Read(uint16_t adroffset,uint64_t* dat){
    uint32_t adr = (FLASH_OTP_BASE+adroffset*sizeof(uint64_t));
    if(adr > FLASH_OTP_END){
        return false; // Error
    }
    uint64_t curval = *(uint64_t*)adr;
    *dat = curval;
    return true;
}
#elif defined(I2C_EEPROM_OTP_ADR) && defined(I2C_PORT_EEPROM)
// I2C EEPROM OTP/ID memory
__weak bool OTP_Write(uint16_t adroffset,uint64_t dat){
    // Write 4 x 16b
    for(uint8_t i = 0; i < 4; i++){
        bool res = I2C_EEPROM_Write16(I2C_EEPROM_OTP_ADR, 4*adroffset + (i), (dat >> (i*16)) & 0xffff);
        if(!res){
            return false;
        }
    }
 
    return true;
}
 
 
__weak bool OTP_Read(uint16_t adroffset,uint64_t* dat){
    uint64_t val = 0;
    for(uint8_t i = 0; i < 4; i++){
        uint16_t tdat = 0;
        bool res = I2C_EEPROM_Read16(I2C_EEPROM_OTP_ADR, 4*adroffset + (i), &tdat,false);
        val |= (uint64_t)tdat << (i*16);
        if(!res){
            return false;
        }
    }
    *dat = val;
    return true;
}
#else
__weak bool OTP_Write(uint16_t adroffset,uint64_t dat){
    return false;
}
 
 
__weak bool OTP_Read(uint16_t adroffset,uint64_t* dat){
    return false;
}
 
#endif
 
#ifndef FLASH_FACTORY_DEFAULTS_OVERRIDE
const std::array<const std::pair<uint16_t,uint16_t>,0> empty_flash_defaults; // Empty
const std::span<const std::pair<uint16_t,uint16_t>> flash_factory_defaults = empty_flash_defaults;
#endif

void Flash_Write_Defaults(){
    for(const std::pair<uint16_t,uint16_t> &kv : flash_factory_defaults){
        Flash_Write(kv.first, kv.second); // Try to write values
    }
}