hid-core.c 37.9 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) 2006-2008 Jiri Kosina
8
 *  Copyright (c) 2007-2008 Oliver Neukum
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 30
#include <linux/smp_lock.h>
#include <linux/spinlock.h>
#include <asm/unaligned.h>
#include <asm/byteorder.h>
#include <linux/input.h>
#include <linux/wait.h>
31
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
32 33 34

#include <linux/usb.h>

35
#include <linux/hid.h>
L
Linus Torvalds 已提交
36
#include <linux/hiddev.h>
37
#include <linux/hid-debug.h>
J
Jiri Kosina 已提交
38
#include <linux/hidraw.h>
J
Jiri Kosina 已提交
39
#include "usbhid.h"
L
Linus Torvalds 已提交
40 41 42 43 44

/*
 * Version Information
 */

45
#define DRIVER_VERSION "v2.6"
46
#define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik, Jiri Kosina"
L
Linus Torvalds 已提交
47 48 49 50 51 52 53 54 55 56 57
#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");

58 59 60 61
static unsigned int ignoreled;
module_param_named(ignoreled, ignoreled, uint, 0644);
MODULE_PARM_DESC(ignoreled, "Autosuspend with active leds");

62 63 64 65 66 67 68
/* 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 已提交
69
/*
70
 * Input submission and I/O error handler.
L
Linus Torvalds 已提交
71
 */
72 73
static DEFINE_MUTEX(hid_open_mut);
static struct workqueue_struct *resumption_waker;
L
Linus Torvalds 已提交
74

75
static void hid_io_error(struct hid_device *hid);
76 77 78
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);
79 80 81

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

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

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

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

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

119 120 121 122 123 124
	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 已提交
125

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

136 137 138 139 140 141
	switch (rc) {
	case 0:
		if (!test_bit(HID_IN_RUNNING, &usbhid->iofl))
			hid_io_error(hid);
		break;
	default:
142
		err_hid("can't reset device, %s-%s/input%d, status %d",
143 144 145 146 147 148 149 150
				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 已提交
151 152 153
	}
}

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

160
	spin_lock_irqsave(&usbhid->lock, flags);
161

162
	/* Stop when disconnected */
163
	if (test_bit(HID_DISCONNECTED, &usbhid->iofl))
164
		goto done;
165

A
Alan Stern 已提交
166 167 168 169 170
	/* 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;

171 172 173 174 175 176
	/* 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;
177

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

180 181 182 183 184
		/* 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 已提交
185 186
	}

187 188 189
	mod_timer(&usbhid->io_retry,
			jiffies + msecs_to_jiffies(usbhid->retry_delay));
done:
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 232 233 234
	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 已提交
235 236
}

237 238 239
/*
 * Input interrupt completion handler.
 */
240

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

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

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

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

307 308
	report = usbhid->out[usbhid->outtail].report;
	raw_report = usbhid->out[usbhid->outtail].raw_report;
L
Linus Torvalds 已提交
309

310 311 312 313 314
	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);
315

316
		dbg_hid("submitting out urb\n");
317

318 319 320 321 322 323 324 325 326 327 328
		if (usb_submit_urb(usbhid->urbout, GFP_ATOMIC)) {
			err_hid("usb_submit_urb(out) failed");
			return -1;
		}
	} 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);
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;
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 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
	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 已提交
368

369 370 371 372 373
		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 已提交
374

375 376 377
		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 已提交
378

379 380 381 382 383 384 385 386 387 388 389
		if (usb_submit_urb(usbhid->urbctrl, GFP_ATOMIC)) {
			err_hid("usb_submit_urb(ctrl) failed");
			return -1;
		}
	} 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);
390
	}
L
Linus Torvalds 已提交
391

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

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

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

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

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

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

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

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

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

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

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

454
	switch (status) {
J
Jiri Slaby 已提交
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
	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 */
470
		dev_warn(&urb->dev->dev, "ctrl urb status %d "
471
				"received\n", status);
472
	}
L
Linus Torvalds 已提交
473

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

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

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

493
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 518 519 520 521
		if (!test_and_set_bit(HID_OUT_RUNNING, &usbhid->iofl))
			if (hid_submit_out(hid))
				clear_bit(HID_OUT_RUNNING, &usbhid->iofl);
		return;
	}
L
Linus Torvalds 已提交
522

523
	if ((head = (usbhid->ctrlhead + 1) & (HID_CONTROL_FIFO_SIZE - 1)) == usbhid->ctrltail) {
524
		dev_warn(&hid->dev, "control queue full\n");
525 526
		return;
	}
527

528 529 530
	if (dir == USB_DIR_OUT) {
		usbhid->ctrl[usbhid->ctrlhead].raw_report = kmalloc(len, GFP_ATOMIC);
		if (!usbhid->ctrl[usbhid->ctrlhead].raw_report) {
531
			dev_warn(&hid->dev, "control queueing failed\n");
532 533 534 535
			return;
		}
		hid_output_report(report, usbhid->ctrl[usbhid->ctrlhead].raw_report);
	}
536 537 538
	usbhid->ctrl[usbhid->ctrlhead].report = report;
	usbhid->ctrl[usbhid->ctrlhead].dir = dir;
	usbhid->ctrlhead = head;
539

540 541 542
	if (!test_and_set_bit(HID_CTRL_RUNNING, &usbhid->iofl))
		if (hid_submit_ctrl(hid))
			clear_bit(HID_CTRL_RUNNING, &usbhid->iofl);
543
}
544

545 546 547 548 549 550 551 552
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;

	spin_lock_irqsave(&usbhid->lock, flags);
	__usbhid_submit_report(hid, report, dir);
	spin_unlock_irqrestore(&usbhid->lock, flags);
553
}
J
Jiri Slaby 已提交
554
EXPORT_SYMBOL_GPL(usbhid_submit_report);
555

556 557
static int usb_hidinput_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
{
558
	struct hid_device *hid = input_get_drvdata(dev);
559
	struct usbhid_device *usbhid = hid->driver_data;
560
	struct hid_field *field;
561
	unsigned long flags;
562
	int offset;
563

564 565
	if (type == EV_FF)
		return input_ff_event(dev, type, code, value);
566

567 568
	if (type != EV_LED)
		return -1;
569

570
	if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
571
		dev_warn(&dev->dev, "event field not found\n");
572 573
		return -1;
	}
G
Geoff Levand 已提交
574

575
	hid_set_field(field, offset, value);
576 577 578 579 580 581 582 583 584
	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);
	}
585
	usbhid_submit_report(hid, field->report, USB_DIR_OUT);
L
Linus Torvalds 已提交
586

587 588
	return 0;
}
L
Linus Torvalds 已提交
589

590 591 592
int usbhid_wait_io(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
593

J
Jiri Slaby 已提交
594 595 596
	if (!wait_event_timeout(usbhid->wait,
				(!test_bit(HID_CTRL_RUNNING, &usbhid->iofl) &&
				!test_bit(HID_OUT_RUNNING, &usbhid->iofl)),
597
					10*HZ)) {
598
		dbg_hid("timeout waiting for ctrl or out queue to clear\n");
599 600
		return -1;
	}
L
Linus Torvalds 已提交
601

602 603
	return 0;
}
604

605 606 607 608 609 610
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 已提交
611

612 613 614 615
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 已提交
616

617
	memset(buf, 0, size);
L
Linus Torvalds 已提交
618

619 620 621 622 623 624 625 626
	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;
}
627

628 629
int usbhid_open(struct hid_device *hid)
{
630 631 632
	struct usbhid_device *usbhid = hid->driver_data;
	int res;

633
	mutex_lock(&hid_open_mut);
634 635
	if (!hid->open++) {
		res = usb_autopm_get_interface(usbhid->intf);
636
		/* the device must be awake to reliable request remote wakeup */
637 638
		if (res < 0) {
			hid->open--;
639
			mutex_unlock(&hid_open_mut);
640 641
			return -EIO;
		}
642 643 644 645 646
		usbhid->intf->needs_remote_wakeup = 1;
		if (hid_start_in(hid))
			hid_io_error(hid);
 
		usb_autopm_put_interface(usbhid->intf);
647
	}
648
	mutex_unlock(&hid_open_mut);
649 650
	return 0;
}
651

652 653 654
void usbhid_close(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
655

656 657 658 659 660 661 662
	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);
663
	if (!--hid->open) {
664
		spin_unlock_irq(&usbhid->lock);
665
		usb_kill_urb(usbhid->urbin);
666 667 668 669
		flush_scheduled_work();
		usbhid->intf->needs_remote_wakeup = 0;
	} else {
		spin_unlock_irq(&usbhid->lock);
670
	}
671
	mutex_unlock(&hid_open_mut);
672
}
673

674 675 676
/*
 * Initialize all reports
 */
677

678 679 680 681 682
void usbhid_init_reports(struct hid_device *hid)
{
	struct hid_report *report;
	struct usbhid_device *usbhid = hid->driver_data;
	int err, ret;
683

684 685
	list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].report_list, list)
		usbhid_submit_report(hid, report, USB_DIR_IN);
686

687 688
	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 已提交
689

690 691 692 693 694 695 696 697 698 699
	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);
	}
700

701
	if (err)
702
		dev_warn(&hid->dev, "timeout initializing reports\n");
703
}
L
Linus Torvalds 已提交
704

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
/*
 * 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 已提交
732
void usbhid_set_leds(struct hid_device *hid)
733 734 735 736 737 738 739 740 741
{
	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 已提交
742
EXPORT_SYMBOL_GPL(usbhid_set_leds);
743

744 745 746
/*
 * Traverse the supplied list of reports and find the longest
 */
J
Jiri Slaby 已提交
747 748
static void hid_find_max_report(struct hid_device *hid, unsigned int type,
		unsigned int *max)
749 750
{
	struct hid_report *report;
J
Jiri Slaby 已提交
751
	unsigned int size;
752 753

	list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
754
		size = ((report->size - 1) >> 3) + 1 + hid->report_enum[type].numbered;
755 756 757 758 759
		if (*max < size)
			*max = size;
	}
}

L
Linus Torvalds 已提交
760 761
static int hid_alloc_buffers(struct usb_device *dev, struct hid_device *hid)
{
J
Jiri Kosina 已提交
762 763
	struct usbhid_device *usbhid = hid->driver_data;

764 765 766 767 768 769 770 771 772 773
	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 已提交
774 775 776 777 778
		return -1;

	return 0;
}

779 780 781 782 783 784 785 786 787 788 789
static int usbhid_output_raw_report(struct hid_device *hid, __u8 *buf, size_t count)
{
	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,
790
		((HID_OUTPUT_REPORT + 1) << 8) | *buf,
791 792 793 794 795 796 797 798 799 800
		interface->desc.bInterfaceNumber, buf + 1, count - 1,
		USB_CTRL_SET_TIMEOUT);

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

	return ret;
}

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
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 已提交
820 821
static void hid_free_buffers(struct usb_device *dev, struct hid_device *hid)
{
J
Jiri Kosina 已提交
822 823
	struct usbhid_device *usbhid = hid->driver_data;

824 825 826 827
	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 已提交
828 829
}

J
Jiri Slaby 已提交
830 831 832
static int usbhid_parse(struct hid_device *hid)
{
	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
L
Linus Torvalds 已提交
833 834 835
	struct usb_host_interface *interface = intf->cur_altsetting;
	struct usb_device *dev = interface_to_usbdev (intf);
	struct hid_descriptor *hdesc;
836
	u32 quirks = 0;
J
Jiri Slaby 已提交
837
	unsigned int rsize = 0;
838
	char *rdesc;
J
Jiri Slaby 已提交
839
	int ret, n;
L
Linus Torvalds 已提交
840

841 842
	quirks = usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
			le16_to_cpu(dev->descriptor.idProduct));
L
Linus Torvalds 已提交
843

844 845 846 847 848 849 850 851
	/* 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;
	}

852 853 854
	if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) &&
	    (!interface->desc.bNumEndpoints ||
	     usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) {
855
		dbg_hid("class descriptor not present\n");
J
Jiri Slaby 已提交
856
		return -ENODEV;
L
Linus Torvalds 已提交
857 858
	}

J
Jiri Slaby 已提交
859 860 861
	hid->version = le16_to_cpu(hdesc->bcdHID);
	hid->country = hdesc->bCountryCode;

L
Linus Torvalds 已提交
862 863 864 865 866
	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) {
867
		dbg_hid("weird size of report descriptor (%u)\n", rsize);
J
Jiri Slaby 已提交
868
		return -EINVAL;
L
Linus Torvalds 已提交
869 870 871
	}

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

876 877
	hid_set_idle(dev, interface->desc.bInterfaceNumber, 0, 0);

J
Jiri Slaby 已提交
878 879 880
	ret = hid_get_class_descriptor(dev, interface->desc.bInterfaceNumber,
			HID_DT_REPORT, rdesc, rsize);
	if (ret < 0) {
881
		dbg_hid("reading report descriptor failed\n");
L
Linus Torvalds 已提交
882
		kfree(rdesc);
J
Jiri Slaby 已提交
883
		goto err;
L
Linus Torvalds 已提交
884 885
	}

886
	dbg_hid("report descriptor (size %u, read %d) = ", rsize, n);
L
Linus Torvalds 已提交
887
	for (n = 0; n < rsize; n++)
888 889
		dbg_hid_line(" %02x", (unsigned char) rdesc[n]);
	dbg_hid_line("\n");
L
Linus Torvalds 已提交
890

J
Jiri Slaby 已提交
891 892 893
	ret = hid_parse_report(hid, rdesc, rsize);
	kfree(rdesc);
	if (ret) {
894
		dbg_hid("parsing report descriptor failed\n");
J
Jiri Slaby 已提交
895
		goto err;
L
Linus Torvalds 已提交
896 897 898 899
	}

	hid->quirks = quirks;

J
Jiri Slaby 已提交
900 901 902 903 904 905 906 907 908 909
	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);
910
	struct usbhid_device *usbhid = hid->driver_data;
J
Jiri Slaby 已提交
911 912 913
	unsigned int n, insize = 0;
	int ret;

914 915
	clear_bit(HID_DISCONNECTED, &usbhid->iofl);

J
Jiri Kosina 已提交
916 917 918 919
	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);
920

J
Jiri Kosina 已提交
921 922
	if (usbhid->bufsize > HID_MAX_BUFFER_SIZE)
		usbhid->bufsize = HID_MAX_BUFFER_SIZE;
923 924 925 926 927 928

	hid_find_max_report(hid, HID_INPUT_REPORT, &insize);

	if (insize > HID_MAX_BUFFER_SIZE)
		insize = HID_MAX_BUFFER_SIZE;

J
Jiri Slaby 已提交
929 930
	if (hid_alloc_buffers(dev, hid)) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
931
		goto fail;
932 933
	}

L
Linus Torvalds 已提交
934 935 936 937 938 939
	for (n = 0; n < interface->desc.bNumEndpoints; n++) {
		struct usb_endpoint_descriptor *endpoint;
		int pipe;
		int interval;

		endpoint = &interface->endpoint[n].desc;
940
		if (!usb_endpoint_xfer_int(endpoint))
L
Linus Torvalds 已提交
941 942 943 944
			continue;

		interval = endpoint->bInterval;

945
		/* Some vendors give fullspeed interval on highspeed devides */
J
Jiri Slaby 已提交
946
		if (hid->quirks & HID_QUIRK_FULLSPEED_INTERVAL &&
947 948 949 950 951 952
		    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 已提交
953 954 955
		/* Change the polling interval of mice. */
		if (hid->collection->usage == HID_GD_MOUSE && hid_mousepoll_interval > 0)
			interval = hid_mousepoll_interval;
956

J
Jiri Slaby 已提交
957
		ret = -ENOMEM;
958
		if (usb_endpoint_dir_in(endpoint)) {
J
Jiri Kosina 已提交
959
			if (usbhid->urbin)
L
Linus Torvalds 已提交
960
				continue;
J
Jiri Kosina 已提交
961
			if (!(usbhid->urbin = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
962 963
				goto fail;
			pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
964
			usb_fill_int_urb(usbhid->urbin, dev, pipe, usbhid->inbuf, insize,
L
Linus Torvalds 已提交
965
					 hid_irq_in, hid, interval);
J
Jiri Kosina 已提交
966 967
			usbhid->urbin->transfer_dma = usbhid->inbuf_dma;
			usbhid->urbin->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
968
		} else {
J
Jiri Kosina 已提交
969
			if (usbhid->urbout)
L
Linus Torvalds 已提交
970
				continue;
J
Jiri Kosina 已提交
971
			if (!(usbhid->urbout = usb_alloc_urb(0, GFP_KERNEL)))
L
Linus Torvalds 已提交
972 973
				goto fail;
			pipe = usb_sndintpipe(dev, endpoint->bEndpointAddress);
J
Jiri Kosina 已提交
974
			usb_fill_int_urb(usbhid->urbout, dev, pipe, usbhid->outbuf, 0,
L
Linus Torvalds 已提交
975
					 hid_irq_out, hid, interval);
J
Jiri Kosina 已提交
976 977
			usbhid->urbout->transfer_dma = usbhid->outbuf_dma;
			usbhid->urbout->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
L
Linus Torvalds 已提交
978 979 980
		}
	}

J
Jiri Slaby 已提交
981
	init_waitqueue_head(&usbhid->wait);
J
Jiri Kosina 已提交
982
	INIT_WORK(&usbhid->reset_work, hid_reset);
983
	INIT_WORK(&usbhid->restart_work, __usbhid_restart_queues);
J
Jiri Kosina 已提交
984
	setup_timer(&usbhid->io_retry, hid_retry_timeout, (unsigned long) hid);
A
Alan Stern 已提交
985

986 987
	spin_lock_init(&usbhid->lock);
	spin_lock_init(&usbhid->lock);
L
Linus Torvalds 已提交
988

J
Jiri Kosina 已提交
989 990
	usbhid->intf = intf;
	usbhid->ifnum = interface->desc.bInterfaceNumber;
L
Linus Torvalds 已提交
991

J
Jiri Kosina 已提交
992
	usbhid->urbctrl = usb_alloc_urb(0, GFP_KERNEL);
J
Jiri Slaby 已提交
993 994
	if (!usbhid->urbctrl) {
		ret = -ENOMEM;
L
Linus Torvalds 已提交
995
		goto fail;
J
Jiri Slaby 已提交
996
	}
997

J
Jiri Kosina 已提交
998 999 1000 1001 1002
	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 已提交
1003

J
Jiri Slaby 已提交
1004 1005 1006
	usbhid_init_reports(hid);
	hid_dump_device(hid);

1007 1008
	set_bit(HID_STARTED, &usbhid->iofl);

1009 1010 1011 1012 1013 1014 1015 1016 1017
	/* 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 已提交
1018
	return 0;
L
Linus Torvalds 已提交
1019 1020

fail:
J
Jiri Kosina 已提交
1021 1022 1023
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbout);
	usb_free_urb(usbhid->urbctrl);
1024 1025 1026
	usbhid->urbin = NULL;
	usbhid->urbout = NULL;
	usbhid->urbctrl = NULL;
1027
	hid_free_buffers(dev, hid);
J
Jiri Slaby 已提交
1028
	return ret;
L
Linus Torvalds 已提交
1029 1030
}

J
Jiri Slaby 已提交
1031
static void usbhid_stop(struct hid_device *hid)
L
Linus Torvalds 已提交
1032
{
J
Jiri Slaby 已提交
1033
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1034

J
Jiri Slaby 已提交
1035
	if (WARN_ON(!usbhid))
L
Linus Torvalds 已提交
1036 1037
		return;

1038
	clear_bit(HID_STARTED, &usbhid->iofl);
1039
	spin_lock_irq(&usbhid->lock);	/* Sync with error handler */
1040
	set_bit(HID_DISCONNECTED, &usbhid->iofl);
1041
	spin_unlock_irq(&usbhid->lock);
J
Jiri Kosina 已提交
1042 1043 1044
	usb_kill_urb(usbhid->urbin);
	usb_kill_urb(usbhid->urbout);
	usb_kill_urb(usbhid->urbctrl);
L
Linus Torvalds 已提交
1045

1046
	hid_cancel_delayed_stuff(usbhid);
A
Alan Stern 已提交
1047

L
Linus Torvalds 已提交
1048 1049 1050 1051
	if (hid->claimed & HID_CLAIMED_INPUT)
		hidinput_disconnect(hid);
	if (hid->claimed & HID_CLAIMED_HIDDEV)
		hiddev_disconnect(hid);
J
Jiri Kosina 已提交
1052 1053
	if (hid->claimed & HID_CLAIMED_HIDRAW)
		hidraw_disconnect(hid);
L
Linus Torvalds 已提交
1054

J
Jiri Slaby 已提交
1055 1056
	hid->claimed = 0;

J
Jiri Kosina 已提交
1057 1058 1059
	usb_free_urb(usbhid->urbin);
	usb_free_urb(usbhid->urbctrl);
	usb_free_urb(usbhid->urbout);
1060 1061 1062
	usbhid->urbin = NULL; /* don't mess up next start */
	usbhid->urbctrl = NULL;
	usbhid->urbout = NULL;
L
Linus Torvalds 已提交
1063

1064
	hid_free_buffers(hid_to_usb_dev(hid), hid);
L
Linus Torvalds 已提交
1065 1066
}

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
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 已提交
1082 1083 1084 1085 1086 1087
static struct hid_ll_driver usb_hid_driver = {
	.parse = usbhid_parse,
	.start = usbhid_start,
	.stop = usbhid_stop,
	.open = usbhid_open,
	.close = usbhid_close,
1088
	.power = usbhid_power,
J
Jiri Slaby 已提交
1089 1090 1091
	.hidinput_input_event = usb_hidinput_input_event,
};

L
Linus Torvalds 已提交
1092 1093
static int hid_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
J
Jiri Slaby 已提交
1094
	struct usb_host_interface *interface = intf->cur_altsetting;
J
Jiri Slaby 已提交
1095
	struct usb_device *dev = interface_to_usbdev(intf);
1096
	struct usbhid_device *usbhid;
L
Linus Torvalds 已提交
1097
	struct hid_device *hid;
J
Jiri Slaby 已提交
1098
	unsigned int n, has_in = 0;
J
Jiri Slaby 已提交
1099 1100
	size_t len;
	int ret;
L
Linus Torvalds 已提交
1101

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

J
Jiri Slaby 已提交
1105 1106 1107 1108 1109 1110 1111 1112 1113
	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 已提交
1114 1115 1116
	hid = hid_allocate_device();
	if (IS_ERR(hid))
		return PTR_ERR(hid);
L
Linus Torvalds 已提交
1117 1118

	usb_set_intfdata(intf, hid);
J
Jiri Slaby 已提交
1119 1120
	hid->ll_driver = &usb_hid_driver;
	hid->hid_output_raw_report = usbhid_output_raw_report;
J
Jiri Slaby 已提交
1121
	hid->ff_init = hid_pidff_init;
J
Jiri Slaby 已提交
1122
#ifdef CONFIG_USB_HIDDEV
J
Jiri Slaby 已提交
1123
	hid->hiddev_connect = hiddev_connect;
J
Jiri Slaby 已提交
1124 1125 1126 1127 1128 1129 1130 1131
	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;
1132 1133 1134
	if (intf->cur_altsetting->desc.bInterfaceProtocol ==
			USB_INTERFACE_PROTOCOL_MOUSE)
		hid->type = HID_TYPE_USBMOUSE;
L
Linus Torvalds 已提交
1135

J
Jiri Slaby 已提交
1136 1137
	if (dev->manufacturer)
		strlcpy(hid->name, dev->manufacturer, sizeof(hid->name));
L
Linus Torvalds 已提交
1138

J
Jiri Slaby 已提交
1139 1140 1141 1142
	if (dev->product) {
		if (dev->manufacturer)
			strlcat(hid->name, " ", sizeof(hid->name));
		strlcat(hid->name, dev->product, sizeof(hid->name));
L
Linus Torvalds 已提交
1143 1144
	}

J
Jiri Slaby 已提交
1145 1146 1147 1148
	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 已提交
1149

J
Jiri Slaby 已提交
1150 1151 1152 1153 1154 1155 1156 1157 1158
	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 已提交
1159

1160 1161 1162 1163 1164 1165 1166 1167 1168
	usbhid = kzalloc(sizeof(*usbhid), GFP_KERNEL);
	if (usbhid == NULL) {
		ret = -ENOMEM;
		goto err;
	}

	hid->driver_data = usbhid;
	usbhid->hid = hid;

J
Jiri Slaby 已提交
1169 1170
	ret = hid_add_device(hid);
	if (ret) {
J
Jiri Slaby 已提交
1171 1172
		if (ret != -ENODEV)
			dev_err(&intf->dev, "can't add hid device: %d\n", ret);
1173
		goto err_free;
J
Jiri Slaby 已提交
1174
	}
J
Jiri Slaby 已提交
1175 1176

	return 0;
1177 1178
err_free:
	kfree(usbhid);
J
Jiri Slaby 已提交
1179 1180
err:
	hid_destroy_device(hid);
J
Jiri Slaby 已提交
1181
	return ret;
L
Linus Torvalds 已提交
1182 1183
}

J
Jiri Slaby 已提交
1184 1185 1186
static void hid_disconnect(struct usb_interface *intf)
{
	struct hid_device *hid = usb_get_intfdata(intf);
1187
	struct usbhid_device *usbhid;
J
Jiri Slaby 已提交
1188 1189 1190 1191

	if (WARN_ON(!hid))
		return;

1192
	usbhid = hid->driver_data;
J
Jiri Slaby 已提交
1193
	hid_destroy_device(hid);
1194
	kfree(usbhid);
J
Jiri Slaby 已提交
1195 1196
}

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
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);
	flush_scheduled_work();
}

1213
#ifdef CONFIG_PM
1214
static int hid_suspend(struct usb_interface *intf, pm_message_t message)
L
Linus Torvalds 已提交
1215
{
1216
	struct hid_device *hid = usb_get_intfdata(intf);
J
Jiri Kosina 已提交
1217
	struct usbhid_device *usbhid = hid->driver_data;
1218 1219
	struct usb_device *udev = interface_to_usbdev(intf);
	int status;
L
Linus Torvalds 已提交
1220

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	if (udev->auto_pm) {
		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;
		}
1237

1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
	} 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;
	}

	if (!ignoreled && udev->auto_pm) {
		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);

	if (udev->auto_pm && test_bit(HID_KEYS_PRESSED, &usbhid->iofl)) {
		/* 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 已提交
1267 1268 1269 1270 1271 1272 1273
	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 已提交
1274
	struct usbhid_device *usbhid = hid->driver_data;
L
Linus Torvalds 已提交
1275 1276
	int status;

1277
	if (!test_bit(HID_STARTED, &usbhid->iofl))
1278 1279
		return 0;

1280 1281 1282 1283 1284 1285
	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 已提交
1286
	usbhid->retry_delay = 0;
A
Alan Stern 已提交
1287
	status = hid_start_in(hid);
1288 1289 1290 1291
	if (status < 0)
		hid_io_error(hid);
	usbhid_restart_queues(usbhid);

L
Linus Torvalds 已提交
1292
	dev_dbg(&intf->dev, "resume status %d\n", status);
1293
	return 0;
L
Linus Torvalds 已提交
1294 1295
}

1296 1297
#endif /* CONFIG_PM */

1298
/* Treat USB reset pretty much the same as suspend/resume */
A
Alan Stern 已提交
1299
static int hid_pre_reset(struct usb_interface *intf)
1300
{
1301 1302 1303 1304 1305 1306 1307 1308
	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);

A
Alan Stern 已提交
1309
	return 0;
1310 1311
}

A
Alan Stern 已提交
1312 1313
/* Same routine used for post_reset and reset_resume */
static int hid_post_reset(struct usb_interface *intf)
1314 1315
{
	struct usb_device *dev = interface_to_usbdev (intf);
1316 1317 1318 1319 1320 1321 1322
	struct hid_device *hid = usb_get_intfdata(intf);
	struct usbhid_device *usbhid = hid->driver_data;
	int status;
 
	spin_lock_irq(&usbhid->lock);
	clear_bit(HID_RESET_PENDING, &usbhid->iofl);
	spin_unlock_irq(&usbhid->lock);
1323 1324
	hid_set_idle(dev, intf->cur_altsetting->desc.bInterfaceNumber, 0, 0);
	/* FIXME: Any more reinitialization needed? */
1325 1326 1327 1328
	status = hid_start_in(hid);
	if (status < 0)
		hid_io_error(hid);
	usbhid_restart_queues(usbhid);
1329

1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
	return 0;
}

int usbhid_get_power(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
 
	return usb_autopm_get_interface(usbhid->intf);
}

void usbhid_put_power(struct hid_device *hid)
{
	struct usbhid_device *usbhid = hid->driver_data;
 
	usb_autopm_put_interface(usbhid->intf);
1345 1346
}

L
Linus Torvalds 已提交
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
static struct usb_device_id hid_usb_ids [] = {
	{ .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",
	.probe =	hid_probe,
	.disconnect =	hid_disconnect,
1359
#ifdef CONFIG_PM
L
Linus Torvalds 已提交
1360 1361
	.suspend =	hid_suspend,
	.resume =	hid_resume,
A
Alan Stern 已提交
1362
	.reset_resume =	hid_post_reset,
1363
#endif
1364 1365
	.pre_reset =	hid_pre_reset,
	.post_reset =	hid_post_reset,
L
Linus Torvalds 已提交
1366
	.id_table =	hid_usb_ids,
1367
	.supports_autosuspend = 1,
L
Linus Torvalds 已提交
1368 1369
};

J
Jiri Slaby 已提交
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
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 已提交
1380 1381
static int __init hid_init(void)
{
1382 1383 1384 1385 1386
	int retval = -ENOMEM;

	resumption_waker = create_freezeable_workqueue("usbhid_resumer");
	if (!resumption_waker)
		goto no_queue;
J
Jiri Slaby 已提交
1387 1388 1389
	retval = hid_register_driver(&hid_usb_driver);
	if (retval)
		goto hid_register_fail;
1390 1391 1392
	retval = usbhid_quirks_init(quirks_param);
	if (retval)
		goto usbhid_quirks_init_fail;
L
Linus Torvalds 已提交
1393 1394 1395 1396 1397 1398
	retval = hiddev_init();
	if (retval)
		goto hiddev_init_fail;
	retval = usb_register(&hid_driver);
	if (retval)
		goto usb_register_fail;
1399 1400
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
			DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1401 1402 1403 1404 1405

	return 0;
usb_register_fail:
	hiddev_exit();
hiddev_init_fail:
1406 1407
	usbhid_quirks_exit();
usbhid_quirks_init_fail:
J
Jiri Slaby 已提交
1408 1409
	hid_unregister_driver(&hid_usb_driver);
hid_register_fail:
1410 1411
	destroy_workqueue(resumption_waker);
no_queue:
L
Linus Torvalds 已提交
1412 1413 1414 1415 1416 1417 1418
	return retval;
}

static void __exit hid_exit(void)
{
	usb_deregister(&hid_driver);
	hiddev_exit();
1419
	usbhid_quirks_exit();
J
Jiri Slaby 已提交
1420
	hid_unregister_driver(&hid_usb_driver);
1421
	destroy_workqueue(resumption_waker);
L
Linus Torvalds 已提交
1422 1423 1424 1425 1426 1427 1428 1429
}

module_init(hid_init);
module_exit(hid_exit);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE(DRIVER_LICENSE);