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>
32 #include <linux/usb.h>
34 #include <linux/hid.h>
35 #include <linux/hiddev.h>
36 #include <linux/hid-debug.h>
37 #include <linux/hidraw.h>
44 #define DRIVER_DESC "USB HID core driver"
45 #define DRIVER_LICENSE "GPL"
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] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
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);
70 static struct workqueue_struct *resumption_waker;
72 static void hid_io_error(struct hid_device *hid);
73 static int hid_submit_out(struct hid_device *hid);
74 static int hid_submit_ctrl(struct hid_device *hid);
75 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
77 /* Start up the input URB */
78 static int hid_start_in(struct hid_device *hid)
82 struct usbhid_device *usbhid = hid->driver_data;
84 spin_lock_irqsave(&usbhid->lock, flags);
86 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
87 !test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
88 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
89 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
91 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
93 spin_unlock_irqrestore(&usbhid->lock, flags);
97 /* I/O retry timer routine */
98 static void hid_retry_timeout(unsigned long _hid)
100 struct hid_device *hid = (struct hid_device *) _hid;
101 struct usbhid_device *usbhid = hid->driver_data;
103 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
104 if (hid_start_in(hid))
108 /* Workqueue routine to reset the device or clear a halt */
109 static void hid_reset(struct work_struct *work)
111 struct usbhid_device *usbhid =
112 container_of(work, struct usbhid_device, reset_work);
113 struct hid_device *hid = usbhid->hid;
116 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
117 dev_dbg(&usbhid->intf->dev, "clear halt\n");
118 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
119 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
123 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
124 dev_dbg(&usbhid->intf->dev, "resetting device\n");
125 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
127 rc = usb_reset_device(hid_to_usb_dev(hid));
128 usb_unlock_device(hid_to_usb_dev(hid));
130 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
135 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
139 err_hid("can't reset device, %s-%s/input%d, status %d",
140 hid_to_usb_dev(hid)->bus->bus_name,
141 hid_to_usb_dev(hid)->devpath,
151 /* Main I/O error handler */
152 static void hid_io_error(struct hid_device *hid)
155 struct usbhid_device *usbhid = hid->driver_data;
157 spin_lock_irqsave(&usbhid->lock, flags);
159 /* Stop when disconnected */
160 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
163 /* If it has been a while since the last error, we'll assume
164 * this a brand new error and reset the retry timeout. */
165 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
166 usbhid->retry_delay = 0;
168 /* When an error occurs, retry at increasing intervals */
169 if (usbhid->retry_delay == 0) {
170 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
171 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
172 } else if (usbhid->retry_delay < 100)
173 usbhid->retry_delay *= 2;
175 if (time_after(jiffies, usbhid->stop_retry)) {
177 /* Retries failed, so do a port reset */
178 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
179 schedule_work(&usbhid->reset_work);
184 mod_timer(&usbhid->io_retry,
185 jiffies + msecs_to_jiffies(usbhid->retry_delay));
187 spin_unlock_irqrestore(&usbhid->lock, flags);
190 static void usbhid_mark_busy(struct usbhid_device *usbhid)
192 struct usb_interface *intf = usbhid->intf;
194 usb_mark_last_busy(interface_to_usbdev(intf));
197 static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
199 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
205 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
206 dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
207 if (hid_submit_out(hid)) {
208 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
209 wake_up(&usbhid->wait);
215 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
217 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
220 WARN_ON(hid == NULL);
224 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
225 dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
226 if (hid_submit_ctrl(hid)) {
227 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
228 wake_up(&usbhid->wait);
235 * Input interrupt completion handler.
238 static void hid_irq_in(struct urb *urb)
240 struct hid_device *hid = urb->context;
241 struct usbhid_device *usbhid = hid->driver_data;
244 switch (urb->status) {
245 case 0: /* success */
246 usbhid_mark_busy(usbhid);
247 usbhid->retry_delay = 0;
248 hid_input_report(urb->context, HID_INPUT_REPORT,
249 urb->transfer_buffer,
250 urb->actual_length, 1);
252 * autosuspend refused while keys are pressed
253 * because most keyboards don't wake up when
256 if (hid_check_keys_pressed(hid))
257 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
259 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
261 case -EPIPE: /* stall */
262 usbhid_mark_busy(usbhid);
263 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
264 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
265 schedule_work(&usbhid->reset_work);
267 case -ECONNRESET: /* unlink */
269 case -ESHUTDOWN: /* unplug */
270 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
272 case -EILSEQ: /* protocol error or unplug */
273 case -EPROTO: /* protocol error or unplug */
274 case -ETIME: /* protocol error or unplug */
275 case -ETIMEDOUT: /* Should never happen, but... */
276 usbhid_mark_busy(usbhid);
277 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
281 dev_warn(&urb->dev->dev, "input irq status %d "
282 "received\n", urb->status);
285 status = usb_submit_urb(urb, GFP_ATOMIC);
287 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
288 if (status != -EPERM) {
289 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
290 hid_to_usb_dev(hid)->bus->bus_name,
291 hid_to_usb_dev(hid)->devpath,
292 usbhid->ifnum, status);
298 static int hid_submit_out(struct hid_device *hid)
300 struct hid_report *report;
302 struct usbhid_device *usbhid = hid->driver_data;
304 report = usbhid->out[usbhid->outtail].report;
305 raw_report = usbhid->out[usbhid->outtail].raw_report;
307 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
308 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
309 usbhid->urbout->dev = hid_to_usb_dev(hid);
310 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
313 dbg_hid("submitting out urb\n");
315 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
316 err_hid("usb_submit_urb(out) failed");
319 usbhid->last_out = jiffies;
322 * queue work to wake up the device.
323 * as the work queue is freezeable, this is safe
324 * with respect to STD and STR
326 queue_work(resumption_waker, &usbhid->restart_work);
332 static int hid_submit_ctrl(struct hid_device *hid)
334 struct hid_report *report;
338 struct usbhid_device *usbhid = hid->driver_data;
340 report = usbhid->ctrl[usbhid->ctrltail].report;
341 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
342 dir = usbhid->ctrl[usbhid->ctrltail].dir;
344 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
345 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
346 if (dir == USB_DIR_OUT) {
347 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
348 usbhid->urbctrl->transfer_buffer_length = len;
349 memcpy(usbhid->ctrlbuf, raw_report, len);
352 int maxpacket, padlen;
354 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
355 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
357 padlen = DIV_ROUND_UP(len, maxpacket);
359 if (padlen > usbhid->bufsize)
360 padlen = usbhid->bufsize;
363 usbhid->urbctrl->transfer_buffer_length = padlen;
365 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
367 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
368 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
369 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
370 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
371 usbhid->cr->wLength = cpu_to_le16(len);
373 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
374 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
375 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
377 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
378 err_hid("usb_submit_urb(ctrl) failed");
381 usbhid->last_ctrl = jiffies;
384 * queue work to wake up the device.
385 * as the work queue is freezeable, this is safe
386 * with respect to STD and STR
388 queue_work(resumption_waker, &usbhid->restart_work);
395 * Output interrupt completion handler.
398 static void hid_irq_out(struct urb *urb)
400 struct hid_device *hid = urb->context;
401 struct usbhid_device *usbhid = hid->driver_data;
405 switch (urb->status) {
406 case 0: /* success */
408 case -ESHUTDOWN: /* unplug */
410 case -EILSEQ: /* protocol error or unplug */
411 case -EPROTO: /* protocol error or unplug */
412 case -ECONNRESET: /* unlink */
416 dev_warn(&urb->dev->dev, "output irq status %d "
417 "received\n", urb->status);
420 spin_lock_irqsave(&usbhid->lock, flags);
423 usbhid->outtail = usbhid->outhead;
425 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
427 if (usbhid->outhead != usbhid->outtail) {
428 if (hid_submit_out(hid)) {
429 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
430 wake_up(&usbhid->wait);
432 spin_unlock_irqrestore(&usbhid->lock, flags);
436 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
437 spin_unlock_irqrestore(&usbhid->lock, flags);
438 wake_up(&usbhid->wait);
442 * Control pipe completion handler.
445 static void hid_ctrl(struct urb *urb)
447 struct hid_device *hid = urb->context;
448 struct usbhid_device *usbhid = hid->driver_data;
449 int unplug = 0, status = urb->status;
451 spin_lock(&usbhid->lock);
454 case 0: /* success */
455 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
456 hid_input_report(urb->context,
457 usbhid->ctrl[usbhid->ctrltail].report->type,
458 urb->transfer_buffer, urb->actual_length, 0);
460 case -ESHUTDOWN: /* unplug */
462 case -EILSEQ: /* protocol error or unplug */
463 case -EPROTO: /* protocol error or unplug */
464 case -ECONNRESET: /* unlink */
466 case -EPIPE: /* report not available */
469 dev_warn(&urb->dev->dev, "ctrl urb status %d "
470 "received\n", status);
474 usbhid->ctrltail = usbhid->ctrlhead;
476 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
478 if (usbhid->ctrlhead != usbhid->ctrltail) {
479 if (hid_submit_ctrl(hid)) {
480 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
481 wake_up(&usbhid->wait);
483 spin_unlock(&usbhid->lock);
487 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
488 spin_unlock(&usbhid->lock);
489 wake_up(&usbhid->wait);
492 static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
496 struct usbhid_device *usbhid = hid->driver_data;
497 int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
499 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
502 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
503 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
504 dev_warn(&hid->dev, "output queue full\n");
508 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
509 if (!usbhid->out[usbhid->outhead].raw_report) {
510 dev_warn(&hid->dev, "output queueing failed\n");
513 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
514 usbhid->out[usbhid->outhead].report = report;
515 usbhid->outhead = head;
517 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
518 if (hid_submit_out(hid))
519 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
522 * the queue is known to run
523 * but an earlier request may be stuck
524 * we may need to time out
525 * no race because this is called under
528 if (time_after(jiffies, usbhid->last_out + HZ * 5))
529 usb_unlink_urb(usbhid->urbout);
534 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
535 dev_warn(&hid->dev, "control queue full\n");
539 if (dir == USB_DIR_OUT) {
540 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
541 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
542 dev_warn(&hid->dev, "control queueing failed\n");
545 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
547 usbhid->ctrl[usbhid->ctrlhead].report = report;
548 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
549 usbhid->ctrlhead = head;
551 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
552 if (hid_submit_ctrl(hid))
553 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
556 * the queue is known to run
557 * but an earlier request may be stuck
558 * we may need to time out
559 * no race because this is called under
562 if (time_after(jiffies, usbhid->last_ctrl + HZ * 5))
563 usb_unlink_urb(usbhid->urbctrl);
567 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
569 struct usbhid_device *usbhid = hid->driver_data;
572 spin_lock_irqsave(&usbhid->lock, flags);
573 __usbhid_submit_report(hid, report, dir);
574 spin_unlock_irqrestore(&usbhid->lock, flags);
576 EXPORT_SYMBOL_GPL(usbhid_submit_report);
578 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
580 struct hid_device *hid = input_get_drvdata(dev);
581 struct usbhid_device *usbhid = hid->driver_data;
582 struct hid_field *field;
587 return input_ff_event(dev, type, code, value);
592 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
593 dev_warn(&dev->dev, "event field not found\n");
597 hid_set_field(field, offset, value);
599 spin_lock_irqsave(&usbhid->lock, flags);
601 spin_unlock_irqrestore(&usbhid->lock, flags);
603 spin_lock_irqsave(&usbhid->lock, flags);
605 spin_unlock_irqrestore(&usbhid->lock, flags);
607 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
612 int usbhid_wait_io(struct hid_device *hid)
614 struct usbhid_device *usbhid = hid->driver_data;
616 if (!wait_event_timeout(usbhid->wait,
617 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
618 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
620 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
627 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
629 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
630 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
631 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
634 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
635 unsigned char type, void *buf, int size)
637 int result, retries = 4;
639 memset(buf, 0, size);
642 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
643 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
644 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
646 } while (result < size && retries);
650 int usbhid_open(struct hid_device *hid)
652 struct usbhid_device *usbhid = hid->driver_data;
655 mutex_lock(&hid_open_mut);
657 res = usb_autopm_get_interface(usbhid->intf);
658 /* the device must be awake to reliable request remote wakeup */
661 mutex_unlock(&hid_open_mut);
664 usbhid->intf->needs_remote_wakeup = 1;
665 if (hid_start_in(hid))
668 usb_autopm_put_interface(usbhid->intf);
670 mutex_unlock(&hid_open_mut);
674 void usbhid_close(struct hid_device *hid)
676 struct usbhid_device *usbhid = hid->driver_data;
678 mutex_lock(&hid_open_mut);
680 /* protecting hid->open to make sure we don't restart
681 * data acquistion due to a resumption we no longer
684 spin_lock_irq(&usbhid->lock);
686 spin_unlock_irq(&usbhid->lock);
687 hid_cancel_delayed_stuff(usbhid);
688 usb_kill_urb(usbhid->urbin);
689 usbhid->intf->needs_remote_wakeup = 0;
691 spin_unlock_irq(&usbhid->lock);
693 mutex_unlock(&hid_open_mut);
697 * Initialize all reports
700 void usbhid_init_reports(struct hid_device *hid)
702 struct hid_report *report;
703 struct usbhid_device *usbhid = hid->driver_data;
706 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
707 usbhid_submit_report(hid, report, USB_DIR_IN);
709 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
710 usbhid_submit_report(hid, report, USB_DIR_IN);
713 ret = usbhid_wait_io(hid);
716 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
717 usb_kill_urb(usbhid->urbctrl);
718 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
719 usb_kill_urb(usbhid->urbout);
720 ret = usbhid_wait_io(hid);
724 dev_warn(&hid->dev, "timeout initializing reports\n");
728 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
730 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
731 unsigned int hid_code, struct hid_field **pfield)
733 struct hid_report *report;
734 struct hid_field *field;
735 struct hid_usage *usage;
738 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
739 for (i = 0; i < report->maxfield; i++) {
740 field = report->field[i];
741 for (j = 0; j < field->maxusage; j++) {
742 usage = &field->usage[j];
743 if ((usage->hid & HID_USAGE_PAGE) == page &&
744 (usage->hid & 0xFFFF) == hid_code) {
754 void usbhid_set_leds(struct hid_device *hid)
756 struct hid_field *field;
759 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
760 hid_set_field(field, offset, 0);
761 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
764 EXPORT_SYMBOL_GPL(usbhid_set_leds);
767 * Traverse the supplied list of reports and find the longest
769 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
772 struct hid_report *report;
775 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
776 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
782 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
784 struct usbhid_device *usbhid = hid->driver_data;
786 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
788 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
789 &usbhid->outbuf_dma);
790 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
791 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
792 &usbhid->ctrlbuf_dma);
793 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
800 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count,
801 unsigned char report_type)
803 struct usbhid_device *usbhid = hid->driver_data;
804 struct usb_device *dev = hid_to_usb_dev(hid);
805 struct usb_interface *intf = usbhid->intf;
806 struct usb_host_interface *interface = intf->cur_altsetting;
809 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
811 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
812 ((report_type + 1) << 8) | *buf,
813 interface->desc.bInterfaceNumber, buf + 1, count - 1,
814 USB_CTRL_SET_TIMEOUT);
816 /* count also the report id */
823 static void usbhid_restart_queues(struct usbhid_device *usbhid)
826 usbhid_restart_out_queue(usbhid);
827 usbhid_restart_ctrl_queue(usbhid);
830 static void __usbhid_restart_queues(struct work_struct *work)
832 struct usbhid_device *usbhid =
833 container_of(work, struct usbhid_device, restart_work);
836 r = usb_autopm_get_interface(usbhid->intf);
839 usb_autopm_put_interface(usbhid->intf);
842 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
844 struct usbhid_device *usbhid = hid->driver_data;
846 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
847 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
849 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
852 static int usbhid_parse(struct hid_device *hid)
854 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
855 struct usb_host_interface *interface = intf->cur_altsetting;
856 struct usb_device *dev = interface_to_usbdev (intf);
857 struct hid_descriptor *hdesc;
859 unsigned int rsize = 0;
863 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
864 le16_to_cpu(dev->descriptor.idProduct));
866 if (quirks & HID_QUIRK_IGNORE)
869 /* Many keyboards and mice don't like to be polled for reports,
870 * so we will always set the HID_QUIRK_NOGET flag for them. */
871 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
872 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
873 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
874 quirks |= HID_QUIRK_NOGET;
877 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
878 (!interface->desc.bNumEndpoints ||
879 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
880 dbg_hid("class descriptor not present\n");
884 hid->version = le16_to_cpu(hdesc->bcdHID);
885 hid->country = hdesc->bCountryCode;
887 for (n = 0; n < hdesc->bNumDescriptors; n++)
888 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
889 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
891 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
892 dbg_hid("weird size of report descriptor (%u)\n", rsize);
896 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
897 dbg_hid("couldn't allocate rdesc memory\n");
901 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
903 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
904 HID_DT_REPORT, rdesc, rsize);
906 dbg_hid("reading report descriptor failed\n");
911 ret = hid_parse_report(hid, rdesc, rsize);
914 dbg_hid("parsing report descriptor failed\n");
918 hid->quirks |= quirks;
925 static int usbhid_start(struct hid_device *hid)
927 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
928 struct usb_host_interface *interface = intf->cur_altsetting;
929 struct usb_device *dev = interface_to_usbdev(intf);
930 struct usbhid_device *usbhid = hid->driver_data;
931 unsigned int n, insize = 0;
934 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
936 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
937 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
938 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
939 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
941 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
942 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
944 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
946 if (insize > HID_MAX_BUFFER_SIZE)
947 insize = HID_MAX_BUFFER_SIZE;
949 if (hid_alloc_buffers(dev, hid)) {
954 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
955 struct usb_endpoint_descriptor *endpoint;
959 endpoint = &interface->endpoint[n].desc;
960 if (!usb_endpoint_xfer_int(endpoint))
963 interval = endpoint->bInterval;
965 /* Some vendors give fullspeed interval on highspeed devides */
966 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
967 dev->speed == USB_SPEED_HIGH) {
968 interval = fls(endpoint->bInterval*8);
969 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
970 hid->name, endpoint->bInterval, interval);
973 /* Change the polling interval of mice. */
974 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
975 interval = hid_mousepoll_interval;
978 if (usb_endpoint_dir_in(endpoint)) {
981 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
983 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
984 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
985 hid_irq_in, hid, interval);
986 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
987 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
991 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
993 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
994 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
995 hid_irq_out, hid, interval);
996 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
997 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1001 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1002 if (!usbhid->urbctrl) {
1007 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1008 usbhid->ctrlbuf, 1, hid_ctrl, hid);
1009 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1010 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1012 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1013 usbhid_init_reports(hid);
1015 set_bit(HID_STARTED, &usbhid->iofl);
1017 /* Some keyboards don't work until their LEDs have been set.
1018 * Since BIOSes do set the LEDs, it must be safe for any device
1019 * that supports the keyboard boot protocol.
1021 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1022 interface->desc.bInterfaceProtocol ==
1023 USB_INTERFACE_PROTOCOL_KEYBOARD)
1024 usbhid_set_leds(hid);
1029 usb_free_urb(usbhid->urbin);
1030 usb_free_urb(usbhid->urbout);
1031 usb_free_urb(usbhid->urbctrl);
1032 usbhid->urbin = NULL;
1033 usbhid->urbout = NULL;
1034 usbhid->urbctrl = NULL;
1035 hid_free_buffers(dev, hid);
1039 static void usbhid_stop(struct hid_device *hid)
1041 struct usbhid_device *usbhid = hid->driver_data;
1043 if (WARN_ON(!usbhid))
1046 clear_bit(HID_STARTED, &usbhid->iofl);
1047 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1048 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1049 spin_unlock_irq(&usbhid->lock);
1050 usb_kill_urb(usbhid->urbin);
1051 usb_kill_urb(usbhid->urbout);
1052 usb_kill_urb(usbhid->urbctrl);
1054 hid_cancel_delayed_stuff(usbhid);
1058 usb_free_urb(usbhid->urbin);
1059 usb_free_urb(usbhid->urbctrl);
1060 usb_free_urb(usbhid->urbout);
1061 usbhid->urbin = NULL; /* don't mess up next start */
1062 usbhid->urbctrl = NULL;
1063 usbhid->urbout = NULL;
1065 hid_free_buffers(hid_to_usb_dev(hid), hid);
1068 static int usbhid_power(struct hid_device *hid, int lvl)
1073 case PM_HINT_FULLON:
1074 r = usbhid_get_power(hid);
1076 case PM_HINT_NORMAL:
1077 usbhid_put_power(hid);
1083 static struct hid_ll_driver usb_hid_driver = {
1084 .parse = usbhid_parse,
1085 .start = usbhid_start,
1086 .stop = usbhid_stop,
1087 .open = usbhid_open,
1088 .close = usbhid_close,
1089 .power = usbhid_power,
1090 .hidinput_input_event = usb_hidinput_input_event,
1093 static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1095 struct usb_host_interface *interface = intf->cur_altsetting;
1096 struct usb_device *dev = interface_to_usbdev(intf);
1097 struct usbhid_device *usbhid;
1098 struct hid_device *hid;
1099 unsigned int n, has_in = 0;
1103 dbg_hid("HID probe called for ifnum %d\n",
1104 intf->altsetting->desc.bInterfaceNumber);
1106 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1107 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1110 dev_err(&intf->dev, "couldn't find an input interrupt "
1115 hid = hid_allocate_device();
1117 return PTR_ERR(hid);
1119 usb_set_intfdata(intf, hid);
1120 hid->ll_driver = &usb_hid_driver;
1121 hid->hid_output_raw_report = usbhid_output_raw_report;
1122 hid->ff_init = hid_pidff_init;
1123 #ifdef CONFIG_USB_HIDDEV
1124 hid->hiddev_connect = hiddev_connect;
1125 hid->hiddev_disconnect = hiddev_disconnect;
1126 hid->hiddev_hid_event = hiddev_hid_event;
1127 hid->hiddev_report_event = hiddev_report_event;
1129 hid->dev.parent = &intf->dev;
1131 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1132 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1134 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1135 USB_INTERFACE_PROTOCOL_MOUSE)
1136 hid->type = HID_TYPE_USBMOUSE;
1138 if (dev->manufacturer)
1139 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1142 if (dev->manufacturer)
1143 strlcat(hid->name, " ", sizeof(hid->name));
1144 strlcat(hid->name, dev->product, sizeof(hid->name));
1147 if (!strlen(hid->name))
1148 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1149 le16_to_cpu(dev->descriptor.idVendor),
1150 le16_to_cpu(dev->descriptor.idProduct));
1152 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1153 strlcat(hid->phys, "/input", sizeof(hid->phys));
1154 len = strlen(hid->phys);
1155 if (len < sizeof(hid->phys) - 1)
1156 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1157 "%d", intf->altsetting[0].desc.bInterfaceNumber);
1159 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1162 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1163 if (usbhid == NULL) {
1168 hid->driver_data = usbhid;
1170 usbhid->intf = intf;
1171 usbhid->ifnum = interface->desc.bInterfaceNumber;
1173 init_waitqueue_head(&usbhid->wait);
1174 INIT_WORK(&usbhid->reset_work, hid_reset);
1175 INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
1176 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1177 spin_lock_init(&usbhid->lock);
1179 ret = hid_add_device(hid);
1182 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1190 hid_destroy_device(hid);
1194 static void usbhid_disconnect(struct usb_interface *intf)
1196 struct hid_device *hid = usb_get_intfdata(intf);
1197 struct usbhid_device *usbhid;
1202 usbhid = hid->driver_data;
1203 hid_destroy_device(hid);
1207 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1209 del_timer_sync(&usbhid->io_retry);
1210 cancel_work_sync(&usbhid->restart_work);
1211 cancel_work_sync(&usbhid->reset_work);
1214 static void hid_cease_io(struct usbhid_device *usbhid)
1216 del_timer(&usbhid->io_retry);
1217 usb_kill_urb(usbhid->urbin);
1218 usb_kill_urb(usbhid->urbctrl);
1219 usb_kill_urb(usbhid->urbout);
1222 /* Treat USB reset pretty much the same as suspend/resume */
1223 static int hid_pre_reset(struct usb_interface *intf)
1225 struct hid_device *hid = usb_get_intfdata(intf);
1226 struct usbhid_device *usbhid = hid->driver_data;
1228 spin_lock_irq(&usbhid->lock);
1229 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1230 spin_unlock_irq(&usbhid->lock);
1231 cancel_work_sync(&usbhid->restart_work);
1232 hid_cease_io(usbhid);
1237 /* Same routine used for post_reset and reset_resume */
1238 static int hid_post_reset(struct usb_interface *intf)
1240 struct usb_device *dev = interface_to_usbdev (intf);
1241 struct hid_device *hid = usb_get_intfdata(intf);
1242 struct usbhid_device *usbhid = hid->driver_data;
1245 spin_lock_irq(&usbhid->lock);
1246 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1247 spin_unlock_irq(&usbhid->lock);
1248 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1249 status = hid_start_in(hid);
1252 usbhid_restart_queues(usbhid);
1257 int usbhid_get_power(struct hid_device *hid)
1259 struct usbhid_device *usbhid = hid->driver_data;
1261 return usb_autopm_get_interface(usbhid->intf);
1264 void usbhid_put_power(struct hid_device *hid)
1266 struct usbhid_device *usbhid = hid->driver_data;
1268 usb_autopm_put_interface(usbhid->intf);
1273 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1275 struct hid_device *hid = usb_get_intfdata(intf);
1276 struct usbhid_device *usbhid = hid->driver_data;
1279 if (message.event & PM_EVENT_AUTO) {
1280 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1281 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1282 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1283 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1284 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1285 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1286 && (!usbhid->ledcount || ignoreled))
1288 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1289 spin_unlock_irq(&usbhid->lock);
1291 usbhid_mark_busy(usbhid);
1292 spin_unlock_irq(&usbhid->lock);
1297 spin_lock_irq(&usbhid->lock);
1298 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1299 spin_unlock_irq(&usbhid->lock);
1300 if (usbhid_wait_io(hid) < 0)
1304 if (!ignoreled && (message.event & PM_EVENT_AUTO)) {
1305 spin_lock_irq(&usbhid->lock);
1306 if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1307 spin_unlock_irq(&usbhid->lock);
1308 usbhid_mark_busy(usbhid);
1311 spin_unlock_irq(&usbhid->lock);
1314 hid_cancel_delayed_stuff(usbhid);
1315 hid_cease_io(usbhid);
1317 if ((message.event & PM_EVENT_AUTO) &&
1318 test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1319 /* lost race against keypresses */
1320 status = hid_start_in(hid);
1323 usbhid_mark_busy(usbhid);
1326 dev_dbg(&intf->dev, "suspend\n");
1330 static int hid_resume(struct usb_interface *intf)
1332 struct hid_device *hid = usb_get_intfdata (intf);
1333 struct usbhid_device *usbhid = hid->driver_data;
1336 if (!test_bit(HID_STARTED, &usbhid->iofl))
1339 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1340 usbhid_mark_busy(usbhid);
1342 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1343 test_bit(HID_RESET_PENDING, &usbhid->iofl))
1344 schedule_work(&usbhid->reset_work);
1345 usbhid->retry_delay = 0;
1346 status = hid_start_in(hid);
1349 usbhid_restart_queues(usbhid);
1351 dev_dbg(&intf->dev, "resume status %d\n", status);
1355 static int hid_reset_resume(struct usb_interface *intf)
1357 struct hid_device *hid = usb_get_intfdata(intf);
1358 struct usbhid_device *usbhid = hid->driver_data;
1360 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1361 return hid_post_reset(intf);
1364 #endif /* CONFIG_PM */
1366 static const struct usb_device_id hid_usb_ids[] = {
1367 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1368 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1369 { } /* Terminating entry */
1372 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1374 static struct usb_driver hid_driver = {
1376 .probe = usbhid_probe,
1377 .disconnect = usbhid_disconnect,
1379 .suspend = hid_suspend,
1380 .resume = hid_resume,
1381 .reset_resume = hid_reset_resume,
1383 .pre_reset = hid_pre_reset,
1384 .post_reset = hid_post_reset,
1385 .id_table = hid_usb_ids,
1386 .supports_autosuspend = 1,
1389 static const struct hid_device_id hid_usb_table[] = {
1390 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1394 static struct hid_driver hid_usb_driver = {
1395 .name = "generic-usb",
1396 .id_table = hid_usb_table,
1399 static int __init hid_init(void)
1401 int retval = -ENOMEM;
1403 resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1404 if (!resumption_waker)
1406 retval = hid_register_driver(&hid_usb_driver);
1408 goto hid_register_fail;
1409 retval = usbhid_quirks_init(quirks_param);
1411 goto usbhid_quirks_init_fail;
1412 retval = hiddev_init();
1414 goto hiddev_init_fail;
1415 retval = usb_register(&hid_driver);
1417 goto usb_register_fail;
1418 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1424 usbhid_quirks_exit();
1425 usbhid_quirks_init_fail:
1426 hid_unregister_driver(&hid_usb_driver);
1428 destroy_workqueue(resumption_waker);
1433 static void __exit hid_exit(void)
1435 usb_deregister(&hid_driver);
1437 usbhid_quirks_exit();
1438 hid_unregister_driver(&hid_usb_driver);
1439 destroy_workqueue(resumption_waker);
1442 module_init(hid_init);
1443 module_exit(hid_exit);
1445 MODULE_AUTHOR("Andreas Gal");
1446 MODULE_AUTHOR("Vojtech Pavlik");
1447 MODULE_AUTHOR("Jiri Kosina");
1448 MODULE_DESCRIPTION(DRIVER_DESC);
1449 MODULE_LICENSE(DRIVER_LICENSE);