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