blob: 390225dbb669751bbb1a1dbf5eaad02e0226a392 [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
Michael Haboustakbf0964d2005-09-05 00:12:01 -050044#define DRIVER_VERSION "v2.6"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define DRIVER_DESC "USB HID core driver"
46#define DRIVER_LICENSE "GPL"
47
Linus Torvalds1da177e2005-04-16 15:20:36 -070048/*
49 * Module parameters.
50 */
51
52static unsigned int hid_mousepoll_interval;
53module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
54MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
55
Oliver Neukum0361a282008-12-17 15:38:03 +010056static unsigned int ignoreled;
57module_param_named(ignoreled, ignoreled, uint, 0644);
58MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
59
Paul Walmsley876b9272007-04-19 14:56:12 +020060/* Quirks specified at module load time */
61static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
62module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
63MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
64 " quirks=vendorID:productID:quirks"
65 " where vendorID, productID, and quirks are all in"
66 " 0x-prefixed hex");
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/*
Alan Sternaef4e262006-01-31 12:58:38 -050068 * Input submission and I/O error handler.
69 */
Oliver Neukum0361a282008-12-17 15:38:03 +010070static DEFINE_MUTEX(hid_open_mut);
71static struct workqueue_struct *resumption_waker;
Alan Sternaef4e262006-01-31 12:58:38 -050072
73static void hid_io_error(struct hid_device *hid);
Oliver Neukum0361a282008-12-17 15:38:03 +010074static int hid_submit_out(struct hid_device *hid);
75static int hid_submit_ctrl(struct hid_device *hid);
76static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -050077
78/* Start up the input URB */
79static int hid_start_in(struct hid_device *hid)
80{
81 unsigned long flags;
82 int rc = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +010083 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -050084
Oliver Neukum0361a282008-12-17 15:38:03 +010085 spin_lock_irqsave(&usbhid->lock, flags);
86 if (hid->open > 0 &&
Oliver Neukum69626f22008-03-31 16:27:30 +020087 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
Oliver Neukum0361a282008-12-17 15:38:03 +010088 !test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
Jiri Kosina4916b3a2006-12-08 18:41:03 +010089 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
90 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -050091 if (rc != 0)
Jiri Kosina4916b3a2006-12-08 18:41:03 +010092 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -050093 }
Oliver Neukum0361a282008-12-17 15:38:03 +010094 spin_unlock_irqrestore(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -050095 return rc;
96}
97
98/* I/O retry timer routine */
99static void hid_retry_timeout(unsigned long _hid)
100{
101 struct hid_device *hid = (struct hid_device *) _hid;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100102 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500103
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100104 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
Alan Sternaef4e262006-01-31 12:58:38 -0500105 if (hid_start_in(hid))
106 hid_io_error(hid);
107}
108
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400109/* Workqueue routine to reset the device or clear a halt */
David Howellsc4028952006-11-22 14:57:56 +0000110static void hid_reset(struct work_struct *work)
Alan Sternaef4e262006-01-31 12:58:38 -0500111{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100112 struct usbhid_device *usbhid =
113 container_of(work, struct usbhid_device, reset_work);
114 struct hid_device *hid = usbhid->hid;
Alan Stern011b15d2008-11-04 11:29:27 -0500115 int rc = 0;
Alan Sternaef4e262006-01-31 12:58:38 -0500116
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100117 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
118 dev_dbg(&usbhid->intf->dev, "clear halt\n");
Anssi Hannulabe820972007-01-19 19:28:17 +0200119 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100120 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400121 hid_start_in(hid);
Alan Sternaef4e262006-01-31 12:58:38 -0500122 }
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400123
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100124 else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
125 dev_dbg(&usbhid->intf->dev, "resetting device\n");
Alan Stern011b15d2008-11-04 11:29:27 -0500126 rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
127 if (rc == 0) {
Ming Lei742120c2008-06-18 22:00:29 +0800128 rc = usb_reset_device(hid_to_usb_dev(hid));
Alan Stern011b15d2008-11-04 11:29:27 -0500129 usb_unlock_device(hid_to_usb_dev(hid));
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400130 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100131 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400132 }
Alan Sternaef4e262006-01-31 12:58:38 -0500133
Alan Sterndf9a1f42006-06-01 13:55:28 -0400134 switch (rc) {
135 case 0:
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100136 if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500137 hid_io_error(hid);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400138 break;
139 default:
Jiri Kosina58037eb2007-05-30 15:07:13 +0200140 err_hid("can't reset device, %s-%s/input%d, status %d",
Anssi Hannulabe820972007-01-19 19:28:17 +0200141 hid_to_usb_dev(hid)->bus->bus_name,
142 hid_to_usb_dev(hid)->devpath,
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100143 usbhid->ifnum, rc);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400144 /* FALLTHROUGH */
145 case -EHOSTUNREACH:
146 case -ENODEV:
147 case -EINTR:
148 break;
149 }
Alan Sternaef4e262006-01-31 12:58:38 -0500150}
151
152/* Main I/O error handler */
153static void hid_io_error(struct hid_device *hid)
154{
155 unsigned long flags;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100156 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500157
Oliver Neukum0361a282008-12-17 15:38:03 +0100158 spin_lock_irqsave(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -0500159
160 /* Stop when disconnected */
Oliver Neukum69626f22008-03-31 16:27:30 +0200161 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500162 goto done;
163
Alan Stern5e2a55f2007-03-20 19:03:31 +0100164 /* If it has been a while since the last error, we'll assume
165 * this a brand new error and reset the retry timeout. */
166 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
167 usbhid->retry_delay = 0;
168
Alan Sternaef4e262006-01-31 12:58:38 -0500169 /* When an error occurs, retry at increasing intervals */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100170 if (usbhid->retry_delay == 0) {
171 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
172 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
173 } else if (usbhid->retry_delay < 100)
174 usbhid->retry_delay *= 2;
Alan Sternaef4e262006-01-31 12:58:38 -0500175
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100176 if (time_after(jiffies, usbhid->stop_retry)) {
Alan Sternaef4e262006-01-31 12:58:38 -0500177
178 /* Retries failed, so do a port reset */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100179 if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
180 schedule_work(&usbhid->reset_work);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400181 goto done;
Alan Sternaef4e262006-01-31 12:58:38 -0500182 }
183 }
184
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100185 mod_timer(&usbhid->io_retry,
186 jiffies + msecs_to_jiffies(usbhid->retry_delay));
Alan Sternaef4e262006-01-31 12:58:38 -0500187done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100188 spin_unlock_irqrestore(&usbhid->lock, flags);
189}
190
191static void usbhid_mark_busy(struct usbhid_device *usbhid)
192{
193 struct usb_interface *intf = usbhid->intf;
194
195 usb_mark_last_busy(interface_to_usbdev(intf));
196}
197
198static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
199{
200 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
201 int kicked;
202
203 if (!hid)
204 return 0;
205
206 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
207 dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
208 if (hid_submit_out(hid)) {
209 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
210 wake_up(&usbhid->wait);
211 }
212 }
213 return kicked;
214}
215
216static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
217{
218 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
219 int kicked;
220
221 WARN_ON(hid == NULL);
222 if (!hid)
223 return 0;
224
225 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
226 dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
227 if (hid_submit_ctrl(hid)) {
228 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
229 wake_up(&usbhid->wait);
230 }
231 }
232 return kicked;
Alan Sternaef4e262006-01-31 12:58:38 -0500233}
234
235/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 * Input interrupt completion handler.
237 */
238
David Howells7d12e782006-10-05 14:55:46 +0100239static void hid_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100242 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 int status;
244
245 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200246 case 0: /* success */
Oliver Neukum0361a282008-12-17 15:38:03 +0100247 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200248 usbhid->retry_delay = 0;
249 hid_input_report(urb->context, HID_INPUT_REPORT,
250 urb->transfer_buffer,
251 urb->actual_length, 1);
Oliver Neukum0361a282008-12-17 15:38:03 +0100252 /*
253 * autosuspend refused while keys are pressed
254 * because most keyboards don't wake up when
255 * a key is released
256 */
257 if (hid_check_keys_pressed(hid))
258 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
259 else
260 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200261 break;
262 case -EPIPE: /* stall */
Oliver Neukum0361a282008-12-17 15:38:03 +0100263 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200264 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
265 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
266 schedule_work(&usbhid->reset_work);
267 return;
268 case -ECONNRESET: /* unlink */
269 case -ENOENT:
270 case -ESHUTDOWN: /* unplug */
271 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
272 return;
273 case -EILSEQ: /* protocol error or unplug */
274 case -EPROTO: /* protocol error or unplug */
275 case -ETIME: /* protocol error or unplug */
276 case -ETIMEDOUT: /* Should never happen, but... */
Oliver Neukum0361a282008-12-17 15:38:03 +0100277 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200278 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
279 hid_io_error(hid);
280 return;
281 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200282 dev_warn(&urb->dev->dev, "input irq status %d "
283 "received\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 }
285
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800286 status = usb_submit_urb(urb, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -0500287 if (status) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100288 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -0500289 if (status != -EPERM) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200290 err_hid("can't resubmit intr, %s-%s/input%d, status %d",
Anssi Hannulabe820972007-01-19 19:28:17 +0200291 hid_to_usb_dev(hid)->bus->bus_name,
292 hid_to_usb_dev(hid)->devpath,
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100293 usbhid->ifnum, status);
Alan Sternaef4e262006-01-31 12:58:38 -0500294 hid_io_error(hid);
295 }
296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297}
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299static int hid_submit_out(struct hid_device *hid)
300{
301 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200302 char *raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100303 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200305 report = usbhid->out[usbhid->outtail].report;
306 raw_report = usbhid->out[usbhid->outtail].raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
Oliver Neukum0361a282008-12-17 15:38:03 +0100308 if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
309 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
310 usbhid->urbout->dev = hid_to_usb_dev(hid);
311 memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
312 kfree(raw_report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Oliver Neukum0361a282008-12-17 15:38:03 +0100314 dbg_hid("submitting out urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Oliver Neukum0361a282008-12-17 15:38:03 +0100316 if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
317 err_hid("usb_submit_urb(out) failed");
318 return -1;
319 }
320 } 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 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 } else {
Oliver Neukum0361a282008-12-17 15:38:03 +0100382 /*
383 * queue work to wake up the device.
384 * as the work queue is freezeable, this is safe
385 * with respect to STD and STR
386 */
387 queue_work(resumption_waker, &usbhid->restart_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 }
389
390 return 0;
391}
392
393/*
394 * Output interrupt completion handler.
395 */
396
David Howells7d12e782006-10-05 14:55:46 +0100397static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
399 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100400 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 unsigned long flags;
402 int unplug = 0;
403
404 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200405 case 0: /* success */
406 break;
407 case -ESHUTDOWN: /* unplug */
408 unplug = 1;
409 case -EILSEQ: /* protocol error or unplug */
410 case -EPROTO: /* protocol error or unplug */
411 case -ECONNRESET: /* unlink */
412 case -ENOENT:
413 break;
414 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200415 dev_warn(&urb->dev->dev, "output irq status %d "
416 "received\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 }
418
Oliver Neukum0361a282008-12-17 15:38:03 +0100419 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100422 usbhid->outtail = usbhid->outhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100424 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100426 if (usbhid->outhead != usbhid->outtail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 if (hid_submit_out(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100428 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100429 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100431 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 return;
433 }
434
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100435 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100436 spin_unlock_irqrestore(&usbhid->lock, flags);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100437 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438}
439
440/*
441 * Control pipe completion handler.
442 */
443
David Howells7d12e782006-10-05 14:55:46 +0100444static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
446 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100447 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100448 int unplug = 0, status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Oliver Neukum0361a282008-12-17 15:38:03 +0100450 spin_lock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Oliver Neukum0361a282008-12-17 15:38:03 +0100452 switch (status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200453 case 0: /* success */
454 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
455 hid_input_report(urb->context,
456 usbhid->ctrl[usbhid->ctrltail].report->type,
457 urb->transfer_buffer, urb->actual_length, 0);
458 break;
459 case -ESHUTDOWN: /* unplug */
460 unplug = 1;
461 case -EILSEQ: /* protocol error or unplug */
462 case -EPROTO: /* protocol error or unplug */
463 case -ECONNRESET: /* unlink */
464 case -ENOENT:
465 case -EPIPE: /* report not available */
466 break;
467 default: /* error */
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200468 dev_warn(&urb->dev->dev, "ctrl urb status %d "
Oliver Neukum0361a282008-12-17 15:38:03 +0100469 "received\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 }
471
472 if (unplug)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100473 usbhid->ctrltail = usbhid->ctrlhead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 else
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100475 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100477 if (usbhid->ctrlhead != usbhid->ctrltail) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 if (hid_submit_ctrl(hid)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100479 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100480 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100482 spin_unlock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 return;
484 }
485
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100486 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100487 spin_unlock(&usbhid->lock);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100488 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
H Hartley Sweeten52cfc61b2009-08-17 15:37:18 -0700491static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
492 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
494 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100495 struct usbhid_device *usbhid = hid->driver_data;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200496 int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498 if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
499 return;
500
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100501 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100502 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200503 dev_warn(&hid->dev, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 return;
505 }
506
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200507 usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
508 if (!usbhid->out[usbhid->outhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700509 dev_warn(&hid->dev, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200510 return;
511 }
512 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
513 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100514 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100516 if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 if (hid_submit_out(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100518 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 return;
520 }
521
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100522 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200523 dev_warn(&hid->dev, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 return;
525 }
526
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200527 if (dir == USB_DIR_OUT) {
528 usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
529 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Greg Kroah-Hartman46fcaec2008-10-15 11:30:07 -0700530 dev_warn(&hid->dev, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200531 return;
532 }
533 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
534 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100535 usbhid->ctrl[usbhid->ctrlhead].report = report;
536 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
537 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100539 if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 if (hid_submit_ctrl(hid))
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100541 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100542}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Oliver Neukum0361a282008-12-17 15:38:03 +0100544void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
545{
546 struct usbhid_device *usbhid = hid->driver_data;
547 unsigned long flags;
548
549 spin_lock_irqsave(&usbhid->lock, flags);
550 __usbhid_submit_report(hid, report, dir);
551 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
Jiri Slaby606bd0a2008-07-04 23:06:45 +0200553EXPORT_SYMBOL_GPL(usbhid_submit_report);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Jiri Kosina229695e2006-12-08 18:40:53 +0100555static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
Jiri Kosinadde58452006-12-08 18:40:44 +0100556{
Dmitry Torokhove0712982007-05-09 10:17:31 +0200557 struct hid_device *hid = input_get_drvdata(dev);
Oliver Neukum0361a282008-12-17 15:38:03 +0100558 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosinadde58452006-12-08 18:40:44 +0100559 struct hid_field *field;
Oliver Neukum0361a282008-12-17 15:38:03 +0100560 unsigned long flags;
Jiri Kosinadde58452006-12-08 18:40:44 +0100561 int offset;
562
563 if (type == EV_FF)
564 return input_ff_event(dev, type, code, value);
565
566 if (type != EV_LED)
567 return -1;
568
569 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200570 dev_warn(&dev->dev, "event field not found\n");
Jiri Kosinadde58452006-12-08 18:40:44 +0100571 return -1;
572 }
573
574 hid_set_field(field, offset, value);
Oliver Neukum0361a282008-12-17 15:38:03 +0100575 if (value) {
576 spin_lock_irqsave(&usbhid->lock, flags);
577 usbhid->ledcount++;
578 spin_unlock_irqrestore(&usbhid->lock, flags);
579 } else {
580 spin_lock_irqsave(&usbhid->lock, flags);
581 usbhid->ledcount--;
582 spin_unlock_irqrestore(&usbhid->lock, flags);
583 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100584 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
Jiri Kosinadde58452006-12-08 18:40:44 +0100585
586 return 0;
587}
588
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100589int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100591 struct usbhid_device *usbhid = hid->driver_data;
592
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100593 if (!wait_event_timeout(usbhid->wait,
594 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
595 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200597 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 return -1;
599 }
600
601 return 0;
602}
603
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500604static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
605{
Vojtech Pavlik71387bd2005-05-29 02:28:14 -0500606 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500607 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
608 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
609}
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
612 unsigned char type, void *buf, int size)
613{
614 int result, retries = 4;
615
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100616 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 do {
619 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
620 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
621 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
622 retries--;
623 } while (result < size && retries);
624 return result;
625}
626
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100627int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Oliver Neukum933e3182007-07-11 14:48:58 +0200629 struct usbhid_device *usbhid = hid->driver_data;
630 int res;
631
Oliver Neukum0361a282008-12-17 15:38:03 +0100632 mutex_lock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200633 if (!hid->open++) {
634 res = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100635 /* the device must be awake to reliable request remote wakeup */
Oliver Neukum933e3182007-07-11 14:48:58 +0200636 if (res < 0) {
637 hid->open--;
Oliver Neukum0361a282008-12-17 15:38:03 +0100638 mutex_unlock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200639 return -EIO;
640 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100641 usbhid->intf->needs_remote_wakeup = 1;
642 if (hid_start_in(hid))
643 hid_io_error(hid);
644
645 usb_autopm_put_interface(usbhid->intf);
Oliver Neukum933e3182007-07-11 14:48:58 +0200646 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100647 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return 0;
649}
650
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100651void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100653 struct usbhid_device *usbhid = hid->driver_data;
654
Oliver Neukum0361a282008-12-17 15:38:03 +0100655 mutex_lock(&hid_open_mut);
656
657 /* protecting hid->open to make sure we don't restart
658 * data acquistion due to a resumption we no longer
659 * care about
660 */
661 spin_lock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200662 if (!--hid->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100663 spin_unlock_irq(&usbhid->lock);
Oliver Neukum89092dd2009-04-29 17:12:12 +0200664 hid_cancel_delayed_stuff(usbhid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100665 usb_kill_urb(usbhid->urbin);
Oliver Neukum0361a282008-12-17 15:38:03 +0100666 usbhid->intf->needs_remote_wakeup = 0;
667 } else {
668 spin_unlock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200669 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100670 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
673/*
674 * Initialize all reports
675 */
676
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100677void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
679 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100680 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 int err, ret;
682
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500683 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100684 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100687 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100690 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 while (ret) {
692 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100693 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
694 usb_kill_urb(usbhid->urbctrl);
695 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
696 usb_kill_urb(usbhid->urbout);
697 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
699
700 if (err)
From: Greg Kroah-Hartman7d89fe12008-10-12 00:25:51 +0200701 dev_warn(&hid->dev, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702}
703
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500704/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200705 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
706 */
707static int hid_find_field_early(struct hid_device *hid, unsigned int page,
708 unsigned int hid_code, struct hid_field **pfield)
709{
710 struct hid_report *report;
711 struct hid_field *field;
712 struct hid_usage *usage;
713 int i, j;
714
715 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
716 for (i = 0; i < report->maxfield; i++) {
717 field = report->field[i];
718 for (j = 0; j < field->maxusage; j++) {
719 usage = &field->usage[j];
720 if ((usage->hid & HID_USAGE_PAGE) == page &&
721 (usage->hid & 0xFFFF) == hid_code) {
722 *pfield = field;
723 return j;
724 }
725 }
726 }
727 }
728 return -1;
729}
730
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200731void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200732{
733 struct hid_field *field;
734 int offset;
735
736 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
737 hid_set_field(field, offset, 0);
738 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
739 }
740}
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200741EXPORT_SYMBOL_GPL(usbhid_set_leds);
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200742
743/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500744 * Traverse the supplied list of reports and find the longest
745 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100746static void hid_find_max_report(struct hid_device *hid, unsigned int type,
747 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500748{
749 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100750 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500751
752 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200753 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500754 if (*max < size)
755 *max = size;
756 }
757}
758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
760{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100761 struct usbhid_device *usbhid = hid->driver_data;
762
Jiri Slaby898089d2008-11-24 16:20:06 +0100763 usbhid->inbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
764 &usbhid->inbuf_dma);
765 usbhid->outbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
766 &usbhid->outbuf_dma);
767 usbhid->cr = usb_buffer_alloc(dev, sizeof(*usbhid->cr), GFP_KERNEL,
768 &usbhid->cr_dma);
769 usbhid->ctrlbuf = usb_buffer_alloc(dev, usbhid->bufsize, GFP_KERNEL,
770 &usbhid->ctrlbuf_dma);
771 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
772 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 return -1;
774
775 return 0;
776}
777
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200778static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
779{
780 struct usbhid_device *usbhid = hid->driver_data;
781 struct usb_device *dev = hid_to_usb_dev(hid);
782 struct usb_interface *intf = usbhid->intf;
783 struct usb_host_interface *interface = intf->cur_altsetting;
784 int ret;
785
786 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
787 HID_REQ_SET_REPORT,
788 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Al Viro01d7b362008-04-28 07:00:05 +0100789 ((HID_OUTPUT_REPORT + 1) << 8) | *buf,
Jiri Kosinaefc493f2007-05-14 09:54:30 +0200790 interface->desc.bInterfaceNumber, buf + 1, count - 1,
791 USB_CTRL_SET_TIMEOUT);
792
793 /* count also the report id */
794 if (ret > 0)
795 ret++;
796
797 return ret;
798}
799
Oliver Neukum0361a282008-12-17 15:38:03 +0100800static void usbhid_restart_queues(struct usbhid_device *usbhid)
801{
802 if (usbhid->urbout)
803 usbhid_restart_out_queue(usbhid);
804 usbhid_restart_ctrl_queue(usbhid);
805}
806
807static void __usbhid_restart_queues(struct work_struct *work)
808{
809 struct usbhid_device *usbhid =
810 container_of(work, struct usbhid_device, restart_work);
811 int r;
812
813 r = usb_autopm_get_interface(usbhid->intf);
814 if (r < 0)
815 return;
816 usb_autopm_put_interface(usbhid->intf);
817}
818
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
820{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100821 struct usbhid_device *usbhid = hid->driver_data;
822
Dmitry Torokhov6675c5b2007-05-03 01:04:52 -0400823 usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
824 usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
825 usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
826 usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
828
Jiri Slabyc500c972008-05-16 11:49:16 +0200829static int usbhid_parse(struct hid_device *hid)
830{
831 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 struct usb_host_interface *interface = intf->cur_altsetting;
833 struct usb_device *dev = interface_to_usbdev (intf);
834 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200835 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200836 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500837 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200838 int ret, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200840 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
841 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100843 if (quirks & HID_QUIRK_IGNORE)
844 return -ENODEV;
845
Alan Stern0f28b552006-05-15 14:49:04 -0400846 /* Many keyboards and mice don't like to be polled for reports,
847 * so we will always set the HID_QUIRK_NOGET flag for them. */
848 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
849 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
850 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
851 quirks |= HID_QUIRK_NOGET;
852 }
853
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500854 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
855 (!interface->desc.bNumEndpoints ||
856 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200857 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200858 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 }
860
Jiri Slabyc500c972008-05-16 11:49:16 +0200861 hid->version = le16_to_cpu(hdesc->bcdHID);
862 hid->country = hdesc->bCountryCode;
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 for (n = 0; n < hdesc->bNumDescriptors; n++)
865 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
866 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
867
868 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200869 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +0200870 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 }
872
873 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200874 dbg_hid("couldn't allocate rdesc memory\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200875 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 }
877
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500878 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
879
Jiri Slabyc500c972008-05-16 11:49:16 +0200880 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
881 HID_DT_REPORT, rdesc, rsize);
882 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200883 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200885 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 }
887
Jiri Slabyc500c972008-05-16 11:49:16 +0200888 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +0200890 if (ret) {
891 dbg_hid("parsing report descriptor failed\n");
892 goto err;
893 }
894
Zoltan Karcagif5208992009-05-06 16:30:21 +0200895 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
Jiri Slabyc500c972008-05-16 11:49:16 +0200897 return 0;
898err:
899 return ret;
900}
901
902static int usbhid_start(struct hid_device *hid)
903{
904 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
905 struct usb_host_interface *interface = intf->cur_altsetting;
906 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +0100907 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +0200908 unsigned int n, insize = 0;
909 int ret;
910
Jiri Slabye3e14de2008-11-01 23:41:46 +0100911 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
912
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100913 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
914 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
915 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
916 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
917
918 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
919 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500920
921 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
922
923 if (insize > HID_MAX_BUFFER_SIZE)
924 insize = HID_MAX_BUFFER_SIZE;
925
Jiri Slabyc500c972008-05-16 11:49:16 +0200926 if (hid_alloc_buffers(dev, hid)) {
927 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100929 }
930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 struct usb_endpoint_descriptor *endpoint;
933 int pipe;
934 int interval;
935
936 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +0100937 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 continue;
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100942 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +0200943 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100944 dev->speed == USB_SPEED_HIGH) {
945 interval = fls(endpoint->bInterval*8);
946 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
947 hid->name, endpoint->bInterval, interval);
948 }
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /* Change the polling interval of mice. */
951 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
952 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500953
Jiri Slabyc500c972008-05-16 11:49:16 +0200954 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -0300955 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100956 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100958 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 goto fail;
960 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100961 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100963 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
964 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100966 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100968 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 goto fail;
970 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100971 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100973 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
974 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 }
976 }
977
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100978 init_waitqueue_head(&usbhid->wait);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100979 INIT_WORK(&usbhid->reset_work, hid_reset);
Oliver Neukum0361a282008-12-17 15:38:03 +0100980 INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100981 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
Alan Sternaef4e262006-01-31 12:58:38 -0500982
Oliver Neukum0361a282008-12-17 15:38:03 +0100983 spin_lock_init(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100985 usbhid->intf = intf;
986 usbhid->ifnum = interface->desc.bInterfaceNumber;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100988 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +0200989 if (!usbhid->urbctrl) {
990 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +0200992 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500993
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100994 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
995 usbhid->ctrlbuf, 1, hid_ctrl, hid);
996 usbhid->urbctrl->setup_dma = usbhid->cr_dma;
997 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
998 usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
Jiri Slabyc500c972008-05-16 11:49:16 +0200999
Jiri Slaby93c10132008-06-27 00:04:24 +02001000 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
1345static struct usb_device_id hid_usb_ids [] = {
1346 { .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;
Greg Kroah-Hartmanddbe3242008-10-12 00:14:23 +02001397 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1398 DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
1400 return 0;
1401usb_register_fail:
1402 hiddev_exit();
1403hiddev_init_fail:
Paul Walmsley876b9272007-04-19 14:56:12 +02001404 usbhid_quirks_exit();
1405usbhid_quirks_init_fail:
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001406 hid_unregister_driver(&hid_usb_driver);
1407hid_register_fail:
Oliver Neukum0361a282008-12-17 15:38:03 +01001408 destroy_workqueue(resumption_waker);
1409no_queue:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 return retval;
1411}
1412
1413static void __exit hid_exit(void)
1414{
1415 usb_deregister(&hid_driver);
1416 hiddev_exit();
Paul Walmsley876b9272007-04-19 14:56:12 +02001417 usbhid_quirks_exit();
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001418 hid_unregister_driver(&hid_usb_driver);
Oliver Neukum0361a282008-12-17 15:38:03 +01001419 destroy_workqueue(resumption_waker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420}
1421
1422module_init(hid_init);
1423module_exit(hid_exit);
1424
Jiri Kosina88adb722009-10-02 18:29:34 +02001425MODULE_AUTHOR("Andreas Gal");
1426MODULE_AUTHOR("Vojtech Pavlik");
1427MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428MODULE_DESCRIPTION(DRIVER_DESC);
1429MODULE_LICENSE(DRIVER_LICENSE);