Use buffered access to the EEPROM data on the flash

Author: sakinit

libraries/EEPROM/examples/eeprom_clear/eeprom_clear.ino

@@ -13,6 +13,8 @@
 void setup() {
   // initialize the LED pin as an output.
   pinMode(13, OUTPUT);
+
+  EEPROM.begin();
 
   /***
     Iterate through each byte of the EEPROM storage.
@@ -30,6 +32,8 @@ void setup() {
     EEPROM.write(i, 0);
   }
 
+  EEPROM.end();
+
   // turn the LED on when we're done
   digitalWrite(13, HIGH);
 }

libraries/EEPROM/examples/eeprom_crc/eeprom_crc.ino

@@ -17,6 +17,7 @@ void setup() {
   while (!Serial) {
     ; // wait for serial port to connect. Needed for native USB port only
   }
+  EEPROM.begin();
 
   //Print length of data to run CRC on.
   Serial.print("EEPROM length: ");
@@ -25,6 +26,8 @@ void setup() {
   //Print the result of calling eeprom_crc()
   Serial.print("CRC32 of EEPROM data: 0x");
   Serial.println(eeprom_crc(), HEX);
+
+  EEPROM.end();
   Serial.print("\n\nDone!");
 }
 

libraries/EEPROM/examples/eeprom_get/eeprom_get.ino

@@ -26,6 +26,8 @@ void setup() {
   while (!Serial) {
     ; // wait for serial port to connect. Needed for native USB port only
   }
+  EEPROM.begin();
+
   Serial.print("Read float from EEPROM: ");
 
   //Get the float data from the EEPROM at position 'eeAddress'
@@ -43,6 +45,9 @@ void setup() {
   ***/
 
   secondTest(); //Run the next test.
+
+  EEPROM.end();
+  Serial.print("\n\nDone!");
 }
 
 struct MyObject {

libraries/EEPROM/examples/eeprom_iteration/eeprom_iteration.ino

@@ -15,6 +15,8 @@
 
 void setup() {
 
+  EEPROM.begin();
+
   /***
     Iterate the EEPROM using a for loop.
   ***/
@@ -51,7 +53,8 @@ void setup() {
     idx++;
   } while (idx < EEPROM.length());
 
+  EEPROM.end();
 
 } //End of setup function.
 
-void loop() {}
+void loop() {}

libraries/EEPROM/examples/eeprom_put/eeprom_put.ino

@@ -28,6 +28,7 @@ void setup() {
   while (!Serial) {
     ; // wait for serial port to connect. Needed for native USB port only
   }
+  EEPROM.begin();
 
   float f = 123.456f;  //Variable to store in EEPROM.
   int eeAddress = 0;   //Location we want the data to be put.
@@ -51,6 +52,9 @@ void setup() {
 
   EEPROM.put(eeAddress, customVar);
   Serial.print("Written custom data type! \n\nView the example sketch eeprom_get to see how you can retrieve the values!");
+
+  EEPROM.end();
+  Serial.print("\n\nDone!");
 }
 
 void loop() {

libraries/EEPROM/examples/eeprom_read/eeprom_read.ino

@@ -18,6 +18,7 @@ void setup() {
   while (!Serial) {
     ; // wait for serial port to connect. Needed for native USB port only
   }
+  EEPROM.begin();
 }
 
 void loop() {

libraries/EEPROM/examples/eeprom_update/eeprom_update.ino

@@ -17,7 +17,11 @@
 int address = 0;
 
 void setup() {
-  /** EMpty setup **/
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+  EEPROM.begin();
 }
 
 void loop() {
@@ -58,6 +62,11 @@ void loop() {
   address = address + 1;
   if (address == EEPROM.length()) {
     address = 0;
+    if (EEPROM.commit()) {
+      Serial.println("EEPROM successfully committed");
+    } else {
+      Serial.println("ERROR! EEPROM commit failed");
+    }
   }
 
   /***

libraries/EEPROM/examples/eeprom_write/eeprom_write.ino

@@ -12,7 +12,11 @@
 int addr = 0;
 
 void setup() {
-  /** Empty setup. **/
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+  EEPROM.begin();
 }
 
 void loop() {
@@ -46,6 +50,11 @@ void loop() {
   addr = addr + 1;
   if (addr == EEPROM.length()) {
     addr = 0;
+    if (EEPROM.commit()) {
+      Serial.println("EEPROM successfully committed");
+    } else {
+      Serial.println("ERROR! EEPROM commit failed");
+    }
   }
 
   /***

libraries/EEPROM/src/EEPROM.cpp

@@ -0,0 +1,29 @@
+/*
+  EEPROM.cpp - EEPROM library
+  Original Copyright (c) 2006 David A. Mellis.  All right reserved.
+  New version by Christopher Andrews 2015.
+
+  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
+*/
+
+#include "EEPROM.h"
+
+EEPROMClass EEPROM;
+
+EERef& EERef::operator=(uint8_t in)
+{
+  if (in != *this) EEPROM.dirty = true;
+  return eeprom_buffered_write_byte(/*(uint8_t*)*/ index, in), *this;
+}

libraries/EEPROM/src/EEPROM.h

@@ -39,7 +39,7 @@ struct EERef {
   //Access/read members.
   uint8_t operator*() const
   {
-    return eeprom_read_byte(/*(uint8_t*)*/ index);
+    return eeprom_buffered_read_byte(/*(uint8_t*)*/ index);
   }
   operator uint8_t() const
   {
@@ -51,10 +51,8 @@ struct EERef {
   {
     return *this = *ref;
   }
-  EERef &operator=(uint8_t in)
-  {
-    return eeprom_write_byte(/*(uint8_t*)*/ index, in), *this;
-  }
+  EERef &operator=(uint8_t in);
+
   EERef &operator +=(uint8_t in)
   {
     return *this = **this + in;
@@ -190,6 +188,8 @@ struct EEPtr {
 
 struct EEPROMClass {
 
+  EEPROMClass() : dirty(false) {}
+
   //Basic user access methods.
   EERef operator[](const int idx)
   {
@@ -211,12 +211,23 @@ struct EEPROMClass {
   //STL and C++11 iteration capability.
   EEPtr begin()
   {
+    eeprom_buffer_fill();
+    dirty = false;
     return 0x00;
   }
   EEPtr end()
   {
+    commit();
     return length();  //Standards requires this to be the item after the last valid entry. The returned pointer is invalid.
   }
+  bool commit()
+  {
+    if (dirty) {
+      eeprom_buffer_flush();
+      dirty = false;
+    }
+    return true;
+  }
   uint16_t length()
   {
     return E2END + 1;
@@ -242,7 +253,10 @@ struct EEPROMClass {
     }
     return t;
   }
+
+  bool dirty;
 };
 
-static EEPROMClass EEPROM;
+extern EEPROMClass EEPROM;
+
 #endif