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