xref: /btstack/src/hci.h (revision ec6321ee39469b8acf366e0cfc0bcd0c86f1a539)
11f504dbdSmatthias.ringwald /*
26b64433eSmatthias.ringwald  * Copyright (C) 2009-2012 by Matthias Ringwald
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  *
201713bceaSmatthias.ringwald  * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD 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
231713bceaSmatthias.ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
241713bceaSmatthias.ringwald  * RINGWALD 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  *
336b64433eSmatthias.ringwald  * Please inquire about commercial licensing options at [email protected]
346b64433eSmatthias.ringwald  *
351713bceaSmatthias.ringwald  */
361713bceaSmatthias.ringwald 
371713bceaSmatthias.ringwald /*
381f504dbdSmatthias.ringwald  *  hci.h
391f504dbdSmatthias.ringwald  *
401f504dbdSmatthias.ringwald  *  Created by Matthias Ringwald on 4/29/09.
411f504dbdSmatthias.ringwald  *
421f504dbdSmatthias.ringwald  */
431f504dbdSmatthias.ringwald 
44f471afd8S[email protected] #ifndef __HCI_H
45f471afd8S[email protected] #define __HCI_H
461f504dbdSmatthias.ringwald 
47bde315ceS[email protected] #include "btstack-config.h"
4836a5e735Smatthias.ringwald 
4923053b9eSmatthias.ringwald #include <btstack/hci_cmds.h>
5023053b9eSmatthias.ringwald #include <btstack/utils.h>
51ba681a6cSmatthias.ringwald #include "hci_transport.h"
52ba681a6cSmatthias.ringwald #include "bt_control.h"
5329d53098Smatthias.ringwald #include "remote_device_db.h"
54ba681a6cSmatthias.ringwald 
5593b8dc03Smatthias.ringwald #include <stdint.h>
5602ea9861Smatthias.ringwald #include <stdlib.h>
571cd208adSmatthias.ringwald #include <stdarg.h>
58da886c03S[email protected] #include <btstack/linked_list.h>
5993b8dc03Smatthias.ringwald 
60e3b6fe7eSmatthias.ringwald #if defined __cplusplus
61e3b6fe7eSmatthias.ringwald extern "C" {
62e3b6fe7eSmatthias.ringwald #endif
63e3b6fe7eSmatthias.ringwald 
6436a5e735Smatthias.ringwald // packet header sizes
6536a5e735Smatthias.ringwald #define HCI_CMD_HEADER_SIZE          3
6636a5e735Smatthias.ringwald #define HCI_ACL_HEADER_SIZE   	     4
6736a5e735Smatthias.ringwald #define HCI_SCO_HEADER_SIZE  	     3
6836a5e735Smatthias.ringwald #define HCI_EVENT_HEADER_SIZE        2
6980d52d6bSmatthias.ringwald 
7028ee662eSmatthias.ringwald // packet sizes (max payload)
7128ee662eSmatthias.ringwald #define HCI_ACL_DM1_SIZE            17
7228ee662eSmatthias.ringwald #define HCI_ACL_DH1_SIZE            27
7328ee662eSmatthias.ringwald #define HCI_ACL_2DH1_SIZE           54
7428ee662eSmatthias.ringwald #define HCI_ACL_3DH1_SIZE           83
7528ee662eSmatthias.ringwald #define HCI_ACL_DM3_SIZE           121
7628ee662eSmatthias.ringwald #define HCI_ACL_DH3_SIZE           183
7728ee662eSmatthias.ringwald #define HCI_ACL_DM5_SIZE           224
7811c41d51Smatthias.ringwald #define HCI_ACL_DH5_SIZE           339
7928ee662eSmatthias.ringwald #define HCI_ACL_2DH3_SIZE          367
8028ee662eSmatthias.ringwald #define HCI_ACL_3DH3_SIZE          552
811d93f560Smatthias.ringwald #define HCI_ACL_2DH5_SIZE          679
8228ee662eSmatthias.ringwald #define HCI_ACL_3DH5_SIZE         1021
8311c41d51Smatthias.ringwald 
8436a5e735Smatthias.ringwald #define HCI_EVENT_PAYLOAD_SIZE     255
8536a5e735Smatthias.ringwald #define HCI_CMD_PAYLOAD_SIZE       255
8636a5e735Smatthias.ringwald 
8736a5e735Smatthias.ringwald // packet buffer sizes
8836a5e735Smatthias.ringwald // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h
8936a5e735Smatthias.ringwald #define HCI_EVENT_BUFFER_SIZE      (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE)
9036a5e735Smatthias.ringwald #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE)
9136a5e735Smatthias.ringwald #define HCI_ACL_BUFFER_SIZE        (HCI_ACL_HEADER_SIZE   + HCI_ACL_PAYLOAD_SIZE)
9236a5e735Smatthias.ringwald 
9336a5e735Smatthias.ringwald // size of hci buffers, big enough for command, event, or acl packet without H4 packet type
9436a5e735Smatthias.ringwald // @note cmd buffer is bigger than event buffer
9525c5e985S[email protected] #ifdef HCI_PACKET_BUFFER_SIZE
9625c5e985S[email protected]     #if HCI_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
9725c5e985S[email protected]         #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
9825c5e985S[email protected]     #endif
9925c5e985S[email protected]     #if HCI_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE
10025c5e985S[email protected]         #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE
10125c5e985S[email protected]     #endif
10225c5e985S[email protected] #else
10336a5e735Smatthias.ringwald     #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE
10436a5e735Smatthias.ringwald         #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
10536a5e735Smatthias.ringwald     #else
1067f3162b2Smatthias.ringwald         #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE
10736a5e735Smatthias.ringwald     #endif
10823ac0743Smatthias.ringwald #endif
10928c93ceeSmatthias.ringwald 
11060da618dS[email protected] // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA
11160da618dS[email protected] #define HCI_OUTGOING_PRE_BUFFER_SIZE 1
11260da618dS[email protected] 
113*ec6321eeS[email protected] // BNEP may uncompress the IP Header by 16 bytes
114*ec6321eeS[email protected] #ifdef HAVE_BNEP
115*ec6321eeS[email protected] #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4)
116*ec6321eeS[email protected] #endif
117b34233c3S[email protected] #ifndef HCI_INCOMING_PRE_BUFFER_SIZE
118b34233c3S[email protected]     #define HCI_INCOMING_PRE_BUFFER_SIZE 0
119b34233c3S[email protected] #endif
120b34233c3S[email protected] 
121945627e4Smatthias.ringwald // OGFs
122945627e4Smatthias.ringwald #define OGF_LINK_CONTROL          0x01
123d59f499aSmatthias.ringwald #define OGF_LINK_POLICY           0x02
124945627e4Smatthias.ringwald #define OGF_CONTROLLER_BASEBAND   0x03
125945627e4Smatthias.ringwald #define OGF_INFORMATIONAL_PARAMETERS 0x04
126fdf1d293S[email protected] #define OGF_STATUS_PARAMETERS     0x05
127da75afa9Smatthias.ringwald #define OGF_LE_CONTROLLER 0x08
128945627e4Smatthias.ringwald #define OGF_BTSTACK 0x3d
129945627e4Smatthias.ringwald #define OGF_VENDOR  0x3f
13080d52d6bSmatthias.ringwald 
13180d52d6bSmatthias.ringwald // cmds for BTstack
13280d52d6bSmatthias.ringwald // get state: @returns HCI_STATE
13380d52d6bSmatthias.ringwald #define BTSTACK_GET_STATE                                  0x01
13480d52d6bSmatthias.ringwald 
13580d52d6bSmatthias.ringwald // set power mode: @param HCI_POWER_MODE
13680d52d6bSmatthias.ringwald #define BTSTACK_SET_POWER_MODE                             0x02
13780d52d6bSmatthias.ringwald 
13880d52d6bSmatthias.ringwald // set capture mode: @param on
13980d52d6bSmatthias.ringwald #define BTSTACK_SET_ACL_CAPTURE_MODE                       0x03
14080d52d6bSmatthias.ringwald 
1411b0e3922Smatthias.ringwald // get BTstack version
1421b0e3922Smatthias.ringwald #define BTSTACK_GET_VERSION                                0x04
1431b0e3922Smatthias.ringwald 
1442ed6235cSmatthias.ringwald // get system Bluetooth state
1452ed6235cSmatthias.ringwald #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED               0x05
1462ed6235cSmatthias.ringwald 
1472ed6235cSmatthias.ringwald // set system Bluetooth state
1482ed6235cSmatthias.ringwald #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED               0x06
1492ed6235cSmatthias.ringwald 
150381fbed8Smatthias.ringwald // enable inquiry scan for this client
151381fbed8Smatthias.ringwald #define BTSTACK_SET_DISCOVERABLE                           0x07
152381fbed8Smatthias.ringwald 
1533c4d4b90Smatthias.ringwald // set global Bluetooth state
1543c4d4b90Smatthias.ringwald #define BTSTACK_SET_BLUETOOTH_ENABLED                      0x08
1553c4d4b90Smatthias.ringwald 
15680d52d6bSmatthias.ringwald // create l2cap channel: @param bd_addr(48), psm (16)
15780d52d6bSmatthias.ringwald #define L2CAP_CREATE_CHANNEL                               0x20
15880d52d6bSmatthias.ringwald 
15980d52d6bSmatthias.ringwald // disconnect l2cap disconnect, @param channel(16), reason(8)
16080d52d6bSmatthias.ringwald #define L2CAP_DISCONNECT                                   0x21
16180d52d6bSmatthias.ringwald 
162116ee617Smatthias.ringwald // register l2cap service: @param psm(16), mtu (16)
163116ee617Smatthias.ringwald #define L2CAP_REGISTER_SERVICE                             0x22
164116ee617Smatthias.ringwald 
165116ee617Smatthias.ringwald // unregister l2cap disconnect, @param psm(16)
166116ee617Smatthias.ringwald #define L2CAP_UNREGISTER_SERVICE                           0x23
167116ee617Smatthias.ringwald 
168116ee617Smatthias.ringwald // accept connection @param bd_addr(48), dest cid (16)
169116ee617Smatthias.ringwald #define L2CAP_ACCEPT_CONNECTION                            0x24
170116ee617Smatthias.ringwald 
171116ee617Smatthias.ringwald // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8)
172116ee617Smatthias.ringwald #define L2CAP_DECLINE_CONNECTION                           0x25
173116ee617Smatthias.ringwald 
17415470d27Smatthias.ringwald // create l2cap channel: @param bd_addr(48), psm (16), mtu (16)
17515470d27Smatthias.ringwald #define L2CAP_CREATE_CHANNEL_MTU                           0x26
17615470d27Smatthias.ringwald 
17706d7e47eSmatthias.ringwald // register SDP Service Record: service record (size)
17806d7e47eSmatthias.ringwald #define SDP_REGISTER_SERVICE_RECORD                        0x30
17906d7e47eSmatthias.ringwald 
18006d7e47eSmatthias.ringwald // unregister SDP Service Record
18106d7e47eSmatthias.ringwald #define SDP_UNREGISTER_SERVICE_RECORD                      0x31
18206d7e47eSmatthias.ringwald 
1836989e7aaS[email protected] // Get remote RFCOMM services
1846989e7aaS[email protected] #define SDP_CLIENT_QUERY_RFCOMM_SERVICES                   0x32
1856989e7aaS[email protected] 
18612fb62f7S[email protected] // Get remote SDP services
18712fb62f7S[email protected] #define SDP_CLIENT_QUERY_SERVICES                          0x33
18812fb62f7S[email protected] 
189e115bf24Smatthias.ringwald // RFCOMM "HCI" Commands
190e115bf24Smatthias.ringwald #define RFCOMM_CREATE_CHANNEL       0x40
191e115bf24Smatthias.ringwald #define RFCOMM_DISCONNECT			0x41
192e115bf24Smatthias.ringwald #define RFCOMM_REGISTER_SERVICE     0x42
193e115bf24Smatthias.ringwald #define RFCOMM_UNREGISTER_SERVICE   0x43
194e115bf24Smatthias.ringwald #define RFCOMM_ACCEPT_CONNECTION    0x44
195e115bf24Smatthias.ringwald #define RFCOMM_DECLINE_CONNECTION   0x45
196933d8a80Smatthias.ringwald #define RFCOMM_PERSISTENT_CHANNEL   0x46
197678847afSmatthias.ringwald #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS   0x47
198678847afSmatthias.ringwald #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48
199678847afSmatthias.ringwald #define RFCOMM_GRANT_CREDITS                 0x49
20006d7e47eSmatthias.ringwald 
2012b552b23S[email protected] // GAP Classic 0x50
2022b552b23S[email protected] #define GAP_DISCONNECT              0x50
2032b552b23S[email protected] 
2042b552b23S[email protected] // GAP LE      0x60
2052b552b23S[email protected] #define GAP_LE_SCAN_START           0x60
2062b552b23S[email protected] #define GAP_LE_SCAN_STOP            0x61
2072b552b23S[email protected] #define GAP_LE_CONNECT              0x62
208e31f89a7S[email protected] #define GAP_LE_CONNECT_CANCEL       0x63
2090fdde038Smatthias.ringwald #define GAP_LE_SET_SCAN_PARAMETERS  0x64
2102b552b23S[email protected] 
2112b552b23S[email protected] // GATT (Client) 0x70
21290f3290fS[email protected] #define GATT_DISCOVER_ALL_PRIMARY_SERVICES                       0x70
21390f3290fS[email protected] #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID16                 0x71
21490f3290fS[email protected] #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID128                0x72
21590f3290fS[email protected] #define GATT_FIND_INCLUDED_SERVICES_FOR_SERVICE                  0x73
21690f3290fS[email protected] #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE                0x74
21790f3290fS[email protected] #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE_BY_UUID128     0x75
2180ef97525S[email protected] #define GATT_DISCOVER_CHARACTERISTIC_DESCRIPTORS                 0x76
21990f3290fS[email protected] #define GATT_READ_VALUE_OF_CHARACTERISTIC                        0x77
22090f3290fS[email protected] #define GATT_READ_LONG_VALUE_OF_CHARACTERISTIC                   0x78
22190f3290fS[email protected] #define GATT_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE      0x79
22290f3290fS[email protected] #define GATT_WRITE_VALUE_OF_CHARACTERISTIC                       0x7A
22390f3290fS[email protected] #define GATT_WRITE_LONG_VALUE_OF_CHARACTERISTIC                  0x7B
22490f3290fS[email protected] #define GATT_RELIABLE_WRITE_LONG_VALUE_OF_CHARACTERISTIC         0x7C
22590f3290fS[email protected] #define GATT_READ_CHARACTERISTIC_DESCRIPTOR                      0X7D
22690f3290fS[email protected] #define GATT_READ_LONG_CHARACTERISTIC_DESCRIPTOR                 0X7E
22790f3290fS[email protected] #define GATT_WRITE_CHARACTERISTIC_DESCRIPTOR                     0X7F
22890f3290fS[email protected] #define GATT_WRITE_LONG_CHARACTERISTIC_DESCRIPTOR                0X80
22990f3290fS[email protected] #define GATT_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION           0X81
2302b552b23S[email protected] 
23180d52d6bSmatthias.ringwald //
23280d52d6bSmatthias.ringwald #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode)
23380d52d6bSmatthias.ringwald 
234945627e4Smatthias.ringwald // data: event(8)
235d8293395Smatthias.ringwald #define DAEMON_EVENT_CONNECTION_OPENED                     0x50
23627d86fbbSmatthias.ringwald 
23727d86fbbSmatthias.ringwald // data: event(8)
238d8293395Smatthias.ringwald #define DAEMON_EVENT_CONNECTION_CLOSED                     0x51
239945627e4Smatthias.ringwald 
240945627e4Smatthias.ringwald // data: event(8), nr_connections(8)
241d8293395Smatthias.ringwald #define DAEMON_NR_CONNECTIONS_CHANGED                      0x52
24227d86fbbSmatthias.ringwald 
243bf8dada5Smatthias.ringwald // data: event(8)
244d8293395Smatthias.ringwald #define DAEMON_EVENT_NEW_RFCOMM_CREDITS                    0x53
245d8293395Smatthias.ringwald 
2463ad83cc6S[email protected] // data: event(8)
247d8293395Smatthias.ringwald #define DAEMON_EVENT_HCI_PACKET_SENT                       0x54
248945627e4Smatthias.ringwald 
24906b35ec0Smatthias.ringwald /**
250da886c03S[email protected]  * LE connection parameter update state
251da886c03S[email protected]  */
252da886c03S[email protected] 
253da886c03S[email protected] typedef enum {
254da886c03S[email protected]     CON_PARAMETER_UPDATE_NONE,
255da886c03S[email protected]     CON_PARAMETER_UPDATE_SEND_RESPONSE,
256da886c03S[email protected]     CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS,
257da886c03S[email protected]     CON_PARAMETER_UPDATE_DENY
258da886c03S[email protected] } le_con_parameter_update_state_t;
259da886c03S[email protected] 
260da886c03S[email protected] typedef struct le_connection_parameter_range{
261da886c03S[email protected]     uint16_t le_conn_interval_min;
262da886c03S[email protected]     uint16_t le_conn_interval_max;
263da886c03S[email protected]     uint16_t le_conn_latency_min;
264da886c03S[email protected]     uint16_t le_conn_latency_max;
265da886c03S[email protected]     uint16_t le_supervision_timeout_min;
266da886c03S[email protected]     uint16_t le_supervision_timeout_max;
267da886c03S[email protected] } le_connection_parameter_range_t;
268da886c03S[email protected] 
2690414dabdS[email protected] // Authentication flags
270c01e9cbdSmatthias.ringwald typedef enum {
271dbe1a790S[email protected]     AUTH_FLAGS_NONE                = 0x0000,
272dbe1a790S[email protected]     RECV_LINK_KEY_REQUEST          = 0x0001,
273dbe1a790S[email protected]     HANDLE_LINK_KEY_REQUEST        = 0x0002,
274dbe1a790S[email protected]     SENT_LINK_KEY_REPLY            = 0x0004,
275dbe1a790S[email protected]     SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008,
276dbe1a790S[email protected]     RECV_LINK_KEY_NOTIFICATION     = 0x0010,
277899283eaS[email protected]     DENY_PIN_CODE_REQUEST          = 0x0040,
278f0944df2S[email protected]     RECV_IO_CAPABILITIES_REQUEST   = 0x0080,
279f0944df2S[email protected]     SEND_IO_CAPABILITIES_REPLY     = 0x0100,
2806724cd9eS[email protected]     SEND_USER_CONFIRM_REPLY        = 0x0200,
2816724cd9eS[email protected]     SEND_USER_PASSKEY_REPLY        = 0x0400,
2826724cd9eS[email protected] 
2836724cd9eS[email protected]     // pairing status
2846724cd9eS[email protected]     LEGACY_PAIRING_ACTIVE          = 0x2000,
2856724cd9eS[email protected]     SSP_PAIRING_ACTIVE             = 0x4000,
286536f9994S[email protected] 
287f0944df2S[email protected]     // connection status
2886724cd9eS[email protected]     CONNECTION_ENCRYPTED           = 0x8000,
2897fde4af9Smatthias.ringwald } hci_authentication_flags_t;
290c01e9cbdSmatthias.ringwald 
2910414dabdS[email protected] /**
2920414dabdS[email protected]  * Connection State
2930414dabdS[email protected]  */
294c8e4258aSmatthias.ringwald typedef enum {
295ad83dc6aS[email protected]     SEND_CREATE_CONNECTION = 0,
296ad83dc6aS[email protected]     SENT_CREATE_CONNECTION,
2970bf6344aS[email protected]     SEND_CANCEL_CONNECTION,
2980bf6344aS[email protected]     SENT_CANCEL_CONNECTION,
299c8e4258aSmatthias.ringwald     RECEIVED_CONNECTION_REQUEST,
300c8e4258aSmatthias.ringwald     ACCEPTED_CONNECTION_REQUEST,
301c8e4258aSmatthias.ringwald     REJECTED_CONNECTION_REQUEST,
302c8e4258aSmatthias.ringwald     OPEN,
3035917a5c5S[email protected]     SEND_DISCONNECT,
304c8e4258aSmatthias.ringwald     SENT_DISCONNECT
305c8e4258aSmatthias.ringwald } CONNECTION_STATE;
306c8e4258aSmatthias.ringwald 
3070414dabdS[email protected] // bonding flags
3080414dabdS[email protected] enum {
309afd4e962S[email protected]     BONDING_REQUEST_REMOTE_FEATURES   = 0x01,
310afd4e962S[email protected]     BONDING_RECEIVED_REMOTE_FEATURES  = 0x02,
311afd4e962S[email protected]     BONDING_REMOTE_SUPPORTS_SSP       = 0x04,
3122bd8b7e7S[email protected]     BONDING_DISCONNECT_SECURITY_BLOCK = 0x08,
313ad83dc6aS[email protected]     BONDING_DISCONNECT_DEDICATED_DONE = 0x10,
314ad83dc6aS[email protected]     BONDING_SEND_AUTHENTICATE_REQUEST = 0x20,
315ad83dc6aS[email protected]     BONDING_SEND_ENCRYPTION_REQUEST   = 0x40,
316ad83dc6aS[email protected]     BONDING_DEDICATED                 = 0x80,
3171bd5283dS[email protected]     BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100
3180414dabdS[email protected] };
319afd4e962S[email protected] 
320afd4e962S[email protected] typedef enum {
32143bfb1bdSmatthias.ringwald     BLUETOOTH_OFF = 1,
32243bfb1bdSmatthias.ringwald     BLUETOOTH_ON,
32343bfb1bdSmatthias.ringwald     BLUETOOTH_ACTIVE
32443bfb1bdSmatthias.ringwald } BLUETOOTH_STATE;
32543bfb1bdSmatthias.ringwald 
3267bdc6798S[email protected] // le central scanning state
3277bdc6798S[email protected] typedef enum {
3287bdc6798S[email protected]     LE_SCAN_IDLE,
3297bdc6798S[email protected]     LE_START_SCAN,
3307bdc6798S[email protected]     LE_SCANNING,
3317bdc6798S[email protected]     LE_STOP_SCAN,
3327bdc6798S[email protected] } le_scanning_state_t;
3337bdc6798S[email protected] 
3344f3229d8S[email protected] 
335c8e4258aSmatthias.ringwald typedef struct {
33606b35ec0Smatthias.ringwald     // linked list - assert: first field
33706b35ec0Smatthias.ringwald     linked_item_t    item;
338c01e9cbdSmatthias.ringwald 
339c01e9cbdSmatthias.ringwald     // remote side
34016833f0aSmatthias.ringwald     bd_addr_t address;
34106b35ec0Smatthias.ringwald 
34206b35ec0Smatthias.ringwald     // module handle
34316833f0aSmatthias.ringwald     hci_con_handle_t con_handle;
344c01e9cbdSmatthias.ringwald 
34596a45072S[email protected]     // le public, le random, classic
34696a45072S[email protected]     bd_addr_type_t address_type;
34796a45072S[email protected] 
348afd4e962S[email protected]     // connection state
349c8e4258aSmatthias.ringwald     CONNECTION_STATE state;
350c8e4258aSmatthias.ringwald 
351afd4e962S[email protected]     // bonding
3527bdc6798S[email protected]     uint16_t bonding_flags;
3531bd5283dS[email protected]     uint8_t  bonding_status;
35434d2123cS[email protected]     // requested security level
35534d2123cS[email protected]     gap_security_level_t requested_security_level;
35634d2123cS[email protected] 
3579ab95c90S[email protected]     //
3589ab95c90S[email protected]     link_key_type_t link_key_type;
3599ab95c90S[email protected] 
36006b35ec0Smatthias.ringwald     // errands
3617bdc6798S[email protected]     uint32_t authentication_flags;
362c8e4258aSmatthias.ringwald 
363c785ef68Smatthias.ringwald     timer_source_t timeout;
364c785ef68Smatthias.ringwald 
3650bece81eSmatthias.ringwald #ifdef HAVE_TIME
366ee091cf1Smatthias.ringwald     // timer
367ee091cf1Smatthias.ringwald     struct timeval timestamp;
3680bece81eSmatthias.ringwald #endif
369e5780900Smatthias.ringwald #ifdef HAVE_TICK
370e1d41216Smatthias.ringwald     uint32_t timestamp; // timeout in system ticks
371c785ef68Smatthias.ringwald #endif
372ee091cf1Smatthias.ringwald 
373*ec6321eeS[email protected]     // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload
374*ec6321eeS[email protected]     uint8_t  acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE];
375c1012e46Smatthias.ringwald     uint16_t acl_recombination_pos;
376d55db49eSmatthias.ringwald     uint16_t acl_recombination_length;
377d55db49eSmatthias.ringwald 
37856cf178bSmatthias.ringwald     // number ACL packets sent to controller
37956cf178bSmatthias.ringwald     uint8_t num_acl_packets_sent;
380c37a3166S[email protected] 
381c37a3166S[email protected]     // connection parameter update
382da886c03S[email protected]     le_con_parameter_update_state_t le_con_parameter_update_state;
383c37a3166S[email protected]     uint16_t le_conn_interval_min;
384c37a3166S[email protected]     uint16_t le_conn_interval_max;
385c37a3166S[email protected]     uint16_t le_conn_latency;
386c37a3166S[email protected]     uint16_t le_supervision_timeout;
387da886c03S[email protected]     uint16_t le_update_con_parameter_response;
38816833f0aSmatthias.ringwald } hci_connection_t;
38916833f0aSmatthias.ringwald 
3904f3229d8S[email protected] 
39106b35ec0Smatthias.ringwald /**
39206b35ec0Smatthias.ringwald  * main data structure
39306b35ec0Smatthias.ringwald  */
39416833f0aSmatthias.ringwald typedef struct {
39506b35ec0Smatthias.ringwald     // transport component with configuration
39616833f0aSmatthias.ringwald     hci_transport_t  * hci_transport;
39711e23e5fSmatthias.ringwald     void             * config;
39811e23e5fSmatthias.ringwald 
399e2386ba1S[email protected]     // bsic configuration
4008e618f72S[email protected]     const char         * local_name;
401e2386ba1S[email protected]     uint32_t           class_of_device;
402e2386ba1S[email protected]     bd_addr_t          local_bd_addr;
403a45d6b9fS[email protected]     uint8_t            ssp_enable;
404a45d6b9fS[email protected]     uint8_t            ssp_io_capability;
405a45d6b9fS[email protected]     uint8_t            ssp_authentication_requirement;
4061d6b20aeS[email protected]     uint8_t            ssp_auto_accept;
407e2386ba1S[email protected] 
40806b35ec0Smatthias.ringwald     // hardware power controller
40906b35ec0Smatthias.ringwald     bt_control_t     * control;
41006b35ec0Smatthias.ringwald 
41106b35ec0Smatthias.ringwald     // list of existing baseband connections
412fe1ed1b8Smatthias.ringwald     linked_list_t     connections;
41316833f0aSmatthias.ringwald 
41460da618dS[email protected]     // single buffer for HCI packet assembly + additional prebuffer for H4 drivers
41560da618dS[email protected]     uint8_t   hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE];
41636a5e735Smatthias.ringwald     uint8_t   hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8)
4176b4af23dS[email protected]     uint8_t   hci_packet_buffer_reserved;
418452cf3bbS[email protected]     uint16_t  acl_fragmentation_pos;
419452cf3bbS[email protected]     uint16_t  acl_fragmentation_total_size;
42006b35ec0Smatthias.ringwald 
42116833f0aSmatthias.ringwald     /* host to controller flow control */
42216833f0aSmatthias.ringwald     uint8_t  num_cmd_packets;
423e2edc0c3Smatthias.ringwald     // uint8_t  total_num_cmd_packets;
424ee303eddS[email protected]     uint8_t  acl_packets_total_num;
425e2edc0c3Smatthias.ringwald     uint16_t acl_data_packet_length;
426ee303eddS[email protected]     uint8_t  le_acl_packets_total_num;
427ee303eddS[email protected]     uint16_t le_data_packets_length;
42816833f0aSmatthias.ringwald 
429559e517eS[email protected]     /* local supported features */
430559e517eS[email protected]     uint8_t local_supported_features[8];
431559e517eS[email protected] 
4328f8108aaSmatthias.ringwald     // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE
4338f8108aaSmatthias.ringwald     uint16_t packet_types;
4348f8108aaSmatthias.ringwald 
43516833f0aSmatthias.ringwald     /* callback to L2CAP layer */
4362718e2e7Smatthias.ringwald     void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size);
43716833f0aSmatthias.ringwald 
43829d53098Smatthias.ringwald     /* remote device db */
4394f4fc1dfSmatthias.ringwald     remote_device_db_t const*remote_device_db;
44029d53098Smatthias.ringwald 
4413429f56bSmatthias.ringwald     /* hci state machine */
4423429f56bSmatthias.ringwald     HCI_STATE state;
4433429f56bSmatthias.ringwald     uint8_t   substate;
4443429f56bSmatthias.ringwald     uint8_t   cmds_ready;
4453429f56bSmatthias.ringwald 
4465127cc62S[email protected]     uint16_t  last_cmd_opcode;
4475127cc62S[email protected] 
448381fbed8Smatthias.ringwald     uint8_t   discoverable;
449758b46ceSmatthias.ringwald     uint8_t   connectable;
450458bf4e8S[email protected]     uint8_t   bondable;
4513dbb95f9Smatthias.ringwald 
452b031bebbSmatthias.ringwald     /* buffer for scan enable cmd - 0xff no change */
453b031bebbSmatthias.ringwald     uint8_t   new_scan_enable_value;
454b031bebbSmatthias.ringwald 
4553dbb95f9Smatthias.ringwald     // buffer for single connection decline
4563dbb95f9Smatthias.ringwald     uint8_t   decline_reason;
4573dbb95f9Smatthias.ringwald     bd_addr_t decline_addr;
458381fbed8Smatthias.ringwald 
45969a97523S[email protected]     uint8_t   adv_addr_type;
46069a97523S[email protected]     bd_addr_t adv_address;
461e2602ea2Smatthias.ringwald 
4627bdc6798S[email protected]     le_scanning_state_t le_scanning_state;
463e2602ea2Smatthias.ringwald 
464e2602ea2Smatthias.ringwald     // buffer for le scan type command - 0xff not set
465e2602ea2Smatthias.ringwald     uint8_t  le_scan_type;
466e2602ea2Smatthias.ringwald     uint16_t le_scan_interval;
467e2602ea2Smatthias.ringwald     uint16_t le_scan_window;
468da886c03S[email protected] 
469da886c03S[email protected]     le_connection_parameter_range_t le_connection_parameter_range;
47016833f0aSmatthias.ringwald } hci_stack_t;
47116833f0aSmatthias.ringwald 
472da886c03S[email protected] /**
473da886c03S[email protected]  * set connection iterator
474da886c03S[email protected]  */
475da886c03S[email protected] void hci_connections_get_iterator(linked_list_iterator_t *it);
476da886c03S[email protected] 
477da886c03S[email protected] le_connection_parameter_range_t gap_le_get_connection_parameter_range();
478da886c03S[email protected] void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range);
479da886c03S[email protected] 
4807bdc6798S[email protected] // *************** le client start
4817bdc6798S[email protected] 
4823ad83cc6S[email protected] le_command_status_t le_central_start_scan(void);
4833ad83cc6S[email protected] le_command_status_t le_central_stop_scan(void);
4844f3229d8S[email protected] le_command_status_t le_central_connect(bd_addr_t * addr, bd_addr_type_t addr_type);
4853ad83cc6S[email protected] le_command_status_t le_central_connect_cancel(void);
4865917a5c5S[email protected] le_command_status_t gap_disconnect(hci_con_handle_t handle);
487ef11999fSmatthias.ringwald void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window);
4887bdc6798S[email protected] 
4897bdc6798S[email protected] // *************** le client end
4907bdc6798S[email protected] 
491945627e4Smatthias.ringwald // create and send hci command packets based on a template and a list of parameters
492945627e4Smatthias.ringwald uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...);
493df33c7a6Smatthias.ringwald uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr);
494945627e4Smatthias.ringwald 
495758b46ceSmatthias.ringwald void hci_connectable_control(uint8_t enable);
496e6cc8be2S[email protected] void hci_close(void);
497475c8125Smatthias.ringwald 
4983429f56bSmatthias.ringwald /**
499c8e4258aSmatthias.ringwald  * run the hci control loop once
5003429f56bSmatthias.ringwald  */
50169415922Smatthias.ringwald void hci_run(void);
5021f504dbdSmatthias.ringwald 
503d8905019Smatthias.ringwald // send complete CMD packet
50449857181Smatthias.ringwald int hci_send_cmd_packet(uint8_t *packet, int size);
505554588a5Smatthias.ringwald 
506826f7347S[email protected] // send ACL packet prepared in hci packet buffer
507826f7347S[email protected] int hci_send_acl_packet_buffer(int size);
50806b35ec0Smatthias.ringwald 
509ac928cc2S[email protected] // new functions replacing hci_can_send_packet_now[_using_packet_buffer]
510ac928cc2S[email protected] int hci_can_send_command_packet_now(void);
511ac928cc2S[email protected] int hci_can_send_acl_packet_now(hci_con_handle_t con_handle);
512ac928cc2S[email protected] int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle);
513ac928cc2S[email protected] 
514c24735b1Smatthias.ringwald // non-blocking UART driver needs
515ac928cc2S[email protected] // @deprecated use hci_can_send_X_now instead
516c24735b1Smatthias.ringwald int hci_can_send_packet_now(uint8_t packet_type);
517c24735b1Smatthias.ringwald 
5186b4af23dS[email protected] // same as hci_can_send_packet_now, but also checks if packet buffer is free for use
519ac928cc2S[email protected] // @deprecated use hci_can_send_X_now instead
5206b4af23dS[email protected] int hci_can_send_packet_now_using_packet_buffer(uint8_t packet_type);
5216b4af23dS[email protected] 
5226b4af23dS[email protected] // reserves outgoing packet buffer. @returns 1 if successful
5236b4af23dS[email protected] int  hci_reserve_packet_buffer(void);
52468a0fcf7S[email protected] void hci_release_packet_buffer(void);
5256b4af23dS[email protected] 
526c8b9416aS[email protected] // used for internal checks in l2cap[-le].c
527c8b9416aS[email protected] int hci_is_packet_buffer_reserved(void);
528c8b9416aS[email protected] 
5296b4af23dS[email protected] // get point to packet buffer
530facf93fdS[email protected] uint8_t* hci_get_outgoing_packet_buffer(void);
5316b4af23dS[email protected] 
5325061f3afS[email protected] bd_addr_t * hci_local_bd_addr(void);
5335061f3afS[email protected] hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle);
53496a45072S[email protected] hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t *addr, bd_addr_type_t addr_type);
5350bf6344aS[email protected] int hci_is_le_connection(hci_connection_t * connection);
536998906cdSmatthias.ringwald uint8_t  hci_number_outgoing_packets(hci_con_handle_t handle);
537e79abdd6S[email protected] uint8_t  hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle);
53880ca58a0Smatthias.ringwald int      hci_authentication_active_for_handle(hci_con_handle_t handle);
53969415922Smatthias.ringwald uint16_t hci_max_acl_data_packet_length(void);
5406c26b087S[email protected] uint16_t hci_max_acl_le_data_packet_length(void);
5418f8108aaSmatthias.ringwald uint16_t hci_usable_acl_packet_types(void);
5426ac9a97eS[email protected] int      hci_non_flushable_packet_boundary_flag_supported(void);
54304a6ef8cSmatthias.ringwald 
5443ad83cc6S[email protected] void hci_disconnect_all(void);
54504a6ef8cSmatthias.ringwald 
54669415922Smatthias.ringwald void hci_emit_state(void);
54717f1ba2aSmatthias.ringwald void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status);
548ee091cf1Smatthias.ringwald void hci_emit_l2cap_check_timeout(hci_connection_t *conn);
5493c4d4b90Smatthias.ringwald void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason);
55069415922Smatthias.ringwald void hci_emit_nr_connections_changed(void);
55169415922Smatthias.ringwald void hci_emit_hci_open_failed(void);
55269415922Smatthias.ringwald void hci_emit_btstack_version(void);
5532ed6235cSmatthias.ringwald void hci_emit_system_bluetooth_enabled(uint8_t enabled);
554627c2f45Smatthias.ringwald void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name);
555381fbed8Smatthias.ringwald void hci_emit_discoverable_enabled(uint8_t enabled);
556a00031e2S[email protected] void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level);
5571bd5283dS[email protected] void hci_emit_dedicated_bonding_result(bd_addr_t address, uint8_t status);
558e3b6fe7eSmatthias.ringwald 
5592bd8b7e7S[email protected] // query if remote side supports SSP
5602bd8b7e7S[email protected] // query if the local side supports SSP
5613ad83cc6S[email protected] int hci_local_ssp_activated(void);
5622bd8b7e7S[email protected] 
5632bd8b7e7S[email protected] // query if the remote side supports SSP
5642bd8b7e7S[email protected] int hci_remote_ssp_supported(hci_con_handle_t con_handle);
5652bd8b7e7S[email protected] 
566df3354fcS[email protected] // query if both sides support SSP
567df3354fcS[email protected] int hci_ssp_supported_on_both_sides(hci_con_handle_t handle);
568df3354fcS[email protected] 
56966fb9560S[email protected] // disable automatic l2cap disconnect for testing
5703ad83cc6S[email protected] void hci_disable_l2cap_timeout_check(void);
571df3354fcS[email protected] 
5722bd8b7e7S[email protected] // disconnect because of security block
5732bd8b7e7S[email protected] void hci_disconnect_security_block(hci_con_handle_t con_handle);
574e6cc8be2S[email protected] 
575e6cc8be2S[email protected] /** Embedded API **/
576e6cc8be2S[email protected] 
5779e61646fS[email protected] // Set up HCI. Needs to be called before any other function
578e6cc8be2S[email protected] void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db);
579e6cc8be2S[email protected] 
5809e61646fS[email protected] // Set class of device that will be set during Bluetooth init
5819e61646fS[email protected] void hci_set_class_of_device(uint32_t class_of_device);
5829e61646fS[email protected] 
583e6cc8be2S[email protected] // Registers a packet handler. Used if L2CAP is not used (rarely).
584e6cc8be2S[email protected] void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size));
585e6cc8be2S[email protected] 
586e6cc8be2S[email protected] // Requests the change of BTstack power mode.
587e6cc8be2S[email protected] int  hci_power_control(HCI_POWER_MODE mode);
588e6cc8be2S[email protected] 
589559e517eS[email protected] // Allows to control if device is discoverable. OFF by default.
590e6cc8be2S[email protected] void hci_discoverable_control(uint8_t enable);
591e6cc8be2S[email protected] 
592dbe1a790S[email protected] // Creates and sends HCI command packets based on a template and
593e6cc8be2S[email protected] // a list of parameters. Will return error if outgoing data buffer
594e6cc8be2S[email protected] // is occupied.
595e6cc8be2S[email protected] int hci_send_cmd(const hci_cmd_t *cmd, ...);
596e6cc8be2S[email protected] 
597e6cc8be2S[email protected] // Deletes link key for remote device with baseband address.
598e6cc8be2S[email protected] void hci_drop_link_key_for_bd_addr(bd_addr_t *addr);
599e6cc8be2S[email protected] 
600dbe1a790S[email protected] // Configure Secure Simple Pairing
601dbe1a790S[email protected] 
602dbe1a790S[email protected] // enable will enable SSP during init
603dbe1a790S[email protected] void hci_ssp_set_enable(int enable);
604dbe1a790S[email protected] 
605dbe1a790S[email protected] // if set, BTstack will respond to io capability request using authentication requirement
606dbe1a790S[email protected] void hci_ssp_set_io_capability(int ssp_io_capability);
607dbe1a790S[email protected] void hci_ssp_set_authentication_requirement(int authentication_requirement);
608dbe1a790S[email protected] 
609dbe1a790S[email protected] // if set, BTstack will confirm a numberic comparion and enter '000000' if requested
610dbe1a790S[email protected] void hci_ssp_set_auto_accept(int auto_accept);
611e6cc8be2S[email protected] 
61269a97523S[email protected] // get addr type and address used in advertisement packets
61318904abdS[email protected] void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t * addr);
61469a97523S[email protected] 
6152bd8b7e7S[email protected] 
616e3b6fe7eSmatthias.ringwald #if defined __cplusplus
617e3b6fe7eSmatthias.ringwald }
618e3b6fe7eSmatthias.ringwald #endif
619f471afd8S[email protected] 
620f471afd8S[email protected] #endif // __HCI_H
621