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