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)
59 * Interrupts are disabled, just acquire the lock.
60 * Make sure we don't leave with the client buffer
61 * "empty" by having client->head == client->tail.
63 spin_lock(&client->buffer_lock);
65 client->buffer[client->head++] = *event;
66 client->head &= client->bufsize - 1;
67 } while (client->head == client->tail);
68 spin_unlock(&client->buffer_lock);
70 if (event->type == EV_SYN)
71 kill_fasync(&client->fasync, SIGIO, POLL_IN);
75 * Pass incoming event to all connected clients.
77 static void evdev_event(struct input_handle *handle,
78 unsigned int type, unsigned int code, int value)
80 struct evdev *evdev = handle->private;
81 struct evdev_client *client;
82 struct input_event event;
84 do_gettimeofday(&event.time);
91 client = rcu_dereference(evdev->grab);
93 evdev_pass_event(client, &event);
95 list_for_each_entry_rcu(client, &evdev->client_list, node)
96 evdev_pass_event(client, &event);
100 wake_up_interruptible(&evdev->wait);
103 static int evdev_fasync(int fd, struct file *file, int on)
105 struct evdev_client *client = file->private_data;
107 return fasync_helper(fd, file, on, &client->fasync);
110 static int evdev_flush(struct file *file, fl_owner_t id)
112 struct evdev_client *client = file->private_data;
113 struct evdev *evdev = client->evdev;
116 retval = mutex_lock_interruptible(&evdev->mutex);
123 retval = input_flush_device(&evdev->handle, file);
125 mutex_unlock(&evdev->mutex);
129 static void evdev_free(struct device *dev)
131 struct evdev *evdev = container_of(dev, struct evdev, dev);
133 input_put_device(evdev->handle.dev);
138 * Grabs an event device (along with underlying input device).
139 * This function is called with evdev->mutex taken.
141 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
148 error = input_grab_device(&evdev->handle);
152 rcu_assign_pointer(evdev->grab, client);
158 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
160 if (evdev->grab != client)
163 rcu_assign_pointer(evdev->grab, NULL);
165 input_release_device(&evdev->handle);
170 static void evdev_attach_client(struct evdev *evdev,
171 struct evdev_client *client)
173 spin_lock(&evdev->client_lock);
174 list_add_tail_rcu(&client->node, &evdev->client_list);
175 spin_unlock(&evdev->client_lock);
179 static void evdev_detach_client(struct evdev *evdev,
180 struct evdev_client *client)
182 spin_lock(&evdev->client_lock);
183 list_del_rcu(&client->node);
184 spin_unlock(&evdev->client_lock);
188 static int evdev_open_device(struct evdev *evdev)
192 retval = mutex_lock_interruptible(&evdev->mutex);
198 else if (!evdev->open++) {
199 retval = input_open_device(&evdev->handle);
204 mutex_unlock(&evdev->mutex);
208 static void evdev_close_device(struct evdev *evdev)
210 mutex_lock(&evdev->mutex);
212 if (evdev->exist && !--evdev->open)
213 input_close_device(&evdev->handle);
215 mutex_unlock(&evdev->mutex);
219 * Wake up users waiting for IO so they can disconnect from
222 static void evdev_hangup(struct evdev *evdev)
224 struct evdev_client *client;
226 spin_lock(&evdev->client_lock);
227 list_for_each_entry(client, &evdev->client_list, node)
228 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
229 spin_unlock(&evdev->client_lock);
231 wake_up_interruptible(&evdev->wait);
234 static int evdev_release(struct inode *inode, struct file *file)
236 struct evdev_client *client = file->private_data;
237 struct evdev *evdev = client->evdev;
239 mutex_lock(&evdev->mutex);
240 if (evdev->grab == client)
241 evdev_ungrab(evdev, client);
242 mutex_unlock(&evdev->mutex);
244 evdev_detach_client(evdev, client);
247 evdev_close_device(evdev);
248 put_device(&evdev->dev);
253 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
255 unsigned int n_events =
256 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
257 EVDEV_MIN_BUFFER_SIZE);
259 return roundup_pow_of_two(n_events);
262 static int evdev_open(struct inode *inode, struct file *file)
265 struct evdev_client *client;
266 int i = iminor(inode) - EVDEV_MINOR_BASE;
267 unsigned int bufsize;
270 if (i >= EVDEV_MINORS)
273 error = mutex_lock_interruptible(&evdev_table_mutex);
276 evdev = evdev_table[i];
278 get_device(&evdev->dev);
279 mutex_unlock(&evdev_table_mutex);
284 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
286 client = kzalloc(sizeof(struct evdev_client) +
287 bufsize * sizeof(struct input_event),
294 client->bufsize = bufsize;
295 spin_lock_init(&client->buffer_lock);
296 client->evdev = evdev;
297 evdev_attach_client(evdev, client);
299 error = evdev_open_device(evdev);
301 goto err_free_client;
303 file->private_data = client;
304 nonseekable_open(inode, file);
309 evdev_detach_client(evdev, client);
312 put_device(&evdev->dev);
316 static ssize_t evdev_write(struct file *file, const char __user *buffer,
317 size_t count, loff_t *ppos)
319 struct evdev_client *client = file->private_data;
320 struct evdev *evdev = client->evdev;
321 struct input_event event;
324 if (count < input_event_size())
327 retval = mutex_lock_interruptible(&evdev->mutex);
337 if (input_event_from_user(buffer + retval, &event)) {
341 retval += input_event_size();
343 input_inject_event(&evdev->handle,
344 event.type, event.code, event.value);
345 } while (retval + input_event_size() <= count);
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))
399 retval += input_event_size();
405 /* No kernel lock - fine */
406 static unsigned int evdev_poll(struct file *file, poll_table *wait)
408 struct evdev_client *client = file->private_data;
409 struct evdev *evdev = client->evdev;
412 poll_wait(file, &evdev->wait, wait);
414 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
415 if (client->head != client->tail)
416 mask |= POLLIN | POLLRDNORM;
423 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
424 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
427 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
428 unsigned int maxlen, void __user *p, int compat)
433 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
437 for (i = 0; i < len / sizeof(compat_long_t); i++)
438 if (copy_to_user((compat_long_t __user *) p + i,
439 (compat_long_t *) bits +
440 i + 1 - ((i % 2) << 1),
441 sizeof(compat_long_t)))
444 len = BITS_TO_LONGS(maxbit) * sizeof(long);
448 if (copy_to_user(p, bits, len))
455 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
456 unsigned int maxlen, void __user *p, int compat)
459 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
460 BITS_TO_LONGS(maxbit) * sizeof(long);
465 return copy_to_user(p, bits, len) ? -EFAULT : len;
467 #endif /* __BIG_ENDIAN */
471 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
472 unsigned int maxlen, void __user *p, int compat)
474 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
479 return copy_to_user(p, bits, len) ? -EFAULT : len;
482 #endif /* CONFIG_COMPAT */
484 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
491 len = strlen(str) + 1;
495 return copy_to_user(p, str, len) ? -EFAULT : len;
498 #define OLD_KEY_MAX 0x1ff
499 static int handle_eviocgbit(struct input_dev *dev,
500 unsigned int type, unsigned int size,
501 void __user *p, int compat_mode)
503 static unsigned long keymax_warn_time;
509 case 0: bits = dev->evbit; len = EV_MAX; break;
510 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
511 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
512 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
513 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
514 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
515 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
516 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
517 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
518 default: return -EINVAL;
522 * Work around bugs in userspace programs that like to do
523 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
524 * should be in bytes, not in bits.
526 if (type == EV_KEY && size == OLD_KEY_MAX) {
528 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
529 pr_warning("(EVIOCGBIT): Suspicious buffer size %u, "
530 "limiting output to %zu bytes. See "
531 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
533 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
536 return bits_to_user(bits, len, size, p, compat_mode);
540 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
542 struct input_keymap_entry ke = {
543 .len = sizeof(unsigned int),
546 int __user *ip = (int __user *)p;
550 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
553 error = input_get_keycode(dev, &ke);
557 if (put_user(ke.keycode, ip + 1))
563 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
565 struct input_keymap_entry ke;
568 if (copy_from_user(&ke, p, sizeof(ke)))
571 error = input_get_keycode(dev, &ke);
575 if (copy_to_user(p, &ke, sizeof(ke)))
581 static int evdev_handle_set_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;
589 if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
592 if (get_user(ke.keycode, ip + 1))
595 return input_set_keycode(dev, &ke);
598 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
600 struct input_keymap_entry ke;
602 if (copy_from_user(&ke, p, sizeof(ke)))
605 if (ke.len > sizeof(ke.scancode))
608 return input_set_keycode(dev, &ke);
611 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
612 void __user *p, int compat_mode)
614 struct evdev_client *client = file->private_data;
615 struct evdev *evdev = client->evdev;
616 struct input_dev *dev = evdev->handle.dev;
617 struct input_absinfo abs;
618 struct ff_effect effect;
619 int __user *ip = (int __user *)p;
620 unsigned int i, t, u, v;
624 /* First we check for fixed-length commands */
628 return put_user(EV_VERSION, ip);
631 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
636 if (!test_bit(EV_REP, dev->evbit))
638 if (put_user(dev->rep[REP_DELAY], ip))
640 if (put_user(dev->rep[REP_PERIOD], ip + 1))
645 if (!test_bit(EV_REP, dev->evbit))
649 if (get_user(v, ip + 1))
652 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
653 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
658 return input_ff_erase(dev, (int)(unsigned long) p, file);
661 i = test_bit(EV_FF, dev->evbit) ?
662 dev->ff->max_effects : 0;
669 return evdev_grab(evdev, client);
671 return evdev_ungrab(evdev, client);
674 return evdev_handle_get_keycode(dev, p);
677 return evdev_handle_set_keycode(dev, p);
679 case EVIOCGKEYCODE_V2:
680 return evdev_handle_get_keycode_v2(dev, p);
682 case EVIOCSKEYCODE_V2:
683 return evdev_handle_set_keycode_v2(dev, p);
686 size = _IOC_SIZE(cmd);
688 /* Now check variable-length commands */
689 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
690 switch (EVIOC_MASK_SIZE(cmd)) {
693 return bits_to_user(dev->propbit, INPUT_PROP_MAX,
694 size, p, compat_mode);
697 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
700 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
703 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
706 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
709 return str_to_user(dev->name, size, p);
712 return str_to_user(dev->phys, size, p);
715 return str_to_user(dev->uniq, size, p);
717 case EVIOC_MASK_SIZE(EVIOCSFF):
718 if (input_ff_effect_from_user(p, size, &effect))
721 error = input_ff_upload(dev, &effect, file);
723 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
729 /* Multi-number variable-length handlers */
730 if (_IOC_TYPE(cmd) != 'E')
733 if (_IOC_DIR(cmd) == _IOC_READ) {
735 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
736 return handle_eviocgbit(dev,
737 _IOC_NR(cmd) & EV_MAX, size,
740 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
745 t = _IOC_NR(cmd) & ABS_MAX;
746 abs = dev->absinfo[t];
748 if (copy_to_user(p, &abs, min_t(size_t,
749 size, sizeof(struct input_absinfo))))
756 if (_IOC_DIR(cmd) == _IOC_WRITE) {
758 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
763 t = _IOC_NR(cmd) & ABS_MAX;
765 if (copy_from_user(&abs, p, min_t(size_t,
766 size, sizeof(struct input_absinfo))))
769 if (size < sizeof(struct input_absinfo))
772 /* We can't change number of reserved MT slots */
773 if (t == ABS_MT_SLOT)
777 * Take event lock to ensure that we are not
778 * changing device parameters in the middle
781 spin_lock_irq(&dev->event_lock);
782 dev->absinfo[t] = abs;
783 spin_unlock_irq(&dev->event_lock);
792 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
793 void __user *p, int compat_mode)
795 struct evdev_client *client = file->private_data;
796 struct evdev *evdev = client->evdev;
799 retval = mutex_lock_interruptible(&evdev->mutex);
808 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
811 mutex_unlock(&evdev->mutex);
815 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
817 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
821 static long evdev_ioctl_compat(struct file *file,
822 unsigned int cmd, unsigned long arg)
824 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
828 static const struct file_operations evdev_fops = {
829 .owner = THIS_MODULE,
831 .write = evdev_write,
834 .release = evdev_release,
835 .unlocked_ioctl = evdev_ioctl,
837 .compat_ioctl = evdev_ioctl_compat,
839 .fasync = evdev_fasync,
840 .flush = evdev_flush,
844 static int evdev_install_chrdev(struct evdev *evdev)
847 * No need to do any locking here as calls to connect and
848 * disconnect are serialized by the input core
850 evdev_table[evdev->minor] = evdev;
854 static void evdev_remove_chrdev(struct evdev *evdev)
857 * Lock evdev table to prevent race with evdev_open()
859 mutex_lock(&evdev_table_mutex);
860 evdev_table[evdev->minor] = NULL;
861 mutex_unlock(&evdev_table_mutex);
865 * Mark device non-existent. This disables writes, ioctls and
866 * prevents new users from opening the device. Already posted
867 * blocking reads will stay, however new ones will fail.
869 static void evdev_mark_dead(struct evdev *evdev)
871 mutex_lock(&evdev->mutex);
872 evdev->exist = false;
873 mutex_unlock(&evdev->mutex);
876 static void evdev_cleanup(struct evdev *evdev)
878 struct input_handle *handle = &evdev->handle;
880 evdev_mark_dead(evdev);
882 evdev_remove_chrdev(evdev);
884 /* evdev is marked dead so no one else accesses evdev->open */
886 input_flush_device(handle, NULL);
887 input_close_device(handle);
892 * Create new evdev device. Note that input core serializes calls
893 * to connect and disconnect so we don't need to lock evdev_table here.
895 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
896 const struct input_device_id *id)
902 for (minor = 0; minor < EVDEV_MINORS; minor++)
903 if (!evdev_table[minor])
906 if (minor == EVDEV_MINORS) {
907 pr_err("no more free evdev devices\n");
911 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
915 INIT_LIST_HEAD(&evdev->client_list);
916 spin_lock_init(&evdev->client_lock);
917 mutex_init(&evdev->mutex);
918 init_waitqueue_head(&evdev->wait);
920 dev_set_name(&evdev->dev, "event%d", minor);
922 evdev->minor = minor;
924 evdev->handle.dev = input_get_device(dev);
925 evdev->handle.name = dev_name(&evdev->dev);
926 evdev->handle.handler = handler;
927 evdev->handle.private = evdev;
929 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
930 evdev->dev.class = &input_class;
931 evdev->dev.parent = &dev->dev;
932 evdev->dev.release = evdev_free;
933 device_initialize(&evdev->dev);
935 error = input_register_handle(&evdev->handle);
939 error = evdev_install_chrdev(evdev);
941 goto err_unregister_handle;
943 error = device_add(&evdev->dev);
945 goto err_cleanup_evdev;
950 evdev_cleanup(evdev);
951 err_unregister_handle:
952 input_unregister_handle(&evdev->handle);
954 put_device(&evdev->dev);
958 static void evdev_disconnect(struct input_handle *handle)
960 struct evdev *evdev = handle->private;
962 device_del(&evdev->dev);
963 evdev_cleanup(evdev);
964 input_unregister_handle(handle);
965 put_device(&evdev->dev);
968 static const struct input_device_id evdev_ids[] = {
969 { .driver_info = 1 }, /* Matches all devices */
970 { }, /* Terminating zero entry */
973 MODULE_DEVICE_TABLE(input, evdev_ids);
975 static struct input_handler evdev_handler = {
976 .event = evdev_event,
977 .connect = evdev_connect,
978 .disconnect = evdev_disconnect,
980 .minor = EVDEV_MINOR_BASE,
982 .id_table = evdev_ids,
985 static int __init evdev_init(void)
987 return input_register_handler(&evdev_handler);
990 static void __exit evdev_exit(void)
992 input_unregister_handler(&evdev_handler);
995 module_init(evdev_init);
996 module_exit(evdev_exit);
999 MODULE_DESCRIPTION("Input driver event char devices");
1000 MODULE_LICENSE("GPL");