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 86507d06b8S[email protected] 87507d06b8S[email protected] #define LE_ADVERTISING_DATA_SIZE 31 8836a5e735Smatthias.ringwald 8936a5e735Smatthias.ringwald // packet buffer sizes 9036a5e735Smatthias.ringwald // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 9136a5e735Smatthias.ringwald #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE) 9236a5e735Smatthias.ringwald #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 9336a5e735Smatthias.ringwald #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 9436a5e735Smatthias.ringwald 9536a5e735Smatthias.ringwald // size of hci buffers, big enough for command, event, or acl packet without H4 packet type 9636a5e735Smatthias.ringwald // @note cmd buffer is bigger than event buffer 9725c5e985S[email protected] #ifdef HCI_PACKET_BUFFER_SIZE 9825c5e985S[email protected] #if HCI_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 9925c5e985S[email protected] #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 10025c5e985S[email protected] #endif 10125c5e985S[email protected] #if HCI_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 10225c5e985S[email protected] #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 10325c5e985S[email protected] #endif 10425c5e985S[email protected] #else 10536a5e735Smatthias.ringwald #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 10636a5e735Smatthias.ringwald #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 10736a5e735Smatthias.ringwald #else 1087f3162b2Smatthias.ringwald #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 10936a5e735Smatthias.ringwald #endif 11023ac0743Smatthias.ringwald #endif 11128c93ceeSmatthias.ringwald 11260da618dS[email protected] // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA 11360da618dS[email protected] #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 11460da618dS[email protected] 115ec6321eeS[email protected] // BNEP may uncompress the IP Header by 16 bytes 116ec6321eeS[email protected] #ifdef HAVE_BNEP 117ec6321eeS[email protected] #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 118ec6321eeS[email protected] #endif 119b34233c3S[email protected] #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 120b34233c3S[email protected] #define HCI_INCOMING_PRE_BUFFER_SIZE 0 121b34233c3S[email protected] #endif 122b34233c3S[email protected] 123945627e4Smatthias.ringwald // OGFs 124945627e4Smatthias.ringwald #define OGF_LINK_CONTROL 0x01 125d59f499aSmatthias.ringwald #define OGF_LINK_POLICY 0x02 126945627e4Smatthias.ringwald #define OGF_CONTROLLER_BASEBAND 0x03 127945627e4Smatthias.ringwald #define OGF_INFORMATIONAL_PARAMETERS 0x04 128fdf1d293S[email protected] #define OGF_STATUS_PARAMETERS 0x05 129da75afa9Smatthias.ringwald #define OGF_LE_CONTROLLER 0x08 130945627e4Smatthias.ringwald #define OGF_BTSTACK 0x3d 131945627e4Smatthias.ringwald #define OGF_VENDOR 0x3f 13280d52d6bSmatthias.ringwald 13380d52d6bSmatthias.ringwald // cmds for BTstack 13480d52d6bSmatthias.ringwald // get state: @returns HCI_STATE 13580d52d6bSmatthias.ringwald #define BTSTACK_GET_STATE 0x01 13680d52d6bSmatthias.ringwald 13780d52d6bSmatthias.ringwald // set power mode: @param HCI_POWER_MODE 13880d52d6bSmatthias.ringwald #define BTSTACK_SET_POWER_MODE 0x02 13980d52d6bSmatthias.ringwald 14080d52d6bSmatthias.ringwald // set capture mode: @param on 14180d52d6bSmatthias.ringwald #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 14280d52d6bSmatthias.ringwald 1431b0e3922Smatthias.ringwald // get BTstack version 1441b0e3922Smatthias.ringwald #define BTSTACK_GET_VERSION 0x04 1451b0e3922Smatthias.ringwald 1462ed6235cSmatthias.ringwald // get system Bluetooth state 1472ed6235cSmatthias.ringwald #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 1482ed6235cSmatthias.ringwald 1492ed6235cSmatthias.ringwald // set system Bluetooth state 1502ed6235cSmatthias.ringwald #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 1512ed6235cSmatthias.ringwald 152381fbed8Smatthias.ringwald // enable inquiry scan for this client 153381fbed8Smatthias.ringwald #define BTSTACK_SET_DISCOVERABLE 0x07 154381fbed8Smatthias.ringwald 1553c4d4b90Smatthias.ringwald // set global Bluetooth state 1563c4d4b90Smatthias.ringwald #define BTSTACK_SET_BLUETOOTH_ENABLED 0x08 1573c4d4b90Smatthias.ringwald 15880d52d6bSmatthias.ringwald // create l2cap channel: @param bd_addr(48), psm (16) 15980d52d6bSmatthias.ringwald #define L2CAP_CREATE_CHANNEL 0x20 16080d52d6bSmatthias.ringwald 16180d52d6bSmatthias.ringwald // disconnect l2cap disconnect, @param channel(16), reason(8) 16280d52d6bSmatthias.ringwald #define L2CAP_DISCONNECT 0x21 16380d52d6bSmatthias.ringwald 164116ee617Smatthias.ringwald // register l2cap service: @param psm(16), mtu (16) 165116ee617Smatthias.ringwald #define L2CAP_REGISTER_SERVICE 0x22 166116ee617Smatthias.ringwald 167116ee617Smatthias.ringwald // unregister l2cap disconnect, @param psm(16) 168116ee617Smatthias.ringwald #define L2CAP_UNREGISTER_SERVICE 0x23 169116ee617Smatthias.ringwald 170116ee617Smatthias.ringwald // accept connection @param bd_addr(48), dest cid (16) 171116ee617Smatthias.ringwald #define L2CAP_ACCEPT_CONNECTION 0x24 172116ee617Smatthias.ringwald 173116ee617Smatthias.ringwald // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 174116ee617Smatthias.ringwald #define L2CAP_DECLINE_CONNECTION 0x25 175116ee617Smatthias.ringwald 17615470d27Smatthias.ringwald // create l2cap channel: @param bd_addr(48), psm (16), mtu (16) 17715470d27Smatthias.ringwald #define L2CAP_CREATE_CHANNEL_MTU 0x26 17815470d27Smatthias.ringwald 17906d7e47eSmatthias.ringwald // register SDP Service Record: service record (size) 18006d7e47eSmatthias.ringwald #define SDP_REGISTER_SERVICE_RECORD 0x30 18106d7e47eSmatthias.ringwald 18206d7e47eSmatthias.ringwald // unregister SDP Service Record 18306d7e47eSmatthias.ringwald #define SDP_UNREGISTER_SERVICE_RECORD 0x31 18406d7e47eSmatthias.ringwald 1856989e7aaS[email protected] // Get remote RFCOMM services 1866989e7aaS[email protected] #define SDP_CLIENT_QUERY_RFCOMM_SERVICES 0x32 1876989e7aaS[email protected] 18812fb62f7S[email protected] // Get remote SDP services 18912fb62f7S[email protected] #define SDP_CLIENT_QUERY_SERVICES 0x33 19012fb62f7S[email protected] 191e115bf24Smatthias.ringwald // RFCOMM "HCI" Commands 192e115bf24Smatthias.ringwald #define RFCOMM_CREATE_CHANNEL 0x40 193e115bf24Smatthias.ringwald #define RFCOMM_DISCONNECT 0x41 194e115bf24Smatthias.ringwald #define RFCOMM_REGISTER_SERVICE 0x42 195e115bf24Smatthias.ringwald #define RFCOMM_UNREGISTER_SERVICE 0x43 196e115bf24Smatthias.ringwald #define RFCOMM_ACCEPT_CONNECTION 0x44 197e115bf24Smatthias.ringwald #define RFCOMM_DECLINE_CONNECTION 0x45 198933d8a80Smatthias.ringwald #define RFCOMM_PERSISTENT_CHANNEL 0x46 199678847afSmatthias.ringwald #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS 0x47 200678847afSmatthias.ringwald #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48 201678847afSmatthias.ringwald #define RFCOMM_GRANT_CREDITS 0x49 20206d7e47eSmatthias.ringwald 2032b552b23S[email protected] // GAP Classic 0x50 2042b552b23S[email protected] #define GAP_DISCONNECT 0x50 2052b552b23S[email protected] 2062b552b23S[email protected] // GAP LE 0x60 2072b552b23S[email protected] #define GAP_LE_SCAN_START 0x60 2082b552b23S[email protected] #define GAP_LE_SCAN_STOP 0x61 2092b552b23S[email protected] #define GAP_LE_CONNECT 0x62 210e31f89a7S[email protected] #define GAP_LE_CONNECT_CANCEL 0x63 2110fdde038Smatthias.ringwald #define GAP_LE_SET_SCAN_PARAMETERS 0x64 2122b552b23S[email protected] 2132b552b23S[email protected] // GATT (Client) 0x70 21490f3290fS[email protected] #define GATT_DISCOVER_ALL_PRIMARY_SERVICES 0x70 21590f3290fS[email protected] #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID16 0x71 21690f3290fS[email protected] #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID128 0x72 21790f3290fS[email protected] #define GATT_FIND_INCLUDED_SERVICES_FOR_SERVICE 0x73 21890f3290fS[email protected] #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE 0x74 21990f3290fS[email protected] #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE_BY_UUID128 0x75 2200ef97525S[email protected] #define GATT_DISCOVER_CHARACTERISTIC_DESCRIPTORS 0x76 22190f3290fS[email protected] #define GATT_READ_VALUE_OF_CHARACTERISTIC 0x77 22290f3290fS[email protected] #define GATT_READ_LONG_VALUE_OF_CHARACTERISTIC 0x78 22390f3290fS[email protected] #define GATT_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE 0x79 22490f3290fS[email protected] #define GATT_WRITE_VALUE_OF_CHARACTERISTIC 0x7A 22590f3290fS[email protected] #define GATT_WRITE_LONG_VALUE_OF_CHARACTERISTIC 0x7B 22690f3290fS[email protected] #define GATT_RELIABLE_WRITE_LONG_VALUE_OF_CHARACTERISTIC 0x7C 22790f3290fS[email protected] #define GATT_READ_CHARACTERISTIC_DESCRIPTOR 0X7D 22890f3290fS[email protected] #define GATT_READ_LONG_CHARACTERISTIC_DESCRIPTOR 0X7E 22990f3290fS[email protected] #define GATT_WRITE_CHARACTERISTIC_DESCRIPTOR 0X7F 23090f3290fS[email protected] #define GATT_WRITE_LONG_CHARACTERISTIC_DESCRIPTOR 0X80 23190f3290fS[email protected] #define GATT_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION 0X81 2322b552b23S[email protected] 23380d52d6bSmatthias.ringwald // 23480d52d6bSmatthias.ringwald #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 23580d52d6bSmatthias.ringwald 236945627e4Smatthias.ringwald // data: event(8) 237d8293395Smatthias.ringwald #define DAEMON_EVENT_CONNECTION_OPENED 0x50 23827d86fbbSmatthias.ringwald 23927d86fbbSmatthias.ringwald // data: event(8) 240d8293395Smatthias.ringwald #define DAEMON_EVENT_CONNECTION_CLOSED 0x51 241945627e4Smatthias.ringwald 242945627e4Smatthias.ringwald // data: event(8), nr_connections(8) 243d8293395Smatthias.ringwald #define DAEMON_NR_CONNECTIONS_CHANGED 0x52 24427d86fbbSmatthias.ringwald 245bf8dada5Smatthias.ringwald // data: event(8) 246d8293395Smatthias.ringwald #define DAEMON_EVENT_NEW_RFCOMM_CREDITS 0x53 247d8293395Smatthias.ringwald 2483ad83cc6S[email protected] // data: event(8) 249d8293395Smatthias.ringwald #define DAEMON_EVENT_HCI_PACKET_SENT 0x54 250945627e4Smatthias.ringwald 25106b35ec0Smatthias.ringwald /** 252da886c03S[email protected] * LE connection parameter update state 253da886c03S[email protected] */ 254da886c03S[email protected] 255da886c03S[email protected] typedef enum { 256da886c03S[email protected] CON_PARAMETER_UPDATE_NONE, 257da886c03S[email protected] CON_PARAMETER_UPDATE_SEND_RESPONSE, 258da886c03S[email protected] CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 259da886c03S[email protected] CON_PARAMETER_UPDATE_DENY 260da886c03S[email protected] } le_con_parameter_update_state_t; 261da886c03S[email protected] 262da886c03S[email protected] typedef struct le_connection_parameter_range{ 263da886c03S[email protected] uint16_t le_conn_interval_min; 264da886c03S[email protected] uint16_t le_conn_interval_max; 265da886c03S[email protected] uint16_t le_conn_latency_min; 266da886c03S[email protected] uint16_t le_conn_latency_max; 267da886c03S[email protected] uint16_t le_supervision_timeout_min; 268da886c03S[email protected] uint16_t le_supervision_timeout_max; 269da886c03S[email protected] } le_connection_parameter_range_t; 270da886c03S[email protected] 2710414dabdS[email protected] // Authentication flags 272c01e9cbdSmatthias.ringwald typedef enum { 273dbe1a790S[email protected] AUTH_FLAGS_NONE = 0x0000, 274dbe1a790S[email protected] RECV_LINK_KEY_REQUEST = 0x0001, 275dbe1a790S[email protected] HANDLE_LINK_KEY_REQUEST = 0x0002, 276dbe1a790S[email protected] SENT_LINK_KEY_REPLY = 0x0004, 277dbe1a790S[email protected] SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 278dbe1a790S[email protected] RECV_LINK_KEY_NOTIFICATION = 0x0010, 279899283eaS[email protected] DENY_PIN_CODE_REQUEST = 0x0040, 280f0944df2S[email protected] RECV_IO_CAPABILITIES_REQUEST = 0x0080, 281f0944df2S[email protected] SEND_IO_CAPABILITIES_REPLY = 0x0100, 2826724cd9eS[email protected] SEND_USER_CONFIRM_REPLY = 0x0200, 2836724cd9eS[email protected] SEND_USER_PASSKEY_REPLY = 0x0400, 2846724cd9eS[email protected] 2856724cd9eS[email protected] // pairing status 2866724cd9eS[email protected] LEGACY_PAIRING_ACTIVE = 0x2000, 2876724cd9eS[email protected] SSP_PAIRING_ACTIVE = 0x4000, 288536f9994S[email protected] 289f0944df2S[email protected] // connection status 2906724cd9eS[email protected] CONNECTION_ENCRYPTED = 0x8000, 2917fde4af9Smatthias.ringwald } hci_authentication_flags_t; 292c01e9cbdSmatthias.ringwald 2930414dabdS[email protected] /** 2940414dabdS[email protected] * Connection State 2950414dabdS[email protected] */ 296c8e4258aSmatthias.ringwald typedef enum { 297ad83dc6aS[email protected] SEND_CREATE_CONNECTION = 0, 298ad83dc6aS[email protected] SENT_CREATE_CONNECTION, 2990bf6344aS[email protected] SEND_CANCEL_CONNECTION, 3000bf6344aS[email protected] SENT_CANCEL_CONNECTION, 301c8e4258aSmatthias.ringwald RECEIVED_CONNECTION_REQUEST, 302c8e4258aSmatthias.ringwald ACCEPTED_CONNECTION_REQUEST, 303c8e4258aSmatthias.ringwald REJECTED_CONNECTION_REQUEST, 304c8e4258aSmatthias.ringwald OPEN, 3055917a5c5S[email protected] SEND_DISCONNECT, 306*ccda6e14S[email protected] SENT_DISCONNECT, 307*ccda6e14S[email protected] RECEIVED_DISCONNECTION_COMPLETE 308c8e4258aSmatthias.ringwald } CONNECTION_STATE; 309c8e4258aSmatthias.ringwald 3100414dabdS[email protected] // bonding flags 3110414dabdS[email protected] enum { 312afd4e962S[email protected] BONDING_REQUEST_REMOTE_FEATURES = 0x01, 313afd4e962S[email protected] BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 314afd4e962S[email protected] BONDING_REMOTE_SUPPORTS_SSP = 0x04, 3152bd8b7e7S[email protected] BONDING_DISCONNECT_SECURITY_BLOCK = 0x08, 316ad83dc6aS[email protected] BONDING_DISCONNECT_DEDICATED_DONE = 0x10, 317ad83dc6aS[email protected] BONDING_SEND_AUTHENTICATE_REQUEST = 0x20, 318ad83dc6aS[email protected] BONDING_SEND_ENCRYPTION_REQUEST = 0x40, 319ad83dc6aS[email protected] BONDING_DEDICATED = 0x80, 3201bd5283dS[email protected] BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100 3210414dabdS[email protected] }; 322afd4e962S[email protected] 323afd4e962S[email protected] typedef enum { 32443bfb1bdSmatthias.ringwald BLUETOOTH_OFF = 1, 32543bfb1bdSmatthias.ringwald BLUETOOTH_ON, 32643bfb1bdSmatthias.ringwald BLUETOOTH_ACTIVE 32743bfb1bdSmatthias.ringwald } BLUETOOTH_STATE; 32843bfb1bdSmatthias.ringwald 3297bdc6798S[email protected] // le central scanning state 3307bdc6798S[email protected] typedef enum { 3317bdc6798S[email protected] LE_SCAN_IDLE, 3327bdc6798S[email protected] LE_START_SCAN, 3337bdc6798S[email protected] LE_SCANNING, 3347bdc6798S[email protected] LE_STOP_SCAN, 3357bdc6798S[email protected] } le_scanning_state_t; 3367bdc6798S[email protected] 3374f3229d8S[email protected] 338c8e4258aSmatthias.ringwald typedef struct { 33906b35ec0Smatthias.ringwald // linked list - assert: first field 34006b35ec0Smatthias.ringwald linked_item_t item; 341c01e9cbdSmatthias.ringwald 342c01e9cbdSmatthias.ringwald // remote side 34316833f0aSmatthias.ringwald bd_addr_t address; 34406b35ec0Smatthias.ringwald 34506b35ec0Smatthias.ringwald // module handle 34616833f0aSmatthias.ringwald hci_con_handle_t con_handle; 347c01e9cbdSmatthias.ringwald 34896a45072S[email protected] // le public, le random, classic 34996a45072S[email protected] bd_addr_type_t address_type; 35096a45072S[email protected] 351afd4e962S[email protected] // connection state 352c8e4258aSmatthias.ringwald CONNECTION_STATE state; 353c8e4258aSmatthias.ringwald 354afd4e962S[email protected] // bonding 3557bdc6798S[email protected] uint16_t bonding_flags; 3561bd5283dS[email protected] uint8_t bonding_status; 35734d2123cS[email protected] // requested security level 35834d2123cS[email protected] gap_security_level_t requested_security_level; 35934d2123cS[email protected] 3609ab95c90S[email protected] // 3619ab95c90S[email protected] link_key_type_t link_key_type; 3629ab95c90S[email protected] 36306b35ec0Smatthias.ringwald // errands 3647bdc6798S[email protected] uint32_t authentication_flags; 365c8e4258aSmatthias.ringwald 366c785ef68Smatthias.ringwald timer_source_t timeout; 367c785ef68Smatthias.ringwald 3680bece81eSmatthias.ringwald #ifdef HAVE_TIME 369ee091cf1Smatthias.ringwald // timer 370ee091cf1Smatthias.ringwald struct timeval timestamp; 3710bece81eSmatthias.ringwald #endif 372e5780900Smatthias.ringwald #ifdef HAVE_TICK 373e1d41216Smatthias.ringwald uint32_t timestamp; // timeout in system ticks 374c785ef68Smatthias.ringwald #endif 375ee091cf1Smatthias.ringwald 376ec6321eeS[email protected] // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 377ec6321eeS[email protected] uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 378c1012e46Smatthias.ringwald uint16_t acl_recombination_pos; 379d55db49eSmatthias.ringwald uint16_t acl_recombination_length; 380d55db49eSmatthias.ringwald 38156cf178bSmatthias.ringwald // number ACL packets sent to controller 38256cf178bSmatthias.ringwald uint8_t num_acl_packets_sent; 383c37a3166S[email protected] 384c37a3166S[email protected] // connection parameter update 385da886c03S[email protected] le_con_parameter_update_state_t le_con_parameter_update_state; 386c37a3166S[email protected] uint16_t le_conn_interval_min; 387c37a3166S[email protected] uint16_t le_conn_interval_max; 388c37a3166S[email protected] uint16_t le_conn_latency; 389c37a3166S[email protected] uint16_t le_supervision_timeout; 390da886c03S[email protected] uint16_t le_update_con_parameter_response; 39116833f0aSmatthias.ringwald } hci_connection_t; 39216833f0aSmatthias.ringwald 3934f3229d8S[email protected] 39406b35ec0Smatthias.ringwald /** 39506b35ec0Smatthias.ringwald * main data structure 39606b35ec0Smatthias.ringwald */ 39716833f0aSmatthias.ringwald typedef struct { 39806b35ec0Smatthias.ringwald // transport component with configuration 39916833f0aSmatthias.ringwald hci_transport_t * hci_transport; 40011e23e5fSmatthias.ringwald void * config; 40111e23e5fSmatthias.ringwald 402e2386ba1S[email protected] // bsic configuration 4038e618f72S[email protected] const char * local_name; 404e2386ba1S[email protected] uint32_t class_of_device; 405e2386ba1S[email protected] bd_addr_t local_bd_addr; 406a45d6b9fS[email protected] uint8_t ssp_enable; 407a45d6b9fS[email protected] uint8_t ssp_io_capability; 408a45d6b9fS[email protected] uint8_t ssp_authentication_requirement; 4091d6b20aeS[email protected] uint8_t ssp_auto_accept; 410e2386ba1S[email protected] 41106b35ec0Smatthias.ringwald // hardware power controller 41206b35ec0Smatthias.ringwald bt_control_t * control; 41306b35ec0Smatthias.ringwald 41406b35ec0Smatthias.ringwald // list of existing baseband connections 415fe1ed1b8Smatthias.ringwald linked_list_t connections; 41616833f0aSmatthias.ringwald 41760da618dS[email protected] // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 41860da618dS[email protected] uint8_t hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE]; 41936a5e735Smatthias.ringwald uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 4206b4af23dS[email protected] uint8_t hci_packet_buffer_reserved; 421452cf3bbS[email protected] uint16_t acl_fragmentation_pos; 422452cf3bbS[email protected] uint16_t acl_fragmentation_total_size; 42306b35ec0Smatthias.ringwald 42416833f0aSmatthias.ringwald /* host to controller flow control */ 42516833f0aSmatthias.ringwald uint8_t num_cmd_packets; 426e2edc0c3Smatthias.ringwald // uint8_t total_num_cmd_packets; 427ee303eddS[email protected] uint8_t acl_packets_total_num; 428e2edc0c3Smatthias.ringwald uint16_t acl_data_packet_length; 429ee303eddS[email protected] uint8_t le_acl_packets_total_num; 430ee303eddS[email protected] uint16_t le_data_packets_length; 43116833f0aSmatthias.ringwald 432559e517eS[email protected] /* local supported features */ 433559e517eS[email protected] uint8_t local_supported_features[8]; 434559e517eS[email protected] 4358f8108aaSmatthias.ringwald // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 4368f8108aaSmatthias.ringwald uint16_t packet_types; 4378f8108aaSmatthias.ringwald 43816833f0aSmatthias.ringwald /* callback to L2CAP layer */ 4392718e2e7Smatthias.ringwald void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 44016833f0aSmatthias.ringwald 44129d53098Smatthias.ringwald /* remote device db */ 4424f4fc1dfSmatthias.ringwald remote_device_db_t const*remote_device_db; 44329d53098Smatthias.ringwald 4443429f56bSmatthias.ringwald /* hci state machine */ 4453429f56bSmatthias.ringwald HCI_STATE state; 4463429f56bSmatthias.ringwald uint8_t substate; 4473429f56bSmatthias.ringwald uint8_t cmds_ready; 4483429f56bSmatthias.ringwald 4495127cc62S[email protected] uint16_t last_cmd_opcode; 4505127cc62S[email protected] 451381fbed8Smatthias.ringwald uint8_t discoverable; 452758b46ceSmatthias.ringwald uint8_t connectable; 453458bf4e8S[email protected] uint8_t bondable; 4543dbb95f9Smatthias.ringwald 455b031bebbSmatthias.ringwald /* buffer for scan enable cmd - 0xff no change */ 456b031bebbSmatthias.ringwald uint8_t new_scan_enable_value; 457b031bebbSmatthias.ringwald 4583dbb95f9Smatthias.ringwald // buffer for single connection decline 4593dbb95f9Smatthias.ringwald uint8_t decline_reason; 4603dbb95f9Smatthias.ringwald bd_addr_t decline_addr; 461381fbed8Smatthias.ringwald 46269a97523S[email protected] uint8_t adv_addr_type; 46369a97523S[email protected] bd_addr_t adv_address; 464e2602ea2Smatthias.ringwald 4657bdc6798S[email protected] le_scanning_state_t le_scanning_state; 466e2602ea2Smatthias.ringwald 467e2602ea2Smatthias.ringwald // buffer for le scan type command - 0xff not set 468e2602ea2Smatthias.ringwald uint8_t le_scan_type; 469e2602ea2Smatthias.ringwald uint16_t le_scan_interval; 470e2602ea2Smatthias.ringwald uint16_t le_scan_window; 471da886c03S[email protected] 472da886c03S[email protected] le_connection_parameter_range_t le_connection_parameter_range; 47316833f0aSmatthias.ringwald } hci_stack_t; 47416833f0aSmatthias.ringwald 475da886c03S[email protected] /** 476da886c03S[email protected] * set connection iterator 477da886c03S[email protected] */ 478da886c03S[email protected] void hci_connections_get_iterator(linked_list_iterator_t *it); 479da886c03S[email protected] 480da886c03S[email protected] le_connection_parameter_range_t gap_le_get_connection_parameter_range(); 481da886c03S[email protected] void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range); 482da886c03S[email protected] 4837bdc6798S[email protected] // *************** le client start 4847bdc6798S[email protected] 4853ad83cc6S[email protected] le_command_status_t le_central_start_scan(void); 4863ad83cc6S[email protected] le_command_status_t le_central_stop_scan(void); 4874f3229d8S[email protected] le_command_status_t le_central_connect(bd_addr_t * addr, bd_addr_type_t addr_type); 4883ad83cc6S[email protected] le_command_status_t le_central_connect_cancel(void); 4895917a5c5S[email protected] le_command_status_t gap_disconnect(hci_con_handle_t handle); 490ef11999fSmatthias.ringwald void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 4917bdc6798S[email protected] 4927bdc6798S[email protected] // *************** le client end 4937bdc6798S[email protected] 494945627e4Smatthias.ringwald // create and send hci command packets based on a template and a list of parameters 495945627e4Smatthias.ringwald uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 496df33c7a6Smatthias.ringwald uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 497945627e4Smatthias.ringwald 498758b46ceSmatthias.ringwald void hci_connectable_control(uint8_t enable); 499e6cc8be2S[email protected] void hci_close(void); 500475c8125Smatthias.ringwald 5013429f56bSmatthias.ringwald /** 502c8e4258aSmatthias.ringwald * run the hci control loop once 5033429f56bSmatthias.ringwald */ 50469415922Smatthias.ringwald void hci_run(void); 5051f504dbdSmatthias.ringwald 506d8905019Smatthias.ringwald // send complete CMD packet 50749857181Smatthias.ringwald int hci_send_cmd_packet(uint8_t *packet, int size); 508554588a5Smatthias.ringwald 509826f7347S[email protected] // send ACL packet prepared in hci packet buffer 510826f7347S[email protected] int hci_send_acl_packet_buffer(int size); 51106b35ec0Smatthias.ringwald 512ac928cc2S[email protected] // new functions replacing hci_can_send_packet_now[_using_packet_buffer] 513ac928cc2S[email protected] int hci_can_send_command_packet_now(void); 514ac928cc2S[email protected] int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 515ac928cc2S[email protected] int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 516ac928cc2S[email protected] 517c24735b1Smatthias.ringwald // non-blocking UART driver needs 518ac928cc2S[email protected] // @deprecated use hci_can_send_X_now instead 519c24735b1Smatthias.ringwald int hci_can_send_packet_now(uint8_t packet_type); 520c24735b1Smatthias.ringwald 5216b4af23dS[email protected] // same as hci_can_send_packet_now, but also checks if packet buffer is free for use 522ac928cc2S[email protected] // @deprecated use hci_can_send_X_now instead 5236b4af23dS[email protected] int hci_can_send_packet_now_using_packet_buffer(uint8_t packet_type); 5246b4af23dS[email protected] 5256b4af23dS[email protected] // reserves outgoing packet buffer. @returns 1 if successful 5266b4af23dS[email protected] int hci_reserve_packet_buffer(void); 52768a0fcf7S[email protected] void hci_release_packet_buffer(void); 5286b4af23dS[email protected] 529c8b9416aS[email protected] // used for internal checks in l2cap[-le].c 530c8b9416aS[email protected] int hci_is_packet_buffer_reserved(void); 531c8b9416aS[email protected] 5326b4af23dS[email protected] // get point to packet buffer 533facf93fdS[email protected] uint8_t* hci_get_outgoing_packet_buffer(void); 5346b4af23dS[email protected] 5355061f3afS[email protected] bd_addr_t * hci_local_bd_addr(void); 5365061f3afS[email protected] hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 53796a45072S[email protected] hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t *addr, bd_addr_type_t addr_type); 5380bf6344aS[email protected] int hci_is_le_connection(hci_connection_t * connection); 539998906cdSmatthias.ringwald uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 540e79abdd6S[email protected] uint8_t hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 54180ca58a0Smatthias.ringwald int hci_authentication_active_for_handle(hci_con_handle_t handle); 54269415922Smatthias.ringwald uint16_t hci_max_acl_data_packet_length(void); 5436c26b087S[email protected] uint16_t hci_max_acl_le_data_packet_length(void); 5448f8108aaSmatthias.ringwald uint16_t hci_usable_acl_packet_types(void); 5456ac9a97eS[email protected] int hci_non_flushable_packet_boundary_flag_supported(void); 54604a6ef8cSmatthias.ringwald 5473ad83cc6S[email protected] void hci_disconnect_all(void); 54804a6ef8cSmatthias.ringwald 54969415922Smatthias.ringwald void hci_emit_state(void); 55017f1ba2aSmatthias.ringwald void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 551ee091cf1Smatthias.ringwald void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 5523c4d4b90Smatthias.ringwald void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 55369415922Smatthias.ringwald void hci_emit_nr_connections_changed(void); 55469415922Smatthias.ringwald void hci_emit_hci_open_failed(void); 55569415922Smatthias.ringwald void hci_emit_btstack_version(void); 5562ed6235cSmatthias.ringwald void hci_emit_system_bluetooth_enabled(uint8_t enabled); 557627c2f45Smatthias.ringwald void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 558381fbed8Smatthias.ringwald void hci_emit_discoverable_enabled(uint8_t enabled); 559a00031e2S[email protected] void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 5601bd5283dS[email protected] void hci_emit_dedicated_bonding_result(bd_addr_t address, uint8_t status); 561e3b6fe7eSmatthias.ringwald 5622bd8b7e7S[email protected] // query if remote side supports SSP 5632bd8b7e7S[email protected] // query if the local side supports SSP 5643ad83cc6S[email protected] int hci_local_ssp_activated(void); 5652bd8b7e7S[email protected] 5662bd8b7e7S[email protected] // query if the remote side supports SSP 5672bd8b7e7S[email protected] int hci_remote_ssp_supported(hci_con_handle_t con_handle); 5682bd8b7e7S[email protected] 569df3354fcS[email protected] // query if both sides support SSP 570df3354fcS[email protected] int hci_ssp_supported_on_both_sides(hci_con_handle_t handle); 571df3354fcS[email protected] 57266fb9560S[email protected] // disable automatic l2cap disconnect for testing 5733ad83cc6S[email protected] void hci_disable_l2cap_timeout_check(void); 574df3354fcS[email protected] 5752bd8b7e7S[email protected] // disconnect because of security block 5762bd8b7e7S[email protected] void hci_disconnect_security_block(hci_con_handle_t con_handle); 577e6cc8be2S[email protected] 578e6cc8be2S[email protected] /** Embedded API **/ 579e6cc8be2S[email protected] 5809e61646fS[email protected] // Set up HCI. Needs to be called before any other function 581e6cc8be2S[email protected] void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 582e6cc8be2S[email protected] 5839e61646fS[email protected] // Set class of device that will be set during Bluetooth init 5849e61646fS[email protected] void hci_set_class_of_device(uint32_t class_of_device); 5859e61646fS[email protected] 586e6cc8be2S[email protected] // Registers a packet handler. Used if L2CAP is not used (rarely). 587e6cc8be2S[email protected] void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 588e6cc8be2S[email protected] 589e6cc8be2S[email protected] // Requests the change of BTstack power mode. 590e6cc8be2S[email protected] int hci_power_control(HCI_POWER_MODE mode); 591e6cc8be2S[email protected] 592559e517eS[email protected] // Allows to control if device is discoverable. OFF by default. 593e6cc8be2S[email protected] void hci_discoverable_control(uint8_t enable); 594e6cc8be2S[email protected] 595dbe1a790S[email protected] // Creates and sends HCI command packets based on a template and 596e6cc8be2S[email protected] // a list of parameters. Will return error if outgoing data buffer 597e6cc8be2S[email protected] // is occupied. 598e6cc8be2S[email protected] int hci_send_cmd(const hci_cmd_t *cmd, ...); 599e6cc8be2S[email protected] 600e6cc8be2S[email protected] // Deletes link key for remote device with baseband address. 601e6cc8be2S[email protected] void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 602e6cc8be2S[email protected] 603dbe1a790S[email protected] // Configure Secure Simple Pairing 604dbe1a790S[email protected] 605dbe1a790S[email protected] // enable will enable SSP during init 606dbe1a790S[email protected] void hci_ssp_set_enable(int enable); 607dbe1a790S[email protected] 608dbe1a790S[email protected] // if set, BTstack will respond to io capability request using authentication requirement 609dbe1a790S[email protected] void hci_ssp_set_io_capability(int ssp_io_capability); 610dbe1a790S[email protected] void hci_ssp_set_authentication_requirement(int authentication_requirement); 611dbe1a790S[email protected] 612dbe1a790S[email protected] // if set, BTstack will confirm a numberic comparion and enter '000000' if requested 613dbe1a790S[email protected] void hci_ssp_set_auto_accept(int auto_accept); 614e6cc8be2S[email protected] 61569a97523S[email protected] // get addr type and address used in advertisement packets 61618904abdS[email protected] void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t * addr); 61769a97523S[email protected] 6182bd8b7e7S[email protected] 619e3b6fe7eSmatthias.ringwald #if defined __cplusplus 620e3b6fe7eSmatthias.ringwald } 621e3b6fe7eSmatthias.ringwald #endif 622f471afd8S[email protected] 623f471afd8S[email protected] #endif // __HCI_H 624