drivers/hid/usbhid/hid-core.c

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