xref: /linux/drivers/hid/hid-multitouch.c (revision cc04a46f11ea046ed53e2c832ae29e4790f7e35f)
1 /*
2  *  HID driver for multitouch panels
3  *
4  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
7  *  Copyright (c) 2012-2013 Red Hat, Inc
8  *
9  *  This code is partly based on hid-egalax.c:
10  *
11  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
12  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
13  *  Copyright (c) 2010 Canonical, Ltd.
14  *
15  *  This code is partly based on hid-3m-pct.c:
16  *
17  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
18  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
19  *  Copyright (c) 2010      Canonical, Ltd.
20  *
21  */
22 
23 /*
24  * This program is free software; you can redistribute it and/or modify it
25  * under the terms of the GNU General Public License as published by the Free
26  * Software Foundation; either version 2 of the License, or (at your option)
27  * any later version.
28  */
29 
30 /*
31  * This driver is regularly tested thanks to the tool hid-test[1].
32  * This tool relies on hid-replay[2] and a database of hid devices[3].
33  * Please run these regression tests before patching this module so that
34  * your patch won't break existing known devices.
35  *
36  * [1] https://github.com/bentiss/hid-test
37  * [2] https://github.com/bentiss/hid-replay
38  * [3] https://github.com/bentiss/hid-devices
39  */
40 
41 #include <linux/device.h>
42 #include <linux/hid.h>
43 #include <linux/module.h>
44 #include <linux/slab.h>
45 #include <linux/input/mt.h>
46 #include <linux/string.h>
47 
48 
49 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
50 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
51 MODULE_DESCRIPTION("HID multitouch panels");
52 MODULE_LICENSE("GPL");
53 
54 #include "hid-ids.h"
55 
56 /* quirks to control the device */
57 #define MT_QUIRK_NOT_SEEN_MEANS_UP	(1 << 0)
58 #define MT_QUIRK_SLOT_IS_CONTACTID	(1 << 1)
59 #define MT_QUIRK_CYPRESS		(1 << 2)
60 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER	(1 << 3)
61 #define MT_QUIRK_ALWAYS_VALID		(1 << 4)
62 #define MT_QUIRK_VALID_IS_INRANGE	(1 << 5)
63 #define MT_QUIRK_VALID_IS_CONFIDENCE	(1 << 6)
64 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE	(1 << 8)
65 #define MT_QUIRK_NO_AREA		(1 << 9)
66 #define MT_QUIRK_IGNORE_DUPLICATES	(1 << 10)
67 #define MT_QUIRK_HOVERING		(1 << 11)
68 #define MT_QUIRK_CONTACT_CNT_ACCURATE	(1 << 12)
69 #define MT_QUIRK_FORCE_GET_FEATURE	(1 << 13)
70 
71 #define MT_INPUTMODE_TOUCHSCREEN	0x02
72 #define MT_INPUTMODE_TOUCHPAD		0x03
73 
74 #define MT_BUTTONTYPE_CLICKPAD		0
75 
76 struct mt_slot {
77 	__s32 x, y, cx, cy, p, w, h;
78 	__s32 contactid;	/* the device ContactID assigned to this slot */
79 	bool touch_state;	/* is the touch valid? */
80 	bool inrange_state;	/* is the finger in proximity of the sensor? */
81 };
82 
83 struct mt_class {
84 	__s32 name;	/* MT_CLS */
85 	__s32 quirks;
86 	__s32 sn_move;	/* Signal/noise ratio for move events */
87 	__s32 sn_width;	/* Signal/noise ratio for width events */
88 	__s32 sn_height;	/* Signal/noise ratio for height events */
89 	__s32 sn_pressure;	/* Signal/noise ratio for pressure events */
90 	__u8 maxcontacts;
91 	bool is_indirect;	/* true for touchpads */
92 	bool export_all_inputs;	/* do not ignore mouse, keyboards, etc... */
93 };
94 
95 struct mt_fields {
96 	unsigned usages[HID_MAX_FIELDS];
97 	unsigned int length;
98 };
99 
100 struct mt_device {
101 	struct mt_slot curdata;	/* placeholder of incoming data */
102 	struct mt_class mtclass;	/* our mt device class */
103 	struct mt_fields *fields;	/* temporary placeholder for storing the
104 					   multitouch fields */
105 	int cc_index;	/* contact count field index in the report */
106 	int cc_value_index;	/* contact count value index in the field */
107 	unsigned last_slot_field;	/* the last field of a slot */
108 	unsigned mt_report_id;	/* the report ID of the multitouch device */
109 	__s16 inputmode;	/* InputMode HID feature, -1 if non-existent */
110 	__s16 inputmode_index;	/* InputMode HID feature index in the report */
111 	__s16 maxcontact_report_id;	/* Maximum Contact Number HID feature,
112 				   -1 if non-existent */
113 	__u8 inputmode_value;  /* InputMode HID feature value */
114 	__u8 num_received;	/* how many contacts we received */
115 	__u8 num_expected;	/* expected last contact index */
116 	__u8 maxcontacts;
117 	__u8 touches_by_report;	/* how many touches are present in one report:
118 				* 1 means we should use a serial protocol
119 				* > 1 means hybrid (multitouch) protocol */
120 	__u8 buttons_count;	/* number of physical buttons per touchpad */
121 	bool is_buttonpad;	/* is this device a button pad? */
122 	bool serial_maybe;	/* need to check for serial protocol */
123 	bool curvalid;		/* is the current contact valid? */
124 	unsigned mt_flags;	/* flags to pass to input-mt */
125 };
126 
127 static void mt_post_parse_default_settings(struct mt_device *td);
128 static void mt_post_parse(struct mt_device *td);
129 
130 /* classes of device behavior */
131 #define MT_CLS_DEFAULT				0x0001
132 
133 #define MT_CLS_SERIAL				0x0002
134 #define MT_CLS_CONFIDENCE			0x0003
135 #define MT_CLS_CONFIDENCE_CONTACT_ID		0x0004
136 #define MT_CLS_CONFIDENCE_MINUS_ONE		0x0005
137 #define MT_CLS_DUAL_INRANGE_CONTACTID		0x0006
138 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER	0x0007
139 /* reserved					0x0008 */
140 #define MT_CLS_INRANGE_CONTACTNUMBER		0x0009
141 #define MT_CLS_NSMU				0x000a
142 /* reserved					0x0010 */
143 /* reserved					0x0011 */
144 #define MT_CLS_WIN_8				0x0012
145 #define MT_CLS_EXPORT_ALL_INPUTS		0x0013
146 
147 /* vendor specific classes */
148 #define MT_CLS_3M				0x0101
149 /* reserved					0x0102 */
150 #define MT_CLS_EGALAX				0x0103
151 #define MT_CLS_EGALAX_SERIAL			0x0104
152 #define MT_CLS_TOPSEED				0x0105
153 #define MT_CLS_PANASONIC			0x0106
154 #define MT_CLS_FLATFROG				0x0107
155 #define MT_CLS_GENERALTOUCH_TWOFINGERS		0x0108
156 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS	0x0109
157 #define MT_CLS_VTL				0x0110
158 
159 #define MT_DEFAULT_MAXCONTACT	10
160 #define MT_MAX_MAXCONTACT	250
161 
162 #define MT_USB_DEVICE(v, p)	HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
163 #define MT_BT_DEVICE(v, p)	HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
164 
165 /*
166  * these device-dependent functions determine what slot corresponds
167  * to a valid contact that was just read.
168  */
169 
170 static int cypress_compute_slot(struct mt_device *td)
171 {
172 	if (td->curdata.contactid != 0 || td->num_received == 0)
173 		return td->curdata.contactid;
174 	else
175 		return -1;
176 }
177 
178 static struct mt_class mt_classes[] = {
179 	{ .name = MT_CLS_DEFAULT,
180 		.quirks = MT_QUIRK_ALWAYS_VALID |
181 			MT_QUIRK_CONTACT_CNT_ACCURATE },
182 	{ .name = MT_CLS_NSMU,
183 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
184 	{ .name = MT_CLS_SERIAL,
185 		.quirks = MT_QUIRK_ALWAYS_VALID},
186 	{ .name = MT_CLS_CONFIDENCE,
187 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
188 	{ .name = MT_CLS_CONFIDENCE_CONTACT_ID,
189 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
190 			MT_QUIRK_SLOT_IS_CONTACTID },
191 	{ .name = MT_CLS_CONFIDENCE_MINUS_ONE,
192 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
193 			MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
194 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTID,
195 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
196 			MT_QUIRK_SLOT_IS_CONTACTID,
197 		.maxcontacts = 2 },
198 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
199 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
200 			MT_QUIRK_SLOT_IS_CONTACTNUMBER,
201 		.maxcontacts = 2 },
202 	{ .name = MT_CLS_INRANGE_CONTACTNUMBER,
203 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
204 			MT_QUIRK_SLOT_IS_CONTACTNUMBER },
205 	{ .name = MT_CLS_WIN_8,
206 		.quirks = MT_QUIRK_ALWAYS_VALID |
207 			MT_QUIRK_IGNORE_DUPLICATES |
208 			MT_QUIRK_HOVERING |
209 			MT_QUIRK_CONTACT_CNT_ACCURATE },
210 	{ .name = MT_CLS_EXPORT_ALL_INPUTS,
211 		.quirks = MT_QUIRK_ALWAYS_VALID |
212 			MT_QUIRK_CONTACT_CNT_ACCURATE,
213 		.export_all_inputs = true },
214 
215 	/*
216 	 * vendor specific classes
217 	 */
218 	{ .name = MT_CLS_3M,
219 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
220 			MT_QUIRK_SLOT_IS_CONTACTID,
221 		.sn_move = 2048,
222 		.sn_width = 128,
223 		.sn_height = 128,
224 		.maxcontacts = 60,
225 	},
226 	{ .name = MT_CLS_EGALAX,
227 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
228 			MT_QUIRK_VALID_IS_INRANGE,
229 		.sn_move = 4096,
230 		.sn_pressure = 32,
231 	},
232 	{ .name = MT_CLS_EGALAX_SERIAL,
233 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
234 			MT_QUIRK_ALWAYS_VALID,
235 		.sn_move = 4096,
236 		.sn_pressure = 32,
237 	},
238 	{ .name = MT_CLS_TOPSEED,
239 		.quirks = MT_QUIRK_ALWAYS_VALID,
240 		.is_indirect = true,
241 		.maxcontacts = 2,
242 	},
243 	{ .name = MT_CLS_PANASONIC,
244 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
245 		.maxcontacts = 4 },
246 	{ .name	= MT_CLS_GENERALTOUCH_TWOFINGERS,
247 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
248 			MT_QUIRK_VALID_IS_INRANGE |
249 			MT_QUIRK_SLOT_IS_CONTACTID,
250 		.maxcontacts = 2
251 	},
252 	{ .name	= MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
253 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
254 			MT_QUIRK_SLOT_IS_CONTACTID
255 	},
256 
257 	{ .name = MT_CLS_FLATFROG,
258 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
259 			MT_QUIRK_NO_AREA,
260 		.sn_move = 2048,
261 		.maxcontacts = 40,
262 	},
263 	{ .name = MT_CLS_VTL,
264 		.quirks = MT_QUIRK_ALWAYS_VALID |
265 			MT_QUIRK_CONTACT_CNT_ACCURATE |
266 			MT_QUIRK_FORCE_GET_FEATURE,
267 	},
268 	{ }
269 };
270 
271 static ssize_t mt_show_quirks(struct device *dev,
272 			   struct device_attribute *attr,
273 			   char *buf)
274 {
275 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
276 	struct mt_device *td = hid_get_drvdata(hdev);
277 
278 	return sprintf(buf, "%u\n", td->mtclass.quirks);
279 }
280 
281 static ssize_t mt_set_quirks(struct device *dev,
282 			  struct device_attribute *attr,
283 			  const char *buf, size_t count)
284 {
285 	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
286 	struct mt_device *td = hid_get_drvdata(hdev);
287 
288 	unsigned long val;
289 
290 	if (kstrtoul(buf, 0, &val))
291 		return -EINVAL;
292 
293 	td->mtclass.quirks = val;
294 
295 	if (td->cc_index < 0)
296 		td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
297 
298 	return count;
299 }
300 
301 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
302 
303 static struct attribute *sysfs_attrs[] = {
304 	&dev_attr_quirks.attr,
305 	NULL
306 };
307 
308 static struct attribute_group mt_attribute_group = {
309 	.attrs = sysfs_attrs
310 };
311 
312 static void mt_feature_mapping(struct hid_device *hdev,
313 		struct hid_field *field, struct hid_usage *usage)
314 {
315 	struct mt_device *td = hid_get_drvdata(hdev);
316 
317 	switch (usage->hid) {
318 	case HID_DG_INPUTMODE:
319 		/* Ignore if value index is out of bounds. */
320 		if (usage->usage_index >= field->report_count) {
321 			dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
322 			break;
323 		}
324 
325 		td->inputmode = field->report->id;
326 		td->inputmode_index = usage->usage_index;
327 
328 		break;
329 	case HID_DG_CONTACTMAX:
330 		td->maxcontact_report_id = field->report->id;
331 		td->maxcontacts = field->value[0];
332 		if (!td->maxcontacts &&
333 		    field->logical_maximum <= MT_MAX_MAXCONTACT)
334 			td->maxcontacts = field->logical_maximum;
335 		if (td->mtclass.maxcontacts)
336 			/* check if the maxcontacts is given by the class */
337 			td->maxcontacts = td->mtclass.maxcontacts;
338 
339 		break;
340 	case HID_DG_BUTTONTYPE:
341 		if (usage->usage_index >= field->report_count) {
342 			dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
343 			break;
344 		}
345 
346 		if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
347 			td->is_buttonpad = true;
348 
349 		break;
350 	}
351 }
352 
353 static void set_abs(struct input_dev *input, unsigned int code,
354 		struct hid_field *field, int snratio)
355 {
356 	int fmin = field->logical_minimum;
357 	int fmax = field->logical_maximum;
358 	int fuzz = snratio ? (fmax - fmin) / snratio : 0;
359 	input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
360 	input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
361 }
362 
363 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
364 		struct hid_input *hi)
365 {
366 	struct mt_fields *f = td->fields;
367 
368 	if (f->length >= HID_MAX_FIELDS)
369 		return;
370 
371 	f->usages[f->length++] = usage->hid;
372 }
373 
374 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
375 		struct hid_field *field, struct hid_usage *usage,
376 		unsigned long **bit, int *max)
377 {
378 	struct mt_device *td = hid_get_drvdata(hdev);
379 	struct mt_class *cls = &td->mtclass;
380 	int code;
381 	struct hid_usage *prev_usage = NULL;
382 
383 	if (field->application == HID_DG_TOUCHSCREEN)
384 		td->mt_flags |= INPUT_MT_DIRECT;
385 
386 	/*
387 	 * Model touchscreens providing buttons as touchpads.
388 	 */
389 	if (field->application == HID_DG_TOUCHPAD ||
390 	    (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
391 		td->mt_flags |= INPUT_MT_POINTER;
392 		td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
393 	}
394 
395 	/* count the buttons on touchpads */
396 	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
397 		td->buttons_count++;
398 
399 	if (usage->usage_index)
400 		prev_usage = &field->usage[usage->usage_index - 1];
401 
402 	switch (usage->hid & HID_USAGE_PAGE) {
403 
404 	case HID_UP_GENDESK:
405 		switch (usage->hid) {
406 		case HID_GD_X:
407 			if (prev_usage && (prev_usage->hid == usage->hid)) {
408 				hid_map_usage(hi, usage, bit, max,
409 					EV_ABS, ABS_MT_TOOL_X);
410 				set_abs(hi->input, ABS_MT_TOOL_X, field,
411 					cls->sn_move);
412 			} else {
413 				hid_map_usage(hi, usage, bit, max,
414 					EV_ABS, ABS_MT_POSITION_X);
415 				set_abs(hi->input, ABS_MT_POSITION_X, field,
416 					cls->sn_move);
417 			}
418 
419 			mt_store_field(usage, td, hi);
420 			return 1;
421 		case HID_GD_Y:
422 			if (prev_usage && (prev_usage->hid == usage->hid)) {
423 				hid_map_usage(hi, usage, bit, max,
424 					EV_ABS, ABS_MT_TOOL_Y);
425 				set_abs(hi->input, ABS_MT_TOOL_Y, field,
426 					cls->sn_move);
427 			} else {
428 				hid_map_usage(hi, usage, bit, max,
429 					EV_ABS, ABS_MT_POSITION_Y);
430 				set_abs(hi->input, ABS_MT_POSITION_Y, field,
431 					cls->sn_move);
432 			}
433 
434 			mt_store_field(usage, td, hi);
435 			return 1;
436 		}
437 		return 0;
438 
439 	case HID_UP_DIGITIZER:
440 		switch (usage->hid) {
441 		case HID_DG_INRANGE:
442 			if (cls->quirks & MT_QUIRK_HOVERING) {
443 				hid_map_usage(hi, usage, bit, max,
444 					EV_ABS, ABS_MT_DISTANCE);
445 				input_set_abs_params(hi->input,
446 					ABS_MT_DISTANCE, 0, 1, 0, 0);
447 			}
448 			mt_store_field(usage, td, hi);
449 			return 1;
450 		case HID_DG_CONFIDENCE:
451 			mt_store_field(usage, td, hi);
452 			return 1;
453 		case HID_DG_TIPSWITCH:
454 			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
455 			input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
456 			mt_store_field(usage, td, hi);
457 			return 1;
458 		case HID_DG_CONTACTID:
459 			mt_store_field(usage, td, hi);
460 			td->touches_by_report++;
461 			td->mt_report_id = field->report->id;
462 			return 1;
463 		case HID_DG_WIDTH:
464 			hid_map_usage(hi, usage, bit, max,
465 					EV_ABS, ABS_MT_TOUCH_MAJOR);
466 			if (!(cls->quirks & MT_QUIRK_NO_AREA))
467 				set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
468 					cls->sn_width);
469 			mt_store_field(usage, td, hi);
470 			return 1;
471 		case HID_DG_HEIGHT:
472 			hid_map_usage(hi, usage, bit, max,
473 					EV_ABS, ABS_MT_TOUCH_MINOR);
474 			if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
475 				set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
476 					cls->sn_height);
477 				input_set_abs_params(hi->input,
478 					ABS_MT_ORIENTATION, 0, 1, 0, 0);
479 			}
480 			mt_store_field(usage, td, hi);
481 			return 1;
482 		case HID_DG_TIPPRESSURE:
483 			hid_map_usage(hi, usage, bit, max,
484 					EV_ABS, ABS_MT_PRESSURE);
485 			set_abs(hi->input, ABS_MT_PRESSURE, field,
486 				cls->sn_pressure);
487 			mt_store_field(usage, td, hi);
488 			return 1;
489 		case HID_DG_CONTACTCOUNT:
490 			/* Ignore if indexes are out of bounds. */
491 			if (field->index >= field->report->maxfield ||
492 			    usage->usage_index >= field->report_count)
493 				return 1;
494 			td->cc_index = field->index;
495 			td->cc_value_index = usage->usage_index;
496 			return 1;
497 		case HID_DG_CONTACTMAX:
498 			/* we don't set td->last_slot_field as contactcount and
499 			 * contact max are global to the report */
500 			return -1;
501 		case HID_DG_TOUCH:
502 			/* Legacy devices use TIPSWITCH and not TOUCH.
503 			 * Let's just ignore this field. */
504 			return -1;
505 		}
506 		/* let hid-input decide for the others */
507 		return 0;
508 
509 	case HID_UP_BUTTON:
510 		code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
511 		hid_map_usage(hi, usage, bit, max, EV_KEY, code);
512 		input_set_capability(hi->input, EV_KEY, code);
513 		return 1;
514 
515 	case 0xff000000:
516 		/* we do not want to map these: no input-oriented meaning */
517 		return -1;
518 	}
519 
520 	return 0;
521 }
522 
523 static int mt_touch_input_mapped(struct hid_device *hdev, struct hid_input *hi,
524 		struct hid_field *field, struct hid_usage *usage,
525 		unsigned long **bit, int *max)
526 {
527 	if (usage->type == EV_KEY || usage->type == EV_ABS)
528 		set_bit(usage->type, hi->input->evbit);
529 
530 	return -1;
531 }
532 
533 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
534 {
535 	__s32 quirks = td->mtclass.quirks;
536 
537 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
538 		return td->curdata.contactid;
539 
540 	if (quirks & MT_QUIRK_CYPRESS)
541 		return cypress_compute_slot(td);
542 
543 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
544 		return td->num_received;
545 
546 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
547 		return td->curdata.contactid - 1;
548 
549 	return input_mt_get_slot_by_key(input, td->curdata.contactid);
550 }
551 
552 /*
553  * this function is called when a whole contact has been processed,
554  * so that it can assign it to a slot and store the data there
555  */
556 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
557 {
558 	if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
559 	    td->num_received >= td->num_expected)
560 		return;
561 
562 	if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
563 		int slotnum = mt_compute_slot(td, input);
564 		struct mt_slot *s = &td->curdata;
565 		struct input_mt *mt = input->mt;
566 
567 		if (slotnum < 0 || slotnum >= td->maxcontacts)
568 			return;
569 
570 		if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
571 			struct input_mt_slot *slot = &mt->slots[slotnum];
572 			if (input_mt_is_active(slot) &&
573 			    input_mt_is_used(mt, slot))
574 				return;
575 		}
576 
577 		input_mt_slot(input, slotnum);
578 		input_mt_report_slot_state(input, MT_TOOL_FINGER,
579 			s->touch_state || s->inrange_state);
580 		if (s->touch_state || s->inrange_state) {
581 			/* this finger is in proximity of the sensor */
582 			int wide = (s->w > s->h);
583 			/* divided by two to match visual scale of touch */
584 			int major = max(s->w, s->h) >> 1;
585 			int minor = min(s->w, s->h) >> 1;
586 
587 			input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
588 			input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
589 			input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
590 			input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
591 			input_event(input, EV_ABS, ABS_MT_DISTANCE,
592 				!s->touch_state);
593 			input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
594 			input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
595 			input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
596 			input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
597 		}
598 	}
599 
600 	td->num_received++;
601 }
602 
603 /*
604  * this function is called when a whole packet has been received and processed,
605  * so that it can decide what to send to the input layer.
606  */
607 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
608 {
609 	input_mt_sync_frame(input);
610 	input_sync(input);
611 	td->num_received = 0;
612 }
613 
614 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
615 				struct hid_usage *usage, __s32 value)
616 {
617 	/* we will handle the hidinput part later, now remains hiddev */
618 	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
619 		hid->hiddev_hid_event(hid, field, usage, value);
620 
621 	return 1;
622 }
623 
624 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
625 				struct hid_usage *usage, __s32 value)
626 {
627 	struct mt_device *td = hid_get_drvdata(hid);
628 	__s32 quirks = td->mtclass.quirks;
629 	struct input_dev *input = field->hidinput->input;
630 
631 	if (hid->claimed & HID_CLAIMED_INPUT) {
632 		switch (usage->hid) {
633 		case HID_DG_INRANGE:
634 			if (quirks & MT_QUIRK_VALID_IS_INRANGE)
635 				td->curvalid = value;
636 			if (quirks & MT_QUIRK_HOVERING)
637 				td->curdata.inrange_state = value;
638 			break;
639 		case HID_DG_TIPSWITCH:
640 			if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
641 				td->curvalid = value;
642 			td->curdata.touch_state = value;
643 			break;
644 		case HID_DG_CONFIDENCE:
645 			if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
646 				td->curvalid = value;
647 			break;
648 		case HID_DG_CONTACTID:
649 			td->curdata.contactid = value;
650 			break;
651 		case HID_DG_TIPPRESSURE:
652 			td->curdata.p = value;
653 			break;
654 		case HID_GD_X:
655 			if (usage->code == ABS_MT_TOOL_X)
656 				td->curdata.cx = value;
657 			else
658 				td->curdata.x = value;
659 			break;
660 		case HID_GD_Y:
661 			if (usage->code == ABS_MT_TOOL_Y)
662 				td->curdata.cy = value;
663 			else
664 				td->curdata.y = value;
665 			break;
666 		case HID_DG_WIDTH:
667 			td->curdata.w = value;
668 			break;
669 		case HID_DG_HEIGHT:
670 			td->curdata.h = value;
671 			break;
672 		case HID_DG_CONTACTCOUNT:
673 			break;
674 		case HID_DG_TOUCH:
675 			/* do nothing */
676 			break;
677 
678 		default:
679 			if (usage->type)
680 				input_event(input, usage->type, usage->code,
681 						value);
682 			return;
683 		}
684 
685 		if (usage->usage_index + 1 == field->report_count) {
686 			/* we only take into account the last report. */
687 			if (usage->hid == td->last_slot_field)
688 				mt_complete_slot(td, field->hidinput->input);
689 		}
690 
691 	}
692 }
693 
694 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
695 {
696 	struct mt_device *td = hid_get_drvdata(hid);
697 	struct hid_field *field;
698 	unsigned count;
699 	int r, n;
700 
701 	/*
702 	 * Includes multi-packet support where subsequent
703 	 * packets are sent with zero contactcount.
704 	 */
705 	if (td->cc_index >= 0) {
706 		struct hid_field *field = report->field[td->cc_index];
707 		int value = field->value[td->cc_value_index];
708 		if (value)
709 			td->num_expected = value;
710 	}
711 
712 	for (r = 0; r < report->maxfield; r++) {
713 		field = report->field[r];
714 		count = field->report_count;
715 
716 		if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
717 			continue;
718 
719 		for (n = 0; n < count; n++)
720 			mt_process_mt_event(hid, field, &field->usage[n],
721 					field->value[n]);
722 	}
723 
724 	if (td->num_received >= td->num_expected)
725 		mt_sync_frame(td, report->field[0]->hidinput->input);
726 }
727 
728 static void mt_touch_input_configured(struct hid_device *hdev,
729 					struct hid_input *hi)
730 {
731 	struct mt_device *td = hid_get_drvdata(hdev);
732 	struct mt_class *cls = &td->mtclass;
733 	struct input_dev *input = hi->input;
734 
735 	if (!td->maxcontacts)
736 		td->maxcontacts = MT_DEFAULT_MAXCONTACT;
737 
738 	mt_post_parse(td);
739 	if (td->serial_maybe)
740 		mt_post_parse_default_settings(td);
741 
742 	if (cls->is_indirect)
743 		td->mt_flags |= INPUT_MT_POINTER;
744 
745 	if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
746 		td->mt_flags |= INPUT_MT_DROP_UNUSED;
747 
748 	/* check for clickpads */
749 	if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
750 		td->is_buttonpad = true;
751 
752 	if (td->is_buttonpad)
753 		__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
754 
755 	input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
756 
757 	td->mt_flags = 0;
758 }
759 
760 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
761 		struct hid_field *field, struct hid_usage *usage,
762 		unsigned long **bit, int *max)
763 {
764 	struct mt_device *td = hid_get_drvdata(hdev);
765 
766 	/*
767 	 * If mtclass.export_all_inputs is not set, only map fields from
768 	 * TouchScreen or TouchPad collections. We need to ignore fields
769 	 * that belong to other collections such as Mouse that might have
770 	 * the same GenericDesktop usages.
771 	 */
772 	if (!td->mtclass.export_all_inputs &&
773 	    field->application != HID_DG_TOUCHSCREEN &&
774 	    field->application != HID_DG_PEN &&
775 	    field->application != HID_DG_TOUCHPAD)
776 		return -1;
777 
778 	/*
779 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
780 	 * for the stylus.
781 	 * The check for mt_report_id ensures we don't process
782 	 * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
783 	 * collection, but within the report ID.
784 	 */
785 	if (field->physical == HID_DG_STYLUS)
786 		return 0;
787 	else if ((field->physical == 0) &&
788 		 (field->report->id != td->mt_report_id) &&
789 		 (td->mt_report_id != -1))
790 		return 0;
791 
792 	if (field->application == HID_DG_TOUCHSCREEN ||
793 	    field->application == HID_DG_TOUCHPAD)
794 		return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
795 
796 	/* let hid-core decide for the others */
797 	return 0;
798 }
799 
800 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
801 		struct hid_field *field, struct hid_usage *usage,
802 		unsigned long **bit, int *max)
803 {
804 	/*
805 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
806 	 * for the stylus.
807 	 */
808 	if (field->physical == HID_DG_STYLUS)
809 		return 0;
810 
811 	if (field->application == HID_DG_TOUCHSCREEN ||
812 	    field->application == HID_DG_TOUCHPAD)
813 		return mt_touch_input_mapped(hdev, hi, field, usage, bit, max);
814 
815 	/* let hid-core decide for the others */
816 	return 0;
817 }
818 
819 static int mt_event(struct hid_device *hid, struct hid_field *field,
820 				struct hid_usage *usage, __s32 value)
821 {
822 	struct mt_device *td = hid_get_drvdata(hid);
823 
824 	if (field->report->id == td->mt_report_id)
825 		return mt_touch_event(hid, field, usage, value);
826 
827 	return 0;
828 }
829 
830 static void mt_report(struct hid_device *hid, struct hid_report *report)
831 {
832 	struct mt_device *td = hid_get_drvdata(hid);
833 	struct hid_field *field = report->field[0];
834 
835 	if (!(hid->claimed & HID_CLAIMED_INPUT))
836 		return;
837 
838 	if (report->id == td->mt_report_id)
839 		return mt_touch_report(hid, report);
840 
841 	if (field && field->hidinput && field->hidinput->input)
842 		input_sync(field->hidinput->input);
843 }
844 
845 static void mt_set_input_mode(struct hid_device *hdev)
846 {
847 	struct mt_device *td = hid_get_drvdata(hdev);
848 	struct hid_report *r;
849 	struct hid_report_enum *re;
850 	struct mt_class *cls = &td->mtclass;
851 	char *buf;
852 	int report_len;
853 
854 	if (td->inputmode < 0)
855 		return;
856 
857 	re = &(hdev->report_enum[HID_FEATURE_REPORT]);
858 	r = re->report_id_hash[td->inputmode];
859 	if (r) {
860 		if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
861 			report_len = hid_report_len(r);
862 			buf = hid_alloc_report_buf(r, GFP_KERNEL);
863 			if (!buf) {
864 				hid_err(hdev, "failed to allocate buffer for report\n");
865 				return;
866 			}
867 			hid_hw_raw_request(hdev, r->id, buf, report_len,
868 					   HID_FEATURE_REPORT,
869 					   HID_REQ_GET_REPORT);
870 			kfree(buf);
871 		}
872 		r->field[0]->value[td->inputmode_index] = td->inputmode_value;
873 		hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
874 	}
875 }
876 
877 static void mt_set_maxcontacts(struct hid_device *hdev)
878 {
879 	struct mt_device *td = hid_get_drvdata(hdev);
880 	struct hid_report *r;
881 	struct hid_report_enum *re;
882 	int fieldmax, max;
883 
884 	if (td->maxcontact_report_id < 0)
885 		return;
886 
887 	if (!td->mtclass.maxcontacts)
888 		return;
889 
890 	re = &hdev->report_enum[HID_FEATURE_REPORT];
891 	r = re->report_id_hash[td->maxcontact_report_id];
892 	if (r) {
893 		max = td->mtclass.maxcontacts;
894 		fieldmax = r->field[0]->logical_maximum;
895 		max = min(fieldmax, max);
896 		if (r->field[0]->value[0] != max) {
897 			r->field[0]->value[0] = max;
898 			hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
899 		}
900 	}
901 }
902 
903 static void mt_post_parse_default_settings(struct mt_device *td)
904 {
905 	__s32 quirks = td->mtclass.quirks;
906 
907 	/* unknown serial device needs special quirks */
908 	if (td->touches_by_report == 1) {
909 		quirks |= MT_QUIRK_ALWAYS_VALID;
910 		quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
911 		quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
912 		quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
913 		quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
914 	}
915 
916 	td->mtclass.quirks = quirks;
917 }
918 
919 static void mt_post_parse(struct mt_device *td)
920 {
921 	struct mt_fields *f = td->fields;
922 	struct mt_class *cls = &td->mtclass;
923 
924 	if (td->touches_by_report > 0) {
925 		int field_count_per_touch = f->length / td->touches_by_report;
926 		td->last_slot_field = f->usages[field_count_per_touch - 1];
927 	}
928 
929 	if (td->cc_index < 0)
930 		cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
931 }
932 
933 static void mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
934 {
935 	struct mt_device *td = hid_get_drvdata(hdev);
936 	char *name;
937 	const char *suffix = NULL;
938 	struct hid_field *field = hi->report->field[0];
939 
940 	if (hi->report->id == td->mt_report_id)
941 		mt_touch_input_configured(hdev, hi);
942 
943 	/*
944 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
945 	 * for the stylus. Check this first, and then rely on the application
946 	 * field.
947 	 */
948 	if (hi->report->field[0]->physical == HID_DG_STYLUS) {
949 		suffix = "Pen";
950 		/* force BTN_STYLUS to allow tablet matching in udev */
951 		__set_bit(BTN_STYLUS, hi->input->keybit);
952 	} else {
953 		switch (field->application) {
954 		case HID_GD_KEYBOARD:
955 			suffix = "Keyboard";
956 			break;
957 		case HID_GD_KEYPAD:
958 			suffix = "Keypad";
959 			break;
960 		case HID_GD_MOUSE:
961 			suffix = "Mouse";
962 			break;
963 		case HID_DG_STYLUS:
964 			suffix = "Pen";
965 			/* force BTN_STYLUS to allow tablet matching in udev */
966 			__set_bit(BTN_STYLUS, hi->input->keybit);
967 			break;
968 		case HID_DG_TOUCHSCREEN:
969 			/* we do not set suffix = "Touchscreen" */
970 			break;
971 		case HID_GD_SYSTEM_CONTROL:
972 			suffix = "System Control";
973 			break;
974 		case HID_CP_CONSUMER_CONTROL:
975 			suffix = "Consumer Control";
976 			break;
977 		default:
978 			suffix = "UNKNOWN";
979 			break;
980 		}
981 	}
982 
983 	if (suffix) {
984 		name = devm_kzalloc(&hi->input->dev,
985 				    strlen(hdev->name) + strlen(suffix) + 2,
986 				    GFP_KERNEL);
987 		if (name) {
988 			sprintf(name, "%s %s", hdev->name, suffix);
989 			hi->input->name = name;
990 		}
991 	}
992 }
993 
994 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
995 {
996 	int ret, i;
997 	struct mt_device *td;
998 	struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
999 
1000 	for (i = 0; mt_classes[i].name ; i++) {
1001 		if (id->driver_data == mt_classes[i].name) {
1002 			mtclass = &(mt_classes[i]);
1003 			break;
1004 		}
1005 	}
1006 
1007 	/* This allows the driver to correctly support devices
1008 	 * that emit events over several HID messages.
1009 	 */
1010 	hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1011 
1012 	/*
1013 	 * This allows the driver to handle different input sensors
1014 	 * that emits events through different reports on the same HID
1015 	 * device.
1016 	 */
1017 	hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1018 	hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
1019 
1020 	/*
1021 	 * Handle special quirks for Windows 8 certified devices.
1022 	 */
1023 	if (id->group == HID_GROUP_MULTITOUCH_WIN_8)
1024 		/*
1025 		 * Some multitouch screens do not like to be polled for input
1026 		 * reports. Fortunately, the Win8 spec says that all touches
1027 		 * should be sent during each report, making the initialization
1028 		 * of input reports unnecessary.
1029 		 */
1030 		hdev->quirks |= HID_QUIRK_NO_INIT_INPUT_REPORTS;
1031 
1032 	td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1033 	if (!td) {
1034 		dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1035 		return -ENOMEM;
1036 	}
1037 	td->mtclass = *mtclass;
1038 	td->inputmode = -1;
1039 	td->maxcontact_report_id = -1;
1040 	td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1041 	td->cc_index = -1;
1042 	td->mt_report_id = -1;
1043 	hid_set_drvdata(hdev, td);
1044 
1045 	td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1046 				  GFP_KERNEL);
1047 	if (!td->fields) {
1048 		dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1049 		return -ENOMEM;
1050 	}
1051 
1052 	if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1053 		td->serial_maybe = true;
1054 
1055 	ret = hid_parse(hdev);
1056 	if (ret != 0)
1057 		return ret;
1058 
1059 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1060 	if (ret)
1061 		return ret;
1062 
1063 	ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1064 
1065 	mt_set_maxcontacts(hdev);
1066 	mt_set_input_mode(hdev);
1067 
1068 	/* release .fields memory as it is not used anymore */
1069 	devm_kfree(&hdev->dev, td->fields);
1070 	td->fields = NULL;
1071 
1072 	return 0;
1073 }
1074 
1075 #ifdef CONFIG_PM
1076 static int mt_reset_resume(struct hid_device *hdev)
1077 {
1078 	mt_set_maxcontacts(hdev);
1079 	mt_set_input_mode(hdev);
1080 	return 0;
1081 }
1082 
1083 static int mt_resume(struct hid_device *hdev)
1084 {
1085 	/* Some Elan legacy devices require SET_IDLE to be set on resume.
1086 	 * It should be safe to send it to other devices too.
1087 	 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1088 
1089 	hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1090 
1091 	return 0;
1092 }
1093 #endif
1094 
1095 static void mt_remove(struct hid_device *hdev)
1096 {
1097 	sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1098 	hid_hw_stop(hdev);
1099 }
1100 
1101 /*
1102  * This list contains only:
1103  * - VID/PID of products not working with the default multitouch handling
1104  * - 2 generic rules.
1105  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1106  */
1107 static const struct hid_device_id mt_devices[] = {
1108 
1109 	/* 3M panels */
1110 	{ .driver_data = MT_CLS_3M,
1111 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1112 			USB_DEVICE_ID_3M1968) },
1113 	{ .driver_data = MT_CLS_3M,
1114 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1115 			USB_DEVICE_ID_3M2256) },
1116 	{ .driver_data = MT_CLS_3M,
1117 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1118 			USB_DEVICE_ID_3M3266) },
1119 
1120 	/* Anton devices */
1121 	{ .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1122 		MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1123 			USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1124 
1125 	/* Atmel panels */
1126 	{ .driver_data = MT_CLS_SERIAL,
1127 		MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1128 			USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1129 
1130 	/* Baanto multitouch devices */
1131 	{ .driver_data = MT_CLS_NSMU,
1132 		MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1133 			USB_DEVICE_ID_BAANTO_MT_190W2) },
1134 
1135 	/* Cando panels */
1136 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1137 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1138 			USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1139 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1140 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1141 			USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1142 
1143 	/* Chunghwa Telecom touch panels */
1144 	{  .driver_data = MT_CLS_NSMU,
1145 		MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1146 			USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1147 
1148 	/* CJTouch panels */
1149 	{ .driver_data = MT_CLS_NSMU,
1150 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1151 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1152 	{ .driver_data = MT_CLS_NSMU,
1153 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1154 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1155 
1156 	/* CVTouch panels */
1157 	{ .driver_data = MT_CLS_NSMU,
1158 		MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1159 			USB_DEVICE_ID_CVTOUCH_SCREEN) },
1160 
1161 	/* eGalax devices (resistive) */
1162 	{ .driver_data = MT_CLS_EGALAX,
1163 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1164 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1165 	{ .driver_data = MT_CLS_EGALAX,
1166 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1167 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1168 
1169 	/* eGalax devices (capacitive) */
1170 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1171 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1172 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1173 	{ .driver_data = MT_CLS_EGALAX,
1174 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1175 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1176 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1177 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1178 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1179 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1180 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1181 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1182 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1183 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1184 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1185 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1186 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1187 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1188 	{ .driver_data = MT_CLS_EGALAX,
1189 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1190 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1191 	{ .driver_data = MT_CLS_EGALAX,
1192 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1193 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1194 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1195 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1196 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1197 	{ .driver_data = MT_CLS_EGALAX,
1198 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1199 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1200 	{ .driver_data = MT_CLS_EGALAX,
1201 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1202 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1203 	{ .driver_data = MT_CLS_EGALAX,
1204 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1205 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1206 	{ .driver_data = MT_CLS_EGALAX,
1207 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1208 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1209 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1210 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1211 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1212 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1213 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1214 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1215 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1216 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1217 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1218 
1219 	/* Elitegroup panel */
1220 	{ .driver_data = MT_CLS_SERIAL,
1221 		MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1222 			USB_DEVICE_ID_ELITEGROUP_05D8) },
1223 
1224 	/* Flatfrog Panels */
1225 	{ .driver_data = MT_CLS_FLATFROG,
1226 		MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1227 			USB_DEVICE_ID_MULTITOUCH_3200) },
1228 
1229 	/* FocalTech Panels */
1230 	{ .driver_data = MT_CLS_SERIAL,
1231 		MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1232 			USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1233 
1234 	/* GeneralTouch panel */
1235 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1236 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1237 			USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1238 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1239 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1240 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1241 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1242 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1243 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1244 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1245 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1246 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1247 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1248 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1249 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1250 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1251 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1252 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1253 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1254 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1255 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1256 
1257 	/* Gametel game controller */
1258 	{ .driver_data = MT_CLS_NSMU,
1259 		MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1260 			USB_DEVICE_ID_GAMETEL_MT_MODE) },
1261 
1262 	/* GoodTouch panels */
1263 	{ .driver_data = MT_CLS_NSMU,
1264 		MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1265 			USB_DEVICE_ID_GOODTOUCH_000f) },
1266 
1267 	/* Hanvon panels */
1268 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1269 		MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1270 			USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1271 
1272 	/* Ilitek dual touch panel */
1273 	{  .driver_data = MT_CLS_NSMU,
1274 		MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1275 			USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1276 
1277 	/* MosArt panels */
1278 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1279 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1280 			USB_DEVICE_ID_ASUS_T91MT)},
1281 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1282 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1283 			USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1284 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1285 		MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1286 			USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1287 
1288 	/* Panasonic panels */
1289 	{ .driver_data = MT_CLS_PANASONIC,
1290 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1291 			USB_DEVICE_ID_PANABOARD_UBT780) },
1292 	{ .driver_data = MT_CLS_PANASONIC,
1293 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1294 			USB_DEVICE_ID_PANABOARD_UBT880) },
1295 
1296 	/* Novatek Panel */
1297 	{ .driver_data = MT_CLS_NSMU,
1298 		MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1299 			USB_DEVICE_ID_NOVATEK_PCT) },
1300 
1301 	/* PixArt optical touch screen */
1302 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1303 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1304 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1305 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1306 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1307 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1308 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1309 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1310 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1311 
1312 	/* PixCir-based panels */
1313 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1314 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1315 			USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1316 
1317 	/* Quanta-based panels */
1318 	{ .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1319 		MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1320 			USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1321 
1322 	/* Stantum panels */
1323 	{ .driver_data = MT_CLS_CONFIDENCE,
1324 		MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1325 			USB_DEVICE_ID_MTP_STM)},
1326 
1327 	/* TopSeed panels */
1328 	{ .driver_data = MT_CLS_TOPSEED,
1329 		MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1330 			USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1331 
1332 	/* Touch International panels */
1333 	{ .driver_data = MT_CLS_NSMU,
1334 		MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1335 			USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1336 
1337 	/* Unitec panels */
1338 	{ .driver_data = MT_CLS_NSMU,
1339 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1340 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1341 	{ .driver_data = MT_CLS_NSMU,
1342 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1343 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1344 
1345 	/* VTL panels */
1346 	{ .driver_data = MT_CLS_VTL,
1347 		MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1348 			USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1349 
1350 	/* Wistron panels */
1351 	{ .driver_data = MT_CLS_NSMU,
1352 		MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1353 			USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1354 
1355 	/* XAT */
1356 	{ .driver_data = MT_CLS_NSMU,
1357 		MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1358 			USB_DEVICE_ID_XAT_CSR) },
1359 
1360 	/* Xiroku */
1361 	{ .driver_data = MT_CLS_NSMU,
1362 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1363 			USB_DEVICE_ID_XIROKU_SPX) },
1364 	{ .driver_data = MT_CLS_NSMU,
1365 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1366 			USB_DEVICE_ID_XIROKU_MPX) },
1367 	{ .driver_data = MT_CLS_NSMU,
1368 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1369 			USB_DEVICE_ID_XIROKU_CSR) },
1370 	{ .driver_data = MT_CLS_NSMU,
1371 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1372 			USB_DEVICE_ID_XIROKU_SPX1) },
1373 	{ .driver_data = MT_CLS_NSMU,
1374 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1375 			USB_DEVICE_ID_XIROKU_MPX1) },
1376 	{ .driver_data = MT_CLS_NSMU,
1377 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1378 			USB_DEVICE_ID_XIROKU_CSR1) },
1379 	{ .driver_data = MT_CLS_NSMU,
1380 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1381 			USB_DEVICE_ID_XIROKU_SPX2) },
1382 	{ .driver_data = MT_CLS_NSMU,
1383 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1384 			USB_DEVICE_ID_XIROKU_MPX2) },
1385 	{ .driver_data = MT_CLS_NSMU,
1386 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1387 			USB_DEVICE_ID_XIROKU_CSR2) },
1388 
1389 	/* Generic MT device */
1390 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1391 
1392 	/* Generic Win 8 certified MT device */
1393 	{  .driver_data = MT_CLS_WIN_8,
1394 		HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1395 			HID_ANY_ID, HID_ANY_ID) },
1396 	{ }
1397 };
1398 MODULE_DEVICE_TABLE(hid, mt_devices);
1399 
1400 static const struct hid_usage_id mt_grabbed_usages[] = {
1401 	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1402 	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1403 };
1404 
1405 static struct hid_driver mt_driver = {
1406 	.name = "hid-multitouch",
1407 	.id_table = mt_devices,
1408 	.probe = mt_probe,
1409 	.remove = mt_remove,
1410 	.input_mapping = mt_input_mapping,
1411 	.input_mapped = mt_input_mapped,
1412 	.input_configured = mt_input_configured,
1413 	.feature_mapping = mt_feature_mapping,
1414 	.usage_table = mt_grabbed_usages,
1415 	.event = mt_event,
1416 	.report = mt_report,
1417 #ifdef CONFIG_PM
1418 	.reset_resume = mt_reset_resume,
1419 	.resume = mt_resume,
1420 #endif
1421 };
1422 module_hid_driver(mt_driver);
1423