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 = hid_report_len(report);
 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 if (usbhid->ctrlhead != usbhid->ctrltail) {
 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         mutex_lock(&usbhid->mutex);
 684
 685         set_bit(HID_OPENED, &usbhid->iofl);
 686
 687         if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
 688                 res = 0;
 689                 goto Done;
 690         }
 691
 692         res = usb_autopm_get_interface(usbhid->intf);
 693         /* the device must be awake to reliably request remote wakeup */
 694         if (res < 0) {
 695                 clear_bit(HID_OPENED, &usbhid->iofl);
 696                 res = -EIO;
 697                 goto Done;
 698         }
 699
 700         usbhid->intf->needs_remote_wakeup = 1;
 701
 702         set_bit(HID_RESUME_RUNNING, &usbhid->iofl);
 703         set_bit(HID_IN_POLLING, &usbhid->iofl);
 704
 705         res = hid_start_in(hid);
 706         if (res) {
 707                 if (res != -ENOSPC) {
 708                         hid_io_error(hid);
 709                         res = 0;
 710                 } else {
 711                         /* no use opening if resources are insufficient */
 712                         res = -EBUSY;
 713                         clear_bit(HID_OPENED, &usbhid->iofl);
 714                         clear_bit(HID_IN_POLLING, &usbhid->iofl);
 715                         usbhid->intf->needs_remote_wakeup = 0;
 716                 }
 717         }
 718
 719         usb_autopm_put_interface(usbhid->intf);
 720
 721         /*
 722          * In case events are generated while nobody was listening,
 723          * some are released when the device is re-opened.
 724          * Wait 50 msec for the queue to empty before allowing events
 725          * to go through hid.
 726          */
 727         if (res == 0)
 728                 msleep(50);
 729
 730         clear_bit(HID_RESUME_RUNNING, &usbhid->iofl);
 731
 732  Done:
 733         mutex_unlock(&usbhid->mutex);
 734         return res;
 735 }
 736
 737 static void usbhid_close(struct hid_device *hid)
 738 {
 739         struct usbhid_device *usbhid = hid->driver_data;
 740
 741         mutex_lock(&usbhid->mutex);
 742
 743         /*
 744          * Make sure we don't restart data acquisition due to
 745          * a resumption we no longer care about by avoiding racing
 746          * with hid_start_in().
 747          */
 748         spin_lock_irq(&usbhid->lock);
 749         clear_bit(HID_OPENED, &usbhid->iofl);
 750         if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL))
 751                 clear_bit(HID_IN_POLLING, &usbhid->iofl);
 752         spin_unlock_irq(&usbhid->lock);
 753
 754         if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL)) {
 755                 hid_cancel_delayed_stuff(usbhid);
 756                 usb_kill_urb(usbhid->urbin);
 757                 usbhid->intf->needs_remote_wakeup = 0;
 758         }
 759
 760         mutex_unlock(&usbhid->mutex);
 761 }
 762
 763 /*
 764  * Initialize all reports
 765  */
 766
 767 void usbhid_init_reports(struct hid_device *hid)
 768 {
 769         struct hid_report *report;
 770         struct usbhid_device *usbhid = hid->driver_data;
 771         struct hid_report_enum *report_enum;
 772         int err, ret;
 773
 774         report_enum = &hid->report_enum[HID_INPUT_REPORT];
 775         list_for_each_entry(report, &report_enum->report_list, list)
 776                 usbhid_submit_report(hid, report, USB_DIR_IN);
 777
 778         report_enum = &hid->report_enum[HID_FEATURE_REPORT];
 779         list_for_each_entry(report, &report_enum->report_list, list)
 780                 usbhid_submit_report(hid, report, USB_DIR_IN);
 781
 782         err = 0;
 783         ret = usbhid_wait_io(hid);
 784         while (ret) {
 785                 err |= ret;
 786                 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
 787                         usb_kill_urb(usbhid->urbctrl);
 788                 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
 789                         usb_kill_urb(usbhid->urbout);
 790                 ret = usbhid_wait_io(hid);
 791         }
 792
 793         if (err)
 794                 hid_warn(hid, "timeout initializing reports\n");
 795 }
 796
 797 /*
 798  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
 799  */
 800 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
 801     unsigned int hid_code, struct hid_field **pfield)
 802 {
 803         struct hid_report *report;
 804         struct hid_field *field;
 805         struct hid_usage *usage;
 806         int i, j;
 807
 808         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
 809                 for (i = 0; i < report->maxfield; i++) {
 810                         field = report->field[i];
 811                         for (j = 0; j < field->maxusage; j++) {
 812                                 usage = &field->usage[j];
 813                                 if ((usage->hid & HID_USAGE_PAGE) == page &&
 814                                     (usage->hid & 0xFFFF) == hid_code) {
 815                                         *pfield = field;
 816                                         return j;
 817                                 }
 818                         }
 819                 }
 820         }
 821         return -1;
 822 }
 823
 824 static void usbhid_set_leds(struct hid_device *hid)
 825 {
 826         struct hid_field *field;
 827         int offset;
 828
 829         if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
 830                 hid_set_field(field, offset, 0);
 831                 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
 832         }
 833 }
 834
 835 /*
 836  * Traverse the supplied list of reports and find the longest
 837  */
 838 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
 839                 unsigned int *max)
 840 {
 841         struct hid_report *report;
 842         unsigned int size;
 843
 844         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
 845                 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
 846                 if (*max < size)
 847                         *max = size;
 848         }
 849 }
 850
 851 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
 852 {
 853         struct usbhid_device *usbhid = hid->driver_data;
 854
 855         usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
 856                         &usbhid->inbuf_dma);
 857         usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
 858                         &usbhid->outbuf_dma);
 859         usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
 860         usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
 861                         &usbhid->ctrlbuf_dma);
 862         if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
 863                         !usbhid->ctrlbuf)
 864                 return -1;
 865
 866         return 0;
 867 }
 868
 869 static int usbhid_get_raw_report(struct hid_device *hid,
 870                 unsigned char report_number, __u8 *buf, size_t count,
 871                 unsigned char report_type)
 872 {
 873         struct usbhid_device *usbhid = hid->driver_data;
 874         struct usb_device *dev = hid_to_usb_dev(hid);
 875         struct usb_interface *intf = usbhid->intf;
 876         struct usb_host_interface *interface = intf->cur_altsetting;
 877         int skipped_report_id = 0;
 878         int ret;
 879
 880         /* Byte 0 is the report number. Report data starts at byte 1.*/
 881         buf[0] = report_number;
 882         if (report_number == 0x0) {
 883                 /* Offset the return buffer by 1, so that the report ID
 884                    will remain in byte 0. */
 885                 buf++;
 886                 count--;
 887                 skipped_report_id = 1;
 888         }
 889         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 890                 HID_REQ_GET_REPORT,
 891                 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 892                 ((report_type + 1) << 8) | report_number,
 893                 interface->desc.bInterfaceNumber, buf, count,
 894                 USB_CTRL_SET_TIMEOUT);
 895
 896         /* count also the report id */
 897         if (ret > 0 && skipped_report_id)
 898                 ret++;
 899
 900         return ret;
 901 }
 902
 903 static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum,
 904                                  __u8 *buf, size_t count, unsigned char rtype)
 905 {
 906         struct usbhid_device *usbhid = hid->driver_data;
 907         struct usb_device *dev = hid_to_usb_dev(hid);
 908         struct usb_interface *intf = usbhid->intf;
 909         struct usb_host_interface *interface = intf->cur_altsetting;
 910         int ret, skipped_report_id = 0;
 911
 912         /* Byte 0 is the report number. Report data starts at byte 1.*/
 913         if ((rtype == HID_OUTPUT_REPORT) &&
 914             (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID))
 915                 buf[0] = 0;
 916         else
 917                 buf[0] = reportnum;
 918
 919         if (buf[0] == 0x0) {
 920                 /* Don't send the Report ID */
 921                 buf++;
 922                 count--;
 923                 skipped_report_id = 1;
 924         }
 925
 926         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 927                         HID_REQ_SET_REPORT,
 928                         USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 929                         ((rtype + 1) << 8) | reportnum,
 930                         interface->desc.bInterfaceNumber, buf, count,
 931                         USB_CTRL_SET_TIMEOUT);
 932         /* count also the report id, if this was a numbered report. */
 933         if (ret > 0 && skipped_report_id)
 934                 ret++;
 935
 936         return ret;
 937 }
 938
 939 static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count)
 940 {
 941         struct usbhid_device *usbhid = hid->driver_data;
 942         struct usb_device *dev = hid_to_usb_dev(hid);
 943         int actual_length, skipped_report_id = 0, ret;
 944
 945         if (!usbhid->urbout)
 946                 return -ENOSYS;
 947
 948         if (buf[0] == 0x0) {
 949                 /* Don't send the Report ID */
 950                 buf++;
 951                 count--;
 952                 skipped_report_id = 1;
 953         }
 954
 955         ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
 956                                 buf, count, &actual_length,
 957                                 USB_CTRL_SET_TIMEOUT);
 958         /* return the number of bytes transferred */
 959         if (ret == 0) {
 960                 ret = actual_length;
 961                 /* count also the report id */
 962                 if (skipped_report_id)
 963                         ret++;
 964         }
 965
 966         return ret;
 967 }
 968
 969 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
 970 {
 971         struct usbhid_device *usbhid = hid->driver_data;
 972
 973         usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
 974         usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
 975         kfree(usbhid->cr);
 976         usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
 977 }
 978
 979 static int usbhid_parse(struct hid_device *hid)
 980 {
 981         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
 982         struct usb_host_interface *interface = intf->cur_altsetting;
 983         struct usb_device *dev = interface_to_usbdev (intf);
 984         struct hid_descriptor *hdesc;
 985         u32 quirks = 0;
 986         unsigned int rsize = 0;
 987         char *rdesc;
 988         int ret, n;
 989         int num_descriptors;
 990         size_t offset = offsetof(struct hid_descriptor, desc);
 991
 992         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
 993                         le16_to_cpu(dev->descriptor.idProduct));
 994
 995         if (quirks & HID_QUIRK_IGNORE)
 996                 return -ENODEV;
 997
 998         /* Many keyboards and mice don't like to be polled for reports,
 999          * so we will always set the HID_QUIRK_NOGET flag for them. */
1000         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
1001                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
1002                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
1003                                 quirks |= HID_QUIRK_NOGET;
1004         }
1005
1006         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
1007             (!interface->desc.bNumEndpoints ||
1008              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
1009                 dbg_hid("class descriptor not present\n");
1010                 return -ENODEV;
1011         }
1012
1013         if (hdesc->bLength < sizeof(struct hid_descriptor)) {
1014                 dbg_hid("hid descriptor is too short\n");
1015                 return -EINVAL;
1016         }
1017
1018         hid->version = le16_to_cpu(hdesc->bcdHID);
1019         hid->country = hdesc->bCountryCode;
1020
1021         num_descriptors = min_t(int, hdesc->bNumDescriptors,
1022                (hdesc->bLength - offset) / sizeof(struct hid_class_descriptor));
1023
1024         for (n = 0; n < num_descriptors; n++)
1025                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1026                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1027
1028         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
1029                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
1030                 return -EINVAL;
1031         }
1032
1033         rdesc = kmalloc(rsize, GFP_KERNEL);
1034         if (!rdesc)
1035                 return -ENOMEM;
1036
1037         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1038
1039         ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
1040                         HID_DT_REPORT, rdesc, rsize);
1041         if (ret < 0) {
1042                 dbg_hid("reading report descriptor failed\n");
1043                 kfree(rdesc);
1044                 goto err;
1045         }
1046
1047         ret = hid_parse_report(hid, rdesc, rsize);
1048         kfree(rdesc);
1049         if (ret) {
1050                 dbg_hid("parsing report descriptor failed\n");
1051                 goto err;
1052         }
1053
1054         hid->quirks |= quirks;
1055
1056         return 0;
1057 err:
1058         return ret;
1059 }
1060
1061 static int usbhid_start(struct hid_device *hid)
1062 {
1063         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1064         struct usb_host_interface *interface = intf->cur_altsetting;
1065         struct usb_device *dev = interface_to_usbdev(intf);
1066         struct usbhid_device *usbhid = hid->driver_data;
1067         unsigned int n, insize = 0;
1068         int ret;
1069
1070         mutex_lock(&usbhid->mutex);
1071
1072         clear_bit(HID_DISCONNECTED, &usbhid->iofl);
1073
1074         usbhid->bufsize = HID_MIN_BUFFER_SIZE;
1075         hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
1076         hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
1077         hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
1078
1079         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
1080                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
1081
1082         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1083
1084         if (insize > HID_MAX_BUFFER_SIZE)
1085                 insize = HID_MAX_BUFFER_SIZE;
1086
1087         if (hid_alloc_buffers(dev, hid)) {
1088                 ret = -ENOMEM;
1089                 goto fail;
1090         }
1091
1092         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
1093                 struct usb_endpoint_descriptor *endpoint;
1094                 int pipe;
1095                 int interval;
1096
1097                 endpoint = &interface->endpoint[n].desc;
1098                 if (!usb_endpoint_xfer_int(endpoint))
1099                         continue;
1100
1101                 interval = endpoint->bInterval;
1102
1103                 /* Some vendors give fullspeed interval on highspeed devides */
1104                 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
1105                     dev->speed == USB_SPEED_HIGH) {
1106                         interval = fls(endpoint->bInterval*8);
1107                         pr_info("%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1108                                 hid->name, endpoint->bInterval, interval);
1109                 }
1110
1111                 /* Change the polling interval of mice and joysticks. */
1112                 switch (hid->collection->usage) {
1113                 case HID_GD_MOUSE:
1114                         if (hid_mousepoll_interval > 0)
1115                                 interval = hid_mousepoll_interval;
1116                         break;
1117                 case HID_GD_JOYSTICK:
1118                         if (hid_jspoll_interval > 0)
1119                                 interval = hid_jspoll_interval;
1120                         break;
1121                 }
1122
1123                 ret = -ENOMEM;
1124                 if (usb_endpoint_dir_in(endpoint)) {
1125                         if (usbhid->urbin)
1126                                 continue;
1127                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
1128                                 goto fail;
1129                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
1130                         usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
1131                                          hid_irq_in, hid, interval);
1132                         usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1133                         usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1134                 } else {
1135                         if (usbhid->urbout)
1136                                 continue;
1137                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
1138                                 goto fail;
1139                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
1140                         usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
1141                                          hid_irq_out, hid, interval);
1142                         usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1143                         usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1144                 }
1145         }
1146
1147         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
1148         if (!usbhid->urbctrl) {
1149                 ret = -ENOMEM;
1150                 goto fail;
1151         }
1152
1153         usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1154                              usbhid->ctrlbuf, 1, hid_ctrl, hid);
1155         usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1156         usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1157
1158         set_bit(HID_STARTED, &usbhid->iofl);
1159
1160         if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1161                 ret = usb_autopm_get_interface(usbhid->intf);
1162                 if (ret)
1163                         goto fail;
1164                 set_bit(HID_IN_POLLING, &usbhid->iofl);
1165                 usbhid->intf->needs_remote_wakeup = 1;
1166                 ret = hid_start_in(hid);
1167                 if (ret) {
1168                         dev_err(&hid->dev,
1169                                 "failed to start in urb: %d\n", ret);
1170                 }
1171                 usb_autopm_put_interface(usbhid->intf);
1172         }
1173
1174         /* Some keyboards don't work until their LEDs have been set.
1175          * Since BIOSes do set the LEDs, it must be safe for any device
1176          * that supports the keyboard boot protocol.
1177          * In addition, enable remote wakeup by default for all keyboard
1178          * devices supporting the boot protocol.
1179          */
1180         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1181                         interface->desc.bInterfaceProtocol ==
1182                                 USB_INTERFACE_PROTOCOL_KEYBOARD) {
1183                 usbhid_set_leds(hid);
1184                 device_set_wakeup_enable(&dev->dev, 1);
1185         }
1186
1187         mutex_unlock(&usbhid->mutex);
1188         return 0;
1189
1190 fail:
1191         usb_free_urb(usbhid->urbin);
1192         usb_free_urb(usbhid->urbout);
1193         usb_free_urb(usbhid->urbctrl);
1194         usbhid->urbin = NULL;
1195         usbhid->urbout = NULL;
1196         usbhid->urbctrl = NULL;
1197         hid_free_buffers(dev, hid);
1198         mutex_unlock(&usbhid->mutex);
1199         return ret;
1200 }
1201
1202 static void usbhid_stop(struct hid_device *hid)
1203 {
1204         struct usbhid_device *usbhid = hid->driver_data;
1205
1206         if (WARN_ON(!usbhid))
1207                 return;
1208
1209         if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1210                 clear_bit(HID_IN_POLLING, &usbhid->iofl);
1211                 usbhid->intf->needs_remote_wakeup = 0;
1212         }
1213
1214         mutex_lock(&usbhid->mutex);
1215
1216         clear_bit(HID_STARTED, &usbhid->iofl);
1217
1218         spin_lock_irq(&usbhid->lock);   /* Sync with error and led handlers */
1219         set_bit(HID_DISCONNECTED, &usbhid->iofl);
1220         while (usbhid->ctrltail != usbhid->ctrlhead) {
1221                 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_OUT) {
1222                         kfree(usbhid->ctrl[usbhid->ctrltail].raw_report);
1223                         usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
1224                 }
1225
1226                 usbhid->ctrltail = (usbhid->ctrltail + 1) &
1227                         (HID_CONTROL_FIFO_SIZE - 1);
1228         }
1229         spin_unlock_irq(&usbhid->lock);
1230
1231         usb_kill_urb(usbhid->urbin);
1232         usb_kill_urb(usbhid->urbout);
1233         usb_kill_urb(usbhid->urbctrl);
1234
1235         hid_cancel_delayed_stuff(usbhid);
1236
1237         hid->claimed = 0;
1238
1239         usb_free_urb(usbhid->urbin);
1240         usb_free_urb(usbhid->urbctrl);
1241         usb_free_urb(usbhid->urbout);
1242         usbhid->urbin = NULL; /* don't mess up next start */
1243         usbhid->urbctrl = NULL;
1244         usbhid->urbout = NULL;
1245
1246         hid_free_buffers(hid_to_usb_dev(hid), hid);
1247
1248         mutex_unlock(&usbhid->mutex);
1249 }
1250
1251 static int usbhid_power(struct hid_device *hid, int lvl)
1252 {
1253         struct usbhid_device *usbhid = hid->driver_data;
1254         int r = 0;
1255
1256         switch (lvl) {
1257         case PM_HINT_FULLON:
1258                 r = usb_autopm_get_interface(usbhid->intf);
1259                 break;
1260
1261         case PM_HINT_NORMAL:
1262                 usb_autopm_put_interface(usbhid->intf);
1263                 break;
1264         }
1265
1266         return r;
1267 }
1268
1269 static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype)
1270 {
1271         switch (reqtype) {
1272         case HID_REQ_GET_REPORT:
1273                 usbhid_submit_report(hid, rep, USB_DIR_IN);
1274                 break;
1275         case HID_REQ_SET_REPORT:
1276                 usbhid_submit_report(hid, rep, USB_DIR_OUT);
1277                 break;
1278         }
1279 }
1280
1281 static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum,
1282                               __u8 *buf, size_t len, unsigned char rtype,
1283                               int reqtype)
1284 {
1285         switch (reqtype) {
1286         case HID_REQ_GET_REPORT:
1287                 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype);
1288         case HID_REQ_SET_REPORT:
1289                 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype);
1290         default:
1291                 return -EIO;
1292         }
1293 }
1294
1295 static int usbhid_idle(struct hid_device *hid, int report, int idle,
1296                 int reqtype)
1297 {
1298         struct usb_device *dev = hid_to_usb_dev(hid);
1299         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1300         struct usb_host_interface *interface = intf->cur_altsetting;
1301         int ifnum = interface->desc.bInterfaceNumber;
1302
1303         if (reqtype != HID_REQ_SET_IDLE)
1304                 return -EINVAL;
1305
1306         return hid_set_idle(dev, ifnum, report, idle);
1307 }
1308
1309 struct hid_ll_driver usb_hid_driver = {
1310         .parse = usbhid_parse,
1311         .start = usbhid_start,
1312         .stop = usbhid_stop,
1313         .open = usbhid_open,
1314         .close = usbhid_close,
1315         .power = usbhid_power,
1316         .request = usbhid_request,
1317         .wait = usbhid_wait_io,
1318         .raw_request = usbhid_raw_request,
1319         .output_report = usbhid_output_report,
1320         .idle = usbhid_idle,
1321 };
1322 EXPORT_SYMBOL_GPL(usb_hid_driver);
1323
1324 static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1325 {
1326         struct usb_host_interface *interface = intf->cur_altsetting;
1327         struct usb_device *dev = interface_to_usbdev(intf);
1328         struct usbhid_device *usbhid;
1329         struct hid_device *hid;
1330         unsigned int n, has_in = 0;
1331         size_t len;
1332         int ret;
1333
1334         dbg_hid("HID probe called for ifnum %d\n",
1335                         intf->altsetting->desc.bInterfaceNumber);
1336
1337         for (n = 0; n < interface->desc.bNumEndpoints; n++)
1338                 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1339                         has_in++;
1340         if (!has_in) {
1341                 hid_err(intf, "couldn't find an input interrupt endpoint\n");
1342                 return -ENODEV;
1343         }
1344
1345         hid = hid_allocate_device();
1346         if (IS_ERR(hid))
1347                 return PTR_ERR(hid);
1348
1349         usb_set_intfdata(intf, hid);
1350         hid->ll_driver = &usb_hid_driver;
1351         hid->ff_init = hid_pidff_init;
1352 #ifdef CONFIG_USB_HIDDEV
1353         hid->hiddev_connect = hiddev_connect;
1354         hid->hiddev_disconnect = hiddev_disconnect;
1355         hid->hiddev_hid_event = hiddev_hid_event;
1356         hid->hiddev_report_event = hiddev_report_event;
1357 #endif
1358         hid->dev.parent = &intf->dev;
1359         hid->bus = BUS_USB;
1360         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1361         hid->product = le16_to_cpu(dev->descriptor.idProduct);
1362         hid->name[0] = 0;
1363         hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
1364         if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1365                         USB_INTERFACE_PROTOCOL_MOUSE)
1366                 hid->type = HID_TYPE_USBMOUSE;
1367         else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
1368                 hid->type = HID_TYPE_USBNONE;
1369
1370         if (dev->manufacturer)
1371                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1372
1373         if (dev->product) {
1374                 if (dev->manufacturer)
1375                         strlcat(hid->name, " ", sizeof(hid->name));
1376                 strlcat(hid->name, dev->product, sizeof(hid->name));
1377         }
1378
1379         if (!strlen(hid->name))
1380                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1381                          le16_to_cpu(dev->descriptor.idVendor),
1382                          le16_to_cpu(dev->descriptor.idProduct));
1383
1384         usb_make_path(dev, hid->phys, sizeof(hid->phys));
1385         strlcat(hid->phys, "/input", sizeof(hid->phys));
1386         len = strlen(hid->phys);
1387         if (len < sizeof(hid->phys) - 1)
1388                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1389                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
1390
1391         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1392                 hid->uniq[0] = 0;
1393
1394         usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1395         if (usbhid == NULL) {
1396                 ret = -ENOMEM;
1397                 goto err;
1398         }
1399
1400         hid->driver_data = usbhid;
1401         usbhid->hid = hid;
1402         usbhid->intf = intf;
1403         usbhid->ifnum = interface->desc.bInterfaceNumber;
1404
1405         init_waitqueue_head(&usbhid->wait);
1406         INIT_WORK(&usbhid->reset_work, hid_reset);
1407         setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1408         spin_lock_init(&usbhid->lock);
1409         mutex_init(&usbhid->mutex);
1410
1411         ret = hid_add_device(hid);
1412         if (ret) {
1413                 if (ret != -ENODEV)
1414                         hid_err(intf, "can't add hid device: %d\n", ret);
1415                 goto err_free;
1416         }
1417
1418         return 0;
1419 err_free:
1420         kfree(usbhid);
1421 err:
1422         hid_destroy_device(hid);
1423         return ret;
1424 }
1425
1426 static void usbhid_disconnect(struct usb_interface *intf)
1427 {
1428         struct hid_device *hid = usb_get_intfdata(intf);
1429         struct usbhid_device *usbhid;
1430
1431         if (WARN_ON(!hid))
1432                 return;
1433
1434         usbhid = hid->driver_data;
1435         spin_lock_irq(&usbhid->lock);   /* Sync with error and led handlers */
1436         set_bit(HID_DISCONNECTED, &usbhid->iofl);
1437         spin_unlock_irq(&usbhid->lock);
1438         hid_destroy_device(hid);
1439         kfree(usbhid);
1440 }
1441
1442 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1443 {
1444         del_timer_sync(&usbhid->io_retry);
1445         cancel_work_sync(&usbhid->reset_work);
1446 }
1447
1448 static void hid_cease_io(struct usbhid_device *usbhid)
1449 {
1450         del_timer_sync(&usbhid->io_retry);
1451         usb_kill_urb(usbhid->urbin);
1452         usb_kill_urb(usbhid->urbctrl);
1453         usb_kill_urb(usbhid->urbout);
1454 }
1455
1456 static void hid_restart_io(struct hid_device *hid)
1457 {
1458         struct usbhid_device *usbhid = hid->driver_data;
1459         int clear_halt = test_bit(HID_CLEAR_HALT, &usbhid->iofl);
1460         int reset_pending = test_bit(HID_RESET_PENDING, &usbhid->iofl);
1461
1462         spin_lock_irq(&usbhid->lock);
1463         clear_bit(HID_SUSPENDED, &usbhid->iofl);
1464         usbhid_mark_busy(usbhid);
1465
1466         if (clear_halt || reset_pending)
1467                 schedule_work(&usbhid->reset_work);
1468         usbhid->retry_delay = 0;
1469         spin_unlock_irq(&usbhid->lock);
1470
1471         if (reset_pending || !test_bit(HID_STARTED, &usbhid->iofl))
1472                 return;
1473
1474         if (!clear_halt) {
1475                 if (hid_start_in(hid) < 0)
1476                         hid_io_error(hid);
1477         }
1478
1479         spin_lock_irq(&usbhid->lock);
1480         if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl))
1481                 usbhid_restart_out_queue(usbhid);
1482         if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
1483                 usbhid_restart_ctrl_queue(usbhid);
1484         spin_unlock_irq(&usbhid->lock);
1485 }
1486
1487 /* Treat USB reset pretty much the same as suspend/resume */
1488 static int hid_pre_reset(struct usb_interface *intf)
1489 {
1490         struct hid_device *hid = usb_get_intfdata(intf);
1491         struct usbhid_device *usbhid = hid->driver_data;
1492
1493         spin_lock_irq(&usbhid->lock);
1494         set_bit(HID_RESET_PENDING, &usbhid->iofl);
1495         spin_unlock_irq(&usbhid->lock);
1496         hid_cease_io(usbhid);
1497
1498         return 0;
1499 }
1500
1501 /* Same routine used for post_reset and reset_resume */
1502 static int hid_post_reset(struct usb_interface *intf)
1503 {
1504         struct usb_device *dev = interface_to_usbdev (intf);
1505         struct hid_device *hid = usb_get_intfdata(intf);
1506         struct usbhid_device *usbhid = hid->driver_data;
1507         struct usb_host_interface *interface = intf->cur_altsetting;
1508         int status;
1509         char *rdesc;
1510
1511         /* Fetch and examine the HID report descriptor. If this
1512          * has changed, then rebind. Since usbcore's check of the
1513          * configuration descriptors passed, we already know that
1514          * the size of the HID report descriptor has not changed.
1515          */
1516         rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL);
1517         if (!rdesc)
1518                 return -ENOMEM;
1519
1520         status = hid_get_class_descriptor(dev,
1521                                 interface->desc.bInterfaceNumber,
1522                                 HID_DT_REPORT, rdesc, hid->dev_rsize);
1523         if (status < 0) {
1524                 dbg_hid("reading report descriptor failed (post_reset)\n");
1525                 kfree(rdesc);
1526                 return status;
1527         }
1528         status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize);
1529         kfree(rdesc);
1530         if (status != 0) {
1531                 dbg_hid("report descriptor changed\n");
1532                 return -EPERM;
1533         }
1534
1535         /* No need to do another reset or clear a halted endpoint */
1536         spin_lock_irq(&usbhid->lock);
1537         clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1538         clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
1539         spin_unlock_irq(&usbhid->lock);
1540         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1541
1542         hid_restart_io(hid);
1543
1544         return 0;
1545 }
1546
1547 #ifdef CONFIG_PM
1548 static int hid_resume_common(struct hid_device *hid, bool driver_suspended)
1549 {
1550         int status = 0;
1551
1552         hid_restart_io(hid);
1553         if (driver_suspended && hid->driver && hid->driver->resume)
1554                 status = hid->driver->resume(hid);
1555         return status;
1556 }
1557
1558 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1559 {
1560         struct hid_device *hid = usb_get_intfdata(intf);
1561         struct usbhid_device *usbhid = hid->driver_data;
1562         int status = 0;
1563         bool driver_suspended = false;
1564         unsigned int ledcount;
1565
1566         if (PMSG_IS_AUTO(message)) {
1567                 ledcount = hidinput_count_leds(hid);
1568                 spin_lock_irq(&usbhid->lock);   /* Sync with error handler */
1569                 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1570                     && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1571                     && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1572                     && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1573                     && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1574                     && (!ledcount || ignoreled))
1575                 {
1576                         set_bit(HID_SUSPENDED, &usbhid->iofl);
1577                         spin_unlock_irq(&usbhid->lock);
1578                         if (hid->driver && hid->driver->suspend) {
1579                                 status = hid->driver->suspend(hid, message);
1580                                 if (status < 0)
1581                                         goto failed;
1582                         }
1583                         driver_suspended = true;
1584                 } else {
1585                         usbhid_mark_busy(usbhid);
1586                         spin_unlock_irq(&usbhid->lock);
1587                         return -EBUSY;
1588                 }
1589
1590         } else {
1591                 /* TODO: resume() might need to handle suspend failure */
1592                 if (hid->driver && hid->driver->suspend)
1593                         status = hid->driver->suspend(hid, message);
1594                 driver_suspended = true;
1595                 spin_lock_irq(&usbhid->lock);
1596                 set_bit(HID_SUSPENDED, &usbhid->iofl);
1597                 spin_unlock_irq(&usbhid->lock);
1598                 if (usbhid_wait_io(hid) < 0)
1599                         status = -EIO;
1600         }
1601
1602         hid_cancel_delayed_stuff(usbhid);
1603         hid_cease_io(usbhid);
1604
1605         if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1606                 /* lost race against keypresses */
1607                 status = -EBUSY;
1608                 goto failed;
1609         }
1610         dev_dbg(&intf->dev, "suspend\n");
1611         return status;
1612
1613  failed:
1614         hid_resume_common(hid, driver_suspended);
1615         return status;
1616 }
1617
1618 static int hid_resume(struct usb_interface *intf)
1619 {
1620         struct hid_device *hid = usb_get_intfdata (intf);
1621         int status;
1622
1623         status = hid_resume_common(hid, true);
1624         dev_dbg(&intf->dev, "resume status %d\n", status);
1625         return 0;
1626 }
1627
1628 static int hid_reset_resume(struct usb_interface *intf)
1629 {
1630         struct hid_device *hid = usb_get_intfdata(intf);
1631         int status;
1632
1633         status = hid_post_reset(intf);
1634         if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1635                 int ret = hid->driver->reset_resume(hid);
1636                 if (ret < 0)
1637                         status = ret;
1638         }
1639         return status;
1640 }
1641
1642 #endif /* CONFIG_PM */
1643
1644 static const struct usb_device_id hid_usb_ids[] = {
1645         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1646                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1647         { }                                             /* Terminating entry */
1648 };
1649
1650 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1651
1652 static struct usb_driver hid_driver = {
1653         .name =         "usbhid",
1654         .probe =        usbhid_probe,
1655         .disconnect =   usbhid_disconnect,
1656 #ifdef CONFIG_PM
1657         .suspend =      hid_suspend,
1658         .resume =       hid_resume,
1659         .reset_resume = hid_reset_resume,
1660 #endif
1661         .pre_reset =    hid_pre_reset,
1662         .post_reset =   hid_post_reset,
1663         .id_table =     hid_usb_ids,
1664         .supports_autosuspend = 1,
1665 };
1666
1667 struct usb_interface *usbhid_find_interface(int minor)
1668 {
1669         return usb_find_interface(&hid_driver, minor);
1670 }
1671
1672 static int __init hid_init(void)
1673 {
1674         int retval = -ENOMEM;
1675
1676         retval = usbhid_quirks_init(quirks_param);
1677         if (retval)
1678                 goto usbhid_quirks_init_fail;
1679         retval = usb_register(&hid_driver);
1680         if (retval)
1681                 goto usb_register_fail;
1682         pr_info(KBUILD_MODNAME ": " DRIVER_DESC "\n");
1683
1684         return 0;
1685 usb_register_fail:
1686         usbhid_quirks_exit();
1687 usbhid_quirks_init_fail:
1688         return retval;
1689 }
1690
1691 static void __exit hid_exit(void)
1692 {
1693         usb_deregister(&hid_driver);
1694         usbhid_quirks_exit();
1695 }
1696
1697 module_init(hid_init);
1698 module_exit(hid_exit);
1699
1700 MODULE_AUTHOR("Andreas Gal");
1701 MODULE_AUTHOR("Vojtech Pavlik");
1702 MODULE_AUTHOR("Jiri Kosina");
1703 MODULE_DESCRIPTION(DRIVER_DESC);
1704 MODULE_LICENSE("GPL");