1 /* 2 * Copyright (C) 2009 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 * 17 * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 21 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 25 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 27 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 */ 31 32 /* 33 * hci.h 34 * 35 * Created by Matthias Ringwald on 4/29/09. 36 * 37 */ 38 39 #pragma once 40 41 #include "../config.h" 42 43 #include <btstack/hci_cmds.h> 44 #include <btstack/utils.h> 45 #include "hci_transport.h" 46 #include "bt_control.h" 47 #include "remote_device_db.h" 48 49 #include <stdint.h> 50 #include <stdlib.h> 51 #include <stdarg.h> 52 53 #if defined __cplusplus 54 extern "C" { 55 #endif 56 57 // packet header sizes 58 #define HCI_CMD_HEADER_SIZE 3 59 #define HCI_ACL_HEADER_SIZE 4 60 #define HCI_SCO_HEADER_SIZE 3 61 #define HCI_EVENT_HEADER_SIZE 2 62 63 // packet sizes (max payload) 64 #define HCI_ACL_DM1_SIZE 17 65 #define HCI_ACL_DH1_SIZE 27 66 #define HCI_ACL_2DH1_SIZE 54 67 #define HCI_ACL_3DH1_SIZE 83 68 #define HCI_ACL_DM3_SIZE 121 69 #define HCI_ACL_DH3_SIZE 183 70 #define HCI_ACL_DM5_SIZE 224 71 #define HCI_ACL_DH5_SIZE 339 72 #define HCI_ACL_2DH3_SIZE 367 73 #define HCI_ACL_3DH3_SIZE 552 74 #define HCI_ACL_2DH5_SIZE 679 75 #define HCI_ACL_3DH5_SIZE 1021 76 77 #define HCI_EVENT_PAYLOAD_SIZE 255 78 #define HCI_CMD_PAYLOAD_SIZE 255 79 80 // packet buffer sizes 81 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 82 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE) 83 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 84 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 85 86 // size of hci buffers, big enough for command, event, or acl packet without H4 packet type 87 // @note cmd buffer is bigger than event buffer 88 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 89 #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 90 #else 91 #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 92 #endif 93 94 // OGFs 95 #define OGF_LINK_CONTROL 0x01 96 #define OGF_LINK_POLICY 0x02 97 #define OGF_CONTROLLER_BASEBAND 0x03 98 #define OGF_INFORMATIONAL_PARAMETERS 0x04 99 #define OGF_BTSTACK 0x3d 100 #define OGF_VENDOR 0x3f 101 102 // cmds for BTstack 103 // get state: @returns HCI_STATE 104 #define BTSTACK_GET_STATE 0x01 105 106 // set power mode: @param HCI_POWER_MODE 107 #define BTSTACK_SET_POWER_MODE 0x02 108 109 // set capture mode: @param on 110 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 111 112 // get BTstack version 113 #define BTSTACK_GET_VERSION 0x04 114 115 // get system Bluetooth state 116 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 117 118 // set system Bluetooth state 119 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 120 121 // enable inquiry scan for this client 122 #define BTSTACK_SET_DISCOVERABLE 0x07 123 124 // set global Bluetooth state 125 #define BTSTACK_SET_BLUETOOTH_ENABLED 0x08 126 127 // create l2cap channel: @param bd_addr(48), psm (16) 128 #define L2CAP_CREATE_CHANNEL 0x20 129 130 // disconnect l2cap disconnect, @param channel(16), reason(8) 131 #define L2CAP_DISCONNECT 0x21 132 133 // register l2cap service: @param psm(16), mtu (16) 134 #define L2CAP_REGISTER_SERVICE 0x22 135 136 // unregister l2cap disconnect, @param psm(16) 137 #define L2CAP_UNREGISTER_SERVICE 0x23 138 139 // accept connection @param bd_addr(48), dest cid (16) 140 #define L2CAP_ACCEPT_CONNECTION 0x24 141 142 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 143 #define L2CAP_DECLINE_CONNECTION 0x25 144 145 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16) 146 #define L2CAP_CREATE_CHANNEL_MTU 0x26 147 148 // register SDP Service Record: service record (size) 149 #define SDP_REGISTER_SERVICE_RECORD 0x30 150 151 // unregister SDP Service Record 152 #define SDP_UNREGISTER_SERVICE_RECORD 0x31 153 154 // RFCOMM "HCI" Commands 155 #define RFCOMM_CREATE_CHANNEL 0x40 156 #define RFCOMM_DISCONNECT 0x41 157 #define RFCOMM_REGISTER_SERVICE 0x42 158 #define RFCOMM_UNREGISTER_SERVICE 0x43 159 #define RFCOMM_ACCEPT_CONNECTION 0x44 160 #define RFCOMM_DECLINE_CONNECTION 0x45 161 #define RFCOMM_PERSISTENT_CHANNEL 0x46 162 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS 0x47 163 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48 164 #define RFCOMM_GRANT_CREDITS 0x49 165 166 // 167 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 168 169 // data: event(8) 170 #define DAEMON_EVENT_CONNECTION_OPENED 0x50 171 172 // data: event(8) 173 #define DAEMON_EVENT_CONNECTION_CLOSED 0x51 174 175 // data: event(8), nr_connections(8) 176 #define DAEMON_NR_CONNECTIONS_CHANGED 0x52 177 178 // data: event(8) 179 #define DAEMON_EVENT_NEW_RFCOMM_CREDITS 0x53 180 181 // data: event() 182 #define DAEMON_EVENT_HCI_PACKET_SENT 0x54 183 184 /** 185 * Connection State 186 */ 187 typedef enum { 188 AUTH_FLAGS_NONE = 0x00, 189 RECV_LINK_KEY_REQUEST = 0x01, 190 HANDLE_LINK_KEY_REQUEST = 0x02, 191 SENT_LINK_KEY_REPLY = 0x04, 192 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x08, 193 RECV_LINK_KEY_NOTIFICATION = 0x10, 194 RECV_PIN_CODE_REQUEST = 0x20, 195 SENT_PIN_CODE_REPLY = 0x40, 196 SENT_PIN_CODE_NEGATIVE_REPLY = 0x80 197 } hci_authentication_flags_t; 198 199 typedef enum { 200 SENT_CREATE_CONNECTION = 1, 201 RECEIVED_CONNECTION_REQUEST, 202 ACCEPTED_CONNECTION_REQUEST, 203 REJECTED_CONNECTION_REQUEST, 204 OPEN, 205 SENT_DISCONNECT 206 } CONNECTION_STATE; 207 208 typedef enum { 209 BLUETOOTH_OFF = 1, 210 BLUETOOTH_ON, 211 BLUETOOTH_ACTIVE 212 } BLUETOOTH_STATE; 213 214 typedef struct { 215 // linked list - assert: first field 216 linked_item_t item; 217 218 // remote side 219 bd_addr_t address; 220 221 // module handle 222 hci_con_handle_t con_handle; 223 224 // state 225 CONNECTION_STATE state; 226 227 // errands 228 hci_authentication_flags_t authentication_flags; 229 230 timer_source_t timeout; 231 232 #ifdef HAVE_TIME 233 // timer 234 struct timeval timestamp; 235 #endif 236 #ifdef HAVE_TICK 237 uint32_t timestamp; // timeout in system ticks 238 #endif 239 240 // ACL packet recombination - ACL Header + ACL payload 241 uint8_t acl_recombination_buffer[4 + HCI_ACL_BUFFER_SIZE]; 242 uint16_t acl_recombination_pos; 243 uint16_t acl_recombination_length; 244 245 // number ACL packets sent to controller 246 uint8_t num_acl_packets_sent; 247 248 } hci_connection_t; 249 250 /** 251 * main data structure 252 */ 253 typedef struct { 254 // transport component with configuration 255 hci_transport_t * hci_transport; 256 void * config; 257 258 // hardware power controller 259 bt_control_t * control; 260 261 // list of existing baseband connections 262 linked_list_t connections; 263 264 // single buffer for HCI Command assembly 265 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 266 267 /* host to controller flow control */ 268 uint8_t num_cmd_packets; 269 // uint8_t total_num_cmd_packets; 270 uint8_t total_num_acl_packets; 271 uint16_t acl_data_packet_length; 272 273 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 274 uint16_t packet_types; 275 276 /* callback to L2CAP layer */ 277 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 278 279 /* remote device db */ 280 remote_device_db_t *remote_device_db; 281 282 /* hci state machine */ 283 HCI_STATE state; 284 uint8_t substate; 285 uint8_t cmds_ready; 286 287 uint8_t discoverable; 288 289 /* buffer for scan enable cmd - 0xff no change */ 290 uint8_t new_scan_enable_value; 291 292 // buffer for single connection decline 293 uint8_t decline_reason; 294 bd_addr_t decline_addr; 295 296 } hci_stack_t; 297 298 // create and send hci command packets based on a template and a list of parameters 299 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 300 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 301 302 // set up HCI 303 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t * remote_device_db); 304 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 305 void hci_close(void); 306 307 // power and inquriy scan control 308 int hci_power_control(HCI_POWER_MODE mode); 309 void hci_discoverable_control(uint8_t enable); 310 311 /** 312 * run the hci control loop once 313 */ 314 void hci_run(void); 315 316 // create and send hci command packets based on a template and a list of parameters 317 int hci_send_cmd(const hci_cmd_t *cmd, ...); 318 319 // send complete CMD packet 320 int hci_send_cmd_packet(uint8_t *packet, int size); 321 322 // send ACL packet 323 int hci_send_acl_packet(uint8_t *packet, int size); 324 325 // non-blocking UART driver needs 326 int hci_can_send_packet_now(uint8_t packet_type); 327 328 hci_connection_t * connection_for_handle(hci_con_handle_t con_handle); 329 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 330 uint8_t hci_number_free_acl_slots(void); 331 int hci_authentication_active_for_handle(hci_con_handle_t handle); 332 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 333 uint16_t hci_max_acl_data_packet_length(void); 334 uint16_t hci_usable_acl_packet_types(void); 335 uint8_t* hci_get_outgoing_acl_packet_buffer(void); 336 337 // 338 void hci_emit_state(void); 339 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 340 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 341 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 342 void hci_emit_nr_connections_changed(void); 343 void hci_emit_hci_open_failed(void); 344 void hci_emit_btstack_version(void); 345 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 346 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 347 void hci_emit_discoverable_enabled(uint8_t enabled); 348 349 #if defined __cplusplus 350 } 351 #endif 352