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 * @title Tag-Value-Length Persistent Storage (TLV) 34 * 35 * Inteface for BTstack's Tag Value Length Persistent Storage implementations 36 * used to store pairing/bonding data. 37 * 38 */ 39 40 #ifndef BTSTACK_TLV_H 41 #define BTSTACK_TLV_H 42 43 #include <stdint.h> 44 45 #if defined __cplusplus 46 extern "C" { 47 #endif 48 49 /* API_START */ 50 51 typedef struct { 52 53 /** 54 * Get Value for Tag 55 * @param context 56 * @param tag 57 * @param buffer 58 * @param buffer_size 59 * @return size of value 60 */ 61 int (*get_tag)(void * context, uint32_t tag, uint8_t * buffer, uint32_t buffer_size); 62 63 /** 64 * Store Tag 65 * @param context 66 * @param tag 67 * @param data 68 * @param data_size 69 * @return 0 on success 70 */ 71 int (*store_tag)(void * context, uint32_t tag, const uint8_t * data, uint32_t data_size); 72 73 /** 74 * Delete Tag 75 * @note it is not expected that delete operation fails, please use at least log_error in case of errors 76 * @param context 77 * @param tag 78 */ 79 void (*delete_tag)(void * context, uint32_t tag); 80 81 } btstack_tlv_t; 82 83 /** 84 * @brief Make TLV implementation available to BTstack components via Singleton 85 * @note Usually called by port after BD_ADDR was retrieved from Bluetooth Controller 86 * @param tlv_impl 87 * @param tlv_context 88 */ 89 void btstack_tlv_set_instance(const btstack_tlv_t * tlv_impl, void * tlv_context); 90 91 /** 92 * @brief Get current TLV implementation. Used for bonding information, but can be used by application, too. 93 * @param tlv_impl 94 * @param tlv_context 95 */ 96 void btstack_tlv_get_instance(const btstack_tlv_t ** tlv_impl, void ** tlv_context); 97 98 /* API_END */ 99 100 #if defined __cplusplus 101 } 102 #endif 103 #endif // BTSTACK_TLV_H 104