xref: /openbmc/linux/drivers/hid/usbhid/hid-core.c (revision fd589a8f)
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-2009 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 
32 #include <linux/usb.h>
33 
34 #include <linux/hid.h>
35 #include <linux/hiddev.h>
36 #include <linux/hid-debug.h>
37 #include <linux/hidraw.h>
38 #include "usbhid.h"
39 
40 /*
41  * Version Information
42  */
43 
44 #define DRIVER_VERSION "v2.6"
45 #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
46 #define DRIVER_DESC "USB HID core driver"
47 #define DRIVER_LICENSE "GPL"
48 
49 /*
50  * Module parameters.
51  */
52 
53 static unsigned int hid_mousepoll_interval;
54 module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
55 MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
56 
57 static unsigned int ignoreled;
58 module_param_named(ignoreled, ignoreled, uint, 0644);
59 MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
60 
61 /* Quirks specified at module load time */
62 static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
63 module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
64 MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
65 		" quirks=vendorID:productID:quirks"
66 		" where vendorID, productID, and quirks are all in"
67 		" 0x-prefixed hex");
68 /*
69  * Input submission and I/O error handler.
70  */
71 static DEFINE_MUTEX(hid_open_mut);
72 static struct workqueue_struct *resumption_waker;
73 
74 static void hid_io_error(struct hid_device *hid);
75 static int hid_submit_out(struct hid_device *hid);
76 static int hid_submit_ctrl(struct hid_device *hid);
77 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
78 
79 /* Start up the input URB */
80 static int hid_start_in(struct hid_device *hid)
81 {
82 	unsigned long flags;
83 	int rc = 0;
84 	struct usbhid_device *usbhid = hid->driver_data;
85 
86 	spin_lock_irqsave(&usbhid->lock, flags);
87 	if (hid->open > 0 &&
88 			!test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
89 			!test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
90 			!test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
91 		rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
92 		if (rc != 0)
93 			clear_bit(HID_IN_RUNNING, &usbhid->iofl);
94 	}
95 	spin_unlock_irqrestore(&usbhid->lock, flags);
96 	return rc;
97 }
98 
99 /* I/O retry timer routine */
100 static void hid_retry_timeout(unsigned long _hid)
101 {
102 	struct hid_device *hid = (struct hid_device *) _hid;
103 	struct usbhid_device *usbhid = hid->driver_data;
104 
105 	dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
106 	if (hid_start_in(hid))
107 		hid_io_error(hid);
108 }
109 
110 /* Workqueue routine to reset the device or clear a halt */
111 static void hid_reset(struct work_struct *work)
112 {
113 	struct usbhid_device *usbhid =
114 		container_of(work, struct usbhid_device, reset_work);
115 	struct hid_device *hid = usbhid->hid;
116 	int rc = 0;
117 
118 	if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
119 		dev_dbg(&usbhid->intf->dev, "clear halt\n");
120 		rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
121 		clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
122 		hid_start_in(hid);
123 	}
124 
125 	else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
126 		dev_dbg(&usbhid->intf->dev, "resetting device\n");
127 		rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
128 		if (rc == 0) {
129 			rc = usb_reset_device(hid_to_usb_dev(hid));
130 			usb_unlock_device(hid_to_usb_dev(hid));
131 		}
132 		clear_bit(HID_RESET_PENDING, &usbhid->iofl);
133 	}
134 
135 	switch (rc) {
136 	case 0:
137 		if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
138 			hid_io_error(hid);
139 		break;
140 	default:
141 		err_hid("can't reset device, %s-%s/input%d, status %d",
142 				hid_to_usb_dev(hid)->bus->bus_name,
143 				hid_to_usb_dev(hid)->devpath,
144 				usbhid->ifnum, rc);
145 		/* FALLTHROUGH */
146 	case -EHOSTUNREACH:
147 	case -ENODEV:
148 	case -EINTR:
149 		break;
150 	}
151 }
152 
153 /* Main I/O error handler */
154 static void hid_io_error(struct hid_device *hid)
155 {
156 	unsigned long flags;
157 	struct usbhid_device *usbhid = hid->driver_data;
158 
159 	spin_lock_irqsave(&usbhid->lock, flags);
160 
161 	/* Stop when disconnected */
162 	if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
163 		goto done;
164 
165 	/* If it has been a while since the last error, we'll assume
166 	 * this a brand new error and reset the retry timeout. */
167 	if (time_after(jiffies, usbhid->stop_retry + HZ/2))
168 		usbhid->retry_delay = 0;
169 
170 	/* When an error occurs, retry at increasing intervals */
171 	if (usbhid->retry_delay == 0) {
172 		usbhid->retry_delay = 13;	/* Then 26, 52, 104, 104, ... */
173 		usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
174 	} else if (usbhid->retry_delay < 100)
175 		usbhid->retry_delay *= 2;
176 
177 	if (time_after(jiffies, usbhid->stop_retry)) {
178 
179 		/* Retries failed, so do a port reset */
180 		if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
181 			schedule_work(&usbhid->reset_work);
182 			goto done;
183 		}
184 	}
185 
186 	mod_timer(&usbhid->io_retry,
187 			jiffies + msecs_to_jiffies(usbhid->retry_delay));
188 done:
189 	spin_unlock_irqrestore(&usbhid->lock, flags);
190 }
191 
192 static void usbhid_mark_busy(struct usbhid_device *usbhid)
193 {
194 	struct usb_interface *intf = usbhid->intf;
195 
196 	usb_mark_last_busy(interface_to_usbdev(intf));
197 }
198 
199 static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
200 {
201 	struct hid_device *hid = usb_get_intfdata(usbhid->intf);
202 	int kicked;
203 
204 	if (!hid)
205 		return 0;
206 
207 	if ((kicked = (usbhid->outhead != usbhid->outtail))) {
208 		dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
209 		if (hid_submit_out(hid)) {
210 			clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
211 			wake_up(&usbhid->wait);
212 		}
213 	}
214 	return kicked;
215 }
216 
217 static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
218 {
219 	struct hid_device *hid = usb_get_intfdata(usbhid->intf);
220 	int kicked;
221 
222 	WARN_ON(hid == NULL);
223 	if (!hid)
224 		return 0;
225 
226 	if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
227 		dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
228 		if (hid_submit_ctrl(hid)) {
229 			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
230 			wake_up(&usbhid->wait);
231 		}
232 	}
233 	return kicked;
234 }
235 
236 /*
237  * Input interrupt completion handler.
238  */
239 
240 static void hid_irq_in(struct urb *urb)
241 {
242 	struct hid_device	*hid = urb->context;
243 	struct usbhid_device 	*usbhid = hid->driver_data;
244 	int			status;
245 
246 	switch (urb->status) {
247 	case 0:			/* success */
248 		usbhid_mark_busy(usbhid);
249 		usbhid->retry_delay = 0;
250 		hid_input_report(urb->context, HID_INPUT_REPORT,
251 				 urb->transfer_buffer,
252 				 urb->actual_length, 1);
253 		/*
254 		 * autosuspend refused while keys are pressed
255 		 * because most keyboards don't wake up when
256 		 * a key is released
257 		 */
258 		if (hid_check_keys_pressed(hid))
259 			set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
260 		else
261 			clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
262 		break;
263 	case -EPIPE:		/* stall */
264 		usbhid_mark_busy(usbhid);
265 		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
266 		set_bit(HID_CLEAR_HALT, &usbhid->iofl);
267 		schedule_work(&usbhid->reset_work);
268 		return;
269 	case -ECONNRESET:	/* unlink */
270 	case -ENOENT:
271 	case -ESHUTDOWN:	/* unplug */
272 		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
273 		return;
274 	case -EILSEQ:		/* protocol error or unplug */
275 	case -EPROTO:		/* protocol error or unplug */
276 	case -ETIME:		/* protocol error or unplug */
277 	case -ETIMEDOUT:	/* Should never happen, but... */
278 		usbhid_mark_busy(usbhid);
279 		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
280 		hid_io_error(hid);
281 		return;
282 	default:		/* error */
283 		dev_warn(&urb->dev->dev, "input irq status %d  "
284 				"received\n", urb->status);
285 	}
286 
287 	status = usb_submit_urb(urb, GFP_ATOMIC);
288 	if (status) {
289 		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
290 		if (status != -EPERM) {
291 			err_hid("can't resubmit intr, %s-%s/input%d, status %d",
292 					hid_to_usb_dev(hid)->bus->bus_name,
293 					hid_to_usb_dev(hid)->devpath,
294 					usbhid->ifnum, status);
295 			hid_io_error(hid);
296 		}
297 	}
298 }
299 
300 static int hid_submit_out(struct hid_device *hid)
301 {
302 	struct hid_report *report;
303 	char *raw_report;
304 	struct usbhid_device *usbhid = hid->driver_data;
305 
306 	report = usbhid->out[usbhid->outtail].report;
307 	raw_report = usbhid->out[usbhid->outtail].raw_report;
308 
309 	if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
310 		usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
311 		usbhid->urbout->dev = hid_to_usb_dev(hid);
312 		memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
313 		kfree(raw_report);
314 
315 		dbg_hid("submitting out urb\n");
316 
317 		if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
318 			err_hid("usb_submit_urb(out) failed");
319 			return -1;
320 		}
321 	} else {
322 		/*
323 		 * queue work to wake up the device.
324 		 * as the work queue is freezeable, this is safe
325 		 * with respect to STD and STR
326 		 */
327 		queue_work(resumption_waker, &usbhid->restart_work);
328 	}
329 
330 	return 0;
331 }
332 
333 static int hid_submit_ctrl(struct hid_device *hid)
334 {
335 	struct hid_report *report;
336 	unsigned char dir;
337 	char *raw_report;
338 	int len;
339 	struct usbhid_device *usbhid = hid->driver_data;
340 
341 	report = usbhid->ctrl[usbhid->ctrltail].report;
342 	raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
343 	dir = usbhid->ctrl[usbhid->ctrltail].dir;
344 
345 	if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
346 		len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
347 		if (dir == USB_DIR_OUT) {
348 			usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
349 			usbhid->urbctrl->transfer_buffer_length = len;
350 			memcpy(usbhid->ctrlbuf, raw_report, len);
351 			kfree(raw_report);
352 		} else {
353 			int maxpacket, padlen;
354 
355 			usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
356 			maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
357 			if (maxpacket > 0) {
358 				padlen = DIV_ROUND_UP(len, maxpacket);
359 				padlen *= maxpacket;
360 				if (padlen > usbhid->bufsize)
361 					padlen = usbhid->bufsize;
362 			} else
363 				padlen = 0;
364 			usbhid->urbctrl->transfer_buffer_length = padlen;
365 		}
366 		usbhid->urbctrl->dev = hid_to_usb_dev(hid);
367 
368 		usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
369 		usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
370 		usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
371 		usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
372 		usbhid->cr->wLength = cpu_to_le16(len);
373 
374 		dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
375 			usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
376 			usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
377 
378 		if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
379 			err_hid("usb_submit_urb(ctrl) failed");
380 			return -1;
381 		}
382 	} else {
383 		/*
384 		 * queue work to wake up the device.
385 		 * as the work queue is freezeable, this is safe
386 		 * with respect to STD and STR
387 		 */
388 		queue_work(resumption_waker, &usbhid->restart_work);
389 	}
390 
391 	return 0;
392 }
393 
394 /*
395  * Output interrupt completion handler.
396  */
397 
398 static void hid_irq_out(struct urb *urb)
399 {
400 	struct hid_device *hid = urb->context;
401 	struct usbhid_device *usbhid = hid->driver_data;
402 	unsigned long flags;
403 	int unplug = 0;
404 
405 	switch (urb->status) {
406 	case 0:			/* success */
407 		break;
408 	case -ESHUTDOWN:	/* unplug */
409 		unplug = 1;
410 	case -EILSEQ:		/* protocol error or unplug */
411 	case -EPROTO:		/* protocol error or unplug */
412 	case -ECONNRESET:	/* unlink */
413 	case -ENOENT:
414 		break;
415 	default:		/* error */
416 		dev_warn(&urb->dev->dev, "output irq status %d "
417 				"received\n", urb->status);
418 	}
419 
420 	spin_lock_irqsave(&usbhid->lock, flags);
421 
422 	if (unplug)
423 		usbhid->outtail = usbhid->outhead;
424 	else
425 		usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
426 
427 	if (usbhid->outhead != usbhid->outtail) {
428 		if (hid_submit_out(hid)) {
429 			clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
430 			wake_up(&usbhid->wait);
431 		}
432 		spin_unlock_irqrestore(&usbhid->lock, flags);
433 		return;
434 	}
435 
436 	clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
437 	spin_unlock_irqrestore(&usbhid->lock, flags);
438 	wake_up(&usbhid->wait);
439 }
440 
441 /*
442  * Control pipe completion handler.
443  */
444 
445 static void hid_ctrl(struct urb *urb)
446 {
447 	struct hid_device *hid = urb->context;
448 	struct usbhid_device *usbhid = hid->driver_data;
449 	int unplug = 0, status = urb->status;
450 
451 	spin_lock(&usbhid->lock);
452 
453 	switch (status) {
454 	case 0:			/* success */
455 		if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
456 			hid_input_report(urb->context,
457 				usbhid->ctrl[usbhid->ctrltail].report->type,
458 				urb->transfer_buffer, urb->actual_length, 0);
459 		break;
460 	case -ESHUTDOWN:	/* unplug */
461 		unplug = 1;
462 	case -EILSEQ:		/* protocol error or unplug */
463 	case -EPROTO:		/* protocol error or unplug */
464 	case -ECONNRESET:	/* unlink */
465 	case -ENOENT:
466 	case -EPIPE:		/* report not available */
467 		break;
468 	default:		/* error */
469 		dev_warn(&urb->dev->dev, "ctrl urb status %d "
470 				"received\n", status);
471 	}
472 
473 	if (unplug)
474 		usbhid->ctrltail = usbhid->ctrlhead;
475 	else
476 		usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
477 
478 	if (usbhid->ctrlhead != usbhid->ctrltail) {
479 		if (hid_submit_ctrl(hid)) {
480 			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
481 			wake_up(&usbhid->wait);
482 		}
483 		spin_unlock(&usbhid->lock);
484 		return;
485 	}
486 
487 	clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
488 	spin_unlock(&usbhid->lock);
489 	wake_up(&usbhid->wait);
490 }
491 
492 static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
493 				   unsigned char dir)
494 {
495 	int head;
496 	struct usbhid_device *usbhid = hid->driver_data;
497 	int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
498 
499 	if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
500 		return;
501 
502 	if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
503 		if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
504 			dev_warn(&hid->dev, "output queue full\n");
505 			return;
506 		}
507 
508 		usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
509 		if (!usbhid->out[usbhid->outhead].raw_report) {
510 			dev_warn(&hid->dev, "output queueing failed\n");
511 			return;
512 		}
513 		hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
514 		usbhid->out[usbhid->outhead].report = report;
515 		usbhid->outhead = head;
516 
517 		if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
518 			if (hid_submit_out(hid))
519 				clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
520 		return;
521 	}
522 
523 	if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
524 		dev_warn(&hid->dev, "control queue full\n");
525 		return;
526 	}
527 
528 	if (dir == USB_DIR_OUT) {
529 		usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
530 		if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
531 			dev_warn(&hid->dev, "control queueing failed\n");
532 			return;
533 		}
534 		hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
535 	}
536 	usbhid->ctrl[usbhid->ctrlhead].report = report;
537 	usbhid->ctrl[usbhid->ctrlhead].dir = dir;
538 	usbhid->ctrlhead = head;
539 
540 	if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
541 		if (hid_submit_ctrl(hid))
542 			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
543 }
544 
545 void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
546 {
547 	struct usbhid_device *usbhid = hid->driver_data;
548 	unsigned long flags;
549 
550 	spin_lock_irqsave(&usbhid->lock, flags);
551 	__usbhid_submit_report(hid, report, dir);
552 	spin_unlock_irqrestore(&usbhid->lock, flags);
553 }
554 EXPORT_SYMBOL_GPL(usbhid_submit_report);
555 
556 static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
557 {
558 	struct hid_device *hid = input_get_drvdata(dev);
559 	struct usbhid_device *usbhid = hid->driver_data;
560 	struct hid_field *field;
561 	unsigned long flags;
562 	int offset;
563 
564 	if (type == EV_FF)
565 		return input_ff_event(dev, type, code, value);
566 
567 	if (type != EV_LED)
568 		return -1;
569 
570 	if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
571 		dev_warn(&dev->dev, "event field not found\n");
572 		return -1;
573 	}
574 
575 	hid_set_field(field, offset, value);
576 	if (value) {
577 		spin_lock_irqsave(&usbhid->lock, flags);
578 		usbhid->ledcount++;
579 		spin_unlock_irqrestore(&usbhid->lock, flags);
580 	} else {
581 		spin_lock_irqsave(&usbhid->lock, flags);
582 		usbhid->ledcount--;
583 		spin_unlock_irqrestore(&usbhid->lock, flags);
584 	}
585 	usbhid_submit_report(hid, field->report, USB_DIR_OUT);
586 
587 	return 0;
588 }
589 
590 int usbhid_wait_io(struct hid_device *hid)
591 {
592 	struct usbhid_device *usbhid = hid->driver_data;
593 
594 	if (!wait_event_timeout(usbhid->wait,
595 				(!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
596 				!test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
597 					10*HZ)) {
598 		dbg_hid("timeout waiting for ctrl or out queue to clear\n");
599 		return -1;
600 	}
601 
602 	return 0;
603 }
604 
605 static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
606 {
607 	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
608 		HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
609 		ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
610 }
611 
612 static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
613 		unsigned char type, void *buf, int size)
614 {
615 	int result, retries = 4;
616 
617 	memset(buf, 0, size);
618 
619 	do {
620 		result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
621 				USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
622 				(type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
623 		retries--;
624 	} while (result < size && retries);
625 	return result;
626 }
627 
628 int usbhid_open(struct hid_device *hid)
629 {
630 	struct usbhid_device *usbhid = hid->driver_data;
631 	int res;
632 
633 	mutex_lock(&hid_open_mut);
634 	if (!hid->open++) {
635 		res = usb_autopm_get_interface(usbhid->intf);
636 		/* the device must be awake to reliable request remote wakeup */
637 		if (res < 0) {
638 			hid->open--;
639 			mutex_unlock(&hid_open_mut);
640 			return -EIO;
641 		}
642 		usbhid->intf->needs_remote_wakeup = 1;
643 		if (hid_start_in(hid))
644 			hid_io_error(hid);
645 
646 		usb_autopm_put_interface(usbhid->intf);
647 	}
648 	mutex_unlock(&hid_open_mut);
649 	return 0;
650 }
651 
652 void usbhid_close(struct hid_device *hid)
653 {
654 	struct usbhid_device *usbhid = hid->driver_data;
655 
656 	mutex_lock(&hid_open_mut);
657 
658 	/* protecting hid->open to make sure we don't restart
659 	 * data acquistion due to a resumption we no longer
660 	 * care about
661 	 */
662 	spin_lock_irq(&usbhid->lock);
663 	if (!--hid->open) {
664 		spin_unlock_irq(&usbhid->lock);
665 		hid_cancel_delayed_stuff(usbhid);
666 		usb_kill_urb(usbhid->urbin);
667 		usbhid->intf->needs_remote_wakeup = 0;
668 	} else {
669 		spin_unlock_irq(&usbhid->lock);
670 	}
671 	mutex_unlock(&hid_open_mut);
672 }
673 
674 /*
675  * Initialize all reports
676  */
677 
678 void usbhid_init_reports(struct hid_device *hid)
679 {
680 	struct hid_report *report;
681 	struct usbhid_device *usbhid = hid->driver_data;
682 	int err, ret;
683 
684 	list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
685 		usbhid_submit_report(hid, report, USB_DIR_IN);
686 
687 	list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
688 		usbhid_submit_report(hid, report, USB_DIR_IN);
689 
690 	err = 0;
691 	ret = usbhid_wait_io(hid);
692 	while (ret) {
693 		err |= ret;
694 		if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
695 			usb_kill_urb(usbhid->urbctrl);
696 		if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
697 			usb_kill_urb(usbhid->urbout);
698 		ret = usbhid_wait_io(hid);
699 	}
700 
701 	if (err)
702 		dev_warn(&hid->dev, "timeout initializing reports\n");
703 }
704 
705 /*
706  * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
707  */
708 static int hid_find_field_early(struct hid_device *hid, unsigned int page,
709     unsigned int hid_code, struct hid_field **pfield)
710 {
711 	struct hid_report *report;
712 	struct hid_field *field;
713 	struct hid_usage *usage;
714 	int i, j;
715 
716 	list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
717 		for (i = 0; i < report->maxfield; i++) {
718 			field = report->field[i];
719 			for (j = 0; j < field->maxusage; j++) {
720 				usage = &field->usage[j];
721 				if ((usage->hid & HID_USAGE_PAGE) == page &&
722 				    (usage->hid & 0xFFFF) == hid_code) {
723 					*pfield = field;
724 					return j;
725 				}
726 			}
727 		}
728 	}
729 	return -1;
730 }
731 
732 void usbhid_set_leds(struct hid_device *hid)
733 {
734 	struct hid_field *field;
735 	int offset;
736 
737 	if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
738 		hid_set_field(field, offset, 0);
739 		usbhid_submit_report(hid, field->report, USB_DIR_OUT);
740 	}
741 }
742 EXPORT_SYMBOL_GPL(usbhid_set_leds);
743 
744 /*
745  * Traverse the supplied list of reports and find the longest
746  */
747 static void hid_find_max_report(struct hid_device *hid, unsigned int type,
748 		unsigned int *max)
749 {
750 	struct hid_report *report;
751 	unsigned int size;
752 
753 	list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
754 		size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
755 		if (*max < size)
756 			*max = size;
757 	}
758 }
759 
760 static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
761 {
762 	struct usbhid_device *usbhid = hid->driver_data;
763 
764 	usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
765 			&usbhid->inbuf_dma);
766 	usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
767 			&usbhid->outbuf_dma);
768 	usbhid->cr = usb_buffer_alloc(dev, sizeof(*usbhid->cr), GFP_KERNEL,
769 			&usbhid->cr_dma);
770 	usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
771 			&usbhid->ctrlbuf_dma);
772 	if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
773 			!usbhid->ctrlbuf)
774 		return -1;
775 
776 	return 0;
777 }
778 
779 static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
780 {
781 	struct usbhid_device *usbhid = hid->driver_data;
782 	struct usb_device *dev = hid_to_usb_dev(hid);
783 	struct usb_interface *intf = usbhid->intf;
784 	struct usb_host_interface *interface = intf->cur_altsetting;
785 	int ret;
786 
787 	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
788 		HID_REQ_SET_REPORT,
789 		USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
790 		((HID_OUTPUT_REPORT + 1) << 8) | *buf,
791 		interface->desc.bInterfaceNumber, buf + 1, count - 1,
792 		USB_CTRL_SET_TIMEOUT);
793 
794 	/* count also the report id */
795 	if (ret > 0)
796 		ret++;
797 
798 	return ret;
799 }
800 
801 static void usbhid_restart_queues(struct usbhid_device *usbhid)
802 {
803 	if (usbhid->urbout)
804 		usbhid_restart_out_queue(usbhid);
805 	usbhid_restart_ctrl_queue(usbhid);
806 }
807 
808 static void __usbhid_restart_queues(struct work_struct *work)
809 {
810 	struct usbhid_device *usbhid =
811 		container_of(work, struct usbhid_device, restart_work);
812 	int r;
813 
814 	r = usb_autopm_get_interface(usbhid->intf);
815 	if (r < 0)
816 		return;
817 	usb_autopm_put_interface(usbhid->intf);
818 }
819 
820 static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
821 {
822 	struct usbhid_device *usbhid = hid->driver_data;
823 
824 	usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
825 	usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
826 	usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
827 	usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
828 }
829 
830 static int usbhid_parse(struct hid_device *hid)
831 {
832 	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
833 	struct usb_host_interface *interface = intf->cur_altsetting;
834 	struct usb_device *dev = interface_to_usbdev (intf);
835 	struct hid_descriptor *hdesc;
836 	u32 quirks = 0;
837 	unsigned int rsize = 0;
838 	char *rdesc;
839 	int ret, n;
840 
841 	quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
842 			le16_to_cpu(dev->descriptor.idProduct));
843 
844 	if (quirks & HID_QUIRK_IGNORE)
845 		return -ENODEV;
846 
847 	/* Many keyboards and mice don't like to be polled for reports,
848 	 * so we will always set the HID_QUIRK_NOGET flag for them. */
849 	if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
850 		if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
851 			interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
852 				quirks |= HID_QUIRK_NOGET;
853 	}
854 
855 	if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
856 	    (!interface->desc.bNumEndpoints ||
857 	     usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
858 		dbg_hid("class descriptor not present\n");
859 		return -ENODEV;
860 	}
861 
862 	hid->version = le16_to_cpu(hdesc->bcdHID);
863 	hid->country = hdesc->bCountryCode;
864 
865 	for (n = 0; n < hdesc->bNumDescriptors; n++)
866 		if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
867 			rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
868 
869 	if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
870 		dbg_hid("weird size of report descriptor (%u)\n", rsize);
871 		return -EINVAL;
872 	}
873 
874 	if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
875 		dbg_hid("couldn't allocate rdesc memory\n");
876 		return -ENOMEM;
877 	}
878 
879 	hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
880 
881 	ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
882 			HID_DT_REPORT, rdesc, rsize);
883 	if (ret < 0) {
884 		dbg_hid("reading report descriptor failed\n");
885 		kfree(rdesc);
886 		goto err;
887 	}
888 
889 	ret = hid_parse_report(hid, rdesc, rsize);
890 	kfree(rdesc);
891 	if (ret) {
892 		dbg_hid("parsing report descriptor failed\n");
893 		goto err;
894 	}
895 
896 	hid->quirks |= quirks;
897 
898 	return 0;
899 err:
900 	return ret;
901 }
902 
903 static int usbhid_start(struct hid_device *hid)
904 {
905 	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
906 	struct usb_host_interface *interface = intf->cur_altsetting;
907 	struct usb_device *dev = interface_to_usbdev(intf);
908 	struct usbhid_device *usbhid = hid->driver_data;
909 	unsigned int n, insize = 0;
910 	int ret;
911 
912 	clear_bit(HID_DISCONNECTED, &usbhid->iofl);
913 
914 	usbhid->bufsize = HID_MIN_BUFFER_SIZE;
915 	hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
916 	hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
917 	hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
918 
919 	if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
920 		usbhid->bufsize = HID_MAX_BUFFER_SIZE;
921 
922 	hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
923 
924 	if (insize > HID_MAX_BUFFER_SIZE)
925 		insize = HID_MAX_BUFFER_SIZE;
926 
927 	if (hid_alloc_buffers(dev, hid)) {
928 		ret = -ENOMEM;
929 		goto fail;
930 	}
931 
932 	for (n = 0; n < interface->desc.bNumEndpoints; n++) {
933 		struct usb_endpoint_descriptor *endpoint;
934 		int pipe;
935 		int interval;
936 
937 		endpoint = &interface->endpoint[n].desc;
938 		if (!usb_endpoint_xfer_int(endpoint))
939 			continue;
940 
941 		interval = endpoint->bInterval;
942 
943 		/* Some vendors give fullspeed interval on highspeed devides */
944 		if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
945 		    dev->speed == USB_SPEED_HIGH) {
946 			interval = fls(endpoint->bInterval*8);
947 			printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
948 			       hid->name, endpoint->bInterval, interval);
949 		}
950 
951 		/* Change the polling interval of mice. */
952 		if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
953 			interval = hid_mousepoll_interval;
954 
955 		ret = -ENOMEM;
956 		if (usb_endpoint_dir_in(endpoint)) {
957 			if (usbhid->urbin)
958 				continue;
959 			if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
960 				goto fail;
961 			pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
962 			usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
963 					 hid_irq_in, hid, interval);
964 			usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
965 			usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
966 		} else {
967 			if (usbhid->urbout)
968 				continue;
969 			if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
970 				goto fail;
971 			pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
972 			usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
973 					 hid_irq_out, hid, interval);
974 			usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
975 			usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
976 		}
977 	}
978 
979 	init_waitqueue_head(&usbhid->wait);
980 	INIT_WORK(&usbhid->reset_work, hid_reset);
981 	INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
982 	setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
983 
984 	spin_lock_init(&usbhid->lock);
985 
986 	usbhid->intf = intf;
987 	usbhid->ifnum = interface->desc.bInterfaceNumber;
988 
989 	usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
990 	if (!usbhid->urbctrl) {
991 		ret = -ENOMEM;
992 		goto fail;
993 	}
994 
995 	usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
996 			     usbhid->ctrlbuf, 1, hid_ctrl, hid);
997 	usbhid->urbctrl->setup_dma = usbhid->cr_dma;
998 	usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
999 	usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
1000 
1001 	usbhid_init_reports(hid);
1002 
1003 	set_bit(HID_STARTED, &usbhid->iofl);
1004 
1005 	/* Some keyboards don't work until their LEDs have been set.
1006 	 * Since BIOSes do set the LEDs, it must be safe for any device
1007 	 * that supports the keyboard boot protocol.
1008 	 */
1009 	if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1010 			interface->desc.bInterfaceProtocol ==
1011 				USB_INTERFACE_PROTOCOL_KEYBOARD)
1012 		usbhid_set_leds(hid);
1013 
1014 	return 0;
1015 
1016 fail:
1017 	usb_free_urb(usbhid->urbin);
1018 	usb_free_urb(usbhid->urbout);
1019 	usb_free_urb(usbhid->urbctrl);
1020 	usbhid->urbin = NULL;
1021 	usbhid->urbout = NULL;
1022 	usbhid->urbctrl = NULL;
1023 	hid_free_buffers(dev, hid);
1024 	return ret;
1025 }
1026 
1027 static void usbhid_stop(struct hid_device *hid)
1028 {
1029 	struct usbhid_device *usbhid = hid->driver_data;
1030 
1031 	if (WARN_ON(!usbhid))
1032 		return;
1033 
1034 	clear_bit(HID_STARTED, &usbhid->iofl);
1035 	spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
1036 	set_bit(HID_DISCONNECTED, &usbhid->iofl);
1037 	spin_unlock_irq(&usbhid->lock);
1038 	usb_kill_urb(usbhid->urbin);
1039 	usb_kill_urb(usbhid->urbout);
1040 	usb_kill_urb(usbhid->urbctrl);
1041 
1042 	hid_cancel_delayed_stuff(usbhid);
1043 
1044 	if (hid->claimed & HID_CLAIMED_INPUT)
1045 		hidinput_disconnect(hid);
1046 	if (hid->claimed & HID_CLAIMED_HIDDEV)
1047 		hiddev_disconnect(hid);
1048 	if (hid->claimed & HID_CLAIMED_HIDRAW)
1049 		hidraw_disconnect(hid);
1050 
1051 	hid->claimed = 0;
1052 
1053 	usb_free_urb(usbhid->urbin);
1054 	usb_free_urb(usbhid->urbctrl);
1055 	usb_free_urb(usbhid->urbout);
1056 	usbhid->urbin = NULL; /* don't mess up next start */
1057 	usbhid->urbctrl = NULL;
1058 	usbhid->urbout = NULL;
1059 
1060 	hid_free_buffers(hid_to_usb_dev(hid), hid);
1061 }
1062 
1063 static int usbhid_power(struct hid_device *hid, int lvl)
1064 {
1065 	int r = 0;
1066 
1067 	switch (lvl) {
1068 	case PM_HINT_FULLON:
1069 		r = usbhid_get_power(hid);
1070 		break;
1071 	case PM_HINT_NORMAL:
1072 		usbhid_put_power(hid);
1073 		break;
1074 	}
1075 	return r;
1076 }
1077 
1078 static struct hid_ll_driver usb_hid_driver = {
1079 	.parse = usbhid_parse,
1080 	.start = usbhid_start,
1081 	.stop = usbhid_stop,
1082 	.open = usbhid_open,
1083 	.close = usbhid_close,
1084 	.power = usbhid_power,
1085 	.hidinput_input_event = usb_hidinput_input_event,
1086 };
1087 
1088 static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
1089 {
1090 	struct usb_host_interface *interface = intf->cur_altsetting;
1091 	struct usb_device *dev = interface_to_usbdev(intf);
1092 	struct usbhid_device *usbhid;
1093 	struct hid_device *hid;
1094 	unsigned int n, has_in = 0;
1095 	size_t len;
1096 	int ret;
1097 
1098 	dbg_hid("HID probe called for ifnum %d\n",
1099 			intf->altsetting->desc.bInterfaceNumber);
1100 
1101 	for (n = 0; n < interface->desc.bNumEndpoints; n++)
1102 		if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1103 			has_in++;
1104 	if (!has_in) {
1105 		dev_err(&intf->dev, "couldn't find an input interrupt "
1106 				"endpoint\n");
1107 		return -ENODEV;
1108 	}
1109 
1110 	hid = hid_allocate_device();
1111 	if (IS_ERR(hid))
1112 		return PTR_ERR(hid);
1113 
1114 	usb_set_intfdata(intf, hid);
1115 	hid->ll_driver = &usb_hid_driver;
1116 	hid->hid_output_raw_report = usbhid_output_raw_report;
1117 	hid->ff_init = hid_pidff_init;
1118 #ifdef CONFIG_USB_HIDDEV
1119 	hid->hiddev_connect = hiddev_connect;
1120 	hid->hiddev_hid_event = hiddev_hid_event;
1121 	hid->hiddev_report_event = hiddev_report_event;
1122 #endif
1123 	hid->dev.parent = &intf->dev;
1124 	hid->bus = BUS_USB;
1125 	hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1126 	hid->product = le16_to_cpu(dev->descriptor.idProduct);
1127 	hid->name[0] = 0;
1128 	if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1129 			USB_INTERFACE_PROTOCOL_MOUSE)
1130 		hid->type = HID_TYPE_USBMOUSE;
1131 
1132 	if (dev->manufacturer)
1133 		strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1134 
1135 	if (dev->product) {
1136 		if (dev->manufacturer)
1137 			strlcat(hid->name, " ", sizeof(hid->name));
1138 		strlcat(hid->name, dev->product, sizeof(hid->name));
1139 	}
1140 
1141 	if (!strlen(hid->name))
1142 		snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1143 			 le16_to_cpu(dev->descriptor.idVendor),
1144 			 le16_to_cpu(dev->descriptor.idProduct));
1145 
1146 	usb_make_path(dev, hid->phys, sizeof(hid->phys));
1147 	strlcat(hid->phys, "/input", sizeof(hid->phys));
1148 	len = strlen(hid->phys);
1149 	if (len < sizeof(hid->phys) - 1)
1150 		snprintf(hid->phys + len, sizeof(hid->phys) - len,
1151 			 "%d", intf->altsetting[0].desc.bInterfaceNumber);
1152 
1153 	if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1154 		hid->uniq[0] = 0;
1155 
1156 	usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1157 	if (usbhid == NULL) {
1158 		ret = -ENOMEM;
1159 		goto err;
1160 	}
1161 
1162 	hid->driver_data = usbhid;
1163 	usbhid->hid = hid;
1164 
1165 	ret = hid_add_device(hid);
1166 	if (ret) {
1167 		if (ret != -ENODEV)
1168 			dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1169 		goto err_free;
1170 	}
1171 
1172 	return 0;
1173 err_free:
1174 	kfree(usbhid);
1175 err:
1176 	hid_destroy_device(hid);
1177 	return ret;
1178 }
1179 
1180 static void hid_disconnect(struct usb_interface *intf)
1181 {
1182 	struct hid_device *hid = usb_get_intfdata(intf);
1183 	struct usbhid_device *usbhid;
1184 
1185 	if (WARN_ON(!hid))
1186 		return;
1187 
1188 	usbhid = hid->driver_data;
1189 	hid_destroy_device(hid);
1190 	kfree(usbhid);
1191 }
1192 
1193 static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
1194 {
1195 	del_timer_sync(&usbhid->io_retry);
1196 	cancel_work_sync(&usbhid->restart_work);
1197 	cancel_work_sync(&usbhid->reset_work);
1198 }
1199 
1200 static void hid_cease_io(struct usbhid_device *usbhid)
1201 {
1202 	del_timer(&usbhid->io_retry);
1203 	usb_kill_urb(usbhid->urbin);
1204 	usb_kill_urb(usbhid->urbctrl);
1205 	usb_kill_urb(usbhid->urbout);
1206 }
1207 
1208 /* Treat USB reset pretty much the same as suspend/resume */
1209 static int hid_pre_reset(struct usb_interface *intf)
1210 {
1211 	struct hid_device *hid = usb_get_intfdata(intf);
1212 	struct usbhid_device *usbhid = hid->driver_data;
1213 
1214 	spin_lock_irq(&usbhid->lock);
1215 	set_bit(HID_RESET_PENDING, &usbhid->iofl);
1216 	spin_unlock_irq(&usbhid->lock);
1217 	cancel_work_sync(&usbhid->restart_work);
1218 	hid_cease_io(usbhid);
1219 
1220 	return 0;
1221 }
1222 
1223 /* Same routine used for post_reset and reset_resume */
1224 static int hid_post_reset(struct usb_interface *intf)
1225 {
1226 	struct usb_device *dev = interface_to_usbdev (intf);
1227 	struct hid_device *hid = usb_get_intfdata(intf);
1228 	struct usbhid_device *usbhid = hid->driver_data;
1229 	int status;
1230 
1231 	spin_lock_irq(&usbhid->lock);
1232 	clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1233 	spin_unlock_irq(&usbhid->lock);
1234 	hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
1235 	status = hid_start_in(hid);
1236 	if (status < 0)
1237 		hid_io_error(hid);
1238 	usbhid_restart_queues(usbhid);
1239 
1240 	return 0;
1241 }
1242 
1243 int usbhid_get_power(struct hid_device *hid)
1244 {
1245 	struct usbhid_device *usbhid = hid->driver_data;
1246 
1247 	return usb_autopm_get_interface(usbhid->intf);
1248 }
1249 
1250 void usbhid_put_power(struct hid_device *hid)
1251 {
1252 	struct usbhid_device *usbhid = hid->driver_data;
1253 
1254 	usb_autopm_put_interface(usbhid->intf);
1255 }
1256 
1257 
1258 #ifdef CONFIG_PM
1259 static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1260 {
1261 	struct hid_device *hid = usb_get_intfdata(intf);
1262 	struct usbhid_device *usbhid = hid->driver_data;
1263 	struct usb_device *udev = interface_to_usbdev(intf);
1264 	int status;
1265 
1266 	if (udev->auto_pm) {
1267 		spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
1268 		if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1269 		    && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1270 		    && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1271 		    && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1272 		    && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1273 		    && (!usbhid->ledcount || ignoreled))
1274 		{
1275 			set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1276 			spin_unlock_irq(&usbhid->lock);
1277 		} else {
1278 			usbhid_mark_busy(usbhid);
1279 			spin_unlock_irq(&usbhid->lock);
1280 			return -EBUSY;
1281 		}
1282 
1283 	} else {
1284 		spin_lock_irq(&usbhid->lock);
1285 		set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1286 		spin_unlock_irq(&usbhid->lock);
1287 		if (usbhid_wait_io(hid) < 0)
1288 			return -EIO;
1289 	}
1290 
1291 	if (!ignoreled && udev->auto_pm) {
1292 		spin_lock_irq(&usbhid->lock);
1293 		if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1294 			spin_unlock_irq(&usbhid->lock);
1295 			usbhid_mark_busy(usbhid);
1296 			return -EBUSY;
1297 		}
1298 		spin_unlock_irq(&usbhid->lock);
1299 	}
1300 
1301 	hid_cancel_delayed_stuff(usbhid);
1302 	hid_cease_io(usbhid);
1303 
1304 	if (udev->auto_pm && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1305 		/* lost race against keypresses */
1306 		status = hid_start_in(hid);
1307 		if (status < 0)
1308 			hid_io_error(hid);
1309 		usbhid_mark_busy(usbhid);
1310 		return -EBUSY;
1311 	}
1312 	dev_dbg(&intf->dev, "suspend\n");
1313 	return 0;
1314 }
1315 
1316 static int hid_resume(struct usb_interface *intf)
1317 {
1318 	struct hid_device *hid = usb_get_intfdata (intf);
1319 	struct usbhid_device *usbhid = hid->driver_data;
1320 	int status;
1321 
1322 	if (!test_bit(HID_STARTED, &usbhid->iofl))
1323 		return 0;
1324 
1325 	clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1326 	usbhid_mark_busy(usbhid);
1327 
1328 	if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1329 	    test_bit(HID_RESET_PENDING, &usbhid->iofl))
1330 		schedule_work(&usbhid->reset_work);
1331 	usbhid->retry_delay = 0;
1332 	status = hid_start_in(hid);
1333 	if (status < 0)
1334 		hid_io_error(hid);
1335 	usbhid_restart_queues(usbhid);
1336 
1337 	dev_dbg(&intf->dev, "resume status %d\n", status);
1338 	return 0;
1339 }
1340 
1341 static int hid_reset_resume(struct usb_interface *intf)
1342 {
1343 	struct hid_device *hid = usb_get_intfdata(intf);
1344 	struct usbhid_device *usbhid = hid->driver_data;
1345 
1346 	clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1347 	return hid_post_reset(intf);
1348 }
1349 
1350 #endif /* CONFIG_PM */
1351 
1352 static struct usb_device_id hid_usb_ids [] = {
1353 	{ .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1354 		.bInterfaceClass = USB_INTERFACE_CLASS_HID },
1355 	{ }						/* Terminating entry */
1356 };
1357 
1358 MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1359 
1360 static struct usb_driver hid_driver = {
1361 	.name =		"usbhid",
1362 	.probe =	hid_probe,
1363 	.disconnect =	hid_disconnect,
1364 #ifdef CONFIG_PM
1365 	.suspend =	hid_suspend,
1366 	.resume =	hid_resume,
1367 	.reset_resume =	hid_reset_resume,
1368 #endif
1369 	.pre_reset =	hid_pre_reset,
1370 	.post_reset =	hid_post_reset,
1371 	.id_table =	hid_usb_ids,
1372 	.supports_autosuspend = 1,
1373 };
1374 
1375 static const struct hid_device_id hid_usb_table[] = {
1376 	{ HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1377 	{ }
1378 };
1379 
1380 static struct hid_driver hid_usb_driver = {
1381 	.name = "generic-usb",
1382 	.id_table = hid_usb_table,
1383 };
1384 
1385 static int __init hid_init(void)
1386 {
1387 	int retval = -ENOMEM;
1388 
1389 	resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1390 	if (!resumption_waker)
1391 		goto no_queue;
1392 	retval = hid_register_driver(&hid_usb_driver);
1393 	if (retval)
1394 		goto hid_register_fail;
1395 	retval = usbhid_quirks_init(quirks_param);
1396 	if (retval)
1397 		goto usbhid_quirks_init_fail;
1398 	retval = hiddev_init();
1399 	if (retval)
1400 		goto hiddev_init_fail;
1401 	retval = usb_register(&hid_driver);
1402 	if (retval)
1403 		goto usb_register_fail;
1404 	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1405 			DRIVER_DESC "\n");
1406 
1407 	return 0;
1408 usb_register_fail:
1409 	hiddev_exit();
1410 hiddev_init_fail:
1411 	usbhid_quirks_exit();
1412 usbhid_quirks_init_fail:
1413 	hid_unregister_driver(&hid_usb_driver);
1414 hid_register_fail:
1415 	destroy_workqueue(resumption_waker);
1416 no_queue:
1417 	return retval;
1418 }
1419 
1420 static void __exit hid_exit(void)
1421 {
1422 	usb_deregister(&hid_driver);
1423 	hiddev_exit();
1424 	usbhid_quirks_exit();
1425 	hid_unregister_driver(&hid_usb_driver);
1426 	destroy_workqueue(resumption_waker);
1427 }
1428 
1429 module_init(hid_init);
1430 module_exit(hid_exit);
1431 
1432 MODULE_AUTHOR(DRIVER_AUTHOR);
1433 MODULE_DESCRIPTION(DRIVER_DESC);
1434 MODULE_LICENSE(DRIVER_LICENSE);
1435