sys/dev/usb/input/ums.c

   1 /*-
   2  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Lennart Augustsson (lennart@augustsson.net) at
   7  * Carlstedt Research & Technology.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 /*
  35  * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
  36  */
  37
  38 #include <sys/stdint.h>
  39 #include <sys/stddef.h>
  40 #include <sys/param.h>
  41 #include <sys/queue.h>
  42 #include <sys/types.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/bus.h>
  46 #include <sys/linker_set.h>
  47 #include <sys/module.h>
  48 #include <sys/lock.h>
  49 #include <sys/mutex.h>
  50 #include <sys/condvar.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/sx.h>
  53 #include <sys/unistd.h>
  54 #include <sys/callout.h>
  55 #include <sys/malloc.h>
  56 #include <sys/priv.h>
  57 #include <sys/conf.h>
  58 #include <sys/fcntl.h>
  59 #include <sys/sbuf.h>
  60
  61 #include <dev/usb/usb.h>
  62 #include <dev/usb/usbdi.h>
  63 #include <dev/usb/usbdi_util.h>
  64 #include <dev/usb/usbhid.h>
  65 #include "usbdevs.h"
  66
  67 #define USB_DEBUG_VAR ums_debug
  68 #include <dev/usb/usb_debug.h>
  69
  70 #include <dev/usb/quirk/usb_quirk.h>
  71
  72 #include <sys/ioccom.h>
  73 #include <sys/filio.h>
  74 #include <sys/tty.h>
  75 #include <sys/mouse.h>
  76
  77 #ifdef USB_DEBUG
  78 static int ums_debug = 0;
  79
  80 SYSCTL_NODE(_hw_usb, OID_AUTO, ums, CTLFLAG_RW, 0, "USB ums");
  81 SYSCTL_INT(_hw_usb_ums, OID_AUTO, debug, CTLFLAG_RW,
  82     &ums_debug, 0, "Debug level");
  83 #endif
  84
  85 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
  86 #define MOUSE_FLAGS (HIO_RELATIVE)
  87
  88 #define UMS_BUF_SIZE      8             /* bytes */
  89 #define UMS_IFQ_MAXLEN   50             /* units */
  90 #define UMS_BUTTON_MAX   31             /* exclusive, must be less than 32 */
  91 #define UMS_BUT(i) ((i) < 3 ? (((i) + 2) % 3) : (i))
  92 #define UMS_INFO_MAX      2             /* maximum number of HID sets */
  93
  94 enum {
  95         UMS_INTR_DT,
  96         UMS_N_TRANSFER,
  97 };
  98
  99 struct ums_info {
 100         struct hid_location sc_loc_w;
 101         struct hid_location sc_loc_x;
 102         struct hid_location sc_loc_y;
 103         struct hid_location sc_loc_z;
 104         struct hid_location sc_loc_t;
 105         struct hid_location sc_loc_btn[UMS_BUTTON_MAX];
 106
 107         uint32_t sc_flags;
 108 #define UMS_FLAG_X_AXIS     0x0001
 109 #define UMS_FLAG_Y_AXIS     0x0002
 110 #define UMS_FLAG_Z_AXIS     0x0004
 111 #define UMS_FLAG_T_AXIS     0x0008
 112 #define UMS_FLAG_SBU        0x0010      /* spurious button up events */
 113 #define UMS_FLAG_REVZ       0x0020      /* Z-axis is reversed */
 114 #define UMS_FLAG_W_AXIS     0x0040
 115
 116         uint8_t sc_iid_w;
 117         uint8_t sc_iid_x;
 118         uint8_t sc_iid_y;
 119         uint8_t sc_iid_z;
 120         uint8_t sc_iid_t;
 121         uint8_t sc_iid_btn[UMS_BUTTON_MAX];
 122         uint8_t sc_buttons;
 123 };
 124
 125 struct ums_softc {
 126         struct usb_fifo_sc sc_fifo;
 127         struct mtx sc_mtx;
 128         struct usb_callout sc_callout;
 129         struct ums_info sc_info[UMS_INFO_MAX];
 130
 131         mousehw_t sc_hw;
 132         mousemode_t sc_mode;
 133         mousestatus_t sc_status;
 134
 135         struct usb_xfer *sc_xfer[UMS_N_TRANSFER];
 136
 137         int sc_pollrate;
 138
 139         uint8_t sc_buttons;
 140         uint8_t sc_iid;
 141         uint8_t sc_temp[64];
 142 };
 143
 144 static void ums_put_queue_timeout(void *__sc);
 145
 146 static usb_callback_t ums_intr_callback;
 147
 148 static device_probe_t ums_probe;
 149 static device_attach_t ums_attach;
 150 static device_detach_t ums_detach;
 151
 152 static usb_fifo_cmd_t ums_start_read;
 153 static usb_fifo_cmd_t ums_stop_read;
 154 static usb_fifo_open_t ums_open;
 155 static usb_fifo_close_t ums_close;
 156 static usb_fifo_ioctl_t ums_ioctl;
 157
 158 static void     ums_put_queue(struct ums_softc *, int32_t, int32_t,
 159                     int32_t, int32_t, int32_t);
 160 static int      ums_sysctl_handler_parseinfo(SYSCTL_HANDLER_ARGS);
 161
 162 static struct usb_fifo_methods ums_fifo_methods = {
 163         .f_open = &ums_open,
 164         .f_close = &ums_close,
 165         .f_ioctl = &ums_ioctl,
 166         .f_start_read = &ums_start_read,
 167         .f_stop_read = &ums_stop_read,
 168         .basename[0] = "ums",
 169 };
 170
 171 static void
 172 ums_put_queue_timeout(void *__sc)
 173 {
 174         struct ums_softc *sc = __sc;
 175
 176         mtx_assert(&sc->sc_mtx, MA_OWNED);
 177
 178         ums_put_queue(sc, 0, 0, 0, 0, 0);
 179 }
 180
 181 static void
 182 ums_intr_callback(struct usb_xfer *xfer, usb_error_t error)
 183 {
 184         struct ums_softc *sc = usbd_xfer_softc(xfer);
 185         struct ums_info *info = &sc->sc_info[0];
 186         struct usb_page_cache *pc;
 187         uint8_t *buf = sc->sc_temp;
 188         int32_t buttons = 0;
 189         int32_t buttons_found = 0;
 190         int32_t dw = 0;
 191         int32_t dx = 0;
 192         int32_t dy = 0;
 193         int32_t dz = 0;
 194         int32_t dt = 0;
 195         uint8_t i;
 196         uint8_t id;
 197         int len;
 198
 199         usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
 200
 201         switch (USB_GET_STATE(xfer)) {
 202         case USB_ST_TRANSFERRED:
 203                 DPRINTFN(6, "sc=%p actlen=%d\n", sc, len);
 204
 205                 if (len > sizeof(sc->sc_temp)) {
 206                         DPRINTFN(6, "truncating large packet to %zu bytes\n",
 207                             sizeof(sc->sc_temp));
 208                         len = sizeof(sc->sc_temp);
 209                 }
 210                 if (len == 0)
 211                         goto tr_setup;
 212
 213                 pc = usbd_xfer_get_frame(xfer, 0);
 214                 usbd_copy_out(pc, 0, buf, len);
 215
 216                 DPRINTFN(6, "data = %02x %02x %02x %02x "
 217                     "%02x %02x %02x %02x\n",
 218                     (len > 0) ? buf[0] : 0, (len > 1) ? buf[1] : 0,
 219                     (len > 2) ? buf[2] : 0, (len > 3) ? buf[3] : 0,
 220                     (len > 4) ? buf[4] : 0, (len > 5) ? buf[5] : 0,
 221                     (len > 6) ? buf[6] : 0, (len > 7) ? buf[7] : 0);
 222
 223                 if (sc->sc_iid) {
 224                         id = *buf;
 225
 226                         len--;
 227                         buf++;
 228
 229                 } else {
 230                         id = 0;
 231                         if (sc->sc_info[0].sc_flags & UMS_FLAG_SBU) {
 232                                 if ((*buf == 0x14) || (*buf == 0x15)) {
 233                                         goto tr_setup;
 234                                 }
 235                         }
 236                 }
 237
 238         repeat:
 239                 if ((info->sc_flags & UMS_FLAG_W_AXIS) &&
 240                     (id == info->sc_iid_w))
 241                         dw += hid_get_data(buf, len, &info->sc_loc_w);
 242
 243                 if ((info->sc_flags & UMS_FLAG_X_AXIS) &&
 244                     (id == info->sc_iid_x))
 245                         dx += hid_get_data(buf, len, &info->sc_loc_x);
 246
 247                 if ((info->sc_flags & UMS_FLAG_Y_AXIS) &&
 248                     (id == info->sc_iid_y))
 249                         dy = -hid_get_data(buf, len, &info->sc_loc_y);
 250
 251                 if ((info->sc_flags & UMS_FLAG_Z_AXIS) &&
 252                     (id == info->sc_iid_z)) {
 253                         int32_t temp;
 254                         temp = hid_get_data(buf, len, &info->sc_loc_z);
 255                         if (info->sc_flags & UMS_FLAG_REVZ)
 256                                 temp = -temp;
 257                         dz -= temp;
 258                 }
 259
 260                 if ((info->sc_flags & UMS_FLAG_T_AXIS) &&
 261                     (id == info->sc_iid_t))
 262                         dt -= hid_get_data(buf, len, &info->sc_loc_t);
 263
 264                 for (i = 0; i < info->sc_buttons; i++) {
 265                         uint32_t mask;
 266                         mask = 1UL << UMS_BUT(i);
 267                         /* check for correct button ID */
 268                         if (id != info->sc_iid_btn[i])
 269                                 continue;
 270                         /* check for button pressed */
 271                         if (hid_get_data(buf, len, &info->sc_loc_btn[i]))
 272                                 buttons |= mask;
 273                         /* register button mask */
 274                         buttons_found |= mask;
 275                 }
 276
 277                 if (++info != &sc->sc_info[UMS_INFO_MAX])
 278                         goto repeat;
 279
 280                 /* keep old button value(s) for non-detected buttons */
 281                 buttons |= sc->sc_status.button & ~buttons_found;
 282
 283                 if (dx || dy || dz || dt || dw ||
 284                     (buttons != sc->sc_status.button)) {
 285
 286                         DPRINTFN(6, "x:%d y:%d z:%d t:%d w:%d buttons:0x%08x\n",
 287                             dx, dy, dz, dt, dw, buttons);
 288
 289                         /* translate T-axis into button presses until further */
 290                         if (dt > 0)
 291                                 buttons |= 1UL << 3;
 292                         else if (dt < 0)
 293                                 buttons |= 1UL << 4;
 294
 295                         sc->sc_status.button = buttons;
 296                         sc->sc_status.dx += dx;
 297                         sc->sc_status.dy += dy;
 298                         sc->sc_status.dz += dz;
 299                         /*
 300                          * sc->sc_status.dt += dt;
 301                          * no way to export this yet
 302                          */
 303
 304                         /*
 305                          * The Qtronix keyboard has a built in PS/2
 306                          * port for a mouse.  The firmware once in a
 307                          * while posts a spurious button up
 308                          * event. This event we ignore by doing a
 309                          * timeout for 50 msecs.  If we receive
 310                          * dx=dy=dz=buttons=0 before we add the event
 311                          * to the queue.  In any other case we delete
 312                          * the timeout event.
 313                          */
 314                         if ((sc->sc_info[0].sc_flags & UMS_FLAG_SBU) &&
 315                             (dx == 0) && (dy == 0) && (dz == 0) && (dt == 0) &&
 316                             (dw == 0) && (buttons == 0)) {
 317
 318                                 usb_callout_reset(&sc->sc_callout, hz / 20,
 319                                     &ums_put_queue_timeout, sc);
 320                         } else {
 321
 322                                 usb_callout_stop(&sc->sc_callout);
 323
 324                                 ums_put_queue(sc, dx, dy, dz, dt, buttons);
 325                         }
 326                 }
 327         case USB_ST_SETUP:
 328 tr_setup:
 329                 /* check if we can put more data into the FIFO */
 330                 if (usb_fifo_put_bytes_max(
 331                     sc->sc_fifo.fp[USB_FIFO_RX]) != 0) {
 332                         usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 333                         usbd_transfer_submit(xfer);
 334                 }
 335                 break;
 336
 337         default:                        /* Error */
 338                 if (error != USB_ERR_CANCELLED) {
 339                         /* try clear stall first */
 340                         usbd_xfer_set_stall(xfer);
 341                         goto tr_setup;
 342                 }
 343                 break;
 344         }
 345 }
 346
 347 static const struct usb_config ums_config[UMS_N_TRANSFER] = {
 348
 349         [UMS_INTR_DT] = {
 350                 .type = UE_INTERRUPT,
 351                 .endpoint = UE_ADDR_ANY,
 352                 .direction = UE_DIR_IN,
 353                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 354                 .bufsize = 0,   /* use wMaxPacketSize */
 355                 .callback = &ums_intr_callback,
 356         },
 357 };
 358
 359 static int
 360 ums_probe(device_t dev)
 361 {
 362         struct usb_attach_arg *uaa = device_get_ivars(dev);
 363         void *d_ptr;
 364         int error;
 365         uint16_t d_len;
 366
 367         DPRINTFN(11, "\n");
 368
 369         if (uaa->usb_mode != USB_MODE_HOST)
 370                 return (ENXIO);
 371
 372         if (uaa->info.bInterfaceClass != UICLASS_HID)
 373                 return (ENXIO);
 374
 375         if ((uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
 376             (uaa->info.bInterfaceProtocol == UIPROTO_MOUSE))
 377                 return (BUS_PROBE_GENERIC);
 378
 379         error = usbd_req_get_hid_desc(uaa->device, NULL,
 380             &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex);
 381
 382         if (error)
 383                 return (ENXIO);
 384
 385         if (hid_is_collection(d_ptr, d_len,
 386             HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
 387                 error = BUS_PROBE_GENERIC;
 388         else
 389                 error = ENXIO;
 390
 391         free(d_ptr, M_TEMP);
 392         return (error);
 393 }
 394
 395 static void
 396 ums_hid_parse(struct ums_softc *sc, device_t dev, const uint8_t *buf,
 397     uint16_t len, uint8_t index)
 398 {
 399         struct ums_info *info = &sc->sc_info[index];
 400         uint32_t flags;
 401         uint8_t i;
 402         uint8_t j;
 403
 404         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 405             hid_input, index, &info->sc_loc_x, &flags, &info->sc_iid_x)) {
 406
 407                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 408                         info->sc_flags |= UMS_FLAG_X_AXIS;
 409                 }
 410         }
 411         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 412             hid_input, index, &info->sc_loc_y, &flags, &info->sc_iid_y)) {
 413
 414                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 415                         info->sc_flags |= UMS_FLAG_Y_AXIS;
 416                 }
 417         }
 418         /* Try the wheel first as the Z activator since it's tradition. */
 419         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 420             HUG_WHEEL), hid_input, index, &info->sc_loc_z, &flags,
 421             &info->sc_iid_z) ||
 422             hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 423             HUG_TWHEEL), hid_input, index, &info->sc_loc_z, &flags,
 424             &info->sc_iid_z)) {
 425                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 426                         info->sc_flags |= UMS_FLAG_Z_AXIS;
 427                 }
 428                 /*
 429                  * We might have both a wheel and Z direction, if so put
 430                  * put the Z on the W coordinate.
 431                  */
 432                 if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 433                     HUG_Z), hid_input, index, &info->sc_loc_w, &flags,
 434                     &info->sc_iid_w)) {
 435
 436                         if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 437                                 info->sc_flags |= UMS_FLAG_W_AXIS;
 438                         }
 439                 }
 440         } else if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 441             HUG_Z), hid_input, index, &info->sc_loc_z, &flags,
 442             &info->sc_iid_z)) {
 443
 444                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 445                         info->sc_flags |= UMS_FLAG_Z_AXIS;
 446                 }
 447         }
 448         /*
 449          * The Microsoft Wireless Intellimouse 2.0 reports it's wheel
 450          * using 0x0048, which is HUG_TWHEEL, and seems to expect you
 451          * to know that the byte after the wheel is the tilt axis.
 452          * There are no other HID axis descriptors other than X,Y and
 453          * TWHEEL
 454          */
 455         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 456             HUG_TWHEEL), hid_input, index, &info->sc_loc_t,
 457             &flags, &info->sc_iid_t)) {
 458
 459                 info->sc_loc_t.pos += 8;
 460
 461                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 462                         info->sc_flags |= UMS_FLAG_T_AXIS;
 463                 }
 464         } else if (hid_locate(buf, len, HID_USAGE2(HUP_CONSUMER,
 465                 HUC_AC_PAN), hid_input, index, &info->sc_loc_t,
 466                 &flags, &info->sc_iid_t)) {
 467
 468                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS)
 469                         info->sc_flags |= UMS_FLAG_T_AXIS;
 470         }
 471         /* figure out the number of buttons */
 472
 473         for (i = 0; i < UMS_BUTTON_MAX; i++) {
 474                 if (!hid_locate(buf, len, HID_USAGE2(HUP_BUTTON, (i + 1)),
 475                     hid_input, index, &info->sc_loc_btn[i], NULL,
 476                     &info->sc_iid_btn[i])) {
 477                         break;
 478                 }
 479         }
 480
 481         /* detect other buttons */
 482
 483         for (j = 0; (i < UMS_BUTTON_MAX) && (j < 2); i++, j++) {
 484                 if (!hid_locate(buf, len, HID_USAGE2(HUP_MICROSOFT, (j + 1)),
 485                     hid_input, index, &info->sc_loc_btn[i], NULL,
 486                     &info->sc_iid_btn[i])) {
 487                         break;
 488                 }
 489         }
 490
 491         info->sc_buttons = i;
 492
 493         if (i > sc->sc_buttons)
 494                 sc->sc_buttons = i;
 495
 496         if (info->sc_flags == 0)
 497                 return;
 498
 499         /* announce information about the mouse */
 500         device_printf(dev, "%d buttons and [%s%s%s%s%s] coordinates ID=%u\n",
 501             (info->sc_buttons),
 502             (info->sc_flags & UMS_FLAG_X_AXIS) ? "X" : "",
 503             (info->sc_flags & UMS_FLAG_Y_AXIS) ? "Y" : "",
 504             (info->sc_flags & UMS_FLAG_Z_AXIS) ? "Z" : "",
 505             (info->sc_flags & UMS_FLAG_T_AXIS) ? "T" : "",
 506             (info->sc_flags & UMS_FLAG_W_AXIS) ? "W" : "",
 507             info->sc_iid_x);
 508 }
 509
 510 static int
 511 ums_attach(device_t dev)
 512 {
 513         struct usb_attach_arg *uaa = device_get_ivars(dev);
 514         struct ums_softc *sc = device_get_softc(dev);
 515         struct ums_info *info;
 516         void *d_ptr = NULL;
 517         int isize;
 518         int err;
 519         uint16_t d_len;
 520         uint8_t i;
 521 #ifdef USB_DEBUG
 522         uint8_t j;
 523 #endif
 524
 525         DPRINTFN(11, "sc=%p\n", sc);
 526
 527         device_set_usb_desc(dev);
 528
 529         mtx_init(&sc->sc_mtx, "ums lock", NULL, MTX_DEF | MTX_RECURSE);
 530
 531         usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
 532
 533         /*
 534          * Force the report (non-boot) protocol.
 535          *
 536          * Mice without boot protocol support may choose not to implement
 537          * Set_Protocol at all; Ignore any error.
 538          */
 539         err = usbd_req_set_protocol(uaa->device, NULL,
 540             uaa->info.bIfaceIndex, 1);
 541
 542         err = usbd_transfer_setup(uaa->device,
 543             &uaa->info.bIfaceIndex, sc->sc_xfer, ums_config,
 544             UMS_N_TRANSFER, sc, &sc->sc_mtx);
 545
 546         if (err) {
 547                 DPRINTF("error=%s\n", usbd_errstr(err));
 548                 goto detach;
 549         }
 550
 551         /* Get HID descriptor */
 552         err = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
 553             &d_len, M_TEMP, uaa->info.bIfaceIndex);
 554
 555         if (err) {
 556                 device_printf(dev, "error reading report description\n");
 557                 goto detach;
 558         }
 559
 560         isize = hid_report_size(d_ptr, d_len, hid_input, &sc->sc_iid);
 561
 562         /*
 563          * The Microsoft Wireless Notebook Optical Mouse seems to be in worse
 564          * shape than the Wireless Intellimouse 2.0, as its X, Y, wheel, and
 565          * all of its other button positions are all off. It also reports that
 566          * it has two addional buttons and a tilt wheel.
 567          */
 568         if (usb_test_quirk(uaa, UQ_MS_BAD_CLASS)) {
 569
 570                 sc->sc_iid = 0;
 571
 572                 info = &sc->sc_info[0];
 573                 info->sc_flags = (UMS_FLAG_X_AXIS |
 574                     UMS_FLAG_Y_AXIS |
 575                     UMS_FLAG_Z_AXIS |
 576                     UMS_FLAG_SBU);
 577                 info->sc_buttons = 3;
 578                 isize = 5;
 579                 /* 1st byte of descriptor report contains garbage */
 580                 info->sc_loc_x.pos = 16;
 581                 info->sc_loc_x.size = 8;
 582                 info->sc_loc_y.pos = 24;
 583                 info->sc_loc_y.size = 8;
 584                 info->sc_loc_z.pos = 32;
 585                 info->sc_loc_z.size = 8;
 586                 info->sc_loc_btn[0].pos = 8;
 587                 info->sc_loc_btn[0].size = 1;
 588                 info->sc_loc_btn[1].pos = 9;
 589                 info->sc_loc_btn[1].size = 1;
 590                 info->sc_loc_btn[2].pos = 10;
 591                 info->sc_loc_btn[2].size = 1;
 592
 593                 /* Announce device */
 594                 device_printf(dev, "3 buttons and [XYZ] "
 595                     "coordinates ID=0\n");
 596
 597         } else {
 598                 /* Search the HID descriptor and announce device */
 599                 for (i = 0; i < UMS_INFO_MAX; i++) {
 600                         ums_hid_parse(sc, dev, d_ptr, d_len, i);
 601                 }
 602         }
 603
 604         if (usb_test_quirk(uaa, UQ_MS_REVZ)) {
 605                 info = &sc->sc_info[0];
 606                 /* Some wheels need the Z axis reversed. */
 607                 info->sc_flags |= UMS_FLAG_REVZ;
 608         }
 609         if (isize > usbd_xfer_max_framelen(sc->sc_xfer[UMS_INTR_DT])) {
 610                 DPRINTF("WARNING: report size, %d bytes, is larger "
 611                     "than interrupt size, %d bytes!\n", isize,
 612                     usbd_xfer_max_framelen(sc->sc_xfer[UMS_INTR_DT]));
 613         }
 614         free(d_ptr, M_TEMP);
 615         d_ptr = NULL;
 616
 617 #ifdef USB_DEBUG
 618         for (j = 0; j < UMS_INFO_MAX; j++) {
 619                 info = &sc->sc_info[j];
 620
 621                 DPRINTF("sc=%p, index=%d\n", sc, j);
 622                 DPRINTF("X\t%d/%d id=%d\n", info->sc_loc_x.pos,
 623                     info->sc_loc_x.size, info->sc_iid_x);
 624                 DPRINTF("Y\t%d/%d id=%d\n", info->sc_loc_y.pos,
 625                     info->sc_loc_y.size, info->sc_iid_y);
 626                 DPRINTF("Z\t%d/%d id=%d\n", info->sc_loc_z.pos,
 627                     info->sc_loc_z.size, info->sc_iid_z);
 628                 DPRINTF("T\t%d/%d id=%d\n", info->sc_loc_t.pos,
 629                     info->sc_loc_t.size, info->sc_iid_t);
 630                 DPRINTF("W\t%d/%d id=%d\n", info->sc_loc_w.pos,
 631                     info->sc_loc_w.size, info->sc_iid_w);
 632
 633                 for (i = 0; i < info->sc_buttons; i++) {
 634                         DPRINTF("B%d\t%d/%d id=%d\n",
 635                             i + 1, info->sc_loc_btn[i].pos,
 636                             info->sc_loc_btn[i].size, info->sc_iid_btn[i]);
 637                 }
 638         }
 639         DPRINTF("size=%d, id=%d\n", isize, sc->sc_iid);
 640 #endif
 641
 642         if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 643                 sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 644         else
 645                 sc->sc_hw.buttons = sc->sc_buttons;
 646
 647         sc->sc_hw.iftype = MOUSE_IF_USB;
 648         sc->sc_hw.type = MOUSE_MOUSE;
 649         sc->sc_hw.model = MOUSE_MODEL_GENERIC;
 650         sc->sc_hw.hwid = 0;
 651
 652         sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 653         sc->sc_mode.rate = -1;
 654         sc->sc_mode.resolution = MOUSE_RES_UNKNOWN;
 655         sc->sc_mode.accelfactor = 0;
 656         sc->sc_mode.level = 0;
 657         sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 658         sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 659         sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 660
 661         err = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx,
 662             &ums_fifo_methods, &sc->sc_fifo,
 663             device_get_unit(dev), 0 - 1, uaa->info.bIfaceIndex,
 664             UID_ROOT, GID_OPERATOR, 0644);
 665         if (err) {
 666                 goto detach;
 667         }
 668         SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
 669             SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
 670             OID_AUTO, "parseinfo", CTLTYPE_STRING|CTLFLAG_RD,
 671             sc, 0, ums_sysctl_handler_parseinfo,
 672             "", "Dump of parsed HID report descriptor");
 673
 674         return (0);
 675
 676 detach:
 677         if (d_ptr) {
 678                 free(d_ptr, M_TEMP);
 679         }
 680         ums_detach(dev);
 681         return (ENOMEM);
 682 }
 683
 684 static int
 685 ums_detach(device_t self)
 686 {
 687         struct ums_softc *sc = device_get_softc(self);
 688
 689         DPRINTF("sc=%p\n", sc);
 690
 691         usb_fifo_detach(&sc->sc_fifo);
 692
 693         usbd_transfer_unsetup(sc->sc_xfer, UMS_N_TRANSFER);
 694
 695         usb_callout_drain(&sc->sc_callout);
 696
 697         mtx_destroy(&sc->sc_mtx);
 698
 699         return (0);
 700 }
 701
 702 static void
 703 ums_start_read(struct usb_fifo *fifo)
 704 {
 705         struct ums_softc *sc = usb_fifo_softc(fifo);
 706         int rate;
 707
 708         /* Check if we should override the default polling interval */
 709         rate = sc->sc_pollrate;
 710         /* Range check rate */
 711         if (rate > 1000)
 712                 rate = 1000;
 713         /* Check for set rate */
 714         if ((rate > 0) && (sc->sc_xfer[UMS_INTR_DT] != NULL)) {
 715                 DPRINTF("Setting pollrate = %d\n", rate);
 716                 /* Stop current transfer, if any */
 717                 usbd_transfer_stop(sc->sc_xfer[UMS_INTR_DT]);
 718                 /* Set new interval */
 719                 usbd_xfer_set_interval(sc->sc_xfer[UMS_INTR_DT], 1000 / rate);
 720                 /* Only set pollrate once */
 721                 sc->sc_pollrate = 0;
 722         }
 723
 724         usbd_transfer_start(sc->sc_xfer[UMS_INTR_DT]);
 725 }
 726
 727 static void
 728 ums_stop_read(struct usb_fifo *fifo)
 729 {
 730         struct ums_softc *sc = usb_fifo_softc(fifo);
 731
 732         usbd_transfer_stop(sc->sc_xfer[UMS_INTR_DT]);
 733         usb_callout_stop(&sc->sc_callout);
 734 }
 735
 736
 737 #if ((MOUSE_SYS_PACKETSIZE != 8) || \
 738      (MOUSE_MSC_PACKETSIZE != 5))
 739 #error "Software assumptions are not met. Please update code."
 740 #endif
 741
 742 static void
 743 ums_put_queue(struct ums_softc *sc, int32_t dx, int32_t dy,
 744     int32_t dz, int32_t dt, int32_t buttons)
 745 {
 746         uint8_t buf[8];
 747
 748         if (1) {
 749
 750                 if (dx > 254)
 751                         dx = 254;
 752                 if (dx < -256)
 753                         dx = -256;
 754                 if (dy > 254)
 755                         dy = 254;
 756                 if (dy < -256)
 757                         dy = -256;
 758                 if (dz > 126)
 759                         dz = 126;
 760                 if (dz < -128)
 761                         dz = -128;
 762                 if (dt > 126)
 763                         dt = 126;
 764                 if (dt < -128)
 765                         dt = -128;
 766
 767                 buf[0] = sc->sc_mode.syncmask[1];
 768                 buf[0] |= (~buttons) & MOUSE_MSC_BUTTONS;
 769                 buf[1] = dx >> 1;
 770                 buf[2] = dy >> 1;
 771                 buf[3] = dx - (dx >> 1);
 772                 buf[4] = dy - (dy >> 1);
 773
 774                 if (sc->sc_mode.level == 1) {
 775                         buf[5] = dz >> 1;
 776                         buf[6] = dz - (dz >> 1);
 777                         buf[7] = (((~buttons) >> 3) & MOUSE_SYS_EXTBUTTONS);
 778                 }
 779                 usb_fifo_put_data_linear(sc->sc_fifo.fp[USB_FIFO_RX], buf,
 780                     sc->sc_mode.packetsize, 1);
 781
 782         } else {
 783                 DPRINTF("Buffer full, discarded packet\n");
 784         }
 785 }
 786
 787 static void
 788 ums_reset_buf(struct ums_softc *sc)
 789 {
 790         /* reset read queue */
 791         usb_fifo_reset(sc->sc_fifo.fp[USB_FIFO_RX]);
 792 }
 793
 794 static int
 795 ums_open(struct usb_fifo *fifo, int fflags)
 796 {
 797         struct ums_softc *sc = usb_fifo_softc(fifo);
 798
 799         DPRINTFN(2, "\n");
 800
 801         if (fflags & FREAD) {
 802
 803                 /* reset status */
 804
 805                 sc->sc_status.flags = 0;
 806                 sc->sc_status.button = 0;
 807                 sc->sc_status.obutton = 0;
 808                 sc->sc_status.dx = 0;
 809                 sc->sc_status.dy = 0;
 810                 sc->sc_status.dz = 0;
 811                 /* sc->sc_status.dt = 0; */
 812
 813                 if (usb_fifo_alloc_buffer(fifo,
 814                     UMS_BUF_SIZE, UMS_IFQ_MAXLEN)) {
 815                         return (ENOMEM);
 816                 }
 817         }
 818         return (0);
 819 }
 820
 821 static void
 822 ums_close(struct usb_fifo *fifo, int fflags)
 823 {
 824         if (fflags & FREAD) {
 825                 usb_fifo_free_buffer(fifo);
 826         }
 827 }
 828
 829 static int
 830 ums_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
 831 {
 832         struct ums_softc *sc = usb_fifo_softc(fifo);
 833         mousemode_t mode;
 834         int error = 0;
 835
 836         DPRINTFN(2, "\n");
 837
 838         mtx_lock(&sc->sc_mtx);
 839
 840         switch (cmd) {
 841         case MOUSE_GETHWINFO:
 842                 *(mousehw_t *)addr = sc->sc_hw;
 843                 break;
 844
 845         case MOUSE_GETMODE:
 846                 *(mousemode_t *)addr = sc->sc_mode;
 847                 break;
 848
 849         case MOUSE_SETMODE:
 850                 mode = *(mousemode_t *)addr;
 851
 852                 if (mode.level == -1) {
 853                         /* don't change the current setting */
 854                 } else if ((mode.level < 0) || (mode.level > 1)) {
 855                         error = EINVAL;
 856                         goto done;
 857                 } else {
 858                         sc->sc_mode.level = mode.level;
 859                 }
 860
 861                 /* store polling rate */
 862                 sc->sc_pollrate = mode.rate;
 863
 864                 if (sc->sc_mode.level == 0) {
 865                         if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 866                                 sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 867                         else
 868                                 sc->sc_hw.buttons = sc->sc_buttons;
 869                         sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 870                         sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 871                         sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 872                         sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 873                 } else if (sc->sc_mode.level == 1) {
 874                         if (sc->sc_buttons > MOUSE_SYS_MAXBUTTON)
 875                                 sc->sc_hw.buttons = MOUSE_SYS_MAXBUTTON;
 876                         else
 877                                 sc->sc_hw.buttons = sc->sc_buttons;
 878                         sc->sc_mode.protocol = MOUSE_PROTO_SYSMOUSE;
 879                         sc->sc_mode.packetsize = MOUSE_SYS_PACKETSIZE;
 880                         sc->sc_mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 881                         sc->sc_mode.syncmask[1] = MOUSE_SYS_SYNC;
 882                 }
 883                 ums_reset_buf(sc);
 884                 break;
 885
 886         case MOUSE_GETLEVEL:
 887                 *(int *)addr = sc->sc_mode.level;
 888                 break;
 889
 890         case MOUSE_SETLEVEL:
 891                 if (*(int *)addr < 0 || *(int *)addr > 1) {
 892                         error = EINVAL;
 893                         goto done;
 894                 }
 895                 sc->sc_mode.level = *(int *)addr;
 896
 897                 if (sc->sc_mode.level == 0) {
 898                         if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 899                                 sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 900                         else
 901                                 sc->sc_hw.buttons = sc->sc_buttons;
 902                         sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 903                         sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 904                         sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 905                         sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 906                 } else if (sc->sc_mode.level == 1) {
 907                         if (sc->sc_buttons > MOUSE_SYS_MAXBUTTON)
 908                                 sc->sc_hw.buttons = MOUSE_SYS_MAXBUTTON;
 909                         else
 910                                 sc->sc_hw.buttons = sc->sc_buttons;
 911                         sc->sc_mode.protocol = MOUSE_PROTO_SYSMOUSE;
 912                         sc->sc_mode.packetsize = MOUSE_SYS_PACKETSIZE;
 913                         sc->sc_mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 914                         sc->sc_mode.syncmask[1] = MOUSE_SYS_SYNC;
 915                 }
 916                 ums_reset_buf(sc);
 917                 break;
 918
 919         case MOUSE_GETSTATUS:{
 920                         mousestatus_t *status = (mousestatus_t *)addr;
 921
 922                         *status = sc->sc_status;
 923                         sc->sc_status.obutton = sc->sc_status.button;
 924                         sc->sc_status.button = 0;
 925                         sc->sc_status.dx = 0;
 926                         sc->sc_status.dy = 0;
 927                         sc->sc_status.dz = 0;
 928                         /* sc->sc_status.dt = 0; */
 929
 930                         if (status->dx || status->dy || status->dz /* || status->dt */ ) {
 931                                 status->flags |= MOUSE_POSCHANGED;
 932                         }
 933                         if (status->button != status->obutton) {
 934                                 status->flags |= MOUSE_BUTTONSCHANGED;
 935                         }
 936                         break;
 937                 }
 938         default:
 939                 error = ENOTTY;
 940         }
 941
 942 done:
 943         mtx_unlock(&sc->sc_mtx);
 944         return (error);
 945 }
 946
 947 static int
 948 ums_sysctl_handler_parseinfo(SYSCTL_HANDLER_ARGS)
 949 {
 950         struct ums_softc *sc = arg1;
 951         struct ums_info *info;
 952         struct sbuf *sb;
 953         int i, j, err, had_output;
 954
 955         sb = sbuf_new_auto();
 956         for (i = 0, had_output = 0; i < UMS_INFO_MAX; i++) {
 957                 info = &sc->sc_info[i];
 958
 959                 /* Don't emit empty info */
 960                 if ((info->sc_flags &
 961                     (UMS_FLAG_X_AXIS | UMS_FLAG_Y_AXIS | UMS_FLAG_Z_AXIS |
 962                      UMS_FLAG_T_AXIS | UMS_FLAG_W_AXIS)) == 0 &&
 963                     info->sc_buttons == 0)
 964                         continue;
 965
 966                 if (had_output)
 967                         sbuf_printf(sb, "\n");
 968                 had_output = 1;
 969                 sbuf_printf(sb, "i%d:", i + 1);
 970                 if (info->sc_flags & UMS_FLAG_X_AXIS)
 971                         sbuf_printf(sb, " X:r%d, p%d, s%d;",
 972                             (int)info->sc_iid_x,
 973                             (int)info->sc_loc_x.pos,
 974                             (int)info->sc_loc_x.size);
 975                 if (info->sc_flags & UMS_FLAG_Y_AXIS)
 976                         sbuf_printf(sb, " Y:r%d, p%d, s%d;",
 977                             (int)info->sc_iid_y,
 978                             (int)info->sc_loc_y.pos,
 979                             (int)info->sc_loc_y.size);
 980                 if (info->sc_flags & UMS_FLAG_Z_AXIS)
 981                         sbuf_printf(sb, " Z:r%d, p%d, s%d;",
 982                             (int)info->sc_iid_z,
 983                             (int)info->sc_loc_z.pos,
 984                             (int)info->sc_loc_z.size);
 985                 if (info->sc_flags & UMS_FLAG_T_AXIS)
 986                         sbuf_printf(sb, " T:r%d, p%d, s%d;",
 987                             (int)info->sc_iid_t,
 988                             (int)info->sc_loc_t.pos,
 989                             (int)info->sc_loc_t.size);
 990                 if (info->sc_flags & UMS_FLAG_W_AXIS)
 991                         sbuf_printf(sb, " W:r%d, p%d, s%d;",
 992                             (int)info->sc_iid_w,
 993                             (int)info->sc_loc_w.pos,
 994                             (int)info->sc_loc_w.size);
 995
 996                 for (j = 0; j < info->sc_buttons; j++) {
 997                         sbuf_printf(sb, " B%d:r%d, p%d, s%d;", j + 1,
 998                             (int)info->sc_iid_btn[j],
 999                             (int)info->sc_loc_btn[j].pos,
1000                             (int)info->sc_loc_btn[j].size);
1001                 }
1002         }
1003         sbuf_finish(sb);
1004         err = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
1005         sbuf_delete(sb);
1006
1007         return (err);
1008 }
1009
1010 static devclass_t ums_devclass;
1011
1012 static device_method_t ums_methods[] = {
1013         DEVMETHOD(device_probe, ums_probe),
1014         DEVMETHOD(device_attach, ums_attach),
1015         DEVMETHOD(device_detach, ums_detach),
1016         {0, 0}
1017 };
1018
1019 static driver_t ums_driver = {
1020         .name = "ums",
1021         .methods = ums_methods,
1022         .size = sizeof(struct ums_softc),
1023 };
1024
1025 DRIVER_MODULE(ums, uhub, ums_driver, ums_devclass, NULL, 0);
1026 MODULE_DEPEND(ums, usb, 1, 1, 1);
1027 MODULE_VERSION(ums, 1);