blob: ca6849a0121e7bee62b23740f52c0a66bddde5e8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB HID support for Linux
3 *
4 * Copyright (c) 1999 Andreas Gal
Michael Haboustakbf0964d2005-09-05 00:12:01 -05005 * Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6 * Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
Oliver Neukum0361a282008-12-17 15:38:03 +01007 * Copyright (c) 2007-2008 Oliver Neukum
Jiri Kosina7d39e842010-02-02 20:46:34 +01008 * Copyright (c) 2006-2010 Jiri Kosina
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10
11/*
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 2 of the License, or (at your option)
15 * any later version.
16 */
17
18#include <linux/module.h>
19#include <linux/slab.h>
20#include <linux/init.h>
21#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/list.h>
23#include <linux/mm.h>
Jiri Slaby3d5afd32008-10-27 12:16:15 +010024#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/spinlock.h>
26#include <asm/unaligned.h>
27#include <asm/byteorder.h>
28#include <linux/input.h>
29#include <linux/wait.h>
Oliver Neukum0361a282008-12-17 15:38:03 +010030#include <linux/workqueue.h>
Simon Haggettdc3c78e2012-04-03 16:04:15 +010031#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/usb.h>
34
Jiri Kosinadde58452006-12-08 18:40:44 +010035#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/hiddev.h>
Jiri Kosinac080d892007-01-25 11:43:31 +010037#include <linux/hid-debug.h>
Jiri Kosina86166b72007-05-14 09:57:40 +020038#include <linux/hidraw.h>
Jiri Kosina4916b3a2006-12-08 18:41:03 +010039#include "usbhid.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41/*
42 * Version Information
43 */
44
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 */
Mathias Krause81ba9922014-06-05 21:20:51 +020061static char *quirks_param[MAX_USBHID_BOOT_QUIRKS];
Paul Walmsley876b9272007-04-19 14:56:12 +020062module_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);
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);
Johan Hovold0b750b32014-09-05 18:08:47 +020085 if ((hid->open > 0 || hid->quirks & HID_QUIRK_ALWAYS_POLL) &&
Oliver Neukum69626f22008-03-31 16:27:30 +020086 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
Alan Sternf2b52642012-07-19 16:08:45 -040087 !test_bit(HID_SUSPENDED, &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);
Oliver Neukuma8c52b62012-03-28 13:16:19 +020090 if (rc != 0) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +010091 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Oliver Neukuma8c52b62012-03-28 13:16:19 +020092 if (rc == -ENOSPC)
93 set_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
94 } else {
95 clear_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
96 }
Alan Sternaef4e262006-01-31 12:58:38 -050097 }
Oliver Neukum0361a282008-12-17 15:38:03 +010098 spin_unlock_irqrestore(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -050099 return rc;
100}
101
102/* I/O retry timer routine */
103static void hid_retry_timeout(unsigned long _hid)
104{
105 struct hid_device *hid = (struct hid_device *) _hid;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100106 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500107
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100108 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
Alan Sternaef4e262006-01-31 12:58:38 -0500109 if (hid_start_in(hid))
110 hid_io_error(hid);
111}
112
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400113/* Workqueue routine to reset the device or clear a halt */
David Howellsc4028952006-11-22 14:57:56 +0000114static void hid_reset(struct work_struct *work)
Alan Sternaef4e262006-01-31 12:58:38 -0500115{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100116 struct usbhid_device *usbhid =
117 container_of(work, struct usbhid_device, reset_work);
118 struct hid_device *hid = usbhid->hid;
Alan Stern8f507ef2014-09-02 11:39:15 -0400119 int rc;
Alan Sternaef4e262006-01-31 12:58:38 -0500120
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100121 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
122 dev_dbg(&usbhid->intf->dev, "clear halt\n");
Anssi Hannulabe820972007-01-19 19:28:17 +0200123 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100124 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Alan Stern011b15d2008-11-04 11:29:27 -0500125 if (rc == 0) {
Alan Stern8f507ef2014-09-02 11:39:15 -0400126 hid_start_in(hid);
127 } else {
128 dev_dbg(&usbhid->intf->dev,
129 "clear-halt failed: %d\n", rc);
130 set_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400131 }
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400132 }
Alan Sternaef4e262006-01-31 12:58:38 -0500133
Alan Stern8f507ef2014-09-02 11:39:15 -0400134 if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
135 dev_dbg(&usbhid->intf->dev, "resetting device\n");
136 usb_queue_reset_device(usbhid->intf);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400137 }
Alan Sternaef4e262006-01-31 12:58:38 -0500138}
139
140/* Main I/O error handler */
141static void hid_io_error(struct hid_device *hid)
142{
143 unsigned long flags;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100144 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500145
Oliver Neukum0361a282008-12-17 15:38:03 +0100146 spin_lock_irqsave(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -0500147
148 /* Stop when disconnected */
Oliver Neukum69626f22008-03-31 16:27:30 +0200149 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500150 goto done;
151
Alan Stern5e2a55f2007-03-20 19:03:31 +0100152 /* If it has been a while since the last error, we'll assume
153 * this a brand new error and reset the retry timeout. */
154 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
155 usbhid->retry_delay = 0;
156
Alan Sternaef4e262006-01-31 12:58:38 -0500157 /* When an error occurs, retry at increasing intervals */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100158 if (usbhid->retry_delay == 0) {
159 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
160 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
161 } else if (usbhid->retry_delay < 100)
162 usbhid->retry_delay *= 2;
Alan Sternaef4e262006-01-31 12:58:38 -0500163
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100164 if (time_after(jiffies, usbhid->stop_retry)) {
Alan Sternaef4e262006-01-31 12:58:38 -0500165
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200166 /* Retries failed, so do a port reset unless we lack bandwidth*/
167 if (test_bit(HID_NO_BANDWIDTH, &usbhid->iofl)
168 && !test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
169
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100170 schedule_work(&usbhid->reset_work);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400171 goto done;
Alan Sternaef4e262006-01-31 12:58:38 -0500172 }
173 }
174
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100175 mod_timer(&usbhid->io_retry,
176 jiffies + msecs_to_jiffies(usbhid->retry_delay));
Alan Sternaef4e262006-01-31 12:58:38 -0500177done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100178 spin_unlock_irqrestore(&usbhid->lock, flags);
179}
180
181static void usbhid_mark_busy(struct usbhid_device *usbhid)
182{
183 struct usb_interface *intf = usbhid->intf;
184
185 usb_mark_last_busy(interface_to_usbdev(intf));
186}
187
188static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
189{
190 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
191 int kicked;
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800192 int r;
Oliver Neukum0361a282008-12-17 15:38:03 +0100193
Alan Sternd4150c82012-07-19 16:08:54 -0400194 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
195 test_bit(HID_SUSPENDED, &usbhid->iofl))
Oliver Neukum0361a282008-12-17 15:38:03 +0100196 return 0;
197
198 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
Greg Kroah-Hartman6cc203d2012-05-01 21:32:55 -0700199 hid_dbg(hid, "Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800200
Alan Stern01a7c982012-07-19 16:08:31 -0400201 /* Try to wake up from autosuspend... */
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800202 r = usb_autopm_get_interface_async(usbhid->intf);
203 if (r < 0)
204 return r;
Alan Stern01a7c982012-07-19 16:08:31 -0400205
206 /*
207 * If still suspended, don't submit. Submission will
208 * occur if/when resume drains the queue.
209 */
Alan Sternf2b52642012-07-19 16:08:45 -0400210 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
Alan Stern01a7c982012-07-19 16:08:31 -0400211 usb_autopm_put_interface_no_suspend(usbhid->intf);
212 return r;
213 }
214
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800215 /* Asynchronously flush queue. */
216 set_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100217 if (hid_submit_out(hid)) {
218 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800219 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100220 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800221 wake_up(&usbhid->wait);
Oliver Neukum0361a282008-12-17 15:38:03 +0100222 }
223 return kicked;
224}
225
226static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
227{
228 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
229 int kicked;
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800230 int r;
Oliver Neukum0361a282008-12-17 15:38:03 +0100231
232 WARN_ON(hid == NULL);
Alan Sternd4150c82012-07-19 16:08:54 -0400233 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
234 test_bit(HID_SUSPENDED, &usbhid->iofl))
Oliver Neukum0361a282008-12-17 15:38:03 +0100235 return 0;
236
237 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
Greg Kroah-Hartman6cc203d2012-05-01 21:32:55 -0700238 hid_dbg(hid, "Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800239
Alan Stern01a7c982012-07-19 16:08:31 -0400240 /* Try to wake up from autosuspend... */
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800241 r = usb_autopm_get_interface_async(usbhid->intf);
242 if (r < 0)
243 return r;
Alan Stern01a7c982012-07-19 16:08:31 -0400244
245 /*
246 * If still suspended, don't submit. Submission will
247 * occur if/when resume drains the queue.
248 */
Alan Sternf2b52642012-07-19 16:08:45 -0400249 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
Alan Stern01a7c982012-07-19 16:08:31 -0400250 usb_autopm_put_interface_no_suspend(usbhid->intf);
251 return r;
252 }
253
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800254 /* Asynchronously flush queue. */
255 set_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100256 if (hid_submit_ctrl(hid)) {
257 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800258 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100259 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800260 wake_up(&usbhid->wait);
Oliver Neukum0361a282008-12-17 15:38:03 +0100261 }
262 return kicked;
Alan Sternaef4e262006-01-31 12:58:38 -0500263}
264
265/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 * Input interrupt completion handler.
267 */
268
David Howells7d12e782006-10-05 14:55:46 +0100269static void hid_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
271 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100272 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 int status;
274
275 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200276 case 0: /* success */
Oliver Neukum0361a282008-12-17 15:38:03 +0100277 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200278 usbhid->retry_delay = 0;
Johan Hovold0b750b32014-09-05 18:08:47 +0200279 if ((hid->quirks & HID_QUIRK_ALWAYS_POLL) && !hid->open)
280 break;
Jiri Slaby880d29f2008-06-18 23:55:41 +0200281 hid_input_report(urb->context, HID_INPUT_REPORT,
282 urb->transfer_buffer,
283 urb->actual_length, 1);
Oliver Neukum0361a282008-12-17 15:38:03 +0100284 /*
285 * autosuspend refused while keys are pressed
286 * because most keyboards don't wake up when
287 * a key is released
288 */
289 if (hid_check_keys_pressed(hid))
290 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
291 else
292 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200293 break;
294 case -EPIPE: /* stall */
Oliver Neukum0361a282008-12-17 15:38:03 +0100295 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200296 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
297 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
298 schedule_work(&usbhid->reset_work);
299 return;
300 case -ECONNRESET: /* unlink */
301 case -ENOENT:
302 case -ESHUTDOWN: /* unplug */
303 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
304 return;
305 case -EILSEQ: /* protocol error or unplug */
306 case -EPROTO: /* protocol error or unplug */
307 case -ETIME: /* protocol error or unplug */
308 case -ETIMEDOUT: /* Should never happen, but... */
Oliver Neukum0361a282008-12-17 15:38:03 +0100309 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200310 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
311 hid_io_error(hid);
312 return;
313 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800314 hid_warn(urb->dev, "input irq status %d received\n",
315 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 }
317
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800318 status = usb_submit_urb(urb, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -0500319 if (status) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100320 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -0500321 if (status != -EPERM) {
Joe Perches4291ee32010-12-09 19:29:03 -0800322 hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n",
323 hid_to_usb_dev(hid)->bus->bus_name,
324 hid_to_usb_dev(hid)->devpath,
325 usbhid->ifnum, status);
Alan Sternaef4e262006-01-31 12:58:38 -0500326 hid_io_error(hid);
327 }
328 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329}
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331static int hid_submit_out(struct hid_device *hid)
332{
333 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200334 char *raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100335 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum68229682010-12-22 15:33:40 +0100336 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200338 report = usbhid->out[usbhid->outtail].report;
339 raw_report = usbhid->out[usbhid->outtail].raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800341 usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) +
342 1 + (report->id > 0);
343 usbhid->urbout->dev = hid_to_usb_dev(hid);
Alan Stern668160e2012-07-19 16:08:21 -0400344 if (raw_report) {
345 memcpy(usbhid->outbuf, raw_report,
346 usbhid->urbout->transfer_buffer_length);
347 kfree(raw_report);
348 usbhid->out[usbhid->outtail].raw_report = NULL;
349 }
Oliver Neukum68229682010-12-22 15:33:40 +0100350
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800351 dbg_hid("submitting out urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800353 r = usb_submit_urb(usbhid->urbout, GFP_ATOMIC);
354 if (r < 0) {
355 hid_err(hid, "usb_submit_urb(out) failed: %d\n", r);
356 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800358 usbhid->last_out = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 return 0;
360}
361
362static int hid_submit_ctrl(struct hid_device *hid)
363{
364 struct hid_report *report;
365 unsigned char dir;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200366 char *raw_report;
Oliver Neukum68229682010-12-22 15:33:40 +0100367 int len, r;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100368 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100370 report = usbhid->ctrl[usbhid->ctrltail].report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200371 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100372 dir = usbhid->ctrl[usbhid->ctrltail].dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800374 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
375 if (dir == USB_DIR_OUT) {
376 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
377 usbhid->urbctrl->transfer_buffer_length = len;
Alan Stern668160e2012-07-19 16:08:21 -0400378 if (raw_report) {
379 memcpy(usbhid->ctrlbuf, raw_report, len);
380 kfree(raw_report);
381 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
382 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800383 } else {
384 int maxpacket, padlen;
Oliver Neukum0361a282008-12-17 15:38:03 +0100385
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800386 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
387 maxpacket = usb_maxpacket(hid_to_usb_dev(hid),
388 usbhid->urbctrl->pipe, 0);
389 if (maxpacket > 0) {
390 padlen = DIV_ROUND_UP(len, maxpacket);
391 padlen *= maxpacket;
392 if (padlen > usbhid->bufsize)
393 padlen = usbhid->bufsize;
394 } else
395 padlen = 0;
396 usbhid->urbctrl->transfer_buffer_length = padlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800398 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800400 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
401 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT :
402 HID_REQ_GET_REPORT;
403 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) |
404 report->id);
405 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
406 usbhid->cr->wLength = cpu_to_le16(len);
407
408 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
409 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" :
410 "Get_Report",
411 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
412
413 r = usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC);
414 if (r < 0) {
415 hid_err(hid, "usb_submit_urb(ctrl) failed: %d\n", r);
416 return r;
417 }
418 usbhid->last_ctrl = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 return 0;
420}
421
422/*
423 * Output interrupt completion handler.
424 */
425
David Howells7d12e782006-10-05 14:55:46 +0100426static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427{
428 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100429 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 unsigned long flags;
431 int unplug = 0;
432
433 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200434 case 0: /* success */
435 break;
436 case -ESHUTDOWN: /* unplug */
437 unplug = 1;
438 case -EILSEQ: /* protocol error or unplug */
439 case -EPROTO: /* protocol error or unplug */
440 case -ECONNRESET: /* unlink */
441 case -ENOENT:
442 break;
443 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800444 hid_warn(urb->dev, "output irq status %d received\n",
445 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 }
447
Oliver Neukum0361a282008-12-17 15:38:03 +0100448 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Alan Stern93101af2012-07-19 16:08:39 -0400450 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100451 usbhid->outtail = usbhid->outhead;
Alan Stern93101af2012-07-19 16:08:39 -0400452 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100453 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Alan Stern93101af2012-07-19 16:08:39 -0400455 if (usbhid->outhead != usbhid->outtail &&
456 hid_submit_out(hid) == 0) {
457 /* Successfully submitted next urb in queue */
458 spin_unlock_irqrestore(&usbhid->lock, flags);
459 return;
460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 }
462
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100463 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100464 spin_unlock_irqrestore(&usbhid->lock, flags);
Oliver Neukum68229682010-12-22 15:33:40 +0100465 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100466 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467}
468
469/*
470 * Control pipe completion handler.
471 */
472
David Howells7d12e782006-10-05 14:55:46 +0100473static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474{
475 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100476 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100477 int unplug = 0, status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Oliver Neukum0361a282008-12-17 15:38:03 +0100479 spin_lock(&usbhid->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Oliver Neukum0361a282008-12-17 15:38:03 +0100481 switch (status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200482 case 0: /* success */
483 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
484 hid_input_report(urb->context,
485 usbhid->ctrl[usbhid->ctrltail].report->type,
486 urb->transfer_buffer, urb->actual_length, 0);
487 break;
488 case -ESHUTDOWN: /* unplug */
489 unplug = 1;
490 case -EILSEQ: /* protocol error or unplug */
491 case -EPROTO: /* protocol error or unplug */
492 case -ECONNRESET: /* unlink */
493 case -ENOENT:
494 case -EPIPE: /* report not available */
495 break;
496 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800497 hid_warn(urb->dev, "ctrl urb status %d received\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 }
499
Alan Stern93101af2012-07-19 16:08:39 -0400500 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100501 usbhid->ctrltail = usbhid->ctrlhead;
Alan Stern93101af2012-07-19 16:08:39 -0400502 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100503 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Alan Stern93101af2012-07-19 16:08:39 -0400505 if (usbhid->ctrlhead != usbhid->ctrltail &&
506 hid_submit_ctrl(hid) == 0) {
507 /* Successfully submitted next urb in queue */
508 spin_unlock(&usbhid->lock);
509 return;
510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 }
512
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100513 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100514 spin_unlock(&usbhid->lock);
Oliver Neukum68229682010-12-22 15:33:40 +0100515 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100516 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517}
518
H Hartley Sweeten52cfc612009-08-17 15:37:18 -0700519static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
520 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100523 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Reyad Attiyat46df9de2014-07-25 00:13:01 -0500525 if (((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN) ||
526 test_bit(HID_DISCONNECTED, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 return;
528
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100529 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100530 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800531 hid_warn(hid, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 return;
533 }
534
Jiri Kosina27ce4052013-07-10 19:56:27 +0200535 usbhid->out[usbhid->outhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200536 if (!usbhid->out[usbhid->outhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800537 hid_warn(hid, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200538 return;
539 }
540 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
541 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100542 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Alan Stern01a7c982012-07-19 16:08:31 -0400544 /* If the queue isn't running, restart it */
545 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
546 usbhid_restart_out_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800547
Alan Stern01a7c982012-07-19 16:08:31 -0400548 /* Otherwise see if an earlier request has timed out */
549 } else if (time_after(jiffies, usbhid->last_out + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800550
Alan Stern01a7c982012-07-19 16:08:31 -0400551 /* Prevent autosuspend following the unlink */
552 usb_autopm_get_interface_no_resume(usbhid->intf);
553
Oliver Neukum858155f2010-02-12 13:02:28 +0100554 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400555 * Prevent resubmission in case the URB completes
556 * before we can unlink it. We don't want to cancel
557 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100558 */
Alan Stern01a7c982012-07-19 16:08:31 -0400559 usb_block_urb(usbhid->urbout);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200560
Alan Stern01a7c982012-07-19 16:08:31 -0400561 /* Drop lock to avoid deadlock if the callback runs */
562 spin_unlock(&usbhid->lock);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200563
Alan Stern01a7c982012-07-19 16:08:31 -0400564 usb_unlink_urb(usbhid->urbout);
565 spin_lock(&usbhid->lock);
566 usb_unblock_urb(usbhid->urbout);
567
568 /* Unlink might have stopped the queue */
569 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl))
570 usbhid_restart_out_queue(usbhid);
571
572 /* Now we can allow autosuspend again */
573 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return;
576 }
577
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100578 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800579 hid_warn(hid, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return;
581 }
582
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200583 if (dir == USB_DIR_OUT) {
Jiri Kosina27ce4052013-07-10 19:56:27 +0200584 usbhid->ctrl[usbhid->ctrlhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200585 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800586 hid_warn(hid, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200587 return;
588 }
589 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
590 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100591 usbhid->ctrl[usbhid->ctrlhead].report = report;
592 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
593 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Alan Stern01a7c982012-07-19 16:08:31 -0400595 /* If the queue isn't running, restart it */
596 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
597 usbhid_restart_ctrl_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800598
Alan Stern01a7c982012-07-19 16:08:31 -0400599 /* Otherwise see if an earlier request has timed out */
600 } else if (time_after(jiffies, usbhid->last_ctrl + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800601
Alan Stern01a7c982012-07-19 16:08:31 -0400602 /* Prevent autosuspend following the unlink */
603 usb_autopm_get_interface_no_resume(usbhid->intf);
604
Oliver Neukum858155f2010-02-12 13:02:28 +0100605 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400606 * Prevent resubmission in case the URB completes
607 * before we can unlink it. We don't want to cancel
608 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100609 */
Alan Stern01a7c982012-07-19 16:08:31 -0400610 usb_block_urb(usbhid->urbctrl);
611
612 /* Drop lock to avoid deadlock if the callback runs */
613 spin_unlock(&usbhid->lock);
614
615 usb_unlink_urb(usbhid->urbctrl);
616 spin_lock(&usbhid->lock);
617 usb_unblock_urb(usbhid->urbctrl);
618
619 /* Unlink might have stopped the queue */
620 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
621 usbhid_restart_ctrl_queue(usbhid);
622
623 /* Now we can allow autosuspend again */
624 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100625 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100626}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100628static void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
Oliver Neukum0361a282008-12-17 15:38:03 +0100629{
630 struct usbhid_device *usbhid = hid->driver_data;
631 unsigned long flags;
632
633 spin_lock_irqsave(&usbhid->lock, flags);
634 __usbhid_submit_report(hid, report, dir);
635 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
637
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100638static int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100640 struct usbhid_device *usbhid = hid->driver_data;
641
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100642 if (!wait_event_timeout(usbhid->wait,
643 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
644 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200646 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return -1;
648 }
649
650 return 0;
651}
652
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500653static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
654{
Vojtech Pavlik71387bd72005-05-29 02:28:14 -0500655 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500656 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
657 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
658}
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
661 unsigned char type, void *buf, int size)
662{
663 int result, retries = 4;
664
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100665 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
667 do {
668 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
669 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
670 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
671 retries--;
672 } while (result < size && retries);
673 return result;
674}
675
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100676int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
Oliver Neukum933e3182007-07-11 14:48:58 +0200678 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200679 int res = 0;
Oliver Neukum933e3182007-07-11 14:48:58 +0200680
Oliver Neukum0361a282008-12-17 15:38:03 +0100681 mutex_lock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200682 if (!hid->open++) {
683 res = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum68229682010-12-22 15:33:40 +0100684 /* the device must be awake to reliably request remote wakeup */
Oliver Neukum933e3182007-07-11 14:48:58 +0200685 if (res < 0) {
686 hid->open--;
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200687 res = -EIO;
688 goto done;
Oliver Neukum933e3182007-07-11 14:48:58 +0200689 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100690 usbhid->intf->needs_remote_wakeup = 1;
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200691 res = hid_start_in(hid);
692 if (res) {
693 if (res != -ENOSPC) {
694 hid_io_error(hid);
695 res = 0;
696 } else {
697 /* no use opening if resources are insufficient */
698 hid->open--;
699 res = -EBUSY;
700 usbhid->intf->needs_remote_wakeup = 0;
701 }
702 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100703 usb_autopm_put_interface(usbhid->intf);
Oliver Neukum933e3182007-07-11 14:48:58 +0200704 }
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200705done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100706 mutex_unlock(&hid_open_mut);
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200707 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
709
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100710void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100712 struct usbhid_device *usbhid = hid->driver_data;
713
Oliver Neukum0361a282008-12-17 15:38:03 +0100714 mutex_lock(&hid_open_mut);
715
716 /* protecting hid->open to make sure we don't restart
717 * data acquistion due to a resumption we no longer
718 * care about
719 */
720 spin_lock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200721 if (!--hid->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100722 spin_unlock_irq(&usbhid->lock);
Oliver Neukum89092dd2009-04-29 17:12:12 +0200723 hid_cancel_delayed_stuff(usbhid);
Johan Hovold0b750b32014-09-05 18:08:47 +0200724 if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL)) {
725 usb_kill_urb(usbhid->urbin);
726 usbhid->intf->needs_remote_wakeup = 0;
727 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100728 } else {
729 spin_unlock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200730 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100731 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
734/*
735 * Initialize all reports
736 */
737
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100738void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
740 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100741 struct usbhid_device *usbhid = hid->driver_data;
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200742 struct hid_report_enum *report_enum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 int err, ret;
744
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200745 if (!(hid->quirks & HID_QUIRK_NO_INIT_INPUT_REPORTS)) {
746 report_enum = &hid->report_enum[HID_INPUT_REPORT];
747 list_for_each_entry(report, &report_enum->report_list, list)
748 usbhid_submit_report(hid, report, USB_DIR_IN);
749 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200751 report_enum = &hid->report_enum[HID_FEATURE_REPORT];
752 list_for_each_entry(report, &report_enum->report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100753 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100756 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 while (ret) {
758 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100759 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
760 usb_kill_urb(usbhid->urbctrl);
761 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
762 usb_kill_urb(usbhid->urbout);
763 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 }
765
766 if (err)
Joe Perches4291ee32010-12-09 19:29:03 -0800767 hid_warn(hid, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768}
769
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500770/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200771 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
772 */
773static int hid_find_field_early(struct hid_device *hid, unsigned int page,
774 unsigned int hid_code, struct hid_field **pfield)
775{
776 struct hid_report *report;
777 struct hid_field *field;
778 struct hid_usage *usage;
779 int i, j;
780
781 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
782 for (i = 0; i < report->maxfield; i++) {
783 field = report->field[i];
784 for (j = 0; j < field->maxusage; j++) {
785 usage = &field->usage[j];
786 if ((usage->hid & HID_USAGE_PAGE) == page &&
787 (usage->hid & 0xFFFF) == hid_code) {
788 *pfield = field;
789 return j;
790 }
791 }
792 }
793 }
794 return -1;
795}
796
David Herrmannddf64a32013-07-15 19:10:10 +0200797static void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200798{
799 struct hid_field *field;
800 int offset;
801
802 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
803 hid_set_field(field, offset, 0);
804 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
805 }
806}
807
808/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500809 * Traverse the supplied list of reports and find the longest
810 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100811static void hid_find_max_report(struct hid_device *hid, unsigned int type,
812 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500813{
814 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100815 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500816
817 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200818 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500819 if (*max < size)
820 *max = size;
821 }
822}
823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
825{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100826 struct usbhid_device *usbhid = hid->driver_data;
827
Daniel Mack997ea582010-04-12 13:17:25 +0200828 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100829 &usbhid->inbuf_dma);
Daniel Mack997ea582010-04-12 13:17:25 +0200830 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100831 &usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500832 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
Daniel Mack997ea582010-04-12 13:17:25 +0200833 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100834 &usbhid->ctrlbuf_dma);
835 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
836 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 return -1;
838
839 return 0;
840}
841
Alan Ottb4dbde92011-01-18 03:04:39 -0500842static int usbhid_get_raw_report(struct hid_device *hid,
843 unsigned char report_number, __u8 *buf, size_t count,
844 unsigned char report_type)
845{
846 struct usbhid_device *usbhid = hid->driver_data;
847 struct usb_device *dev = hid_to_usb_dev(hid);
848 struct usb_interface *intf = usbhid->intf;
849 struct usb_host_interface *interface = intf->cur_altsetting;
850 int skipped_report_id = 0;
851 int ret;
852
853 /* Byte 0 is the report number. Report data starts at byte 1.*/
854 buf[0] = report_number;
855 if (report_number == 0x0) {
856 /* Offset the return buffer by 1, so that the report ID
857 will remain in byte 0. */
858 buf++;
859 count--;
860 skipped_report_id = 1;
861 }
862 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
863 HID_REQ_GET_REPORT,
864 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
865 ((report_type + 1) << 8) | report_number,
866 interface->desc.bInterfaceNumber, buf, count,
867 USB_CTRL_SET_TIMEOUT);
868
869 /* count also the report id */
870 if (ret > 0 && skipped_report_id)
871 ret++;
872
873 return ret;
874}
875
Frank Praznik975a6832014-01-22 13:49:42 -0500876static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum,
877 __u8 *buf, size_t count, unsigned char rtype)
878{
879 struct usbhid_device *usbhid = hid->driver_data;
880 struct usb_device *dev = hid_to_usb_dev(hid);
881 struct usb_interface *intf = usbhid->intf;
882 struct usb_host_interface *interface = intf->cur_altsetting;
883 int ret, skipped_report_id = 0;
884
885 /* Byte 0 is the report number. Report data starts at byte 1.*/
Benjamin Tissoirese534a932014-03-08 22:52:42 -0500886 if ((rtype == HID_OUTPUT_REPORT) &&
887 (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID))
888 buf[0] = 0;
889 else
890 buf[0] = reportnum;
891
Frank Praznik975a6832014-01-22 13:49:42 -0500892 if (buf[0] == 0x0) {
893 /* Don't send the Report ID */
894 buf++;
895 count--;
896 skipped_report_id = 1;
897 }
898
899 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
900 HID_REQ_SET_REPORT,
901 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
902 ((rtype + 1) << 8) | reportnum,
903 interface->desc.bInterfaceNumber, buf, count,
904 USB_CTRL_SET_TIMEOUT);
905 /* count also the report id, if this was a numbered report. */
906 if (ret > 0 && skipped_report_id)
907 ret++;
908
909 return ret;
910}
911
Frank Praznik975a6832014-01-22 13:49:42 -0500912static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count)
913{
914 struct usbhid_device *usbhid = hid->driver_data;
915 struct usb_device *dev = hid_to_usb_dev(hid);
916 int actual_length, skipped_report_id = 0, ret;
917
918 if (!usbhid->urbout)
Benjamin Tissoiresddea1af2014-02-10 12:58:51 -0500919 return -ENOSYS;
Frank Praznik975a6832014-01-22 13:49:42 -0500920
921 if (buf[0] == 0x0) {
922 /* Don't send the Report ID */
923 buf++;
924 count--;
925 skipped_report_id = 1;
926 }
927
928 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
929 buf, count, &actual_length,
930 USB_CTRL_SET_TIMEOUT);
931 /* return the number of bytes transferred */
932 if (ret == 0) {
933 ret = actual_length;
934 /* count also the report id */
935 if (skipped_report_id)
936 ret++;
937 }
938
939 return ret;
940}
941
Oliver Neukum0361a282008-12-17 15:38:03 +0100942static void usbhid_restart_queues(struct usbhid_device *usbhid)
943{
Alan Sterneb055fd2012-07-19 16:09:01 -0400944 if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl))
Oliver Neukum0361a282008-12-17 15:38:03 +0100945 usbhid_restart_out_queue(usbhid);
Alan Sterneb055fd2012-07-19 16:09:01 -0400946 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
947 usbhid_restart_ctrl_queue(usbhid);
Oliver Neukum0361a282008-12-17 15:38:03 +0100948}
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
951{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100952 struct usbhid_device *usbhid = hid->driver_data;
953
Daniel Mack997ea582010-04-12 13:17:25 +0200954 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
955 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500956 kfree(usbhid->cr);
Daniel Mack997ea582010-04-12 13:17:25 +0200957 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958}
959
Jiri Slabyc500c972008-05-16 11:49:16 +0200960static int usbhid_parse(struct hid_device *hid)
961{
962 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 struct usb_host_interface *interface = intf->cur_altsetting;
964 struct usb_device *dev = interface_to_usbdev (intf);
965 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200966 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200967 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500968 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200969 int ret, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200971 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
972 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100974 if (quirks & HID_QUIRK_IGNORE)
975 return -ENODEV;
976
Alan Stern0f28b552006-05-15 14:49:04 -0400977 /* Many keyboards and mice don't like to be polled for reports,
978 * so we will always set the HID_QUIRK_NOGET flag for them. */
979 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
980 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
981 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
982 quirks |= HID_QUIRK_NOGET;
983 }
984
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500985 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
986 (!interface->desc.bNumEndpoints ||
987 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200988 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200989 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 }
991
Jiri Slabyc500c972008-05-16 11:49:16 +0200992 hid->version = le16_to_cpu(hdesc->bcdHID);
993 hid->country = hdesc->bCountryCode;
994
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 for (n = 0; n < hdesc->bNumDescriptors; n++)
996 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
997 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
998
999 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001000 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +02001001 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 }
1003
1004 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001005 dbg_hid("couldn't allocate rdesc memory\n");
Jiri Slabyc500c972008-05-16 11:49:16 +02001006 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 }
1008
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001009 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1010
Jiri Slabyc500c972008-05-16 11:49:16 +02001011 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
1012 HID_DT_REPORT, rdesc, rsize);
1013 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001014 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001016 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 }
1018
Jiri Slabyc500c972008-05-16 11:49:16 +02001019 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001021 if (ret) {
1022 dbg_hid("parsing report descriptor failed\n");
1023 goto err;
1024 }
1025
Zoltan Karcagif5208992009-05-06 16:30:21 +02001026 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Jiri Slabyc500c972008-05-16 11:49:16 +02001028 return 0;
1029err:
1030 return ret;
1031}
1032
1033static int usbhid_start(struct hid_device *hid)
1034{
1035 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1036 struct usb_host_interface *interface = intf->cur_altsetting;
1037 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001038 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +02001039 unsigned int n, insize = 0;
1040 int ret;
1041
Jiri Slabye3e14de2008-11-01 23:41:46 +01001042 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
1043
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001044 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
1045 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
1046 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
1047 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
1048
1049 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
1050 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001051
1052 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1053
1054 if (insize > HID_MAX_BUFFER_SIZE)
1055 insize = HID_MAX_BUFFER_SIZE;
1056
Jiri Slabyc500c972008-05-16 11:49:16 +02001057 if (hid_alloc_buffers(dev, hid)) {
1058 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001060 }
1061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 struct usb_endpoint_descriptor *endpoint;
1064 int pipe;
1065 int interval;
1066
1067 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +01001068 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 continue;
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001073 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +02001074 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001075 dev->speed == USB_SPEED_HIGH) {
1076 interval = fls(endpoint->bInterval*8);
1077 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1078 hid->name, endpoint->bInterval, interval);
1079 }
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 /* Change the polling interval of mice. */
1082 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1083 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05001084
Jiri Slabyc500c972008-05-16 11:49:16 +02001085 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -03001086 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001087 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001089 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 goto fail;
1091 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001092 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001094 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1095 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001097 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001099 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 goto fail;
1101 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001102 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001104 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1105 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 }
1107 }
1108
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001109 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +02001110 if (!usbhid->urbctrl) {
1111 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +02001113 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001114
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001115 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1116 usbhid->ctrlbuf, 1, hid_ctrl, hid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001117 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
Alan Stern0ede76f2010-03-05 15:10:17 -05001118 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Jiri Slabyc500c972008-05-16 11:49:16 +02001119
Jiri Kosina5b915d92009-11-05 14:08:03 +01001120 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1121 usbhid_init_reports(hid);
Jiri Slaby93c10132008-06-27 00:04:24 +02001122
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001123 set_bit(HID_STARTED, &usbhid->iofl);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001124
Johan Hovold0b750b32014-09-05 18:08:47 +02001125 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1126 ret = usb_autopm_get_interface(usbhid->intf);
1127 if (ret)
1128 goto fail;
1129 usbhid->intf->needs_remote_wakeup = 1;
1130 ret = hid_start_in(hid);
1131 if (ret) {
1132 dev_err(&hid->dev,
1133 "failed to start in urb: %d\n", ret);
1134 }
1135 usb_autopm_put_interface(usbhid->intf);
1136 }
1137
Alan Stern08ef08e2008-10-30 23:58:51 +01001138 /* Some keyboards don't work until their LEDs have been set.
1139 * Since BIOSes do set the LEDs, it must be safe for any device
1140 * that supports the keyboard boot protocol.
Alan Stern3d615102010-04-02 13:21:58 -04001141 * In addition, enable remote wakeup by default for all keyboard
1142 * devices supporting the boot protocol.
Alan Stern08ef08e2008-10-30 23:58:51 +01001143 */
1144 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1145 interface->desc.bInterfaceProtocol ==
Alan Stern3d615102010-04-02 13:21:58 -04001146 USB_INTERFACE_PROTOCOL_KEYBOARD) {
Alan Stern08ef08e2008-10-30 23:58:51 +01001147 usbhid_set_leds(hid);
Alan Stern3d615102010-04-02 13:21:58 -04001148 device_set_wakeup_enable(&dev->dev, 1);
1149 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001150 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
1152fail:
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001153 usb_free_urb(usbhid->urbin);
1154 usb_free_urb(usbhid->urbout);
1155 usb_free_urb(usbhid->urbctrl);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001156 usbhid->urbin = NULL;
1157 usbhid->urbout = NULL;
1158 usbhid->urbctrl = NULL;
Jiri Kosina22f675f2007-08-01 12:32:27 +02001159 hid_free_buffers(dev, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001160 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161}
1162
Jiri Slabyc500c972008-05-16 11:49:16 +02001163static void usbhid_stop(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164{
Jiri Slabyc500c972008-05-16 11:49:16 +02001165 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Jiri Slabyc500c972008-05-16 11:49:16 +02001167 if (WARN_ON(!usbhid))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 return;
1169
Johan Hovold0b750b32014-09-05 18:08:47 +02001170 if (hid->quirks & HID_QUIRK_ALWAYS_POLL)
1171 usbhid->intf->needs_remote_wakeup = 0;
1172
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001173 clear_bit(HID_STARTED, &usbhid->iofl);
Daniel Kurtz4371ea82011-11-17 19:23:50 +08001174 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
Oliver Neukum69626f22008-03-31 16:27:30 +02001175 set_bit(HID_DISCONNECTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001176 spin_unlock_irq(&usbhid->lock);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001177 usb_kill_urb(usbhid->urbin);
1178 usb_kill_urb(usbhid->urbout);
1179 usb_kill_urb(usbhid->urbctrl);
1180
Oliver Neukum0361a282008-12-17 15:38:03 +01001181 hid_cancel_delayed_stuff(usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -05001182
Jiri Slabyc500c972008-05-16 11:49:16 +02001183 hid->claimed = 0;
1184
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001185 usb_free_urb(usbhid->urbin);
1186 usb_free_urb(usbhid->urbctrl);
1187 usb_free_urb(usbhid->urbout);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001188 usbhid->urbin = NULL; /* don't mess up next start */
1189 usbhid->urbctrl = NULL;
1190 usbhid->urbout = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
Anssi Hannulabe820972007-01-19 19:28:17 +02001192 hid_free_buffers(hid_to_usb_dev(hid), hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193}
1194
Oliver Neukum0361a282008-12-17 15:38:03 +01001195static int usbhid_power(struct hid_device *hid, int lvl)
1196{
1197 int r = 0;
1198
1199 switch (lvl) {
1200 case PM_HINT_FULLON:
1201 r = usbhid_get_power(hid);
1202 break;
1203 case PM_HINT_NORMAL:
1204 usbhid_put_power(hid);
1205 break;
1206 }
1207 return r;
1208}
1209
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001210static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype)
1211{
1212 switch (reqtype) {
1213 case HID_REQ_GET_REPORT:
1214 usbhid_submit_report(hid, rep, USB_DIR_IN);
1215 break;
1216 case HID_REQ_SET_REPORT:
1217 usbhid_submit_report(hid, rep, USB_DIR_OUT);
1218 break;
1219 }
1220}
1221
Frank Praznik975a6832014-01-22 13:49:42 -05001222static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum,
1223 __u8 *buf, size_t len, unsigned char rtype,
1224 int reqtype)
1225{
1226 switch (reqtype) {
1227 case HID_REQ_GET_REPORT:
1228 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype);
1229 case HID_REQ_SET_REPORT:
1230 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype);
1231 default:
1232 return -EIO;
1233 }
1234}
1235
Benjamin Tissoires96848192013-02-27 16:38:17 +01001236static int usbhid_idle(struct hid_device *hid, int report, int idle,
1237 int reqtype)
1238{
1239 struct usb_device *dev = hid_to_usb_dev(hid);
1240 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1241 struct usb_host_interface *interface = intf->cur_altsetting;
1242 int ifnum = interface->desc.bInterfaceNumber;
1243
1244 if (reqtype != HID_REQ_SET_IDLE)
1245 return -EINVAL;
1246
1247 return hid_set_idle(dev, ifnum, report, idle);
1248}
1249
Jiri Slabyc500c972008-05-16 11:49:16 +02001250static struct hid_ll_driver usb_hid_driver = {
1251 .parse = usbhid_parse,
1252 .start = usbhid_start,
1253 .stop = usbhid_stop,
1254 .open = usbhid_open,
1255 .close = usbhid_close,
Oliver Neukum0361a282008-12-17 15:38:03 +01001256 .power = usbhid_power,
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001257 .request = usbhid_request,
Henrik Rydberg33734432013-02-25 11:31:44 +01001258 .wait = usbhid_wait_io,
Frank Praznik975a6832014-01-22 13:49:42 -05001259 .raw_request = usbhid_raw_request,
1260 .output_report = usbhid_output_report,
Benjamin Tissoires96848192013-02-27 16:38:17 +01001261 .idle = usbhid_idle,
Jiri Slabyc500c972008-05-16 11:49:16 +02001262};
1263
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001264static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001266 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Slabyc500c972008-05-16 11:49:16 +02001267 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001268 struct usbhid_device *usbhid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 struct hid_device *hid;
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001270 unsigned int n, has_in = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +02001271 size_t len;
1272 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Jiri Kosina58037eb2007-05-30 15:07:13 +02001274 dbg_hid("HID probe called for ifnum %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 intf->altsetting->desc.bInterfaceNumber);
1276
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001277 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1278 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1279 has_in++;
1280 if (!has_in) {
Joe Perches4291ee32010-12-09 19:29:03 -08001281 hid_err(intf, "couldn't find an input interrupt endpoint\n");
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001282 return -ENODEV;
1283 }
1284
Jiri Slabyc500c972008-05-16 11:49:16 +02001285 hid = hid_allocate_device();
1286 if (IS_ERR(hid))
1287 return PTR_ERR(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
1289 usb_set_intfdata(intf, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001290 hid->ll_driver = &usb_hid_driver;
Jiri Slaby76483cf2008-09-18 12:23:33 +02001291 hid->ff_init = hid_pidff_init;
Jiri Slabyc500c972008-05-16 11:49:16 +02001292#ifdef CONFIG_USB_HIDDEV
Jiri Slaby93c10132008-06-27 00:04:24 +02001293 hid->hiddev_connect = hiddev_connect;
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001294 hid->hiddev_disconnect = hiddev_disconnect;
Jiri Slabyc500c972008-05-16 11:49:16 +02001295 hid->hiddev_hid_event = hiddev_hid_event;
1296 hid->hiddev_report_event = hiddev_report_event;
1297#endif
1298 hid->dev.parent = &intf->dev;
1299 hid->bus = BUS_USB;
1300 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1301 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1302 hid->name[0] = 0;
Bastien Nocerab5e5a372010-04-16 17:19:50 +01001303 hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
Jiri Slabya73a6372008-10-22 14:45:11 +02001304 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1305 USB_INTERFACE_PROTOCOL_MOUSE)
1306 hid->type = HID_TYPE_USBMOUSE;
Tomoki Sekiyama6dc14182011-05-23 15:45:44 -07001307 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
1308 hid->type = HID_TYPE_USBNONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Jiri Slabyc500c972008-05-16 11:49:16 +02001310 if (dev->manufacturer)
1311 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1312
1313 if (dev->product) {
1314 if (dev->manufacturer)
1315 strlcat(hid->name, " ", sizeof(hid->name));
1316 strlcat(hid->name, dev->product, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 }
1318
Jiri Slabyc500c972008-05-16 11:49:16 +02001319 if (!strlen(hid->name))
1320 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1321 le16_to_cpu(dev->descriptor.idVendor),
1322 le16_to_cpu(dev->descriptor.idProduct));
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001323
Jiri Slabyc500c972008-05-16 11:49:16 +02001324 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1325 strlcat(hid->phys, "/input", sizeof(hid->phys));
1326 len = strlen(hid->phys);
1327 if (len < sizeof(hid->phys) - 1)
1328 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1329 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Geoff Levand4a1a4d82007-01-15 20:11:52 -08001330
Jiri Slabyc500c972008-05-16 11:49:16 +02001331 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1332 hid->uniq[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001334 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1335 if (usbhid == NULL) {
1336 ret = -ENOMEM;
1337 goto err;
1338 }
1339
1340 hid->driver_data = usbhid;
1341 usbhid->hid = hid;
Jiri Kosina57ab12e2010-02-17 14:25:01 +01001342 usbhid->intf = intf;
1343 usbhid->ifnum = interface->desc.bInterfaceNumber;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001344
Alan Sternfde4e2f2010-05-07 10:41:10 -04001345 init_waitqueue_head(&usbhid->wait);
1346 INIT_WORK(&usbhid->reset_work, hid_reset);
Alan Sternfde4e2f2010-05-07 10:41:10 -04001347 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1348 spin_lock_init(&usbhid->lock);
1349
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001350 ret = hid_add_device(hid);
1351 if (ret) {
Jiri Slabyd458a9d2008-05-16 11:49:20 +02001352 if (ret != -ENODEV)
Joe Perches4291ee32010-12-09 19:29:03 -08001353 hid_err(intf, "can't add hid device: %d\n", ret);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001354 goto err_free;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001355 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001356
1357 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001358err_free:
1359 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001360err:
1361 hid_destroy_device(hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001362 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
1364
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001365static void usbhid_disconnect(struct usb_interface *intf)
Jiri Slabyc500c972008-05-16 11:49:16 +02001366{
1367 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001368 struct usbhid_device *usbhid;
Jiri Slabyc500c972008-05-16 11:49:16 +02001369
1370 if (WARN_ON(!hid))
1371 return;
1372
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001373 usbhid = hid->driver_data;
Reyad Attiyat46df9de2014-07-25 00:13:01 -05001374 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
1375 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1376 spin_unlock_irq(&usbhid->lock);
Jiri Slabyc500c972008-05-16 11:49:16 +02001377 hid_destroy_device(hid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001378 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001379}
1380
Oliver Neukum0361a282008-12-17 15:38:03 +01001381static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382{
Oliver Neukum0361a282008-12-17 15:38:03 +01001383 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001384 cancel_work_sync(&usbhid->reset_work);
1385}
1386
1387static void hid_cease_io(struct usbhid_device *usbhid)
1388{
Oliver Neukumfad9fbe2011-10-13 18:21:58 +02001389 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001390 usb_kill_urb(usbhid->urbin);
1391 usb_kill_urb(usbhid->urbctrl);
1392 usb_kill_urb(usbhid->urbout);
Oliver Neukum0361a282008-12-17 15:38:03 +01001393}
1394
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001395/* Treat USB reset pretty much the same as suspend/resume */
1396static int hid_pre_reset(struct usb_interface *intf)
1397{
1398 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001399 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001401 spin_lock_irq(&usbhid->lock);
1402 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1403 spin_unlock_irq(&usbhid->lock);
1404 hid_cease_io(usbhid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001405
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001406 return 0;
1407}
1408
1409/* Same routine used for post_reset and reset_resume */
1410static int hid_post_reset(struct usb_interface *intf)
1411{
1412 struct usb_device *dev = interface_to_usbdev (intf);
1413 struct hid_device *hid = usb_get_intfdata(intf);
1414 struct usbhid_device *usbhid = hid->driver_data;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001415 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001416 int status;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001417 char *rdesc;
1418
1419 /* Fetch and examine the HID report descriptor. If this
1420 * has changed, then rebind. Since usbcore's check of the
1421 * configuration descriptors passed, we already know that
1422 * the size of the HID report descriptor has not changed.
1423 */
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001424 rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001425 if (!rdesc) {
1426 dbg_hid("couldn't allocate rdesc memory (post_reset)\n");
1427 return 1;
1428 }
1429 status = hid_get_class_descriptor(dev,
1430 interface->desc.bInterfaceNumber,
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001431 HID_DT_REPORT, rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001432 if (status < 0) {
1433 dbg_hid("reading report descriptor failed (post_reset)\n");
1434 kfree(rdesc);
1435 return 1;
1436 }
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001437 status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001438 kfree(rdesc);
1439 if (status != 0) {
1440 dbg_hid("report descriptor changed\n");
1441 return 1;
1442 }
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001443
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001444 spin_lock_irq(&usbhid->lock);
1445 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
1446 spin_unlock_irq(&usbhid->lock);
1447 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001448 status = hid_start_in(hid);
1449 if (status < 0)
1450 hid_io_error(hid);
1451 usbhid_restart_queues(usbhid);
1452
1453 return 0;
1454}
1455
1456int usbhid_get_power(struct hid_device *hid)
1457{
1458 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001459
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001460 return usb_autopm_get_interface(usbhid->intf);
1461}
1462
1463void usbhid_put_power(struct hid_device *hid)
1464{
1465 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001466
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001467 usb_autopm_put_interface(usbhid->intf);
1468}
1469
1470
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001471#ifdef CONFIG_PM
Alan Sterneb055fd2012-07-19 16:09:01 -04001472static int hid_resume_common(struct hid_device *hid, bool driver_suspended)
1473{
1474 struct usbhid_device *usbhid = hid->driver_data;
1475 int status;
1476
1477 spin_lock_irq(&usbhid->lock);
1478 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1479 usbhid_mark_busy(usbhid);
1480
1481 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
1482 test_bit(HID_RESET_PENDING, &usbhid->iofl))
1483 schedule_work(&usbhid->reset_work);
1484 usbhid->retry_delay = 0;
1485
1486 usbhid_restart_queues(usbhid);
1487 spin_unlock_irq(&usbhid->lock);
1488
1489 status = hid_start_in(hid);
1490 if (status < 0)
1491 hid_io_error(hid);
1492
1493 if (driver_suspended && hid->driver && hid->driver->resume)
1494 status = hid->driver->resume(hid);
1495 return status;
1496}
1497
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1499{
Oliver Neukum0361a282008-12-17 15:38:03 +01001500 struct hid_device *hid = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 struct usbhid_device *usbhid = hid->driver_data;
Ming Lei37093b72013-03-15 12:08:55 +08001502 int status = 0;
Alan Sterneb055fd2012-07-19 16:09:01 -04001503 bool driver_suspended = false;
David Herrmannbfde79c2013-07-15 19:10:13 +02001504 unsigned int ledcount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
Alan Stern5b1b0b82011-08-19 23:49:48 +02001506 if (PMSG_IS_AUTO(message)) {
David Herrmannbfde79c2013-07-15 19:10:13 +02001507 ledcount = hidinput_count_leds(hid);
Oliver Neukum0361a282008-12-17 15:38:03 +01001508 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1509 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1510 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1511 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1512 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1513 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
David Herrmannbfde79c2013-07-15 19:10:13 +02001514 && (!ledcount || ignoreled))
Oliver Neukum0361a282008-12-17 15:38:03 +01001515 {
Alan Sternf2b52642012-07-19 16:08:45 -04001516 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001517 spin_unlock_irq(&usbhid->lock);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001518 if (hid->driver && hid->driver->suspend) {
1519 status = hid->driver->suspend(hid, message);
1520 if (status < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001521 goto failed;
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001522 }
Alan Sterneb055fd2012-07-19 16:09:01 -04001523 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001524 } else {
1525 usbhid_mark_busy(usbhid);
1526 spin_unlock_irq(&usbhid->lock);
1527 return -EBUSY;
1528 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Oliver Neukum0361a282008-12-17 15:38:03 +01001530 } else {
Ming Lei37093b72013-03-15 12:08:55 +08001531 /* TODO: resume() might need to handle suspend failure */
1532 if (hid->driver && hid->driver->suspend)
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001533 status = hid->driver->suspend(hid, message);
Alan Sterneb055fd2012-07-19 16:09:01 -04001534 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001535 spin_lock_irq(&usbhid->lock);
Alan Sternf2b52642012-07-19 16:08:45 -04001536 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001537 spin_unlock_irq(&usbhid->lock);
Ming Lei37093b72013-03-15 12:08:55 +08001538 if (usbhid_wait_io(hid) < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001539 status = -EIO;
Oliver Neukum0361a282008-12-17 15:38:03 +01001540 }
1541
Oliver Neukum0361a282008-12-17 15:38:03 +01001542 hid_cancel_delayed_stuff(usbhid);
1543 hid_cease_io(usbhid);
1544
Alan Stern5b1b0b82011-08-19 23:49:48 +02001545 if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001546 /* lost race against keypresses */
Alan Sterneb055fd2012-07-19 16:09:01 -04001547 status = -EBUSY;
1548 goto failed;
Oliver Neukum0361a282008-12-17 15:38:03 +01001549 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 dev_dbg(&intf->dev, "suspend\n");
Ming Lei37093b72013-03-15 12:08:55 +08001551 return status;
Alan Sterneb055fd2012-07-19 16:09:01 -04001552
1553 failed:
1554 hid_resume_common(hid, driver_suspended);
1555 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556}
1557
1558static int hid_resume(struct usb_interface *intf)
1559{
1560 struct hid_device *hid = usb_get_intfdata (intf);
1561 struct usbhid_device *usbhid = hid->driver_data;
1562 int status;
1563
Jiri Slabyfde5be32008-11-23 12:03:20 +01001564 if (!test_bit(HID_STARTED, &usbhid->iofl))
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001565 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001566
Alan Sterneb055fd2012-07-19 16:09:01 -04001567 status = hid_resume_common(hid, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 dev_dbg(&intf->dev, "resume status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 return 0;
1570}
1571
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001572static int hid_reset_resume(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573{
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001574 struct hid_device *hid = usb_get_intfdata(intf);
1575 struct usbhid_device *usbhid = hid->driver_data;
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001576 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Alan Sternf2b52642012-07-19 16:08:45 -04001578 clear_bit(HID_SUSPENDED, &usbhid->iofl);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001579 status = hid_post_reset(intf);
1580 if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1581 int ret = hid->driver->reset_resume(hid);
1582 if (ret < 0)
1583 status = ret;
1584 }
1585 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586}
1587
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001588#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Márton Némethd67dec52010-01-10 17:59:22 +01001590static const struct usb_device_id hid_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1592 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1593 { } /* Terminating entry */
1594};
1595
1596MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1597
1598static struct usb_driver hid_driver = {
1599 .name = "usbhid",
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001600 .probe = usbhid_probe,
1601 .disconnect = usbhid_disconnect,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001602#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 .suspend = hid_suspend,
1604 .resume = hid_resume,
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001605 .reset_resume = hid_reset_resume,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001606#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 .pre_reset = hid_pre_reset,
1608 .post_reset = hid_post_reset,
1609 .id_table = hid_usb_ids,
Oliver Neukum933e3182007-07-11 14:48:58 +02001610 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611};
1612
Guillaume Chazarain8fe294c2010-09-12 21:32:35 +02001613struct usb_interface *usbhid_find_interface(int minor)
1614{
1615 return usb_find_interface(&hid_driver, minor);
1616}
1617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618static int __init hid_init(void)
1619{
Oliver Neukum0361a282008-12-17 15:38:03 +01001620 int retval = -ENOMEM;
1621
Paul Walmsley876b9272007-04-19 14:56:12 +02001622 retval = usbhid_quirks_init(quirks_param);
1623 if (retval)
1624 goto usbhid_quirks_init_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 retval = usb_register(&hid_driver);
1626 if (retval)
1627 goto usb_register_fail;
Jiri Kosinaccabcd22009-10-02 18:31:36 +02001628 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 return 0;
1631usb_register_fail:
Paul Walmsley876b9272007-04-19 14:56:12 +02001632 usbhid_quirks_exit();
1633usbhid_quirks_init_fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 return retval;
1635}
1636
1637static void __exit hid_exit(void)
1638{
1639 usb_deregister(&hid_driver);
Paul Walmsley876b9272007-04-19 14:56:12 +02001640 usbhid_quirks_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641}
1642
1643module_init(hid_init);
1644module_exit(hid_exit);
1645
Jiri Kosina88adb722009-10-02 18:29:34 +02001646MODULE_AUTHOR("Andreas Gal");
1647MODULE_AUTHOR("Vojtech Pavlik");
1648MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649MODULE_DESCRIPTION(DRIVER_DESC);
1650MODULE_LICENSE(DRIVER_LICENSE);