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 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
45 struct fasync_struct *fasync;
47 struct list_head node;
49 struct input_event buffer[];
52 static struct evdev *evdev_table[EVDEV_MINORS];
53 static DEFINE_MUTEX(evdev_table_mutex);
55 static void evdev_pass_event(struct evdev_client *client,
56 struct input_event *event)
58 /* Interrupts are disabled, just acquire the lock. */
59 spin_lock(&client->buffer_lock);
61 client->buffer[client->head++] = *event;
62 client->head &= client->bufsize - 1;
64 if (unlikely(client->head == client->tail)) {
66 * This effectively "drops" all unconsumed events, leaving
67 * EV_SYN/SYN_DROPPED plus the newest event in the queue.
69 client->tail = (client->head - 2) & (client->bufsize - 1);
71 client->buffer[client->tail].time = event->time;
72 client->buffer[client->tail].type = EV_SYN;
73 client->buffer[client->tail].code = SYN_DROPPED;
74 client->buffer[client->tail].value = 0;
77 spin_unlock(&client->buffer_lock);
79 if (event->type == EV_SYN)
80 kill_fasync(&client->fasync, SIGIO, POLL_IN);
84 * Pass incoming event to all connected clients.
86 static void evdev_event(struct input_handle *handle,
87 unsigned int type, unsigned int code, int value)
89 struct evdev *evdev = handle->private;
90 struct evdev_client *client;
91 struct input_event event;
93 do_gettimeofday(&event.time);
100 client = rcu_dereference(evdev->grab);
102 evdev_pass_event(client, &event);
104 list_for_each_entry_rcu(client, &evdev->client_list, node)
105 evdev_pass_event(client, &event);
109 wake_up_interruptible(&evdev->wait);
112 static int evdev_fasync(int fd, struct file *file, int on)
114 struct evdev_client *client = file->private_data;
116 return fasync_helper(fd, file, on, &client->fasync);
119 static int evdev_flush(struct file *file, fl_owner_t id)
121 struct evdev_client *client = file->private_data;
122 struct evdev *evdev = client->evdev;
125 retval = mutex_lock_interruptible(&evdev->mutex);
132 retval = input_flush_device(&evdev->handle, file);
134 mutex_unlock(&evdev->mutex);
138 static void evdev_free(struct device *dev)
140 struct evdev *evdev = container_of(dev, struct evdev, dev);
142 input_put_device(evdev->handle.dev);
147 * Grabs an event device (along with underlying input device).
148 * This function is called with evdev->mutex taken.
150 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
157 error = input_grab_device(&evdev->handle);
161 rcu_assign_pointer(evdev->grab, client);
167 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
169 if (evdev->grab != client)
172 rcu_assign_pointer(evdev->grab, NULL);
174 input_release_device(&evdev->handle);
179 static void evdev_attach_client(struct evdev *evdev,
180 struct evdev_client *client)
182 spin_lock(&evdev->client_lock);
183 list_add_tail_rcu(&client->node, &evdev->client_list);
184 spin_unlock(&evdev->client_lock);
188 static void evdev_detach_client(struct evdev *evdev,
189 struct evdev_client *client)
191 spin_lock(&evdev->client_lock);
192 list_del_rcu(&client->node);
193 spin_unlock(&evdev->client_lock);
197 static int evdev_open_device(struct evdev *evdev)
201 retval = mutex_lock_interruptible(&evdev->mutex);
207 else if (!evdev->open++) {
208 retval = input_open_device(&evdev->handle);
213 mutex_unlock(&evdev->mutex);
217 static void evdev_close_device(struct evdev *evdev)
219 mutex_lock(&evdev->mutex);
221 if (evdev->exist && !--evdev->open)
222 input_close_device(&evdev->handle);
224 mutex_unlock(&evdev->mutex);
228 * Wake up users waiting for IO so they can disconnect from
231 static void evdev_hangup(struct evdev *evdev)
233 struct evdev_client *client;
235 spin_lock(&evdev->client_lock);
236 list_for_each_entry(client, &evdev->client_list, node)
237 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
238 spin_unlock(&evdev->client_lock);
240 wake_up_interruptible(&evdev->wait);
243 static int evdev_release(struct inode *inode, struct file *file)
245 struct evdev_client *client = file->private_data;
246 struct evdev *evdev = client->evdev;
248 mutex_lock(&evdev->mutex);
249 if (evdev->grab == client)
250 evdev_ungrab(evdev, client);
251 mutex_unlock(&evdev->mutex);
253 evdev_detach_client(evdev, client);
256 evdev_close_device(evdev);
257 put_device(&evdev->dev);
262 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
264 unsigned int n_events =
265 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
266 EVDEV_MIN_BUFFER_SIZE);
268 return roundup_pow_of_two(n_events);
271 static int evdev_open(struct inode *inode, struct file *file)
274 struct evdev_client *client;
275 int i = iminor(inode) - EVDEV_MINOR_BASE;
276 unsigned int bufsize;
279 if (i >= EVDEV_MINORS)
282 error = mutex_lock_interruptible(&evdev_table_mutex);
285 evdev = evdev_table[i];
287 get_device(&evdev->dev);
288 mutex_unlock(&evdev_table_mutex);
293 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
295 client = kzalloc(sizeof(struct evdev_client) +
296 bufsize * sizeof(struct input_event),
303 client->bufsize = bufsize;
304 spin_lock_init(&client->buffer_lock);
305 client->evdev = evdev;
306 evdev_attach_client(evdev, client);
308 error = evdev_open_device(evdev);
310 goto err_free_client;
312 file->private_data = client;
313 nonseekable_open(inode, file);
318 evdev_detach_client(evdev, client);
321 put_device(&evdev->dev);
325 static ssize_t evdev_write(struct file *file, const char __user *buffer,
326 size_t count, loff_t *ppos)
328 struct evdev_client *client = file->private_data;
329 struct evdev *evdev = client->evdev;
330 struct input_event event;
333 if (count < input_event_size())
336 retval = mutex_lock_interruptible(&evdev->mutex);
346 if (input_event_from_user(buffer + retval, &event)) {
350 retval += input_event_size();
352 input_inject_event(&evdev->handle,
353 event.type, event.code, event.value);
354 } while (retval + input_event_size() <= count);
357 mutex_unlock(&evdev->mutex);
361 static int evdev_fetch_next_event(struct evdev_client *client,
362 struct input_event *event)
366 spin_lock_irq(&client->buffer_lock);
368 have_event = client->head != client->tail;
370 *event = client->buffer[client->tail++];
371 client->tail &= client->bufsize - 1;
374 spin_unlock_irq(&client->buffer_lock);
379 static ssize_t evdev_read(struct file *file, char __user *buffer,
380 size_t count, loff_t *ppos)
382 struct evdev_client *client = file->private_data;
383 struct evdev *evdev = client->evdev;
384 struct input_event event;
387 if (count < input_event_size())
390 if (client->head == client->tail && evdev->exist &&
391 (file->f_flags & O_NONBLOCK))
394 retval = wait_event_interruptible(evdev->wait,
395 client->head != client->tail || !evdev->exist);
402 while (retval + input_event_size() <= count &&
403 evdev_fetch_next_event(client, &event)) {
405 if (input_event_to_user(buffer + retval, &event))
408 retval += input_event_size();
414 /* No kernel lock - fine */
415 static unsigned int evdev_poll(struct file *file, poll_table *wait)
417 struct evdev_client *client = file->private_data;
418 struct evdev *evdev = client->evdev;
421 poll_wait(file, &evdev->wait, wait);
423 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
424 if (client->head != client->tail)
425 mask |= POLLIN | POLLRDNORM;
432 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
433 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
436 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
437 unsigned int maxlen, void __user *p, int compat)
442 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
446 for (i = 0; i < len / sizeof(compat_long_t); i++)
447 if (copy_to_user((compat_long_t __user *) p + i,
448 (compat_long_t *) bits +
449 i + 1 - ((i % 2) << 1),
450 sizeof(compat_long_t)))
453 len = BITS_TO_LONGS(maxbit) * sizeof(long);
457 if (copy_to_user(p, bits, len))
464 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
465 unsigned int maxlen, void __user *p, int compat)
468 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
469 BITS_TO_LONGS(maxbit) * sizeof(long);
474 return copy_to_user(p, bits, len) ? -EFAULT : len;
476 #endif /* __BIG_ENDIAN */
480 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
481 unsigned int maxlen, void __user *p, int compat)
483 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
488 return copy_to_user(p, bits, len) ? -EFAULT : len;
491 #endif /* CONFIG_COMPAT */
493 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
500 len = strlen(str) + 1;
504 return copy_to_user(p, str, len) ? -EFAULT : len;
507 #define OLD_KEY_MAX 0x1ff
508 static int handle_eviocgbit(struct input_dev *dev,
509 unsigned int type, unsigned int size,
510 void __user *p, int compat_mode)
512 static unsigned long keymax_warn_time;
518 case 0: bits = dev->evbit; len = EV_MAX; break;
519 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
520 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
521 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
522 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
523 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
524 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
525 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
526 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
527 default: return -EINVAL;
531 * Work around bugs in userspace programs that like to do
532 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
533 * should be in bytes, not in bits.
535 if (type == EV_KEY && size == OLD_KEY_MAX) {
537 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
538 pr_warning("(EVIOCGBIT): Suspicious buffer size %u, "
539 "limiting output to %zu bytes. See "
540 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
542 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
545 return bits_to_user(bits, len, size, p, compat_mode);
549 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
551 struct input_keymap_entry ke = {
552 .len = sizeof(unsigned int),
555 int __user *ip = (int __user *)p;
559 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
562 error = input_get_keycode(dev, &ke);
566 if (put_user(ke.keycode, ip + 1))
572 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
574 struct input_keymap_entry ke;
577 if (copy_from_user(&ke, p, sizeof(ke)))
580 error = input_get_keycode(dev, &ke);
584 if (copy_to_user(p, &ke, sizeof(ke)))
590 static int evdev_handle_set_keycode(struct input_dev *dev, void __user *p)
592 struct input_keymap_entry ke = {
593 .len = sizeof(unsigned int),
596 int __user *ip = (int __user *)p;
598 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
601 if (get_user(ke.keycode, ip + 1))
604 return input_set_keycode(dev, &ke);
607 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
609 struct input_keymap_entry ke;
611 if (copy_from_user(&ke, p, sizeof(ke)))
614 if (ke.len > sizeof(ke.scancode))
617 return input_set_keycode(dev, &ke);
620 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
621 void __user *p, int compat_mode)
623 struct evdev_client *client = file->private_data;
624 struct evdev *evdev = client->evdev;
625 struct input_dev *dev = evdev->handle.dev;
626 struct input_absinfo abs;
627 struct ff_effect effect;
628 int __user *ip = (int __user *)p;
629 unsigned int i, t, u, v;
633 /* First we check for fixed-length commands */
637 return put_user(EV_VERSION, ip);
640 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
645 if (!test_bit(EV_REP, dev->evbit))
647 if (put_user(dev->rep[REP_DELAY], ip))
649 if (put_user(dev->rep[REP_PERIOD], ip + 1))
654 if (!test_bit(EV_REP, dev->evbit))
658 if (get_user(v, ip + 1))
661 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
662 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
667 return input_ff_erase(dev, (int)(unsigned long) p, file);
670 i = test_bit(EV_FF, dev->evbit) ?
671 dev->ff->max_effects : 0;
678 return evdev_grab(evdev, client);
680 return evdev_ungrab(evdev, client);
683 return evdev_handle_get_keycode(dev, p);
686 return evdev_handle_set_keycode(dev, p);
688 case EVIOCGKEYCODE_V2:
689 return evdev_handle_get_keycode_v2(dev, p);
691 case EVIOCSKEYCODE_V2:
692 return evdev_handle_set_keycode_v2(dev, p);
695 size = _IOC_SIZE(cmd);
697 /* Now check variable-length commands */
698 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
699 switch (EVIOC_MASK_SIZE(cmd)) {
702 return bits_to_user(dev->propbit, INPUT_PROP_MAX,
703 size, p, compat_mode);
706 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
709 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
712 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
715 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
718 return str_to_user(dev->name, size, p);
721 return str_to_user(dev->phys, size, p);
724 return str_to_user(dev->uniq, size, p);
726 case EVIOC_MASK_SIZE(EVIOCSFF):
727 if (input_ff_effect_from_user(p, size, &effect))
730 error = input_ff_upload(dev, &effect, file);
732 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
738 /* Multi-number variable-length handlers */
739 if (_IOC_TYPE(cmd) != 'E')
742 if (_IOC_DIR(cmd) == _IOC_READ) {
744 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
745 return handle_eviocgbit(dev,
746 _IOC_NR(cmd) & EV_MAX, size,
749 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
754 t = _IOC_NR(cmd) & ABS_MAX;
755 abs = dev->absinfo[t];
757 if (copy_to_user(p, &abs, min_t(size_t,
758 size, sizeof(struct input_absinfo))))
765 if (_IOC_DIR(cmd) == _IOC_WRITE) {
767 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
772 t = _IOC_NR(cmd) & ABS_MAX;
774 if (copy_from_user(&abs, p, min_t(size_t,
775 size, sizeof(struct input_absinfo))))
778 if (size < sizeof(struct input_absinfo))
781 /* We can't change number of reserved MT slots */
782 if (t == ABS_MT_SLOT)
786 * Take event lock to ensure that we are not
787 * changing device parameters in the middle
790 spin_lock_irq(&dev->event_lock);
791 dev->absinfo[t] = abs;
792 spin_unlock_irq(&dev->event_lock);
801 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
802 void __user *p, int compat_mode)
804 struct evdev_client *client = file->private_data;
805 struct evdev *evdev = client->evdev;
808 retval = mutex_lock_interruptible(&evdev->mutex);
817 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
820 mutex_unlock(&evdev->mutex);
824 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
826 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
830 static long evdev_ioctl_compat(struct file *file,
831 unsigned int cmd, unsigned long arg)
833 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
837 static const struct file_operations evdev_fops = {
838 .owner = THIS_MODULE,
840 .write = evdev_write,
843 .release = evdev_release,
844 .unlocked_ioctl = evdev_ioctl,
846 .compat_ioctl = evdev_ioctl_compat,
848 .fasync = evdev_fasync,
849 .flush = evdev_flush,
853 static int evdev_install_chrdev(struct evdev *evdev)
856 * No need to do any locking here as calls to connect and
857 * disconnect are serialized by the input core
859 evdev_table[evdev->minor] = evdev;
863 static void evdev_remove_chrdev(struct evdev *evdev)
866 * Lock evdev table to prevent race with evdev_open()
868 mutex_lock(&evdev_table_mutex);
869 evdev_table[evdev->minor] = NULL;
870 mutex_unlock(&evdev_table_mutex);
874 * Mark device non-existent. This disables writes, ioctls and
875 * prevents new users from opening the device. Already posted
876 * blocking reads will stay, however new ones will fail.
878 static void evdev_mark_dead(struct evdev *evdev)
880 mutex_lock(&evdev->mutex);
881 evdev->exist = false;
882 mutex_unlock(&evdev->mutex);
885 static void evdev_cleanup(struct evdev *evdev)
887 struct input_handle *handle = &evdev->handle;
889 evdev_mark_dead(evdev);
891 evdev_remove_chrdev(evdev);
893 /* evdev is marked dead so no one else accesses evdev->open */
895 input_flush_device(handle, NULL);
896 input_close_device(handle);
901 * Create new evdev device. Note that input core serializes calls
902 * to connect and disconnect so we don't need to lock evdev_table here.
904 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
905 const struct input_device_id *id)
911 for (minor = 0; minor < EVDEV_MINORS; minor++)
912 if (!evdev_table[minor])
915 if (minor == EVDEV_MINORS) {
916 pr_err("no more free evdev devices\n");
920 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
924 INIT_LIST_HEAD(&evdev->client_list);
925 spin_lock_init(&evdev->client_lock);
926 mutex_init(&evdev->mutex);
927 init_waitqueue_head(&evdev->wait);
929 dev_set_name(&evdev->dev, "event%d", minor);
931 evdev->minor = minor;
933 evdev->handle.dev = input_get_device(dev);
934 evdev->handle.name = dev_name(&evdev->dev);
935 evdev->handle.handler = handler;
936 evdev->handle.private = evdev;
938 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
939 evdev->dev.class = &input_class;
940 evdev->dev.parent = &dev->dev;
941 evdev->dev.release = evdev_free;
942 device_initialize(&evdev->dev);
944 error = input_register_handle(&evdev->handle);
948 error = evdev_install_chrdev(evdev);
950 goto err_unregister_handle;
952 error = device_add(&evdev->dev);
954 goto err_cleanup_evdev;
959 evdev_cleanup(evdev);
960 err_unregister_handle:
961 input_unregister_handle(&evdev->handle);
963 put_device(&evdev->dev);
967 static void evdev_disconnect(struct input_handle *handle)
969 struct evdev *evdev = handle->private;
971 device_del(&evdev->dev);
972 evdev_cleanup(evdev);
973 input_unregister_handle(handle);
974 put_device(&evdev->dev);
977 static const struct input_device_id evdev_ids[] = {
978 { .driver_info = 1 }, /* Matches all devices */
979 { }, /* Terminating zero entry */
982 MODULE_DEVICE_TABLE(input, evdev_ids);
984 static struct input_handler evdev_handler = {
985 .event = evdev_event,
986 .connect = evdev_connect,
987 .disconnect = evdev_disconnect,
989 .minor = EVDEV_MINOR_BASE,
991 .id_table = evdev_ids,
994 static int __init evdev_init(void)
996 return input_register_handler(&evdev_handler);
999 static void __exit evdev_exit(void)
1001 input_unregister_handler(&evdev_handler);
1004 module_init(evdev_init);
1005 module_exit(evdev_exit);
1008 MODULE_DESCRIPTION("Input driver event char devices");
1009 MODULE_LICENSE("GPL");