Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * touchkitusb.c -- Driver for eGalax TouchKit USB Touchscreens | |
3 | * | |
5d320294 | 4 | * Copyright (C) 2004-2005 by Daniel Ritz <daniel.ritz@gmx.ch> |
1da177e4 LT |
5 | * Copyright (C) by Todd E. Johnson (mtouchusb.c) |
6 | * | |
7 | * This program is free software; you can redistribute it and/or | |
8 | * modify it under the terms of the GNU General Public License as | |
9 | * published by the Free Software Foundation; either version 2 of the | |
10 | * License, or (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
20 | * | |
21 | * Based upon mtouchusb.c | |
22 | * | |
23 | *****************************************************************************/ | |
24 | ||
25 | //#define DEBUG | |
26 | ||
1da177e4 LT |
27 | #include <linux/kernel.h> |
28 | #include <linux/slab.h> | |
1da177e4 LT |
29 | #include <linux/module.h> |
30 | #include <linux/init.h> | |
ae0dadcf | 31 | #include <linux/usb/input.h> |
1da177e4 LT |
32 | |
33 | #define TOUCHKIT_MIN_XC 0x0 | |
34 | #define TOUCHKIT_MAX_XC 0x07ff | |
35 | #define TOUCHKIT_XC_FUZZ 0x0 | |
36 | #define TOUCHKIT_XC_FLAT 0x0 | |
37 | #define TOUCHKIT_MIN_YC 0x0 | |
38 | #define TOUCHKIT_MAX_YC 0x07ff | |
39 | #define TOUCHKIT_YC_FUZZ 0x0 | |
40 | #define TOUCHKIT_YC_FLAT 0x0 | |
5d320294 | 41 | #define TOUCHKIT_REPORT_DATA_SIZE 16 |
1da177e4 LT |
42 | |
43 | #define TOUCHKIT_DOWN 0x01 | |
1da177e4 | 44 | |
5d320294 DR |
45 | #define TOUCHKIT_PKT_TYPE_MASK 0xFE |
46 | #define TOUCHKIT_PKT_TYPE_REPT 0x80 | |
47 | #define TOUCHKIT_PKT_TYPE_DIAG 0x0A | |
1da177e4 LT |
48 | |
49 | #define DRIVER_VERSION "v0.1" | |
50 | #define DRIVER_AUTHOR "Daniel Ritz <daniel.ritz@gmx.ch>" | |
51 | #define DRIVER_DESC "eGalax TouchKit USB HID Touchscreen Driver" | |
52 | ||
53 | static int swap_xy; | |
54 | module_param(swap_xy, bool, 0644); | |
55 | MODULE_PARM_DESC(swap_xy, "If set X and Y axes are swapped."); | |
56 | ||
57 | struct touchkit_usb { | |
58 | unsigned char *data; | |
59 | dma_addr_t data_dma; | |
5d320294 DR |
60 | char buffer[TOUCHKIT_REPORT_DATA_SIZE]; |
61 | int buf_len; | |
1da177e4 LT |
62 | struct urb *irq; |
63 | struct usb_device *udev; | |
c5b7c7c3 | 64 | struct input_dev *input; |
1da177e4 LT |
65 | char name[128]; |
66 | char phys[64]; | |
67 | }; | |
68 | ||
69 | static struct usb_device_id touchkit_devices[] = { | |
70 | {USB_DEVICE(0x3823, 0x0001)}, | |
3f8c03ee | 71 | {USB_DEVICE(0x0123, 0x0001)}, |
1da177e4 | 72 | {USB_DEVICE(0x0eef, 0x0001)}, |
3f8c03ee | 73 | {USB_DEVICE(0x0eef, 0x0002)}, |
1da177e4 LT |
74 | {} |
75 | }; | |
76 | ||
5d320294 DR |
77 | /* helpers to read the data */ |
78 | static inline int touchkit_get_touched(char *data) | |
79 | { | |
80 | return (data[0] & TOUCHKIT_DOWN) ? 1 : 0; | |
81 | } | |
82 | ||
83 | static inline int touchkit_get_x(char *data) | |
84 | { | |
85 | return ((data[3] & 0x0F) << 7) | (data[4] & 0x7F); | |
86 | } | |
87 | ||
88 | static inline int touchkit_get_y(char *data) | |
89 | { | |
90 | return ((data[1] & 0x0F) << 7) | (data[2] & 0x7F); | |
91 | } | |
92 | ||
93 | ||
94 | /* processes one input packet. */ | |
7d12e780 | 95 | static void touchkit_process_pkt(struct touchkit_usb *touchkit, char *pkt) |
5d320294 DR |
96 | { |
97 | int x, y; | |
98 | ||
99 | /* only process report packets */ | |
100 | if ((pkt[0] & TOUCHKIT_PKT_TYPE_MASK) != TOUCHKIT_PKT_TYPE_REPT) | |
101 | return; | |
102 | ||
103 | if (swap_xy) { | |
104 | y = touchkit_get_x(pkt); | |
105 | x = touchkit_get_y(pkt); | |
106 | } else { | |
107 | x = touchkit_get_x(pkt); | |
108 | y = touchkit_get_y(pkt); | |
109 | } | |
110 | ||
5d320294 DR |
111 | input_report_key(touchkit->input, BTN_TOUCH, touchkit_get_touched(pkt)); |
112 | input_report_abs(touchkit->input, ABS_X, x); | |
113 | input_report_abs(touchkit->input, ABS_Y, y); | |
114 | input_sync(touchkit->input); | |
115 | } | |
116 | ||
117 | ||
118 | static int touchkit_get_pkt_len(char *buf) | |
119 | { | |
120 | switch (buf[0] & TOUCHKIT_PKT_TYPE_MASK) { | |
121 | case TOUCHKIT_PKT_TYPE_REPT: | |
122 | return 5; | |
123 | ||
124 | case TOUCHKIT_PKT_TYPE_DIAG: | |
125 | return buf[1] + 2; | |
126 | } | |
127 | ||
128 | return 0; | |
129 | } | |
130 | ||
7d12e780 | 131 | static void touchkit_process(struct touchkit_usb *touchkit, int len) |
5d320294 DR |
132 | { |
133 | char *buffer; | |
134 | int pkt_len, buf_len, pos; | |
135 | ||
136 | /* if the buffer contains data, append */ | |
137 | if (unlikely(touchkit->buf_len)) { | |
138 | int tmp; | |
139 | ||
140 | /* if only 1 byte in buffer, add another one to get length */ | |
141 | if (touchkit->buf_len == 1) | |
142 | touchkit->buffer[1] = touchkit->data[0]; | |
143 | ||
144 | pkt_len = touchkit_get_pkt_len(touchkit->buffer); | |
145 | ||
146 | /* unknown packet: drop everything */ | |
147 | if (!pkt_len) | |
148 | return; | |
149 | ||
150 | /* append, process */ | |
151 | tmp = pkt_len - touchkit->buf_len; | |
152 | memcpy(touchkit->buffer + touchkit->buf_len, touchkit->data, tmp); | |
7d12e780 | 153 | touchkit_process_pkt(touchkit, touchkit->buffer); |
5d320294 DR |
154 | |
155 | buffer = touchkit->data + tmp; | |
156 | buf_len = len - tmp; | |
157 | } else { | |
158 | buffer = touchkit->data; | |
159 | buf_len = len; | |
160 | } | |
161 | ||
162 | /* only one byte left in buffer */ | |
163 | if (unlikely(buf_len == 1)) { | |
164 | touchkit->buffer[0] = buffer[0]; | |
165 | touchkit->buf_len = 1; | |
166 | return; | |
167 | } | |
168 | ||
169 | /* loop over the buffer */ | |
170 | pos = 0; | |
171 | while (pos < buf_len) { | |
172 | /* get packet len */ | |
173 | pkt_len = touchkit_get_pkt_len(buffer + pos); | |
174 | ||
175 | /* unknown packet: drop everything */ | |
176 | if (unlikely(!pkt_len)) | |
177 | return; | |
178 | ||
179 | /* full packet: process */ | |
180 | if (likely(pkt_len <= buf_len)) { | |
7d12e780 | 181 | touchkit_process_pkt(touchkit, buffer + pos); |
5d320294 DR |
182 | } else { |
183 | /* incomplete packet: save in buffer */ | |
184 | memcpy(touchkit->buffer, buffer + pos, buf_len - pos); | |
185 | touchkit->buf_len = buf_len - pos; | |
186 | } | |
187 | pos += pkt_len; | |
188 | } | |
189 | } | |
190 | ||
191 | ||
7d12e780 | 192 | static void touchkit_irq(struct urb *urb) |
1da177e4 LT |
193 | { |
194 | struct touchkit_usb *touchkit = urb->context; | |
195 | int retval; | |
1da177e4 LT |
196 | |
197 | switch (urb->status) { | |
198 | case 0: | |
199 | /* success */ | |
200 | break; | |
38e2bfc9 | 201 | case -ETIME: |
1da177e4 LT |
202 | /* this urb is timing out */ |
203 | dbg("%s - urb timed out - was the device unplugged?", | |
204 | __FUNCTION__); | |
205 | return; | |
206 | case -ECONNRESET: | |
207 | case -ENOENT: | |
208 | case -ESHUTDOWN: | |
209 | /* this urb is terminated, clean up */ | |
210 | dbg("%s - urb shutting down with status: %d", | |
211 | __FUNCTION__, urb->status); | |
212 | return; | |
213 | default: | |
214 | dbg("%s - nonzero urb status received: %d", | |
215 | __FUNCTION__, urb->status); | |
216 | goto exit; | |
217 | } | |
218 | ||
7d12e780 | 219 | touchkit_process(touchkit, urb->actual_length); |
1da177e4 LT |
220 | |
221 | exit: | |
222 | retval = usb_submit_urb(urb, GFP_ATOMIC); | |
223 | if (retval) | |
224 | err("%s - usb_submit_urb failed with result: %d", | |
225 | __FUNCTION__, retval); | |
226 | } | |
227 | ||
228 | static int touchkit_open(struct input_dev *input) | |
229 | { | |
230 | struct touchkit_usb *touchkit = input->private; | |
231 | ||
1da177e4 LT |
232 | touchkit->irq->dev = touchkit->udev; |
233 | ||
65cde54b | 234 | if (usb_submit_urb(touchkit->irq, GFP_ATOMIC)) |
1da177e4 | 235 | return -EIO; |
1da177e4 LT |
236 | |
237 | return 0; | |
238 | } | |
239 | ||
240 | static void touchkit_close(struct input_dev *input) | |
241 | { | |
242 | struct touchkit_usb *touchkit = input->private; | |
243 | ||
65cde54b | 244 | usb_kill_urb(touchkit->irq); |
1da177e4 LT |
245 | } |
246 | ||
247 | static int touchkit_alloc_buffers(struct usb_device *udev, | |
248 | struct touchkit_usb *touchkit) | |
249 | { | |
250 | touchkit->data = usb_buffer_alloc(udev, TOUCHKIT_REPORT_DATA_SIZE, | |
54e6ecb2 | 251 | GFP_ATOMIC, &touchkit->data_dma); |
1da177e4 LT |
252 | |
253 | if (!touchkit->data) | |
254 | return -1; | |
255 | ||
256 | return 0; | |
257 | } | |
258 | ||
259 | static void touchkit_free_buffers(struct usb_device *udev, | |
260 | struct touchkit_usb *touchkit) | |
261 | { | |
262 | if (touchkit->data) | |
263 | usb_buffer_free(udev, TOUCHKIT_REPORT_DATA_SIZE, | |
264 | touchkit->data, touchkit->data_dma); | |
265 | } | |
266 | ||
267 | static int touchkit_probe(struct usb_interface *intf, | |
268 | const struct usb_device_id *id) | |
269 | { | |
1da177e4 | 270 | struct touchkit_usb *touchkit; |
c5b7c7c3 | 271 | struct input_dev *input_dev; |
1da177e4 LT |
272 | struct usb_host_interface *interface; |
273 | struct usb_endpoint_descriptor *endpoint; | |
274 | struct usb_device *udev = interface_to_usbdev(intf); | |
1da177e4 LT |
275 | |
276 | interface = intf->cur_altsetting; | |
277 | endpoint = &interface->endpoint[0].desc; | |
278 | ||
c5b7c7c3 DT |
279 | touchkit = kzalloc(sizeof(struct touchkit_usb), GFP_KERNEL); |
280 | input_dev = input_allocate_device(); | |
281 | if (!touchkit || !input_dev) | |
1da177e4 | 282 | goto out_free; |
1da177e4 | 283 | |
c5b7c7c3 DT |
284 | if (touchkit_alloc_buffers(udev, touchkit)) |
285 | goto out_free; | |
1da177e4 LT |
286 | |
287 | touchkit->irq = usb_alloc_urb(0, GFP_KERNEL); | |
288 | if (!touchkit->irq) { | |
289 | dbg("%s - usb_alloc_urb failed: touchkit->irq", __FUNCTION__); | |
1da177e4 LT |
290 | goto out_free_buffers; |
291 | } | |
292 | ||
c5b7c7c3 DT |
293 | touchkit->udev = udev; |
294 | touchkit->input = input_dev; | |
295 | ||
296 | if (udev->manufacturer) | |
297 | strlcpy(touchkit->name, udev->manufacturer, sizeof(touchkit->name)); | |
298 | ||
299 | if (udev->product) { | |
300 | if (udev->manufacturer) | |
301 | strlcat(touchkit->name, " ", sizeof(touchkit->name)); | |
302 | strlcat(touchkit->name, udev->product, sizeof(touchkit->name)); | |
303 | } | |
304 | ||
305 | if (!strlen(touchkit->name)) | |
306 | snprintf(touchkit->name, sizeof(touchkit->name), | |
307 | "USB Touchscreen %04x:%04x", | |
308 | le16_to_cpu(udev->descriptor.idVendor), | |
309 | le16_to_cpu(udev->descriptor.idProduct)); | |
310 | ||
311 | usb_make_path(udev, touchkit->phys, sizeof(touchkit->phys)); | |
312 | strlcpy(touchkit->phys, "/input0", sizeof(touchkit->phys)); | |
313 | ||
314 | input_dev->name = touchkit->name; | |
315 | input_dev->phys = touchkit->phys; | |
316 | usb_to_input_id(udev, &input_dev->id); | |
317 | input_dev->cdev.dev = &intf->dev; | |
318 | input_dev->private = touchkit; | |
319 | input_dev->open = touchkit_open; | |
320 | input_dev->close = touchkit_close; | |
321 | ||
322 | input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS); | |
323 | input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH); | |
324 | input_set_abs_params(input_dev, ABS_X, TOUCHKIT_MIN_XC, TOUCHKIT_MAX_XC, | |
325 | TOUCHKIT_XC_FUZZ, TOUCHKIT_XC_FLAT); | |
326 | input_set_abs_params(input_dev, ABS_Y, TOUCHKIT_MIN_YC, TOUCHKIT_MAX_YC, | |
327 | TOUCHKIT_YC_FUZZ, TOUCHKIT_YC_FLAT); | |
328 | ||
1da177e4 | 329 | usb_fill_int_urb(touchkit->irq, touchkit->udev, |
c5b7c7c3 DT |
330 | usb_rcvintpipe(touchkit->udev, 0x81), |
331 | touchkit->data, TOUCHKIT_REPORT_DATA_SIZE, | |
332 | touchkit_irq, touchkit, endpoint->bInterval); | |
1da177e4 | 333 | |
a001100d JS |
334 | touchkit->irq->transfer_dma = touchkit->data_dma; |
335 | touchkit->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; | |
336 | ||
c5b7c7c3 | 337 | input_register_device(touchkit->input); |
1da177e4 | 338 | |
1da177e4 | 339 | usb_set_intfdata(intf, touchkit); |
1da177e4 LT |
340 | return 0; |
341 | ||
342 | out_free_buffers: | |
343 | touchkit_free_buffers(udev, touchkit); | |
344 | out_free: | |
c5b7c7c3 | 345 | input_free_device(input_dev); |
1da177e4 | 346 | kfree(touchkit); |
c5b7c7c3 | 347 | return -ENOMEM; |
1da177e4 LT |
348 | } |
349 | ||
350 | static void touchkit_disconnect(struct usb_interface *intf) | |
351 | { | |
352 | struct touchkit_usb *touchkit = usb_get_intfdata(intf); | |
353 | ||
354 | dbg("%s - called", __FUNCTION__); | |
355 | ||
356 | if (!touchkit) | |
357 | return; | |
358 | ||
359 | dbg("%s - touchkit is initialized, cleaning up", __FUNCTION__); | |
360 | usb_set_intfdata(intf, NULL); | |
1da177e4 | 361 | usb_kill_urb(touchkit->irq); |
c5b7c7c3 | 362 | input_unregister_device(touchkit->input); |
1da177e4 LT |
363 | usb_free_urb(touchkit->irq); |
364 | touchkit_free_buffers(interface_to_usbdev(intf), touchkit); | |
365 | kfree(touchkit); | |
366 | } | |
367 | ||
368 | MODULE_DEVICE_TABLE(usb, touchkit_devices); | |
369 | ||
370 | static struct usb_driver touchkit_driver = { | |
1da177e4 LT |
371 | .name = "touchkitusb", |
372 | .probe = touchkit_probe, | |
373 | .disconnect = touchkit_disconnect, | |
374 | .id_table = touchkit_devices, | |
375 | }; | |
376 | ||
377 | static int __init touchkit_init(void) | |
378 | { | |
379 | return usb_register(&touchkit_driver); | |
380 | } | |
381 | ||
382 | static void __exit touchkit_cleanup(void) | |
383 | { | |
384 | usb_deregister(&touchkit_driver); | |
385 | } | |
386 | ||
387 | module_init(touchkit_init); | |
388 | module_exit(touchkit_cleanup); | |
389 | ||
390 | MODULE_AUTHOR(DRIVER_AUTHOR); | |
391 | MODULE_DESCRIPTION(DRIVER_DESC); | |
392 | MODULE_LICENSE("GPL"); |