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
20 * Copyright (C) 2004-2007 by Daniel Ritz <daniel.ritz@gmx.ch>
21 * Copyright (C) by Todd E. Johnson (mtouchusb.c)
23 * This program is free software; you can redistribute it and/or
24 * modify it under the terms of the GNU General Public License as
25 * published by the Free Software Foundation; either version 2 of the
26 * License, or (at your option) any later version.
28 * This program is distributed in the hope that it will be useful, but
29 * WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31 * General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
37 * Driver is based on touchkitusb.c
38 * - ITM parts are from itmtouch.c
39 * - 3M parts are from mtouchusb.c
40 * - PanJit parts are from an unmerged driver by Lanslott Gish
41 * - DMC TSC 10/25 are from Holger Schurig, with ideas from an unmerged
42 * driver from Marius Vollmer
44 *****************************************************************************/
48 #include <linux/kernel.h>
49 #include <linux/slab.h>
50 #include <linux/input.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/usb.h>
54 #include <linux/usb/input.h>
55 #include <linux/hid.h>
58 #define DRIVER_VERSION "v0.6"
59 #define DRIVER_AUTHOR "Daniel Ritz <daniel.ritz@gmx.ch>"
60 #define DRIVER_DESC "USB Touchscreen Driver"
63 module_param(swap_xy, bool, 0644);
64 MODULE_PARM_DESC(swap_xy, "If set X and Y axes are swapped.");
66 static int hwcalib_xy;
67 module_param(hwcalib_xy, bool, 0644);
68 MODULE_PARM_DESC(hwcalib_xy, "If set hw-calibrated X/Y are used if available");
70 /* device specifc data/functions */
72 struct usbtouch_device_info {
75 int min_press, max_press;
79 * Always service the USB devices irq not just when the input device is
80 * open. This is useful when devices have a watchdog which prevents us
81 * from periodically polling the device. Leave this unset unless your
82 * touchscreen device requires it, as it does consume more of the USB
87 void (*process_pkt) (struct usbtouch_usb *usbtouch, unsigned char *pkt, int len);
90 * used to get the packet len. possible return values:
93 * < 0: -return value more bytes needed
95 int (*get_pkt_len) (unsigned char *pkt, int len);
97 int (*read_data) (struct usbtouch_usb *usbtouch, unsigned char *pkt);
98 int (*alloc) (struct usbtouch_usb *usbtouch);
99 int (*init) (struct usbtouch_usb *usbtouch);
100 void (*exit) (struct usbtouch_usb *usbtouch);
103 /* a usbtouch device */
104 struct usbtouch_usb {
107 unsigned char *buffer;
110 struct usb_interface *interface;
111 struct input_dev *input;
112 struct usbtouch_device_info *type;
134 DEVTYPE_GENERAL_TOUCH,
143 #define USB_DEVICE_HID_CLASS(vend, prod) \
144 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS \
145 | USB_DEVICE_ID_MATCH_INT_PROTOCOL \
146 | USB_DEVICE_ID_MATCH_DEVICE, \
147 .idVendor = (vend), \
148 .idProduct = (prod), \
149 .bInterfaceClass = USB_INTERFACE_CLASS_HID, \
150 .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE
152 static const struct usb_device_id usbtouch_devices[] = {
153 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
154 /* ignore the HID capable devices, handled by usbhid */
155 {USB_DEVICE_HID_CLASS(0x0eef, 0x0001), .driver_info = DEVTYPE_IGNORE},
156 {USB_DEVICE_HID_CLASS(0x0eef, 0x0002), .driver_info = DEVTYPE_IGNORE},
158 /* normal device IDs */
159 {USB_DEVICE(0x3823, 0x0001), .driver_info = DEVTYPE_EGALAX},
160 {USB_DEVICE(0x3823, 0x0002), .driver_info = DEVTYPE_EGALAX},
161 {USB_DEVICE(0x0123, 0x0001), .driver_info = DEVTYPE_EGALAX},
162 {USB_DEVICE(0x0eef, 0x0001), .driver_info = DEVTYPE_EGALAX},
163 {USB_DEVICE(0x0eef, 0x0002), .driver_info = DEVTYPE_EGALAX},
164 {USB_DEVICE(0x1234, 0x0001), .driver_info = DEVTYPE_EGALAX},
165 {USB_DEVICE(0x1234, 0x0002), .driver_info = DEVTYPE_EGALAX},
168 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
169 {USB_DEVICE(0x134c, 0x0001), .driver_info = DEVTYPE_PANJIT},
170 {USB_DEVICE(0x134c, 0x0002), .driver_info = DEVTYPE_PANJIT},
171 {USB_DEVICE(0x134c, 0x0003), .driver_info = DEVTYPE_PANJIT},
172 {USB_DEVICE(0x134c, 0x0004), .driver_info = DEVTYPE_PANJIT},
175 #ifdef CONFIG_TOUCHSCREEN_USB_3M
176 {USB_DEVICE(0x0596, 0x0001), .driver_info = DEVTYPE_3M},
179 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
180 {USB_DEVICE(0x0403, 0xf9e9), .driver_info = DEVTYPE_ITM},
181 {USB_DEVICE(0x16e3, 0xf9e9), .driver_info = DEVTYPE_ITM},
184 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
185 {USB_DEVICE(0x1234, 0x5678), .driver_info = DEVTYPE_ETURBO},
188 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
189 {USB_DEVICE(0x0637, 0x0001), .driver_info = DEVTYPE_GUNZE},
192 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
193 {USB_DEVICE(0x0afa, 0x03e8), .driver_info = DEVTYPE_DMC_TSC10},
196 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
197 {USB_DEVICE(0x595a, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
198 {USB_DEVICE(0x6615, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
201 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
202 {USB_DEVICE(0x1391, 0x1000), .driver_info = DEVTYPE_IDEALTEK},
205 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
206 {USB_DEVICE(0x0dfc, 0x0001), .driver_info = DEVTYPE_GENERAL_TOUCH},
209 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
210 {USB_DEVICE(0x08f2, 0x007f), .driver_info = DEVTYPE_GOTOP},
211 {USB_DEVICE(0x08f2, 0x00ce), .driver_info = DEVTYPE_GOTOP},
212 {USB_DEVICE(0x08f2, 0x00f4), .driver_info = DEVTYPE_GOTOP},
215 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
216 {USB_DEVICE(0x0f92, 0x0001), .driver_info = DEVTYPE_JASTEC},
219 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
220 {USB_DEVICE(0x1ac7, 0x0001), .driver_info = DEVTYPE_E2I},
223 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
224 {USB_DEVICE(0x14c8, 0x0003), .driver_info = DEVTYPE_ZYTRONIC},
227 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
229 {USB_DEVICE(0x0664, 0x0309), .driver_info = DEVTYPE_TC45USB},
231 {USB_DEVICE(0x0664, 0x0306), .driver_info = DEVTYPE_TC45USB},
234 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
235 /* data interface only */
236 {USB_DEVICE_AND_INTERFACE_INFO(0x10f0, 0x2002, 0x0a, 0x00, 0x00),
237 .driver_info = DEVTYPE_NEXIO},
238 {USB_DEVICE_AND_INTERFACE_INFO(0x1870, 0x0001, 0x0a, 0x00, 0x00),
239 .driver_info = DEVTYPE_NEXIO},
246 /*****************************************************************************
250 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
251 static int e2i_init(struct usbtouch_usb *usbtouch)
254 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
256 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
257 0x01, 0x02, 0x0000, 0x0081,
258 NULL, 0, USB_CTRL_SET_TIMEOUT);
260 dbg("%s - usb_control_msg - E2I_RESET - bytes|err: %d",
265 static int e2i_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
267 int tmp = (pkt[0] << 8) | pkt[1];
268 dev->x = (pkt[2] << 8) | pkt[3];
269 dev->y = (pkt[4] << 8) | pkt[5];
272 dev->touch = (tmp > 0);
273 dev->press = (tmp > 0 ? tmp : 0);
280 /*****************************************************************************
284 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
290 #define EGALAX_PKT_TYPE_MASK 0xFE
291 #define EGALAX_PKT_TYPE_REPT 0x80
292 #define EGALAX_PKT_TYPE_DIAG 0x0A
294 static int egalax_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
296 if ((pkt[0] & EGALAX_PKT_TYPE_MASK) != EGALAX_PKT_TYPE_REPT)
299 dev->x = ((pkt[3] & 0x0F) << 7) | (pkt[4] & 0x7F);
300 dev->y = ((pkt[1] & 0x0F) << 7) | (pkt[2] & 0x7F);
301 dev->touch = pkt[0] & 0x01;
306 static int egalax_get_pkt_len(unsigned char *buf, int len)
308 switch (buf[0] & EGALAX_PKT_TYPE_MASK) {
309 case EGALAX_PKT_TYPE_REPT:
312 case EGALAX_PKT_TYPE_DIAG:
324 /*****************************************************************************
327 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
328 static int panjit_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
330 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
331 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
332 dev->touch = pkt[0] & 0x01;
339 /*****************************************************************************
342 #ifdef CONFIG_TOUCHSCREEN_USB_3M
344 #define MTOUCHUSB_ASYNC_REPORT 1
345 #define MTOUCHUSB_RESET 7
346 #define MTOUCHUSB_REQ_CTRLLR_ID 10
348 static int mtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
351 dev->x = (pkt[4] << 8) | pkt[3];
352 dev->y = 0xffff - ((pkt[6] << 8) | pkt[5]);
354 dev->x = (pkt[8] << 8) | pkt[7];
355 dev->y = (pkt[10] << 8) | pkt[9];
357 dev->touch = (pkt[2] & 0x40) ? 1 : 0;
362 static int mtouch_init(struct usbtouch_usb *usbtouch)
365 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
367 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
369 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
370 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
371 dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
377 for (i = 0; i < 3; i++) {
378 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
379 MTOUCHUSB_ASYNC_REPORT,
380 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
381 1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
382 dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
390 /* Default min/max xy are the raw values, override if using hw-calib */
392 input_set_abs_params(usbtouch->input, ABS_X, 0, 0xffff, 0, 0);
393 input_set_abs_params(usbtouch->input, ABS_Y, 0, 0xffff, 0, 0);
401 /*****************************************************************************
404 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
405 static int itm_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
409 * ITM devices report invalid x/y data if not touched.
410 * if the screen was touched before but is not touched any more
411 * report touch as 0 with the last valid x/y data once. then stop
412 * reporting data until touched again.
414 dev->press = ((pkt[2] & 0x01) << 7) | (pkt[5] & 0x7F);
416 touch = ~pkt[7] & 0x20;
426 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[3] & 0x7F);
427 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[4] & 0x7F);
435 /*****************************************************************************
438 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
442 static int eturbo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
446 /* packets should start with sync */
447 if (!(pkt[0] & 0x80))
450 shift = (6 - (pkt[0] & 0x03));
451 dev->x = ((pkt[3] << 7) | pkt[4]) >> shift;
452 dev->y = ((pkt[1] << 7) | pkt[2]) >> shift;
453 dev->touch = (pkt[0] & 0x10) ? 1 : 0;
458 static int eturbo_get_pkt_len(unsigned char *buf, int len)
469 /*****************************************************************************
472 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
473 static int gunze_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
475 if (!(pkt[0] & 0x80) || ((pkt[1] | pkt[2] | pkt[3]) & 0x80))
478 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[2] & 0x7F);
479 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[3] & 0x7F);
480 dev->touch = pkt[0] & 0x20;
486 /*****************************************************************************
489 * Documentation about the controller and it's protocol can be found at
490 * http://www.dmccoltd.com/files/controler/tsc10usb_pi_e.pdf
491 * http://www.dmccoltd.com/files/controler/tsc25_usb_e.pdf
493 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
495 /* supported data rates. currently using 130 */
496 #define TSC10_RATE_POINT 0x50
497 #define TSC10_RATE_30 0x40
498 #define TSC10_RATE_50 0x41
499 #define TSC10_RATE_80 0x42
500 #define TSC10_RATE_100 0x43
501 #define TSC10_RATE_130 0x44
502 #define TSC10_RATE_150 0x45
505 #define TSC10_CMD_RESET 0x55
506 #define TSC10_CMD_RATE 0x05
507 #define TSC10_CMD_DATA1 0x01
509 static int dmc_tsc10_init(struct usbtouch_usb *usbtouch)
511 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
515 buf = kmalloc(2, GFP_NOIO);
519 buf[0] = buf[1] = 0xFF;
520 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
522 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
523 0, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
526 if (buf[0] != 0x06) {
531 /* TSC-25 data sheet specifies a delay after the RESET command */
534 /* set coordinate output rate */
535 buf[0] = buf[1] = 0xFF;
536 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
538 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
539 TSC10_RATE_150, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
542 if ((buf[0] != 0x06) && (buf[0] != 0x15 || buf[1] != 0x01)) {
547 /* start sending data */
548 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
550 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
551 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
559 static int dmc_tsc10_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
561 dev->x = ((pkt[2] & 0x03) << 8) | pkt[1];
562 dev->y = ((pkt[4] & 0x03) << 8) | pkt[3];
563 dev->touch = pkt[0] & 0x01;
570 /*****************************************************************************
573 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
574 static int irtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
576 dev->x = (pkt[3] << 8) | pkt[2];
577 dev->y = (pkt[5] << 8) | pkt[4];
578 dev->touch = (pkt[1] & 0x03) ? 1 : 0;
584 /*****************************************************************************
585 * ET&T TC5UH/TC4UM part
587 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
588 static int tc45usb_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
590 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
591 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
592 dev->touch = pkt[0] & 0x01;
598 /*****************************************************************************
599 * IdealTEK URTC1000 Part
601 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
605 static int idealtek_get_pkt_len(unsigned char *buf, int len)
614 static int idealtek_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
616 switch (pkt[0] & 0x98) {
618 /* touch data in IdealTEK mode */
619 dev->x = (pkt[1] << 5) | (pkt[2] >> 2);
620 dev->y = (pkt[3] << 5) | (pkt[4] >> 2);
621 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
625 /* touch data in MT emulation mode */
626 dev->x = (pkt[2] << 5) | (pkt[1] >> 2);
627 dev->y = (pkt[4] << 5) | (pkt[3] >> 2);
628 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
637 /*****************************************************************************
640 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
641 static int general_touch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
643 dev->x = (pkt[2] << 8) | pkt[1];
644 dev->y = (pkt[4] << 8) | pkt[3];
645 dev->press = pkt[5] & 0xff;
646 dev->touch = pkt[0] & 0x01;
652 /*****************************************************************************
655 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
656 static int gotop_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
658 dev->x = ((pkt[1] & 0x38) << 4) | pkt[2];
659 dev->y = ((pkt[1] & 0x07) << 7) | pkt[3];
660 dev->touch = pkt[0] & 0x01;
666 /*****************************************************************************
669 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
670 static int jastec_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
672 dev->x = ((pkt[0] & 0x3f) << 6) | (pkt[2] & 0x3f);
673 dev->y = ((pkt[1] & 0x3f) << 6) | (pkt[3] & 0x3f);
674 dev->touch = (pkt[0] & 0x40) >> 6;
680 /*****************************************************************************
683 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
684 static int zytronic_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
687 case 0x3A: /* command response */
688 dbg("%s: Command response %d", __func__, pkt[1]);
691 case 0xC0: /* down */
692 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
693 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
695 dbg("%s: down %d,%d", __func__, dev->x, dev->y);
699 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
700 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
702 dbg("%s: up %d,%d", __func__, dev->x, dev->y);
706 dbg("%s: Unknown return %d", __func__, pkt[0]);
714 /*****************************************************************************
717 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
719 #define NEXIO_TIMEOUT 5000
720 #define NEXIO_BUFSIZE 1024
721 #define NEXIO_THRESHOLD 50
725 unsigned char *ack_buf;
728 struct nexio_touch_packet {
729 u8 flags; /* 0xe1 = touch, 0xe1 = release */
730 __be16 data_len; /* total bytes of touch data */
731 __be16 x_len; /* bytes for X axis */
732 __be16 y_len; /* bytes for Y axis */
734 } __attribute__ ((packed));
736 static unsigned char nexio_ack_pkt[2] = { 0xaa, 0x02 };
737 static unsigned char nexio_init_pkt[4] = { 0x82, 0x04, 0x0a, 0x0f };
739 static void nexio_ack_complete(struct urb *urb)
743 static int nexio_alloc(struct usbtouch_usb *usbtouch)
745 struct nexio_priv *priv;
748 usbtouch->priv = kmalloc(sizeof(struct nexio_priv), GFP_KERNEL);
752 priv = usbtouch->priv;
754 priv->ack_buf = kmemdup(nexio_ack_pkt, sizeof(nexio_ack_pkt),
759 priv->ack = usb_alloc_urb(0, GFP_KERNEL);
761 dbg("%s - usb_alloc_urb failed: usbtouch->ack", __func__);
768 kfree(priv->ack_buf);
775 static int nexio_init(struct usbtouch_usb *usbtouch)
777 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
778 struct usb_host_interface *interface = usbtouch->interface->cur_altsetting;
779 struct nexio_priv *priv = usbtouch->priv;
783 char *firmware_ver = NULL, *device_name = NULL;
784 int input_ep = 0, output_ep = 0;
786 /* find first input and output endpoint */
787 for (i = 0; i < interface->desc.bNumEndpoints; i++) {
789 usb_endpoint_dir_in(&interface->endpoint[i].desc))
790 input_ep = interface->endpoint[i].desc.bEndpointAddress;
792 usb_endpoint_dir_out(&interface->endpoint[i].desc))
793 output_ep = interface->endpoint[i].desc.bEndpointAddress;
795 if (!input_ep || !output_ep)
798 buf = kmalloc(NEXIO_BUFSIZE, GFP_NOIO);
802 /* two empty reads */
803 for (i = 0; i < 2; i++) {
804 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
805 buf, NEXIO_BUFSIZE, &actual_len,
811 /* send init command */
812 memcpy(buf, nexio_init_pkt, sizeof(nexio_init_pkt));
813 ret = usb_bulk_msg(dev, usb_sndbulkpipe(dev, output_ep),
814 buf, sizeof(nexio_init_pkt), &actual_len,
820 for (i = 0; i < 3; i++) {
821 memset(buf, 0, NEXIO_BUFSIZE);
822 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
823 buf, NEXIO_BUFSIZE, &actual_len,
825 if (ret < 0 || actual_len < 1 || buf[1] != actual_len)
828 case 0x83: /* firmware version */
830 firmware_ver = kstrdup(&buf[2], GFP_NOIO);
832 case 0x84: /* device name */
834 device_name = kstrdup(&buf[2], GFP_NOIO);
839 printk(KERN_INFO "Nexio device: %s, firmware version: %s\n",
840 device_name, firmware_ver);
845 usb_fill_bulk_urb(priv->ack, dev, usb_sndbulkpipe(dev, output_ep),
846 priv->ack_buf, sizeof(nexio_ack_pkt),
847 nexio_ack_complete, usbtouch);
855 static void nexio_exit(struct usbtouch_usb *usbtouch)
857 struct nexio_priv *priv = usbtouch->priv;
859 usb_kill_urb(priv->ack);
860 usb_free_urb(priv->ack);
861 kfree(priv->ack_buf);
865 static int nexio_read_data(struct usbtouch_usb *usbtouch, unsigned char *pkt)
867 struct nexio_touch_packet *packet = (void *) pkt;
868 struct nexio_priv *priv = usbtouch->priv;
869 unsigned int data_len = be16_to_cpu(packet->data_len);
870 unsigned int x_len = be16_to_cpu(packet->x_len);
871 unsigned int y_len = be16_to_cpu(packet->y_len);
872 int x, y, begin_x, begin_y, end_x, end_y, w, h, ret;
874 /* got touch data? */
875 if ((pkt[0] & 0xe0) != 0xe0)
884 ret = usb_submit_urb(priv->ack, GFP_ATOMIC);
886 if (!usbtouch->type->max_xc) {
887 usbtouch->type->max_xc = 2 * x_len;
888 input_set_abs_params(usbtouch->input, ABS_X,
889 0, usbtouch->type->max_xc, 0, 0);
890 usbtouch->type->max_yc = 2 * y_len;
891 input_set_abs_params(usbtouch->input, ABS_Y,
892 0, usbtouch->type->max_yc, 0, 0);
895 * The device reports state of IR sensors on X and Y axes.
896 * Each byte represents "darkness" percentage (0-100) of one element.
897 * 17" touchscreen reports only 64 x 52 bytes so the resolution is low.
898 * This also means that there's a limited multi-touch capability but
899 * it's disabled (and untested) here as there's no X driver for that.
901 begin_x = end_x = begin_y = end_y = -1;
902 for (x = 0; x < x_len; x++) {
903 if (begin_x == -1 && packet->data[x] > NEXIO_THRESHOLD) {
907 if (end_x == -1 && begin_x != -1 && packet->data[x] < NEXIO_THRESHOLD) {
909 for (y = x_len; y < data_len; y++) {
910 if (begin_y == -1 && packet->data[y] > NEXIO_THRESHOLD) {
915 begin_y != -1 && packet->data[y] < NEXIO_THRESHOLD) {
916 end_y = y - 1 - x_len;
921 input_report_abs(usbtouch->input,
922 ABS_MT_TOUCH_MAJOR, max(w,h));
923 input_report_abs(usbtouch->input,
924 ABS_MT_TOUCH_MINOR, min(x,h));
925 input_report_abs(usbtouch->input,
926 ABS_MT_POSITION_X, 2*begin_x+w);
927 input_report_abs(usbtouch->input,
928 ABS_MT_POSITION_Y, 2*begin_y+h);
929 input_report_abs(usbtouch->input,
930 ABS_MT_ORIENTATION, w > h);
931 input_mt_sync(usbtouch->input);
934 usbtouch->x = 2 * begin_x + w;
935 usbtouch->y = 2 * begin_y + h;
936 usbtouch->touch = packet->flags & 0x01;
937 begin_y = end_y = -1;
941 begin_x = end_x = -1;
950 /*****************************************************************************
951 * the different device descriptors
954 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
955 unsigned char *pkt, int len);
958 static struct usbtouch_device_info usbtouch_dev_info[] = {
959 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
966 .process_pkt = usbtouch_process_multi,
967 .get_pkt_len = egalax_get_pkt_len,
968 .read_data = egalax_read_data,
972 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
979 .read_data = panjit_read_data,
983 #ifdef CONFIG_TOUCHSCREEN_USB_3M
990 .read_data = mtouch_read_data,
995 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
1003 .read_data = itm_read_data,
1007 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
1008 [DEVTYPE_ETURBO] = {
1014 .process_pkt = usbtouch_process_multi,
1015 .get_pkt_len = eturbo_get_pkt_len,
1016 .read_data = eturbo_read_data,
1020 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
1027 .read_data = gunze_read_data,
1031 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
1032 [DEVTYPE_DMC_TSC10] = {
1038 .init = dmc_tsc10_init,
1039 .read_data = dmc_tsc10_read_data,
1043 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
1044 [DEVTYPE_IRTOUCH] = {
1050 .read_data = irtouch_read_data,
1054 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
1055 [DEVTYPE_IDEALTEK] = {
1061 .process_pkt = usbtouch_process_multi,
1062 .get_pkt_len = idealtek_get_pkt_len,
1063 .read_data = idealtek_read_data,
1067 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
1068 [DEVTYPE_GENERAL_TOUCH] = {
1074 .read_data = general_touch_read_data,
1078 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
1085 .read_data = gotop_read_data,
1089 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
1090 [DEVTYPE_JASTEC] = {
1096 .read_data = jastec_read_data,
1100 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
1108 .read_data = e2i_read_data,
1112 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
1113 [DEVTYPE_ZYTRONIC] = {
1119 .read_data = zytronic_read_data,
1124 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC45USB
1125 [DEVTYPE_TC45USB] = {
1131 .read_data = tc45usb_read_data,
1135 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
1139 .read_data = nexio_read_data,
1140 .alloc = nexio_alloc,
1148 /*****************************************************************************
1151 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
1152 unsigned char *pkt, int len)
1154 struct usbtouch_device_info *type = usbtouch->type;
1156 if (!type->read_data(usbtouch, pkt))
1159 input_report_key(usbtouch->input, BTN_TOUCH, usbtouch->touch);
1162 input_report_abs(usbtouch->input, ABS_X, usbtouch->y);
1163 input_report_abs(usbtouch->input, ABS_Y, usbtouch->x);
1165 input_report_abs(usbtouch->input, ABS_X, usbtouch->x);
1166 input_report_abs(usbtouch->input, ABS_Y, usbtouch->y);
1168 if (type->max_press)
1169 input_report_abs(usbtouch->input, ABS_PRESSURE, usbtouch->press);
1170 input_sync(usbtouch->input);
1175 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1176 unsigned char *pkt, int len)
1178 unsigned char *buffer;
1179 int pkt_len, pos, buf_len, tmp;
1181 /* process buffer */
1182 if (unlikely(usbtouch->buf_len)) {
1183 /* try to get size */
1184 pkt_len = usbtouch->type->get_pkt_len(
1185 usbtouch->buffer, usbtouch->buf_len);
1188 if (unlikely(!pkt_len))
1191 /* need to append -pkt_len bytes before able to get size */
1192 if (unlikely(pkt_len < 0)) {
1193 int append = -pkt_len;
1194 if (unlikely(append > len))
1196 if (usbtouch->buf_len + append >= usbtouch->type->rept_size)
1198 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, append);
1199 usbtouch->buf_len += append;
1201 pkt_len = usbtouch->type->get_pkt_len(
1202 usbtouch->buffer, usbtouch->buf_len);
1208 tmp = pkt_len - usbtouch->buf_len;
1209 if (usbtouch->buf_len + tmp >= usbtouch->type->rept_size)
1211 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, tmp);
1212 usbtouch_process_pkt(usbtouch, usbtouch->buffer, pkt_len);
1215 buf_len = len - tmp;
1221 /* loop over the received packet, process */
1223 while (pos < buf_len) {
1224 /* get packet len */
1225 pkt_len = usbtouch->type->get_pkt_len(buffer + pos,
1228 /* unknown packet: skip one byte */
1229 if (unlikely(!pkt_len)) {
1234 /* full packet: process */
1235 if (likely((pkt_len > 0) && (pkt_len <= buf_len - pos))) {
1236 usbtouch_process_pkt(usbtouch, buffer + pos, pkt_len);
1238 /* incomplete packet: save in buffer */
1239 memcpy(usbtouch->buffer, buffer + pos, buf_len - pos);
1240 usbtouch->buf_len = buf_len - pos;
1247 usbtouch->buf_len = 0;
1253 static void usbtouch_irq(struct urb *urb)
1255 struct usbtouch_usb *usbtouch = urb->context;
1258 switch (urb->status) {
1263 /* this urb is timing out */
1264 dbg("%s - urb timed out - was the device unplugged?",
1271 /* this urb is terminated, clean up */
1272 dbg("%s - urb shutting down with status: %d",
1273 __func__, urb->status);
1276 dbg("%s - nonzero urb status received: %d",
1277 __func__, urb->status);
1281 usbtouch->type->process_pkt(usbtouch, usbtouch->data, urb->actual_length);
1284 usb_mark_last_busy(interface_to_usbdev(usbtouch->interface));
1285 retval = usb_submit_urb(urb, GFP_ATOMIC);
1287 err("%s - usb_submit_urb failed with result: %d",
1291 static int usbtouch_open(struct input_dev *input)
1293 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1296 usbtouch->irq->dev = interface_to_usbdev(usbtouch->interface);
1298 r = usb_autopm_get_interface(usbtouch->interface) ? -EIO : 0;
1302 if (!usbtouch->type->irq_always) {
1303 if (usb_submit_urb(usbtouch->irq, GFP_KERNEL)) {
1309 usbtouch->interface->needs_remote_wakeup = 1;
1311 usb_autopm_put_interface(usbtouch->interface);
1316 static void usbtouch_close(struct input_dev *input)
1318 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1321 if (!usbtouch->type->irq_always)
1322 usb_kill_urb(usbtouch->irq);
1323 r = usb_autopm_get_interface(usbtouch->interface);
1324 usbtouch->interface->needs_remote_wakeup = 0;
1326 usb_autopm_put_interface(usbtouch->interface);
1329 static int usbtouch_suspend
1330 (struct usb_interface *intf, pm_message_t message)
1332 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1334 usb_kill_urb(usbtouch->irq);
1339 static int usbtouch_resume(struct usb_interface *intf)
1341 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1342 struct input_dev *input = usbtouch->input;
1345 mutex_lock(&input->mutex);
1346 if (input->users || usbtouch->type->irq_always)
1347 result = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1348 mutex_unlock(&input->mutex);
1353 static int usbtouch_reset_resume(struct usb_interface *intf)
1355 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1356 struct input_dev *input = usbtouch->input;
1359 /* reinit the device */
1360 if (usbtouch->type->init) {
1361 err = usbtouch->type->init(usbtouch);
1363 dbg("%s - type->init() failed, err: %d",
1369 /* restart IO if needed */
1370 mutex_lock(&input->mutex);
1372 err = usb_submit_urb(usbtouch->irq, GFP_NOIO);
1373 mutex_unlock(&input->mutex);
1378 static void usbtouch_free_buffers(struct usb_device *udev,
1379 struct usbtouch_usb *usbtouch)
1381 usb_free_coherent(udev, usbtouch->type->rept_size,
1382 usbtouch->data, usbtouch->data_dma);
1383 kfree(usbtouch->buffer);
1386 static struct usb_endpoint_descriptor *
1387 usbtouch_get_input_endpoint(struct usb_host_interface *interface)
1391 for (i = 0; i < interface->desc.bNumEndpoints; i++)
1392 if (usb_endpoint_dir_in(&interface->endpoint[i].desc))
1393 return &interface->endpoint[i].desc;
1398 static int usbtouch_probe(struct usb_interface *intf,
1399 const struct usb_device_id *id)
1401 struct usbtouch_usb *usbtouch;
1402 struct input_dev *input_dev;
1403 struct usb_endpoint_descriptor *endpoint;
1404 struct usb_device *udev = interface_to_usbdev(intf);
1405 struct usbtouch_device_info *type;
1408 /* some devices are ignored */
1409 if (id->driver_info == DEVTYPE_IGNORE)
1412 endpoint = usbtouch_get_input_endpoint(intf->cur_altsetting);
1416 usbtouch = kzalloc(sizeof(struct usbtouch_usb), GFP_KERNEL);
1417 input_dev = input_allocate_device();
1418 if (!usbtouch || !input_dev)
1421 type = &usbtouch_dev_info[id->driver_info];
1422 usbtouch->type = type;
1423 if (!type->process_pkt)
1424 type->process_pkt = usbtouch_process_pkt;
1426 usbtouch->data = usb_alloc_coherent(udev, type->rept_size,
1427 GFP_KERNEL, &usbtouch->data_dma);
1428 if (!usbtouch->data)
1431 if (type->get_pkt_len) {
1432 usbtouch->buffer = kmalloc(type->rept_size, GFP_KERNEL);
1433 if (!usbtouch->buffer)
1434 goto out_free_buffers;
1437 usbtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
1438 if (!usbtouch->irq) {
1439 dbg("%s - usb_alloc_urb failed: usbtouch->irq", __func__);
1440 goto out_free_buffers;
1443 usbtouch->interface = intf;
1444 usbtouch->input = input_dev;
1446 if (udev->manufacturer)
1447 strlcpy(usbtouch->name, udev->manufacturer, sizeof(usbtouch->name));
1449 if (udev->product) {
1450 if (udev->manufacturer)
1451 strlcat(usbtouch->name, " ", sizeof(usbtouch->name));
1452 strlcat(usbtouch->name, udev->product, sizeof(usbtouch->name));
1455 if (!strlen(usbtouch->name))
1456 snprintf(usbtouch->name, sizeof(usbtouch->name),
1457 "USB Touchscreen %04x:%04x",
1458 le16_to_cpu(udev->descriptor.idVendor),
1459 le16_to_cpu(udev->descriptor.idProduct));
1461 usb_make_path(udev, usbtouch->phys, sizeof(usbtouch->phys));
1462 strlcat(usbtouch->phys, "/input0", sizeof(usbtouch->phys));
1464 input_dev->name = usbtouch->name;
1465 input_dev->phys = usbtouch->phys;
1466 usb_to_input_id(udev, &input_dev->id);
1467 input_dev->dev.parent = &intf->dev;
1469 input_set_drvdata(input_dev, usbtouch);
1471 input_dev->open = usbtouch_open;
1472 input_dev->close = usbtouch_close;
1474 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1475 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1476 input_set_abs_params(input_dev, ABS_X, type->min_xc, type->max_xc, 0, 0);
1477 input_set_abs_params(input_dev, ABS_Y, type->min_yc, type->max_yc, 0, 0);
1478 if (type->max_press)
1479 input_set_abs_params(input_dev, ABS_PRESSURE, type->min_press,
1480 type->max_press, 0, 0);
1482 if (usb_endpoint_type(endpoint) == USB_ENDPOINT_XFER_INT)
1483 usb_fill_int_urb(usbtouch->irq, udev,
1484 usb_rcvintpipe(udev, endpoint->bEndpointAddress),
1485 usbtouch->data, type->rept_size,
1486 usbtouch_irq, usbtouch, endpoint->bInterval);
1488 usb_fill_bulk_urb(usbtouch->irq, udev,
1489 usb_rcvbulkpipe(udev, endpoint->bEndpointAddress),
1490 usbtouch->data, type->rept_size,
1491 usbtouch_irq, usbtouch);
1493 usbtouch->irq->dev = udev;
1494 usbtouch->irq->transfer_dma = usbtouch->data_dma;
1495 usbtouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1497 /* device specific allocations */
1499 err = type->alloc(usbtouch);
1501 dbg("%s - type->alloc() failed, err: %d", __func__, err);
1506 /* device specific initialisation*/
1508 err = type->init(usbtouch);
1510 dbg("%s - type->init() failed, err: %d", __func__, err);
1515 err = input_register_device(usbtouch->input);
1517 dbg("%s - input_register_device failed, err: %d", __func__, err);
1521 usb_set_intfdata(intf, usbtouch);
1523 if (usbtouch->type->irq_always) {
1524 /* this can't fail */
1525 usb_autopm_get_interface(intf);
1526 err = usb_submit_urb(usbtouch->irq, GFP_KERNEL);
1528 usb_autopm_put_interface(intf);
1529 err("%s - usb_submit_urb failed with result: %d",
1531 goto out_unregister_input;
1537 out_unregister_input:
1538 input_unregister_device(input_dev);
1542 type->exit(usbtouch);
1544 usb_free_urb(usbtouch->irq);
1546 usbtouch_free_buffers(udev, usbtouch);
1548 input_free_device(input_dev);
1553 static void usbtouch_disconnect(struct usb_interface *intf)
1555 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1557 dbg("%s - called", __func__);
1562 dbg("%s - usbtouch is initialized, cleaning up", __func__);
1563 usb_set_intfdata(intf, NULL);
1564 /* this will stop IO via close */
1565 input_unregister_device(usbtouch->input);
1566 usb_free_urb(usbtouch->irq);
1567 if (usbtouch->type->exit)
1568 usbtouch->type->exit(usbtouch);
1569 usbtouch_free_buffers(interface_to_usbdev(intf), usbtouch);
1573 MODULE_DEVICE_TABLE(usb, usbtouch_devices);
1575 static struct usb_driver usbtouch_driver = {
1576 .name = "usbtouchscreen",
1577 .probe = usbtouch_probe,
1578 .disconnect = usbtouch_disconnect,
1579 .suspend = usbtouch_suspend,
1580 .resume = usbtouch_resume,
1581 .reset_resume = usbtouch_reset_resume,
1582 .id_table = usbtouch_devices,
1583 .supports_autosuspend = 1,
1586 static int __init usbtouch_init(void)
1588 return usb_register(&usbtouch_driver);
1591 static void __exit usbtouch_cleanup(void)
1593 usb_deregister(&usbtouch_driver);
1596 module_init(usbtouch_init);
1597 module_exit(usbtouch_cleanup);
1599 MODULE_AUTHOR(DRIVER_AUTHOR);
1600 MODULE_DESCRIPTION(DRIVER_DESC);
1601 MODULE_LICENSE("GPL");
1603 MODULE_ALIAS("touchkitusb");
1604 MODULE_ALIAS("itmtouch");
1605 MODULE_ALIAS("mtouchusb");