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