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