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