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 MATTHIAS 24 * RINGWALD 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 * Helper to construct ATT DB at runtime 40 * (BTstack GATT Compiler is not used) 41 */ 42 43 #ifndef __ATT_DB_UTIL 44 #define __ATT_DB_UTIL 45 46 #include "btstack_config.h" 47 # 48 #ifdef HAVE_MALLOC 49 #else 50 #endif 51 52 #include <stdint.h> 53 54 #if defined __cplusplus 55 extern "C" { 56 #endif 57 58 /* API_START */ 59 60 /** 61 * @brief Init ATT DB storage 62 */ 63 void att_db_util_init(void); 64 65 /** 66 * @brief Add primary service for 16-bit UUID 67 * @param uuid16 68 * @returns attribute handle for the new service definition 69 */ 70 uint16_t att_db_util_add_service_uuid16(uint16_t uuid16); 71 72 /** 73 * @brief Add primary service for 128-bit UUID 74 * @param uuid1286 75 * @returns attribute handle for the new service definition 76 */ 77 uint16_t att_db_util_add_service_uuid128(const uint8_t * uuid128); 78 79 /** 80 * @brief Add secondary service for 16-bit UUID 81 * @param uuid16 82 * @returns attribute handle for the new service definition 83 */ 84 uint16_t att_db_util_add_secondary_service_uuid16(uint16_t uuid16); 85 86 /** 87 * @brief Add secondary service for 128-bit UUID 88 * @param uuid1286 89 * @returns attribute handle for the new service definition 90 */ 91 uint16_t att_db_util_add_secondary_service_uuid128(const uint8_t * uuid128); 92 93 /** 94 * @brief Add Characteristic with 16-bit UUID, properties, and data 95 * @param uuid16 96 * @param properties - see ATT_PROPERTY_* in src/bluetooth.h 97 * @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h 98 * @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h 99 * @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified 100 * @param data_len 101 * @returns attribute handle of the new characteristic value declaration 102 * @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD) 103 * is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1 104 */ 105 uint16_t att_db_util_add_characteristic_uuid16(uint16_t uuid16, uint16_t properties, uint8_t read_permission, uint8_t write_permission, uint8_t * data, uint16_t data_len); 106 107 /** 108 * @brief Add Characteristic with 128-bit UUID, properties, and data 109 * @param uuid128 110 * @param properties - see ATT_PROPERTY_* in src/bluetooth.h 111 * @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h 112 * @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h 113 * @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified 114 * @param data_len 115 * @returns attribute handle of the new characteristic value declaration 116 * @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD) 117 * is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1 118 */ 119 uint16_t att_db_util_add_characteristic_uuid128(const uint8_t * uuid128, uint16_t properties, uint8_t read_permission, uint8_t write_permission, uint8_t * data, uint16_t data_len); 120 121 /** 122 * @brief Add descriptor with 16-bit UUID, properties, and data 123 * @param uuid16 124 * @param properties - see ATT_PROPERTY_* in src/bluetooth.h 125 * @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h 126 * @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h 127 * @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified 128 * @param data_len 129 * @returns attribute handle of the new characteristic descriptor declaration 130 */ 131 uint16_t att_db_util_add_descriptor_uuid16(uint16_t uuid16, uint16_t properties, uint8_t read_permission, uint8_t write_permission, uint8_t * data, uint16_t data_len); 132 133 /** 134 * @brief Add descriptor with 128-bit UUID, properties, and data 135 * @param uuid128 136 * @param properties - see ATT_PROPERTY_* in src/bluetooth.h 137 * @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h 138 * @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h 139 * @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified 140 * @param data_len 141 * @returns attribute handle of the new characteristic descriptor declaration 142 */ 143 uint16_t att_db_util_add_descriptor_uuid128(const uint8_t * uuid128, uint16_t properties, uint8_t read_permission, uint8_t write_permission, uint8_t * data, uint16_t data_len); 144 145 /** 146 * @brief Get address of constructed ATT DB 147 */ 148 uint8_t * att_db_util_get_address(void); 149 150 /** 151 * @brief Get size of constructed ATT DB 152 */ 153 uint16_t att_db_util_get_size(void); 154 155 /* API_END */ 156 157 #if defined __cplusplus 158 } 159 #endif 160 #endif 161