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 #pragma once 45 46 #include "config.h" 47 48 #include <btstack/hci_cmds.h> 49 #include <btstack/utils.h> 50 #include "hci_transport.h" 51 #include "bt_control.h" 52 #include "remote_device_db.h" 53 54 #include <stdint.h> 55 #include <stdlib.h> 56 #include <stdarg.h> 57 58 #if defined __cplusplus 59 extern "C" { 60 #endif 61 62 // packet header sizes 63 #define HCI_CMD_HEADER_SIZE 3 64 #define HCI_ACL_HEADER_SIZE 4 65 #define HCI_SCO_HEADER_SIZE 3 66 #define HCI_EVENT_HEADER_SIZE 2 67 68 // packet sizes (max payload) 69 #define HCI_ACL_DM1_SIZE 17 70 #define HCI_ACL_DH1_SIZE 27 71 #define HCI_ACL_2DH1_SIZE 54 72 #define HCI_ACL_3DH1_SIZE 83 73 #define HCI_ACL_DM3_SIZE 121 74 #define HCI_ACL_DH3_SIZE 183 75 #define HCI_ACL_DM5_SIZE 224 76 #define HCI_ACL_DH5_SIZE 339 77 #define HCI_ACL_2DH3_SIZE 367 78 #define HCI_ACL_3DH3_SIZE 552 79 #define HCI_ACL_2DH5_SIZE 679 80 #define HCI_ACL_3DH5_SIZE 1021 81 82 #define HCI_EVENT_PAYLOAD_SIZE 255 83 #define HCI_CMD_PAYLOAD_SIZE 255 84 85 // packet buffer sizes 86 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 87 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE) 88 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 89 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 90 91 // size of hci buffers, big enough for command, event, or acl packet without H4 packet type 92 // @note cmd buffer is bigger than event buffer 93 #ifndef HCI_PACKET_BUFFER_SIZE 94 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 95 #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 96 #else 97 #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 98 #endif 99 #endif 100 101 // OGFs 102 #define OGF_LINK_CONTROL 0x01 103 #define OGF_LINK_POLICY 0x02 104 #define OGF_CONTROLLER_BASEBAND 0x03 105 #define OGF_INFORMATIONAL_PARAMETERS 0x04 106 #define OGF_LE_CONTROLLER 0x08 107 #define OGF_BTSTACK 0x3d 108 #define OGF_VENDOR 0x3f 109 110 // cmds for BTstack 111 // get state: @returns HCI_STATE 112 #define BTSTACK_GET_STATE 0x01 113 114 // set power mode: @param HCI_POWER_MODE 115 #define BTSTACK_SET_POWER_MODE 0x02 116 117 // set capture mode: @param on 118 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 119 120 // get BTstack version 121 #define BTSTACK_GET_VERSION 0x04 122 123 // get system Bluetooth state 124 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 125 126 // set system Bluetooth state 127 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 128 129 // enable inquiry scan for this client 130 #define BTSTACK_SET_DISCOVERABLE 0x07 131 132 // set global Bluetooth state 133 #define BTSTACK_SET_BLUETOOTH_ENABLED 0x08 134 135 // create l2cap channel: @param bd_addr(48), psm (16) 136 #define L2CAP_CREATE_CHANNEL 0x20 137 138 // disconnect l2cap disconnect, @param channel(16), reason(8) 139 #define L2CAP_DISCONNECT 0x21 140 141 // register l2cap service: @param psm(16), mtu (16) 142 #define L2CAP_REGISTER_SERVICE 0x22 143 144 // unregister l2cap disconnect, @param psm(16) 145 #define L2CAP_UNREGISTER_SERVICE 0x23 146 147 // accept connection @param bd_addr(48), dest cid (16) 148 #define L2CAP_ACCEPT_CONNECTION 0x24 149 150 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 151 #define L2CAP_DECLINE_CONNECTION 0x25 152 153 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16) 154 #define L2CAP_CREATE_CHANNEL_MTU 0x26 155 156 // register SDP Service Record: service record (size) 157 #define SDP_REGISTER_SERVICE_RECORD 0x30 158 159 // unregister SDP Service Record 160 #define SDP_UNREGISTER_SERVICE_RECORD 0x31 161 162 // Get remote RFCOMM services 163 #define SDP_CLIENT_QUERY_RFCOMM_SERVICES 0x32 164 165 // Get remote SDP services 166 #define SDP_CLIENT_QUERY_SERVICES 0x33 167 168 // RFCOMM "HCI" Commands 169 #define RFCOMM_CREATE_CHANNEL 0x40 170 #define RFCOMM_DISCONNECT 0x41 171 #define RFCOMM_REGISTER_SERVICE 0x42 172 #define RFCOMM_UNREGISTER_SERVICE 0x43 173 #define RFCOMM_ACCEPT_CONNECTION 0x44 174 #define RFCOMM_DECLINE_CONNECTION 0x45 175 #define RFCOMM_PERSISTENT_CHANNEL 0x46 176 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS 0x47 177 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48 178 #define RFCOMM_GRANT_CREDITS 0x49 179 180 // 181 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 182 183 // data: event(8) 184 #define DAEMON_EVENT_CONNECTION_OPENED 0x50 185 186 // data: event(8) 187 #define DAEMON_EVENT_CONNECTION_CLOSED 0x51 188 189 // data: event(8), nr_connections(8) 190 #define DAEMON_NR_CONNECTIONS_CHANGED 0x52 191 192 // data: event(8) 193 #define DAEMON_EVENT_NEW_RFCOMM_CREDITS 0x53 194 195 // data: event() 196 #define DAEMON_EVENT_HCI_PACKET_SENT 0x54 197 198 /** 199 * Connection State 200 */ 201 typedef enum { 202 AUTH_FLAGS_NONE = 0x0000, 203 RECV_LINK_KEY_REQUEST = 0x0001, 204 HANDLE_LINK_KEY_REQUEST = 0x0002, 205 SENT_LINK_KEY_REPLY = 0x0004, 206 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 207 RECV_LINK_KEY_NOTIFICATION = 0x0010, 208 DENY_PIN_CODE_REQUEST = 0x0040, 209 RECV_IO_CAPABILITIES_REQUEST = 0x0080, 210 SEND_IO_CAPABILITIES_REPLY = 0x0100, 211 SEND_USER_CONFIRM_REPLY = 0x0200, 212 SEND_USER_PASSKEY_REPLY = 0x0400, 213 214 // pairing status 215 LEGACY_PAIRING_ACTIVE = 0x2000, 216 SSP_PAIRING_ACTIVE = 0x4000, 217 218 // connection status 219 CONNECTION_ENCRYPTED = 0x8000, 220 } hci_authentication_flags_t; 221 222 typedef enum { 223 SEND_CREATE_CONNECTION = 0, 224 SENT_CREATE_CONNECTION, 225 RECEIVED_CONNECTION_REQUEST, 226 ACCEPTED_CONNECTION_REQUEST, 227 REJECTED_CONNECTION_REQUEST, 228 OPEN, 229 SENT_DISCONNECT 230 } CONNECTION_STATE; 231 232 typedef enum { 233 BONDING_REQUEST_REMOTE_FEATURES = 0x01, 234 BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 235 BONDING_REMOTE_SUPPORTS_SSP = 0x04, 236 BONDING_DISCONNECT_SECURITY_BLOCK = 0x08, 237 BONDING_DISCONNECT_DEDICATED_DONE = 0x10, 238 BONDING_SEND_AUTHENTICATE_REQUEST = 0x20, 239 BONDING_SEND_ENCRYPTION_REQUEST = 0x40, 240 BONDING_DEDICATED = 0x80, 241 } bonding_flags_t; 242 243 typedef enum { 244 BLUETOOTH_OFF = 1, 245 BLUETOOTH_ON, 246 BLUETOOTH_ACTIVE 247 } BLUETOOTH_STATE; 248 249 typedef struct { 250 // linked list - assert: first field 251 linked_item_t item; 252 253 // remote side 254 bd_addr_t address; 255 256 // module handle 257 hci_con_handle_t con_handle; 258 259 // connection state 260 CONNECTION_STATE state; 261 262 // bonding 263 bonding_flags_t bonding_flags; 264 265 // requested security level 266 gap_security_level_t requested_security_level; 267 268 // 269 link_key_type_t link_key_type; 270 271 // errands 272 hci_authentication_flags_t authentication_flags; 273 274 timer_source_t timeout; 275 276 #ifdef HAVE_TIME 277 // timer 278 struct timeval timestamp; 279 #endif 280 #ifdef HAVE_TICK 281 uint32_t timestamp; // timeout in system ticks 282 #endif 283 284 // ACL packet recombination - ACL Header + ACL payload 285 uint8_t acl_recombination_buffer[4 + HCI_ACL_BUFFER_SIZE]; 286 uint16_t acl_recombination_pos; 287 uint16_t acl_recombination_length; 288 289 // number ACL packets sent to controller 290 uint8_t num_acl_packets_sent; 291 292 } hci_connection_t; 293 294 /** 295 * main data structure 296 */ 297 typedef struct { 298 // transport component with configuration 299 hci_transport_t * hci_transport; 300 void * config; 301 302 // bsic configuration 303 char * local_name; 304 uint32_t class_of_device; 305 bd_addr_t local_bd_addr; 306 uint8_t ssp_enable; 307 uint8_t ssp_io_capability; 308 uint8_t ssp_authentication_requirement; 309 uint8_t ssp_auto_accept; 310 311 // hardware power controller 312 bt_control_t * control; 313 314 // list of existing baseband connections 315 linked_list_t connections; 316 317 // single buffer for HCI Command assembly 318 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 319 320 /* host to controller flow control */ 321 uint8_t num_cmd_packets; 322 // uint8_t total_num_cmd_packets; 323 uint8_t total_num_acl_packets; 324 uint16_t acl_data_packet_length; 325 uint8_t total_num_le_packets; 326 uint16_t le_data_packet_length; 327 328 /* local supported features */ 329 uint8_t local_supported_features[8]; 330 331 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 332 uint16_t packet_types; 333 334 /* callback to L2CAP layer */ 335 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 336 337 /* remote device db */ 338 remote_device_db_t const*remote_device_db; 339 340 /* hci state machine */ 341 HCI_STATE state; 342 uint8_t substate; 343 uint8_t cmds_ready; 344 345 uint8_t discoverable; 346 uint8_t connectable; 347 uint8_t bondable; 348 349 /* buffer for scan enable cmd - 0xff no change */ 350 uint8_t new_scan_enable_value; 351 352 // buffer for single connection decline 353 uint8_t decline_reason; 354 bd_addr_t decline_addr; 355 356 uint8_t adv_addr_type; 357 bd_addr_t adv_address; 358 359 } hci_stack_t; 360 361 // create and send hci command packets based on a template and a list of parameters 362 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 363 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 364 365 void hci_connectable_control(uint8_t enable); 366 void hci_close(void); 367 368 /** 369 * run the hci control loop once 370 */ 371 void hci_run(void); 372 373 // send complete CMD packet 374 int hci_send_cmd_packet(uint8_t *packet, int size); 375 376 // send ACL packet 377 int hci_send_acl_packet(uint8_t *packet, int size); 378 379 // non-blocking UART driver needs 380 int hci_can_send_packet_now(uint8_t packet_type); 381 382 bd_addr_t * hci_local_bd_addr(void); 383 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 384 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 385 uint8_t hci_number_free_acl_slots(void); 386 int hci_authentication_active_for_handle(hci_con_handle_t handle); 387 uint16_t hci_max_acl_data_packet_length(void); 388 uint16_t hci_usable_acl_packet_types(void); 389 uint8_t* hci_get_outgoing_acl_packet_buffer(void); 390 391 // 392 void hci_emit_state(void); 393 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 394 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 395 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 396 void hci_emit_nr_connections_changed(void); 397 void hci_emit_hci_open_failed(void); 398 void hci_emit_btstack_version(void); 399 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 400 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 401 void hci_emit_discoverable_enabled(uint8_t enabled); 402 void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 403 void hci_emit_dedicated_bonding_result(hci_connection_t * connection, uint8_t status); 404 405 // query if remote side supports SSP 406 // query if the local side supports SSP 407 int hci_local_ssp_activated(); 408 409 // query if the remote side supports SSP 410 int hci_remote_ssp_supported(hci_con_handle_t con_handle); 411 412 // query if both sides support SSP 413 int hci_ssp_supported_on_both_sides(hci_con_handle_t handle); 414 415 416 // disconnect because of security block 417 void hci_disconnect_security_block(hci_con_handle_t con_handle); 418 419 /** Embedded API **/ 420 421 // Set up HCI. 422 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 423 424 // Registers a packet handler. Used if L2CAP is not used (rarely). 425 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 426 427 // Requests the change of BTstack power mode. 428 int hci_power_control(HCI_POWER_MODE mode); 429 430 // Allows to control if device is discoverable. OFF by default. 431 void hci_discoverable_control(uint8_t enable); 432 433 // Creates and sends HCI command packets based on a template and 434 // a list of parameters. Will return error if outgoing data buffer 435 // is occupied. 436 int hci_send_cmd(const hci_cmd_t *cmd, ...); 437 438 // Deletes link key for remote device with baseband address. 439 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 440 441 // Configure Secure Simple Pairing 442 443 // enable will enable SSP during init 444 void hci_ssp_set_enable(int enable); 445 446 // if set, BTstack will respond to io capability request using authentication requirement 447 void hci_ssp_set_io_capability(int ssp_io_capability); 448 void hci_ssp_set_authentication_requirement(int authentication_requirement); 449 450 // if set, BTstack will confirm a numberic comparion and enter '000000' if requested 451 void hci_ssp_set_auto_accept(int auto_accept); 452 453 // get addr type and address used in advertisement packets 454 void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t * addr); 455 456 457 #if defined __cplusplus 458 } 459 #endif 460