[mirror_ubuntu-zesty-kernel.git] / drivers / input / tablet / wacom_sys.c

/*
 * drivers/input/tablet/wacom_sys.c
 *
 *  USB Wacom tablet support - system specific code
 */

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

/* 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 */
#define USB_REQ_GET_REPORT	0x01
#define USB_REQ_SET_REPORT	0x09
#define WAC_HID_FEATURE_REPORT	0x03

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

static void wacom_sys_irq(struct urb *urb)
{
	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 */
		dbg("%s - urb shutting down with status: %d", __func__, urb->status);
		return;
	default:
		dbg("%s - nonzero urb status received: %d", __func__, urb->status);
		goto exit;
	}

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

 exit:
	usb_mark_last_busy(wacom->usbdev);
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval)
		err ("%s - usb_submit_urb failed with result %d",
		     __func__, retval);
}

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

	mutex_lock(&wacom->lock);

	wacom->irq->dev = wacom->usbdev;

	if (usb_autopm_get_interface(wacom->intf) < 0) {
		mutex_unlock(&wacom->lock);
		return -EIO;
	}

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

	wacom->open = true;
	wacom->intf->needs_remote_wakeup = 1;

	mutex_unlock(&wacom->lock);
	return 0;
}

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

	mutex_lock(&wacom->lock);
	usb_kill_urb(wacom->irq);
	wacom->open = false;
	wacom->intf->needs_remote_wakeup = 0;
	mutex_unlock(&wacom->lock);
}

static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
			   struct wacom_features *features)
{
	struct usb_device *dev = interface_to_usbdev(intf);
	char limit = 0;
	/* result has to be defined as int for some devices */
	int result = 0;
	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);

	/* No need to parse the Descriptor. It isn't an error though */
	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) {
						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;
						}
						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;
						}
					} else if (pen) {
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
						features->device_type = BTN_TOOL_PEN;
						features->x_max =
							get_unaligned_le16(&report[i + 3]);
						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:
				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 =
								get_unaligned_le16(&report[i + 3]);
							features->y_phy =
								get_unaligned_le16(&report[i + 6]);
							i += 7;
						} 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;
						} else {
							features->y_max =
								features->x_max;
							features->y_phy =
								get_unaligned_le16(&report[i + 3]);
							i += 4;
						}
					} else if (pen) {
						/* penabled only accepts exact bytes of data */
						if (features->type == TABLETPC2FG)
							features->pktlen = WACOM_PKGLEN_GRAPHIRE;
						if (features->type == BAMBOO_PT)
							features->pktlen = WACOM_PKGLEN_BBFUN;
						features->device_type = BTN_TOOL_PEN;
						features->y_max =
							get_unaligned_le16(&report[i + 3]);
						i += 4;
					}
				}
				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 =
						get_unaligned_le16(&report[i + 3]);
				i += 4;
				break;
			}
			break;

		case HID_COLLECTION:
			/* reset UsagePage and Finger */
			finger = usage = 0;
			break;
		}
	}

 out:
	result = 0;
	kfree(report);
	return result;
}

static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
{
	unsigned char *rep_data;
	int limit = 0, report_id = 2;
	int error = -ENOMEM;

	rep_data = kmalloc(2, GFP_KERNEL);
	if (!rep_data)
		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);
	}

	kfree(rep_data);

	return error < 0 ? error : 0;
}

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;

	/* default features */
	features->device_type = BTN_TOOL_PEN;
	features->x_fuzz = 4;
	features->y_fuzz = 4;
	features->pressure_fuzz = 0;
	features->distance_fuzz = 0;

	/* only Tablet PCs need to retrieve the info */
	if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
	    (features->type != BAMBOO_PT))
		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;

	/* touch device found but size is not defined. use default */
	if (features->device_type == BTN_TOOL_DOUBLETAP && !features->x_max) {
		features->x_max = 1023;
		features->y_max = 1023;
	}

 out:
	return error;
}

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

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;
	struct wacom_features *features;
	struct input_dev *input_dev;
	int error;

	if (!id->driver_info)
		return -EINVAL;

	wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!wacom || !input_dev) {
		error = -ENOMEM;
		goto fail1;
	}

	wacom_wac = &wacom->wacom_wac;
	wacom_wac->features = *((struct wacom_features *)id->driver_info);
	features = &wacom_wac->features;
	if (features->pktlen > WACOM_PKGLEN_MAX) {
		error = -EINVAL;
		goto fail1;
	}

	wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
					     GFP_KERNEL, &wacom->data_dma);
	if (!wacom_wac->data) {
		error = -ENOMEM;
		goto fail1;
	}

	wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
	if (!wacom->irq) {
		error = -ENOMEM;
		goto fail2;
	}

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

	wacom_wac->input = input_dev;

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

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

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

	if (features->type == TABLETPC || features->type == TABLETPC2FG ||
	    features->type == BAMBOO_PT) {
		/* Append the device type to the name */
		strlcat(wacom_wac->name,
			features->device_type == BTN_TOOL_PEN ?
				" Pen" : " Finger",
			sizeof(wacom_wac->name));

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

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

	wacom_setup_input_capabilities(input_dev, wacom_wac);

	usb_fill_int_urb(wacom->irq, dev,
			 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
			 wacom_wac->data, features->pktlen,
			 wacom_sys_irq, wacom, endpoint->bInterval);
	wacom->irq->transfer_dma = wacom->data_dma;
	wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	error = input_register_device(input_dev);
	if (error)
		goto fail4;

	/* Note that if query fails it is not a hard failure */
	wacom_query_tablet_data(intf, features);

	usb_set_intfdata(intf, wacom);
	return 0;

 fail4:	wacom_remove_shared_data(wacom_wac);
 fail3:	usb_free_urb(wacom->irq);
 fail2:	usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
 fail1:	input_free_device(input_dev);
	kfree(wacom);
	return error;
}

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

	usb_set_intfdata(intf, NULL);

	usb_kill_urb(wacom->irq);
	input_unregister_device(wacom->wacom_wac.input);
	usb_free_urb(wacom->irq);
	usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
			wacom->wacom_wac.data, wacom->data_dma);
	wacom_remove_shared_data(&wacom->wacom_wac);
	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);
	struct wacom_features *features = &wacom->wacom_wac.features;
	int rv;

	mutex_lock(&wacom->lock);

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

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

	mutex_unlock(&wacom->lock);

	return rv;
}

static int wacom_reset_resume(struct usb_interface *intf)
{
	return wacom_resume(intf);
}

static struct usb_driver wacom_driver = {
	.name =		"wacom",
	.id_table =	wacom_ids,
	.probe =	wacom_probe,
	.disconnect =	wacom_disconnect,
	.suspend =	wacom_suspend,
	.resume =	wacom_resume,
	.reset_resume =	wacom_reset_resume,
	.supports_autosuspend = 1,
};

static int __init wacom_init(void)
{
	int result;

	result = usb_register(&wacom_driver);
	if (result == 0)
		printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
		       DRIVER_DESC "\n");
	return result;
}

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

module_init(wacom_init);
module_exit(wacom_exit);
Commit	Line	Data
3bea733a	1	/*
4104d13f	2	* drivers/input/tablet/wacom_sys.c
3bea733a	3	*
232f5693	4	* USB Wacom tablet support - system specific code
3bea733a PC	5	*/
	6
	7	/*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*/
	13
3bea733a	14	#include "wacom_wac.h"
51269fe8	15	#include "wacom.h"
3bea733a	16
545f4e99 PC	17	/* defines to get HID report descriptor */
	18	#define HID_DEVICET_HID (USB_TYPE_CLASS \| 0x01)
	19	#define HID_DEVICET_REPORT (USB_TYPE_CLASS \| 0x02)
	20	#define HID_USAGE_UNDEFINED 0x00
	21	#define HID_USAGE_PAGE 0x05
	22	#define HID_USAGE_PAGE_DIGITIZER 0x0d
	23	#define HID_USAGE_PAGE_DESKTOP 0x01
	24	#define HID_USAGE 0x09
	25	#define HID_USAGE_X 0x30
	26	#define HID_USAGE_Y 0x31
	27	#define HID_USAGE_X_TILT 0x3d
	28	#define HID_USAGE_Y_TILT 0x3e
	29	#define HID_USAGE_FINGER 0x22
	30	#define HID_USAGE_STYLUS 0x20
	31	#define HID_COLLECTION 0xc0
	32
	33	enum {
	34	WCM_UNDEFINED = 0,
	35	WCM_DESKTOP,
	36	WCM_DIGITIZER,
	37	};
	38
	39	struct hid_descriptor {
	40	struct usb_descriptor_header header;
	41	__le16 bcdHID;
	42	u8 bCountryCode;
	43	u8 bNumDescriptors;
	44	u8 bDescriptorType;
	45	__le16 wDescriptorLength;
	46	} __attribute__ ((packed));
	47
	48	/* defines to get/set USB message */
3bea733a PC	49	#define USB_REQ_GET_REPORT 0x01
3bea733a PC	50	#define USB_REQ_SET_REPORT 0x09
545f4e99	51	#define WAC_HID_FEATURE_REPORT 0x03
3bea733a PC	52
	53	static int usb_get_report(struct usb_interface *intf, unsigned char type,
	54	unsigned char id, void *buf, int size)
	55	{
	56	return usb_control_msg(interface_to_usbdev(intf),
	57	usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
	58	USB_REQ_GET_REPORT, USB_TYPE_CLASS \| USB_RECIP_INTERFACE,
	59	(type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
	60	buf, size, 100);
	61	}
	62
	63	static int usb_set_report(struct usb_interface *intf, unsigned char type,
	64	unsigned char id, void *buf, int size)
	65	{
	66	return usb_control_msg(interface_to_usbdev(intf),
	67	usb_sndctrlpipe(interface_to_usbdev(intf), 0),
	68	USB_REQ_SET_REPORT, USB_TYPE_CLASS \| USB_RECIP_INTERFACE,
	69	(type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
	70	buf, size, 1000);
	71	}
	72
54c9b226	73	static void wacom_sys_irq(struct urb *urb)
3bea733a PC	74	{
3bea733a PC	75	struct wacom *wacom = urb->context;
3bea733a PC	76	int retval;
	77
	78	switch (urb->status) {
	79	case 0:
	80	/* success */
	81	break;
	82	case -ECONNRESET:
	83	case -ENOENT:
	84	case -ESHUTDOWN:
	85	/* this urb is terminated, clean up */
ea3e6c59	86	dbg("%s - urb shutting down with status: %d", __func__, urb->status);
3bea733a PC	87	return;
3bea733a PC	88	default:
ea3e6c59	89	dbg("%s - nonzero urb status received: %d", __func__, urb->status);
3bea733a PC	90	goto exit;
	91	}
	92
95dd3b30	93	wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
3bea733a PC	94
3bea733a PC	95	exit:
e7224094	96	usb_mark_last_busy(wacom->usbdev);
73a97f4f	97	retval = usb_submit_urb(urb, GFP_ATOMIC);
3bea733a PC	98	if (retval)
3bea733a PC	99	err ("%s - usb_submit_urb failed with result %d",
ea3e6c59	100	__func__, retval);
3bea733a PC	101	}
3bea733a PC	102
3bea733a PC	103	static int wacom_open(struct input_dev *dev)
3bea733a PC	104	{
7791bdae	105	struct wacom *wacom = input_get_drvdata(dev);
3bea733a	106
e7224094 ON	107	mutex_lock(&wacom->lock);
e7224094 ON	108
3bea733a	109	wacom->irq->dev = wacom->usbdev;
e7224094 ON	110
	111	if (usb_autopm_get_interface(wacom->intf) < 0) {
	112	mutex_unlock(&wacom->lock);
3bea733a	113	return -EIO;
e7224094 ON	114	}
	115
	116	if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
	117	usb_autopm_put_interface(wacom->intf);
	118	mutex_unlock(&wacom->lock);
	119	return -EIO;
	120	}
	121
51269fe8	122	wacom->open = true;
e7224094	123	wacom->intf->needs_remote_wakeup = 1;
3bea733a	124
e7224094	125	mutex_unlock(&wacom->lock);
3bea733a PC	126	return 0;
	127	}
	128
	129	static void wacom_close(struct input_dev *dev)
	130	{
7791bdae	131	struct wacom *wacom = input_get_drvdata(dev);
3bea733a	132
e7224094	133	mutex_lock(&wacom->lock);
3bea733a	134	usb_kill_urb(wacom->irq);
51269fe8	135	wacom->open = false;
e7224094 ON	136	wacom->intf->needs_remote_wakeup = 0;
e7224094 ON	137	mutex_unlock(&wacom->lock);
3bea733a PC	138	}
3bea733a PC	139
545f4e99	140	static int wacom_parse_hid(struct usb_interface intf, struct hid_descriptor hid_desc,
ec67bbed	141	struct wacom_features *features)
545f4e99 PC	142	{
545f4e99 PC	143	struct usb_device *dev = interface_to_usbdev(intf);
ec67bbed PC	144	char limit = 0;
	145	/* result has to be defined as int for some devices */
	146	int result = 0;
545f4e99 PC	147	int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
	148	unsigned char *report;
	149
	150	report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
	151	if (!report)
	152	return -ENOMEM;
	153
	154	/* retrive report descriptors */
	155	do {
	156	result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
	157	USB_REQ_GET_DESCRIPTOR,
	158	USB_RECIP_INTERFACE \| USB_DIR_IN,
	159	HID_DEVICET_REPORT << 8,
	160	intf->altsetting[0].desc.bInterfaceNumber, /* interface */
	161	report,
	162	hid_desc->wDescriptorLength,
	163	5000); /* 5 secs */
	164	} while (result < 0 && limit++ < 5);
	165
384318ec	166	/* No need to parse the Descriptor. It isn't an error though */
545f4e99 PC	167	if (result < 0)
	168	goto out;
	169
	170	for (i = 0; i < hid_desc->wDescriptorLength; i++) {
	171
	172	switch (report[i]) {
	173	case HID_USAGE_PAGE:
	174	switch (report[i + 1]) {
	175	case HID_USAGE_PAGE_DIGITIZER:
	176	usage = WCM_DIGITIZER;
	177	i++;
	178	break;
	179
	180	case HID_USAGE_PAGE_DESKTOP:
	181	usage = WCM_DESKTOP;
	182	i++;
	183	break;
	184	}
	185	break;
	186
	187	case HID_USAGE:
	188	switch (report[i + 1]) {
	189	case HID_USAGE_X:
	190	if (usage == WCM_DESKTOP) {
	191	if (finger) {
ec67bbed PC	192	features->device_type = BTN_TOOL_DOUBLETAP;
	193	if (features->type == TABLETPC2FG) {
	194	/* need to reset back */
	195	features->pktlen = WACOM_PKGLEN_TPC2FG;
	196	features->device_type = BTN_TOOL_TRIPLETAP;
	197	}
4a88081e PC	198	if (features->type == BAMBOO_PT) {
	199	/* need to reset back */
	200	features->pktlen = WACOM_PKGLEN_BBTOUCH;
	201	features->device_type = BTN_TOOL_TRIPLETAP;
	202	features->x_phy =
	203	get_unaligned_le16(&report[i + 5]);
	204	features->x_max =
	205	get_unaligned_le16(&report[i + 8]);
	206	i += 15;
	207	} else {
	208	features->x_max =
	209	get_unaligned_le16(&report[i + 3]);
	210	features->x_phy =
	211	get_unaligned_le16(&report[i + 6]);
	212	features->unit = report[i + 9];
	213	features->unitExpo = report[i + 11];
	214	i += 12;
	215	}
545f4e99	216	} else if (pen) {
ec67bbed PC	217	/* penabled only accepts exact bytes of data */
ec67bbed PC	218	if (features->type == TABLETPC2FG)
57e413d9	219	features->pktlen = WACOM_PKGLEN_GRAPHIRE;
4a88081e PC	220	if (features->type == BAMBOO_PT)
4a88081e PC	221	features->pktlen = WACOM_PKGLEN_BBFUN;
ec67bbed	222	features->device_type = BTN_TOOL_PEN;
545f4e99	223	features->x_max =
252f7769	224	get_unaligned_le16(&report[i + 3]);
545f4e99 PC	225	i += 4;
	226	}
	227	} else if (usage == WCM_DIGITIZER) {
	228	/* max pressure isn't reported
	229	features->pressure_max = (unsigned short)
	230	(report[i+4] << 8 \| report[i + 3]);
	231	*/
	232	features->pressure_max = 255;
	233	i += 4;
	234	}
	235	break;
	236
	237	case HID_USAGE_Y:
ec67bbed PC	238	if (usage == WCM_DESKTOP) {
	239	if (finger) {
	240	features->device_type = BTN_TOOL_DOUBLETAP;
	241	if (features->type == TABLETPC2FG) {
	242	/* need to reset back */
	243	features->pktlen = WACOM_PKGLEN_TPC2FG;
	244	features->device_type = BTN_TOOL_TRIPLETAP;
	245	features->y_max =
252f7769	246	get_unaligned_le16(&report[i + 3]);
ec67bbed	247	features->y_phy =
252f7769	248	get_unaligned_le16(&report[i + 6]);
ec67bbed	249	i += 7;
4a88081e PC	250	} else if (features->type == BAMBOO_PT) {
	251	/* need to reset back */
	252	features->pktlen = WACOM_PKGLEN_BBTOUCH;
	253	features->device_type = BTN_TOOL_TRIPLETAP;
	254	features->y_phy =
	255	get_unaligned_le16(&report[i + 3]);
	256	features->y_max =
	257	get_unaligned_le16(&report[i + 6]);
	258	i += 12;
ec67bbed PC	259	} else {
	260	features->y_max =
	261	features->x_max;
	262	features->y_phy =
252f7769	263	get_unaligned_le16(&report[i + 3]);
ec67bbed PC	264	i += 4;
	265	}
	266	} else if (pen) {
	267	/* penabled only accepts exact bytes of data */
	268	if (features->type == TABLETPC2FG)
57e413d9	269	features->pktlen = WACOM_PKGLEN_GRAPHIRE;
4a88081e PC	270	if (features->type == BAMBOO_PT)
4a88081e PC	271	features->pktlen = WACOM_PKGLEN_BBFUN;
ec67bbed PC	272	features->device_type = BTN_TOOL_PEN;
ec67bbed PC	273	features->y_max =
252f7769	274	get_unaligned_le16(&report[i + 3]);
ec67bbed PC	275	i += 4;
	276	}
	277	}
545f4e99 PC	278	break;
	279
	280	case HID_USAGE_FINGER:
	281	finger = 1;
	282	i++;
	283	break;
	284
	285	case HID_USAGE_STYLUS:
	286	pen = 1;
	287	i++;
	288	break;
	289
	290	case HID_USAGE_UNDEFINED:
	291	if (usage == WCM_DESKTOP && finger) /* capacity */
	292	features->pressure_max =
252f7769	293	get_unaligned_le16(&report[i + 3]);
545f4e99 PC	294	i += 4;
	295	break;
	296	}
	297	break;
	298
	299	case HID_COLLECTION:
ec67bbed	300	/* reset UsagePage and Finger */
545f4e99 PC	301	finger = usage = 0;
	302	break;
	303	}
	304	}
	305
545f4e99	306	out:
384318ec	307	result = 0;
545f4e99 PC	308	kfree(report);
	309	return result;
	310	}
	311
ec67bbed	312	static int wacom_query_tablet_data(struct usb_interface intf, struct wacom_features features)
3b7307c2 DT	313	{
3b7307c2 DT	314	unsigned char *rep_data;
ec67bbed PC	315	int limit = 0, report_id = 2;
ec67bbed PC	316	int error = -ENOMEM;
3b7307c2 DT	317
	318	rep_data = kmalloc(2, GFP_KERNEL);
	319	if (!rep_data)
ec67bbed PC	320	return error;
	321
	322	/* ask to report tablet data if it is 2FGT or not a Tablet PC */
	323	if (features->device_type == BTN_TOOL_TRIPLETAP) {
	324	do {
	325	rep_data[0] = 3;
	326	rep_data[1] = 4;
	327	report_id = 3;
	328	error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
	329	report_id, rep_data, 2);
	330	if (error >= 0)
	331	error = usb_get_report(intf,
	332	WAC_HID_FEATURE_REPORT, report_id,
	333	rep_data, 3);
	334	} while ((error < 0 \|\| rep_data[1] != 4) && limit++ < 5);
	335	} else if (features->type != TABLETPC && features->type != TABLETPC2FG) {
	336	do {
	337	rep_data[0] = 2;
	338	rep_data[1] = 2;
	339	error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
	340	report_id, rep_data, 2);
	341	if (error >= 0)
	342	error = usb_get_report(intf,
	343	WAC_HID_FEATURE_REPORT, report_id,
	344	rep_data, 2);
	345	} while ((error < 0 \|\| rep_data[1] != 2) && limit++ < 5);
	346	}
3b7307c2 DT	347
	348	kfree(rep_data);
	349
	350	return error < 0 ? error : 0;
	351	}
	352
ec67bbed PC	353	static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
	354	struct wacom_features *features)
	355	{
	356	int error = 0;
	357	struct usb_host_interface *interface = intf->cur_altsetting;
	358	struct hid_descriptor *hid_desc;
	359
fed87e65	360	/* default features */
ec67bbed	361	features->device_type = BTN_TOOL_PEN;
fed87e65 HR	362	features->x_fuzz = 4;
	363	features->y_fuzz = 4;
	364	features->pressure_fuzz = 0;
	365	features->distance_fuzz = 0;
ec67bbed PC	366
ec67bbed PC	367	/* only Tablet PCs need to retrieve the info */
4a88081e PC	368	if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
4a88081e PC	369	(features->type != BAMBOO_PT))
ec67bbed PC	370	goto out;
	371
	372	if (usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc)) {
	373	if (usb_get_extra_descriptor(&interface->endpoint[0],
	374	HID_DEVICET_REPORT, &hid_desc)) {
	375	printk("wacom: can not retrieve extra class descriptor\n");
	376	error = 1;
	377	goto out;
	378	}
	379	}
	380	error = wacom_parse_hid(intf, hid_desc, features);
	381	if (error)
	382	goto out;
	383
	384	/* touch device found but size is not defined. use default */
	385	if (features->device_type == BTN_TOOL_DOUBLETAP && !features->x_max) {
	386	features->x_max = 1023;
	387	features->y_max = 1023;
	388	}
	389
	390	out:
	391	return error;
	392	}
	393
4492efff PC	394	struct wacom_usbdev_data {
	395	struct list_head list;
	396	struct kref kref;
	397	struct usb_device *dev;
	398	struct wacom_shared shared;
	399	};
	400
	401	static LIST_HEAD(wacom_udev_list);
	402	static DEFINE_MUTEX(wacom_udev_list_lock);
	403
	404	static struct wacom_usbdev_data wacom_get_usbdev_data(struct usb_device dev)
	405	{
	406	struct wacom_usbdev_data *data;
	407
	408	list_for_each_entry(data, &wacom_udev_list, list) {
	409	if (data->dev == dev) {
	410	kref_get(&data->kref);
	411	return data;
	412	}
	413	}
	414
	415	return NULL;
	416	}
	417
	418	static int wacom_add_shared_data(struct wacom_wac *wacom,
	419	struct usb_device *dev)
	420	{
	421	struct wacom_usbdev_data *data;
	422	int retval = 0;
	423
	424	mutex_lock(&wacom_udev_list_lock);
	425
	426	data = wacom_get_usbdev_data(dev);
	427	if (!data) {
	428	data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
	429	if (!data) {
	430	retval = -ENOMEM;
	431	goto out;
	432	}
	433
	434	kref_init(&data->kref);
	435	data->dev = dev;
	436	list_add_tail(&data->list, &wacom_udev_list);
	437	}
	438
	439	wacom->shared = &data->shared;
	440
	441	out:
	442	mutex_unlock(&wacom_udev_list_lock);
	443	return retval;
	444	}
	445
	446	static void wacom_release_shared_data(struct kref *kref)
	447	{
	448	struct wacom_usbdev_data *data =
	449	container_of(kref, struct wacom_usbdev_data, kref);
	450
	451	mutex_lock(&wacom_udev_list_lock);
	452	list_del(&data->list);
	453	mutex_unlock(&wacom_udev_list_lock);
	454
	455	kfree(data);
	456	}
	457
458	static void wacom_remove_shared_data(struct wacom_wac *wacom)
459	{
460	struct wacom_usbdev_data *data;
461
462	if (wacom->shared) {
463	data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
464	kref_put(&data->kref, wacom_release_shared_data);
465	wacom->shared = NULL;
466	}
467	}
468
3bea733a PC	469	static int wacom_probe(struct usb_interface intf, const struct usb_device_id id)
	470	{
	471	struct usb_device *dev = interface_to_usbdev(intf);
	472	struct usb_endpoint_descriptor *endpoint;
	473	struct wacom *wacom;
	474	struct wacom_wac *wacom_wac;
e33da8a5	475	struct wacom_features *features;
3bea733a	476	struct input_dev *input_dev;
e33da8a5	477	int error;
3bea733a	478
e33da8a5	479	if (!id->driver_info)
b036f6fb BB	480	return -EINVAL;
b036f6fb BB	481
3bea733a	482	wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
3bea733a	483	input_dev = input_allocate_device();
51269fe8	484	if (!wacom \|\| !input_dev) {
e33da8a5 JC	485	error = -ENOMEM;
	486	goto fail1;
	487	}
	488
51269fe8	489	wacom_wac = &wacom->wacom_wac;
e33da8a5 JC	490	wacom_wac->features = ((struct wacom_features )id->driver_info);
	491	features = &wacom_wac->features;
	492	if (features->pktlen > WACOM_PKGLEN_MAX) {
	493	error = -EINVAL;
3bea733a	494	goto fail1;
e33da8a5	495	}
3bea733a	496
997ea58e DM	497	wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
997ea58e DM	498	GFP_KERNEL, &wacom->data_dma);
e33da8a5 JC	499	if (!wacom_wac->data) {
e33da8a5 JC	500	error = -ENOMEM;
3bea733a	501	goto fail1;
e33da8a5	502	}
3bea733a PC	503
3bea733a PC	504	wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
e33da8a5 JC	505	if (!wacom->irq) {
e33da8a5 JC	506	error = -ENOMEM;
3bea733a	507	goto fail2;
e33da8a5	508	}
3bea733a PC	509
3bea733a PC	510	wacom->usbdev = dev;
e7224094 ON	511	wacom->intf = intf;
e7224094 ON	512	mutex_init(&wacom->lock);
3bea733a PC	513	usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
	514	strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
	515
8da23fc1	516	wacom_wac->input = input_dev;
3bea733a	517
545f4e99 PC	518	endpoint = &intf->cur_altsetting->endpoint[0].desc;
545f4e99 PC	519
ec67bbed PC	520	/* Retrieve the physical and logical size for OEM devices */
	521	error = wacom_retrieve_hid_descriptor(intf, features);
	522	if (error)
	523	goto fail2;
545f4e99	524
49b764ae PC	525	strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
49b764ae PC	526
4a88081e PC	527	if (features->type == TABLETPC \|\| features->type == TABLETPC2FG \|\|
4a88081e PC	528	features->type == BAMBOO_PT) {
49b764ae PC	529	/* Append the device type to the name */
	530	strlcat(wacom_wac->name,
	531	features->device_type == BTN_TOOL_PEN ?
	532	" Pen" : " Finger",
	533	sizeof(wacom_wac->name));
4492efff PC	534
	535	error = wacom_add_shared_data(wacom_wac, dev);
	536	if (error)
	537	goto fail3;
49b764ae PC	538	}
49b764ae PC	539
8da23fc1 DT	540	input_dev->name = wacom_wac->name;
	541	input_dev->dev.parent = &intf->dev;
	542	input_dev->open = wacom_open;
	543	input_dev->close = wacom_close;
	544	usb_to_input_id(dev, &input_dev->id);
	545	input_set_drvdata(input_dev, wacom);
e33da8a5	546
8da23fc1	547	wacom_setup_input_capabilities(input_dev, wacom_wac);
3bea733a	548
3bea733a PC	549	usb_fill_int_urb(wacom->irq, dev,
3bea733a PC	550	usb_rcvintpipe(dev, endpoint->bEndpointAddress),
ec67bbed	551	wacom_wac->data, features->pktlen,
8d32e3ae	552	wacom_sys_irq, wacom, endpoint->bInterval);
3bea733a PC	553	wacom->irq->transfer_dma = wacom->data_dma;
	554	wacom->irq->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
	555
8da23fc1	556	error = input_register_device(input_dev);
5014186d	557	if (error)
4492efff	558	goto fail4;
3bea733a	559
ec67bbed PC	560	/* Note that if query fails it is not a hard failure */
ec67bbed PC	561	wacom_query_tablet_data(intf, features);
3bea733a PC	562
	563	usb_set_intfdata(intf, wacom);
	564	return 0;
	565
4492efff	566	fail4: wacom_remove_shared_data(wacom_wac);
5014186d	567	fail3: usb_free_urb(wacom->irq);
997ea58e	568	fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
5014186d	569	fail1: input_free_device(input_dev);
3bea733a	570	kfree(wacom);
5014186d	571	return error;
3bea733a PC	572	}
	573
	574	static void wacom_disconnect(struct usb_interface *intf)
	575	{
e7224094	576	struct wacom *wacom = usb_get_intfdata(intf);
3bea733a PC	577
3bea733a PC	578	usb_set_intfdata(intf, NULL);
e7224094 ON	579
e7224094 ON	580	usb_kill_urb(wacom->irq);
8da23fc1	581	input_unregister_device(wacom->wacom_wac.input);
e7224094	582	usb_free_urb(wacom->irq);
997ea58e	583	usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
51269fe8 DT	584	wacom->wacom_wac.data, wacom->data_dma);
51269fe8 DT	585	wacom_remove_shared_data(&wacom->wacom_wac);
e7224094 ON	586	kfree(wacom);
	587	}
	588
	589	static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
	590	{
	591	struct wacom *wacom = usb_get_intfdata(intf);
	592
	593	mutex_lock(&wacom->lock);
	594	usb_kill_urb(wacom->irq);
	595	mutex_unlock(&wacom->lock);
	596
	597	return 0;
	598	}
	599
	600	static int wacom_resume(struct usb_interface *intf)
	601	{
	602	struct wacom *wacom = usb_get_intfdata(intf);
51269fe8	603	struct wacom_features *features = &wacom->wacom_wac.features;
e7224094 ON	604	int rv;
	605
	606	mutex_lock(&wacom->lock);
38101475 PC	607
	608	/* switch to wacom mode first */
	609	wacom_query_tablet_data(intf, features);
	610
	611	if (wacom->open)
e7224094	612	rv = usb_submit_urb(wacom->irq, GFP_NOIO);
38101475	613	else
e7224094	614	rv = 0;
38101475	615
e7224094 ON	616	mutex_unlock(&wacom->lock);
	617
	618	return rv;
	619	}
	620
	621	static int wacom_reset_resume(struct usb_interface *intf)
	622	{
	623	return wacom_resume(intf);
3bea733a PC	624	}
	625
	626	static struct usb_driver wacom_driver = {
	627	.name = "wacom",
b036f6fb	628	.id_table = wacom_ids,
3bea733a PC	629	.probe = wacom_probe,
3bea733a PC	630	.disconnect = wacom_disconnect,
e7224094 ON	631	.suspend = wacom_suspend,
	632	.resume = wacom_resume,
	633	.reset_resume = wacom_reset_resume,
	634	.supports_autosuspend = 1,
3bea733a PC	635	};
	636
	637	static int __init wacom_init(void)
	638	{
	639	int result;
b036f6fb	640
3bea733a PC	641	result = usb_register(&wacom_driver);
3bea733a PC	642	if (result == 0)
899ef6e7 GKH	643	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
899ef6e7 GKH	644	DRIVER_DESC "\n");
3bea733a PC	645	return result;
	646	}
	647
	648	static void __exit wacom_exit(void)
	649	{
	650	usb_deregister(&wacom_driver);
	651	}
	652
	653	module_init(wacom_init);
	654	module_exit(wacom_exit);