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"
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");
55 static unsigned int ignoreled
;
56 module_param_named(ignoreled
, ignoreled
, uint
, 0644);
57 MODULE_PARM_DESC(ignoreled
, "Autosuspend with active leds");
59 /* Quirks specified at module load time */
60 static char *quirks_param
[MAX_USBHID_BOOT_QUIRKS
];
61 module_param_array_named(quirks
, quirks_param
, charp
, NULL
, 0444);
62 MODULE_PARM_DESC(quirks
, "Add/modify USB HID quirks by specifying "
63 " quirks=vendorID:productID:quirks"
64 " where vendorID, productID, and quirks are all in"
67 * Input submission and I/O error handler.
69 static DEFINE_MUTEX(hid_open_mut
);
71 static void hid_io_error(struct hid_device
*hid
);
72 static int hid_submit_out(struct hid_device
*hid
);
73 static int hid_submit_ctrl(struct hid_device
*hid
);
74 static void hid_cancel_delayed_stuff(struct usbhid_device
*usbhid
);
76 /* Start up the input URB */
77 static int hid_start_in(struct hid_device
*hid
)
81 struct usbhid_device
*usbhid
= hid
->driver_data
;
83 spin_lock_irqsave(&usbhid
->lock
, flags
);
84 if ((hid
->open
> 0 || hid
->quirks
& HID_QUIRK_ALWAYS_POLL
) &&
85 !test_bit(HID_DISCONNECTED
, &usbhid
->iofl
) &&
86 !test_bit(HID_SUSPENDED
, &usbhid
->iofl
) &&
87 !test_and_set_bit(HID_IN_RUNNING
, &usbhid
->iofl
)) {
88 rc
= usb_submit_urb(usbhid
->urbin
, GFP_ATOMIC
);
90 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
92 set_bit(HID_NO_BANDWIDTH
, &usbhid
->iofl
);
94 clear_bit(HID_NO_BANDWIDTH
, &usbhid
->iofl
);
97 spin_unlock_irqrestore(&usbhid
->lock
, flags
);
101 /* I/O retry timer routine */
102 static void hid_retry_timeout(unsigned long _hid
)
104 struct hid_device
*hid
= (struct hid_device
*) _hid
;
105 struct usbhid_device
*usbhid
= hid
->driver_data
;
107 dev_dbg(&usbhid
->intf
->dev
, "retrying intr urb\n");
108 if (hid_start_in(hid
))
112 /* Workqueue routine to reset the device or clear a halt */
113 static void hid_reset(struct work_struct
*work
)
115 struct usbhid_device
*usbhid
=
116 container_of(work
, struct usbhid_device
, reset_work
);
117 struct hid_device
*hid
= usbhid
->hid
;
120 if (test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
)) {
121 dev_dbg(&usbhid
->intf
->dev
, "clear halt\n");
122 rc
= usb_clear_halt(hid_to_usb_dev(hid
), usbhid
->urbin
->pipe
);
123 clear_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
127 dev_dbg(&usbhid
->intf
->dev
,
128 "clear-halt failed: %d\n", rc
);
129 set_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
133 if (test_bit(HID_RESET_PENDING
, &usbhid
->iofl
)) {
134 dev_dbg(&usbhid
->intf
->dev
, "resetting device\n");
135 usb_queue_reset_device(usbhid
->intf
);
139 /* Main I/O error handler */
140 static void hid_io_error(struct hid_device
*hid
)
143 struct usbhid_device
*usbhid
= hid
->driver_data
;
145 spin_lock_irqsave(&usbhid
->lock
, flags
);
147 /* Stop when disconnected */
148 if (test_bit(HID_DISCONNECTED
, &usbhid
->iofl
))
151 /* If it has been a while since the last error, we'll assume
152 * this a brand new error and reset the retry timeout. */
153 if (time_after(jiffies
, usbhid
->stop_retry
+ HZ
/2))
154 usbhid
->retry_delay
= 0;
156 /* When an error occurs, retry at increasing intervals */
157 if (usbhid
->retry_delay
== 0) {
158 usbhid
->retry_delay
= 13; /* Then 26, 52, 104, 104, ... */
159 usbhid
->stop_retry
= jiffies
+ msecs_to_jiffies(1000);
160 } else if (usbhid
->retry_delay
< 100)
161 usbhid
->retry_delay
*= 2;
163 if (time_after(jiffies
, usbhid
->stop_retry
)) {
165 /* Retries failed, so do a port reset unless we lack bandwidth*/
166 if (!test_bit(HID_NO_BANDWIDTH
, &usbhid
->iofl
)
167 && !test_and_set_bit(HID_RESET_PENDING
, &usbhid
->iofl
)) {
169 schedule_work(&usbhid
->reset_work
);
174 mod_timer(&usbhid
->io_retry
,
175 jiffies
+ msecs_to_jiffies(usbhid
->retry_delay
));
177 spin_unlock_irqrestore(&usbhid
->lock
, flags
);
180 static void usbhid_mark_busy(struct usbhid_device
*usbhid
)
182 struct usb_interface
*intf
= usbhid
->intf
;
184 usb_mark_last_busy(interface_to_usbdev(intf
));
187 static int usbhid_restart_out_queue(struct usbhid_device
*usbhid
)
189 struct hid_device
*hid
= usb_get_intfdata(usbhid
->intf
);
193 if (!hid
|| test_bit(HID_RESET_PENDING
, &usbhid
->iofl
) ||
194 test_bit(HID_SUSPENDED
, &usbhid
->iofl
))
197 if ((kicked
= (usbhid
->outhead
!= usbhid
->outtail
))) {
198 hid_dbg(hid
, "Kicking head %d tail %d", usbhid
->outhead
, usbhid
->outtail
);
200 /* Try to wake up from autosuspend... */
201 r
= usb_autopm_get_interface_async(usbhid
->intf
);
206 * If still suspended, don't submit. Submission will
207 * occur if/when resume drains the queue.
209 if (test_bit(HID_SUSPENDED
, &usbhid
->iofl
)) {
210 usb_autopm_put_interface_no_suspend(usbhid
->intf
);
214 /* Asynchronously flush queue. */
215 set_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
216 if (hid_submit_out(hid
)) {
217 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
218 usb_autopm_put_interface_async(usbhid
->intf
);
220 wake_up(&usbhid
->wait
);
225 static int usbhid_restart_ctrl_queue(struct usbhid_device
*usbhid
)
227 struct hid_device
*hid
= usb_get_intfdata(usbhid
->intf
);
231 WARN_ON(hid
== NULL
);
232 if (!hid
|| test_bit(HID_RESET_PENDING
, &usbhid
->iofl
) ||
233 test_bit(HID_SUSPENDED
, &usbhid
->iofl
))
236 if ((kicked
= (usbhid
->ctrlhead
!= usbhid
->ctrltail
))) {
237 hid_dbg(hid
, "Kicking head %d tail %d", usbhid
->ctrlhead
, usbhid
->ctrltail
);
239 /* Try to wake up from autosuspend... */
240 r
= usb_autopm_get_interface_async(usbhid
->intf
);
245 * If still suspended, don't submit. Submission will
246 * occur if/when resume drains the queue.
248 if (test_bit(HID_SUSPENDED
, &usbhid
->iofl
)) {
249 usb_autopm_put_interface_no_suspend(usbhid
->intf
);
253 /* Asynchronously flush queue. */
254 set_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
255 if (hid_submit_ctrl(hid
)) {
256 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
257 usb_autopm_put_interface_async(usbhid
->intf
);
259 wake_up(&usbhid
->wait
);
265 * Input interrupt completion handler.
268 static void hid_irq_in(struct urb
*urb
)
270 struct hid_device
*hid
= urb
->context
;
271 struct usbhid_device
*usbhid
= hid
->driver_data
;
274 switch (urb
->status
) {
275 case 0: /* success */
276 usbhid
->retry_delay
= 0;
277 if ((hid
->quirks
& HID_QUIRK_ALWAYS_POLL
) && !hid
->open
)
279 usbhid_mark_busy(usbhid
);
280 if (!test_bit(HID_RESUME_RUNNING
, &usbhid
->iofl
)) {
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
);
295 case -EPIPE
: /* stall */
296 usbhid_mark_busy(usbhid
);
297 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
298 set_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
299 schedule_work(&usbhid
->reset_work
);
301 case -ECONNRESET
: /* unlink */
303 case -ESHUTDOWN
: /* unplug */
304 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
306 case -EILSEQ
: /* protocol error or unplug */
307 case -EPROTO
: /* protocol error or unplug */
308 case -ETIME
: /* protocol error or unplug */
309 case -ETIMEDOUT
: /* Should never happen, but... */
310 usbhid_mark_busy(usbhid
);
311 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
315 hid_warn(urb
->dev
, "input irq status %d received\n",
319 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
321 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
322 if (status
!= -EPERM
) {
323 hid_err(hid
, "can't resubmit intr, %s-%s/input%d, status %d\n",
324 hid_to_usb_dev(hid
)->bus
->bus_name
,
325 hid_to_usb_dev(hid
)->devpath
,
326 usbhid
->ifnum
, status
);
332 static int hid_submit_out(struct hid_device
*hid
)
334 struct hid_report
*report
;
336 struct usbhid_device
*usbhid
= hid
->driver_data
;
339 report
= usbhid
->out
[usbhid
->outtail
].report
;
340 raw_report
= usbhid
->out
[usbhid
->outtail
].raw_report
;
342 usbhid
->urbout
->transfer_buffer_length
= hid_report_len(report
);
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
;
480 case 0: /* success */
481 if (usbhid
->ctrl
[usbhid
->ctrltail
].dir
== USB_DIR_IN
)
482 hid_input_report(urb
->context
,
483 usbhid
->ctrl
[usbhid
->ctrltail
].report
->type
,
484 urb
->transfer_buffer
, urb
->actual_length
, 0);
486 case -ESHUTDOWN
: /* unplug */
488 case -EILSEQ
: /* protocol error or unplug */
489 case -EPROTO
: /* protocol error or unplug */
490 case -ECONNRESET
: /* unlink */
492 case -EPIPE
: /* report not available */
495 hid_warn(urb
->dev
, "ctrl urb status %d received\n", status
);
498 spin_lock(&usbhid
->lock
);
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 set_bit(HID_RESUME_RUNNING
, &usbhid
->iofl
);
692 res
= hid_start_in(hid
);
694 if (res
!= -ENOSPC
) {
698 /* no use opening if resources are insufficient */
701 usbhid
->intf
->needs_remote_wakeup
= 0;
704 usb_autopm_put_interface(usbhid
->intf
);
707 * In case events are generated while nobody was listening,
708 * some are released when the device is re-opened.
709 * Wait 50 msec for the queue to empty before allowing events
712 if (res
== 0 && !(hid
->quirks
& HID_QUIRK_ALWAYS_POLL
))
714 clear_bit(HID_RESUME_RUNNING
, &usbhid
->iofl
);
717 mutex_unlock(&hid_open_mut
);
721 void usbhid_close(struct hid_device
*hid
)
723 struct usbhid_device
*usbhid
= hid
->driver_data
;
725 mutex_lock(&hid_open_mut
);
727 /* protecting hid->open to make sure we don't restart
728 * data acquistion due to a resumption we no longer
731 spin_lock_irq(&usbhid
->lock
);
733 spin_unlock_irq(&usbhid
->lock
);
734 hid_cancel_delayed_stuff(usbhid
);
735 if (!(hid
->quirks
& HID_QUIRK_ALWAYS_POLL
)) {
736 usb_kill_urb(usbhid
->urbin
);
737 usbhid
->intf
->needs_remote_wakeup
= 0;
740 spin_unlock_irq(&usbhid
->lock
);
742 mutex_unlock(&hid_open_mut
);
746 * Initialize all reports
749 void usbhid_init_reports(struct hid_device
*hid
)
751 struct hid_report
*report
;
752 struct usbhid_device
*usbhid
= hid
->driver_data
;
753 struct hid_report_enum
*report_enum
;
756 report_enum
= &hid
->report_enum
[HID_INPUT_REPORT
];
757 list_for_each_entry(report
, &report_enum
->report_list
, list
)
758 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
760 report_enum
= &hid
->report_enum
[HID_FEATURE_REPORT
];
761 list_for_each_entry(report
, &report_enum
->report_list
, list
)
762 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
765 ret
= usbhid_wait_io(hid
);
768 if (test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
769 usb_kill_urb(usbhid
->urbctrl
);
770 if (test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
771 usb_kill_urb(usbhid
->urbout
);
772 ret
= usbhid_wait_io(hid
);
776 hid_warn(hid
, "timeout initializing reports\n");
780 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
782 static int hid_find_field_early(struct hid_device
*hid
, unsigned int page
,
783 unsigned int hid_code
, struct hid_field
**pfield
)
785 struct hid_report
*report
;
786 struct hid_field
*field
;
787 struct hid_usage
*usage
;
790 list_for_each_entry(report
, &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
791 for (i
= 0; i
< report
->maxfield
; i
++) {
792 field
= report
->field
[i
];
793 for (j
= 0; j
< field
->maxusage
; j
++) {
794 usage
= &field
->usage
[j
];
795 if ((usage
->hid
& HID_USAGE_PAGE
) == page
&&
796 (usage
->hid
& 0xFFFF) == hid_code
) {
806 static void usbhid_set_leds(struct hid_device
*hid
)
808 struct hid_field
*field
;
811 if ((offset
= hid_find_field_early(hid
, HID_UP_LED
, 0x01, &field
)) != -1) {
812 hid_set_field(field
, offset
, 0);
813 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
818 * Traverse the supplied list of reports and find the longest
820 static void hid_find_max_report(struct hid_device
*hid
, unsigned int type
,
823 struct hid_report
*report
;
826 list_for_each_entry(report
, &hid
->report_enum
[type
].report_list
, list
) {
827 size
= ((report
->size
- 1) >> 3) + 1 + hid
->report_enum
[type
].numbered
;
833 static int hid_alloc_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
835 struct usbhid_device
*usbhid
= hid
->driver_data
;
837 usbhid
->inbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
839 usbhid
->outbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
840 &usbhid
->outbuf_dma
);
841 usbhid
->cr
= kmalloc(sizeof(*usbhid
->cr
), GFP_KERNEL
);
842 usbhid
->ctrlbuf
= usb_alloc_coherent(dev
, usbhid
->bufsize
, GFP_KERNEL
,
843 &usbhid
->ctrlbuf_dma
);
844 if (!usbhid
->inbuf
|| !usbhid
->outbuf
|| !usbhid
->cr
||
851 static int usbhid_get_raw_report(struct hid_device
*hid
,
852 unsigned char report_number
, __u8
*buf
, size_t count
,
853 unsigned char report_type
)
855 struct usbhid_device
*usbhid
= hid
->driver_data
;
856 struct usb_device
*dev
= hid_to_usb_dev(hid
);
857 struct usb_interface
*intf
= usbhid
->intf
;
858 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
859 int skipped_report_id
= 0;
862 /* Byte 0 is the report number. Report data starts at byte 1.*/
863 buf
[0] = report_number
;
864 if (report_number
== 0x0) {
865 /* Offset the return buffer by 1, so that the report ID
866 will remain in byte 0. */
869 skipped_report_id
= 1;
871 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
873 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
874 ((report_type
+ 1) << 8) | report_number
,
875 interface
->desc
.bInterfaceNumber
, buf
, count
,
876 USB_CTRL_SET_TIMEOUT
);
878 /* count also the report id */
879 if (ret
> 0 && skipped_report_id
)
885 static int usbhid_set_raw_report(struct hid_device
*hid
, unsigned int reportnum
,
886 __u8
*buf
, size_t count
, unsigned char rtype
)
888 struct usbhid_device
*usbhid
= hid
->driver_data
;
889 struct usb_device
*dev
= hid_to_usb_dev(hid
);
890 struct usb_interface
*intf
= usbhid
->intf
;
891 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
892 int ret
, skipped_report_id
= 0;
894 /* Byte 0 is the report number. Report data starts at byte 1.*/
895 if ((rtype
== HID_OUTPUT_REPORT
) &&
896 (hid
->quirks
& HID_QUIRK_SKIP_OUTPUT_REPORT_ID
))
902 /* Don't send the Report ID */
905 skipped_report_id
= 1;
908 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
910 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
911 ((rtype
+ 1) << 8) | reportnum
,
912 interface
->desc
.bInterfaceNumber
, buf
, count
,
913 USB_CTRL_SET_TIMEOUT
);
914 /* count also the report id, if this was a numbered report. */
915 if (ret
> 0 && skipped_report_id
)
921 static int usbhid_output_report(struct hid_device
*hid
, __u8
*buf
, size_t count
)
923 struct usbhid_device
*usbhid
= hid
->driver_data
;
924 struct usb_device
*dev
= hid_to_usb_dev(hid
);
925 int actual_length
, skipped_report_id
= 0, ret
;
931 /* Don't send the Report ID */
934 skipped_report_id
= 1;
937 ret
= usb_interrupt_msg(dev
, usbhid
->urbout
->pipe
,
938 buf
, count
, &actual_length
,
939 USB_CTRL_SET_TIMEOUT
);
940 /* return the number of bytes transferred */
943 /* count also the report id */
944 if (skipped_report_id
)
951 static void hid_free_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
953 struct usbhid_device
*usbhid
= hid
->driver_data
;
955 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->inbuf
, usbhid
->inbuf_dma
);
956 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->outbuf
, usbhid
->outbuf_dma
);
958 usb_free_coherent(dev
, usbhid
->bufsize
, usbhid
->ctrlbuf
, usbhid
->ctrlbuf_dma
);
961 static int usbhid_parse(struct hid_device
*hid
)
963 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
964 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
965 struct usb_device
*dev
= interface_to_usbdev (intf
);
966 struct hid_descriptor
*hdesc
;
968 unsigned int rsize
= 0;
972 quirks
= usbhid_lookup_quirk(le16_to_cpu(dev
->descriptor
.idVendor
),
973 le16_to_cpu(dev
->descriptor
.idProduct
));
975 if (quirks
& HID_QUIRK_IGNORE
)
978 /* Many keyboards and mice don't like to be polled for reports,
979 * so we will always set the HID_QUIRK_NOGET flag for them. */
980 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
) {
981 if (interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_KEYBOARD
||
982 interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_MOUSE
)
983 quirks
|= HID_QUIRK_NOGET
;
986 if (usb_get_extra_descriptor(interface
, HID_DT_HID
, &hdesc
) &&
987 (!interface
->desc
.bNumEndpoints
||
988 usb_get_extra_descriptor(&interface
->endpoint
[0], HID_DT_HID
, &hdesc
))) {
989 dbg_hid("class descriptor not present\n");
993 hid
->version
= le16_to_cpu(hdesc
->bcdHID
);
994 hid
->country
= hdesc
->bCountryCode
;
996 for (n
= 0; n
< hdesc
->bNumDescriptors
; n
++)
997 if (hdesc
->desc
[n
].bDescriptorType
== HID_DT_REPORT
)
998 rsize
= le16_to_cpu(hdesc
->desc
[n
].wDescriptorLength
);
1000 if (!rsize
|| rsize
> HID_MAX_DESCRIPTOR_SIZE
) {
1001 dbg_hid("weird size of report descriptor (%u)\n", rsize
);
1005 if (!(rdesc
= kmalloc(rsize
, GFP_KERNEL
))) {
1006 dbg_hid("couldn't allocate rdesc memory\n");
1010 hid_set_idle(dev
, interface
->desc
.bInterfaceNumber
, 0, 0);
1012 ret
= hid_get_class_descriptor(dev
, interface
->desc
.bInterfaceNumber
,
1013 HID_DT_REPORT
, rdesc
, rsize
);
1015 dbg_hid("reading report descriptor failed\n");
1020 ret
= hid_parse_report(hid
, rdesc
, rsize
);
1023 dbg_hid("parsing report descriptor failed\n");
1027 hid
->quirks
|= quirks
;
1034 static int usbhid_start(struct hid_device
*hid
)
1036 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
1037 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1038 struct usb_device
*dev
= interface_to_usbdev(intf
);
1039 struct usbhid_device
*usbhid
= hid
->driver_data
;
1040 unsigned int n
, insize
= 0;
1043 clear_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1045 usbhid
->bufsize
= HID_MIN_BUFFER_SIZE
;
1046 hid_find_max_report(hid
, HID_INPUT_REPORT
, &usbhid
->bufsize
);
1047 hid_find_max_report(hid
, HID_OUTPUT_REPORT
, &usbhid
->bufsize
);
1048 hid_find_max_report(hid
, HID_FEATURE_REPORT
, &usbhid
->bufsize
);
1050 if (usbhid
->bufsize
> HID_MAX_BUFFER_SIZE
)
1051 usbhid
->bufsize
= HID_MAX_BUFFER_SIZE
;
1053 hid_find_max_report(hid
, HID_INPUT_REPORT
, &insize
);
1055 if (insize
> HID_MAX_BUFFER_SIZE
)
1056 insize
= HID_MAX_BUFFER_SIZE
;
1058 if (hid_alloc_buffers(dev
, hid
)) {
1063 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++) {
1064 struct usb_endpoint_descriptor
*endpoint
;
1068 endpoint
= &interface
->endpoint
[n
].desc
;
1069 if (!usb_endpoint_xfer_int(endpoint
))
1072 interval
= endpoint
->bInterval
;
1074 /* Some vendors give fullspeed interval on highspeed devides */
1075 if (hid
->quirks
& HID_QUIRK_FULLSPEED_INTERVAL
&&
1076 dev
->speed
== USB_SPEED_HIGH
) {
1077 interval
= fls(endpoint
->bInterval
*8);
1078 printk(KERN_INFO
"%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1079 hid
->name
, endpoint
->bInterval
, interval
);
1082 /* Change the polling interval of mice. */
1083 if (hid
->collection
->usage
== HID_GD_MOUSE
&& hid_mousepoll_interval
> 0)
1084 interval
= hid_mousepoll_interval
;
1087 if (usb_endpoint_dir_in(endpoint
)) {
1090 if (!(usbhid
->urbin
= usb_alloc_urb(0, GFP_KERNEL
)))
1092 pipe
= usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
);
1093 usb_fill_int_urb(usbhid
->urbin
, dev
, pipe
, usbhid
->inbuf
, insize
,
1094 hid_irq_in
, hid
, interval
);
1095 usbhid
->urbin
->transfer_dma
= usbhid
->inbuf_dma
;
1096 usbhid
->urbin
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1100 if (!(usbhid
->urbout
= usb_alloc_urb(0, GFP_KERNEL
)))
1102 pipe
= usb_sndintpipe(dev
, endpoint
->bEndpointAddress
);
1103 usb_fill_int_urb(usbhid
->urbout
, dev
, pipe
, usbhid
->outbuf
, 0,
1104 hid_irq_out
, hid
, interval
);
1105 usbhid
->urbout
->transfer_dma
= usbhid
->outbuf_dma
;
1106 usbhid
->urbout
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1110 usbhid
->urbctrl
= usb_alloc_urb(0, GFP_KERNEL
);
1111 if (!usbhid
->urbctrl
) {
1116 usb_fill_control_urb(usbhid
->urbctrl
, dev
, 0, (void *) usbhid
->cr
,
1117 usbhid
->ctrlbuf
, 1, hid_ctrl
, hid
);
1118 usbhid
->urbctrl
->transfer_dma
= usbhid
->ctrlbuf_dma
;
1119 usbhid
->urbctrl
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1121 set_bit(HID_STARTED
, &usbhid
->iofl
);
1123 if (hid
->quirks
& HID_QUIRK_ALWAYS_POLL
) {
1124 ret
= usb_autopm_get_interface(usbhid
->intf
);
1127 usbhid
->intf
->needs_remote_wakeup
= 1;
1128 ret
= hid_start_in(hid
);
1131 "failed to start in urb: %d\n", ret
);
1133 usb_autopm_put_interface(usbhid
->intf
);
1136 /* Some keyboards don't work until their LEDs have been set.
1137 * Since BIOSes do set the LEDs, it must be safe for any device
1138 * that supports the keyboard boot protocol.
1139 * In addition, enable remote wakeup by default for all keyboard
1140 * devices supporting the boot protocol.
1142 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
&&
1143 interface
->desc
.bInterfaceProtocol
==
1144 USB_INTERFACE_PROTOCOL_KEYBOARD
) {
1145 usbhid_set_leds(hid
);
1146 device_set_wakeup_enable(&dev
->dev
, 1);
1151 usb_free_urb(usbhid
->urbin
);
1152 usb_free_urb(usbhid
->urbout
);
1153 usb_free_urb(usbhid
->urbctrl
);
1154 usbhid
->urbin
= NULL
;
1155 usbhid
->urbout
= NULL
;
1156 usbhid
->urbctrl
= NULL
;
1157 hid_free_buffers(dev
, hid
);
1161 static void usbhid_stop(struct hid_device
*hid
)
1163 struct usbhid_device
*usbhid
= hid
->driver_data
;
1165 if (WARN_ON(!usbhid
))
1168 if (hid
->quirks
& HID_QUIRK_ALWAYS_POLL
)
1169 usbhid
->intf
->needs_remote_wakeup
= 0;
1171 clear_bit(HID_STARTED
, &usbhid
->iofl
);
1172 spin_lock_irq(&usbhid
->lock
); /* Sync with error and led handlers */
1173 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1174 spin_unlock_irq(&usbhid
->lock
);
1175 usb_kill_urb(usbhid
->urbin
);
1176 usb_kill_urb(usbhid
->urbout
);
1177 usb_kill_urb(usbhid
->urbctrl
);
1179 hid_cancel_delayed_stuff(usbhid
);
1183 usb_free_urb(usbhid
->urbin
);
1184 usb_free_urb(usbhid
->urbctrl
);
1185 usb_free_urb(usbhid
->urbout
);
1186 usbhid
->urbin
= NULL
; /* don't mess up next start */
1187 usbhid
->urbctrl
= NULL
;
1188 usbhid
->urbout
= NULL
;
1190 hid_free_buffers(hid_to_usb_dev(hid
), hid
);
1193 static int usbhid_power(struct hid_device
*hid
, int lvl
)
1198 case PM_HINT_FULLON
:
1199 r
= usbhid_get_power(hid
);
1201 case PM_HINT_NORMAL
:
1202 usbhid_put_power(hid
);
1208 static void usbhid_request(struct hid_device
*hid
, struct hid_report
*rep
, int reqtype
)
1211 case HID_REQ_GET_REPORT
:
1212 usbhid_submit_report(hid
, rep
, USB_DIR_IN
);
1214 case HID_REQ_SET_REPORT
:
1215 usbhid_submit_report(hid
, rep
, USB_DIR_OUT
);
1220 static int usbhid_raw_request(struct hid_device
*hid
, unsigned char reportnum
,
1221 __u8
*buf
, size_t len
, unsigned char rtype
,
1225 case HID_REQ_GET_REPORT
:
1226 return usbhid_get_raw_report(hid
, reportnum
, buf
, len
, rtype
);
1227 case HID_REQ_SET_REPORT
:
1228 return usbhid_set_raw_report(hid
, reportnum
, buf
, len
, rtype
);
1234 static int usbhid_idle(struct hid_device
*hid
, int report
, int idle
,
1237 struct usb_device
*dev
= hid_to_usb_dev(hid
);
1238 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
1239 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1240 int ifnum
= interface
->desc
.bInterfaceNumber
;
1242 if (reqtype
!= HID_REQ_SET_IDLE
)
1245 return hid_set_idle(dev
, ifnum
, report
, idle
);
1248 static struct hid_ll_driver usb_hid_driver
= {
1249 .parse
= usbhid_parse
,
1250 .start
= usbhid_start
,
1251 .stop
= usbhid_stop
,
1252 .open
= usbhid_open
,
1253 .close
= usbhid_close
,
1254 .power
= usbhid_power
,
1255 .request
= usbhid_request
,
1256 .wait
= usbhid_wait_io
,
1257 .raw_request
= usbhid_raw_request
,
1258 .output_report
= usbhid_output_report
,
1259 .idle
= usbhid_idle
,
1262 static int usbhid_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1264 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1265 struct usb_device
*dev
= interface_to_usbdev(intf
);
1266 struct usbhid_device
*usbhid
;
1267 struct hid_device
*hid
;
1268 unsigned int n
, has_in
= 0;
1272 dbg_hid("HID probe called for ifnum %d\n",
1273 intf
->altsetting
->desc
.bInterfaceNumber
);
1275 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++)
1276 if (usb_endpoint_is_int_in(&interface
->endpoint
[n
].desc
))
1279 hid_err(intf
, "couldn't find an input interrupt endpoint\n");
1283 hid
= hid_allocate_device();
1285 return PTR_ERR(hid
);
1287 usb_set_intfdata(intf
, hid
);
1288 hid
->ll_driver
= &usb_hid_driver
;
1289 hid
->ff_init
= hid_pidff_init
;
1290 #ifdef CONFIG_USB_HIDDEV
1291 hid
->hiddev_connect
= hiddev_connect
;
1292 hid
->hiddev_disconnect
= hiddev_disconnect
;
1293 hid
->hiddev_hid_event
= hiddev_hid_event
;
1294 hid
->hiddev_report_event
= hiddev_report_event
;
1296 hid
->dev
.parent
= &intf
->dev
;
1298 hid
->vendor
= le16_to_cpu(dev
->descriptor
.idVendor
);
1299 hid
->product
= le16_to_cpu(dev
->descriptor
.idProduct
);
1301 hid
->quirks
= usbhid_lookup_quirk(hid
->vendor
, hid
->product
);
1302 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
==
1303 USB_INTERFACE_PROTOCOL_MOUSE
)
1304 hid
->type
= HID_TYPE_USBMOUSE
;
1305 else if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
== 0)
1306 hid
->type
= HID_TYPE_USBNONE
;
1308 if (dev
->manufacturer
)
1309 strlcpy(hid
->name
, dev
->manufacturer
, sizeof(hid
->name
));
1312 if (dev
->manufacturer
)
1313 strlcat(hid
->name
, " ", sizeof(hid
->name
));
1314 strlcat(hid
->name
, dev
->product
, sizeof(hid
->name
));
1317 if (!strlen(hid
->name
))
1318 snprintf(hid
->name
, sizeof(hid
->name
), "HID %04x:%04x",
1319 le16_to_cpu(dev
->descriptor
.idVendor
),
1320 le16_to_cpu(dev
->descriptor
.idProduct
));
1322 usb_make_path(dev
, hid
->phys
, sizeof(hid
->phys
));
1323 strlcat(hid
->phys
, "/input", sizeof(hid
->phys
));
1324 len
= strlen(hid
->phys
);
1325 if (len
< sizeof(hid
->phys
) - 1)
1326 snprintf(hid
->phys
+ len
, sizeof(hid
->phys
) - len
,
1327 "%d", intf
->altsetting
[0].desc
.bInterfaceNumber
);
1329 if (usb_string(dev
, dev
->descriptor
.iSerialNumber
, hid
->uniq
, 64) <= 0)
1332 usbhid
= kzalloc(sizeof(*usbhid
), GFP_KERNEL
);
1333 if (usbhid
== NULL
) {
1338 hid
->driver_data
= usbhid
;
1340 usbhid
->intf
= intf
;
1341 usbhid
->ifnum
= interface
->desc
.bInterfaceNumber
;
1343 init_waitqueue_head(&usbhid
->wait
);
1344 INIT_WORK(&usbhid
->reset_work
, hid_reset
);
1345 setup_timer(&usbhid
->io_retry
, hid_retry_timeout
, (unsigned long) hid
);
1346 spin_lock_init(&usbhid
->lock
);
1348 ret
= hid_add_device(hid
);
1351 hid_err(intf
, "can't add hid device: %d\n", ret
);
1359 hid_destroy_device(hid
);
1363 static void usbhid_disconnect(struct usb_interface
*intf
)
1365 struct hid_device
*hid
= usb_get_intfdata(intf
);
1366 struct usbhid_device
*usbhid
;
1371 usbhid
= hid
->driver_data
;
1372 spin_lock_irq(&usbhid
->lock
); /* Sync with error and led handlers */
1373 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
1374 spin_unlock_irq(&usbhid
->lock
);
1375 hid_destroy_device(hid
);
1379 static void hid_cancel_delayed_stuff(struct usbhid_device
*usbhid
)
1381 del_timer_sync(&usbhid
->io_retry
);
1382 cancel_work_sync(&usbhid
->reset_work
);
1385 static void hid_cease_io(struct usbhid_device
*usbhid
)
1387 del_timer_sync(&usbhid
->io_retry
);
1388 usb_kill_urb(usbhid
->urbin
);
1389 usb_kill_urb(usbhid
->urbctrl
);
1390 usb_kill_urb(usbhid
->urbout
);
1393 static void hid_restart_io(struct hid_device
*hid
)
1395 struct usbhid_device
*usbhid
= hid
->driver_data
;
1396 int clear_halt
= test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
1397 int reset_pending
= test_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
1399 spin_lock_irq(&usbhid
->lock
);
1400 clear_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1401 usbhid_mark_busy(usbhid
);
1403 if (clear_halt
|| reset_pending
)
1404 schedule_work(&usbhid
->reset_work
);
1405 usbhid
->retry_delay
= 0;
1406 spin_unlock_irq(&usbhid
->lock
);
1408 if (reset_pending
|| !test_bit(HID_STARTED
, &usbhid
->iofl
))
1412 if (hid_start_in(hid
) < 0)
1416 spin_lock_irq(&usbhid
->lock
);
1417 if (usbhid
->urbout
&& !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
1418 usbhid_restart_out_queue(usbhid
);
1419 if (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
1420 usbhid_restart_ctrl_queue(usbhid
);
1421 spin_unlock_irq(&usbhid
->lock
);
1424 /* Treat USB reset pretty much the same as suspend/resume */
1425 static int hid_pre_reset(struct usb_interface
*intf
)
1427 struct hid_device
*hid
= usb_get_intfdata(intf
);
1428 struct usbhid_device
*usbhid
= hid
->driver_data
;
1430 spin_lock_irq(&usbhid
->lock
);
1431 set_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
1432 spin_unlock_irq(&usbhid
->lock
);
1433 hid_cease_io(usbhid
);
1438 /* Same routine used for post_reset and reset_resume */
1439 static int hid_post_reset(struct usb_interface
*intf
)
1441 struct usb_device
*dev
= interface_to_usbdev (intf
);
1442 struct hid_device
*hid
= usb_get_intfdata(intf
);
1443 struct usbhid_device
*usbhid
= hid
->driver_data
;
1444 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
1448 /* Fetch and examine the HID report descriptor. If this
1449 * has changed, then rebind. Since usbcore's check of the
1450 * configuration descriptors passed, we already know that
1451 * the size of the HID report descriptor has not changed.
1453 rdesc
= kmalloc(hid
->dev_rsize
, GFP_KERNEL
);
1455 dbg_hid("couldn't allocate rdesc memory (post_reset)\n");
1458 status
= hid_get_class_descriptor(dev
,
1459 interface
->desc
.bInterfaceNumber
,
1460 HID_DT_REPORT
, rdesc
, hid
->dev_rsize
);
1462 dbg_hid("reading report descriptor failed (post_reset)\n");
1466 status
= memcmp(rdesc
, hid
->dev_rdesc
, hid
->dev_rsize
);
1469 dbg_hid("report descriptor changed\n");
1473 /* No need to do another reset or clear a halted endpoint */
1474 spin_lock_irq(&usbhid
->lock
);
1475 clear_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
1476 clear_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
1477 spin_unlock_irq(&usbhid
->lock
);
1478 hid_set_idle(dev
, intf
->cur_altsetting
->desc
.bInterfaceNumber
, 0, 0);
1480 hid_restart_io(hid
);
1485 int usbhid_get_power(struct hid_device
*hid
)
1487 struct usbhid_device
*usbhid
= hid
->driver_data
;
1489 return usb_autopm_get_interface(usbhid
->intf
);
1492 void usbhid_put_power(struct hid_device
*hid
)
1494 struct usbhid_device
*usbhid
= hid
->driver_data
;
1496 usb_autopm_put_interface(usbhid
->intf
);
1501 static int hid_resume_common(struct hid_device
*hid
, bool driver_suspended
)
1505 hid_restart_io(hid
);
1506 if (driver_suspended
&& hid
->driver
&& hid
->driver
->resume
)
1507 status
= hid
->driver
->resume(hid
);
1511 static int hid_suspend(struct usb_interface
*intf
, pm_message_t message
)
1513 struct hid_device
*hid
= usb_get_intfdata(intf
);
1514 struct usbhid_device
*usbhid
= hid
->driver_data
;
1516 bool driver_suspended
= false;
1517 unsigned int ledcount
;
1519 if (PMSG_IS_AUTO(message
)) {
1520 ledcount
= hidinput_count_leds(hid
);
1521 spin_lock_irq(&usbhid
->lock
); /* Sync with error handler */
1522 if (!test_bit(HID_RESET_PENDING
, &usbhid
->iofl
)
1523 && !test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
)
1524 && !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)
1525 && !test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
)
1526 && !test_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
)
1527 && (!ledcount
|| ignoreled
))
1529 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1530 spin_unlock_irq(&usbhid
->lock
);
1531 if (hid
->driver
&& hid
->driver
->suspend
) {
1532 status
= hid
->driver
->suspend(hid
, message
);
1536 driver_suspended
= true;
1538 usbhid_mark_busy(usbhid
);
1539 spin_unlock_irq(&usbhid
->lock
);
1544 /* TODO: resume() might need to handle suspend failure */
1545 if (hid
->driver
&& hid
->driver
->suspend
)
1546 status
= hid
->driver
->suspend(hid
, message
);
1547 driver_suspended
= true;
1548 spin_lock_irq(&usbhid
->lock
);
1549 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1550 spin_unlock_irq(&usbhid
->lock
);
1551 if (usbhid_wait_io(hid
) < 0)
1555 hid_cancel_delayed_stuff(usbhid
);
1556 hid_cease_io(usbhid
);
1558 if (PMSG_IS_AUTO(message
) && test_bit(HID_KEYS_PRESSED
, &usbhid
->iofl
)) {
1559 /* lost race against keypresses */
1563 dev_dbg(&intf
->dev
, "suspend\n");
1567 hid_resume_common(hid
, driver_suspended
);
1571 static int hid_resume(struct usb_interface
*intf
)
1573 struct hid_device
*hid
= usb_get_intfdata (intf
);
1576 status
= hid_resume_common(hid
, true);
1577 dev_dbg(&intf
->dev
, "resume status %d\n", status
);
1581 static int hid_reset_resume(struct usb_interface
*intf
)
1583 struct hid_device
*hid
= usb_get_intfdata(intf
);
1586 status
= hid_post_reset(intf
);
1587 if (status
>= 0 && hid
->driver
&& hid
->driver
->reset_resume
) {
1588 int ret
= hid
->driver
->reset_resume(hid
);
1595 #endif /* CONFIG_PM */
1597 static const struct usb_device_id hid_usb_ids
[] = {
1598 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
1599 .bInterfaceClass
= USB_INTERFACE_CLASS_HID
},
1600 { } /* Terminating entry */
1603 MODULE_DEVICE_TABLE (usb
, hid_usb_ids
);
1605 static struct usb_driver hid_driver
= {
1607 .probe
= usbhid_probe
,
1608 .disconnect
= usbhid_disconnect
,
1610 .suspend
= hid_suspend
,
1611 .resume
= hid_resume
,
1612 .reset_resume
= hid_reset_resume
,
1614 .pre_reset
= hid_pre_reset
,
1615 .post_reset
= hid_post_reset
,
1616 .id_table
= hid_usb_ids
,
1617 .supports_autosuspend
= 1,
1620 struct usb_interface
*usbhid_find_interface(int minor
)
1622 return usb_find_interface(&hid_driver
, minor
);
1625 static int __init
hid_init(void)
1627 int retval
= -ENOMEM
;
1629 retval
= usbhid_quirks_init(quirks_param
);
1631 goto usbhid_quirks_init_fail
;
1632 retval
= usb_register(&hid_driver
);
1634 goto usb_register_fail
;
1635 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1639 usbhid_quirks_exit();
1640 usbhid_quirks_init_fail
:
1644 static void __exit
hid_exit(void)
1646 usb_deregister(&hid_driver
);
1647 usbhid_quirks_exit();
1650 module_init(hid_init
);
1651 module_exit(hid_exit
);
1653 MODULE_AUTHOR("Andreas Gal");
1654 MODULE_AUTHOR("Vojtech Pavlik");
1655 MODULE_AUTHOR("Jiri Kosina");
1656 MODULE_DESCRIPTION(DRIVER_DESC
);
1657 MODULE_LICENSE("GPL");