|
@@ -0,0 +1,265 @@
|
|
1
|
+/**
|
|
2
|
+ * Marlin 3D Printer Firmware
|
|
3
|
+ *
|
|
4
|
+ * Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
5
|
+ * Copyright (c) 2016 Bob Cousins bobcousins42@googlemail.com
|
|
6
|
+ * Copyright (c) 2015-2016 Nico Tonnhofer wurstnase.reprap@gmail.com
|
|
7
|
+ * Copyright (c) 2016 Victor Perez victor_pv@hotmail.com
|
|
8
|
+ *
|
|
9
|
+ * This program is free software: you can redistribute it and/or modify
|
|
10
|
+ * it under the terms of the GNU General Public License as published by
|
|
11
|
+ * the Free Software Foundation, either version 3 of the License, or
|
|
12
|
+ * (at your option) any later version.
|
|
13
|
+ *
|
|
14
|
+ * This program is distributed in the hope that it will be useful,
|
|
15
|
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
16
|
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
17
|
+ * GNU General Public License for more details.
|
|
18
|
+ *
|
|
19
|
+ * You should have received a copy of the GNU General Public License
|
|
20
|
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
21
|
+ *
|
|
22
|
+ */
|
|
23
|
+
|
|
24
|
+#if defined(ARDUINO_ARCH_STM32) && !defined(STM32GENERIC)
|
|
25
|
+
|
|
26
|
+#include "../../inc/MarlinConfig.h"
|
|
27
|
+
|
|
28
|
+#if BOTH(EEPROM_SETTINGS, FLASH_EEPROM_EMULATION)
|
|
29
|
+
|
|
30
|
+#include "../shared/persistent_store_api.h"
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+// Only STM32F4 can support wear leveling at this time
|
|
34
|
+#ifndef STM32F4xx
|
|
35
|
+ #undef FLASH_EEPROM_LEVELING
|
|
36
|
+#endif
|
|
37
|
+
|
|
38
|
+/**
|
|
39
|
+ * The STM32 HAL supports chips that deal with "pages" and some with "sectors" and some that
|
|
40
|
+ * even have multiple "banks" of flash.
|
|
41
|
+ *
|
|
42
|
+ * This code is a bit of a mashup of
|
|
43
|
+ * framework-arduinoststm32/cores/arduino/stm32/stm32_eeprom.c
|
|
44
|
+ * hal/hal_lpc1768/persistent_store_flash.cpp
|
|
45
|
+ *
|
|
46
|
+ * This has only be written against those that use a single "sector" design.
|
|
47
|
+ *
|
|
48
|
+ * Those that deal with "pages" could be made to work. Looking at the STM32F07 for example, there are
|
|
49
|
+ * 128 "pages", each 2kB in size. If we continued with our EEPROM being 4Kb, we'd always need to operate
|
|
50
|
+ * on 2 of these pages. Each write, we'd use 2 different pages from a pool of pages until we are done.
|
|
51
|
+ */
|
|
52
|
+
|
|
53
|
+#if ENABLED(FLASH_EEPROM_LEVELING)
|
|
54
|
+
|
|
55
|
+ #include "stm32_def.h"
|
|
56
|
+
|
|
57
|
+ #define DEBUG_OUT ENABLED(EEPROM_CHITCHAT)
|
|
58
|
+ #include "src/core/debug_out.h"
|
|
59
|
+
|
|
60
|
+ #ifndef EEPROM_SIZE
|
|
61
|
+ #define EEPROM_SIZE 0x1000 // 4kB
|
|
62
|
+ #endif
|
|
63
|
+
|
|
64
|
+ #ifndef FLASH_SECTOR
|
|
65
|
+ #define FLASH_SECTOR (FLASH_SECTOR_TOTAL - 1)
|
|
66
|
+ #endif
|
|
67
|
+ #ifndef FLASH_UNIT_SIZE
|
|
68
|
+ #define FLASH_UNIT_SIZE 0x20000 // 128kB
|
|
69
|
+ #endif
|
|
70
|
+
|
|
71
|
+ #define FLASH_ADDRESS_START (FLASH_END - ((FLASH_SECTOR_TOTAL - FLASH_SECTOR) * FLASH_UNIT_SIZE) + 1)
|
|
72
|
+ #define FLASH_ADDRESS_END (FLASH_ADDRESS_START + FLASH_UNIT_SIZE - 1)
|
|
73
|
+
|
|
74
|
+ #define EEPROM_SLOTS (FLASH_UNIT_SIZE/EEPROM_SIZE)
|
|
75
|
+ #define SLOT_ADDRESS(slot) (FLASH_ADDRESS_START + (slot * EEPROM_SIZE))
|
|
76
|
+
|
|
77
|
+ #define UNLOCK_FLASH() if (!flash_unlocked) { \
|
|
78
|
+ HAL_FLASH_Unlock(); \
|
|
79
|
+ __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_EOP | FLASH_FLAG_OPERR | FLASH_FLAG_WRPERR | \
|
|
80
|
+ FLASH_FLAG_PGAERR | FLASH_FLAG_PGPERR | FLASH_FLAG_PGSERR); \
|
|
81
|
+ flash_unlocked = true; \
|
|
82
|
+ }
|
|
83
|
+ #define LOCK_FLASH() if (flash_unlocked) { HAL_FLASH_Lock(); flash_unlocked = false; }
|
|
84
|
+
|
|
85
|
+ #define EMPTY_UINT32 ((uint32_t)-1)
|
|
86
|
+ #define EMPTY_UINT8 ((uint8_t)-1)
|
|
87
|
+
|
|
88
|
+ static uint8_t ram_eeprom[EEPROM_SIZE] __attribute__((aligned(4))) = {0};
|
|
89
|
+ static int current_slot = -1;
|
|
90
|
+
|
|
91
|
+ static_assert(0 == EEPROM_SIZE % 4, "EEPROM_SIZE must be a multiple of 4"); // Ensure copying as uint32_t is safe
|
|
92
|
+ static_assert(0 == FLASH_UNIT_SIZE % EEPROM_SIZE, "EEPROM_SIZE must divide evenly into your FLASH_UNIT_SIZE");
|
|
93
|
+ static_assert(FLASH_UNIT_SIZE >= EEPROM_SIZE, "FLASH_UNIT_SIZE must be greater than or equal to your EEPROM_SIZE");
|
|
94
|
+ static_assert(IS_FLASH_SECTOR(FLASH_SECTOR), "FLASH_SECTOR is invalid");
|
|
95
|
+ static_assert(IS_POWER_OF_2(FLASH_UNIT_SIZE), "FLASH_UNIT_SIZE should be a power of 2, please check your chip's spec sheet");
|
|
96
|
+
|
|
97
|
+#endif
|
|
98
|
+
|
|
99
|
+static bool eeprom_data_written = false;
|
|
100
|
+
|
|
101
|
+bool PersistentStore::access_start() {
|
|
102
|
+
|
|
103
|
+ #if ENABLED(FLASH_EEPROM_LEVELING)
|
|
104
|
+
|
|
105
|
+ if (current_slot == -1 || eeprom_data_written) {
|
|
106
|
+ // This must be the first time since power on that we have accessed the storage, or someone
|
|
107
|
+ // loaded and called write_data and never called access_finish.
|
|
108
|
+ // Lets go looking for the slot that holds our configuration.
|
|
109
|
+ if (eeprom_data_written) DEBUG_ECHOLN("Dangling EEPROM write_data");
|
|
110
|
+ uint32_t address = FLASH_ADDRESS_START;
|
|
111
|
+ while (address <= FLASH_ADDRESS_END) {
|
|
112
|
+ uint32_t address_value = (*(__IO uint32_t*)address);
|
|
113
|
+ if (address_value != EMPTY_UINT32) {
|
|
114
|
+ current_slot = (address - FLASH_ADDRESS_START) / EEPROM_SIZE;
|
|
115
|
+ break;
|
|
116
|
+ }
|
|
117
|
+ address += sizeof(uint32_t);
|
|
118
|
+ }
|
|
119
|
+ if (current_slot == -1) {
|
|
120
|
+ // We didn't find anything, so we'll just intialize to empty
|
|
121
|
+ for (int i = 0; i < EEPROM_SIZE; i++) ram_eeprom[i] = EMPTY_UINT8;
|
|
122
|
+ current_slot = EEPROM_SLOTS;
|
|
123
|
+ }
|
|
124
|
+ else {
|
|
125
|
+ // load current settings
|
|
126
|
+ uint8_t *eeprom_data = (uint8_t *)SLOT_ADDRESS(current_slot);
|
|
127
|
+ for (int i = 0; i < EEPROM_SIZE; i++) ram_eeprom[i] = eeprom_data[i];
|
|
128
|
+ DEBUG_ECHOLNPAIR("EEPROM loaded from slot ", current_slot, ".");
|
|
129
|
+ }
|
|
130
|
+ eeprom_data_written = false;
|
|
131
|
+ }
|
|
132
|
+
|
|
133
|
+ #else
|
|
134
|
+ eeprom_buffer_fill();
|
|
135
|
+ #endif
|
|
136
|
+
|
|
137
|
+ return true;
|
|
138
|
+}
|
|
139
|
+
|
|
140
|
+bool PersistentStore::access_finish() {
|
|
141
|
+
|
|
142
|
+ if (eeprom_data_written) {
|
|
143
|
+
|
|
144
|
+ #if ENABLED(FLASH_EEPROM_LEVELING)
|
|
145
|
+
|
|
146
|
+ HAL_StatusTypeDef status = HAL_ERROR;
|
|
147
|
+ bool flash_unlocked = false;
|
|
148
|
+
|
|
149
|
+ if (--current_slot < 0) {
|
|
150
|
+ // all slots have been used, erase everything and start again
|
|
151
|
+
|
|
152
|
+ FLASH_EraseInitTypeDef EraseInitStruct;
|
|
153
|
+ uint32_t SectorError = 0;
|
|
154
|
+
|
|
155
|
+ EraseInitStruct.TypeErase = FLASH_TYPEERASE_SECTORS;
|
|
156
|
+ EraseInitStruct.VoltageRange = FLASH_VOLTAGE_RANGE_3;
|
|
157
|
+ EraseInitStruct.Sector = FLASH_SECTOR;
|
|
158
|
+ EraseInitStruct.NbSectors = 1;
|
|
159
|
+
|
|
160
|
+ current_slot = EEPROM_SLOTS - 1;
|
|
161
|
+ UNLOCK_FLASH();
|
|
162
|
+
|
|
163
|
+ status = HAL_FLASHEx_Erase(&EraseInitStruct, &SectorError);
|
|
164
|
+ if (status != HAL_OK) {
|
|
165
|
+ DEBUG_ECHOLNPAIR("HAL_FLASHEx_Erase=", status);
|
|
166
|
+ DEBUG_ECHOLNPAIR("GetError=", HAL_FLASH_GetError());
|
|
167
|
+ DEBUG_ECHOLNPAIR("SectorError=", SectorError);
|
|
168
|
+ LOCK_FLASH();
|
|
169
|
+ return false;
|
|
170
|
+ }
|
|
171
|
+ }
|
|
172
|
+
|
|
173
|
+ UNLOCK_FLASH();
|
|
174
|
+
|
|
175
|
+ uint32_t offset = 0;
|
|
176
|
+ uint32_t address = SLOT_ADDRESS(current_slot);
|
|
177
|
+ uint32_t address_end = address + EEPROM_SIZE;
|
|
178
|
+ uint32_t data = 0;
|
|
179
|
+
|
|
180
|
+ bool success = true;
|
|
181
|
+
|
|
182
|
+ while (address < address_end) {
|
|
183
|
+ memcpy(&data, ram_eeprom + offset, sizeof(uint32_t));
|
|
184
|
+ status = HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, address, data);
|
|
185
|
+ if (status == HAL_OK) {
|
|
186
|
+ address += sizeof(uint32_t);
|
|
187
|
+ offset += sizeof(uint32_t);
|
|
188
|
+ }
|
|
189
|
+ else {
|
|
190
|
+ DEBUG_ECHOLNPAIR("HAL_FLASH_Program=", status);
|
|
191
|
+ DEBUG_ECHOLNPAIR("GetError=", HAL_FLASH_GetError());
|
|
192
|
+ DEBUG_ECHOLNPAIR("address=", address);
|
|
193
|
+ success = false;
|
|
194
|
+ break;
|
|
195
|
+ }
|
|
196
|
+ }
|
|
197
|
+
|
|
198
|
+ LOCK_FLASH();
|
|
199
|
+
|
|
200
|
+ if (success) {
|
|
201
|
+ eeprom_data_written = false;
|
|
202
|
+ DEBUG_ECHOLNPAIR("EEPROM saved to slot ", current_slot, ".");
|
|
203
|
+ }
|
|
204
|
+
|
|
205
|
+ return success;
|
|
206
|
+
|
|
207
|
+ #else
|
|
208
|
+ eeprom_buffer_flush();
|
|
209
|
+ eeprom_data_written = false;
|
|
210
|
+ #endif
|
|
211
|
+ }
|
|
212
|
+
|
|
213
|
+ return true;
|
|
214
|
+}
|
|
215
|
+
|
|
216
|
+bool PersistentStore::write_data(int &pos, const uint8_t *value, size_t size, uint16_t *crc) {
|
|
217
|
+ while (size--) {
|
|
218
|
+ uint8_t v = *value;
|
|
219
|
+ #if ENABLED(FLASH_EEPROM_LEVELING)
|
|
220
|
+ if (v != ram_eeprom[pos]) {
|
|
221
|
+ ram_eeprom[pos] = v;
|
|
222
|
+ eeprom_data_written = true;
|
|
223
|
+ }
|
|
224
|
+ #else
|
|
225
|
+ if (v != eeprom_buffered_read_byte(pos)) {
|
|
226
|
+ eeprom_buffered_write_byte(pos, v);
|
|
227
|
+ eeprom_data_written = true;
|
|
228
|
+ }
|
|
229
|
+ #endif
|
|
230
|
+ crc16(crc, &v, 1);
|
|
231
|
+ pos++;
|
|
232
|
+ value++;
|
|
233
|
+ }
|
|
234
|
+ return false;
|
|
235
|
+}
|
|
236
|
+
|
|
237
|
+bool PersistentStore::read_data(int &pos, uint8_t* value, size_t size, uint16_t *crc, const bool writing/*=true*/) {
|
|
238
|
+ do {
|
|
239
|
+ const uint8_t c = (
|
|
240
|
+ #if ENABLED(FLASH_EEPROM_LEVELING)
|
|
241
|
+ ram_eeprom[pos]
|
|
242
|
+ #else
|
|
243
|
+ eeprom_buffered_read_byte(pos)
|
|
244
|
+ #endif
|
|
245
|
+ );
|
|
246
|
+ if (writing) *value = c;
|
|
247
|
+ crc16(crc, &c, 1);
|
|
248
|
+ pos++;
|
|
249
|
+ value++;
|
|
250
|
+ } while (--size);
|
|
251
|
+ return false;
|
|
252
|
+}
|
|
253
|
+
|
|
254
|
+size_t PersistentStore::capacity() {
|
|
255
|
+ return (
|
|
256
|
+ #if ENABLED(FLASH_EEPROM_LEVELING)
|
|
257
|
+ EEPROM_SIZE
|
|
258
|
+ #else
|
|
259
|
+ E2END + 1
|
|
260
|
+ #endif
|
|
261
|
+ );
|
|
262
|
+}
|
|
263
|
+
|
|
264
|
+#endif // EEPROM_SETTINGS && FLASH_EEPROM_EMULATION
|
|
265
|
+#endif // ARDUINO_ARCH_STM32 && !STM32GENERIC
|