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