blob: 77c50cdfff974cd35b91c30e4fb9940a23ecedb2 [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"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
48 * Module parameters.
49 */
50
51static unsigned int hid_mousepoll_interval;
52module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
53MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
54
Tobias Jakobi933bfe42017-02-25 20:27:27 +010055static unsigned int hid_jspoll_interval;
56module_param_named(jspoll, hid_jspoll_interval, uint, 0644);
57MODULE_PARM_DESC(jspoll, "Polling interval of joysticks");
58
Oliver Neukum0361a282008-12-17 15:38:03 +010059static unsigned int ignoreled;
60module_param_named(ignoreled, ignoreled, uint, 0644);
61MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");
62
Paul Walmsley876b9272007-04-19 14:56:12 +020063/* Quirks specified at module load time */
Mathias Krause81ba9922014-06-05 21:20:51 +020064static char *quirks_param[MAX_USBHID_BOOT_QUIRKS];
Paul Walmsley876b9272007-04-19 14:56:12 +020065module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
66MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
67 " quirks=vendorID:productID:quirks"
68 " where vendorID, productID, and quirks are all in"
69 " 0x-prefixed hex");
Linus Torvalds1da177e2005-04-16 15:20:36 -070070/*
Alan Sternaef4e262006-01-31 12:58:38 -050071 * Input submission and I/O error handler.
72 */
Alan Sternaef4e262006-01-31 12:58:38 -050073static void hid_io_error(struct hid_device *hid);
Oliver Neukum0361a282008-12-17 15:38:03 +010074static int hid_submit_out(struct hid_device *hid);
75static int hid_submit_ctrl(struct hid_device *hid);
76static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -050077
78/* Start up the input URB */
79static int hid_start_in(struct hid_device *hid)
80{
81 unsigned long flags;
82 int rc = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +010083 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -050084
Oliver Neukum0361a282008-12-17 15:38:03 +010085 spin_lock_irqsave(&usbhid->lock, flags);
Dmitry Torokhov28cbc862017-06-06 23:59:33 -070086 if (test_bit(HID_IN_POLLING, &usbhid->iofl) &&
87 !test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
88 !test_bit(HID_SUSPENDED, &usbhid->iofl) &&
89 !test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +010090 rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
Oliver Neukuma8c52b62012-03-28 13:16:19 +020091 if (rc != 0) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +010092 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Oliver Neukuma8c52b62012-03-28 13:16:19 +020093 if (rc == -ENOSPC)
94 set_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
95 } else {
96 clear_bit(HID_NO_BANDWIDTH, &usbhid->iofl);
97 }
Alan Sternaef4e262006-01-31 12:58:38 -050098 }
Oliver Neukum0361a282008-12-17 15:38:03 +010099 spin_unlock_irqrestore(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -0500100 return rc;
101}
102
103/* I/O retry timer routine */
Kees Cook0ee32772017-10-04 17:53:24 -0700104static void hid_retry_timeout(struct timer_list *t)
Alan Sternaef4e262006-01-31 12:58:38 -0500105{
Kees Cook0ee32772017-10-04 17:53:24 -0700106 struct usbhid_device *usbhid = from_timer(usbhid, t, io_retry);
107 struct hid_device *hid = usbhid->hid;
Alan Sternaef4e262006-01-31 12:58:38 -0500108
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100109 dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
Alan Sternaef4e262006-01-31 12:58:38 -0500110 if (hid_start_in(hid))
111 hid_io_error(hid);
112}
113
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400114/* Workqueue routine to reset the device or clear a halt */
David Howellsc4028952006-11-22 14:57:56 +0000115static void hid_reset(struct work_struct *work)
Alan Sternaef4e262006-01-31 12:58:38 -0500116{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100117 struct usbhid_device *usbhid =
118 container_of(work, struct usbhid_device, reset_work);
119 struct hid_device *hid = usbhid->hid;
Alan Stern8f507ef2014-09-02 11:39:15 -0400120 int rc;
Alan Sternaef4e262006-01-31 12:58:38 -0500121
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100122 if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
123 dev_dbg(&usbhid->intf->dev, "clear halt\n");
Anssi Hannulabe820972007-01-19 19:28:17 +0200124 rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100125 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Alan Stern011b15d2008-11-04 11:29:27 -0500126 if (rc == 0) {
Alan Stern8f507ef2014-09-02 11:39:15 -0400127 hid_start_in(hid);
128 } else {
129 dev_dbg(&usbhid->intf->dev,
130 "clear-halt failed: %d\n", rc);
131 set_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400132 }
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400133 }
Alan Sternaef4e262006-01-31 12:58:38 -0500134
Alan Stern8f507ef2014-09-02 11:39:15 -0400135 if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
136 dev_dbg(&usbhid->intf->dev, "resetting device\n");
137 usb_queue_reset_device(usbhid->intf);
Alan Sterndf9a1f42006-06-01 13:55:28 -0400138 }
Alan Sternaef4e262006-01-31 12:58:38 -0500139}
140
141/* Main I/O error handler */
142static void hid_io_error(struct hid_device *hid)
143{
144 unsigned long flags;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100145 struct usbhid_device *usbhid = hid->driver_data;
Alan Sternaef4e262006-01-31 12:58:38 -0500146
Oliver Neukum0361a282008-12-17 15:38:03 +0100147 spin_lock_irqsave(&usbhid->lock, flags);
Alan Sternaef4e262006-01-31 12:58:38 -0500148
149 /* Stop when disconnected */
Oliver Neukum69626f22008-03-31 16:27:30 +0200150 if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
Alan Sternaef4e262006-01-31 12:58:38 -0500151 goto done;
152
Alan Stern5e2a55f2007-03-20 19:03:31 +0100153 /* If it has been a while since the last error, we'll assume
154 * this a brand new error and reset the retry timeout. */
155 if (time_after(jiffies, usbhid->stop_retry + HZ/2))
156 usbhid->retry_delay = 0;
157
Alan Sternaef4e262006-01-31 12:58:38 -0500158 /* When an error occurs, retry at increasing intervals */
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100159 if (usbhid->retry_delay == 0) {
160 usbhid->retry_delay = 13; /* Then 26, 52, 104, 104, ... */
161 usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
162 } else if (usbhid->retry_delay < 100)
163 usbhid->retry_delay *= 2;
Alan Sternaef4e262006-01-31 12:58:38 -0500164
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100165 if (time_after(jiffies, usbhid->stop_retry)) {
Alan Sternaef4e262006-01-31 12:58:38 -0500166
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200167 /* Retries failed, so do a port reset unless we lack bandwidth*/
Don Zickus3af4e5a2015-08-10 12:06:53 -0400168 if (!test_bit(HID_NO_BANDWIDTH, &usbhid->iofl)
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200169 && !test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
170
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100171 schedule_work(&usbhid->reset_work);
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400172 goto done;
Alan Sternaef4e262006-01-31 12:58:38 -0500173 }
174 }
175
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100176 mod_timer(&usbhid->io_retry,
177 jiffies + msecs_to_jiffies(usbhid->retry_delay));
Alan Sternaef4e262006-01-31 12:58:38 -0500178done:
Oliver Neukum0361a282008-12-17 15:38:03 +0100179 spin_unlock_irqrestore(&usbhid->lock, flags);
180}
181
182static void usbhid_mark_busy(struct usbhid_device *usbhid)
183{
184 struct usb_interface *intf = usbhid->intf;
185
186 usb_mark_last_busy(interface_to_usbdev(intf));
187}
188
189static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
190{
191 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
192 int kicked;
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800193 int r;
Oliver Neukum0361a282008-12-17 15:38:03 +0100194
Alan Sternd4150c82012-07-19 16:08:54 -0400195 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
196 test_bit(HID_SUSPENDED, &usbhid->iofl))
Oliver Neukum0361a282008-12-17 15:38:03 +0100197 return 0;
198
199 if ((kicked = (usbhid->outhead != usbhid->outtail))) {
Greg Kroah-Hartman6cc203d2012-05-01 21:32:55 -0700200 hid_dbg(hid, "Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800201
Alan Stern01a7c982012-07-19 16:08:31 -0400202 /* Try to wake up from autosuspend... */
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800203 r = usb_autopm_get_interface_async(usbhid->intf);
204 if (r < 0)
205 return r;
Alan Stern01a7c982012-07-19 16:08:31 -0400206
207 /*
208 * If still suspended, don't submit. Submission will
209 * occur if/when resume drains the queue.
210 */
Alan Sternf2b52642012-07-19 16:08:45 -0400211 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
Alan Stern01a7c982012-07-19 16:08:31 -0400212 usb_autopm_put_interface_no_suspend(usbhid->intf);
213 return r;
214 }
215
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800216 /* Asynchronously flush queue. */
217 set_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100218 if (hid_submit_out(hid)) {
219 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800220 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100221 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800222 wake_up(&usbhid->wait);
Oliver Neukum0361a282008-12-17 15:38:03 +0100223 }
224 return kicked;
225}
226
227static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
228{
229 struct hid_device *hid = usb_get_intfdata(usbhid->intf);
230 int kicked;
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800231 int r;
Oliver Neukum0361a282008-12-17 15:38:03 +0100232
233 WARN_ON(hid == NULL);
Alan Sternd4150c82012-07-19 16:08:54 -0400234 if (!hid || test_bit(HID_RESET_PENDING, &usbhid->iofl) ||
235 test_bit(HID_SUSPENDED, &usbhid->iofl))
Oliver Neukum0361a282008-12-17 15:38:03 +0100236 return 0;
237
238 if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
Greg Kroah-Hartman6cc203d2012-05-01 21:32:55 -0700239 hid_dbg(hid, "Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800240
Alan Stern01a7c982012-07-19 16:08:31 -0400241 /* Try to wake up from autosuspend... */
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800242 r = usb_autopm_get_interface_async(usbhid->intf);
243 if (r < 0)
244 return r;
Alan Stern01a7c982012-07-19 16:08:31 -0400245
246 /*
247 * If still suspended, don't submit. Submission will
248 * occur if/when resume drains the queue.
249 */
Alan Sternf2b52642012-07-19 16:08:45 -0400250 if (test_bit(HID_SUSPENDED, &usbhid->iofl)) {
Alan Stern01a7c982012-07-19 16:08:31 -0400251 usb_autopm_put_interface_no_suspend(usbhid->intf);
252 return r;
253 }
254
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800255 /* Asynchronously flush queue. */
256 set_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100257 if (hid_submit_ctrl(hid)) {
258 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800259 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +0100260 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800261 wake_up(&usbhid->wait);
Oliver Neukum0361a282008-12-17 15:38:03 +0100262 }
263 return kicked;
Alan Sternaef4e262006-01-31 12:58:38 -0500264}
265
266/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 * Input interrupt completion handler.
268 */
269
David Howells7d12e782006-10-05 14:55:46 +0100270static void hid_irq_in(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271{
272 struct hid_device *hid = urb->context;
Dmitry Torokhov28cbc862017-06-06 23:59:33 -0700273 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 int status;
275
276 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200277 case 0: /* success */
278 usbhid->retry_delay = 0;
Dmitry Torokhov28cbc862017-06-06 23:59:33 -0700279 if (!test_bit(HID_OPENED, &usbhid->iofl))
Johan Hovold0b750b32014-09-05 18:08:47 +0200280 break;
Oliver Neukumcc8a9d72015-11-05 12:55:27 +0100281 usbhid_mark_busy(usbhid);
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400282 if (!test_bit(HID_RESUME_RUNNING, &usbhid->iofl)) {
283 hid_input_report(urb->context, HID_INPUT_REPORT,
284 urb->transfer_buffer,
285 urb->actual_length, 1);
286 /*
287 * autosuspend refused while keys are pressed
288 * because most keyboards don't wake up when
289 * a key is released
290 */
291 if (hid_check_keys_pressed(hid))
292 set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
293 else
294 clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
295 }
Jiri Slaby880d29f2008-06-18 23:55:41 +0200296 break;
297 case -EPIPE: /* stall */
Oliver Neukum0361a282008-12-17 15:38:03 +0100298 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200299 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
300 set_bit(HID_CLEAR_HALT, &usbhid->iofl);
301 schedule_work(&usbhid->reset_work);
302 return;
303 case -ECONNRESET: /* unlink */
304 case -ENOENT:
305 case -ESHUTDOWN: /* unplug */
306 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
307 return;
308 case -EILSEQ: /* protocol error or unplug */
309 case -EPROTO: /* protocol error or unplug */
310 case -ETIME: /* protocol error or unplug */
311 case -ETIMEDOUT: /* Should never happen, but... */
Oliver Neukum0361a282008-12-17 15:38:03 +0100312 usbhid_mark_busy(usbhid);
Jiri Slaby880d29f2008-06-18 23:55:41 +0200313 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
314 hid_io_error(hid);
315 return;
316 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800317 hid_warn(urb->dev, "input irq status %d received\n",
318 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 }
320
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800321 status = usb_submit_urb(urb, GFP_ATOMIC);
Alan Sternaef4e262006-01-31 12:58:38 -0500322 if (status) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100323 clear_bit(HID_IN_RUNNING, &usbhid->iofl);
Alan Sternaef4e262006-01-31 12:58:38 -0500324 if (status != -EPERM) {
Joe Perches4291ee32010-12-09 19:29:03 -0800325 hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n",
326 hid_to_usb_dev(hid)->bus->bus_name,
327 hid_to_usb_dev(hid)->devpath,
328 usbhid->ifnum, status);
Alan Sternaef4e262006-01-31 12:58:38 -0500329 hid_io_error(hid);
330 }
331 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334static int hid_submit_out(struct hid_device *hid)
335{
336 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200337 char *raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100338 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum68229682010-12-22 15:33:40 +0100339 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200341 report = usbhid->out[usbhid->outtail].report;
342 raw_report = usbhid->out[usbhid->outtail].raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Mathieu Magnaudetdabb05c62014-11-27 16:02:36 +0100344 usbhid->urbout->transfer_buffer_length = hid_report_len(report);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800345 usbhid->urbout->dev = hid_to_usb_dev(hid);
Alan Stern668160e2012-07-19 16:08:21 -0400346 if (raw_report) {
347 memcpy(usbhid->outbuf, raw_report,
348 usbhid->urbout->transfer_buffer_length);
349 kfree(raw_report);
350 usbhid->out[usbhid->outtail].raw_report = NULL;
351 }
Oliver Neukum68229682010-12-22 15:33:40 +0100352
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800353 dbg_hid("submitting out urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800355 r = usb_submit_urb(usbhid->urbout, GFP_ATOMIC);
356 if (r < 0) {
357 hid_err(hid, "usb_submit_urb(out) failed: %d\n", r);
358 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800360 usbhid->last_out = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 return 0;
362}
363
364static int hid_submit_ctrl(struct hid_device *hid)
365{
366 struct hid_report *report;
367 unsigned char dir;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200368 char *raw_report;
Oliver Neukum68229682010-12-22 15:33:40 +0100369 int len, r;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100370 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100372 report = usbhid->ctrl[usbhid->ctrltail].report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200373 raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100374 dir = usbhid->ctrl[usbhid->ctrltail].dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800376 len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
377 if (dir == USB_DIR_OUT) {
378 usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
379 usbhid->urbctrl->transfer_buffer_length = len;
Alan Stern668160e2012-07-19 16:08:21 -0400380 if (raw_report) {
381 memcpy(usbhid->ctrlbuf, raw_report, len);
382 kfree(raw_report);
383 usbhid->ctrl[usbhid->ctrltail].raw_report = NULL;
384 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800385 } else {
386 int maxpacket, padlen;
Oliver Neukum0361a282008-12-17 15:38:03 +0100387
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800388 usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
389 maxpacket = usb_maxpacket(hid_to_usb_dev(hid),
390 usbhid->urbctrl->pipe, 0);
391 if (maxpacket > 0) {
392 padlen = DIV_ROUND_UP(len, maxpacket);
393 padlen *= maxpacket;
394 if (padlen > usbhid->bufsize)
395 padlen = usbhid->bufsize;
396 } else
397 padlen = 0;
398 usbhid->urbctrl->transfer_buffer_length = padlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 }
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800400 usbhid->urbctrl->dev = hid_to_usb_dev(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800402 usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
403 usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT :
404 HID_REQ_GET_REPORT;
405 usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) |
406 report->id);
407 usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
408 usbhid->cr->wLength = cpu_to_le16(len);
409
410 dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
411 usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" :
412 "Get_Report",
413 usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
414
415 r = usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC);
416 if (r < 0) {
417 hid_err(hid, "usb_submit_urb(ctrl) failed: %d\n", r);
418 return r;
419 }
420 usbhid->last_ctrl = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 return 0;
422}
423
424/*
425 * Output interrupt completion handler.
426 */
427
David Howells7d12e782006-10-05 14:55:46 +0100428static void hid_irq_out(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429{
430 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100431 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 unsigned long flags;
433 int unplug = 0;
434
435 switch (urb->status) {
Jiri Slaby880d29f2008-06-18 23:55:41 +0200436 case 0: /* success */
437 break;
438 case -ESHUTDOWN: /* unplug */
439 unplug = 1;
440 case -EILSEQ: /* protocol error or unplug */
441 case -EPROTO: /* protocol error or unplug */
442 case -ECONNRESET: /* unlink */
443 case -ENOENT:
444 break;
445 default: /* error */
Joe Perches4291ee32010-12-09 19:29:03 -0800446 hid_warn(urb->dev, "output irq status %d received\n",
447 urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
449
Oliver Neukum0361a282008-12-17 15:38:03 +0100450 spin_lock_irqsave(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Alan Stern93101af2012-07-19 16:08:39 -0400452 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100453 usbhid->outtail = usbhid->outhead;
Alan Stern93101af2012-07-19 16:08:39 -0400454 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100455 usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Alan Stern93101af2012-07-19 16:08:39 -0400457 if (usbhid->outhead != usbhid->outtail &&
458 hid_submit_out(hid) == 0) {
459 /* Successfully submitted next urb in queue */
460 spin_unlock_irqrestore(&usbhid->lock, flags);
461 return;
462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 }
464
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100465 clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100466 spin_unlock_irqrestore(&usbhid->lock, flags);
Oliver Neukum68229682010-12-22 15:33:40 +0100467 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100468 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470
471/*
472 * Control pipe completion handler.
473 */
474
David Howells7d12e782006-10-05 14:55:46 +0100475static void hid_ctrl(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
477 struct hid_device *hid = urb->context;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100478 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +0100479 int unplug = 0, status = urb->status;
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
Ioan-Adrian Ratiue4701272015-11-20 22:19:02 +0200500 spin_lock(&usbhid->lock);
501
Alan Stern93101af2012-07-19 16:08:39 -0400502 if (unplug) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100503 usbhid->ctrltail = usbhid->ctrlhead;
Alan Stern93101af2012-07-19 16:08:39 -0400504 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100505 usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Alan Stern93101af2012-07-19 16:08:39 -0400507 if (usbhid->ctrlhead != usbhid->ctrltail &&
508 hid_submit_ctrl(hid) == 0) {
509 /* Successfully submitted next urb in queue */
510 spin_unlock(&usbhid->lock);
511 return;
512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 }
514
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100515 clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +0100516 spin_unlock(&usbhid->lock);
Oliver Neukum68229682010-12-22 15:33:40 +0100517 usb_autopm_put_interface_async(usbhid->intf);
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100518 wake_up(&usbhid->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
520
H Hartley Sweeten52cfc61b2009-08-17 15:37:18 -0700521static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
522 unsigned char dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
524 int head;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100525 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Reyad Attiyat46df9deda2014-07-25 00:13:01 -0500527 if (((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN) ||
528 test_bit(HID_DISCONNECTED, &usbhid->iofl))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 return;
530
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100531 if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100532 if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800533 hid_warn(hid, "output queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 return;
535 }
536
Jiri Kosina27ce4052013-07-10 19:56:27 +0200537 usbhid->out[usbhid->outhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200538 if (!usbhid->out[usbhid->outhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800539 hid_warn(hid, "output queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200540 return;
541 }
542 hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
543 usbhid->out[usbhid->outhead].report = report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100544 usbhid->outhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Alan Stern01a7c982012-07-19 16:08:31 -0400546 /* If the queue isn't running, restart it */
547 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
548 usbhid_restart_out_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800549
Alan Stern01a7c982012-07-19 16:08:31 -0400550 /* Otherwise see if an earlier request has timed out */
551 } else if (time_after(jiffies, usbhid->last_out + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800552
Alan Stern01a7c982012-07-19 16:08:31 -0400553 /* Prevent autosuspend following the unlink */
554 usb_autopm_get_interface_no_resume(usbhid->intf);
555
Oliver Neukum858155f2010-02-12 13:02:28 +0100556 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400557 * Prevent resubmission in case the URB completes
558 * before we can unlink it. We don't want to cancel
559 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100560 */
Alan Stern01a7c982012-07-19 16:08:31 -0400561 usb_block_urb(usbhid->urbout);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200562
Alan Stern01a7c982012-07-19 16:08:31 -0400563 /* Drop lock to avoid deadlock if the callback runs */
564 spin_unlock(&usbhid->lock);
Oliver Neukum8815bb02012-04-30 09:13:46 +0200565
Alan Stern01a7c982012-07-19 16:08:31 -0400566 usb_unlink_urb(usbhid->urbout);
567 spin_lock(&usbhid->lock);
568 usb_unblock_urb(usbhid->urbout);
569
570 /* Unlink might have stopped the queue */
571 if (!test_bit(HID_OUT_RUNNING, &usbhid->iofl))
572 usbhid_restart_out_queue(usbhid);
573
574 /* Now we can allow autosuspend again */
575 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100576 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return;
578 }
579
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100580 if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
Joe Perches4291ee32010-12-09 19:29:03 -0800581 hid_warn(hid, "control queue full\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 return;
583 }
584
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200585 if (dir == USB_DIR_OUT) {
Jiri Kosina27ce4052013-07-10 19:56:27 +0200586 usbhid->ctrl[usbhid->ctrlhead].raw_report = hid_alloc_report_buf(report, GFP_ATOMIC);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200587 if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800588 hid_warn(hid, "control queueing failed\n");
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200589 return;
590 }
591 hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
592 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100593 usbhid->ctrl[usbhid->ctrlhead].report = report;
594 usbhid->ctrl[usbhid->ctrlhead].dir = dir;
595 usbhid->ctrlhead = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Alan Stern01a7c982012-07-19 16:08:31 -0400597 /* If the queue isn't running, restart it */
598 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
599 usbhid_restart_ctrl_queue(usbhid);
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800600
Alan Stern01a7c982012-07-19 16:08:31 -0400601 /* Otherwise see if an earlier request has timed out */
602 } else if (time_after(jiffies, usbhid->last_ctrl + HZ * 5)) {
Daniel Kurtzf0befcd2011-11-17 19:23:49 +0800603
Alan Stern01a7c982012-07-19 16:08:31 -0400604 /* Prevent autosuspend following the unlink */
605 usb_autopm_get_interface_no_resume(usbhid->intf);
606
Oliver Neukum858155f2010-02-12 13:02:28 +0100607 /*
Alan Stern01a7c982012-07-19 16:08:31 -0400608 * Prevent resubmission in case the URB completes
609 * before we can unlink it. We don't want to cancel
610 * the wrong transfer!
Oliver Neukum858155f2010-02-12 13:02:28 +0100611 */
Alan Stern01a7c982012-07-19 16:08:31 -0400612 usb_block_urb(usbhid->urbctrl);
613
614 /* Drop lock to avoid deadlock if the callback runs */
615 spin_unlock(&usbhid->lock);
616
617 usb_unlink_urb(usbhid->urbctrl);
618 spin_lock(&usbhid->lock);
619 usb_unblock_urb(usbhid->urbctrl);
620
621 /* Unlink might have stopped the queue */
622 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
623 usbhid_restart_ctrl_queue(usbhid);
624
625 /* Now we can allow autosuspend again */
626 usb_autopm_put_interface_async(usbhid->intf);
Oliver Neukum858155f2010-02-12 13:02:28 +0100627 }
Oliver Neukum0361a282008-12-17 15:38:03 +0100628}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100630static void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
Oliver Neukum0361a282008-12-17 15:38:03 +0100631{
632 struct usbhid_device *usbhid = hid->driver_data;
633 unsigned long flags;
634
635 spin_lock_irqsave(&usbhid->lock, flags);
636 __usbhid_submit_report(hid, report, dir);
637 spin_unlock_irqrestore(&usbhid->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638}
639
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100640static int usbhid_wait_io(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100642 struct usbhid_device *usbhid = hid->driver_data;
643
Jiri Slaby1d1bdd22008-03-19 21:55:04 +0100644 if (!wait_event_timeout(usbhid->wait,
645 (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
646 !test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 10*HZ)) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200648 dbg_hid("timeout waiting for ctrl or out queue to clear\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 return -1;
650 }
651
652 return 0;
653}
654
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500655static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
656{
Vojtech Pavlik71387bd2005-05-29 02:28:14 -0500657 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Vojtech Pavlik854561b2005-05-29 02:28:00 -0500658 HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
659 ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
660}
661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
663 unsigned char type, void *buf, int size)
664{
665 int result, retries = 4;
666
Jiri Kosina43c7bf02007-01-26 12:58:24 +0100667 memset(buf, 0, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669 do {
670 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
671 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
672 (type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
673 retries--;
674 } while (result < size && retries);
675 return result;
676}
677
Dmitry Torokhovd36b7d42017-06-06 23:59:31 -0700678static int usbhid_open(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679{
Oliver Neukum933e3182007-07-11 14:48:58 +0200680 struct usbhid_device *usbhid = hid->driver_data;
Dmitry Torokhove3993962017-06-06 23:59:36 -0700681 int res;
Oliver Neukum933e3182007-07-11 14:48:58 +0200682
Dmitry Torokhovcf601772017-07-12 17:14:24 -0700683 set_bit(HID_OPENED, &usbhid->iofl);
684
Dmitry Torokhove3993962017-06-06 23:59:36 -0700685 if (hid->quirks & HID_QUIRK_ALWAYS_POLL)
686 return 0;
Benjamin Tissoiresb9058112014-09-30 14:28:22 -0400687
Dmitry Torokhove3993962017-06-06 23:59:36 -0700688 res = usb_autopm_get_interface(usbhid->intf);
689 /* the device must be awake to reliably request remote wakeup */
Dmitry Torokhovcf601772017-07-12 17:14:24 -0700690 if (res < 0) {
691 clear_bit(HID_OPENED, &usbhid->iofl);
Dmitry Torokhove3993962017-06-06 23:59:36 -0700692 return -EIO;
Dmitry Torokhovcf601772017-07-12 17:14:24 -0700693 }
Dmitry Torokhove3993962017-06-06 23:59:36 -0700694
695 usbhid->intf->needs_remote_wakeup = 1;
696
697 set_bit(HID_RESUME_RUNNING, &usbhid->iofl);
Dmitry Torokhove3993962017-06-06 23:59:36 -0700698 set_bit(HID_IN_POLLING, &usbhid->iofl);
699
700 res = hid_start_in(hid);
701 if (res) {
702 if (res != -ENOSPC) {
703 hid_io_error(hid);
704 res = 0;
705 } else {
706 /* no use opening if resources are insufficient */
707 res = -EBUSY;
708 clear_bit(HID_OPENED, &usbhid->iofl);
709 clear_bit(HID_IN_POLLING, &usbhid->iofl);
710 usbhid->intf->needs_remote_wakeup = 0;
711 }
Oliver Neukum933e3182007-07-11 14:48:58 +0200712 }
Dmitry Torokhove3993962017-06-06 23:59:36 -0700713
714 usb_autopm_put_interface(usbhid->intf);
715
716 /*
717 * In case events are generated while nobody was listening,
718 * some are released when the device is re-opened.
719 * Wait 50 msec for the queue to empty before allowing events
720 * to go through hid.
721 */
722 if (res == 0)
723 msleep(50);
724
725 clear_bit(HID_RESUME_RUNNING, &usbhid->iofl);
Oliver Neukuma8c52b62012-03-28 13:16:19 +0200726 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727}
728
Dmitry Torokhovd36b7d42017-06-06 23:59:31 -0700729static void usbhid_close(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100731 struct usbhid_device *usbhid = hid->driver_data;
732
Dmitry Torokhove3993962017-06-06 23:59:36 -0700733 /*
734 * Make sure we don't restart data acquisition due to
735 * a resumption we no longer care about by avoiding racing
736 * with hid_start_in().
Oliver Neukum0361a282008-12-17 15:38:03 +0100737 */
738 spin_lock_irq(&usbhid->lock);
Dmitry Torokhove3993962017-06-06 23:59:36 -0700739 clear_bit(HID_OPENED, &usbhid->iofl);
Dmitry Torokhovcf601772017-07-12 17:14:24 -0700740 if (!(hid->quirks & HID_QUIRK_ALWAYS_POLL))
741 clear_bit(HID_IN_POLLING, &usbhid->iofl);
Dmitry Torokhove3993962017-06-06 23:59:36 -0700742 spin_unlock_irq(&usbhid->lock);
743
Dmitry Torokhovcf601772017-07-12 17:14:24 -0700744 if (hid->quirks & HID_QUIRK_ALWAYS_POLL)
745 return;
746
Dmitry Torokhove3993962017-06-06 23:59:36 -0700747 hid_cancel_delayed_stuff(usbhid);
748 usb_kill_urb(usbhid->urbin);
749 usbhid->intf->needs_remote_wakeup = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750}
751
752/*
753 * Initialize all reports
754 */
755
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100756void usbhid_init_reports(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757{
758 struct hid_report *report;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100759 struct usbhid_device *usbhid = hid->driver_data;
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200760 struct hid_report_enum *report_enum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 int err, ret;
762
Benjamin Tissoires91430592017-03-08 15:11:14 +0100763 report_enum = &hid->report_enum[HID_INPUT_REPORT];
764 list_for_each_entry(report, &report_enum->report_list, list)
765 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200767 report_enum = &hid->report_enum[HID_FEATURE_REPORT];
768 list_for_each_entry(report, &report_enum->report_list, list)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100769 usbhid_submit_report(hid, report, USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
771 err = 0;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100772 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 while (ret) {
774 err |= ret;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100775 if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
776 usb_kill_urb(usbhid->urbctrl);
777 if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
778 usb_kill_urb(usbhid->urbout);
779 ret = usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
781
782 if (err)
Joe Perches4291ee32010-12-09 19:29:03 -0800783 hid_warn(hid, "timeout initializing reports\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784}
785
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500786/*
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200787 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
788 */
789static int hid_find_field_early(struct hid_device *hid, unsigned int page,
790 unsigned int hid_code, struct hid_field **pfield)
791{
792 struct hid_report *report;
793 struct hid_field *field;
794 struct hid_usage *usage;
795 int i, j;
796
797 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
798 for (i = 0; i < report->maxfield; i++) {
799 field = report->field[i];
800 for (j = 0; j < field->maxusage; j++) {
801 usage = &field->usage[j];
802 if ((usage->hid & HID_USAGE_PAGE) == page &&
803 (usage->hid & 0xFFFF) == hid_code) {
804 *pfield = field;
805 return j;
806 }
807 }
808 }
809 }
810 return -1;
811}
812
David Herrmannddf64a32013-07-15 19:10:10 +0200813static void usbhid_set_leds(struct hid_device *hid)
Pete Zaitcev713c8aa2007-04-06 14:33:18 +0200814{
815 struct hid_field *field;
816 int offset;
817
818 if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
819 hid_set_field(field, offset, 0);
820 usbhid_submit_report(hid, field->report, USB_DIR_OUT);
821 }
822}
823
824/*
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500825 * Traverse the supplied list of reports and find the longest
826 */
Jiri Slaby282bfd42008-03-28 17:06:41 +0100827static void hid_find_max_report(struct hid_device *hid, unsigned int type,
828 unsigned int *max)
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500829{
830 struct hid_report *report;
Jiri Slaby282bfd42008-03-28 17:06:41 +0100831 unsigned int size;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500832
833 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
Jiri Kosinaefc7ce12008-10-17 15:01:15 +0200834 size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500835 if (*max < size)
836 *max = size;
837 }
838}
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
841{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100842 struct usbhid_device *usbhid = hid->driver_data;
843
Daniel Mack997ea582010-04-12 13:17:25 +0200844 usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100845 &usbhid->inbuf_dma);
Daniel Mack997ea582010-04-12 13:17:25 +0200846 usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100847 &usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500848 usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
Daniel Mack997ea582010-04-12 13:17:25 +0200849 usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
Jiri Slaby898089d2008-11-24 16:20:06 +0100850 &usbhid->ctrlbuf_dma);
851 if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
852 !usbhid->ctrlbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 return -1;
854
855 return 0;
856}
857
Alan Ottb4dbde92011-01-18 03:04:39 -0500858static int usbhid_get_raw_report(struct hid_device *hid,
859 unsigned char report_number, __u8 *buf, size_t count,
860 unsigned char report_type)
861{
862 struct usbhid_device *usbhid = hid->driver_data;
863 struct usb_device *dev = hid_to_usb_dev(hid);
864 struct usb_interface *intf = usbhid->intf;
865 struct usb_host_interface *interface = intf->cur_altsetting;
866 int skipped_report_id = 0;
867 int ret;
868
869 /* Byte 0 is the report number. Report data starts at byte 1.*/
870 buf[0] = report_number;
871 if (report_number == 0x0) {
872 /* Offset the return buffer by 1, so that the report ID
873 will remain in byte 0. */
874 buf++;
875 count--;
876 skipped_report_id = 1;
877 }
878 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
879 HID_REQ_GET_REPORT,
880 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
881 ((report_type + 1) << 8) | report_number,
882 interface->desc.bInterfaceNumber, buf, count,
883 USB_CTRL_SET_TIMEOUT);
884
885 /* count also the report id */
886 if (ret > 0 && skipped_report_id)
887 ret++;
888
889 return ret;
890}
891
Frank Praznik975a6832014-01-22 13:49:42 -0500892static int usbhid_set_raw_report(struct hid_device *hid, unsigned int reportnum,
893 __u8 *buf, size_t count, unsigned char rtype)
894{
895 struct usbhid_device *usbhid = hid->driver_data;
896 struct usb_device *dev = hid_to_usb_dev(hid);
897 struct usb_interface *intf = usbhid->intf;
898 struct usb_host_interface *interface = intf->cur_altsetting;
899 int ret, skipped_report_id = 0;
900
901 /* Byte 0 is the report number. Report data starts at byte 1.*/
Benjamin Tissoirese534a932014-03-08 22:52:42 -0500902 if ((rtype == HID_OUTPUT_REPORT) &&
903 (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORT_ID))
904 buf[0] = 0;
905 else
906 buf[0] = reportnum;
907
Frank Praznik975a6832014-01-22 13:49:42 -0500908 if (buf[0] == 0x0) {
909 /* Don't send the Report ID */
910 buf++;
911 count--;
912 skipped_report_id = 1;
913 }
914
915 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
916 HID_REQ_SET_REPORT,
917 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
918 ((rtype + 1) << 8) | reportnum,
919 interface->desc.bInterfaceNumber, buf, count,
920 USB_CTRL_SET_TIMEOUT);
921 /* count also the report id, if this was a numbered report. */
922 if (ret > 0 && skipped_report_id)
923 ret++;
924
925 return ret;
926}
927
Frank Praznik975a6832014-01-22 13:49:42 -0500928static int usbhid_output_report(struct hid_device *hid, __u8 *buf, size_t count)
929{
930 struct usbhid_device *usbhid = hid->driver_data;
931 struct usb_device *dev = hid_to_usb_dev(hid);
932 int actual_length, skipped_report_id = 0, ret;
933
934 if (!usbhid->urbout)
Benjamin Tissoiresddea1af2014-02-10 12:58:51 -0500935 return -ENOSYS;
Frank Praznik975a6832014-01-22 13:49:42 -0500936
937 if (buf[0] == 0x0) {
938 /* Don't send the Report ID */
939 buf++;
940 count--;
941 skipped_report_id = 1;
942 }
943
944 ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
945 buf, count, &actual_length,
946 USB_CTRL_SET_TIMEOUT);
947 /* return the number of bytes transferred */
948 if (ret == 0) {
949 ret = actual_length;
950 /* count also the report id */
951 if (skipped_report_id)
952 ret++;
953 }
954
955 return ret;
956}
957
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
959{
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100960 struct usbhid_device *usbhid = hid->driver_data;
961
Daniel Mack997ea582010-04-12 13:17:25 +0200962 usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
963 usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
Alan Stern0ede76f2010-03-05 15:10:17 -0500964 kfree(usbhid->cr);
Daniel Mack997ea582010-04-12 13:17:25 +0200965 usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966}
967
Jiri Slabyc500c972008-05-16 11:49:16 +0200968static int usbhid_parse(struct hid_device *hid)
969{
970 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 struct usb_host_interface *interface = intf->cur_altsetting;
972 struct usb_device *dev = interface_to_usbdev (intf);
973 struct hid_descriptor *hdesc;
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200974 u32 quirks = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +0200975 unsigned int rsize = 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500976 char *rdesc;
Jiri Slabyc500c972008-05-16 11:49:16 +0200977 int ret, n;
Jaejoong Kimf043bfc2017-09-28 19:16:30 +0900978 int num_descriptors;
979 size_t offset = offsetof(struct hid_descriptor, desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Benjamin Tissoiresd5d3e202017-11-20 11:48:41 +0100981 quirks = hid_lookup_quirk(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100983 if (quirks & HID_QUIRK_IGNORE)
984 return -ENODEV;
985
Alan Stern0f28b552006-05-15 14:49:04 -0400986 /* Many keyboards and mice don't like to be polled for reports,
987 * so we will always set the HID_QUIRK_NOGET flag for them. */
988 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
989 if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
990 interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
991 quirks |= HID_QUIRK_NOGET;
992 }
993
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500994 if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
995 (!interface->desc.bNumEndpoints ||
996 usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200997 dbg_hid("class descriptor not present\n");
Jiri Slabyc500c972008-05-16 11:49:16 +0200998 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 }
1000
Jaejoong Kimf043bfc2017-09-28 19:16:30 +09001001 if (hdesc->bLength < sizeof(struct hid_descriptor)) {
1002 dbg_hid("hid descriptor is too short\n");
1003 return -EINVAL;
1004 }
1005
Jiri Slabyc500c972008-05-16 11:49:16 +02001006 hid->version = le16_to_cpu(hdesc->bcdHID);
1007 hid->country = hdesc->bCountryCode;
1008
Jaejoong Kimf043bfc2017-09-28 19:16:30 +09001009 num_descriptors = min_t(int, hdesc->bNumDescriptors,
1010 (hdesc->bLength - offset) / sizeof(struct hid_class_descriptor));
1011
1012 for (n = 0; n < num_descriptors; n++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
1014 rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);
1015
1016 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001017 dbg_hid("weird size of report descriptor (%u)\n", rsize);
Jiri Slabyc500c972008-05-16 11:49:16 +02001018 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 }
1020
Joe Perches52150c72017-03-01 17:35:07 -08001021 rdesc = kmalloc(rsize, GFP_KERNEL);
1022 if (!rdesc)
Jiri Slabyc500c972008-05-16 11:49:16 +02001023 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Vojtech Pavlik854561b2005-05-29 02:28:00 -05001025 hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);
1026
Jiri Slabyc500c972008-05-16 11:49:16 +02001027 ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
1028 HID_DT_REPORT, rdesc, rsize);
1029 if (ret < 0) {
Jiri Kosina58037eb2007-05-30 15:07:13 +02001030 dbg_hid("reading report descriptor failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001032 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 }
1034
Jiri Slabyc500c972008-05-16 11:49:16 +02001035 ret = hid_parse_report(hid, rdesc, rsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 kfree(rdesc);
Jiri Slabyc500c972008-05-16 11:49:16 +02001037 if (ret) {
1038 dbg_hid("parsing report descriptor failed\n");
1039 goto err;
1040 }
1041
Zoltan Karcagif5208992009-05-06 16:30:21 +02001042 hid->quirks |= quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Jiri Slabyc500c972008-05-16 11:49:16 +02001044 return 0;
1045err:
1046 return ret;
1047}
1048
1049static int usbhid_start(struct hid_device *hid)
1050{
1051 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1052 struct usb_host_interface *interface = intf->cur_altsetting;
1053 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001054 struct usbhid_device *usbhid = hid->driver_data;
Jiri Slabyc500c972008-05-16 11:49:16 +02001055 unsigned int n, insize = 0;
1056 int ret;
1057
Jiri Slabye3e14de2008-11-01 23:41:46 +01001058 clear_bit(HID_DISCONNECTED, &usbhid->iofl);
1059
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001060 usbhid->bufsize = HID_MIN_BUFFER_SIZE;
1061 hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
1062 hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
1063 hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
1064
1065 if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
1066 usbhid->bufsize = HID_MAX_BUFFER_SIZE;
Michael Haboustakbf0964d2005-09-05 00:12:01 -05001067
1068 hid_find_max_report(hid, HID_INPUT_REPORT, &insize);
1069
1070 if (insize > HID_MAX_BUFFER_SIZE)
1071 insize = HID_MAX_BUFFER_SIZE;
1072
Jiri Slabyc500c972008-05-16 11:49:16 +02001073 if (hid_alloc_buffers(dev, hid)) {
1074 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 goto fail;
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001076 }
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 for (n = 0; n < interface->desc.bNumEndpoints; n++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 struct usb_endpoint_descriptor *endpoint;
1080 int pipe;
1081 int interval;
1082
1083 endpoint = &interface->endpoint[n].desc;
Jiri Slaby581a2732008-11-24 16:20:08 +01001084 if (!usb_endpoint_xfer_int(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 continue;
1086
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 interval = endpoint->bInterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001089 /* Some vendors give fullspeed interval on highspeed devides */
Jiri Slabyc500c972008-05-16 11:49:16 +02001090 if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001091 dev->speed == USB_SPEED_HIGH) {
1092 interval = fls(endpoint->bInterval*8);
Joe Perches52150c72017-03-01 17:35:07 -08001093 pr_info("%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
1094 hid->name, endpoint->bInterval, interval);
Pekka Sarnilaf345c372008-03-06 13:23:14 +01001095 }
1096
Tobias Jakobi933bfe42017-02-25 20:27:27 +01001097 /* Change the polling interval of mice and joysticks. */
1098 switch (hid->collection->usage) {
1099 case HID_GD_MOUSE:
1100 if (hid_mousepoll_interval > 0)
1101 interval = hid_mousepoll_interval;
1102 break;
1103 case HID_GD_JOYSTICK:
1104 if (hid_jspoll_interval > 0)
1105 interval = hid_jspoll_interval;
1106 break;
1107 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05001108
Jiri Slabyc500c972008-05-16 11:49:16 +02001109 ret = -ENOMEM;
Luiz Fernando N. Capitulino0f12aa02006-10-26 13:02:51 -03001110 if (usb_endpoint_dir_in(endpoint)) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001111 if (usbhid->urbin)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001113 if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 goto fail;
1115 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001116 usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 hid_irq_in, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001118 usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
1119 usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 } else {
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001121 if (usbhid->urbout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 continue;
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001123 if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 goto fail;
1125 pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001126 usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 hid_irq_out, hid, interval);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001128 usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
1129 usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 }
1131 }
1132
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001133 usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
Jiri Slabyc500c972008-05-16 11:49:16 +02001134 if (!usbhid->urbctrl) {
1135 ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 goto fail;
Jiri Slabyc500c972008-05-16 11:49:16 +02001137 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001138
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001139 usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
1140 usbhid->ctrlbuf, 1, hid_ctrl, hid);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001141 usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
Alan Stern0ede76f2010-03-05 15:10:17 -05001142 usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Jiri Slabyc500c972008-05-16 11:49:16 +02001143
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001144 set_bit(HID_STARTED, &usbhid->iofl);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001145
Johan Hovold0b750b32014-09-05 18:08:47 +02001146 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1147 ret = usb_autopm_get_interface(usbhid->intf);
1148 if (ret)
1149 goto fail;
Dmitry Torokhov28cbc862017-06-06 23:59:33 -07001150 set_bit(HID_IN_POLLING, &usbhid->iofl);
Johan Hovold0b750b32014-09-05 18:08:47 +02001151 usbhid->intf->needs_remote_wakeup = 1;
1152 ret = hid_start_in(hid);
1153 if (ret) {
1154 dev_err(&hid->dev,
1155 "failed to start in urb: %d\n", ret);
1156 }
1157 usb_autopm_put_interface(usbhid->intf);
1158 }
1159
Alan Stern08ef08e2008-10-30 23:58:51 +01001160 /* Some keyboards don't work until their LEDs have been set.
1161 * Since BIOSes do set the LEDs, it must be safe for any device
1162 * that supports the keyboard boot protocol.
Alan Stern3d615102010-04-02 13:21:58 -04001163 * In addition, enable remote wakeup by default for all keyboard
1164 * devices supporting the boot protocol.
Alan Stern08ef08e2008-10-30 23:58:51 +01001165 */
1166 if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
1167 interface->desc.bInterfaceProtocol ==
Alan Stern3d615102010-04-02 13:21:58 -04001168 USB_INTERFACE_PROTOCOL_KEYBOARD) {
Alan Stern08ef08e2008-10-30 23:58:51 +01001169 usbhid_set_leds(hid);
Alan Stern3d615102010-04-02 13:21:58 -04001170 device_set_wakeup_enable(&dev->dev, 1);
1171 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001172 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
1174fail:
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001175 usb_free_urb(usbhid->urbin);
1176 usb_free_urb(usbhid->urbout);
1177 usb_free_urb(usbhid->urbctrl);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001178 usbhid->urbin = NULL;
1179 usbhid->urbout = NULL;
1180 usbhid->urbctrl = NULL;
Jiri Kosina22f675f2007-08-01 12:32:27 +02001181 hid_free_buffers(dev, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001182 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183}
1184
Jiri Slabyc500c972008-05-16 11:49:16 +02001185static void usbhid_stop(struct hid_device *hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186{
Jiri Slabyc500c972008-05-16 11:49:16 +02001187 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Jiri Slabyc500c972008-05-16 11:49:16 +02001189 if (WARN_ON(!usbhid))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 return;
1191
Dmitry Torokhov28cbc862017-06-06 23:59:33 -07001192 if (hid->quirks & HID_QUIRK_ALWAYS_POLL) {
1193 clear_bit(HID_IN_POLLING, &usbhid->iofl);
Johan Hovold0b750b32014-09-05 18:08:47 +02001194 usbhid->intf->needs_remote_wakeup = 0;
Dmitry Torokhov28cbc862017-06-06 23:59:33 -07001195 }
Johan Hovold0b750b32014-09-05 18:08:47 +02001196
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001197 clear_bit(HID_STARTED, &usbhid->iofl);
Daniel Kurtz4371ea82011-11-17 19:23:50 +08001198 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
Oliver Neukum69626f22008-03-31 16:27:30 +02001199 set_bit(HID_DISCONNECTED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001200 spin_unlock_irq(&usbhid->lock);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001201 usb_kill_urb(usbhid->urbin);
1202 usb_kill_urb(usbhid->urbout);
1203 usb_kill_urb(usbhid->urbctrl);
1204
Oliver Neukum0361a282008-12-17 15:38:03 +01001205 hid_cancel_delayed_stuff(usbhid);
Alan Sternaef4e262006-01-31 12:58:38 -05001206
Jiri Slabyc500c972008-05-16 11:49:16 +02001207 hid->claimed = 0;
1208
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001209 usb_free_urb(usbhid->urbin);
1210 usb_free_urb(usbhid->urbctrl);
1211 usb_free_urb(usbhid->urbout);
Jiri Slabye3e14de2008-11-01 23:41:46 +01001212 usbhid->urbin = NULL; /* don't mess up next start */
1213 usbhid->urbctrl = NULL;
1214 usbhid->urbout = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Anssi Hannulabe820972007-01-19 19:28:17 +02001216 hid_free_buffers(hid_to_usb_dev(hid), hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218
Oliver Neukum0361a282008-12-17 15:38:03 +01001219static int usbhid_power(struct hid_device *hid, int lvl)
1220{
Dmitry Torokhov9a835632017-06-06 23:59:32 -07001221 struct usbhid_device *usbhid = hid->driver_data;
Oliver Neukum0361a282008-12-17 15:38:03 +01001222 int r = 0;
1223
1224 switch (lvl) {
1225 case PM_HINT_FULLON:
Dmitry Torokhov9a835632017-06-06 23:59:32 -07001226 r = usb_autopm_get_interface(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +01001227 break;
Dmitry Torokhov9a835632017-06-06 23:59:32 -07001228
Oliver Neukum0361a282008-12-17 15:38:03 +01001229 case PM_HINT_NORMAL:
Dmitry Torokhov9a835632017-06-06 23:59:32 -07001230 usb_autopm_put_interface(usbhid->intf);
Oliver Neukum0361a282008-12-17 15:38:03 +01001231 break;
1232 }
Dmitry Torokhov9a835632017-06-06 23:59:32 -07001233
Oliver Neukum0361a282008-12-17 15:38:03 +01001234 return r;
1235}
1236
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001237static void usbhid_request(struct hid_device *hid, struct hid_report *rep, int reqtype)
1238{
1239 switch (reqtype) {
1240 case HID_REQ_GET_REPORT:
1241 usbhid_submit_report(hid, rep, USB_DIR_IN);
1242 break;
1243 case HID_REQ_SET_REPORT:
1244 usbhid_submit_report(hid, rep, USB_DIR_OUT);
1245 break;
1246 }
1247}
1248
Frank Praznik975a6832014-01-22 13:49:42 -05001249static int usbhid_raw_request(struct hid_device *hid, unsigned char reportnum,
1250 __u8 *buf, size_t len, unsigned char rtype,
1251 int reqtype)
1252{
1253 switch (reqtype) {
1254 case HID_REQ_GET_REPORT:
1255 return usbhid_get_raw_report(hid, reportnum, buf, len, rtype);
1256 case HID_REQ_SET_REPORT:
1257 return usbhid_set_raw_report(hid, reportnum, buf, len, rtype);
1258 default:
1259 return -EIO;
1260 }
1261}
1262
Benjamin Tissoires96848192013-02-27 16:38:17 +01001263static int usbhid_idle(struct hid_device *hid, int report, int idle,
1264 int reqtype)
1265{
1266 struct usb_device *dev = hid_to_usb_dev(hid);
1267 struct usb_interface *intf = to_usb_interface(hid->dev.parent);
1268 struct usb_host_interface *interface = intf->cur_altsetting;
1269 int ifnum = interface->desc.bInterfaceNumber;
1270
1271 if (reqtype != HID_REQ_SET_IDLE)
1272 return -EINVAL;
1273
1274 return hid_set_idle(dev, ifnum, report, idle);
1275}
1276
Jason Gereckefc2237a2017-07-24 09:46:18 -07001277struct hid_ll_driver usb_hid_driver = {
Jiri Slabyc500c972008-05-16 11:49:16 +02001278 .parse = usbhid_parse,
1279 .start = usbhid_start,
1280 .stop = usbhid_stop,
1281 .open = usbhid_open,
1282 .close = usbhid_close,
Oliver Neukum0361a282008-12-17 15:38:03 +01001283 .power = usbhid_power,
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001284 .request = usbhid_request,
Henrik Rydberg33734432013-02-25 11:31:44 +01001285 .wait = usbhid_wait_io,
Frank Praznik975a6832014-01-22 13:49:42 -05001286 .raw_request = usbhid_raw_request,
1287 .output_report = usbhid_output_report,
Benjamin Tissoires96848192013-02-27 16:38:17 +01001288 .idle = usbhid_idle,
Jiri Slabyc500c972008-05-16 11:49:16 +02001289};
Jason Gereckefc2237a2017-07-24 09:46:18 -07001290EXPORT_SYMBOL_GPL(usb_hid_driver);
Jiri Slabyc500c972008-05-16 11:49:16 +02001291
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001292static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293{
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001294 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Slabyc500c972008-05-16 11:49:16 +02001295 struct usb_device *dev = interface_to_usbdev(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001296 struct usbhid_device *usbhid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 struct hid_device *hid;
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001298 unsigned int n, has_in = 0;
Jiri Slabyc500c972008-05-16 11:49:16 +02001299 size_t len;
1300 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
Jiri Kosina58037eb2007-05-30 15:07:13 +02001302 dbg_hid("HID probe called for ifnum %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 intf->altsetting->desc.bInterfaceNumber);
1304
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001305 for (n = 0; n < interface->desc.bNumEndpoints; n++)
1306 if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
1307 has_in++;
1308 if (!has_in) {
Joe Perches4291ee32010-12-09 19:29:03 -08001309 hid_err(intf, "couldn't find an input interrupt endpoint\n");
Jiri Slaby131d3a7a2008-11-14 12:03:47 +01001310 return -ENODEV;
1311 }
1312
Jiri Slabyc500c972008-05-16 11:49:16 +02001313 hid = hid_allocate_device();
1314 if (IS_ERR(hid))
1315 return PTR_ERR(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
1317 usb_set_intfdata(intf, hid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001318 hid->ll_driver = &usb_hid_driver;
Jiri Slaby76483cf2008-09-18 12:23:33 +02001319 hid->ff_init = hid_pidff_init;
Jiri Slabyc500c972008-05-16 11:49:16 +02001320#ifdef CONFIG_USB_HIDDEV
Jiri Slaby93c10132008-06-27 00:04:24 +02001321 hid->hiddev_connect = hiddev_connect;
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001322 hid->hiddev_disconnect = hiddev_disconnect;
Jiri Slabyc500c972008-05-16 11:49:16 +02001323 hid->hiddev_hid_event = hiddev_hid_event;
1324 hid->hiddev_report_event = hiddev_report_event;
1325#endif
1326 hid->dev.parent = &intf->dev;
1327 hid->bus = BUS_USB;
1328 hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
1329 hid->product = le16_to_cpu(dev->descriptor.idProduct);
Niels Skou Olsend5158e02017-10-04 12:29:57 +02001330 hid->version = le16_to_cpu(dev->descriptor.bcdDevice);
Jiri Slabyc500c972008-05-16 11:49:16 +02001331 hid->name[0] = 0;
Jiri Slabya73a6372008-10-22 14:45:11 +02001332 if (intf->cur_altsetting->desc.bInterfaceProtocol ==
1333 USB_INTERFACE_PROTOCOL_MOUSE)
1334 hid->type = HID_TYPE_USBMOUSE;
Tomoki Sekiyama6dc14182011-05-23 15:45:44 -07001335 else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
1336 hid->type = HID_TYPE_USBNONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
Jiri Slabyc500c972008-05-16 11:49:16 +02001338 if (dev->manufacturer)
1339 strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
1340
1341 if (dev->product) {
1342 if (dev->manufacturer)
1343 strlcat(hid->name, " ", sizeof(hid->name));
1344 strlcat(hid->name, dev->product, sizeof(hid->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 }
1346
Jiri Slabyc500c972008-05-16 11:49:16 +02001347 if (!strlen(hid->name))
1348 snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
1349 le16_to_cpu(dev->descriptor.idVendor),
1350 le16_to_cpu(dev->descriptor.idProduct));
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001351
Jiri Slabyc500c972008-05-16 11:49:16 +02001352 usb_make_path(dev, hid->phys, sizeof(hid->phys));
1353 strlcat(hid->phys, "/input", sizeof(hid->phys));
1354 len = strlen(hid->phys);
1355 if (len < sizeof(hid->phys) - 1)
1356 snprintf(hid->phys + len, sizeof(hid->phys) - len,
1357 "%d", intf->altsetting[0].desc.bInterfaceNumber);
Geoff Levand4a1a4d82007-01-15 20:11:52 -08001358
Jiri Slabyc500c972008-05-16 11:49:16 +02001359 if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
1360 hid->uniq[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001362 usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
1363 if (usbhid == NULL) {
1364 ret = -ENOMEM;
1365 goto err;
1366 }
1367
1368 hid->driver_data = usbhid;
1369 usbhid->hid = hid;
Jiri Kosina57ab12e2010-02-17 14:25:01 +01001370 usbhid->intf = intf;
1371 usbhid->ifnum = interface->desc.bInterfaceNumber;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001372
Alan Sternfde4e2f2010-05-07 10:41:10 -04001373 init_waitqueue_head(&usbhid->wait);
1374 INIT_WORK(&usbhid->reset_work, hid_reset);
Kees Cook0ee32772017-10-04 17:53:24 -07001375 timer_setup(&usbhid->io_retry, hid_retry_timeout, 0);
Alan Sternfde4e2f2010-05-07 10:41:10 -04001376 spin_lock_init(&usbhid->lock);
1377
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001378 ret = hid_add_device(hid);
1379 if (ret) {
Jiri Slabyd458a9d2008-05-16 11:49:20 +02001380 if (ret != -ENODEV)
Joe Perches4291ee32010-12-09 19:29:03 -08001381 hid_err(intf, "can't add hid device: %d\n", ret);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001382 goto err_free;
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001383 }
Jiri Slabyc500c972008-05-16 11:49:16 +02001384
1385 return 0;
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001386err_free:
1387 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001388err:
1389 hid_destroy_device(hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001390 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
1392
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001393static void usbhid_disconnect(struct usb_interface *intf)
Jiri Slabyc500c972008-05-16 11:49:16 +02001394{
1395 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001396 struct usbhid_device *usbhid;
Jiri Slabyc500c972008-05-16 11:49:16 +02001397
1398 if (WARN_ON(!hid))
1399 return;
1400
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001401 usbhid = hid->driver_data;
Reyad Attiyat46df9deda2014-07-25 00:13:01 -05001402 spin_lock_irq(&usbhid->lock); /* Sync with error and led handlers */
1403 set_bit(HID_DISCONNECTED, &usbhid->iofl);
1404 spin_unlock_irq(&usbhid->lock);
Jiri Slabyc500c972008-05-16 11:49:16 +02001405 hid_destroy_device(hid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001406 kfree(usbhid);
Jiri Slabyc500c972008-05-16 11:49:16 +02001407}
1408
Oliver Neukum0361a282008-12-17 15:38:03 +01001409static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
Oliver Neukum0361a282008-12-17 15:38:03 +01001411 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001412 cancel_work_sync(&usbhid->reset_work);
1413}
1414
1415static void hid_cease_io(struct usbhid_device *usbhid)
1416{
Oliver Neukumfad9fbe82011-10-13 18:21:58 +02001417 del_timer_sync(&usbhid->io_retry);
Oliver Neukum0361a282008-12-17 15:38:03 +01001418 usb_kill_urb(usbhid->urbin);
1419 usb_kill_urb(usbhid->urbctrl);
1420 usb_kill_urb(usbhid->urbout);
Oliver Neukum0361a282008-12-17 15:38:03 +01001421}
1422
Alan Stern972e6a92016-03-23 12:17:09 -04001423static void hid_restart_io(struct hid_device *hid)
1424{
1425 struct usbhid_device *usbhid = hid->driver_data;
1426 int clear_halt = test_bit(HID_CLEAR_HALT, &usbhid->iofl);
1427 int reset_pending = test_bit(HID_RESET_PENDING, &usbhid->iofl);
1428
1429 spin_lock_irq(&usbhid->lock);
1430 clear_bit(HID_SUSPENDED, &usbhid->iofl);
1431 usbhid_mark_busy(usbhid);
1432
1433 if (clear_halt || reset_pending)
1434 schedule_work(&usbhid->reset_work);
1435 usbhid->retry_delay = 0;
1436 spin_unlock_irq(&usbhid->lock);
1437
1438 if (reset_pending || !test_bit(HID_STARTED, &usbhid->iofl))
1439 return;
1440
1441 if (!clear_halt) {
1442 if (hid_start_in(hid) < 0)
1443 hid_io_error(hid);
1444 }
1445
1446 spin_lock_irq(&usbhid->lock);
1447 if (usbhid->urbout && !test_bit(HID_OUT_RUNNING, &usbhid->iofl))
1448 usbhid_restart_out_queue(usbhid);
1449 if (!test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
1450 usbhid_restart_ctrl_queue(usbhid);
1451 spin_unlock_irq(&usbhid->lock);
1452}
1453
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001454/* Treat USB reset pretty much the same as suspend/resume */
1455static int hid_pre_reset(struct usb_interface *intf)
1456{
1457 struct hid_device *hid = usb_get_intfdata(intf);
Jiri Kosina4916b3a2006-12-08 18:41:03 +01001458 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001460 spin_lock_irq(&usbhid->lock);
1461 set_bit(HID_RESET_PENDING, &usbhid->iofl);
1462 spin_unlock_irq(&usbhid->lock);
1463 hid_cease_io(usbhid);
Jiri Slaby3d5afd32008-10-27 12:16:15 +01001464
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001465 return 0;
1466}
1467
1468/* Same routine used for post_reset and reset_resume */
1469static int hid_post_reset(struct usb_interface *intf)
1470{
1471 struct usb_device *dev = interface_to_usbdev (intf);
1472 struct hid_device *hid = usb_get_intfdata(intf);
1473 struct usbhid_device *usbhid = hid->driver_data;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001474 struct usb_host_interface *interface = intf->cur_altsetting;
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001475 int status;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001476 char *rdesc;
1477
1478 /* Fetch and examine the HID report descriptor. If this
1479 * has changed, then rebind. Since usbcore's check of the
1480 * configuration descriptors passed, we already know that
1481 * the size of the HID report descriptor has not changed.
1482 */
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001483 rdesc = kmalloc(hid->dev_rsize, GFP_KERNEL);
Joe Perches52150c72017-03-01 17:35:07 -08001484 if (!rdesc)
Pan Bianc60fa552016-12-05 19:37:24 +08001485 return -ENOMEM;
Joe Perches52150c72017-03-01 17:35:07 -08001486
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001487 status = hid_get_class_descriptor(dev,
1488 interface->desc.bInterfaceNumber,
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001489 HID_DT_REPORT, rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001490 if (status < 0) {
1491 dbg_hid("reading report descriptor failed (post_reset)\n");
1492 kfree(rdesc);
Pan Bianc60fa552016-12-05 19:37:24 +08001493 return status;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001494 }
Kevin Daughtridge86e6b772012-09-20 12:00:32 -07001495 status = memcmp(rdesc, hid->dev_rdesc, hid->dev_rsize);
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001496 kfree(rdesc);
1497 if (status != 0) {
1498 dbg_hid("report descriptor changed\n");
Pan Bianc60fa552016-12-05 19:37:24 +08001499 return -EPERM;
Simon Haggettdc3c78e2012-04-03 16:04:15 +01001500 }
Jiri Kosina70fa9f22009-06-04 15:48:38 +02001501
Alan Stern972e6a92016-03-23 12:17:09 -04001502 /* No need to do another reset or clear a halted endpoint */
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001503 spin_lock_irq(&usbhid->lock);
1504 clear_bit(HID_RESET_PENDING, &usbhid->iofl);
Alan Stern972e6a92016-03-23 12:17:09 -04001505 clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001506 spin_unlock_irq(&usbhid->lock);
1507 hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
Alan Stern972e6a92016-03-23 12:17:09 -04001508
1509 hid_restart_io(hid);
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001510
1511 return 0;
1512}
1513
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001514#ifdef CONFIG_PM
Alan Sterneb055fd2012-07-19 16:09:01 -04001515static int hid_resume_common(struct hid_device *hid, bool driver_suspended)
1516{
Alan Stern972e6a92016-03-23 12:17:09 -04001517 int status = 0;
Alan Sterneb055fd2012-07-19 16:09:01 -04001518
Alan Stern972e6a92016-03-23 12:17:09 -04001519 hid_restart_io(hid);
Alan Sterneb055fd2012-07-19 16:09:01 -04001520 if (driver_suspended && hid->driver && hid->driver->resume)
1521 status = hid->driver->resume(hid);
1522 return status;
1523}
1524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525static int hid_suspend(struct usb_interface *intf, pm_message_t message)
1526{
Oliver Neukum0361a282008-12-17 15:38:03 +01001527 struct hid_device *hid = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 struct usbhid_device *usbhid = hid->driver_data;
Ming Lei37093b72013-03-15 12:08:55 +08001529 int status = 0;
Alan Sterneb055fd2012-07-19 16:09:01 -04001530 bool driver_suspended = false;
David Herrmannbfde79c2013-07-15 19:10:13 +02001531 unsigned int ledcount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Alan Stern5b1b0b82011-08-19 23:49:48 +02001533 if (PMSG_IS_AUTO(message)) {
David Herrmannbfde79c2013-07-15 19:10:13 +02001534 ledcount = hidinput_count_leds(hid);
Oliver Neukum0361a282008-12-17 15:38:03 +01001535 spin_lock_irq(&usbhid->lock); /* Sync with error handler */
1536 if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
1537 && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
1538 && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
1539 && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
1540 && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
David Herrmannbfde79c2013-07-15 19:10:13 +02001541 && (!ledcount || ignoreled))
Oliver Neukum0361a282008-12-17 15:38:03 +01001542 {
Alan Sternf2b52642012-07-19 16:08:45 -04001543 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001544 spin_unlock_irq(&usbhid->lock);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001545 if (hid->driver && hid->driver->suspend) {
1546 status = hid->driver->suspend(hid, message);
1547 if (status < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001548 goto failed;
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001549 }
Alan Sterneb055fd2012-07-19 16:09:01 -04001550 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001551 } else {
1552 usbhid_mark_busy(usbhid);
1553 spin_unlock_irq(&usbhid->lock);
1554 return -EBUSY;
1555 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Oliver Neukum0361a282008-12-17 15:38:03 +01001557 } else {
Ming Lei37093b72013-03-15 12:08:55 +08001558 /* TODO: resume() might need to handle suspend failure */
1559 if (hid->driver && hid->driver->suspend)
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001560 status = hid->driver->suspend(hid, message);
Alan Sterneb055fd2012-07-19 16:09:01 -04001561 driver_suspended = true;
Oliver Neukum0361a282008-12-17 15:38:03 +01001562 spin_lock_irq(&usbhid->lock);
Alan Sternf2b52642012-07-19 16:08:45 -04001563 set_bit(HID_SUSPENDED, &usbhid->iofl);
Oliver Neukum0361a282008-12-17 15:38:03 +01001564 spin_unlock_irq(&usbhid->lock);
Ming Lei37093b72013-03-15 12:08:55 +08001565 if (usbhid_wait_io(hid) < 0)
Alan Sterneb055fd2012-07-19 16:09:01 -04001566 status = -EIO;
Oliver Neukum0361a282008-12-17 15:38:03 +01001567 }
1568
Oliver Neukum0361a282008-12-17 15:38:03 +01001569 hid_cancel_delayed_stuff(usbhid);
1570 hid_cease_io(usbhid);
1571
Alan Stern5b1b0b82011-08-19 23:49:48 +02001572 if (PMSG_IS_AUTO(message) && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
Oliver Neukum0361a282008-12-17 15:38:03 +01001573 /* lost race against keypresses */
Alan Sterneb055fd2012-07-19 16:09:01 -04001574 status = -EBUSY;
1575 goto failed;
Oliver Neukum0361a282008-12-17 15:38:03 +01001576 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 dev_dbg(&intf->dev, "suspend\n");
Ming Lei37093b72013-03-15 12:08:55 +08001578 return status;
Alan Sterneb055fd2012-07-19 16:09:01 -04001579
1580 failed:
1581 hid_resume_common(hid, driver_suspended);
1582 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583}
1584
1585static int hid_resume(struct usb_interface *intf)
1586{
1587 struct hid_device *hid = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 int status;
1589
Alan Sterneb055fd2012-07-19 16:09:01 -04001590 status = hid_resume_common(hid, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 dev_dbg(&intf->dev, "resume status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 return 0;
1593}
1594
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001595static int hid_reset_resume(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001597 struct hid_device *hid = usb_get_intfdata(intf);
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001598 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Bruno Prémont6a740aa2010-04-25 21:40:03 +02001600 status = hid_post_reset(intf);
1601 if (status >= 0 && hid->driver && hid->driver->reset_resume) {
1602 int ret = hid->driver->reset_resume(hid);
1603 if (ret < 0)
1604 status = ret;
1605 }
1606 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607}
1608
Jiri Kosinaae2f0072009-02-20 12:47:08 +01001609#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Márton Némethd67dec52010-01-10 17:59:22 +01001611static const struct usb_device_id hid_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1613 .bInterfaceClass = USB_INTERFACE_CLASS_HID },
1614 { } /* Terminating entry */
1615};
1616
1617MODULE_DEVICE_TABLE (usb, hid_usb_ids);
1618
1619static struct usb_driver hid_driver = {
1620 .name = "usbhid",
Jiri Kosinac4c259b2009-09-15 16:27:45 +02001621 .probe = usbhid_probe,
1622 .disconnect = usbhid_disconnect,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001623#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 .suspend = hid_suspend,
1625 .resume = hid_resume,
Oliver Neukum378a0ed2009-02-18 11:46:45 +01001626 .reset_resume = hid_reset_resume,
Jiri Kosina0f6f1402009-01-19 09:17:18 +01001627#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 .pre_reset = hid_pre_reset,
1629 .post_reset = hid_post_reset,
1630 .id_table = hid_usb_ids,
Oliver Neukum933e3182007-07-11 14:48:58 +02001631 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632};
1633
Guillaume Chazarain8fe294c2010-09-12 21:32:35 +02001634struct usb_interface *usbhid_find_interface(int minor)
1635{
1636 return usb_find_interface(&hid_driver, minor);
1637}
1638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639static int __init hid_init(void)
1640{
Oliver Neukum0361a282008-12-17 15:38:03 +01001641 int retval = -ENOMEM;
1642
Benjamin Tissoiresd5d3e202017-11-20 11:48:41 +01001643 retval = hid_quirks_init(quirks_param, BUS_USB, MAX_USBHID_BOOT_QUIRKS);
Paul Walmsley876b9272007-04-19 14:56:12 +02001644 if (retval)
1645 goto usbhid_quirks_init_fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 retval = usb_register(&hid_driver);
1647 if (retval)
1648 goto usb_register_fail;
Joe Perches52150c72017-03-01 17:35:07 -08001649 pr_info(KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
1651 return 0;
1652usb_register_fail:
Benjamin Tissoiresd5d3e202017-11-20 11:48:41 +01001653 hid_quirks_exit(BUS_USB);
Paul Walmsley876b9272007-04-19 14:56:12 +02001654usbhid_quirks_init_fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 return retval;
1656}
1657
1658static void __exit hid_exit(void)
1659{
1660 usb_deregister(&hid_driver);
Benjamin Tissoiresd5d3e202017-11-20 11:48:41 +01001661 hid_quirks_exit(BUS_USB);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662}
1663
1664module_init(hid_init);
1665module_exit(hid_exit);
1666
Jiri Kosina88adb722009-10-02 18:29:34 +02001667MODULE_AUTHOR("Andreas Gal");
1668MODULE_AUTHOR("Vojtech Pavlik");
1669MODULE_AUTHOR("Jiri Kosina");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670MODULE_DESCRIPTION(DRIVER_DESC);
Grant Grundler7021b602017-01-05 11:07:04 -08001671MODULE_LICENSE("GPL");