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