Browse Source

SPIFFS-backed PersistentStore for ESP32 (#13566)

Kajetan Rzepecki 6 years ago
parent
commit
b21ca53dfc

+ 6
- 0
Marlin/src/HAL/HAL_ESP32/HAL.cpp View File

@@ -41,7 +41,10 @@
41 41
   #endif
42 42
   #if ENABLED(WEBSUPPORT)
43 43
     #include "web.h"
44
+    #include "spiffs.h"
44 45
   #endif
46
+#elif ENABLED(EEPROM_SETTINGS)
47
+  #include "spiffs.h"
45 48
 #endif
46 49
 
47 50
 // --------------------------------------------------------------------------
@@ -95,9 +98,12 @@ void HAL_init(void) {
95 98
       OTA_init();
96 99
     #endif
97 100
     #if ENABLED(WEBSUPPORT)
101
+      spiffs_init();
98 102
       web_init();
99 103
     #endif
100 104
     server.begin();
105
+  #elif ENABLED(EEPROM_SETTINGS)
106
+    spiffs_init();
101 107
   #endif
102 108
 
103 109
   i2s_init();

+ 93
- 0
Marlin/src/HAL/HAL_ESP32/persistent_store_spiffs.cpp View File

@@ -0,0 +1,93 @@
1
+/**
2
+ * Marlin 3D Printer Firmware
3
+ * Copyright (C) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
4
+ *
5
+ * Based on Sprinter and grbl.
6
+ * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
7
+ *
8
+ * This program is free software: you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation, either version 3 of the License, or
11
+ * (at your option) any later version.
12
+ *
13
+ * This program is distributed in the hope that it will be useful,
14
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
+ * GNU General Public License for more details.
17
+ *
18
+ * You should have received a copy of the GNU General Public License
19
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
+ *
21
+ */
22
+
23
+#ifdef ARDUINO_ARCH_ESP32
24
+
25
+#include "../../inc/MarlinConfig.h"
26
+
27
+#if ENABLED(EEPROM_SETTINGS) && DISABLED(FLASH_EEPROM_EMULATION)
28
+
29
+#include "../shared/persistent_store_api.h"
30
+
31
+#include "SPIFFS.h"
32
+#include "FS.h"
33
+#include "spiffs.h"
34
+
35
+#define HAL_ESP32_EEPROM_SIZE 4096
36
+
37
+File eeprom_file;
38
+
39
+bool PersistentStore::access_start() {
40
+  if (spiffs_initialized) {
41
+    eeprom_file = SPIFFS.open("/eeprom.dat", "r+");
42
+
43
+    size_t file_size = eeprom_file.size();
44
+    if (file_size < HAL_ESP32_EEPROM_SIZE) {
45
+      bool write_ok = eeprom_file.seek(file_size);
46
+
47
+      while (write_ok && file_size < HAL_ESP32_EEPROM_SIZE) {
48
+        write_ok = eeprom_file.write(0xFF) == 1;
49
+        file_size++;
50
+      }
51
+    }
52
+    return true;
53
+  }
54
+  return false;
55
+}
56
+
57
+bool PersistentStore::access_finish() {
58
+  eeprom_file.close();
59
+  return true;
60
+}
61
+
62
+bool PersistentStore::write_data(int &pos, const uint8_t *value, size_t size, uint16_t *crc) {
63
+  if (!eeprom_file.seek(pos)) return true; // return true for any error
64
+  if (eeprom_file.write(value, size) != size) return true;
65
+
66
+  crc16(crc, value, size);
67
+  pos += size;
68
+
69
+  return false;
70
+}
71
+
72
+bool PersistentStore::read_data(int &pos, uint8_t* value, size_t size, uint16_t *crc, const bool writing/*=true*/) {
73
+  if (!eeprom_file.seek(pos)) return true; // return true for any error
74
+
75
+  if (writing) {
76
+    if (eeprom_file.read(value, size) != size) return true;
77
+    crc16(crc, value, size);
78
+  }
79
+  else {
80
+    uint8_t tmp[size];
81
+    if (eeprom_file.read(tmp, size) != size) return true;
82
+    crc16(crc, tmp, size);
83
+  }
84
+
85
+  pos += size;
86
+
87
+  return false;
88
+}
89
+
90
+size_t PersistentStore::capacity() { return HAL_ESP32_EEPROM_SIZE; }
91
+
92
+#endif // EEPROM_SETTINGS
93
+#endif // ARDUINO_ARCH_ESP32

+ 44
- 0
Marlin/src/HAL/HAL_ESP32/spiffs.cpp View File

@@ -0,0 +1,44 @@
1
+/**
2
+ * Marlin 3D Printer Firmware
3
+ * Copyright (C) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
4
+ *
5
+ * Based on Sprinter and grbl.
6
+ * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
7
+ *
8
+ * This program is free software: you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation, either version 3 of the License, or
11
+ * (at your option) any later version.
12
+ *
13
+ * This program is distributed in the hope that it will be useful,
14
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
+ * GNU General Public License for more details.
17
+ *
18
+ * You should have received a copy of the GNU General Public License
19
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
+ *
21
+ */
22
+
23
+#ifdef ARDUINO_ARCH_ESP32
24
+
25
+#include "../../inc/MarlinConfigPre.h"
26
+
27
+#if EITHER(WEBSUPPORT, EEPROM_SETTINGS)
28
+
29
+#include "../../core/serial.h"
30
+
31
+#include "FS.h"
32
+#include "SPIFFS.h"
33
+
34
+bool spiffs_initialized;
35
+
36
+void spiffs_init() {
37
+  if (SPIFFS.begin())
38
+    spiffs_initialized = true;
39
+  else
40
+    SERIAL_ECHO_MSG("SPIFFS mount failed");
41
+}
42
+
43
+#endif // WEBSUPPORT
44
+#endif // ARDUINO_ARCH_ESP32

+ 26
- 0
Marlin/src/HAL/HAL_ESP32/spiffs.h View File

@@ -0,0 +1,26 @@
1
+/**
2
+ * Marlin 3D Printer Firmware
3
+ * Copyright (C) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
4
+ *
5
+ * Based on Sprinter and grbl.
6
+ * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
7
+ *
8
+ * This program is free software: you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation, either version 3 of the License, or
11
+ * (at your option) any later version.
12
+ *
13
+ * This program is distributed in the hope that it will be useful,
14
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
+ * GNU General Public License for more details.
17
+ *
18
+ * You should have received a copy of the GNU General Public License
19
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
+ *
21
+ */
22
+#pragma once
23
+
24
+extern bool spiffs_initialized;
25
+
26
+void spiffs_init();

+ 2
- 9
Marlin/src/HAL/HAL_ESP32/web.cpp View File

@@ -23,9 +23,6 @@
23 23
 
24 24
 #if ENABLED(WEBSUPPORT)
25 25
 
26
-#include "../../core/serial.h"
27
-
28
-#include "FS.h"
29 26
 #include "SPIFFS.h"
30 27
 #include "wifi.h"
31 28
 
@@ -37,12 +34,8 @@ void onNotFound(AsyncWebServerRequest *request){
37 34
 
38 35
 void web_init() {
39 36
   server.addHandler(&events);       // attach AsyncEventSource
40
-  if (SPIFFS.begin()) {
41
-    server.serveStatic("/", SPIFFS, "/www").setDefaultFile("index.html");
42
-    server.onNotFound(onNotFound);
43
-  }
44
-  else
45
-    SERIAL_ECHO_MSG("SPIFFS Mount Failed");
37
+  server.serveStatic("/", SPIFFS, "/www").setDefaultFile("index.html");
38
+  server.onNotFound(onNotFound);
46 39
 }
47 40
 
48 41
 #endif // WEBSUPPORT

Loading…
Cancel
Save