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-2007 Jiri Kosina
   8  */
   9
  10 /*
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the Free
  13  * Software Foundation; either version 2 of the License, or (at your option)
  14  * any later version.
  15  */
  16
  17 #include <linux/module.h>
  18 #include <linux/slab.h>
  19 #include <linux/init.h>
  20 #include <linux/kernel.h>
  21 #include <linux/list.h>
  22 #include <linux/mm.h>
  23 #include <linux/smp_lock.h>
  24 #include <linux/spinlock.h>
  25 #include <asm/unaligned.h>
  26 #include <asm/byteorder.h>
  27 #include <linux/input.h>
  28 #include <linux/wait.h>
  29
  30 #include <linux/usb.h>
  31
  32 #include <linux/hid.h>
  33 #include <linux/hiddev.h>
  34 #include <linux/hid-debug.h>
  35 #include <linux/hidraw.h>
  36 #include "usbhid.h"
  37
  38 /*
  39  * Version Information
  40  */
  41
  42 #define DRIVER_VERSION "v2.6"
  43 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
  44 #define DRIVER_DESC "USB HID core driver"
  45 #define DRIVER_LICENSE "GPL"
  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 /* Quirks specified at module load time */
  56 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
  57 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
  58 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
  59                 " quirks=vendorID:productID:quirks"
  60                 " where vendorID, productID, and quirks are all in"
  61                 " 0x-prefixed hex");
  62 /*
  63  * Input submission and I/O error handler.
  64  */
  65
  66 static void hid_io_error(struct hid_device *hid);
  67
  68 /* Start up the input URB */
  69 static int hid_start_in(struct hid_device *hid)
  70 {
  71         unsigned long flags;
  72         int rc = 0;
  73         struct usbhid_device *usbhid = hid->driver_data;
  74
  75         spin_lock_irqsave(&usbhid->inlock, flags);
  76         if (hid->open > 0 && !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
  77                         !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
  78                         !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
  79                 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
  80                 if (rc != 0)
  81                         clear_bit(HID_IN_RUNNING, &usbhid->iofl);
  82         }
  83         spin_unlock_irqrestore(&usbhid->inlock, flags);
  84         return rc;
  85 }
  86
  87 /* I/O retry timer routine */
  88 static void hid_retry_timeout(unsigned long _hid)
  89 {
  90         struct hid_device *hid = (struct hid_device *) _hid;
  91         struct usbhid_device *usbhid = hid->driver_data;
  92
  93         dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
  94         if (hid_start_in(hid))
  95                 hid_io_error(hid);
  96 }
  97
  98 /* Workqueue routine to reset the device or clear a halt */
  99 static void hid_reset(struct work_struct *work)
 100 {
 101         struct usbhid_device *usbhid =
 102                 container_of(work, struct usbhid_device, reset_work);
 103         struct hid_device *hid = usbhid->hid;
 104         int rc_lock, rc = 0;
 105
 106         if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
 107                 dev_dbg(&usbhid->intf->dev, "clear halt\n");
 108                 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
 109                 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
 110                 hid_start_in(hid);
 111         }
 112
 113         else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
 114                 dev_dbg(&usbhid->intf->dev, "resetting device\n");
 115                 rc = rc_lock = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
 116                 if (rc_lock >= 0) {
 117                         rc = usb_reset_device(hid_to_usb_dev(hid));
 118                         if (rc_lock)
 119                                 usb_unlock_device(hid_to_usb_dev(hid));
 120                 }
 121                 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
 122         }
 123
 124         switch (rc) {
 125         case 0:
 126                 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
 127                         hid_io_error(hid);
 128                 break;
 129         default:
 130                 err_hid("can't reset device, %s-%s/input%d, status %d",
 131                                 hid_to_usb_dev(hid)->bus->bus_name,
 132                                 hid_to_usb_dev(hid)->devpath,
 133                                 usbhid->ifnum, rc);
 134                 /* FALLTHROUGH */
 135         case -EHOSTUNREACH:
 136         case -ENODEV:
 137         case -EINTR:
 138                 break;
 139         }
 140 }
 141
 142 /* Main I/O error handler */
 143 static void hid_io_error(struct hid_device *hid)
 144 {
 145         unsigned long flags;
 146         struct usbhid_device *usbhid = hid->driver_data;
 147
 148         spin_lock_irqsave(&usbhid->inlock, flags);
 149
 150         /* Stop when disconnected */
 151         if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
 152                 goto done;
 153
 154         /* If it has been a while since the last error, we'll assume
 155          * this a brand new error and reset the retry timeout. */
 156         if (time_after(jiffies, usbhid->stop_retry + HZ/2))
 157                 usbhid->retry_delay = 0;
 158
 159         /* When an error occurs, retry at increasing intervals */
 160         if (usbhid->retry_delay == 0) {
 161                 usbhid->retry_delay = 13;       /* Then 26, 52, 104, 104, ... */
 162                 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
 163         } else if (usbhid->retry_delay < 100)
 164                 usbhid->retry_delay *= 2;
 165
 166         if (time_after(jiffies, usbhid->stop_retry)) {
 167
 168                 /* Retries failed, so do a port reset */
 169                 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
 170                         schedule_work(&usbhid->reset_work);
 171                         goto done;
 172                 }
 173         }
 174
 175         mod_timer(&usbhid->io_retry,
 176                         jiffies + msecs_to_jiffies(usbhid->retry_delay));
 177 done:
 178         spin_unlock_irqrestore(&usbhid->inlock, flags);
 179 }
 180
 181 /*
 182  * Input interrupt completion handler.
 183  */
 184
 185 static void hid_irq_in(struct urb *urb)
 186 {
 187         struct hid_device       *hid = urb->context;
 188         struct usbhid_device    *usbhid = hid->driver_data;
 189         int                     status;
 190
 191         switch (urb->status) {
 192         case 0:                 /* success */
 193                 usbhid->retry_delay = 0;
 194                 hid_input_report(urb->context, HID_INPUT_REPORT,
 195                                  urb->transfer_buffer,
 196                                  urb->actual_length, 1);
 197                 break;
 198         case -EPIPE:            /* stall */
 199                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
 200                 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
 201                 schedule_work(&usbhid->reset_work);
 202                 return;
 203         case -ECONNRESET:       /* unlink */
 204         case -ENOENT:
 205         case -ESHUTDOWN:        /* unplug */
 206                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
 207                 return;
 208         case -EILSEQ:           /* protocol error or unplug */
 209         case -EPROTO:           /* protocol error or unplug */
 210         case -ETIME:            /* protocol error or unplug */
 211         case -ETIMEDOUT:        /* Should never happen, but... */
 212                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
 213                 hid_io_error(hid);
 214                 return;
 215         default:                /* error */
 216                 dev_warn(&urb->dev->dev, "input irq status %d  "
 217                                 "received\n", urb->status);
 218         }
 219
 220         status = usb_submit_urb(urb, GFP_ATOMIC);
 221         if (status) {
 222                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
 223                 if (status != -EPERM) {
 224                         err_hid("can't resubmit intr, %s-%s/input%d, status %d",
 225                                         hid_to_usb_dev(hid)->bus->bus_name,
 226                                         hid_to_usb_dev(hid)->devpath,
 227                                         usbhid->ifnum, status);
 228                         hid_io_error(hid);
 229                 }
 230         }
 231 }
 232
 233 static int hid_submit_out(struct hid_device *hid)
 234 {
 235         struct hid_report *report;
 236         char *raw_report;
 237         struct usbhid_device *usbhid = hid->driver_data;
 238
 239         report = usbhid->out[usbhid->outtail].report;
 240         raw_report = usbhid->out[usbhid->outtail].raw_report;
 241
 242         usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
 243         usbhid->urbout->dev = hid_to_usb_dev(hid);
 244         memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
 245         kfree(raw_report);
 246
 247         dbg_hid("submitting out urb\n");
 248
 249         if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
 250                 err_hid("usb_submit_urb(out) failed");
 251                 return -1;
 252         }
 253
 254         return 0;
 255 }
 256
 257 static int hid_submit_ctrl(struct hid_device *hid)
 258 {
 259         struct hid_report *report;
 260         unsigned char dir;
 261         char *raw_report;
 262         int len;
 263         struct usbhid_device *usbhid = hid->driver_data;
 264
 265         report = usbhid->ctrl[usbhid->ctrltail].report;
 266         raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
 267         dir = usbhid->ctrl[usbhid->ctrltail].dir;
 268
 269         len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
 270         if (dir == USB_DIR_OUT) {
 271                 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
 272                 usbhid->urbctrl->transfer_buffer_length = len;
 273                 memcpy(usbhid->ctrlbuf, raw_report, len);
 274                 kfree(raw_report);
 275         } else {
 276                 int maxpacket, padlen;
 277
 278                 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
 279                 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
 280                 if (maxpacket > 0) {
 281                         padlen = DIV_ROUND_UP(len, maxpacket);
 282                         padlen *= maxpacket;
 283                         if (padlen > usbhid->bufsize)
 284                                 padlen = usbhid->bufsize;
 285                 } else
 286                         padlen = 0;
 287                 usbhid->urbctrl->transfer_buffer_length = padlen;
 288         }
 289         usbhid->urbctrl->dev = hid_to_usb_dev(hid);
 290
 291         usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
 292         usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
 293         usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
 294         usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
 295         usbhid->cr->wLength = cpu_to_le16(len);
 296
 297         dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
 298                 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
 299                 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
 300
 301         if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
 302                 err_hid("usb_submit_urb(ctrl) failed");
 303                 return -1;
 304         }
 305
 306         return 0;
 307 }
 308
 309 /*
 310  * Output interrupt completion handler.
 311  */
 312
 313 static void hid_irq_out(struct urb *urb)
 314 {
 315         struct hid_device *hid = urb->context;
 316         struct usbhid_device *usbhid = hid->driver_data;
 317         unsigned long flags;
 318         int unplug = 0;
 319
 320         switch (urb->status) {
 321         case 0:                 /* success */
 322                 break;
 323         case -ESHUTDOWN:        /* unplug */
 324                 unplug = 1;
 325         case -EILSEQ:           /* protocol error or unplug */
 326         case -EPROTO:           /* protocol error or unplug */
 327         case -ECONNRESET:       /* unlink */
 328         case -ENOENT:
 329                 break;
 330         default:                /* error */
 331                 dev_warn(&urb->dev->dev, "output irq status %d "
 332                                 "received\n", urb->status);
 333         }
 334
 335         spin_lock_irqsave(&usbhid->outlock, flags);
 336
 337         if (unplug)
 338                 usbhid->outtail = usbhid->outhead;
 339         else
 340                 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
 341
 342         if (usbhid->outhead != usbhid->outtail) {
 343                 if (hid_submit_out(hid)) {
 344                         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 345                         wake_up(&usbhid->wait);
 346                 }
 347                 spin_unlock_irqrestore(&usbhid->outlock, flags);
 348                 return;
 349         }
 350
 351         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 352         spin_unlock_irqrestore(&usbhid->outlock, flags);
 353         wake_up(&usbhid->wait);
 354 }
 355
 356 /*
 357  * Control pipe completion handler.
 358  */
 359
 360 static void hid_ctrl(struct urb *urb)
 361 {
 362         struct hid_device *hid = urb->context;
 363         struct usbhid_device *usbhid = hid->driver_data;
 364         unsigned long flags;
 365         int unplug = 0;
 366
 367         spin_lock_irqsave(&usbhid->ctrllock, flags);
 368
 369         switch (urb->status) {
 370         case 0:                 /* success */
 371                 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
 372                         hid_input_report(urb->context,
 373                                 usbhid->ctrl[usbhid->ctrltail].report->type,
 374                                 urb->transfer_buffer, urb->actual_length, 0);
 375                 break;
 376         case -ESHUTDOWN:        /* unplug */
 377                 unplug = 1;
 378         case -EILSEQ:           /* protocol error or unplug */
 379         case -EPROTO:           /* protocol error or unplug */
 380         case -ECONNRESET:       /* unlink */
 381         case -ENOENT:
 382         case -EPIPE:            /* report not available */
 383                 break;
 384         default:                /* error */
 385                 dev_warn(&urb->dev->dev, "ctrl urb status %d "
 386                                 "received\n", urb->status);
 387         }
 388
 389         if (unplug)
 390                 usbhid->ctrltail = usbhid->ctrlhead;
 391         else
 392                 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
 393
 394         if (usbhid->ctrlhead != usbhid->ctrltail) {
 395                 if (hid_submit_ctrl(hid)) {
 396                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 397                         wake_up(&usbhid->wait);
 398                 }
 399                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 400                 return;
 401         }
 402
 403         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 404         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 405         wake_up(&usbhid->wait);
 406 }
 407
 408 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
 409 {
 410         int head;
 411         unsigned long flags;
 412         struct usbhid_device *usbhid = hid->driver_data;
 413         int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
 414
 415         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
 416                 return;
 417
 418         if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
 419
 420                 spin_lock_irqsave(&usbhid->outlock, flags);
 421
 422                 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
 423                         spin_unlock_irqrestore(&usbhid->outlock, flags);
 424                         dev_warn(&hid->dev, "output queue full\n");
 425                         return;
 426                 }
 427
 428                 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
 429                 if (!usbhid->out[usbhid->outhead].raw_report) {
 430                         spin_unlock_irqrestore(&usbhid->outlock, flags);
 431                         dev_warn(&hid->dev, "output queueing failed\n");
 432                         return;
 433                 }
 434                 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
 435                 usbhid->out[usbhid->outhead].report = report;
 436                 usbhid->outhead = head;
 437
 438                 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
 439                         if (hid_submit_out(hid))
 440                                 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 441
 442                 spin_unlock_irqrestore(&usbhid->outlock, flags);
 443                 return;
 444         }
 445
 446         spin_lock_irqsave(&usbhid->ctrllock, flags);
 447
 448         if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
 449                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 450                 dev_warn(&hid->dev, "control queue full\n");
 451                 return;
 452         }
 453
 454         if (dir == USB_DIR_OUT) {
 455                 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
 456                 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
 457                         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 458                         dev_warn(&hid->dev, "control queueing failed\n");
 459                         return;
 460                 }
 461                 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
 462         }
 463         usbhid->ctrl[usbhid->ctrlhead].report = report;
 464         usbhid->ctrl[usbhid->ctrlhead].dir = dir;
 465         usbhid->ctrlhead = head;
 466
 467         if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
 468                 if (hid_submit_ctrl(hid))
 469                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 470
 471         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 472 }
 473 EXPORT_SYMBOL_GPL(usbhid_submit_report);
 474
 475 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
 476 {
 477         struct hid_device *hid = input_get_drvdata(dev);
 478         struct hid_field *field;
 479         int offset;
 480
 481         if (type == EV_FF)
 482                 return input_ff_event(dev, type, code, value);
 483
 484         if (type != EV_LED)
 485                 return -1;
 486
 487         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
 488                 dev_warn(&dev->dev, "event field not found\n");
 489                 return -1;
 490         }
 491
 492         hid_set_field(field, offset, value);
 493         usbhid_submit_report(hid, field->report, USB_DIR_OUT);
 494
 495         return 0;
 496 }
 497
 498 int usbhid_wait_io(struct hid_device *hid)
 499 {
 500         struct usbhid_device *usbhid = hid->driver_data;
 501
 502         if (!wait_event_timeout(usbhid->wait,
 503                                 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
 504                                 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
 505                                         10*HZ)) {
 506                 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
 507                 return -1;
 508         }
 509
 510         return 0;
 511 }
 512
 513 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
 514 {
 515         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 516                 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
 517                 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
 518 }
 519
 520 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
 521                 unsigned char type, void *buf, int size)
 522 {
 523         int result, retries = 4;
 524
 525         memset(buf, 0, size);
 526
 527         do {
 528                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 529                                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
 530                                 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
 531                 retries--;
 532         } while (result < size && retries);
 533         return result;
 534 }
 535
 536 int usbhid_open(struct hid_device *hid)
 537 {
 538         struct usbhid_device *usbhid = hid->driver_data;
 539         int res;
 540
 541         if (!hid->open++) {
 542                 res = usb_autopm_get_interface(usbhid->intf);
 543                 if (res < 0) {
 544                         hid->open--;
 545                         return -EIO;
 546                 }
 547         }
 548         if (hid_start_in(hid))
 549                 hid_io_error(hid);
 550         return 0;
 551 }
 552
 553 void usbhid_close(struct hid_device *hid)
 554 {
 555         struct usbhid_device *usbhid = hid->driver_data;
 556
 557         if (!--hid->open) {
 558                 usb_kill_urb(usbhid->urbin);
 559                 usb_autopm_put_interface(usbhid->intf);
 560         }
 561 }
 562
 563 /*
 564  * Initialize all reports
 565  */
 566
 567 void usbhid_init_reports(struct hid_device *hid)
 568 {
 569         struct hid_report *report;
 570         struct usbhid_device *usbhid = hid->driver_data;
 571         int err, ret;
 572
 573         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
 574                 usbhid_submit_report(hid, report, USB_DIR_IN);
 575
 576         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
 577                 usbhid_submit_report(hid, report, USB_DIR_IN);
 578
 579         err = 0;
 580         ret = usbhid_wait_io(hid);
 581         while (ret) {
 582                 err |= ret;
 583                 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
 584                         usb_kill_urb(usbhid->urbctrl);
 585                 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
 586                         usb_kill_urb(usbhid->urbout);
 587                 ret = usbhid_wait_io(hid);
 588         }
 589
 590         if (err)
 591                 dev_warn(&hid->dev, "timeout initializing reports\n");
 592 }
 593
 594 /*
 595  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
 596  */
 597 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
 598     unsigned int hid_code, struct hid_field **pfield)
 599 {
 600         struct hid_report *report;
 601         struct hid_field *field;
 602         struct hid_usage *usage;
 603         int i, j;
 604
 605         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
 606                 for (i = 0; i < report->maxfield; i++) {
 607                         field = report->field[i];
 608                         for (j = 0; j < field->maxusage; j++) {
 609                                 usage = &field->usage[j];
 610                                 if ((usage->hid & HID_USAGE_PAGE) == page &&
 611                                     (usage->hid & 0xFFFF) == hid_code) {
 612                                         *pfield = field;
 613                                         return j;
 614                                 }
 615                         }
 616                 }
 617         }
 618         return -1;
 619 }
 620
 621 void usbhid_set_leds(struct hid_device *hid)
 622 {
 623         struct hid_field *field;
 624         int offset;
 625
 626         if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
 627                 hid_set_field(field, offset, 0);
 628                 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
 629         }
 630 }
 631 EXPORT_SYMBOL_GPL(usbhid_set_leds);
 632
 633 /*
 634  * Traverse the supplied list of reports and find the longest
 635  */
 636 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
 637                 unsigned int *max)
 638 {
 639         struct hid_report *report;
 640         unsigned int size;
 641
 642         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
 643                 size = ((report->size - 1) >> 3) + 1;
 644                 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
 645                         size++;
 646                 if (*max < size)
 647                         *max = size;
 648         }
 649 }
 650
 651 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
 652 {
 653         struct usbhid_device *usbhid = hid->driver_data;
 654
 655         if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
 656                 return -1;
 657         if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
 658                 return -1;
 659         if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
 660                 return -1;
 661         if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
 662                 return -1;
 663
 664         return 0;
 665 }
 666
 667 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
 668 {
 669         struct usbhid_device *usbhid = hid->driver_data;
 670         struct usb_device *dev = hid_to_usb_dev(hid);
 671         struct usb_interface *intf = usbhid->intf;
 672         struct usb_host_interface *interface = intf->cur_altsetting;
 673         int ret;
 674
 675         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 676                 HID_REQ_SET_REPORT,
 677                 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 678                 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
 679                 interface->desc.bInterfaceNumber, buf + 1, count - 1,
 680                 USB_CTRL_SET_TIMEOUT);
 681
 682         /* count also the report id */
 683         if (ret > 0)
 684                 ret++;
 685
 686         return ret;
 687 }
 688
 689 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
 690 {
 691         struct usbhid_device *usbhid = hid->driver_data;
 692
 693         usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
 694         usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
 695         usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
 696         usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
 697 }
 698
 699 static int usbhid_parse(struct hid_device *hid)
 700 {
 701         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
 702         struct usb_host_interface *interface = intf->cur_altsetting;
 703         struct usb_device *dev = interface_to_usbdev (intf);
 704         struct hid_descriptor *hdesc;
 705         u32 quirks = 0;
 706         unsigned int rsize = 0;
 707         char *rdesc;
 708         int ret, n;
 709
 710         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
 711                         le16_to_cpu(dev->descriptor.idProduct));
 712
 713         /* Many keyboards and mice don't like to be polled for reports,
 714          * so we will always set the HID_QUIRK_NOGET flag for them. */
 715         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
 716                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
 717                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
 718                                 quirks |= HID_QUIRK_NOGET;
 719         }
 720
 721         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
 722             (!interface->desc.bNumEndpoints ||
 723              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
 724                 dbg_hid("class descriptor not present\n");
 725                 return -ENODEV;
 726         }
 727
 728         hid->version = le16_to_cpu(hdesc->bcdHID);
 729         hid->country = hdesc->bCountryCode;
 730
 731         for (n = 0; n < hdesc->bNumDescriptors; n++)
 732                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
 733                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
 734
 735         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
 736                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
 737                 return -EINVAL;
 738         }
 739
 740         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
 741                 dbg_hid("couldn't allocate rdesc memory\n");
 742                 return -ENOMEM;
 743         }
 744
 745         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
 746
 747         ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
 748                         HID_DT_REPORT, rdesc, rsize);
 749         if (ret < 0) {
 750                 dbg_hid("reading report descriptor failed\n");
 751                 kfree(rdesc);
 752                 goto err;
 753         }
 754
 755         dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
 756         for (n = 0; n < rsize; n++)
 757                 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
 758         dbg_hid_line("\n");
 759
 760         ret = hid_parse_report(hid, rdesc, rsize);
 761         kfree(rdesc);
 762         if (ret) {
 763                 dbg_hid("parsing report descriptor failed\n");
 764                 goto err;
 765         }
 766
 767         hid->quirks = quirks;
 768
 769         return 0;
 770 err:
 771         return ret;
 772 }
 773
 774 static int usbhid_start(struct hid_device *hid)
 775 {
 776         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
 777         struct usb_host_interface *interface = intf->cur_altsetting;
 778         struct usb_device *dev = interface_to_usbdev(intf);
 779         struct usbhid_device *usbhid;
 780         unsigned int n, insize = 0;
 781         int ret;
 782
 783         WARN_ON(hid->driver_data);
 784
 785         usbhid = kzalloc(sizeof(struct usbhid_device), GFP_KERNEL);
 786         if (usbhid == NULL) {
 787                 ret = -ENOMEM;
 788                 goto err;
 789         }
 790
 791         hid->driver_data = usbhid;
 792         usbhid->hid = hid;
 793
 794         usbhid->bufsize = HID_MIN_BUFFER_SIZE;
 795         hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
 796         hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
 797         hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
 798
 799         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
 800                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
 801
 802         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
 803
 804         if (insize > HID_MAX_BUFFER_SIZE)
 805                 insize = HID_MAX_BUFFER_SIZE;
 806
 807         if (hid_alloc_buffers(dev, hid)) {
 808                 ret = -ENOMEM;
 809                 goto fail;
 810         }
 811
 812         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
 813                 struct usb_endpoint_descriptor *endpoint;
 814                 int pipe;
 815                 int interval;
 816
 817                 endpoint = &interface->endpoint[n].desc;
 818                 if ((endpoint->bmAttributes & 3) != 3)          /* Not an interrupt endpoint */
 819                         continue;
 820
 821                 interval = endpoint->bInterval;
 822
 823                 /* Some vendors give fullspeed interval on highspeed devides */
 824                 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
 825                     dev->speed == USB_SPEED_HIGH) {
 826                         interval = fls(endpoint->bInterval*8);
 827                         printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
 828                                hid->name, endpoint->bInterval, interval);
 829                 }
 830
 831                 /* Change the polling interval of mice. */
 832                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
 833                         interval = hid_mousepoll_interval;
 834
 835                 ret = -ENOMEM;
 836                 if (usb_endpoint_dir_in(endpoint)) {
 837                         if (usbhid->urbin)
 838                                 continue;
 839                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
 840                                 goto fail;
 841                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
 842                         usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
 843                                          hid_irq_in, hid, interval);
 844                         usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
 845                         usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 846                 } else {
 847                         if (usbhid->urbout)
 848                                 continue;
 849                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
 850                                 goto fail;
 851                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
 852                         usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
 853                                          hid_irq_out, hid, interval);
 854                         usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
 855                         usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 856                 }
 857         }
 858
 859         if (!usbhid->urbin) {
 860                 err_hid("couldn't find an input interrupt endpoint");
 861                 ret = -ENODEV;
 862                 goto fail;
 863         }
 864
 865         init_waitqueue_head(&usbhid->wait);
 866         INIT_WORK(&usbhid->reset_work, hid_reset);
 867         setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
 868
 869         spin_lock_init(&usbhid->inlock);
 870         spin_lock_init(&usbhid->outlock);
 871         spin_lock_init(&usbhid->ctrllock);
 872
 873         usbhid->intf = intf;
 874         usbhid->ifnum = interface->desc.bInterfaceNumber;
 875
 876         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
 877         if (!usbhid->urbctrl) {
 878                 ret = -ENOMEM;
 879                 goto fail;
 880         }
 881
 882         usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
 883                              usbhid->ctrlbuf, 1, hid_ctrl, hid);
 884         usbhid->urbctrl->setup_dma = usbhid->cr_dma;
 885         usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
 886         usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
 887
 888         usbhid_init_reports(hid);
 889         hid_dump_device(hid);
 890
 891         return 0;
 892
 893 fail:
 894         usb_free_urb(usbhid->urbin);
 895         usb_free_urb(usbhid->urbout);
 896         usb_free_urb(usbhid->urbctrl);
 897         hid_free_buffers(dev, hid);
 898         kfree(usbhid);
 899 err:
 900         return ret;
 901 }
 902
 903 static void usbhid_stop(struct hid_device *hid)
 904 {
 905         struct usbhid_device *usbhid = hid->driver_data;
 906
 907         if (WARN_ON(!usbhid))
 908                 return;
 909
 910         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
 911         set_bit(HID_DISCONNECTED, &usbhid->iofl);
 912         spin_unlock_irq(&usbhid->inlock);
 913         usb_kill_urb(usbhid->urbin);
 914         usb_kill_urb(usbhid->urbout);
 915         usb_kill_urb(usbhid->urbctrl);
 916
 917         del_timer_sync(&usbhid->io_retry);
 918         cancel_work_sync(&usbhid->reset_work);
 919
 920         if (hid->claimed & HID_CLAIMED_INPUT)
 921                 hidinput_disconnect(hid);
 922         if (hid->claimed & HID_CLAIMED_HIDDEV)
 923                 hiddev_disconnect(hid);
 924         if (hid->claimed & HID_CLAIMED_HIDRAW)
 925                 hidraw_disconnect(hid);
 926
 927         hid->claimed = 0;
 928
 929         usb_free_urb(usbhid->urbin);
 930         usb_free_urb(usbhid->urbctrl);
 931         usb_free_urb(usbhid->urbout);
 932
 933         hid_free_buffers(hid_to_usb_dev(hid), hid);
 934         kfree(usbhid);
 935         hid->driver_data = NULL;
 936 }
 937
 938 static struct hid_ll_driver usb_hid_driver = {
 939         .parse = usbhid_parse,
 940         .start = usbhid_start,
 941         .stop = usbhid_stop,
 942         .open = usbhid_open,
 943         .close = usbhid_close,
 944         .hidinput_input_event = usb_hidinput_input_event,
 945 };
 946
 947 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
 948 {
 949         struct usb_device *dev = interface_to_usbdev(intf);
 950         struct hid_device *hid;
 951         size_t len;
 952         int ret;
 953
 954         dbg_hid("HID probe called for ifnum %d\n",
 955                         intf->altsetting->desc.bInterfaceNumber);
 956
 957         hid = hid_allocate_device();
 958         if (IS_ERR(hid))
 959                 return PTR_ERR(hid);
 960
 961         usb_set_intfdata(intf, hid);
 962         hid->ll_driver = &usb_hid_driver;
 963         hid->hid_output_raw_report = usbhid_output_raw_report;
 964         hid->ff_init = hid_pidff_init;
 965 #ifdef CONFIG_USB_HIDDEV
 966         hid->hiddev_connect = hiddev_connect;
 967         hid->hiddev_hid_event = hiddev_hid_event;
 968         hid->hiddev_report_event = hiddev_report_event;
 969 #endif
 970         hid->dev.parent = &intf->dev;
 971         hid->bus = BUS_USB;
 972         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
 973         hid->product = le16_to_cpu(dev->descriptor.idProduct);
 974         hid->name[0] = 0;
 975
 976         if (dev->manufacturer)
 977                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
 978
 979         if (dev->product) {
 980                 if (dev->manufacturer)
 981                         strlcat(hid->name, " ", sizeof(hid->name));
 982                 strlcat(hid->name, dev->product, sizeof(hid->name));
 983         }
 984
 985         if (!strlen(hid->name))
 986                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
 987                          le16_to_cpu(dev->descriptor.idVendor),
 988                          le16_to_cpu(dev->descriptor.idProduct));
 989
 990         usb_make_path(dev, hid->phys, sizeof(hid->phys));
 991         strlcat(hid->phys, "/input", sizeof(hid->phys));
 992         len = strlen(hid->phys);
 993         if (len < sizeof(hid->phys) - 1)
 994                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
 995                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
 996
 997         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
 998                 hid->uniq[0] = 0;
 999
1000         ret = hid_add_device(hid);
1001         if (ret) {
1002                 if (ret != -ENODEV)
1003                         dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1004                 goto err;
1005         }
1006
1007         return 0;
1008 err:
1009         hid_destroy_device(hid);
1010         return ret;
1011 }
1012
1013 static void hid_disconnect(struct usb_interface *intf)
1014 {
1015         struct hid_device *hid = usb_get_intfdata(intf);
1016
1017         if (WARN_ON(!hid))
1018                 return;
1019
1020         hid_destroy_device(hid);
1021 }
1022
1023 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1024 {
1025         struct hid_device *hid = usb_get_intfdata (intf);
1026         struct usbhid_device *usbhid = hid->driver_data;
1027
1028         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
1029         set_bit(HID_SUSPENDED, &usbhid->iofl);
1030         spin_unlock_irq(&usbhid->inlock);
1031         del_timer(&usbhid->io_retry);
1032         usb_kill_urb(usbhid->urbin);
1033         dev_dbg(&intf->dev, "suspend\n");
1034         return 0;
1035 }
1036
1037 static int hid_resume(struct usb_interface *intf)
1038 {
1039         struct hid_device *hid = usb_get_intfdata (intf);
1040         struct usbhid_device *usbhid = hid->driver_data;
1041         int status;
1042
1043         clear_bit(HID_SUSPENDED, &usbhid->iofl);
1044         usbhid->retry_delay = 0;
1045         status = hid_start_in(hid);
1046         dev_dbg(&intf->dev, "resume status %d\n", status);
1047         return status;
1048 }
1049
1050 /* Treat USB reset pretty much the same as suspend/resume */
1051 static int hid_pre_reset(struct usb_interface *intf)
1052 {
1053         /* FIXME: What if the interface is already suspended? */
1054         hid_suspend(intf, PMSG_ON);
1055         return 0;
1056 }
1057
1058 /* Same routine used for post_reset and reset_resume */
1059 static int hid_post_reset(struct usb_interface *intf)
1060 {
1061         struct usb_device *dev = interface_to_usbdev (intf);
1062
1063         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1064         /* FIXME: Any more reinitialization needed? */
1065
1066         return hid_resume(intf);
1067 }
1068
1069 static struct usb_device_id hid_usb_ids [] = {
1070         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1071                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1072         { }                                             /* Terminating entry */
1073 };
1074
1075 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1076
1077 static struct usb_driver hid_driver = {
1078         .name =         "usbhid",
1079         .probe =        hid_probe,
1080         .disconnect =   hid_disconnect,
1081         .suspend =      hid_suspend,
1082         .resume =       hid_resume,
1083         .reset_resume = hid_post_reset,
1084         .pre_reset =    hid_pre_reset,
1085         .post_reset =   hid_post_reset,
1086         .id_table =     hid_usb_ids,
1087         .supports_autosuspend = 1,
1088 };
1089
1090 static const struct hid_device_id hid_usb_table[] = {
1091         { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1092         { }
1093 };
1094
1095 static struct hid_driver hid_usb_driver = {
1096         .name = "generic-usb",
1097         .id_table = hid_usb_table,
1098 };
1099
1100 static int __init hid_init(void)
1101 {
1102         int retval;
1103         retval = hid_register_driver(&hid_usb_driver);
1104         if (retval)
1105                 goto hid_register_fail;
1106         retval = usbhid_quirks_init(quirks_param);
1107         if (retval)
1108                 goto usbhid_quirks_init_fail;
1109         retval = hiddev_init();
1110         if (retval)
1111                 goto hiddev_init_fail;
1112         retval = usb_register(&hid_driver);
1113         if (retval)
1114                 goto usb_register_fail;
1115         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1116                         DRIVER_DESC "\n");
1117
1118         return 0;
1119 usb_register_fail:
1120         hiddev_exit();
1121 hiddev_init_fail:
1122         usbhid_quirks_exit();
1123 usbhid_quirks_init_fail:
1124         hid_unregister_driver(&hid_usb_driver);
1125 hid_register_fail:
1126         return retval;
1127 }
1128
1129 static void __exit hid_exit(void)
1130 {
1131         usb_deregister(&hid_driver);
1132         hiddev_exit();
1133         usbhid_quirks_exit();
1134         hid_unregister_driver(&hid_usb_driver);
1135 }
1136
1137 module_init(hid_init);
1138 module_exit(hid_exit);
1139
1140 MODULE_AUTHOR(DRIVER_AUTHOR);
1141 MODULE_DESCRIPTION(DRIVER_DESC);
1142 MODULE_LICENSE(DRIVER_LICENSE);