drivers/input/tsdev.c

   1 /*
   2  * $Id: tsdev.c,v 1.15 2002/04/10 16:50:19 jsimmons Exp $
   3  *
   4  *  Copyright (c) 2001 "Crazy" james Simmons
   5  *
   6  *  Compaq touchscreen protocol driver. The protocol emulated by this driver
   7  *  is obsolete; for new programs use the tslib library which can read directly
   8  *  from evdev and perform dejittering, variance filtering and calibration -
   9  *  all in user space, not at kernel level. The meaning of this driver is
  10  *  to allow usage of newer input drivers with old applications that use the
  11  *  old /dev/h3600_ts and /dev/h3600_tsraw devices.
  12  *
  13  *  09-Apr-2004: Andrew Zabolotny <zap@homelink.ru>
  14  *      Fixed to actually work, not just output random numbers.
  15  *      Added support for both h3600_ts and h3600_tsraw protocol
  16  *      emulation.
  17  */
  18
  19 /*
  20  * This program is free software; you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation; either version 2 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program; if not, write to the Free Software
  32  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  33  *
  34  * Should you need to contact me, the author, you can do so either by
  35  * e-mail - mail your message to <jsimmons@infradead.org>.
  36  */
  37
  38 #define TSDEV_MINOR_BASE        128
  39 #define TSDEV_MINORS            32
  40 /* First 16 devices are h3600_ts compatible; second 16 are h3600_tsraw */
  41 #define TSDEV_MINOR_MASK        15
  42 #define TSDEV_BUFFER_SIZE       64
  43
  44 #include <linux/slab.h>
  45 #include <linux/poll.h>
  46 #include <linux/module.h>
  47 #include <linux/moduleparam.h>
  48 #include <linux/init.h>
  49 #include <linux/input.h>
  50 #include <linux/major.h>
  51 #include <linux/random.h>
  52 #include <linux/time.h>
  53 #include <linux/device.h>
  54
  55 #ifndef CONFIG_INPUT_TSDEV_SCREEN_X
  56 #define CONFIG_INPUT_TSDEV_SCREEN_X     240
  57 #endif
  58 #ifndef CONFIG_INPUT_TSDEV_SCREEN_Y
  59 #define CONFIG_INPUT_TSDEV_SCREEN_Y     320
  60 #endif
  61
  62 /* This driver emulates both protocols of the old h3600_ts and h3600_tsraw
  63  * devices. The first one must output X/Y data in 'cooked' format, e.g.
  64  * filtered, dejittered and calibrated. Second device just outputs raw
  65  * data received from the hardware.
  66  *
  67  * This driver doesn't support filtering and dejittering; it supports only
  68  * calibration. Filtering and dejittering must be done in the low-level
  69  * driver, if needed, because it may gain additional benefits from knowing
  70  * the low-level details, the nature of noise and so on.
  71  *
  72  * The driver precomputes a calibration matrix given the initial xres and
  73  * yres values (quite innacurate for most touchscreens) that will result
  74  * in a more or less expected range of output values. The driver supports
  75  * the TS_SET_CAL ioctl, which will replace the calibration matrix with a
  76  * new one, supposedly generated from the values taken from the raw device.
  77  */
  78
  79 MODULE_AUTHOR("James Simmons <jsimmons@transvirtual.com>");
  80 MODULE_DESCRIPTION("Input driver to touchscreen converter");
  81 MODULE_LICENSE("GPL");
  82
  83 static int xres = CONFIG_INPUT_TSDEV_SCREEN_X;
  84 module_param(xres, uint, 0);
  85 MODULE_PARM_DESC(xres, "Horizontal screen resolution (can be negative for X-mirror)");
  86
  87 static int yres = CONFIG_INPUT_TSDEV_SCREEN_Y;
  88 module_param(yres, uint, 0);
  89 MODULE_PARM_DESC(yres, "Vertical screen resolution (can be negative for Y-mirror)");
  90
  91 /* From Compaq's Touch Screen Specification version 0.2 (draft) */
  92 struct ts_event {
  93         short pressure;
  94         short x;
  95         short y;
  96         short millisecs;
  97 };
  98
  99 struct ts_calibration {
 100         int xscale;
 101         int xtrans;
 102         int yscale;
 103         int ytrans;
 104         int xyswap;
 105 };
 106
 107 struct tsdev {
 108         int exist;
 109         int open;
 110         int minor;
 111         char name[8];
 112         struct input_handle handle;
 113         wait_queue_head_t wait;
 114         struct list_head client_list;
 115         struct device dev;
 116
 117         int x, y, pressure;
 118         struct ts_calibration cal;
 119 };
 120
 121 struct tsdev_client {
 122         struct fasync_struct *fasync;
 123         struct list_head node;
 124         struct tsdev *tsdev;
 125         int head, tail;
 126         struct ts_event event[TSDEV_BUFFER_SIZE];
 127         int raw;
 128 };
 129
 130 /* The following ioctl codes are defined ONLY for backward compatibility.
 131  * Don't use tsdev for new developement; use the tslib library instead.
 132  * Touchscreen calibration is a fully userspace task.
 133  */
 134 /* Use 'f' as magic number */
 135 #define IOC_H3600_TS_MAGIC  'f'
 136 #define TS_GET_CAL      _IOR(IOC_H3600_TS_MAGIC, 10, struct ts_calibration)
 137 #define TS_SET_CAL      _IOW(IOC_H3600_TS_MAGIC, 11, struct ts_calibration)
 138
 139 static struct tsdev *tsdev_table[TSDEV_MINORS/2];
 140
 141 static int tsdev_fasync(int fd, struct file *file, int on)
 142 {
 143         struct tsdev_client *client = file->private_data;
 144         int retval;
 145
 146         retval = fasync_helper(fd, file, on, &client->fasync);
 147         return retval < 0 ? retval : 0;
 148 }
 149
 150 static int tsdev_open(struct inode *inode, struct file *file)
 151 {
 152         int i = iminor(inode) - TSDEV_MINOR_BASE;
 153         struct tsdev_client *client;
 154         struct tsdev *tsdev;
 155         int error;
 156
 157         printk(KERN_WARNING "tsdev (compaq touchscreen emulation) is scheduled "
 158                 "for removal.\nSee Documentation/feature-removal-schedule.txt "
 159                 "for details.\n");
 160
 161         if (i >= TSDEV_MINORS)
 162                 return -ENODEV;
 163
 164         tsdev = tsdev_table[i & TSDEV_MINOR_MASK];
 165         if (!tsdev || !tsdev->exist)
 166                 return -ENODEV;
 167
 168         get_device(&tsdev->dev);
 169
 170         client = kzalloc(sizeof(struct tsdev_client), GFP_KERNEL);
 171         if (!client) {
 172                 error = -ENOMEM;
 173                 goto err_put_tsdev;
 174         }
 175
 176         client->tsdev = tsdev;
 177         client->raw = (i >= TSDEV_MINORS / 2) ? 1 : 0;
 178         list_add_tail(&client->node, &tsdev->client_list);
 179
 180         if (!tsdev->open++ && tsdev->exist) {
 181                 error = input_open_device(&tsdev->handle);
 182                 if (error)
 183                         goto err_free_client;
 184         }
 185
 186         file->private_data = client;
 187         return 0;
 188
 189  err_free_client:
 190         list_del(&client->node);
 191         kfree(client);
 192  err_put_tsdev:
 193         put_device(&tsdev->dev);
 194         return error;
 195 }
 196
 197 static void tsdev_free(struct device *dev)
 198 {
 199         struct tsdev *tsdev = container_of(dev, struct tsdev, dev);
 200
 201         tsdev_table[tsdev->minor] = NULL;
 202         kfree(tsdev);
 203 }
 204
 205 static int tsdev_release(struct inode *inode, struct file *file)
 206 {
 207         struct tsdev_client *client = file->private_data;
 208         struct tsdev *tsdev = client->tsdev;
 209
 210         tsdev_fasync(-1, file, 0);
 211
 212         list_del(&client->node);
 213         kfree(client);
 214
 215         if (!--tsdev->open && tsdev->exist)
 216                 input_close_device(&tsdev->handle);
 217
 218         put_device(&tsdev->dev);
 219
 220         return 0;
 221 }
 222
 223 static ssize_t tsdev_read(struct file *file, char __user *buffer, size_t count,
 224                           loff_t *ppos)
 225 {
 226         struct tsdev_client *client = file->private_data;
 227         struct tsdev *tsdev = client->tsdev;
 228         int retval = 0;
 229
 230         if (client->head == client->tail && tsdev->exist && (file->f_flags & O_NONBLOCK))
 231                 return -EAGAIN;
 232
 233         retval = wait_event_interruptible(tsdev->wait,
 234                         client->head != client->tail || !tsdev->exist);
 235         if (retval)
 236                 return retval;
 237
 238         if (!tsdev->exist)
 239                 return -ENODEV;
 240
 241         while (client->head != client->tail &&
 242                retval + sizeof (struct ts_event) <= count) {
 243                 if (copy_to_user (buffer + retval, client->event + client->tail,
 244                                   sizeof (struct ts_event)))
 245                         return -EFAULT;
 246                 client->tail = (client->tail + 1) & (TSDEV_BUFFER_SIZE - 1);
 247                 retval += sizeof (struct ts_event);
 248         }
 249
 250         return retval;
 251 }
 252
 253 /* No kernel lock - fine */
 254 static unsigned int tsdev_poll(struct file *file, poll_table *wait)
 255 {
 256         struct tsdev_client *client = file->private_data;
 257         struct tsdev *tsdev = client->tsdev;
 258
 259         poll_wait(file, &tsdev->wait, wait);
 260         return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
 261                 (tsdev->exist ? 0 : (POLLHUP | POLLERR));
 262 }
 263
 264 static int tsdev_ioctl(struct inode *inode, struct file *file,
 265                        unsigned int cmd, unsigned long arg)
 266 {
 267         struct tsdev_client *client = file->private_data;
 268         struct tsdev *tsdev = client->tsdev;
 269         int retval = 0;
 270
 271         switch (cmd) {
 272         case TS_GET_CAL:
 273                 if (copy_to_user((void __user *)arg, &tsdev->cal,
 274                                  sizeof (struct ts_calibration)))
 275                         retval = -EFAULT;
 276                 break;
 277
 278         case TS_SET_CAL:
 279                 if (copy_from_user(&tsdev->cal, (void __user *)arg,
 280                                    sizeof (struct ts_calibration)))
 281                         retval = -EFAULT;
 282                 break;
 283
 284         default:
 285                 retval = -EINVAL;
 286                 break;
 287         }
 288
 289         return retval;
 290 }
 291
 292 static const struct file_operations tsdev_fops = {
 293         .owner =        THIS_MODULE,
 294         .open =         tsdev_open,
 295         .release =      tsdev_release,
 296         .read =         tsdev_read,
 297         .poll =         tsdev_poll,
 298         .fasync =       tsdev_fasync,
 299         .ioctl =        tsdev_ioctl,
 300 };
 301
 302 static void tsdev_event(struct input_handle *handle, unsigned int type,
 303                         unsigned int code, int value)
 304 {
 305         struct tsdev *tsdev = handle->private;
 306         struct tsdev_client *client;
 307         struct timeval time;
 308
 309         switch (type) {
 310         case EV_ABS:
 311                 switch (code) {
 312                 case ABS_X:
 313                         tsdev->x = value;
 314                         break;
 315
 316                 case ABS_Y:
 317                         tsdev->y = value;
 318                         break;
 319
 320                 case ABS_PRESSURE:
 321                         if (value > handle->dev->absmax[ABS_PRESSURE])
 322                                 value = handle->dev->absmax[ABS_PRESSURE];
 323                         value -= handle->dev->absmin[ABS_PRESSURE];
 324                         if (value < 0)
 325                                 value = 0;
 326                         tsdev->pressure = value;
 327                         break;
 328                 }
 329                 break;
 330
 331         case EV_REL:
 332                 switch (code) {
 333                 case REL_X:
 334                         tsdev->x += value;
 335                         if (tsdev->x < 0)
 336                                 tsdev->x = 0;
 337                         else if (tsdev->x > xres)
 338                                 tsdev->x = xres;
 339                         break;
 340
 341                 case REL_Y:
 342                         tsdev->y += value;
 343                         if (tsdev->y < 0)
 344                                 tsdev->y = 0;
 345                         else if (tsdev->y > yres)
 346                                 tsdev->y = yres;
 347                         break;
 348                 }
 349                 break;
 350
 351         case EV_KEY:
 352                 if (code == BTN_TOUCH || code == BTN_MOUSE) {
 353                         switch (value) {
 354                         case 0:
 355                                 tsdev->pressure = 0;
 356                                 break;
 357
 358                         case 1:
 359                                 if (!tsdev->pressure)
 360                                         tsdev->pressure = 1;
 361                                 break;
 362                         }
 363                 }
 364                 break;
 365         }
 366
 367         if (type != EV_SYN || code != SYN_REPORT)
 368                 return;
 369
 370         list_for_each_entry(client, &tsdev->client_list, node) {
 371                 int x, y, tmp;
 372
 373                 do_gettimeofday(&time);
 374                 client->event[client->head].millisecs = time.tv_usec / 1000;
 375                 client->event[client->head].pressure = tsdev->pressure;
 376
 377                 x = tsdev->x;
 378                 y = tsdev->y;
 379
 380                 /* Calibration */
 381                 if (!client->raw) {
 382                         x = ((x * tsdev->cal.xscale) >> 8) + tsdev->cal.xtrans;
 383                         y = ((y * tsdev->cal.yscale) >> 8) + tsdev->cal.ytrans;
 384                         if (tsdev->cal.xyswap) {
 385                                 tmp = x; x = y; y = tmp;
 386                         }
 387                 }
 388
 389                 client->event[client->head].x = x;
 390                 client->event[client->head].y = y;
 391                 client->head = (client->head + 1) & (TSDEV_BUFFER_SIZE - 1);
 392                 kill_fasync(&client->fasync, SIGIO, POLL_IN);
 393         }
 394         wake_up_interruptible(&tsdev->wait);
 395 }
 396
 397 static int tsdev_connect(struct input_handler *handler, struct input_dev *dev,
 398                          const struct input_device_id *id)
 399 {
 400         struct tsdev *tsdev;
 401         int minor, delta;
 402         int error;
 403
 404         for (minor = 0; minor < TSDEV_MINORS / 2 && tsdev_table[minor]; minor++);
 405         if (minor >= TSDEV_MINORS / 2) {
 406                 printk(KERN_ERR
 407                        "tsdev: You have way too many touchscreens\n");
 408                 return -ENFILE;
 409         }
 410
 411         tsdev = kzalloc(sizeof(struct tsdev), GFP_KERNEL);
 412         if (!tsdev)
 413                 return -ENOMEM;
 414
 415         INIT_LIST_HEAD(&tsdev->client_list);
 416         init_waitqueue_head(&tsdev->wait);
 417
 418         tsdev->exist = 1;
 419         tsdev->minor = minor;
 420         tsdev->handle.dev = dev;
 421         tsdev->handle.name = tsdev->name;
 422         tsdev->handle.handler = handler;
 423         tsdev->handle.private = tsdev;
 424         snprintf(tsdev->name, sizeof(tsdev->name), "ts%d", minor);
 425
 426         /* Precompute the rough calibration matrix */
 427         delta = dev->absmax [ABS_X] - dev->absmin [ABS_X] + 1;
 428         if (delta == 0)
 429                 delta = 1;
 430         tsdev->cal.xscale = (xres << 8) / delta;
 431         tsdev->cal.xtrans = - ((dev->absmin [ABS_X] * tsdev->cal.xscale) >> 8);
 432
 433         delta = dev->absmax [ABS_Y] - dev->absmin [ABS_Y] + 1;
 434         if (delta == 0)
 435                 delta = 1;
 436         tsdev->cal.yscale = (yres << 8) / delta;
 437         tsdev->cal.ytrans = - ((dev->absmin [ABS_Y] * tsdev->cal.yscale) >> 8);
 438
 439         snprintf(tsdev->dev.bus_id, sizeof(tsdev->dev.bus_id),
 440                  "ts%d", minor);
 441         tsdev->dev.class = &input_class;
 442         tsdev->dev.parent = &dev->dev;
 443         tsdev->dev.devt = MKDEV(INPUT_MAJOR, TSDEV_MINOR_BASE + minor);
 444         tsdev->dev.release = tsdev_free;
 445         device_initialize(&tsdev->dev);
 446
 447         tsdev_table[minor] = tsdev;
 448
 449         error = device_add(&tsdev->dev);
 450         if (error)
 451                 goto err_free_tsdev;
 452
 453         error = input_register_handle(&tsdev->handle);
 454         if (error)
 455                 goto err_delete_tsdev;
 456
 457         return 0;
 458
 459  err_delete_tsdev:
 460         device_del(&tsdev->dev);
 461  err_free_tsdev:
 462         put_device(&tsdev->dev);
 463         return error;
 464 }
 465
 466 static void tsdev_disconnect(struct input_handle *handle)
 467 {
 468         struct tsdev *tsdev = handle->private;
 469         struct tsdev_client *client;
 470
 471         input_unregister_handle(handle);
 472         device_del(&tsdev->dev);
 473
 474         tsdev->exist = 0;
 475
 476         if (tsdev->open) {
 477                 input_close_device(handle);
 478                 list_for_each_entry(client, &tsdev->client_list, node)
 479                         kill_fasync(&client->fasync, SIGIO, POLL_HUP);
 480                 wake_up_interruptible(&tsdev->wait);
 481         }
 482
 483         put_device(&tsdev->dev);
 484 }
 485
 486 static const struct input_device_id tsdev_ids[] = {
 487         {
 488               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_KEYBIT | INPUT_DEVICE_ID_MATCH_RELBIT,
 489               .evbit    = { BIT(EV_KEY) | BIT(EV_REL) },
 490               .keybit   = { [LONG(BTN_LEFT)] = BIT(BTN_LEFT) },
 491               .relbit   = { BIT(REL_X) | BIT(REL_Y) },
 492         }, /* A mouse like device, at least one button, two relative axes */
 493
 494         {
 495               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_KEYBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
 496               .evbit    = { BIT(EV_KEY) | BIT(EV_ABS) },
 497               .keybit   = { [LONG(BTN_TOUCH)] = BIT(BTN_TOUCH) },
 498               .absbit   = { BIT(ABS_X) | BIT(ABS_Y) },
 499         }, /* A tablet like device, at least touch detection, two absolute axes */
 500
 501         {
 502               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
 503               .evbit    = { BIT(EV_ABS) },
 504               .absbit   = { BIT(ABS_X) | BIT(ABS_Y) | BIT(ABS_PRESSURE) },
 505         }, /* A tablet like device with several gradations of pressure */
 506
 507         {} /* Terminating entry */
 508 };
 509
 510 MODULE_DEVICE_TABLE(input, tsdev_ids);
 511
 512 static struct input_handler tsdev_handler = {
 513         .event =        tsdev_event,
 514         .connect =      tsdev_connect,
 515         .disconnect =   tsdev_disconnect,
 516         .fops =         &tsdev_fops,
 517         .minor =        TSDEV_MINOR_BASE,
 518         .name =         "tsdev",
 519         .id_table =     tsdev_ids,
 520 };
 521
 522 static int __init tsdev_init(void)
 523 {
 524         return input_register_handler(&tsdev_handler);
 525 }
 526
 527 static void __exit tsdev_exit(void)
 528 {
 529         input_unregister_handler(&tsdev_handler);
 530 }
 531
 532 module_init(tsdev_init);
 533 module_exit(tsdev_exit);