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 pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #define EVDEV_MINOR_BASE 64
14 #define EVDEV_MINORS 32
15 #define EVDEV_MIN_BUFFER_SIZE 64U
16 #define EVDEV_BUF_PACKETS 8
18 #include <linux/poll.h>
19 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/input.h>
24 #include <linux/major.h>
25 #include <linux/device.h>
26 #include "input-compat.h"
31 struct input_handle handle;
32 wait_queue_head_t wait;
33 struct evdev_client __rcu *grab;
34 struct list_head client_list;
35 spinlock_t client_lock; /* protects client_list */
44 unsigned int packet_head; /* [future] position of the first element of next packet */
45 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
46 struct fasync_struct *fasync;
48 struct list_head node;
50 struct input_event buffer[];
53 static struct evdev *evdev_table[EVDEV_MINORS];
54 static DEFINE_MUTEX(evdev_table_mutex);
56 static void evdev_pass_event(struct evdev_client *client,
57 struct input_event *event)
59 /* Interrupts are disabled, just acquire the lock. */
60 spin_lock(&client->buffer_lock);
62 client->buffer[client->head++] = *event;
63 client->head &= client->bufsize - 1;
65 if (unlikely(client->head == client->tail)) {
67 * This effectively "drops" all unconsumed events, leaving
68 * EV_SYN/SYN_DROPPED plus the newest event in the queue.
70 client->tail = (client->head - 2) & (client->bufsize - 1);
72 client->buffer[client->tail].time = event->time;
73 client->buffer[client->tail].type = EV_SYN;
74 client->buffer[client->tail].code = SYN_DROPPED;
75 client->buffer[client->tail].value = 0;
77 client->packet_head = client->tail;
80 if (event->type == EV_SYN && event->code == SYN_REPORT) {
81 client->packet_head = client->head;
82 kill_fasync(&client->fasync, SIGIO, POLL_IN);
85 spin_unlock(&client->buffer_lock);
89 * Pass incoming event to all connected clients.
91 static void evdev_event(struct input_handle *handle,
92 unsigned int type, unsigned int code, int value)
94 struct evdev *evdev = handle->private;
95 struct evdev_client *client;
96 struct input_event event;
98 do_gettimeofday(&event.time);
105 client = rcu_dereference(evdev->grab);
107 evdev_pass_event(client, &event);
109 list_for_each_entry_rcu(client, &evdev->client_list, node)
110 evdev_pass_event(client, &event);
114 wake_up_interruptible(&evdev->wait);
117 static int evdev_fasync(int fd, struct file *file, int on)
119 struct evdev_client *client = file->private_data;
121 return fasync_helper(fd, file, on, &client->fasync);
124 static int evdev_flush(struct file *file, fl_owner_t id)
126 struct evdev_client *client = file->private_data;
127 struct evdev *evdev = client->evdev;
130 retval = mutex_lock_interruptible(&evdev->mutex);
137 retval = input_flush_device(&evdev->handle, file);
139 mutex_unlock(&evdev->mutex);
143 static void evdev_free(struct device *dev)
145 struct evdev *evdev = container_of(dev, struct evdev, dev);
147 input_put_device(evdev->handle.dev);
152 * Grabs an event device (along with underlying input device).
153 * This function is called with evdev->mutex taken.
155 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
162 error = input_grab_device(&evdev->handle);
166 rcu_assign_pointer(evdev->grab, client);
172 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
174 if (evdev->grab != client)
177 rcu_assign_pointer(evdev->grab, NULL);
179 input_release_device(&evdev->handle);
184 static void evdev_attach_client(struct evdev *evdev,
185 struct evdev_client *client)
187 spin_lock(&evdev->client_lock);
188 list_add_tail_rcu(&client->node, &evdev->client_list);
189 spin_unlock(&evdev->client_lock);
193 static void evdev_detach_client(struct evdev *evdev,
194 struct evdev_client *client)
196 spin_lock(&evdev->client_lock);
197 list_del_rcu(&client->node);
198 spin_unlock(&evdev->client_lock);
202 static int evdev_open_device(struct evdev *evdev)
206 retval = mutex_lock_interruptible(&evdev->mutex);
212 else if (!evdev->open++) {
213 retval = input_open_device(&evdev->handle);
218 mutex_unlock(&evdev->mutex);
222 static void evdev_close_device(struct evdev *evdev)
224 mutex_lock(&evdev->mutex);
226 if (evdev->exist && !--evdev->open)
227 input_close_device(&evdev->handle);
229 mutex_unlock(&evdev->mutex);
233 * Wake up users waiting for IO so they can disconnect from
236 static void evdev_hangup(struct evdev *evdev)
238 struct evdev_client *client;
240 spin_lock(&evdev->client_lock);
241 list_for_each_entry(client, &evdev->client_list, node)
242 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
243 spin_unlock(&evdev->client_lock);
245 wake_up_interruptible(&evdev->wait);
248 static int evdev_release(struct inode *inode, struct file *file)
250 struct evdev_client *client = file->private_data;
251 struct evdev *evdev = client->evdev;
253 mutex_lock(&evdev->mutex);
254 if (evdev->grab == client)
255 evdev_ungrab(evdev, client);
256 mutex_unlock(&evdev->mutex);
258 evdev_detach_client(evdev, client);
261 evdev_close_device(evdev);
262 put_device(&evdev->dev);
267 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
269 unsigned int n_events =
270 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
271 EVDEV_MIN_BUFFER_SIZE);
273 return roundup_pow_of_two(n_events);
276 static int evdev_open(struct inode *inode, struct file *file)
279 struct evdev_client *client;
280 int i = iminor(inode) - EVDEV_MINOR_BASE;
281 unsigned int bufsize;
284 if (i >= EVDEV_MINORS)
287 error = mutex_lock_interruptible(&evdev_table_mutex);
290 evdev = evdev_table[i];
292 get_device(&evdev->dev);
293 mutex_unlock(&evdev_table_mutex);
298 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
300 client = kzalloc(sizeof(struct evdev_client) +
301 bufsize * sizeof(struct input_event),
308 client->bufsize = bufsize;
309 spin_lock_init(&client->buffer_lock);
310 client->evdev = evdev;
311 evdev_attach_client(evdev, client);
313 error = evdev_open_device(evdev);
315 goto err_free_client;
317 file->private_data = client;
318 nonseekable_open(inode, file);
323 evdev_detach_client(evdev, client);
326 put_device(&evdev->dev);
330 static ssize_t evdev_write(struct file *file, const char __user *buffer,
331 size_t count, loff_t *ppos)
333 struct evdev_client *client = file->private_data;
334 struct evdev *evdev = client->evdev;
335 struct input_event event;
338 if (count < input_event_size())
341 retval = mutex_lock_interruptible(&evdev->mutex);
351 if (input_event_from_user(buffer + retval, &event)) {
355 retval += input_event_size();
357 input_inject_event(&evdev->handle,
358 event.type, event.code, event.value);
359 } while (retval + input_event_size() <= count);
362 mutex_unlock(&evdev->mutex);
366 static int evdev_fetch_next_event(struct evdev_client *client,
367 struct input_event *event)
371 spin_lock_irq(&client->buffer_lock);
373 have_event = client->head != client->tail;
375 *event = client->buffer[client->tail++];
376 client->tail &= client->bufsize - 1;
379 spin_unlock_irq(&client->buffer_lock);
384 static ssize_t evdev_read(struct file *file, char __user *buffer,
385 size_t count, loff_t *ppos)
387 struct evdev_client *client = file->private_data;
388 struct evdev *evdev = client->evdev;
389 struct input_event event;
392 if (count < input_event_size())
395 if (client->packet_head == client->tail && evdev->exist &&
396 (file->f_flags & O_NONBLOCK))
399 retval = wait_event_interruptible(evdev->wait,
400 client->packet_head != client->tail || !evdev->exist);
407 while (retval + input_event_size() <= count &&
408 evdev_fetch_next_event(client, &event)) {
410 if (input_event_to_user(buffer + retval, &event))
413 retval += input_event_size();
419 /* No kernel lock - fine */
420 static unsigned int evdev_poll(struct file *file, poll_table *wait)
422 struct evdev_client *client = file->private_data;
423 struct evdev *evdev = client->evdev;
426 poll_wait(file, &evdev->wait, wait);
428 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
429 if (client->packet_head != client->tail)
430 mask |= POLLIN | POLLRDNORM;
437 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
438 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
441 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
442 unsigned int maxlen, void __user *p, int compat)
447 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
451 for (i = 0; i < len / sizeof(compat_long_t); i++)
452 if (copy_to_user((compat_long_t __user *) p + i,
453 (compat_long_t *) bits +
454 i + 1 - ((i % 2) << 1),
455 sizeof(compat_long_t)))
458 len = BITS_TO_LONGS(maxbit) * sizeof(long);
462 if (copy_to_user(p, bits, len))
469 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
470 unsigned int maxlen, void __user *p, int compat)
473 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
474 BITS_TO_LONGS(maxbit) * sizeof(long);
479 return copy_to_user(p, bits, len) ? -EFAULT : len;
481 #endif /* __BIG_ENDIAN */
485 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
486 unsigned int maxlen, void __user *p, int compat)
488 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
493 return copy_to_user(p, bits, len) ? -EFAULT : len;
496 #endif /* CONFIG_COMPAT */
498 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
505 len = strlen(str) + 1;
509 return copy_to_user(p, str, len) ? -EFAULT : len;
512 #define OLD_KEY_MAX 0x1ff
513 static int handle_eviocgbit(struct input_dev *dev,
514 unsigned int type, unsigned int size,
515 void __user *p, int compat_mode)
517 static unsigned long keymax_warn_time;
523 case 0: bits = dev->evbit; len = EV_MAX; break;
524 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
525 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
526 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
527 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
528 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
529 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
530 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
531 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
532 default: return -EINVAL;
536 * Work around bugs in userspace programs that like to do
537 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
538 * should be in bytes, not in bits.
540 if (type == EV_KEY && size == OLD_KEY_MAX) {
542 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
543 pr_warning("(EVIOCGBIT): Suspicious buffer size %u, "
544 "limiting output to %zu bytes. See "
545 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
547 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
550 return bits_to_user(bits, len, size, p, compat_mode);
554 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
556 struct input_keymap_entry ke = {
557 .len = sizeof(unsigned int),
560 int __user *ip = (int __user *)p;
564 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
567 error = input_get_keycode(dev, &ke);
571 if (put_user(ke.keycode, ip + 1))
577 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
579 struct input_keymap_entry ke;
582 if (copy_from_user(&ke, p, sizeof(ke)))
585 error = input_get_keycode(dev, &ke);
589 if (copy_to_user(p, &ke, sizeof(ke)))
595 static int evdev_handle_set_keycode(struct input_dev *dev, void __user *p)
597 struct input_keymap_entry ke = {
598 .len = sizeof(unsigned int),
601 int __user *ip = (int __user *)p;
603 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
606 if (get_user(ke.keycode, ip + 1))
609 return input_set_keycode(dev, &ke);
612 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
614 struct input_keymap_entry ke;
616 if (copy_from_user(&ke, p, sizeof(ke)))
619 if (ke.len > sizeof(ke.scancode))
622 return input_set_keycode(dev, &ke);
625 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
626 void __user *p, int compat_mode)
628 struct evdev_client *client = file->private_data;
629 struct evdev *evdev = client->evdev;
630 struct input_dev *dev = evdev->handle.dev;
631 struct input_absinfo abs;
632 struct ff_effect effect;
633 int __user *ip = (int __user *)p;
634 unsigned int i, t, u, v;
638 /* First we check for fixed-length commands */
642 return put_user(EV_VERSION, ip);
645 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
650 if (!test_bit(EV_REP, dev->evbit))
652 if (put_user(dev->rep[REP_DELAY], ip))
654 if (put_user(dev->rep[REP_PERIOD], ip + 1))
659 if (!test_bit(EV_REP, dev->evbit))
663 if (get_user(v, ip + 1))
666 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
667 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
672 return input_ff_erase(dev, (int)(unsigned long) p, file);
675 i = test_bit(EV_FF, dev->evbit) ?
676 dev->ff->max_effects : 0;
683 return evdev_grab(evdev, client);
685 return evdev_ungrab(evdev, client);
688 return evdev_handle_get_keycode(dev, p);
691 return evdev_handle_set_keycode(dev, p);
693 case EVIOCGKEYCODE_V2:
694 return evdev_handle_get_keycode_v2(dev, p);
696 case EVIOCSKEYCODE_V2:
697 return evdev_handle_set_keycode_v2(dev, p);
700 size = _IOC_SIZE(cmd);
702 /* Now check variable-length commands */
703 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
704 switch (EVIOC_MASK_SIZE(cmd)) {
707 return bits_to_user(dev->propbit, INPUT_PROP_MAX,
708 size, p, compat_mode);
711 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
714 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
717 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
720 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
723 return str_to_user(dev->name, size, p);
726 return str_to_user(dev->phys, size, p);
729 return str_to_user(dev->uniq, size, p);
731 case EVIOC_MASK_SIZE(EVIOCSFF):
732 if (input_ff_effect_from_user(p, size, &effect))
735 error = input_ff_upload(dev, &effect, file);
737 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
743 /* Multi-number variable-length handlers */
744 if (_IOC_TYPE(cmd) != 'E')
747 if (_IOC_DIR(cmd) == _IOC_READ) {
749 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
750 return handle_eviocgbit(dev,
751 _IOC_NR(cmd) & EV_MAX, size,
754 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
759 t = _IOC_NR(cmd) & ABS_MAX;
760 abs = dev->absinfo[t];
762 if (copy_to_user(p, &abs, min_t(size_t,
763 size, sizeof(struct input_absinfo))))
770 if (_IOC_DIR(cmd) == _IOC_WRITE) {
772 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
777 t = _IOC_NR(cmd) & ABS_MAX;
779 if (copy_from_user(&abs, p, min_t(size_t,
780 size, sizeof(struct input_absinfo))))
783 if (size < sizeof(struct input_absinfo))
786 /* We can't change number of reserved MT slots */
787 if (t == ABS_MT_SLOT)
791 * Take event lock to ensure that we are not
792 * changing device parameters in the middle
795 spin_lock_irq(&dev->event_lock);
796 dev->absinfo[t] = abs;
797 spin_unlock_irq(&dev->event_lock);
806 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
807 void __user *p, int compat_mode)
809 struct evdev_client *client = file->private_data;
810 struct evdev *evdev = client->evdev;
813 retval = mutex_lock_interruptible(&evdev->mutex);
822 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
825 mutex_unlock(&evdev->mutex);
829 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
831 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
835 static long evdev_ioctl_compat(struct file *file,
836 unsigned int cmd, unsigned long arg)
838 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
842 static const struct file_operations evdev_fops = {
843 .owner = THIS_MODULE,
845 .write = evdev_write,
848 .release = evdev_release,
849 .unlocked_ioctl = evdev_ioctl,
851 .compat_ioctl = evdev_ioctl_compat,
853 .fasync = evdev_fasync,
854 .flush = evdev_flush,
858 static int evdev_install_chrdev(struct evdev *evdev)
861 * No need to do any locking here as calls to connect and
862 * disconnect are serialized by the input core
864 evdev_table[evdev->minor] = evdev;
868 static void evdev_remove_chrdev(struct evdev *evdev)
871 * Lock evdev table to prevent race with evdev_open()
873 mutex_lock(&evdev_table_mutex);
874 evdev_table[evdev->minor] = NULL;
875 mutex_unlock(&evdev_table_mutex);
879 * Mark device non-existent. This disables writes, ioctls and
880 * prevents new users from opening the device. Already posted
881 * blocking reads will stay, however new ones will fail.
883 static void evdev_mark_dead(struct evdev *evdev)
885 mutex_lock(&evdev->mutex);
886 evdev->exist = false;
887 mutex_unlock(&evdev->mutex);
890 static void evdev_cleanup(struct evdev *evdev)
892 struct input_handle *handle = &evdev->handle;
894 evdev_mark_dead(evdev);
896 evdev_remove_chrdev(evdev);
898 /* evdev is marked dead so no one else accesses evdev->open */
900 input_flush_device(handle, NULL);
901 input_close_device(handle);
906 * Create new evdev device. Note that input core serializes calls
907 * to connect and disconnect so we don't need to lock evdev_table here.
909 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
910 const struct input_device_id *id)
916 for (minor = 0; minor < EVDEV_MINORS; minor++)
917 if (!evdev_table[minor])
920 if (minor == EVDEV_MINORS) {
921 pr_err("no more free evdev devices\n");
925 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
929 INIT_LIST_HEAD(&evdev->client_list);
930 spin_lock_init(&evdev->client_lock);
931 mutex_init(&evdev->mutex);
932 init_waitqueue_head(&evdev->wait);
934 dev_set_name(&evdev->dev, "event%d", minor);
936 evdev->minor = minor;
938 evdev->handle.dev = input_get_device(dev);
939 evdev->handle.name = dev_name(&evdev->dev);
940 evdev->handle.handler = handler;
941 evdev->handle.private = evdev;
943 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
944 evdev->dev.class = &input_class;
945 evdev->dev.parent = &dev->dev;
946 evdev->dev.release = evdev_free;
947 device_initialize(&evdev->dev);
949 error = input_register_handle(&evdev->handle);
953 error = evdev_install_chrdev(evdev);
955 goto err_unregister_handle;
957 error = device_add(&evdev->dev);
959 goto err_cleanup_evdev;
964 evdev_cleanup(evdev);
965 err_unregister_handle:
966 input_unregister_handle(&evdev->handle);
968 put_device(&evdev->dev);
972 static void evdev_disconnect(struct input_handle *handle)
974 struct evdev *evdev = handle->private;
976 device_del(&evdev->dev);
977 evdev_cleanup(evdev);
978 input_unregister_handle(handle);
979 put_device(&evdev->dev);
982 static const struct input_device_id evdev_ids[] = {
983 { .driver_info = 1 }, /* Matches all devices */
984 { }, /* Terminating zero entry */
987 MODULE_DEVICE_TABLE(input, evdev_ids);
989 static struct input_handler evdev_handler = {
990 .event = evdev_event,
991 .connect = evdev_connect,
992 .disconnect = evdev_disconnect,
994 .minor = EVDEV_MINOR_BASE,
996 .id_table = evdev_ids,
999 static int __init evdev_init(void)
1001 return input_register_handler(&evdev_handler);
1004 static void __exit evdev_exit(void)
1006 input_unregister_handler(&evdev_handler);
1009 module_init(evdev_init);
1010 module_exit(evdev_exit);
1012 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
1013 MODULE_DESCRIPTION("Input driver event char devices");
1014 MODULE_LICENSE("GPL");