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;
98 return fasync_helper(fd, file, on, &client->fasync);
101 static int evdev_flush(struct file *file, fl_owner_t id)
103 struct evdev_client *client = file->private_data;
104 struct evdev *evdev = client->evdev;
107 retval = mutex_lock_interruptible(&evdev->mutex);
114 retval = input_flush_device(&evdev->handle, file);
116 mutex_unlock(&evdev->mutex);
120 static void evdev_free(struct device *dev)
122 struct evdev *evdev = container_of(dev, struct evdev, dev);
124 input_put_device(evdev->handle.dev);
129 * Grabs an event device (along with underlying input device).
130 * This function is called with evdev->mutex taken.
132 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
139 error = input_grab_device(&evdev->handle);
143 rcu_assign_pointer(evdev->grab, client);
149 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
151 if (evdev->grab != client)
154 rcu_assign_pointer(evdev->grab, NULL);
156 input_release_device(&evdev->handle);
161 static void evdev_attach_client(struct evdev *evdev,
162 struct evdev_client *client)
164 spin_lock(&evdev->client_lock);
165 list_add_tail_rcu(&client->node, &evdev->client_list);
166 spin_unlock(&evdev->client_lock);
170 static void evdev_detach_client(struct evdev *evdev,
171 struct evdev_client *client)
173 spin_lock(&evdev->client_lock);
174 list_del_rcu(&client->node);
175 spin_unlock(&evdev->client_lock);
179 static int evdev_open_device(struct evdev *evdev)
183 retval = mutex_lock_interruptible(&evdev->mutex);
189 else if (!evdev->open++) {
190 retval = input_open_device(&evdev->handle);
195 mutex_unlock(&evdev->mutex);
199 static void evdev_close_device(struct evdev *evdev)
201 mutex_lock(&evdev->mutex);
203 if (evdev->exist && !--evdev->open)
204 input_close_device(&evdev->handle);
206 mutex_unlock(&evdev->mutex);
210 * Wake up users waiting for IO so they can disconnect from
213 static void evdev_hangup(struct evdev *evdev)
215 struct evdev_client *client;
217 spin_lock(&evdev->client_lock);
218 list_for_each_entry(client, &evdev->client_list, node)
219 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
220 spin_unlock(&evdev->client_lock);
222 wake_up_interruptible(&evdev->wait);
225 static int evdev_release(struct inode *inode, struct file *file)
227 struct evdev_client *client = file->private_data;
228 struct evdev *evdev = client->evdev;
230 mutex_lock(&evdev->mutex);
231 if (evdev->grab == client)
232 evdev_ungrab(evdev, client);
233 mutex_unlock(&evdev->mutex);
235 evdev_detach_client(evdev, client);
238 evdev_close_device(evdev);
239 put_device(&evdev->dev);
244 static int evdev_open(struct inode *inode, struct file *file)
247 struct evdev_client *client;
248 int i = iminor(inode) - EVDEV_MINOR_BASE;
251 if (i >= EVDEV_MINORS)
254 error = mutex_lock_interruptible(&evdev_table_mutex);
257 evdev = evdev_table[i];
259 get_device(&evdev->dev);
260 mutex_unlock(&evdev_table_mutex);
265 client = kzalloc(sizeof(struct evdev_client), GFP_KERNEL);
271 spin_lock_init(&client->buffer_lock);
272 client->evdev = evdev;
273 evdev_attach_client(evdev, client);
275 error = evdev_open_device(evdev);
277 goto err_free_client;
279 file->private_data = client;
283 evdev_detach_client(evdev, client);
286 put_device(&evdev->dev);
290 static ssize_t evdev_write(struct file *file, const char __user *buffer,
291 size_t count, loff_t *ppos)
293 struct evdev_client *client = file->private_data;
294 struct evdev *evdev = client->evdev;
295 struct input_event event;
298 retval = mutex_lock_interruptible(&evdev->mutex);
307 while (retval < count) {
309 if (input_event_from_user(buffer + retval, &event)) {
314 input_inject_event(&evdev->handle,
315 event.type, event.code, event.value);
316 retval += input_event_size();
320 mutex_unlock(&evdev->mutex);
324 static int evdev_fetch_next_event(struct evdev_client *client,
325 struct input_event *event)
329 spin_lock_irq(&client->buffer_lock);
331 have_event = client->head != client->tail;
333 *event = client->buffer[client->tail++];
334 client->tail &= EVDEV_BUFFER_SIZE - 1;
337 spin_unlock_irq(&client->buffer_lock);
342 static ssize_t evdev_read(struct file *file, char __user *buffer,
343 size_t count, loff_t *ppos)
345 struct evdev_client *client = file->private_data;
346 struct evdev *evdev = client->evdev;
347 struct input_event event;
350 if (count < input_event_size())
353 if (client->head == client->tail && evdev->exist &&
354 (file->f_flags & O_NONBLOCK))
357 retval = wait_event_interruptible(evdev->wait,
358 client->head != client->tail || !evdev->exist);
365 while (retval + input_event_size() <= count &&
366 evdev_fetch_next_event(client, &event)) {
368 if (input_event_to_user(buffer + retval, &event))
371 retval += input_event_size();
377 /* No kernel lock - fine */
378 static unsigned int evdev_poll(struct file *file, poll_table *wait)
380 struct evdev_client *client = file->private_data;
381 struct evdev *evdev = client->evdev;
383 poll_wait(file, &evdev->wait, wait);
384 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
385 (evdev->exist ? 0 : (POLLHUP | POLLERR));
390 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
391 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
394 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
395 unsigned int maxlen, void __user *p, int compat)
400 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
404 for (i = 0; i < len / sizeof(compat_long_t); i++)
405 if (copy_to_user((compat_long_t __user *) p + i,
406 (compat_long_t *) bits +
407 i + 1 - ((i % 2) << 1),
408 sizeof(compat_long_t)))
411 len = BITS_TO_LONGS(maxbit) * sizeof(long);
415 if (copy_to_user(p, bits, len))
422 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
423 unsigned int maxlen, void __user *p, int compat)
426 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
427 BITS_TO_LONGS(maxbit) * sizeof(long);
432 return copy_to_user(p, bits, len) ? -EFAULT : len;
434 #endif /* __BIG_ENDIAN */
438 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
439 unsigned int maxlen, void __user *p, int compat)
441 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
446 return copy_to_user(p, bits, len) ? -EFAULT : len;
449 #endif /* CONFIG_COMPAT */
451 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
458 len = strlen(str) + 1;
462 return copy_to_user(p, str, len) ? -EFAULT : len;
465 #define OLD_KEY_MAX 0x1ff
466 static int handle_eviocgbit(struct input_dev *dev, unsigned int cmd, void __user *p, int compat_mode)
468 static unsigned long keymax_warn_time;
472 switch (_IOC_NR(cmd) & EV_MAX) {
474 case 0: bits = dev->evbit; len = EV_MAX; break;
475 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
476 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
477 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
478 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
479 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
480 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
481 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
482 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
483 default: return -EINVAL;
487 * Work around bugs in userspace programs that like to do
488 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
489 * should be in bytes, not in bits.
491 if ((_IOC_NR(cmd) & EV_MAX) == EV_KEY && _IOC_SIZE(cmd) == OLD_KEY_MAX) {
493 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
495 "evdev.c(EVIOCGBIT): Suspicious buffer size %u, "
496 "limiting output to %zu bytes. See "
497 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
499 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
502 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
506 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
507 void __user *p, int compat_mode)
509 struct evdev_client *client = file->private_data;
510 struct evdev *evdev = client->evdev;
511 struct input_dev *dev = evdev->handle.dev;
512 struct input_absinfo abs;
513 struct ff_effect effect;
514 int __user *ip = (int __user *)p;
521 return put_user(EV_VERSION, ip);
524 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
529 if (!test_bit(EV_REP, dev->evbit))
531 if (put_user(dev->rep[REP_DELAY], ip))
533 if (put_user(dev->rep[REP_PERIOD], ip + 1))
538 if (!test_bit(EV_REP, dev->evbit))
542 if (get_user(v, ip + 1))
545 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
546 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
554 error = input_get_keycode(dev, t, &v);
558 if (put_user(v, ip + 1))
564 if (get_user(t, ip) || get_user(v, ip + 1))
567 return input_set_keycode(dev, t, v);
570 return input_ff_erase(dev, (int)(unsigned long) p, file);
573 i = test_bit(EV_FF, dev->evbit) ?
574 dev->ff->max_effects : 0;
581 return evdev_grab(evdev, client);
583 return evdev_ungrab(evdev, client);
587 if (_IOC_TYPE(cmd) != 'E')
590 if (_IOC_DIR(cmd) == _IOC_READ) {
592 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
593 return handle_eviocgbit(dev, cmd, p, compat_mode);
595 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
596 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
599 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
600 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
603 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
604 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
607 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
608 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
611 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
612 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
614 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
615 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
617 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
618 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
620 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
622 t = _IOC_NR(cmd) & ABS_MAX;
624 abs.value = dev->abs[t];
625 abs.minimum = dev->absmin[t];
626 abs.maximum = dev->absmax[t];
627 abs.fuzz = dev->absfuzz[t];
628 abs.flat = dev->absflat[t];
630 if (copy_to_user(p, &abs, sizeof(struct input_absinfo)))
638 if (_IOC_DIR(cmd) == _IOC_WRITE) {
640 if (_IOC_NR(cmd) == _IOC_NR(EVIOCSFF)) {
642 if (input_ff_effect_from_user(p, _IOC_SIZE(cmd), &effect))
645 error = input_ff_upload(dev, &effect, file);
647 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
653 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
655 t = _IOC_NR(cmd) & ABS_MAX;
657 if (copy_from_user(&abs, p,
658 sizeof(struct input_absinfo)))
662 * Take event lock to ensure that we are not
663 * changing device parameters in the middle
666 spin_lock_irq(&dev->event_lock);
668 dev->abs[t] = abs.value;
669 dev->absmin[t] = abs.minimum;
670 dev->absmax[t] = abs.maximum;
671 dev->absfuzz[t] = abs.fuzz;
672 dev->absflat[t] = abs.flat;
674 spin_unlock_irq(&dev->event_lock);
683 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
684 void __user *p, int compat_mode)
686 struct evdev_client *client = file->private_data;
687 struct evdev *evdev = client->evdev;
690 retval = mutex_lock_interruptible(&evdev->mutex);
699 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
702 mutex_unlock(&evdev->mutex);
706 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
708 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
712 static long evdev_ioctl_compat(struct file *file,
713 unsigned int cmd, unsigned long arg)
715 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
719 static const struct file_operations evdev_fops = {
720 .owner = THIS_MODULE,
722 .write = evdev_write,
725 .release = evdev_release,
726 .unlocked_ioctl = evdev_ioctl,
728 .compat_ioctl = evdev_ioctl_compat,
730 .fasync = evdev_fasync,
734 static int evdev_install_chrdev(struct evdev *evdev)
737 * No need to do any locking here as calls to connect and
738 * disconnect are serialized by the input core
740 evdev_table[evdev->minor] = evdev;
744 static void evdev_remove_chrdev(struct evdev *evdev)
747 * Lock evdev table to prevent race with evdev_open()
749 mutex_lock(&evdev_table_mutex);
750 evdev_table[evdev->minor] = NULL;
751 mutex_unlock(&evdev_table_mutex);
755 * Mark device non-existent. This disables writes, ioctls and
756 * prevents new users from opening the device. Already posted
757 * blocking reads will stay, however new ones will fail.
759 static void evdev_mark_dead(struct evdev *evdev)
761 mutex_lock(&evdev->mutex);
763 mutex_unlock(&evdev->mutex);
766 static void evdev_cleanup(struct evdev *evdev)
768 struct input_handle *handle = &evdev->handle;
770 evdev_mark_dead(evdev);
772 evdev_remove_chrdev(evdev);
774 /* evdev is marked dead so no one else accesses evdev->open */
776 input_flush_device(handle, NULL);
777 input_close_device(handle);
782 * Create new evdev device. Note that input core serializes calls
783 * to connect and disconnect so we don't need to lock evdev_table here.
785 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
786 const struct input_device_id *id)
792 for (minor = 0; minor < EVDEV_MINORS; minor++)
793 if (!evdev_table[minor])
796 if (minor == EVDEV_MINORS) {
797 printk(KERN_ERR "evdev: no more free evdev devices\n");
801 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
805 INIT_LIST_HEAD(&evdev->client_list);
806 spin_lock_init(&evdev->client_lock);
807 mutex_init(&evdev->mutex);
808 init_waitqueue_head(&evdev->wait);
810 snprintf(evdev->name, sizeof(evdev->name), "event%d", minor);
812 evdev->minor = minor;
814 evdev->handle.dev = input_get_device(dev);
815 evdev->handle.name = evdev->name;
816 evdev->handle.handler = handler;
817 evdev->handle.private = evdev;
819 dev_set_name(&evdev->dev, evdev->name);
820 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
821 evdev->dev.class = &input_class;
822 evdev->dev.parent = &dev->dev;
823 evdev->dev.release = evdev_free;
824 device_initialize(&evdev->dev);
826 error = input_register_handle(&evdev->handle);
830 error = evdev_install_chrdev(evdev);
832 goto err_unregister_handle;
834 error = device_add(&evdev->dev);
836 goto err_cleanup_evdev;
841 evdev_cleanup(evdev);
842 err_unregister_handle:
843 input_unregister_handle(&evdev->handle);
845 put_device(&evdev->dev);
849 static void evdev_disconnect(struct input_handle *handle)
851 struct evdev *evdev = handle->private;
853 device_del(&evdev->dev);
854 evdev_cleanup(evdev);
855 input_unregister_handle(handle);
856 put_device(&evdev->dev);
859 static const struct input_device_id evdev_ids[] = {
860 { .driver_info = 1 }, /* Matches all devices */
861 { }, /* Terminating zero entry */
864 MODULE_DEVICE_TABLE(input, evdev_ids);
866 static struct input_handler evdev_handler = {
867 .event = evdev_event,
868 .connect = evdev_connect,
869 .disconnect = evdev_disconnect,
871 .minor = EVDEV_MINOR_BASE,
873 .id_table = evdev_ids,
876 static int __init evdev_init(void)
878 return input_register_handler(&evdev_handler);
881 static void __exit evdev_exit(void)
883 input_unregister_handler(&evdev_handler);
886 module_init(evdev_init);
887 module_exit(evdev_exit);
889 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
890 MODULE_DESCRIPTION("Input driver event char devices");
891 MODULE_LICENSE("GPL");