blob: ae83af649a607f67239f1a64bf45dd4b5770cc7d [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*/
Don Zickus3af4e5a2015-08-10 12:06:53 -0400167 if (!test_bit(HID_NO_BANDWIDTH, &usbhid->iofl)
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200168 && !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 */
277 usbhid->retry_delay = 0;
Johan Hovold0b750b32014-09-05 18:08:47 +0200278 if ((hid->quirks & HID_QUIRK_ALWAYS_POLL) && !hid->open)
279 break;
Oliver Neukumcc8a9d72015-11-05 12:55:27 +0100280 usbhid_mark_busy(usbhid);
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400281 if (!test_bit(HID_RESUME_RUNNING, &usbhid->iofl)) {
282 hid_input_report(urb->context, HID_INPUT_REPORT,
283 urb->transfer_buffer,
284 urb->actual_length, 1);
285 /*
286 * autosuspend refused while keys are pressed
287 * because most keyboards don't wake up when
288 * a key is released
289 */
290 if (hid_check_keys_pressed(hid))
291 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
292 else
293 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
294 }
Jiri Slaby880d29f2008-06-18 23:55:41 +0200295 break;
296 case -EPIPE: /* stall */
Oliver Neukum0361a282008-12-17 15:38:03 +0100297 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200298 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
299 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
300 schedule_work(&usbhid->reset_work);
301 return;
302 case -ECONNRESET: /* unlink */
303 case -ENOENT:
304 case -ESHUTDOWN: /* unplug */
305 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
306 return;
307 case -EILSEQ: /* protocol error or unplug */
308 case -EPROTO: /* protocol error or unplug */
309 case -ETIME: /* protocol error or unplug */
310 case -ETIMEDOUT: /* Should never happen, but... */
Oliver Neukum0361a282008-12-17 15:38:03 +0100311 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200312 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
313 hid_io_error(hid);
314 return;
315 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800316 hid_warn(urb->dev, "input irq status %d received\n",
317 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 }
319
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800320 status = usb_submit_urb(urb, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -0500321 if (status) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100322 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -0500323 if (status != -EPERM) {
Joe Perches4291ee32010-12-09 19:29:03 -0800324 hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n",
325 hid_to_usb_dev(hid)->bus->bus_name,
326 hid_to_usb_dev(hid)->devpath,
327 usbhid->ifnum, status);
Alan Sternaef4e262006-01-31 12:58:38 -0500328 hid_io_error(hid);
329 }
330 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333static int hid_submit_out(struct hid_device *hid)
334{
335 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200336 char *raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100337 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum68229682010-12-22 15:33:40 +0100338 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200340 report = usbhid->out[usbhid->outtail].report;
341 raw_report = usbhid->out[usbhid->outtail].raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Mathieu Magnaudetdabb05c62014-11-27 16:02:36 +0100343 usbhid->urbout->transfer_buffer_length = hid_report_len(report);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800344 usbhid->urbout->dev = hid_to_usb_dev(hid);
Alan Stern668160e2012-07-19 16:08:21 -0400345 if (raw_report) {
346 memcpy(usbhid->outbuf, raw_report,
347 usbhid->urbout->transfer_buffer_length);
348 kfree(raw_report);
349 usbhid->out[usbhid->outtail].raw_report = NULL;
350 }
Oliver Neukum68229682010-12-22 15:33:40 +0100351
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800352 dbg_hid("submitting out urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800354 r = usb_submit_urb(usbhid->urbout, GFP_ATOMIC);
355 if (r < 0) {
356 hid_err(hid, "usb_submit_urb(out) failed: %d\n", r);
357 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800359 usbhid->last_out = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 return 0;
361}
362
363static int hid_submit_ctrl(struct hid_device *hid)
364{
365 struct hid_report *report;
366 unsigned char dir;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200367 char *raw_report;
Oliver Neukum68229682010-12-22 15:33:40 +0100368 int len, r;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100369 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100371 report = usbhid->ctrl[usbhid->ctrltail].report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200372 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100373 dir = usbhid->ctrl[usbhid->ctrltail].dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800375 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
376 if (dir == USB_DIR_OUT) {
377 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
378 usbhid->urbctrl->transfer_buffer_length = len;
Alan Stern668160e2012-07-19 16:08:21 -0400379 if (raw_report) {
380 memcpy(usbhid->ctrlbuf, raw_report, len);
381 kfree(raw_report);
382 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
383 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800384 } else {
385 int maxpacket, padlen;
Oliver Neukum0361a282008-12-17 15:38:03 +0100386
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800387 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
388 maxpacket = usb_maxpacket(hid_to_usb_dev(hid),
389 usbhid->urbctrl->pipe, 0);
390 if (maxpacket > 0) {
391 padlen = DIV_ROUND_UP(len, maxpacket);
392 padlen *= maxpacket;
393 if (padlen > usbhid->bufsize)
394 padlen = usbhid->bufsize;
395 } else
396 padlen = 0;
397 usbhid->urbctrl->transfer_buffer_length = padlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800399 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800401 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
402 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT :
403 HID_REQ_GET_REPORT;
404 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) |
405 report->id);
406 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
407 usbhid->cr->wLength = cpu_to_le16(len);
408
409 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
410 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" :
411 "Get_Report",
412 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
413
414 r = usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC);
415 if (r < 0) {
416 hid_err(hid, "usb_submit_urb(ctrl) failed: %d\n", r);
417 return r;
418 }
419 usbhid->last_ctrl = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 return 0;
421}
422
423/*
424 * Output interrupt completion handler.
425 */
426
David Howells7d12e782006-10-05 14:55:46 +0100427static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428{
429 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100430 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 unsigned long flags;
432 int unplug = 0;
433
434 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200435 case 0: /* success */
436 break;
437 case -ESHUTDOWN: /* unplug */
438 unplug = 1;
439 case -EILSEQ: /* protocol error or unplug */
440 case -EPROTO: /* protocol error or unplug */
441 case -ECONNRESET: /* unlink */
442 case -ENOENT:
443 break;
444 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800445 hid_warn(urb->dev, "output irq status %d received\n",
446 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 }
448
Oliver Neukum0361a282008-12-17 15:38:03 +0100449 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Alan Stern93101af2012-07-19 16:08:39 -0400451 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100452 usbhid->outtail = usbhid->outhead;
Alan Stern93101af2012-07-19 16:08:39 -0400453 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100454 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
Alan Stern93101af2012-07-19 16:08:39 -0400456 if (usbhid->outhead != usbhid->outtail &&
457 hid_submit_out(hid) == 0) {
458 /* Successfully submitted next urb in queue */
459 spin_unlock_irqrestore(&usbhid->lock, flags);
460 return;
461 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 }
463
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100464 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100465 spin_unlock_irqrestore(&usbhid->lock, flags);
Oliver Neukum68229682010-12-22 15:33:40 +0100466 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100467 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468}
469
470/*
471 * Control pipe completion handler.
472 */
473
David Howells7d12e782006-10-05 14:55:46 +0100474static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100477 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100478 int unplug = 0, status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Oliver Neukum0361a282008-12-17 15:38:03 +0100480 switch (status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200481 case 0: /* success */
482 if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
483 hid_input_report(urb->context,
484 usbhid->ctrl[usbhid->ctrltail].report->type,
485 urb->transfer_buffer, urb->actual_length, 0);
486 break;
487 case -ESHUTDOWN: /* unplug */
488 unplug = 1;
489 case -EILSEQ: /* protocol error or unplug */
490 case -EPROTO: /* protocol error or unplug */
491 case -ECONNRESET: /* unlink */
492 case -ENOENT:
493 case -EPIPE: /* report not available */
494 break;
495 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800496 hid_warn(urb->dev, "ctrl urb status %d received\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
498
Ioan-Adrian Ratiue4701272015-11-20 22:19:02 +0200499 spin_lock(&usbhid->lock);
500
Alan Stern93101af2012-07-19 16:08:39 -0400501 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100502 usbhid->ctrltail = usbhid->ctrlhead;
Alan Stern93101af2012-07-19 16:08:39 -0400503 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100504 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Alan Stern93101af2012-07-19 16:08:39 -0400506 if (usbhid->ctrlhead != usbhid->ctrltail &&
507 hid_submit_ctrl(hid) == 0) {
508 /* Successfully submitted next urb in queue */
509 spin_unlock(&usbhid->lock);
510 return;
511 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 }
513
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100514 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100515 spin_unlock(&usbhid->lock);
Oliver Neukum68229682010-12-22 15:33:40 +0100516 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100517 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518}
519
H Hartley Sweeten52cfc612009-08-17 15:37:18 -0700520static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
521 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
523 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100524 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Reyad Attiyat46df9de2014-07-25 00:13:01 -0500526 if (((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN) ||
527 test_bit(HID_DISCONNECTED, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 return;
529
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100530 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100531 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800532 hid_warn(hid, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 return;
534 }
535
Jiri Kosina27ce4052013-07-10 19:56:27 +0200536 usbhid->out[usbhid->outhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200537 if (!usbhid->out[usbhid->outhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800538 hid_warn(hid, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200539 return;
540 }
541 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
542 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100543 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Alan Stern01a7c982012-07-19 16:08:31 -0400545 /* If the queue isn't running, restart it */
546 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
547 usbhid_restart_out_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800548
Alan Stern01a7c982012-07-19 16:08:31 -0400549 /* Otherwise see if an earlier request has timed out */
550 } else if (time_after(jiffies, usbhid->last_out + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800551
Alan Stern01a7c982012-07-19 16:08:31 -0400552 /* Prevent autosuspend following the unlink */
553 usb_autopm_get_interface_no_resume(usbhid->intf);
554
Oliver Neukum858155f2010-02-12 13:02:28 +0100555 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400556 * Prevent resubmission in case the URB completes
557 * before we can unlink it. We don't want to cancel
558 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100559 */
Alan Stern01a7c982012-07-19 16:08:31 -0400560 usb_block_urb(usbhid->urbout);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200561
Alan Stern01a7c982012-07-19 16:08:31 -0400562 /* Drop lock to avoid deadlock if the callback runs */
563 spin_unlock(&usbhid->lock);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200564
Alan Stern01a7c982012-07-19 16:08:31 -0400565 usb_unlink_urb(usbhid->urbout);
566 spin_lock(&usbhid->lock);
567 usb_unblock_urb(usbhid->urbout);
568
569 /* Unlink might have stopped the queue */
570 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl))
571 usbhid_restart_out_queue(usbhid);
572
573 /* Now we can allow autosuspend again */
574 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100575 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 return;
577 }
578
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100579 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800580 hid_warn(hid, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return;
582 }
583
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200584 if (dir == USB_DIR_OUT) {
Jiri Kosina27ce4052013-07-10 19:56:27 +0200585 usbhid->ctrl[usbhid->ctrlhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200586 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800587 hid_warn(hid, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200588 return;
589 }
590 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
591 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100592 usbhid->ctrl[usbhid->ctrlhead].report = report;
593 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
594 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Alan Stern01a7c982012-07-19 16:08:31 -0400596 /* If the queue isn't running, restart it */
597 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
598 usbhid_restart_ctrl_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800599
Alan Stern01a7c982012-07-19 16:08:31 -0400600 /* Otherwise see if an earlier request has timed out */
601 } else if (time_after(jiffies, usbhid->last_ctrl + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800602
Alan Stern01a7c982012-07-19 16:08:31 -0400603 /* Prevent autosuspend following the unlink */
604 usb_autopm_get_interface_no_resume(usbhid->intf);
605
Oliver Neukum858155f2010-02-12 13:02:28 +0100606 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400607 * Prevent resubmission in case the URB completes
608 * before we can unlink it. We don't want to cancel
609 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100610 */
Alan Stern01a7c982012-07-19 16:08:31 -0400611 usb_block_urb(usbhid->urbctrl);
612
613 /* Drop lock to avoid deadlock if the callback runs */
614 spin_unlock(&usbhid->lock);
615
616 usb_unlink_urb(usbhid->urbctrl);
617 spin_lock(&usbhid->lock);
618 usb_unblock_urb(usbhid->urbctrl);
619
620 /* Unlink might have stopped the queue */
621 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
622 usbhid_restart_ctrl_queue(usbhid);
623
624 /* Now we can allow autosuspend again */
625 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100626 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100627}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100629static void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
Oliver Neukum0361a282008-12-17 15:38:03 +0100630{
631 struct usbhid_device *usbhid = hid->driver_data;
632 unsigned long flags;
633
634 spin_lock_irqsave(&usbhid->lock, flags);
635 __usbhid_submit_report(hid, report, dir);
636 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100639static int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100641 struct usbhid_device *usbhid = hid->driver_data;
642
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100643 if (!wait_event_timeout(usbhid->wait,
644 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
645 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200647 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return -1;
649 }
650
651 return 0;
652}
653
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500654static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
655{
Vojtech Pavlik71387bd72005-05-29 02:28:14 -0500656 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500657 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
658 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
659}
660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
662 unsigned char type, void *buf, int size)
663{
664 int result, retries = 4;
665
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100666 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 do {
669 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
670 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
671 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
672 retries--;
673 } while (result < size && retries);
674 return result;
675}
676
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100677int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
Oliver Neukum933e3182007-07-11 14:48:58 +0200679 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200680 int res = 0;
Oliver Neukum933e3182007-07-11 14:48:58 +0200681
Oliver Neukum0361a282008-12-17 15:38:03 +0100682 mutex_lock(&hid_open_mut);
Oliver Neukum933e3182007-07-11 14:48:58 +0200683 if (!hid->open++) {
684 res = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum68229682010-12-22 15:33:40 +0100685 /* the device must be awake to reliably request remote wakeup */
Oliver Neukum933e3182007-07-11 14:48:58 +0200686 if (res < 0) {
687 hid->open--;
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200688 res = -EIO;
689 goto done;
Oliver Neukum933e3182007-07-11 14:48:58 +0200690 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100691 usbhid->intf->needs_remote_wakeup = 1;
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400692 set_bit(HID_RESUME_RUNNING, &usbhid->iofl);
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200693 res = hid_start_in(hid);
694 if (res) {
695 if (res != -ENOSPC) {
696 hid_io_error(hid);
697 res = 0;
698 } else {
699 /* no use opening if resources are insufficient */
700 hid->open--;
701 res = -EBUSY;
702 usbhid->intf->needs_remote_wakeup = 0;
703 }
704 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100705 usb_autopm_put_interface(usbhid->intf);
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400706
707 /*
708 * In case events are generated while nobody was listening,
709 * some are released when the device is re-opened.
710 * Wait 50 msec for the queue to empty before allowing events
711 * to go through hid.
712 */
Oliver Neukum615322f2015-06-29 11:10:41 +0200713 if (res == 0 && !(hid->quirks & HID_QUIRK_ALWAYS_POLL))
714 msleep(50);
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400715 clear_bit(HID_RESUME_RUNNING, &usbhid->iofl);
Oliver Neukum933e3182007-07-11 14:48:58 +0200716 }
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200717done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100718 mutex_unlock(&hid_open_mut);
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200719 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720}
721
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100722void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100724 struct usbhid_device *usbhid = hid->driver_data;
725
Oliver Neukum0361a282008-12-17 15:38:03 +0100726 mutex_lock(&hid_open_mut);
727
728 /* protecting hid->open to make sure we don't restart
729 * data acquistion due to a resumption we no longer
730 * care about
731 */
732 spin_lock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200733 if (!--hid->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100734 spin_unlock_irq(&usbhid->lock);
Oliver Neukum89092dd2009-04-29 17:12:12 +0200735 hid_cancel_delayed_stuff(usbhid);
Johan Hovold0b750b32014-09-05 18:08:47 +0200736 if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL)) {
737 usb_kill_urb(usbhid->urbin);
738 usbhid->intf->needs_remote_wakeup = 0;
739 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100740 } else {
741 spin_unlock_irq(&usbhid->lock);
Oliver Neukum933e3182007-07-11 14:48:58 +0200742 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100743 mutex_unlock(&hid_open_mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
745
746/*
747 * Initialize all reports
748 */
749
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100750void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751{
752 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100753 struct usbhid_device *usbhid = hid->driver_data;
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200754 struct hid_report_enum *report_enum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 int err, ret;
756
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200757 if (!(hid->quirks & HID_QUIRK_NO_INIT_INPUT_REPORTS)) {
758 report_enum = &hid->report_enum[HID_INPUT_REPORT];
759 list_for_each_entry(report, &report_enum->report_list, list)
760 usbhid_submit_report(hid, report, USB_DIR_IN);
761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200763 report_enum = &hid->report_enum[HID_FEATURE_REPORT];
764 list_for_each_entry(report, &report_enum->report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100765 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100768 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 while (ret) {
770 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100771 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
772 usb_kill_urb(usbhid->urbctrl);
773 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
774 usb_kill_urb(usbhid->urbout);
775 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 }
777
778 if (err)
Joe Perches4291ee32010-12-09 19:29:03 -0800779 hid_warn(hid, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780}
781
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500782/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200783 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
784 */
785static int hid_find_field_early(struct hid_device *hid, unsigned int page,
786 unsigned int hid_code, struct hid_field **pfield)
787{
788 struct hid_report *report;
789 struct hid_field *field;
790 struct hid_usage *usage;
791 int i, j;
792
793 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
794 for (i = 0; i < report->maxfield; i++) {
795 field = report->field[i];
796 for (j = 0; j < field->maxusage; j++) {
797 usage = &field->usage[j];
798 if ((usage->hid & HID_USAGE_PAGE) == page &&
799 (usage->hid & 0xFFFF) == hid_code) {
800 *pfield = field;
801 return j;
802 }
803 }
804 }
805 }
806 return -1;
807}
808
David Herrmannddf64a32013-07-15 19:10:10 +0200809static void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200810{
811 struct hid_field *field;
812 int offset;
813
814 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
815 hid_set_field(field, offset, 0);
816 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
817 }
818}
819
820/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500821 * Traverse the supplied list of reports and find the longest
822 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100823static void hid_find_max_report(struct hid_device *hid, unsigned int type,
824 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500825{
826 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100827 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500828
829 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200830 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500831 if (*max < size)
832 *max = size;
833 }
834}
835
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
837{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100838 struct usbhid_device *usbhid = hid->driver_data;
839
Daniel Mack997ea582010-04-12 13:17:25 +0200840 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100841 &usbhid->inbuf_dma);
Daniel Mack997ea582010-04-12 13:17:25 +0200842 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100843 &usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500844 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
Daniel Mack997ea582010-04-12 13:17:25 +0200845 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100846 &usbhid->ctrlbuf_dma);
847 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
848 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 return -1;
850
851 return 0;
852}
853
Alan Ottb4dbde92011-01-18 03:04:39 -0500854static int usbhid_get_raw_report(struct hid_device *hid,
855 unsigned char report_number, __u8 *buf, size_t count,
856 unsigned char report_type)
857{
858 struct usbhid_device *usbhid = hid->driver_data;
859 struct usb_device *dev = hid_to_usb_dev(hid);
860 struct usb_interface *intf = usbhid->intf;
861 struct usb_host_interface *interface = intf->cur_altsetting;
862 int skipped_report_id = 0;
863 int ret;
864
865 /* Byte 0 is the report number. Report data starts at byte 1.*/
866 buf[0] = report_number;
867 if (report_number == 0x0) {
868 /* Offset the return buffer by 1, so that the report ID
869 will remain in byte 0. */
870 buf++;
871 count--;
872 skipped_report_id = 1;
873 }
874 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
875 HID_REQ_GET_REPORT,
876 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
877 ((report_type + 1) << 8) | report_number,
878 interface->desc.bInterfaceNumber, buf, count,
879 USB_CTRL_SET_TIMEOUT);
880
881 /* count also the report id */
882 if (ret > 0 && skipped_report_id)
883 ret++;
884
885 return ret;
886}
887
Frank Praznik975a6832014-01-22 13:49:42 -0500888static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum,
889 __u8 *buf, size_t count, unsigned char rtype)
890{
891 struct usbhid_device *usbhid = hid->driver_data;
892 struct usb_device *dev = hid_to_usb_dev(hid);
893 struct usb_interface *intf = usbhid->intf;
894 struct usb_host_interface *interface = intf->cur_altsetting;
895 int ret, skipped_report_id = 0;
896
897 /* Byte 0 is the report number. Report data starts at byte 1.*/
Benjamin Tissoirese534a932014-03-08 22:52:42 -0500898 if ((rtype == HID_OUTPUT_REPORT) &&
899 (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID))
900 buf[0] = 0;
901 else
902 buf[0] = reportnum;
903
Frank Praznik975a6832014-01-22 13:49:42 -0500904 if (buf[0] == 0x0) {
905 /* Don't send the Report ID */
906 buf++;
907 count--;
908 skipped_report_id = 1;
909 }
910
911 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
912 HID_REQ_SET_REPORT,
913 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
914 ((rtype + 1) << 8) | reportnum,
915 interface->desc.bInterfaceNumber, buf, count,
916 USB_CTRL_SET_TIMEOUT);
917 /* count also the report id, if this was a numbered report. */
918 if (ret > 0 && skipped_report_id)
919 ret++;
920
921 return ret;
922}
923
Frank Praznik975a6832014-01-22 13:49:42 -0500924static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count)
925{
926 struct usbhid_device *usbhid = hid->driver_data;
927 struct usb_device *dev = hid_to_usb_dev(hid);
928 int actual_length, skipped_report_id = 0, ret;
929
930 if (!usbhid->urbout)
Benjamin Tissoiresddea1af2014-02-10 12:58:51 -0500931 return -ENOSYS;
Frank Praznik975a6832014-01-22 13:49:42 -0500932
933 if (buf[0] == 0x0) {
934 /* Don't send the Report ID */
935 buf++;
936 count--;
937 skipped_report_id = 1;
938 }
939
940 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
941 buf, count, &actual_length,
942 USB_CTRL_SET_TIMEOUT);
943 /* return the number of bytes transferred */
944 if (ret == 0) {
945 ret = actual_length;
946 /* count also the report id */
947 if (skipped_report_id)
948 ret++;
949 }
950
951 return ret;
952}
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
955{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100956 struct usbhid_device *usbhid = hid->driver_data;
957
Daniel Mack997ea582010-04-12 13:17:25 +0200958 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
959 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500960 kfree(usbhid->cr);
Daniel Mack997ea582010-04-12 13:17:25 +0200961 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962}
963
Jiri Slabyc500c972008-05-16 11:49:16 +0200964static int usbhid_parse(struct hid_device *hid)
965{
966 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 struct usb_host_interface *interface = intf->cur_altsetting;
968 struct usb_device *dev = interface_to_usbdev (intf);
969 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200970 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200971 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500972 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200973 int ret, n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200975 quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
976 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100978 if (quirks & HID_QUIRK_IGNORE)
979 return -ENODEV;
980
Alan Stern0f28b552006-05-15 14:49:04 -0400981 /* Many keyboards and mice don't like to be polled for reports,
982 * so we will always set the HID_QUIRK_NOGET flag for them. */
983 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
984 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
985 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
986 quirks |= HID_QUIRK_NOGET;
987 }
988
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500989 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
990 (!interface->desc.bNumEndpoints ||
991 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200992 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200993 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 }
995
Jiri Slabyc500c972008-05-16 11:49:16 +0200996 hid->version = le16_to_cpu(hdesc->bcdHID);
997 hid->country = hdesc->bCountryCode;
998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 for (n = 0; n < hdesc->bNumDescriptors; n++)
1000 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1001 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1002
1003 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001004 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +02001005 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 }
1007
1008 if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001009 dbg_hid("couldn't allocate rdesc memory\n");
Jiri Slabyc500c972008-05-16 11:49:16 +02001010 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 }
1012
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001013 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1014
Jiri Slabyc500c972008-05-16 11:49:16 +02001015 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
1016 HID_DT_REPORT, rdesc, rsize);
1017 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001018 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001020 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 }
1022
Jiri Slabyc500c972008-05-16 11:49:16 +02001023 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001025 if (ret) {
1026 dbg_hid("parsing report descriptor failed\n");
1027 goto err;
1028 }
1029
Zoltan Karcagif5208992009-05-06 16:30:21 +02001030 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Jiri Slabyc500c972008-05-16 11:49:16 +02001032 return 0;
1033err:
1034 return ret;
1035}
1036
1037static int usbhid_start(struct hid_device *hid)
1038{
1039 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1040 struct usb_host_interface *interface = intf->cur_altsetting;
1041 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001042 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +02001043 unsigned int n, insize = 0;
1044 int ret;
1045
Jiri Slabye3e14de2008-11-01 23:41:46 +01001046 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
1047
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001048 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
1049 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
1050 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
1051 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
1052
1053 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
1054 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001055
1056 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1057
1058 if (insize > HID_MAX_BUFFER_SIZE)
1059 insize = HID_MAX_BUFFER_SIZE;
1060
Jiri Slabyc500c972008-05-16 11:49:16 +02001061 if (hid_alloc_buffers(dev, hid)) {
1062 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001064 }
1065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 struct usb_endpoint_descriptor *endpoint;
1068 int pipe;
1069 int interval;
1070
1071 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +01001072 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 continue;
1074
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001077 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +02001078 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001079 dev->speed == USB_SPEED_HIGH) {
1080 interval = fls(endpoint->bInterval*8);
1081 printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1082 hid->name, endpoint->bInterval, interval);
1083 }
1084
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 /* Change the polling interval of mice. */
1086 if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
1087 interval = hid_mousepoll_interval;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05001088
Jiri Slabyc500c972008-05-16 11:49:16 +02001089 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -03001090 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001091 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001093 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 goto fail;
1095 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001096 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001098 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1099 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001101 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001103 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 goto fail;
1105 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001106 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001108 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1109 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 }
1111 }
1112
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001113 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +02001114 if (!usbhid->urbctrl) {
1115 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +02001117 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001118
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001119 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1120 usbhid->ctrlbuf, 1, hid_ctrl, hid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001121 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
Alan Stern0ede76f2010-03-05 15:10:17 -05001122 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Jiri Slabyc500c972008-05-16 11:49:16 +02001123
Jiri Kosina5b915d92009-11-05 14:08:03 +01001124 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
1125 usbhid_init_reports(hid);
Jiri Slaby93c10132008-06-27 00:04:24 +02001126
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001127 set_bit(HID_STARTED, &usbhid->iofl);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001128
Johan Hovold0b750b32014-09-05 18:08:47 +02001129 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1130 ret = usb_autopm_get_interface(usbhid->intf);
1131 if (ret)
1132 goto fail;
1133 usbhid->intf->needs_remote_wakeup = 1;
1134 ret = hid_start_in(hid);
1135 if (ret) {
1136 dev_err(&hid->dev,
1137 "failed to start in urb: %d\n", ret);
1138 }
1139 usb_autopm_put_interface(usbhid->intf);
1140 }
1141
Alan Stern08ef08e2008-10-30 23:58:51 +01001142 /* Some keyboards don't work until their LEDs have been set.
1143 * Since BIOSes do set the LEDs, it must be safe for any device
1144 * that supports the keyboard boot protocol.
Alan Stern3d615102010-04-02 13:21:58 -04001145 * In addition, enable remote wakeup by default for all keyboard
1146 * devices supporting the boot protocol.
Alan Stern08ef08e2008-10-30 23:58:51 +01001147 */
1148 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1149 interface->desc.bInterfaceProtocol ==
Alan Stern3d615102010-04-02 13:21:58 -04001150 USB_INTERFACE_PROTOCOL_KEYBOARD) {
Alan Stern08ef08e2008-10-30 23:58:51 +01001151 usbhid_set_leds(hid);
Alan Stern3d615102010-04-02 13:21:58 -04001152 device_set_wakeup_enable(&dev->dev, 1);
1153 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001154 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
1156fail:
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001157 usb_free_urb(usbhid->urbin);
1158 usb_free_urb(usbhid->urbout);
1159 usb_free_urb(usbhid->urbctrl);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001160 usbhid->urbin = NULL;
1161 usbhid->urbout = NULL;
1162 usbhid->urbctrl = NULL;
Jiri Kosina22f675f2007-08-01 12:32:27 +02001163 hid_free_buffers(dev, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001164 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
1166
Jiri Slabyc500c972008-05-16 11:49:16 +02001167static void usbhid_stop(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168{
Jiri Slabyc500c972008-05-16 11:49:16 +02001169 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Jiri Slabyc500c972008-05-16 11:49:16 +02001171 if (WARN_ON(!usbhid))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 return;
1173
Johan Hovold0b750b32014-09-05 18:08:47 +02001174 if (hid->quirks & HID_QUIRK_ALWAYS_POLL)
1175 usbhid->intf->needs_remote_wakeup = 0;
1176
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001177 clear_bit(HID_STARTED, &usbhid->iofl);
Daniel Kurtz4371ea82011-11-17 19:23:50 +08001178 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
Oliver Neukum69626f22008-03-31 16:27:30 +02001179 set_bit(HID_DISCONNECTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001180 spin_unlock_irq(&usbhid->lock);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001181 usb_kill_urb(usbhid->urbin);
1182 usb_kill_urb(usbhid->urbout);
1183 usb_kill_urb(usbhid->urbctrl);
1184
Oliver Neukum0361a282008-12-17 15:38:03 +01001185 hid_cancel_delayed_stuff(usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -05001186
Jiri Slabyc500c972008-05-16 11:49:16 +02001187 hid->claimed = 0;
1188
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001189 usb_free_urb(usbhid->urbin);
1190 usb_free_urb(usbhid->urbctrl);
1191 usb_free_urb(usbhid->urbout);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001192 usbhid->urbin = NULL; /* don't mess up next start */
1193 usbhid->urbctrl = NULL;
1194 usbhid->urbout = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Anssi Hannulabe820972007-01-19 19:28:17 +02001196 hid_free_buffers(hid_to_usb_dev(hid), hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197}
1198
Oliver Neukum0361a282008-12-17 15:38:03 +01001199static int usbhid_power(struct hid_device *hid, int lvl)
1200{
1201 int r = 0;
1202
1203 switch (lvl) {
1204 case PM_HINT_FULLON:
1205 r = usbhid_get_power(hid);
1206 break;
1207 case PM_HINT_NORMAL:
1208 usbhid_put_power(hid);
1209 break;
1210 }
1211 return r;
1212}
1213
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001214static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype)
1215{
1216 switch (reqtype) {
1217 case HID_REQ_GET_REPORT:
1218 usbhid_submit_report(hid, rep, USB_DIR_IN);
1219 break;
1220 case HID_REQ_SET_REPORT:
1221 usbhid_submit_report(hid, rep, USB_DIR_OUT);
1222 break;
1223 }
1224}
1225
Frank Praznik975a6832014-01-22 13:49:42 -05001226static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum,
1227 __u8 *buf, size_t len, unsigned char rtype,
1228 int reqtype)
1229{
1230 switch (reqtype) {
1231 case HID_REQ_GET_REPORT:
1232 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype);
1233 case HID_REQ_SET_REPORT:
1234 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype);
1235 default:
1236 return -EIO;
1237 }
1238}
1239
Benjamin Tissoires96848192013-02-27 16:38:17 +01001240static int usbhid_idle(struct hid_device *hid, int report, int idle,
1241 int reqtype)
1242{
1243 struct usb_device *dev = hid_to_usb_dev(hid);
1244 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1245 struct usb_host_interface *interface = intf->cur_altsetting;
1246 int ifnum = interface->desc.bInterfaceNumber;
1247
1248 if (reqtype != HID_REQ_SET_IDLE)
1249 return -EINVAL;
1250
1251 return hid_set_idle(dev, ifnum, report, idle);
1252}
1253
Jiri Slabyc500c972008-05-16 11:49:16 +02001254static struct hid_ll_driver usb_hid_driver = {
1255 .parse = usbhid_parse,
1256 .start = usbhid_start,
1257 .stop = usbhid_stop,
1258 .open = usbhid_open,
1259 .close = usbhid_close,
Oliver Neukum0361a282008-12-17 15:38:03 +01001260 .power = usbhid_power,
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001261 .request = usbhid_request,
Henrik Rydberg33734432013-02-25 11:31:44 +01001262 .wait = usbhid_wait_io,
Frank Praznik975a6832014-01-22 13:49:42 -05001263 .raw_request = usbhid_raw_request,
1264 .output_report = usbhid_output_report,
Benjamin Tissoires96848192013-02-27 16:38:17 +01001265 .idle = usbhid_idle,
Jiri Slabyc500c972008-05-16 11:49:16 +02001266};
1267
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001268static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269{
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001270 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Slabyc500c972008-05-16 11:49:16 +02001271 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001272 struct usbhid_device *usbhid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 struct hid_device *hid;
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001274 unsigned int n, has_in = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +02001275 size_t len;
1276 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Jiri Kosina58037eb2007-05-30 15:07:13 +02001278 dbg_hid("HID probe called for ifnum %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 intf->altsetting->desc.bInterfaceNumber);
1280
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001281 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1282 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1283 has_in++;
1284 if (!has_in) {
Joe Perches4291ee32010-12-09 19:29:03 -08001285 hid_err(intf, "couldn't find an input interrupt endpoint\n");
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001286 return -ENODEV;
1287 }
1288
Jiri Slabyc500c972008-05-16 11:49:16 +02001289 hid = hid_allocate_device();
1290 if (IS_ERR(hid))
1291 return PTR_ERR(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293 usb_set_intfdata(intf, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001294 hid->ll_driver = &usb_hid_driver;
Jiri Slaby76483cf2008-09-18 12:23:33 +02001295 hid->ff_init = hid_pidff_init;
Jiri Slabyc500c972008-05-16 11:49:16 +02001296#ifdef CONFIG_USB_HIDDEV
Jiri Slaby93c10132008-06-27 00:04:24 +02001297 hid->hiddev_connect = hiddev_connect;
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001298 hid->hiddev_disconnect = hiddev_disconnect;
Jiri Slabyc500c972008-05-16 11:49:16 +02001299 hid->hiddev_hid_event = hiddev_hid_event;
1300 hid->hiddev_report_event = hiddev_report_event;
1301#endif
1302 hid->dev.parent = &intf->dev;
1303 hid->bus = BUS_USB;
1304 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1305 hid->product = le16_to_cpu(dev->descriptor.idProduct);
1306 hid->name[0] = 0;
Bastien Nocerab5e5a372010-04-16 17:19:50 +01001307 hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
Jiri Slabya73a6372008-10-22 14:45:11 +02001308 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1309 USB_INTERFACE_PROTOCOL_MOUSE)
1310 hid->type = HID_TYPE_USBMOUSE;
Tomoki Sekiyama6dc14182011-05-23 15:45:44 -07001311 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
1312 hid->type = HID_TYPE_USBNONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
Jiri Slabyc500c972008-05-16 11:49:16 +02001314 if (dev->manufacturer)
1315 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1316
1317 if (dev->product) {
1318 if (dev->manufacturer)
1319 strlcat(hid->name, " ", sizeof(hid->name));
1320 strlcat(hid->name, dev->product, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 }
1322
Jiri Slabyc500c972008-05-16 11:49:16 +02001323 if (!strlen(hid->name))
1324 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1325 le16_to_cpu(dev->descriptor.idVendor),
1326 le16_to_cpu(dev->descriptor.idProduct));
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001327
Jiri Slabyc500c972008-05-16 11:49:16 +02001328 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1329 strlcat(hid->phys, "/input", sizeof(hid->phys));
1330 len = strlen(hid->phys);
1331 if (len < sizeof(hid->phys) - 1)
1332 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1333 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Geoff Levand4a1a4d82007-01-15 20:11:52 -08001334
Jiri Slabyc500c972008-05-16 11:49:16 +02001335 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1336 hid->uniq[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001338 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1339 if (usbhid == NULL) {
1340 ret = -ENOMEM;
1341 goto err;
1342 }
1343
1344 hid->driver_data = usbhid;
1345 usbhid->hid = hid;
Jiri Kosina57ab12e2010-02-17 14:25:01 +01001346 usbhid->intf = intf;
1347 usbhid->ifnum = interface->desc.bInterfaceNumber;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001348
Alan Sternfde4e2f2010-05-07 10:41:10 -04001349 init_waitqueue_head(&usbhid->wait);
1350 INIT_WORK(&usbhid->reset_work, hid_reset);
Alan Sternfde4e2f2010-05-07 10:41:10 -04001351 setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
1352 spin_lock_init(&usbhid->lock);
1353
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001354 ret = hid_add_device(hid);
1355 if (ret) {
Jiri Slabyd458a9d2008-05-16 11:49:20 +02001356 if (ret != -ENODEV)
Joe Perches4291ee32010-12-09 19:29:03 -08001357 hid_err(intf, "can't add hid device: %d\n", ret);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001358 goto err_free;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001359 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001360
1361 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001362err_free:
1363 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001364err:
1365 hid_destroy_device(hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001366 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
1368
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001369static void usbhid_disconnect(struct usb_interface *intf)
Jiri Slabyc500c972008-05-16 11:49:16 +02001370{
1371 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001372 struct usbhid_device *usbhid;
Jiri Slabyc500c972008-05-16 11:49:16 +02001373
1374 if (WARN_ON(!hid))
1375 return;
1376
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001377 usbhid = hid->driver_data;
Reyad Attiyat46df9de2014-07-25 00:13:01 -05001378 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
1379 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1380 spin_unlock_irq(&usbhid->lock);
Jiri Slabyc500c972008-05-16 11:49:16 +02001381 hid_destroy_device(hid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001382 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001383}
1384
Oliver Neukum0361a282008-12-17 15:38:03 +01001385static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386{
Oliver Neukum0361a282008-12-17 15:38:03 +01001387 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001388 cancel_work_sync(&usbhid->reset_work);
1389}
1390
1391static void hid_cease_io(struct usbhid_device *usbhid)
1392{
Oliver Neukumfad9fbe2011-10-13 18:21:58 +02001393 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001394 usb_kill_urb(usbhid->urbin);
1395 usb_kill_urb(usbhid->urbctrl);
1396 usb_kill_urb(usbhid->urbout);
Oliver Neukum0361a282008-12-17 15:38:03 +01001397}
1398
Alan Stern972e6a92016-03-23 12:17:09 -04001399static void hid_restart_io(struct hid_device *hid)
1400{
1401 struct usbhid_device *usbhid = hid->driver_data;
1402 int clear_halt = test_bit(HID_CLEAR_HALT, &usbhid->iofl);
1403 int reset_pending = test_bit(HID_RESET_PENDING, &usbhid->iofl);
1404
1405 spin_lock_irq(&usbhid->lock);
1406 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1407 usbhid_mark_busy(usbhid);
1408
1409 if (clear_halt || reset_pending)
1410 schedule_work(&usbhid->reset_work);
1411 usbhid->retry_delay = 0;
1412 spin_unlock_irq(&usbhid->lock);
1413
1414 if (reset_pending || !test_bit(HID_STARTED, &usbhid->iofl))
1415 return;
1416
1417 if (!clear_halt) {
1418 if (hid_start_in(hid) < 0)
1419 hid_io_error(hid);
1420 }
1421
1422 spin_lock_irq(&usbhid->lock);
1423 if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl))
1424 usbhid_restart_out_queue(usbhid);
1425 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
1426 usbhid_restart_ctrl_queue(usbhid);
1427 spin_unlock_irq(&usbhid->lock);
1428}
1429
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001430/* Treat USB reset pretty much the same as suspend/resume */
1431static int hid_pre_reset(struct usb_interface *intf)
1432{
1433 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001434 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001436 spin_lock_irq(&usbhid->lock);
1437 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1438 spin_unlock_irq(&usbhid->lock);
1439 hid_cease_io(usbhid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001440
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001441 return 0;
1442}
1443
1444/* Same routine used for post_reset and reset_resume */
1445static int hid_post_reset(struct usb_interface *intf)
1446{
1447 struct usb_device *dev = interface_to_usbdev (intf);
1448 struct hid_device *hid = usb_get_intfdata(intf);
1449 struct usbhid_device *usbhid = hid->driver_data;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001450 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001451 int status;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001452 char *rdesc;
1453
1454 /* Fetch and examine the HID report descriptor. If this
1455 * has changed, then rebind. Since usbcore's check of the
1456 * configuration descriptors passed, we already know that
1457 * the size of the HID report descriptor has not changed.
1458 */
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001459 rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001460 if (!rdesc) {
1461 dbg_hid("couldn't allocate rdesc memory (post_reset)\n");
1462 return 1;
1463 }
1464 status = hid_get_class_descriptor(dev,
1465 interface->desc.bInterfaceNumber,
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001466 HID_DT_REPORT, rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001467 if (status < 0) {
1468 dbg_hid("reading report descriptor failed (post_reset)\n");
1469 kfree(rdesc);
1470 return 1;
1471 }
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001472 status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001473 kfree(rdesc);
1474 if (status != 0) {
1475 dbg_hid("report descriptor changed\n");
1476 return 1;
1477 }
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001478
Alan Stern972e6a92016-03-23 12:17:09 -04001479 /* No need to do another reset or clear a halted endpoint */
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001480 spin_lock_irq(&usbhid->lock);
1481 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern972e6a92016-03-23 12:17:09 -04001482 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001483 spin_unlock_irq(&usbhid->lock);
1484 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
Alan Stern972e6a92016-03-23 12:17:09 -04001485
1486 hid_restart_io(hid);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001487
1488 return 0;
1489}
1490
1491int usbhid_get_power(struct hid_device *hid)
1492{
1493 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001494
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001495 return usb_autopm_get_interface(usbhid->intf);
1496}
1497
1498void usbhid_put_power(struct hid_device *hid)
1499{
1500 struct usbhid_device *usbhid = hid->driver_data;
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001501
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001502 usb_autopm_put_interface(usbhid->intf);
1503}
1504
1505
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001506#ifdef CONFIG_PM
Alan Sterneb055fd2012-07-19 16:09:01 -04001507static int hid_resume_common(struct hid_device *hid, bool driver_suspended)
1508{
Alan Stern972e6a92016-03-23 12:17:09 -04001509 int status = 0;
Alan Sterneb055fd2012-07-19 16:09:01 -04001510
Alan Stern972e6a92016-03-23 12:17:09 -04001511 hid_restart_io(hid);
Alan Sterneb055fd2012-07-19 16:09:01 -04001512 if (driver_suspended && hid->driver && hid->driver->resume)
1513 status = hid->driver->resume(hid);
1514 return status;
1515}
1516
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1518{
Oliver Neukum0361a282008-12-17 15:38:03 +01001519 struct hid_device *hid = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 struct usbhid_device *usbhid = hid->driver_data;
Ming Lei37093b72013-03-15 12:08:55 +08001521 int status = 0;
Alan Sterneb055fd2012-07-19 16:09:01 -04001522 bool driver_suspended = false;
David Herrmannbfde79c2013-07-15 19:10:13 +02001523 unsigned int ledcount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Alan Stern5b1b0b82011-08-19 23:49:48 +02001525 if (PMSG_IS_AUTO(message)) {
David Herrmannbfde79c2013-07-15 19:10:13 +02001526 ledcount = hidinput_count_leds(hid);
Oliver Neukum0361a282008-12-17 15:38:03 +01001527 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1528 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1529 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1530 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1531 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1532 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
David Herrmannbfde79c2013-07-15 19:10:13 +02001533 && (!ledcount || ignoreled))
Oliver Neukum0361a282008-12-17 15:38:03 +01001534 {
Alan Sternf2b52642012-07-19 16:08:45 -04001535 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001536 spin_unlock_irq(&usbhid->lock);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001537 if (hid->driver && hid->driver->suspend) {
1538 status = hid->driver->suspend(hid, message);
1539 if (status < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001540 goto failed;
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001541 }
Alan Sterneb055fd2012-07-19 16:09:01 -04001542 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001543 } else {
1544 usbhid_mark_busy(usbhid);
1545 spin_unlock_irq(&usbhid->lock);
1546 return -EBUSY;
1547 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
Oliver Neukum0361a282008-12-17 15:38:03 +01001549 } else {
Ming Lei37093b72013-03-15 12:08:55 +08001550 /* TODO: resume() might need to handle suspend failure */
1551 if (hid->driver && hid->driver->suspend)
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001552 status = hid->driver->suspend(hid, message);
Alan Sterneb055fd2012-07-19 16:09:01 -04001553 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001554 spin_lock_irq(&usbhid->lock);
Alan Sternf2b52642012-07-19 16:08:45 -04001555 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001556 spin_unlock_irq(&usbhid->lock);
Ming Lei37093b72013-03-15 12:08:55 +08001557 if (usbhid_wait_io(hid) < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001558 status = -EIO;
Oliver Neukum0361a282008-12-17 15:38:03 +01001559 }
1560
Oliver Neukum0361a282008-12-17 15:38:03 +01001561 hid_cancel_delayed_stuff(usbhid);
1562 hid_cease_io(usbhid);
1563
Alan Stern5b1b0b82011-08-19 23:49:48 +02001564 if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001565 /* lost race against keypresses */
Alan Sterneb055fd2012-07-19 16:09:01 -04001566 status = -EBUSY;
1567 goto failed;
Oliver Neukum0361a282008-12-17 15:38:03 +01001568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 dev_dbg(&intf->dev, "suspend\n");
Ming Lei37093b72013-03-15 12:08:55 +08001570 return status;
Alan Sterneb055fd2012-07-19 16:09:01 -04001571
1572 failed:
1573 hid_resume_common(hid, driver_suspended);
1574 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575}
1576
1577static int hid_resume(struct usb_interface *intf)
1578{
1579 struct hid_device *hid = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 int status;
1581
Alan Sterneb055fd2012-07-19 16:09:01 -04001582 status = hid_resume_common(hid, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 dev_dbg(&intf->dev, "resume status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 return 0;
1585}
1586
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001587static int hid_reset_resume(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588{
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001589 struct hid_device *hid = usb_get_intfdata(intf);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001590 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001592 status = hid_post_reset(intf);
1593 if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1594 int ret = hid->driver->reset_resume(hid);
1595 if (ret < 0)
1596 status = ret;
1597 }
1598 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599}
1600
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001601#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
Márton Némethd67dec52010-01-10 17:59:22 +01001603static const struct usb_device_id hid_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1605 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1606 { } /* Terminating entry */
1607};
1608
1609MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1610
1611static struct usb_driver hid_driver = {
1612 .name = "usbhid",
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001613 .probe = usbhid_probe,
1614 .disconnect = usbhid_disconnect,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001615#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 .suspend = hid_suspend,
1617 .resume = hid_resume,
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001618 .reset_resume = hid_reset_resume,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001619#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 .pre_reset = hid_pre_reset,
1621 .post_reset = hid_post_reset,
1622 .id_table = hid_usb_ids,
Oliver Neukum933e3182007-07-11 14:48:58 +02001623 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624};
1625
Guillaume Chazarain8fe294c2010-09-12 21:32:35 +02001626struct usb_interface *usbhid_find_interface(int minor)
1627{
1628 return usb_find_interface(&hid_driver, minor);
1629}
1630
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631static int __init hid_init(void)
1632{
Oliver Neukum0361a282008-12-17 15:38:03 +01001633 int retval = -ENOMEM;
1634
Paul Walmsley876b9272007-04-19 14:56:12 +02001635 retval = usbhid_quirks_init(quirks_param);
1636 if (retval)
1637 goto usbhid_quirks_init_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 retval = usb_register(&hid_driver);
1639 if (retval)
1640 goto usb_register_fail;
Jiri Kosinaccabcd22009-10-02 18:31:36 +02001641 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
1643 return 0;
1644usb_register_fail:
Paul Walmsley876b9272007-04-19 14:56:12 +02001645 usbhid_quirks_exit();
1646usbhid_quirks_init_fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 return retval;
1648}
1649
1650static void __exit hid_exit(void)
1651{
1652 usb_deregister(&hid_driver);
Paul Walmsley876b9272007-04-19 14:56:12 +02001653 usbhid_quirks_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654}
1655
1656module_init(hid_init);
1657module_exit(hid_exit);
1658
Jiri Kosina88adb722009-10-02 18:29:34 +02001659MODULE_AUTHOR("Andreas Gal");
1660MODULE_AUTHOR("Vojtech Pavlik");
1661MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662MODULE_DESCRIPTION(DRIVER_DESC);
1663MODULE_LICENSE(DRIVER_LICENSE);