drivers/hid/usbhid/hid-core.c

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