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