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