1 /*- 2 * Copyright (c) 2014-2017 Vladimir Kondratyev <wulf@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 /* 31 * MS Windows 7/8/10 compatible USB HID Multi-touch Device driver. 32 * https://msdn.microsoft.com/en-us/library/windows/hardware/jj151569(v=vs.85).aspx 33 * https://www.kernel.org/doc/Documentation/input/multi-touch-protocol.txt 34 */ 35 36 #include <sys/param.h> 37 #include <sys/bus.h> 38 #include <sys/conf.h> 39 #include <sys/kernel.h> 40 #include <sys/lock.h> 41 #include <sys/malloc.h> 42 #include <sys/module.h> 43 #include <sys/mutex.h> 44 #include <sys/stddef.h> 45 #include <sys/sysctl.h> 46 #include <sys/systm.h> 47 48 #include "usbdevs.h" 49 #include <dev/usb/usb.h> 50 #include <dev/usb/usbdi.h> 51 #include <dev/usb/usbdi_util.h> 52 #include <dev/usb/usbhid.h> 53 54 #include <dev/usb/quirk/usb_quirk.h> 55 56 #include <dev/evdev/evdev.h> 57 #include <dev/evdev/input.h> 58 59 #define USB_DEBUG_VAR wmt_debug 60 #include <dev/usb/usb_debug.h> 61 62 #ifdef USB_DEBUG 63 static int wmt_debug = 0; 64 65 static SYSCTL_NODE(_hw_usb, OID_AUTO, wmt, CTLFLAG_RW, 0, 66 "USB MSWindows 7/8/10 compatible Multi-touch Device"); 67 SYSCTL_INT(_hw_usb_wmt, OID_AUTO, debug, CTLFLAG_RWTUN, 68 &wmt_debug, 1, "Debug level"); 69 #endif 70 71 #define WMT_BSIZE 1024 /* bytes, buffer size */ 72 73 enum { 74 WMT_INTR_DT, 75 WMT_N_TRANSFER, 76 }; 77 78 enum { 79 WMT_TIP_SWITCH, 80 #define WMT_SLOT WMT_TIP_SWITCH 81 WMT_WIDTH, 82 #define WMT_MAJOR WMT_WIDTH 83 WMT_HEIGHT, 84 #define WMT_MINOR WMT_HEIGHT 85 WMT_ORIENTATION, 86 WMT_X, 87 WMT_Y, 88 WMT_CONTACTID, 89 WMT_PRESSURE, 90 WMT_IN_RANGE, 91 WMT_CONFIDENCE, 92 WMT_TOOL_X, 93 WMT_TOOL_Y, 94 WMT_N_USAGES, 95 }; 96 97 #define WMT_NO_CODE (ABS_MAX + 10) 98 #define WMT_NO_USAGE -1 99 100 struct wmt_hid_map_item { 101 char name[5]; 102 int32_t usage; /* HID usage */ 103 uint32_t code; /* Evdev event code */ 104 bool required; /* Required for MT Digitizers */ 105 }; 106 107 static const struct wmt_hid_map_item wmt_hid_map[WMT_N_USAGES] = { 108 109 [WMT_TIP_SWITCH] = { /* WMT_SLOT */ 110 .name = "TIP", 111 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_TIP_SWITCH), 112 .code = ABS_MT_SLOT, 113 .required = true, 114 }, 115 [WMT_WIDTH] = { /* WMT_MAJOR */ 116 .name = "WDTH", 117 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_WIDTH), 118 .code = ABS_MT_TOUCH_MAJOR, 119 .required = false, 120 }, 121 [WMT_HEIGHT] = { /* WMT_MINOR */ 122 .name = "HGHT", 123 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_HEIGHT), 124 .code = ABS_MT_TOUCH_MINOR, 125 .required = false, 126 }, 127 [WMT_ORIENTATION] = { 128 .name = "ORIE", 129 .usage = WMT_NO_USAGE, 130 .code = ABS_MT_ORIENTATION, 131 .required = false, 132 }, 133 [WMT_X] = { 134 .name = "X", 135 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X), 136 .code = ABS_MT_POSITION_X, 137 .required = true, 138 }, 139 [WMT_Y] = { 140 .name = "Y", 141 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y), 142 .code = ABS_MT_POSITION_Y, 143 .required = true, 144 }, 145 [WMT_CONTACTID] = { 146 .name = "C_ID", 147 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACTID), 148 .code = ABS_MT_TRACKING_ID, 149 .required = true, 150 }, 151 [WMT_PRESSURE] = { 152 .name = "PRES", 153 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_TIP_PRESSURE), 154 .code = ABS_MT_PRESSURE, 155 .required = false, 156 }, 157 [WMT_IN_RANGE] = { 158 .name = "RANG", 159 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_IN_RANGE), 160 .code = ABS_MT_DISTANCE, 161 .required = false, 162 }, 163 [WMT_CONFIDENCE] = { 164 .name = "CONF", 165 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_CONFIDENCE), 166 .code = WMT_NO_CODE, 167 .required = false, 168 }, 169 [WMT_TOOL_X] = { /* Shares HID usage with WMT_X */ 170 .name = "TL_X", 171 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X), 172 .code = ABS_MT_TOOL_X, 173 .required = false, 174 }, 175 [WMT_TOOL_Y] = { /* Shares HID usage with WMT_Y */ 176 .name = "TL_Y", 177 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y), 178 .code = ABS_MT_TOOL_Y, 179 .required = false, 180 }, 181 }; 182 183 struct wmt_absinfo { 184 int32_t min; 185 int32_t max; 186 int32_t res; 187 }; 188 189 struct wmt_softc 190 { 191 device_t dev; 192 struct mtx mtx; 193 struct wmt_absinfo ai[WMT_N_USAGES]; 194 struct hid_location locs[MAX_MT_SLOTS][WMT_N_USAGES]; 195 struct hid_location nconts_loc; 196 197 struct usb_xfer *xfer[WMT_N_TRANSFER]; 198 struct evdev_dev *evdev; 199 200 uint32_t slot_data[WMT_N_USAGES]; 201 uint32_t caps; 202 uint32_t isize; 203 uint32_t nconts_max; 204 uint8_t report_id; 205 206 struct hid_location cont_max_loc; 207 uint32_t cont_max_rlen; 208 uint8_t cont_max_rid; 209 uint32_t thqa_cert_rlen; 210 uint8_t thqa_cert_rid; 211 212 uint8_t buf[WMT_BSIZE] __aligned(4); 213 }; 214 215 #define USAGE_SUPPORTED(caps, usage) ((caps) & (1 << (usage))) 216 #define WMT_FOREACH_USAGE(caps, usage) \ 217 for ((usage) = 0; (usage) < WMT_N_USAGES; ++(usage)) \ 218 if (USAGE_SUPPORTED((caps), (usage))) 219 220 static bool wmt_hid_parse(struct wmt_softc *, const void *, uint16_t); 221 static void wmt_cont_max_parse(struct wmt_softc *, const void *, uint16_t); 222 223 static usb_callback_t wmt_intr_callback; 224 225 static device_probe_t wmt_probe; 226 static device_attach_t wmt_attach; 227 static device_detach_t wmt_detach; 228 229 #if __FreeBSD_version >= 1200077 230 static evdev_open_t wmt_ev_open; 231 static evdev_close_t wmt_ev_close; 232 #else 233 static evdev_open_t wmt_ev_open_11; 234 static evdev_close_t wmt_ev_close_11; 235 #endif 236 237 static const struct evdev_methods wmt_evdev_methods = { 238 #if __FreeBSD_version >= 1200077 239 .ev_open = &wmt_ev_open, 240 .ev_close = &wmt_ev_close, 241 #else 242 .ev_open = &wmt_ev_open_11, 243 .ev_close = &wmt_ev_close_11, 244 #endif 245 }; 246 247 static const struct usb_config wmt_config[WMT_N_TRANSFER] = { 248 249 [WMT_INTR_DT] = { 250 .type = UE_INTERRUPT, 251 .endpoint = UE_ADDR_ANY, 252 .direction = UE_DIR_IN, 253 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 }, 254 .bufsize = WMT_BSIZE, 255 .callback = &wmt_intr_callback, 256 }, 257 }; 258 259 static int 260 wmt_probe(device_t dev) 261 { 262 struct usb_attach_arg *uaa = device_get_ivars(dev); 263 void *d_ptr; 264 uint16_t d_len; 265 int err; 266 267 if (uaa->usb_mode != USB_MODE_HOST) 268 return (ENXIO); 269 270 if (uaa->info.bInterfaceClass != UICLASS_HID) 271 return (ENXIO); 272 273 if (usb_test_quirk(uaa, UQ_WMT_IGNORE)) 274 return (ENXIO); 275 276 err = usbd_req_get_hid_desc(uaa->device, NULL, 277 &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex); 278 if (err) 279 return (ENXIO); 280 281 if (wmt_hid_parse(NULL, d_ptr, d_len)) 282 err = BUS_PROBE_DEFAULT; 283 else 284 err = ENXIO; 285 286 free(d_ptr, M_TEMP); 287 return (err); 288 } 289 290 static int 291 wmt_attach(device_t dev) 292 { 293 struct usb_attach_arg *uaa = device_get_ivars(dev); 294 struct wmt_softc *sc = device_get_softc(dev); 295 void *d_ptr; 296 uint16_t d_len; 297 size_t i; 298 int err; 299 bool hid_ok; 300 301 device_set_usb_desc(dev); 302 sc->dev = dev; 303 304 /* Get HID descriptor */ 305 err = usbd_req_get_hid_desc(uaa->device, NULL, 306 &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex); 307 if (err) { 308 DPRINTF("usbd_req_get_hid_desc error=%s\n", usbd_errstr(err)); 309 return (ENXIO); 310 } 311 312 hid_ok = wmt_hid_parse(sc, d_ptr, d_len); 313 free(d_ptr, M_TEMP); 314 if (!hid_ok) { 315 DPRINTF("multi-touch HID descriptor not found\n"); 316 return (ENXIO); 317 } 318 319 /* Check HID report length */ 320 if (sc->isize <= 0 || sc->isize > WMT_BSIZE) { 321 DPRINTF("Input size invalid or too large: %d\n", sc->isize); 322 return (ENXIO); 323 } 324 325 /* Fetch and parse "Contact count maximum" feature report */ 326 if (sc->cont_max_rlen > 0 && sc->cont_max_rlen <= WMT_BSIZE) { 327 err = usbd_req_get_report(uaa->device, NULL, sc->buf, 328 sc->cont_max_rlen, uaa->info.bIfaceIndex, 329 UHID_FEATURE_REPORT, sc->cont_max_rid); 330 if (err == USB_ERR_NORMAL_COMPLETION) 331 wmt_cont_max_parse(sc, sc->buf, sc->cont_max_rlen); 332 else 333 DPRINTF("usbd_req_get_report error=(%s)\n", 334 usbd_errstr(err)); 335 } else 336 DPRINTF("Feature report %hhu size invalid or too large: %u\n", 337 sc->cont_max_rid, sc->cont_max_rlen); 338 339 /* Fetch THQA certificate to enable some devices like WaveShare */ 340 if (sc->thqa_cert_rlen > 0 && sc->thqa_cert_rlen <= WMT_BSIZE && 341 sc->thqa_cert_rid != sc->cont_max_rid) 342 (void)usbd_req_get_report(uaa->device, NULL, sc->buf, 343 sc->thqa_cert_rlen, uaa->info.bIfaceIndex, 344 UHID_FEATURE_REPORT, sc->thqa_cert_rid); 345 346 mtx_init(&sc->mtx, "wmt lock", NULL, MTX_DEF); 347 348 err = usbd_transfer_setup(uaa->device, &uaa->info.bIfaceIndex, 349 sc->xfer, wmt_config, WMT_N_TRANSFER, sc, &sc->mtx); 350 if (err != USB_ERR_NORMAL_COMPLETION) { 351 DPRINTF("usbd_transfer_setup error=%s\n", usbd_errstr(err)); 352 goto detach; 353 } 354 355 sc->evdev = evdev_alloc(); 356 evdev_set_name(sc->evdev, device_get_desc(dev)); 357 evdev_set_phys(sc->evdev, device_get_nameunit(dev)); 358 evdev_set_id(sc->evdev, BUS_USB, uaa->info.idVendor, 359 uaa->info.idProduct, 0); 360 evdev_set_serial(sc->evdev, usb_get_serial(uaa->device)); 361 evdev_set_methods(sc->evdev, sc, &wmt_evdev_methods); 362 evdev_set_flag(sc->evdev, EVDEV_FLAG_MT_STCOMPAT); 363 evdev_support_prop(sc->evdev, INPUT_PROP_DIRECT); 364 evdev_support_event(sc->evdev, EV_SYN); 365 evdev_support_event(sc->evdev, EV_ABS); 366 WMT_FOREACH_USAGE(sc->caps, i) { 367 if (wmt_hid_map[i].code != WMT_NO_CODE) 368 evdev_support_abs(sc->evdev, wmt_hid_map[i].code, 0, 369 sc->ai[i].min, sc->ai[i].max, 0, 0, sc->ai[i].res); 370 } 371 372 err = evdev_register_mtx(sc->evdev, &sc->mtx); 373 if (err) 374 goto detach; 375 376 return (0); 377 378 detach: 379 wmt_detach(dev); 380 return (ENXIO); 381 } 382 383 static int 384 wmt_detach(device_t dev) 385 { 386 struct wmt_softc *sc = device_get_softc(dev); 387 388 evdev_free(sc->evdev); 389 usbd_transfer_unsetup(sc->xfer, WMT_N_TRANSFER); 390 mtx_destroy(&sc->mtx); 391 return (0); 392 } 393 394 static void 395 wmt_process_report(struct wmt_softc *sc, uint8_t *buf, int len) 396 { 397 size_t usage; 398 uint32_t *slot_data = sc->slot_data; 399 uint32_t cont; 400 uint32_t nconts; 401 uint32_t width; 402 uint32_t height; 403 int32_t slot; 404 405 nconts = hid_get_data_unsigned(buf, len, &sc->nconts_loc); 406 407 #ifdef USB_DEBUG 408 DPRINTFN(6, "nconts = %u ", (unsigned)nconts); 409 if (wmt_debug >= 6) { 410 WMT_FOREACH_USAGE(sc->caps, usage) { 411 if (wmt_hid_map[usage].usage != WMT_NO_USAGE) 412 printf(" %-4s", wmt_hid_map[usage].name); 413 } 414 printf("\n"); 415 } 416 #endif 417 418 if (nconts > sc->nconts_max) { 419 DPRINTF("Contact count overflow %u\n", (unsigned)nconts); 420 nconts = sc->nconts_max; 421 } 422 423 /* Use protocol Type B for reporting events */ 424 for (cont = 0; cont < nconts; cont++) { 425 426 bzero(slot_data, sizeof(sc->slot_data)); 427 WMT_FOREACH_USAGE(sc->caps, usage) { 428 if (sc->locs[cont][usage].size > 0) 429 slot_data[usage] = hid_get_data_unsigned( 430 buf, len, &sc->locs[cont][usage]); 431 } 432 433 slot = evdev_get_mt_slot_by_tracking_id(sc->evdev, 434 slot_data[WMT_CONTACTID]); 435 436 #ifdef USB_DEBUG 437 DPRINTFN(6, "cont%01x: data = ", cont); 438 if (wmt_debug >= 6) { 439 WMT_FOREACH_USAGE(sc->caps, usage) { 440 if (wmt_hid_map[usage].usage != WMT_NO_USAGE) 441 printf("%04x ", slot_data[usage]); 442 } 443 printf("slot = %d\n", (int)slot); 444 } 445 #endif 446 447 if (slot == -1) { 448 DPRINTF("Slot overflow for contact_id %u\n", 449 (unsigned)slot_data[WMT_CONTACTID]); 450 continue; 451 } 452 453 if (slot_data[WMT_TIP_SWITCH] != 0 && 454 !(USAGE_SUPPORTED(sc->caps, WMT_CONFIDENCE) && 455 slot_data[WMT_CONFIDENCE] == 0)) { 456 /* This finger is in proximity of the sensor */ 457 slot_data[WMT_SLOT] = slot; 458 slot_data[WMT_IN_RANGE] = !slot_data[WMT_IN_RANGE]; 459 /* Divided by two to match visual scale of touch */ 460 width = slot_data[WMT_WIDTH] >> 1; 461 height = slot_data[WMT_HEIGHT] >> 1; 462 slot_data[WMT_ORIENTATION] = width > height; 463 slot_data[WMT_MAJOR] = MAX(width, height); 464 slot_data[WMT_MINOR] = MIN(width, height); 465 466 WMT_FOREACH_USAGE(sc->caps, usage) 467 if (wmt_hid_map[usage].code != WMT_NO_CODE) 468 evdev_push_abs(sc->evdev, 469 wmt_hid_map[usage].code, 470 slot_data[usage]); 471 } else { 472 evdev_push_abs(sc->evdev, ABS_MT_SLOT, slot); 473 evdev_push_abs(sc->evdev, ABS_MT_TRACKING_ID, -1); 474 } 475 } 476 evdev_sync(sc->evdev); 477 } 478 479 static void 480 wmt_intr_callback(struct usb_xfer *xfer, usb_error_t error) 481 { 482 struct wmt_softc *sc = usbd_xfer_softc(xfer); 483 struct usb_page_cache *pc; 484 uint8_t *buf = sc->buf; 485 int len; 486 487 usbd_xfer_status(xfer, &len, NULL, NULL, NULL); 488 489 switch (USB_GET_STATE(xfer)) { 490 case USB_ST_TRANSFERRED: 491 pc = usbd_xfer_get_frame(xfer, 0); 492 493 DPRINTFN(6, "sc=%p actlen=%d\n", sc, len); 494 495 if (len >= (int)sc->isize || (len > 0 && sc->report_id != 0)) { 496 /* Limit report length to the maximum */ 497 if (len > (int)sc->isize) 498 len = sc->isize; 499 500 usbd_copy_out(pc, 0, buf, len); 501 502 /* Ignore irrelevant reports */ 503 if (sc->report_id && *buf != sc->report_id) 504 goto tr_ignore; 505 506 /* Make sure we don't process old data */ 507 if (len < sc->isize) 508 bzero(buf + len, sc->isize - len); 509 510 /* Strip leading "report ID" byte */ 511 if (sc->report_id) { 512 len--; 513 buf++; 514 } 515 516 wmt_process_report(sc, buf, len); 517 } else { 518 tr_ignore: 519 DPRINTF("Ignored transfer, %d bytes\n", len); 520 } 521 522 case USB_ST_SETUP: 523 tr_setup: 524 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 525 usbd_transfer_submit(xfer); 526 break; 527 default: 528 if (error != USB_ERR_CANCELLED) { 529 /* Try clear stall first */ 530 usbd_xfer_set_stall(xfer); 531 goto tr_setup; 532 } 533 break; 534 } 535 } 536 537 static void 538 wmt_ev_close_11(struct evdev_dev *evdev, void *ev_softc) 539 { 540 struct wmt_softc *sc = ev_softc; 541 542 mtx_assert(&sc->mtx, MA_OWNED); 543 usbd_transfer_stop(sc->xfer[WMT_INTR_DT]); 544 } 545 546 static int 547 wmt_ev_open_11(struct evdev_dev *evdev, void *ev_softc) 548 { 549 struct wmt_softc *sc = ev_softc; 550 551 mtx_assert(&sc->mtx, MA_OWNED); 552 usbd_transfer_start(sc->xfer[WMT_INTR_DT]); 553 554 return (0); 555 } 556 557 #if __FreeBSD_version >= 1200077 558 static int 559 wmt_ev_close(struct evdev_dev *evdev) 560 { 561 struct wmt_softc *sc = evdev_get_softc(evdev); 562 563 wmt_ev_close_11(evdev, sc); 564 565 return (0); 566 } 567 568 static int 569 wmt_ev_open(struct evdev_dev *evdev) 570 { 571 struct wmt_softc *sc = evdev_get_softc(evdev); 572 573 return (wmt_ev_open_11(evdev, sc)); 574 575 } 576 #endif 577 578 /* port of userland hid_report_size() from usbhid(3) to kernel */ 579 static int 580 wmt_hid_report_size(const void *buf, uint16_t len, enum hid_kind k, uint8_t id) 581 { 582 struct hid_data *d; 583 struct hid_item h; 584 uint32_t temp; 585 uint32_t hpos; 586 uint32_t lpos; 587 int report_id = 0; 588 589 hpos = 0; 590 lpos = 0xFFFFFFFF; 591 592 for (d = hid_start_parse(buf, len, 1 << k); hid_get_item(d, &h);) { 593 if (h.kind == k && h.report_ID == id) { 594 /* compute minimum */ 595 if (lpos > h.loc.pos) 596 lpos = h.loc.pos; 597 /* compute end position */ 598 temp = h.loc.pos + (h.loc.size * h.loc.count); 599 /* compute maximum */ 600 if (hpos < temp) 601 hpos = temp; 602 if (h.report_ID != 0) 603 report_id = 1; 604 } 605 } 606 hid_end_parse(d); 607 608 /* safety check - can happen in case of currupt descriptors */ 609 if (lpos > hpos) 610 temp = 0; 611 else 612 temp = hpos - lpos; 613 614 /* return length in bytes rounded up */ 615 return ((temp + 7) / 8 + report_id); 616 } 617 618 static bool 619 wmt_hid_parse(struct wmt_softc *sc, const void *d_ptr, uint16_t d_len) 620 { 621 struct hid_item hi; 622 struct hid_data *hd; 623 size_t i; 624 size_t cont = 0; 625 uint32_t caps = 0; 626 int32_t cont_count_max = 0; 627 uint8_t report_id = 0; 628 uint8_t cont_max_rid = 0; 629 uint8_t thqa_cert_rid = 0; 630 bool touch_coll = false; 631 bool finger_coll = false; 632 bool cont_count_found = false; 633 bool scan_time_found = false; 634 635 #define WMT_HI_ABSOLUTE(hi) \ 636 (((hi).flags & (HIO_CONST|HIO_VARIABLE|HIO_RELATIVE)) == HIO_VARIABLE) 637 #define HUMS_THQA_CERT 0xC5 638 639 /* Parse features for maximum contact count */ 640 hd = hid_start_parse(d_ptr, d_len, 1 << hid_feature); 641 while (hid_get_item(hd, &hi)) { 642 switch (hi.kind) { 643 case hid_collection: 644 if (hi.collevel == 1 && hi.usage == 645 HID_USAGE2(HUP_DIGITIZERS, HUD_TOUCHSCREEN)) 646 touch_coll = true; 647 break; 648 case hid_endcollection: 649 if (hi.collevel == 0 && touch_coll) 650 touch_coll = false; 651 break; 652 case hid_feature: 653 if (hi.collevel == 1 && touch_coll && hi.usage == 654 HID_USAGE2(HUP_MICROSOFT, HUMS_THQA_CERT)) { 655 thqa_cert_rid = hi.report_ID; 656 break; 657 } 658 if (hi.collevel == 1 && touch_coll && 659 WMT_HI_ABSOLUTE(hi) && hi.usage == 660 HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACT_MAX)) { 661 cont_count_max = hi.logical_maximum; 662 cont_max_rid = hi.report_ID; 663 if (sc != NULL) 664 sc->cont_max_loc = hi.loc; 665 } 666 break; 667 default: 668 break; 669 } 670 } 671 hid_end_parse(hd); 672 673 /* Maximum contact count is required usage */ 674 if (cont_max_rid == 0) 675 return (false); 676 677 touch_coll = false; 678 679 /* Parse input for other parameters */ 680 hd = hid_start_parse(d_ptr, d_len, 1 << hid_input); 681 while (hid_get_item(hd, &hi)) { 682 switch (hi.kind) { 683 case hid_collection: 684 if (hi.collevel == 1 && hi.usage == 685 HID_USAGE2(HUP_DIGITIZERS, HUD_TOUCHSCREEN)) 686 touch_coll = true; 687 else if (touch_coll && hi.collevel == 2 && 688 (report_id == 0 || report_id == hi.report_ID) && 689 hi.usage == HID_USAGE2(HUP_DIGITIZERS, HUD_FINGER)) 690 finger_coll = true; 691 break; 692 case hid_endcollection: 693 if (hi.collevel == 1 && finger_coll) { 694 finger_coll = false; 695 cont++; 696 } else if (hi.collevel == 0 && touch_coll) 697 touch_coll = false; 698 break; 699 case hid_input: 700 /* 701 * Ensure that all usages are located within the same 702 * report and proper collection. 703 */ 704 if (WMT_HI_ABSOLUTE(hi) && touch_coll && 705 (report_id == 0 || report_id == hi.report_ID)) 706 report_id = hi.report_ID; 707 else 708 break; 709 710 if (hi.collevel == 1 && hi.usage == 711 HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACTCOUNT)) { 712 cont_count_found = true; 713 if (sc != NULL) 714 sc->nconts_loc = hi.loc; 715 break; 716 } 717 /* Scan time is required but clobbered by evdev */ 718 if (hi.collevel == 1 && hi.usage == 719 HID_USAGE2(HUP_DIGITIZERS, HUD_SCAN_TIME)) { 720 scan_time_found = true; 721 break; 722 } 723 724 if (!finger_coll || hi.collevel != 2) 725 break; 726 if (sc == NULL && cont > 0) 727 break; 728 if (cont >= MAX_MT_SLOTS) { 729 DPRINTF("Finger %zu ignored\n", cont); 730 break; 731 } 732 733 for (i = 0; i < WMT_N_USAGES; i++) { 734 if (hi.usage == wmt_hid_map[i].usage) { 735 if (sc == NULL) { 736 if (USAGE_SUPPORTED(caps, i)) 737 continue; 738 caps |= 1 << i; 739 break; 740 } 741 /* 742 * HUG_X usage is an array mapped to 743 * both ABS_MT_POSITION and ABS_MT_TOOL 744 * events. So don`t stop search if we 745 * already have HUG_X mapping done. 746 */ 747 if (sc->locs[cont][i].size) 748 continue; 749 sc->locs[cont][i] = hi.loc; 750 /* 751 * Hid parser returns valid logical and 752 * physical sizes for first finger only 753 * at least on ElanTS 0x04f3:0x0012. 754 */ 755 if (cont > 0) 756 break; 757 caps |= 1 << i; 758 sc->ai[i] = (struct wmt_absinfo) { 759 .max = hi.logical_maximum, 760 .min = hi.logical_minimum, 761 .res = hid_item_resolution(&hi), 762 }; 763 break; 764 } 765 } 766 break; 767 default: 768 break; 769 } 770 } 771 hid_end_parse(hd); 772 773 /* Check for required HID Usages */ 774 if (!cont_count_found || !scan_time_found || cont == 0) 775 return (false); 776 for (i = 0; i < WMT_N_USAGES; i++) { 777 if (wmt_hid_map[i].required && !USAGE_SUPPORTED(caps, i)) 778 return (false); 779 } 780 781 /* Stop probing here */ 782 if (sc == NULL) 783 return (true); 784 785 /* 786 * According to specifications 'Contact Count Maximum' should be read 787 * from Feature Report rather than from HID descriptor. Set sane 788 * default value now to handle the case of 'Get Report' request failure 789 */ 790 if (cont_count_max < 1) 791 cont_count_max = cont; 792 793 /* Cap contact count maximum to MAX_MT_SLOTS */ 794 if (cont_count_max > MAX_MT_SLOTS) 795 cont_count_max = MAX_MT_SLOTS; 796 797 /* Set number of MT protocol type B slots */ 798 sc->ai[WMT_SLOT] = (struct wmt_absinfo) { 799 .min = 0, 800 .max = cont_count_max - 1, 801 .res = 0, 802 }; 803 804 /* Report touch orientation if both width and height are supported */ 805 if (USAGE_SUPPORTED(caps, WMT_WIDTH) && 806 USAGE_SUPPORTED(caps, WMT_HEIGHT)) { 807 caps |= (1 << WMT_ORIENTATION); 808 sc->ai[WMT_ORIENTATION].max = 1; 809 } 810 811 sc->isize = wmt_hid_report_size(d_ptr, d_len, hid_input, report_id); 812 sc->cont_max_rlen = wmt_hid_report_size(d_ptr, d_len, hid_feature, 813 cont_max_rid); 814 if (thqa_cert_rid > 0) 815 sc->thqa_cert_rlen = wmt_hid_report_size(d_ptr, d_len, 816 hid_feature, thqa_cert_rid); 817 818 sc->report_id = report_id; 819 sc->caps = caps; 820 sc->nconts_max = cont; 821 sc->cont_max_rid = cont_max_rid; 822 sc->thqa_cert_rid = thqa_cert_rid; 823 824 /* Announce information about the touch device */ 825 device_printf(sc->dev, 826 "%d contacts and [%s%s%s%s%s]. Report range [%d:%d] - [%d:%d]\n", 827 (int)cont_count_max, 828 USAGE_SUPPORTED(sc->caps, WMT_IN_RANGE) ? "R" : "", 829 USAGE_SUPPORTED(sc->caps, WMT_CONFIDENCE) ? "C" : "", 830 USAGE_SUPPORTED(sc->caps, WMT_WIDTH) ? "W" : "", 831 USAGE_SUPPORTED(sc->caps, WMT_HEIGHT) ? "H" : "", 832 USAGE_SUPPORTED(sc->caps, WMT_PRESSURE) ? "P" : "", 833 (int)sc->ai[WMT_X].min, (int)sc->ai[WMT_Y].min, 834 (int)sc->ai[WMT_X].max, (int)sc->ai[WMT_Y].max); 835 return (true); 836 } 837 838 static void 839 wmt_cont_max_parse(struct wmt_softc *sc, const void *r_ptr, uint16_t r_len) 840 { 841 uint32_t cont_count_max; 842 843 cont_count_max = hid_get_data_unsigned((const uint8_t *)r_ptr + 1, 844 r_len - 1, &sc->cont_max_loc); 845 if (cont_count_max > MAX_MT_SLOTS) { 846 DPRINTF("Hardware reported %d contacts while only %d is " 847 "supported\n", (int)cont_count_max, MAX_MT_SLOTS); 848 cont_count_max = MAX_MT_SLOTS; 849 } 850 /* Feature report is a primary source of 'Contact Count Maximum' */ 851 if (cont_count_max > 0 && 852 cont_count_max != sc->ai[WMT_SLOT].max + 1) { 853 sc->ai[WMT_SLOT].max = cont_count_max - 1; 854 device_printf(sc->dev, "%d feature report contacts", 855 cont_count_max); 856 } 857 } 858 859 static const STRUCT_USB_HOST_ID wmt_devs[] = { 860 /* generic HID class w/o boot interface */ 861 {USB_IFACE_CLASS(UICLASS_HID), 862 USB_IFACE_SUBCLASS(0),}, 863 }; 864 865 static devclass_t wmt_devclass; 866 867 static device_method_t wmt_methods[] = { 868 DEVMETHOD(device_probe, wmt_probe), 869 DEVMETHOD(device_attach, wmt_attach), 870 DEVMETHOD(device_detach, wmt_detach), 871 872 DEVMETHOD_END 873 }; 874 875 static driver_t wmt_driver = { 876 .name = "wmt", 877 .methods = wmt_methods, 878 .size = sizeof(struct wmt_softc), 879 }; 880 881 DRIVER_MODULE(wmt, uhub, wmt_driver, wmt_devclass, NULL, 0); 882 MODULE_DEPEND(wmt, usb, 1, 1, 1); 883 MODULE_DEPEND(wmt, evdev, 1, 1, 1); 884 MODULE_VERSION(wmt, 1); 885 USB_PNP_HOST_INFO(wmt_devs); 886