[deliverable/linux.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_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,
	},
	{ }
};

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

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