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