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