[mirror_ubuntu-artful-kernel.git] / drivers / hid / hid-multitouch.c

/*
 *  HID driver for multitouch panels
 *
 *  Copyright (c) 2010-2011 Stephane Chatty <chatty@enac.fr>
 *  Copyright (c) 2010-2011 Benjamin Tissoires <benjamin.tissoires@gmail.com>
 *  Copyright (c) 2010-2011 Ecole Nationale de l'Aviation Civile, France
 *
 *  This code is partly based on hid-egalax.c:
 *
 *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
 *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
 *  Copyright (c) 2010 Canonical, Ltd.
 *
 */

/*
 * 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/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/usb.h>
#include <linux/input/mt.h>
#include "usbhid/usbhid.h"


MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
MODULE_DESCRIPTION("HID multitouch panels");
MODULE_LICENSE("GPL");

#include "hid-ids.h"

/* quirks to control the device */
#define MT_QUIRK_NOT_SEEN_MEANS_UP	(1 << 0)
#define MT_QUIRK_SLOT_IS_CONTACTID	(1 << 1)
#define MT_QUIRK_CYPRESS		(1 << 2)
#define MT_QUIRK_SLOT_IS_CONTACTNUMBER	(1 << 3)
#define MT_QUIRK_VALID_IS_INRANGE	(1 << 4)
#define MT_QUIRK_VALID_IS_CONFIDENCE	(1 << 5)
#define MT_QUIRK_EGALAX_XYZ_FIXUP	(1 << 6)

struct mt_slot {
	__s32 x, y, p, w, h;
	__s32 contactid;	/* the device ContactID assigned to this slot */
	bool touch_state;	/* is the touch valid? */
	bool seen_in_this_frame;/* has this slot been updated */
};

struct mt_device {
	struct mt_slot curdata;	/* placeholder of incoming data */
	struct mt_class *mtclass;	/* our mt device class */
	unsigned last_field_index;	/* last field index of the report */
	unsigned last_slot_field;	/* the last field of a slot */
	__s8 inputmode;		/* InputMode HID feature, -1 if non-existent */
	__u8 num_received;	/* how many contacts we received */
	__u8 num_expected;	/* expected last contact index */
	__u8 maxcontacts;
	bool curvalid;		/* is the current contact valid? */
	struct mt_slot *slots;
};

struct mt_class {
	__s32 name;	/* MT_CLS */
	__s32 quirks;
	__s32 sn_move;	/* Signal/noise ratio for move events */
	__s32 sn_pressure;	/* Signal/noise ratio for pressure events */
	__u8 maxcontacts;
};

/* classes of device behavior */
#define MT_CLS_DEFAULT				1
#define MT_CLS_DUAL_INRANGE_CONTACTID		2
#define MT_CLS_DUAL_INRANGE_CONTACTNUMBER	3
#define MT_CLS_CYPRESS				4
#define MT_CLS_EGALAX				5
#define MT_CLS_STANTUM				6

#define MT_DEFAULT_MAXCONTACT	10

/*
 * these device-dependent functions determine what slot corresponds
 * to a valid contact that was just read.
 */

static int cypress_compute_slot(struct mt_device *td)
{
	if (td->curdata.contactid != 0 || td->num_received == 0)
		return td->curdata.contactid;
	else
		return -1;
}

static int find_slot_from_contactid(struct mt_device *td)
{
	int i;
	for (i = 0; i < td->maxcontacts; ++i) {
		if (td->slots[i].contactid == td->curdata.contactid &&
			td->slots[i].touch_state)
			return i;
	}
	for (i = 0; i < td->maxcontacts; ++i) {
		if (!td->slots[i].seen_in_this_frame &&
			!td->slots[i].touch_state)
			return i;
	}
	/* should not occurs. If this happens that means
	 * that the device sent more touches that it says
	 * in the report descriptor. It is ignored then. */
	return -1;
}

struct mt_class mt_classes[] = {
	{ .name = MT_CLS_DEFAULT,
		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
	{ .name = MT_CLS_DUAL_INRANGE_CONTACTID,
		.quirks = MT_QUIRK_VALID_IS_INRANGE |
			MT_QUIRK_SLOT_IS_CONTACTID,
		.maxcontacts = 2 },
	{ .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
		.quirks = MT_QUIRK_VALID_IS_INRANGE |
			MT_QUIRK_SLOT_IS_CONTACTNUMBER,
		.maxcontacts = 2 },
	{ .name = MT_CLS_CYPRESS,
		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
			MT_QUIRK_CYPRESS,
		.maxcontacts = 10 },

	{ .name = MT_CLS_EGALAX,
		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
			MT_QUIRK_VALID_IS_INRANGE |
			MT_QUIRK_EGALAX_XYZ_FIXUP,
		.maxcontacts = 2,
		.sn_move = 4096,
		.sn_pressure = 32,
	},
	{ .name = MT_CLS_STANTUM,
		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE },

	{ }
};

static void mt_feature_mapping(struct hid_device *hdev,
		struct hid_field *field, struct hid_usage *usage)
{
	struct mt_device *td = hid_get_drvdata(hdev);

	switch (usage->hid) {
	case HID_DG_INPUTMODE:
		td->inputmode = field->report->id;
		break;
	case HID_DG_CONTACTMAX:
		td->maxcontacts = field->value[0];
		if (td->mtclass->maxcontacts)
			/* check if the maxcontacts is given by the class */
			td->maxcontacts = td->mtclass->maxcontacts;

		break;
	}
}

static void set_abs(struct input_dev *input, unsigned int code,
		struct hid_field *field, int snratio)
{
	int fmin = field->logical_minimum;
	int fmax = field->logical_maximum;
	int fuzz = snratio ? (fmax - fmin) / snratio : 0;
	input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
}

static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	struct mt_device *td = hid_get_drvdata(hdev);
	struct mt_class *cls = td->mtclass;
	__s32 quirks = cls->quirks;

	switch (usage->hid & HID_USAGE_PAGE) {

	case HID_UP_GENDESK:
		switch (usage->hid) {
		case HID_GD_X:
			if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
				field->logical_maximum = 32760;
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_POSITION_X);
			set_abs(hi->input, ABS_MT_POSITION_X, field,
				cls->sn_move);
			/* touchscreen emulation */
			set_abs(hi->input, ABS_X, field, cls->sn_move);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_GD_Y:
			if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
				field->logical_maximum = 32760;
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_POSITION_Y);
			set_abs(hi->input, ABS_MT_POSITION_Y, field,
				cls->sn_move);
			/* touchscreen emulation */
			set_abs(hi->input, ABS_Y, field, cls->sn_move);
			td->last_slot_field = usage->hid;
			return 1;
		}
		return 0;

	case HID_UP_DIGITIZER:
		switch (usage->hid) {
		case HID_DG_INRANGE:
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_CONFIDENCE:
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_TIPSWITCH:
			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
			input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_CONTACTID:
			input_mt_init_slots(hi->input, td->maxcontacts);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_WIDTH:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_TOUCH_MAJOR);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_HEIGHT:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_TOUCH_MINOR);
			field->logical_maximum = 1;
			field->logical_minimum = 0;
			set_abs(hi->input, ABS_MT_ORIENTATION, field, 0);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_TIPPRESSURE:
			if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
				field->logical_minimum = 0;
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_PRESSURE);
			set_abs(hi->input, ABS_MT_PRESSURE, field,
				cls->sn_pressure);
			/* touchscreen emulation */
			set_abs(hi->input, ABS_PRESSURE, field,
				cls->sn_pressure);
			td->last_slot_field = usage->hid;
			return 1;
		case HID_DG_CONTACTCOUNT:
			td->last_field_index = field->report->maxfield - 1;
			return 1;
		case HID_DG_CONTACTMAX:
			/* we don't set td->last_slot_field as contactcount and
			 * contact max are global to the report */
			return -1;
		}
		/* let hid-input decide for the others */
		return 0;

	case 0xff000000:
		/* we do not want to map these: no input-oriented meaning */
		return -1;
	}

	return 0;
}

static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	if (usage->type == EV_KEY || usage->type == EV_ABS)
		set_bit(usage->type, hi->input->evbit);

	return -1;
}

static int mt_compute_slot(struct mt_device *td)
{
	__s32 quirks = td->mtclass->quirks;

	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
		return td->curdata.contactid;

	if (quirks & MT_QUIRK_CYPRESS)
		return cypress_compute_slot(td);

	if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
		return td->num_received;

	return find_slot_from_contactid(td);
}

/*
 * this function is called when a whole contact has been processed,
 * so that it can assign it to a slot and store the data there
 */
static void mt_complete_slot(struct mt_device *td)
{
	td->curdata.seen_in_this_frame = true;
	if (td->curvalid) {
		int slotnum = mt_compute_slot(td);

		if (slotnum >= 0 && slotnum < td->maxcontacts)
			td->slots[slotnum] = td->curdata;
	}
	td->num_received++;
}


/*
 * this function is called when a whole packet has been received and processed,
 * so that it can decide what to send to the input layer.
 */
static void mt_emit_event(struct mt_device *td, struct input_dev *input)
{
	int i;

	for (i = 0; i < td->maxcontacts; ++i) {
		struct mt_slot *s = &(td->slots[i]);
		if ((td->mtclass->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
			!s->seen_in_this_frame) {
			s->touch_state = false;
		}

		input_mt_slot(input, i);
		input_mt_report_slot_state(input, MT_TOOL_FINGER,
			s->touch_state);
		if (s->touch_state) {
			input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
			input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
			input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
			input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, s->w);
			input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, s->h);
		}
		s->seen_in_this_frame = false;

	}

	input_mt_report_pointer_emulation(input, true);
	input_sync(input);
	td->num_received = 0;
}


static int mt_event(struct hid_device *hid, struct hid_field *field,
				struct hid_usage *usage, __s32 value)
{
	struct mt_device *td = hid_get_drvdata(hid);
	__s32 quirks = td->mtclass->quirks;

	if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
		switch (usage->hid) {
		case HID_DG_INRANGE:
			if (quirks & MT_QUIRK_VALID_IS_INRANGE)
				td->curvalid = value;
			break;
		case HID_DG_TIPSWITCH:
			if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
				td->curvalid = value;
			td->curdata.touch_state = value;
			break;
		case HID_DG_CONFIDENCE:
			if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
				td->curvalid = value;
			break;
		case HID_DG_CONTACTID:
			td->curdata.contactid = value;
			break;
		case HID_DG_TIPPRESSURE:
			td->curdata.p = value;
			break;
		case HID_GD_X:
			td->curdata.x = value;
			break;
		case HID_GD_Y:
			td->curdata.y = value;
			break;
		case HID_DG_WIDTH:
			td->curdata.w = value;
			break;
		case HID_DG_HEIGHT:
			td->curdata.h = value;
			break;
		case HID_DG_CONTACTCOUNT:
			/*
			 * Includes multi-packet support where subsequent
			 * packets are sent with zero contactcount.
			 */
			if (value)
				td->num_expected = value;
			break;

		default:
			/* fallback to the generic hidinput handling */
			return 0;
		}

		if (usage->hid == td->last_slot_field) {
			mt_complete_slot(td);
			if (!td->last_field_index)
				mt_emit_event(td, field->hidinput->input);
		}

		if (field->index == td->last_field_index
			&& td->num_received >= td->num_expected)
			mt_emit_event(td, field->hidinput->input);

	}

	/* we have handled the hidinput part, now remains hiddev */
	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
		hid->hiddev_hid_event(hid, field, usage, value);

	return 1;
}

static void mt_set_input_mode(struct hid_device *hdev)
{
	struct mt_device *td = hid_get_drvdata(hdev);
	struct hid_report *r;
	struct hid_report_enum *re;

	if (td->inputmode < 0)
		return;

	re = &(hdev->report_enum[HID_FEATURE_REPORT]);
	r = re->report_id_hash[td->inputmode];
	if (r) {
		r->field[0]->value[0] = 0x02;
		usbhid_submit_report(hdev, r, USB_DIR_OUT);
	}
}

static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret, i;
	struct mt_device *td;
	struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */

	for (i = 0; mt_classes[i].name ; i++) {
		if (id->driver_data == mt_classes[i].name) {
			mtclass = &(mt_classes[i]);
			break;
		}
	}

	/* This allows the driver to correctly support devices
	 * that emit events over several HID messages.
	 */
	hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;

	td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
	if (!td) {
		dev_err(&hdev->dev, "cannot allocate multitouch data\n");
		return -ENOMEM;
	}
	td->mtclass = mtclass;
	td->inputmode = -1;
	hid_set_drvdata(hdev, td);

	ret = hid_parse(hdev);
	if (ret != 0)
		goto fail;

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	if (ret)
		goto fail;

	if (!td->maxcontacts)
		td->maxcontacts = MT_DEFAULT_MAXCONTACT;

	td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
				GFP_KERNEL);
	if (!td->slots) {
		dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
		hid_hw_stop(hdev);
		ret = -ENOMEM;
		goto fail;
	}

	mt_set_input_mode(hdev);

	return 0;

fail:
	kfree(td);
	return ret;
}

#ifdef CONFIG_PM
static int mt_reset_resume(struct hid_device *hdev)
{
	mt_set_input_mode(hdev);
	return 0;
}
#endif

static void mt_remove(struct hid_device *hdev)
{
	struct mt_device *td = hid_get_drvdata(hdev);
	hid_hw_stop(hdev);
	kfree(td->slots);
	kfree(td);
	hid_set_drvdata(hdev, NULL);
}

static const struct hid_device_id mt_devices[] = {

	/* Cypress panel */
	{ .driver_data = MT_CLS_CYPRESS,
		HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
			USB_DEVICE_ID_CYPRESS_TRUETOUCH) },

	/* GeneralTouch panel */
	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
		HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
			USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },

	/* IRTOUCH panels */
	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
		HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
			USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },

	/* PixCir-based panels */
	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
		HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
			USB_DEVICE_ID_HANVON_MULTITOUCH) },
	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
		HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
			USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },

	/* Resistive eGalax devices */
	{  .driver_data = MT_CLS_EGALAX,
		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH) },
	{  .driver_data = MT_CLS_EGALAX,
		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH3) },

	/* Capacitive eGalax devices */
	{  .driver_data = MT_CLS_EGALAX,
		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH1) },
	{  .driver_data = MT_CLS_EGALAX,
		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH2) },
	{  .driver_data = MT_CLS_EGALAX,
		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH4) },

	/* Stantum panels */
	{ .driver_data = MT_CLS_STANTUM,
		HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
			USB_DEVICE_ID_MTP)},
	{ .driver_data = MT_CLS_STANTUM,
		HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
			USB_DEVICE_ID_MTP_STM)},
	{ .driver_data = MT_CLS_STANTUM,
		HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
			USB_DEVICE_ID_MTP_SITRONIX)},

	{ }
};
MODULE_DEVICE_TABLE(hid, mt_devices);

static const struct hid_usage_id mt_grabbed_usages[] = {
	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
};

static struct hid_driver mt_driver = {
	.name = "hid-multitouch",
	.id_table = mt_devices,
	.probe = mt_probe,
	.remove = mt_remove,
	.input_mapping = mt_input_mapping,
	.input_mapped = mt_input_mapped,
	.feature_mapping = mt_feature_mapping,
	.usage_table = mt_grabbed_usages,
	.event = mt_event,
#ifdef CONFIG_PM
	.reset_resume = mt_reset_resume,
#endif
};

static int __init mt_init(void)
{
	return hid_register_driver(&mt_driver);
}

static void __exit mt_exit(void)
{
	hid_unregister_driver(&mt_driver);
}

module_init(mt_init);
module_exit(mt_exit);
Commit	Line	Data
5519cab4 BT	1	/*
	2	* HID driver for multitouch panels
	3	*
	4	* Copyright (c) 2010-2011 Stephane Chatty <chatty@enac.fr>
	5	* Copyright (c) 2010-2011 Benjamin Tissoires <benjamin.tissoires@gmail.com>
	6	* Copyright (c) 2010-2011 Ecole Nationale de l'Aviation Civile, France
	7	*
4875ac11 RN	8	* This code is partly based on hid-egalax.c:
	9	*
	10	* Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
	11	* Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
	12	* Copyright (c) 2010 Canonical, Ltd.
	13	*
5519cab4 BT	14	*/
	15
	16	/*
	17	* This program is free software; you can redistribute it and/or modify it
	18	* under the terms of the GNU General Public License as published by the Free
	19	* Software Foundation; either version 2 of the License, or (at your option)
	20	* any later version.
	21	*/
	22
	23	#include <linux/device.h>
	24	#include <linux/hid.h>
	25	#include <linux/module.h>
	26	#include <linux/slab.h>
	27	#include <linux/usb.h>
	28	#include <linux/input/mt.h>
	29	#include "usbhid/usbhid.h"
	30
	31
	32	MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
ef2fafb3	33	MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
5519cab4 BT	34	MODULE_DESCRIPTION("HID multitouch panels");
	35	MODULE_LICENSE("GPL");
	36
	37	#include "hid-ids.h"
	38
	39	/* quirks to control the device */
	40	#define MT_QUIRK_NOT_SEEN_MEANS_UP (1 << 0)
	41	#define MT_QUIRK_SLOT_IS_CONTACTID (1 << 1)
2d93666e	42	#define MT_QUIRK_CYPRESS (1 << 2)
5572da08	43	#define MT_QUIRK_SLOT_IS_CONTACTNUMBER (1 << 3)
2d93666e BT	44	#define MT_QUIRK_VALID_IS_INRANGE (1 << 4)
2d93666e BT	45	#define MT_QUIRK_VALID_IS_CONFIDENCE (1 << 5)
4875ac11	46	#define MT_QUIRK_EGALAX_XYZ_FIXUP (1 << 6)
5519cab4 BT	47
	48	struct mt_slot {
	49	__s32 x, y, p, w, h;
	50	__s32 contactid; /* the device ContactID assigned to this slot */
	51	bool touch_state; /* is the touch valid? */
	52	bool seen_in_this_frame;/* has this slot been updated */
	53	};
	54
	55	struct mt_device {
	56	struct mt_slot curdata; /* placeholder of incoming data */
	57	struct mt_class mtclass; / our mt device class */
	58	unsigned last_field_index; /* last field index of the report */
	59	unsigned last_slot_field; /* the last field of a slot */
	60	__s8 inputmode; /* InputMode HID feature, -1 if non-existent */
	61	__u8 num_received; /* how many contacts we received */
	62	__u8 num_expected; /* expected last contact index */
9498f954	63	__u8 maxcontacts;
5519cab4	64	bool curvalid; /* is the current contact valid? */
9498f954	65	struct mt_slot *slots;
5519cab4 BT	66	};
	67
	68	struct mt_class {
2d93666e	69	__s32 name; /* MT_CLS */
5519cab4 BT	70	__s32 quirks;
	71	__s32 sn_move; /* Signal/noise ratio for move events */
	72	__s32 sn_pressure; /* Signal/noise ratio for pressure events */
	73	__u8 maxcontacts;
	74	};
	75
	76	/* classes of device behavior */
1e9cf35b BT	77	#define MT_CLS_DEFAULT 1
	78	#define MT_CLS_DUAL_INRANGE_CONTACTID 2
	79	#define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 3
	80	#define MT_CLS_CYPRESS 4
4875ac11	81	#define MT_CLS_EGALAX 5
043b403a	82	#define MT_CLS_STANTUM 6
5519cab4	83
9498f954 BT	84	#define MT_DEFAULT_MAXCONTACT 10
9498f954 BT	85
5519cab4 BT	86	/*
	87	* these device-dependent functions determine what slot corresponds
	88	* to a valid contact that was just read.
	89	*/
	90
a3b5e577 BT	91	static int cypress_compute_slot(struct mt_device *td)
	92	{
	93	if (td->curdata.contactid != 0 \|\| td->num_received == 0)
	94	return td->curdata.contactid;
	95	else
	96	return -1;
	97	}
	98
5519cab4 BT	99	static int find_slot_from_contactid(struct mt_device *td)
	100	{
	101	int i;
9498f954	102	for (i = 0; i < td->maxcontacts; ++i) {
5519cab4 BT	103	if (td->slots[i].contactid == td->curdata.contactid &&
	104	td->slots[i].touch_state)
	105	return i;
	106	}
9498f954	107	for (i = 0; i < td->maxcontacts; ++i) {
5519cab4 BT	108	if (!td->slots[i].seen_in_this_frame &&
	109	!td->slots[i].touch_state)
	110	return i;
	111	}
5519cab4 BT	112	/* should not occurs. If this happens that means
	113	* that the device sent more touches that it says
	114	* in the report descriptor. It is ignored then. */
2d93666e	115	return -1;
5519cab4 BT	116	}
	117
	118	struct mt_class mt_classes[] = {
2d93666e	119	{ .name = MT_CLS_DEFAULT,
9498f954	120	.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
1e9cf35b	121	{ .name = MT_CLS_DUAL_INRANGE_CONTACTID,
2d93666e BT	122	.quirks = MT_QUIRK_VALID_IS_INRANGE \|
	123	MT_QUIRK_SLOT_IS_CONTACTID,
	124	.maxcontacts = 2 },
1e9cf35b	125	{ .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
2d93666e BT	126	.quirks = MT_QUIRK_VALID_IS_INRANGE \|
	127	MT_QUIRK_SLOT_IS_CONTACTNUMBER,
	128	.maxcontacts = 2 },
	129	{ .name = MT_CLS_CYPRESS,
	130	.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP \|
	131	MT_QUIRK_CYPRESS,
	132	.maxcontacts = 10 },
	133
4875ac11 RN	134	{ .name = MT_CLS_EGALAX,
	135	.quirks = MT_QUIRK_SLOT_IS_CONTACTID \|
	136	MT_QUIRK_VALID_IS_INRANGE \|
	137	MT_QUIRK_EGALAX_XYZ_FIXUP,
	138	.maxcontacts = 2,
	139	.sn_move = 4096,
	140	.sn_pressure = 32,
	141	},
043b403a BT	142	{ .name = MT_CLS_STANTUM,
	143	.quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
	144
2d93666e	145	{ }
5519cab4 BT	146	};
5519cab4 BT	147
f635bd11	148	static void mt_feature_mapping(struct hid_device *hdev,
5519cab4 BT	149	struct hid_field field, struct hid_usage usage)
5519cab4 BT	150	{
9498f954 BT	151	struct mt_device *td = hid_get_drvdata(hdev);
	152
	153	switch (usage->hid) {
	154	case HID_DG_INPUTMODE:
5519cab4	155	td->inputmode = field->report->id;
9498f954 BT	156	break;
	157	case HID_DG_CONTACTMAX:
	158	td->maxcontacts = field->value[0];
	159	if (td->mtclass->maxcontacts)
	160	/* check if the maxcontacts is given by the class */
	161	td->maxcontacts = td->mtclass->maxcontacts;
	162
	163	break;
5519cab4 BT	164	}
	165	}
	166
	167	static void set_abs(struct input_dev *input, unsigned int code,
	168	struct hid_field *field, int snratio)
	169	{
	170	int fmin = field->logical_minimum;
	171	int fmax = field->logical_maximum;
	172	int fuzz = snratio ? (fmax - fmin) / snratio : 0;
	173	input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
	174	}
	175
	176	static int mt_input_mapping(struct hid_device hdev, struct hid_input hi,
	177	struct hid_field field, struct hid_usage usage,
	178	unsigned long *bit, int max)
	179	{
	180	struct mt_device *td = hid_get_drvdata(hdev);
	181	struct mt_class *cls = td->mtclass;
4875ac11 RN	182	__s32 quirks = cls->quirks;
4875ac11 RN	183
5519cab4 BT	184	switch (usage->hid & HID_USAGE_PAGE) {
	185
	186	case HID_UP_GENDESK:
	187	switch (usage->hid) {
	188	case HID_GD_X:
4875ac11 RN	189	if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
4875ac11 RN	190	field->logical_maximum = 32760;
5519cab4 BT	191	hid_map_usage(hi, usage, bit, max,
	192	EV_ABS, ABS_MT_POSITION_X);
	193	set_abs(hi->input, ABS_MT_POSITION_X, field,
	194	cls->sn_move);
	195	/* touchscreen emulation */
	196	set_abs(hi->input, ABS_X, field, cls->sn_move);
	197	td->last_slot_field = usage->hid;
	198	return 1;
	199	case HID_GD_Y:
4875ac11 RN	200	if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
4875ac11 RN	201	field->logical_maximum = 32760;
5519cab4 BT	202	hid_map_usage(hi, usage, bit, max,
	203	EV_ABS, ABS_MT_POSITION_Y);
	204	set_abs(hi->input, ABS_MT_POSITION_Y, field,
	205	cls->sn_move);
	206	/* touchscreen emulation */
	207	set_abs(hi->input, ABS_Y, field, cls->sn_move);
	208	td->last_slot_field = usage->hid;
	209	return 1;
	210	}
	211	return 0;
	212
	213	case HID_UP_DIGITIZER:
	214	switch (usage->hid) {
	215	case HID_DG_INRANGE:
	216	td->last_slot_field = usage->hid;
	217	return 1;
	218	case HID_DG_CONFIDENCE:
	219	td->last_slot_field = usage->hid;
	220	return 1;
	221	case HID_DG_TIPSWITCH:
	222	hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
	223	input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
	224	td->last_slot_field = usage->hid;
	225	return 1;
	226	case HID_DG_CONTACTID:
9498f954	227	input_mt_init_slots(hi->input, td->maxcontacts);
5519cab4 BT	228	td->last_slot_field = usage->hid;
	229	return 1;
	230	case HID_DG_WIDTH:
	231	hid_map_usage(hi, usage, bit, max,
	232	EV_ABS, ABS_MT_TOUCH_MAJOR);
	233	td->last_slot_field = usage->hid;
	234	return 1;
	235	case HID_DG_HEIGHT:
	236	hid_map_usage(hi, usage, bit, max,
	237	EV_ABS, ABS_MT_TOUCH_MINOR);
	238	field->logical_maximum = 1;
2d93666e	239	field->logical_minimum = 0;
5519cab4 BT	240	set_abs(hi->input, ABS_MT_ORIENTATION, field, 0);
	241	td->last_slot_field = usage->hid;
	242	return 1;
	243	case HID_DG_TIPPRESSURE:
4875ac11 RN	244	if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
4875ac11 RN	245	field->logical_minimum = 0;
5519cab4 BT	246	hid_map_usage(hi, usage, bit, max,
	247	EV_ABS, ABS_MT_PRESSURE);
	248	set_abs(hi->input, ABS_MT_PRESSURE, field,
	249	cls->sn_pressure);
	250	/* touchscreen emulation */
	251	set_abs(hi->input, ABS_PRESSURE, field,
	252	cls->sn_pressure);
	253	td->last_slot_field = usage->hid;
	254	return 1;
	255	case HID_DG_CONTACTCOUNT:
	256	td->last_field_index = field->report->maxfield - 1;
	257	return 1;
	258	case HID_DG_CONTACTMAX:
	259	/* we don't set td->last_slot_field as contactcount and
	260	* contact max are global to the report */
	261	return -1;
	262	}
	263	/* let hid-input decide for the others */
	264	return 0;
	265
	266	case 0xff000000:
	267	/* we do not want to map these: no input-oriented meaning */
	268	return -1;
	269	}
	270
	271	return 0;
	272	}
	273
	274	static int mt_input_mapped(struct hid_device hdev, struct hid_input hi,
	275	struct hid_field field, struct hid_usage usage,
	276	unsigned long *bit, int max)
	277	{
	278	if (usage->type == EV_KEY \|\| usage->type == EV_ABS)
	279	set_bit(usage->type, hi->input->evbit);
	280
	281	return -1;
	282	}
	283
	284	static int mt_compute_slot(struct mt_device *td)
	285	{
2d93666e	286	__s32 quirks = td->mtclass->quirks;
5519cab4	287
2d93666e BT	288	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
2d93666e BT	289	return td->curdata.contactid;
5519cab4	290
2d93666e	291	if (quirks & MT_QUIRK_CYPRESS)
a3b5e577 BT	292	return cypress_compute_slot(td);
a3b5e577 BT	293
2d93666e BT	294	if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
2d93666e BT	295	return td->num_received;
5572da08	296
5519cab4 BT	297	return find_slot_from_contactid(td);
	298	}
	299
	300	/*
	301	* this function is called when a whole contact has been processed,
	302	* so that it can assign it to a slot and store the data there
	303	*/
	304	static void mt_complete_slot(struct mt_device *td)
	305	{
2d93666e	306	td->curdata.seen_in_this_frame = true;
5519cab4	307	if (td->curvalid) {
5519cab4 BT	308	int slotnum = mt_compute_slot(td);
5519cab4 BT	309
9498f954	310	if (slotnum >= 0 && slotnum < td->maxcontacts)
2d93666e	311	td->slots[slotnum] = td->curdata;
5519cab4 BT	312	}
	313	td->num_received++;
	314	}
	315
	316
	317	/*
	318	* this function is called when a whole packet has been received and processed,
	319	* so that it can decide what to send to the input layer.
	320	*/
	321	static void mt_emit_event(struct mt_device td, struct input_dev input)
	322	{
	323	int i;
	324
9498f954	325	for (i = 0; i < td->maxcontacts; ++i) {
5519cab4 BT	326	struct mt_slot *s = &(td->slots[i]);
	327	if ((td->mtclass->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
	328	!s->seen_in_this_frame) {
5519cab4 BT	329	s->touch_state = false;
	330	}
	331
	332	input_mt_slot(input, i);
	333	input_mt_report_slot_state(input, MT_TOOL_FINGER,
	334	s->touch_state);
2d93666e BT	335	if (s->touch_state) {
	336	input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
	337	input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
	338	input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
	339	input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, s->w);
	340	input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, s->h);
	341	}
5519cab4 BT	342	s->seen_in_this_frame = false;
	343
	344	}
	345
	346	input_mt_report_pointer_emulation(input, true);
	347	input_sync(input);
	348	td->num_received = 0;
	349	}
	350
	351
	352
	353	static int mt_event(struct hid_device hid, struct hid_field field,
	354	struct hid_usage *usage, __s32 value)
	355	{
	356	struct mt_device *td = hid_get_drvdata(hid);
2d93666e	357	__s32 quirks = td->mtclass->quirks;
5519cab4	358
9498f954	359	if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
5519cab4 BT	360	switch (usage->hid) {
5519cab4 BT	361	case HID_DG_INRANGE:
2d93666e BT	362	if (quirks & MT_QUIRK_VALID_IS_INRANGE)
2d93666e BT	363	td->curvalid = value;
5519cab4 BT	364	break;
5519cab4 BT	365	case HID_DG_TIPSWITCH:
2d93666e BT	366	if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
2d93666e BT	367	td->curvalid = value;
5519cab4 BT	368	td->curdata.touch_state = value;
	369	break;
	370	case HID_DG_CONFIDENCE:
2d93666e BT	371	if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
2d93666e BT	372	td->curvalid = value;
5519cab4 BT	373	break;
	374	case HID_DG_CONTACTID:
	375	td->curdata.contactid = value;
	376	break;
	377	case HID_DG_TIPPRESSURE:
	378	td->curdata.p = value;
	379	break;
	380	case HID_GD_X:
	381	td->curdata.x = value;
	382	break;
	383	case HID_GD_Y:
	384	td->curdata.y = value;
	385	break;
	386	case HID_DG_WIDTH:
	387	td->curdata.w = value;
	388	break;
	389	case HID_DG_HEIGHT:
	390	td->curdata.h = value;
	391	break;
	392	case HID_DG_CONTACTCOUNT:
	393	/*
2d93666e BT	394	* Includes multi-packet support where subsequent
2d93666e BT	395	* packets are sent with zero contactcount.
5519cab4 BT	396	*/
5519cab4 BT	397	if (value)
2d93666e	398	td->num_expected = value;
5519cab4 BT	399	break;
	400
	401	default:
	402	/* fallback to the generic hidinput handling */
	403	return 0;
	404	}
5519cab4	405
f153fc39	406	if (usage->hid == td->last_slot_field) {
2d93666e	407	mt_complete_slot(td);
f153fc39 HR	408	if (!td->last_field_index)
	409	mt_emit_event(td, field->hidinput->input);
	410	}
2d93666e BT	411
	412	if (field->index == td->last_field_index
	413	&& td->num_received >= td->num_expected)
	414	mt_emit_event(td, field->hidinput->input);
5519cab4	415
2d93666e	416	}
5519cab4 BT	417
	418	/* we have handled the hidinput part, now remains hiddev */
	419	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
	420	hid->hiddev_hid_event(hid, field, usage, value);
	421
	422	return 1;
	423	}
	424
	425	static void mt_set_input_mode(struct hid_device *hdev)
	426	{
	427	struct mt_device *td = hid_get_drvdata(hdev);
	428	struct hid_report *r;
	429	struct hid_report_enum *re;
	430
	431	if (td->inputmode < 0)
	432	return;
	433
	434	re = &(hdev->report_enum[HID_FEATURE_REPORT]);
	435	r = re->report_id_hash[td->inputmode];
	436	if (r) {
	437	r->field[0]->value[0] = 0x02;
	438	usbhid_submit_report(hdev, r, USB_DIR_OUT);
	439	}
	440	}
	441
	442	static int mt_probe(struct hid_device hdev, const struct hid_device_id id)
	443	{
2d93666e	444	int ret, i;
5519cab4	445	struct mt_device *td;
2d93666e BT	446	struct mt_class mtclass = mt_classes; / MT_CLS_DEFAULT */
	447
	448	for (i = 0; mt_classes[i].name ; i++) {
	449	if (id->driver_data == mt_classes[i].name) {
	450	mtclass = &(mt_classes[i]);
	451	break;
	452	}
	453	}
5519cab4 BT	454
	455	/* This allows the driver to correctly support devices
	456	* that emit events over several HID messages.
	457	*/
	458	hdev->quirks \|= HID_QUIRK_NO_INPUT_SYNC;
	459
9498f954	460	td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
5519cab4 BT	461	if (!td) {
	462	dev_err(&hdev->dev, "cannot allocate multitouch data\n");
	463	return -ENOMEM;
	464	}
	465	td->mtclass = mtclass;
	466	td->inputmode = -1;
	467	hid_set_drvdata(hdev, td);
	468
	469	ret = hid_parse(hdev);
	470	if (ret != 0)
	471	goto fail;
	472
	473	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
2d93666e	474	if (ret)
5519cab4 BT	475	goto fail;
5519cab4 BT	476
9498f954 BT	477	if (!td->maxcontacts)
	478	td->maxcontacts = MT_DEFAULT_MAXCONTACT;
	479
	480	td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
	481	GFP_KERNEL);
	482	if (!td->slots) {
	483	dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
	484	hid_hw_stop(hdev);
	485	ret = -ENOMEM;
	486	goto fail;
	487	}
	488
5519cab4 BT	489	mt_set_input_mode(hdev);
	490
	491	return 0;
	492
	493	fail:
	494	kfree(td);
	495	return ret;
	496	}
	497
	498	#ifdef CONFIG_PM
	499	static int mt_reset_resume(struct hid_device *hdev)
	500	{
	501	mt_set_input_mode(hdev);
	502	return 0;
	503	}
	504	#endif
	505
	506	static void mt_remove(struct hid_device *hdev)
	507	{
	508	struct mt_device *td = hid_get_drvdata(hdev);
	509	hid_hw_stop(hdev);
9498f954	510	kfree(td->slots);
5519cab4 BT	511	kfree(td);
	512	hid_set_drvdata(hdev, NULL);
	513	}
	514
	515	static const struct hid_device_id mt_devices[] = {
	516
a3b5e577 BT	517	/* Cypress panel */
	518	{ .driver_data = MT_CLS_CYPRESS,
	519	HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
	520	USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
	521
5572da08	522	/* GeneralTouch panel */
1e9cf35b	523	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
5572da08 BT	524	HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
	525	USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
	526
4dfcced8 BT	527	/* IRTOUCH panels */
	528	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
	529	HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
	530	USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
	531
5519cab4	532	/* PixCir-based panels */
1e9cf35b	533	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
5519cab4 BT	534	HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
5519cab4 BT	535	USB_DEVICE_ID_HANVON_MULTITOUCH) },
1e9cf35b	536	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
5519cab4 BT	537	HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
	538	USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
	539
4875ac11 RN	540	/* Resistive eGalax devices */
	541	{ .driver_data = MT_CLS_EGALAX,
	542	HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
	543	USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH) },
	544	{ .driver_data = MT_CLS_EGALAX,
	545	HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
	546	USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH3) },
	547
	548	/* Capacitive eGalax devices */
	549	{ .driver_data = MT_CLS_EGALAX,
	550	HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
	551	USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH1) },
	552	{ .driver_data = MT_CLS_EGALAX,
	553	HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
	554	USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH2) },
	555	{ .driver_data = MT_CLS_EGALAX,
	556	HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
	557	USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH4) },
	558
043b403a BT	559	/* Stantum panels */
	560	{ .driver_data = MT_CLS_STANTUM,
	561	HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
	562	USB_DEVICE_ID_MTP)},
	563	{ .driver_data = MT_CLS_STANTUM,
	564	HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
	565	USB_DEVICE_ID_MTP_STM)},
	566	{ .driver_data = MT_CLS_STANTUM,
	567	HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
	568	USB_DEVICE_ID_MTP_SITRONIX)},
	569
5519cab4 BT	570	{ }
	571	};
	572	MODULE_DEVICE_TABLE(hid, mt_devices);
	573
	574	static const struct hid_usage_id mt_grabbed_usages[] = {
	575	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
	576	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
	577	};
	578
	579	static struct hid_driver mt_driver = {
	580	.name = "hid-multitouch",
	581	.id_table = mt_devices,
	582	.probe = mt_probe,
	583	.remove = mt_remove,
	584	.input_mapping = mt_input_mapping,
	585	.input_mapped = mt_input_mapped,
	586	.feature_mapping = mt_feature_mapping,
	587	.usage_table = mt_grabbed_usages,
	588	.event = mt_event,
	589	#ifdef CONFIG_PM
	590	.reset_resume = mt_reset_resume,
	591	#endif
	592	};
	593
	594	static int __init mt_init(void)
	595	{
	596	return hid_register_driver(&mt_driver);
	597	}
	598
	599	static void __exit mt_exit(void)
	600	{
	601	hid_unregister_driver(&mt_driver);
	602	}
	603
	604	module_init(mt_init);
	605	module_exit(mt_exit);