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