blob: 65b92d2bf759849ef9de4499ac23a66e3eecdfd7 [file] [log] [blame]
Benjamin Tissoires5519cab2011-01-07 23:45:50 +01001/*
2 * HID driver for multitouch panels
3 *
4 * Copyright (c) 2010-2011 Stephane Chatty <chatty@enac.fr>
5 * Copyright (c) 2010-2011 Benjamin Tissoires <benjamin.tissoires@gmail.com>
6 * Copyright (c) 2010-2011 Ecole Nationale de l'Aviation Civile, France
7 *
Richard Nauber4875ac12011-03-09 06:20:57 +01008 * 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 *
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +010014 * 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 *
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010020 */
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>");
Benjamin Tissoiresef2fafb2011-01-31 11:28:21 +010039MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010040MODULE_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)
Benjamin Tissoires2d936662011-01-11 16:45:54 +010048#define MT_QUIRK_CYPRESS (1 << 2)
Benjamin Tissoires5572da02011-01-07 23:47:27 +010049#define MT_QUIRK_SLOT_IS_CONTACTNUMBER (1 << 3)
Benjamin Tissoires2d936662011-01-11 16:45:54 +010050#define MT_QUIRK_VALID_IS_INRANGE (1 << 4)
51#define MT_QUIRK_VALID_IS_CONFIDENCE (1 << 5)
Richard Nauber4875ac12011-03-09 06:20:57 +010052#define MT_QUIRK_EGALAX_XYZ_FIXUP (1 << 6)
Benjamin Tissoires4a6ee682011-04-22 11:51:48 +020053#define MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE (1 << 7)
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010054
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
62struct mt_device {
63 struct mt_slot curdata; /* placeholder of incoming data */
64 struct mt_class *mtclass; /* our mt device class */
65 unsigned last_field_index; /* last field index of the report */
66 unsigned last_slot_field; /* the last field of a slot */
67 __s8 inputmode; /* InputMode HID feature, -1 if non-existent */
68 __u8 num_received; /* how many contacts we received */
69 __u8 num_expected; /* expected last contact index */
Benjamin Tissoires9498f952011-03-18 14:27:52 +010070 __u8 maxcontacts;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010071 bool curvalid; /* is the current contact valid? */
Benjamin Tissoires9498f952011-03-18 14:27:52 +010072 struct mt_slot *slots;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010073};
74
75struct mt_class {
Benjamin Tissoires2d936662011-01-11 16:45:54 +010076 __s32 name; /* MT_CLS */
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010077 __s32 quirks;
78 __s32 sn_move; /* Signal/noise ratio for move events */
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +010079 __s32 sn_width; /* Signal/noise ratio for width events */
80 __s32 sn_height; /* Signal/noise ratio for height events */
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010081 __s32 sn_pressure; /* Signal/noise ratio for pressure events */
82 __u8 maxcontacts;
83};
84
85/* classes of device behavior */
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +010086#define MT_CLS_DEFAULT 1
87#define MT_CLS_DUAL_INRANGE_CONTACTID 2
88#define MT_CLS_DUAL_INRANGE_CONTACTNUMBER 3
89#define MT_CLS_CYPRESS 4
Richard Nauber4875ac12011-03-09 06:20:57 +010090#define MT_CLS_EGALAX 5
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +010091#define MT_CLS_3M 7
John Sung6ab3a9a2011-04-21 16:21:52 +020092#define MT_CLS_CONFIDENCE 8
Benjamin Tissoires4a6ee682011-04-22 11:51:48 +020093#define MT_CLS_CONFIDENCE_MINUS_ONE 9
Benjamin Tissoiresc04abee2011-05-19 11:37:29 +020094#define MT_CLS_DUAL_NSMU_CONTACTID 10
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010095
Benjamin Tissoires9498f952011-03-18 14:27:52 +010096#define MT_DEFAULT_MAXCONTACT 10
97
Benjamin Tissoires5519cab2011-01-07 23:45:50 +010098/*
99 * these device-dependent functions determine what slot corresponds
100 * to a valid contact that was just read.
101 */
102
Benjamin Tissoiresa3b5e572011-01-07 23:46:30 +0100103static int cypress_compute_slot(struct mt_device *td)
104{
105 if (td->curdata.contactid != 0 || td->num_received == 0)
106 return td->curdata.contactid;
107 else
108 return -1;
109}
110
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100111static int find_slot_from_contactid(struct mt_device *td)
112{
113 int i;
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100114 for (i = 0; i < td->maxcontacts; ++i) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100115 if (td->slots[i].contactid == td->curdata.contactid &&
116 td->slots[i].touch_state)
117 return i;
118 }
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100119 for (i = 0; i < td->maxcontacts; ++i) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100120 if (!td->slots[i].seen_in_this_frame &&
121 !td->slots[i].touch_state)
122 return i;
123 }
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100124 /* should not occurs. If this happens that means
125 * that the device sent more touches that it says
126 * in the report descriptor. It is ignored then. */
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100127 return -1;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100128}
129
130struct mt_class mt_classes[] = {
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100131 { .name = MT_CLS_DEFAULT,
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100132 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP },
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +0100133 { .name = MT_CLS_DUAL_INRANGE_CONTACTID,
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100134 .quirks = MT_QUIRK_VALID_IS_INRANGE |
135 MT_QUIRK_SLOT_IS_CONTACTID,
136 .maxcontacts = 2 },
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +0100137 { .name = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100138 .quirks = MT_QUIRK_VALID_IS_INRANGE |
139 MT_QUIRK_SLOT_IS_CONTACTNUMBER,
140 .maxcontacts = 2 },
141 { .name = MT_CLS_CYPRESS,
142 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
143 MT_QUIRK_CYPRESS,
144 .maxcontacts = 10 },
Benjamin Tissoires4a6ee682011-04-22 11:51:48 +0200145 { .name = MT_CLS_CONFIDENCE_MINUS_ONE,
146 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
147 MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE },
Richard Nauber4875ac12011-03-09 06:20:57 +0100148 { .name = MT_CLS_EGALAX,
149 .quirks = MT_QUIRK_SLOT_IS_CONTACTID |
150 MT_QUIRK_VALID_IS_INRANGE |
151 MT_QUIRK_EGALAX_XYZ_FIXUP,
152 .maxcontacts = 2,
153 .sn_move = 4096,
154 .sn_pressure = 32,
155 },
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100156 { .name = MT_CLS_3M,
157 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE |
158 MT_QUIRK_SLOT_IS_CONTACTID,
159 .sn_move = 2048,
160 .sn_width = 128,
161 .sn_height = 128 },
John Sung6ab3a9a2011-04-21 16:21:52 +0200162 { .name = MT_CLS_CONFIDENCE,
163 .quirks = MT_QUIRK_VALID_IS_CONFIDENCE },
Benjamin Tissoiresc04abee2011-05-19 11:37:29 +0200164 { .name = MT_CLS_DUAL_NSMU_CONTACTID,
165 .quirks = MT_QUIRK_NOT_SEEN_MEANS_UP |
166 MT_QUIRK_SLOT_IS_CONTACTID,
167 .maxcontacts = 2 },
Benjamin Tissoires043b4032011-03-18 14:27:53 +0100168
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100169 { }
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100170};
171
Henrik Rydbergf635bd12011-02-24 19:30:59 +0100172static void mt_feature_mapping(struct hid_device *hdev,
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100173 struct hid_field *field, struct hid_usage *usage)
174{
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100175 struct mt_device *td = hid_get_drvdata(hdev);
176
177 switch (usage->hid) {
178 case HID_DG_INPUTMODE:
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100179 td->inputmode = field->report->id;
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100180 break;
181 case HID_DG_CONTACTMAX:
182 td->maxcontacts = field->value[0];
183 if (td->mtclass->maxcontacts)
184 /* check if the maxcontacts is given by the class */
185 td->maxcontacts = td->mtclass->maxcontacts;
186
187 break;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100188 }
189}
190
191static void set_abs(struct input_dev *input, unsigned int code,
192 struct hid_field *field, int snratio)
193{
194 int fmin = field->logical_minimum;
195 int fmax = field->logical_maximum;
196 int fuzz = snratio ? (fmax - fmin) / snratio : 0;
197 input_set_abs_params(input, code, fmin, fmax, fuzz, 0);
198}
199
200static int mt_input_mapping(struct hid_device *hdev, struct hid_input *hi,
201 struct hid_field *field, struct hid_usage *usage,
202 unsigned long **bit, int *max)
203{
204 struct mt_device *td = hid_get_drvdata(hdev);
205 struct mt_class *cls = td->mtclass;
Richard Nauber4875ac12011-03-09 06:20:57 +0100206 __s32 quirks = cls->quirks;
207
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100208 switch (usage->hid & HID_USAGE_PAGE) {
209
210 case HID_UP_GENDESK:
211 switch (usage->hid) {
212 case HID_GD_X:
Richard Nauber4875ac12011-03-09 06:20:57 +0100213 if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
214 field->logical_maximum = 32760;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100215 hid_map_usage(hi, usage, bit, max,
216 EV_ABS, ABS_MT_POSITION_X);
217 set_abs(hi->input, ABS_MT_POSITION_X, field,
218 cls->sn_move);
219 /* touchscreen emulation */
220 set_abs(hi->input, ABS_X, field, cls->sn_move);
221 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200222 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100223 return 1;
224 case HID_GD_Y:
Richard Nauber4875ac12011-03-09 06:20:57 +0100225 if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
226 field->logical_maximum = 32760;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100227 hid_map_usage(hi, usage, bit, max,
228 EV_ABS, ABS_MT_POSITION_Y);
229 set_abs(hi->input, ABS_MT_POSITION_Y, field,
230 cls->sn_move);
231 /* touchscreen emulation */
232 set_abs(hi->input, ABS_Y, field, cls->sn_move);
233 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200234 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100235 return 1;
236 }
237 return 0;
238
239 case HID_UP_DIGITIZER:
240 switch (usage->hid) {
241 case HID_DG_INRANGE:
242 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200243 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100244 return 1;
245 case HID_DG_CONFIDENCE:
246 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200247 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100248 return 1;
249 case HID_DG_TIPSWITCH:
250 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_TOUCH);
251 input_set_capability(hi->input, EV_KEY, BTN_TOUCH);
252 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200253 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100254 return 1;
255 case HID_DG_CONTACTID:
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100256 input_mt_init_slots(hi->input, td->maxcontacts);
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100257 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200258 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100259 return 1;
260 case HID_DG_WIDTH:
261 hid_map_usage(hi, usage, bit, max,
262 EV_ABS, ABS_MT_TOUCH_MAJOR);
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100263 set_abs(hi->input, ABS_MT_TOUCH_MAJOR, field,
264 cls->sn_width);
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100265 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200266 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100267 return 1;
268 case HID_DG_HEIGHT:
269 hid_map_usage(hi, usage, bit, max,
270 EV_ABS, ABS_MT_TOUCH_MINOR);
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100271 set_abs(hi->input, ABS_MT_TOUCH_MINOR, field,
272 cls->sn_height);
Benjamin Tissoires1e648a12011-03-18 14:27:55 +0100273 input_set_abs_params(hi->input,
274 ABS_MT_ORIENTATION, 0, 1, 0, 0);
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100275 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200276 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100277 return 1;
278 case HID_DG_TIPPRESSURE:
Richard Nauber4875ac12011-03-09 06:20:57 +0100279 if (quirks & MT_QUIRK_EGALAX_XYZ_FIXUP)
280 field->logical_minimum = 0;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100281 hid_map_usage(hi, usage, bit, max,
282 EV_ABS, ABS_MT_PRESSURE);
283 set_abs(hi->input, ABS_MT_PRESSURE, field,
284 cls->sn_pressure);
285 /* touchscreen emulation */
286 set_abs(hi->input, ABS_PRESSURE, field,
287 cls->sn_pressure);
288 td->last_slot_field = usage->hid;
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200289 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100290 return 1;
291 case HID_DG_CONTACTCOUNT:
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200292 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100293 return 1;
294 case HID_DG_CONTACTMAX:
295 /* we don't set td->last_slot_field as contactcount and
296 * contact max are global to the report */
Benjamin Tissoires2955cae2011-04-21 14:15:59 +0200297 td->last_field_index = field->index;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100298 return -1;
299 }
300 /* let hid-input decide for the others */
301 return 0;
302
303 case 0xff000000:
304 /* we do not want to map these: no input-oriented meaning */
305 return -1;
306 }
307
308 return 0;
309}
310
311static int mt_input_mapped(struct hid_device *hdev, struct hid_input *hi,
312 struct hid_field *field, struct hid_usage *usage,
313 unsigned long **bit, int *max)
314{
315 if (usage->type == EV_KEY || usage->type == EV_ABS)
316 set_bit(usage->type, hi->input->evbit);
317
318 return -1;
319}
320
321static int mt_compute_slot(struct mt_device *td)
322{
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100323 __s32 quirks = td->mtclass->quirks;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100324
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100325 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID)
326 return td->curdata.contactid;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100327
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100328 if (quirks & MT_QUIRK_CYPRESS)
Benjamin Tissoiresa3b5e572011-01-07 23:46:30 +0100329 return cypress_compute_slot(td);
330
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100331 if (quirks & MT_QUIRK_SLOT_IS_CONTACTNUMBER)
332 return td->num_received;
Benjamin Tissoires5572da02011-01-07 23:47:27 +0100333
Benjamin Tissoires4a6ee682011-04-22 11:51:48 +0200334 if (quirks & MT_QUIRK_SLOT_IS_CONTACTID_MINUS_ONE)
335 return td->curdata.contactid - 1;
336
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100337 return find_slot_from_contactid(td);
338}
339
340/*
341 * this function is called when a whole contact has been processed,
342 * so that it can assign it to a slot and store the data there
343 */
344static void mt_complete_slot(struct mt_device *td)
345{
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100346 td->curdata.seen_in_this_frame = true;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100347 if (td->curvalid) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100348 int slotnum = mt_compute_slot(td);
349
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100350 if (slotnum >= 0 && slotnum < td->maxcontacts)
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100351 td->slots[slotnum] = td->curdata;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100352 }
353 td->num_received++;
354}
355
356
357/*
358 * this function is called when a whole packet has been received and processed,
359 * so that it can decide what to send to the input layer.
360 */
361static void mt_emit_event(struct mt_device *td, struct input_dev *input)
362{
363 int i;
364
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100365 for (i = 0; i < td->maxcontacts; ++i) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100366 struct mt_slot *s = &(td->slots[i]);
367 if ((td->mtclass->quirks & MT_QUIRK_NOT_SEEN_MEANS_UP) &&
368 !s->seen_in_this_frame) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100369 s->touch_state = false;
370 }
371
372 input_mt_slot(input, i);
373 input_mt_report_slot_state(input, MT_TOOL_FINGER,
374 s->touch_state);
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100375 if (s->touch_state) {
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100376 /* this finger is on the screen */
377 int wide = (s->w > s->h);
378 /* divided by two to match visual scale of touch */
379 int major = max(s->w, s->h) >> 1;
380 int minor = min(s->w, s->h) >> 1;
381
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100382 input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
383 input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100384 input_event(input, EV_ABS, ABS_MT_ORIENTATION, wide);
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100385 input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100386 input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
387 input_event(input, EV_ABS, ABS_MT_TOUCH_MINOR, minor);
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100388 }
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100389 s->seen_in_this_frame = false;
390
391 }
392
393 input_mt_report_pointer_emulation(input, true);
394 input_sync(input);
395 td->num_received = 0;
396}
397
398
399
400static int mt_event(struct hid_device *hid, struct hid_field *field,
401 struct hid_usage *usage, __s32 value)
402{
403 struct mt_device *td = hid_get_drvdata(hid);
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100404 __s32 quirks = td->mtclass->quirks;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100405
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100406 if (hid->claimed & HID_CLAIMED_INPUT && td->slots) {
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100407 switch (usage->hid) {
408 case HID_DG_INRANGE:
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100409 if (quirks & MT_QUIRK_VALID_IS_INRANGE)
410 td->curvalid = value;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100411 break;
412 case HID_DG_TIPSWITCH:
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100413 if (quirks & MT_QUIRK_NOT_SEEN_MEANS_UP)
414 td->curvalid = value;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100415 td->curdata.touch_state = value;
416 break;
417 case HID_DG_CONFIDENCE:
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100418 if (quirks & MT_QUIRK_VALID_IS_CONFIDENCE)
419 td->curvalid = value;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100420 break;
421 case HID_DG_CONTACTID:
422 td->curdata.contactid = value;
423 break;
424 case HID_DG_TIPPRESSURE:
425 td->curdata.p = value;
426 break;
427 case HID_GD_X:
428 td->curdata.x = value;
429 break;
430 case HID_GD_Y:
431 td->curdata.y = value;
432 break;
433 case HID_DG_WIDTH:
434 td->curdata.w = value;
435 break;
436 case HID_DG_HEIGHT:
437 td->curdata.h = value;
438 break;
439 case HID_DG_CONTACTCOUNT:
440 /*
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100441 * Includes multi-packet support where subsequent
442 * packets are sent with zero contactcount.
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100443 */
444 if (value)
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100445 td->num_expected = value;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100446 break;
447
448 default:
449 /* fallback to the generic hidinput handling */
450 return 0;
451 }
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100452
Henrik Rydbergf153fc32011-03-09 06:35:25 +0100453 if (usage->hid == td->last_slot_field) {
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100454 mt_complete_slot(td);
Henrik Rydbergf153fc32011-03-09 06:35:25 +0100455 }
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100456
457 if (field->index == td->last_field_index
458 && td->num_received >= td->num_expected)
459 mt_emit_event(td, field->hidinput->input);
460
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100461 }
462
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100463 /* we have handled the hidinput part, now remains hiddev */
464 if (hid->claimed & HID_CLAIMED_HIDDEV && hid->hiddev_hid_event)
465 hid->hiddev_hid_event(hid, field, usage, value);
466
467 return 1;
468}
469
470static void mt_set_input_mode(struct hid_device *hdev)
471{
472 struct mt_device *td = hid_get_drvdata(hdev);
473 struct hid_report *r;
474 struct hid_report_enum *re;
475
476 if (td->inputmode < 0)
477 return;
478
479 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
480 r = re->report_id_hash[td->inputmode];
481 if (r) {
482 r->field[0]->value[0] = 0x02;
483 usbhid_submit_report(hdev, r, USB_DIR_OUT);
484 }
485}
486
487static int mt_probe(struct hid_device *hdev, const struct hid_device_id *id)
488{
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100489 int ret, i;
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100490 struct mt_device *td;
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100491 struct mt_class *mtclass = mt_classes; /* MT_CLS_DEFAULT */
492
493 for (i = 0; mt_classes[i].name ; i++) {
494 if (id->driver_data == mt_classes[i].name) {
495 mtclass = &(mt_classes[i]);
496 break;
497 }
498 }
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100499
500 /* This allows the driver to correctly support devices
501 * that emit events over several HID messages.
502 */
503 hdev->quirks |= HID_QUIRK_NO_INPUT_SYNC;
504
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100505 td = kzalloc(sizeof(struct mt_device), GFP_KERNEL);
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100506 if (!td) {
507 dev_err(&hdev->dev, "cannot allocate multitouch data\n");
508 return -ENOMEM;
509 }
510 td->mtclass = mtclass;
511 td->inputmode = -1;
512 hid_set_drvdata(hdev, td);
513
514 ret = hid_parse(hdev);
515 if (ret != 0)
516 goto fail;
517
518 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
Benjamin Tissoires2d936662011-01-11 16:45:54 +0100519 if (ret)
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100520 goto fail;
521
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100522 if (!td->maxcontacts)
523 td->maxcontacts = MT_DEFAULT_MAXCONTACT;
524
525 td->slots = kzalloc(td->maxcontacts * sizeof(struct mt_slot),
526 GFP_KERNEL);
527 if (!td->slots) {
528 dev_err(&hdev->dev, "cannot allocate multitouch slots\n");
529 hid_hw_stop(hdev);
530 ret = -ENOMEM;
531 goto fail;
532 }
533
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100534 mt_set_input_mode(hdev);
535
536 return 0;
537
538fail:
539 kfree(td);
540 return ret;
541}
542
543#ifdef CONFIG_PM
544static int mt_reset_resume(struct hid_device *hdev)
545{
546 mt_set_input_mode(hdev);
547 return 0;
548}
549#endif
550
551static void mt_remove(struct hid_device *hdev)
552{
553 struct mt_device *td = hid_get_drvdata(hdev);
554 hid_hw_stop(hdev);
Benjamin Tissoires9498f952011-03-18 14:27:52 +0100555 kfree(td->slots);
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100556 kfree(td);
557 hid_set_drvdata(hdev, NULL);
558}
559
560static const struct hid_device_id mt_devices[] = {
561
Benjamin Tissoiresf786bba2011-03-22 17:34:01 +0100562 /* 3M panels */
563 { .driver_data = MT_CLS_3M,
564 HID_USB_DEVICE(USB_VENDOR_ID_3M,
565 USB_DEVICE_ID_3M1968) },
566 { .driver_data = MT_CLS_3M,
567 HID_USB_DEVICE(USB_VENDOR_ID_3M,
568 USB_DEVICE_ID_3M2256) },
569
Benjamin Tissoirese6aac342011-05-19 14:18:13 +0200570 /* ActionStar panels */
571 { .driver_data = MT_CLS_DEFAULT,
572 HID_USB_DEVICE(USB_VENDOR_ID_ACTIONSTAR,
573 USB_DEVICE_ID_ACTIONSTAR_1011) },
574
Benjamin Tissoiresa841b622011-03-18 14:27:54 +0100575 /* Cando panels */
576 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
577 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
578 USB_DEVICE_ID_CANDO_MULTI_TOUCH) },
579 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
580 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
581 USB_DEVICE_ID_CANDO_MULTI_TOUCH_10_1) },
582 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
583 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
584 USB_DEVICE_ID_CANDO_MULTI_TOUCH_11_6) },
585 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
586 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
587 USB_DEVICE_ID_CANDO_MULTI_TOUCH_15_6) },
588
Benjamin Tissoires79603dc2011-05-19 14:18:14 +0200589 /* CVTouch panels */
590 { .driver_data = MT_CLS_DEFAULT,
591 HID_USB_DEVICE(USB_VENDOR_ID_CVTOUCH,
592 USB_DEVICE_ID_CVTOUCH_SCREEN) },
593
Benjamin Tissoiresa3b5e572011-01-07 23:46:30 +0100594 /* Cypress panel */
595 { .driver_data = MT_CLS_CYPRESS,
596 HID_USB_DEVICE(USB_VENDOR_ID_CYPRESS,
597 USB_DEVICE_ID_CYPRESS_TRUETOUCH) },
598
Benjamin Tissoiresc04abee2011-05-19 11:37:29 +0200599 /* Elo TouchSystems IntelliTouch Plus panel */
600 { .driver_data = MT_CLS_DUAL_NSMU_CONTACTID,
601 HID_USB_DEVICE(USB_VENDOR_ID_ELO,
602 USB_DEVICE_ID_ELO_TS2515) },
603
Benjamin Tissoires5572da02011-01-07 23:47:27 +0100604 /* GeneralTouch panel */
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +0100605 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTNUMBER,
Benjamin Tissoires5572da02011-01-07 23:47:27 +0100606 HID_USB_DEVICE(USB_VENDOR_ID_GENERAL_TOUCH,
607 USB_DEVICE_ID_GENERAL_TOUCH_WIN7_TWOFINGERS) },
608
Benjamin Tissoiresee0fbd12011-05-19 14:18:15 +0200609 /* GoodTouch panels */
610 { .driver_data = MT_CLS_DEFAULT,
611 HID_USB_DEVICE(USB_VENDOR_ID_GOODTOUCH,
612 USB_DEVICE_ID_GOODTOUCH_000f) },
613
Austin Zhang4e61f0d2011-05-09 23:54:14 +0800614 /* Ilitek dual touch panel */
615 { .driver_data = MT_CLS_DEFAULT,
616 HID_USB_DEVICE(USB_VENDOR_ID_ILITEK,
617 USB_DEVICE_ID_ILITEK_MULTITOUCH) },
618
Benjamin Tissoires4dfcced2011-01-31 11:28:22 +0100619 /* IRTOUCH panels */
620 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
621 HID_USB_DEVICE(USB_VENDOR_ID_IRTOUCHSYSTEMS,
622 USB_DEVICE_ID_IRTOUCH_INFRARED_USB) },
623
Benjamin Tissoiresdf167c42011-05-18 15:27:24 +0200624 /* Lumio panels */
625 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
626 HID_USB_DEVICE(USB_VENDOR_ID_LUMIO,
627 USB_DEVICE_ID_CRYSTALTOUCH) },
628
Benjamin Tissoires4a6ee682011-04-22 11:51:48 +0200629 /* MosArt panels */
630 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
631 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
632 USB_DEVICE_ID_ASUS_T91MT)},
633 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
634 HID_USB_DEVICE(USB_VENDOR_ID_ASUS,
635 USB_DEVICE_ID_ASUSTEK_MULTITOUCH_YFO) },
636 { .driver_data = MT_CLS_CONFIDENCE_MINUS_ONE,
637 HID_USB_DEVICE(USB_VENDOR_ID_TURBOX,
638 USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART) },
639
John Sung6ab3a9a2011-04-21 16:21:52 +0200640 /* PenMount panels */
641 { .driver_data = MT_CLS_CONFIDENCE,
642 HID_USB_DEVICE(USB_VENDOR_ID_PENMOUNT,
643 USB_DEVICE_ID_PENMOUNT_PCI) },
644
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100645 /* PixCir-based panels */
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +0100646 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100647 HID_USB_DEVICE(USB_VENDOR_ID_HANVON,
648 USB_DEVICE_ID_HANVON_MULTITOUCH) },
Benjamin Tissoires1e9cf352011-01-31 11:28:20 +0100649 { .driver_data = MT_CLS_DUAL_INRANGE_CONTACTID,
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100650 HID_USB_DEVICE(USB_VENDOR_ID_CANDO,
651 USB_DEVICE_ID_CANDO_PIXCIR_MULTI_TOUCH) },
652
Richard Nauber4875ac12011-03-09 06:20:57 +0100653 /* Resistive eGalax devices */
654 { .driver_data = MT_CLS_EGALAX,
655 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
656 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH) },
657 { .driver_data = MT_CLS_EGALAX,
658 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
659 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH3) },
660
661 /* Capacitive eGalax devices */
662 { .driver_data = MT_CLS_EGALAX,
663 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
664 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH1) },
665 { .driver_data = MT_CLS_EGALAX,
666 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
667 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH2) },
668 { .driver_data = MT_CLS_EGALAX,
669 HID_USB_DEVICE(USB_VENDOR_ID_DWAV,
670 USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH4) },
671
Benjamin Tissoires043b4032011-03-18 14:27:53 +0100672 /* Stantum panels */
Benjamin Tissoiresbf5af9b2011-05-19 14:18:18 +0200673 { .driver_data = MT_CLS_CONFIDENCE,
Benjamin Tissoires043b4032011-03-18 14:27:53 +0100674 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
675 USB_DEVICE_ID_MTP)},
Benjamin Tissoiresbf5af9b2011-05-19 14:18:18 +0200676 { .driver_data = MT_CLS_CONFIDENCE,
Benjamin Tissoires043b4032011-03-18 14:27:53 +0100677 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
678 USB_DEVICE_ID_MTP_STM)},
Benjamin Tissoiresbf5af9b2011-05-19 14:18:18 +0200679 { .driver_data = MT_CLS_CONFIDENCE,
Benjamin Tissoires043b4032011-03-18 14:27:53 +0100680 HID_USB_DEVICE(USB_VENDOR_ID_STANTUM,
681 USB_DEVICE_ID_MTP_SITRONIX)},
682
Benjamin Tissoires5e74e562011-05-19 14:18:16 +0200683 /* Touch International panels */
684 { .driver_data = MT_CLS_DEFAULT,
685 HID_USB_DEVICE(USB_VENDOR_ID_TOUCH_INTL,
686 USB_DEVICE_ID_TOUCH_INTL_MULTI_TOUCH) },
687
Benjamin Tissoires617b64f2011-05-19 14:18:17 +0200688 /* Unitec panels */
689 { .driver_data = MT_CLS_DEFAULT,
690 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
691 USB_DEVICE_ID_UNITEC_USB_TOUCH_0709) },
692 { .driver_data = MT_CLS_DEFAULT,
693 HID_USB_DEVICE(USB_VENDOR_ID_UNITEC,
694 USB_DEVICE_ID_UNITEC_USB_TOUCH_0A19) },
695
Benjamin Tissoires5519cab2011-01-07 23:45:50 +0100696 { }
697};
698MODULE_DEVICE_TABLE(hid, mt_devices);
699
700static const struct hid_usage_id mt_grabbed_usages[] = {
701 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
702 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
703};
704
705static struct hid_driver mt_driver = {
706 .name = "hid-multitouch",
707 .id_table = mt_devices,
708 .probe = mt_probe,
709 .remove = mt_remove,
710 .input_mapping = mt_input_mapping,
711 .input_mapped = mt_input_mapped,
712 .feature_mapping = mt_feature_mapping,
713 .usage_table = mt_grabbed_usages,
714 .event = mt_event,
715#ifdef CONFIG_PM
716 .reset_resume = mt_reset_resume,
717#endif
718};
719
720static int __init mt_init(void)
721{
722 return hid_register_driver(&mt_driver);
723}
724
725static void __exit mt_exit(void)
726{
727 hid_unregister_driver(&mt_driver);
728}
729
730module_init(mt_init);
731module_exit(mt_exit);