?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
replace some function names
[linux-2.6/zen-sources.git] / drivers / hid / usbhid / hid-core.c
blobf7725018d9eb9ff4a13d952bf2552541b61be9a9
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) 2006-2007 Jiri Kosina
8 */
9
10 /*
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the Free
13 * Software Foundation; either version 2 of the License, or (at your option)
14 * any later version.
15 */
16
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/init.h>
20 #include <linux/kernel.h>
21 #include <linux/list.h>
22 #include <linux/mm.h>
23 #include <linux/mutex.h>
24 #include <linux/smp_lock.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
31 #include <linux/usb.h>
32
33 #include <linux/hid.h>
34 #include <linux/hiddev.h>
35 #include <linux/hid-debug.h>
36 #include <linux/hidraw.h>
37 #include "usbhid.h"
38
39 /*
40 * Version Information
41 */
42
43 #define DRIVER_VERSION "v2.6"
44 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
45 #define DRIVER_DESC "USB HID core driver"
46 #define DRIVER_LICENSE "GPL"
47
48 /*
49 * Module parameters.
50 */
51
52 #ifdef USB_HID_MOUSE_POLLING
53 static unsigned int hid_mousepoll_interval = CONFIG_USB_HID_MOUSE_POLLING_INTERVAL;
54 #else
55 static unsigned int hid_mousepoll_interval;
56 #endif
57 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
58 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
59
60 /* Quirks specified at module load time */
61 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
62 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
63 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
64 " quirks=vendorID:productID:quirks"
65 " where vendorID, productID, and quirks are all in"
66 " 0x-prefixed hex");
67 /*
68 * Input submission and I/O error handler.
69 */
70
71 static void hid_io_error(struct hid_device *hid);
72
73 /* Start up the input URB */
74 static int hid_start_in(struct hid_device *hid)
75 {
76 unsigned long flags;
77 int rc = 0;
78 struct usbhid_device *usbhid = hid->driver_data;
79
80 spin_lock_irqsave(&usbhid->inlock, flags);
81 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
82 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
83 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
84 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
85 if (rc != 0)
86 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
87 }
88 spin_unlock_irqrestore(&usbhid->inlock, flags);
89 return rc;
90 }
91
92 /* I/O retry timer routine */
93 static void hid_retry_timeout(unsigned long _hid)
94 {
95 struct hid_device *hid = (struct hid_device *) _hid;
96 struct usbhid_device *usbhid = hid->driver_data;
97
98 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
99 if (hid_start_in(hid))
100 hid_io_error(hid);
101 }
102
103 /* Workqueue routine to reset the device or clear a halt */
104 static void hid_reset(struct work_struct *work)
105 {
106 struct usbhid_device *usbhid =
107 container_of(work, struct usbhid_device, reset_work);
108 struct hid_device *hid = usbhid->hid;
109 int rc_lock, rc = 0;
110
111 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
112 dev_dbg(&usbhid->intf->dev, "clear halt\n");
113 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
114 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
115 hid_start_in(hid);
116 }
117
118 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
119 dev_dbg(&usbhid->intf->dev, "resetting device\n");
120 rc = rc_lock = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
121 if (rc_lock >= 0) {
122 rc = usb_reset_device(hid_to_usb_dev(hid));
123 if (rc_lock)
124 usb_unlock_device(hid_to_usb_dev(hid));
125 }
126 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
127 }
128
129 switch (rc) {
130 case 0:
131 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
132 hid_io_error(hid);
133 break;
134 default:
135 err_hid("can't reset device, %s-%s/input%d, status %d",
136 hid_to_usb_dev(hid)->bus->bus_name,
137 hid_to_usb_dev(hid)->devpath,
138 usbhid->ifnum, rc);
139 /* FALLTHROUGH */
140 case -EHOSTUNREACH:
141 case -ENODEV:
142 case -EINTR:
143 break;
144 }
145 }
146
147 /* Main I/O error handler */
148 static void hid_io_error(struct hid_device *hid)
149 {
150 unsigned long flags;
151 struct usbhid_device *usbhid = hid->driver_data;
152
153 spin_lock_irqsave(&usbhid->inlock, flags);
154
155 /* Stop when disconnected */
156 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
157 goto done;
158
159 /* If it has been a while since the last error, we'll assume
160 * this a brand new error and reset the retry timeout. */
161 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
162 usbhid->retry_delay = 0;
163
164 /* When an error occurs, retry at increasing intervals */
165 if (usbhid->retry_delay == 0) {
166 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
167 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
168 } else if (usbhid->retry_delay < 100)
169 usbhid->retry_delay *= 2;
170
171 if (time_after(jiffies, usbhid->stop_retry)) {
172
173 /* Retries failed, so do a port reset */
174 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
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->inlock, flags);
184 }
185
186 /*
187 * Input interrupt completion handler.
188 */
189
190 static void hid_irq_in(struct urb *urb)
191 {
192 struct hid_device *hid = urb->context;
193 struct usbhid_device *usbhid = hid->driver_data;
194 int status;
195
196 switch (urb->status) {
197 case 0: /* success */
198 usbhid->retry_delay = 0;
199 hid_input_report(urb->context, HID_INPUT_REPORT,
200 urb->transfer_buffer,
201 urb->actual_length, 1);
202 break;
203 case -EPIPE: /* stall */
204 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
205 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
206 schedule_work(&usbhid->reset_work);
207 return;
208 case -ECONNRESET: /* unlink */
209 case -ENOENT:
210 case -ESHUTDOWN: /* unplug */
211 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
212 return;
213 case -EILSEQ: /* protocol error or unplug */
214 case -EPROTO: /* protocol error or unplug */
215 case -ETIME: /* protocol error or unplug */
216 case -ETIMEDOUT: /* Should never happen, but... */
217 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
218 hid_io_error(hid);
219 return;
220 default: /* error */
221 dev_warn(&urb->dev->dev, "input irq status %d "
222 "received\n", urb->status);
223 }
224
225 status = usb_submit_urb(urb, GFP_ATOMIC);
226 if (status) {
227 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
228 if (status != -EPERM) {
229 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
230 hid_to_usb_dev(hid)->bus->bus_name,
231 hid_to_usb_dev(hid)->devpath,
232 usbhid->ifnum, status);
233 hid_io_error(hid);
234 }
235 }
236 }
237
238 static int hid_submit_out(struct hid_device *hid)
239 {
240 struct hid_report *report;
241 char *raw_report;
242 struct usbhid_device *usbhid = hid->driver_data;
243
244 report = usbhid->out[usbhid->outtail].report;
245 raw_report = usbhid->out[usbhid->outtail].raw_report;
246
247 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
248 usbhid->urbout->dev = hid_to_usb_dev(hid);
249 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
250 kfree(raw_report);
251
252 dbg_hid("submitting out urb\n");
253
254 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
255 err_hid("usb_submit_urb(out) failed");
256 return -1;
257 }
258
259 return 0;
260 }
261
262 static int hid_submit_ctrl(struct hid_device *hid)
263 {
264 struct hid_report *report;
265 unsigned char dir;
266 char *raw_report;
267 int len;
268 struct usbhid_device *usbhid = hid->driver_data;
269
270 report = usbhid->ctrl[usbhid->ctrltail].report;
271 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
272 dir = usbhid->ctrl[usbhid->ctrltail].dir;
273
274 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
275 if (dir == USB_DIR_OUT) {
276 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
277 usbhid->urbctrl->transfer_buffer_length = len;
278 memcpy(usbhid->ctrlbuf, raw_report, len);
279 kfree(raw_report);
280 } else {
281 int maxpacket, padlen;
282
283 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
284 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
285 if (maxpacket > 0) {
286 padlen = DIV_ROUND_UP(len, maxpacket);
287 padlen *= maxpacket;
288 if (padlen > usbhid->bufsize)
289 padlen = usbhid->bufsize;
290 } else
291 padlen = 0;
292 usbhid->urbctrl->transfer_buffer_length = padlen;
293 }
294 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
295
296 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
297 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
298 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
299 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
300 usbhid->cr->wLength = cpu_to_le16(len);
301
302 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
303 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
304 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
305
306 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
307 err_hid("usb_submit_urb(ctrl) failed");
308 return -1;
309 }
310
311 return 0;
312 }
313
314 /*
315 * Output interrupt completion handler.
316 */
317
318 static void hid_irq_out(struct urb *urb)
319 {
320 struct hid_device *hid = urb->context;
321 struct usbhid_device *usbhid = hid->driver_data;
322 unsigned long flags;
323 int unplug = 0;
324
325 switch (urb->status) {
326 case 0: /* success */
327 break;
328 case -ESHUTDOWN: /* unplug */
329 unplug = 1;
330 case -EILSEQ: /* protocol error or unplug */
331 case -EPROTO: /* protocol error or unplug */
332 case -ECONNRESET: /* unlink */
333 case -ENOENT:
334 break;
335 default: /* error */
336 dev_warn(&urb->dev->dev, "output irq status %d "
337 "received\n", urb->status);
338 }
339
340 spin_lock_irqsave(&usbhid->outlock, flags);
341
342 if (unplug)
343 usbhid->outtail = usbhid->outhead;
344 else
345 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
346
347 if (usbhid->outhead != usbhid->outtail) {
348 if (hid_submit_out(hid)) {
349 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
350 wake_up(&usbhid->wait);
351 }
352 spin_unlock_irqrestore(&usbhid->outlock, flags);
353 return;
354 }
355
356 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
357 spin_unlock_irqrestore(&usbhid->outlock, flags);
358 wake_up(&usbhid->wait);
359 }
360
361 /*
362 * Control pipe completion handler.
363 */
364
365 static void hid_ctrl(struct urb *urb)
366 {
367 struct hid_device *hid = urb->context;
368 struct usbhid_device *usbhid = hid->driver_data;
369 unsigned long flags;
370 int unplug = 0;
371
372 spin_lock_irqsave(&usbhid->ctrllock, flags);
373
374 switch (urb->status) {
375 case 0: /* success */
376 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
377 hid_input_report(urb->context,
378 usbhid->ctrl[usbhid->ctrltail].report->type,
379 urb->transfer_buffer, urb->actual_length, 0);
380 break;
381 case -ESHUTDOWN: /* unplug */
382 unplug = 1;
383 case -EILSEQ: /* protocol error or unplug */
384 case -EPROTO: /* protocol error or unplug */
385 case -ECONNRESET: /* unlink */
386 case -ENOENT:
387 case -EPIPE: /* report not available */
388 break;
389 default: /* error */
390 dev_warn(&urb->dev->dev, "ctrl urb status %d "
391 "received\n", urb->status);
392 }
393
394 if (unplug)
395 usbhid->ctrltail = usbhid->ctrlhead;
396 else
397 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
398
399 if (usbhid->ctrlhead != usbhid->ctrltail) {
400 if (hid_submit_ctrl(hid)) {
401 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
402 wake_up(&usbhid->wait);
403 }
404 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
405 return;
406 }
407
408 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
409 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
410 wake_up(&usbhid->wait);
411 }
412
413 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
414 {
415 int head;
416 unsigned long flags;
417 struct usbhid_device *usbhid = hid->driver_data;
418 int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
419
420 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
421 return;
422
423 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
424
425 spin_lock_irqsave(&usbhid->outlock, flags);
426
427 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
428 spin_unlock_irqrestore(&usbhid->outlock, flags);
429 dev_warn(&hid->dev, "output queue full\n");
430 return;
431 }
432
433 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
434 if (!usbhid->out[usbhid->outhead].raw_report) {
435 spin_unlock_irqrestore(&usbhid->outlock, flags);
436 dev_warn(&hid->dev, "output queueing failed\n");
437 return;
438 }
439 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
440 usbhid->out[usbhid->outhead].report = report;
441 usbhid->outhead = head;
442
443 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
444 if (hid_submit_out(hid))
445 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
446
447 spin_unlock_irqrestore(&usbhid->outlock, flags);
448 return;
449 }
450
451 spin_lock_irqsave(&usbhid->ctrllock, flags);
452
453 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
454 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
455 dev_warn(&hid->dev, "control queue full\n");
456 return;
457 }
458
459 if (dir == USB_DIR_OUT) {
460 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
461 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
462 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
463 dev_warn(&hid->dev, "control queueing failed\n");
464 return;
465 }
466 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
467 }
468 usbhid->ctrl[usbhid->ctrlhead].report = report;
469 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
470 usbhid->ctrlhead = head;
471
472 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
473 if (hid_submit_ctrl(hid))
474 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
475
476 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
477 }
478 EXPORT_SYMBOL_GPL(usbhid_submit_report);
479
480 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
481 {
482 struct hid_device *hid = input_get_drvdata(dev);
483 struct hid_field *field;
484 int offset;
485
486 if (type == EV_FF)
487 return input_ff_event(dev, type, code, value);
488
489 if (type != EV_LED)
490 return -1;
491
492 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
493 dev_warn(&dev->dev, "event field not found\n");
494 return -1;
495 }
496
497 hid_set_field(field, offset, value);
498 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
499
500 return 0;
501 }
502
503 int usbhid_wait_io(struct hid_device *hid)
504 {
505 struct usbhid_device *usbhid = hid->driver_data;
506
507 if (!wait_event_timeout(usbhid->wait,
508 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
509 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
510 10*HZ)) {
511 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
512 return -1;
513 }
514
515 return 0;
516 }
517
518 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
519 {
520 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
521 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
522 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
523 }
524
525 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
526 unsigned char type, void *buf, int size)
527 {
528 int result, retries = 4;
529
530 memset(buf, 0, size);
531
532 do {
533 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
534 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
535 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
536 retries--;
537 } while (result < size && retries);
538 return result;
539 }
540
541 int usbhid_open(struct hid_device *hid)
542 {
543 struct usbhid_device *usbhid = hid->driver_data;
544 int res;
545
546 if (!hid->open++) {
547 res = usb_autopm_get_interface(usbhid->intf);
548 if (res < 0) {
549 hid->open--;
550 return -EIO;
551 }
552 }
553 if (hid_start_in(hid))
554 hid_io_error(hid);
555 return 0;
556 }
557
558 void usbhid_close(struct hid_device *hid)
559 {
560 struct usbhid_device *usbhid = hid->driver_data;
561
562 if (!--hid->open) {
563 usb_kill_urb(usbhid->urbin);
564 usb_autopm_put_interface(usbhid->intf);
565 }
566 }
567
568 /*
569 * Initialize all reports
570 */
571
572 void usbhid_init_reports(struct hid_device *hid)
573 {
574 struct hid_report *report;
575 struct usbhid_device *usbhid = hid->driver_data;
576 int err, ret;
577
578 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
579 usbhid_submit_report(hid, report, USB_DIR_IN);
580
581 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
582 usbhid_submit_report(hid, report, USB_DIR_IN);
583
584 err = 0;
585 ret = usbhid_wait_io(hid);
586 while (ret) {
587 err |= ret;
588 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
589 usb_kill_urb(usbhid->urbctrl);
590 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
591 usb_kill_urb(usbhid->urbout);
592 ret = usbhid_wait_io(hid);
593 }
594
595 if (err)
596 dev_warn(&hid->dev, "timeout initializing reports\n");
597 }
598
599 /*
600 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
601 */
602 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
603 unsigned int hid_code, struct hid_field **pfield)
604 {
605 struct hid_report *report;
606 struct hid_field *field;
607 struct hid_usage *usage;
608 int i, j;
609
610 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
611 for (i = 0; i < report->maxfield; i++) {
612 field = report->field[i];
613 for (j = 0; j < field->maxusage; j++) {
614 usage = &field->usage[j];
615 if ((usage->hid & HID_USAGE_PAGE) == page &&
616 (usage->hid & 0xFFFF) == hid_code) {
617 *pfield = field;
618 return j;
619 }
620 }
621 }
622 }
623 return -1;
624 }
625
626 void usbhid_set_leds(struct hid_device *hid)
627 {
628 struct hid_field *field;
629 int offset;
630
631 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
632 hid_set_field(field, offset, 0);
633 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
634 }
635 }
636 EXPORT_SYMBOL_GPL(usbhid_set_leds);
637
638 /*
639 * Traverse the supplied list of reports and find the longest
640 */
641 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
642 unsigned int *max)
643 {
644 struct hid_report *report;
645 unsigned int size;
646
647 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
648 size = ((report->size - 1) >> 3) + 1;
649 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
650 size++;
651 if (*max < size)
652 *max = size;
653 }
654 }
655
656 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
657 {
658 struct usbhid_device *usbhid = hid->driver_data;
659
660 if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
661 return -1;
662 if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
663 return -1;
664 if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
665 return -1;
666 if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
667 return -1;
668
669 return 0;
670 }
671
672 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
673 {
674 struct usbhid_device *usbhid = hid->driver_data;
675 struct usb_device *dev = hid_to_usb_dev(hid);
676 struct usb_interface *intf = usbhid->intf;
677 struct usb_host_interface *interface = intf->cur_altsetting;
678 int ret;
679
680 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
681 HID_REQ_SET_REPORT,
682 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
683 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
684 interface->desc.bInterfaceNumber, buf + 1, count - 1,
685 USB_CTRL_SET_TIMEOUT);
686
687 /* count also the report id */
688 if (ret > 0)
689 ret++;
690
691 return ret;
692 }
693
694 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
695 {
696 struct usbhid_device *usbhid = hid->driver_data;
697
698 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
699 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
700 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
701 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
702 }
703
704 static int usbhid_parse(struct hid_device *hid)
705 {
706 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
707 struct usb_host_interface *interface = intf->cur_altsetting;
708 struct usb_device *dev = interface_to_usbdev (intf);
709 struct hid_descriptor *hdesc;
710 u32 quirks = 0;
711 unsigned int rsize = 0;
712 char *rdesc;
713 int ret, n;
714
715 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
716 le16_to_cpu(dev->descriptor.idProduct));
717
718 /* Many keyboards and mice don't like to be polled for reports,
719 * so we will always set the HID_QUIRK_NOGET flag for them. */
720 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
721 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
722 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
723 quirks |= HID_QUIRK_NOGET;
724 }
725
726 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
727 (!interface->desc.bNumEndpoints ||
728 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
729 dbg_hid("class descriptor not present\n");
730 return -ENODEV;
731 }
732
733 hid->version = le16_to_cpu(hdesc->bcdHID);
734 hid->country = hdesc->bCountryCode;
735
736 for (n = 0; n < hdesc->bNumDescriptors; n++)
737 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
738 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
739
740 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
741 dbg_hid("weird size of report descriptor (%u)\n", rsize);
742 return -EINVAL;
743 }
744
745 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
746 dbg_hid("couldn't allocate rdesc memory\n");
747 return -ENOMEM;
748 }
749
750 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
751
752 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
753 HID_DT_REPORT, rdesc, rsize);
754 if (ret < 0) {
755 dbg_hid("reading report descriptor failed\n");
756 kfree(rdesc);
757 goto err;
758 }
759
760 dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
761 for (n = 0; n < rsize; n++)
762 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
763 dbg_hid_line("\n");
764
765 ret = hid_parse_report(hid, rdesc, rsize);
766 kfree(rdesc);
767 if (ret) {
768 dbg_hid("parsing report descriptor failed\n");
769 goto err;
770 }
771
772 hid->quirks = quirks;
773
774 return 0;
775 err:
776 return ret;
777 }
778
779 static int usbhid_start(struct hid_device *hid)
780 {
781 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
782 struct usb_host_interface *interface = intf->cur_altsetting;
783 struct usb_device *dev = interface_to_usbdev(intf);
784 struct usbhid_device *usbhid = hid->driver_data;
785 unsigned int n, insize = 0;
786 int ret;
787
788 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
789
790 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
791 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
792 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
793 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
794
795 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
796 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
797
798 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
799
800 if (insize > HID_MAX_BUFFER_SIZE)
801 insize = HID_MAX_BUFFER_SIZE;
802
803 if (hid_alloc_buffers(dev, hid)) {
804 ret = -ENOMEM;
805 goto fail;
806 }
807
808 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
809 struct usb_endpoint_descriptor *endpoint;
810 int pipe;
811 int interval;
812
813 endpoint = &interface->endpoint[n].desc;
814 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
815 continue;
816
817 interval = endpoint->bInterval;
818
819 /* Some vendors give fullspeed interval on highspeed devides */
820 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
821 dev->speed == USB_SPEED_HIGH) {
822 interval = fls(endpoint->bInterval*8);
823 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
824 hid->name, endpoint->bInterval, interval);
825 }
826
827 /* Change the polling interval of mice. */
828 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
829 interval = hid_mousepoll_interval;
830
831 ret = -ENOMEM;
832 if (usb_endpoint_dir_in(endpoint)) {
833 if (usbhid->urbin)
834 continue;
835 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
836 goto fail;
837 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
838 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
839 hid_irq_in, hid, interval);
840 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
841 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
842 } else {
843 if (usbhid->urbout)
844 continue;
845 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
846 goto fail;
847 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
848 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
849 hid_irq_out, hid, interval);
850 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
851 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
852 }
853 }
854
855 init_waitqueue_head(&usbhid->wait);
856 INIT_WORK(&usbhid->reset_work, hid_reset);
857 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
858
859 spin_lock_init(&usbhid->inlock);
860 spin_lock_init(&usbhid->outlock);
861 spin_lock_init(&usbhid->ctrllock);
862
863 usbhid->intf = intf;
864 usbhid->ifnum = interface->desc.bInterfaceNumber;
865
866 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
867 if (!usbhid->urbctrl) {
868 ret = -ENOMEM;
869 goto fail;
870 }
871
872 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
873 usbhid->ctrlbuf, 1, hid_ctrl, hid);
874 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
875 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
876 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
877
878 usbhid_init_reports(hid);
879 hid_dump_device(hid);
880
881 set_bit(HID_STARTED, &usbhid->iofl);
882
883 return 0;
884
885 fail:
886 usb_free_urb(usbhid->urbin);
887 usb_free_urb(usbhid->urbout);
888 usb_free_urb(usbhid->urbctrl);
889 usbhid->urbin = NULL;
890 usbhid->urbout = NULL;
891 usbhid->urbctrl = NULL;
892 hid_free_buffers(dev, hid);
893 return ret;
894 }
895
896 static void usbhid_stop(struct hid_device *hid)
897 {
898 struct usbhid_device *usbhid = hid->driver_data;
899
900 if (WARN_ON(!usbhid))
901 return;
902
903 clear_bit(HID_STARTED, &usbhid->iofl);
904 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
905 set_bit(HID_DISCONNECTED, &usbhid->iofl);
906 spin_unlock_irq(&usbhid->inlock);
907 usb_kill_urb(usbhid->urbin);
908 usb_kill_urb(usbhid->urbout);
909 usb_kill_urb(usbhid->urbctrl);
910
911 del_timer_sync(&usbhid->io_retry);
912 cancel_work_sync(&usbhid->reset_work);
913
914 if (hid->claimed & HID_CLAIMED_INPUT)
915 hidinput_disconnect(hid);
916 if (hid->claimed & HID_CLAIMED_HIDDEV)
917 hiddev_disconnect(hid);
918 if (hid->claimed & HID_CLAIMED_HIDRAW)
919 hidraw_disconnect(hid);
920
921 hid->claimed = 0;
922
923 usb_free_urb(usbhid->urbin);
924 usb_free_urb(usbhid->urbctrl);
925 usb_free_urb(usbhid->urbout);
926 usbhid->urbin = NULL; /* don't mess up next start */
927 usbhid->urbctrl = NULL;
928 usbhid->urbout = NULL;
929
930 hid_free_buffers(hid_to_usb_dev(hid), hid);
931 }
932
933 static struct hid_ll_driver usb_hid_driver = {
934 .parse = usbhid_parse,
935 .start = usbhid_start,
936 .stop = usbhid_stop,
937 .open = usbhid_open,
938 .close = usbhid_close,
939 .hidinput_input_event = usb_hidinput_input_event,
940 };
941
942 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
943 {
944 struct usb_host_interface *interface = intf->cur_altsetting;
945 struct usb_device *dev = interface_to_usbdev(intf);
946 struct usbhid_device *usbhid;
947 struct hid_device *hid;
948 unsigned int n, has_in = 0;
949 size_t len;
950 int ret;
951
952 dbg_hid("HID probe called for ifnum %d\n",
953 intf->altsetting->desc.bInterfaceNumber);
954
955 for (n = 0; n < interface->desc.bNumEndpoints; n++)
956 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
957 has_in++;
958 if (!has_in) {
959 dev_err(&intf->dev, "couldn't find an input interrupt "
960 "endpoint\n");
961 return -ENODEV;
962 }
963
964 hid = hid_allocate_device();
965 if (IS_ERR(hid))
966 return PTR_ERR(hid);
967
968 usb_set_intfdata(intf, hid);
969 hid->ll_driver = &usb_hid_driver;
970 hid->hid_output_raw_report = usbhid_output_raw_report;
971 hid->ff_init = hid_pidff_init;
972 #ifdef CONFIG_USB_HIDDEV
973 hid->hiddev_connect = hiddev_connect;
974 hid->hiddev_hid_event = hiddev_hid_event;
975 hid->hiddev_report_event = hiddev_report_event;
976 #endif
977 hid->dev.parent = &intf->dev;
978 hid->bus = BUS_USB;
979 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
980 hid->product = le16_to_cpu(dev->descriptor.idProduct);
981 hid->name[0] = 0;
982 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
983 USB_INTERFACE_PROTOCOL_MOUSE)
984 hid->type = HID_TYPE_USBMOUSE;
985
986 if (dev->manufacturer)
987 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
988
989 if (dev->product) {
990 if (dev->manufacturer)
991 strlcat(hid->name, " ", sizeof(hid->name));
992 strlcat(hid->name, dev->product, sizeof(hid->name));
993 }
994
995 if (!strlen(hid->name))
996 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
997 le16_to_cpu(dev->descriptor.idVendor),
998 le16_to_cpu(dev->descriptor.idProduct));
999
1000 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1001 strlcat(hid->phys, "/input", sizeof(hid->phys));
1002 len = strlen(hid->phys);
1003 if (len < sizeof(hid->phys) - 1)
1004 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1005 "%d", intf->altsetting[0].desc.bInterfaceNumber);
1006
1007 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1008 hid->uniq[0] = 0;
1009
1010 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1011 if (usbhid == NULL) {
1012 ret = -ENOMEM;
1013 goto err;
1014 }
1015
1016 hid->driver_data = usbhid;
1017 usbhid->hid = hid;
1018
1019 ret = hid_add_device(hid);
1020 if (ret) {
1021 if (ret != -ENODEV)
1022 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1023 goto err_free;
1024 }
1025
1026 return 0;
1027 err_free:
1028 kfree(usbhid);
1029 err:
1030 hid_destroy_device(hid);
1031 return ret;
1032 }
1033
1034 static void hid_disconnect(struct usb_interface *intf)
1035 {
1036 struct hid_device *hid = usb_get_intfdata(intf);
1037 struct usbhid_device *usbhid;
1038
1039 if (WARN_ON(!hid))
1040 return;
1041
1042 usbhid = hid->driver_data;
1043 hid_destroy_device(hid);
1044 kfree(usbhid);
1045 }
1046
1047 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1048 {
1049 struct hid_device *hid = usb_get_intfdata (intf);
1050 struct usbhid_device *usbhid = hid->driver_data;
1051
1052 if (!test_bit(HID_STARTED, &usbhid->iofl))
1053 return 0;
1054
1055 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
1056 set_bit(HID_SUSPENDED, &usbhid->iofl);
1057 spin_unlock_irq(&usbhid->inlock);
1058 del_timer_sync(&usbhid->io_retry);
1059 usb_kill_urb(usbhid->urbin);
1060 dev_dbg(&intf->dev, "suspend\n");
1061 return 0;
1062 }
1063
1064 static int hid_resume(struct usb_interface *intf)
1065 {
1066 struct hid_device *hid = usb_get_intfdata (intf);
1067 struct usbhid_device *usbhid = hid->driver_data;
1068 int status;
1069
1070 if (!test_bit(HID_STARTED, &usbhid->iofl))
1071 return 0;
1072
1073 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1074 usbhid->retry_delay = 0;
1075 status = hid_start_in(hid);
1076 dev_dbg(&intf->dev, "resume status %d\n", status);
1077 return status;
1078 }
1079
1080 /* Treat USB reset pretty much the same as suspend/resume */
1081 static int hid_pre_reset(struct usb_interface *intf)
1082 {
1083 /* FIXME: What if the interface is already suspended? */
1084 hid_suspend(intf, PMSG_ON);
1085 return 0;
1086 }
1087
1088 /* Same routine used for post_reset and reset_resume */
1089 static int hid_post_reset(struct usb_interface *intf)
1090 {
1091 struct usb_device *dev = interface_to_usbdev (intf);
1092
1093 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1094 /* FIXME: Any more reinitialization needed? */
1095
1096 return hid_resume(intf);
1097 }
1098
1099 static struct usb_device_id hid_usb_ids [] = {
1100 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1101 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1102 { } /* Terminating entry */
1103 };
1104
1105 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1106
1107 static struct usb_driver hid_driver = {
1108 .name = "usbhid",
1109 .probe = hid_probe,
1110 .disconnect = hid_disconnect,
1111 .suspend = hid_suspend,
1112 .resume = hid_resume,
1113 .reset_resume = hid_post_reset,
1114 .pre_reset = hid_pre_reset,
1115 .post_reset = hid_post_reset,
1116 .id_table = hid_usb_ids,
1117 .supports_autosuspend = 1,
1118 };
1119
1120 static const struct hid_device_id hid_usb_table[] = {
1121 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1122 { }
1123 };
1124
1125 static struct hid_driver hid_usb_driver = {
1126 .name = "generic-usb",
1127 .id_table = hid_usb_table,
1128 };
1129
1130 static int __init hid_init(void)
1131 {
1132 int retval;
1133 retval = hid_register_driver(&hid_usb_driver);
1134 if (retval)
1135 goto hid_register_fail;
1136 retval = usbhid_quirks_init(quirks_param);
1137 if (retval)
1138 goto usbhid_quirks_init_fail;
1139 retval = hiddev_init();
1140 if (retval)
1141 goto hiddev_init_fail;
1142 retval = usb_register(&hid_driver);
1143 if (retval)
1144 goto usb_register_fail;
1145 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1146 DRIVER_DESC "\n");
1147
1148 return 0;
1149 usb_register_fail:
1150 hiddev_exit();
1151 hiddev_init_fail:
1152 usbhid_quirks_exit();
1153 usbhid_quirks_init_fail:
1154 hid_unregister_driver(&hid_usb_driver);
1155 hid_register_fail:
1156 return retval;
1157 }
1158
1159 static void __exit hid_exit(void)
1160 {
1161 usb_deregister(&hid_driver);
1162 hiddev_exit();
1163 usbhid_quirks_exit();
1164 hid_unregister_driver(&hid_usb_driver);
1165 }
1166
1167 module_init(hid_init);
1168 module_exit(hid_exit);
1169
1170 MODULE_AUTHOR(DRIVER_AUTHOR);
1171 MODULE_DESCRIPTION(DRIVER_DESC);
1172 MODULE_LICENSE(DRIVER_LICENSE);
Stable & featurefull patchset based on Linus's git branch