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