HID: sync on deleted io_retry timer in usbhid driver
[linux-3.10.git] / drivers / hid / usbhid / hid-core.c
1 /*
2  *  USB HID support for Linux
3  *
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
8  */
9
10 /*
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)
14  * any later version.
15  */
16
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>
22 #include <linux/mm.h>
23 #include <linux/mutex.h>
24 #include <linux/smp_lock.h>
25 #include <linux/spinlock.h>
26 #include <asm/unaligned.h>
27 #include <asm/byteorder.h>
28 #include <linux/input.h>
29 #include <linux/wait.h>
30
31 #include <linux/usb.h>
32
33 #include <linux/hid.h>
34 #include <linux/hiddev.h>
35 #include <linux/hid-debug.h>
36 #include <linux/hidraw.h>
37 #include "usbhid.h"
38
39 /*
40  * Version Information
41  */
42
43 #define DRIVER_VERSION "v2.6"
44 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
45 #define DRIVER_DESC "USB HID core driver"
46 #define DRIVER_LICENSE "GPL"
47
48 /*
49  * Module parameters.
50  */
51
52 static unsigned int hid_mousepoll_interval;
53 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
54 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
55
56 /* Quirks specified at module load time */
57 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
58 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
59 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
60                 " quirks=vendorID:productID:quirks"
61                 " where vendorID, productID, and quirks are all in"
62                 " 0x-prefixed hex");
63 /*
64  * Input submission and I/O error handler.
65  */
66
67 static void hid_io_error(struct hid_device *hid);
68
69 /* Start up the input URB */
70 static int hid_start_in(struct hid_device *hid)
71 {
72         unsigned long flags;
73         int rc = 0;
74         struct usbhid_device *usbhid = hid->driver_data;
75
76         spin_lock_irqsave(&usbhid->inlock, flags);
77         if (hid->open > 0 && !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
78                         !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
79                         !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
80                 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
81                 if (rc != 0)
82                         clear_bit(HID_IN_RUNNING, &usbhid->iofl);
83         }
84         spin_unlock_irqrestore(&usbhid->inlock, flags);
85         return rc;
86 }
87
88 /* I/O retry timer routine */
89 static void hid_retry_timeout(unsigned long _hid)
90 {
91         struct hid_device *hid = (struct hid_device *) _hid;
92         struct usbhid_device *usbhid = hid->driver_data;
93
94         dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
95         if (hid_start_in(hid))
96                 hid_io_error(hid);
97 }
98
99 /* Workqueue routine to reset the device or clear a halt */
100 static void hid_reset(struct work_struct *work)
101 {
102         struct usbhid_device *usbhid =
103                 container_of(work, struct usbhid_device, reset_work);
104         struct hid_device *hid = usbhid->hid;
105         int rc_lock, rc = 0;
106
107         if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
108                 dev_dbg(&usbhid->intf->dev, "clear halt\n");
109                 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
110                 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
111                 hid_start_in(hid);
112         }
113
114         else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
115                 dev_dbg(&usbhid->intf->dev, "resetting device\n");
116                 rc = rc_lock = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
117                 if (rc_lock >= 0) {
118                         rc = usb_reset_device(hid_to_usb_dev(hid));
119                         if (rc_lock)
120                                 usb_unlock_device(hid_to_usb_dev(hid));
121                 }
122                 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
123         }
124
125         switch (rc) {
126         case 0:
127                 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
128                         hid_io_error(hid);
129                 break;
130         default:
131                 err_hid("can't reset device, %s-%s/input%d, status %d",
132                                 hid_to_usb_dev(hid)->bus->bus_name,
133                                 hid_to_usb_dev(hid)->devpath,
134                                 usbhid->ifnum, rc);
135                 /* FALLTHROUGH */
136         case -EHOSTUNREACH:
137         case -ENODEV:
138         case -EINTR:
139                 break;
140         }
141 }
142
143 /* Main I/O error handler */
144 static void hid_io_error(struct hid_device *hid)
145 {
146         unsigned long flags;
147         struct usbhid_device *usbhid = hid->driver_data;
148
149         spin_lock_irqsave(&usbhid->inlock, flags);
150
151         /* Stop when disconnected */
152         if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
153                 goto done;
154
155         /* If it has been a while since the last error, we'll assume
156          * this a brand new error and reset the retry timeout. */
157         if (time_after(jiffies, usbhid->stop_retry + HZ/2))
158                 usbhid->retry_delay = 0;
159
160         /* When an error occurs, retry at increasing intervals */
161         if (usbhid->retry_delay == 0) {
162                 usbhid->retry_delay = 13;       /* Then 26, 52, 104, 104, ... */
163                 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
164         } else if (usbhid->retry_delay < 100)
165                 usbhid->retry_delay *= 2;
166
167         if (time_after(jiffies, usbhid->stop_retry)) {
168
169                 /* Retries failed, so do a port reset */
170                 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
171                         schedule_work(&usbhid->reset_work);
172                         goto done;
173                 }
174         }
175
176         mod_timer(&usbhid->io_retry,
177                         jiffies + msecs_to_jiffies(usbhid->retry_delay));
178 done:
179         spin_unlock_irqrestore(&usbhid->inlock, flags);
180 }
181
182 /*
183  * Input interrupt completion handler.
184  */
185
186 static void hid_irq_in(struct urb *urb)
187 {
188         struct hid_device       *hid = urb->context;
189         struct usbhid_device    *usbhid = hid->driver_data;
190         int                     status;
191
192         switch (urb->status) {
193         case 0:                 /* success */
194                 usbhid->retry_delay = 0;
195                 hid_input_report(urb->context, HID_INPUT_REPORT,
196                                  urb->transfer_buffer,
197                                  urb->actual_length, 1);
198                 break;
199         case -EPIPE:            /* stall */
200                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
201                 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
202                 schedule_work(&usbhid->reset_work);
203                 return;
204         case -ECONNRESET:       /* unlink */
205         case -ENOENT:
206         case -ESHUTDOWN:        /* unplug */
207                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
208                 return;
209         case -EILSEQ:           /* protocol error or unplug */
210         case -EPROTO:           /* protocol error or unplug */
211         case -ETIME:            /* protocol error or unplug */
212         case -ETIMEDOUT:        /* Should never happen, but... */
213                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
214                 hid_io_error(hid);
215                 return;
216         default:                /* error */
217                 dev_warn(&urb->dev->dev, "input irq status %d  "
218                                 "received\n", urb->status);
219         }
220
221         status = usb_submit_urb(urb, GFP_ATOMIC);
222         if (status) {
223                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
224                 if (status != -EPERM) {
225                         err_hid("can't resubmit intr, %s-%s/input%d, status %d",
226                                         hid_to_usb_dev(hid)->bus->bus_name,
227                                         hid_to_usb_dev(hid)->devpath,
228                                         usbhid->ifnum, status);
229                         hid_io_error(hid);
230                 }
231         }
232 }
233
234 static int hid_submit_out(struct hid_device *hid)
235 {
236         struct hid_report *report;
237         char *raw_report;
238         struct usbhid_device *usbhid = hid->driver_data;
239
240         report = usbhid->out[usbhid->outtail].report;
241         raw_report = usbhid->out[usbhid->outtail].raw_report;
242
243         usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
244         usbhid->urbout->dev = hid_to_usb_dev(hid);
245         memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
246         kfree(raw_report);
247
248         dbg_hid("submitting out urb\n");
249
250         if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
251                 err_hid("usb_submit_urb(out) failed");
252                 return -1;
253         }
254
255         return 0;
256 }
257
258 static int hid_submit_ctrl(struct hid_device *hid)
259 {
260         struct hid_report *report;
261         unsigned char dir;
262         char *raw_report;
263         int len;
264         struct usbhid_device *usbhid = hid->driver_data;
265
266         report = usbhid->ctrl[usbhid->ctrltail].report;
267         raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
268         dir = usbhid->ctrl[usbhid->ctrltail].dir;
269
270         len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
271         if (dir == USB_DIR_OUT) {
272                 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
273                 usbhid->urbctrl->transfer_buffer_length = len;
274                 memcpy(usbhid->ctrlbuf, raw_report, len);
275                 kfree(raw_report);
276         } else {
277                 int maxpacket, padlen;
278
279                 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
280                 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
281                 if (maxpacket > 0) {
282                         padlen = DIV_ROUND_UP(len, maxpacket);
283                         padlen *= maxpacket;
284                         if (padlen > usbhid->bufsize)
285                                 padlen = usbhid->bufsize;
286                 } else
287                         padlen = 0;
288                 usbhid->urbctrl->transfer_buffer_length = padlen;
289         }
290         usbhid->urbctrl->dev = hid_to_usb_dev(hid);
291
292         usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
293         usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
294         usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
295         usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
296         usbhid->cr->wLength = cpu_to_le16(len);
297
298         dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
299                 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
300                 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
301
302         if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
303                 err_hid("usb_submit_urb(ctrl) failed");
304                 return -1;
305         }
306
307         return 0;
308 }
309
310 /*
311  * Output interrupt completion handler.
312  */
313
314 static void hid_irq_out(struct urb *urb)
315 {
316         struct hid_device *hid = urb->context;
317         struct usbhid_device *usbhid = hid->driver_data;
318         unsigned long flags;
319         int unplug = 0;
320
321         switch (urb->status) {
322         case 0:                 /* success */
323                 break;
324         case -ESHUTDOWN:        /* unplug */
325                 unplug = 1;
326         case -EILSEQ:           /* protocol error or unplug */
327         case -EPROTO:           /* protocol error or unplug */
328         case -ECONNRESET:       /* unlink */
329         case -ENOENT:
330                 break;
331         default:                /* error */
332                 dev_warn(&urb->dev->dev, "output irq status %d "
333                                 "received\n", urb->status);
334         }
335
336         spin_lock_irqsave(&usbhid->outlock, flags);
337
338         if (unplug)
339                 usbhid->outtail = usbhid->outhead;
340         else
341                 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
342
343         if (usbhid->outhead != usbhid->outtail) {
344                 if (hid_submit_out(hid)) {
345                         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
346                         wake_up(&usbhid->wait);
347                 }
348                 spin_unlock_irqrestore(&usbhid->outlock, flags);
349                 return;
350         }
351
352         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
353         spin_unlock_irqrestore(&usbhid->outlock, flags);
354         wake_up(&usbhid->wait);
355 }
356
357 /*
358  * Control pipe completion handler.
359  */
360
361 static void hid_ctrl(struct urb *urb)
362 {
363         struct hid_device *hid = urb->context;
364         struct usbhid_device *usbhid = hid->driver_data;
365         unsigned long flags;
366         int unplug = 0;
367
368         spin_lock_irqsave(&usbhid->ctrllock, flags);
369
370         switch (urb->status) {
371         case 0:                 /* success */
372                 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
373                         hid_input_report(urb->context,
374                                 usbhid->ctrl[usbhid->ctrltail].report->type,
375                                 urb->transfer_buffer, urb->actual_length, 0);
376                 break;
377         case -ESHUTDOWN:        /* unplug */
378                 unplug = 1;
379         case -EILSEQ:           /* protocol error or unplug */
380         case -EPROTO:           /* protocol error or unplug */
381         case -ECONNRESET:       /* unlink */
382         case -ENOENT:
383         case -EPIPE:            /* report not available */
384                 break;
385         default:                /* error */
386                 dev_warn(&urb->dev->dev, "ctrl urb status %d "
387                                 "received\n", urb->status);
388         }
389
390         if (unplug)
391                 usbhid->ctrltail = usbhid->ctrlhead;
392         else
393                 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
394
395         if (usbhid->ctrlhead != usbhid->ctrltail) {
396                 if (hid_submit_ctrl(hid)) {
397                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
398                         wake_up(&usbhid->wait);
399                 }
400                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
401                 return;
402         }
403
404         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
405         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
406         wake_up(&usbhid->wait);
407 }
408
409 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
410 {
411         int head;
412         unsigned long flags;
413         struct usbhid_device *usbhid = hid->driver_data;
414         int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
415
416         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
417                 return;
418
419         if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
420
421                 spin_lock_irqsave(&usbhid->outlock, flags);
422
423                 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
424                         spin_unlock_irqrestore(&usbhid->outlock, flags);
425                         dev_warn(&hid->dev, "output queue full\n");
426                         return;
427                 }
428
429                 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
430                 if (!usbhid->out[usbhid->outhead].raw_report) {
431                         spin_unlock_irqrestore(&usbhid->outlock, flags);
432                         dev_warn(&hid->dev, "output queueing failed\n");
433                         return;
434                 }
435                 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
436                 usbhid->out[usbhid->outhead].report = report;
437                 usbhid->outhead = head;
438
439                 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
440                         if (hid_submit_out(hid))
441                                 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
442
443                 spin_unlock_irqrestore(&usbhid->outlock, flags);
444                 return;
445         }
446
447         spin_lock_irqsave(&usbhid->ctrllock, flags);
448
449         if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
450                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
451                 dev_warn(&hid->dev, "control queue full\n");
452                 return;
453         }
454
455         if (dir == USB_DIR_OUT) {
456                 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
457                 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
458                         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
459                         dev_warn(&hid->dev, "control queueing failed\n");
460                         return;
461                 }
462                 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
463         }
464         usbhid->ctrl[usbhid->ctrlhead].report = report;
465         usbhid->ctrl[usbhid->ctrlhead].dir = dir;
466         usbhid->ctrlhead = head;
467
468         if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
469                 if (hid_submit_ctrl(hid))
470                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
471
472         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
473 }
474 EXPORT_SYMBOL_GPL(usbhid_submit_report);
475
476 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
477 {
478         struct hid_device *hid = input_get_drvdata(dev);
479         struct hid_field *field;
480         int offset;
481
482         if (type == EV_FF)
483                 return input_ff_event(dev, type, code, value);
484
485         if (type != EV_LED)
486                 return -1;
487
488         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
489                 dev_warn(&dev->dev, "event field not found\n");
490                 return -1;
491         }
492
493         hid_set_field(field, offset, value);
494         usbhid_submit_report(hid, field->report, USB_DIR_OUT);
495
496         return 0;
497 }
498
499 int usbhid_wait_io(struct hid_device *hid)
500 {
501         struct usbhid_device *usbhid = hid->driver_data;
502
503         if (!wait_event_timeout(usbhid->wait,
504                                 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
505                                 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
506                                         10*HZ)) {
507                 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
508                 return -1;
509         }
510
511         return 0;
512 }
513
514 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
515 {
516         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
517                 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
518                 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
519 }
520
521 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
522                 unsigned char type, void *buf, int size)
523 {
524         int result, retries = 4;
525
526         memset(buf, 0, size);
527
528         do {
529                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
530                                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
531                                 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
532                 retries--;
533         } while (result < size && retries);
534         return result;
535 }
536
537 int usbhid_open(struct hid_device *hid)
538 {
539         struct usbhid_device *usbhid = hid->driver_data;
540         int res;
541
542         if (!hid->open++) {
543                 res = usb_autopm_get_interface(usbhid->intf);
544                 if (res < 0) {
545                         hid->open--;
546                         return -EIO;
547                 }
548         }
549         if (hid_start_in(hid))
550                 hid_io_error(hid);
551         return 0;
552 }
553
554 void usbhid_close(struct hid_device *hid)
555 {
556         struct usbhid_device *usbhid = hid->driver_data;
557
558         if (!--hid->open) {
559                 usb_kill_urb(usbhid->urbin);
560                 usb_autopm_put_interface(usbhid->intf);
561         }
562 }
563
564 /*
565  * Initialize all reports
566  */
567
568 void usbhid_init_reports(struct hid_device *hid)
569 {
570         struct hid_report *report;
571         struct usbhid_device *usbhid = hid->driver_data;
572         int err, ret;
573
574         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
575                 usbhid_submit_report(hid, report, USB_DIR_IN);
576
577         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
578                 usbhid_submit_report(hid, report, USB_DIR_IN);
579
580         err = 0;
581         ret = usbhid_wait_io(hid);
582         while (ret) {
583                 err |= ret;
584                 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
585                         usb_kill_urb(usbhid->urbctrl);
586                 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
587                         usb_kill_urb(usbhid->urbout);
588                 ret = usbhid_wait_io(hid);
589         }
590
591         if (err)
592                 dev_warn(&hid->dev, "timeout initializing reports\n");
593 }
594
595 /*
596  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
597  */
598 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
599     unsigned int hid_code, struct hid_field **pfield)
600 {
601         struct hid_report *report;
602         struct hid_field *field;
603         struct hid_usage *usage;
604         int i, j;
605
606         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
607                 for (i = 0; i < report->maxfield; i++) {
608                         field = report->field[i];
609                         for (j = 0; j < field->maxusage; j++) {
610                                 usage = &field->usage[j];
611                                 if ((usage->hid & HID_USAGE_PAGE) == page &&
612                                     (usage->hid & 0xFFFF) == hid_code) {
613                                         *pfield = field;
614                                         return j;
615                                 }
616                         }
617                 }
618         }
619         return -1;
620 }
621
622 void usbhid_set_leds(struct hid_device *hid)
623 {
624         struct hid_field *field;
625         int offset;
626
627         if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
628                 hid_set_field(field, offset, 0);
629                 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
630         }
631 }
632 EXPORT_SYMBOL_GPL(usbhid_set_leds);
633
634 /*
635  * Traverse the supplied list of reports and find the longest
636  */
637 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
638                 unsigned int *max)
639 {
640         struct hid_report *report;
641         unsigned int size;
642
643         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
644                 size = ((report->size - 1) >> 3) + 1;
645                 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
646                         size++;
647                 if (*max < size)
648                         *max = size;
649         }
650 }
651
652 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
653 {
654         struct usbhid_device *usbhid = hid->driver_data;
655
656         if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
657                 return -1;
658         if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
659                 return -1;
660         if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
661                 return -1;
662         if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
663                 return -1;
664
665         return 0;
666 }
667
668 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
669 {
670         struct usbhid_device *usbhid = hid->driver_data;
671         struct usb_device *dev = hid_to_usb_dev(hid);
672         struct usb_interface *intf = usbhid->intf;
673         struct usb_host_interface *interface = intf->cur_altsetting;
674         int ret;
675
676         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
677                 HID_REQ_SET_REPORT,
678                 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
679                 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
680                 interface->desc.bInterfaceNumber, buf + 1, count - 1,
681                 USB_CTRL_SET_TIMEOUT);
682
683         /* count also the report id */
684         if (ret > 0)
685                 ret++;
686
687         return ret;
688 }
689
690 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
691 {
692         struct usbhid_device *usbhid = hid->driver_data;
693
694         usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
695         usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
696         usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
697         usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
698 }
699
700 static int usbhid_parse(struct hid_device *hid)
701 {
702         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
703         struct usb_host_interface *interface = intf->cur_altsetting;
704         struct usb_device *dev = interface_to_usbdev (intf);
705         struct hid_descriptor *hdesc;
706         u32 quirks = 0;
707         unsigned int rsize = 0;
708         char *rdesc;
709         int ret, n;
710
711         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
712                         le16_to_cpu(dev->descriptor.idProduct));
713
714         /* Many keyboards and mice don't like to be polled for reports,
715          * so we will always set the HID_QUIRK_NOGET flag for them. */
716         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
717                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
718                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
719                                 quirks |= HID_QUIRK_NOGET;
720         }
721
722         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
723             (!interface->desc.bNumEndpoints ||
724              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
725                 dbg_hid("class descriptor not present\n");
726                 return -ENODEV;
727         }
728
729         hid->version = le16_to_cpu(hdesc->bcdHID);
730         hid->country = hdesc->bCountryCode;
731
732         for (n = 0; n < hdesc->bNumDescriptors; n++)
733                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
734                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
735
736         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
737                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
738                 return -EINVAL;
739         }
740
741         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
742                 dbg_hid("couldn't allocate rdesc memory\n");
743                 return -ENOMEM;
744         }
745
746         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
747
748         ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
749                         HID_DT_REPORT, rdesc, rsize);
750         if (ret < 0) {
751                 dbg_hid("reading report descriptor failed\n");
752                 kfree(rdesc);
753                 goto err;
754         }
755
756         dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
757         for (n = 0; n < rsize; n++)
758                 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
759         dbg_hid_line("\n");
760
761         ret = hid_parse_report(hid, rdesc, rsize);
762         kfree(rdesc);
763         if (ret) {
764                 dbg_hid("parsing report descriptor failed\n");
765                 goto err;
766         }
767
768         hid->quirks = quirks;
769
770         return 0;
771 err:
772         return ret;
773 }
774
775 static int usbhid_start(struct hid_device *hid)
776 {
777         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
778         struct usb_host_interface *interface = intf->cur_altsetting;
779         struct usb_device *dev = interface_to_usbdev(intf);
780         struct usbhid_device *usbhid = hid->driver_data;
781         unsigned int n, insize = 0;
782         int ret;
783
784         usbhid->bufsize = HID_MIN_BUFFER_SIZE;
785         hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
786         hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
787         hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
788
789         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
790                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
791
792         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
793
794         if (insize > HID_MAX_BUFFER_SIZE)
795                 insize = HID_MAX_BUFFER_SIZE;
796
797         mutex_lock(&usbhid->setup);
798         if (hid_alloc_buffers(dev, hid)) {
799                 ret = -ENOMEM;
800                 goto fail;
801         }
802
803         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
804                 struct usb_endpoint_descriptor *endpoint;
805                 int pipe;
806                 int interval;
807
808                 endpoint = &interface->endpoint[n].desc;
809                 if ((endpoint->bmAttributes & 3) != 3)          /* Not an interrupt endpoint */
810                         continue;
811
812                 interval = endpoint->bInterval;
813
814                 /* Some vendors give fullspeed interval on highspeed devides */
815                 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
816                     dev->speed == USB_SPEED_HIGH) {
817                         interval = fls(endpoint->bInterval*8);
818                         printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
819                                hid->name, endpoint->bInterval, interval);
820                 }
821
822                 /* Change the polling interval of mice. */
823                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
824                         interval = hid_mousepoll_interval;
825
826                 ret = -ENOMEM;
827                 if (usb_endpoint_dir_in(endpoint)) {
828                         if (usbhid->urbin)
829                                 continue;
830                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
831                                 goto fail;
832                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
833                         usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
834                                          hid_irq_in, hid, interval);
835                         usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
836                         usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
837                 } else {
838                         if (usbhid->urbout)
839                                 continue;
840                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
841                                 goto fail;
842                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
843                         usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
844                                          hid_irq_out, hid, interval);
845                         usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
846                         usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
847                 }
848         }
849
850         if (!usbhid->urbin) {
851                 err_hid("couldn't find an input interrupt endpoint");
852                 ret = -ENODEV;
853                 goto fail;
854         }
855
856         init_waitqueue_head(&usbhid->wait);
857         INIT_WORK(&usbhid->reset_work, hid_reset);
858         setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
859
860         spin_lock_init(&usbhid->inlock);
861         spin_lock_init(&usbhid->outlock);
862         spin_lock_init(&usbhid->ctrllock);
863
864         usbhid->intf = intf;
865         usbhid->ifnum = interface->desc.bInterfaceNumber;
866
867         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
868         if (!usbhid->urbctrl) {
869                 ret = -ENOMEM;
870                 goto fail;
871         }
872
873         usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
874                              usbhid->ctrlbuf, 1, hid_ctrl, hid);
875         usbhid->urbctrl->setup_dma = usbhid->cr_dma;
876         usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
877         usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
878
879         usbhid_init_reports(hid);
880         hid_dump_device(hid);
881
882         set_bit(HID_STARTED, &usbhid->iofl);
883         mutex_unlock(&usbhid->setup);
884
885         return 0;
886
887 fail:
888         usb_free_urb(usbhid->urbin);
889         usb_free_urb(usbhid->urbout);
890         usb_free_urb(usbhid->urbctrl);
891         hid_free_buffers(dev, hid);
892         mutex_unlock(&usbhid->setup);
893         return ret;
894 }
895
896 static void usbhid_stop(struct hid_device *hid)
897 {
898         struct usbhid_device *usbhid = hid->driver_data;
899
900         if (WARN_ON(!usbhid))
901                 return;
902
903         mutex_lock(&usbhid->setup);
904         clear_bit(HID_STARTED, &usbhid->iofl);
905         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
906         set_bit(HID_DISCONNECTED, &usbhid->iofl);
907         spin_unlock_irq(&usbhid->inlock);
908         usb_kill_urb(usbhid->urbin);
909         usb_kill_urb(usbhid->urbout);
910         usb_kill_urb(usbhid->urbctrl);
911
912         del_timer_sync(&usbhid->io_retry);
913         cancel_work_sync(&usbhid->reset_work);
914
915         if (hid->claimed & HID_CLAIMED_INPUT)
916                 hidinput_disconnect(hid);
917         if (hid->claimed & HID_CLAIMED_HIDDEV)
918                 hiddev_disconnect(hid);
919         if (hid->claimed & HID_CLAIMED_HIDRAW)
920                 hidraw_disconnect(hid);
921
922         hid->claimed = 0;
923
924         usb_free_urb(usbhid->urbin);
925         usb_free_urb(usbhid->urbctrl);
926         usb_free_urb(usbhid->urbout);
927
928         hid_free_buffers(hid_to_usb_dev(hid), hid);
929         mutex_unlock(&usbhid->setup);
930 }
931
932 static struct hid_ll_driver usb_hid_driver = {
933         .parse = usbhid_parse,
934         .start = usbhid_start,
935         .stop = usbhid_stop,
936         .open = usbhid_open,
937         .close = usbhid_close,
938         .hidinput_input_event = usb_hidinput_input_event,
939 };
940
941 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
942 {
943         struct usb_device *dev = interface_to_usbdev(intf);
944         struct usbhid_device *usbhid;
945         struct hid_device *hid;
946         size_t len;
947         int ret;
948
949         dbg_hid("HID probe called for ifnum %d\n",
950                         intf->altsetting->desc.bInterfaceNumber);
951
952         hid = hid_allocate_device();
953         if (IS_ERR(hid))
954                 return PTR_ERR(hid);
955
956         usb_set_intfdata(intf, hid);
957         hid->ll_driver = &usb_hid_driver;
958         hid->hid_output_raw_report = usbhid_output_raw_report;
959         hid->ff_init = hid_pidff_init;
960 #ifdef CONFIG_USB_HIDDEV
961         hid->hiddev_connect = hiddev_connect;
962         hid->hiddev_hid_event = hiddev_hid_event;
963         hid->hiddev_report_event = hiddev_report_event;
964 #endif
965         hid->dev.parent = &intf->dev;
966         hid->bus = BUS_USB;
967         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
968         hid->product = le16_to_cpu(dev->descriptor.idProduct);
969         hid->name[0] = 0;
970         if (intf->cur_altsetting->desc.bInterfaceProtocol ==
971                         USB_INTERFACE_PROTOCOL_MOUSE)
972                 hid->type = HID_TYPE_USBMOUSE;
973
974         if (dev->manufacturer)
975                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
976
977         if (dev->product) {
978                 if (dev->manufacturer)
979                         strlcat(hid->name, " ", sizeof(hid->name));
980                 strlcat(hid->name, dev->product, sizeof(hid->name));
981         }
982
983         if (!strlen(hid->name))
984                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
985                          le16_to_cpu(dev->descriptor.idVendor),
986                          le16_to_cpu(dev->descriptor.idProduct));
987
988         usb_make_path(dev, hid->phys, sizeof(hid->phys));
989         strlcat(hid->phys, "/input", sizeof(hid->phys));
990         len = strlen(hid->phys);
991         if (len < sizeof(hid->phys) - 1)
992                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
993                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
994
995         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
996                 hid->uniq[0] = 0;
997
998         usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
999         if (usbhid == NULL) {
1000                 ret = -ENOMEM;
1001                 goto err;
1002         }
1003
1004         hid->driver_data = usbhid;
1005         usbhid->hid = hid;
1006         mutex_init(&usbhid->setup); /* needed on suspend/resume */
1007
1008         ret = hid_add_device(hid);
1009         if (ret) {
1010                 if (ret != -ENODEV)
1011                         dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1012                 goto err_free;
1013         }
1014
1015         return 0;
1016 err_free:
1017         kfree(usbhid);
1018 err:
1019         hid_destroy_device(hid);
1020         return ret;
1021 }
1022
1023 static void hid_disconnect(struct usb_interface *intf)
1024 {
1025         struct hid_device *hid = usb_get_intfdata(intf);
1026         struct usbhid_device *usbhid;
1027
1028         if (WARN_ON(!hid))
1029                 return;
1030
1031         usbhid = hid->driver_data;
1032         hid_destroy_device(hid);
1033         kfree(usbhid);
1034 }
1035
1036 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1037 {
1038         struct hid_device *hid = usb_get_intfdata (intf);
1039         struct usbhid_device *usbhid = hid->driver_data;
1040
1041         mutex_lock(&usbhid->setup);
1042         if (!test_bit(HID_STARTED, &usbhid->iofl)) {
1043                 mutex_unlock(&usbhid->setup);
1044                 return 0;
1045         }
1046
1047         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
1048         set_bit(HID_SUSPENDED, &usbhid->iofl);
1049         spin_unlock_irq(&usbhid->inlock);
1050         del_timer_sync(&usbhid->io_retry);
1051         usb_kill_urb(usbhid->urbin);
1052         mutex_unlock(&usbhid->setup);
1053         dev_dbg(&intf->dev, "suspend\n");
1054         return 0;
1055 }
1056
1057 static int hid_resume(struct usb_interface *intf)
1058 {
1059         struct hid_device *hid = usb_get_intfdata (intf);
1060         struct usbhid_device *usbhid = hid->driver_data;
1061         int status;
1062
1063         mutex_lock(&usbhid->setup);
1064         if (!test_bit(HID_STARTED, &usbhid->iofl)) {
1065                 mutex_unlock(&usbhid->setup);
1066                 return 0;
1067         }
1068
1069         clear_bit(HID_SUSPENDED, &usbhid->iofl);
1070         usbhid->retry_delay = 0;
1071         status = hid_start_in(hid);
1072         mutex_unlock(&usbhid->setup);
1073         dev_dbg(&intf->dev, "resume status %d\n", status);
1074         return status;
1075 }
1076
1077 /* Treat USB reset pretty much the same as suspend/resume */
1078 static int hid_pre_reset(struct usb_interface *intf)
1079 {
1080         /* FIXME: What if the interface is already suspended? */
1081         hid_suspend(intf, PMSG_ON);
1082         return 0;
1083 }
1084
1085 /* Same routine used for post_reset and reset_resume */
1086 static int hid_post_reset(struct usb_interface *intf)
1087 {
1088         struct usb_device *dev = interface_to_usbdev (intf);
1089
1090         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1091         /* FIXME: Any more reinitialization needed? */
1092
1093         return hid_resume(intf);
1094 }
1095
1096 static struct usb_device_id hid_usb_ids [] = {
1097         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1098                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1099         { }                                             /* Terminating entry */
1100 };
1101
1102 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1103
1104 static struct usb_driver hid_driver = {
1105         .name =         "usbhid",
1106         .probe =        hid_probe,
1107         .disconnect =   hid_disconnect,
1108         .suspend =      hid_suspend,
1109         .resume =       hid_resume,
1110         .reset_resume = hid_post_reset,
1111         .pre_reset =    hid_pre_reset,
1112         .post_reset =   hid_post_reset,
1113         .id_table =     hid_usb_ids,
1114         .supports_autosuspend = 1,
1115 };
1116
1117 static const struct hid_device_id hid_usb_table[] = {
1118         { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1119         { }
1120 };
1121
1122 static struct hid_driver hid_usb_driver = {
1123         .name = "generic-usb",
1124         .id_table = hid_usb_table,
1125 };
1126
1127 static int __init hid_init(void)
1128 {
1129         int retval;
1130         retval = hid_register_driver(&hid_usb_driver);
1131         if (retval)
1132                 goto hid_register_fail;
1133         retval = usbhid_quirks_init(quirks_param);
1134         if (retval)
1135                 goto usbhid_quirks_init_fail;
1136         retval = hiddev_init();
1137         if (retval)
1138                 goto hiddev_init_fail;
1139         retval = usb_register(&hid_driver);
1140         if (retval)
1141                 goto usb_register_fail;
1142         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1143                         DRIVER_DESC "\n");
1144
1145         return 0;
1146 usb_register_fail:
1147         hiddev_exit();
1148 hiddev_init_fail:
1149         usbhid_quirks_exit();
1150 usbhid_quirks_init_fail:
1151         hid_unregister_driver(&hid_usb_driver);
1152 hid_register_fail:
1153         return retval;
1154 }
1155
1156 static void __exit hid_exit(void)
1157 {
1158         usb_deregister(&hid_driver);
1159         hiddev_exit();
1160         usbhid_quirks_exit();
1161         hid_unregister_driver(&hid_usb_driver);
1162 }
1163
1164 module_init(hid_init);
1165 module_exit(hid_exit);
1166
1167 MODULE_AUTHOR(DRIVER_AUTHOR);
1168 MODULE_DESCRIPTION(DRIVER_DESC);
1169 MODULE_LICENSE(DRIVER_LICENSE);