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