blob: 599041a7f670a9f105e00da3272d79642aefb78c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB HID support for Linux
3 *
4 * Copyright (c) 1999 Andreas Gal
Michael Haboustakbf0964d2005-09-05 00:12:01 -05005 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
Oliver Neukum0361a282008-12-17 15:38:03 +01007 * Copyright (c) 2007-2008 Oliver Neukum
Jiri Kosina7d39e842010-02-02 20:46:34 +01008 * Copyright (c) 2006-2010 Jiri Kosina
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/list.h>
23#include <linux/mm.h>
Jiri Slaby3d5afd32008-10-27 12:16:15 +010024#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/spinlock.h>
26#include <asm/unaligned.h>
27#include <asm/byteorder.h>
28#include <linux/input.h>
29#include <linux/wait.h>
Oliver Neukum0361a282008-12-17 15:38:03 +010030#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/usb.h>
33
Jiri Kosinadde58452006-12-08 18:40:44 +010034#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/hiddev.h>
Jiri Kosinac080d892007-01-25 11:43:31 +010036#include <linux/hid-debug.h>
Jiri Kosina86166b72007-05-14 09:57:40 +020037#include <linux/hidraw.h>
Jiri Kosina4916b3a2006-12-08 18:41:03 +010038#include "usbhid.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/*
41 * Version Information
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define DRIVER_DESC "USB HID core driver"
45#define DRIVER_LICENSE "GPL"
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
48 * Module parameters.
49 */
50
51static unsigned int hid_mousepoll_interval;
52module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
53MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
54
Oliver Neukum0361a282008-12-17 15:38:03 +010055static unsigned int ignoreled;
56module_param_named(ignoreled, ignoreled, uint, 0644);
57MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
58
Paul Walmsley876b9272007-04-19 14:56:12 +020059/* Quirks specified at module load time */
60static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
61module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
62MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
63 " quirks=vendorID:productID:quirks"
64 " where vendorID, productID, and quirks are all in"
65 " 0x-prefixed hex");
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/*
Alan Sternaef4e262006-01-31 12:58:38 -050067 * Input submission and I/O error handler.
68 */
Oliver Neukum0361a282008-12-17 15:38:03 +010069static DEFINE_MUTEX(hid_open_mut);
70static struct workqueue_struct *resumption_waker;
Alan Sternaef4e262006-01-31 12:58:38 -050071
72static void hid_io_error(struct hid_device *hid);
Oliver Neukum0361a282008-12-17 15:38:03 +010073static int hid_submit_out(struct hid_device *hid);
74static int hid_submit_ctrl(struct hid_device *hid);
75static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -050076
77/* Start up the input URB */
78static int hid_start_in(struct hid_device *hid)
79{
80 unsigned long flags;
81 int rc = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +010082 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -050083
Oliver Neukum0361a282008-12-17 15:38:03 +010084 spin_lock_irqsave(&usbhid->lock, flags);
85 if (hid->open > 0 &&
Oliver Neukum69626f22008-03-31 16:27:30 +020086 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
Oliver Neukum0361a282008-12-17 15:38:03 +010087 !test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
Jiri Kosina4916b3a2006-12-08 18:41:03 +010088 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
89 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -050090 if (rc != 0)
Jiri Kosina4916b3a2006-12-08 18:41:03 +010091 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -050092 }
Oliver Neukum0361a282008-12-17 15:38:03 +010093 spin_unlock_irqrestore(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -050094 return rc;
95}
96
97/* I/O retry timer routine */
98static void hid_retry_timeout(unsigned long _hid)
99{
100 struct hid_device *hid = (struct hid_device *) _hid;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100101 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500102
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100103 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
Alan Sternaef4e262006-01-31 12:58:38 -0500104 if (hid_start_in(hid))
105 hid_io_error(hid);
106}
107
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400108/* Workqueue routine to reset the device or clear a halt */
David Howellsc4028952006-11-22 14:57:56 +0000109static void hid_reset(struct work_struct *work)
Alan Sternaef4e262006-01-31 12:58:38 -0500110{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100111 struct usbhid_device *usbhid =
112 container_of(work, struct usbhid_device, reset_work);
113 struct hid_device *hid = usbhid->hid;
Alan Stern011b15d2008-11-04 11:29:27 -0500114 int rc = 0;
Alan Sternaef4e262006-01-31 12:58:38 -0500115
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100116 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
117 dev_dbg(&usbhid->intf->dev, "clear halt\n");
Anssi Hannulabe820972007-01-19 19:28:17 +0200118 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100119 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400120 hid_start_in(hid);
Alan Sternaef4e262006-01-31 12:58:38 -0500121 }
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400122
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100123 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
124 dev_dbg(&usbhid->intf->dev, "resetting device\n");
Alan Stern011b15d2008-11-04 11:29:27 -0500125 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
126 if (rc == 0) {
Ming Lei742120c2008-06-18 22:00:29 +0800127 rc = usb_reset_device(hid_to_usb_dev(hid));
Alan Stern011b15d2008-11-04 11:29:27 -0500128 usb_unlock_device(hid_to_usb_dev(hid));
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400129 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100130 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400131 }
Alan Sternaef4e262006-01-31 12:58:38 -0500132
Alan Sterndf9a1f42006-06-01 13:55:28 -0400133 switch (rc) {
134 case 0:
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100135 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500136 hid_io_error(hid);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400137 break;
138 default:
Jiri Kosina58037eb2007-05-30 15:07:13 +0200139 err_hid("can't reset device, %s-%s/input%d, status %d",
Anssi Hannulabe820972007-01-19 19:28:17 +0200140 hid_to_usb_dev(hid)->bus->bus_name,
141 hid_to_usb_dev(hid)->devpath,
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100142 usbhid->ifnum, rc);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400143 /* FALLTHROUGH */
144 case -EHOSTUNREACH:
145 case -ENODEV:
146 case -EINTR:
147 break;
148 }
Alan Sternaef4e262006-01-31 12:58:38 -0500149}
150
151/* Main I/O error handler */
152static void hid_io_error(struct hid_device *hid)
153{
154 unsigned long flags;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100155 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500156
Oliver Neukum0361a282008-12-17 15:38:03 +0100157 spin_lock_irqsave(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -0500158
159 /* Stop when disconnected */
Oliver Neukum69626f22008-03-31 16:27:30 +0200160 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500161 goto done;
162
Alan Stern5e2a55f2007-03-20 19:03:31 +0100163 /* If it has been a while since the last error, we'll assume
164 * this a brand new error and reset the retry timeout. */
165 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
166 usbhid->retry_delay = 0;
167
Alan Sternaef4e262006-01-31 12:58:38 -0500168 /* When an error occurs, retry at increasing intervals */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100169 if (usbhid->retry_delay == 0) {
170 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
171 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
172 } else if (usbhid->retry_delay < 100)
173 usbhid->retry_delay *= 2;
Alan Sternaef4e262006-01-31 12:58:38 -0500174
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100175 if (time_after(jiffies, usbhid->stop_retry)) {
Alan Sternaef4e262006-01-31 12:58:38 -0500176
177 /* Retries failed, so do a port reset */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100178 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
179 schedule_work(&usbhid->reset_work);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400180 goto done;
Alan Sternaef4e262006-01-31 12:58:38 -0500181 }
182 }
183
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100184 mod_timer(&usbhid->io_retry,
185 jiffies + msecs_to_jiffies(usbhid->retry_delay));
Alan Sternaef4e262006-01-31 12:58:38 -0500186done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100187 spin_unlock_irqrestore(&usbhid->lock, flags);
188}
189
190static void usbhid_mark_busy(struct usbhid_device *usbhid)
191{
192 struct usb_interface *intf = usbhid->intf;
193
194 usb_mark_last_busy(interface_to_usbdev(intf));
195}
196
197static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
198{
199 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
200 int kicked;
201
202 if (!hid)
203 return 0;
204
205 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
206 dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
207 if (hid_submit_out(hid)) {
208 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
209 wake_up(&usbhid->wait);
210 }
211 }
212 return kicked;
213}
214
215static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
216{
217 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
218 int kicked;
219
220 WARN_ON(hid == NULL);
221 if (!hid)
222 return 0;
223
224 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
225 dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
226 if (hid_submit_ctrl(hid)) {
227 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
228 wake_up(&usbhid->wait);
229 }
230 }
231 return kicked;
Alan Sternaef4e262006-01-31 12:58:38 -0500232}
233
234/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 * Input interrupt completion handler.
236 */
237
David Howells7d12e782006-10-05 14:55:46 +0100238static void hid_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
240 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100241 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 int status;
243
244 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200245 case 0: /* success */
Oliver Neukum0361a282008-12-17 15:38:03 +0100246 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200247 usbhid->retry_delay = 0;
248 hid_input_report(urb->context, HID_INPUT_REPORT,
249 urb->transfer_buffer,
250 urb->actual_length, 1);
Oliver Neukum0361a282008-12-17 15:38:03 +0100251 /*
252 * autosuspend refused while keys are pressed
253 * because most keyboards don't wake up when
254 * a key is released
255 */
256 if (hid_check_keys_pressed(hid))
257 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
258 else
259 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200260 break;
261 case -EPIPE: /* stall */
Oliver Neukum0361a282008-12-17 15:38:03 +0100262 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200263 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
264 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
265 schedule_work(&usbhid->reset_work);
266 return;
267 case -ECONNRESET: /* unlink */
268 case -ENOENT:
269 case -ESHUTDOWN: /* unplug */
270 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
271 return;
272 case -EILSEQ: /* protocol error or unplug */
273 case -EPROTO: /* protocol error or unplug */
274 case -ETIME: /* protocol error or unplug */
275 case -ETIMEDOUT: /* Should never happen, but... */
Oliver Neukum0361a282008-12-17 15:38:03 +0100276 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200277 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
278 hid_io_error(hid);
279 return;
280 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200281 dev_warn(&urb->dev->dev, "input irq status %d "
282 "received\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 }
284
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800285 status = usb_submit_urb(urb, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -0500286 if (status) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100287 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -0500288 if (status != -EPERM) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200289 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
Anssi Hannulabe820972007-01-19 19:28:17 +0200290 hid_to_usb_dev(hid)->bus->bus_name,
291 hid_to_usb_dev(hid)->devpath,
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100292 usbhid->ifnum, status);
Alan Sternaef4e262006-01-31 12:58:38 -0500293 hid_io_error(hid);
294 }
295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298static int hid_submit_out(struct hid_device *hid)
299{
300 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200301 char *raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100302 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200304 report = usbhid->out[usbhid->outtail].report;
305 raw_report = usbhid->out[usbhid->outtail].raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Oliver Neukum0361a282008-12-17 15:38:03 +0100307 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
308 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
309 usbhid->urbout->dev = hid_to_usb_dev(hid);
310 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
311 kfree(raw_report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Oliver Neukum0361a282008-12-17 15:38:03 +0100313 dbg_hid("submitting out urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Oliver Neukum0361a282008-12-17 15:38:03 +0100315 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
316 err_hid("usb_submit_urb(out) failed");
317 return -1;
318 }
Oliver Neukum858155f2010-02-12 13:02:28 +0100319 usbhid->last_out = jiffies;
Oliver Neukum0361a282008-12-17 15:38:03 +0100320 } else {
321 /*
322 * queue work to wake up the device.
323 * as the work queue is freezeable, this is safe
324 * with respect to STD and STR
325 */
326 queue_work(resumption_waker, &usbhid->restart_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 }
328
329 return 0;
330}
331
332static int hid_submit_ctrl(struct hid_device *hid)
333{
334 struct hid_report *report;
335 unsigned char dir;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200336 char *raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 int len;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100338 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100340 report = usbhid->ctrl[usbhid->ctrltail].report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200341 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100342 dir = usbhid->ctrl[usbhid->ctrltail].dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Oliver Neukum0361a282008-12-17 15:38:03 +0100344 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
345 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
346 if (dir == USB_DIR_OUT) {
347 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
348 usbhid->urbctrl->transfer_buffer_length = len;
349 memcpy(usbhid->ctrlbuf, raw_report, len);
350 kfree(raw_report);
351 } else {
352 int maxpacket, padlen;
353
354 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
355 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
356 if (maxpacket > 0) {
357 padlen = DIV_ROUND_UP(len, maxpacket);
358 padlen *= maxpacket;
359 if (padlen > usbhid->bufsize)
360 padlen = usbhid->bufsize;
361 } else
362 padlen = 0;
363 usbhid->urbctrl->transfer_buffer_length = padlen;
364 }
365 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
366
367 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
368 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
369 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
370 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
371 usbhid->cr->wLength = cpu_to_le16(len);
372
373 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
374 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
375 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
376
377 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
378 err_hid("usb_submit_urb(ctrl) failed");
379 return -1;
380 }
Oliver Neukum858155f2010-02-12 13:02:28 +0100381 usbhid->last_ctrl = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 } else {
Oliver Neukum0361a282008-12-17 15:38:03 +0100383 /*
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 }
390
391 return 0;
392}
393
394/*
395 * Output interrupt completion handler.
396 */
397
David Howells7d12e782006-10-05 14:55:46 +0100398static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
400 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100401 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 unsigned long flags;
403 int unplug = 0;
404
405 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200406 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 */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200416 dev_warn(&urb->dev->dev, "output irq status %d "
417 "received\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 }
419
Oliver Neukum0361a282008-12-17 15:38:03 +0100420 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100423 usbhid->outtail = usbhid->outhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100425 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100427 if (usbhid->outhead != usbhid->outtail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 if (hid_submit_out(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100429 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100430 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100432 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return;
434 }
435
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100436 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100437 spin_unlock_irqrestore(&usbhid->lock, flags);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100438 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439}
440
441/*
442 * Control pipe completion handler.
443 */
444
David Howells7d12e782006-10-05 14:55:46 +0100445static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
447 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100448 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100449 int unplug = 0, status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Oliver Neukum0361a282008-12-17 15:38:03 +0100451 spin_lock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Oliver Neukum0361a282008-12-17 15:38:03 +0100453 switch (status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200454 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 */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200469 dev_warn(&urb->dev->dev, "ctrl urb status %d "
Oliver Neukum0361a282008-12-17 15:38:03 +0100470 "received\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 }
472
473 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100474 usbhid->ctrltail = usbhid->ctrlhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100476 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100478 if (usbhid->ctrlhead != usbhid->ctrltail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 if (hid_submit_ctrl(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100480 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100481 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100483 spin_unlock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 return;
485 }
486
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100487 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100488 spin_unlock(&usbhid->lock);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100489 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
H Hartley Sweeten52cfc61b2009-08-17 15:37:18 -0700492static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
493 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
495 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100496 struct usbhid_device *usbhid = hid->driver_data;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200497 int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
500 return;
501
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100502 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100503 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200504 dev_warn(&hid->dev, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 return;
506 }
507
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200508 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
509 if (!usbhid->out[usbhid->outhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700510 dev_warn(&hid->dev, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200511 return;
512 }
513 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
514 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100515 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Oliver Neukum858155f2010-02-12 13:02:28 +0100517 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 if (hid_submit_out(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100519 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum858155f2010-02-12 13:02:28 +0100520 } else {
521 /*
522 * the queue is known to run
523 * but an earlier request may be stuck
524 * we may need to time out
525 * no race because this is called under
526 * spinlock
527 */
528 if (time_after(jiffies, usbhid->last_out + HZ * 5))
529 usb_unlink_urb(usbhid->urbout);
530 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 return;
532 }
533
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100534 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200535 dev_warn(&hid->dev, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return;
537 }
538
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200539 if (dir == USB_DIR_OUT) {
540 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
541 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700542 dev_warn(&hid->dev, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200543 return;
544 }
545 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
546 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100547 usbhid->ctrl[usbhid->ctrlhead].report = report;
548 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
549 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Oliver Neukum858155f2010-02-12 13:02:28 +0100551 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 if (hid_submit_ctrl(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100553 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum858155f2010-02-12 13:02:28 +0100554 } else {
555 /*
556 * the queue is known to run
557 * but an earlier request may be stuck
558 * we may need to time out
559 * no race because this is called under
560 * spinlock
561 */
562 if (time_after(jiffies, usbhid->last_ctrl + HZ * 5))
563 usb_unlink_urb(usbhid->urbctrl);
564 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100565}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Oliver Neukum0361a282008-12-17 15:38:03 +0100567void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
568{
569 struct usbhid_device *usbhid = hid->driver_data;
570 unsigned long flags;
571
572 spin_lock_irqsave(&usbhid->lock, flags);
573 __usbhid_submit_report(hid, report, dir);
574 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575}
Jiri Slaby606bd0a2008-07-04 23:06:45 +0200576EXPORT_SYMBOL_GPL(usbhid_submit_report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Jiri Kosina229695e2006-12-08 18:40:53 +0100578static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
Jiri Kosinadde58452006-12-08 18:40:44 +0100579{
Dmitry Torokhove0712982007-05-09 10:17:31 +0200580 struct hid_device *hid = input_get_drvdata(dev);
Oliver Neukum0361a282008-12-17 15:38:03 +0100581 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosinadde58452006-12-08 18:40:44 +0100582 struct hid_field *field;
Oliver Neukum0361a282008-12-17 15:38:03 +0100583 unsigned long flags;
Jiri Kosinadde58452006-12-08 18:40:44 +0100584 int offset;
585
586 if (type == EV_FF)
587 return input_ff_event(dev, type, code, value);
588
589 if (type != EV_LED)
590 return -1;
591
592 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200593 dev_warn(&dev->dev, "event field not found\n");
Jiri Kosinadde58452006-12-08 18:40:44 +0100594 return -1;
595 }
596
597 hid_set_field(field, offset, value);
Oliver Neukum0361a282008-12-17 15:38:03 +0100598 if (value) {
599 spin_lock_irqsave(&usbhid->lock, flags);
600 usbhid->ledcount++;
601 spin_unlock_irqrestore(&usbhid->lock, flags);
602 } else {
603 spin_lock_irqsave(&usbhid->lock, flags);
604 usbhid->ledcount--;
605 spin_unlock_irqrestore(&usbhid->lock, flags);
606 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100607 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
Jiri Kosinadde58452006-12-08 18:40:44 +0100608
609 return 0;
610}
611
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100612int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100614 struct usbhid_device *usbhid = hid->driver_data;
615
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100616 if (!wait_event_timeout(usbhid->wait,
617 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
618 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200620 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return -1;
622 }
623
624 return 0;
625}
Bruno Prémontb8c21cf2010-03-30 22:34:30 +0200626EXPORT_SYMBOL_GPL(usbhid_wait_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500628static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
629{
Vojtech Pavlik71387bd2005-05-29 02:28:14 -0500630 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500631 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
632 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
633}
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
636 unsigned char type, void *buf, int size)
637{
638 int result, retries = 4;
639
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100640 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642 do {
643 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
644 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
645 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
646 retries--;
647 } while (result < size && retries);
648 return result;
649}
650
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100651int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652{
Oliver Neukum933e3182007-07-11 14:48:58 +0200653 struct usbhid_device *usbhid = hid->driver_data;
654 int res;
655
Oliver Neukum0361a282008-12-17 15:38:03 +0100656 mutex_lock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200657 if (!hid->open++) {
658 res = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100659 /* the device must be awake to reliable request remote wakeup */
Oliver Neukum933e3182007-07-11 14:48:58 +0200660 if (res < 0) {
661 hid->open--;
Oliver Neukum0361a282008-12-17 15:38:03 +0100662 mutex_unlock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200663 return -EIO;
664 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100665 usbhid->intf->needs_remote_wakeup = 1;
666 if (hid_start_in(hid))
667 hid_io_error(hid);
668
669 usb_autopm_put_interface(usbhid->intf);
Oliver Neukum933e3182007-07-11 14:48:58 +0200670 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100671 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 return 0;
673}
674
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100675void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100677 struct usbhid_device *usbhid = hid->driver_data;
678
Oliver Neukum0361a282008-12-17 15:38:03 +0100679 mutex_lock(&hid_open_mut);
680
681 /* protecting hid->open to make sure we don't restart
682 * data acquistion due to a resumption we no longer
683 * care about
684 */
685 spin_lock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200686 if (!--hid->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100687 spin_unlock_irq(&usbhid->lock);
Oliver Neukum89092dd2009-04-29 17:12:12 +0200688 hid_cancel_delayed_stuff(usbhid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100689 usb_kill_urb(usbhid->urbin);
Oliver Neukum0361a282008-12-17 15:38:03 +0100690 usbhid->intf->needs_remote_wakeup = 0;
691 } else {
692 spin_unlock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200693 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100694 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
696
697/*
698 * Initialize all reports
699 */
700
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100701void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
703 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100704 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 int err, ret;
706
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500707 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100708 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100711 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100714 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 while (ret) {
716 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100717 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
718 usb_kill_urb(usbhid->urbctrl);
719 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
720 usb_kill_urb(usbhid->urbout);
721 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 }
723
724 if (err)
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200725 dev_warn(&hid->dev, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
727
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500728/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200729 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
730 */
731static int hid_find_field_early(struct hid_device *hid, unsigned int page,
732 unsigned int hid_code, struct hid_field **pfield)
733{
734 struct hid_report *report;
735 struct hid_field *field;
736 struct hid_usage *usage;
737 int i, j;
738
739 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
740 for (i = 0; i < report->maxfield; i++) {
741 field = report->field[i];
742 for (j = 0; j < field->maxusage; j++) {
743 usage = &field->usage[j];
744 if ((usage->hid & HID_USAGE_PAGE) == page &&
745 (usage->hid & 0xFFFF) == hid_code) {
746 *pfield = field;
747 return j;
748 }
749 }
750 }
751 }
752 return -1;
753}
754
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200755void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200756{
757 struct hid_field *field;
758 int offset;
759
760 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
761 hid_set_field(field, offset, 0);
762 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
763 }
764}
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200765EXPORT_SYMBOL_GPL(usbhid_set_leds);
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200766
767/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500768 * Traverse the supplied list of reports and find the longest
769 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100770static void hid_find_max_report(struct hid_device *hid, unsigned int type,
771 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500772{
773 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100774 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500775
776 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200777 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500778 if (*max < size)
779 *max = size;
780 }
781}
782
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
784{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100785 struct usbhid_device *usbhid = hid->driver_data;
786
Daniel Mack997ea582010-04-12 13:17:25 +0200787 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100788 &usbhid->inbuf_dma);
Daniel Mack997ea582010-04-12 13:17:25 +0200789 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100790 &usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500791 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
Daniel Mack997ea582010-04-12 13:17:25 +0200792 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100793 &usbhid->ctrlbuf_dma);
794 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
795 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 return -1;
797
798 return 0;
799}
800
Jiri Kosinad4bfa032010-01-29 15:03:36 +0100801static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count,
802 unsigned char report_type)
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200803{
804 struct usbhid_device *usbhid = hid->driver_data;
805 struct usb_device *dev = hid_to_usb_dev(hid);
806 struct usb_interface *intf = usbhid->intf;
807 struct usb_host_interface *interface = intf->cur_altsetting;
808 int ret;
809
Alan Otta8ab5d52010-05-16 18:07:09 -0400810 if (usbhid->urbout) {
811 int actual_length;
812 int skipped_report_id = 0;
813 if (buf[0] == 0x0) {
814 /* Don't send the Report ID */
815 buf++;
816 count--;
817 skipped_report_id = 1;
818 }
819 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
820 buf, count, &actual_length,
821 USB_CTRL_SET_TIMEOUT);
822 /* return the number of bytes transferred */
823 if (ret == 0) {
824 ret = actual_length;
825 /* count also the report id */
826 if (skipped_report_id)
827 ret++;
828 }
829 } else {
Alan Ott29129a92010-06-30 09:50:36 -0400830 int skipped_report_id = 0;
Alan Ottc29771c2010-08-17 00:44:04 -0400831 int report_id = buf[0];
Alan Ott29129a92010-06-30 09:50:36 -0400832 if (buf[0] == 0x0) {
833 /* Don't send the Report ID */
834 buf++;
835 count--;
836 skipped_report_id = 1;
837 }
Alan Otta8ab5d52010-05-16 18:07:09 -0400838 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
839 HID_REQ_SET_REPORT,
840 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Alan Ottc29771c2010-08-17 00:44:04 -0400841 ((report_type + 1) << 8) | report_id,
Alan Ott29129a92010-06-30 09:50:36 -0400842 interface->desc.bInterfaceNumber, buf, count,
Alan Otta8ab5d52010-05-16 18:07:09 -0400843 USB_CTRL_SET_TIMEOUT);
Alan Ott29129a92010-06-30 09:50:36 -0400844 /* count also the report id, if this was a numbered report. */
845 if (ret > 0 && skipped_report_id)
Alan Otta8ab5d52010-05-16 18:07:09 -0400846 ret++;
847 }
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200848
849 return ret;
850}
851
Oliver Neukum0361a282008-12-17 15:38:03 +0100852static void usbhid_restart_queues(struct usbhid_device *usbhid)
853{
854 if (usbhid->urbout)
855 usbhid_restart_out_queue(usbhid);
856 usbhid_restart_ctrl_queue(usbhid);
857}
858
859static void __usbhid_restart_queues(struct work_struct *work)
860{
861 struct usbhid_device *usbhid =
862 container_of(work, struct usbhid_device, restart_work);
863 int r;
864
865 r = usb_autopm_get_interface(usbhid->intf);
866 if (r < 0)
867 return;
868 usb_autopm_put_interface(usbhid->intf);
869}
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
872{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100873 struct usbhid_device *usbhid = hid->driver_data;
874
Daniel Mack997ea582010-04-12 13:17:25 +0200875 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
876 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500877 kfree(usbhid->cr);
Daniel Mack997ea582010-04-12 13:17:25 +0200878 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
880
Jiri Slabyc500c972008-05-16 11:49:16 +0200881static int usbhid_parse(struct hid_device *hid)
882{
883 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 struct usb_host_interface *interface = intf->cur_altsetting;
885 struct usb_device *dev = interface_to_usbdev (intf);
886 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200887 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200888 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500889 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200890 int ret, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200892 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
893 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100895 if (quirks & HID_QUIRK_IGNORE)
896 return -ENODEV;
897
Alan Stern0f28b552006-05-15 14:49:04 -0400898 /* Many keyboards and mice don't like to be polled for reports,
899 * so we will always set the HID_QUIRK_NOGET flag for them. */
900 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
901 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
902 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
903 quirks |= HID_QUIRK_NOGET;
904 }
905
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500906 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
907 (!interface->desc.bNumEndpoints ||
908 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200909 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200910 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 }
912
Jiri Slabyc500c972008-05-16 11:49:16 +0200913 hid->version = le16_to_cpu(hdesc->bcdHID);
914 hid->country = hdesc->bCountryCode;
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 for (n = 0; n < hdesc->bNumDescriptors; n++)
917 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
918 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
919
920 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200921 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +0200922 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 }
924
925 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200926 dbg_hid("couldn't allocate rdesc memory\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200927 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 }
929
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500930 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
931
Jiri Slabyc500c972008-05-16 11:49:16 +0200932 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
933 HID_DT_REPORT, rdesc, rsize);
934 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200935 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200937 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 }
939
Jiri Slabyc500c972008-05-16 11:49:16 +0200940 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200942 if (ret) {
943 dbg_hid("parsing report descriptor failed\n");
944 goto err;
945 }
946
Zoltan Karcagif5208992009-05-06 16:30:21 +0200947 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
Jiri Slabyc500c972008-05-16 11:49:16 +0200949 return 0;
950err:
951 return ret;
952}
953
954static int usbhid_start(struct hid_device *hid)
955{
956 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
957 struct usb_host_interface *interface = intf->cur_altsetting;
958 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +0100959 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +0200960 unsigned int n, insize = 0;
961 int ret;
962
Jiri Slabye3e14de2008-11-01 23:41:46 +0100963 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
964
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100965 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
966 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
967 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
968 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
969
970 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
971 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500972
973 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
974
975 if (insize > HID_MAX_BUFFER_SIZE)
976 insize = HID_MAX_BUFFER_SIZE;
977
Jiri Slabyc500c972008-05-16 11:49:16 +0200978 if (hid_alloc_buffers(dev, hid)) {
979 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100981 }
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 struct usb_endpoint_descriptor *endpoint;
985 int pipe;
986 int interval;
987
988 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +0100989 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 continue;
991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100994 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +0200995 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100996 dev->speed == USB_SPEED_HIGH) {
997 interval = fls(endpoint->bInterval*8);
998 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
999 hid->name, endpoint->bInterval, interval);
1000 }
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 /* Change the polling interval of mice. */
1003 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1004 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05001005
Jiri Slabyc500c972008-05-16 11:49:16 +02001006 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -03001007 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001008 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001010 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 goto fail;
1012 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001013 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001015 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1016 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001018 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001020 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 goto fail;
1022 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001023 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001025 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1026 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 }
1028 }
1029
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001030 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +02001031 if (!usbhid->urbctrl) {
1032 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +02001034 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001035
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001036 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1037 usbhid->ctrlbuf, 1, hid_ctrl, hid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001038 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
Alan Stern0ede76f2010-03-05 15:10:17 -05001039 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Jiri Slabyc500c972008-05-16 11:49:16 +02001040
Jiri Kosina5b915d92009-11-05 14:08:03 +01001041 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1042 usbhid_init_reports(hid);
Jiri Slaby93c10132008-06-27 00:04:24 +02001043
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001044 set_bit(HID_STARTED, &usbhid->iofl);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001045
Alan Stern08ef08e2008-10-30 23:58:51 +01001046 /* Some keyboards don't work until their LEDs have been set.
1047 * Since BIOSes do set the LEDs, it must be safe for any device
1048 * that supports the keyboard boot protocol.
Alan Stern3d615102010-04-02 13:21:58 -04001049 * In addition, enable remote wakeup by default for all keyboard
1050 * devices supporting the boot protocol.
Alan Stern08ef08e2008-10-30 23:58:51 +01001051 */
1052 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1053 interface->desc.bInterfaceProtocol ==
Alan Stern3d615102010-04-02 13:21:58 -04001054 USB_INTERFACE_PROTOCOL_KEYBOARD) {
Alan Stern08ef08e2008-10-30 23:58:51 +01001055 usbhid_set_leds(hid);
Alan Stern3d615102010-04-02 13:21:58 -04001056 device_set_wakeup_enable(&dev->dev, 1);
1057 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001058 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
1060fail:
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001061 usb_free_urb(usbhid->urbin);
1062 usb_free_urb(usbhid->urbout);
1063 usb_free_urb(usbhid->urbctrl);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001064 usbhid->urbin = NULL;
1065 usbhid->urbout = NULL;
1066 usbhid->urbctrl = NULL;
Jiri Kosina22f675f2007-08-01 12:32:27 +02001067 hid_free_buffers(dev, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001068 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069}
1070
Jiri Slabyc500c972008-05-16 11:49:16 +02001071static void usbhid_stop(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072{
Jiri Slabyc500c972008-05-16 11:49:16 +02001073 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Jiri Slabyc500c972008-05-16 11:49:16 +02001075 if (WARN_ON(!usbhid))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 return;
1077
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001078 clear_bit(HID_STARTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001079 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
Oliver Neukum69626f22008-03-31 16:27:30 +02001080 set_bit(HID_DISCONNECTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001081 spin_unlock_irq(&usbhid->lock);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001082 usb_kill_urb(usbhid->urbin);
1083 usb_kill_urb(usbhid->urbout);
1084 usb_kill_urb(usbhid->urbctrl);
1085
Oliver Neukum0361a282008-12-17 15:38:03 +01001086 hid_cancel_delayed_stuff(usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -05001087
Jiri Slabyc500c972008-05-16 11:49:16 +02001088 hid->claimed = 0;
1089
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001090 usb_free_urb(usbhid->urbin);
1091 usb_free_urb(usbhid->urbctrl);
1092 usb_free_urb(usbhid->urbout);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001093 usbhid->urbin = NULL; /* don't mess up next start */
1094 usbhid->urbctrl = NULL;
1095 usbhid->urbout = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Anssi Hannulabe820972007-01-19 19:28:17 +02001097 hid_free_buffers(hid_to_usb_dev(hid), hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
1099
Oliver Neukum0361a282008-12-17 15:38:03 +01001100static int usbhid_power(struct hid_device *hid, int lvl)
1101{
1102 int r = 0;
1103
1104 switch (lvl) {
1105 case PM_HINT_FULLON:
1106 r = usbhid_get_power(hid);
1107 break;
1108 case PM_HINT_NORMAL:
1109 usbhid_put_power(hid);
1110 break;
1111 }
1112 return r;
1113}
1114
Jiri Slabyc500c972008-05-16 11:49:16 +02001115static struct hid_ll_driver usb_hid_driver = {
1116 .parse = usbhid_parse,
1117 .start = usbhid_start,
1118 .stop = usbhid_stop,
1119 .open = usbhid_open,
1120 .close = usbhid_close,
Oliver Neukum0361a282008-12-17 15:38:03 +01001121 .power = usbhid_power,
Jiri Slabyc500c972008-05-16 11:49:16 +02001122 .hidinput_input_event = usb_hidinput_input_event,
1123};
1124
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001125static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126{
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001127 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Slabyc500c972008-05-16 11:49:16 +02001128 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001129 struct usbhid_device *usbhid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 struct hid_device *hid;
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001131 unsigned int n, has_in = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +02001132 size_t len;
1133 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Jiri Kosina58037eb2007-05-30 15:07:13 +02001135 dbg_hid("HID probe called for ifnum %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 intf->altsetting->desc.bInterfaceNumber);
1137
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001138 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1139 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1140 has_in++;
1141 if (!has_in) {
1142 dev_err(&intf->dev, "couldn't find an input interrupt "
1143 "endpoint\n");
1144 return -ENODEV;
1145 }
1146
Jiri Slabyc500c972008-05-16 11:49:16 +02001147 hid = hid_allocate_device();
1148 if (IS_ERR(hid))
1149 return PTR_ERR(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
1151 usb_set_intfdata(intf, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001152 hid->ll_driver = &usb_hid_driver;
1153 hid->hid_output_raw_report = usbhid_output_raw_report;
Jiri Slaby76483cf2008-09-18 12:23:33 +02001154 hid->ff_init = hid_pidff_init;
Jiri Slabyc500c972008-05-16 11:49:16 +02001155#ifdef CONFIG_USB_HIDDEV
Jiri Slaby93c10132008-06-27 00:04:24 +02001156 hid->hiddev_connect = hiddev_connect;
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001157 hid->hiddev_disconnect = hiddev_disconnect;
Jiri Slabyc500c972008-05-16 11:49:16 +02001158 hid->hiddev_hid_event = hiddev_hid_event;
1159 hid->hiddev_report_event = hiddev_report_event;
1160#endif
1161 hid->dev.parent = &intf->dev;
1162 hid->bus = BUS_USB;
1163 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1164 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1165 hid->name[0] = 0;
Bastien Nocerab5e5a372010-04-16 17:19:50 +01001166 hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
Jiri Slabya73a6372008-10-22 14:45:11 +02001167 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1168 USB_INTERFACE_PROTOCOL_MOUSE)
1169 hid->type = HID_TYPE_USBMOUSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Jiri Slabyc500c972008-05-16 11:49:16 +02001171 if (dev->manufacturer)
1172 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1173
1174 if (dev->product) {
1175 if (dev->manufacturer)
1176 strlcat(hid->name, " ", sizeof(hid->name));
1177 strlcat(hid->name, dev->product, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 }
1179
Jiri Slabyc500c972008-05-16 11:49:16 +02001180 if (!strlen(hid->name))
1181 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1182 le16_to_cpu(dev->descriptor.idVendor),
1183 le16_to_cpu(dev->descriptor.idProduct));
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001184
Jiri Slabyc500c972008-05-16 11:49:16 +02001185 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1186 strlcat(hid->phys, "/input", sizeof(hid->phys));
1187 len = strlen(hid->phys);
1188 if (len < sizeof(hid->phys) - 1)
1189 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1190 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Geoff Levand4a1a4d82007-01-15 20:11:52 -08001191
Jiri Slabyc500c972008-05-16 11:49:16 +02001192 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1193 hid->uniq[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001195 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1196 if (usbhid == NULL) {
1197 ret = -ENOMEM;
1198 goto err;
1199 }
1200
1201 hid->driver_data = usbhid;
1202 usbhid->hid = hid;
Jiri Kosina57ab12e2010-02-17 14:25:01 +01001203 usbhid->intf = intf;
1204 usbhid->ifnum = interface->desc.bInterfaceNumber;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001205
Alan Sternfde4e2f2010-05-07 10:41:10 -04001206 init_waitqueue_head(&usbhid->wait);
1207 INIT_WORK(&usbhid->reset_work, hid_reset);
1208 INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
1209 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1210 spin_lock_init(&usbhid->lock);
1211
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001212 ret = hid_add_device(hid);
1213 if (ret) {
Jiri Slabyd458a9d2008-05-16 11:49:20 +02001214 if (ret != -ENODEV)
1215 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001216 goto err_free;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001217 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001218
1219 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001220err_free:
1221 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001222err:
1223 hid_destroy_device(hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001224 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
1226
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001227static void usbhid_disconnect(struct usb_interface *intf)
Jiri Slabyc500c972008-05-16 11:49:16 +02001228{
1229 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001230 struct usbhid_device *usbhid;
Jiri Slabyc500c972008-05-16 11:49:16 +02001231
1232 if (WARN_ON(!hid))
1233 return;
1234
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001235 usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +02001236 hid_destroy_device(hid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001237 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001238}
1239
Oliver Neukum0361a282008-12-17 15:38:03 +01001240static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
Oliver Neukum0361a282008-12-17 15:38:03 +01001242 del_timer_sync(&usbhid->io_retry);
1243 cancel_work_sync(&usbhid->restart_work);
1244 cancel_work_sync(&usbhid->reset_work);
1245}
1246
1247static void hid_cease_io(struct usbhid_device *usbhid)
1248{
1249 del_timer(&usbhid->io_retry);
1250 usb_kill_urb(usbhid->urbin);
1251 usb_kill_urb(usbhid->urbctrl);
1252 usb_kill_urb(usbhid->urbout);
Oliver Neukum0361a282008-12-17 15:38:03 +01001253}
1254
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001255/* Treat USB reset pretty much the same as suspend/resume */
1256static int hid_pre_reset(struct usb_interface *intf)
1257{
1258 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001259 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001261 spin_lock_irq(&usbhid->lock);
1262 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1263 spin_unlock_irq(&usbhid->lock);
Oliver Neukum6d779762009-03-22 18:01:49 +01001264 cancel_work_sync(&usbhid->restart_work);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001265 hid_cease_io(usbhid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001266
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001267 return 0;
1268}
1269
1270/* Same routine used for post_reset and reset_resume */
1271static int hid_post_reset(struct usb_interface *intf)
1272{
1273 struct usb_device *dev = interface_to_usbdev (intf);
1274 struct hid_device *hid = usb_get_intfdata(intf);
1275 struct usbhid_device *usbhid = hid->driver_data;
1276 int status;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001277
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001278 spin_lock_irq(&usbhid->lock);
1279 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1280 spin_unlock_irq(&usbhid->lock);
1281 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001282 status = hid_start_in(hid);
1283 if (status < 0)
1284 hid_io_error(hid);
1285 usbhid_restart_queues(usbhid);
1286
1287 return 0;
1288}
1289
1290int usbhid_get_power(struct hid_device *hid)
1291{
1292 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001293
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001294 return usb_autopm_get_interface(usbhid->intf);
1295}
1296
1297void usbhid_put_power(struct hid_device *hid)
1298{
1299 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001300
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001301 usb_autopm_put_interface(usbhid->intf);
1302}
1303
1304
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001305#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1307{
Oliver Neukum0361a282008-12-17 15:38:03 +01001308 struct hid_device *hid = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +01001310 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Alan Sternfb34d532009-11-13 11:53:59 -05001312 if (message.event & PM_EVENT_AUTO) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001313 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1314 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1315 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1316 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1317 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1318 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1319 && (!usbhid->ledcount || ignoreled))
1320 {
1321 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1322 spin_unlock_irq(&usbhid->lock);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001323 if (hid->driver && hid->driver->suspend) {
1324 status = hid->driver->suspend(hid, message);
1325 if (status < 0)
1326 return status;
1327 }
Oliver Neukum0361a282008-12-17 15:38:03 +01001328 } else {
1329 usbhid_mark_busy(usbhid);
1330 spin_unlock_irq(&usbhid->lock);
1331 return -EBUSY;
1332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Oliver Neukum0361a282008-12-17 15:38:03 +01001334 } else {
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001335 if (hid->driver && hid->driver->suspend) {
1336 status = hid->driver->suspend(hid, message);
1337 if (status < 0)
1338 return status;
1339 }
Oliver Neukum0361a282008-12-17 15:38:03 +01001340 spin_lock_irq(&usbhid->lock);
1341 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1342 spin_unlock_irq(&usbhid->lock);
1343 if (usbhid_wait_io(hid) < 0)
1344 return -EIO;
1345 }
1346
Alan Sternfb34d532009-11-13 11:53:59 -05001347 if (!ignoreled && (message.event & PM_EVENT_AUTO)) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001348 spin_lock_irq(&usbhid->lock);
1349 if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1350 spin_unlock_irq(&usbhid->lock);
1351 usbhid_mark_busy(usbhid);
1352 return -EBUSY;
1353 }
1354 spin_unlock_irq(&usbhid->lock);
1355 }
1356
1357 hid_cancel_delayed_stuff(usbhid);
1358 hid_cease_io(usbhid);
1359
Alan Sternfb34d532009-11-13 11:53:59 -05001360 if ((message.event & PM_EVENT_AUTO) &&
1361 test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001362 /* lost race against keypresses */
1363 status = hid_start_in(hid);
1364 if (status < 0)
1365 hid_io_error(hid);
1366 usbhid_mark_busy(usbhid);
1367 return -EBUSY;
1368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 dev_dbg(&intf->dev, "suspend\n");
1370 return 0;
1371}
1372
1373static int hid_resume(struct usb_interface *intf)
1374{
1375 struct hid_device *hid = usb_get_intfdata (intf);
1376 struct usbhid_device *usbhid = hid->driver_data;
1377 int status;
1378
Jiri Slabyfde5be32008-11-23 12:03:20 +01001379 if (!test_bit(HID_STARTED, &usbhid->iofl))
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001380 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001381
Oliver Neukum0361a282008-12-17 15:38:03 +01001382 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1383 usbhid_mark_busy(usbhid);
1384
1385 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1386 test_bit(HID_RESET_PENDING, &usbhid->iofl))
1387 schedule_work(&usbhid->reset_work);
Alan Sterndf9a1f42006-06-01 13:55:28 -04001388 usbhid->retry_delay = 0;
1389 status = hid_start_in(hid);
Oliver Neukum0361a282008-12-17 15:38:03 +01001390 if (status < 0)
1391 hid_io_error(hid);
1392 usbhid_restart_queues(usbhid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001394 if (status >= 0 && hid->driver && hid->driver->resume) {
1395 int ret = hid->driver->resume(hid);
1396 if (ret < 0)
1397 status = ret;
1398 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 dev_dbg(&intf->dev, "resume status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 return 0;
1401}
1402
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001403static int hid_reset_resume(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404{
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001405 struct hid_device *hid = usb_get_intfdata(intf);
1406 struct usbhid_device *usbhid = hid->driver_data;
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001407 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001409 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001410 status = hid_post_reset(intf);
1411 if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1412 int ret = hid->driver->reset_resume(hid);
1413 if (ret < 0)
1414 status = ret;
1415 }
1416 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001419#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Márton Némethd67dec52010-01-10 17:59:22 +01001421static const struct usb_device_id hid_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1423 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1424 { } /* Terminating entry */
1425};
1426
1427MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1428
1429static struct usb_driver hid_driver = {
1430 .name = "usbhid",
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001431 .probe = usbhid_probe,
1432 .disconnect = usbhid_disconnect,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001433#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 .suspend = hid_suspend,
1435 .resume = hid_resume,
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001436 .reset_resume = hid_reset_resume,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001437#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 .pre_reset = hid_pre_reset,
1439 .post_reset = hid_post_reset,
1440 .id_table = hid_usb_ids,
Oliver Neukum933e3182007-07-11 14:48:58 +02001441 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442};
1443
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001444static const struct hid_device_id hid_usb_table[] = {
1445 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1446 { }
1447};
1448
Guillaume Chazarain8fe294c2010-09-12 21:32:35 +02001449struct usb_interface *usbhid_find_interface(int minor)
1450{
1451 return usb_find_interface(&hid_driver, minor);
1452}
1453
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001454static struct hid_driver hid_usb_driver = {
1455 .name = "generic-usb",
1456 .id_table = hid_usb_table,
1457};
1458
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459static int __init hid_init(void)
1460{
Oliver Neukum0361a282008-12-17 15:38:03 +01001461 int retval = -ENOMEM;
1462
1463 resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1464 if (!resumption_waker)
1465 goto no_queue;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001466 retval = hid_register_driver(&hid_usb_driver);
1467 if (retval)
1468 goto hid_register_fail;
Paul Walmsley876b9272007-04-19 14:56:12 +02001469 retval = usbhid_quirks_init(quirks_param);
1470 if (retval)
1471 goto usbhid_quirks_init_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 retval = hiddev_init();
1473 if (retval)
1474 goto hiddev_init_fail;
1475 retval = usb_register(&hid_driver);
1476 if (retval)
1477 goto usb_register_fail;
Jiri Kosinaccabcd22009-10-02 18:31:36 +02001478 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
1480 return 0;
1481usb_register_fail:
1482 hiddev_exit();
1483hiddev_init_fail:
Paul Walmsley876b9272007-04-19 14:56:12 +02001484 usbhid_quirks_exit();
1485usbhid_quirks_init_fail:
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001486 hid_unregister_driver(&hid_usb_driver);
1487hid_register_fail:
Oliver Neukum0361a282008-12-17 15:38:03 +01001488 destroy_workqueue(resumption_waker);
1489no_queue:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 return retval;
1491}
1492
1493static void __exit hid_exit(void)
1494{
1495 usb_deregister(&hid_driver);
1496 hiddev_exit();
Paul Walmsley876b9272007-04-19 14:56:12 +02001497 usbhid_quirks_exit();
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001498 hid_unregister_driver(&hid_usb_driver);
Oliver Neukum0361a282008-12-17 15:38:03 +01001499 destroy_workqueue(resumption_waker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500}
1501
1502module_init(hid_init);
1503module_exit(hid_exit);
1504
Jiri Kosina88adb722009-10-02 18:29:34 +02001505MODULE_AUTHOR("Andreas Gal");
1506MODULE_AUTHOR("Vojtech Pavlik");
1507MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508MODULE_DESCRIPTION(DRIVER_DESC);
1509MODULE_LICENSE(DRIVER_LICENSE);