[linux-2.6-block.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;
	char reading_a_point, found_contact_id;
	char pen_active;
	char finger_active;
	char inverted;
};

/*
 * 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)
{
	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)
{
	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);

        if (hid->claimed & HID_CLAIMED_INPUT) {
		switch (usage->hid) {

		case HID_DG_INRANGE:
			if (field->application & 0x3)
				nd->pen_active = (value != 0);
			else
				nd->finger_active = (value != 0);
			return 0;

		case HID_DG_INVERT:
			nd->inverted = value;
			return 0;

		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) {
				if (nd->pen_active && nd->finger_active) {
					input_report_key(input, BTN_TOOL_DOUBLETAP, 0);
					input_report_key(input, BTN_TOOL_DOUBLETAP, 1);
				}
				input_event(input, EV_ABS, ABS_X, nd->x);
				input_event(input, EV_ABS, ABS_Y, nd->y);
			}
			break;
		case HID_DG_TIPPRESSURE:
			/*
			 * when in single touch mode, this is the last
			 * report received in a pen event. We want
			 * to emit a normal (X, Y) position
			 */
			if (! nd->found_contact_id) {
				if (nd->pen_active && nd->finger_active) {
					input_report_key(input,
							nd->inverted ? BTN_TOOL_RUBBER : BTN_TOOL_PEN
							, 0);
					input_report_key(input,
							nd->inverted ? BTN_TOOL_RUBBER : BTN_TOOL_PEN
							, 1);
				}
				input_event(input, EV_ABS, ABS_X, nd->x);
				input_event(input, EV_ABS, ABS_Y, nd->y);
				input_event(input, EV_ABS, ABS_PRESSURE, value);
			}
			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;

	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)
		ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);

	if (ret)
		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 {
	28	__s32 x, y, id, w, h;
	29	char reading_a_point, found_contact_id;
837b4753 RR	30	char pen_active;
	31	char finger_active;
	32	char inverted;
57fd637a SC	33	};
	34
	35	/*
	36	* this driver is aimed at two firmware versions in circulation:
	37	* - dual pen/finger single touch
	38	* - finger multitouch, pen not working
	39	*/
	40
94011f93 RR	41	static int ntrig_input_mapping(struct hid_device hdev, struct hid_input hi,
	42	struct hid_field field, struct hid_usage usage,
	43	unsigned long *bit, int max)
	44	{
57fd637a SC	45	switch (usage->hid & HID_USAGE_PAGE) {
	46
	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	{
	107	if (usage->type == EV_KEY \|\| usage->type == EV_REL
	108	\|\| usage->type == EV_ABS)
	109	clear_bit(usage->code, *bit);
	110
	111	return 0;
	112	}
57fd637a SC	113
	114	/*
	115	* this function is called upon all reports
	116	* so that we can filter contact point information,
	117	* decide whether we are in multi or single touch mode
	118	* and call input_mt_sync after each point if necessary
	119	*/
	120	static int ntrig_event (struct hid_device hid, struct hid_field field,
	121	struct hid_usage *usage, __s32 value)
	122	{
	123	struct input_dev *input = field->hidinput->input;
	124	struct ntrig_data *nd = hid_get_drvdata(hid);
	125
	126	if (hid->claimed & HID_CLAIMED_INPUT) {
	127	switch (usage->hid) {
837b4753 RR	128
	129	case HID_DG_INRANGE:
	130	if (field->application & 0x3)
	131	nd->pen_active = (value != 0);
	132	else
	133	nd->finger_active = (value != 0);
	134	return 0;
	135
	136	case HID_DG_INVERT:
	137	nd->inverted = value;
	138	return 0;
	139
57fd637a SC	140	case HID_GD_X:
	141	nd->x = value;
	142	nd->reading_a_point = 1;
	143	break;
	144	case HID_GD_Y:
	145	nd->y = value;
	146	break;
	147	case HID_DG_CONTACTID:
	148	nd->id = value;
	149	/* we receive this only when in multitouch mode */
	150	nd->found_contact_id = 1;
	151	break;
	152	case HID_DG_WIDTH:
	153	nd->w = value;
	154	break;
	155	case HID_DG_HEIGHT:
	156	nd->h = value;
	157	/*
	158	* when in single touch mode, this is the last
	159	* report received in a finger event. We want
	160	* to emit a normal (X, Y) position
	161	*/
837b4753 RR	162	if (!nd->found_contact_id) {
	163	if (nd->pen_active && nd->finger_active) {
	164	input_report_key(input, BTN_TOOL_DOUBLETAP, 0);
	165	input_report_key(input, BTN_TOOL_DOUBLETAP, 1);
	166	}
57fd637a SC	167	input_event(input, EV_ABS, ABS_X, nd->x);
	168	input_event(input, EV_ABS, ABS_Y, nd->y);
	169	}
	170	break;
	171	case HID_DG_TIPPRESSURE:
	172	/*
	173	* when in single touch mode, this is the last
	174	* report received in a pen event. We want
	175	* to emit a normal (X, Y) position
	176	*/
	177	if (! nd->found_contact_id) {
837b4753 RR	178	if (nd->pen_active && nd->finger_active) {
	179	input_report_key(input,
	180	nd->inverted ? BTN_TOOL_RUBBER : BTN_TOOL_PEN
	181	, 0);
	182	input_report_key(input,
	183	nd->inverted ? BTN_TOOL_RUBBER : BTN_TOOL_PEN
	184	, 1);
	185	}
57fd637a SC	186	input_event(input, EV_ABS, ABS_X, nd->x);
	187	input_event(input, EV_ABS, ABS_Y, nd->y);
	188	input_event(input, EV_ABS, ABS_PRESSURE, value);
	189	}
	190	break;
	191	case 0xff000002:
	192	/*
	193	* we receive this when the device is in multitouch
	194	* mode. The first of the three values tagged with
	195	* this usage tells if the contact point is real
	196	* or a placeholder
	197	*/
	198	if (!nd->reading_a_point \|\| value != 1)
	199	break;
	200	/* emit a normal (X, Y) for the first point only */
	201	if (nd->id == 0) {
	202	input_event(input, EV_ABS, ABS_X, nd->x);
	203	input_event(input, EV_ABS, ABS_Y, nd->y);
	204	}
	205	input_event(input, EV_ABS, ABS_MT_POSITION_X, nd->x);
	206	input_event(input, EV_ABS, ABS_MT_POSITION_Y, nd->y);
	207	if (nd->w > nd->h) {
	208	input_event(input, EV_ABS,
	209	ABS_MT_ORIENTATION, 1);
	210	input_event(input, EV_ABS,
	211	ABS_MT_TOUCH_MAJOR, nd->w);
	212	input_event(input, EV_ABS,
	213	ABS_MT_TOUCH_MINOR, nd->h);
	214	} else {
	215	input_event(input, EV_ABS,
	216	ABS_MT_ORIENTATION, 0);
	217	input_event(input, EV_ABS,
	218	ABS_MT_TOUCH_MAJOR, nd->h);
	219	input_event(input, EV_ABS,
	220	ABS_MT_TOUCH_MINOR, nd->w);
	221	}
	222	input_mt_sync(field->hidinput->input);
	223	nd->reading_a_point = 0;
	224	nd->found_contact_id = 0;
	225	break;
	226
	227	default:
	228	/* fallback to the generic hidinput handling */
	229	return 0;
	230	}
	231	}
	232
	233	/* we have handled the hidinput part, now remains hiddev */
	234	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
	235	hid->hiddev_hid_event(hid, field, usage, value);
	236
	237	return 1;
	238	}
	239
	240	static int ntrig_probe(struct hid_device hdev, const struct hid_device_id id)
	241	{
	242	int ret;
	243	struct ntrig_data *nd;
	244
	245	nd = kmalloc(sizeof(struct ntrig_data), GFP_KERNEL);
	246	if (!nd) {
	247	dev_err(&hdev->dev, "cannot allocate N-Trig data\n");
	248	return -ENOMEM;
	249	}
250	nd->reading_a_point = 0;
251	nd->found_contact_id = 0;
252	hid_set_drvdata(hdev, nd);
253
254	ret = hid_parse(hdev);
255	if (!ret)
256	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
257
258	if (ret)
259	kfree (nd);
837b4753	260
57fd637a SC	261	return ret;
	262	}
	263
	264	static void ntrig_remove(struct hid_device *hdev)
	265	{
	266	hid_hw_stop(hdev);
	267	kfree(hid_get_drvdata(hdev));
	268	}
	269
94011f93 RR	270	static const struct hid_device_id ntrig_devices[] = {
	271	{ HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN),
	272	.driver_data = NTRIG_DUPLICATE_USAGES },
	273	{ }
	274	};
	275	MODULE_DEVICE_TABLE(hid, ntrig_devices);
	276
57fd637a SC	277	static const struct hid_usage_id ntrig_grabbed_usages[] = {
	278	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
	279	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
	280	};
	281
94011f93 RR	282	static struct hid_driver ntrig_driver = {
	283	.name = "ntrig",
	284	.id_table = ntrig_devices,
57fd637a SC	285	.probe = ntrig_probe,
57fd637a SC	286	.remove = ntrig_remove,
94011f93 RR	287	.input_mapping = ntrig_input_mapping,
94011f93 RR	288	.input_mapped = ntrig_input_mapped,
57fd637a SC	289	.usage_table = ntrig_grabbed_usages,
57fd637a SC	290	.event = ntrig_event,
94011f93 RR	291	};
94011f93 RR	292
a24f423b	293	static int __init ntrig_init(void)
94011f93 RR	294	{
	295	return hid_register_driver(&ntrig_driver);
	296	}
	297
a24f423b	298	static void __exit ntrig_exit(void)
94011f93 RR	299	{
	300	hid_unregister_driver(&ntrig_driver);
	301	}
	302
	303	module_init(ntrig_init);
	304	module_exit(ntrig_exit);
	305	MODULE_LICENSE("GPL");