blob: e72751d6e3e7df1e8a7f5883551916a74fb2f642 [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 Kosinaa635f9d2009-06-12 15:20:55 +02008 * Copyright (c) 2006-2009 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 }
319 } else {
320 /*
321 * queue work to wake up the device.
322 * as the work queue is freezeable, this is safe
323 * with respect to STD and STR
324 */
325 queue_work(resumption_waker, &usbhid->restart_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
327
328 return 0;
329}
330
331static int hid_submit_ctrl(struct hid_device *hid)
332{
333 struct hid_report *report;
334 unsigned char dir;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200335 char *raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 int len;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100337 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100339 report = usbhid->ctrl[usbhid->ctrltail].report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200340 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100341 dir = usbhid->ctrl[usbhid->ctrltail].dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Oliver Neukum0361a282008-12-17 15:38:03 +0100343 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
344 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
345 if (dir == USB_DIR_OUT) {
346 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
347 usbhid->urbctrl->transfer_buffer_length = len;
348 memcpy(usbhid->ctrlbuf, raw_report, len);
349 kfree(raw_report);
350 } else {
351 int maxpacket, padlen;
352
353 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
354 maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
355 if (maxpacket > 0) {
356 padlen = DIV_ROUND_UP(len, maxpacket);
357 padlen *= maxpacket;
358 if (padlen > usbhid->bufsize)
359 padlen = usbhid->bufsize;
360 } else
361 padlen = 0;
362 usbhid->urbctrl->transfer_buffer_length = padlen;
363 }
364 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
365
366 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
367 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
368 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
369 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
370 usbhid->cr->wLength = cpu_to_le16(len);
371
372 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
373 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
374 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
375
376 if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
377 err_hid("usb_submit_urb(ctrl) failed");
378 return -1;
379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 } else {
Oliver Neukum0361a282008-12-17 15:38:03 +0100381 /*
382 * queue work to wake up the device.
383 * as the work queue is freezeable, this is safe
384 * with respect to STD and STR
385 */
386 queue_work(resumption_waker, &usbhid->restart_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 }
388
389 return 0;
390}
391
392/*
393 * Output interrupt completion handler.
394 */
395
David Howells7d12e782006-10-05 14:55:46 +0100396static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
398 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100399 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 unsigned long flags;
401 int unplug = 0;
402
403 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200404 case 0: /* success */
405 break;
406 case -ESHUTDOWN: /* unplug */
407 unplug = 1;
408 case -EILSEQ: /* protocol error or unplug */
409 case -EPROTO: /* protocol error or unplug */
410 case -ECONNRESET: /* unlink */
411 case -ENOENT:
412 break;
413 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200414 dev_warn(&urb->dev->dev, "output irq status %d "
415 "received\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 }
417
Oliver Neukum0361a282008-12-17 15:38:03 +0100418 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100421 usbhid->outtail = usbhid->outhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100423 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100425 if (usbhid->outhead != usbhid->outtail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 if (hid_submit_out(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100427 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100428 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100430 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 return;
432 }
433
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100434 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100435 spin_unlock_irqrestore(&usbhid->lock, flags);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100436 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437}
438
439/*
440 * Control pipe completion handler.
441 */
442
David Howells7d12e782006-10-05 14:55:46 +0100443static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100446 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100447 int unplug = 0, status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Oliver Neukum0361a282008-12-17 15:38:03 +0100449 spin_lock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Oliver Neukum0361a282008-12-17 15:38:03 +0100451 switch (status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200452 case 0: /* success */
453 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
454 hid_input_report(urb->context,
455 usbhid->ctrl[usbhid->ctrltail].report->type,
456 urb->transfer_buffer, urb->actual_length, 0);
457 break;
458 case -ESHUTDOWN: /* unplug */
459 unplug = 1;
460 case -EILSEQ: /* protocol error or unplug */
461 case -EPROTO: /* protocol error or unplug */
462 case -ECONNRESET: /* unlink */
463 case -ENOENT:
464 case -EPIPE: /* report not available */
465 break;
466 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200467 dev_warn(&urb->dev->dev, "ctrl urb status %d "
Oliver Neukum0361a282008-12-17 15:38:03 +0100468 "received\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 }
470
471 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100472 usbhid->ctrltail = usbhid->ctrlhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100474 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100476 if (usbhid->ctrlhead != usbhid->ctrltail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 if (hid_submit_ctrl(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100478 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100479 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100481 spin_unlock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 return;
483 }
484
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100485 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100486 spin_unlock(&usbhid->lock);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100487 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488}
489
H Hartley Sweeten52cfc61b2009-08-17 15:37:18 -0700490static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
491 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100494 struct usbhid_device *usbhid = hid->driver_data;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200495 int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
498 return;
499
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100500 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100501 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200502 dev_warn(&hid->dev, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 return;
504 }
505
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200506 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
507 if (!usbhid->out[usbhid->outhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700508 dev_warn(&hid->dev, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200509 return;
510 }
511 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
512 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100513 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100515 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 if (hid_submit_out(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100517 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 return;
519 }
520
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100521 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200522 dev_warn(&hid->dev, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 return;
524 }
525
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200526 if (dir == USB_DIR_OUT) {
527 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
528 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700529 dev_warn(&hid->dev, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200530 return;
531 }
532 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
533 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100534 usbhid->ctrl[usbhid->ctrlhead].report = report;
535 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
536 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100538 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 if (hid_submit_ctrl(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100540 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100541}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Oliver Neukum0361a282008-12-17 15:38:03 +0100543void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
544{
545 struct usbhid_device *usbhid = hid->driver_data;
546 unsigned long flags;
547
548 spin_lock_irqsave(&usbhid->lock, flags);
549 __usbhid_submit_report(hid, report, dir);
550 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
Jiri Slaby606bd0a2008-07-04 23:06:45 +0200552EXPORT_SYMBOL_GPL(usbhid_submit_report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Jiri Kosina229695e2006-12-08 18:40:53 +0100554static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
Jiri Kosinadde58452006-12-08 18:40:44 +0100555{
Dmitry Torokhove0712982007-05-09 10:17:31 +0200556 struct hid_device *hid = input_get_drvdata(dev);
Oliver Neukum0361a282008-12-17 15:38:03 +0100557 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosinadde58452006-12-08 18:40:44 +0100558 struct hid_field *field;
Oliver Neukum0361a282008-12-17 15:38:03 +0100559 unsigned long flags;
Jiri Kosinadde58452006-12-08 18:40:44 +0100560 int offset;
561
562 if (type == EV_FF)
563 return input_ff_event(dev, type, code, value);
564
565 if (type != EV_LED)
566 return -1;
567
568 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200569 dev_warn(&dev->dev, "event field not found\n");
Jiri Kosinadde58452006-12-08 18:40:44 +0100570 return -1;
571 }
572
573 hid_set_field(field, offset, value);
Oliver Neukum0361a282008-12-17 15:38:03 +0100574 if (value) {
575 spin_lock_irqsave(&usbhid->lock, flags);
576 usbhid->ledcount++;
577 spin_unlock_irqrestore(&usbhid->lock, flags);
578 } else {
579 spin_lock_irqsave(&usbhid->lock, flags);
580 usbhid->ledcount--;
581 spin_unlock_irqrestore(&usbhid->lock, flags);
582 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100583 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
Jiri Kosinadde58452006-12-08 18:40:44 +0100584
585 return 0;
586}
587
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100588int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100590 struct usbhid_device *usbhid = hid->driver_data;
591
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100592 if (!wait_event_timeout(usbhid->wait,
593 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
594 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200596 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return -1;
598 }
599
600 return 0;
601}
602
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500603static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
604{
Vojtech Pavlik71387bd2005-05-29 02:28:14 -0500605 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500606 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
607 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
608}
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
611 unsigned char type, void *buf, int size)
612{
613 int result, retries = 4;
614
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100615 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617 do {
618 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
619 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
620 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
621 retries--;
622 } while (result < size && retries);
623 return result;
624}
625
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100626int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
Oliver Neukum933e3182007-07-11 14:48:58 +0200628 struct usbhid_device *usbhid = hid->driver_data;
629 int res;
630
Oliver Neukum0361a282008-12-17 15:38:03 +0100631 mutex_lock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200632 if (!hid->open++) {
633 res = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100634 /* the device must be awake to reliable request remote wakeup */
Oliver Neukum933e3182007-07-11 14:48:58 +0200635 if (res < 0) {
636 hid->open--;
Oliver Neukum0361a282008-12-17 15:38:03 +0100637 mutex_unlock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200638 return -EIO;
639 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100640 usbhid->intf->needs_remote_wakeup = 1;
641 if (hid_start_in(hid))
642 hid_io_error(hid);
643
644 usb_autopm_put_interface(usbhid->intf);
Oliver Neukum933e3182007-07-11 14:48:58 +0200645 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100646 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return 0;
648}
649
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100650void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100652 struct usbhid_device *usbhid = hid->driver_data;
653
Oliver Neukum0361a282008-12-17 15:38:03 +0100654 mutex_lock(&hid_open_mut);
655
656 /* protecting hid->open to make sure we don't restart
657 * data acquistion due to a resumption we no longer
658 * care about
659 */
660 spin_lock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200661 if (!--hid->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100662 spin_unlock_irq(&usbhid->lock);
Oliver Neukum89092dd2009-04-29 17:12:12 +0200663 hid_cancel_delayed_stuff(usbhid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100664 usb_kill_urb(usbhid->urbin);
Oliver Neukum0361a282008-12-17 15:38:03 +0100665 usbhid->intf->needs_remote_wakeup = 0;
666 } else {
667 spin_unlock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200668 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100669 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
672/*
673 * Initialize all reports
674 */
675
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100676void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
678 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100679 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 int err, ret;
681
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500682 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100683 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
685 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100686 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100689 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 while (ret) {
691 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100692 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
693 usb_kill_urb(usbhid->urbctrl);
694 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
695 usb_kill_urb(usbhid->urbout);
696 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 }
698
699 if (err)
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200700 dev_warn(&hid->dev, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500703/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200704 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
705 */
706static int hid_find_field_early(struct hid_device *hid, unsigned int page,
707 unsigned int hid_code, struct hid_field **pfield)
708{
709 struct hid_report *report;
710 struct hid_field *field;
711 struct hid_usage *usage;
712 int i, j;
713
714 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
715 for (i = 0; i < report->maxfield; i++) {
716 field = report->field[i];
717 for (j = 0; j < field->maxusage; j++) {
718 usage = &field->usage[j];
719 if ((usage->hid & HID_USAGE_PAGE) == page &&
720 (usage->hid & 0xFFFF) == hid_code) {
721 *pfield = field;
722 return j;
723 }
724 }
725 }
726 }
727 return -1;
728}
729
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200730void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200731{
732 struct hid_field *field;
733 int offset;
734
735 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
736 hid_set_field(field, offset, 0);
737 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
738 }
739}
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200740EXPORT_SYMBOL_GPL(usbhid_set_leds);
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200741
742/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500743 * Traverse the supplied list of reports and find the longest
744 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100745static void hid_find_max_report(struct hid_device *hid, unsigned int type,
746 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500747{
748 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100749 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500750
751 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200752 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500753 if (*max < size)
754 *max = size;
755 }
756}
757
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
759{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100760 struct usbhid_device *usbhid = hid->driver_data;
761
Jiri Slaby898089d2008-11-24 16:20:06 +0100762 usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
763 &usbhid->inbuf_dma);
764 usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
765 &usbhid->outbuf_dma);
766 usbhid->cr = usb_buffer_alloc(dev, sizeof(*usbhid->cr), GFP_KERNEL,
767 &usbhid->cr_dma);
768 usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
769 &usbhid->ctrlbuf_dma);
770 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
771 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 return -1;
773
774 return 0;
775}
776
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200777static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
778{
779 struct usbhid_device *usbhid = hid->driver_data;
780 struct usb_device *dev = hid_to_usb_dev(hid);
781 struct usb_interface *intf = usbhid->intf;
782 struct usb_host_interface *interface = intf->cur_altsetting;
783 int ret;
784
785 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
786 HID_REQ_SET_REPORT,
787 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Al Viro01d7b362008-04-28 07:00:05 +0100788 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200789 interface->desc.bInterfaceNumber, buf + 1, count - 1,
790 USB_CTRL_SET_TIMEOUT);
791
792 /* count also the report id */
793 if (ret > 0)
794 ret++;
795
796 return ret;
797}
798
Oliver Neukum0361a282008-12-17 15:38:03 +0100799static void usbhid_restart_queues(struct usbhid_device *usbhid)
800{
801 if (usbhid->urbout)
802 usbhid_restart_out_queue(usbhid);
803 usbhid_restart_ctrl_queue(usbhid);
804}
805
806static void __usbhid_restart_queues(struct work_struct *work)
807{
808 struct usbhid_device *usbhid =
809 container_of(work, struct usbhid_device, restart_work);
810 int r;
811
812 r = usb_autopm_get_interface(usbhid->intf);
813 if (r < 0)
814 return;
815 usb_autopm_put_interface(usbhid->intf);
816}
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
819{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100820 struct usbhid_device *usbhid = hid->driver_data;
821
Dmitry Torokhov6675c5b2007-05-03 01:04:52 -0400822 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
823 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
824 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
825 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
827
Jiri Slabyc500c972008-05-16 11:49:16 +0200828static int usbhid_parse(struct hid_device *hid)
829{
830 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 struct usb_host_interface *interface = intf->cur_altsetting;
832 struct usb_device *dev = interface_to_usbdev (intf);
833 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200834 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200835 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500836 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200837 int ret, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200839 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
840 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100842 if (quirks & HID_QUIRK_IGNORE)
843 return -ENODEV;
844
Alan Stern0f28b552006-05-15 14:49:04 -0400845 /* Many keyboards and mice don't like to be polled for reports,
846 * so we will always set the HID_QUIRK_NOGET flag for them. */
847 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
848 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
849 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
850 quirks |= HID_QUIRK_NOGET;
851 }
852
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500853 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
854 (!interface->desc.bNumEndpoints ||
855 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200856 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200857 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 }
859
Jiri Slabyc500c972008-05-16 11:49:16 +0200860 hid->version = le16_to_cpu(hdesc->bcdHID);
861 hid->country = hdesc->bCountryCode;
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 for (n = 0; n < hdesc->bNumDescriptors; n++)
864 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
865 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
866
867 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200868 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +0200869 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
871
872 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200873 dbg_hid("couldn't allocate rdesc memory\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200874 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 }
876
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500877 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
878
Jiri Slabyc500c972008-05-16 11:49:16 +0200879 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
880 HID_DT_REPORT, rdesc, rsize);
881 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200882 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200884 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
886
Jiri Slabyc500c972008-05-16 11:49:16 +0200887 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200889 if (ret) {
890 dbg_hid("parsing report descriptor failed\n");
891 goto err;
892 }
893
Zoltan Karcagif5208992009-05-06 16:30:21 +0200894 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Jiri Slabyc500c972008-05-16 11:49:16 +0200896 return 0;
897err:
898 return ret;
899}
900
901static int usbhid_start(struct hid_device *hid)
902{
903 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
904 struct usb_host_interface *interface = intf->cur_altsetting;
905 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +0100906 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +0200907 unsigned int n, insize = 0;
908 int ret;
909
Jiri Slabye3e14de2008-11-01 23:41:46 +0100910 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
911
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100912 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
913 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
914 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
915 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
916
917 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
918 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500919
920 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
921
922 if (insize > HID_MAX_BUFFER_SIZE)
923 insize = HID_MAX_BUFFER_SIZE;
924
Jiri Slabyc500c972008-05-16 11:49:16 +0200925 if (hid_alloc_buffers(dev, hid)) {
926 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100928 }
929
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 struct usb_endpoint_descriptor *endpoint;
932 int pipe;
933 int interval;
934
935 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +0100936 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 continue;
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100941 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +0200942 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100943 dev->speed == USB_SPEED_HIGH) {
944 interval = fls(endpoint->bInterval*8);
945 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
946 hid->name, endpoint->bInterval, interval);
947 }
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 /* Change the polling interval of mice. */
950 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
951 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500952
Jiri Slabyc500c972008-05-16 11:49:16 +0200953 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -0300954 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100955 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100957 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 goto fail;
959 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100960 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100962 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
963 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100965 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100967 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 goto fail;
969 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100970 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100972 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
973 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 }
975 }
976
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100977 init_waitqueue_head(&usbhid->wait);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100978 INIT_WORK(&usbhid->reset_work, hid_reset);
Oliver Neukum0361a282008-12-17 15:38:03 +0100979 INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100980 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
Alan Sternaef4e262006-01-31 12:58:38 -0500981
Oliver Neukum0361a282008-12-17 15:38:03 +0100982 spin_lock_init(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100984 usbhid->intf = intf;
985 usbhid->ifnum = interface->desc.bInterfaceNumber;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100987 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +0200988 if (!usbhid->urbctrl) {
989 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +0200991 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500992
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100993 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
994 usbhid->ctrlbuf, 1, hid_ctrl, hid);
995 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
996 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
997 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
Jiri Slabyc500c972008-05-16 11:49:16 +0200998
Jiri Kosina5b915d92009-11-05 14:08:03 +0100999 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1000 usbhid_init_reports(hid);
Jiri Slaby93c10132008-06-27 00:04:24 +02001001
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001002 set_bit(HID_STARTED, &usbhid->iofl);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001003
Alan Stern08ef08e2008-10-30 23:58:51 +01001004 /* Some keyboards don't work until their LEDs have been set.
1005 * Since BIOSes do set the LEDs, it must be safe for any device
1006 * that supports the keyboard boot protocol.
1007 */
1008 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1009 interface->desc.bInterfaceProtocol ==
1010 USB_INTERFACE_PROTOCOL_KEYBOARD)
1011 usbhid_set_leds(hid);
1012
Jiri Slabyc500c972008-05-16 11:49:16 +02001013 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
1015fail:
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001016 usb_free_urb(usbhid->urbin);
1017 usb_free_urb(usbhid->urbout);
1018 usb_free_urb(usbhid->urbctrl);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001019 usbhid->urbin = NULL;
1020 usbhid->urbout = NULL;
1021 usbhid->urbctrl = NULL;
Jiri Kosina22f675f2007-08-01 12:32:27 +02001022 hid_free_buffers(dev, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001023 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
Jiri Slabyc500c972008-05-16 11:49:16 +02001026static void usbhid_stop(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027{
Jiri Slabyc500c972008-05-16 11:49:16 +02001028 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
Jiri Slabyc500c972008-05-16 11:49:16 +02001030 if (WARN_ON(!usbhid))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 return;
1032
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001033 clear_bit(HID_STARTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001034 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
Oliver Neukum69626f22008-03-31 16:27:30 +02001035 set_bit(HID_DISCONNECTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001036 spin_unlock_irq(&usbhid->lock);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001037 usb_kill_urb(usbhid->urbin);
1038 usb_kill_urb(usbhid->urbout);
1039 usb_kill_urb(usbhid->urbctrl);
1040
Oliver Neukum0361a282008-12-17 15:38:03 +01001041 hid_cancel_delayed_stuff(usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -05001042
Jiri Slabyc500c972008-05-16 11:49:16 +02001043 hid->claimed = 0;
1044
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001045 usb_free_urb(usbhid->urbin);
1046 usb_free_urb(usbhid->urbctrl);
1047 usb_free_urb(usbhid->urbout);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001048 usbhid->urbin = NULL; /* don't mess up next start */
1049 usbhid->urbctrl = NULL;
1050 usbhid->urbout = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Anssi Hannulabe820972007-01-19 19:28:17 +02001052 hid_free_buffers(hid_to_usb_dev(hid), hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053}
1054
Oliver Neukum0361a282008-12-17 15:38:03 +01001055static int usbhid_power(struct hid_device *hid, int lvl)
1056{
1057 int r = 0;
1058
1059 switch (lvl) {
1060 case PM_HINT_FULLON:
1061 r = usbhid_get_power(hid);
1062 break;
1063 case PM_HINT_NORMAL:
1064 usbhid_put_power(hid);
1065 break;
1066 }
1067 return r;
1068}
1069
Jiri Slabyc500c972008-05-16 11:49:16 +02001070static struct hid_ll_driver usb_hid_driver = {
1071 .parse = usbhid_parse,
1072 .start = usbhid_start,
1073 .stop = usbhid_stop,
1074 .open = usbhid_open,
1075 .close = usbhid_close,
Oliver Neukum0361a282008-12-17 15:38:03 +01001076 .power = usbhid_power,
Jiri Slabyc500c972008-05-16 11:49:16 +02001077 .hidinput_input_event = usb_hidinput_input_event,
1078};
1079
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001080static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081{
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001082 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Slabyc500c972008-05-16 11:49:16 +02001083 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001084 struct usbhid_device *usbhid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 struct hid_device *hid;
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001086 unsigned int n, has_in = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +02001087 size_t len;
1088 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Jiri Kosina58037eb2007-05-30 15:07:13 +02001090 dbg_hid("HID probe called for ifnum %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 intf->altsetting->desc.bInterfaceNumber);
1092
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001093 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1094 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1095 has_in++;
1096 if (!has_in) {
1097 dev_err(&intf->dev, "couldn't find an input interrupt "
1098 "endpoint\n");
1099 return -ENODEV;
1100 }
1101
Jiri Slabyc500c972008-05-16 11:49:16 +02001102 hid = hid_allocate_device();
1103 if (IS_ERR(hid))
1104 return PTR_ERR(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
1106 usb_set_intfdata(intf, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001107 hid->ll_driver = &usb_hid_driver;
1108 hid->hid_output_raw_report = usbhid_output_raw_report;
Jiri Slaby76483cf2008-09-18 12:23:33 +02001109 hid->ff_init = hid_pidff_init;
Jiri Slabyc500c972008-05-16 11:49:16 +02001110#ifdef CONFIG_USB_HIDDEV
Jiri Slaby93c10132008-06-27 00:04:24 +02001111 hid->hiddev_connect = hiddev_connect;
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001112 hid->hiddev_disconnect = hiddev_disconnect;
Jiri Slabyc500c972008-05-16 11:49:16 +02001113 hid->hiddev_hid_event = hiddev_hid_event;
1114 hid->hiddev_report_event = hiddev_report_event;
1115#endif
1116 hid->dev.parent = &intf->dev;
1117 hid->bus = BUS_USB;
1118 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1119 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1120 hid->name[0] = 0;
Jiri Slabya73a6372008-10-22 14:45:11 +02001121 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1122 USB_INTERFACE_PROTOCOL_MOUSE)
1123 hid->type = HID_TYPE_USBMOUSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Jiri Slabyc500c972008-05-16 11:49:16 +02001125 if (dev->manufacturer)
1126 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1127
1128 if (dev->product) {
1129 if (dev->manufacturer)
1130 strlcat(hid->name, " ", sizeof(hid->name));
1131 strlcat(hid->name, dev->product, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 }
1133
Jiri Slabyc500c972008-05-16 11:49:16 +02001134 if (!strlen(hid->name))
1135 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1136 le16_to_cpu(dev->descriptor.idVendor),
1137 le16_to_cpu(dev->descriptor.idProduct));
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001138
Jiri Slabyc500c972008-05-16 11:49:16 +02001139 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1140 strlcat(hid->phys, "/input", sizeof(hid->phys));
1141 len = strlen(hid->phys);
1142 if (len < sizeof(hid->phys) - 1)
1143 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1144 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Geoff Levand4a1a4d82007-01-15 20:11:52 -08001145
Jiri Slabyc500c972008-05-16 11:49:16 +02001146 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1147 hid->uniq[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001149 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1150 if (usbhid == NULL) {
1151 ret = -ENOMEM;
1152 goto err;
1153 }
1154
1155 hid->driver_data = usbhid;
1156 usbhid->hid = hid;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001157
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001158 ret = hid_add_device(hid);
1159 if (ret) {
Jiri Slabyd458a9d2008-05-16 11:49:20 +02001160 if (ret != -ENODEV)
1161 dev_err(&intf->dev, "can't add hid device: %d\n", ret);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001162 goto err_free;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001163 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001164
1165 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001166err_free:
1167 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001168err:
1169 hid_destroy_device(hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001170 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171}
1172
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001173static void usbhid_disconnect(struct usb_interface *intf)
Jiri Slabyc500c972008-05-16 11:49:16 +02001174{
1175 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001176 struct usbhid_device *usbhid;
Jiri Slabyc500c972008-05-16 11:49:16 +02001177
1178 if (WARN_ON(!hid))
1179 return;
1180
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001181 usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +02001182 hid_destroy_device(hid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001183 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001184}
1185
Oliver Neukum0361a282008-12-17 15:38:03 +01001186static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
Oliver Neukum0361a282008-12-17 15:38:03 +01001188 del_timer_sync(&usbhid->io_retry);
1189 cancel_work_sync(&usbhid->restart_work);
1190 cancel_work_sync(&usbhid->reset_work);
1191}
1192
1193static void hid_cease_io(struct usbhid_device *usbhid)
1194{
1195 del_timer(&usbhid->io_retry);
1196 usb_kill_urb(usbhid->urbin);
1197 usb_kill_urb(usbhid->urbctrl);
1198 usb_kill_urb(usbhid->urbout);
Oliver Neukum0361a282008-12-17 15:38:03 +01001199}
1200
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001201/* Treat USB reset pretty much the same as suspend/resume */
1202static int hid_pre_reset(struct usb_interface *intf)
1203{
1204 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001205 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001207 spin_lock_irq(&usbhid->lock);
1208 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1209 spin_unlock_irq(&usbhid->lock);
Oliver Neukum6d779762009-03-22 18:01:49 +01001210 cancel_work_sync(&usbhid->restart_work);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001211 hid_cease_io(usbhid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001212
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001213 return 0;
1214}
1215
1216/* Same routine used for post_reset and reset_resume */
1217static int hid_post_reset(struct usb_interface *intf)
1218{
1219 struct usb_device *dev = interface_to_usbdev (intf);
1220 struct hid_device *hid = usb_get_intfdata(intf);
1221 struct usbhid_device *usbhid = hid->driver_data;
1222 int status;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001223
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001224 spin_lock_irq(&usbhid->lock);
1225 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1226 spin_unlock_irq(&usbhid->lock);
1227 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001228 status = hid_start_in(hid);
1229 if (status < 0)
1230 hid_io_error(hid);
1231 usbhid_restart_queues(usbhid);
1232
1233 return 0;
1234}
1235
1236int usbhid_get_power(struct hid_device *hid)
1237{
1238 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001239
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001240 return usb_autopm_get_interface(usbhid->intf);
1241}
1242
1243void usbhid_put_power(struct hid_device *hid)
1244{
1245 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001246
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001247 usb_autopm_put_interface(usbhid->intf);
1248}
1249
1250
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001251#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1253{
Oliver Neukum0361a282008-12-17 15:38:03 +01001254 struct hid_device *hid = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +01001256 struct usb_device *udev = interface_to_usbdev(intf);
1257 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Oliver Neukum0361a282008-12-17 15:38:03 +01001259 if (udev->auto_pm) {
1260 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1261 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1262 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1263 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1264 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1265 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
1266 && (!usbhid->ledcount || ignoreled))
1267 {
1268 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1269 spin_unlock_irq(&usbhid->lock);
1270 } else {
1271 usbhid_mark_busy(usbhid);
1272 spin_unlock_irq(&usbhid->lock);
1273 return -EBUSY;
1274 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Oliver Neukum0361a282008-12-17 15:38:03 +01001276 } else {
1277 spin_lock_irq(&usbhid->lock);
1278 set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1279 spin_unlock_irq(&usbhid->lock);
1280 if (usbhid_wait_io(hid) < 0)
1281 return -EIO;
1282 }
1283
1284 if (!ignoreled && udev->auto_pm) {
1285 spin_lock_irq(&usbhid->lock);
1286 if (test_bit(HID_LED_ON, &usbhid->iofl)) {
1287 spin_unlock_irq(&usbhid->lock);
1288 usbhid_mark_busy(usbhid);
1289 return -EBUSY;
1290 }
1291 spin_unlock_irq(&usbhid->lock);
1292 }
1293
1294 hid_cancel_delayed_stuff(usbhid);
1295 hid_cease_io(usbhid);
1296
1297 if (udev->auto_pm && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1298 /* lost race against keypresses */
1299 status = hid_start_in(hid);
1300 if (status < 0)
1301 hid_io_error(hid);
1302 usbhid_mark_busy(usbhid);
1303 return -EBUSY;
1304 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 dev_dbg(&intf->dev, "suspend\n");
1306 return 0;
1307}
1308
1309static int hid_resume(struct usb_interface *intf)
1310{
1311 struct hid_device *hid = usb_get_intfdata (intf);
1312 struct usbhid_device *usbhid = hid->driver_data;
1313 int status;
1314
Jiri Slabyfde5be32008-11-23 12:03:20 +01001315 if (!test_bit(HID_STARTED, &usbhid->iofl))
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001316 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001317
Oliver Neukum0361a282008-12-17 15:38:03 +01001318 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1319 usbhid_mark_busy(usbhid);
1320
1321 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1322 test_bit(HID_RESET_PENDING, &usbhid->iofl))
1323 schedule_work(&usbhid->reset_work);
Alan Sterndf9a1f42006-06-01 13:55:28 -04001324 usbhid->retry_delay = 0;
1325 status = hid_start_in(hid);
Oliver Neukum0361a282008-12-17 15:38:03 +01001326 if (status < 0)
1327 hid_io_error(hid);
1328 usbhid_restart_queues(usbhid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 dev_dbg(&intf->dev, "resume status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return 0;
1332}
1333
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001334static int hid_reset_resume(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335{
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001336 struct hid_device *hid = usb_get_intfdata(intf);
1337 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001339 clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1340 return hid_post_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341}
1342
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001343#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Márton Némethd67dec52010-01-10 17:59:22 +01001345static const struct usb_device_id hid_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1347 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1348 { } /* Terminating entry */
1349};
1350
1351MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1352
1353static struct usb_driver hid_driver = {
1354 .name = "usbhid",
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001355 .probe = usbhid_probe,
1356 .disconnect = usbhid_disconnect,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001357#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 .suspend = hid_suspend,
1359 .resume = hid_resume,
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001360 .reset_resume = hid_reset_resume,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001361#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 .pre_reset = hid_pre_reset,
1363 .post_reset = hid_post_reset,
1364 .id_table = hid_usb_ids,
Oliver Neukum933e3182007-07-11 14:48:58 +02001365 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366};
1367
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001368static const struct hid_device_id hid_usb_table[] = {
1369 { HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
1370 { }
1371};
1372
1373static struct hid_driver hid_usb_driver = {
1374 .name = "generic-usb",
1375 .id_table = hid_usb_table,
1376};
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378static int __init hid_init(void)
1379{
Oliver Neukum0361a282008-12-17 15:38:03 +01001380 int retval = -ENOMEM;
1381
1382 resumption_waker = create_freezeable_workqueue("usbhid_resumer");
1383 if (!resumption_waker)
1384 goto no_queue;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001385 retval = hid_register_driver(&hid_usb_driver);
1386 if (retval)
1387 goto hid_register_fail;
Paul Walmsley876b9272007-04-19 14:56:12 +02001388 retval = usbhid_quirks_init(quirks_param);
1389 if (retval)
1390 goto usbhid_quirks_init_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 retval = hiddev_init();
1392 if (retval)
1393 goto hiddev_init_fail;
1394 retval = usb_register(&hid_driver);
1395 if (retval)
1396 goto usb_register_fail;
Jiri Kosinaccabcd22009-10-02 18:31:36 +02001397 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
1399 return 0;
1400usb_register_fail:
1401 hiddev_exit();
1402hiddev_init_fail:
Paul Walmsley876b9272007-04-19 14:56:12 +02001403 usbhid_quirks_exit();
1404usbhid_quirks_init_fail:
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001405 hid_unregister_driver(&hid_usb_driver);
1406hid_register_fail:
Oliver Neukum0361a282008-12-17 15:38:03 +01001407 destroy_workqueue(resumption_waker);
1408no_queue:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 return retval;
1410}
1411
1412static void __exit hid_exit(void)
1413{
1414 usb_deregister(&hid_driver);
1415 hiddev_exit();
Paul Walmsley876b9272007-04-19 14:56:12 +02001416 usbhid_quirks_exit();
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001417 hid_unregister_driver(&hid_usb_driver);
Oliver Neukum0361a282008-12-17 15:38:03 +01001418 destroy_workqueue(resumption_waker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419}
1420
1421module_init(hid_init);
1422module_exit(hid_exit);
1423
Jiri Kosina88adb722009-10-02 18:29:34 +02001424MODULE_AUTHOR("Andreas Gal");
1425MODULE_AUTHOR("Vojtech Pavlik");
1426MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427MODULE_DESCRIPTION(DRIVER_DESC);
1428MODULE_LICENSE(DRIVER_LICENSE);