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