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 // 90 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 91 92 // data: event(8) 93 #define DAEMON_EVENT_CONNECTION_CLOSED 0x70 94 95 // data: event(8), nr_connections(8) 96 #define DAEMON_NR_CONNECTIONS_CHANGED 0x71 97 98 99 /** 100 * Connection State 101 */ 102 typedef enum { 103 SEND_NEGATIVE_LINK_KEY_REQUEST = 1 << 0, 104 SEND_PIN_CODE_RESPONSE = 1 << 1 105 } hci_connection_flags_t; 106 107 typedef enum { 108 SENT_CREATE_CONNECTION = 1, 109 RECEIVED_CONNECTION_REQUEST, 110 ACCEPTED_CONNECTION_REQUEST, 111 REJECTED_CONNECTION_REQUEST, 112 OPEN, 113 SENT_DISCONNECT 114 } CONNECTION_STATE; 115 116 typedef enum { 117 BLUETOOTH_OFF = 1, 118 BLUETOOTH_ON, 119 BLUETOOTH_ACTIVE 120 } BLUETOOTH_STATE; 121 122 typedef struct { 123 // linked list - assert: first field 124 linked_item_t item; 125 126 // remote side 127 bd_addr_t address; 128 129 // module handle 130 hci_con_handle_t con_handle; 131 132 // state 133 CONNECTION_STATE state; 134 135 // errands 136 hci_connection_flags_t flags; 137 138 // timer 139 timer_source_t timeout; 140 struct timeval timestamp; 141 142 } hci_connection_t; 143 144 /** 145 * main data structure 146 */ 147 typedef struct { 148 // transport component with configuration 149 hci_transport_t * hci_transport; 150 void * config; 151 152 // hardware power controller 153 bt_control_t * control; 154 155 // list of existing baseband connections 156 linked_list_t connections; 157 158 // single buffer for HCI Command assembly 159 uint8_t * hci_cmd_buffer; 160 161 /* host to controller flow control */ 162 uint8_t num_cmd_packets; 163 uint8_t num_acl_packets; 164 165 /* callback to L2CAP layer */ 166 void (*event_packet_handler)(uint8_t *packet, uint16_t size); 167 void (*acl_packet_handler) (uint8_t *packet, uint16_t size); 168 169 /* hci state machine */ 170 HCI_STATE state; 171 uint8_t substate; 172 uint8_t cmds_ready; 173 174 } hci_stack_t; 175 176 // create and send hci command packets based on a template and a list of parameters 177 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 178 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, va_list argptr); 179 180 // set up HCI 181 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control); 182 183 void hci_register_event_packet_handler(void (*handler)(uint8_t *packet, uint16_t size)); 184 185 void hci_register_acl_packet_handler (void (*handler)(uint8_t *packet, uint16_t size)); 186 187 // power control 188 int hci_power_control(HCI_POWER_MODE mode); 189 190 /** 191 * run the hci control loop once 192 */ 193 void hci_run(); 194 195 // create and send hci command packets based on a template and a list of parameters 196 int hci_send_cmd(hci_cmd_t *cmd, ...); 197 198 // send complete CMD packet 199 int hci_send_cmd_packet(uint8_t *packet, int size); 200 201 // send ACL packet 202 int hci_send_acl_packet(uint8_t *packet, int size); 203 204 // 205 void hci_emit_state(); 206 void hci_emit_connection_complete(hci_connection_t *conn); 207 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 208 void hci_emit_nr_connections_changed(); 209 void hci_emit_hci_open_failed(); 210 void hci_emit_btstack_version(); 211 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 212