Merge pull request #11526 from hasenbanck/eeprom-cleanup

[2.0.x] Change direct eeprom access to HAL::PersistentStore

Marlin/src/HAL/persistent_store_api.cpp

@@ -0,0 +1,29 @@
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * Based on Sprinter and grbl.
+ * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+#include "../inc/MarlinConfigPre.h"
+
+#if ENABLED(EEPROM_SETTINGS)
+
+  #include "persistent_store_api.h"
+  PersistentStore persistentStore;
+
+#endif

Marlin/src/HAL/persistent_store_api.h

@@ -1,5 +1,25 @@
-#ifndef _PERSISTENT_STORE_H_
+/**
-#define _PERSISTENT_STORE_H_
+ * Marlin 3D Printer Firmware
+ * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * Based on Sprinter and grbl.
+ * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+#pragma once
 
 #include <stddef.h>
 #include <stdint.h>
@@ -16,5 +36,3 @@ public:
 };
 
 extern PersistentStore persistentStore;
-
-#endif // _PERSISTENT_STORE_H_

Marlin/src/feature/bedlevel/ubl/ubl_G29.cpp

@@ -29,6 +29,7 @@
   #include "ubl.h"
 
   #include "../../../Marlin.h"
+  #include "../../../HAL/persistent_store_api.h"
   #include "../../../libs/hex_print_routines.h"
   #include "../../../module/configuration_store.h"
   #include "../../../lcd/ultralcd.h"
@@ -1167,24 +1168,27 @@
    * right now, it is good to have the extra information. Soon... we prune this.
    */
   void unified_bed_leveling::g29_eeprom_dump() {
-    unsigned char cccc;
+    uint8_t cccc;
-    unsigned int  kkkk;  // Needs to be of unspecfied size to compile clean on all platforms
+    int kkkk;
+    uint16_t crc = 0;
 
     SERIAL_ECHO_START();
     SERIAL_ECHOLNPGM("EEPROM Dump:");
+    persistentStore.access_start();
     for (uint16_t i = 0; i < persistentStore.capacity(); i += 16) {
       if (!(i & 0x3)) idle();
       print_hex_word(i);
       SERIAL_ECHOPGM(": ");
       for (uint16_t j = 0; j < 16; j++) {
         kkkk = i + j;
-        eeprom_read_block(&cccc, (const void *)kkkk, sizeof(unsigned char));
+        persistentStore.read_data(kkkk, &cccc, sizeof(uint8_t), &crc);
         print_hex_byte(cccc);
         SERIAL_ECHO(' ');
       }
       SERIAL_EOL();
     }
     SERIAL_EOL();
+    persistentStore.access_finish();
   }
 
   /**

Marlin/src/module/configuration_store.cpp

@@ -345,7 +345,6 @@ void MarlinSettings::postprocess() {
 
 #if ENABLED(EEPROM_SETTINGS)
   #include "../HAL/persistent_store_api.h"
-  PersistentStore persistentStore;
 
   #define DUMMY_PID_VALUE 3000.0f
   #define EEPROM_START() int eeprom_index = EEPROM_OFFSET; persistentStore.access_start()

Marlin/src/module/printcounter.cpp

@@ -31,6 +31,7 @@ Stopwatch print_job_timer;      // Global Print Job Timer instance
 
 #include "printcounter.h"
 #include "../Marlin.h"
+#include "../HAL/persistent_store_api.h"
 
 PrintCounter print_job_timer;   // Global Print Job Timer instance
 
@@ -73,7 +74,12 @@ void PrintCounter::initStats() {
   data = { 0, 0, 0, 0, 0.0 };
 
   saveStats();
-  eeprom_write_byte((uint8_t*)address, 0x16);
+  
+  uint16_t crc = 0;
+  int a = address;
+  persistentStore.access_start();
+  persistentStore.write_data(a, (uint8_t*)0x16, sizeof(uint8_t), &crc);
+  persistentStore.access_finish();
 }
 
 void PrintCounter::loadStats() {
@@ -81,11 +87,18 @@ void PrintCounter::loadStats() {
     debug(PSTR("loadStats"));
   #endif
 
-  // Checks if the EEPROM block is initialized
+  // Check if the EEPROM block is initialized
-  if (eeprom_read_byte((uint8_t*)address) != 0x16) initStats();
+  uint16_t crc = 0;
-  else eeprom_read_block(&data,
+  int a = address;
-    (void*)(address + sizeof(uint8_t)), sizeof(printStatistics));
+  uint8_t value;
-
+  persistentStore.access_start();
+  persistentStore.read_data(a, &value, sizeof(uint8_t), &crc);
+  if (value != 0x16) initStats();
+  else {
+    a = address + sizeof(uint8_t);
+    persistentStore.read_data(a, (uint8_t*)&data, sizeof(printStatistics), &crc);
+  }
+  persistentStore.access_finish();
   loaded = true;
 }
 
@@ -98,8 +111,11 @@ void PrintCounter::saveStats() {
   if (!isLoaded()) return;
 
   // Saves the struct to EEPROM
-  eeprom_update_block(&data,
+  uint16_t crc = 0;
-    (void*)(address + sizeof(uint8_t)), sizeof(printStatistics));
+  int a = (address + sizeof(uint8_t));
+  persistentStore.access_start();
+  persistentStore.write_data(a, (uint8_t*)&data, sizeof(printStatistics), &crc);
+  persistentStore.access_finish();
 }
 
 void PrintCounter::showStats() {