xref: /btstack/platform/embedded/btstack_tlv_flash_bank.h (revision f268b03a0a84e7be82f2540297a832c060d832bc)
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 /*
33  *  btstack_tlv_flash_bank.h
34  *
35  *  Implementation for BTstack's Tag Value Length Persistent Storage implementations
36  *  using hal_flash_bank storage
37  */
38 
39 #ifndef BTSTACK_TLV_FLASH_BANK_H
40 #define BTSTACK_TLV_FLASH_BANK_H
41 
42 #include <stdint.h>
43 #include "btstack_tlv.h"
44 #include "hal_flash_bank.h"
45 
46 #if defined __cplusplus
47 extern "C" {
48 #endif
49 
50 typedef struct {
51 	const    hal_flash_bank_t * hal_flash_bank_impl;
52 	void *   hal_flash_bank_context;
53     uint32_t write_offset;
54 	int8_t   current_bank;
55     uint16_t  delete_tag_len;
56     uint16_t  entry_header_len;
57 } btstack_tlv_flash_bank_t;
58 
59 /**
60  * Init Tag Length Value Store
61  * @param context btstack_tlv_flash_bank_t
62  * @param hal_flash_bank_impl    of hal_flash_bank interface
63  * @Param hal_flash_bank_context of hal_flash_bank_interface
64  */
65 const btstack_tlv_t * btstack_tlv_flash_bank_init_instance(btstack_tlv_flash_bank_t * context, const hal_flash_bank_t * hal_flash_bank_impl, void * hal_flash_bank_context);
66 
67 #if defined __cplusplus
68 }
69 #endif
70 #endif // BTSTACK_TLV_FLASH_BANK_H
71