flash_helpers.h

Go to the documentation of this file.

/*
 * flash_helpers.h
 *
 *  Created on: 31.01.2020
 *      Author: Yannick
 */
 
#ifndef FLASH_HELPERS_H_
#define FLASH_HELPERS_H_
#include "constants.h"
 
#ifdef __cplusplus
extern "C" {
#endif
#include "main.h"
#ifdef USE_EEPROM_EMULATION
#include "eeprom.h"
#endif
 
#ifdef __cplusplus
}
#endif
 
#include <tuple>
#include <vector>
#include <span>
 
bool Flash_Init();
bool Flash_Write(uint16_t adr,uint16_t dat); // Writes or updates only if changed or missing
bool Flash_Read(uint16_t adr,uint16_t *buf,bool checkempty = true); // returns true if found, false if error
bool Flash_ReadWriteDefault(uint16_t adr,uint16_t *buf,uint16_t def); // returns and writes def if variable is missing
void Flash_Dump(std::vector<std::tuple<uint16_t,uint16_t>> *result,bool includeAll = false);
bool Flash_Format();
 
bool OTP_Write(uint16_t adroffset,uint64_t dat);
bool OTP_Read(uint16_t adroffset,uint64_t* dat);
 
 
template<typename TVal>
inline TVal Flash_ReadDefault(uint16_t adr, TVal def) {
    uint16_t buf;
 
    return Flash_Read(adr, &buf)
            ? TVal(buf)
            : def;
}
 
inline uint16_t pack(uint8_t hb, uint8_t lb) {
    return (hb << 8) | lb;
}
 
inline std::tuple<uint8_t, uint8_t> unpack(uint16_t v) {
    return { v >> 8, v & 0xFF };
}
 
#if defined(I2C_PORT_EEPROM)
// i2c buffer
#define I2C_EEPROM_TIMEOUT 100
 
#endif
 
extern const std::span<const std::pair<uint16_t,uint16_t>> flash_factory_defaults; // address,value pair
void Flash_Write_Defaults();
 
#endif /* FLASH_HELPERS_H_ */