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) 2006-2008 Jiri Kosina
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the Free
13 * Software Foundation; either version 2 of the License, or (at your option)
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/init.h>
20 #include <linux/kernel.h>
21 #include <linux/list.h>
23 #include <linux/mutex.h>
24 #include <linux/smp_lock.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>
31 #include <linux/usb.h>
33 #include <linux/hid.h>
34 #include <linux/hiddev.h>
35 #include <linux/hid-debug.h>
36 #include <linux/hidraw.h>
43 #define DRIVER_VERSION "v2.6"
44 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
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 /* Quirks specified at module load time */
57 static char *quirks_param
[MAX_USBHID_BOOT_QUIRKS
] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS
- 1) ] = NULL
};
58 module_param_array_named(quirks
, quirks_param
, charp
, NULL
, 0444);
59 MODULE_PARM_DESC(quirks
, "Add/modify USB HID quirks by specifying "
60 " quirks=vendorID:productID:quirks"
61 " where vendorID, productID, and quirks are all in"
64 * Input submission and I/O error handler.
67 static void hid_io_error(struct hid_device
*hid
);
69 /* Start up the input URB */
70 static int hid_start_in(struct hid_device
*hid
)
74 struct usbhid_device
*usbhid
= hid
->driver_data
;
76 spin_lock_irqsave(&usbhid
->inlock
, flags
);
77 if (hid
->open
> 0 && !test_bit(HID_SUSPENDED
, &usbhid
->iofl
) &&
78 !test_bit(HID_DISCONNECTED
, &usbhid
->iofl
) &&
79 !test_and_set_bit(HID_IN_RUNNING
, &usbhid
->iofl
)) {
80 rc
= usb_submit_urb(usbhid
->urbin
, GFP_ATOMIC
);
82 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
84 spin_unlock_irqrestore(&usbhid
->inlock
, flags
);
88 /* I/O retry timer routine */
89 static void hid_retry_timeout(unsigned long _hid
)
91 struct hid_device
*hid
= (struct hid_device
*) _hid
;
92 struct usbhid_device
*usbhid
= hid
->driver_data
;
94 dev_dbg(&usbhid
->intf
->dev
, "retrying intr urb\n");
95 if (hid_start_in(hid
))
99 /* Workqueue routine to reset the device or clear a halt */
100 static void hid_reset(struct work_struct
*work
)
102 struct usbhid_device
*usbhid
=
103 container_of(work
, struct usbhid_device
, reset_work
);
104 struct hid_device
*hid
= usbhid
->hid
;
107 if (test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
)) {
108 dev_dbg(&usbhid
->intf
->dev
, "clear halt\n");
109 rc
= usb_clear_halt(hid_to_usb_dev(hid
), usbhid
->urbin
->pipe
);
110 clear_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
114 else if (test_bit(HID_RESET_PENDING
, &usbhid
->iofl
)) {
115 dev_dbg(&usbhid
->intf
->dev
, "resetting device\n");
116 rc
= usb_lock_device_for_reset(hid_to_usb_dev(hid
), usbhid
->intf
);
118 rc
= usb_reset_device(hid_to_usb_dev(hid
));
119 usb_unlock_device(hid_to_usb_dev(hid
));
121 clear_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
126 if (!test_bit(HID_IN_RUNNING
, &usbhid
->iofl
))
130 err_hid("can't reset device, %s-%s/input%d, status %d",
131 hid_to_usb_dev(hid
)->bus
->bus_name
,
132 hid_to_usb_dev(hid
)->devpath
,
142 /* Main I/O error handler */
143 static void hid_io_error(struct hid_device
*hid
)
146 struct usbhid_device
*usbhid
= hid
->driver_data
;
148 spin_lock_irqsave(&usbhid
->inlock
, flags
);
150 /* Stop when disconnected */
151 if (test_bit(HID_DISCONNECTED
, &usbhid
->iofl
))
154 /* If it has been a while since the last error, we'll assume
155 * this a brand new error and reset the retry timeout. */
156 if (time_after(jiffies
, usbhid
->stop_retry
+ HZ
/2))
157 usbhid
->retry_delay
= 0;
159 /* When an error occurs, retry at increasing intervals */
160 if (usbhid
->retry_delay
== 0) {
161 usbhid
->retry_delay
= 13; /* Then 26, 52, 104, 104, ... */
162 usbhid
->stop_retry
= jiffies
+ msecs_to_jiffies(1000);
163 } else if (usbhid
->retry_delay
< 100)
164 usbhid
->retry_delay
*= 2;
166 if (time_after(jiffies
, usbhid
->stop_retry
)) {
168 /* Retries failed, so do a port reset */
169 if (!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
->inlock
, flags
);
182 * Input interrupt completion handler.
185 static void hid_irq_in(struct urb
*urb
)
187 struct hid_device
*hid
= urb
->context
;
188 struct usbhid_device
*usbhid
= hid
->driver_data
;
191 switch (urb
->status
) {
192 case 0: /* success */
193 usbhid
->retry_delay
= 0;
194 hid_input_report(urb
->context
, HID_INPUT_REPORT
,
195 urb
->transfer_buffer
,
196 urb
->actual_length
, 1);
198 case -EPIPE
: /* stall */
199 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
200 set_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
201 schedule_work(&usbhid
->reset_work
);
203 case -ECONNRESET
: /* unlink */
205 case -ESHUTDOWN
: /* unplug */
206 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
208 case -EILSEQ
: /* protocol error or unplug */
209 case -EPROTO
: /* protocol error or unplug */
210 case -ETIME
: /* protocol error or unplug */
211 case -ETIMEDOUT
: /* Should never happen, but... */
212 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
216 dev_warn(&urb
->dev
->dev
, "input irq status %d "
217 "received\n", urb
->status
);
220 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
222 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
223 if (status
!= -EPERM
) {
224 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
225 hid_to_usb_dev(hid
)->bus
->bus_name
,
226 hid_to_usb_dev(hid
)->devpath
,
227 usbhid
->ifnum
, status
);
233 static int hid_submit_out(struct hid_device
*hid
)
235 struct hid_report
*report
;
237 struct usbhid_device
*usbhid
= hid
->driver_data
;
239 report
= usbhid
->out
[usbhid
->outtail
].report
;
240 raw_report
= usbhid
->out
[usbhid
->outtail
].raw_report
;
242 usbhid
->urbout
->transfer_buffer_length
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
243 usbhid
->urbout
->dev
= hid_to_usb_dev(hid
);
244 memcpy(usbhid
->outbuf
, raw_report
, usbhid
->urbout
->transfer_buffer_length
);
247 dbg_hid("submitting out urb\n");
249 if (usb_submit_urb(usbhid
->urbout
, GFP_ATOMIC
)) {
250 err_hid("usb_submit_urb(out) failed");
257 static int hid_submit_ctrl(struct hid_device
*hid
)
259 struct hid_report
*report
;
263 struct usbhid_device
*usbhid
= hid
->driver_data
;
265 report
= usbhid
->ctrl
[usbhid
->ctrltail
].report
;
266 raw_report
= usbhid
->ctrl
[usbhid
->ctrltail
].raw_report
;
267 dir
= usbhid
->ctrl
[usbhid
->ctrltail
].dir
;
269 len
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
270 if (dir
== USB_DIR_OUT
) {
271 usbhid
->urbctrl
->pipe
= usb_sndctrlpipe(hid_to_usb_dev(hid
), 0);
272 usbhid
->urbctrl
->transfer_buffer_length
= len
;
273 memcpy(usbhid
->ctrlbuf
, raw_report
, len
);
276 int maxpacket
, padlen
;
278 usbhid
->urbctrl
->pipe
= usb_rcvctrlpipe(hid_to_usb_dev(hid
), 0);
279 maxpacket
= usb_maxpacket(hid_to_usb_dev(hid
), usbhid
->urbctrl
->pipe
, 0);
281 padlen
= DIV_ROUND_UP(len
, maxpacket
);
283 if (padlen
> usbhid
->bufsize
)
284 padlen
= usbhid
->bufsize
;
287 usbhid
->urbctrl
->transfer_buffer_length
= padlen
;
289 usbhid
->urbctrl
->dev
= hid_to_usb_dev(hid
);
291 usbhid
->cr
->bRequestType
= USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| dir
;
292 usbhid
->cr
->bRequest
= (dir
== USB_DIR_OUT
) ? HID_REQ_SET_REPORT
: HID_REQ_GET_REPORT
;
293 usbhid
->cr
->wValue
= cpu_to_le16(((report
->type
+ 1) << 8) | report
->id
);
294 usbhid
->cr
->wIndex
= cpu_to_le16(usbhid
->ifnum
);
295 usbhid
->cr
->wLength
= cpu_to_le16(len
);
297 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
298 usbhid
->cr
->bRequest
== HID_REQ_SET_REPORT
? "Set_Report" : "Get_Report",
299 usbhid
->cr
->wValue
, usbhid
->cr
->wIndex
, usbhid
->cr
->wLength
);
301 if (usb_submit_urb(usbhid
->urbctrl
, GFP_ATOMIC
)) {
302 err_hid("usb_submit_urb(ctrl) failed");
310 * Output interrupt completion handler.
313 static void hid_irq_out(struct urb
*urb
)
315 struct hid_device
*hid
= urb
->context
;
316 struct usbhid_device
*usbhid
= hid
->driver_data
;
320 switch (urb
->status
) {
321 case 0: /* success */
323 case -ESHUTDOWN
: /* unplug */
325 case -EILSEQ
: /* protocol error or unplug */
326 case -EPROTO
: /* protocol error or unplug */
327 case -ECONNRESET
: /* unlink */
331 dev_warn(&urb
->dev
->dev
, "output irq status %d "
332 "received\n", urb
->status
);
335 spin_lock_irqsave(&usbhid
->outlock
, flags
);
338 usbhid
->outtail
= usbhid
->outhead
;
340 usbhid
->outtail
= (usbhid
->outtail
+ 1) & (HID_OUTPUT_FIFO_SIZE
- 1);
342 if (usbhid
->outhead
!= usbhid
->outtail
) {
343 if (hid_submit_out(hid
)) {
344 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
345 wake_up(&usbhid
->wait
);
347 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
351 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
352 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
353 wake_up(&usbhid
->wait
);
357 * Control pipe completion handler.
360 static void hid_ctrl(struct urb
*urb
)
362 struct hid_device
*hid
= urb
->context
;
363 struct usbhid_device
*usbhid
= hid
->driver_data
;
367 spin_lock_irqsave(&usbhid
->ctrllock
, flags
);
369 switch (urb
->status
) {
370 case 0: /* success */
371 if (usbhid
->ctrl
[usbhid
->ctrltail
].dir
== USB_DIR_IN
)
372 hid_input_report(urb
->context
,
373 usbhid
->ctrl
[usbhid
->ctrltail
].report
->type
,
374 urb
->transfer_buffer
, urb
->actual_length
, 0);
376 case -ESHUTDOWN
: /* unplug */
378 case -EILSEQ
: /* protocol error or unplug */
379 case -EPROTO
: /* protocol error or unplug */
380 case -ECONNRESET
: /* unlink */
382 case -EPIPE
: /* report not available */
385 dev_warn(&urb
->dev
->dev
, "ctrl urb status %d "
386 "received\n", urb
->status
);
390 usbhid
->ctrltail
= usbhid
->ctrlhead
;
392 usbhid
->ctrltail
= (usbhid
->ctrltail
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1);
394 if (usbhid
->ctrlhead
!= usbhid
->ctrltail
) {
395 if (hid_submit_ctrl(hid
)) {
396 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
397 wake_up(&usbhid
->wait
);
399 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
403 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
404 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
405 wake_up(&usbhid
->wait
);
408 void usbhid_submit_report(struct hid_device
*hid
, struct hid_report
*report
, unsigned char dir
)
412 struct usbhid_device
*usbhid
= hid
->driver_data
;
413 int len
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
415 if ((hid
->quirks
& HID_QUIRK_NOGET
) && dir
== USB_DIR_IN
)
418 if (usbhid
->urbout
&& dir
== USB_DIR_OUT
&& report
->type
== HID_OUTPUT_REPORT
) {
420 spin_lock_irqsave(&usbhid
->outlock
, flags
);
422 if ((head
= (usbhid
->outhead
+ 1) & (HID_OUTPUT_FIFO_SIZE
- 1)) == usbhid
->outtail
) {
423 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
424 dev_warn(&hid
->dev
, "output queue full\n");
428 usbhid
->out
[usbhid
->outhead
].raw_report
= kmalloc(len
, GFP_ATOMIC
);
429 if (!usbhid
->out
[usbhid
->outhead
].raw_report
) {
430 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
431 dev_warn(&hid
->dev
, "output queueing failed\n");
434 hid_output_report(report
, usbhid
->out
[usbhid
->outhead
].raw_report
);
435 usbhid
->out
[usbhid
->outhead
].report
= report
;
436 usbhid
->outhead
= head
;
438 if (!test_and_set_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
439 if (hid_submit_out(hid
))
440 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
442 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
446 spin_lock_irqsave(&usbhid
->ctrllock
, flags
);
448 if ((head
= (usbhid
->ctrlhead
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1)) == usbhid
->ctrltail
) {
449 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
450 dev_warn(&hid
->dev
, "control queue full\n");
454 if (dir
== USB_DIR_OUT
) {
455 usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
= kmalloc(len
, GFP_ATOMIC
);
456 if (!usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
) {
457 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
458 dev_warn(&hid
->dev
, "control queueing failed\n");
461 hid_output_report(report
, usbhid
->ctrl
[usbhid
->ctrlhead
].raw_report
);
463 usbhid
->ctrl
[usbhid
->ctrlhead
].report
= report
;
464 usbhid
->ctrl
[usbhid
->ctrlhead
].dir
= dir
;
465 usbhid
->ctrlhead
= head
;
467 if (!test_and_set_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
468 if (hid_submit_ctrl(hid
))
469 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
471 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
473 EXPORT_SYMBOL_GPL(usbhid_submit_report
);
475 static int usb_hidinput_input_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
)
477 struct hid_device
*hid
= input_get_drvdata(dev
);
478 struct hid_field
*field
;
482 return input_ff_event(dev
, type
, code
, value
);
487 if ((offset
= hidinput_find_field(hid
, type
, code
, &field
)) == -1) {
488 dev_warn(&dev
->dev
, "event field not found\n");
492 hid_set_field(field
, offset
, value
);
493 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
498 int usbhid_wait_io(struct hid_device
*hid
)
500 struct usbhid_device
*usbhid
= hid
->driver_data
;
502 if (!wait_event_timeout(usbhid
->wait
,
503 (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
) &&
504 !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)),
506 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
513 static int hid_set_idle(struct usb_device
*dev
, int ifnum
, int report
, int idle
)
515 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
516 HID_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
, (idle
<< 8) | report
,
517 ifnum
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
520 static int hid_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
521 unsigned char type
, void *buf
, int size
)
523 int result
, retries
= 4;
525 memset(buf
, 0, size
);
528 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
529 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
530 (type
<< 8), ifnum
, buf
, size
, USB_CTRL_GET_TIMEOUT
);
532 } while (result
< size
&& retries
);
536 int usbhid_open(struct hid_device
*hid
)
538 struct usbhid_device
*usbhid
= hid
->driver_data
;
542 res
= usb_autopm_get_interface(usbhid
->intf
);
548 if (hid_start_in(hid
))
553 void usbhid_close(struct hid_device
*hid
)
555 struct usbhid_device
*usbhid
= hid
->driver_data
;
558 usb_kill_urb(usbhid
->urbin
);
559 usb_autopm_put_interface(usbhid
->intf
);
564 * Initialize all reports
567 void usbhid_init_reports(struct hid_device
*hid
)
569 struct hid_report
*report
;
570 struct usbhid_device
*usbhid
= hid
->driver_data
;
573 list_for_each_entry(report
, &hid
->report_enum
[HID_INPUT_REPORT
].report_list
, list
)
574 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
576 list_for_each_entry(report
, &hid
->report_enum
[HID_FEATURE_REPORT
].report_list
, list
)
577 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
580 ret
= usbhid_wait_io(hid
);
583 if (test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
584 usb_kill_urb(usbhid
->urbctrl
);
585 if (test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
586 usb_kill_urb(usbhid
->urbout
);
587 ret
= usbhid_wait_io(hid
);
591 dev_warn(&hid
->dev
, "timeout initializing reports\n");
595 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
597 static int hid_find_field_early(struct hid_device
*hid
, unsigned int page
,
598 unsigned int hid_code
, struct hid_field
**pfield
)
600 struct hid_report
*report
;
601 struct hid_field
*field
;
602 struct hid_usage
*usage
;
605 list_for_each_entry(report
, &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
606 for (i
= 0; i
< report
->maxfield
; i
++) {
607 field
= report
->field
[i
];
608 for (j
= 0; j
< field
->maxusage
; j
++) {
609 usage
= &field
->usage
[j
];
610 if ((usage
->hid
& HID_USAGE_PAGE
) == page
&&
611 (usage
->hid
& 0xFFFF) == hid_code
) {
621 void usbhid_set_leds(struct hid_device
*hid
)
623 struct hid_field
*field
;
626 if ((offset
= hid_find_field_early(hid
, HID_UP_LED
, 0x01, &field
)) != -1) {
627 hid_set_field(field
, offset
, 0);
628 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
631 EXPORT_SYMBOL_GPL(usbhid_set_leds
);
634 * Traverse the supplied list of reports and find the longest
636 static void hid_find_max_report(struct hid_device
*hid
, unsigned int type
,
639 struct hid_report
*report
;
642 list_for_each_entry(report
, &hid
->report_enum
[type
].report_list
, list
) {
643 size
= ((report
->size
- 1) >> 3) + 1 + hid
->report_enum
[type
].numbered
;
649 static int hid_alloc_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
651 struct usbhid_device
*usbhid
= hid
->driver_data
;
653 usbhid
->inbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_KERNEL
,
655 usbhid
->outbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_KERNEL
,
656 &usbhid
->outbuf_dma
);
657 usbhid
->cr
= usb_buffer_alloc(dev
, sizeof(*usbhid
->cr
), GFP_KERNEL
,
659 usbhid
->ctrlbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_KERNEL
,
660 &usbhid
->ctrlbuf_dma
);
661 if (!usbhid
->inbuf
|| !usbhid
->outbuf
|| !usbhid
->cr
||
668 static int usbhid_output_raw_report(struct hid_device
*hid
, __u8
*buf
, size_t count
)
670 struct usbhid_device
*usbhid
= hid
->driver_data
;
671 struct usb_device
*dev
= hid_to_usb_dev(hid
);
672 struct usb_interface
*intf
= usbhid
->intf
;
673 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
676 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
678 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
679 ((HID_OUTPUT_REPORT
+ 1) << 8) | *buf
,
680 interface
->desc
.bInterfaceNumber
, buf
+ 1, count
- 1,
681 USB_CTRL_SET_TIMEOUT
);
683 /* count also the report id */
690 static void hid_free_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
692 struct usbhid_device
*usbhid
= hid
->driver_data
;
694 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->inbuf
, usbhid
->inbuf_dma
);
695 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->outbuf
, usbhid
->outbuf_dma
);
696 usb_buffer_free(dev
, sizeof(*(usbhid
->cr
)), usbhid
->cr
, usbhid
->cr_dma
);
697 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->ctrlbuf
, usbhid
->ctrlbuf_dma
);
700 static int usbhid_parse(struct hid_device
*hid
)
702 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
703 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
704 struct usb_device
*dev
= interface_to_usbdev (intf
);
705 struct hid_descriptor
*hdesc
;
707 unsigned int rsize
= 0;
711 quirks
= usbhid_lookup_quirk(le16_to_cpu(dev
->descriptor
.idVendor
),
712 le16_to_cpu(dev
->descriptor
.idProduct
));
714 /* Many keyboards and mice don't like to be polled for reports,
715 * so we will always set the HID_QUIRK_NOGET flag for them. */
716 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
) {
717 if (interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_KEYBOARD
||
718 interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_MOUSE
)
719 quirks
|= HID_QUIRK_NOGET
;
722 if (usb_get_extra_descriptor(interface
, HID_DT_HID
, &hdesc
) &&
723 (!interface
->desc
.bNumEndpoints
||
724 usb_get_extra_descriptor(&interface
->endpoint
[0], HID_DT_HID
, &hdesc
))) {
725 dbg_hid("class descriptor not present\n");
729 hid
->version
= le16_to_cpu(hdesc
->bcdHID
);
730 hid
->country
= hdesc
->bCountryCode
;
732 for (n
= 0; n
< hdesc
->bNumDescriptors
; n
++)
733 if (hdesc
->desc
[n
].bDescriptorType
== HID_DT_REPORT
)
734 rsize
= le16_to_cpu(hdesc
->desc
[n
].wDescriptorLength
);
736 if (!rsize
|| rsize
> HID_MAX_DESCRIPTOR_SIZE
) {
737 dbg_hid("weird size of report descriptor (%u)\n", rsize
);
741 if (!(rdesc
= kmalloc(rsize
, GFP_KERNEL
))) {
742 dbg_hid("couldn't allocate rdesc memory\n");
746 hid_set_idle(dev
, interface
->desc
.bInterfaceNumber
, 0, 0);
748 ret
= hid_get_class_descriptor(dev
, interface
->desc
.bInterfaceNumber
,
749 HID_DT_REPORT
, rdesc
, rsize
);
751 dbg_hid("reading report descriptor failed\n");
756 dbg_hid("report descriptor (size %u, read %d) = ", rsize
, n
);
757 for (n
= 0; n
< rsize
; n
++)
758 dbg_hid_line(" %02x", (unsigned char) rdesc
[n
]);
761 ret
= hid_parse_report(hid
, rdesc
, rsize
);
764 dbg_hid("parsing report descriptor failed\n");
768 hid
->quirks
= quirks
;
775 static int usbhid_start(struct hid_device
*hid
)
777 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
778 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
779 struct usb_device
*dev
= interface_to_usbdev(intf
);
780 struct usbhid_device
*usbhid
= hid
->driver_data
;
781 unsigned int n
, insize
= 0;
784 clear_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
786 usbhid
->bufsize
= HID_MIN_BUFFER_SIZE
;
787 hid_find_max_report(hid
, HID_INPUT_REPORT
, &usbhid
->bufsize
);
788 hid_find_max_report(hid
, HID_OUTPUT_REPORT
, &usbhid
->bufsize
);
789 hid_find_max_report(hid
, HID_FEATURE_REPORT
, &usbhid
->bufsize
);
791 if (usbhid
->bufsize
> HID_MAX_BUFFER_SIZE
)
792 usbhid
->bufsize
= HID_MAX_BUFFER_SIZE
;
794 hid_find_max_report(hid
, HID_INPUT_REPORT
, &insize
);
796 if (insize
> HID_MAX_BUFFER_SIZE
)
797 insize
= HID_MAX_BUFFER_SIZE
;
799 if (hid_alloc_buffers(dev
, hid
)) {
804 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++) {
805 struct usb_endpoint_descriptor
*endpoint
;
809 endpoint
= &interface
->endpoint
[n
].desc
;
810 if (!usb_endpoint_xfer_int(endpoint
))
813 interval
= endpoint
->bInterval
;
815 /* Some vendors give fullspeed interval on highspeed devides */
816 if (hid
->quirks
& HID_QUIRK_FULLSPEED_INTERVAL
&&
817 dev
->speed
== USB_SPEED_HIGH
) {
818 interval
= fls(endpoint
->bInterval
*8);
819 printk(KERN_INFO
"%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
820 hid
->name
, endpoint
->bInterval
, interval
);
823 /* Change the polling interval of mice. */
824 if (hid
->collection
->usage
== HID_GD_MOUSE
&& hid_mousepoll_interval
> 0)
825 interval
= hid_mousepoll_interval
;
828 if (usb_endpoint_dir_in(endpoint
)) {
831 if (!(usbhid
->urbin
= usb_alloc_urb(0, GFP_KERNEL
)))
833 pipe
= usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
);
834 usb_fill_int_urb(usbhid
->urbin
, dev
, pipe
, usbhid
->inbuf
, insize
,
835 hid_irq_in
, hid
, interval
);
836 usbhid
->urbin
->transfer_dma
= usbhid
->inbuf_dma
;
837 usbhid
->urbin
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
841 if (!(usbhid
->urbout
= usb_alloc_urb(0, GFP_KERNEL
)))
843 pipe
= usb_sndintpipe(dev
, endpoint
->bEndpointAddress
);
844 usb_fill_int_urb(usbhid
->urbout
, dev
, pipe
, usbhid
->outbuf
, 0,
845 hid_irq_out
, hid
, interval
);
846 usbhid
->urbout
->transfer_dma
= usbhid
->outbuf_dma
;
847 usbhid
->urbout
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
851 init_waitqueue_head(&usbhid
->wait
);
852 INIT_WORK(&usbhid
->reset_work
, hid_reset
);
853 setup_timer(&usbhid
->io_retry
, hid_retry_timeout
, (unsigned long) hid
);
855 spin_lock_init(&usbhid
->inlock
);
856 spin_lock_init(&usbhid
->outlock
);
857 spin_lock_init(&usbhid
->ctrllock
);
860 usbhid
->ifnum
= interface
->desc
.bInterfaceNumber
;
862 usbhid
->urbctrl
= usb_alloc_urb(0, GFP_KERNEL
);
863 if (!usbhid
->urbctrl
) {
868 usb_fill_control_urb(usbhid
->urbctrl
, dev
, 0, (void *) usbhid
->cr
,
869 usbhid
->ctrlbuf
, 1, hid_ctrl
, hid
);
870 usbhid
->urbctrl
->setup_dma
= usbhid
->cr_dma
;
871 usbhid
->urbctrl
->transfer_dma
= usbhid
->ctrlbuf_dma
;
872 usbhid
->urbctrl
->transfer_flags
|= (URB_NO_TRANSFER_DMA_MAP
| URB_NO_SETUP_DMA_MAP
);
874 usbhid_init_reports(hid
);
875 hid_dump_device(hid
);
877 set_bit(HID_STARTED
, &usbhid
->iofl
);
879 /* Some keyboards don't work until their LEDs have been set.
880 * Since BIOSes do set the LEDs, it must be safe for any device
881 * that supports the keyboard boot protocol.
883 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
&&
884 interface
->desc
.bInterfaceProtocol
==
885 USB_INTERFACE_PROTOCOL_KEYBOARD
)
886 usbhid_set_leds(hid
);
891 usb_free_urb(usbhid
->urbin
);
892 usb_free_urb(usbhid
->urbout
);
893 usb_free_urb(usbhid
->urbctrl
);
894 usbhid
->urbin
= NULL
;
895 usbhid
->urbout
= NULL
;
896 usbhid
->urbctrl
= NULL
;
897 hid_free_buffers(dev
, hid
);
901 static void usbhid_stop(struct hid_device
*hid
)
903 struct usbhid_device
*usbhid
= hid
->driver_data
;
905 if (WARN_ON(!usbhid
))
908 clear_bit(HID_STARTED
, &usbhid
->iofl
);
909 spin_lock_irq(&usbhid
->inlock
); /* Sync with error handler */
910 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
911 spin_unlock_irq(&usbhid
->inlock
);
912 usb_kill_urb(usbhid
->urbin
);
913 usb_kill_urb(usbhid
->urbout
);
914 usb_kill_urb(usbhid
->urbctrl
);
916 del_timer_sync(&usbhid
->io_retry
);
917 cancel_work_sync(&usbhid
->reset_work
);
919 if (hid
->claimed
& HID_CLAIMED_INPUT
)
920 hidinput_disconnect(hid
);
921 if (hid
->claimed
& HID_CLAIMED_HIDDEV
)
922 hiddev_disconnect(hid
);
923 if (hid
->claimed
& HID_CLAIMED_HIDRAW
)
924 hidraw_disconnect(hid
);
928 usb_free_urb(usbhid
->urbin
);
929 usb_free_urb(usbhid
->urbctrl
);
930 usb_free_urb(usbhid
->urbout
);
931 usbhid
->urbin
= NULL
; /* don't mess up next start */
932 usbhid
->urbctrl
= NULL
;
933 usbhid
->urbout
= NULL
;
935 hid_free_buffers(hid_to_usb_dev(hid
), hid
);
938 static struct hid_ll_driver usb_hid_driver
= {
939 .parse
= usbhid_parse
,
940 .start
= usbhid_start
,
943 .close
= usbhid_close
,
944 .hidinput_input_event
= usb_hidinput_input_event
,
947 static int hid_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
949 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
950 struct usb_device
*dev
= interface_to_usbdev(intf
);
951 struct usbhid_device
*usbhid
;
952 struct hid_device
*hid
;
953 unsigned int n
, has_in
= 0;
957 dbg_hid("HID probe called for ifnum %d\n",
958 intf
->altsetting
->desc
.bInterfaceNumber
);
960 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++)
961 if (usb_endpoint_is_int_in(&interface
->endpoint
[n
].desc
))
964 dev_err(&intf
->dev
, "couldn't find an input interrupt "
969 hid
= hid_allocate_device();
973 usb_set_intfdata(intf
, hid
);
974 hid
->ll_driver
= &usb_hid_driver
;
975 hid
->hid_output_raw_report
= usbhid_output_raw_report
;
976 hid
->ff_init
= hid_pidff_init
;
977 #ifdef CONFIG_USB_HIDDEV
978 hid
->hiddev_connect
= hiddev_connect
;
979 hid
->hiddev_hid_event
= hiddev_hid_event
;
980 hid
->hiddev_report_event
= hiddev_report_event
;
982 hid
->dev
.parent
= &intf
->dev
;
984 hid
->vendor
= le16_to_cpu(dev
->descriptor
.idVendor
);
985 hid
->product
= le16_to_cpu(dev
->descriptor
.idProduct
);
987 if (intf
->cur_altsetting
->desc
.bInterfaceProtocol
==
988 USB_INTERFACE_PROTOCOL_MOUSE
)
989 hid
->type
= HID_TYPE_USBMOUSE
;
991 if (dev
->manufacturer
)
992 strlcpy(hid
->name
, dev
->manufacturer
, sizeof(hid
->name
));
995 if (dev
->manufacturer
)
996 strlcat(hid
->name
, " ", sizeof(hid
->name
));
997 strlcat(hid
->name
, dev
->product
, sizeof(hid
->name
));
1000 if (!strlen(hid
->name
))
1001 snprintf(hid
->name
, sizeof(hid
->name
), "HID %04x:%04x",
1002 le16_to_cpu(dev
->descriptor
.idVendor
),
1003 le16_to_cpu(dev
->descriptor
.idProduct
));
1005 usb_make_path(dev
, hid
->phys
, sizeof(hid
->phys
));
1006 strlcat(hid
->phys
, "/input", sizeof(hid
->phys
));
1007 len
= strlen(hid
->phys
);
1008 if (len
< sizeof(hid
->phys
) - 1)
1009 snprintf(hid
->phys
+ len
, sizeof(hid
->phys
) - len
,
1010 "%d", intf
->altsetting
[0].desc
.bInterfaceNumber
);
1012 if (usb_string(dev
, dev
->descriptor
.iSerialNumber
, hid
->uniq
, 64) <= 0)
1015 usbhid
= kzalloc(sizeof(*usbhid
), GFP_KERNEL
);
1016 if (usbhid
== NULL
) {
1021 hid
->driver_data
= usbhid
;
1024 ret
= hid_add_device(hid
);
1027 dev_err(&intf
->dev
, "can't add hid device: %d\n", ret
);
1035 hid_destroy_device(hid
);
1039 static void hid_disconnect(struct usb_interface
*intf
)
1041 struct hid_device
*hid
= usb_get_intfdata(intf
);
1042 struct usbhid_device
*usbhid
;
1047 usbhid
= hid
->driver_data
;
1048 hid_destroy_device(hid
);
1052 static int hid_suspend(struct usb_interface
*intf
, pm_message_t message
)
1054 struct hid_device
*hid
= usb_get_intfdata (intf
);
1055 struct usbhid_device
*usbhid
= hid
->driver_data
;
1057 if (!test_bit(HID_STARTED
, &usbhid
->iofl
))
1060 spin_lock_irq(&usbhid
->inlock
); /* Sync with error handler */
1061 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1062 spin_unlock_irq(&usbhid
->inlock
);
1063 del_timer_sync(&usbhid
->io_retry
);
1064 usb_kill_urb(usbhid
->urbin
);
1065 dev_dbg(&intf
->dev
, "suspend\n");
1069 static int hid_resume(struct usb_interface
*intf
)
1071 struct hid_device
*hid
= usb_get_intfdata (intf
);
1072 struct usbhid_device
*usbhid
= hid
->driver_data
;
1075 if (!test_bit(HID_STARTED
, &usbhid
->iofl
))
1078 clear_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1079 usbhid
->retry_delay
= 0;
1080 status
= hid_start_in(hid
);
1081 dev_dbg(&intf
->dev
, "resume status %d\n", status
);
1085 /* Treat USB reset pretty much the same as suspend/resume */
1086 static int hid_pre_reset(struct usb_interface
*intf
)
1088 /* FIXME: What if the interface is already suspended? */
1089 hid_suspend(intf
, PMSG_ON
);
1093 /* Same routine used for post_reset and reset_resume */
1094 static int hid_post_reset(struct usb_interface
*intf
)
1096 struct usb_device
*dev
= interface_to_usbdev (intf
);
1098 hid_set_idle(dev
, intf
->cur_altsetting
->desc
.bInterfaceNumber
, 0, 0);
1099 /* FIXME: Any more reinitialization needed? */
1101 return hid_resume(intf
);
1104 static struct usb_device_id hid_usb_ids
[] = {
1105 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
1106 .bInterfaceClass
= USB_INTERFACE_CLASS_HID
},
1107 { } /* Terminating entry */
1110 MODULE_DEVICE_TABLE (usb
, hid_usb_ids
);
1112 static struct usb_driver hid_driver
= {
1115 .disconnect
= hid_disconnect
,
1116 .suspend
= hid_suspend
,
1117 .resume
= hid_resume
,
1118 .reset_resume
= hid_post_reset
,
1119 .pre_reset
= hid_pre_reset
,
1120 .post_reset
= hid_post_reset
,
1121 .id_table
= hid_usb_ids
,
1122 .supports_autosuspend
= 1,
1125 static const struct hid_device_id hid_usb_table
[] = {
1126 { HID_USB_DEVICE(HID_ANY_ID
, HID_ANY_ID
) },
1130 static struct hid_driver hid_usb_driver
= {
1131 .name
= "generic-usb",
1132 .id_table
= hid_usb_table
,
1135 static int __init
hid_init(void)
1138 retval
= hid_register_driver(&hid_usb_driver
);
1140 goto hid_register_fail
;
1141 retval
= usbhid_quirks_init(quirks_param
);
1143 goto usbhid_quirks_init_fail
;
1144 retval
= hiddev_init();
1146 goto hiddev_init_fail
;
1147 retval
= usb_register(&hid_driver
);
1149 goto usb_register_fail
;
1150 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_VERSION
":"
1157 usbhid_quirks_exit();
1158 usbhid_quirks_init_fail
:
1159 hid_unregister_driver(&hid_usb_driver
);
1164 static void __exit
hid_exit(void)
1166 usb_deregister(&hid_driver
);
1168 usbhid_quirks_exit();
1169 hid_unregister_driver(&hid_usb_driver
);
1172 module_init(hid_init
);
1173 module_exit(hid_exit
);
1175 MODULE_AUTHOR(DRIVER_AUTHOR
);
1176 MODULE_DESCRIPTION(DRIVER_DESC
);
1177 MODULE_LICENSE(DRIVER_LICENSE
);