| /****************************************************************************** |
| * |
| * Copyright (C) 2002-2012 Broadcom Corporation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at: |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| ******************************************************************************/ |
| #ifndef BTA_HH_API_H |
| #define BTA_HH_API_H |
| |
| #include "bta_api.h" |
| #include "hidh_api.h" |
| |
| #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) |
| #include "gatt_api.h" |
| #endif |
| |
| /***************************************************************************** |
| ** Constants and Type Definitions |
| *****************************************************************************/ |
| #ifndef BTA_HH_DEBUG |
| #define BTA_HH_DEBUG TRUE |
| #endif |
| |
| #ifndef BTA_HH_SSR_MAX_LATENCY_DEF |
| #define BTA_HH_SSR_MAX_LATENCY_DEF 800 /* 500 ms*/ |
| #endif |
| |
| #ifndef BTA_HH_SSR_MIN_TOUT_DEF |
| #define BTA_HH_SSR_MIN_TOUT_DEF 2 |
| #endif |
| |
| /* BTA HID Host callback events */ |
| #define BTA_HH_ENABLE_EVT 0 /* HH enabled */ |
| #define BTA_HH_DISABLE_EVT 1 /* HH disabled */ |
| #define BTA_HH_OPEN_EVT 2 /* connection opened */ |
| #define BTA_HH_CLOSE_EVT 3 /* connection closed */ |
| #define BTA_HH_GET_RPT_EVT 4 /* BTA_HhGetReport callback */ |
| #define BTA_HH_SET_RPT_EVT 5 /* BTA_HhSetReport callback */ |
| #define BTA_HH_GET_PROTO_EVT 6 /* BTA_GetProtoMode callback */ |
| #define BTA_HH_SET_PROTO_EVT 7 /* BTA_HhSetProtoMode callback */ |
| #define BTA_HH_GET_IDLE_EVT 8 /* BTA_HhGetIdle comes callback */ |
| #define BTA_HH_SET_IDLE_EVT 9 /* BTA_HhSetIdle finish callback */ |
| #define BTA_HH_GET_DSCP_EVT 10 /* Get report descriptor */ |
| #define BTA_HH_ADD_DEV_EVT 11 /* Add Device callback */ |
| #define BTA_HH_RMV_DEV_EVT 12 /* remove device finished */ |
| #define BTA_HH_VC_UNPLUG_EVT 13 /* virtually unplugged */ |
| #define BTA_HH_DATA_EVT 15 |
| #define BTA_HH_API_ERR_EVT 16 /* API error is caught */ |
| #define BTA_HH_UPDATE_SCPP_EVT 17 /* update scan paramter complete */ |
| |
| typedef UINT16 tBTA_HH_EVT; |
| |
| /* application ID(none-zero) for each type of device */ |
| #define BTA_HH_APP_ID_MI 1 |
| #define BTA_HH_APP_ID_KB 2 |
| #define BTA_HH_APP_ID_RMC 3 |
| #define BTA_HH_APP_ID_3DSG 4 |
| #define BTA_HH_APP_ID_JOY 5 |
| #define BTA_HH_APP_ID_GPAD 6 |
| #define BTA_HH_APP_ID_LE 0xff |
| |
| /* defined the minimum offset */ |
| #define BTA_HH_MIN_OFFSET L2CAP_MIN_OFFSET+1 |
| |
| /* HID_HOST_MAX_DEVICES can not exceed 15 for th design of BTA HH */ |
| #define BTA_HH_IDX_INVALID 0xff |
| #define BTA_HH_MAX_KNOWN HID_HOST_MAX_DEVICES |
| |
| #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) |
| /* GATT_MAX_PHY_CHANNEL can not exceed 14 for the design of BTA HH */ |
| #define BTA_HH_LE_MAX_KNOWN GATT_MAX_PHY_CHANNEL |
| #define BTA_HH_MAX_DEVICE (HID_HOST_MAX_DEVICES + GATT_MAX_PHY_CHANNEL) |
| #else |
| #define BTA_HH_MAX_DEVICE HID_HOST_MAX_DEVICES |
| #endif |
| /* invalid device handle */ |
| #define BTA_HH_INVALID_HANDLE 0xff |
| |
| /* type of protocol mode */ |
| #define BTA_HH_PROTO_RPT_MODE (0x00) |
| #define BTA_HH_PROTO_BOOT_MODE (0x01) |
| #define BTA_HH_PROTO_UNKNOWN (0xff) |
| typedef UINT8 tBTA_HH_PROTO_MODE; |
| |
| enum |
| { |
| BTA_HH_KEYBD_RPT_ID = 1, |
| BTA_HH_MOUSE_RPT_ID |
| }; |
| typedef UINT8 tBTA_HH_BOOT_RPT_ID; |
| |
| /* type of devices, bit mask */ |
| #define BTA_HH_DEVT_UNKNOWN 0x00 |
| #define BTA_HH_DEVT_JOS 0x01 /* joy stick */ |
| #define BTA_HH_DEVT_GPD 0x02 /* game pad */ |
| #define BTA_HH_DEVT_RMC 0x03 /* remote control */ |
| #define BTA_HH_DEVT_SED 0x04 /* sensing device */ |
| #define BTA_HH_DEVT_DGT 0x05 /* Digitizer tablet */ |
| #define BTA_HH_DEVT_CDR 0x06 /* card reader */ |
| #define BTA_HH_DEVT_KBD 0x10 /* keyboard */ |
| #define BTA_HH_DEVT_MIC 0x20 /* pointing device */ |
| #define BTA_HH_DEVT_COM 0x30 /* Combo keyboard/pointing */ |
| #define BTA_HH_DEVT_OTHER 0x80 |
| typedef UINT8 tBTA_HH_DEVT; |
| |
| enum |
| { |
| BTA_HH_OK, |
| BTA_HH_HS_HID_NOT_READY, /* handshake error : device not ready */ |
| BTA_HH_HS_INVALID_RPT_ID, /* handshake error : invalid report ID */ |
| BTA_HH_HS_TRANS_NOT_SPT, /* handshake error : transaction not spt */ |
| BTA_HH_HS_INVALID_PARAM, /* handshake error : invalid paremter */ |
| BTA_HH_HS_ERROR, /* handshake error : unspecified HS error */ |
| BTA_HH_ERR, /* general BTA HH error */ |
| BTA_HH_ERR_SDP, /* SDP error */ |
| BTA_HH_ERR_PROTO, /* SET_Protocol error, |
| only used in BTA_HH_OPEN_EVT callback */ |
| |
| BTA_HH_ERR_DB_FULL, /* device database full error, used in |
| BTA_HH_OPEN_EVT/BTA_HH_ADD_DEV_EVT */ |
| BTA_HH_ERR_TOD_UNSPT, /* type of device not supported */ |
| BTA_HH_ERR_NO_RES, /* out of system resources */ |
| BTA_HH_ERR_AUTH_FAILED, /* authentication fail */ |
| BTA_HH_ERR_HDL, |
| BTA_HH_ERR_SEC |
| }; |
| typedef UINT8 tBTA_HH_STATUS; |
| |
| |
| #define BTA_HH_VIRTUAL_CABLE HID_VIRTUAL_CABLE |
| #define BTA_HH_NORMALLY_CONNECTABLE HID_NORMALLY_CONNECTABLE |
| #define BTA_HH_RECONN_INIT HID_RECONN_INIT |
| #define BTA_HH_SDP_DISABLE HID_SDP_DISABLE |
| #define BTA_HH_BATTERY_POWER HID_BATTERY_POWER |
| #define BTA_HH_REMOTE_WAKE HID_REMOTE_WAKE |
| #define BTA_HH_SUP_TOUT_AVLBL HID_SUP_TOUT_AVLBL |
| #define BTA_HH_SEC_REQUIRED HID_SEC_REQUIRED |
| typedef UINT16 tBTA_HH_ATTR_MASK; |
| |
| /* supported type of device and corresponding application ID */ |
| typedef struct |
| { |
| tBTA_HH_DEVT tod; /* type of device */ |
| UINT8 app_id; /* corresponding application ID */ |
| }tBTA_HH_SPT_TOD; |
| |
| /* configuration struct */ |
| typedef struct |
| { |
| UINT8 max_devt_spt; /* max number of types of devices spt */ |
| tBTA_HH_SPT_TOD *p_devt_list; /* supported types of device list */ |
| UINT16 sdp_db_size; |
| }tBTA_HH_CFG; |
| |
| enum |
| { |
| BTA_HH_RPTT_RESRV, /* reserved */ |
| BTA_HH_RPTT_INPUT, /* input report */ |
| BTA_HH_RPTT_OUTPUT, /* output report */ |
| BTA_HH_RPTT_FEATURE /* feature report */ |
| }; |
| typedef UINT8 tBTA_HH_RPT_TYPE; |
| |
| /* HID_CONTROL operation code used in BTA_HhSendCtrl() |
| */ |
| enum |
| { |
| BTA_HH_CTRL_NOP = 0 + HID_PAR_CONTROL_NOP ,/* mapping from BTE */ |
| BTA_HH_CTRL_HARD_RESET, /* hard reset */ |
| BTA_HH_CTRL_SOFT_RESET, /* soft reset */ |
| BTA_HH_CTRL_SUSPEND, /* enter suspend */ |
| BTA_HH_CTRL_EXIT_SUSPEND, /* exit suspend */ |
| BTA_HH_CTRL_VIRTUAL_CABLE_UNPLUG /* virtual unplug */ |
| }; |
| typedef UINT8 tBTA_HH_TRANS_CTRL_TYPE; |
| |
| typedef tHID_DEV_DSCP_INFO tBTA_HH_DEV_DESCR; |
| |
| #define BTA_HH_SSR_PARAM_INVALID HID_SSR_PARAM_INVALID |
| |
| /* id DI is not existing in remote device, vendor_id in tBTA_HH_DEV_DSCP_INFO will be set to 0xffff */ |
| #define BTA_HH_VENDOR_ID_INVALID 0xffff |
| |
| |
| /* report descriptor information */ |
| typedef struct |
| { |
| UINT16 vendor_id; /* vendor ID */ |
| UINT16 product_id; /* product ID */ |
| UINT16 version; /* version */ |
| UINT16 ssr_max_latency; /* SSR max latency, BTA_HH_SSR_PARAM_INVALID if unknown */ |
| UINT16 ssr_min_tout; /* SSR min timeout, BTA_HH_SSR_PARAM_INVALID if unknown */ |
| UINT8 ctry_code; /*Country Code.*/ |
| #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) |
| #define BTA_HH_LE_REMOTE_WAKE 0x01 |
| #define BTA_HH_LE_NORMAL_CONN 0x02 |
| |
| UINT8 flag; |
| #endif |
| tBTA_HH_DEV_DESCR descriptor; |
| }tBTA_HH_DEV_DSCP_INFO; |
| |
| /* callback event data for BTA_HH_OPEN_EVT */ |
| typedef struct |
| { |
| BD_ADDR bda; /* HID device bd address */ |
| tBTA_HH_STATUS status; /* operation status */ |
| UINT8 handle; /* device handle */ |
| #if (defined BTA_HH_LE_INCLUDED && BTA_HH_LE_INCLUDED == TRUE) |
| BOOLEAN le_hid; /* is LE devices? */ |
| BOOLEAN scps_supported; /* scan parameter service supported */ |
| #endif |
| |
| } tBTA_HH_CONN; |
| |
| typedef tBTA_HH_CONN tBTA_HH_DEV_INFO; |
| |
| /* callback event data */ |
| typedef struct |
| { |
| tBTA_HH_STATUS status; /* operation status */ |
| UINT8 handle; /* device handle */ |
| } tBTA_HH_CBDATA; |
| |
| enum |
| { |
| BTA_HH_MOD_CTRL_KEY, |
| BTA_HH_MOD_SHFT_KEY, |
| BTA_HH_MOD_ALT_KEY, |
| BTA_HH_MOD_GUI_KEY, |
| BTA_HH_MOD_MAX_KEY |
| }; |
| |
| /* parsed boot mode keyboard report */ |
| typedef struct |
| { |
| UINT8 this_char[6]; /* virtual key code */ |
| BOOLEAN mod_key[BTA_HH_MOD_MAX_KEY]; |
| /* ctrl, shift, Alt, GUI */ |
| /* modifier key: is Shift key pressed */ |
| /* modifier key: is Ctrl key pressed */ |
| /* modifier key: is Alt key pressed */ |
| /* modifier key: GUI up/down */ |
| BOOLEAN caps_lock; /* is caps locked */ |
| BOOLEAN num_lock; /* is Num key pressed */ |
| } tBTA_HH_KEYBD_RPT; |
| |
| /* parsed boot mode mouse report */ |
| typedef struct |
| { |
| UINT8 mouse_button; /* mouse button is clicked */ |
| INT8 delta_x; /* displacement x */ |
| INT8 delta_y; /* displacement y */ |
| }tBTA_HH_MICE_RPT; |
| |
| /* parsed Boot report */ |
| typedef struct |
| { |
| tBTA_HH_BOOT_RPT_ID dev_type; /* type of device report */ |
| union |
| { |
| tBTA_HH_KEYBD_RPT keybd_rpt; /* keyboard report */ |
| tBTA_HH_MICE_RPT mice_rpt; /* mouse report */ |
| } data_rpt; |
| } tBTA_HH_BOOT_RPT; |
| |
| /* handshake data */ |
| typedef struct |
| { |
| tBTA_HH_STATUS status; /* handshake status */ |
| UINT8 handle; /* device handle */ |
| union |
| { |
| tBTA_HH_PROTO_MODE proto_mode; /* GET_PROTO_EVT :protocol mode */ |
| BT_HDR *p_rpt_data; /* GET_RPT_EVT : report data */ |
| UINT8 idle_rate; /* GET_IDLE_EVT : idle rate */ |
| } rsp_data; |
| |
| }tBTA_HH_HSDATA; |
| |
| /* union of data associated with HD callback */ |
| typedef union |
| { |
| tBTA_HH_DEV_INFO dev_info; /* BTA_HH_ADD_DEV_EVT, BTA_HH_RMV_DEV_EVT */ |
| tBTA_HH_CONN conn; /* BTA_HH_OPEN_EVT */ |
| tBTA_HH_CBDATA dev_status; /* BTA_HH_CLOSE_EVT, |
| BTA_HH_SET_PROTO_EVT |
| BTA_HH_SET_RPT_EVT |
| BTA_HH_SET_IDLE_EVT |
| BTA_HH_UPDATE_SCPP_EVT */ |
| |
| tBTA_HH_STATUS status; /* BTA_HH_ENABLE_EVT */ |
| tBTA_HH_DEV_DSCP_INFO dscp_info; /* BTA_HH_GET_DSCP_EVT */ |
| tBTA_HH_HSDATA hs_data; /* GET_ transaction callback |
| BTA_HH_GET_RPT_EVT |
| BTA_HH_GET_PROTO_EVT |
| BTA_HH_GET_IDLE_EVT */ |
| } tBTA_HH; |
| |
| /* BTA HH callback function */ |
| typedef void (tBTA_HH_CBACK) (tBTA_HH_EVT event, tBTA_HH *p_data); |
| |
| |
| /***************************************************************************** |
| ** External Function Declarations |
| *****************************************************************************/ |
| #ifdef __cplusplus |
| extern "C" |
| { |
| #endif |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhRegister |
| ** |
| ** Description This function enable HID host and registers HID-Host with |
| ** lower layers. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhEnable(tBTA_SEC sec_mask, tBTA_HH_CBACK *p_cback); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhDeregister |
| ** |
| ** Description This function is called when the host is about power down. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhDisable(void); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhOpen |
| ** |
| ** Description This function is called to start an inquiry and read SDP |
| ** record of responding devices; connect to a device if only |
| ** one active HID device is found. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhOpen (BD_ADDR dev_bda, tBTA_HH_PROTO_MODE mode, |
| tBTA_SEC sec_mask); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhClose |
| ** |
| ** Description This function disconnects the device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhClose(UINT8 dev_handle); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSetProtoMode |
| ** |
| ** Description This function set the protocol mode at specified HID handle |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSetProtoMode(UINT8 handle, tBTA_HH_PROTO_MODE t_type); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhGetProtoMode |
| ** |
| ** Description This function get the protocol mode of a specified HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhGetProtoMode(UINT8 dev_handle); |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSetReport |
| ** |
| ** Description send SET_REPORT to device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSetReport(UINT8 dev_handle, tBTA_HH_RPT_TYPE r_type, |
| BT_HDR *p_data); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhGetReport |
| ** |
| ** Description Send a GET_REPORT to HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhGetReport(UINT8 dev_handle, tBTA_HH_RPT_TYPE r_type, |
| UINT8 rpt_id, UINT16 buf_size); |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSetIdle |
| ** |
| ** Description send SET_IDLE to device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSetIdle(UINT8 dev_handle, UINT16 idle_rate); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhGetIdle |
| ** |
| ** Description Send a GET_IDLE to HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhGetIdle(UINT8 dev_handle); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSendCtrl |
| ** |
| ** Description Send HID_CONTROL request to a HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSendCtrl(UINT8 dev_handle, |
| tBTA_HH_TRANS_CTRL_TYPE c_type); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSetIdle |
| ** |
| ** Description send SET_IDLE to device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSetIdle(UINT8 dev_handle, UINT16 idle_rate); |
| |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhGetIdle |
| ** |
| ** Description Send a GET_IDLE from HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhGetIdle(UINT8 dev_handle); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhSendData |
| ** |
| ** Description Send DATA transaction to a HID device. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhSendData(UINT8 dev_handle, BD_ADDR dev_bda, BT_HDR *p_buf); |
| |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhGetDscpInfo |
| ** |
| ** Description Get report descriptor of the device |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhGetDscpInfo(UINT8 dev_handle); |
| |
| /******************************************************************************* |
| ** Function BTA_HhAddDev |
| ** |
| ** Description Add a virtually cabled device into HID-Host device list |
| ** to manage and assign a device handle for future API call, |
| ** host applciation call this API at start-up to initialize its |
| ** virtually cabled devices. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhAddDev(BD_ADDR bda, tBTA_HH_ATTR_MASK attr_mask, |
| UINT8 sub_class, UINT8 app_id, |
| tBTA_HH_DEV_DSCP_INFO dscp_info); |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhRemoveDev |
| ** |
| ** Description Remove a device from the HID host devices list. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhRemoveDev(UINT8 dev_handle ); |
| |
| /******************************************************************************* |
| ** |
| ** Parsing Utility Functions |
| ** |
| *******************************************************************************/ |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhParseBootRpt |
| ** |
| ** Description This utility function parse a boot mode report. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhParseBootRpt(tBTA_HH_BOOT_RPT *p_data, UINT8 *p_report, |
| UINT16 report_len); |
| |
| #if BTA_HH_LE_INCLUDED == TRUE |
| /******************************************************************************* |
| ** |
| ** Function BTA_HhUpdateLeScanParam |
| ** |
| ** Description Update the scan paramteters if connected to a LE hid device as |
| ** report host. |
| ** |
| ** Returns void |
| ** |
| *******************************************************************************/ |
| BTA_API extern void BTA_HhUpdateLeScanParam(UINT8 dev_handle, UINT16 scan_int, UINT16 scan_win); |
| #endif |
| /* test commands */ |
| BTA_API extern void bta_hh_le_hid_read_rpt_clt_cfg(BD_ADDR bd_addr, UINT8 rpt_id); |
| |
| |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* BTA_HH_API_H */ |
