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