xref: /openbmc/linux/drivers/hid/hid-multitouch.c (revision 4ce94eab)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  HID driver for multitouch panels
4  *
5  *  Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
6  *  Copyright (c) 2010-2013 Benjamin Tissoires <benjamin.tissoires@gmail.com>
7  *  Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
8  *  Copyright (c) 2012-2013 Red Hat, Inc
9  *
10  *  This code is partly based on hid-egalax.c:
11  *
12  *  Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
13  *  Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
14  *  Copyright (c) 2010 Canonical, Ltd.
15  *
16  *  This code is partly based on hid-3m-pct.c:
17  *
18  *  Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
19  *  Copyright (c) 2010      Henrik Rydberg <rydberg@euromail.se>
20  *  Copyright (c) 2010      Canonical, Ltd.
21  */
22 
23 /*
24  */
25 
26 /*
27  * This driver is regularly tested thanks to the test suite in hid-tools[1].
28  * Please run these regression tests before patching this module so that
29  * your patch won't break existing known devices.
30  *
31  * [1] https://gitlab.freedesktop.org/libevdev/hid-tools
32  */
33 
34 #include <linux/device.h>
35 #include <linux/hid.h>
36 #include <linux/module.h>
37 #include <linux/slab.h>
38 #include <linux/input/mt.h>
39 #include <linux/jiffies.h>
40 #include <linux/string.h>
41 #include <linux/timer.h>
42 
43 
44 MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
45 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
46 MODULE_DESCRIPTION("HID multitouch panels");
47 MODULE_LICENSE("GPL");
48 
49 #include "hid-ids.h"
50 
51 /* quirks to control the device */
52 #define MT_QUIRK_NOT_SEEN_MEANS_UP	BIT(0)
53 #define MT_QUIRK_SLOT_IS_CONTACTID	BIT(1)
54 #define MT_QUIRK_CYPRESS		BIT(2)
55 #define MT_QUIRK_SLOT_IS_CONTACTNUMBER	BIT(3)
56 #define MT_QUIRK_ALWAYS_VALID		BIT(4)
57 #define MT_QUIRK_VALID_IS_INRANGE	BIT(5)
58 #define MT_QUIRK_VALID_IS_CONFIDENCE	BIT(6)
59 #define MT_QUIRK_CONFIDENCE		BIT(7)
60 #define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE	BIT(8)
61 #define MT_QUIRK_NO_AREA		BIT(9)
62 #define MT_QUIRK_IGNORE_DUPLICATES	BIT(10)
63 #define MT_QUIRK_HOVERING		BIT(11)
64 #define MT_QUIRK_CONTACT_CNT_ACCURATE	BIT(12)
65 #define MT_QUIRK_FORCE_GET_FEATURE	BIT(13)
66 #define MT_QUIRK_FIX_CONST_CONTACT_ID	BIT(14)
67 #define MT_QUIRK_TOUCH_SIZE_SCALING	BIT(15)
68 #define MT_QUIRK_STICKY_FINGERS		BIT(16)
69 #define MT_QUIRK_ASUS_CUSTOM_UP		BIT(17)
70 #define MT_QUIRK_WIN8_PTP_BUTTONS	BIT(18)
71 #define MT_QUIRK_SEPARATE_APP_REPORT	BIT(19)
72 #define MT_QUIRK_FORCE_MULTI_INPUT	BIT(20)
73 
74 #define MT_INPUTMODE_TOUCHSCREEN	0x02
75 #define MT_INPUTMODE_TOUCHPAD		0x03
76 
77 #define MT_BUTTONTYPE_CLICKPAD		0
78 
79 enum latency_mode {
80 	HID_LATENCY_NORMAL = 0,
81 	HID_LATENCY_HIGH = 1,
82 };
83 
84 #define MT_IO_FLAGS_RUNNING		0
85 #define MT_IO_FLAGS_ACTIVE_SLOTS	1
86 #define MT_IO_FLAGS_PENDING_SLOTS	2
87 
88 static const bool mtrue = true;		/* default for true */
89 static const bool mfalse;		/* default for false */
90 static const __s32 mzero;		/* default for 0 */
91 
92 #define DEFAULT_TRUE	((void *)&mtrue)
93 #define DEFAULT_FALSE	((void *)&mfalse)
94 #define DEFAULT_ZERO	((void *)&mzero)
95 
96 struct mt_usages {
97 	struct list_head list;
98 	__s32 *x, *y, *cx, *cy, *p, *w, *h, *a;
99 	__s32 *contactid;	/* the device ContactID assigned to this slot */
100 	bool *tip_state;	/* is the touch valid? */
101 	bool *inrange_state;	/* is the finger in proximity of the sensor? */
102 	bool *confidence_state;	/* is the touch made by a finger? */
103 };
104 
105 struct mt_application {
106 	struct list_head list;
107 	unsigned int application;
108 	unsigned int report_id;
109 	struct list_head mt_usages;	/* mt usages list */
110 
111 	__s32 quirks;
112 
113 	__s32 *scantime;		/* scantime reported */
114 	__s32 scantime_logical_max;	/* max value for raw scantime */
115 
116 	__s32 *raw_cc;			/* contact count in the report */
117 	int left_button_state;		/* left button state */
118 	unsigned int mt_flags;		/* flags to pass to input-mt */
119 
120 	unsigned long *pending_palm_slots;	/* slots where we reported palm
121 						 * and need to release */
122 
123 	__u8 num_received;	/* how many contacts we received */
124 	__u8 num_expected;	/* expected last contact index */
125 	__u8 buttons_count;	/* number of physical buttons per touchpad */
126 	__u8 touches_by_report;	/* how many touches are present in one report:
127 				 * 1 means we should use a serial protocol
128 				 * > 1 means hybrid (multitouch) protocol
129 				 */
130 
131 	__s32 dev_time;		/* the scan time provided by the device */
132 	unsigned long jiffies;	/* the frame's jiffies */
133 	int timestamp;		/* the timestamp to be sent */
134 	int prev_scantime;		/* scantime reported previously */
135 
136 	bool have_contact_count;
137 };
138 
139 struct mt_class {
140 	__s32 name;	/* MT_CLS */
141 	__s32 quirks;
142 	__s32 sn_move;	/* Signal/noise ratio for move events */
143 	__s32 sn_width;	/* Signal/noise ratio for width events */
144 	__s32 sn_height;	/* Signal/noise ratio for height events */
145 	__s32 sn_pressure;	/* Signal/noise ratio for pressure events */
146 	__u8 maxcontacts;
147 	bool is_indirect;	/* true for touchpads */
148 	bool export_all_inputs;	/* do not ignore mouse, keyboards, etc... */
149 };
150 
151 struct mt_report_data {
152 	struct list_head list;
153 	struct hid_report *report;
154 	struct mt_application *application;
155 	bool is_mt_collection;
156 };
157 
158 struct mt_device {
159 	struct mt_class mtclass;	/* our mt device class */
160 	struct timer_list release_timer;	/* to release sticky fingers */
161 	struct hid_device *hdev;	/* hid_device we're attached to */
162 	unsigned long mt_io_flags;	/* mt flags (MT_IO_FLAGS_*) */
163 	__u8 inputmode_value;	/* InputMode HID feature value */
164 	__u8 maxcontacts;
165 	bool is_buttonpad;	/* is this device a button pad? */
166 	bool serial_maybe;	/* need to check for serial protocol */
167 
168 	struct list_head applications;
169 	struct list_head reports;
170 };
171 
172 static void mt_post_parse_default_settings(struct mt_device *td,
173 					   struct mt_application *app);
174 static void mt_post_parse(struct mt_device *td, struct mt_application *app);
175 
176 /* classes of device behavior */
177 #define MT_CLS_DEFAULT				0x0001
178 
179 #define MT_CLS_SERIAL				0x0002
180 #define MT_CLS_CONFIDENCE			0x0003
181 #define MT_CLS_CONFIDENCE_CONTACT_ID		0x0004
182 #define MT_CLS_CONFIDENCE_MINUS_ONE		0x0005
183 #define MT_CLS_DUAL_INRANGE_CONTACTID		0x0006
184 #define MT_CLS_DUAL_INRANGE_CONTACTNUMBER	0x0007
185 /* reserved					0x0008 */
186 #define MT_CLS_INRANGE_CONTACTNUMBER		0x0009
187 #define MT_CLS_NSMU				0x000a
188 /* reserved					0x0010 */
189 /* reserved					0x0011 */
190 #define MT_CLS_WIN_8				0x0012
191 #define MT_CLS_EXPORT_ALL_INPUTS		0x0013
192 /* reserved					0x0014 */
193 #define MT_CLS_WIN_8_FORCE_MULTI_INPUT		0x0015
194 
195 /* vendor specific classes */
196 #define MT_CLS_3M				0x0101
197 /* reserved					0x0102 */
198 #define MT_CLS_EGALAX				0x0103
199 #define MT_CLS_EGALAX_SERIAL			0x0104
200 #define MT_CLS_TOPSEED				0x0105
201 #define MT_CLS_PANASONIC			0x0106
202 #define MT_CLS_FLATFROG				0x0107
203 #define MT_CLS_GENERALTOUCH_TWOFINGERS		0x0108
204 #define MT_CLS_GENERALTOUCH_PWT_TENFINGERS	0x0109
205 #define MT_CLS_LG				0x010a
206 #define MT_CLS_ASUS				0x010b
207 #define MT_CLS_VTL				0x0110
208 #define MT_CLS_GOOGLE				0x0111
209 #define MT_CLS_RAZER_BLADE_STEALTH		0x0112
210 #define MT_CLS_SMART_TECH			0x0113
211 
212 #define MT_DEFAULT_MAXCONTACT	10
213 #define MT_MAX_MAXCONTACT	250
214 
215 /*
216  * Resync device and local timestamps after that many microseconds without
217  * receiving data.
218  */
219 #define MAX_TIMESTAMP_INTERVAL	1000000
220 
221 #define MT_USB_DEVICE(v, p)	HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH, v, p)
222 #define MT_BT_DEVICE(v, p)	HID_DEVICE(BUS_BLUETOOTH, HID_GROUP_MULTITOUCH, v, p)
223 
224 /*
225  * these device-dependent functions determine what slot corresponds
226  * to a valid contact that was just read.
227  */
228 
229 static int cypress_compute_slot(struct mt_application *application,
230 				struct mt_usages *slot)
231 {
232 	if (*slot->contactid != 0 || application->num_received == 0)
233 		return *slot->contactid;
234 	else
235 		return -1;
236 }
237 
238 static const struct mt_class mt_classes[] = {
239 	{ .name = MT_CLS_DEFAULT,
240 		.quirks = MT_QUIRK_ALWAYS_VALID |
241 			MT_QUIRK_CONTACT_CNT_ACCURATE },
242 	{ .name = MT_CLS_NSMU,
243 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
244 	{ .name = MT_CLS_SERIAL,
245 		.quirks = MT_QUIRK_ALWAYS_VALID},
246 	{ .name = MT_CLS_CONFIDENCE,
247 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
248 	{ .name = MT_CLS_CONFIDENCE_CONTACT_ID,
249 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
250 			MT_QUIRK_SLOT_IS_CONTACTID },
251 	{ .name = MT_CLS_CONFIDENCE_MINUS_ONE,
252 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
253 			MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
254 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTID,
255 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
256 			MT_QUIRK_SLOT_IS_CONTACTID,
257 		.maxcontacts = 2 },
258 	{ .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
259 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
260 			MT_QUIRK_SLOT_IS_CONTACTNUMBER,
261 		.maxcontacts = 2 },
262 	{ .name = MT_CLS_INRANGE_CONTACTNUMBER,
263 		.quirks = MT_QUIRK_VALID_IS_INRANGE |
264 			MT_QUIRK_SLOT_IS_CONTACTNUMBER },
265 	{ .name = MT_CLS_WIN_8,
266 		.quirks = MT_QUIRK_ALWAYS_VALID |
267 			MT_QUIRK_IGNORE_DUPLICATES |
268 			MT_QUIRK_HOVERING |
269 			MT_QUIRK_CONTACT_CNT_ACCURATE |
270 			MT_QUIRK_STICKY_FINGERS |
271 			MT_QUIRK_WIN8_PTP_BUTTONS,
272 		.export_all_inputs = true },
273 	{ .name = MT_CLS_EXPORT_ALL_INPUTS,
274 		.quirks = MT_QUIRK_ALWAYS_VALID |
275 			MT_QUIRK_CONTACT_CNT_ACCURATE,
276 		.export_all_inputs = true },
277 	{ .name = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
278 		.quirks = MT_QUIRK_ALWAYS_VALID |
279 			MT_QUIRK_IGNORE_DUPLICATES |
280 			MT_QUIRK_HOVERING |
281 			MT_QUIRK_CONTACT_CNT_ACCURATE |
282 			MT_QUIRK_STICKY_FINGERS |
283 			MT_QUIRK_WIN8_PTP_BUTTONS |
284 			MT_QUIRK_FORCE_MULTI_INPUT,
285 		.export_all_inputs = true },
286 
287 	/*
288 	 * vendor specific classes
289 	 */
290 	{ .name = MT_CLS_3M,
291 		.quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
292 			MT_QUIRK_SLOT_IS_CONTACTID |
293 			MT_QUIRK_TOUCH_SIZE_SCALING,
294 		.sn_move = 2048,
295 		.sn_width = 128,
296 		.sn_height = 128,
297 		.maxcontacts = 60,
298 	},
299 	{ .name = MT_CLS_EGALAX,
300 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
301 			MT_QUIRK_VALID_IS_INRANGE,
302 		.sn_move = 4096,
303 		.sn_pressure = 32,
304 	},
305 	{ .name = MT_CLS_EGALAX_SERIAL,
306 		.quirks =  MT_QUIRK_SLOT_IS_CONTACTID |
307 			MT_QUIRK_ALWAYS_VALID,
308 		.sn_move = 4096,
309 		.sn_pressure = 32,
310 	},
311 	{ .name = MT_CLS_TOPSEED,
312 		.quirks = MT_QUIRK_ALWAYS_VALID,
313 		.is_indirect = true,
314 		.maxcontacts = 2,
315 	},
316 	{ .name = MT_CLS_PANASONIC,
317 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP,
318 		.maxcontacts = 4 },
319 	{ .name	= MT_CLS_GENERALTOUCH_TWOFINGERS,
320 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
321 			MT_QUIRK_VALID_IS_INRANGE |
322 			MT_QUIRK_SLOT_IS_CONTACTID,
323 		.maxcontacts = 2
324 	},
325 	{ .name	= MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
326 		.quirks	= MT_QUIRK_NOT_SEEN_MEANS_UP |
327 			MT_QUIRK_SLOT_IS_CONTACTID
328 	},
329 
330 	{ .name = MT_CLS_FLATFROG,
331 		.quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
332 			MT_QUIRK_NO_AREA,
333 		.sn_move = 2048,
334 		.maxcontacts = 40,
335 	},
336 	{ .name = MT_CLS_LG,
337 		.quirks = MT_QUIRK_ALWAYS_VALID |
338 			MT_QUIRK_FIX_CONST_CONTACT_ID |
339 			MT_QUIRK_IGNORE_DUPLICATES |
340 			MT_QUIRK_HOVERING |
341 			MT_QUIRK_CONTACT_CNT_ACCURATE },
342 	{ .name = MT_CLS_ASUS,
343 		.quirks = MT_QUIRK_ALWAYS_VALID |
344 			MT_QUIRK_CONTACT_CNT_ACCURATE |
345 			MT_QUIRK_ASUS_CUSTOM_UP },
346 	{ .name = MT_CLS_VTL,
347 		.quirks = MT_QUIRK_ALWAYS_VALID |
348 			MT_QUIRK_CONTACT_CNT_ACCURATE |
349 			MT_QUIRK_FORCE_GET_FEATURE,
350 	},
351 	{ .name = MT_CLS_GOOGLE,
352 		.quirks = MT_QUIRK_ALWAYS_VALID |
353 			MT_QUIRK_CONTACT_CNT_ACCURATE |
354 			MT_QUIRK_SLOT_IS_CONTACTID |
355 			MT_QUIRK_HOVERING
356 	},
357 	{ .name = MT_CLS_RAZER_BLADE_STEALTH,
358 		.quirks = MT_QUIRK_ALWAYS_VALID |
359 			MT_QUIRK_IGNORE_DUPLICATES |
360 			MT_QUIRK_HOVERING |
361 			MT_QUIRK_CONTACT_CNT_ACCURATE |
362 			MT_QUIRK_WIN8_PTP_BUTTONS,
363 	},
364 	{ .name = MT_CLS_SMART_TECH,
365 		.quirks = MT_QUIRK_ALWAYS_VALID |
366 			MT_QUIRK_IGNORE_DUPLICATES |
367 			MT_QUIRK_CONTACT_CNT_ACCURATE |
368 			MT_QUIRK_SEPARATE_APP_REPORT,
369 	},
370 	{ }
371 };
372 
373 static ssize_t mt_show_quirks(struct device *dev,
374 			   struct device_attribute *attr,
375 			   char *buf)
376 {
377 	struct hid_device *hdev = to_hid_device(dev);
378 	struct mt_device *td = hid_get_drvdata(hdev);
379 
380 	return sprintf(buf, "%u\n", td->mtclass.quirks);
381 }
382 
383 static ssize_t mt_set_quirks(struct device *dev,
384 			  struct device_attribute *attr,
385 			  const char *buf, size_t count)
386 {
387 	struct hid_device *hdev = to_hid_device(dev);
388 	struct mt_device *td = hid_get_drvdata(hdev);
389 	struct mt_application *application;
390 
391 	unsigned long val;
392 
393 	if (kstrtoul(buf, 0, &val))
394 		return -EINVAL;
395 
396 	td->mtclass.quirks = val;
397 
398 	list_for_each_entry(application, &td->applications, list) {
399 		application->quirks = val;
400 		if (!application->have_contact_count)
401 			application->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
402 	}
403 
404 	return count;
405 }
406 
407 static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
408 
409 static struct attribute *sysfs_attrs[] = {
410 	&dev_attr_quirks.attr,
411 	NULL
412 };
413 
414 static const struct attribute_group mt_attribute_group = {
415 	.attrs = sysfs_attrs
416 };
417 
418 static void mt_get_feature(struct hid_device *hdev, struct hid_report *report)
419 {
420 	int ret;
421 	u32 size = hid_report_len(report);
422 	u8 *buf;
423 
424 	/*
425 	 * Do not fetch the feature report if the device has been explicitly
426 	 * marked as non-capable.
427 	 */
428 	if (hdev->quirks & HID_QUIRK_NO_INIT_REPORTS)
429 		return;
430 
431 	buf = hid_alloc_report_buf(report, GFP_KERNEL);
432 	if (!buf)
433 		return;
434 
435 	ret = hid_hw_raw_request(hdev, report->id, buf, size,
436 				 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
437 	if (ret < 0) {
438 		dev_warn(&hdev->dev, "failed to fetch feature %d\n",
439 			 report->id);
440 	} else {
441 		ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT, buf,
442 					   size, 0);
443 		if (ret)
444 			dev_warn(&hdev->dev, "failed to report feature\n");
445 	}
446 
447 	kfree(buf);
448 }
449 
450 static void mt_feature_mapping(struct hid_device *hdev,
451 		struct hid_field *field, struct hid_usage *usage)
452 {
453 	struct mt_device *td = hid_get_drvdata(hdev);
454 
455 	switch (usage->hid) {
456 	case HID_DG_CONTACTMAX:
457 		mt_get_feature(hdev, field->report);
458 
459 		td->maxcontacts = field->value[0];
460 		if (!td->maxcontacts &&
461 		    field->logical_maximum <= MT_MAX_MAXCONTACT)
462 			td->maxcontacts = field->logical_maximum;
463 		if (td->mtclass.maxcontacts)
464 			/* check if the maxcontacts is given by the class */
465 			td->maxcontacts = td->mtclass.maxcontacts;
466 
467 		break;
468 	case HID_DG_BUTTONTYPE:
469 		if (usage->usage_index >= field->report_count) {
470 			dev_err(&hdev->dev, "HID_DG_BUTTONTYPE out of range\n");
471 			break;
472 		}
473 
474 		mt_get_feature(hdev, field->report);
475 		if (field->value[usage->usage_index] == MT_BUTTONTYPE_CLICKPAD)
476 			td->is_buttonpad = true;
477 
478 		break;
479 	case 0xff0000c5:
480 		/* Retrieve the Win8 blob once to enable some devices */
481 		if (usage->usage_index == 0)
482 			mt_get_feature(hdev, field->report);
483 		break;
484 	}
485 }
486 
487 static void set_abs(struct input_dev *input, unsigned int code,
488 		struct hid_field *field, int snratio)
489 {
490 	int fmin = field->logical_minimum;
491 	int fmax = field->logical_maximum;
492 	int fuzz = snratio ? (fmax - fmin) / snratio : 0;
493 	input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
494 	input_abs_set_res(input, code, hidinput_calc_abs_res(field, code));
495 }
496 
497 static struct mt_usages *mt_allocate_usage(struct hid_device *hdev,
498 					   struct mt_application *application)
499 {
500 	struct mt_usages *usage;
501 
502 	usage = devm_kzalloc(&hdev->dev, sizeof(*usage), GFP_KERNEL);
503 	if (!usage)
504 		return NULL;
505 
506 	/* set some defaults so we do not need to check for null pointers */
507 	usage->x = DEFAULT_ZERO;
508 	usage->y = DEFAULT_ZERO;
509 	usage->cx = DEFAULT_ZERO;
510 	usage->cy = DEFAULT_ZERO;
511 	usage->p = DEFAULT_ZERO;
512 	usage->w = DEFAULT_ZERO;
513 	usage->h = DEFAULT_ZERO;
514 	usage->a = DEFAULT_ZERO;
515 	usage->contactid = DEFAULT_ZERO;
516 	usage->tip_state = DEFAULT_FALSE;
517 	usage->inrange_state = DEFAULT_FALSE;
518 	usage->confidence_state = DEFAULT_TRUE;
519 
520 	list_add_tail(&usage->list, &application->mt_usages);
521 
522 	return usage;
523 }
524 
525 static struct mt_application *mt_allocate_application(struct mt_device *td,
526 						      struct hid_report *report)
527 {
528 	unsigned int application = report->application;
529 	struct mt_application *mt_application;
530 
531 	mt_application = devm_kzalloc(&td->hdev->dev, sizeof(*mt_application),
532 				      GFP_KERNEL);
533 	if (!mt_application)
534 		return NULL;
535 
536 	mt_application->application = application;
537 	INIT_LIST_HEAD(&mt_application->mt_usages);
538 
539 	if (application == HID_DG_TOUCHSCREEN)
540 		mt_application->mt_flags |= INPUT_MT_DIRECT;
541 
542 	/*
543 	 * Model touchscreens providing buttons as touchpads.
544 	 */
545 	if (application == HID_DG_TOUCHPAD) {
546 		mt_application->mt_flags |= INPUT_MT_POINTER;
547 		td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
548 	}
549 
550 	mt_application->scantime = DEFAULT_ZERO;
551 	mt_application->raw_cc = DEFAULT_ZERO;
552 	mt_application->quirks = td->mtclass.quirks;
553 	mt_application->report_id = report->id;
554 
555 	list_add_tail(&mt_application->list, &td->applications);
556 
557 	return mt_application;
558 }
559 
560 static struct mt_application *mt_find_application(struct mt_device *td,
561 						  struct hid_report *report)
562 {
563 	unsigned int application = report->application;
564 	struct mt_application *tmp, *mt_application = NULL;
565 
566 	list_for_each_entry(tmp, &td->applications, list) {
567 		if (application == tmp->application) {
568 			if (!(td->mtclass.quirks & MT_QUIRK_SEPARATE_APP_REPORT) ||
569 			    tmp->report_id == report->id) {
570 				mt_application = tmp;
571 				break;
572 			}
573 		}
574 	}
575 
576 	if (!mt_application)
577 		mt_application = mt_allocate_application(td, report);
578 
579 	return mt_application;
580 }
581 
582 static struct mt_report_data *mt_allocate_report_data(struct mt_device *td,
583 						      struct hid_report *report)
584 {
585 	struct mt_report_data *rdata;
586 	struct hid_field *field;
587 	int r, n;
588 
589 	rdata = devm_kzalloc(&td->hdev->dev, sizeof(*rdata), GFP_KERNEL);
590 	if (!rdata)
591 		return NULL;
592 
593 	rdata->report = report;
594 	rdata->application = mt_find_application(td, report);
595 
596 	if (!rdata->application) {
597 		devm_kfree(&td->hdev->dev, rdata);
598 		return NULL;
599 	}
600 
601 	for (r = 0; r < report->maxfield; r++) {
602 		field = report->field[r];
603 
604 		if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
605 			continue;
606 
607 		for (n = 0; n < field->report_count; n++) {
608 			if (field->usage[n].hid == HID_DG_CONTACTID)
609 				rdata->is_mt_collection = true;
610 		}
611 	}
612 
613 	list_add_tail(&rdata->list, &td->reports);
614 
615 	return rdata;
616 }
617 
618 static struct mt_report_data *mt_find_report_data(struct mt_device *td,
619 						  struct hid_report *report)
620 {
621 	struct mt_report_data *tmp, *rdata = NULL;
622 
623 	list_for_each_entry(tmp, &td->reports, list) {
624 		if (report == tmp->report) {
625 			rdata = tmp;
626 			break;
627 		}
628 	}
629 
630 	if (!rdata)
631 		rdata = mt_allocate_report_data(td, report);
632 
633 	return rdata;
634 }
635 
636 static void mt_store_field(struct hid_device *hdev,
637 			   struct mt_application *application,
638 			   __s32 *value,
639 			   size_t offset)
640 {
641 	struct mt_usages *usage;
642 	__s32 **target;
643 
644 	if (list_empty(&application->mt_usages))
645 		usage = mt_allocate_usage(hdev, application);
646 	else
647 		usage = list_last_entry(&application->mt_usages,
648 					struct mt_usages,
649 					list);
650 
651 	if (!usage)
652 		return;
653 
654 	target = (__s32 **)((char *)usage + offset);
655 
656 	/* the value has already been filled, create a new slot */
657 	if (*target != DEFAULT_TRUE &&
658 	    *target != DEFAULT_FALSE &&
659 	    *target != DEFAULT_ZERO) {
660 		if (usage->contactid == DEFAULT_ZERO ||
661 		    usage->x == DEFAULT_ZERO ||
662 		    usage->y == DEFAULT_ZERO) {
663 			hid_dbg(hdev,
664 				"ignoring duplicate usage on incomplete");
665 			return;
666 		}
667 		usage = mt_allocate_usage(hdev, application);
668 		if (!usage)
669 			return;
670 
671 		target = (__s32 **)((char *)usage + offset);
672 	}
673 
674 	*target = value;
675 }
676 
677 #define MT_STORE_FIELD(__name)						\
678 	mt_store_field(hdev, app,					\
679 		       &field->value[usage->usage_index],		\
680 		       offsetof(struct mt_usages, __name))
681 
682 static int mt_touch_input_mapping(struct hid_device *hdev, struct hid_input *hi,
683 		struct hid_field *field, struct hid_usage *usage,
684 		unsigned long **bit, int *max, struct mt_application *app)
685 {
686 	struct mt_device *td = hid_get_drvdata(hdev);
687 	struct mt_class *cls = &td->mtclass;
688 	int code;
689 	struct hid_usage *prev_usage = NULL;
690 
691 	/*
692 	 * Model touchscreens providing buttons as touchpads.
693 	 */
694 	if (field->application == HID_DG_TOUCHSCREEN &&
695 	    (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON) {
696 		app->mt_flags |= INPUT_MT_POINTER;
697 		td->inputmode_value = MT_INPUTMODE_TOUCHPAD;
698 	}
699 
700 	/* count the buttons on touchpads */
701 	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON)
702 		app->buttons_count++;
703 
704 	if (usage->usage_index)
705 		prev_usage = &field->usage[usage->usage_index - 1];
706 
707 	switch (usage->hid & HID_USAGE_PAGE) {
708 
709 	case HID_UP_GENDESK:
710 		switch (usage->hid) {
711 		case HID_GD_X:
712 			if (prev_usage && (prev_usage->hid == usage->hid)) {
713 				code = ABS_MT_TOOL_X;
714 				MT_STORE_FIELD(cx);
715 			} else {
716 				code = ABS_MT_POSITION_X;
717 				MT_STORE_FIELD(x);
718 			}
719 
720 			set_abs(hi->input, code, field, cls->sn_move);
721 
722 			/*
723 			 * A system multi-axis that exports X and Y has a high
724 			 * chance of being used directly on a surface
725 			 */
726 			if (field->application == HID_GD_SYSTEM_MULTIAXIS) {
727 				__set_bit(INPUT_PROP_DIRECT,
728 					  hi->input->propbit);
729 				input_set_abs_params(hi->input,
730 						     ABS_MT_TOOL_TYPE,
731 						     MT_TOOL_DIAL,
732 						     MT_TOOL_DIAL, 0, 0);
733 			}
734 
735 			return 1;
736 		case HID_GD_Y:
737 			if (prev_usage && (prev_usage->hid == usage->hid)) {
738 				code = ABS_MT_TOOL_Y;
739 				MT_STORE_FIELD(cy);
740 			} else {
741 				code = ABS_MT_POSITION_Y;
742 				MT_STORE_FIELD(y);
743 			}
744 
745 			set_abs(hi->input, code, field, cls->sn_move);
746 
747 			return 1;
748 		}
749 		return 0;
750 
751 	case HID_UP_DIGITIZER:
752 		switch (usage->hid) {
753 		case HID_DG_INRANGE:
754 			if (app->quirks & MT_QUIRK_HOVERING) {
755 				input_set_abs_params(hi->input,
756 					ABS_MT_DISTANCE, 0, 1, 0, 0);
757 			}
758 			MT_STORE_FIELD(inrange_state);
759 			return 1;
760 		case HID_DG_CONFIDENCE:
761 			if ((cls->name == MT_CLS_WIN_8 ||
762 			     cls->name == MT_CLS_WIN_8_FORCE_MULTI_INPUT) &&
763 				(field->application == HID_DG_TOUCHPAD ||
764 				 field->application == HID_DG_TOUCHSCREEN))
765 				app->quirks |= MT_QUIRK_CONFIDENCE;
766 
767 			if (app->quirks & MT_QUIRK_CONFIDENCE)
768 				input_set_abs_params(hi->input,
769 						     ABS_MT_TOOL_TYPE,
770 						     MT_TOOL_FINGER,
771 						     MT_TOOL_PALM, 0, 0);
772 
773 			MT_STORE_FIELD(confidence_state);
774 			return 1;
775 		case HID_DG_TIPSWITCH:
776 			if (field->application != HID_GD_SYSTEM_MULTIAXIS)
777 				input_set_capability(hi->input,
778 						     EV_KEY, BTN_TOUCH);
779 			MT_STORE_FIELD(tip_state);
780 			return 1;
781 		case HID_DG_CONTACTID:
782 			MT_STORE_FIELD(contactid);
783 			app->touches_by_report++;
784 			return 1;
785 		case HID_DG_WIDTH:
786 			if (!(app->quirks & MT_QUIRK_NO_AREA))
787 				set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
788 					cls->sn_width);
789 			MT_STORE_FIELD(w);
790 			return 1;
791 		case HID_DG_HEIGHT:
792 			if (!(app->quirks & MT_QUIRK_NO_AREA)) {
793 				set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
794 					cls->sn_height);
795 
796 				/*
797 				 * Only set ABS_MT_ORIENTATION if it is not
798 				 * already set by the HID_DG_AZIMUTH usage.
799 				 */
800 				if (!test_bit(ABS_MT_ORIENTATION,
801 						hi->input->absbit))
802 					input_set_abs_params(hi->input,
803 						ABS_MT_ORIENTATION, 0, 1, 0, 0);
804 			}
805 			MT_STORE_FIELD(h);
806 			return 1;
807 		case HID_DG_TIPPRESSURE:
808 			set_abs(hi->input, ABS_MT_PRESSURE, field,
809 				cls->sn_pressure);
810 			MT_STORE_FIELD(p);
811 			return 1;
812 		case HID_DG_SCANTIME:
813 			input_set_capability(hi->input, EV_MSC, MSC_TIMESTAMP);
814 			app->scantime = &field->value[usage->usage_index];
815 			app->scantime_logical_max = field->logical_maximum;
816 			return 1;
817 		case HID_DG_CONTACTCOUNT:
818 			app->have_contact_count = true;
819 			app->raw_cc = &field->value[usage->usage_index];
820 			return 1;
821 		case HID_DG_AZIMUTH:
822 			/*
823 			 * Azimuth has the range of [0, MAX) representing a full
824 			 * revolution. Set ABS_MT_ORIENTATION to a quarter of
825 			 * MAX according the definition of ABS_MT_ORIENTATION
826 			 */
827 			input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
828 				-field->logical_maximum / 4,
829 				field->logical_maximum / 4,
830 				cls->sn_move ?
831 				field->logical_maximum / cls->sn_move : 0, 0);
832 			MT_STORE_FIELD(a);
833 			return 1;
834 		case HID_DG_CONTACTMAX:
835 			/* contact max are global to the report */
836 			return -1;
837 		case HID_DG_TOUCH:
838 			/* Legacy devices use TIPSWITCH and not TOUCH.
839 			 * Let's just ignore this field. */
840 			return -1;
841 		}
842 		/* let hid-input decide for the others */
843 		return 0;
844 
845 	case HID_UP_BUTTON:
846 		code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
847 		/*
848 		 * MS PTP spec says that external buttons left and right have
849 		 * usages 2 and 3.
850 		 */
851 		if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
852 		    field->application == HID_DG_TOUCHPAD &&
853 		    (usage->hid & HID_USAGE) > 1)
854 			code--;
855 
856 		if (field->application == HID_GD_SYSTEM_MULTIAXIS)
857 			code = BTN_0  + ((usage->hid - 1) & HID_USAGE);
858 
859 		hid_map_usage(hi, usage, bit, max, EV_KEY, code);
860 		if (!*bit)
861 			return -1;
862 		input_set_capability(hi->input, EV_KEY, code);
863 		return 1;
864 
865 	case 0xff000000:
866 		/* we do not want to map these: no input-oriented meaning */
867 		return -1;
868 	}
869 
870 	return 0;
871 }
872 
873 static int mt_compute_slot(struct mt_device *td, struct mt_application *app,
874 			   struct mt_usages *slot,
875 			   struct input_dev *input)
876 {
877 	__s32 quirks = app->quirks;
878 
879 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
880 		return *slot->contactid;
881 
882 	if (quirks & MT_QUIRK_CYPRESS)
883 		return cypress_compute_slot(app, slot);
884 
885 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
886 		return app->num_received;
887 
888 	if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
889 		return *slot->contactid - 1;
890 
891 	return input_mt_get_slot_by_key(input, *slot->contactid);
892 }
893 
894 static void mt_release_pending_palms(struct mt_device *td,
895 				     struct mt_application *app,
896 				     struct input_dev *input)
897 {
898 	int slotnum;
899 	bool need_sync = false;
900 
901 	for_each_set_bit(slotnum, app->pending_palm_slots, td->maxcontacts) {
902 		clear_bit(slotnum, app->pending_palm_slots);
903 
904 		input_mt_slot(input, slotnum);
905 		input_mt_report_slot_inactive(input);
906 
907 		need_sync = true;
908 	}
909 
910 	if (need_sync) {
911 		input_mt_sync_frame(input);
912 		input_sync(input);
913 	}
914 }
915 
916 /*
917  * this function is called when a whole packet has been received and processed,
918  * so that it can decide what to send to the input layer.
919  */
920 static void mt_sync_frame(struct mt_device *td, struct mt_application *app,
921 			  struct input_dev *input)
922 {
923 	if (app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS)
924 		input_event(input, EV_KEY, BTN_LEFT, app->left_button_state);
925 
926 	input_mt_sync_frame(input);
927 	input_event(input, EV_MSC, MSC_TIMESTAMP, app->timestamp);
928 	input_sync(input);
929 
930 	mt_release_pending_palms(td, app, input);
931 
932 	app->num_received = 0;
933 	app->left_button_state = 0;
934 
935 	if (test_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags))
936 		set_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
937 	else
938 		clear_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags);
939 	clear_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
940 }
941 
942 static int mt_compute_timestamp(struct mt_application *app, __s32 value)
943 {
944 	long delta = value - app->prev_scantime;
945 	unsigned long jdelta = jiffies_to_usecs(jiffies - app->jiffies);
946 
947 	app->jiffies = jiffies;
948 
949 	if (delta < 0)
950 		delta += app->scantime_logical_max;
951 
952 	/* HID_DG_SCANTIME is expressed in 100us, we want it in us. */
953 	delta *= 100;
954 
955 	if (jdelta > MAX_TIMESTAMP_INTERVAL)
956 		/* No data received for a while, resync the timestamp. */
957 		return 0;
958 	else
959 		return app->timestamp + delta;
960 }
961 
962 static int mt_touch_event(struct hid_device *hid, struct hid_field *field,
963 				struct hid_usage *usage, __s32 value)
964 {
965 	/* we will handle the hidinput part later, now remains hiddev */
966 	if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
967 		hid->hiddev_hid_event(hid, field, usage, value);
968 
969 	return 1;
970 }
971 
972 static int mt_process_slot(struct mt_device *td, struct input_dev *input,
973 			    struct mt_application *app,
974 			    struct mt_usages *slot)
975 {
976 	struct input_mt *mt = input->mt;
977 	__s32 quirks = app->quirks;
978 	bool valid = true;
979 	bool confidence_state = true;
980 	bool inrange_state = false;
981 	int active;
982 	int slotnum;
983 	int tool = MT_TOOL_FINGER;
984 
985 	if (!slot)
986 		return -EINVAL;
987 
988 	if ((quirks & MT_QUIRK_CONTACT_CNT_ACCURATE) &&
989 	    app->num_received >= app->num_expected)
990 		return -EAGAIN;
991 
992 	if (!(quirks & MT_QUIRK_ALWAYS_VALID)) {
993 		if (quirks & MT_QUIRK_VALID_IS_INRANGE)
994 			valid = *slot->inrange_state;
995 		if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
996 			valid = *slot->tip_state;
997 		if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
998 			valid = *slot->confidence_state;
999 
1000 		if (!valid)
1001 			return 0;
1002 	}
1003 
1004 	slotnum = mt_compute_slot(td, app, slot, input);
1005 	if (slotnum < 0 || slotnum >= td->maxcontacts)
1006 		return 0;
1007 
1008 	if ((quirks & MT_QUIRK_IGNORE_DUPLICATES) && mt) {
1009 		struct input_mt_slot *i_slot = &mt->slots[slotnum];
1010 
1011 		if (input_mt_is_active(i_slot) &&
1012 		    input_mt_is_used(mt, i_slot))
1013 			return -EAGAIN;
1014 	}
1015 
1016 	if (quirks & MT_QUIRK_CONFIDENCE)
1017 		confidence_state = *slot->confidence_state;
1018 
1019 	if (quirks & MT_QUIRK_HOVERING)
1020 		inrange_state = *slot->inrange_state;
1021 
1022 	active = *slot->tip_state || inrange_state;
1023 
1024 	if (app->application == HID_GD_SYSTEM_MULTIAXIS)
1025 		tool = MT_TOOL_DIAL;
1026 	else if (unlikely(!confidence_state)) {
1027 		tool = MT_TOOL_PALM;
1028 		if (!active && mt &&
1029 		    input_mt_is_active(&mt->slots[slotnum])) {
1030 			/*
1031 			 * The non-confidence was reported for
1032 			 * previously valid contact that is also no
1033 			 * longer valid. We can't simply report
1034 			 * lift-off as userspace will not be aware
1035 			 * of non-confidence, so we need to split
1036 			 * it into 2 events: active MT_TOOL_PALM
1037 			 * and a separate liftoff.
1038 			 */
1039 			active = true;
1040 			set_bit(slotnum, app->pending_palm_slots);
1041 		}
1042 	}
1043 
1044 	input_mt_slot(input, slotnum);
1045 	input_mt_report_slot_state(input, tool, active);
1046 	if (active) {
1047 		/* this finger is in proximity of the sensor */
1048 		int wide = (*slot->w > *slot->h);
1049 		int major = max(*slot->w, *slot->h);
1050 		int minor = min(*slot->w, *slot->h);
1051 		int orientation = wide;
1052 		int max_azimuth;
1053 		int azimuth;
1054 
1055 		if (slot->a != DEFAULT_ZERO) {
1056 			/*
1057 			 * Azimuth is counter-clockwise and ranges from [0, MAX)
1058 			 * (a full revolution). Convert it to clockwise ranging
1059 			 * [-MAX/2, MAX/2].
1060 			 *
1061 			 * Note that ABS_MT_ORIENTATION require us to report
1062 			 * the limit of [-MAX/4, MAX/4], but the value can go
1063 			 * out of range to [-MAX/2, MAX/2] to report an upside
1064 			 * down ellipsis.
1065 			 */
1066 			azimuth = *slot->a;
1067 			max_azimuth = input_abs_get_max(input,
1068 							ABS_MT_ORIENTATION);
1069 			if (azimuth > max_azimuth * 2)
1070 				azimuth -= max_azimuth * 4;
1071 			orientation = -azimuth;
1072 		}
1073 
1074 		if (quirks & MT_QUIRK_TOUCH_SIZE_SCALING) {
1075 			/*
1076 			 * divided by two to match visual scale of touch
1077 			 * for devices with this quirk
1078 			 */
1079 			major = major >> 1;
1080 			minor = minor >> 1;
1081 		}
1082 
1083 		input_event(input, EV_ABS, ABS_MT_POSITION_X, *slot->x);
1084 		input_event(input, EV_ABS, ABS_MT_POSITION_Y, *slot->y);
1085 		input_event(input, EV_ABS, ABS_MT_TOOL_X, *slot->cx);
1086 		input_event(input, EV_ABS, ABS_MT_TOOL_Y, *slot->cy);
1087 		input_event(input, EV_ABS, ABS_MT_DISTANCE, !*slot->tip_state);
1088 		input_event(input, EV_ABS, ABS_MT_ORIENTATION, orientation);
1089 		input_event(input, EV_ABS, ABS_MT_PRESSURE, *slot->p);
1090 		input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
1091 		input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
1092 
1093 		set_bit(MT_IO_FLAGS_ACTIVE_SLOTS, &td->mt_io_flags);
1094 	}
1095 
1096 	return 0;
1097 }
1098 
1099 static void mt_process_mt_event(struct hid_device *hid,
1100 				struct mt_application *app,
1101 				struct hid_field *field,
1102 				struct hid_usage *usage,
1103 				__s32 value,
1104 				bool first_packet)
1105 {
1106 	__s32 quirks = app->quirks;
1107 	struct input_dev *input = field->hidinput->input;
1108 
1109 	if (!usage->type || !(hid->claimed & HID_CLAIMED_INPUT))
1110 		return;
1111 
1112 	if (quirks & MT_QUIRK_WIN8_PTP_BUTTONS) {
1113 
1114 		/*
1115 		 * For Win8 PTP touchpads we should only look at
1116 		 * non finger/touch events in the first_packet of a
1117 		 * (possible) multi-packet frame.
1118 		 */
1119 		if (!first_packet)
1120 			return;
1121 
1122 		/*
1123 		 * For Win8 PTP touchpads we map both the clickpad click
1124 		 * and any "external" left buttons to BTN_LEFT if a
1125 		 * device claims to have both we need to report 1 for
1126 		 * BTN_LEFT if either is pressed, so we or all values
1127 		 * together and report the result in mt_sync_frame().
1128 		 */
1129 		if (usage->type == EV_KEY && usage->code == BTN_LEFT) {
1130 			app->left_button_state |= value;
1131 			return;
1132 		}
1133 	}
1134 
1135 	input_event(input, usage->type, usage->code, value);
1136 }
1137 
1138 static void mt_touch_report(struct hid_device *hid,
1139 			    struct mt_report_data *rdata)
1140 {
1141 	struct mt_device *td = hid_get_drvdata(hid);
1142 	struct hid_report *report = rdata->report;
1143 	struct mt_application *app = rdata->application;
1144 	struct hid_field *field;
1145 	struct input_dev *input;
1146 	struct mt_usages *slot;
1147 	bool first_packet;
1148 	unsigned count;
1149 	int r, n;
1150 	int scantime = 0;
1151 	int contact_count = -1;
1152 
1153 	/* sticky fingers release in progress, abort */
1154 	if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1155 		return;
1156 
1157 	scantime = *app->scantime;
1158 	app->timestamp = mt_compute_timestamp(app, scantime);
1159 	if (app->raw_cc != DEFAULT_ZERO)
1160 		contact_count = *app->raw_cc;
1161 
1162 	/*
1163 	 * Includes multi-packet support where subsequent
1164 	 * packets are sent with zero contactcount.
1165 	 */
1166 	if (contact_count >= 0) {
1167 		/*
1168 		 * For Win8 PTPs the first packet (td->num_received == 0) may
1169 		 * have a contactcount of 0 if there only is a button event.
1170 		 * We double check that this is not a continuation packet
1171 		 * of a possible multi-packet frame be checking that the
1172 		 * timestamp has changed.
1173 		 */
1174 		if ((app->quirks & MT_QUIRK_WIN8_PTP_BUTTONS) &&
1175 		    app->num_received == 0 &&
1176 		    app->prev_scantime != scantime)
1177 			app->num_expected = contact_count;
1178 		/* A non 0 contact count always indicates a first packet */
1179 		else if (contact_count)
1180 			app->num_expected = contact_count;
1181 	}
1182 	app->prev_scantime = scantime;
1183 
1184 	first_packet = app->num_received == 0;
1185 
1186 	input = report->field[0]->hidinput->input;
1187 
1188 	list_for_each_entry(slot, &app->mt_usages, list) {
1189 		if (!mt_process_slot(td, input, app, slot))
1190 			app->num_received++;
1191 	}
1192 
1193 	for (r = 0; r < report->maxfield; r++) {
1194 		field = report->field[r];
1195 		count = field->report_count;
1196 
1197 		if (!(HID_MAIN_ITEM_VARIABLE & field->flags))
1198 			continue;
1199 
1200 		for (n = 0; n < count; n++)
1201 			mt_process_mt_event(hid, app, field,
1202 					    &field->usage[n], field->value[n],
1203 					    first_packet);
1204 	}
1205 
1206 	if (app->num_received >= app->num_expected)
1207 		mt_sync_frame(td, app, input);
1208 
1209 	/*
1210 	 * Windows 8 specs says 2 things:
1211 	 * - once a contact has been reported, it has to be reported in each
1212 	 *   subsequent report
1213 	 * - the report rate when fingers are present has to be at least
1214 	 *   the refresh rate of the screen, 60 or 120 Hz
1215 	 *
1216 	 * I interprete this that the specification forces a report rate of
1217 	 * at least 60 Hz for a touchscreen to be certified.
1218 	 * Which means that if we do not get a report whithin 16 ms, either
1219 	 * something wrong happens, either the touchscreen forgets to send
1220 	 * a release. Taking a reasonable margin allows to remove issues
1221 	 * with USB communication or the load of the machine.
1222 	 *
1223 	 * Given that Win 8 devices are forced to send a release, this will
1224 	 * only affect laggish machines and the ones that have a firmware
1225 	 * defect.
1226 	 */
1227 	if (app->quirks & MT_QUIRK_STICKY_FINGERS) {
1228 		if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1229 			mod_timer(&td->release_timer,
1230 				  jiffies + msecs_to_jiffies(100));
1231 		else
1232 			del_timer(&td->release_timer);
1233 	}
1234 
1235 	clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1236 }
1237 
1238 static int mt_touch_input_configured(struct hid_device *hdev,
1239 				     struct hid_input *hi,
1240 				     struct mt_application *app)
1241 {
1242 	struct mt_device *td = hid_get_drvdata(hdev);
1243 	struct mt_class *cls = &td->mtclass;
1244 	struct input_dev *input = hi->input;
1245 	int ret;
1246 
1247 	if (!td->maxcontacts)
1248 		td->maxcontacts = MT_DEFAULT_MAXCONTACT;
1249 
1250 	mt_post_parse(td, app);
1251 	if (td->serial_maybe)
1252 		mt_post_parse_default_settings(td, app);
1253 
1254 	if (cls->is_indirect)
1255 		app->mt_flags |= INPUT_MT_POINTER;
1256 
1257 	if (app->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
1258 		app->mt_flags |= INPUT_MT_DROP_UNUSED;
1259 
1260 	/* check for clickpads */
1261 	if ((app->mt_flags & INPUT_MT_POINTER) &&
1262 	    (app->buttons_count == 1))
1263 		td->is_buttonpad = true;
1264 
1265 	if (td->is_buttonpad)
1266 		__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1267 
1268 	app->pending_palm_slots = devm_kcalloc(&hi->input->dev,
1269 					       BITS_TO_LONGS(td->maxcontacts),
1270 					       sizeof(long),
1271 					       GFP_KERNEL);
1272 	if (!app->pending_palm_slots)
1273 		return -ENOMEM;
1274 
1275 	ret = input_mt_init_slots(input, td->maxcontacts, app->mt_flags);
1276 	if (ret)
1277 		return ret;
1278 
1279 	app->mt_flags = 0;
1280 	return 0;
1281 }
1282 
1283 #define mt_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, \
1284 						    max, EV_KEY, (c))
1285 static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
1286 		struct hid_field *field, struct hid_usage *usage,
1287 		unsigned long **bit, int *max)
1288 {
1289 	struct mt_device *td = hid_get_drvdata(hdev);
1290 	struct mt_application *application;
1291 	struct mt_report_data *rdata;
1292 
1293 	rdata = mt_find_report_data(td, field->report);
1294 	if (!rdata) {
1295 		hid_err(hdev, "failed to allocate data for report\n");
1296 		return 0;
1297 	}
1298 
1299 	application = rdata->application;
1300 
1301 	/*
1302 	 * If mtclass.export_all_inputs is not set, only map fields from
1303 	 * TouchScreen or TouchPad collections. We need to ignore fields
1304 	 * that belong to other collections such as Mouse that might have
1305 	 * the same GenericDesktop usages.
1306 	 */
1307 	if (!td->mtclass.export_all_inputs &&
1308 	    field->application != HID_DG_TOUCHSCREEN &&
1309 	    field->application != HID_DG_PEN &&
1310 	    field->application != HID_DG_TOUCHPAD &&
1311 	    field->application != HID_GD_KEYBOARD &&
1312 	    field->application != HID_GD_SYSTEM_CONTROL &&
1313 	    field->application != HID_CP_CONSUMER_CONTROL &&
1314 	    field->application != HID_GD_WIRELESS_RADIO_CTLS &&
1315 	    field->application != HID_GD_SYSTEM_MULTIAXIS &&
1316 	    !(field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1317 	      application->quirks & MT_QUIRK_ASUS_CUSTOM_UP))
1318 		return -1;
1319 
1320 	/*
1321 	 * Some Asus keyboard+touchpad devices have the hotkeys defined in the
1322 	 * touchpad report descriptor. We need to treat these as an array to
1323 	 * map usages to input keys.
1324 	 */
1325 	if (field->application == HID_VD_ASUS_CUSTOM_MEDIA_KEYS &&
1326 	    application->quirks & MT_QUIRK_ASUS_CUSTOM_UP &&
1327 	    (usage->hid & HID_USAGE_PAGE) == HID_UP_CUSTOM) {
1328 		set_bit(EV_REP, hi->input->evbit);
1329 		if (field->flags & HID_MAIN_ITEM_VARIABLE)
1330 			field->flags &= ~HID_MAIN_ITEM_VARIABLE;
1331 		switch (usage->hid & HID_USAGE) {
1332 		case 0x10: mt_map_key_clear(KEY_BRIGHTNESSDOWN);	break;
1333 		case 0x20: mt_map_key_clear(KEY_BRIGHTNESSUP);		break;
1334 		case 0x35: mt_map_key_clear(KEY_DISPLAY_OFF);		break;
1335 		case 0x6b: mt_map_key_clear(KEY_F21);			break;
1336 		case 0x6c: mt_map_key_clear(KEY_SLEEP);			break;
1337 		default:
1338 			return -1;
1339 		}
1340 		return 1;
1341 	}
1342 
1343 	if (rdata->is_mt_collection)
1344 		return mt_touch_input_mapping(hdev, hi, field, usage, bit, max,
1345 					      application);
1346 
1347 	/*
1348 	 * some egalax touchscreens have "application == DG_TOUCHSCREEN"
1349 	 * for the stylus. Overwrite the hid_input application
1350 	 */
1351 	if (field->physical == HID_DG_STYLUS)
1352 		hi->application = HID_DG_STYLUS;
1353 
1354 	/* let hid-core decide for the others */
1355 	return 0;
1356 }
1357 
1358 static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
1359 		struct hid_field *field, struct hid_usage *usage,
1360 		unsigned long **bit, int *max)
1361 {
1362 	struct mt_device *td = hid_get_drvdata(hdev);
1363 	struct mt_report_data *rdata;
1364 
1365 	rdata = mt_find_report_data(td, field->report);
1366 	if (rdata && rdata->is_mt_collection) {
1367 		/* We own these mappings, tell hid-input to ignore them */
1368 		return -1;
1369 	}
1370 
1371 	/* let hid-core decide for the others */
1372 	return 0;
1373 }
1374 
1375 static int mt_event(struct hid_device *hid, struct hid_field *field,
1376 				struct hid_usage *usage, __s32 value)
1377 {
1378 	struct mt_device *td = hid_get_drvdata(hid);
1379 	struct mt_report_data *rdata;
1380 
1381 	rdata = mt_find_report_data(td, field->report);
1382 	if (rdata && rdata->is_mt_collection)
1383 		return mt_touch_event(hid, field, usage, value);
1384 
1385 	return 0;
1386 }
1387 
1388 static void mt_report(struct hid_device *hid, struct hid_report *report)
1389 {
1390 	struct mt_device *td = hid_get_drvdata(hid);
1391 	struct hid_field *field = report->field[0];
1392 	struct mt_report_data *rdata;
1393 
1394 	if (!(hid->claimed & HID_CLAIMED_INPUT))
1395 		return;
1396 
1397 	rdata = mt_find_report_data(td, report);
1398 	if (rdata && rdata->is_mt_collection)
1399 		return mt_touch_report(hid, rdata);
1400 
1401 	if (field && field->hidinput && field->hidinput->input)
1402 		input_sync(field->hidinput->input);
1403 }
1404 
1405 static bool mt_need_to_apply_feature(struct hid_device *hdev,
1406 				     struct hid_field *field,
1407 				     struct hid_usage *usage,
1408 				     enum latency_mode latency,
1409 				     bool surface_switch,
1410 				     bool button_switch,
1411 				     bool *inputmode_found)
1412 {
1413 	struct mt_device *td = hid_get_drvdata(hdev);
1414 	struct mt_class *cls = &td->mtclass;
1415 	struct hid_report *report = field->report;
1416 	unsigned int index = usage->usage_index;
1417 	char *buf;
1418 	u32 report_len;
1419 	int max;
1420 
1421 	switch (usage->hid) {
1422 	case HID_DG_INPUTMODE:
1423 		/*
1424 		 * Some elan panels wrongly declare 2 input mode features,
1425 		 * and silently ignore when we set the value in the second
1426 		 * field. Skip the second feature and hope for the best.
1427 		 */
1428 		if (*inputmode_found)
1429 			return false;
1430 
1431 		if (cls->quirks & MT_QUIRK_FORCE_GET_FEATURE) {
1432 			report_len = hid_report_len(report);
1433 			buf = hid_alloc_report_buf(report, GFP_KERNEL);
1434 			if (!buf) {
1435 				hid_err(hdev,
1436 					"failed to allocate buffer for report\n");
1437 				return false;
1438 			}
1439 			hid_hw_raw_request(hdev, report->id, buf, report_len,
1440 					   HID_FEATURE_REPORT,
1441 					   HID_REQ_GET_REPORT);
1442 			kfree(buf);
1443 		}
1444 
1445 		field->value[index] = td->inputmode_value;
1446 		*inputmode_found = true;
1447 		return true;
1448 
1449 	case HID_DG_CONTACTMAX:
1450 		if (cls->maxcontacts) {
1451 			max = min_t(int, field->logical_maximum,
1452 				    cls->maxcontacts);
1453 			if (field->value[index] != max) {
1454 				field->value[index] = max;
1455 				return true;
1456 			}
1457 		}
1458 		break;
1459 
1460 	case HID_DG_LATENCYMODE:
1461 		field->value[index] = latency;
1462 		return true;
1463 
1464 	case HID_DG_SURFACESWITCH:
1465 		field->value[index] = surface_switch;
1466 		return true;
1467 
1468 	case HID_DG_BUTTONSWITCH:
1469 		field->value[index] = button_switch;
1470 		return true;
1471 	}
1472 
1473 	return false; /* no need to update the report */
1474 }
1475 
1476 static void mt_set_modes(struct hid_device *hdev, enum latency_mode latency,
1477 			 bool surface_switch, bool button_switch)
1478 {
1479 	struct hid_report_enum *rep_enum;
1480 	struct hid_report *rep;
1481 	struct hid_usage *usage;
1482 	int i, j;
1483 	bool update_report;
1484 	bool inputmode_found = false;
1485 
1486 	rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
1487 	list_for_each_entry(rep, &rep_enum->report_list, list) {
1488 		update_report = false;
1489 
1490 		for (i = 0; i < rep->maxfield; i++) {
1491 			/* Ignore if report count is out of bounds. */
1492 			if (rep->field[i]->report_count < 1)
1493 				continue;
1494 
1495 			for (j = 0; j < rep->field[i]->maxusage; j++) {
1496 				usage = &rep->field[i]->usage[j];
1497 
1498 				if (mt_need_to_apply_feature(hdev,
1499 							     rep->field[i],
1500 							     usage,
1501 							     latency,
1502 							     surface_switch,
1503 							     button_switch,
1504 							     &inputmode_found))
1505 					update_report = true;
1506 			}
1507 		}
1508 
1509 		if (update_report)
1510 			hid_hw_request(hdev, rep, HID_REQ_SET_REPORT);
1511 	}
1512 }
1513 
1514 static void mt_post_parse_default_settings(struct mt_device *td,
1515 					   struct mt_application *app)
1516 {
1517 	__s32 quirks = app->quirks;
1518 
1519 	/* unknown serial device needs special quirks */
1520 	if (list_is_singular(&app->mt_usages)) {
1521 		quirks |= MT_QUIRK_ALWAYS_VALID;
1522 		quirks &= ~MT_QUIRK_NOT_SEEN_MEANS_UP;
1523 		quirks &= ~MT_QUIRK_VALID_IS_INRANGE;
1524 		quirks &= ~MT_QUIRK_VALID_IS_CONFIDENCE;
1525 		quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1526 	}
1527 
1528 	app->quirks = quirks;
1529 }
1530 
1531 static void mt_post_parse(struct mt_device *td, struct mt_application *app)
1532 {
1533 	if (!app->have_contact_count)
1534 		app->quirks &= ~MT_QUIRK_CONTACT_CNT_ACCURATE;
1535 }
1536 
1537 static int mt_input_configured(struct hid_device *hdev, struct hid_input *hi)
1538 {
1539 	struct mt_device *td = hid_get_drvdata(hdev);
1540 	char *name;
1541 	const char *suffix = NULL;
1542 	struct mt_report_data *rdata;
1543 	struct mt_application *mt_application = NULL;
1544 	struct hid_report *report;
1545 	int ret;
1546 
1547 	list_for_each_entry(report, &hi->reports, hidinput_list) {
1548 		rdata = mt_find_report_data(td, report);
1549 		if (!rdata) {
1550 			hid_err(hdev, "failed to allocate data for report\n");
1551 			return -ENOMEM;
1552 		}
1553 
1554 		mt_application = rdata->application;
1555 
1556 		if (rdata->is_mt_collection) {
1557 			ret = mt_touch_input_configured(hdev, hi,
1558 							mt_application);
1559 			if (ret)
1560 				return ret;
1561 		}
1562 	}
1563 
1564 	switch (hi->application) {
1565 	case HID_GD_KEYBOARD:
1566 	case HID_GD_KEYPAD:
1567 	case HID_GD_MOUSE:
1568 	case HID_DG_TOUCHPAD:
1569 	case HID_GD_SYSTEM_CONTROL:
1570 	case HID_CP_CONSUMER_CONTROL:
1571 	case HID_GD_WIRELESS_RADIO_CTLS:
1572 	case HID_GD_SYSTEM_MULTIAXIS:
1573 		/* already handled by hid core */
1574 		break;
1575 	case HID_DG_TOUCHSCREEN:
1576 		/* we do not set suffix = "Touchscreen" */
1577 		hi->input->name = hdev->name;
1578 		break;
1579 	case HID_DG_STYLUS:
1580 		/* force BTN_STYLUS to allow tablet matching in udev */
1581 		__set_bit(BTN_STYLUS, hi->input->keybit);
1582 		break;
1583 	case HID_VD_ASUS_CUSTOM_MEDIA_KEYS:
1584 		suffix = "Custom Media Keys";
1585 		break;
1586 	case HID_DG_PEN:
1587 		suffix = "Stylus";
1588 		break;
1589 	default:
1590 		suffix = "UNKNOWN";
1591 		break;
1592 	}
1593 
1594 	if (suffix) {
1595 		name = devm_kzalloc(&hi->input->dev,
1596 				    strlen(hdev->name) + strlen(suffix) + 2,
1597 				    GFP_KERNEL);
1598 		if (name) {
1599 			sprintf(name, "%s %s", hdev->name, suffix);
1600 			hi->input->name = name;
1601 		}
1602 	}
1603 
1604 	return 0;
1605 }
1606 
1607 static void mt_fix_const_field(struct hid_field *field, unsigned int usage)
1608 {
1609 	if (field->usage[0].hid != usage ||
1610 	    !(field->flags & HID_MAIN_ITEM_CONSTANT))
1611 		return;
1612 
1613 	field->flags &= ~HID_MAIN_ITEM_CONSTANT;
1614 	field->flags |= HID_MAIN_ITEM_VARIABLE;
1615 }
1616 
1617 static void mt_fix_const_fields(struct hid_device *hdev, unsigned int usage)
1618 {
1619 	struct hid_report *report;
1620 	int i;
1621 
1622 	list_for_each_entry(report,
1623 			    &hdev->report_enum[HID_INPUT_REPORT].report_list,
1624 			    list) {
1625 
1626 		if (!report->maxfield)
1627 			continue;
1628 
1629 		for (i = 0; i < report->maxfield; i++)
1630 			if (report->field[i]->maxusage >= 1)
1631 				mt_fix_const_field(report->field[i], usage);
1632 	}
1633 }
1634 
1635 static void mt_release_contacts(struct hid_device *hid)
1636 {
1637 	struct hid_input *hidinput;
1638 	struct mt_application *application;
1639 	struct mt_device *td = hid_get_drvdata(hid);
1640 
1641 	list_for_each_entry(hidinput, &hid->inputs, list) {
1642 		struct input_dev *input_dev = hidinput->input;
1643 		struct input_mt *mt = input_dev->mt;
1644 		int i;
1645 
1646 		if (mt) {
1647 			for (i = 0; i < mt->num_slots; i++) {
1648 				input_mt_slot(input_dev, i);
1649 				input_mt_report_slot_inactive(input_dev);
1650 			}
1651 			input_mt_sync_frame(input_dev);
1652 			input_sync(input_dev);
1653 		}
1654 	}
1655 
1656 	list_for_each_entry(application, &td->applications, list) {
1657 		application->num_received = 0;
1658 	}
1659 }
1660 
1661 static void mt_expired_timeout(struct timer_list *t)
1662 {
1663 	struct mt_device *td = from_timer(td, t, release_timer);
1664 	struct hid_device *hdev = td->hdev;
1665 
1666 	/*
1667 	 * An input report came in just before we release the sticky fingers,
1668 	 * it will take care of the sticky fingers.
1669 	 */
1670 	if (test_and_set_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags))
1671 		return;
1672 	if (test_bit(MT_IO_FLAGS_PENDING_SLOTS, &td->mt_io_flags))
1673 		mt_release_contacts(hdev);
1674 	clear_bit(MT_IO_FLAGS_RUNNING, &td->mt_io_flags);
1675 }
1676 
1677 static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
1678 {
1679 	int ret, i;
1680 	struct mt_device *td;
1681 	const struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
1682 
1683 	for (i = 0; mt_classes[i].name ; i++) {
1684 		if (id->driver_data == mt_classes[i].name) {
1685 			mtclass = &(mt_classes[i]);
1686 			break;
1687 		}
1688 	}
1689 
1690 	td = devm_kzalloc(&hdev->dev, sizeof(struct mt_device), GFP_KERNEL);
1691 	if (!td) {
1692 		dev_err(&hdev->dev, "cannot allocate multitouch data\n");
1693 		return -ENOMEM;
1694 	}
1695 	td->hdev = hdev;
1696 	td->mtclass = *mtclass;
1697 	td->inputmode_value = MT_INPUTMODE_TOUCHSCREEN;
1698 	hid_set_drvdata(hdev, td);
1699 
1700 	INIT_LIST_HEAD(&td->applications);
1701 	INIT_LIST_HEAD(&td->reports);
1702 
1703 	if (id->vendor == HID_ANY_ID && id->product == HID_ANY_ID)
1704 		td->serial_maybe = true;
1705 
1706 	/* This allows the driver to correctly support devices
1707 	 * that emit events over several HID messages.
1708 	 */
1709 	hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
1710 
1711 	/*
1712 	 * This allows the driver to handle different input sensors
1713 	 * that emits events through different applications on the same HID
1714 	 * device.
1715 	 */
1716 	hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
1717 
1718 	if (id->group != HID_GROUP_MULTITOUCH_WIN_8)
1719 		hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1720 
1721 	if (mtclass->quirks & MT_QUIRK_FORCE_MULTI_INPUT) {
1722 		hdev->quirks &= ~HID_QUIRK_INPUT_PER_APP;
1723 		hdev->quirks |= HID_QUIRK_MULTI_INPUT;
1724 	}
1725 
1726 	timer_setup(&td->release_timer, mt_expired_timeout, 0);
1727 
1728 	ret = hid_parse(hdev);
1729 	if (ret != 0)
1730 		return ret;
1731 
1732 	if (mtclass->quirks & MT_QUIRK_FIX_CONST_CONTACT_ID)
1733 		mt_fix_const_fields(hdev, HID_DG_CONTACTID);
1734 
1735 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1736 	if (ret)
1737 		return ret;
1738 
1739 	ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
1740 	if (ret)
1741 		dev_warn(&hdev->dev, "Cannot allocate sysfs group for %s\n",
1742 				hdev->name);
1743 
1744 	mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1745 
1746 	return 0;
1747 }
1748 
1749 #ifdef CONFIG_PM
1750 static int mt_suspend(struct hid_device *hdev, pm_message_t state)
1751 {
1752 	/* High latency is desirable for power savings during S3/S0ix */
1753 	mt_set_modes(hdev, HID_LATENCY_HIGH, true, true);
1754 	return 0;
1755 }
1756 
1757 static int mt_reset_resume(struct hid_device *hdev)
1758 {
1759 	mt_release_contacts(hdev);
1760 	mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1761 	return 0;
1762 }
1763 
1764 static int mt_resume(struct hid_device *hdev)
1765 {
1766 	/* Some Elan legacy devices require SET_IDLE to be set on resume.
1767 	 * It should be safe to send it to other devices too.
1768 	 * Tested on 3M, Stantum, Cypress, Zytronic, eGalax, and Elan panels. */
1769 
1770 	hid_hw_idle(hdev, 0, 0, HID_REQ_SET_IDLE);
1771 
1772 	mt_set_modes(hdev, HID_LATENCY_NORMAL, true, true);
1773 
1774 	return 0;
1775 }
1776 #endif
1777 
1778 static void mt_remove(struct hid_device *hdev)
1779 {
1780 	struct mt_device *td = hid_get_drvdata(hdev);
1781 
1782 	del_timer_sync(&td->release_timer);
1783 
1784 	sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
1785 	hid_hw_stop(hdev);
1786 }
1787 
1788 /*
1789  * This list contains only:
1790  * - VID/PID of products not working with the default multitouch handling
1791  * - 2 generic rules.
1792  * So there is no point in adding here any device with MT_CLS_DEFAULT.
1793  */
1794 static const struct hid_device_id mt_devices[] = {
1795 
1796 	/* 3M panels */
1797 	{ .driver_data = MT_CLS_3M,
1798 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1799 			USB_DEVICE_ID_3M1968) },
1800 	{ .driver_data = MT_CLS_3M,
1801 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1802 			USB_DEVICE_ID_3M2256) },
1803 	{ .driver_data = MT_CLS_3M,
1804 		MT_USB_DEVICE(USB_VENDOR_ID_3M,
1805 			USB_DEVICE_ID_3M3266) },
1806 
1807 	/* Anton devices */
1808 	{ .driver_data = MT_CLS_EXPORT_ALL_INPUTS,
1809 		MT_USB_DEVICE(USB_VENDOR_ID_ANTON,
1810 			USB_DEVICE_ID_ANTON_TOUCH_PAD) },
1811 
1812 	/* Asus T304UA */
1813 	{ .driver_data = MT_CLS_ASUS,
1814 		HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1815 			USB_VENDOR_ID_ASUSTEK,
1816 			USB_DEVICE_ID_ASUSTEK_T304_KEYBOARD) },
1817 
1818 	/* Atmel panels */
1819 	{ .driver_data = MT_CLS_SERIAL,
1820 		MT_USB_DEVICE(USB_VENDOR_ID_ATMEL,
1821 			USB_DEVICE_ID_ATMEL_MXT_DIGITIZER) },
1822 
1823 	/* Baanto multitouch devices */
1824 	{ .driver_data = MT_CLS_NSMU,
1825 		MT_USB_DEVICE(USB_VENDOR_ID_BAANTO,
1826 			USB_DEVICE_ID_BAANTO_MT_190W2) },
1827 
1828 	/* Cando panels */
1829 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1830 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1831 			USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
1832 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
1833 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
1834 			USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
1835 
1836 	/* Chunghwa Telecom touch panels */
1837 	{  .driver_data = MT_CLS_NSMU,
1838 		MT_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
1839 			USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
1840 
1841 	/* CJTouch panels */
1842 	{ .driver_data = MT_CLS_NSMU,
1843 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1844 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0020) },
1845 	{ .driver_data = MT_CLS_NSMU,
1846 		MT_USB_DEVICE(USB_VENDOR_ID_CJTOUCH,
1847 			USB_DEVICE_ID_CJTOUCH_MULTI_TOUCH_0040) },
1848 
1849 	/* CVTouch panels */
1850 	{ .driver_data = MT_CLS_NSMU,
1851 		MT_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
1852 			USB_DEVICE_ID_CVTOUCH_SCREEN) },
1853 
1854 	/* eGalax devices (resistive) */
1855 	{ .driver_data = MT_CLS_EGALAX,
1856 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1857 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
1858 	{ .driver_data = MT_CLS_EGALAX,
1859 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1860 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
1861 
1862 	/* eGalax devices (capacitive) */
1863 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1864 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1865 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7207) },
1866 	{ .driver_data = MT_CLS_EGALAX,
1867 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1868 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
1869 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1870 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1871 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7224) },
1872 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1873 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1874 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_722A) },
1875 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1876 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1877 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_725E) },
1878 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1879 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1880 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7262) },
1881 	{ .driver_data = MT_CLS_EGALAX,
1882 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1883 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
1884 	{ .driver_data = MT_CLS_EGALAX,
1885 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1886 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
1887 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1888 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1889 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72AA) },
1890 	{ .driver_data = MT_CLS_EGALAX,
1891 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1892 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72C4) },
1893 	{ .driver_data = MT_CLS_EGALAX,
1894 		HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
1895 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72D0) },
1896 	{ .driver_data = MT_CLS_EGALAX,
1897 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1898 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
1899 	{ .driver_data = MT_CLS_EGALAX,
1900 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1901 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1902 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1903 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1904 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7349) },
1905 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1906 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1907 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_73F7) },
1908 	{ .driver_data = MT_CLS_EGALAX_SERIAL,
1909 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1910 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
1911 	{ .driver_data = MT_CLS_EGALAX,
1912 		MT_USB_DEVICE(USB_VENDOR_ID_DWAV,
1913 			USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_C002) },
1914 
1915 	/* Elan devices */
1916 	{ .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1917 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
1918 			USB_VENDOR_ID_ELAN, 0x313a) },
1919 
1920 	/* Elitegroup panel */
1921 	{ .driver_data = MT_CLS_SERIAL,
1922 		MT_USB_DEVICE(USB_VENDOR_ID_ELITEGROUP,
1923 			USB_DEVICE_ID_ELITEGROUP_05D8) },
1924 
1925 	/* Flatfrog Panels */
1926 	{ .driver_data = MT_CLS_FLATFROG,
1927 		MT_USB_DEVICE(USB_VENDOR_ID_FLATFROG,
1928 			USB_DEVICE_ID_MULTITOUCH_3200) },
1929 
1930 	/* FocalTech Panels */
1931 	{ .driver_data = MT_CLS_SERIAL,
1932 		MT_USB_DEVICE(USB_VENDOR_ID_CYGNAL,
1933 			USB_DEVICE_ID_FOCALTECH_FTXXXX_MULTITOUCH) },
1934 
1935 	/* GeneralTouch panel */
1936 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1937 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1938 			USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
1939 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1940 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1941 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PWT_TENFINGERS) },
1942 	{ .driver_data = MT_CLS_GENERALTOUCH_TWOFINGERS,
1943 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1944 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0101) },
1945 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1946 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1947 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0102) },
1948 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1949 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1950 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_0106) },
1951 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1952 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1953 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_010A) },
1954 	{ .driver_data = MT_CLS_GENERALTOUCH_PWT_TENFINGERS,
1955 		MT_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
1956 			USB_DEVICE_ID_GENERAL_TOUCH_WIN8_PIT_E100) },
1957 
1958 	/* Gametel game controller */
1959 	{ .driver_data = MT_CLS_NSMU,
1960 		MT_BT_DEVICE(USB_VENDOR_ID_FRUCTEL,
1961 			USB_DEVICE_ID_GAMETEL_MT_MODE) },
1962 
1963 	/* GoodTouch panels */
1964 	{ .driver_data = MT_CLS_NSMU,
1965 		MT_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
1966 			USB_DEVICE_ID_GOODTOUCH_000f) },
1967 
1968 	/* Hanvon panels */
1969 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
1970 		MT_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
1971 			USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
1972 
1973 	/* Ilitek dual touch panel */
1974 	{  .driver_data = MT_CLS_NSMU,
1975 		MT_USB_DEVICE(USB_VENDOR_ID_ILITEK,
1976 			USB_DEVICE_ID_ILITEK_MULTITOUCH) },
1977 
1978 	/* LG Melfas panel */
1979 	{ .driver_data = MT_CLS_LG,
1980 		HID_USB_DEVICE(USB_VENDOR_ID_LG,
1981 			USB_DEVICE_ID_LG_MELFAS_MT) },
1982 	{ .driver_data = MT_CLS_LG,
1983 		HID_DEVICE(BUS_I2C, HID_GROUP_GENERIC,
1984 			USB_VENDOR_ID_LG, I2C_DEVICE_ID_LG_7010) },
1985 
1986 	/* Lenovo X1 TAB Gen 2 */
1987 	{ .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1988 		HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1989 			   USB_VENDOR_ID_LENOVO,
1990 			   USB_DEVICE_ID_LENOVO_X1_TAB) },
1991 
1992 	/* Lenovo X1 TAB Gen 3 */
1993 	{ .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
1994 		HID_DEVICE(BUS_USB, HID_GROUP_MULTITOUCH_WIN_8,
1995 			   USB_VENDOR_ID_LENOVO,
1996 			   USB_DEVICE_ID_LENOVO_X1_TAB3) },
1997 
1998 	/* MosArt panels */
1999 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2000 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2001 			USB_DEVICE_ID_ASUS_T91MT)},
2002 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2003 		MT_USB_DEVICE(USB_VENDOR_ID_ASUS,
2004 			USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
2005 	{ .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
2006 		MT_USB_DEVICE(USB_VENDOR_ID_TURBOX,
2007 			USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
2008 
2009 	/* Novatek Panel */
2010 	{ .driver_data = MT_CLS_NSMU,
2011 		MT_USB_DEVICE(USB_VENDOR_ID_NOVATEK,
2012 			USB_DEVICE_ID_NOVATEK_PCT) },
2013 
2014 	/* Ntrig Panel */
2015 	{ .driver_data = MT_CLS_NSMU,
2016 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2017 			USB_VENDOR_ID_NTRIG, 0x1b05) },
2018 
2019 	/* Panasonic panels */
2020 	{ .driver_data = MT_CLS_PANASONIC,
2021 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2022 			USB_DEVICE_ID_PANABOARD_UBT780) },
2023 	{ .driver_data = MT_CLS_PANASONIC,
2024 		MT_USB_DEVICE(USB_VENDOR_ID_PANASONIC,
2025 			USB_DEVICE_ID_PANABOARD_UBT880) },
2026 
2027 	/* PixArt optical touch screen */
2028 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2029 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2030 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
2031 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2032 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2033 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
2034 	{ .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
2035 		MT_USB_DEVICE(USB_VENDOR_ID_PIXART,
2036 			USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
2037 
2038 	/* PixCir-based panels */
2039 	{ .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
2040 		MT_USB_DEVICE(USB_VENDOR_ID_CANDO,
2041 			USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
2042 
2043 	/* Quanta-based panels */
2044 	{ .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
2045 		MT_USB_DEVICE(USB_VENDOR_ID_QUANTA,
2046 			USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
2047 
2048 	/* Razer touchpads */
2049 	{ .driver_data = MT_CLS_RAZER_BLADE_STEALTH,
2050 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2051 			USB_VENDOR_ID_SYNAPTICS, 0x8323) },
2052 
2053 	/* Smart Tech panels */
2054 	{ .driver_data = MT_CLS_SMART_TECH,
2055 		MT_USB_DEVICE(0x0b8c, 0x0092)},
2056 
2057 	/* Stantum panels */
2058 	{ .driver_data = MT_CLS_CONFIDENCE,
2059 		MT_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
2060 			USB_DEVICE_ID_MTP_STM)},
2061 
2062 	/* Synaptics devices */
2063 	{ .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2064 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2065 			USB_VENDOR_ID_SYNAPTICS, 0xce08) },
2066 
2067 	{ .driver_data = MT_CLS_WIN_8_FORCE_MULTI_INPUT,
2068 		HID_DEVICE(BUS_I2C, HID_GROUP_MULTITOUCH_WIN_8,
2069 			USB_VENDOR_ID_SYNAPTICS, 0xce09) },
2070 
2071 	/* TopSeed panels */
2072 	{ .driver_data = MT_CLS_TOPSEED,
2073 		MT_USB_DEVICE(USB_VENDOR_ID_TOPSEED2,
2074 			USB_DEVICE_ID_TOPSEED2_PERIPAD_701) },
2075 
2076 	/* Touch International panels */
2077 	{ .driver_data = MT_CLS_NSMU,
2078 		MT_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
2079 			USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
2080 
2081 	/* Unitec panels */
2082 	{ .driver_data = MT_CLS_NSMU,
2083 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2084 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
2085 	{ .driver_data = MT_CLS_NSMU,
2086 		MT_USB_DEVICE(USB_VENDOR_ID_UNITEC,
2087 			USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
2088 
2089 	/* VTL panels */
2090 	{ .driver_data = MT_CLS_VTL,
2091 		MT_USB_DEVICE(USB_VENDOR_ID_VTL,
2092 			USB_DEVICE_ID_VTL_MULTITOUCH_FF3F) },
2093 
2094 	/* Wistron panels */
2095 	{ .driver_data = MT_CLS_NSMU,
2096 		MT_USB_DEVICE(USB_VENDOR_ID_WISTRON,
2097 			USB_DEVICE_ID_WISTRON_OPTICAL_TOUCH) },
2098 
2099 	/* XAT */
2100 	{ .driver_data = MT_CLS_NSMU,
2101 		MT_USB_DEVICE(USB_VENDOR_ID_XAT,
2102 			USB_DEVICE_ID_XAT_CSR) },
2103 
2104 	/* Xiroku */
2105 	{ .driver_data = MT_CLS_NSMU,
2106 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2107 			USB_DEVICE_ID_XIROKU_SPX) },
2108 	{ .driver_data = MT_CLS_NSMU,
2109 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2110 			USB_DEVICE_ID_XIROKU_MPX) },
2111 	{ .driver_data = MT_CLS_NSMU,
2112 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2113 			USB_DEVICE_ID_XIROKU_CSR) },
2114 	{ .driver_data = MT_CLS_NSMU,
2115 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2116 			USB_DEVICE_ID_XIROKU_SPX1) },
2117 	{ .driver_data = MT_CLS_NSMU,
2118 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2119 			USB_DEVICE_ID_XIROKU_MPX1) },
2120 	{ .driver_data = MT_CLS_NSMU,
2121 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2122 			USB_DEVICE_ID_XIROKU_CSR1) },
2123 	{ .driver_data = MT_CLS_NSMU,
2124 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2125 			USB_DEVICE_ID_XIROKU_SPX2) },
2126 	{ .driver_data = MT_CLS_NSMU,
2127 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2128 			USB_DEVICE_ID_XIROKU_MPX2) },
2129 	{ .driver_data = MT_CLS_NSMU,
2130 		MT_USB_DEVICE(USB_VENDOR_ID_XIROKU,
2131 			USB_DEVICE_ID_XIROKU_CSR2) },
2132 
2133 	/* Google MT devices */
2134 	{ .driver_data = MT_CLS_GOOGLE,
2135 		HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY, USB_VENDOR_ID_GOOGLE,
2136 			USB_DEVICE_ID_GOOGLE_TOUCH_ROSE) },
2137 
2138 	/* Generic MT device */
2139 	{ HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH, HID_ANY_ID, HID_ANY_ID) },
2140 
2141 	/* Generic Win 8 certified MT device */
2142 	{  .driver_data = MT_CLS_WIN_8,
2143 		HID_DEVICE(HID_BUS_ANY, HID_GROUP_MULTITOUCH_WIN_8,
2144 			HID_ANY_ID, HID_ANY_ID) },
2145 	{ }
2146 };
2147 MODULE_DEVICE_TABLE(hid, mt_devices);
2148 
2149 static const struct hid_usage_id mt_grabbed_usages[] = {
2150 	{ HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
2151 	{ HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
2152 };
2153 
2154 static struct hid_driver mt_driver = {
2155 	.name = "hid-multitouch",
2156 	.id_table = mt_devices,
2157 	.probe = mt_probe,
2158 	.remove = mt_remove,
2159 	.input_mapping = mt_input_mapping,
2160 	.input_mapped = mt_input_mapped,
2161 	.input_configured = mt_input_configured,
2162 	.feature_mapping = mt_feature_mapping,
2163 	.usage_table = mt_grabbed_usages,
2164 	.event = mt_event,
2165 	.report = mt_report,
2166 #ifdef CONFIG_PM
2167 	.suspend = mt_suspend,
2168 	.reset_resume = mt_reset_resume,
2169 	.resume = mt_resume,
2170 #endif
2171 };
2172 module_hid_driver(mt_driver);
2173