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