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_mark_busy(usbhid
);
278 usbhid
->retry_delay
= 0;
279 if ((hid
->quirks
& HID_QUIRK_ALWAYS_POLL
) && !hid
->open
)
281 hid_input_report(urb
->context
, HID_INPUT_REPORT
,
282 urb
->transfer_buffer
,
283 urb
->actual_length
, 1);
285 * autosuspend refused while keys are pressed
286 * because most keyboards don't wake up when
289 if (hid_check_keys_pressed(hid
))
290 set_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
);
292 clear_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
);
294 case -EPIPE
: /* stall */
295 usbhid_mark_busy(usbhid
);
296 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
297 set_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
298 schedule_work(&usbhid
->reset_work
);
300 case -ECONNRESET
: /* unlink */
302 case -ESHUTDOWN
: /* unplug */
303 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
305 case -EILSEQ
: /* protocol error or unplug */
306 case -EPROTO
: /* protocol error or unplug */
307 case -ETIME
: /* protocol error or unplug */
308 case -ETIMEDOUT
: /* Should never happen, but... */
309 usbhid_mark_busy(usbhid
);
310 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
314 hid_warn(urb
->dev
, "input irq status %d received\n",
318 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
320 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
321 if (status
!= -EPERM
) {
322 hid_err(hid
, "can't resubmit intr, %s-%s/input%d, status %d\n",
323 hid_to_usb_dev(hid
)->bus
->bus_name
,
324 hid_to_usb_dev(hid
)->devpath
,
325 usbhid
->ifnum
, status
);
331 static int hid_submit_out(struct hid_device
*hid
)
333 struct hid_report
*report
;
335 struct usbhid_device
*usbhid
= hid
->driver_data
;
338 report
= usbhid
->out
[usbhid
->outtail
].report
;
339 raw_report
= usbhid
->out
[usbhid
->outtail
].raw_report
;
341 usbhid
->urbout
->transfer_buffer_length
= ((report
->size
- 1) >> 3) +
342 1 + (report
->id
> 0);
343 usbhid
->urbout
->dev
= hid_to_usb_dev(hid
);
345 memcpy(usbhid
->outbuf
, raw_report
,
346 usbhid
->urbout
->transfer_buffer_length
);
348 usbhid
->out
[usbhid
->outtail
].raw_report
= NULL
;
351 dbg_hid("submitting out urb\n");
353 r
= usb_submit_urb(usbhid
->urbout
, GFP_ATOMIC
);
355 hid_err(hid
, "usb_submit_urb(out) failed: %d\n", r
);
358 usbhid
->last_out
= jiffies
;
362 static int hid_submit_ctrl(struct hid_device
*hid
)
364 struct hid_report
*report
;
368 struct usbhid_device
*usbhid
= hid
->driver_data
;
370 report
= usbhid
->ctrl
[usbhid
->ctrltail
].report
;
371 raw_report
= usbhid
->ctrl
[usbhid
->ctrltail
].raw_report
;
372 dir
= usbhid
->ctrl
[usbhid
->ctrltail
].dir
;
374 len
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
375 if (dir
== USB_DIR_OUT
) {
376 usbhid
->urbctrl
->pipe
= usb_sndctrlpipe(hid_to_usb_dev(hid
), 0);
377 usbhid
->urbctrl
->transfer_buffer_length
= len
;
379 memcpy(usbhid
->ctrlbuf
, raw_report
, len
);
381 usbhid
->ctrl
[usbhid
->ctrltail
].raw_report
= NULL
;
384 int maxpacket
, padlen
;
386 usbhid
->urbctrl
->pipe
= usb_rcvctrlpipe(hid_to_usb_dev(hid
), 0);
387 maxpacket
= usb_maxpacket(hid_to_usb_dev(hid
),
388 usbhid
->urbctrl
->pipe
, 0);
390 padlen
= DIV_ROUND_UP(len
, maxpacket
);
392 if (padlen
> usbhid
->bufsize
)
393 padlen
= usbhid
->bufsize
;
396 usbhid
->urbctrl
->transfer_buffer_length
= padlen
;
398 usbhid
->urbctrl
->dev
= hid_to_usb_dev(hid
);
400 usbhid
->cr
->bRequestType
= USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| dir
;
401 usbhid
->cr
->bRequest
= (dir
== USB_DIR_OUT
) ? HID_REQ_SET_REPORT
:
403 usbhid
->cr
->wValue
= cpu_to_le16(((report
->type
+ 1) << 8) |
405 usbhid
->cr
->wIndex
= cpu_to_le16(usbhid
->ifnum
);
406 usbhid
->cr
->wLength
= cpu_to_le16(len
);
408 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
409 usbhid
->cr
->bRequest
== HID_REQ_SET_REPORT
? "Set_Report" :
411 usbhid
->cr
->wValue
, usbhid
->cr
->wIndex
, usbhid
->cr
->wLength
);
413 r
= usb_submit_urb(usbhid
->urbctrl
, GFP_ATOMIC
);
415 hid_err(hid
, "usb_submit_urb(ctrl) failed: %d\n", r
);
418 usbhid
->last_ctrl
= jiffies
;
423 * Output interrupt completion handler.
426 static void hid_irq_out(struct urb
*urb
)
428 struct hid_device
*hid
= urb
->context
;
429 struct usbhid_device
*usbhid
= hid
->driver_data
;
433 switch (urb
->status
) {
434 case 0: /* success */
436 case -ESHUTDOWN
: /* unplug */
438 case -EILSEQ
: /* protocol error or unplug */
439 case -EPROTO
: /* protocol error or unplug */
440 case -ECONNRESET
: /* unlink */
444 hid_warn(urb
->dev
, "output irq status %d received\n",
448 spin_lock_irqsave(&usbhid
->lock
, flags
);
451 usbhid
->outtail
= usbhid
->outhead
;
453 usbhid
->outtail
= (usbhid
->outtail
+ 1) & (HID_OUTPUT_FIFO_SIZE
- 1);
455 if (usbhid
->outhead
!= usbhid
->outtail
&&
456 hid_submit_out(hid
) == 0) {
457 /* Successfully submitted next urb in queue */
458 spin_unlock_irqrestore(&usbhid
->lock
, flags
);
463 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
464 spin_unlock_irqrestore(&usbhid
->lock
, flags
);
465 usb_autopm_put_interface_async(usbhid
->intf
);
466 wake_up(&usbhid
->wait
);
470 * Control pipe completion handler.
473 static void hid_ctrl(struct urb
*urb
)
475 struct hid_device
*hid
= urb
->context
;
476 struct usbhid_device
*usbhid
= hid
->driver_data
;
477 int unplug
= 0, status
= urb
->status
;
479 spin_lock(&usbhid
->lock
);
482 case 0: /* success */
483 if (usbhid
->ctrl
[usbhid
->ctrltail
].dir
== USB_DIR_IN
)
484 hid_input_report(urb
->context
,
485 usbhid
->ctrl
[usbhid
->ctrltail
].report
->type
,
486 urb
->transfer_buffer
, urb
->actual_length
, 0);
488 case -ESHUTDOWN
: /* unplug */
490 case -EILSEQ
: /* protocol error or unplug */
491 case -EPROTO
: /* protocol error or unplug */
492 case -ECONNRESET
: /* unlink */
494 case -EPIPE
: /* report not available */
497 hid_warn(urb
->dev
, "ctrl urb status %d received\n", status
);
501 usbhid
->ctrltail
= usbhid
->ctrlhead
;
503 usbhid
->ctrltail
= (usbhid
->ctrltail
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1);
505 if (usbhid
->ctrlhead
!= usbhid
->ctrltail
&&
506 hid_submit_ctrl(hid
) == 0) {
507 /* Successfully submitted next urb in queue */
508 spin_unlock(&usbhid
->lock
);
513 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
514 spin_unlock(&usbhid
->lock
);
515 usb_autopm_put_interface_async(usbhid
->intf
);
516 wake_up(&usbhid
->wait
);
519 static void __usbhid_submit_report(struct hid_device
*hid
, struct hid_report
*report
,
523 struct usbhid_device
*usbhid
= hid
->driver_data
;
525 if (((hid
->quirks
& HID_QUIRK_NOGET
) && dir
== USB_DIR_IN
) ||
526 test_bit(HID_DISCONNECTED
, &usbhid
->iofl
))
529 if (usbhid
->urbout
&& dir
== USB_DIR_OUT
&& report
->type
== HID_OUTPUT_REPORT
) {
530 if ((head
= (usbhid
->outhead
+ 1) & (HID_OUTPUT_FIFO_SIZE
- 1)) == usbhid
->outtail
) {
531 hid_warn(hid
, "output queue full\n");
535 usbhid
->out
[usbhid
->outhead
].raw_report
= hid_alloc_report_buf(report
, GFP_ATOMIC
);
536 if (!usbhid
->out
[usbhid
->outhead
].raw_report
) {
537 hid_warn(hid
, "output queueing failed\n");
540 hid_output_report(report
, usbhid
->out
[usbhid
->outhead
].raw_report
);
541 usbhid
->out
[usbhid
->outhead
].report
= report
;
542 usbhid
->outhead
= head
;
544 /* If the queue isn't running, restart it */
545 if (!test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)) {
546 usbhid_restart_out_queue(usbhid
);
548 /* Otherwise see if an earlier request has timed out */
549 } else if (time_after(jiffies
, usbhid
->last_out
+ HZ
* 5)) {
551 /* Prevent autosuspend following the unlink */
552 usb_autopm_get_interface_no_resume(usbhid
->intf
);
555 * Prevent resubmission in case the URB completes
556 * before we can unlink it. We don't want to cancel
557 * the wrong transfer!
559 usb_block_urb(usbhid
->urbout
);
561 /* Drop lock to avoid deadlock if the callback runs */
562 spin_unlock(&usbhid
->lock
);
564 usb_unlink_urb(usbhid
->urbout
);
565 spin_lock(&usbhid
->lock
);
566 usb_unblock_urb(usbhid
->urbout
);
568 /* Unlink might have stopped the queue */
569 if (!test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
570 usbhid_restart_out_queue(usbhid
);
572 /* Now we can allow autosuspend again */
573 usb_autopm_put_interface_async(usbhid
->intf
);
578 if ((head
= (usbhid
->ctrlhead
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1)) == usbhid
->ctrltail
) {
579 hid_warn(hid
, "control queue full\n");
583 if (dir
== USB_DIR_OUT
) {
584 usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
= hid_alloc_report_buf(report
, GFP_ATOMIC
);
585 if (!usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
) {
586 hid_warn(hid
, "control queueing failed\n");
589 hid_output_report(report
, usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
);
591 usbhid
->ctrl
[usbhid
->ctrlhead
].report
= report
;
592 usbhid
->ctrl
[usbhid
->ctrlhead
].dir
= dir
;
593 usbhid
->ctrlhead
= head
;
595 /* If the queue isn't running, restart it */
596 if (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
)) {
597 usbhid_restart_ctrl_queue(usbhid
);
599 /* Otherwise see if an earlier request has timed out */
600 } else if (time_after(jiffies
, usbhid
->last_ctrl
+ HZ
* 5)) {
602 /* Prevent autosuspend following the unlink */
603 usb_autopm_get_interface_no_resume(usbhid
->intf
);
606 * Prevent resubmission in case the URB completes
607 * before we can unlink it. We don't want to cancel
608 * the wrong transfer!
610 usb_block_urb(usbhid
->urbctrl
);
612 /* Drop lock to avoid deadlock if the callback runs */
613 spin_unlock(&usbhid
->lock
);
615 usb_unlink_urb(usbhid
->urbctrl
);
616 spin_lock(&usbhid
->lock
);
617 usb_unblock_urb(usbhid
->urbctrl
);
619 /* Unlink might have stopped the queue */
620 if (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
621 usbhid_restart_ctrl_queue(usbhid
);
623 /* Now we can allow autosuspend again */
624 usb_autopm_put_interface_async(usbhid
->intf
);
628 static void usbhid_submit_report(struct hid_device
*hid
, struct hid_report
*report
, unsigned char dir
)
630 struct usbhid_device
*usbhid
= hid
->driver_data
;
633 spin_lock_irqsave(&usbhid
->lock
, flags
);
634 __usbhid_submit_report(hid
, report
, dir
);
635 spin_unlock_irqrestore(&usbhid
->lock
, flags
);
638 static int usbhid_wait_io(struct hid_device
*hid
)
640 struct usbhid_device
*usbhid
= hid
->driver_data
;
642 if (!wait_event_timeout(usbhid
->wait
,
643 (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
) &&
644 !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)),
646 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
653 static int hid_set_idle(struct usb_device
*dev
, int ifnum
, int report
, int idle
)
655 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
656 HID_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
, (idle
<< 8) | report
,
657 ifnum
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
660 static int hid_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
661 unsigned char type
, void *buf
, int size
)
663 int result
, retries
= 4;
665 memset(buf
, 0, size
);
668 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
669 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
670 (type
<< 8), ifnum
, buf
, size
, USB_CTRL_GET_TIMEOUT
);
672 } while (result
< size
&& retries
);
676 int usbhid_open(struct hid_device
*hid
)
678 struct usbhid_device
*usbhid
= hid
->driver_data
;
681 mutex_lock(&hid_open_mut
);
683 res
= usb_autopm_get_interface(usbhid
->intf
);
684 /* the device must be awake to reliably request remote wakeup */
690 usbhid
->intf
->needs_remote_wakeup
= 1;
691 res
= hid_start_in(hid
);
693 if (res
!= -ENOSPC
) {
697 /* no use opening if resources are insufficient */
700 usbhid
->intf
->needs_remote_wakeup
= 0;
703 usb_autopm_put_interface(usbhid
->intf
);
706 mutex_unlock(&hid_open_mut
);
710 void usbhid_close(struct hid_device
*hid
)
712 struct usbhid_device
*usbhid
= hid
->driver_data
;
714 mutex_lock(&hid_open_mut
);
716 /* protecting hid->open to make sure we don't restart
717 * data acquistion due to a resumption we no longer
720 spin_lock_irq(&usbhid
->lock
);
722 spin_unlock_irq(&usbhid
->lock
);
723 hid_cancel_delayed_stuff(usbhid
);
724 if (!(hid
->quirks
& HID_QUIRK_ALWAYS_POLL
)) {
725 usb_kill_urb(usbhid
->urbin
);
726 usbhid
->intf
->needs_remote_wakeup
= 0;
729 spin_unlock_irq(&usbhid
->lock
);
731 mutex_unlock(&hid_open_mut
);
735 * Initialize all reports
738 void usbhid_init_reports(struct hid_device
*hid
)
740 struct hid_report
*report
;
741 struct usbhid_device
*usbhid
= hid
->driver_data
;
742 struct hid_report_enum
*report_enum
;
745 if (!(hid
->quirks
& HID_QUIRK_NO_INIT_INPUT_REPORTS
)) {
746 report_enum
= &hid
->report_enum
[HID_INPUT_REPORT
];
747 list_for_each_entry(report
, &report_enum
->report_list
, list
)
748 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
751 report_enum
= &hid
->report_enum
[HID_FEATURE_REPORT
];
752 list_for_each_entry(report
, &report_enum
->report_list
, list
)
753 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
756 ret
= usbhid_wait_io(hid
);
759 if (test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
760 usb_kill_urb(usbhid
->urbctrl
);
761 if (test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
762 usb_kill_urb(usbhid
->urbout
);
763 ret
= usbhid_wait_io(hid
);
767 hid_warn(hid
, "timeout initializing reports\n");
771 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
773 static int hid_find_field_early(struct hid_device
*hid
, unsigned int page
,
774 unsigned int hid_code
, struct hid_field
**pfield
)
776 struct hid_report
*report
;
777 struct hid_field
*field
;
778 struct hid_usage
*usage
;
781 list_for_each_entry(report
, &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
782 for (i
= 0; i
< report
->maxfield
; i
++) {
783 field
= report
->field
[i
];
784 for (j
= 0; j
< field
->maxusage
; j
++) {
785 usage
= &field
->usage
[j
];
786 if ((usage
->hid
& HID_USAGE_PAGE
) == page
&&
787 (usage
->hid
& 0xFFFF) == hid_code
) {
797 static void usbhid_set_leds(struct hid_device
*hid
)
799 struct hid_field
*field
;
802 if ((offset
= hid_find_field_early(hid
, HID_UP_LED
, 0x01, &field
)) != -1) {
803 hid_set_field(field
, offset
, 0);
804 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
809 * Traverse the supplied list of reports and find the longest
811 static void hid_find_max_report(struct hid_device
*hid
, unsigned int type
,
814 struct hid_report
*report
;
817 list_for_each_entry(report
, &hid
->report_enum
[type
].report_list
, list
) {
818 size
= ((report
->size
- 1) >> 3) + 1 + hid
->report_enum
[type
].numbered
;
824 static int hid_alloc_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
826 struct usbhid_device
*usbhid
= hid
->driver_data
;
828 usbhid
->inbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
830 usbhid
->outbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
831 &usbhid
->outbuf_dma
);
832 usbhid
->cr
= kmalloc(sizeof(*usbhid
->cr
), GFP_KERNEL
);
833 usbhid
->ctrlbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
834 &usbhid
->ctrlbuf_dma
);
835 if (!usbhid
->inbuf
|| !usbhid
->outbuf
|| !usbhid
->cr
||
842 static int usbhid_get_raw_report(struct hid_device
*hid
,
843 unsigned char report_number
, __u8
*buf
, size_t count
,
844 unsigned char report_type
)
846 struct usbhid_device
*usbhid
= hid
->driver_data
;
847 struct usb_device
*dev
= hid_to_usb_dev(hid
);
848 struct usb_interface
*intf
= usbhid
->intf
;
849 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
850 int skipped_report_id
= 0;
853 /* Byte 0 is the report number. Report data starts at byte 1.*/
854 buf
[0] = report_number
;
855 if (report_number
== 0x0) {
856 /* Offset the return buffer by 1, so that the report ID
857 will remain in byte 0. */
860 skipped_report_id
= 1;
862 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
864 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
865 ((report_type
+ 1) << 8) | report_number
,
866 interface
->desc
.bInterfaceNumber
, buf
, count
,
867 USB_CTRL_SET_TIMEOUT
);
869 /* count also the report id */
870 if (ret
> 0 && skipped_report_id
)
876 static int usbhid_set_raw_report(struct hid_device
*hid
, unsigned int reportnum
,
877 __u8
*buf
, size_t count
, unsigned char rtype
)
879 struct usbhid_device
*usbhid
= hid
->driver_data
;
880 struct usb_device
*dev
= hid_to_usb_dev(hid
);
881 struct usb_interface
*intf
= usbhid
->intf
;
882 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
883 int ret
, skipped_report_id
= 0;
885 /* Byte 0 is the report number. Report data starts at byte 1.*/
886 if ((rtype
== HID_OUTPUT_REPORT
) &&
887 (hid
->quirks
& HID_QUIRK_SKIP_OUTPUT_REPORT_ID
))
893 /* Don't send the Report ID */
896 skipped_report_id
= 1;
899 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
901 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
902 ((rtype
+ 1) << 8) | reportnum
,
903 interface
->desc
.bInterfaceNumber
, buf
, count
,
904 USB_CTRL_SET_TIMEOUT
);
905 /* count also the report id, if this was a numbered report. */
906 if (ret
> 0 && skipped_report_id
)
912 static int usbhid_output_report(struct hid_device
*hid
, __u8
*buf
, size_t count
)
914 struct usbhid_device
*usbhid
= hid
->driver_data
;
915 struct usb_device
*dev
= hid_to_usb_dev(hid
);
916 int actual_length
, skipped_report_id
= 0, ret
;
922 /* Don't send the Report ID */
925 skipped_report_id
= 1;
928 ret
= usb_interrupt_msg(dev
, usbhid
->urbout
->pipe
,
929 buf
, count
, &actual_length
,
930 USB_CTRL_SET_TIMEOUT
);
931 /* return the number of bytes transferred */
934 /* count also the report id */
935 if (skipped_report_id
)
942 static void usbhid_restart_queues(struct usbhid_device
*usbhid
)
944 if (usbhid
->urbout
&& !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
945 usbhid_restart_out_queue(usbhid
);
946 if (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
947 usbhid_restart_ctrl_queue(usbhid
);
950 static void hid_free_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
952 struct usbhid_device
*usbhid
= hid
->driver_data
;
954 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->inbuf
, usbhid
->inbuf_dma
);
955 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->outbuf
, usbhid
->outbuf_dma
);
957 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->ctrlbuf
, usbhid
->ctrlbuf_dma
);
960 static int usbhid_parse(struct hid_device
*hid
)
962 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
963 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
964 struct usb_device
*dev
= interface_to_usbdev (intf
);
965 struct hid_descriptor
*hdesc
;
967 unsigned int rsize
= 0;
971 quirks
= usbhid_lookup_quirk(le16_to_cpu(dev
->descriptor
.idVendor
),
972 le16_to_cpu(dev
->descriptor
.idProduct
));
974 if (quirks
& HID_QUIRK_IGNORE
)
977 /* Many keyboards and mice don't like to be polled for reports,
978 * so we will always set the HID_QUIRK_NOGET flag for them. */
979 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
) {
980 if (interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_KEYBOARD
||
981 interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_MOUSE
)
982 quirks
|= HID_QUIRK_NOGET
;
985 if (usb_get_extra_descriptor(interface
, HID_DT_HID
, &hdesc
) &&
986 (!interface
->desc
.bNumEndpoints
||
987 usb_get_extra_descriptor(&interface
->endpoint
[0], HID_DT_HID
, &hdesc
))) {
988 dbg_hid("class descriptor not present\n");
992 hid
->version
= le16_to_cpu(hdesc
->bcdHID
);
993 hid
->country
= hdesc
->bCountryCode
;
995 for (n
= 0; n
< hdesc
->bNumDescriptors
; n
++)
996 if (hdesc
->desc
[n
].bDescriptorType
== HID_DT_REPORT
)
997 rsize
= le16_to_cpu(hdesc
->desc
[n
].wDescriptorLength
);
999 if (!rsize
|| rsize
> HID_MAX_DESCRIPTOR_SIZE
) {
1000 dbg_hid("weird size of report descriptor (%u)\n", rsize
);
1004 if (!(rdesc
= kmalloc(rsize
, GFP_KERNEL
))) {
1005 dbg_hid("couldn't allocate rdesc memory\n");
1009 hid_set_idle(dev
, interface
->desc
.bInterfaceNumber
, 0, 0);
1011 ret
= hid_get_class_descriptor(dev
, interface
->desc
.bInterfaceNumber
,
1012 HID_DT_REPORT
, rdesc
, rsize
);
1014 dbg_hid("reading report descriptor failed\n");
1019 ret
= hid_parse_report(hid
, rdesc
, rsize
);
1022 dbg_hid("parsing report descriptor failed\n");
1026 hid
->quirks
|= quirks
;
1033 static int usbhid_start(struct hid_device
*hid
)
1035 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
1036 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1037 struct usb_device
*dev
= interface_to_usbdev(intf
);
1038 struct usbhid_device
*usbhid
= hid
->driver_data
;
1039 unsigned int n
, insize
= 0;
1042 clear_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1044 usbhid
->bufsize
= HID_MIN_BUFFER_SIZE
;
1045 hid_find_max_report(hid
, HID_INPUT_REPORT
, &usbhid
->bufsize
);
1046 hid_find_max_report(hid
, HID_OUTPUT_REPORT
, &usbhid
->bufsize
);
1047 hid_find_max_report(hid
, HID_FEATURE_REPORT
, &usbhid
->bufsize
);
1049 if (usbhid
->bufsize
> HID_MAX_BUFFER_SIZE
)
1050 usbhid
->bufsize
= HID_MAX_BUFFER_SIZE
;
1052 hid_find_max_report(hid
, HID_INPUT_REPORT
, &insize
);
1054 if (insize
> HID_MAX_BUFFER_SIZE
)
1055 insize
= HID_MAX_BUFFER_SIZE
;
1057 if (hid_alloc_buffers(dev
, hid
)) {
1062 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++) {
1063 struct usb_endpoint_descriptor
*endpoint
;
1067 endpoint
= &interface
->endpoint
[n
].desc
;
1068 if (!usb_endpoint_xfer_int(endpoint
))
1071 interval
= endpoint
->bInterval
;
1073 /* Some vendors give fullspeed interval on highspeed devides */
1074 if (hid
->quirks
& HID_QUIRK_FULLSPEED_INTERVAL
&&
1075 dev
->speed
== USB_SPEED_HIGH
) {
1076 interval
= fls(endpoint
->bInterval
*8);
1077 printk(KERN_INFO
"%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1078 hid
->name
, endpoint
->bInterval
, interval
);
1081 /* Change the polling interval of mice. */
1082 if (hid
->collection
->usage
== HID_GD_MOUSE
&& hid_mousepoll_interval
> 0)
1083 interval
= hid_mousepoll_interval
;
1086 if (usb_endpoint_dir_in(endpoint
)) {
1089 if (!(usbhid
->urbin
= usb_alloc_urb(0, GFP_KERNEL
)))
1091 pipe
= usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
);
1092 usb_fill_int_urb(usbhid
->urbin
, dev
, pipe
, usbhid
->inbuf
, insize
,
1093 hid_irq_in
, hid
, interval
);
1094 usbhid
->urbin
->transfer_dma
= usbhid
->inbuf_dma
;
1095 usbhid
->urbin
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1099 if (!(usbhid
->urbout
= usb_alloc_urb(0, GFP_KERNEL
)))
1101 pipe
= usb_sndintpipe(dev
, endpoint
->bEndpointAddress
);
1102 usb_fill_int_urb(usbhid
->urbout
, dev
, pipe
, usbhid
->outbuf
, 0,
1103 hid_irq_out
, hid
, interval
);
1104 usbhid
->urbout
->transfer_dma
= usbhid
->outbuf_dma
;
1105 usbhid
->urbout
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1109 usbhid
->urbctrl
= usb_alloc_urb(0, GFP_KERNEL
);
1110 if (!usbhid
->urbctrl
) {
1115 usb_fill_control_urb(usbhid
->urbctrl
, dev
, 0, (void *) usbhid
->cr
,
1116 usbhid
->ctrlbuf
, 1, hid_ctrl
, hid
);
1117 usbhid
->urbctrl
->transfer_dma
= usbhid
->ctrlbuf_dma
;
1118 usbhid
->urbctrl
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1120 if (!(hid
->quirks
& HID_QUIRK_NO_INIT_REPORTS
))
1121 usbhid_init_reports(hid
);
1123 set_bit(HID_STARTED
, &usbhid
->iofl
);
1125 if (hid
->quirks
& HID_QUIRK_ALWAYS_POLL
) {
1126 ret
= usb_autopm_get_interface(usbhid
->intf
);
1129 usbhid
->intf
->needs_remote_wakeup
= 1;
1130 ret
= hid_start_in(hid
);
1133 "failed to start in urb: %d\n", ret
);
1135 usb_autopm_put_interface(usbhid
->intf
);
1138 /* Some keyboards don't work until their LEDs have been set.
1139 * Since BIOSes do set the LEDs, it must be safe for any device
1140 * that supports the keyboard boot protocol.
1141 * In addition, enable remote wakeup by default for all keyboard
1142 * devices supporting the boot protocol.
1144 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
&&
1145 interface
->desc
.bInterfaceProtocol
==
1146 USB_INTERFACE_PROTOCOL_KEYBOARD
) {
1147 usbhid_set_leds(hid
);
1148 device_set_wakeup_enable(&dev
->dev
, 1);
1153 usb_free_urb(usbhid
->urbin
);
1154 usb_free_urb(usbhid
->urbout
);
1155 usb_free_urb(usbhid
->urbctrl
);
1156 usbhid
->urbin
= NULL
;
1157 usbhid
->urbout
= NULL
;
1158 usbhid
->urbctrl
= NULL
;
1159 hid_free_buffers(dev
, hid
);
1163 static void usbhid_stop(struct hid_device
*hid
)
1165 struct usbhid_device
*usbhid
= hid
->driver_data
;
1167 if (WARN_ON(!usbhid
))
1170 if (hid
->quirks
& HID_QUIRK_ALWAYS_POLL
)
1171 usbhid
->intf
->needs_remote_wakeup
= 0;
1173 clear_bit(HID_STARTED
, &usbhid
->iofl
);
1174 spin_lock_irq(&usbhid
->lock
); /* Sync with error and led handlers */
1175 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1176 spin_unlock_irq(&usbhid
->lock
);
1177 usb_kill_urb(usbhid
->urbin
);
1178 usb_kill_urb(usbhid
->urbout
);
1179 usb_kill_urb(usbhid
->urbctrl
);
1181 hid_cancel_delayed_stuff(usbhid
);
1185 usb_free_urb(usbhid
->urbin
);
1186 usb_free_urb(usbhid
->urbctrl
);
1187 usb_free_urb(usbhid
->urbout
);
1188 usbhid
->urbin
= NULL
; /* don't mess up next start */
1189 usbhid
->urbctrl
= NULL
;
1190 usbhid
->urbout
= NULL
;
1192 hid_free_buffers(hid_to_usb_dev(hid
), hid
);
1195 static int usbhid_power(struct hid_device
*hid
, int lvl
)
1200 case PM_HINT_FULLON
:
1201 r
= usbhid_get_power(hid
);
1203 case PM_HINT_NORMAL
:
1204 usbhid_put_power(hid
);
1210 static void usbhid_request(struct hid_device
*hid
, struct hid_report
*rep
, int reqtype
)
1213 case HID_REQ_GET_REPORT
:
1214 usbhid_submit_report(hid
, rep
, USB_DIR_IN
);
1216 case HID_REQ_SET_REPORT
:
1217 usbhid_submit_report(hid
, rep
, USB_DIR_OUT
);
1222 static int usbhid_raw_request(struct hid_device
*hid
, unsigned char reportnum
,
1223 __u8
*buf
, size_t len
, unsigned char rtype
,
1227 case HID_REQ_GET_REPORT
:
1228 return usbhid_get_raw_report(hid
, reportnum
, buf
, len
, rtype
);
1229 case HID_REQ_SET_REPORT
:
1230 return usbhid_set_raw_report(hid
, reportnum
, buf
, len
, rtype
);
1236 static int usbhid_idle(struct hid_device
*hid
, int report
, int idle
,
1239 struct usb_device
*dev
= hid_to_usb_dev(hid
);
1240 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
1241 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1242 int ifnum
= interface
->desc
.bInterfaceNumber
;
1244 if (reqtype
!= HID_REQ_SET_IDLE
)
1247 return hid_set_idle(dev
, ifnum
, report
, idle
);
1250 static struct hid_ll_driver usb_hid_driver
= {
1251 .parse
= usbhid_parse
,
1252 .start
= usbhid_start
,
1253 .stop
= usbhid_stop
,
1254 .open
= usbhid_open
,
1255 .close
= usbhid_close
,
1256 .power
= usbhid_power
,
1257 .request
= usbhid_request
,
1258 .wait
= usbhid_wait_io
,
1259 .raw_request
= usbhid_raw_request
,
1260 .output_report
= usbhid_output_report
,
1261 .idle
= usbhid_idle
,
1264 static int usbhid_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1266 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1267 struct usb_device
*dev
= interface_to_usbdev(intf
);
1268 struct usbhid_device
*usbhid
;
1269 struct hid_device
*hid
;
1270 unsigned int n
, has_in
= 0;
1274 dbg_hid("HID probe called for ifnum %d\n",
1275 intf
->altsetting
->desc
.bInterfaceNumber
);
1277 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++)
1278 if (usb_endpoint_is_int_in(&interface
->endpoint
[n
].desc
))
1281 hid_err(intf
, "couldn't find an input interrupt endpoint\n");
1285 hid
= hid_allocate_device();
1287 return PTR_ERR(hid
);
1289 usb_set_intfdata(intf
, hid
);
1290 hid
->ll_driver
= &usb_hid_driver
;
1291 hid
->ff_init
= hid_pidff_init
;
1292 #ifdef CONFIG_USB_HIDDEV
1293 hid
->hiddev_connect
= hiddev_connect
;
1294 hid
->hiddev_disconnect
= hiddev_disconnect
;
1295 hid
->hiddev_hid_event
= hiddev_hid_event
;
1296 hid
->hiddev_report_event
= hiddev_report_event
;
1298 hid
->dev
.parent
= &intf
->dev
;
1300 hid
->vendor
= le16_to_cpu(dev
->descriptor
.idVendor
);
1301 hid
->product
= le16_to_cpu(dev
->descriptor
.idProduct
);
1303 hid
->quirks
= usbhid_lookup_quirk(hid
->vendor
, hid
->product
);
1304 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
==
1305 USB_INTERFACE_PROTOCOL_MOUSE
)
1306 hid
->type
= HID_TYPE_USBMOUSE
;
1307 else if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
== 0)
1308 hid
->type
= HID_TYPE_USBNONE
;
1310 if (dev
->manufacturer
)
1311 strlcpy(hid
->name
, dev
->manufacturer
, sizeof(hid
->name
));
1314 if (dev
->manufacturer
)
1315 strlcat(hid
->name
, " ", sizeof(hid
->name
));
1316 strlcat(hid
->name
, dev
->product
, sizeof(hid
->name
));
1319 if (!strlen(hid
->name
))
1320 snprintf(hid
->name
, sizeof(hid
->name
), "HID %04x:%04x",
1321 le16_to_cpu(dev
->descriptor
.idVendor
),
1322 le16_to_cpu(dev
->descriptor
.idProduct
));
1324 usb_make_path(dev
, hid
->phys
, sizeof(hid
->phys
));
1325 strlcat(hid
->phys
, "/input", sizeof(hid
->phys
));
1326 len
= strlen(hid
->phys
);
1327 if (len
< sizeof(hid
->phys
) - 1)
1328 snprintf(hid
->phys
+ len
, sizeof(hid
->phys
) - len
,
1329 "%d", intf
->altsetting
[0].desc
.bInterfaceNumber
);
1331 if (usb_string(dev
, dev
->descriptor
.iSerialNumber
, hid
->uniq
, 64) <= 0)
1334 usbhid
= kzalloc(sizeof(*usbhid
), GFP_KERNEL
);
1335 if (usbhid
== NULL
) {
1340 hid
->driver_data
= usbhid
;
1342 usbhid
->intf
= intf
;
1343 usbhid
->ifnum
= interface
->desc
.bInterfaceNumber
;
1345 init_waitqueue_head(&usbhid
->wait
);
1346 INIT_WORK(&usbhid
->reset_work
, hid_reset
);
1347 setup_timer(&usbhid
->io_retry
, hid_retry_timeout
, (unsigned long) hid
);
1348 spin_lock_init(&usbhid
->lock
);
1350 ret
= hid_add_device(hid
);
1353 hid_err(intf
, "can't add hid device: %d\n", ret
);
1361 hid_destroy_device(hid
);
1365 static void usbhid_disconnect(struct usb_interface
*intf
)
1367 struct hid_device
*hid
= usb_get_intfdata(intf
);
1368 struct usbhid_device
*usbhid
;
1373 usbhid
= hid
->driver_data
;
1374 spin_lock_irq(&usbhid
->lock
); /* Sync with error and led handlers */
1375 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1376 spin_unlock_irq(&usbhid
->lock
);
1377 hid_destroy_device(hid
);
1381 static void hid_cancel_delayed_stuff(struct usbhid_device
*usbhid
)
1383 del_timer_sync(&usbhid
->io_retry
);
1384 cancel_work_sync(&usbhid
->reset_work
);
1387 static void hid_cease_io(struct usbhid_device
*usbhid
)
1389 del_timer_sync(&usbhid
->io_retry
);
1390 usb_kill_urb(usbhid
->urbin
);
1391 usb_kill_urb(usbhid
->urbctrl
);
1392 usb_kill_urb(usbhid
->urbout
);
1395 /* Treat USB reset pretty much the same as suspend/resume */
1396 static int hid_pre_reset(struct usb_interface
*intf
)
1398 struct hid_device
*hid
= usb_get_intfdata(intf
);
1399 struct usbhid_device
*usbhid
= hid
->driver_data
;
1401 spin_lock_irq(&usbhid
->lock
);
1402 set_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
1403 spin_unlock_irq(&usbhid
->lock
);
1404 hid_cease_io(usbhid
);
1409 /* Same routine used for post_reset and reset_resume */
1410 static int hid_post_reset(struct usb_interface
*intf
)
1412 struct usb_device
*dev
= interface_to_usbdev (intf
);
1413 struct hid_device
*hid
= usb_get_intfdata(intf
);
1414 struct usbhid_device
*usbhid
= hid
->driver_data
;
1415 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1419 /* Fetch and examine the HID report descriptor. If this
1420 * has changed, then rebind. Since usbcore's check of the
1421 * configuration descriptors passed, we already know that
1422 * the size of the HID report descriptor has not changed.
1424 rdesc
= kmalloc(hid
->dev_rsize
, GFP_KERNEL
);
1426 dbg_hid("couldn't allocate rdesc memory (post_reset)\n");
1429 status
= hid_get_class_descriptor(dev
,
1430 interface
->desc
.bInterfaceNumber
,
1431 HID_DT_REPORT
, rdesc
, hid
->dev_rsize
);
1433 dbg_hid("reading report descriptor failed (post_reset)\n");
1437 status
= memcmp(rdesc
, hid
->dev_rdesc
, hid
->dev_rsize
);
1440 dbg_hid("report descriptor changed\n");
1444 spin_lock_irq(&usbhid
->lock
);
1445 clear_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
1446 spin_unlock_irq(&usbhid
->lock
);
1447 hid_set_idle(dev
, intf
->cur_altsetting
->desc
.bInterfaceNumber
, 0, 0);
1448 status
= hid_start_in(hid
);
1451 usbhid_restart_queues(usbhid
);
1456 int usbhid_get_power(struct hid_device
*hid
)
1458 struct usbhid_device
*usbhid
= hid
->driver_data
;
1460 return usb_autopm_get_interface(usbhid
->intf
);
1463 void usbhid_put_power(struct hid_device
*hid
)
1465 struct usbhid_device
*usbhid
= hid
->driver_data
;
1467 usb_autopm_put_interface(usbhid
->intf
);
1472 static int hid_resume_common(struct hid_device
*hid
, bool driver_suspended
)
1474 struct usbhid_device
*usbhid
= hid
->driver_data
;
1477 spin_lock_irq(&usbhid
->lock
);
1478 clear_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1479 usbhid_mark_busy(usbhid
);
1481 if (test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
) ||
1482 test_bit(HID_RESET_PENDING
, &usbhid
->iofl
))
1483 schedule_work(&usbhid
->reset_work
);
1484 usbhid
->retry_delay
= 0;
1486 usbhid_restart_queues(usbhid
);
1487 spin_unlock_irq(&usbhid
->lock
);
1489 status
= hid_start_in(hid
);
1493 if (driver_suspended
&& hid
->driver
&& hid
->driver
->resume
)
1494 status
= hid
->driver
->resume(hid
);
1498 static int hid_suspend(struct usb_interface
*intf
, pm_message_t message
)
1500 struct hid_device
*hid
= usb_get_intfdata(intf
);
1501 struct usbhid_device
*usbhid
= hid
->driver_data
;
1503 bool driver_suspended
= false;
1504 unsigned int ledcount
;
1506 if (PMSG_IS_AUTO(message
)) {
1507 ledcount
= hidinput_count_leds(hid
);
1508 spin_lock_irq(&usbhid
->lock
); /* Sync with error handler */
1509 if (!test_bit(HID_RESET_PENDING
, &usbhid
->iofl
)
1510 && !test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
)
1511 && !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)
1512 && !test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
)
1513 && !test_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
)
1514 && (!ledcount
|| ignoreled
))
1516 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1517 spin_unlock_irq(&usbhid
->lock
);
1518 if (hid
->driver
&& hid
->driver
->suspend
) {
1519 status
= hid
->driver
->suspend(hid
, message
);
1523 driver_suspended
= true;
1525 usbhid_mark_busy(usbhid
);
1526 spin_unlock_irq(&usbhid
->lock
);
1531 /* TODO: resume() might need to handle suspend failure */
1532 if (hid
->driver
&& hid
->driver
->suspend
)
1533 status
= hid
->driver
->suspend(hid
, message
);
1534 driver_suspended
= true;
1535 spin_lock_irq(&usbhid
->lock
);
1536 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1537 spin_unlock_irq(&usbhid
->lock
);
1538 if (usbhid_wait_io(hid
) < 0)
1542 hid_cancel_delayed_stuff(usbhid
);
1543 hid_cease_io(usbhid
);
1545 if (PMSG_IS_AUTO(message
) && test_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
)) {
1546 /* lost race against keypresses */
1550 dev_dbg(&intf
->dev
, "suspend\n");
1554 hid_resume_common(hid
, driver_suspended
);
1558 static int hid_resume(struct usb_interface
*intf
)
1560 struct hid_device
*hid
= usb_get_intfdata (intf
);
1561 struct usbhid_device
*usbhid
= hid
->driver_data
;
1564 if (!test_bit(HID_STARTED
, &usbhid
->iofl
))
1567 status
= hid_resume_common(hid
, true);
1568 dev_dbg(&intf
->dev
, "resume status %d\n", status
);
1572 static int hid_reset_resume(struct usb_interface
*intf
)
1574 struct hid_device
*hid
= usb_get_intfdata(intf
);
1575 struct usbhid_device
*usbhid
= hid
->driver_data
;
1578 clear_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1579 status
= hid_post_reset(intf
);
1580 if (status
>= 0 && hid
->driver
&& hid
->driver
->reset_resume
) {
1581 int ret
= hid
->driver
->reset_resume(hid
);
1588 #endif /* CONFIG_PM */
1590 static const struct usb_device_id hid_usb_ids
[] = {
1591 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
1592 .bInterfaceClass
= USB_INTERFACE_CLASS_HID
},
1593 { } /* Terminating entry */
1596 MODULE_DEVICE_TABLE (usb
, hid_usb_ids
);
1598 static struct usb_driver hid_driver
= {
1600 .probe
= usbhid_probe
,
1601 .disconnect
= usbhid_disconnect
,
1603 .suspend
= hid_suspend
,
1604 .resume
= hid_resume
,
1605 .reset_resume
= hid_reset_resume
,
1607 .pre_reset
= hid_pre_reset
,
1608 .post_reset
= hid_post_reset
,
1609 .id_table
= hid_usb_ids
,
1610 .supports_autosuspend
= 1,
1613 struct usb_interface
*usbhid_find_interface(int minor
)
1615 return usb_find_interface(&hid_driver
, minor
);
1618 static int __init
hid_init(void)
1620 int retval
= -ENOMEM
;
1622 retval
= usbhid_quirks_init(quirks_param
);
1624 goto usbhid_quirks_init_fail
;
1625 retval
= usb_register(&hid_driver
);
1627 goto usb_register_fail
;
1628 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1632 usbhid_quirks_exit();
1633 usbhid_quirks_init_fail
:
1637 static void __exit
hid_exit(void)
1639 usb_deregister(&hid_driver
);
1640 usbhid_quirks_exit();
1643 module_init(hid_init
);
1644 module_exit(hid_exit
);
1646 MODULE_AUTHOR("Andreas Gal");
1647 MODULE_AUTHOR("Vojtech Pavlik");
1648 MODULE_AUTHOR("Jiri Kosina");
1649 MODULE_DESCRIPTION(DRIVER_DESC
);
1650 MODULE_LICENSE(DRIVER_LICENSE
);