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