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