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-2007 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/smp_lock.h>
24 #include <linux/spinlock.h>
25 #include <asm/unaligned.h>
26 #include <asm/byteorder.h>
27 #include <linux/input.h>
28 #include <linux/wait.h>
30 #include <linux/usb.h>
32 #include <linux/hid.h>
33 #include <linux/hiddev.h>
34 #include <linux/hid-debug.h>
35 #include <linux/hidraw.h>
42 #define DRIVER_VERSION "v2.6"
43 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
44 #define DRIVER_DESC "USB HID core driver"
45 #define DRIVER_LICENSE "GPL"
47 static char *hid_types
[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
48 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
53 static unsigned int hid_mousepoll_interval
;
54 module_param_named(mousepoll
, hid_mousepoll_interval
, uint
, 0644);
55 MODULE_PARM_DESC(mousepoll
, "Polling interval of mice");
57 /* Quirks specified at module load time */
58 static char *quirks_param
[MAX_USBHID_BOOT_QUIRKS
] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS
- 1) ] = NULL
};
59 module_param_array_named(quirks
, quirks_param
, charp
, NULL
, 0444);
60 MODULE_PARM_DESC(quirks
, "Add/modify USB HID quirks by specifying "
61 " quirks=vendorID:productID:quirks"
62 " where vendorID, productID, and quirks are all in"
64 static char *rdesc_quirks_param
[MAX_USBHID_BOOT_QUIRKS
] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS
- 1) ] = NULL
};
65 module_param_array_named(rdesc_quirks
, rdesc_quirks_param
, charp
, NULL
, 0444);
66 MODULE_PARM_DESC(rdesc_quirks
, "Add/modify report descriptor quirks by specifying "
67 " rdesc_quirks=vendorID:productID:rdesc_quirks"
68 " where vendorID, productID, and rdesc_quirks are all in"
71 * Input submission and I/O error handler.
74 static void hid_io_error(struct hid_device
*hid
);
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
->inlock
, flags
);
84 if (hid
->open
> 0 && !test_bit(HID_SUSPENDED
, &usbhid
->iofl
) &&
85 !test_bit(HID_DISCONNECTED
, &usbhid
->iofl
) &&
86 !test_and_set_bit(HID_IN_RUNNING
, &usbhid
->iofl
)) {
87 rc
= usb_submit_urb(usbhid
->urbin
, GFP_ATOMIC
);
89 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
91 spin_unlock_irqrestore(&usbhid
->inlock
, flags
);
95 /* I/O retry timer routine */
96 static void hid_retry_timeout(unsigned long _hid
)
98 struct hid_device
*hid
= (struct hid_device
*) _hid
;
99 struct usbhid_device
*usbhid
= hid
->driver_data
;
101 dev_dbg(&usbhid
->intf
->dev
, "retrying intr urb\n");
102 if (hid_start_in(hid
))
106 /* Workqueue routine to reset the device or clear a halt */
107 static void hid_reset(struct work_struct
*work
)
109 struct usbhid_device
*usbhid
=
110 container_of(work
, struct usbhid_device
, reset_work
);
111 struct hid_device
*hid
= usbhid
->hid
;
114 if (test_bit(HID_CLEAR_HALT
, &usbhid
->iofl
)) {
115 dev_dbg(&usbhid
->intf
->dev
, "clear halt\n");
116 rc
= usb_clear_halt(hid_to_usb_dev(hid
), usbhid
->urbin
->pipe
);
117 clear_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
121 else if (test_bit(HID_RESET_PENDING
, &usbhid
->iofl
)) {
122 dev_dbg(&usbhid
->intf
->dev
, "resetting device\n");
123 rc
= rc_lock
= usb_lock_device_for_reset(hid_to_usb_dev(hid
), usbhid
->intf
);
125 rc
= usb_reset_device(hid_to_usb_dev(hid
));
127 usb_unlock_device(hid_to_usb_dev(hid
));
129 clear_bit(HID_RESET_PENDING
, &usbhid
->iofl
);
134 if (!test_bit(HID_IN_RUNNING
, &usbhid
->iofl
))
138 err_hid("can't reset device, %s-%s/input%d, status %d",
139 hid_to_usb_dev(hid
)->bus
->bus_name
,
140 hid_to_usb_dev(hid
)->devpath
,
150 /* Main I/O error handler */
151 static void hid_io_error(struct hid_device
*hid
)
154 struct usbhid_device
*usbhid
= hid
->driver_data
;
156 spin_lock_irqsave(&usbhid
->inlock
, flags
);
158 /* Stop when disconnected */
159 if (test_bit(HID_DISCONNECTED
, &usbhid
->iofl
))
162 /* If it has been a while since the last error, we'll assume
163 * this a brand new error and reset the retry timeout. */
164 if (time_after(jiffies
, usbhid
->stop_retry
+ HZ
/2))
165 usbhid
->retry_delay
= 0;
167 /* When an error occurs, retry at increasing intervals */
168 if (usbhid
->retry_delay
== 0) {
169 usbhid
->retry_delay
= 13; /* Then 26, 52, 104, 104, ... */
170 usbhid
->stop_retry
= jiffies
+ msecs_to_jiffies(1000);
171 } else if (usbhid
->retry_delay
< 100)
172 usbhid
->retry_delay
*= 2;
174 if (time_after(jiffies
, usbhid
->stop_retry
)) {
176 /* Retries failed, so do a port reset */
177 if (!test_and_set_bit(HID_RESET_PENDING
, &usbhid
->iofl
)) {
178 schedule_work(&usbhid
->reset_work
);
183 mod_timer(&usbhid
->io_retry
,
184 jiffies
+ msecs_to_jiffies(usbhid
->retry_delay
));
186 spin_unlock_irqrestore(&usbhid
->inlock
, flags
);
190 * Input interrupt completion handler.
193 static void hid_irq_in(struct urb
*urb
)
195 struct hid_device
*hid
= urb
->context
;
196 struct usbhid_device
*usbhid
= hid
->driver_data
;
199 switch (urb
->status
) {
200 case 0: /* success */
201 usbhid
->retry_delay
= 0;
202 hid_input_report(urb
->context
, HID_INPUT_REPORT
,
203 urb
->transfer_buffer
,
204 urb
->actual_length
, 1);
206 case -EPIPE
: /* stall */
207 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
208 set_bit(HID_CLEAR_HALT
, &usbhid
->iofl
);
209 schedule_work(&usbhid
->reset_work
);
211 case -ECONNRESET
: /* unlink */
213 case -ESHUTDOWN
: /* unplug */
214 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
216 case -EILSEQ
: /* protocol error or unplug */
217 case -EPROTO
: /* protocol error or unplug */
218 case -ETIME
: /* protocol error or unplug */
219 case -ETIMEDOUT
: /* Should never happen, but... */
220 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
224 warn("input irq status %d received", urb
->status
);
227 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
229 clear_bit(HID_IN_RUNNING
, &usbhid
->iofl
);
230 if (status
!= -EPERM
) {
231 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
232 hid_to_usb_dev(hid
)->bus
->bus_name
,
233 hid_to_usb_dev(hid
)->devpath
,
234 usbhid
->ifnum
, status
);
240 static int hid_submit_out(struct hid_device
*hid
)
242 struct hid_report
*report
;
243 struct usbhid_device
*usbhid
= hid
->driver_data
;
245 report
= usbhid
->out
[usbhid
->outtail
];
247 hid_output_report(report
, usbhid
->outbuf
);
248 usbhid
->urbout
->transfer_buffer_length
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
249 usbhid
->urbout
->dev
= hid_to_usb_dev(hid
);
251 dbg_hid("submitting out urb\n");
253 if (usb_submit_urb(usbhid
->urbout
, GFP_ATOMIC
)) {
254 err_hid("usb_submit_urb(out) failed");
261 static int hid_submit_ctrl(struct hid_device
*hid
)
263 struct hid_report
*report
;
266 struct usbhid_device
*usbhid
= hid
->driver_data
;
268 report
= usbhid
->ctrl
[usbhid
->ctrltail
].report
;
269 dir
= usbhid
->ctrl
[usbhid
->ctrltail
].dir
;
271 len
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
272 if (dir
== USB_DIR_OUT
) {
273 hid_output_report(report
, usbhid
->ctrlbuf
);
274 usbhid
->urbctrl
->pipe
= usb_sndctrlpipe(hid_to_usb_dev(hid
), 0);
275 usbhid
->urbctrl
->transfer_buffer_length
= len
;
277 int maxpacket
, padlen
;
279 usbhid
->urbctrl
->pipe
= usb_rcvctrlpipe(hid_to_usb_dev(hid
), 0);
280 maxpacket
= usb_maxpacket(hid_to_usb_dev(hid
), usbhid
->urbctrl
->pipe
, 0);
282 padlen
= DIV_ROUND_UP(len
, maxpacket
);
284 if (padlen
> usbhid
->bufsize
)
285 padlen
= usbhid
->bufsize
;
288 usbhid
->urbctrl
->transfer_buffer_length
= padlen
;
290 usbhid
->urbctrl
->dev
= hid_to_usb_dev(hid
);
292 usbhid
->cr
->bRequestType
= USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| dir
;
293 usbhid
->cr
->bRequest
= (dir
== USB_DIR_OUT
) ? HID_REQ_SET_REPORT
: HID_REQ_GET_REPORT
;
294 usbhid
->cr
->wValue
= cpu_to_le16(((report
->type
+ 1) << 8) | report
->id
);
295 usbhid
->cr
->wIndex
= cpu_to_le16(usbhid
->ifnum
);
296 usbhid
->cr
->wLength
= cpu_to_le16(len
);
298 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
299 usbhid
->cr
->bRequest
== HID_REQ_SET_REPORT
? "Set_Report" : "Get_Report",
300 usbhid
->cr
->wValue
, usbhid
->cr
->wIndex
, usbhid
->cr
->wLength
);
302 if (usb_submit_urb(usbhid
->urbctrl
, GFP_ATOMIC
)) {
303 err_hid("usb_submit_urb(ctrl) failed");
311 * Output interrupt completion handler.
314 static void hid_irq_out(struct urb
*urb
)
316 struct hid_device
*hid
= urb
->context
;
317 struct usbhid_device
*usbhid
= hid
->driver_data
;
321 switch (urb
->status
) {
322 case 0: /* success */
324 case -ESHUTDOWN
: /* unplug */
326 case -EILSEQ
: /* protocol error or unplug */
327 case -EPROTO
: /* protocol error or unplug */
328 case -ECONNRESET
: /* unlink */
332 warn("output irq status %d received", 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
, usbhid
->ctrl
[usbhid
->ctrltail
].report
->type
,
373 urb
->transfer_buffer
, urb
->actual_length
, 0);
375 case -ESHUTDOWN
: /* unplug */
377 case -EILSEQ
: /* protocol error or unplug */
378 case -EPROTO
: /* protocol error or unplug */
379 case -ECONNRESET
: /* unlink */
381 case -EPIPE
: /* report not available */
384 warn("ctrl urb status %d received", urb
->status
);
388 usbhid
->ctrltail
= usbhid
->ctrlhead
;
390 usbhid
->ctrltail
= (usbhid
->ctrltail
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1);
392 if (usbhid
->ctrlhead
!= usbhid
->ctrltail
) {
393 if (hid_submit_ctrl(hid
)) {
394 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
395 wake_up(&usbhid
->wait
);
397 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
401 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
402 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
403 wake_up(&usbhid
->wait
);
406 void usbhid_submit_report(struct hid_device
*hid
, struct hid_report
*report
, unsigned char dir
)
410 struct usbhid_device
*usbhid
= hid
->driver_data
;
412 if ((hid
->quirks
& HID_QUIRK_NOGET
) && dir
== USB_DIR_IN
)
415 if (usbhid
->urbout
&& dir
== USB_DIR_OUT
&& report
->type
== HID_OUTPUT_REPORT
) {
417 spin_lock_irqsave(&usbhid
->outlock
, flags
);
419 if ((head
= (usbhid
->outhead
+ 1) & (HID_OUTPUT_FIFO_SIZE
- 1)) == usbhid
->outtail
) {
420 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
421 warn("output queue full");
425 usbhid
->out
[usbhid
->outhead
] = report
;
426 usbhid
->outhead
= head
;
428 if (!test_and_set_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
429 if (hid_submit_out(hid
))
430 clear_bit(HID_OUT_RUNNING
, &usbhid
->iofl
);
432 spin_unlock_irqrestore(&usbhid
->outlock
, flags
);
436 spin_lock_irqsave(&usbhid
->ctrllock
, flags
);
438 if ((head
= (usbhid
->ctrlhead
+ 1) & (HID_CONTROL_FIFO_SIZE
- 1)) == usbhid
->ctrltail
) {
439 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
440 warn("control queue full");
444 usbhid
->ctrl
[usbhid
->ctrlhead
].report
= report
;
445 usbhid
->ctrl
[usbhid
->ctrlhead
].dir
= dir
;
446 usbhid
->ctrlhead
= head
;
448 if (!test_and_set_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
449 if (hid_submit_ctrl(hid
))
450 clear_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
);
452 spin_unlock_irqrestore(&usbhid
->ctrllock
, flags
);
455 static int usb_hidinput_input_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
)
457 struct hid_device
*hid
= input_get_drvdata(dev
);
458 struct hid_field
*field
;
462 return input_ff_event(dev
, type
, code
, value
);
467 if ((offset
= hidinput_find_field(hid
, type
, code
, &field
)) == -1) {
468 warn("event field not found");
472 hid_set_field(field
, offset
, value
);
473 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
478 int usbhid_wait_io(struct hid_device
*hid
)
480 struct usbhid_device
*usbhid
= hid
->driver_data
;
482 if (!wait_event_timeout(usbhid
->wait
,
483 (!test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
) &&
484 !test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
)),
486 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
493 static int hid_set_idle(struct usb_device
*dev
, int ifnum
, int report
, int idle
)
495 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
496 HID_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
, (idle
<< 8) | report
,
497 ifnum
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
500 static int hid_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
501 unsigned char type
, void *buf
, int size
)
503 int result
, retries
= 4;
505 memset(buf
, 0, size
);
508 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
509 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
510 (type
<< 8), ifnum
, buf
, size
, USB_CTRL_GET_TIMEOUT
);
512 } while (result
< size
&& retries
);
516 int usbhid_open(struct hid_device
*hid
)
518 struct usbhid_device
*usbhid
= hid
->driver_data
;
522 res
= usb_autopm_get_interface(usbhid
->intf
);
528 if (hid_start_in(hid
))
533 void usbhid_close(struct hid_device
*hid
)
535 struct usbhid_device
*usbhid
= hid
->driver_data
;
538 usb_kill_urb(usbhid
->urbin
);
539 usb_autopm_put_interface(usbhid
->intf
);
544 * Initialize all reports
547 void usbhid_init_reports(struct hid_device
*hid
)
549 struct hid_report
*report
;
550 struct usbhid_device
*usbhid
= hid
->driver_data
;
553 list_for_each_entry(report
, &hid
->report_enum
[HID_INPUT_REPORT
].report_list
, list
)
554 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
556 list_for_each_entry(report
, &hid
->report_enum
[HID_FEATURE_REPORT
].report_list
, list
)
557 usbhid_submit_report(hid
, report
, USB_DIR_IN
);
560 ret
= usbhid_wait_io(hid
);
563 if (test_bit(HID_CTRL_RUNNING
, &usbhid
->iofl
))
564 usb_kill_urb(usbhid
->urbctrl
);
565 if (test_bit(HID_OUT_RUNNING
, &usbhid
->iofl
))
566 usb_kill_urb(usbhid
->urbout
);
567 ret
= usbhid_wait_io(hid
);
571 warn("timeout initializing reports");
575 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
577 static int hid_find_field_early(struct hid_device
*hid
, unsigned int page
,
578 unsigned int hid_code
, struct hid_field
**pfield
)
580 struct hid_report
*report
;
581 struct hid_field
*field
;
582 struct hid_usage
*usage
;
585 list_for_each_entry(report
, &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
586 for (i
= 0; i
< report
->maxfield
; i
++) {
587 field
= report
->field
[i
];
588 for (j
= 0; j
< field
->maxusage
; j
++) {
589 usage
= &field
->usage
[j
];
590 if ((usage
->hid
& HID_USAGE_PAGE
) == page
&&
591 (usage
->hid
& 0xFFFF) == hid_code
) {
601 static void usbhid_set_leds(struct hid_device
*hid
)
603 struct hid_field
*field
;
606 if ((offset
= hid_find_field_early(hid
, HID_UP_LED
, 0x01, &field
)) != -1) {
607 hid_set_field(field
, offset
, 0);
608 usbhid_submit_report(hid
, field
->report
, USB_DIR_OUT
);
613 * Traverse the supplied list of reports and find the longest
615 static void hid_find_max_report(struct hid_device
*hid
, unsigned int type
,
618 struct hid_report
*report
;
621 list_for_each_entry(report
, &hid
->report_enum
[type
].report_list
, list
) {
622 size
= ((report
->size
- 1) >> 3) + 1;
623 if (type
== HID_INPUT_REPORT
&& hid
->report_enum
[type
].numbered
)
630 static int hid_alloc_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
632 struct usbhid_device
*usbhid
= hid
->driver_data
;
634 if (!(usbhid
->inbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_ATOMIC
, &usbhid
->inbuf_dma
)))
636 if (!(usbhid
->outbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_ATOMIC
, &usbhid
->outbuf_dma
)))
638 if (!(usbhid
->cr
= usb_buffer_alloc(dev
, sizeof(*(usbhid
->cr
)), GFP_ATOMIC
, &usbhid
->cr_dma
)))
640 if (!(usbhid
->ctrlbuf
= usb_buffer_alloc(dev
, usbhid
->bufsize
, GFP_ATOMIC
, &usbhid
->ctrlbuf_dma
)))
646 static int usbhid_output_raw_report(struct hid_device
*hid
, __u8
*buf
, size_t count
)
648 struct usbhid_device
*usbhid
= hid
->driver_data
;
649 struct usb_device
*dev
= hid_to_usb_dev(hid
);
650 struct usb_interface
*intf
= usbhid
->intf
;
651 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
654 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
656 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
657 ((HID_OUTPUT_REPORT
+ 1) << 8) | *buf
,
658 interface
->desc
.bInterfaceNumber
, buf
+ 1, count
- 1,
659 USB_CTRL_SET_TIMEOUT
);
661 /* count also the report id */
668 static void hid_free_buffers(struct usb_device
*dev
, struct hid_device
*hid
)
670 struct usbhid_device
*usbhid
= hid
->driver_data
;
672 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->inbuf
, usbhid
->inbuf_dma
);
673 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->outbuf
, usbhid
->outbuf_dma
);
674 usb_buffer_free(dev
, sizeof(*(usbhid
->cr
)), usbhid
->cr
, usbhid
->cr_dma
);
675 usb_buffer_free(dev
, usbhid
->bufsize
, usbhid
->ctrlbuf
, usbhid
->ctrlbuf_dma
);
679 * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
680 * to "operational". Without this, the ps3 controller will not report any
683 static void hid_fixup_sony_ps3_controller(struct usb_device
*dev
, int ifnum
)
686 char *buf
= kmalloc(18, GFP_KERNEL
);
691 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
693 USB_DIR_IN
| USB_TYPE_CLASS
|
695 (3 << 8) | 0xf2, ifnum
, buf
, 17,
696 USB_CTRL_GET_TIMEOUT
);
699 err_hid("%s failed: %d\n", __func__
, result
);
704 static int usbhid_start_finish(struct hid_device
*hid
)
706 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
707 char path
[64], *type
;
710 usbhid_init_reports(hid
);
711 hid_dump_device(hid
);
712 if (hid
->quirks
& HID_QUIRK_RESET_LEDS
)
713 usbhid_set_leds(hid
);
715 if (!hidinput_connect(hid
))
716 hid
->claimed
|= HID_CLAIMED_INPUT
;
717 if (!hiddev_connect(hid
))
718 hid
->claimed
|= HID_CLAIMED_HIDDEV
;
719 if (!hidraw_connect(hid
))
720 hid
->claimed
|= HID_CLAIMED_HIDRAW
;
723 printk(KERN_ERR
"HID device claimed by neither input, hiddev "
728 if ((hid
->claimed
& HID_CLAIMED_INPUT
))
731 if (hid
->quirks
& HID_QUIRK_SONY_PS3_CONTROLLER
)
732 hid_fixup_sony_ps3_controller(interface_to_usbdev(intf
),
733 intf
->cur_altsetting
->desc
.bInterfaceNumber
);
737 if (hid
->claimed
& HID_CLAIMED_INPUT
)
739 if ((hid
->claimed
& HID_CLAIMED_INPUT
) &&
740 ((hid
->claimed
& HID_CLAIMED_HIDDEV
) ||
741 hid
->claimed
& HID_CLAIMED_HIDRAW
))
743 if (hid
->claimed
& HID_CLAIMED_HIDDEV
)
744 printk("hiddev%d", hid
->minor
);
745 if ((hid
->claimed
& HID_CLAIMED_INPUT
) &&
746 (hid
->claimed
& HID_CLAIMED_HIDDEV
) &&
747 (hid
->claimed
& HID_CLAIMED_HIDRAW
))
749 if (hid
->claimed
& HID_CLAIMED_HIDRAW
)
750 printk("hidraw%d", ((struct hidraw
*)hid
->hidraw
)->minor
);
753 for (i
= 0; i
< hid
->maxcollection
; i
++) {
754 if (hid
->collection
[i
].type
== HID_COLLECTION_APPLICATION
&&
755 (hid
->collection
[i
].usage
& HID_USAGE_PAGE
) ==
757 (hid
->collection
[i
].usage
& 0xffff) <
758 ARRAY_SIZE(hid_types
)) {
759 type
= hid_types
[hid
->collection
[i
].usage
& 0xffff];
764 usb_make_path(interface_to_usbdev(intf
), path
, 63);
766 printk(": USB HID v%x.%02x %s [%s] on %s\n",
767 hid
->version
>> 8, hid
->version
& 0xff, type
, hid
->name
, path
);
772 static int usbhid_parse(struct hid_device
*hid
)
774 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
775 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
776 struct usb_device
*dev
= interface_to_usbdev (intf
);
777 struct hid_descriptor
*hdesc
;
779 unsigned int rsize
= 0;
783 quirks
= usbhid_lookup_quirk(le16_to_cpu(dev
->descriptor
.idVendor
),
784 le16_to_cpu(dev
->descriptor
.idProduct
));
786 /* Many keyboards and mice don't like to be polled for reports,
787 * so we will always set the HID_QUIRK_NOGET flag for them. */
788 if (interface
->desc
.bInterfaceSubClass
== USB_INTERFACE_SUBCLASS_BOOT
) {
789 if (interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_KEYBOARD
||
790 interface
->desc
.bInterfaceProtocol
== USB_INTERFACE_PROTOCOL_MOUSE
)
791 quirks
|= HID_QUIRK_NOGET
;
794 if (usb_get_extra_descriptor(interface
, HID_DT_HID
, &hdesc
) &&
795 (!interface
->desc
.bNumEndpoints
||
796 usb_get_extra_descriptor(&interface
->endpoint
[0], HID_DT_HID
, &hdesc
))) {
797 dbg_hid("class descriptor not present\n");
801 hid
->version
= le16_to_cpu(hdesc
->bcdHID
);
802 hid
->country
= hdesc
->bCountryCode
;
804 for (n
= 0; n
< hdesc
->bNumDescriptors
; n
++)
805 if (hdesc
->desc
[n
].bDescriptorType
== HID_DT_REPORT
)
806 rsize
= le16_to_cpu(hdesc
->desc
[n
].wDescriptorLength
);
808 if (!rsize
|| rsize
> HID_MAX_DESCRIPTOR_SIZE
) {
809 dbg_hid("weird size of report descriptor (%u)\n", rsize
);
813 if (!(rdesc
= kmalloc(rsize
, GFP_KERNEL
))) {
814 dbg_hid("couldn't allocate rdesc memory\n");
818 hid_set_idle(dev
, interface
->desc
.bInterfaceNumber
, 0, 0);
820 ret
= hid_get_class_descriptor(dev
, interface
->desc
.bInterfaceNumber
,
821 HID_DT_REPORT
, rdesc
, rsize
);
823 dbg_hid("reading report descriptor failed\n");
828 usbhid_fixup_report_descriptor(le16_to_cpu(dev
->descriptor
.idVendor
),
829 le16_to_cpu(dev
->descriptor
.idProduct
), rdesc
,
830 rsize
, rdesc_quirks_param
);
832 dbg_hid("report descriptor (size %u, read %d) = ", rsize
, n
);
833 for (n
= 0; n
< rsize
; n
++)
834 dbg_hid_line(" %02x", (unsigned char) rdesc
[n
]);
837 ret
= hid_parse_report(hid
, rdesc
, rsize
);
840 dbg_hid("parsing report descriptor failed\n");
844 hid
->quirks
= quirks
;
851 static int usbhid_start(struct hid_device
*hid
)
853 struct usb_interface
*intf
= to_usb_interface(hid
->dev
.parent
);
854 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
855 struct usb_device
*dev
= interface_to_usbdev(intf
);
856 struct usbhid_device
*usbhid
;
857 unsigned int n
, insize
= 0;
860 WARN_ON(hid
->driver_data
);
862 usbhid
= kzalloc(sizeof(struct usbhid_device
), GFP_KERNEL
);
863 if (usbhid
== NULL
) {
868 hid
->driver_data
= usbhid
;
871 usbhid
->bufsize
= HID_MIN_BUFFER_SIZE
;
872 hid_find_max_report(hid
, HID_INPUT_REPORT
, &usbhid
->bufsize
);
873 hid_find_max_report(hid
, HID_OUTPUT_REPORT
, &usbhid
->bufsize
);
874 hid_find_max_report(hid
, HID_FEATURE_REPORT
, &usbhid
->bufsize
);
876 if (usbhid
->bufsize
> HID_MAX_BUFFER_SIZE
)
877 usbhid
->bufsize
= HID_MAX_BUFFER_SIZE
;
879 hid_find_max_report(hid
, HID_INPUT_REPORT
, &insize
);
881 if (insize
> HID_MAX_BUFFER_SIZE
)
882 insize
= HID_MAX_BUFFER_SIZE
;
884 if (hid_alloc_buffers(dev
, hid
)) {
889 for (n
= 0; n
< interface
->desc
.bNumEndpoints
; n
++) {
890 struct usb_endpoint_descriptor
*endpoint
;
894 endpoint
= &interface
->endpoint
[n
].desc
;
895 if ((endpoint
->bmAttributes
& 3) != 3) /* Not an interrupt endpoint */
898 interval
= endpoint
->bInterval
;
900 /* Some vendors give fullspeed interval on highspeed devides */
901 if (hid
->quirks
& HID_QUIRK_FULLSPEED_INTERVAL
&&
902 dev
->speed
== USB_SPEED_HIGH
) {
903 interval
= fls(endpoint
->bInterval
*8);
904 printk(KERN_INFO
"%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
905 hid
->name
, endpoint
->bInterval
, interval
);
908 /* Change the polling interval of mice. */
909 if (hid
->collection
->usage
== HID_GD_MOUSE
&& hid_mousepoll_interval
> 0)
910 interval
= hid_mousepoll_interval
;
913 if (usb_endpoint_dir_in(endpoint
)) {
916 if (!(usbhid
->urbin
= usb_alloc_urb(0, GFP_KERNEL
)))
918 pipe
= usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
);
919 usb_fill_int_urb(usbhid
->urbin
, dev
, pipe
, usbhid
->inbuf
, insize
,
920 hid_irq_in
, hid
, interval
);
921 usbhid
->urbin
->transfer_dma
= usbhid
->inbuf_dma
;
922 usbhid
->urbin
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
926 if (!(usbhid
->urbout
= usb_alloc_urb(0, GFP_KERNEL
)))
928 pipe
= usb_sndintpipe(dev
, endpoint
->bEndpointAddress
);
929 usb_fill_int_urb(usbhid
->urbout
, dev
, pipe
, usbhid
->outbuf
, 0,
930 hid_irq_out
, hid
, interval
);
931 usbhid
->urbout
->transfer_dma
= usbhid
->outbuf_dma
;
932 usbhid
->urbout
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
936 if (!usbhid
->urbin
) {
937 err_hid("couldn't find an input interrupt endpoint");
942 init_waitqueue_head(&usbhid
->wait
);
943 INIT_WORK(&usbhid
->reset_work
, hid_reset
);
944 setup_timer(&usbhid
->io_retry
, hid_retry_timeout
, (unsigned long) hid
);
946 spin_lock_init(&usbhid
->inlock
);
947 spin_lock_init(&usbhid
->outlock
);
948 spin_lock_init(&usbhid
->ctrllock
);
951 usbhid
->ifnum
= interface
->desc
.bInterfaceNumber
;
953 usbhid
->urbctrl
= usb_alloc_urb(0, GFP_KERNEL
);
954 if (!usbhid
->urbctrl
) {
959 usb_fill_control_urb(usbhid
->urbctrl
, dev
, 0, (void *) usbhid
->cr
,
960 usbhid
->ctrlbuf
, 1, hid_ctrl
, hid
);
961 usbhid
->urbctrl
->setup_dma
= usbhid
->cr_dma
;
962 usbhid
->urbctrl
->transfer_dma
= usbhid
->ctrlbuf_dma
;
963 usbhid
->urbctrl
->transfer_flags
|= (URB_NO_TRANSFER_DMA_MAP
| URB_NO_SETUP_DMA_MAP
);
965 ret
= usbhid_start_finish(hid
);
972 usb_free_urb(usbhid
->urbin
);
973 usb_free_urb(usbhid
->urbout
);
974 usb_free_urb(usbhid
->urbctrl
);
975 hid_free_buffers(dev
, hid
);
981 static void usbhid_stop(struct hid_device
*hid
)
983 struct usbhid_device
*usbhid
= hid
->driver_data
;
985 if (WARN_ON(!usbhid
))
988 spin_lock_irq(&usbhid
->inlock
); /* Sync with error handler */
989 set_bit(HID_DISCONNECTED
, &usbhid
->iofl
);
990 spin_unlock_irq(&usbhid
->inlock
);
991 usb_kill_urb(usbhid
->urbin
);
992 usb_kill_urb(usbhid
->urbout
);
993 usb_kill_urb(usbhid
->urbctrl
);
995 del_timer_sync(&usbhid
->io_retry
);
996 cancel_work_sync(&usbhid
->reset_work
);
998 if (hid
->claimed
& HID_CLAIMED_INPUT
)
999 hidinput_disconnect(hid
);
1000 if (hid
->claimed
& HID_CLAIMED_HIDDEV
)
1001 hiddev_disconnect(hid
);
1002 if (hid
->claimed
& HID_CLAIMED_HIDRAW
)
1003 hidraw_disconnect(hid
);
1007 usb_free_urb(usbhid
->urbin
);
1008 usb_free_urb(usbhid
->urbctrl
);
1009 usb_free_urb(usbhid
->urbout
);
1011 hid_free_buffers(hid_to_usb_dev(hid
), hid
);
1013 hid
->driver_data
= NULL
;
1016 static struct hid_ll_driver usb_hid_driver
= {
1017 .parse
= usbhid_parse
,
1018 .start
= usbhid_start
,
1019 .stop
= usbhid_stop
,
1020 .open
= usbhid_open
,
1021 .close
= usbhid_close
,
1022 .hidinput_input_event
= usb_hidinput_input_event
,
1025 static int hid_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1027 struct usb_device
*dev
= interface_to_usbdev(intf
);
1028 struct hid_device
*hid
;
1032 dbg_hid("HID probe called for ifnum %d\n",
1033 intf
->altsetting
->desc
.bInterfaceNumber
);
1035 hid
= hid_allocate_device();
1037 return PTR_ERR(hid
);
1039 usb_set_intfdata(intf
, hid
);
1040 hid
->ll_driver
= &usb_hid_driver
;
1041 hid
->hid_output_raw_report
= usbhid_output_raw_report
;
1042 #ifdef CONFIG_USB_HIDDEV
1043 hid
->hiddev_hid_event
= hiddev_hid_event
;
1044 hid
->hiddev_report_event
= hiddev_report_event
;
1046 hid
->dev
.parent
= &intf
->dev
;
1048 hid
->vendor
= le16_to_cpu(dev
->descriptor
.idVendor
);
1049 hid
->product
= le16_to_cpu(dev
->descriptor
.idProduct
);
1052 if (dev
->manufacturer
)
1053 strlcpy(hid
->name
, dev
->manufacturer
, sizeof(hid
->name
));
1056 if (dev
->manufacturer
)
1057 strlcat(hid
->name
, " ", sizeof(hid
->name
));
1058 strlcat(hid
->name
, dev
->product
, sizeof(hid
->name
));
1061 if (!strlen(hid
->name
))
1062 snprintf(hid
->name
, sizeof(hid
->name
), "HID %04x:%04x",
1063 le16_to_cpu(dev
->descriptor
.idVendor
),
1064 le16_to_cpu(dev
->descriptor
.idProduct
));
1066 usb_make_path(dev
, hid
->phys
, sizeof(hid
->phys
));
1067 strlcat(hid
->phys
, "/input", sizeof(hid
->phys
));
1068 len
= strlen(hid
->phys
);
1069 if (len
< sizeof(hid
->phys
) - 1)
1070 snprintf(hid
->phys
+ len
, sizeof(hid
->phys
) - len
,
1071 "%d", intf
->altsetting
[0].desc
.bInterfaceNumber
);
1073 if (usb_string(dev
, dev
->descriptor
.iSerialNumber
, hid
->uniq
, 64) <= 0)
1076 ret
= hid_add_device(hid
);
1079 dev_err(&intf
->dev
, "can't add hid device: %d\n", ret
);
1085 hid_destroy_device(hid
);
1089 static void hid_disconnect(struct usb_interface
*intf
)
1091 struct hid_device
*hid
= usb_get_intfdata(intf
);
1096 hid_destroy_device(hid
);
1099 static int hid_suspend(struct usb_interface
*intf
, pm_message_t message
)
1101 struct hid_device
*hid
= usb_get_intfdata (intf
);
1102 struct usbhid_device
*usbhid
= hid
->driver_data
;
1104 spin_lock_irq(&usbhid
->inlock
); /* Sync with error handler */
1105 set_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1106 spin_unlock_irq(&usbhid
->inlock
);
1107 del_timer(&usbhid
->io_retry
);
1108 usb_kill_urb(usbhid
->urbin
);
1109 dev_dbg(&intf
->dev
, "suspend\n");
1113 static int hid_resume(struct usb_interface
*intf
)
1115 struct hid_device
*hid
= usb_get_intfdata (intf
);
1116 struct usbhid_device
*usbhid
= hid
->driver_data
;
1119 clear_bit(HID_SUSPENDED
, &usbhid
->iofl
);
1120 usbhid
->retry_delay
= 0;
1121 status
= hid_start_in(hid
);
1122 dev_dbg(&intf
->dev
, "resume status %d\n", status
);
1126 /* Treat USB reset pretty much the same as suspend/resume */
1127 static int hid_pre_reset(struct usb_interface
*intf
)
1129 /* FIXME: What if the interface is already suspended? */
1130 hid_suspend(intf
, PMSG_ON
);
1134 /* Same routine used for post_reset and reset_resume */
1135 static int hid_post_reset(struct usb_interface
*intf
)
1137 struct usb_device
*dev
= interface_to_usbdev (intf
);
1139 hid_set_idle(dev
, intf
->cur_altsetting
->desc
.bInterfaceNumber
, 0, 0);
1140 /* FIXME: Any more reinitialization needed? */
1142 return hid_resume(intf
);
1145 static struct usb_device_id hid_usb_ids
[] = {
1146 { .match_flags
= USB_DEVICE_ID_MATCH_INT_CLASS
,
1147 .bInterfaceClass
= USB_INTERFACE_CLASS_HID
},
1148 { } /* Terminating entry */
1151 MODULE_DEVICE_TABLE (usb
, hid_usb_ids
);
1153 static struct usb_driver hid_driver
= {
1156 .disconnect
= hid_disconnect
,
1157 .suspend
= hid_suspend
,
1158 .resume
= hid_resume
,
1159 .reset_resume
= hid_post_reset
,
1160 .pre_reset
= hid_pre_reset
,
1161 .post_reset
= hid_post_reset
,
1162 .id_table
= hid_usb_ids
,
1163 .supports_autosuspend
= 1,
1166 static const struct hid_device_id hid_usb_table
[] = {
1167 { HID_USB_DEVICE(HID_ANY_ID
, HID_ANY_ID
) },
1171 static struct hid_driver hid_usb_driver
= {
1172 .name
= "generic-usb",
1173 .id_table
= hid_usb_table
,
1176 static int __init
hid_init(void)
1179 retval
= hid_register_driver(&hid_usb_driver
);
1181 goto hid_register_fail
;
1182 retval
= usbhid_quirks_init(quirks_param
);
1184 goto usbhid_quirks_init_fail
;
1185 retval
= hiddev_init();
1187 goto hiddev_init_fail
;
1188 retval
= usb_register(&hid_driver
);
1190 goto usb_register_fail
;
1191 info(DRIVER_VERSION
":" DRIVER_DESC
);
1197 usbhid_quirks_exit();
1198 usbhid_quirks_init_fail
:
1199 hid_unregister_driver(&hid_usb_driver
);
1204 static void __exit
hid_exit(void)
1206 usb_deregister(&hid_driver
);
1208 usbhid_quirks_exit();
1209 hid_unregister_driver(&hid_usb_driver
);
1212 module_init(hid_init
);
1213 module_exit(hid_exit
);
1215 MODULE_AUTHOR(DRIVER_AUTHOR
);
1216 MODULE_DESCRIPTION(DRIVER_DESC
);
1217 MODULE_LICENSE(DRIVER_LICENSE
);