1 /* 2 * Copyright (C) 2017 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 21 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 25 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 27 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 */ 31 32 #define BTSTACK_FILE__ "btstack_tlv_flash_bank.c" 33 34 #include "btstack_tlv.h" 35 #include "btstack_tlv_flash_bank.h" 36 #include "btstack_debug.h" 37 #include "btstack_util.h" 38 #include "btstack_debug.h" 39 40 #include <string.h> 41 #include <inttypes.h> 42 43 // Header: 44 // - Magic: 'BTstack' 45 // - Status: 46 // - bits 765432: reserved 47 // - bits 10: epoch 48 49 // Entries 50 // - Tag: 32 bit 51 // - Len: 32 bit 52 // - Delete: 32 delete field - only used with ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 53 // - Value: Len in bytes 54 55 // Alignment 56 // Tag and Delete (if it exists) are aligned to the alignment from hal_flash_bank_t 57 58 // ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 59 // 60 // Most Flash implementations allow to: 61 // - erase sector -> all values are 0xff 62 // - write value (1s -> 0s) 63 // - overwrite value with zero (remaining 1s -> 0s) 64 // 65 // We use the ability to overwrite a value with zeros to mark deleted enttries (by writing zero into the tag field). 66 // Some targets, E.g. Kinetix K64F, do enot allow for that. 67 // 68 // With ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD an extra field is reserved to indicate a deleted tag, while keeping main logic 69 // 70 // With ENABLE_TLV_FLASH_WRITE_ONCE, tags are never marked as deleted. Instead, an emtpy tag will be written instead. 71 // Also, lookup and migrate requires to always search until the end of the valid bank 72 73 #if defined (ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD) && defined (ENABLE_TLV_FLASH_WRITE_ONCE) 74 #error "Please define either ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD or ENABLE_TLV_FLASH_WRITE_ONCE" 75 #endif 76 77 #define BTSTACK_TLV_BANK_HEADER_LEN 8 78 #define BTSTACK_TLV_ENTRY_HEADER_LEN 8 79 80 #ifndef BTSTACK_FLASH_ALIGNMENT_MAX 81 #define BTSTACK_FLASH_ALIGNMENT_MAX 8 82 #endif 83 84 static const char * btstack_tlv_header_magic = "BTstack"; 85 86 // TLV Iterator 87 typedef struct { 88 int bank; 89 uint32_t offset; 90 uint32_t size; 91 uint32_t tag; 92 uint32_t len; 93 } tlv_iterator_t; 94 95 static uint32_t btstack_tlv_flash_bank_align_size(btstack_tlv_flash_bank_t * self, uint32_t size){ 96 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 97 return (size + alignment - 1) & ~(alignment - 1); 98 } 99 100 static uint32_t btstack_tlv_flash_bank_aligned_entry_size(btstack_tlv_flash_bank_t * self, uint32_t size) { 101 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 102 // entry header and delete fields are already padded 103 return self->entry_header_len + self->delete_tag_len + btstack_tlv_flash_bank_align_size(self, size); 104 #else 105 // otherwise, data starts right after entry header 106 return btstack_tlv_flash_bank_align_size(self, self->entry_header_len + size); 107 #endif 108 } 109 110 // support unaligned flash read/writes 111 // strategy: increase size to meet alignment, perform unaligned read/write of last chunk with helper buffer 112 113 static void btstack_tlv_flash_bank_read(btstack_tlv_flash_bank_t * self, int bank, uint32_t offset, uint8_t * buffer, uint32_t size){ 114 115 // read main data 116 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 117 uint32_t lower_bits = size & (alignment - 1); 118 uint32_t size_aligned = size - lower_bits; 119 if (size_aligned){ 120 self->hal_flash_bank_impl->read(self->hal_flash_bank_context, bank, offset, buffer, size_aligned); 121 buffer += size_aligned; 122 offset += size_aligned; 123 size -= size_aligned; 124 } 125 126 // read last part 127 if (size == 0) return; 128 uint8_t alignment_block[BTSTACK_FLASH_ALIGNMENT_MAX]; 129 self->hal_flash_bank_impl->read(self->hal_flash_bank_context, bank, offset, alignment_block, alignment); 130 uint32_t bytes_to_copy = btstack_min(alignment - lower_bits, size); 131 memcpy(buffer, alignment_block, bytes_to_copy); 132 } 133 134 static void btstack_tlv_flash_bank_write(btstack_tlv_flash_bank_t * self, int bank, uint32_t offset, const uint8_t * buffer, uint32_t size){ 135 136 // write main data 137 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 138 uint32_t lower_bits = size & (alignment - 1); 139 uint32_t size_aligned = size - lower_bits; 140 if (size_aligned){ 141 self->hal_flash_bank_impl->write(self->hal_flash_bank_context, bank, offset, buffer, size_aligned); 142 buffer += size_aligned; 143 offset += size_aligned; 144 size -= size_aligned; 145 } 146 147 // write last part 148 if (size == 0) return; 149 uint8_t alignment_block[BTSTACK_FLASH_ALIGNMENT_MAX]; 150 memset(alignment_block, 0xff, alignment); 151 memcpy(alignment_block, buffer, lower_bits); 152 self->hal_flash_bank_impl->write(self->hal_flash_bank_context, bank, offset, alignment_block, alignment); 153 } 154 155 156 // iterator 157 158 static void btstack_tlv_flash_bank_iterator_fetch_tag_len(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){ 159 // abort if header doesn't fit into remaining space 160 if (it->offset + self->entry_header_len + self->delete_tag_len >= self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){ 161 it->tag = 0xffffffff; 162 return; 163 } 164 165 uint8_t entry[BTSTACK_TLV_ENTRY_HEADER_LEN]; 166 btstack_tlv_flash_bank_read(self, it->bank, it->offset, entry, BTSTACK_TLV_ENTRY_HEADER_LEN); 167 it->tag = big_endian_read_32(entry, 0); 168 it->len = big_endian_read_32(entry, 4); 169 170 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 171 // clear tag, if delete field is set 172 uint32_t delete_tag; 173 btstack_tlv_flash_bank_read(self, it->bank, it->offset + self->entry_header_len, (uint8_t *) &delete_tag, 4); 174 if (delete_tag == 0){ 175 it->tag = 0; 176 } 177 #endif 178 } 179 180 static void btstack_tlv_flash_bank_iterator_init(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it, int bank){ 181 memset(it, 0, sizeof(tlv_iterator_t)); 182 it->bank = bank; 183 it->offset = BTSTACK_TLV_BANK_HEADER_LEN; 184 it->size = self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context); 185 btstack_tlv_flash_bank_iterator_fetch_tag_len(self, it); 186 } 187 188 static bool btstack_tlv_flash_bank_iterator_has_next(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){ 189 UNUSED(self); 190 return it->tag != 0xffffffff; 191 } 192 193 static void tlv_iterator_fetch_next(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){ 194 it->offset += btstack_tlv_flash_bank_aligned_entry_size(self, it->len); 195 196 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 197 // skip delete field 198 it->offset += self->delete_tag_len; 199 #endif 200 201 if (it->offset >= it->size) { 202 it->tag = 0xffffffff; 203 it->len = 0; 204 return; 205 } 206 btstack_tlv_flash_bank_iterator_fetch_tag_len(self, it); 207 } 208 209 // 210 211 // check both banks for headers and pick the one with the higher epoch % 4 212 // @returns bank or -1 if something is invalid 213 static int btstack_tlv_flash_bank_get_latest_bank(btstack_tlv_flash_bank_t * self){ 214 uint8_t header0[BTSTACK_TLV_BANK_HEADER_LEN]; 215 uint8_t header1[BTSTACK_TLV_BANK_HEADER_LEN]; 216 btstack_tlv_flash_bank_read(self, 0, 0, &header0[0], BTSTACK_TLV_BANK_HEADER_LEN); 217 btstack_tlv_flash_bank_read(self, 1, 0, &header1[0], BTSTACK_TLV_BANK_HEADER_LEN); 218 int valid0 = memcmp(header0, btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1) == 0; 219 int valid1 = memcmp(header1, btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1) == 0; 220 if (!valid0 && !valid1) return -1; 221 if ( valid0 && !valid1) return 0; 222 if (!valid0 && valid1) return 1; 223 int epoch0 = header0[BTSTACK_TLV_BANK_HEADER_LEN-1] & 0x03; 224 int epoch1 = header1[BTSTACK_TLV_BANK_HEADER_LEN-1] & 0x03; 225 if (epoch0 == ((epoch1 + 1) & 0x03)) return 0; 226 if (epoch1 == ((epoch0 + 1) & 0x03)) return 1; 227 return -1; // invalid, must not happen 228 } 229 230 static void btstack_tlv_flash_bank_write_header(btstack_tlv_flash_bank_t * self, int bank, int epoch){ 231 uint8_t header[BTSTACK_TLV_BANK_HEADER_LEN]; 232 memcpy(&header[0], btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1); 233 header[BTSTACK_TLV_BANK_HEADER_LEN-1] = epoch; 234 btstack_tlv_flash_bank_write(self, bank, 0, header, BTSTACK_TLV_BANK_HEADER_LEN); 235 } 236 237 /** 238 * @brief Check if erased from offset 239 */ 240 static int btstack_tlv_flash_bank_test_erased(btstack_tlv_flash_bank_t * self, int bank, uint32_t offset){ 241 log_info("test erased: bank %u, offset %u", bank, (unsigned int) offset); 242 uint32_t size = self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context); 243 uint8_t buffer[16]; 244 uint8_t empty16[16]; 245 memset(empty16, 0xff, sizeof(empty16)); 246 while (offset < size){ 247 uint32_t copy_size = (offset + sizeof(empty16) < size) ? sizeof(empty16) : (size - offset); 248 btstack_tlv_flash_bank_read(self, bank, offset, buffer, copy_size); 249 if (memcmp(buffer, empty16, copy_size) != 0) { 250 log_info("not erased %x - %x", (unsigned int) offset, (unsigned int) (offset + copy_size)); 251 return 0; 252 } 253 offset += copy_size; 254 } 255 return 1; 256 } 257 258 /** 259 * @brief erase bank (only if not already erased) 260 */ 261 static void btstack_tlv_flash_bank_erase_bank(btstack_tlv_flash_bank_t * self, int bank){ 262 if (btstack_tlv_flash_bank_test_erased(self, bank, 0)){ 263 log_info("bank %u already erased", bank); 264 } else { 265 log_info("bank %u not empty, erase bank", bank); 266 self->hal_flash_bank_impl->erase(self->hal_flash_bank_context, bank); 267 } 268 } 269 270 static void btstack_tlv_flash_bank_migrate(btstack_tlv_flash_bank_t * self){ 271 272 int next_bank = 1 - self->current_bank; 273 log_info("migrate bank %u -> bank %u", self->current_bank, next_bank); 274 // erase bank (if needed) 275 btstack_tlv_flash_bank_erase_bank(self, next_bank); 276 int next_write_pos = BTSTACK_TLV_BANK_HEADER_LEN; 277 278 tlv_iterator_t it; 279 btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank); 280 while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){ 281 // skip deleted entries 282 if (it.tag) { 283 uint32_t tag_len = it.len; 284 uint32_t tag_index = it.offset; 285 286 bool tag_valid = true; 287 288 #ifdef ENABLE_TLV_FLASH_WRITE_ONCE 289 // search until end for newer entry of same tag 290 tlv_iterator_t it2; 291 memcpy(&it2, &it, sizeof(tlv_iterator_t)); 292 while (btstack_tlv_flash_bank_iterator_has_next(self, &it2)){ 293 if ((it2.offset != it.offset) && (it2.tag == it.tag)){ 294 tag_valid = false; 295 break; 296 } 297 tlv_iterator_fetch_next(self, &it2); 298 } 299 if (tag_valid == false){ 300 log_info("skip pos %u, tag '%x' as newer entry found at %u", (unsigned int) tag_index, (unsigned int) it.tag, 301 (unsigned int) it2.offset); 302 } 303 #endif 304 305 if (tag_valid) { 306 307 log_info("migrate pos %u, tag '%x' len %u -> new pos %u", 308 (unsigned int) tag_index, (unsigned int) it.tag, (unsigned int) tag_len, next_write_pos); 309 310 uint32_t write_offset = next_write_pos; 311 uint32_t bytes_to_copy; 312 uint32_t entry_size = btstack_tlv_flash_bank_aligned_entry_size(self, tag_len); 313 314 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 315 // copy in two steps to skip delete field 316 317 // copy header 318 uint8_t header_buffer[BTSTACK_TLV_ENTRY_HEADER_LEN]; 319 btstack_tlv_flash_bank_read(self, self->current_bank, tag_index, header_buffer, BTSTACK_TLV_ENTRY_HEADER_LEN); 320 btstack_tlv_flash_bank_write(self, next_bank, next_write_pos, header_buffer, BTSTACK_TLV_ENTRY_HEADER_LEN); 321 tag_index += self->entry_header_len + self->delete_tag_len; 322 write_offset += self->entry_header_len + self->delete_tag_len; 323 324 // preparee copy value 325 bytes_to_copy = tag_len; 326 #else 327 // copy everything as one block 328 bytes_to_copy = entry_size; 329 #endif 330 331 // copy value 332 uint8_t copy_buffer[32]; 333 while (bytes_to_copy > 0) { 334 uint32_t bytes_this_iteration = btstack_min(bytes_to_copy, sizeof(copy_buffer)); 335 btstack_tlv_flash_bank_read(self, self->current_bank, tag_index, copy_buffer, bytes_this_iteration); 336 btstack_tlv_flash_bank_write(self, next_bank, write_offset, copy_buffer, bytes_this_iteration); 337 tag_index += bytes_this_iteration; 338 write_offset += bytes_this_iteration; 339 bytes_to_copy -= bytes_this_iteration; 340 } 341 next_write_pos += entry_size; 342 } 343 } 344 tlv_iterator_fetch_next(self, &it); 345 } 346 347 // prepare new one 348 uint8_t epoch_buffer; 349 btstack_tlv_flash_bank_read(self, self->current_bank, BTSTACK_TLV_BANK_HEADER_LEN-1, &epoch_buffer, 1); 350 btstack_tlv_flash_bank_write_header(self, next_bank, (epoch_buffer + 1) & 3); 351 self->current_bank = next_bank; 352 self->write_offset = next_write_pos; 353 } 354 355 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 356 static void btstack_tlv_flash_bank_delete_tag_until_offset(btstack_tlv_flash_bank_t * self, uint32_t tag, uint32_t offset){ 357 tlv_iterator_t it; 358 btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank); 359 while (btstack_tlv_flash_bank_iterator_has_next(self, &it) && it.offset < offset){ 360 if (it.tag == tag){ 361 log_info("Erase tag '%x' at position %u", (unsigned int) tag, (unsigned int) it.offset); 362 363 // mark entry as invalid 364 uint32_t zero_value = 0; 365 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 366 // write delete field after entry header 367 btstack_tlv_flash_bank_write(self, self->current_bank, it.offset+self->entry_header_len, (uint8_t*) &zero_value, sizeof(zero_value)); 368 #else 369 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 370 if (alignment <= 4){ 371 // if alignment < 4, overwrite only tag with zero value 372 btstack_tlv_flash_bank_write(self, self->current_bank, it.offset, (uint8_t*) &zero_value, sizeof(zero_value)); 373 } else { 374 // otherwise, overwrite complete entry. This results in a sequence of { tag: 0, len: 0 } entries 375 uint8_t zero_buffer[32]; 376 memset(zero_buffer, 0, sizeof(zero_buffer)); 377 uint32_t entry_offset = 0; 378 uint32_t entry_size = btstack_tlv_flash_bank_aligned_entry_size(self, it.len); 379 while (entry_offset < entry_size) { 380 uint32_t bytes_to_write = btstack_min(entry_size - entry_offset, sizeof(zero_buffer)); 381 btstack_tlv_flash_bank_write(self, self->current_bank, it.offset + entry_offset, zero_buffer, bytes_to_write); 382 entry_offset += bytes_to_write; 383 } 384 } 385 #endif 386 } 387 tlv_iterator_fetch_next(self, &it); 388 } 389 } 390 #endif 391 392 /** 393 * Get Value for Tag 394 * @param tag 395 * @param buffer 396 * @param buffer_size 397 * @returns size of value 398 */ 399 static int btstack_tlv_flash_bank_get_tag(void * context, uint32_t tag, uint8_t * buffer, uint32_t buffer_size){ 400 401 btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context; 402 403 uint32_t tag_index = 0; 404 uint32_t tag_len = 0; 405 tlv_iterator_t it; 406 btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank); 407 while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){ 408 if (it.tag == tag){ 409 log_info("Found tag '%x' at position %u", (unsigned int) tag, (unsigned int) it.offset); 410 tag_index = it.offset; 411 tag_len = it.len; 412 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 413 break; 414 #endif 415 } 416 tlv_iterator_fetch_next(self, &it); 417 } 418 if (tag_index == 0) return 0; 419 if (!buffer) return tag_len; 420 int copy_size = btstack_min(buffer_size, tag_len); 421 uint32_t value_offset = tag_index + self->entry_header_len; 422 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 423 // skip delete field 424 value_offset += self->delete_tag_len; 425 #endif 426 btstack_tlv_flash_bank_read(self, self->current_bank, value_offset, buffer, copy_size); 427 return copy_size; 428 } 429 430 /** 431 * Store Tag 432 * @param tag 433 * @param data 434 * @param data_size 435 */ 436 static int btstack_tlv_flash_bank_store_tag(void * context, uint32_t tag, const uint8_t * data, uint32_t data_size){ 437 438 btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context; 439 440 // trigger migration if not enough space 441 uint32_t required_space = self->entry_header_len + self->delete_tag_len + data_size; 442 if (self->write_offset + required_space > self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){ 443 btstack_tlv_flash_bank_migrate(self); 444 } 445 446 if (self->write_offset + required_space > self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){ 447 log_error("couldn't write entry, not enough space left"); 448 return 2; 449 } 450 451 // prepare entry 452 log_info("write '%" PRIx32 "', len %" PRIu32 " at %" PRIx32, tag, data_size, self->write_offset); 453 454 uint8_t alignment_buffer[BTSTACK_FLASH_ALIGNMENT_MAX]; 455 memset(alignment_buffer, 0, sizeof(alignment_buffer)); 456 big_endian_store_32(alignment_buffer, 0, tag); 457 big_endian_store_32(alignment_buffer, 4, data_size); 458 459 uint32_t header_len = BTSTACK_TLV_ENTRY_HEADER_LEN; 460 uint32_t value_size = data_size; 461 uint32_t value_offset = self->write_offset + self->entry_header_len; 462 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 463 // skip delete field 464 value_offset += self->delete_tag_len; 465 #else 466 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 467 468 // if alignment is larger than the entry header, store parts from value in alignment buffer 469 if (alignment > BTSTACK_TLV_ENTRY_HEADER_LEN){ 470 // calculated number of value bytes to store in alignment buffer 471 uint32_t bytes_from_value = btstack_min(alignment - BTSTACK_TLV_ENTRY_HEADER_LEN, value_size); 472 473 // store parts from value in alignment buffer and update remaining value 474 memcpy(&alignment_buffer[header_len], data, bytes_from_value); 475 header_len += bytes_from_value; 476 data += bytes_from_value; 477 value_size -= bytes_from_value; 478 value_offset = self->write_offset + alignment; 479 } 480 #endif 481 482 // write value first 483 if (value_size > 0){ 484 btstack_tlv_flash_bank_write(self, self->current_bank, value_offset, data, value_size); 485 } 486 487 // then entry 488 btstack_tlv_flash_bank_write(self, self->current_bank, self->write_offset, alignment_buffer, header_len); 489 490 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 491 // overwrite old entries (if exists) 492 btstack_tlv_flash_bank_delete_tag_until_offset(self, tag, self->write_offset); 493 #endif 494 495 // done 496 self->write_offset += btstack_tlv_flash_bank_aligned_entry_size(self, data_size); 497 498 return 0; 499 } 500 501 /** 502 * Delete Tag 503 * @param tag 504 */ 505 static void btstack_tlv_flash_bank_delete_tag(void * context, uint32_t tag){ 506 #ifdef ENABLE_TLV_FLASH_WRITE_ONCE 507 btstack_tlv_flash_bank_store_tag(context, tag, NULL, 0); 508 #else 509 btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context; 510 btstack_tlv_flash_bank_delete_tag_until_offset(self, tag, self->write_offset); 511 #endif 512 } 513 514 static const btstack_tlv_t btstack_tlv_flash_bank = { 515 /* int (*get_tag)(..); */ &btstack_tlv_flash_bank_get_tag, 516 /* int (*store_tag)(..); */ &btstack_tlv_flash_bank_store_tag, 517 /* void (*delete_tag)(v..); */ &btstack_tlv_flash_bank_delete_tag, 518 }; 519 520 /** 521 * Init Tag Length Value Store 522 */ 523 const btstack_tlv_t * btstack_tlv_flash_bank_init_instance(btstack_tlv_flash_bank_t * self, const hal_flash_bank_t * hal_flash_bank_impl, void * hal_flash_bank_context){ 524 525 self->hal_flash_bank_impl = hal_flash_bank_impl; 526 self->hal_flash_bank_context = hal_flash_bank_context; 527 self->delete_tag_len = 0; 528 529 #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 530 if (hal_flash_bank_impl->get_alignment(hal_flash_bank_context) > 8){ 531 log_error("Flash alignment > 8 with ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD not supported"); 532 return NULL; 533 } 534 // set delete tag len 535 uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context); 536 self->delete_tag_len = (uint8_t) btstack_max(4, alignment); 537 log_info("delete tag len %u", self->delete_tag_len); 538 539 // set aligned entry header len 540 self->entry_header_len = btstack_tlv_flash_bank_align_size(self, BTSTACK_TLV_ENTRY_HEADER_LEN); 541 #else 542 // data starts right after entry header 543 self->entry_header_len = BTSTACK_TLV_ENTRY_HEADER_LEN; 544 #endif 545 546 // try to find current bank 547 self->current_bank = btstack_tlv_flash_bank_get_latest_bank(self); 548 log_info("found bank %d", self->current_bank); 549 if (self->current_bank >= 0){ 550 551 // find last entry and write offset 552 tlv_iterator_t it; 553 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 554 uint32_t last_tag = 0; 555 uint32_t last_offset = 0; 556 #endif 557 btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank); 558 while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){ 559 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 560 last_tag = it.tag; 561 last_offset = it.offset; 562 #endif 563 tlv_iterator_fetch_next(self, &it); 564 } 565 self->write_offset = it.offset; 566 567 if (self->write_offset <= self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){ 568 569 #ifndef ENABLE_TLV_FLASH_WRITE_ONCE 570 // delete older instances of last_tag 571 // this handles the unlikely case where MCU did reset after new value + header was written but before delete did complete 572 if (last_tag){ 573 btstack_tlv_flash_bank_delete_tag_until_offset(self, last_tag, last_offset); 574 } 575 #endif 576 577 // verify that rest of bank is empty 578 // this handles the unlikely case where MCU did reset after new value was written, but not the tag 579 if (!btstack_tlv_flash_bank_test_erased(self, self->current_bank, self->write_offset)){ 580 log_info("Flash not empty after last found tag -> migrate"); 581 btstack_tlv_flash_bank_migrate(self); 582 } else { 583 log_info("Flash clean after last found tag"); 584 } 585 } else { 586 // failure! 587 self->current_bank = -1; 588 } 589 } 590 591 if (self->current_bank < 0) { 592 btstack_tlv_flash_bank_erase_bank(self, 0); 593 self->current_bank = 0; 594 btstack_tlv_flash_bank_write_header(self, self->current_bank, 0); // epoch = 0; 595 self->write_offset = BTSTACK_TLV_BANK_HEADER_LEN; 596 } 597 598 log_info("write offset %" PRIx32, self->write_offset); 599 return &btstack_tlv_flash_bank; 600 } 601 602