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 = 0xfc, 74 BD_ADDR_TYPE_ACL = 0xfd, 75 BD_ADDR_TYPE_UNKNOWN = 0xfe, // also used as 'invalid' 76 } bd_addr_type_t; 77 78 /** 79 * Link types for BR/EDR Connections 80 */ 81 typedef enum { 82 HCI_LINK_TYPE_SCO = 0, 83 HCI_LINK_TYPE_ACL = 1, 84 HCI_LINK_TYPE_ESCO = 2, 85 } hci_link_type_t; 86 87 88 /** 89 * @brief link key 90 */ 91 #define LINK_KEY_LEN 16 92 #define LINK_KEY_STR_LEN (LINK_KEY_LEN*2) 93 typedef uint8_t link_key_t[LINK_KEY_LEN]; 94 95 /** 96 * @brief link key type 97 */ 98 typedef enum { 99 INVALID_LINK_KEY = 0xffff, 100 COMBINATION_KEY = 0, // standard pairing 101 LOCAL_UNIT_KEY, // ? 102 REMOTE_UNIT_KEY, // ? 103 DEBUG_COMBINATION_KEY, // SSP with debug 104 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Simple Pairing 105 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Passkey, Number confirm, OOB 106 CHANGED_COMBINATION_KEY, // Link key changed using Change Connection Lnk Key 107 UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Simpe Pairing 108 AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Passkey, Number confirm, OOB 109 } link_key_type_t; 110 111 /** 112 * @brief Extended Inquiry Response 113 */ 114 #define EXTENDED_INQUIRY_RESPONSE_DATA_LEN 240 115 116 /** 117 * @brief Inquiry modes 118 */ 119 typedef enum { 120 INQUIRY_MODE_STANDARD = 0, 121 INQUIRY_MODE_RSSI, 122 INQUIRY_MODE_RSSI_AND_EIR, 123 } inquiry_mode_t; 124 125 /** 126 * @brief Page Scan Types 127 */ 128 typedef enum { 129 PAGE_SCAN_MODE_STANDARD = 0, 130 PAGE_SCAN_MODE_INTERLACED, 131 } page_scan_type_t; 132 133 /** 134 * @brief Inquiry Scan Types 135 */ 136 typedef enum { 137 INQUIRY_SCAN_MODE_STANDARD = 0, 138 INQUIRY_SCAN_MODE_INTERLACED, 139 } inquiry_scan_type_t; 140 141 /** 142 * Link Supervision Timeout Default, 0x7d00 * 0.625ms = 20s 143 */ 144 #define HCI_LINK_SUPERVISION_TIMEOUT_DEFAULT 0x7D00 145 146 /** 147 * Service Type used for QoS Setup and Flow Specification 148 */ 149 typedef enum { 150 HCI_SERVICE_TYPE_NO_TRAFFIC = 0, 151 HCI_SERVICE_TYPE_BEST_EFFORT, 152 HCI_SERVICE_TYPE_GUARANTEED, 153 HCI_SERVICE_TYPE_INVALID, 154 } hci_service_type_t; 155 156 /** 157 * HCI Transport 158 */ 159 160 /** 161 * packet types - used in BTstack and over the H4 UART interface 162 */ 163 #define HCI_COMMAND_DATA_PACKET 0x01 164 #define HCI_ACL_DATA_PACKET 0x02 165 #define HCI_SCO_DATA_PACKET 0x03 166 #define HCI_EVENT_PACKET 0x04 167 168 /** 169 * HCI Layer 170 */ 171 172 // 173 // Error Codes rfom Bluetooth Core Specification 174 // 175 176 /* ENUM_START: BLUETOOTH_ERROR_CODE */ 177 #define ERROR_CODE_SUCCESS 0x00 178 #define ERROR_CODE_UNKNOWN_HCI_COMMAND 0x01 179 #define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER 0x02 180 #define ERROR_CODE_HARDWARE_FAILURE 0x03 181 #define ERROR_CODE_PAGE_TIMEOUT 0x04 182 #define ERROR_CODE_AUTHENTICATION_FAILURE 0x05 183 #define ERROR_CODE_PIN_OR_KEY_MISSING 0x06 184 #define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED 0x07 185 #define ERROR_CODE_CONNECTION_TIMEOUT 0x08 186 #define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED 0x09 187 #define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED 0x0A 188 #define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS 0x0B 189 #define ERROR_CODE_COMMAND_DISALLOWED 0x0C 190 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D 191 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS 0x0E 192 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F 193 #define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED 0x10 194 #define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE 0x11 195 #define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS 0x12 196 #define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION 0x13 197 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14 198 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF 0x15 199 #define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST 0x16 200 #define ERROR_CODE_REPEATED_ATTEMPTS 0x17 201 #define ERROR_CODE_PAIRING_NOT_ALLOWED 0x18 202 #define ERROR_CODE_UNKNOWN_LMP_PDU 0x19 203 #define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A 204 #define ERROR_CODE_SCO_OFFSET_REJECTED 0x1B 205 #define ERROR_CODE_SCO_INTERVAL_REJECTED 0x1C 206 #define ERROR_CODE_SCO_AIR_MODE_REJECTED 0x1D 207 #define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E 208 #define ERROR_CODE_UNSPECIFIED_ERROR 0x1F 209 #define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20 210 #define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED 0x21 211 #define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22 212 #define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION 0x23 213 #define ERROR_CODE_LMP_PDU_NOT_ALLOWED 0x24 214 #define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE 0x25 215 #define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED 0x26 216 #define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED 0x27 217 #define ERROR_CODE_INSTANT_PASSED 0x28 218 #define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED 0x29 219 #define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION 0x2A 220 #define ERROR_CODE_RESERVED 0x2B 221 #define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER 0x2C 222 #define ERROR_CODE_QOS_REJECTED 0x2D 223 #define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED 0x2E 224 #define ERROR_CODE_INSUFFICIENT_SECURITY 0x2F 225 #define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE 0x30 226 // #define ERROR_CODE_RESERVED 227 #define ERROR_CODE_ROLE_SWITCH_PENDING 0x32 228 // #define ERROR_CODE_RESERVED 229 #define ERROR_CODE_RESERVED_SLOT_VIOLATION 0x34 230 #define ERROR_CODE_ROLE_SWITCH_FAILED 0x35 231 #define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE 0x36 232 #define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37 233 #define ERROR_CODE_HOST_BUSY_PAIRING 0x38 234 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39 235 #define ERROR_CODE_CONTROLLER_BUSY 0x3A 236 #define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS 0x3B 237 #define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT 0x3C 238 #define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D 239 #define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED 0x3E 240 #define ERROR_CODE_MAC_CONNECTION_FAILED 0x3F 241 #define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40 242 243 // BTstack defined ERRORS, mapped into BLuetooth status code range 244 245 #define BTSTACK_CONNECTION_TO_BTDAEMON_FAILED 0x50 246 #define BTSTACK_ACTIVATION_FAILED_SYSTEM_BLUETOOTH 0x51 247 #define BTSTACK_ACTIVATION_POWERON_FAILED 0x52 248 #define BTSTACK_ACTIVATION_FAILED_UNKNOWN 0x53 249 #define BTSTACK_NOT_ACTIVATED 0x54 250 #define BTSTACK_BUSY 0x55 251 #define BTSTACK_MEMORY_ALLOC_FAILED 0x56 252 #define BTSTACK_ACL_BUFFERS_FULL 0x57 253 254 // l2cap errors - enumeration by the command that created them 255 #define L2CAP_COMMAND_REJECT_REASON_COMMAND_NOT_UNDERSTOOD 0x60 256 #define L2CAP_COMMAND_REJECT_REASON_SIGNALING_MTU_EXCEEDED 0x61 257 #define L2CAP_COMMAND_REJECT_REASON_INVALID_CID_IN_REQUEST 0x62 258 259 #define L2CAP_CONNECTION_RESPONSE_RESULT_SUCCESSFUL 0x63 260 #define L2CAP_CONNECTION_RESPONSE_RESULT_PENDING 0x64 261 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_PSM 0x65 262 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_SECURITY 0x66 263 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_RESOURCES 0x67 264 #define L2CAP_CONNECTION_RESPONSE_RESULT_ERTM_NOT_SUPPORTED 0x68 265 266 // should be L2CAP_CONNECTION_RTX_TIMEOUT 267 #define L2CAP_CONNECTION_RESPONSE_RESULT_RTX_TIMEOUT 0x69 268 #define L2CAP_CONNECTION_BASEBAND_DISCONNECT 0x6A 269 #define L2CAP_SERVICE_ALREADY_REGISTERED 0x6B 270 #define L2CAP_DATA_LEN_EXCEEDS_REMOTE_MTU 0x6C 271 #define L2CAP_SERVICE_DOES_NOT_EXIST 0x6D 272 #define L2CAP_LOCAL_CID_DOES_NOT_EXIST 0x6E 273 274 #define RFCOMM_MULTIPLEXER_STOPPED 0x70 275 #define RFCOMM_CHANNEL_ALREADY_REGISTERED 0x71 276 #define RFCOMM_NO_OUTGOING_CREDITS 0x72 277 #define RFCOMM_AGGREGATE_FLOW_OFF 0x73 278 #define RFCOMM_DATA_LEN_EXCEEDS_MTU 0x74 279 280 #define HFP_REMOTE_REJECTS_AUDIO_CONNECTION 0x7F 281 282 #define SDP_HANDLE_ALREADY_REGISTERED 0x80 283 #define SDP_QUERY_INCOMPLETE 0x81 284 #define SDP_SERVICE_NOT_FOUND 0x82 285 #define SDP_HANDLE_INVALID 0x83 286 #define SDP_QUERY_BUSY 0x84 287 288 #define ATT_HANDLE_VALUE_INDICATION_IN_PROGRESS 0x90 289 #define ATT_HANDLE_VALUE_INDICATION_TIMEOUT 0x91 290 #define ATT_HANDLE_VALUE_INDICATION_DISCONNECT 0x92 291 292 #define GATT_CLIENT_NOT_CONNECTED 0x93 293 #define GATT_CLIENT_BUSY 0x94 294 #define GATT_CLIENT_IN_WRONG_STATE 0x95 295 #define GATT_CLIENT_DIFFERENT_CONTEXT_FOR_ADDRESS_ALREADY_EXISTS 0x96 296 #define GATT_CLIENT_VALUE_TOO_LONG 0x97 297 #define GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED 0x98 298 #define GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED 0x99 299 300 #define BNEP_SERVICE_ALREADY_REGISTERED 0xA0 301 #define BNEP_CHANNEL_NOT_CONNECTED 0xA1 302 #define BNEP_DATA_LEN_EXCEEDS_MTU 0xA2 303 304 // OBEX ERRORS 305 #define OBEX_UNKNOWN_ERROR 0xB0 306 #define OBEX_CONNECT_FAILED 0xB1 307 #define OBEX_DISCONNECTED 0xB2 308 #define OBEX_NOT_FOUND 0xB3 309 #define OBEX_NOT_ACCEPTABLE 0xB4 310 311 #define MESH_ERROR_APPKEY_INDEX_INVALID 0xD0 312 /* ENUM_END */ 313 314 315 /* ENUM_START: AVRCP_BROWSING_ERROR_CODE */ 316 #define AVRCP_BROWSING_ERROR_CODE_INVALID_COMMAND 0x00 // Sent if TG received a PDU that it did not understand. Valid for All. 317 #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. 318 #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. 319 #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. 320 #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. 321 #define AVRCP_BROWSING_ERROR_CODE_UID_CHANGED 0x05 // The UIDs on the device have changed. Valid for All. 322 #define AVRCP_BROWSING_ERROR_CODE_RESERVED_06 0x06 // Valid for All. 323 #define AVRCP_BROWSING_ERROR_CODE_INVALID_DIRECTION 0x07 // The Direction parameter is invalid. Valid for Change Path. 324 #define AVRCP_BROWSING_ERROR_CODE_NOT_A_DIRECTORY 0x08 // The UID provided does not refer to a folder item. Valid for Change Path. 325 #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. 326 #define AVRCP_BROWSING_ERROR_CODE_INVALID_SCOPE 0x0a // The scope parameter is invalid. Valid for GetFolderItems, PlayItem, AddToNowPlayer, GetItemAttributes,. 327 #define AVRCP_BROWSING_ERROR_CODE_RANGE_OUT_OF_BOUNDS 0x0b // The start of range provided is not valid. Valid for GetFolderItems. 328 #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. 329 #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. 330 #define AVRCP_BROWSING_ERROR_CODE_NOW_PLAYING_LIST_FULL 0x0e // No more items can be added to the Now Playing List. Valid for AddToNowPlaying. 331 #define AVRCP_BROWSING_ERROR_CODE_SEARCH_NOT_SUPPORTED 0x0f // The Browsed Media Player does not support search. Valid for Search. 332 #define AVRCP_BROWSING_ERROR_CODE_SEARCH_IN_PROGRESS 0x10 // A search operation is already in progress. Valid for Search. 333 #define AVRCP_BROWSING_ERROR_CODE_INVALID_PLAYER_ID 0x11 // The specified Player Id does not refer to a valid player. Valid for SetAddressedPlayer, SetBrowsedPlayer. 334 #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. 335 #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. 336 #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. 337 #define AVRCP_BROWSING_ERROR_CODE_NO_AVAILABLE_PLAYERS 0x15 // Valid for All. 338 #define AVRCP_BROWSING_ERROR_CODE_ADDRESSED_PLAYER_CHANGED 0x16 // Valid for Register Notification. 339 // 0x17-0xff Reserved 340 /* ENUM_END */ 341 342 // HCI roles 343 typedef enum { 344 HCI_ROLE_MASTER = 0, 345 HCI_ROLE_SLAVE = 1, 346 HCI_ROLE_INVALID = 0xff, 347 } hci_role_t; 348 349 // packet sizes (max payload) 350 #define HCI_ACL_DM1_SIZE 17 351 #define HCI_ACL_DH1_SIZE 27 352 #define HCI_ACL_2DH1_SIZE 54 353 #define HCI_ACL_3DH1_SIZE 83 354 #define HCI_ACL_DM3_SIZE 121 355 #define HCI_ACL_DH3_SIZE 183 356 #define HCI_ACL_DM5_SIZE 224 357 #define HCI_ACL_DH5_SIZE 339 358 #define HCI_ACL_2DH3_SIZE 367 359 #define HCI_ACL_3DH3_SIZE 552 360 #define HCI_ACL_2DH5_SIZE 679 361 #define HCI_ACL_3DH5_SIZE 1021 362 363 #define LE_ADVERTISING_DATA_SIZE 31 364 365 // SCO Packet Types 366 #define SCO_PACKET_TYPES_NONE 0x0000 367 #define SCO_PACKET_TYPES_HV1 0x0001 368 #define SCO_PACKET_TYPES_HV3 0x0004 369 #define SCO_PACKET_TYPES_EV3 0x0008 370 #define SCO_PACKET_TYPES_2EV3 0x0040 371 #define SCO_PACKET_TYPES_ALL 0x03FF 372 373 // Link Policy Settings 374 #define LM_LINK_POLICY_DISABLE_ALL_LM_MODES 0 375 #define LM_LINK_POLICY_ENABLE_ROLE_SWITCH 1 376 #define LM_LINK_POLICY_ENABLE_HOLD_MODE 2 377 #define LM_LINK_POLICY_ENABLE_SNIFF_MODE 4 378 379 // ACL Connection Modes 380 #define ACL_CONNECTION_MODE_ACTIVE 0 381 #define ACL_CONNECTION_MODE_HOLD 1 382 #define ACL_CONNECTION_MODE_SNIFF 2 383 384 /** 385 * Default INQ Mode 386 */ 387 #define GAP_IAC_GENERAL_INQUIRY 0x9E8B33L // General/Unlimited Inquiry Access Code (GIAC) 388 #define GAP_IAC_LIMITED_INQUIRY 0x9E8B00L // Limited Dedicated Inquiry Access Code (LIAC) 389 390 /** 391 * SSP IO Capabilities 392 */ 393 #define SSP_IO_CAPABILITY_DISPLAY_ONLY 0 394 #define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1 395 #define SSP_IO_CAPABILITY_KEYBOARD_ONLY 2 396 #define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3 397 #define SSP_IO_CAPABILITY_UNKNOWN 0xff 398 399 400 /** 401 * SSP Authentication Requirements, see IO Capability Request Reply Commmand 402 */ 403 404 // Numeric comparison with automatic accept allowed. 405 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00 406 407 // Use IO Capabilities to deter- mine authentication procedure 408 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01 409 410 // Numeric compar- ison with automatic accept allowed. 411 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02 412 413 // Use IO Capabilities to determine authentication procedure 414 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03 415 416 // Numeric Compari- son with automatic accept allowed. 417 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04 418 419 // Use IO capabilities to determine authentication procedure. 420 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05 421 422 423 // OGFs 424 #define OGF_LINK_CONTROL 0x01 425 #define OGF_LINK_POLICY 0x02 426 #define OGF_CONTROLLER_BASEBAND 0x03 427 #define OGF_INFORMATIONAL_PARAMETERS 0x04 428 #define OGF_STATUS_PARAMETERS 0x05 429 #define OGF_TESTING 0x06 430 #define OGF_LE_CONTROLLER 0x08 431 #define OGF_VENDOR 0x3f 432 433 434 435 436 /** 437 * L2CAP Layer 438 */ 439 440 #define L2CAP_HEADER_SIZE 4 441 442 // minimum signaling MTU 443 #define L2CAP_MINIMAL_MTU 48 444 #define L2CAP_DEFAULT_MTU 672 445 446 // Minimum/default MTU 447 #define L2CAP_LE_DEFAULT_MTU 23 448 449 // L2CAP Fixed Channel IDs 450 #define L2CAP_CID_SIGNALING 0x0001 451 #define L2CAP_CID_CONNECTIONLESS_CHANNEL 0x0002 452 #define L2CAP_CID_ATTRIBUTE_PROTOCOL 0x0004 453 #define L2CAP_CID_SIGNALING_LE 0x0005 454 #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006 455 #define L2CAP_CID_BR_EDR_SECURITY_MANAGER 0x0007 456 /** 457 * SDP Protocol 458 */ 459 460 // Device Vendor ID Sources 461 #define DEVICE_ID_VENDOR_ID_SOURCE_BLUETOOTH 0x0001 462 #define DEVICE_ID_VENDOR_ID_SOURCE_USB 0x0002 463 464 // OBEX 465 #define SDP_vCard_2_1 0x01 466 #define SDP_vCard_3_0 0x02 467 #define SDP_vCal_1_0 0x03 468 #define SDP_iCal_2_0 0x04 469 #define SDP_vNote 0x05 470 #define SDP_vMessage 0x06 471 #define SDP_OBEXFileTypeAny 0xFF 472 473 /** 474 * RFCOMM Protocol 475 */ 476 477 // Line Status 478 #define LINE_STATUS_NO_ERROR 0x00 479 #define LINE_STATUS_OVERRUN_ERROR 0x03 480 #define LINE_STATUS_PARITY_ERORR 0x05 481 #define LINE_STATUS_FRAMING_ERROR 0x09 482 483 // Modem Status Flags 484 #define MODEM_STATUS_FC 0x02 485 #define MODEM_STATUS_RTC 0x04 486 #define MODEM_STATUS_RTR 0x08 487 #define MODEM_STATUS_IC 0x40 488 #define MODEM_STATUS_DV 0x80 489 490 typedef enum rpn_baud { 491 RPN_BAUD_2400 = 0, 492 RPN_BAUD_4800, 493 RPN_BAUD_7200, 494 RPN_BAUD_9600, 495 RPN_BAUD_19200, 496 RPN_BAUD_38400, 497 RPN_BAUD_57600, 498 RPN_BAUD_115200, 499 RPN_BAUD_230400 500 } rpn_baud_t; 501 502 typedef enum rpn_data_bits { 503 RPN_DATA_BITS_5 = 0, 504 RPN_DATA_BITS_6 = 0, 505 RPN_DATA_BITS_7 = 0, 506 RPN_DATA_BITS_8 = 0 507 } rpn_data_bits_t; 508 509 typedef enum rpn_stop_bits { 510 RPN_STOP_BITS_1_0 = 0, 511 RPN_STOP_BITS_1_5 512 } rpn_stop_bits_t; 513 514 typedef enum rpn_parity { 515 RPN_PARITY_NONE = 0, 516 RPN_PARITY_ODD = 1, 517 RPN_PARITY_EVEN = 3, 518 RPN_PARITY_MARK = 5, 519 RPN_PARITY_SPACE = 7, 520 } rpn_parity_t; 521 522 typedef enum rpn_flow_control { 523 RPN_FLOW_CONTROL_XONXOFF_ON_INPUT = 1 << 0, 524 RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT = 1 << 1, 525 RPN_FLOW_CONTROL_RTR_ON_INPUT = 1 << 2, 526 RPN_FLOW_CONTROL_RTR_ON_OUTPUT = 1 << 3, 527 RPN_FLOW_CONTROL_RTC_ON_INPUT = 1 << 4, 528 RPN_FLOW_CONTROL_RTC_ON_OUTPUT = 1 << 5, 529 } rpn_flow_control_t; 530 531 #define RPN_PARAM_MASK_0_BAUD 0x01 532 #define RPN_PARAM_MASK_0_DATA_BITS 0x02 533 #define RPN_PARAM_MASK_0_STOP_BITS 0x04 534 #define RPN_PARAM_MASK_0_PARITY 0x08 535 #define RPN_PARAM_MASK_0_PARITY_TYPE 0x10 536 #define RPN_PARAM_MASK_0_XON_CHAR 0x20 537 #define RPN_PARAM_MASK_0_XOFF_CHAR 0x40 538 #define RPN_PARAM_MASK_0_RESERVED 0x80 539 540 // @note: values are identical to rpn_flow_control_t 541 #define RPN_PARAM_MASK_1_XONOFF_ON_INPUT 0x01 542 #define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02 543 #define RPN_PARAM_MASK_1_RTR_ON_INPUT 0x04 544 #define RPN_PARAM_MASK_1_RTR_ON_OUTPUT 0x08 545 #define RPN_PARAM_MASK_1_RTC_ON_INPUT 0x10 546 #define RPN_PARAM_MASK_1_RTC_ON_OUTPUT 0x20 547 #define RPN_PARAM_MASK_1_RESERVED_0 0x40 548 #define RPN_PARAM_MASK_1_RESERVED_1 0x80 549 550 /** 551 * BNEP Protocol 552 */ 553 554 #ifndef ETHER_ADDR_LEN 555 #define ETHER_ADDR_LEN 6 556 #endif 557 558 #ifndef ETHERTYPE_VLAN 559 #define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tag */ 560 #endif 561 562 #define BNEP_MTU_MIN 1691 563 564 565 /** 566 * PAN Profile 567 */ 568 569 typedef enum { 570 BNEP_SECURITY_NONE = 0x0000, 571 BNEP_SECURITY_SERVICE_LEVEL_ENFORCED, 572 BNEP_SECURITY_802_1X 573 } security_description_t; 574 575 typedef enum { 576 PAN_NET_ACCESS_TYPE_PSTN = 0x0000, 577 PAN_NET_ACCESS_TYPE_ISDN, 578 PAN_NET_ACCESS_TYPE_DSL, 579 PAN_NET_ACCESS_TYPE_CABLE_MODEM, 580 PAN_NET_ACCESS_TYPE_10MB_ETHERNET, 581 PAN_NET_ACCESS_TYPE_100MB_ETHERNET, 582 PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING, 583 PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING, 584 PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING, 585 PAN_NET_ACCESS_TYPE_FDDI, 586 PAN_NET_ACCESS_TYPE_GSM, 587 PAN_NET_ACCESS_TYPE_CDMA, 588 PAN_NET_ACCESS_TYPE_GPRS, 589 PAN_NET_ACCESS_TYPE_3G, 590 PAN_NET_ACCESS_TYPE_CELULAR, 591 PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE, 592 PAN_NET_ACCESS_TYPE_NONE 593 } net_access_type_t; 594 595 /** 596 * ATT 597 */ 598 599 // Minimum/default MTU 600 #define ATT_DEFAULT_MTU 23 601 602 // MARK: ATT Error Codes 603 #define ATT_ERROR_SUCCESS 0x00 604 #define ATT_ERROR_INVALID_HANDLE 0x01 605 #define ATT_ERROR_READ_NOT_PERMITTED 0x02 606 #define ATT_ERROR_WRITE_NOT_PERMITTED 0x03 607 #define ATT_ERROR_INVALID_PDU 0x04 608 #define ATT_ERROR_INSUFFICIENT_AUTHENTICATION 0x05 609 #define ATT_ERROR_REQUEST_NOT_SUPPORTED 0x06 610 #define ATT_ERROR_INVALID_OFFSET 0x07 611 #define ATT_ERROR_INSUFFICIENT_AUTHORIZATION 0x08 612 #define ATT_ERROR_PREPARE_QUEUE_FULL 0x09 613 #define ATT_ERROR_ATTRIBUTE_NOT_FOUND 0x0a 614 #define ATT_ERROR_ATTRIBUTE_NOT_LONG 0x0b 615 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c 616 #define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH 0x0d 617 #define ATT_ERROR_UNLIKELY_ERROR 0x0e 618 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION 0x0f 619 #define ATT_ERROR_UNSUPPORTED_GROUP_TYPE 0x10 620 #define ATT_ERROR_INSUFFICIENT_RESOURCES 0x11 621 622 // MARK: ATT Error Codes defined by BTstack 623 #define ATT_ERROR_HCI_DISCONNECT_RECEIVED 0x1f 624 #define ATT_ERROR_BONDING_INFORMATION_MISSING 0x70 625 #define ATT_ERROR_DATA_MISMATCH 0x7e 626 #define ATT_ERROR_TIMEOUT 0x7F 627 #define ATT_ERROR_WRITE_RESPONSE_PENDING 0x100 628 629 // MARK: ATT Error Codes from Cycling Power Service spec 630 #define CYCLING_POWER_ERROR_CODE_INAPPROPRIATE_CONNECTION_PARAMETERS 0x80 631 #define CYCLING_POWER_ERROR_CODE_PROCEDURE_ALREADY_IN_PROGRESS 0xFE 632 #define CYCLING_POWER_ERROR_CODE_CCC_DESCRIPTOR_IMPROPERLY_CONFIGURED 0xFD 633 634 // MARK: ATT Error Codes from Cycling Speed and Cadence Service spec 635 #define CYCLING_SPEED_AND_CADENCE_ERROR_CODE_PROCEDURE_ALREADY_IN_PROGRESS 0x80 636 #define CYCLING_SPEED_AND_CADENCE_ERROR_CODE_CCC_DESCRIPTOR_IMPROPERLY_CONFIGURED 0x81 637 638 639 // MARK: Attribute Property Flags 640 #define ATT_PROPERTY_BROADCAST 0x01 641 #define ATT_PROPERTY_READ 0x02 642 #define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04 643 #define ATT_PROPERTY_WRITE 0x08 644 #define ATT_PROPERTY_NOTIFY 0x10 645 #define ATT_PROPERTY_INDICATE 0x20 646 #define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40 647 #define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80 648 649 // MARK: Attribute Property Flag, BTstack extension 650 // value is asked from client 651 #define ATT_PROPERTY_DYNAMIC 0x100 652 653 // Security levels 654 #define ATT_SECURITY_NONE 0 655 #define ATT_SECURITY_ENCRYPTED 1 656 #define ATT_SECURITY_AUTHENTICATED 2 657 #define ATT_SECURITY_AUTHORIZED 3 658 #define ATT_SECURITY_AUTHENTICATED_SC 4 659 660 // ATT Transaction Timeout of 30 seconds for Command/Response or Indication/Confirmation 661 #define ATT_TRANSACTION_TIMEOUT_MS 30000 662 663 #define ATT_TRANSACTION_MODE_NONE 0x0 664 #define ATT_TRANSACTION_MODE_ACTIVE 0x1 665 #define ATT_TRANSACTION_MODE_EXECUTE 0x2 666 #define ATT_TRANSACTION_MODE_CANCEL 0x3 667 #define ATT_TRANSACTION_MODE_VALIDATE 0x4 668 669 // MARK: GATT UUIDs 670 #define GATT_PRIMARY_SERVICE_UUID 0x2800 671 #define GATT_SECONDARY_SERVICE_UUID 0x2801 672 #define GATT_INCLUDE_SERVICE_UUID 0x2802 673 #define GATT_CHARACTERISTICS_UUID 0x2803 674 #define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES 0x2900 675 #define GATT_CHARACTERISTIC_USER_DESCRIPTION 0x2901 676 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION 0x2902 677 #define GATT_SERVER_CHARACTERISTICS_CONFIGURATION 0x2903 678 #define GATT_CHARACTERISTIC_PRESENTATION_FORMAT 0x2904 679 #define GATT_CHARACTERISTIC_AGGREGATE_FORMAT 0x2905 680 681 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE 0 682 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 1 683 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 2 684 685 #define GATT_CLIENT_ANY_CONNECTION 0xffff 686 #define GATT_CLIENT_ANY_VALUE_HANDLE 0x0000 687 688 // GAP Service and Characteristics 689 #define GAP_SERVICE_UUID 0x1800 690 #define GAP_DEVICE_NAME_UUID 0x2a00 691 #define GAP_APPEARANCE_UUID 0x2a01 692 #define GAP_PERIPHERAL_PRIVACY_FLAG 0x2a02 693 #define GAP_RECONNECTION_ADDRESS_UUID 0x2a03 694 #define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04 695 #define GAP_SERVICE_CHANGED 0x2a05 696 697 // Bluetooth GATT types 698 699 typedef struct { 700 uint16_t year; // 0 - year is not known; or [1582,9999] 701 uint8_t month; // 0 - month is not known; or [1,12] 702 uint8_t day; // 0 - day is not known; or [1,31] 703 uint8_t hours; // [0,23] 704 uint8_t minutes; // [0,59] 705 uint8_t seconds; // [0,59] 706 } gatt_date_time_t; 707 708 /** 709 * SM - LE Security Manager 710 */ 711 // Bluetooth Spec definitions 712 typedef enum { 713 SM_CODE_PAIRING_REQUEST = 0X01, 714 SM_CODE_PAIRING_RESPONSE, 715 SM_CODE_PAIRING_CONFIRM, 716 SM_CODE_PAIRING_RANDOM, 717 SM_CODE_PAIRING_FAILED, 718 SM_CODE_ENCRYPTION_INFORMATION, 719 SM_CODE_MASTER_IDENTIFICATION, 720 SM_CODE_IDENTITY_INFORMATION, 721 SM_CODE_IDENTITY_ADDRESS_INFORMATION, 722 SM_CODE_SIGNING_INFORMATION, 723 SM_CODE_SECURITY_REQUEST, 724 SM_CODE_PAIRING_PUBLIC_KEY, 725 SM_CODE_PAIRING_DHKEY_CHECK, 726 SM_CODE_KEYPRESS_NOTIFICATION, 727 } SECURITY_MANAGER_COMMANDS; 728 729 // IO Capability Values 730 typedef enum { 731 IO_CAPABILITY_DISPLAY_ONLY = 0, 732 IO_CAPABILITY_DISPLAY_YES_NO, 733 IO_CAPABILITY_KEYBOARD_ONLY, 734 IO_CAPABILITY_NO_INPUT_NO_OUTPUT, 735 IO_CAPABILITY_KEYBOARD_DISPLAY, // not used by secure simple pairing 736 } io_capability_t; 737 738 // Authentication requirement flags 739 #define SM_AUTHREQ_NO_BONDING 0x00 740 #define SM_AUTHREQ_BONDING 0x01 741 #define SM_AUTHREQ_MITM_PROTECTION 0x04 742 #define SM_AUTHREQ_SECURE_CONNECTION 0x08 743 #define SM_AUTHREQ_KEYPRESS 0x10 744 #define SM_AUTHREQ_CT2 0x20 745 746 // Key distribution flags used by spec 747 #define SM_KEYDIST_ENC_KEY 0x01 748 #define SM_KEYDIST_ID_KEY 0x02 749 #define SM_KEYDIST_SIGN 0x04 750 #define SM_KEYDIST_LINK_KEY 0x08 751 752 // Key distribution flags used internally 753 #define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION 0x01 754 #define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION 0x02 755 #define SM_KEYDIST_FLAG_IDENTITY_INFORMATION 0x04 756 #define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08 757 #define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION 0x10 758 759 // STK Generation Methods 760 #define SM_STK_GENERATION_METHOD_JUST_WORKS 0x01 761 #define SM_STK_GENERATION_METHOD_OOB 0x02 762 #define SM_STK_GENERATION_METHOD_PASSKEY 0x04 763 #define SM_STK_GENERATION_METHOD_NUMERIC_COMPARISON 0x08 764 765 // Pairing Failed Reasons 766 #define SM_REASON_RESERVED 0x00 767 #define SM_REASON_PASSKEY_ENTRY_FAILED 0x01 768 #define SM_REASON_OOB_NOT_AVAILABLE 0x02 769 #define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03 770 #define SM_REASON_CONFIRM_VALUE_FAILED 0x04 771 #define SM_REASON_PAIRING_NOT_SUPPORTED 0x05 772 #define SM_REASON_ENCRYPTION_KEY_SIZE 0x06 773 #define SM_REASON_COMMAND_NOT_SUPPORTED 0x07 774 #define SM_REASON_UNSPECIFIED_REASON 0x08 775 #define SM_REASON_REPEATED_ATTEMPTS 0x09 776 #define SM_REASON_INVALID_PARAMETERS 0x0a 777 #define SM_REASON_DHKEY_CHECK_FAILED 0x0b 778 #define SM_REASON_NUMERIC_COMPARISON_FAILED 0x0c 779 #define SM_REASON_BR_EDR_PAIRING_IN_PROGRESS 0x0d 780 #define SM_REASON_CROSS_TRANSPORT_KEY_DERIVATION_NOT_ALLOWED 0x0e 781 #define SM_REASON_KEY_REJECTED 0x0f 782 783 // also, invalid parameters 784 // and reserved 785 786 // Keypress Notifications 787 #define SM_KEYPRESS_PASSKEY_ENTRY_STARTED 0x00 788 #define SM_KEYPRESS_PASSKEY_DIGIT_ENTERED 0x01 789 #define SM_KEYPRESS_PASSKEY_DIGIT_ERASED 0x02 790 #define SM_KEYPRESS_PASSKEY_CLEARED 0x03 791 #define SM_KEYPRESS_PASSKEY_ENTRY_COMPLETED 0x04 792 793 794 #endif 795