hid-core.c 38.4 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 70
static DEFINE_MUTEX(hid_open_mut);
static struct workqueue_struct *resumption_waker;
L
Linus Torvalds 已提交
71

72
static void hid_io_error(struct hid_device *hid);
73 74 75
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);
76 77 78

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

84 85
	spin_lock_irqsave(&usbhid->lock, flags);
	if (hid->open > 0 &&
86
			!test_bit(HID_DISCONNECTED, &usbhid->iofl) &&
87
			!test_bit(HID_REPORTED_IDLE, &usbhid->iofl) &&
88 89 90 91
			!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 已提交
92
	}
93
	spin_unlock_irqrestore(&usbhid->lock, flags);
94
	return rc;
L
Linus Torvalds 已提交
95 96
}

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

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

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

116 117 118 119 120 121
	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 已提交
122

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

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

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

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

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

A
Alan Stern 已提交
163 164 165 166 167
	/* 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;

168 169 170 171 172 173
	/* 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;
174

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

177 178 179 180 181
		/* 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 已提交
182 183
	}

184 185 186
	mod_timer(&usbhid->io_retry,
			jiffies + msecs_to_jiffies(usbhid->retry_delay));
done:
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 231
	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 已提交
232 233
}

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

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

244
	switch (urb->status) {
J
Jiri Slaby 已提交
245
	case 0:			/* success */
246
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
247 248 249 250
		usbhid->retry_delay = 0;
		hid_input_report(urb->context, HID_INPUT_REPORT,
				 urb->transfer_buffer,
				 urb->actual_length, 1);
251 252 253 254 255 256 257 258 259
		/*
		 * 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 已提交
260 261
		break;
	case -EPIPE:		/* stall */
262
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
263 264 265 266 267 268 269 270 271 272 273 274 275
		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... */
276
		usbhid_mark_busy(usbhid);
J
Jiri Slaby 已提交
277 278 279 280
		clear_bit(HID_IN_RUNNING, &usbhid->iofl);
		hid_io_error(hid);
		return;
	default:		/* error */
281 282
		dev_warn(&urb->dev->dev, "input irq status %d  "
				"received\n", urb->status);
283
	}
L
Linus Torvalds 已提交
284

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

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

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
	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);
312

313
		dbg_hid("submitting out urb\n");
314

315 316 317 318
		if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
			err_hid("usb_submit_urb(out) failed");
			return -1;
		}
319
		usbhid->last_out = jiffies;
320 321 322 323 324 325 326
	} else {
		/*
		 * queue work to wake up the device.
		 * as the work queue is freezeable, this is safe
		 * with respect to STD and STR
		 */
		queue_work(resumption_waker, &usbhid->restart_work);
327
	}
L
Linus Torvalds 已提交
328

329 330 331 332
	return 0;
}

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

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

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
	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 已提交
366

367 368 369 370 371
		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 已提交
372

373 374 375
		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 已提交
376

377 378 379 380
		if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
			err_hid("usb_submit_urb(ctrl) failed");
			return -1;
		}
381
		usbhid->last_ctrl = jiffies;
382 383 384 385 386 387 388
	} else {
		/*
		 * queue work to wake up the device.
		 * as the work queue is freezeable, this is safe
		 * with respect to STD and STR
		 */
		queue_work(resumption_waker, &usbhid->restart_work);
389
	}
L
Linus Torvalds 已提交
390

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

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

398 399 400 401 402 403
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 已提交
404

405
	switch (urb->status) {
J
Jiri Slaby 已提交
406 407 408 409 410 411 412 413 414 415
	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 */
416 417
		dev_warn(&urb->dev->dev, "output irq status %d "
				"received\n", urb->status);
418
	}
L
Linus Torvalds 已提交
419

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

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

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

436
	clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
437
	spin_unlock_irqrestore(&usbhid->lock, flags);
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
		dev_warn(&urb->dev->dev, "ctrl urb status %d "
470
				"received\n", status);
471
	}
L
Linus Torvalds 已提交
472

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

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

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

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

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

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

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

517
		if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl)) {
518 519
			if (hid_submit_out(hid))
				clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
520 521 522 523 524 525 526 527 528 529 530
		} 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);
		}
531 532
		return;
	}
L
Linus Torvalds 已提交
533

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

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

551
	if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl)) {
552 553
		if (hid_submit_ctrl(hid))
			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
554 555 556 557 558 559 560 561 562 563 564
	} 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);
	}
565
}
566

567 568 569 570
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;
571

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

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

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

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

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

597
	hid_set_field(field, offset, value);
598 599 600 601 602 603 604 605 606
	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);
	}
607
	usbhid_submit_report(hid, field->report, USB_DIR_OUT);
L
Linus Torvalds 已提交
608

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

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

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

624 625
	return 0;
}
626

627 628 629 630 631 632
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 已提交
633

634 635 636 637
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 已提交
638

639
	memset(buf, 0, size);
L
Linus Torvalds 已提交
640

641 642 643 644 645 646 647 648
	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;
}
649

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

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

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

678 679 680 681 682 683 684
	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);
685
	if (!--hid->open) {
686
		spin_unlock_irq(&usbhid->lock);
687
		hid_cancel_delayed_stuff(usbhid);
688
		usb_kill_urb(usbhid->urbin);
689 690 691
		usbhid->intf->needs_remote_wakeup = 0;
	} else {
		spin_unlock_irq(&usbhid->lock);
692
	}
693
	mutex_unlock(&hid_open_mut);
694
}
695

696 697 698
/*
 * Initialize all reports
 */
699

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

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

709 710
	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 已提交
711

712 713 714 715 716 717 718 719 720 721
	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);
	}
722

723
	if (err)
724
		dev_warn(&hid->dev, "timeout initializing reports\n");
725
}
L
Linus Torvalds 已提交
726

727 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
/*
 * 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 已提交
754
void usbhid_set_leds(struct hid_device *hid)
755 756 757 758 759 760 761 762 763
{
	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 已提交
764
EXPORT_SYMBOL_GPL(usbhid_set_leds);
765

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

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

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

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

	return 0;
}

801 802
static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count,
		unsigned char report_type)
803 804 805 806 807 808 809 810 811 812
{
	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;

	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		HID_REQ_SET_REPORT,
		USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
813
		((report_type + 1) << 8) | *buf,
814 815 816 817 818 819 820 821 822 823
		interface->desc.bInterfaceNumber, buf + 1, count - 1,
		USB_CTRL_SET_TIMEOUT);

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

	return ret;
}

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
static void usbhid_restart_queues(struct usbhid_device *usbhid)
{
	if (usbhid->urbout)
		usbhid_restart_out_queue(usbhid);
	usbhid_restart_ctrl_queue(usbhid);
}

static void __usbhid_restart_queues(struct work_struct *work)
{
	struct usbhid_device *usbhid =
		container_of(work, struct usbhid_device, restart_work);
	int r;

	r = usb_autopm_get_interface(usbhid->intf);
	if (r < 0)
		return;
	usb_autopm_put_interface(usbhid->intf);
}

L
Linus Torvalds 已提交
843 844
static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
{
J
Jiri Kosina 已提交
845 846
	struct usbhid_device *usbhid = hid->driver_data;

847 848 849 850
	usb_buffer_free(dev, usbhid->bufsize, usbhid->inbuf, usbhid->inbuf_dma);
	usb_buffer_free(dev, usbhid->bufsize, usbhid->outbuf, usbhid->outbuf_dma);
	usb_buffer_free(dev, sizeof(*(usbhid->cr)), usbhid->cr, usbhid->cr_dma);
	usb_buffer_free(dev, usbhid->bufsize, usbhid->ctrlbuf, usbhid->ctrlbuf_dma);
L
Linus Torvalds 已提交
851 852
}

J
Jiri Slaby 已提交
853 854 855
static int usbhid_parse(struct hid_device *hid)
{
	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
L
Linus Torvalds 已提交
856 857 858
	struct usb_host_interface *interface = intf->cur_altsetting;
	struct usb_device *dev = interface_to_usbdev (intf);
	struct hid_descriptor *hdesc;
859
	u32 quirks = 0;
J
Jiri Slaby 已提交
860
	unsigned int rsize = 0;
861
	char *rdesc;
J
Jiri Slaby 已提交
862
	int ret, n;
L
Linus Torvalds 已提交
863

864 865
	quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
			le16_to_cpu(dev->descriptor.idProduct));
L
Linus Torvalds 已提交
866

867 868 869
	if (quirks & HID_QUIRK_IGNORE)
		return -ENODEV;

870 871 872 873 874 875 876 877
	/* 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;
	}

878 879 880
	if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
	    (!interface->desc.bNumEndpoints ||
	     usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
881
		dbg_hid("class descriptor not present\n");
J
Jiri Slaby 已提交
882
		return -ENODEV;
L
Linus Torvalds 已提交
883 884
	}

J
Jiri Slaby 已提交
885 886 887
	hid->version = le16_to_cpu(hdesc->bcdHID);
	hid->country = hdesc->bCountryCode;

L
Linus Torvalds 已提交
888 889 890 891 892
	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) {
893
		dbg_hid("weird size of report descriptor (%u)\n", rsize);
J
Jiri Slaby 已提交
894
		return -EINVAL;
L
Linus Torvalds 已提交
895 896 897
	}

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

902 903
	hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);

J
Jiri Slaby 已提交
904 905 906
	ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
			HID_DT_REPORT, rdesc, rsize);
	if (ret < 0) {
907
		dbg_hid("reading report descriptor failed\n");
L
Linus Torvalds 已提交
908
		kfree(rdesc);
J
Jiri Slaby 已提交
909
		goto err;
L
Linus Torvalds 已提交
910 911
	}

J
Jiri Slaby 已提交
912 913 914
	ret = hid_parse_report(hid, rdesc, rsize);
	kfree(rdesc);
	if (ret) {
915
		dbg_hid("parsing report descriptor failed\n");
J
Jiri Slaby 已提交
916
		goto err;
L
Linus Torvalds 已提交
917 918
	}

919
	hid->quirks |= quirks;
L
Linus Torvalds 已提交
920

J
Jiri Slaby 已提交
921 922 923 924 925 926 927 928 929 930
	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);
931
	struct usbhid_device *usbhid = hid->driver_data;
J
Jiri Slaby 已提交
932 933 934
	unsigned int n, insize = 0;
	int ret;

935 936
	clear_bit(HID_DISCONNECTED, &usbhid->iofl);

J
Jiri Kosina 已提交
937 938 939 940
	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);
941

J
Jiri Kosina 已提交
942 943
	if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
		usbhid->bufsize = HID_MAX_BUFFER_SIZE;
944 945 946 947 948 949

	hid_find_max_report(hid, HID_INPUT_REPORT, &insize);

	if (insize > HID_MAX_BUFFER_SIZE)
		insize = HID_MAX_BUFFER_SIZE;

J
Jiri Slaby 已提交
950 951
	if (hid_alloc_buffers(dev, hid)) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
952
		goto fail;
953 954
	}

L
Linus Torvalds 已提交
955 956 957 958 959 960
	for (n = 0; n < interface->desc.bNumEndpoints; n++) {
		struct usb_endpoint_descriptor *endpoint;
		int pipe;
		int interval;

		endpoint = &interface->endpoint[n].desc;
961
		if (!usb_endpoint_xfer_int(endpoint))
L
Linus Torvalds 已提交
962 963 964 965
			continue;

		interval = endpoint->bInterval;

966
		/* Some vendors give fullspeed interval on highspeed devides */
J
Jiri Slaby 已提交
967
		if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
968 969 970 971 972 973
		    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 已提交
974 975 976
		/* Change the polling interval of mice. */
		if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
			interval = hid_mousepoll_interval;
977

J
Jiri Slaby 已提交
978
		ret = -ENOMEM;
979
		if (usb_endpoint_dir_in(endpoint)) {
J
Jiri Kosina 已提交
980
			if (usbhid->urbin)
L
Linus Torvalds 已提交
981
				continue;
J
Jiri Kosina 已提交
982
			if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
983 984
				goto fail;
			pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
985
			usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
L
Linus Torvalds 已提交
986
					 hid_irq_in, hid, interval);
J
Jiri Kosina 已提交
987 988
			usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
			usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
989
		} else {
J
Jiri Kosina 已提交
990
			if (usbhid->urbout)
L
Linus Torvalds 已提交
991
				continue;
J
Jiri Kosina 已提交
992
			if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
993 994
				goto fail;
			pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
995
			usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
L
Linus Torvalds 已提交
996
					 hid_irq_out, hid, interval);
J
Jiri Kosina 已提交
997 998
			usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
			usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
999 1000 1001
		}
	}

J
Jiri Slaby 已提交
1002
	init_waitqueue_head(&usbhid->wait);
J
Jiri Kosina 已提交
1003
	INIT_WORK(&usbhid->reset_work, hid_reset);
1004
	INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
J
Jiri Kosina 已提交
1005
	setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
A
Alan Stern 已提交
1006

1007
	spin_lock_init(&usbhid->lock);
L
Linus Torvalds 已提交
1008

J
Jiri Kosina 已提交
1009
	usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
J
Jiri Slaby 已提交
1010 1011
	if (!usbhid->urbctrl) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
1012
		goto fail;
J
Jiri Slaby 已提交
1013
	}
1014

J
Jiri Kosina 已提交
1015 1016 1017 1018 1019
	usb_fill_control_urb(usbhid->urbctrl, dev, 0, (void *) usbhid->cr,
			     usbhid->ctrlbuf, 1, hid_ctrl, hid);
	usbhid->urbctrl->setup_dma = usbhid->cr_dma;
	usbhid->urbctrl->transfer_dma = usbhid->ctrlbuf_dma;
	usbhid->urbctrl->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
J
Jiri Slaby 已提交
1020

J
Jiri Kosina 已提交
1021 1022
	if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
		usbhid_init_reports(hid);
J
Jiri Slaby 已提交
1023

1024 1025
	set_bit(HID_STARTED, &usbhid->iofl);

1026 1027 1028 1029 1030 1031 1032 1033 1034
	/* 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.
	 */
	if (interface->desc.bInterfaceSubClass == USB_INTERFACE_SUBCLASS_BOOT &&
			interface->desc.bInterfaceProtocol ==
				USB_INTERFACE_PROTOCOL_KEYBOARD)
		usbhid_set_leds(hid);

J
Jiri Slaby 已提交
1035
	return 0;
L
Linus Torvalds 已提交
1036 1037

fail:
J
Jiri Kosina 已提交
1038 1039 1040
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbout);
	usb_free_urb(usbhid->urbctrl);
1041 1042 1043
	usbhid->urbin = NULL;
	usbhid->urbout = NULL;
	usbhid->urbctrl = NULL;
1044
	hid_free_buffers(dev, hid);
J
Jiri Slaby 已提交
1045
	return ret;
L
Linus Torvalds 已提交
1046 1047
}

J
Jiri Slaby 已提交
1048
static void usbhid_stop(struct hid_device *hid)
L
Linus Torvalds 已提交
1049
{
J
Jiri Slaby 已提交
1050
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1051

J
Jiri Slaby 已提交
1052
	if (WARN_ON(!usbhid))
L
Linus Torvalds 已提交
1053 1054
		return;

1055
	clear_bit(HID_STARTED, &usbhid->iofl);
1056
	spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
1057
	set_bit(HID_DISCONNECTED, &usbhid->iofl);
1058
	spin_unlock_irq(&usbhid->lock);
J
Jiri Kosina 已提交
1059 1060 1061
	usb_kill_urb(usbhid->urbin);
	usb_kill_urb(usbhid->urbout);
	usb_kill_urb(usbhid->urbctrl);
L
Linus Torvalds 已提交
1062

1063
	hid_cancel_delayed_stuff(usbhid);
A
Alan Stern 已提交
1064

J
Jiri Slaby 已提交
1065 1066
	hid->claimed = 0;

J
Jiri Kosina 已提交
1067 1068 1069
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbctrl);
	usb_free_urb(usbhid->urbout);
1070 1071 1072
	usbhid->urbin = NULL; /* don't mess up next start */
	usbhid->urbctrl = NULL;
	usbhid->urbout = NULL;
L
Linus Torvalds 已提交
1073

1074
	hid_free_buffers(hid_to_usb_dev(hid), hid);
L
Linus Torvalds 已提交
1075 1076
}

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
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 已提交
1092 1093 1094 1095 1096 1097
static struct hid_ll_driver usb_hid_driver = {
	.parse = usbhid_parse,
	.start = usbhid_start,
	.stop = usbhid_stop,
	.open = usbhid_open,
	.close = usbhid_close,
1098
	.power = usbhid_power,
J
Jiri Slaby 已提交
1099 1100 1101
	.hidinput_input_event = usb_hidinput_input_event,
};

1102
static int usbhid_probe(struct usb_interface *intf, const struct usb_device_id *id)
L
Linus Torvalds 已提交
1103
{
J
Jiri Slaby 已提交
1104
	struct usb_host_interface *interface = intf->cur_altsetting;
J
Jiri Slaby 已提交
1105
	struct usb_device *dev = interface_to_usbdev(intf);
1106
	struct usbhid_device *usbhid;
L
Linus Torvalds 已提交
1107
	struct hid_device *hid;
J
Jiri Slaby 已提交
1108
	unsigned int n, has_in = 0;
J
Jiri Slaby 已提交
1109 1110
	size_t len;
	int ret;
L
Linus Torvalds 已提交
1111

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

J
Jiri Slaby 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123
	for (n = 0; n < interface->desc.bNumEndpoints; n++)
		if (usb_endpoint_is_int_in(&interface->endpoint[n].desc))
			has_in++;
	if (!has_in) {
		dev_err(&intf->dev, "couldn't find an input interrupt "
				"endpoint\n");
		return -ENODEV;
	}

J
Jiri Slaby 已提交
1124 1125 1126
	hid = hid_allocate_device();
	if (IS_ERR(hid))
		return PTR_ERR(hid);
L
Linus Torvalds 已提交
1127 1128

	usb_set_intfdata(intf, hid);
J
Jiri Slaby 已提交
1129 1130
	hid->ll_driver = &usb_hid_driver;
	hid->hid_output_raw_report = usbhid_output_raw_report;
J
Jiri Slaby 已提交
1131
	hid->ff_init = hid_pidff_init;
J
Jiri Slaby 已提交
1132
#ifdef CONFIG_USB_HIDDEV
J
Jiri Slaby 已提交
1133
	hid->hiddev_connect = hiddev_connect;
1134
	hid->hiddev_disconnect = hiddev_disconnect;
J
Jiri Slaby 已提交
1135 1136 1137 1138 1139 1140 1141 1142
	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;
1143 1144 1145
	if (intf->cur_altsetting->desc.bInterfaceProtocol ==
			USB_INTERFACE_PROTOCOL_MOUSE)
		hid->type = HID_TYPE_USBMOUSE;
L
Linus Torvalds 已提交
1146

J
Jiri Slaby 已提交
1147 1148
	if (dev->manufacturer)
		strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
L
Linus Torvalds 已提交
1149

J
Jiri Slaby 已提交
1150 1151 1152 1153
	if (dev->product) {
		if (dev->manufacturer)
			strlcat(hid->name, " ", sizeof(hid->name));
		strlcat(hid->name, dev->product, sizeof(hid->name));
L
Linus Torvalds 已提交
1154 1155
	}

J
Jiri Slaby 已提交
1156 1157 1158 1159
	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 已提交
1160

J
Jiri Slaby 已提交
1161 1162 1163 1164 1165 1166 1167 1168 1169
	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 已提交
1170

1171 1172 1173 1174 1175 1176 1177 1178
	usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
	if (usbhid == NULL) {
		ret = -ENOMEM;
		goto err;
	}

	hid->driver_data = usbhid;
	usbhid->hid = hid;
1179 1180
	usbhid->intf = intf;
	usbhid->ifnum = interface->desc.bInterfaceNumber;
1181

J
Jiri Slaby 已提交
1182 1183
	ret = hid_add_device(hid);
	if (ret) {
J
Jiri Slaby 已提交
1184 1185
		if (ret != -ENODEV)
			dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1186
		goto err_free;
J
Jiri Slaby 已提交
1187
	}
J
Jiri Slaby 已提交
1188 1189

	return 0;
1190 1191
err_free:
	kfree(usbhid);
J
Jiri Slaby 已提交
1192 1193
err:
	hid_destroy_device(hid);
J
Jiri Slaby 已提交
1194
	return ret;
L
Linus Torvalds 已提交
1195 1196
}

1197
static void usbhid_disconnect(struct usb_interface *intf)
J
Jiri Slaby 已提交
1198 1199
{
	struct hid_device *hid = usb_get_intfdata(intf);
1200
	struct usbhid_device *usbhid;
J
Jiri Slaby 已提交
1201 1202 1203 1204

	if (WARN_ON(!hid))
		return;

1205
	usbhid = hid->driver_data;
J
Jiri Slaby 已提交
1206
	hid_destroy_device(hid);
1207
	kfree(usbhid);
J
Jiri Slaby 已提交
1208 1209
}

1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
static void hid_cancel_delayed_stuff(struct usbhid_device *usbhid)
{
	del_timer_sync(&usbhid->io_retry);
	cancel_work_sync(&usbhid->restart_work);
	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);
}

1225 1226 1227 1228 1229 1230 1231 1232 1233
/* 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);
1234
	cancel_work_sync(&usbhid->restart_work);
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
	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;
1247

1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
	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;
1263

1264 1265 1266 1267 1268 1269
	return usb_autopm_get_interface(usbhid->intf);
}

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

1271 1272 1273 1274
	usb_autopm_put_interface(usbhid->intf);
}


1275
#ifdef CONFIG_PM
1276
static int hid_suspend(struct usb_interface *intf, pm_message_t message)
L
Linus Torvalds 已提交
1277
{
1278
	struct hid_device *hid = usb_get_intfdata(intf);
J
Jiri Kosina 已提交
1279
	struct usbhid_device *usbhid = hid->driver_data;
1280
	int status;
L
Linus Torvalds 已提交
1281

A
Alan Stern 已提交
1282
	if (message.event & PM_EVENT_AUTO) {
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
		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);
		} else {
			usbhid_mark_busy(usbhid);
			spin_unlock_irq(&usbhid->lock);
			return -EBUSY;
		}
1298

1299 1300 1301 1302 1303 1304 1305 1306
	} else {
		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 已提交
1307
	if (!ignoreled && (message.event & PM_EVENT_AUTO)) {
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
		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 已提交
1320 1321
	if ((message.event & PM_EVENT_AUTO) &&
			test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
1322 1323 1324 1325 1326 1327 1328
		/* 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 已提交
1329 1330 1331 1332 1333 1334 1335
	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 已提交
1336
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1337 1338
	int status;

1339
	if (!test_bit(HID_STARTED, &usbhid->iofl))
1340 1341
		return 0;

1342 1343 1344 1345 1346 1347
	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 已提交
1348
	usbhid->retry_delay = 0;
A
Alan Stern 已提交
1349
	status = hid_start_in(hid);
1350 1351 1352
	if (status < 0)
		hid_io_error(hid);
	usbhid_restart_queues(usbhid);
L
Linus Torvalds 已提交
1353 1354

	dev_dbg(&intf->dev, "resume status %d\n", status);
A
Alan Stern 已提交
1355
	return 0;
1356 1357
}

1358
static int hid_reset_resume(struct usb_interface *intf)
1359
{
1360 1361
	struct hid_device *hid = usb_get_intfdata(intf);
	struct usbhid_device *usbhid = hid->driver_data;
1362

1363 1364
	clear_bit(HID_REPORTED_IDLE, &usbhid->iofl);
	return hid_post_reset(intf);
1365 1366
}

1367
#endif /* CONFIG_PM */
1368

1369
static const struct usb_device_id hid_usb_ids[] = {
L
Linus Torvalds 已提交
1370 1371 1372 1373 1374 1375 1376 1377 1378
	{ .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",
1379 1380
	.probe =	usbhid_probe,
	.disconnect =	usbhid_disconnect,
1381
#ifdef CONFIG_PM
L
Linus Torvalds 已提交
1382 1383
	.suspend =	hid_suspend,
	.resume =	hid_resume,
1384
	.reset_resume =	hid_reset_resume,
1385
#endif
1386 1387
	.pre_reset =	hid_pre_reset,
	.post_reset =	hid_post_reset,
L
Linus Torvalds 已提交
1388
	.id_table =	hid_usb_ids,
1389
	.supports_autosuspend = 1,
L
Linus Torvalds 已提交
1390 1391
};

J
Jiri Slaby 已提交
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
static const struct hid_device_id hid_usb_table[] = {
	{ HID_USB_DEVICE(HID_ANY_ID, HID_ANY_ID) },
	{ }
};

static struct hid_driver hid_usb_driver = {
	.name = "generic-usb",
	.id_table = hid_usb_table,
};

L
Linus Torvalds 已提交
1402 1403
static int __init hid_init(void)
{
1404 1405 1406 1407 1408
	int retval = -ENOMEM;

	resumption_waker = create_freezeable_workqueue("usbhid_resumer");
	if (!resumption_waker)
		goto no_queue;
J
Jiri Slaby 已提交
1409 1410 1411
	retval = hid_register_driver(&hid_usb_driver);
	if (retval)
		goto hid_register_fail;
1412 1413 1414
	retval = usbhid_quirks_init(quirks_param);
	if (retval)
		goto usbhid_quirks_init_fail;
L
Linus Torvalds 已提交
1415 1416 1417 1418 1419 1420
	retval = hiddev_init();
	if (retval)
		goto hiddev_init_fail;
	retval = usb_register(&hid_driver);
	if (retval)
		goto usb_register_fail;
1421
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1422 1423 1424 1425 1426

	return 0;
usb_register_fail:
	hiddev_exit();
hiddev_init_fail:
1427 1428
	usbhid_quirks_exit();
usbhid_quirks_init_fail:
J
Jiri Slaby 已提交
1429 1430
	hid_unregister_driver(&hid_usb_driver);
hid_register_fail:
1431 1432
	destroy_workqueue(resumption_waker);
no_queue:
L
Linus Torvalds 已提交
1433 1434 1435 1436 1437 1438 1439
	return retval;
}

static void __exit hid_exit(void)
{
	usb_deregister(&hid_driver);
	hiddev_exit();
1440
	usbhid_quirks_exit();
J
Jiri Slaby 已提交
1441
	hid_unregister_driver(&hid_usb_driver);
1442
	destroy_workqueue(resumption_waker);
L
Linus Torvalds 已提交
1443 1444 1445 1446 1447
}

module_init(hid_init);
module_exit(hid_exit);

1448 1449 1450
MODULE_AUTHOR("Andreas Gal");
MODULE_AUTHOR("Vojtech Pavlik");
MODULE_AUTHOR("Jiri Kosina");
L
Linus Torvalds 已提交
1451 1452
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE(DRIVER_LICENSE);