1 /* 2 * Copyright (C) 2018 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 Bond Management Service Server 40 * 41 */ 42 43 #ifndef BOND_MANAGEMENT_SERVICE_SERVER_H 44 #define BOND_MANAGEMENT_SERVICE_SERVER_H 45 46 #include <stdint.h> 47 48 #if defined __cplusplus 49 extern "C" { 50 #endif 51 52 /** 53 * @text The Bond Management service server defines how a peer Bluetooth device can manage the storage of bond information, 54 * especially the deletion of it, on the Bluetooth device supporting this service. 55 * 56 * To use with your application, add `#import <bond_management_service.gatt>` to your .gatt file. 57 * After adding it to your .gatt file, you call *bond_management_service_server_init(supported_features)*. The input parameter "supported_features" 58 * is a bitmap, which defines how the bond information will be deleted, see BMF_DELETE_* flags below. 59 */ 60 61 /* API_START */ 62 #define BOND_MANAGEMENT_CONTROL_POINT_OPCODE_NOT_SUPPORTED 0x80 63 #define BOND_MANAGEMENT_OPERATION_FAILED 0x81 64 65 #define BMF_DELETE_ACTIVE_BOND_CLASSIC_AND_LE 0x00001 66 #define BMF_DELETE_ACTIVE_BOND_CLASSIC_AND_LE_WITH_AUTH 0x00002 67 #define BMF_DELETE_ACTIVE_BOND_CLASSIC 0x00004 68 #define BMF_DELETE_ACTIVE_BOND_CLASSIC_WITH_AUTH 0x00008 69 #define BMF_DELETE_ACTIVE_BOND_LE 0x00010 70 #define BMF_DELETE_ACTIVE_BOND_LE_WITH_AUTH 0x00020 71 #define BMF_DELETE_ALL_BONDS_CLASSIC_AND_LE 0x00040 72 #define BMF_DELETE_ALL_BONDS_CLASSIC_AND_LE_WITH_AUTH 0x00080 73 #define BMF_DELETE_ALL_BONDS_CLASSIC 0x00100 74 #define BMF_DELETE_ALL_BONDS_CLASSIC_WITH_AUTH 0x00200 75 #define BMF_DELETE_ALL_BONDS_LE 0x00400 76 #define BMF_DELETE_ALL_BONDS_LE_WITH_AUTH 0x00800 77 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC_AND_LE 0x01000 78 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC_AND_LE_WITH_AUTH 0x02000 79 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC 0x04000 80 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC_WITH_AUTH 0x08000 81 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_LE 0x10000 82 #define BMF_DELETE_ALL_BUT_ACTIVE_BOND_LE_WITH_AUT 0x20000 83 84 typedef enum { 85 BOND_MANAGEMENT_CMD_DELETE_ACTIVE_BOND_CLASSIC_AND_LE = 0x01, 86 BOND_MANAGEMENT_CMD_DELETE_ACTIVE_BOND_CLASSIC, 87 BOND_MANAGEMENT_CMD_DELETE_ACTIVE_BOND_LE, 88 BOND_MANAGEMENT_CMD_DELETE_ALL_BONDS_CLASSIC_AND_LE, 89 BOND_MANAGEMENT_CMD_DELETE_ALL_BONDS_CLASSIC, 90 BOND_MANAGEMENT_CMD_DELETE_ALL_BONDS_LE, 91 BOND_MANAGEMENT_CMD_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC_AND_LE, 92 BOND_MANAGEMENT_CMD_DELETE_ALL_BUT_ACTIVE_BOND_CLASSIC, 93 BOND_MANAGEMENT_CMD_DELETE_ALL_BUT_ACTIVE_BOND_LE 94 } bond_management_cmd_t; 95 96 /** 97 * @brief Init Bond Management Service with ATT DB 98 * @param supported_features 99 */ 100 void bond_management_service_server_init(uint32_t supported_features); 101 102 /** 103 * @brief Set authorisation string 104 * @note String is not copied 105 * @param authorisation_string 106 */ 107 void bond_management_service_server_set_authorisation_string(const char * authorisation_string); 108 109 /* API_END */ 110 111 #if defined __cplusplus 112 } 113 #endif 114 115 #endif 116 117