Select one of the symbols to view example projects that use it.
 
Outline
#include <stdio.h>
#include "esp_random.h"
#include "esp_log.h"
#include "Partition.h"
#include "WL_Flash.h"
#include <stdlib.h>
#include "crc32.h"
#include <string.h>
#include <stddef.h>
#include <inttypes.h>
TAG
#define WL_CFG_CRC_CONST
WL_Flash::WL_Flash()
WL_Flash::~WL_Flash()
WL_Flash::config(wl_config_t *, Partition *)
WL_Flash::init()
WL_Flash::recoverPos()
WL_Flash::initSections()
WL_Flash::updateVersion()
WL_Flash::updateV1_V2()
WL_Flash::fillOkBuff(int)
WL_Flash::OkBuffSet(int)
WL_Flash::updateWL()
WL_Flash::calcAddr(size_t)
WL_Flash::get_flash_size()
WL_Flash::get_sector_size()
WL_Flash::erase_sector(size_t)
WL_Flash::erase_range(size_t, size_t)
WL_Flash::write(size_t, const void *, size_t)
WL_Flash::read(size_t, void *, size_t)
WL_Flash::get_part()
WL_Flash::get_cfg()
WL_Flash::flush()
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/wear_levelling/WL_Flash.cpp
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #include <stdio.h> #include "esp_random.h" #include "esp_log.h" #include "Partition.h" #include "WL_Flash.h" #include <stdlib.h> #include "crc32.h" #include <string.h> #include <stddef.h> #include <inttypes.h>10 includes static const char *TAG = "wl_flash"; #ifndef WL_CFG_CRC_CONST #define WL_CFG_CRC_CONST UINT32_MAX #endif // WL_CFG_CRC_CONST #define WL_RESULT_CHECK(result) \ if (result != ESP_OK) { \ ESP_LOGE(TAG,"%s(%d): result = 0x%08" PRIx32, __FUNCTION__, __LINE__, (uint32_t) result); \ return (result); \ }{...} ... #ifndef _MSC_VER // MSVS has different format for this define static_assert(sizeof(wl_state_t) % 32 == 0, "wl_state_t structure size must be multiple of flash encryption unit size"); #endif // _MSC_VER WL_Flash::WL_Flash() { }{ ... } WL_Flash::~WL_Flash() { free(this->temp_buff); }{ ... } esp_err_t WL_Flash::config(wl_config_t *cfg, Partition *partition) { ESP_LOGV(TAG, "%s partition_start_addr=0x%08" PRIx32 ", wl_partition_size=0x%08" PRIx32 ", wl_page_size=0x%08" PRIx32 ", flash_sector_size=0x%08" PRIx32 ", wl_update_rate=0x%08" PRIx32 ", wl_pos_update_record_size=0x%08" PRIx32 ", version=0x%08" PRIx32 ", wl_temp_buff_size=0x%08" PRIx32 , __func__, (uint32_t) cfg->wl_partition_start_addr, cfg->wl_partition_size, cfg->wl_page_size, cfg->flash_sector_size, cfg->wl_update_rate, cfg->wl_pos_update_record_size, cfg->version, (uint32_t) cfg->wl_temp_buff_size); cfg->crc32 = crc32::crc32_le(WL_CFG_CRC_CONST, (const unsigned char *)cfg, offsetof(wl_config_t, crc32)); esp_err_t result = ESP_OK; memcpy(&this->cfg, cfg, sizeof(wl_config_t)); if (this->cfg.wl_temp_buff_size < this->cfg.wl_pos_update_record_size) { this->cfg.wl_temp_buff_size = this->cfg.wl_pos_update_record_size; }{...} this->configured = false; if (cfg == NULL) { result = ESP_ERR_INVALID_ARG; }{...} this->partition = partition; if (partition == NULL) { result = ESP_ERR_INVALID_ARG; }{...} if ((this->cfg.flash_sector_size % this->cfg.wl_temp_buff_size) != 0) { result = ESP_ERR_INVALID_ARG; }{...} if (this->cfg.wl_page_size < this->cfg.flash_sector_size) { result = ESP_ERR_INVALID_ARG; }{...} WL_RESULT_CHECK(result); this->state_size = this->cfg.flash_sector_size; if (this->state_size < (sizeof(wl_state_t) + (this->cfg.wl_partition_size / this->cfg.flash_sector_size)*this->cfg.wl_pos_update_record_size)) { this->state_size = ((sizeof(wl_state_t) + (this->cfg.wl_partition_size / this->cfg.flash_sector_size) * this->cfg.wl_pos_update_record_size) + this->cfg.flash_sector_size - 1) / this->cfg.flash_sector_size; this->state_size = this->state_size * this->cfg.flash_sector_size; }{...} this->cfg_size = (sizeof(wl_config_t) + this->cfg.flash_sector_size - 1) / this->cfg.flash_sector_size; this->cfg_size = cfg_size * this->cfg.flash_sector_size; this->addr_cfg = this->cfg.wl_partition_start_addr + this->cfg.wl_partition_size - this->cfg_size; this->addr_state1 = this->cfg.wl_partition_start_addr + this->cfg.wl_partition_size - this->state_size * 2 - this->cfg_size; // allocate data at the end of memory this->addr_state2 = this->cfg.wl_partition_start_addr + this->cfg.wl_partition_size - this->state_size * 1 - this->cfg_size; // allocate data at the end of memory ptrdiff_t flash_sz = ((this->cfg.wl_partition_size - this->state_size * 2 - this->cfg_size) / this->cfg.wl_page_size - 1) * this->cfg.wl_page_size; // -1 remove dummy block this->flash_size = ((this->cfg.wl_partition_size - this->state_size * 2 - this->cfg_size) / this->cfg.wl_page_size - 1) * this->cfg.wl_page_size; // -1 remove dummy block ESP_LOGD(TAG, "%s - config result: state_size=0x%08" PRIx32 ", cfg_size=0x%08" PRIx32 ", addr_cfg=0x%08" PRIx32 ", addr_state1=0x%08" PRIx32 ", addr_state2=0x%08" PRIx32 ", flash_size=0x%08" PRIx32, __func__, (uint32_t) this->state_size, (uint32_t) this->cfg_size, (uint32_t) this->addr_cfg, (uint32_t) this->addr_state1, (uint32_t) this->addr_state2, (uint32_t) this->flash_size ); if (flash_sz <= 0) { result = ESP_ERR_INVALID_ARG; }{...} WL_RESULT_CHECK(result); this->temp_buff = (uint8_t *)malloc(this->cfg.wl_temp_buff_size); if (this->temp_buff == NULL) { result = ESP_ERR_NO_MEM; }{...} WL_RESULT_CHECK(result); this->configured = true; return ESP_OK; }{ ... } esp_err_t WL_Flash::init() { esp_err_t result = ESP_OK; if (this->configured == false) { ESP_LOGW(TAG, "WL_Flash: not configured, call config() first"); return ESP_ERR_INVALID_STATE; }{...} // If flow will be interrupted by error, then this flag will be false this->initialized = false; // Init states if it is first time... this->partition->read(this->addr_state1, &this->state, sizeof(wl_state_t)); wl_state_t sa_copy; wl_state_t *state_copy = &sa_copy; result = this->partition->read(this->addr_state2, state_copy, sizeof(wl_state_t)); WL_RESULT_CHECK(result); int check_size = WL_STATE_CRC_LEN_V2; // Chech CRC and recover state uint32_t crc1 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&this->state, check_size); uint32_t crc2 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)state_copy, check_size); ESP_LOGD(TAG, "%s - config ID=%" PRIu32 ", stored ID=%" PRIu32 ", wl_sec_erase_cycle_count=%" PRIu32 ", wl_block_size=%" PRIu32 ", wl_max_sec_erase_cycle_count=%" PRIu32 ", wl_dummy_sec_pos=%" PRIu32 ", wl_dummy_sec_move_count=0x%8.8" PRIX32, __func__, this->cfg.version, this->state.version, this->state.wl_sec_erase_cycle_count, this->state.wl_block_size, this->state.wl_max_sec_erase_cycle_count, this->state.wl_dummy_sec_pos, this->state.wl_dummy_sec_move_count); ESP_LOGD(TAG, "%s starts: crc1= 0x%08" PRIx32 ", crc2 = 0x%08" PRIx32 ", this->state.crc= 0x%08" PRIx32 ", state_copy->crc= 0x%08" PRIx32 ", version=%" PRIu32 ", read_version=%" PRIu32, __func__, crc1, crc2, this->state.crc32, state_copy->crc32, this->cfg.version, this->state.version); if ((crc1 == this->state.crc32) && (crc2 == state_copy->crc32)) { // The state is OK. Check the ID if (this->state.version != this->cfg.version) { result = this->initSections(); WL_RESULT_CHECK(result); result = this->recoverPos(); WL_RESULT_CHECK(result); }{...} else { if (crc1 != crc2) {// we did not update second structure. result = this->partition->erase_range(this->addr_state2, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); for (size_t i = 0; i < ((this->cfg.wl_partition_size / this->cfg.flash_sector_size)); i++) { bool pos_bits; result = this->partition->read(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); pos_bits = this->OkBuffSet(i); if (pos_bits == true) { //this->fillOkBuff(i); result = this->partition->write(this->addr_state2 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); }{...} }{...} }{...} ESP_LOGD(TAG, "%s: crc1=0x%08" PRIx32 ", crc2 = 0x%08" PRIx32 ", result= 0x%08" PRIx32 , __func__, crc1, crc2, (uint32_t)result); result = this->recoverPos(); WL_RESULT_CHECK(result); }{...} }{...} else if ((crc1 != this->state.crc32) && (crc2 != state_copy->crc32)) { // This is just new flash or new version // Check if this is new version or just new instance of WL ESP_LOGD(TAG, "%s: try to update version - crc1= 0x%08" PRIx32 ", crc2 = 0x%08" PRIx32 ", result= 0x%08" PRIx32 , __func__, (uint32_t)crc1, (uint32_t)crc2, (uint32_t)result); result = this->updateVersion(); if (result == ESP_FAIL) { ESP_LOGD(TAG, "%s: init flash sections", __func__); result = this->initSections(); WL_RESULT_CHECK(result); }{...} result = this->recoverPos(); WL_RESULT_CHECK(result); }{...} else { // recover broken state if (crc1 == this->state.crc32) {// we have to recover state 2 result = this->partition->erase_range(this->addr_state2, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); for (size_t i = 0; i < ((this->cfg.wl_partition_size / this->cfg.flash_sector_size)); i++) { bool pos_bits; result = this->partition->read(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); pos_bits = this->OkBuffSet(i); if (pos_bits == true) { result = this->partition->write(this->addr_state2 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); }{...} }{...} result = this->partition->read(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); }{...} else { // we have to recover state 1 result = this->partition->erase_range(this->addr_state1, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state1, state_copy, sizeof(wl_state_t)); WL_RESULT_CHECK(result); for (size_t i = 0; i < ((this->cfg.wl_partition_size / this->cfg.flash_sector_size)); i++) { bool pos_bits; result = this->partition->read(this->addr_state2 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); pos_bits = this->OkBuffSet(i); if (pos_bits == true) { result = this->partition->write(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); }{...} }{...} result = this->partition->read(this->addr_state1, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); this->state.wl_dummy_sec_pos = this->state.wl_part_max_sec_pos - 1; }{...} // done. We have recovered the state // If we have a new configuration, we will overwrite it if (this->state.version != this->cfg.version) { result = this->initSections(); WL_RESULT_CHECK(result); }{...} }{...} if (result != ESP_OK) { this->initialized = false; ESP_LOGE(TAG, "%s: returned 0x%08" PRIx32 , __func__, (uint32_t)result); return result; }{...} this->initialized = true; ESP_LOGD(TAG, "%s - wl_dummy_sec_move_count= 0x%08" PRIx32 , __func__, (uint32_t)this->state.wl_dummy_sec_move_count); return ESP_OK; }{ ... } esp_err_t WL_Flash::recoverPos() { esp_err_t result = ESP_OK; size_t position = 0; ESP_LOGV(TAG, "%s start", __func__); for (size_t i = 0; i < this->state.wl_part_max_sec_pos; i++) { bool pos_bits; position = i; result = this->partition->read(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); pos_bits = this->OkBuffSet(i); WL_RESULT_CHECK(result); ESP_LOGV(TAG, "%s - check pos: result=0x%08" PRIx32 ", position= %" PRIu32 ", pos_bits= 0x%08" PRIx32 , __func__, (uint32_t) result, (uint32_t) position, (uint32_t) pos_bits); if (pos_bits == false) { break; // we have found position }{...} }{...} this->state.wl_dummy_sec_pos = position; if (this->state.wl_dummy_sec_pos == this->state.wl_part_max_sec_pos) { this->state.wl_dummy_sec_pos--; }{...} ESP_LOGD(TAG, "%s - this->state.wl_dummy_sec_pos= 0x%08" PRIx32 ", position= 0x%08" PRIx32 ", result= 0x%08" PRIx32 ", wl_part_max_sec_pos= 0x%08" PRIx32 , __func__, (uint32_t)this->state.wl_dummy_sec_pos, (uint32_t)position, (uint32_t)result, (uint32_t)this->state.wl_part_max_sec_pos); ESP_LOGV(TAG, "%s done", __func__); return result; }{ ... } esp_err_t WL_Flash::initSections() { esp_err_t result = ESP_OK; this->state.wl_dummy_sec_pos = 0; this->state.wl_sec_erase_cycle_count = 0; this->state.wl_dummy_sec_move_count = 0; // max count this->state.wl_max_sec_erase_cycle_count = this->flash_size / this->state_size * this->cfg.wl_update_rate; if (this->cfg.wl_update_rate != 0) { this->state.wl_max_sec_erase_cycle_count = this->cfg.wl_update_rate; }{...} this->state.version = this->cfg.version; this->state.wl_block_size = this->cfg.wl_page_size; this->state.wl_device_id = esp_random(); memset(this->state.reserved, 0, sizeof(this->state.reserved)); this->state.wl_part_max_sec_pos = 1 + this->flash_size / this->cfg.wl_page_size; this->state.crc32 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&this->state, WL_STATE_CRC_LEN_V2); result = this->partition->erase_range(this->addr_state1, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state1, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); // write state copy result = this->partition->erase_range(this->addr_state2, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); result = this->partition->erase_range(this->addr_cfg, this->cfg_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_cfg, &this->cfg, sizeof(wl_config_t)); WL_RESULT_CHECK(result); ESP_LOGD(TAG, "%s - this->state->wl_max_sec_erase_cycle_count= 0x%08" PRIx32 ", this->state->wl_part_max_sec_pos= 0x%08" PRIx32 , __func__, this->state.wl_max_sec_erase_cycle_count, this->state.wl_part_max_sec_pos); ESP_LOGD(TAG, "%s - result= 0x%08x" , __func__, result); return result; }{ ... } esp_err_t WL_Flash::updateVersion() { esp_err_t result = ESP_OK; result = this->updateV1_V2(); if (result == ESP_OK) { return result; }{...} // check next version return result; }{ ... } esp_err_t WL_Flash::updateV1_V2() { esp_err_t result = ESP_OK; // Check crc for old version and old version ESP_LOGV(TAG, "%s start", __func__); int check_size = WL_STATE_CRC_LEN_V1; // Chech CRC and recover state uint32_t crc1 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&this->state, check_size); wl_state_t sa_copy; wl_state_t *state_copy = &sa_copy; result = this->partition->read(this->addr_state2, state_copy, sizeof(wl_state_t)); WL_RESULT_CHECK(result); uint32_t crc2 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)state_copy, check_size); // For V1 crc in place of wl_device_id and version uint32_t v1_crc1 = this->state.wl_device_id; uint32_t v1_crc2 = state_copy->wl_device_id; ESP_LOGD(TAG, "%s - process crc1=0x%08" PRIx32 ", crc2=0x%08" PRIx32 ", v1_crc1=0x%08" PRIx32 ", v1_crc2=0x%08" PRIx32 ", version=%" PRIu32, __func__, crc1, crc2, v1_crc1, v1_crc2, this->state.version); if ((crc1 == v1_crc1) && (crc2 == v1_crc2) && (v1_crc1 == v1_crc2) && (this->state.version == 1) && (state_copy->version == 1)) { // Here we have to update all internal structures ESP_LOGI(TAG, "%s Update from V1 to V2, crc=0x%08" PRIx32 ", ", __func__, crc1); uint32_t pos = 0; for (size_t i = 0; i < this->state.wl_part_max_sec_pos; i++) { uint8_t pos_bits; result = this->partition->read(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, &pos_bits, 1); WL_RESULT_CHECK(result); ESP_LOGV(TAG, "%s- result= 0x%08" PRIx32 ", pos= %" PRIu32 ", pos_bits= 0x%08" PRIx32 , __func__, (uint32_t) result, (uint32_t) pos, (uint32_t) pos_bits); pos = i; if (pos_bits == 0xff) { break; // we have found position }{...} }{...} ESP_LOGI(TAG, "%s wl_part_max_sec_pos=%" PRIu32 ", pos=%" PRIu32 ", state.ver=%" PRIu32 ", state2.ver=%" PRIu32, __func__, (uint32_t) this->state.wl_part_max_sec_pos, (uint32_t) pos, (uint32_t) this->state.version, (uint32_t) state_copy->version); if (pos == this->state.wl_part_max_sec_pos) { pos--; }{...} WL_RESULT_CHECK(result); this->state.version = 2; this->state.wl_dummy_sec_pos = 0; this->state.wl_device_id = esp_random(); memset(this->state.reserved, 0, sizeof(this->state.reserved)); this->state.crc32 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&this->state, WL_STATE_CRC_LEN_V2); result = this->partition->erase_range(this->addr_state1, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state1, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); memset(this->temp_buff, 0, this->cfg.wl_pos_update_record_size); for (uint32_t i = 0 ; i <= pos; i++) { this->fillOkBuff(i); result = this->partition->write(this->addr_state1 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); }{...} result = this->partition->erase_range(this->addr_state2, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); ESP_LOGD(TAG, "%s - wl_dummy_sec_move_count= 0x%08" PRIx32 ", pos= 0x%08" PRIx32 , __func__, this->state.wl_dummy_sec_move_count, this->state.wl_dummy_sec_pos); memset(this->temp_buff, 0, this->cfg.wl_pos_update_record_size); for (uint32_t i = 0 ; i <= pos; i++) { this->fillOkBuff(i); result = this->partition->write(this->addr_state2 + sizeof(wl_state_t) + i * this->cfg.wl_pos_update_record_size, this->temp_buff, this->cfg.wl_pos_update_record_size); WL_RESULT_CHECK(result); }{...} this->state.wl_dummy_sec_pos = pos; return result; }{...} return ESP_FAIL; }{ ... } void WL_Flash::fillOkBuff(int n) { uint32_t *buff = (uint32_t *)this->temp_buff; for (int i = 0 ; i < 4 ; i++) { buff[i] = this->state.wl_device_id + n * 4 + i; buff[i] = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&buff[i], sizeof(uint32_t)); }{...} }{ ... } bool WL_Flash::OkBuffSet(int n) { bool result = true; uint32_t *data_buff = (uint32_t *)this->temp_buff; for (int i = 0 ; i < 4 ; i++) { uint32_t data = this->state.wl_device_id + n * 4 + i; uint32_t crc = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&data, sizeof(uint32_t)); if (crc != data_buff[i]) { result = false; }{...} }{...} return result; }{ ... } esp_err_t WL_Flash::updateWL() { esp_err_t result = ESP_OK; this->state.wl_sec_erase_cycle_count++; if (this->state.wl_sec_erase_cycle_count < this->state.wl_max_sec_erase_cycle_count) { return result; }{...} // Here we have to move the block and increase the state this->state.wl_sec_erase_cycle_count = 0; ESP_LOGV(TAG, "%s - wl_sec_erase_cycle_count= 0x%08" PRIx32 ", pos= 0x%08" PRIx32 , __func__, this->state.wl_sec_erase_cycle_count, this->state.wl_dummy_sec_pos); // copy data to dummy block size_t data_addr = this->state.wl_dummy_sec_pos + 1; // next block, [pos+1] copy to [pos] if (data_addr >= this->state.wl_part_max_sec_pos) { data_addr = 0; }{...} data_addr = this->cfg.wl_partition_start_addr + data_addr * this->cfg.wl_page_size; this->dummy_addr = this->cfg.wl_partition_start_addr + this->state.wl_dummy_sec_pos * this->cfg.wl_page_size; result = this->partition->erase_range(this->dummy_addr, this->cfg.wl_page_size); if (result != ESP_OK) { ESP_LOGE(TAG, "%s - erase wl dummy sector result= 0x%08x" , __func__, result); this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; // we will update next time return result; }{...} size_t copy_count = this->cfg.wl_page_size / this->cfg.wl_temp_buff_size; for (size_t i = 0; i < copy_count; i++) { result = this->partition->read(data_addr + i * this->cfg.wl_temp_buff_size, this->temp_buff, this->cfg.wl_temp_buff_size); if (result != ESP_OK) { ESP_LOGE(TAG, "%s - not possible to read buffer, will try next time, result= 0x%08x" , __func__, result); this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; // we will update next time return result; }{...} result = this->partition->write(this->dummy_addr + i * this->cfg.wl_temp_buff_size, this->temp_buff, this->cfg.wl_temp_buff_size); if (result != ESP_OK) { ESP_LOGE(TAG, "%s - not possible to write buffer, will try next time, result= 0x%08x" , __func__, result); this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; // we will update next time return result; }{...} }{...} // done... block moved. // Here we will update structures... // Update bits and save to flash: uint32_t byte_pos = this->state.wl_dummy_sec_pos * this->cfg.wl_pos_update_record_size; this->fillOkBuff(this->state.wl_dummy_sec_pos); // write state to mem. We updating only affected bits result |= this->partition->write(this->addr_state1 + sizeof(wl_state_t) + byte_pos, this->temp_buff, this->cfg.wl_pos_update_record_size); if (result != ESP_OK) { ESP_LOGE(TAG, "%s - update position 1 result= 0x%08x" , __func__, result); this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; // we will update next time return result; }{...} this->fillOkBuff(this->state.wl_dummy_sec_pos); result |= this->partition->write(this->addr_state2 + sizeof(wl_state_t) + byte_pos, this->temp_buff, this->cfg.wl_pos_update_record_size); if (result != ESP_OK) { ESP_LOGE(TAG, "%s - update position 2 result= 0x%08x" , __func__, result); this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; // we will update next time return result; }{...} this->state.wl_dummy_sec_pos++; if (this->state.wl_dummy_sec_pos >= this->state.wl_part_max_sec_pos) { this->state.wl_dummy_sec_pos = 0; // one loop more this->state.wl_dummy_sec_move_count++; if (this->state.wl_dummy_sec_move_count >= (this->state.wl_part_max_sec_pos - 1)) { this->state.wl_dummy_sec_move_count = 0; }{...} // write main state this->state.crc32 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)&this->state, WL_STATE_CRC_LEN_V2); result = this->partition->erase_range(this->addr_state1, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state1, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); result = this->partition->erase_range(this->addr_state2, this->state_size); WL_RESULT_CHECK(result); result = this->partition->write(this->addr_state2, &this->state, sizeof(wl_state_t)); WL_RESULT_CHECK(result); ESP_LOGD(TAG, "%s - wl_dummy_sec_move_count= 0x%08" PRIx32 ", wl_dummy_sec_pos= 0x%08" PRIx32 ", ", __func__, this->state.wl_dummy_sec_move_count, this->state.wl_dummy_sec_pos); }{...} // Save structures to the flash... and check result if (result == ESP_OK) { ESP_LOGV(TAG, "%s - result= 0x%08x" , __func__, result); }{...} else { ESP_LOGE(TAG, "%s - result= 0x%08x" , __func__, result); }{...} return result; }{ ... } size_t WL_Flash::calcAddr(size_t addr) { size_t result = (this->flash_size - this->state.wl_dummy_sec_move_count * this->cfg.wl_page_size + addr) % this->flash_size; size_t dummy_addr = this->state.wl_dummy_sec_pos * this->cfg.wl_page_size; if (result < dummy_addr) { }{...} else { result += this->cfg.wl_page_size; }{...} ESP_LOGV(TAG, "%s - addr= 0x%08" PRIx32 " -> result= 0x%08" PRIx32 ", dummy_addr= 0x%08" PRIx32 , __func__, (uint32_t) addr, (uint32_t) result, (uint32_t)dummy_addr); return result; }{ ... } size_t WL_Flash::get_flash_size() { if (!this->configured) { return 0; }{...} return this->flash_size; }{ ... } size_t WL_Flash::get_sector_size() { if (!this->configured) { return 0; }{...} return this->cfg.flash_sector_size; }{ ... } esp_err_t WL_Flash::erase_sector(size_t sector) { esp_err_t result = ESP_OK; if (!this->initialized) { return ESP_ERR_INVALID_STATE; }{...} ESP_LOGD(TAG, "%s - sector= 0x%08" PRIx32 , __func__, (uint32_t) sector); result = this->updateWL(); WL_RESULT_CHECK(result); size_t virt_addr = this->calcAddr(sector * this->cfg.flash_sector_size); result = this->partition->erase_sector((this->cfg.wl_partition_start_addr + virt_addr) / this->cfg.flash_sector_size); WL_RESULT_CHECK(result); return result; }{ ... } esp_err_t WL_Flash::erase_range(size_t start_address, size_t size) { esp_err_t result = ESP_OK; if (!this->initialized) { return ESP_ERR_INVALID_STATE; }{...} ESP_LOGD(TAG, "%s - start_address= 0x%08" PRIx32 ", size= 0x%08" PRIx32 , __func__, (uint32_t) start_address, (uint32_t) size); size_t erase_count = (size + this->cfg.flash_sector_size - 1) / this->cfg.flash_sector_size; size_t start_sector = start_address / this->cfg.flash_sector_size; for (size_t i = 0; i < erase_count; i++) { result = this->erase_sector(start_sector + i); WL_RESULT_CHECK(result); }{...} ESP_LOGV(TAG, "%s - result= 0x%08x" , __func__, result); return result; }{ ... } esp_err_t WL_Flash::write(size_t dest_addr, const void *src, size_t size) { esp_err_t result = ESP_OK; if (!this->initialized) { return ESP_ERR_INVALID_STATE; }{...} ESP_LOGD(TAG, "%s - dest_addr= 0x%08" PRIx32 ", size= 0x%08" PRIx32 , __func__, (uint32_t) dest_addr, (uint32_t) size); uint32_t count = (size - 1) / this->cfg.wl_page_size; for (size_t i = 0; i < count; i++) { size_t virt_addr = this->calcAddr(dest_addr + i * this->cfg.wl_page_size); result = this->partition->write(this->cfg.wl_partition_start_addr + virt_addr, &((uint8_t *)src)[i * this->cfg.wl_page_size], this->cfg.wl_page_size); WL_RESULT_CHECK(result); }{...} size_t virt_addr_last = this->calcAddr(dest_addr + count * this->cfg.wl_page_size); result = this->partition->write(this->cfg.wl_partition_start_addr + virt_addr_last, &((uint8_t *)src)[count * this->cfg.wl_page_size], size - count * this->cfg.wl_page_size); WL_RESULT_CHECK(result); return result; }{ ... } esp_err_t WL_Flash::read(size_t src_addr, void *dest, size_t size) { esp_err_t result = ESP_OK; if (!this->initialized) { return ESP_ERR_INVALID_STATE; }{...} ESP_LOGD(TAG, "%s - src_addr= 0x%08" PRIx32 ", size= 0x%08" PRIx32 , __func__, (uint32_t) src_addr, (uint32_t) size); uint32_t count = (size - 1) / this->cfg.wl_page_size; for (size_t i = 0; i < count; i++) { size_t virt_addr = this->calcAddr(src_addr + i * this->cfg.wl_page_size); ESP_LOGV(TAG, "%s - real_addr= 0x%08" PRIx32 ", size= 0x%08" PRIx32 , __func__, (uint32_t) (this->cfg.wl_partition_start_addr + virt_addr), (uint32_t) size); result = this->partition->read(this->cfg.wl_partition_start_addr + virt_addr, &((uint8_t *)dest)[i * this->cfg.wl_page_size], this->cfg.wl_page_size); WL_RESULT_CHECK(result); }{...} size_t virt_addr_last = this->calcAddr(src_addr + count * this->cfg.wl_page_size); result = this->partition->read(this->cfg.wl_partition_start_addr + virt_addr_last, &((uint8_t *)dest)[count * this->cfg.wl_page_size], size - count * this->cfg.wl_page_size); WL_RESULT_CHECK(result); return result; }{ ... } Partition *WL_Flash::get_part() { return this->partition; }{ ... } wl_config_t *WL_Flash::get_cfg() { return &this->cfg; }{ ... } esp_err_t WL_Flash::flush() { esp_err_t result = ESP_OK; this->state.wl_sec_erase_cycle_count = this->state.wl_max_sec_erase_cycle_count - 1; result = this->updateWL(); ESP_LOGD(TAG, "%s - result= 0x%08x, wl_dummy_sec_move_count= 0x%08" PRIx32, __func__, result, this->state.wl_dummy_sec_move_count); return result; }{ ... }
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.