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