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