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 (*init) (struct usbtouch_usb *usbtouch);
99 void (*exit) (struct usbtouch_usb *usbtouch);
102 /* a usbtouch device */
103 struct usbtouch_usb {
106 unsigned char *buffer;
109 struct usb_interface *interface;
110 struct input_dev *input;
111 struct usbtouch_device_info *type;
133 DEVTYPE_GENERAL_TOUCH,
142 #define USB_DEVICE_HID_CLASS(vend, prod) \
143 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS \
144 | USB_DEVICE_ID_MATCH_INT_PROTOCOL \
145 | USB_DEVICE_ID_MATCH_DEVICE, \
146 .idVendor = (vend), \
147 .idProduct = (prod), \
148 .bInterfaceClass = USB_INTERFACE_CLASS_HID, \
149 .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE
151 static const struct usb_device_id usbtouch_devices[] = {
152 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
153 /* ignore the HID capable devices, handled by usbhid */
154 {USB_DEVICE_HID_CLASS(0x0eef, 0x0001), .driver_info = DEVTYPE_IGNORE},
155 {USB_DEVICE_HID_CLASS(0x0eef, 0x0002), .driver_info = DEVTYPE_IGNORE},
157 /* normal device IDs */
158 {USB_DEVICE(0x3823, 0x0001), .driver_info = DEVTYPE_EGALAX},
159 {USB_DEVICE(0x3823, 0x0002), .driver_info = DEVTYPE_EGALAX},
160 {USB_DEVICE(0x0123, 0x0001), .driver_info = DEVTYPE_EGALAX},
161 {USB_DEVICE(0x0eef, 0x0001), .driver_info = DEVTYPE_EGALAX},
162 {USB_DEVICE(0x0eef, 0x0002), .driver_info = DEVTYPE_EGALAX},
163 {USB_DEVICE(0x1234, 0x0001), .driver_info = DEVTYPE_EGALAX},
164 {USB_DEVICE(0x1234, 0x0002), .driver_info = DEVTYPE_EGALAX},
167 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
168 {USB_DEVICE(0x134c, 0x0001), .driver_info = DEVTYPE_PANJIT},
169 {USB_DEVICE(0x134c, 0x0002), .driver_info = DEVTYPE_PANJIT},
170 {USB_DEVICE(0x134c, 0x0003), .driver_info = DEVTYPE_PANJIT},
171 {USB_DEVICE(0x134c, 0x0004), .driver_info = DEVTYPE_PANJIT},
174 #ifdef CONFIG_TOUCHSCREEN_USB_3M
175 {USB_DEVICE(0x0596, 0x0001), .driver_info = DEVTYPE_3M},
178 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
179 {USB_DEVICE(0x0403, 0xf9e9), .driver_info = DEVTYPE_ITM},
182 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
183 {USB_DEVICE(0x1234, 0x5678), .driver_info = DEVTYPE_ETURBO},
186 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
187 {USB_DEVICE(0x0637, 0x0001), .driver_info = DEVTYPE_GUNZE},
190 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
191 {USB_DEVICE(0x0afa, 0x03e8), .driver_info = DEVTYPE_DMC_TSC10},
194 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
195 {USB_DEVICE(0x595a, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
196 {USB_DEVICE(0x6615, 0x0001), .driver_info = DEVTYPE_IRTOUCH},
199 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
200 {USB_DEVICE(0x1391, 0x1000), .driver_info = DEVTYPE_IDEALTEK},
203 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
204 {USB_DEVICE(0x0dfc, 0x0001), .driver_info = DEVTYPE_GENERAL_TOUCH},
207 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
208 {USB_DEVICE(0x08f2, 0x007f), .driver_info = DEVTYPE_GOTOP},
209 {USB_DEVICE(0x08f2, 0x00ce), .driver_info = DEVTYPE_GOTOP},
210 {USB_DEVICE(0x08f2, 0x00f4), .driver_info = DEVTYPE_GOTOP},
213 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
214 {USB_DEVICE(0x0f92, 0x0001), .driver_info = DEVTYPE_JASTEC},
217 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
218 {USB_DEVICE(0x1ac7, 0x0001), .driver_info = DEVTYPE_E2I},
221 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
222 {USB_DEVICE(0x14c8, 0x0003), .driver_info = DEVTYPE_ZYTRONIC},
225 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC5UH
226 {USB_DEVICE(0x0664, 0x0309), .driver_info = DEVTYPE_TC5UH},
229 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
230 /* data interface only */
231 {USB_DEVICE_AND_INTERFACE_INFO(0x10f0, 0x2002, 0x0a, 0x00, 0x00),
232 .driver_info = DEVTYPE_NEXIO},
233 {USB_DEVICE_AND_INTERFACE_INFO(0x1870, 0x0001, 0x0a, 0x00, 0x00),
234 .driver_info = DEVTYPE_NEXIO},
241 /*****************************************************************************
245 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
246 static int e2i_init(struct usbtouch_usb *usbtouch)
249 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
251 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
252 0x01, 0x02, 0x0000, 0x0081,
253 NULL, 0, USB_CTRL_SET_TIMEOUT);
255 dbg("%s - usb_control_msg - E2I_RESET - bytes|err: %d",
260 static int e2i_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
262 int tmp = (pkt[0] << 8) | pkt[1];
263 dev->x = (pkt[2] << 8) | pkt[3];
264 dev->y = (pkt[4] << 8) | pkt[5];
267 dev->touch = (tmp > 0);
268 dev->press = (tmp > 0 ? tmp : 0);
275 /*****************************************************************************
279 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
285 #define EGALAX_PKT_TYPE_MASK 0xFE
286 #define EGALAX_PKT_TYPE_REPT 0x80
287 #define EGALAX_PKT_TYPE_DIAG 0x0A
289 static int egalax_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
291 if ((pkt[0] & EGALAX_PKT_TYPE_MASK) != EGALAX_PKT_TYPE_REPT)
294 dev->x = ((pkt[3] & 0x0F) << 7) | (pkt[4] & 0x7F);
295 dev->y = ((pkt[1] & 0x0F) << 7) | (pkt[2] & 0x7F);
296 dev->touch = pkt[0] & 0x01;
301 static int egalax_get_pkt_len(unsigned char *buf, int len)
303 switch (buf[0] & EGALAX_PKT_TYPE_MASK) {
304 case EGALAX_PKT_TYPE_REPT:
307 case EGALAX_PKT_TYPE_DIAG:
319 /*****************************************************************************
322 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
323 static int panjit_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
325 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
326 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
327 dev->touch = pkt[0] & 0x01;
334 /*****************************************************************************
337 #ifdef CONFIG_TOUCHSCREEN_USB_3M
339 #define MTOUCHUSB_ASYNC_REPORT 1
340 #define MTOUCHUSB_RESET 7
341 #define MTOUCHUSB_REQ_CTRLLR_ID 10
343 static int mtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
346 dev->x = (pkt[4] << 8) | pkt[3];
347 dev->y = 0xffff - ((pkt[6] << 8) | pkt[5]);
349 dev->x = (pkt[8] << 8) | pkt[7];
350 dev->y = (pkt[10] << 8) | pkt[9];
352 dev->touch = (pkt[2] & 0x40) ? 1 : 0;
357 static int mtouch_init(struct usbtouch_usb *usbtouch)
360 struct usb_device *udev = interface_to_usbdev(usbtouch->interface);
362 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
364 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
365 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
366 dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
372 for (i = 0; i < 3; i++) {
373 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
374 MTOUCHUSB_ASYNC_REPORT,
375 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
376 1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
377 dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
385 /* Default min/max xy are the raw values, override if using hw-calib */
387 input_set_abs_params(usbtouch->input, ABS_X, 0, 0xffff, 0, 0);
388 input_set_abs_params(usbtouch->input, ABS_Y, 0, 0xffff, 0, 0);
396 /*****************************************************************************
399 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
400 static int itm_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
404 * ITM devices report invalid x/y data if not touched.
405 * if the screen was touched before but is not touched any more
406 * report touch as 0 with the last valid x/y data once. then stop
407 * reporting data until touched again.
409 dev->press = ((pkt[2] & 0x01) << 7) | (pkt[5] & 0x7F);
411 touch = ~pkt[7] & 0x20;
421 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[3] & 0x7F);
422 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[4] & 0x7F);
430 /*****************************************************************************
433 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
437 static int eturbo_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
441 /* packets should start with sync */
442 if (!(pkt[0] & 0x80))
445 shift = (6 - (pkt[0] & 0x03));
446 dev->x = ((pkt[3] << 7) | pkt[4]) >> shift;
447 dev->y = ((pkt[1] << 7) | pkt[2]) >> shift;
448 dev->touch = (pkt[0] & 0x10) ? 1 : 0;
453 static int eturbo_get_pkt_len(unsigned char *buf, int len)
464 /*****************************************************************************
467 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
468 static int gunze_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
470 if (!(pkt[0] & 0x80) || ((pkt[1] | pkt[2] | pkt[3]) & 0x80))
473 dev->x = ((pkt[0] & 0x1F) << 7) | (pkt[2] & 0x7F);
474 dev->y = ((pkt[1] & 0x1F) << 7) | (pkt[3] & 0x7F);
475 dev->touch = pkt[0] & 0x20;
481 /*****************************************************************************
484 * Documentation about the controller and it's protocol can be found at
485 * http://www.dmccoltd.com/files/controler/tsc10usb_pi_e.pdf
486 * http://www.dmccoltd.com/files/controler/tsc25_usb_e.pdf
488 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
490 /* supported data rates. currently using 130 */
491 #define TSC10_RATE_POINT 0x50
492 #define TSC10_RATE_30 0x40
493 #define TSC10_RATE_50 0x41
494 #define TSC10_RATE_80 0x42
495 #define TSC10_RATE_100 0x43
496 #define TSC10_RATE_130 0x44
497 #define TSC10_RATE_150 0x45
500 #define TSC10_CMD_RESET 0x55
501 #define TSC10_CMD_RATE 0x05
502 #define TSC10_CMD_DATA1 0x01
504 static int dmc_tsc10_init(struct usbtouch_usb *usbtouch)
506 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
510 buf = kmalloc(2, GFP_KERNEL);
514 buf[0] = buf[1] = 0xFF;
515 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
517 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
518 0, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
521 if (buf[0] != 0x06) {
526 /* set coordinate output rate */
527 buf[0] = buf[1] = 0xFF;
528 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
530 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
531 TSC10_RATE_150, 0, buf, 2, USB_CTRL_SET_TIMEOUT);
534 if ((buf[0] != 0x06) && (buf[0] != 0x15 || buf[1] != 0x01)) {
539 /* start sending data */
540 ret = usb_control_msg(dev, usb_rcvctrlpipe (dev, 0),
542 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
543 0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
551 static int dmc_tsc10_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
553 dev->x = ((pkt[2] & 0x03) << 8) | pkt[1];
554 dev->y = ((pkt[4] & 0x03) << 8) | pkt[3];
555 dev->touch = pkt[0] & 0x01;
562 /*****************************************************************************
565 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
566 static int irtouch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
568 dev->x = (pkt[3] << 8) | pkt[2];
569 dev->y = (pkt[5] << 8) | pkt[4];
570 dev->touch = (pkt[1] & 0x03) ? 1 : 0;
576 /*****************************************************************************
579 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC5UH
580 static int tc5uh_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
582 dev->x = ((pkt[2] & 0x0F) << 8) | pkt[1];
583 dev->y = ((pkt[4] & 0x0F) << 8) | pkt[3];
584 dev->touch = pkt[0] & 0x01;
590 /*****************************************************************************
591 * IdealTEK URTC1000 Part
593 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
597 static int idealtek_get_pkt_len(unsigned char *buf, int len)
606 static int idealtek_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
608 switch (pkt[0] & 0x98) {
610 /* touch data in IdealTEK mode */
611 dev->x = (pkt[1] << 5) | (pkt[2] >> 2);
612 dev->y = (pkt[3] << 5) | (pkt[4] >> 2);
613 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
617 /* touch data in MT emulation mode */
618 dev->x = (pkt[2] << 5) | (pkt[1] >> 2);
619 dev->y = (pkt[4] << 5) | (pkt[3] >> 2);
620 dev->touch = (pkt[0] & 0x40) ? 1 : 0;
629 /*****************************************************************************
632 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
633 static int general_touch_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
635 dev->x = (pkt[2] << 8) | pkt[1];
636 dev->y = (pkt[4] << 8) | pkt[3];
637 dev->press = pkt[5] & 0xff;
638 dev->touch = pkt[0] & 0x01;
644 /*****************************************************************************
647 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
648 static int gotop_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
650 dev->x = ((pkt[1] & 0x38) << 4) | pkt[2];
651 dev->y = ((pkt[1] & 0x07) << 7) | pkt[3];
652 dev->touch = pkt[0] & 0x01;
658 /*****************************************************************************
661 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
662 static int jastec_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
664 dev->x = ((pkt[0] & 0x3f) << 6) | (pkt[2] & 0x3f);
665 dev->y = ((pkt[1] & 0x3f) << 6) | (pkt[3] & 0x3f);
666 dev->touch = (pkt[0] & 0x40) >> 6;
672 /*****************************************************************************
675 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
676 static int zytronic_read_data(struct usbtouch_usb *dev, unsigned char *pkt)
679 case 0x3A: /* command response */
680 dbg("%s: Command response %d", __func__, pkt[1]);
683 case 0xC0: /* down */
684 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
685 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
687 dbg("%s: down %d,%d", __func__, dev->x, dev->y);
691 dev->x = (pkt[1] & 0x7f) | ((pkt[2] & 0x07) << 7);
692 dev->y = (pkt[3] & 0x7f) | ((pkt[4] & 0x07) << 7);
694 dbg("%s: up %d,%d", __func__, dev->x, dev->y);
698 dbg("%s: Unknown return %d", __func__, pkt[0]);
706 /*****************************************************************************
709 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
711 #define NEXIO_TIMEOUT 5000
712 #define NEXIO_BUFSIZE 1024
713 #define NEXIO_THRESHOLD 50
717 unsigned char *ack_buf;
720 struct nexio_touch_packet {
721 u8 flags; /* 0xe1 = touch, 0xe1 = release */
722 __be16 data_len; /* total bytes of touch data */
723 __be16 x_len; /* bytes for X axis */
724 __be16 y_len; /* bytes for Y axis */
726 } __attribute__ ((packed));
728 static unsigned char nexio_ack_pkt[2] = { 0xaa, 0x02 };
729 static unsigned char nexio_init_pkt[4] = { 0x82, 0x04, 0x0a, 0x0f };
731 static void nexio_ack_complete(struct urb *urb)
735 static int nexio_init(struct usbtouch_usb *usbtouch)
737 struct usb_device *dev = interface_to_usbdev(usbtouch->interface);
738 struct usb_host_interface *interface = usbtouch->interface->cur_altsetting;
739 struct nexio_priv *priv;
743 char *firmware_ver = NULL, *device_name = NULL;
744 int input_ep = 0, output_ep = 0;
746 /* find first input and output endpoint */
747 for (i = 0; i < interface->desc.bNumEndpoints; i++) {
749 usb_endpoint_dir_in(&interface->endpoint[i].desc))
750 input_ep = interface->endpoint[i].desc.bEndpointAddress;
752 usb_endpoint_dir_out(&interface->endpoint[i].desc))
753 output_ep = interface->endpoint[i].desc.bEndpointAddress;
755 if (!input_ep || !output_ep)
758 buf = kmalloc(NEXIO_BUFSIZE, GFP_KERNEL);
762 /* two empty reads */
763 for (i = 0; i < 2; i++) {
764 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
765 buf, NEXIO_BUFSIZE, &actual_len,
771 /* send init command */
772 memcpy(buf, nexio_init_pkt, sizeof(nexio_init_pkt));
773 ret = usb_bulk_msg(dev, usb_sndbulkpipe(dev, output_ep),
774 buf, sizeof(nexio_init_pkt), &actual_len,
780 for (i = 0; i < 3; i++) {
781 memset(buf, 0, NEXIO_BUFSIZE);
782 ret = usb_bulk_msg(dev, usb_rcvbulkpipe(dev, input_ep),
783 buf, NEXIO_BUFSIZE, &actual_len,
785 if (ret < 0 || actual_len < 1 || buf[1] != actual_len)
788 case 0x83: /* firmware version */
790 firmware_ver = kstrdup(&buf[2], GFP_KERNEL);
792 case 0x84: /* device name */
794 device_name = kstrdup(&buf[2], GFP_KERNEL);
799 printk(KERN_INFO "Nexio device: %s, firmware version: %s\n",
800 device_name, firmware_ver);
805 /* prepare ACK URB */
808 usbtouch->priv = kmalloc(sizeof(struct nexio_priv), GFP_KERNEL);
812 priv = usbtouch->priv;
814 priv->ack_buf = kmemdup(nexio_ack_pkt, sizeof(nexio_ack_pkt),
819 priv->ack = usb_alloc_urb(0, GFP_KERNEL);
821 dbg("%s - usb_alloc_urb failed: usbtouch->ack", __func__);
825 usb_fill_bulk_urb(priv->ack, dev, usb_sndbulkpipe(dev, output_ep),
826 priv->ack_buf, sizeof(nexio_ack_pkt),
827 nexio_ack_complete, usbtouch);
832 kfree(priv->ack_buf);
840 static void nexio_exit(struct usbtouch_usb *usbtouch)
842 struct nexio_priv *priv = usbtouch->priv;
844 usb_kill_urb(priv->ack);
845 usb_free_urb(priv->ack);
846 kfree(priv->ack_buf);
850 static int nexio_read_data(struct usbtouch_usb *usbtouch, unsigned char *pkt)
852 int x, y, begin_x, begin_y, end_x, end_y, w, h, ret;
853 struct nexio_touch_packet *packet = (void *) pkt;
854 struct nexio_priv *priv = usbtouch->priv;
856 /* got touch data? */
857 if ((pkt[0] & 0xe0) != 0xe0)
861 ret = usb_submit_urb(priv->ack, GFP_ATOMIC);
863 if (!usbtouch->type->max_xc) {
864 usbtouch->type->max_xc = 2 * be16_to_cpu(packet->x_len);
865 input_set_abs_params(usbtouch->input, ABS_X, 0,
866 2 * be16_to_cpu(packet->x_len), 0, 0);
867 usbtouch->type->max_yc = 2 * be16_to_cpu(packet->y_len);
868 input_set_abs_params(usbtouch->input, ABS_Y, 0,
869 2 * be16_to_cpu(packet->y_len), 0, 0);
872 * The device reports state of IR sensors on X and Y axes.
873 * Each byte represents "darkness" percentage (0-100) of one element.
874 * 17" touchscreen reports only 64 x 52 bytes so the resolution is low.
875 * This also means that there's a limited multi-touch capability but
876 * it's disabled (and untested) here as there's no X driver for that.
878 begin_x = end_x = begin_y = end_y = -1;
879 for (x = 0; x < be16_to_cpu(packet->x_len); x++) {
880 if (begin_x == -1 && packet->data[x] > NEXIO_THRESHOLD) {
884 if (end_x == -1 && begin_x != -1 && packet->data[x] < NEXIO_THRESHOLD) {
886 for (y = be16_to_cpu(packet->x_len);
887 y < be16_to_cpu(packet->data_len); y++) {
888 if (begin_y == -1 && packet->data[y] > NEXIO_THRESHOLD) {
889 begin_y = y - be16_to_cpu(packet->x_len);
893 begin_y != -1 && packet->data[y] < NEXIO_THRESHOLD) {
894 end_y = y - 1 - be16_to_cpu(packet->x_len);
899 input_report_abs(usbtouch->input,
900 ABS_MT_TOUCH_MAJOR, max(w,h));
901 input_report_abs(usbtouch->input,
902 ABS_MT_TOUCH_MINOR, min(x,h));
903 input_report_abs(usbtouch->input,
904 ABS_MT_POSITION_X, 2*begin_x+w);
905 input_report_abs(usbtouch->input,
906 ABS_MT_POSITION_Y, 2*begin_y+h);
907 input_report_abs(usbtouch->input,
908 ABS_MT_ORIENTATION, w > h);
909 input_mt_sync(usbtouch->input);
912 usbtouch->x = 2 * begin_x + w;
913 usbtouch->y = 2 * begin_y + h;
914 usbtouch->touch = packet->flags & 0x01;
915 begin_y = end_y = -1;
919 begin_x = end_x = -1;
928 /*****************************************************************************
929 * the different device descriptors
932 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
933 unsigned char *pkt, int len);
936 static struct usbtouch_device_info usbtouch_dev_info[] = {
937 #ifdef CONFIG_TOUCHSCREEN_USB_EGALAX
944 .process_pkt = usbtouch_process_multi,
945 .get_pkt_len = egalax_get_pkt_len,
946 .read_data = egalax_read_data,
950 #ifdef CONFIG_TOUCHSCREEN_USB_PANJIT
957 .read_data = panjit_read_data,
961 #ifdef CONFIG_TOUCHSCREEN_USB_3M
968 .read_data = mtouch_read_data,
973 #ifdef CONFIG_TOUCHSCREEN_USB_ITM
981 .read_data = itm_read_data,
985 #ifdef CONFIG_TOUCHSCREEN_USB_ETURBO
992 .process_pkt = usbtouch_process_multi,
993 .get_pkt_len = eturbo_get_pkt_len,
994 .read_data = eturbo_read_data,
998 #ifdef CONFIG_TOUCHSCREEN_USB_GUNZE
1005 .read_data = gunze_read_data,
1009 #ifdef CONFIG_TOUCHSCREEN_USB_DMC_TSC10
1010 [DEVTYPE_DMC_TSC10] = {
1016 .init = dmc_tsc10_init,
1017 .read_data = dmc_tsc10_read_data,
1021 #ifdef CONFIG_TOUCHSCREEN_USB_IRTOUCH
1022 [DEVTYPE_IRTOUCH] = {
1028 .read_data = irtouch_read_data,
1032 #ifdef CONFIG_TOUCHSCREEN_USB_IDEALTEK
1033 [DEVTYPE_IDEALTEK] = {
1039 .process_pkt = usbtouch_process_multi,
1040 .get_pkt_len = idealtek_get_pkt_len,
1041 .read_data = idealtek_read_data,
1045 #ifdef CONFIG_TOUCHSCREEN_USB_GENERAL_TOUCH
1046 [DEVTYPE_GENERAL_TOUCH] = {
1052 .read_data = general_touch_read_data,
1056 #ifdef CONFIG_TOUCHSCREEN_USB_GOTOP
1063 .read_data = gotop_read_data,
1067 #ifdef CONFIG_TOUCHSCREEN_USB_JASTEC
1068 [DEVTYPE_JASTEC] = {
1074 .read_data = jastec_read_data,
1078 #ifdef CONFIG_TOUCHSCREEN_USB_E2I
1086 .read_data = e2i_read_data,
1090 #ifdef CONFIG_TOUCHSCREEN_USB_ZYTRONIC
1091 [DEVTYPE_ZYTRONIC] = {
1097 .read_data = zytronic_read_data,
1102 #ifdef CONFIG_TOUCHSCREEN_USB_ETT_TC5UH
1109 .read_data = tc5uh_read_data,
1113 #ifdef CONFIG_TOUCHSCREEN_USB_NEXIO
1117 .read_data = nexio_read_data,
1125 /*****************************************************************************
1128 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
1129 unsigned char *pkt, int len)
1131 struct usbtouch_device_info *type = usbtouch->type;
1133 if (!type->read_data(usbtouch, pkt))
1136 input_report_key(usbtouch->input, BTN_TOUCH, usbtouch->touch);
1139 input_report_abs(usbtouch->input, ABS_X, usbtouch->y);
1140 input_report_abs(usbtouch->input, ABS_Y, usbtouch->x);
1142 input_report_abs(usbtouch->input, ABS_X, usbtouch->x);
1143 input_report_abs(usbtouch->input, ABS_Y, usbtouch->y);
1145 if (type->max_press)
1146 input_report_abs(usbtouch->input, ABS_PRESSURE, usbtouch->press);
1147 input_sync(usbtouch->input);
1152 static void usbtouch_process_multi(struct usbtouch_usb *usbtouch,
1153 unsigned char *pkt, int len)
1155 unsigned char *buffer;
1156 int pkt_len, pos, buf_len, tmp;
1158 /* process buffer */
1159 if (unlikely(usbtouch->buf_len)) {
1160 /* try to get size */
1161 pkt_len = usbtouch->type->get_pkt_len(
1162 usbtouch->buffer, usbtouch->buf_len);
1165 if (unlikely(!pkt_len))
1168 /* need to append -pkt_len bytes before able to get size */
1169 if (unlikely(pkt_len < 0)) {
1170 int append = -pkt_len;
1171 if (unlikely(append > len))
1173 if (usbtouch->buf_len + append >= usbtouch->type->rept_size)
1175 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, append);
1176 usbtouch->buf_len += append;
1178 pkt_len = usbtouch->type->get_pkt_len(
1179 usbtouch->buffer, usbtouch->buf_len);
1185 tmp = pkt_len - usbtouch->buf_len;
1186 if (usbtouch->buf_len + tmp >= usbtouch->type->rept_size)
1188 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, tmp);
1189 usbtouch_process_pkt(usbtouch, usbtouch->buffer, pkt_len);
1192 buf_len = len - tmp;
1198 /* loop over the received packet, process */
1200 while (pos < buf_len) {
1201 /* get packet len */
1202 pkt_len = usbtouch->type->get_pkt_len(buffer + pos,
1205 /* unknown packet: skip one byte */
1206 if (unlikely(!pkt_len)) {
1211 /* full packet: process */
1212 if (likely((pkt_len > 0) && (pkt_len <= buf_len - pos))) {
1213 usbtouch_process_pkt(usbtouch, buffer + pos, pkt_len);
1215 /* incomplete packet: save in buffer */
1216 memcpy(usbtouch->buffer, buffer + pos, buf_len - pos);
1217 usbtouch->buf_len = buf_len - pos;
1224 usbtouch->buf_len = 0;
1230 static void usbtouch_irq(struct urb *urb)
1232 struct usbtouch_usb *usbtouch = urb->context;
1235 switch (urb->status) {
1240 /* this urb is timing out */
1241 dbg("%s - urb timed out - was the device unplugged?",
1248 /* this urb is terminated, clean up */
1249 dbg("%s - urb shutting down with status: %d",
1250 __func__, urb->status);
1253 dbg("%s - nonzero urb status received: %d",
1254 __func__, urb->status);
1258 usbtouch->type->process_pkt(usbtouch, usbtouch->data, urb->actual_length);
1261 retval = usb_submit_urb(urb, GFP_ATOMIC);
1263 err("%s - usb_submit_urb failed with result: %d",
1267 static int usbtouch_open(struct input_dev *input)
1269 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1271 usbtouch->irq->dev = interface_to_usbdev(usbtouch->interface);
1273 if (!usbtouch->type->irq_always) {
1274 if (usb_submit_urb(usbtouch->irq, GFP_KERNEL))
1281 static void usbtouch_close(struct input_dev *input)
1283 struct usbtouch_usb *usbtouch = input_get_drvdata(input);
1285 if (!usbtouch->type->irq_always)
1286 usb_kill_urb(usbtouch->irq);
1290 static void usbtouch_free_buffers(struct usb_device *udev,
1291 struct usbtouch_usb *usbtouch)
1293 usb_free_coherent(udev, usbtouch->type->rept_size,
1294 usbtouch->data, usbtouch->data_dma);
1295 kfree(usbtouch->buffer);
1298 static struct usb_endpoint_descriptor *
1299 usbtouch_get_input_endpoint(struct usb_host_interface *interface)
1303 for (i = 0; i < interface->desc.bNumEndpoints; i++)
1304 if (usb_endpoint_dir_in(&interface->endpoint[i].desc))
1305 return &interface->endpoint[i].desc;
1310 static int usbtouch_probe(struct usb_interface *intf,
1311 const struct usb_device_id *id)
1313 struct usbtouch_usb *usbtouch;
1314 struct input_dev *input_dev;
1315 struct usb_endpoint_descriptor *endpoint;
1316 struct usb_device *udev = interface_to_usbdev(intf);
1317 struct usbtouch_device_info *type;
1320 /* some devices are ignored */
1321 if (id->driver_info == DEVTYPE_IGNORE)
1324 endpoint = usbtouch_get_input_endpoint(intf->cur_altsetting);
1328 usbtouch = kzalloc(sizeof(struct usbtouch_usb), GFP_KERNEL);
1329 input_dev = input_allocate_device();
1330 if (!usbtouch || !input_dev)
1333 type = &usbtouch_dev_info[id->driver_info];
1334 usbtouch->type = type;
1335 if (!type->process_pkt)
1336 type->process_pkt = usbtouch_process_pkt;
1338 usbtouch->data = usb_alloc_coherent(udev, type->rept_size,
1339 GFP_KERNEL, &usbtouch->data_dma);
1340 if (!usbtouch->data)
1343 if (type->get_pkt_len) {
1344 usbtouch->buffer = kmalloc(type->rept_size, GFP_KERNEL);
1345 if (!usbtouch->buffer)
1346 goto out_free_buffers;
1349 usbtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
1350 if (!usbtouch->irq) {
1351 dbg("%s - usb_alloc_urb failed: usbtouch->irq", __func__);
1352 goto out_free_buffers;
1355 usbtouch->interface = intf;
1356 usbtouch->input = input_dev;
1358 if (udev->manufacturer)
1359 strlcpy(usbtouch->name, udev->manufacturer, sizeof(usbtouch->name));
1361 if (udev->product) {
1362 if (udev->manufacturer)
1363 strlcat(usbtouch->name, " ", sizeof(usbtouch->name));
1364 strlcat(usbtouch->name, udev->product, sizeof(usbtouch->name));
1367 if (!strlen(usbtouch->name))
1368 snprintf(usbtouch->name, sizeof(usbtouch->name),
1369 "USB Touchscreen %04x:%04x",
1370 le16_to_cpu(udev->descriptor.idVendor),
1371 le16_to_cpu(udev->descriptor.idProduct));
1373 usb_make_path(udev, usbtouch->phys, sizeof(usbtouch->phys));
1374 strlcat(usbtouch->phys, "/input0", sizeof(usbtouch->phys));
1376 input_dev->name = usbtouch->name;
1377 input_dev->phys = usbtouch->phys;
1378 usb_to_input_id(udev, &input_dev->id);
1379 input_dev->dev.parent = &intf->dev;
1381 input_set_drvdata(input_dev, usbtouch);
1383 input_dev->open = usbtouch_open;
1384 input_dev->close = usbtouch_close;
1386 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
1387 input_dev->keybit[BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH);
1388 input_set_abs_params(input_dev, ABS_X, type->min_xc, type->max_xc, 0, 0);
1389 input_set_abs_params(input_dev, ABS_Y, type->min_yc, type->max_yc, 0, 0);
1390 if (type->max_press)
1391 input_set_abs_params(input_dev, ABS_PRESSURE, type->min_press,
1392 type->max_press, 0, 0);
1394 if (usb_endpoint_type(endpoint) == USB_ENDPOINT_XFER_INT)
1395 usb_fill_int_urb(usbtouch->irq, udev,
1396 usb_rcvintpipe(udev, endpoint->bEndpointAddress),
1397 usbtouch->data, type->rept_size,
1398 usbtouch_irq, usbtouch, endpoint->bInterval);
1400 usb_fill_bulk_urb(usbtouch->irq, udev,
1401 usb_rcvbulkpipe(udev, endpoint->bEndpointAddress),
1402 usbtouch->data, type->rept_size,
1403 usbtouch_irq, usbtouch);
1405 usbtouch->irq->dev = udev;
1406 usbtouch->irq->transfer_dma = usbtouch->data_dma;
1407 usbtouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1409 /* device specific init */
1411 err = type->init(usbtouch);
1413 dbg("%s - type->init() failed, err: %d", __func__, err);
1418 err = input_register_device(usbtouch->input);
1420 dbg("%s - input_register_device failed, err: %d", __func__, err);
1424 usb_set_intfdata(intf, usbtouch);
1426 if (usbtouch->type->irq_always) {
1427 err = usb_submit_urb(usbtouch->irq, GFP_KERNEL);
1429 err("%s - usb_submit_urb failed with result: %d",
1431 goto out_unregister_input;
1437 out_unregister_input:
1438 input_unregister_device(input_dev);
1442 type->exit(usbtouch);
1444 usb_free_urb(usbtouch->irq);
1446 usbtouch_free_buffers(udev, usbtouch);
1448 input_free_device(input_dev);
1453 static void usbtouch_disconnect(struct usb_interface *intf)
1455 struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
1457 dbg("%s - called", __func__);
1462 dbg("%s - usbtouch is initialized, cleaning up", __func__);
1463 usb_set_intfdata(intf, NULL);
1464 /* this will stop IO via close */
1465 input_unregister_device(usbtouch->input);
1466 usb_free_urb(usbtouch->irq);
1467 if (usbtouch->type->exit)
1468 usbtouch->type->exit(usbtouch);
1469 usbtouch_free_buffers(interface_to_usbdev(intf), usbtouch);
1473 MODULE_DEVICE_TABLE(usb, usbtouch_devices);
1475 static struct usb_driver usbtouch_driver = {
1476 .name = "usbtouchscreen",
1477 .probe = usbtouch_probe,
1478 .disconnect = usbtouch_disconnect,
1479 .id_table = usbtouch_devices,
1482 static int __init usbtouch_init(void)
1484 return usb_register(&usbtouch_driver);
1487 static void __exit usbtouch_cleanup(void)
1489 usb_deregister(&usbtouch_driver);
1492 module_init(usbtouch_init);
1493 module_exit(usbtouch_cleanup);
1495 MODULE_AUTHOR(DRIVER_AUTHOR);
1496 MODULE_DESCRIPTION(DRIVER_DESC);
1497 MODULE_LICENSE("GPL");
1499 MODULE_ALIAS("touchkitusb");
1500 MODULE_ALIAS("itmtouch");
1501 MODULE_ALIAS("mtouchusb");