2 * HID driver for N-Trig touchscreens
4 * Copyright (c) 2008 Rafi Rubin
5 * Copyright (c) 2009 Stephane Chatty
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)
16 #include <linux/device.h>
17 #include <linux/hid.h>
18 #include <linux/module.h>
22 #define NTRIG_DUPLICATE_USAGES 0x001
24 #define nt_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \
29 bool reading_a_point, found_contact_id;
33 * this driver is aimed at two firmware versions in circulation:
34 * - dual pen/finger single touch
35 * - finger multitouch, pen not working
38 static int ntrig_input_mapping(struct hid_device *hdev, struct hid_input *hi,
39 struct hid_field *field, struct hid_usage *usage,
40 unsigned long **bit, int *max)
42 /* No special mappings needed for the pen */
43 if (field->application == HID_DG_PEN)
46 switch (usage->hid & HID_USAGE_PAGE) {
50 hid_map_usage(hi, usage, bit, max,
51 EV_ABS, ABS_MT_POSITION_X);
52 input_set_abs_params(hi->input, ABS_X,
53 field->logical_minimum,
54 field->logical_maximum, 0, 0);
57 hid_map_usage(hi, usage, bit, max,
58 EV_ABS, ABS_MT_POSITION_Y);
59 input_set_abs_params(hi->input, ABS_Y,
60 field->logical_minimum,
61 field->logical_maximum, 0, 0);
66 case HID_UP_DIGITIZER:
68 /* we do not want to map these for now */
69 case HID_DG_CONTACTID: /* value is useless */
70 case HID_DG_INPUTMODE:
71 case HID_DG_DEVICEINDEX:
72 case HID_DG_CONTACTCOUNT:
73 case HID_DG_CONTACTMAX:
76 /* original mapping by Rafi Rubin */
77 case HID_DG_CONFIDENCE:
78 nt_map_key_clear(BTN_TOOL_DOUBLETAP);
81 /* width/height mapped on TouchMajor/TouchMinor/Orientation */
83 hid_map_usage(hi, usage, bit, max,
84 EV_ABS, ABS_MT_TOUCH_MAJOR);
87 hid_map_usage(hi, usage, bit, max,
88 EV_ABS, ABS_MT_TOUCH_MINOR);
89 input_set_abs_params(hi->input, ABS_MT_ORIENTATION,
96 /* we do not want to map these: no input-oriented meaning */
103 static int ntrig_input_mapped(struct hid_device *hdev, struct hid_input *hi,
104 struct hid_field *field, struct hid_usage *usage,
105 unsigned long **bit, int *max)
107 /* No special mappings needed for the pen */
108 if (field->application == HID_DG_PEN)
111 if (usage->type == EV_KEY || usage->type == EV_REL
112 || usage->type == EV_ABS)
113 clear_bit(usage->code, *bit);
119 * this function is called upon all reports
120 * so that we can filter contact point information,
121 * decide whether we are in multi or single touch mode
122 * and call input_mt_sync after each point if necessary
124 static int ntrig_event (struct hid_device *hid, struct hid_field *field,
125 struct hid_usage *usage, __s32 value)
127 struct input_dev *input = field->hidinput->input;
128 struct ntrig_data *nd = hid_get_drvdata(hid);
130 /* No special handling needed for the pen */
131 if (field->application == HID_DG_PEN)
134 if (hid->claimed & HID_CLAIMED_INPUT) {
135 switch (usage->hid) {
138 nd->reading_a_point = 1;
143 case HID_DG_CONTACTID:
145 /* we receive this only when in multitouch mode */
146 nd->found_contact_id = 1;
154 * when in single touch mode, this is the last
155 * report received in a finger event. We want
156 * to emit a normal (X, Y) position
158 if (!nd->found_contact_id) {
159 input_event(input, EV_ABS, ABS_X, nd->x);
160 input_event(input, EV_ABS, ABS_Y, nd->y);
165 * we receive this when the device is in multitouch
166 * mode. The first of the three values tagged with
167 * this usage tells if the contact point is real
170 if (!nd->reading_a_point || value != 1)
172 /* emit a normal (X, Y) for the first point only */
174 input_event(input, EV_ABS, ABS_X, nd->x);
175 input_event(input, EV_ABS, ABS_Y, nd->y);
177 input_event(input, EV_ABS, ABS_MT_POSITION_X, nd->x);
178 input_event(input, EV_ABS, ABS_MT_POSITION_Y, nd->y);
180 input_event(input, EV_ABS,
181 ABS_MT_ORIENTATION, 1);
182 input_event(input, EV_ABS,
183 ABS_MT_TOUCH_MAJOR, nd->w);
184 input_event(input, EV_ABS,
185 ABS_MT_TOUCH_MINOR, nd->h);
187 input_event(input, EV_ABS,
188 ABS_MT_ORIENTATION, 0);
189 input_event(input, EV_ABS,
190 ABS_MT_TOUCH_MAJOR, nd->h);
191 input_event(input, EV_ABS,
192 ABS_MT_TOUCH_MINOR, nd->w);
194 input_mt_sync(field->hidinput->input);
195 nd->reading_a_point = 0;
196 nd->found_contact_id = 0;
200 /* fallback to the generic hidinput handling */
205 /* we have handled the hidinput part, now remains hiddev */
206 if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_hid_event)
207 hid->hiddev_hid_event(hid, field, usage, value);
212 static int ntrig_probe(struct hid_device *hdev, const struct hid_device_id *id)
215 struct ntrig_data *nd;
216 struct hid_input *hidinput;
217 struct input_dev *input;
220 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
222 nd = kmalloc(sizeof(struct ntrig_data), GFP_KERNEL);
224 dev_err(&hdev->dev, "cannot allocate N-Trig data\n");
227 nd->reading_a_point = 0;
228 nd->found_contact_id = 0;
229 hid_set_drvdata(hdev, nd);
231 ret = hid_parse(hdev);
233 dev_err(&hdev->dev, "parse failed\n");
237 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
239 dev_err(&hdev->dev, "hw start failed\n");
244 list_for_each_entry(hidinput, &hdev->inputs, list) {
245 input = hidinput->input;
246 switch (hidinput->report->field[0]->application) {
248 input->name = "N-Trig Pen";
250 case HID_DG_TOUCHSCREEN:
252 * The physical touchscreen (single touch)
253 * input has a value for physical, whereas
254 * the multitouch only has logical input
258 (hidinput->report->field[0]
260 "N-Trig Touchscreen" :
272 static void ntrig_remove(struct hid_device *hdev)
275 kfree(hid_get_drvdata(hdev));
278 static const struct hid_device_id ntrig_devices[] = {
279 { HID_USB_DEVICE(USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_TOUCH_SCREEN),
280 .driver_data = NTRIG_DUPLICATE_USAGES },
283 MODULE_DEVICE_TABLE(hid, ntrig_devices);
285 static const struct hid_usage_id ntrig_grabbed_usages[] = {
286 { HID_ANY_ID, HID_ANY_ID, HID_ANY_ID },
287 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1 }
290 static struct hid_driver ntrig_driver = {
292 .id_table = ntrig_devices,
293 .probe = ntrig_probe,
294 .remove = ntrig_remove,
295 .input_mapping = ntrig_input_mapping,
296 .input_mapped = ntrig_input_mapped,
297 .usage_table = ntrig_grabbed_usages,
298 .event = ntrig_event,
301 static int __init ntrig_init(void)
303 return hid_register_driver(&ntrig_driver);
306 static void __exit ntrig_exit(void)
308 hid_unregister_driver(&ntrig_driver);
311 module_init(ntrig_init);
312 module_exit(ntrig_exit);
313 MODULE_LICENSE("GPL");