Linux Audio

Check our new training course

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