sys/dev/hid/hmt.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014-2020 Vladimir Kondratyev <wulf@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 /*
  32  * MS Windows 7/8/10 compatible HID Multi-touch Device driver.
  33  * https://msdn.microsoft.com/en-us/library/windows/hardware/jj151569(v=vs.85).aspx
  34  * http://download.microsoft.com/download/7/d/d/7dd44bb7-2a7a-4505-ac1c-7227d3d96d5b/hid-over-i2c-protocol-spec-v1-0.docx
  35  * https://www.kernel.org/doc/Documentation/input/multi-touch-protocol.txt
  36  */
  37
  38 #include "opt_hid.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/bus.h>
  42 #include <sys/kernel.h>
  43 #include <sys/lock.h>
  44 #include <sys/malloc.h>
  45 #include <sys/module.h>
  46 #include <sys/mutex.h>
  47 #include <sys/sysctl.h>
  48 #include <sys/systm.h>
  49
  50 #include <dev/evdev/evdev.h>
  51 #include <dev/evdev/input.h>
  52
  53 #define HID_DEBUG_VAR   hmt_debug
  54 #include <dev/hid/hid.h>
  55 #include <dev/hid/hidbus.h>
  56 #include <dev/hid/hidquirk.h>
  57
  58 #include <dev/hid/hconf.h>
  59
  60 static SYSCTL_NODE(_hw_hid, OID_AUTO, hmt, CTLFLAG_RW, 0,
  61     "MSWindows 7/8/10 compatible HID Multi-touch Device");
  62 #ifdef HID_DEBUG
  63 static int hmt_debug = 0;
  64 SYSCTL_INT(_hw_hid_hmt, OID_AUTO, debug, CTLFLAG_RWTUN,
  65     &hmt_debug, 1, "Debug level");
  66 #endif
  67 static bool hmt_timestamps = 0;
  68 SYSCTL_BOOL(_hw_hid_hmt, OID_AUTO, timestamps, CTLFLAG_RDTUN,
  69     &hmt_timestamps, 1, "Enable hardware timestamp reporting");
  70
  71 #define HMT_BTN_MAX     8       /* Number of buttons supported */
  72
  73 enum hmt_type {
  74         HMT_TYPE_UNKNOWN = 0,   /* HID report descriptor is not probed */
  75         HMT_TYPE_UNSUPPORTED,   /* Repdescr does not belong to MT device */
  76         HMT_TYPE_TOUCHPAD,
  77         HMT_TYPE_TOUCHSCREEN,
  78 };
  79
  80 enum {
  81         HMT_TIP_SWITCH =        ABS_MT_INDEX(ABS_MT_TOOL_TYPE),
  82         HMT_WIDTH =             ABS_MT_INDEX(ABS_MT_TOUCH_MAJOR),
  83         HMT_HEIGHT =            ABS_MT_INDEX(ABS_MT_TOUCH_MINOR),
  84         HMT_ORIENTATION =       ABS_MT_INDEX(ABS_MT_ORIENTATION),
  85         HMT_X =                 ABS_MT_INDEX(ABS_MT_POSITION_X),
  86         HMT_Y =                 ABS_MT_INDEX(ABS_MT_POSITION_Y),
  87         HMT_CONTACTID =         ABS_MT_INDEX(ABS_MT_TRACKING_ID),
  88         HMT_PRESSURE =          ABS_MT_INDEX(ABS_MT_PRESSURE),
  89         HMT_IN_RANGE =          ABS_MT_INDEX(ABS_MT_DISTANCE),
  90         HMT_CONFIDENCE =        ABS_MT_INDEX(ABS_MT_BLOB_ID),
  91         HMT_TOOL_X =            ABS_MT_INDEX(ABS_MT_TOOL_X),
  92         HMT_TOOL_Y =            ABS_MT_INDEX(ABS_MT_TOOL_Y),
  93 };
  94
  95 #define HMT_N_USAGES    MT_CNT
  96 #define HMT_NO_USAGE    -1
  97
  98 struct hmt_hid_map_item {
  99         char            name[5];
 100         int32_t         usage;          /* HID usage */
 101         bool            reported;       /* Item value is passed to evdev */
 102         bool            required;       /* Required for MT Digitizers */
 103 };
 104
 105 static const struct hmt_hid_map_item hmt_hid_map[HMT_N_USAGES] = {
 106         [HMT_TIP_SWITCH] = {
 107                 .name = "TIP",
 108                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_TIP_SWITCH),
 109                 .reported = false,
 110                 .required = true,
 111         },
 112         [HMT_WIDTH] = {
 113                 .name = "WDTH",
 114                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_WIDTH),
 115                 .reported = true,
 116                 .required = false,
 117         },
 118         [HMT_HEIGHT] = {
 119                 .name = "HGHT",
 120                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_HEIGHT),
 121                 .reported = true,
 122                 .required = false,
 123         },
 124         [HMT_ORIENTATION] = {
 125                 .name = "ORIE",
 126                 .usage = HMT_NO_USAGE,
 127                 .reported = true,
 128                 .required = false,
 129         },
 130         [HMT_X] = {
 131                 .name = "X",
 132                 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 133                 .reported = true,
 134                 .required = true,
 135         },
 136         [HMT_Y] = {
 137                 .name = "Y",
 138                 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 139                 .reported = true,
 140                 .required = true,
 141         },
 142         [HMT_CONTACTID] = {
 143                 .name = "C_ID",
 144                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACTID),
 145                 .reported = true,
 146                 .required = true,
 147         },
 148         [HMT_PRESSURE] = {
 149                 .name = "PRES",
 150                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_TIP_PRESSURE),
 151                 .reported = true,
 152                 .required = false,
 153         },
 154         [HMT_IN_RANGE] = {
 155                 .name = "RANG",
 156                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_IN_RANGE),
 157                 .reported = true,
 158                 .required = false,
 159         },
 160         [HMT_CONFIDENCE] = {
 161                 .name = "CONF",
 162                 .usage = HID_USAGE2(HUP_DIGITIZERS, HUD_CONFIDENCE),
 163                 .reported = false,
 164                 .required = false,
 165         },
 166         [HMT_TOOL_X] = { /* Shares HID usage with POS_X */
 167                 .name = "TL_X",
 168                 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 169                 .reported = true,
 170                 .required = false,
 171         },
 172         [HMT_TOOL_Y] = { /* Shares HID usage with POS_Y */
 173                 .name = "TL_Y",
 174                 .usage = HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 175                 .reported = true,
 176                 .required = false,
 177         },
 178 };
 179
 180 struct hmt_softc {
 181         device_t                dev;
 182         enum hmt_type           type;
 183
 184         int32_t                 cont_count_max;
 185         struct hid_absinfo      ai[HMT_N_USAGES];
 186         struct hid_location     locs[MAX_MT_SLOTS][HMT_N_USAGES];
 187         struct hid_location     cont_count_loc;
 188         struct hid_location     btn_loc[HMT_BTN_MAX];
 189         struct hid_location     int_btn_loc;
 190         struct hid_location     scan_time_loc;
 191         int32_t                 scan_time_max;
 192         int32_t                 scan_time;
 193         int32_t                 timestamp;
 194         bool                    touch;
 195         bool                    prev_touch;
 196
 197         struct evdev_dev        *evdev;
 198
 199         union evdev_mt_slot     slot_data;
 200         uint8_t                 caps[howmany(HMT_N_USAGES, 8)];
 201         uint8_t                 buttons[howmany(HMT_BTN_MAX, 8)];
 202         uint32_t                nconts_per_report;
 203         uint32_t                nconts_todo;
 204         uint8_t                 report_id;
 205         uint32_t                max_button;
 206         bool                    has_int_button;
 207         bool                    has_cont_count;
 208         bool                    has_scan_time;
 209         bool                    is_clickpad;
 210         bool                    do_timestamps;
 211 #ifdef IICHID_SAMPLING
 212         bool                    iichid_sampling;
 213 #endif
 214
 215         struct hid_location     cont_max_loc;
 216         uint32_t                cont_max_rlen;
 217         uint8_t                 cont_max_rid;
 218         struct hid_location     btn_type_loc;
 219         uint32_t                btn_type_rlen;
 220         uint8_t                 btn_type_rid;
 221         uint32_t                thqa_cert_rlen;
 222         uint8_t                 thqa_cert_rid;
 223 };
 224
 225 #define HMT_FOREACH_USAGE(caps, usage)                  \
 226         for ((usage) = 0; (usage) < HMT_N_USAGES; ++(usage))    \
 227                 if (isset((caps), (usage)))
 228
 229 static enum hmt_type hmt_hid_parse(struct hmt_softc *, const void *,
 230     hid_size_t, uint32_t, uint8_t);
 231 static int hmt_set_input_mode(struct hmt_softc *, enum hconf_input_mode);
 232
 233 static hid_intr_t       hmt_intr;
 234
 235 static device_probe_t   hmt_probe;
 236 static device_attach_t  hmt_attach;
 237 static device_detach_t  hmt_detach;
 238
 239 static evdev_open_t     hmt_ev_open;
 240 static evdev_close_t    hmt_ev_close;
 241
 242 static const struct evdev_methods hmt_evdev_methods = {
 243         .ev_open = &hmt_ev_open,
 244         .ev_close = &hmt_ev_close,
 245 };
 246
 247 static const struct hid_device_id hmt_devs[] = {
 248         { HID_TLC(HUP_DIGITIZERS, HUD_TOUCHSCREEN) },
 249         { HID_TLC(HUP_DIGITIZERS, HUD_TOUCHPAD) },
 250 };
 251
 252 static int
 253 hmt_ev_close(struct evdev_dev *evdev)
 254 {
 255         return (hidbus_intr_stop(evdev_get_softc(evdev)));
 256 }
 257
 258 static int
 259 hmt_ev_open(struct evdev_dev *evdev)
 260 {
 261         return (hidbus_intr_start(evdev_get_softc(evdev)));
 262 }
 263
 264 static int
 265 hmt_probe(device_t dev)
 266 {
 267         struct hmt_softc *sc = device_get_softc(dev);
 268         void *d_ptr;
 269         hid_size_t d_len;
 270         int err;
 271
 272         err = HIDBUS_LOOKUP_DRIVER_INFO(dev, hmt_devs);
 273         if (err != 0)
 274                 return (err);
 275
 276         err = hid_get_report_descr(dev, &d_ptr, &d_len);
 277         if (err != 0) {
 278                 device_printf(dev, "could not retrieve report descriptor from "
 279                      "device: %d\n", err);
 280                 return (ENXIO);
 281         }
 282
 283         /* Check if report descriptor belongs to a HID multitouch device */
 284         if (sc->type == HMT_TYPE_UNKNOWN)
 285                 sc->type = hmt_hid_parse(sc, d_ptr, d_len,
 286                     hidbus_get_usage(dev), hidbus_get_index(dev));
 287         if (sc->type == HMT_TYPE_UNSUPPORTED)
 288                 return (ENXIO);
 289
 290         hidbus_set_desc(dev,
 291             sc->type == HMT_TYPE_TOUCHPAD ? "TouchPad" : "TouchScreen");
 292
 293         return (BUS_PROBE_DEFAULT);
 294 }
 295
 296 static int
 297 hmt_attach(device_t dev)
 298 {
 299         struct hmt_softc *sc = device_get_softc(dev);
 300         const struct hid_device_info *hw = hid_get_device_info(dev);
 301         void *d_ptr;
 302         uint8_t *fbuf = NULL;
 303         hid_size_t d_len, fsize;
 304         uint32_t cont_count_max;
 305         int nbuttons, btn;
 306         size_t i;
 307         int err;
 308
 309         err = hid_get_report_descr(dev, &d_ptr, &d_len);
 310         if (err != 0) {
 311                 device_printf(dev, "could not retrieve report descriptor from "
 312                     "device: %d\n", err);
 313                 return (ENXIO);
 314         }
 315
 316         sc->dev = dev;
 317
 318         fsize = hid_report_size_max(d_ptr, d_len, hid_feature, NULL);
 319         if (fsize != 0)
 320                 fbuf = malloc(fsize, M_TEMP, M_WAITOK | M_ZERO);
 321
 322         /* Fetch and parse "Contact count maximum" feature report */
 323         if (sc->cont_max_rlen > 1) {
 324                 err = hid_get_report(dev, fbuf, sc->cont_max_rlen, NULL,
 325                     HID_FEATURE_REPORT, sc->cont_max_rid);
 326                 if (err == 0) {
 327                         cont_count_max = hid_get_udata(fbuf + 1,
 328                             sc->cont_max_rlen - 1, &sc->cont_max_loc);
 329                         /*
 330                          * Feature report is a primary source of
 331                          * 'Contact Count Maximum'
 332                          */
 333                         if (cont_count_max > 0)
 334                                 sc->cont_count_max = cont_count_max;
 335                 } else
 336                         DPRINTF("hid_get_report error=%d\n", err);
 337         } else
 338                 DPRINTF("Feature report %hhu size invalid: %u\n",
 339                     sc->cont_max_rid, sc->cont_max_rlen);
 340
 341         /* Fetch and parse "Button type" feature report */
 342         if (sc->btn_type_rlen > 1 && sc->btn_type_rid != sc->cont_max_rid) {
 343                 bzero(fbuf, fsize);
 344                 err = hid_get_report(dev, fbuf, sc->btn_type_rlen, NULL,
 345                     HID_FEATURE_REPORT, sc->btn_type_rid);
 346         }
 347         if (sc->btn_type_rlen > 1) {
 348                 if (err == 0)
 349                         sc->is_clickpad = hid_get_udata(fbuf + 1,
 350                             sc->btn_type_rlen - 1, &sc->btn_type_loc) == 0;
 351                 else
 352                         DPRINTF("hid_get_report error=%d\n", err);
 353         }
 354
 355         /* Fetch THQA certificate to enable some devices like WaveShare */
 356         if (sc->thqa_cert_rlen > 1 && sc->thqa_cert_rid != sc->cont_max_rid)
 357                 (void)hid_get_report(dev, fbuf, sc->thqa_cert_rlen, NULL,
 358                     HID_FEATURE_REPORT, sc->thqa_cert_rid);
 359
 360         free(fbuf, M_TEMP);
 361
 362         /* Switch touchpad in to absolute multitouch mode */
 363         if (sc->type == HMT_TYPE_TOUCHPAD) {
 364                 err = hmt_set_input_mode(sc, HCONF_INPUT_MODE_MT_TOUCHPAD);
 365                 if (err != 0)
 366                         DPRINTF("Failed to set input mode: %d\n", err);
 367         }
 368
 369         /* Cap contact count maximum to MAX_MT_SLOTS */
 370         if (sc->cont_count_max > MAX_MT_SLOTS) {
 371                 DPRINTF("Hardware reported %d contacts while only %d is "
 372                     "supported\n", sc->cont_count_max, MAX_MT_SLOTS);
 373                 sc->cont_count_max = MAX_MT_SLOTS;
 374         }
 375
 376         if (sc->has_scan_time &&
 377             (hid_test_quirk(hw, HQ_MT_TIMESTAMP) || hmt_timestamps))
 378                 sc->do_timestamps = true;
 379 #ifdef IICHID_SAMPLING
 380         if (hid_test_quirk(hw, HQ_IICHID_SAMPLING))
 381                 sc->iichid_sampling = true;
 382 #endif
 383
 384         hidbus_set_intr(dev, hmt_intr, sc);
 385
 386         sc->evdev = evdev_alloc();
 387         evdev_set_name(sc->evdev, device_get_desc(dev));
 388         evdev_set_phys(sc->evdev, device_get_nameunit(dev));
 389         evdev_set_id(sc->evdev, hw->idBus, hw->idVendor, hw->idProduct,
 390             hw->idVersion);
 391         evdev_set_serial(sc->evdev, hw->serial);
 392         evdev_set_methods(sc->evdev, dev, &hmt_evdev_methods);
 393         evdev_set_flag(sc->evdev, EVDEV_FLAG_MT_STCOMPAT);
 394         evdev_set_flag(sc->evdev, EVDEV_FLAG_EXT_EPOCH); /* hidbus child */
 395         switch (sc->type) {
 396         case HMT_TYPE_TOUCHSCREEN:
 397                 evdev_support_prop(sc->evdev, INPUT_PROP_DIRECT);
 398                 break;
 399         case HMT_TYPE_TOUCHPAD:
 400                 evdev_support_prop(sc->evdev, INPUT_PROP_POINTER);
 401                 if (sc->is_clickpad)
 402                         evdev_support_prop(sc->evdev, INPUT_PROP_BUTTONPAD);
 403                 break;
 404         default:
 405                 KASSERT(0, ("hmt_attach: unsupported touch device type"));
 406         }
 407         evdev_support_event(sc->evdev, EV_SYN);
 408         evdev_support_event(sc->evdev, EV_ABS);
 409         if (sc->do_timestamps) {
 410                 evdev_support_event(sc->evdev, EV_MSC);
 411                 evdev_support_msc(sc->evdev, MSC_TIMESTAMP);
 412         }
 413 #ifdef IICHID_SAMPLING
 414         if (sc->iichid_sampling)
 415                 evdev_set_flag(sc->evdev, EVDEV_FLAG_MT_AUTOREL);
 416 #endif
 417         nbuttons = 0;
 418         if (sc->max_button != 0 || sc->has_int_button) {
 419                 evdev_support_event(sc->evdev, EV_KEY);
 420                 if (sc->has_int_button)
 421                         evdev_support_key(sc->evdev, BTN_LEFT);
 422                 for (btn = 0; btn < sc->max_button; ++btn) {
 423                         if (isset(sc->buttons, btn)) {
 424                                 evdev_support_key(sc->evdev, BTN_MOUSE + btn);
 425                                 nbuttons++;
 426                         }
 427                 }
 428         }
 429         evdev_support_abs(sc->evdev,
 430             ABS_MT_SLOT, 0, sc->cont_count_max - 1, 0, 0, 0);
 431         HMT_FOREACH_USAGE(sc->caps, i) {
 432                 if (hmt_hid_map[i].reported)
 433                         evdev_support_abs(sc->evdev, ABS_MT_FIRST + i,
 434                             sc->ai[i].min, sc->ai[i].max, 0, 0, sc->ai[i].res);
 435         }
 436
 437         err = evdev_register(sc->evdev);
 438         if (err) {
 439                 hmt_detach(dev);
 440                 return (ENXIO);
 441         }
 442
 443         /* Announce information about the touch device */
 444         device_printf(sc->dev, "%s %s with %d external button%s%s\n",
 445             sc->cont_count_max > 1 ? "Multitouch" : "Singletouch",
 446             sc->type == HMT_TYPE_TOUCHSCREEN ? "touchscreen" : "touchpad",
 447             nbuttons, nbuttons != 1 ? "s" : "",
 448             sc->is_clickpad ? ", click-pad" : "");
 449         device_printf(sc->dev,
 450             "%d contact%s with [%s%s%s%s%s] properties. Report range [%d:%d] - [%d:%d]\n",
 451             (int)sc->cont_count_max, sc->cont_count_max != 1 ? "s" : "",
 452             isset(sc->caps, HMT_IN_RANGE) ? "R" : "",
 453             isset(sc->caps, HMT_CONFIDENCE) ? "C" : "",
 454             isset(sc->caps, HMT_WIDTH) ? "W" : "",
 455             isset(sc->caps, HMT_HEIGHT) ? "H" : "",
 456             isset(sc->caps, HMT_PRESSURE) ? "P" : "",
 457             (int)sc->ai[HMT_X].min, (int)sc->ai[HMT_Y].min,
 458             (int)sc->ai[HMT_X].max, (int)sc->ai[HMT_Y].max);
 459
 460         return (0);
 461 }
 462
 463 static int
 464 hmt_detach(device_t dev)
 465 {
 466         struct hmt_softc *sc = device_get_softc(dev);
 467
 468         evdev_free(sc->evdev);
 469
 470         return (0);
 471 }
 472
 473 static void
 474 hmt_intr(void *context, void *buf, hid_size_t len)
 475 {
 476         struct hmt_softc *sc = context;
 477         size_t usage;
 478         union evdev_mt_slot *slot_data;
 479         uint32_t cont, btn;
 480         uint32_t cont_count;
 481         uint32_t width;
 482         uint32_t height;
 483         uint32_t int_btn = 0;
 484         uint32_t left_btn = 0;
 485         int slot;
 486         uint32_t scan_time;
 487         int32_t delta;
 488         uint8_t id;
 489
 490 #ifdef IICHID_SAMPLING
 491         /*
 492          * Special packet of zero length is generated by iichid driver running
 493          * in polling mode at the start of inactivity period to workaround
 494          * "stuck touch" problem caused by miss of finger release events.
 495          * This snippet is to be removed after GPIO interrupt support is added.
 496          */
 497         if (sc->iichid_sampling && len == 0) {
 498                 sc->prev_touch = false;
 499                 sc->timestamp = 0;
 500                 /* EVDEV_FLAG_MT_AUTOREL releases all touches for us */
 501                 evdev_sync(sc->evdev);
 502                 return;
 503         }
 504 #endif
 505
 506         /* Ignore irrelevant reports */
 507         id = sc->report_id != 0 ? *(uint8_t *)buf : 0;
 508         if (sc->report_id != id) {
 509                 DPRINTF("Skip report with unexpected ID: %hhu\n", id);
 510                 return;
 511         }
 512
 513         /* Strip leading "report ID" byte */
 514         if (sc->report_id != 0) {
 515                 len--;
 516                 buf = (uint8_t *)buf + 1;
 517         }
 518
 519         /*
 520          * "In Serial mode, each packet contains information that describes a
 521          * single physical contact point. Multiple contacts are streamed
 522          * serially. In this mode, devices report all contact information in a
 523          * series of packets. The device sends a separate packet for each
 524          * concurrent contact."
 525          *
 526          * "In Parallel mode, devices report all contact information in a
 527          * single packet. Each physical contact is represented by a logical
 528          * collection that is embedded in the top-level collection."
 529          *
 530          * Since additional contacts that were not present will still be in the
 531          * report with contactid=0 but contactids are zero-based, find
 532          * contactcount first.
 533          */
 534         if (sc->has_cont_count)
 535                 cont_count = hid_get_udata(buf, len, &sc->cont_count_loc);
 536         else
 537                 cont_count = 1;
 538         /*
 539          * "In Hybrid mode, the number of contacts that can be reported in one
 540          * report is less than the maximum number of contacts that the device
 541          * supports. For example, a device that supports a maximum of
 542          * 4 concurrent physical contacts, can set up its top-level collection
 543          * to deliver a maximum of two contacts in one report. If four contact
 544          * points are present, the device can break these up into two serial
 545          * reports that deliver two contacts each.
 546          *
 547          * "When a device delivers data in this manner, the Contact Count usage
 548          * value in the first report should reflect the total number of
 549          * contacts that are being delivered in the hybrid reports. The other
 550          * serial reports should have a contact count of zero (0)."
 551          */
 552         if (cont_count != 0)
 553                 sc->nconts_todo = cont_count;
 554
 555 #ifdef HID_DEBUG
 556         DPRINTFN(6, "cont_count:%2u", (unsigned)cont_count);
 557         if (hmt_debug >= 6) {
 558                 HMT_FOREACH_USAGE(sc->caps, usage) {
 559                         if (hmt_hid_map[usage].usage != HMT_NO_USAGE)
 560                                 printf(" %-4s", hmt_hid_map[usage].name);
 561                 }
 562                 printf("\n");
 563         }
 564 #endif
 565
 566         /* Find the number of contacts reported in current report */
 567         cont_count = MIN(sc->nconts_todo, sc->nconts_per_report);
 568
 569         /* Use protocol Type B for reporting events */
 570         for (cont = 0; cont < cont_count; cont++) {
 571                 slot_data = &sc->slot_data;
 572                 bzero(slot_data, sizeof(sc->slot_data));
 573                 HMT_FOREACH_USAGE(sc->caps, usage) {
 574                         if (sc->locs[cont][usage].size > 0)
 575                                 slot_data->val[usage] = hid_get_udata(
 576                                     buf, len, &sc->locs[cont][usage]);
 577                 }
 578
 579                 slot = evdev_mt_id_to_slot(sc->evdev, slot_data->id);
 580
 581 #ifdef HID_DEBUG
 582                 DPRINTFN(6, "cont%01x: data = ", cont);
 583                 if (hmt_debug >= 6) {
 584                         HMT_FOREACH_USAGE(sc->caps, usage) {
 585                                 if (hmt_hid_map[usage].usage != HMT_NO_USAGE)
 586                                         printf("%04x ", slot_data->val[usage]);
 587                         }
 588                         printf("slot = %d\n", slot);
 589                 }
 590 #endif
 591
 592                 if (slot == -1) {
 593                         DPRINTF("Slot overflow for contact_id %u\n",
 594                             (unsigned)slot_data->id);
 595                         continue;
 596                 }
 597
 598                 if (slot_data->val[HMT_TIP_SWITCH] != 0 &&
 599                     !(isset(sc->caps, HMT_CONFIDENCE) &&
 600                       slot_data->val[HMT_CONFIDENCE] == 0)) {
 601                         /* This finger is in proximity of the sensor */
 602                         sc->touch = true;
 603                         slot_data->dist = !slot_data->val[HMT_IN_RANGE];
 604                         /* Divided by two to match visual scale of touch */
 605                         width = slot_data->val[HMT_WIDTH] >> 1;
 606                         height = slot_data->val[HMT_HEIGHT] >> 1;
 607                         slot_data->ori = width > height;
 608                         slot_data->maj = MAX(width, height);
 609                         slot_data->min = MIN(width, height);
 610                 } else
 611                         slot_data = NULL;
 612
 613                 evdev_mt_push_slot(sc->evdev, slot, slot_data);
 614         }
 615
 616         sc->nconts_todo -= cont_count;
 617         if (sc->do_timestamps && sc->nconts_todo == 0) {
 618                 /* HUD_SCAN_TIME is measured in 100us, convert to us. */
 619                 scan_time = hid_get_udata(buf, len, &sc->scan_time_loc);
 620                 if (sc->prev_touch) {
 621                         delta = scan_time - sc->scan_time;
 622                         if (delta < 0)
 623                                 delta += sc->scan_time_max;
 624                 } else
 625                         delta = 0;
 626                 sc->scan_time = scan_time;
 627                 sc->timestamp += delta * 100;
 628                 evdev_push_msc(sc->evdev, MSC_TIMESTAMP, sc->timestamp);
 629                 sc->prev_touch = sc->touch;
 630                 sc->touch = false;
 631                 if (!sc->prev_touch)
 632                         sc->timestamp = 0;
 633         }
 634         if (sc->nconts_todo == 0) {
 635                 /* Report both the click and external left btns as BTN_LEFT */
 636                 if (sc->has_int_button)
 637                         int_btn = hid_get_data(buf, len, &sc->int_btn_loc);
 638                 if (isset(sc->buttons, 0))
 639                         left_btn = hid_get_data(buf, len, &sc->btn_loc[0]);
 640                 if (sc->has_int_button || isset(sc->buttons, 0))
 641                         evdev_push_key(sc->evdev, BTN_LEFT,
 642                             (int_btn != 0) | (left_btn != 0));
 643                 for (btn = 1; btn < sc->max_button; ++btn) {
 644                         if (isset(sc->buttons, btn))
 645                                 evdev_push_key(sc->evdev, BTN_MOUSE + btn,
 646                                     hid_get_data(buf,
 647                                                  len,
 648                                                  &sc->btn_loc[btn]) != 0);
 649                 }
 650                 evdev_sync(sc->evdev);
 651         }
 652 }
 653
 654 static enum hmt_type
 655 hmt_hid_parse(struct hmt_softc *sc, const void *d_ptr, hid_size_t d_len,
 656     uint32_t tlc_usage, uint8_t tlc_index)
 657 {
 658         struct hid_absinfo ai;
 659         struct hid_item hi;
 660         struct hid_data *hd;
 661         uint32_t flags;
 662         size_t i;
 663         size_t cont = 0;
 664         enum hmt_type type;
 665         uint32_t left_btn, btn;
 666         int32_t cont_count_max = 0;
 667         uint8_t report_id = 0;
 668         bool finger_coll = false;
 669         bool cont_count_found = false;
 670         bool scan_time_found = false;
 671         bool has_int_button = false;
 672
 673 #define HMT_HI_ABSOLUTE(hi)     ((hi).nusages != 0 &&   \
 674         ((hi).flags & (HIO_VARIABLE | HIO_RELATIVE)) == HIO_VARIABLE)
 675 #define HUMS_THQA_CERT  0xC5
 676
 677         /*
 678          * Get left button usage taking in account MS Precision Touchpad specs.
 679          * For Windows PTP report descriptor assigns buttons in following way:
 680          * Button 1 - Indicates Button State for touchpad button integrated
 681          *            with digitizer.
 682          * Button 2 - Indicates Button State for external button for primary
 683          *            (default left) clicking.
 684          * Button 3 - Indicates Button State for external button for secondary
 685          *            (default right) clicking.
 686          * If a device only supports external buttons, it must still use
 687          * Button 2 and Button 3 to reference the external buttons.
 688          */
 689         switch (tlc_usage) {
 690         case HID_USAGE2(HUP_DIGITIZERS, HUD_TOUCHSCREEN):
 691                 type = HMT_TYPE_TOUCHSCREEN;
 692                 left_btn = 1;
 693                 break;
 694         case HID_USAGE2(HUP_DIGITIZERS, HUD_TOUCHPAD):
 695                 type = HMT_TYPE_TOUCHPAD;
 696                 left_btn = 2;
 697                 break;
 698         default:
 699                 return (HMT_TYPE_UNSUPPORTED);
 700         }
 701
 702         /* Parse features for mandatory maximum contact count usage */
 703         if (!hidbus_locate(d_ptr, d_len,
 704             HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACT_MAX), hid_feature,
 705             tlc_index, 0, &sc->cont_max_loc, &flags, &sc->cont_max_rid, &ai) ||
 706             (flags & (HIO_VARIABLE | HIO_RELATIVE)) != HIO_VARIABLE)
 707                 return (HMT_TYPE_UNSUPPORTED);
 708
 709         cont_count_max = ai.max;
 710
 711         /* Parse features for button type usage */
 712         if (hidbus_locate(d_ptr, d_len,
 713             HID_USAGE2(HUP_DIGITIZERS, HUD_BUTTON_TYPE), hid_feature,
 714             tlc_index, 0, &sc->btn_type_loc, &flags, &sc->btn_type_rid, NULL)
 715             && (flags & (HIO_VARIABLE | HIO_RELATIVE)) != HIO_VARIABLE)
 716                 sc->btn_type_rid = 0;
 717
 718         /* Parse features for THQA certificate report ID */
 719         hidbus_locate(d_ptr, d_len, HID_USAGE2(HUP_MICROSOFT, HUMS_THQA_CERT),
 720             hid_feature, tlc_index, 0, NULL, NULL, &sc->thqa_cert_rid, NULL);
 721
 722         /* Parse input for other parameters */
 723         hd = hid_start_parse(d_ptr, d_len, 1 << hid_input);
 724         HIDBUS_FOREACH_ITEM(hd, &hi, tlc_index) {
 725                 switch (hi.kind) {
 726                 case hid_collection:
 727                         if (hi.collevel == 2 &&
 728                             hi.usage == HID_USAGE2(HUP_DIGITIZERS, HUD_FINGER))
 729                                 finger_coll = true;
 730                         break;
 731                 case hid_endcollection:
 732                         if (hi.collevel == 1 && finger_coll) {
 733                                 finger_coll = false;
 734                                 cont++;
 735                         }
 736                         break;
 737                 case hid_input:
 738                         /*
 739                          * Ensure that all usages belong to the same report
 740                          */
 741                         if (HMT_HI_ABSOLUTE(hi) &&
 742                             (report_id == 0 || report_id == hi.report_ID))
 743                                 report_id = hi.report_ID;
 744                         else
 745                                 break;
 746
 747                         if (hi.collevel == 1 && left_btn == 2 &&
 748                             hi.usage == HID_USAGE2(HUP_BUTTON, 1)) {
 749                                 has_int_button = true;
 750                                 sc->int_btn_loc = hi.loc;
 751                                 break;
 752                         }
 753                         if (hi.collevel == 1 &&
 754                             hi.usage >= HID_USAGE2(HUP_BUTTON, left_btn) &&
 755                             hi.usage <= HID_USAGE2(HUP_BUTTON, HMT_BTN_MAX)) {
 756                                 btn = (hi.usage & 0xFFFF) - left_btn;
 757                                 setbit(sc->buttons, btn);
 758                                 sc->btn_loc[btn] = hi.loc;
 759                                 if (btn >= sc->max_button)
 760                                         sc->max_button = btn + 1;
 761                                 break;
 762                         }
 763                         if (hi.collevel == 1 && hi.usage ==
 764                             HID_USAGE2(HUP_DIGITIZERS, HUD_CONTACTCOUNT)) {
 765                                 cont_count_found = true;
 766                                 sc->cont_count_loc = hi.loc;
 767                                 break;
 768                         }
 769                         if (hi.collevel == 1 && hi.usage ==
 770                             HID_USAGE2(HUP_DIGITIZERS, HUD_SCAN_TIME)) {
 771                                 scan_time_found = true;
 772                                 sc->scan_time_loc = hi.loc;
 773                                 sc->scan_time_max = hi.logical_maximum;
 774                                 break;
 775                         }
 776
 777                         if (!finger_coll || hi.collevel != 2)
 778                                 break;
 779                         if (cont >= MAX_MT_SLOTS) {
 780                                 DPRINTF("Finger %zu ignored\n", cont);
 781                                 break;
 782                         }
 783
 784                         for (i = 0; i < HMT_N_USAGES; i++) {
 785                                 if (hi.usage == hmt_hid_map[i].usage) {
 786                                         /*
 787                                          * HUG_X usage is an array mapped to
 788                                          * both ABS_MT_POSITION and ABS_MT_TOOL
 789                                          * events. So don`t stop search if we
 790                                          * already have HUG_X mapping done.
 791                                          */
 792                                         if (sc->locs[cont][i].size)
 793                                                 continue;
 794                                         sc->locs[cont][i] = hi.loc;
 795                                         /*
 796                                          * Hid parser returns valid logical and
 797                                          * physical sizes for first finger only
 798                                          * at least on ElanTS 0x04f3:0x0012.
 799                                          */
 800                                         if (cont > 0)
 801                                                 break;
 802                                         setbit(sc->caps, i);
 803                                         sc->ai[i] = (struct hid_absinfo) {
 804                                             .max = hi.logical_maximum,
 805                                             .min = hi.logical_minimum,
 806                                             .res = hid_item_resolution(&hi),
 807                                         };
 808                                         break;
 809                                 }
 810                         }
 811                         break;
 812                 default:
 813                         break;
 814                 }
 815         }
 816         hid_end_parse(hd);
 817
 818         /* Check for required HID Usages */
 819         if ((!cont_count_found && cont != 1) || cont == 0)
 820                 return (HMT_TYPE_UNSUPPORTED);
 821         for (i = 0; i < HMT_N_USAGES; i++) {
 822                 if (hmt_hid_map[i].required && isclr(sc->caps, i))
 823                         return (HMT_TYPE_UNSUPPORTED);
 824         }
 825
 826         /* Touchpads must have at least one button */
 827         if (type == HMT_TYPE_TOUCHPAD && !sc->max_button && !has_int_button)
 828                 return (HMT_TYPE_UNSUPPORTED);
 829
 830         /*
 831          * According to specifications 'Contact Count Maximum' should be read
 832          * from Feature Report rather than from HID descriptor. Set sane
 833          * default value now to handle the case of 'Get Report' request failure
 834          */
 835         if (cont_count_max < 1)
 836                 cont_count_max = cont;
 837
 838         /* Report touch orientation if both width and height are supported */
 839         if (isset(sc->caps, HMT_WIDTH) && isset(sc->caps, HMT_HEIGHT)) {
 840                 setbit(sc->caps, HMT_ORIENTATION);
 841                 sc->ai[HMT_ORIENTATION].max = 1;
 842         }
 843
 844         sc->cont_max_rlen = hid_report_size(d_ptr, d_len, hid_feature,
 845             sc->cont_max_rid);
 846         if (sc->btn_type_rid > 0)
 847                 sc->btn_type_rlen = hid_report_size(d_ptr, d_len,
 848                     hid_feature, sc->btn_type_rid);
 849         if (sc->thqa_cert_rid > 0)
 850                 sc->thqa_cert_rlen = hid_report_size(d_ptr, d_len,
 851                     hid_feature, sc->thqa_cert_rid);
 852
 853         sc->report_id = report_id;
 854         sc->cont_count_max = cont_count_max;
 855         sc->nconts_per_report = cont;
 856         sc->has_int_button = has_int_button;
 857         sc->has_cont_count = cont_count_found;
 858         sc->has_scan_time = scan_time_found;
 859
 860         return (type);
 861 }
 862
 863 static int
 864 hmt_set_input_mode(struct hmt_softc *sc, enum hconf_input_mode mode)
 865 {
 866         devclass_t hconf_devclass;
 867         device_t hconf;
 868         int  err;
 869
 870         GIANT_REQUIRED;
 871
 872         /* Find touchpad's configuration TLC */
 873         hconf = hidbus_find_child(device_get_parent(sc->dev),
 874             HID_USAGE2(HUP_DIGITIZERS, HUD_CONFIG));
 875         if (hconf == NULL)
 876                 return (ENXIO);
 877
 878         /* Ensure that hconf driver is attached to configuration TLC */
 879         if (device_is_alive(hconf) == 0)
 880                 device_probe_and_attach(hconf);
 881         if (device_is_attached(hconf) == 0)
 882                 return (ENXIO);
 883         hconf_devclass = devclass_find("hconf");
 884         if (device_get_devclass(hconf) != hconf_devclass)
 885                 return (ENXIO);
 886
 887         /* hconf_set_input_mode can drop the Giant while sleeping */
 888         device_busy(hconf);
 889         err = hconf_set_input_mode(hconf, mode);
 890         device_unbusy(hconf);
 891
 892         return (err);
 893 }
 894
 895 static devclass_t hmt_devclass;
 896
 897 static device_method_t hmt_methods[] = {
 898         DEVMETHOD(device_probe,         hmt_probe),
 899         DEVMETHOD(device_attach,        hmt_attach),
 900         DEVMETHOD(device_detach,        hmt_detach),
 901
 902         DEVMETHOD_END
 903 };
 904
 905 static driver_t hmt_driver = {
 906         .name = "hmt",
 907         .methods = hmt_methods,
 908         .size = sizeof(struct hmt_softc),
 909 };
 910
 911 DRIVER_MODULE(hmt, hidbus, hmt_driver, hmt_devclass, NULL, 0);
 912 MODULE_DEPEND(hmt, hidbus, 1, 1, 1);
 913 MODULE_DEPEND(hmt, hid, 1, 1, 1);
 914 MODULE_DEPEND(hmt, hconf, 1, 1, 1);
 915 MODULE_DEPEND(hmt, evdev, 1, 1, 1);
 916 MODULE_VERSION(hmt, 1);
 917 HID_PNP_INFO(hmt_devs);