[deliverable/linux.git] / drivers / hid / hid-ntrig.c

/*
 *  HID driver for N-Trig touchscreens
 *
 *  Copyright (c) 2008 Rafi Rubin
 *  Copyright (c) 2009 Stephane Chatty
 *
 */

/*
 * 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 "hid-ids.h"

#define NTRIG_DUPLICATE_USAGES	0x001

#define nt_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, max, \
					EV_KEY, (c))

struct ntrig_data {
	__s32 x, y, id, w, h;
	bool reading_a_point, found_contact_id;
};

/*
 * this driver is aimed at two firmware versions in circulation:
 *  - dual pen/finger single touch
 *  - finger multitouch, pen not working
 */

static int ntrig_input_mapping(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	/* No special mappings needed for the pen */
	if (field->application == HID_DG_PEN)
		return 0;

	switch (usage->hid & HID_USAGE_PAGE) {
	case HID_UP_GENDESK:
		switch (usage->hid) {
		case HID_GD_X:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_POSITION_X);
			input_set_abs_params(hi->input, ABS_X,
					field->logical_minimum,
					field->logical_maximum, 0, 0);
			return 1;
		case HID_GD_Y:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_POSITION_Y);
			input_set_abs_params(hi->input, ABS_Y,
					field->logical_minimum,
					field->logical_maximum, 0, 0);
			return 1;
		}
		return 0;

	case HID_UP_DIGITIZER:
		switch (usage->hid) {
		/* we do not want to map these for now */
		case HID_DG_CONTACTID: /* value is useless */
		case HID_DG_INPUTMODE:
		case HID_DG_DEVICEINDEX:
		case HID_DG_CONTACTCOUNT:
		case HID_DG_CONTACTMAX:
			return -1;

		/* original mapping by Rafi Rubin */
		case HID_DG_CONFIDENCE:
			nt_map_key_clear(BTN_TOOL_DOUBLETAP);
			return 1;

		/* width/height mapped on TouchMajor/TouchMinor/Orientation */
		case HID_DG_WIDTH:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_TOUCH_MAJOR);
			return 1;
		case HID_DG_HEIGHT:
			hid_map_usage(hi, usage, bit, max,
					EV_ABS, ABS_MT_TOUCH_MINOR);
			input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
					0, 1, 0, 0);
			return 1;
		}
		return 0;

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

	return 0;
}

static int ntrig_input_mapped(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	/* No special mappings needed for the pen */
	if (field->application == HID_DG_PEN)
		return 0;

	if (usage->type == EV_KEY || usage->type == EV_REL
			|| usage->type == EV_ABS)
		clear_bit(usage->code, *bit);

	return 0;
}

/*
 * this function is called upon all reports
 * so that we can filter contact point information,
 * decide whether we are in multi or single touch mode
 * and call input_mt_sync after each point if necessary
 */
static int ntrig_event (struct hid_device *hid, struct hid_field *field,
		                        struct hid_usage *usage, __s32 value)
{
	struct input_dev *input = field->hidinput->input;
	struct ntrig_data *nd = hid_get_drvdata(hid);

	/* No special handling needed for the pen */
	if (field->application == HID_DG_PEN)
		return 0;

        if (hid->claimed & HID_CLAIMED_INPUT) {
		switch (usage->hid) {
		case HID_GD_X:
			nd->x = value;
			nd->reading_a_point = 1;
			break;
		case HID_GD_Y:
			nd->y = value;
			break;
		case HID_DG_CONTACTID:
			nd->id = value;
			/* we receive this only when in multitouch mode */
			nd->found_contact_id = 1;
			break;
		case HID_DG_WIDTH:
			nd->w = value;
			break;
		case HID_DG_HEIGHT:
			nd->h = value;
			/*
			 * when in single touch mode, this is the last
			 * report received in a finger event. We want
			 * to emit a normal (X, Y) position
			 */
			if (!nd->found_contact_id) {
				input_event(input, EV_ABS, ABS_X, nd->x);
				input_event(input, EV_ABS, ABS_Y, nd->y);
			}
			break;
		case 0xff000002:
			/*
			 * we receive this when the device is in multitouch
			 * mode. The first of the three values tagged with
			 * this usage tells if the contact point is real
			 * or a placeholder
			 */
			if (!nd->reading_a_point || value != 1)
				break;
			/* emit a normal (X, Y) for the first point only */
			if (nd->id == 0) {
				input_event(input, EV_ABS, ABS_X, nd->x);
				input_event(input, EV_ABS, ABS_Y, nd->y);
			}
			input_event(input, EV_ABS, ABS_MT_POSITION_X, nd->x);
			input_event(input, EV_ABS, ABS_MT_POSITION_Y, nd->y);
			if (nd->w > nd->h) {
				input_event(input, EV_ABS,
						ABS_MT_ORIENTATION, 1);
				input_event(input, EV_ABS,
						ABS_MT_TOUCH_MAJOR, nd->w);
				input_event(input, EV_ABS,
						ABS_MT_TOUCH_MINOR, nd->h);
			} else {
				input_event(input, EV_ABS,
						ABS_MT_ORIENTATION, 0);
				input_event(input, EV_ABS,
						ABS_MT_TOUCH_MAJOR, nd->h);
				input_event(input, EV_ABS,
						ABS_MT_TOUCH_MINOR, nd->w);
			}
			input_mt_sync(field->hidinput->input);
			nd->reading_a_point = 0;
			nd->found_contact_id = 0;
			break;

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

	/* 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 int ntrig_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret;
	struct ntrig_data *nd;
	struct hid_input *hidinput;
	struct input_dev *input;

	if (id->driver_data)
		hdev->quirks |= HID_QUIRK_MULTI_INPUT;

	nd = kmalloc(sizeof(struct ntrig_data), GFP_KERNEL);
	if (!nd) {
		dev_err(&hdev->dev, "cannot allocate N-Trig data\n");
		return -ENOMEM;
	}
	nd->reading_a_point = 0;
	nd->found_contact_id = 0;
	hid_set_drvdata(hdev, nd);

	ret = hid_parse(hdev);
	if (ret) {
		dev_err(&hdev->dev, "parse failed\n");
		goto err_free;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	if (ret) {
		dev_err(&hdev->dev, "hw start failed\n");
		goto err_free;
	}


	list_for_each_entry(hidinput, &hdev->inputs, list) {
		input = hidinput->input;
		switch (hidinput->report->field[0]->application) {
		case HID_DG_PEN:
			input->name = "N-Trig Pen";
			break;
		case HID_DG_TOUCHSCREEN:
			/*
			 * The physical touchscreen (single touch)
			 * input has a value for physical, whereas
			 * the multitouch only has logical input
			 * fields.
			 */
			input->name =
				(hidinput->report->field[0]
				 ->physical) ?
				"N-Trig Touchscreen" :
				"N-Trig MultiTouch";
			break;
		}
	}

	return 0;
err_free:
	kfree(nd);
	return ret;
}

static void ntrig_remove(struct hid_device *hdev)
{
	hid_hw_stop(hdev);
	kfree(hid_get_drvdata(hdev));
}

static const struct hid_device_id ntrig_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN),
		.driver_data = NTRIG_DUPLICATE_USAGES },
	{ }
};
MODULE_DEVICE_TABLE(hid, ntrig_devices);

static const struct hid_usage_id ntrig_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 ntrig_driver = {
	.name = "ntrig",
	.id_table = ntrig_devices,
	.probe = ntrig_probe,
	.remove = ntrig_remove,
	.input_mapping = ntrig_input_mapping,
	.input_mapped = ntrig_input_mapped,
	.usage_table = ntrig_grabbed_usages,
	.event = ntrig_event,
};

static int __init ntrig_init(void)
{
	return hid_register_driver(&ntrig_driver);
}

static void __exit ntrig_exit(void)
{
	hid_unregister_driver(&ntrig_driver);
}

module_init(ntrig_init);
module_exit(ntrig_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
94011f93	1	/*
57fd637a	2	* HID driver for N-Trig touchscreens
94011f93	3	*
94011f93	4	* Copyright (c) 2008 Rafi Rubin
57fd637a	5	* Copyright (c) 2009 Stephane Chatty
94011f93 RR	6	*
	7	*/
	8
	9	/*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the Free
	12	* Software Foundation; either version 2 of the License, or (at your option)
	13	* any later version.
	14	*/
	15
	16	#include <linux/device.h>
	17	#include <linux/hid.h>
	18	#include <linux/module.h>
	19
	20	#include "hid-ids.h"
	21
	22	#define NTRIG_DUPLICATE_USAGES 0x001
	23
	24	#define nt_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \
	25	EV_KEY, (c))
	26
57fd637a SC	27	struct ntrig_data {
57fd637a SC	28	__s32 x, y, id, w, h;
943ed464	29	bool reading_a_point, found_contact_id;
57fd637a SC	30	};
	31
	32	/*
	33	* this driver is aimed at two firmware versions in circulation:
	34	* - dual pen/finger single touch
	35	* - finger multitouch, pen not working
	36	*/
	37
94011f93 RR	38	static int ntrig_input_mapping(struct hid_device hdev, struct hid_input hi,
	39	struct hid_field field, struct hid_usage usage,
	40	unsigned long *bit, int max)
	41	{
943ed464 RR	42	/* No special mappings needed for the pen */
	43	if (field->application == HID_DG_PEN)
	44	return 0;
	45
57fd637a	46	switch (usage->hid & HID_USAGE_PAGE) {
57fd637a SC	47	case HID_UP_GENDESK:
	48	switch (usage->hid) {
	49	case HID_GD_X:
	50	hid_map_usage(hi, usage, bit, max,
	51	EV_ABS, ABS_MT_POSITION_X);
	52	input_set_abs_params(hi->input, ABS_X,
	53	field->logical_minimum,
	54	field->logical_maximum, 0, 0);
	55	return 1;
	56	case HID_GD_Y:
	57	hid_map_usage(hi, usage, bit, max,
	58	EV_ABS, ABS_MT_POSITION_Y);
	59	input_set_abs_params(hi->input, ABS_Y,
	60	field->logical_minimum,
	61	field->logical_maximum, 0, 0);
	62	return 1;
	63	}
	64	return 0;
	65
	66	case HID_UP_DIGITIZER:
	67	switch (usage->hid) {
	68	/* we do not want to map these for now */
57fd637a	69	case HID_DG_CONTACTID: /* value is useless */
57fd637a SC	70	case HID_DG_INPUTMODE:
	71	case HID_DG_DEVICEINDEX:
	72	case HID_DG_CONTACTCOUNT:
	73	case HID_DG_CONTACTMAX:
	74	return -1;
	75
	76	/* original mapping by Rafi Rubin */
	77	case HID_DG_CONFIDENCE:
	78	nt_map_key_clear(BTN_TOOL_DOUBLETAP);
	79	return 1;
	80
	81	/* width/height mapped on TouchMajor/TouchMinor/Orientation */
	82	case HID_DG_WIDTH:
	83	hid_map_usage(hi, usage, bit, max,
	84	EV_ABS, ABS_MT_TOUCH_MAJOR);
	85	return 1;
	86	case HID_DG_HEIGHT:
	87	hid_map_usage(hi, usage, bit, max,
	88	EV_ABS, ABS_MT_TOUCH_MINOR);
	89	input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
	90	0, 1, 0, 0);
	91	return 1;
	92	}
	93	return 0;
	94
	95	case 0xff000000:
	96	/* we do not want to map these: no input-oriented meaning */
	97	return -1;
94011f93	98	}
57fd637a	99
94011f93 RR	100	return 0;
	101	}
	102
	103	static int ntrig_input_mapped(struct hid_device hdev, struct hid_input hi,
	104	struct hid_field field, struct hid_usage usage,
	105	unsigned long *bit, int max)
	106	{
943ed464 RR	107	/* No special mappings needed for the pen */
	108	if (field->application == HID_DG_PEN)
	109	return 0;
b0549cf1	110
94011f93 RR	111	if (usage->type == EV_KEY \|\| usage->type == EV_REL
	112	\|\| usage->type == EV_ABS)
	113	clear_bit(usage->code, *bit);
	114
	115	return 0;
	116	}
57fd637a SC	117
	118	/*
	119	* this function is called upon all reports
	120	* so that we can filter contact point information,
	121	* decide whether we are in multi or single touch mode
	122	* and call input_mt_sync after each point if necessary
	123	*/
	124	static int ntrig_event (struct hid_device hid, struct hid_field field,
	125	struct hid_usage *usage, __s32 value)
	126	{
	127	struct input_dev *input = field->hidinput->input;
	128	struct ntrig_data *nd = hid_get_drvdata(hid);
	129
943ed464 RR	130	/* No special handling needed for the pen */
	131	if (field->application == HID_DG_PEN)
	132	return 0;
	133
57fd637a SC	134	if (hid->claimed & HID_CLAIMED_INPUT) {
	135	switch (usage->hid) {
	136	case HID_GD_X:
	137	nd->x = value;
	138	nd->reading_a_point = 1;
	139	break;
	140	case HID_GD_Y:
	141	nd->y = value;
	142	break;
	143	case HID_DG_CONTACTID:
	144	nd->id = value;
	145	/* we receive this only when in multitouch mode */
	146	nd->found_contact_id = 1;
	147	break;
	148	case HID_DG_WIDTH:
	149	nd->w = value;
	150	break;
	151	case HID_DG_HEIGHT:
	152	nd->h = value;
	153	/*
	154	* when in single touch mode, this is the last
	155	* report received in a finger event. We want
	156	* to emit a normal (X, Y) position
	157	*/
837b4753	158	if (!nd->found_contact_id) {
57fd637a SC	159	input_event(input, EV_ABS, ABS_X, nd->x);
57fd637a SC	160	input_event(input, EV_ABS, ABS_Y, nd->y);
57fd637a SC	161	}
	162	break;
	163	case 0xff000002:
	164	/*
	165	* we receive this when the device is in multitouch
	166	* mode. The first of the three values tagged with
	167	* this usage tells if the contact point is real
	168	* or a placeholder
	169	*/
	170	if (!nd->reading_a_point \|\| value != 1)
	171	break;
	172	/* emit a normal (X, Y) for the first point only */
	173	if (nd->id == 0) {
	174	input_event(input, EV_ABS, ABS_X, nd->x);
	175	input_event(input, EV_ABS, ABS_Y, nd->y);
	176	}
	177	input_event(input, EV_ABS, ABS_MT_POSITION_X, nd->x);
	178	input_event(input, EV_ABS, ABS_MT_POSITION_Y, nd->y);
	179	if (nd->w > nd->h) {
	180	input_event(input, EV_ABS,
	181	ABS_MT_ORIENTATION, 1);
	182	input_event(input, EV_ABS,
	183	ABS_MT_TOUCH_MAJOR, nd->w);
	184	input_event(input, EV_ABS,
	185	ABS_MT_TOUCH_MINOR, nd->h);
	186	} else {
	187	input_event(input, EV_ABS,
	188	ABS_MT_ORIENTATION, 0);
	189	input_event(input, EV_ABS,
	190	ABS_MT_TOUCH_MAJOR, nd->h);
	191	input_event(input, EV_ABS,
	192	ABS_MT_TOUCH_MINOR, nd->w);
	193	}
	194	input_mt_sync(field->hidinput->input);
	195	nd->reading_a_point = 0;
	196	nd->found_contact_id = 0;
	197	break;
	198
	199	default:
	200	/* fallback to the generic hidinput handling */
	201	return 0;
	202	}
	203	}
	204
	205	/* we have handled the hidinput part, now remains hiddev */
943ed464 RR	206	if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_hid_event)
943ed464 RR	207	hid->hiddev_hid_event(hid, field, usage, value);
57fd637a SC	208
	209	return 1;
	210	}
	211
	212	static int ntrig_probe(struct hid_device hdev, const struct hid_device_id id)
	213	{
	214	int ret;
	215	struct ntrig_data *nd;
943ed464 RR	216	struct hid_input *hidinput;
	217	struct input_dev *input;
	218
	219	if (id->driver_data)
	220	hdev->quirks \|= HID_QUIRK_MULTI_INPUT;
57fd637a SC	221
	222	nd = kmalloc(sizeof(struct ntrig_data), GFP_KERNEL);
	223	if (!nd) {
	224	dev_err(&hdev->dev, "cannot allocate N-Trig data\n");
	225	return -ENOMEM;
	226	}
	227	nd->reading_a_point = 0;
	228	nd->found_contact_id = 0;
	229	hid_set_drvdata(hdev, nd);
	230
	231	ret = hid_parse(hdev);
943ed464 RR	232	if (ret) {
	233	dev_err(&hdev->dev, "parse failed\n");
	234	goto err_free;
	235	}
	236
	237	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	238	if (ret) {
	239	dev_err(&hdev->dev, "hw start failed\n");
	240	goto err_free;
	241	}
57fd637a	242
837b4753	243
943ed464 RR	244	list_for_each_entry(hidinput, &hdev->inputs, list) {
	245	input = hidinput->input;
	246	switch (hidinput->report->field[0]->application) {
	247	case HID_DG_PEN:
	248	input->name = "N-Trig Pen";
	249	break;
	250	case HID_DG_TOUCHSCREEN:
	251	/*
	252	* The physical touchscreen (single touch)
	253	* input has a value for physical, whereas
	254	* the multitouch only has logical input
	255	* fields.
	256	*/
	257	input->name =
	258	(hidinput->report->field[0]
	259	->physical) ?
	260	"N-Trig Touchscreen" :
	261	"N-Trig MultiTouch";
	262	break;
	263	}
	264	}
	265
	266	return 0;
	267	err_free:
	268	kfree(nd);
57fd637a SC	269	return ret;
	270	}
	271
	272	static void ntrig_remove(struct hid_device *hdev)
	273	{
	274	hid_hw_stop(hdev);
	275	kfree(hid_get_drvdata(hdev));
	276	}
	277
94011f93 RR	278	static const struct hid_device_id ntrig_devices[] = {
	279	{ HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN),
	280	.driver_data = NTRIG_DUPLICATE_USAGES },
	281	{ }
	282	};
	283	MODULE_DEVICE_TABLE(hid, ntrig_devices);
	284
57fd637a SC	285	static const struct hid_usage_id ntrig_grabbed_usages[] = {
57fd637a SC	286	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
943ed464	287	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1 }
57fd637a SC	288	};
57fd637a SC	289
94011f93 RR	290	static struct hid_driver ntrig_driver = {
	291	.name = "ntrig",
	292	.id_table = ntrig_devices,
57fd637a SC	293	.probe = ntrig_probe,
57fd637a SC	294	.remove = ntrig_remove,
94011f93 RR	295	.input_mapping = ntrig_input_mapping,
94011f93 RR	296	.input_mapped = ntrig_input_mapped,
57fd637a SC	297	.usage_table = ntrig_grabbed_usages,
57fd637a SC	298	.event = ntrig_event,
94011f93 RR	299	};
94011f93 RR	300
a24f423b	301	static int __init ntrig_init(void)
94011f93 RR	302	{
	303	return hid_register_driver(&ntrig_driver);
	304	}
	305
a24f423b	306	static void __exit ntrig_exit(void)
94011f93 RR	307	{
	308	hid_unregister_driver(&ntrig_driver);
	309	}
	310
	311	module_init(ntrig_init);
	312	module_exit(ntrig_exit);
	313	MODULE_LICENSE("GPL");