1 /******************************************************************************
3 * Copyright (C) 2002-2012 Broadcom Corporation
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 ******************************************************************************/
19 /******************************************************************************
21 * This file contains the HID HOST API entry points
23 ******************************************************************************/
29 #include "bt_common.h"
38 #if HID_DYNAMIC_MEMORY == FALSE
42 static void hidh_search_callback (UINT16 sdp_result);
44 /*******************************************************************************
46 ** Function HID_HostGetSDPRecord
48 ** Description This function reads the device SDP record
50 ** Returns tHID_STATUS
52 *******************************************************************************/
53 tHID_STATUS HID_HostGetSDPRecord ( BD_ADDR addr, tSDP_DISCOVERY_DB *p_db, UINT32 db_len,
54 tHID_HOST_SDP_CALLBACK *sdp_cback )
59 return HID_ERR_SDP_BUSY;
62 uuid_list.uu.uuid16 = UUID_SERVCLASS_HUMAN_INTERFACE;
64 hh_cb.p_sdp_db = p_db;
65 SDP_InitDiscoveryDb (p_db, db_len, 1, &uuid_list, 0, NULL);
67 if (SDP_ServiceSearchRequest (addr, p_db, hidh_search_callback))
69 hh_cb.sdp_cback = sdp_cback ;
70 hh_cb.sdp_busy = TRUE;
74 return HID_ERR_NO_RESOURCES;
77 void hidh_get_str_attr( tSDP_DISC_REC *p_rec, UINT16 attr_id, UINT16 max_len, char *str )
79 tSDP_DISC_ATTR *p_attr;
82 if ((p_attr = SDP_FindAttributeInRec(p_rec, attr_id)) != NULL)
84 if((name_len = SDP_DISC_ATTR_LEN(p_attr->attr_len_type)) < max_len )
86 memcpy( str, (char *) p_attr->attr_value.v.array, name_len );
91 memcpy( str, (char *) p_attr->attr_value.v.array, max_len-1 );
92 str[max_len-1] = '\0';
100 static void hidh_search_callback (UINT16 sdp_result)
102 tSDP_DISCOVERY_DB *p_db = hh_cb.p_sdp_db;
103 tSDP_DISC_REC *p_rec;
104 tSDP_DISC_ATTR *p_attr, *p_subattr1, *p_subattr2, *p_repdesc;
106 tHID_DEV_SDP_INFO *p_nvi = &hh_cb.sdp_rec;
107 UINT16 attr_mask = 0;
109 hid_uuid.len = LEN_UUID_16;
110 hid_uuid.uu.uuid16 = UUID_SERVCLASS_HUMAN_INTERFACE;
112 hh_cb.sdp_busy = FALSE;
114 if (sdp_result != SDP_SUCCESS)
116 hh_cb.sdp_cback(sdp_result, 0, NULL);
120 if ((p_rec = SDP_FindServiceUUIDInDb (p_db, &hid_uuid, NULL)) == NULL)
122 hh_cb.sdp_cback(HID_SDP_NO_SERV_UUID, 0, NULL);
126 memset (&hh_cb.sdp_rec, 0, sizeof( tHID_DEV_SDP_INFO ));
128 /* First, verify the mandatory fields we care about */
129 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_DESCRIPTOR_LIST)) == NULL)
130 || (SDP_DISC_ATTR_TYPE(p_attr->attr_len_type) != DATA_ELE_SEQ_DESC_TYPE)
131 || ((p_subattr1 = p_attr->attr_value.v.p_sub_attr) == NULL)
132 || (SDP_DISC_ATTR_TYPE(p_subattr1->attr_len_type) != DATA_ELE_SEQ_DESC_TYPE)
133 || ((p_subattr2 = p_subattr1->attr_value.v.p_sub_attr) == NULL)
134 || ((p_repdesc = p_subattr2->p_next_attr) == NULL)
135 || (SDP_DISC_ATTR_TYPE(p_repdesc->attr_len_type) != TEXT_STR_DESC_TYPE))
137 hh_cb.sdp_cback(HID_SDP_MANDATORY_MISSING, 0, NULL);
141 if ((p_nvi->dscp_info.dl_len = SDP_DISC_ATTR_LEN(p_repdesc->attr_len_type)) != 0)
142 p_nvi->dscp_info.dsc_list = (UINT8 *) &p_repdesc->attr_value;
144 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_VIRTUAL_CABLE)) != NULL) &&
145 (p_attr->attr_value.v.u8) )
147 attr_mask |= HID_VIRTUAL_CABLE;
150 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_RECONNECT_INITIATE)) != NULL) &&
151 (p_attr->attr_value.v.u8) )
153 attr_mask |= HID_RECONN_INIT;
156 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_NORMALLY_CONNECTABLE)) != NULL) &&
157 (p_attr->attr_value.v.u8) )
159 attr_mask |= HID_NORMALLY_CONNECTABLE;
162 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_SDP_DISABLE)) != NULL)&&
163 (p_attr->attr_value.v.u8) )
165 attr_mask |= HID_SDP_DISABLE;
168 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_BATTERY_POWER)) != NULL)&&
169 (p_attr->attr_value.v.u8) )
171 attr_mask |= HID_BATTERY_POWER;
174 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_REMOTE_WAKE)) != NULL)&&
175 (p_attr->attr_value.v.u8) )
177 attr_mask |= HID_REMOTE_WAKE;
180 hidh_get_str_attr( p_rec, ATTR_ID_SERVICE_NAME, HID_MAX_SVC_NAME_LEN, p_nvi->svc_name );
181 hidh_get_str_attr( p_rec, ATTR_ID_SERVICE_DESCRIPTION, HID_MAX_SVC_DESCR_LEN, p_nvi->svc_descr );
182 hidh_get_str_attr( p_rec, ATTR_ID_PROVIDER_NAME, HID_MAX_PROV_NAME_LEN, p_nvi->prov_name );
184 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_DEVICE_RELNUM)) != NULL))
186 p_nvi->rel_num = p_attr->attr_value.v.u16;
189 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_COUNTRY_CODE)) != NULL))
191 p_nvi->ctry_code = p_attr->attr_value.v.u8;
194 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_DEVICE_SUBCLASS)) != NULL))
196 p_nvi->sub_class = p_attr->attr_value.v.u8;
199 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_PARSER_VERSION)) != NULL))
201 p_nvi->hpars_ver = p_attr->attr_value.v.u16;
204 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_LINK_SUPERVISION_TO)) != NULL))
206 attr_mask |= HID_SUP_TOUT_AVLBL;
207 p_nvi->sup_timeout = p_attr->attr_value.v.u16;
210 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_SSR_HOST_MAX_LAT)) != NULL))
212 attr_mask |= HID_SSR_MAX_LATENCY;
213 p_nvi->ssr_max_latency = p_attr->attr_value.v.u16;
216 p_nvi->ssr_max_latency = HID_SSR_PARAM_INVALID;
218 if (((p_attr = SDP_FindAttributeInRec (p_rec, ATTR_ID_HID_SSR_HOST_MIN_TOUT)) != NULL))
220 attr_mask |= HID_SSR_MIN_TOUT;
221 p_nvi->ssr_min_tout = p_attr->attr_value.v.u16;
224 p_nvi->ssr_min_tout = HID_SSR_PARAM_INVALID;
226 hh_cb.sdp_rec.p_sdp_layer_rec = p_rec;
227 hh_cb.sdp_cback(SDP_SUCCESS, attr_mask, &hh_cb.sdp_rec);
231 /*******************************************************************************
233 ** Function HID_HostInit
235 ** Description This function initializes the control block and trace variable
239 *******************************************************************************/
240 void HID_HostInit (void)
242 memset(&hh_cb, 0, sizeof(tHID_HOST_CTB));
244 for (size_t i = 0; i < HID_HOST_MAX_DEVICES; i++) {
245 hh_cb.devices[i].conn.process_repage_timer =
246 alarm_new("hid_devices_conn.process_repage_timer");
249 #if defined(HID_INITIAL_TRACE_LEVEL)
250 hh_cb.trace_level = HID_INITIAL_TRACE_LEVEL;
252 hh_cb.trace_level = BT_TRACE_LEVEL_NONE;
256 /*******************************************************************************
258 ** Function HID_HostSetTraceLevel
260 ** Description This function sets the trace level for HID Host. If called with
261 ** a value of 0xFF, it simply reads the current trace level.
263 ** Returns the new (current) trace level
265 *******************************************************************************/
266 UINT8 HID_HostSetTraceLevel (UINT8 new_level)
268 if (new_level != 0xFF)
269 hh_cb.trace_level = new_level;
271 return (hh_cb.trace_level);
274 /*******************************************************************************
276 ** Function HID_HostRegister
278 ** Description This function registers HID-Host with lower layers
280 ** Returns tHID_STATUS
282 *******************************************************************************/
283 tHID_STATUS HID_HostRegister (tHID_HOST_DEV_CALLBACK *dev_cback)
288 return HID_ERR_ALREADY_REGISTERED;
290 if( dev_cback == NULL )
291 return HID_ERR_INVALID_PARAM;
293 /* Register with L2CAP */
294 if( (st = hidh_conn_reg()) != HID_SUCCESS )
299 hh_cb.callback = dev_cback ;
300 hh_cb.reg_flag = TRUE;
302 return (HID_SUCCESS);
305 /*******************************************************************************
307 ** Function HID_HostDeregister
309 ** Description This function is called when the host is about power down.
311 ** Returns tHID_STATUS
313 *******************************************************************************/
314 tHID_STATUS HID_HostDeregister(void)
318 if( !hh_cb.reg_flag )
319 return (HID_ERR_NOT_REGISTERED);
321 for( i=0; i<HID_HOST_MAX_DEVICES; i++ )
323 HID_HostRemoveDev( i ) ;
327 hh_cb.reg_flag = FALSE;
329 return (HID_SUCCESS) ;
332 /*******************************************************************************
334 ** Function HID_HostAddDev
336 ** Description This is called so HID-host may manage this device.
338 ** Returns tHID_STATUS
340 *******************************************************************************/
341 tHID_STATUS HID_HostAddDev ( BD_ADDR addr, UINT16 attr_mask, UINT8 *handle )
344 /* Find an entry for this device in hh_cb.devices array */
345 if( !hh_cb.reg_flag )
346 return (HID_ERR_NOT_REGISTERED);
348 for( i=0; i<HID_HOST_MAX_DEVICES; i++)
350 if((hh_cb.devices[i].in_use) &&
351 (!memcmp(addr, hh_cb.devices[i].addr, BD_ADDR_LEN)))
355 if (i== HID_HOST_MAX_DEVICES )
357 for( i=0; i<HID_HOST_MAX_DEVICES; i++)
359 if( !hh_cb.devices[i].in_use)
364 if( i==HID_HOST_MAX_DEVICES )
365 return HID_ERR_NO_RESOURCES;
367 if (!hh_cb.devices[i].in_use)
369 hh_cb.devices[i].in_use = TRUE;
370 memcpy( hh_cb.devices[i].addr, addr, sizeof( BD_ADDR ) ) ;
371 hh_cb.devices[i].state = HID_DEV_NO_CONN;
372 hh_cb.devices[i].conn_tries = 0 ;
375 if (attr_mask != HID_ATTR_MASK_IGNORE)
376 hh_cb.devices[i].attr_mask = attr_mask;
380 return (HID_SUCCESS);
384 /*******************************************************************************
386 ** Function HID_HostRemoveDev
388 ** Description This removes the device from list devices that host has to manage.
390 ** Returns tHID_STATUS
392 *******************************************************************************/
393 tHID_STATUS HID_HostRemoveDev ( UINT8 dev_handle )
395 if( !hh_cb.reg_flag )
396 return (HID_ERR_NOT_REGISTERED);
398 if( (dev_handle >= HID_HOST_MAX_DEVICES) || (!hh_cb.devices[dev_handle].in_use) )
399 return HID_ERR_INVALID_PARAM;
401 HID_HostCloseDev( dev_handle ) ;
402 hh_cb.devices[dev_handle].in_use = FALSE;
403 hh_cb.devices[dev_handle].conn.conn_state = HID_CONN_STATE_UNUSED;
404 hh_cb.devices[dev_handle].conn.ctrl_cid = hh_cb.devices[dev_handle].conn.intr_cid = 0;
405 hh_cb.devices[dev_handle].attr_mask = 0;
409 /*******************************************************************************
411 ** Function HID_HostOpenDev
413 ** Description This function is called when the user wants to initiate a
414 ** connection attempt to a device.
418 *******************************************************************************/
419 tHID_STATUS HID_HostOpenDev ( UINT8 dev_handle )
421 if( !hh_cb.reg_flag )
422 return (HID_ERR_NOT_REGISTERED);
424 if( (dev_handle >= HID_HOST_MAX_DEVICES) || (!hh_cb.devices[dev_handle].in_use) )
425 return HID_ERR_INVALID_PARAM;
427 if( hh_cb.devices[dev_handle].state != HID_DEV_NO_CONN )
428 return HID_ERR_ALREADY_CONN;
430 hh_cb.devices[dev_handle].conn_tries = 1;
431 return hidh_conn_initiate( dev_handle );
434 /*******************************************************************************
436 ** Function HID_HostWriteDev
438 ** Description This function is called when the host has a report to send.
440 ** report_id: is only used on GET_REPORT transaction if is specified.
441 ** only valid when it's a non-zero value.
445 *******************************************************************************/
446 tHID_STATUS HID_HostWriteDev( UINT8 dev_handle, UINT8 t_type,
447 UINT8 param, UINT16 data, UINT8 report_id, BT_HDR *pbuf )
449 tHID_STATUS status = HID_SUCCESS;
451 if( !hh_cb.reg_flag )
453 HIDH_TRACE_ERROR("HID_ERR_NOT_REGISTERED");
454 status = HID_ERR_NOT_REGISTERED;
457 if( (dev_handle >= HID_HOST_MAX_DEVICES) || (!hh_cb.devices[dev_handle].in_use) )
459 HIDH_TRACE_ERROR("HID_ERR_INVALID_PARAM");
460 status = HID_ERR_INVALID_PARAM;
463 else if( hh_cb.devices[dev_handle].state != HID_DEV_CONNECTED )
465 HIDH_TRACE_ERROR("HID_ERR_NO_CONNECTION dev_handle %d", dev_handle);
466 status = HID_ERR_NO_CONNECTION;
469 if (status != HID_SUCCESS)
472 osi_freebuf ((void *)pbuf);
475 status = hidh_conn_snd_data( dev_handle, t_type, param, data, report_id, pbuf ) ;
480 /*******************************************************************************
482 ** Function HID_HostCloseDev
484 ** Description This function disconnects the device.
488 *******************************************************************************/
489 tHID_STATUS HID_HostCloseDev( UINT8 dev_handle )
491 if( !hh_cb.reg_flag )
492 return (HID_ERR_NOT_REGISTERED);
494 if( (dev_handle >= HID_HOST_MAX_DEVICES) || (!hh_cb.devices[dev_handle].in_use) )
495 return HID_ERR_INVALID_PARAM;
497 hh_cb.devices[dev_handle].conn_tries = HID_HOST_MAX_CONN_RETRY+1;
498 alarm_cancel(hh_cb.devices[dev_handle].conn.process_repage_timer);
500 if( hh_cb.devices[dev_handle].state != HID_DEV_CONNECTED )
501 return HID_ERR_NO_CONNECTION;
503 hh_cb.devices[dev_handle].conn_tries = HID_HOST_MAX_CONN_RETRY+1;
504 return hidh_conn_disconnect( dev_handle );
507 tHID_STATUS HID_HostSetSecurityLevel( char serv_name[], UINT8 sec_lvl )
509 if (!BTM_SetSecurityLevel (FALSE, serv_name, BTM_SEC_SERVICE_HIDH_SEC_CTRL,
510 sec_lvl, HID_PSM_CONTROL, BTM_SEC_PROTO_HID, HID_SEC_CHN))
512 HIDH_TRACE_ERROR ("Security Registration 1 failed");
513 return (HID_ERR_NO_RESOURCES);
516 if (!BTM_SetSecurityLevel (TRUE, serv_name, BTM_SEC_SERVICE_HIDH_SEC_CTRL,
517 sec_lvl, HID_PSM_CONTROL, BTM_SEC_PROTO_HID, HID_SEC_CHN))
519 HIDH_TRACE_ERROR ("Security Registration 2 failed");
520 return (HID_ERR_NO_RESOURCES);
523 if (!BTM_SetSecurityLevel (FALSE, serv_name, BTM_SEC_SERVICE_HIDH_NOSEC_CTRL,
524 BTM_SEC_NONE, HID_PSM_CONTROL, BTM_SEC_PROTO_HID, HID_NOSEC_CHN))
526 HIDH_TRACE_ERROR ("Security Registration 3 failed");
527 return (HID_ERR_NO_RESOURCES);
530 if (!BTM_SetSecurityLevel (TRUE, serv_name, BTM_SEC_SERVICE_HIDH_NOSEC_CTRL,
531 BTM_SEC_NONE, HID_PSM_CONTROL, BTM_SEC_PROTO_HID, HID_NOSEC_CHN))
533 HIDH_TRACE_ERROR ("Security Registration 4 failed");
534 return (HID_ERR_NO_RESOURCES);
537 if (!BTM_SetSecurityLevel (TRUE, serv_name, BTM_SEC_SERVICE_HIDH_INTR,
538 BTM_SEC_NONE, HID_PSM_INTERRUPT, BTM_SEC_PROTO_HID, 0))
540 HIDH_TRACE_ERROR ("Security Registration 5 failed");
541 return (HID_ERR_NO_RESOURCES);
544 if (!BTM_SetSecurityLevel (FALSE, serv_name, BTM_SEC_SERVICE_HIDH_INTR,
545 BTM_SEC_NONE, HID_PSM_INTERRUPT, BTM_SEC_PROTO_HID, 0))
547 HIDH_TRACE_ERROR ("Security Registration 6 failed");
548 return (HID_ERR_NO_RESOURCES);
551 return( HID_SUCCESS );
554 /******************************************************************************
556 ** Function hid_known_hid_device
558 ** Description check if this device is of type HID Device
560 ** Returns TRUE if device is HID Device else FALSE
562 *******************************************************************************/
563 BOOLEAN hid_known_hid_device (BD_ADDR bd_addr)
566 tBTM_INQ_INFO *p_inq_info = BTM_InqDbRead(bd_addr);
568 if ( !hh_cb.reg_flag )
571 /* First check for class of device , if Inq DB has information about this device*/
572 if (p_inq_info != NULL)
574 /* Check if remote major device class is of type BTM_COD_MAJOR_PERIPHERAL */
575 if ((p_inq_info->results.dev_class[1] & BTM_COD_MAJOR_CLASS_MASK)
576 == BTM_COD_MAJOR_PERIPHERAL )
578 HIDH_TRACE_DEBUG("hid_known_hid_device:dev found in InqDB & COD matches HID dev");
584 /* Look for this device in security device DB */
585 tBTM_SEC_DEV_REC *p_dev_rec = btm_find_dev (bd_addr);
586 if ((p_dev_rec != NULL) &&
587 ((p_dev_rec->dev_class[1] & BTM_COD_MAJOR_CLASS_MASK) == BTM_COD_MAJOR_PERIPHERAL ))
589 HIDH_TRACE_DEBUG("hid_known_hid_device:dev found in SecDevDB & COD matches HID dev");
594 /* Find an entry for this device in hh_cb.devices array */
595 for ( i=0; i<HID_HOST_MAX_DEVICES; i++)
597 if ((hh_cb.devices[i].in_use) &&
598 (memcmp(bd_addr, hh_cb.devices[i].addr, BD_ADDR_LEN) == 0))
601 /* Check if this device is marked as HID Device in IOP Dev */
602 HIDH_TRACE_DEBUG("hid_known_hid_device:remote is not HID device");