2 * USB HID support for Linux
4 * Copyright (c) 1999 Andreas Gal
5 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7 * Copyright (c) 2007-2008 Oliver Neukum
8 * Copyright (c) 2006-2010 Jiri Kosina
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 2 of the License, or (at your option)
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/init.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
24 #include <linux/mutex.h>
25 #include <linux/spinlock.h>
26 #include <asm/unaligned.h>
27 #include <asm/byteorder.h>
28 #include <linux/input.h>
29 #include <linux/wait.h>
30 #include <linux/workqueue.h>
31 #include <linux/string.h>
33 #include <linux/usb.h>
35 #include <linux/hid.h>
36 #include <linux/hiddev.h>
37 #include <linux/hid-debug.h>
38 #include <linux/hidraw.h>
45 #define DRIVER_DESC "USB HID core driver"
46 #define DRIVER_LICENSE "GPL"
52 static unsigned int hid_mousepoll_interval;
53 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
54 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
56 static unsigned int ignoreled;
57 module_param_named(ignoreled, ignoreled, uint, 0644);
58 MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
60 /* Quirks specified at module load time */
61 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS];
62 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
63 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
64 " quirks=vendorID:productID:quirks"
65 " where vendorID, productID, and quirks are all in"
68 * Input submission and I/O error handler.
70 static DEFINE_MUTEX(hid_open_mut);
72 static void hid_io_error(struct hid_device *hid);
73 static int hid_submit_out(struct hid_device *hid);
74 static int hid_submit_ctrl(struct hid_device *hid);
75 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
77 /* Start up the input URB */
78 static int hid_start_in(struct hid_device *hid)
82 struct usbhid_device *usbhid = hid->driver_data;
84 spin_lock_irqsave(&usbhid->lock, flags);
85 if ((hid->open > 0 || hid->quirks & HID_QUIRK_ALWAYS_POLL) &&
86 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
87 !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
88 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
89 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
91 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
93 set_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
95 clear_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
98 spin_unlock_irqrestore(&usbhid->lock, flags);
102 /* I/O retry timer routine */
103 static void hid_retry_timeout(unsigned long _hid)
105 struct hid_device *hid = (struct hid_device *) _hid;
106 struct usbhid_device *usbhid = hid->driver_data;
108 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
109 if (hid_start_in(hid))
113 /* Workqueue routine to reset the device or clear a halt */
114 static void hid_reset(struct work_struct *work)
116 struct usbhid_device *usbhid =
117 container_of(work, struct usbhid_device, reset_work);
118 struct hid_device *hid = usbhid->hid;
121 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
122 dev_dbg(&usbhid->intf->dev, "clear halt\n");
123 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
124 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
128 dev_dbg(&usbhid->intf->dev,
129 "clear-halt failed: %d\n", rc);
130 set_bit(HID_RESET_PENDING, &usbhid->iofl);
134 if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
135 dev_dbg(&usbhid->intf->dev, "resetting device\n");
136 usb_queue_reset_device(usbhid->intf);
140 /* Main I/O error handler */
141 static void hid_io_error(struct hid_device *hid)
144 struct usbhid_device *usbhid = hid->driver_data;
146 spin_lock_irqsave(&usbhid->lock, flags);
148 /* Stop when disconnected */
149 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
152 /* If it has been a while since the last error, we'll assume
153 * this a brand new error and reset the retry timeout. */
154 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
155 usbhid->retry_delay = 0;
157 /* When an error occurs, retry at increasing intervals */
158 if (usbhid->retry_delay == 0) {
159 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
160 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
161 } else if (usbhid->retry_delay < 100)
162 usbhid->retry_delay *= 2;
164 if (time_after(jiffies, usbhid->stop_retry)) {
166 /* Retries failed, so do a port reset unless we lack bandwidth*/
167 if (!test_bit(HID_NO_BANDWIDTH, &usbhid->iofl)
168 && !test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
170 schedule_work(&usbhid->reset_work);
175 mod_timer(&usbhid->io_retry,
176 jiffies + msecs_to_jiffies(usbhid->retry_delay));
178 spin_unlock_irqrestore(&usbhid->lock, flags);
181 static void usbhid_mark_busy(struct usbhid_device *usbhid)
183 struct usb_interface *intf = usbhid->intf;
185 usb_mark_last_busy(interface_to_usbdev(intf));
188 static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
190 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
194 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
195 test_bit(HID_SUSPENDED, &usbhid->iofl))
198 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
199 hid_dbg(hid, "Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
201 /* Try to wake up from autosuspend... */
202 r = usb_autopm_get_interface_async(usbhid->intf);
207 * If still suspended, don't submit. Submission will
208 * occur if/when resume drains the queue.
210 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
211 usb_autopm_put_interface_no_suspend(usbhid->intf);
215 /* Asynchronously flush queue. */
216 set_bit(HID_OUT_RUNNING, &usbhid->iofl);
217 if (hid_submit_out(hid)) {
218 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
219 usb_autopm_put_interface_async(usbhid->intf);
221 wake_up(&usbhid->wait);
226 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
228 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
232 WARN_ON(hid == NULL);
233 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
234 test_bit(HID_SUSPENDED, &usbhid->iofl))
237 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
238 hid_dbg(hid, "Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
240 /* Try to wake up from autosuspend... */
241 r = usb_autopm_get_interface_async(usbhid->intf);
246 * If still suspended, don't submit. Submission will
247 * occur if/when resume drains the queue.
249 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
250 usb_autopm_put_interface_no_suspend(usbhid->intf);
254 /* Asynchronously flush queue. */
255 set_bit(HID_CTRL_RUNNING, &usbhid->iofl);
256 if (hid_submit_ctrl(hid)) {
257 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
258 usb_autopm_put_interface_async(usbhid->intf);
260 wake_up(&usbhid->wait);
266 * Input interrupt completion handler.
269 static void hid_irq_in(struct urb *urb)
271 struct hid_device *hid = urb->context;
272 struct usbhid_device *usbhid = hid->driver_data;
275 switch (urb->status) {
276 case 0: /* success */
277 usbhid->retry_delay = 0;
278 if ((hid->quirks & HID_QUIRK_ALWAYS_POLL) && !hid->open)
280 usbhid_mark_busy(usbhid);
281 if (!test_bit(HID_RESUME_RUNNING, &usbhid->iofl)) {
282 hid_input_report(urb->context, HID_INPUT_REPORT,
283 urb->transfer_buffer,
284 urb->actual_length, 1);
286 * autosuspend refused while keys are pressed
287 * because most keyboards don't wake up when
290 if (hid_check_keys_pressed(hid))
291 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
293 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
296 case -EPIPE: /* stall */
297 usbhid_mark_busy(usbhid);
298 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
299 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
300 schedule_work(&usbhid->reset_work);
302 case -ECONNRESET: /* unlink */
304 case -ESHUTDOWN: /* unplug */
305 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
307 case -EILSEQ: /* protocol error or unplug */
308 case -EPROTO: /* protocol error or unplug */
309 case -ETIME: /* protocol error or unplug */
310 case -ETIMEDOUT: /* Should never happen, but... */
311 usbhid_mark_busy(usbhid);
312 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
316 hid_warn(urb->dev, "input irq status %d received\n",
320 status = usb_submit_urb(urb, GFP_ATOMIC);
322 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
323 if (status != -EPERM) {
324 hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n",
325 hid_to_usb_dev(hid)->bus->bus_name,
326 hid_to_usb_dev(hid)->devpath,
327 usbhid->ifnum, status);
333 static int hid_submit_out(struct hid_device *hid)
335 struct hid_report *report;
337 struct usbhid_device *usbhid = hid->driver_data;
340 report = usbhid->out[usbhid->outtail].report;
341 raw_report = usbhid->out[usbhid->outtail].raw_report;
343 usbhid->urbout->transfer_buffer_length = hid_report_len(report);
344 usbhid->urbout->dev = hid_to_usb_dev(hid);
346 memcpy(usbhid->outbuf, raw_report,
347 usbhid->urbout->transfer_buffer_length);
349 usbhid->out[usbhid->outtail].raw_report = NULL;
352 dbg_hid("submitting out urb\n");
354 r = usb_submit_urb(usbhid->urbout, GFP_ATOMIC);
356 hid_err(hid, "usb_submit_urb(out) failed: %d\n", r);
359 usbhid->last_out = jiffies;
363 static int hid_submit_ctrl(struct hid_device *hid)
365 struct hid_report *report;
369 struct usbhid_device *usbhid = hid->driver_data;
371 report = usbhid->ctrl[usbhid->ctrltail].report;
372 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
373 dir = usbhid->ctrl[usbhid->ctrltail].dir;
375 len = hid_report_len(report);
376 if (dir == USB_DIR_OUT) {
377 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
378 usbhid->urbctrl->transfer_buffer_length = len;
380 memcpy(usbhid->ctrlbuf, raw_report, len);
382 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
385 int maxpacket, padlen;
387 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
388 maxpacket = usb_maxpacket(hid_to_usb_dev(hid),
389 usbhid->urbctrl->pipe, 0);
391 padlen = DIV_ROUND_UP(len, maxpacket);
393 if (padlen > usbhid->bufsize)
394 padlen = usbhid->bufsize;
397 usbhid->urbctrl->transfer_buffer_length = padlen;
399 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
401 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
402 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT :
404 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) |
406 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
407 usbhid->cr->wLength = cpu_to_le16(len);
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" :
412 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
414 r = usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC);
416 hid_err(hid, "usb_submit_urb(ctrl) failed: %d\n", r);
419 usbhid->last_ctrl = jiffies;
424 * Output interrupt completion handler.
427 static void hid_irq_out(struct urb *urb)
429 struct hid_device *hid = urb->context;
430 struct usbhid_device *usbhid = hid->driver_data;
434 switch (urb->status) {
435 case 0: /* success */
437 case -ESHUTDOWN: /* unplug */
439 case -EILSEQ: /* protocol error or unplug */
440 case -EPROTO: /* protocol error or unplug */
441 case -ECONNRESET: /* unlink */
445 hid_warn(urb->dev, "output irq status %d received\n",
449 spin_lock_irqsave(&usbhid->lock, flags);
452 usbhid->outtail = usbhid->outhead;
454 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
456 if (usbhid->outhead != usbhid->outtail &&
457 hid_submit_out(hid) == 0) {
458 /* Successfully submitted next urb in queue */
459 spin_unlock_irqrestore(&usbhid->lock, flags);
464 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
465 spin_unlock_irqrestore(&usbhid->lock, flags);
466 usb_autopm_put_interface_async(usbhid->intf);
467 wake_up(&usbhid->wait);
471 * Control pipe completion handler.
474 static void hid_ctrl(struct urb *urb)
476 struct hid_device *hid = urb->context;
477 struct usbhid_device *usbhid = hid->driver_data;
478 int unplug = 0, status = urb->status;
481 case 0: /* success */
482 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
483 hid_input_report(urb->context,
484 usbhid->ctrl[usbhid->ctrltail].report->type,
485 urb->transfer_buffer, urb->actual_length, 0);
487 case -ESHUTDOWN: /* unplug */
489 case -EILSEQ: /* protocol error or unplug */
490 case -EPROTO: /* protocol error or unplug */
491 case -ECONNRESET: /* unlink */
493 case -EPIPE: /* report not available */
496 hid_warn(urb->dev, "ctrl urb status %d received\n", status);
499 spin_lock(&usbhid->lock);
502 usbhid->ctrltail = usbhid->ctrlhead;
503 } else if (usbhid->ctrlhead != usbhid->ctrltail) {
504 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
506 if (usbhid->ctrlhead != usbhid->ctrltail &&
507 hid_submit_ctrl(hid) == 0) {
508 /* Successfully submitted next urb in queue */
509 spin_unlock(&usbhid->lock);
514 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
515 spin_unlock(&usbhid->lock);
516 usb_autopm_put_interface_async(usbhid->intf);
517 wake_up(&usbhid->wait);
520 static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
524 struct usbhid_device *usbhid = hid->driver_data;
526 if (((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN) ||
527 test_bit(HID_DISCONNECTED, &usbhid->iofl))
530 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
531 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
532 hid_warn(hid, "output queue full\n");
536 usbhid->out[usbhid->outhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
537 if (!usbhid->out[usbhid->outhead].raw_report) {
538 hid_warn(hid, "output queueing failed\n");
541 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
542 usbhid->out[usbhid->outhead].report = report;
543 usbhid->outhead = head;
545 /* If the queue isn't running, restart it */
546 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
547 usbhid_restart_out_queue(usbhid);
549 /* Otherwise see if an earlier request has timed out */
550 } else if (time_after(jiffies, usbhid->last_out + HZ * 5)) {
552 /* Prevent autosuspend following the unlink */
553 usb_autopm_get_interface_no_resume(usbhid->intf);
556 * Prevent resubmission in case the URB completes
557 * before we can unlink it. We don't want to cancel
558 * the wrong transfer!
560 usb_block_urb(usbhid->urbout);
562 /* Drop lock to avoid deadlock if the callback runs */
563 spin_unlock(&usbhid->lock);
565 usb_unlink_urb(usbhid->urbout);
566 spin_lock(&usbhid->lock);
567 usb_unblock_urb(usbhid->urbout);
569 /* Unlink might have stopped the queue */
570 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl))
571 usbhid_restart_out_queue(usbhid);
573 /* Now we can allow autosuspend again */
574 usb_autopm_put_interface_async(usbhid->intf);
579 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
580 hid_warn(hid, "control queue full\n");
584 if (dir == USB_DIR_OUT) {
585 usbhid->ctrl[usbhid->ctrlhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
586 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
587 hid_warn(hid, "control queueing failed\n");
590 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
592 usbhid->ctrl[usbhid->ctrlhead].report = report;
593 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
594 usbhid->ctrlhead = head;
596 /* If the queue isn't running, restart it */
597 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
598 usbhid_restart_ctrl_queue(usbhid);
600 /* Otherwise see if an earlier request has timed out */
601 } else if (time_after(jiffies, usbhid->last_ctrl + HZ * 5)) {
603 /* Prevent autosuspend following the unlink */
604 usb_autopm_get_interface_no_resume(usbhid->intf);
607 * Prevent resubmission in case the URB completes
608 * before we can unlink it. We don't want to cancel
609 * the wrong transfer!
611 usb_block_urb(usbhid->urbctrl);
613 /* Drop lock to avoid deadlock if the callback runs */
614 spin_unlock(&usbhid->lock);
616 usb_unlink_urb(usbhid->urbctrl);
617 spin_lock(&usbhid->lock);
618 usb_unblock_urb(usbhid->urbctrl);
620 /* Unlink might have stopped the queue */
621 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
622 usbhid_restart_ctrl_queue(usbhid);
624 /* Now we can allow autosuspend again */
625 usb_autopm_put_interface_async(usbhid->intf);
629 static void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
631 struct usbhid_device *usbhid = hid->driver_data;
634 spin_lock_irqsave(&usbhid->lock, flags);
635 __usbhid_submit_report(hid, report, dir);
636 spin_unlock_irqrestore(&usbhid->lock, flags);
639 static int usbhid_wait_io(struct hid_device *hid)
641 struct usbhid_device *usbhid = hid->driver_data;
643 if (!wait_event_timeout(usbhid->wait,
644 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
645 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
647 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
654 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
656 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
657 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
658 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
661 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
662 unsigned char type, void *buf, int size)
664 int result, retries = 4;
666 memset(buf, 0, size);
669 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
670 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
671 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
673 } while (result < size && retries);
677 int usbhid_open(struct hid_device *hid)
679 struct usbhid_device *usbhid = hid->driver_data;
682 mutex_lock(&hid_open_mut);
684 res = usb_autopm_get_interface(usbhid->intf);
685 /* the device must be awake to reliably request remote wakeup */
691 usbhid->intf->needs_remote_wakeup = 1;
692 set_bit(HID_RESUME_RUNNING, &usbhid->iofl);
693 res = hid_start_in(hid);
695 if (res != -ENOSPC) {
699 /* no use opening if resources are insufficient */
702 usbhid->intf->needs_remote_wakeup = 0;
705 usb_autopm_put_interface(usbhid->intf);
708 * In case events are generated while nobody was listening,
709 * some are released when the device is re-opened.
710 * Wait 50 msec for the queue to empty before allowing events
713 if (res == 0 && !(hid->quirks & HID_QUIRK_ALWAYS_POLL))
715 clear_bit(HID_RESUME_RUNNING, &usbhid->iofl);
718 mutex_unlock(&hid_open_mut);
722 void usbhid_close(struct hid_device *hid)
724 struct usbhid_device *usbhid = hid->driver_data;
726 mutex_lock(&hid_open_mut);
728 /* protecting hid->open to make sure we don't restart
729 * data acquistion due to a resumption we no longer
732 spin_lock_irq(&usbhid->lock);
734 spin_unlock_irq(&usbhid->lock);
735 hid_cancel_delayed_stuff(usbhid);
736 if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL)) {
737 usb_kill_urb(usbhid->urbin);
738 usbhid->intf->needs_remote_wakeup = 0;
741 spin_unlock_irq(&usbhid->lock);
743 mutex_unlock(&hid_open_mut);
747 * Initialize all reports
750 void usbhid_init_reports(struct hid_device *hid)
752 struct hid_report *report;
753 struct usbhid_device *usbhid = hid->driver_data;
754 struct hid_report_enum *report_enum;
757 if (!(hid->quirks & HID_QUIRK_NO_INIT_INPUT_REPORTS)) {
758 report_enum = &hid->report_enum[HID_INPUT_REPORT];
759 list_for_each_entry(report, &report_enum->report_list, list)
760 usbhid_submit_report(hid, report, USB_DIR_IN);
763 report_enum = &hid->report_enum[HID_FEATURE_REPORT];
764 list_for_each_entry(report, &report_enum->report_list, list)
765 usbhid_submit_report(hid, report, USB_DIR_IN);
768 ret = usbhid_wait_io(hid);
771 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
772 usb_kill_urb(usbhid->urbctrl);
773 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
774 usb_kill_urb(usbhid->urbout);
775 ret = usbhid_wait_io(hid);
779 hid_warn(hid, "timeout initializing reports\n");
783 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
785 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
786 unsigned int hid_code, struct hid_field **pfield)
788 struct hid_report *report;
789 struct hid_field *field;
790 struct hid_usage *usage;
793 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
794 for (i = 0; i < report->maxfield; i++) {
795 field = report->field[i];
796 for (j = 0; j < field->maxusage; j++) {
797 usage = &field->usage[j];
798 if ((usage->hid & HID_USAGE_PAGE) == page &&
799 (usage->hid & 0xFFFF) == hid_code) {
809 static void usbhid_set_leds(struct hid_device *hid)
811 struct hid_field *field;
814 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
815 hid_set_field(field, offset, 0);
816 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
821 * Traverse the supplied list of reports and find the longest
823 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
826 struct hid_report *report;
829 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
830 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
836 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
838 struct usbhid_device *usbhid = hid->driver_data;
840 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
842 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
843 &usbhid->outbuf_dma);
844 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
845 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
846 &usbhid->ctrlbuf_dma);
847 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
854 static int usbhid_get_raw_report(struct hid_device *hid,
855 unsigned char report_number, __u8 *buf, size_t count,
856 unsigned char report_type)
858 struct usbhid_device *usbhid = hid->driver_data;
859 struct usb_device *dev = hid_to_usb_dev(hid);
860 struct usb_interface *intf = usbhid->intf;
861 struct usb_host_interface *interface = intf->cur_altsetting;
862 int skipped_report_id = 0;
865 /* Byte 0 is the report number. Report data starts at byte 1.*/
866 buf[0] = report_number;
867 if (report_number == 0x0) {
868 /* Offset the return buffer by 1, so that the report ID
869 will remain in byte 0. */
872 skipped_report_id = 1;
874 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
876 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
877 ((report_type + 1) << 8) | report_number,
878 interface->desc.bInterfaceNumber, buf, count,
879 USB_CTRL_SET_TIMEOUT);
881 /* count also the report id */
882 if (ret > 0 && skipped_report_id)
888 static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum,
889 __u8 *buf, size_t count, unsigned char rtype)
891 struct usbhid_device *usbhid = hid->driver_data;
892 struct usb_device *dev = hid_to_usb_dev(hid);
893 struct usb_interface *intf = usbhid->intf;
894 struct usb_host_interface *interface = intf->cur_altsetting;
895 int ret, skipped_report_id = 0;
897 /* Byte 0 is the report number. Report data starts at byte 1.*/
898 if ((rtype == HID_OUTPUT_REPORT) &&
899 (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID))
905 /* Don't send the Report ID */
908 skipped_report_id = 1;
911 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
913 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
914 ((rtype + 1) << 8) | reportnum,
915 interface->desc.bInterfaceNumber, buf, count,
916 USB_CTRL_SET_TIMEOUT);
917 /* count also the report id, if this was a numbered report. */
918 if (ret > 0 && skipped_report_id)
924 static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count)
926 struct usbhid_device *usbhid = hid->driver_data;
927 struct usb_device *dev = hid_to_usb_dev(hid);
928 int actual_length, skipped_report_id = 0, ret;
934 /* Don't send the Report ID */
937 skipped_report_id = 1;
940 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
941 buf, count, &actual_length,
942 USB_CTRL_SET_TIMEOUT);
943 /* return the number of bytes transferred */
946 /* count also the report id */
947 if (skipped_report_id)
954 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
956 struct usbhid_device *usbhid = hid->driver_data;
958 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
959 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
961 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
964 static int usbhid_parse(struct hid_device *hid)
966 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
967 struct usb_host_interface *interface = intf->cur_altsetting;
968 struct usb_device *dev = interface_to_usbdev (intf);
969 struct hid_descriptor *hdesc;
971 unsigned int rsize = 0;
975 size_t offset = offsetof(struct hid_descriptor, desc);
977 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
978 le16_to_cpu(dev->descriptor.idProduct));
980 if (quirks & HID_QUIRK_IGNORE)
983 /* Many keyboards and mice don't like to be polled for reports,
984 * so we will always set the HID_QUIRK_NOGET flag for them. */
985 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
986 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
987 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
988 quirks |= HID_QUIRK_NOGET;
991 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
992 (!interface->desc.bNumEndpoints ||
993 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
994 dbg_hid("class descriptor not present\n");
998 if (hdesc->bLength < sizeof(struct hid_descriptor)) {
999 dbg_hid("hid descriptor is too short\n");
1003 hid->version = le16_to_cpu(hdesc->bcdHID);
1004 hid->country = hdesc->bCountryCode;
1006 num_descriptors = min_t(int, hdesc->bNumDescriptors,
1007 (hdesc->bLength - offset) / sizeof(struct hid_class_descriptor));
1009 for (n = 0; n < num_descriptors; n++)
1010 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1011 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1013 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1014 dbg_hid("weird size of report descriptor (%u)\n", rsize);
1018 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
1019 dbg_hid("couldn't allocate rdesc memory\n");
1023 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1025 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
1026 HID_DT_REPORT, rdesc, rsize);
1028 dbg_hid("reading report descriptor failed\n");
1033 ret = hid_parse_report(hid, rdesc, rsize);
1036 dbg_hid("parsing report descriptor failed\n");
1040 hid->quirks |= quirks;
1047 static int usbhid_start(struct hid_device *hid)
1049 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1050 struct usb_host_interface *interface = intf->cur_altsetting;
1051 struct usb_device *dev = interface_to_usbdev(intf);
1052 struct usbhid_device *usbhid = hid->driver_data;
1053 unsigned int n, insize = 0;
1056 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
1058 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
1059 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
1060 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
1061 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
1063 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
1064 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
1066 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1068 if (insize > HID_MAX_BUFFER_SIZE)
1069 insize = HID_MAX_BUFFER_SIZE;
1071 if (hid_alloc_buffers(dev, hid)) {
1076 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1077 struct usb_endpoint_descriptor *endpoint;
1081 endpoint = &interface->endpoint[n].desc;
1082 if (!usb_endpoint_xfer_int(endpoint))
1085 interval = endpoint->bInterval;
1087 /* Some vendors give fullspeed interval on highspeed devides */
1088 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
1089 dev->speed == USB_SPEED_HIGH) {
1090 interval = fls(endpoint->bInterval*8);
1091 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1092 hid->name, endpoint->bInterval, interval);
1095 /* Change the polling interval of mice. */
1096 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1097 interval = hid_mousepoll_interval;
1100 if (usb_endpoint_dir_in(endpoint)) {
1103 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1105 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1106 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
1107 hid_irq_in, hid, interval);
1108 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1109 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1113 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1115 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1116 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
1117 hid_irq_out, hid, interval);
1118 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1119 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1123 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1124 if (!usbhid->urbctrl) {
1129 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1130 usbhid->ctrlbuf, 1, hid_ctrl, hid);
1131 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1132 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1134 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1135 usbhid_init_reports(hid);
1137 set_bit(HID_STARTED, &usbhid->iofl);
1139 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1140 ret = usb_autopm_get_interface(usbhid->intf);
1143 usbhid->intf->needs_remote_wakeup = 1;
1144 ret = hid_start_in(hid);
1147 "failed to start in urb: %d\n", ret);
1149 usb_autopm_put_interface(usbhid->intf);
1152 /* Some keyboards don't work until their LEDs have been set.
1153 * Since BIOSes do set the LEDs, it must be safe for any device
1154 * that supports the keyboard boot protocol.
1155 * In addition, enable remote wakeup by default for all keyboard
1156 * devices supporting the boot protocol.
1158 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1159 interface->desc.bInterfaceProtocol ==
1160 USB_INTERFACE_PROTOCOL_KEYBOARD) {
1161 usbhid_set_leds(hid);
1162 device_set_wakeup_enable(&dev->dev, 1);
1167 usb_free_urb(usbhid->urbin);
1168 usb_free_urb(usbhid->urbout);
1169 usb_free_urb(usbhid->urbctrl);
1170 usbhid->urbin = NULL;
1171 usbhid->urbout = NULL;
1172 usbhid->urbctrl = NULL;
1173 hid_free_buffers(dev, hid);
1177 static void usbhid_stop(struct hid_device *hid)
1179 struct usbhid_device *usbhid = hid->driver_data;
1181 if (WARN_ON(!usbhid))
1184 if (hid->quirks & HID_QUIRK_ALWAYS_POLL)
1185 usbhid->intf->needs_remote_wakeup = 0;
1187 clear_bit(HID_STARTED, &usbhid->iofl);
1189 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
1190 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1191 while (usbhid->ctrltail != usbhid->ctrlhead) {
1192 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_OUT) {
1193 kfree(usbhid->ctrl[usbhid->ctrltail].raw_report);
1194 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
1197 usbhid->ctrltail = (usbhid->ctrltail + 1) &
1198 (HID_CONTROL_FIFO_SIZE - 1);
1200 spin_unlock_irq(&usbhid->lock);
1202 usb_kill_urb(usbhid->urbin);
1203 usb_kill_urb(usbhid->urbout);
1204 usb_kill_urb(usbhid->urbctrl);
1206 hid_cancel_delayed_stuff(usbhid);
1210 usb_free_urb(usbhid->urbin);
1211 usb_free_urb(usbhid->urbctrl);
1212 usb_free_urb(usbhid->urbout);
1213 usbhid->urbin = NULL; /* don't mess up next start */
1214 usbhid->urbctrl = NULL;
1215 usbhid->urbout = NULL;
1217 hid_free_buffers(hid_to_usb_dev(hid), hid);
1220 static int usbhid_power(struct hid_device *hid, int lvl)
1225 case PM_HINT_FULLON:
1226 r = usbhid_get_power(hid);
1228 case PM_HINT_NORMAL:
1229 usbhid_put_power(hid);
1235 static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype)
1238 case HID_REQ_GET_REPORT:
1239 usbhid_submit_report(hid, rep, USB_DIR_IN);
1241 case HID_REQ_SET_REPORT:
1242 usbhid_submit_report(hid, rep, USB_DIR_OUT);
1247 static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum,
1248 __u8 *buf, size_t len, unsigned char rtype,
1252 case HID_REQ_GET_REPORT:
1253 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype);
1254 case HID_REQ_SET_REPORT:
1255 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype);
1261 static int usbhid_idle(struct hid_device *hid, int report, int idle,
1264 struct usb_device *dev = hid_to_usb_dev(hid);
1265 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1266 struct usb_host_interface *interface = intf->cur_altsetting;
1267 int ifnum = interface->desc.bInterfaceNumber;
1269 if (reqtype != HID_REQ_SET_IDLE)
1272 return hid_set_idle(dev, ifnum, report, idle);
1275 struct hid_ll_driver usb_hid_driver = {
1276 .parse = usbhid_parse,
1277 .start = usbhid_start,
1278 .stop = usbhid_stop,
1279 .open = usbhid_open,
1280 .close = usbhid_close,
1281 .power = usbhid_power,
1282 .request = usbhid_request,
1283 .wait = usbhid_wait_io,
1284 .raw_request = usbhid_raw_request,
1285 .output_report = usbhid_output_report,
1286 .idle = usbhid_idle,
1288 EXPORT_SYMBOL_GPL(usb_hid_driver);
1290 static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1292 struct usb_host_interface *interface = intf->cur_altsetting;
1293 struct usb_device *dev = interface_to_usbdev(intf);
1294 struct usbhid_device *usbhid;
1295 struct hid_device *hid;
1296 unsigned int n, has_in = 0;
1300 dbg_hid("HID probe called for ifnum %d\n",
1301 intf->altsetting->desc.bInterfaceNumber);
1303 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1304 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1307 hid_err(intf, "couldn't find an input interrupt endpoint\n");
1311 hid = hid_allocate_device();
1313 return PTR_ERR(hid);
1315 usb_set_intfdata(intf, hid);
1316 hid->ll_driver = &usb_hid_driver;
1317 hid->ff_init = hid_pidff_init;
1318 #ifdef CONFIG_USB_HIDDEV
1319 hid->hiddev_connect = hiddev_connect;
1320 hid->hiddev_disconnect = hiddev_disconnect;
1321 hid->hiddev_hid_event = hiddev_hid_event;
1322 hid->hiddev_report_event = hiddev_report_event;
1324 hid->dev.parent = &intf->dev;
1326 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1327 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1329 hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
1330 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1331 USB_INTERFACE_PROTOCOL_MOUSE)
1332 hid->type = HID_TYPE_USBMOUSE;
1333 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
1334 hid->type = HID_TYPE_USBNONE;
1336 if (dev->manufacturer)
1337 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1340 if (dev->manufacturer)
1341 strlcat(hid->name, " ", sizeof(hid->name));
1342 strlcat(hid->name, dev->product, sizeof(hid->name));
1345 if (!strlen(hid->name))
1346 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1347 le16_to_cpu(dev->descriptor.idVendor),
1348 le16_to_cpu(dev->descriptor.idProduct));
1350 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1351 strlcat(hid->phys, "/input", sizeof(hid->phys));
1352 len = strlen(hid->phys);
1353 if (len < sizeof(hid->phys) - 1)
1354 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1355 "%d", intf->altsetting[0].desc.bInterfaceNumber);
1357 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1360 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1361 if (usbhid == NULL) {
1366 hid->driver_data = usbhid;
1368 usbhid->intf = intf;
1369 usbhid->ifnum = interface->desc.bInterfaceNumber;
1371 init_waitqueue_head(&usbhid->wait);
1372 INIT_WORK(&usbhid->reset_work, hid_reset);
1373 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1374 spin_lock_init(&usbhid->lock);
1376 ret = hid_add_device(hid);
1379 hid_err(intf, "can't add hid device: %d\n", ret);
1387 hid_destroy_device(hid);
1391 static void usbhid_disconnect(struct usb_interface *intf)
1393 struct hid_device *hid = usb_get_intfdata(intf);
1394 struct usbhid_device *usbhid;
1399 usbhid = hid->driver_data;
1400 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
1401 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1402 spin_unlock_irq(&usbhid->lock);
1403 hid_destroy_device(hid);
1407 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1409 del_timer_sync(&usbhid->io_retry);
1410 cancel_work_sync(&usbhid->reset_work);
1413 static void hid_cease_io(struct usbhid_device *usbhid)
1415 del_timer_sync(&usbhid->io_retry);
1416 usb_kill_urb(usbhid->urbin);
1417 usb_kill_urb(usbhid->urbctrl);
1418 usb_kill_urb(usbhid->urbout);
1421 static void hid_restart_io(struct hid_device *hid)
1423 struct usbhid_device *usbhid = hid->driver_data;
1424 int clear_halt = test_bit(HID_CLEAR_HALT, &usbhid->iofl);
1425 int reset_pending = test_bit(HID_RESET_PENDING, &usbhid->iofl);
1427 spin_lock_irq(&usbhid->lock);
1428 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1429 usbhid_mark_busy(usbhid);
1431 if (clear_halt || reset_pending)
1432 schedule_work(&usbhid->reset_work);
1433 usbhid->retry_delay = 0;
1434 spin_unlock_irq(&usbhid->lock);
1436 if (reset_pending || !test_bit(HID_STARTED, &usbhid->iofl))
1440 if (hid_start_in(hid) < 0)
1444 spin_lock_irq(&usbhid->lock);
1445 if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl))
1446 usbhid_restart_out_queue(usbhid);
1447 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
1448 usbhid_restart_ctrl_queue(usbhid);
1449 spin_unlock_irq(&usbhid->lock);
1452 /* Treat USB reset pretty much the same as suspend/resume */
1453 static int hid_pre_reset(struct usb_interface *intf)
1455 struct hid_device *hid = usb_get_intfdata(intf);
1456 struct usbhid_device *usbhid = hid->driver_data;
1458 spin_lock_irq(&usbhid->lock);
1459 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1460 spin_unlock_irq(&usbhid->lock);
1461 hid_cease_io(usbhid);
1466 /* Same routine used for post_reset and reset_resume */
1467 static int hid_post_reset(struct usb_interface *intf)
1469 struct usb_device *dev = interface_to_usbdev (intf);
1470 struct hid_device *hid = usb_get_intfdata(intf);
1471 struct usbhid_device *usbhid = hid->driver_data;
1472 struct usb_host_interface *interface = intf->cur_altsetting;
1476 /* Fetch and examine the HID report descriptor. If this
1477 * has changed, then rebind. Since usbcore's check of the
1478 * configuration descriptors passed, we already know that
1479 * the size of the HID report descriptor has not changed.
1481 rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL);
1483 dbg_hid("couldn't allocate rdesc memory (post_reset)\n");
1486 status = hid_get_class_descriptor(dev,
1487 interface->desc.bInterfaceNumber,
1488 HID_DT_REPORT, rdesc, hid->dev_rsize);
1490 dbg_hid("reading report descriptor failed (post_reset)\n");
1494 status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize);
1497 dbg_hid("report descriptor changed\n");
1501 /* No need to do another reset or clear a halted endpoint */
1502 spin_lock_irq(&usbhid->lock);
1503 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1504 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
1505 spin_unlock_irq(&usbhid->lock);
1506 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1508 hid_restart_io(hid);
1513 int usbhid_get_power(struct hid_device *hid)
1515 struct usbhid_device *usbhid = hid->driver_data;
1517 return usb_autopm_get_interface(usbhid->intf);
1520 void usbhid_put_power(struct hid_device *hid)
1522 struct usbhid_device *usbhid = hid->driver_data;
1524 usb_autopm_put_interface(usbhid->intf);
1529 static int hid_resume_common(struct hid_device *hid, bool driver_suspended)
1533 hid_restart_io(hid);
1534 if (driver_suspended && hid->driver && hid->driver->resume)
1535 status = hid->driver->resume(hid);
1539 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1541 struct hid_device *hid = usb_get_intfdata(intf);
1542 struct usbhid_device *usbhid = hid->driver_data;
1544 bool driver_suspended = false;
1545 unsigned int ledcount;
1547 if (PMSG_IS_AUTO(message)) {
1548 ledcount = hidinput_count_leds(hid);
1549 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1550 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1551 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1552 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1553 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1554 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1555 && (!ledcount || ignoreled))
1557 set_bit(HID_SUSPENDED, &usbhid->iofl);
1558 spin_unlock_irq(&usbhid->lock);
1559 if (hid->driver && hid->driver->suspend) {
1560 status = hid->driver->suspend(hid, message);
1564 driver_suspended = true;
1566 usbhid_mark_busy(usbhid);
1567 spin_unlock_irq(&usbhid->lock);
1572 /* TODO: resume() might need to handle suspend failure */
1573 if (hid->driver && hid->driver->suspend)
1574 status = hid->driver->suspend(hid, message);
1575 driver_suspended = true;
1576 spin_lock_irq(&usbhid->lock);
1577 set_bit(HID_SUSPENDED, &usbhid->iofl);
1578 spin_unlock_irq(&usbhid->lock);
1579 if (usbhid_wait_io(hid) < 0)
1583 hid_cancel_delayed_stuff(usbhid);
1584 hid_cease_io(usbhid);
1586 if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1587 /* lost race against keypresses */
1591 dev_dbg(&intf->dev, "suspend\n");
1595 hid_resume_common(hid, driver_suspended);
1599 static int hid_resume(struct usb_interface *intf)
1601 struct hid_device *hid = usb_get_intfdata (intf);
1604 status = hid_resume_common(hid, true);
1605 dev_dbg(&intf->dev, "resume status %d\n", status);
1609 static int hid_reset_resume(struct usb_interface *intf)
1611 struct hid_device *hid = usb_get_intfdata(intf);
1614 status = hid_post_reset(intf);
1615 if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1616 int ret = hid->driver->reset_resume(hid);
1623 #endif /* CONFIG_PM */
1625 static const struct usb_device_id hid_usb_ids[] = {
1626 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1627 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1628 { } /* Terminating entry */
1631 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1633 static struct usb_driver hid_driver = {
1635 .probe = usbhid_probe,
1636 .disconnect = usbhid_disconnect,
1638 .suspend = hid_suspend,
1639 .resume = hid_resume,
1640 .reset_resume = hid_reset_resume,
1642 .pre_reset = hid_pre_reset,
1643 .post_reset = hid_post_reset,
1644 .id_table = hid_usb_ids,
1645 .supports_autosuspend = 1,
1648 struct usb_interface *usbhid_find_interface(int minor)
1650 return usb_find_interface(&hid_driver, minor);
1653 static int __init hid_init(void)
1655 int retval = -ENOMEM;
1657 retval = usbhid_quirks_init(quirks_param);
1659 goto usbhid_quirks_init_fail;
1660 retval = usb_register(&hid_driver);
1662 goto usb_register_fail;
1663 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1667 usbhid_quirks_exit();
1668 usbhid_quirks_init_fail:
1672 static void __exit hid_exit(void)
1674 usb_deregister(&hid_driver);
1675 usbhid_quirks_exit();
1678 module_init(hid_init);
1679 module_exit(hid_exit);
1681 MODULE_AUTHOR("Andreas Gal");
1682 MODULE_AUTHOR("Vojtech Pavlik");
1683 MODULE_AUTHOR("Jiri Kosina");
1684 MODULE_DESCRIPTION(DRIVER_DESC);
1685 MODULE_LICENSE(DRIVER_LICENSE);