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