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