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_SCO = 0xfe, 72 BD_ADDR_TYPE_CLASSIC = 0xff, 73 BD_ADDR_TYPE_UNKNOWN = 0xfe 74 } bd_addr_type_t; 75 76 /** 77 * @brief link key 78 */ 79 #define LINK_KEY_LEN 16 80 #define LINK_KEY_STR_LEN (LINK_KEY_LEN*2) 81 typedef uint8_t link_key_t[LINK_KEY_LEN]; 82 83 /** 84 * @brief link key type 85 */ 86 typedef enum { 87 COMBINATION_KEY = 0, // standard pairing 88 LOCAL_UNIT_KEY, // ? 89 REMOTE_UNIT_KEY, // ? 90 DEBUG_COMBINATION_KEY, // SSP with debug 91 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Simple Pairing 92 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Passkey, Number confirm, OOB 93 CHANGED_COMBINATION_KEY, // Link key changed using Change Connection Lnk Key 94 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Simpe Pairing 95 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Passkey, Number confirm, OOB 96 } link_key_type_t; 97 98 /** 99 * HCI Transport 100 */ 101 102 /** 103 * packet types - used in BTstack and over the H4 UART interface 104 */ 105 #define HCI_COMMAND_DATA_PACKET 0x01 106 #define HCI_ACL_DATA_PACKET 0x02 107 #define HCI_SCO_DATA_PACKET 0x03 108 #define HCI_EVENT_PACKET 0x04 109 110 // packet header sizes 111 #define HCI_CMD_HEADER_SIZE 3 112 #define HCI_ACL_HEADER_SIZE 4 113 #define HCI_SCO_HEADER_SIZE 3 114 #define HCI_EVENT_HEADER_SIZE 2 115 116 /** 117 * HCI Layer 118 */ 119 120 // 121 // Error Codes 122 // 123 124 // from Bluetooth Core Specification 125 #define ERROR_CODE_SUCCESS 0x00 126 #define ERROR_CODE_UNKNOWN_HCI_COMMAND 0x01 127 #define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER 0x02 128 #define ERROR_CODE_HARDWARE_FAILURE 0x03 129 #define ERROR_CODE_PAGE_TIMEOUT 0x04 130 #define ERROR_CODE_AUTHENTICATION_FAILURE 0x05 131 #define ERROR_CODE_PIN_OR_KEY_MISSING 0x06 132 #define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED 0x07 133 #define ERROR_CODE_CONNECTION_TIMEOUT 0x08 134 #define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED 0x09 135 #define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED 0x0A 136 #define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS 0x0B 137 #define ERROR_CODE_COMMAND_DISALLOWED 0x0C 138 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D 139 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS 0x0E 140 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F 141 #define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED 0x10 142 #define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE 0x11 143 #define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS 0x12 144 #define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION 0x13 145 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14 146 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF 0x15 147 #define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST 0x16 148 #define ERROR_CODE_REPEATED_ATTEMPTS 0x17 149 #define ERROR_CODE_PAIRING_NOT_ALLOWED 0x18 150 #define ERROR_CODE_UNKNOWN_LMP_PDU 0x19 151 #define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A 152 #define ERROR_CODE_SCO_OFFSET_REJECTED 0x1B 153 #define ERROR_CODE_SCO_INTERVAL_REJECTED 0x1C 154 #define ERROR_CODE_SCO_AIR_MODE_REJECTED 0x1D 155 #define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E 156 #define ERROR_CODE_UNSPECIFIED_ERROR 0x1F 157 #define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20 158 #define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED 0x21 159 #define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22 160 #define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION 0x23 161 #define ERROR_CODE_LMP_PDU_NOT_ALLOWED 0x24 162 #define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE 0x25 163 #define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED 0x26 164 #define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED 0x27 165 #define ERROR_CODE_INSTANT_PASSED 0x28 166 #define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED 0x29 167 #define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION 0x2A 168 #define ERROR_CODE_RESERVED 0x2B 169 #define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER 0x2C 170 #define ERROR_CODE_QOS_REJECTED 0x2D 171 #define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED 0x2E 172 #define ERROR_CODE_INSUFFICIENT_SECURITY 0x2F 173 #define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE 0x30 174 // #define ERROR_CODE_RESERVED 175 #define ERROR_CODE_ROLE_SWITCH_PENDING 0x32 176 // #define ERROR_CODE_RESERVED 177 #define ERROR_CODE_RESERVED_SLOT_VIOLATION 0x34 178 #define ERROR_CODE_ROLE_SWITCH_FAILED 0x35 179 #define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE 0x36 180 #define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37 181 #define ERROR_CODE_HOST_BUSY_PAIRING 0x38 182 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39 183 #define ERROR_CODE_CONTROLLER_BUSY 0x3A 184 #define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS 0x3B 185 #define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT 0x3C 186 #define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D 187 #define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED 0x3E 188 #define ERROR_CODE_MAC_CONNECTION_FAILED 0x3F 189 #define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40 190 191 // HCI roles 192 #define HCI_ROLE_MASTER 0 193 #define HCI_ROLE_SLAVE 1 194 195 // packet sizes (max payload) 196 #define HCI_ACL_DM1_SIZE 17 197 #define HCI_ACL_DH1_SIZE 27 198 #define HCI_ACL_2DH1_SIZE 54 199 #define HCI_ACL_3DH1_SIZE 83 200 #define HCI_ACL_DM3_SIZE 121 201 #define HCI_ACL_DH3_SIZE 183 202 #define HCI_ACL_DM5_SIZE 224 203 #define HCI_ACL_DH5_SIZE 339 204 #define HCI_ACL_2DH3_SIZE 367 205 #define HCI_ACL_3DH3_SIZE 552 206 #define HCI_ACL_2DH5_SIZE 679 207 #define HCI_ACL_3DH5_SIZE 1021 208 209 #define HCI_EVENT_PAYLOAD_SIZE 255 210 #define HCI_CMD_PAYLOAD_SIZE 255 211 212 #define LE_ADVERTISING_DATA_SIZE 31 213 214 /** 215 * Default INQ Mode 216 */ 217 #define HCI_INQUIRY_LAP 0x9E8B33L // 0x9E8B33: General/Unlimited Inquiry Access Code (GIAC) 218 219 /** 220 * SSP IO Capabilities 221 */ 222 #define SSP_IO_CAPABILITY_DISPLAY_ONLY 0 223 #define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1 224 #define SSP_IO_CAPABILITY_KEYBOARD_ONLY 2 225 #define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3 226 #define SSP_IO_CAPABILITY_UNKNOWN 0xff 227 228 229 /** 230 * SSP Authentication Requirements, see IO Capability Request Reply Commmand 231 */ 232 233 // Numeric comparison with automatic accept allowed. 234 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00 235 236 // Use IO Capabilities to deter- mine authentication procedure 237 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01 238 239 // Numeric compar- ison with automatic accept allowed. 240 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02 241 242 // Use IO Capabilities to determine authentication procedure 243 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03 244 245 // Numeric Compari- son with automatic accept allowed. 246 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04 247 248 // Use IO capabilities to determine authentication procedure. 249 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05 250 251 252 // OGFs 253 #define OGF_LINK_CONTROL 0x01 254 #define OGF_LINK_POLICY 0x02 255 #define OGF_CONTROLLER_BASEBAND 0x03 256 #define OGF_INFORMATIONAL_PARAMETERS 0x04 257 #define OGF_STATUS_PARAMETERS 0x05 258 #define OGF_TESTING 0x06 259 #define OGF_LE_CONTROLLER 0x08 260 #define OGF_VENDOR 0x3f 261 262 263 // Events from host controller to host 264 265 /** 266 * @format 1 267 * @param status 268 */ 269 #define HCI_EVENT_INQUIRY_COMPLETE 0x01 270 // no format yet, can contain multiple results 271 272 /** 273 * @format 1B11132 274 * @param num_responses 275 * @param bd_addr 276 * @param page_scan_repetition_mode 277 * @param reserved1 278 * @param reserved2 279 * @param class_of_device 280 * @param clock_offset 281 */ 282 #define HCI_EVENT_INQUIRY_RESULT 0x02 283 284 /** 285 * @format 12B11 286 * @param status 287 * @param connection_handle 288 * @param bd_addr 289 * @param link_type 290 * @param encryption_enabled 291 */ 292 #define HCI_EVENT_CONNECTION_COMPLETE 0x03 293 /** 294 * @format B31 295 * @param bd_addr 296 * @param class_of_device 297 * @param link_type 298 */ 299 #define HCI_EVENT_CONNECTION_REQUEST 0x04 300 /** 301 * @format 121 302 * @param status 303 * @param connection_handle 304 * @param reason 305 */ 306 #define HCI_EVENT_DISCONNECTION_COMPLETE 0x05 307 /** 308 * @format 12 309 * @param status 310 * @param connection_handle 311 */ 312 #define HCI_EVENT_AUTHENTICATION_COMPLETE_EVENT 0x06 313 /** 314 * @format 1BN 315 * @param status 316 * @param bd_addr 317 * @param remote_name 318 */ 319 #define HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 0x07 320 /** 321 * @format 121 322 * @param status 323 * @param connection_handle 324 * @param encryption_enabled 325 */ 326 #define HCI_EVENT_ENCRYPTION_CHANGE 0x08 327 /** 328 * @format 12 329 * @param status 330 * @param connection_handle 331 */ 332 #define HCI_EVENT_CHANGE_CONNECTION_LINK_KEY_COMPLETE 0x09 333 /** 334 * @format 121 335 * @param status 336 * @param connection_handle 337 * @param key_flag 338 */ 339 #define HCI_EVENT_MASTER_LINK_KEY_COMPLETE 0x0A 340 #define HCI_EVENT_READ_REMOTE_SUPPORTED_FEATURES_COMPLETE 0x0B 341 #define HCI_EVENT_READ_REMOTE_VERSION_INFORMATION_COMPLETE 0x0C 342 #define HCI_EVENT_QOS_SETUP_COMPLETE 0x0D 343 344 /** 345 * @format 12R 346 * @param num_hci_command_packets 347 * @param command_opcode 348 * @param return_parameters 349 */ 350 #define HCI_EVENT_COMMAND_COMPLETE 0x0E 351 /** 352 * @format 112 353 * @param status 354 * @param num_hci_command_packets 355 * @param command_opcode 356 */ 357 #define HCI_EVENT_COMMAND_STATUS 0x0F 358 359 /** 360 * @format 121 361 * @param hardware_code 362 */ 363 #define HCI_EVENT_HARDWARE_ERROR 0x10 364 365 #define HCI_EVENT_FLUSH_OCCURED 0x11 366 367 /** 368 * @format 1B1 369 * @param status 370 * @param bd_addr 371 * @param role 372 */ 373 #define HCI_EVENT_ROLE_CHANGE 0x12 374 375 #define HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS 0x13 376 #define HCI_EVENT_MODE_CHANGE_EVENT 0x14 377 #define HCI_EVENT_RETURN_LINK_KEYS 0x15 378 #define HCI_EVENT_PIN_CODE_REQUEST 0x16 379 #define HCI_EVENT_LINK_KEY_REQUEST 0x17 380 #define HCI_EVENT_LINK_KEY_NOTIFICATION 0x18 381 #define HCI_EVENT_DATA_BUFFER_OVERFLOW 0x1A 382 #define HCI_EVENT_MAX_SLOTS_CHANGED 0x1B 383 #define HCI_EVENT_READ_CLOCK_OFFSET_COMPLETE 0x1C 384 #define HCI_EVENT_PACKET_TYPE_CHANGED 0x1D 385 386 /** 387 * @format 1B11321 388 * @param num_responses 389 * @param bd_addr 390 * @param page_scan_repetition_mode 391 * @param reserved 392 * @param class_of_device 393 * @param clock_offset 394 * @param rssi 395 */ 396 #define HCI_EVENT_INQUIRY_RESULT_WITH_RSSI 0x22 397 398 /** 399 * @format 1HB111221 400 * @param status 401 * @param handle 402 * @param bd_addr 403 * @param link_type 404 * @param transmission_interval 405 * @param retransmission_interval 406 * @param rx_packet_length 407 * @param tx_packet_length 408 * @param air_mode 409 */ 410 #define HCI_EVENT_SYNCHRONOUS_CONNECTION_COMPLETE 0x2C 411 412 // TODO: serialize extended_inquiry_response and provide parser 413 /** 414 * @format 1B11321 415 * @param num_responses 416 * @param bd_addr 417 * @param page_scan_repetition_mode 418 * @param reserved 419 * @param class_of_device 420 * @param clock_offset 421 * @param rssi 422 */ 423 #define HCI_EVENT_EXTENDED_INQUIRY_RESPONSE 0x2F 424 425 /** 426 * @format 1H 427 * @param status 428 * @param handle 429 */ 430 #define HCI_EVENT_ENCRYPTION_KEY_REFRESH_COMPLETE 0x30 431 432 #define HCI_EVENT_IO_CAPABILITY_REQUEST 0x31 433 #define HCI_EVENT_IO_CAPABILITY_RESPONSE 0x32 434 #define HCI_EVENT_USER_CONFIRMATION_REQUEST 0x33 435 #define HCI_EVENT_USER_PASSKEY_REQUEST 0x34 436 #define HCI_EVENT_REMOTE_OOB_DATA_REQUEST 0x35 437 #define HCI_EVENT_SIMPLE_PAIRING_COMPLETE 0x36 438 439 #define HCI_EVENT_LE_META 0x3E 440 441 #define HCI_EVENT_VENDOR_SPECIFIC 0xFF 442 443 /** 444 * @format 11211B2221 445 * @param subevent_code 446 * @param status 447 * @param connection_handle 448 * @param role 449 * @param peer_address_type 450 * @param peer_address 451 * @param conn_interval 452 * @param conn_latency 453 * @param supervision_timeout 454 * @param master_clock_accuracy 455 */ 456 #define HCI_SUBEVENT_LE_CONNECTION_COMPLETE 0x01 457 #define HCI_SUBEVENT_LE_ADVERTISING_REPORT 0x02 458 #define HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE 0x03 459 #define HCI_SUBEVENT_LE_READ_REMOTE_USED_FEATURES_COMPLETE 0x04 460 #define HCI_SUBEVENT_LE_LONG_TERM_KEY_REQUEST 0x05 461 462 // last used HCI_EVENT in 2.1 is 0x3d 463 // last used HCI_EVENT in 4.1 is 0x57 464 465 /** 466 * L2CAP Layer 467 */ 468 469 #define L2CAP_HEADER_SIZE 4 470 471 #define L2CAP_SIG_ID_INVALID 0 472 473 // size of HCI ACL + L2CAP Header for regular data packets (8) 474 #define COMPLETE_L2CAP_HEADER (HCI_ACL_HEADER_SIZE + L2CAP_HEADER_SIZE) 475 476 // minimum signaling MTU 477 #define L2CAP_MINIMAL_MTU 48 478 #define L2CAP_DEFAULT_MTU 672 479 480 // Minimum/default MTU 481 #define L2CAP_LE_DEFAULT_MTU 23 482 483 // L2CAP Fixed Channel IDs 484 #define L2CAP_CID_SIGNALING 0x0001 485 #define L2CAP_CID_CONNECTIONLESS_CHANNEL 0x0002 486 #define L2CAP_CID_ATTRIBUTE_PROTOCOL 0x0004 487 #define L2CAP_CID_SIGNALING_LE 0x0005 488 #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006 489 490 // L2CAP Configuration Result Codes 491 #define L2CAP_CONF_RESULT_UNKNOWN_OPTIONS 0x0003 492 493 // L2CAP Reject Result Codes 494 #define L2CAP_REJ_CMD_UNKNOWN 0x0000 495 496 // Response Timeout eXpired 497 #define L2CAP_RTX_TIMEOUT_MS 10000 498 499 // Extended Response Timeout eXpired 500 #define L2CAP_ERTX_TIMEOUT_MS 120000 501 502 // Fixed PSM numbers 503 #define PSM_SDP 0x01 504 #define PSM_RFCOMM 0x03 505 #define PSM_BNEP 0x0F 506 #define PSM_HID_CONTROL 0x11 507 #define PSM_HID_INTERRUPT 0x13 508 509 /** 510 * SDP Protocl 511 */ 512 513 // PDU Types 514 typedef enum { 515 SDP_Invalid = 0, 516 SDP_ErrorResponse = 1, 517 SDP_ServiceSearchRequest, 518 SDP_ServiceSearchResponse, 519 SDP_ServiceAttributeRequest, 520 SDP_ServiceAttributeResponse, 521 SDP_ServiceSearchAttributeRequest, 522 SDP_ServiceSearchAttributeResponse 523 } SDP_PDU_ID_t; 524 525 // UNIVERSAL ATTRIBUTE DEFINITIONS 526 #define SDP_ServiceRecordHandle 0x0000 527 #define SDP_ServiceClassIDList 0x0001 528 #define SDP_ServiceRecordState 0x0002 529 #define SDP_ServiceID 0x0003 530 #define SDP_ProtocolDescriptorList 0x0004 531 #define SDP_BrowseGroupList 0x0005 532 #define SDP_LanguageBaseAttributeIDList 0x0006 533 #define SDP_ServiceInfoTimeToLive 0x0007 534 #define SDP_ServiceAvailability 0x0008 535 #define SDP_BluetoothProfileDescriptorList 0x0009 536 #define SDP_DocumentationURL 0x000a 537 #define SDP_ClientExecutableURL 0x000b 538 #define SDP_IconURL 0x000c 539 #define SDP_AdditionalProtocolDescriptorList 0x000d 540 #define SDP_SupportedFormatsList 0x0303 541 542 // SERVICE CLASSES 543 #define SDP_OBEXObjectPush 0x1105 544 #define SDP_OBEXFileTransfer 0x1106 545 #define SDP_PublicBrowseGroup 0x1002 546 #define SDP_HSP 0x1108 547 #define SDP_Headset_AG 0x1112 548 #define SDP_PANU 0x1115 549 #define SDP_NAP 0x1116 550 #define SDP_GN 0x1117 551 #define SDP_Handsfree 0x111E 552 #define SDP_HandsfreeAudioGateway 0x111F 553 #define SDP_Headset_HS 0x1131 554 #define SDP_GenericAudio 0x1203 555 556 557 // PROTOCOLS 558 #define SDP_SDPProtocol 0x0001 559 #define SDP_UDPProtocol 0x0002 560 #define SDP_RFCOMMProtocol 0x0003 561 #define SDP_OBEXProtocol 0x0008 562 #define SDP_L2CAPProtocol 0x0100 563 #define SDP_BNEPProtocol 0x000F 564 #define SDP_AVDTPProtocol 0x0019 565 566 // OFFSETS FOR LOCALIZED ATTRIBUTES - SDP_LanguageBaseAttributeIDList 567 #define SDP_Offest_ServiceName 0x0000 568 #define SDP_Offest_ServiceDescription 0x0001 569 #define SDP_Offest_ProviderName 0x0002 570 571 // OBEX 572 #define SDP_vCard_2_1 0x01 573 #define SDP_vCard_3_0 0x02 574 #define SDP_vCal_1_0 0x03 575 #define SDP_iCal_2_0 0x04 576 #define SDP_vNote 0x05 577 #define SDP_vMessage 0x06 578 #define SDP_OBEXFileTypeAny 0xFF 579 580 /** 581 * RFCOMM Protocol 582 */ 583 584 // Control field values bit no. 1 2 3 4 PF 6 7 8 585 #define BT_RFCOMM_SABM 0x3F // 1 1 1 1 1 1 0 0 586 #define BT_RFCOMM_UA 0x73 // 1 1 0 0 1 1 1 0 587 #define BT_RFCOMM_DM 0x0F // 1 1 1 1 0 0 0 0 588 #define BT_RFCOMM_DM_PF 0x1F // 1 1 1 1 1 0 0 0 589 #define BT_RFCOMM_DISC 0x53 // 1 1 0 0 1 0 1 0 590 #define BT_RFCOMM_UIH 0xEF // 1 1 1 1 0 1 1 1 591 #define BT_RFCOMM_UIH_PF 0xFF // 1 1 1 1 0 1 1 1 592 593 // Multiplexer message types 594 #define BT_RFCOMM_CLD_CMD 0xC3 595 #define BT_RFCOMM_FCON_CMD 0xA3 596 #define BT_RFCOMM_FCON_RSP 0xA1 597 #define BT_RFCOMM_FCOFF_CMD 0x63 598 #define BT_RFCOMM_FCOFF_RSP 0x61 599 #define BT_RFCOMM_MSC_CMD 0xE3 600 #define BT_RFCOMM_MSC_RSP 0xE1 601 #define BT_RFCOMM_NSC_RSP 0x11 602 #define BT_RFCOMM_PN_CMD 0x83 603 #define BT_RFCOMM_PN_RSP 0x81 604 #define BT_RFCOMM_RLS_CMD 0x53 605 #define BT_RFCOMM_RLS_RSP 0x51 606 #define BT_RFCOMM_RPN_CMD 0x93 607 #define BT_RFCOMM_RPN_RSP 0x91 608 #define BT_RFCOMM_TEST_CMD 0x23 609 #define BT_RFCOMM_TEST_RSP 0x21 610 611 // Line Status 612 #define LINE_STATUS_NO_ERROR 0x00 613 #define LINE_STATUS_OVERRUN_ERROR 0x03 614 #define LINE_STATUS_PARITY_ERORR 0x05 615 #define LINE_STATUS_FRAMING_ERROR 0x09 616 617 // Modem Status Flags 618 #define MODEM_STATUS_FC 0x02 619 #define MODEM_STATUS_RTC 0x04 620 #define MODEM_STATUS_RTR 0x08 621 #define MODEM_STATUS_IC 0x40 622 #define MODEM_STATUS_DV 0x80 623 624 typedef enum rpn_baud { 625 RPN_BAUD_2400 = 0, 626 RPN_BAUD_4800, 627 RPN_BAUD_7200, 628 RPN_BAUD_9600, 629 RPN_BAUD_19200, 630 RPN_BAUD_38400, 631 RPN_BAUD_57600, 632 RPN_BAUD_115200, 633 RPN_BAUD_230400 634 } rpn_baud_t; 635 636 typedef enum rpn_data_bits { 637 RPN_DATA_BITS_5 = 0, 638 RPN_DATA_BITS_6 = 0, 639 RPN_DATA_BITS_7 = 0, 640 RPN_DATA_BITS_8 = 0 641 } rpn_data_bits_t; 642 643 typedef enum rpn_stop_bits { 644 RPN_STOP_BITS_1_0 = 0, 645 RPN_STOP_BITS_1_5 646 } rpn_stop_bits_t; 647 648 typedef enum rpn_parity { 649 RPN_PARITY_NONE = 0, 650 RPN_PARITY_ODD = 1, 651 RPN_PARITY_EVEN = 3, 652 RPN_PARITY_MARK = 5, 653 RPN_PARITY_SPACE = 7, 654 } rpn_parity_t; 655 656 typedef enum rpn_flow_control { 657 RPN_FLOW_CONTROL_XONXOFF_ON_INPUT = 1 << 0, 658 RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT = 1 << 1, 659 RPN_FLOW_CONTROL_RTR_ON_INPUT = 1 << 2, 660 RPN_FLOW_CONTROL_RTR_ON_OUTPUT = 1 << 3, 661 RPN_FLOW_CONTROL_RTC_ON_INPUT = 1 << 4, 662 RPN_FLOW_CONTROL_RTC_ON_OUTPUT = 1 << 5, 663 } rpn_flow_control_t; 664 665 #define RPN_PARAM_MASK_0_BAUD 0x01 666 #define RPN_PARAM_MASK_0_DATA_BITS 0x02 667 #define RPN_PARAM_MASK_0_STOP_BITS 0x04 668 #define RPN_PARAM_MASK_0_PARITY 0x08 669 #define RPN_PARAM_MASK_0_PARITY_TYPE 0x10 670 #define RPN_PARAM_MASK_0_XON_CHAR 0x20 671 #define RPN_PARAM_MASK_0_XOFF_CHAR 0x40 672 #define RPN_PARAM_MASK_0_RESERVED 0x80 673 674 // @note: values are identical to rpn_flow_control_t 675 #define RPN_PARAM_MASK_1_XONOFF_ON_INPUT 0x01 676 #define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02 677 #define RPN_PARAM_MASK_1_RTR_ON_INPUT 0x04 678 #define RPN_PARAM_MASK_1_RTR_ON_OUTPUT 0x08 679 #define RPN_PARAM_MASK_1_RTC_ON_INPUT 0x10 680 #define RPN_PARAM_MASK_1_RTC_ON_OUTPUT 0x20 681 #define RPN_PARAM_MASK_1_RESERVED_0 0x40 682 #define RPN_PARAM_MASK_1_RESERVED_1 0x80 683 684 /** 685 * BNEP Protocol 686 */ 687 688 #ifndef ETHER_ADDR_LEN 689 #define ETHER_ADDR_LEN 6 690 #endif 691 692 #ifndef ETHERTYPE_VLAN 693 #define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tag */ 694 #endif 695 696 #define BNEP_MTU_MIN 1691 697 698 #define BNEP_EXT_FLAG 0x80 699 #define BNEP_TYPE_MASK 0x7F 700 #define BNEP_TYPE(header) ((header) & BNEP_TYPE_MASK) 701 #define BNEP_HEADER_HAS_EXT(x) (((x) & BNEP_EXT_FLAG) == BNEP_EXT_FLAG) 702 703 /* BNEP packet types */ 704 #define BNEP_PKT_TYPE_GENERAL_ETHERNET 0x00 705 #define BNEP_PKT_TYPE_CONTROL 0x01 706 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET 0x02 707 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_SOURCE_ONLY 0x03 708 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_DEST_ONLY 0x04 709 710 /* BNEP control types */ 711 #define BNEP_CONTROL_TYPE_COMMAND_NOT_UNDERSTOOD 0x00 712 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_REQUEST 0x01 713 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_RESPONSE 0x02 714 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_SET 0x03 715 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_RESPONSE 0x04 716 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_SET 0x05 717 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_RESPONSE 0x06 718 719 /* BNEP extension header types */ 720 #define BNEP_EXT_HEADER_TYPE_EXTENSION_CONTROL 0x00 721 722 /* BNEP setup response codes */ 723 #define BNEP_RESP_SETUP_SUCCESS 0x0000 724 #define BNEP_RESP_SETUP_INVALID_DEST_UUID 0x0001 725 #define BNEP_RESP_SETUP_INVALID_SOURCE_UUID 0x0002 726 #define BNEP_RESP_SETUP_INVALID_SERVICE_UUID_SIZE 0x0003 727 #define BNEP_RESP_SETUP_CONNECTION_NOT_ALLOWED 0x0004 728 729 /* BNEP filter response codes */ 730 #define BNEP_RESP_FILTER_SUCCESS 0x0000 731 #define BNEP_RESP_FILTER_UNSUPPORTED_REQUEST 0x0001 732 #define BNEP_RESP_FILTER_ERR_INVALID_RANGE 0x0002 733 #define BNEP_RESP_FILTER_ERR_TOO_MANY_FILTERS 0x0003 734 #define BNEP_RESP_FILTER_ERR_SECURITY 0x0004 735 736 /** 737 * PAN Profile 738 */ 739 740 typedef enum { 741 PANU_UUID = 0x1115, 742 NAP_UUID = 0x1116, 743 GN_UUID = 0x1117 744 } bnep_service_uuid_t; 745 746 typedef enum { 747 BNEP_SECURITY_NONE = 0x0000, 748 BNEP_SECURITY_SERVICE_LEVEL_ENFORCED, 749 BNEP_SECURITY_802_1X 750 } security_description_t; 751 752 typedef enum { 753 PAN_NET_ACCESS_TYPE_PSTN = 0x0000, 754 PAN_NET_ACCESS_TYPE_ISDN, 755 PAN_NET_ACCESS_TYPE_DSL, 756 PAN_NET_ACCESS_TYPE_CABLE_MODEM, 757 PAN_NET_ACCESS_TYPE_10MB_ETHERNET, 758 PAN_NET_ACCESS_TYPE_100MB_ETHERNET, 759 PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING, 760 PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING, 761 PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING, 762 PAN_NET_ACCESS_TYPE_FDDI, 763 PAN_NET_ACCESS_TYPE_GSM, 764 PAN_NET_ACCESS_TYPE_CDMA, 765 PAN_NET_ACCESS_TYPE_GPRS, 766 PAN_NET_ACCESS_TYPE_3G, 767 PAN_NET_ACCESS_TYPE_CELULAR, 768 PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE, 769 PAN_NET_ACCESS_TYPE_NONE 770 } net_access_type_t; 771 772 /** 773 * ATT 774 */ 775 776 // Minimum/default MTU 777 #define ATT_DEFAULT_MTU 23 778 779 // MARK: Attribute PDU Opcodes 780 #define ATT_ERROR_RESPONSE 0x01 781 782 #define ATT_EXCHANGE_MTU_REQUEST 0x02 783 #define ATT_EXCHANGE_MTU_RESPONSE 0x03 784 785 #define ATT_FIND_INFORMATION_REQUEST 0x04 786 #define ATT_FIND_INFORMATION_REPLY 0x05 787 #define ATT_FIND_BY_TYPE_VALUE_REQUEST 0x06 788 #define ATT_FIND_BY_TYPE_VALUE_RESPONSE 0x07 789 790 #define ATT_READ_BY_TYPE_REQUEST 0x08 791 #define ATT_READ_BY_TYPE_RESPONSE 0x09 792 #define ATT_READ_REQUEST 0x0a 793 #define ATT_READ_RESPONSE 0x0b 794 #define ATT_READ_BLOB_REQUEST 0x0c 795 #define ATT_READ_BLOB_RESPONSE 0x0d 796 #define ATT_READ_MULTIPLE_REQUEST 0x0e 797 #define ATT_READ_MULTIPLE_RESPONSE 0x0f 798 #define ATT_READ_BY_GROUP_TYPE_REQUEST 0x10 799 #define ATT_READ_BY_GROUP_TYPE_RESPONSE 0x11 800 801 #define ATT_WRITE_REQUEST 0x12 802 #define ATT_WRITE_RESPONSE 0x13 803 804 #define ATT_PREPARE_WRITE_REQUEST 0x16 805 #define ATT_PREPARE_WRITE_RESPONSE 0x17 806 #define ATT_EXECUTE_WRITE_REQUEST 0x18 807 #define ATT_EXECUTE_WRITE_RESPONSE 0x19 808 809 #define ATT_HANDLE_VALUE_NOTIFICATION 0x1b 810 #define ATT_HANDLE_VALUE_INDICATION 0x1d 811 #define ATT_HANDLE_VALUE_CONFIRMATION 0x1e 812 813 814 #define ATT_WRITE_COMMAND 0x52 815 #define ATT_SIGNED_WRITE_COMMAND 0xD2 816 817 // MARK: ATT Error Codes 818 #define ATT_ERROR_INVALID_HANDLE 0x01 819 #define ATT_ERROR_READ_NOT_PERMITTED 0x02 820 #define ATT_ERROR_WRITE_NOT_PERMITTED 0x03 821 #define ATT_ERROR_INVALID_PDU 0x04 822 #define ATT_ERROR_INSUFFICIENT_AUTHENTICATION 0x05 823 #define ATT_ERROR_REQUEST_NOT_SUPPORTED 0x06 824 #define ATT_ERROR_INVALID_OFFSET 0x07 825 #define ATT_ERROR_INSUFFICIENT_AUTHORIZATION 0x08 826 #define ATT_ERROR_PREPARE_QUEUE_FULL 0x09 827 #define ATT_ERROR_ATTRIBUTE_NOT_FOUND 0x0a 828 #define ATT_ERROR_ATTRIBUTE_NOT_LONG 0x0b 829 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c 830 #define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH 0x0d 831 #define ATT_ERROR_UNLIKELY_ERROR 0x0e 832 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION 0x0f 833 #define ATT_ERROR_UNSUPPORTED_GROUP_TYPE 0x10 834 #define ATT_ERROR_INSUFFICIENT_RESOURCES 0x11 835 836 // MARK: Attribute Property Flags 837 #define ATT_PROPERTY_BROADCAST 0x01 838 #define ATT_PROPERTY_READ 0x02 839 #define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04 840 #define ATT_PROPERTY_WRITE 0x08 841 #define ATT_PROPERTY_NOTIFY 0x10 842 #define ATT_PROPERTY_INDICATE 0x20 843 #define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40 844 #define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80 845 846 // MARK: Attribute Property Flag, BTstack extension 847 // value is asked from client 848 #define ATT_PROPERTY_DYNAMIC 0x100 849 // 128 bit UUID used 850 #define ATT_PROPERTY_UUID128 0x200 851 // Authentication required 852 #define ATT_PROPERTY_AUTHENTICATION_REQUIRED 0x400 853 // Authorization from user required 854 #define ATT_PROPERTY_AUTHORIZATION_REQUIRED 0x800 855 // Encryption key size stored in upper 4 bits, 0 == no encryption, encryption key size - 1 otherwise 856 857 // ATT Transaction Timeout of 30 seconds for Command/Response or Incidationc/Confirmation 858 #define ATT_TRANSACTION_TIMEOUT_MS 30000 859 860 #define ATT_TRANSACTION_MODE_NONE 0x0 861 #define ATT_TRANSACTION_MODE_ACTIVE 0x1 862 #define ATT_TRANSACTION_MODE_EXECUTE 0x2 863 #define ATT_TRANSACTION_MODE_CANCEL 0x3 864 865 // MARK: GATT UUIDs 866 #define GATT_PRIMARY_SERVICE_UUID 0x2800 867 #define GATT_SECONDARY_SERVICE_UUID 0x2801 868 #define GATT_INCLUDE_SERVICE_UUID 0x2802 869 #define GATT_CHARACTERISTICS_UUID 0x2803 870 #define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES 0x2900 871 #define GATT_CHARACTERISTIC_USER_DESCRIPTION 0x2901 872 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION 0x2902 873 #define GATT_SERVER_CHARACTERISTICS_CONFIGURATION 0x2903 874 #define GATT_CHARACTERISTIC_PRESENTATION_FORMAT 0x2904 875 #define GATT_CHARACTERISTIC_AGGREGATE_FORMAT 0x2905 876 877 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE 0 878 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 1 879 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 2 880 881 // GAP Service and Characteristics 882 #define GAP_SERVICE_UUID 0x1800 883 #define GAP_DEVICE_NAME_UUID 0x2a00 884 #define GAP_APPEARANCE_UUID 0x2a01 885 #define GAP_PERIPHERAL_PRIVACY_FLAG 0x2a02 886 #define GAP_RECONNECTION_ADDRESS_UUID 0x2a03 887 #define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04 888 #define GAP_SERVICE_CHANGED 0x2a05 889 890 /** 891 * SM - LE Security Manager 892 */ 893 // Bluetooth Spec definitions 894 typedef enum { 895 SM_CODE_PAIRING_REQUEST = 0X01, 896 SM_CODE_PAIRING_RESPONSE, 897 SM_CODE_PAIRING_CONFIRM, 898 SM_CODE_PAIRING_RANDOM, 899 SM_CODE_PAIRING_FAILED, 900 SM_CODE_ENCRYPTION_INFORMATION, 901 SM_CODE_MASTER_IDENTIFICATION, 902 SM_CODE_IDENTITY_INFORMATION, 903 SM_CODE_IDENTITY_ADDRESS_INFORMATION, 904 SM_CODE_SIGNING_INFORMATION, 905 SM_CODE_SECURITY_REQUEST 906 } SECURITY_MANAGER_COMMANDS; 907 908 // IO Capability Values 909 typedef enum { 910 IO_CAPABILITY_DISPLAY_ONLY = 0, 911 IO_CAPABILITY_DISPLAY_YES_NO, 912 IO_CAPABILITY_KEYBOARD_ONLY, 913 IO_CAPABILITY_NO_INPUT_NO_OUTPUT, 914 IO_CAPABILITY_KEYBOARD_DISPLAY, // not used by secure simple pairing 915 } io_capability_t; 916 917 // Authentication requirement flags 918 #define SM_AUTHREQ_NO_BONDING 0x00 919 #define SM_AUTHREQ_BONDING 0x01 920 #define SM_AUTHREQ_MITM_PROTECTION 0x04 921 922 // Key distribution flags used by spec 923 #define SM_KEYDIST_ENC_KEY 0X01 924 #define SM_KEYDIST_ID_KEY 0x02 925 #define SM_KEYDIST_SIGN 0x04 926 927 // Key distribution flags used internally 928 #define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION 0x01 929 #define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION 0x02 930 #define SM_KEYDIST_FLAG_IDENTITY_INFORMATION 0x04 931 #define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08 932 #define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION 0x10 933 934 // STK Generation Methods 935 #define SM_STK_GENERATION_METHOD_JUST_WORKS 0x01 936 #define SM_STK_GENERATION_METHOD_OOB 0x02 937 #define SM_STK_GENERATION_METHOD_PASSKEY 0x04 938 939 // Pairing Failed Reasons 940 #define SM_REASON_RESERVED 0x00 941 #define SM_REASON_PASSKEYT_ENTRY_FAILED 0x01 942 #define SM_REASON_OOB_NOT_AVAILABLE 0x02 943 #define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03 944 #define SM_REASON_CONFIRM_VALUE_FAILED 0x04 945 #define SM_REASON_PAIRING_NOT_SUPPORTED 0x05 946 #define SM_REASON_ENCRYPTION_KEY_SIZE 0x06 947 #define SM_REASON_COMMAND_NOT_SUPPORTED 0x07 948 #define SM_REASON_UNSPECIFIED_REASON 0x08 949 #define SM_REASON_REPEATED_ATTEMPTS 0x09 950 // also, invalid parameters 951 // and reserved 952 953 // Company identifiers / manufacturers 954 #define COMPANY_ID_CAMBRIDGE_SILICON_RADIO 0x000A 955 #define COMPANY_ID_TEXAS_INSTRUMENTS_INC 0x000D 956 #define COMPANY_ID_BROADCOM_CORPORATION 0x000F 957 #define COMPANY_ID_ST_MICROELECTRONICS 0x0030 958 #define COMPANY_ID_EM_MICROELECTRONICS_MARIN 0x005A 959 960 961 #endif