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