xref: /btstack/src/hci.h (revision 0b78a44766c58e2442074e2c64ce5cc27f775238)
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 BLUEKITCHEN
24  * GMBH 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  * @title Host Controler Interface (HCI)
40  *
41  */
42 
43 #ifndef HCI_H
44 #define HCI_H
45 
46 #include "btstack_config.h"
47 
48 #include "btstack_chipset.h"
49 #include "btstack_control.h"
50 #include "btstack_linked_list.h"
51 #include "btstack_util.h"
52 #include "hci_cmd.h"
53 #include "gap.h"
54 #include "hci_transport.h"
55 #include "btstack_run_loop.h"
56 
57 #ifdef ENABLE_CLASSIC
58 #include "classic/btstack_link_key_db.h"
59 #endif
60 
61 #ifdef ENABLE_BLE
62 #include "ble/att_db.h"
63 #endif
64 
65 #ifdef HAVE_SCO_TRANSPORT
66 #include "btstack_sco_transport.h"
67 #endif
68 
69 #include <stdint.h>
70 #include <stdlib.h>
71 #include <stdarg.h>
72 
73 #if defined __cplusplus
74 extern "C" {
75 #endif
76 
77 // packet buffer sizes
78 #define HCI_CMD_HEADER_SIZE          3
79 #define HCI_ACL_HEADER_SIZE          4
80 #define HCI_SCO_HEADER_SIZE          3
81 #define HCI_EVENT_HEADER_SIZE        2
82 #define HCI_ISO_HEADER_SIZE          4
83 
84 #define HCI_EVENT_PAYLOAD_SIZE     255
85 #define HCI_CMD_PAYLOAD_SIZE       255
86 
87 // default for ISO streams: 48_6_2 : 2 x 155
88 #ifndef HCI_ISO_PAYLOAD_SIZE
89 #define HCI_ISO_PAYLOAD_SIZE 310
90 #endif
91 
92 // Max HCI Command LE payload size:
93 // 64 from LE Generate DHKey command
94 // 32 from LE Encrypt command
95 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS)
96 #define HCI_CMD_PAYLOAD_SIZE_LE 64
97 #else
98 #define HCI_CMD_PAYLOAD_SIZE_LE 32
99 #endif
100 
101 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h
102 // addition byte in even to terminate remote name request with '\0'
103 #define HCI_EVENT_BUFFER_SIZE      (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1)
104 
105 #ifdef ENABLE_CLASSIC
106 #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE)
107 #else
108 #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE_LE)
109 #endif
110 
111 #define HCI_ACL_BUFFER_SIZE        (HCI_ACL_HEADER_SIZE   + HCI_ACL_PAYLOAD_SIZE)
112 
113 // size of hci incoming buffer, big enough for event or acl packet without H4 packet type
114 #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE
115     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
116         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
117     #endif
118     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE
119         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE
120     #endif
121 #else
122     #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE
123         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
124     #else
125         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE
126     #endif
127 #endif
128 
129 // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type
130 #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE
131     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
132         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
133     #endif
134     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE
135         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE
136     #endif
137 #else
138     #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE
139         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
140     #else
141         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE
142     #endif
143 #endif
144 
145 // additional pre-buffer space for packets to Bluetooth module
146 // - H4 requires 1 byte for the packet type
147 // - h5 requires 4 bytes for H5 header
148 #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE
149     #ifdef HAVE_HOST_CONTROLLER_API
150         #define HCI_OUTGOING_PRE_BUFFER_SIZE 0
151     #else
152         #ifdef ENABLE_H5
153             #define HCI_OUTGOING_PRE_BUFFER_SIZE 4
154         #else
155             #define HCI_OUTGOING_PRE_BUFFER_SIZE 1
156         #endif
157     #endif
158 #endif
159 
160 // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads
161 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE
162 #ifdef ENABLE_CLASSIC
163 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4)
164 #else
165 #define HCI_INCOMING_PRE_BUFFER_SIZE 2
166 #endif
167 #endif
168 
169 //
170 #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode )
171 
172 // check if command complete event for given command
173 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) )
174 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd)   ( (event[0] == HCI_EVENT_COMMAND_STATUS)   && (little_endian_read_16(event,4) == cmd.opcode) )
175 
176 // Code+Len=2, Pkts+Opcode=3; total=5
177 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5
178 
179 // ACL Packet
180 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
181 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
182 #define READ_ISO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
183 #define READ_ACL_FLAGS( buffer )      ( buffer[1] >> 4 )
184 #define READ_ACL_LENGTH( buffer )     (little_endian_read_16(buffer, 2))
185 
186 // Sneak peak into L2CAP Packet
187 #define READ_L2CAP_LENGTH(buffer)     ( little_endian_read_16(buffer, 4))
188 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6))
189 
190 /**
191  * LE connection parameter update state
192  */
193 
194 typedef enum {
195     CON_PARAMETER_UPDATE_NONE,
196     // L2CAP
197     CON_PARAMETER_UPDATE_SEND_REQUEST,
198     CON_PARAMETER_UPDATE_SEND_RESPONSE,
199     CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS,
200     CON_PARAMETER_UPDATE_DENY,
201     // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST
202     CON_PARAMETER_UPDATE_REPLY,
203     CON_PARAMETER_UPDATE_NEGATIVE_REPLY,
204 } le_con_parameter_update_state_t;
205 
206 // Authentication flags
207 typedef enum {
208     AUTH_FLAG_NONE                                = 0x0000,
209     AUTH_FLAG_HANDLE_LINK_KEY_REQUEST             = 0x0001,
210     AUTH_FLAG_DENY_PIN_CODE_REQUEST               = 0x0002,
211     AUTH_FLAG_RECV_IO_CAPABILITIES_REQUEST        = 0x0004,
212     AUTH_FLAG_RECV_IO_CAPABILITIES_RESPONSE       = 0x0008,
213     AUTH_FLAG_SEND_IO_CAPABILITIES_REPLY          = 0x0010,
214     AUTH_FLAG_SEND_IO_CAPABILITIES_NEGATIVE_REPLY = 0x0020,
215     AUTH_FLAG_SEND_USER_CONFIRM_REPLY             = 0x0040,
216     AUTH_FLAG_SEND_USER_CONFIRM_NEGATIVE_REPLY    = 0x0080,
217     AUTH_FLAG_SEND_USER_PASSKEY_REPLY             = 0x0100,
218 
219     // Classic OOB
220     AUTH_FLAG_SEND_REMOTE_OOB_DATA_REPLY          = 0x0200,
221 
222     // pairing status
223     AUTH_FLAG_LEGACY_PAIRING_ACTIVE               = 0x0400,
224     AUTH_FLAG_SSP_PAIRING_ACTIVE                  = 0x0800,
225     AUTH_FLAG_PAIRING_ACTIVE_MASK                 = (AUTH_FLAG_LEGACY_PAIRING_ACTIVE | AUTH_FLAG_SSP_PAIRING_ACTIVE),
226 
227     // connection status
228     AUTH_FLAG_CONNECTION_AUTHENTICATED            = 0x1000,
229     AUTH_FLAG_CONNECTION_ENCRYPTED                = 0x2000,
230 
231 } hci_authentication_flags_t;
232 
233 // GAP Connection Tasks
234 #define GAP_CONNECTION_TASK_WRITE_AUTOMATIC_FLUSH_TIMEOUT 0x0001u
235 #define GAP_CONNECTION_TASK_WRITE_SUPERVISION_TIMEOUT     0x0002u
236 #define GAP_CONNECTION_TASK_READ_RSSI                     0x0004u
237 #define GAP_CONNECTION_TASK_LE_READ_REMOTE_FEATURES       0x0008u
238 
239 /**
240  * Connection State
241  */
242 typedef enum {
243     SEND_CREATE_CONNECTION = 0,
244     SENT_CREATE_CONNECTION,
245     RECEIVED_CONNECTION_REQUEST,
246     ACCEPTED_CONNECTION_REQUEST,
247     OPEN,
248     SEND_DISCONNECT,
249     SENT_DISCONNECT,
250     RECEIVED_DISCONNECTION_COMPLETE
251 } CONNECTION_STATE;
252 
253 // bonding flags
254 enum {
255     // remote features
256     BONDING_REMOTE_FEATURES_QUERY_ACTIVE      =  0x0001,
257     BONDING_REQUEST_REMOTE_FEATURES_PAGE_0    =  0x0002,
258     BONDING_REQUEST_REMOTE_FEATURES_PAGE_1    =  0x0004,
259     BONDING_REQUEST_REMOTE_FEATURES_PAGE_2    =  0x0008,
260     BONDING_RECEIVED_REMOTE_FEATURES          =  0x0010,
261     BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER    =  0x0020,
262     BONDING_REMOTE_SUPPORTS_SSP_HOST          =  0x0040,
263     BONDING_REMOTE_SUPPORTS_SC_CONTROLLER     =  0x0080,
264     BONDING_REMOTE_SUPPORTS_SC_HOST           =  0x0100,
265     // other
266     BONDING_DISCONNECT_SECURITY_BLOCK         =  0x0200,
267     BONDING_DISCONNECT_DEDICATED_DONE         =  0x0400,
268     BONDING_SEND_AUTHENTICATE_REQUEST         =  0x0800,
269     BONDING_SENT_AUTHENTICATE_REQUEST         =  0x1000,
270     BONDING_SEND_ENCRYPTION_REQUEST           =  0x2000,
271     BONDING_SEND_READ_ENCRYPTION_KEY_SIZE     =  0x4000,
272     BONDING_DEDICATED                         =  0x8000,
273     BONDING_DEDICATED_DEFER_DISCONNECT        = 0x10000,
274     BONDING_EMIT_COMPLETE_ON_DISCONNECT       = 0x20000,
275 };
276 
277 typedef enum {
278     BLUETOOTH_OFF = 1,
279     BLUETOOTH_ON,
280     BLUETOOTH_ACTIVE
281 } BLUETOOTH_STATE;
282 
283 typedef enum {
284     LE_CONNECTING_IDLE,
285     LE_CONNECTING_CANCEL,
286     LE_CONNECTING_DIRECT,
287     LE_CONNECTING_WHITELIST,
288 } le_connecting_state_t;
289 
290 #ifdef ENABLE_BLE
291 
292 //
293 // SM internal types and globals
294 //
295 
296 typedef enum {
297 
298     // general states
299     SM_GENERAL_IDLE,
300     SM_GENERAL_SEND_PAIRING_FAILED,
301     SM_GENERAL_TIMEOUT, // no other security messages are exchanged
302     SM_GENERAL_REENCRYPTION_FAILED,
303 
304     // Phase 1: Pairing Feature Exchange
305     SM_PH1_W4_USER_RESPONSE,
306 
307     // Phase 2: Authenticating and Encrypting
308 
309     // get random number for use as TK Passkey if we show it
310     SM_PH2_GET_RANDOM_TK,
311     SM_PH2_W4_RANDOM_TK,
312 
313     // get local random number for confirm c1
314     SM_PH2_C1_GET_RANDOM_A,
315     SM_PH2_C1_W4_RANDOM_A,
316     SM_PH2_C1_GET_RANDOM_B,
317     SM_PH2_C1_W4_RANDOM_B,
318 
319     // calculate confirm value for local side
320     SM_PH2_C1_GET_ENC_A,
321     SM_PH2_C1_W4_ENC_A,
322 
323     // calculate confirm value for remote side
324     SM_PH2_C1_GET_ENC_C,
325     SM_PH2_C1_W4_ENC_C,
326 
327     SM_PH2_C1_SEND_PAIRING_CONFIRM,
328     SM_PH2_SEND_PAIRING_RANDOM,
329 
330     // calc STK
331     SM_PH2_CALC_STK,
332     SM_PH2_W4_STK,
333 
334     SM_PH2_W4_CONNECTION_ENCRYPTED,
335 
336     // Phase 3: Transport Specific Key Distribution
337     // calculate DHK, Y, EDIV, and LTK
338     SM_PH3_Y_GET_ENC,
339     SM_PH3_Y_W4_ENC,
340     SM_PH3_LTK_GET_ENC,
341 
342     // exchange keys
343     SM_PH3_DISTRIBUTE_KEYS,
344     SM_PH3_RECEIVE_KEYS,
345 
346     // Phase 4: re-establish previously distributed LTK
347     SM_PH4_W4_CONNECTION_ENCRYPTED,
348 
349     // RESPONDER ROLE
350     SM_RESPONDER_IDLE,
351     SM_RESPONDER_SEND_SECURITY_REQUEST,
352     SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST,
353     SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK,
354     SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY,
355     SM_RESPONDER_PH1_W4_PAIRING_REQUEST,
356     SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED,
357     SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED_W4_IRK,
358     SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE,
359     SM_RESPONDER_PH1_W4_PAIRING_CONFIRM,
360     SM_RESPONDER_PH2_W4_PAIRING_RANDOM,
361     SM_RESPONDER_PH2_W4_LTK_REQUEST,
362     SM_RESPONDER_PH2_SEND_LTK_REPLY,
363     SM_RESPONDER_PH4_Y_W4_ENC,
364     SM_RESPONDER_PH4_SEND_LTK_REPLY,
365 
366     // INITIATOR ROLE
367     SM_INITIATOR_CONNECTED,
368     SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST,
369     SM_INITIATOR_PH1_W4_PAIRING_RESPONSE,
370     SM_INITIATOR_PH2_W4_PAIRING_CONFIRM,
371     SM_INITIATOR_PH2_W4_PAIRING_RANDOM,
372     SM_INITIATOR_PH3_SEND_START_ENCRYPTION,
373     SM_INITIATOR_PH4_HAS_LTK,
374 
375     // LE Secure Connections
376     SM_SC_RECEIVED_LTK_REQUEST,
377     SM_SC_SEND_PUBLIC_KEY_COMMAND,
378     SM_SC_W4_PUBLIC_KEY_COMMAND,
379     SM_SC_W4_LOCAL_NONCE,
380     SM_SC_W2_CMAC_FOR_CONFIRMATION,
381     SM_SC_W4_CMAC_FOR_CONFIRMATION,
382     SM_SC_SEND_CONFIRMATION,
383     SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION,
384     SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION,
385     SM_SC_W4_CONFIRMATION,
386     SM_SC_SEND_PAIRING_RANDOM,
387     SM_SC_W4_PAIRING_RANDOM,
388     SM_SC_W2_CALCULATE_G2,
389     SM_SC_W4_CALCULATE_G2,
390     SM_SC_W4_CALCULATE_DHKEY,
391     SM_SC_W2_CALCULATE_F5_SALT,
392     SM_SC_W4_CALCULATE_F5_SALT,
393     SM_SC_W2_CALCULATE_F5_MACKEY,
394     SM_SC_W4_CALCULATE_F5_MACKEY,
395     SM_SC_W2_CALCULATE_F5_LTK,
396     SM_SC_W4_CALCULATE_F5_LTK,
397     SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK,
398     SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK,
399     SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
400     SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
401     SM_SC_W4_USER_RESPONSE,
402     SM_SC_SEND_DHKEY_CHECK_COMMAND,
403     SM_SC_W4_DHKEY_CHECK_COMMAND,
404     SM_SC_W4_LTK_REQUEST_SC,
405     SM_SC_W2_CALCULATE_ILK_USING_H6,
406 	SM_SC_W2_CALCULATE_ILK_USING_H7,
407     SM_SC_W4_CALCULATE_ILK,
408     SM_SC_W2_CALCULATE_BR_EDR_LINK_KEY,
409     SM_SC_W4_CALCULATE_BR_EDR_LINK_KEY,
410 
411     // Classic
412     SM_BR_EDR_W4_ENCRYPTION_COMPLETE,
413     SM_BR_EDR_INITIATOR_W4_FIXED_CHANNEL_MASK,
414     SM_BR_EDR_INITIATOR_SEND_PAIRING_REQUEST,
415     SM_BR_EDR_INITIATOR_W4_PAIRING_RESPONSE,
416     SM_BR_EDR_RESPONDER_W4_PAIRING_REQUEST,
417     SM_BR_EDR_RESPONDER_PAIRING_REQUEST_RECEIVED,
418     SM_BR_EDR_DISTRIBUTE_KEYS,
419     SM_BR_EDR_RECEIVE_KEYS,
420     SM_BR_EDR_W2_CALCULATE_ILK_USING_H6,
421     SM_BR_EDR_W2_CALCULATE_ILK_USING_H7,
422     SM_BR_EDR_W4_CALCULATE_ILK,
423     SM_BR_EDR_W2_CALCULATE_LE_LTK,
424     SM_BR_EDR_W4_CALCULATE_LE_LTK,
425 } security_manager_state_t;
426 
427 typedef enum {
428     IRK_LOOKUP_IDLE,
429     IRK_LOOKUP_W4_READY,
430     IRK_LOOKUP_STARTED,
431     IRK_LOOKUP_SUCCEEDED,
432     IRK_LOOKUP_FAILED
433 } irk_lookup_state_t;
434 
435 typedef uint8_t sm_pairing_packet_t[7];
436 
437 // connection info available as long as connection exists
438 typedef struct sm_connection {
439     hci_con_handle_t         sm_handle;
440     uint16_t                 sm_cid;
441     uint8_t                  sm_role;   // 0 - IamMaster, 1 = IamSlave
442     uint8_t                  sm_security_request_received;
443     uint8_t                  sm_pairing_requested;
444     uint8_t                  sm_peer_addr_type;
445     bd_addr_t                sm_peer_address;
446     uint8_t                  sm_own_addr_type;
447     bd_addr_t                sm_own_address;
448     security_manager_state_t sm_engine_state;
449     irk_lookup_state_t       sm_irk_lookup_state;
450     uint8_t                  sm_pairing_failed_reason;
451     uint8_t                  sm_connection_encrypted;
452     uint8_t                  sm_connection_authenticated;   // [0..1]
453     uint8_t                  sm_connection_sc;
454     uint8_t                  sm_actual_encryption_key_size;
455     sm_pairing_packet_t      sm_m_preq;  // only used during c1
456     authorization_state_t    sm_connection_authorization_state;
457     uint16_t                 sm_local_ediv;
458     uint8_t                  sm_local_rand[8];
459     int                      sm_le_db_index;
460     bool                     sm_pairing_active;
461     bool                     sm_reencryption_active;
462 } sm_connection_t;
463 
464 //
465 // ATT Server
466 //
467 
468 // max ATT request matches L2CAP PDU -- allow to use smaller buffer
469 #ifndef ATT_REQUEST_BUFFER_SIZE
470 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE
471 #endif
472 
473 typedef enum {
474     ATT_SERVER_IDLE,
475     ATT_SERVER_REQUEST_RECEIVED,
476     ATT_SERVER_W4_SIGNED_WRITE_VALIDATION,
477     ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED,
478     ATT_SERVER_RESPONSE_PENDING,
479 } att_server_state_t;
480 
481 typedef struct {
482     att_server_state_t      state;
483 
484     uint8_t                 peer_addr_type;
485     bd_addr_t               peer_address;
486 
487     int                     ir_le_device_db_index;
488     uint8_t                 ir_lookup_active;
489     uint8_t                 pairing_active;
490 
491     uint16_t                value_indication_handle;
492     btstack_timer_source_t  value_indication_timer;
493 
494     btstack_linked_list_t   notification_requests;
495     btstack_linked_list_t   indication_requests;
496 
497 #ifdef ENABLE_GATT_OVER_CLASSIC
498     uint16_t                l2cap_cid;
499 #endif
500 
501     uint16_t                request_size;
502     uint8_t                 request_buffer[ATT_REQUEST_BUFFER_SIZE];
503 
504 } att_server_t;
505 
506 #endif
507 
508 typedef enum {
509     L2CAP_INFORMATION_STATE_IDLE = 0,
510     L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST,
511     L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE,
512     L2CAP_INFORMATION_STATE_W2_SEND_FIXED_CHANNELS_REQUEST,
513     L2CAP_INFORMATION_STATE_W4_FIXED_CHANNELS_RESPONSE,
514     L2CAP_INFORMATION_STATE_DONE
515 } l2cap_information_state_t;
516 
517 typedef struct {
518     l2cap_information_state_t information_state;
519     uint16_t                  extended_feature_mask;
520     uint16_t                  fixed_channels_supported;    // Core V5.3 - only first octet used
521 } l2cap_state_t;
522 
523 //
524 typedef struct {
525     // linked list - assert: first field
526     btstack_linked_item_t    item;
527 
528     // remote side
529     bd_addr_t address;
530 
531     // module handle
532     hci_con_handle_t con_handle;
533 
534     // le public, le random, classic
535     bd_addr_type_t address_type;
536 
537     // role: 0 - master, 1 - slave
538     hci_role_t role;
539 
540     // connection state
541     CONNECTION_STATE state;
542 
543     // bonding
544     uint32_t bonding_flags;
545     uint8_t  bonding_status;
546 
547     // encryption key size (in octets)
548     uint8_t encryption_key_size;
549 
550     // requested security level
551     gap_security_level_t requested_security_level;
552 
553     // link key and its type for Classic connections
554     // LTK and LTK valid flag for LE connections
555     link_key_t      link_key;
556     link_key_type_t link_key_type;
557 
558 #ifdef ENABLE_CLASSIC
559     // remote supported SCO packets based on remote supported features mask
560     uint16_t remote_supported_sco_packets;
561 
562     // remote supported features
563     /* bit 0 - eSCO */
564     /* bit 1 - extended features */
565     uint8_t remote_supported_features[1];
566 
567     // IO Capabilities Response
568     uint8_t io_cap_response_auth_req;
569     uint8_t io_cap_response_io;
570 #ifdef ENABLE_CLASSIC_PAIRING_OOB
571     uint8_t io_cap_response_oob_data;
572 #endif
573 
574     // connection mode, default ACL_CONNECTION_MODE_ACTIVE
575     uint8_t connection_mode;
576 
577     // enter/exit sniff mode requests
578     uint16_t sniff_min_interval;    // 0: idle, 0xffff exit sniff, else enter sniff
579     uint16_t sniff_max_interval;
580     uint16_t sniff_attempt;
581     uint16_t sniff_timeout;
582 
583     // sniff subrating
584     uint16_t sniff_subrating_max_latency;   // 0xffff = not set
585     uint16_t sniff_subrating_min_remote_timeout;
586     uint16_t sniff_subrating_min_local_timeout;
587 
588     // QoS
589     hci_service_type_t qos_service_type;
590     uint32_t qos_token_rate;
591     uint32_t qos_peak_bandwidth;
592     uint32_t qos_latency;
593     uint32_t qos_delay_variation;
594 
595 #ifdef ENABLE_SCO_OVER_HCI
596     // track SCO rx event
597     uint32_t sco_rx_ms;
598     uint8_t  sco_rx_count;
599     uint8_t  sco_rx_valid;
600 #endif
601     // generate sco can send now based on received packets, using timeout below
602     uint8_t  sco_tx_ready;
603 
604     // request role switch
605     hci_role_t request_role;
606 
607     btstack_timer_source_t timeout_sco;
608 #endif /* ENABLE_CLASSIC */
609 
610     // authentication and other errands
611     uint16_t authentication_flags;
612 
613     // gap connection tasks, see GAP_CONNECTION_TASK_x
614     uint16_t gap_connection_tasks;
615 
616     btstack_timer_source_t timeout;
617 
618     // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS)
619     uint32_t timestamp;
620 
621     // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload
622     uint8_t  acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE];
623     uint16_t acl_recombination_pos;
624     uint16_t acl_recombination_length;
625 
626 
627     // number packets sent to controller
628     uint8_t num_packets_sent;
629 
630 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
631     uint8_t num_packets_completed;
632 #endif
633 
634     // LE Connection parameter update
635     le_con_parameter_update_state_t le_con_parameter_update_state;
636     uint8_t  le_con_param_update_identifier;
637     uint16_t le_conn_interval_min;
638     uint16_t le_conn_interval_max;
639     uint16_t le_conn_latency;
640     uint16_t le_supervision_timeout;
641 
642 #ifdef ENABLE_BLE
643     uint16_t le_connection_interval;
644 
645     // LE PHY Update via set phy command
646     uint8_t le_phy_update_all_phys;      // 0xff for idle
647     uint8_t le_phy_update_tx_phys;
648     uint8_t le_phy_update_rx_phys;
649     int8_t  le_phy_update_phy_options;
650 
651     // LE Security Manager
652     sm_connection_t sm_connection;
653 
654 #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS
655     uint16_t le_max_tx_octets;
656 #endif
657 
658     // ATT Connection
659     att_connection_t att_connection;
660 
661     // ATT Server
662     att_server_t    att_server;
663 
664 #ifdef ENABLE_LE_PERIODIC_ADVERTISING
665     hci_con_handle_t le_past_sync_handle;
666     uint16_t         le_past_service_data;
667 #endif
668 
669 #endif
670 
671     l2cap_state_t l2cap_state;
672 
673 #ifdef ENABLE_CLASSIC_PAIRING_OOB
674     const uint8_t * classic_oob_c_192;
675     const uint8_t * classic_oob_r_192;
676     const uint8_t * classic_oob_c_256;
677     const uint8_t * classic_oob_r_256;
678 #endif
679 
680 } hci_connection_t;
681 
682 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS
683 
684 
685 typedef enum {
686     HCI_ISO_TYPE_INVALID = 0,
687     HCI_ISO_TYPE_BIS,
688     HCI_ISO_TYPE_CIS,
689 } hci_iso_type_t;
690 
691 #define HCI_ISO_GROUP_ID_SINGLE_CIS 0xfe
692 #define HCI_ISO_GROUP_ID_INVALID    0xff
693 
694 typedef enum{
695     HCI_ISO_STREAM_STATE_IDLE,
696     HCI_ISO_STREAM_W4_USER,
697     HCI_ISO_STREAM_W2_ACCEPT,
698     HCI_ISO_STREAM_W2_REJECT,
699     HCI_ISO_STREAM_STATE_REQUESTED,
700     HCI_ISO_STREAM_STATE_W4_ESTABLISHED,
701     HCI_ISO_STREAM_STATE_ESTABLISHED,
702     HCI_ISO_STREAM_STATE_W2_SETUP_ISO_INPUT,
703     HCI_ISO_STREAM_STATE_W4_ISO_SETUP_INPUT,
704     HCI_ISO_STREAM_STATE_W2_SETUP_ISO_OUTPUT,
705     HCI_ISO_STREAM_STATE_W4_ISO_SETUP_OUTPUT,
706 } hci_iso_stream_state_t;
707 
708 typedef struct {
709     // linked list - assert: first field
710     btstack_linked_item_t    item;
711 
712     // state
713     hci_iso_stream_state_t state;
714 
715     // iso type: bis or cis
716     hci_iso_type_t iso_type;
717 
718     // group_id: big_handle or cig_id
719     uint8_t group_id;
720 
721     // stream_id: bis_index or cis_id
722     uint8_t stream_id;
723 
724     // only valid for HCI_ISO_TYPE_CIS
725     hci_con_handle_t cis_handle;
726     hci_con_handle_t acl_handle;
727 
728     // connection info
729     uint16_t max_sdu_c_to_p;
730     uint16_t max_sdu_p_to_c;
731 
732     // re-assembly buffer
733     uint16_t reassembly_pos;
734     uint8_t  reassembly_buffer[HCI_ISO_PAYLOAD_SIZE];
735 
736     // number packets sent to controller
737     uint8_t num_packets_sent;
738 
739     // packets to skip due to queuing them to late before
740     uint8_t num_packets_to_skip;
741 
742     // request to send
743     bool can_send_now_requested;
744 
745     // ready to send
746     bool emit_ready_to_send;
747 
748 } hci_iso_stream_t;
749 #endif
750 
751 /**
752  * HCI Initialization State Machine
753  */
754 typedef enum hci_init_state{
755     HCI_INIT_SEND_RESET = 0,
756     HCI_INIT_W4_SEND_RESET,
757     HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION,
758     HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION,
759 
760 #ifndef HAVE_HOST_CONTROLLER_API
761     HCI_INIT_SEND_READ_LOCAL_NAME,
762     HCI_INIT_W4_SEND_READ_LOCAL_NAME,
763     HCI_INIT_SEND_BAUD_CHANGE,
764     HCI_INIT_W4_SEND_BAUD_CHANGE,
765     HCI_INIT_CUSTOM_INIT,
766     HCI_INIT_W4_CUSTOM_INIT,
767 
768     HCI_INIT_SEND_RESET_CSR_WARM_BOOT,
769     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT,
770     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET,
771 
772     HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY,
773 
774     // Support for Pre-Init before HCI Reset
775     HCI_INIT_CUSTOM_PRE_INIT,
776     HCI_INIT_W4_CUSTOM_PRE_INIT,
777 #endif
778 
779     HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS,
780     HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS,
781 
782     HCI_INIT_SEND_BAUD_CHANGE_BCM,
783     HCI_INIT_W4_SEND_BAUD_CHANGE_BCM,
784 
785     HCI_INIT_SET_BD_ADDR,
786     HCI_INIT_W4_SET_BD_ADDR,
787 
788     HCI_INIT_SEND_RESET_ST_WARM_BOOT,
789     HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT,
790 
791     HCI_INIT_READ_BD_ADDR,
792     HCI_INIT_W4_READ_BD_ADDR,
793 
794     HCI_INIT_READ_BUFFER_SIZE,
795     HCI_INIT_W4_READ_BUFFER_SIZE,
796     HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES,
797     HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES,
798 
799 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
800     HCI_INIT_HOST_BUFFER_SIZE,
801     HCI_INIT_W4_HOST_BUFFER_SIZE,
802     HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
803     HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
804 #endif
805 
806     HCI_INIT_SET_EVENT_MASK,
807     HCI_INIT_W4_SET_EVENT_MASK,
808     HCI_INIT_SET_EVENT_MASK_2,
809     HCI_INIT_W4_SET_EVENT_MASK_2,
810 
811 #ifdef ENABLE_CLASSIC
812     HCI_INIT_WRITE_SIMPLE_PAIRING_MODE,
813     HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE,
814     HCI_INIT_WRITE_INQUIRY_MODE,
815     HCI_INIT_W4_WRITE_INQUIRY_MODE,
816     HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE,
817     HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE,
818     HCI_INIT_SET_MIN_ENCRYPTION_KEY_SIZE,
819     HCI_INIT_W4_SET_MIN_ENCRYPTION_KEY_SIZE,
820 
821 #ifdef ENABLE_SCO_OVER_HCI
822     // SCO over HCI
823     HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
824     HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
825     HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
826     HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
827 #endif
828 
829 #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM)
830     // Broadcom SCO Routing and Configuration
831     HCI_INIT_BCM_WRITE_SCO_PCM_INT,
832     HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT,
833 #endif
834 #ifdef ENABLE_SCO_OVER_PCM
835     HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM,
836     HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM,
837 #endif
838 #endif
839 
840 #ifdef ENABLE_BLE
841     HCI_INIT_LE_READ_BUFFER_SIZE,
842     HCI_INIT_W4_LE_READ_BUFFER_SIZE,
843     HCI_INIT_WRITE_LE_HOST_SUPPORTED,
844     HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED,
845     HCI_INIT_LE_SET_EVENT_MASK,
846     HCI_INIT_W4_LE_SET_EVENT_MASK,
847 #endif
848 
849 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
850     HCI_INIT_LE_READ_MAX_DATA_LENGTH,
851     HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH,
852     HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH,
853     HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH,
854 #endif
855 
856 #ifdef ENABLE_LE_CENTRAL
857     HCI_INIT_READ_WHITE_LIST_SIZE,
858     HCI_INIT_W4_READ_WHITE_LIST_SIZE,
859 #endif
860 
861 #ifdef ENABLE_LE_PERIPHERAL
862 #ifdef ENABLE_LE_EXTENDED_ADVERTISING
863     HCI_INIT_LE_READ_MAX_ADV_DATA_LEN,
864     HCI_INIT_W4_LE_READ_MAX_ADV_DATA_LEN,
865 #endif
866 #endif
867 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS
868     HCI_INIT_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS,
869     HCI_INIT_W4_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS,
870 #endif
871 
872     HCI_INIT_DONE,
873 
874     HCI_FALLING_ASLEEP_DISCONNECT,
875     HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE,
876     HCI_FALLING_ASLEEP_COMPLETE,
877 
878     HCI_INIT_AFTER_SLEEP,
879 
880     HCI_HALTING_CLASSIC_STOP,
881     HCI_HALTING_LE_ADV_STOP,
882     HCI_HALTING_LE_SCAN_STOP,
883     HCI_HALTING_DISCONNECT_ALL,
884     HCI_HALTING_W4_CLOSE_TIMER,
885     HCI_HALTING_CLOSE,
886     HCI_HALTING_CLOSE_DISCARDING_CONNECTIONS,
887 
888 } hci_substate_t;
889 
890 #define GAP_TASK_SET_LOCAL_NAME               0x01
891 #define GAP_TASK_SET_EIR_DATA                 0x02
892 #define GAP_TASK_SET_CLASS_OF_DEVICE          0x04
893 #define GAP_TASK_SET_DEFAULT_LINK_POLICY      0x08
894 #define GAP_TASK_WRITE_SCAN_ENABLE            0x10
895 #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY     0x20
896 #define GAP_TASK_WRITE_PAGE_SCAN_TYPE         0x40
897 #define GAP_TASK_WRITE_PAGE_TIMEOUT           0x80
898 #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100
899 
900 enum {
901     // Tasks
902     LE_ADVERTISEMENT_TASKS_SET_ADV_DATA         = 1 << 0,
903     LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA        = 1 << 1,
904     LE_ADVERTISEMENT_TASKS_SET_PARAMS           = 1 << 2,
905     LE_ADVERTISEMENT_TASKS_SET_PERIODIC_PARAMS  = 1 << 3,
906     LE_ADVERTISEMENT_TASKS_SET_PERIODIC_DATA    = 1 << 4,
907     LE_ADVERTISEMENT_TASKS_REMOVE_SET           = 1 << 5,
908     LE_ADVERTISEMENT_TASKS_SET_ADDRESS          = 1 << 6,
909     LE_ADVERTISEMENT_TASKS_SET_ADDRESS_SET_0    = 1 << 7,
910 };
911 
912 enum {
913     // State
914     LE_ADVERTISEMENT_STATE_PARAMS_SET       = 1 << 0,
915     LE_ADVERTISEMENT_STATE_ACTIVE           = 1 << 1,
916     LE_ADVERTISEMENT_STATE_ENABLED          = 1 << 2,
917     LE_ADVERTISEMENT_STATE_PERIODIC_ACTIVE  = 1 << 3,
918     LE_ADVERTISEMENT_STATE_PERIODIC_ENABLED = 1 << 4,
919 };
920 
921 enum {
922     LE_WHITELIST_ON_CONTROLLER          = 1 << 0,
923     LE_WHITELIST_ADD_TO_CONTROLLER      = 1 << 1,
924     LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2,
925 };
926 
927 enum {
928     LE_PERIODIC_ADVERTISER_LIST_ENTRY_ON_CONTROLLER          = 1 << 0,
929     LE_PERIODIC_ADVERTISER_LIST_ENTRY_ADD_TO_CONTROLLER      = 1 << 1,
930     LE_PERIODIC_ADVERTISER_LIST_ENTRY_REMOVE_FROM_CONTROLLER = 1 << 2,
931 };
932 
933 typedef struct {
934     btstack_linked_item_t  item;
935     bd_addr_t      address;
936     bd_addr_type_t address_type;
937     uint8_t        state;
938 } whitelist_entry_t;
939 
940 typedef struct {
941     btstack_linked_item_t  item;
942     bd_addr_t      address;
943     bd_addr_type_t address_type;
944     uint8_t        sid;
945     uint8_t        state;
946 } periodic_advertiser_list_entry_t;
947 
948 #define MAX_NUM_RESOLVING_LIST_ENTRIES 64
949 typedef enum {
950     LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION,
951     LE_RESOLVING_LIST_READ_SIZE,
952     LE_RESOLVING_LIST_SEND_CLEAR,
953 	LE_RESOLVING_LIST_UPDATES_ENTRIES,
954     LE_RESOLVING_LIST_DONE
955 } le_resolving_list_state_t;
956 
957 /**
958  * main data structure
959  */
960 typedef struct {
961     // transport component with configuration
962     const hci_transport_t * hci_transport;
963     const void            * config;
964 
965     // chipset driver
966     const btstack_chipset_t * chipset;
967 
968     // chipset driver requires pre-init
969     bool chipset_pre_init;
970 
971     // hardware power controller
972     const btstack_control_t * control;
973 
974 #ifdef ENABLE_CLASSIC
975     /* link key db */
976     const btstack_link_key_db_t * link_key_db;
977 #endif
978 
979     // list of existing baseband connections
980     btstack_linked_list_t     connections;
981 
982     /* callback to L2CAP layer */
983     btstack_packet_handler_t acl_packet_handler;
984 
985     /* callback for SCO data */
986     btstack_packet_handler_t sco_packet_handler;
987 
988     /* callbacks for events */
989     btstack_linked_list_t event_handlers;
990 
991 #ifdef ENABLE_CLASSIC
992     /* callback for reject classic connection */
993     int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type);
994 #endif
995 
996     // hardware error callback
997     void (*hardware_error_callback)(uint8_t error);
998 
999 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS
1000     /* callback for ISO data */
1001     btstack_packet_handler_t iso_packet_handler;
1002 
1003     /* fragmentation for ISO data */
1004     uint16_t  iso_fragmentation_pos;
1005     uint16_t  iso_fragmentation_total_size;
1006     bool      iso_fragmentation_tx_active;
1007 
1008     uint8_t   iso_packets_to_queue;
1009     // group id and type of active operation
1010     hci_iso_type_t iso_active_operation_type;
1011     uint8_t iso_active_operation_group_id;
1012 
1013     // list of iso streams
1014     btstack_linked_list_t iso_streams;
1015 
1016     // list of BIGs and BIG Syncs
1017     btstack_linked_list_t le_audio_bigs;
1018     btstack_linked_list_t le_audio_big_syncs;
1019 
1020     // list of CIGs
1021     btstack_linked_list_t le_audio_cigs;
1022 #endif
1023 
1024     // basic configuration
1025     const char *       local_name;
1026     const uint8_t *    eir_data;
1027     uint32_t           class_of_device;
1028     bd_addr_t          local_bd_addr;
1029     uint16_t           default_link_policy_settings;
1030     uint8_t            allow_role_switch;
1031     uint8_t            ssp_enable;
1032     uint8_t            ssp_io_capability;
1033     uint8_t            ssp_authentication_requirement;
1034     uint8_t            ssp_auto_accept;
1035     bool               secure_connections_enable;
1036     bool               secure_connections_active;
1037     inquiry_mode_t     inquiry_mode;
1038 
1039 #ifdef ENABLE_CLASSIC
1040     /* GAP tasks, see GAP_TASK_* */
1041     uint16_t           gap_tasks_classic;
1042 
1043     /* write page scan activity */
1044     uint16_t           new_page_scan_interval;
1045     uint16_t           new_page_scan_window;
1046 
1047     /* write page scan type */
1048     uint8_t            new_page_scan_type;
1049 
1050     /* write page timeout */
1051     uint16_t           page_timeout;
1052 
1053     // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default
1054     uint8_t            gap_required_encyrption_key_size;
1055 
1056     uint16_t           link_supervision_timeout;
1057     uint16_t           automatic_flush_timeout;
1058 
1059     gap_security_level_t gap_security_level;
1060     gap_security_level_t gap_minimal_service_security_level;
1061     gap_security_mode_t  gap_security_mode;
1062 
1063     uint32_t            inquiry_lap;      // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY
1064     uint16_t            inquiry_scan_interval;
1065     uint16_t            inquiry_scan_window;
1066 
1067     bool                gap_secure_connections_only_mode;
1068 #endif
1069 
1070     // single buffer for HCI packet assembly + additional prebuffer for H4 drivers
1071     uint8_t   * hci_packet_buffer;
1072     uint8_t   hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE];
1073     bool      hci_packet_buffer_reserved;
1074     uint16_t  acl_fragmentation_pos;
1075     uint16_t  acl_fragmentation_total_size;
1076     uint8_t   acl_fragmentation_tx_active;
1077 
1078     /* host to controller flow control */
1079     uint8_t  num_cmd_packets;
1080     uint8_t  acl_packets_total_num;
1081     uint16_t acl_data_packet_length;
1082     uint8_t  sco_packets_total_num;
1083     uint8_t  sco_data_packet_length;
1084     uint8_t  synchronous_flow_control_enabled;
1085     uint8_t  le_acl_packets_total_num;
1086     uint16_t le_data_packets_length;
1087     uint8_t  le_iso_packets_total_num;
1088     uint16_t le_iso_packets_length;
1089     uint8_t  sco_waiting_for_can_send_now;
1090     bool     sco_can_send_now;
1091 
1092     /* local supported features */
1093     uint8_t local_supported_features[8];
1094 
1095     /* local supported commands summary - complete info is 64 bytes */
1096     uint32_t local_supported_commands;
1097 
1098     /* bluetooth device information from hci read local version information */
1099     // uint16_t hci_version;
1100     // uint16_t hci_revision;
1101     // uint16_t lmp_version;
1102     uint16_t manufacturer;
1103     // uint16_t lmp_subversion;
1104 
1105     // usable ACL packet types given HCI_ACL_BUFFER_SIZE and local supported features
1106     uint16_t usable_packet_types_acl;
1107 
1108     // usable SCO packet types given local supported features
1109     uint16_t usable_packet_types_sco;
1110 
1111     /* hci state machine */
1112     HCI_STATE      state;
1113     hci_substate_t substate;
1114     btstack_timer_source_t timeout;
1115     btstack_chipset_result_t chipset_result;
1116 
1117     uint16_t  last_cmd_opcode;
1118 
1119     uint8_t   cmds_ready;
1120 
1121     /* buffer for scan enable cmd - 0xff no change */
1122     uint8_t   new_scan_enable_value;
1123 
1124     uint8_t   discoverable;
1125     uint8_t   connectable;
1126     uint8_t   bondable;
1127 
1128     uint8_t   inquiry_state;    // see hci.c for state defines
1129     uint16_t  inquiry_max_period_length;
1130     uint16_t  inquiry_min_period_length;
1131 
1132     bd_addr_t remote_name_addr;
1133     uint16_t  remote_name_clock_offset;
1134     uint8_t   remote_name_page_scan_repetition_mode;
1135     uint8_t   remote_name_state;    // see hci.c for state defines
1136 
1137     bd_addr_t gap_pairing_addr;
1138     uint8_t   gap_pairing_state;    // see hci.c for state defines
1139     uint8_t   gap_pairing_pin_len;
1140     union {
1141         const uint8_t * gap_pairing_pin;
1142         uint32_t     gap_pairing_passkey;
1143     } gap_pairing_input;
1144 
1145     uint16_t  sco_voice_setting;
1146     uint16_t  sco_voice_setting_active;
1147 
1148     uint8_t   loopback_mode;
1149 
1150     // buffer for single connection decline
1151     uint8_t   decline_reason;
1152     bd_addr_t decline_addr;
1153 
1154 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
1155     uint8_t   host_completed_packets;
1156 #endif
1157 
1158 #ifdef ENABLE_BLE
1159     uint8_t   le_own_addr_type;
1160     bd_addr_t le_random_address;
1161     uint8_t   le_random_address_set;
1162 
1163     // LE Whitelist Management
1164     uint8_t               le_whitelist_capacity;
1165     btstack_linked_list_t le_whitelist;
1166 
1167     // Connection parameters
1168     uint16_t le_connection_scan_interval;
1169     uint16_t le_connection_scan_window;
1170     uint16_t le_connection_interval_min;
1171     uint16_t le_connection_interval_max;
1172     uint16_t le_connection_latency;
1173     uint16_t le_supervision_timeout;
1174     uint16_t le_minimum_ce_length;
1175     uint16_t le_maximum_ce_length;
1176 #endif
1177 
1178 #ifdef ENABLE_LE_CENTRAL
1179     bool   le_scanning_enabled;
1180     bool   le_scanning_active;
1181 
1182     le_connecting_state_t le_connecting_state;
1183     le_connecting_state_t le_connecting_request;
1184 
1185     bool     le_scanning_param_update;
1186     uint8_t  le_scan_filter_duplicates;
1187     uint8_t  le_scan_type;
1188     uint8_t  le_scan_filter_policy;
1189     uint8_t  le_scan_phys;
1190     uint16_t le_scan_interval;
1191     uint16_t le_scan_window;
1192 
1193     uint8_t  le_connection_own_addr_type;
1194     uint8_t  le_connection_phys;
1195     bd_addr_t le_connection_own_address;
1196 
1197 #ifdef ENABLE_LE_EXTENDED_ADVERTISING
1198     btstack_linked_list_t le_periodic_advertiser_list;
1199     uint16_t        le_periodic_terminate_sync_handle;
1200 
1201     // Periodic Advertising Sync parameters
1202     uint8_t         le_periodic_sync_options;
1203     uint8_t         le_periodic_sync_advertising_sid;
1204     bd_addr_type_t  le_periodic_sync_advertiser_address_type;
1205     bd_addr_t       le_periodic_sync_advertiser_address;
1206     uint16_t        le_periodic_sync_skip;
1207     uint16_t        le_periodic_sync_timeout;
1208     uint8_t         le_periodic_sync_cte_type;
1209     le_connecting_state_t le_periodic_sync_state;
1210     le_connecting_state_t le_periodic_sync_request;
1211 
1212     // Periodic Advertising Sync Transfer (PAST)
1213     bool     le_past_set_default_params;
1214     uint8_t  le_past_mode;
1215     uint16_t le_past_skip;
1216     uint16_t le_past_sync_timeout;
1217     uint8_t  le_past_cte_type;
1218 #endif
1219 #endif
1220 
1221     le_connection_parameter_range_t le_connection_parameter_range;
1222 
1223     // TODO: move LE_ADVERTISEMENT_TASKS_SET_ADDRESS flag which is used for both roles into
1224     //  some generic gap_le variable
1225     uint8_t  le_advertisements_todo;
1226 
1227 #ifdef ENABLE_LE_PERIPHERAL
1228     uint8_t  * le_advertisements_data;
1229     uint8_t    le_advertisements_data_len;
1230 
1231     uint8_t  * le_scan_response_data;
1232     uint8_t    le_scan_response_data_len;
1233 
1234     uint16_t le_advertisements_interval_min;
1235     uint16_t le_advertisements_interval_max;
1236     uint8_t  le_advertisements_type;
1237     uint8_t  le_advertisements_direct_address_type;
1238     uint8_t  le_advertisements_channel_map;
1239     uint8_t  le_advertisements_filter_policy;
1240     bd_addr_t le_advertisements_direct_address;
1241     uint8_t   le_advertisements_own_addr_type;
1242     bd_addr_t le_advertisements_own_address;
1243 
1244     uint8_t  le_advertisements_state;
1245 
1246     bool     le_advertisements_enabled_for_current_roles;
1247     uint8_t le_max_number_peripheral_connections;
1248 
1249 #ifdef ENABLE_LE_EXTENDED_ADVERTISING
1250     btstack_linked_list_t le_advertising_sets;
1251     uint16_t le_maximum_advertising_data_length;
1252     uint8_t  le_advertising_set_in_current_command;
1253 #endif
1254 #endif
1255 
1256 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
1257     // LE Data Length
1258     uint16_t le_supported_max_tx_octets;
1259     uint16_t le_supported_max_tx_time;
1260 #endif
1261 
1262     // custom BD ADDR
1263     bd_addr_t custom_bd_addr;
1264     uint8_t   custom_bd_addr_set;
1265 
1266 #ifdef ENABLE_CLASSIC
1267     uint8_t master_slave_policy;
1268 #endif
1269 
1270     // address and address_type of active create connection command (ACL, SCO, LE)
1271     bd_addr_t      outgoing_addr;
1272     bd_addr_type_t outgoing_addr_type;
1273 
1274     // LE Resolving List
1275 #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION
1276     le_privacy_mode_t         le_privacy_mode;
1277     le_resolving_list_state_t le_resolving_list_state;
1278     uint16_t                  le_resolving_list_size;
1279     uint8_t                   le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8];
1280     uint8_t                   le_resolving_list_set_privacy_mode[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8];
1281 	uint8_t                   le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8];
1282 #endif
1283 
1284 #ifdef ENABLE_CLASSIC_PAIRING_OOB
1285 	bool                      classic_read_local_oob_data;
1286 	hci_con_handle_t          classic_oob_con_handle;
1287 #endif
1288 
1289 #ifdef HAVE_SCO_TRANSPORT
1290 	const btstack_sco_transport_t * sco_transport;
1291 #endif
1292 } hci_stack_t;
1293 
1294 
1295 /* API_START */
1296 
1297 
1298 // HCI init and configuration
1299 
1300 
1301 /**
1302  * @brief Set up HCI. Needs to be called before any other function.
1303  */
1304 void hci_init(const hci_transport_t *transport, const void *config);
1305 
1306 /**
1307  * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information.
1308  */
1309 void hci_set_chipset(const btstack_chipset_t *chipset_driver);
1310 
1311 /**
1312  * @brief Enable custom init for chipset driver to send HCI commands before HCI Reset
1313  */
1314 void hci_enable_custom_pre_init(void);
1315 
1316 /**
1317  * @brief Configure Bluetooth hardware control. Has to be called before power on.
1318  * @[aram hardware_control implementation
1319  */
1320 void hci_set_control(const btstack_control_t *hardware_control);
1321 
1322 #ifdef HAVE_SCO_TRANSPORT
1323 /**
1324  * @brief Set SCO Transport implementation for SCO over PCM mode
1325  * @param sco_transport that sends SCO over I2S or PCM interface
1326  */
1327 void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport);
1328 #endif
1329 
1330 #ifdef ENABLE_CLASSIC
1331 /**
1332  * @brief Configure Bluetooth hardware control. Has to be called before power on.
1333  */
1334 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db);
1335 #endif
1336 
1337 /**
1338  * @brief Set callback for Bluetooth Hardware Error
1339  */
1340 void hci_set_hardware_error_callback(void (*fn)(uint8_t error));
1341 
1342 /**
1343  * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h
1344  */
1345 void hci_set_bd_addr(bd_addr_t addr);
1346 
1347 /**
1348  * @brief Configure Voice Setting for use with SCO data in HSP/HFP
1349  */
1350 void hci_set_sco_voice_setting(uint16_t voice_setting);
1351 
1352 /**
1353  * @brief Get SCO Voice Setting
1354  * @return current voice setting
1355  */
1356 uint16_t hci_get_sco_voice_setting(void);
1357 
1358 /**
1359  * @brief Set number of ISO packets to buffer for BIS/CIS
1360  * @param num_packets (default = 1)
1361  */
1362 void hci_set_num_iso_packets_to_queue(uint8_t num_packets);
1363 
1364 /**
1365  * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on.
1366  * @param inquriy_mode see bluetooth_defines.h
1367  */
1368 void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode);
1369 
1370 /**
1371  * @brief Requests the change of BTstack power mode.
1372  * @param power_mode
1373  * @return 0 if success, otherwise error
1374  */
1375 int  hci_power_control(HCI_POWER_MODE power_mode);
1376 
1377 /**
1378  * @brief Shutdown HCI
1379  */
1380 void hci_close(void);
1381 
1382 
1383 // Callback registration
1384 
1385 
1386 /**
1387  * @brief Add event packet handler.
1388  */
1389 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler);
1390 
1391 /**
1392  * @brief Remove event packet handler.
1393  */
1394 void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler);
1395 
1396 /**
1397  * @brief Registers a packet handler for ACL data. Used by L2CAP
1398  */
1399 void hci_register_acl_packet_handler(btstack_packet_handler_t handler);
1400 
1401 /**
1402  * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles.
1403  */
1404 void hci_register_sco_packet_handler(btstack_packet_handler_t handler);
1405 
1406 /**
1407  * @brief Registers a packet handler for ISO data. Used for LE Audio profiles
1408  */
1409 void hci_register_iso_packet_handler(btstack_packet_handler_t handler);
1410 
1411 // Sending HCI Commands
1412 
1413 /**
1414  * @brief Check if CMD packet can be sent to controller
1415  * @return true if command can be sent
1416  */
1417 bool hci_can_send_command_packet_now(void);
1418 
1419 /**
1420  * @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.
1421  * @return status
1422  */
1423 uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...);
1424 
1425 
1426 // Sending SCO Packets
1427 
1428 /** @brief Get SCO packet length for current SCO Voice setting
1429  *  @note  Using SCO packets of the exact length is required for USB transfer
1430  *  @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header
1431  */
1432 uint16_t hci_get_sco_packet_length(void);
1433 
1434 /**
1435  * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible
1436  * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function
1437  *       so packet handler should be ready to handle it
1438  */
1439 void hci_request_sco_can_send_now_event(void);
1440 
1441 /**
1442  * @brief Check HCI packet buffer and if SCO packet can be sent to controller
1443  * @return true if sco packet can be sent
1444  */
1445 bool hci_can_send_sco_packet_now(void);
1446 
1447 /**
1448  * @brief Check if SCO packet can be sent to controller
1449  * @return true if sco packet can be sent
1450  */
1451 bool hci_can_send_prepared_sco_packet_now(void);
1452 
1453 /**
1454  * @brief Send SCO packet prepared in HCI packet buffer
1455  */
1456 uint8_t hci_send_sco_packet_buffer(int size);
1457 
1458 /**
1459  * @brief Request emission of HCI_EVENT_BIS_CAN_SEND_NOW for all BIS as soon as possible
1460  * @param big_handle
1461  * @note HCI_EVENT_ISO_CAN_SEND_NOW might be emitted during call to this function
1462  *       so packet handler should be ready to handle it
1463  */
1464 uint8_t hci_request_bis_can_send_now_events(uint8_t big_handle);
1465 
1466 /**
1467  * @brief Request emission of HCI_EVENT_CIS_CAN_SEND_NOW for CIS as soon as possible
1468  * @param cis_con_handle
1469  * @note HCI_EVENT_CIS_CAN_SEND_NOW might be emitted during call to this function
1470  *       so packet handler should be ready to handle it
1471  */
1472 uint8_t hci_request_cis_can_send_now_events(hci_con_handle_t cis_con_handle);
1473 
1474 /**
1475  * @brief Send ISO packet prepared in HCI packet buffer
1476  */
1477 uint8_t hci_send_iso_packet_buffer(uint16_t size);
1478 
1479 /**
1480  * Reserves outgoing packet buffer.
1481  * @return true on success
1482  */
1483 bool hci_reserve_packet_buffer(void);
1484 
1485 /**
1486  * Get pointer for outgoing packet buffer
1487  */
1488 uint8_t* hci_get_outgoing_packet_buffer(void);
1489 
1490 /**
1491  * Release outgoing packet buffer\
1492  * @note only called instead of hci_send_preparared
1493  */
1494 void hci_release_packet_buffer(void);
1495 
1496 /**
1497 * @brief Sets the master/slave policy
1498 * @param policy (0: attempt to become master, 1: let connecting device decide)
1499 */
1500 void hci_set_master_slave_policy(uint8_t policy);
1501 
1502 /* API_END */
1503 
1504 
1505 /**
1506  * va_list version of hci_send_cmd, call hci_send_cmd_packet
1507  * @return status
1508  */
1509 uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr);
1510 
1511 /**
1512  * Get connection iterator. Only used by l2cap.c and sm.c
1513  */
1514 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it);
1515 
1516 /**
1517  * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon
1518  */
1519 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle);
1520 
1521 /**
1522  * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP
1523  */
1524 hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type);
1525 
1526 /**
1527  * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c
1528  * @return true if packet buffer is reserved
1529  */
1530 bool hci_is_packet_buffer_reserved(void);
1531 
1532 /**
1533  * Check hci packet buffer is free and a classic acl packet can be sent to controller
1534  * @return true if ACL Classic packet can be sent now
1535  */
1536 bool hci_can_send_acl_classic_packet_now(void);
1537 
1538 /**
1539  * Check hci packet buffer is free and an LE acl packet can be sent to controller
1540  * @return true if ACL LE packet can be sent now
1541  */
1542 bool hci_can_send_acl_le_packet_now(void);
1543 
1544 /**
1545  * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller
1546  * @return true if ACL packet for con_handle can be sent now
1547  */
1548 bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle);
1549 
1550 /**
1551  * Check if acl packet for the given handle can be sent to controller
1552  * @return true if ACL packet for con_handle can be sent now
1553  */
1554 bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle);
1555 
1556 /**
1557  * Send acl packet prepared in hci packet buffer
1558  * @return status
1559  */
1560 uint8_t hci_send_acl_packet_buffer(int size);
1561 
1562 /**
1563  * Check if authentication is active. It delays automatic disconnect while no L2CAP connection
1564  * Called by l2cap.
1565  */
1566 bool hci_authentication_active_for_handle(hci_con_handle_t handle);
1567 
1568 /**
1569  * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP
1570  */
1571 uint16_t hci_max_acl_data_packet_length(void);
1572 
1573 /**
1574  * Get supported ACL packet types. Already flipped for create connection. Called by L2CAP
1575  */
1576 uint16_t hci_usable_acl_packet_types(void);
1577 
1578 /**
1579  * Get supported SCO packet types. Not flipped. Called by HFP
1580   */
1581 uint16_t hci_usable_sco_packet_types(void);
1582 
1583 /**
1584  * Check if ACL packets marked as non flushable can be sent. Called by L2CAP
1585  */
1586 bool hci_non_flushable_packet_boundary_flag_supported(void);
1587 
1588 /**
1589  * Return current automatic flush timeout setting
1590  */
1591 uint16_t hci_automatic_flush_timeout(void);
1592 
1593 /**
1594  * Check if remote supported features query has completed
1595  */
1596 bool hci_remote_features_available(hci_con_handle_t con_handle);
1597 
1598 /**
1599  * Trigger remote supported features query
1600  */
1601 void hci_remote_features_query(hci_con_handle_t con_handle);
1602 
1603 /**
1604  * Check if extended SCO Link is supported
1605  */
1606 bool hci_extended_sco_link_supported(void);
1607 
1608 /**
1609  * Check if SSP is supported on both sides. Called by L2CAP
1610  */
1611 bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle);
1612 
1613 /**
1614  * Disconn because of security block. Called by L2CAP
1615  */
1616 void hci_disconnect_security_block(hci_con_handle_t con_handle);
1617 
1618 /**
1619  * Query if remote side supports eSCO
1620  * @param con_handle
1621  */
1622 bool hci_remote_esco_supported(hci_con_handle_t con_handle);
1623 
1624 /**
1625  * Query remote supported SCO packets based on remote supported features
1626  * @param con_handle
1627  */
1628 uint16_t hci_remote_sco_packet_types(hci_con_handle_t con_handle);
1629 
1630 /**
1631  * Emit current HCI state. Called by daemon
1632  */
1633 void hci_emit_state(void);
1634 
1635 /**
1636  * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg
1637  * @return status
1638  */
1639 uint8_t hci_send_cmd_packet(uint8_t *packet, int size);
1640 
1641 /**
1642  * Disconnect all HCI connections. Called by daemon
1643  */
1644 void hci_disconnect_all(void);
1645 
1646 /**
1647  * Get number of free acl slots for packets of given handle. Called by daemon
1648  */
1649 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle);
1650 
1651 /**
1652  * @brief Set Advertisement Parameters
1653  * @param adv_int_min
1654  * @param adv_int_max
1655  * @param adv_type
1656  * @param direct_address_type
1657  * @param direct_address
1658  * @param channel_map
1659  * @param filter_policy
1660  *
1661  * @note internal use. use gap_advertisements_set_params from gap.h instead.
1662  */
1663 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type,
1664     uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy);
1665 
1666 /**
1667  *
1668  * @note internal use. use gap_random_address_set_mode from gap.h instead.
1669  */
1670 void hci_le_set_own_address_type(uint8_t own_address_type);
1671 
1672 /**
1673  * @naote internal use. use gap_random_address_set from gap.h instead
1674  */
1675 void hci_le_random_address_set(const bd_addr_t random_address);
1676 
1677 /**
1678  * @note internal use by sm
1679  */
1680 void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index);
1681 
1682 /**
1683  * @note internal use by sm
1684  */
1685 void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index);
1686 
1687 /**
1688  * @note internal use
1689  */
1690 uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type);
1691 
1692 /**
1693  * @brief Clear Periodic Advertiser List
1694  * @return status
1695  */
1696 uint8_t gap_periodic_advertiser_list_clear(void);
1697 
1698 /**
1699  * @brief Add entry to Periodic Advertiser List
1700  * @param address_type
1701  * @param address
1702  * @param advertising_sid
1703  * @return
1704  */
1705 uint8_t gap_periodic_advertiser_list_add(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid);
1706 
1707 /**
1708  * Remove entry from Periodic Advertising List
1709  * @param address_type
1710  * @param address
1711  * @param advertising_sid
1712  * @return
1713  */
1714 uint8_t gap_periodic_advertiser_list_remove(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid);
1715 
1716 /**
1717  * @brief Synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.
1718  * @param options
1719  * @param advertising_sid
1720  * @param advertiser_address_type
1721  * @param advertiser_address
1722  * @param skip
1723  * @param sync_timeout
1724  * @param sync_cte_type
1725  * @return
1726  */
1727 uint8_t gap_periodic_advertising_create_sync(uint8_t options, uint8_t advertising_sid, bd_addr_type_t advertiser_address_type,
1728                                              bd_addr_t advertiser_address, uint16_t skip, uint16_t sync_timeout, uint8_t sync_cte_type);
1729 
1730 /**
1731  * @brief Cancel sync periodic advertising train while it is pending.
1732  * @return status
1733  */
1734 uint8_t gap_periodic_advertising_create_sync_cancel(void);
1735 
1736 /**
1737  * @biref Stop reception of the periodic advertising train
1738  * @param sync_handle
1739  * @return status
1740  */
1741 uint8_t gap_periodic_advertising_terminate_sync(uint16_t sync_handle);
1742 
1743 /**
1744  * @brief Get Controller Manufacturer
1745  * @returns company_id - see bluetooth_company_id.h
1746  */
1747 uint16_t hci_get_manufacturer(void);
1748 
1749 /**
1750  *  Get Classic Allow Role Switch param
1751  */
1752 uint8_t hci_get_allow_role_switch(void);
1753 
1754 /**
1755  * Get state
1756  */
1757 HCI_STATE hci_get_state(void);
1758 
1759 /**
1760  * @brief De-Init HCI
1761  */
1762 void hci_deinit(void);
1763 
1764 // defer disconnect on dedicated bonding complete, used internally for CTKD
1765 uint8_t hci_dedicated_bonding_defer_disconnect(hci_con_handle_t con_handle, bool defer);
1766 
1767 // Only for PTS testing
1768 
1769 // Disable automatic L2CAP disconnect if no L2CAP connection is established
1770 void hci_disable_l2cap_timeout_check(void);
1771 
1772 // setup test connections, used for fuzzing
1773 void hci_setup_test_connections_fuzz(void);
1774 
1775 // free all connections, used for fuzzing
1776 void hci_free_connections_fuzz(void);
1777 
1778 // simulate stack bootup
1779 void hci_simulate_working_fuzz(void);
1780 
1781 
1782 #if defined __cplusplus
1783 }
1784 #endif
1785 
1786 #endif // HCI_H
1787