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/slab.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/input.h>
20 #include <linux/major.h>
21 #include <linux/device.h>
22 #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 kill_fasync(&client->fasync, SIGIO, POLL_IN);
66 * Pass incoming event to all connected clients.
68 static void evdev_event(struct input_handle *handle,
69 unsigned int type, unsigned int code, int value)
71 struct evdev *evdev = handle->private;
72 struct evdev_client *client;
73 struct input_event event;
75 do_gettimeofday(&event.time);
82 client = rcu_dereference(evdev->grab);
84 evdev_pass_event(client, &event);
86 list_for_each_entry_rcu(client, &evdev->client_list, node)
87 evdev_pass_event(client, &event);
91 wake_up_interruptible(&evdev->wait);
94 static int evdev_fasync(int fd, struct file *file, int on)
96 struct evdev_client *client = file->private_data;
99 retval = fasync_helper(fd, file, on, &client->fasync);
101 return retval < 0 ? retval : 0;
104 static int evdev_flush(struct file *file, fl_owner_t id)
106 struct evdev_client *client = file->private_data;
107 struct evdev *evdev = client->evdev;
110 retval = mutex_lock_interruptible(&evdev->mutex);
117 retval = input_flush_device(&evdev->handle, file);
119 mutex_unlock(&evdev->mutex);
123 static void evdev_free(struct device *dev)
125 struct evdev *evdev = container_of(dev, struct evdev, dev);
127 input_put_device(evdev->handle.dev);
132 * Grabs an event device (along with underlying input device).
133 * This function is called with evdev->mutex taken.
135 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
142 error = input_grab_device(&evdev->handle);
146 rcu_assign_pointer(evdev->grab, client);
152 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
154 if (evdev->grab != client)
157 rcu_assign_pointer(evdev->grab, NULL);
159 input_release_device(&evdev->handle);
164 static void evdev_attach_client(struct evdev *evdev,
165 struct evdev_client *client)
167 spin_lock(&evdev->client_lock);
168 list_add_tail_rcu(&client->node, &evdev->client_list);
169 spin_unlock(&evdev->client_lock);
173 static void evdev_detach_client(struct evdev *evdev,
174 struct evdev_client *client)
176 spin_lock(&evdev->client_lock);
177 list_del_rcu(&client->node);
178 spin_unlock(&evdev->client_lock);
182 static int evdev_open_device(struct evdev *evdev)
186 retval = mutex_lock_interruptible(&evdev->mutex);
192 else if (!evdev->open++) {
193 retval = input_open_device(&evdev->handle);
198 mutex_unlock(&evdev->mutex);
202 static void evdev_close_device(struct evdev *evdev)
204 mutex_lock(&evdev->mutex);
206 if (evdev->exist && !--evdev->open)
207 input_close_device(&evdev->handle);
209 mutex_unlock(&evdev->mutex);
213 * Wake up users waiting for IO so they can disconnect from
216 static void evdev_hangup(struct evdev *evdev)
218 struct evdev_client *client;
220 spin_lock(&evdev->client_lock);
221 list_for_each_entry(client, &evdev->client_list, node)
222 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
223 spin_unlock(&evdev->client_lock);
225 wake_up_interruptible(&evdev->wait);
228 static int evdev_release(struct inode *inode, struct file *file)
230 struct evdev_client *client = file->private_data;
231 struct evdev *evdev = client->evdev;
233 mutex_lock(&evdev->mutex);
234 if (evdev->grab == client)
235 evdev_ungrab(evdev, client);
236 mutex_unlock(&evdev->mutex);
238 evdev_fasync(-1, file, 0);
239 evdev_detach_client(evdev, client);
242 evdev_close_device(evdev);
243 put_device(&evdev->dev);
248 static int evdev_open(struct inode *inode, struct file *file)
251 struct evdev_client *client;
252 int i = iminor(inode) - EVDEV_MINOR_BASE;
255 if (i >= EVDEV_MINORS)
258 error = mutex_lock_interruptible(&evdev_table_mutex);
261 evdev = evdev_table[i];
263 get_device(&evdev->dev);
264 mutex_unlock(&evdev_table_mutex);
269 client = kzalloc(sizeof(struct evdev_client), GFP_KERNEL);
275 spin_lock_init(&client->buffer_lock);
276 client->evdev = evdev;
277 evdev_attach_client(evdev, client);
279 error = evdev_open_device(evdev);
281 goto err_free_client;
283 file->private_data = client;
287 evdev_detach_client(evdev, client);
290 put_device(&evdev->dev);
294 static ssize_t evdev_write(struct file *file, const char __user *buffer,
295 size_t count, loff_t *ppos)
297 struct evdev_client *client = file->private_data;
298 struct evdev *evdev = client->evdev;
299 struct input_event event;
302 retval = mutex_lock_interruptible(&evdev->mutex);
311 while (retval < count) {
313 if (input_event_from_user(buffer + retval, &event)) {
318 input_inject_event(&evdev->handle,
319 event.type, event.code, event.value);
320 retval += input_event_size();
324 mutex_unlock(&evdev->mutex);
328 static int evdev_fetch_next_event(struct evdev_client *client,
329 struct input_event *event)
333 spin_lock_irq(&client->buffer_lock);
335 have_event = client->head != client->tail;
337 *event = client->buffer[client->tail++];
338 client->tail &= EVDEV_BUFFER_SIZE - 1;
341 spin_unlock_irq(&client->buffer_lock);
346 static ssize_t evdev_read(struct file *file, char __user *buffer,
347 size_t count, loff_t *ppos)
349 struct evdev_client *client = file->private_data;
350 struct evdev *evdev = client->evdev;
351 struct input_event event;
354 if (count < input_event_size())
357 if (client->head == client->tail && evdev->exist &&
358 (file->f_flags & O_NONBLOCK))
361 retval = wait_event_interruptible(evdev->wait,
362 client->head != client->tail || !evdev->exist);
369 while (retval + input_event_size() <= count &&
370 evdev_fetch_next_event(client, &event)) {
372 if (input_event_to_user(buffer + retval, &event))
375 retval += input_event_size();
381 /* No kernel lock - fine */
382 static unsigned int evdev_poll(struct file *file, poll_table *wait)
384 struct evdev_client *client = file->private_data;
385 struct evdev *evdev = client->evdev;
387 poll_wait(file, &evdev->wait, wait);
388 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
389 (evdev->exist ? 0 : (POLLHUP | POLLERR));
394 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
395 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
398 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
399 unsigned int maxlen, void __user *p, int compat)
404 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
408 for (i = 0; i < len / sizeof(compat_long_t); i++)
409 if (copy_to_user((compat_long_t __user *) p + i,
410 (compat_long_t *) bits +
411 i + 1 - ((i % 2) << 1),
412 sizeof(compat_long_t)))
415 len = BITS_TO_LONGS(maxbit) * sizeof(long);
419 if (copy_to_user(p, bits, len))
426 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
427 unsigned int maxlen, void __user *p, int compat)
430 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
431 BITS_TO_LONGS(maxbit) * sizeof(long);
436 return copy_to_user(p, bits, len) ? -EFAULT : len;
438 #endif /* __BIG_ENDIAN */
442 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
443 unsigned int maxlen, void __user *p, int compat)
445 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
450 return copy_to_user(p, bits, len) ? -EFAULT : len;
453 #endif /* CONFIG_COMPAT */
455 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
462 len = strlen(str) + 1;
466 return copy_to_user(p, str, len) ? -EFAULT : len;
469 #define OLD_KEY_MAX 0x1ff
470 static int handle_eviocgbit(struct input_dev *dev, unsigned int cmd, void __user *p, int compat_mode)
472 static unsigned long keymax_warn_time;
476 switch (_IOC_NR(cmd) & EV_MAX) {
478 case 0: bits = dev->evbit; len = EV_MAX; break;
479 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
480 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
481 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
482 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
483 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
484 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
485 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
486 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
487 default: return -EINVAL;
491 * Work around bugs in userspace programs that like to do
492 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
493 * should be in bytes, not in bits.
495 if ((_IOC_NR(cmd) & EV_MAX) == EV_KEY && _IOC_SIZE(cmd) == OLD_KEY_MAX) {
497 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
499 "evdev.c(EVIOCGBIT): Suspicious buffer size %u, "
500 "limiting output to %zu bytes. See "
501 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
503 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
506 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
510 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
511 void __user *p, int compat_mode)
513 struct evdev_client *client = file->private_data;
514 struct evdev *evdev = client->evdev;
515 struct input_dev *dev = evdev->handle.dev;
516 struct input_absinfo abs;
517 struct ff_effect effect;
518 int __user *ip = (int __user *)p;
525 return put_user(EV_VERSION, ip);
528 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
533 if (!test_bit(EV_REP, dev->evbit))
535 if (put_user(dev->rep[REP_DELAY], ip))
537 if (put_user(dev->rep[REP_PERIOD], ip + 1))
542 if (!test_bit(EV_REP, dev->evbit))
546 if (get_user(v, ip + 1))
549 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
550 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
558 error = input_get_keycode(dev, t, &v);
562 if (put_user(v, ip + 1))
568 if (get_user(t, ip) || get_user(v, ip + 1))
571 return input_set_keycode(dev, t, v);
574 return input_ff_erase(dev, (int)(unsigned long) p, file);
577 i = test_bit(EV_FF, dev->evbit) ?
578 dev->ff->max_effects : 0;
585 return evdev_grab(evdev, client);
587 return evdev_ungrab(evdev, client);
591 if (_IOC_TYPE(cmd) != 'E')
594 if (_IOC_DIR(cmd) == _IOC_READ) {
596 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
597 return handle_eviocgbit(dev, cmd, p, compat_mode);
599 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
600 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
603 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
604 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
607 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
608 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
611 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
612 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
615 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
616 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
618 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
619 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
621 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
622 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
624 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
626 t = _IOC_NR(cmd) & ABS_MAX;
628 abs.value = dev->abs[t];
629 abs.minimum = dev->absmin[t];
630 abs.maximum = dev->absmax[t];
631 abs.fuzz = dev->absfuzz[t];
632 abs.flat = dev->absflat[t];
634 if (copy_to_user(p, &abs, sizeof(struct input_absinfo)))
642 if (_IOC_DIR(cmd) == _IOC_WRITE) {
644 if (_IOC_NR(cmd) == _IOC_NR(EVIOCSFF)) {
646 if (input_ff_effect_from_user(p, _IOC_SIZE(cmd), &effect))
649 error = input_ff_upload(dev, &effect, file);
651 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
657 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
659 t = _IOC_NR(cmd) & ABS_MAX;
661 if (copy_from_user(&abs, p,
662 sizeof(struct input_absinfo)))
666 * Take event lock to ensure that we are not
667 * changing device parameters in the middle
670 spin_lock_irq(&dev->event_lock);
672 dev->abs[t] = abs.value;
673 dev->absmin[t] = abs.minimum;
674 dev->absmax[t] = abs.maximum;
675 dev->absfuzz[t] = abs.fuzz;
676 dev->absflat[t] = abs.flat;
678 spin_unlock_irq(&dev->event_lock);
687 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
688 void __user *p, int compat_mode)
690 struct evdev_client *client = file->private_data;
691 struct evdev *evdev = client->evdev;
694 retval = mutex_lock_interruptible(&evdev->mutex);
703 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
706 mutex_unlock(&evdev->mutex);
710 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
712 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
716 static long evdev_ioctl_compat(struct file *file,
717 unsigned int cmd, unsigned long arg)
719 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
723 static const struct file_operations evdev_fops = {
724 .owner = THIS_MODULE,
726 .write = evdev_write,
729 .release = evdev_release,
730 .unlocked_ioctl = evdev_ioctl,
732 .compat_ioctl = evdev_ioctl_compat,
734 .fasync = evdev_fasync,
738 static int evdev_install_chrdev(struct evdev *evdev)
741 * No need to do any locking here as calls to connect and
742 * disconnect are serialized by the input core
744 evdev_table[evdev->minor] = evdev;
748 static void evdev_remove_chrdev(struct evdev *evdev)
751 * Lock evdev table to prevent race with evdev_open()
753 mutex_lock(&evdev_table_mutex);
754 evdev_table[evdev->minor] = NULL;
755 mutex_unlock(&evdev_table_mutex);
759 * Mark device non-existent. This disables writes, ioctls and
760 * prevents new users from opening the device. Already posted
761 * blocking reads will stay, however new ones will fail.
763 static void evdev_mark_dead(struct evdev *evdev)
765 mutex_lock(&evdev->mutex);
767 mutex_unlock(&evdev->mutex);
770 static void evdev_cleanup(struct evdev *evdev)
772 struct input_handle *handle = &evdev->handle;
774 evdev_mark_dead(evdev);
776 evdev_remove_chrdev(evdev);
778 /* evdev is marked dead so no one else accesses evdev->open */
780 input_flush_device(handle, NULL);
781 input_close_device(handle);
786 * Create new evdev device. Note that input core serializes calls
787 * to connect and disconnect so we don't need to lock evdev_table here.
789 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
790 const struct input_device_id *id)
796 for (minor = 0; minor < EVDEV_MINORS; minor++)
797 if (!evdev_table[minor])
800 if (minor == EVDEV_MINORS) {
801 printk(KERN_ERR "evdev: no more free evdev devices\n");
805 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
809 INIT_LIST_HEAD(&evdev->client_list);
810 spin_lock_init(&evdev->client_lock);
811 mutex_init(&evdev->mutex);
812 init_waitqueue_head(&evdev->wait);
814 snprintf(evdev->name, sizeof(evdev->name), "event%d", minor);
816 evdev->minor = minor;
818 evdev->handle.dev = input_get_device(dev);
819 evdev->handle.name = evdev->name;
820 evdev->handle.handler = handler;
821 evdev->handle.private = evdev;
823 dev_set_name(&evdev->dev, evdev->name);
824 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
825 evdev->dev.class = &input_class;
826 evdev->dev.parent = &dev->dev;
827 evdev->dev.release = evdev_free;
828 device_initialize(&evdev->dev);
830 error = input_register_handle(&evdev->handle);
834 error = evdev_install_chrdev(evdev);
836 goto err_unregister_handle;
838 error = device_add(&evdev->dev);
840 goto err_cleanup_evdev;
845 evdev_cleanup(evdev);
846 err_unregister_handle:
847 input_unregister_handle(&evdev->handle);
849 put_device(&evdev->dev);
853 static void evdev_disconnect(struct input_handle *handle)
855 struct evdev *evdev = handle->private;
857 device_del(&evdev->dev);
858 evdev_cleanup(evdev);
859 input_unregister_handle(handle);
860 put_device(&evdev->dev);
863 static const struct input_device_id evdev_ids[] = {
864 { .driver_info = 1 }, /* Matches all devices */
865 { }, /* Terminating zero entry */
868 MODULE_DEVICE_TABLE(input, evdev_ids);
870 static struct input_handler evdev_handler = {
871 .event = evdev_event,
872 .connect = evdev_connect,
873 .disconnect = evdev_disconnect,
875 .minor = EVDEV_MINOR_BASE,
877 .id_table = evdev_ids,
880 static int __init evdev_init(void)
882 return input_register_handler(&evdev_handler);
885 static void __exit evdev_exit(void)
887 input_unregister_handler(&evdev_handler);
890 module_init(evdev_init);
891 module_exit(evdev_exit);
893 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
894 MODULE_DESCRIPTION("Input driver event char devices");
895 MODULE_LICENSE("GPL");