1 /* 2 * Copyright (C) 2014 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 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title Link Key DB 40 * 41 * Interface to provide link key storage. 42 * 43 */ 44 45 #ifndef BTSTACK_LINK_KEY_DB_H 46 #define BTSTACK_LINK_KEY_DB_H 47 48 #include "bluetooth.h" 49 50 #if defined __cplusplus 51 extern "C" { 52 #endif 53 54 typedef struct { 55 void * context; 56 } btstack_link_key_iterator_t; 57 58 /* API_START */ 59 typedef struct { 60 61 // management 62 63 /** 64 * @brief Open the Link Key DB 65 */ 66 void (*open)(void); 67 68 /** 69 * @brief Sets BD Addr of local Bluetooth Controller. 70 * @note Only needed if Bluetooth Controller can be swapped, e.g. USB Dongles on desktop systems 71 */ 72 void (*set_local_bd_addr)(bd_addr_t bd_addr); 73 74 /** 75 * @brief Close the Link Key DB 76 */ 77 void (*close)(void); 78 79 // get/set/delete link key 80 81 /** 82 * @brief Get Link Key for given address 83 * @param addr to lookup 84 * @param link_key (out) 85 * @param type (out) 86 * @return 1 on success 87 */ 88 int (*get_link_key)(bd_addr_t bd_addr, link_key_t link_key, link_key_type_t * type); 89 90 /** 91 * @brief Update/Store Link key 92 * @brief addr 93 * @brief link_key 94 * @brief type of link key 95 */ 96 void (*put_link_key)(bd_addr_t bd_addr, link_key_t link_key, link_key_type_t type); 97 98 /** 99 * @brief Delete Link Keys 100 * @brief addr 101 */ 102 void (*delete_link_key)(bd_addr_t bd_addr); 103 104 // iterator: it's allowed to delete 105 106 /** 107 * @brief Setup iterator 108 * @param it 109 * @return 1 on success 110 */ 111 int (*iterator_init)(btstack_link_key_iterator_t * it); 112 113 /** 114 * @brief Get next Link Key 115 * @param it 116 * @brief addr 117 * @brief link_key 118 * @brief type of link key 119 * @return 1, if valid link key found 120 */ 121 int (*iterator_get_next)(btstack_link_key_iterator_t * it, bd_addr_t bd_addr, link_key_t link_key, link_key_type_t * type); 122 123 /** 124 * @brief Frees resources allocated by iterator_init 125 * @note Must be called after iteration to free resources 126 * @param it 127 */ 128 void (*iterator_done)(btstack_link_key_iterator_t * it); 129 130 } btstack_link_key_db_t; 131 132 /* API_END */ 133 134 #if defined __cplusplus 135 } 136 #endif 137 138 #endif // BTSTACK_LINK_KEY_DB_H 139