wacom_sys.c 15.9 KB
Newer Older
1
/*
2
 * drivers/input/tablet/wacom_sys.c
3
 *
4
 *  USB Wacom tablet support - system specific code
5 6 7 8 9 10 11 12 13 14
 */

/*
 * 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 "wacom_wac.h"
15
#include "wacom.h"
16

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/* defines to get HID report descriptor */
#define HID_DEVICET_HID		(USB_TYPE_CLASS | 0x01)
#define HID_DEVICET_REPORT	(USB_TYPE_CLASS | 0x02)
#define HID_USAGE_UNDEFINED		0x00
#define HID_USAGE_PAGE			0x05
#define HID_USAGE_PAGE_DIGITIZER	0x0d
#define HID_USAGE_PAGE_DESKTOP		0x01
#define HID_USAGE			0x09
#define HID_USAGE_X			0x30
#define HID_USAGE_Y			0x31
#define HID_USAGE_X_TILT		0x3d
#define HID_USAGE_Y_TILT		0x3e
#define HID_USAGE_FINGER		0x22
#define HID_USAGE_STYLUS		0x20
#define HID_COLLECTION			0xc0

enum {
	WCM_UNDEFINED = 0,
	WCM_DESKTOP,
	WCM_DIGITIZER,
};

struct hid_descriptor {
	struct usb_descriptor_header header;
	__le16   bcdHID;
	u8       bCountryCode;
	u8       bNumDescriptors;
	u8       bDescriptorType;
	__le16   wDescriptorLength;
} __attribute__ ((packed));

/* defines to get/set USB message */
49 50
#define USB_REQ_GET_REPORT	0x01
#define USB_REQ_SET_REPORT	0x09
51
#define WAC_HID_FEATURE_REPORT	0x03
52
#define WAC_MSG_RETRIES		5
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

static int usb_get_report(struct usb_interface *intf, unsigned char type,
				unsigned char id, void *buf, int size)
{
	return usb_control_msg(interface_to_usbdev(intf),
		usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
		USB_REQ_GET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		(type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
		buf, size, 100);
}

static int usb_set_report(struct usb_interface *intf, unsigned char type,
				unsigned char id, void *buf, int size)
{
	return usb_control_msg(interface_to_usbdev(intf),
		usb_sndctrlpipe(interface_to_usbdev(intf), 0),
                USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
                (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
		buf, size, 1000);
}

74
static void wacom_sys_irq(struct urb *urb)
75 76 77 78 79 80 81 82 83 84 85 86
{
	struct wacom *wacom = urb->context;
	int retval;

	switch (urb->status) {
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
87
		dbg("%s - urb shutting down with status: %d", __func__, urb->status);
88 89
		return;
	default:
90
		dbg("%s - nonzero urb status received: %d", __func__, urb->status);
91 92 93
		goto exit;
	}

94
	wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
95 96

 exit:
97
	usb_mark_last_busy(wacom->usbdev);
98
	retval = usb_submit_urb(urb, GFP_ATOMIC);
99 100
	if (retval)
		err ("%s - usb_submit_urb failed with result %d",
101
		     __func__, retval);
102 103 104 105
}

static int wacom_open(struct input_dev *dev)
{
106
	struct wacom *wacom = input_get_drvdata(dev);
107
	int retval = 0;
108

109
	if (usb_autopm_get_interface(wacom->intf) < 0)
110
		return -EIO;
111 112

	mutex_lock(&wacom->lock);
113 114

	if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
115 116
		retval = -EIO;
		goto out;
117 118
	}

119
	wacom->open = true;
120
	wacom->intf->needs_remote_wakeup = 1;
121

122
out:
123
	mutex_unlock(&wacom->lock);
124
	usb_autopm_put_interface(wacom->intf);
125
	return retval;
126 127 128 129
}

static void wacom_close(struct input_dev *dev)
{
130
	struct wacom *wacom = input_get_drvdata(dev);
131 132 133
	int autopm_error;

	autopm_error = usb_autopm_get_interface(wacom->intf);
134

135
	mutex_lock(&wacom->lock);
136
	usb_kill_urb(wacom->irq);
137
	wacom->open = false;
138 139
	wacom->intf->needs_remote_wakeup = 0;
	mutex_unlock(&wacom->lock);
140

141 142
	if (!autopm_error)
		usb_autopm_put_interface(wacom->intf);
143 144
}

145
static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
146
			   struct wacom_features *features)
147 148
{
	struct usb_device *dev = interface_to_usbdev(intf);
149 150 151
	char limit = 0;
	/* result has to be defined as int for some devices */
	int result = 0;
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
	int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
	unsigned char *report;

	report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
	if (!report)
		return -ENOMEM;

	/* retrive report descriptors */
	do {
		result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
			USB_REQ_GET_DESCRIPTOR,
			USB_RECIP_INTERFACE | USB_DIR_IN,
			HID_DEVICET_REPORT << 8,
			intf->altsetting[0].desc.bInterfaceNumber, /* interface */
			report,
			hid_desc->wDescriptorLength,
			5000); /* 5 secs */
169
	} while (result < 0 && limit++ < WAC_MSG_RETRIES);
170

171
	/* No need to parse the Descriptor. It isn't an error though */
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
	if (result < 0)
		goto out;

	for (i = 0; i < hid_desc->wDescriptorLength; i++) {

		switch (report[i]) {
		case HID_USAGE_PAGE:
			switch (report[i + 1]) {
			case HID_USAGE_PAGE_DIGITIZER:
				usage = WCM_DIGITIZER;
				i++;
				break;

			case HID_USAGE_PAGE_DESKTOP:
				usage = WCM_DESKTOP;
				i++;
				break;
			}
			break;

		case HID_USAGE:
			switch (report[i + 1]) {
			case HID_USAGE_X:
				if (usage == WCM_DESKTOP) {
					if (finger) {
197
						features->device_type = BTN_TOOL_FINGER;
198 199 200
						if (features->type == TABLETPC2FG) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_TPC2FG;
201
							features->device_type = BTN_TOOL_DOUBLETAP;
202
						}
203 204 205
						if (features->type == BAMBOO_PT) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_BBTOUCH;
206
							features->device_type = BTN_TOOL_DOUBLETAP;
207 208 209 210 211 212 213 214 215 216 217 218 219 220
							features->x_phy =
								get_unaligned_le16(&report[i + 5]);
							features->x_max =
								get_unaligned_le16(&report[i + 8]);
							i += 15;
						} else {
							features->x_max =
								get_unaligned_le16(&report[i + 3]);
							features->x_phy =
								get_unaligned_le16(&report[i + 6]);
							features->unit = report[i + 9];
							features->unitExpo = report[i + 11];
							i += 12;
						}
221
					} else if (pen) {
222 223
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
224
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
225 226
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
227
						features->device_type = BTN_TOOL_PEN;
228
						features->x_max =
229
							get_unaligned_le16(&report[i + 3]);
230 231 232 233 234 235 236 237 238 239 240 241 242
						i += 4;
					}
				} else if (usage == WCM_DIGITIZER) {
					/* max pressure isn't reported
					features->pressure_max = (unsigned short)
							(report[i+4] << 8  | report[i + 3]);
					*/
					features->pressure_max = 255;
					i += 4;
				}
				break;

			case HID_USAGE_Y:
243 244
				if (usage == WCM_DESKTOP) {
					if (finger) {
245
						features->device_type = BTN_TOOL_FINGER;
246 247 248
						if (features->type == TABLETPC2FG) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_TPC2FG;
249
							features->device_type = BTN_TOOL_DOUBLETAP;
250
							features->y_max =
251
								get_unaligned_le16(&report[i + 3]);
252
							features->y_phy =
253
								get_unaligned_le16(&report[i + 6]);
254
							i += 7;
255 256 257
						} else if (features->type == BAMBOO_PT) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_BBTOUCH;
258
							features->device_type = BTN_TOOL_DOUBLETAP;
259 260 261 262 263
							features->y_phy =
								get_unaligned_le16(&report[i + 3]);
							features->y_max =
								get_unaligned_le16(&report[i + 6]);
							i += 12;
264 265 266 267
						} else {
							features->y_max =
								features->x_max;
							features->y_phy =
268
								get_unaligned_le16(&report[i + 3]);
269 270 271 272 273
							i += 4;
						}
					} else if (pen) {
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
274
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
275 276
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
277 278
						features->device_type = BTN_TOOL_PEN;
						features->y_max =
279
							get_unaligned_le16(&report[i + 3]);
280 281 282
						i += 4;
					}
				}
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
				break;

			case HID_USAGE_FINGER:
				finger = 1;
				i++;
				break;

			case HID_USAGE_STYLUS:
				pen = 1;
				i++;
				break;

			case HID_USAGE_UNDEFINED:
				if (usage == WCM_DESKTOP && finger) /* capacity */
					features->pressure_max =
298
						get_unaligned_le16(&report[i + 3]);
299 300 301 302 303 304
				i += 4;
				break;
			}
			break;

		case HID_COLLECTION:
305
			/* reset UsagePage and Finger */
306 307 308 309 310 311
			finger = usage = 0;
			break;
		}
	}

 out:
312
	result = 0;
313 314 315 316
	kfree(report);
	return result;
}

317
static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
318 319
{
	unsigned char *rep_data;
320 321
	int limit = 0, report_id = 2;
	int error = -ENOMEM;
322 323 324

	rep_data = kmalloc(2, GFP_KERNEL);
	if (!rep_data)
325 326
		return error;

327 328 329
	/* ask to report tablet data if it is 2FGT Tablet PC or
	 * not a Tablet PC */
	if (features->type == TABLETPC2FG) {
330 331 332 333 334 335 336 337 338 339
		do {
			rep_data[0] = 3;
			rep_data[1] = 4;
			report_id = 3;
			error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
				report_id, rep_data, 2);
			if (error >= 0)
				error = usb_get_report(intf,
					WAC_HID_FEATURE_REPORT, report_id,
					rep_data, 3);
340
		} while ((error < 0 || rep_data[1] != 4) && limit++ < WAC_MSG_RETRIES);
341
	} else if (features->type != TABLETPC) {
342 343 344 345 346 347 348 349 350
		do {
			rep_data[0] = 2;
			rep_data[1] = 2;
			error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
				report_id, rep_data, 2);
			if (error >= 0)
				error = usb_get_report(intf,
					WAC_HID_FEATURE_REPORT, report_id,
					rep_data, 2);
351
		} while ((error < 0 || rep_data[1] != 2) && limit++ < WAC_MSG_RETRIES);
352
	}
353 354 355 356 357 358

	kfree(rep_data);

	return error < 0 ? error : 0;
}

359 360 361 362 363 364 365
static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
		struct wacom_features *features)
{
	int error = 0;
	struct usb_host_interface *interface = intf->cur_altsetting;
	struct hid_descriptor *hid_desc;

366
	/* default features */
367
	features->device_type = BTN_TOOL_PEN;
368 369 370 371
	features->x_fuzz = 4;
	features->y_fuzz = 4;
	features->pressure_fuzz = 0;
	features->distance_fuzz = 0;
372

373
	/* only Tablet PCs and Bamboo P&T need to retrieve the info */
374 375
	if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
	    (features->type != BAMBOO_PT))
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
		goto out;

	if (usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc)) {
		if (usb_get_extra_descriptor(&interface->endpoint[0],
				HID_DEVICET_REPORT, &hid_desc)) {
			printk("wacom: can not retrieve extra class descriptor\n");
			error = 1;
			goto out;
		}
	}
	error = wacom_parse_hid(intf, hid_desc, features);
	if (error)
		goto out;

 out:
	return error;
}

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
struct wacom_usbdev_data {
	struct list_head list;
	struct kref kref;
	struct usb_device *dev;
	struct wacom_shared shared;
};

static LIST_HEAD(wacom_udev_list);
static DEFINE_MUTEX(wacom_udev_list_lock);

static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
{
	struct wacom_usbdev_data *data;

	list_for_each_entry(data, &wacom_udev_list, list) {
		if (data->dev == dev) {
			kref_get(&data->kref);
			return data;
		}
	}

	return NULL;
}

static int wacom_add_shared_data(struct wacom_wac *wacom,
				 struct usb_device *dev)
{
	struct wacom_usbdev_data *data;
	int retval = 0;

	mutex_lock(&wacom_udev_list_lock);

	data = wacom_get_usbdev_data(dev);
	if (!data) {
		data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
		if (!data) {
			retval = -ENOMEM;
			goto out;
		}

		kref_init(&data->kref);
		data->dev = dev;
		list_add_tail(&data->list, &wacom_udev_list);
	}

	wacom->shared = &data->shared;

out:
	mutex_unlock(&wacom_udev_list_lock);
	return retval;
}

static void wacom_release_shared_data(struct kref *kref)
{
	struct wacom_usbdev_data *data =
		container_of(kref, struct wacom_usbdev_data, kref);

	mutex_lock(&wacom_udev_list_lock);
	list_del(&data->list);
	mutex_unlock(&wacom_udev_list_lock);

	kfree(data);
}

static void wacom_remove_shared_data(struct wacom_wac *wacom)
{
	struct wacom_usbdev_data *data;

	if (wacom->shared) {
		data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
		kref_put(&data->kref, wacom_release_shared_data);
		wacom->shared = NULL;
	}
}

469 470 471 472 473 474
static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *dev = interface_to_usbdev(intf);
	struct usb_endpoint_descriptor *endpoint;
	struct wacom *wacom;
	struct wacom_wac *wacom_wac;
475
	struct wacom_features *features;
476
	struct input_dev *input_dev;
477
	int error;
478

479
	if (!id->driver_info)
480 481
		return -EINVAL;

482 483
	wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
	input_dev = input_allocate_device();
484
	if (!wacom || !input_dev) {
485 486 487 488
		error = -ENOMEM;
		goto fail1;
	}

489
	wacom_wac = &wacom->wacom_wac;
490 491 492 493
	wacom_wac->features = *((struct wacom_features *)id->driver_info);
	features = &wacom_wac->features;
	if (features->pktlen > WACOM_PKGLEN_MAX) {
		error = -EINVAL;
494
		goto fail1;
495
	}
496

497 498
	wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
					     GFP_KERNEL, &wacom->data_dma);
499 500
	if (!wacom_wac->data) {
		error = -ENOMEM;
501
		goto fail1;
502
	}
503 504

	wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
505 506
	if (!wacom->irq) {
		error = -ENOMEM;
507
		goto fail2;
508
	}
509 510

	wacom->usbdev = dev;
511 512
	wacom->intf = intf;
	mutex_init(&wacom->lock);
513 514 515
	usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
	strlcat(wacom->phys, "/input0", sizeof(wacom->phys));

516
	wacom_wac->input = input_dev;
517

518 519
	endpoint = &intf->cur_altsetting->endpoint[0].desc;

520 521 522
	/* Retrieve the physical and logical size for OEM devices */
	error = wacom_retrieve_hid_descriptor(intf, features);
	if (error)
523
		goto fail3;
524

525 526
	wacom_setup_device_quirks(features);

527 528
	strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));

529
	if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
530 531 532 533 534
		/* Append the device type to the name */
		strlcat(wacom_wac->name,
			features->device_type == BTN_TOOL_PEN ?
				" Pen" : " Finger",
			sizeof(wacom_wac->name));
535 536 537 538

		error = wacom_add_shared_data(wacom_wac, dev);
		if (error)
			goto fail3;
539 540
	}

541 542 543 544 545 546
	input_dev->name = wacom_wac->name;
	input_dev->dev.parent = &intf->dev;
	input_dev->open = wacom_open;
	input_dev->close = wacom_close;
	usb_to_input_id(dev, &input_dev->id);
	input_set_drvdata(input_dev, wacom);
547

548
	wacom_setup_input_capabilities(input_dev, wacom_wac);
549 550 551

	usb_fill_int_urb(wacom->irq, dev,
			 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
552
			 wacom_wac->data, features->pktlen,
P
Ping Cheng 已提交
553
			 wacom_sys_irq, wacom, endpoint->bInterval);
554 555 556
	wacom->irq->transfer_dma = wacom->data_dma;
	wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

557
	error = input_register_device(input_dev);
558
	if (error)
559
		goto fail4;
560

561 562
	/* Note that if query fails it is not a hard failure */
	wacom_query_tablet_data(intf, features);
563 564 565 566

	usb_set_intfdata(intf, wacom);
	return 0;

567
 fail4:	wacom_remove_shared_data(wacom_wac);
568
 fail3:	usb_free_urb(wacom->irq);
569
 fail2:	usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
570
 fail1:	input_free_device(input_dev);
571
	kfree(wacom);
572
	return error;
573 574 575 576
}

static void wacom_disconnect(struct usb_interface *intf)
{
577
	struct wacom *wacom = usb_get_intfdata(intf);
578 579

	usb_set_intfdata(intf, NULL);
580 581

	usb_kill_urb(wacom->irq);
582
	input_unregister_device(wacom->wacom_wac.input);
583
	usb_free_urb(wacom->irq);
584
	usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
585 586
			wacom->wacom_wac.data, wacom->data_dma);
	wacom_remove_shared_data(&wacom->wacom_wac);
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
	kfree(wacom);
}

static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct wacom *wacom = usb_get_intfdata(intf);

	mutex_lock(&wacom->lock);
	usb_kill_urb(wacom->irq);
	mutex_unlock(&wacom->lock);

	return 0;
}

static int wacom_resume(struct usb_interface *intf)
{
	struct wacom *wacom = usb_get_intfdata(intf);
604
	struct wacom_features *features = &wacom->wacom_wac.features;
605 606 607
	int rv;

	mutex_lock(&wacom->lock);
608 609 610 611 612

	/* switch to wacom mode first */
	wacom_query_tablet_data(intf, features);

	if (wacom->open)
613
		rv = usb_submit_urb(wacom->irq, GFP_NOIO);
614
	else
615
		rv = 0;
616

617 618 619 620 621 622 623 624
	mutex_unlock(&wacom->lock);

	return rv;
}

static int wacom_reset_resume(struct usb_interface *intf)
{
	return wacom_resume(intf);
625 626 627 628
}

static struct usb_driver wacom_driver = {
	.name =		"wacom",
629
	.id_table =	wacom_ids,
630 631
	.probe =	wacom_probe,
	.disconnect =	wacom_disconnect,
632 633 634 635
	.suspend =	wacom_suspend,
	.resume =	wacom_resume,
	.reset_resume =	wacom_reset_resume,
	.supports_autosuspend = 1,
636 637 638 639 640
};

static int __init wacom_init(void)
{
	int result;
641

642 643
	result = usb_register(&wacom_driver);
	if (result == 0)
644 645
		printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
		       DRIVER_DESC "\n");
646 647 648 649 650 651 652 653 654 655
	return result;
}

static void __exit wacom_exit(void)
{
	usb_deregister(&wacom_driver);
}

module_init(wacom_init);
module_exit(wacom_exit);