projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
HID: multitouch: add control of the feature "Maximum Contact Number"
[linux-block.git] / drivers / hid / hid-multitouch.c
CommitLineData
5519cab4
BT		 1/*
2 * HID driver for multitouch panels
3 *
c2ef8f21
BT		 4 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr>
5 * Copyright (c) 2010-2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6 * Copyright (c) 2010-2012 Ecole Nationale de l'Aviation Civile, France
5519cab4 7 *
4875ac11
RN		 8 * This code is partly based on hid-egalax.c:
9 *
10 * Copyright (c) 2010 Stephane Chatty <chatty@enac.fr>
11 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
12 * Copyright (c) 2010 Canonical, Ltd.
13 *
f786bba4
BT		 14 * This code is partly based on hid-3m-pct.c:
15 *
16 * Copyright (c) 2009-2010 Stephane Chatty <chatty@enac.fr>
17 * Copyright (c) 2010 Henrik Rydberg <rydberg@euromail.se>
18 * Copyright (c) 2010 Canonical, Ltd.
19 *
5519cab4
BT		 20 */
21
22/*
23 * This program is free software; you can redistribute it and/or modify it
24 * under the terms of the GNU General Public License as published by the Free
25 * Software Foundation; either version 2 of the License, or (at your option)
26 * any later version.
27 */
28
29#include <linux/device.h>
30#include <linux/hid.h>
31#include <linux/module.h>
32#include <linux/slab.h>
33#include <linux/usb.h>
34#include <linux/input/mt.h>
35#include "usbhid/usbhid.h"
36
37
38MODULE_AUTHOR("Stephane Chatty <chatty@enac.fr>");
ef2fafb3 39MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
5519cab4
BT		 40MODULE_DESCRIPTION("HID multitouch panels");
41MODULE_LICENSE("GPL");
42
43#include "hid-ids.h"
44
45/* quirks to control the device */
46#define MT_QUIRK_NOT_SEEN_MEANS_UP (1 << 0)
47#define MT_QUIRK_SLOT_IS_CONTACTID (1 << 1)
2d93666e 48#define MT_QUIRK_CYPRESS (1 << 2)
5572da08 49#define MT_QUIRK_SLOT_IS_CONTACTNUMBER (1 << 3)
a062cc5a
SC		 50#define MT_QUIRK_ALWAYS_VALID (1 << 4)
51#define MT_QUIRK_VALID_IS_INRANGE (1 << 5)
52#define MT_QUIRK_VALID_IS_CONFIDENCE (1 << 6)
a062cc5a 53#define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE (1 << 8)
5519cab4
BT		 54
55struct mt_slot {
56 __s32 x, y, p, w, h;
57 __s32 contactid; /* the device ContactID assigned to this slot */
58 bool touch_state; /* is the touch valid? */
59 bool seen_in_this_frame;/* has this slot been updated */
60};
61
eec29e3d
BT		 62struct mt_class {
63 __s32 name; /* MT_CLS */
64 __s32 quirks;
65 __s32 sn_move; /* Signal/noise ratio for move events */
66 __s32 sn_width; /* Signal/noise ratio for width events */
67 __s32 sn_height; /* Signal/noise ratio for height events */
68 __s32 sn_pressure; /* Signal/noise ratio for pressure events */
69 __u8 maxcontacts;
c2ef8f21 70 bool is_indirect; /* true for touchpads */
eec29e3d
BT		 71};
72
5519cab4
BT		 73struct mt_device {
74 struct mt_slot curdata; /* placeholder of incoming data */
eec29e3d 75 struct mt_class mtclass; /* our mt device class */
5519cab4
BT		 76 unsigned last_field_index; /* last field index of the report */
77 unsigned last_slot_field; /* the last field of a slot */
b84bd27f 78 int last_mt_collection; /* last known mt-related collection */
5519cab4 79 __s8 inputmode; /* InputMode HID feature, -1 if non-existent */
31ae9bdd
BT		 80 __s8 maxcontact_report_id; /* Maximum Contact Number HID feature,
81 -1 if non-existent */
5519cab4
BT		 82 __u8 num_received; /* how many contacts we received */
83 __u8 num_expected; /* expected last contact index */
9498f954 84 __u8 maxcontacts;
5519cab4 85 bool curvalid; /* is the current contact valid? */
9498f954 86 struct mt_slot *slots;
5519cab4
BT		 87};
88
5519cab4 89/* classes of device behavior */
22408283
BT		 90#define MT_CLS_DEFAULT 0x0001
91
a062cc5a
SC		 92#define MT_CLS_SERIAL 0x0002
93#define MT_CLS_CONFIDENCE 0x0003
5e7ea11f
BT		 94#define MT_CLS_CONFIDENCE_CONTACT_ID 0x0004
95#define MT_CLS_CONFIDENCE_MINUS_ONE 0x0005
96#define MT_CLS_DUAL_INRANGE_CONTACTID 0x0006
97#define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 0x0007
98#define MT_CLS_DUAL_NSMU_CONTACTID 0x0008
b7ea95ff 99#define MT_CLS_INRANGE_CONTACTNUMBER 0x0009
22408283
BT		 100
101/* vendor specific classes */
102#define MT_CLS_3M 0x0101
103#define MT_CLS_CYPRESS 0x0102
104#define MT_CLS_EGALAX 0x0103
1b723e8d 105#define MT_CLS_EGALAX_SERIAL 0x0104
5519cab4 106
9498f954
BT		 107#define MT_DEFAULT_MAXCONTACT 10
108
5519cab4
BT		 109/*
110 * these device-dependent functions determine what slot corresponds
111 * to a valid contact that was just read.
112 */
113
a3b5e577
BT		 114static int cypress_compute_slot(struct mt_device *td)
115{
116 if (td->curdata.contactid != 0 || td->num_received == 0)
117 return td->curdata.contactid;
118 else
119 return -1;
120}
121
5519cab4
BT		 122static int find_slot_from_contactid(struct mt_device *td)
123{
124 int i;
9498f954 125 for (i = 0; i < td->maxcontacts; ++i) {
5519cab4
BT		 126 if (td->slots[i].contactid == td->curdata.contactid &&
127 td->slots[i].touch_state)
128 return i;
129 }
9498f954 130 for (i = 0; i < td->maxcontacts; ++i) {
5519cab4
BT		 131 if (!td->slots[i].seen_in_this_frame &&
132 !td->slots[i].touch_state)
133 return i;
134 }
5519cab4
BT		 135 /* should not occurs. If this happens that means
136 * that the device sent more touches that it says
137 * in the report descriptor. It is ignored then. */
2d93666e 138 return -1;
5519cab4
BT		 139}
140
b3c21d2c 141static struct mt_class mt_classes[] = {
2d93666e 142 { .name = MT_CLS_DEFAULT,
9498f954 143 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
a062cc5a
SC		 144 { .name = MT_CLS_SERIAL,
145 .quirks = MT_QUIRK_ALWAYS_VALID},
22408283
BT		 146 { .name = MT_CLS_CONFIDENCE,
147 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
5e7ea11f
BT		 148 { .name = MT_CLS_CONFIDENCE_CONTACT_ID,
149 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
150 MT_QUIRK_SLOT_IS_CONTACTID },
22408283
BT		 151 { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
152 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
153 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
1e9cf35b 154 { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
2d93666e
BT		 155 .quirks = MT_QUIRK_VALID_IS_INRANGE |
156 MT_QUIRK_SLOT_IS_CONTACTID,
157 .maxcontacts = 2 },
1e9cf35b 158 { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
2d93666e
BT		 159 .quirks = MT_QUIRK_VALID_IS_INRANGE |
160 MT_QUIRK_SLOT_IS_CONTACTNUMBER,
161 .maxcontacts = 2 },
22408283
BT		 162 { .name = MT_CLS_DUAL_NSMU_CONTACTID,
163 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
164 MT_QUIRK_SLOT_IS_CONTACTID,
165 .maxcontacts = 2 },
b7ea95ff
AT		 166 { .name = MT_CLS_INRANGE_CONTACTNUMBER,
167 .quirks = MT_QUIRK_VALID_IS_INRANGE |
168 MT_QUIRK_SLOT_IS_CONTACTNUMBER },
22408283
BT		 169
170 /*
171 * vendor specific classes
172 */
173 { .name = MT_CLS_3M,
174 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
175 MT_QUIRK_SLOT_IS_CONTACTID,
176 .sn_move = 2048,
177 .sn_width = 128,
178 .sn_height = 128 },
2d93666e
BT		 179 { .name = MT_CLS_CYPRESS,
180 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
181 MT_QUIRK_CYPRESS,
182 .maxcontacts = 10 },
4875ac11
RN		 183 { .name = MT_CLS_EGALAX,
184 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
2261bb9f 185 MT_QUIRK_VALID_IS_INRANGE,
4875ac11
RN		 186 .sn_move = 4096,
187 .sn_pressure = 32,
188 },
1b723e8d
BT		 189 { .name = MT_CLS_EGALAX_SERIAL,
190 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
191 MT_QUIRK_ALWAYS_VALID,
4875ac11
RN		 192 .sn_move = 4096,
193 .sn_pressure = 32,
194 },
043b403a 195
2d93666e 196 { }
5519cab4
BT		 197};
198
eec29e3d
BT		 199static ssize_t mt_show_quirks(struct device *dev,
200 struct device_attribute *attr,
201 char *buf)
202{
203 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
204 struct mt_device *td = hid_get_drvdata(hdev);
205
206 return sprintf(buf, "%u\n", td->mtclass.quirks);
207}
208
209static ssize_t mt_set_quirks(struct device *dev,
210 struct device_attribute *attr,
211 const char *buf, size_t count)
212{
213 struct hid_device *hdev = container_of(dev, struct hid_device, dev);
214 struct mt_device *td = hid_get_drvdata(hdev);
215
216 unsigned long val;
217
218 if (kstrtoul(buf, 0, &val))
219 return -EINVAL;
220
221 td->mtclass.quirks = val;
222
223 return count;
224}
225
226static DEVICE_ATTR(quirks, S_IWUSR | S_IRUGO, mt_show_quirks, mt_set_quirks);
227
228static struct attribute *sysfs_attrs[] = {
229 &dev_attr_quirks.attr,
230 NULL
231};
232
233static struct attribute_group mt_attribute_group = {
234 .attrs = sysfs_attrs
235};
236
f635bd11 237static void mt_feature_mapping(struct hid_device *hdev,
5519cab4
BT		 238 struct hid_field *field, struct hid_usage *usage)
239{
9498f954
BT		 240 struct mt_device *td = hid_get_drvdata(hdev);
241
242 switch (usage->hid) {
243 case HID_DG_INPUTMODE:
5519cab4 244 td->inputmode = field->report->id;
9498f954
BT		 245 break;
246 case HID_DG_CONTACTMAX:
31ae9bdd 247 td->maxcontact_report_id = field->report->id;
9498f954 248 td->maxcontacts = field->value[0];
eec29e3d 249 if (td->mtclass.maxcontacts)
9498f954 250 /* check if the maxcontacts is given by the class */
eec29e3d 251 td->maxcontacts = td->mtclass.maxcontacts;
9498f954
BT		 252
253 break;
5519cab4
BT		 254 }
255}
256
257static void set_abs(struct input_dev *input, unsigned int code,
258 struct hid_field *field, int snratio)
259{
260 int fmin = field->logical_minimum;
261 int fmax = field->logical_maximum;
262 int fuzz = snratio ? (fmax - fmin) / snratio : 0;
263 input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
264}
265
266static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
267 struct hid_field *field, struct hid_usage *usage,
268 unsigned long **bit, int *max)
269{
270 struct mt_device *td = hid_get_drvdata(hdev);
eec29e3d 271 struct mt_class *cls = &td->mtclass;
c2ef8f21 272 int code;
4875ac11 273
658d4aed
JB		 274 /* Only map fields from TouchScreen or TouchPad collections.
275 * We need to ignore fields that belong to other collections
276 * such as Mouse that might have the same GenericDesktop usages. */
277 if (field->application == HID_DG_TOUCHSCREEN)
278 set_bit(INPUT_PROP_DIRECT, hi->input->propbit);
c2ef8f21 279 else if (field->application != HID_DG_TOUCHPAD)
658d4aed
JB		 280 return 0;
281
c2ef8f21
BT		 282 /* In case of an indirect device (touchpad), we need to add
283 * specific BTN_TOOL_* to be handled by the synaptics xorg
284 * driver.
285 * We also consider that touchscreens providing buttons are touchpads.
286 */
287 if (field->application == HID_DG_TOUCHPAD ||
288 (usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON ||
289 cls->is_indirect) {
290 set_bit(INPUT_PROP_POINTER, hi->input->propbit);
291 set_bit(BTN_TOOL_FINGER, hi->input->keybit);
292 set_bit(BTN_TOOL_DOUBLETAP, hi->input->keybit);
293 set_bit(BTN_TOOL_TRIPLETAP, hi->input->keybit);
294 set_bit(BTN_TOOL_QUADTAP, hi->input->keybit);
295 }
296
2261bb9f
BT		 297 /* eGalax devices provide a Digitizer.Stylus input which overrides
298 * the correct Digitizers.Finger X/Y ranges.
299 * Let's just ignore this input. */
300 if (field->physical == HID_DG_STYLUS)
301 return -1;
302
5519cab4
BT		 303 switch (usage->hid & HID_USAGE_PAGE) {
304
305 case HID_UP_GENDESK:
306 switch (usage->hid) {
307 case HID_GD_X:
308 hid_map_usage(hi, usage, bit, max,
309 EV_ABS, ABS_MT_POSITION_X);
310 set_abs(hi->input, ABS_MT_POSITION_X, field,
311 cls->sn_move);
312 /* touchscreen emulation */
313 set_abs(hi->input, ABS_X, field, cls->sn_move);
b84bd27f
BT		 314 if (td->last_mt_collection == usage->collection_index) {
315 td->last_slot_field = usage->hid;
316 td->last_field_index = field->index;
317 }
5519cab4
BT		 318 return 1;
319 case HID_GD_Y:
320 hid_map_usage(hi, usage, bit, max,
321 EV_ABS, ABS_MT_POSITION_Y);
322 set_abs(hi->input, ABS_MT_POSITION_Y, field,
323 cls->sn_move);
324 /* touchscreen emulation */
325 set_abs(hi->input, ABS_Y, field, cls->sn_move);
b84bd27f
BT		 326 if (td->last_mt_collection == usage->collection_index) {
327 td->last_slot_field = usage->hid;
328 td->last_field_index = field->index;
329 }
5519cab4
BT		 330 return 1;
331 }
332 return 0;
333
334 case HID_UP_DIGITIZER:
335 switch (usage->hid) {
336 case HID_DG_INRANGE:
b84bd27f
BT		 337 if (td->last_mt_collection == usage->collection_index) {
338 td->last_slot_field = usage->hid;
339 td->last_field_index = field->index;
340 }
5519cab4
BT		 341 return 1;
342 case HID_DG_CONFIDENCE:
b84bd27f
BT		 343 if (td->last_mt_collection == usage->collection_index) {
344 td->last_slot_field = usage->hid;
345 td->last_field_index = field->index;
346 }
5519cab4
BT		 347 return 1;
348 case HID_DG_TIPSWITCH:
349 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
350 input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
b84bd27f
BT		 351 if (td->last_mt_collection == usage->collection_index) {
352 td->last_slot_field = usage->hid;
353 td->last_field_index = field->index;
354 }
5519cab4
BT		 355 return 1;
356 case HID_DG_CONTACTID:
50bc03ab
BT		 357 if (!td->maxcontacts)
358 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
9498f954 359 input_mt_init_slots(hi->input, td->maxcontacts);
5519cab4 360 td->last_slot_field = usage->hid;
2955caed 361 td->last_field_index = field->index;
b84bd27f 362 td->last_mt_collection = usage->collection_index;
5519cab4
BT		 363 return 1;
364 case HID_DG_WIDTH:
365 hid_map_usage(hi, usage, bit, max,
366 EV_ABS, ABS_MT_TOUCH_MAJOR);
f786bba4
BT		 367 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
368 cls->sn_width);
b84bd27f
BT		 369 if (td->last_mt_collection == usage->collection_index) {
370 td->last_slot_field = usage->hid;
371 td->last_field_index = field->index;
372 }
5519cab4
BT		 373 return 1;
374 case HID_DG_HEIGHT:
375 hid_map_usage(hi, usage, bit, max,
376 EV_ABS, ABS_MT_TOUCH_MINOR);
f786bba4
BT		 377 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
378 cls->sn_height);
1e648a13
BT		 379 input_set_abs_params(hi->input,
380 ABS_MT_ORIENTATION, 0, 1, 0, 0);
b84bd27f
BT		 381 if (td->last_mt_collection == usage->collection_index) {
382 td->last_slot_field = usage->hid;
383 td->last_field_index = field->index;
384 }
5519cab4
BT		 385 return 1;
386 case HID_DG_TIPPRESSURE:
387 hid_map_usage(hi, usage, bit, max,
388 EV_ABS, ABS_MT_PRESSURE);
389 set_abs(hi->input, ABS_MT_PRESSURE, field,
390 cls->sn_pressure);
391 /* touchscreen emulation */
392 set_abs(hi->input, ABS_PRESSURE, field,
393 cls->sn_pressure);
b84bd27f
BT		 394 if (td->last_mt_collection == usage->collection_index) {
395 td->last_slot_field = usage->hid;
396 td->last_field_index = field->index;
397 }
5519cab4
BT		 398 return 1;
399 case HID_DG_CONTACTCOUNT:
b84bd27f
BT		 400 if (td->last_mt_collection == usage->collection_index)
401 td->last_field_index = field->index;
5519cab4
BT		 402 return 1;
403 case HID_DG_CONTACTMAX:
404 /* we don't set td->last_slot_field as contactcount and
405 * contact max are global to the report */
b84bd27f
BT		 406 if (td->last_mt_collection == usage->collection_index)
407 td->last_field_index = field->index;
5519cab4
BT		 408 return -1;
409 }
c2ef8f21
BT		 410 case HID_DG_TOUCH:
411 /* Legacy devices use TIPSWITCH and not TOUCH.
412 * Let's just ignore this field. */
413 return -1;
5519cab4
BT		 414 /* let hid-input decide for the others */
415 return 0;
416
c2ef8f21
BT		 417 case HID_UP_BUTTON:
418 code = BTN_MOUSE + ((usage->hid - 1) & HID_USAGE);
419 hid_map_usage(hi, usage, bit, max, EV_KEY, code);
420 input_set_capability(hi->input, EV_KEY, code);
421 return 1;
422
5519cab4
BT		 423 case 0xff000000:
424 /* we do not want to map these: no input-oriented meaning */
425 return -1;
426 }
427
428 return 0;
429}
430
431static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
432 struct hid_field *field, struct hid_usage *usage,
433 unsigned long **bit, int *max)
434{
435 if (usage->type == EV_KEY || usage->type == EV_ABS)
436 set_bit(usage->type, hi->input->evbit);
437
438 return -1;
439}
440
441static int mt_compute_slot(struct mt_device *td)
442{
eec29e3d 443 __s32 quirks = td->mtclass.quirks;
5519cab4 444
2d93666e
BT		 445 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
446 return td->curdata.contactid;
5519cab4 447
2d93666e 448 if (quirks & MT_QUIRK_CYPRESS)
a3b5e577
BT		 449 return cypress_compute_slot(td);
450
2d93666e
BT		 451 if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
452 return td->num_received;
5572da08 453
4a6ee685
BT		 454 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
455 return td->curdata.contactid - 1;
456
5519cab4
BT		 457 return find_slot_from_contactid(td);
458}
459
460/*
461 * this function is called when a whole contact has been processed,
462 * so that it can assign it to a slot and store the data there
463 */
464static void mt_complete_slot(struct mt_device *td)
465{
2d93666e 466 td->curdata.seen_in_this_frame = true;
5519cab4 467 if (td->curvalid) {
5519cab4
BT		 468 int slotnum = mt_compute_slot(td);
469
9498f954 470 if (slotnum >= 0 && slotnum < td->maxcontacts)
2d93666e 471 td->slots[slotnum] = td->curdata;
5519cab4
BT		 472 }
473 td->num_received++;
474}
475
476
477/*
478 * this function is called when a whole packet has been received and processed,
479 * so that it can decide what to send to the input layer.
480 */
481static void mt_emit_event(struct mt_device *td, struct input_dev *input)
482{
483 int i;
484
9498f954 485 for (i = 0; i < td->maxcontacts; ++i) {
5519cab4 486 struct mt_slot *s = &(td->slots[i]);
eec29e3d 487 if ((td->mtclass.quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
5519cab4 488 !s->seen_in_this_frame) {
5519cab4
BT		 489 s->touch_state = false;
490 }
491
492 input_mt_slot(input, i);
493 input_mt_report_slot_state(input, MT_TOOL_FINGER,
494 s->touch_state);
2d93666e 495 if (s->touch_state) {
f786bba4
BT		 496 /* this finger is on the screen */
497 int wide = (s->w > s->h);
498 /* divided by two to match visual scale of touch */
499 int major = max(s->w, s->h) >> 1;
500 int minor = min(s->w, s->h) >> 1;
501
2d93666e
BT		 502 input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
503 input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
f786bba4 504 input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
2d93666e 505 input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
f786bba4
BT		 506 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
507 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
2d93666e 508 }
5519cab4
BT		 509 s->seen_in_this_frame = false;
510
511 }
512
513 input_mt_report_pointer_emulation(input, true);
514 input_sync(input);
515 td->num_received = 0;
516}
517
518
519
520static int mt_event(struct hid_device *hid, struct hid_field *field,
521 struct hid_usage *usage, __s32 value)
522{
523 struct mt_device *td = hid_get_drvdata(hid);
eec29e3d 524 __s32 quirks = td->mtclass.quirks;
5519cab4 525
9498f954 526 if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
5519cab4
BT		 527 switch (usage->hid) {
528 case HID_DG_INRANGE:
a062cc5a
SC		 529 if (quirks & MT_QUIRK_ALWAYS_VALID)
530 td->curvalid = true;
531 else if (quirks & MT_QUIRK_VALID_IS_INRANGE)
2d93666e 532 td->curvalid = value;
5519cab4
BT		 533 break;
534 case HID_DG_TIPSWITCH:
2d93666e
BT		 535 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
536 td->curvalid = value;
5519cab4
BT		 537 td->curdata.touch_state = value;
538 break;
539 case HID_DG_CONFIDENCE:
2d93666e
BT		 540 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
541 td->curvalid = value;
5519cab4
BT		 542 break;
543 case HID_DG_CONTACTID:
544 td->curdata.contactid = value;
545 break;
546 case HID_DG_TIPPRESSURE:
547 td->curdata.p = value;
548 break;
549 case HID_GD_X:
550 td->curdata.x = value;
551 break;
552 case HID_GD_Y:
553 td->curdata.y = value;
554 break;
555 case HID_DG_WIDTH:
556 td->curdata.w = value;
557 break;
558 case HID_DG_HEIGHT:
559 td->curdata.h = value;
560 break;
561 case HID_DG_CONTACTCOUNT:
562 /*
2d93666e
BT		 563 * Includes multi-packet support where subsequent
564 * packets are sent with zero contactcount.
5519cab4
BT		 565 */
566 if (value)
2d93666e 567 td->num_expected = value;
5519cab4 568 break;
c2ef8f21
BT		 569 case HID_DG_TOUCH:
570 /* do nothing */
571 break;
5519cab4
BT		 572
573 default:
574 /* fallback to the generic hidinput handling */
575 return 0;
576 }
5519cab4 577
f153fc39 578 if (usage->hid == td->last_slot_field) {
2d93666e 579 mt_complete_slot(td);
f153fc39 580 }
2d93666e
BT		 581
582 if (field->index == td->last_field_index
583 && td->num_received >= td->num_expected)
584 mt_emit_event(td, field->hidinput->input);
5519cab4 585
2d93666e 586 }
5519cab4
BT		 587
588 /* we have handled the hidinput part, now remains hiddev */
589 if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
590 hid->hiddev_hid_event(hid, field, usage, value);
591
592 return 1;
593}
594
595static void mt_set_input_mode(struct hid_device *hdev)
596{
597 struct mt_device *td = hid_get_drvdata(hdev);
598 struct hid_report *r;
599 struct hid_report_enum *re;
600
601 if (td->inputmode < 0)
602 return;
603
604 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
605 r = re->report_id_hash[td->inputmode];
606 if (r) {
607 r->field[0]->value[0] = 0x02;
608 usbhid_submit_report(hdev, r, USB_DIR_OUT);
609 }
610}
611
31ae9bdd
BT		 612static void mt_set_maxcontacts(struct hid_device *hdev)
613{
614 struct mt_device *td = hid_get_drvdata(hdev);
615 struct hid_report *r;
616 struct hid_report_enum *re;
617 int fieldmax, max;
618
619 if (td->maxcontact_report_id < 0)
620 return;
621
622 if (!td->mtclass.maxcontacts)
623 return;
624
625 re = &hdev->report_enum[HID_FEATURE_REPORT];
626 r = re->report_id_hash[td->maxcontact_report_id];
627 if (r) {
628 max = td->mtclass.maxcontacts;
629 fieldmax = r->field[0]->logical_maximum;
630 max = min(fieldmax, max);
631 if (r->field[0]->value[0] != max) {
632 r->field[0]->value[0] = max;
633 usbhid_submit_report(hdev, r, USB_DIR_OUT);
634 }
635 }
636}
637
5519cab4
BT		 638static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
639{
2d93666e 640 int ret, i;
5519cab4 641 struct mt_device *td;
2d93666e
BT		 642 struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
643
644 for (i = 0; mt_classes[i].name ; i++) {
645 if (id->driver_data == mt_classes[i].name) {
646 mtclass = &(mt_classes[i]);
647 break;
648 }
649 }
5519cab4 650
d682bd7f
HR		 651 /* This allows the driver to correctly support devices
652 * that emit events over several HID messages.
653 */
654 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
5519cab4 655
9498f954 656 td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
5519cab4
BT		 657 if (!td) {
658 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
659 return -ENOMEM;
660 }
eec29e3d 661 td->mtclass = *mtclass;
5519cab4 662 td->inputmode = -1;
31ae9bdd 663 td->maxcontact_report_id = -1;
b84bd27f 664 td->last_mt_collection = -1;
5519cab4
BT		 665 hid_set_drvdata(hdev, td);
666
667 ret = hid_parse(hdev);
668 if (ret != 0)
669 goto fail;
670
671 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
2d93666e 672 if (ret)
5519cab4
BT		 673 goto fail;
674
9498f954
BT		 675 td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
676 GFP_KERNEL);
677 if (!td->slots) {
678 dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
679 hid_hw_stop(hdev);
680 ret = -ENOMEM;
681 goto fail;
682 }
683
eec29e3d
BT		 684 ret = sysfs_create_group(&hdev->dev.kobj, &mt_attribute_group);
685
31ae9bdd 686 mt_set_maxcontacts(hdev);
5519cab4
BT		 687 mt_set_input_mode(hdev);
688
689 return 0;
690
691fail:
692 kfree(td);
693 return ret;
694}
695
696#ifdef CONFIG_PM
697static int mt_reset_resume(struct hid_device *hdev)
698{
31ae9bdd 699 mt_set_maxcontacts(hdev);
5519cab4
BT		 700 mt_set_input_mode(hdev);
701 return 0;
702}
703#endif
704
705static void mt_remove(struct hid_device *hdev)
706{
707 struct mt_device *td = hid_get_drvdata(hdev);
eec29e3d 708 sysfs_remove_group(&hdev->dev.kobj, &mt_attribute_group);
5519cab4 709 hid_hw_stop(hdev);
9498f954 710 kfree(td->slots);
5519cab4
BT		 711 kfree(td);
712 hid_set_drvdata(hdev, NULL);
713}
714
715static const struct hid_device_id mt_devices[] = {
716
f786bba4
BT		 717 /* 3M panels */
718 { .driver_data = MT_CLS_3M,
719 HID_USB_DEVICE(USB_VENDOR_ID_3M,
720 USB_DEVICE_ID_3M1968) },
721 { .driver_data = MT_CLS_3M,
722 HID_USB_DEVICE(USB_VENDOR_ID_3M,
723 USB_DEVICE_ID_3M2256) },
c4fad877
BT		 724 { .driver_data = MT_CLS_3M,
725 HID_USB_DEVICE(USB_VENDOR_ID_3M,
726 USB_DEVICE_ID_3M3266) },
f786bba4 727
e6aac342
BT		 728 /* ActionStar panels */
729 { .driver_data = MT_CLS_DEFAULT,
730 HID_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
731 USB_DEVICE_ID_ACTIONSTAR_1011) },
732
b1057124
BT		 733 /* Atmel panels */
734 { .driver_data = MT_CLS_SERIAL,
735 HID_USB_DEVICE(USB_VENDOR_ID_ATMEL,
736 USB_DEVICE_ID_ATMEL_MULTITOUCH) },
737
a841b62c
BT		 738 /* Cando panels */
739 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
740 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
741 USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
742 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
743 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
744 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
745 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
746 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
747 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
748 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
749 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
750 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
751
942fd422
AZ		 752 /* Chunghwa Telecom touch panels */
753 { .driver_data = MT_CLS_DEFAULT,
754 HID_USB_DEVICE(USB_VENDOR_ID_CHUNGHWAT,
755 USB_DEVICE_ID_CHUNGHWAT_MULTITOUCH) },
756
79603dc9
BT		 757 /* CVTouch panels */
758 { .driver_data = MT_CLS_DEFAULT,
759 HID_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
760 USB_DEVICE_ID_CVTOUCH_SCREEN) },
761
a3b5e577
BT		 762 /* Cypress panel */
763 { .driver_data = MT_CLS_CYPRESS,
764 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
765 USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
766
22408283 767 /* eGalax devices (resistive) */
e36f690b 768 { .driver_data = MT_CLS_EGALAX,
22408283 769 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b
BT		 770 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480D) },
771 { .driver_data = MT_CLS_EGALAX,
22408283 772 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b 773 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_480E) },
22408283
BT		 774
775 /* eGalax devices (capacitive) */
e36f690b 776 { .driver_data = MT_CLS_EGALAX,
22408283 777 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b
BT		 778 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_720C) },
779 { .driver_data = MT_CLS_EGALAX,
22408283 780 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b
BT		 781 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_726B) },
782 { .driver_data = MT_CLS_EGALAX,
22408283 783 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b 784 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72A1) },
66f06127
BT		 785 { .driver_data = MT_CLS_EGALAX,
786 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
787 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_72FA) },
bb9ff210
MV		 788 { .driver_data = MT_CLS_EGALAX,
789 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
790 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_7302) },
1b723e8d 791 { .driver_data = MT_CLS_EGALAX_SERIAL,
1fd8f047 792 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
e36f690b 793 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH_A001) },
22408283 794
c04abeef
BT		 795 /* Elo TouchSystems IntelliTouch Plus panel */
796 { .driver_data = MT_CLS_DUAL_NSMU_CONTACTID,
797 HID_USB_DEVICE(USB_VENDOR_ID_ELO,
798 USB_DEVICE_ID_ELO_TS2515) },
799
5572da08 800 /* GeneralTouch panel */
1e9cf35b 801 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
5572da08
BT		 802 HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
803 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
804
ee0fbd14
BT		 805 /* GoodTouch panels */
806 { .driver_data = MT_CLS_DEFAULT,
807 HID_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
808 USB_DEVICE_ID_GOODTOUCH_000f) },
809
54580365
BT		 810 /* Hanvon panels */
811 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
812 HID_USB_DEVICE(USB_VENDOR_ID_HANVON_ALT,
813 USB_DEVICE_ID_HANVON_ALT_MULTITOUCH) },
814
a062cc5a
SC		 815 /* Ideacom panel */
816 { .driver_data = MT_CLS_SERIAL,
817 HID_USB_DEVICE(USB_VENDOR_ID_IDEACOM,
818 USB_DEVICE_ID_IDEACOM_IDC6650) },
819
4e61f0d7
AZ		 820 /* Ilitek dual touch panel */
821 { .driver_data = MT_CLS_DEFAULT,
822 HID_USB_DEVICE(USB_VENDOR_ID_ILITEK,
823 USB_DEVICE_ID_ILITEK_MULTITOUCH) },
824
4dfcced8
BT		 825 /* IRTOUCH panels */
826 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
827 HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
828 USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
829
c50bb1a4
JB		 830 /* LG Display panels */
831 { .driver_data = MT_CLS_DEFAULT,
832 HID_USB_DEVICE(USB_VENDOR_ID_LG,
833 USB_DEVICE_ID_LG_MULTITOUCH) },
834
df167c4a
BT		 835 /* Lumio panels */
836 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
837 HID_USB_DEVICE(USB_VENDOR_ID_LUMIO,
838 USB_DEVICE_ID_CRYSTALTOUCH) },
c3ead6de
BT		 839 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
840 HID_USB_DEVICE(USB_VENDOR_ID_LUMIO,
841 USB_DEVICE_ID_CRYSTALTOUCH_DUAL) },
df167c4a 842
4a6ee685
BT		 843 /* MosArt panels */
844 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
845 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
846 USB_DEVICE_ID_ASUS_T91MT)},
847 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
848 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
849 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
850 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
851 HID_USB_DEVICE(USB_VENDOR_ID_TURBOX,
852 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
853
6ab3a9a6
JS		 854 /* PenMount panels */
855 { .driver_data = MT_CLS_CONFIDENCE,
856 HID_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
857 USB_DEVICE_ID_PENMOUNT_PCI) },
858
b7ea95ff
AT		 859 /* PixArt optical touch screen */
860 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
861 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
862 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN) },
863 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
864 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
865 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1) },
866 { .driver_data = MT_CLS_INRANGE_CONTACTNUMBER,
867 HID_USB_DEVICE(USB_VENDOR_ID_PIXART,
868 USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2) },
869
5519cab4 870 /* PixCir-based panels */
1e9cf35b 871 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
5519cab4
BT		 872 HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
873 USB_DEVICE_ID_HANVON_MULTITOUCH) },
1e9cf35b 874 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
5519cab4
BT		 875 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
876 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
877
5e7ea11f
BT		 878 /* Quanta-based panels */
879 { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
880 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
881 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },
882 { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
883 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
884 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001) },
885 { .driver_data = MT_CLS_CONFIDENCE_CONTACT_ID,
886 HID_USB_DEVICE(USB_VENDOR_ID_QUANTA,
887 USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008) },
888
043b403a 889 /* Stantum panels */
bf5af9b5 890 { .driver_data = MT_CLS_CONFIDENCE,
043b403a
BT		 891 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
892 USB_DEVICE_ID_MTP)},
bf5af9b5 893 { .driver_data = MT_CLS_CONFIDENCE,
85a60082 894 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM_STM,
043b403a 895 USB_DEVICE_ID_MTP_STM)},
bf5af9b5 896 { .driver_data = MT_CLS_CONFIDENCE,
85a60082 897 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM_SITRONIX,
043b403a
BT		 898 USB_DEVICE_ID_MTP_SITRONIX)},
899
5e74e56d
BT		 900 /* Touch International panels */
901 { .driver_data = MT_CLS_DEFAULT,
902 HID_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
903 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
904
617b64f9
BT		 905 /* Unitec panels */
906 { .driver_data = MT_CLS_DEFAULT,
907 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
908 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
909 { .driver_data = MT_CLS_DEFAULT,
910 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
911 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
bc8a2a9b 912 /* XAT */
913 { .driver_data = MT_CLS_DEFAULT,
914 HID_USB_DEVICE(USB_VENDOR_ID_XAT,
915 USB_DEVICE_ID_XAT_CSR) },
617b64f9 916
11576c61
MH		 917 /* Xiroku */
918 { .driver_data = MT_CLS_DEFAULT,
919 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
920 USB_DEVICE_ID_XIROKU_SPX) },
921 { .driver_data = MT_CLS_DEFAULT,
922 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
923 USB_DEVICE_ID_XIROKU_MPX) },
924 { .driver_data = MT_CLS_DEFAULT,
925 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
926 USB_DEVICE_ID_XIROKU_CSR) },
927 { .driver_data = MT_CLS_DEFAULT,
928 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
929 USB_DEVICE_ID_XIROKU_SPX1) },
930 { .driver_data = MT_CLS_DEFAULT,
931 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
932 USB_DEVICE_ID_XIROKU_MPX1) },
933 { .driver_data = MT_CLS_DEFAULT,
934 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
935 USB_DEVICE_ID_XIROKU_CSR1) },
936 { .driver_data = MT_CLS_DEFAULT,
937 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
938 USB_DEVICE_ID_XIROKU_SPX2) },
939 { .driver_data = MT_CLS_DEFAULT,
940 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
941 USB_DEVICE_ID_XIROKU_MPX2) },
942 { .driver_data = MT_CLS_DEFAULT,
943 HID_USB_DEVICE(USB_VENDOR_ID_XIROKU,
944 USB_DEVICE_ID_XIROKU_CSR2) },
945
5519cab4
BT		 946 { }
947};
948MODULE_DEVICE_TABLE(hid, mt_devices);
949
950static const struct hid_usage_id mt_grabbed_usages[] = {
951 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
952 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
953};
954
955static struct hid_driver mt_driver = {
956 .name = "hid-multitouch",
957 .id_table = mt_devices,
958 .probe = mt_probe,
959 .remove = mt_remove,
960 .input_mapping = mt_input_mapping,
961 .input_mapped = mt_input_mapped,
962 .feature_mapping = mt_feature_mapping,
963 .usage_table = mt_grabbed_usages,
964 .event = mt_event,
965#ifdef CONFIG_PM
966 .reset_resume = mt_reset_resume,
967#endif
968};
969
970static int __init mt_init(void)
971{
972 return hid_register_driver(&mt_driver);
973}
974
975static void __exit mt_exit(void)
976{
977 hid_unregister_driver(&mt_driver);
978}
979
980module_init(mt_init);
981module_exit(mt_exit);
Linux 6.x block layer and io_uring tree(s)