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