1 /******************************************************************************
3 * Driver for USB Touchscreens, supporting those devices:
5 * includes eTurboTouch CT-410/510/700
6 * - 3M/Microtouch EX II series
12 * - IRTOUCHSYSTEMS/UNITOP
15 * - GoTop Super_Q2/GogoPen/PenPower tablets
16 * - JASTEC USB touch controller/DigiTech DTR-02U
17 * - Zytronic capacitive touchscreen
19 * - Elo TouchSystems 2700 IntelliTouch
20 * - EasyTouch USB Dual/Multi touch controller from Data Modul
22 * Copyright (C) 2004-2007 by Daniel Ritz <daniel.ritz@gmx.ch>
23 * Copyright (C) by Todd E. Johnson (mtouchusb.c)
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.
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.
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.
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
46 *****************************************************************************/
50 #include <linux/kernel.h>
51 #include <linux/slab.h>
52 #include <linux/input.h>
53 #include <linux/module.h>
54 #include <linux/init.h>
55 #include <linux/usb.h>
56 #include <linux/usb/input.h>
57 #include <linux/hid.h>
60 #define DRIVER_VERSION "v0.6"
61 #define DRIVER_AUTHOR "Daniel Ritz <daniel.ritz@gmx.ch>"
62 #define DRIVER_DESC "USB Touchscreen Driver"
65 module_param(swap_xy, bool, 0644);
66 MODULE_PARM_DESC(swap_xy, "If set X and Y axes are swapped.");
68 static bool hwcalib_xy;
69 module_param(hwcalib_xy, bool, 0644);
70 MODULE_PARM_DESC(hwcalib_xy, "If set hw-calibrated X/Y are used if available");
72 /* device specifc data/functions */
74 struct usbtouch_device_info {
77 int min_press, max_press;
81 * Always service the USB devices irq not just when the input device is
82 * open. This is useful when devices have a watchdog which prevents us
83 * from periodically polling the device. Leave this unset unless your
84 * touchscreen device requires it, as it does consume more of the USB
89 void (*process_pkt) (struct usbtouch_usb *usbtouch, unsigned char *pkt, int len);
92 * used to get the packet len. possible return values:
95 * < 0: -return value more bytes needed
97 int (*get_pkt_len) (unsigned char *pkt, int len);
99 int (*read_data) (struct usbtouch_usb *usbtouch, unsigned char *pkt);
100 int (*alloc) (struct usbtouch_usb *usbtouch);
101 int (*init) (struct usbtouch_usb *usbtouch);
102 void (*exit) (struct usbtouch_usb *usbtouch);
105 /* a usbtouch device */
106 struct usbtouch_usb {
109 unsigned char *buffer;
112 struct usb_interface *interface;
113 struct input_dev *input;
114 struct usbtouch_device_info *type;
136 DEVTYPE_GENERAL_TOUCH,
147 #define USB_DEVICE_HID_CLASS(vend, prod) \
148 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS \
149 | USB_DEVICE_ID_MATCH_INT_PROTOCOL \
150 | USB_DEVICE_ID_MATCH_DEVICE, \
151 .idVendor = (vend), \
152 .idProduct = (prod), \
153 .bInterfaceClass = USB_INTERFACE_CLASS_HID, \
154 .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE
156 static const struct usb_device_id usbtouch_devices[] = {
157 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
158 /* ignore the HID capable devices, handled by usbhid */
159 {USB_DEVICE_HID_CLASS(0x0eef, 0x0001), .driver_info = DEVTYPE_IGNORE},
160 {USB_DEVICE_HID_CLASS(0x0eef, 0x0002), .driver_info = DEVTYPE_IGNORE},
162 /* normal device IDs */
163 {USB_DEVICE(0x3823, 0x0001), .driver_info = DEVTYPE_EGALAX},
164 {USB_DEVICE(0x3823, 0x0002), .driver_info = DEVTYPE_EGALAX},
165 {USB_DEVICE(0x0123, 0x0001), .driver_info = DEVTYPE_EGALAX},
166 {USB_DEVICE(0x0eef, 0x0001), .driver_info = DEVTYPE_EGALAX},
167 {USB_DEVICE(0x0eef, 0x0002), .driver_info = DEVTYPE_EGALAX},
168 {USB_DEVICE(0x1234, 0x0001), .driver_info = DEVTYPE_EGALAX},
169 {USB_DEVICE(0x1234, 0x0002), .driver_info = DEVTYPE_EGALAX},
172 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
173 {USB_DEVICE(0x134c, 0x0001), .driver_info = DEVTYPE_PANJIT},
174 {USB_DEVICE(0x134c, 0x0002), .driver_info = DEVTYPE_PANJIT},
175 {USB_DEVICE(0x134c, 0x0003), .driver_info = DEVTYPE_PANJIT},
176 {USB_DEVICE(0x134c, 0x0004), .driver_info = DEVTYPE_PANJIT},
179 #ifdef CONFIG_TOUCHSCREEN_USB_3M
180 {USB_DEVICE(0x0596, 0x0001), .driver_info = DEVTYPE_3M},
183 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
184 {USB_DEVICE(0x0403, 0xf9e9), .driver_info = DEVTYPE_ITM},
185 {USB_DEVICE(0x16e3, 0xf9e9), .driver_info = DEVTYPE_ITM},
188 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
189 {USB_DEVICE(0x1234, 0x5678), .driver_info = DEVTYPE_ETURBO},
192 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
193 {USB_DEVICE(0x0637, 0x0001), .driver_info = DEVTYPE_GUNZE},
196 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
197 {USB_DEVICE(0x0afa, 0x03e8), .driver_info = DEVTYPE_DMC_TSC10},
200 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
201 {USB_DEVICE(0x595a, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
202 {USB_DEVICE(0x6615, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
205 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
206 {USB_DEVICE(0x1391, 0x1000), .driver_info = DEVTYPE_IDEALTEK},
209 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
210 {USB_DEVICE(0x0dfc, 0x0001), .driver_info = DEVTYPE_GENERAL_TOUCH},
213 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
214 {USB_DEVICE(0x08f2, 0x007f), .driver_info = DEVTYPE_GOTOP},
215 {USB_DEVICE(0x08f2, 0x00ce), .driver_info = DEVTYPE_GOTOP},
216 {USB_DEVICE(0x08f2, 0x00f4), .driver_info = DEVTYPE_GOTOP},
219 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
220 {USB_DEVICE(0x0f92, 0x0001), .driver_info = DEVTYPE_JASTEC},
223 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
224 {USB_DEVICE(0x1ac7, 0x0001), .driver_info = DEVTYPE_E2I},
227 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
228 {USB_DEVICE(0x14c8, 0x0003), .driver_info = DEVTYPE_ZYTRONIC},
231 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
233 {USB_DEVICE(0x0664, 0x0309), .driver_info = DEVTYPE_TC45USB},
235 {USB_DEVICE(0x0664, 0x0306), .driver_info = DEVTYPE_TC45USB},
238 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
239 /* data interface only */
240 {USB_DEVICE_AND_INTERFACE_INFO(0x10f0, 0x2002, 0x0a, 0x00, 0x00),
241 .driver_info = DEVTYPE_NEXIO},
242 {USB_DEVICE_AND_INTERFACE_INFO(0x1870, 0x0001, 0x0a, 0x00, 0x00),
243 .driver_info = DEVTYPE_NEXIO},
246 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
247 {USB_DEVICE(0x04e7, 0x0020), .driver_info = DEVTYPE_ELO},
250 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
251 {USB_DEVICE(0x7374, 0x0001), .driver_info = DEVTYPE_ETOUCH},
258 /*****************************************************************************
262 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
263 static int e2i_init(struct usbtouch_usb *usbtouch)
266 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
268 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
269 0x01, 0x02, 0x0000, 0x0081,
270 NULL, 0, USB_CTRL_SET_TIMEOUT);
272 dev_dbg(&usbtouch->interface->dev,
273 "%s - usb_control_msg - E2I_RESET - bytes|err: %d\n",
278 static int e2i_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
280 int tmp = (pkt[0] << 8) | pkt[1];
281 dev->x = (pkt[2] << 8) | pkt[3];
282 dev->y = (pkt[4] << 8) | pkt[5];
285 dev->touch = (tmp > 0);
286 dev->press = (tmp > 0 ? tmp : 0);
293 /*****************************************************************************
297 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
303 #define EGALAX_PKT_TYPE_MASK 0xFE
304 #define EGALAX_PKT_TYPE_REPT 0x80
305 #define EGALAX_PKT_TYPE_DIAG 0x0A
307 static int egalax_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
309 if ((pkt[0] & EGALAX_PKT_TYPE_MASK) != EGALAX_PKT_TYPE_REPT)
312 dev->x = ((pkt[3] & 0x0F) << 7) | (pkt[4] & 0x7F);
313 dev->y = ((pkt[1] & 0x0F) << 7) | (pkt[2] & 0x7F);
314 dev->touch = pkt[0] & 0x01;
319 static int egalax_get_pkt_len(unsigned char *buf, int len)
321 switch (buf[0] & EGALAX_PKT_TYPE_MASK) {
322 case EGALAX_PKT_TYPE_REPT:
325 case EGALAX_PKT_TYPE_DIAG:
336 /*****************************************************************************
340 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
346 #define ETOUCH_PKT_TYPE_MASK 0xFE
347 #define ETOUCH_PKT_TYPE_REPT 0x80
348 #define ETOUCH_PKT_TYPE_REPT2 0xB0
349 #define ETOUCH_PKT_TYPE_DIAG 0x0A
351 static int etouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
353 if ((pkt[0] & ETOUCH_PKT_TYPE_MASK) != ETOUCH_PKT_TYPE_REPT &&
354 (pkt[0] & ETOUCH_PKT_TYPE_MASK) != ETOUCH_PKT_TYPE_REPT2)
357 dev->x = ((pkt[1] & 0x1F) << 7) | (pkt[2] & 0x7F);
358 dev->y = ((pkt[3] & 0x1F) << 7) | (pkt[4] & 0x7F);
359 dev->touch = pkt[0] & 0x01;
364 static int etouch_get_pkt_len(unsigned char *buf, int len)
366 switch (buf[0] & ETOUCH_PKT_TYPE_MASK) {
367 case ETOUCH_PKT_TYPE_REPT:
368 case ETOUCH_PKT_TYPE_REPT2:
371 case ETOUCH_PKT_TYPE_DIAG:
382 /*****************************************************************************
385 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
386 static int panjit_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
388 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
389 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
390 dev->touch = pkt[0] & 0x01;
397 /*****************************************************************************
400 #ifdef CONFIG_TOUCHSCREEN_USB_3M
402 #define MTOUCHUSB_ASYNC_REPORT 1
403 #define MTOUCHUSB_RESET 7
404 #define MTOUCHUSB_REQ_CTRLLR_ID 10
406 static int mtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
409 dev->x = (pkt[4] << 8) | pkt[3];
410 dev->y = 0xffff - ((pkt[6] << 8) | pkt[5]);
412 dev->x = (pkt[8] << 8) | pkt[7];
413 dev->y = (pkt[10] << 8) | pkt[9];
415 dev->touch = (pkt[2] & 0x40) ? 1 : 0;
420 static int mtouch_init(struct usbtouch_usb *usbtouch)
423 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
425 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
427 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
428 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
429 dev_dbg(&usbtouch->interface->dev,
430 "%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d\n",
436 for (i = 0; i < 3; i++) {
437 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
438 MTOUCHUSB_ASYNC_REPORT,
439 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
440 1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
441 dev_dbg(&usbtouch->interface->dev,
442 "%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d\n",
450 /* Default min/max xy are the raw values, override if using hw-calib */
452 input_set_abs_params(usbtouch->input, ABS_X, 0, 0xffff, 0, 0);
453 input_set_abs_params(usbtouch->input, ABS_Y, 0, 0xffff, 0, 0);
461 /*****************************************************************************
464 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
465 static int itm_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
469 * ITM devices report invalid x/y data if not touched.
470 * if the screen was touched before but is not touched any more
471 * report touch as 0 with the last valid x/y data once. then stop
472 * reporting data until touched again.
474 dev->press = ((pkt[2] & 0x01) << 7) | (pkt[5] & 0x7F);
476 touch = ~pkt[7] & 0x20;
486 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[3] & 0x7F);
487 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[4] & 0x7F);
495 /*****************************************************************************
498 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
502 static int eturbo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
506 /* packets should start with sync */
507 if (!(pkt[0] & 0x80))
510 shift = (6 - (pkt[0] & 0x03));
511 dev->x = ((pkt[3] << 7) | pkt[4]) >> shift;
512 dev->y = ((pkt[1] << 7) | pkt[2]) >> shift;
513 dev->touch = (pkt[0] & 0x10) ? 1 : 0;
518 static int eturbo_get_pkt_len(unsigned char *buf, int len)
529 /*****************************************************************************
532 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
533 static int gunze_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
535 if (!(pkt[0] & 0x80) || ((pkt[1] | pkt[2] | pkt[3]) & 0x80))
538 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[2] & 0x7F);
539 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[3] & 0x7F);
540 dev->touch = pkt[0] & 0x20;
546 /*****************************************************************************
549 * Documentation about the controller and it's protocol can be found at
550 * http://www.dmccoltd.com/files/controler/tsc10usb_pi_e.pdf
551 * http://www.dmccoltd.com/files/controler/tsc25_usb_e.pdf
553 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
555 /* supported data rates. currently using 130 */
556 #define TSC10_RATE_POINT 0x50
557 #define TSC10_RATE_30 0x40
558 #define TSC10_RATE_50 0x41
559 #define TSC10_RATE_80 0x42
560 #define TSC10_RATE_100 0x43
561 #define TSC10_RATE_130 0x44
562 #define TSC10_RATE_150 0x45
565 #define TSC10_CMD_RESET 0x55
566 #define TSC10_CMD_RATE 0x05
567 #define TSC10_CMD_DATA1 0x01
569 static int dmc_tsc10_init(struct usbtouch_usb *usbtouch)
571 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
575 buf = kmalloc(2, GFP_NOIO);
579 buf[0] = buf[1] = 0xFF;
580 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
582 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
583 0, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
586 if (buf[0] != 0x06) {
591 /* set coordinate output rate */
592 buf[0] = buf[1] = 0xFF;
593 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
595 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
596 TSC10_RATE_150, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
599 if ((buf[0] != 0x06) && (buf[0] != 0x15 || buf[1] != 0x01)) {
604 /* start sending data */
605 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
607 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
608 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
616 static int dmc_tsc10_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
618 dev->x = ((pkt[2] & 0x03) << 8) | pkt[1];
619 dev->y = ((pkt[4] & 0x03) << 8) | pkt[3];
620 dev->touch = pkt[0] & 0x01;
627 /*****************************************************************************
630 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
631 static int irtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
633 dev->x = (pkt[3] << 8) | pkt[2];
634 dev->y = (pkt[5] << 8) | pkt[4];
635 dev->touch = (pkt[1] & 0x03) ? 1 : 0;
641 /*****************************************************************************
642 * ET&T TC5UH/TC4UM part
644 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
645 static int tc45usb_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
647 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
648 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
649 dev->touch = pkt[0] & 0x01;
655 /*****************************************************************************
656 * IdealTEK URTC1000 Part
658 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
662 static int idealtek_get_pkt_len(unsigned char *buf, int len)
671 static int idealtek_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
673 switch (pkt[0] & 0x98) {
675 /* touch data in IdealTEK mode */
676 dev->x = (pkt[1] << 5) | (pkt[2] >> 2);
677 dev->y = (pkt[3] << 5) | (pkt[4] >> 2);
678 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
682 /* touch data in MT emulation mode */
683 dev->x = (pkt[2] << 5) | (pkt[1] >> 2);
684 dev->y = (pkt[4] << 5) | (pkt[3] >> 2);
685 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
694 /*****************************************************************************
697 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
698 static int general_touch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
700 dev->x = (pkt[2] << 8) | pkt[1];
701 dev->y = (pkt[4] << 8) | pkt[3];
702 dev->press = pkt[5] & 0xff;
703 dev->touch = pkt[0] & 0x01;
709 /*****************************************************************************
712 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
713 static int gotop_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
715 dev->x = ((pkt[1] & 0x38) << 4) | pkt[2];
716 dev->y = ((pkt[1] & 0x07) << 7) | pkt[3];
717 dev->touch = pkt[0] & 0x01;
723 /*****************************************************************************
726 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
727 static int jastec_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
729 dev->x = ((pkt[0] & 0x3f) << 6) | (pkt[2] & 0x3f);
730 dev->y = ((pkt[1] & 0x3f) << 6) | (pkt[3] & 0x3f);
731 dev->touch = (pkt[0] & 0x40) >> 6;
737 /*****************************************************************************
740 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
741 static int zytronic_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
743 struct usb_interface *intf = dev->interface;
746 case 0x3A: /* command response */
747 dev_dbg(&intf->dev, "%s: Command response %d\n", __func__, pkt[1]);
750 case 0xC0: /* down */
751 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
752 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
754 dev_dbg(&intf->dev, "%s: down %d,%d\n", __func__, dev->x, dev->y);
758 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
759 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
761 dev_dbg(&intf->dev, "%s: up %d,%d\n", __func__, dev->x, dev->y);
765 dev_dbg(&intf->dev, "%s: Unknown return %d\n", __func__, pkt[0]);
773 /*****************************************************************************
776 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
778 #define NEXIO_TIMEOUT 5000
779 #define NEXIO_BUFSIZE 1024
780 #define NEXIO_THRESHOLD 50
784 unsigned char *ack_buf;
787 struct nexio_touch_packet {
788 u8 flags; /* 0xe1 = touch, 0xe1 = release */
789 __be16 data_len; /* total bytes of touch data */
790 __be16 x_len; /* bytes for X axis */
791 __be16 y_len; /* bytes for Y axis */
793 } __attribute__ ((packed));
795 static unsigned char nexio_ack_pkt[2] = { 0xaa, 0x02 };
796 static unsigned char nexio_init_pkt[4] = { 0x82, 0x04, 0x0a, 0x0f };
798 static void nexio_ack_complete(struct urb *urb)
802 static int nexio_alloc(struct usbtouch_usb *usbtouch)
804 struct nexio_priv *priv;
807 usbtouch->priv = kmalloc(sizeof(struct nexio_priv), GFP_KERNEL);
811 priv = usbtouch->priv;
813 priv->ack_buf = kmemdup(nexio_ack_pkt, sizeof(nexio_ack_pkt),
818 priv->ack = usb_alloc_urb(0, GFP_KERNEL);
820 dev_dbg(&usbtouch->interface->dev,
821 "%s - usb_alloc_urb failed: usbtouch->ack\n", __func__);
828 kfree(priv->ack_buf);
835 static int nexio_init(struct usbtouch_usb *usbtouch)
837 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
838 struct usb_host_interface *interface = usbtouch->interface->cur_altsetting;
839 struct nexio_priv *priv = usbtouch->priv;
843 char *firmware_ver = NULL, *device_name = NULL;
844 int input_ep = 0, output_ep = 0;
846 /* find first input and output endpoint */
847 for (i = 0; i < interface->desc.bNumEndpoints; i++) {
849 usb_endpoint_dir_in(&interface->endpoint[i].desc))
850 input_ep = interface->endpoint[i].desc.bEndpointAddress;
852 usb_endpoint_dir_out(&interface->endpoint[i].desc))
853 output_ep = interface->endpoint[i].desc.bEndpointAddress;
855 if (!input_ep || !output_ep)
858 buf = kmalloc(NEXIO_BUFSIZE, GFP_NOIO);
862 /* two empty reads */
863 for (i = 0; i < 2; i++) {
864 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
865 buf, NEXIO_BUFSIZE, &actual_len,
871 /* send init command */
872 memcpy(buf, nexio_init_pkt, sizeof(nexio_init_pkt));
873 ret = usb_bulk_msg(dev, usb_sndbulkpipe(dev, output_ep),
874 buf, sizeof(nexio_init_pkt), &actual_len,
880 for (i = 0; i < 3; i++) {
881 memset(buf, 0, NEXIO_BUFSIZE);
882 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
883 buf, NEXIO_BUFSIZE, &actual_len,
885 if (ret < 0 || actual_len < 1 || buf[1] != actual_len)
888 case 0x83: /* firmware version */
890 firmware_ver = kstrdup(&buf[2], GFP_NOIO);
892 case 0x84: /* device name */
894 device_name = kstrdup(&buf[2], GFP_NOIO);
899 printk(KERN_INFO "Nexio device: %s, firmware version: %s\n",
900 device_name, firmware_ver);
905 usb_fill_bulk_urb(priv->ack, dev, usb_sndbulkpipe(dev, output_ep),
906 priv->ack_buf, sizeof(nexio_ack_pkt),
907 nexio_ack_complete, usbtouch);
915 static void nexio_exit(struct usbtouch_usb *usbtouch)
917 struct nexio_priv *priv = usbtouch->priv;
919 usb_kill_urb(priv->ack);
920 usb_free_urb(priv->ack);
921 kfree(priv->ack_buf);
925 static int nexio_read_data(struct usbtouch_usb *usbtouch, unsigned char *pkt)
927 struct nexio_touch_packet *packet = (void *) pkt;
928 struct nexio_priv *priv = usbtouch->priv;
929 unsigned int data_len = be16_to_cpu(packet->data_len);
930 unsigned int x_len = be16_to_cpu(packet->x_len);
931 unsigned int y_len = be16_to_cpu(packet->y_len);
932 int x, y, begin_x, begin_y, end_x, end_y, w, h, ret;
934 /* got touch data? */
935 if ((pkt[0] & 0xe0) != 0xe0)
944 ret = usb_submit_urb(priv->ack, GFP_ATOMIC);
946 if (!usbtouch->type->max_xc) {
947 usbtouch->type->max_xc = 2 * x_len;
948 input_set_abs_params(usbtouch->input, ABS_X,
949 0, usbtouch->type->max_xc, 0, 0);
950 usbtouch->type->max_yc = 2 * y_len;
951 input_set_abs_params(usbtouch->input, ABS_Y,
952 0, usbtouch->type->max_yc, 0, 0);
955 * The device reports state of IR sensors on X and Y axes.
956 * Each byte represents "darkness" percentage (0-100) of one element.
957 * 17" touchscreen reports only 64 x 52 bytes so the resolution is low.
958 * This also means that there's a limited multi-touch capability but
959 * it's disabled (and untested) here as there's no X driver for that.
961 begin_x = end_x = begin_y = end_y = -1;
962 for (x = 0; x < x_len; x++) {
963 if (begin_x == -1 && packet->data[x] > NEXIO_THRESHOLD) {
967 if (end_x == -1 && begin_x != -1 && packet->data[x] < NEXIO_THRESHOLD) {
969 for (y = x_len; y < data_len; y++) {
970 if (begin_y == -1 && packet->data[y] > NEXIO_THRESHOLD) {
975 begin_y != -1 && packet->data[y] < NEXIO_THRESHOLD) {
976 end_y = y - 1 - x_len;
981 input_report_abs(usbtouch->input,
982 ABS_MT_TOUCH_MAJOR, max(w,h));
983 input_report_abs(usbtouch->input,
984 ABS_MT_TOUCH_MINOR, min(x,h));
985 input_report_abs(usbtouch->input,
986 ABS_MT_POSITION_X, 2*begin_x+w);
987 input_report_abs(usbtouch->input,
988 ABS_MT_POSITION_Y, 2*begin_y+h);
989 input_report_abs(usbtouch->input,
990 ABS_MT_ORIENTATION, w > h);
991 input_mt_sync(usbtouch->input);
994 usbtouch->x = 2 * begin_x + w;
995 usbtouch->y = 2 * begin_y + h;
996 usbtouch->touch = packet->flags & 0x01;
997 begin_y = end_y = -1;
1001 begin_x = end_x = -1;
1010 /*****************************************************************************
1014 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
1016 static int elo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
1018 dev->x = (pkt[3] << 8) | pkt[2];
1019 dev->y = (pkt[5] << 8) | pkt[4];
1020 dev->touch = pkt[6] > 0;
1021 dev->press = pkt[6];
1028 /*****************************************************************************
1029 * the different device descriptors
1032 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1033 unsigned char *pkt, int len);
1036 static struct usbtouch_device_info usbtouch_dev_info[] = {
1037 #ifdef CONFIG_TOUCHSCREEN_USB_ELO
1045 .read_data = elo_read_data,
1049 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
1050 [DEVTYPE_EGALAX] = {
1056 .process_pkt = usbtouch_process_multi,
1057 .get_pkt_len = egalax_get_pkt_len,
1058 .read_data = egalax_read_data,
1062 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
1063 [DEVTYPE_PANJIT] = {
1069 .read_data = panjit_read_data,
1073 #ifdef CONFIG_TOUCHSCREEN_USB_3M
1080 .read_data = mtouch_read_data,
1081 .init = mtouch_init,
1085 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
1093 .read_data = itm_read_data,
1097 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
1098 [DEVTYPE_ETURBO] = {
1104 .process_pkt = usbtouch_process_multi,
1105 .get_pkt_len = eturbo_get_pkt_len,
1106 .read_data = eturbo_read_data,
1110 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
1117 .read_data = gunze_read_data,
1121 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
1122 [DEVTYPE_DMC_TSC10] = {
1128 .init = dmc_tsc10_init,
1129 .read_data = dmc_tsc10_read_data,
1133 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
1134 [DEVTYPE_IRTOUCH] = {
1140 .read_data = irtouch_read_data,
1144 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
1145 [DEVTYPE_IDEALTEK] = {
1151 .process_pkt = usbtouch_process_multi,
1152 .get_pkt_len = idealtek_get_pkt_len,
1153 .read_data = idealtek_read_data,
1157 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
1158 [DEVTYPE_GENERAL_TOUCH] = {
1164 .read_data = general_touch_read_data,
1168 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
1175 .read_data = gotop_read_data,
1179 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
1180 [DEVTYPE_JASTEC] = {
1186 .read_data = jastec_read_data,
1190 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
1198 .read_data = e2i_read_data,
1202 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
1203 [DEVTYPE_ZYTRONIC] = {
1209 .read_data = zytronic_read_data,
1214 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
1215 [DEVTYPE_TC45USB] = {
1221 .read_data = tc45usb_read_data,
1225 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
1229 .read_data = nexio_read_data,
1230 .alloc = nexio_alloc,
1235 #ifdef CONFIG_TOUCHSCREEN_USB_EASYTOUCH
1236 [DEVTYPE_ETOUCH] = {
1242 .process_pkt = usbtouch_process_multi,
1243 .get_pkt_len = etouch_get_pkt_len,
1244 .read_data = etouch_read_data,
1250 /*****************************************************************************
1253 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
1254 unsigned char *pkt, int len)
1256 struct usbtouch_device_info *type = usbtouch->type;
1258 if (!type->read_data(usbtouch, pkt))
1261 input_report_key(usbtouch->input, BTN_TOUCH, usbtouch->touch);
1264 input_report_abs(usbtouch->input, ABS_X, usbtouch->y);
1265 input_report_abs(usbtouch->input, ABS_Y, usbtouch->x);
1267 input_report_abs(usbtouch->input, ABS_X, usbtouch->x);
1268 input_report_abs(usbtouch->input, ABS_Y, usbtouch->y);
1270 if (type->max_press)
1271 input_report_abs(usbtouch->input, ABS_PRESSURE, usbtouch->press);
1272 input_sync(usbtouch->input);
1277 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1278 unsigned char *pkt, int len)
1280 unsigned char *buffer;
1281 int pkt_len, pos, buf_len, tmp;
1283 /* process buffer */
1284 if (unlikely(usbtouch->buf_len)) {
1285 /* try to get size */
1286 pkt_len = usbtouch->type->get_pkt_len(
1287 usbtouch->buffer, usbtouch->buf_len);
1290 if (unlikely(!pkt_len))
1293 /* need to append -pkt_len bytes before able to get size */
1294 if (unlikely(pkt_len < 0)) {
1295 int append = -pkt_len;
1296 if (unlikely(append > len))
1298 if (usbtouch->buf_len + append >= usbtouch->type->rept_size)
1300 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, append);
1301 usbtouch->buf_len += append;
1303 pkt_len = usbtouch->type->get_pkt_len(
1304 usbtouch->buffer, usbtouch->buf_len);
1310 tmp = pkt_len - usbtouch->buf_len;
1311 if (usbtouch->buf_len + tmp >= usbtouch->type->rept_size)
1313 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, tmp);
1314 usbtouch_process_pkt(usbtouch, usbtouch->buffer, pkt_len);
1317 buf_len = len - tmp;
1323 /* loop over the received packet, process */
1325 while (pos < buf_len) {
1326 /* get packet len */
1327 pkt_len = usbtouch->type->get_pkt_len(buffer + pos,
1330 /* unknown packet: skip one byte */
1331 if (unlikely(!pkt_len)) {
1336 /* full packet: process */
1337 if (likely((pkt_len > 0) && (pkt_len <= buf_len - pos))) {
1338 usbtouch_process_pkt(usbtouch, buffer + pos, pkt_len);
1340 /* incomplete packet: save in buffer */
1341 memcpy(usbtouch->buffer, buffer + pos, buf_len - pos);
1342 usbtouch->buf_len = buf_len - pos;
1349 usbtouch->buf_len = 0;
1355 static void usbtouch_irq(struct urb *urb)
1357 struct usbtouch_usb *usbtouch = urb->context;
1358 struct device *dev = &usbtouch->interface->dev;
1361 switch (urb->status) {
1366 /* this urb is timing out */
1368 "%s - urb timed out - was the device unplugged?\n",
1375 /* this urb is terminated, clean up */
1376 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1377 __func__, urb->status);
1380 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
1381 __func__, urb->status);
1385 usbtouch->type->process_pkt(usbtouch, usbtouch->data, urb->actual_length);
1388 usb_mark_last_busy(interface_to_usbdev(usbtouch->interface));
1389 retval = usb_submit_urb(urb, GFP_ATOMIC);
1391 dev_err(dev, "%s - usb_submit_urb failed with result: %d\n",
1395 static int usbtouch_open(struct input_dev *input)
1397 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1400 usbtouch->irq->dev = interface_to_usbdev(usbtouch->interface);
1402 r = usb_autopm_get_interface(usbtouch->interface) ? -EIO : 0;
1406 if (!usbtouch->type->irq_always) {
1407 if (usb_submit_urb(usbtouch->irq, GFP_KERNEL)) {
1413 usbtouch->interface->needs_remote_wakeup = 1;
1415 usb_autopm_put_interface(usbtouch->interface);
1420 static void usbtouch_close(struct input_dev *input)
1422 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1425 if (!usbtouch->type->irq_always)
1426 usb_kill_urb(usbtouch->irq);
1427 r = usb_autopm_get_interface(usbtouch->interface);
1428 usbtouch->interface->needs_remote_wakeup = 0;
1430 usb_autopm_put_interface(usbtouch->interface);
1433 static int usbtouch_suspend
1434 (struct usb_interface *intf, pm_message_t message)
1436 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1438 usb_kill_urb(usbtouch->irq);
1443 static int usbtouch_resume(struct usb_interface *intf)
1445 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1446 struct input_dev *input = usbtouch->input;
1449 mutex_lock(&input->mutex);
1450 if (input->users || usbtouch->type->irq_always)
1451 result = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1452 mutex_unlock(&input->mutex);
1457 static int usbtouch_reset_resume(struct usb_interface *intf)
1459 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1460 struct input_dev *input = usbtouch->input;
1463 /* reinit the device */
1464 if (usbtouch->type->init) {
1465 err = usbtouch->type->init(usbtouch);
1468 "%s - type->init() failed, err: %d\n",
1474 /* restart IO if needed */
1475 mutex_lock(&input->mutex);
1477 err = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1478 mutex_unlock(&input->mutex);
1483 static void usbtouch_free_buffers(struct usb_device *udev,
1484 struct usbtouch_usb *usbtouch)
1486 usb_free_coherent(udev, usbtouch->type->rept_size,
1487 usbtouch->data, usbtouch->data_dma);
1488 kfree(usbtouch->buffer);
1491 static struct usb_endpoint_descriptor *
1492 usbtouch_get_input_endpoint(struct usb_host_interface *interface)
1496 for (i = 0; i < interface->desc.bNumEndpoints; i++)
1497 if (usb_endpoint_dir_in(&interface->endpoint[i].desc))
1498 return &interface->endpoint[i].desc;
1503 static int usbtouch_probe(struct usb_interface *intf,
1504 const struct usb_device_id *id)
1506 struct usbtouch_usb *usbtouch;
1507 struct input_dev *input_dev;
1508 struct usb_endpoint_descriptor *endpoint;
1509 struct usb_device *udev = interface_to_usbdev(intf);
1510 struct usbtouch_device_info *type;
1513 /* some devices are ignored */
1514 if (id->driver_info == DEVTYPE_IGNORE)
1517 endpoint = usbtouch_get_input_endpoint(intf->cur_altsetting);
1521 usbtouch = kzalloc(sizeof(struct usbtouch_usb), GFP_KERNEL);
1522 input_dev = input_allocate_device();
1523 if (!usbtouch || !input_dev)
1526 type = &usbtouch_dev_info[id->driver_info];
1527 usbtouch->type = type;
1528 if (!type->process_pkt)
1529 type->process_pkt = usbtouch_process_pkt;
1531 usbtouch->data = usb_alloc_coherent(udev, type->rept_size,
1532 GFP_KERNEL, &usbtouch->data_dma);
1533 if (!usbtouch->data)
1536 if (type->get_pkt_len) {
1537 usbtouch->buffer = kmalloc(type->rept_size, GFP_KERNEL);
1538 if (!usbtouch->buffer)
1539 goto out_free_buffers;
1542 usbtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
1543 if (!usbtouch->irq) {
1545 "%s - usb_alloc_urb failed: usbtouch->irq\n", __func__);
1546 goto out_free_buffers;
1549 usbtouch->interface = intf;
1550 usbtouch->input = input_dev;
1552 if (udev->manufacturer)
1553 strlcpy(usbtouch->name, udev->manufacturer, sizeof(usbtouch->name));
1555 if (udev->product) {
1556 if (udev->manufacturer)
1557 strlcat(usbtouch->name, " ", sizeof(usbtouch->name));
1558 strlcat(usbtouch->name, udev->product, sizeof(usbtouch->name));
1561 if (!strlen(usbtouch->name))
1562 snprintf(usbtouch->name, sizeof(usbtouch->name),
1563 "USB Touchscreen %04x:%04x",
1564 le16_to_cpu(udev->descriptor.idVendor),
1565 le16_to_cpu(udev->descriptor.idProduct));
1567 usb_make_path(udev, usbtouch->phys, sizeof(usbtouch->phys));
1568 strlcat(usbtouch->phys, "/input0", sizeof(usbtouch->phys));
1570 input_dev->name = usbtouch->name;
1571 input_dev->phys = usbtouch->phys;
1572 usb_to_input_id(udev, &input_dev->id);
1573 input_dev->dev.parent = &intf->dev;
1575 input_set_drvdata(input_dev, usbtouch);
1577 input_dev->open = usbtouch_open;
1578 input_dev->close = usbtouch_close;
1580 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1581 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1582 input_set_abs_params(input_dev, ABS_X, type->min_xc, type->max_xc, 0, 0);
1583 input_set_abs_params(input_dev, ABS_Y, type->min_yc, type->max_yc, 0, 0);
1584 if (type->max_press)
1585 input_set_abs_params(input_dev, ABS_PRESSURE, type->min_press,
1586 type->max_press, 0, 0);
1588 if (usb_endpoint_type(endpoint) == USB_ENDPOINT_XFER_INT)
1589 usb_fill_int_urb(usbtouch->irq, udev,
1590 usb_rcvintpipe(udev, endpoint->bEndpointAddress),
1591 usbtouch->data, type->rept_size,
1592 usbtouch_irq, usbtouch, endpoint->bInterval);
1594 usb_fill_bulk_urb(usbtouch->irq, udev,
1595 usb_rcvbulkpipe(udev, endpoint->bEndpointAddress),
1596 usbtouch->data, type->rept_size,
1597 usbtouch_irq, usbtouch);
1599 usbtouch->irq->dev = udev;
1600 usbtouch->irq->transfer_dma = usbtouch->data_dma;
1601 usbtouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1603 /* device specific allocations */
1605 err = type->alloc(usbtouch);
1608 "%s - type->alloc() failed, err: %d\n",
1614 /* device specific initialisation*/
1616 err = type->init(usbtouch);
1619 "%s - type->init() failed, err: %d\n",
1625 err = input_register_device(usbtouch->input);
1628 "%s - input_register_device failed, err: %d\n",
1633 usb_set_intfdata(intf, usbtouch);
1635 if (usbtouch->type->irq_always) {
1636 /* this can't fail */
1637 usb_autopm_get_interface(intf);
1638 err = usb_submit_urb(usbtouch->irq, GFP_KERNEL);
1640 usb_autopm_put_interface(intf);
1642 "%s - usb_submit_urb failed with result: %d\n",
1644 goto out_unregister_input;
1650 out_unregister_input:
1651 input_unregister_device(input_dev);
1655 type->exit(usbtouch);
1657 usb_free_urb(usbtouch->irq);
1659 usbtouch_free_buffers(udev, usbtouch);
1661 input_free_device(input_dev);
1666 static void usbtouch_disconnect(struct usb_interface *intf)
1668 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1674 "%s - usbtouch is initialized, cleaning up\n", __func__);
1676 usb_set_intfdata(intf, NULL);
1677 /* this will stop IO via close */
1678 input_unregister_device(usbtouch->input);
1679 usb_free_urb(usbtouch->irq);
1680 if (usbtouch->type->exit)
1681 usbtouch->type->exit(usbtouch);
1682 usbtouch_free_buffers(interface_to_usbdev(intf), usbtouch);
1686 MODULE_DEVICE_TABLE(usb, usbtouch_devices);
1688 static struct usb_driver usbtouch_driver = {
1689 .name = "usbtouchscreen",
1690 .probe = usbtouch_probe,
1691 .disconnect = usbtouch_disconnect,
1692 .suspend = usbtouch_suspend,
1693 .resume = usbtouch_resume,
1694 .reset_resume = usbtouch_reset_resume,
1695 .id_table = usbtouch_devices,
1696 .supports_autosuspend = 1,
1699 module_usb_driver(usbtouch_driver);
1701 MODULE_AUTHOR(DRIVER_AUTHOR);
1702 MODULE_DESCRIPTION(DRIVER_DESC);
1703 MODULE_LICENSE("GPL");
1705 MODULE_ALIAS("touchkitusb");
1706 MODULE_ALIAS("itmtouch");
1707 MODULE_ALIAS("mtouchusb");