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