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/module.h>
  47 #include <sys/lock.h>
  48 #include <sys/mutex.h>
  49 #include <sys/condvar.h>
  50 #include <sys/sysctl.h>
  51 #include <sys/sx.h>
  52 #include <sys/unistd.h>
  53 #include <sys/callout.h>
  54 #include <sys/malloc.h>
  55 #include <sys/priv.h>
  56 #include <sys/conf.h>
  57 #include <sys/fcntl.h>
  58 #include <sys/sbuf.h>
  59
  60 #include <dev/usb/usb.h>
  61 #include <dev/usb/usbdi.h>
  62 #include <dev/usb/usbdi_util.h>
  63 #include <dev/usb/usbhid.h>
  64 #include "usbdevs.h"
  65
  66 #define USB_DEBUG_VAR ums_debug
  67 #include <dev/usb/usb_debug.h>
  68
  69 #include <dev/usb/quirk/usb_quirk.h>
  70
  71 #include <sys/ioccom.h>
  72 #include <sys/filio.h>
  73 #include <sys/tty.h>
  74 #include <sys/mouse.h>
  75
  76 #ifdef USB_DEBUG
  77 static int ums_debug = 0;
  78
  79 SYSCTL_NODE(_hw_usb, OID_AUTO, ums, CTLFLAG_RW, 0, "USB ums");
  80 SYSCTL_INT(_hw_usb_ums, OID_AUTO, debug, CTLFLAG_RW,
  81     &ums_debug, 0, "Debug level");
  82 #endif
  83
  84 #define MOUSE_FLAGS_MASK (HIO_CONST|HIO_RELATIVE)
  85 #define MOUSE_FLAGS (HIO_RELATIVE)
  86
  87 #define UMS_BUF_SIZE      8             /* bytes */
  88 #define UMS_IFQ_MAXLEN   50             /* units */
  89 #define UMS_BUTTON_MAX   31             /* exclusive, must be less than 32 */
  90 #define UMS_BUT(i) ((i) < 3 ? (((i) + 2) % 3) : (i))
  91 #define UMS_INFO_MAX      2             /* maximum number of HID sets */
  92
  93 enum {
  94         UMS_INTR_DT,
  95         UMS_N_TRANSFER,
  96 };
  97
  98 struct ums_info {
  99         struct hid_location sc_loc_w;
 100         struct hid_location sc_loc_x;
 101         struct hid_location sc_loc_y;
 102         struct hid_location sc_loc_z;
 103         struct hid_location sc_loc_t;
 104         struct hid_location sc_loc_btn[UMS_BUTTON_MAX];
 105
 106         uint32_t sc_flags;
 107 #define UMS_FLAG_X_AXIS     0x0001
 108 #define UMS_FLAG_Y_AXIS     0x0002
 109 #define UMS_FLAG_Z_AXIS     0x0004
 110 #define UMS_FLAG_T_AXIS     0x0008
 111 #define UMS_FLAG_SBU        0x0010      /* spurious button up events */
 112 #define UMS_FLAG_REVZ       0x0020      /* Z-axis is reversed */
 113 #define UMS_FLAG_W_AXIS     0x0040
 114
 115         uint8_t sc_iid_w;
 116         uint8_t sc_iid_x;
 117         uint8_t sc_iid_y;
 118         uint8_t sc_iid_z;
 119         uint8_t sc_iid_t;
 120         uint8_t sc_iid_btn[UMS_BUTTON_MAX];
 121         uint8_t sc_buttons;
 122 };
 123
 124 struct ums_softc {
 125         struct usb_fifo_sc sc_fifo;
 126         struct mtx sc_mtx;
 127         struct usb_callout sc_callout;
 128         struct ums_info sc_info[UMS_INFO_MAX];
 129
 130         mousehw_t sc_hw;
 131         mousemode_t sc_mode;
 132         mousestatus_t sc_status;
 133
 134         struct usb_xfer *sc_xfer[UMS_N_TRANSFER];
 135
 136         int sc_pollrate;
 137         int sc_fflags;
 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 > (int)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 << 5;
 292                         else if (dt < 0)
 293                                 buttons |= 1UL << 6;
 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 /* A match on these entries will load ums */
 360 static const STRUCT_USB_HOST_ID __used ums_devs[] = {
 361         {USB_IFACE_CLASS(UICLASS_HID),
 362          USB_IFACE_SUBCLASS(UISUBCLASS_BOOT),
 363          USB_IFACE_PROTOCOL(UIPROTO_MOUSE),},
 364 };
 365
 366 static int
 367 ums_probe(device_t dev)
 368 {
 369         struct usb_attach_arg *uaa = device_get_ivars(dev);
 370         void *d_ptr;
 371         int error;
 372         uint16_t d_len;
 373
 374         DPRINTFN(11, "\n");
 375
 376         if (uaa->usb_mode != USB_MODE_HOST)
 377                 return (ENXIO);
 378
 379         if (uaa->info.bInterfaceClass != UICLASS_HID)
 380                 return (ENXIO);
 381
 382         if (usb_test_quirk(uaa, UQ_UMS_IGNORE))
 383                 return (ENXIO);
 384
 385         if ((uaa->info.bInterfaceSubClass == UISUBCLASS_BOOT) &&
 386             (uaa->info.bInterfaceProtocol == UIPROTO_MOUSE))
 387                 return (BUS_PROBE_DEFAULT);
 388
 389         error = usbd_req_get_hid_desc(uaa->device, NULL,
 390             &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex);
 391
 392         if (error)
 393                 return (ENXIO);
 394
 395         if (hid_is_collection(d_ptr, d_len,
 396             HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE)))
 397                 error = BUS_PROBE_DEFAULT;
 398         else
 399                 error = ENXIO;
 400
 401         free(d_ptr, M_TEMP);
 402         return (error);
 403 }
 404
 405 static void
 406 ums_hid_parse(struct ums_softc *sc, device_t dev, const uint8_t *buf,
 407     uint16_t len, uint8_t index)
 408 {
 409         struct ums_info *info = &sc->sc_info[index];
 410         uint32_t flags;
 411         uint8_t i;
 412         uint8_t j;
 413
 414         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X),
 415             hid_input, index, &info->sc_loc_x, &flags, &info->sc_iid_x)) {
 416
 417                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 418                         info->sc_flags |= UMS_FLAG_X_AXIS;
 419                 }
 420         }
 421         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y),
 422             hid_input, index, &info->sc_loc_y, &flags, &info->sc_iid_y)) {
 423
 424                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 425                         info->sc_flags |= UMS_FLAG_Y_AXIS;
 426                 }
 427         }
 428         /* Try the wheel first as the Z activator since it's tradition. */
 429         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 430             HUG_WHEEL), hid_input, index, &info->sc_loc_z, &flags,
 431             &info->sc_iid_z) ||
 432             hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 433             HUG_TWHEEL), hid_input, index, &info->sc_loc_z, &flags,
 434             &info->sc_iid_z)) {
 435                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 436                         info->sc_flags |= UMS_FLAG_Z_AXIS;
 437                 }
 438                 /*
 439                  * We might have both a wheel and Z direction, if so put
 440                  * put the Z on the W coordinate.
 441                  */
 442                 if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 443                     HUG_Z), hid_input, index, &info->sc_loc_w, &flags,
 444                     &info->sc_iid_w)) {
 445
 446                         if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 447                                 info->sc_flags |= UMS_FLAG_W_AXIS;
 448                         }
 449                 }
 450         } else if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 451             HUG_Z), hid_input, index, &info->sc_loc_z, &flags,
 452             &info->sc_iid_z)) {
 453
 454                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 455                         info->sc_flags |= UMS_FLAG_Z_AXIS;
 456                 }
 457         }
 458         /*
 459          * The Microsoft Wireless Intellimouse 2.0 reports it's wheel
 460          * using 0x0048, which is HUG_TWHEEL, and seems to expect you
 461          * to know that the byte after the wheel is the tilt axis.
 462          * There are no other HID axis descriptors other than X,Y and
 463          * TWHEEL
 464          */
 465         if (hid_locate(buf, len, HID_USAGE2(HUP_GENERIC_DESKTOP,
 466             HUG_TWHEEL), hid_input, index, &info->sc_loc_t,
 467             &flags, &info->sc_iid_t)) {
 468
 469                 info->sc_loc_t.pos += 8;
 470
 471                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS) {
 472                         info->sc_flags |= UMS_FLAG_T_AXIS;
 473                 }
 474         } else if (hid_locate(buf, len, HID_USAGE2(HUP_CONSUMER,
 475                 HUC_AC_PAN), hid_input, index, &info->sc_loc_t,
 476                 &flags, &info->sc_iid_t)) {
 477
 478                 if ((flags & MOUSE_FLAGS_MASK) == MOUSE_FLAGS)
 479                         info->sc_flags |= UMS_FLAG_T_AXIS;
 480         }
 481         /* figure out the number of buttons */
 482
 483         for (i = 0; i < UMS_BUTTON_MAX; i++) {
 484                 if (!hid_locate(buf, len, HID_USAGE2(HUP_BUTTON, (i + 1)),
 485                     hid_input, index, &info->sc_loc_btn[i], NULL,
 486                     &info->sc_iid_btn[i])) {
 487                         break;
 488                 }
 489         }
 490
 491         /* detect other buttons */
 492
 493         for (j = 0; (i < UMS_BUTTON_MAX) && (j < 2); i++, j++) {
 494                 if (!hid_locate(buf, len, HID_USAGE2(HUP_MICROSOFT, (j + 1)),
 495                     hid_input, index, &info->sc_loc_btn[i], NULL,
 496                     &info->sc_iid_btn[i])) {
 497                         break;
 498                 }
 499         }
 500
 501         info->sc_buttons = i;
 502
 503         if (i > sc->sc_buttons)
 504                 sc->sc_buttons = i;
 505
 506         if (info->sc_flags == 0)
 507                 return;
 508
 509         /* announce information about the mouse */
 510         device_printf(dev, "%d buttons and [%s%s%s%s%s] coordinates ID=%u\n",
 511             (info->sc_buttons),
 512             (info->sc_flags & UMS_FLAG_X_AXIS) ? "X" : "",
 513             (info->sc_flags & UMS_FLAG_Y_AXIS) ? "Y" : "",
 514             (info->sc_flags & UMS_FLAG_Z_AXIS) ? "Z" : "",
 515             (info->sc_flags & UMS_FLAG_T_AXIS) ? "T" : "",
 516             (info->sc_flags & UMS_FLAG_W_AXIS) ? "W" : "",
 517             info->sc_iid_x);
 518 }
 519
 520 static int
 521 ums_attach(device_t dev)
 522 {
 523         struct usb_attach_arg *uaa = device_get_ivars(dev);
 524         struct ums_softc *sc = device_get_softc(dev);
 525         struct ums_info *info;
 526         void *d_ptr = NULL;
 527         int isize;
 528         int err;
 529         uint16_t d_len;
 530         uint8_t i;
 531 #ifdef USB_DEBUG
 532         uint8_t j;
 533 #endif
 534
 535         DPRINTFN(11, "sc=%p\n", sc);
 536
 537         device_set_usb_desc(dev);
 538
 539         mtx_init(&sc->sc_mtx, "ums lock", NULL, MTX_DEF | MTX_RECURSE);
 540
 541         usb_callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
 542
 543         /*
 544          * Force the report (non-boot) protocol.
 545          *
 546          * Mice without boot protocol support may choose not to implement
 547          * Set_Protocol at all; Ignore any error.
 548          */
 549         err = usbd_req_set_protocol(uaa->device, NULL,
 550             uaa->info.bIfaceIndex, 1);
 551
 552         err = usbd_transfer_setup(uaa->device,
 553             &uaa->info.bIfaceIndex, sc->sc_xfer, ums_config,
 554             UMS_N_TRANSFER, sc, &sc->sc_mtx);
 555
 556         if (err) {
 557                 DPRINTF("error=%s\n", usbd_errstr(err));
 558                 goto detach;
 559         }
 560
 561         /* Get HID descriptor */
 562         err = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
 563             &d_len, M_TEMP, uaa->info.bIfaceIndex);
 564
 565         if (err) {
 566                 device_printf(dev, "error reading report description\n");
 567                 goto detach;
 568         }
 569
 570         isize = hid_report_size(d_ptr, d_len, hid_input, &sc->sc_iid);
 571
 572         /*
 573          * The Microsoft Wireless Notebook Optical Mouse seems to be in worse
 574          * shape than the Wireless Intellimouse 2.0, as its X, Y, wheel, and
 575          * all of its other button positions are all off. It also reports that
 576          * it has two addional buttons and a tilt wheel.
 577          */
 578         if (usb_test_quirk(uaa, UQ_MS_BAD_CLASS)) {
 579
 580                 sc->sc_iid = 0;
 581
 582                 info = &sc->sc_info[0];
 583                 info->sc_flags = (UMS_FLAG_X_AXIS |
 584                     UMS_FLAG_Y_AXIS |
 585                     UMS_FLAG_Z_AXIS |
 586                     UMS_FLAG_SBU);
 587                 info->sc_buttons = 3;
 588                 isize = 5;
 589                 /* 1st byte of descriptor report contains garbage */
 590                 info->sc_loc_x.pos = 16;
 591                 info->sc_loc_x.size = 8;
 592                 info->sc_loc_y.pos = 24;
 593                 info->sc_loc_y.size = 8;
 594                 info->sc_loc_z.pos = 32;
 595                 info->sc_loc_z.size = 8;
 596                 info->sc_loc_btn[0].pos = 8;
 597                 info->sc_loc_btn[0].size = 1;
 598                 info->sc_loc_btn[1].pos = 9;
 599                 info->sc_loc_btn[1].size = 1;
 600                 info->sc_loc_btn[2].pos = 10;
 601                 info->sc_loc_btn[2].size = 1;
 602
 603                 /* Announce device */
 604                 device_printf(dev, "3 buttons and [XYZ] "
 605                     "coordinates ID=0\n");
 606
 607         } else {
 608                 /* Search the HID descriptor and announce device */
 609                 for (i = 0; i < UMS_INFO_MAX; i++) {
 610                         ums_hid_parse(sc, dev, d_ptr, d_len, i);
 611                 }
 612         }
 613
 614         if (usb_test_quirk(uaa, UQ_MS_REVZ)) {
 615                 info = &sc->sc_info[0];
 616                 /* Some wheels need the Z axis reversed. */
 617                 info->sc_flags |= UMS_FLAG_REVZ;
 618         }
 619         if (isize > (int)usbd_xfer_max_framelen(sc->sc_xfer[UMS_INTR_DT])) {
 620                 DPRINTF("WARNING: report size, %d bytes, is larger "
 621                     "than interrupt size, %d bytes!\n", isize,
 622                     usbd_xfer_max_framelen(sc->sc_xfer[UMS_INTR_DT]));
 623         }
 624         free(d_ptr, M_TEMP);
 625         d_ptr = NULL;
 626
 627 #ifdef USB_DEBUG
 628         for (j = 0; j < UMS_INFO_MAX; j++) {
 629                 info = &sc->sc_info[j];
 630
 631                 DPRINTF("sc=%p, index=%d\n", sc, j);
 632                 DPRINTF("X\t%d/%d id=%d\n", info->sc_loc_x.pos,
 633                     info->sc_loc_x.size, info->sc_iid_x);
 634                 DPRINTF("Y\t%d/%d id=%d\n", info->sc_loc_y.pos,
 635                     info->sc_loc_y.size, info->sc_iid_y);
 636                 DPRINTF("Z\t%d/%d id=%d\n", info->sc_loc_z.pos,
 637                     info->sc_loc_z.size, info->sc_iid_z);
 638                 DPRINTF("T\t%d/%d id=%d\n", info->sc_loc_t.pos,
 639                     info->sc_loc_t.size, info->sc_iid_t);
 640                 DPRINTF("W\t%d/%d id=%d\n", info->sc_loc_w.pos,
 641                     info->sc_loc_w.size, info->sc_iid_w);
 642
 643                 for (i = 0; i < info->sc_buttons; i++) {
 644                         DPRINTF("B%d\t%d/%d id=%d\n",
 645                             i + 1, info->sc_loc_btn[i].pos,
 646                             info->sc_loc_btn[i].size, info->sc_iid_btn[i]);
 647                 }
 648         }
 649         DPRINTF("size=%d, id=%d\n", isize, sc->sc_iid);
 650 #endif
 651
 652         err = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx,
 653             &ums_fifo_methods, &sc->sc_fifo,
 654             device_get_unit(dev), -1, uaa->info.bIfaceIndex,
 655             UID_ROOT, GID_OPERATOR, 0644);
 656         if (err)
 657                 goto detach;
 658
 659         SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
 660             SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
 661             OID_AUTO, "parseinfo", CTLTYPE_STRING|CTLFLAG_RD,
 662             sc, 0, ums_sysctl_handler_parseinfo,
 663             "", "Dump of parsed HID report descriptor");
 664
 665         return (0);
 666
 667 detach:
 668         if (d_ptr) {
 669                 free(d_ptr, M_TEMP);
 670         }
 671         ums_detach(dev);
 672         return (ENOMEM);
 673 }
 674
 675 static int
 676 ums_detach(device_t self)
 677 {
 678         struct ums_softc *sc = device_get_softc(self);
 679
 680         DPRINTF("sc=%p\n", sc);
 681
 682         usb_fifo_detach(&sc->sc_fifo);
 683
 684         usbd_transfer_unsetup(sc->sc_xfer, UMS_N_TRANSFER);
 685
 686         usb_callout_drain(&sc->sc_callout);
 687
 688         mtx_destroy(&sc->sc_mtx);
 689
 690         return (0);
 691 }
 692
 693 static void
 694 ums_start_read(struct usb_fifo *fifo)
 695 {
 696         struct ums_softc *sc = usb_fifo_softc(fifo);
 697         int rate;
 698
 699         /* Check if we should override the default polling interval */
 700         rate = sc->sc_pollrate;
 701         /* Range check rate */
 702         if (rate > 1000)
 703                 rate = 1000;
 704         /* Check for set rate */
 705         if ((rate > 0) && (sc->sc_xfer[UMS_INTR_DT] != NULL)) {
 706                 DPRINTF("Setting pollrate = %d\n", rate);
 707                 /* Stop current transfer, if any */
 708                 usbd_transfer_stop(sc->sc_xfer[UMS_INTR_DT]);
 709                 /* Set new interval */
 710                 usbd_xfer_set_interval(sc->sc_xfer[UMS_INTR_DT], 1000 / rate);
 711                 /* Only set pollrate once */
 712                 sc->sc_pollrate = 0;
 713         }
 714
 715         usbd_transfer_start(sc->sc_xfer[UMS_INTR_DT]);
 716 }
 717
 718 static void
 719 ums_stop_read(struct usb_fifo *fifo)
 720 {
 721         struct ums_softc *sc = usb_fifo_softc(fifo);
 722
 723         usbd_transfer_stop(sc->sc_xfer[UMS_INTR_DT]);
 724         usb_callout_stop(&sc->sc_callout);
 725 }
 726
 727
 728 #if ((MOUSE_SYS_PACKETSIZE != 8) || \
 729      (MOUSE_MSC_PACKETSIZE != 5))
 730 #error "Software assumptions are not met. Please update code."
 731 #endif
 732
 733 static void
 734 ums_put_queue(struct ums_softc *sc, int32_t dx, int32_t dy,
 735     int32_t dz, int32_t dt, int32_t buttons)
 736 {
 737         uint8_t buf[8];
 738
 739         if (1) {
 740
 741                 if (dx > 254)
 742                         dx = 254;
 743                 if (dx < -256)
 744                         dx = -256;
 745                 if (dy > 254)
 746                         dy = 254;
 747                 if (dy < -256)
 748                         dy = -256;
 749                 if (dz > 126)
 750                         dz = 126;
 751                 if (dz < -128)
 752                         dz = -128;
 753                 if (dt > 126)
 754                         dt = 126;
 755                 if (dt < -128)
 756                         dt = -128;
 757
 758                 buf[0] = sc->sc_mode.syncmask[1];
 759                 buf[0] |= (~buttons) & MOUSE_MSC_BUTTONS;
 760                 buf[1] = dx >> 1;
 761                 buf[2] = dy >> 1;
 762                 buf[3] = dx - (dx >> 1);
 763                 buf[4] = dy - (dy >> 1);
 764
 765                 if (sc->sc_mode.level == 1) {
 766                         buf[5] = dz >> 1;
 767                         buf[6] = dz - (dz >> 1);
 768                         buf[7] = (((~buttons) >> 3) & MOUSE_SYS_EXTBUTTONS);
 769                 }
 770                 usb_fifo_put_data_linear(sc->sc_fifo.fp[USB_FIFO_RX], buf,
 771                     sc->sc_mode.packetsize, 1);
 772
 773         } else {
 774                 DPRINTF("Buffer full, discarded packet\n");
 775         }
 776 }
 777
 778 static void
 779 ums_reset_buf(struct ums_softc *sc)
 780 {
 781         /* reset read queue, must be called locked */
 782         usb_fifo_reset(sc->sc_fifo.fp[USB_FIFO_RX]);
 783 }
 784
 785 static int
 786 ums_open(struct usb_fifo *fifo, int fflags)
 787 {
 788         struct ums_softc *sc = usb_fifo_softc(fifo);
 789
 790         DPRINTFN(2, "\n");
 791
 792         /* check for duplicate open, should not happen */
 793         if (sc->sc_fflags & fflags)
 794                 return (EBUSY);
 795
 796         /* check for first open */
 797         if (sc->sc_fflags == 0) {
 798
 799                 /* reset all USB mouse parameters */
 800
 801                 if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 802                         sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 803                 else
 804                         sc->sc_hw.buttons = sc->sc_buttons;
 805
 806                 sc->sc_hw.iftype = MOUSE_IF_USB;
 807                 sc->sc_hw.type = MOUSE_MOUSE;
 808                 sc->sc_hw.model = MOUSE_MODEL_GENERIC;
 809                 sc->sc_hw.hwid = 0;
 810
 811                 sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 812                 sc->sc_mode.rate = -1;
 813                 sc->sc_mode.resolution = MOUSE_RES_UNKNOWN;
 814                 sc->sc_mode.accelfactor = 0;
 815                 sc->sc_mode.level = 0;
 816                 sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 817                 sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 818                 sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 819
 820                 /* reset status */
 821
 822                 sc->sc_status.flags = 0;
 823                 sc->sc_status.button = 0;
 824                 sc->sc_status.obutton = 0;
 825                 sc->sc_status.dx = 0;
 826                 sc->sc_status.dy = 0;
 827                 sc->sc_status.dz = 0;
 828                 /* sc->sc_status.dt = 0; */
 829         }
 830
 831         if (fflags & FREAD) {
 832                 /* allocate RX buffer */
 833                 if (usb_fifo_alloc_buffer(fifo,
 834                     UMS_BUF_SIZE, UMS_IFQ_MAXLEN)) {
 835                         return (ENOMEM);
 836                 }
 837         }
 838
 839         sc->sc_fflags |= fflags & (FREAD | FWRITE);
 840         return (0);
 841 }
 842
 843 static void
 844 ums_close(struct usb_fifo *fifo, int fflags)
 845 {
 846         struct ums_softc *sc = usb_fifo_softc(fifo);
 847
 848         DPRINTFN(2, "\n");
 849
 850         if (fflags & FREAD)
 851                 usb_fifo_free_buffer(fifo);
 852
 853         sc->sc_fflags &= ~(fflags & (FREAD | FWRITE));
 854 }
 855
 856 static int
 857 ums_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
 858 {
 859         struct ums_softc *sc = usb_fifo_softc(fifo);
 860         mousemode_t mode;
 861         int error = 0;
 862
 863         DPRINTFN(2, "\n");
 864
 865         mtx_lock(&sc->sc_mtx);
 866
 867         switch (cmd) {
 868         case MOUSE_GETHWINFO:
 869                 *(mousehw_t *)addr = sc->sc_hw;
 870                 break;
 871
 872         case MOUSE_GETMODE:
 873                 *(mousemode_t *)addr = sc->sc_mode;
 874                 break;
 875
 876         case MOUSE_SETMODE:
 877                 mode = *(mousemode_t *)addr;
 878
 879                 if (mode.level == -1) {
 880                         /* don't change the current setting */
 881                 } else if ((mode.level < 0) || (mode.level > 1)) {
 882                         error = EINVAL;
 883                         break;
 884                 } else {
 885                         sc->sc_mode.level = mode.level;
 886                 }
 887
 888                 /* store polling rate */
 889                 sc->sc_pollrate = mode.rate;
 890
 891                 if (sc->sc_mode.level == 0) {
 892                         if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 893                                 sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 894                         else
 895                                 sc->sc_hw.buttons = sc->sc_buttons;
 896                         sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 897                         sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 898                         sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 899                         sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 900                 } else if (sc->sc_mode.level == 1) {
 901                         if (sc->sc_buttons > MOUSE_SYS_MAXBUTTON)
 902                                 sc->sc_hw.buttons = MOUSE_SYS_MAXBUTTON;
 903                         else
 904                                 sc->sc_hw.buttons = sc->sc_buttons;
 905                         sc->sc_mode.protocol = MOUSE_PROTO_SYSMOUSE;
 906                         sc->sc_mode.packetsize = MOUSE_SYS_PACKETSIZE;
 907                         sc->sc_mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 908                         sc->sc_mode.syncmask[1] = MOUSE_SYS_SYNC;
 909                 }
 910                 ums_reset_buf(sc);
 911                 break;
 912
 913         case MOUSE_GETLEVEL:
 914                 *(int *)addr = sc->sc_mode.level;
 915                 break;
 916
 917         case MOUSE_SETLEVEL:
 918                 if (*(int *)addr < 0 || *(int *)addr > 1) {
 919                         error = EINVAL;
 920                         break;
 921                 }
 922                 sc->sc_mode.level = *(int *)addr;
 923
 924                 if (sc->sc_mode.level == 0) {
 925                         if (sc->sc_buttons > MOUSE_MSC_MAXBUTTON)
 926                                 sc->sc_hw.buttons = MOUSE_MSC_MAXBUTTON;
 927                         else
 928                                 sc->sc_hw.buttons = sc->sc_buttons;
 929                         sc->sc_mode.protocol = MOUSE_PROTO_MSC;
 930                         sc->sc_mode.packetsize = MOUSE_MSC_PACKETSIZE;
 931                         sc->sc_mode.syncmask[0] = MOUSE_MSC_SYNCMASK;
 932                         sc->sc_mode.syncmask[1] = MOUSE_MSC_SYNC;
 933                 } else if (sc->sc_mode.level == 1) {
 934                         if (sc->sc_buttons > MOUSE_SYS_MAXBUTTON)
 935                                 sc->sc_hw.buttons = MOUSE_SYS_MAXBUTTON;
 936                         else
 937                                 sc->sc_hw.buttons = sc->sc_buttons;
 938                         sc->sc_mode.protocol = MOUSE_PROTO_SYSMOUSE;
 939                         sc->sc_mode.packetsize = MOUSE_SYS_PACKETSIZE;
 940                         sc->sc_mode.syncmask[0] = MOUSE_SYS_SYNCMASK;
 941                         sc->sc_mode.syncmask[1] = MOUSE_SYS_SYNC;
 942                 }
 943                 ums_reset_buf(sc);
 944                 break;
 945
 946         case MOUSE_GETSTATUS:{
 947                         mousestatus_t *status = (mousestatus_t *)addr;
 948
 949                         *status = sc->sc_status;
 950                         sc->sc_status.obutton = sc->sc_status.button;
 951                         sc->sc_status.button = 0;
 952                         sc->sc_status.dx = 0;
 953                         sc->sc_status.dy = 0;
 954                         sc->sc_status.dz = 0;
 955                         /* sc->sc_status.dt = 0; */
 956
 957                         if (status->dx || status->dy || status->dz /* || status->dt */ ) {
 958                                 status->flags |= MOUSE_POSCHANGED;
 959                         }
 960                         if (status->button != status->obutton) {
 961                                 status->flags |= MOUSE_BUTTONSCHANGED;
 962                         }
 963                         break;
 964                 }
 965         default:
 966                 error = ENOTTY;
 967                 break;
 968         }
 969
 970         mtx_unlock(&sc->sc_mtx);
 971         return (error);
 972 }
 973
 974 static int
 975 ums_sysctl_handler_parseinfo(SYSCTL_HANDLER_ARGS)
 976 {
 977         struct ums_softc *sc = arg1;
 978         struct ums_info *info;
 979         struct sbuf *sb;
 980         int i, j, err, had_output;
 981
 982         sb = sbuf_new_auto();
 983         for (i = 0, had_output = 0; i < UMS_INFO_MAX; i++) {
 984                 info = &sc->sc_info[i];
 985
 986                 /* Don't emit empty info */
 987                 if ((info->sc_flags &
 988                     (UMS_FLAG_X_AXIS | UMS_FLAG_Y_AXIS | UMS_FLAG_Z_AXIS |
 989                      UMS_FLAG_T_AXIS | UMS_FLAG_W_AXIS)) == 0 &&
 990                     info->sc_buttons == 0)
 991                         continue;
 992
 993                 if (had_output)
 994                         sbuf_printf(sb, "\n");
 995                 had_output = 1;
 996                 sbuf_printf(sb, "i%d:", i + 1);
 997                 if (info->sc_flags & UMS_FLAG_X_AXIS)
 998                         sbuf_printf(sb, " X:r%d, p%d, s%d;",
 999                             (int)info->sc_iid_x,
1000                             (int)info->sc_loc_x.pos,
1001                             (int)info->sc_loc_x.size);
1002                 if (info->sc_flags & UMS_FLAG_Y_AXIS)
1003                         sbuf_printf(sb, " Y:r%d, p%d, s%d;",
1004                             (int)info->sc_iid_y,
1005                             (int)info->sc_loc_y.pos,
1006                             (int)info->sc_loc_y.size);
1007                 if (info->sc_flags & UMS_FLAG_Z_AXIS)
1008                         sbuf_printf(sb, " Z:r%d, p%d, s%d;",
1009                             (int)info->sc_iid_z,
1010                             (int)info->sc_loc_z.pos,
1011                             (int)info->sc_loc_z.size);
1012                 if (info->sc_flags & UMS_FLAG_T_AXIS)
1013                         sbuf_printf(sb, " T:r%d, p%d, s%d;",
1014                             (int)info->sc_iid_t,
1015                             (int)info->sc_loc_t.pos,
1016                             (int)info->sc_loc_t.size);
1017                 if (info->sc_flags & UMS_FLAG_W_AXIS)
1018                         sbuf_printf(sb, " W:r%d, p%d, s%d;",
1019                             (int)info->sc_iid_w,
1020                             (int)info->sc_loc_w.pos,
1021                             (int)info->sc_loc_w.size);
1022
1023                 for (j = 0; j < info->sc_buttons; j++) {
1024                         sbuf_printf(sb, " B%d:r%d, p%d, s%d;", j + 1,
1025                             (int)info->sc_iid_btn[j],
1026                             (int)info->sc_loc_btn[j].pos,
1027                             (int)info->sc_loc_btn[j].size);
1028                 }
1029         }
1030         sbuf_finish(sb);
1031         err = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
1032         sbuf_delete(sb);
1033
1034         return (err);
1035 }
1036
1037 static devclass_t ums_devclass;
1038
1039 static device_method_t ums_methods[] = {
1040         DEVMETHOD(device_probe, ums_probe),
1041         DEVMETHOD(device_attach, ums_attach),
1042         DEVMETHOD(device_detach, ums_detach),
1043         {0, 0}
1044 };
1045
1046 static driver_t ums_driver = {
1047         .name = "ums",
1048         .methods = ums_methods,
1049         .size = sizeof(struct ums_softc),
1050 };
1051
1052 DRIVER_MODULE(ums, uhub, ums_driver, ums_devclass, NULL, 0);
1053 MODULE_DEPEND(ums, usb, 1, 1, 1);
1054 MODULE_VERSION(ums, 1);