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