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 EVDEV_MINOR_BASE 64
12 #define EVDEV_MINORS 32
13 #define EVDEV_BUFFER_SIZE 64
15 #include <linux/poll.h>
16 #include <linux/sched.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/input.h>
21 #include <linux/major.h>
22 #include <linux/device.h>
23 #include "input-compat.h"
29 struct input_handle handle;
30 wait_queue_head_t wait;
31 struct evdev_client *grab;
32 struct list_head client_list;
33 spinlock_t client_lock; /* protects client_list */
39 struct input_event buffer[EVDEV_BUFFER_SIZE];
42 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
43 struct fasync_struct *fasync;
45 struct list_head node;
48 static struct evdev *evdev_table[EVDEV_MINORS];
49 static DEFINE_MUTEX(evdev_table_mutex);
51 static void evdev_pass_event(struct evdev_client *client,
52 struct input_event *event)
55 * Interrupts are disabled, just acquire the lock
57 spin_lock(&client->buffer_lock);
58 client->buffer[client->head++] = *event;
59 client->head &= EVDEV_BUFFER_SIZE - 1;
60 spin_unlock(&client->buffer_lock);
62 if (event->type == EV_SYN)
63 kill_fasync(&client->fasync, SIGIO, POLL_IN);
67 * Pass incoming event to all connected clients.
69 static void evdev_event(struct input_handle *handle,
70 unsigned int type, unsigned int code, int value)
72 struct evdev *evdev = handle->private;
73 struct evdev_client *client;
74 struct input_event event;
76 do_gettimeofday(&event.time);
83 client = rcu_dereference(evdev->grab);
85 evdev_pass_event(client, &event);
87 list_for_each_entry_rcu(client, &evdev->client_list, node)
88 evdev_pass_event(client, &event);
92 wake_up_interruptible(&evdev->wait);
95 static int evdev_fasync(int fd, struct file *file, int on)
97 struct evdev_client *client = file->private_data;
99 return fasync_helper(fd, file, on, &client->fasync);
102 static int evdev_flush(struct file *file, fl_owner_t id)
104 struct evdev_client *client = file->private_data;
105 struct evdev *evdev = client->evdev;
108 retval = mutex_lock_interruptible(&evdev->mutex);
115 retval = input_flush_device(&evdev->handle, file);
117 mutex_unlock(&evdev->mutex);
121 static void evdev_free(struct device *dev)
123 struct evdev *evdev = container_of(dev, struct evdev, dev);
125 input_put_device(evdev->handle.dev);
130 * Grabs an event device (along with underlying input device).
131 * This function is called with evdev->mutex taken.
133 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
140 error = input_grab_device(&evdev->handle);
144 rcu_assign_pointer(evdev->grab, client);
150 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
152 if (evdev->grab != client)
155 rcu_assign_pointer(evdev->grab, NULL);
157 input_release_device(&evdev->handle);
162 static void evdev_attach_client(struct evdev *evdev,
163 struct evdev_client *client)
165 spin_lock(&evdev->client_lock);
166 list_add_tail_rcu(&client->node, &evdev->client_list);
167 spin_unlock(&evdev->client_lock);
171 static void evdev_detach_client(struct evdev *evdev,
172 struct evdev_client *client)
174 spin_lock(&evdev->client_lock);
175 list_del_rcu(&client->node);
176 spin_unlock(&evdev->client_lock);
180 static int evdev_open_device(struct evdev *evdev)
184 retval = mutex_lock_interruptible(&evdev->mutex);
190 else if (!evdev->open++) {
191 retval = input_open_device(&evdev->handle);
196 mutex_unlock(&evdev->mutex);
200 static void evdev_close_device(struct evdev *evdev)
202 mutex_lock(&evdev->mutex);
204 if (evdev->exist && !--evdev->open)
205 input_close_device(&evdev->handle);
207 mutex_unlock(&evdev->mutex);
211 * Wake up users waiting for IO so they can disconnect from
214 static void evdev_hangup(struct evdev *evdev)
216 struct evdev_client *client;
218 spin_lock(&evdev->client_lock);
219 list_for_each_entry(client, &evdev->client_list, node)
220 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
221 spin_unlock(&evdev->client_lock);
223 wake_up_interruptible(&evdev->wait);
226 static int evdev_release(struct inode *inode, struct file *file)
228 struct evdev_client *client = file->private_data;
229 struct evdev *evdev = client->evdev;
231 mutex_lock(&evdev->mutex);
232 if (evdev->grab == client)
233 evdev_ungrab(evdev, client);
234 mutex_unlock(&evdev->mutex);
236 evdev_detach_client(evdev, client);
239 evdev_close_device(evdev);
240 put_device(&evdev->dev);
245 static int evdev_open(struct inode *inode, struct file *file)
248 struct evdev_client *client;
249 int i = iminor(inode) - EVDEV_MINOR_BASE;
252 if (i >= EVDEV_MINORS)
255 error = mutex_lock_interruptible(&evdev_table_mutex);
258 evdev = evdev_table[i];
260 get_device(&evdev->dev);
261 mutex_unlock(&evdev_table_mutex);
266 client = kzalloc(sizeof(struct evdev_client), GFP_KERNEL);
272 spin_lock_init(&client->buffer_lock);
273 client->evdev = evdev;
274 evdev_attach_client(evdev, client);
276 error = evdev_open_device(evdev);
278 goto err_free_client;
280 file->private_data = client;
281 nonseekable_open(inode, file);
286 evdev_detach_client(evdev, client);
289 put_device(&evdev->dev);
293 static ssize_t evdev_write(struct file *file, const char __user *buffer,
294 size_t count, loff_t *ppos)
296 struct evdev_client *client = file->private_data;
297 struct evdev *evdev = client->evdev;
298 struct input_event event;
301 retval = mutex_lock_interruptible(&evdev->mutex);
310 while (retval < count) {
312 if (input_event_from_user(buffer + retval, &event)) {
317 input_inject_event(&evdev->handle,
318 event.type, event.code, event.value);
319 retval += input_event_size();
323 mutex_unlock(&evdev->mutex);
327 static int evdev_fetch_next_event(struct evdev_client *client,
328 struct input_event *event)
332 spin_lock_irq(&client->buffer_lock);
334 have_event = client->head != client->tail;
336 *event = client->buffer[client->tail++];
337 client->tail &= EVDEV_BUFFER_SIZE - 1;
340 spin_unlock_irq(&client->buffer_lock);
345 static ssize_t evdev_read(struct file *file, char __user *buffer,
346 size_t count, loff_t *ppos)
348 struct evdev_client *client = file->private_data;
349 struct evdev *evdev = client->evdev;
350 struct input_event event;
353 if (count < input_event_size())
356 if (client->head == client->tail && evdev->exist &&
357 (file->f_flags & O_NONBLOCK))
360 retval = wait_event_interruptible(evdev->wait,
361 client->head != client->tail || !evdev->exist);
368 while (retval + input_event_size() <= count &&
369 evdev_fetch_next_event(client, &event)) {
371 if (input_event_to_user(buffer + retval, &event))
374 retval += input_event_size();
380 /* No kernel lock - fine */
381 static unsigned int evdev_poll(struct file *file, poll_table *wait)
383 struct evdev_client *client = file->private_data;
384 struct evdev *evdev = client->evdev;
386 poll_wait(file, &evdev->wait, wait);
387 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
388 (evdev->exist ? 0 : (POLLHUP | POLLERR));
393 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
394 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
397 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
398 unsigned int maxlen, void __user *p, int compat)
403 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
407 for (i = 0; i < len / sizeof(compat_long_t); i++)
408 if (copy_to_user((compat_long_t __user *) p + i,
409 (compat_long_t *) bits +
410 i + 1 - ((i % 2) << 1),
411 sizeof(compat_long_t)))
414 len = BITS_TO_LONGS(maxbit) * sizeof(long);
418 if (copy_to_user(p, bits, len))
425 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
426 unsigned int maxlen, void __user *p, int compat)
429 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
430 BITS_TO_LONGS(maxbit) * sizeof(long);
435 return copy_to_user(p, bits, len) ? -EFAULT : len;
437 #endif /* __BIG_ENDIAN */
441 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
442 unsigned int maxlen, void __user *p, int compat)
444 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
449 return copy_to_user(p, bits, len) ? -EFAULT : len;
452 #endif /* CONFIG_COMPAT */
454 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
461 len = strlen(str) + 1;
465 return copy_to_user(p, str, len) ? -EFAULT : len;
468 #define OLD_KEY_MAX 0x1ff
469 static int handle_eviocgbit(struct input_dev *dev, unsigned int cmd, void __user *p, int compat_mode)
471 static unsigned long keymax_warn_time;
475 switch (_IOC_NR(cmd) & EV_MAX) {
477 case 0: bits = dev->evbit; len = EV_MAX; break;
478 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
479 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
480 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
481 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
482 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
483 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
484 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
485 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
486 default: return -EINVAL;
490 * Work around bugs in userspace programs that like to do
491 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
492 * should be in bytes, not in bits.
494 if ((_IOC_NR(cmd) & EV_MAX) == EV_KEY && _IOC_SIZE(cmd) == OLD_KEY_MAX) {
496 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
498 "evdev.c(EVIOCGBIT): Suspicious buffer size %u, "
499 "limiting output to %zu bytes. See "
500 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
502 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
505 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
509 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
510 void __user *p, int compat_mode)
512 struct evdev_client *client = file->private_data;
513 struct evdev *evdev = client->evdev;
514 struct input_dev *dev = evdev->handle.dev;
515 struct input_absinfo abs;
516 struct ff_effect effect;
517 int __user *ip = (int __user *)p;
518 unsigned int i, t, u, v;
524 return put_user(EV_VERSION, ip);
527 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
532 if (!test_bit(EV_REP, dev->evbit))
534 if (put_user(dev->rep[REP_DELAY], ip))
536 if (put_user(dev->rep[REP_PERIOD], ip + 1))
541 if (!test_bit(EV_REP, dev->evbit))
545 if (get_user(v, ip + 1))
548 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
549 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
557 error = input_get_keycode(dev, t, &v);
561 if (put_user(v, ip + 1))
567 if (get_user(t, ip) || get_user(v, ip + 1))
570 return input_set_keycode(dev, t, v);
573 return input_ff_erase(dev, (int)(unsigned long) p, file);
576 i = test_bit(EV_FF, dev->evbit) ?
577 dev->ff->max_effects : 0;
584 return evdev_grab(evdev, client);
586 return evdev_ungrab(evdev, client);
590 if (_IOC_TYPE(cmd) != 'E')
593 if (_IOC_DIR(cmd) == _IOC_READ) {
595 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
596 return handle_eviocgbit(dev, cmd, p, compat_mode);
598 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
599 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
602 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
603 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
606 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
607 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
610 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
611 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
614 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
615 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
617 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
618 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
620 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
621 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
623 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
625 t = _IOC_NR(cmd) & ABS_MAX;
627 abs.value = dev->abs[t];
628 abs.minimum = dev->absmin[t];
629 abs.maximum = dev->absmax[t];
630 abs.fuzz = dev->absfuzz[t];
631 abs.flat = dev->absflat[t];
632 abs.resolution = dev->absres[t];
634 if (copy_to_user(p, &abs, min_t(size_t,
636 sizeof(struct input_absinfo))))
644 if (_IOC_DIR(cmd) == _IOC_WRITE) {
646 if (_IOC_NR(cmd) == _IOC_NR(EVIOCSFF)) {
648 if (input_ff_effect_from_user(p, _IOC_SIZE(cmd), &effect))
651 error = input_ff_upload(dev, &effect, file);
653 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
659 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
661 t = _IOC_NR(cmd) & ABS_MAX;
663 if (copy_from_user(&abs, p, min_t(size_t,
665 sizeof(struct input_absinfo))))
669 * Take event lock to ensure that we are not
670 * changing device parameters in the middle
673 spin_lock_irq(&dev->event_lock);
675 dev->abs[t] = abs.value;
676 dev->absmin[t] = abs.minimum;
677 dev->absmax[t] = abs.maximum;
678 dev->absfuzz[t] = abs.fuzz;
679 dev->absflat[t] = abs.flat;
680 dev->absres[t] = _IOC_SIZE(cmd) < sizeof(struct input_absinfo) ?
683 spin_unlock_irq(&dev->event_lock);
692 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
693 void __user *p, int compat_mode)
695 struct evdev_client *client = file->private_data;
696 struct evdev *evdev = client->evdev;
699 retval = mutex_lock_interruptible(&evdev->mutex);
708 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
711 mutex_unlock(&evdev->mutex);
715 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
717 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
721 static long evdev_ioctl_compat(struct file *file,
722 unsigned int cmd, unsigned long arg)
724 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
728 static const struct file_operations evdev_fops = {
729 .owner = THIS_MODULE,
731 .write = evdev_write,
734 .release = evdev_release,
735 .unlocked_ioctl = evdev_ioctl,
737 .compat_ioctl = evdev_ioctl_compat,
739 .fasync = evdev_fasync,
743 static int evdev_install_chrdev(struct evdev *evdev)
746 * No need to do any locking here as calls to connect and
747 * disconnect are serialized by the input core
749 evdev_table[evdev->minor] = evdev;
753 static void evdev_remove_chrdev(struct evdev *evdev)
756 * Lock evdev table to prevent race with evdev_open()
758 mutex_lock(&evdev_table_mutex);
759 evdev_table[evdev->minor] = NULL;
760 mutex_unlock(&evdev_table_mutex);
764 * Mark device non-existent. This disables writes, ioctls and
765 * prevents new users from opening the device. Already posted
766 * blocking reads will stay, however new ones will fail.
768 static void evdev_mark_dead(struct evdev *evdev)
770 mutex_lock(&evdev->mutex);
772 mutex_unlock(&evdev->mutex);
775 static void evdev_cleanup(struct evdev *evdev)
777 struct input_handle *handle = &evdev->handle;
779 evdev_mark_dead(evdev);
781 evdev_remove_chrdev(evdev);
783 /* evdev is marked dead so no one else accesses evdev->open */
785 input_flush_device(handle, NULL);
786 input_close_device(handle);
791 * Create new evdev device. Note that input core serializes calls
792 * to connect and disconnect so we don't need to lock evdev_table here.
794 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
795 const struct input_device_id *id)
801 for (minor = 0; minor < EVDEV_MINORS; minor++)
802 if (!evdev_table[minor])
805 if (minor == EVDEV_MINORS) {
806 printk(KERN_ERR "evdev: no more free evdev devices\n");
810 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
814 INIT_LIST_HEAD(&evdev->client_list);
815 spin_lock_init(&evdev->client_lock);
816 mutex_init(&evdev->mutex);
817 init_waitqueue_head(&evdev->wait);
819 dev_set_name(&evdev->dev, "event%d", minor);
821 evdev->minor = minor;
823 evdev->handle.dev = input_get_device(dev);
824 evdev->handle.name = dev_name(&evdev->dev);
825 evdev->handle.handler = handler;
826 evdev->handle.private = evdev;
828 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
829 evdev->dev.class = &input_class;
830 evdev->dev.parent = &dev->dev;
831 evdev->dev.release = evdev_free;
832 device_initialize(&evdev->dev);
834 error = input_register_handle(&evdev->handle);
838 error = evdev_install_chrdev(evdev);
840 goto err_unregister_handle;
842 error = device_add(&evdev->dev);
844 goto err_cleanup_evdev;
849 evdev_cleanup(evdev);
850 err_unregister_handle:
851 input_unregister_handle(&evdev->handle);
853 put_device(&evdev->dev);
857 static void evdev_disconnect(struct input_handle *handle)
859 struct evdev *evdev = handle->private;
861 device_del(&evdev->dev);
862 evdev_cleanup(evdev);
863 input_unregister_handle(handle);
864 put_device(&evdev->dev);
867 static const struct input_device_id evdev_ids[] = {
868 { .driver_info = 1 }, /* Matches all devices */
869 { }, /* Terminating zero entry */
872 MODULE_DEVICE_TABLE(input, evdev_ids);
874 static struct input_handler evdev_handler = {
875 .event = evdev_event,
876 .connect = evdev_connect,
877 .disconnect = evdev_disconnect,
879 .minor = EVDEV_MINOR_BASE,
881 .id_table = evdev_ids,
884 static int __init evdev_init(void)
886 return input_register_handler(&evdev_handler);
889 static void __exit evdev_exit(void)
891 input_unregister_handler(&evdev_handler);
894 module_init(evdev_init);
895 module_exit(evdev_exit);
898 MODULE_DESCRIPTION("Input driver event char devices");
899 MODULE_LICENSE("GPL");