Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
* Copyright (C) 2014 BlueKitchen GmbH
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holders nor the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
* 4. Any redistribution, use, or modification is done solely for
* personal benefit and not for any commercial purpose or for
* monetary gain.
*
* THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
* GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* Please inquire about commercial licensing options at
* contact@bluekitchen-gmbh.com
*
*/
/**
* @title Runtine ATT Database Setup
*
* Helper to construct ATT DB at runtime (BTstack GATT Compiler is not used).
*
*/
#ifndef ATT_DB_UTIL_H
#define ATT_DB_UTIL_H
#include "btstack_config.h"
#include "btstack_crypto.h"
#include <stdint.h>
#if defined __cplusplus
extern "C" {
#endif
/* API_START */
/**
* @brief Init ATT DB storage
*/
void att_db_util_init(void);
/**
* @brief Add primary service for 16-bit UUID
* @param uuid16
* @return attribute handle for the new service definition
*/
uint16_t att_db_util_add_service_uuid16(uint16_t uuid16);
/**
* @brief Add primary service for 128-bit UUID
* @param uuid128
* @return attribute handle for the new service definition
*/
uint16_t att_db_util_add_service_uuid128(const uint8_t * uuid128);
/**
* @brief Add secondary service for 16-bit UUID
* @param uuid16
* @return attribute handle for the new service definition
*/
uint16_t att_db_util_add_secondary_service_uuid16(uint16_t uuid16);
/**
* @brief Add secondary service for 128-bit UUID
* @param uuid128
* @return attribute handle for the new service definition
*/
uint16_t att_db_util_add_secondary_service_uuid128(const uint8_t * uuid128);
/**
* @brief Add included service with 16-bit UUID
* @param start_group_handle
* @param end_group_handle
* @param uuid16
* @return attribute handle for the new service definition
*/
uint16_t att_db_util_add_included_service_uuid16(uint16_t start_group_handle, uint16_t end_group_handle, uint16_t uuid16);
/**
* @brief Add Characteristic with 16-bit UUID, properties, and data
* @param uuid16
* @param properties - see ATT_PROPERTY_* in src/bluetooth.h
* @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified
* @param data_len
* @return attribute handle of the new characteristic value declaration
* @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD)
* is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1
*/
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);
/**
* @brief Add Characteristic with 128-bit UUID, properties, and data
* @param uuid128
* @param properties - see ATT_PROPERTY_* in src/bluetooth.h
* @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified
* @param data_len
* @return attribute handle of the new characteristic value declaration
* @note If properties contains ATT_PROPERTY_NOTIFY or ATT_PROPERTY_INDICATE flags, a Client Configuration Characteristic Descriptor (CCCD)
* is created as well. The attribute value handle of the CCCD is the attribute value handle plus 1
*/
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);
/**
* @brief Add descriptor with 16-bit UUID, properties, and data
* @param uuid16
* @param properties - see ATT_PROPERTY_* in src/bluetooth.h
* @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified
* @param data_len
* @return attribute handle of the new characteristic descriptor declaration
*/
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);
/**
* @brief Add descriptor with 128-bit UUID, properties, and data
* @param uuid128
* @param properties - see ATT_PROPERTY_* in src/bluetooth.h
* @param read_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param write_permissions - see ATT_SECURITY_* in src/bluetooth.h
* @param data returned in read operations if ATT_PROPERTY_DYNAMIC is not specified
* @param data_len
* @return attribute handle of the new characteristic descriptor declaration
*/
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);
/**
* @brief Get address of constructed ATT DB
*/
uint8_t * att_db_util_get_address(void);
/**
* @brief Get size of constructed ATT DB
*/
uint16_t att_db_util_get_size(void);
/**
* @brief Get number of bytes that are included in GATT Database Hash
*/
uint16_t att_db_util_hash_len(void);
/**
* @brief init generator for GATT Database Hash
*/
void att_db_util_hash_init(void);
/**
* @brief get next byte from generator for GATT Database Hash
*/
uint8_t att_db_util_hash_get_next(void);
/**
* @brief Calculate GATT Database Hash using crypto engine
* @param request
* @param db_hash
* @param callback
* @param callback_arg
*/
void att_db_util_hash_calc(btstack_crypto_aes128_cmac_t * request, uint8_t * db_hash, void (* callback)(void * arg), void * callback_arg);
/* API_END */
#if defined __cplusplus
}
#endif
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.