xref: /btstack/src/hci.h (revision a0ecb5f3e03de203431a83bfb88217ac1247ef71)
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 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  *  hci.h
40  *
41  *  Created by Matthias Ringwald on 4/29/09.
42  *
43  */
44 
45 #ifndef HCI_H
46 #define HCI_H
47 
48 #include "btstack_config.h"
49 
50 #include "btstack_chipset.h"
51 #include "btstack_control.h"
52 #include "btstack_linked_list.h"
53 #include "btstack_util.h"
54 #include "classic/btstack_link_key_db.h"
55 #include "hci_cmd.h"
56 #include "gap.h"
57 #include "hci_transport.h"
58 
59 #ifdef ENABLE_BLE
60 #include "ble/att_db.h"
61 #endif
62 
63 #include <stdint.h>
64 #include <stdlib.h>
65 #include <stdarg.h>
66 
67 #if defined __cplusplus
68 extern "C" {
69 #endif
70 
71 // packet buffer sizes
72 
73 // Max HCI Command LE payload size:
74 // 64 from LE Generate DHKey command
75 // 32 from LE Encrypt command
76 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS)
77 #define HCI_CMD_PAYLOAD_SIZE_LE 64
78 #else
79 #define HCI_CMD_PAYLOAD_SIZE_LE 32
80 #endif
81 
82 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h
83 // addition byte in even to terminate remote name request with '\0'
84 #define HCI_EVENT_BUFFER_SIZE      (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1)
85 
86 #ifdef ENABLE_CLASSIC
87 #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE)
88 #else
89 #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE_LE)
90 #endif
91 
92 #define HCI_ACL_BUFFER_SIZE        (HCI_ACL_HEADER_SIZE   + HCI_ACL_PAYLOAD_SIZE)
93 
94 // size of hci incoming buffer, big enough for event or acl packet without H4 packet type
95 #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE
96     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
97         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
98     #endif
99     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE
100         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE
101     #endif
102 #else
103     #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE
104         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
105     #else
106         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE
107     #endif
108 #endif
109 
110 // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type
111 #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE
112     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
113         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
114     #endif
115     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE
116         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE
117     #endif
118 #else
119     #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE
120         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
121     #else
122         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE
123     #endif
124 #endif
125 
126 // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA
127 #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE
128 #ifdef HAVE_HOST_CONTROLLER_API
129 #define HCI_OUTGOING_PRE_BUFFER_SIZE 0
130 #else
131 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1
132 #endif
133 #endif
134 
135 // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads
136 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE
137 #ifdef ENABLE_CLASSIC
138 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4)
139 #else
140 #define HCI_INCOMING_PRE_BUFFER_SIZE 2
141 #endif
142 #endif
143 
144 //
145 #define IS_COMMAND(packet, command) (little_endian_read_16(packet,0) == command.opcode)
146 
147 // check if command complete event for given command
148 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( event[0] == HCI_EVENT_COMMAND_COMPLETE && little_endian_read_16(event,3) == cmd.opcode)
149 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( event[0] == HCI_EVENT_COMMAND_STATUS && little_endian_read_16(event,4) == cmd.opcode)
150 
151 // Code+Len=2, Pkts+Opcode=3; total=5
152 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5
153 
154 // ACL Packet
155 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
156 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
157 #define READ_ACL_FLAGS( buffer )      ( buffer[1] >> 4 )
158 #define READ_ACL_LENGTH( buffer )     (little_endian_read_16(buffer, 2))
159 
160 // Sneak peak into L2CAP Packet
161 #define READ_L2CAP_LENGTH(buffer)     ( little_endian_read_16(buffer, 4))
162 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6))
163 
164 /**
165  * LE connection parameter update state
166  */
167 
168 typedef enum {
169     CON_PARAMETER_UPDATE_NONE,
170     // L2CAP
171     CON_PARAMETER_UPDATE_SEND_REQUEST,
172     CON_PARAMETER_UPDATE_SEND_RESPONSE,
173     CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS,
174     CON_PARAMETER_UPDATE_DENY,
175     // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST
176     CON_PARAMETER_UPDATE_REPLY,
177     CON_PARAMETER_UPDATE_NEGATIVE_REPLY,
178 } le_con_parameter_update_state_t;
179 
180 // Authentication flags
181 typedef enum {
182     AUTH_FLAGS_NONE                = 0x0000,
183     RECV_LINK_KEY_REQUEST          = 0x0001,
184     HANDLE_LINK_KEY_REQUEST        = 0x0002,
185     SENT_LINK_KEY_REPLY            = 0x0004,
186     SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008,
187     RECV_LINK_KEY_NOTIFICATION     = 0x0010,
188     DENY_PIN_CODE_REQUEST          = 0x0040,
189     RECV_IO_CAPABILITIES_REQUEST   = 0x0080,
190     SEND_IO_CAPABILITIES_REPLY     = 0x0100,
191     SEND_USER_CONFIRM_REPLY        = 0x0200,
192     SEND_USER_PASSKEY_REPLY        = 0x0400,
193 
194     // pairing status
195     LEGACY_PAIRING_ACTIVE          = 0x2000,
196     SSP_PAIRING_ACTIVE             = 0x4000,
197 
198     // connection status
199     CONNECTION_ENCRYPTED           = 0x8000,
200 } hci_authentication_flags_t;
201 
202 /**
203  * Connection State
204  */
205 typedef enum {
206     SEND_CREATE_CONNECTION = 0,
207     SENT_CREATE_CONNECTION,
208     SEND_CANCEL_CONNECTION,
209     SENT_CANCEL_CONNECTION,
210     RECEIVED_CONNECTION_REQUEST,
211     ACCEPTED_CONNECTION_REQUEST,
212     REJECTED_CONNECTION_REQUEST,
213     OPEN,
214     SEND_DISCONNECT,
215     SENT_DISCONNECT,
216     RECEIVED_DISCONNECTION_COMPLETE
217 } CONNECTION_STATE;
218 
219 // bonding flags
220 enum {
221     BONDING_REQUEST_REMOTE_FEATURES       = 0x01,
222     BONDING_RECEIVED_REMOTE_FEATURES      = 0x02,
223     BONDING_REMOTE_SUPPORTS_SSP           = 0x04,
224     BONDING_DISCONNECT_SECURITY_BLOCK     = 0x08,
225     BONDING_DISCONNECT_DEDICATED_DONE     = 0x10,
226     BONDING_SEND_AUTHENTICATE_REQUEST     = 0x20,
227     BONDING_SEND_ENCRYPTION_REQUEST       = 0x40,
228     BONDING_SEND_READ_ENCRYPTION_KEY_SIZE = 0x80,
229     BONDING_DEDICATED                     = 0x100,
230     BONDING_EMIT_COMPLETE_ON_DISCONNECT   = 0x200
231 };
232 
233 typedef enum {
234     BLUETOOTH_OFF = 1,
235     BLUETOOTH_ON,
236     BLUETOOTH_ACTIVE
237 } BLUETOOTH_STATE;
238 
239 typedef enum {
240     LE_CONNECTING_IDLE,
241     LE_CONNECTING_DIRECT,
242     LE_CONNECTING_WHITELIST,
243 } le_connecting_state_t;
244 
245 #ifdef ENABLE_BLE
246 
247 //
248 // SM internal types and globals
249 //
250 
251 typedef enum {
252 
253     // general states
254     SM_GENERAL_IDLE,
255     SM_GENERAL_SEND_PAIRING_FAILED,
256     SM_GENERAL_TIMEOUT, // no other security messages are exchanged
257 
258     // Phase 1: Pairing Feature Exchange
259     SM_PH1_W4_USER_RESPONSE,
260 
261     // Phase 2: Authenticating and Encrypting
262 
263     // get random number for use as TK Passkey if we show it
264     SM_PH2_GET_RANDOM_TK,
265     SM_PH2_W4_RANDOM_TK,
266 
267     // get local random number for confirm c1
268     SM_PH2_C1_GET_RANDOM_A,
269     SM_PH2_C1_W4_RANDOM_A,
270     SM_PH2_C1_GET_RANDOM_B,
271     SM_PH2_C1_W4_RANDOM_B,
272 
273     // calculate confirm value for local side
274     SM_PH2_C1_GET_ENC_A,
275     SM_PH2_C1_W4_ENC_A,
276 
277     // calculate confirm value for remote side
278     SM_PH2_C1_GET_ENC_C,
279     SM_PH2_C1_W4_ENC_C,
280 
281     SM_PH2_C1_SEND_PAIRING_CONFIRM,
282     SM_PH2_SEND_PAIRING_RANDOM,
283 
284     // calc STK
285     SM_PH2_CALC_STK,
286     SM_PH2_W4_STK,
287 
288     SM_PH2_W4_CONNECTION_ENCRYPTED,
289 
290     // Phase 3: Transport Specific Key Distribution
291     // calculate DHK, Y, EDIV, and LTK
292     SM_PH3_Y_GET_ENC,
293     SM_PH3_Y_W4_ENC,
294     SM_PH3_LTK_GET_ENC,
295 
296     // exchange keys
297     SM_PH3_DISTRIBUTE_KEYS,
298     SM_PH3_RECEIVE_KEYS,
299 
300     // RESPONDER ROLE
301     SM_RESPONDER_IDLE,
302     SM_RESPONDER_SEND_SECURITY_REQUEST,
303     SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST,
304     SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK,
305     SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY,
306     SM_RESPONDER_PH1_W4_PAIRING_REQUEST,
307     SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED,
308     SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE,
309     SM_RESPONDER_PH1_W4_PAIRING_CONFIRM,
310     SM_RESPONDER_PH2_W4_PAIRING_RANDOM,
311     SM_RESPONDER_PH2_W4_LTK_REQUEST,
312     SM_RESPONDER_PH2_SEND_LTK_REPLY,
313 
314     // Phase 4: re-establish previously distributed LTK
315     SM_RESPONDER_PH4_Y_GET_ENC,
316     SM_RESPONDER_PH4_Y_W4_ENC,
317     SM_RESPONDER_PH4_SEND_LTK_REPLY,
318 
319     // INITITIATOR ROLE
320     SM_INITIATOR_CONNECTED,
321     SM_INITIATOR_PH0_HAS_LTK,
322     SM_INITIATOR_PH0_SEND_START_ENCRYPTION,
323     SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED,
324     SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST,
325     SM_INITIATOR_PH1_SEND_PAIRING_REQUEST,
326     SM_INITIATOR_PH1_W4_PAIRING_RESPONSE,
327     SM_INITIATOR_PH2_W4_PAIRING_CONFIRM,
328     SM_INITIATOR_PH2_W4_PAIRING_RANDOM,
329     SM_INITIATOR_PH3_SEND_START_ENCRYPTION,
330 
331     // LE Secure Connections
332     SM_SC_RECEIVED_LTK_REQUEST,
333     SM_SC_SEND_PUBLIC_KEY_COMMAND,
334     SM_SC_W4_PUBLIC_KEY_COMMAND,
335     SM_SC_W2_GET_RANDOM_A,
336     SM_SC_W4_GET_RANDOM_A,
337     SM_SC_W2_GET_RANDOM_B,
338     SM_SC_W4_GET_RANDOM_B,
339     SM_SC_W2_CMAC_FOR_CONFIRMATION,
340     SM_SC_W4_CMAC_FOR_CONFIRMATION,
341     SM_SC_SEND_CONFIRMATION,
342     SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION,
343     SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION,
344     SM_SC_W4_CONFIRMATION,
345     SM_SC_SEND_PAIRING_RANDOM,
346     SM_SC_W4_PAIRING_RANDOM,
347     SM_SC_W2_CALCULATE_G2,
348     SM_SC_W4_CALCULATE_G2,
349     SM_SC_W4_CALCULATE_DHKEY,
350     SM_SC_W2_CALCULATE_F5_SALT,
351     SM_SC_W4_CALCULATE_F5_SALT,
352     SM_SC_W2_CALCULATE_F5_MACKEY,
353     SM_SC_W4_CALCULATE_F5_MACKEY,
354     SM_SC_W2_CALCULATE_F5_LTK,
355     SM_SC_W4_CALCULATE_F5_LTK,
356     SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK,
357     SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK,
358     SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
359     SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
360     SM_SC_W4_USER_RESPONSE,
361     SM_SC_SEND_DHKEY_CHECK_COMMAND,
362     SM_SC_W4_DHKEY_CHECK_COMMAND,
363     SM_SC_W4_LTK_REQUEST_SC,
364     SM_SC_W2_CALCULATE_H6_ILK,
365     SM_SC_W4_CALCULATE_H6_ILK,
366     SM_SC_W2_CALCULATE_H6_BR_EDR_LINK_KEY,
367     SM_SC_W4_CALCULATE_H6_BR_EDR_LINK_KEY,
368 } security_manager_state_t;
369 
370 typedef enum {
371     IRK_LOOKUP_IDLE,
372     IRK_LOOKUP_W4_READY,
373     IRK_LOOKUP_STARTED,
374     IRK_LOOKUP_SUCCEEDED,
375     IRK_LOOKUP_FAILED
376 } irk_lookup_state_t;
377 
378 typedef uint8_t sm_pairing_packet_t[7];
379 
380 // connection info available as long as connection exists
381 typedef struct sm_connection {
382     hci_con_handle_t         sm_handle;
383     uint8_t                  sm_role;   // 0 - IamMaster, 1 = IamSlave
384     uint8_t                  sm_security_request_received;
385     uint8_t                  sm_pairing_requested;
386     uint8_t                  sm_peer_addr_type;
387     bd_addr_t                sm_peer_address;
388     security_manager_state_t sm_engine_state;
389     irk_lookup_state_t      sm_irk_lookup_state;
390     uint8_t                  sm_connection_encrypted;
391     uint8_t                  sm_connection_authenticated;   // [0..1]
392     uint8_t                  sm_connection_sc;
393     uint8_t                  sm_actual_encryption_key_size;
394     sm_pairing_packet_t      sm_m_preq;  // only used during c1
395     authorization_state_t    sm_connection_authorization_state;
396     uint16_t                 sm_local_ediv;
397     uint8_t                  sm_local_rand[8];
398     int                      sm_le_db_index;
399 } sm_connection_t;
400 
401 //
402 // ATT Server
403 //
404 
405 // max ATT request matches L2CAP PDU -- allow to use smaller buffer
406 #ifndef ATT_REQUEST_BUFFER_SIZE
407 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE
408 #endif
409 
410 typedef enum {
411     ATT_SERVER_IDLE,
412     ATT_SERVER_REQUEST_RECEIVED,
413     ATT_SERVER_W4_SIGNED_WRITE_VALIDATION,
414     ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED,
415     ATT_SERVER_RESPONSE_PENDING,
416 } att_server_state_t;
417 
418 typedef struct {
419     att_server_state_t      state;
420 
421     uint8_t                 peer_addr_type;
422     bd_addr_t               peer_address;
423 
424     int                     ir_le_device_db_index;
425     uint8_t                 ir_lookup_active;
426     uint8_t                 pairing_active;
427 
428     int                     value_indication_handle;
429     btstack_timer_source_t  value_indication_timer;
430 
431     att_connection_t        connection;
432 
433     btstack_linked_list_t   notification_requests;
434     btstack_linked_list_t   indication_requests;
435 
436 #ifdef ENABLE_GATT_OVER_CLASSIC
437     uint16_t                l2cap_cid;
438 #endif
439 
440     uint16_t                request_size;
441     uint8_t                 request_buffer[ATT_REQUEST_BUFFER_SIZE];
442 
443 } att_server_t;
444 
445 #endif
446 
447 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE
448 typedef enum {
449     L2CAP_INFORMATION_STATE_IDLE = 0,
450     L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST,
451     L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE,
452     L2CAP_INFORMATION_STATE_DONE
453 } l2cap_information_state_t;
454 
455 typedef struct {
456     l2cap_information_state_t information_state;
457     uint16_t                  extended_feature_mask;
458 } l2cap_state_t;
459 #endif
460 
461 //
462 typedef struct {
463     // linked list - assert: first field
464     btstack_linked_item_t    item;
465 
466     // remote side
467     bd_addr_t address;
468 
469     // module handle
470     hci_con_handle_t con_handle;
471 
472     // le public, le random, classic
473     bd_addr_type_t address_type;
474 
475     // role: 0 - master, 1 - slave
476     uint8_t role;
477 
478     // connection state
479     CONNECTION_STATE state;
480 
481     // bonding
482     uint16_t bonding_flags;
483     uint8_t  bonding_status;
484 
485     // encryption key size (in octets)
486     uint8_t encryption_key_size;
487 
488     // requested security level
489     gap_security_level_t requested_security_level;
490 
491     //
492     link_key_type_t link_key_type;
493 
494     // remote supported features
495     uint8_t remote_supported_feature_eSCO;
496 
497 #ifdef ENABLE_CLASSIC
498     // connection mode, default ACL_CONNECTION_MODE_ACTIVE
499     uint8_t connection_mode;
500 
501     // enter/exit sniff mode requests
502     uint16_t sniff_min_interval;    // 0: idle, 0xffff exit sniff, else enter sniff
503     uint16_t sniff_max_interval;
504     uint16_t sniff_attempt;
505     uint16_t sniff_timeout;
506 
507     // track SCO rx event
508     uint32_t sco_rx_ms;
509     uint8_t  sco_rx_count;
510     uint8_t  sco_rx_valid;
511 
512     // generate sco can send now based on received packets, using timeout below
513     uint8_t  sco_tx_ready;
514 
515     btstack_timer_source_t timeout_sco;
516 #endif /* ENABLE_CLASSIC */
517 
518     // errands
519     uint32_t authentication_flags;
520 
521     btstack_timer_source_t timeout;
522 
523     // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS)
524     uint32_t timestamp;
525 
526     // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload
527     uint8_t  acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE];
528     uint16_t acl_recombination_pos;
529     uint16_t acl_recombination_length;
530 
531 
532     // number packets sent to controller
533     uint8_t num_packets_sent;
534 
535 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
536     uint8_t num_packets_completed;
537 #endif
538 
539     // LE Connection parameter update
540     le_con_parameter_update_state_t le_con_parameter_update_state;
541     uint8_t  le_con_param_update_identifier;
542     uint16_t le_conn_interval_min;
543     uint16_t le_conn_interval_max;
544     uint16_t le_conn_latency;
545     uint16_t le_supervision_timeout;
546 
547 #ifdef ENABLE_BLE
548     uint16_t le_connection_interval;
549 
550     // LE PHY Update via set phy command
551     uint8_t le_phy_update_all_phys;      // 0xff for idle
552     uint8_t le_phy_update_tx_phys;
553     uint8_t le_phy_update_rx_phys;
554     int8_t  le_phy_update_phy_options;
555 
556     // LE Security Manager
557     sm_connection_t sm_connection;
558 
559     // ATT Server
560     att_server_t    att_server;
561 #endif
562 
563 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE
564     l2cap_state_t l2cap_state;
565 #endif
566 
567 } hci_connection_t;
568 
569 
570 /**
571  * HCI Inititizlization State Machine
572  */
573 typedef enum hci_init_state{
574     HCI_INIT_SEND_RESET = 0,
575     HCI_INIT_W4_SEND_RESET,
576     HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION,
577     HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION,
578     HCI_INIT_SEND_READ_LOCAL_NAME,
579     HCI_INIT_W4_SEND_READ_LOCAL_NAME,
580 
581     HCI_INIT_SEND_BAUD_CHANGE,
582     HCI_INIT_W4_SEND_BAUD_CHANGE,
583     HCI_INIT_CUSTOM_INIT,
584     HCI_INIT_W4_CUSTOM_INIT,
585     HCI_INIT_SEND_RESET_CSR_WARM_BOOT,
586     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT,
587     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET,
588     HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY,
589 
590     HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS,
591     HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS,
592 
593     HCI_INIT_SEND_BAUD_CHANGE_BCM,
594     HCI_INIT_W4_SEND_BAUD_CHANGE_BCM,
595 
596     HCI_INIT_SET_BD_ADDR,
597     HCI_INIT_W4_SET_BD_ADDR,
598 
599     HCI_INIT_SEND_RESET_ST_WARM_BOOT,
600     HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT,
601 
602     HCI_INIT_READ_BD_ADDR,
603     HCI_INIT_W4_READ_BD_ADDR,
604 
605     HCI_INIT_READ_BUFFER_SIZE,
606     HCI_INIT_W4_READ_BUFFER_SIZE,
607     HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES,
608     HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES,
609 
610 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
611     HCI_INIT_HOST_BUFFER_SIZE,
612     HCI_INIT_W4_HOST_BUFFER_SIZE,
613     HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
614     HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
615 #endif
616 
617     HCI_INIT_SET_EVENT_MASK,
618     HCI_INIT_W4_SET_EVENT_MASK,
619 
620     HCI_INIT_WRITE_SIMPLE_PAIRING_MODE,
621     HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE,
622     HCI_INIT_WRITE_PAGE_TIMEOUT,
623     HCI_INIT_W4_WRITE_PAGE_TIMEOUT,
624     HCI_INIT_WRITE_DEFAULT_LINK_POLICY_SETTING,
625     HCI_INIT_W4_WRITE_DEFAULT_LINK_POLICY_SETTING,
626     HCI_INIT_WRITE_CLASS_OF_DEVICE,
627     HCI_INIT_W4_WRITE_CLASS_OF_DEVICE,
628     HCI_INIT_WRITE_LOCAL_NAME,
629     HCI_INIT_W4_WRITE_LOCAL_NAME,
630     HCI_INIT_WRITE_EIR_DATA,
631     HCI_INIT_W4_WRITE_EIR_DATA,
632     HCI_INIT_WRITE_INQUIRY_MODE,
633     HCI_INIT_W4_WRITE_INQUIRY_MODE,
634     HCI_INIT_WRITE_SCAN_ENABLE,
635     HCI_INIT_W4_WRITE_SCAN_ENABLE,
636 
637     // SCO over HCI
638     HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
639     HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
640     HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
641     HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
642 
643     // SCO over HCI Broadcom
644     HCI_INIT_BCM_WRITE_SCO_PCM_INT,
645     HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT,
646 
647 #ifdef ENABLE_BLE
648     HCI_INIT_LE_READ_BUFFER_SIZE,
649     HCI_INIT_W4_LE_READ_BUFFER_SIZE,
650     HCI_INIT_WRITE_LE_HOST_SUPPORTED,
651     HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED,
652     HCI_INIT_LE_SET_EVENT_MASK,
653     HCI_INIT_W4_LE_SET_EVENT_MASK,
654 #endif
655 
656 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
657     HCI_INIT_LE_READ_MAX_DATA_LENGTH,
658     HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH,
659     HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH,
660     HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH,
661 #endif
662 
663 #ifdef ENABLE_LE_CENTRAL
664     HCI_INIT_READ_WHITE_LIST_SIZE,
665     HCI_INIT_W4_READ_WHITE_LIST_SIZE,
666 
667     HCI_INIT_LE_SET_SCAN_PARAMETERS,
668     HCI_INIT_W4_LE_SET_SCAN_PARAMETERS,
669 #endif
670 
671     HCI_INIT_DONE,
672 
673     HCI_FALLING_ASLEEP_DISCONNECT,
674     HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE,
675     HCI_FALLING_ASLEEP_COMPLETE,
676 
677     HCI_INIT_AFTER_SLEEP,
678 
679     HCI_HALTING_DISCONNECT_ALL_NO_TIMER,
680     HCI_HALTING_DISCONNECT_ALL_TIMER,
681     HCI_HALTING_W4_TIMER,
682     HCI_HALTING_CLOSE,
683 
684 } hci_substate_t;
685 
686 enum {
687     LE_ADVERTISEMENT_TASKS_DISABLE       = 1 << 0,
688     LE_ADVERTISEMENT_TASKS_SET_ADV_DATA  = 1 << 1,
689     LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 2,
690     LE_ADVERTISEMENT_TASKS_SET_PARAMS    = 1 << 3,
691     LE_ADVERTISEMENT_TASKS_ENABLE        = 1 << 4,
692 };
693 
694 enum {
695     LE_WHITELIST_ON_CONTROLLER          = 1 << 0,
696     LE_WHITELIST_ADD_TO_CONTROLLER      = 1 << 1,
697     LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2,
698 };
699 
700 typedef struct {
701     btstack_linked_item_t  item;
702     bd_addr_t      address;
703     bd_addr_type_t address_type;
704     uint8_t        state;
705 } whitelist_entry_t;
706 
707 /**
708  * main data structure
709  */
710 typedef struct {
711     // transport component with configuration
712     const hci_transport_t * hci_transport;
713     const void            * config;
714 
715     // chipset driver
716     const btstack_chipset_t * chipset;
717 
718     // hardware power controller
719     const btstack_control_t * control;
720 
721     /* link key db */
722     const btstack_link_key_db_t * link_key_db;
723 
724     // list of existing baseband connections
725     btstack_linked_list_t     connections;
726 
727     /* callback to L2CAP layer */
728     btstack_packet_handler_t acl_packet_handler;
729 
730     /* callback for SCO data */
731     btstack_packet_handler_t sco_packet_handler;
732 
733     /* callbacks for events */
734     btstack_linked_list_t event_handlers;
735 
736     // hardware error callback
737     void (*hardware_error_callback)(uint8_t error);
738 
739     // basic configuration
740     const char *       local_name;
741     const uint8_t *    eir_data;
742     uint32_t           class_of_device;
743     bd_addr_t          local_bd_addr;
744     uint8_t            default_link_policy_settings;
745     uint8_t            ssp_enable;
746     uint8_t            ssp_io_capability;
747     uint8_t            ssp_authentication_requirement;
748     uint8_t            ssp_auto_accept;
749     inquiry_mode_t     inquiry_mode;
750 #ifdef ENABLE_CLASSIC
751     // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default
752     uint8_t             gap_required_encyrption_key_size;
753 #endif
754 
755     // single buffer for HCI packet assembly + additional prebuffer for H4 drivers
756     uint8_t   * hci_packet_buffer;
757     uint8_t   hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE];
758     uint8_t   hci_packet_buffer_reserved;
759     uint16_t  acl_fragmentation_pos;
760     uint16_t  acl_fragmentation_total_size;
761     uint8_t   acl_fragmentation_tx_active;
762 
763     /* host to controller flow control */
764     uint8_t  num_cmd_packets;
765     uint8_t  acl_packets_total_num;
766     uint16_t acl_data_packet_length;
767     uint8_t  sco_packets_total_num;
768     uint8_t  sco_data_packet_length;
769     uint8_t  synchronous_flow_control_enabled;
770     uint8_t  le_acl_packets_total_num;
771     uint16_t le_data_packets_length;
772     uint8_t  sco_waiting_for_can_send_now;
773     uint8_t  sco_can_send_now;
774 
775     /* local supported features */
776     uint8_t local_supported_features[8];
777 
778     /* local supported commands summary - complete info is 64 bytes */
779     /* 0 - Read Buffer Size                        (Octet 14/bit 7) */
780     /* 1 - Write Le Host Supported                 (Octet 24/bit 6) */
781     /* 2 - Write Synchronous Flow Control Enable   (Octet 10/bit 4) */
782     /* 3 - Write Default Erroneous Data Reporting  (Octet 18/bit 3) */
783     /* 4 - LE Write Suggested Default Data Length  (Octet 34/bit 0) */
784     /* 5 - LE Read Maximum Data Length             (Octet 35/bit 3) */
785     /* 6 - LE Set Default PHY                      (Octet 35/bit 5) */
786     uint8_t local_supported_commands[1];
787 
788     /* bluetooth device information from hci read local version information */
789     // uint16_t hci_version;
790     // uint16_t hci_revision;
791     // uint16_t lmp_version;
792     uint16_t manufacturer;
793     // uint16_t lmp_subversion;
794 
795     // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE
796     uint16_t packet_types;
797 
798 
799     /* hci state machine */
800     HCI_STATE      state;
801     hci_substate_t substate;
802     btstack_timer_source_t timeout;
803     btstack_chipset_result_t chipset_result;
804 
805     uint16_t  last_cmd_opcode;
806 
807     uint8_t   cmds_ready;
808 
809     /* buffer for scan enable cmd - 0xff no change */
810     uint8_t   new_scan_enable_value;
811 
812     uint8_t   discoverable;
813     uint8_t   connectable;
814     uint8_t   bondable;
815 
816     uint8_t   inquiry_state;    // see hci.c for state defines
817 
818     bd_addr_t remote_name_addr;
819     uint16_t  remote_name_clock_offset;
820     uint8_t   remote_name_page_scan_repetition_mode;
821     uint8_t   remote_name_state;    // see hci.c for state defines
822 
823     bd_addr_t gap_pairing_addr;
824     uint8_t   gap_pairing_state;    // see hci.c for state defines
825     union {
826         const char * gap_pairing_pin;
827         uint32_t     gap_pairing_passkey;
828     } gap_pairing_input;
829 
830     uint16_t  sco_voice_setting;
831     uint16_t  sco_voice_setting_active;
832 
833     uint8_t   loopback_mode;
834 
835     // buffer for single connection decline
836     uint8_t   decline_reason;
837     bd_addr_t decline_addr;
838 
839 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
840     uint8_t   host_completed_packets;
841 #endif
842 
843 #ifdef ENABLE_BLE
844     uint8_t   le_own_addr_type;
845     bd_addr_t le_random_address;
846     uint8_t   le_random_address_set;
847 #endif
848 
849 #ifdef ENABLE_LE_CENTRAL
850     uint8_t   le_scanning_enabled;
851     uint8_t   le_scanning_active;
852 
853     le_connecting_state_t le_connecting_state;
854 
855     // buffer for le scan type command - 0xff not set
856     uint8_t  le_scan_type;
857     uint16_t le_scan_interval;
858     uint16_t le_scan_window;
859 
860     // LE Whitelist Management
861     uint8_t               le_whitelist_capacity;
862     btstack_linked_list_t le_whitelist;
863 
864     // Connection parameters
865     uint16_t le_connection_interval_min;
866     uint16_t le_connection_interval_max;
867     uint16_t le_connection_latency;
868     uint16_t le_supervision_timeout;
869     uint16_t le_minimum_ce_length;
870     uint16_t le_maximum_ce_length;
871     uint16_t le_connection_scan_interval;
872     uint16_t le_connection_scan_window;
873 #endif
874 
875     le_connection_parameter_range_t le_connection_parameter_range;
876 
877 #ifdef ENABLE_LE_PERIPHERAL
878     uint8_t  * le_advertisements_data;
879     uint8_t    le_advertisements_data_len;
880 
881     uint8_t  * le_scan_response_data;
882     uint8_t    le_scan_response_data_len;
883 
884     uint8_t  le_advertisements_active;
885     uint8_t  le_advertisements_enabled;
886     uint8_t  le_advertisements_todo;
887 
888     uint16_t le_advertisements_interval_min;
889     uint16_t le_advertisements_interval_max;
890     uint8_t  le_advertisements_type;
891     uint8_t  le_advertisements_direct_address_type;
892     uint8_t  le_advertisements_channel_map;
893     uint8_t  le_advertisements_filter_policy;
894     bd_addr_t le_advertisements_direct_address;
895 
896     uint8_t le_max_number_peripheral_connections;
897 #endif
898 
899 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
900     // LE Data Length
901     uint16_t le_supported_max_tx_octets;
902     uint16_t le_supported_max_tx_time;
903 #endif
904 
905     // custom BD ADDR
906     bd_addr_t custom_bd_addr;
907     uint8_t   custom_bd_addr_set;
908 
909 #ifdef ENABLE_CLASSIC
910     uint8_t master_slave_policy;
911 #endif
912 
913     // address and address_type of active create connection command (ACL, SCO, LE)
914     bd_addr_t      outgoing_addr;
915     bd_addr_type_t outgoing_addr_type;
916 
917 } hci_stack_t;
918 
919 
920 /* API_START */
921 
922 
923 // HCI init and configuration
924 
925 
926 /**
927  * @brief Set up HCI. Needs to be called before any other function.
928  */
929 void hci_init(const hci_transport_t *transport, const void *config);
930 
931 /**
932  * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information.
933  */
934 void hci_set_chipset(const btstack_chipset_t *chipset_driver);
935 
936 /**
937  * @brief Configure Bluetooth hardware control. Has to be called before power on.
938  */
939 void hci_set_control(const btstack_control_t *hardware_control);
940 
941 /**
942  * @brief Configure Bluetooth hardware control. Has to be called before power on.
943  */
944 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db);
945 
946 /**
947  * @brief Set callback for Bluetooth Hardware Error
948  */
949 void hci_set_hardware_error_callback(void (*fn)(uint8_t error));
950 
951 /**
952  * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h
953  */
954 void hci_set_bd_addr(bd_addr_t addr);
955 
956 /**
957  * @brief Configure Voice Setting for use with SCO data in HSP/HFP
958  */
959 void hci_set_sco_voice_setting(uint16_t voice_setting);
960 
961 /**
962  * @brief Get SCO Voice Setting
963  * @return current voice setting
964  */
965 uint16_t hci_get_sco_voice_setting(void);
966 
967 /**
968  * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on.
969  * @param inquriy_mode see bluetooth_defines.h
970  */
971 void hci_set_inquiry_mode(inquiry_mode_t mode);
972 
973 /**
974  * @brief Requests the change of BTstack power mode.
975  */
976 int  hci_power_control(HCI_POWER_MODE mode);
977 
978 /**
979  * @brief Shutdown HCI
980  */
981 void hci_close(void);
982 
983 
984 // Callback registration
985 
986 
987 /**
988  * @brief Add event packet handler.
989  */
990 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler);
991 
992 /**
993  * @brief Registers a packet handler for ACL data. Used by L2CAP
994  */
995 void hci_register_acl_packet_handler(btstack_packet_handler_t handler);
996 
997 /**
998  * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles.
999  */
1000 void hci_register_sco_packet_handler(btstack_packet_handler_t handler);
1001 
1002 
1003 // Sending HCI Commands
1004 
1005 /**
1006  * @brief Check if CMD packet can be sent to controller
1007  */
1008 int hci_can_send_command_packet_now(void);
1009 
1010 /**
1011  * @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.
1012  */
1013 int hci_send_cmd(const hci_cmd_t *cmd, ...);
1014 
1015 
1016 // Sending SCO Packets
1017 
1018 /** @brief Get SCO packet length for current SCO Voice setting
1019  *  @note  Using SCO packets of the exact length is required for USB transfer
1020  *  @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header
1021  */
1022 int hci_get_sco_packet_length(void);
1023 
1024 /**
1025  * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible
1026  * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function
1027  *       so packet handler should be ready to handle it
1028  */
1029 void hci_request_sco_can_send_now_event(void);
1030 
1031 /**
1032  * @brief Check HCI packet buffer and if SCO packet can be sent to controller
1033  */
1034 int hci_can_send_sco_packet_now(void);
1035 
1036 /**
1037  * @brief Check if SCO packet can be sent to controller
1038  */
1039 int hci_can_send_prepared_sco_packet_now(void);
1040 
1041 /**
1042  * @brief Send SCO packet prepared in HCI packet buffer
1043  */
1044 int hci_send_sco_packet_buffer(int size);
1045 
1046 
1047 // Outgoing packet buffer, also used for SCO packets
1048 // see hci_can_send_prepared_sco_packet_now amn hci_send_sco_packet_buffer
1049 
1050 /**
1051  * Reserves outgoing packet buffer.
1052  * @return 1 on success
1053  */
1054 int hci_reserve_packet_buffer(void);
1055 
1056 /**
1057  * Get pointer for outgoing packet buffer
1058  */
1059 uint8_t* hci_get_outgoing_packet_buffer(void);
1060 
1061 /**
1062  * Release outgoing packet buffer\
1063  * @note only called instead of hci_send_preparared
1064  */
1065 void hci_release_packet_buffer(void);
1066 
1067 /**
1068 * @brief Sets the master/slave policy
1069 * @param policy (0: attempt to become master, 1: let connecting device decide)
1070 */
1071 void hci_set_master_slave_policy(uint8_t policy);
1072 
1073 /* API_END */
1074 
1075 
1076 /**
1077  * va_list version of hci_send_cmd, call hci_send_cmd_packet
1078  */
1079 int hci_send_cmd_va_arg(const hci_cmd_t *cmd, va_list argtr);
1080 
1081 /**
1082  * Get connection iterator. Only used by l2cap.c and sm.c
1083  */
1084 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it);
1085 
1086 /**
1087  * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon
1088  */
1089 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle);
1090 
1091 /**
1092  * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP
1093  */
1094 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type);
1095 
1096 /**
1097  * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c
1098  */
1099 int hci_is_packet_buffer_reserved(void);
1100 
1101 /**
1102  * Check hci packet buffer is free and a classic acl packet can be sent to controller
1103  */
1104 int hci_can_send_acl_classic_packet_now(void);
1105 
1106 /**
1107  * Check hci packet buffer is free and an LE acl packet can be sent to controller
1108  */
1109 int hci_can_send_acl_le_packet_now(void);
1110 
1111 /**
1112  * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller
1113  */
1114 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle);
1115 
1116 /**
1117  * Check if acl packet for the given handle can be sent to controller
1118  */
1119 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle);
1120 
1121 /**
1122  * Send acl packet prepared in hci packet buffer
1123  */
1124 int hci_send_acl_packet_buffer(int size);
1125 
1126 /**
1127  * Check if authentication is active. It delays automatic disconnect while no L2CAP connection
1128  * Called by l2cap.
1129  */
1130 int hci_authentication_active_for_handle(hci_con_handle_t handle);
1131 
1132 /**
1133  * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP
1134  */
1135 uint16_t hci_max_acl_data_packet_length(void);
1136 
1137 /**
1138  * Get supported packet types. Called by L2CAP
1139  */
1140 uint16_t hci_usable_acl_packet_types(void);
1141 
1142 /**
1143  * Check if ACL packets marked as non flushable can be sent. Called by L2CAP
1144  */
1145 int hci_non_flushable_packet_boundary_flag_supported(void);
1146 
1147 /**
1148  * Check if extended SCO Link is supported
1149  */
1150 int hci_extended_sco_link_supported(void);
1151 
1152 /**
1153  * Check if SSP is supported on both sides. Called by L2CAP
1154  */
1155 int gap_ssp_supported_on_both_sides(hci_con_handle_t handle);
1156 
1157 /**
1158  * Disconn because of security block. Called by L2CAP
1159  */
1160 void hci_disconnect_security_block(hci_con_handle_t con_handle);
1161 
1162 /**
1163  * Query if remote side supports eSCO
1164  */
1165 int hci_remote_esco_supported(hci_con_handle_t con_handle);
1166 
1167 /**
1168  * Emit current HCI state. Called by daemon
1169  */
1170 void hci_emit_state(void);
1171 
1172 /**
1173  * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg
1174  * @returns 0 if command was successfully sent to HCI Transport layer
1175  */
1176 int hci_send_cmd_packet(uint8_t *packet, int size);
1177 
1178 /**
1179  * Disconnect all HCI connections. Called by daemon
1180  */
1181 void hci_disconnect_all(void);
1182 
1183 /**
1184  * Get number of free acl slots for packets of given handle. Called by daemon
1185  */
1186 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle);
1187 
1188 /**
1189  * @brief Set Advertisement Parameters
1190  * @param adv_int_min
1191  * @param adv_int_max
1192  * @param adv_type
1193  * @param direct_address_type
1194  * @param direct_address
1195  * @param channel_map
1196  * @param filter_policy
1197  *
1198  * @note internal use. use gap_advertisements_set_params from gap.h instead.
1199  */
1200 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type,
1201     uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy);
1202 
1203 /**
1204  *
1205  * @note internal use. use gap_random_address_set_mode from gap.h instead.
1206  */
1207 void hci_le_set_own_address_type(uint8_t own_address_type);
1208 
1209 /**
1210  * @brief Get Manufactured
1211  * @return manufacturer id
1212  */
1213 uint16_t hci_get_manufacturer(void);
1214 
1215 // Only for PTS testing
1216 
1217 /**
1218  * Disable automatic L2CAP disconnect if no L2CAP connection is established
1219  */
1220 void hci_disable_l2cap_timeout_check(void);
1221 
1222 /**
1223  * Get state
1224  */
1225 HCI_STATE hci_get_state(void);
1226 
1227 /**
1228  * Defer halt. Used by btstack_crypto to allow current HCI operation to complete
1229  */
1230 void hci_halting_defer(void);
1231 
1232 #if defined __cplusplus
1233 }
1234 #endif
1235 
1236 #endif // HCI_H
1237