mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-01-31 00:32:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

gap: comment on link key db only working after power up

Browse Source
This commit is contained in:
Matthias Ringwald 2020-06-09 10:16:42 +02:00
parent c1e2cdaa05
commit c771037830
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/gap.h
View File

@ -516,11 +516,17 @@ void gap_local_bd_addr(bd_addr_t address_buffer);
/** /**
* @brief Deletes link key for remote device with baseband address. * @brief Deletes link key for remote device with baseband address.
* @param addr * @param addr
* @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per
* Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during
* power up, this function only works, when the stack is in working state for these ports.
*/ */
void gap_drop_link_key_for_bd_addr(bd_addr_t addr); void gap_drop_link_key_for_bd_addr(bd_addr_t addr);
/** /**
* @brief Delete all stored link keys * @brief Delete all stored link keys
* @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per
* Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during
* power up, this function only works, when the stack is in working state for these ports.
*/ */
void gap_delete_all_link_keys(void); void gap_delete_all_link_keys(void);
@ -529,6 +535,9 @@ void gap_delete_all_link_keys(void);
* @param addr * @param addr
* @param link_key * @param link_key
* @param link_key_type * @param link_key_type
* @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per
* Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during
* power up, this function only works, when the stack is in working state for these ports.
*/ */
void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type);
@ -536,6 +545,9 @@ void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_ke
* @brief Setup Link Key iterator * @brief Setup Link Key iterator
* @param it * @param it
* @returns 1 on success * @returns 1 on success
* @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per
* Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during
* power up, this function only works, when the stack is in working state for these ports.
*/ */
int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); int gap_link_key_iterator_init(btstack_link_key_iterator_t * it);
@ -546,6 +558,7 @@ int gap_link_key_iterator_init(btstack_link_key_iterator_t * it);
* @brief link_key * @brief link_key
* @brief type of link key * @brief type of link key
* @returns 1, if valid link key found * @returns 1, if valid link key found
* @see note on gap_link_key_iterator_init
*/ */
int gap_link_key_iterator_get_next(btstack_link_key_iterator_t * it, bd_addr_t bd_addr, link_key_t link_key, link_key_type_t * type); int gap_link_key_iterator_get_next(btstack_link_key_iterator_t * it, bd_addr_t bd_addr, link_key_t link_key, link_key_type_t * type);
@ -553,6 +566,7 @@ int gap_link_key_iterator_get_next(btstack_link_key_iterator_t * it, bd_addr_t b
* @brief Frees resources allocated by iterator_init * @brief Frees resources allocated by iterator_init
* @note Must be called after iteration to free resources * @note Must be called after iteration to free resources
* @param it * @param it
* @see note on gap_link_key_iterator_init
*/ */
void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); void gap_link_key_iterator_done(btstack_link_key_iterator_t * it);