xref: /btstack/src/ble/att_db_util.h (revision c32dba203d4af5ccae95e4d7b5aa9cabd63fc4ec)
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  * @returns attribute handle for the new service definition
68  */
69 uint16_t att_db_util_add_service_uuid16(uint16_t udid16);
70 
71 /**
72  * @brief Add primary service for 128-bit UUID
73  * @returns attribute handle for the new service definition
74  */
75 uint16_t att_db_util_add_service_uuid128(uint8_t * udid128);
76 
77 /**
78  * @brief Add Characteristic with 16-bit UUID, properties, and data
79  * @returns attribute handle of the new characteristic value declaration
80  * @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD)
81  *       is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1
82  * @see ATT_PROPERTY_* in ble/att_db.h
83  */
84 uint16_t att_db_util_add_characteristic_uuid16(uint16_t   udid16,  uint16_t properties, uint8_t * data, uint16_t data_len);
85 
86 /**
87  * @brief Add Characteristic with 128-bit UUID, properties, and data
88  * @returns attribute handle of the new characteristic value declaration
89  * @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD)
90  *       is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1
91  * @see ATT_PROPERTY_* in ble/att_db.h
92  */
93 uint16_t att_db_util_add_characteristic_uuid128(uint8_t * udid128, uint16_t properties, uint8_t * data, uint16_t data_len);
94 
95 /**
96 * @brief Add descriptor with 16-bit UUID, properties, and data
97 * @returns attribute handle of the new descriptor
98 * @see ATT_PROPERTY_* in ble/att_db.h
99 */
100 uint16_t att_db_util_add_descriptor_uuid16(uint16_t uuid16, uint16_t properties, uint8_t * data, uint16_t data_len);
101 
102 /**
103 * @brief Add descriptor with 128-bit UUID, properties, and data
104 * @returns attribute handle of the new characteristic descriptor declaration
105 * @see ATT_PROPERTY_* in ble/att_db.h
106 */
107 uint16_t att_db_util_add_descriptor_uuid128(uint8_t * udid128, uint16_t properties, uint8_t * data, uint16_t data_len);
108 
109 /**
110  * @brief Get address of constructed ATT DB
111  */
112 uint8_t * att_db_util_get_address(void);
113 
114 /**
115  * @brief Get size of constructed ATT DB
116  */
117 uint16_t att_db_util_get_size(void);
118 
119 /* API_END */
120 
121 #if defined __cplusplus
122 }
123 #endif
124 #endif
125