6a510c9675fc36e70171adeb4bfe201d186d2fb5
[linux-2.6.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) 2007-2008 Oliver Neukum
8  *  Copyright (c) 2006-2010 Jiri Kosina
9  */
10
11 /*
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 2 of the License, or (at your option)
15  * any later version.
16  */
17
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/init.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/mm.h>
24 #include <linux/mutex.h>
25 #include <linux/spinlock.h>
26 #include <asm/unaligned.h>
27 #include <asm/byteorder.h>
28 #include <linux/input.h>
29 #include <linux/wait.h>
30 #include <linux/workqueue.h>
31
32 #include <linux/usb.h>
33
34 #include <linux/hid.h>
35 #include <linux/hiddev.h>
36 #include <linux/hid-debug.h>
37 #include <linux/hidraw.h>
38 #include "usbhid.h"
39
40 /*
41  * Version Information
42  */
43
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 static unsigned int ignoreled;
56 module_param_named(ignoreled, ignoreled, uint, 0644);
57 MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
58
59 /* Quirks specified at module load time */
60 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
61 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
62 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
63                 " quirks=vendorID:productID:quirks"
64                 " where vendorID, productID, and quirks are all in"
65                 " 0x-prefixed hex");
66 /*
67  * Input submission and I/O error handler.
68  */
69 static DEFINE_MUTEX(hid_open_mut);
70 static struct workqueue_struct *resumption_waker;
71
72 static void hid_io_error(struct hid_device *hid);
73 static int hid_submit_out(struct hid_device *hid);
74 static int hid_submit_ctrl(struct hid_device *hid);
75 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
76
77 /* Start up the input URB */
78 static int hid_start_in(struct hid_device *hid)
79 {
80         unsigned long flags;
81         int rc = 0;
82         struct usbhid_device *usbhid = hid->driver_data;
83
84         spin_lock_irqsave(&usbhid->lock, flags);
85         if (hid->open > 0 &&
86                         !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
87                         !test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
88                         !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
89                 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
90                 if (rc != 0)
91                         clear_bit(HID_IN_RUNNING, &usbhid->iofl);
92         }
93         spin_unlock_irqrestore(&usbhid->lock, flags);
94         return rc;
95 }
96
97 /* I/O retry timer routine */
98 static void hid_retry_timeout(unsigned long _hid)
99 {
100         struct hid_device *hid = (struct hid_device *) _hid;
101         struct usbhid_device *usbhid = hid->driver_data;
102
103         dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
104         if (hid_start_in(hid))
105                 hid_io_error(hid);
106 }
107
108 /* Workqueue routine to reset the device or clear a halt */
109 static void hid_reset(struct work_struct *work)
110 {
111         struct usbhid_device *usbhid =
112                 container_of(work, struct usbhid_device, reset_work);
113         struct hid_device *hid = usbhid->hid;
114         int rc = 0;
115
116         if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
117                 dev_dbg(&usbhid->intf->dev, "clear halt\n");
118                 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
119                 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
120                 hid_start_in(hid);
121         }
122
123         else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
124                 dev_dbg(&usbhid->intf->dev, "resetting device\n");
125                 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
126                 if (rc == 0) {
127                         rc = usb_reset_device(hid_to_usb_dev(hid));
128                         usb_unlock_device(hid_to_usb_dev(hid));
129                 }
130                 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
131         }
132
133         switch (rc) {
134         case 0:
135                 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
136                         hid_io_error(hid);
137                 break;
138         default:
139                 err_hid("can't reset device, %s-%s/input%d, status %d",
140                                 hid_to_usb_dev(hid)->bus->bus_name,
141                                 hid_to_usb_dev(hid)->devpath,
142                                 usbhid->ifnum, rc);
143                 /* FALLTHROUGH */
144         case -EHOSTUNREACH:
145         case -ENODEV:
146         case -EINTR:
147                 break;
148         }
149 }
150
151 /* Main I/O error handler */
152 static void hid_io_error(struct hid_device *hid)
153 {
154         unsigned long flags;
155         struct usbhid_device *usbhid = hid->driver_data;
156
157         spin_lock_irqsave(&usbhid->lock, flags);
158
159         /* Stop when disconnected */
160         if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
161                 goto done;
162
163         /* If it has been a while since the last error, we'll assume
164          * this a brand new error and reset the retry timeout. */
165         if (time_after(jiffies, usbhid->stop_retry + HZ/2))
166                 usbhid->retry_delay = 0;
167
168         /* When an error occurs, retry at increasing intervals */
169         if (usbhid->retry_delay == 0) {
170                 usbhid->retry_delay = 13;       /* Then 26, 52, 104, 104, ... */
171                 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
172         } else if (usbhid->retry_delay < 100)
173                 usbhid->retry_delay *= 2;
174
175         if (time_after(jiffies, usbhid->stop_retry)) {
176
177                 /* Retries failed, so do a port reset */
178                 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
179                         schedule_work(&usbhid->reset_work);
180                         goto done;
181                 }
182         }
183
184         mod_timer(&usbhid->io_retry,
185                         jiffies + msecs_to_jiffies(usbhid->retry_delay));
186 done:
187         spin_unlock_irqrestore(&usbhid->lock, flags);
188 }
189
190 static void usbhid_mark_busy(struct usbhid_device *usbhid)
191 {
192         struct usb_interface *intf = usbhid->intf;
193
194         usb_mark_last_busy(interface_to_usbdev(intf));
195 }
196
197 static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
198 {
199         struct hid_device *hid = usb_get_intfdata(usbhid->intf);
200         int kicked;
201
202         if (!hid)
203                 return 0;
204
205         if ((kicked = (usbhid->outhead != usbhid->outtail))) {
206                 dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
207                 if (hid_submit_out(hid)) {
208                         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
209                         wake_up(&usbhid->wait);
210                 }
211         }
212         return kicked;
213 }
214
215 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
216 {
217         struct hid_device *hid = usb_get_intfdata(usbhid->intf);
218         int kicked;
219
220         WARN_ON(hid == NULL);
221         if (!hid)
222                 return 0;
223
224         if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
225                 dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
226                 if (hid_submit_ctrl(hid)) {
227                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
228                         wake_up(&usbhid->wait);
229                 }
230         }
231         return kicked;
232 }
233
234 /*
235  * Input interrupt completion handler.
236  */
237
238 static void hid_irq_in(struct urb *urb)
239 {
240         struct hid_device       *hid = urb->context;
241         struct usbhid_device    *usbhid = hid->driver_data;
242         int                     status;
243
244         switch (urb->status) {
245         case 0:                 /* success */
246                 usbhid_mark_busy(usbhid);
247                 usbhid->retry_delay = 0;
248                 hid_input_report(urb->context, HID_INPUT_REPORT,
249                                  urb->transfer_buffer,
250                                  urb->actual_length, 1);
251                 /*
252                  * autosuspend refused while keys are pressed
253                  * because most keyboards don't wake up when
254                  * a key is released
255                  */
256                 if (hid_check_keys_pressed(hid))
257                         set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
258                 else
259                         clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
260                 break;
261         case -EPIPE:            /* stall */
262                 usbhid_mark_busy(usbhid);
263                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
264                 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
265                 schedule_work(&usbhid->reset_work);
266                 return;
267         case -ECONNRESET:       /* unlink */
268         case -ENOENT:
269         case -ESHUTDOWN:        /* unplug */
270                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
271                 return;
272         case -EILSEQ:           /* protocol error or unplug */
273         case -EPROTO:           /* protocol error or unplug */
274         case -ETIME:            /* protocol error or unplug */
275         case -ETIMEDOUT:        /* Should never happen, but... */
276                 usbhid_mark_busy(usbhid);
277                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
278                 hid_io_error(hid);
279                 return;
280         default:                /* error */
281                 dev_warn(&urb->dev->dev, "input irq status %d  "
282                                 "received\n", urb->status);
283         }
284
285         status = usb_submit_urb(urb, GFP_ATOMIC);
286         if (status) {
287                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
288                 if (status != -EPERM) {
289                         err_hid("can't resubmit intr, %s-%s/input%d, status %d",
290                                         hid_to_usb_dev(hid)->bus->bus_name,
291                                         hid_to_usb_dev(hid)->devpath,
292                                         usbhid->ifnum, status);
293                         hid_io_error(hid);
294                 }
295         }
296 }
297
298 static int hid_submit_out(struct hid_device *hid)
299 {
300         struct hid_report *report;
301         char *raw_report;
302         struct usbhid_device *usbhid = hid->driver_data;
303
304         report = usbhid->out[usbhid->outtail].report;
305         raw_report = usbhid->out[usbhid->outtail].raw_report;
306
307         if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
308                 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
309                 usbhid->urbout->dev = hid_to_usb_dev(hid);
310                 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
311                 kfree(raw_report);
312
313                 dbg_hid("submitting out urb\n");
314
315                 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
316                         err_hid("usb_submit_urb(out) failed");
317                         return -1;
318                 }
319                 usbhid->last_out = jiffies;
320         } else {
321                 /*
322                  * queue work to wake up the device.
323                  * as the work queue is freezeable, this is safe
324                  * with respect to STD and STR
325                  */
326                 queue_work(resumption_waker, &usbhid->restart_work);
327         }
328
329         return 0;
330 }
331
332 static int hid_submit_ctrl(struct hid_device *hid)
333 {
334         struct hid_report *report;
335         unsigned char dir;
336         char *raw_report;
337         int len;
338         struct usbhid_device *usbhid = hid->driver_data;
339
340         report = usbhid->ctrl[usbhid->ctrltail].report;
341         raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
342         dir = usbhid->ctrl[usbhid->ctrltail].dir;
343
344         if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
345                 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
346                 if (dir == USB_DIR_OUT) {
347                         usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
348                         usbhid->urbctrl->transfer_buffer_length = len;
349                         memcpy(usbhid->ctrlbuf, raw_report, len);
350                         kfree(raw_report);
351                 } else {
352                         int maxpacket, padlen;
353
354                         usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
355                         maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
356                         if (maxpacket > 0) {
357                                 padlen = DIV_ROUND_UP(len, maxpacket);
358                                 padlen *= maxpacket;
359                                 if (padlen > usbhid->bufsize)
360                                         padlen = usbhid->bufsize;
361                         } else
362                                 padlen = 0;
363                         usbhid->urbctrl->transfer_buffer_length = padlen;
364                 }
365                 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
366
367                 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
368                 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
369                 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
370                 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
371                 usbhid->cr->wLength = cpu_to_le16(len);
372
373                 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
374                         usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
375                         usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
376
377                 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
378                         err_hid("usb_submit_urb(ctrl) failed");
379                         return -1;
380                 }
381                 usbhid->last_ctrl = jiffies;
382         } else {
383                 /*
384                  * queue work to wake up the device.
385                  * as the work queue is freezeable, this is safe
386                  * with respect to STD and STR
387                  */
388                 queue_work(resumption_waker, &usbhid->restart_work);
389         }
390
391         return 0;
392 }
393
394 /*
395  * Output interrupt completion handler.
396  */
397
398 static void hid_irq_out(struct urb *urb)
399 {
400         struct hid_device *hid = urb->context;
401         struct usbhid_device *usbhid = hid->driver_data;
402         unsigned long flags;
403         int unplug = 0;
404
405         switch (urb->status) {
406         case 0:                 /* success */
407                 break;
408         case -ESHUTDOWN:        /* unplug */
409                 unplug = 1;
410         case -EILSEQ:           /* protocol error or unplug */
411         case -EPROTO:           /* protocol error or unplug */
412         case -ECONNRESET:       /* unlink */
413         case -ENOENT:
414                 break;
415         default:                /* error */
416                 dev_warn(&urb->dev->dev, "output irq status %d "
417                                 "received\n", urb->status);
418         }
419
420         spin_lock_irqsave(&usbhid->lock, flags);
421
422         if (unplug)
423                 usbhid->outtail = usbhid->outhead;
424         else
425                 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
426
427         if (usbhid->outhead != usbhid->outtail) {
428                 if (hid_submit_out(hid)) {
429                         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
430                         wake_up(&usbhid->wait);
431                 }
432                 spin_unlock_irqrestore(&usbhid->lock, flags);
433                 return;
434         }
435
436         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
437         spin_unlock_irqrestore(&usbhid->lock, flags);
438         wake_up(&usbhid->wait);
439 }
440
441 /*
442  * Control pipe completion handler.
443  */
444
445 static void hid_ctrl(struct urb *urb)
446 {
447         struct hid_device *hid = urb->context;
448         struct usbhid_device *usbhid = hid->driver_data;
449         int unplug = 0, status = urb->status;
450
451         spin_lock(&usbhid->lock);
452
453         switch (status) {
454         case 0:                 /* success */
455                 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
456                         hid_input_report(urb->context,
457                                 usbhid->ctrl[usbhid->ctrltail].report->type,
458                                 urb->transfer_buffer, urb->actual_length, 0);
459                 break;
460         case -ESHUTDOWN:        /* unplug */
461                 unplug = 1;
462         case -EILSEQ:           /* protocol error or unplug */
463         case -EPROTO:           /* protocol error or unplug */
464         case -ECONNRESET:       /* unlink */
465         case -ENOENT:
466         case -EPIPE:            /* report not available */
467                 break;
468         default:                /* error */
469                 dev_warn(&urb->dev->dev, "ctrl urb status %d "
470                                 "received\n", status);
471         }
472
473         if (unplug)
474                 usbhid->ctrltail = usbhid->ctrlhead;
475         else
476                 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
477
478         if (usbhid->ctrlhead != usbhid->ctrltail) {
479                 if (hid_submit_ctrl(hid)) {
480                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
481                         wake_up(&usbhid->wait);
482                 }
483                 spin_unlock(&usbhid->lock);
484                 return;
485         }
486
487         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
488         spin_unlock(&usbhid->lock);
489         wake_up(&usbhid->wait);
490 }
491
492 static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
493                                    unsigned char dir)
494 {
495         int head;
496         struct usbhid_device *usbhid = hid->driver_data;
497         int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
498
499         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
500                 return;
501
502         if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
503                 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
504                         dev_warn(&hid->dev, "output queue full\n");
505                         return;
506                 }
507
508                 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
509                 if (!usbhid->out[usbhid->outhead].raw_report) {
510                         dev_warn(&hid->dev, "output queueing failed\n");
511                         return;
512                 }
513                 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
514                 usbhid->out[usbhid->outhead].report = report;
515                 usbhid->outhead = head;
516
517                 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
518                         if (hid_submit_out(hid))
519                                 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
520                 } else {
521                         /*
522                          * the queue is known to run
523                          * but an earlier request may be stuck
524                          * we may need to time out
525                          * no race because this is called under
526                          * spinlock
527                          */
528                         if (time_after(jiffies, usbhid->last_out + HZ * 5))
529                                 usb_unlink_urb(usbhid->urbout);
530                 }
531                 return;
532         }
533
534         if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
535                 dev_warn(&hid->dev, "control queue full\n");
536                 return;
537         }
538
539         if (dir == USB_DIR_OUT) {
540                 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
541                 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
542                         dev_warn(&hid->dev, "control queueing failed\n");
543                         return;
544                 }
545                 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
546         }
547         usbhid->ctrl[usbhid->ctrlhead].report = report;
548         usbhid->ctrl[usbhid->ctrlhead].dir = dir;
549         usbhid->ctrlhead = head;
550
551         if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
552                 if (hid_submit_ctrl(hid))
553                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
554         } else {
555                 /*
556                  * the queue is known to run
557                  * but an earlier request may be stuck
558                  * we may need to time out
559                  * no race because this is called under
560                  * spinlock
561                  */
562                 if (time_after(jiffies, usbhid->last_ctrl + HZ * 5))
563                         usb_unlink_urb(usbhid->urbctrl);
564         }
565 }
566
567 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
568 {
569         struct usbhid_device *usbhid = hid->driver_data;
570         unsigned long flags;
571
572         spin_lock_irqsave(&usbhid->lock, flags);
573         __usbhid_submit_report(hid, report, dir);
574         spin_unlock_irqrestore(&usbhid->lock, flags);
575 }
576 EXPORT_SYMBOL_GPL(usbhid_submit_report);
577
578 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
579 {
580         struct hid_device *hid = input_get_drvdata(dev);
581         struct usbhid_device *usbhid = hid->driver_data;
582         struct hid_field *field;
583         unsigned long flags;
584         int offset;
585
586         if (type == EV_FF)
587                 return input_ff_event(dev, type, code, value);
588
589         if (type != EV_LED)
590                 return -1;
591
592         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
593                 dev_warn(&dev->dev, "event field not found\n");
594                 return -1;
595         }
596
597         hid_set_field(field, offset, value);
598         if (value) {
599                 spin_lock_irqsave(&usbhid->lock, flags);
600                 usbhid->ledcount++;
601                 spin_unlock_irqrestore(&usbhid->lock, flags);
602         } else {
603                 spin_lock_irqsave(&usbhid->lock, flags);
604                 usbhid->ledcount--;
605                 spin_unlock_irqrestore(&usbhid->lock, flags);
606         }
607         usbhid_submit_report(hid, field->report, USB_DIR_OUT);
608
609         return 0;
610 }
611
612 int usbhid_wait_io(struct hid_device *hid)
613 {
614         struct usbhid_device *usbhid = hid->driver_data;
615
616         if (!wait_event_timeout(usbhid->wait,
617                                 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
618                                 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
619                                         10*HZ)) {
620                 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
621                 return -1;
622         }
623
624         return 0;
625 }
626
627 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
628 {
629         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
630                 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
631                 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
632 }
633
634 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
635                 unsigned char type, void *buf, int size)
636 {
637         int result, retries = 4;
638
639         memset(buf, 0, size);
640
641         do {
642                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
643                                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
644                                 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
645                 retries--;
646         } while (result < size && retries);
647         return result;
648 }
649
650 int usbhid_open(struct hid_device *hid)
651 {
652         struct usbhid_device *usbhid = hid->driver_data;
653         int res;
654
655         mutex_lock(&hid_open_mut);
656         if (!hid->open++) {
657                 res = usb_autopm_get_interface(usbhid->intf);
658                 /* the device must be awake to reliable request remote wakeup */
659                 if (res < 0) {
660                         hid->open--;
661                         mutex_unlock(&hid_open_mut);
662                         return -EIO;
663                 }
664                 usbhid->intf->needs_remote_wakeup = 1;
665                 if (hid_start_in(hid))
666                         hid_io_error(hid);
667  
668                 usb_autopm_put_interface(usbhid->intf);
669         }
670         mutex_unlock(&hid_open_mut);
671         return 0;
672 }
673
674 void usbhid_close(struct hid_device *hid)
675 {
676         struct usbhid_device *usbhid = hid->driver_data;
677
678         mutex_lock(&hid_open_mut);
679
680         /* protecting hid->open to make sure we don't restart
681          * data acquistion due to a resumption we no longer
682          * care about
683          */
684         spin_lock_irq(&usbhid->lock);
685         if (!--hid->open) {
686                 spin_unlock_irq(&usbhid->lock);
687                 hid_cancel_delayed_stuff(usbhid);
688                 usb_kill_urb(usbhid->urbin);
689                 usbhid->intf->needs_remote_wakeup = 0;
690         } else {
691                 spin_unlock_irq(&usbhid->lock);
692         }
693         mutex_unlock(&hid_open_mut);
694 }
695
696 /*
697  * Initialize all reports
698  */
699
700 void usbhid_init_reports(struct hid_device *hid)
701 {
702         struct hid_report *report;
703         struct usbhid_device *usbhid = hid->driver_data;
704         int err, ret;
705
706         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
707                 usbhid_submit_report(hid, report, USB_DIR_IN);
708
709         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
710                 usbhid_submit_report(hid, report, USB_DIR_IN);
711
712         err = 0;
713         ret = usbhid_wait_io(hid);
714         while (ret) {
715                 err |= ret;
716                 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
717                         usb_kill_urb(usbhid->urbctrl);
718                 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
719                         usb_kill_urb(usbhid->urbout);
720                 ret = usbhid_wait_io(hid);
721         }
722
723         if (err)
724                 dev_warn(&hid->dev, "timeout initializing reports\n");
725 }
726
727 /*
728  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
729  */
730 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
731     unsigned int hid_code, struct hid_field **pfield)
732 {
733         struct hid_report *report;
734         struct hid_field *field;
735         struct hid_usage *usage;
736         int i, j;
737
738         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
739                 for (i = 0; i < report->maxfield; i++) {
740                         field = report->field[i];
741                         for (j = 0; j < field->maxusage; j++) {
742                                 usage = &field->usage[j];
743                                 if ((usage->hid & HID_USAGE_PAGE) == page &&
744                                     (usage->hid & 0xFFFF) == hid_code) {
745                                         *pfield = field;
746                                         return j;
747                                 }
748                         }
749                 }
750         }
751         return -1;
752 }
753
754 void usbhid_set_leds(struct hid_device *hid)
755 {
756         struct hid_field *field;
757         int offset;
758
759         if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
760                 hid_set_field(field, offset, 0);
761                 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
762         }
763 }
764 EXPORT_SYMBOL_GPL(usbhid_set_leds);
765
766 /*
767  * Traverse the supplied list of reports and find the longest
768  */
769 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
770                 unsigned int *max)
771 {
772         struct hid_report *report;
773         unsigned int size;
774
775         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
776                 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
777                 if (*max < size)
778                         *max = size;
779         }
780 }
781
782 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
783 {
784         struct usbhid_device *usbhid = hid->driver_data;
785
786         usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
787                         &usbhid->inbuf_dma);
788         usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
789                         &usbhid->outbuf_dma);
790         usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
791         usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
792                         &usbhid->ctrlbuf_dma);
793         if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
794                         !usbhid->ctrlbuf)
795                 return -1;
796
797         return 0;
798 }
799
800 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count,
801                 unsigned char report_type)
802 {
803         struct usbhid_device *usbhid = hid->driver_data;
804         struct usb_device *dev = hid_to_usb_dev(hid);
805         struct usb_interface *intf = usbhid->intf;
806         struct usb_host_interface *interface = intf->cur_altsetting;
807         int ret;
808
809         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
810                 HID_REQ_SET_REPORT,
811                 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
812                 ((report_type + 1) << 8) | *buf,
813                 interface->desc.bInterfaceNumber, buf + 1, count - 1,
814                 USB_CTRL_SET_TIMEOUT);
815
816         /* count also the report id */
817         if (ret > 0)
818                 ret++;
819
820         return ret;
821 }
822
823 static void usbhid_restart_queues(struct usbhid_device *usbhid)
824 {
825         if (usbhid->urbout)
826                 usbhid_restart_out_queue(usbhid);
827         usbhid_restart_ctrl_queue(usbhid);
828 }
829
830 static void __usbhid_restart_queues(struct work_struct *work)
831 {
832         struct usbhid_device *usbhid =
833                 container_of(work, struct usbhid_device, restart_work);
834         int r;
835
836         r = usb_autopm_get_interface(usbhid->intf);
837         if (r < 0)
838                 return;
839         usb_autopm_put_interface(usbhid->intf);
840 }
841
842 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
843 {
844         struct usbhid_device *usbhid = hid->driver_data;
845
846         usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
847         usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
848         kfree(usbhid->cr);
849         usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
850 }
851
852 static int usbhid_parse(struct hid_device *hid)
853 {
854         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
855         struct usb_host_interface *interface = intf->cur_altsetting;
856         struct usb_device *dev = interface_to_usbdev (intf);
857         struct hid_descriptor *hdesc;
858         u32 quirks = 0;
859         unsigned int rsize = 0;
860         char *rdesc;
861         int ret, n;
862
863         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
864                         le16_to_cpu(dev->descriptor.idProduct));
865
866         if (quirks & HID_QUIRK_IGNORE)
867                 return -ENODEV;
868
869         /* Many keyboards and mice don't like to be polled for reports,
870          * so we will always set the HID_QUIRK_NOGET flag for them. */
871         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
872                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
873                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
874                                 quirks |= HID_QUIRK_NOGET;
875         }
876
877         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
878             (!interface->desc.bNumEndpoints ||
879              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
880                 dbg_hid("class descriptor not present\n");
881                 return -ENODEV;
882         }
883
884         hid->version = le16_to_cpu(hdesc->bcdHID);
885         hid->country = hdesc->bCountryCode;
886
887         for (n = 0; n < hdesc->bNumDescriptors; n++)
888                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
889                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
890
891         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
892                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
893                 return -EINVAL;
894         }
895
896         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
897                 dbg_hid("couldn't allocate rdesc memory\n");
898                 return -ENOMEM;
899         }
900
901         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
902
903         ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
904                         HID_DT_REPORT, rdesc, rsize);
905         if (ret < 0) {
906                 dbg_hid("reading report descriptor failed\n");
907                 kfree(rdesc);
908                 goto err;
909         }
910
911         ret = hid_parse_report(hid, rdesc, rsize);
912         kfree(rdesc);
913         if (ret) {
914                 dbg_hid("parsing report descriptor failed\n");
915                 goto err;
916         }
917
918         hid->quirks |= quirks;
919
920         return 0;
921 err:
922         return ret;
923 }
924
925 static int usbhid_start(struct hid_device *hid)
926 {
927         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
928         struct usb_host_interface *interface = intf->cur_altsetting;
929         struct usb_device *dev = interface_to_usbdev(intf);
930         struct usbhid_device *usbhid = hid->driver_data;
931         unsigned int n, insize = 0;
932         int ret;
933
934         clear_bit(HID_DISCONNECTED, &usbhid->iofl);
935
936         usbhid->bufsize = HID_MIN_BUFFER_SIZE;
937         hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
938         hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
939         hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
940
941         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
942                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
943
944         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
945
946         if (insize > HID_MAX_BUFFER_SIZE)
947                 insize = HID_MAX_BUFFER_SIZE;
948
949         if (hid_alloc_buffers(dev, hid)) {
950                 ret = -ENOMEM;
951                 goto fail;
952         }
953
954         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
955                 struct usb_endpoint_descriptor *endpoint;
956                 int pipe;
957                 int interval;
958
959                 endpoint = &interface->endpoint[n].desc;
960                 if (!usb_endpoint_xfer_int(endpoint))
961                         continue;
962
963                 interval = endpoint->bInterval;
964
965                 /* Some vendors give fullspeed interval on highspeed devides */
966                 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
967                     dev->speed == USB_SPEED_HIGH) {
968                         interval = fls(endpoint->bInterval*8);
969                         printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
970                                hid->name, endpoint->bInterval, interval);
971                 }
972
973                 /* Change the polling interval of mice. */
974                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
975                         interval = hid_mousepoll_interval;
976
977                 ret = -ENOMEM;
978                 if (usb_endpoint_dir_in(endpoint)) {
979                         if (usbhid->urbin)
980                                 continue;
981                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
982                                 goto fail;
983                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
984                         usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
985                                          hid_irq_in, hid, interval);
986                         usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
987                         usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
988                 } else {
989                         if (usbhid->urbout)
990                                 continue;
991                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
992                                 goto fail;
993                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
994                         usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
995                                          hid_irq_out, hid, interval);
996                         usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
997                         usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
998                 }
999         }
1000
1001         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1002         if (!usbhid->urbctrl) {
1003                 ret = -ENOMEM;
1004                 goto fail;
1005         }
1006
1007         usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1008                              usbhid->ctrlbuf, 1, hid_ctrl, hid);
1009         usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1010         usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1011
1012         if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1013                 usbhid_init_reports(hid);
1014
1015         set_bit(HID_STARTED, &usbhid->iofl);
1016
1017         /* Some keyboards don't work until their LEDs have been set.
1018          * Since BIOSes do set the LEDs, it must be safe for any device
1019          * that supports the keyboard boot protocol.
1020          */
1021         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1022                         interface->desc.bInterfaceProtocol ==
1023                                 USB_INTERFACE_PROTOCOL_KEYBOARD)
1024                 usbhid_set_leds(hid);
1025
1026         return 0;
1027
1028 fail:
1029         usb_free_urb(usbhid->urbin);
1030         usb_free_urb(usbhid->urbout);
1031         usb_free_urb(usbhid->urbctrl);
1032         usbhid->urbin = NULL;
1033         usbhid->urbout = NULL;
1034         usbhid->urbctrl = NULL;
1035         hid_free_buffers(dev, hid);
1036         return ret;
1037 }
1038
1039 static void usbhid_stop(struct hid_device *hid)
1040 {
1041         struct usbhid_device *usbhid = hid->driver_data;
1042
1043         if (WARN_ON(!usbhid))
1044                 return;
1045
1046         clear_bit(HID_STARTED, &usbhid->iofl);
1047         spin_lock_irq(&usbhid->lock);   /* Sync with error handler */
1048         set_bit(HID_DISCONNECTED, &usbhid->iofl);
1049         spin_unlock_irq(&usbhid->lock);
1050         usb_kill_urb(usbhid->urbin);
1051         usb_kill_urb(usbhid->urbout);
1052         usb_kill_urb(usbhid->urbctrl);
1053
1054         hid_cancel_delayed_stuff(usbhid);
1055
1056         hid->claimed = 0;
1057
1058         usb_free_urb(usbhid->urbin);
1059         usb_free_urb(usbhid->urbctrl);
1060         usb_free_urb(usbhid->urbout);
1061         usbhid->urbin = NULL; /* don't mess up next start */
1062         usbhid->urbctrl = NULL;
1063         usbhid->urbout = NULL;
1064
1065         hid_free_buffers(hid_to_usb_dev(hid), hid);
1066 }
1067
1068 static int usbhid_power(struct hid_device *hid, int lvl)
1069 {
1070         int r = 0;
1071
1072         switch (lvl) {
1073         case PM_HINT_FULLON:
1074                 r = usbhid_get_power(hid);
1075                 break;
1076         case PM_HINT_NORMAL:
1077                 usbhid_put_power(hid);
1078                 break;
1079         }
1080         return r;
1081 }
1082
1083 static struct hid_ll_driver usb_hid_driver = {
1084         .parse = usbhid_parse,
1085         .start = usbhid_start,
1086         .stop = usbhid_stop,
1087         .open = usbhid_open,
1088         .close = usbhid_close,
1089         .power = usbhid_power,
1090         .hidinput_input_event = usb_hidinput_input_event,
1091 };
1092
1093 static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1094 {
1095         struct usb_host_interface *interface = intf->cur_altsetting;
1096         struct usb_device *dev = interface_to_usbdev(intf);
1097         struct usbhid_device *usbhid;
1098         struct hid_device *hid;
1099         unsigned int n, has_in = 0;
1100         size_t len;
1101         int ret;
1102
1103         dbg_hid("HID probe called for ifnum %d\n",
1104                         intf->altsetting->desc.bInterfaceNumber);
1105
1106         for (n = 0; n < interface->desc.bNumEndpoints; n++)
1107                 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1108                         has_in++;
1109         if (!has_in) {
1110                 dev_err(&intf->dev, "couldn't find an input interrupt "
1111                                 "endpoint\n");
1112                 return -ENODEV;
1113         }
1114
1115         hid = hid_allocate_device();
1116         if (IS_ERR(hid))
1117                 return PTR_ERR(hid);
1118
1119         usb_set_intfdata(intf, hid);
1120         hid->ll_driver = &usb_hid_driver;
1121         hid->hid_output_raw_report = usbhid_output_raw_report;
1122         hid->ff_init = hid_pidff_init;
1123 #ifdef CONFIG_USB_HIDDEV
1124         hid->hiddev_connect = hiddev_connect;
1125         hid->hiddev_disconnect = hiddev_disconnect;
1126         hid->hiddev_hid_event = hiddev_hid_event;
1127         hid->hiddev_report_event = hiddev_report_event;
1128 #endif
1129         hid->dev.parent = &intf->dev;
1130         hid->bus = BUS_USB;
1131         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1132         hid->product = le16_to_cpu(dev->descriptor.idProduct);
1133         hid->name[0] = 0;
1134         if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1135                         USB_INTERFACE_PROTOCOL_MOUSE)
1136                 hid->type = HID_TYPE_USBMOUSE;
1137
1138         if (dev->manufacturer)
1139                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1140
1141         if (dev->product) {
1142                 if (dev->manufacturer)
1143                         strlcat(hid->name, " ", sizeof(hid->name));
1144                 strlcat(hid->name, dev->product, sizeof(hid->name));
1145         }
1146
1147         if (!strlen(hid->name))
1148                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1149                          le16_to_cpu(dev->descriptor.idVendor),
1150                          le16_to_cpu(dev->descriptor.idProduct));
1151
1152         usb_make_path(dev, hid->phys, sizeof(hid->phys));
1153         strlcat(hid->phys, "/input", sizeof(hid->phys));
1154         len = strlen(hid->phys);
1155         if (len < sizeof(hid->phys) - 1)
1156                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1157                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
1158
1159         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1160                 hid->uniq[0] = 0;
1161
1162         usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1163         if (usbhid == NULL) {
1164                 ret = -ENOMEM;
1165                 goto err;
1166         }
1167
1168         hid->driver_data = usbhid;
1169         usbhid->hid = hid;
1170         usbhid->intf = intf;
1171         usbhid->ifnum = interface->desc.bInterfaceNumber;
1172
1173         init_waitqueue_head(&usbhid->wait);
1174         INIT_WORK(&usbhid->reset_work, hid_reset);
1175         INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
1176         setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1177         spin_lock_init(&usbhid->lock);
1178
1179         ret = hid_add_device(hid);
1180         if (ret) {
1181                 if (ret != -ENODEV)
1182                         dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1183                 goto err_free;
1184         }
1185
1186         return 0;
1187 err_free:
1188         kfree(usbhid);
1189 err:
1190         hid_destroy_device(hid);
1191         return ret;
1192 }
1193
1194 static void usbhid_disconnect(struct usb_interface *intf)
1195 {
1196         struct hid_device *hid = usb_get_intfdata(intf);
1197         struct usbhid_device *usbhid;
1198
1199         if (WARN_ON(!hid))
1200                 return;
1201
1202         usbhid = hid->driver_data;
1203         hid_destroy_device(hid);
1204         kfree(usbhid);
1205 }
1206
1207 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1208 {
1209         del_timer_sync(&usbhid->io_retry);
1210         cancel_work_sync(&usbhid->restart_work);
1211         cancel_work_sync(&usbhid->reset_work);
1212 }
1213
1214 static void hid_cease_io(struct usbhid_device *usbhid)
1215 {
1216         del_timer(&usbhid->io_retry);
1217         usb_kill_urb(usbhid->urbin);
1218         usb_kill_urb(usbhid->urbctrl);
1219         usb_kill_urb(usbhid->urbout);
1220 }
1221
1222 /* Treat USB reset pretty much the same as suspend/resume */
1223 static int hid_pre_reset(struct usb_interface *intf)
1224 {
1225         struct hid_device *hid = usb_get_intfdata(intf);
1226         struct usbhid_device *usbhid = hid->driver_data;
1227
1228         spin_lock_irq(&usbhid->lock);
1229         set_bit(HID_RESET_PENDING, &usbhid->iofl);
1230         spin_unlock_irq(&usbhid->lock);
1231         cancel_work_sync(&usbhid->restart_work);
1232         hid_cease_io(usbhid);
1233
1234         return 0;
1235 }
1236
1237 /* Same routine used for post_reset and reset_resume */
1238 static int hid_post_reset(struct usb_interface *intf)
1239 {
1240         struct usb_device *dev = interface_to_usbdev (intf);
1241         struct hid_device *hid = usb_get_intfdata(intf);
1242         struct usbhid_device *usbhid = hid->driver_data;
1243         int status;
1244
1245         spin_lock_irq(&usbhid->lock);
1246         clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1247         spin_unlock_irq(&usbhid->lock);
1248         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1249         status = hid_start_in(hid);
1250         if (status < 0)
1251                 hid_io_error(hid);
1252         usbhid_restart_queues(usbhid);
1253
1254         return 0;
1255 }
1256
1257 int usbhid_get_power(struct hid_device *hid)
1258 {
1259         struct usbhid_device *usbhid = hid->driver_data;
1260
1261         return usb_autopm_get_interface(usbhid->intf);
1262 }
1263
1264 void usbhid_put_power(struct hid_device *hid)
1265 {
1266         struct usbhid_device *usbhid = hid->driver_data;
1267
1268         usb_autopm_put_interface(usbhid->intf);
1269 }
1270
1271
1272 #ifdef CONFIG_PM
1273 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1274 {
1275         struct hid_device *hid = usb_get_intfdata(intf);
1276         struct usbhid_device *usbhid = hid->driver_data;
1277         int status;
1278
1279         if (message.event & PM_EVENT_AUTO) {
1280                 spin_lock_irq(&usbhid->lock);   /* Sync with error handler */
1281                 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1282                     && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1283                     && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1284                     && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1285                     && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1286                     && (!usbhid->ledcount || ignoreled))
1287                 {
1288                         set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1289                         spin_unlock_irq(&usbhid->lock);
1290                 } else {
1291                         usbhid_mark_busy(usbhid);
1292                         spin_unlock_irq(&usbhid->lock);
1293                         return -EBUSY;
1294                 }
1295
1296         } else {
1297                 spin_lock_irq(&usbhid->lock);
1298                 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1299                 spin_unlock_irq(&usbhid->lock);
1300                 if (usbhid_wait_io(hid) < 0)
1301                         return -EIO;
1302         }
1303
1304         if (!ignoreled && (message.event & PM_EVENT_AUTO)) {
1305                 spin_lock_irq(&usbhid->lock);
1306                 if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1307                         spin_unlock_irq(&usbhid->lock);
1308                         usbhid_mark_busy(usbhid);
1309                         return -EBUSY;
1310                 }
1311                 spin_unlock_irq(&usbhid->lock);
1312         }
1313
1314         hid_cancel_delayed_stuff(usbhid);
1315         hid_cease_io(usbhid);
1316
1317         if ((message.event & PM_EVENT_AUTO) &&
1318                         test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1319                 /* lost race against keypresses */
1320                 status = hid_start_in(hid);
1321                 if (status < 0)
1322                         hid_io_error(hid);
1323                 usbhid_mark_busy(usbhid);
1324                 return -EBUSY;
1325         }
1326         dev_dbg(&intf->dev, "suspend\n");
1327         return 0;
1328 }
1329
1330 static int hid_resume(struct usb_interface *intf)
1331 {
1332         struct hid_device *hid = usb_get_intfdata (intf);
1333         struct usbhid_device *usbhid = hid->driver_data;
1334         int status;
1335
1336         if (!test_bit(HID_STARTED, &usbhid->iofl))
1337                 return 0;
1338
1339         clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1340         usbhid_mark_busy(usbhid);
1341
1342         if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1343             test_bit(HID_RESET_PENDING, &usbhid->iofl))
1344                 schedule_work(&usbhid->reset_work);
1345         usbhid->retry_delay = 0;
1346         status = hid_start_in(hid);
1347         if (status < 0)
1348                 hid_io_error(hid);
1349         usbhid_restart_queues(usbhid);
1350
1351         dev_dbg(&intf->dev, "resume status %d\n", status);
1352         return 0;
1353 }
1354
1355 static int hid_reset_resume(struct usb_interface *intf)
1356 {
1357         struct hid_device *hid = usb_get_intfdata(intf);
1358         struct usbhid_device *usbhid = hid->driver_data;
1359
1360         clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1361         return hid_post_reset(intf);
1362 }
1363
1364 #endif /* CONFIG_PM */
1365
1366 static const struct usb_device_id hid_usb_ids[] = {
1367         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1368                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1369         { }                                             /* Terminating entry */
1370 };
1371
1372 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1373
1374 static struct usb_driver hid_driver = {
1375         .name =         "usbhid",
1376         .probe =        usbhid_probe,
1377         .disconnect =   usbhid_disconnect,
1378 #ifdef CONFIG_PM
1379         .suspend =      hid_suspend,
1380         .resume =       hid_resume,
1381         .reset_resume = hid_reset_resume,
1382 #endif
1383         .pre_reset =    hid_pre_reset,
1384         .post_reset =   hid_post_reset,
1385         .id_table =     hid_usb_ids,
1386         .supports_autosuspend = 1,
1387 };
1388
1389 static const struct hid_device_id hid_usb_table[] = {
1390         { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1391         { }
1392 };
1393
1394 static struct hid_driver hid_usb_driver = {
1395         .name = "generic-usb",
1396         .id_table = hid_usb_table,
1397 };
1398
1399 static int __init hid_init(void)
1400 {
1401         int retval = -ENOMEM;
1402
1403         resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1404         if (!resumption_waker)
1405                 goto no_queue;
1406         retval = hid_register_driver(&hid_usb_driver);
1407         if (retval)
1408                 goto hid_register_fail;
1409         retval = usbhid_quirks_init(quirks_param);
1410         if (retval)
1411                 goto usbhid_quirks_init_fail;
1412         retval = hiddev_init();
1413         if (retval)
1414                 goto hiddev_init_fail;
1415         retval = usb_register(&hid_driver);
1416         if (retval)
1417                 goto usb_register_fail;
1418         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1419
1420         return 0;
1421 usb_register_fail:
1422         hiddev_exit();
1423 hiddev_init_fail:
1424         usbhid_quirks_exit();
1425 usbhid_quirks_init_fail:
1426         hid_unregister_driver(&hid_usb_driver);
1427 hid_register_fail:
1428         destroy_workqueue(resumption_waker);
1429 no_queue:
1430         return retval;
1431 }
1432
1433 static void __exit hid_exit(void)
1434 {
1435         usb_deregister(&hid_driver);
1436         hiddev_exit();
1437         usbhid_quirks_exit();
1438         hid_unregister_driver(&hid_usb_driver);
1439         destroy_workqueue(resumption_waker);
1440 }
1441
1442 module_init(hid_init);
1443 module_exit(hid_exit);
1444
1445 MODULE_AUTHOR("Andreas Gal");
1446 MODULE_AUTHOR("Vojtech Pavlik");
1447 MODULE_AUTHOR("Jiri Kosina");
1448 MODULE_DESCRIPTION(DRIVER_DESC);
1449 MODULE_LICENSE(DRIVER_LICENSE);