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 // RFCOMM "HCI" Commands 166 #define RFCOMM_CREATE_CHANNEL 0x40 167 #define RFCOMM_DISCONNECT 0x41 168 #define RFCOMM_REGISTER_SERVICE 0x42 169 #define RFCOMM_UNREGISTER_SERVICE 0x43 170 #define RFCOMM_ACCEPT_CONNECTION 0x44 171 #define RFCOMM_DECLINE_CONNECTION 0x45 172 #define RFCOMM_PERSISTENT_CHANNEL 0x46 173 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS 0x47 174 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48 175 #define RFCOMM_GRANT_CREDITS 0x49 176 177 // 178 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 179 180 // data: event(8) 181 #define DAEMON_EVENT_CONNECTION_OPENED 0x50 182 183 // data: event(8) 184 #define DAEMON_EVENT_CONNECTION_CLOSED 0x51 185 186 // data: event(8), nr_connections(8) 187 #define DAEMON_NR_CONNECTIONS_CHANGED 0x52 188 189 // data: event(8) 190 #define DAEMON_EVENT_NEW_RFCOMM_CREDITS 0x53 191 192 // data: event() 193 #define DAEMON_EVENT_HCI_PACKET_SENT 0x54 194 195 /** 196 * Connection State 197 */ 198 typedef enum { 199 AUTH_FLAGS_NONE = 0x00, 200 RECV_LINK_KEY_REQUEST = 0x01, 201 HANDLE_LINK_KEY_REQUEST = 0x02, 202 SENT_LINK_KEY_REPLY = 0x04, 203 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x08, 204 RECV_LINK_KEY_NOTIFICATION = 0x10, 205 RECV_PIN_CODE_REQUEST = 0x20, 206 SENT_PIN_CODE_REPLY = 0x40, 207 SENT_PIN_CODE_NEGATIVE_REPLY = 0x80, 208 // SSP 209 RECV_IO_CAPABILITIES_REQUEST = 0x100; 210 SENT_IO_CAPABILITIES_REPLY = 0x200; 211 } hci_authentication_flags_t; 212 213 typedef enum { 214 SENT_CREATE_CONNECTION = 1, 215 RECEIVED_CONNECTION_REQUEST, 216 ACCEPTED_CONNECTION_REQUEST, 217 REJECTED_CONNECTION_REQUEST, 218 OPEN, 219 SENT_DISCONNECT 220 } CONNECTION_STATE; 221 222 typedef enum { 223 BLUETOOTH_OFF = 1, 224 BLUETOOTH_ON, 225 BLUETOOTH_ACTIVE 226 } BLUETOOTH_STATE; 227 228 typedef struct { 229 // linked list - assert: first field 230 linked_item_t item; 231 232 // remote side 233 bd_addr_t address; 234 235 // module handle 236 hci_con_handle_t con_handle; 237 238 // state 239 CONNECTION_STATE state; 240 241 // errands 242 hci_authentication_flags_t authentication_flags; 243 244 timer_source_t timeout; 245 246 #ifdef HAVE_TIME 247 // timer 248 struct timeval timestamp; 249 #endif 250 #ifdef HAVE_TICK 251 uint32_t timestamp; // timeout in system ticks 252 #endif 253 254 // ACL packet recombination - ACL Header + ACL payload 255 uint8_t acl_recombination_buffer[4 + HCI_ACL_BUFFER_SIZE]; 256 uint16_t acl_recombination_pos; 257 uint16_t acl_recombination_length; 258 259 // number ACL packets sent to controller 260 uint8_t num_acl_packets_sent; 261 262 } hci_connection_t; 263 264 /** 265 * main data structure 266 */ 267 typedef struct { 268 // transport component with configuration 269 hci_transport_t * hci_transport; 270 void * config; 271 272 // bsic configuration 273 char * local_name; 274 uint32_t class_of_device; 275 bd_addr_t local_bd_addr; 276 uint8_t ssp_enable; 277 uint8_t ssp_io_capability; 278 uint8_t ssp_authentication_requirement; 279 uint8_t ssp_auto_accept; 280 281 // hardware power controller 282 bt_control_t * control; 283 284 // list of existing baseband connections 285 linked_list_t connections; 286 287 // single buffer for HCI Command assembly 288 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 289 290 /* host to controller flow control */ 291 uint8_t num_cmd_packets; 292 // uint8_t total_num_cmd_packets; 293 uint8_t total_num_acl_packets; 294 uint16_t acl_data_packet_length; 295 296 /* local supported features */ 297 uint8_t local_supported_features[8]; 298 299 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 300 uint16_t packet_types; 301 302 /* callback to L2CAP layer */ 303 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 304 305 /* remote device db */ 306 remote_device_db_t const*remote_device_db; 307 308 /* hci state machine */ 309 HCI_STATE state; 310 uint8_t substate; 311 uint8_t cmds_ready; 312 313 uint8_t discoverable; 314 uint8_t connectable; 315 316 /* buffer for scan enable cmd - 0xff no change */ 317 uint8_t new_scan_enable_value; 318 319 // buffer for single connection decline 320 uint8_t decline_reason; 321 bd_addr_t decline_addr; 322 323 } hci_stack_t; 324 325 // create and send hci command packets based on a template and a list of parameters 326 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 327 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 328 329 void hci_connectable_control(uint8_t enable); 330 void hci_close(void); 331 332 /** 333 * run the hci control loop once 334 */ 335 void hci_run(void); 336 337 // send complete CMD packet 338 int hci_send_cmd_packet(uint8_t *packet, int size); 339 340 // send ACL packet 341 int hci_send_acl_packet(uint8_t *packet, int size); 342 343 // non-blocking UART driver needs 344 int hci_can_send_packet_now(uint8_t packet_type); 345 346 hci_connection_t * connection_for_handle(hci_con_handle_t con_handle); 347 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 348 uint8_t hci_number_free_acl_slots(void); 349 int hci_authentication_active_for_handle(hci_con_handle_t handle); 350 uint16_t hci_max_acl_data_packet_length(void); 351 uint16_t hci_usable_acl_packet_types(void); 352 uint8_t* hci_get_outgoing_acl_packet_buffer(void); 353 354 // 355 void hci_emit_state(void); 356 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 357 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 358 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 359 void hci_emit_nr_connections_changed(void); 360 void hci_emit_hci_open_failed(void); 361 void hci_emit_btstack_version(void); 362 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 363 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 364 void hci_emit_discoverable_enabled(uint8_t enabled); 365 366 367 /** Embedded API **/ 368 369 // Set up HCI. 370 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 371 372 // Registers a packet handler. Used if L2CAP is not used (rarely). 373 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 374 375 // Requests the change of BTstack power mode. 376 int hci_power_control(HCI_POWER_MODE mode); 377 378 // Allows to control if device is discoverable. OFF by default. 379 void hci_discoverable_control(uint8_t enable); 380 381 // Creates and sends hci command packets based on a template and 382 // a list of parameters. Will return error if outgoing data buffer 383 // is occupied. 384 int hci_send_cmd(const hci_cmd_t *cmd, ...); 385 386 // Deletes link key for remote device with baseband address. 387 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 388 389 390 #if defined __cplusplus 391 } 392 #endif 393