1
0
mirror of https://github.com/bdring/Grbl_Esp32.git synced 2025-08-30 01:30:05 +02:00
Files
Grbl_Esp32/libraries/EpoxyEepromEsp/EEPROM.h
2021-07-10 23:16:38 -10:00

115 lines
3.2 KiB
C++

/*
Copyright (c) 2021 Brian T. Park.
API derived from:
EEPROM.cpp - esp8266 EEPROM emulation
Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
This file is part of the esp8266 core for Arduino environment.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef EPOXY_EEPROM_ESP_H
#define EPOXY_EEPROM_ESP_H
#include <stdint.h>
#include <string.h> // memcpy()
/** Use this macro to distinguish between EpoxyEepromEsp or EpoxyEepromAvr. */
#define EPOXY_DUINO_EPOXY_EEPROM_ESP 1
/**
* A EEPROM library that works on POSIX-like systems using EpoxyDuino. This
* version implements the EEPROM API found on ESP8266 and ESP32 Arduino Cores.
*/
class EpoxyEepromEsp {
public:
EpoxyEepromEsp() = default;
void begin(size_t size);
uint8_t read(int address) {
return data_[address];
}
void write(int address, uint8_t val) {
uint8_t prev = data_[address];
if (val != prev) {
data_[address] = val;
dirty_ = true;
}
}
bool commit();
void end() {
commit();
if (data_) {
delete[] data_;
data_ = nullptr;
}
size_ = 0;
dirty_ = false;
}
size_t length() { return size_; }
uint8_t& operator[](int address) { return data_[address]; }
uint8_t const & operator[](int address) const { return data_[address]; }
/**
* Unlike the version on ESP8266 or ESP32, this implementation does not
* perform bounds checking. It didn't seem to make sense since operator[]
* does not do bounds checking either, and it seems better to catch out of
* bounds problem on desktop systems with a Segmentation Fault.
*/
template<typename T>
T &get(int address, T &t) {
memcpy((uint8_t*) &t, data_ + address, sizeof(T));
return t;
}
/**
* Unlike the version on ESP8266 or ESP32, this implementation does not
* perform bounds checking. It didn't seem to make sense since operator[]
* does not do bounds checking either, and it seems better to catch out of
* bounds problem on desktop systems with a Segmentation Fault.
*/
template<typename T>
const T &put(int address, const T &t) {
if (memcmp(data_ + address, (const uint8_t*)&t, sizeof(T)) != 0) {
dirty_ = true;
memcpy(data_ + address, (const uint8_t*)&t, sizeof(T));
}
return t;
}
private:
static const char* getDataPath();
uint8_t* data_ = nullptr;
size_t size_ = 0;
bool dirty_ = false;
};
#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_EEPROM)
extern EpoxyEepromEsp EpoxyEepromEspInstance;
#endif
#endif