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 <btstack/hci_cmds.h> 42 #include <btstack/utils.h> 43 #include "hci_transport.h" 44 #include "bt_control.h" 45 #include "remote_device_db.h" 46 47 #include <stdint.h> 48 #include <stdlib.h> 49 #include <stdarg.h> 50 51 #if defined __cplusplus 52 extern "C" { 53 #endif 54 55 // packet header lenghts 56 #define HCI_CMD_DATA_PKT_HDR 0x03 57 #define HCI_ACL_DATA_PKT_HDR 0x04 58 #define HCI_SCO_DATA_PKT_HDR 0x03 59 #define HCI_EVENT_PKT_HDR 0x02 60 61 // packet sizes (max payload) 62 #define HCI_ACL_DM1_SIZE 17 63 #define HCI_ACL_DH1_SIZE 27 64 #define HCI_ACL_2DH1_SIZE 54 65 #define HCI_ACL_3DH1_SIZE 83 66 #define HCI_ACL_DM3_SIZE 121 67 #define HCI_ACL_DH3_SIZE 183 68 #define HCI_ACL_DM5_SIZE 224 69 #define HCI_ACL_DH5_SIZE 339 70 #define HCI_ACL_2DH3_SIZE 367 71 #define HCI_ACL_3DH3_SIZE 552 72 #define HCI_ACL_2HH5_SIZE 679 73 #define HCI_ACL_3DH5_SIZE 1021 74 75 // OGFs 76 #define OGF_LINK_CONTROL 0x01 77 #define OGF_LINK_POLICY 0x02 78 #define OGF_CONTROLLER_BASEBAND 0x03 79 #define OGF_INFORMATIONAL_PARAMETERS 0x04 80 #define OGF_BTSTACK 0x3d 81 #define OGF_VENDOR 0x3f 82 83 // cmds for BTstack 84 // get state: @returns HCI_STATE 85 #define BTSTACK_GET_STATE 0x01 86 87 // set power mode: @param HCI_POWER_MODE 88 #define BTSTACK_SET_POWER_MODE 0x02 89 90 // set capture mode: @param on 91 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 92 93 // get BTstack version 94 #define BTSTACK_GET_VERSION 0x04 95 96 // get system Bluetooth state 97 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 98 99 // set system Bluetooth state 100 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 101 102 // enable inquiry scan for this client 103 #define BTSTACK_SET_DISCOVERABLE 0x07 104 105 // set global Bluetooth state 106 #define BTSTACK_SET_BLUETOOTH_ENABLED 0x08 107 108 // create l2cap channel: @param bd_addr(48), psm (16) 109 #define L2CAP_CREATE_CHANNEL 0x20 110 111 // disconnect l2cap disconnect, @param channel(16), reason(8) 112 #define L2CAP_DISCONNECT 0x21 113 114 // register l2cap service: @param psm(16), mtu (16) 115 #define L2CAP_REGISTER_SERVICE 0x22 116 117 // unregister l2cap disconnect, @param psm(16) 118 #define L2CAP_UNREGISTER_SERVICE 0x23 119 120 // accept connection @param bd_addr(48), dest cid (16) 121 #define L2CAP_ACCEPT_CONNECTION 0x24 122 123 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 124 #define L2CAP_DECLINE_CONNECTION 0x25 125 126 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16) 127 #define L2CAP_CREATE_CHANNEL_MTU 0x26 128 129 // register SDP Service Record: service record (size) 130 #define SDP_REGISTER_SERVICE_RECORD 0x30 131 132 // unregister SDP Service Record 133 #define SDP_UNREGISTER_SERVICE_RECORD 0x31 134 135 // RFCOMM "HCI" Commands 136 #define RFCOMM_CREATE_CHANNEL 0x40 137 #define RFCOMM_DISCONNECT 0x41 138 #define RFCOMM_REGISTER_SERVICE 0x42 139 #define RFCOMM_UNREGISTER_SERVICE 0x43 140 #define RFCOMM_ACCEPT_CONNECTION 0x44 141 #define RFCOMM_DECLINE_CONNECTION 0x45 142 #define RFCOMM_PERSISTENT_CHANNEL 0x46 143 144 // 145 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 146 147 // data: event(8) 148 #define DAEMON_EVENT_CONNECTION_OPENED 0x50 149 150 // data: event(8) 151 #define DAEMON_EVENT_CONNECTION_CLOSED 0x51 152 153 // data: event(8), nr_connections(8) 154 #define DAEMON_NR_CONNECTIONS_CHANGED 0x52 155 156 // data: event(8) 157 #define DAEMON_EVENT_NEW_RFCOMM_CREDITS 0x53 158 159 // data: event() 160 #define DAEMON_EVENT_HCI_PACKET_SENT 0x54 161 162 /** 163 * Connection State 164 */ 165 typedef enum { 166 AUTH_FLAGS_NONE = 0x00, 167 RECV_LINK_KEY_REQUEST = 0x01, 168 HANDLE_LINK_KEY_REQUEST = 0x02, 169 SENT_LINK_KEY_REPLY = 0x04, 170 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x08, 171 RECV_LINK_KEY_NOTIFICATION = 0x10, 172 RECV_PIN_CODE_REQUEST = 0x20, 173 SENT_PIN_CODE_REPLY = 0x40, 174 SENT_PIN_CODE_NEGATIVE_REPLY = 0x80 175 } hci_authentication_flags_t; 176 177 typedef enum { 178 SENT_CREATE_CONNECTION = 1, 179 RECEIVED_CONNECTION_REQUEST, 180 ACCEPTED_CONNECTION_REQUEST, 181 REJECTED_CONNECTION_REQUEST, 182 OPEN, 183 SENT_DISCONNECT 184 } CONNECTION_STATE; 185 186 typedef enum { 187 BLUETOOTH_OFF = 1, 188 BLUETOOTH_ON, 189 BLUETOOTH_ACTIVE 190 } BLUETOOTH_STATE; 191 192 typedef struct { 193 // linked list - assert: first field 194 linked_item_t item; 195 196 // remote side 197 bd_addr_t address; 198 199 // module handle 200 hci_con_handle_t con_handle; 201 202 // state 203 CONNECTION_STATE state; 204 205 // errands 206 hci_authentication_flags_t authentication_flags; 207 208 timer_source_t timeout; 209 210 #ifdef HAVE_TIME 211 // timer 212 struct timeval timestamp; 213 #endif 214 #ifdef EMBEDDED 215 uint32_t timestamp; // timeout in system ticks 216 #endif 217 218 // ACL packet recombination 219 uint8_t acl_recombination_buffer[4 + HCI_ACL_3DH5_SIZE]; 220 uint16_t acl_recombination_pos; 221 uint16_t acl_recombination_length; 222 223 // number ACL packets sent to controller 224 uint8_t num_acl_packets_sent; 225 226 } hci_connection_t; 227 228 /** 229 * main data structure 230 */ 231 typedef struct { 232 // transport component with configuration 233 hci_transport_t * hci_transport; 234 void * config; 235 236 // hardware power controller 237 bt_control_t * control; 238 239 // list of existing baseband connections 240 linked_list_t connections; 241 242 // single buffer for HCI Command assembly 243 uint8_t hci_cmd_buffer[3+255]; // opcode (16), len(8) 244 245 /* host to controller flow control */ 246 uint8_t num_cmd_packets; 247 // uint8_t total_num_cmd_packets; 248 uint8_t total_num_acl_packets; 249 uint16_t acl_data_packet_length; 250 251 /* callback to L2CAP layer */ 252 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 253 254 /* remote device db */ 255 remote_device_db_t *remote_device_db; 256 257 /* hci state machine */ 258 HCI_STATE state; 259 uint8_t substate; 260 uint8_t cmds_ready; 261 262 /* */ 263 uint8_t discoverable; 264 265 // buffer for single connection decline 266 uint8_t decline_reason; 267 bd_addr_t decline_addr; 268 269 } hci_stack_t; 270 271 // create and send hci command packets based on a template and a list of parameters 272 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 273 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 274 275 // set up HCI 276 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t * remote_device_db); 277 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 278 void hci_close(void); 279 280 // power and inquriy scan control 281 int hci_power_control(HCI_POWER_MODE mode); 282 void hci_discoverable_control(uint8_t enable); 283 284 /** 285 * run the hci control loop once 286 */ 287 void hci_run(void); 288 289 // create and send hci command packets based on a template and a list of parameters 290 int hci_send_cmd(const hci_cmd_t *cmd, ...); 291 292 // send complete CMD packet 293 int hci_send_cmd_packet(uint8_t *packet, int size); 294 295 // send ACL packet 296 int hci_send_acl_packet(uint8_t *packet, int size); 297 298 // non-blocking UART driver needs 299 int hci_can_send_packet_now(uint8_t packet_type); 300 301 hci_connection_t * connection_for_handle(hci_con_handle_t con_handle); 302 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 303 uint8_t hci_number_free_acl_slots(void); 304 int hci_authentication_active_for_handle(hci_con_handle_t handle); 305 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr); 306 uint16_t hci_max_acl_data_packet_length(void); 307 308 // 309 void hci_emit_state(void); 310 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 311 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 312 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 313 void hci_emit_nr_connections_changed(void); 314 void hci_emit_hci_open_failed(void); 315 void hci_emit_btstack_version(void); 316 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 317 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name); 318 void hci_emit_discoverable_enabled(uint8_t enabled); 319 320 #if defined __cplusplus 321 } 322 #endif 323