wacom_sys.c 15.8 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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

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

73
static void wacom_sys_irq(struct urb *urb)
74 75 76 77 78 79 80 81 82 83 84 85
{
	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 */
86
		dbg("%s - urb shutting down with status: %d", __func__, urb->status);
87 88
		return;
	default:
89
		dbg("%s - nonzero urb status received: %d", __func__, urb->status);
90 91 92
		goto exit;
	}

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

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

static int wacom_open(struct input_dev *dev)
{
105
	struct wacom *wacom = input_get_drvdata(dev);
106

107 108
	mutex_lock(&wacom->lock);

109
	wacom->irq->dev = wacom->usbdev;
110 111 112

	if (usb_autopm_get_interface(wacom->intf) < 0) {
		mutex_unlock(&wacom->lock);
113
		return -EIO;
114 115 116 117 118 119 120 121
	}

	if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
		usb_autopm_put_interface(wacom->intf);
		mutex_unlock(&wacom->lock);
		return -EIO;
	}

122
	wacom->open = true;
123
	wacom->intf->needs_remote_wakeup = 1;
124

125
	mutex_unlock(&wacom->lock);
126 127 128 129 130
	return 0;
}

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

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

140
static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
141
			   struct wacom_features *features)
142 143
{
	struct usb_device *dev = interface_to_usbdev(intf);
144 145 146
	char limit = 0;
	/* result has to be defined as int for some devices */
	int result = 0;
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
	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 */
	} while (result < 0 && limit++ < 5);

166
	/* No need to parse the Descriptor. It isn't an error though */
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
	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) {
192 193 194 195 196 197
						features->device_type = BTN_TOOL_DOUBLETAP;
						if (features->type == TABLETPC2FG) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_TPC2FG;
							features->device_type = BTN_TOOL_TRIPLETAP;
						}
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
						if (features->type == BAMBOO_PT) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_BBTOUCH;
							features->device_type = BTN_TOOL_TRIPLETAP;
							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;
						}
216
					} else if (pen) {
217 218
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
219
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
220 221
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
222
						features->device_type = BTN_TOOL_PEN;
223
						features->x_max =
224
							get_unaligned_le16(&report[i + 3]);
225 226 227 228 229 230 231 232 233 234 235 236 237
						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:
238 239 240 241 242 243 244 245
				if (usage == WCM_DESKTOP) {
					if (finger) {
						features->device_type = BTN_TOOL_DOUBLETAP;
						if (features->type == TABLETPC2FG) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_TPC2FG;
							features->device_type = BTN_TOOL_TRIPLETAP;
							features->y_max =
246
								get_unaligned_le16(&report[i + 3]);
247
							features->y_phy =
248
								get_unaligned_le16(&report[i + 6]);
249
							i += 7;
250 251 252 253 254 255 256 257 258
						} else if (features->type == BAMBOO_PT) {
							/* need to reset back */
							features->pktlen = WACOM_PKGLEN_BBTOUCH;
							features->device_type = BTN_TOOL_TRIPLETAP;
							features->y_phy =
								get_unaligned_le16(&report[i + 3]);
							features->y_max =
								get_unaligned_le16(&report[i + 6]);
							i += 12;
259 260 261 262
						} else {
							features->y_max =
								features->x_max;
							features->y_phy =
263
								get_unaligned_le16(&report[i + 3]);
264 265 266 267 268
							i += 4;
						}
					} else if (pen) {
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
269
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
270 271
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
272 273
						features->device_type = BTN_TOOL_PEN;
						features->y_max =
274
							get_unaligned_le16(&report[i + 3]);
275 276 277
						i += 4;
					}
				}
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
				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 =
293
						get_unaligned_le16(&report[i + 3]);
294 295 296 297 298 299
				i += 4;
				break;
			}
			break;

		case HID_COLLECTION:
300
			/* reset UsagePage and Finger */
301 302 303 304 305 306
			finger = usage = 0;
			break;
		}
	}

 out:
307
	result = 0;
308 309 310 311
	kfree(report);
	return result;
}

312
static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
313 314
{
	unsigned char *rep_data;
315 316
	int limit = 0, report_id = 2;
	int error = -ENOMEM;
317 318 319

	rep_data = kmalloc(2, GFP_KERNEL);
	if (!rep_data)
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
		return error;

	/* ask to report tablet data if it is 2FGT or not a Tablet PC */
	if (features->device_type == BTN_TOOL_TRIPLETAP) {
		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);
		} while ((error < 0 || rep_data[1] != 4) && limit++ < 5);
	} else if (features->type != TABLETPC && features->type != TABLETPC2FG) {
		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);
		} while ((error < 0 || rep_data[1] != 2) && limit++ < 5);
	}
347 348 349 350 351 352

	kfree(rep_data);

	return error < 0 ? error : 0;
}

353 354 355 356 357 358 359
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;

360
	/* default features */
361
	features->device_type = BTN_TOOL_PEN;
362 363 364 365
	features->x_fuzz = 4;
	features->y_fuzz = 4;
	features->pressure_fuzz = 0;
	features->distance_fuzz = 0;
366 367

	/* only Tablet PCs need to retrieve the info */
368 369
	if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
	    (features->type != BAMBOO_PT))
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
		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;
}

388 389 390 391 392 393 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
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;
	}
}

463 464 465 466 467 468
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;
469
	struct wacom_features *features;
470
	struct input_dev *input_dev;
471
	int error;
472

473
	if (!id->driver_info)
474 475
		return -EINVAL;

476 477
	wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
	input_dev = input_allocate_device();
478
	if (!wacom || !input_dev) {
479 480 481 482
		error = -ENOMEM;
		goto fail1;
	}

483
	wacom_wac = &wacom->wacom_wac;
484 485 486 487
	wacom_wac->features = *((struct wacom_features *)id->driver_info);
	features = &wacom_wac->features;
	if (features->pktlen > WACOM_PKGLEN_MAX) {
		error = -EINVAL;
488
		goto fail1;
489
	}
490

491 492
	wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
					     GFP_KERNEL, &wacom->data_dma);
493 494
	if (!wacom_wac->data) {
		error = -ENOMEM;
495
		goto fail1;
496
	}
497 498

	wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
499 500
	if (!wacom->irq) {
		error = -ENOMEM;
501
		goto fail2;
502
	}
503 504

	wacom->usbdev = dev;
505 506
	wacom->intf = intf;
	mutex_init(&wacom->lock);
507 508 509
	usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
	strlcat(wacom->phys, "/input0", sizeof(wacom->phys));

510
	wacom_wac->input = input_dev;
511

512 513
	endpoint = &intf->cur_altsetting->endpoint[0].desc;

514 515 516 517
	/* Retrieve the physical and logical size for OEM devices */
	error = wacom_retrieve_hid_descriptor(intf, features);
	if (error)
		goto fail2;
518

519 520
	wacom_setup_device_quirks(features);

521 522
	strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));

523
	if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
524 525 526 527 528
		/* Append the device type to the name */
		strlcat(wacom_wac->name,
			features->device_type == BTN_TOOL_PEN ?
				" Pen" : " Finger",
			sizeof(wacom_wac->name));
529 530 531 532

		error = wacom_add_shared_data(wacom_wac, dev);
		if (error)
			goto fail3;
533 534
	}

535 536 537 538 539 540
	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);
541

542
	wacom_setup_input_capabilities(input_dev, wacom_wac);
543 544 545

	usb_fill_int_urb(wacom->irq, dev,
			 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
546
			 wacom_wac->data, features->pktlen,
P
Ping Cheng 已提交
547
			 wacom_sys_irq, wacom, endpoint->bInterval);
548 549 550
	wacom->irq->transfer_dma = wacom->data_dma;
	wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

551
	error = input_register_device(input_dev);
552
	if (error)
553
		goto fail4;
554

555 556
	/* Note that if query fails it is not a hard failure */
	wacom_query_tablet_data(intf, features);
557 558 559 560

	usb_set_intfdata(intf, wacom);
	return 0;

561
 fail4:	wacom_remove_shared_data(wacom_wac);
562
 fail3:	usb_free_urb(wacom->irq);
563
 fail2:	usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
564
 fail1:	input_free_device(input_dev);
565
	kfree(wacom);
566
	return error;
567 568 569 570
}

static void wacom_disconnect(struct usb_interface *intf)
{
571
	struct wacom *wacom = usb_get_intfdata(intf);
572 573

	usb_set_intfdata(intf, NULL);
574 575

	usb_kill_urb(wacom->irq);
576
	input_unregister_device(wacom->wacom_wac.input);
577
	usb_free_urb(wacom->irq);
578
	usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
579 580
			wacom->wacom_wac.data, wacom->data_dma);
	wacom_remove_shared_data(&wacom->wacom_wac);
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
	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);
598
	struct wacom_features *features = &wacom->wacom_wac.features;
599 600 601
	int rv;

	mutex_lock(&wacom->lock);
602 603 604 605 606

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

	if (wacom->open)
607
		rv = usb_submit_urb(wacom->irq, GFP_NOIO);
608
	else
609
		rv = 0;
610

611 612 613 614 615 616 617 618
	mutex_unlock(&wacom->lock);

	return rv;
}

static int wacom_reset_resume(struct usb_interface *intf)
{
	return wacom_resume(intf);
619 620 621 622
}

static struct usb_driver wacom_driver = {
	.name =		"wacom",
623
	.id_table =	wacom_ids,
624 625
	.probe =	wacom_probe,
	.disconnect =	wacom_disconnect,
626 627 628 629
	.suspend =	wacom_suspend,
	.resume =	wacom_resume,
	.reset_resume =	wacom_reset_resume,
	.supports_autosuspend = 1,
630 631 632 633 634
};

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

636 637
	result = usb_register(&wacom_driver);
	if (result == 0)
638 639
		printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
		       DRIVER_DESC "\n");
640 641 642 643 644 645 646 647 648 649
	return result;
}

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

module_init(wacom_init);
module_exit(wacom_exit);