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_CONTROLLER_BASEBAND 0x03 59 #define OGF_INFORMATIONAL_PARAMETERS 0x04 60 #define OGF_BTSTACK 0x3d 61 #define OGF_VENDOR 0x3f 62 63 // cmds for BTstack 64 // get state: @returns HCI_STATE 65 #define BTSTACK_GET_STATE 0x01 66 67 // set power mode: @param HCI_POWER_MODE 68 #define BTSTACK_SET_POWER_MODE 0x02 69 70 // set capture mode: @param on 71 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 72 73 // get BTstack version 74 #define BTSTACK_GET_VERSION 0x04 75 76 // create l2cap channel: @param bd_addr(48), psm (16) 77 #define L2CAP_CREATE_CHANNEL 0x20 78 79 // disconnect l2cap disconnect, @param channel(16), reason(8) 80 #define L2CAP_DISCONNECT 0x21 81 82 // 83 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 84 85 // data: event(8) 86 #define DAEMON_EVENT_CONNECTION_CLOSED 0x70 87 88 // data: event(8), nr_connections(8) 89 #define DAEMON_NR_CONNECTIONS_CHANGED 0x71 90 91 92 /** 93 * Connection State 94 */ 95 typedef enum { 96 SEND_NEGATIVE_LINK_KEY_REQUEST = 1 << 0, 97 SEND_PIN_CODE_RESPONSE = 1 << 1 98 } hci_connection_flags_t; 99 100 typedef enum { 101 SENT_CREATE_CONNECTION = 1, 102 RECEIVED_CONNECTION_REQUEST, 103 ACCEPTED_CONNECTION_REQUEST, 104 REJECTED_CONNECTION_REQUEST, 105 OPEN, 106 SENT_DISCONNECT 107 } CONNECTION_STATE; 108 109 typedef enum { 110 BLUETOOTH_OFF = 1, 111 BLUETOOTH_ON, 112 BLUETOOTH_ACTIVE 113 } BLUETOOTH_STATE; 114 115 typedef struct { 116 // linked list - assert: first field 117 linked_item_t item; 118 119 // remote side 120 bd_addr_t address; 121 122 // module handle 123 hci_con_handle_t con_handle; 124 125 // state 126 CONNECTION_STATE state; 127 128 // errands 129 hci_connection_flags_t flags; 130 131 // timer 132 timer_source_t timeout; 133 struct timeval timestamp; 134 135 } hci_connection_t; 136 137 /** 138 * main data structure 139 */ 140 typedef struct { 141 // transport component with configuration 142 hci_transport_t * hci_transport; 143 void * config; 144 145 // hardware power controller 146 bt_control_t * control; 147 148 // list of existing baseband connections 149 linked_list_t connections; 150 151 // single buffer for HCI Command assembly 152 uint8_t * hci_cmd_buffer; 153 154 /* host to controller flow control */ 155 uint8_t num_cmd_packets; 156 uint8_t num_acl_packets; 157 158 /* callback to L2CAP layer */ 159 void (*event_packet_handler)(uint8_t *packet, uint16_t size); 160 void (*acl_packet_handler) (uint8_t *packet, uint16_t size); 161 162 /* hci state machine */ 163 HCI_STATE state; 164 uint8_t substate; 165 uint8_t cmds_ready; 166 167 } hci_stack_t; 168 169 // create and send hci command packets based on a template and a list of parameters 170 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 171 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, va_list argptr); 172 173 // set up HCI 174 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control); 175 176 void hci_register_event_packet_handler(void (*handler)(uint8_t *packet, uint16_t size)); 177 178 void hci_register_acl_packet_handler (void (*handler)(uint8_t *packet, uint16_t size)); 179 180 // power control 181 int hci_power_control(HCI_POWER_MODE mode); 182 183 /** 184 * run the hci control loop once 185 */ 186 void hci_run(); 187 188 // create and send hci command packets based on a template and a list of parameters 189 int hci_send_cmd(hci_cmd_t *cmd, ...); 190 191 // send complete CMD packet 192 int hci_send_cmd_packet(uint8_t *packet, int size); 193 194 // send ACL packet 195 int hci_send_acl_packet(uint8_t *packet, int size); 196 197 // 198 void hci_emit_state(); 199 void hci_emit_connection_complete(hci_connection_t *conn); 200 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 201 void hci_emit_nr_connections_changed(); 202 void hci_emit_hci_open_failed(); 203 void hci_emit_btstack_version(); 204 205