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 46 #include <stdint.h> 47 #include <stdlib.h> 48 #include <stdarg.h> 49 50 // packet header lenghts 51 #define HCI_CMD_DATA_PKT_HDR 0x03 52 #define HCI_ACL_DATA_PKT_HDR 0x04 53 #define HCI_SCO_DATA_PKT_HDR 0x03 54 #define HCI_EVENT_PKT_HDR 0x02 55 56 // OGFs 57 #define OGF_LINK_CONTROL 0x01 58 #define OGF_LINK_POLICY 0x02 59 #define OGF_CONTROLLER_BASEBAND 0x03 60 #define OGF_INFORMATIONAL_PARAMETERS 0x04 61 #define OGF_BTSTACK 0x3d 62 #define OGF_VENDOR 0x3f 63 64 // cmds for BTstack 65 // get state: @returns HCI_STATE 66 #define BTSTACK_GET_STATE 0x01 67 68 // set power mode: @param HCI_POWER_MODE 69 #define BTSTACK_SET_POWER_MODE 0x02 70 71 // set capture mode: @param on 72 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 73 74 // get BTstack version 75 #define BTSTACK_GET_VERSION 0x04 76 77 // get system Bluetooth state 78 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 79 80 // set system Bluetooth state 81 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 82 83 // create l2cap channel: @param bd_addr(48), psm (16) 84 #define L2CAP_CREATE_CHANNEL 0x20 85 86 // disconnect l2cap disconnect, @param channel(16), reason(8) 87 #define L2CAP_DISCONNECT 0x21 88 89 // register l2cap service: @param psm(16), mtu (16) 90 #define L2CAP_REGISTER_SERVICE 0x22 91 92 // unregister l2cap disconnect, @param psm(16) 93 #define L2CAP_UNREGISTER_SERVICE 0x23 94 95 // accept connection @param bd_addr(48), dest cid (16) 96 #define L2CAP_ACCEPT_CONNECTION 0x24 97 98 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 99 #define L2CAP_DECLINE_CONNECTION 0x25 100 101 // 102 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 103 104 // data: event(8) 105 #define DAEMON_EVENT_CONNECTION_CLOSED 0x70 106 107 // data: event(8), nr_connections(8) 108 #define DAEMON_NR_CONNECTIONS_CHANGED 0x71 109 110 111 /** 112 * Connection State 113 */ 114 typedef enum { 115 SEND_NEGATIVE_LINK_KEY_REQUEST = 1 << 0, 116 SEND_PIN_CODE_RESPONSE = 1 << 1 117 } hci_connection_flags_t; 118 119 typedef enum { 120 SENT_CREATE_CONNECTION = 1, 121 RECEIVED_CONNECTION_REQUEST, 122 ACCEPTED_CONNECTION_REQUEST, 123 REJECTED_CONNECTION_REQUEST, 124 OPEN, 125 SENT_DISCONNECT 126 } CONNECTION_STATE; 127 128 typedef enum { 129 BLUETOOTH_OFF = 1, 130 BLUETOOTH_ON, 131 BLUETOOTH_ACTIVE 132 } BLUETOOTH_STATE; 133 134 typedef struct { 135 // linked list - assert: first field 136 linked_item_t item; 137 138 // remote side 139 bd_addr_t address; 140 141 // module handle 142 hci_con_handle_t con_handle; 143 144 // state 145 CONNECTION_STATE state; 146 147 // errands 148 hci_connection_flags_t flags; 149 150 // timer 151 timer_source_t timeout; 152 struct timeval timestamp; 153 154 // ACL packet recombination 155 uint8_t acl_recombination_buffer[350]; // max packet: DH5 = header(4) + payload (339) 156 uint16_t acl_recombination_pos; 157 uint16_t acl_recombination_length; 158 159 } hci_connection_t; 160 161 /** 162 * main data structure 163 */ 164 typedef struct { 165 // transport component with configuration 166 hci_transport_t * hci_transport; 167 void * config; 168 169 // hardware power controller 170 bt_control_t * control; 171 172 // list of existing baseband connections 173 linked_list_t connections; 174 175 // single buffer for HCI Command assembly 176 uint8_t * hci_cmd_buffer; 177 178 /* host to controller flow control */ 179 uint8_t num_cmd_packets; 180 uint8_t num_acl_packets; 181 182 /* callback to L2CAP layer */ 183 void (*event_packet_handler)(uint8_t *packet, uint16_t size); 184 void (*acl_packet_handler) (uint8_t *packet, uint16_t size); 185 186 /* hci state machine */ 187 HCI_STATE state; 188 uint8_t substate; 189 uint8_t cmds_ready; 190 191 } hci_stack_t; 192 193 // create and send hci command packets based on a template and a list of parameters 194 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 195 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, va_list argptr); 196 197 // set up HCI 198 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control); 199 200 void hci_register_event_packet_handler(void (*handler)(uint8_t *packet, uint16_t size)); 201 202 void hci_register_acl_packet_handler (void (*handler)(uint8_t *packet, uint16_t size)); 203 204 // power control 205 int hci_power_control(HCI_POWER_MODE mode); 206 207 /** 208 * run the hci control loop once 209 */ 210 void hci_run(); 211 212 // create and send hci command packets based on a template and a list of parameters 213 int hci_send_cmd(hci_cmd_t *cmd, ...); 214 215 // send complete CMD packet 216 int hci_send_cmd_packet(uint8_t *packet, int size); 217 218 // send ACL packet 219 int hci_send_acl_packet(uint8_t *packet, int size); 220 221 hci_connection_t * connection_for_handle(hci_con_handle_t con_handle); 222 223 // 224 void hci_emit_state(); 225 void hci_emit_connection_complete(hci_connection_t *conn); 226 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 227 void hci_emit_nr_connections_changed(); 228 void hci_emit_hci_open_failed(); 229 void hci_emit_btstack_version(); 230 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 231