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 * @title GATT Client 40 * 41 */ 42 43 #ifndef btstack_gatt_client_h 44 #define btstack_gatt_client_h 45 46 #include "hci.h" 47 48 #if defined __cplusplus 49 extern "C" { 50 #endif 51 52 typedef enum { 53 P_READY, 54 P_W2_SEND_SERVICE_QUERY, 55 P_W4_SERVICE_QUERY_RESULT, 56 P_W2_SEND_SERVICE_WITH_UUID_QUERY, 57 P_W4_SERVICE_WITH_UUID_RESULT, 58 59 P_W2_SEND_ALL_CHARACTERISTICS_OF_SERVICE_QUERY, 60 P_W4_ALL_CHARACTERISTICS_OF_SERVICE_QUERY_RESULT, 61 P_W2_SEND_CHARACTERISTIC_WITH_UUID_QUERY, 62 P_W4_CHARACTERISTIC_WITH_UUID_QUERY_RESULT, 63 64 P_W2_SEND_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY, 65 P_W4_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT, 66 67 P_W2_SEND_INCLUDED_SERVICE_QUERY, 68 P_W4_INCLUDED_SERVICE_QUERY_RESULT, 69 P_W2_SEND_INCLUDED_SERVICE_WITH_UUID_QUERY, 70 P_W4_INCLUDED_SERVICE_UUID_WITH_QUERY_RESULT, 71 72 P_W2_SEND_READ_CHARACTERISTIC_VALUE_QUERY, 73 P_W4_READ_CHARACTERISTIC_VALUE_RESULT, 74 75 P_W2_SEND_READ_BLOB_QUERY, 76 P_W4_READ_BLOB_RESULT, 77 78 P_W2_SEND_READ_BY_TYPE_REQUEST, 79 P_W4_READ_BY_TYPE_RESPONSE, 80 81 P_W2_SEND_READ_MULTIPLE_REQUEST, 82 P_W4_READ_MULTIPLE_RESPONSE, 83 84 P_W2_SEND_WRITE_CHARACTERISTIC_VALUE, 85 P_W4_WRITE_CHARACTERISTIC_VALUE_RESULT, 86 87 P_W2_PREPARE_WRITE, 88 P_W4_PREPARE_WRITE_RESULT, 89 P_W2_PREPARE_RELIABLE_WRITE, 90 P_W4_PREPARE_RELIABLE_WRITE_RESULT, 91 92 P_W2_EXECUTE_PREPARED_WRITE, 93 P_W4_EXECUTE_PREPARED_WRITE_RESULT, 94 P_W2_CANCEL_PREPARED_WRITE, 95 P_W4_CANCEL_PREPARED_WRITE_RESULT, 96 P_W2_CANCEL_PREPARED_WRITE_DATA_MISMATCH, 97 P_W4_CANCEL_PREPARED_WRITE_DATA_MISMATCH_RESULT, 98 99 #ifdef ENABLE_GATT_FIND_INFORMATION_FOR_CCC_DISCOVERY 100 P_W2_SEND_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 101 P_W4_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 102 #else 103 P_W2_SEND_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 104 P_W4_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 105 #endif 106 P_W2_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION, 107 P_W4_CLIENT_CHARACTERISTIC_CONFIGURATION_RESULT, 108 109 P_W2_SEND_READ_CHARACTERISTIC_DESCRIPTOR_QUERY, 110 P_W4_READ_CHARACTERISTIC_DESCRIPTOR_RESULT, 111 112 P_W2_SEND_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_QUERY, 113 P_W4_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_RESULT, 114 115 P_W2_SEND_WRITE_CHARACTERISTIC_DESCRIPTOR, 116 P_W4_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 117 118 // all long writes use this 119 P_W2_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR, 120 P_W4_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 121 P_W2_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR, 122 P_W4_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 123 124 // gatt reliable write API use this (manual version of the above) 125 P_W2_PREPARE_WRITE_SINGLE, 126 P_W4_PREPARE_WRITE_SINGLE_RESULT, 127 128 P_W4_IDENTITY_RESOLVING, 129 P_W4_CMAC_READY, 130 P_W4_CMAC_RESULT, 131 P_W2_SEND_SIGNED_WRITE, 132 P_W4_SEND_SINGED_WRITE_DONE, 133 } gatt_client_state_t; 134 135 136 typedef enum{ 137 SEND_MTU_EXCHANGE, 138 SENT_MTU_EXCHANGE, 139 MTU_EXCHANGED, 140 MTU_AUTO_EXCHANGE_DISABLED 141 } gatt_client_mtu_t; 142 143 typedef struct gatt_client{ 144 btstack_linked_item_t item; 145 // TODO: rename gatt_client_state -> state 146 gatt_client_state_t gatt_client_state; 147 148 // user callback 149 btstack_packet_handler_t callback; 150 151 // can write without response callback 152 btstack_packet_handler_t write_without_response_callback; 153 154 hci_con_handle_t con_handle; 155 156 uint16_t mtu; 157 gatt_client_mtu_t mtu_state; 158 159 uint16_t uuid16; 160 uint8_t uuid128[16]; 161 162 uint16_t start_group_handle; 163 uint16_t end_group_handle; 164 165 uint16_t query_start_handle; 166 uint16_t query_end_handle; 167 168 uint8_t characteristic_properties; 169 uint16_t characteristic_start_handle; 170 171 uint16_t attribute_handle; 172 uint16_t attribute_offset; 173 uint16_t attribute_length; 174 uint8_t* attribute_value; 175 176 // read multiple characteristic values 177 uint16_t read_multiple_handle_count; 178 uint16_t * read_multiple_handles; 179 180 uint16_t client_characteristic_configuration_handle; 181 uint8_t client_characteristic_configuration_value[2]; 182 183 uint8_t filter_with_uuid; 184 uint8_t send_confirmation; 185 186 int le_device_index; 187 uint8_t cmac[8]; 188 189 btstack_timer_source_t gc_timeout; 190 191 uint8_t security_counter; 192 uint8_t wait_for_authentication_complete; 193 uint8_t pending_error_code; 194 195 bool reencryption_active; 196 uint8_t reencryption_result; 197 198 gap_security_level_t security_level; 199 200 } gatt_client_t; 201 202 typedef struct gatt_client_notification { 203 btstack_linked_item_t item; 204 btstack_packet_handler_t callback; 205 hci_con_handle_t con_handle; 206 uint16_t attribute_handle; 207 } gatt_client_notification_t; 208 209 /* API_START */ 210 211 typedef struct { 212 uint16_t start_group_handle; 213 uint16_t end_group_handle; 214 uint16_t uuid16; 215 uint8_t uuid128[16]; 216 } gatt_client_service_t; 217 218 typedef struct { 219 uint16_t start_handle; 220 uint16_t value_handle; 221 uint16_t end_handle; 222 uint16_t properties; 223 uint16_t uuid16; 224 uint8_t uuid128[16]; 225 } gatt_client_characteristic_t; 226 227 typedef struct { 228 uint16_t handle; 229 uint16_t uuid16; 230 uint8_t uuid128[16]; 231 } gatt_client_characteristic_descriptor_t; 232 233 /** 234 * @brief Set up GATT client. 235 */ 236 void gatt_client_init(void); 237 238 /** 239 * @brief Set minimum required security level for GATT Client 240 * @note The Bluetooth specification makes the GATT Server responsible to check for security. 241 * This allows an attacker to spoof an existing device with a GATT Servers, but skip the authentication part. 242 * If your application is exchanging sensitive data with a remote device, you would need to manually check 243 * the security level before sending/receive such data. 244 * With level > 0, the GATT Client triggers authentication for all GATT Requests and defers any exchange 245 * until the required security level is established. 246 * gatt_client_request_can_write_without_response_event does not trigger authentication 247 * @pram level, default LEVEL_0 (no encryption required) 248 */ 249 void gatt_client_set_required_security_level(gap_security_level_t level); 250 251 /** 252 * @brief MTU is available after the first query has completed. If status is equal to ERROR_CODE_SUCCESS, it returns the real value, otherwise the default value ATT_DEFAULT_MTU (see bluetooth.h). 253 * @param con_handle 254 * @param mtu 255 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 256 * GATT_CLIENT_IN_WRONG_STATE if MTU is not exchanged and MTU auto-exchange is disabled 257 * ERROR_CODE_SUCCESS if query is successfully registered 258 */ 259 uint8_t gatt_client_get_mtu(hci_con_handle_t con_handle, uint16_t * mtu); 260 261 /** 262 * @brief Sets whether a MTU Exchange Request shall be automatically send before the first attribute read request is send. Default is enabled. 263 * @param enabled 264 */ 265 void gatt_client_mtu_enable_auto_negotiation(uint8_t enabled); 266 267 /** 268 * @brief Sends a MTU Exchange Request, this allows for the client to exchange MTU when gatt_client_mtu_enable_auto_negotiation is disabled. 269 * @param callback 270 * @param con_handle 271 */ 272 void gatt_client_send_mtu_negotiation(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 273 274 /** 275 * @brief Returns if the GATT client is ready to receive a query. It is used with daemon. 276 * @param con_handle 277 * @return is_ready_status 0 - if no GATT client for con_handle is found, or is not ready, otherwise 1 278 */ 279 int gatt_client_is_ready(hci_con_handle_t con_handle); 280 281 /** 282 * @brief Discovers all primary services. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 283 * @param callback 284 * @param con_handle 285 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 286 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 287 * ERROR_CODE_SUCCESS , if query is successfully registered 288 */ 289 uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 290 291 /** 292 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 293 * @param callback 294 * @param con_handle 295 * @param uuid16 296 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 297 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 298 * ERROR_CODE_SUCCESS , if query is successfully registered 299 */ 300 uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16); 301 302 /** 303 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 304 * @param callback 305 * @param con_handle 306 * @param uuid128 307 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 308 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 309 * ERROR_CODE_SUCCESS , if query is successfully registered 310 */ 311 uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid128); 312 313 /** 314 * @brief Finds included services within the specified service. For each found included service, an le_service_event_t with type set to GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. Information about included service type (primary/secondary) can be retrieved either by sending an ATT find information request for the returned start group handle (returning the handle and the UUID for primary or secondary service) or by comparing the service to the list of all primary services. 315 * @param callback 316 * @param con_handle 317 * @param service 318 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 319 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 320 * ERROR_CODE_SUCCESS , if query is successfully registered 321 */ 322 uint8_t gatt_client_find_included_services_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service); 323 324 /** 325 * @brief Discovers all characteristics within the specified service. For each found characteristic, an le_characteristics_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 326 * @param callback 327 * @param con_handle 328 * @param service 329 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 330 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 331 * ERROR_CODE_SUCCESS , if query is successfully registered 332 */ 333 uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service); 334 335 /** 336 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 337 * @param callback 338 * @param con_handle 339 * @param start_handle 340 * @param end_handle 341 * @param uuid16 342 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 343 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 344 * ERROR_CODE_SUCCESS , if query is successfully registered 345 */ 346 uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint16_t uuid16); 347 348 /** 349 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 350 * @param callback 351 * @param con_handle 352 * @param start_handle 353 * @param end_handle 354 * @param uuid128 355 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 356 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 357 * ERROR_CODE_SUCCESS , if query is successfully registered 358 */ 359 uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, const uint8_t * uuid128); 360 361 /** 362 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 363 * @param callback 364 * @param con_handle 365 * @param service 366 * @param uuid16 367 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 368 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 369 * ERROR_CODE_SUCCESS , if query is successfully registered 370 */ 371 uint8_t gatt_client_discover_characteristics_for_service_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service, uint16_t uuid16); 372 373 /** 374 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 375 * @param callback 376 * @param con_handle 377 * @param service 378 * @param uuid128 379 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 380 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 381 * ERROR_CODE_SUCCESS , if query is successfully registered 382 */ 383 uint8_t gatt_client_discover_characteristics_for_service_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service, const uint8_t * uuid128); 384 385 /** 386 * @brief Discovers attribute handle and UUID of a characteristic descriptor within the specified characteristic. For each found descriptor, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 387 * @param callback 388 * @param con_handle 389 * @param characteristic 390 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 391 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 392 * ERROR_CODE_SUCCESS , if query is successfully registered 393 */ 394 uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 395 396 /** 397 * @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 398 * @param callback 399 * @param con_handle 400 * @param characteristic 401 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 402 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 403 * ERROR_CODE_SUCCESS , if query is successfully registered 404 */ 405 uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 406 407 /** 408 * @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 409 * @param callback 410 * @param con_handle 411 * @param value_handle 412 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 413 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 414 * ERROR_CODE_SUCCESS , if query is successfully registered 415 */ 416 uint8_t gatt_client_read_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle); 417 418 /** 419 * @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 420 * @param callback 421 * @param con_handle 422 * @param start_handle 423 * @param end_handle 424 * @param uuid16 425 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 426 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 427 * ERROR_CODE_SUCCESS , if query is successfully registered 428 */ 429 uint8_t gatt_client_read_value_of_characteristics_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint16_t uuid16); 430 431 /** 432 * @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 433 * @param callback 434 * @param con_handle 435 * @param start_handle 436 * @param end_handle 437 * @param uuid128 438 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 439 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 440 * ERROR_CODE_SUCCESS , if query is successfully registered 441 */ 442 uint8_t gatt_client_read_value_of_characteristics_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, const uint8_t * uuid128); 443 444 /** 445 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 446 * @param callback 447 * @param con_handle 448 * @param characteristic 449 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 450 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 451 * ERROR_CODE_SUCCESS , if query is successfully registered 452 */ 453 uint8_t gatt_client_read_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 454 455 /** 456 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 457 * @param callback 458 * @param con_handle 459 * @param value_handle 460 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 461 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 462 * ERROR_CODE_SUCCESS , if query is successfully registered 463 */ 464 uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle); 465 466 /** 467 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 468 * @param callback 469 * @param con_handle 470 * @param value_handle 471 * @param offset 472 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 473 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 474 * ERROR_CODE_SUCCESS , if query is successfully registered 475 */ 476 uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t offset); 477 478 /* 479 * @brief Read multiple characteristic values 480 * @param callback 481 * @param con_handle 482 * @param num_value_handles 483 * @param value_handles list of handles 484 */ 485 uint8_t gatt_client_read_multiple_characteristic_values(btstack_packet_handler_t callback, hci_con_handle_t con_handle, int num_value_handles, uint16_t * value_handles); 486 487 /** 488 * @brief Writes the characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 489 * @param con_handle 490 * @param value_handle 491 * @param value_length 492 * @param value is not copied, make sure memory is accessible until write is done 493 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 494 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 495 * BTSTACK_ACL_BUFFERS_FULL , if L2CAP cannot send, there are no free ACL slots 496 * ERROR_CODE_SUCCESS , if query is successfully registered 497 */ 498 uint8_t gatt_client_write_value_of_characteristic_without_response(hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 499 500 /** 501 * @brief Writes the authenticated characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 502 * @note GATT_EVENT_QUERY_COMPLETE is emitted with 0 for success or ATT_ERROR_BONDING_INFORMATION_MISSING if there is no bonding information stored 503 * @param callback 504 * @param con_handle 505 * @param value_handle 506 * @param message_len 507 * @param message is not copied, make sure memory is accessible until write is done 508 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 509 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 510 * ERROR_CODE_SUCCESS if query is successfully registered 511 */ 512 uint8_t gatt_client_signed_write_without_response(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t message_len, uint8_t * message); 513 514 /** 515 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 516 * @param callback 517 * @param con_handle 518 * @param value_handle 519 * @param value_length 520 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 521 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 522 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 523 * ERROR_CODE_SUCCESS if query is successfully registered 524 */ 525 uint8_t gatt_client_write_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 526 527 /** 528 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 529 * @param callback 530 * @param con_handle 531 * @param value_handle 532 * @param value_length 533 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 534 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 535 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 536 * ERROR_CODE_SUCCESS if query is successfully registered 537 */ 538 uint8_t gatt_client_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 539 540 /** 541 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 542 * @param callback 543 * @param con_handle 544 * @param value_handle 545 * @param offset of value 546 * @param value_length 547 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 548 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 549 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 550 * ERROR_CODE_SUCCESS if query is successfully registered 551 */ 552 uint8_t gatt_client_write_long_value_of_characteristic_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t offset, uint16_t value_length, uint8_t * value); 553 554 /** 555 * @brief Writes of the long characteristic value using the characteristic's value handle. It uses server response to validate that the write was correctly received. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 556 * @param callback 557 * @param con_handle 558 * @param value_handle 559 * @param value_length 560 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 561 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 562 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 563 * ERROR_CODE_SUCCESS if query is successfully registered 564 */ 565 uint8_t gatt_client_reliable_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 566 567 /** 568 * @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 569 * @param callback 570 * @param con_handle 571 * @param descriptor 572 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 573 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 574 * ERROR_CODE_SUCCESS if query is successfully registered 575 */ 576 uint8_t gatt_client_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 577 578 /** 579 * @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 580 * @param callback 581 * @param con_handle 582 * @param descriptor 583 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 584 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 585 * ERROR_CODE_SUCCESS if query is successfully registered 586 */ 587 uint8_t gatt_client_read_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle); 588 589 /** 590 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 591 * @param callback 592 * @param con_handle 593 * @param descriptor 594 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 595 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 596 * ERROR_CODE_SUCCESS if query is successfully registered 597 */ 598 uint8_t gatt_client_read_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 599 600 /** 601 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 602 * @param callback 603 * @param con_handle 604 * @param descriptor_handle 605 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 606 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 607 * ERROR_CODE_SUCCESS if query is successfully registered 608 */ 609 uint8_t gatt_client_read_long_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle); 610 611 /** 612 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 613 * @param callback 614 * @param con_handle 615 * @param descriptor_handle 616 * @param offset 617 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 618 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 619 * ERROR_CODE_SUCCESS if query is successfully registered 620 */ 621 uint8_t gatt_client_read_long_characteristic_descriptor_using_descriptor_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t offset); 622 623 /** 624 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 625 * @param callback 626 * @param con_handle 627 * @param descriptor 628 * @param value_length 629 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 630 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 631 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 632 * ERROR_CODE_SUCCESS if query is successfully registered 633 */ 634 uint8_t gatt_client_write_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t value_length, uint8_t * value); 635 636 /** 637 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 638 * @param callback 639 * @param con_handle 640 * @param descriptor_handle 641 * @param value_length 642 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 643 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 644 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 645 * ERROR_CODE_SUCCESS if query is successfully registered 646 */ 647 uint8_t gatt_client_write_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t value_length, uint8_t * value); 648 649 /** 650 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 651 * @param callback 652 * @param con_handle 653 * @param descriptor 654 * @param value_length 655 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 656 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 657 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 658 * ERROR_CODE_SUCCESS if query is successfully registered 659 */ 660 uint8_t gatt_client_write_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t value_length, uint8_t * value); 661 662 /** 663 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 664 * @param callback 665 * @param con_handle 666 * @param descriptor_handle 667 * @param value_length 668 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 669 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 670 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 671 * ERROR_CODE_SUCCESS if query is successfully registered 672 */ 673 uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t value_length, uint8_t * value); 674 675 /** 676 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 677 * @param callback 678 * @param con_handle 679 * @param descriptor_handle 680 * @param offset of value 681 * @param value_length 682 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 683 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 684 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 685 * ERROR_CODE_SUCCESS if query is successfully registered 686 */ 687 uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t offset, uint16_t value_length, uint8_t * value); 688 689 /** 690 * @brief Writes the client characteristic configuration of the specified characteristic. It is used to subscribe for notifications or indications of the characteristic value. 691 * For notifications or indications specify: GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION resp. GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION as configuration value. 692 * The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS 693 * (see bluetooth.h for ATT_ERROR codes). 694 * @param callback 695 * @param con_handle 696 * @param characteristic 697 * @param configuration GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 698 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 699 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 700 * GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED if configuring notification, but characteristic has no notification property set 701 * GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED if configuring indication, but characteristic has no indication property set 702 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if configuration is invalid 703 * ERROR_CODE_SUCCESS if query is successfully registered 704 */ 705 uint8_t gatt_client_write_client_characteristic_configuration(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic, uint16_t configuration); 706 707 /** 708 * @brief Register for notifications and indications of a characteristic enabled by gatt_client_write_client_characteristic_configuration 709 * @param notification struct used to store registration 710 * @param callback 711 * @param con_handle or GATT_CLIENT_ANY_CONNECTION to receive updates from all connected devices 712 * @param characteristic or NULL to receive updates for all characteristics 713 */ 714 void gatt_client_listen_for_characteristic_value_updates(gatt_client_notification_t * notification, btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 715 716 /** 717 * @brief Stop listening to characteristic value updates registered with gatt_client_listen_for_characteristic_value_updates 718 * @param notification struct used in gatt_client_listen_for_characteristic_value_updates 719 */ 720 void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification); 721 722 /** 723 * @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees a single successful gatt_client_write_value_of_characteristic_without_response 724 * @param callback 725 * @param con_handle 726 * @returns status 727 */ 728 uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 729 730 /** 731 * @brief Transactional write. It can be called as many times as it is needed to write the characteristics within the same transaction. Call gatt_client_execute_write to commit the transaction. 732 * @param callback 733 * @param con_handle 734 * @param attribute_handle 735 * @param offset of value 736 * @param value_length 737 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 738 */ 739 uint8_t gatt_client_prepare_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint16_t value_length, uint8_t * value); 740 741 /** 742 * @brief Commit transactional write. GATT_EVENT_QUERY_COMPLETE is received. 743 * @param callback 744 * @param con_handle 745 */ 746 uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 747 748 /** 749 * @brief Abort transactional write. GATT_EVENT_QUERY_COMPLETE is received. 750 * @param callback 751 * @param con_handle 752 */ 753 uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 754 755 /* API_END */ 756 757 // used by generated btstack_event.c 758 759 void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t * service); 760 void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic); 761 void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor); 762 763 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 764 void gatt_client_att_packet_handler_fuzz(uint8_t packet_type, uint16_t handle, uint8_t *packet, uint16_t size); 765 #endif 766 767 #if defined __cplusplus 768 } 769 #endif 770 771 #endif 772