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
8 * Copyright (c) 2007-2008 Oliver Neukum
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/smp_lock.h>
26 #include <linux/spinlock.h>
27 #include <asm/unaligned.h>
28 #include <asm/byteorder.h>
29 #include <linux/input.h>
30 #include <linux/wait.h>
31 #include <linux/workqueue.h>
33 #include <linux/usb.h>
35 #include <linux/hid.h>
36 #include <linux/hiddev.h>
37 #include <linux/hid-debug.h>
38 #include <linux/hidraw.h>
45 #define DRIVER_VERSION "v2.6"
46 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
47 #define DRIVER_DESC "USB HID core driver"
48 #define DRIVER_LICENSE "GPL"
54 static unsigned int hid_mousepoll_interval;
55 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
56 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
58 static unsigned int ignoreled;
59 module_param_named(ignoreled, ignoreled, uint, 0644);
60 MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
62 /* Quirks specified at module load time */
63 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
64 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
65 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
66 " quirks=vendorID:productID:quirks"
67 " where vendorID, productID, and quirks are all in"
70 * Input submission and I/O error handler.
72 static DEFINE_MUTEX(hid_open_mut);
73 static struct workqueue_struct *resumption_waker;
75 static void hid_io_error(struct hid_device *hid);
76 static int hid_submit_out(struct hid_device *hid);
77 static int hid_submit_ctrl(struct hid_device *hid);
78 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
80 /* Start up the input URB */
81 static int hid_start_in(struct hid_device *hid)
85 struct usbhid_device *usbhid = hid->driver_data;
87 spin_lock_irqsave(&usbhid->lock, flags);
89 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
90 !test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
91 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
92 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
94 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
96 spin_unlock_irqrestore(&usbhid->lock, flags);
100 /* I/O retry timer routine */
101 static void hid_retry_timeout(unsigned long _hid)
103 struct hid_device *hid = (struct hid_device *) _hid;
104 struct usbhid_device *usbhid = hid->driver_data;
106 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
107 if (hid_start_in(hid))
111 /* Workqueue routine to reset the device or clear a halt */
112 static void hid_reset(struct work_struct *work)
114 struct usbhid_device *usbhid =
115 container_of(work, struct usbhid_device, reset_work);
116 struct hid_device *hid = usbhid->hid;
119 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
120 dev_dbg(&usbhid->intf->dev, "clear halt\n");
121 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
122 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
126 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
127 dev_dbg(&usbhid->intf->dev, "resetting device\n");
128 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
130 rc = usb_reset_device(hid_to_usb_dev(hid));
131 usb_unlock_device(hid_to_usb_dev(hid));
133 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
138 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
142 err_hid("can't reset device, %s-%s/input%d, status %d",
143 hid_to_usb_dev(hid)->bus->bus_name,
144 hid_to_usb_dev(hid)->devpath,
154 /* Main I/O error handler */
155 static void hid_io_error(struct hid_device *hid)
158 struct usbhid_device *usbhid = hid->driver_data;
160 spin_lock_irqsave(&usbhid->lock, flags);
162 /* Stop when disconnected */
163 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
166 /* If it has been a while since the last error, we'll assume
167 * this a brand new error and reset the retry timeout. */
168 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
169 usbhid->retry_delay = 0;
171 /* When an error occurs, retry at increasing intervals */
172 if (usbhid->retry_delay == 0) {
173 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
174 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
175 } else if (usbhid->retry_delay < 100)
176 usbhid->retry_delay *= 2;
178 if (time_after(jiffies, usbhid->stop_retry)) {
180 /* Retries failed, so do a port reset */
181 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
182 schedule_work(&usbhid->reset_work);
187 mod_timer(&usbhid->io_retry,
188 jiffies + msecs_to_jiffies(usbhid->retry_delay));
190 spin_unlock_irqrestore(&usbhid->lock, flags);
193 static void usbhid_mark_busy(struct usbhid_device *usbhid)
195 struct usb_interface *intf = usbhid->intf;
197 usb_mark_last_busy(interface_to_usbdev(intf));
200 static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
202 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
208 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
209 dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
210 if (hid_submit_out(hid)) {
211 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
212 wake_up(&usbhid->wait);
218 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
220 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
223 WARN_ON(hid == NULL);
227 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
228 dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
229 if (hid_submit_ctrl(hid)) {
230 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
231 wake_up(&usbhid->wait);
238 * Input interrupt completion handler.
241 static void hid_irq_in(struct urb *urb)
243 struct hid_device *hid = urb->context;
244 struct usbhid_device *usbhid = hid->driver_data;
247 switch (urb->status) {
248 case 0: /* success */
249 usbhid_mark_busy(usbhid);
250 usbhid->retry_delay = 0;
251 hid_input_report(urb->context, HID_INPUT_REPORT,
252 urb->transfer_buffer,
253 urb->actual_length, 1);
255 * autosuspend refused while keys are pressed
256 * because most keyboards don't wake up when
259 if (hid_check_keys_pressed(hid))
260 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
262 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
264 case -EPIPE: /* stall */
265 usbhid_mark_busy(usbhid);
266 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
267 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
268 schedule_work(&usbhid->reset_work);
270 case -ECONNRESET: /* unlink */
272 case -ESHUTDOWN: /* unplug */
273 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
275 case -EILSEQ: /* protocol error or unplug */
276 case -EPROTO: /* protocol error or unplug */
277 case -ETIME: /* protocol error or unplug */
278 case -ETIMEDOUT: /* Should never happen, but... */
279 usbhid_mark_busy(usbhid);
280 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
284 dev_warn(&urb->dev->dev, "input irq status %d "
285 "received\n", urb->status);
288 status = usb_submit_urb(urb, GFP_ATOMIC);
290 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
291 if (status != -EPERM) {
292 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
293 hid_to_usb_dev(hid)->bus->bus_name,
294 hid_to_usb_dev(hid)->devpath,
295 usbhid->ifnum, status);
301 static int hid_submit_out(struct hid_device *hid)
303 struct hid_report *report;
305 struct usbhid_device *usbhid = hid->driver_data;
307 report = usbhid->out[usbhid->outtail].report;
308 raw_report = usbhid->out[usbhid->outtail].raw_report;
310 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
311 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
312 usbhid->urbout->dev = hid_to_usb_dev(hid);
313 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
316 dbg_hid("submitting out urb\n");
318 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
319 err_hid("usb_submit_urb(out) failed");
324 * queue work to wake up the device.
325 * as the work queue is freezeable, this is safe
326 * with respect to STD and STR
328 queue_work(resumption_waker, &usbhid->restart_work);
334 static int hid_submit_ctrl(struct hid_device *hid)
336 struct hid_report *report;
340 struct usbhid_device *usbhid = hid->driver_data;
342 report = usbhid->ctrl[usbhid->ctrltail].report;
343 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
344 dir = usbhid->ctrl[usbhid->ctrltail].dir;
346 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
347 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
348 if (dir == USB_DIR_OUT) {
349 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
350 usbhid->urbctrl->transfer_buffer_length = len;
351 memcpy(usbhid->ctrlbuf, raw_report, len);
354 int maxpacket, padlen;
356 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
357 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
359 padlen = DIV_ROUND_UP(len, maxpacket);
361 if (padlen > usbhid->bufsize)
362 padlen = usbhid->bufsize;
365 usbhid->urbctrl->transfer_buffer_length = padlen;
367 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
369 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
370 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
371 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
372 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
373 usbhid->cr->wLength = cpu_to_le16(len);
375 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
376 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
377 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
379 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
380 err_hid("usb_submit_urb(ctrl) failed");
385 * queue work to wake up the device.
386 * as the work queue is freezeable, this is safe
387 * with respect to STD and STR
389 queue_work(resumption_waker, &usbhid->restart_work);
396 * Output interrupt completion handler.
399 static void hid_irq_out(struct urb *urb)
401 struct hid_device *hid = urb->context;
402 struct usbhid_device *usbhid = hid->driver_data;
406 switch (urb->status) {
407 case 0: /* success */
409 case -ESHUTDOWN: /* unplug */
411 case -EILSEQ: /* protocol error or unplug */
412 case -EPROTO: /* protocol error or unplug */
413 case -ECONNRESET: /* unlink */
417 dev_warn(&urb->dev->dev, "output irq status %d "
418 "received\n", urb->status);
421 spin_lock_irqsave(&usbhid->lock, flags);
424 usbhid->outtail = usbhid->outhead;
426 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
428 if (usbhid->outhead != usbhid->outtail) {
429 if (hid_submit_out(hid)) {
430 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
431 wake_up(&usbhid->wait);
433 spin_unlock_irqrestore(&usbhid->lock, flags);
437 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
438 spin_unlock_irqrestore(&usbhid->lock, flags);
439 wake_up(&usbhid->wait);
443 * Control pipe completion handler.
446 static void hid_ctrl(struct urb *urb)
448 struct hid_device *hid = urb->context;
449 struct usbhid_device *usbhid = hid->driver_data;
450 int unplug = 0, status = urb->status;
452 spin_lock(&usbhid->lock);
455 case 0: /* success */
456 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
457 hid_input_report(urb->context,
458 usbhid->ctrl[usbhid->ctrltail].report->type,
459 urb->transfer_buffer, urb->actual_length, 0);
461 case -ESHUTDOWN: /* unplug */
463 case -EILSEQ: /* protocol error or unplug */
464 case -EPROTO: /* protocol error or unplug */
465 case -ECONNRESET: /* unlink */
467 case -EPIPE: /* report not available */
470 dev_warn(&urb->dev->dev, "ctrl urb status %d "
471 "received\n", status);
475 usbhid->ctrltail = usbhid->ctrlhead;
477 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
479 if (usbhid->ctrlhead != usbhid->ctrltail) {
480 if (hid_submit_ctrl(hid)) {
481 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
482 wake_up(&usbhid->wait);
484 spin_unlock(&usbhid->lock);
488 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
489 spin_unlock(&usbhid->lock);
490 wake_up(&usbhid->wait);
493 void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
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);
523 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
524 dev_warn(&hid->dev, "control queue full\n");
528 if (dir == USB_DIR_OUT) {
529 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
530 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
531 dev_warn(&hid->dev, "control queueing failed\n");
534 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
536 usbhid->ctrl[usbhid->ctrlhead].report = report;
537 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
538 usbhid->ctrlhead = head;
540 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
541 if (hid_submit_ctrl(hid))
542 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
545 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
547 struct usbhid_device *usbhid = hid->driver_data;
550 spin_lock_irqsave(&usbhid->lock, flags);
551 __usbhid_submit_report(hid, report, dir);
552 spin_unlock_irqrestore(&usbhid->lock, flags);
554 EXPORT_SYMBOL_GPL(usbhid_submit_report);
556 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
558 struct hid_device *hid = input_get_drvdata(dev);
559 struct usbhid_device *usbhid = hid->driver_data;
560 struct hid_field *field;
565 return input_ff_event(dev, type, code, value);
570 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
571 dev_warn(&dev->dev, "event field not found\n");
575 hid_set_field(field, offset, value);
577 spin_lock_irqsave(&usbhid->lock, flags);
579 spin_unlock_irqrestore(&usbhid->lock, flags);
581 spin_lock_irqsave(&usbhid->lock, flags);
583 spin_unlock_irqrestore(&usbhid->lock, flags);
585 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
590 int usbhid_wait_io(struct hid_device *hid)
592 struct usbhid_device *usbhid = hid->driver_data;
594 if (!wait_event_timeout(usbhid->wait,
595 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
596 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
598 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
605 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
607 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
608 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
609 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
612 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
613 unsigned char type, void *buf, int size)
615 int result, retries = 4;
617 memset(buf, 0, size);
620 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
621 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
622 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
624 } while (result < size && retries);
628 int usbhid_open(struct hid_device *hid)
630 struct usbhid_device *usbhid = hid->driver_data;
633 mutex_lock(&hid_open_mut);
635 res = usb_autopm_get_interface(usbhid->intf);
636 /* the device must be awake to reliable request remote wakeup */
639 mutex_unlock(&hid_open_mut);
642 usbhid->intf->needs_remote_wakeup = 1;
643 if (hid_start_in(hid))
646 usb_autopm_put_interface(usbhid->intf);
648 mutex_unlock(&hid_open_mut);
652 void usbhid_close(struct hid_device *hid)
654 struct usbhid_device *usbhid = hid->driver_data;
656 mutex_lock(&hid_open_mut);
658 /* protecting hid->open to make sure we don't restart
659 * data acquistion due to a resumption we no longer
662 spin_lock_irq(&usbhid->lock);
664 spin_unlock_irq(&usbhid->lock);
665 hid_cancel_delayed_stuff(usbhid);
666 usb_kill_urb(usbhid->urbin);
667 usbhid->intf->needs_remote_wakeup = 0;
669 spin_unlock_irq(&usbhid->lock);
671 mutex_unlock(&hid_open_mut);
675 * Initialize all reports
678 void usbhid_init_reports(struct hid_device *hid)
680 struct hid_report *report;
681 struct usbhid_device *usbhid = hid->driver_data;
684 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
685 usbhid_submit_report(hid, report, USB_DIR_IN);
687 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
688 usbhid_submit_report(hid, report, USB_DIR_IN);
691 ret = usbhid_wait_io(hid);
694 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
695 usb_kill_urb(usbhid->urbctrl);
696 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
697 usb_kill_urb(usbhid->urbout);
698 ret = usbhid_wait_io(hid);
702 dev_warn(&hid->dev, "timeout initializing reports\n");
706 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
708 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
709 unsigned int hid_code, struct hid_field **pfield)
711 struct hid_report *report;
712 struct hid_field *field;
713 struct hid_usage *usage;
716 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
717 for (i = 0; i < report->maxfield; i++) {
718 field = report->field[i];
719 for (j = 0; j < field->maxusage; j++) {
720 usage = &field->usage[j];
721 if ((usage->hid & HID_USAGE_PAGE) == page &&
722 (usage->hid & 0xFFFF) == hid_code) {
732 void usbhid_set_leds(struct hid_device *hid)
734 struct hid_field *field;
737 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
738 hid_set_field(field, offset, 0);
739 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
742 EXPORT_SYMBOL_GPL(usbhid_set_leds);
745 * Traverse the supplied list of reports and find the longest
747 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
750 struct hid_report *report;
753 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
754 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
760 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
762 struct usbhid_device *usbhid = hid->driver_data;
764 usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
766 usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
767 &usbhid->outbuf_dma);
768 usbhid->cr = usb_buffer_alloc(dev, sizeof(*usbhid->cr), GFP_KERNEL,
770 usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
771 &usbhid->ctrlbuf_dma);
772 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
779 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
781 struct usbhid_device *usbhid = hid->driver_data;
782 struct usb_device *dev = hid_to_usb_dev(hid);
783 struct usb_interface *intf = usbhid->intf;
784 struct usb_host_interface *interface = intf->cur_altsetting;
787 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
789 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
790 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
791 interface->desc.bInterfaceNumber, buf + 1, count - 1,
792 USB_CTRL_SET_TIMEOUT);
794 /* count also the report id */
801 static void usbhid_restart_queues(struct usbhid_device *usbhid)
804 usbhid_restart_out_queue(usbhid);
805 usbhid_restart_ctrl_queue(usbhid);
808 static void __usbhid_restart_queues(struct work_struct *work)
810 struct usbhid_device *usbhid =
811 container_of(work, struct usbhid_device, restart_work);
814 r = usb_autopm_get_interface(usbhid->intf);
817 usb_autopm_put_interface(usbhid->intf);
820 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
822 struct usbhid_device *usbhid = hid->driver_data;
824 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
825 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
826 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
827 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
830 static int usbhid_parse(struct hid_device *hid)
832 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
833 struct usb_host_interface *interface = intf->cur_altsetting;
834 struct usb_device *dev = interface_to_usbdev (intf);
835 struct hid_descriptor *hdesc;
837 unsigned int rsize = 0;
841 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
842 le16_to_cpu(dev->descriptor.idProduct));
844 if (quirks & HID_QUIRK_IGNORE)
847 /* Many keyboards and mice don't like to be polled for reports,
848 * so we will always set the HID_QUIRK_NOGET flag for them. */
849 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
850 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
851 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
852 quirks |= HID_QUIRK_NOGET;
855 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
856 (!interface->desc.bNumEndpoints ||
857 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
858 dbg_hid("class descriptor not present\n");
862 hid->version = le16_to_cpu(hdesc->bcdHID);
863 hid->country = hdesc->bCountryCode;
865 for (n = 0; n < hdesc->bNumDescriptors; n++)
866 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
867 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
869 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
870 dbg_hid("weird size of report descriptor (%u)\n", rsize);
874 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
875 dbg_hid("couldn't allocate rdesc memory\n");
879 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
881 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
882 HID_DT_REPORT, rdesc, rsize);
884 dbg_hid("reading report descriptor failed\n");
889 dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
890 for (n = 0; n < rsize; n++)
891 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
894 ret = hid_parse_report(hid, rdesc, rsize);
897 dbg_hid("parsing report descriptor failed\n");
901 hid->quirks = quirks;
908 static int usbhid_start(struct hid_device *hid)
910 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
911 struct usb_host_interface *interface = intf->cur_altsetting;
912 struct usb_device *dev = interface_to_usbdev(intf);
913 struct usbhid_device *usbhid = hid->driver_data;
914 unsigned int n, insize = 0;
917 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
919 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
920 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
921 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
922 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
924 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
925 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
927 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
929 if (insize > HID_MAX_BUFFER_SIZE)
930 insize = HID_MAX_BUFFER_SIZE;
932 if (hid_alloc_buffers(dev, hid)) {
937 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
938 struct usb_endpoint_descriptor *endpoint;
942 endpoint = &interface->endpoint[n].desc;
943 if (!usb_endpoint_xfer_int(endpoint))
946 interval = endpoint->bInterval;
948 /* Some vendors give fullspeed interval on highspeed devides */
949 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
950 dev->speed == USB_SPEED_HIGH) {
951 interval = fls(endpoint->bInterval*8);
952 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
953 hid->name, endpoint->bInterval, interval);
956 /* Change the polling interval of mice. */
957 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
958 interval = hid_mousepoll_interval;
961 if (usb_endpoint_dir_in(endpoint)) {
964 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
966 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
967 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
968 hid_irq_in, hid, interval);
969 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
970 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
974 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
976 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
977 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
978 hid_irq_out, hid, interval);
979 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
980 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
984 init_waitqueue_head(&usbhid->wait);
985 INIT_WORK(&usbhid->reset_work, hid_reset);
986 INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
987 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
989 spin_lock_init(&usbhid->lock);
990 spin_lock_init(&usbhid->lock);
993 usbhid->ifnum = interface->desc.bInterfaceNumber;
995 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
996 if (!usbhid->urbctrl) {
1001 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1002 usbhid->ctrlbuf, 1, hid_ctrl, hid);
1003 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
1004 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1005 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
1007 usbhid_init_reports(hid);
1008 hid_dump_device(hid);
1010 set_bit(HID_STARTED, &usbhid->iofl);
1012 /* Some keyboards don't work until their LEDs have been set.
1013 * Since BIOSes do set the LEDs, it must be safe for any device
1014 * that supports the keyboard boot protocol.
1016 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1017 interface->desc.bInterfaceProtocol ==
1018 USB_INTERFACE_PROTOCOL_KEYBOARD)
1019 usbhid_set_leds(hid);
1024 usb_free_urb(usbhid->urbin);
1025 usb_free_urb(usbhid->urbout);
1026 usb_free_urb(usbhid->urbctrl);
1027 usbhid->urbin = NULL;
1028 usbhid->urbout = NULL;
1029 usbhid->urbctrl = NULL;
1030 hid_free_buffers(dev, hid);
1034 static void usbhid_stop(struct hid_device *hid)
1036 struct usbhid_device *usbhid = hid->driver_data;
1038 if (WARN_ON(!usbhid))
1041 clear_bit(HID_STARTED, &usbhid->iofl);
1042 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1043 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1044 spin_unlock_irq(&usbhid->lock);
1045 usb_kill_urb(usbhid->urbin);
1046 usb_kill_urb(usbhid->urbout);
1047 usb_kill_urb(usbhid->urbctrl);
1049 hid_cancel_delayed_stuff(usbhid);
1051 if (hid->claimed & HID_CLAIMED_INPUT)
1052 hidinput_disconnect(hid);
1053 if (hid->claimed & HID_CLAIMED_HIDDEV)
1054 hiddev_disconnect(hid);
1055 if (hid->claimed & HID_CLAIMED_HIDRAW)
1056 hidraw_disconnect(hid);
1060 usb_free_urb(usbhid->urbin);
1061 usb_free_urb(usbhid->urbctrl);
1062 usb_free_urb(usbhid->urbout);
1063 usbhid->urbin = NULL; /* don't mess up next start */
1064 usbhid->urbctrl = NULL;
1065 usbhid->urbout = NULL;
1067 hid_free_buffers(hid_to_usb_dev(hid), hid);
1070 static int usbhid_power(struct hid_device *hid, int lvl)
1075 case PM_HINT_FULLON:
1076 r = usbhid_get_power(hid);
1078 case PM_HINT_NORMAL:
1079 usbhid_put_power(hid);
1085 static struct hid_ll_driver usb_hid_driver = {
1086 .parse = usbhid_parse,
1087 .start = usbhid_start,
1088 .stop = usbhid_stop,
1089 .open = usbhid_open,
1090 .close = usbhid_close,
1091 .power = usbhid_power,
1092 .hidinput_input_event = usb_hidinput_input_event,
1095 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1097 struct usb_host_interface *interface = intf->cur_altsetting;
1098 struct usb_device *dev = interface_to_usbdev(intf);
1099 struct usbhid_device *usbhid;
1100 struct hid_device *hid;
1101 unsigned int n, has_in = 0;
1105 dbg_hid("HID probe called for ifnum %d\n",
1106 intf->altsetting->desc.bInterfaceNumber);
1108 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1109 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1112 dev_err(&intf->dev, "couldn't find an input interrupt "
1117 hid = hid_allocate_device();
1119 return PTR_ERR(hid);
1121 usb_set_intfdata(intf, hid);
1122 hid->ll_driver = &usb_hid_driver;
1123 hid->hid_output_raw_report = usbhid_output_raw_report;
1124 hid->ff_init = hid_pidff_init;
1125 #ifdef CONFIG_USB_HIDDEV
1126 hid->hiddev_connect = hiddev_connect;
1127 hid->hiddev_hid_event = hiddev_hid_event;
1128 hid->hiddev_report_event = hiddev_report_event;
1130 hid->dev.parent = &intf->dev;
1132 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1133 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1135 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1136 USB_INTERFACE_PROTOCOL_MOUSE)
1137 hid->type = HID_TYPE_USBMOUSE;
1139 if (dev->manufacturer)
1140 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1143 if (dev->manufacturer)
1144 strlcat(hid->name, " ", sizeof(hid->name));
1145 strlcat(hid->name, dev->product, sizeof(hid->name));
1148 if (!strlen(hid->name))
1149 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1150 le16_to_cpu(dev->descriptor.idVendor),
1151 le16_to_cpu(dev->descriptor.idProduct));
1153 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1154 strlcat(hid->phys, "/input", sizeof(hid->phys));
1155 len = strlen(hid->phys);
1156 if (len < sizeof(hid->phys) - 1)
1157 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1158 "%d", intf->altsetting[0].desc.bInterfaceNumber);
1160 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1163 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1164 if (usbhid == NULL) {
1169 hid->driver_data = usbhid;
1172 ret = hid_add_device(hid);
1175 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1183 hid_destroy_device(hid);
1187 static void hid_disconnect(struct usb_interface *intf)
1189 struct hid_device *hid = usb_get_intfdata(intf);
1190 struct usbhid_device *usbhid;
1195 usbhid = hid->driver_data;
1196 hid_destroy_device(hid);
1200 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1202 del_timer_sync(&usbhid->io_retry);
1203 cancel_work_sync(&usbhid->restart_work);
1204 cancel_work_sync(&usbhid->reset_work);
1207 static void hid_cease_io(struct usbhid_device *usbhid)
1209 del_timer(&usbhid->io_retry);
1210 usb_kill_urb(usbhid->urbin);
1211 usb_kill_urb(usbhid->urbctrl);
1212 usb_kill_urb(usbhid->urbout);
1215 /* Treat USB reset pretty much the same as suspend/resume */
1216 static int hid_pre_reset(struct usb_interface *intf)
1218 struct hid_device *hid = usb_get_intfdata(intf);
1219 struct usbhid_device *usbhid = hid->driver_data;
1221 spin_lock_irq(&usbhid->lock);
1222 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1223 spin_unlock_irq(&usbhid->lock);
1224 cancel_work_sync(&usbhid->restart_work);
1225 hid_cease_io(usbhid);
1230 /* Same routine used for post_reset and reset_resume */
1231 static int hid_post_reset(struct usb_interface *intf)
1233 struct usb_device *dev = interface_to_usbdev (intf);
1234 struct hid_device *hid = usb_get_intfdata(intf);
1235 struct usbhid_device *usbhid = hid->driver_data;
1238 spin_lock_irq(&usbhid->lock);
1239 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1240 spin_unlock_irq(&usbhid->lock);
1241 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1242 /* FIXME: Any more reinitialization needed? */
1243 status = hid_start_in(hid);
1246 usbhid_restart_queues(usbhid);
1251 int usbhid_get_power(struct hid_device *hid)
1253 struct usbhid_device *usbhid = hid->driver_data;
1255 return usb_autopm_get_interface(usbhid->intf);
1258 void usbhid_put_power(struct hid_device *hid)
1260 struct usbhid_device *usbhid = hid->driver_data;
1262 usb_autopm_put_interface(usbhid->intf);
1267 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1269 struct hid_device *hid = usb_get_intfdata(intf);
1270 struct usbhid_device *usbhid = hid->driver_data;
1271 struct usb_device *udev = interface_to_usbdev(intf);
1274 if (udev->auto_pm) {
1275 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1276 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1277 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1278 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1279 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1280 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1281 && (!usbhid->ledcount || ignoreled))
1283 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1284 spin_unlock_irq(&usbhid->lock);
1286 usbhid_mark_busy(usbhid);
1287 spin_unlock_irq(&usbhid->lock);
1292 spin_lock_irq(&usbhid->lock);
1293 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1294 spin_unlock_irq(&usbhid->lock);
1295 if (usbhid_wait_io(hid) < 0)
1299 if (!ignoreled && udev->auto_pm) {
1300 spin_lock_irq(&usbhid->lock);
1301 if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1302 spin_unlock_irq(&usbhid->lock);
1303 usbhid_mark_busy(usbhid);
1306 spin_unlock_irq(&usbhid->lock);
1309 hid_cancel_delayed_stuff(usbhid);
1310 hid_cease_io(usbhid);
1312 if (udev->auto_pm && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1313 /* lost race against keypresses */
1314 status = hid_start_in(hid);
1317 usbhid_mark_busy(usbhid);
1320 dev_dbg(&intf->dev, "suspend\n");
1324 static int hid_resume(struct usb_interface *intf)
1326 struct hid_device *hid = usb_get_intfdata (intf);
1327 struct usbhid_device *usbhid = hid->driver_data;
1330 if (!test_bit(HID_STARTED, &usbhid->iofl))
1333 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1334 usbhid_mark_busy(usbhid);
1336 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1337 test_bit(HID_RESET_PENDING, &usbhid->iofl))
1338 schedule_work(&usbhid->reset_work);
1339 usbhid->retry_delay = 0;
1340 status = hid_start_in(hid);
1343 usbhid_restart_queues(usbhid);
1345 dev_dbg(&intf->dev, "resume status %d\n", status);
1349 static int hid_reset_resume(struct usb_interface *intf)
1351 struct hid_device *hid = usb_get_intfdata(intf);
1352 struct usbhid_device *usbhid = hid->driver_data;
1354 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1355 return hid_post_reset(intf);
1358 #endif /* CONFIG_PM */
1360 static struct usb_device_id hid_usb_ids [] = {
1361 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1362 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1363 { } /* Terminating entry */
1366 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1368 static struct usb_driver hid_driver = {
1371 .disconnect = hid_disconnect,
1373 .suspend = hid_suspend,
1374 .resume = hid_resume,
1375 .reset_resume = hid_reset_resume,
1377 .pre_reset = hid_pre_reset,
1378 .post_reset = hid_post_reset,
1379 .id_table = hid_usb_ids,
1380 .supports_autosuspend = 1,
1383 static const struct hid_device_id hid_usb_table[] = {
1384 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1388 static struct hid_driver hid_usb_driver = {
1389 .name = "generic-usb",
1390 .id_table = hid_usb_table,
1393 static int __init hid_init(void)
1395 int retval = -ENOMEM;
1397 resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1398 if (!resumption_waker)
1400 retval = hid_register_driver(&hid_usb_driver);
1402 goto hid_register_fail;
1403 retval = usbhid_quirks_init(quirks_param);
1405 goto usbhid_quirks_init_fail;
1406 retval = hiddev_init();
1408 goto hiddev_init_fail;
1409 retval = usb_register(&hid_driver);
1411 goto usb_register_fail;
1412 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1419 usbhid_quirks_exit();
1420 usbhid_quirks_init_fail:
1421 hid_unregister_driver(&hid_usb_driver);
1423 destroy_workqueue(resumption_waker);
1428 static void __exit hid_exit(void)
1430 usb_deregister(&hid_driver);
1432 usbhid_quirks_exit();
1433 hid_unregister_driver(&hid_usb_driver);
1434 destroy_workqueue(resumption_waker);
1437 module_init(hid_init);
1438 module_exit(hid_exit);
1440 MODULE_AUTHOR(DRIVER_AUTHOR);
1441 MODULE_DESCRIPTION(DRIVER_DESC);
1442 MODULE_LICENSE(DRIVER_LICENSE);