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