Input: gpio-keys - add suspend/resume support
[safe/jmp/linux-2.6] / 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         spinlock_t client_lock; /* protects client_list */
116         struct mutex mutex;
117         struct device dev;
118
119         int x, y, pressure;
120         struct ts_calibration cal;
121 };
122
123 struct tsdev_client {
124         struct fasync_struct *fasync;
125         struct list_head node;
126         struct tsdev *tsdev;
127         struct ts_event buffer[TSDEV_BUFFER_SIZE];
128         int head, tail;
129         spinlock_t buffer_lock; /* protects access to buffer, head and tail */
130         int raw;
131 };
132
133 /* The following ioctl codes are defined ONLY for backward compatibility.
134  * Don't use tsdev for new developement; use the tslib library instead.
135  * Touchscreen calibration is a fully userspace task.
136  */
137 /* Use 'f' as magic number */
138 #define IOC_H3600_TS_MAGIC  'f'
139 #define TS_GET_CAL      _IOR(IOC_H3600_TS_MAGIC, 10, struct ts_calibration)
140 #define TS_SET_CAL      _IOW(IOC_H3600_TS_MAGIC, 11, struct ts_calibration)
141
142 static struct tsdev *tsdev_table[TSDEV_MINORS/2];
143 static DEFINE_MUTEX(tsdev_table_mutex);
144
145 static int tsdev_fasync(int fd, struct file *file, int on)
146 {
147         struct tsdev_client *client = file->private_data;
148         int retval;
149
150         retval = fasync_helper(fd, file, on, &client->fasync);
151
152         return retval < 0 ? retval : 0;
153 }
154
155 static void tsdev_free(struct device *dev)
156 {
157         struct tsdev *tsdev = container_of(dev, struct tsdev, dev);
158
159         kfree(tsdev);
160 }
161
162 static void tsdev_attach_client(struct tsdev *tsdev, struct tsdev_client *client)
163 {
164         spin_lock(&tsdev->client_lock);
165         list_add_tail_rcu(&client->node, &tsdev->client_list);
166         spin_unlock(&tsdev->client_lock);
167         synchronize_sched();
168 }
169
170 static void tsdev_detach_client(struct tsdev *tsdev, struct tsdev_client *client)
171 {
172         spin_lock(&tsdev->client_lock);
173         list_del_rcu(&client->node);
174         spin_unlock(&tsdev->client_lock);
175         synchronize_sched();
176 }
177
178 static int tsdev_open_device(struct tsdev *tsdev)
179 {
180         int retval;
181
182         retval = mutex_lock_interruptible(&tsdev->mutex);
183         if (retval)
184                 return retval;
185
186         if (!tsdev->exist)
187                 retval = -ENODEV;
188         else if (!tsdev->open++)
189                 retval = input_open_device(&tsdev->handle);
190
191         mutex_unlock(&tsdev->mutex);
192         return retval;
193 }
194
195 static void tsdev_close_device(struct tsdev *tsdev)
196 {
197         mutex_lock(&tsdev->mutex);
198
199         if (tsdev->exist && !--tsdev->open)
200                 input_close_device(&tsdev->handle);
201
202         mutex_unlock(&tsdev->mutex);
203 }
204
205 /*
206  * Wake up users waiting for IO so they can disconnect from
207  * dead device.
208  */
209 static void tsdev_hangup(struct tsdev *tsdev)
210 {
211         struct tsdev_client *client;
212
213         spin_lock(&tsdev->client_lock);
214         list_for_each_entry(client, &tsdev->client_list, node)
215                 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
216         spin_unlock(&tsdev->client_lock);
217
218         wake_up_interruptible(&tsdev->wait);
219 }
220
221 static int tsdev_release(struct inode *inode, struct file *file)
222 {
223         struct tsdev_client *client = file->private_data;
224         struct tsdev *tsdev = client->tsdev;
225
226         tsdev_fasync(-1, file, 0);
227         tsdev_detach_client(tsdev, client);
228         kfree(client);
229
230         tsdev_close_device(tsdev);
231         put_device(&tsdev->dev);
232
233         return 0;
234 }
235
236 static int tsdev_open(struct inode *inode, struct file *file)
237 {
238         int i = iminor(inode) - TSDEV_MINOR_BASE;
239         struct tsdev_client *client;
240         struct tsdev *tsdev;
241         int error;
242
243         printk(KERN_WARNING "tsdev (compaq touchscreen emulation) is scheduled "
244                 "for removal.\nSee Documentation/feature-removal-schedule.txt "
245                 "for details.\n");
246
247         if (i >= TSDEV_MINORS)
248                 return -ENODEV;
249
250         error = mutex_lock_interruptible(&tsdev_table_mutex);
251         if (error)
252                 return error;
253         tsdev = tsdev_table[i & TSDEV_MINOR_MASK];
254         if (tsdev)
255                 get_device(&tsdev->dev);
256         mutex_unlock(&tsdev_table_mutex);
257
258         if (!tsdev)
259                 return -ENODEV;
260
261         client = kzalloc(sizeof(struct tsdev_client), GFP_KERNEL);
262         if (!client) {
263                 error = -ENOMEM;
264                 goto err_put_tsdev;
265         }
266
267         spin_lock_init(&client->buffer_lock);
268         client->tsdev = tsdev;
269         client->raw = i >= TSDEV_MINORS / 2;
270         tsdev_attach_client(tsdev, client);
271
272         error = tsdev_open_device(tsdev);
273         if (error)
274                 goto err_free_client;
275
276         file->private_data = client;
277         return 0;
278
279  err_free_client:
280         tsdev_detach_client(tsdev, client);
281         kfree(client);
282  err_put_tsdev:
283         put_device(&tsdev->dev);
284         return error;
285 }
286
287 static int tsdev_fetch_next_event(struct tsdev_client *client,
288                                   struct ts_event *event)
289 {
290         int have_event;
291
292         spin_lock_irq(&client->buffer_lock);
293
294         have_event = client->head != client->tail;
295         if (have_event) {
296                 *event = client->buffer[client->tail++];
297                 client->tail &= TSDEV_BUFFER_SIZE - 1;
298         }
299
300         spin_unlock_irq(&client->buffer_lock);
301
302         return have_event;
303 }
304
305 static ssize_t tsdev_read(struct file *file, char __user *buffer, size_t count,
306                           loff_t *ppos)
307 {
308         struct tsdev_client *client = file->private_data;
309         struct tsdev *tsdev = client->tsdev;
310         struct ts_event event;
311         int retval;
312
313         if (client->head == client->tail && tsdev->exist &&
314             (file->f_flags & O_NONBLOCK))
315                 return -EAGAIN;
316
317         retval = wait_event_interruptible(tsdev->wait,
318                         client->head != client->tail || !tsdev->exist);
319         if (retval)
320                 return retval;
321
322         if (!tsdev->exist)
323                 return -ENODEV;
324
325         while (retval + sizeof(struct ts_event) <= count &&
326                tsdev_fetch_next_event(client, &event)) {
327
328                 if (copy_to_user(buffer + retval, &event,
329                                  sizeof(struct ts_event)))
330                         return -EFAULT;
331
332                 retval += sizeof(struct ts_event);
333         }
334
335         return retval;
336 }
337
338 /* No kernel lock - fine */
339 static unsigned int tsdev_poll(struct file *file, poll_table *wait)
340 {
341         struct tsdev_client *client = file->private_data;
342         struct tsdev *tsdev = client->tsdev;
343
344         poll_wait(file, &tsdev->wait, wait);
345         return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
346                 (tsdev->exist ? 0 : (POLLHUP | POLLERR));
347 }
348
349 static long tsdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
350 {
351         struct tsdev_client *client = file->private_data;
352         struct tsdev *tsdev = client->tsdev;
353         int retval = 0;
354
355         retval = mutex_lock_interruptible(&tsdev->mutex);
356         if (retval)
357                 return retval;
358
359         if (!tsdev->exist) {
360                 retval = -ENODEV;
361                 goto out;
362         }
363
364         switch (cmd) {
365
366         case TS_GET_CAL:
367                 if (copy_to_user((void __user *)arg, &tsdev->cal,
368                                  sizeof (struct ts_calibration)))
369                         retval = -EFAULT;
370                 break;
371
372         case TS_SET_CAL:
373                 if (copy_from_user(&tsdev->cal, (void __user *)arg,
374                                    sizeof(struct ts_calibration)))
375                         retval = -EFAULT;
376                 break;
377
378         default:
379                 retval = -EINVAL;
380                 break;
381         }
382
383  out:
384         mutex_unlock(&tsdev->mutex);
385         return retval;
386 }
387
388 static const struct file_operations tsdev_fops = {
389         .owner          = THIS_MODULE,
390         .open           = tsdev_open,
391         .release        = tsdev_release,
392         .read           = tsdev_read,
393         .poll           = tsdev_poll,
394         .fasync         = tsdev_fasync,
395         .unlocked_ioctl = tsdev_ioctl,
396 };
397
398 static void tsdev_pass_event(struct tsdev *tsdev, struct tsdev_client *client,
399                              int x, int y, int pressure, int millisecs)
400 {
401         struct ts_event *event;
402         int tmp;
403
404         /* Interrupts are already disabled, just acquire the lock */
405         spin_lock(&client->buffer_lock);
406
407         event = &client->buffer[client->head++];
408         client->head &= TSDEV_BUFFER_SIZE - 1;
409
410         /* Calibration */
411         if (!client->raw) {
412                 x = ((x * tsdev->cal.xscale) >> 8) + tsdev->cal.xtrans;
413                 y = ((y * tsdev->cal.yscale) >> 8) + tsdev->cal.ytrans;
414                 if (tsdev->cal.xyswap) {
415                         tmp = x; x = y; y = tmp;
416                 }
417         }
418
419         event->millisecs = millisecs;
420         event->x = x;
421         event->y = y;
422         event->pressure = pressure;
423
424         spin_unlock(&client->buffer_lock);
425
426         kill_fasync(&client->fasync, SIGIO, POLL_IN);
427 }
428
429 static void tsdev_distribute_event(struct tsdev *tsdev)
430 {
431         struct tsdev_client *client;
432         struct timeval time;
433         int millisecs;
434
435         do_gettimeofday(&time);
436         millisecs = time.tv_usec / 1000;
437
438         list_for_each_entry_rcu(client, &tsdev->client_list, node)
439                 tsdev_pass_event(tsdev, client,
440                                  tsdev->x, tsdev->y,
441                                  tsdev->pressure, millisecs);
442 }
443
444 static void tsdev_event(struct input_handle *handle, unsigned int type,
445                         unsigned int code, int value)
446 {
447         struct tsdev *tsdev = handle->private;
448         struct input_dev *dev = handle->dev;
449         int wake_up_readers = 0;
450
451         switch (type) {
452
453         case EV_ABS:
454                 switch (code) {
455
456                 case ABS_X:
457                         tsdev->x = value;
458                         break;
459
460                 case ABS_Y:
461                         tsdev->y = value;
462                         break;
463
464                 case ABS_PRESSURE:
465                         if (value > dev->absmax[ABS_PRESSURE])
466                                 value = dev->absmax[ABS_PRESSURE];
467                         value -= dev->absmin[ABS_PRESSURE];
468                         if (value < 0)
469                                 value = 0;
470                         tsdev->pressure = value;
471                         break;
472                 }
473                 break;
474
475         case EV_REL:
476                 switch (code) {
477
478                 case REL_X:
479                         tsdev->x += value;
480                         if (tsdev->x < 0)
481                                 tsdev->x = 0;
482                         else if (tsdev->x > xres)
483                                 tsdev->x = xres;
484                         break;
485
486                 case REL_Y:
487                         tsdev->y += value;
488                         if (tsdev->y < 0)
489                                 tsdev->y = 0;
490                         else if (tsdev->y > yres)
491                                 tsdev->y = yres;
492                         break;
493                 }
494                 break;
495
496         case EV_KEY:
497                 if (code == BTN_TOUCH || code == BTN_MOUSE) {
498                         switch (value) {
499
500                         case 0:
501                                 tsdev->pressure = 0;
502                                 break;
503
504                         case 1:
505                                 if (!tsdev->pressure)
506                                         tsdev->pressure = 1;
507                                 break;
508                         }
509                 }
510                 break;
511
512         case EV_SYN:
513                 if (code == SYN_REPORT) {
514                         tsdev_distribute_event(tsdev);
515                         wake_up_readers = 1;
516                 }
517                 break;
518         }
519
520         if (wake_up_readers)
521                 wake_up_interruptible(&tsdev->wait);
522 }
523
524 static int tsdev_install_chrdev(struct tsdev *tsdev)
525 {
526         tsdev_table[tsdev->minor] = tsdev;
527         return 0;
528 }
529
530 static void tsdev_remove_chrdev(struct tsdev *tsdev)
531 {
532         mutex_lock(&tsdev_table_mutex);
533         tsdev_table[tsdev->minor] = NULL;
534         mutex_unlock(&tsdev_table_mutex);
535 }
536
537 /*
538  * Mark device non-existant. This disables writes, ioctls and
539  * prevents new users from opening the device. Already posted
540  * blocking reads will stay, however new ones will fail.
541  */
542 static void tsdev_mark_dead(struct tsdev *tsdev)
543 {
544         mutex_lock(&tsdev->mutex);
545         tsdev->exist = 0;
546         mutex_unlock(&tsdev->mutex);
547 }
548
549 static void tsdev_cleanup(struct tsdev *tsdev)
550 {
551         struct input_handle *handle = &tsdev->handle;
552
553         tsdev_mark_dead(tsdev);
554         tsdev_hangup(tsdev);
555         tsdev_remove_chrdev(tsdev);
556
557         /* tsdev is marked dead so noone else accesses tsdev->open */
558         if (tsdev->open)
559                 input_close_device(handle);
560 }
561
562 static int tsdev_connect(struct input_handler *handler, struct input_dev *dev,
563                          const struct input_device_id *id)
564 {
565         struct tsdev *tsdev;
566         int delta;
567         int minor;
568         int error;
569
570         for (minor = 0; minor < TSDEV_MINORS / 2; minor++)
571                 if (!tsdev_table[minor])
572                         break;
573
574         if (minor == TSDEV_MINORS) {
575                 printk(KERN_ERR "tsdev: no more free tsdev devices\n");
576                 return -ENFILE;
577         }
578
579         tsdev = kzalloc(sizeof(struct tsdev), GFP_KERNEL);
580         if (!tsdev)
581                 return -ENOMEM;
582
583         INIT_LIST_HEAD(&tsdev->client_list);
584         spin_lock_init(&tsdev->client_lock);
585         mutex_init(&tsdev->mutex);
586         init_waitqueue_head(&tsdev->wait);
587
588         snprintf(tsdev->name, sizeof(tsdev->name), "ts%d", minor);
589         tsdev->exist = 1;
590         tsdev->minor = minor;
591
592         tsdev->handle.dev = dev;
593         tsdev->handle.name = tsdev->name;
594         tsdev->handle.handler = handler;
595         tsdev->handle.private = tsdev;
596
597         /* Precompute the rough calibration matrix */
598         delta = dev->absmax [ABS_X] - dev->absmin [ABS_X] + 1;
599         if (delta == 0)
600                 delta = 1;
601         tsdev->cal.xscale = (xres << 8) / delta;
602         tsdev->cal.xtrans = - ((dev->absmin [ABS_X] * tsdev->cal.xscale) >> 8);
603
604         delta = dev->absmax [ABS_Y] - dev->absmin [ABS_Y] + 1;
605         if (delta == 0)
606                 delta = 1;
607         tsdev->cal.yscale = (yres << 8) / delta;
608         tsdev->cal.ytrans = - ((dev->absmin [ABS_Y] * tsdev->cal.yscale) >> 8);
609
610         strlcpy(tsdev->dev.bus_id, tsdev->name, sizeof(tsdev->dev.bus_id));
611         tsdev->dev.devt = MKDEV(INPUT_MAJOR, TSDEV_MINOR_BASE + minor);
612         tsdev->dev.class = &input_class;
613         tsdev->dev.parent = &dev->dev;
614         tsdev->dev.release = tsdev_free;
615         device_initialize(&tsdev->dev);
616
617         error = input_register_handle(&tsdev->handle);
618         if (error)
619                 goto err_free_tsdev;
620
621         error = tsdev_install_chrdev(tsdev);
622         if (error)
623                 goto err_unregister_handle;
624
625         error = device_add(&tsdev->dev);
626         if (error)
627                 goto err_cleanup_tsdev;
628
629         return 0;
630
631  err_cleanup_tsdev:
632         tsdev_cleanup(tsdev);
633  err_unregister_handle:
634         input_unregister_handle(&tsdev->handle);
635  err_free_tsdev:
636         put_device(&tsdev->dev);
637         return error;
638 }
639
640 static void tsdev_disconnect(struct input_handle *handle)
641 {
642         struct tsdev *tsdev = handle->private;
643
644         device_del(&tsdev->dev);
645         tsdev_cleanup(tsdev);
646         input_unregister_handle(handle);
647         put_device(&tsdev->dev);
648 }
649
650 static const struct input_device_id tsdev_ids[] = {
651         {
652               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_KEYBIT | INPUT_DEVICE_ID_MATCH_RELBIT,
653               .evbit    = { BIT(EV_KEY) | BIT(EV_REL) },
654               .keybit   = { [LONG(BTN_LEFT)] = BIT(BTN_LEFT) },
655               .relbit   = { BIT(REL_X) | BIT(REL_Y) },
656         }, /* A mouse like device, at least one button, two relative axes */
657
658         {
659               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_KEYBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
660               .evbit    = { BIT(EV_KEY) | BIT(EV_ABS) },
661               .keybit   = { [LONG(BTN_TOUCH)] = BIT(BTN_TOUCH) },
662               .absbit   = { BIT(ABS_X) | BIT(ABS_Y) },
663         }, /* A tablet like device, at least touch detection, two absolute axes */
664
665         {
666               .flags    = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
667               .evbit    = { BIT(EV_ABS) },
668               .absbit   = { BIT(ABS_X) | BIT(ABS_Y) | BIT(ABS_PRESSURE) },
669         }, /* A tablet like device with several gradations of pressure */
670
671         {} /* Terminating entry */
672 };
673
674 MODULE_DEVICE_TABLE(input, tsdev_ids);
675
676 static struct input_handler tsdev_handler = {
677         .event          = tsdev_event,
678         .connect        = tsdev_connect,
679         .disconnect     = tsdev_disconnect,
680         .fops           = &tsdev_fops,
681         .minor          = TSDEV_MINOR_BASE,
682         .name           = "tsdev",
683         .id_table       = tsdev_ids,
684 };
685
686 static int __init tsdev_init(void)
687 {
688         return input_register_handler(&tsdev_handler);
689 }
690
691 static void __exit tsdev_exit(void)
692 {
693         input_unregister_handler(&tsdev_handler);
694 }
695
696 module_init(tsdev_init);
697 module_exit(tsdev_exit);