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