Version:  2.0.40 2.2.26 2.4.37 2.6.39 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15

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

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us