xref: /openbmc/linux/drivers/input/touchscreen/usbtouchscreen.c (revision b240b419db5d624ce7a5a397d6f62a1a686009ec)
1 /******************************************************************************
2  * usbtouchscreen.c
3  * Driver for USB Touchscreens, supporting those devices:
4  *  - eGalax Touchkit
5  *    includes eTurboTouch CT-410/510/700
6  *  - 3M/Microtouch  EX II series
7  *  - ITM
8  *  - PanJit TouchSet
9  *  - eTurboTouch
10  *  - Gunze AHL61
11  *  - DMC TSC-10/25
12  *  - IRTOUCHSYSTEMS/UNITOP
13  *  - IdealTEK URTC1000
14  *  - General Touch
15  *  - GoTop Super_Q2/GogoPen/PenPower tablets
16  *  - JASTEC USB touch controller/DigiTech DTR-02U
17  *  - Zytronic capacitive touchscreen
18  *  - NEXIO/iNexio
19  *  - Elo TouchSystems 2700 IntelliTouch
20  *  - EasyTouch USB Dual/Multi touch controller from Data Modul
21  *
22  * Copyright (C) 2004-2007 by Daniel Ritz <daniel.ritz@gmx.ch>
23  * Copyright (C) by Todd E. Johnson (mtouchusb.c)
24  *
25  * This program is free software; you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License as
27  * published by the Free Software Foundation; either version 2 of the
28  * License, or (at your option) any later version.
29  *
30  * This program is distributed in the hope that it will be useful, but
31  * WITHOUT ANY WARRANTY; without even the implied warranty of
32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
33  * General Public License for more details.
34  *
35  * You should have received a copy of the GNU General Public License
36  * along with this program; if not, write to the Free Software
37  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
38  *
39  * Driver is based on touchkitusb.c
40  * - ITM parts are from itmtouch.c
41  * - 3M parts are from mtouchusb.c
42  * - PanJit parts are from an unmerged driver by Lanslott Gish
43  * - DMC TSC 10/25 are from Holger Schurig, with ideas from an unmerged
44  *   driver from Marius Vollmer
45  *
46  *****************************************************************************/
47 
48 //#define DEBUG
49 
50 #include <linux/kernel.h>
51 #include <linux/slab.h>
52 #include <linux/input.h>
53 #include <linux/module.h>
54 #include <linux/usb.h>
55 #include <linux/usb/input.h>
56 #include <linux/hid.h>
57 #include <linux/mutex.h>
58 
59 static bool swap_xy;
60 module_param(swap_xy, bool, 0644);
61 MODULE_PARM_DESC(swap_xy, "If set X and Y axes are swapped.");
62 
63 static bool hwcalib_xy;
64 module_param(hwcalib_xy, bool, 0644);
65 MODULE_PARM_DESC(hwcalib_xy, "If set hw-calibrated X/Y are used if available");
66 
67 /* device specifc data/functions */
68 struct usbtouch_usb;
69 struct usbtouch_device_info {
70 	int min_xc, max_xc;
71 	int min_yc, max_yc;
72 	int min_press, max_press;
73 	int rept_size;
74 
75 	/*
76 	 * Always service the USB devices irq not just when the input device is
77 	 * open. This is useful when devices have a watchdog which prevents us
78 	 * from periodically polling the device. Leave this unset unless your
79 	 * touchscreen device requires it, as it does consume more of the USB
80 	 * bandwidth.
81 	 */
82 	bool irq_always;
83 
84 	void (*process_pkt) (struct usbtouch_usb *usbtouch, unsigned char *pkt, int len);
85 
86 	/*
87 	 * used to get the packet len. possible return values:
88 	 * > 0: packet len
89 	 * = 0: skip one byte
90 	 * < 0: -return value more bytes needed
91 	 */
92 	int  (*get_pkt_len) (unsigned char *pkt, int len);
93 
94 	int  (*read_data)   (struct usbtouch_usb *usbtouch, unsigned char *pkt);
95 	int  (*alloc)       (struct usbtouch_usb *usbtouch);
96 	int  (*init)        (struct usbtouch_usb *usbtouch);
97 	void (*exit)	    (struct usbtouch_usb *usbtouch);
98 };
99 
100 /* a usbtouch device */
101 struct usbtouch_usb {
102 	unsigned char *data;
103 	dma_addr_t data_dma;
104 	int data_size;
105 	unsigned char *buffer;
106 	int buf_len;
107 	struct urb *irq;
108 	struct usb_interface *interface;
109 	struct input_dev *input;
110 	struct usbtouch_device_info *type;
111 	struct mutex pm_mutex;  /* serialize access to open/suspend */
112 	bool is_open;
113 	char name[128];
114 	char phys[64];
115 	void *priv;
116 
117 	int x, y;
118 	int touch, press;
119 };
120 
121 
122 /* device types */
123 enum {
124 	DEVTYPE_IGNORE = -1,
125 	DEVTYPE_EGALAX,
126 	DEVTYPE_PANJIT,
127 	DEVTYPE_3M,
128 	DEVTYPE_ITM,
129 	DEVTYPE_ETURBO,
130 	DEVTYPE_GUNZE,
131 	DEVTYPE_DMC_TSC10,
132 	DEVTYPE_IRTOUCH,
133 	DEVTYPE_IRTOUCH_HIRES,
134 	DEVTYPE_IDEALTEK,
135 	DEVTYPE_GENERAL_TOUCH,
136 	DEVTYPE_GOTOP,
137 	DEVTYPE_JASTEC,
138 	DEVTYPE_E2I,
139 	DEVTYPE_ZYTRONIC,
140 	DEVTYPE_TC45USB,
141 	DEVTYPE_NEXIO,
142 	DEVTYPE_ELO,
143 	DEVTYPE_ETOUCH,
144 };
145 
146 #define USB_DEVICE_HID_CLASS(vend, prod) \
147 	.match_flags = USB_DEVICE_ID_MATCH_INT_CLASS \
148 		| USB_DEVICE_ID_MATCH_DEVICE, \
149 	.idVendor = (vend), \
150 	.idProduct = (prod), \
151 	.bInterfaceClass = USB_INTERFACE_CLASS_HID
152 
153 static const struct usb_device_id usbtouch_devices[] = {
154 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
155 	/* ignore the HID capable devices, handled by usbhid */
156 	{USB_DEVICE_HID_CLASS(0x0eef, 0x0001), .driver_info = DEVTYPE_IGNORE},
157 	{USB_DEVICE_HID_CLASS(0x0eef, 0x0002), .driver_info = DEVTYPE_IGNORE},
158 
159 	/* normal device IDs */
160 	{USB_DEVICE(0x3823, 0x0001), .driver_info = DEVTYPE_EGALAX},
161 	{USB_DEVICE(0x3823, 0x0002), .driver_info = DEVTYPE_EGALAX},
162 	{USB_DEVICE(0x0123, 0x0001), .driver_info = DEVTYPE_EGALAX},
163 	{USB_DEVICE(0x0eef, 0x0001), .driver_info = DEVTYPE_EGALAX},
164 	{USB_DEVICE(0x0eef, 0x0002), .driver_info = DEVTYPE_EGALAX},
165 	{USB_DEVICE(0x1234, 0x0001), .driver_info = DEVTYPE_EGALAX},
166 	{USB_DEVICE(0x1234, 0x0002), .driver_info = DEVTYPE_EGALAX},
167 #endif
168 
169 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
170 	{USB_DEVICE(0x134c, 0x0001), .driver_info = DEVTYPE_PANJIT},
171 	{USB_DEVICE(0x134c, 0x0002), .driver_info = DEVTYPE_PANJIT},
172 	{USB_DEVICE(0x134c, 0x0003), .driver_info = DEVTYPE_PANJIT},
173 	{USB_DEVICE(0x134c, 0x0004), .driver_info = DEVTYPE_PANJIT},
174 #endif
175 
176 #ifdef CONFIG_TOUCHSCREEN_USB_3M
177 	{USB_DEVICE(0x0596, 0x0001), .driver_info = DEVTYPE_3M},
178 #endif
179 
180 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
181 	{USB_DEVICE(0x0403, 0xf9e9), .driver_info = DEVTYPE_ITM},
182 	{USB_DEVICE(0x16e3, 0xf9e9), .driver_info = DEVTYPE_ITM},
183 #endif
184 
185 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
186 	{USB_DEVICE(0x1234, 0x5678), .driver_info = DEVTYPE_ETURBO},
187 #endif
188 
189 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
190 	{USB_DEVICE(0x0637, 0x0001), .driver_info = DEVTYPE_GUNZE},
191 #endif
192 
193 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
194 	{USB_DEVICE(0x0afa, 0x03e8), .driver_info = DEVTYPE_DMC_TSC10},
195 #endif
196 
197 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
198 	{USB_DEVICE(0x595a, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
199 	{USB_DEVICE(0x6615, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
200 	{USB_DEVICE(0x6615, 0x0012), .driver_info = DEVTYPE_IRTOUCH_HIRES},
201 #endif
202 
203 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
204 	{USB_DEVICE(0x1391, 0x1000), .driver_info = DEVTYPE_IDEALTEK},
205 #endif
206 
207 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
208 	{USB_DEVICE(0x0dfc, 0x0001), .driver_info = DEVTYPE_GENERAL_TOUCH},
209 #endif
210 
211 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
212 	{USB_DEVICE(0x08f2, 0x007f), .driver_info = DEVTYPE_GOTOP},
213 	{USB_DEVICE(0x08f2, 0x00ce), .driver_info = DEVTYPE_GOTOP},
214 	{USB_DEVICE(0x08f2, 0x00f4), .driver_info = DEVTYPE_GOTOP},
215 #endif
216 
217 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
218 	{USB_DEVICE(0x0f92, 0x0001), .driver_info = DEVTYPE_JASTEC},
219 #endif
220 
221 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
222 	{USB_DEVICE(0x1ac7, 0x0001), .driver_info = DEVTYPE_E2I},
223 #endif
224 
225 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
226 	{USB_DEVICE(0x14c8, 0x0003), .driver_info = DEVTYPE_ZYTRONIC},
227 #endif
228 
229 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
230 	/* TC5UH */
231 	{USB_DEVICE(0x0664, 0x0309), .driver_info = DEVTYPE_TC45USB},
232 	/* TC4UM */
233 	{USB_DEVICE(0x0664, 0x0306), .driver_info = DEVTYPE_TC45USB},
234 #endif
235 
236 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
237 	/* data interface only */
238 	{USB_DEVICE_AND_INTERFACE_INFO(0x10f0, 0x2002, 0x0a, 0x00, 0x00),
239 		.driver_info = DEVTYPE_NEXIO},
240 	{USB_DEVICE_AND_INTERFACE_INFO(0x1870, 0x0001, 0x0a, 0x00, 0x00),
241 		.driver_info = DEVTYPE_NEXIO},
242 #endif
243 
244 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
245 	{USB_DEVICE(0x04e7, 0x0020), .driver_info = DEVTYPE_ELO},
246 #endif
247 
248 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
249 	{USB_DEVICE(0x7374, 0x0001), .driver_info = DEVTYPE_ETOUCH},
250 #endif
251 
252 	{}
253 };
254 
255 
256 /*****************************************************************************
257  * e2i Part
258  */
259 
260 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
261 static int e2i_init(struct usbtouch_usb *usbtouch)
262 {
263 	int ret;
264 	struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
265 
266 	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
267 	                      0x01, 0x02, 0x0000, 0x0081,
268 	                      NULL, 0, USB_CTRL_SET_TIMEOUT);
269 
270 	dev_dbg(&usbtouch->interface->dev,
271 		"%s - usb_control_msg - E2I_RESET - bytes|err: %d\n",
272 		__func__, ret);
273 	return ret;
274 }
275 
276 static int e2i_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
277 {
278 	int tmp = (pkt[0] << 8) | pkt[1];
279 	dev->x  = (pkt[2] << 8) | pkt[3];
280 	dev->y  = (pkt[4] << 8) | pkt[5];
281 
282 	tmp = tmp - 0xA000;
283 	dev->touch = (tmp > 0);
284 	dev->press = (tmp > 0 ? tmp : 0);
285 
286 	return 1;
287 }
288 #endif
289 
290 
291 /*****************************************************************************
292  * eGalax part
293  */
294 
295 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
296 
297 #ifndef MULTI_PACKET
298 #define MULTI_PACKET
299 #endif
300 
301 #define EGALAX_PKT_TYPE_MASK		0xFE
302 #define EGALAX_PKT_TYPE_REPT		0x80
303 #define EGALAX_PKT_TYPE_DIAG		0x0A
304 
305 static int egalax_init(struct usbtouch_usb *usbtouch)
306 {
307 	int ret, i;
308 	unsigned char *buf;
309 	struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
310 
311 	/*
312 	 * An eGalax diagnostic packet kicks the device into using the right
313 	 * protocol.  We send a "check active" packet.  The response will be
314 	 * read later and ignored.
315 	 */
316 
317 	buf = kmalloc(3, GFP_KERNEL);
318 	if (!buf)
319 		return -ENOMEM;
320 
321 	buf[0] = EGALAX_PKT_TYPE_DIAG;
322 	buf[1] = 1;	/* length */
323 	buf[2] = 'A';	/* command - check active */
324 
325 	for (i = 0; i < 3; i++) {
326 		ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
327 				      0,
328 				      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
329 				      0, 0, buf, 3,
330 				      USB_CTRL_SET_TIMEOUT);
331 		if (ret >= 0) {
332 			ret = 0;
333 			break;
334 		}
335 		if (ret != -EPIPE)
336 			break;
337 	}
338 
339 	kfree(buf);
340 
341 	return ret;
342 }
343 
344 static int egalax_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
345 {
346 	if ((pkt[0] & EGALAX_PKT_TYPE_MASK) != EGALAX_PKT_TYPE_REPT)
347 		return 0;
348 
349 	dev->x = ((pkt[3] & 0x0F) << 7) | (pkt[4] & 0x7F);
350 	dev->y = ((pkt[1] & 0x0F) << 7) | (pkt[2] & 0x7F);
351 	dev->touch = pkt[0] & 0x01;
352 
353 	return 1;
354 }
355 
356 static int egalax_get_pkt_len(unsigned char *buf, int len)
357 {
358 	switch (buf[0] & EGALAX_PKT_TYPE_MASK) {
359 	case EGALAX_PKT_TYPE_REPT:
360 		return 5;
361 
362 	case EGALAX_PKT_TYPE_DIAG:
363 		if (len < 2)
364 			return -1;
365 
366 		return buf[1] + 2;
367 	}
368 
369 	return 0;
370 }
371 #endif
372 
373 /*****************************************************************************
374  * EasyTouch part
375  */
376 
377 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
378 
379 #ifndef MULTI_PACKET
380 #define MULTI_PACKET
381 #endif
382 
383 #define ETOUCH_PKT_TYPE_MASK		0xFE
384 #define ETOUCH_PKT_TYPE_REPT		0x80
385 #define ETOUCH_PKT_TYPE_REPT2		0xB0
386 #define ETOUCH_PKT_TYPE_DIAG		0x0A
387 
388 static int etouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
389 {
390 	if ((pkt[0] & ETOUCH_PKT_TYPE_MASK) != ETOUCH_PKT_TYPE_REPT &&
391 		(pkt[0] & ETOUCH_PKT_TYPE_MASK) != ETOUCH_PKT_TYPE_REPT2)
392 		return 0;
393 
394 	dev->x = ((pkt[1] & 0x1F) << 7) | (pkt[2] & 0x7F);
395 	dev->y = ((pkt[3] & 0x1F) << 7) | (pkt[4] & 0x7F);
396 	dev->touch = pkt[0] & 0x01;
397 
398 	return 1;
399 }
400 
401 static int etouch_get_pkt_len(unsigned char *buf, int len)
402 {
403 	switch (buf[0] & ETOUCH_PKT_TYPE_MASK) {
404 	case ETOUCH_PKT_TYPE_REPT:
405 	case ETOUCH_PKT_TYPE_REPT2:
406 		return 5;
407 
408 	case ETOUCH_PKT_TYPE_DIAG:
409 		if (len < 2)
410 			return -1;
411 
412 		return buf[1] + 2;
413 	}
414 
415 	return 0;
416 }
417 #endif
418 
419 /*****************************************************************************
420  * PanJit Part
421  */
422 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
423 static int panjit_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
424 {
425 	dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
426 	dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
427 	dev->touch = pkt[0] & 0x01;
428 
429 	return 1;
430 }
431 #endif
432 
433 
434 /*****************************************************************************
435  * 3M/Microtouch Part
436  */
437 #ifdef CONFIG_TOUCHSCREEN_USB_3M
438 
439 #define MTOUCHUSB_ASYNC_REPORT          1
440 #define MTOUCHUSB_RESET                 7
441 #define MTOUCHUSB_REQ_CTRLLR_ID         10
442 
443 static int mtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
444 {
445 	if (hwcalib_xy) {
446 		dev->x = (pkt[4] << 8) | pkt[3];
447 		dev->y = 0xffff - ((pkt[6] << 8) | pkt[5]);
448 	} else {
449 		dev->x = (pkt[8] << 8) | pkt[7];
450 		dev->y = (pkt[10] << 8) | pkt[9];
451 	}
452 	dev->touch = (pkt[2] & 0x40) ? 1 : 0;
453 
454 	return 1;
455 }
456 
457 static int mtouch_init(struct usbtouch_usb *usbtouch)
458 {
459 	int ret, i;
460 	struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
461 
462 	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
463 	                      MTOUCHUSB_RESET,
464 	                      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
465 	                      1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
466 	dev_dbg(&usbtouch->interface->dev,
467 		"%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d\n",
468 		__func__, ret);
469 	if (ret < 0)
470 		return ret;
471 	msleep(150);
472 
473 	for (i = 0; i < 3; i++) {
474 		ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
475 				      MTOUCHUSB_ASYNC_REPORT,
476 				      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
477 				      1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
478 		dev_dbg(&usbtouch->interface->dev,
479 			"%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d\n",
480 			__func__, ret);
481 		if (ret >= 0)
482 			break;
483 		if (ret != -EPIPE)
484 			return ret;
485 	}
486 
487 	/* Default min/max xy are the raw values, override if using hw-calib */
488 	if (hwcalib_xy) {
489 		input_set_abs_params(usbtouch->input, ABS_X, 0, 0xffff, 0, 0);
490 		input_set_abs_params(usbtouch->input, ABS_Y, 0, 0xffff, 0, 0);
491 	}
492 
493 	return 0;
494 }
495 #endif
496 
497 
498 /*****************************************************************************
499  * ITM Part
500  */
501 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
502 static int itm_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
503 {
504 	int touch;
505 	/*
506 	 * ITM devices report invalid x/y data if not touched.
507 	 * if the screen was touched before but is not touched any more
508 	 * report touch as 0 with the last valid x/y data once. then stop
509 	 * reporting data until touched again.
510 	 */
511 	dev->press = ((pkt[2] & 0x01) << 7) | (pkt[5] & 0x7F);
512 
513 	touch = ~pkt[7] & 0x20;
514 	if (!touch) {
515 		if (dev->touch) {
516 			dev->touch = 0;
517 			return 1;
518 		}
519 
520 		return 0;
521 	}
522 
523 	dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[3] & 0x7F);
524 	dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[4] & 0x7F);
525 	dev->touch = touch;
526 
527 	return 1;
528 }
529 #endif
530 
531 
532 /*****************************************************************************
533  * eTurboTouch part
534  */
535 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
536 #ifndef MULTI_PACKET
537 #define MULTI_PACKET
538 #endif
539 static int eturbo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
540 {
541 	unsigned int shift;
542 
543 	/* packets should start with sync */
544 	if (!(pkt[0] & 0x80))
545 		return 0;
546 
547 	shift = (6 - (pkt[0] & 0x03));
548 	dev->x = ((pkt[3] << 7) | pkt[4]) >> shift;
549 	dev->y = ((pkt[1] << 7) | pkt[2]) >> shift;
550 	dev->touch = (pkt[0] & 0x10) ? 1 : 0;
551 
552 	return 1;
553 }
554 
555 static int eturbo_get_pkt_len(unsigned char *buf, int len)
556 {
557 	if (buf[0] & 0x80)
558 		return 5;
559 	if (buf[0] == 0x01)
560 		return 3;
561 	return 0;
562 }
563 #endif
564 
565 
566 /*****************************************************************************
567  * Gunze part
568  */
569 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
570 static int gunze_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
571 {
572 	if (!(pkt[0] & 0x80) || ((pkt[1] | pkt[2] | pkt[3]) & 0x80))
573 		return 0;
574 
575 	dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[2] & 0x7F);
576 	dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[3] & 0x7F);
577 	dev->touch = pkt[0] & 0x20;
578 
579 	return 1;
580 }
581 #endif
582 
583 /*****************************************************************************
584  * DMC TSC-10/25 Part
585  *
586  * Documentation about the controller and it's protocol can be found at
587  *   http://www.dmccoltd.com/files/controler/tsc10usb_pi_e.pdf
588  *   http://www.dmccoltd.com/files/controler/tsc25_usb_e.pdf
589  */
590 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
591 
592 /* supported data rates. currently using 130 */
593 #define TSC10_RATE_POINT	0x50
594 #define TSC10_RATE_30		0x40
595 #define TSC10_RATE_50		0x41
596 #define TSC10_RATE_80		0x42
597 #define TSC10_RATE_100		0x43
598 #define TSC10_RATE_130		0x44
599 #define TSC10_RATE_150		0x45
600 
601 /* commands */
602 #define TSC10_CMD_RESET		0x55
603 #define TSC10_CMD_RATE		0x05
604 #define TSC10_CMD_DATA1		0x01
605 
606 static int dmc_tsc10_init(struct usbtouch_usb *usbtouch)
607 {
608 	struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
609 	int ret = -ENOMEM;
610 	unsigned char *buf;
611 
612 	buf = kmalloc(2, GFP_NOIO);
613 	if (!buf)
614 		goto err_nobuf;
615 	/* reset */
616 	buf[0] = buf[1] = 0xFF;
617 	ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
618 	                      TSC10_CMD_RESET,
619 	                      USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
620 	                      0, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
621 	if (ret < 0)
622 		goto err_out;
623 	if (buf[0] != 0x06) {
624 		ret = -ENODEV;
625 		goto err_out;
626 	}
627 
628 	/* TSC-25 data sheet specifies a delay after the RESET command */
629 	msleep(150);
630 
631 	/* set coordinate output rate */
632 	buf[0] = buf[1] = 0xFF;
633 	ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
634 	                      TSC10_CMD_RATE,
635 	                      USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
636 	                      TSC10_RATE_150, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
637 	if (ret < 0)
638 		goto err_out;
639 	if ((buf[0] != 0x06) && (buf[0] != 0x15 || buf[1] != 0x01)) {
640 		ret = -ENODEV;
641 		goto err_out;
642 	}
643 
644 	/* start sending data */
645 	ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
646 	                      TSC10_CMD_DATA1,
647 	                      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
648 	                      0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
649 err_out:
650 	kfree(buf);
651 err_nobuf:
652 	return ret;
653 }
654 
655 
656 static int dmc_tsc10_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
657 {
658 	dev->x = ((pkt[2] & 0x03) << 8) | pkt[1];
659 	dev->y = ((pkt[4] & 0x03) << 8) | pkt[3];
660 	dev->touch = pkt[0] & 0x01;
661 
662 	return 1;
663 }
664 #endif
665 
666 
667 /*****************************************************************************
668  * IRTOUCH Part
669  */
670 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
671 static int irtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
672 {
673 	dev->x = (pkt[3] << 8) | pkt[2];
674 	dev->y = (pkt[5] << 8) | pkt[4];
675 	dev->touch = (pkt[1] & 0x03) ? 1 : 0;
676 
677 	return 1;
678 }
679 #endif
680 
681 /*****************************************************************************
682  * ET&T TC5UH/TC4UM part
683  */
684 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
685 static int tc45usb_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
686 {
687 	dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
688 	dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
689 	dev->touch = pkt[0] & 0x01;
690 
691 	return 1;
692 }
693 #endif
694 
695 /*****************************************************************************
696  * IdealTEK URTC1000 Part
697  */
698 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
699 #ifndef MULTI_PACKET
700 #define MULTI_PACKET
701 #endif
702 static int idealtek_get_pkt_len(unsigned char *buf, int len)
703 {
704 	if (buf[0] & 0x80)
705 		return 5;
706 	if (buf[0] == 0x01)
707 		return len;
708 	return 0;
709 }
710 
711 static int idealtek_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
712 {
713 	switch (pkt[0] & 0x98) {
714 	case 0x88:
715 		/* touch data in IdealTEK mode */
716 		dev->x = (pkt[1] << 5) | (pkt[2] >> 2);
717 		dev->y = (pkt[3] << 5) | (pkt[4] >> 2);
718 		dev->touch = (pkt[0] & 0x40) ? 1 : 0;
719 		return 1;
720 
721 	case 0x98:
722 		/* touch data in MT emulation mode */
723 		dev->x = (pkt[2] << 5) | (pkt[1] >> 2);
724 		dev->y = (pkt[4] << 5) | (pkt[3] >> 2);
725 		dev->touch = (pkt[0] & 0x40) ? 1 : 0;
726 		return 1;
727 
728 	default:
729 		return 0;
730 	}
731 }
732 #endif
733 
734 /*****************************************************************************
735  * General Touch Part
736  */
737 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
738 static int general_touch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
739 {
740 	dev->x = (pkt[2] << 8) | pkt[1];
741 	dev->y = (pkt[4] << 8) | pkt[3];
742 	dev->press = pkt[5] & 0xff;
743 	dev->touch = pkt[0] & 0x01;
744 
745 	return 1;
746 }
747 #endif
748 
749 /*****************************************************************************
750  * GoTop Part
751  */
752 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
753 static int gotop_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
754 {
755 	dev->x = ((pkt[1] & 0x38) << 4) | pkt[2];
756 	dev->y = ((pkt[1] & 0x07) << 7) | pkt[3];
757 	dev->touch = pkt[0] & 0x01;
758 
759 	return 1;
760 }
761 #endif
762 
763 /*****************************************************************************
764  * JASTEC Part
765  */
766 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
767 static int jastec_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
768 {
769 	dev->x = ((pkt[0] & 0x3f) << 6) | (pkt[2] & 0x3f);
770 	dev->y = ((pkt[1] & 0x3f) << 6) | (pkt[3] & 0x3f);
771 	dev->touch = (pkt[0] & 0x40) >> 6;
772 
773 	return 1;
774 }
775 #endif
776 
777 /*****************************************************************************
778  * Zytronic Part
779  */
780 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
781 static int zytronic_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
782 {
783 	struct usb_interface *intf = dev->interface;
784 
785 	switch (pkt[0]) {
786 	case 0x3A: /* command response */
787 		dev_dbg(&intf->dev, "%s: Command response %d\n", __func__, pkt[1]);
788 		break;
789 
790 	case 0xC0: /* down */
791 		dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
792 		dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
793 		dev->touch = 1;
794 		dev_dbg(&intf->dev, "%s: down %d,%d\n", __func__, dev->x, dev->y);
795 		return 1;
796 
797 	case 0x80: /* up */
798 		dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
799 		dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
800 		dev->touch = 0;
801 		dev_dbg(&intf->dev, "%s: up %d,%d\n", __func__, dev->x, dev->y);
802 		return 1;
803 
804 	default:
805 		dev_dbg(&intf->dev, "%s: Unknown return %d\n", __func__, pkt[0]);
806 		break;
807 	}
808 
809 	return 0;
810 }
811 #endif
812 
813 /*****************************************************************************
814  * NEXIO Part
815  */
816 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
817 
818 #define NEXIO_TIMEOUT	5000
819 #define NEXIO_BUFSIZE	1024
820 #define NEXIO_THRESHOLD	50
821 
822 struct nexio_priv {
823 	struct urb *ack;
824 	unsigned char *ack_buf;
825 };
826 
827 struct nexio_touch_packet {
828 	u8	flags;		/* 0xe1 = touch, 0xe1 = release */
829 	__be16	data_len;	/* total bytes of touch data */
830 	__be16	x_len;		/* bytes for X axis */
831 	__be16	y_len;		/* bytes for Y axis */
832 	u8	data[];
833 } __attribute__ ((packed));
834 
835 static unsigned char nexio_ack_pkt[2] = { 0xaa, 0x02 };
836 static unsigned char nexio_init_pkt[4] = { 0x82, 0x04, 0x0a, 0x0f };
837 
838 static void nexio_ack_complete(struct urb *urb)
839 {
840 }
841 
842 static int nexio_alloc(struct usbtouch_usb *usbtouch)
843 {
844 	struct nexio_priv *priv;
845 	int ret = -ENOMEM;
846 
847 	usbtouch->priv = kmalloc(sizeof(struct nexio_priv), GFP_KERNEL);
848 	if (!usbtouch->priv)
849 		goto out_buf;
850 
851 	priv = usbtouch->priv;
852 
853 	priv->ack_buf = kmemdup(nexio_ack_pkt, sizeof(nexio_ack_pkt),
854 				GFP_KERNEL);
855 	if (!priv->ack_buf)
856 		goto err_priv;
857 
858 	priv->ack = usb_alloc_urb(0, GFP_KERNEL);
859 	if (!priv->ack) {
860 		dev_dbg(&usbtouch->interface->dev,
861 			"%s - usb_alloc_urb failed: usbtouch->ack\n", __func__);
862 		goto err_ack_buf;
863 	}
864 
865 	return 0;
866 
867 err_ack_buf:
868 	kfree(priv->ack_buf);
869 err_priv:
870 	kfree(priv);
871 out_buf:
872 	return ret;
873 }
874 
875 static int nexio_init(struct usbtouch_usb *usbtouch)
876 {
877 	struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
878 	struct usb_host_interface *interface = usbtouch->interface->cur_altsetting;
879 	struct nexio_priv *priv = usbtouch->priv;
880 	int ret = -ENOMEM;
881 	int actual_len, i;
882 	unsigned char *buf;
883 	char *firmware_ver = NULL, *device_name = NULL;
884 	int input_ep = 0, output_ep = 0;
885 
886 	/* find first input and output endpoint */
887 	for (i = 0; i < interface->desc.bNumEndpoints; i++) {
888 		if (!input_ep &&
889 		    usb_endpoint_dir_in(&interface->endpoint[i].desc))
890 			input_ep = interface->endpoint[i].desc.bEndpointAddress;
891 		if (!output_ep &&
892 		    usb_endpoint_dir_out(&interface->endpoint[i].desc))
893 			output_ep = interface->endpoint[i].desc.bEndpointAddress;
894 	}
895 	if (!input_ep || !output_ep)
896 		return -ENXIO;
897 
898 	buf = kmalloc(NEXIO_BUFSIZE, GFP_NOIO);
899 	if (!buf)
900 		goto out_buf;
901 
902 	/* two empty reads */
903 	for (i = 0; i < 2; i++) {
904 		ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
905 				   buf, NEXIO_BUFSIZE, &actual_len,
906 				   NEXIO_TIMEOUT);
907 		if (ret < 0)
908 			goto out_buf;
909 	}
910 
911 	/* send init command */
912 	memcpy(buf, nexio_init_pkt, sizeof(nexio_init_pkt));
913 	ret = usb_bulk_msg(dev, usb_sndbulkpipe(dev, output_ep),
914 			   buf, sizeof(nexio_init_pkt), &actual_len,
915 			   NEXIO_TIMEOUT);
916 	if (ret < 0)
917 		goto out_buf;
918 
919 	/* read replies */
920 	for (i = 0; i < 3; i++) {
921 		memset(buf, 0, NEXIO_BUFSIZE);
922 		ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
923 				   buf, NEXIO_BUFSIZE, &actual_len,
924 				   NEXIO_TIMEOUT);
925 		if (ret < 0 || actual_len < 1 || buf[1] != actual_len)
926 			continue;
927 		switch (buf[0]) {
928 		case 0x83:	/* firmware version */
929 			if (!firmware_ver)
930 				firmware_ver = kstrdup(&buf[2], GFP_NOIO);
931 			break;
932 		case 0x84:	/* device name */
933 			if (!device_name)
934 				device_name = kstrdup(&buf[2], GFP_NOIO);
935 			break;
936 		}
937 	}
938 
939 	printk(KERN_INFO "Nexio device: %s, firmware version: %s\n",
940 	       device_name, firmware_ver);
941 
942 	kfree(firmware_ver);
943 	kfree(device_name);
944 
945 	usb_fill_bulk_urb(priv->ack, dev, usb_sndbulkpipe(dev, output_ep),
946 			  priv->ack_buf, sizeof(nexio_ack_pkt),
947 			  nexio_ack_complete, usbtouch);
948 	ret = 0;
949 
950 out_buf:
951 	kfree(buf);
952 	return ret;
953 }
954 
955 static void nexio_exit(struct usbtouch_usb *usbtouch)
956 {
957 	struct nexio_priv *priv = usbtouch->priv;
958 
959 	usb_kill_urb(priv->ack);
960 	usb_free_urb(priv->ack);
961 	kfree(priv->ack_buf);
962 	kfree(priv);
963 }
964 
965 static int nexio_read_data(struct usbtouch_usb *usbtouch, unsigned char *pkt)
966 {
967 	struct nexio_touch_packet *packet = (void *) pkt;
968 	struct nexio_priv *priv = usbtouch->priv;
969 	unsigned int data_len = be16_to_cpu(packet->data_len);
970 	unsigned int x_len = be16_to_cpu(packet->x_len);
971 	unsigned int y_len = be16_to_cpu(packet->y_len);
972 	int x, y, begin_x, begin_y, end_x, end_y, w, h, ret;
973 
974 	/* got touch data? */
975 	if ((pkt[0] & 0xe0) != 0xe0)
976 		return 0;
977 
978 	if (data_len > 0xff)
979 		data_len -= 0x100;
980 	if (x_len > 0xff)
981 		x_len -= 0x80;
982 
983 	/* send ACK */
984 	ret = usb_submit_urb(priv->ack, GFP_ATOMIC);
985 
986 	if (!usbtouch->type->max_xc) {
987 		usbtouch->type->max_xc = 2 * x_len;
988 		input_set_abs_params(usbtouch->input, ABS_X,
989 				     0, usbtouch->type->max_xc, 0, 0);
990 		usbtouch->type->max_yc = 2 * y_len;
991 		input_set_abs_params(usbtouch->input, ABS_Y,
992 				     0, usbtouch->type->max_yc, 0, 0);
993 	}
994 	/*
995 	 * The device reports state of IR sensors on X and Y axes.
996 	 * Each byte represents "darkness" percentage (0-100) of one element.
997 	 * 17" touchscreen reports only 64 x 52 bytes so the resolution is low.
998 	 * This also means that there's a limited multi-touch capability but
999 	 * it's disabled (and untested) here as there's no X driver for that.
1000 	 */
1001 	begin_x = end_x = begin_y = end_y = -1;
1002 	for (x = 0; x < x_len; x++) {
1003 		if (begin_x == -1 && packet->data[x] > NEXIO_THRESHOLD) {
1004 			begin_x = x;
1005 			continue;
1006 		}
1007 		if (end_x == -1 && begin_x != -1 && packet->data[x] < NEXIO_THRESHOLD) {
1008 			end_x = x - 1;
1009 			for (y = x_len; y < data_len; y++) {
1010 				if (begin_y == -1 && packet->data[y] > NEXIO_THRESHOLD) {
1011 					begin_y = y - x_len;
1012 					continue;
1013 				}
1014 				if (end_y == -1 &&
1015 				    begin_y != -1 && packet->data[y] < NEXIO_THRESHOLD) {
1016 					end_y = y - 1 - x_len;
1017 					w = end_x - begin_x;
1018 					h = end_y - begin_y;
1019 #if 0
1020 					/* multi-touch */
1021 					input_report_abs(usbtouch->input,
1022 						    ABS_MT_TOUCH_MAJOR, max(w,h));
1023 					input_report_abs(usbtouch->input,
1024 						    ABS_MT_TOUCH_MINOR, min(x,h));
1025 					input_report_abs(usbtouch->input,
1026 						    ABS_MT_POSITION_X, 2*begin_x+w);
1027 					input_report_abs(usbtouch->input,
1028 						    ABS_MT_POSITION_Y, 2*begin_y+h);
1029 					input_report_abs(usbtouch->input,
1030 						    ABS_MT_ORIENTATION, w > h);
1031 					input_mt_sync(usbtouch->input);
1032 #endif
1033 					/* single touch */
1034 					usbtouch->x = 2 * begin_x + w;
1035 					usbtouch->y = 2 * begin_y + h;
1036 					usbtouch->touch = packet->flags & 0x01;
1037 					begin_y = end_y = -1;
1038 					return 1;
1039 				}
1040 			}
1041 			begin_x = end_x = -1;
1042 		}
1043 
1044 	}
1045 	return 0;
1046 }
1047 #endif
1048 
1049 
1050 /*****************************************************************************
1051  * ELO part
1052  */
1053 
1054 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
1055 
1056 static int elo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
1057 {
1058 	dev->x = (pkt[3] << 8) | pkt[2];
1059 	dev->y = (pkt[5] << 8) | pkt[4];
1060 	dev->touch = pkt[6] > 0;
1061 	dev->press = pkt[6];
1062 
1063 	return 1;
1064 }
1065 #endif
1066 
1067 
1068 /*****************************************************************************
1069  * the different device descriptors
1070  */
1071 #ifdef MULTI_PACKET
1072 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1073 				   unsigned char *pkt, int len);
1074 #endif
1075 
1076 static struct usbtouch_device_info usbtouch_dev_info[] = {
1077 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
1078 	[DEVTYPE_ELO] = {
1079 		.min_xc		= 0x0,
1080 		.max_xc		= 0x0fff,
1081 		.min_yc		= 0x0,
1082 		.max_yc		= 0x0fff,
1083 		.max_press	= 0xff,
1084 		.rept_size	= 8,
1085 		.read_data	= elo_read_data,
1086 	},
1087 #endif
1088 
1089 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
1090 	[DEVTYPE_EGALAX] = {
1091 		.min_xc		= 0x0,
1092 		.max_xc		= 0x07ff,
1093 		.min_yc		= 0x0,
1094 		.max_yc		= 0x07ff,
1095 		.rept_size	= 16,
1096 		.process_pkt	= usbtouch_process_multi,
1097 		.get_pkt_len	= egalax_get_pkt_len,
1098 		.read_data	= egalax_read_data,
1099 		.init		= egalax_init,
1100 	},
1101 #endif
1102 
1103 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
1104 	[DEVTYPE_PANJIT] = {
1105 		.min_xc		= 0x0,
1106 		.max_xc		= 0x0fff,
1107 		.min_yc		= 0x0,
1108 		.max_yc		= 0x0fff,
1109 		.rept_size	= 8,
1110 		.read_data	= panjit_read_data,
1111 	},
1112 #endif
1113 
1114 #ifdef CONFIG_TOUCHSCREEN_USB_3M
1115 	[DEVTYPE_3M] = {
1116 		.min_xc		= 0x0,
1117 		.max_xc		= 0x4000,
1118 		.min_yc		= 0x0,
1119 		.max_yc		= 0x4000,
1120 		.rept_size	= 11,
1121 		.read_data	= mtouch_read_data,
1122 		.init		= mtouch_init,
1123 	},
1124 #endif
1125 
1126 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
1127 	[DEVTYPE_ITM] = {
1128 		.min_xc		= 0x0,
1129 		.max_xc		= 0x0fff,
1130 		.min_yc		= 0x0,
1131 		.max_yc		= 0x0fff,
1132 		.max_press	= 0xff,
1133 		.rept_size	= 8,
1134 		.read_data	= itm_read_data,
1135 	},
1136 #endif
1137 
1138 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
1139 	[DEVTYPE_ETURBO] = {
1140 		.min_xc		= 0x0,
1141 		.max_xc		= 0x07ff,
1142 		.min_yc		= 0x0,
1143 		.max_yc		= 0x07ff,
1144 		.rept_size	= 8,
1145 		.process_pkt	= usbtouch_process_multi,
1146 		.get_pkt_len	= eturbo_get_pkt_len,
1147 		.read_data	= eturbo_read_data,
1148 	},
1149 #endif
1150 
1151 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
1152 	[DEVTYPE_GUNZE] = {
1153 		.min_xc		= 0x0,
1154 		.max_xc		= 0x0fff,
1155 		.min_yc		= 0x0,
1156 		.max_yc		= 0x0fff,
1157 		.rept_size	= 4,
1158 		.read_data	= gunze_read_data,
1159 	},
1160 #endif
1161 
1162 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
1163 	[DEVTYPE_DMC_TSC10] = {
1164 		.min_xc		= 0x0,
1165 		.max_xc		= 0x03ff,
1166 		.min_yc		= 0x0,
1167 		.max_yc		= 0x03ff,
1168 		.rept_size	= 5,
1169 		.init		= dmc_tsc10_init,
1170 		.read_data	= dmc_tsc10_read_data,
1171 	},
1172 #endif
1173 
1174 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
1175 	[DEVTYPE_IRTOUCH] = {
1176 		.min_xc		= 0x0,
1177 		.max_xc		= 0x0fff,
1178 		.min_yc		= 0x0,
1179 		.max_yc		= 0x0fff,
1180 		.rept_size	= 8,
1181 		.read_data	= irtouch_read_data,
1182 	},
1183 
1184 	[DEVTYPE_IRTOUCH_HIRES] = {
1185 		.min_xc		= 0x0,
1186 		.max_xc		= 0x7fff,
1187 		.min_yc		= 0x0,
1188 		.max_yc		= 0x7fff,
1189 		.rept_size	= 8,
1190 		.read_data	= irtouch_read_data,
1191 	},
1192 #endif
1193 
1194 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
1195 	[DEVTYPE_IDEALTEK] = {
1196 		.min_xc		= 0x0,
1197 		.max_xc		= 0x0fff,
1198 		.min_yc		= 0x0,
1199 		.max_yc		= 0x0fff,
1200 		.rept_size	= 8,
1201 		.process_pkt	= usbtouch_process_multi,
1202 		.get_pkt_len	= idealtek_get_pkt_len,
1203 		.read_data	= idealtek_read_data,
1204 	},
1205 #endif
1206 
1207 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
1208 	[DEVTYPE_GENERAL_TOUCH] = {
1209 		.min_xc		= 0x0,
1210 		.max_xc		= 0x7fff,
1211 		.min_yc		= 0x0,
1212 		.max_yc		= 0x7fff,
1213 		.rept_size	= 7,
1214 		.read_data	= general_touch_read_data,
1215 	},
1216 #endif
1217 
1218 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
1219 	[DEVTYPE_GOTOP] = {
1220 		.min_xc		= 0x0,
1221 		.max_xc		= 0x03ff,
1222 		.min_yc		= 0x0,
1223 		.max_yc		= 0x03ff,
1224 		.rept_size	= 4,
1225 		.read_data	= gotop_read_data,
1226 	},
1227 #endif
1228 
1229 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
1230 	[DEVTYPE_JASTEC] = {
1231 		.min_xc		= 0x0,
1232 		.max_xc		= 0x0fff,
1233 		.min_yc		= 0x0,
1234 		.max_yc		= 0x0fff,
1235 		.rept_size	= 4,
1236 		.read_data	= jastec_read_data,
1237 	},
1238 #endif
1239 
1240 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
1241 	[DEVTYPE_E2I] = {
1242 		.min_xc		= 0x0,
1243 		.max_xc		= 0x7fff,
1244 		.min_yc		= 0x0,
1245 		.max_yc		= 0x7fff,
1246 		.rept_size	= 6,
1247 		.init		= e2i_init,
1248 		.read_data	= e2i_read_data,
1249 	},
1250 #endif
1251 
1252 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
1253 	[DEVTYPE_ZYTRONIC] = {
1254 		.min_xc		= 0x0,
1255 		.max_xc		= 0x03ff,
1256 		.min_yc		= 0x0,
1257 		.max_yc		= 0x03ff,
1258 		.rept_size	= 5,
1259 		.read_data	= zytronic_read_data,
1260 		.irq_always     = true,
1261 	},
1262 #endif
1263 
1264 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
1265 	[DEVTYPE_TC45USB] = {
1266 		.min_xc		= 0x0,
1267 		.max_xc		= 0x0fff,
1268 		.min_yc		= 0x0,
1269 		.max_yc		= 0x0fff,
1270 		.rept_size	= 5,
1271 		.read_data	= tc45usb_read_data,
1272 	},
1273 #endif
1274 
1275 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
1276 	[DEVTYPE_NEXIO] = {
1277 		.rept_size	= 1024,
1278 		.irq_always	= true,
1279 		.read_data	= nexio_read_data,
1280 		.alloc		= nexio_alloc,
1281 		.init		= nexio_init,
1282 		.exit		= nexio_exit,
1283 	},
1284 #endif
1285 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
1286 	[DEVTYPE_ETOUCH] = {
1287 		.min_xc		= 0x0,
1288 		.max_xc		= 0x07ff,
1289 		.min_yc		= 0x0,
1290 		.max_yc		= 0x07ff,
1291 		.rept_size	= 16,
1292 		.process_pkt	= usbtouch_process_multi,
1293 		.get_pkt_len	= etouch_get_pkt_len,
1294 		.read_data	= etouch_read_data,
1295 	},
1296 #endif
1297 };
1298 
1299 
1300 /*****************************************************************************
1301  * Generic Part
1302  */
1303 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
1304                                  unsigned char *pkt, int len)
1305 {
1306 	struct usbtouch_device_info *type = usbtouch->type;
1307 
1308 	if (!type->read_data(usbtouch, pkt))
1309 			return;
1310 
1311 	input_report_key(usbtouch->input, BTN_TOUCH, usbtouch->touch);
1312 
1313 	if (swap_xy) {
1314 		input_report_abs(usbtouch->input, ABS_X, usbtouch->y);
1315 		input_report_abs(usbtouch->input, ABS_Y, usbtouch->x);
1316 	} else {
1317 		input_report_abs(usbtouch->input, ABS_X, usbtouch->x);
1318 		input_report_abs(usbtouch->input, ABS_Y, usbtouch->y);
1319 	}
1320 	if (type->max_press)
1321 		input_report_abs(usbtouch->input, ABS_PRESSURE, usbtouch->press);
1322 	input_sync(usbtouch->input);
1323 }
1324 
1325 
1326 #ifdef MULTI_PACKET
1327 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1328                                    unsigned char *pkt, int len)
1329 {
1330 	unsigned char *buffer;
1331 	int pkt_len, pos, buf_len, tmp;
1332 
1333 	/* process buffer */
1334 	if (unlikely(usbtouch->buf_len)) {
1335 		/* try to get size */
1336 		pkt_len = usbtouch->type->get_pkt_len(
1337 				usbtouch->buffer, usbtouch->buf_len);
1338 
1339 		/* drop? */
1340 		if (unlikely(!pkt_len))
1341 			goto out_flush_buf;
1342 
1343 		/* need to append -pkt_len bytes before able to get size */
1344 		if (unlikely(pkt_len < 0)) {
1345 			int append = -pkt_len;
1346 			if (unlikely(append > len))
1347 			       append = len;
1348 			if (usbtouch->buf_len + append >= usbtouch->type->rept_size)
1349 				goto out_flush_buf;
1350 			memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, append);
1351 			usbtouch->buf_len += append;
1352 
1353 			pkt_len = usbtouch->type->get_pkt_len(
1354 					usbtouch->buffer, usbtouch->buf_len);
1355 			if (pkt_len < 0)
1356 				return;
1357 		}
1358 
1359 		/* append */
1360 		tmp = pkt_len - usbtouch->buf_len;
1361 		if (usbtouch->buf_len + tmp >= usbtouch->type->rept_size)
1362 			goto out_flush_buf;
1363 		memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, tmp);
1364 		usbtouch_process_pkt(usbtouch, usbtouch->buffer, pkt_len);
1365 
1366 		buffer = pkt + tmp;
1367 		buf_len = len - tmp;
1368 	} else {
1369 		buffer = pkt;
1370 		buf_len = len;
1371 	}
1372 
1373 	/* loop over the received packet, process */
1374 	pos = 0;
1375 	while (pos < buf_len) {
1376 		/* get packet len */
1377 		pkt_len = usbtouch->type->get_pkt_len(buffer + pos,
1378 							buf_len - pos);
1379 
1380 		/* unknown packet: skip one byte */
1381 		if (unlikely(!pkt_len)) {
1382 			pos++;
1383 			continue;
1384 		}
1385 
1386 		/* full packet: process */
1387 		if (likely((pkt_len > 0) && (pkt_len <= buf_len - pos))) {
1388 			usbtouch_process_pkt(usbtouch, buffer + pos, pkt_len);
1389 		} else {
1390 			/* incomplete packet: save in buffer */
1391 			memcpy(usbtouch->buffer, buffer + pos, buf_len - pos);
1392 			usbtouch->buf_len = buf_len - pos;
1393 			return;
1394 		}
1395 		pos += pkt_len;
1396 	}
1397 
1398 out_flush_buf:
1399 	usbtouch->buf_len = 0;
1400 	return;
1401 }
1402 #endif
1403 
1404 
1405 static void usbtouch_irq(struct urb *urb)
1406 {
1407 	struct usbtouch_usb *usbtouch = urb->context;
1408 	struct device *dev = &usbtouch->interface->dev;
1409 	int retval;
1410 
1411 	switch (urb->status) {
1412 	case 0:
1413 		/* success */
1414 		break;
1415 	case -ETIME:
1416 		/* this urb is timing out */
1417 		dev_dbg(dev,
1418 			"%s - urb timed out - was the device unplugged?\n",
1419 			__func__);
1420 		return;
1421 	case -ECONNRESET:
1422 	case -ENOENT:
1423 	case -ESHUTDOWN:
1424 	case -EPIPE:
1425 		/* this urb is terminated, clean up */
1426 		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1427 			__func__, urb->status);
1428 		return;
1429 	default:
1430 		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1431 			__func__, urb->status);
1432 		goto exit;
1433 	}
1434 
1435 	usbtouch->type->process_pkt(usbtouch, usbtouch->data, urb->actual_length);
1436 
1437 exit:
1438 	usb_mark_last_busy(interface_to_usbdev(usbtouch->interface));
1439 	retval = usb_submit_urb(urb, GFP_ATOMIC);
1440 	if (retval)
1441 		dev_err(dev, "%s - usb_submit_urb failed with result: %d\n",
1442 			__func__, retval);
1443 }
1444 
1445 static int usbtouch_open(struct input_dev *input)
1446 {
1447 	struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1448 	int r;
1449 
1450 	usbtouch->irq->dev = interface_to_usbdev(usbtouch->interface);
1451 
1452 	r = usb_autopm_get_interface(usbtouch->interface) ? -EIO : 0;
1453 	if (r < 0)
1454 		goto out;
1455 
1456 	mutex_lock(&usbtouch->pm_mutex);
1457 	if (!usbtouch->type->irq_always) {
1458 		if (usb_submit_urb(usbtouch->irq, GFP_KERNEL)) {
1459 			r = -EIO;
1460 			goto out_put;
1461 		}
1462 	}
1463 
1464 	usbtouch->interface->needs_remote_wakeup = 1;
1465 	usbtouch->is_open = true;
1466 out_put:
1467 	mutex_unlock(&usbtouch->pm_mutex);
1468 	usb_autopm_put_interface(usbtouch->interface);
1469 out:
1470 	return r;
1471 }
1472 
1473 static void usbtouch_close(struct input_dev *input)
1474 {
1475 	struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1476 	int r;
1477 
1478 	mutex_lock(&usbtouch->pm_mutex);
1479 	if (!usbtouch->type->irq_always)
1480 		usb_kill_urb(usbtouch->irq);
1481 	usbtouch->is_open = false;
1482 	mutex_unlock(&usbtouch->pm_mutex);
1483 
1484 	r = usb_autopm_get_interface(usbtouch->interface);
1485 	usbtouch->interface->needs_remote_wakeup = 0;
1486 	if (!r)
1487 		usb_autopm_put_interface(usbtouch->interface);
1488 }
1489 
1490 static int usbtouch_suspend
1491 (struct usb_interface *intf, pm_message_t message)
1492 {
1493 	struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1494 
1495 	usb_kill_urb(usbtouch->irq);
1496 
1497 	return 0;
1498 }
1499 
1500 static int usbtouch_resume(struct usb_interface *intf)
1501 {
1502 	struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1503 	int result = 0;
1504 
1505 	mutex_lock(&usbtouch->pm_mutex);
1506 	if (usbtouch->is_open || usbtouch->type->irq_always)
1507 		result = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1508 	mutex_unlock(&usbtouch->pm_mutex);
1509 
1510 	return result;
1511 }
1512 
1513 static int usbtouch_reset_resume(struct usb_interface *intf)
1514 {
1515 	struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1516 	int err = 0;
1517 
1518 	/* reinit the device */
1519 	if (usbtouch->type->init) {
1520 		err = usbtouch->type->init(usbtouch);
1521 		if (err) {
1522 			dev_dbg(&intf->dev,
1523 				"%s - type->init() failed, err: %d\n",
1524 				__func__, err);
1525 			return err;
1526 		}
1527 	}
1528 
1529 	/* restart IO if needed */
1530 	mutex_lock(&usbtouch->pm_mutex);
1531 	if (usbtouch->is_open)
1532 		err = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1533 	mutex_unlock(&usbtouch->pm_mutex);
1534 
1535 	return err;
1536 }
1537 
1538 static void usbtouch_free_buffers(struct usb_device *udev,
1539 				  struct usbtouch_usb *usbtouch)
1540 {
1541 	usb_free_coherent(udev, usbtouch->data_size,
1542 			  usbtouch->data, usbtouch->data_dma);
1543 	kfree(usbtouch->buffer);
1544 }
1545 
1546 static struct usb_endpoint_descriptor *
1547 usbtouch_get_input_endpoint(struct usb_host_interface *interface)
1548 {
1549 	int i;
1550 
1551 	for (i = 0; i < interface->desc.bNumEndpoints; i++)
1552 		if (usb_endpoint_dir_in(&interface->endpoint[i].desc))
1553 			return &interface->endpoint[i].desc;
1554 
1555 	return NULL;
1556 }
1557 
1558 static int usbtouch_probe(struct usb_interface *intf,
1559 			  const struct usb_device_id *id)
1560 {
1561 	struct usbtouch_usb *usbtouch;
1562 	struct input_dev *input_dev;
1563 	struct usb_endpoint_descriptor *endpoint;
1564 	struct usb_device *udev = interface_to_usbdev(intf);
1565 	struct usbtouch_device_info *type;
1566 	int err = -ENOMEM;
1567 
1568 	/* some devices are ignored */
1569 	if (id->driver_info == DEVTYPE_IGNORE)
1570 		return -ENODEV;
1571 
1572 	endpoint = usbtouch_get_input_endpoint(intf->cur_altsetting);
1573 	if (!endpoint)
1574 		return -ENXIO;
1575 
1576 	usbtouch = kzalloc(sizeof(struct usbtouch_usb), GFP_KERNEL);
1577 	input_dev = input_allocate_device();
1578 	if (!usbtouch || !input_dev)
1579 		goto out_free;
1580 
1581 	type = &usbtouch_dev_info[id->driver_info];
1582 	usbtouch->type = type;
1583 	if (!type->process_pkt)
1584 		type->process_pkt = usbtouch_process_pkt;
1585 
1586 	usbtouch->data_size = type->rept_size;
1587 	if (type->get_pkt_len) {
1588 		/*
1589 		 * When dealing with variable-length packets we should
1590 		 * not request more than wMaxPacketSize bytes at once
1591 		 * as we do not know if there is more data coming or
1592 		 * we filled exactly wMaxPacketSize bytes and there is
1593 		 * nothing else.
1594 		 */
1595 		usbtouch->data_size = min(usbtouch->data_size,
1596 					  usb_endpoint_maxp(endpoint));
1597 	}
1598 
1599 	usbtouch->data = usb_alloc_coherent(udev, usbtouch->data_size,
1600 					    GFP_KERNEL, &usbtouch->data_dma);
1601 	if (!usbtouch->data)
1602 		goto out_free;
1603 
1604 	if (type->get_pkt_len) {
1605 		usbtouch->buffer = kmalloc(type->rept_size, GFP_KERNEL);
1606 		if (!usbtouch->buffer)
1607 			goto out_free_buffers;
1608 	}
1609 
1610 	usbtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
1611 	if (!usbtouch->irq) {
1612 		dev_dbg(&intf->dev,
1613 			"%s - usb_alloc_urb failed: usbtouch->irq\n", __func__);
1614 		goto out_free_buffers;
1615 	}
1616 
1617 	usbtouch->interface = intf;
1618 	usbtouch->input = input_dev;
1619 
1620 	if (udev->manufacturer)
1621 		strlcpy(usbtouch->name, udev->manufacturer, sizeof(usbtouch->name));
1622 
1623 	if (udev->product) {
1624 		if (udev->manufacturer)
1625 			strlcat(usbtouch->name, " ", sizeof(usbtouch->name));
1626 		strlcat(usbtouch->name, udev->product, sizeof(usbtouch->name));
1627 	}
1628 
1629 	if (!strlen(usbtouch->name))
1630 		snprintf(usbtouch->name, sizeof(usbtouch->name),
1631 			"USB Touchscreen %04x:%04x",
1632 			 le16_to_cpu(udev->descriptor.idVendor),
1633 			 le16_to_cpu(udev->descriptor.idProduct));
1634 
1635 	usb_make_path(udev, usbtouch->phys, sizeof(usbtouch->phys));
1636 	strlcat(usbtouch->phys, "/input0", sizeof(usbtouch->phys));
1637 
1638 	input_dev->name = usbtouch->name;
1639 	input_dev->phys = usbtouch->phys;
1640 	usb_to_input_id(udev, &input_dev->id);
1641 	input_dev->dev.parent = &intf->dev;
1642 
1643 	input_set_drvdata(input_dev, usbtouch);
1644 
1645 	input_dev->open = usbtouch_open;
1646 	input_dev->close = usbtouch_close;
1647 
1648 	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1649 	input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1650 	input_set_abs_params(input_dev, ABS_X, type->min_xc, type->max_xc, 0, 0);
1651 	input_set_abs_params(input_dev, ABS_Y, type->min_yc, type->max_yc, 0, 0);
1652 	if (type->max_press)
1653 		input_set_abs_params(input_dev, ABS_PRESSURE, type->min_press,
1654 		                     type->max_press, 0, 0);
1655 
1656 	if (usb_endpoint_type(endpoint) == USB_ENDPOINT_XFER_INT)
1657 		usb_fill_int_urb(usbtouch->irq, udev,
1658 			 usb_rcvintpipe(udev, endpoint->bEndpointAddress),
1659 			 usbtouch->data, usbtouch->data_size,
1660 			 usbtouch_irq, usbtouch, endpoint->bInterval);
1661 	else
1662 		usb_fill_bulk_urb(usbtouch->irq, udev,
1663 			 usb_rcvbulkpipe(udev, endpoint->bEndpointAddress),
1664 			 usbtouch->data, usbtouch->data_size,
1665 			 usbtouch_irq, usbtouch);
1666 
1667 	usbtouch->irq->dev = udev;
1668 	usbtouch->irq->transfer_dma = usbtouch->data_dma;
1669 	usbtouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1670 
1671 	/* device specific allocations */
1672 	if (type->alloc) {
1673 		err = type->alloc(usbtouch);
1674 		if (err) {
1675 			dev_dbg(&intf->dev,
1676 				"%s - type->alloc() failed, err: %d\n",
1677 				__func__, err);
1678 			goto out_free_urb;
1679 		}
1680 	}
1681 
1682 	/* device specific initialisation*/
1683 	if (type->init) {
1684 		err = type->init(usbtouch);
1685 		if (err) {
1686 			dev_dbg(&intf->dev,
1687 				"%s - type->init() failed, err: %d\n",
1688 				__func__, err);
1689 			goto out_do_exit;
1690 		}
1691 	}
1692 
1693 	err = input_register_device(usbtouch->input);
1694 	if (err) {
1695 		dev_dbg(&intf->dev,
1696 			"%s - input_register_device failed, err: %d\n",
1697 			__func__, err);
1698 		goto out_do_exit;
1699 	}
1700 
1701 	usb_set_intfdata(intf, usbtouch);
1702 
1703 	if (usbtouch->type->irq_always) {
1704 		/* this can't fail */
1705 		usb_autopm_get_interface(intf);
1706 		err = usb_submit_urb(usbtouch->irq, GFP_KERNEL);
1707 		if (err) {
1708 			usb_autopm_put_interface(intf);
1709 			dev_err(&intf->dev,
1710 				"%s - usb_submit_urb failed with result: %d\n",
1711 				__func__, err);
1712 			goto out_unregister_input;
1713 		}
1714 	}
1715 
1716 	return 0;
1717 
1718 out_unregister_input:
1719 	input_unregister_device(input_dev);
1720 	input_dev = NULL;
1721 out_do_exit:
1722 	if (type->exit)
1723 		type->exit(usbtouch);
1724 out_free_urb:
1725 	usb_free_urb(usbtouch->irq);
1726 out_free_buffers:
1727 	usbtouch_free_buffers(udev, usbtouch);
1728 out_free:
1729 	input_free_device(input_dev);
1730 	kfree(usbtouch);
1731 	return err;
1732 }
1733 
1734 static void usbtouch_disconnect(struct usb_interface *intf)
1735 {
1736 	struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1737 
1738 	if (!usbtouch)
1739 		return;
1740 
1741 	dev_dbg(&intf->dev,
1742 		"%s - usbtouch is initialized, cleaning up\n", __func__);
1743 
1744 	usb_set_intfdata(intf, NULL);
1745 	/* this will stop IO via close */
1746 	input_unregister_device(usbtouch->input);
1747 	usb_free_urb(usbtouch->irq);
1748 	if (usbtouch->type->exit)
1749 		usbtouch->type->exit(usbtouch);
1750 	usbtouch_free_buffers(interface_to_usbdev(intf), usbtouch);
1751 	kfree(usbtouch);
1752 }
1753 
1754 MODULE_DEVICE_TABLE(usb, usbtouch_devices);
1755 
1756 static struct usb_driver usbtouch_driver = {
1757 	.name		= "usbtouchscreen",
1758 	.probe		= usbtouch_probe,
1759 	.disconnect	= usbtouch_disconnect,
1760 	.suspend	= usbtouch_suspend,
1761 	.resume		= usbtouch_resume,
1762 	.reset_resume	= usbtouch_reset_resume,
1763 	.id_table	= usbtouch_devices,
1764 	.supports_autosuspend = 1,
1765 };
1766 
1767 module_usb_driver(usbtouch_driver);
1768 
1769 MODULE_AUTHOR("Daniel Ritz <daniel.ritz@gmx.ch>");
1770 MODULE_DESCRIPTION("USB Touchscreen Driver");
1771 MODULE_LICENSE("GPL");
1772 
1773 MODULE_ALIAS("touchkitusb");
1774 MODULE_ALIAS("itmtouch");
1775 MODULE_ALIAS("mtouchusb");
1776