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 RECV_PIN_CODE_REQUEST = 0x0020, 209 HANDLE_PIN_CODE_REQUEST = 0x0040, 210 // SSP 211 RECV_IO_CAPABILITIES_REQUEST = 0x0080, 212 SEND_IO_CAPABILITIES_REPLY = 0x0100, 213 RECV_USER_CONFIRM_REQUEST = 0x0200, 214 SEND_USER_CONFIRM_REPLY = 0x0400, 215 RECV_USER_PASSKEY_REQUEST = 0x0800, 216 SEND_USER_PASSKEY_REPLY = 0x1000, 217 218 // link key 219 HAVE_AUTHENTICATED_LINK_KEY = 0x2000, 220 221 // connection status 222 CONNECTION_ENCRYPTED = 0x2000, 223 224 // SENT_PIN_CODE_REPLY = 0x0080, 225 // SENT_PIN_CODE_NEGATIVE_REPLY = 0x0100, 226 227 } hci_authentication_flags_t; 228 229 typedef enum { 230 SENT_CREATE_CONNECTION = 1, 231 RECEIVED_CONNECTION_REQUEST, 232 ACCEPTED_CONNECTION_REQUEST, 233 REJECTED_CONNECTION_REQUEST, 234 OPEN, 235 SENT_DISCONNECT 236 } CONNECTION_STATE; 237 238 typedef enum { 239 BONDING_REQUEST_REMOTE_FEATURES = 0x01, 240 BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 241 BONDING_REMOTE_SUPPORTS_SSP = 0x04, 242 } bonding_flags_t; 243 244 #define CHANNEL_SECURITY_ENCRYPTED = 0x01 245 #define CHANNEL_SECURITY_AUTHENTICAED = 0x02 246 247 typedef enum { 248 BLUETOOTH_OFF = 1, 249 BLUETOOTH_ON, 250 BLUETOOTH_ACTIVE 251 } BLUETOOTH_STATE; 252 253 typedef struct { 254 // linked list - assert: first field 255 linked_item_t item; 256 257 // remote side 258 bd_addr_t address; 259 260 // module handle 261 hci_con_handle_t con_handle; 262 263 // connection state 264 CONNECTION_STATE state; 265 266 // bonding 267 bonding_flags_t bonding_flags; 268 269 // errands 270 hci_authentication_flags_t authentication_flags; 271 272 timer_source_t timeout; 273 274 #ifdef HAVE_TIME 275 // timer 276 struct timeval timestamp; 277 #endif 278 #ifdef HAVE_TICK 279 uint32_t timestamp; // timeout in system ticks 280 #endif 281 282 // ACL packet recombination - ACL Header + ACL payload 283 uint8_t acl_recombination_buffer[4 + HCI_ACL_BUFFER_SIZE]; 284 uint16_t acl_recombination_pos; 285 uint16_t acl_recombination_length; 286 287 // number ACL packets sent to controller 288 uint8_t num_acl_packets_sent; 289 290 } hci_connection_t; 291 292 /** 293 * main data structure 294 */ 295 typedef struct { 296 // transport component with configuration 297 hci_transport_t * hci_transport; 298 void * config; 299 300 // bsic configuration 301 char * local_name; 302 uint32_t class_of_device; 303 bd_addr_t local_bd_addr; 304 uint8_t ssp_enable; 305 uint8_t ssp_io_capability; 306 uint8_t ssp_authentication_requirement; 307 uint8_t ssp_auto_accept; 308 309 // hardware power controller 310 bt_control_t * control; 311 312 // list of existing baseband connections 313 linked_list_t connections; 314 315 // single buffer for HCI Command assembly 316 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 317 318 /* host to controller flow control */ 319 uint8_t num_cmd_packets; 320 // uint8_t total_num_cmd_packets; 321 uint8_t total_num_acl_packets; 322 uint16_t acl_data_packet_length; 323 uint8_t total_num_le_packets; 324 uint16_t le_data_packet_length; 325 326 /* local supported features */ 327 uint8_t local_supported_features[8]; 328 329 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 330 uint16_t packet_types; 331 332 /* callback to L2CAP layer */ 333 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 334 335 /* remote device db */ 336 remote_device_db_t const*remote_device_db; 337 338 /* hci state machine */ 339 HCI_STATE state; 340 uint8_t substate; 341 uint8_t cmds_ready; 342 343 uint8_t discoverable; 344 uint8_t connectable; 345 uint8_t bondable; 346 347 /* buffer for scan enable cmd - 0xff no change */ 348 uint8_t new_scan_enable_value; 349 350 // buffer for single connection decline 351 uint8_t decline_reason; 352 bd_addr_t decline_addr; 353 354 uint8_t adv_addr_type; 355 bd_addr_t adv_address; 356 357 } hci_stack_t; 358 359 // create and send hci command packets based on a template and a list of parameters 360 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 361 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 362 363 void hci_connectable_control(uint8_t enable); 364 void hci_close(void); 365 366 /** 367 * run the hci control loop once 368 */ 369 void hci_run(void); 370 371 // send complete CMD packet 372 int hci_send_cmd_packet(uint8_t *packet, int size); 373 374 // send ACL packet 375 int hci_send_acl_packet(uint8_t *packet, int size); 376 377 // non-blocking UART driver needs 378 int hci_can_send_packet_now(uint8_t packet_type); 379 380 bd_addr_t * hci_local_bd_addr(void); 381 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 382 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 383 uint8_t hci_number_free_acl_slots(void); 384 int hci_authentication_active_for_handle(hci_con_handle_t handle); 385 uint16_t hci_max_acl_data_packet_length(void); 386 uint16_t hci_usable_acl_packet_types(void); 387 uint8_t* hci_get_outgoing_acl_packet_buffer(void); 388 389 // 390 void hci_emit_state(void); 391 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 392 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 393 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 394 void hci_emit_nr_connections_changed(void); 395 void hci_emit_hci_open_failed(void); 396 void hci_emit_btstack_version(void); 397 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 398 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 399 void hci_emit_discoverable_enabled(uint8_t enabled); 400 401 402 /** Embedded API **/ 403 404 // Set up HCI. 405 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 406 407 // Registers a packet handler. Used if L2CAP is not used (rarely). 408 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 409 410 // Requests the change of BTstack power mode. 411 int hci_power_control(HCI_POWER_MODE mode); 412 413 // Allows to control if device is discoverable. OFF by default. 414 void hci_discoverable_control(uint8_t enable); 415 416 // Creates and sends HCI command packets based on a template and 417 // a list of parameters. Will return error if outgoing data buffer 418 // is occupied. 419 int hci_send_cmd(const hci_cmd_t *cmd, ...); 420 421 // Deletes link key for remote device with baseband address. 422 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 423 424 // Configure Secure Simple Pairing 425 426 // enable will enable SSP during init 427 void hci_ssp_set_enable(int enable); 428 429 // if set, BTstack will respond to io capability request using authentication requirement 430 void hci_ssp_set_io_capability(int ssp_io_capability); 431 void hci_ssp_set_authentication_requirement(int authentication_requirement); 432 433 // if set, BTstack will confirm a numberic comparion and enter '000000' if requested 434 void hci_ssp_set_auto_accept(int auto_accept); 435 436 // get addr type and address used in advertisement packets 437 void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t * addr); 438 439 #if defined __cplusplus 440 } 441 #endif 442