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