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