2 * Event char devices, giving access to raw input device events.
4 * Copyright (c) 1999-2002 Vojtech Pavlik
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
11 #define EVDEV_MINOR_BASE 64
12 #define EVDEV_MINORS 32
13 #define EVDEV_MIN_BUFFER_SIZE 64U
14 #define EVDEV_BUF_PACKETS 8
16 #include <linux/poll.h>
17 #include <linux/sched.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/input.h>
22 #include <linux/major.h>
23 #include <linux/device.h>
24 #include "input-compat.h"
26 #ifdef CONFIG_SEC_DEBUG_KERNEL_HISTORY
27 #include <plat/debug-kernel-history.h> /* YUBAEK 20110905 RAMDUMP_DEBUG : added debug-kernel-history.h */
28 #endif /* CONFIG_SEC_DEBUG_KERNEL_HISTORY */
33 struct input_handle handle;
34 wait_queue_head_t wait;
35 struct evdev_client *grab;
36 struct list_head client_list;
37 spinlock_t client_lock; /* protects client_list */
46 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
47 struct fasync_struct *fasync;
49 struct list_head node;
51 struct input_event buffer[];
54 static struct evdev *evdev_table[EVDEV_MINORS];
55 static DEFINE_MUTEX(evdev_table_mutex);
57 static void evdev_pass_event(struct evdev_client *client,
58 struct input_event *event)
61 * Interrupts are disabled, just acquire the lock.
62 * Make sure we don't leave with the client buffer
63 * "empty" by having client->head == client->tail.
65 spin_lock(&client->buffer_lock);
67 client->buffer[client->head++] = *event;
68 client->head &= client->bufsize - 1;
69 } while (client->head == client->tail);
70 spin_unlock(&client->buffer_lock);
72 if (event->type == EV_SYN)
73 kill_fasync(&client->fasync, SIGIO, POLL_IN);
77 * Pass incoming event to all connected clients.
79 static void evdev_event(struct input_handle *handle,
80 unsigned int type, unsigned int code, int value)
82 struct evdev *evdev = handle->private;
83 struct evdev_client *client;
84 struct input_event event;
86 do_gettimeofday(&event.time);
93 client = rcu_dereference(evdev->grab);
95 evdev_pass_event(client, &event);
97 list_for_each_entry_rcu(client, &evdev->client_list, node)
98 evdev_pass_event(client, &event);
102 wake_up_interruptible(&evdev->wait);
105 static int evdev_fasync(int fd, struct file *file, int on)
107 struct evdev_client *client = file->private_data;
109 return fasync_helper(fd, file, on, &client->fasync);
112 static int evdev_flush(struct file *file, fl_owner_t id)
114 struct evdev_client *client = file->private_data;
115 struct evdev *evdev = client->evdev;
118 retval = mutex_lock_interruptible(&evdev->mutex);
125 retval = input_flush_device(&evdev->handle, file);
127 mutex_unlock(&evdev->mutex);
131 static void evdev_free(struct device *dev)
133 struct evdev *evdev = container_of(dev, struct evdev, dev);
135 input_put_device(evdev->handle.dev);
140 * Grabs an event device (along with underlying input device).
141 * This function is called with evdev->mutex taken.
143 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
150 error = input_grab_device(&evdev->handle);
154 rcu_assign_pointer(evdev->grab, client);
160 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
162 if (evdev->grab != client)
165 rcu_assign_pointer(evdev->grab, NULL);
167 input_release_device(&evdev->handle);
172 static void evdev_attach_client(struct evdev *evdev,
173 struct evdev_client *client)
175 spin_lock(&evdev->client_lock);
176 list_add_tail_rcu(&client->node, &evdev->client_list);
177 spin_unlock(&evdev->client_lock);
181 static void evdev_detach_client(struct evdev *evdev,
182 struct evdev_client *client)
184 spin_lock(&evdev->client_lock);
185 list_del_rcu(&client->node);
186 spin_unlock(&evdev->client_lock);
190 static int evdev_open_device(struct evdev *evdev)
194 retval = mutex_lock_interruptible(&evdev->mutex);
200 else if (!evdev->open++) {
201 retval = input_open_device(&evdev->handle);
206 mutex_unlock(&evdev->mutex);
210 static void evdev_close_device(struct evdev *evdev)
212 mutex_lock(&evdev->mutex);
214 if (evdev->exist && !--evdev->open)
215 input_close_device(&evdev->handle);
217 mutex_unlock(&evdev->mutex);
221 * Wake up users waiting for IO so they can disconnect from
224 static void evdev_hangup(struct evdev *evdev)
226 struct evdev_client *client;
228 spin_lock(&evdev->client_lock);
229 list_for_each_entry(client, &evdev->client_list, node)
230 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
231 spin_unlock(&evdev->client_lock);
233 wake_up_interruptible(&evdev->wait);
236 static int evdev_release(struct inode *inode, struct file *file)
238 struct evdev_client *client = file->private_data;
239 struct evdev *evdev = client->evdev;
241 mutex_lock(&evdev->mutex);
242 if (evdev->grab == client)
243 evdev_ungrab(evdev, client);
244 mutex_unlock(&evdev->mutex);
246 evdev_detach_client(evdev, client);
249 evdev_close_device(evdev);
250 put_device(&evdev->dev);
255 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
257 unsigned int n_events =
258 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
259 EVDEV_MIN_BUFFER_SIZE);
261 return roundup_pow_of_two(n_events);
264 static int evdev_open(struct inode *inode, struct file *file)
267 struct evdev_client *client;
268 int i = iminor(inode) - EVDEV_MINOR_BASE;
269 unsigned int bufsize;
272 if (i >= EVDEV_MINORS)
275 error = mutex_lock_interruptible(&evdev_table_mutex);
278 evdev = evdev_table[i];
280 get_device(&evdev->dev);
281 mutex_unlock(&evdev_table_mutex);
286 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
288 client = kzalloc(sizeof(struct evdev_client) +
289 bufsize * sizeof(struct input_event),
296 client->bufsize = bufsize;
297 spin_lock_init(&client->buffer_lock);
298 client->evdev = evdev;
299 evdev_attach_client(evdev, client);
301 error = evdev_open_device(evdev);
303 goto err_free_client;
305 file->private_data = client;
306 nonseekable_open(inode, file);
311 evdev_detach_client(evdev, client);
314 put_device(&evdev->dev);
318 static ssize_t evdev_write(struct file *file, const char __user *buffer,
319 size_t count, loff_t *ppos)
321 struct evdev_client *client = file->private_data;
322 struct evdev *evdev = client->evdev;
323 struct input_event event;
326 retval = mutex_lock_interruptible(&evdev->mutex);
335 while (retval < count) {
337 if (input_event_from_user(buffer + retval, &event)) {
342 input_inject_event(&evdev->handle,
343 event.type, event.code, event.value);
344 retval += input_event_size();
348 mutex_unlock(&evdev->mutex);
352 static int evdev_fetch_next_event(struct evdev_client *client,
353 struct input_event *event)
357 spin_lock_irq(&client->buffer_lock);
359 have_event = client->head != client->tail;
361 *event = client->buffer[client->tail++];
362 client->tail &= client->bufsize - 1;
365 spin_unlock_irq(&client->buffer_lock);
370 static ssize_t evdev_read(struct file *file, char __user *buffer,
371 size_t count, loff_t *ppos)
373 struct evdev_client *client = file->private_data;
374 struct evdev *evdev = client->evdev;
375 struct input_event event;
378 if (count < input_event_size())
381 if (client->head == client->tail && evdev->exist &&
382 (file->f_flags & O_NONBLOCK))
385 retval = wait_event_interruptible(evdev->wait,
386 client->head != client->tail || !evdev->exist);
393 while (retval + input_event_size() <= count &&
394 evdev_fetch_next_event(client, &event)) {
396 if (input_event_to_user(buffer + retval, &event))
398 /* YUBAEK 20110905 RAMDUMP_DEBUG : added slp_kernel_debug_evdev ++ */
399 #ifdef CONFIG_SEC_DEBUG_KERNEL_HISTORY
400 slp_kernel_debug_evdev(&event);
401 #endif /* CONFIG_SEC_DEBUG_KERNEL_HISTORY */
402 /* YUBAEK 20110905 RAMDUMP_DEBUG : added slp_kernel_debug_evdev ++ */
403 retval += input_event_size();
409 /* No kernel lock - fine */
410 static unsigned int evdev_poll(struct file *file, poll_table *wait)
412 struct evdev_client *client = file->private_data;
413 struct evdev *evdev = client->evdev;
416 poll_wait(file, &evdev->wait, wait);
418 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
419 if (client->head != client->tail)
420 mask |= POLLIN | POLLRDNORM;
427 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
428 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
431 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
432 unsigned int maxlen, void __user *p, int compat)
437 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
441 for (i = 0; i < len / sizeof(compat_long_t); i++)
442 if (copy_to_user((compat_long_t __user *) p + i,
443 (compat_long_t *) bits +
444 i + 1 - ((i % 2) << 1),
445 sizeof(compat_long_t)))
448 len = BITS_TO_LONGS(maxbit) * sizeof(long);
452 if (copy_to_user(p, bits, len))
459 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
460 unsigned int maxlen, void __user *p, int compat)
463 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
464 BITS_TO_LONGS(maxbit) * sizeof(long);
469 return copy_to_user(p, bits, len) ? -EFAULT : len;
471 #endif /* __BIG_ENDIAN */
475 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
476 unsigned int maxlen, void __user *p, int compat)
478 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
483 return copy_to_user(p, bits, len) ? -EFAULT : len;
486 #endif /* CONFIG_COMPAT */
488 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
495 len = strlen(str) + 1;
499 return copy_to_user(p, str, len) ? -EFAULT : len;
502 #define OLD_KEY_MAX 0x1ff
503 static int handle_eviocgbit(struct input_dev *dev,
504 unsigned int type, unsigned int size,
505 void __user *p, int compat_mode)
507 static unsigned long keymax_warn_time;
513 case 0: bits = dev->evbit; len = EV_MAX; break;
514 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
515 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
516 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
517 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
518 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
519 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
520 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
521 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
522 default: return -EINVAL;
526 * Work around bugs in userspace programs that like to do
527 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
528 * should be in bytes, not in bits.
530 if (type == EV_KEY && size == OLD_KEY_MAX) {
532 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
534 "evdev.c(EVIOCGBIT): Suspicious buffer size %u, "
535 "limiting output to %zu bytes. See "
536 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
538 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
541 return bits_to_user(bits, len, size, p, compat_mode);
545 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
546 void __user *p, int compat_mode)
548 struct evdev_client *client = file->private_data;
549 struct evdev *evdev = client->evdev;
550 struct input_dev *dev = evdev->handle.dev;
551 struct input_absinfo abs;
552 struct ff_effect effect;
553 int __user *ip = (int __user *)p;
554 unsigned int i, t, u, v;
558 /* First we check for fixed-length commands */
562 return put_user(EV_VERSION, ip);
565 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
570 if (!test_bit(EV_REP, dev->evbit))
572 if (put_user(dev->rep[REP_DELAY], ip))
574 if (put_user(dev->rep[REP_PERIOD], ip + 1))
579 if (!test_bit(EV_REP, dev->evbit))
583 if (get_user(v, ip + 1))
586 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
587 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
595 error = input_get_keycode(dev, t, &v);
599 if (put_user(v, ip + 1))
605 if (get_user(t, ip) || get_user(v, ip + 1))
608 return input_set_keycode(dev, t, v);
611 return input_ff_erase(dev, (int)(unsigned long) p, file);
614 i = test_bit(EV_FF, dev->evbit) ?
615 dev->ff->max_effects : 0;
622 return evdev_grab(evdev, client);
624 return evdev_ungrab(evdev, client);
627 size = _IOC_SIZE(cmd);
629 /* Now check variable-length commands */
630 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
632 switch (EVIOC_MASK_SIZE(cmd)) {
635 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
638 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
641 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
644 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
647 return str_to_user(dev->name, size, p);
650 return str_to_user(dev->phys, size, p);
653 return str_to_user(dev->uniq, size, p);
655 case EVIOC_MASK_SIZE(EVIOCSFF):
656 if (input_ff_effect_from_user(p, size, &effect))
659 error = input_ff_upload(dev, &effect, file);
661 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
667 /* Multi-number variable-length handlers */
668 if (_IOC_TYPE(cmd) != 'E')
671 if (_IOC_DIR(cmd) == _IOC_READ) {
673 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
674 return handle_eviocgbit(dev,
675 _IOC_NR(cmd) & EV_MAX, size,
678 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
683 t = _IOC_NR(cmd) & ABS_MAX;
684 abs = dev->absinfo[t];
686 if (copy_to_user(p, &abs, min_t(size_t,
687 size, sizeof(struct input_absinfo))))
694 if (_IOC_DIR(cmd) == _IOC_WRITE) {
696 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
701 t = _IOC_NR(cmd) & ABS_MAX;
703 if (copy_from_user(&abs, p, min_t(size_t,
704 size, sizeof(struct input_absinfo))))
707 if (size < sizeof(struct input_absinfo))
710 /* We can't change number of reserved MT slots */
711 if (t == ABS_MT_SLOT)
715 * Take event lock to ensure that we are not
716 * changing device parameters in the middle
719 spin_lock_irq(&dev->event_lock);
720 dev->absinfo[t] = abs;
721 spin_unlock_irq(&dev->event_lock);
730 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
731 void __user *p, int compat_mode)
733 struct evdev_client *client = file->private_data;
734 struct evdev *evdev = client->evdev;
737 retval = mutex_lock_interruptible(&evdev->mutex);
746 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
749 mutex_unlock(&evdev->mutex);
753 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
755 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
759 static long evdev_ioctl_compat(struct file *file,
760 unsigned int cmd, unsigned long arg)
762 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
766 static const struct file_operations evdev_fops = {
767 .owner = THIS_MODULE,
769 .write = evdev_write,
772 .release = evdev_release,
773 .unlocked_ioctl = evdev_ioctl,
775 .compat_ioctl = evdev_ioctl_compat,
777 .fasync = evdev_fasync,
781 static int evdev_install_chrdev(struct evdev *evdev)
784 * No need to do any locking here as calls to connect and
785 * disconnect are serialized by the input core
787 evdev_table[evdev->minor] = evdev;
791 static void evdev_remove_chrdev(struct evdev *evdev)
794 * Lock evdev table to prevent race with evdev_open()
796 mutex_lock(&evdev_table_mutex);
797 evdev_table[evdev->minor] = NULL;
798 mutex_unlock(&evdev_table_mutex);
802 * Mark device non-existent. This disables writes, ioctls and
803 * prevents new users from opening the device. Already posted
804 * blocking reads will stay, however new ones will fail.
806 static void evdev_mark_dead(struct evdev *evdev)
808 mutex_lock(&evdev->mutex);
809 evdev->exist = false;
810 mutex_unlock(&evdev->mutex);
813 static void evdev_cleanup(struct evdev *evdev)
815 struct input_handle *handle = &evdev->handle;
817 evdev_mark_dead(evdev);
819 evdev_remove_chrdev(evdev);
821 /* evdev is marked dead so no one else accesses evdev->open */
823 input_flush_device(handle, NULL);
824 input_close_device(handle);
829 * Create new evdev device. Note that input core serializes calls
830 * to connect and disconnect so we don't need to lock evdev_table here.
832 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
833 const struct input_device_id *id)
839 for (minor = 0; minor < EVDEV_MINORS; minor++)
840 if (!evdev_table[minor])
843 if (minor == EVDEV_MINORS) {
844 printk(KERN_ERR "evdev: no more free evdev devices\n");
848 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
852 INIT_LIST_HEAD(&evdev->client_list);
853 spin_lock_init(&evdev->client_lock);
854 mutex_init(&evdev->mutex);
855 init_waitqueue_head(&evdev->wait);
857 dev_set_name(&evdev->dev, "event%d", minor);
859 evdev->minor = minor;
861 evdev->handle.dev = input_get_device(dev);
862 evdev->handle.name = dev_name(&evdev->dev);
863 evdev->handle.handler = handler;
864 evdev->handle.private = evdev;
866 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
867 evdev->dev.class = &input_class;
868 evdev->dev.parent = &dev->dev;
869 evdev->dev.release = evdev_free;
870 device_initialize(&evdev->dev);
872 error = input_register_handle(&evdev->handle);
876 error = evdev_install_chrdev(evdev);
878 goto err_unregister_handle;
880 error = device_add(&evdev->dev);
882 goto err_cleanup_evdev;
887 evdev_cleanup(evdev);
888 err_unregister_handle:
889 input_unregister_handle(&evdev->handle);
891 put_device(&evdev->dev);
895 static void evdev_disconnect(struct input_handle *handle)
897 struct evdev *evdev = handle->private;
899 device_del(&evdev->dev);
900 evdev_cleanup(evdev);
901 input_unregister_handle(handle);
902 put_device(&evdev->dev);
905 static const struct input_device_id evdev_ids[] = {
906 { .driver_info = 1 }, /* Matches all devices */
907 { }, /* Terminating zero entry */
910 MODULE_DEVICE_TABLE(input, evdev_ids);
912 static struct input_handler evdev_handler = {
913 .event = evdev_event,
914 .connect = evdev_connect,
915 .disconnect = evdev_disconnect,
917 .minor = EVDEV_MINOR_BASE,
919 .id_table = evdev_ids,
922 static int __init evdev_init(void)
924 return input_register_handler(&evdev_handler);
927 static void __exit evdev_exit(void)
929 input_unregister_handler(&evdev_handler);
932 module_init(evdev_init);
933 module_exit(evdev_exit);
935 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
936 MODULE_DESCRIPTION("Input driver event char devices");
937 MODULE_LICENSE("GPL");