drivers/usb/input/usbtouchscreen.c

   1 /******************************************************************************
   2  * usbtouchscreen.c
   3  * Driver for USB Touchscreens, supporting those devices:
   4  *  - eGalax Touchkit
   5  *  - 3M/Microtouch
   6  *  - ITM
   7  *  - PanJit TouchSet
   8  *
   9  * Copyright (C) 2004-2006 by Daniel Ritz <daniel.ritz@gmx.ch>
  10  * Copyright (C) by Todd E. Johnson (mtouchusb.c)
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  *
  26  * Driver is based on touchkitusb.c
  27  * - ITM parts are from itmtouch.c
  28  * - 3M parts are from mtouchusb.c
  29  * - PanJit parts are from an unmerged driver by Lanslott Gish
  30  *
  31  *****************************************************************************/
  32
  33 //#define DEBUG
  34
  35 #include <linux/kernel.h>
  36 #include <linux/slab.h>
  37 #include <linux/input.h>
  38 #include <linux/module.h>
  39 #include <linux/init.h>
  40 #include <linux/usb.h>
  41 #include <linux/usb/input.h>
  42
  43
  44 #define DRIVER_VERSION          "v0.3"
  45 #define DRIVER_AUTHOR           "Daniel Ritz <daniel.ritz@gmx.ch>"
  46 #define DRIVER_DESC             "USB Touchscreen Driver"
  47
  48 static int swap_xy;
  49 module_param(swap_xy, bool, 0644);
  50 MODULE_PARM_DESC(swap_xy, "If set X and Y axes are swapped.");
  51
  52 /* device specifc data/functions */
  53 struct usbtouch_usb;
  54 struct usbtouch_device_info {
  55         int min_xc, max_xc;
  56         int min_yc, max_yc;
  57         int min_press, max_press;
  58         int rept_size;
  59         int flags;
  60
  61         void (*process_pkt) (struct usbtouch_usb *usbtouch, struct pt_regs *regs, unsigned char *pkt, int len);
  62         int  (*read_data)   (unsigned char *pkt, int *x, int *y, int *touch, int *press);
  63         int  (*init)        (struct usbtouch_usb *usbtouch);
  64 };
  65
  66 #define USBTOUCH_FLG_BUFFER     0x01
  67
  68
  69 /* a usbtouch device */
  70 struct usbtouch_usb {
  71         unsigned char *data;
  72         dma_addr_t data_dma;
  73         unsigned char *buffer;
  74         int buf_len;
  75         struct urb *irq;
  76         struct usb_device *udev;
  77         struct input_dev *input;
  78         struct usbtouch_device_info *type;
  79         char name[128];
  80         char phys[64];
  81 };
  82
  83 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
  84                                  struct pt_regs *regs, unsigned char *pkt, int len);
  85
  86 /* device types */
  87 enum {
  88         DEVTPYE_DUMMY = -1,
  89         DEVTYPE_EGALAX,
  90         DEVTYPE_PANJIT,
  91         DEVTYPE_3M,
  92         DEVTYPE_ITM,
  93 };
  94
  95 static struct usb_device_id usbtouch_devices[] = {
  96 #ifdef CONFIG_USB_TOUCHSCREEN_EGALAX
  97         {USB_DEVICE(0x3823, 0x0001), .driver_info = DEVTYPE_EGALAX},
  98         {USB_DEVICE(0x0123, 0x0001), .driver_info = DEVTYPE_EGALAX},
  99         {USB_DEVICE(0x0eef, 0x0001), .driver_info = DEVTYPE_EGALAX},
 100         {USB_DEVICE(0x0eef, 0x0002), .driver_info = DEVTYPE_EGALAX},
 101 #endif
 102
 103 #ifdef CONFIG_USB_TOUCHSCREEN_PANJIT
 104         {USB_DEVICE(0x134c, 0x0001), .driver_info = DEVTYPE_PANJIT},
 105         {USB_DEVICE(0x134c, 0x0002), .driver_info = DEVTYPE_PANJIT},
 106         {USB_DEVICE(0x134c, 0x0003), .driver_info = DEVTYPE_PANJIT},
 107         {USB_DEVICE(0x134c, 0x0004), .driver_info = DEVTYPE_PANJIT},
 108 #endif
 109
 110 #ifdef CONFIG_USB_TOUCHSCREEN_3M
 111         {USB_DEVICE(0x0596, 0x0001), .driver_info = DEVTYPE_3M},
 112 #endif
 113
 114 #ifdef CONFIG_USB_TOUCHSCREEN_ITM
 115         {USB_DEVICE(0x0403, 0xf9e9), .driver_info = DEVTYPE_ITM},
 116 #endif
 117
 118         {}
 119 };
 120
 121
 122 /*****************************************************************************
 123  * eGalax part
 124  */
 125
 126 #ifdef CONFIG_USB_TOUCHSCREEN_EGALAX
 127
 128 #define EGALAX_PKT_TYPE_MASK            0xFE
 129 #define EGALAX_PKT_TYPE_REPT            0x80
 130 #define EGALAX_PKT_TYPE_DIAG            0x0A
 131
 132 static int egalax_read_data(unsigned char *pkt, int *x, int *y, int *touch, int *press)
 133 {
 134         if ((pkt[0] & EGALAX_PKT_TYPE_MASK) != EGALAX_PKT_TYPE_REPT)
 135                 return 0;
 136
 137         *x = ((pkt[3] & 0x0F) << 7) | (pkt[4] & 0x7F);
 138         *y = ((pkt[1] & 0x0F) << 7) | (pkt[2] & 0x7F);
 139         *touch = pkt[0] & 0x01;
 140
 141         return 1;
 142
 143 }
 144
 145 static int egalax_get_pkt_len(unsigned char *buf)
 146 {
 147         switch (buf[0] & EGALAX_PKT_TYPE_MASK) {
 148         case EGALAX_PKT_TYPE_REPT:
 149                 return 5;
 150
 151         case EGALAX_PKT_TYPE_DIAG:
 152                 return buf[1] + 2;
 153         }
 154
 155         return 0;
 156 }
 157
 158 static void egalax_process(struct usbtouch_usb *usbtouch, struct pt_regs *regs,
 159                            unsigned char *pkt, int len)
 160 {
 161         unsigned char *buffer;
 162         int pkt_len, buf_len, pos;
 163
 164         /* if the buffer contains data, append */
 165         if (unlikely(usbtouch->buf_len)) {
 166                 int tmp;
 167
 168                 /* if only 1 byte in buffer, add another one to get length */
 169                 if (usbtouch->buf_len == 1)
 170                         usbtouch->buffer[1] = pkt[0];
 171
 172                 pkt_len = egalax_get_pkt_len(usbtouch->buffer);
 173
 174                 /* unknown packet: drop everything */
 175                 if (!pkt_len)
 176                         return;
 177
 178                 /* append, process */
 179                 tmp = pkt_len - usbtouch->buf_len;
 180                 memcpy(usbtouch->buffer + usbtouch->buf_len, pkt, tmp);
 181                 usbtouch_process_pkt(usbtouch, regs, usbtouch->buffer, pkt_len);
 182
 183                 buffer = pkt + tmp;
 184                 buf_len = len - tmp;
 185         } else {
 186                 buffer = pkt;
 187                 buf_len = len;
 188         }
 189
 190         /* only one byte left in buffer */
 191         if (unlikely(buf_len == 1)) {
 192                 usbtouch->buffer[0] = buffer[0];
 193                 usbtouch->buf_len = 1;
 194                 return;
 195         }
 196
 197         /* loop over the buffer */
 198         pos = 0;
 199         while (pos < buf_len) {
 200                 /* get packet len */
 201                 pkt_len = egalax_get_pkt_len(buffer + pos);
 202
 203                 /* unknown packet: drop everything */
 204                 if (unlikely(!pkt_len))
 205                         return;
 206
 207                 /* full packet: process */
 208                 if (likely(pkt_len <= buf_len)) {
 209                         usbtouch_process_pkt(usbtouch, regs, buffer + pos, pkt_len);
 210                 } else {
 211                         /* incomplete packet: save in buffer */
 212                         memcpy(usbtouch->buffer, buffer + pos, buf_len - pos);
 213                         usbtouch->buf_len = buf_len - pos;
 214                 }
 215                 pos += pkt_len;
 216         }
 217 }
 218 #endif
 219
 220
 221 /*****************************************************************************
 222  * PanJit Part
 223  */
 224 #ifdef CONFIG_USB_TOUCHSCREEN_PANJIT
 225 static int panjit_read_data(unsigned char *pkt, int *x, int *y, int *touch, int *press)
 226 {
 227         *x = ((pkt[2] & 0x0F) << 8) | pkt[1];
 228         *y = ((pkt[4] & 0x0F) << 8) | pkt[3];
 229         *touch = pkt[0] & 0x01;
 230
 231         return 1;
 232 }
 233 #endif
 234
 235
 236 /*****************************************************************************
 237  * 3M/Microtouch Part
 238  */
 239 #ifdef CONFIG_USB_TOUCHSCREEN_3M
 240
 241 #define MTOUCHUSB_ASYNC_REPORT          1
 242 #define MTOUCHUSB_RESET                 7
 243 #define MTOUCHUSB_REQ_CTRLLR_ID         10
 244
 245 static int mtouch_read_data(unsigned char *pkt, int *x, int *y, int *touch, int *press)
 246 {
 247         *x = (pkt[8] << 8) | pkt[7];
 248         *y = (pkt[10] << 8) | pkt[9];
 249         *touch = (pkt[2] & 0x40) ? 1 : 0;
 250
 251         return 1;
 252 }
 253
 254 static int mtouch_init(struct usbtouch_usb *usbtouch)
 255 {
 256         int ret;
 257
 258         ret = usb_control_msg(usbtouch->udev, usb_rcvctrlpipe(usbtouch->udev, 0),
 259                               MTOUCHUSB_RESET,
 260                               USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 261                               1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
 262         dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
 263             __FUNCTION__, ret);
 264         if (ret < 0)
 265                 return ret;
 266
 267         ret = usb_control_msg(usbtouch->udev, usb_rcvctrlpipe(usbtouch->udev, 0),
 268                               MTOUCHUSB_ASYNC_REPORT,
 269                               USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 270                               1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
 271         dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
 272             __FUNCTION__, ret);
 273         if (ret < 0)
 274                 return ret;
 275
 276         return 0;
 277 }
 278 #endif
 279
 280
 281 /*****************************************************************************
 282  * ITM Part
 283  */
 284 #ifdef CONFIG_USB_TOUCHSCREEN_ITM
 285 static int itm_read_data(unsigned char *pkt, int *x, int *y, int *touch, int *press)
 286 {
 287         *x = ((pkt[0] & 0x1F) << 7) | (pkt[3] & 0x7F);
 288         *y = ((pkt[1] & 0x1F) << 7) | (pkt[4] & 0x7F);
 289         *press = ((pkt[2] & 0x1F) << 7) | (pkt[5] & 0x7F);
 290         *touch = ~pkt[7] & 0x20;
 291
 292         return 1;
 293 }
 294 #endif
 295
 296
 297 /*****************************************************************************
 298  * the different device descriptors
 299  */
 300 static struct usbtouch_device_info usbtouch_dev_info[] = {
 301 #ifdef CONFIG_USB_TOUCHSCREEN_EGALAX
 302         [DEVTYPE_EGALAX] = {
 303                 .min_xc         = 0x0,
 304                 .max_xc         = 0x07ff,
 305                 .min_yc         = 0x0,
 306                 .max_yc         = 0x07ff,
 307                 .rept_size      = 16,
 308                 .flags          = USBTOUCH_FLG_BUFFER,
 309                 .process_pkt    = egalax_process,
 310                 .read_data      = egalax_read_data,
 311         },
 312 #endif
 313
 314 #ifdef CONFIG_USB_TOUCHSCREEN_PANJIT
 315         [DEVTYPE_PANJIT] = {
 316                 .min_xc         = 0x0,
 317                 .max_xc         = 0x0fff,
 318                 .min_yc         = 0x0,
 319                 .max_yc         = 0x0fff,
 320                 .rept_size      = 8,
 321                 .read_data      = panjit_read_data,
 322         },
 323 #endif
 324
 325 #ifdef CONFIG_USB_TOUCHSCREEN_3M
 326         [DEVTYPE_3M] = {
 327                 .min_xc         = 0x0,
 328                 .max_xc         = 0x4000,
 329                 .min_yc         = 0x0,
 330                 .max_yc         = 0x4000,
 331                 .rept_size      = 11,
 332                 .read_data      = mtouch_read_data,
 333                 .init           = mtouch_init,
 334         },
 335 #endif
 336
 337 #ifdef CONFIG_USB_TOUCHSCREEN_ITM
 338         [DEVTYPE_ITM] = {
 339                 .min_xc         = 0x0,
 340                 .max_xc         = 0x0fff,
 341                 .min_yc         = 0x0,
 342                 .max_yc         = 0x0fff,
 343                 .max_press      = 0xff,
 344                 .rept_size      = 8,
 345                 .read_data      = itm_read_data,
 346         },
 347 #endif
 348 };
 349
 350
 351 /*****************************************************************************
 352  * Generic Part
 353  */
 354 static void usbtouch_process_pkt(struct usbtouch_usb *usbtouch,
 355                                  struct pt_regs *regs, unsigned char *pkt, int len)
 356 {
 357         int x, y, touch, press;
 358         struct usbtouch_device_info *type = usbtouch->type;
 359
 360         if (!type->read_data(pkt, &x, &y, &touch, &press))
 361                         return;
 362
 363         input_regs(usbtouch->input, regs);
 364         input_report_key(usbtouch->input, BTN_TOUCH, touch);
 365
 366         if (swap_xy) {
 367                 input_report_abs(usbtouch->input, ABS_X, y);
 368                 input_report_abs(usbtouch->input, ABS_Y, x);
 369         } else {
 370                 input_report_abs(usbtouch->input, ABS_X, x);
 371                 input_report_abs(usbtouch->input, ABS_Y, y);
 372         }
 373         if (type->max_press)
 374                 input_report_abs(usbtouch->input, ABS_PRESSURE, press);
 375         input_sync(usbtouch->input);
 376 }
 377
 378
 379 static void usbtouch_irq(struct urb *urb, struct pt_regs *regs)
 380 {
 381         struct usbtouch_usb *usbtouch = urb->context;
 382         int retval;
 383
 384         switch (urb->status) {
 385         case 0:
 386                 /* success */
 387                 break;
 388         case -ETIMEDOUT:
 389                 /* this urb is timing out */
 390                 dbg("%s - urb timed out - was the device unplugged?",
 391                     __FUNCTION__);
 392                 return;
 393         case -ECONNRESET:
 394         case -ENOENT:
 395         case -ESHUTDOWN:
 396                 /* this urb is terminated, clean up */
 397                 dbg("%s - urb shutting down with status: %d",
 398                     __FUNCTION__, urb->status);
 399                 return;
 400         default:
 401                 dbg("%s - nonzero urb status received: %d",
 402                     __FUNCTION__, urb->status);
 403                 goto exit;
 404         }
 405
 406         usbtouch->type->process_pkt(usbtouch, regs, usbtouch->data, urb->actual_length);
 407
 408 exit:
 409         retval = usb_submit_urb(urb, GFP_ATOMIC);
 410         if (retval)
 411                 err("%s - usb_submit_urb failed with result: %d",
 412                     __FUNCTION__, retval);
 413 }
 414
 415 static int usbtouch_open(struct input_dev *input)
 416 {
 417         struct usbtouch_usb *usbtouch = input->private;
 418
 419         usbtouch->irq->dev = usbtouch->udev;
 420
 421         if (usb_submit_urb(usbtouch->irq, GFP_KERNEL))
 422                 return -EIO;
 423
 424         return 0;
 425 }
 426
 427 static void usbtouch_close(struct input_dev *input)
 428 {
 429         struct usbtouch_usb *usbtouch = input->private;
 430
 431         usb_kill_urb(usbtouch->irq);
 432 }
 433
 434
 435 static void usbtouch_free_buffers(struct usb_device *udev,
 436                                   struct usbtouch_usb *usbtouch)
 437 {
 438         if (usbtouch->data)
 439                 usb_buffer_free(udev, usbtouch->type->rept_size,
 440                                 usbtouch->data, usbtouch->data_dma);
 441         kfree(usbtouch->buffer);
 442 }
 443
 444
 445 static int usbtouch_probe(struct usb_interface *intf,
 446                           const struct usb_device_id *id)
 447 {
 448         struct usbtouch_usb *usbtouch;
 449         struct input_dev *input_dev;
 450         struct usb_host_interface *interface;
 451         struct usb_endpoint_descriptor *endpoint;
 452         struct usb_device *udev = interface_to_usbdev(intf);
 453         struct usbtouch_device_info *type;
 454         int err;
 455
 456         interface = intf->cur_altsetting;
 457         endpoint = &interface->endpoint[0].desc;
 458
 459         usbtouch = kzalloc(sizeof(struct usbtouch_usb), GFP_KERNEL);
 460         input_dev = input_allocate_device();
 461         if (!usbtouch || !input_dev)
 462                 goto out_free;
 463
 464         type = &usbtouch_dev_info[id->driver_info];
 465         usbtouch->type = type;
 466         if (!type->process_pkt)
 467                 type->process_pkt = usbtouch_process_pkt;
 468
 469         usbtouch->data = usb_buffer_alloc(udev, type->rept_size,
 470                                           SLAB_KERNEL, &usbtouch->data_dma);
 471         if (!usbtouch->data)
 472                 goto out_free;
 473
 474         if (type->flags & USBTOUCH_FLG_BUFFER) {
 475                 usbtouch->buffer = kmalloc(type->rept_size, GFP_KERNEL);
 476                 if (!usbtouch->buffer)
 477                         goto out_free_buffers;
 478         }
 479
 480         usbtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
 481         if (!usbtouch->irq) {
 482                 dbg("%s - usb_alloc_urb failed: usbtouch->irq", __FUNCTION__);
 483                 goto out_free_buffers;
 484         }
 485
 486         usbtouch->udev = udev;
 487         usbtouch->input = input_dev;
 488
 489         if (udev->manufacturer)
 490                 strlcpy(usbtouch->name, udev->manufacturer, sizeof(usbtouch->name));
 491
 492         if (udev->product) {
 493                 if (udev->manufacturer)
 494                         strlcat(usbtouch->name, " ", sizeof(usbtouch->name));
 495                 strlcat(usbtouch->name, udev->product, sizeof(usbtouch->name));
 496         }
 497
 498         if (!strlen(usbtouch->name))
 499                 snprintf(usbtouch->name, sizeof(usbtouch->name),
 500                         "USB Touchscreen %04x:%04x",
 501                          le16_to_cpu(udev->descriptor.idVendor),
 502                          le16_to_cpu(udev->descriptor.idProduct));
 503
 504         usb_make_path(udev, usbtouch->phys, sizeof(usbtouch->phys));
 505         strlcpy(usbtouch->phys, "/input0", sizeof(usbtouch->phys));
 506
 507         input_dev->name = usbtouch->name;
 508         input_dev->phys = usbtouch->phys;
 509         usb_to_input_id(udev, &input_dev->id);
 510         input_dev->cdev.dev = &intf->dev;
 511         input_dev->private = usbtouch;
 512         input_dev->open = usbtouch_open;
 513         input_dev->close = usbtouch_close;
 514
 515         input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
 516         input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
 517         input_set_abs_params(input_dev, ABS_X, type->min_xc, type->max_xc, 0, 0);
 518         input_set_abs_params(input_dev, ABS_Y, type->min_yc, type->max_yc, 0, 0);
 519         if (type->max_press)
 520                 input_set_abs_params(input_dev, ABS_PRESSURE, type->min_press,
 521                                      type->max_press, 0, 0);
 522
 523         usb_fill_int_urb(usbtouch->irq, usbtouch->udev,
 524                          usb_rcvintpipe(usbtouch->udev, endpoint->bEndpointAddress),
 525                          usbtouch->data, type->rept_size,
 526                          usbtouch_irq, usbtouch, endpoint->bInterval);
 527
 528         usbtouch->irq->transfer_dma = usbtouch->data_dma;
 529         usbtouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 530
 531         /* device specific init */
 532         if (type->init) {
 533                 err = type->init(usbtouch);
 534                 if (err) {
 535                         dbg("%s - type->init() failed, err: %d", __FUNCTION__, err);
 536                         goto out_free_buffers;
 537                 }
 538         }
 539
 540         err = input_register_device(usbtouch->input);
 541         if (err) {
 542                 dbg("%s - input_register_device failed, err: %d", __FUNCTION__, err);
 543                 goto out_free_buffers;
 544         }
 545
 546         usb_set_intfdata(intf, usbtouch);
 547
 548         return 0;
 549
 550 out_free_buffers:
 551         usbtouch_free_buffers(udev, usbtouch);
 552 out_free:
 553         input_free_device(input_dev);
 554         kfree(usbtouch);
 555         return -ENOMEM;
 556 }
 557
 558 static void usbtouch_disconnect(struct usb_interface *intf)
 559 {
 560         struct usbtouch_usb *usbtouch = usb_get_intfdata(intf);
 561
 562         dbg("%s - called", __FUNCTION__);
 563
 564         if (!usbtouch)
 565                 return;
 566
 567         dbg("%s - usbtouch is initialized, cleaning up", __FUNCTION__);
 568         usb_set_intfdata(intf, NULL);
 569         usb_kill_urb(usbtouch->irq);
 570         input_unregister_device(usbtouch->input);
 571         usb_free_urb(usbtouch->irq);
 572         usbtouch_free_buffers(interface_to_usbdev(intf), usbtouch);
 573         kfree(usbtouch);
 574 }
 575
 576 MODULE_DEVICE_TABLE(usb, usbtouch_devices);
 577
 578 static struct usb_driver usbtouch_driver = {
 579         .name           = "usbtouchscreen",
 580         .probe          = usbtouch_probe,
 581         .disconnect     = usbtouch_disconnect,
 582         .id_table       = usbtouch_devices,
 583 };
 584
 585 static int __init usbtouch_init(void)
 586 {
 587         return usb_register(&usbtouch_driver);
 588 }
 589
 590 static void __exit usbtouch_cleanup(void)
 591 {
 592         usb_deregister(&usbtouch_driver);
 593 }
 594
 595 module_init(usbtouch_init);
 596 module_exit(usbtouch_cleanup);
 597
 598 MODULE_AUTHOR(DRIVER_AUTHOR);
 599 MODULE_DESCRIPTION(DRIVER_DESC);
 600 MODULE_LICENSE("GPL");
 601
 602 MODULE_ALIAS("touchkitusb");
 603 MODULE_ALIAS("itmtouch");
 604 MODULE_ALIAS("mtouchusb");