xref: /btstack/src/hci.h (revision dbca66ff5b7d5d6c4b8a34e88f8c8497a15a22f5)
11f504dbdSmatthias.ringwald /*
2a0c35809S[email protected]  * Copyright (C) 2014 BlueKitchen GmbH
31713bceaSmatthias.ringwald  *
41713bceaSmatthias.ringwald  * Redistribution and use in source and binary forms, with or without
51713bceaSmatthias.ringwald  * modification, are permitted provided that the following conditions
61713bceaSmatthias.ringwald  * are met:
71713bceaSmatthias.ringwald  *
81713bceaSmatthias.ringwald  * 1. Redistributions of source code must retain the above copyright
91713bceaSmatthias.ringwald  *    notice, this list of conditions and the following disclaimer.
101713bceaSmatthias.ringwald  * 2. Redistributions in binary form must reproduce the above copyright
111713bceaSmatthias.ringwald  *    notice, this list of conditions and the following disclaimer in the
121713bceaSmatthias.ringwald  *    documentation and/or other materials provided with the distribution.
131713bceaSmatthias.ringwald  * 3. Neither the name of the copyright holders nor the names of
141713bceaSmatthias.ringwald  *    contributors may be used to endorse or promote products derived
151713bceaSmatthias.ringwald  *    from this software without specific prior written permission.
166b64433eSmatthias.ringwald  * 4. Any redistribution, use, or modification is done solely for
176b64433eSmatthias.ringwald  *    personal benefit and not for any commercial purpose or for
186b64433eSmatthias.ringwald  *    monetary gain.
191713bceaSmatthias.ringwald  *
20a0c35809S[email protected]  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
211713bceaSmatthias.ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
221713bceaSmatthias.ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
232fca4dadSMilanka Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
242fca4dadSMilanka Ringwald  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
251713bceaSmatthias.ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
261713bceaSmatthias.ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
271713bceaSmatthias.ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
281713bceaSmatthias.ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
291713bceaSmatthias.ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
301713bceaSmatthias.ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
311713bceaSmatthias.ringwald  * SUCH DAMAGE.
321713bceaSmatthias.ringwald  *
33a0c35809S[email protected]  * Please inquire about commercial licensing options at
34a0c35809S[email protected]  * [email protected]
356b64433eSmatthias.ringwald  *
361713bceaSmatthias.ringwald  */
371713bceaSmatthias.ringwald 
38fe5a6c4eSMilanka Ringwald /**
39fe5a6c4eSMilanka Ringwald  * @title Host Controler Interface (HCI)
401f504dbdSmatthias.ringwald  *
411f504dbdSmatthias.ringwald  */
421f504dbdSmatthias.ringwald 
4380e33422SMatthias Ringwald #ifndef HCI_H
4480e33422SMatthias Ringwald #define HCI_H
451f504dbdSmatthias.ringwald 
467907f069SMatthias Ringwald #include "btstack_config.h"
4736a5e735Smatthias.ringwald 
483fb36a29SMatthias Ringwald #include "btstack_chipset.h"
49af3c1ffeSMatthias Ringwald #include "btstack_control.h"
503fb36a29SMatthias Ringwald #include "btstack_linked_list.h"
513fb36a29SMatthias Ringwald #include "btstack_util.h"
5256042629SMatthias Ringwald #include "hci_cmd.h"
538974fcd6SMatthias Ringwald #include "gap.h"
543edc84c5SMatthias Ringwald #include "hci_transport.h"
55f1f3f303SMatthias Ringwald #include "btstack_run_loop.h"
56ba681a6cSmatthias.ringwald 
578fd3cd58SMatthias Ringwald #ifdef ENABLE_CLASSIC
588fd3cd58SMatthias Ringwald #include "classic/btstack_link_key_db.h"
598fd3cd58SMatthias Ringwald #endif
608fd3cd58SMatthias Ringwald 
6118707219SMatthias Ringwald #ifdef ENABLE_BLE
6218707219SMatthias Ringwald #include "ble/att_db.h"
6318707219SMatthias Ringwald #endif
6418707219SMatthias Ringwald 
65cb70c5abSMatthias Ringwald #ifdef HAVE_SCO_TRANSPORT
66cb70c5abSMatthias Ringwald #include "btstack_sco_transport.h"
67cb70c5abSMatthias Ringwald #endif
68cb70c5abSMatthias Ringwald 
6993b8dc03Smatthias.ringwald #include <stdint.h>
7002ea9861Smatthias.ringwald #include <stdlib.h>
711cd208adSmatthias.ringwald #include <stdarg.h>
7293b8dc03Smatthias.ringwald 
73e3b6fe7eSmatthias.ringwald #if defined __cplusplus
74e3b6fe7eSmatthias.ringwald extern "C" {
75e3b6fe7eSmatthias.ringwald #endif
76e3b6fe7eSmatthias.ringwald 
7736a5e735Smatthias.ringwald // packet buffer sizes
786ffe3f3eSMatthias Ringwald #define HCI_CMD_HEADER_SIZE          3
796ffe3f3eSMatthias Ringwald #define HCI_ACL_HEADER_SIZE          4
806ffe3f3eSMatthias Ringwald #define HCI_SCO_HEADER_SIZE          3
816ffe3f3eSMatthias Ringwald #define HCI_EVENT_HEADER_SIZE        2
826ffe3f3eSMatthias Ringwald 
836ffe3f3eSMatthias Ringwald #define HCI_EVENT_PAYLOAD_SIZE     255
846ffe3f3eSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE       255
85f9f2075cSMatthias Ringwald 
86fcae305fSMatthias Ringwald // Max HCI Command LE payload size:
87f9f2075cSMatthias Ringwald // 64 from LE Generate DHKey command
88f9f2075cSMatthias Ringwald // 32 from LE Encrypt command
89fcae305fSMatthias Ringwald #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS)
90f9f2075cSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE_LE 64
91f9f2075cSMatthias Ringwald #else
92f9f2075cSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE_LE 32
93f9f2075cSMatthias Ringwald #endif
94f9f2075cSMatthias Ringwald 
9536a5e735Smatthias.ringwald // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h
96a1ffb867SMatthias Ringwald // addition byte in even to terminate remote name request with '\0'
97a1ffb867SMatthias Ringwald #define HCI_EVENT_BUFFER_SIZE      (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1)
98f9f2075cSMatthias Ringwald 
99f9f2075cSMatthias Ringwald #ifdef ENABLE_CLASSIC
10036a5e735Smatthias.ringwald #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE)
101f9f2075cSMatthias Ringwald #else
102f9f2075cSMatthias Ringwald #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE_LE)
103f9f2075cSMatthias Ringwald #endif
104f9f2075cSMatthias Ringwald 
10536a5e735Smatthias.ringwald #define HCI_ACL_BUFFER_SIZE        (HCI_ACL_HEADER_SIZE   + HCI_ACL_PAYLOAD_SIZE)
10636a5e735Smatthias.ringwald 
107fc6cde64SMatthias Ringwald // size of hci incoming buffer, big enough for event or acl packet without H4 packet type
108fc6cde64SMatthias Ringwald #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE
109fc6cde64SMatthias Ringwald     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
110fc6cde64SMatthias Ringwald         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
11125c5e985S[email protected]     #endif
112fc6cde64SMatthias Ringwald     #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE
113fc6cde64SMatthias Ringwald         #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE
114fc6cde64SMatthias Ringwald     #endif
115fc6cde64SMatthias Ringwald #else
116fc6cde64SMatthias Ringwald     #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE
117fc6cde64SMatthias Ringwald         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
118fc6cde64SMatthias Ringwald     #else
119fc6cde64SMatthias Ringwald         #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE
120fc6cde64SMatthias Ringwald     #endif
121fc6cde64SMatthias Ringwald #endif
122fc6cde64SMatthias Ringwald 
123fc6cde64SMatthias Ringwald // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type
124fc6cde64SMatthias Ringwald #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE
125fc6cde64SMatthias Ringwald     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
126fc6cde64SMatthias Ringwald         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
127fc6cde64SMatthias Ringwald     #endif
128fc6cde64SMatthias Ringwald     #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE
129fc6cde64SMatthias Ringwald         #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE
13025c5e985S[email protected]     #endif
13125c5e985S[email protected] #else
13236a5e735Smatthias.ringwald     #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE
133fc6cde64SMatthias Ringwald         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
13436a5e735Smatthias.ringwald     #else
135fc6cde64SMatthias Ringwald         #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE
13636a5e735Smatthias.ringwald     #endif
13723ac0743Smatthias.ringwald #endif
13828c93ceeSmatthias.ringwald 
139c6602a61SMatthias Ringwald // additional pre-buffer space for packets to Bluetooth module
140c6602a61SMatthias Ringwald // - H4 requires 1 byte for the packet type
141c6602a61SMatthias Ringwald // - h5 requires 4 bytes for H5 header
1424ccd6018SAustin Morton #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE
143689a7eb9SMatthias Ringwald     #ifdef HAVE_HOST_CONTROLLER_API
144689a7eb9SMatthias Ringwald         #define HCI_OUTGOING_PRE_BUFFER_SIZE 0
145689a7eb9SMatthias Ringwald     #else
146c6602a61SMatthias Ringwald         #ifdef ENABLE_H5
147c6602a61SMatthias Ringwald             #define HCI_OUTGOING_PRE_BUFFER_SIZE 4
148c6602a61SMatthias Ringwald         #else
14960da618dS[email protected]             #define HCI_OUTGOING_PRE_BUFFER_SIZE 1
150689a7eb9SMatthias Ringwald         #endif
1514ccd6018SAustin Morton     #endif
152c6602a61SMatthias Ringwald #endif
15360da618dS[email protected] 
154dfa951b1SMatthias Ringwald // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads
155b34233c3S[email protected] #ifndef HCI_INCOMING_PRE_BUFFER_SIZE
156689a7eb9SMatthias Ringwald #ifdef ENABLE_CLASSIC
157f2e45468SMatthias Ringwald #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4)
158689a7eb9SMatthias Ringwald #else
159dfa951b1SMatthias Ringwald #define HCI_INCOMING_PRE_BUFFER_SIZE 2
160689a7eb9SMatthias Ringwald #endif
161b34233c3S[email protected] #endif
162b34233c3S[email protected] 
16380d52d6bSmatthias.ringwald //
164f8fbdce0SMatthias Ringwald #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode )
16580d52d6bSmatthias.ringwald 
166caed94dfSMatthias Ringwald // check if command complete event for given command
1675df9dc78SMatthias Ringwald #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) )
1685df9dc78SMatthias Ringwald #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd)   ( (event[0] == HCI_EVENT_COMMAND_STATUS)   && (little_endian_read_16(event,4) == cmd.opcode) )
169caed94dfSMatthias Ringwald 
170caed94dfSMatthias Ringwald // Code+Len=2, Pkts+Opcode=3; total=5
171caed94dfSMatthias Ringwald #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5
172caed94dfSMatthias Ringwald 
173caed94dfSMatthias Ringwald // ACL Packet
174caed94dfSMatthias Ringwald #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
1752b838201SMatthias Ringwald #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff)
176caed94dfSMatthias Ringwald #define READ_ACL_FLAGS( buffer )      ( buffer[1] >> 4 )
177caed94dfSMatthias Ringwald #define READ_ACL_LENGTH( buffer )     (little_endian_read_16(buffer, 2))
178caed94dfSMatthias Ringwald 
179caed94dfSMatthias Ringwald // Sneak peak into L2CAP Packet
180caed94dfSMatthias Ringwald #define READ_L2CAP_LENGTH(buffer)     ( little_endian_read_16(buffer, 4))
181caed94dfSMatthias Ringwald #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6))
182caed94dfSMatthias Ringwald 
18306b35ec0Smatthias.ringwald /**
184da886c03S[email protected]  * LE connection parameter update state
185da886c03S[email protected]  */
186da886c03S[email protected] 
187da886c03S[email protected] typedef enum {
188da886c03S[email protected]     CON_PARAMETER_UPDATE_NONE,
18973cd8a2aSMatthias Ringwald     // L2CAP
190b68d7bc3SMatthias Ringwald     CON_PARAMETER_UPDATE_SEND_REQUEST,
191da886c03S[email protected]     CON_PARAMETER_UPDATE_SEND_RESPONSE,
192da886c03S[email protected]     CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS,
19373cd8a2aSMatthias Ringwald     CON_PARAMETER_UPDATE_DENY,
19473cd8a2aSMatthias Ringwald     // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST
19573cd8a2aSMatthias Ringwald     CON_PARAMETER_UPDATE_REPLY,
19673cd8a2aSMatthias Ringwald     CON_PARAMETER_UPDATE_NEGATIVE_REPLY,
197da886c03S[email protected] } le_con_parameter_update_state_t;
198da886c03S[email protected] 
1990414dabdS[email protected] // Authentication flags
200c01e9cbdSmatthias.ringwald typedef enum {
2018daf94bcSMatthias Ringwald     AUTH_FLAG_NONE                                = 0x0000,
202b54464caSMatthias Ringwald     AUTH_FLAG_HANDLE_LINK_KEY_REQUEST             = 0x0001,
203b54464caSMatthias Ringwald     AUTH_FLAG_DENY_PIN_CODE_REQUEST               = 0x0002,
2046a43ec02SMatthias Ringwald     AUTH_FLAG_RECV_IO_CAPABILITIES_REQUEST        = 0x0004,
2056a43ec02SMatthias Ringwald     AUTH_FLAG_RECV_IO_CAPABILITIES_RESPONSE       = 0x0008,
2066a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_IO_CAPABILITIES_REPLY          = 0x0010,
2076a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_IO_CAPABILITIES_NEGATIVE_REPLY = 0x0020,
2086a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_USER_CONFIRM_REPLY             = 0x0040,
2096a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_USER_CONFIRM_NEGATIVE_REPLY    = 0x0080,
2106a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_USER_PASSKEY_REPLY             = 0x0100,
2116724cd9eS[email protected] 
2121849becdSMatthias Ringwald     // Classic OOB
2136a43ec02SMatthias Ringwald     AUTH_FLAG_SEND_REMOTE_OOB_DATA_REPLY          = 0x0200,
2141849becdSMatthias Ringwald 
2156724cd9eS[email protected]     // pairing status
2166a43ec02SMatthias Ringwald     AUTH_FLAG_LEGACY_PAIRING_ACTIVE               = 0x0400,
2176a43ec02SMatthias Ringwald     AUTH_FLAG_SSP_PAIRING_ACTIVE                  = 0x0800,
2188daf94bcSMatthias Ringwald     AUTH_FLAG_PAIRING_ACTIVE_MASK                 = (AUTH_FLAG_LEGACY_PAIRING_ACTIVE | AUTH_FLAG_SSP_PAIRING_ACTIVE),
219536f9994S[email protected] 
220f0944df2S[email protected]     // connection status
2216a43ec02SMatthias Ringwald     AUTH_FLAG_CONNECTION_AUTHENTICATED            = 0x1000,
2226a43ec02SMatthias Ringwald     AUTH_FLAG_CONNECTION_ENCRYPTED                = 0x2000,
223891b9fc2SMatthias Ringwald 
2247fde4af9Smatthias.ringwald } hci_authentication_flags_t;
225c01e9cbdSmatthias.ringwald 
2269afaa4d4SMatthias Ringwald // GAP Connection Tasks
2279afaa4d4SMatthias Ringwald #define GAP_CONNECTION_TASK_WRITE_AUTOMATIC_FLUSH_TIMEOUT 0x0001u
22822df2fe2SMatthias Ringwald #define GAP_CONNECTION_TASK_WRITE_SUPERVISION_TIMEOUT     0x0002u
22922df2fe2SMatthias Ringwald #define GAP_CONNECTION_TASK_READ_RSSI                     0x0004u
2309afaa4d4SMatthias Ringwald 
2310414dabdS[email protected] /**
2320414dabdS[email protected]  * Connection State
2330414dabdS[email protected]  */
234c8e4258aSmatthias.ringwald typedef enum {
235ad83dc6aS[email protected]     SEND_CREATE_CONNECTION = 0,
236ad83dc6aS[email protected]     SENT_CREATE_CONNECTION,
2370bf6344aS[email protected]     SEND_CANCEL_CONNECTION,
2380bf6344aS[email protected]     SENT_CANCEL_CONNECTION,
239c8e4258aSmatthias.ringwald     RECEIVED_CONNECTION_REQUEST,
240c8e4258aSmatthias.ringwald     ACCEPTED_CONNECTION_REQUEST,
241c8e4258aSmatthias.ringwald     REJECTED_CONNECTION_REQUEST,
242c8e4258aSmatthias.ringwald     OPEN,
2435917a5c5S[email protected]     SEND_DISCONNECT,
244ccda6e14S[email protected]     SENT_DISCONNECT,
245ccda6e14S[email protected]     RECEIVED_DISCONNECTION_COMPLETE
246c8e4258aSmatthias.ringwald } CONNECTION_STATE;
247c8e4258aSmatthias.ringwald 
2480414dabdS[email protected] // bonding flags
2490414dabdS[email protected] enum {
250461a2bc4SMatthias Ringwald     // remote features
251461a2bc4SMatthias Ringwald     BONDING_REMOTE_FEATURES_QUERY_ACTIVE      =  0x0001,
252461a2bc4SMatthias Ringwald     BONDING_REQUEST_REMOTE_FEATURES_PAGE_0    =  0x0002,
253461a2bc4SMatthias Ringwald     BONDING_REQUEST_REMOTE_FEATURES_PAGE_1    =  0x0004,
254461a2bc4SMatthias Ringwald     BONDING_REQUEST_REMOTE_FEATURES_PAGE_2    =  0x0008,
255461a2bc4SMatthias Ringwald     BONDING_RECEIVED_REMOTE_FEATURES          =  0x0010,
256461a2bc4SMatthias Ringwald     BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER    =  0x0020,
257461a2bc4SMatthias Ringwald     BONDING_REMOTE_SUPPORTS_SSP_HOST          =  0x0040,
258461a2bc4SMatthias Ringwald     BONDING_REMOTE_SUPPORTS_SC_CONTROLLER     =  0x0080,
259461a2bc4SMatthias Ringwald     BONDING_REMOTE_SUPPORTS_SC_HOST           =  0x0100,
260461a2bc4SMatthias Ringwald     // other
261461a2bc4SMatthias Ringwald     BONDING_DISCONNECT_SECURITY_BLOCK         =  0x0200,
262461a2bc4SMatthias Ringwald     BONDING_DISCONNECT_DEDICATED_DONE         =  0x0400,
263461a2bc4SMatthias Ringwald     BONDING_SEND_AUTHENTICATE_REQUEST         =  0x0800,
264461a2bc4SMatthias Ringwald     BONDING_SENT_AUTHENTICATE_REQUEST         =  0x1000,
265461a2bc4SMatthias Ringwald     BONDING_SEND_ENCRYPTION_REQUEST           =  0x2000,
266461a2bc4SMatthias Ringwald     BONDING_SEND_READ_ENCRYPTION_KEY_SIZE     =  0x4000,
267461a2bc4SMatthias Ringwald     BONDING_DEDICATED                         =  0x8000,
268461a2bc4SMatthias Ringwald     BONDING_EMIT_COMPLETE_ON_DISCONNECT       = 0x10000,
2690414dabdS[email protected] };
270afd4e962S[email protected] 
271afd4e962S[email protected] typedef enum {
27243bfb1bdSmatthias.ringwald     BLUETOOTH_OFF = 1,
27343bfb1bdSmatthias.ringwald     BLUETOOTH_ON,
27443bfb1bdSmatthias.ringwald     BLUETOOTH_ACTIVE
27543bfb1bdSmatthias.ringwald } BLUETOOTH_STATE;
27643bfb1bdSmatthias.ringwald 
277b04dfa37SMatthias Ringwald typedef enum {
278b04dfa37SMatthias Ringwald     LE_CONNECTING_IDLE,
2796ea9315cSMatthias Ringwald     LE_CONNECTING_CANCEL,
280b04dfa37SMatthias Ringwald     LE_CONNECTING_DIRECT,
281b04dfa37SMatthias Ringwald     LE_CONNECTING_WHITELIST,
282b04dfa37SMatthias Ringwald } le_connecting_state_t;
283b04dfa37SMatthias Ringwald 
2843a6673b6SMatthias Ringwald #ifdef ENABLE_BLE
2853a6673b6SMatthias Ringwald 
28695d04d44S[email protected] //
28795d04d44S[email protected] // SM internal types and globals
28895d04d44S[email protected] //
28995d04d44S[email protected] 
29095d04d44S[email protected] typedef enum {
29195d04d44S[email protected] 
29295d04d44S[email protected]     // general states
29395d04d44S[email protected]     SM_GENERAL_IDLE,
29495d04d44S[email protected]     SM_GENERAL_SEND_PAIRING_FAILED,
29595d04d44S[email protected]     SM_GENERAL_TIMEOUT, // no other security messages are exchanged
29641ce31d9SMatthias Ringwald     SM_GENERAL_REENCRYPTION_FAILED,
29795d04d44S[email protected] 
29895d04d44S[email protected]     // Phase 1: Pairing Feature Exchange
29995d04d44S[email protected]     SM_PH1_W4_USER_RESPONSE,
30095d04d44S[email protected] 
30195d04d44S[email protected]     // Phase 2: Authenticating and Encrypting
30295d04d44S[email protected] 
30395d04d44S[email protected]     // get random number for use as TK Passkey if we show it
30495d04d44S[email protected]     SM_PH2_GET_RANDOM_TK,
30595d04d44S[email protected]     SM_PH2_W4_RANDOM_TK,
30695d04d44S[email protected] 
30795d04d44S[email protected]     // get local random number for confirm c1
30895d04d44S[email protected]     SM_PH2_C1_GET_RANDOM_A,
30995d04d44S[email protected]     SM_PH2_C1_W4_RANDOM_A,
31095d04d44S[email protected]     SM_PH2_C1_GET_RANDOM_B,
31195d04d44S[email protected]     SM_PH2_C1_W4_RANDOM_B,
31295d04d44S[email protected] 
31395d04d44S[email protected]     // calculate confirm value for local side
31495d04d44S[email protected]     SM_PH2_C1_GET_ENC_A,
31595d04d44S[email protected]     SM_PH2_C1_W4_ENC_A,
31695d04d44S[email protected] 
31795d04d44S[email protected]     // calculate confirm value for remote side
31895d04d44S[email protected]     SM_PH2_C1_GET_ENC_C,
31995d04d44S[email protected]     SM_PH2_C1_W4_ENC_C,
32095d04d44S[email protected] 
32195d04d44S[email protected]     SM_PH2_C1_SEND_PAIRING_CONFIRM,
32295d04d44S[email protected]     SM_PH2_SEND_PAIRING_RANDOM,
32395d04d44S[email protected] 
32495d04d44S[email protected]     // calc STK
32595d04d44S[email protected]     SM_PH2_CALC_STK,
32695d04d44S[email protected]     SM_PH2_W4_STK,
32795d04d44S[email protected] 
32895d04d44S[email protected]     SM_PH2_W4_CONNECTION_ENCRYPTED,
32995d04d44S[email protected] 
33095d04d44S[email protected]     // Phase 3: Transport Specific Key Distribution
33195d04d44S[email protected]     // calculate DHK, Y, EDIV, and LTK
33295d04d44S[email protected]     SM_PH3_Y_GET_ENC,
33395d04d44S[email protected]     SM_PH3_Y_W4_ENC,
33495d04d44S[email protected]     SM_PH3_LTK_GET_ENC,
33595d04d44S[email protected] 
33695d04d44S[email protected]     // exchange keys
33795d04d44S[email protected]     SM_PH3_DISTRIBUTE_KEYS,
33895d04d44S[email protected]     SM_PH3_RECEIVE_KEYS,
33995d04d44S[email protected] 
3405567aa60SMatthias Ringwald     // Phase 4: re-establish previously distributed LTK
3415567aa60SMatthias Ringwald     SM_PH4_W4_CONNECTION_ENCRYPTED,
3425567aa60SMatthias Ringwald 
34395d04d44S[email protected]     // RESPONDER ROLE
344d7119506SMatthias Ringwald     SM_RESPONDER_IDLE,
34595d04d44S[email protected]     SM_RESPONDER_SEND_SECURITY_REQUEST,
34659066796SMatthias Ringwald     SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST,
3476c39055aSMatthias Ringwald     SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK,
3489ec080fdS[email protected]     SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY,
34995d04d44S[email protected]     SM_RESPONDER_PH1_W4_PAIRING_REQUEST,
350477200f2S[email protected]     SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED,
351212d735eSMatthias Ringwald     SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED_W4_IRK,
35295d04d44S[email protected]     SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE,
35395d04d44S[email protected]     SM_RESPONDER_PH1_W4_PAIRING_CONFIRM,
35495d04d44S[email protected]     SM_RESPONDER_PH2_W4_PAIRING_RANDOM,
35595d04d44S[email protected]     SM_RESPONDER_PH2_W4_LTK_REQUEST,
35695d04d44S[email protected]     SM_RESPONDER_PH2_SEND_LTK_REPLY,
3570db5c26bSMatthias Ringwald     SM_RESPONDER_PH4_Y_W4_ENC,
358d7471931SMatthias Ringwald     SM_RESPONDER_PH4_SEND_LTK_REPLY,
3590db5c26bSMatthias Ringwald 
3605567aa60SMatthias Ringwald     // INITIATOR ROLE
36195d04d44S[email protected]     SM_INITIATOR_CONNECTED,
362477200f2S[email protected]     SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST,
36395d04d44S[email protected]     SM_INITIATOR_PH1_W4_PAIRING_RESPONSE,
36495d04d44S[email protected]     SM_INITIATOR_PH2_W4_PAIRING_CONFIRM,
36595d04d44S[email protected]     SM_INITIATOR_PH2_W4_PAIRING_RANDOM,
36695d04d44S[email protected]     SM_INITIATOR_PH3_SEND_START_ENCRYPTION,
3675567aa60SMatthias Ringwald     SM_INITIATOR_PH4_HAS_LTK,
368c6b7cbd9SMatthias Ringwald 
369c6b7cbd9SMatthias Ringwald     // LE Secure Connections
37006cd539fSMatthias Ringwald     SM_SC_RECEIVED_LTK_REQUEST,
371c6b7cbd9SMatthias Ringwald     SM_SC_SEND_PUBLIC_KEY_COMMAND,
372c6b7cbd9SMatthias Ringwald     SM_SC_W4_PUBLIC_KEY_COMMAND,
373b90c4e75SMatthias Ringwald     SM_SC_W4_LOCAL_NONCE,
374aec94140SMatthias Ringwald     SM_SC_W2_CMAC_FOR_CONFIRMATION,
375aec94140SMatthias Ringwald     SM_SC_W4_CMAC_FOR_CONFIRMATION,
376c6b7cbd9SMatthias Ringwald     SM_SC_SEND_CONFIRMATION,
377688a08f9SMatthias Ringwald     SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION,
378688a08f9SMatthias Ringwald     SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION,
379c6b7cbd9SMatthias Ringwald     SM_SC_W4_CONFIRMATION,
380c6b7cbd9SMatthias Ringwald     SM_SC_SEND_PAIRING_RANDOM,
381c6b7cbd9SMatthias Ringwald     SM_SC_W4_PAIRING_RANDOM,
382945888f5SMatthias Ringwald     SM_SC_W2_CALCULATE_G2,
383945888f5SMatthias Ringwald     SM_SC_W4_CALCULATE_G2,
3843cf37b8cSMatthias Ringwald     SM_SC_W4_CALCULATE_DHKEY,
3850346c37cSMatthias Ringwald     SM_SC_W2_CALCULATE_F5_SALT,
3860346c37cSMatthias Ringwald     SM_SC_W4_CALCULATE_F5_SALT,
3870346c37cSMatthias Ringwald     SM_SC_W2_CALCULATE_F5_MACKEY,
3880346c37cSMatthias Ringwald     SM_SC_W4_CALCULATE_F5_MACKEY,
3890346c37cSMatthias Ringwald     SM_SC_W2_CALCULATE_F5_LTK,
3900346c37cSMatthias Ringwald     SM_SC_W4_CALCULATE_F5_LTK,
391dc300847SMatthias Ringwald     SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK,
392dc300847SMatthias Ringwald     SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK,
393019005a0SMatthias Ringwald     SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
394019005a0SMatthias Ringwald     SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK,
395c6b7cbd9SMatthias Ringwald     SM_SC_W4_USER_RESPONSE,
396bd57ffebSMatthias Ringwald     SM_SC_SEND_DHKEY_CHECK_COMMAND,
397901c000fSMatthias Ringwald     SM_SC_W4_DHKEY_CHECK_COMMAND,
398c6b7cbd9SMatthias Ringwald     SM_SC_W4_LTK_REQUEST_SC,
39957132f12SMatthias Ringwald     SM_SC_W2_CALCULATE_ILK_USING_H6,
40057132f12SMatthias Ringwald 	SM_SC_W2_CALCULATE_ILK_USING_H7,
40157132f12SMatthias Ringwald     SM_SC_W4_CALCULATE_ILK,
40257132f12SMatthias Ringwald     SM_SC_W2_CALCULATE_BR_EDR_LINK_KEY,
40357132f12SMatthias Ringwald     SM_SC_W4_CALCULATE_BR_EDR_LINK_KEY,
404e0a03c85SMatthias Ringwald 
405e0a03c85SMatthias Ringwald     // Classic
406c18be159SMatthias Ringwald     SM_BR_EDR_W4_ENCRYPTION_COMPLETE,
407c18be159SMatthias Ringwald     SM_BR_EDR_INITIATOR_SEND_PAIRING_REQUEST,
408c18be159SMatthias Ringwald     SM_BR_EDR_INITIATOR_W4_PAIRING_RESPONSE,
409c18be159SMatthias Ringwald     SM_BR_EDR_RESPONDER_W4_PAIRING_REQUEST,
410c18be159SMatthias Ringwald     SM_BR_EDR_RESPONDER_PAIRING_REQUEST_RECEIVED,
411c18be159SMatthias Ringwald     SM_BR_EDR_DISTRIBUTE_KEYS,
412c18be159SMatthias Ringwald     SM_BR_EDR_RECEIVE_KEYS,
413e0a03c85SMatthias Ringwald     SM_BR_EDR_W2_CALCULATE_ILK_USING_H6,
414e0a03c85SMatthias Ringwald     SM_BR_EDR_W2_CALCULATE_ILK_USING_H7,
415e0a03c85SMatthias Ringwald     SM_BR_EDR_W4_CALCULATE_ILK,
416e0a03c85SMatthias Ringwald     SM_BR_EDR_W2_CALCULATE_LE_LTK,
417e0a03c85SMatthias Ringwald     SM_BR_EDR_W4_CALCULATE_LE_LTK,
41895d04d44S[email protected] } security_manager_state_t;
41995d04d44S[email protected] 
42095d04d44S[email protected] typedef enum {
4217b8f2e5cSMatthias Ringwald     IRK_LOOKUP_IDLE,
4227b8f2e5cSMatthias Ringwald     IRK_LOOKUP_W4_READY,
4237b8f2e5cSMatthias Ringwald     IRK_LOOKUP_STARTED,
4247b8f2e5cSMatthias Ringwald     IRK_LOOKUP_SUCCEEDED,
4257b8f2e5cSMatthias Ringwald     IRK_LOOKUP_FAILED
4267b8f2e5cSMatthias Ringwald } irk_lookup_state_t;
42795d04d44S[email protected] 
4281ad129beSMatthias Ringwald typedef uint8_t sm_pairing_packet_t[7];
429477200f2S[email protected] 
43095d04d44S[email protected] // connection info available as long as connection exists
43195d04d44S[email protected] typedef struct sm_connection {
432fc64f94aSMatthias Ringwald     hci_con_handle_t         sm_handle;
433687a03c8SMatthias Ringwald     uint16_t                 sm_cid;
43495d04d44S[email protected]     uint8_t                  sm_role;   // 0 - IamMaster, 1 = IamSlave
435190e7c61SMatthias Ringwald     uint8_t                  sm_security_request_received;
43609ea1b62SMatthias Ringwald     uint8_t                  sm_pairing_requested;
43795d04d44S[email protected]     uint8_t                  sm_peer_addr_type;
43878b8321eSMatthias Ringwald     bd_addr_t                sm_peer_address;
439d5314cbeSMatthias Ringwald     uint8_t                  sm_own_addr_type;
440d5314cbeSMatthias Ringwald     bd_addr_t                sm_own_address;
44195d04d44S[email protected]     security_manager_state_t sm_engine_state;
4427b8f2e5cSMatthias Ringwald     irk_lookup_state_t       sm_irk_lookup_state;
443f4935286SMatthias Ringwald     uint8_t                  sm_pairing_failed_reason;
44495d04d44S[email protected]     uint8_t                  sm_connection_encrypted;
44595d04d44S[email protected]     uint8_t                  sm_connection_authenticated;   // [0..1]
4463dc3a67dSMatthias Ringwald     uint8_t                  sm_connection_sc;
44795d04d44S[email protected]     uint8_t                  sm_actual_encryption_key_size;
448477200f2S[email protected]     sm_pairing_packet_t      sm_m_preq;  // only used during c1
44995d04d44S[email protected]     authorization_state_t    sm_connection_authorization_state;
4500f6219e5S[email protected]     uint16_t                 sm_local_ediv;
4510f6219e5S[email protected]     uint8_t                  sm_local_rand[8];
452c5d3944dS[email protected]     int                      sm_le_db_index;
453d77906ffSMatthias Ringwald     bool                     sm_pairing_active;
4547b001f4eSMatthias Ringwald     bool                     sm_reencryption_active;
45595d04d44S[email protected] } sm_connection_t;
4564f3229d8S[email protected] 
45718707219SMatthias Ringwald //
45818707219SMatthias Ringwald // ATT Server
45918707219SMatthias Ringwald //
46018707219SMatthias Ringwald 
46118707219SMatthias Ringwald // max ATT request matches L2CAP PDU -- allow to use smaller buffer
46218707219SMatthias Ringwald #ifndef ATT_REQUEST_BUFFER_SIZE
46318707219SMatthias Ringwald #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE
46418707219SMatthias Ringwald #endif
46518707219SMatthias Ringwald 
46618707219SMatthias Ringwald typedef enum {
46718707219SMatthias Ringwald     ATT_SERVER_IDLE,
46818707219SMatthias Ringwald     ATT_SERVER_REQUEST_RECEIVED,
46918707219SMatthias Ringwald     ATT_SERVER_W4_SIGNED_WRITE_VALIDATION,
47018707219SMatthias Ringwald     ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED,
471beb20288SMatthias Ringwald     ATT_SERVER_RESPONSE_PENDING,
47218707219SMatthias Ringwald } att_server_state_t;
47318707219SMatthias Ringwald 
47418707219SMatthias Ringwald typedef struct {
47518707219SMatthias Ringwald     att_server_state_t      state;
47618707219SMatthias Ringwald 
47718707219SMatthias Ringwald     uint8_t                 peer_addr_type;
47818707219SMatthias Ringwald     bd_addr_t               peer_address;
47918707219SMatthias Ringwald 
48018707219SMatthias Ringwald     int                     ir_le_device_db_index;
48130c8e114SMatthias Ringwald     uint8_t                 ir_lookup_active;
482760ad805SMatthias Ringwald     uint8_t                 pairing_active;
48318707219SMatthias Ringwald 
4847fee22d1SMilanka Ringwald     uint16_t                value_indication_handle;
48518707219SMatthias Ringwald     btstack_timer_source_t  value_indication_timer;
48618707219SMatthias Ringwald 
487cbbb12d9SMatthias Ringwald     btstack_linked_list_t   notification_requests;
488cbbb12d9SMatthias Ringwald     btstack_linked_list_t   indication_requests;
489cbbb12d9SMatthias Ringwald 
4907fc7cb2bSMatthias Ringwald #ifdef ENABLE_GATT_OVER_CLASSIC
4917fc7cb2bSMatthias Ringwald     uint16_t                l2cap_cid;
4927fc7cb2bSMatthias Ringwald #endif
4937fc7cb2bSMatthias Ringwald 
49418707219SMatthias Ringwald     uint16_t                request_size;
49518707219SMatthias Ringwald     uint8_t                 request_buffer[ATT_REQUEST_BUFFER_SIZE];
49618707219SMatthias Ringwald 
49718707219SMatthias Ringwald } att_server_t;
49818707219SMatthias Ringwald 
4993a6673b6SMatthias Ringwald #endif
5003a6673b6SMatthias Ringwald 
5011b9cb13dSMatthias Ringwald typedef enum {
5021b9cb13dSMatthias Ringwald     L2CAP_INFORMATION_STATE_IDLE = 0,
5031b9cb13dSMatthias Ringwald     L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST,
5041b9cb13dSMatthias Ringwald     L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE,
5051901fae5SMatthias Ringwald     L2CAP_INFORMATION_STATE_W2_SEND_FIXED_CHANNELS_REQUEST,
5061901fae5SMatthias Ringwald     L2CAP_INFORMATION_STATE_W4_FIXED_CHANNELS_RESPONSE,
5071b9cb13dSMatthias Ringwald     L2CAP_INFORMATION_STATE_DONE
5081b9cb13dSMatthias Ringwald } l2cap_information_state_t;
5091b9cb13dSMatthias Ringwald 
5101b9cb13dSMatthias Ringwald typedef struct {
5111b9cb13dSMatthias Ringwald     l2cap_information_state_t information_state;
5121b9cb13dSMatthias Ringwald     uint16_t                  extended_feature_mask;
5133cc0a368SMatthias Ringwald     uint16_t                  fixed_channels_supported;    // Core V5.3 - only first octet used
5141b9cb13dSMatthias Ringwald } l2cap_state_t;
5151b9cb13dSMatthias Ringwald 
51618707219SMatthias Ringwald //
517c8e4258aSmatthias.ringwald typedef struct {
51806b35ec0Smatthias.ringwald     // linked list - assert: first field
519665d90f2SMatthias Ringwald     btstack_linked_item_t    item;
520c01e9cbdSmatthias.ringwald 
521c01e9cbdSmatthias.ringwald     // remote side
52216833f0aSmatthias.ringwald     bd_addr_t address;
52306b35ec0Smatthias.ringwald 
52406b35ec0Smatthias.ringwald     // module handle
52516833f0aSmatthias.ringwald     hci_con_handle_t con_handle;
526c01e9cbdSmatthias.ringwald 
52796a45072S[email protected]     // le public, le random, classic
52896a45072S[email protected]     bd_addr_type_t address_type;
52996a45072S[email protected] 
5305cf766e8SMatthias Ringwald     // role: 0 - master, 1 - slave
5315cf766e8SMatthias Ringwald     uint8_t role;
5325cf766e8SMatthias Ringwald 
533afd4e962S[email protected]     // connection state
534c8e4258aSmatthias.ringwald     CONNECTION_STATE state;
535c8e4258aSmatthias.ringwald 
536afd4e962S[email protected]     // bonding
537461a2bc4SMatthias Ringwald     uint32_t bonding_flags;
5381bd5283dS[email protected]     uint8_t  bonding_status;
539f8ee3071SMatthias Ringwald 
540573897a0SMatthias Ringwald     // encryption key size (in octets)
541573897a0SMatthias Ringwald     uint8_t encryption_key_size;
542573897a0SMatthias Ringwald 
54334d2123cS[email protected]     // requested security level
54434d2123cS[email protected]     gap_security_level_t requested_security_level;
54534d2123cS[email protected] 
546e9f98c4aSMatthias Ringwald     // link key and its type
547e9f98c4aSMatthias Ringwald     link_key_t      link_key;
5489ab95c90S[email protected]     link_key_type_t link_key_type;
5499ab95c90S[email protected] 
55098a2fd1cSMatthias Ringwald     // remote supported features
55176ccfb2aSMatthias Ringwald     /* bit 0 - eSCO */
55249bafb5eSMatthias Ringwald     /* bit 1 - extended features */
553b1ace6bdSMatthias Ringwald     uint8_t remote_supported_features[1];
55498a2fd1cSMatthias Ringwald 
555f8ee3071SMatthias Ringwald #ifdef ENABLE_CLASSIC
55650d7398cSMatthias Ringwald     // IO Capabilities Response
55750d7398cSMatthias Ringwald     uint8_t io_cap_response_auth_req;
558e276e383SMatthias Ringwald     uint8_t io_cap_response_io;
559d22b82d6SMatthias Ringwald #ifdef ENABLE_CLASSIC_PAIRING_OOB
560d22b82d6SMatthias Ringwald     uint8_t io_cap_response_oob_data;
561d22b82d6SMatthias Ringwald #endif
56250d7398cSMatthias Ringwald 
563f8ee3071SMatthias Ringwald     // connection mode, default ACL_CONNECTION_MODE_ACTIVE
5643dce6128SMatthias Ringwald     uint8_t connection_mode;
5653dce6128SMatthias Ringwald 
566f8ee3071SMatthias Ringwald     // enter/exit sniff mode requests
567f8ee3071SMatthias Ringwald     uint16_t sniff_min_interval;    // 0: idle, 0xffff exit sniff, else enter sniff
568f8ee3071SMatthias Ringwald     uint16_t sniff_max_interval;
569f8ee3071SMatthias Ringwald     uint16_t sniff_attempt;
570f8ee3071SMatthias Ringwald     uint16_t sniff_timeout;
571760b20efSMatthias Ringwald 
572140c0557SMatthias Ringwald     // sniff subrating
573140c0557SMatthias Ringwald     uint16_t sniff_subrating_max_latency;   // 0xffff = not set
574140c0557SMatthias Ringwald     uint16_t sniff_subrating_min_remote_timeout;
575140c0557SMatthias Ringwald     uint16_t sniff_subrating_min_local_timeout;
576140c0557SMatthias Ringwald 
577278ff8a9SMatthias Ringwald     // QoS
578278ff8a9SMatthias Ringwald     hci_service_type_t qos_service_type;
579278ff8a9SMatthias Ringwald     uint32_t qos_token_rate;
580278ff8a9SMatthias Ringwald     uint32_t qos_peak_bandwidth;
581278ff8a9SMatthias Ringwald     uint32_t qos_latency;
582278ff8a9SMatthias Ringwald     uint32_t qos_delay_variation;
583278ff8a9SMatthias Ringwald 
5846be3cf7fSMatthias Ringwald #ifdef ENABLE_SCO_OVER_HCI
5856f28d2eeSMatthias Ringwald     // track SCO rx event
5866f28d2eeSMatthias Ringwald     uint32_t sco_rx_ms;
5876f28d2eeSMatthias Ringwald     uint8_t  sco_rx_count;
5886f28d2eeSMatthias Ringwald     uint8_t  sco_rx_valid;
5896be3cf7fSMatthias Ringwald #endif
5906f28d2eeSMatthias Ringwald     // generate sco can send now based on received packets, using timeout below
5916f28d2eeSMatthias Ringwald     uint8_t  sco_tx_ready;
592f8ee3071SMatthias Ringwald 
59388a03c8dSMatthias Ringwald     // request role switch
59488a03c8dSMatthias Ringwald     hci_role_t request_role;
59588a03c8dSMatthias Ringwald 
59659c33575SMatthias Ringwald     btstack_timer_source_t timeout_sco;
5976f28d2eeSMatthias Ringwald #endif /* ENABLE_CLASSIC */
5986f28d2eeSMatthias Ringwald 
599891b9fc2SMatthias Ringwald     // authentication and other errands
6009afaa4d4SMatthias Ringwald     uint16_t authentication_flags;
6019afaa4d4SMatthias Ringwald 
6029afaa4d4SMatthias Ringwald     // gap connection tasks, see GAP_CONNECTION_TASK_x
6039afaa4d4SMatthias Ringwald     uint16_t gap_connection_tasks;
604c8e4258aSmatthias.ringwald 
605ec820d77SMatthias Ringwald     btstack_timer_source_t timeout;
606c785ef68Smatthias.ringwald 
607f316a845SMatthias Ringwald     // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS)
608f316a845SMatthias Ringwald     uint32_t timestamp;
609ee091cf1Smatthias.ringwald 
610ec6321eeS[email protected]     // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload
611ec6321eeS[email protected]     uint8_t  acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE];
612c1012e46Smatthias.ringwald     uint16_t acl_recombination_pos;
613d55db49eSmatthias.ringwald     uint16_t acl_recombination_length;
614d55db49eSmatthias.ringwald 
615760b20efSMatthias Ringwald 
616477200f2S[email protected]     // number packets sent to controller
617ce41473eSMatthias Ringwald     uint8_t num_packets_sent;
618c37a3166S[email protected] 
6192b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
6202b838201SMatthias Ringwald     uint8_t num_packets_completed;
6212b838201SMatthias Ringwald #endif
6222b838201SMatthias Ringwald 
623477200f2S[email protected]     // LE Connection parameter update
624da886c03S[email protected]     le_con_parameter_update_state_t le_con_parameter_update_state;
62579f53f1dSMatthias Ringwald     uint8_t  le_con_param_update_identifier;
626c37a3166S[email protected]     uint16_t le_conn_interval_min;
627c37a3166S[email protected]     uint16_t le_conn_interval_max;
628c37a3166S[email protected]     uint16_t le_conn_latency;
629c37a3166S[email protected]     uint16_t le_supervision_timeout;
63095d04d44S[email protected] 
631a9a4c409SMatthias Ringwald #ifdef ENABLE_BLE
632c9db5c21SMilanka Ringwald     uint16_t le_connection_interval;
633b90f6e0aSMatthias Ringwald 
634b90f6e0aSMatthias Ringwald     // LE PHY Update via set phy command
635b90f6e0aSMatthias Ringwald     uint8_t le_phy_update_all_phys;      // 0xff for idle
636b90f6e0aSMatthias Ringwald     uint8_t le_phy_update_tx_phys;
637b90f6e0aSMatthias Ringwald     uint8_t le_phy_update_rx_phys;
638b90f6e0aSMatthias Ringwald     int8_t  le_phy_update_phy_options;
639b90f6e0aSMatthias Ringwald 
64095d04d44S[email protected]     // LE Security Manager
641477200f2S[email protected]     sm_connection_t sm_connection;
64218707219SMatthias Ringwald 
6430f3b27c5SMatthias Ringwald #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS
6440f3b27c5SMatthias Ringwald     uint16_t le_max_tx_octets;
6450f3b27c5SMatthias Ringwald #endif
6460f3b27c5SMatthias Ringwald 
647aafc4f7aSMatthias Ringwald     // ATT Connection
648aafc4f7aSMatthias Ringwald     att_connection_t att_connection;
649aafc4f7aSMatthias Ringwald 
65018707219SMatthias Ringwald     // ATT Server
65118707219SMatthias Ringwald     att_server_t    att_server;
652aafc4f7aSMatthias Ringwald 
653477200f2S[email protected] #endif
65495d04d44S[email protected] 
6551b9cb13dSMatthias Ringwald     l2cap_state_t l2cap_state;
6561b9cb13dSMatthias Ringwald 
6571849becdSMatthias Ringwald #ifdef ENABLE_CLASSIC_PAIRING_OOB
6581849becdSMatthias Ringwald     const uint8_t * classic_oob_c_192;
6591849becdSMatthias Ringwald     const uint8_t * classic_oob_r_192;
6601849becdSMatthias Ringwald     const uint8_t * classic_oob_c_256;
6611849becdSMatthias Ringwald     const uint8_t * classic_oob_r_256;
6621849becdSMatthias Ringwald #endif
6631849becdSMatthias Ringwald 
66416833f0aSmatthias.ringwald } hci_connection_t;
66516833f0aSmatthias.ringwald 
666556d11b3SMatthias Ringwald 
667556d11b3SMatthias Ringwald /**
668556d11b3SMatthias Ringwald  * HCI Inititizlization State Machine
669556d11b3SMatthias Ringwald  */
670556d11b3SMatthias Ringwald typedef enum hci_init_state{
671556d11b3SMatthias Ringwald     HCI_INIT_SEND_RESET = 0,
672556d11b3SMatthias Ringwald     HCI_INIT_W4_SEND_RESET,
67376fcb19bSMatthias Ringwald     HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION,
67476fcb19bSMatthias Ringwald     HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION,
675e28e41c0SMatthias Ringwald 
676e28e41c0SMatthias Ringwald #ifndef HAVE_HOST_CONTROLLER_API
677e90bae01SMatthias Ringwald     HCI_INIT_SEND_READ_LOCAL_NAME,
678e90bae01SMatthias Ringwald     HCI_INIT_W4_SEND_READ_LOCAL_NAME,
6798d29070eSMatthias Ringwald     HCI_INIT_SEND_BAUD_CHANGE,
6808d29070eSMatthias Ringwald     HCI_INIT_W4_SEND_BAUD_CHANGE,
681556d11b3SMatthias Ringwald     HCI_INIT_CUSTOM_INIT,
682556d11b3SMatthias Ringwald     HCI_INIT_W4_CUSTOM_INIT,
683e47e68c7SMatthias Ringwald     HCI_INIT_SEND_RESET_CSR_WARM_BOOT,
684e47e68c7SMatthias Ringwald     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT,
6859f007422SMatthias Ringwald     HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET,
686559961d0SMatthias Ringwald     HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY,
687e28e41c0SMatthias Ringwald #endif
688556d11b3SMatthias Ringwald 
689a828a756SMatthias Ringwald     HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS,
690a828a756SMatthias Ringwald     HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS,
69174b323a9SMatthias Ringwald 
692eb3a5314SMatthias Ringwald     HCI_INIT_SEND_BAUD_CHANGE_BCM,
693eb3a5314SMatthias Ringwald     HCI_INIT_W4_SEND_BAUD_CHANGE_BCM,
694eb3a5314SMatthias Ringwald 
69553860077SMatthias Ringwald     HCI_INIT_SET_BD_ADDR,
69653860077SMatthias Ringwald     HCI_INIT_W4_SET_BD_ADDR,
69753860077SMatthias Ringwald 
69853860077SMatthias Ringwald     HCI_INIT_SEND_RESET_ST_WARM_BOOT,
69953860077SMatthias Ringwald     HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT,
70053860077SMatthias Ringwald 
70153860077SMatthias Ringwald     HCI_INIT_READ_BD_ADDR,
70253860077SMatthias Ringwald     HCI_INIT_W4_READ_BD_ADDR,
70353860077SMatthias Ringwald 
704556d11b3SMatthias Ringwald     HCI_INIT_READ_BUFFER_SIZE,
705556d11b3SMatthias Ringwald     HCI_INIT_W4_READ_BUFFER_SIZE,
70653860077SMatthias Ringwald     HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES,
70753860077SMatthias Ringwald     HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES,
7082b838201SMatthias Ringwald 
7092b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
7102b838201SMatthias Ringwald     HCI_INIT_HOST_BUFFER_SIZE,
7112b838201SMatthias Ringwald     HCI_INIT_W4_HOST_BUFFER_SIZE,
712182c3ec8SMatthias Ringwald     HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
713182c3ec8SMatthias Ringwald     HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL,
7142b838201SMatthias Ringwald #endif
7152b838201SMatthias Ringwald 
716556d11b3SMatthias Ringwald     HCI_INIT_SET_EVENT_MASK,
717556d11b3SMatthias Ringwald     HCI_INIT_W4_SET_EVENT_MASK,
718ff7d1758SMatthias Ringwald     HCI_INIT_SET_EVENT_MASK_2,
719ff7d1758SMatthias Ringwald     HCI_INIT_W4_SET_EVENT_MASK_2,
7202b838201SMatthias Ringwald 
72144b93b4eSMatthias Ringwald #ifdef ENABLE_CLASSIC
722556d11b3SMatthias Ringwald     HCI_INIT_WRITE_SIMPLE_PAIRING_MODE,
723556d11b3SMatthias Ringwald     HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE,
724f6858d14SMatthias Ringwald     HCI_INIT_WRITE_INQUIRY_MODE,
725f6858d14SMatthias Ringwald     HCI_INIT_W4_WRITE_INQUIRY_MODE,
7265d23aae8SMatthias Ringwald     HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE,
7275d23aae8SMatthias Ringwald     HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE,
728a391128dSMatthias Ringwald     HCI_INIT_SET_MIN_ENCRYPTION_KEY_SIZE,
729a391128dSMatthias Ringwald     HCI_INIT_W4_SET_MIN_ENCRYPTION_KEY_SIZE,
730729ed62eSMatthias Ringwald 
731e4c6114dSMatthias Ringwald #ifdef ENABLE_SCO_OVER_HCI
732577ca2d3SMatthias Ringwald     // SCO over HCI
733729ed62eSMatthias Ringwald     HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
734729ed62eSMatthias Ringwald     HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE,
735483c5078SMatthias Ringwald     HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
736483c5078SMatthias Ringwald     HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING,
737e4c6114dSMatthias Ringwald #endif
738729ed62eSMatthias Ringwald 
739e4c6114dSMatthias Ringwald #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM)
7404e821764SMatthias Ringwald     // Broadcom SCO Routing and Configuration
741a42798c3SMatthias Ringwald     HCI_INIT_BCM_WRITE_SCO_PCM_INT,
742a42798c3SMatthias Ringwald     HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT,
743a9904214SMatthias Ringwald #endif
744a9904214SMatthias Ringwald #ifdef ENABLE_SCO_OVER_PCM
7454e821764SMatthias Ringwald     HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM,
7464e821764SMatthias Ringwald     HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM,
747e4c6114dSMatthias Ringwald #endif
74844b93b4eSMatthias Ringwald #endif
749a42798c3SMatthias Ringwald 
750903ea03aSMatthias Ringwald #ifdef ENABLE_BLE
751556d11b3SMatthias Ringwald     HCI_INIT_LE_READ_BUFFER_SIZE,
752556d11b3SMatthias Ringwald     HCI_INIT_W4_LE_READ_BUFFER_SIZE,
753556d11b3SMatthias Ringwald     HCI_INIT_WRITE_LE_HOST_SUPPORTED,
754556d11b3SMatthias Ringwald     HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED,
755daabb8b8SMatthias Ringwald     HCI_INIT_LE_SET_EVENT_MASK,
756daabb8b8SMatthias Ringwald     HCI_INIT_W4_LE_SET_EVENT_MASK,
757b435e062SMatthias Ringwald #endif
758b435e062SMatthias Ringwald 
759b435e062SMatthias Ringwald #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
760dcd678baSMatthias Ringwald     HCI_INIT_LE_READ_MAX_DATA_LENGTH,
761dcd678baSMatthias Ringwald     HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH,
762dcd678baSMatthias Ringwald     HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH,
763dcd678baSMatthias Ringwald     HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH,
764903ea03aSMatthias Ringwald #endif
765903ea03aSMatthias Ringwald 
766903ea03aSMatthias Ringwald #ifdef ENABLE_LE_CENTRAL
7673b6d4121SMatthias Ringwald     HCI_INIT_READ_WHITE_LIST_SIZE,
7683b6d4121SMatthias Ringwald     HCI_INIT_W4_READ_WHITE_LIST_SIZE,
769903ea03aSMatthias Ringwald #endif
770556d11b3SMatthias Ringwald 
7713a74541eSMatthias Ringwald #ifdef ENABLE_LE_PERIPHERAL
7723a74541eSMatthias Ringwald #ifdef ENABLE_LE_EXTENDED_ADVERTISING
7733a74541eSMatthias Ringwald     HCI_INIT_LE_READ_MAX_ADV_DATA_LEN,
7743a74541eSMatthias Ringwald     HCI_INIT_W4_LE_READ_MAX_ADV_DATA_LEN,
7753a74541eSMatthias Ringwald #endif
7763a74541eSMatthias Ringwald #endif
7773a74541eSMatthias Ringwald 
778556d11b3SMatthias Ringwald     HCI_INIT_DONE,
77974b323a9SMatthias Ringwald 
78074b323a9SMatthias Ringwald     HCI_FALLING_ASLEEP_DISCONNECT,
78174b323a9SMatthias Ringwald     HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE,
78274b323a9SMatthias Ringwald     HCI_FALLING_ASLEEP_COMPLETE,
78374b323a9SMatthias Ringwald 
78426fe9592SMatthias Ringwald     HCI_INIT_AFTER_SLEEP,
78526fe9592SMatthias Ringwald 
7860c88d5efSMatthias Ringwald     HCI_HALTING_CLASSIC_STOP,
7870c88d5efSMatthias Ringwald     HCI_HALTING_LE_ADV_STOP,
7880c88d5efSMatthias Ringwald     HCI_HALTING_LE_SCAN_STOP,
7890c88d5efSMatthias Ringwald     HCI_HALTING_DISCONNECT_ALL,
7900c88d5efSMatthias Ringwald     HCI_HALTING_READY_FOR_CLOSE,
7910c88d5efSMatthias Ringwald     HCI_HALTING_DEFER_CLOSE,
7920c88d5efSMatthias Ringwald     HCI_HALTING_W4_CLOSE_TIMER,
79326fe9592SMatthias Ringwald     HCI_HALTING_CLOSE,
794556d11b3SMatthias Ringwald 
79574b323a9SMatthias Ringwald } hci_substate_t;
796556d11b3SMatthias Ringwald 
797bc2dcc03SMatthias Ringwald #define GAP_TASK_SET_LOCAL_NAME               0x01
798bc2dcc03SMatthias Ringwald #define GAP_TASK_SET_EIR_DATA                 0x02
799bc2dcc03SMatthias Ringwald #define GAP_TASK_SET_CLASS_OF_DEVICE          0x04
800bc2dcc03SMatthias Ringwald #define GAP_TASK_SET_DEFAULT_LINK_POLICY      0x08
801bc2dcc03SMatthias Ringwald #define GAP_TASK_WRITE_SCAN_ENABLE            0x10
80227741fe7SMatthias Ringwald #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY     0x20
8039c1f3c56SMatthias Ringwald #define GAP_TASK_WRITE_PAGE_SCAN_TYPE         0x40
80432a12730SMatthias Ringwald #define GAP_TASK_WRITE_PAGE_TIMEOUT           0x80
805c0c8a829SMatthias Ringwald #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100
80659d59ecfSMatthias Ringwald 
80745c102fdSMatthias Ringwald enum {
808a61834b6SMatthias Ringwald     // Tasks
809bbc366e6SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_ADV_DATA         = 1 << 0,
810bbc366e6SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA        = 1 << 1,
811bbc366e6SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_PARAMS           = 1 << 2,
8129136bde8SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_ADDRESS          = 1 << 3,
81353f240c0SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_PERIODIC_PARAMS  = 1 << 4,
81453f240c0SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_SET_PERIODIC_DATA    = 1 << 5,
81553f240c0SMatthias Ringwald     LE_ADVERTISEMENT_TASKS_REMOVE_SET           = 1 << 6,
8166bf435a6SMatthias Ringwald };
8176bf435a6SMatthias Ringwald 
8186bf435a6SMatthias Ringwald enum {
819a61834b6SMatthias Ringwald     // State
8206bf435a6SMatthias Ringwald     LE_ADVERTISEMENT_STATE_PARAMS_SET       = 1 << 0,
821935aa76eSMatthias Ringwald     LE_ADVERTISEMENT_STATE_ACTIVE           = 1 << 1,
822935aa76eSMatthias Ringwald     LE_ADVERTISEMENT_STATE_ENABLED          = 1 << 2,
82353f240c0SMatthias Ringwald     LE_ADVERTISEMENT_STATE_PERIODIC_ACTIVE  = 1 << 3,
82453f240c0SMatthias Ringwald     LE_ADVERTISEMENT_STATE_PERIODIC_ENABLED = 1 << 4,
82545c102fdSMatthias Ringwald };
826556d11b3SMatthias Ringwald 
827656bec4fSMatthias Ringwald enum {
8285877c8b7SMatthias Ringwald     LE_WHITELIST_ON_CONTROLLER          = 1 << 0,
8295877c8b7SMatthias Ringwald     LE_WHITELIST_ADD_TO_CONTROLLER      = 1 << 1,
830e83201bcSMatthias Ringwald     LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2,
831656bec4fSMatthias Ringwald };
832656bec4fSMatthias Ringwald 
833*dbca66ffSMatthias Ringwald enum {
834*dbca66ffSMatthias Ringwald     LE_PERIODIC_ADVERTISER_LIST_ENTRY_ON_CONTROLLER          = 1 << 0,
835*dbca66ffSMatthias Ringwald     LE_PERIODIC_ADVERTISER_LIST_ENTRY_ADD_TO_CONTROLLER      = 1 << 1,
836*dbca66ffSMatthias Ringwald     LE_PERIODIC_ADVERTISER_LIST_ENTRY_REMOVE_FROM_CONTROLLER = 1 << 2,
837*dbca66ffSMatthias Ringwald };
838*dbca66ffSMatthias Ringwald 
839656bec4fSMatthias Ringwald typedef struct {
840665d90f2SMatthias Ringwald     btstack_linked_item_t  item;
841e83201bcSMatthias Ringwald     bd_addr_t      address;
842e83201bcSMatthias Ringwald     bd_addr_type_t address_type;
843656bec4fSMatthias Ringwald     uint8_t        state;
844656bec4fSMatthias Ringwald } whitelist_entry_t;
845656bec4fSMatthias Ringwald 
846*dbca66ffSMatthias Ringwald typedef struct {
847*dbca66ffSMatthias Ringwald     btstack_linked_item_t  item;
848*dbca66ffSMatthias Ringwald     bd_addr_t      address;
849*dbca66ffSMatthias Ringwald     bd_addr_type_t address_type;
850*dbca66ffSMatthias Ringwald     uint8_t        sid;
851*dbca66ffSMatthias Ringwald     uint8_t        state;
852*dbca66ffSMatthias Ringwald } periodic_advertiser_list_entry_t;
853*dbca66ffSMatthias Ringwald 
85421debf25SMatthias Ringwald #define MAX_NUM_RESOLVING_LIST_ENTRIES 64
85521debf25SMatthias Ringwald typedef enum {
85621debf25SMatthias Ringwald     LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION,
85721debf25SMatthias Ringwald     LE_RESOLVING_LIST_READ_SIZE,
85821debf25SMatthias Ringwald     LE_RESOLVING_LIST_SEND_CLEAR,
85902b02cffSMatthias Ringwald 	LE_RESOLVING_LIST_REMOVE_ENTRIES,
86021debf25SMatthias Ringwald     LE_RESOLVING_LIST_ADD_ENTRIES,
86121debf25SMatthias Ringwald     LE_RESOLVING_LIST_DONE
86221debf25SMatthias Ringwald } le_resolving_list_state_t;
86321debf25SMatthias Ringwald 
86406b35ec0Smatthias.ringwald /**
86506b35ec0Smatthias.ringwald  * main data structure
86606b35ec0Smatthias.ringwald  */
86716833f0aSmatthias.ringwald typedef struct {
86806b35ec0Smatthias.ringwald     // transport component with configuration
869fb55bd0aSMatthias Ringwald     const hci_transport_t * hci_transport;
870fb55bd0aSMatthias Ringwald     const void            * config;
871fb55bd0aSMatthias Ringwald 
872fb55bd0aSMatthias Ringwald     // chipset driver
8733fb36a29SMatthias Ringwald     const btstack_chipset_t * chipset;
874fb55bd0aSMatthias Ringwald 
875fb55bd0aSMatthias Ringwald     // hardware power controller
876fb55bd0aSMatthias Ringwald     const btstack_control_t * control;
87711e23e5fSmatthias.ringwald 
878e6d6524dSMatthias Ringwald #ifdef ENABLE_CLASSIC
879d6b06661SMatthias Ringwald     /* link key db */
880d6b06661SMatthias Ringwald     const btstack_link_key_db_t * link_key_db;
881e6d6524dSMatthias Ringwald #endif
882d6b06661SMatthias Ringwald 
8833bc639ceSMatthias Ringwald     // list of existing baseband connections
8843bc639ceSMatthias Ringwald     btstack_linked_list_t     connections;
8853bc639ceSMatthias Ringwald 
8863bc639ceSMatthias Ringwald     /* callback to L2CAP layer */
8873d50b4baSMatthias Ringwald     btstack_packet_handler_t acl_packet_handler;
8883bc639ceSMatthias Ringwald 
8893bc639ceSMatthias Ringwald     /* callback for SCO data */
8903d50b4baSMatthias Ringwald     btstack_packet_handler_t sco_packet_handler;
8913bc639ceSMatthias Ringwald 
8923bc639ceSMatthias Ringwald     /* callbacks for events */
8933bc639ceSMatthias Ringwald     btstack_linked_list_t event_handlers;
8943bc639ceSMatthias Ringwald 
89507e010b6SMilanka Ringwald #ifdef ENABLE_CLASSIC
89607e010b6SMilanka Ringwald     /* callback for reject classic connection */
8975e91d96cSMatthias Ringwald     int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type);
89807e010b6SMilanka Ringwald #endif
89907e010b6SMilanka Ringwald 
9003bc639ceSMatthias Ringwald     // hardware error callback
901c2e1fa60SMatthias Ringwald     void (*hardware_error_callback)(uint8_t error);
9023bc639ceSMatthias Ringwald 
903f456b2d0S[email protected]     // basic configuration
9048e618f72S[email protected]     const char *       local_name;
905ff00ed1cSMatthias Ringwald     const uint8_t *    eir_data;
906e2386ba1S[email protected]     uint32_t           class_of_device;
907e2386ba1S[email protected]     bd_addr_t          local_bd_addr;
908c33e56d3SMatthias Ringwald     uint8_t            default_link_policy_settings;
909b4eb4420SMatthias Ringwald     uint8_t            allow_role_switch;
910a45d6b9fS[email protected]     uint8_t            ssp_enable;
911a45d6b9fS[email protected]     uint8_t            ssp_io_capability;
912a45d6b9fS[email protected]     uint8_t            ssp_authentication_requirement;
9131d6b20aeS[email protected]     uint8_t            ssp_auto_accept;
9145d23aae8SMatthias Ringwald     bool               secure_connections_enable;
915c214d65bSMatthias Ringwald     bool               secure_connections_active;
916f6858d14SMatthias Ringwald     inquiry_mode_t     inquiry_mode;
917bea424a5SMatthias Ringwald 
918170fafaeSMatthias Ringwald #ifdef ENABLE_CLASSIC
91959d59ecfSMatthias Ringwald     /* GAP tasks, see GAP_TASK_* */
920baa4881eSMatthias Ringwald     uint16_t           gap_tasks_classic;
92159d59ecfSMatthias Ringwald 
92232a12730SMatthias Ringwald     /* write page scan activity */
923bea424a5SMatthias Ringwald     uint16_t           new_page_scan_interval;
924bea424a5SMatthias Ringwald     uint16_t           new_page_scan_window;
925bea424a5SMatthias Ringwald 
92632a12730SMatthias Ringwald     /* write page scan type */
927bea424a5SMatthias Ringwald     uint8_t            new_page_scan_type;
928bea424a5SMatthias Ringwald 
92932a12730SMatthias Ringwald     /* write page timeout */
93032a12730SMatthias Ringwald     uint16_t           page_timeout;
93132a12730SMatthias Ringwald 
932170fafaeSMatthias Ringwald     // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default
933170fafaeSMatthias Ringwald     uint8_t            gap_required_encyrption_key_size;
9349afaa4d4SMatthias Ringwald 
9350c3eb48dSMatthias Ringwald     uint16_t           link_supervision_timeout;
9369afaa4d4SMatthias Ringwald     uint16_t           automatic_flush_timeout;
9379afaa4d4SMatthias Ringwald 
93878315a58SMatthias Ringwald     gap_security_level_t gap_security_level;
9398ad4dfffSMatthias Ringwald     gap_security_level_t gap_minimal_service_security_level;
9405dbec6b3SMatthias Ringwald     gap_security_mode_t  gap_security_mode;
941496bb884SMatthias Ringwald 
942496bb884SMatthias Ringwald     uint32_t            inquiry_lap;      // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY
943c0c8a829SMatthias Ringwald     uint16_t            inquiry_scan_interval;
944c0c8a829SMatthias Ringwald     uint16_t            inquiry_scan_window;
94530cdf3c6SMatthias Ringwald 
94630cdf3c6SMatthias Ringwald     bool                gap_secure_connections_only_mode;
947170fafaeSMatthias Ringwald #endif
948e2386ba1S[email protected] 
94960da618dS[email protected]     // single buffer for HCI packet assembly + additional prebuffer for H4 drivers
95026a9b6daSMatthias Ringwald     uint8_t   * hci_packet_buffer;
951fc6cde64SMatthias Ringwald     uint8_t   hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE];
95202c7fc01SMatthias Ringwald     bool      hci_packet_buffer_reserved;
953452cf3bbS[email protected]     uint16_t  acl_fragmentation_pos;
954452cf3bbS[email protected]     uint16_t  acl_fragmentation_total_size;
9554cec6212SMatthias Ringwald     uint8_t   acl_fragmentation_tx_active;
95606b35ec0Smatthias.ringwald 
95716833f0aSmatthias.ringwald     /* host to controller flow control */
95816833f0aSmatthias.ringwald     uint8_t  num_cmd_packets;
959ee303eddS[email protected]     uint8_t  acl_packets_total_num;
960e2edc0c3Smatthias.ringwald     uint16_t acl_data_packet_length;
961a8b12447S[email protected]     uint8_t  sco_packets_total_num;
962a8b12447S[email protected]     uint8_t  sco_data_packet_length;
963ed361f5fSMatthias Ringwald     uint8_t  synchronous_flow_control_enabled;
964ee303eddS[email protected]     uint8_t  le_acl_packets_total_num;
965ee303eddS[email protected]     uint16_t le_data_packets_length;
96679b7ea2dSMatthias Ringwald     uint8_t  le_iso_packets_total_num;
96779b7ea2dSMatthias Ringwald     uint16_t le_iso_packets_length;
9683bc639ceSMatthias Ringwald     uint8_t  sco_waiting_for_can_send_now;
9691972f31fSMatthias Ringwald     bool     sco_can_send_now;
97016833f0aSmatthias.ringwald 
971559e517eS[email protected]     /* local supported features */
972559e517eS[email protected]     uint8_t local_supported_features[8];
973559e517eS[email protected] 
974a828a756SMatthias Ringwald     /* local supported commands summary - complete info is 64 bytes */
9758c021356SMatthias Ringwald     uint32_t local_supported_commands;
976a828a756SMatthias Ringwald 
9774696bddbSMatthias Ringwald     /* bluetooth device information from hci read local version information */
9784696bddbSMatthias Ringwald     // uint16_t hci_version;
9794696bddbSMatthias Ringwald     // uint16_t hci_revision;
9804696bddbSMatthias Ringwald     // uint16_t lmp_version;
9814696bddbSMatthias Ringwald     uint16_t manufacturer;
9824696bddbSMatthias Ringwald     // uint16_t lmp_subversion;
9834696bddbSMatthias Ringwald 
9848f8108aaSmatthias.ringwald     // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE
9858f8108aaSmatthias.ringwald     uint16_t packet_types;
9868f8108aaSmatthias.ringwald 
98729d53098Smatthias.ringwald 
9883429f56bSmatthias.ringwald     /* hci state machine */
9893429f56bSmatthias.ringwald     HCI_STATE      state;
99074b323a9SMatthias Ringwald     hci_substate_t substate;
991ec820d77SMatthias Ringwald     btstack_timer_source_t timeout;
992ae334e9eSMatthias Ringwald     btstack_chipset_result_t chipset_result;
9933429f56bSmatthias.ringwald 
9945127cc62S[email protected]     uint16_t  last_cmd_opcode;
9955127cc62S[email protected] 
996f5875de5SMatthias Ringwald     uint8_t   cmds_ready;
9970a51f88bSMatthias Ringwald 
9980a51f88bSMatthias Ringwald     /* buffer for scan enable cmd - 0xff no change */
9990a51f88bSMatthias Ringwald     uint8_t   new_scan_enable_value;
10000a51f88bSMatthias Ringwald 
10010a51f88bSMatthias Ringwald     uint8_t   discoverable;
10020a51f88bSMatthias Ringwald     uint8_t   connectable;
10030a51f88bSMatthias Ringwald     uint8_t   bondable;
10040a51f88bSMatthias Ringwald 
1005f5875de5SMatthias Ringwald     uint8_t   inquiry_state;    // see hci.c for state defines
1006f5875de5SMatthias Ringwald 
1007b7f1ee76SMatthias Ringwald     bd_addr_t remote_name_addr;
1008b7f1ee76SMatthias Ringwald     uint16_t  remote_name_clock_offset;
1009b7f1ee76SMatthias Ringwald     uint8_t   remote_name_page_scan_repetition_mode;
1010b7f1ee76SMatthias Ringwald     uint8_t   remote_name_state;    // see hci.c for state defines
1011b7f1ee76SMatthias Ringwald 
10120a51f88bSMatthias Ringwald     bd_addr_t gap_pairing_addr;
10130a51f88bSMatthias Ringwald     uint8_t   gap_pairing_state;    // see hci.c for state defines
1014aad97216SMatthias Ringwald     uint8_t   gap_pairing_pin_len;
10150a51f88bSMatthias Ringwald     union {
1016aad97216SMatthias Ringwald         const uint8_t * gap_pairing_pin;
10170a51f88bSMatthias Ringwald         uint32_t     gap_pairing_passkey;
1018d504181aSMatthias Ringwald     } gap_pairing_input;
1019f5875de5SMatthias Ringwald 
1020d950d659SMatthias Ringwald     uint16_t  sco_voice_setting;
1021ee752bb8SMatthias Ringwald     uint16_t  sco_voice_setting_active;
1022d950d659SMatthias Ringwald 
10234b3e1e19SMatthias Ringwald     uint8_t   loopback_mode;
10244b3e1e19SMatthias Ringwald 
10253dbb95f9Smatthias.ringwald     // buffer for single connection decline
10263dbb95f9Smatthias.ringwald     uint8_t   decline_reason;
10273dbb95f9Smatthias.ringwald     bd_addr_t decline_addr;
1028381fbed8Smatthias.ringwald 
10292b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
10302b838201SMatthias Ringwald     uint8_t   host_completed_packets;
10312b838201SMatthias Ringwald #endif
10322b838201SMatthias Ringwald 
1033b95a5a35SMatthias Ringwald #ifdef ENABLE_BLE
1034b95a5a35SMatthias Ringwald     uint8_t   le_own_addr_type;
1035b95a5a35SMatthias Ringwald     bd_addr_t le_random_address;
1036b95a5a35SMatthias Ringwald     uint8_t   le_random_address_set;
103713eb2a2eSMatthias Ringwald 
103813eb2a2eSMatthias Ringwald     // LE Whitelist Management
103913eb2a2eSMatthias Ringwald     uint8_t               le_whitelist_capacity;
104013eb2a2eSMatthias Ringwald     btstack_linked_list_t le_whitelist;
1041b95a5a35SMatthias Ringwald #endif
1042e2602ea2Smatthias.ringwald 
1043d70217a2SMatthias Ringwald #ifdef ENABLE_LE_CENTRAL
1044fde725feSMatthias Ringwald     bool   le_scanning_enabled;
1045fde725feSMatthias Ringwald     bool   le_scanning_active;
10466fab74dbSMatthias Ringwald 
1047b04dfa37SMatthias Ringwald     le_connecting_state_t le_connecting_state;
1048d5b1a89eSMatthias Ringwald     le_connecting_state_t le_connecting_request;
1049e2602ea2Smatthias.ringwald 
10508b69e4c7SMatthias Ringwald     bool     le_scanning_param_update;
1051e2602ea2Smatthias.ringwald     uint8_t  le_scan_type;
10525a1ca52eSMatthias Ringwald     uint8_t  le_scan_filter_policy;
1053e2602ea2Smatthias.ringwald     uint16_t le_scan_interval;
1054e2602ea2Smatthias.ringwald     uint16_t le_scan_window;
1055da886c03S[email protected] 
105673044eb2SMatthias Ringwald     // Connection parameters
105773044eb2SMatthias Ringwald     uint16_t le_connection_interval_min;
105873044eb2SMatthias Ringwald     uint16_t le_connection_interval_max;
105973044eb2SMatthias Ringwald     uint16_t le_connection_latency;
106073044eb2SMatthias Ringwald     uint16_t le_supervision_timeout;
106173044eb2SMatthias Ringwald     uint16_t le_minimum_ce_length;
106273044eb2SMatthias Ringwald     uint16_t le_maximum_ce_length;
1063cbe54ab2SJakob Krantz     uint16_t le_connection_scan_interval;
1064cbe54ab2SJakob Krantz     uint16_t le_connection_scan_window;
1065f5873674SMatthias Ringwald     uint8_t  le_connection_own_addr_type;
10666bcfa632SMatthias Ringwald     bd_addr_t le_connection_own_address;
1067d70217a2SMatthias Ringwald #endif
1068d70217a2SMatthias Ringwald 
1069da886c03S[email protected]     le_connection_parameter_range_t le_connection_parameter_range;
1070f456b2d0S[email protected] 
1071d70217a2SMatthias Ringwald #ifdef ENABLE_LE_PERIPHERAL
107245c102fdSMatthias Ringwald     uint8_t  * le_advertisements_data;
107345c102fdSMatthias Ringwald     uint8_t    le_advertisements_data_len;
107445c102fdSMatthias Ringwald 
1075501f56b3SMatthias Ringwald     uint8_t  * le_scan_response_data;
1076501f56b3SMatthias Ringwald     uint8_t    le_scan_response_data_len;
1077501f56b3SMatthias Ringwald 
107845c102fdSMatthias Ringwald     uint16_t le_advertisements_interval_min;
107945c102fdSMatthias Ringwald     uint16_t le_advertisements_interval_max;
108045c102fdSMatthias Ringwald     uint8_t  le_advertisements_type;
108145c102fdSMatthias Ringwald     uint8_t  le_advertisements_direct_address_type;
108245c102fdSMatthias Ringwald     uint8_t  le_advertisements_channel_map;
108345c102fdSMatthias Ringwald     uint8_t  le_advertisements_filter_policy;
108445c102fdSMatthias Ringwald     bd_addr_t le_advertisements_direct_address;
1085f5873674SMatthias Ringwald     uint8_t   le_advertisements_own_addr_type;
10866bcfa632SMatthias Ringwald     bd_addr_t le_advertisements_own_address;
10872b6ab3e6SMatthias Ringwald 
1088a408e724SMatthias Ringwald     uint8_t  le_advertisements_todo;
1089a408e724SMatthias Ringwald     uint8_t  le_advertisements_state;
1090a408e724SMatthias Ringwald 
1091a408e724SMatthias Ringwald     bool     le_advertisements_enabled_for_current_roles;
10922b6ab3e6SMatthias Ringwald     uint8_t le_max_number_peripheral_connections;
1093a408e724SMatthias Ringwald 
10943a74541eSMatthias Ringwald #ifdef ENABLE_LE_EXTENDED_ADVERTISING
10955ce0b5cbSMatthias Ringwald     btstack_linked_list_t le_advertising_sets;
10963a74541eSMatthias Ringwald     uint16_t le_maximum_advertising_data_length;
1097174b4d21SMatthias Ringwald     uint8_t  le_advertising_set_in_current_command;
10983a74541eSMatthias Ringwald #endif
1099d70217a2SMatthias Ringwald #endif
11003b6d4121SMatthias Ringwald 
1101b435e062SMatthias Ringwald #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION
1102dcd678baSMatthias Ringwald     // LE Data Length
1103dcd678baSMatthias Ringwald     uint16_t le_supported_max_tx_octets;
1104dcd678baSMatthias Ringwald     uint16_t le_supported_max_tx_time;
1105b435e062SMatthias Ringwald #endif
1106dcd678baSMatthias Ringwald 
1107f456b2d0S[email protected]     // custom BD ADDR
1108f456b2d0S[email protected]     bd_addr_t custom_bd_addr;
1109f456b2d0S[email protected]     uint8_t   custom_bd_addr_set;
1110f456b2d0S[email protected] 
1111c4c88f1bSJakob Krantz #ifdef ENABLE_CLASSIC
1112c4c88f1bSJakob Krantz     uint8_t master_slave_policy;
1113c4c88f1bSJakob Krantz #endif
1114c4c88f1bSJakob Krantz 
1115229331c6SMatthias Ringwald     // address and address_type of active create connection command (ACL, SCO, LE)
1116229331c6SMatthias Ringwald     bd_addr_t      outgoing_addr;
1117229331c6SMatthias Ringwald     bd_addr_type_t outgoing_addr_type;
111821debf25SMatthias Ringwald 
111921debf25SMatthias Ringwald     // LE Resolving List
112021debf25SMatthias Ringwald #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION
112121debf25SMatthias Ringwald     le_resolving_list_state_t le_resolving_list_state;
112221debf25SMatthias Ringwald     uint16_t                  le_resolving_list_size;
112302b02cffSMatthias Ringwald     uint8_t                   le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8];
112402b02cffSMatthias Ringwald 	uint8_t                   le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8];
112521debf25SMatthias Ringwald #endif
112621debf25SMatthias Ringwald 
1127cf01e888SMatthias Ringwald #ifdef ENABLE_CLASSIC_PAIRING_OOB
1128cf01e888SMatthias Ringwald 	bool                      classic_read_local_oob_data;
11291ae74bf3SMatthias Ringwald 	hci_con_handle_t          classic_oob_con_handle;
1130cf01e888SMatthias Ringwald #endif
1131cb70c5abSMatthias Ringwald 
1132cb70c5abSMatthias Ringwald #ifdef HAVE_SCO_TRANSPORT
1133cb70c5abSMatthias Ringwald 	const btstack_sco_transport_t * sco_transport;
1134cb70c5abSMatthias Ringwald #endif
113516833f0aSmatthias.ringwald } hci_stack_t;
113616833f0aSmatthias.ringwald 
113715a95bd5SMatthias Ringwald 
11385e6d58c4SMilanka Ringwald /* API_START */
11395e6d58c4SMilanka Ringwald 
114095d71764SMatthias Ringwald 
114115a95bd5SMatthias Ringwald // HCI init and configuration
114295d71764SMatthias Ringwald 
11435e6d58c4SMilanka Ringwald 
11443de95307SMilanka Ringwald /**
11453de95307SMilanka Ringwald  * @brief Set up HCI. Needs to be called before any other function.
11463de95307SMilanka Ringwald  */
11472d5e09d6SMatthias Ringwald void hci_init(const hci_transport_t *transport, const void *config);
1148e6cc8be2S[email protected] 
11493de95307SMilanka Ringwald /**
1150fb55bd0aSMatthias Ringwald  * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information.
1151c67501cbSMatthias Ringwald  */
11523fb36a29SMatthias Ringwald void hci_set_chipset(const btstack_chipset_t *chipset_driver);
1153c67501cbSMatthias Ringwald 
1154c67501cbSMatthias Ringwald /**
1155fb55bd0aSMatthias Ringwald  * @brief Configure Bluetooth hardware control. Has to be called before power on.
1156cb70c5abSMatthias Ringwald  * @[aram hardware_control implementation
1157fb55bd0aSMatthias Ringwald  */
1158fb55bd0aSMatthias Ringwald void hci_set_control(const btstack_control_t *hardware_control);
1159fb55bd0aSMatthias Ringwald 
1160c694b835SMatthias Ringwald #ifdef HAVE_SCO_TRANSPORT
1161fb55bd0aSMatthias Ringwald /**
1162cb70c5abSMatthias Ringwald  * @brief Set SCO Transport implementation for SCO over PCM mode
1163cb70c5abSMatthias Ringwald  * @param sco_transport that sends SCO over I2S or PCM interface
1164cb70c5abSMatthias Ringwald  */
1165cb70c5abSMatthias Ringwald void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport);
1166c694b835SMatthias Ringwald #endif
1167cb70c5abSMatthias Ringwald 
1168e6d6524dSMatthias Ringwald #ifdef ENABLE_CLASSIC
1169cb70c5abSMatthias Ringwald /**
11702d5e09d6SMatthias Ringwald  * @brief Configure Bluetooth hardware control. Has to be called before power on.
11712d5e09d6SMatthias Ringwald  */
11722d5e09d6SMatthias Ringwald void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db);
1173e6d6524dSMatthias Ringwald #endif
11742d5e09d6SMatthias Ringwald 
11752d5e09d6SMatthias Ringwald /**
117615a95bd5SMatthias Ringwald  * @brief Set callback for Bluetooth Hardware Error
117715a95bd5SMatthias Ringwald  */
1178c2e1fa60SMatthias Ringwald void hci_set_hardware_error_callback(void (*fn)(uint8_t error));
117915a95bd5SMatthias Ringwald 
118015a95bd5SMatthias Ringwald /**
118115a95bd5SMatthias Ringwald  * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h
11823de95307SMilanka Ringwald  */
1183f456b2d0S[email protected] void hci_set_bd_addr(bd_addr_t addr);
1184f456b2d0S[email protected] 
11853de95307SMilanka Ringwald /**
118615a95bd5SMatthias Ringwald  * @brief Configure Voice Setting for use with SCO data in HSP/HFP
118715a95bd5SMatthias Ringwald  */
118815a95bd5SMatthias Ringwald void hci_set_sco_voice_setting(uint16_t voice_setting);
118915a95bd5SMatthias Ringwald 
119015a95bd5SMatthias Ringwald /**
119115a95bd5SMatthias Ringwald  * @brief Get SCO Voice Setting
119215a95bd5SMatthias Ringwald  * @return current voice setting
119315a95bd5SMatthias Ringwald  */
119415a95bd5SMatthias Ringwald uint16_t hci_get_sco_voice_setting(void);
119515a95bd5SMatthias Ringwald 
119615a95bd5SMatthias Ringwald /**
1197f6858d14SMatthias Ringwald  * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on.
1198f6858d14SMatthias Ringwald  * @param inquriy_mode see bluetooth_defines.h
1199f6858d14SMatthias Ringwald  */
1200b45b7749SMilanka Ringwald void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode);
1201f6858d14SMatthias Ringwald 
1202f6858d14SMatthias Ringwald /**
120315a95bd5SMatthias Ringwald  * @brief Requests the change of BTstack power mode.
1204b45b7749SMilanka Ringwald  * @param power_mode
1205b45b7749SMilanka Ringwald  * @return 0 if success, otherwise error
120615a95bd5SMatthias Ringwald  */
120748cdff9cSMilanka Ringwald int  hci_power_control(HCI_POWER_MODE power_mode);
120815a95bd5SMatthias Ringwald 
120915a95bd5SMatthias Ringwald /**
121015a95bd5SMatthias Ringwald  * @brief Shutdown HCI
121115a95bd5SMatthias Ringwald  */
121215a95bd5SMatthias Ringwald void hci_close(void);
121315a95bd5SMatthias Ringwald 
121415a95bd5SMatthias Ringwald 
121515a95bd5SMatthias Ringwald // Callback registration
121615a95bd5SMatthias Ringwald 
121715a95bd5SMatthias Ringwald 
121815a95bd5SMatthias Ringwald /**
1219d6b06661SMatthias Ringwald  * @brief Add event packet handler.
1220d6b06661SMatthias Ringwald  */
1221d6b06661SMatthias Ringwald void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler);
1222d6b06661SMatthias Ringwald 
1223d6b06661SMatthias Ringwald /**
122467f708e0SMatthias Ringwald  * @brief Remove event packet handler.
122567f708e0SMatthias Ringwald  */
122667f708e0SMatthias Ringwald void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler);
122767f708e0SMatthias Ringwald 
122867f708e0SMatthias Ringwald /**
1229fb37a842SMatthias Ringwald  * @brief Registers a packet handler for ACL data. Used by L2CAP
12303de95307SMilanka Ringwald  */
12313d50b4baSMatthias Ringwald void hci_register_acl_packet_handler(btstack_packet_handler_t handler);
1232e6cc8be2S[email protected] 
12333de95307SMilanka Ringwald /**
12348abbe8b5SMatthias Ringwald  * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles.
12358abbe8b5SMatthias Ringwald  */
12363d50b4baSMatthias Ringwald void hci_register_sco_packet_handler(btstack_packet_handler_t handler);
12378abbe8b5SMatthias Ringwald 
123815a95bd5SMatthias Ringwald 
123915a95bd5SMatthias Ringwald // Sending HCI Commands
1240e6cc8be2S[email protected] 
12413de95307SMilanka Ringwald /**
124215a95bd5SMatthias Ringwald  * @brief Check if CMD packet can be sent to controller
12431972f31fSMatthias Ringwald  * @return true if command can be sent
12443de95307SMilanka Ringwald  */
12451972f31fSMatthias Ringwald bool hci_can_send_command_packet_now(void);
1246e6cc8be2S[email protected] 
12473de95307SMilanka Ringwald /**
12483de95307SMilanka Ringwald  * @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.
12493e2050f7SMatthias Ringwald  * @return status
12503de95307SMilanka Ringwald  */
12513e2050f7SMatthias Ringwald uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...);
1252e6cc8be2S[email protected] 
1253e6cc8be2S[email protected] 
125415a95bd5SMatthias Ringwald // Sending SCO Packets
1255d950d659SMatthias Ringwald 
1256b3aad8daSMatthias Ringwald /** @brief Get SCO packet length for current SCO Voice setting
1257b3aad8daSMatthias Ringwald  *  @note  Using SCO packets of the exact length is required for USB transfer
1258b3aad8daSMatthias Ringwald  *  @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header
1259b3aad8daSMatthias Ringwald  */
126020dcdd22SMatthias Ringwald uint16_t hci_get_sco_packet_length(void);
1261b3aad8daSMatthias Ringwald 
126295d71764SMatthias Ringwald /**
1263d057580eSMatthias Ringwald  * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible
1264d057580eSMatthias Ringwald  * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function
1265d057580eSMatthias Ringwald  *       so packet handler should be ready to handle it
1266d057580eSMatthias Ringwald  */
1267d057580eSMatthias Ringwald void hci_request_sco_can_send_now_event(void);
1268d057580eSMatthias Ringwald 
1269d057580eSMatthias Ringwald /**
1270d057580eSMatthias Ringwald  * @brief Check HCI packet buffer and if SCO packet can be sent to controller
12711972f31fSMatthias Ringwald  * @return true if sco packet can be sent
127215a95bd5SMatthias Ringwald  */
12731972f31fSMatthias Ringwald bool hci_can_send_sco_packet_now(void);
127415a95bd5SMatthias Ringwald 
127515a95bd5SMatthias Ringwald /**
127615a95bd5SMatthias Ringwald  * @brief Check if SCO packet can be sent to controller
12771972f31fSMatthias Ringwald  * @return true if sco packet can be sent
127815a95bd5SMatthias Ringwald  */
12791972f31fSMatthias Ringwald bool hci_can_send_prepared_sco_packet_now(void);
128015a95bd5SMatthias Ringwald 
128115a95bd5SMatthias Ringwald /**
1282d057580eSMatthias Ringwald  * @brief Send SCO packet prepared in HCI packet buffer
128315a95bd5SMatthias Ringwald  */
12843e2050f7SMatthias Ringwald uint8_t hci_send_sco_packet_buffer(int size);
128515a95bd5SMatthias Ringwald 
128615a95bd5SMatthias Ringwald /**
128795d71764SMatthias Ringwald  * Reserves outgoing packet buffer.
1288cafc12e8SMatthias Ringwald  * @return true on success
128995d71764SMatthias Ringwald  */
1290cafc12e8SMatthias Ringwald bool hci_reserve_packet_buffer(void);
129195d71764SMatthias Ringwald 
129295d71764SMatthias Ringwald /**
129395d71764SMatthias Ringwald  * Get pointer for outgoing packet buffer
129495d71764SMatthias Ringwald  */
129595d71764SMatthias Ringwald uint8_t* hci_get_outgoing_packet_buffer(void);
129695d71764SMatthias Ringwald 
129795d71764SMatthias Ringwald /**
129895d71764SMatthias Ringwald  * Release outgoing packet buffer\
129995d71764SMatthias Ringwald  * @note only called instead of hci_send_preparared
130095d71764SMatthias Ringwald  */
130195d71764SMatthias Ringwald void hci_release_packet_buffer(void);
130295d71764SMatthias Ringwald 
1303c4c88f1bSJakob Krantz /**
1304c4c88f1bSJakob Krantz * @brief Sets the master/slave policy
1305c4c88f1bSJakob Krantz * @param policy (0: attempt to become master, 1: let connecting device decide)
1306c4c88f1bSJakob Krantz */
1307c4c88f1bSJakob Krantz void hci_set_master_slave_policy(uint8_t policy);
130895d71764SMatthias Ringwald 
13095e6d58c4SMilanka Ringwald /* API_END */
13102bd8b7e7S[email protected] 
131115a95bd5SMatthias Ringwald 
131294be1a66SMatthias Ringwald /**
1313f5e5741dSMatthias Ringwald  * va_list version of hci_send_cmd, call hci_send_cmd_packet
13143e2050f7SMatthias Ringwald  * @return status
131594be1a66SMatthias Ringwald  */
13163e2050f7SMatthias Ringwald uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr);
131715a95bd5SMatthias Ringwald 
131845c102fdSMatthias Ringwald /**
131995d71764SMatthias Ringwald  * Get connection iterator. Only used by l2cap.c and sm.c
132095d71764SMatthias Ringwald  */
132195d71764SMatthias Ringwald void hci_connections_get_iterator(btstack_linked_list_iterator_t *it);
132295d71764SMatthias Ringwald 
132395d71764SMatthias Ringwald /**
132415a95bd5SMatthias Ringwald  * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon
132515a95bd5SMatthias Ringwald  */
132615a95bd5SMatthias Ringwald hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle);
132715a95bd5SMatthias Ringwald 
132815a95bd5SMatthias Ringwald /**
132915a95bd5SMatthias Ringwald  * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP
133015a95bd5SMatthias Ringwald  */
1331667ba9d1SMatthias Ringwald hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type);
133215a95bd5SMatthias Ringwald 
133315a95bd5SMatthias Ringwald /**
133415a95bd5SMatthias Ringwald  * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c
13351972f31fSMatthias Ringwald  * @return true if packet buffer is reserved
133615a95bd5SMatthias Ringwald  */
133702c7fc01SMatthias Ringwald bool hci_is_packet_buffer_reserved(void);
133815a95bd5SMatthias Ringwald 
133915a95bd5SMatthias Ringwald /**
134095d71764SMatthias Ringwald  * Check hci packet buffer is free and a classic acl packet can be sent to controller
13411972f31fSMatthias Ringwald  * @return true if ACL Classic packet can be sent now
134295d71764SMatthias Ringwald  */
13431972f31fSMatthias Ringwald bool hci_can_send_acl_classic_packet_now(void);
134495d71764SMatthias Ringwald 
134595d71764SMatthias Ringwald /**
134695d71764SMatthias Ringwald  * Check hci packet buffer is free and an LE acl packet can be sent to controller
13471972f31fSMatthias Ringwald  * @return true if ACL LE packet can be sent now
134895d71764SMatthias Ringwald  */
13491972f31fSMatthias Ringwald bool hci_can_send_acl_le_packet_now(void);
135095d71764SMatthias Ringwald 
135195d71764SMatthias Ringwald /**
135295d71764SMatthias Ringwald  * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller
13531972f31fSMatthias Ringwald  * @return true if ACL packet for con_handle can be sent now
135495d71764SMatthias Ringwald  */
13551972f31fSMatthias Ringwald bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle);
135695d71764SMatthias Ringwald 
135795d71764SMatthias Ringwald /**
135895d71764SMatthias Ringwald  * Check if acl packet for the given handle can be sent to controller
13591972f31fSMatthias Ringwald  * @return true if ACL packet for con_handle can be sent now
136095d71764SMatthias Ringwald  */
13611972f31fSMatthias Ringwald bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle);
136295d71764SMatthias Ringwald 
136395d71764SMatthias Ringwald /**
136495d71764SMatthias Ringwald  * Send acl packet prepared in hci packet buffer
13653e2050f7SMatthias Ringwald  * @return status
136695d71764SMatthias Ringwald  */
13673e2050f7SMatthias Ringwald uint8_t hci_send_acl_packet_buffer(int size);
136895d71764SMatthias Ringwald 
136995d71764SMatthias Ringwald /**
137095d71764SMatthias Ringwald  * Check if authentication is active. It delays automatic disconnect while no L2CAP connection
137195d71764SMatthias Ringwald  * Called by l2cap.
137295d71764SMatthias Ringwald  */
137320dcdd22SMatthias Ringwald bool hci_authentication_active_for_handle(hci_con_handle_t handle);
137495d71764SMatthias Ringwald 
137595d71764SMatthias Ringwald /**
137695d71764SMatthias Ringwald  * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP
137795d71764SMatthias Ringwald  */
137895d71764SMatthias Ringwald uint16_t hci_max_acl_data_packet_length(void);
137995d71764SMatthias Ringwald 
138095d71764SMatthias Ringwald /**
138195d71764SMatthias Ringwald  * Get supported packet types. Called by L2CAP
138295d71764SMatthias Ringwald  */
138395d71764SMatthias Ringwald uint16_t hci_usable_acl_packet_types(void);
138495d71764SMatthias Ringwald 
138595d71764SMatthias Ringwald /**
138695d71764SMatthias Ringwald  * Check if ACL packets marked as non flushable can be sent. Called by L2CAP
138795d71764SMatthias Ringwald  */
138820dcdd22SMatthias Ringwald bool hci_non_flushable_packet_boundary_flag_supported(void);
138995d71764SMatthias Ringwald 
139095d71764SMatthias Ringwald /**
13919afaa4d4SMatthias Ringwald  * Return current automatic flush timeout setting
13929afaa4d4SMatthias Ringwald  */
13939afaa4d4SMatthias Ringwald uint16_t hci_automatic_flush_timeout(void);
13949afaa4d4SMatthias Ringwald 
13959afaa4d4SMatthias Ringwald /**
13966ffc78ceSMatthias Ringwald  * Check if remote supported features query has completed
13976ffc78ceSMatthias Ringwald  */
13986ffc78ceSMatthias Ringwald bool hci_remote_features_available(hci_con_handle_t con_handle);
1399d6596031SMatthias Ringwald 
1400d6596031SMatthias Ringwald /**
1401d6596031SMatthias Ringwald  * Trigger remote supported features query
1402d6596031SMatthias Ringwald  */
1403d6596031SMatthias Ringwald void hci_remote_features_query(hci_con_handle_t con_handle);
1404d6596031SMatthias Ringwald 
14056ffc78ceSMatthias Ringwald /**
14063e68d23dSMatthias Ringwald  * Check if extended SCO Link is supported
14073e68d23dSMatthias Ringwald  */
140820dcdd22SMatthias Ringwald bool hci_extended_sco_link_supported(void);
14093e68d23dSMatthias Ringwald 
14103e68d23dSMatthias Ringwald /**
141195d71764SMatthias Ringwald  * Check if SSP is supported on both sides. Called by L2CAP
141295d71764SMatthias Ringwald  */
141320dcdd22SMatthias Ringwald bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle);
141495d71764SMatthias Ringwald 
141595d71764SMatthias Ringwald /**
141695d71764SMatthias Ringwald  * Disconn because of security block. Called by L2CAP
141795d71764SMatthias Ringwald  */
141895d71764SMatthias Ringwald void hci_disconnect_security_block(hci_con_handle_t con_handle);
141995d71764SMatthias Ringwald 
142095d71764SMatthias Ringwald /**
142195d71764SMatthias Ringwald  * Query if remote side supports eSCO
142295d71764SMatthias Ringwald  */
142320dcdd22SMatthias Ringwald bool hci_remote_esco_supported(hci_con_handle_t con_handle);
142495d71764SMatthias Ringwald 
142595d71764SMatthias Ringwald /**
142695d71764SMatthias Ringwald  * Emit current HCI state. Called by daemon
142795d71764SMatthias Ringwald  */
142895d71764SMatthias Ringwald void hci_emit_state(void);
142995d71764SMatthias Ringwald 
143095d71764SMatthias Ringwald /**
1431f5e5741dSMatthias Ringwald  * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg
14323e2050f7SMatthias Ringwald  * @return status
143395d71764SMatthias Ringwald  */
14343e2050f7SMatthias Ringwald uint8_t hci_send_cmd_packet(uint8_t *packet, int size);
143595d71764SMatthias Ringwald 
143695d71764SMatthias Ringwald /**
143795d71764SMatthias Ringwald  * Disconnect all HCI connections. Called by daemon
143895d71764SMatthias Ringwald  */
143995d71764SMatthias Ringwald void hci_disconnect_all(void);
144095d71764SMatthias Ringwald 
144195d71764SMatthias Ringwald /**
144295d71764SMatthias Ringwald  * Get number of free acl slots for packets of given handle. Called by daemon
144395d71764SMatthias Ringwald  */
144495d71764SMatthias Ringwald int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle);
144595d71764SMatthias Ringwald 
144695d71764SMatthias Ringwald /**
144745c102fdSMatthias Ringwald  * @brief Set Advertisement Parameters
144845c102fdSMatthias Ringwald  * @param adv_int_min
144945c102fdSMatthias Ringwald  * @param adv_int_max
145045c102fdSMatthias Ringwald  * @param adv_type
145145c102fdSMatthias Ringwald  * @param direct_address_type
145245c102fdSMatthias Ringwald  * @param direct_address
145345c102fdSMatthias Ringwald  * @param channel_map
145445c102fdSMatthias Ringwald  * @param filter_policy
145545c102fdSMatthias Ringwald  *
1456b95a5a35SMatthias Ringwald  * @note internal use. use gap_advertisements_set_params from gap.h instead.
145745c102fdSMatthias Ringwald  */
145845c102fdSMatthias Ringwald void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type,
1459b95a5a35SMatthias Ringwald     uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy);
146045c102fdSMatthias Ringwald 
1461b95a5a35SMatthias Ringwald /**
1462b95a5a35SMatthias Ringwald  *
1463b95a5a35SMatthias Ringwald  * @note internal use. use gap_random_address_set_mode from gap.h instead.
1464b95a5a35SMatthias Ringwald  */
1465b95a5a35SMatthias Ringwald void hci_le_set_own_address_type(uint8_t own_address_type);
146633373e40SMatthias Ringwald 
146733373e40SMatthias Ringwald /**
14689136bde8SMatthias Ringwald  * @naote internal use. use gap_random_address_set from gap.h instead
14699136bde8SMatthias Ringwald  */
14709136bde8SMatthias Ringwald void hci_le_random_address_set(const bd_addr_t random_address);
14719136bde8SMatthias Ringwald 
14729136bde8SMatthias Ringwald /**
147321debf25SMatthias Ringwald  * @note internal use by sm
147421debf25SMatthias Ringwald  */
147521debf25SMatthias Ringwald void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index);
147621debf25SMatthias Ringwald 
147721debf25SMatthias Ringwald /**
147802b02cffSMatthias Ringwald  * @note internal use by sm
147902b02cffSMatthias Ringwald  */
148002b02cffSMatthias Ringwald void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index);
148102b02cffSMatthias Ringwald 
148202b02cffSMatthias Ringwald /**
14838f733c6fSMatthias Ringwald  * @note internal use
14848f733c6fSMatthias Ringwald  */
14858f733c6fSMatthias Ringwald uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type);
14868f733c6fSMatthias Ringwald 
14878f733c6fSMatthias Ringwald /**
148833373e40SMatthias Ringwald  * @brief Get Manufactured
148933373e40SMatthias Ringwald  * @return manufacturer id
149033373e40SMatthias Ringwald  */
149133373e40SMatthias Ringwald uint16_t hci_get_manufacturer(void);
149295d71764SMatthias Ringwald 
1493eddac615SMatthias Ringwald /**
1494eddac615SMatthias Ringwald  * Defer halt. Used by btstack_crypto to allow current HCI operation to complete
1495eddac615SMatthias Ringwald  */
1496eddac615SMatthias Ringwald void hci_halting_defer(void);
1497eddac615SMatthias Ringwald 
149895d71764SMatthias Ringwald // Only for PTS testing
149995d71764SMatthias Ringwald 
150095d71764SMatthias Ringwald /**
150195d71764SMatthias Ringwald  * Disable automatic L2CAP disconnect if no L2CAP connection is established
150295d71764SMatthias Ringwald  */
150395d71764SMatthias Ringwald void hci_disable_l2cap_timeout_check(void);
150495d71764SMatthias Ringwald 
1505ec111c8bSMatthias Ringwald /**
1506b4eb4420SMatthias Ringwald  *  Get Classic Allow Role Switch param
1507b4eb4420SMatthias Ringwald  */
1508b4eb4420SMatthias Ringwald uint8_t hci_get_allow_role_switch(void);
1509b4eb4420SMatthias Ringwald 
1510b4eb4420SMatthias Ringwald /**
1511ec111c8bSMatthias Ringwald  * Get state
1512ec111c8bSMatthias Ringwald  */
1513ec111c8bSMatthias Ringwald HCI_STATE hci_get_state(void);
1514ec111c8bSMatthias Ringwald 
15154688f216SMatthias Ringwald /**
15164688f216SMatthias Ringwald  * @brief De-Init HCI
15174688f216SMatthias Ringwald  */
15184688f216SMatthias Ringwald void hci_deinit(void);
15194688f216SMatthias Ringwald 
152018976c74SMatthias Ringwald // setup test connections, used for fuzzing
152118976c74SMatthias Ringwald void hci_setup_test_connections_fuzz(void);
152218976c74SMatthias Ringwald 
1523eddac615SMatthias Ringwald // free all connections, used for fuzzing
1524eddac615SMatthias Ringwald void hci_free_connections_fuzz(void);
1525beceeddeSMatthias Ringwald 
15261470db0cSMatthias Ringwald // simulate stack bootup
15271470db0cSMatthias Ringwald void hci_simulate_working_fuzz(void);
15281470db0cSMatthias Ringwald 
152921debf25SMatthias Ringwald 
1530e3b6fe7eSmatthias.ringwald #if defined __cplusplus
1531e3b6fe7eSmatthias.ringwald }
1532e3b6fe7eSmatthias.ringwald #endif
1533f471afd8S[email protected] 
153480e33422SMatthias Ringwald #endif // HCI_H
1535