EepromAbstraction.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef _IOABSTRACTION_EEPROMABSTRACTION_H_
#define _IOABSTRACTION_EEPROMABSTRACTION_H_
 
#include "PlatformDetermination.h"
 
#ifdef IOA_USE_MBED
#include <mbed.h>
#elif !defined(BUILD_FOR_PICO_CMAKE)
#include <Arduino.h>
#endif
 
typedef uint16_t EepromPosition;
 
class EepromAbstraction {
public:
    virtual ~EepromAbstraction() {}
 
    virtual bool hasErrorOccurred() { return false;}
 
    virtual uint8_t read8(EepromPosition position) = 0;
 
    virtual void write8(EepromPosition position, uint8_t val) = 0;
 
    virtual uint16_t read16(EepromPosition position) = 0;
 
    virtual void write16(EepromPosition position, uint16_t val) = 0;
 
    virtual uint32_t read32(EepromPosition position) = 0;
 
    virtual void write32(EepromPosition position, uint32_t val) = 0;
 
    virtual void readIntoMemArray(uint8_t* memDest, EepromPosition romSrc, uint8_t len) = 0;
 
    virtual void writeArrayToRom(EepromPosition romDest, const uint8_t* memSrc, uint8_t len) = 0;
};
 
// only include the atmel AVR support if it's available on this platform.
#ifdef __AVR__
 
class AvrEeprom : public EepromAbstraction {
public:
    virtual ~AvrEeprom() {}
 
    virtual uint8_t read8(EepromPosition position);
    virtual void write8(EepromPosition position, uint8_t val);
 
    virtual uint16_t read16(EepromPosition position);
    virtual void write16(EepromPosition position, uint16_t val);
 
    virtual uint32_t read32(EepromPosition position);
    virtual void write32(EepromPosition position, uint32_t val);
 
    virtual void readIntoMemArray(uint8_t* memDest, EepromPosition romSrc, uint8_t len);
    virtual void writeArrayToRom(EepromPosition romDest, const uint8_t* memSrc, uint8_t len);
};
 
#endif
 
class NoEeprom : public EepromAbstraction {
public:
    virtual ~NoEeprom() {}
 
    virtual uint8_t read8(__attribute__((unused)) EepromPosition position) {return 0;}
    virtual void write8(__attribute__((unused)) EepromPosition position, __attribute__((unused)) uint8_t val) {}
 
    virtual uint16_t read16(__attribute__((unused)) EepromPosition position) {return 0;}
    virtual void write16(__attribute__((unused)) EepromPosition position, __attribute__((unused)) uint16_t val) {}
 
    virtual uint32_t read32(__attribute__((unused)) EepromPosition position) {return 0;}
    virtual void write32(__attribute__((unused)) EepromPosition position, __attribute__((unused)) uint32_t val) {}
 
    virtual void readIntoMemArray(__attribute__((unused)) uint8_t* memDest, __attribute__((unused)) EepromPosition romSrc, __attribute__((unused)) uint8_t len) {memDest[0]=0;}
    virtual void writeArrayToRom(__attribute__((unused)) EepromPosition romDest, __attribute__((unused)) const uint8_t* memSrc, __attribute__((unused)) uint8_t len) {}
};
 
#endif /* _IOABSTRACTION_EEPROMABSTRACTION_H_ */