hid-core.c 40.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
 *  USB HID support for Linux
 *
 *  Copyright (c) 1999 Andreas Gal
5 6
 *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
 *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7
 *  Copyright (c) 2007-2008 Oliver Neukum
J
Jiri Kosina 已提交
8
 *  Copyright (c) 2006-2010 Jiri Kosina
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 */

/*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/mm.h>
24
#include <linux/mutex.h>
L
Linus Torvalds 已提交
25 26 27 28 29
#include <linux/spinlock.h>
#include <asm/unaligned.h>
#include <asm/byteorder.h>
#include <linux/input.h>
#include <linux/wait.h>
30
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
31 32 33

#include <linux/usb.h>

34
#include <linux/hid.h>
L
Linus Torvalds 已提交
35
#include <linux/hiddev.h>
36
#include <linux/hid-debug.h>
J
Jiri Kosina 已提交
37
#include <linux/hidraw.h>
J
Jiri Kosina 已提交
38
#include "usbhid.h"
L
Linus Torvalds 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

/*
 * Version Information
 */

#define DRIVER_DESC "USB HID core driver"
#define DRIVER_LICENSE "GPL"

/*
 * Module parameters.
 */

static unsigned int hid_mousepoll_interval;
module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
MODULE_PARM_DESC(mousepoll, "Polling interval of mice");

55 56 57 58
static unsigned int ignoreled;
module_param_named(ignoreled, ignoreled, uint, 0644);
MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");

59 60 61 62 63 64 65
/* Quirks specified at module load time */
static char *quirks_param[MAX_USBHID_BOOT_QUIRKS] = { [ 0 ... (MAX_USBHID_BOOT_QUIRKS - 1) ] = NULL };
module_param_array_named(quirks, quirks_param, charp, NULL, 0444);
MODULE_PARM_DESC(quirks, "Add/modify USB HID quirks by specifying "
		" quirks=vendorID:productID:quirks"
		" where vendorID, productID, and quirks are all in"
		" 0x-prefixed hex");
L
Linus Torvalds 已提交
66
/*
67
 * Input submission and I/O error handler.
L
Linus Torvalds 已提交
68
 */
69
static DEFINE_MUTEX(hid_open_mut);
L
Linus Torvalds 已提交
70

71
static void hid_io_error(struct hid_device *hid);
72 73 74
static int hid_submit_out(struct hid_device *hid);
static int hid_submit_ctrl(struct hid_device *hid);
static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid);
75 76 77

/* Start up the input URB */
static int hid_start_in(struct hid_device *hid)
L
Linus Torvalds 已提交
78 79
{
	unsigned long flags;
80 81
	int rc = 0;
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
82

83 84
	spin_lock_irqsave(&usbhid->lock, flags);
	if (hid->open > 0 &&
85
			!test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
86
			!test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
87 88 89 90
			!test_and_set_bit(HID_IN_RUNNING, &usbhid->iofl)) {
		rc = usb_submit_urb(usbhid->urbin, GFP_ATOMIC);
		if (rc != 0)
			clear_bit(HID_IN_RUNNING, &usbhid->iofl);
L
Linus Torvalds 已提交
91
	}
92
	spin_unlock_irqrestore(&usbhid->lock, flags);
93
	return rc;
L
Linus Torvalds 已提交
94 95
}

96 97
/* I/O retry timer routine */
static void hid_retry_timeout(unsigned long _hid)
L
Linus Torvalds 已提交
98
{
99
	struct hid_device *hid = (struct hid_device *) _hid;
J
Jiri Kosina 已提交
100
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
101

102 103 104
	dev_dbg(&usbhid->intf->dev, "retrying intr urb\n");
	if (hid_start_in(hid))
		hid_io_error(hid);
L
Linus Torvalds 已提交
105 106
}

107 108
/* Workqueue routine to reset the device or clear a halt */
static void hid_reset(struct work_struct *work)
L
Linus Torvalds 已提交
109
{
110 111 112
	struct usbhid_device *usbhid =
		container_of(work, struct usbhid_device, reset_work);
	struct hid_device *hid = usbhid->hid;
113
	int rc = 0;
L
Linus Torvalds 已提交
114

115 116 117 118 119 120
	if (test_bit(HID_CLEAR_HALT, &usbhid->iofl)) {
		dev_dbg(&usbhid->intf->dev, "clear halt\n");
		rc = usb_clear_halt(hid_to_usb_dev(hid), usbhid->urbin->pipe);
		clear_bit(HID_CLEAR_HALT, &usbhid->iofl);
		hid_start_in(hid);
	}
L
Linus Torvalds 已提交
121

122 123
	else if (test_bit(HID_RESET_PENDING, &usbhid->iofl)) {
		dev_dbg(&usbhid->intf->dev, "resetting device\n");
124 125
		rc = usb_lock_device_for_reset(hid_to_usb_dev(hid), usbhid->intf);
		if (rc == 0) {
126
			rc = usb_reset_device(hid_to_usb_dev(hid));
127
			usb_unlock_device(hid_to_usb_dev(hid));
L
Linus Torvalds 已提交
128
		}
129
		clear_bit(HID_RESET_PENDING, &usbhid->iofl);
L
Linus Torvalds 已提交
130 131
	}

132 133 134 135 136 137
	switch (rc) {
	case 0:
		if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
			hid_io_error(hid);
		break;
	default:
138 139 140 141
		hid_err(hid, "can't reset device, %s-%s/input%d, status %d\n",
			hid_to_usb_dev(hid)->bus->bus_name,
			hid_to_usb_dev(hid)->devpath,
			usbhid->ifnum, rc);
142 143 144 145 146
		/* FALLTHROUGH */
	case -EHOSTUNREACH:
	case -ENODEV:
	case -EINTR:
		break;
L
Linus Torvalds 已提交
147 148 149
	}
}

150 151
/* Main I/O error handler */
static void hid_io_error(struct hid_device *hid)
152
{
153 154
	unsigned long flags;
	struct usbhid_device *usbhid = hid->driver_data;
155

156
	spin_lock_irqsave(&usbhid->lock, flags);
157

158
	/* Stop when disconnected */
159
	if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
160
		goto done;
161

A
Alan Stern 已提交
162 163 164 165 166
	/* If it has been a while since the last error, we'll assume
	 * this a brand new error and reset the retry timeout. */
	if (time_after(jiffies, usbhid->stop_retry + HZ/2))
		usbhid->retry_delay = 0;

167 168 169 170 171 172
	/* When an error occurs, retry at increasing intervals */
	if (usbhid->retry_delay == 0) {
		usbhid->retry_delay = 13;	/* Then 26, 52, 104, 104, ... */
		usbhid->stop_retry = jiffies + msecs_to_jiffies(1000);
	} else if (usbhid->retry_delay < 100)
		usbhid->retry_delay *= 2;
173

174
	if (time_after(jiffies, usbhid->stop_retry)) {
J
Jiri Kosina 已提交
175

176 177 178 179 180
		/* Retries failed, so do a port reset */
		if (!test_and_set_bit(HID_RESET_PENDING, &usbhid->iofl)) {
			schedule_work(&usbhid->reset_work);
			goto done;
		}
L
Linus Torvalds 已提交
181 182
	}

183 184 185
	mod_timer(&usbhid->io_retry,
			jiffies + msecs_to_jiffies(usbhid->retry_delay));
done:
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
	spin_unlock_irqrestore(&usbhid->lock, flags);
}

static void usbhid_mark_busy(struct usbhid_device *usbhid)
{
	struct usb_interface *intf = usbhid->intf;

	usb_mark_last_busy(interface_to_usbdev(intf));
}

static int usbhid_restart_out_queue(struct usbhid_device *usbhid)
{
	struct hid_device *hid = usb_get_intfdata(usbhid->intf);
	int kicked;

	if (!hid)
		return 0;

	if ((kicked = (usbhid->outhead != usbhid->outtail))) {
		dbg("Kicking head %d tail %d", usbhid->outhead, usbhid->outtail);
		if (hid_submit_out(hid)) {
			clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
			wake_up(&usbhid->wait);
		}
	}
	return kicked;
}

static int usbhid_restart_ctrl_queue(struct usbhid_device *usbhid)
{
	struct hid_device *hid = usb_get_intfdata(usbhid->intf);
	int kicked;

	WARN_ON(hid == NULL);
	if (!hid)
		return 0;

	if ((kicked = (usbhid->ctrlhead != usbhid->ctrltail))) {
		dbg("Kicking head %d tail %d", usbhid->ctrlhead, usbhid->ctrltail);
		if (hid_submit_ctrl(hid)) {
			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
			wake_up(&usbhid->wait);
		}
	}
	return kicked;
L
Linus Torvalds 已提交
231 232
}

233 234 235
/*
 * Input interrupt completion handler.
 */
236

237
static void hid_irq_in(struct urb *urb)
L
Linus Torvalds 已提交
238
{
239 240 241
	struct hid_device	*hid = urb->context;
	struct usbhid_device 	*usbhid = hid->driver_data;
	int			status;
L
Linus Torvalds 已提交
242

243
	switch (urb->status) {
J
Jiri Slaby 已提交
244
	case 0:			/* success */
245
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
246 247 248 249
		usbhid->retry_delay = 0;
		hid_input_report(urb->context, HID_INPUT_REPORT,
				 urb->transfer_buffer,
				 urb->actual_length, 1);
250 251 252 253 254 255 256 257 258
		/*
		 * autosuspend refused while keys are pressed
		 * because most keyboards don't wake up when
		 * a key is released
		 */
		if (hid_check_keys_pressed(hid))
			set_bit(HID_KEYS_PRESSED, &usbhid->iofl);
		else
			clear_bit(HID_KEYS_PRESSED, &usbhid->iofl);
J
Jiri Slaby 已提交
259 260
		break;
	case -EPIPE:		/* stall */
261
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
262 263 264 265 266 267 268 269 270 271 272 273 274
		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
		set_bit(HID_CLEAR_HALT, &usbhid->iofl);
		schedule_work(&usbhid->reset_work);
		return;
	case -ECONNRESET:	/* unlink */
	case -ENOENT:
	case -ESHUTDOWN:	/* unplug */
		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
		return;
	case -EILSEQ:		/* protocol error or unplug */
	case -EPROTO:		/* protocol error or unplug */
	case -ETIME:		/* protocol error or unplug */
	case -ETIMEDOUT:	/* Should never happen, but... */
275
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
276 277 278 279
		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
		hid_io_error(hid);
		return;
	default:		/* error */
280 281
		hid_warn(urb->dev, "input irq status %d received\n",
			 urb->status);
282
	}
L
Linus Torvalds 已提交
283

284 285 286 287
	status = usb_submit_urb(urb, GFP_ATOMIC);
	if (status) {
		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
		if (status != -EPERM) {
288 289 290 291
			hid_err(hid, "can't resubmit intr, %s-%s/input%d, status %d\n",
				hid_to_usb_dev(hid)->bus->bus_name,
				hid_to_usb_dev(hid)->devpath,
				usbhid->ifnum, status);
292 293 294
			hid_io_error(hid);
		}
	}
L
Linus Torvalds 已提交
295 296
}

297
static int hid_submit_out(struct hid_device *hid)
L
Linus Torvalds 已提交
298
{
299
	struct hid_report *report;
300
	char *raw_report;
J
Jiri Kosina 已提交
301
	struct usbhid_device *usbhid = hid->driver_data;
302
	int r;
J
Jiri Kosina 已提交
303

304 305
	report = usbhid->out[usbhid->outtail].report;
	raw_report = usbhid->out[usbhid->outtail].raw_report;
L
Linus Torvalds 已提交
306

307 308 309 310 311 312 313 314
	r = usb_autopm_get_interface_async(usbhid->intf);
	if (r < 0)
		return -1;

	/*
	 * if the device hasn't been woken, we leave the output
	 * to resume()
	 */
315 316 317 318 319
	if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
		usbhid->urbout->transfer_buffer_length = ((report->size - 1) >> 3) + 1 + (report->id > 0);
		usbhid->urbout->dev = hid_to_usb_dev(hid);
		memcpy(usbhid->outbuf, raw_report, usbhid->urbout->transfer_buffer_length);
		kfree(raw_report);
320

321
		dbg_hid("submitting out urb\n");
322

323
		if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
324
			hid_err(hid, "usb_submit_urb(out) failed\n");
325
			usb_autopm_put_interface_async(usbhid->intf);
326 327
			return -1;
		}
328
		usbhid->last_out = jiffies;
329
	}
L
Linus Torvalds 已提交
330

331 332 333 334
	return 0;
}

static int hid_submit_ctrl(struct hid_device *hid)
L
Linus Torvalds 已提交
335 336
{
	struct hid_report *report;
337
	unsigned char dir;
338
	char *raw_report;
339
	int len, r;
J
Jiri Kosina 已提交
340
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
341

342
	report = usbhid->ctrl[usbhid->ctrltail].report;
343
	raw_report = usbhid->ctrl[usbhid->ctrltail].raw_report;
344
	dir = usbhid->ctrl[usbhid->ctrltail].dir;
L
Linus Torvalds 已提交
345

346 347 348
	r = usb_autopm_get_interface_async(usbhid->intf);
	if (r < 0)
		return -1;
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
	if (!test_bit(HID_REPORTED_IDLE, &usbhid->iofl)) {
		len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
		if (dir == USB_DIR_OUT) {
			usbhid->urbctrl->pipe = usb_sndctrlpipe(hid_to_usb_dev(hid), 0);
			usbhid->urbctrl->transfer_buffer_length = len;
			memcpy(usbhid->ctrlbuf, raw_report, len);
			kfree(raw_report);
		} else {
			int maxpacket, padlen;

			usbhid->urbctrl->pipe = usb_rcvctrlpipe(hid_to_usb_dev(hid), 0);
			maxpacket = usb_maxpacket(hid_to_usb_dev(hid), usbhid->urbctrl->pipe, 0);
			if (maxpacket > 0) {
				padlen = DIV_ROUND_UP(len, maxpacket);
				padlen *= maxpacket;
				if (padlen > usbhid->bufsize)
					padlen = usbhid->bufsize;
			} else
				padlen = 0;
			usbhid->urbctrl->transfer_buffer_length = padlen;
		}
		usbhid->urbctrl->dev = hid_to_usb_dev(hid);
L
Linus Torvalds 已提交
371

372 373 374 375 376
		usbhid->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | dir;
		usbhid->cr->bRequest = (dir == USB_DIR_OUT) ? HID_REQ_SET_REPORT : HID_REQ_GET_REPORT;
		usbhid->cr->wValue = cpu_to_le16(((report->type + 1) << 8) | report->id);
		usbhid->cr->wIndex = cpu_to_le16(usbhid->ifnum);
		usbhid->cr->wLength = cpu_to_le16(len);
L
Linus Torvalds 已提交
377

378 379 380
		dbg_hid("submitting ctrl urb: %s wValue=0x%04x wIndex=0x%04x wLength=%u\n",
			usbhid->cr->bRequest == HID_REQ_SET_REPORT ? "Set_Report" : "Get_Report",
			usbhid->cr->wValue, usbhid->cr->wIndex, usbhid->cr->wLength);
L
Linus Torvalds 已提交
381

382
		if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
383
			usb_autopm_put_interface_async(usbhid->intf);
384
			hid_err(hid, "usb_submit_urb(ctrl) failed\n");
385 386
			return -1;
		}
387
		usbhid->last_ctrl = jiffies;
388
	}
L
Linus Torvalds 已提交
389

390 391
	return 0;
}
L
Linus Torvalds 已提交
392

393 394 395
/*
 * Output interrupt completion handler.
 */
L
Linus Torvalds 已提交
396

397 398 399 400 401 402
static void hid_irq_out(struct urb *urb)
{
	struct hid_device *hid = urb->context;
	struct usbhid_device *usbhid = hid->driver_data;
	unsigned long flags;
	int unplug = 0;
L
Linus Torvalds 已提交
403

404
	switch (urb->status) {
J
Jiri Slaby 已提交
405 406 407 408 409 410 411 412 413 414
	case 0:			/* success */
		break;
	case -ESHUTDOWN:	/* unplug */
		unplug = 1;
	case -EILSEQ:		/* protocol error or unplug */
	case -EPROTO:		/* protocol error or unplug */
	case -ECONNRESET:	/* unlink */
	case -ENOENT:
		break;
	default:		/* error */
415 416
		hid_warn(urb->dev, "output irq status %d received\n",
			 urb->status);
417
	}
L
Linus Torvalds 已提交
418

419
	spin_lock_irqsave(&usbhid->lock, flags);
L
Linus Torvalds 已提交
420

421 422 423 424
	if (unplug)
		usbhid->outtail = usbhid->outhead;
	else
		usbhid->outtail = (usbhid->outtail + 1) & (HID_OUTPUT_FIFO_SIZE - 1);
L
Linus Torvalds 已提交
425

426 427 428
	if (usbhid->outhead != usbhid->outtail) {
		if (hid_submit_out(hid)) {
			clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
J
Jiri Slaby 已提交
429
			wake_up(&usbhid->wait);
430
		}
431
		spin_unlock_irqrestore(&usbhid->lock, flags);
432 433
		return;
	}
L
Linus Torvalds 已提交
434

435
	clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
436
	spin_unlock_irqrestore(&usbhid->lock, flags);
437
	usb_autopm_put_interface_async(usbhid->intf);
J
Jiri Slaby 已提交
438
	wake_up(&usbhid->wait);
439
}
440

441 442 443
/*
 * Control pipe completion handler.
 */
L
Linus Torvalds 已提交
444

445 446 447 448
static void hid_ctrl(struct urb *urb)
{
	struct hid_device *hid = urb->context;
	struct usbhid_device *usbhid = hid->driver_data;
449
	int unplug = 0, status = urb->status;
L
Linus Torvalds 已提交
450

451
	spin_lock(&usbhid->lock);
L
Linus Torvalds 已提交
452

453
	switch (status) {
J
Jiri Slaby 已提交
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
	case 0:			/* success */
		if (usbhid->ctrl[usbhid->ctrltail].dir == USB_DIR_IN)
			hid_input_report(urb->context,
				usbhid->ctrl[usbhid->ctrltail].report->type,
				urb->transfer_buffer, urb->actual_length, 0);
		break;
	case -ESHUTDOWN:	/* unplug */
		unplug = 1;
	case -EILSEQ:		/* protocol error or unplug */
	case -EPROTO:		/* protocol error or unplug */
	case -ECONNRESET:	/* unlink */
	case -ENOENT:
	case -EPIPE:		/* report not available */
		break;
	default:		/* error */
469
		hid_warn(urb->dev, "ctrl urb status %d received\n", status);
470
	}
L
Linus Torvalds 已提交
471

472 473 474 475
	if (unplug)
		usbhid->ctrltail = usbhid->ctrlhead;
	else
		usbhid->ctrltail = (usbhid->ctrltail + 1) & (HID_CONTROL_FIFO_SIZE - 1);
L
Linus Torvalds 已提交
476

477 478 479
	if (usbhid->ctrlhead != usbhid->ctrltail) {
		if (hid_submit_ctrl(hid)) {
			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
J
Jiri Slaby 已提交
480
			wake_up(&usbhid->wait);
481
		}
482
		spin_unlock(&usbhid->lock);
483
		usb_autopm_put_interface_async(usbhid->intf);
484 485
		return;
	}
L
Linus Torvalds 已提交
486

487
	clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
488
	spin_unlock(&usbhid->lock);
489
	usb_autopm_put_interface_async(usbhid->intf);
J
Jiri Slaby 已提交
490
	wake_up(&usbhid->wait);
491
}
L
Linus Torvalds 已提交
492

493 494
static void __usbhid_submit_report(struct hid_device *hid, struct hid_report *report,
				   unsigned char dir)
495 496 497
{
	int head;
	struct usbhid_device *usbhid = hid->driver_data;
498
	int len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
L
Linus Torvalds 已提交
499

500 501
	if ((hid->quirks & HID_QUIRK_NOGET) && dir == USB_DIR_IN)
		return;
502

503 504
	if (usbhid->urbout && dir == USB_DIR_OUT && report->type == HID_OUTPUT_REPORT) {
		if ((head = (usbhid->outhead + 1) & (HID_OUTPUT_FIFO_SIZE - 1)) == usbhid->outtail) {
505
			hid_warn(hid, "output queue full\n");
506 507
			return;
		}
L
Linus Torvalds 已提交
508

509 510
		usbhid->out[usbhid->outhead].raw_report = kmalloc(len, GFP_ATOMIC);
		if (!usbhid->out[usbhid->outhead].raw_report) {
511
			hid_warn(hid, "output queueing failed\n");
512 513 514 515
			return;
		}
		hid_output_report(report, usbhid->out[usbhid->outhead].raw_report);
		usbhid->out[usbhid->outhead].report = report;
516
		usbhid->outhead = head;
517

518
		if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
519 520
			if (hid_submit_out(hid))
				clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
521 522 523 524 525 526 527 528 529 530 531
		} else {
			/*
			 * the queue is known to run
			 * but an earlier request may be stuck
			 * we may need to time out
			 * no race because this is called under
			 * spinlock
			 */
			if (time_after(jiffies, usbhid->last_out + HZ * 5))
				usb_unlink_urb(usbhid->urbout);
		}
532 533
		return;
	}
L
Linus Torvalds 已提交
534

535
	if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
536
		hid_warn(hid, "control queue full\n");
537 538
		return;
	}
539

540 541 542
	if (dir == USB_DIR_OUT) {
		usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
		if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
543
			hid_warn(hid, "control queueing failed\n");
544 545 546 547
			return;
		}
		hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
	}
548 549 550
	usbhid->ctrl[usbhid->ctrlhead].report = report;
	usbhid->ctrl[usbhid->ctrlhead].dir = dir;
	usbhid->ctrlhead = head;
551

552
	if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
553 554
		if (hid_submit_ctrl(hid))
			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
555 556 557 558 559 560 561 562 563 564 565
	} else {
		/*
		 * the queue is known to run
		 * but an earlier request may be stuck
		 * we may need to time out
		 * no race because this is called under
		 * spinlock
		 */
		if (time_after(jiffies, usbhid->last_ctrl + HZ * 5))
			usb_unlink_urb(usbhid->urbctrl);
	}
566
}
567

568 569 570 571
void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir)
{
	struct usbhid_device *usbhid = hid->driver_data;
	unsigned long flags;
572

573 574 575
	spin_lock_irqsave(&usbhid->lock, flags);
	__usbhid_submit_report(hid, report, dir);
	spin_unlock_irqrestore(&usbhid->lock, flags);
576
}
J
Jiri Slaby 已提交
577
EXPORT_SYMBOL_GPL(usbhid_submit_report);
578

579 580
static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
{
581
	struct hid_device *hid = input_get_drvdata(dev);
582
	struct usbhid_device *usbhid = hid->driver_data;
583
	struct hid_field *field;
584
	unsigned long flags;
585
	int offset;
586

587 588
	if (type == EV_FF)
		return input_ff_event(dev, type, code, value);
589

590 591
	if (type != EV_LED)
		return -1;
592

593
	if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
594
		hid_warn(dev, "event field not found\n");
595 596
		return -1;
	}
G
Geoff Levand 已提交
597

598
	hid_set_field(field, offset, value);
599 600 601 602 603 604 605 606 607
	if (value) {
		spin_lock_irqsave(&usbhid->lock, flags);
		usbhid->ledcount++;
		spin_unlock_irqrestore(&usbhid->lock, flags);
	} else {
		spin_lock_irqsave(&usbhid->lock, flags);
		usbhid->ledcount--;
		spin_unlock_irqrestore(&usbhid->lock, flags);
	}
608
	usbhid_submit_report(hid, field->report, USB_DIR_OUT);
L
Linus Torvalds 已提交
609

610 611
	return 0;
}
L
Linus Torvalds 已提交
612

613 614 615
int usbhid_wait_io(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
616

J
Jiri Slaby 已提交
617 618 619
	if (!wait_event_timeout(usbhid->wait,
				(!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
				!test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
620
					10*HZ)) {
621
		dbg_hid("timeout waiting for ctrl or out queue to clear\n");
622 623
		return -1;
	}
L
Linus Torvalds 已提交
624

625 626
	return 0;
}
627
EXPORT_SYMBOL_GPL(usbhid_wait_io);
628

629 630 631 632 633 634
static int hid_set_idle(struct usb_device *dev, int ifnum, int report, int idle)
{
	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, (idle << 8) | report,
		ifnum, NULL, 0, USB_CTRL_SET_TIMEOUT);
}
L
Linus Torvalds 已提交
635

636 637 638 639
static int hid_get_class_descriptor(struct usb_device *dev, int ifnum,
		unsigned char type, void *buf, int size)
{
	int result, retries = 4;
L
Linus Torvalds 已提交
640

641
	memset(buf, 0, size);
L
Linus Torvalds 已提交
642

643 644 645 646 647 648 649 650
	do {
		result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
				USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
				(type << 8), ifnum, buf, size, USB_CTRL_GET_TIMEOUT);
		retries--;
	} while (result < size && retries);
	return result;
}
651

652 653
int usbhid_open(struct hid_device *hid)
{
654 655 656
	struct usbhid_device *usbhid = hid->driver_data;
	int res;

657
	mutex_lock(&hid_open_mut);
658 659
	if (!hid->open++) {
		res = usb_autopm_get_interface(usbhid->intf);
660
		/* the device must be awake to reliably request remote wakeup */
661 662
		if (res < 0) {
			hid->open--;
663
			mutex_unlock(&hid_open_mut);
664 665
			return -EIO;
		}
666 667 668 669 670
		usbhid->intf->needs_remote_wakeup = 1;
		if (hid_start_in(hid))
			hid_io_error(hid);
 
		usb_autopm_put_interface(usbhid->intf);
671
	}
672
	mutex_unlock(&hid_open_mut);
673 674
	return 0;
}
675

676 677 678
void usbhid_close(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
679

680 681 682 683 684 685 686
	mutex_lock(&hid_open_mut);

	/* protecting hid->open to make sure we don't restart
	 * data acquistion due to a resumption we no longer
	 * care about
	 */
	spin_lock_irq(&usbhid->lock);
687
	if (!--hid->open) {
688
		spin_unlock_irq(&usbhid->lock);
689
		hid_cancel_delayed_stuff(usbhid);
690
		usb_kill_urb(usbhid->urbin);
691 692 693
		usbhid->intf->needs_remote_wakeup = 0;
	} else {
		spin_unlock_irq(&usbhid->lock);
694
	}
695
	mutex_unlock(&hid_open_mut);
696
}
697

698 699 700
/*
 * Initialize all reports
 */
701

702 703 704 705 706
void usbhid_init_reports(struct hid_device *hid)
{
	struct hid_report *report;
	struct usbhid_device *usbhid = hid->driver_data;
	int err, ret;
707

708 709
	list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
		usbhid_submit_report(hid, report, USB_DIR_IN);
710

711 712
	list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
		usbhid_submit_report(hid, report, USB_DIR_IN);
G
Geoff Levand 已提交
713

714 715 716 717 718 719 720 721 722 723
	err = 0;
	ret = usbhid_wait_io(hid);
	while (ret) {
		err |= ret;
		if (test_bit(HID_CTRL_RUNNING, &usbhid->iofl))
			usb_kill_urb(usbhid->urbctrl);
		if (test_bit(HID_OUT_RUNNING, &usbhid->iofl))
			usb_kill_urb(usbhid->urbout);
		ret = usbhid_wait_io(hid);
	}
724

725
	if (err)
726
		hid_warn(hid, "timeout initializing reports\n");
727
}
L
Linus Torvalds 已提交
728

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
/*
 * Reset LEDs which BIOS might have left on. For now, just NumLock (0x01).
 */
static int hid_find_field_early(struct hid_device *hid, unsigned int page,
    unsigned int hid_code, struct hid_field **pfield)
{
	struct hid_report *report;
	struct hid_field *field;
	struct hid_usage *usage;
	int i, j;

	list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
		for (i = 0; i < report->maxfield; i++) {
			field = report->field[i];
			for (j = 0; j < field->maxusage; j++) {
				usage = &field->usage[j];
				if ((usage->hid & HID_USAGE_PAGE) == page &&
				    (usage->hid & 0xFFFF) == hid_code) {
					*pfield = field;
					return j;
				}
			}
		}
	}
	return -1;
}

J
Jiri Slaby 已提交
756
void usbhid_set_leds(struct hid_device *hid)
757 758 759 760 761 762 763 764 765
{
	struct hid_field *field;
	int offset;

	if ((offset = hid_find_field_early(hid, HID_UP_LED, 0x01, &field)) != -1) {
		hid_set_field(field, offset, 0);
		usbhid_submit_report(hid, field->report, USB_DIR_OUT);
	}
}
J
Jiri Slaby 已提交
766
EXPORT_SYMBOL_GPL(usbhid_set_leds);
767

768 769 770
/*
 * Traverse the supplied list of reports and find the longest
 */
J
Jiri Slaby 已提交
771 772
static void hid_find_max_report(struct hid_device *hid, unsigned int type,
		unsigned int *max)
773 774
{
	struct hid_report *report;
J
Jiri Slaby 已提交
775
	unsigned int size;
776 777

	list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
778
		size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
779 780 781 782 783
		if (*max < size)
			*max = size;
	}
}

L
Linus Torvalds 已提交
784 785
static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
{
J
Jiri Kosina 已提交
786 787
	struct usbhid_device *usbhid = hid->driver_data;

788
	usbhid->inbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
789
			&usbhid->inbuf_dma);
790
	usbhid->outbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
791
			&usbhid->outbuf_dma);
792
	usbhid->cr = kmalloc(sizeof(*usbhid->cr), GFP_KERNEL);
793
	usbhid->ctrlbuf = usb_alloc_coherent(dev, usbhid->bufsize, GFP_KERNEL,
794 795 796
			&usbhid->ctrlbuf_dma);
	if (!usbhid->inbuf || !usbhid->outbuf || !usbhid->cr ||
			!usbhid->ctrlbuf)
L
Linus Torvalds 已提交
797 798 799 800 801
		return -1;

	return 0;
}

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
static int usbhid_get_raw_report(struct hid_device *hid,
		unsigned char report_number, __u8 *buf, size_t count,
		unsigned char report_type)
{
	struct usbhid_device *usbhid = hid->driver_data;
	struct usb_device *dev = hid_to_usb_dev(hid);
	struct usb_interface *intf = usbhid->intf;
	struct usb_host_interface *interface = intf->cur_altsetting;
	int skipped_report_id = 0;
	int ret;

	/* Byte 0 is the report number. Report data starts at byte 1.*/
	buf[0] = report_number;
	if (report_number == 0x0) {
		/* Offset the return buffer by 1, so that the report ID
		   will remain in byte 0. */
		buf++;
		count--;
		skipped_report_id = 1;
	}
	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
		HID_REQ_GET_REPORT,
		USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		((report_type + 1) << 8) | report_number,
		interface->desc.bInterfaceNumber, buf, count,
		USB_CTRL_SET_TIMEOUT);

	/* count also the report id */
	if (ret > 0 && skipped_report_id)
		ret++;

	return ret;
}

836 837
static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count,
		unsigned char report_type)
838 839 840 841 842 843 844
{
	struct usbhid_device *usbhid = hid->driver_data;
	struct usb_device *dev = hid_to_usb_dev(hid);
	struct usb_interface *intf = usbhid->intf;
	struct usb_host_interface *interface = intf->cur_altsetting;
	int ret;

845
	if (usbhid->urbout && report_type != HID_FEATURE_REPORT) {
846 847
		int actual_length;
		int skipped_report_id = 0;
A
Alan Ott 已提交
848

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
		if (buf[0] == 0x0) {
			/* Don't send the Report ID */
			buf++;
			count--;
			skipped_report_id = 1;
		}
		ret = usb_interrupt_msg(dev, usbhid->urbout->pipe,
			buf, count, &actual_length,
			USB_CTRL_SET_TIMEOUT);
		/* return the number of bytes transferred */
		if (ret == 0) {
			ret = actual_length;
			/* count also the report id */
			if (skipped_report_id)
				ret++;
		}
	} else {
866
		int skipped_report_id = 0;
867
		int report_id = buf[0];
868 869 870 871 872 873
		if (buf[0] == 0x0) {
			/* Don't send the Report ID */
			buf++;
			count--;
			skipped_report_id = 1;
		}
874 875 876
		ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			HID_REQ_SET_REPORT,
			USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
877
			((report_type + 1) << 8) | report_id,
878
			interface->desc.bInterfaceNumber, buf, count,
879
			USB_CTRL_SET_TIMEOUT);
880 881
		/* count also the report id, if this was a numbered report. */
		if (ret > 0 && skipped_report_id)
882 883
			ret++;
	}
884 885 886 887

	return ret;
}

888 889 890 891 892 893 894
static void usbhid_restart_queues(struct usbhid_device *usbhid)
{
	if (usbhid->urbout)
		usbhid_restart_out_queue(usbhid);
	usbhid_restart_ctrl_queue(usbhid);
}

L
Linus Torvalds 已提交
895 896
static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
{
J
Jiri Kosina 已提交
897 898
	struct usbhid_device *usbhid = hid->driver_data;

899 900
	usb_free_coherent(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
	usb_free_coherent(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
901
	kfree(usbhid->cr);
902
	usb_free_coherent(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
L
Linus Torvalds 已提交
903 904
}

J
Jiri Slaby 已提交
905 906 907
static int usbhid_parse(struct hid_device *hid)
{
	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
L
Linus Torvalds 已提交
908 909 910
	struct usb_host_interface *interface = intf->cur_altsetting;
	struct usb_device *dev = interface_to_usbdev (intf);
	struct hid_descriptor *hdesc;
911
	u32 quirks = 0;
J
Jiri Slaby 已提交
912
	unsigned int rsize = 0;
913
	char *rdesc;
J
Jiri Slaby 已提交
914
	int ret, n;
L
Linus Torvalds 已提交
915

916 917
	quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
			le16_to_cpu(dev->descriptor.idProduct));
L
Linus Torvalds 已提交
918

919 920 921
	if (quirks & HID_QUIRK_IGNORE)
		return -ENODEV;

922 923 924 925 926 927 928 929
	/* Many keyboards and mice don't like to be polled for reports,
	 * so we will always set the HID_QUIRK_NOGET flag for them. */
	if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT) {
		if (interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_KEYBOARD ||
			interface->desc.bInterfaceProtocol == USB_INTERFACE_PROTOCOL_MOUSE)
				quirks |= HID_QUIRK_NOGET;
	}

930 931 932
	if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
	    (!interface->desc.bNumEndpoints ||
	     usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
933
		dbg_hid("class descriptor not present\n");
J
Jiri Slaby 已提交
934
		return -ENODEV;
L
Linus Torvalds 已提交
935 936
	}

J
Jiri Slaby 已提交
937 938 939
	hid->version = le16_to_cpu(hdesc->bcdHID);
	hid->country = hdesc->bCountryCode;

L
Linus Torvalds 已提交
940 941 942 943 944
	for (n = 0; n < hdesc->bNumDescriptors; n++)
		if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT)
			rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength);

	if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
945
		dbg_hid("weird size of report descriptor (%u)\n", rsize);
J
Jiri Slaby 已提交
946
		return -EINVAL;
L
Linus Torvalds 已提交
947 948 949
	}

	if (!(rdesc = kmalloc(rsize, GFP_KERNEL))) {
950
		dbg_hid("couldn't allocate rdesc memory\n");
J
Jiri Slaby 已提交
951
		return -ENOMEM;
L
Linus Torvalds 已提交
952 953
	}

954 955
	hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);

J
Jiri Slaby 已提交
956 957 958
	ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
			HID_DT_REPORT, rdesc, rsize);
	if (ret < 0) {
959
		dbg_hid("reading report descriptor failed\n");
L
Linus Torvalds 已提交
960
		kfree(rdesc);
J
Jiri Slaby 已提交
961
		goto err;
L
Linus Torvalds 已提交
962 963
	}

J
Jiri Slaby 已提交
964 965 966
	ret = hid_parse_report(hid, rdesc, rsize);
	kfree(rdesc);
	if (ret) {
967
		dbg_hid("parsing report descriptor failed\n");
J
Jiri Slaby 已提交
968
		goto err;
L
Linus Torvalds 已提交
969 970
	}

971
	hid->quirks |= quirks;
L
Linus Torvalds 已提交
972

J
Jiri Slaby 已提交
973 974 975 976 977 978 979 980 981 982
	return 0;
err:
	return ret;
}

static int usbhid_start(struct hid_device *hid)
{
	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
	struct usb_host_interface *interface = intf->cur_altsetting;
	struct usb_device *dev = interface_to_usbdev(intf);
983
	struct usbhid_device *usbhid = hid->driver_data;
J
Jiri Slaby 已提交
984 985 986
	unsigned int n, insize = 0;
	int ret;

987 988
	clear_bit(HID_DISCONNECTED, &usbhid->iofl);

J
Jiri Kosina 已提交
989 990 991 992
	usbhid->bufsize = HID_MIN_BUFFER_SIZE;
	hid_find_max_report(hid, HID_INPUT_REPORT, &usbhid->bufsize);
	hid_find_max_report(hid, HID_OUTPUT_REPORT, &usbhid->bufsize);
	hid_find_max_report(hid, HID_FEATURE_REPORT, &usbhid->bufsize);
993

J
Jiri Kosina 已提交
994 995
	if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
		usbhid->bufsize = HID_MAX_BUFFER_SIZE;
996 997 998 999 1000 1001

	hid_find_max_report(hid, HID_INPUT_REPORT, &insize);

	if (insize > HID_MAX_BUFFER_SIZE)
		insize = HID_MAX_BUFFER_SIZE;

J
Jiri Slaby 已提交
1002 1003
	if (hid_alloc_buffers(dev, hid)) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
1004
		goto fail;
1005 1006
	}

L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012
	for (n = 0; n < interface->desc.bNumEndpoints; n++) {
		struct usb_endpoint_descriptor *endpoint;
		int pipe;
		int interval;

		endpoint = &interface->endpoint[n].desc;
1013
		if (!usb_endpoint_xfer_int(endpoint))
L
Linus Torvalds 已提交
1014 1015 1016 1017
			continue;

		interval = endpoint->bInterval;

1018
		/* Some vendors give fullspeed interval on highspeed devides */
J
Jiri Slaby 已提交
1019
		if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
1020 1021 1022 1023 1024 1025
		    dev->speed == USB_SPEED_HIGH) {
			interval = fls(endpoint->bInterval*8);
			printk(KERN_INFO "%s: Fixing fullspeed to highspeed interval: %d -> %d\n",
			       hid->name, endpoint->bInterval, interval);
		}

L
Linus Torvalds 已提交
1026 1027 1028
		/* Change the polling interval of mice. */
		if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
			interval = hid_mousepoll_interval;
1029

J
Jiri Slaby 已提交
1030
		ret = -ENOMEM;
1031
		if (usb_endpoint_dir_in(endpoint)) {
J
Jiri Kosina 已提交
1032
			if (usbhid->urbin)
L
Linus Torvalds 已提交
1033
				continue;
J
Jiri Kosina 已提交
1034
			if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
1035 1036
				goto fail;
			pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
1037
			usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
L
Linus Torvalds 已提交
1038
					 hid_irq_in, hid, interval);
J
Jiri Kosina 已提交
1039 1040
			usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
			usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
1041
		} else {
J
Jiri Kosina 已提交
1042
			if (usbhid->urbout)
L
Linus Torvalds 已提交
1043
				continue;
J
Jiri Kosina 已提交
1044
			if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
1045 1046
				goto fail;
			pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
1047
			usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
L
Linus Torvalds 已提交
1048
					 hid_irq_out, hid, interval);
J
Jiri Kosina 已提交
1049 1050
			usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
			usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
1051 1052 1053
		}
	}

J
Jiri Kosina 已提交
1054
	usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
J
Jiri Slaby 已提交
1055 1056
	if (!usbhid->urbctrl) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
1057
		goto fail;
J
Jiri Slaby 已提交
1058
	}
1059

J
Jiri Kosina 已提交
1060 1061 1062
	usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
			     usbhid->ctrlbuf, 1, hid_ctrl, hid);
	usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
1063
	usbhid->urbctrl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
J
Jiri Slaby 已提交
1064

J
Jiri Kosina 已提交
1065 1066
	if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
		usbhid_init_reports(hid);
J
Jiri Slaby 已提交
1067

1068 1069
	set_bit(HID_STARTED, &usbhid->iofl);

1070 1071 1072
	/* Some keyboards don't work until their LEDs have been set.
	 * Since BIOSes do set the LEDs, it must be safe for any device
	 * that supports the keyboard boot protocol.
1073 1074
	 * In addition, enable remote wakeup by default for all keyboard
	 * devices supporting the boot protocol.
1075 1076 1077
	 */
	if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
			interface->desc.bInterfaceProtocol ==
1078
				USB_INTERFACE_PROTOCOL_KEYBOARD) {
1079
		usbhid_set_leds(hid);
1080 1081
		device_set_wakeup_enable(&dev->dev, 1);
	}
J
Jiri Slaby 已提交
1082
	return 0;
L
Linus Torvalds 已提交
1083 1084

fail:
J
Jiri Kosina 已提交
1085 1086 1087
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbout);
	usb_free_urb(usbhid->urbctrl);
1088 1089 1090
	usbhid->urbin = NULL;
	usbhid->urbout = NULL;
	usbhid->urbctrl = NULL;
1091
	hid_free_buffers(dev, hid);
J
Jiri Slaby 已提交
1092
	return ret;
L
Linus Torvalds 已提交
1093 1094
}

J
Jiri Slaby 已提交
1095
static void usbhid_stop(struct hid_device *hid)
L
Linus Torvalds 已提交
1096
{
J
Jiri Slaby 已提交
1097
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1098

J
Jiri Slaby 已提交
1099
	if (WARN_ON(!usbhid))
L
Linus Torvalds 已提交
1100 1101
		return;

1102
	clear_bit(HID_STARTED, &usbhid->iofl);
1103
	spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
1104
	set_bit(HID_DISCONNECTED, &usbhid->iofl);
1105
	spin_unlock_irq(&usbhid->lock);
J
Jiri Kosina 已提交
1106 1107 1108
	usb_kill_urb(usbhid->urbin);
	usb_kill_urb(usbhid->urbout);
	usb_kill_urb(usbhid->urbctrl);
L
Linus Torvalds 已提交
1109

1110
	hid_cancel_delayed_stuff(usbhid);
A
Alan Stern 已提交
1111

J
Jiri Slaby 已提交
1112 1113
	hid->claimed = 0;

J
Jiri Kosina 已提交
1114 1115 1116
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbctrl);
	usb_free_urb(usbhid->urbout);
1117 1118 1119
	usbhid->urbin = NULL; /* don't mess up next start */
	usbhid->urbctrl = NULL;
	usbhid->urbout = NULL;
L
Linus Torvalds 已提交
1120

1121
	hid_free_buffers(hid_to_usb_dev(hid), hid);
L
Linus Torvalds 已提交
1122 1123
}

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
static int usbhid_power(struct hid_device *hid, int lvl)
{
	int r = 0;

	switch (lvl) {
	case PM_HINT_FULLON:
		r = usbhid_get_power(hid);
		break;
	case PM_HINT_NORMAL:
		usbhid_put_power(hid);
		break;
	}
	return r;
}

J
Jiri Slaby 已提交
1139 1140 1141 1142 1143 1144
static struct hid_ll_driver usb_hid_driver = {
	.parse = usbhid_parse,
	.start = usbhid_start,
	.stop = usbhid_stop,
	.open = usbhid_open,
	.close = usbhid_close,
1145
	.power = usbhid_power,
J
Jiri Slaby 已提交
1146 1147 1148
	.hidinput_input_event = usb_hidinput_input_event,
};

1149
static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
L
Linus Torvalds 已提交
1150
{
J
Jiri Slaby 已提交
1151
	struct usb_host_interface *interface = intf->cur_altsetting;
J
Jiri Slaby 已提交
1152
	struct usb_device *dev = interface_to_usbdev(intf);
1153
	struct usbhid_device *usbhid;
L
Linus Torvalds 已提交
1154
	struct hid_device *hid;
J
Jiri Slaby 已提交
1155
	unsigned int n, has_in = 0;
J
Jiri Slaby 已提交
1156 1157
	size_t len;
	int ret;
L
Linus Torvalds 已提交
1158

1159
	dbg_hid("HID probe called for ifnum %d\n",
L
Linus Torvalds 已提交
1160 1161
			intf->altsetting->desc.bInterfaceNumber);

J
Jiri Slaby 已提交
1162 1163 1164 1165
	for (n = 0; n < interface->desc.bNumEndpoints; n++)
		if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
			has_in++;
	if (!has_in) {
1166
		hid_err(intf, "couldn't find an input interrupt endpoint\n");
J
Jiri Slaby 已提交
1167 1168 1169
		return -ENODEV;
	}

J
Jiri Slaby 已提交
1170 1171 1172
	hid = hid_allocate_device();
	if (IS_ERR(hid))
		return PTR_ERR(hid);
L
Linus Torvalds 已提交
1173 1174

	usb_set_intfdata(intf, hid);
J
Jiri Slaby 已提交
1175
	hid->ll_driver = &usb_hid_driver;
1176
	hid->hid_get_raw_report = usbhid_get_raw_report;
J
Jiri Slaby 已提交
1177
	hid->hid_output_raw_report = usbhid_output_raw_report;
J
Jiri Slaby 已提交
1178
	hid->ff_init = hid_pidff_init;
J
Jiri Slaby 已提交
1179
#ifdef CONFIG_USB_HIDDEV
J
Jiri Slaby 已提交
1180
	hid->hiddev_connect = hiddev_connect;
1181
	hid->hiddev_disconnect = hiddev_disconnect;
J
Jiri Slaby 已提交
1182 1183 1184 1185 1186 1187 1188 1189
	hid->hiddev_hid_event = hiddev_hid_event;
	hid->hiddev_report_event = hiddev_report_event;
#endif
	hid->dev.parent = &intf->dev;
	hid->bus = BUS_USB;
	hid->vendor = le16_to_cpu(dev->descriptor.idVendor);
	hid->product = le16_to_cpu(dev->descriptor.idProduct);
	hid->name[0] = 0;
1190
	hid->quirks = usbhid_lookup_quirk(hid->vendor, hid->product);
1191 1192 1193
	if (intf->cur_altsetting->desc.bInterfaceProtocol ==
			USB_INTERFACE_PROTOCOL_MOUSE)
		hid->type = HID_TYPE_USBMOUSE;
1194 1195
	else if (intf->cur_altsetting->desc.bInterfaceProtocol == 0)
		hid->type = HID_TYPE_USBNONE;
L
Linus Torvalds 已提交
1196

J
Jiri Slaby 已提交
1197 1198
	if (dev->manufacturer)
		strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
L
Linus Torvalds 已提交
1199

J
Jiri Slaby 已提交
1200 1201 1202 1203
	if (dev->product) {
		if (dev->manufacturer)
			strlcat(hid->name, " ", sizeof(hid->name));
		strlcat(hid->name, dev->product, sizeof(hid->name));
L
Linus Torvalds 已提交
1204 1205
	}

J
Jiri Slaby 已提交
1206 1207 1208 1209
	if (!strlen(hid->name))
		snprintf(hid->name, sizeof(hid->name), "HID %04x:%04x",
			 le16_to_cpu(dev->descriptor.idVendor),
			 le16_to_cpu(dev->descriptor.idProduct));
L
Linus Torvalds 已提交
1210

J
Jiri Slaby 已提交
1211 1212 1213 1214 1215 1216 1217 1218 1219
	usb_make_path(dev, hid->phys, sizeof(hid->phys));
	strlcat(hid->phys, "/input", sizeof(hid->phys));
	len = strlen(hid->phys);
	if (len < sizeof(hid->phys) - 1)
		snprintf(hid->phys + len, sizeof(hid->phys) - len,
			 "%d", intf->altsetting[0].desc.bInterfaceNumber);

	if (usb_string(dev, dev->descriptor.iSerialNumber, hid->uniq, 64) <= 0)
		hid->uniq[0] = 0;
L
Linus Torvalds 已提交
1220

1221 1222 1223 1224 1225 1226 1227 1228
	usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
	if (usbhid == NULL) {
		ret = -ENOMEM;
		goto err;
	}

	hid->driver_data = usbhid;
	usbhid->hid = hid;
1229 1230
	usbhid->intf = intf;
	usbhid->ifnum = interface->desc.bInterfaceNumber;
1231

1232 1233 1234 1235 1236
	init_waitqueue_head(&usbhid->wait);
	INIT_WORK(&usbhid->reset_work, hid_reset);
	setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
	spin_lock_init(&usbhid->lock);

J
Jiri Slaby 已提交
1237 1238
	ret = hid_add_device(hid);
	if (ret) {
J
Jiri Slaby 已提交
1239
		if (ret != -ENODEV)
1240
			hid_err(intf, "can't add hid device: %d\n", ret);
1241
		goto err_free;
J
Jiri Slaby 已提交
1242
	}
J
Jiri Slaby 已提交
1243 1244

	return 0;
1245 1246
err_free:
	kfree(usbhid);
J
Jiri Slaby 已提交
1247 1248
err:
	hid_destroy_device(hid);
J
Jiri Slaby 已提交
1249
	return ret;
L
Linus Torvalds 已提交
1250 1251
}

1252
static void usbhid_disconnect(struct usb_interface *intf)
J
Jiri Slaby 已提交
1253 1254
{
	struct hid_device *hid = usb_get_intfdata(intf);
1255
	struct usbhid_device *usbhid;
J
Jiri Slaby 已提交
1256 1257 1258 1259

	if (WARN_ON(!hid))
		return;

1260
	usbhid = hid->driver_data;
J
Jiri Slaby 已提交
1261
	hid_destroy_device(hid);
1262
	kfree(usbhid);
J
Jiri Slaby 已提交
1263 1264
}

1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
{
	del_timer_sync(&usbhid->io_retry);
	cancel_work_sync(&usbhid->reset_work);
}

static void hid_cease_io(struct usbhid_device *usbhid)
{
	del_timer(&usbhid->io_retry);
	usb_kill_urb(usbhid->urbin);
	usb_kill_urb(usbhid->urbctrl);
	usb_kill_urb(usbhid->urbout);
}

1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
/* Treat USB reset pretty much the same as suspend/resume */
static int hid_pre_reset(struct usb_interface *intf)
{
	struct hid_device *hid = usb_get_intfdata(intf);
	struct usbhid_device *usbhid = hid->driver_data;

	spin_lock_irq(&usbhid->lock);
	set_bit(HID_RESET_PENDING, &usbhid->iofl);
	spin_unlock_irq(&usbhid->lock);
	hid_cease_io(usbhid);

	return 0;
}

/* Same routine used for post_reset and reset_resume */
static int hid_post_reset(struct usb_interface *intf)
{
	struct usb_device *dev = interface_to_usbdev (intf);
	struct hid_device *hid = usb_get_intfdata(intf);
	struct usbhid_device *usbhid = hid->driver_data;
	int status;
1300

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
	spin_lock_irq(&usbhid->lock);
	clear_bit(HID_RESET_PENDING, &usbhid->iofl);
	spin_unlock_irq(&usbhid->lock);
	hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
	status = hid_start_in(hid);
	if (status < 0)
		hid_io_error(hid);
	usbhid_restart_queues(usbhid);

	return 0;
}

int usbhid_get_power(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
1316

1317 1318 1319 1320 1321 1322
	return usb_autopm_get_interface(usbhid->intf);
}

void usbhid_put_power(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
1323

1324 1325 1326 1327
	usb_autopm_put_interface(usbhid->intf);
}


1328
#ifdef CONFIG_PM
1329
static int hid_suspend(struct usb_interface *intf, pm_message_t message)
L
Linus Torvalds 已提交
1330
{
1331
	struct hid_device *hid = usb_get_intfdata(intf);
J
Jiri Kosina 已提交
1332
	struct usbhid_device *usbhid = hid->driver_data;
1333
	int status;
L
Linus Torvalds 已提交
1334

A
Alan Stern 已提交
1335
	if (message.event & PM_EVENT_AUTO) {
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
		spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
		if (!test_bit(HID_RESET_PENDING, &usbhid->iofl)
		    && !test_bit(HID_CLEAR_HALT, &usbhid->iofl)
		    && !test_bit(HID_OUT_RUNNING, &usbhid->iofl)
		    && !test_bit(HID_CTRL_RUNNING, &usbhid->iofl)
		    && !test_bit(HID_KEYS_PRESSED, &usbhid->iofl)
		    && (!usbhid->ledcount || ignoreled))
		{
			set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
			spin_unlock_irq(&usbhid->lock);
1346 1347 1348 1349 1350
			if (hid->driver && hid->driver->suspend) {
				status = hid->driver->suspend(hid, message);
				if (status < 0)
					return status;
			}
1351 1352 1353 1354 1355
		} else {
			usbhid_mark_busy(usbhid);
			spin_unlock_irq(&usbhid->lock);
			return -EBUSY;
		}
1356

1357
	} else {
1358 1359 1360 1361 1362
		if (hid->driver && hid->driver->suspend) {
			status = hid->driver->suspend(hid, message);
			if (status < 0)
				return status;
		}
1363 1364 1365 1366 1367 1368 1369
		spin_lock_irq(&usbhid->lock);
		set_bit(HID_REPORTED_IDLE, &usbhid->iofl);
		spin_unlock_irq(&usbhid->lock);
		if (usbhid_wait_io(hid) < 0)
			return -EIO;
	}

A
Alan Stern 已提交
1370
	if (!ignoreled && (message.event & PM_EVENT_AUTO)) {
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
		spin_lock_irq(&usbhid->lock);
		if (test_bit(HID_LED_ON, &usbhid->iofl)) {
			spin_unlock_irq(&usbhid->lock);
			usbhid_mark_busy(usbhid);
			return -EBUSY;
		}
		spin_unlock_irq(&usbhid->lock);
	}

	hid_cancel_delayed_stuff(usbhid);
	hid_cease_io(usbhid);

A
Alan Stern 已提交
1383 1384
	if ((message.event & PM_EVENT_AUTO) &&
			test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1385 1386 1387 1388 1389 1390 1391
		/* lost race against keypresses */
		status = hid_start_in(hid);
		if (status < 0)
			hid_io_error(hid);
		usbhid_mark_busy(usbhid);
		return -EBUSY;
	}
L
Linus Torvalds 已提交
1392 1393 1394 1395 1396 1397 1398
	dev_dbg(&intf->dev, "suspend\n");
	return 0;
}

static int hid_resume(struct usb_interface *intf)
{
	struct hid_device *hid = usb_get_intfdata (intf);
J
Jiri Kosina 已提交
1399
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1400 1401
	int status;

1402
	if (!test_bit(HID_STARTED, &usbhid->iofl))
1403 1404
		return 0;

1405 1406 1407 1408 1409 1410
	clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
	usbhid_mark_busy(usbhid);

	if (test_bit(HID_CLEAR_HALT, &usbhid->iofl) ||
	    test_bit(HID_RESET_PENDING, &usbhid->iofl))
		schedule_work(&usbhid->reset_work);
J
Jiri Kosina 已提交
1411
	usbhid->retry_delay = 0;
A
Alan Stern 已提交
1412
	status = hid_start_in(hid);
1413 1414 1415
	if (status < 0)
		hid_io_error(hid);
	usbhid_restart_queues(usbhid);
L
Linus Torvalds 已提交
1416

1417 1418 1419 1420 1421
	if (status >= 0 && hid->driver && hid->driver->resume) {
		int ret = hid->driver->resume(hid);
		if (ret < 0)
			status = ret;
	}
L
Linus Torvalds 已提交
1422
	dev_dbg(&intf->dev, "resume status %d\n", status);
A
Alan Stern 已提交
1423
	return 0;
1424 1425
}

1426
static int hid_reset_resume(struct usb_interface *intf)
1427
{
1428 1429
	struct hid_device *hid = usb_get_intfdata(intf);
	struct usbhid_device *usbhid = hid->driver_data;
1430
	int status;
1431

1432
	clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
1433 1434 1435 1436 1437 1438 1439
	status = hid_post_reset(intf);
	if (status >= 0 && hid->driver && hid->driver->reset_resume) {
		int ret = hid->driver->reset_resume(hid);
		if (ret < 0)
			status = ret;
	}
	return status;
1440 1441
}

1442
#endif /* CONFIG_PM */
1443

1444
static const struct usb_device_id hid_usb_ids[] = {
L
Linus Torvalds 已提交
1445 1446 1447 1448 1449 1450 1451 1452 1453
	{ .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
		.bInterfaceClass = USB_INTERFACE_CLASS_HID },
	{ }						/* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, hid_usb_ids);

static struct usb_driver hid_driver = {
	.name =		"usbhid",
1454 1455
	.probe =	usbhid_probe,
	.disconnect =	usbhid_disconnect,
1456
#ifdef CONFIG_PM
L
Linus Torvalds 已提交
1457 1458
	.suspend =	hid_suspend,
	.resume =	hid_resume,
1459
	.reset_resume =	hid_reset_resume,
1460
#endif
1461 1462
	.pre_reset =	hid_pre_reset,
	.post_reset =	hid_post_reset,
L
Linus Torvalds 已提交
1463
	.id_table =	hid_usb_ids,
1464
	.supports_autosuspend = 1,
L
Linus Torvalds 已提交
1465 1466
};

J
Jiri Slaby 已提交
1467 1468 1469 1470 1471
static const struct hid_device_id hid_usb_table[] = {
	{ HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
	{ }
};

1472 1473 1474 1475 1476
struct usb_interface *usbhid_find_interface(int minor)
{
	return usb_find_interface(&hid_driver, minor);
}

J
Jiri Slaby 已提交
1477 1478 1479 1480 1481
static struct hid_driver hid_usb_driver = {
	.name = "generic-usb",
	.id_table = hid_usb_table,
};

L
Linus Torvalds 已提交
1482 1483
static int __init hid_init(void)
{
1484 1485
	int retval = -ENOMEM;

J
Jiri Slaby 已提交
1486 1487 1488
	retval = hid_register_driver(&hid_usb_driver);
	if (retval)
		goto hid_register_fail;
1489 1490 1491
	retval = usbhid_quirks_init(quirks_param);
	if (retval)
		goto usbhid_quirks_init_fail;
L
Linus Torvalds 已提交
1492 1493 1494
	retval = usb_register(&hid_driver);
	if (retval)
		goto usb_register_fail;
1495
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1496 1497 1498

	return 0;
usb_register_fail:
1499 1500
	usbhid_quirks_exit();
usbhid_quirks_init_fail:
J
Jiri Slaby 已提交
1501 1502
	hid_unregister_driver(&hid_usb_driver);
hid_register_fail:
L
Linus Torvalds 已提交
1503 1504 1505 1506 1507 1508
	return retval;
}

static void __exit hid_exit(void)
{
	usb_deregister(&hid_driver);
1509
	usbhid_quirks_exit();
J
Jiri Slaby 已提交
1510
	hid_unregister_driver(&hid_usb_driver);
L
Linus Torvalds 已提交
1511 1512 1513 1514 1515
}

module_init(hid_init);
module_exit(hid_exit);

1516 1517 1518
MODULE_AUTHOR("Andreas Gal");
MODULE_AUTHOR("Vojtech Pavlik");
MODULE_AUTHOR("Jiri Kosina");
L
Linus Torvalds 已提交
1519 1520
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE(DRIVER_LICENSE);