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