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