bta/hh/bta_hh_utils.cc

   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 #include <string.h>
  19
  20 #include "bt_target.h"
  21 #if (BTA_HH_INCLUDED == TRUE)
  22
  23
  24 #include "bta_hh_int.h"
  25
  26 /* if SSR max latency is not defined by remote device, set the default value
  27    as half of the link supervision timeout */
  28 #define BTA_HH_GET_DEF_SSR_MAX_LAT(x)   ((x)>> 1)
  29
  30 /*****************************************************************************
  31 **  Constants
  32 *****************************************************************************/
  33 #define BTA_HH_KB_CTRL_MASK         0x11
  34 #define BTA_HH_KB_SHIFT_MASK        0x22
  35 #define BTA_HH_KB_ALT_MASK          0x44
  36 #define BTA_HH_KB_GUI_MASK          0x88
  37
  38 #define BTA_HH_KB_CAPS_LOCK      0x39           /* caps lock */
  39 #define BTA_HH_KB_NUM_LOCK       0x53           /* num lock */
  40
  41
  42 #define BTA_HH_MAX_RPT_CHARS    8
  43
  44 static const uint8_t bta_hh_mod_key_mask[BTA_HH_MOD_MAX_KEY] =
  45 {
  46     BTA_HH_KB_CTRL_MASK,
  47     BTA_HH_KB_SHIFT_MASK,
  48     BTA_HH_KB_ALT_MASK,
  49     BTA_HH_KB_GUI_MASK
  50 };
  51
  52
  53 /*******************************************************************************
  54 **
  55 ** Function         bta_hh_find_cb
  56 **
  57 ** Description      Find best available control block according to BD address.
  58 **
  59 **
  60 ** Returns          void
  61 **
  62 *******************************************************************************/
  63 uint8_t  bta_hh_find_cb(BD_ADDR bda)
  64 {
  65     uint8_t xx;
  66
  67     /* See how many active devices there are. */
  68     for (xx = 0; xx < BTA_HH_MAX_DEVICE; xx++)
  69     {
  70         /* check if any active/known devices is a match */
  71         if ((!bdcmp (bda, bta_hh_cb.kdev[xx].addr) &&
  72               bdcmp(bda, bd_addr_null) != 0) )
  73         {
  74 #if (BTA_HH_DEBUG == TRUE)
  75             APPL_TRACE_DEBUG("found kdev_cb[%d] hid_handle = %d ", xx,
  76                                 bta_hh_cb.kdev[xx].hid_handle)
  77 #endif
  78             return xx;
  79         }
  80 #if (BTA_HH_DEBUG == TRUE)
  81         else
  82             APPL_TRACE_DEBUG("in_use ? [%d] kdev[%d].hid_handle = %d state = [%d]",
  83                             bta_hh_cb.kdev[xx].in_use, xx,
  84                             bta_hh_cb.kdev[xx].hid_handle,
  85                             bta_hh_cb.kdev[xx].state);
  86 #endif
  87     }
  88
  89     /* if no active device match, find a spot for it */
  90     for (xx = 0; xx < BTA_HH_MAX_DEVICE; xx++)
  91     {
  92         if (!bta_hh_cb.kdev[xx].in_use)
  93         {
  94             bdcpy(bta_hh_cb.kdev[xx].addr, bda);
  95             break;
  96         }
  97     }
  98     /* If device list full, report BTA_HH_IDX_INVALID */
  99 #if (BTA_HH_DEBUG == TRUE)
 100     APPL_TRACE_DEBUG("bta_hh_find_cb:: index = %d while max = %d",
 101                         xx, BTA_HH_MAX_DEVICE);
 102 #endif
 103
 104     if (xx == BTA_HH_MAX_DEVICE)
 105         xx = BTA_HH_IDX_INVALID;
 106
 107     return xx;
 108 }
 109
 110 /*******************************************************************************
 111 **
 112 ** Function         bta_hh_clean_up_kdev
 113 **
 114 ** Description      Clean up device control block when device is removed from
 115 **                  manitainace list, and update control block index map.
 116 **
 117 ** Returns          void
 118 **
 119 *******************************************************************************/
 120 void bta_hh_clean_up_kdev(tBTA_HH_DEV_CB *p_cb)
 121 {
 122     uint8_t index;
 123
 124     if (p_cb->hid_handle != BTA_HH_INVALID_HANDLE )
 125     {
 126 #if (BTA_HH_LE_INCLUDED == TRUE)
 127         if (p_cb->is_le_device)
 128             bta_hh_cb.le_cb_index[BTA_HH_GET_LE_CB_IDX(p_cb->hid_handle)] = BTA_HH_IDX_INVALID;
 129         else
 130 #endif
 131             bta_hh_cb.cb_index[p_cb->hid_handle] = BTA_HH_IDX_INVALID;
 132     }
 133
 134     /* reset device control block */
 135     index = p_cb->index;                        /* Preserve index for this control block */
 136
 137     /* Free buffer for report descriptor info */
 138     osi_free_and_reset((void **)&p_cb->dscp_info.descriptor.dsc_list);
 139
 140     memset(p_cb, 0, sizeof(tBTA_HH_DEV_CB));    /* Reset control block */
 141
 142     p_cb->index = index;                        /* Restore index for this control block */
 143     p_cb->state      = BTA_HH_IDLE_ST;
 144     p_cb->hid_handle = BTA_HH_INVALID_HANDLE;
 145
 146 }
 147 /*******************************************************************************
 148 **
 149 ** Function         bta_hh_update_di_info
 150 **
 151 ** Description      Maintain a known device list for BTA HH.
 152 **
 153 ** Returns          void
 154 **
 155 *******************************************************************************/
 156 void bta_hh_update_di_info(tBTA_HH_DEV_CB *p_cb, uint16_t vendor_id, uint16_t product_id,
 157                            uint16_t version,
 158 #if (BTA_HH_LE_INCLUDED == TRUE)
 159                            uint8_t flag)
 160 #else
 161                            UNUSED_ATTR uint8_t flag)
 162 #endif
 163 {
 164 #if (BTA_HH_DEBUG == TRUE)
 165     APPL_TRACE_DEBUG("vendor_id = 0x%2x product_id = 0x%2x version = 0x%2x",
 166                         vendor_id, product_id, version);
 167 #endif
 168     p_cb->dscp_info.vendor_id     =   vendor_id;
 169     p_cb->dscp_info.product_id    =   product_id;
 170     p_cb->dscp_info.version       =   version;
 171 #if (BTA_HH_LE_INCLUDED == TRUE)
 172     p_cb->dscp_info.flag          =   flag;
 173 #endif
 174 }
 175 /*******************************************************************************
 176 **
 177 ** Function         bta_hh_add_device_to_list
 178 **
 179 ** Description      Maintain a known device list for BTA HH.
 180 **
 181 ** Returns          void
 182 **
 183 *******************************************************************************/
 184 void bta_hh_add_device_to_list(tBTA_HH_DEV_CB *p_cb, uint8_t handle,
 185                                uint16_t attr_mask,
 186                                tHID_DEV_DSCP_INFO *p_dscp_info,
 187                                uint8_t sub_class,
 188                                uint16_t ssr_max_latency,
 189                                uint16_t ssr_min_tout,
 190                                uint8_t app_id)
 191 {
 192 #if (BTA_HH_DEBUG == TRUE)
 193     APPL_TRACE_DEBUG("subclass = 0x%2x", sub_class);
 194 #endif
 195
 196     p_cb->hid_handle = handle;
 197     p_cb->in_use = true;
 198     p_cb->attr_mask = attr_mask;
 199
 200     p_cb->sub_class = sub_class;
 201     p_cb->app_id    = app_id;
 202
 203     p_cb->dscp_info.ssr_max_latency = ssr_max_latency;
 204     p_cb->dscp_info.ssr_min_tout    = ssr_min_tout;
 205
 206     /* store report descriptor info */
 207     if (p_dscp_info) {
 208         osi_free_and_reset((void **)&p_cb->dscp_info.descriptor.dsc_list);
 209
 210         if (p_dscp_info->dl_len) {
 211             p_cb->dscp_info.descriptor.dsc_list =
 212               (uint8_t *)osi_malloc(p_dscp_info->dl_len);
 213             p_cb->dscp_info.descriptor.dl_len = p_dscp_info->dl_len;
 214             memcpy(p_cb->dscp_info.descriptor.dsc_list, p_dscp_info->dsc_list,
 215                    p_dscp_info->dl_len);
 216         }
 217     }
 218 }
 219
 220 /*******************************************************************************
 221 **
 222 ** Function         bta_hh_tod_spt
 223 **
 224 ** Description      Check to see if this type of device is supported
 225 **
 226 ** Returns
 227 **
 228 *******************************************************************************/
 229 bool bta_hh_tod_spt(tBTA_HH_DEV_CB *p_cb,uint8_t sub_class)
 230 {
 231     uint8_t    xx;
 232     uint8_t    cod = (sub_class >> 2); /* lower two bits are reserved */
 233
 234     for (xx = 0 ; xx < p_bta_hh_cfg->max_devt_spt; xx ++)
 235     {
 236         if (cod == (uint8_t) p_bta_hh_cfg->p_devt_list[xx].tod)
 237         {
 238             p_cb->app_id = p_bta_hh_cfg->p_devt_list[xx].app_id;
 239 #if (BTA_HH_DEBUG == TRUE)
 240             APPL_TRACE_EVENT("bta_hh_tod_spt sub_class:0x%x supported", sub_class);
 241 #endif
 242             return true;
 243         }
 244     }
 245 #if (BTA_HH_DEBUG == TRUE)
 246             APPL_TRACE_EVENT("bta_hh_tod_spt sub_class:0x%x NOT supported", sub_class);
 247 #endif
 248     return false;
 249 }
 250
 251
 252 /*******************************************************************************
 253 **
 254 ** Function         bta_hh_parse_keybd_rpt
 255 **
 256 ** Description      This utility function parse a boot mode keyboard report.
 257 **
 258 ** Returns          void
 259 **
 260 *******************************************************************************/
 261 void bta_hh_parse_keybd_rpt(tBTA_HH_BOOT_RPT *p_kb_data, uint8_t *p_report,
 262                             uint16_t report_len)
 263 {
 264     tBTA_HH_KB_CB       *p_kb = &bta_hh_cb.kb_cb;
 265     tBTA_HH_KEYBD_RPT   *p_data = &p_kb_data->data_rpt.keybd_rpt;
 266
 267     uint8_t        this_char, ctl_shift;
 268     uint16_t       xx, yy, key_idx = 0;
 269     uint8_t        this_report[BTA_HH_MAX_RPT_CHARS];
 270
 271 #if (BTA_HH_DEBUG == TRUE)
 272     APPL_TRACE_DEBUG("bta_hh_parse_keybd_rpt:  (report=%p, report_len=%d) called",
 273             p_report, report_len);
 274 #endif
 275
 276     if (report_len < 2)
 277         return;
 278
 279     ctl_shift = *p_report++;
 280     report_len--;
 281
 282     if (report_len > BTA_HH_MAX_RPT_CHARS)
 283         report_len = BTA_HH_MAX_RPT_CHARS;
 284
 285     memset (this_report, 0, BTA_HH_MAX_RPT_CHARS);
 286     memset (p_data, 0, sizeof(tBTA_HH_KEYBD_RPT));
 287     memcpy (this_report, p_report, report_len);
 288
 289     /* Take care of shift, control, GUI and alt, modifier keys  */
 290     for (xx = 0; xx < BTA_HH_MOD_MAX_KEY; xx ++ )
 291     {
 292         if (ctl_shift & bta_hh_mod_key_mask[xx])
 293         {
 294             APPL_TRACE_DEBUG("Mod Key[%02x] pressed", bta_hh_mod_key_mask[xx] );
 295             p_kb->mod_key[xx] = true;
 296         }
 297         else if (p_kb->mod_key[xx])
 298         {
 299             p_kb->mod_key[xx] = false;
 300         }
 301         /* control key flag is set */
 302         p_data->mod_key[xx]       = p_kb->mod_key[xx];
 303     }
 304
 305     /***************************************************************************/
 306     /*  First step is to remove all characters we saw in the last report       */
 307     /***************************************************************************/
 308     for (xx = 0; xx < report_len; xx++)
 309     {
 310         for (yy = 0; yy < BTA_HH_MAX_RPT_CHARS; yy++)
 311         {
 312             if (this_report[xx] == p_kb->last_report[yy])
 313             {
 314                 this_report[xx] = 0;
 315             }
 316         }
 317     }
 318     /***************************************************************************/
 319     /*  Now, process all the characters in the report, up to 6 keycodes        */
 320     /***************************************************************************/
 321     for (xx = 0; xx < report_len; xx++)
 322     {
 323 #if (BTA_HH_DEBUG == TRUE)
 324         APPL_TRACE_DEBUG("this_char = %02x", this_report[xx]);
 325 #endif
 326         if ((this_char = this_report[xx]) == 0)
 327             continue;
 328         /* take the key code as the report data */
 329         if (this_report[xx] == BTA_HH_KB_CAPS_LOCK)
 330             p_kb->caps_lock = p_kb->caps_lock ? false : true;
 331         else if (this_report[xx] == BTA_HH_KB_NUM_LOCK)
 332             p_kb->num_lock = p_kb->num_lock ? false : true;
 333         else
 334             p_data->this_char[key_idx ++] = this_char;
 335
 336 #if (BTA_HH_DEBUG == TRUE)
 337         APPL_TRACE_DEBUG("found keycode %02x ",  this_report[xx]);
 338 #endif
 339         p_data->caps_lock   = p_kb->caps_lock;
 340         p_data->num_lock      = p_kb->num_lock;
 341     }
 342
 343     memset (p_kb->last_report, 0, BTA_HH_MAX_RPT_CHARS);
 344     memcpy (p_kb->last_report, p_report, report_len);
 345
 346     return;
 347 }
 348
 349 /*******************************************************************************
 350 **
 351 ** Function         bta_hh_parse_mice_rpt
 352 **
 353 ** Description      This utility function parse a boot mode mouse report.
 354 **
 355 ** Returns          void
 356 **
 357 *******************************************************************************/
 358 void bta_hh_parse_mice_rpt(tBTA_HH_BOOT_RPT *p_mice_data, uint8_t *p_report,
 359                            uint16_t report_len)
 360 {
 361     tBTA_HH_MICE_RPT   *p_data = &p_mice_data->data_rpt.mice_rpt;
 362 #if (BTA_HH_DEBUG == TRUE)
 363     uint8_t       xx;
 364
 365     APPL_TRACE_DEBUG("bta_hh_parse_mice_rpt:  bta_keybd_rpt_rcvd(report=%p, \
 366                 report_len=%d) called", p_report, report_len);
 367 #endif
 368
 369     if (report_len < 3)
 370         return;
 371
 372     if (report_len > BTA_HH_MAX_RPT_CHARS)
 373         report_len = BTA_HH_MAX_RPT_CHARS;
 374
 375 #if (BTA_HH_DEBUG == TRUE)
 376     for (xx = 0; xx < report_len; xx++)
 377     {
 378         APPL_TRACE_DEBUG("this_char = %02x", p_report[xx]);
 379     }
 380 #endif
 381
 382     /* only first bytes lower 3 bits valid */
 383     p_data->mouse_button     = (p_report[0] & 0x07);
 384
 385     /* x displacement */
 386     p_data->delta_x     = p_report[1];
 387
 388     /* y displacement */
 389     p_data->delta_y     = p_report[2];
 390
 391 #if (BTA_HH_DEBUG == TRUE)
 392     APPL_TRACE_DEBUG("mice button: 0x%2x", p_data->mouse_button);
 393     APPL_TRACE_DEBUG("mice move: x = %d y = %d", p_data->delta_x,
 394                         p_data->delta_y );
 395 #endif
 396
 397     return;
 398
 399 }
 400
 401 /*******************************************************************************
 402 **
 403 ** Function         bta_hh_read_ssr_param
 404 **
 405 ** Description      Read the SSR Parameter for the remote device
 406 **
 407 ** Returns          tBTA_HH_STATUS  operation status
 408 **
 409 *******************************************************************************/
 410 tBTA_HH_STATUS bta_hh_read_ssr_param(BD_ADDR bd_addr, uint16_t *p_max_ssr_lat, uint16_t *p_min_ssr_tout)
 411 {
 412     tBTA_HH_STATUS  status = BTA_HH_ERR;
 413     tBTA_HH_CB  *p_cb = &bta_hh_cb;
 414     uint8_t       i;
 415     uint16_t      ssr_max_latency;
 416     for (i = 0; i < BTA_HH_MAX_KNOWN; i ++)
 417     {
 418         if (memcmp(p_cb->kdev[i].addr, bd_addr, BD_ADDR_LEN) == 0)
 419         {
 420
 421             /* if remote device does not have HIDSSRHostMaxLatency attribute in SDP,
 422             set SSR max latency default value here.  */
 423             if (p_cb->kdev[i].dscp_info.ssr_max_latency == HID_SSR_PARAM_INVALID)
 424             {
 425                 /* The default is calculated as half of link supervision timeout.*/
 426
 427                 BTM_GetLinkSuperTout(p_cb->kdev[i].addr, &ssr_max_latency) ;
 428                 ssr_max_latency = BTA_HH_GET_DEF_SSR_MAX_LAT(ssr_max_latency);
 429
 430                 /* per 1.1 spec, if the newly calculated max latency is greater than
 431                 BTA_HH_SSR_MAX_LATENCY_DEF which is 500ms, use BTA_HH_SSR_MAX_LATENCY_DEF */
 432                 if (ssr_max_latency > BTA_HH_SSR_MAX_LATENCY_DEF)
 433                     ssr_max_latency = BTA_HH_SSR_MAX_LATENCY_DEF;
 434
 435                 * p_max_ssr_lat  = ssr_max_latency;
 436             }
 437             else
 438                 * p_max_ssr_lat  = p_cb->kdev[i].dscp_info.ssr_max_latency;
 439
 440             if (p_cb->kdev[i].dscp_info.ssr_min_tout == HID_SSR_PARAM_INVALID)
 441                 * p_min_ssr_tout = BTA_HH_SSR_MIN_TOUT_DEF;
 442             else
 443                 * p_min_ssr_tout = p_cb->kdev[i].dscp_info.ssr_min_tout;
 444
 445             status           = BTA_HH_OK;
 446
 447             break;
 448         }
 449     }
 450
 451     return status;
 452 }
 453
 454 /*******************************************************************************
 455 **
 456 ** Function         bta_hh_cleanup_disable
 457 **
 458 ** Description      when disable finished, cleanup control block and send callback
 459 **
 460 **
 461 ** Returns          void
 462 **
 463 *******************************************************************************/
 464 void bta_hh_cleanup_disable(tBTA_HH_STATUS status)
 465 {
 466     uint8_t   xx;
 467     /* free buffer in CB holding report descriptors */
 468     for (xx = 0; xx < BTA_HH_MAX_DEVICE; xx ++) {
 469         osi_free_and_reset((void **)&bta_hh_cb.kdev[xx].dscp_info.descriptor.dsc_list);
 470     }
 471     osi_free_and_reset((void **)&bta_hh_cb.p_disc_db);
 472
 473     (* bta_hh_cb.p_cback)(BTA_HH_DISABLE_EVT, (tBTA_HH *)&status);
 474     /* all connections are down, no waiting for diconnect */
 475     memset(&bta_hh_cb, 0, sizeof(tBTA_HH_CB));
 476 }
 477
 478 /*******************************************************************************
 479 **
 480 ** Function         bta_hh_dev_handle_to_cb_idx
 481 **
 482 ** Description      convert a HID device handle to the device control block index.
 483 **
 484 **
 485 ** Returns          uint8_t: index of the device control block.
 486 **
 487 *******************************************************************************/
 488 uint8_t bta_hh_dev_handle_to_cb_idx(uint8_t dev_handle)
 489 {
 490     uint8_t index = BTA_HH_IDX_INVALID;
 491
 492 #if (BTA_HH_LE_INCLUDED == TRUE)
 493     if (BTA_HH_IS_LE_DEV_HDL(dev_handle))
 494     {
 495         if (BTA_HH_IS_LE_DEV_HDL_VALID(dev_handle))
 496             index = bta_hh_cb.le_cb_index[BTA_HH_GET_LE_CB_IDX(dev_handle)];
 497 #if (BTA_HH_DEBUG == TRUE)
 498         APPL_TRACE_DEBUG("bta_hh_dev_handle_to_cb_idx dev_handle = %d index = %d", dev_handle, index);
 499 #endif
 500     }
 501     else
 502 #endif
 503         /* regular HID device checking */
 504         if (dev_handle < BTA_HH_MAX_KNOWN )
 505         index = bta_hh_cb.cb_index[dev_handle];
 506
 507     return index;
 508
 509 }
 510 #if (BTA_HH_DEBUG == TRUE)
 511 /*******************************************************************************
 512 **
 513 ** Function         bta_hh_trace_dev_db
 514 **
 515 ** Description      Check to see if this type of device is supported
 516 **
 517 ** Returns
 518 **
 519 *******************************************************************************/
 520 void bta_hh_trace_dev_db(void)
 521 {
 522     uint8_t    xx;
 523
 524     APPL_TRACE_DEBUG("bta_hh_trace_dev_db:: Device DB list********************");
 525
 526     for (xx = 0; xx < BTA_HH_MAX_DEVICE; xx++)
 527     {
 528         APPL_TRACE_DEBUG("kdev[%d] in_use[%d]  handle[%d] ",xx,
 529             bta_hh_cb.kdev[xx].in_use, bta_hh_cb.kdev[xx].hid_handle);
 530
 531         APPL_TRACE_DEBUG("\t\t\t attr_mask[%04x] state [%d] sub_class[%02x] index = %d",
 532             bta_hh_cb.kdev[xx].attr_mask, bta_hh_cb.kdev[xx].state,
 533             bta_hh_cb.kdev[xx].sub_class, bta_hh_cb.kdev[xx].index);
 534     }
 535     APPL_TRACE_DEBUG("*********************************************************");
 536 }
 537 #endif
 538 #endif /* HL_INCLUDED */