xref: /btstack/src/hci.h (revision 507d06b8706f343b0b71782ceff40e11246399a7)
1 /*
2  * Copyright (C) 2009-2012 by Matthias Ringwald
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at [email protected]
34  *
35  */
36 
37 /*
38  *  hci.h
39  *
40  *  Created by Matthias Ringwald on 4/29/09.
41  *
42  */
43 
44 #ifndef __HCI_H
45 #define __HCI_H
46 
47 #include "btstack-config.h"
48 
49 #include <btstack/hci_cmds.h>
50 #include <btstack/utils.h>
51 #include "hci_transport.h"
52 #include "bt_control.h"
53 #include "remote_device_db.h"
54 
55 #include <stdint.h>
56 #include <stdlib.h>
57 #include <stdarg.h>
58 #include <btstack/linked_list.h>
59 
60 #if defined __cplusplus
61 extern "C" {
62 #endif
63 
64 // packet header sizes
65 #define HCI_CMD_HEADER_SIZE          3
66 #define HCI_ACL_HEADER_SIZE   	     4
67 #define HCI_SCO_HEADER_SIZE  	     3
68 #define HCI_EVENT_HEADER_SIZE        2
69 
70 // packet sizes (max payload)
71 #define HCI_ACL_DM1_SIZE            17
72 #define HCI_ACL_DH1_SIZE            27
73 #define HCI_ACL_2DH1_SIZE           54
74 #define HCI_ACL_3DH1_SIZE           83
75 #define HCI_ACL_DM3_SIZE           121
76 #define HCI_ACL_DH3_SIZE           183
77 #define HCI_ACL_DM5_SIZE           224
78 #define HCI_ACL_DH5_SIZE           339
79 #define HCI_ACL_2DH3_SIZE          367
80 #define HCI_ACL_3DH3_SIZE          552
81 #define HCI_ACL_2DH5_SIZE          679
82 #define HCI_ACL_3DH5_SIZE         1021
83 
84 #define HCI_EVENT_PAYLOAD_SIZE     255
85 #define HCI_CMD_PAYLOAD_SIZE       255
86 
87 #define LE_ADVERTISING_DATA_SIZE    31
88 
89 // packet buffer sizes
90 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h
91 #define HCI_EVENT_BUFFER_SIZE      (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE)
92 #define HCI_CMD_BUFFER_SIZE        (HCI_CMD_HEADER_SIZE   + HCI_CMD_PAYLOAD_SIZE)
93 #define HCI_ACL_BUFFER_SIZE        (HCI_ACL_HEADER_SIZE   + HCI_ACL_PAYLOAD_SIZE)
94 
95 // size of hci buffers, big enough for command, event, or acl packet without H4 packet type
96 // @note cmd buffer is bigger than event buffer
97 #ifdef HCI_PACKET_BUFFER_SIZE
98     #if HCI_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE
99         #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE
100     #endif
101     #if HCI_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE
102         #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE
103     #endif
104 #else
105     #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE
106         #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE
107     #else
108         #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE
109     #endif
110 #endif
111 
112 // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA
113 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1
114 
115 // BNEP may uncompress the IP Header by 16 bytes
116 #ifdef HAVE_BNEP
117 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4)
118 #endif
119 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE
120     #define HCI_INCOMING_PRE_BUFFER_SIZE 0
121 #endif
122 
123 // OGFs
124 #define OGF_LINK_CONTROL          0x01
125 #define OGF_LINK_POLICY           0x02
126 #define OGF_CONTROLLER_BASEBAND   0x03
127 #define OGF_INFORMATIONAL_PARAMETERS 0x04
128 #define OGF_STATUS_PARAMETERS     0x05
129 #define OGF_LE_CONTROLLER 0x08
130 #define OGF_BTSTACK 0x3d
131 #define OGF_VENDOR  0x3f
132 
133 // cmds for BTstack
134 // get state: @returns HCI_STATE
135 #define BTSTACK_GET_STATE                                  0x01
136 
137 // set power mode: @param HCI_POWER_MODE
138 #define BTSTACK_SET_POWER_MODE                             0x02
139 
140 // set capture mode: @param on
141 #define BTSTACK_SET_ACL_CAPTURE_MODE                       0x03
142 
143 // get BTstack version
144 #define BTSTACK_GET_VERSION                                0x04
145 
146 // get system Bluetooth state
147 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED               0x05
148 
149 // set system Bluetooth state
150 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED               0x06
151 
152 // enable inquiry scan for this client
153 #define BTSTACK_SET_DISCOVERABLE                           0x07
154 
155 // set global Bluetooth state
156 #define BTSTACK_SET_BLUETOOTH_ENABLED                      0x08
157 
158 // create l2cap channel: @param bd_addr(48), psm (16)
159 #define L2CAP_CREATE_CHANNEL                               0x20
160 
161 // disconnect l2cap disconnect, @param channel(16), reason(8)
162 #define L2CAP_DISCONNECT                                   0x21
163 
164 // register l2cap service: @param psm(16), mtu (16)
165 #define L2CAP_REGISTER_SERVICE                             0x22
166 
167 // unregister l2cap disconnect, @param psm(16)
168 #define L2CAP_UNREGISTER_SERVICE                           0x23
169 
170 // accept connection @param bd_addr(48), dest cid (16)
171 #define L2CAP_ACCEPT_CONNECTION                            0x24
172 
173 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8)
174 #define L2CAP_DECLINE_CONNECTION                           0x25
175 
176 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16)
177 #define L2CAP_CREATE_CHANNEL_MTU                           0x26
178 
179 // register SDP Service Record: service record (size)
180 #define SDP_REGISTER_SERVICE_RECORD                        0x30
181 
182 // unregister SDP Service Record
183 #define SDP_UNREGISTER_SERVICE_RECORD                      0x31
184 
185 // Get remote RFCOMM services
186 #define SDP_CLIENT_QUERY_RFCOMM_SERVICES                   0x32
187 
188 // Get remote SDP services
189 #define SDP_CLIENT_QUERY_SERVICES                          0x33
190 
191 // RFCOMM "HCI" Commands
192 #define RFCOMM_CREATE_CHANNEL       0x40
193 #define RFCOMM_DISCONNECT			0x41
194 #define RFCOMM_REGISTER_SERVICE     0x42
195 #define RFCOMM_UNREGISTER_SERVICE   0x43
196 #define RFCOMM_ACCEPT_CONNECTION    0x44
197 #define RFCOMM_DECLINE_CONNECTION   0x45
198 #define RFCOMM_PERSISTENT_CHANNEL   0x46
199 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS   0x47
200 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48
201 #define RFCOMM_GRANT_CREDITS                 0x49
202 
203 // GAP Classic 0x50
204 #define GAP_DISCONNECT              0x50
205 
206 // GAP LE      0x60
207 #define GAP_LE_SCAN_START           0x60
208 #define GAP_LE_SCAN_STOP            0x61
209 #define GAP_LE_CONNECT              0x62
210 #define GAP_LE_CONNECT_CANCEL       0x63
211 #define GAP_LE_SET_SCAN_PARAMETERS  0x64
212 
213 // GATT (Client) 0x70
214 #define GATT_DISCOVER_ALL_PRIMARY_SERVICES                       0x70
215 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID16                 0x71
216 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID128                0x72
217 #define GATT_FIND_INCLUDED_SERVICES_FOR_SERVICE                  0x73
218 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE                0x74
219 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE_BY_UUID128     0x75
220 #define GATT_DISCOVER_CHARACTERISTIC_DESCRIPTORS                 0x76
221 #define GATT_READ_VALUE_OF_CHARACTERISTIC                        0x77
222 #define GATT_READ_LONG_VALUE_OF_CHARACTERISTIC                   0x78
223 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE      0x79
224 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC                       0x7A
225 #define GATT_WRITE_LONG_VALUE_OF_CHARACTERISTIC                  0x7B
226 #define GATT_RELIABLE_WRITE_LONG_VALUE_OF_CHARACTERISTIC         0x7C
227 #define GATT_READ_CHARACTERISTIC_DESCRIPTOR                      0X7D
228 #define GATT_READ_LONG_CHARACTERISTIC_DESCRIPTOR                 0X7E
229 #define GATT_WRITE_CHARACTERISTIC_DESCRIPTOR                     0X7F
230 #define GATT_WRITE_LONG_CHARACTERISTIC_DESCRIPTOR                0X80
231 #define GATT_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION           0X81
232 
233 //
234 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode)
235 
236 // data: event(8)
237 #define DAEMON_EVENT_CONNECTION_OPENED                     0x50
238 
239 // data: event(8)
240 #define DAEMON_EVENT_CONNECTION_CLOSED                     0x51
241 
242 // data: event(8), nr_connections(8)
243 #define DAEMON_NR_CONNECTIONS_CHANGED                      0x52
244 
245 // data: event(8)
246 #define DAEMON_EVENT_NEW_RFCOMM_CREDITS                    0x53
247 
248 // data: event(8)
249 #define DAEMON_EVENT_HCI_PACKET_SENT                       0x54
250 
251 /**
252  * LE connection parameter update state
253  */
254 
255 typedef enum {
256     CON_PARAMETER_UPDATE_NONE,
257     CON_PARAMETER_UPDATE_SEND_RESPONSE,
258     CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS,
259     CON_PARAMETER_UPDATE_DENY
260 } le_con_parameter_update_state_t;
261 
262 typedef struct le_connection_parameter_range{
263     uint16_t le_conn_interval_min;
264     uint16_t le_conn_interval_max;
265     uint16_t le_conn_latency_min;
266     uint16_t le_conn_latency_max;
267     uint16_t le_supervision_timeout_min;
268     uint16_t le_supervision_timeout_max;
269 } le_connection_parameter_range_t;
270 
271 // Authentication flags
272 typedef enum {
273     AUTH_FLAGS_NONE                = 0x0000,
274     RECV_LINK_KEY_REQUEST          = 0x0001,
275     HANDLE_LINK_KEY_REQUEST        = 0x0002,
276     SENT_LINK_KEY_REPLY            = 0x0004,
277     SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008,
278     RECV_LINK_KEY_NOTIFICATION     = 0x0010,
279     DENY_PIN_CODE_REQUEST          = 0x0040,
280     RECV_IO_CAPABILITIES_REQUEST   = 0x0080,
281     SEND_IO_CAPABILITIES_REPLY     = 0x0100,
282     SEND_USER_CONFIRM_REPLY        = 0x0200,
283     SEND_USER_PASSKEY_REPLY        = 0x0400,
284 
285     // pairing status
286     LEGACY_PAIRING_ACTIVE          = 0x2000,
287     SSP_PAIRING_ACTIVE             = 0x4000,
288 
289     // connection status
290     CONNECTION_ENCRYPTED           = 0x8000,
291 } hci_authentication_flags_t;
292 
293 /**
294  * Connection State
295  */
296 typedef enum {
297     SEND_CREATE_CONNECTION = 0,
298     SENT_CREATE_CONNECTION,
299     SEND_CANCEL_CONNECTION,
300     SENT_CANCEL_CONNECTION,
301     RECEIVED_CONNECTION_REQUEST,
302     ACCEPTED_CONNECTION_REQUEST,
303     REJECTED_CONNECTION_REQUEST,
304     OPEN,
305     SEND_DISCONNECT,
306     SENT_DISCONNECT
307 } CONNECTION_STATE;
308 
309 // bonding flags
310 enum {
311     BONDING_REQUEST_REMOTE_FEATURES   = 0x01,
312     BONDING_RECEIVED_REMOTE_FEATURES  = 0x02,
313     BONDING_REMOTE_SUPPORTS_SSP       = 0x04,
314     BONDING_DISCONNECT_SECURITY_BLOCK = 0x08,
315     BONDING_DISCONNECT_DEDICATED_DONE = 0x10,
316     BONDING_SEND_AUTHENTICATE_REQUEST = 0x20,
317     BONDING_SEND_ENCRYPTION_REQUEST   = 0x40,
318     BONDING_DEDICATED                 = 0x80,
319     BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100
320 };
321 
322 typedef enum {
323     BLUETOOTH_OFF = 1,
324     BLUETOOTH_ON,
325     BLUETOOTH_ACTIVE
326 } BLUETOOTH_STATE;
327 
328 // le central scanning state
329 typedef enum {
330     LE_SCAN_IDLE,
331     LE_START_SCAN,
332     LE_SCANNING,
333     LE_STOP_SCAN,
334 } le_scanning_state_t;
335 
336 
337 typedef struct {
338     // linked list - assert: first field
339     linked_item_t    item;
340 
341     // remote side
342     bd_addr_t address;
343 
344     // module handle
345     hci_con_handle_t con_handle;
346 
347     // le public, le random, classic
348     bd_addr_type_t address_type;
349 
350     // connection state
351     CONNECTION_STATE state;
352 
353     // bonding
354     uint16_t bonding_flags;
355     uint8_t  bonding_status;
356     // requested security level
357     gap_security_level_t requested_security_level;
358 
359     //
360     link_key_type_t link_key_type;
361 
362     // errands
363     uint32_t authentication_flags;
364 
365     timer_source_t timeout;
366 
367 #ifdef HAVE_TIME
368     // timer
369     struct timeval timestamp;
370 #endif
371 #ifdef HAVE_TICK
372     uint32_t timestamp; // timeout in system ticks
373 #endif
374 
375     // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload
376     uint8_t  acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE];
377     uint16_t acl_recombination_pos;
378     uint16_t acl_recombination_length;
379 
380     // number ACL packets sent to controller
381     uint8_t num_acl_packets_sent;
382 
383     // connection parameter update
384     le_con_parameter_update_state_t le_con_parameter_update_state;
385     uint16_t le_conn_interval_min;
386     uint16_t le_conn_interval_max;
387     uint16_t le_conn_latency;
388     uint16_t le_supervision_timeout;
389     uint16_t le_update_con_parameter_response;
390 } hci_connection_t;
391 
392 
393 /**
394  * main data structure
395  */
396 typedef struct {
397     // transport component with configuration
398     hci_transport_t  * hci_transport;
399     void             * config;
400 
401     // bsic configuration
402     const char         * local_name;
403     uint32_t           class_of_device;
404     bd_addr_t          local_bd_addr;
405     uint8_t            ssp_enable;
406     uint8_t            ssp_io_capability;
407     uint8_t            ssp_authentication_requirement;
408     uint8_t            ssp_auto_accept;
409 
410     // hardware power controller
411     bt_control_t     * control;
412 
413     // list of existing baseband connections
414     linked_list_t     connections;
415 
416     // single buffer for HCI packet assembly + additional prebuffer for H4 drivers
417     uint8_t   hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE];
418     uint8_t   hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8)
419     uint8_t   hci_packet_buffer_reserved;
420     uint16_t  acl_fragmentation_pos;
421     uint16_t  acl_fragmentation_total_size;
422 
423     /* host to controller flow control */
424     uint8_t  num_cmd_packets;
425     // uint8_t  total_num_cmd_packets;
426     uint8_t  acl_packets_total_num;
427     uint16_t acl_data_packet_length;
428     uint8_t  le_acl_packets_total_num;
429     uint16_t le_data_packets_length;
430 
431     /* local supported features */
432     uint8_t local_supported_features[8];
433 
434     // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE
435     uint16_t packet_types;
436 
437     /* callback to L2CAP layer */
438     void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size);
439 
440     /* remote device db */
441     remote_device_db_t const*remote_device_db;
442 
443     /* hci state machine */
444     HCI_STATE state;
445     uint8_t   substate;
446     uint8_t   cmds_ready;
447 
448     uint16_t  last_cmd_opcode;
449 
450     uint8_t   discoverable;
451     uint8_t   connectable;
452     uint8_t   bondable;
453 
454     /* buffer for scan enable cmd - 0xff no change */
455     uint8_t   new_scan_enable_value;
456 
457     // buffer for single connection decline
458     uint8_t   decline_reason;
459     bd_addr_t decline_addr;
460 
461     uint8_t   adv_addr_type;
462     bd_addr_t adv_address;
463 
464     le_scanning_state_t le_scanning_state;
465 
466     // buffer for le scan type command - 0xff not set
467     uint8_t  le_scan_type;
468     uint16_t le_scan_interval;
469     uint16_t le_scan_window;
470 
471     le_connection_parameter_range_t le_connection_parameter_range;
472 } hci_stack_t;
473 
474 /**
475  * set connection iterator
476  */
477 void hci_connections_get_iterator(linked_list_iterator_t *it);
478 
479 le_connection_parameter_range_t gap_le_get_connection_parameter_range();
480 void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range);
481 
482 // *************** le client start
483 
484 le_command_status_t le_central_start_scan(void);
485 le_command_status_t le_central_stop_scan(void);
486 le_command_status_t le_central_connect(bd_addr_t * addr, bd_addr_type_t addr_type);
487 le_command_status_t le_central_connect_cancel(void);
488 le_command_status_t gap_disconnect(hci_con_handle_t handle);
489 void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window);
490 
491 // *************** le client end
492 
493 // create and send hci command packets based on a template and a list of parameters
494 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...);
495 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr);
496 
497 void hci_connectable_control(uint8_t enable);
498 void hci_close(void);
499 
500 /**
501  * run the hci control loop once
502  */
503 void hci_run(void);
504 
505 // send complete CMD packet
506 int hci_send_cmd_packet(uint8_t *packet, int size);
507 
508 // send ACL packet prepared in hci packet buffer
509 int hci_send_acl_packet_buffer(int size);
510 
511 // new functions replacing hci_can_send_packet_now[_using_packet_buffer]
512 int hci_can_send_command_packet_now(void);
513 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle);
514 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle);
515 
516 // non-blocking UART driver needs
517 // @deprecated use hci_can_send_X_now instead
518 int hci_can_send_packet_now(uint8_t packet_type);
519 
520 // same as hci_can_send_packet_now, but also checks if packet buffer is free for use
521 // @deprecated use hci_can_send_X_now instead
522 int hci_can_send_packet_now_using_packet_buffer(uint8_t packet_type);
523 
524 // reserves outgoing packet buffer. @returns 1 if successful
525 int  hci_reserve_packet_buffer(void);
526 void hci_release_packet_buffer(void);
527 
528 // used for internal checks in l2cap[-le].c
529 int hci_is_packet_buffer_reserved(void);
530 
531 // get point to packet buffer
532 uint8_t* hci_get_outgoing_packet_buffer(void);
533 
534 bd_addr_t * hci_local_bd_addr(void);
535 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle);
536 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t *addr, bd_addr_type_t addr_type);
537 int hci_is_le_connection(hci_connection_t * connection);
538 uint8_t  hci_number_outgoing_packets(hci_con_handle_t handle);
539 uint8_t  hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle);
540 int      hci_authentication_active_for_handle(hci_con_handle_t handle);
541 uint16_t hci_max_acl_data_packet_length(void);
542 uint16_t hci_max_acl_le_data_packet_length(void);
543 uint16_t hci_usable_acl_packet_types(void);
544 int      hci_non_flushable_packet_boundary_flag_supported(void);
545 
546 void hci_disconnect_all(void);
547 
548 void hci_emit_state(void);
549 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status);
550 void hci_emit_l2cap_check_timeout(hci_connection_t *conn);
551 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason);
552 void hci_emit_nr_connections_changed(void);
553 void hci_emit_hci_open_failed(void);
554 void hci_emit_btstack_version(void);
555 void hci_emit_system_bluetooth_enabled(uint8_t enabled);
556 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name);
557 void hci_emit_discoverable_enabled(uint8_t enabled);
558 void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level);
559 void hci_emit_dedicated_bonding_result(bd_addr_t address, uint8_t status);
560 
561 // query if remote side supports SSP
562 // query if the local side supports SSP
563 int hci_local_ssp_activated(void);
564 
565 // query if the remote side supports SSP
566 int hci_remote_ssp_supported(hci_con_handle_t con_handle);
567 
568 // query if both sides support SSP
569 int hci_ssp_supported_on_both_sides(hci_con_handle_t handle);
570 
571 // disable automatic l2cap disconnect for testing
572 void hci_disable_l2cap_timeout_check(void);
573 
574 // disconnect because of security block
575 void hci_disconnect_security_block(hci_con_handle_t con_handle);
576 
577 /** Embedded API **/
578 
579 // Set up HCI. Needs to be called before any other function
580 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db);
581 
582 // Set class of device that will be set during Bluetooth init
583 void hci_set_class_of_device(uint32_t class_of_device);
584 
585 // Registers a packet handler. Used if L2CAP is not used (rarely).
586 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size));
587 
588 // Requests the change of BTstack power mode.
589 int  hci_power_control(HCI_POWER_MODE mode);
590 
591 // Allows to control if device is discoverable. OFF by default.
592 void hci_discoverable_control(uint8_t enable);
593 
594 // Creates and sends HCI command packets based on a template and
595 // a list of parameters. Will return error if outgoing data buffer
596 // is occupied.
597 int hci_send_cmd(const hci_cmd_t *cmd, ...);
598 
599 // Deletes link key for remote device with baseband address.
600 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr);
601 
602 // Configure Secure Simple Pairing
603 
604 // enable will enable SSP during init
605 void hci_ssp_set_enable(int enable);
606 
607 // if set, BTstack will respond to io capability request using authentication requirement
608 void hci_ssp_set_io_capability(int ssp_io_capability);
609 void hci_ssp_set_authentication_requirement(int authentication_requirement);
610 
611 // if set, BTstack will confirm a numberic comparion and enter '000000' if requested
612 void hci_ssp_set_auto_accept(int auto_accept);
613 
614 // get addr type and address used in advertisement packets
615 void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t * addr);
616 
617 
618 #if defined __cplusplus
619 }
620 #endif
621 
622 #endif // __HCI_H
623