1 /* 2 * USB HID support for Linux 3 * 4 * Copyright (c) 1999 Andreas Gal 5 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz> 6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc 7 * Copyright (c) 2007-2008 Oliver Neukum 8 * Copyright (c) 2006-2010 Jiri Kosina 9 */ 10 11 /* 12 * This program is free software; you can redistribute it and/or modify it 13 * under the terms of the GNU General Public License as published by the Free 14 * Software Foundation; either version 2 of the License, or (at your option) 15 * any later version. 16 */ 17 18 #include <linux/module.h> 19 #include <linux/slab.h> 20 #include <linux/init.h> 21 #include <linux/kernel.h> 22 #include <linux/list.h> 23 #include <linux/mm.h> 24 #include <linux/mutex.h> 25 #include <linux/spinlock.h> 26 #include <asm/unaligned.h> 27 #include <asm/byteorder.h> 28 #include <linux/input.h> 29 #include <linux/wait.h> 30 #include <linux/workqueue.h> 31 #include <linux/string.h> 32 33 #include <linux/usb.h> 34 35 #include <linux/hid.h> 36 #include <linux/hiddev.h> 37 #include <linux/hid-debug.h> 38 #include <linux/hidraw.h> 39 #include "usbhid.h" 40 41 /* 42 * Version Information 43 */ 44 45 #define DRIVER_DESC "USB HID core driver" 46 47 /* 48 * Module parameters. 49 */ 50 51 static unsigned int hid_mousepoll_interval; 52 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644); 53 MODULE_PARM_DESC(mousepoll, "Polling interval of mice"); 54 55 static unsigned int hid_jspoll_interval; 56 module_param_named(jspoll, hid_jspoll_interval, uint, 0644); 57 MODULE_PARM_DESC(jspoll, "Polling interval of joysticks"); 58 59 static unsigned int ignoreled; 60 module_param_named(ignoreled, ignoreled, uint, 0644); 61 MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds"); 62 63 /* Quirks specified at module load time */ 64 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS]; 65 module_param_array_named(quirks, quirks_param, charp, NULL, 0444); 66 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying " 67 " quirks=vendorID:productID:quirks" 68 " where vendorID, productID, and quirks are all in" 69 " 0x-prefixed hex"); 70 /* 71 * Input submission and I/O error handler. 72 */ 73 static void hid_io_error(struct hid_device *hid); 74 static int hid_submit_out(struct hid_device *hid); 75 static int hid_submit_ctrl(struct hid_device *hid); 76 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid); 77 78 /* Start up the input URB */ 79 static int hid_start_in(struct hid_device *hid) 80 { 81 unsigned long flags; 82 int rc = 0; 83 struct usbhid_device *usbhid = hid->driver_data; 84 85 spin_lock_irqsave(&usbhid->lock, flags); 86 if (test_bit(HID_IN_POLLING, &usbhid->iofl) && 87 !test_bit(HID_DISCONNECTED, &usbhid->iofl) && 88 !test_bit(HID_SUSPENDED, &usbhid->iofl) && 89 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) { 90 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC); 91 if (rc != 0) { 92 clear_bit(HID_IN_RUNNING, &usbhid->iofl); 93 if (rc == -ENOSPC) 94 set_bit(HID_NO_BANDWIDTH, &usbhid->iofl); 95 } else { 96 clear_bit(HID_NO_BANDWIDTH, &usbhid->iofl); 97 } 98 } 99 spin_unlock_irqrestore(&usbhid->lock, flags); 100 return rc; 101 } 102 103 /* I/O retry timer routine */ 104 static void hid_retry_timeout(unsigned long _hid) 105 { 106 struct hid_device *hid = (struct hid_device *) _hid; 107 struct usbhid_device *usbhid = hid->driver_data; 108 109 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n"); 110 if (hid_start_in(hid)) 111 hid_io_error(hid); 112 } 113 114 /* Workqueue routine to reset the device or clear a halt */ 115 static void hid_reset(struct work_struct *work) 116 { 117 struct usbhid_device *usbhid = 118 container_of(work, struct usbhid_device, reset_work); 119 struct hid_device *hid = usbhid->hid; 120 int rc; 121 122 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) { 123 dev_dbg(&usbhid->intf->dev, "clear halt\n"); 124 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe); 125 clear_bit(HID_CLEAR_HALT, &usbhid->iofl); 126 if (rc == 0) { 127 hid_start_in(hid); 128 } else { 129 dev_dbg(&usbhid->intf->dev, 130 "clear-halt failed: %d\n", rc); 131 set_bit(HID_RESET_PENDING, &usbhid->iofl); 132 } 133 } 134 135 if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) { 136 dev_dbg(&usbhid->intf->dev, "resetting device\n"); 137 usb_queue_reset_device(usbhid->intf); 138 } 139 } 140 141 /* Main I/O error handler */ 142 static void hid_io_error(struct hid_device *hid) 143 { 144 unsigned long flags; 145 struct usbhid_device *usbhid = hid->driver_data; 146 147 spin_lock_irqsave(&usbhid->lock, flags); 148 149 /* Stop when disconnected */ 150 if (test_bit(HID_DISCONNECTED, &usbhid->iofl)) 151 goto done; 152 153 /* If it has been a while since the last error, we'll assume 154 * this a brand new error and reset the retry timeout. */ 155 if (time_after(jiffies, usbhid->stop_retry + HZ/2)) 156 usbhid->retry_delay = 0; 157 158 /* When an error occurs, retry at increasing intervals */ 159 if (usbhid->retry_delay == 0) { 160 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */ 161 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000); 162 } else if (usbhid->retry_delay < 100) 163 usbhid->retry_delay *= 2; 164 165 if (time_after(jiffies, usbhid->stop_retry)) { 166 167 /* Retries failed, so do a port reset unless we lack bandwidth*/ 168 if (!test_bit(HID_NO_BANDWIDTH, &usbhid->iofl) 169 && !test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) { 170 171 schedule_work(&usbhid->reset_work); 172 goto done; 173 } 174 } 175 176 mod_timer(&usbhid->io_retry, 177 jiffies + msecs_to_jiffies(usbhid->retry_delay)); 178 done: 179 spin_unlock_irqrestore(&usbhid->lock, flags); 180 } 181 182 static void usbhid_mark_busy(struct usbhid_device *usbhid) 183 { 184 struct usb_interface *intf = usbhid->intf; 185 186 usb_mark_last_busy(interface_to_usbdev(intf)); 187 } 188 189 static int usbhid_restart_out_queue(struct usbhid_device *usbhid) 190 { 191 struct hid_device *hid = usb_get_intfdata(usbhid->intf); 192 int kicked; 193 int r; 194 195 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) || 196 test_bit(HID_SUSPENDED, &usbhid->iofl)) 197 return 0; 198 199 if ((kicked = (usbhid->outhead != usbhid->outtail))) { 200 hid_dbg(hid, "Kicking head %d tail %d", usbhid->outhead, usbhid->outtail); 201 202 /* Try to wake up from autosuspend... */ 203 r = usb_autopm_get_interface_async(usbhid->intf); 204 if (r < 0) 205 return r; 206 207 /* 208 * If still suspended, don't submit. Submission will 209 * occur if/when resume drains the queue. 210 */ 211 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) { 212 usb_autopm_put_interface_no_suspend(usbhid->intf); 213 return r; 214 } 215 216 /* Asynchronously flush queue. */ 217 set_bit(HID_OUT_RUNNING, &usbhid->iofl); 218 if (hid_submit_out(hid)) { 219 clear_bit(HID_OUT_RUNNING, &usbhid->iofl); 220 usb_autopm_put_interface_async(usbhid->intf); 221 } 222 wake_up(&usbhid->wait); 223 } 224 return kicked; 225 } 226 227 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid) 228 { 229 struct hid_device *hid = usb_get_intfdata(usbhid->intf); 230 int kicked; 231 int r; 232 233 WARN_ON(hid == NULL); 234 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) || 235 test_bit(HID_SUSPENDED, &usbhid->iofl)) 236 return 0; 237 238 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) { 239 hid_dbg(hid, "Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail); 240 241 /* Try to wake up from autosuspend... */ 242 r = usb_autopm_get_interface_async(usbhid->intf); 243 if (r < 0) 244 return r; 245 246 /* 247 * If still suspended, don't submit. Submission will 248 * occur if/when resume drains the queue. 249 */ 250 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) { 251 usb_autopm_put_interface_no_suspend(usbhid->intf); 252 return r; 253 } 254 255 /* Asynchronously flush queue. */ 256 set_bit(HID_CTRL_RUNNING, &usbhid->iofl); 257 if (hid_submit_ctrl(hid)) { 258 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl); 259 usb_autopm_put_interface_async(usbhid->intf); 260 } 261 wake_up(&usbhid->wait); 262 } 263 return kicked; 264 } 265 266 /* 267 * Input interrupt completion handler. 268 */ 269 270 static void hid_irq_in(struct urb *urb) 271 { 272 struct hid_device *hid = urb->context; 273 struct usbhid_device *usbhid = hid->driver_data; 274 int status; 275 276 switch (urb->status) { 277 case 0: /* success */ 278 usbhid->retry_delay = 0; 279 if (!test_bit(HID_OPENED, &usbhid->iofl)) 280 break; 281 usbhid_mark_busy(usbhid); 282 if (!test_bit(HID_RESUME_RUNNING, &usbhid->iofl)) { 283 hid_input_report(urb->context, HID_INPUT_REPORT, 284 urb->transfer_buffer, 285 urb->actual_length, 1); 286 /* 287 * autosuspend refused while keys are pressed 288 * because most keyboards don't wake up when 289 * a key is released 290 */ 291 if (hid_check_keys_pressed(hid)) 292 set_bit(HID_KEYS_PRESSED, &usbhid->iofl); 293 else 294 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl); 295 } 296 break; 297 case -EPIPE: /* stall */ 298 usbhid_mark_busy(usbhid); 299 clear_bit(HID_IN_RUNNING, &usbhid->iofl); 300 set_bit(HID_CLEAR_HALT, &usbhid->iofl); 301 schedule_work(&usbhid->reset_work); 302 return; 303 case -ECONNRESET: /* unlink */ 304 case -ENOENT: 305 case -ESHUTDOWN: /* unplug */ 306 clear_bit(HID_IN_RUNNING, &usbhid->iofl); 307 return; 308 case -EILSEQ: /* protocol error or unplug */ 309 case -EPROTO: /* protocol error or unplug */ 310 case -ETIME: /* protocol error or unplug */ 311 case -ETIMEDOUT: /* Should never happen, but... */ 312 usbhid_mark_busy(usbhid); 313 clear_bit(HID_IN_RUNNING, &usbhid->iofl); 314 hid_io_error(hid); 315 return; 316 default: /* error */ 317 hid_warn(urb->dev, "input irq status %d received\n", 318 urb->status); 319 } 320 321 status = usb_submit_urb(urb, GFP_ATOMIC); 322 if (status) { 323 clear_bit(HID_IN_RUNNING, &usbhid->iofl); 324 if (status != -EPERM) { 325 hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n", 326 hid_to_usb_dev(hid)->bus->bus_name, 327 hid_to_usb_dev(hid)->devpath, 328 usbhid->ifnum, status); 329 hid_io_error(hid); 330 } 331 } 332 } 333 334 static int hid_submit_out(struct hid_device *hid) 335 { 336 struct hid_report *report; 337 char *raw_report; 338 struct usbhid_device *usbhid = hid->driver_data; 339 int r; 340 341 report = usbhid->out[usbhid->outtail].report; 342 raw_report = usbhid->out[usbhid->outtail].raw_report; 343 344 usbhid->urbout->transfer_buffer_length = hid_report_len(report); 345 usbhid->urbout->dev = hid_to_usb_dev(hid); 346 if (raw_report) { 347 memcpy(usbhid->outbuf, raw_report, 348 usbhid->urbout->transfer_buffer_length); 349 kfree(raw_report); 350 usbhid->out[usbhid->outtail].raw_report = NULL; 351 } 352 353 dbg_hid("submitting out urb\n"); 354 355 r = usb_submit_urb(usbhid->urbout, GFP_ATOMIC); 356 if (r < 0) { 357 hid_err(hid, "usb_submit_urb(out) failed: %d\n", r); 358 return r; 359 } 360 usbhid->last_out = jiffies; 361 return 0; 362 } 363 364 static int hid_submit_ctrl(struct hid_device *hid) 365 { 366 struct hid_report *report; 367 unsigned char dir; 368 char *raw_report; 369 int len, r; 370 struct usbhid_device *usbhid = hid->driver_data; 371 372 report = usbhid->ctrl[usbhid->ctrltail].report; 373 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report; 374 dir = usbhid->ctrl[usbhid->ctrltail].dir; 375 376 len = ((report->size - 1) >> 3) + 1 + (report->id > 0); 377 if (dir == USB_DIR_OUT) { 378 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0); 379 usbhid->urbctrl->transfer_buffer_length = len; 380 if (raw_report) { 381 memcpy(usbhid->ctrlbuf, raw_report, len); 382 kfree(raw_report); 383 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL; 384 } 385 } else { 386 int maxpacket, padlen; 387 388 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0); 389 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), 390 usbhid->urbctrl->pipe, 0); 391 if (maxpacket > 0) { 392 padlen = DIV_ROUND_UP(len, maxpacket); 393 padlen *= maxpacket; 394 if (padlen > usbhid->bufsize) 395 padlen = usbhid->bufsize; 396 } else 397 padlen = 0; 398 usbhid->urbctrl->transfer_buffer_length = padlen; 399 } 400 usbhid->urbctrl->dev = hid_to_usb_dev(hid); 401 402 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir; 403 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : 404 HID_REQ_GET_REPORT; 405 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | 406 report->id); 407 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum); 408 usbhid->cr->wLength = cpu_to_le16(len); 409 410 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n", 411 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : 412 "Get_Report", 413 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength); 414 415 r = usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC); 416 if (r < 0) { 417 hid_err(hid, "usb_submit_urb(ctrl) failed: %d\n", r); 418 return r; 419 } 420 usbhid->last_ctrl = jiffies; 421 return 0; 422 } 423 424 /* 425 * Output interrupt completion handler. 426 */ 427 428 static void hid_irq_out(struct urb *urb) 429 { 430 struct hid_device *hid = urb->context; 431 struct usbhid_device *usbhid = hid->driver_data; 432 unsigned long flags; 433 int unplug = 0; 434 435 switch (urb->status) { 436 case 0: /* success */ 437 break; 438 case -ESHUTDOWN: /* unplug */ 439 unplug = 1; 440 case -EILSEQ: /* protocol error or unplug */ 441 case -EPROTO: /* protocol error or unplug */ 442 case -ECONNRESET: /* unlink */ 443 case -ENOENT: 444 break; 445 default: /* error */ 446 hid_warn(urb->dev, "output irq status %d received\n", 447 urb->status); 448 } 449 450 spin_lock_irqsave(&usbhid->lock, flags); 451 452 if (unplug) { 453 usbhid->outtail = usbhid->outhead; 454 } else { 455 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1); 456 457 if (usbhid->outhead != usbhid->outtail && 458 hid_submit_out(hid) == 0) { 459 /* Successfully submitted next urb in queue */ 460 spin_unlock_irqrestore(&usbhid->lock, flags); 461 return; 462 } 463 } 464 465 clear_bit(HID_OUT_RUNNING, &usbhid->iofl); 466 spin_unlock_irqrestore(&usbhid->lock, flags); 467 usb_autopm_put_interface_async(usbhid->intf); 468 wake_up(&usbhid->wait); 469 } 470 471 /* 472 * Control pipe completion handler. 473 */ 474 475 static void hid_ctrl(struct urb *urb) 476 { 477 struct hid_device *hid = urb->context; 478 struct usbhid_device *usbhid = hid->driver_data; 479 int unplug = 0, status = urb->status; 480 481 switch (status) { 482 case 0: /* success */ 483 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN) 484 hid_input_report(urb->context, 485 usbhid->ctrl[usbhid->ctrltail].report->type, 486 urb->transfer_buffer, urb->actual_length, 0); 487 break; 488 case -ESHUTDOWN: /* unplug */ 489 unplug = 1; 490 case -EILSEQ: /* protocol error or unplug */ 491 case -EPROTO: /* protocol error or unplug */ 492 case -ECONNRESET: /* unlink */ 493 case -ENOENT: 494 case -EPIPE: /* report not available */ 495 break; 496 default: /* error */ 497 hid_warn(urb->dev, "ctrl urb status %d received\n", status); 498 } 499 500 spin_lock(&usbhid->lock); 501 502 if (unplug) { 503 usbhid->ctrltail = usbhid->ctrlhead; 504 } else { 505 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1); 506 507 if (usbhid->ctrlhead != usbhid->ctrltail && 508 hid_submit_ctrl(hid) == 0) { 509 /* Successfully submitted next urb in queue */ 510 spin_unlock(&usbhid->lock); 511 return; 512 } 513 } 514 515 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl); 516 spin_unlock(&usbhid->lock); 517 usb_autopm_put_interface_async(usbhid->intf); 518 wake_up(&usbhid->wait); 519 } 520 521 static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report, 522 unsigned char dir) 523 { 524 int head; 525 struct usbhid_device *usbhid = hid->driver_data; 526 527 if (((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN) || 528 test_bit(HID_DISCONNECTED, &usbhid->iofl)) 529 return; 530 531 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) { 532 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) { 533 hid_warn(hid, "output queue full\n"); 534 return; 535 } 536 537 usbhid->out[usbhid->outhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC); 538 if (!usbhid->out[usbhid->outhead].raw_report) { 539 hid_warn(hid, "output queueing failed\n"); 540 return; 541 } 542 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report); 543 usbhid->out[usbhid->outhead].report = report; 544 usbhid->outhead = head; 545 546 /* If the queue isn't running, restart it */ 547 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) { 548 usbhid_restart_out_queue(usbhid); 549 550 /* Otherwise see if an earlier request has timed out */ 551 } else if (time_after(jiffies, usbhid->last_out + HZ * 5)) { 552 553 /* Prevent autosuspend following the unlink */ 554 usb_autopm_get_interface_no_resume(usbhid->intf); 555 556 /* 557 * Prevent resubmission in case the URB completes 558 * before we can unlink it. We don't want to cancel 559 * the wrong transfer! 560 */ 561 usb_block_urb(usbhid->urbout); 562 563 /* Drop lock to avoid deadlock if the callback runs */ 564 spin_unlock(&usbhid->lock); 565 566 usb_unlink_urb(usbhid->urbout); 567 spin_lock(&usbhid->lock); 568 usb_unblock_urb(usbhid->urbout); 569 570 /* Unlink might have stopped the queue */ 571 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) 572 usbhid_restart_out_queue(usbhid); 573 574 /* Now we can allow autosuspend again */ 575 usb_autopm_put_interface_async(usbhid->intf); 576 } 577 return; 578 } 579 580 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) { 581 hid_warn(hid, "control queue full\n"); 582 return; 583 } 584 585 if (dir == USB_DIR_OUT) { 586 usbhid->ctrl[usbhid->ctrlhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC); 587 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) { 588 hid_warn(hid, "control queueing failed\n"); 589 return; 590 } 591 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report); 592 } 593 usbhid->ctrl[usbhid->ctrlhead].report = report; 594 usbhid->ctrl[usbhid->ctrlhead].dir = dir; 595 usbhid->ctrlhead = head; 596 597 /* If the queue isn't running, restart it */ 598 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) { 599 usbhid_restart_ctrl_queue(usbhid); 600 601 /* Otherwise see if an earlier request has timed out */ 602 } else if (time_after(jiffies, usbhid->last_ctrl + HZ * 5)) { 603 604 /* Prevent autosuspend following the unlink */ 605 usb_autopm_get_interface_no_resume(usbhid->intf); 606 607 /* 608 * Prevent resubmission in case the URB completes 609 * before we can unlink it. We don't want to cancel 610 * the wrong transfer! 611 */ 612 usb_block_urb(usbhid->urbctrl); 613 614 /* Drop lock to avoid deadlock if the callback runs */ 615 spin_unlock(&usbhid->lock); 616 617 usb_unlink_urb(usbhid->urbctrl); 618 spin_lock(&usbhid->lock); 619 usb_unblock_urb(usbhid->urbctrl); 620 621 /* Unlink might have stopped the queue */ 622 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) 623 usbhid_restart_ctrl_queue(usbhid); 624 625 /* Now we can allow autosuspend again */ 626 usb_autopm_put_interface_async(usbhid->intf); 627 } 628 } 629 630 static void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir) 631 { 632 struct usbhid_device *usbhid = hid->driver_data; 633 unsigned long flags; 634 635 spin_lock_irqsave(&usbhid->lock, flags); 636 __usbhid_submit_report(hid, report, dir); 637 spin_unlock_irqrestore(&usbhid->lock, flags); 638 } 639 640 static int usbhid_wait_io(struct hid_device *hid) 641 { 642 struct usbhid_device *usbhid = hid->driver_data; 643 644 if (!wait_event_timeout(usbhid->wait, 645 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) && 646 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)), 647 10*HZ)) { 648 dbg_hid("timeout waiting for ctrl or out queue to clear\n"); 649 return -1; 650 } 651 652 return 0; 653 } 654 655 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle) 656 { 657 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 658 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report, 659 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT); 660 } 661 662 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum, 663 unsigned char type, void *buf, int size) 664 { 665 int result, retries = 4; 666 667 memset(buf, 0, size); 668 669 do { 670 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 671 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN, 672 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT); 673 retries--; 674 } while (result < size && retries); 675 return result; 676 } 677 678 static int usbhid_open(struct hid_device *hid) 679 { 680 struct usbhid_device *usbhid = hid->driver_data; 681 int res; 682 683 set_bit(HID_OPENED, &usbhid->iofl); 684 685 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) 686 return 0; 687 688 res = usb_autopm_get_interface(usbhid->intf); 689 /* the device must be awake to reliably request remote wakeup */ 690 if (res < 0) { 691 clear_bit(HID_OPENED, &usbhid->iofl); 692 return -EIO; 693 } 694 695 usbhid->intf->needs_remote_wakeup = 1; 696 697 set_bit(HID_RESUME_RUNNING, &usbhid->iofl); 698 set_bit(HID_IN_POLLING, &usbhid->iofl); 699 700 res = hid_start_in(hid); 701 if (res) { 702 if (res != -ENOSPC) { 703 hid_io_error(hid); 704 res = 0; 705 } else { 706 /* no use opening if resources are insufficient */ 707 res = -EBUSY; 708 clear_bit(HID_OPENED, &usbhid->iofl); 709 clear_bit(HID_IN_POLLING, &usbhid->iofl); 710 usbhid->intf->needs_remote_wakeup = 0; 711 } 712 } 713 714 usb_autopm_put_interface(usbhid->intf); 715 716 /* 717 * In case events are generated while nobody was listening, 718 * some are released when the device is re-opened. 719 * Wait 50 msec for the queue to empty before allowing events 720 * to go through hid. 721 */ 722 if (res == 0) 723 msleep(50); 724 725 clear_bit(HID_RESUME_RUNNING, &usbhid->iofl); 726 return res; 727 } 728 729 static void usbhid_close(struct hid_device *hid) 730 { 731 struct usbhid_device *usbhid = hid->driver_data; 732 733 /* 734 * Make sure we don't restart data acquisition due to 735 * a resumption we no longer care about by avoiding racing 736 * with hid_start_in(). 737 */ 738 spin_lock_irq(&usbhid->lock); 739 clear_bit(HID_OPENED, &usbhid->iofl); 740 if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL)) 741 clear_bit(HID_IN_POLLING, &usbhid->iofl); 742 spin_unlock_irq(&usbhid->lock); 743 744 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) 745 return; 746 747 hid_cancel_delayed_stuff(usbhid); 748 usb_kill_urb(usbhid->urbin); 749 usbhid->intf->needs_remote_wakeup = 0; 750 } 751 752 /* 753 * Initialize all reports 754 */ 755 756 void usbhid_init_reports(struct hid_device *hid) 757 { 758 struct hid_report *report; 759 struct usbhid_device *usbhid = hid->driver_data; 760 struct hid_report_enum *report_enum; 761 int err, ret; 762 763 report_enum = &hid->report_enum[HID_INPUT_REPORT]; 764 list_for_each_entry(report, &report_enum->report_list, list) 765 usbhid_submit_report(hid, report, USB_DIR_IN); 766 767 report_enum = &hid->report_enum[HID_FEATURE_REPORT]; 768 list_for_each_entry(report, &report_enum->report_list, list) 769 usbhid_submit_report(hid, report, USB_DIR_IN); 770 771 err = 0; 772 ret = usbhid_wait_io(hid); 773 while (ret) { 774 err |= ret; 775 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) 776 usb_kill_urb(usbhid->urbctrl); 777 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl)) 778 usb_kill_urb(usbhid->urbout); 779 ret = usbhid_wait_io(hid); 780 } 781 782 if (err) 783 hid_warn(hid, "timeout initializing reports\n"); 784 } 785 786 /* 787 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01). 788 */ 789 static int hid_find_field_early(struct hid_device *hid, unsigned int page, 790 unsigned int hid_code, struct hid_field **pfield) 791 { 792 struct hid_report *report; 793 struct hid_field *field; 794 struct hid_usage *usage; 795 int i, j; 796 797 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) { 798 for (i = 0; i < report->maxfield; i++) { 799 field = report->field[i]; 800 for (j = 0; j < field->maxusage; j++) { 801 usage = &field->usage[j]; 802 if ((usage->hid & HID_USAGE_PAGE) == page && 803 (usage->hid & 0xFFFF) == hid_code) { 804 *pfield = field; 805 return j; 806 } 807 } 808 } 809 } 810 return -1; 811 } 812 813 static void usbhid_set_leds(struct hid_device *hid) 814 { 815 struct hid_field *field; 816 int offset; 817 818 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) { 819 hid_set_field(field, offset, 0); 820 usbhid_submit_report(hid, field->report, USB_DIR_OUT); 821 } 822 } 823 824 /* 825 * Traverse the supplied list of reports and find the longest 826 */ 827 static void hid_find_max_report(struct hid_device *hid, unsigned int type, 828 unsigned int *max) 829 { 830 struct hid_report *report; 831 unsigned int size; 832 833 list_for_each_entry(report, &hid->report_enum[type].report_list, list) { 834 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered; 835 if (*max < size) 836 *max = size; 837 } 838 } 839 840 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid) 841 { 842 struct usbhid_device *usbhid = hid->driver_data; 843 844 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL, 845 &usbhid->inbuf_dma); 846 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL, 847 &usbhid->outbuf_dma); 848 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL); 849 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL, 850 &usbhid->ctrlbuf_dma); 851 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr || 852 !usbhid->ctrlbuf) 853 return -1; 854 855 return 0; 856 } 857 858 static int usbhid_get_raw_report(struct hid_device *hid, 859 unsigned char report_number, __u8 *buf, size_t count, 860 unsigned char report_type) 861 { 862 struct usbhid_device *usbhid = hid->driver_data; 863 struct usb_device *dev = hid_to_usb_dev(hid); 864 struct usb_interface *intf = usbhid->intf; 865 struct usb_host_interface *interface = intf->cur_altsetting; 866 int skipped_report_id = 0; 867 int ret; 868 869 /* Byte 0 is the report number. Report data starts at byte 1.*/ 870 buf[0] = report_number; 871 if (report_number == 0x0) { 872 /* Offset the return buffer by 1, so that the report ID 873 will remain in byte 0. */ 874 buf++; 875 count--; 876 skipped_report_id = 1; 877 } 878 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 879 HID_REQ_GET_REPORT, 880 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 881 ((report_type + 1) << 8) | report_number, 882 interface->desc.bInterfaceNumber, buf, count, 883 USB_CTRL_SET_TIMEOUT); 884 885 /* count also the report id */ 886 if (ret > 0 && skipped_report_id) 887 ret++; 888 889 return ret; 890 } 891 892 static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum, 893 __u8 *buf, size_t count, unsigned char rtype) 894 { 895 struct usbhid_device *usbhid = hid->driver_data; 896 struct usb_device *dev = hid_to_usb_dev(hid); 897 struct usb_interface *intf = usbhid->intf; 898 struct usb_host_interface *interface = intf->cur_altsetting; 899 int ret, skipped_report_id = 0; 900 901 /* Byte 0 is the report number. Report data starts at byte 1.*/ 902 if ((rtype == HID_OUTPUT_REPORT) && 903 (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID)) 904 buf[0] = 0; 905 else 906 buf[0] = reportnum; 907 908 if (buf[0] == 0x0) { 909 /* Don't send the Report ID */ 910 buf++; 911 count--; 912 skipped_report_id = 1; 913 } 914 915 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 916 HID_REQ_SET_REPORT, 917 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 918 ((rtype + 1) << 8) | reportnum, 919 interface->desc.bInterfaceNumber, buf, count, 920 USB_CTRL_SET_TIMEOUT); 921 /* count also the report id, if this was a numbered report. */ 922 if (ret > 0 && skipped_report_id) 923 ret++; 924 925 return ret; 926 } 927 928 static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count) 929 { 930 struct usbhid_device *usbhid = hid->driver_data; 931 struct usb_device *dev = hid_to_usb_dev(hid); 932 int actual_length, skipped_report_id = 0, ret; 933 934 if (!usbhid->urbout) 935 return -ENOSYS; 936 937 if (buf[0] == 0x0) { 938 /* Don't send the Report ID */ 939 buf++; 940 count--; 941 skipped_report_id = 1; 942 } 943 944 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe, 945 buf, count, &actual_length, 946 USB_CTRL_SET_TIMEOUT); 947 /* return the number of bytes transferred */ 948 if (ret == 0) { 949 ret = actual_length; 950 /* count also the report id */ 951 if (skipped_report_id) 952 ret++; 953 } 954 955 return ret; 956 } 957 958 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid) 959 { 960 struct usbhid_device *usbhid = hid->driver_data; 961 962 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma); 963 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma); 964 kfree(usbhid->cr); 965 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma); 966 } 967 968 static int usbhid_parse(struct hid_device *hid) 969 { 970 struct usb_interface *intf = to_usb_interface(hid->dev.parent); 971 struct usb_host_interface *interface = intf->cur_altsetting; 972 struct usb_device *dev = interface_to_usbdev (intf); 973 struct hid_descriptor *hdesc; 974 u32 quirks = 0; 975 unsigned int rsize = 0; 976 char *rdesc; 977 int ret, n; 978 int num_descriptors; 979 size_t offset = offsetof(struct hid_descriptor, desc); 980 981 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor), 982 le16_to_cpu(dev->descriptor.idProduct)); 983 984 if (quirks & HID_QUIRK_IGNORE) 985 return -ENODEV; 986 987 /* Many keyboards and mice don't like to be polled for reports, 988 * so we will always set the HID_QUIRK_NOGET flag for them. */ 989 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) { 990 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD || 991 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE) 992 quirks |= HID_QUIRK_NOGET; 993 } 994 995 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) && 996 (!interface->desc.bNumEndpoints || 997 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) { 998 dbg_hid("class descriptor not present\n"); 999 return -ENODEV; 1000 } 1001 1002 if (hdesc->bLength < sizeof(struct hid_descriptor)) { 1003 dbg_hid("hid descriptor is too short\n"); 1004 return -EINVAL; 1005 } 1006 1007 hid->version = le16_to_cpu(hdesc->bcdHID); 1008 hid->country = hdesc->bCountryCode; 1009 1010 num_descriptors = min_t(int, hdesc->bNumDescriptors, 1011 (hdesc->bLength - offset) / sizeof(struct hid_class_descriptor)); 1012 1013 for (n = 0; n < num_descriptors; n++) 1014 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT) 1015 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength); 1016 1017 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) { 1018 dbg_hid("weird size of report descriptor (%u)\n", rsize); 1019 return -EINVAL; 1020 } 1021 1022 rdesc = kmalloc(rsize, GFP_KERNEL); 1023 if (!rdesc) 1024 return -ENOMEM; 1025 1026 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0); 1027 1028 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, 1029 HID_DT_REPORT, rdesc, rsize); 1030 if (ret < 0) { 1031 dbg_hid("reading report descriptor failed\n"); 1032 kfree(rdesc); 1033 goto err; 1034 } 1035 1036 ret = hid_parse_report(hid, rdesc, rsize); 1037 kfree(rdesc); 1038 if (ret) { 1039 dbg_hid("parsing report descriptor failed\n"); 1040 goto err; 1041 } 1042 1043 hid->quirks |= quirks; 1044 1045 return 0; 1046 err: 1047 return ret; 1048 } 1049 1050 static int usbhid_start(struct hid_device *hid) 1051 { 1052 struct usb_interface *intf = to_usb_interface(hid->dev.parent); 1053 struct usb_host_interface *interface = intf->cur_altsetting; 1054 struct usb_device *dev = interface_to_usbdev(intf); 1055 struct usbhid_device *usbhid = hid->driver_data; 1056 unsigned int n, insize = 0; 1057 int ret; 1058 1059 clear_bit(HID_DISCONNECTED, &usbhid->iofl); 1060 1061 usbhid->bufsize = HID_MIN_BUFFER_SIZE; 1062 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize); 1063 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize); 1064 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize); 1065 1066 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE) 1067 usbhid->bufsize = HID_MAX_BUFFER_SIZE; 1068 1069 hid_find_max_report(hid, HID_INPUT_REPORT, &insize); 1070 1071 if (insize > HID_MAX_BUFFER_SIZE) 1072 insize = HID_MAX_BUFFER_SIZE; 1073 1074 if (hid_alloc_buffers(dev, hid)) { 1075 ret = -ENOMEM; 1076 goto fail; 1077 } 1078 1079 for (n = 0; n < interface->desc.bNumEndpoints; n++) { 1080 struct usb_endpoint_descriptor *endpoint; 1081 int pipe; 1082 int interval; 1083 1084 endpoint = &interface->endpoint[n].desc; 1085 if (!usb_endpoint_xfer_int(endpoint)) 1086 continue; 1087 1088 interval = endpoint->bInterval; 1089 1090 /* Some vendors give fullspeed interval on highspeed devides */ 1091 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL && 1092 dev->speed == USB_SPEED_HIGH) { 1093 interval = fls(endpoint->bInterval*8); 1094 pr_info("%s: Fixing fullspeed to highspeed interval: %d -> %d\n", 1095 hid->name, endpoint->bInterval, interval); 1096 } 1097 1098 /* Change the polling interval of mice and joysticks. */ 1099 switch (hid->collection->usage) { 1100 case HID_GD_MOUSE: 1101 if (hid_mousepoll_interval > 0) 1102 interval = hid_mousepoll_interval; 1103 break; 1104 case HID_GD_JOYSTICK: 1105 if (hid_jspoll_interval > 0) 1106 interval = hid_jspoll_interval; 1107 break; 1108 } 1109 1110 ret = -ENOMEM; 1111 if (usb_endpoint_dir_in(endpoint)) { 1112 if (usbhid->urbin) 1113 continue; 1114 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL))) 1115 goto fail; 1116 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress); 1117 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize, 1118 hid_irq_in, hid, interval); 1119 usbhid->urbin->transfer_dma = usbhid->inbuf_dma; 1120 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 1121 } else { 1122 if (usbhid->urbout) 1123 continue; 1124 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL))) 1125 goto fail; 1126 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress); 1127 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0, 1128 hid_irq_out, hid, interval); 1129 usbhid->urbout->transfer_dma = usbhid->outbuf_dma; 1130 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 1131 } 1132 } 1133 1134 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL); 1135 if (!usbhid->urbctrl) { 1136 ret = -ENOMEM; 1137 goto fail; 1138 } 1139 1140 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr, 1141 usbhid->ctrlbuf, 1, hid_ctrl, hid); 1142 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma; 1143 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 1144 1145 set_bit(HID_STARTED, &usbhid->iofl); 1146 1147 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) { 1148 ret = usb_autopm_get_interface(usbhid->intf); 1149 if (ret) 1150 goto fail; 1151 set_bit(HID_IN_POLLING, &usbhid->iofl); 1152 usbhid->intf->needs_remote_wakeup = 1; 1153 ret = hid_start_in(hid); 1154 if (ret) { 1155 dev_err(&hid->dev, 1156 "failed to start in urb: %d\n", ret); 1157 } 1158 usb_autopm_put_interface(usbhid->intf); 1159 } 1160 1161 /* Some keyboards don't work until their LEDs have been set. 1162 * Since BIOSes do set the LEDs, it must be safe for any device 1163 * that supports the keyboard boot protocol. 1164 * In addition, enable remote wakeup by default for all keyboard 1165 * devices supporting the boot protocol. 1166 */ 1167 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT && 1168 interface->desc.bInterfaceProtocol == 1169 USB_INTERFACE_PROTOCOL_KEYBOARD) { 1170 usbhid_set_leds(hid); 1171 device_set_wakeup_enable(&dev->dev, 1); 1172 } 1173 return 0; 1174 1175 fail: 1176 usb_free_urb(usbhid->urbin); 1177 usb_free_urb(usbhid->urbout); 1178 usb_free_urb(usbhid->urbctrl); 1179 usbhid->urbin = NULL; 1180 usbhid->urbout = NULL; 1181 usbhid->urbctrl = NULL; 1182 hid_free_buffers(dev, hid); 1183 return ret; 1184 } 1185 1186 static void usbhid_stop(struct hid_device *hid) 1187 { 1188 struct usbhid_device *usbhid = hid->driver_data; 1189 1190 if (WARN_ON(!usbhid)) 1191 return; 1192 1193 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) { 1194 clear_bit(HID_IN_POLLING, &usbhid->iofl); 1195 usbhid->intf->needs_remote_wakeup = 0; 1196 } 1197 1198 clear_bit(HID_STARTED, &usbhid->iofl); 1199 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */ 1200 set_bit(HID_DISCONNECTED, &usbhid->iofl); 1201 spin_unlock_irq(&usbhid->lock); 1202 usb_kill_urb(usbhid->urbin); 1203 usb_kill_urb(usbhid->urbout); 1204 usb_kill_urb(usbhid->urbctrl); 1205 1206 hid_cancel_delayed_stuff(usbhid); 1207 1208 hid->claimed = 0; 1209 1210 usb_free_urb(usbhid->urbin); 1211 usb_free_urb(usbhid->urbctrl); 1212 usb_free_urb(usbhid->urbout); 1213 usbhid->urbin = NULL; /* don't mess up next start */ 1214 usbhid->urbctrl = NULL; 1215 usbhid->urbout = NULL; 1216 1217 hid_free_buffers(hid_to_usb_dev(hid), hid); 1218 } 1219 1220 static int usbhid_power(struct hid_device *hid, int lvl) 1221 { 1222 struct usbhid_device *usbhid = hid->driver_data; 1223 int r = 0; 1224 1225 switch (lvl) { 1226 case PM_HINT_FULLON: 1227 r = usb_autopm_get_interface(usbhid->intf); 1228 break; 1229 1230 case PM_HINT_NORMAL: 1231 usb_autopm_put_interface(usbhid->intf); 1232 break; 1233 } 1234 1235 return r; 1236 } 1237 1238 static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype) 1239 { 1240 switch (reqtype) { 1241 case HID_REQ_GET_REPORT: 1242 usbhid_submit_report(hid, rep, USB_DIR_IN); 1243 break; 1244 case HID_REQ_SET_REPORT: 1245 usbhid_submit_report(hid, rep, USB_DIR_OUT); 1246 break; 1247 } 1248 } 1249 1250 static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum, 1251 __u8 *buf, size_t len, unsigned char rtype, 1252 int reqtype) 1253 { 1254 switch (reqtype) { 1255 case HID_REQ_GET_REPORT: 1256 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype); 1257 case HID_REQ_SET_REPORT: 1258 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype); 1259 default: 1260 return -EIO; 1261 } 1262 } 1263 1264 static int usbhid_idle(struct hid_device *hid, int report, int idle, 1265 int reqtype) 1266 { 1267 struct usb_device *dev = hid_to_usb_dev(hid); 1268 struct usb_interface *intf = to_usb_interface(hid->dev.parent); 1269 struct usb_host_interface *interface = intf->cur_altsetting; 1270 int ifnum = interface->desc.bInterfaceNumber; 1271 1272 if (reqtype != HID_REQ_SET_IDLE) 1273 return -EINVAL; 1274 1275 return hid_set_idle(dev, ifnum, report, idle); 1276 } 1277 1278 struct hid_ll_driver usb_hid_driver = { 1279 .parse = usbhid_parse, 1280 .start = usbhid_start, 1281 .stop = usbhid_stop, 1282 .open = usbhid_open, 1283 .close = usbhid_close, 1284 .power = usbhid_power, 1285 .request = usbhid_request, 1286 .wait = usbhid_wait_io, 1287 .raw_request = usbhid_raw_request, 1288 .output_report = usbhid_output_report, 1289 .idle = usbhid_idle, 1290 }; 1291 EXPORT_SYMBOL_GPL(usb_hid_driver); 1292 1293 static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id) 1294 { 1295 struct usb_host_interface *interface = intf->cur_altsetting; 1296 struct usb_device *dev = interface_to_usbdev(intf); 1297 struct usbhid_device *usbhid; 1298 struct hid_device *hid; 1299 unsigned int n, has_in = 0; 1300 size_t len; 1301 int ret; 1302 1303 dbg_hid("HID probe called for ifnum %d\n", 1304 intf->altsetting->desc.bInterfaceNumber); 1305 1306 for (n = 0; n < interface->desc.bNumEndpoints; n++) 1307 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc)) 1308 has_in++; 1309 if (!has_in) { 1310 hid_err(intf, "couldn't find an input interrupt endpoint\n"); 1311 return -ENODEV; 1312 } 1313 1314 hid = hid_allocate_device(); 1315 if (IS_ERR(hid)) 1316 return PTR_ERR(hid); 1317 1318 usb_set_intfdata(intf, hid); 1319 hid->ll_driver = &usb_hid_driver; 1320 hid->ff_init = hid_pidff_init; 1321 #ifdef CONFIG_USB_HIDDEV 1322 hid->hiddev_connect = hiddev_connect; 1323 hid->hiddev_disconnect = hiddev_disconnect; 1324 hid->hiddev_hid_event = hiddev_hid_event; 1325 hid->hiddev_report_event = hiddev_report_event; 1326 #endif 1327 hid->dev.parent = &intf->dev; 1328 hid->bus = BUS_USB; 1329 hid->vendor = le16_to_cpu(dev->descriptor.idVendor); 1330 hid->product = le16_to_cpu(dev->descriptor.idProduct); 1331 hid->name[0] = 0; 1332 hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product); 1333 if (intf->cur_altsetting->desc.bInterfaceProtocol == 1334 USB_INTERFACE_PROTOCOL_MOUSE) 1335 hid->type = HID_TYPE_USBMOUSE; 1336 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0) 1337 hid->type = HID_TYPE_USBNONE; 1338 1339 if (dev->manufacturer) 1340 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name)); 1341 1342 if (dev->product) { 1343 if (dev->manufacturer) 1344 strlcat(hid->name, " ", sizeof(hid->name)); 1345 strlcat(hid->name, dev->product, sizeof(hid->name)); 1346 } 1347 1348 if (!strlen(hid->name)) 1349 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x", 1350 le16_to_cpu(dev->descriptor.idVendor), 1351 le16_to_cpu(dev->descriptor.idProduct)); 1352 1353 usb_make_path(dev, hid->phys, sizeof(hid->phys)); 1354 strlcat(hid->phys, "/input", sizeof(hid->phys)); 1355 len = strlen(hid->phys); 1356 if (len < sizeof(hid->phys) - 1) 1357 snprintf(hid->phys + len, sizeof(hid->phys) - len, 1358 "%d", intf->altsetting[0].desc.bInterfaceNumber); 1359 1360 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0) 1361 hid->uniq[0] = 0; 1362 1363 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL); 1364 if (usbhid == NULL) { 1365 ret = -ENOMEM; 1366 goto err; 1367 } 1368 1369 hid->driver_data = usbhid; 1370 usbhid->hid = hid; 1371 usbhid->intf = intf; 1372 usbhid->ifnum = interface->desc.bInterfaceNumber; 1373 1374 init_waitqueue_head(&usbhid->wait); 1375 INIT_WORK(&usbhid->reset_work, hid_reset); 1376 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid); 1377 spin_lock_init(&usbhid->lock); 1378 1379 ret = hid_add_device(hid); 1380 if (ret) { 1381 if (ret != -ENODEV) 1382 hid_err(intf, "can't add hid device: %d\n", ret); 1383 goto err_free; 1384 } 1385 1386 return 0; 1387 err_free: 1388 kfree(usbhid); 1389 err: 1390 hid_destroy_device(hid); 1391 return ret; 1392 } 1393 1394 static void usbhid_disconnect(struct usb_interface *intf) 1395 { 1396 struct hid_device *hid = usb_get_intfdata(intf); 1397 struct usbhid_device *usbhid; 1398 1399 if (WARN_ON(!hid)) 1400 return; 1401 1402 usbhid = hid->driver_data; 1403 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */ 1404 set_bit(HID_DISCONNECTED, &usbhid->iofl); 1405 spin_unlock_irq(&usbhid->lock); 1406 hid_destroy_device(hid); 1407 kfree(usbhid); 1408 } 1409 1410 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid) 1411 { 1412 del_timer_sync(&usbhid->io_retry); 1413 cancel_work_sync(&usbhid->reset_work); 1414 } 1415 1416 static void hid_cease_io(struct usbhid_device *usbhid) 1417 { 1418 del_timer_sync(&usbhid->io_retry); 1419 usb_kill_urb(usbhid->urbin); 1420 usb_kill_urb(usbhid->urbctrl); 1421 usb_kill_urb(usbhid->urbout); 1422 } 1423 1424 static void hid_restart_io(struct hid_device *hid) 1425 { 1426 struct usbhid_device *usbhid = hid->driver_data; 1427 int clear_halt = test_bit(HID_CLEAR_HALT, &usbhid->iofl); 1428 int reset_pending = test_bit(HID_RESET_PENDING, &usbhid->iofl); 1429 1430 spin_lock_irq(&usbhid->lock); 1431 clear_bit(HID_SUSPENDED, &usbhid->iofl); 1432 usbhid_mark_busy(usbhid); 1433 1434 if (clear_halt || reset_pending) 1435 schedule_work(&usbhid->reset_work); 1436 usbhid->retry_delay = 0; 1437 spin_unlock_irq(&usbhid->lock); 1438 1439 if (reset_pending || !test_bit(HID_STARTED, &usbhid->iofl)) 1440 return; 1441 1442 if (!clear_halt) { 1443 if (hid_start_in(hid) < 0) 1444 hid_io_error(hid); 1445 } 1446 1447 spin_lock_irq(&usbhid->lock); 1448 if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)) 1449 usbhid_restart_out_queue(usbhid); 1450 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) 1451 usbhid_restart_ctrl_queue(usbhid); 1452 spin_unlock_irq(&usbhid->lock); 1453 } 1454 1455 /* Treat USB reset pretty much the same as suspend/resume */ 1456 static int hid_pre_reset(struct usb_interface *intf) 1457 { 1458 struct hid_device *hid = usb_get_intfdata(intf); 1459 struct usbhid_device *usbhid = hid->driver_data; 1460 1461 spin_lock_irq(&usbhid->lock); 1462 set_bit(HID_RESET_PENDING, &usbhid->iofl); 1463 spin_unlock_irq(&usbhid->lock); 1464 hid_cease_io(usbhid); 1465 1466 return 0; 1467 } 1468 1469 /* Same routine used for post_reset and reset_resume */ 1470 static int hid_post_reset(struct usb_interface *intf) 1471 { 1472 struct usb_device *dev = interface_to_usbdev (intf); 1473 struct hid_device *hid = usb_get_intfdata(intf); 1474 struct usbhid_device *usbhid = hid->driver_data; 1475 struct usb_host_interface *interface = intf->cur_altsetting; 1476 int status; 1477 char *rdesc; 1478 1479 /* Fetch and examine the HID report descriptor. If this 1480 * has changed, then rebind. Since usbcore's check of the 1481 * configuration descriptors passed, we already know that 1482 * the size of the HID report descriptor has not changed. 1483 */ 1484 rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL); 1485 if (!rdesc) 1486 return -ENOMEM; 1487 1488 status = hid_get_class_descriptor(dev, 1489 interface->desc.bInterfaceNumber, 1490 HID_DT_REPORT, rdesc, hid->dev_rsize); 1491 if (status < 0) { 1492 dbg_hid("reading report descriptor failed (post_reset)\n"); 1493 kfree(rdesc); 1494 return status; 1495 } 1496 status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize); 1497 kfree(rdesc); 1498 if (status != 0) { 1499 dbg_hid("report descriptor changed\n"); 1500 return -EPERM; 1501 } 1502 1503 /* No need to do another reset or clear a halted endpoint */ 1504 spin_lock_irq(&usbhid->lock); 1505 clear_bit(HID_RESET_PENDING, &usbhid->iofl); 1506 clear_bit(HID_CLEAR_HALT, &usbhid->iofl); 1507 spin_unlock_irq(&usbhid->lock); 1508 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0); 1509 1510 hid_restart_io(hid); 1511 1512 return 0; 1513 } 1514 1515 #ifdef CONFIG_PM 1516 static int hid_resume_common(struct hid_device *hid, bool driver_suspended) 1517 { 1518 int status = 0; 1519 1520 hid_restart_io(hid); 1521 if (driver_suspended && hid->driver && hid->driver->resume) 1522 status = hid->driver->resume(hid); 1523 return status; 1524 } 1525 1526 static int hid_suspend(struct usb_interface *intf, pm_message_t message) 1527 { 1528 struct hid_device *hid = usb_get_intfdata(intf); 1529 struct usbhid_device *usbhid = hid->driver_data; 1530 int status = 0; 1531 bool driver_suspended = false; 1532 unsigned int ledcount; 1533 1534 if (PMSG_IS_AUTO(message)) { 1535 ledcount = hidinput_count_leds(hid); 1536 spin_lock_irq(&usbhid->lock); /* Sync with error handler */ 1537 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl) 1538 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl) 1539 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl) 1540 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl) 1541 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl) 1542 && (!ledcount || ignoreled)) 1543 { 1544 set_bit(HID_SUSPENDED, &usbhid->iofl); 1545 spin_unlock_irq(&usbhid->lock); 1546 if (hid->driver && hid->driver->suspend) { 1547 status = hid->driver->suspend(hid, message); 1548 if (status < 0) 1549 goto failed; 1550 } 1551 driver_suspended = true; 1552 } else { 1553 usbhid_mark_busy(usbhid); 1554 spin_unlock_irq(&usbhid->lock); 1555 return -EBUSY; 1556 } 1557 1558 } else { 1559 /* TODO: resume() might need to handle suspend failure */ 1560 if (hid->driver && hid->driver->suspend) 1561 status = hid->driver->suspend(hid, message); 1562 driver_suspended = true; 1563 spin_lock_irq(&usbhid->lock); 1564 set_bit(HID_SUSPENDED, &usbhid->iofl); 1565 spin_unlock_irq(&usbhid->lock); 1566 if (usbhid_wait_io(hid) < 0) 1567 status = -EIO; 1568 } 1569 1570 hid_cancel_delayed_stuff(usbhid); 1571 hid_cease_io(usbhid); 1572 1573 if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) { 1574 /* lost race against keypresses */ 1575 status = -EBUSY; 1576 goto failed; 1577 } 1578 dev_dbg(&intf->dev, "suspend\n"); 1579 return status; 1580 1581 failed: 1582 hid_resume_common(hid, driver_suspended); 1583 return status; 1584 } 1585 1586 static int hid_resume(struct usb_interface *intf) 1587 { 1588 struct hid_device *hid = usb_get_intfdata (intf); 1589 int status; 1590 1591 status = hid_resume_common(hid, true); 1592 dev_dbg(&intf->dev, "resume status %d\n", status); 1593 return 0; 1594 } 1595 1596 static int hid_reset_resume(struct usb_interface *intf) 1597 { 1598 struct hid_device *hid = usb_get_intfdata(intf); 1599 int status; 1600 1601 status = hid_post_reset(intf); 1602 if (status >= 0 && hid->driver && hid->driver->reset_resume) { 1603 int ret = hid->driver->reset_resume(hid); 1604 if (ret < 0) 1605 status = ret; 1606 } 1607 return status; 1608 } 1609 1610 #endif /* CONFIG_PM */ 1611 1612 static const struct usb_device_id hid_usb_ids[] = { 1613 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS, 1614 .bInterfaceClass = USB_INTERFACE_CLASS_HID }, 1615 { } /* Terminating entry */ 1616 }; 1617 1618 MODULE_DEVICE_TABLE (usb, hid_usb_ids); 1619 1620 static struct usb_driver hid_driver = { 1621 .name = "usbhid", 1622 .probe = usbhid_probe, 1623 .disconnect = usbhid_disconnect, 1624 #ifdef CONFIG_PM 1625 .suspend = hid_suspend, 1626 .resume = hid_resume, 1627 .reset_resume = hid_reset_resume, 1628 #endif 1629 .pre_reset = hid_pre_reset, 1630 .post_reset = hid_post_reset, 1631 .id_table = hid_usb_ids, 1632 .supports_autosuspend = 1, 1633 }; 1634 1635 struct usb_interface *usbhid_find_interface(int minor) 1636 { 1637 return usb_find_interface(&hid_driver, minor); 1638 } 1639 1640 static int __init hid_init(void) 1641 { 1642 int retval = -ENOMEM; 1643 1644 retval = usbhid_quirks_init(quirks_param); 1645 if (retval) 1646 goto usbhid_quirks_init_fail; 1647 retval = usb_register(&hid_driver); 1648 if (retval) 1649 goto usb_register_fail; 1650 pr_info(KBUILD_MODNAME ": " DRIVER_DESC "\n"); 1651 1652 return 0; 1653 usb_register_fail: 1654 usbhid_quirks_exit(); 1655 usbhid_quirks_init_fail: 1656 return retval; 1657 } 1658 1659 static void __exit hid_exit(void) 1660 { 1661 usb_deregister(&hid_driver); 1662 usbhid_quirks_exit(); 1663 } 1664 1665 module_init(hid_init); 1666 module_exit(hid_exit); 1667 1668 MODULE_AUTHOR("Andreas Gal"); 1669 MODULE_AUTHOR("Vojtech Pavlik"); 1670 MODULE_AUTHOR("Jiri Kosina"); 1671 MODULE_DESCRIPTION(DRIVER_DESC); 1672 MODULE_LICENSE("GPL"); 1673