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