Merge branch 'bkl/procfs' of git://git.kernel.org/pub/scm/linux/kernel/git/frederic...
[linux-2.6-block.git] / drivers / hid / hid-ntrig.c
CommitLineData
94011f93 1/*
57fd637a 2 * HID driver for N-Trig touchscreens
94011f93 3 *
6549981b
SC
4 * Copyright (c) 2008-2010 Rafi Rubin
5 * Copyright (c) 2009-2010 Stephane Chatty
94011f93
RR
6 *
7 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
13 * any later version.
14 */
15
16#include <linux/device.h>
17#include <linux/hid.h>
6549981b
SC
18#include <linux/usb.h>
19#include "usbhid/usbhid.h"
94011f93 20#include <linux/module.h>
5a0e3ad6 21#include <linux/slab.h>
94011f93
RR
22
23#include "hid-ids.h"
24
25#define NTRIG_DUPLICATE_USAGES 0x001
26
57fd637a 27struct ntrig_data {
dbf2b17d
RR
28 /* Incoming raw values for a single contact */
29 __u16 x, y, w, h;
30 __u16 id;
250d3775
RR
31
32 bool tipswitch;
33 bool confidence;
34 bool first_contact_touch;
dbf2b17d
RR
35
36 bool reading_mt;
dbf2b17d
RR
37
38 __u8 mt_footer[4];
39 __u8 mt_foot_count;
57fd637a
SC
40};
41
42/*
43 * this driver is aimed at two firmware versions in circulation:
44 * - dual pen/finger single touch
45 * - finger multitouch, pen not working
46 */
47
94011f93
RR
48static int ntrig_input_mapping(struct hid_device *hdev, struct hid_input *hi,
49 struct hid_field *field, struct hid_usage *usage,
50 unsigned long **bit, int *max)
51{
dbf2b17d
RR
52 /* No special mappings needed for the pen and single touch */
53 if (field->physical)
943ed464
RR
54 return 0;
55
57fd637a 56 switch (usage->hid & HID_USAGE_PAGE) {
57fd637a
SC
57 case HID_UP_GENDESK:
58 switch (usage->hid) {
59 case HID_GD_X:
60 hid_map_usage(hi, usage, bit, max,
61 EV_ABS, ABS_MT_POSITION_X);
62 input_set_abs_params(hi->input, ABS_X,
63 field->logical_minimum,
64 field->logical_maximum, 0, 0);
65 return 1;
66 case HID_GD_Y:
67 hid_map_usage(hi, usage, bit, max,
68 EV_ABS, ABS_MT_POSITION_Y);
69 input_set_abs_params(hi->input, ABS_Y,
70 field->logical_minimum,
71 field->logical_maximum, 0, 0);
72 return 1;
73 }
74 return 0;
75
76 case HID_UP_DIGITIZER:
77 switch (usage->hid) {
78 /* we do not want to map these for now */
dbf2b17d 79 case HID_DG_CONTACTID: /* Not trustworthy, squelch for now */
57fd637a
SC
80 case HID_DG_INPUTMODE:
81 case HID_DG_DEVICEINDEX:
57fd637a
SC
82 case HID_DG_CONTACTMAX:
83 return -1;
84
57fd637a
SC
85 /* width/height mapped on TouchMajor/TouchMinor/Orientation */
86 case HID_DG_WIDTH:
87 hid_map_usage(hi, usage, bit, max,
88 EV_ABS, ABS_MT_TOUCH_MAJOR);
89 return 1;
90 case HID_DG_HEIGHT:
91 hid_map_usage(hi, usage, bit, max,
92 EV_ABS, ABS_MT_TOUCH_MINOR);
93 input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
94 0, 1, 0, 0);
95 return 1;
96 }
97 return 0;
98
99 case 0xff000000:
100 /* we do not want to map these: no input-oriented meaning */
101 return -1;
94011f93 102 }
57fd637a 103
94011f93
RR
104 return 0;
105}
106
107static int ntrig_input_mapped(struct hid_device *hdev, struct hid_input *hi,
108 struct hid_field *field, struct hid_usage *usage,
109 unsigned long **bit, int *max)
110{
dbf2b17d
RR
111 /* No special mappings needed for the pen and single touch */
112 if (field->physical)
943ed464 113 return 0;
b0549cf1 114
94011f93
RR
115 if (usage->type == EV_KEY || usage->type == EV_REL
116 || usage->type == EV_ABS)
117 clear_bit(usage->code, *bit);
118
119 return 0;
120}
57fd637a
SC
121
122/*
123 * this function is called upon all reports
124 * so that we can filter contact point information,
125 * decide whether we are in multi or single touch mode
126 * and call input_mt_sync after each point if necessary
127 */
128static int ntrig_event (struct hid_device *hid, struct hid_field *field,
129 struct hid_usage *usage, __s32 value)
130{
131 struct input_dev *input = field->hidinput->input;
132 struct ntrig_data *nd = hid_get_drvdata(hid);
133
943ed464
RR
134 /* No special handling needed for the pen */
135 if (field->application == HID_DG_PEN)
136 return 0;
137
57fd637a
SC
138 if (hid->claimed & HID_CLAIMED_INPUT) {
139 switch (usage->hid) {
dbf2b17d
RR
140 case 0xff000001:
141 /* Tag indicating the start of a multitouch group */
142 nd->reading_mt = 1;
250d3775 143 nd->first_contact_touch = 0;
dbf2b17d 144 break;
2886539d 145 case HID_DG_TIPSWITCH:
250d3775 146 nd->tipswitch = value;
2886539d
RR
147 /* Prevent emission of touch until validated */
148 return 1;
dbf2b17d
RR
149 case HID_DG_CONFIDENCE:
150 nd->confidence = value;
151 break;
57fd637a
SC
152 case HID_GD_X:
153 nd->x = value;
dbf2b17d
RR
154 /* Clear the contact footer */
155 nd->mt_foot_count = 0;
57fd637a
SC
156 break;
157 case HID_GD_Y:
158 nd->y = value;
159 break;
160 case HID_DG_CONTACTID:
161 nd->id = value;
57fd637a
SC
162 break;
163 case HID_DG_WIDTH:
164 nd->w = value;
165 break;
166 case HID_DG_HEIGHT:
167 nd->h = value;
168 /*
169 * when in single touch mode, this is the last
170 * report received in a finger event. We want
171 * to emit a normal (X, Y) position
172 */
dbf2b17d 173 if (!nd->reading_mt) {
250d3775
RR
174 /*
175 * TipSwitch indicates the presence of a
176 * finger in single touch mode.
177 */
2170c5a8 178 input_report_key(input, BTN_TOUCH,
250d3775
RR
179 nd->tipswitch);
180 input_report_key(input, BTN_TOOL_DOUBLETAP,
181 nd->tipswitch);
57fd637a
SC
182 input_event(input, EV_ABS, ABS_X, nd->x);
183 input_event(input, EV_ABS, ABS_Y, nd->y);
57fd637a
SC
184 }
185 break;
186 case 0xff000002:
187 /*
188 * we receive this when the device is in multitouch
189 * mode. The first of the three values tagged with
190 * this usage tells if the contact point is real
191 * or a placeholder
192 */
dbf2b17d
RR
193
194 /* Shouldn't get more than 4 footer packets, so skip */
195 if (nd->mt_foot_count >= 4)
196 break;
197
198 nd->mt_footer[nd->mt_foot_count++] = value;
199
200 /* if the footer isn't complete break */
201 if (nd->mt_foot_count != 4)
202 break;
203
204 /* Pen activity signal, trigger end of touch. */
205 if (nd->mt_footer[2]) {
206 nd->confidence = 0;
57fd637a 207 break;
dbf2b17d
RR
208 }
209
210 /* If the contact was invalid */
211 if (!(nd->confidence && nd->mt_footer[0])
212 || nd->w <= 250
213 || nd->h <= 190) {
214 nd->confidence = 0;
215 break;
216 }
217
57fd637a
SC
218 /* emit a normal (X, Y) for the first point only */
219 if (nd->id == 0) {
250d3775
RR
220 /*
221 * TipSwitch is superfluous in multitouch
222 * mode. The footer events tell us
223 * if there is a finger on the screen or
224 * not.
225 */
226 nd->first_contact_touch = nd->confidence;
57fd637a
SC
227 input_event(input, EV_ABS, ABS_X, nd->x);
228 input_event(input, EV_ABS, ABS_Y, nd->y);
229 }
230 input_event(input, EV_ABS, ABS_MT_POSITION_X, nd->x);
231 input_event(input, EV_ABS, ABS_MT_POSITION_Y, nd->y);
232 if (nd->w > nd->h) {
233 input_event(input, EV_ABS,
234 ABS_MT_ORIENTATION, 1);
235 input_event(input, EV_ABS,
236 ABS_MT_TOUCH_MAJOR, nd->w);
237 input_event(input, EV_ABS,
238 ABS_MT_TOUCH_MINOR, nd->h);
239 } else {
240 input_event(input, EV_ABS,
241 ABS_MT_ORIENTATION, 0);
242 input_event(input, EV_ABS,
243 ABS_MT_TOUCH_MAJOR, nd->h);
244 input_event(input, EV_ABS,
245 ABS_MT_TOUCH_MINOR, nd->w);
246 }
247 input_mt_sync(field->hidinput->input);
dbf2b17d
RR
248 break;
249
250 case HID_DG_CONTACTCOUNT: /* End of a multitouch group */
251 if (!nd->reading_mt)
252 break;
253
254 nd->reading_mt = 0;
255
250d3775 256 if (nd->first_contact_touch) {
ed7e2ca2 257 input_report_key(input, BTN_TOOL_DOUBLETAP, 1);
dbf2b17d
RR
258 input_report_key(input, BTN_TOUCH, 1);
259 } else {
ed7e2ca2 260 input_report_key(input, BTN_TOOL_DOUBLETAP, 0);
2886539d 261 input_report_key(input, BTN_TOUCH, 0);
dbf2b17d 262 }
57fd637a
SC
263 break;
264
265 default:
266 /* fallback to the generic hidinput handling */
267 return 0;
268 }
269 }
270
271 /* we have handled the hidinput part, now remains hiddev */
943ed464
RR
272 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_hid_event)
273 hid->hiddev_hid_event(hid, field, usage, value);
57fd637a
SC
274
275 return 1;
276}
277
278static int ntrig_probe(struct hid_device *hdev, const struct hid_device_id *id)
279{
280 int ret;
281 struct ntrig_data *nd;
943ed464
RR
282 struct hid_input *hidinput;
283 struct input_dev *input;
6549981b 284 struct hid_report *report;
943ed464
RR
285
286 if (id->driver_data)
287 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
57fd637a
SC
288
289 nd = kmalloc(sizeof(struct ntrig_data), GFP_KERNEL);
290 if (!nd) {
291 dev_err(&hdev->dev, "cannot allocate N-Trig data\n");
292 return -ENOMEM;
293 }
dbf2b17d
RR
294
295 nd->reading_mt = 0;
57fd637a
SC
296 hid_set_drvdata(hdev, nd);
297
298 ret = hid_parse(hdev);
943ed464
RR
299 if (ret) {
300 dev_err(&hdev->dev, "parse failed\n");
301 goto err_free;
302 }
303
304 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
305 if (ret) {
306 dev_err(&hdev->dev, "hw start failed\n");
307 goto err_free;
308 }
57fd637a 309
837b4753 310
943ed464 311 list_for_each_entry(hidinput, &hdev->inputs, list) {
2886539d
RR
312 if (hidinput->report->maxfield < 1)
313 continue;
314
943ed464
RR
315 input = hidinput->input;
316 switch (hidinput->report->field[0]->application) {
317 case HID_DG_PEN:
318 input->name = "N-Trig Pen";
319 break;
320 case HID_DG_TOUCHSCREEN:
2886539d
RR
321 /* These keys are redundant for fingers, clear them
322 * to prevent incorrect identification */
dbf2b17d 323 __clear_bit(BTN_TOOL_PEN, input->keybit);
2886539d
RR
324 __clear_bit(BTN_TOOL_FINGER, input->keybit);
325 __clear_bit(BTN_0, input->keybit);
dbf2b17d 326 __set_bit(BTN_TOOL_DOUBLETAP, input->keybit);
943ed464
RR
327 /*
328 * The physical touchscreen (single touch)
329 * input has a value for physical, whereas
330 * the multitouch only has logical input
331 * fields.
332 */
333 input->name =
334 (hidinput->report->field[0]
335 ->physical) ?
336 "N-Trig Touchscreen" :
337 "N-Trig MultiTouch";
338 break;
339 }
340 }
341
c0858552
JK
342 /* This is needed for devices with more recent firmware versions */
343 report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[0x0a];
6549981b
SC
344 if (report)
345 usbhid_submit_report(hdev, report, USB_DIR_OUT);
346
347
943ed464
RR
348 return 0;
349err_free:
350 kfree(nd);
57fd637a
SC
351 return ret;
352}
353
354static void ntrig_remove(struct hid_device *hdev)
355{
356 hid_hw_stop(hdev);
357 kfree(hid_get_drvdata(hdev));
358}
359
94011f93
RR
360static const struct hid_device_id ntrig_devices[] = {
361 { HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN),
362 .driver_data = NTRIG_DUPLICATE_USAGES },
363 { }
364};
365MODULE_DEVICE_TABLE(hid, ntrig_devices);
366
57fd637a
SC
367static const struct hid_usage_id ntrig_grabbed_usages[] = {
368 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
943ed464 369 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1 }
57fd637a
SC
370};
371
94011f93
RR
372static struct hid_driver ntrig_driver = {
373 .name = "ntrig",
374 .id_table = ntrig_devices,
57fd637a
SC
375 .probe = ntrig_probe,
376 .remove = ntrig_remove,
94011f93
RR
377 .input_mapping = ntrig_input_mapping,
378 .input_mapped = ntrig_input_mapped,
57fd637a
SC
379 .usage_table = ntrig_grabbed_usages,
380 .event = ntrig_event,
94011f93
RR
381};
382
a24f423b 383static int __init ntrig_init(void)
94011f93
RR
384{
385 return hid_register_driver(&ntrig_driver);
386}
387
a24f423b 388static void __exit ntrig_exit(void)
94011f93
RR
389{
390 hid_unregister_driver(&ntrig_driver);
391}
392
393module_init(ntrig_init);
394module_exit(ntrig_exit);
395MODULE_LICENSE("GPL");