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