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