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"
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 /* Quirks specified at module load time */
56 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
57 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
58 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
59 " quirks=vendorID:productID:quirks"
60 " where vendorID, productID, and quirks are all in"
63 * Input submission and I/O error handler.
66 static void hid_io_error(struct hid_device *hid);
68 /* Start up the input URB */
69 static int hid_start_in(struct hid_device *hid)
73 struct usbhid_device *usbhid = hid->driver_data;
75 spin_lock_irqsave(&usbhid->inlock, flags);
76 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
77 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
78 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
79 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
81 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
83 spin_unlock_irqrestore(&usbhid->inlock, flags);
87 /* I/O retry timer routine */
88 static void hid_retry_timeout(unsigned long _hid)
90 struct hid_device *hid = (struct hid_device *) _hid;
91 struct usbhid_device *usbhid = hid->driver_data;
93 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
94 if (hid_start_in(hid))
98 /* Workqueue routine to reset the device or clear a halt */
99 static void hid_reset(struct work_struct *work)
101 struct usbhid_device *usbhid =
102 container_of(work, struct usbhid_device, reset_work);
103 struct hid_device *hid = usbhid->hid;
106 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
107 dev_dbg(&usbhid->intf->dev, "clear halt\n");
108 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
109 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
113 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
114 dev_dbg(&usbhid->intf->dev, "resetting device\n");
115 rc = rc_lock = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
117 rc = usb_reset_device(hid_to_usb_dev(hid));
119 usb_unlock_device(hid_to_usb_dev(hid));
121 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
126 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
130 err_hid("can't reset device, %s-%s/input%d, status %d",
131 hid_to_usb_dev(hid)->bus->bus_name,
132 hid_to_usb_dev(hid)->devpath,
142 /* Main I/O error handler */
143 static void hid_io_error(struct hid_device *hid)
146 struct usbhid_device *usbhid = hid->driver_data;
148 spin_lock_irqsave(&usbhid->inlock, flags);
150 /* Stop when disconnected */
151 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
154 /* If it has been a while since the last error, we'll assume
155 * this a brand new error and reset the retry timeout. */
156 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
157 usbhid->retry_delay = 0;
159 /* When an error occurs, retry at increasing intervals */
160 if (usbhid->retry_delay == 0) {
161 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
162 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
163 } else if (usbhid->retry_delay < 100)
164 usbhid->retry_delay *= 2;
166 if (time_after(jiffies, usbhid->stop_retry)) {
168 /* Retries failed, so do a port reset */
169 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
170 schedule_work(&usbhid->reset_work);
175 mod_timer(&usbhid->io_retry,
176 jiffies + msecs_to_jiffies(usbhid->retry_delay));
178 spin_unlock_irqrestore(&usbhid->inlock, flags);
182 * Input interrupt completion handler.
185 static void hid_irq_in(struct urb *urb)
187 struct hid_device *hid = urb->context;
188 struct usbhid_device *usbhid = hid->driver_data;
191 switch (urb->status) {
192 case 0: /* success */
193 usbhid->retry_delay = 0;
194 hid_input_report(urb->context, HID_INPUT_REPORT,
195 urb->transfer_buffer,
196 urb->actual_length, 1);
198 case -EPIPE: /* stall */
199 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
200 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
201 schedule_work(&usbhid->reset_work);
203 case -ECONNRESET: /* unlink */
205 case -ESHUTDOWN: /* unplug */
206 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
208 case -EILSEQ: /* protocol error or unplug */
209 case -EPROTO: /* protocol error or unplug */
210 case -ETIME: /* protocol error or unplug */
211 case -ETIMEDOUT: /* Should never happen, but... */
212 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
216 warn("input irq status %d received", urb->status);
219 status = usb_submit_urb(urb, GFP_ATOMIC);
221 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
222 if (status != -EPERM) {
223 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
224 hid_to_usb_dev(hid)->bus->bus_name,
225 hid_to_usb_dev(hid)->devpath,
226 usbhid->ifnum, status);
232 static int hid_submit_out(struct hid_device *hid)
234 struct hid_report *report;
235 struct usbhid_device *usbhid = hid->driver_data;
237 report = usbhid->out[usbhid->outtail];
239 hid_output_report(report, usbhid->outbuf);
240 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
241 usbhid->urbout->dev = hid_to_usb_dev(hid);
243 dbg_hid("submitting out urb\n");
245 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
246 err_hid("usb_submit_urb(out) failed");
253 static int hid_submit_ctrl(struct hid_device *hid)
255 struct hid_report *report;
258 struct usbhid_device *usbhid = hid->driver_data;
260 report = usbhid->ctrl[usbhid->ctrltail].report;
261 dir = usbhid->ctrl[usbhid->ctrltail].dir;
263 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
264 if (dir == USB_DIR_OUT) {
265 hid_output_report(report, usbhid->ctrlbuf);
266 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
267 usbhid->urbctrl->transfer_buffer_length = len;
269 int maxpacket, padlen;
271 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
272 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
274 padlen = DIV_ROUND_UP(len, maxpacket);
276 if (padlen > usbhid->bufsize)
277 padlen = usbhid->bufsize;
280 usbhid->urbctrl->transfer_buffer_length = padlen;
282 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
284 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
285 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
286 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
287 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
288 usbhid->cr->wLength = cpu_to_le16(len);
290 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
291 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
292 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
294 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
295 err_hid("usb_submit_urb(ctrl) failed");
303 * Output interrupt completion handler.
306 static void hid_irq_out(struct urb *urb)
308 struct hid_device *hid = urb->context;
309 struct usbhid_device *usbhid = hid->driver_data;
313 switch (urb->status) {
314 case 0: /* success */
316 case -ESHUTDOWN: /* unplug */
318 case -EILSEQ: /* protocol error or unplug */
319 case -EPROTO: /* protocol error or unplug */
320 case -ECONNRESET: /* unlink */
324 warn("output irq status %d received", urb->status);
327 spin_lock_irqsave(&usbhid->outlock, flags);
330 usbhid->outtail = usbhid->outhead;
332 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
334 if (usbhid->outhead != usbhid->outtail) {
335 if (hid_submit_out(hid)) {
336 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
337 wake_up(&usbhid->wait);
339 spin_unlock_irqrestore(&usbhid->outlock, flags);
343 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
344 spin_unlock_irqrestore(&usbhid->outlock, flags);
345 wake_up(&usbhid->wait);
349 * Control pipe completion handler.
352 static void hid_ctrl(struct urb *urb)
354 struct hid_device *hid = urb->context;
355 struct usbhid_device *usbhid = hid->driver_data;
359 spin_lock_irqsave(&usbhid->ctrllock, flags);
361 switch (urb->status) {
362 case 0: /* success */
363 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
364 hid_input_report(urb->context,
365 usbhid->ctrl[usbhid->ctrltail].report->type,
366 urb->transfer_buffer, urb->actual_length, 0);
368 case -ESHUTDOWN: /* unplug */
370 case -EILSEQ: /* protocol error or unplug */
371 case -EPROTO: /* protocol error or unplug */
372 case -ECONNRESET: /* unlink */
374 case -EPIPE: /* report not available */
377 warn("ctrl urb status %d received", urb->status);
381 usbhid->ctrltail = usbhid->ctrlhead;
383 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
385 if (usbhid->ctrlhead != usbhid->ctrltail) {
386 if (hid_submit_ctrl(hid)) {
387 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
388 wake_up(&usbhid->wait);
390 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
394 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
395 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
396 wake_up(&usbhid->wait);
399 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
403 struct usbhid_device *usbhid = hid->driver_data;
405 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
408 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
410 spin_lock_irqsave(&usbhid->outlock, flags);
412 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
413 spin_unlock_irqrestore(&usbhid->outlock, flags);
414 warn("output queue full");
418 usbhid->out[usbhid->outhead] = report;
419 usbhid->outhead = head;
421 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
422 if (hid_submit_out(hid))
423 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
425 spin_unlock_irqrestore(&usbhid->outlock, flags);
429 spin_lock_irqsave(&usbhid->ctrllock, flags);
431 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
432 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
433 warn("control queue full");
437 usbhid->ctrl[usbhid->ctrlhead].report = report;
438 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
439 usbhid->ctrlhead = head;
441 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
442 if (hid_submit_ctrl(hid))
443 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
445 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
448 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
450 struct hid_device *hid = input_get_drvdata(dev);
451 struct hid_field *field;
455 return input_ff_event(dev, type, code, value);
460 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
461 warn("event field not found");
465 hid_set_field(field, offset, value);
466 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
471 int usbhid_wait_io(struct hid_device *hid)
473 struct usbhid_device *usbhid = hid->driver_data;
475 if (!wait_event_timeout(usbhid->wait,
476 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
477 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
479 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
486 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
488 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
489 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
490 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
493 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
494 unsigned char type, void *buf, int size)
496 int result, retries = 4;
498 memset(buf, 0, size);
501 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
502 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
503 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
505 } while (result < size && retries);
509 int usbhid_open(struct hid_device *hid)
511 struct usbhid_device *usbhid = hid->driver_data;
515 res = usb_autopm_get_interface(usbhid->intf);
521 if (hid_start_in(hid))
526 void usbhid_close(struct hid_device *hid)
528 struct usbhid_device *usbhid = hid->driver_data;
531 usb_kill_urb(usbhid->urbin);
532 usb_autopm_put_interface(usbhid->intf);
537 * Initialize all reports
540 void usbhid_init_reports(struct hid_device *hid)
542 struct hid_report *report;
543 struct usbhid_device *usbhid = hid->driver_data;
546 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
547 usbhid_submit_report(hid, report, USB_DIR_IN);
549 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
550 usbhid_submit_report(hid, report, USB_DIR_IN);
553 ret = usbhid_wait_io(hid);
556 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
557 usb_kill_urb(usbhid->urbctrl);
558 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
559 usb_kill_urb(usbhid->urbout);
560 ret = usbhid_wait_io(hid);
564 warn("timeout initializing reports");
568 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
570 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
571 unsigned int hid_code, struct hid_field **pfield)
573 struct hid_report *report;
574 struct hid_field *field;
575 struct hid_usage *usage;
578 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
579 for (i = 0; i < report->maxfield; i++) {
580 field = report->field[i];
581 for (j = 0; j < field->maxusage; j++) {
582 usage = &field->usage[j];
583 if ((usage->hid & HID_USAGE_PAGE) == page &&
584 (usage->hid & 0xFFFF) == hid_code) {
594 void usbhid_set_leds(struct hid_device *hid)
596 struct hid_field *field;
599 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
600 hid_set_field(field, offset, 0);
601 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
604 EXPORT_SYMBOL_GPL(usbhid_set_leds);
607 * Traverse the supplied list of reports and find the longest
609 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
612 struct hid_report *report;
615 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
616 size = ((report->size - 1) >> 3) + 1;
617 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
624 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
626 struct usbhid_device *usbhid = hid->driver_data;
628 if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
630 if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
632 if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
634 if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
640 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
642 struct usbhid_device *usbhid = hid->driver_data;
643 struct usb_device *dev = hid_to_usb_dev(hid);
644 struct usb_interface *intf = usbhid->intf;
645 struct usb_host_interface *interface = intf->cur_altsetting;
648 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
650 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
651 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
652 interface->desc.bInterfaceNumber, buf + 1, count - 1,
653 USB_CTRL_SET_TIMEOUT);
655 /* count also the report id */
662 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
664 struct usbhid_device *usbhid = hid->driver_data;
666 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
667 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
668 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
669 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
672 static int usbhid_parse(struct hid_device *hid)
674 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
675 struct usb_host_interface *interface = intf->cur_altsetting;
676 struct usb_device *dev = interface_to_usbdev (intf);
677 struct hid_descriptor *hdesc;
679 unsigned int rsize = 0;
683 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
684 le16_to_cpu(dev->descriptor.idProduct));
686 /* Many keyboards and mice don't like to be polled for reports,
687 * so we will always set the HID_QUIRK_NOGET flag for them. */
688 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
689 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
690 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
691 quirks |= HID_QUIRK_NOGET;
694 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
695 (!interface->desc.bNumEndpoints ||
696 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
697 dbg_hid("class descriptor not present\n");
701 hid->version = le16_to_cpu(hdesc->bcdHID);
702 hid->country = hdesc->bCountryCode;
704 for (n = 0; n < hdesc->bNumDescriptors; n++)
705 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
706 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
708 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
709 dbg_hid("weird size of report descriptor (%u)\n", rsize);
713 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
714 dbg_hid("couldn't allocate rdesc memory\n");
718 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
720 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
721 HID_DT_REPORT, rdesc, rsize);
723 dbg_hid("reading report descriptor failed\n");
728 dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
729 for (n = 0; n < rsize; n++)
730 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
733 ret = hid_parse_report(hid, rdesc, rsize);
736 dbg_hid("parsing report descriptor failed\n");
740 hid->quirks = quirks;
747 static int usbhid_start(struct hid_device *hid)
749 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
750 struct usb_host_interface *interface = intf->cur_altsetting;
751 struct usb_device *dev = interface_to_usbdev(intf);
752 struct usbhid_device *usbhid;
753 unsigned int n, insize = 0;
756 WARN_ON(hid->driver_data);
758 usbhid = kzalloc(sizeof(struct usbhid_device), GFP_KERNEL);
759 if (usbhid == NULL) {
764 hid->driver_data = usbhid;
767 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
768 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
769 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
770 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
772 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
773 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
775 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
777 if (insize > HID_MAX_BUFFER_SIZE)
778 insize = HID_MAX_BUFFER_SIZE;
780 if (hid_alloc_buffers(dev, hid)) {
785 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
786 struct usb_endpoint_descriptor *endpoint;
790 endpoint = &interface->endpoint[n].desc;
791 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
794 interval = endpoint->bInterval;
796 /* Some vendors give fullspeed interval on highspeed devides */
797 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
798 dev->speed == USB_SPEED_HIGH) {
799 interval = fls(endpoint->bInterval*8);
800 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
801 hid->name, endpoint->bInterval, interval);
804 /* Change the polling interval of mice. */
805 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
806 interval = hid_mousepoll_interval;
809 if (usb_endpoint_dir_in(endpoint)) {
812 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
814 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
815 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
816 hid_irq_in, hid, interval);
817 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
818 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
822 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
824 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
825 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
826 hid_irq_out, hid, interval);
827 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
828 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
832 if (!usbhid->urbin) {
833 err_hid("couldn't find an input interrupt endpoint");
838 init_waitqueue_head(&usbhid->wait);
839 INIT_WORK(&usbhid->reset_work, hid_reset);
840 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
842 spin_lock_init(&usbhid->inlock);
843 spin_lock_init(&usbhid->outlock);
844 spin_lock_init(&usbhid->ctrllock);
847 usbhid->ifnum = interface->desc.bInterfaceNumber;
849 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
850 if (!usbhid->urbctrl) {
855 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
856 usbhid->ctrlbuf, 1, hid_ctrl, hid);
857 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
858 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
859 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
861 usbhid_init_reports(hid);
862 hid_dump_device(hid);
867 usb_free_urb(usbhid->urbin);
868 usb_free_urb(usbhid->urbout);
869 usb_free_urb(usbhid->urbctrl);
870 hid_free_buffers(dev, hid);
876 static void usbhid_stop(struct hid_device *hid)
878 struct usbhid_device *usbhid = hid->driver_data;
880 if (WARN_ON(!usbhid))
883 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
884 set_bit(HID_DISCONNECTED, &usbhid->iofl);
885 spin_unlock_irq(&usbhid->inlock);
886 usb_kill_urb(usbhid->urbin);
887 usb_kill_urb(usbhid->urbout);
888 usb_kill_urb(usbhid->urbctrl);
890 del_timer_sync(&usbhid->io_retry);
891 cancel_work_sync(&usbhid->reset_work);
893 if (hid->claimed & HID_CLAIMED_INPUT)
894 hidinput_disconnect(hid);
895 if (hid->claimed & HID_CLAIMED_HIDDEV)
896 hiddev_disconnect(hid);
897 if (hid->claimed & HID_CLAIMED_HIDRAW)
898 hidraw_disconnect(hid);
902 usb_free_urb(usbhid->urbin);
903 usb_free_urb(usbhid->urbctrl);
904 usb_free_urb(usbhid->urbout);
906 hid_free_buffers(hid_to_usb_dev(hid), hid);
908 hid->driver_data = NULL;
911 static struct hid_ll_driver usb_hid_driver = {
912 .parse = usbhid_parse,
913 .start = usbhid_start,
916 .close = usbhid_close,
917 .hidinput_input_event = usb_hidinput_input_event,
920 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
922 struct usb_device *dev = interface_to_usbdev(intf);
923 struct hid_device *hid;
927 dbg_hid("HID probe called for ifnum %d\n",
928 intf->altsetting->desc.bInterfaceNumber);
930 hid = hid_allocate_device();
934 usb_set_intfdata(intf, hid);
935 hid->ll_driver = &usb_hid_driver;
936 hid->hid_output_raw_report = usbhid_output_raw_report;
937 hid->ff_init = hid_ff_init;
938 #ifdef CONFIG_USB_HIDDEV
939 hid->hiddev_connect = hiddev_connect;
940 hid->hiddev_hid_event = hiddev_hid_event;
941 hid->hiddev_report_event = hiddev_report_event;
943 hid->dev.parent = &intf->dev;
945 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
946 hid->product = le16_to_cpu(dev->descriptor.idProduct);
949 if (dev->manufacturer)
950 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
953 if (dev->manufacturer)
954 strlcat(hid->name, " ", sizeof(hid->name));
955 strlcat(hid->name, dev->product, sizeof(hid->name));
958 if (!strlen(hid->name))
959 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
960 le16_to_cpu(dev->descriptor.idVendor),
961 le16_to_cpu(dev->descriptor.idProduct));
963 usb_make_path(dev, hid->phys, sizeof(hid->phys));
964 strlcat(hid->phys, "/input", sizeof(hid->phys));
965 len = strlen(hid->phys);
966 if (len < sizeof(hid->phys) - 1)
967 snprintf(hid->phys + len, sizeof(hid->phys) - len,
968 "%d", intf->altsetting[0].desc.bInterfaceNumber);
970 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
973 ret = hid_add_device(hid);
976 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
982 hid_destroy_device(hid);
986 static void hid_disconnect(struct usb_interface *intf)
988 struct hid_device *hid = usb_get_intfdata(intf);
993 hid_destroy_device(hid);
996 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
998 struct hid_device *hid = usb_get_intfdata (intf);
999 struct usbhid_device *usbhid = hid->driver_data;
1001 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
1002 set_bit(HID_SUSPENDED, &usbhid->iofl);
1003 spin_unlock_irq(&usbhid->inlock);
1004 del_timer(&usbhid->io_retry);
1005 usb_kill_urb(usbhid->urbin);
1006 dev_dbg(&intf->dev, "suspend\n");
1010 static int hid_resume(struct usb_interface *intf)
1012 struct hid_device *hid = usb_get_intfdata (intf);
1013 struct usbhid_device *usbhid = hid->driver_data;
1016 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1017 usbhid->retry_delay = 0;
1018 status = hid_start_in(hid);
1019 dev_dbg(&intf->dev, "resume status %d\n", status);
1023 /* Treat USB reset pretty much the same as suspend/resume */
1024 static int hid_pre_reset(struct usb_interface *intf)
1026 /* FIXME: What if the interface is already suspended? */
1027 hid_suspend(intf, PMSG_ON);
1031 /* Same routine used for post_reset and reset_resume */
1032 static int hid_post_reset(struct usb_interface *intf)
1034 struct usb_device *dev = interface_to_usbdev (intf);
1036 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1037 /* FIXME: Any more reinitialization needed? */
1039 return hid_resume(intf);
1042 static struct usb_device_id hid_usb_ids [] = {
1043 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1044 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1045 { } /* Terminating entry */
1048 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1050 static struct usb_driver hid_driver = {
1053 .disconnect = hid_disconnect,
1054 .suspend = hid_suspend,
1055 .resume = hid_resume,
1056 .reset_resume = hid_post_reset,
1057 .pre_reset = hid_pre_reset,
1058 .post_reset = hid_post_reset,
1059 .id_table = hid_usb_ids,
1060 .supports_autosuspend = 1,
1063 static const struct hid_device_id hid_usb_table[] = {
1064 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1068 static struct hid_driver hid_usb_driver = {
1069 .name = "generic-usb",
1070 .id_table = hid_usb_table,
1073 static int __init hid_init(void)
1076 retval = hid_register_driver(&hid_usb_driver);
1078 goto hid_register_fail;
1079 retval = usbhid_quirks_init(quirks_param);
1081 goto usbhid_quirks_init_fail;
1082 retval = hiddev_init();
1084 goto hiddev_init_fail;
1085 retval = usb_register(&hid_driver);
1087 goto usb_register_fail;
1088 info(DRIVER_VERSION ":" DRIVER_DESC);
1094 usbhid_quirks_exit();
1095 usbhid_quirks_init_fail:
1096 hid_unregister_driver(&hid_usb_driver);
1101 static void __exit hid_exit(void)
1103 usb_deregister(&hid_driver);
1105 usbhid_quirks_exit();
1106 hid_unregister_driver(&hid_usb_driver);
1109 module_init(hid_init);
1110 module_exit(hid_exit);
1112 MODULE_AUTHOR(DRIVER_AUTHOR);
1113 MODULE_DESCRIPTION(DRIVER_DESC);
1114 MODULE_LICENSE(DRIVER_LICENSE);