xref: /btstack/platform/embedded/btstack_tlv_flash_bank.c (revision f268b03a0a84e7be82f2540297a832c060d832bc)
117ae5bc4SMatthias Ringwald /*
217ae5bc4SMatthias Ringwald  * Copyright (C) 2017 BlueKitchen GmbH
317ae5bc4SMatthias Ringwald  *
417ae5bc4SMatthias Ringwald  * Redistribution and use in source and binary forms, with or without
517ae5bc4SMatthias Ringwald  * modification, are permitted provided that the following conditions
617ae5bc4SMatthias Ringwald  * are met:
717ae5bc4SMatthias Ringwald  *
817ae5bc4SMatthias Ringwald  * 1. Redistributions of source code must retain the above copyright
917ae5bc4SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer.
1017ae5bc4SMatthias Ringwald  * 2. Redistributions in binary form must reproduce the above copyright
1117ae5bc4SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer in the
1217ae5bc4SMatthias Ringwald  *    documentation and/or other materials provided with the distribution.
1317ae5bc4SMatthias Ringwald  * 3. Neither the name of the copyright holders nor the names of
1417ae5bc4SMatthias Ringwald  *    contributors may be used to endorse or promote products derived
1517ae5bc4SMatthias Ringwald  *    from this software without specific prior written permission.
1617ae5bc4SMatthias Ringwald  *
172fca4dadSMilanka Ringwald  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
1817ae5bc4SMatthias Ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1917ae5bc4SMatthias Ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
202fca4dadSMilanka Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
212fca4dadSMilanka Ringwald  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
2217ae5bc4SMatthias Ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
2317ae5bc4SMatthias Ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
2417ae5bc4SMatthias Ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
2517ae5bc4SMatthias Ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
2617ae5bc4SMatthias Ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
2717ae5bc4SMatthias Ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2817ae5bc4SMatthias Ringwald  * SUCH DAMAGE.
2917ae5bc4SMatthias Ringwald  *
3017ae5bc4SMatthias Ringwald  */
3117ae5bc4SMatthias Ringwald 
32e501bae0SMatthias Ringwald #define BTSTACK_FILE__ "btstack_tlv_flash_bank.c"
3317ae5bc4SMatthias Ringwald 
3417ae5bc4SMatthias Ringwald #include "btstack_tlv.h"
3517ae5bc4SMatthias Ringwald #include "btstack_tlv_flash_bank.h"
3617ae5bc4SMatthias Ringwald #include "btstack_debug.h"
3717ae5bc4SMatthias Ringwald #include "btstack_util.h"
3817ae5bc4SMatthias Ringwald #include "btstack_debug.h"
3917ae5bc4SMatthias Ringwald 
4017ae5bc4SMatthias Ringwald #include <string.h>
4179b7220dSMatthias Ringwald #include <inttypes.h>
4217ae5bc4SMatthias Ringwald 
4317ae5bc4SMatthias Ringwald // Header:
4417ae5bc4SMatthias Ringwald // - Magic: 'BTstack'
4517ae5bc4SMatthias Ringwald // - Status:
4617ae5bc4SMatthias Ringwald //   - bits 765432: reserved
4717ae5bc4SMatthias Ringwald //	 - bits 10:     epoch
4817ae5bc4SMatthias Ringwald 
4917ae5bc4SMatthias Ringwald // Entries
5017ae5bc4SMatthias Ringwald // - Tag: 32 bit
5117ae5bc4SMatthias Ringwald // - Len: 32 bit
520d5520a9SMatthias Ringwald // - Delete: 32 delete field - only used with ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
5317ae5bc4SMatthias Ringwald // - Value: Len in bytes
5417ae5bc4SMatthias Ringwald 
550d5520a9SMatthias Ringwald // ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
560d5520a9SMatthias Ringwald //
570d5520a9SMatthias Ringwald // Most Flash implementations allow to:
580d5520a9SMatthias Ringwald // - erase sector -> all values are 0xff
590d5520a9SMatthias Ringwald // - write value (1s -> 0s)
60052e5e42SMatthias Ringwald // - overwrite value with zero (remaining 1s -> 0s)
610d5520a9SMatthias Ringwald //
620d5520a9SMatthias Ringwald // We use the ability to overwrite a value with zeros to mark deleted enttries (by writing zero into the tag field).
63052e5e42SMatthias Ringwald // Some targets, E.g. Kinetix K64F, do enot allow for that.
640d5520a9SMatthias Ringwald //
650d5520a9SMatthias Ringwald // With ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD an extra field is reserved to indicate a deleted tag, while keeping main logic
66052e5e42SMatthias Ringwald //
67052e5e42SMatthias Ringwald // With ENABLE_TLV_FLASH_WRITE_ONCE, tags are never marked as deleted. Instead, an emtpy tag will be written instead.
68052e5e42SMatthias Ringwald //     Also, lookup and migrate requires to always search until the end of the valid bank
69052e5e42SMatthias Ringwald 
70052e5e42SMatthias Ringwald #if defined (ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD) && defined (ENABLE_TLV_FLASH_WRITE_ONCE)
71052e5e42SMatthias Ringwald #error "Please define either ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD or ENABLE_TLV_FLASH_WRITE_ONCE"
72052e5e42SMatthias Ringwald #endif
730d5520a9SMatthias Ringwald 
74b6c12bd6SMatthias Ringwald #define BTSTACK_TLV_BANK_HEADER_LEN  8
759b112178SMatthias Ringwald #define BTSTACK_TLV_ENTRY_HEADER_LEN 8
76e8efffc8SMatthias Ringwald 
77372a3556SMatthias Ringwald #ifndef BTSTACK_FLASH_ALIGNMENT_MAX
78372a3556SMatthias Ringwald #define BTSTACK_FLASH_ALIGNMENT_MAX 8
79372a3556SMatthias Ringwald #endif
80e8efffc8SMatthias Ringwald 
8117ae5bc4SMatthias Ringwald static const char * btstack_tlv_header_magic = "BTstack";
8217ae5bc4SMatthias Ringwald 
8317ae5bc4SMatthias Ringwald // TLV Iterator
8417ae5bc4SMatthias Ringwald typedef struct {
8517ae5bc4SMatthias Ringwald 	int 	 bank;
8617ae5bc4SMatthias Ringwald 	uint32_t offset;
874c7f5275SMatthias Ringwald     uint32_t size;
8817ae5bc4SMatthias Ringwald 	uint32_t tag;
8917ae5bc4SMatthias Ringwald 	uint32_t len;
9017ae5bc4SMatthias Ringwald } tlv_iterator_t;
9117ae5bc4SMatthias Ringwald 
92372a3556SMatthias Ringwald static uint32_t btstack_tlv_flash_bank_align_size(btstack_tlv_flash_bank_t * self, uint32_t size){
934c7f5275SMatthias Ringwald 	uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context);
944c7f5275SMatthias Ringwald 	return (size + alignment - 1) & ~(alignment - 1);
95372a3556SMatthias Ringwald }
96372a3556SMatthias Ringwald 
97372a3556SMatthias Ringwald // support unaligned flash read/writes
98372a3556SMatthias Ringwald // strategy: increase size to meet alignment, perform unaligned read/write of last chunk with helper buffer
99372a3556SMatthias Ringwald 
100e8efffc8SMatthias Ringwald static void btstack_tlv_flash_bank_read(btstack_tlv_flash_bank_t * self, int bank, uint32_t offset, uint8_t * buffer, uint32_t size){
101372a3556SMatthias Ringwald 
102372a3556SMatthias Ringwald 	// read main data
1031295b091SMatthias Ringwald 	uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context);
1041295b091SMatthias Ringwald 	uint32_t lower_bits = size & (alignment - 1);
105372a3556SMatthias Ringwald 	uint32_t size_aligned = size - lower_bits;
106372a3556SMatthias Ringwald 	if (size_aligned){
107372a3556SMatthias Ringwald 		self->hal_flash_bank_impl->read(self->hal_flash_bank_context, bank, offset, buffer, size_aligned);
108372a3556SMatthias Ringwald 		buffer += size_aligned;
109372a3556SMatthias Ringwald 		offset += size_aligned;
110372a3556SMatthias Ringwald 		size   -= size_aligned;
111372a3556SMatthias Ringwald 	}
112372a3556SMatthias Ringwald 
113372a3556SMatthias Ringwald 	// read last part
114372a3556SMatthias Ringwald 	if (size == 0) return;
1151295b091SMatthias Ringwald 	uint8_t alignment_block[BTSTACK_FLASH_ALIGNMENT_MAX];
1161295b091SMatthias Ringwald 	self->hal_flash_bank_impl->read(self->hal_flash_bank_context, bank, offset, alignment_block, alignment);
1171295b091SMatthias Ringwald 	uint32_t bytes_to_copy = btstack_min(alignment - lower_bits, size);
1181295b091SMatthias Ringwald 	memcpy(buffer, alignment_block, bytes_to_copy);
119e8efffc8SMatthias Ringwald }
120e8efffc8SMatthias Ringwald 
121e8efffc8SMatthias Ringwald 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){
122372a3556SMatthias Ringwald 
123372a3556SMatthias Ringwald 	// write main data
1241295b091SMatthias Ringwald 	uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context);
1251295b091SMatthias Ringwald 	uint32_t lower_bits = size & (alignment - 1);
126372a3556SMatthias Ringwald 	uint32_t size_aligned = size - lower_bits;
127372a3556SMatthias Ringwald 	if (size_aligned){
128372a3556SMatthias Ringwald 		self->hal_flash_bank_impl->write(self->hal_flash_bank_context, bank, offset, buffer, size_aligned);
129372a3556SMatthias Ringwald 		buffer += size_aligned;
130372a3556SMatthias Ringwald 		offset += size_aligned;
131372a3556SMatthias Ringwald 		size   -= size_aligned;
132e8efffc8SMatthias Ringwald 	}
133e8efffc8SMatthias Ringwald 
134372a3556SMatthias Ringwald 	// write last part
135372a3556SMatthias Ringwald 	if (size == 0) return;
1361295b091SMatthias Ringwald 	uint8_t alignment_block[BTSTACK_FLASH_ALIGNMENT_MAX];
1371295b091SMatthias Ringwald 	memset(alignment_block, 0xff, alignment);
1381295b091SMatthias Ringwald 	memcpy(alignment_block, buffer, lower_bits);
1391295b091SMatthias Ringwald 	self->hal_flash_bank_impl->write(self->hal_flash_bank_context, bank, offset, alignment_block, alignment);
140372a3556SMatthias Ringwald }
141372a3556SMatthias Ringwald 
142e8efffc8SMatthias Ringwald 
143e8efffc8SMatthias Ringwald // iterator
144e8efffc8SMatthias Ringwald 
14517ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_iterator_fetch_tag_len(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){
1464c7f5275SMatthias Ringwald     // abort if header doesn't fit into remaining space
1479b112178SMatthias Ringwald     if (it->offset + BTSTACK_TLV_ENTRY_HEADER_LEN + self->delete_tag_len >= self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){
14826c447f6SMatthias Ringwald         it->tag = 0xffffffff;
14926c447f6SMatthias Ringwald         return;
15026c447f6SMatthias Ringwald     }
15126c447f6SMatthias Ringwald 
1529b112178SMatthias Ringwald 	uint8_t entry[BTSTACK_TLV_ENTRY_HEADER_LEN];
1539b112178SMatthias Ringwald 	btstack_tlv_flash_bank_read(self, it->bank, it->offset, entry, BTSTACK_TLV_ENTRY_HEADER_LEN);
15417ae5bc4SMatthias Ringwald 	it->tag = big_endian_read_32(entry, 0);
15517ae5bc4SMatthias Ringwald 	it->len = big_endian_read_32(entry, 4);
1560d5520a9SMatthias Ringwald 
1570d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
1580d5520a9SMatthias Ringwald 	// clear tag, if delete field is set
1590d5520a9SMatthias Ringwald 	uint32_t delete_tag;
1609b112178SMatthias Ringwald 	btstack_tlv_flash_bank_read(self, it->bank, it->offset + BTSTACK_TLV_ENTRY_HEADER_LEN, (uint8_t *) &delete_tag, 4);
1610d5520a9SMatthias Ringwald 	if (delete_tag == 0){
1620d5520a9SMatthias Ringwald 		it->tag = 0;
1630d5520a9SMatthias Ringwald 	}
1640d5520a9SMatthias Ringwald #endif
16517ae5bc4SMatthias Ringwald }
16617ae5bc4SMatthias Ringwald 
16717ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_iterator_init(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it, int bank){
16817ae5bc4SMatthias Ringwald 	memset(it, 0, sizeof(tlv_iterator_t));
16917ae5bc4SMatthias Ringwald 	it->bank = bank;
170b6c12bd6SMatthias Ringwald 	it->offset = BTSTACK_TLV_BANK_HEADER_LEN;
1714c7f5275SMatthias Ringwald     it->size = self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context);
17217ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_iterator_fetch_tag_len(self, it);
17317ae5bc4SMatthias Ringwald }
17417ae5bc4SMatthias Ringwald 
1754c7f5275SMatthias Ringwald static bool btstack_tlv_flash_bank_iterator_has_next(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){
17679b7220dSMatthias Ringwald 	UNUSED(self);
1774c7f5275SMatthias Ringwald 	return it->tag != 0xffffffff;
17817ae5bc4SMatthias Ringwald }
17917ae5bc4SMatthias Ringwald 
18017ae5bc4SMatthias Ringwald static void tlv_iterator_fetch_next(btstack_tlv_flash_bank_t * self, tlv_iterator_t * it){
1819b112178SMatthias Ringwald 	it->offset += BTSTACK_TLV_ENTRY_HEADER_LEN + btstack_tlv_flash_bank_align_size(self, it->len);
1820d5520a9SMatthias Ringwald 
1830d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
1840d5520a9SMatthias Ringwald 	// skip delete field
1855ff6a55bSMatthias Ringwald 	it->offset += self->delete_tag_len;
1860d5520a9SMatthias Ringwald #endif
1870d5520a9SMatthias Ringwald 
1884c7f5275SMatthias Ringwald 	if (it->offset >= it->size) {
18917ae5bc4SMatthias Ringwald 		it->tag = 0xffffffff;
19017ae5bc4SMatthias Ringwald 		it->len = 0;
19117ae5bc4SMatthias Ringwald 		return;
19217ae5bc4SMatthias Ringwald 	}
19317ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_iterator_fetch_tag_len(self, it);
19417ae5bc4SMatthias Ringwald }
19517ae5bc4SMatthias Ringwald 
19617ae5bc4SMatthias Ringwald //
19717ae5bc4SMatthias Ringwald 
19817ae5bc4SMatthias Ringwald // check both banks for headers and pick the one with the higher epoch % 4
19917ae5bc4SMatthias Ringwald // @returns bank or -1 if something is invalid
20017ae5bc4SMatthias Ringwald static int btstack_tlv_flash_bank_get_latest_bank(btstack_tlv_flash_bank_t * self){
201b6c12bd6SMatthias Ringwald  	uint8_t header0[BTSTACK_TLV_BANK_HEADER_LEN];
202b6c12bd6SMatthias Ringwald  	uint8_t header1[BTSTACK_TLV_BANK_HEADER_LEN];
203b6c12bd6SMatthias Ringwald  	btstack_tlv_flash_bank_read(self, 0, 0, &header0[0], BTSTACK_TLV_BANK_HEADER_LEN);
204b6c12bd6SMatthias Ringwald  	btstack_tlv_flash_bank_read(self, 1, 0, &header1[0], BTSTACK_TLV_BANK_HEADER_LEN);
205b6c12bd6SMatthias Ringwald  	int valid0 = memcmp(header0, btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1) == 0;
206b6c12bd6SMatthias Ringwald  	int valid1 = memcmp(header1, btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1) == 0;
20717ae5bc4SMatthias Ringwald 	if (!valid0 && !valid1) return -1;
20817ae5bc4SMatthias Ringwald 	if ( valid0 && !valid1) return 0;
20917ae5bc4SMatthias Ringwald 	if (!valid0 &&  valid1) return 1;
210b6c12bd6SMatthias Ringwald 	int epoch0 = header0[BTSTACK_TLV_BANK_HEADER_LEN-1] & 0x03;
211b6c12bd6SMatthias Ringwald 	int epoch1 = header1[BTSTACK_TLV_BANK_HEADER_LEN-1] & 0x03;
21217ae5bc4SMatthias Ringwald 	if (epoch0 == ((epoch1 + 1) & 0x03)) return 0;
21317ae5bc4SMatthias Ringwald 	if (epoch1 == ((epoch0 + 1) & 0x03)) return 1;
21417ae5bc4SMatthias Ringwald 	return -1;	// invalid, must not happen
21517ae5bc4SMatthias Ringwald }
21617ae5bc4SMatthias Ringwald 
21717ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_write_header(btstack_tlv_flash_bank_t * self, int bank, int epoch){
218b6c12bd6SMatthias Ringwald 	uint8_t header[BTSTACK_TLV_BANK_HEADER_LEN];
219b6c12bd6SMatthias Ringwald 	memcpy(&header[0], btstack_tlv_header_magic, BTSTACK_TLV_BANK_HEADER_LEN-1);
220b6c12bd6SMatthias Ringwald 	header[BTSTACK_TLV_BANK_HEADER_LEN-1] = epoch;
221b6c12bd6SMatthias Ringwald 	btstack_tlv_flash_bank_write(self, bank, 0, header, BTSTACK_TLV_BANK_HEADER_LEN);
22217ae5bc4SMatthias Ringwald }
22317ae5bc4SMatthias Ringwald 
22417ae5bc4SMatthias Ringwald /**
22517ae5bc4SMatthias Ringwald  * @brief Check if erased from offset
22617ae5bc4SMatthias Ringwald  */
22717ae5bc4SMatthias Ringwald static int btstack_tlv_flash_bank_test_erased(btstack_tlv_flash_bank_t * self, int bank, uint32_t offset){
22897d2cfbcSMatthias Ringwald 	log_info("test erased: bank %u, offset %u", bank, (unsigned int) offset);
22917ae5bc4SMatthias Ringwald 	uint32_t size = self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context);
23017ae5bc4SMatthias Ringwald 	uint8_t buffer[16];
23117ae5bc4SMatthias Ringwald 	uint8_t empty16[16];
23217ae5bc4SMatthias Ringwald 	memset(empty16, 0xff, sizeof(empty16));
23317ae5bc4SMatthias Ringwald 	while (offset < size){
23417ae5bc4SMatthias Ringwald 		uint32_t copy_size = (offset + sizeof(empty16) < size) ? sizeof(empty16) : (size - offset);
235e8efffc8SMatthias Ringwald 		btstack_tlv_flash_bank_read(self, bank, offset, buffer, copy_size);
2364c7f5275SMatthias Ringwald 		if (memcmp(buffer, empty16, copy_size) != 0) {
23797d2cfbcSMatthias Ringwald 			log_info("not erased %x - %x", (unsigned int) offset, (unsigned int) (offset + copy_size));
23817ae5bc4SMatthias Ringwald 			return 0;
23917ae5bc4SMatthias Ringwald 		}
24017ae5bc4SMatthias Ringwald 		offset += copy_size;
24117ae5bc4SMatthias Ringwald 	}
24217ae5bc4SMatthias Ringwald 	return 1;
24317ae5bc4SMatthias Ringwald }
24417ae5bc4SMatthias Ringwald 
24517ae5bc4SMatthias Ringwald /**
24617ae5bc4SMatthias Ringwald  * @brief erase bank (only if not already erased)
24717ae5bc4SMatthias Ringwald  */
24817ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_erase_bank(btstack_tlv_flash_bank_t * self, int bank){
24917ae5bc4SMatthias Ringwald 	if (btstack_tlv_flash_bank_test_erased(self, bank, 0)){
25017ae5bc4SMatthias Ringwald 		log_info("bank %u already erased", bank);
25117ae5bc4SMatthias Ringwald 	} else {
25217ae5bc4SMatthias Ringwald 		log_info("bank %u not empty, erase bank", bank);
25317ae5bc4SMatthias Ringwald 		self->hal_flash_bank_impl->erase(self->hal_flash_bank_context, bank);
25417ae5bc4SMatthias Ringwald 	}
25517ae5bc4SMatthias Ringwald }
25617ae5bc4SMatthias Ringwald 
25717ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_migrate(btstack_tlv_flash_bank_t * self){
25817ae5bc4SMatthias Ringwald 
25917ae5bc4SMatthias Ringwald 	int next_bank = 1 - self->current_bank;
26017ae5bc4SMatthias Ringwald 	log_info("migrate bank %u -> bank %u", self->current_bank, next_bank);
26117ae5bc4SMatthias Ringwald 	// erase bank (if needed)
26217ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_erase_bank(self, next_bank);
263b6c12bd6SMatthias Ringwald 	int next_write_pos = BTSTACK_TLV_BANK_HEADER_LEN;
26417ae5bc4SMatthias Ringwald 
26517ae5bc4SMatthias Ringwald 	tlv_iterator_t it;
26617ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank);
26717ae5bc4SMatthias Ringwald 	while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){
26817ae5bc4SMatthias Ringwald 		// skip deleted entries
26917ae5bc4SMatthias Ringwald 		if (it.tag) {
27017ae5bc4SMatthias Ringwald 			uint32_t tag_len = it.len;
27117ae5bc4SMatthias Ringwald 			uint32_t tag_index = it.offset;
27217ae5bc4SMatthias Ringwald 
273052e5e42SMatthias Ringwald             bool tag_valid = true;
274052e5e42SMatthias Ringwald 
275052e5e42SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_WRITE_ONCE
276052e5e42SMatthias Ringwald             // search until end for newer entry of same tag
277052e5e42SMatthias Ringwald             tlv_iterator_t it2;
278052e5e42SMatthias Ringwald             memcpy(&it2, &it, sizeof(tlv_iterator_t));
279052e5e42SMatthias Ringwald             while (btstack_tlv_flash_bank_iterator_has_next(self, &it2)){
280052e5e42SMatthias Ringwald                 if ((it2.offset != it.offset) && (it2.tag == it.tag)){
281052e5e42SMatthias Ringwald                     tag_valid = false;
282052e5e42SMatthias Ringwald                     break;
283052e5e42SMatthias Ringwald                 }
284052e5e42SMatthias Ringwald                 tlv_iterator_fetch_next(self, &it2);
285052e5e42SMatthias Ringwald             }
286052e5e42SMatthias Ringwald             if (tag_valid == false){
287052e5e42SMatthias Ringwald 			    log_info("skip pos %u, tag '%x' as newer entry found at %u", (unsigned int) tag_index, (unsigned int) it.tag,
288052e5e42SMatthias Ringwald                     (unsigned int) it2.offset);
289052e5e42SMatthias Ringwald             }
290052e5e42SMatthias Ringwald #endif
291052e5e42SMatthias Ringwald 
292052e5e42SMatthias Ringwald             if (tag_valid) {
293052e5e42SMatthias Ringwald 
29497d2cfbcSMatthias Ringwald                 log_info("migrate pos %u, tag '%x' len %u -> new pos %u",
29597d2cfbcSMatthias Ringwald                          (unsigned int) tag_index, (unsigned int) it.tag, (unsigned int) tag_len, next_write_pos);
2960d5520a9SMatthias Ringwald 
2970d5520a9SMatthias Ringwald                 // copy header
2989b112178SMatthias Ringwald                 uint8_t header_buffer[BTSTACK_TLV_ENTRY_HEADER_LEN];
2999b112178SMatthias Ringwald                 btstack_tlv_flash_bank_read(self, self->current_bank, tag_index, header_buffer, BTSTACK_TLV_ENTRY_HEADER_LEN);
3009b112178SMatthias Ringwald                 btstack_tlv_flash_bank_write(self, next_bank, next_write_pos, header_buffer, BTSTACK_TLV_ENTRY_HEADER_LEN);
3019b112178SMatthias Ringwald                 tag_index      += BTSTACK_TLV_ENTRY_HEADER_LEN;
3029b112178SMatthias Ringwald                 next_write_pos += BTSTACK_TLV_ENTRY_HEADER_LEN;
3030d5520a9SMatthias Ringwald 
3040d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
3050d5520a9SMatthias Ringwald                 // skip delete field
3065ff6a55bSMatthias Ringwald                 tag_index      += self->delete_tag_len;
3075ff6a55bSMatthias Ringwald                 next_write_pos += self->delete_tag_len;
3080d5520a9SMatthias Ringwald #endif
3090d5520a9SMatthias Ringwald                 // copy value
3100d5520a9SMatthias Ringwald                 int bytes_to_copy = tag_len;
31117ae5bc4SMatthias Ringwald                 uint8_t copy_buffer[32];
31217ae5bc4SMatthias Ringwald                 while (bytes_to_copy) {
31317ae5bc4SMatthias Ringwald                     int bytes_this_iteration = btstack_min(bytes_to_copy, sizeof(copy_buffer));
314e8efffc8SMatthias Ringwald                     btstack_tlv_flash_bank_read(self, self->current_bank, tag_index, copy_buffer, bytes_this_iteration);
315e8efffc8SMatthias Ringwald                     btstack_tlv_flash_bank_write(self, next_bank, next_write_pos, copy_buffer, bytes_this_iteration);
31617ae5bc4SMatthias Ringwald                     tag_index += bytes_this_iteration;
31717ae5bc4SMatthias Ringwald                     next_write_pos += bytes_this_iteration;
31817ae5bc4SMatthias Ringwald                     bytes_to_copy -= bytes_this_iteration;
31917ae5bc4SMatthias Ringwald                 }
32017ae5bc4SMatthias Ringwald             }
321052e5e42SMatthias Ringwald 		}
32217ae5bc4SMatthias Ringwald 		tlv_iterator_fetch_next(self, &it);
32317ae5bc4SMatthias Ringwald 	}
32417ae5bc4SMatthias Ringwald 
32517ae5bc4SMatthias Ringwald 	// prepare new one
32617ae5bc4SMatthias Ringwald 	uint8_t epoch_buffer;
327b6c12bd6SMatthias Ringwald 	btstack_tlv_flash_bank_read(self, self->current_bank, BTSTACK_TLV_BANK_HEADER_LEN-1, &epoch_buffer, 1);
32817ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_write_header(self, next_bank, (epoch_buffer + 1) & 3);
32917ae5bc4SMatthias Ringwald 	self->current_bank = next_bank;
33017ae5bc4SMatthias Ringwald 	self->write_offset = next_write_pos;
33117ae5bc4SMatthias Ringwald }
33217ae5bc4SMatthias Ringwald 
333052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
33417ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_delete_tag_until_offset(btstack_tlv_flash_bank_t * self, uint32_t tag, uint32_t offset){
33517ae5bc4SMatthias Ringwald 	tlv_iterator_t it;
33617ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank);
33717ae5bc4SMatthias Ringwald 	while (btstack_tlv_flash_bank_iterator_has_next(self, &it) && it.offset < offset){
33817ae5bc4SMatthias Ringwald 		if (it.tag == tag){
33997d2cfbcSMatthias Ringwald 			log_info("Erase tag '%x' at position %u", (unsigned int) tag, (unsigned int) it.offset);
3400d5520a9SMatthias Ringwald 
3410d5520a9SMatthias Ringwald 			// mark entry as invalid
3420d5520a9SMatthias Ringwald 			uint32_t zero_value = 0;
3430d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
3449b112178SMatthias Ringwald 			// write delete field after entry header
3459b112178SMatthias Ringwald 			btstack_tlv_flash_bank_write(self, self->current_bank, it.offset+BTSTACK_TLV_ENTRY_HEADER_LEN, (uint8_t*) &zero_value, sizeof(zero_value));
3460d5520a9SMatthias Ringwald #else
3470d5520a9SMatthias Ringwald 			// overwrite tag with zero value
3480d5520a9SMatthias Ringwald 			btstack_tlv_flash_bank_write(self, self->current_bank, it.offset, (uint8_t*) &zero_value, sizeof(zero_value));
3490d5520a9SMatthias Ringwald #endif
3500d5520a9SMatthias Ringwald 
35117ae5bc4SMatthias Ringwald 		}
35217ae5bc4SMatthias Ringwald 		tlv_iterator_fetch_next(self, &it);
35317ae5bc4SMatthias Ringwald 	}
35417ae5bc4SMatthias Ringwald }
355052e5e42SMatthias Ringwald #endif
35617ae5bc4SMatthias Ringwald 
35717ae5bc4SMatthias Ringwald /**
35817ae5bc4SMatthias Ringwald  * Get Value for Tag
35917ae5bc4SMatthias Ringwald  * @param tag
36017ae5bc4SMatthias Ringwald  * @param buffer
36117ae5bc4SMatthias Ringwald  * @param buffer_size
36217ae5bc4SMatthias Ringwald  * @returns size of value
36317ae5bc4SMatthias Ringwald  */
36417ae5bc4SMatthias Ringwald static int btstack_tlv_flash_bank_get_tag(void * context, uint32_t tag, uint8_t * buffer, uint32_t buffer_size){
36517ae5bc4SMatthias Ringwald 
36617ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context;
36717ae5bc4SMatthias Ringwald 
36817ae5bc4SMatthias Ringwald 	uint32_t tag_index = 0;
36917ae5bc4SMatthias Ringwald 	uint32_t tag_len   = 0;
37017ae5bc4SMatthias Ringwald 	tlv_iterator_t it;
37117ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank);
37217ae5bc4SMatthias Ringwald 	while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){
37317ae5bc4SMatthias Ringwald 		if (it.tag == tag){
37497d2cfbcSMatthias Ringwald 			log_info("Found tag '%x' at position %u", (unsigned int) tag, (unsigned int) it.offset);
37517ae5bc4SMatthias Ringwald 			tag_index = it.offset;
37617ae5bc4SMatthias Ringwald 			tag_len   = it.len;
377052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
37817ae5bc4SMatthias Ringwald 			break;
379052e5e42SMatthias Ringwald #endif
38017ae5bc4SMatthias Ringwald 		}
38117ae5bc4SMatthias Ringwald 		tlv_iterator_fetch_next(self, &it);
38217ae5bc4SMatthias Ringwald 	}
38317ae5bc4SMatthias Ringwald 	if (tag_index == 0) return 0;
38417ae5bc4SMatthias Ringwald 	if (!buffer) return tag_len;
38517ae5bc4SMatthias Ringwald 	int copy_size = btstack_min(buffer_size, tag_len);
3869b112178SMatthias Ringwald 	uint32_t value_offset = tag_index + BTSTACK_TLV_ENTRY_HEADER_LEN;
3870d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
3880d5520a9SMatthias Ringwald 	// skip delete field
3895ff6a55bSMatthias Ringwald 	value_offset += self->delete_tag_len;
3900d5520a9SMatthias Ringwald #endif
3910d5520a9SMatthias Ringwald 	btstack_tlv_flash_bank_read(self, self->current_bank, value_offset, buffer, copy_size);
39217ae5bc4SMatthias Ringwald 	return copy_size;
39317ae5bc4SMatthias Ringwald }
39417ae5bc4SMatthias Ringwald 
39517ae5bc4SMatthias Ringwald /**
39617ae5bc4SMatthias Ringwald  * Store Tag
39717ae5bc4SMatthias Ringwald  * @param tag
39817ae5bc4SMatthias Ringwald  * @param data
39917ae5bc4SMatthias Ringwald  * @param data_size
40017ae5bc4SMatthias Ringwald  */
40117ae5bc4SMatthias Ringwald static int btstack_tlv_flash_bank_store_tag(void * context, uint32_t tag, const uint8_t * data, uint32_t data_size){
40217ae5bc4SMatthias Ringwald 
40317ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context;
40417ae5bc4SMatthias Ringwald 
40517ae5bc4SMatthias Ringwald 	// trigger migration if not enough space
4069b112178SMatthias Ringwald 	uint32_t required_space = BTSTACK_TLV_ENTRY_HEADER_LEN + self->delete_tag_len + data_size;
4075ff6a55bSMatthias Ringwald 	if (self->write_offset + required_space > self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){
40817ae5bc4SMatthias Ringwald 		btstack_tlv_flash_bank_migrate(self);
40917ae5bc4SMatthias Ringwald 	}
41017ae5bc4SMatthias Ringwald 
4115ff6a55bSMatthias Ringwald 	if (self->write_offset + required_space > self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){
41217ae5bc4SMatthias Ringwald 		log_error("couldn't write entry, not enough space left");
41317ae5bc4SMatthias Ringwald 		return 2;
41417ae5bc4SMatthias Ringwald 	}
41517ae5bc4SMatthias Ringwald 
41617ae5bc4SMatthias Ringwald 	// prepare entry
4179b112178SMatthias Ringwald 	uint8_t entry[BTSTACK_TLV_ENTRY_HEADER_LEN];
41817ae5bc4SMatthias Ringwald 	big_endian_store_32(entry, 0, tag);
41917ae5bc4SMatthias Ringwald 	big_endian_store_32(entry, 4, data_size);
42017ae5bc4SMatthias Ringwald 
42179b7220dSMatthias Ringwald 	log_info("write '%" PRIx32 "', len %" PRIu32 " at %" PRIx32, tag, data_size, self->write_offset);
42217ae5bc4SMatthias Ringwald 
4239b112178SMatthias Ringwald 	uint32_t value_offset = self->write_offset + BTSTACK_TLV_ENTRY_HEADER_LEN;
4240d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
4250d5520a9SMatthias Ringwald 	// skip delete field
4265ff6a55bSMatthias Ringwald 	value_offset += self->delete_tag_len;
4270d5520a9SMatthias Ringwald #endif
4280d5520a9SMatthias Ringwald 
42917ae5bc4SMatthias Ringwald 	// write value first
4300d5520a9SMatthias Ringwald 	btstack_tlv_flash_bank_write(self, self->current_bank, value_offset, data, data_size);
43117ae5bc4SMatthias Ringwald 
43217ae5bc4SMatthias Ringwald 	// then entry
433e8efffc8SMatthias Ringwald 	btstack_tlv_flash_bank_write(self, self->current_bank, self->write_offset, entry, sizeof(entry));
43417ae5bc4SMatthias Ringwald 
435052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
43617ae5bc4SMatthias Ringwald 	// overwrite old entries (if exists)
43717ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_delete_tag_until_offset(self, tag, self->write_offset);
438052e5e42SMatthias Ringwald #endif
43917ae5bc4SMatthias Ringwald 
44017ae5bc4SMatthias Ringwald 	// done
441372a3556SMatthias Ringwald 	self->write_offset += sizeof(entry) + btstack_tlv_flash_bank_align_size(self, data_size);
44217ae5bc4SMatthias Ringwald 
4430d5520a9SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
4440d5520a9SMatthias Ringwald 	// skip delete field
4455ff6a55bSMatthias Ringwald 	self->write_offset += self->delete_tag_len;
4460d5520a9SMatthias Ringwald #endif
4470d5520a9SMatthias Ringwald 
44817ae5bc4SMatthias Ringwald 	return 0;
44917ae5bc4SMatthias Ringwald }
45017ae5bc4SMatthias Ringwald 
45117ae5bc4SMatthias Ringwald /**
45217ae5bc4SMatthias Ringwald  * Delete Tag
45317ae5bc4SMatthias Ringwald  * @param tag
45417ae5bc4SMatthias Ringwald  */
45517ae5bc4SMatthias Ringwald static void btstack_tlv_flash_bank_delete_tag(void * context, uint32_t tag){
456052e5e42SMatthias Ringwald #ifdef ENABLE_TLV_FLASH_WRITE_ONCE
457052e5e42SMatthias Ringwald     btstack_tlv_flash_bank_store_tag(context, tag, NULL, 0);
458052e5e42SMatthias Ringwald #else
45917ae5bc4SMatthias Ringwald     btstack_tlv_flash_bank_t * self = (btstack_tlv_flash_bank_t *) context;
46017ae5bc4SMatthias Ringwald 	btstack_tlv_flash_bank_delete_tag_until_offset(self, tag, self->write_offset);
461052e5e42SMatthias Ringwald #endif
46217ae5bc4SMatthias Ringwald }
46317ae5bc4SMatthias Ringwald 
46417ae5bc4SMatthias Ringwald static const btstack_tlv_t btstack_tlv_flash_bank = {
46517ae5bc4SMatthias Ringwald 	/* int  (*get_tag)(..);     */ &btstack_tlv_flash_bank_get_tag,
46617ae5bc4SMatthias Ringwald 	/* int (*store_tag)(..);    */ &btstack_tlv_flash_bank_store_tag,
46717ae5bc4SMatthias Ringwald 	/* void (*delete_tag)(v..); */ &btstack_tlv_flash_bank_delete_tag,
46817ae5bc4SMatthias Ringwald };
46917ae5bc4SMatthias Ringwald 
47017ae5bc4SMatthias Ringwald /**
47117ae5bc4SMatthias Ringwald  * Init Tag Length Value Store
47217ae5bc4SMatthias Ringwald  */
47317ae5bc4SMatthias Ringwald 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){
47417ae5bc4SMatthias Ringwald 
47517ae5bc4SMatthias Ringwald 	self->hal_flash_bank_impl    = hal_flash_bank_impl;
47617ae5bc4SMatthias Ringwald 	self->hal_flash_bank_context = hal_flash_bank_context;
4775ff6a55bSMatthias Ringwald 	self->delete_tag_len = 0;
4785ff6a55bSMatthias Ringwald 
4795ff6a55bSMatthias Ringwald #ifdef ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
4805ff6a55bSMatthias Ringwald 	if (hal_flash_bank_impl->get_alignment(hal_flash_bank_context) > 8){
4815ff6a55bSMatthias Ringwald 		log_error("Flash alignment > 8 with ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD not supported");
4825ff6a55bSMatthias Ringwald 		return NULL;
4835ff6a55bSMatthias Ringwald 	}
4845ff6a55bSMatthias Ringwald 	// set delete tag len
4851295b091SMatthias Ringwald 	uint32_t alignment = self->hal_flash_bank_impl->get_alignment(self->hal_flash_bank_context);
4861295b091SMatthias Ringwald 	self->delete_tag_len = (uint8_t) btstack_max(4, alignment);
4875ff6a55bSMatthias Ringwald 	log_info("delete tag len %u", self->delete_tag_len);
4885ff6a55bSMatthias Ringwald #endif
48917ae5bc4SMatthias Ringwald 
490*f268b03aSMatthias Ringwald     // set aligned entry header len
491*f268b03aSMatthias Ringwald     self->entry_header_len = btstack_tlv_flash_bank_align_size(self, BTSTACK_TLV_ENTRY_HEADER_LEN);
492*f268b03aSMatthias Ringwald 
49317ae5bc4SMatthias Ringwald 	// try to find current bank
49417ae5bc4SMatthias Ringwald 	self->current_bank = btstack_tlv_flash_bank_get_latest_bank(self);
49517ae5bc4SMatthias Ringwald 	log_info("found bank %d", self->current_bank);
49617ae5bc4SMatthias Ringwald 	if (self->current_bank >= 0){
49717ae5bc4SMatthias Ringwald 
49817ae5bc4SMatthias Ringwald 		// find last entry and write offset
49917ae5bc4SMatthias Ringwald 		tlv_iterator_t it;
500052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
50117ae5bc4SMatthias Ringwald 		uint32_t last_tag = 0;
50217ae5bc4SMatthias Ringwald 		uint32_t last_offset = 0;
503052e5e42SMatthias Ringwald #endif
50417ae5bc4SMatthias Ringwald         btstack_tlv_flash_bank_iterator_init(self, &it, self->current_bank);
50517ae5bc4SMatthias Ringwald 		while (btstack_tlv_flash_bank_iterator_has_next(self, &it)){
506052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
50717ae5bc4SMatthias Ringwald 			last_tag = it.tag;
50817ae5bc4SMatthias Ringwald 			last_offset = it.offset;
509052e5e42SMatthias Ringwald #endif
51017ae5bc4SMatthias Ringwald 			tlv_iterator_fetch_next(self, &it);
51117ae5bc4SMatthias Ringwald 		}
51217ae5bc4SMatthias Ringwald 		self->write_offset = it.offset;
51317ae5bc4SMatthias Ringwald 
514e195acfcSMatthias Ringwald 		if (self->write_offset <= self->hal_flash_bank_impl->get_size(self->hal_flash_bank_context)){
51517ae5bc4SMatthias Ringwald 
516052e5e42SMatthias Ringwald #ifndef ENABLE_TLV_FLASH_WRITE_ONCE
51717ae5bc4SMatthias Ringwald 			// delete older instances of last_tag
51817ae5bc4SMatthias Ringwald 			// this handles the unlikely case where MCU did reset after new value + header was written but before delete did complete
51917ae5bc4SMatthias Ringwald 			if (last_tag){
52017ae5bc4SMatthias Ringwald 				btstack_tlv_flash_bank_delete_tag_until_offset(self, last_tag, last_offset);
52117ae5bc4SMatthias Ringwald 			}
522052e5e42SMatthias Ringwald #endif
52317ae5bc4SMatthias Ringwald 
52417ae5bc4SMatthias Ringwald 			// verify that rest of bank is empty
52517ae5bc4SMatthias Ringwald 			// this handles the unlikely case where MCU did reset after new value was written, but not the tag
52617ae5bc4SMatthias Ringwald 			if (!btstack_tlv_flash_bank_test_erased(self, self->current_bank, self->write_offset)){
52717ae5bc4SMatthias Ringwald 				log_info("Flash not empty after last found tag -> migrate");
52817ae5bc4SMatthias Ringwald 				btstack_tlv_flash_bank_migrate(self);
52917ae5bc4SMatthias Ringwald 			} else {
53017ae5bc4SMatthias Ringwald 				log_info("Flash clean after last found tag");
53117ae5bc4SMatthias Ringwald 			}
53217ae5bc4SMatthias Ringwald 		} else {
53317ae5bc4SMatthias Ringwald 			// failure!
53417ae5bc4SMatthias Ringwald 			self->current_bank = -1;
53517ae5bc4SMatthias Ringwald 		}
53617ae5bc4SMatthias Ringwald 	}
53717ae5bc4SMatthias Ringwald 
53817ae5bc4SMatthias Ringwald 	if (self->current_bank < 0) {
53917ae5bc4SMatthias Ringwald 		btstack_tlv_flash_bank_erase_bank(self, 0);
54017ae5bc4SMatthias Ringwald 		self->current_bank = 0;
54117ae5bc4SMatthias Ringwald 		btstack_tlv_flash_bank_write_header(self, self->current_bank, 0);	// epoch = 0;
542b6c12bd6SMatthias Ringwald 		self->write_offset = BTSTACK_TLV_BANK_HEADER_LEN;
54317ae5bc4SMatthias Ringwald 	}
54417ae5bc4SMatthias Ringwald 
54579b7220dSMatthias Ringwald 	log_info("write offset %" PRIx32, self->write_offset);
54617ae5bc4SMatthias Ringwald 	return &btstack_tlv_flash_bank;
54717ae5bc4SMatthias Ringwald }
54817ae5bc4SMatthias Ringwald 
549