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 "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;
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,
59 ktime_t mono, ktime_t real)
61 event->time = ktime_to_timeval(client->clkid == CLOCK_MONOTONIC ?
64 /* Interrupts are disabled, just acquire the lock. */
65 spin_lock(&client->buffer_lock);
67 client->buffer[client->head++] = *event;
68 client->head &= client->bufsize - 1;
70 if (unlikely(client->head == client->tail)) {
72 * This effectively "drops" all unconsumed events, leaving
73 * EV_SYN/SYN_DROPPED plus the newest event in the queue.
75 client->tail = (client->head - 2) & (client->bufsize - 1);
77 client->buffer[client->tail].time = event->time;
78 client->buffer[client->tail].type = EV_SYN;
79 client->buffer[client->tail].code = SYN_DROPPED;
80 client->buffer[client->tail].value = 0;
82 client->packet_head = client->tail;
85 if (event->type == EV_SYN && event->code == SYN_REPORT) {
86 client->packet_head = client->head;
87 kill_fasync(&client->fasync, SIGIO, POLL_IN);
90 spin_unlock(&client->buffer_lock);
94 * Pass incoming event to all connected clients.
96 static void evdev_event(struct input_handle *handle,
97 unsigned int type, unsigned int code, int value)
99 struct evdev *evdev = handle->private;
100 struct evdev_client *client;
101 struct input_event event;
102 ktime_t time_mono, time_real;
104 time_mono = ktime_get();
105 time_real = ktime_sub(time_mono, ktime_get_monotonic_offset());
113 client = rcu_dereference(evdev->grab);
116 evdev_pass_event(client, &event, time_mono, time_real);
118 list_for_each_entry_rcu(client, &evdev->client_list, node)
119 evdev_pass_event(client, &event, time_mono, time_real);
123 if (type == EV_SYN && code == SYN_REPORT)
124 wake_up_interruptible(&evdev->wait);
127 static int evdev_fasync(int fd, struct file *file, int on)
129 struct evdev_client *client = file->private_data;
131 return fasync_helper(fd, file, on, &client->fasync);
134 static int evdev_flush(struct file *file, fl_owner_t id)
136 struct evdev_client *client = file->private_data;
137 struct evdev *evdev = client->evdev;
140 retval = mutex_lock_interruptible(&evdev->mutex);
147 retval = input_flush_device(&evdev->handle, file);
149 mutex_unlock(&evdev->mutex);
153 static void evdev_free(struct device *dev)
155 struct evdev *evdev = container_of(dev, struct evdev, dev);
157 input_put_device(evdev->handle.dev);
162 * Grabs an event device (along with underlying input device).
163 * This function is called with evdev->mutex taken.
165 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
172 error = input_grab_device(&evdev->handle);
176 rcu_assign_pointer(evdev->grab, client);
181 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
183 struct evdev_client *grab = rcu_dereference_protected(evdev->grab,
184 lockdep_is_held(&evdev->mutex));
189 rcu_assign_pointer(evdev->grab, NULL);
191 input_release_device(&evdev->handle);
196 static void evdev_attach_client(struct evdev *evdev,
197 struct evdev_client *client)
199 spin_lock(&evdev->client_lock);
200 list_add_tail_rcu(&client->node, &evdev->client_list);
201 spin_unlock(&evdev->client_lock);
204 static void evdev_detach_client(struct evdev *evdev,
205 struct evdev_client *client)
207 spin_lock(&evdev->client_lock);
208 list_del_rcu(&client->node);
209 spin_unlock(&evdev->client_lock);
213 static int evdev_open_device(struct evdev *evdev)
217 retval = mutex_lock_interruptible(&evdev->mutex);
223 else if (!evdev->open++) {
224 retval = input_open_device(&evdev->handle);
229 mutex_unlock(&evdev->mutex);
233 static void evdev_close_device(struct evdev *evdev)
235 mutex_lock(&evdev->mutex);
237 if (evdev->exist && !--evdev->open)
238 input_close_device(&evdev->handle);
240 mutex_unlock(&evdev->mutex);
244 * Wake up users waiting for IO so they can disconnect from
247 static void evdev_hangup(struct evdev *evdev)
249 struct evdev_client *client;
251 spin_lock(&evdev->client_lock);
252 list_for_each_entry(client, &evdev->client_list, node)
253 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
254 spin_unlock(&evdev->client_lock);
256 wake_up_interruptible(&evdev->wait);
259 static int evdev_release(struct inode *inode, struct file *file)
261 struct evdev_client *client = file->private_data;
262 struct evdev *evdev = client->evdev;
264 mutex_lock(&evdev->mutex);
265 evdev_ungrab(evdev, client);
266 mutex_unlock(&evdev->mutex);
268 evdev_detach_client(evdev, client);
271 evdev_close_device(evdev);
272 put_device(&evdev->dev);
277 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
279 unsigned int n_events =
280 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
281 EVDEV_MIN_BUFFER_SIZE);
283 return roundup_pow_of_two(n_events);
286 static int evdev_open(struct inode *inode, struct file *file)
289 struct evdev_client *client;
290 int i = iminor(inode) - EVDEV_MINOR_BASE;
291 unsigned int bufsize;
294 if (i >= EVDEV_MINORS)
297 error = mutex_lock_interruptible(&evdev_table_mutex);
300 evdev = evdev_table[i];
302 get_device(&evdev->dev);
303 mutex_unlock(&evdev_table_mutex);
308 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
310 client = kzalloc(sizeof(struct evdev_client) +
311 bufsize * sizeof(struct input_event),
318 client->bufsize = bufsize;
319 spin_lock_init(&client->buffer_lock);
320 client->evdev = evdev;
321 evdev_attach_client(evdev, client);
323 error = evdev_open_device(evdev);
325 goto err_free_client;
327 file->private_data = client;
328 nonseekable_open(inode, file);
333 evdev_detach_client(evdev, client);
336 put_device(&evdev->dev);
340 static ssize_t evdev_write(struct file *file, const char __user *buffer,
341 size_t count, loff_t *ppos)
343 struct evdev_client *client = file->private_data;
344 struct evdev *evdev = client->evdev;
345 struct input_event event;
348 if (count != 0 && count < input_event_size())
351 retval = mutex_lock_interruptible(&evdev->mutex);
360 while (retval + input_event_size() <= count) {
362 if (input_event_from_user(buffer + retval, &event)) {
366 retval += input_event_size();
368 input_inject_event(&evdev->handle,
369 event.type, event.code, event.value);
373 mutex_unlock(&evdev->mutex);
377 static int evdev_fetch_next_event(struct evdev_client *client,
378 struct input_event *event)
382 spin_lock_irq(&client->buffer_lock);
384 have_event = client->packet_head != client->tail;
386 *event = client->buffer[client->tail++];
387 client->tail &= client->bufsize - 1;
390 spin_unlock_irq(&client->buffer_lock);
395 static ssize_t evdev_read(struct file *file, char __user *buffer,
396 size_t count, loff_t *ppos)
398 struct evdev_client *client = file->private_data;
399 struct evdev *evdev = client->evdev;
400 struct input_event event;
404 if (count != 0 && count < input_event_size())
411 if (client->packet_head == client->tail &&
412 (file->f_flags & O_NONBLOCK))
416 * count == 0 is special - no IO is done but we check
417 * for error conditions (see above).
422 while (read + input_event_size() <= count &&
423 evdev_fetch_next_event(client, &event)) {
425 if (input_event_to_user(buffer + read, &event))
428 read += input_event_size();
434 if (!(file->f_flags & O_NONBLOCK)) {
435 error = wait_event_interruptible(evdev->wait,
436 client->packet_head != client->tail ||
446 /* No kernel lock - fine */
447 static unsigned int evdev_poll(struct file *file, poll_table *wait)
449 struct evdev_client *client = file->private_data;
450 struct evdev *evdev = client->evdev;
453 poll_wait(file, &evdev->wait, wait);
455 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
456 if (client->packet_head != client->tail)
457 mask |= POLLIN | POLLRDNORM;
464 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
465 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
468 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
469 unsigned int maxlen, void __user *p, int compat)
474 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
478 for (i = 0; i < len / sizeof(compat_long_t); i++)
479 if (copy_to_user((compat_long_t __user *) p + i,
480 (compat_long_t *) bits +
481 i + 1 - ((i % 2) << 1),
482 sizeof(compat_long_t)))
485 len = BITS_TO_LONGS(maxbit) * sizeof(long);
489 if (copy_to_user(p, bits, len))
496 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
497 unsigned int maxlen, void __user *p, int compat)
500 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
501 BITS_TO_LONGS(maxbit) * sizeof(long);
506 return copy_to_user(p, bits, len) ? -EFAULT : len;
508 #endif /* __BIG_ENDIAN */
512 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
513 unsigned int maxlen, void __user *p, int compat)
515 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
520 return copy_to_user(p, bits, len) ? -EFAULT : len;
523 #endif /* CONFIG_COMPAT */
525 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
532 len = strlen(str) + 1;
536 return copy_to_user(p, str, len) ? -EFAULT : len;
539 #define OLD_KEY_MAX 0x1ff
540 static int handle_eviocgbit(struct input_dev *dev,
541 unsigned int type, unsigned int size,
542 void __user *p, int compat_mode)
544 static unsigned long keymax_warn_time;
550 case 0: bits = dev->evbit; len = EV_MAX; break;
551 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
552 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
553 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
554 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
555 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
556 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
557 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
558 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
559 default: return -EINVAL;
563 * Work around bugs in userspace programs that like to do
564 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
565 * should be in bytes, not in bits.
567 if (type == EV_KEY && size == OLD_KEY_MAX) {
569 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
570 pr_warning("(EVIOCGBIT): Suspicious buffer size %u, "
571 "limiting output to %zu bytes. See "
572 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
574 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
577 return bits_to_user(bits, len, size, p, compat_mode);
581 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
583 struct input_keymap_entry ke = {
584 .len = sizeof(unsigned int),
587 int __user *ip = (int __user *)p;
591 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
594 error = input_get_keycode(dev, &ke);
598 if (put_user(ke.keycode, ip + 1))
604 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
606 struct input_keymap_entry ke;
609 if (copy_from_user(&ke, p, sizeof(ke)))
612 error = input_get_keycode(dev, &ke);
616 if (copy_to_user(p, &ke, sizeof(ke)))
622 static int evdev_handle_set_keycode(struct input_dev *dev, void __user *p)
624 struct input_keymap_entry ke = {
625 .len = sizeof(unsigned int),
628 int __user *ip = (int __user *)p;
630 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
633 if (get_user(ke.keycode, ip + 1))
636 return input_set_keycode(dev, &ke);
639 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
641 struct input_keymap_entry ke;
643 if (copy_from_user(&ke, p, sizeof(ke)))
646 if (ke.len > sizeof(ke.scancode))
649 return input_set_keycode(dev, &ke);
652 static int evdev_handle_mt_request(struct input_dev *dev,
656 const struct input_mt_slot *mt = dev->mt;
661 if (get_user(code, &ip[0]))
663 if (!input_is_mt_value(code))
666 max_slots = (size - sizeof(__u32)) / sizeof(__s32);
667 for (i = 0; i < dev->mtsize && i < max_slots; i++)
668 if (put_user(input_mt_get_value(&mt[i], code), &ip[1 + i]))
674 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
675 void __user *p, int compat_mode)
677 struct evdev_client *client = file->private_data;
678 struct evdev *evdev = client->evdev;
679 struct input_dev *dev = evdev->handle.dev;
680 struct input_absinfo abs;
681 struct ff_effect effect;
682 int __user *ip = (int __user *)p;
683 unsigned int i, t, u, v;
687 /* First we check for fixed-length commands */
691 return put_user(EV_VERSION, ip);
694 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
699 if (!test_bit(EV_REP, dev->evbit))
701 if (put_user(dev->rep[REP_DELAY], ip))
703 if (put_user(dev->rep[REP_PERIOD], ip + 1))
708 if (!test_bit(EV_REP, dev->evbit))
712 if (get_user(v, ip + 1))
715 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
716 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
721 return input_ff_erase(dev, (int)(unsigned long) p, file);
724 i = test_bit(EV_FF, dev->evbit) ?
725 dev->ff->max_effects : 0;
732 return evdev_grab(evdev, client);
734 return evdev_ungrab(evdev, client);
737 if (copy_from_user(&i, p, sizeof(unsigned int)))
739 if (i != CLOCK_MONOTONIC && i != CLOCK_REALTIME)
745 return evdev_handle_get_keycode(dev, p);
748 return evdev_handle_set_keycode(dev, p);
750 case EVIOCGKEYCODE_V2:
751 return evdev_handle_get_keycode_v2(dev, p);
753 case EVIOCSKEYCODE_V2:
754 return evdev_handle_set_keycode_v2(dev, p);
757 size = _IOC_SIZE(cmd);
759 /* Now check variable-length commands */
760 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
761 switch (EVIOC_MASK_SIZE(cmd)) {
764 return bits_to_user(dev->propbit, INPUT_PROP_MAX,
765 size, p, compat_mode);
767 case EVIOCGMTSLOTS(0):
768 return evdev_handle_mt_request(dev, size, ip);
771 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
774 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
777 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
780 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
783 return str_to_user(dev->name, size, p);
786 return str_to_user(dev->phys, size, p);
789 return str_to_user(dev->uniq, size, p);
791 case EVIOC_MASK_SIZE(EVIOCSFF):
792 if (input_ff_effect_from_user(p, size, &effect))
795 error = input_ff_upload(dev, &effect, file);
797 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
803 /* Multi-number variable-length handlers */
804 if (_IOC_TYPE(cmd) != 'E')
807 if (_IOC_DIR(cmd) == _IOC_READ) {
809 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
810 return handle_eviocgbit(dev,
811 _IOC_NR(cmd) & EV_MAX, size,
814 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
819 t = _IOC_NR(cmd) & ABS_MAX;
820 abs = dev->absinfo[t];
822 if (copy_to_user(p, &abs, min_t(size_t,
823 size, sizeof(struct input_absinfo))))
830 if (_IOC_DIR(cmd) == _IOC_WRITE) {
832 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
837 t = _IOC_NR(cmd) & ABS_MAX;
839 if (copy_from_user(&abs, p, min_t(size_t,
840 size, sizeof(struct input_absinfo))))
843 if (size < sizeof(struct input_absinfo))
846 /* We can't change number of reserved MT slots */
847 if (t == ABS_MT_SLOT)
851 * Take event lock to ensure that we are not
852 * changing device parameters in the middle
855 spin_lock_irq(&dev->event_lock);
856 dev->absinfo[t] = abs;
857 spin_unlock_irq(&dev->event_lock);
866 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
867 void __user *p, int compat_mode)
869 struct evdev_client *client = file->private_data;
870 struct evdev *evdev = client->evdev;
873 retval = mutex_lock_interruptible(&evdev->mutex);
882 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
885 mutex_unlock(&evdev->mutex);
889 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
891 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
895 static long evdev_ioctl_compat(struct file *file,
896 unsigned int cmd, unsigned long arg)
898 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
902 static const struct file_operations evdev_fops = {
903 .owner = THIS_MODULE,
905 .write = evdev_write,
908 .release = evdev_release,
909 .unlocked_ioctl = evdev_ioctl,
911 .compat_ioctl = evdev_ioctl_compat,
913 .fasync = evdev_fasync,
914 .flush = evdev_flush,
918 static int evdev_install_chrdev(struct evdev *evdev)
921 * No need to do any locking here as calls to connect and
922 * disconnect are serialized by the input core
924 evdev_table[evdev->minor] = evdev;
928 static void evdev_remove_chrdev(struct evdev *evdev)
931 * Lock evdev table to prevent race with evdev_open()
933 mutex_lock(&evdev_table_mutex);
934 evdev_table[evdev->minor] = NULL;
935 mutex_unlock(&evdev_table_mutex);
939 * Mark device non-existent. This disables writes, ioctls and
940 * prevents new users from opening the device. Already posted
941 * blocking reads will stay, however new ones will fail.
943 static void evdev_mark_dead(struct evdev *evdev)
945 mutex_lock(&evdev->mutex);
946 evdev->exist = false;
947 mutex_unlock(&evdev->mutex);
950 static void evdev_cleanup(struct evdev *evdev)
952 struct input_handle *handle = &evdev->handle;
954 evdev_mark_dead(evdev);
956 evdev_remove_chrdev(evdev);
958 /* evdev is marked dead so no one else accesses evdev->open */
960 input_flush_device(handle, NULL);
961 input_close_device(handle);
966 * Create new evdev device. Note that input core serializes calls
967 * to connect and disconnect so we don't need to lock evdev_table here.
969 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
970 const struct input_device_id *id)
976 for (minor = 0; minor < EVDEV_MINORS; minor++)
977 if (!evdev_table[minor])
980 if (minor == EVDEV_MINORS) {
981 pr_err("no more free evdev devices\n");
985 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
989 INIT_LIST_HEAD(&evdev->client_list);
990 spin_lock_init(&evdev->client_lock);
991 mutex_init(&evdev->mutex);
992 init_waitqueue_head(&evdev->wait);
994 dev_set_name(&evdev->dev, "event%d", minor);
996 evdev->minor = minor;
998 evdev->handle.dev = input_get_device(dev);
999 evdev->handle.name = dev_name(&evdev->dev);
1000 evdev->handle.handler = handler;
1001 evdev->handle.private = evdev;
1003 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
1004 evdev->dev.class = &input_class;
1005 evdev->dev.parent = &dev->dev;
1006 evdev->dev.release = evdev_free;
1007 device_initialize(&evdev->dev);
1009 error = input_register_handle(&evdev->handle);
1011 goto err_free_evdev;
1013 error = evdev_install_chrdev(evdev);
1015 goto err_unregister_handle;
1017 error = device_add(&evdev->dev);
1019 goto err_cleanup_evdev;
1024 evdev_cleanup(evdev);
1025 err_unregister_handle:
1026 input_unregister_handle(&evdev->handle);
1028 put_device(&evdev->dev);
1032 static void evdev_disconnect(struct input_handle *handle)
1034 struct evdev *evdev = handle->private;
1036 device_del(&evdev->dev);
1037 evdev_cleanup(evdev);
1038 input_unregister_handle(handle);
1039 put_device(&evdev->dev);
1042 static const struct input_device_id evdev_ids[] = {
1043 { .driver_info = 1 }, /* Matches all devices */
1044 { }, /* Terminating zero entry */
1047 MODULE_DEVICE_TABLE(input, evdev_ids);
1049 static struct input_handler evdev_handler = {
1050 .event = evdev_event,
1051 .connect = evdev_connect,
1052 .disconnect = evdev_disconnect,
1053 .fops = &evdev_fops,
1054 .minor = EVDEV_MINOR_BASE,
1056 .id_table = evdev_ids,
1059 static int __init evdev_init(void)
1061 return input_register_handler(&evdev_handler);
1064 static void __exit evdev_exit(void)
1066 input_unregister_handler(&evdev_handler);
1069 module_init(evdev_init);
1070 module_exit(evdev_exit);
1072 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
1073 MODULE_DESCRIPTION("Input driver event char devices");
1074 MODULE_LICENSE("GPL");