xref: /openbmc/linux/drivers/hid/hid-multitouch.c (revision 52c291a3)
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 #include <linux/timer.h>
48 
49 
50 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
51 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
52 MODULE_DESCRIPTION("HID multitouch panels");
53 MODULE_LICENSE("GPL");
54 
55 #include "hid-ids.h"
56 
57 /* quirks to control the device */
58 #define MT_QUIRK_NOT_SEEN_MEANS_UP	BIT(0)
59 #define MT_QUIRK_SLOT_IS_CONTACTID	BIT(1)
60 #define MT_QUIRK_CYPRESS		BIT(2)
61 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER	BIT(3)
62 #define MT_QUIRK_ALWAYS_VALID		BIT(4)
63 #define MT_QUIRK_VALID_IS_INRANGE	BIT(5)
64 #define MT_QUIRK_VALID_IS_CONFIDENCE	BIT(6)
65 #define MT_QUIRK_CONFIDENCE		BIT(7)
66 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE	BIT(8)
67 #define MT_QUIRK_NO_AREA		BIT(9)
68 #define MT_QUIRK_IGNORE_DUPLICATES	BIT(10)
69 #define MT_QUIRK_HOVERING		BIT(11)
70 #define MT_QUIRK_CONTACT_CNT_ACCURATE	BIT(12)
71 #define MT_QUIRK_FORCE_GET_FEATURE	BIT(13)
72 #define MT_QUIRK_FIX_CONST_CONTACT_ID	BIT(14)
73 #define MT_QUIRK_TOUCH_SIZE_SCALING	BIT(15)
74 #define MT_QUIRK_STICKY_FINGERS		BIT(16)
75 #define MT_QUIRK_ASUS_CUSTOM_UP		BIT(17)
76 
77 #define MT_INPUTMODE_TOUCHSCREEN	0x02
78 #define MT_INPUTMODE_TOUCHPAD		0x03
79 
80 #define MT_BUTTONTYPE_CLICKPAD		0
81 
82 #define MT_IO_FLAGS_RUNNING		0
83 #define MT_IO_FLAGS_ACTIVE_SLOTS	1
84 #define MT_IO_FLAGS_PENDING_SLOTS	2
85 
86 struct mt_slot {
87 	__s32 x, y, cx, cy, p, w, h;
88 	__s32 contactid;	/* the device ContactID assigned to this slot */
89 	bool touch_state;	/* is the touch valid? */
90 	bool inrange_state;	/* is the finger in proximity of the sensor? */
91 	bool confidence_state;  /* is the touch made by a finger? */
92 };
93 
94 struct mt_class {
95 	__s32 name;	/* MT_CLS */
96 	__s32 quirks;
97 	__s32 sn_move;	/* Signal/noise ratio for move events */
98 	__s32 sn_width;	/* Signal/noise ratio for width events */
99 	__s32 sn_height;	/* Signal/noise ratio for height events */
100 	__s32 sn_pressure;	/* Signal/noise ratio for pressure events */
101 	__u8 maxcontacts;
102 	bool is_indirect;	/* true for touchpads */
103 	bool export_all_inputs;	/* do not ignore mouse, keyboards, etc... */
104 };
105 
106 struct mt_fields {
107 	unsigned usages[HID_MAX_FIELDS];
108 	unsigned int length;
109 };
110 
111 struct mt_device {
112 	struct mt_slot curdata;	/* placeholder of incoming data */
113 	struct mt_class mtclass;	/* our mt device class */
114 	struct timer_list release_timer;	/* to release sticky fingers */
115 	struct mt_fields *fields;	/* temporary placeholder for storing the
116 					   multitouch fields */
117 	unsigned long mt_io_flags;	/* mt flags (MT_IO_FLAGS_*) */
118 	int cc_index;	/* contact count field index in the report */
119 	int cc_value_index;	/* contact count value index in the field */
120 	unsigned last_slot_field;	/* the last field of a slot */
121 	unsigned mt_report_id;	/* the report ID of the multitouch device */
122 	unsigned long initial_quirks;	/* initial quirks state */
123 	__s16 inputmode;	/* InputMode HID feature, -1 if non-existent */
124 	__s16 inputmode_index;	/* InputMode HID feature index in the report */
125 	__s16 maxcontact_report_id;	/* Maximum Contact Number HID feature,
126 				   -1 if non-existent */
127 	__u8 inputmode_value;  /* InputMode HID feature value */
128 	__u8 num_received;	/* how many contacts we received */
129 	__u8 num_expected;	/* expected last contact index */
130 	__u8 maxcontacts;
131 	__u8 touches_by_report;	/* how many touches are present in one report:
132 				* 1 means we should use a serial protocol
133 				* > 1 means hybrid (multitouch) protocol */
134 	__u8 buttons_count;	/* number of physical buttons per touchpad */
135 	bool is_buttonpad;	/* is this device a button pad? */
136 	bool serial_maybe;	/* need to check for serial protocol */
137 	bool curvalid;		/* is the current contact valid? */
138 	unsigned mt_flags;	/* flags to pass to input-mt */
139 };
140 
141 static void mt_post_parse_default_settings(struct mt_device *td);
142 static void mt_post_parse(struct mt_device *td);
143 
144 /* classes of device behavior */
145 #define MT_CLS_DEFAULT				0x0001
146 
147 #define MT_CLS_SERIAL				0x0002
148 #define MT_CLS_CONFIDENCE			0x0003
149 #define MT_CLS_CONFIDENCE_CONTACT_ID		0x0004
150 #define MT_CLS_CONFIDENCE_MINUS_ONE		0x0005
151 #define MT_CLS_DUAL_INRANGE_CONTACTID		0x0006
152 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER	0x0007
153 /* reserved					0x0008 */
154 #define MT_CLS_INRANGE_CONTACTNUMBER		0x0009
155 #define MT_CLS_NSMU				0x000a
156 /* reserved					0x0010 */
157 /* reserved					0x0011 */
158 #define MT_CLS_WIN_8				0x0012
159 #define MT_CLS_EXPORT_ALL_INPUTS		0x0013
160 #define MT_CLS_WIN_8_DUAL			0x0014
161 
162 /* vendor specific classes */
163 #define MT_CLS_3M				0x0101
164 /* reserved					0x0102 */
165 #define MT_CLS_EGALAX				0x0103
166 #define MT_CLS_EGALAX_SERIAL			0x0104
167 #define MT_CLS_TOPSEED				0x0105
168 #define MT_CLS_PANASONIC			0x0106
169 #define MT_CLS_FLATFROG				0x0107
170 #define MT_CLS_GENERALTOUCH_TWOFINGERS		0x0108
171 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS	0x0109
172 #define MT_CLS_LG				0x010a
173 #define MT_CLS_ASUS				0x010b
174 #define MT_CLS_VTL				0x0110
175 #define MT_CLS_GOOGLE				0x0111
176 
177 #define MT_DEFAULT_MAXCONTACT	10
178 #define MT_MAX_MAXCONTACT	250
179 
180 #define MT_USB_DEVICE(v, p)	HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
181 #define MT_BT_DEVICE(v, p)	HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
182 
183 /*
184  * these device-dependent functions determine what slot corresponds
185  * to a valid contact that was just read.
186  */
187 
188 static int cypress_compute_slot(struct mt_device *td)
189 {
190 	if (td->curdata.contactid != 0 || td->num_received == 0)
191 		return td->curdata.contactid;
192 	else
193 		return -1;
194 }
195 
196 static struct mt_class mt_classes[] = {
197 	{ .name = MT_CLS_DEFAULT,
198 		.quirks = MT_QUIRK_ALWAYS_VALID |
199 			MT_QUIRK_CONTACT_CNT_ACCURATE },
200 	{ .name = MT_CLS_NSMU,
201 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
202 	{ .name = MT_CLS_SERIAL,
203 		.quirks = MT_QUIRK_ALWAYS_VALID},
204 	{ .name = MT_CLS_CONFIDENCE,
205 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
206 	{ .name = MT_CLS_CONFIDENCE_CONTACT_ID,
207 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
208 			MT_QUIRK_SLOT_IS_CONTACTID },
209 	{ .name = MT_CLS_CONFIDENCE_MINUS_ONE,
210 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
211 			MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
212 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTID,
213 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
214 			MT_QUIRK_SLOT_IS_CONTACTID,
215 		.maxcontacts = 2 },
216 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
217 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
218 			MT_QUIRK_SLOT_IS_CONTACTNUMBER,
219 		.maxcontacts = 2 },
220 	{ .name = MT_CLS_INRANGE_CONTACTNUMBER,
221 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
222 			MT_QUIRK_SLOT_IS_CONTACTNUMBER },
223 	{ .name = MT_CLS_WIN_8,
224 		.quirks = MT_QUIRK_ALWAYS_VALID |
225 			MT_QUIRK_IGNORE_DUPLICATES |
226 			MT_QUIRK_HOVERING |
227 			MT_QUIRK_CONTACT_CNT_ACCURATE |
228 			MT_QUIRK_STICKY_FINGERS },
229 	{ .name = MT_CLS_EXPORT_ALL_INPUTS,
230 		.quirks = MT_QUIRK_ALWAYS_VALID |
231 			MT_QUIRK_CONTACT_CNT_ACCURATE,
232 		.export_all_inputs = true },
233 	{ .name = MT_CLS_WIN_8_DUAL,
234 		.quirks = MT_QUIRK_ALWAYS_VALID |
235 			MT_QUIRK_IGNORE_DUPLICATES |
236 			MT_QUIRK_HOVERING |
237 			MT_QUIRK_CONTACT_CNT_ACCURATE,
238 		.export_all_inputs = true },
239 
240 	/*
241 	 * vendor specific classes
242 	 */
243 	{ .name = MT_CLS_3M,
244 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
245 			MT_QUIRK_SLOT_IS_CONTACTID |
246 			MT_QUIRK_TOUCH_SIZE_SCALING,
247 		.sn_move = 2048,
248 		.sn_width = 128,
249 		.sn_height = 128,
250 		.maxcontacts = 60,
251 	},
252 	{ .name = MT_CLS_EGALAX,
253 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
254 			MT_QUIRK_VALID_IS_INRANGE,
255 		.sn_move = 4096,
256 		.sn_pressure = 32,
257 	},
258 	{ .name = MT_CLS_EGALAX_SERIAL,
259 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
260 			MT_QUIRK_ALWAYS_VALID,
261 		.sn_move = 4096,
262 		.sn_pressure = 32,
263 	},
264 	{ .name = MT_CLS_TOPSEED,
265 		.quirks = MT_QUIRK_ALWAYS_VALID,
266 		.is_indirect = true,
267 		.maxcontacts = 2,
268 	},
269 	{ .name = MT_CLS_PANASONIC,
270 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
271 		.maxcontacts = 4 },
272 	{ .name	= MT_CLS_GENERALTOUCH_TWOFINGERS,
273 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
274 			MT_QUIRK_VALID_IS_INRANGE |
275 			MT_QUIRK_SLOT_IS_CONTACTID,
276 		.maxcontacts = 2
277 	},
278 	{ .name	= MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
279 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
280 			MT_QUIRK_SLOT_IS_CONTACTID
281 	},
282 
283 	{ .name = MT_CLS_FLATFROG,
284 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
285 			MT_QUIRK_NO_AREA,
286 		.sn_move = 2048,
287 		.maxcontacts = 40,
288 	},
289 	{ .name = MT_CLS_LG,
290 		.quirks = MT_QUIRK_ALWAYS_VALID |
291 			MT_QUIRK_FIX_CONST_CONTACT_ID |
292 			MT_QUIRK_IGNORE_DUPLICATES |
293 			MT_QUIRK_HOVERING |
294 			MT_QUIRK_CONTACT_CNT_ACCURATE },
295 	{ .name = MT_CLS_ASUS,
296 		.quirks = MT_QUIRK_ALWAYS_VALID |
297 			MT_QUIRK_CONTACT_CNT_ACCURATE |
298 			MT_QUIRK_ASUS_CUSTOM_UP },
299 	{ .name = MT_CLS_VTL,
300 		.quirks = MT_QUIRK_ALWAYS_VALID |
301 			MT_QUIRK_CONTACT_CNT_ACCURATE |
302 			MT_QUIRK_FORCE_GET_FEATURE,
303 	},
304 	{ .name = MT_CLS_GOOGLE,
305 		.quirks = MT_QUIRK_ALWAYS_VALID |
306 			MT_QUIRK_CONTACT_CNT_ACCURATE |
307 			MT_QUIRK_SLOT_IS_CONTACTID |
308 			MT_QUIRK_HOVERING
309 	},
310 	{ }
311 };
312 
313 static ssize_t mt_show_quirks(struct device *dev,
314 			   struct device_attribute *attr,
315 			   char *buf)
316 {
317 	struct hid_device *hdev = to_hid_device(dev);
318 	struct mt_device *td = hid_get_drvdata(hdev);
319 
320 	return sprintf(buf, "%u\n", td->mtclass.quirks);
321 }
322 
323 static ssize_t mt_set_quirks(struct device *dev,
324 			  struct device_attribute *attr,
325 			  const char *buf, size_t count)
326 {
327 	struct hid_device *hdev = to_hid_device(dev);
328 	struct mt_device *td = hid_get_drvdata(hdev);
329 
330 	unsigned long val;
331 
332 	if (kstrtoul(buf, 0, &val))
333 		return -EINVAL;
334 
335 	td->mtclass.quirks = val;
336 
337 	if (td->cc_index < 0)
338 		td->mtclass.quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
339 
340 	return count;
341 }
342 
343 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
344 
345 static struct attribute *sysfs_attrs[] = {
346 	&dev_attr_quirks.attr,
347 	NULL
348 };
349 
350 static const struct attribute_group mt_attribute_group = {
351 	.attrs = sysfs_attrs
352 };
353 
354 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
355 {
356 	struct mt_device *td = hid_get_drvdata(hdev);
357 	int ret, size = hid_report_len(report);
358 	u8 *buf;
359 
360 	/*
361 	 * Do not fetch the feature report if the device has been explicitly
362 	 * marked as non-capable.
363 	 */
364 	if (td->initial_quirks & HID_QUIRK_NO_INIT_REPORTS)
365 		return;
366 
367 	buf = hid_alloc_report_buf(report, GFP_KERNEL);
368 	if (!buf)
369 		return;
370 
371 	ret = hid_hw_raw_request(hdev, report->id, buf, size,
372 				 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
373 	if (ret < 0) {
374 		dev_warn(&hdev->dev, "failed to fetch feature %d\n",
375 			 report->id);
376 	} else {
377 		ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
378 					   size, 0);
379 		if (ret)
380 			dev_warn(&hdev->dev, "failed to report feature\n");
381 	}
382 
383 	kfree(buf);
384 }
385 
386 static void mt_feature_mapping(struct hid_device *hdev,
387 		struct hid_field *field, struct hid_usage *usage)
388 {
389 	struct mt_device *td = hid_get_drvdata(hdev);
390 
391 	switch (usage->hid) {
392 	case HID_DG_INPUTMODE:
393 		/* Ignore if value index is out of bounds. */
394 		if (usage->usage_index >= field->report_count) {
395 			dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
396 			break;
397 		}
398 
399 		if (td->inputmode < 0) {
400 			td->inputmode = field->report->id;
401 			td->inputmode_index = usage->usage_index;
402 		} else {
403 			/*
404 			 * Some elan panels wrongly declare 2 input mode
405 			 * features, and silently ignore when we set the
406 			 * value in the second field. Skip the second feature
407 			 * and hope for the best.
408 			 */
409 			dev_info(&hdev->dev,
410 				 "Ignoring the extra HID_DG_INPUTMODE\n");
411 		}
412 
413 		break;
414 	case HID_DG_CONTACTMAX:
415 		mt_get_feature(hdev, field->report);
416 
417 		td->maxcontact_report_id = field->report->id;
418 		td->maxcontacts = field->value[0];
419 		if (!td->maxcontacts &&
420 		    field->logical_maximum <= MT_MAX_MAXCONTACT)
421 			td->maxcontacts = field->logical_maximum;
422 		if (td->mtclass.maxcontacts)
423 			/* check if the maxcontacts is given by the class */
424 			td->maxcontacts = td->mtclass.maxcontacts;
425 
426 		break;
427 	case HID_DG_BUTTONTYPE:
428 		if (usage->usage_index >= field->report_count) {
429 			dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
430 			break;
431 		}
432 
433 		mt_get_feature(hdev, field->report);
434 		if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
435 			td->is_buttonpad = true;
436 
437 		break;
438 	case 0xff0000c5:
439 		/* Retrieve the Win8 blob once to enable some devices */
440 		if (usage->usage_index == 0)
441 			mt_get_feature(hdev, field->report);
442 		break;
443 	}
444 }
445 
446 static void set_abs(struct input_dev *input, unsigned int code,
447 		struct hid_field *field, int snratio)
448 {
449 	int fmin = field->logical_minimum;
450 	int fmax = field->logical_maximum;
451 	int fuzz = snratio ? (fmax - fmin) / snratio : 0;
452 	input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
453 	input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
454 }
455 
456 static void mt_store_field(struct hid_usage *usage, struct mt_device *td,
457 		struct hid_input *hi)
458 {
459 	struct mt_fields *f = td->fields;
460 
461 	if (f->length >= HID_MAX_FIELDS)
462 		return;
463 
464 	f->usages[f->length++] = usage->hid;
465 }
466 
467 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
468 		struct hid_field *field, struct hid_usage *usage,
469 		unsigned long **bit, int *max)
470 {
471 	struct mt_device *td = hid_get_drvdata(hdev);
472 	struct mt_class *cls = &td->mtclass;
473 	int code;
474 	struct hid_usage *prev_usage = NULL;
475 
476 	if (field->application == HID_DG_TOUCHSCREEN)
477 		td->mt_flags |= INPUT_MT_DIRECT;
478 
479 	/*
480 	 * Model touchscreens providing buttons as touchpads.
481 	 */
482 	if (field->application == HID_DG_TOUCHPAD ||
483 	    (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
484 		td->mt_flags |= INPUT_MT_POINTER;
485 		td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
486 	}
487 
488 	/* count the buttons on touchpads */
489 	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
490 		td->buttons_count++;
491 
492 	if (usage->usage_index)
493 		prev_usage = &field->usage[usage->usage_index - 1];
494 
495 	switch (usage->hid & HID_USAGE_PAGE) {
496 
497 	case HID_UP_GENDESK:
498 		switch (usage->hid) {
499 		case HID_GD_X:
500 			if (prev_usage && (prev_usage->hid == usage->hid)) {
501 				hid_map_usage(hi, usage, bit, max,
502 					EV_ABS, ABS_MT_TOOL_X);
503 				set_abs(hi->input, ABS_MT_TOOL_X, field,
504 					cls->sn_move);
505 			} else {
506 				hid_map_usage(hi, usage, bit, max,
507 					EV_ABS, ABS_MT_POSITION_X);
508 				set_abs(hi->input, ABS_MT_POSITION_X, field,
509 					cls->sn_move);
510 			}
511 
512 			mt_store_field(usage, td, hi);
513 			return 1;
514 		case HID_GD_Y:
515 			if (prev_usage && (prev_usage->hid == usage->hid)) {
516 				hid_map_usage(hi, usage, bit, max,
517 					EV_ABS, ABS_MT_TOOL_Y);
518 				set_abs(hi->input, ABS_MT_TOOL_Y, field,
519 					cls->sn_move);
520 			} else {
521 				hid_map_usage(hi, usage, bit, max,
522 					EV_ABS, ABS_MT_POSITION_Y);
523 				set_abs(hi->input, ABS_MT_POSITION_Y, field,
524 					cls->sn_move);
525 			}
526 
527 			mt_store_field(usage, td, hi);
528 			return 1;
529 		}
530 		return 0;
531 
532 	case HID_UP_DIGITIZER:
533 		switch (usage->hid) {
534 		case HID_DG_INRANGE:
535 			if (cls->quirks & MT_QUIRK_HOVERING) {
536 				hid_map_usage(hi, usage, bit, max,
537 					EV_ABS, ABS_MT_DISTANCE);
538 				input_set_abs_params(hi->input,
539 					ABS_MT_DISTANCE, 0, 1, 0, 0);
540 			}
541 			mt_store_field(usage, td, hi);
542 			return 1;
543 		case HID_DG_CONFIDENCE:
544 			if ((cls->name == MT_CLS_WIN_8 ||
545 				cls->name == MT_CLS_WIN_8_DUAL) &&
546 				field->application == HID_DG_TOUCHPAD)
547 				cls->quirks |= MT_QUIRK_CONFIDENCE;
548 			mt_store_field(usage, td, hi);
549 			return 1;
550 		case HID_DG_TIPSWITCH:
551 			hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
552 			input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
553 			mt_store_field(usage, td, hi);
554 			return 1;
555 		case HID_DG_CONTACTID:
556 			mt_store_field(usage, td, hi);
557 			td->touches_by_report++;
558 			td->mt_report_id = field->report->id;
559 			return 1;
560 		case HID_DG_WIDTH:
561 			hid_map_usage(hi, usage, bit, max,
562 					EV_ABS, ABS_MT_TOUCH_MAJOR);
563 			if (!(cls->quirks & MT_QUIRK_NO_AREA))
564 				set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
565 					cls->sn_width);
566 			mt_store_field(usage, td, hi);
567 			return 1;
568 		case HID_DG_HEIGHT:
569 			hid_map_usage(hi, usage, bit, max,
570 					EV_ABS, ABS_MT_TOUCH_MINOR);
571 			if (!(cls->quirks & MT_QUIRK_NO_AREA)) {
572 				set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
573 					cls->sn_height);
574 				input_set_abs_params(hi->input,
575 					ABS_MT_ORIENTATION, 0, 1, 0, 0);
576 			}
577 			mt_store_field(usage, td, hi);
578 			return 1;
579 		case HID_DG_TIPPRESSURE:
580 			hid_map_usage(hi, usage, bit, max,
581 					EV_ABS, ABS_MT_PRESSURE);
582 			set_abs(hi->input, ABS_MT_PRESSURE, field,
583 				cls->sn_pressure);
584 			mt_store_field(usage, td, hi);
585 			return 1;
586 		case HID_DG_CONTACTCOUNT:
587 			/* Ignore if indexes are out of bounds. */
588 			if (field->index >= field->report->maxfield ||
589 			    usage->usage_index >= field->report_count)
590 				return 1;
591 			td->cc_index = field->index;
592 			td->cc_value_index = usage->usage_index;
593 			return 1;
594 		case HID_DG_CONTACTMAX:
595 			/* we don't set td->last_slot_field as contactcount and
596 			 * contact max are global to the report */
597 			return -1;
598 		case HID_DG_TOUCH:
599 			/* Legacy devices use TIPSWITCH and not TOUCH.
600 			 * Let's just ignore this field. */
601 			return -1;
602 		}
603 		/* let hid-input decide for the others */
604 		return 0;
605 
606 	case HID_UP_BUTTON:
607 		code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
608 		/*
609 		 * MS PTP spec says that external buttons left and right have
610 		 * usages 2 and 3.
611 		 */
612 		if ((cls->name == MT_CLS_WIN_8 ||
613 			cls->name == MT_CLS_WIN_8_DUAL) &&
614 		    field->application == HID_DG_TOUCHPAD &&
615 		    (usage->hid & HID_USAGE) > 1)
616 			code--;
617 		hid_map_usage(hi, usage, bit, max, EV_KEY, code);
618 		input_set_capability(hi->input, EV_KEY, code);
619 		return 1;
620 
621 	case 0xff000000:
622 		/* we do not want to map these: no input-oriented meaning */
623 		return -1;
624 	}
625 
626 	return 0;
627 }
628 
629 static int mt_compute_slot(struct mt_device *td, struct input_dev *input)
630 {
631 	__s32 quirks = td->mtclass.quirks;
632 
633 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
634 		return td->curdata.contactid;
635 
636 	if (quirks & MT_QUIRK_CYPRESS)
637 		return cypress_compute_slot(td);
638 
639 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
640 		return td->num_received;
641 
642 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
643 		return td->curdata.contactid - 1;
644 
645 	return input_mt_get_slot_by_key(input, td->curdata.contactid);
646 }
647 
648 /*
649  * this function is called when a whole contact has been processed,
650  * so that it can assign it to a slot and store the data there
651  */
652 static void mt_complete_slot(struct mt_device *td, struct input_dev *input)
653 {
654 	if ((td->mtclass.quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
655 	    td->num_received >= td->num_expected)
656 		return;
657 
658 	if (td->curvalid || (td->mtclass.quirks & MT_QUIRK_ALWAYS_VALID)) {
659 		int active;
660 		int slotnum = mt_compute_slot(td, input);
661 		struct mt_slot *s = &td->curdata;
662 		struct input_mt *mt = input->mt;
663 
664 		if (slotnum < 0 || slotnum >= td->maxcontacts)
665 			return;
666 
667 		if ((td->mtclass.quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
668 			struct input_mt_slot *slot = &mt->slots[slotnum];
669 			if (input_mt_is_active(slot) &&
670 			    input_mt_is_used(mt, slot))
671 				return;
672 		}
673 
674 		if (!(td->mtclass.quirks & MT_QUIRK_CONFIDENCE))
675 			s->confidence_state = 1;
676 		active = (s->touch_state || s->inrange_state) &&
677 							s->confidence_state;
678 
679 		input_mt_slot(input, slotnum);
680 		input_mt_report_slot_state(input, MT_TOOL_FINGER, active);
681 		if (active) {
682 			/* this finger is in proximity of the sensor */
683 			int wide = (s->w > s->h);
684 			int major = max(s->w, s->h);
685 			int minor = min(s->w, s->h);
686 
687 			/*
688 			 * divided by two to match visual scale of touch
689 			 * for devices with this quirk
690 			 */
691 			if (td->mtclass.quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
692 				major = major >> 1;
693 				minor = minor >> 1;
694 			}
695 
696 			input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
697 			input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
698 			input_event(input, EV_ABS, ABS_MT_TOOL_X, s->cx);
699 			input_event(input, EV_ABS, ABS_MT_TOOL_Y, s->cy);
700 			input_event(input, EV_ABS, ABS_MT_DISTANCE,
701 				!s->touch_state);
702 			input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
703 			input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
704 			input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
705 			input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
706 
707 			set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
708 		}
709 	}
710 
711 	td->num_received++;
712 }
713 
714 /*
715  * this function is called when a whole packet has been received and processed,
716  * so that it can decide what to send to the input layer.
717  */
718 static void mt_sync_frame(struct mt_device *td, struct input_dev *input)
719 {
720 	input_mt_sync_frame(input);
721 	input_sync(input);
722 	td->num_received = 0;
723 	if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
724 		set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
725 	else
726 		clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
727 	clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
728 }
729 
730 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
731 				struct hid_usage *usage, __s32 value)
732 {
733 	/* we will handle the hidinput part later, now remains hiddev */
734 	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
735 		hid->hiddev_hid_event(hid, field, usage, value);
736 
737 	return 1;
738 }
739 
740 static void mt_process_mt_event(struct hid_device *hid, struct hid_field *field,
741 				struct hid_usage *usage, __s32 value)
742 {
743 	struct mt_device *td = hid_get_drvdata(hid);
744 	__s32 quirks = td->mtclass.quirks;
745 	struct input_dev *input = field->hidinput->input;
746 
747 	if (hid->claimed & HID_CLAIMED_INPUT) {
748 		switch (usage->hid) {
749 		case HID_DG_INRANGE:
750 			if (quirks & MT_QUIRK_VALID_IS_INRANGE)
751 				td->curvalid = value;
752 			if (quirks & MT_QUIRK_HOVERING)
753 				td->curdata.inrange_state = value;
754 			break;
755 		case HID_DG_TIPSWITCH:
756 			if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
757 				td->curvalid = value;
758 			td->curdata.touch_state = value;
759 			break;
760 		case HID_DG_CONFIDENCE:
761 			if (quirks & MT_QUIRK_CONFIDENCE)
762 				td->curdata.confidence_state = value;
763 			if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
764 				td->curvalid = value;
765 			break;
766 		case HID_DG_CONTACTID:
767 			td->curdata.contactid = value;
768 			break;
769 		case HID_DG_TIPPRESSURE:
770 			td->curdata.p = value;
771 			break;
772 		case HID_GD_X:
773 			if (usage->code == ABS_MT_TOOL_X)
774 				td->curdata.cx = value;
775 			else
776 				td->curdata.x = value;
777 			break;
778 		case HID_GD_Y:
779 			if (usage->code == ABS_MT_TOOL_Y)
780 				td->curdata.cy = value;
781 			else
782 				td->curdata.y = value;
783 			break;
784 		case HID_DG_WIDTH:
785 			td->curdata.w = value;
786 			break;
787 		case HID_DG_HEIGHT:
788 			td->curdata.h = value;
789 			break;
790 		case HID_DG_CONTACTCOUNT:
791 			break;
792 		case HID_DG_TOUCH:
793 			/* do nothing */
794 			break;
795 
796 		default:
797 			if (usage->type)
798 				input_event(input, usage->type, usage->code,
799 						value);
800 			return;
801 		}
802 
803 		if (usage->usage_index + 1 == field->report_count) {
804 			/* we only take into account the last report. */
805 			if (usage->hid == td->last_slot_field)
806 				mt_complete_slot(td, field->hidinput->input);
807 		}
808 
809 	}
810 }
811 
812 static void mt_touch_report(struct hid_device *hid, struct hid_report *report)
813 {
814 	struct mt_device *td = hid_get_drvdata(hid);
815 	struct hid_field *field;
816 	unsigned count;
817 	int r, n;
818 
819 	/* sticky fingers release in progress, abort */
820 	if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
821 		return;
822 
823 	/*
824 	 * Includes multi-packet support where subsequent
825 	 * packets are sent with zero contactcount.
826 	 */
827 	if (td->cc_index >= 0) {
828 		struct hid_field *field = report->field[td->cc_index];
829 		int value = field->value[td->cc_value_index];
830 		if (value)
831 			td->num_expected = value;
832 	}
833 
834 	for (r = 0; r < report->maxfield; r++) {
835 		field = report->field[r];
836 		count = field->report_count;
837 
838 		if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
839 			continue;
840 
841 		for (n = 0; n < count; n++)
842 			mt_process_mt_event(hid, field, &field->usage[n],
843 					field->value[n]);
844 	}
845 
846 	if (td->num_received >= td->num_expected)
847 		mt_sync_frame(td, report->field[0]->hidinput->input);
848 
849 	/*
850 	 * Windows 8 specs says 2 things:
851 	 * - once a contact has been reported, it has to be reported in each
852 	 *   subsequent report
853 	 * - the report rate when fingers are present has to be at least
854 	 *   the refresh rate of the screen, 60 or 120 Hz
855 	 *
856 	 * I interprete this that the specification forces a report rate of
857 	 * at least 60 Hz for a touchscreen to be certified.
858 	 * Which means that if we do not get a report whithin 16 ms, either
859 	 * something wrong happens, either the touchscreen forgets to send
860 	 * a release. Taking a reasonable margin allows to remove issues
861 	 * with USB communication or the load of the machine.
862 	 *
863 	 * Given that Win 8 devices are forced to send a release, this will
864 	 * only affect laggish machines and the ones that have a firmware
865 	 * defect.
866 	 */
867 	if (td->mtclass.quirks & MT_QUIRK_STICKY_FINGERS) {
868 		if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
869 			mod_timer(&td->release_timer,
870 				  jiffies + msecs_to_jiffies(100));
871 		else
872 			del_timer(&td->release_timer);
873 	}
874 
875 	clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
876 }
877 
878 static int mt_touch_input_configured(struct hid_device *hdev,
879 					struct hid_input *hi)
880 {
881 	struct mt_device *td = hid_get_drvdata(hdev);
882 	struct mt_class *cls = &td->mtclass;
883 	struct input_dev *input = hi->input;
884 	int ret;
885 
886 	if (!td->maxcontacts)
887 		td->maxcontacts = MT_DEFAULT_MAXCONTACT;
888 
889 	mt_post_parse(td);
890 	if (td->serial_maybe)
891 		mt_post_parse_default_settings(td);
892 
893 	if (cls->is_indirect)
894 		td->mt_flags |= INPUT_MT_POINTER;
895 
896 	if (cls->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
897 		td->mt_flags |= INPUT_MT_DROP_UNUSED;
898 
899 	/* check for clickpads */
900 	if ((td->mt_flags & INPUT_MT_POINTER) && (td->buttons_count == 1))
901 		td->is_buttonpad = true;
902 
903 	if (td->is_buttonpad)
904 		__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
905 
906 	ret = input_mt_init_slots(input, td->maxcontacts, td->mt_flags);
907 	if (ret)
908 		return ret;
909 
910 	td->mt_flags = 0;
911 	return 0;
912 }
913 
914 #define mt_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, \
915 						    max, EV_KEY, (c))
916 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
917 		struct hid_field *field, struct hid_usage *usage,
918 		unsigned long **bit, int *max)
919 {
920 	struct mt_device *td = hid_get_drvdata(hdev);
921 
922 	/*
923 	 * If mtclass.export_all_inputs is not set, only map fields from
924 	 * TouchScreen or TouchPad collections. We need to ignore fields
925 	 * that belong to other collections such as Mouse that might have
926 	 * the same GenericDesktop usages.
927 	 */
928 	if (!td->mtclass.export_all_inputs &&
929 	    field->application != HID_DG_TOUCHSCREEN &&
930 	    field->application != HID_DG_PEN &&
931 	    field->application != HID_DG_TOUCHPAD &&
932 	    field->application != HID_GD_KEYBOARD &&
933 	    field->application != HID_CP_CONSUMER_CONTROL &&
934 	    field->application != HID_GD_WIRELESS_RADIO_CTLS &&
935 	    !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
936 	      td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP))
937 		return -1;
938 
939 	/*
940 	 * Some Asus keyboard+touchpad devices have the hotkeys defined in the
941 	 * touchpad report descriptor. We need to treat these as an array to
942 	 * map usages to input keys.
943 	 */
944 	if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
945 	    td->mtclass.quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
946 	    (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
947 		set_bit(EV_REP, hi->input->evbit);
948 		if (field->flags & HID_MAIN_ITEM_VARIABLE)
949 			field->flags &= ~HID_MAIN_ITEM_VARIABLE;
950 		switch (usage->hid & HID_USAGE) {
951 		case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN);	break;
952 		case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP);		break;
953 		case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF);		break;
954 		case 0x6b: mt_map_key_clear(KEY_F21);			break;
955 		case 0x6c: mt_map_key_clear(KEY_SLEEP);			break;
956 		default:
957 			return -1;
958 		}
959 		return 1;
960 	}
961 
962 	/*
963 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
964 	 * for the stylus.
965 	 * The check for mt_report_id ensures we don't process
966 	 * HID_DG_CONTACTCOUNT from the pen report as it is outside the physical
967 	 * collection, but within the report ID.
968 	 */
969 	if (field->physical == HID_DG_STYLUS)
970 		return 0;
971 	else if ((field->physical == 0) &&
972 		 (field->report->id != td->mt_report_id) &&
973 		 (td->mt_report_id != -1))
974 		return 0;
975 
976 	if (field->application == HID_DG_TOUCHSCREEN ||
977 	    field->application == HID_DG_TOUCHPAD)
978 		return mt_touch_input_mapping(hdev, hi, field, usage, bit, max);
979 
980 	/* let hid-core decide for the others */
981 	return 0;
982 }
983 
984 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
985 		struct hid_field *field, struct hid_usage *usage,
986 		unsigned long **bit, int *max)
987 {
988 	/*
989 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
990 	 * for the stylus.
991 	 */
992 	if (field->physical == HID_DG_STYLUS)
993 		return 0;
994 
995 	if (field->application == HID_DG_TOUCHSCREEN ||
996 	    field->application == HID_DG_TOUCHPAD) {
997 		/* We own these mappings, tell hid-input to ignore them */
998 		return -1;
999 	}
1000 
1001 	/* let hid-core decide for the others */
1002 	return 0;
1003 }
1004 
1005 static int mt_event(struct hid_device *hid, struct hid_field *field,
1006 				struct hid_usage *usage, __s32 value)
1007 {
1008 	struct mt_device *td = hid_get_drvdata(hid);
1009 
1010 	if (field->report->id == td->mt_report_id)
1011 		return mt_touch_event(hid, field, usage, value);
1012 
1013 	return 0;
1014 }
1015 
1016 static void mt_report(struct hid_device *hid, struct hid_report *report)
1017 {
1018 	struct mt_device *td = hid_get_drvdata(hid);
1019 	struct hid_field *field = report->field[0];
1020 
1021 	if (!(hid->claimed & HID_CLAIMED_INPUT))
1022 		return;
1023 
1024 	if (report->id == td->mt_report_id)
1025 		return mt_touch_report(hid, report);
1026 
1027 	if (field && field->hidinput && field->hidinput->input)
1028 		input_sync(field->hidinput->input);
1029 }
1030 
1031 static void mt_set_input_mode(struct hid_device *hdev)
1032 {
1033 	struct mt_device *td = hid_get_drvdata(hdev);
1034 	struct hid_report *r;
1035 	struct hid_report_enum *re;
1036 	struct mt_class *cls = &td->mtclass;
1037 	char *buf;
1038 	int report_len;
1039 
1040 	if (td->inputmode < 0)
1041 		return;
1042 
1043 	re = &(hdev->report_enum[HID_FEATURE_REPORT]);
1044 	r = re->report_id_hash[td->inputmode];
1045 	if (r) {
1046 		if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1047 			report_len = hid_report_len(r);
1048 			buf = hid_alloc_report_buf(r, GFP_KERNEL);
1049 			if (!buf) {
1050 				hid_err(hdev, "failed to allocate buffer for report\n");
1051 				return;
1052 			}
1053 			hid_hw_raw_request(hdev, r->id, buf, report_len,
1054 					   HID_FEATURE_REPORT,
1055 					   HID_REQ_GET_REPORT);
1056 			kfree(buf);
1057 		}
1058 		r->field[0]->value[td->inputmode_index] = td->inputmode_value;
1059 		hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1060 	}
1061 }
1062 
1063 static void mt_set_maxcontacts(struct hid_device *hdev)
1064 {
1065 	struct mt_device *td = hid_get_drvdata(hdev);
1066 	struct hid_report *r;
1067 	struct hid_report_enum *re;
1068 	int fieldmax, max;
1069 
1070 	if (td->maxcontact_report_id < 0)
1071 		return;
1072 
1073 	if (!td->mtclass.maxcontacts)
1074 		return;
1075 
1076 	re = &hdev->report_enum[HID_FEATURE_REPORT];
1077 	r = re->report_id_hash[td->maxcontact_report_id];
1078 	if (r) {
1079 		max = td->mtclass.maxcontacts;
1080 		fieldmax = r->field[0]->logical_maximum;
1081 		max = min(fieldmax, max);
1082 		if (r->field[0]->value[0] != max) {
1083 			r->field[0]->value[0] = max;
1084 			hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
1085 		}
1086 	}
1087 }
1088 
1089 static void mt_post_parse_default_settings(struct mt_device *td)
1090 {
1091 	__s32 quirks = td->mtclass.quirks;
1092 
1093 	/* unknown serial device needs special quirks */
1094 	if (td->touches_by_report == 1) {
1095 		quirks |= MT_QUIRK_ALWAYS_VALID;
1096 		quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1097 		quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1098 		quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1099 		quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1100 	}
1101 
1102 	td->mtclass.quirks = quirks;
1103 }
1104 
1105 static void mt_post_parse(struct mt_device *td)
1106 {
1107 	struct mt_fields *f = td->fields;
1108 	struct mt_class *cls = &td->mtclass;
1109 
1110 	if (td->touches_by_report > 0) {
1111 		int field_count_per_touch = f->length / td->touches_by_report;
1112 		td->last_slot_field = f->usages[field_count_per_touch - 1];
1113 	}
1114 
1115 	if (td->cc_index < 0)
1116 		cls->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1117 }
1118 
1119 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1120 {
1121 	struct mt_device *td = hid_get_drvdata(hdev);
1122 	char *name;
1123 	const char *suffix = NULL;
1124 	struct hid_field *field = hi->report->field[0];
1125 	int ret;
1126 
1127 	if (hi->report->id == td->mt_report_id) {
1128 		ret = mt_touch_input_configured(hdev, hi);
1129 		if (ret)
1130 			return ret;
1131 	}
1132 
1133 	/*
1134 	 * some egalax touchscreens have "application == HID_DG_TOUCHSCREEN"
1135 	 * for the stylus. Check this first, and then rely on the application
1136 	 * field.
1137 	 */
1138 	if (hi->report->field[0]->physical == HID_DG_STYLUS) {
1139 		suffix = "Pen";
1140 		/* force BTN_STYLUS to allow tablet matching in udev */
1141 		__set_bit(BTN_STYLUS, hi->input->keybit);
1142 	} else {
1143 		switch (field->application) {
1144 		case HID_GD_KEYBOARD:
1145 			suffix = "Keyboard";
1146 			break;
1147 		case HID_GD_KEYPAD:
1148 			suffix = "Keypad";
1149 			break;
1150 		case HID_GD_MOUSE:
1151 			suffix = "Mouse";
1152 			break;
1153 		case HID_DG_STYLUS:
1154 			suffix = "Pen";
1155 			/* force BTN_STYLUS to allow tablet matching in udev */
1156 			__set_bit(BTN_STYLUS, hi->input->keybit);
1157 			break;
1158 		case HID_DG_TOUCHSCREEN:
1159 			/* we do not set suffix = "Touchscreen" */
1160 			break;
1161 		case HID_DG_TOUCHPAD:
1162 			suffix = "Touchpad";
1163 			break;
1164 		case HID_GD_SYSTEM_CONTROL:
1165 			suffix = "System Control";
1166 			break;
1167 		case HID_CP_CONSUMER_CONTROL:
1168 			suffix = "Consumer Control";
1169 			break;
1170 		case HID_GD_WIRELESS_RADIO_CTLS:
1171 			suffix = "Wireless Radio Control";
1172 			break;
1173 		case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1174 			suffix = "Custom Media Keys";
1175 			break;
1176 		default:
1177 			suffix = "UNKNOWN";
1178 			break;
1179 		}
1180 	}
1181 
1182 	if (suffix) {
1183 		name = devm_kzalloc(&hi->input->dev,
1184 				    strlen(hdev->name) + strlen(suffix) + 2,
1185 				    GFP_KERNEL);
1186 		if (name) {
1187 			sprintf(name, "%s %s", hdev->name, suffix);
1188 			hi->input->name = name;
1189 		}
1190 	}
1191 
1192 	return 0;
1193 }
1194 
1195 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1196 {
1197 	if (field->usage[0].hid != usage ||
1198 	    !(field->flags & HID_MAIN_ITEM_CONSTANT))
1199 		return;
1200 
1201 	field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1202 	field->flags |= HID_MAIN_ITEM_VARIABLE;
1203 }
1204 
1205 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1206 {
1207 	struct hid_report *report;
1208 	int i;
1209 
1210 	list_for_each_entry(report,
1211 			    &hdev->report_enum[HID_INPUT_REPORT].report_list,
1212 			    list) {
1213 
1214 		if (!report->maxfield)
1215 			continue;
1216 
1217 		for (i = 0; i < report->maxfield; i++)
1218 			if (report->field[i]->maxusage >= 1)
1219 				mt_fix_const_field(report->field[i], usage);
1220 	}
1221 }
1222 
1223 static void mt_release_contacts(struct hid_device *hid)
1224 {
1225 	struct hid_input *hidinput;
1226 	struct mt_device *td = hid_get_drvdata(hid);
1227 
1228 	list_for_each_entry(hidinput, &hid->inputs, list) {
1229 		struct input_dev *input_dev = hidinput->input;
1230 		struct input_mt *mt = input_dev->mt;
1231 		int i;
1232 
1233 		if (mt) {
1234 			for (i = 0; i < mt->num_slots; i++) {
1235 				input_mt_slot(input_dev, i);
1236 				input_mt_report_slot_state(input_dev,
1237 							   MT_TOOL_FINGER,
1238 							   false);
1239 			}
1240 			input_mt_sync_frame(input_dev);
1241 			input_sync(input_dev);
1242 		}
1243 	}
1244 
1245 	td->num_received = 0;
1246 }
1247 
1248 static void mt_expired_timeout(unsigned long arg)
1249 {
1250 	struct hid_device *hdev = (void *)arg;
1251 	struct mt_device *td = hid_get_drvdata(hdev);
1252 
1253 	/*
1254 	 * An input report came in just before we release the sticky fingers,
1255 	 * it will take care of the sticky fingers.
1256 	 */
1257 	if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1258 		return;
1259 	if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1260 		mt_release_contacts(hdev);
1261 	clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1262 }
1263 
1264 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1265 {
1266 	int ret, i;
1267 	struct mt_device *td;
1268 	struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1269 
1270 	for (i = 0; mt_classes[i].name ; i++) {
1271 		if (id->driver_data == mt_classes[i].name) {
1272 			mtclass = &(mt_classes[i]);
1273 			break;
1274 		}
1275 	}
1276 
1277 	td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1278 	if (!td) {
1279 		dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1280 		return -ENOMEM;
1281 	}
1282 	td->mtclass = *mtclass;
1283 	td->inputmode = -1;
1284 	td->maxcontact_report_id = -1;
1285 	td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1286 	td->cc_index = -1;
1287 	td->mt_report_id = -1;
1288 	hid_set_drvdata(hdev, td);
1289 
1290 	td->fields = devm_kzalloc(&hdev->dev, sizeof(struct mt_fields),
1291 				  GFP_KERNEL);
1292 	if (!td->fields) {
1293 		dev_err(&hdev->dev, "cannot allocate multitouch fields data\n");
1294 		return -ENOMEM;
1295 	}
1296 
1297 	if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1298 		td->serial_maybe = true;
1299 
1300 	/*
1301 	 * Store the initial quirk state
1302 	 */
1303 	td->initial_quirks = hdev->quirks;
1304 
1305 	/* This allows the driver to correctly support devices
1306 	 * that emit events over several HID messages.
1307 	 */
1308 	hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1309 
1310 	/*
1311 	 * This allows the driver to handle different input sensors
1312 	 * that emits events through different reports on the same HID
1313 	 * device.
1314 	 */
1315 	hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1316 	hdev->quirks |= HID_QUIRK_NO_EMPTY_INPUT;
1317 
1318 	/*
1319 	 * Some multitouch screens do not like to be polled for input
1320 	 * reports. Fortunately, the Win8 spec says that all touches
1321 	 * should be sent during each report, making the initialization
1322 	 * of input reports unnecessary. For Win7 devices, well, let's hope
1323 	 * they will still be happy (this is only be a problem if a touch
1324 	 * was already there while probing the device).
1325 	 *
1326 	 * In addition some touchpads do not behave well if we read
1327 	 * all feature reports from them. Instead we prevent
1328 	 * initial report fetching and then selectively fetch each
1329 	 * report we are interested in.
1330 	 */
1331 	hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1332 
1333 	setup_timer(&td->release_timer, mt_expired_timeout, (long)hdev);
1334 
1335 	ret = hid_parse(hdev);
1336 	if (ret != 0)
1337 		return ret;
1338 
1339 	if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1340 		mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1341 
1342 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1343 	if (ret)
1344 		return ret;
1345 
1346 	ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1347 	if (ret)
1348 		dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1349 				hdev->name);
1350 
1351 	mt_set_maxcontacts(hdev);
1352 	mt_set_input_mode(hdev);
1353 
1354 	/* release .fields memory as it is not used anymore */
1355 	devm_kfree(&hdev->dev, td->fields);
1356 	td->fields = NULL;
1357 
1358 	return 0;
1359 }
1360 
1361 #ifdef CONFIG_PM
1362 static int mt_reset_resume(struct hid_device *hdev)
1363 {
1364 	mt_release_contacts(hdev);
1365 	mt_set_maxcontacts(hdev);
1366 	mt_set_input_mode(hdev);
1367 	return 0;
1368 }
1369 
1370 static int mt_resume(struct hid_device *hdev)
1371 {
1372 	/* Some Elan legacy devices require SET_IDLE to be set on resume.
1373 	 * It should be safe to send it to other devices too.
1374 	 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1375 
1376 	hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1377 
1378 	return 0;
1379 }
1380 #endif
1381 
1382 static void mt_remove(struct hid_device *hdev)
1383 {
1384 	struct mt_device *td = hid_get_drvdata(hdev);
1385 
1386 	del_timer_sync(&td->release_timer);
1387 
1388 	sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1389 	hid_hw_stop(hdev);
1390 	hdev->quirks = td->initial_quirks;
1391 }
1392 
1393 /*
1394  * This list contains only:
1395  * - VID/PID of products not working with the default multitouch handling
1396  * - 2 generic rules.
1397  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1398  */
1399 static const struct hid_device_id mt_devices[] = {
1400 
1401 	/* 3M panels */
1402 	{ .driver_data = MT_CLS_3M,
1403 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1404 			USB_DEVICE_ID_3M1968) },
1405 	{ .driver_data = MT_CLS_3M,
1406 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1407 			USB_DEVICE_ID_3M2256) },
1408 	{ .driver_data = MT_CLS_3M,
1409 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1410 			USB_DEVICE_ID_3M3266) },
1411 
1412 	/* Alps devices */
1413 	{ .driver_data = MT_CLS_WIN_8_DUAL,
1414 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1415 			USB_VENDOR_ID_ALPS_JP,
1416 			HID_DEVICE_ID_ALPS_U1_DUAL_PTP) },
1417 	{ .driver_data = MT_CLS_WIN_8_DUAL,
1418 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1419 			USB_VENDOR_ID_ALPS_JP,
1420 			HID_DEVICE_ID_ALPS_U1_DUAL_3BTN_PTP) },
1421 
1422 	/* Anton devices */
1423 	{ .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1424 		MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1425 			USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1426 
1427 	/* Asus T304UA */
1428 	{ .driver_data = MT_CLS_ASUS,
1429 		HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1430 			USB_VENDOR_ID_ASUSTEK,
1431 			USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1432 
1433 	/* Atmel panels */
1434 	{ .driver_data = MT_CLS_SERIAL,
1435 		MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1436 			USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1437 
1438 	/* Baanto multitouch devices */
1439 	{ .driver_data = MT_CLS_NSMU,
1440 		MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1441 			USB_DEVICE_ID_BAANTO_MT_190W2) },
1442 
1443 	/* Cando panels */
1444 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1445 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1446 			USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1447 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1448 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1449 			USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1450 
1451 	/* Chunghwa Telecom touch panels */
1452 	{  .driver_data = MT_CLS_NSMU,
1453 		MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1454 			USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1455 
1456 	/* CJTouch panels */
1457 	{ .driver_data = MT_CLS_NSMU,
1458 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1459 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1460 	{ .driver_data = MT_CLS_NSMU,
1461 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1462 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1463 
1464 	/* CVTouch panels */
1465 	{ .driver_data = MT_CLS_NSMU,
1466 		MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1467 			USB_DEVICE_ID_CVTOUCH_SCREEN) },
1468 
1469 	/* eGalax devices (resistive) */
1470 	{ .driver_data = MT_CLS_EGALAX,
1471 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1472 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1473 	{ .driver_data = MT_CLS_EGALAX,
1474 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1475 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1476 
1477 	/* eGalax devices (capacitive) */
1478 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1479 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1480 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1481 	{ .driver_data = MT_CLS_EGALAX,
1482 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1483 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1484 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1485 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1486 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1487 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1488 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1489 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1490 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1491 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1492 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1493 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1494 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1495 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1496 	{ .driver_data = MT_CLS_EGALAX,
1497 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1498 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1499 	{ .driver_data = MT_CLS_EGALAX,
1500 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1501 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1502 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1503 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1504 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1505 	{ .driver_data = MT_CLS_EGALAX,
1506 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1507 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1508 	{ .driver_data = MT_CLS_EGALAX,
1509 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1510 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1511 	{ .driver_data = MT_CLS_EGALAX,
1512 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1513 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1514 	{ .driver_data = MT_CLS_EGALAX,
1515 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1516 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1517 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1518 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1519 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1520 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1521 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1522 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1523 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1524 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1525 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1526 
1527 	/* Elitegroup panel */
1528 	{ .driver_data = MT_CLS_SERIAL,
1529 		MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1530 			USB_DEVICE_ID_ELITEGROUP_05D8) },
1531 
1532 	/* Flatfrog Panels */
1533 	{ .driver_data = MT_CLS_FLATFROG,
1534 		MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1535 			USB_DEVICE_ID_MULTITOUCH_3200) },
1536 
1537 	/* FocalTech Panels */
1538 	{ .driver_data = MT_CLS_SERIAL,
1539 		MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1540 			USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1541 
1542 	/* GeneralTouch panel */
1543 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1544 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1545 			USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1546 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1547 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1548 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1549 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1550 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1551 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1552 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1553 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1554 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1555 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1556 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1557 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1558 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1559 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1560 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1561 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1562 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1563 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1564 
1565 	/* Gametel game controller */
1566 	{ .driver_data = MT_CLS_NSMU,
1567 		MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1568 			USB_DEVICE_ID_GAMETEL_MT_MODE) },
1569 
1570 	/* GoodTouch panels */
1571 	{ .driver_data = MT_CLS_NSMU,
1572 		MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1573 			USB_DEVICE_ID_GOODTOUCH_000f) },
1574 
1575 	/* Hanvon panels */
1576 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1577 		MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1578 			USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1579 
1580 	/* Ilitek dual touch panel */
1581 	{  .driver_data = MT_CLS_NSMU,
1582 		MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1583 			USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1584 
1585 	/* LG Melfas panel */
1586 	{ .driver_data = MT_CLS_LG,
1587 		HID_USB_DEVICE(USB_VENDOR_ID_LG,
1588 			USB_DEVICE_ID_LG_MELFAS_MT) },
1589 
1590 	/* MosArt panels */
1591 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1592 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1593 			USB_DEVICE_ID_ASUS_T91MT)},
1594 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1595 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
1596 			USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
1597 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
1598 		MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
1599 			USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
1600 
1601 	/* Panasonic panels */
1602 	{ .driver_data = MT_CLS_PANASONIC,
1603 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1604 			USB_DEVICE_ID_PANABOARD_UBT780) },
1605 	{ .driver_data = MT_CLS_PANASONIC,
1606 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
1607 			USB_DEVICE_ID_PANABOARD_UBT880) },
1608 
1609 	/* Novatek Panel */
1610 	{ .driver_data = MT_CLS_NSMU,
1611 		MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
1612 			USB_DEVICE_ID_NOVATEK_PCT) },
1613 
1614 	/* Ntrig Panel */
1615 	{ .driver_data = MT_CLS_NSMU,
1616 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1617 			USB_VENDOR_ID_NTRIG, 0x1b05) },
1618 
1619 	/* PixArt optical touch screen */
1620 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1621 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1622 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
1623 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1624 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1625 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
1626 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
1627 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
1628 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
1629 
1630 	/* PixCir-based panels */
1631 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1632 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1633 			USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
1634 
1635 	/* Quanta-based panels */
1636 	{ .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
1637 		MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
1638 			USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
1639 
1640 	/* Stantum panels */
1641 	{ .driver_data = MT_CLS_CONFIDENCE,
1642 		MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
1643 			USB_DEVICE_ID_MTP_STM)},
1644 
1645 	/* TopSeed panels */
1646 	{ .driver_data = MT_CLS_TOPSEED,
1647 		MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
1648 			USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
1649 
1650 	/* Touch International panels */
1651 	{ .driver_data = MT_CLS_NSMU,
1652 		MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
1653 			USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
1654 
1655 	/* Unitec panels */
1656 	{ .driver_data = MT_CLS_NSMU,
1657 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1658 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
1659 	{ .driver_data = MT_CLS_NSMU,
1660 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
1661 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
1662 
1663 	/* VTL panels */
1664 	{ .driver_data = MT_CLS_VTL,
1665 		MT_USB_DEVICE(USB_VENDOR_ID_VTL,
1666 			USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
1667 
1668 	/* Wistron panels */
1669 	{ .driver_data = MT_CLS_NSMU,
1670 		MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
1671 			USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
1672 
1673 	/* XAT */
1674 	{ .driver_data = MT_CLS_NSMU,
1675 		MT_USB_DEVICE(USB_VENDOR_ID_XAT,
1676 			USB_DEVICE_ID_XAT_CSR) },
1677 
1678 	/* Xiroku */
1679 	{ .driver_data = MT_CLS_NSMU,
1680 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1681 			USB_DEVICE_ID_XIROKU_SPX) },
1682 	{ .driver_data = MT_CLS_NSMU,
1683 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1684 			USB_DEVICE_ID_XIROKU_MPX) },
1685 	{ .driver_data = MT_CLS_NSMU,
1686 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1687 			USB_DEVICE_ID_XIROKU_CSR) },
1688 	{ .driver_data = MT_CLS_NSMU,
1689 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1690 			USB_DEVICE_ID_XIROKU_SPX1) },
1691 	{ .driver_data = MT_CLS_NSMU,
1692 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1693 			USB_DEVICE_ID_XIROKU_MPX1) },
1694 	{ .driver_data = MT_CLS_NSMU,
1695 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1696 			USB_DEVICE_ID_XIROKU_CSR1) },
1697 	{ .driver_data = MT_CLS_NSMU,
1698 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1699 			USB_DEVICE_ID_XIROKU_SPX2) },
1700 	{ .driver_data = MT_CLS_NSMU,
1701 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1702 			USB_DEVICE_ID_XIROKU_MPX2) },
1703 	{ .driver_data = MT_CLS_NSMU,
1704 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
1705 			USB_DEVICE_ID_XIROKU_CSR2) },
1706 
1707 	/* Google MT devices */
1708 	{ .driver_data = MT_CLS_GOOGLE,
1709 		HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
1710 			USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
1711 
1712 	/* Generic MT device */
1713 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
1714 
1715 	/* Generic Win 8 certified MT device */
1716 	{  .driver_data = MT_CLS_WIN_8,
1717 		HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
1718 			HID_ANY_ID, HID_ANY_ID) },
1719 	{ }
1720 };
1721 MODULE_DEVICE_TABLE(hid, mt_devices);
1722 
1723 static const struct hid_usage_id mt_grabbed_usages[] = {
1724 	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
1725 	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
1726 };
1727 
1728 static struct hid_driver mt_driver = {
1729 	.name = "hid-multitouch",
1730 	.id_table = mt_devices,
1731 	.probe = mt_probe,
1732 	.remove = mt_remove,
1733 	.input_mapping = mt_input_mapping,
1734 	.input_mapped = mt_input_mapped,
1735 	.input_configured = mt_input_configured,
1736 	.feature_mapping = mt_feature_mapping,
1737 	.usage_table = mt_grabbed_usages,
1738 	.event = mt_event,
1739 	.report = mt_report,
1740 #ifdef CONFIG_PM
1741 	.reset_resume = mt_reset_resume,
1742 	.resume = mt_resume,
1743 #endif
1744 };
1745 module_hid_driver(mt_driver);
1746