?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
allow coexistance of N build and AC build.
[tomato.git] / release / src-rt-6.x / linux / linux-2.6 / drivers / hid / usbhid / hid-core.c
blobb2aa7ff2dd3e9fca0efdbc0dcec1241c70e2c311
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/smp_lock.h>
24 #include <linux/spinlock.h>
25 #include <asm/unaligned.h>
26 #include <asm/byteorder.h>
27 #include <linux/input.h>
28 #include <linux/wait.h>
29
30 #include <linux/usb.h>
31
32 #include <linux/hid.h>
33 #include <linux/hiddev.h>
34 #include <linux/hid-debug.h>
35 #include "usbhid.h"
36
37 /*
38 * Version Information
39 */
40
41 #define DRIVER_VERSION "v2.6"
42 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
43 #define DRIVER_DESC "USB HID core driver"
44 #define DRIVER_LICENSE "GPL"
45
46 static char *hid_types[] = {"Device", "Pointer", "Mouse", "Device", "Joystick",
47 "Gamepad", "Keyboard", "Keypad", "Multi-Axis Controller"};
48 /*
49 * Module parameters.
50 */
51
52 static unsigned int hid_mousepoll_interval;
53 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
54 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
55
56 /* Quirks specified at module load time */
57 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
58 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
59 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
60 " quirks=vendorID:productID:quirks"
61 " where vendorID, productID, and quirks are all in"
62 " 0x-prefixed hex");
63 static char *rdesc_quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
64 module_param_array_named(rdesc_quirks, rdesc_quirks_param, charp, NULL, 0444);
65 MODULE_PARM_DESC(rdesc_quirks, "Add/modify report descriptor quirks by specifying "
66 " rdesc_quirks=vendorID:productID:rdesc_quirks"
67 " where vendorID, productID, and rdesc_quirks are all in"
68 " 0x-prefixed hex");
69 /*
70 * Input submission and I/O error handler.
71 */
72
73 static void hid_io_error(struct hid_device *hid);
74
75 /* Start up the input URB */
76 static int hid_start_in(struct hid_device *hid)
77 {
78 unsigned long flags;
79 int rc = 0;
80 struct usbhid_device *usbhid = hid->driver_data;
81
82 spin_lock_irqsave(&usbhid->inlock, flags);
83 if (hid->open > 0 && !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
84 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
85 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
86 if (rc != 0)
87 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
88 }
89 spin_unlock_irqrestore(&usbhid->inlock, flags);
90 return rc;
91 }
92
93 /* I/O retry timer routine */
94 static void hid_retry_timeout(unsigned long _hid)
95 {
96 struct hid_device *hid = (struct hid_device *) _hid;
97 struct usbhid_device *usbhid = hid->driver_data;
98
99 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
100 if (hid_start_in(hid))
101 hid_io_error(hid);
102 }
103
104 /* Workqueue routine to reset the device or clear a halt */
105 static void hid_reset(struct work_struct *work)
106 {
107 struct usbhid_device *usbhid =
108 container_of(work, struct usbhid_device, reset_work);
109 struct hid_device *hid = usbhid->hid;
110 int rc = 0;
111
112 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
113 dev_dbg(&usbhid->intf->dev, "clear halt\n");
114 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
115 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
116 hid_start_in(hid);
117 }
118
119 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
120 dev_dbg(&usbhid->intf->dev, "resetting device\n");
121 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
122 if (rc == 0) {
123 rc = usb_reset_device(hid_to_usb_dev(hid));
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 (usb_get_intfdata(usbhid->intf) == NULL)
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 warn("input irq status %d received", urb->status);
222 }
223
224 status = usb_submit_urb(urb, GFP_ATOMIC);
225 if (status) {
226 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
227 if (status != -EPERM) {
228 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
229 hid_to_usb_dev(hid)->bus->bus_name,
230 hid_to_usb_dev(hid)->devpath,
231 usbhid->ifnum, status);
232 hid_io_error(hid);
233 }
234 }
235 }
236
237 static int hid_submit_out(struct hid_device *hid)
238 {
239 struct hid_report *report;
240 struct usbhid_device *usbhid = hid->driver_data;
241
242 report = usbhid->out[usbhid->outtail];
243
244 hid_output_report(report, usbhid->outbuf);
245 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
246 usbhid->urbout->dev = hid_to_usb_dev(hid);
247
248 dbg_hid("submitting out urb\n");
249
250 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
251 err_hid("usb_submit_urb(out) failed");
252 return -1;
253 }
254
255 return 0;
256 }
257
258 static int hid_submit_ctrl(struct hid_device *hid)
259 {
260 struct hid_report *report;
261 unsigned char dir;
262 int len;
263 struct usbhid_device *usbhid = hid->driver_data;
264
265 report = usbhid->ctrl[usbhid->ctrltail].report;
266 dir = usbhid->ctrl[usbhid->ctrltail].dir;
267
268 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
269 if (dir == USB_DIR_OUT) {
270 hid_output_report(report, usbhid->ctrlbuf);
271 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
272 usbhid->urbctrl->transfer_buffer_length = len;
273 } else {
274 int maxpacket, padlen;
275
276 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
277 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
278 if (maxpacket > 0) {
279 padlen = (len + maxpacket - 1) / maxpacket;
280 padlen *= maxpacket;
281 if (padlen > usbhid->bufsize)
282 padlen = usbhid->bufsize;
283 } else
284 padlen = 0;
285 usbhid->urbctrl->transfer_buffer_length = padlen;
286 }
287 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
288
289 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
290 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
291 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
292 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
293 usbhid->cr->wLength = cpu_to_le16(len);
294
295 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
296 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
297 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
298
299 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
300 err_hid("usb_submit_urb(ctrl) failed");
301 return -1;
302 }
303
304 return 0;
305 }
306
307 /*
308 * Output interrupt completion handler.
309 */
310
311 static void hid_irq_out(struct urb *urb)
312 {
313 struct hid_device *hid = urb->context;
314 struct usbhid_device *usbhid = hid->driver_data;
315 unsigned long flags;
316 int unplug = 0;
317
318 switch (urb->status) {
319 case 0: /* success */
320 break;
321 case -ESHUTDOWN: /* unplug */
322 unplug = 1;
323 case -EILSEQ: /* protocol error or unplug */
324 case -EPROTO: /* protocol error or unplug */
325 case -ECONNRESET: /* unlink */
326 case -ENOENT:
327 break;
328 default: /* error */
329 warn("output irq status %d received", urb->status);
330 }
331
332 spin_lock_irqsave(&usbhid->outlock, flags);
333
334 if (unplug)
335 usbhid->outtail = usbhid->outhead;
336 else
337 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
338
339 if (usbhid->outhead != usbhid->outtail) {
340 if (hid_submit_out(hid)) {
341 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
342 wake_up(&hid->wait);
343 }
344 spin_unlock_irqrestore(&usbhid->outlock, flags);
345 return;
346 }
347
348 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
349 spin_unlock_irqrestore(&usbhid->outlock, flags);
350 wake_up(&hid->wait);
351 }
352
353 /*
354 * Control pipe completion handler.
355 */
356
357 static void hid_ctrl(struct urb *urb)
358 {
359 struct hid_device *hid = urb->context;
360 struct usbhid_device *usbhid = hid->driver_data;
361 unsigned long flags;
362 int unplug = 0;
363
364 spin_lock_irqsave(&usbhid->ctrllock, flags);
365
366 switch (urb->status) {
367 case 0: /* success */
368 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
369 hid_input_report(urb->context, usbhid->ctrl[usbhid->ctrltail].report->type,
370 urb->transfer_buffer, urb->actual_length, 0);
371 break;
372 case -ESHUTDOWN: /* unplug */
373 unplug = 1;
374 case -EILSEQ: /* protocol error or unplug */
375 case -EPROTO: /* protocol error or unplug */
376 case -ECONNRESET: /* unlink */
377 case -ENOENT:
378 case -EPIPE: /* report not available */
379 break;
380 default: /* error */
381 warn("ctrl urb status %d received", urb->status);
382 }
383
384 if (unplug)
385 usbhid->ctrltail = usbhid->ctrlhead;
386 else
387 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
388
389 if (usbhid->ctrlhead != usbhid->ctrltail) {
390 if (hid_submit_ctrl(hid)) {
391 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
392 wake_up(&hid->wait);
393 }
394 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
395 return;
396 }
397
398 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
399 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
400 wake_up(&hid->wait);
401 }
402
403 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
404 {
405 int head;
406 unsigned long flags;
407 struct usbhid_device *usbhid = hid->driver_data;
408
409 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
410 return;
411
412 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
413
414 spin_lock_irqsave(&usbhid->outlock, flags);
415
416 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
417 spin_unlock_irqrestore(&usbhid->outlock, flags);
418 warn("output queue full");
419 return;
420 }
421
422 usbhid->out[usbhid->outhead] = report;
423 usbhid->outhead = head;
424
425 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
426 if (hid_submit_out(hid))
427 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
428
429 spin_unlock_irqrestore(&usbhid->outlock, flags);
430 return;
431 }
432
433 spin_lock_irqsave(&usbhid->ctrllock, flags);
434
435 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
436 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
437 warn("control queue full");
438 return;
439 }
440
441 usbhid->ctrl[usbhid->ctrlhead].report = report;
442 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
443 usbhid->ctrlhead = head;
444
445 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
446 if (hid_submit_ctrl(hid))
447 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
448
449 spin_unlock_irqrestore(&usbhid->ctrllock, flags);
450 }
451
452 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
453 {
454 struct hid_device *hid = input_get_drvdata(dev);
455 struct hid_field *field;
456 int offset;
457
458 if (type == EV_FF)
459 return input_ff_event(dev, type, code, value);
460
461 if (type != EV_LED)
462 return -1;
463
464 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
465 warn("event field not found");
466 return -1;
467 }
468
469 hid_set_field(field, offset, value);
470 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
471
472 return 0;
473 }
474
475 int usbhid_wait_io(struct hid_device *hid)
476 {
477 struct usbhid_device *usbhid = hid->driver_data;
478
479 if (!wait_event_timeout(hid->wait, (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
480 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
481 10*HZ)) {
482 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
483 return -1;
484 }
485
486 return 0;
487 }
488
489 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
490 {
491 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
492 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
493 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
494 }
495
496 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
497 unsigned char type, void *buf, int size)
498 {
499 int result, retries = 4;
500
501 memset(buf, 0, size);
502
503 do {
504 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
505 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
506 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
507 retries--;
508 } while (result < size && retries);
509 return result;
510 }
511
512 int usbhid_open(struct hid_device *hid)
513 {
514 ++hid->open;
515 if (hid_start_in(hid))
516 hid_io_error(hid);
517 return 0;
518 }
519
520 void usbhid_close(struct hid_device *hid)
521 {
522 struct usbhid_device *usbhid = hid->driver_data;
523
524 if (!--hid->open)
525 usb_kill_urb(usbhid->urbin);
526 }
527
528 /*
529 * Initialize all reports
530 */
531
532 void usbhid_init_reports(struct hid_device *hid)
533 {
534 struct hid_report *report;
535 struct usbhid_device *usbhid = hid->driver_data;
536 int err, ret;
537
538 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
539 usbhid_submit_report(hid, report, USB_DIR_IN);
540
541 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
542 usbhid_submit_report(hid, report, USB_DIR_IN);
543
544 err = 0;
545 ret = usbhid_wait_io(hid);
546 while (ret) {
547 err |= ret;
548 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
549 usb_kill_urb(usbhid->urbctrl);
550 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
551 usb_kill_urb(usbhid->urbout);
552 ret = usbhid_wait_io(hid);
553 }
554
555 if (err)
556 warn("timeout initializing reports");
557 }
558
559 /*
560 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
561 */
562 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
563 unsigned int hid_code, struct hid_field **pfield)
564 {
565 struct hid_report *report;
566 struct hid_field *field;
567 struct hid_usage *usage;
568 int i, j;
569
570 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
571 for (i = 0; i < report->maxfield; i++) {
572 field = report->field[i];
573 for (j = 0; j < field->maxusage; j++) {
574 usage = &field->usage[j];
575 if ((usage->hid & HID_USAGE_PAGE) == page &&
576 (usage->hid & 0xFFFF) == hid_code) {
577 *pfield = field;
578 return j;
579 }
580 }
581 }
582 }
583 return -1;
584 }
585
586 static void usbhid_set_leds(struct hid_device *hid)
587 {
588 struct hid_field *field;
589 int offset;
590
591 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
592 hid_set_field(field, offset, 0);
593 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
594 }
595 }
596
597 /*
598 * Traverse the supplied list of reports and find the longest
599 */
600 static void hid_find_max_report(struct hid_device *hid, unsigned int type, int *max)
601 {
602 struct hid_report *report;
603 int size;
604
605 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
606 size = ((report->size - 1) >> 3) + 1;
607 if (type == HID_INPUT_REPORT && hid->report_enum[type].numbered)
608 size++;
609 if (*max < size)
610 *max = size;
611 }
612 }
613
614 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
615 {
616 struct usbhid_device *usbhid = hid->driver_data;
617
618 if (!(usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->inbuf_dma)))
619 return -1;
620 if (!(usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->outbuf_dma)))
621 return -1;
622 if (!(usbhid->cr = usb_buffer_alloc(dev, sizeof(*(usbhid->cr)), GFP_ATOMIC, &usbhid->cr_dma)))
623 return -1;
624 if (!(usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_ATOMIC, &usbhid->ctrlbuf_dma)))
625 return -1;
626
627 return 0;
628 }
629
630 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
631 {
632 struct usbhid_device *usbhid = hid->driver_data;
633
634 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
635 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
636 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
637 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
638 }
639
640 /*
641 * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
642 * to "operational". Without this, the ps3 controller will not report any
643 * events.
644 */
645 static void hid_fixup_sony_ps3_controller(struct usb_device *dev, int ifnum)
646 {
647 int result;
648 char *buf = kmalloc(18, GFP_KERNEL);
649
650 if (!buf)
651 return;
652
653 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
654 HID_REQ_GET_REPORT,
655 USB_DIR_IN | USB_TYPE_CLASS |
656 USB_RECIP_INTERFACE,
657 (3 << 8) | 0xf2, ifnum, buf, 17,
658 USB_CTRL_GET_TIMEOUT);
659
660 if (result < 0)
661 err_hid("%s failed: %d\n", __func__, result);
662
663 kfree(buf);
664 }
665
666 static struct hid_device *usb_hid_configure(struct usb_interface *intf)
667 {
668 struct usb_host_interface *interface = intf->cur_altsetting;
669 struct usb_device *dev = interface_to_usbdev (intf);
670 struct hid_descriptor *hdesc;
671 struct hid_device *hid;
672 u32 quirks = 0;
673 unsigned rsize = 0;
674 char *rdesc;
675 int n, len, insize = 0;
676 struct usbhid_device *usbhid;
677
678 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
679 le16_to_cpu(dev->descriptor.idProduct));
680
681 /* Many keyboards and mice don't like to be polled for reports,
682 * so we will always set the HID_QUIRK_NOGET flag for them. */
683 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
684 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
685 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
686 quirks |= HID_QUIRK_NOGET;
687 }
688
689 if (quirks & HID_QUIRK_IGNORE)
690 return NULL;
691
692 if ((quirks & HID_QUIRK_IGNORE_MOUSE) &&
693 (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE))
694 return NULL;
695
696
697 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
698 (!interface->desc.bNumEndpoints ||
699 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
700 dbg_hid("class descriptor not present\n");
701 return NULL;
702 }
703
704 for (n = 0; n < hdesc->bNumDescriptors; n++)
705 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
706 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
707
708 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
709 dbg_hid("weird size of report descriptor (%u)\n", rsize);
710 return NULL;
711 }
712
713 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
714 dbg_hid("couldn't allocate rdesc memory\n");
715 return NULL;
716 }
717
718 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
719
720 if ((n = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) {
721 dbg_hid("reading report descriptor failed\n");
722 kfree(rdesc);
723 return NULL;
724 }
725
726 usbhid_fixup_report_descriptor(le16_to_cpu(dev->descriptor.idVendor),
727 le16_to_cpu(dev->descriptor.idProduct), rdesc,
728 rsize, rdesc_quirks_param);
729
730 dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
731 for (n = 0; n < rsize; n++)
732 dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
733 dbg_hid_line("\n");
734
735 if (!(hid = hid_parse_report(rdesc, n))) {
736 dbg_hid("parsing report descriptor failed\n");
737 kfree(rdesc);
738 return NULL;
739 }
740
741 kfree(rdesc);
742 hid->quirks = quirks;
743
744 if (!(usbhid = kzalloc(sizeof(struct usbhid_device), GFP_KERNEL)))
745 goto fail_no_usbhid;
746
747 hid->driver_data = usbhid;
748 usbhid->hid = hid;
749
750 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
751 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
752 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
753 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
754
755 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
756 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
757
758 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
759
760 if (insize > HID_MAX_BUFFER_SIZE)
761 insize = HID_MAX_BUFFER_SIZE;
762
763 if (hid_alloc_buffers(dev, hid)) {
764 hid_free_buffers(dev, hid);
765 goto fail;
766 }
767
768 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
769
770 struct usb_endpoint_descriptor *endpoint;
771 int pipe;
772 int interval;
773
774 endpoint = &interface->endpoint[n].desc;
775 if ((endpoint->bmAttributes & 3) != 3) /* Not an interrupt endpoint */
776 continue;
777
778 interval = endpoint->bInterval;
779
780 /* Change the polling interval of mice. */
781 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
782 interval = hid_mousepoll_interval;
783
784 if (usb_endpoint_dir_in(endpoint)) {
785 if (usbhid->urbin)
786 continue;
787 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
788 goto fail;
789 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
790 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
791 hid_irq_in, hid, interval);
792 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
793 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
794 } else {
795 if (usbhid->urbout)
796 continue;
797 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
798 goto fail;
799 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
800 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
801 hid_irq_out, hid, interval);
802 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
803 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
804 }
805 }
806
807 if (!usbhid->urbin) {
808 err_hid("couldn't find an input interrupt endpoint");
809 goto fail;
810 }
811
812 init_waitqueue_head(&hid->wait);
813
814 INIT_WORK(&usbhid->reset_work, hid_reset);
815 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
816
817 spin_lock_init(&usbhid->inlock);
818 spin_lock_init(&usbhid->outlock);
819 spin_lock_init(&usbhid->ctrllock);
820
821 hid->version = le16_to_cpu(hdesc->bcdHID);
822 hid->country = hdesc->bCountryCode;
823 hid->dev = &intf->dev;
824 usbhid->intf = intf;
825 usbhid->ifnum = interface->desc.bInterfaceNumber;
826
827 hid->name[0] = 0;
828
829 if (dev->manufacturer)
830 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
831
832 if (dev->product) {
833 if (dev->manufacturer)
834 strlcat(hid->name, " ", sizeof(hid->name));
835 strlcat(hid->name, dev->product, sizeof(hid->name));
836 }
837
838 if (!strlen(hid->name))
839 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
840 le16_to_cpu(dev->descriptor.idVendor),
841 le16_to_cpu(dev->descriptor.idProduct));
842
843 hid->bus = BUS_USB;
844 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
845 hid->product = le16_to_cpu(dev->descriptor.idProduct);
846
847 usb_make_path(dev, hid->phys, sizeof(hid->phys));
848 strlcat(hid->phys, "/input", sizeof(hid->phys));
849 len = strlen(hid->phys);
850 if (len < sizeof(hid->phys) - 1)
851 snprintf(hid->phys + len, sizeof(hid->phys) - len,
852 "%d", intf->altsetting[0].desc.bInterfaceNumber);
853
854 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
855 hid->uniq[0] = 0;
856
857 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
858 if (!usbhid->urbctrl)
859 goto fail;
860
861 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
862 usbhid->ctrlbuf, 1, hid_ctrl, hid);
863 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
864 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
865 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
866 hid->hidinput_input_event = usb_hidinput_input_event;
867 hid->hid_open = usbhid_open;
868 hid->hid_close = usbhid_close;
869 #ifdef CONFIG_USB_HIDDEV
870 hid->hiddev_hid_event = hiddev_hid_event;
871 hid->hiddev_report_event = hiddev_report_event;
872 #endif
873 return hid;
874
875 fail:
876 usb_free_urb(usbhid->urbin);
877 usb_free_urb(usbhid->urbout);
878 usb_free_urb(usbhid->urbctrl);
879 hid_free_buffers(dev, hid);
880 kfree(usbhid);
881 fail_no_usbhid:
882 hid_free_device(hid);
883
884 return NULL;
885 }
886
887 static void hid_disconnect(struct usb_interface *intf)
888 {
889 struct hid_device *hid = usb_get_intfdata (intf);
890 struct usbhid_device *usbhid;
891
892 if (!hid)
893 return;
894
895 usbhid = hid->driver_data;
896
897 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
898 usb_set_intfdata(intf, NULL);
899 spin_unlock_irq(&usbhid->inlock);
900 usb_kill_urb(usbhid->urbin);
901 usb_kill_urb(usbhid->urbout);
902 usb_kill_urb(usbhid->urbctrl);
903
904 del_timer_sync(&usbhid->io_retry);
905 cancel_work_sync(&usbhid->reset_work);
906
907 if (hid->claimed & HID_CLAIMED_INPUT)
908 hidinput_disconnect(hid);
909 if (hid->claimed & HID_CLAIMED_HIDDEV)
910 hiddev_disconnect(hid);
911
912 usb_free_urb(usbhid->urbin);
913 usb_free_urb(usbhid->urbctrl);
914 usb_free_urb(usbhid->urbout);
915
916 hid_free_buffers(hid_to_usb_dev(hid), hid);
917 kfree(usbhid);
918 hid_free_device(hid);
919 }
920
921 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
922 {
923 struct hid_device *hid;
924 char path[64];
925 int i;
926 char *c;
927
928 dbg_hid("HID probe called for ifnum %d\n",
929 intf->altsetting->desc.bInterfaceNumber);
930
931 if (!(hid = usb_hid_configure(intf)))
932 return -ENODEV;
933
934 usbhid_init_reports(hid);
935 hid_dump_device(hid);
936 if (hid->quirks & HID_QUIRK_RESET_LEDS)
937 usbhid_set_leds(hid);
938
939 if (!hidinput_connect(hid))
940 hid->claimed |= HID_CLAIMED_INPUT;
941 if (!hiddev_connect(hid))
942 hid->claimed |= HID_CLAIMED_HIDDEV;
943
944 usb_set_intfdata(intf, hid);
945
946 if (!hid->claimed) {
947 printk ("HID device not claimed by input or hiddev\n");
948 hid_disconnect(intf);
949 return -ENODEV;
950 }
951
952 if ((hid->claimed & HID_CLAIMED_INPUT))
953 hid_ff_init(hid);
954
955 if (hid->quirks & HID_QUIRK_SONY_PS3_CONTROLLER)
956 hid_fixup_sony_ps3_controller(interface_to_usbdev(intf),
957 intf->cur_altsetting->desc.bInterfaceNumber);
958
959 printk(KERN_INFO);
960
961 if (hid->claimed & HID_CLAIMED_INPUT)
962 printk("input");
963 if (hid->claimed == (HID_CLAIMED_INPUT | HID_CLAIMED_HIDDEV))
964 printk(",");
965 if (hid->claimed & HID_CLAIMED_HIDDEV)
966 printk("hiddev%d", hid->minor);
967
968 c = "Device";
969 for (i = 0; i < hid->maxcollection; i++) {
970 if (hid->collection[i].type == HID_COLLECTION_APPLICATION &&
971 (hid->collection[i].usage & HID_USAGE_PAGE) == HID_UP_GENDESK &&
972 (hid->collection[i].usage & 0xffff) < ARRAY_SIZE(hid_types)) {
973 c = hid_types[hid->collection[i].usage & 0xffff];
974 break;
975 }
976 }
977
978 usb_make_path(interface_to_usbdev(intf), path, 63);
979
980 printk(": USB HID v%x.%02x %s [%s] on %s\n",
981 hid->version >> 8, hid->version & 0xff, c, hid->name, path);
982
983 return 0;
984 }
985
986 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
987 {
988 struct hid_device *hid = usb_get_intfdata (intf);
989 struct usbhid_device *usbhid = hid->driver_data;
990
991 spin_lock_irq(&usbhid->inlock); /* Sync with error handler */
992 set_bit(HID_SUSPENDED, &usbhid->iofl);
993 spin_unlock_irq(&usbhid->inlock);
994 del_timer(&usbhid->io_retry);
995 usb_kill_urb(usbhid->urbin);
996 dev_dbg(&intf->dev, "suspend\n");
997 return 0;
998 }
999
1000 static int hid_resume(struct usb_interface *intf)
1001 {
1002 struct hid_device *hid = usb_get_intfdata (intf);
1003 struct usbhid_device *usbhid = hid->driver_data;
1004 int status;
1005
1006 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1007 usbhid->retry_delay = 0;
1008 status = hid_start_in(hid);
1009 dev_dbg(&intf->dev, "resume status %d\n", status);
1010 return status;
1011 }
1012
1013 /* Treat USB reset pretty much the same as suspend/resume */
1014 static int hid_pre_reset(struct usb_interface *intf)
1015 {
1016 /* FIXME: What if the interface is already suspended? */
1017 hid_suspend(intf, PMSG_ON);
1018 return 0;
1019 }
1020
1021 /* Same routine used for post_reset and reset_resume */
1022 static int hid_post_reset(struct usb_interface *intf)
1023 {
1024 struct usb_device *dev = interface_to_usbdev (intf);
1025
1026 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1027 /* FIXME: Any more reinitialization needed? */
1028
1029 return hid_resume(intf);
1030 }
1031
1032 static struct usb_device_id hid_usb_ids [] = {
1033 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1034 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1035 { } /* Terminating entry */
1036 };
1037
1038 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1039
1040 static struct usb_driver hid_driver = {
1041 .name = "usbhid",
1042 .probe = hid_probe,
1043 .disconnect = hid_disconnect,
1044 .suspend = hid_suspend,
1045 .resume = hid_resume,
1046 .reset_resume = hid_post_reset,
1047 .pre_reset = hid_pre_reset,
1048 .post_reset = hid_post_reset,
1049 .id_table = hid_usb_ids,
1050 };
1051
1052 static int __init hid_init(void)
1053 {
1054 int retval;
1055 retval = usbhid_quirks_init(quirks_param);
1056 if (retval)
1057 goto usbhid_quirks_init_fail;
1058 retval = hiddev_init();
1059 if (retval)
1060 goto hiddev_init_fail;
1061 retval = usb_register(&hid_driver);
1062 if (retval)
1063 goto usb_register_fail;
1064 info(DRIVER_VERSION ":" DRIVER_DESC);
1065
1066 return 0;
1067 usb_register_fail:
1068 hiddev_exit();
1069 hiddev_init_fail:
1070 usbhid_quirks_exit();
1071 usbhid_quirks_init_fail:
1072 return retval;
1073 }
1074
1075 static void __exit hid_exit(void)
1076 {
1077 usb_deregister(&hid_driver);
1078 hiddev_exit();
1079 usbhid_quirks_exit();
1080 }
1081
1082 module_init(hid_init);
1083 module_exit(hid_exit);
1084
1085 MODULE_AUTHOR(DRIVER_AUTHOR);
1086 MODULE_DESCRIPTION(DRIVER_DESC);
1087 MODULE_LICENSE(DRIVER_LICENSE);
Tomato firmware and modifications.