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