1 /* 2 * Copyright (C) 2015 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 * bluetooth.h 40 * 41 * Numbers defined or derived from the official Bluetooth specification 42 */ 43 44 #ifndef __BLUETOOTH_H 45 #define __BLUETOOTH_H 46 47 #include <stdint.h> 48 49 /** 50 * @brief hci connection handle type 51 */ 52 typedef uint16_t hci_con_handle_t; 53 54 /** 55 * @brief Length of a bluetooth device address. 56 */ 57 #define BD_ADDR_LEN 6 58 59 /** 60 * @brief Bluetooth address 61 */ 62 typedef uint8_t bd_addr_t[BD_ADDR_LEN]; 63 64 /** 65 * Address types 66 * @note: BTstack uses a custom addr type to refer to classic ACL and SCO devices 67 */ 68 typedef enum { 69 BD_ADDR_TYPE_LE_PUBLIC = 0, 70 BD_ADDR_TYPE_LE_RANDOM = 1, 71 BD_ADDR_TYPE_LE_PRIVAT_FALLBACK_PUBLIC = 2, 72 BD_ADDR_TYPE_LE_PRIVAT_FALLBACK_RANDOM = 3, 73 BD_ADDR_TYPE_SCO = 0xfe, 74 BD_ADDR_TYPE_CLASSIC = 0xff, 75 BD_ADDR_TYPE_UNKNOWN = 0xfe 76 } bd_addr_type_t; 77 78 79 80 /** 81 * @brief link key 82 */ 83 #define LINK_KEY_LEN 16 84 #define LINK_KEY_STR_LEN (LINK_KEY_LEN*2) 85 typedef uint8_t link_key_t[LINK_KEY_LEN]; 86 87 /** 88 * @brief link key type 89 */ 90 typedef enum { 91 COMBINATION_KEY = 0, // standard pairing 92 LOCAL_UNIT_KEY, // ? 93 REMOTE_UNIT_KEY, // ? 94 DEBUG_COMBINATION_KEY, // SSP with debug 95 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Simple Pairing 96 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Passkey, Number confirm, OOB 97 CHANGED_COMBINATION_KEY, // Link key changed using Change Connection Lnk Key 98 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Simpe Pairing 99 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Passkey, Number confirm, OOB 100 } link_key_type_t; 101 102 /** 103 * @brief Inquiry modes 104 */ 105 typedef enum { 106 INQUIRY_MODE_STANDARD = 0, 107 INQUIRY_MODE_RSSI, 108 INQUIRY_MODE_RSSI_AND_EIR, 109 } inquiry_mode_t; 110 111 112 /* 113 * @brief L2CAP Segmentation And Reassembly packet type in I-Frames 114 */ 115 typedef enum { 116 L2CAP_SEGMENTATION_AND_REASSEMBLY_UNSEGMENTED_L2CAP_SDU = 0, 117 L2CAP_SEGMENTATION_AND_REASSEMBLY_START_OF_L2CAP_SDU, 118 L2CAP_SEGMENTATION_AND_REASSEMBLY_END_OF_L2CAP_SDU, 119 L2CAP_SEGMENTATION_AND_REASSEMBLY_CONTINUATION_OF_L2CAP_SDU 120 } l2cap_segmentation_and_reassembly_t; 121 122 /* 123 * @brief L2CAP Supervisory function in S-Frames 124 */ 125 typedef enum { 126 L2CAP_SUPERVISORY_FUNCTION_RR_RECEIVER_READY = 0, 127 L2CAP_SUPERVISORY_FUNCTION_REJ_REJECT, 128 L2CAP_SUPERVISORY_FUNCTION_RNR_RECEIVER_NOT_READY, 129 L2CAP_SUPERVISORY_FUNCTION_SREJ_SELECTIVE_REJECT 130 } l2cap_supervisory_function_t; 131 132 /** 133 * @brief L2CAP Information Types used in Information Request & Response 134 */ 135 typedef enum { 136 L2CAP_INFO_TYPE_CONNECTIONLESS_MTU = 1, 137 L2CAP_INFO_TYPE_EXTENDED_FEATURES_SUPPORTED, 138 L2CAP_INFO_TYPE_FIXED_CHANNELS_SUPPORTED, 139 } l2cap_info_type_t; 140 141 /** 142 * @brief L2CAP Configuration Option Types used in Configurateion Request & Response 143 */ 144 typedef enum { 145 L2CAP_CONFIG_OPTION_TYPE_MAX_TRANSMISSION_UNIT = 1, 146 L2CAP_CONFIG_OPTION_TYPE_FLUSH_TIMEOUT, 147 L2CAP_CONFIG_OPTION_TYPE_QUALITY_OF_SERVICE, 148 L2CAP_CONFIG_OPTION_TYPE_RETRANSMISSION_AND_FLOW_CONTROL, 149 L2CAP_CONFIG_OPTION_TYPE_FRAME_CHECK_SEQUENCE, 150 L2CAP_CONFIG_OPTION_TYPE_EXTENDED_FLOW_SPECIFICATION, 151 L2CAP_CONFIG_OPTION_TYPE_EXTENDED_WINDOW_SIZE, 152 } l2cap_config_option_type_t; 153 154 /** 155 * HCI Transport 156 */ 157 158 /** 159 * packet types - used in BTstack and over the H4 UART interface 160 */ 161 #define HCI_COMMAND_DATA_PACKET 0x01 162 #define HCI_ACL_DATA_PACKET 0x02 163 #define HCI_SCO_DATA_PACKET 0x03 164 #define HCI_EVENT_PACKET 0x04 165 166 // packet header sizes 167 #define HCI_CMD_HEADER_SIZE 3 168 #define HCI_ACL_HEADER_SIZE 4 169 #define HCI_SCO_HEADER_SIZE 3 170 #define HCI_EVENT_HEADER_SIZE 2 171 172 /** 173 * HCI Layer 174 */ 175 176 // 177 // Error Codes rfom Bluetooth Core Specification 178 // 179 180 /* ENUM_START: BLUETOOTH_ERROR_CODE */ 181 #define ERROR_CODE_SUCCESS 0x00 182 #define ERROR_CODE_UNKNOWN_HCI_COMMAND 0x01 183 #define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER 0x02 184 #define ERROR_CODE_HARDWARE_FAILURE 0x03 185 #define ERROR_CODE_PAGE_TIMEOUT 0x04 186 #define ERROR_CODE_AUTHENTICATION_FAILURE 0x05 187 #define ERROR_CODE_PIN_OR_KEY_MISSING 0x06 188 #define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED 0x07 189 #define ERROR_CODE_CONNECTION_TIMEOUT 0x08 190 #define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED 0x09 191 #define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED 0x0A 192 #define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS 0x0B 193 #define ERROR_CODE_COMMAND_DISALLOWED 0x0C 194 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D 195 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS 0x0E 196 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F 197 #define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED 0x10 198 #define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE 0x11 199 #define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS 0x12 200 #define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION 0x13 201 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14 202 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF 0x15 203 #define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST 0x16 204 #define ERROR_CODE_REPEATED_ATTEMPTS 0x17 205 #define ERROR_CODE_PAIRING_NOT_ALLOWED 0x18 206 #define ERROR_CODE_UNKNOWN_LMP_PDU 0x19 207 #define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A 208 #define ERROR_CODE_SCO_OFFSET_REJECTED 0x1B 209 #define ERROR_CODE_SCO_INTERVAL_REJECTED 0x1C 210 #define ERROR_CODE_SCO_AIR_MODE_REJECTED 0x1D 211 #define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E 212 #define ERROR_CODE_UNSPECIFIED_ERROR 0x1F 213 #define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20 214 #define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED 0x21 215 #define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22 216 #define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION 0x23 217 #define ERROR_CODE_LMP_PDU_NOT_ALLOWED 0x24 218 #define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE 0x25 219 #define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED 0x26 220 #define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED 0x27 221 #define ERROR_CODE_INSTANT_PASSED 0x28 222 #define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED 0x29 223 #define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION 0x2A 224 #define ERROR_CODE_RESERVED 0x2B 225 #define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER 0x2C 226 #define ERROR_CODE_QOS_REJECTED 0x2D 227 #define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED 0x2E 228 #define ERROR_CODE_INSUFFICIENT_SECURITY 0x2F 229 #define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE 0x30 230 // #define ERROR_CODE_RESERVED 231 #define ERROR_CODE_ROLE_SWITCH_PENDING 0x32 232 // #define ERROR_CODE_RESERVED 233 #define ERROR_CODE_RESERVED_SLOT_VIOLATION 0x34 234 #define ERROR_CODE_ROLE_SWITCH_FAILED 0x35 235 #define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE 0x36 236 #define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37 237 #define ERROR_CODE_HOST_BUSY_PAIRING 0x38 238 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39 239 #define ERROR_CODE_CONTROLLER_BUSY 0x3A 240 #define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS 0x3B 241 #define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT 0x3C 242 #define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D 243 #define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED 0x3E 244 #define ERROR_CODE_MAC_CONNECTION_FAILED 0x3F 245 #define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40 246 /* ENUM_END */ 247 248 // HCI roles 249 #define HCI_ROLE_MASTER 0 250 #define HCI_ROLE_SLAVE 1 251 252 // packet sizes (max payload) 253 #define HCI_ACL_DM1_SIZE 17 254 #define HCI_ACL_DH1_SIZE 27 255 #define HCI_ACL_2DH1_SIZE 54 256 #define HCI_ACL_3DH1_SIZE 83 257 #define HCI_ACL_DM3_SIZE 121 258 #define HCI_ACL_DH3_SIZE 183 259 #define HCI_ACL_DM5_SIZE 224 260 #define HCI_ACL_DH5_SIZE 339 261 #define HCI_ACL_2DH3_SIZE 367 262 #define HCI_ACL_3DH3_SIZE 552 263 #define HCI_ACL_2DH5_SIZE 679 264 #define HCI_ACL_3DH5_SIZE 1021 265 266 #define HCI_EVENT_PAYLOAD_SIZE 255 267 #define HCI_CMD_PAYLOAD_SIZE 255 268 269 #define LE_ADVERTISING_DATA_SIZE 31 270 271 /** 272 * Default INQ Mode 273 */ 274 #define HCI_INQUIRY_LAP 0x9E8B33L // 0x9E8B33: General/Unlimited Inquiry Access Code (GIAC) 275 276 /** 277 * SSP IO Capabilities 278 */ 279 #define SSP_IO_CAPABILITY_DISPLAY_ONLY 0 280 #define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1 281 #define SSP_IO_CAPABILITY_KEYBOARD_ONLY 2 282 #define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3 283 #define SSP_IO_CAPABILITY_UNKNOWN 0xff 284 285 286 /** 287 * SSP Authentication Requirements, see IO Capability Request Reply Commmand 288 */ 289 290 // Numeric comparison with automatic accept allowed. 291 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00 292 293 // Use IO Capabilities to deter- mine authentication procedure 294 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01 295 296 // Numeric compar- ison with automatic accept allowed. 297 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02 298 299 // Use IO Capabilities to determine authentication procedure 300 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03 301 302 // Numeric Compari- son with automatic accept allowed. 303 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04 304 305 // Use IO capabilities to determine authentication procedure. 306 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05 307 308 309 // OGFs 310 #define OGF_LINK_CONTROL 0x01 311 #define OGF_LINK_POLICY 0x02 312 #define OGF_CONTROLLER_BASEBAND 0x03 313 #define OGF_INFORMATIONAL_PARAMETERS 0x04 314 #define OGF_STATUS_PARAMETERS 0x05 315 #define OGF_TESTING 0x06 316 #define OGF_LE_CONTROLLER 0x08 317 #define OGF_VENDOR 0x3f 318 319 320 // Events from host controller to host 321 322 /** 323 * @format 1 324 * @param status 325 */ 326 #define HCI_EVENT_INQUIRY_COMPLETE 0x01 327 328 /** 329 * @format 1B11132 330 * @param num_responses 331 * @param bd_addr 332 * @param page_scan_repetition_mode 333 * @param reserved1 334 * @param reserved2 335 * @param class_of_device 336 * @param clock_offset 337 */ 338 #define HCI_EVENT_INQUIRY_RESULT 0x02 339 340 /** 341 * @format 12B11 342 * @param status 343 * @param connection_handle 344 * @param bd_addr 345 * @param link_type 346 * @param encryption_enabled 347 */ 348 #define HCI_EVENT_CONNECTION_COMPLETE 0x03 349 /** 350 * @format B31 351 * @param bd_addr 352 * @param class_of_device 353 * @param link_type 354 */ 355 #define HCI_EVENT_CONNECTION_REQUEST 0x04 356 /** 357 * @format 121 358 * @param status 359 * @param connection_handle 360 * @param reason 361 */ 362 #define HCI_EVENT_DISCONNECTION_COMPLETE 0x05 363 /** 364 * @format 12 365 * @param status 366 * @param connection_handle 367 */ 368 #define HCI_EVENT_AUTHENTICATION_COMPLETE_EVENT 0x06 369 /** 370 * @format 1BN 371 * @param status 372 * @param bd_addr 373 * @param remote_name 374 */ 375 #define HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 0x07 376 /** 377 * @format 121 378 * @param status 379 * @param connection_handle 380 * @param encryption_enabled 381 */ 382 #define HCI_EVENT_ENCRYPTION_CHANGE 0x08 383 /** 384 * @format 12 385 * @param status 386 * @param connection_handle 387 */ 388 #define HCI_EVENT_CHANGE_CONNECTION_LINK_KEY_COMPLETE 0x09 389 /** 390 * @format 121 391 * @param status 392 * @param connection_handle 393 * @param key_flag 394 */ 395 #define HCI_EVENT_MASTER_LINK_KEY_COMPLETE 0x0A 396 397 #define HCI_EVENT_READ_REMOTE_SUPPORTED_FEATURES_COMPLETE 0x0B 398 399 #define HCI_EVENT_READ_REMOTE_VERSION_INFORMATION_COMPLETE 0x0C 400 401 #define HCI_EVENT_QOS_SETUP_COMPLETE 0x0D 402 403 /** 404 * @format 12R 405 * @param num_hci_command_packets 406 * @param command_opcode 407 * @param return_parameters 408 */ 409 #define HCI_EVENT_COMMAND_COMPLETE 0x0E 410 /** 411 * @format 112 412 * @param status 413 * @param num_hci_command_packets 414 * @param command_opcode 415 */ 416 #define HCI_EVENT_COMMAND_STATUS 0x0F 417 418 /** 419 * @format 1 420 * @param hardware_code 421 */ 422 #define HCI_EVENT_HARDWARE_ERROR 0x10 423 424 #define HCI_EVENT_FLUSH_OCCURRED 0x11 425 426 /** 427 * @format 1B1 428 * @param status 429 * @param bd_addr 430 * @param role 431 */ 432 #define HCI_EVENT_ROLE_CHANGE 0x12 433 434 // TODO: number_of_handles 1, connection_handle[H*i], hc_num_of_completed_packets[2*i] 435 #define HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS 0x13 436 437 /** 438 * @format 1H12 439 * @param status 440 * @param handle 441 * @param mode 442 * @param interval 443 */ 444 #define HCI_EVENT_MODE_CHANGE_EVENT 0x14 445 446 // TODO: num_keys, bd_addr[B*i], link_key[16 octets * i] 447 #define HCI_EVENT_RETURN_LINK_KEYS 0x15 448 449 /** 450 * @format B 451 * @param bd_addr 452 */ 453 #define HCI_EVENT_PIN_CODE_REQUEST 0x16 454 455 /** 456 * @format B 457 * @param bd_addr 458 */ 459 #define HCI_EVENT_LINK_KEY_REQUEST 0x17 460 461 // TODO: bd_addr B, link_key 16octets, key_type 1 462 #define HCI_EVENT_LINK_KEY_NOTIFICATION 0x18 463 464 /** 465 * @format 1 466 * @param link_type 467 */ 468 #define HCI_EVENT_DATA_BUFFER_OVERFLOW 0x1A 469 470 /** 471 * @format H1 472 * @param handle 473 * @param lmp_max_slots 474 */ 475 #define HCI_EVENT_MAX_SLOTS_CHANGED 0x1B 476 477 /** 478 * @format 1H2 479 * @param status 480 * @param handle 481 * @param clock_offset 482 */ 483 #define HCI_EVENT_READ_CLOCK_OFFSET_COMPLETE 0x1C 484 485 /** 486 * @format 1H2 487 * @param status 488 * @param handle 489 * @param packet_types 490 * @pnote packet_type is in plural to avoid clash with Java binding Packet.getPacketType() 491 */ 492 #define HCI_EVENT_CONNECTION_PACKET_TYPE_CHANGED 0x1D 493 494 /** 495 * @format 1B11321 496 * @param num_responses 497 * @param bd_addr 498 * @param page_scan_repetition_mode 499 * @param reserved 500 * @param class_of_device 501 * @param clock_offset 502 * @param rssi 503 */ 504 #define HCI_EVENT_INQUIRY_RESULT_WITH_RSSI 0x22 505 506 /** 507 * @format 1HB111221 508 * @param status 509 * @param handle 510 * @param bd_addr 511 * @param link_type 512 * @param transmission_interval 513 * @param retransmission_interval 514 * @param rx_packet_length 515 * @param tx_packet_length 516 * @param air_mode 517 */ 518 #define HCI_EVENT_SYNCHRONOUS_CONNECTION_COMPLETE 0x2C 519 520 // TODO: serialize extended_inquiry_response and provide parser 521 /** 522 * @format 1B11321 523 * @param num_responses 524 * @param bd_addr 525 * @param page_scan_repetition_mode 526 * @param reserved 527 * @param class_of_device 528 * @param clock_offset 529 * @param rssi 530 */ 531 #define HCI_EVENT_EXTENDED_INQUIRY_RESPONSE 0x2F 532 533 /** 534 * @format 1H 535 * @param status 536 * @param handle 537 */ 538 #define HCI_EVENT_ENCRYPTION_KEY_REFRESH_COMPLETE 0x30 539 540 #define HCI_EVENT_IO_CAPABILITY_REQUEST 0x31 541 #define HCI_EVENT_IO_CAPABILITY_RESPONSE 0x32 542 543 /** 544 * @format B4 545 * @param bd_addr 546 * @param numeric_value 547 */ 548 #define HCI_EVENT_USER_CONFIRMATION_REQUEST 0x33 549 550 /** 551 * @format B 552 * @param bd_addr 553 */ 554 #define HCI_EVENT_USER_PASSKEY_REQUEST 0x34 555 556 /** 557 * @format B 558 * @param bd_addr 559 */ 560 #define HCI_EVENT_REMOTE_OOB_DATA_REQUEST 0x35 561 562 /** 563 * @format 1B 564 * @param status 565 * @param bd_addr 566 */ 567 #define HCI_EVENT_SIMPLE_PAIRING_COMPLETE 0x36 568 569 #define HCI_EVENT_LE_META 0x3E 570 571 // last used HCI_EVENT in 2.1 is 0x3d 572 // last used HCI_EVENT in 4.1 is 0x57 573 574 #define HCI_EVENT_VENDOR_SPECIFIC 0xFF 575 576 /** 577 * @format 11H11B2221 578 * @param subevent_code 579 * @param status 580 * @param connection_handle 581 * @param role 582 * @param peer_address_type 583 * @param peer_address 584 * @param conn_interval 585 * @param conn_latency 586 * @param supervision_timeout 587 * @param master_clock_accuracy 588 */ 589 #define HCI_SUBEVENT_LE_CONNECTION_COMPLETE 0x01 590 591 // array of advertisements, not handled by event accessor generator 592 #define HCI_SUBEVENT_LE_ADVERTISING_REPORT 0x02 593 594 /** 595 * @format 11H222 596 * @param subevent_code 597 * @param status 598 * @param connection_handle 599 * @param conn_interval 600 * @param conn_latency 601 * @param supervision_timeout 602 */ 603 #define HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE 0x03 604 605 /** 606 * @format 1HD2 607 * @param subevent_code 608 * @param connection_handle 609 * @param random_number 610 * @param encryption_diversifier 611 */ 612 #define HCI_SUBEVENT_LE_READ_REMOTE_USED_FEATURES_COMPLETE 0x04 613 614 /** 615 * @format 1HD2 616 * @param subevent_code 617 * @param connection_handle 618 * @param random_number 619 * @param encryption_diversifier 620 */ 621 #define HCI_SUBEVENT_LE_LONG_TERM_KEY_REQUEST 0x05 622 623 /** 624 * @format 1H2222 625 * @param subevent_code 626 * @param connection_handle 627 * @param interval_min 628 * @param interval_max 629 * @param latency 630 * @param timeout 631 */ 632 #define HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 0x06 633 634 /** 635 * @format 1H2222 636 * @param subevent_code 637 * @param connection_handle 638 * @param max_tx_octets 639 * @param max_tx_time 640 * @param max_rx_octets 641 * @param max_rx_time 642 */ 643 #define HCI_SUBEVENT_LE_DATA_LENGTH_CHANGE 0x07 644 645 /** 646 * @format 11QQ 647 * @param subevent_code 648 * @param status 649 * @param dhkey_x x coordinate of P256 public key 650 * @param dhkey_y y coordinate of P256 public key 651 */ 652 #define HCI_SUBEVENT_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE 0x08 653 /** 654 * @format 11Q 655 * @param subevent_code 656 * @param status 657 * @param dhkey Diffie-Hellman key 658 */ 659 #define HCI_SUBEVENT_LE_GENERATE_DHKEY_COMPLETE 0x09 660 661 /** 662 * @format 11H11BBB2221 663 * @param subevent_code 664 * @param status 665 * @param connection_handle 666 * @param role 667 * @param peer_address_type 668 * @param perr_addresss 669 * @param local_resolvable_private_addres 670 * @param peer_resolvable_private_addres 671 * @param conn_interval 672 * @param conn_latency 673 * @param supervision_timeout 674 * @param master_clock_accuracy 675 */ 676 #define HCI_SUBEVENT_LE_ENHANCED_CONNECTION_COMPLETE 0x0A 677 678 // array of advertisements, not handled by event accessor generator 679 #define HCI_SUBEVENT_LE_DIRECT_ADVERTISING_REPORT 0x0B 680 681 /** 682 * L2CAP Layer 683 */ 684 685 #define L2CAP_HEADER_SIZE 4 686 687 #define L2CAP_SIG_ID_INVALID 0 688 689 // size of HCI ACL + L2CAP Header for regular data packets (8) 690 #define COMPLETE_L2CAP_HEADER (HCI_ACL_HEADER_SIZE + L2CAP_HEADER_SIZE) 691 692 // minimum signaling MTU 693 #define L2CAP_MINIMAL_MTU 48 694 #define L2CAP_DEFAULT_MTU 672 695 696 // Minimum/default MTU 697 #define L2CAP_LE_DEFAULT_MTU 23 698 699 // L2CAP Fixed Channel IDs 700 #define L2CAP_CID_SIGNALING 0x0001 701 #define L2CAP_CID_CONNECTIONLESS_CHANNEL 0x0002 702 #define L2CAP_CID_ATTRIBUTE_PROTOCOL 0x0004 703 #define L2CAP_CID_SIGNALING_LE 0x0005 704 #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006 705 706 // L2CAP Configuration Result Codes 707 #define L2CAP_CONF_RESULT_SUCCESS 0x0000 708 #define L2CAP_CONF_RESULT_UNACCEPTABLE_PARAMETERS 0x0001 709 #define L2CAP_CONF_RESULT_REJECT 0x0002 710 #define L2CAP_CONF_RESULT_UNKNOWN_OPTIONS 0x0003 711 #define L2CAP_CONF_RESULT_PENDING 0x0004 712 #define L2CAP_CONF_RESULT_FLOW_SPEC_REJECTED 0x0005 713 714 // L2CAP Reject Result Codes 715 #define L2CAP_REJ_CMD_UNKNOWN 0x0000 716 717 // Response Timeout eXpired 718 #define L2CAP_RTX_TIMEOUT_MS 10000 719 720 // Extended Response Timeout eXpired 721 #define L2CAP_ERTX_TIMEOUT_MS 120000 722 723 // 724 // Fixed PSM numbers from https://www.bluetooth.com/specifications/assigned-numbers/logical-link-control 725 // 726 // @TODO: replace with BLUETOOTH_PROTOCOL_xxx in rest of code 727 #define PSM_SDP BLUETOOTH_PROTOCOL_SDP 728 #define PSM_RFCOMM BLUETOOTH_PROTOCOL_RFCOMM 729 #define PSM_BNEP BLUETOOTH_PROTOCOL_BNEP 730 // @TODO: scrape PSMs Bluetooth SIG site and put in bluetooth_psm.h or bluetooth_l2cap.h 731 #define PSM_HID_CONTROL 0x11 732 #define PSM_HID_INTERRUPT 0x13 733 #define PSM_IPSP 0x23 734 735 /** 736 * SDP Protocol 737 */ 738 739 // PDU Types 740 typedef enum { 741 SDP_Invalid = 0, 742 SDP_ErrorResponse = 1, 743 SDP_ServiceSearchRequest, 744 SDP_ServiceSearchResponse, 745 SDP_ServiceAttributeRequest, 746 SDP_ServiceAttributeResponse, 747 SDP_ServiceSearchAttributeRequest, 748 SDP_ServiceSearchAttributeResponse 749 } SDP_PDU_ID_t; 750 751 /* Please use assigned numbers from bluetooth_sdp.h instead for thsese ...*/ 752 753 // UNIVERSAL ATTRIBUTE DEFINITIONS 754 #define SDP_ServiceRecordHandle BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_HANDLE 755 #define SDP_ServiceClassIDList BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST 756 #define SDP_ServiceRecordState BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_STATE 757 #define SDP_ServiceID BLUETOOTH_ATTRIBUTE_SERVICE_ID 758 #define SDP_ProtocolDescriptorList BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST 759 #define SDP_BrowseGroupList BLUETOOTH_ATTRIBUTE_BROWSE_GROUP_LIST 760 #define SDP_LanguageBaseAttributeIDList BLUETOOTH_ATTRIBUTE_LANGUAGE_BASE_ATTRIBUTE_ID_LIST 761 #define SDP_ServiceInfoTimeToLive BLUETOOTH_ATTRIBUTE_SERVICE_INFO_TIME_TO_LIVE 762 #define SDP_ServiceAvailability BLUETOOTH_ATTRIBUTE_SERVICE_AVAILABILITY 763 #define SDP_BluetoothProfileDescriptorList BLUETOOTH_ATTRIBUTE_BLUETOOTH_PROFILE_DESCRIPTOR_LIST 764 #define SDP_DocumentationURL BLUETOOTH_ATTRIBUTE_DOCUMENTATION_URL 765 #define SDP_ClientExecutableURL BLUETOOTH_ATTRIBUTE_CLIENT_EXECUTABLE_URL 766 #define SDP_IconURL BLUETOOTH_ATTRIBUTE_ICON_URL 767 #define SDP_AdditionalProtocolDescriptorList BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS 768 #define SDP_SupportedFormatsList BLUETOOTH_ATTRIBUTE_SUPPORTED_FORMATS_LIST 769 770 // SERVICE CLASSES 771 #define SDP_OBEXObjectPush BLUETOOTH_SERVICE_CLASS_OBEX_OBJECT_PUSH 772 #define SDP_OBEXFileTransfer BLUETOOTH_SERVICE_CLASS_OBEX_FILE_TRANSFER 773 #define SDP_PublicBrowseGroup BLUETOOTH_ATTRIBUTE_PUBLIC_BROWSE_ROOT 774 #define SDP_HSP BLUETOOTH_SERVICE_CLASS_HEADSET 775 #define SDP_Headset_AG BLUETOOTH_SERVICE_CLASS_HEADSET_AUDIO_GATEWAY_AG 776 #define SDP_PANU BLUETOOTH_SERVICE_CLASS_PANU 777 #define SDP_NAP BLUETOOTH_SERVICE_CLASS_NAP 778 #define SDP_GN BLUETOOTH_SERVICE_CLASS_GN 779 #define SDP_Handsfree BLUETOOTH_SERVICE_CLASS_HANDSFREE 780 #define SDP_HandsfreeAudioGateway BLUETOOTH_SERVICE_CLASS_HANDSFREE_AUDIO_GATEWAY 781 #define SDP_Headset_HS BLUETOOTH_SERVICE_CLASS_HEADSET_HS 782 #define SDP_GenericAudio BLUETOOTH_SERVICE_CLASS_GENERIC_AUDIO 783 784 // PROTOCOLS 785 #define SDP_SDPProtocol BLUETOOTH_PROTOCOL_SDP 786 #define SDP_UDPProtocol BLUETOOTH_PROTOCOL_UDP 787 #define SDP_RFCOMMProtocol BLUETOOTH_PROTOCOL_RFCOMM 788 #define SDP_OBEXProtocol BLUETOOTH_PROTOCOL_OBEX 789 #define SDP_L2CAPProtocol BLUETOOTH_PROTOCOL_L2CAP 790 #define SDP_BNEPProtocol BLUETOOTH_PROTOCOL_BNEP 791 #define SDP_AVDTPProtocol BLUETOOTH_PROTOCOL_AVDTP 792 793 /** .. until here ..*/ 794 795 // OFFSETS FOR LOCALIZED ATTRIBUTES - SDP_LanguageBaseAttributeIDList 796 #define SDP_Offest_ServiceName 0x0000 797 #define SDP_Offest_ServiceDescription 0x0001 798 #define SDP_Offest_ProviderName 0x0002 799 800 // Device Vendor ID Sources 801 #define DEVICE_ID_VENDOR_ID_SOURCE_BLUETOOTH 0x0001 802 #define DEVICE_ID_VENDOR_ID_SOURCE_USB 0x0002 803 804 // OBEX 805 #define SDP_vCard_2_1 0x01 806 #define SDP_vCard_3_0 0x02 807 #define SDP_vCal_1_0 0x03 808 #define SDP_iCal_2_0 0x04 809 #define SDP_vNote 0x05 810 #define SDP_vMessage 0x06 811 #define SDP_OBEXFileTypeAny 0xFF 812 813 /** 814 * RFCOMM Protocol 815 */ 816 817 // Control field values bit no. 1 2 3 4 PF 6 7 8 818 #define BT_RFCOMM_SABM 0x3F // 1 1 1 1 1 1 0 0 819 #define BT_RFCOMM_UA 0x73 // 1 1 0 0 1 1 1 0 820 #define BT_RFCOMM_DM 0x0F // 1 1 1 1 0 0 0 0 821 #define BT_RFCOMM_DM_PF 0x1F // 1 1 1 1 1 0 0 0 822 #define BT_RFCOMM_DISC 0x53 // 1 1 0 0 1 0 1 0 823 #define BT_RFCOMM_UIH 0xEF // 1 1 1 1 0 1 1 1 824 #define BT_RFCOMM_UIH_PF 0xFF // 1 1 1 1 0 1 1 1 825 826 // Multiplexer message types 827 #define BT_RFCOMM_CLD_CMD 0xC3 828 #define BT_RFCOMM_FCON_CMD 0xA3 829 #define BT_RFCOMM_FCON_RSP 0xA1 830 #define BT_RFCOMM_FCOFF_CMD 0x63 831 #define BT_RFCOMM_FCOFF_RSP 0x61 832 #define BT_RFCOMM_MSC_CMD 0xE3 833 #define BT_RFCOMM_MSC_RSP 0xE1 834 #define BT_RFCOMM_NSC_RSP 0x11 835 #define BT_RFCOMM_PN_CMD 0x83 836 #define BT_RFCOMM_PN_RSP 0x81 837 #define BT_RFCOMM_RLS_CMD 0x53 838 #define BT_RFCOMM_RLS_RSP 0x51 839 #define BT_RFCOMM_RPN_CMD 0x93 840 #define BT_RFCOMM_RPN_RSP 0x91 841 #define BT_RFCOMM_TEST_CMD 0x23 842 #define BT_RFCOMM_TEST_RSP 0x21 843 844 // Line Status 845 #define LINE_STATUS_NO_ERROR 0x00 846 #define LINE_STATUS_OVERRUN_ERROR 0x03 847 #define LINE_STATUS_PARITY_ERORR 0x05 848 #define LINE_STATUS_FRAMING_ERROR 0x09 849 850 // Modem Status Flags 851 #define MODEM_STATUS_FC 0x02 852 #define MODEM_STATUS_RTC 0x04 853 #define MODEM_STATUS_RTR 0x08 854 #define MODEM_STATUS_IC 0x40 855 #define MODEM_STATUS_DV 0x80 856 857 typedef enum rpn_baud { 858 RPN_BAUD_2400 = 0, 859 RPN_BAUD_4800, 860 RPN_BAUD_7200, 861 RPN_BAUD_9600, 862 RPN_BAUD_19200, 863 RPN_BAUD_38400, 864 RPN_BAUD_57600, 865 RPN_BAUD_115200, 866 RPN_BAUD_230400 867 } rpn_baud_t; 868 869 typedef enum rpn_data_bits { 870 RPN_DATA_BITS_5 = 0, 871 RPN_DATA_BITS_6 = 0, 872 RPN_DATA_BITS_7 = 0, 873 RPN_DATA_BITS_8 = 0 874 } rpn_data_bits_t; 875 876 typedef enum rpn_stop_bits { 877 RPN_STOP_BITS_1_0 = 0, 878 RPN_STOP_BITS_1_5 879 } rpn_stop_bits_t; 880 881 typedef enum rpn_parity { 882 RPN_PARITY_NONE = 0, 883 RPN_PARITY_ODD = 1, 884 RPN_PARITY_EVEN = 3, 885 RPN_PARITY_MARK = 5, 886 RPN_PARITY_SPACE = 7, 887 } rpn_parity_t; 888 889 typedef enum rpn_flow_control { 890 RPN_FLOW_CONTROL_XONXOFF_ON_INPUT = 1 << 0, 891 RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT = 1 << 1, 892 RPN_FLOW_CONTROL_RTR_ON_INPUT = 1 << 2, 893 RPN_FLOW_CONTROL_RTR_ON_OUTPUT = 1 << 3, 894 RPN_FLOW_CONTROL_RTC_ON_INPUT = 1 << 4, 895 RPN_FLOW_CONTROL_RTC_ON_OUTPUT = 1 << 5, 896 } rpn_flow_control_t; 897 898 #define RPN_PARAM_MASK_0_BAUD 0x01 899 #define RPN_PARAM_MASK_0_DATA_BITS 0x02 900 #define RPN_PARAM_MASK_0_STOP_BITS 0x04 901 #define RPN_PARAM_MASK_0_PARITY 0x08 902 #define RPN_PARAM_MASK_0_PARITY_TYPE 0x10 903 #define RPN_PARAM_MASK_0_XON_CHAR 0x20 904 #define RPN_PARAM_MASK_0_XOFF_CHAR 0x40 905 #define RPN_PARAM_MASK_0_RESERVED 0x80 906 907 // @note: values are identical to rpn_flow_control_t 908 #define RPN_PARAM_MASK_1_XONOFF_ON_INPUT 0x01 909 #define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02 910 #define RPN_PARAM_MASK_1_RTR_ON_INPUT 0x04 911 #define RPN_PARAM_MASK_1_RTR_ON_OUTPUT 0x08 912 #define RPN_PARAM_MASK_1_RTC_ON_INPUT 0x10 913 #define RPN_PARAM_MASK_1_RTC_ON_OUTPUT 0x20 914 #define RPN_PARAM_MASK_1_RESERVED_0 0x40 915 #define RPN_PARAM_MASK_1_RESERVED_1 0x80 916 917 /** 918 * BNEP Protocol 919 */ 920 921 #ifndef ETHER_ADDR_LEN 922 #define ETHER_ADDR_LEN 6 923 #endif 924 925 #ifndef ETHERTYPE_VLAN 926 #define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tag */ 927 #endif 928 929 #define BNEP_MTU_MIN 1691 930 931 #define BNEP_EXT_FLAG 0x80 932 #define BNEP_TYPE_MASK 0x7F 933 #define BNEP_TYPE(header) ((header) & BNEP_TYPE_MASK) 934 #define BNEP_HEADER_HAS_EXT(x) (((x) & BNEP_EXT_FLAG) == BNEP_EXT_FLAG) 935 936 /* BNEP packet types */ 937 #define BNEP_PKT_TYPE_GENERAL_ETHERNET 0x00 938 #define BNEP_PKT_TYPE_CONTROL 0x01 939 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET 0x02 940 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_SOURCE_ONLY 0x03 941 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_DEST_ONLY 0x04 942 943 /* BNEP control types */ 944 #define BNEP_CONTROL_TYPE_COMMAND_NOT_UNDERSTOOD 0x00 945 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_REQUEST 0x01 946 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_RESPONSE 0x02 947 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_SET 0x03 948 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_RESPONSE 0x04 949 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_SET 0x05 950 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_RESPONSE 0x06 951 952 /* BNEP extension header types */ 953 #define BNEP_EXT_HEADER_TYPE_EXTENSION_CONTROL 0x00 954 955 /* BNEP setup response codes */ 956 #define BNEP_RESP_SETUP_SUCCESS 0x0000 957 #define BNEP_RESP_SETUP_INVALID_DEST_UUID 0x0001 958 #define BNEP_RESP_SETUP_INVALID_SOURCE_UUID 0x0002 959 #define BNEP_RESP_SETUP_INVALID_SERVICE_UUID_SIZE 0x0003 960 #define BNEP_RESP_SETUP_CONNECTION_NOT_ALLOWED 0x0004 961 962 /* BNEP filter response codes */ 963 #define BNEP_RESP_FILTER_SUCCESS 0x0000 964 #define BNEP_RESP_FILTER_UNSUPPORTED_REQUEST 0x0001 965 #define BNEP_RESP_FILTER_ERR_INVALID_RANGE 0x0002 966 #define BNEP_RESP_FILTER_ERR_TOO_MANY_FILTERS 0x0003 967 #define BNEP_RESP_FILTER_ERR_SECURITY 0x0004 968 969 /** 970 * PAN Profile 971 */ 972 973 typedef enum { 974 BNEP_SECURITY_NONE = 0x0000, 975 BNEP_SECURITY_SERVICE_LEVEL_ENFORCED, 976 BNEP_SECURITY_802_1X 977 } security_description_t; 978 979 typedef enum { 980 PAN_NET_ACCESS_TYPE_PSTN = 0x0000, 981 PAN_NET_ACCESS_TYPE_ISDN, 982 PAN_NET_ACCESS_TYPE_DSL, 983 PAN_NET_ACCESS_TYPE_CABLE_MODEM, 984 PAN_NET_ACCESS_TYPE_10MB_ETHERNET, 985 PAN_NET_ACCESS_TYPE_100MB_ETHERNET, 986 PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING, 987 PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING, 988 PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING, 989 PAN_NET_ACCESS_TYPE_FDDI, 990 PAN_NET_ACCESS_TYPE_GSM, 991 PAN_NET_ACCESS_TYPE_CDMA, 992 PAN_NET_ACCESS_TYPE_GPRS, 993 PAN_NET_ACCESS_TYPE_3G, 994 PAN_NET_ACCESS_TYPE_CELULAR, 995 PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE, 996 PAN_NET_ACCESS_TYPE_NONE 997 } net_access_type_t; 998 999 /** 1000 * ATT 1001 */ 1002 1003 // Minimum/default MTU 1004 #define ATT_DEFAULT_MTU 23 1005 1006 // MARK: Attribute PDU Opcodes 1007 #define ATT_ERROR_RESPONSE 0x01 1008 1009 #define ATT_EXCHANGE_MTU_REQUEST 0x02 1010 #define ATT_EXCHANGE_MTU_RESPONSE 0x03 1011 1012 #define ATT_FIND_INFORMATION_REQUEST 0x04 1013 #define ATT_FIND_INFORMATION_REPLY 0x05 1014 #define ATT_FIND_BY_TYPE_VALUE_REQUEST 0x06 1015 #define ATT_FIND_BY_TYPE_VALUE_RESPONSE 0x07 1016 1017 #define ATT_READ_BY_TYPE_REQUEST 0x08 1018 #define ATT_READ_BY_TYPE_RESPONSE 0x09 1019 #define ATT_READ_REQUEST 0x0a 1020 #define ATT_READ_RESPONSE 0x0b 1021 #define ATT_READ_BLOB_REQUEST 0x0c 1022 #define ATT_READ_BLOB_RESPONSE 0x0d 1023 #define ATT_READ_MULTIPLE_REQUEST 0x0e 1024 #define ATT_READ_MULTIPLE_RESPONSE 0x0f 1025 #define ATT_READ_BY_GROUP_TYPE_REQUEST 0x10 1026 #define ATT_READ_BY_GROUP_TYPE_RESPONSE 0x11 1027 1028 #define ATT_WRITE_REQUEST 0x12 1029 #define ATT_WRITE_RESPONSE 0x13 1030 1031 #define ATT_PREPARE_WRITE_REQUEST 0x16 1032 #define ATT_PREPARE_WRITE_RESPONSE 0x17 1033 #define ATT_EXECUTE_WRITE_REQUEST 0x18 1034 #define ATT_EXECUTE_WRITE_RESPONSE 0x19 1035 1036 #define ATT_HANDLE_VALUE_NOTIFICATION 0x1b 1037 #define ATT_HANDLE_VALUE_INDICATION 0x1d 1038 #define ATT_HANDLE_VALUE_CONFIRMATION 0x1e 1039 1040 1041 #define ATT_WRITE_COMMAND 0x52 1042 #define ATT_SIGNED_WRITE_COMMAND 0xD2 1043 1044 // MARK: ATT Error Codes 1045 #define ATT_ERROR_INVALID_HANDLE 0x01 1046 #define ATT_ERROR_READ_NOT_PERMITTED 0x02 1047 #define ATT_ERROR_WRITE_NOT_PERMITTED 0x03 1048 #define ATT_ERROR_INVALID_PDU 0x04 1049 #define ATT_ERROR_INSUFFICIENT_AUTHENTICATION 0x05 1050 #define ATT_ERROR_REQUEST_NOT_SUPPORTED 0x06 1051 #define ATT_ERROR_INVALID_OFFSET 0x07 1052 #define ATT_ERROR_INSUFFICIENT_AUTHORIZATION 0x08 1053 #define ATT_ERROR_PREPARE_QUEUE_FULL 0x09 1054 #define ATT_ERROR_ATTRIBUTE_NOT_FOUND 0x0a 1055 #define ATT_ERROR_ATTRIBUTE_NOT_LONG 0x0b 1056 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c 1057 #define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH 0x0d 1058 #define ATT_ERROR_UNLIKELY_ERROR 0x0e 1059 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION 0x0f 1060 #define ATT_ERROR_UNSUPPORTED_GROUP_TYPE 0x10 1061 #define ATT_ERROR_INSUFFICIENT_RESOURCES 0x11 1062 1063 // MARK: Attribute Property Flags 1064 #define ATT_PROPERTY_BROADCAST 0x01 1065 #define ATT_PROPERTY_READ 0x02 1066 #define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04 1067 #define ATT_PROPERTY_WRITE 0x08 1068 #define ATT_PROPERTY_NOTIFY 0x10 1069 #define ATT_PROPERTY_INDICATE 0x20 1070 #define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40 1071 #define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80 1072 1073 // MARK: Attribute Property Flag, BTstack extension 1074 // value is asked from client 1075 #define ATT_PROPERTY_DYNAMIC 0x100 1076 // 128 bit UUID used 1077 #define ATT_PROPERTY_UUID128 0x200 1078 // Authentication required 1079 #define ATT_PROPERTY_AUTHENTICATION_REQUIRED 0x400 1080 // Authorization from user required 1081 #define ATT_PROPERTY_AUTHORIZATION_REQUIRED 0x800 1082 // Encryption key size stored in upper 4 bits, 0 == no encryption, encryption key size - 1 otherwise 1083 1084 // ATT Transaction Timeout of 30 seconds for Command/Response or Incidationc/Confirmation 1085 #define ATT_TRANSACTION_TIMEOUT_MS 30000 1086 1087 #define ATT_TRANSACTION_MODE_NONE 0x0 1088 #define ATT_TRANSACTION_MODE_ACTIVE 0x1 1089 #define ATT_TRANSACTION_MODE_EXECUTE 0x2 1090 #define ATT_TRANSACTION_MODE_CANCEL 0x3 1091 1092 // MARK: GATT UUIDs 1093 #define GATT_PRIMARY_SERVICE_UUID 0x2800 1094 #define GATT_SECONDARY_SERVICE_UUID 0x2801 1095 #define GATT_INCLUDE_SERVICE_UUID 0x2802 1096 #define GATT_CHARACTERISTICS_UUID 0x2803 1097 #define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES 0x2900 1098 #define GATT_CHARACTERISTIC_USER_DESCRIPTION 0x2901 1099 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION 0x2902 1100 #define GATT_SERVER_CHARACTERISTICS_CONFIGURATION 0x2903 1101 #define GATT_CHARACTERISTIC_PRESENTATION_FORMAT 0x2904 1102 #define GATT_CHARACTERISTIC_AGGREGATE_FORMAT 0x2905 1103 1104 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE 0 1105 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 1 1106 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 2 1107 1108 // GAP Service and Characteristics 1109 #define GAP_SERVICE_UUID 0x1800 1110 #define GAP_DEVICE_NAME_UUID 0x2a00 1111 #define GAP_APPEARANCE_UUID 0x2a01 1112 #define GAP_PERIPHERAL_PRIVACY_FLAG 0x2a02 1113 #define GAP_RECONNECTION_ADDRESS_UUID 0x2a03 1114 #define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04 1115 #define GAP_SERVICE_CHANGED 0x2a05 1116 1117 /** 1118 * SM - LE Security Manager 1119 */ 1120 // Bluetooth Spec definitions 1121 typedef enum { 1122 SM_CODE_PAIRING_REQUEST = 0X01, 1123 SM_CODE_PAIRING_RESPONSE, 1124 SM_CODE_PAIRING_CONFIRM, 1125 SM_CODE_PAIRING_RANDOM, 1126 SM_CODE_PAIRING_FAILED, 1127 SM_CODE_ENCRYPTION_INFORMATION, 1128 SM_CODE_MASTER_IDENTIFICATION, 1129 SM_CODE_IDENTITY_INFORMATION, 1130 SM_CODE_IDENTITY_ADDRESS_INFORMATION, 1131 SM_CODE_SIGNING_INFORMATION, 1132 SM_CODE_SECURITY_REQUEST, 1133 SM_CODE_PAIRING_PUBLIC_KEY, 1134 SM_CODE_PAIRING_DHKEY_CHECK, 1135 SM_CODE_KEYPRESS_NOTIFICATION, 1136 } SECURITY_MANAGER_COMMANDS; 1137 1138 // IO Capability Values 1139 typedef enum { 1140 IO_CAPABILITY_DISPLAY_ONLY = 0, 1141 IO_CAPABILITY_DISPLAY_YES_NO, 1142 IO_CAPABILITY_KEYBOARD_ONLY, 1143 IO_CAPABILITY_NO_INPUT_NO_OUTPUT, 1144 IO_CAPABILITY_KEYBOARD_DISPLAY, // not used by secure simple pairing 1145 } io_capability_t; 1146 1147 // Authentication requirement flags 1148 #define SM_AUTHREQ_NO_BONDING 0x00 1149 #define SM_AUTHREQ_BONDING 0x01 1150 #define SM_AUTHREQ_MITM_PROTECTION 0x04 1151 #define SM_AUTHREQ_SECURE_CONNECTION 0x08 1152 #define SM_AUTHREQ_KEYPRESS 0x10 1153 1154 // Key distribution flags used by spec 1155 #define SM_KEYDIST_ENC_KEY 0x01 1156 #define SM_KEYDIST_ID_KEY 0x02 1157 #define SM_KEYDIST_SIGN 0x04 1158 #define SM_KEYDIST_LINK_KEY 0x08 1159 1160 // Key distribution flags used internally 1161 #define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION 0x01 1162 #define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION 0x02 1163 #define SM_KEYDIST_FLAG_IDENTITY_INFORMATION 0x04 1164 #define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08 1165 #define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION 0x10 1166 1167 // STK Generation Methods 1168 #define SM_STK_GENERATION_METHOD_JUST_WORKS 0x01 1169 #define SM_STK_GENERATION_METHOD_OOB 0x02 1170 #define SM_STK_GENERATION_METHOD_PASSKEY 0x04 1171 #define SM_STK_GENERATION_METHOD_NUMERIC_COMPARISON 0x08 1172 1173 // Pairing Failed Reasons 1174 #define SM_REASON_RESERVED 0x00 1175 #define SM_REASON_PASSKEYT_ENTRY_FAILED 0x01 1176 #define SM_REASON_OOB_NOT_AVAILABLE 0x02 1177 #define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03 1178 #define SM_REASON_CONFIRM_VALUE_FAILED 0x04 1179 #define SM_REASON_PAIRING_NOT_SUPPORTED 0x05 1180 #define SM_REASON_ENCRYPTION_KEY_SIZE 0x06 1181 #define SM_REASON_COMMAND_NOT_SUPPORTED 0x07 1182 #define SM_REASON_UNSPECIFIED_REASON 0x08 1183 #define SM_REASON_REPEATED_ATTEMPTS 0x09 1184 #define SM_REASON_INVALID_PARAMETERS 0x0a 1185 #define SM_REASON_DHKEY_CHECK_FAILED 0x0b 1186 #define SM_REASON_NUMERIC_COMPARISON_FAILED 0x0c 1187 1188 // also, invalid parameters 1189 // and reserved 1190 1191 // Keypress Notifications 1192 #define SM_KEYPRESS_PASSKEY_ENTRY_STARTED 0x00 1193 #define SM_KEYPRESS_PASSKEY_DIGIT_ENTERED 0x01 1194 #define SM_KEYPRESS_PASSKEY_DIGIT_ERASED 0x02 1195 #define SM_KEYPRESS_PASSKEY_CLEARED 0x03 1196 #define SM_KEYPRESS_PASSKEY_ENTRY_COMPLETED 0x04 1197 1198 1199 #endif