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/mt.h>
24 #include <linux/major.h>
25 #include <linux/device.h>
26 #include <linux/cdev.h>
27 #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 */
45 unsigned int packet_head; /* [future] position of the first element of next packet */
46 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
47 struct fasync_struct *fasync;
49 struct list_head node;
52 struct input_event buffer[];
55 static void __pass_event(struct evdev_client *client,
56 const struct input_event *event)
58 client->buffer[client->head++] = *event;
59 client->head &= client->bufsize - 1;
61 if (unlikely(client->head == client->tail)) {
63 * This effectively "drops" all unconsumed events, leaving
64 * EV_SYN/SYN_DROPPED plus the newest event in the queue.
66 client->tail = (client->head - 2) & (client->bufsize - 1);
68 client->buffer[client->tail].time = event->time;
69 client->buffer[client->tail].type = EV_SYN;
70 client->buffer[client->tail].code = SYN_DROPPED;
71 client->buffer[client->tail].value = 0;
73 client->packet_head = client->tail;
76 if (event->type == EV_SYN && event->code == SYN_REPORT) {
77 client->packet_head = client->head;
78 kill_fasync(&client->fasync, SIGIO, POLL_IN);
82 static void evdev_pass_values(struct evdev_client *client,
83 const struct input_value *vals, unsigned int count,
84 ktime_t mono, ktime_t real)
86 struct evdev *evdev = client->evdev;
87 const struct input_value *v;
88 struct input_event event;
91 event.time = ktime_to_timeval(client->clkid == CLOCK_MONOTONIC ?
94 /* Interrupts are disabled, just acquire the lock. */
95 spin_lock(&client->buffer_lock);
97 for (v = vals; v != vals + count; v++) {
100 event.value = v->value;
101 __pass_event(client, &event);
102 if (v->type == EV_SYN && v->code == SYN_REPORT)
106 spin_unlock(&client->buffer_lock);
109 wake_up_interruptible(&evdev->wait);
113 * Pass incoming events to all connected clients.
115 static void evdev_events(struct input_handle *handle,
116 const struct input_value *vals, unsigned int count)
118 struct evdev *evdev = handle->private;
119 struct evdev_client *client;
120 ktime_t time_mono, time_real;
122 time_mono = ktime_get();
123 time_real = ktime_sub(time_mono, ktime_get_monotonic_offset());
127 client = rcu_dereference(evdev->grab);
130 evdev_pass_values(client, vals, count, time_mono, time_real);
132 list_for_each_entry_rcu(client, &evdev->client_list, node)
133 evdev_pass_values(client, vals, count,
134 time_mono, time_real);
140 * Pass incoming event to all connected clients.
142 static void evdev_event(struct input_handle *handle,
143 unsigned int type, unsigned int code, int value)
145 struct input_value vals[] = { { type, code, value } };
147 evdev_events(handle, vals, 1);
150 static int evdev_fasync(int fd, struct file *file, int on)
152 struct evdev_client *client = file->private_data;
154 return fasync_helper(fd, file, on, &client->fasync);
157 static int evdev_flush(struct file *file, fl_owner_t id)
159 struct evdev_client *client = file->private_data;
160 struct evdev *evdev = client->evdev;
163 retval = mutex_lock_interruptible(&evdev->mutex);
170 retval = input_flush_device(&evdev->handle, file);
172 mutex_unlock(&evdev->mutex);
176 static void evdev_free(struct device *dev)
178 struct evdev *evdev = container_of(dev, struct evdev, dev);
180 input_put_device(evdev->handle.dev);
185 * Grabs an event device (along with underlying input device).
186 * This function is called with evdev->mutex taken.
188 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
195 error = input_grab_device(&evdev->handle);
199 rcu_assign_pointer(evdev->grab, client);
204 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
206 struct evdev_client *grab = rcu_dereference_protected(evdev->grab,
207 lockdep_is_held(&evdev->mutex));
212 rcu_assign_pointer(evdev->grab, NULL);
214 input_release_device(&evdev->handle);
219 static void evdev_attach_client(struct evdev *evdev,
220 struct evdev_client *client)
222 spin_lock(&evdev->client_lock);
223 list_add_tail_rcu(&client->node, &evdev->client_list);
224 spin_unlock(&evdev->client_lock);
227 static void evdev_detach_client(struct evdev *evdev,
228 struct evdev_client *client)
230 spin_lock(&evdev->client_lock);
231 list_del_rcu(&client->node);
232 spin_unlock(&evdev->client_lock);
236 static int evdev_open_device(struct evdev *evdev)
240 retval = mutex_lock_interruptible(&evdev->mutex);
246 else if (!evdev->open++) {
247 retval = input_open_device(&evdev->handle);
252 mutex_unlock(&evdev->mutex);
256 static void evdev_close_device(struct evdev *evdev)
258 mutex_lock(&evdev->mutex);
260 if (evdev->exist && !--evdev->open)
261 input_close_device(&evdev->handle);
263 mutex_unlock(&evdev->mutex);
267 * Wake up users waiting for IO so they can disconnect from
270 static void evdev_hangup(struct evdev *evdev)
272 struct evdev_client *client;
274 spin_lock(&evdev->client_lock);
275 list_for_each_entry(client, &evdev->client_list, node)
276 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
277 spin_unlock(&evdev->client_lock);
279 wake_up_interruptible(&evdev->wait);
282 static int evdev_release(struct inode *inode, struct file *file)
284 struct evdev_client *client = file->private_data;
285 struct evdev *evdev = client->evdev;
287 mutex_lock(&evdev->mutex);
288 evdev_ungrab(evdev, client);
289 mutex_unlock(&evdev->mutex);
291 evdev_detach_client(evdev, client);
294 evdev_close_device(evdev);
299 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
301 unsigned int n_events =
302 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
303 EVDEV_MIN_BUFFER_SIZE);
305 return roundup_pow_of_two(n_events);
308 static int evdev_open(struct inode *inode, struct file *file)
310 struct evdev *evdev = container_of(inode->i_cdev, struct evdev, cdev);
311 unsigned int bufsize = evdev_compute_buffer_size(evdev->handle.dev);
312 struct evdev_client *client;
315 client = kzalloc(sizeof(struct evdev_client) +
316 bufsize * sizeof(struct input_event),
321 client->bufsize = bufsize;
322 spin_lock_init(&client->buffer_lock);
323 client->evdev = evdev;
324 evdev_attach_client(evdev, client);
326 error = evdev_open_device(evdev);
328 goto err_free_client;
330 file->private_data = client;
331 nonseekable_open(inode, file);
336 evdev_detach_client(evdev, client);
341 static ssize_t evdev_write(struct file *file, const char __user *buffer,
342 size_t count, loff_t *ppos)
344 struct evdev_client *client = file->private_data;
345 struct evdev *evdev = client->evdev;
346 struct input_event event;
349 if (count != 0 && count < input_event_size())
352 retval = mutex_lock_interruptible(&evdev->mutex);
361 while (retval + input_event_size() <= count) {
363 if (input_event_from_user(buffer + retval, &event)) {
367 retval += input_event_size();
369 input_inject_event(&evdev->handle,
370 event.type, event.code, event.value);
374 mutex_unlock(&evdev->mutex);
378 static int evdev_fetch_next_event(struct evdev_client *client,
379 struct input_event *event)
383 spin_lock_irq(&client->buffer_lock);
385 have_event = client->packet_head != client->tail;
387 *event = client->buffer[client->tail++];
388 client->tail &= client->bufsize - 1;
391 spin_unlock_irq(&client->buffer_lock);
396 static ssize_t evdev_read(struct file *file, char __user *buffer,
397 size_t count, loff_t *ppos)
399 struct evdev_client *client = file->private_data;
400 struct evdev *evdev = client->evdev;
401 struct input_event event;
405 if (count != 0 && count < input_event_size())
412 if (client->packet_head == client->tail &&
413 (file->f_flags & O_NONBLOCK))
417 * count == 0 is special - no IO is done but we check
418 * for error conditions (see above).
423 while (read + input_event_size() <= count &&
424 evdev_fetch_next_event(client, &event)) {
426 if (input_event_to_user(buffer + read, &event))
429 read += input_event_size();
435 if (!(file->f_flags & O_NONBLOCK)) {
436 error = wait_event_interruptible(evdev->wait,
437 client->packet_head != client->tail ||
447 /* No kernel lock - fine */
448 static unsigned int evdev_poll(struct file *file, poll_table *wait)
450 struct evdev_client *client = file->private_data;
451 struct evdev *evdev = client->evdev;
454 poll_wait(file, &evdev->wait, wait);
456 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
457 if (client->packet_head != client->tail)
458 mask |= POLLIN | POLLRDNORM;
465 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
466 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
469 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
470 unsigned int maxlen, void __user *p, int compat)
475 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
479 for (i = 0; i < len / sizeof(compat_long_t); i++)
480 if (copy_to_user((compat_long_t __user *) p + i,
481 (compat_long_t *) bits +
482 i + 1 - ((i % 2) << 1),
483 sizeof(compat_long_t)))
486 len = BITS_TO_LONGS(maxbit) * sizeof(long);
490 if (copy_to_user(p, bits, len))
497 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
498 unsigned int maxlen, void __user *p, int compat)
501 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
502 BITS_TO_LONGS(maxbit) * sizeof(long);
507 return copy_to_user(p, bits, len) ? -EFAULT : len;
509 #endif /* __BIG_ENDIAN */
513 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
514 unsigned int maxlen, void __user *p, int compat)
516 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
521 return copy_to_user(p, bits, len) ? -EFAULT : len;
524 #endif /* CONFIG_COMPAT */
526 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
533 len = strlen(str) + 1;
537 return copy_to_user(p, str, len) ? -EFAULT : len;
540 #define OLD_KEY_MAX 0x1ff
541 static int handle_eviocgbit(struct input_dev *dev,
542 unsigned int type, unsigned int size,
543 void __user *p, int compat_mode)
545 static unsigned long keymax_warn_time;
551 case 0: bits = dev->evbit; len = EV_MAX; break;
552 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
553 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
554 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
555 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
556 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
557 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
558 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
559 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
560 default: return -EINVAL;
564 * Work around bugs in userspace programs that like to do
565 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
566 * should be in bytes, not in bits.
568 if (type == EV_KEY && size == OLD_KEY_MAX) {
570 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
571 pr_warning("(EVIOCGBIT): Suspicious buffer size %u, "
572 "limiting output to %zu bytes. See "
573 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
575 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
578 return bits_to_user(bits, len, size, p, compat_mode);
582 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
584 struct input_keymap_entry ke = {
585 .len = sizeof(unsigned int),
588 int __user *ip = (int __user *)p;
592 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
595 error = input_get_keycode(dev, &ke);
599 if (put_user(ke.keycode, ip + 1))
605 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
607 struct input_keymap_entry ke;
610 if (copy_from_user(&ke, p, sizeof(ke)))
613 error = input_get_keycode(dev, &ke);
617 if (copy_to_user(p, &ke, sizeof(ke)))
623 static int evdev_handle_set_keycode(struct input_dev *dev, void __user *p)
625 struct input_keymap_entry ke = {
626 .len = sizeof(unsigned int),
629 int __user *ip = (int __user *)p;
631 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
634 if (get_user(ke.keycode, ip + 1))
637 return input_set_keycode(dev, &ke);
640 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
642 struct input_keymap_entry ke;
644 if (copy_from_user(&ke, p, sizeof(ke)))
647 if (ke.len > sizeof(ke.scancode))
650 return input_set_keycode(dev, &ke);
653 static int evdev_handle_mt_request(struct input_dev *dev,
657 const struct input_mt *mt = dev->mt;
662 if (get_user(code, &ip[0]))
664 if (!mt || !input_is_mt_value(code))
667 max_slots = (size - sizeof(__u32)) / sizeof(__s32);
668 for (i = 0; i < mt->num_slots && i < max_slots; i++) {
669 int value = input_mt_get_value(&mt->slots[i], code);
670 if (put_user(value, &ip[1 + i]))
677 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
678 void __user *p, int compat_mode)
680 struct evdev_client *client = file->private_data;
681 struct evdev *evdev = client->evdev;
682 struct input_dev *dev = evdev->handle.dev;
683 struct input_absinfo abs;
684 struct ff_effect effect;
685 int __user *ip = (int __user *)p;
686 unsigned int i, t, u, v;
690 /* First we check for fixed-length commands */
694 return put_user(EV_VERSION, ip);
697 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
702 if (!test_bit(EV_REP, dev->evbit))
704 if (put_user(dev->rep[REP_DELAY], ip))
706 if (put_user(dev->rep[REP_PERIOD], ip + 1))
711 if (!test_bit(EV_REP, dev->evbit))
715 if (get_user(v, ip + 1))
718 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
719 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
724 return input_ff_erase(dev, (int)(unsigned long) p, file);
727 i = test_bit(EV_FF, dev->evbit) ?
728 dev->ff->max_effects : 0;
735 return evdev_grab(evdev, client);
737 return evdev_ungrab(evdev, client);
740 if (copy_from_user(&i, p, sizeof(unsigned int)))
742 if (i != CLOCK_MONOTONIC && i != CLOCK_REALTIME)
748 return evdev_handle_get_keycode(dev, p);
751 return evdev_handle_set_keycode(dev, p);
753 case EVIOCGKEYCODE_V2:
754 return evdev_handle_get_keycode_v2(dev, p);
756 case EVIOCSKEYCODE_V2:
757 return evdev_handle_set_keycode_v2(dev, p);
760 size = _IOC_SIZE(cmd);
762 /* Now check variable-length commands */
763 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
764 switch (EVIOC_MASK_SIZE(cmd)) {
767 return bits_to_user(dev->propbit, INPUT_PROP_MAX,
768 size, p, compat_mode);
770 case EVIOCGMTSLOTS(0):
771 return evdev_handle_mt_request(dev, size, ip);
774 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
777 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
780 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
783 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
786 return str_to_user(dev->name, size, p);
789 return str_to_user(dev->phys, size, p);
792 return str_to_user(dev->uniq, size, p);
794 case EVIOC_MASK_SIZE(EVIOCSFF):
795 if (input_ff_effect_from_user(p, size, &effect))
798 error = input_ff_upload(dev, &effect, file);
800 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
806 /* Multi-number variable-length handlers */
807 if (_IOC_TYPE(cmd) != 'E')
810 if (_IOC_DIR(cmd) == _IOC_READ) {
812 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
813 return handle_eviocgbit(dev,
814 _IOC_NR(cmd) & EV_MAX, size,
817 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
822 t = _IOC_NR(cmd) & ABS_MAX;
823 abs = dev->absinfo[t];
825 if (copy_to_user(p, &abs, min_t(size_t,
826 size, sizeof(struct input_absinfo))))
833 if (_IOC_DIR(cmd) == _IOC_WRITE) {
835 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
840 t = _IOC_NR(cmd) & ABS_MAX;
842 if (copy_from_user(&abs, p, min_t(size_t,
843 size, sizeof(struct input_absinfo))))
846 if (size < sizeof(struct input_absinfo))
849 /* We can't change number of reserved MT slots */
850 if (t == ABS_MT_SLOT)
854 * Take event lock to ensure that we are not
855 * changing device parameters in the middle
858 spin_lock_irq(&dev->event_lock);
859 dev->absinfo[t] = abs;
860 spin_unlock_irq(&dev->event_lock);
869 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
870 void __user *p, int compat_mode)
872 struct evdev_client *client = file->private_data;
873 struct evdev *evdev = client->evdev;
876 retval = mutex_lock_interruptible(&evdev->mutex);
885 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
888 mutex_unlock(&evdev->mutex);
892 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
894 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
898 static long evdev_ioctl_compat(struct file *file,
899 unsigned int cmd, unsigned long arg)
901 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
905 static const struct file_operations evdev_fops = {
906 .owner = THIS_MODULE,
908 .write = evdev_write,
911 .release = evdev_release,
912 .unlocked_ioctl = evdev_ioctl,
914 .compat_ioctl = evdev_ioctl_compat,
916 .fasync = evdev_fasync,
917 .flush = evdev_flush,
922 * Mark device non-existent. This disables writes, ioctls and
923 * prevents new users from opening the device. Already posted
924 * blocking reads will stay, however new ones will fail.
926 static void evdev_mark_dead(struct evdev *evdev)
928 mutex_lock(&evdev->mutex);
929 evdev->exist = false;
930 mutex_unlock(&evdev->mutex);
933 static void evdev_cleanup(struct evdev *evdev)
935 struct input_handle *handle = &evdev->handle;
937 evdev_mark_dead(evdev);
940 cdev_del(&evdev->cdev);
942 /* evdev is marked dead so no one else accesses evdev->open */
944 input_flush_device(handle, NULL);
945 input_close_device(handle);
950 * Create new evdev device. Note that input core serializes calls
951 * to connect and disconnect.
953 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
954 const struct input_device_id *id)
961 minor = input_get_new_minor(EVDEV_MINOR_BASE, EVDEV_MINORS, true);
964 pr_err("failed to reserve new minor: %d\n", error);
968 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
974 INIT_LIST_HEAD(&evdev->client_list);
975 spin_lock_init(&evdev->client_lock);
976 mutex_init(&evdev->mutex);
977 init_waitqueue_head(&evdev->wait);
981 /* Normalize device number if it falls into legacy range */
982 if (dev_no < EVDEV_MINOR_BASE + EVDEV_MINORS)
983 dev_no -= EVDEV_MINOR_BASE;
984 dev_set_name(&evdev->dev, "event%d", dev_no);
986 evdev->handle.dev = input_get_device(dev);
987 evdev->handle.name = dev_name(&evdev->dev);
988 evdev->handle.handler = handler;
989 evdev->handle.private = evdev;
991 evdev->dev.devt = MKDEV(INPUT_MAJOR, minor);
992 evdev->dev.class = &input_class;
993 evdev->dev.parent = &dev->dev;
994 evdev->dev.release = evdev_free;
995 device_initialize(&evdev->dev);
997 error = input_register_handle(&evdev->handle);
1001 cdev_init(&evdev->cdev, &evdev_fops);
1002 evdev->cdev.kobj.parent = &evdev->dev.kobj;
1003 error = cdev_add(&evdev->cdev, evdev->dev.devt, 1);
1005 goto err_unregister_handle;
1007 error = device_add(&evdev->dev);
1009 goto err_cleanup_evdev;
1014 evdev_cleanup(evdev);
1015 err_unregister_handle:
1016 input_unregister_handle(&evdev->handle);
1018 put_device(&evdev->dev);
1020 input_free_minor(minor);
1024 static void evdev_disconnect(struct input_handle *handle)
1026 struct evdev *evdev = handle->private;
1028 device_del(&evdev->dev);
1029 evdev_cleanup(evdev);
1030 input_free_minor(MINOR(evdev->dev.devt));
1031 input_unregister_handle(handle);
1032 put_device(&evdev->dev);
1035 static const struct input_device_id evdev_ids[] = {
1036 { .driver_info = 1 }, /* Matches all devices */
1037 { }, /* Terminating zero entry */
1040 MODULE_DEVICE_TABLE(input, evdev_ids);
1042 static struct input_handler evdev_handler = {
1043 .event = evdev_event,
1044 .events = evdev_events,
1045 .connect = evdev_connect,
1046 .disconnect = evdev_disconnect,
1047 .legacy_minors = true,
1048 .minor = EVDEV_MINOR_BASE,
1050 .id_table = evdev_ids,
1053 static int __init evdev_init(void)
1055 return input_register_handler(&evdev_handler);
1058 static void __exit evdev_exit(void)
1060 input_unregister_handler(&evdev_handler);
1063 module_init(evdev_init);
1064 module_exit(evdev_exit);
1066 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
1067 MODULE_DESCRIPTION("Input driver event char devices");
1068 MODULE_LICENSE("GPL");