1 /* 2 * Copyright (C) 2014 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 * @title Host Controler Interface (HCI) 40 * 41 */ 42 43 #ifndef HCI_H 44 #define HCI_H 45 46 #include "btstack_config.h" 47 48 #include "btstack_chipset.h" 49 #include "btstack_control.h" 50 #include "btstack_linked_list.h" 51 #include "btstack_util.h" 52 #include "hci_cmd.h" 53 #include "gap.h" 54 #include "hci_transport.h" 55 #include "btstack_run_loop.h" 56 57 #ifdef ENABLE_CLASSIC 58 #include "classic/btstack_link_key_db.h" 59 #endif 60 61 #ifdef ENABLE_BLE 62 #include "ble/att_db.h" 63 #endif 64 65 #ifdef HAVE_SCO_TRANSPORT 66 #include "btstack_sco_transport.h" 67 #endif 68 69 #include <stdint.h> 70 #include <stdlib.h> 71 #include <stdarg.h> 72 73 #if defined __cplusplus 74 extern "C" { 75 #endif 76 77 // packet buffer sizes 78 #define HCI_CMD_HEADER_SIZE 3 79 #define HCI_ACL_HEADER_SIZE 4 80 #define HCI_SCO_HEADER_SIZE 3 81 #define HCI_EVENT_HEADER_SIZE 2 82 #define HCI_ISO_HEADER_SIZE 4 83 84 #define HCI_EVENT_PAYLOAD_SIZE 255 85 #define HCI_CMD_PAYLOAD_SIZE 255 86 87 // default for ISO streams: 48_6_2 : 2 x 155 88 #ifndef HCI_ISO_PAYLOAD_SIZE 89 #define HCI_ISO_PAYLOAD_SIZE 310 90 #endif 91 92 // Max HCI Command LE payload size: 93 // 64 from LE Generate DHKey command 94 // 32 from LE Encrypt command 95 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS) 96 #define HCI_CMD_PAYLOAD_SIZE_LE 64 97 #else 98 #define HCI_CMD_PAYLOAD_SIZE_LE 32 99 #endif 100 101 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 102 // addition byte in even to terminate remote name request with '\0' 103 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1) 104 105 #ifdef ENABLE_CLASSIC 106 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 107 #else 108 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE_LE) 109 #endif 110 111 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 112 113 // size of hci incoming buffer, big enough for event or acl packet without H4 packet type 114 #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE 115 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 116 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 117 #endif 118 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE 119 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE 120 #endif 121 #else 122 #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE 123 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 124 #else 125 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE 126 #endif 127 #endif 128 129 // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type 130 #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE 131 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 132 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 133 #endif 134 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 135 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 136 #endif 137 #else 138 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 139 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 140 #else 141 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 142 #endif 143 #endif 144 145 // additional pre-buffer space for packets to Bluetooth module 146 // - H4 requires 1 byte for the packet type 147 // - h5 requires 4 bytes for H5 header 148 #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE 149 #ifdef HAVE_HOST_CONTROLLER_API 150 #define HCI_OUTGOING_PRE_BUFFER_SIZE 0 151 #else 152 #ifdef ENABLE_H5 153 #define HCI_OUTGOING_PRE_BUFFER_SIZE 4 154 #else 155 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 156 #endif 157 #endif 158 #endif 159 160 // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads 161 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 162 #ifdef ENABLE_CLASSIC 163 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 164 #else 165 #define HCI_INCOMING_PRE_BUFFER_SIZE 2 166 #endif 167 #endif 168 169 // 170 #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode ) 171 172 // check if command complete event for given command 173 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) ) 174 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_STATUS) && (little_endian_read_16(event,4) == cmd.opcode) ) 175 176 // Code+Len=2, Pkts+Opcode=3; total=5 177 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5 178 179 // ACL Packet 180 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 181 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 182 #define READ_ISO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 183 #define READ_ACL_FLAGS( buffer ) ( buffer[1] >> 4 ) 184 #define READ_ACL_LENGTH( buffer ) (little_endian_read_16(buffer, 2)) 185 186 // Sneak peak into L2CAP Packet 187 #define READ_L2CAP_LENGTH(buffer) ( little_endian_read_16(buffer, 4)) 188 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6)) 189 190 /** 191 * LE connection parameter update state 192 */ 193 194 typedef enum { 195 CON_PARAMETER_UPDATE_NONE, 196 // L2CAP 197 CON_PARAMETER_UPDATE_SEND_REQUEST, 198 CON_PARAMETER_UPDATE_SEND_RESPONSE, 199 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 200 CON_PARAMETER_UPDATE_DENY, 201 // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 202 CON_PARAMETER_UPDATE_REPLY, 203 CON_PARAMETER_UPDATE_NEGATIVE_REPLY, 204 } le_con_parameter_update_state_t; 205 206 // Authentication flags 207 typedef enum { 208 AUTH_FLAG_NONE = 0x0000, 209 AUTH_FLAG_HANDLE_LINK_KEY_REQUEST = 0x0001, 210 AUTH_FLAG_DENY_PIN_CODE_REQUEST = 0x0002, 211 AUTH_FLAG_RECV_IO_CAPABILITIES_REQUEST = 0x0004, 212 AUTH_FLAG_RECV_IO_CAPABILITIES_RESPONSE = 0x0008, 213 AUTH_FLAG_SEND_IO_CAPABILITIES_REPLY = 0x0010, 214 AUTH_FLAG_SEND_IO_CAPABILITIES_NEGATIVE_REPLY = 0x0020, 215 AUTH_FLAG_SEND_USER_CONFIRM_REPLY = 0x0040, 216 AUTH_FLAG_SEND_USER_CONFIRM_NEGATIVE_REPLY = 0x0080, 217 AUTH_FLAG_SEND_USER_PASSKEY_REPLY = 0x0100, 218 219 // Classic OOB 220 AUTH_FLAG_SEND_REMOTE_OOB_DATA_REPLY = 0x0200, 221 222 // pairing status 223 AUTH_FLAG_LEGACY_PAIRING_ACTIVE = 0x0400, 224 AUTH_FLAG_SSP_PAIRING_ACTIVE = 0x0800, 225 AUTH_FLAG_PAIRING_ACTIVE_MASK = (AUTH_FLAG_LEGACY_PAIRING_ACTIVE | AUTH_FLAG_SSP_PAIRING_ACTIVE), 226 227 // connection status 228 AUTH_FLAG_CONNECTION_AUTHENTICATED = 0x1000, 229 AUTH_FLAG_CONNECTION_ENCRYPTED = 0x2000, 230 231 } hci_authentication_flags_t; 232 233 // GAP Connection Tasks 234 #define GAP_CONNECTION_TASK_WRITE_AUTOMATIC_FLUSH_TIMEOUT 0x0001u 235 #define GAP_CONNECTION_TASK_WRITE_SUPERVISION_TIMEOUT 0x0002u 236 #define GAP_CONNECTION_TASK_READ_RSSI 0x0004u 237 #define GAP_CONNECTION_TASK_LE_READ_REMOTE_FEATURES 0x0008u 238 239 /** 240 * Connection State 241 */ 242 typedef enum { 243 SEND_CREATE_CONNECTION = 0, 244 SENT_CREATE_CONNECTION, 245 RECEIVED_CONNECTION_REQUEST, 246 ACCEPTED_CONNECTION_REQUEST, 247 OPEN, 248 SEND_DISCONNECT, 249 SENT_DISCONNECT, 250 RECEIVED_DISCONNECTION_COMPLETE 251 } CONNECTION_STATE; 252 253 // bonding flags 254 enum { 255 // remote features 256 BONDING_REMOTE_FEATURES_QUERY_ACTIVE = 0x0001, 257 BONDING_REQUEST_REMOTE_FEATURES_PAGE_0 = 0x0002, 258 BONDING_REQUEST_REMOTE_FEATURES_PAGE_1 = 0x0004, 259 BONDING_REQUEST_REMOTE_FEATURES_PAGE_2 = 0x0008, 260 BONDING_RECEIVED_REMOTE_FEATURES = 0x0010, 261 BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER = 0x0020, 262 BONDING_REMOTE_SUPPORTS_SSP_HOST = 0x0040, 263 BONDING_REMOTE_SUPPORTS_SC_CONTROLLER = 0x0080, 264 BONDING_REMOTE_SUPPORTS_SC_HOST = 0x0100, 265 // other 266 BONDING_DISCONNECT_SECURITY_BLOCK = 0x0200, 267 BONDING_DISCONNECT_DEDICATED_DONE = 0x0400, 268 BONDING_SEND_AUTHENTICATE_REQUEST = 0x0800, 269 BONDING_SENT_AUTHENTICATE_REQUEST = 0x1000, 270 BONDING_SEND_ENCRYPTION_REQUEST = 0x2000, 271 BONDING_SEND_READ_ENCRYPTION_KEY_SIZE = 0x4000, 272 BONDING_DEDICATED = 0x8000, 273 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x10000, 274 }; 275 276 typedef enum { 277 BLUETOOTH_OFF = 1, 278 BLUETOOTH_ON, 279 BLUETOOTH_ACTIVE 280 } BLUETOOTH_STATE; 281 282 typedef enum { 283 LE_CONNECTING_IDLE, 284 LE_CONNECTING_CANCEL, 285 LE_CONNECTING_DIRECT, 286 LE_CONNECTING_WHITELIST, 287 } le_connecting_state_t; 288 289 #ifdef ENABLE_BLE 290 291 // 292 // SM internal types and globals 293 // 294 295 typedef enum { 296 297 // general states 298 SM_GENERAL_IDLE, 299 SM_GENERAL_SEND_PAIRING_FAILED, 300 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 301 SM_GENERAL_REENCRYPTION_FAILED, 302 303 // Phase 1: Pairing Feature Exchange 304 SM_PH1_W4_USER_RESPONSE, 305 306 // Phase 2: Authenticating and Encrypting 307 308 // get random number for use as TK Passkey if we show it 309 SM_PH2_GET_RANDOM_TK, 310 SM_PH2_W4_RANDOM_TK, 311 312 // get local random number for confirm c1 313 SM_PH2_C1_GET_RANDOM_A, 314 SM_PH2_C1_W4_RANDOM_A, 315 SM_PH2_C1_GET_RANDOM_B, 316 SM_PH2_C1_W4_RANDOM_B, 317 318 // calculate confirm value for local side 319 SM_PH2_C1_GET_ENC_A, 320 SM_PH2_C1_W4_ENC_A, 321 322 // calculate confirm value for remote side 323 SM_PH2_C1_GET_ENC_C, 324 SM_PH2_C1_W4_ENC_C, 325 326 SM_PH2_C1_SEND_PAIRING_CONFIRM, 327 SM_PH2_SEND_PAIRING_RANDOM, 328 329 // calc STK 330 SM_PH2_CALC_STK, 331 SM_PH2_W4_STK, 332 333 SM_PH2_W4_CONNECTION_ENCRYPTED, 334 335 // Phase 3: Transport Specific Key Distribution 336 // calculate DHK, Y, EDIV, and LTK 337 SM_PH3_Y_GET_ENC, 338 SM_PH3_Y_W4_ENC, 339 SM_PH3_LTK_GET_ENC, 340 341 // exchange keys 342 SM_PH3_DISTRIBUTE_KEYS, 343 SM_PH3_RECEIVE_KEYS, 344 345 // Phase 4: re-establish previously distributed LTK 346 SM_PH4_W4_CONNECTION_ENCRYPTED, 347 348 // RESPONDER ROLE 349 SM_RESPONDER_IDLE, 350 SM_RESPONDER_SEND_SECURITY_REQUEST, 351 SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST, 352 SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK, 353 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 354 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 355 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 356 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED_W4_IRK, 357 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 358 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 359 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 360 SM_RESPONDER_PH2_W4_LTK_REQUEST, 361 SM_RESPONDER_PH2_SEND_LTK_REPLY, 362 SM_RESPONDER_PH4_Y_W4_ENC, 363 SM_RESPONDER_PH4_SEND_LTK_REPLY, 364 365 // INITIATOR ROLE 366 SM_INITIATOR_CONNECTED, 367 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 368 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 369 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 370 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 371 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 372 SM_INITIATOR_PH4_HAS_LTK, 373 374 // LE Secure Connections 375 SM_SC_RECEIVED_LTK_REQUEST, 376 SM_SC_SEND_PUBLIC_KEY_COMMAND, 377 SM_SC_W4_PUBLIC_KEY_COMMAND, 378 SM_SC_W4_LOCAL_NONCE, 379 SM_SC_W2_CMAC_FOR_CONFIRMATION, 380 SM_SC_W4_CMAC_FOR_CONFIRMATION, 381 SM_SC_SEND_CONFIRMATION, 382 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 383 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 384 SM_SC_W4_CONFIRMATION, 385 SM_SC_SEND_PAIRING_RANDOM, 386 SM_SC_W4_PAIRING_RANDOM, 387 SM_SC_W2_CALCULATE_G2, 388 SM_SC_W4_CALCULATE_G2, 389 SM_SC_W4_CALCULATE_DHKEY, 390 SM_SC_W2_CALCULATE_F5_SALT, 391 SM_SC_W4_CALCULATE_F5_SALT, 392 SM_SC_W2_CALCULATE_F5_MACKEY, 393 SM_SC_W4_CALCULATE_F5_MACKEY, 394 SM_SC_W2_CALCULATE_F5_LTK, 395 SM_SC_W4_CALCULATE_F5_LTK, 396 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 397 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 398 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 399 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 400 SM_SC_W4_USER_RESPONSE, 401 SM_SC_SEND_DHKEY_CHECK_COMMAND, 402 SM_SC_W4_DHKEY_CHECK_COMMAND, 403 SM_SC_W4_LTK_REQUEST_SC, 404 SM_SC_W2_CALCULATE_ILK_USING_H6, 405 SM_SC_W2_CALCULATE_ILK_USING_H7, 406 SM_SC_W4_CALCULATE_ILK, 407 SM_SC_W2_CALCULATE_BR_EDR_LINK_KEY, 408 SM_SC_W4_CALCULATE_BR_EDR_LINK_KEY, 409 410 // Classic 411 SM_BR_EDR_W4_ENCRYPTION_COMPLETE, 412 SM_BR_EDR_INITIATOR_SEND_PAIRING_REQUEST, 413 SM_BR_EDR_INITIATOR_W4_PAIRING_RESPONSE, 414 SM_BR_EDR_RESPONDER_W4_PAIRING_REQUEST, 415 SM_BR_EDR_RESPONDER_PAIRING_REQUEST_RECEIVED, 416 SM_BR_EDR_DISTRIBUTE_KEYS, 417 SM_BR_EDR_RECEIVE_KEYS, 418 SM_BR_EDR_W2_CALCULATE_ILK_USING_H6, 419 SM_BR_EDR_W2_CALCULATE_ILK_USING_H7, 420 SM_BR_EDR_W4_CALCULATE_ILK, 421 SM_BR_EDR_W2_CALCULATE_LE_LTK, 422 SM_BR_EDR_W4_CALCULATE_LE_LTK, 423 } security_manager_state_t; 424 425 typedef enum { 426 IRK_LOOKUP_IDLE, 427 IRK_LOOKUP_W4_READY, 428 IRK_LOOKUP_STARTED, 429 IRK_LOOKUP_SUCCEEDED, 430 IRK_LOOKUP_FAILED 431 } irk_lookup_state_t; 432 433 typedef uint8_t sm_pairing_packet_t[7]; 434 435 // connection info available as long as connection exists 436 typedef struct sm_connection { 437 hci_con_handle_t sm_handle; 438 uint16_t sm_cid; 439 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 440 uint8_t sm_security_request_received; 441 uint8_t sm_pairing_requested; 442 uint8_t sm_peer_addr_type; 443 bd_addr_t sm_peer_address; 444 uint8_t sm_own_addr_type; 445 bd_addr_t sm_own_address; 446 security_manager_state_t sm_engine_state; 447 irk_lookup_state_t sm_irk_lookup_state; 448 uint8_t sm_pairing_failed_reason; 449 uint8_t sm_connection_encrypted; 450 uint8_t sm_connection_authenticated; // [0..1] 451 uint8_t sm_connection_sc; 452 uint8_t sm_actual_encryption_key_size; 453 sm_pairing_packet_t sm_m_preq; // only used during c1 454 authorization_state_t sm_connection_authorization_state; 455 uint16_t sm_local_ediv; 456 uint8_t sm_local_rand[8]; 457 int sm_le_db_index; 458 bool sm_pairing_active; 459 bool sm_reencryption_active; 460 } sm_connection_t; 461 462 // 463 // ATT Server 464 // 465 466 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 467 #ifndef ATT_REQUEST_BUFFER_SIZE 468 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 469 #endif 470 471 typedef enum { 472 ATT_SERVER_IDLE, 473 ATT_SERVER_REQUEST_RECEIVED, 474 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 475 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 476 ATT_SERVER_RESPONSE_PENDING, 477 } att_server_state_t; 478 479 typedef struct { 480 att_server_state_t state; 481 482 uint8_t peer_addr_type; 483 bd_addr_t peer_address; 484 485 int ir_le_device_db_index; 486 uint8_t ir_lookup_active; 487 uint8_t pairing_active; 488 489 uint16_t value_indication_handle; 490 btstack_timer_source_t value_indication_timer; 491 492 btstack_linked_list_t notification_requests; 493 btstack_linked_list_t indication_requests; 494 495 #ifdef ENABLE_GATT_OVER_CLASSIC 496 uint16_t l2cap_cid; 497 #endif 498 499 uint16_t request_size; 500 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 501 502 } att_server_t; 503 504 #endif 505 506 typedef enum { 507 L2CAP_INFORMATION_STATE_IDLE = 0, 508 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 509 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 510 L2CAP_INFORMATION_STATE_W2_SEND_FIXED_CHANNELS_REQUEST, 511 L2CAP_INFORMATION_STATE_W4_FIXED_CHANNELS_RESPONSE, 512 L2CAP_INFORMATION_STATE_DONE 513 } l2cap_information_state_t; 514 515 typedef struct { 516 l2cap_information_state_t information_state; 517 uint16_t extended_feature_mask; 518 uint16_t fixed_channels_supported; // Core V5.3 - only first octet used 519 } l2cap_state_t; 520 521 // 522 typedef struct { 523 // linked list - assert: first field 524 btstack_linked_item_t item; 525 526 // remote side 527 bd_addr_t address; 528 529 // module handle 530 hci_con_handle_t con_handle; 531 532 // le public, le random, classic 533 bd_addr_type_t address_type; 534 535 // role: 0 - master, 1 - slave 536 uint8_t role; 537 538 // connection state 539 CONNECTION_STATE state; 540 541 // bonding 542 uint32_t bonding_flags; 543 uint8_t bonding_status; 544 545 // encryption key size (in octets) 546 uint8_t encryption_key_size; 547 548 // requested security level 549 gap_security_level_t requested_security_level; 550 551 // link key and its type 552 link_key_t link_key; 553 link_key_type_t link_key_type; 554 555 // remote supported features 556 /* bit 0 - eSCO */ 557 /* bit 1 - extended features */ 558 uint8_t remote_supported_features[1]; 559 560 #ifdef ENABLE_CLASSIC 561 // IO Capabilities Response 562 uint8_t io_cap_response_auth_req; 563 uint8_t io_cap_response_io; 564 #ifdef ENABLE_CLASSIC_PAIRING_OOB 565 uint8_t io_cap_response_oob_data; 566 #endif 567 568 // connection mode, default ACL_CONNECTION_MODE_ACTIVE 569 uint8_t connection_mode; 570 571 // enter/exit sniff mode requests 572 uint16_t sniff_min_interval; // 0: idle, 0xffff exit sniff, else enter sniff 573 uint16_t sniff_max_interval; 574 uint16_t sniff_attempt; 575 uint16_t sniff_timeout; 576 577 // sniff subrating 578 uint16_t sniff_subrating_max_latency; // 0xffff = not set 579 uint16_t sniff_subrating_min_remote_timeout; 580 uint16_t sniff_subrating_min_local_timeout; 581 582 // QoS 583 hci_service_type_t qos_service_type; 584 uint32_t qos_token_rate; 585 uint32_t qos_peak_bandwidth; 586 uint32_t qos_latency; 587 uint32_t qos_delay_variation; 588 589 #ifdef ENABLE_SCO_OVER_HCI 590 // track SCO rx event 591 uint32_t sco_rx_ms; 592 uint8_t sco_rx_count; 593 uint8_t sco_rx_valid; 594 #endif 595 // generate sco can send now based on received packets, using timeout below 596 uint8_t sco_tx_ready; 597 598 // request role switch 599 hci_role_t request_role; 600 601 btstack_timer_source_t timeout_sco; 602 #endif /* ENABLE_CLASSIC */ 603 604 // authentication and other errands 605 uint16_t authentication_flags; 606 607 // gap connection tasks, see GAP_CONNECTION_TASK_x 608 uint16_t gap_connection_tasks; 609 610 btstack_timer_source_t timeout; 611 612 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 613 uint32_t timestamp; 614 615 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 616 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 617 uint16_t acl_recombination_pos; 618 uint16_t acl_recombination_length; 619 620 621 // number packets sent to controller 622 uint8_t num_packets_sent; 623 624 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 625 uint8_t num_packets_completed; 626 #endif 627 628 // LE Connection parameter update 629 le_con_parameter_update_state_t le_con_parameter_update_state; 630 uint8_t le_con_param_update_identifier; 631 uint16_t le_conn_interval_min; 632 uint16_t le_conn_interval_max; 633 uint16_t le_conn_latency; 634 uint16_t le_supervision_timeout; 635 636 #ifdef ENABLE_BLE 637 uint16_t le_connection_interval; 638 639 // LE PHY Update via set phy command 640 uint8_t le_phy_update_all_phys; // 0xff for idle 641 uint8_t le_phy_update_tx_phys; 642 uint8_t le_phy_update_rx_phys; 643 int8_t le_phy_update_phy_options; 644 645 // LE Security Manager 646 sm_connection_t sm_connection; 647 648 #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS 649 uint16_t le_max_tx_octets; 650 #endif 651 652 // ATT Connection 653 att_connection_t att_connection; 654 655 // ATT Server 656 att_server_t att_server; 657 658 #ifdef ENABLE_LE_PERIODIC_ADVERTISING 659 hci_con_handle_t le_past_sync_handle; 660 uint16_t le_past_service_data; 661 #endif 662 663 #endif 664 665 l2cap_state_t l2cap_state; 666 667 #ifdef ENABLE_CLASSIC_PAIRING_OOB 668 const uint8_t * classic_oob_c_192; 669 const uint8_t * classic_oob_r_192; 670 const uint8_t * classic_oob_c_256; 671 const uint8_t * classic_oob_r_256; 672 #endif 673 674 } hci_connection_t; 675 676 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 677 678 679 typedef enum { 680 HCI_ISO_TYPE_INVALID = 0, 681 HCI_ISO_TYPE_BIS, 682 HCI_ISO_TYPE_CIS, 683 } hci_iso_type_t; 684 685 #define HCI_ISO_GROUP_ID_SINGLE_CIS 0xfe 686 #define HCI_ISO_GROUP_ID_INVALID 0xff 687 688 typedef enum{ 689 HCI_ISO_STREAM_STATE_IDLE, 690 HCI_ISO_STREAM_W2_ACCEPT, 691 HCI_ISO_STREAM_W2_REJECT, 692 HCI_ISO_STREAM_STATE_REQUESTED, 693 HCI_ISO_STREAM_STATE_W4_ESTABLISHED, 694 HCI_ISO_STREAM_STATE_ESTABLISHED, 695 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_INPUT, 696 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_INPUT, 697 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_OUTPUT, 698 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_OUTPUT, 699 } hci_iso_stream_state_t; 700 701 typedef struct { 702 // linked list - assert: first field 703 btstack_linked_item_t item; 704 705 // iso type: bis or cis 706 hci_iso_type_t iso_type; 707 708 // group_id: big_handle or cis_id 709 uint8_t group_id; 710 711 // state 712 hci_iso_stream_state_t state; 713 714 // peer info 715 hci_con_handle_t con_handle; 716 717 // connection info 718 uint16_t max_sdu_c_to_p; 719 uint16_t max_sdu_p_to_c; 720 721 // re-assembly buffer 722 uint16_t reassembly_pos; 723 uint8_t reassembly_buffer[HCI_ISO_PAYLOAD_SIZE]; 724 725 // number packets sent to controller 726 uint8_t num_packets_sent; 727 728 // packets to skip due to queuing them to late before 729 uint8_t num_packets_to_skip; 730 731 // request to send 732 bool can_send_now_requested; 733 734 // ready to send 735 bool emit_ready_to_send; 736 737 } hci_iso_stream_t; 738 #endif 739 740 /** 741 * HCI Inititizlization State Machine 742 */ 743 typedef enum hci_init_state{ 744 HCI_INIT_SEND_RESET = 0, 745 HCI_INIT_W4_SEND_RESET, 746 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 747 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 748 749 #ifndef HAVE_HOST_CONTROLLER_API 750 HCI_INIT_SEND_READ_LOCAL_NAME, 751 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 752 HCI_INIT_SEND_BAUD_CHANGE, 753 HCI_INIT_W4_SEND_BAUD_CHANGE, 754 HCI_INIT_CUSTOM_INIT, 755 HCI_INIT_W4_CUSTOM_INIT, 756 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 757 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 758 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 759 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 760 #endif 761 762 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 763 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 764 765 HCI_INIT_SEND_BAUD_CHANGE_BCM, 766 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 767 768 HCI_INIT_SET_BD_ADDR, 769 HCI_INIT_W4_SET_BD_ADDR, 770 771 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 772 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 773 774 HCI_INIT_READ_BD_ADDR, 775 HCI_INIT_W4_READ_BD_ADDR, 776 777 HCI_INIT_READ_BUFFER_SIZE, 778 HCI_INIT_W4_READ_BUFFER_SIZE, 779 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 780 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 781 782 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 783 HCI_INIT_HOST_BUFFER_SIZE, 784 HCI_INIT_W4_HOST_BUFFER_SIZE, 785 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 786 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 787 #endif 788 789 HCI_INIT_SET_EVENT_MASK, 790 HCI_INIT_W4_SET_EVENT_MASK, 791 HCI_INIT_SET_EVENT_MASK_2, 792 HCI_INIT_W4_SET_EVENT_MASK_2, 793 794 #ifdef ENABLE_CLASSIC 795 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 796 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 797 HCI_INIT_WRITE_INQUIRY_MODE, 798 HCI_INIT_W4_WRITE_INQUIRY_MODE, 799 HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 800 HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 801 HCI_INIT_SET_MIN_ENCRYPTION_KEY_SIZE, 802 HCI_INIT_W4_SET_MIN_ENCRYPTION_KEY_SIZE, 803 804 #ifdef ENABLE_SCO_OVER_HCI 805 // SCO over HCI 806 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 807 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 808 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 809 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 810 #endif 811 812 #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM) 813 // Broadcom SCO Routing and Configuration 814 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 815 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 816 #endif 817 #ifdef ENABLE_SCO_OVER_PCM 818 HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 819 HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 820 #endif 821 #endif 822 823 #ifdef ENABLE_BLE 824 HCI_INIT_LE_READ_BUFFER_SIZE, 825 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 826 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 827 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 828 HCI_INIT_LE_SET_EVENT_MASK, 829 HCI_INIT_W4_LE_SET_EVENT_MASK, 830 #endif 831 832 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 833 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 834 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 835 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 836 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 837 #endif 838 839 #ifdef ENABLE_LE_CENTRAL 840 HCI_INIT_READ_WHITE_LIST_SIZE, 841 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 842 #endif 843 844 #ifdef ENABLE_LE_PERIPHERAL 845 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 846 HCI_INIT_LE_READ_MAX_ADV_DATA_LEN, 847 HCI_INIT_W4_LE_READ_MAX_ADV_DATA_LEN, 848 #endif 849 #endif 850 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 851 HCI_INIT_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 852 HCI_INIT_W4_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 853 #endif 854 855 HCI_INIT_DONE, 856 857 HCI_FALLING_ASLEEP_DISCONNECT, 858 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 859 HCI_FALLING_ASLEEP_COMPLETE, 860 861 HCI_INIT_AFTER_SLEEP, 862 863 HCI_HALTING_CLASSIC_STOP, 864 HCI_HALTING_LE_ADV_STOP, 865 HCI_HALTING_LE_SCAN_STOP, 866 HCI_HALTING_DISCONNECT_ALL, 867 HCI_HALTING_W4_CLOSE_TIMER, 868 HCI_HALTING_CLOSE, 869 870 } hci_substate_t; 871 872 #define GAP_TASK_SET_LOCAL_NAME 0x01 873 #define GAP_TASK_SET_EIR_DATA 0x02 874 #define GAP_TASK_SET_CLASS_OF_DEVICE 0x04 875 #define GAP_TASK_SET_DEFAULT_LINK_POLICY 0x08 876 #define GAP_TASK_WRITE_SCAN_ENABLE 0x10 877 #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY 0x20 878 #define GAP_TASK_WRITE_PAGE_SCAN_TYPE 0x40 879 #define GAP_TASK_WRITE_PAGE_TIMEOUT 0x80 880 #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100 881 882 enum { 883 // Tasks 884 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 0, 885 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 1, 886 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 887 LE_ADVERTISEMENT_TASKS_SET_ADDRESS = 1 << 3, 888 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_PARAMS = 1 << 4, 889 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_DATA = 1 << 5, 890 LE_ADVERTISEMENT_TASKS_REMOVE_SET = 1 << 6, 891 }; 892 893 enum { 894 // State 895 LE_ADVERTISEMENT_STATE_PARAMS_SET = 1 << 0, 896 LE_ADVERTISEMENT_STATE_ACTIVE = 1 << 1, 897 LE_ADVERTISEMENT_STATE_ENABLED = 1 << 2, 898 LE_ADVERTISEMENT_STATE_PERIODIC_ACTIVE = 1 << 3, 899 LE_ADVERTISEMENT_STATE_PERIODIC_ENABLED = 1 << 4, 900 }; 901 902 enum { 903 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 904 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 905 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 906 }; 907 908 enum { 909 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ON_CONTROLLER = 1 << 0, 910 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ADD_TO_CONTROLLER = 1 << 1, 911 LE_PERIODIC_ADVERTISER_LIST_ENTRY_REMOVE_FROM_CONTROLLER = 1 << 2, 912 }; 913 914 typedef struct { 915 btstack_linked_item_t item; 916 bd_addr_t address; 917 bd_addr_type_t address_type; 918 uint8_t state; 919 } whitelist_entry_t; 920 921 typedef struct { 922 btstack_linked_item_t item; 923 bd_addr_t address; 924 bd_addr_type_t address_type; 925 uint8_t sid; 926 uint8_t state; 927 } periodic_advertiser_list_entry_t; 928 929 #define MAX_NUM_RESOLVING_LIST_ENTRIES 64 930 typedef enum { 931 LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION, 932 LE_RESOLVING_LIST_READ_SIZE, 933 LE_RESOLVING_LIST_SEND_CLEAR, 934 LE_RESOLVING_LIST_UPDATES_ENTRIES, 935 LE_RESOLVING_LIST_DONE 936 } le_resolving_list_state_t; 937 938 /** 939 * main data structure 940 */ 941 typedef struct { 942 // transport component with configuration 943 const hci_transport_t * hci_transport; 944 const void * config; 945 946 // chipset driver 947 const btstack_chipset_t * chipset; 948 949 // hardware power controller 950 const btstack_control_t * control; 951 952 #ifdef ENABLE_CLASSIC 953 /* link key db */ 954 const btstack_link_key_db_t * link_key_db; 955 #endif 956 957 // list of existing baseband connections 958 btstack_linked_list_t connections; 959 960 /* callback to L2CAP layer */ 961 btstack_packet_handler_t acl_packet_handler; 962 963 /* callback for SCO data */ 964 btstack_packet_handler_t sco_packet_handler; 965 966 /* callbacks for events */ 967 btstack_linked_list_t event_handlers; 968 969 #ifdef ENABLE_CLASSIC 970 /* callback for reject classic connection */ 971 int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type); 972 #endif 973 974 // hardware error callback 975 void (*hardware_error_callback)(uint8_t error); 976 977 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 978 /* callback for ISO data */ 979 btstack_packet_handler_t iso_packet_handler; 980 981 /* fragmentation for ISO data */ 982 uint16_t iso_fragmentation_pos; 983 uint16_t iso_fragmentation_total_size; 984 bool iso_fragmentation_tx_active; 985 986 uint8_t iso_packets_to_queue; 987 // group id and type of active operation 988 hci_iso_type_t iso_active_operation_type; 989 uint8_t iso_active_operation_group_id; 990 991 // list of iso streams 992 btstack_linked_list_t iso_streams; 993 994 // list of BIGs and BIG Syncs 995 btstack_linked_list_t le_audio_bigs; 996 btstack_linked_list_t le_audio_big_syncs; 997 998 // list of CIGs 999 btstack_linked_list_t le_audio_cigs; 1000 #endif 1001 1002 // basic configuration 1003 const char * local_name; 1004 const uint8_t * eir_data; 1005 uint32_t class_of_device; 1006 bd_addr_t local_bd_addr; 1007 uint16_t default_link_policy_settings; 1008 uint8_t allow_role_switch; 1009 uint8_t ssp_enable; 1010 uint8_t ssp_io_capability; 1011 uint8_t ssp_authentication_requirement; 1012 uint8_t ssp_auto_accept; 1013 bool secure_connections_enable; 1014 bool secure_connections_active; 1015 inquiry_mode_t inquiry_mode; 1016 1017 #ifdef ENABLE_CLASSIC 1018 /* GAP tasks, see GAP_TASK_* */ 1019 uint16_t gap_tasks_classic; 1020 1021 /* write page scan activity */ 1022 uint16_t new_page_scan_interval; 1023 uint16_t new_page_scan_window; 1024 1025 /* write page scan type */ 1026 uint8_t new_page_scan_type; 1027 1028 /* write page timeout */ 1029 uint16_t page_timeout; 1030 1031 // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default 1032 uint8_t gap_required_encyrption_key_size; 1033 1034 uint16_t link_supervision_timeout; 1035 uint16_t automatic_flush_timeout; 1036 1037 gap_security_level_t gap_security_level; 1038 gap_security_level_t gap_minimal_service_security_level; 1039 gap_security_mode_t gap_security_mode; 1040 1041 uint32_t inquiry_lap; // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY 1042 uint16_t inquiry_scan_interval; 1043 uint16_t inquiry_scan_window; 1044 1045 bool gap_secure_connections_only_mode; 1046 #endif 1047 1048 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 1049 uint8_t * hci_packet_buffer; 1050 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE]; 1051 bool hci_packet_buffer_reserved; 1052 uint16_t acl_fragmentation_pos; 1053 uint16_t acl_fragmentation_total_size; 1054 uint8_t acl_fragmentation_tx_active; 1055 1056 /* host to controller flow control */ 1057 uint8_t num_cmd_packets; 1058 uint8_t acl_packets_total_num; 1059 uint16_t acl_data_packet_length; 1060 uint8_t sco_packets_total_num; 1061 uint8_t sco_data_packet_length; 1062 uint8_t synchronous_flow_control_enabled; 1063 uint8_t le_acl_packets_total_num; 1064 uint16_t le_data_packets_length; 1065 uint8_t le_iso_packets_total_num; 1066 uint16_t le_iso_packets_length; 1067 uint8_t sco_waiting_for_can_send_now; 1068 bool sco_can_send_now; 1069 1070 /* local supported features */ 1071 uint8_t local_supported_features[8]; 1072 1073 /* local supported commands summary - complete info is 64 bytes */ 1074 uint32_t local_supported_commands; 1075 1076 /* bluetooth device information from hci read local version information */ 1077 // uint16_t hci_version; 1078 // uint16_t hci_revision; 1079 // uint16_t lmp_version; 1080 uint16_t manufacturer; 1081 // uint16_t lmp_subversion; 1082 1083 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 1084 uint16_t packet_types; 1085 1086 1087 /* hci state machine */ 1088 HCI_STATE state; 1089 hci_substate_t substate; 1090 btstack_timer_source_t timeout; 1091 btstack_chipset_result_t chipset_result; 1092 1093 uint16_t last_cmd_opcode; 1094 1095 uint8_t cmds_ready; 1096 1097 /* buffer for scan enable cmd - 0xff no change */ 1098 uint8_t new_scan_enable_value; 1099 1100 uint8_t discoverable; 1101 uint8_t connectable; 1102 uint8_t bondable; 1103 1104 uint8_t inquiry_state; // see hci.c for state defines 1105 uint16_t inquiry_max_period_length; 1106 uint16_t inquiry_min_period_length; 1107 1108 bd_addr_t remote_name_addr; 1109 uint16_t remote_name_clock_offset; 1110 uint8_t remote_name_page_scan_repetition_mode; 1111 uint8_t remote_name_state; // see hci.c for state defines 1112 1113 bd_addr_t gap_pairing_addr; 1114 uint8_t gap_pairing_state; // see hci.c for state defines 1115 uint8_t gap_pairing_pin_len; 1116 union { 1117 const uint8_t * gap_pairing_pin; 1118 uint32_t gap_pairing_passkey; 1119 } gap_pairing_input; 1120 1121 uint16_t sco_voice_setting; 1122 uint16_t sco_voice_setting_active; 1123 1124 uint8_t loopback_mode; 1125 1126 // buffer for single connection decline 1127 uint8_t decline_reason; 1128 bd_addr_t decline_addr; 1129 1130 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 1131 uint8_t host_completed_packets; 1132 #endif 1133 1134 #ifdef ENABLE_BLE 1135 uint8_t le_own_addr_type; 1136 bd_addr_t le_random_address; 1137 uint8_t le_random_address_set; 1138 1139 // LE Whitelist Management 1140 uint8_t le_whitelist_capacity; 1141 btstack_linked_list_t le_whitelist; 1142 #endif 1143 1144 #ifdef ENABLE_LE_CENTRAL 1145 bool le_scanning_enabled; 1146 bool le_scanning_active; 1147 1148 le_connecting_state_t le_connecting_state; 1149 le_connecting_state_t le_connecting_request; 1150 1151 bool le_scanning_param_update; 1152 uint8_t le_scan_filter_duplicates; 1153 uint8_t le_scan_type; 1154 uint8_t le_scan_filter_policy; 1155 uint16_t le_scan_interval; 1156 uint16_t le_scan_window; 1157 1158 // Connection parameters 1159 uint16_t le_connection_interval_min; 1160 uint16_t le_connection_interval_max; 1161 uint16_t le_connection_latency; 1162 uint16_t le_supervision_timeout; 1163 uint16_t le_minimum_ce_length; 1164 uint16_t le_maximum_ce_length; 1165 uint16_t le_connection_scan_interval; 1166 uint16_t le_connection_scan_window; 1167 uint8_t le_connection_own_addr_type; 1168 bd_addr_t le_connection_own_address; 1169 1170 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1171 btstack_linked_list_t le_periodic_advertiser_list; 1172 uint16_t le_periodic_terminate_sync_handle; 1173 1174 // Periodic Advertising Sync parameters 1175 uint8_t le_periodic_sync_options; 1176 uint8_t le_periodic_sync_advertising_sid; 1177 bd_addr_type_t le_periodic_sync_advertiser_address_type; 1178 bd_addr_t le_periodic_sync_advertiser_address; 1179 uint16_t le_periodic_sync_skip; 1180 uint16_t le_periodic_sync_timeout; 1181 uint8_t le_periodic_sync_cte_type; 1182 le_connecting_state_t le_periodic_sync_state; 1183 le_connecting_state_t le_periodic_sync_request; 1184 1185 // Periodic Advertising Sync Transfer (PAST) 1186 bool le_past_set_default_params; 1187 uint8_t le_past_mode; 1188 uint16_t le_past_skip; 1189 uint16_t le_past_sync_timeout; 1190 uint8_t le_past_cte_type; 1191 #endif 1192 #endif 1193 1194 le_connection_parameter_range_t le_connection_parameter_range; 1195 1196 // TODO: move LE_ADVERTISEMENT_TASKS_SET_ADDRESS flag which is used for both roles into 1197 // some generic gap_le variable 1198 uint8_t le_advertisements_todo; 1199 1200 #ifdef ENABLE_LE_PERIPHERAL 1201 uint8_t * le_advertisements_data; 1202 uint8_t le_advertisements_data_len; 1203 1204 uint8_t * le_scan_response_data; 1205 uint8_t le_scan_response_data_len; 1206 1207 uint16_t le_advertisements_interval_min; 1208 uint16_t le_advertisements_interval_max; 1209 uint8_t le_advertisements_type; 1210 uint8_t le_advertisements_direct_address_type; 1211 uint8_t le_advertisements_channel_map; 1212 uint8_t le_advertisements_filter_policy; 1213 bd_addr_t le_advertisements_direct_address; 1214 uint8_t le_advertisements_own_addr_type; 1215 bd_addr_t le_advertisements_own_address; 1216 1217 uint8_t le_advertisements_state; 1218 1219 bool le_advertisements_enabled_for_current_roles; 1220 uint8_t le_max_number_peripheral_connections; 1221 1222 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1223 btstack_linked_list_t le_advertising_sets; 1224 uint16_t le_maximum_advertising_data_length; 1225 uint8_t le_advertising_set_in_current_command; 1226 #endif 1227 #endif 1228 1229 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 1230 // LE Data Length 1231 uint16_t le_supported_max_tx_octets; 1232 uint16_t le_supported_max_tx_time; 1233 #endif 1234 1235 // custom BD ADDR 1236 bd_addr_t custom_bd_addr; 1237 uint8_t custom_bd_addr_set; 1238 1239 #ifdef ENABLE_CLASSIC 1240 uint8_t master_slave_policy; 1241 #endif 1242 1243 // address and address_type of active create connection command (ACL, SCO, LE) 1244 bd_addr_t outgoing_addr; 1245 bd_addr_type_t outgoing_addr_type; 1246 1247 // LE Resolving List 1248 #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION 1249 le_resolving_list_state_t le_resolving_list_state; 1250 uint16_t le_resolving_list_size; 1251 uint8_t le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1252 uint8_t le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1253 #endif 1254 1255 #ifdef ENABLE_CLASSIC_PAIRING_OOB 1256 bool classic_read_local_oob_data; 1257 hci_con_handle_t classic_oob_con_handle; 1258 #endif 1259 1260 #ifdef HAVE_SCO_TRANSPORT 1261 const btstack_sco_transport_t * sco_transport; 1262 #endif 1263 } hci_stack_t; 1264 1265 1266 /* API_START */ 1267 1268 1269 // HCI init and configuration 1270 1271 1272 /** 1273 * @brief Set up HCI. Needs to be called before any other function. 1274 */ 1275 void hci_init(const hci_transport_t *transport, const void *config); 1276 1277 /** 1278 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 1279 */ 1280 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 1281 1282 /** 1283 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1284 * @[aram hardware_control implementation 1285 */ 1286 void hci_set_control(const btstack_control_t *hardware_control); 1287 1288 #ifdef HAVE_SCO_TRANSPORT 1289 /** 1290 * @brief Set SCO Transport implementation for SCO over PCM mode 1291 * @param sco_transport that sends SCO over I2S or PCM interface 1292 */ 1293 void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport); 1294 #endif 1295 1296 #ifdef ENABLE_CLASSIC 1297 /** 1298 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1299 */ 1300 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 1301 #endif 1302 1303 /** 1304 * @brief Set callback for Bluetooth Hardware Error 1305 */ 1306 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 1307 1308 /** 1309 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 1310 */ 1311 void hci_set_bd_addr(bd_addr_t addr); 1312 1313 /** 1314 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 1315 */ 1316 void hci_set_sco_voice_setting(uint16_t voice_setting); 1317 1318 /** 1319 * @brief Get SCO Voice Setting 1320 * @return current voice setting 1321 */ 1322 uint16_t hci_get_sco_voice_setting(void); 1323 1324 /** 1325 * @brief Set number of ISO packets to buffer for BIS/CIS 1326 * @param num_packets (default = 1) 1327 */ 1328 void hci_set_num_iso_packets_to_queue(uint8_t num_packets); 1329 1330 /** 1331 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 1332 * @param inquriy_mode see bluetooth_defines.h 1333 */ 1334 void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode); 1335 1336 /** 1337 * @brief Requests the change of BTstack power mode. 1338 * @param power_mode 1339 * @return 0 if success, otherwise error 1340 */ 1341 int hci_power_control(HCI_POWER_MODE power_mode); 1342 1343 /** 1344 * @brief Shutdown HCI 1345 */ 1346 void hci_close(void); 1347 1348 1349 // Callback registration 1350 1351 1352 /** 1353 * @brief Add event packet handler. 1354 */ 1355 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 1356 1357 /** 1358 * @brief Remove event packet handler. 1359 */ 1360 void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler); 1361 1362 /** 1363 * @brief Registers a packet handler for ACL data. Used by L2CAP 1364 */ 1365 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 1366 1367 /** 1368 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 1369 */ 1370 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 1371 1372 /** 1373 * @brief Registers a packet handler for ISO data. Used for LE Audio profiles 1374 */ 1375 void hci_register_iso_packet_handler(btstack_packet_handler_t handler); 1376 1377 // Sending HCI Commands 1378 1379 /** 1380 * @brief Check if CMD packet can be sent to controller 1381 * @return true if command can be sent 1382 */ 1383 bool hci_can_send_command_packet_now(void); 1384 1385 /** 1386 * @brief Creates and sends HCI command packets based on a template and a list of parameters. Will return error if outgoing data buffer is occupied. 1387 * @return status 1388 */ 1389 uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...); 1390 1391 1392 // Sending SCO Packets 1393 1394 /** @brief Get SCO packet length for current SCO Voice setting 1395 * @note Using SCO packets of the exact length is required for USB transfer 1396 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 1397 */ 1398 uint16_t hci_get_sco_packet_length(void); 1399 1400 /** 1401 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 1402 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 1403 * so packet handler should be ready to handle it 1404 */ 1405 void hci_request_sco_can_send_now_event(void); 1406 1407 /** 1408 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 1409 * @return true if sco packet can be sent 1410 */ 1411 bool hci_can_send_sco_packet_now(void); 1412 1413 /** 1414 * @brief Check if SCO packet can be sent to controller 1415 * @return true if sco packet can be sent 1416 */ 1417 bool hci_can_send_prepared_sco_packet_now(void); 1418 1419 /** 1420 * @brief Send SCO packet prepared in HCI packet buffer 1421 */ 1422 uint8_t hci_send_sco_packet_buffer(int size); 1423 1424 /** 1425 * @brief Request emission of HCI_EVENT_BIS_CAN_SEND_NOW for all BIS as soon as possible 1426 * @param big_handle 1427 * @note HCI_EVENT_ISO_CAN_SEND_NOW might be emitted during call to this function 1428 * so packet handler should be ready to handle it 1429 */ 1430 uint8_t hci_request_bis_can_send_now_events(uint8_t big_handle); 1431 1432 /** 1433 * @brief Request emission of HCI_EVENT_CIS_CAN_SEND_NOW for CIS as soon as possible 1434 * @param cis_con_handle 1435 * @note HCI_EVENT_CIS_CAN_SEND_NOW might be emitted during call to this function 1436 * so packet handler should be ready to handle it 1437 */ 1438 uint8_t hci_request_cis_can_send_now_events(hci_con_handle_t cis_con_handle); 1439 1440 /** 1441 * @brief Send ISO packet prepared in HCI packet buffer 1442 */ 1443 uint8_t hci_send_iso_packet_buffer(uint16_t size); 1444 1445 /** 1446 * Reserves outgoing packet buffer. 1447 * @return true on success 1448 */ 1449 bool hci_reserve_packet_buffer(void); 1450 1451 /** 1452 * Get pointer for outgoing packet buffer 1453 */ 1454 uint8_t* hci_get_outgoing_packet_buffer(void); 1455 1456 /** 1457 * Release outgoing packet buffer\ 1458 * @note only called instead of hci_send_preparared 1459 */ 1460 void hci_release_packet_buffer(void); 1461 1462 /** 1463 * @brief Sets the master/slave policy 1464 * @param policy (0: attempt to become master, 1: let connecting device decide) 1465 */ 1466 void hci_set_master_slave_policy(uint8_t policy); 1467 1468 /* API_END */ 1469 1470 1471 /** 1472 * va_list version of hci_send_cmd, call hci_send_cmd_packet 1473 * @return status 1474 */ 1475 uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr); 1476 1477 /** 1478 * Get connection iterator. Only used by l2cap.c and sm.c 1479 */ 1480 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1481 1482 /** 1483 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1484 */ 1485 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1486 1487 /** 1488 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1489 */ 1490 hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type); 1491 1492 /** 1493 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1494 * @return true if packet buffer is reserved 1495 */ 1496 bool hci_is_packet_buffer_reserved(void); 1497 1498 /** 1499 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1500 * @return true if ACL Classic packet can be sent now 1501 */ 1502 bool hci_can_send_acl_classic_packet_now(void); 1503 1504 /** 1505 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1506 * @return true if ACL LE packet can be sent now 1507 */ 1508 bool hci_can_send_acl_le_packet_now(void); 1509 1510 /** 1511 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1512 * @return true if ACL packet for con_handle can be sent now 1513 */ 1514 bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1515 1516 /** 1517 * Check if acl packet for the given handle can be sent to controller 1518 * @return true if ACL packet for con_handle can be sent now 1519 */ 1520 bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1521 1522 /** 1523 * Send acl packet prepared in hci packet buffer 1524 * @return status 1525 */ 1526 uint8_t hci_send_acl_packet_buffer(int size); 1527 1528 /** 1529 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1530 * Called by l2cap. 1531 */ 1532 bool hci_authentication_active_for_handle(hci_con_handle_t handle); 1533 1534 /** 1535 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1536 */ 1537 uint16_t hci_max_acl_data_packet_length(void); 1538 1539 /** 1540 * Get supported packet types. Called by L2CAP 1541 */ 1542 uint16_t hci_usable_acl_packet_types(void); 1543 1544 /** 1545 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1546 */ 1547 bool hci_non_flushable_packet_boundary_flag_supported(void); 1548 1549 /** 1550 * Return current automatic flush timeout setting 1551 */ 1552 uint16_t hci_automatic_flush_timeout(void); 1553 1554 /** 1555 * Check if remote supported features query has completed 1556 */ 1557 bool hci_remote_features_available(hci_con_handle_t con_handle); 1558 1559 /** 1560 * Trigger remote supported features query 1561 */ 1562 void hci_remote_features_query(hci_con_handle_t con_handle); 1563 1564 /** 1565 * Check if extended SCO Link is supported 1566 */ 1567 bool hci_extended_sco_link_supported(void); 1568 1569 /** 1570 * Check if SSP is supported on both sides. Called by L2CAP 1571 */ 1572 bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1573 1574 /** 1575 * Disconn because of security block. Called by L2CAP 1576 */ 1577 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1578 1579 /** 1580 * Query if remote side supports eSCO 1581 */ 1582 bool hci_remote_esco_supported(hci_con_handle_t con_handle); 1583 1584 /** 1585 * Emit current HCI state. Called by daemon 1586 */ 1587 void hci_emit_state(void); 1588 1589 /** 1590 * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg 1591 * @return status 1592 */ 1593 uint8_t hci_send_cmd_packet(uint8_t *packet, int size); 1594 1595 /** 1596 * Disconnect all HCI connections. Called by daemon 1597 */ 1598 void hci_disconnect_all(void); 1599 1600 /** 1601 * Get number of free acl slots for packets of given handle. Called by daemon 1602 */ 1603 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1604 1605 /** 1606 * @brief Set Advertisement Parameters 1607 * @param adv_int_min 1608 * @param adv_int_max 1609 * @param adv_type 1610 * @param direct_address_type 1611 * @param direct_address 1612 * @param channel_map 1613 * @param filter_policy 1614 * 1615 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1616 */ 1617 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1618 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1619 1620 /** 1621 * 1622 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1623 */ 1624 void hci_le_set_own_address_type(uint8_t own_address_type); 1625 1626 /** 1627 * @naote internal use. use gap_random_address_set from gap.h instead 1628 */ 1629 void hci_le_random_address_set(const bd_addr_t random_address); 1630 1631 /** 1632 * @note internal use by sm 1633 */ 1634 void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index); 1635 1636 /** 1637 * @note internal use by sm 1638 */ 1639 void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index); 1640 1641 /** 1642 * @note internal use 1643 */ 1644 uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type); 1645 1646 /** 1647 * @brief Clear Periodic Advertiser List 1648 * @return status 1649 */ 1650 uint8_t gap_periodic_advertiser_list_clear(void); 1651 1652 /** 1653 * @brief Add entry to Periodic Advertiser List 1654 * @param address_type 1655 * @param address 1656 * @param advertising_sid 1657 * @return 1658 */ 1659 uint8_t gap_periodic_advertiser_list_add(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1660 1661 /** 1662 * Remove entry from Periodic Advertising List 1663 * @param address_type 1664 * @param address 1665 * @param advertising_sid 1666 * @return 1667 */ 1668 uint8_t gap_periodic_advertiser_list_remove(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1669 1670 /** 1671 * @brief Synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets. 1672 * @param options 1673 * @param advertising_sid 1674 * @param advertiser_address_type 1675 * @param advertiser_address 1676 * @param skip 1677 * @param sync_timeout 1678 * @param sync_cte_type 1679 * @return 1680 */ 1681 uint8_t gap_periodic_advertising_create_sync(uint8_t options, uint8_t advertising_sid, bd_addr_type_t advertiser_address_type, 1682 bd_addr_t advertiser_address, uint16_t skip, uint16_t sync_timeout, uint8_t sync_cte_type); 1683 1684 /** 1685 * @brief Cancel sync periodic advertising train while it is pending. 1686 * @return status 1687 */ 1688 uint8_t gap_periodic_advertising_create_sync_cancel(void); 1689 1690 /** 1691 * @biref Stop reception of the periodic advertising train 1692 * @param sync_handle 1693 * @return status 1694 */ 1695 uint8_t gap_periodic_advertising_terminate_sync(uint16_t sync_handle); 1696 1697 /** 1698 * @brief Get Manufactured 1699 * @return manufacturer id 1700 */ 1701 uint16_t hci_get_manufacturer(void); 1702 1703 // Only for PTS testing 1704 1705 /** 1706 * Disable automatic L2CAP disconnect if no L2CAP connection is established 1707 */ 1708 void hci_disable_l2cap_timeout_check(void); 1709 1710 /** 1711 * Get Classic Allow Role Switch param 1712 */ 1713 uint8_t hci_get_allow_role_switch(void); 1714 1715 /** 1716 * Get state 1717 */ 1718 HCI_STATE hci_get_state(void); 1719 1720 /** 1721 * @brief De-Init HCI 1722 */ 1723 void hci_deinit(void); 1724 1725 // setup test connections, used for fuzzing 1726 void hci_setup_test_connections_fuzz(void); 1727 1728 // free all connections, used for fuzzing 1729 void hci_free_connections_fuzz(void); 1730 1731 // simulate stack bootup 1732 void hci_simulate_working_fuzz(void); 1733 1734 1735 #if defined __cplusplus 1736 } 1737 #endif 1738 1739 #endif // HCI_H 1740