402ace7512718028ab19ea0f3f7434b86bface59
[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/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>
29
30 #include <linux/usb.h>
31
32 #include <linux/hid.h>
33 #include <linux/hiddev.h>
34 #include <linux/hid-debug.h>
35 #include <linux/hidraw.h>
36 #include "usbhid.h"
37
38 /*
39  * Version Information
40  */
41
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"
46
47 /*
48  * Module parameters.
49  */
50
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");
54
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"
61                 " 0x-prefixed hex");
62 /*
63  * Input submission and I/O error handler.
64  */
65
66 static void hid_io_error(struct hid_device *hid);
67
68 /* Start up the input URB */
69 static int hid_start_in(struct hid_device *hid)
70 {
71         unsigned long flags;
72         int rc = 0;
73         struct usbhid_device *usbhid = hid->driver_data;
74
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);
80                 if (rc != 0)
81                         clear_bit(HID_IN_RUNNING, &usbhid->iofl);
82         }
83         spin_unlock_irqrestore(&usbhid->inlock, flags);
84         return rc;
85 }
86
87 /* I/O retry timer routine */
88 static void hid_retry_timeout(unsigned long _hid)
89 {
90         struct hid_device *hid = (struct hid_device *) _hid;
91         struct usbhid_device *usbhid = hid->driver_data;
92
93         dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
94         if (hid_start_in(hid))
95                 hid_io_error(hid);
96 }
97
98 /* Workqueue routine to reset the device or clear a halt */
99 static void hid_reset(struct work_struct *work)
100 {
101         struct usbhid_device *usbhid =
102                 container_of(work, struct usbhid_device, reset_work);
103         struct hid_device *hid = usbhid->hid;
104         int rc_lock, rc = 0;
105
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);
110                 hid_start_in(hid);
111         }
112
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);
116                 if (rc_lock >= 0) {
117                         rc = usb_reset_device(hid_to_usb_dev(hid));
118                         if (rc_lock)
119                                 usb_unlock_device(hid_to_usb_dev(hid));
120                 }
121                 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
122         }
123
124         switch (rc) {
125         case 0:
126                 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
127                         hid_io_error(hid);
128                 break;
129         default:
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,
133                                 usbhid->ifnum, rc);
134                 /* FALLTHROUGH */
135         case -EHOSTUNREACH:
136         case -ENODEV:
137         case -EINTR:
138                 break;
139         }
140 }
141
142 /* Main I/O error handler */
143 static void hid_io_error(struct hid_device *hid)
144 {
145         unsigned long flags;
146         struct usbhid_device *usbhid = hid->driver_data;
147
148         spin_lock_irqsave(&usbhid->inlock, flags);
149
150         /* Stop when disconnected */
151         if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
152                 goto done;
153
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;
158
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;
165
166         if (time_after(jiffies, usbhid->stop_retry)) {
167
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);
171                         goto done;
172                 }
173         }
174
175         mod_timer(&usbhid->io_retry,
176                         jiffies + msecs_to_jiffies(usbhid->retry_delay));
177 done:
178         spin_unlock_irqrestore(&usbhid->inlock, flags);
179 }
180
181 /*
182  * Input interrupt completion handler.
183  */
184
185 static void hid_irq_in(struct urb *urb)
186 {
187         struct hid_device       *hid = urb->context;
188         struct usbhid_device    *usbhid = hid->driver_data;
189         int                     status;
190
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);
197                 break;
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);
202                 return;
203         case -ECONNRESET:       /* unlink */
204         case -ENOENT:
205         case -ESHUTDOWN:        /* unplug */
206                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
207                 return;
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);
213                 hid_io_error(hid);
214                 return;
215         default:                /* error */
216                 warn("input irq status %d received", urb->status);
217         }
218
219         status = usb_submit_urb(urb, GFP_ATOMIC);
220         if (status) {
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);
227                         hid_io_error(hid);
228                 }
229         }
230 }
231
232 static int hid_submit_out(struct hid_device *hid)
233 {
234         struct hid_report *report;
235         struct usbhid_device *usbhid = hid->driver_data;
236
237         report = usbhid->out[usbhid->outtail];
238
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);
242
243         dbg_hid("submitting out urb\n");
244
245         if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
246                 err_hid("usb_submit_urb(out) failed");
247                 return -1;
248         }
249
250         return 0;
251 }
252
253 static int hid_submit_ctrl(struct hid_device *hid)
254 {
255         struct hid_report *report;
256         unsigned char dir;
257         int len;
258         struct usbhid_device *usbhid = hid->driver_data;
259
260         report = usbhid->ctrl[usbhid->ctrltail].report;
261         dir = usbhid->ctrl[usbhid->ctrltail].dir;
262
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;
268         } else {
269                 int maxpacket, padlen;
270
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);
273                 if (maxpacket > 0) {
274                         padlen = DIV_ROUND_UP(len, maxpacket);
275                         padlen *= maxpacket;
276                         if (padlen > usbhid->bufsize)
277                                 padlen = usbhid->bufsize;
278                 } else
279                         padlen = 0;
280                 usbhid->urbctrl->transfer_buffer_length = padlen;
281         }
282         usbhid->urbctrl->dev = hid_to_usb_dev(hid);
283
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);
289
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);
293
294         if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
295                 err_hid("usb_submit_urb(ctrl) failed");
296                 return -1;
297         }
298
299         return 0;
300 }
301
302 /*
303  * Output interrupt completion handler.
304  */
305
306 static void hid_irq_out(struct urb *urb)
307 {
308         struct hid_device *hid = urb->context;
309         struct usbhid_device *usbhid = hid->driver_data;
310         unsigned long flags;
311         int unplug = 0;
312
313         switch (urb->status) {
314         case 0:                 /* success */
315                 break;
316         case -ESHUTDOWN:        /* unplug */
317                 unplug = 1;
318         case -EILSEQ:           /* protocol error or unplug */
319         case -EPROTO:           /* protocol error or unplug */
320         case -ECONNRESET:       /* unlink */
321         case -ENOENT:
322                 break;
323         default:                /* error */
324                 warn("output irq status %d received", urb->status);
325         }
326
327         spin_lock_irqsave(&usbhid->outlock, flags);
328
329         if (unplug)
330                 usbhid->outtail = usbhid->outhead;
331         else
332                 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
333
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);
338                 }
339                 spin_unlock_irqrestore(&usbhid->outlock, flags);
340                 return;
341         }
342
343         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
344         spin_unlock_irqrestore(&usbhid->outlock, flags);
345         wake_up(&usbhid->wait);
346 }
347
348 /*
349  * Control pipe completion handler.
350  */
351
352 static void hid_ctrl(struct urb *urb)
353 {
354         struct hid_device *hid = urb->context;
355         struct usbhid_device *usbhid = hid->driver_data;
356         unsigned long flags;
357         int unplug = 0;
358
359         spin_lock_irqsave(&usbhid->ctrllock, flags);
360
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);
367                 break;
368         case -ESHUTDOWN:        /* unplug */
369                 unplug = 1;
370         case -EILSEQ:           /* protocol error or unplug */
371         case -EPROTO:           /* protocol error or unplug */
372         case -ECONNRESET:       /* unlink */
373         case -ENOENT:
374         case -EPIPE:            /* report not available */
375                 break;
376         default:                /* error */
377                 warn("ctrl urb status %d received", urb->status);
378         }
379
380         if (unplug)
381                 usbhid->ctrltail = usbhid->ctrlhead;
382         else
383                 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
384
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);
389                 }
390                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
391                 return;
392         }
393
394         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
395         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
396         wake_up(&usbhid->wait);
397 }
398
399 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
400 {
401         int head;
402         unsigned long flags;
403         struct usbhid_device *usbhid = hid->driver_data;
404
405         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
406                 return;
407
408         if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
409
410                 spin_lock_irqsave(&usbhid->outlock, flags);
411
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");
415                         return;
416                 }
417
418                 usbhid->out[usbhid->outhead] = report;
419                 usbhid->outhead = head;
420
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);
424
425                 spin_unlock_irqrestore(&usbhid->outlock, flags);
426                 return;
427         }
428
429         spin_lock_irqsave(&usbhid->ctrllock, flags);
430
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");
434                 return;
435         }
436
437         usbhid->ctrl[usbhid->ctrlhead].report = report;
438         usbhid->ctrl[usbhid->ctrlhead].dir = dir;
439         usbhid->ctrlhead = head;
440
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);
444
445         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
446 }
447
448 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
449 {
450         struct hid_device *hid = input_get_drvdata(dev);
451         struct hid_field *field;
452         int offset;
453
454         if (type == EV_FF)
455                 return input_ff_event(dev, type, code, value);
456
457         if (type != EV_LED)
458                 return -1;
459
460         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
461                 warn("event field not found");
462                 return -1;
463         }
464
465         hid_set_field(field, offset, value);
466         usbhid_submit_report(hid, field->report, USB_DIR_OUT);
467
468         return 0;
469 }
470
471 int usbhid_wait_io(struct hid_device *hid)
472 {
473         struct usbhid_device *usbhid = hid->driver_data;
474
475         if (!wait_event_timeout(usbhid->wait,
476                                 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
477                                 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
478                                         10*HZ)) {
479                 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
480                 return -1;
481         }
482
483         return 0;
484 }
485
486 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
487 {
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);
491 }
492
493 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
494                 unsigned char type, void *buf, int size)
495 {
496         int result, retries = 4;
497
498         memset(buf, 0, size);
499
500         do {
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);
504                 retries--;
505         } while (result < size && retries);
506         return result;
507 }
508
509 int usbhid_open(struct hid_device *hid)
510 {
511         struct usbhid_device *usbhid = hid->driver_data;
512         int res;
513
514         if (!hid->open++) {
515                 res = usb_autopm_get_interface(usbhid->intf);
516                 if (res < 0) {
517                         hid->open--;
518                         return -EIO;
519                 }
520         }
521         if (hid_start_in(hid))
522                 hid_io_error(hid);
523         return 0;
524 }
525
526 void usbhid_close(struct hid_device *hid)
527 {
528         struct usbhid_device *usbhid = hid->driver_data;
529
530         if (!--hid->open) {
531                 usb_kill_urb(usbhid->urbin);
532                 usb_autopm_put_interface(usbhid->intf);
533         }
534 }
535
536 /*
537  * Initialize all reports
538  */
539
540 void usbhid_init_reports(struct hid_device *hid)
541 {
542         struct hid_report *report;
543         struct usbhid_device *usbhid = hid->driver_data;
544         int err, ret;
545
546         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
547                 usbhid_submit_report(hid, report, USB_DIR_IN);
548
549         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
550                 usbhid_submit_report(hid, report, USB_DIR_IN);
551
552         err = 0;
553         ret = usbhid_wait_io(hid);
554         while (ret) {
555                 err |= ret;
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);
561         }
562
563         if (err)
564                 warn("timeout initializing reports");
565 }
566
567 /*
568  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
569  */
570 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
571     unsigned int hid_code, struct hid_field **pfield)
572 {
573         struct hid_report *report;
574         struct hid_field *field;
575         struct hid_usage *usage;
576         int i, j;
577
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) {
585                                         *pfield = field;
586                                         return j;
587                                 }
588                         }
589                 }
590         }
591         return -1;
592 }
593
594 void usbhid_set_leds(struct hid_device *hid)
595 {
596         struct hid_field *field;
597         int offset;
598
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);
602         }
603 }
604 EXPORT_SYMBOL_GPL(usbhid_set_leds);
605
606 /*
607  * Traverse the supplied list of reports and find the longest
608  */
609 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
610                 unsigned int *max)
611 {
612         struct hid_report *report;
613         unsigned int size;
614
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)
618                         size++;
619                 if (*max < size)
620                         *max = size;
621         }
622 }
623
624 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
625 {
626         struct usbhid_device *usbhid = hid->driver_data;
627
628         if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
629                 return -1;
630         if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
631                 return -1;
632         if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
633                 return -1;
634         if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
635                 return -1;
636
637         return 0;
638 }
639
640 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
641 {
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;
646         int ret;
647
648         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
649                 HID_REQ_SET_REPORT,
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);
654
655         /* count also the report id */
656         if (ret > 0)
657                 ret++;
658
659         return ret;
660 }
661
662 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
663 {
664         struct usbhid_device *usbhid = hid->driver_data;
665
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);
670 }
671
672 static int usbhid_parse(struct hid_device *hid)
673 {
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;
678         u32 quirks = 0;
679         unsigned int rsize = 0;
680         char *rdesc;
681         int ret, n;
682
683         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
684                         le16_to_cpu(dev->descriptor.idProduct));
685
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;
692         }
693
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");
698                 return -ENODEV;
699         }
700
701         hid->version = le16_to_cpu(hdesc->bcdHID);
702         hid->country = hdesc->bCountryCode;
703
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);
707
708         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
709                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
710                 return -EINVAL;
711         }
712
713         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
714                 dbg_hid("couldn't allocate rdesc memory\n");
715                 return -ENOMEM;
716         }
717
718         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
719
720         ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
721                         HID_DT_REPORT, rdesc, rsize);
722         if (ret < 0) {
723                 dbg_hid("reading report descriptor failed\n");
724                 kfree(rdesc);
725                 goto err;
726         }
727
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]);
731         dbg_hid_line("\n");
732
733         ret = hid_parse_report(hid, rdesc, rsize);
734         kfree(rdesc);
735         if (ret) {
736                 dbg_hid("parsing report descriptor failed\n");
737                 goto err;
738         }
739
740         hid->quirks = quirks;
741
742         return 0;
743 err:
744         return ret;
745 }
746
747 static int usbhid_start(struct hid_device *hid)
748 {
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;
754         int ret;
755
756         WARN_ON(hid->driver_data);
757
758         usbhid = kzalloc(sizeof(struct usbhid_device), GFP_KERNEL);
759         if (usbhid == NULL) {
760                 ret = -ENOMEM;
761                 goto err;
762         }
763
764         hid->driver_data = usbhid;
765         usbhid->hid = hid;
766
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);
771
772         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
773                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
774
775         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
776
777         if (insize > HID_MAX_BUFFER_SIZE)
778                 insize = HID_MAX_BUFFER_SIZE;
779
780         if (hid_alloc_buffers(dev, hid)) {
781                 ret = -ENOMEM;
782                 goto fail;
783         }
784
785         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
786                 struct usb_endpoint_descriptor *endpoint;
787                 int pipe;
788                 int interval;
789
790                 endpoint = &interface->endpoint[n].desc;
791                 if ((endpoint->bmAttributes & 3) != 3)          /* Not an interrupt endpoint */
792                         continue;
793
794                 interval = endpoint->bInterval;
795
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);
802                 }
803
804                 /* Change the polling interval of mice. */
805                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
806                         interval = hid_mousepoll_interval;
807
808                 ret = -ENOMEM;
809                 if (usb_endpoint_dir_in(endpoint)) {
810                         if (usbhid->urbin)
811                                 continue;
812                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
813                                 goto fail;
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;
819                 } else {
820                         if (usbhid->urbout)
821                                 continue;
822                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
823                                 goto fail;
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;
829                 }
830         }
831
832         if (!usbhid->urbin) {
833                 err_hid("couldn't find an input interrupt endpoint");
834                 ret = -ENODEV;
835                 goto fail;
836         }
837
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);
841
842         spin_lock_init(&usbhid->inlock);
843         spin_lock_init(&usbhid->outlock);
844         spin_lock_init(&usbhid->ctrllock);
845
846         usbhid->intf = intf;
847         usbhid->ifnum = interface->desc.bInterfaceNumber;
848
849         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
850         if (!usbhid->urbctrl) {
851                 ret = -ENOMEM;
852                 goto fail;
853         }
854
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);
860
861         usbhid_init_reports(hid);
862         hid_dump_device(hid);
863
864         return 0;
865
866 fail:
867         usb_free_urb(usbhid->urbin);
868         usb_free_urb(usbhid->urbout);
869         usb_free_urb(usbhid->urbctrl);
870         hid_free_buffers(dev, hid);
871         kfree(usbhid);
872 err:
873         return ret;
874 }
875
876 static void usbhid_stop(struct hid_device *hid)
877 {
878         struct usbhid_device *usbhid = hid->driver_data;
879
880         if (WARN_ON(!usbhid))
881                 return;
882
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);
889
890         del_timer_sync(&usbhid->io_retry);
891         cancel_work_sync(&usbhid->reset_work);
892
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);
899
900         hid->claimed = 0;
901
902         usb_free_urb(usbhid->urbin);
903         usb_free_urb(usbhid->urbctrl);
904         usb_free_urb(usbhid->urbout);
905
906         hid_free_buffers(hid_to_usb_dev(hid), hid);
907         kfree(usbhid);
908         hid->driver_data = NULL;
909 }
910
911 static struct hid_ll_driver usb_hid_driver = {
912         .parse = usbhid_parse,
913         .start = usbhid_start,
914         .stop = usbhid_stop,
915         .open = usbhid_open,
916         .close = usbhid_close,
917         .hidinput_input_event = usb_hidinput_input_event,
918 };
919
920 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
921 {
922         struct usb_device *dev = interface_to_usbdev(intf);
923         struct hid_device *hid;
924         size_t len;
925         int ret;
926
927         dbg_hid("HID probe called for ifnum %d\n",
928                         intf->altsetting->desc.bInterfaceNumber);
929
930         hid = hid_allocate_device();
931         if (IS_ERR(hid))
932                 return PTR_ERR(hid);
933
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;
942 #endif
943         hid->dev.parent = &intf->dev;
944         hid->bus = BUS_USB;
945         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
946         hid->product = le16_to_cpu(dev->descriptor.idProduct);
947         hid->name[0] = 0;
948
949         if (dev->manufacturer)
950                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
951
952         if (dev->product) {
953                 if (dev->manufacturer)
954                         strlcat(hid->name, " ", sizeof(hid->name));
955                 strlcat(hid->name, dev->product, sizeof(hid->name));
956         }
957
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));
962
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);
969
970         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
971                 hid->uniq[0] = 0;
972
973         ret = hid_add_device(hid);
974         if (ret) {
975                 if (ret != -ENODEV)
976                         dev_err(&intf->dev, "can't add hid device: %d\n", ret);
977                 goto err;
978         }
979
980         return 0;
981 err:
982         hid_destroy_device(hid);
983         return ret;
984 }
985
986 static void hid_disconnect(struct usb_interface *intf)
987 {
988         struct hid_device *hid = usb_get_intfdata(intf);
989
990         if (WARN_ON(!hid))
991                 return;
992
993         hid_destroy_device(hid);
994 }
995
996 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
997 {
998         struct hid_device *hid = usb_get_intfdata (intf);
999         struct usbhid_device *usbhid = hid->driver_data;
1000
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");
1007         return 0;
1008 }
1009
1010 static int hid_resume(struct usb_interface *intf)
1011 {
1012         struct hid_device *hid = usb_get_intfdata (intf);
1013         struct usbhid_device *usbhid = hid->driver_data;
1014         int status;
1015
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);
1020         return status;
1021 }
1022
1023 /* Treat USB reset pretty much the same as suspend/resume */
1024 static int hid_pre_reset(struct usb_interface *intf)
1025 {
1026         /* FIXME: What if the interface is already suspended? */
1027         hid_suspend(intf, PMSG_ON);
1028         return 0;
1029 }
1030
1031 /* Same routine used for post_reset and reset_resume */
1032 static int hid_post_reset(struct usb_interface *intf)
1033 {
1034         struct usb_device *dev = interface_to_usbdev (intf);
1035
1036         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1037         /* FIXME: Any more reinitialization needed? */
1038
1039         return hid_resume(intf);
1040 }
1041
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 */
1046 };
1047
1048 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1049
1050 static struct usb_driver hid_driver = {
1051         .name =         "usbhid",
1052         .probe =        hid_probe,
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,
1061 };
1062
1063 static const struct hid_device_id hid_usb_table[] = {
1064         { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1065         { }
1066 };
1067
1068 static struct hid_driver hid_usb_driver = {
1069         .name = "generic-usb",
1070         .id_table = hid_usb_table,
1071 };
1072
1073 static int __init hid_init(void)
1074 {
1075         int retval;
1076         retval = hid_register_driver(&hid_usb_driver);
1077         if (retval)
1078                 goto hid_register_fail;
1079         retval = usbhid_quirks_init(quirks_param);
1080         if (retval)
1081                 goto usbhid_quirks_init_fail;
1082         retval = hiddev_init();
1083         if (retval)
1084                 goto hiddev_init_fail;
1085         retval = usb_register(&hid_driver);
1086         if (retval)
1087                 goto usb_register_fail;
1088         info(DRIVER_VERSION ":" DRIVER_DESC);
1089
1090         return 0;
1091 usb_register_fail:
1092         hiddev_exit();
1093 hiddev_init_fail:
1094         usbhid_quirks_exit();
1095 usbhid_quirks_init_fail:
1096         hid_unregister_driver(&hid_usb_driver);
1097 hid_register_fail:
1098         return retval;
1099 }
1100
1101 static void __exit hid_exit(void)
1102 {
1103         usb_deregister(&hid_driver);
1104         hiddev_exit();
1105         usbhid_quirks_exit();
1106         hid_unregister_driver(&hid_usb_driver);
1107 }
1108
1109 module_init(hid_init);
1110 module_exit(hid_exit);
1111
1112 MODULE_AUTHOR(DRIVER_AUTHOR);
1113 MODULE_DESCRIPTION(DRIVER_DESC);
1114 MODULE_LICENSE(DRIVER_LICENSE);