1/****************************************************************************** 2 * 3 * Copyright (C) 2002-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#ifndef HIDH_API_H 19#define HIDH_API_H 20 21#include "hiddefs.h" 22#include "sdp_api.h" 23 24/***************************************************************************** 25** Constants 26*****************************************************************************/ 27 28enum { 29 HID_SDP_NO_SERV_UUID = (SDP_ILLEGAL_PARAMETER+1), 30 HID_SDP_MANDATORY_MISSING 31}; 32 33/* Attributes mask values to be used in HID_HostAddDev API */ 34#define HID_VIRTUAL_CABLE 0x0001 35#define HID_NORMALLY_CONNECTABLE 0x0002 36#define HID_RECONN_INIT 0x0004 37#define HID_SDP_DISABLE 0x0008 38#define HID_BATTERY_POWER 0x0010 39#define HID_REMOTE_WAKE 0x0020 40#define HID_SUP_TOUT_AVLBL 0x0040 41#define HID_SSR_MAX_LATENCY 0x0080 42#define HID_SSR_MIN_TOUT 0x0100 43 44#define HID_SEC_REQUIRED 0x8000 45#define HID_ATTR_MASK_IGNORE 0 46 47 48/***************************************************************************** 49** Type Definitions 50*****************************************************************************/ 51 52typedef void (tHID_HOST_SDP_CALLBACK) (UINT16 result, UINT16 attr_mask, 53 tHID_DEV_SDP_INFO *sdp_rec ); 54 55/* HID-HOST returns the events in the following table to the application via tHID_HOST_DEV_CALLBACK 56HID_HDEV_EVT_OPEN Connected to device with Interrupt and Control Channels in OPEN state. 57 Data = NA 58HID_HDEV_EVT_CLOSE Connection with device is closed. Data=reason code. 59HID_HDEV_EVT_RETRYING Lost connection is being re-connected. 60 Data=Retrial number 61HID_HDEV_EVT_IN_REPORT Device sent an input report Data=Report Type pdata= pointer to BT_HDR 62 (GKI buffer having report data.) 63HID_HDEV_EVT_HANDSHAKE Device sent SET_REPORT Data=Result-code pdata=NA. 64HID_HDEV_EVT_VC_UNPLUG Device sent Virtual Unplug Data=NA. pdata=NA. 65*/ 66 67enum 68{ 69 HID_HDEV_EVT_OPEN, 70 HID_HDEV_EVT_CLOSE, 71 HID_HDEV_EVT_RETRYING, 72 HID_HDEV_EVT_INTR_DATA, 73 HID_HDEV_EVT_INTR_DATC, 74 HID_HDEV_EVT_CTRL_DATA, 75 HID_HDEV_EVT_CTRL_DATC, 76 HID_HDEV_EVT_HANDSHAKE, 77 HID_HDEV_EVT_VC_UNPLUG 78}; 79typedef void (tHID_HOST_DEV_CALLBACK) (UINT8 dev_handle, 80 BD_ADDR addr, 81 UINT8 event, /* Event from HID-DEVICE. */ 82 UINT32 data, /* Integer data corresponding to the event.*/ 83 BT_HDR *p_buf ); /* Pointer data corresponding to the event. */ 84 85 86/***************************************************************************** 87** External Function Declarations 88*****************************************************************************/ 89#ifdef __cplusplus 90extern "C" 91{ 92#endif 93 94/******************************************************************************* 95** 96** Function HID_HostGetSDPRecord 97** 98** Description This function reads the device SDP record. 99** 100** Returns tHID_STATUS 101** 102*******************************************************************************/ 103HID_API extern tHID_STATUS HID_HostGetSDPRecord (BD_ADDR addr, 104 tSDP_DISCOVERY_DB *p_db, 105 UINT32 db_len, 106 tHID_HOST_SDP_CALLBACK *sdp_cback ); 107 108/******************************************************************************* 109** 110** Function HID_HostRegister 111** 112** Description This function registers HID-Host with lower layers. 113** 114** Returns tHID_STATUS 115** 116*******************************************************************************/ 117HID_API extern tHID_STATUS HID_HostRegister (tHID_HOST_DEV_CALLBACK *dev_cback); 118 119/******************************************************************************* 120** 121** Function HID_HostDeregister 122** 123** Description This function is called when the host is about power down. 124** 125** Returns tHID_STATUS 126** 127*******************************************************************************/ 128HID_API extern tHID_STATUS HID_HostDeregister(void); 129 130/******************************************************************************* 131** 132** Function HID_HostAddDev 133** 134** Description This is called so HID-host may manage this device. 135** 136** Returns tHID_STATUS 137** 138*******************************************************************************/ 139HID_API extern tHID_STATUS HID_HostAddDev (BD_ADDR addr, UINT16 attr_mask, 140 UINT8 *handle ); 141 142/******************************************************************************* 143** 144** Function HID_HostRemoveDev 145** 146** Description This removes the device from list devices that host has to manage. 147** 148** Returns tHID_STATUS 149** 150*******************************************************************************/ 151HID_API extern tHID_STATUS HID_HostRemoveDev (UINT8 dev_handle ); 152 153/******************************************************************************* 154** 155** Function HID_HostOpenDev 156** 157** Description This function is called when the user wants to initiate a 158** connection attempt to a device. 159** 160** Returns void 161** 162*******************************************************************************/ 163HID_API extern tHID_STATUS HID_HostOpenDev (UINT8 dev_handle ); 164 165/******************************************************************************* 166** 167** Function HID_HostWriteDev 168** 169** Description This function is called when the host has a report to send. 170** 171** Returns void 172** 173*******************************************************************************/ 174HID_API extern tHID_STATUS HID_HostWriteDev(UINT8 dev_handle, UINT8 t_type, 175 UINT8 param, UINT16 data, 176 UINT8 report_id, BT_HDR *pbuf); 177 178/******************************************************************************* 179** 180** Function HID_HostCloseDev 181** 182** Description This function disconnects the device. 183** 184** Returns void 185** 186*******************************************************************************/ 187HID_API extern tHID_STATUS HID_HostCloseDev(UINT8 dev_handle ); 188 189/******************************************************************************* 190** Function HID_HostInit 191** 192** Description This function initializes the control block and trace variable 193** 194** Returns void 195*******************************************************************************/ 196HID_API extern void HID_HostInit(void); 197 198/******************************************************************************* 199** Function HID_HostSetSecurityLevel 200** 201** Description This function sets the security level for the devices which 202** are marked by application as requiring security 203** 204** Returns tHID_STATUS 205*******************************************************************************/ 206HID_API extern tHID_STATUS HID_HostSetSecurityLevel( char serv_name[], UINT8 sec_lvl ); 207 208/******************************************************************************* 209** 210** Function hid_known_hid_device 211** 212** Description This function checks if this device is of type HID Device 213** 214** Returns TRUE if device exists else FALSE 215** 216*******************************************************************************/ 217BOOLEAN hid_known_hid_device (BD_ADDR bd_addr); 218 219 220/******************************************************************************* 221** 222** Function HID_HostSetTraceLevel 223** 224** Description This function sets the trace level for HID Host. If called with 225** a value of 0xFF, it simply reads the current trace level. 226** 227** Returns the new (current) trace level 228** 229*******************************************************************************/ 230HID_API extern UINT8 HID_HostSetTraceLevel (UINT8 new_level); 231 232#ifdef __cplusplus 233} 234#endif 235 236#endif /* HIDH_API_H */ 237