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 "usbhid.h"
  36
  37 /*
  38  * Version Information
  39  */
  40
  41 #define DRIVER_VERSION "v2.6"
  42 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
  43 #define DRIVER_DESC "USB HID core driver"
  44 #define DRIVER_LICENSE "GPL"
  45
  46 static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
  47                                 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
  48 /*
  49  * Module parameters.
  50  */
  51
  52 static unsigned int hid_mousepoll_interval;
  53 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
  54 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
  55
  56 /* Quirks specified at module load time */
  57 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
  58 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
  59 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
  60                 " quirks=vendorID:productID:quirks"
  61                 " where vendorID, productID, and quirks are all in"
  62                 " 0x-prefixed hex");
  63 /*
  64  * Input submission and I/O error handler.
  65  */
  66
  67 static void hid_io_error(struct hid_device *hid);
  68
  69 /* Start up the input URB */
  70 static int hid_start_in(struct hid_device *hid)
  71 {
  72         unsigned long flags;
  73         int rc = 0;
  74         struct usbhid_device *usbhid = hid->driver_data;
  75
  76         spin_lock_irqsave(&usbhid->inlock, flags);
  77         if (hid->open > 0 && !test_bit(HID_SUSPENDED, &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_composite_device(hid_to_usb_dev(hid), usbhid->intf);
 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("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 (usb_get_intfdata(usbhid->intf) == NULL)
 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                         warn("input irq status %d received", urb->status);
 217         }
 218
 219         status = usb_submit_urb(urb, GFP_ATOMIC);
 220         if (status) {
 221                 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
 222                 if (status != -EPERM) {
 223                         err("can't resubmit intr, %s-%s/input%d, status %d",
 224                                         hid_to_usb_dev(hid)->bus->bus_name,
 225                                         hid_to_usb_dev(hid)->devpath,
 226                                         usbhid->ifnum, status);
 227                         hid_io_error(hid);
 228                 }
 229         }
 230 }
 231
 232 static int hid_submit_out(struct hid_device *hid)
 233 {
 234         struct hid_report *report;
 235         struct usbhid_device *usbhid = hid->driver_data;
 236
 237         report = usbhid->out[usbhid->outtail];
 238
 239         hid_output_report(report, usbhid->outbuf);
 240         usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
 241         usbhid->urbout->dev = hid_to_usb_dev(hid);
 242
 243         dbg("submitting out urb");
 244
 245         if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
 246                 err("usb_submit_urb(out) failed");
 247                 return -1;
 248         }
 249
 250         return 0;
 251 }
 252
 253 static int hid_submit_ctrl(struct hid_device *hid)
 254 {
 255         struct hid_report *report;
 256         unsigned char dir;
 257         int len;
 258         struct usbhid_device *usbhid = hid->driver_data;
 259
 260         report = usbhid->ctrl[usbhid->ctrltail].report;
 261         dir = usbhid->ctrl[usbhid->ctrltail].dir;
 262
 263         len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
 264         if (dir == USB_DIR_OUT) {
 265                 hid_output_report(report, usbhid->ctrlbuf);
 266                 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
 267                 usbhid->urbctrl->transfer_buffer_length = len;
 268         } else {
 269                 int maxpacket, padlen;
 270
 271                 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
 272                 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
 273                 if (maxpacket > 0) {
 274                         padlen = (len + maxpacket - 1) / maxpacket;
 275                         padlen *= maxpacket;
 276                         if (padlen > usbhid->bufsize)
 277                                 padlen = usbhid->bufsize;
 278                 } else
 279                         padlen = 0;
 280                 usbhid->urbctrl->transfer_buffer_length = padlen;
 281         }
 282         usbhid->urbctrl->dev = hid_to_usb_dev(hid);
 283
 284         usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
 285         usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
 286         usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
 287         usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
 288         usbhid->cr->wLength = cpu_to_le16(len);
 289
 290         dbg("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u",
 291                 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
 292                 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
 293
 294         if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
 295                 err("usb_submit_urb(ctrl) failed");
 296                 return -1;
 297         }
 298
 299         return 0;
 300 }
 301
 302 /*
 303  * Output interrupt completion handler.
 304  */
 305
 306 static void hid_irq_out(struct urb *urb)
 307 {
 308         struct hid_device *hid = urb->context;
 309         struct usbhid_device *usbhid = hid->driver_data;
 310         unsigned long flags;
 311         int unplug = 0;
 312
 313         switch (urb->status) {
 314                 case 0:                 /* success */
 315                         break;
 316                 case -ESHUTDOWN:        /* unplug */
 317                         unplug = 1;
 318                 case -EILSEQ:           /* protocol error or unplug */
 319                 case -EPROTO:           /* protocol error or unplug */
 320                 case -ECONNRESET:       /* unlink */
 321                 case -ENOENT:
 322                         break;
 323                 default:                /* error */
 324                         warn("output irq status %d received", urb->status);
 325         }
 326
 327         spin_lock_irqsave(&usbhid->outlock, flags);
 328
 329         if (unplug)
 330                 usbhid->outtail = usbhid->outhead;
 331         else
 332                 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
 333
 334         if (usbhid->outhead != usbhid->outtail) {
 335                 if (hid_submit_out(hid)) {
 336                         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 337                         wake_up(&hid->wait);
 338                 }
 339                 spin_unlock_irqrestore(&usbhid->outlock, flags);
 340                 return;
 341         }
 342
 343         clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 344         spin_unlock_irqrestore(&usbhid->outlock, flags);
 345         wake_up(&hid->wait);
 346 }
 347
 348 /*
 349  * Control pipe completion handler.
 350  */
 351
 352 static void hid_ctrl(struct urb *urb)
 353 {
 354         struct hid_device *hid = urb->context;
 355         struct usbhid_device *usbhid = hid->driver_data;
 356         unsigned long flags;
 357         int unplug = 0;
 358
 359         spin_lock_irqsave(&usbhid->ctrllock, flags);
 360
 361         switch (urb->status) {
 362                 case 0:                 /* success */
 363                         if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
 364                                 hid_input_report(urb->context, usbhid->ctrl[usbhid->ctrltail].report->type,
 365                                                 urb->transfer_buffer, urb->actual_length, 0);
 366                         break;
 367                 case -ESHUTDOWN:        /* unplug */
 368                         unplug = 1;
 369                 case -EILSEQ:           /* protocol error or unplug */
 370                 case -EPROTO:           /* protocol error or unplug */
 371                 case -ECONNRESET:       /* unlink */
 372                 case -ENOENT:
 373                 case -EPIPE:            /* report not available */
 374                         break;
 375                 default:                /* error */
 376                         warn("ctrl urb status %d received", urb->status);
 377         }
 378
 379         if (unplug)
 380                 usbhid->ctrltail = usbhid->ctrlhead;
 381         else
 382                 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
 383
 384         if (usbhid->ctrlhead != usbhid->ctrltail) {
 385                 if (hid_submit_ctrl(hid)) {
 386                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 387                         wake_up(&hid->wait);
 388                 }
 389                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 390                 return;
 391         }
 392
 393         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 394         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 395         wake_up(&hid->wait);
 396 }
 397
 398 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
 399 {
 400         int head;
 401         unsigned long flags;
 402         struct usbhid_device *usbhid = hid->driver_data;
 403
 404         if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
 405                 return;
 406
 407         if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
 408
 409                 spin_lock_irqsave(&usbhid->outlock, flags);
 410
 411                 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
 412                         spin_unlock_irqrestore(&usbhid->outlock, flags);
 413                         warn("output queue full");
 414                         return;
 415                 }
 416
 417                 usbhid->out[usbhid->outhead] = report;
 418                 usbhid->outhead = head;
 419
 420                 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
 421                         if (hid_submit_out(hid))
 422                                 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
 423
 424                 spin_unlock_irqrestore(&usbhid->outlock, flags);
 425                 return;
 426         }
 427
 428         spin_lock_irqsave(&usbhid->ctrllock, flags);
 429
 430         if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
 431                 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 432                 warn("control queue full");
 433                 return;
 434         }
 435
 436         usbhid->ctrl[usbhid->ctrlhead].report = report;
 437         usbhid->ctrl[usbhid->ctrlhead].dir = dir;
 438         usbhid->ctrlhead = head;
 439
 440         if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
 441                 if (hid_submit_ctrl(hid))
 442                         clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
 443
 444         spin_unlock_irqrestore(&usbhid->ctrllock, flags);
 445 }
 446
 447 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
 448 {
 449         struct hid_device *hid = dev->private;
 450         struct hid_field *field;
 451         int offset;
 452
 453         if (type == EV_FF)
 454                 return input_ff_event(dev, type, code, value);
 455
 456         if (type != EV_LED)
 457                 return -1;
 458
 459         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
 460                 warn("event field not found");
 461                 return -1;
 462         }
 463
 464         hid_set_field(field, offset, value);
 465         usbhid_submit_report(hid, field->report, USB_DIR_OUT);
 466
 467         return 0;
 468 }
 469
 470 int usbhid_wait_io(struct hid_device *hid)
 471 {
 472         struct usbhid_device *usbhid = hid->driver_data;
 473
 474         if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
 475                                         !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
 476                                         10*HZ)) {
 477                 dbg("timeout waiting for ctrl or out queue to clear");
 478                 return -1;
 479         }
 480
 481         return 0;
 482 }
 483
 484 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
 485 {
 486         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 487                 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
 488                 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
 489 }
 490
 491 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
 492                 unsigned char type, void *buf, int size)
 493 {
 494         int result, retries = 4;
 495
 496         memset(buf, 0, size);
 497
 498         do {
 499                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 500                                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
 501                                 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
 502                 retries--;
 503         } while (result < size && retries);
 504         return result;
 505 }
 506
 507 int usbhid_open(struct hid_device *hid)
 508 {
 509         ++hid->open;
 510         if (hid_start_in(hid))
 511                 hid_io_error(hid);
 512         return 0;
 513 }
 514
 515 void usbhid_close(struct hid_device *hid)
 516 {
 517         struct usbhid_device *usbhid = hid->driver_data;
 518
 519         if (!--hid->open)
 520                 usb_kill_urb(usbhid->urbin);
 521 }
 522
 523 /*
 524  * Initialize all reports
 525  */
 526
 527 void usbhid_init_reports(struct hid_device *hid)
 528 {
 529         struct hid_report *report;
 530         struct usbhid_device *usbhid = hid->driver_data;
 531         int err, ret;
 532
 533         list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
 534                 usbhid_submit_report(hid, report, USB_DIR_IN);
 535
 536         list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
 537                 usbhid_submit_report(hid, report, USB_DIR_IN);
 538
 539         err = 0;
 540         ret = usbhid_wait_io(hid);
 541         while (ret) {
 542                 err |= ret;
 543                 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
 544                         usb_kill_urb(usbhid->urbctrl);
 545                 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
 546                         usb_kill_urb(usbhid->urbout);
 547                 ret = usbhid_wait_io(hid);
 548         }
 549
 550         if (err)
 551                 warn("timeout initializing reports");
 552 }
 553
 554 /*
 555  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
 556  */
 557 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
 558     unsigned int hid_code, struct hid_field **pfield)
 559 {
 560         struct hid_report *report;
 561         struct hid_field *field;
 562         struct hid_usage *usage;
 563         int i, j;
 564
 565         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
 566                 for (i = 0; i < report->maxfield; i++) {
 567                         field = report->field[i];
 568                         for (j = 0; j < field->maxusage; j++) {
 569                                 usage = &field->usage[j];
 570                                 if ((usage->hid & HID_USAGE_PAGE) == page &&
 571                                     (usage->hid & 0xFFFF) == hid_code) {
 572                                         *pfield = field;
 573                                         return j;
 574                                 }
 575                         }
 576                 }
 577         }
 578         return -1;
 579 }
 580
 581 static void usbhid_set_leds(struct hid_device *hid)
 582 {
 583         struct hid_field *field;
 584         int offset;
 585
 586         if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
 587                 hid_set_field(field, offset, 0);
 588                 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
 589         }
 590 }
 591
 592 /*
 593  * Traverse the supplied list of reports and find the longest
 594  */
 595 static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
 596 {
 597         struct hid_report *report;
 598         int size;
 599
 600         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
 601                 size = ((report->size - 1) >> 3) + 1;
 602                 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
 603                         size++;
 604                 if (*max < size)
 605                         *max = size;
 606         }
 607 }
 608
 609 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
 610 {
 611         struct usbhid_device *usbhid = hid->driver_data;
 612
 613         if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
 614                 return -1;
 615         if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
 616                 return -1;
 617         if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
 618                 return -1;
 619         if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
 620                 return -1;
 621
 622         return 0;
 623 }
 624
 625 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
 626 {
 627         struct usbhid_device *usbhid = hid->driver_data;
 628
 629         if (usbhid->inbuf)
 630                 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
 631         if (usbhid->outbuf)
 632                 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
 633         if (usbhid->cr)
 634                 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
 635         if (usbhid->ctrlbuf)
 636                 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
 637 }
 638
 639 /*
 640  * Cherry Cymotion keyboard have an invalid HID report descriptor,
 641  * that needs fixing before we can parse it.
 642  */
 643
 644 static void hid_fixup_cymotion_descriptor(char *rdesc, int rsize)
 645 {
 646         if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
 647                 info("Fixing up Cherry Cymotion report descriptor");
 648                 rdesc[11] = rdesc[16] = 0xff;
 649                 rdesc[12] = rdesc[17] = 0x03;
 650         }
 651 }
 652
 653 /*
 654  * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
 655  * to "operational".  Without this, the ps3 controller will not report any
 656  * events.
 657  */
 658 static void hid_fixup_sony_ps3_controller(struct usb_device *dev, int ifnum)
 659 {
 660         int result;
 661         char *buf = kmalloc(18, GFP_KERNEL);
 662
 663         if (!buf)
 664                 return;
 665
 666         result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 667                                  HID_REQ_GET_REPORT,
 668                                  USB_DIR_IN | USB_TYPE_CLASS |
 669                                  USB_RECIP_INTERFACE,
 670                                  (3 << 8) | 0xf2, ifnum, buf, 17,
 671                                  USB_CTRL_GET_TIMEOUT);
 672
 673         if (result < 0)
 674                 err("%s failed: %d\n", __func__, result);
 675
 676         kfree(buf);
 677 }
 678
 679 /*
 680  * Certain Logitech keyboards send in report #3 keys which are far
 681  * above the logical maximum described in descriptor. This extends
 682  * the original value of 0x28c of logical maximum to 0x104d
 683  */
 684 static void hid_fixup_logitech_descriptor(unsigned char *rdesc, int rsize)
 685 {
 686         if (rsize >= 90 && rdesc[83] == 0x26
 687                         && rdesc[84] == 0x8c
 688                         && rdesc[85] == 0x02) {
 689                 info("Fixing up Logitech keyboard report descriptor");
 690                 rdesc[84] = rdesc[89] = 0x4d;
 691                 rdesc[85] = rdesc[90] = 0x10;
 692         }
 693 }
 694
 695 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
 696 {
 697         struct usb_host_interface *interface = intf->cur_altsetting;
 698         struct usb_device *dev = interface_to_usbdev (intf);
 699         struct hid_descriptor *hdesc;
 700         struct hid_device *hid;
 701         u32 quirks = 0;
 702         unsigned rsize = 0;
 703         char *rdesc;
 704         int n, len, insize = 0;
 705         struct usbhid_device *usbhid;
 706
 707         quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
 708                         le16_to_cpu(dev->descriptor.idProduct));
 709
 710         /* Many keyboards and mice don't like to be polled for reports,
 711          * so we will always set the HID_QUIRK_NOGET flag for them. */
 712         if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
 713                 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
 714                         interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
 715                                 quirks |= HID_QUIRK_NOGET;
 716         }
 717
 718         if (quirks & HID_QUIRK_IGNORE)
 719                 return NULL;
 720
 721         if ((quirks & HID_QUIRK_IGNORE_MOUSE) &&
 722                 (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE))
 723                         return NULL;
 724
 725
 726         if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
 727             (!interface->desc.bNumEndpoints ||
 728              usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
 729                 dbg("class descriptor not present\n");
 730                 return NULL;
 731         }
 732
 733         for (n = 0; n < hdesc->bNumDescriptors; n++)
 734                 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
 735                         rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
 736
 737         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
 738                 dbg("weird size of report descriptor (%u)", rsize);
 739                 return NULL;
 740         }
 741
 742         if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
 743                 dbg("couldn't allocate rdesc memory");
 744                 return NULL;
 745         }
 746
 747         hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
 748
 749         if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
 750                 dbg("reading report descriptor failed");
 751                 kfree(rdesc);
 752                 return NULL;
 753         }
 754
 755         if ((quirks & HID_QUIRK_CYMOTION))
 756                 hid_fixup_cymotion_descriptor(rdesc, rsize);
 757
 758         if (quirks & HID_QUIRK_LOGITECH_DESCRIPTOR)
 759                 hid_fixup_logitech_descriptor(rdesc, rsize);
 760
 761 #ifdef CONFIG_HID_DEBUG
 762         printk(KERN_DEBUG __FILE__ ": report descriptor (size %u, read %d) = ", rsize, n);
 763         for (n = 0; n < rsize; n++)
 764                 printk(" %02x", (unsigned char) rdesc[n]);
 765         printk("\n");
 766 #endif
 767
 768         if (!(hid = hid_parse_report(rdesc, n))) {
 769                 dbg("parsing report descriptor failed");
 770                 kfree(rdesc);
 771                 return NULL;
 772         }
 773
 774         kfree(rdesc);
 775         hid->quirks = quirks;
 776
 777         if (!(usbhid = kzalloc(sizeof(struct usbhid_device), GFP_KERNEL)))
 778                 goto fail;
 779
 780         hid->driver_data = usbhid;
 781         usbhid->hid = hid;
 782
 783         usbhid->bufsize = HID_MIN_BUFFER_SIZE;
 784         hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
 785         hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
 786         hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
 787
 788         if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
 789                 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
 790
 791         hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
 792
 793         if (insize > HID_MAX_BUFFER_SIZE)
 794                 insize = HID_MAX_BUFFER_SIZE;
 795
 796         if (hid_alloc_buffers(dev, hid)) {
 797                 hid_free_buffers(dev, hid);
 798                 goto fail;
 799         }
 800
 801         for (n = 0; n < interface->desc.bNumEndpoints; n++) {
 802
 803                 struct usb_endpoint_descriptor *endpoint;
 804                 int pipe;
 805                 int interval;
 806
 807                 endpoint = &interface->endpoint[n].desc;
 808                 if ((endpoint->bmAttributes & 3) != 3)          /* Not an interrupt endpoint */
 809                         continue;
 810
 811                 interval = endpoint->bInterval;
 812
 813                 /* Change the polling interval of mice. */
 814                 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
 815                         interval = hid_mousepoll_interval;
 816
 817                 if (usb_endpoint_dir_in(endpoint)) {
 818                         if (usbhid->urbin)
 819                                 continue;
 820                         if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
 821                                 goto fail;
 822                         pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
 823                         usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
 824                                          hid_irq_in, hid, interval);
 825                         usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
 826                         usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 827                 } else {
 828                         if (usbhid->urbout)
 829                                 continue;
 830                         if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
 831                                 goto fail;
 832                         pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
 833                         usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
 834                                          hid_irq_out, hid, interval);
 835                         usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
 836                         usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 837                 }
 838         }
 839
 840         if (!usbhid->urbin) {
 841                 err("couldn't find an input interrupt endpoint");
 842                 goto fail;
 843         }
 844
 845         init_waitqueue_head(&hid->wait);
 846
 847         INIT_WORK(&usbhid->reset_work, hid_reset);
 848         setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
 849
 850         spin_lock_init(&usbhid->inlock);
 851         spin_lock_init(&usbhid->outlock);
 852         spin_lock_init(&usbhid->ctrllock);
 853
 854         hid->version = le16_to_cpu(hdesc->bcdHID);
 855         hid->country = hdesc->bCountryCode;
 856         hid->dev = &intf->dev;
 857         usbhid->intf = intf;
 858         usbhid->ifnum = interface->desc.bInterfaceNumber;
 859
 860         hid->name[0] = 0;
 861
 862         if (dev->manufacturer)
 863                 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
 864
 865         if (dev->product) {
 866                 if (dev->manufacturer)
 867                         strlcat(hid->name, " ", sizeof(hid->name));
 868                 strlcat(hid->name, dev->product, sizeof(hid->name));
 869         }
 870
 871         if (!strlen(hid->name))
 872                 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
 873                          le16_to_cpu(dev->descriptor.idVendor),
 874                          le16_to_cpu(dev->descriptor.idProduct));
 875
 876         hid->bus = BUS_USB;
 877         hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
 878         hid->product = le16_to_cpu(dev->descriptor.idProduct);
 879
 880         usb_make_path(dev, hid->phys, sizeof(hid->phys));
 881         strlcat(hid->phys, "/input", sizeof(hid->phys));
 882         len = strlen(hid->phys);
 883         if (len < sizeof(hid->phys) - 1)
 884                 snprintf(hid->phys + len, sizeof(hid->phys) - len,
 885                          "%d", intf->altsetting[0].desc.bInterfaceNumber);
 886
 887         if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
 888                 hid->uniq[0] = 0;
 889
 890         usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
 891         if (!usbhid->urbctrl)
 892                 goto fail;
 893
 894         usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
 895                              usbhid->ctrlbuf, 1, hid_ctrl, hid);
 896         usbhid->urbctrl->setup_dma = usbhid->cr_dma;
 897         usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
 898         usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
 899         hid->hidinput_input_event = usb_hidinput_input_event;
 900         hid->hid_open = usbhid_open;
 901         hid->hid_close = usbhid_close;
 902 #ifdef CONFIG_USB_HIDDEV
 903         hid->hiddev_hid_event = hiddev_hid_event;
 904         hid->hiddev_report_event = hiddev_report_event;
 905 #endif
 906         return hid;
 907
 908 fail:
 909         usb_free_urb(usbhid->urbin);
 910         usb_free_urb(usbhid->urbout);
 911         usb_free_urb(usbhid->urbctrl);
 912         hid_free_buffers(dev, hid);
 913         hid_free_device(hid);
 914
 915         return NULL;
 916 }
 917
 918 static void hid_disconnect(struct usb_interface *intf)
 919 {
 920         struct hid_device *hid = usb_get_intfdata (intf);
 921         struct usbhid_device *usbhid;
 922
 923         if (!hid)
 924                 return;
 925
 926         usbhid = hid->driver_data;
 927
 928         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
 929         usb_set_intfdata(intf, NULL);
 930         spin_unlock_irq(&usbhid->inlock);
 931         usb_kill_urb(usbhid->urbin);
 932         usb_kill_urb(usbhid->urbout);
 933         usb_kill_urb(usbhid->urbctrl);
 934
 935         del_timer_sync(&usbhid->io_retry);
 936         flush_scheduled_work();
 937
 938         if (hid->claimed & HID_CLAIMED_INPUT)
 939                 hidinput_disconnect(hid);
 940         if (hid->claimed & HID_CLAIMED_HIDDEV)
 941                 hiddev_disconnect(hid);
 942
 943         usb_free_urb(usbhid->urbin);
 944         usb_free_urb(usbhid->urbctrl);
 945         usb_free_urb(usbhid->urbout);
 946
 947         hid_free_buffers(hid_to_usb_dev(hid), hid);
 948         hid_free_device(hid);
 949 }
 950
 951 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
 952 {
 953         struct hid_device *hid;
 954         char path[64];
 955         int i;
 956         char *c;
 957
 958         dbg("HID probe called for ifnum %d",
 959                         intf->altsetting->desc.bInterfaceNumber);
 960
 961         if (!(hid = usb_hid_configure(intf)))
 962                 return -ENODEV;
 963
 964         usbhid_init_reports(hid);
 965         hid_dump_device(hid);
 966         if (hid->quirks & HID_QUIRK_RESET_LEDS)
 967                 usbhid_set_leds(hid);
 968
 969         if (!hidinput_connect(hid))
 970                 hid->claimed |= HID_CLAIMED_INPUT;
 971         if (!hiddev_connect(hid))
 972                 hid->claimed |= HID_CLAIMED_HIDDEV;
 973
 974         usb_set_intfdata(intf, hid);
 975
 976         if (!hid->claimed) {
 977                 printk ("HID device not claimed by input or hiddev\n");
 978                 hid_disconnect(intf);
 979                 return -ENODEV;
 980         }
 981
 982         if ((hid->claimed & HID_CLAIMED_INPUT))
 983                 hid_ff_init(hid);
 984
 985         if (hid->quirks & HID_QUIRK_SONY_PS3_CONTROLLER)
 986                 hid_fixup_sony_ps3_controller(interface_to_usbdev(intf),
 987                         intf->cur_altsetting->desc.bInterfaceNumber);
 988
 989         printk(KERN_INFO);
 990
 991         if (hid->claimed & HID_CLAIMED_INPUT)
 992                 printk("input");
 993         if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
 994                 printk(",");
 995         if (hid->claimed & HID_CLAIMED_HIDDEV)
 996                 printk("hiddev%d", hid->minor);
 997
 998         c = "Device";
 999         for (i = 0; i < hid->maxcollection; i++) {
1000                 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
1001                     (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
1002                     (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
1003                         c = hid_types[hid->collection[i].usage & 0xffff];
1004                         break;
1005                 }
1006         }
1007
1008         usb_make_path(interface_to_usbdev(intf), path, 63);
1009
1010         printk(": USB HID v%x.%02x %s [%s] on %s\n",
1011                 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
1012
1013         return 0;
1014 }
1015
1016 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1017 {
1018         struct hid_device *hid = usb_get_intfdata (intf);
1019         struct usbhid_device *usbhid = hid->driver_data;
1020
1021         spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
1022         set_bit(HID_SUSPENDED, &usbhid->iofl);
1023         spin_unlock_irq(&usbhid->inlock);
1024         del_timer(&usbhid->io_retry);
1025         usb_kill_urb(usbhid->urbin);
1026         dev_dbg(&intf->dev, "suspend\n");
1027         return 0;
1028 }
1029
1030 static int hid_resume(struct usb_interface *intf)
1031 {
1032         struct hid_device *hid = usb_get_intfdata (intf);
1033         struct usbhid_device *usbhid = hid->driver_data;
1034         int status;
1035
1036         clear_bit(HID_SUSPENDED, &usbhid->iofl);
1037         usbhid->retry_delay = 0;
1038         status = hid_start_in(hid);
1039         dev_dbg(&intf->dev, "resume status %d\n", status);
1040         return status;
1041 }
1042
1043 /* Treat USB reset pretty much the same as suspend/resume */
1044 static void hid_pre_reset(struct usb_interface *intf)
1045 {
1046         /* FIXME: What if the interface is already suspended? */
1047         hid_suspend(intf, PMSG_ON);
1048 }
1049
1050 static void hid_post_reset(struct usb_interface *intf)
1051 {
1052         struct usb_device *dev = interface_to_usbdev (intf);
1053
1054         hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1055         /* FIXME: Any more reinitialization needed? */
1056
1057         hid_resume(intf);
1058 }
1059
1060 static struct usb_device_id hid_usb_ids [] = {
1061         { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1062                 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1063         { }                                             /* Terminating entry */
1064 };
1065
1066 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1067
1068 static struct usb_driver hid_driver = {
1069         .name =         "usbhid",
1070         .probe =        hid_probe,
1071         .disconnect =   hid_disconnect,
1072         .suspend =      hid_suspend,
1073         .resume =       hid_resume,
1074         .pre_reset =    hid_pre_reset,
1075         .post_reset =   hid_post_reset,
1076         .id_table =     hid_usb_ids,
1077 };
1078
1079 static int __init hid_init(void)
1080 {
1081         int retval;
1082         retval = usbhid_quirks_init(quirks_param);
1083         if (retval)
1084                 goto usbhid_quirks_init_fail;
1085         retval = hiddev_init();
1086         if (retval)
1087                 goto hiddev_init_fail;
1088         retval = usb_register(&hid_driver);
1089         if (retval)
1090                 goto usb_register_fail;
1091         info(DRIVER_VERSION ":" DRIVER_DESC);
1092
1093         return 0;
1094 usb_register_fail:
1095         hiddev_exit();
1096 hiddev_init_fail:
1097         usbhid_quirks_exit();
1098 usbhid_quirks_init_fail:
1099         return retval;
1100 }
1101
1102 static void __exit hid_exit(void)
1103 {
1104         usb_deregister(&hid_driver);
1105         hiddev_exit();
1106         usbhid_quirks_exit();
1107 }
1108
1109 module_init(hid_init);
1110 module_exit(hid_exit);
1111
1112 MODULE_AUTHOR(DRIVER_AUTHOR);
1113 MODULE_DESCRIPTION(DRIVER_DESC);
1114 MODULE_LICENSE(DRIVER_LICENSE);