1 /****************************************************************************** 2 * 3 * Copyright (C) 2005-2012 Broadcom Corporation 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at: 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 ******************************************************************************/ 18 19 /****************************************************************************** 20 * 21 * This file contains BTA HID Host internal definitions 22 * 23 ******************************************************************************/ 24 25 #ifndef BTA_HH_INT_H 26 #define BTA_HH_INT_H 27 28 #include "bta/bta_sys.h" 29 #include "bta/utl.h" 30 #include "bta/bta_hh_api.h" 31 32 //#if BTA_HH_LE_INCLUDED == TRUE 33 #include "bta/bta_gatt_api.h" 34 //#endif 35 #if defined(BTA_HH_INCLUDED) && (BTA_HH_INCLUDED == TRUE) 36 37 /* can be moved to bta/bta_api.h */ 38 #define BTA_HH_MAX_RPT_CHARS 8 39 40 #if (BTA_GATT_INCLUDED == FALSE || BLE_INCLUDED == FALSE) 41 #undef BTA_HH_LE_INCLUDED 42 #define BTA_HH_LE_INCLUDED FALSE 43 #endif 44 45 /* state machine events, these events are handled by the state machine */ 46 enum { 47 BTA_HH_API_OPEN_EVT = BTA_SYS_EVT_START(BTA_ID_HH), 48 BTA_HH_API_CLOSE_EVT, 49 BTA_HH_INT_OPEN_EVT, 50 BTA_HH_INT_CLOSE_EVT, 51 BTA_HH_INT_DATA_EVT, 52 BTA_HH_INT_CTRL_DATA, 53 BTA_HH_INT_HANDSK_EVT, 54 BTA_HH_SDP_CMPL_EVT, 55 BTA_HH_API_WRITE_DEV_EVT, 56 BTA_HH_API_GET_DSCP_EVT, 57 BTA_HH_API_MAINT_DEV_EVT, 58 BTA_HH_OPEN_CMPL_EVT, 59 #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) 60 BTA_HH_GATT_CLOSE_EVT, 61 BTA_HH_GATT_OPEN_EVT, 62 BTA_HH_START_ENC_EVT, 63 BTA_HH_ENC_CMPL_EVT, 64 BTA_HH_GATT_READ_CHAR_CMPL_EVT, 65 BTA_HH_GATT_WRITE_CHAR_CMPL_EVT, 66 BTA_HH_GATT_READ_DESCR_CMPL_EVT, 67 BTA_HH_GATT_WRITE_DESCR_CMPL_EVT, 68 BTA_HH_API_SCPP_UPDATE_EVT, 69 BTA_HH_GATT_ENC_CMPL_EVT, 70 #endif 71 72 /* not handled by execute state machine */ 73 BTA_HH_API_ENABLE_EVT, 74 BTA_HH_API_DISABLE_EVT, 75 BTA_HH_DISC_CMPL_EVT 76 }; 77 typedef UINT16 tBTA_HH_INT_EVT; /* HID host internal events */ 78 79 #define BTA_HH_INVALID_EVT (BTA_HH_DISC_CMPL_EVT + 1) 80 81 /* event used to map between BTE event and BTA event */ 82 #define BTA_HH_FST_TRANS_CB_EVT BTA_HH_GET_RPT_EVT 83 #define BTA_HH_FST_BTE_TRANS_EVT HID_TRANS_GET_REPORT 84 85 /* sub event code used for device maintainence API call */ 86 #define BTA_HH_ADD_DEV 0 87 #define BTA_HH_REMOVE_DEV 1 88 89 /* state machine states */ 90 enum { 91 BTA_HH_NULL_ST, 92 BTA_HH_IDLE_ST, 93 BTA_HH_W4_CONN_ST, 94 BTA_HH_CONN_ST 95 #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) 96 , BTA_HH_W4_SEC 97 #endif 98 , BTA_HH_INVALID_ST /* Used to check invalid states before executing SM function */ 99 100 }; 101 typedef UINT8 tBTA_HH_STATE; 102 103 /* data structure used to send a command/data to HID device */ 104 typedef struct { 105 BT_HDR hdr; 106 UINT8 t_type; 107 UINT8 param; 108 UINT8 rpt_id; 109 #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) 110 UINT8 srvc_id; 111 #endif 112 UINT16 data; 113 BT_HDR *p_data; 114 } tBTA_HH_CMD_DATA; 115 116 /* data type for BTA_HH_API_ENABLE_EVT */ 117 typedef struct { 118 BT_HDR hdr; 119 UINT8 sec_mask; 120 UINT8 service_name[BTA_SERVICE_NAME_LEN + 1]; 121 tBTA_HH_CBACK *p_cback; 122 } tBTA_HH_API_ENABLE; 123 124 typedef struct { 125 BT_HDR hdr; 126 BD_ADDR bd_addr; 127 UINT8 sec_mask; 128 tBTA_HH_PROTO_MODE mode; 129 } tBTA_HH_API_CONN; 130 131 /* internal event data from BTE HID callback */ 132 typedef struct { 133 BT_HDR hdr; 134 BD_ADDR addr; 135 UINT32 data; 136 BT_HDR *p_data; 137 } tBTA_HH_CBACK_DATA; 138 139 typedef struct { 140 BT_HDR hdr; 141 BD_ADDR bda; 142 UINT16 attr_mask; 143 UINT16 sub_event; 144 UINT8 sub_class; 145 UINT8 app_id; 146 tBTA_HH_DEV_DSCP_INFO dscp_info; 147 } tBTA_HH_MAINT_DEV; 148 149 #if BTA_HH_LE_INCLUDED == TRUE 150 typedef struct { 151 BT_HDR hdr; 152 UINT16 conn_id; 153 tBTA_GATT_REASON reason; /* disconnect reason code, not useful when connect event is reported */ 154 155 } tBTA_HH_LE_CLOSE; 156 157 typedef struct { 158 BT_HDR hdr; 159 UINT16 scan_int; 160 UINT16 scan_win; 161 } tBTA_HH_SCPP_UPDATE; 162 #endif 163 /* union of all event data types */ 164 typedef union { 165 BT_HDR hdr; 166 tBTA_HH_API_ENABLE api_enable; 167 tBTA_HH_API_CONN api_conn; 168 tBTA_HH_CMD_DATA api_sndcmd; 169 tBTA_HH_CBACK_DATA hid_cback; 170 tBTA_HH_STATUS status; 171 tBTA_HH_MAINT_DEV api_maintdev; 172 #if BTA_HH_LE_INCLUDED == TRUE 173 tBTA_HH_LE_CLOSE le_close; 174 tBTA_GATTC_OPEN le_open; 175 tBTA_HH_SCPP_UPDATE le_scpp_update; 176 tBTA_GATTC_ENC_CMPL_CB le_enc_cmpl; 177 #endif 178 } tBTA_HH_DATA; 179 180 #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) 181 typedef struct { 182 UINT8 index; 183 BOOLEAN in_use; 184 UINT8 inst_id; /* share service instance ID and report instance ID, as 185 hi 4 for service instance ID, low 4 as charatceristic instance ID */ 186 tBTA_HH_RPT_TYPE rpt_type; 187 UINT16 uuid; 188 UINT8 prop; 189 UINT8 rpt_id; 190 BOOLEAN client_cfg_exist; 191 UINT16 client_cfg_value; 192 } tBTA_HH_LE_RPT; 193 194 #ifndef BTA_HH_LE_RPT_MAX 195 #define BTA_HH_LE_RPT_MAX 20 196 #endif 197 198 typedef struct { 199 BOOLEAN in_use; 200 tBTA_HH_LE_RPT report[BTA_HH_LE_RPT_MAX]; 201 202 #define BTA_HH_LE_PROTO_MODE_BIT 0x01 203 #define BTA_HH_LE_CP_BIT 0x02 204 UINT8 option_char; /* control point char exisit or not */ 205 206 BOOLEAN expl_incl_srvc; 207 UINT8 incl_srvc_inst; /* assuming only one included service : battery service */ 208 UINT8 cur_expl_char_idx; /* currently discovering service index */ 209 UINT8 *rpt_map; 210 UINT16 ext_rpt_ref; 211 tBTA_HH_DEV_DESCR descriptor; 212 213 } tBTA_HH_LE_HID_SRVC; 214 215 #ifndef BTA_HH_LE_HID_SRVC_MAX 216 #define BTA_HH_LE_HID_SRVC_MAX 1 217 #endif 218 219 /* convert a HID handle to the LE CB index */ 220 #define BTA_HH_GET_LE_CB_IDX(x) (((x) >> 4) - 1) 221 /* convert a GATT connection ID to HID device handle, it is the hi 4 bits of a UINT8 */ 222 #define BTA_HH_GET_LE_DEV_HDL(x) (UINT8)(((x) + 1) << 4) 223 /* check to see if th edevice handle is a LE device handle */ 224 #define BTA_HH_IS_LE_DEV_HDL(x) ((x) & 0xf0) 225 #define BTA_HH_IS_LE_DEV_HDL_VALID(x) (((x)>>4) <= BTA_HH_LE_MAX_KNOWN) 226 #endif 227 228 /* device control block */ 229 typedef struct { 230 tBTA_HH_DEV_DSCP_INFO dscp_info; /* report descriptor and DI information */ 231 BD_ADDR addr; /* BD-Addr of the HID device */ 232 UINT16 attr_mask; /* attribute mask */ 233 UINT16 w4_evt; /* W4_handshake event name */ 234 UINT8 index; /* index number referenced to handle index */ 235 UINT8 sub_class; /* Cod sub class */ 236 UINT8 sec_mask; /* security mask */ 237 UINT8 app_id; /* application ID for this connection */ 238 UINT8 hid_handle; /* device handle : low 4 bits for regular HID: HID_HOST_MAX_DEVICES can not exceed 15; 239 high 4 bits for LE HID: GATT_MAX_PHY_CHANNEL can not exceed 15 */ 240 BOOLEAN vp; /* virtually unplug flag */ 241 BOOLEAN in_use; /* control block currently in use */ 242 BOOLEAN incoming_conn; /* is incoming connection? */ 243 UINT8 incoming_hid_handle; /* temporary handle for incoming connection? */ 244 BOOLEAN opened; /* TRUE if device successfully opened HID connection */ 245 tBTA_HH_PROTO_MODE mode; /* protocol mode */ 246 tBTA_HH_PROTO_MODE new_mode; /* protocol mode */ 247 tBTA_HH_STATE state; /* CB state */ 248 249 #if (BTA_HH_LE_INCLUDED == TRUE) 250 #define BTA_HH_LE_DISC_NONE 0x00 251 #define BTA_HH_LE_DISC_HIDS 0x01 252 #define BTA_HH_LE_DISC_DIS 0x02 253 #define BTA_HH_LE_DISC_SCPS 0x04 254 255 UINT8 disc_active; 256 tBTA_HH_STATUS status; 257 tBTA_GATT_REASON reason; 258 BOOLEAN is_le_device; 259 tBTA_HH_LE_HID_SRVC hid_srvc[BTA_HH_LE_HID_SRVC_MAX]; 260 UINT16 conn_id; 261 BOOLEAN in_bg_conn; 262 UINT8 total_srvc; 263 UINT8 clt_cfg_idx; 264 UINT8 cur_srvc_index; /* currently discovering service index */ 265 BOOLEAN scps_supported; 266 267 #define BTA_HH_LE_SCPS_NOTIFY_NONE 0 268 #define BTA_HH_LE_SCPS_NOTIFY_SPT 0x01 269 #define BTA_HH_LE_SCPS_NOTIFY_ENB 0x02 270 UINT8 scps_notify; /* scan refresh supported/notification enabled */ 271 #endif 272 273 BOOLEAN security_pending; 274 } tBTA_HH_DEV_CB; 275 276 /* key board parsing control block */ 277 typedef struct { 278 BOOLEAN mod_key[4]; /* ctrl, shift(upper), Alt, GUI */ 279 BOOLEAN num_lock; 280 BOOLEAN caps_lock; 281 UINT8 last_report[BTA_HH_MAX_RPT_CHARS]; 282 } tBTA_HH_KB_CB; 283 284 /****************************************************************************** 285 ** Main Control Block 286 *******************************************************************************/ 287 typedef struct { 288 tBTA_HH_KB_CB kb_cb; /* key board control block, 289 suppose BTA will connect 290 to only one keyboard at 291 the same time */ 292 tBTA_HH_DEV_CB kdev[BTA_HH_MAX_DEVICE]; /* device control block */ 293 tBTA_HH_DEV_CB *p_cur; /* current device control 294 block idx, used in sdp */ 295 UINT8 cb_index[BTA_HH_MAX_KNOWN]; /* maintain a CB index 296 map to dev handle */ 297 #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) 298 UINT8 le_cb_index[BTA_HH_MAX_DEVICE]; /* maintain a CB index map to LE dev handle */ 299 tBTA_GATTC_IF gatt_if; 300 #endif 301 tBTA_HH_CBACK *p_cback; /* Application callbacks */ 302 tSDP_DISCOVERY_DB *p_disc_db; 303 UINT8 trace_level; /* tracing level */ 304 UINT8 cnt_num; /* connected device number */ 305 BOOLEAN w4_disable; /* w4 disable flag */ 306 } 307 tBTA_HH_CB; 308 309 #if BTA_DYNAMIC_MEMORY == FALSE 310 extern tBTA_HH_CB bta_hh_cb; 311 #else 312 extern tBTA_HH_CB *bta_hh_cb_ptr; 313 #define bta_hh_cb (*bta_hh_cb_ptr) 314 #endif 315 316 /* from bta_hh_cfg.c */ 317 extern tBTA_HH_CFG *p_bta_hh_cfg; 318 319 /***************************************************************************** 320 ** Function prototypes 321 *****************************************************************************/ 322 extern BOOLEAN bta_hh_hdl_event(BT_HDR *p_msg); 323 extern void bta_hh_sm_execute(tBTA_HH_DEV_CB *p_cb, UINT16 event, 324 tBTA_HH_DATA *p_data); 325 326 /* action functions */ 327 extern void bta_hh_api_disc_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 328 extern void bta_hh_open_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 329 extern void bta_hh_close_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 330 extern void bta_hh_data_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 331 extern void bta_hh_ctrl_dat_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 332 extern void bta_hh_start_sdp(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 333 extern void bta_hh_sdp_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 334 extern void bta_hh_write_dev_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 335 extern void bta_hh_get_dscp_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 336 extern void bta_hh_handsk_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 337 extern void bta_hh_maint_dev_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 338 extern void bta_hh_open_cmpl_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 339 extern void bta_hh_open_failure(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 340 341 /* utility functions */ 342 extern UINT8 bta_hh_find_cb(BD_ADDR bda); 343 extern void bta_hh_parse_keybd_rpt(tBTA_HH_BOOT_RPT *p_kb_data, 344 UINT8 *p_report, UINT16 report_len); 345 extern void bta_hh_parse_mice_rpt(tBTA_HH_BOOT_RPT *p_kb_data, 346 UINT8 *p_report, UINT16 report_len); 347 extern BOOLEAN bta_hh_tod_spt(tBTA_HH_DEV_CB *p_cb, UINT8 sub_class); 348 extern void bta_hh_clean_up_kdev(tBTA_HH_DEV_CB *p_cb); 349 350 extern void bta_hh_add_device_to_list(tBTA_HH_DEV_CB *p_cb, UINT8 handle, 351 UINT16 attr_mask, 352 tHID_DEV_DSCP_INFO *p_dscp_info, 353 UINT8 sub_class, UINT16 max_latency, UINT16 min_tout, UINT8 app_id); 354 extern void bta_hh_update_di_info(tBTA_HH_DEV_CB *p_cb, UINT16 vendor_id, UINT16 product_id, 355 UINT16 version, UINT8 flag); 356 extern void bta_hh_cleanup_disable(tBTA_HH_STATUS status); 357 358 extern UINT8 bta_hh_dev_handle_to_cb_idx(UINT8 dev_handle); 359 360 /* action functions used outside state machine */ 361 extern void bta_hh_api_enable(tBTA_HH_DATA *p_data); 362 extern void bta_hh_api_disable(void); 363 extern void bta_hh_disc_cmpl(void); 364 365 extern tBTA_HH_STATUS bta_hh_read_ssr_param(BD_ADDR bd_addr, UINT16 *p_max_ssr_lat, UINT16 *p_min_ssr_tout); 366 367 /* functions for LE HID */ 368 #if (BTA_HH_LE_INCLUDED == TRUE) 369 extern void bta_hh_le_enable(void); 370 extern BOOLEAN bta_hh_le_is_hh_gatt_if(tBTA_GATTC_IF client_if); 371 extern void bta_hh_le_deregister(void); 372 extern BOOLEAN bta_hh_is_le_device(tBTA_HH_DEV_CB *p_cb, BD_ADDR remote_bda); 373 extern void bta_hh_le_open_conn(tBTA_HH_DEV_CB *p_cb, BD_ADDR remote_bda); 374 extern void bta_hh_le_api_disc_act(tBTA_HH_DEV_CB *p_cb); 375 extern void bta_hh_le_get_dscp_act(tBTA_HH_DEV_CB *p_cb); 376 extern void bta_hh_le_write_dev_act(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 377 extern UINT8 bta_hh_le_add_device(tBTA_HH_DEV_CB *p_cb, tBTA_HH_MAINT_DEV *p_dev_info); 378 extern void bta_hh_le_remove_dev_bg_conn(tBTA_HH_DEV_CB *p_cb); 379 extern void bta_hh_le_open_fail(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 380 extern void bta_hh_gatt_open(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 381 extern void bta_hh_gatt_close(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 382 extern void bta_hh_start_security(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 383 extern void bta_hh_start_srvc_discovery(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 384 extern void bta_hh_w4_le_read_char_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 385 extern void bta_hh_le_read_char_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 386 extern void bta_hh_w4_le_read_descr_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 387 extern void bta_hh_le_read_descr_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 388 extern void bta_hh_w4_le_write_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 389 extern void bta_hh_le_write_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 390 extern void bta_hh_le_write_char_descr_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 391 extern void bta_hh_start_security(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 392 extern void bta_hh_security_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 393 extern void bta_hh_le_update_scpp(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 394 extern void bta_hh_le_notify_enc_cmpl(tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_data); 395 extern void bta_hh_ci_load_rpt (tBTA_HH_DEV_CB *p_cb, tBTA_HH_DATA *p_buf); 396 #endif 397 398 #if BTA_HH_DEBUG 399 extern void bta_hh_trace_dev_db(void); 400 #endif 401 402 #endif ///defined(BTA_HH_INCLUDED) && (BTA_HH_INCLUDED == TRUE) 403 #endif 404
