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_MIN_BUFFER_SIZE 64U
14 #define EVDEV_BUF_PACKETS 8
16 #include <linux/poll.h>
17 #include <linux/sched.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/input.h>
22 #include <linux/major.h>
23 #include <linux/device.h>
24 #include <linux/wakelock.h>
25 #include "input-compat.h"
30 struct input_handle handle;
31 wait_queue_head_t wait;
32 struct evdev_client *grab;
33 struct list_head client_list;
34 spinlock_t client_lock; /* protects client_list */
43 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
44 struct wake_lock wake_lock;
46 struct fasync_struct *fasync;
48 struct list_head node;
50 struct input_event buffer[];
53 static struct evdev *evdev_table[EVDEV_MINORS];
54 static DEFINE_MUTEX(evdev_table_mutex);
56 static void evdev_pass_event(struct evdev_client *client,
57 struct input_event *event)
60 * Interrupts are disabled, just acquire the lock.
61 * Make sure we don't leave with the client buffer
62 * "empty" by having client->head == client->tail.
64 spin_lock(&client->buffer_lock);
65 wake_lock_timeout(&client->wake_lock, 5 * HZ);
67 client->buffer[client->head++] = *event;
68 client->head &= client->bufsize - 1;
69 } while (client->head == client->tail);
70 spin_unlock(&client->buffer_lock);
72 if (event->type == EV_SYN)
73 kill_fasync(&client->fasync, SIGIO, POLL_IN);
77 * Pass incoming event to all connected clients.
79 static void evdev_event(struct input_handle *handle,
80 unsigned int type, unsigned int code, int value)
82 struct evdev *evdev = handle->private;
83 struct evdev_client *client;
84 struct input_event event;
88 event.time.tv_sec = ts.tv_sec;
89 event.time.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
96 client = rcu_dereference(evdev->grab);
98 evdev_pass_event(client, &event);
100 list_for_each_entry_rcu(client, &evdev->client_list, node)
101 evdev_pass_event(client, &event);
105 wake_up_interruptible(&evdev->wait);
108 static int evdev_fasync(int fd, struct file *file, int on)
110 struct evdev_client *client = file->private_data;
112 return fasync_helper(fd, file, on, &client->fasync);
115 static int evdev_flush(struct file *file, fl_owner_t id)
117 struct evdev_client *client = file->private_data;
118 struct evdev *evdev = client->evdev;
121 retval = mutex_lock_interruptible(&evdev->mutex);
128 retval = input_flush_device(&evdev->handle, file);
130 mutex_unlock(&evdev->mutex);
134 static void evdev_free(struct device *dev)
136 struct evdev *evdev = container_of(dev, struct evdev, dev);
138 input_put_device(evdev->handle.dev);
143 * Grabs an event device (along with underlying input device).
144 * This function is called with evdev->mutex taken.
146 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
153 error = input_grab_device(&evdev->handle);
157 rcu_assign_pointer(evdev->grab, client);
163 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
165 if (evdev->grab != client)
168 rcu_assign_pointer(evdev->grab, NULL);
170 input_release_device(&evdev->handle);
175 static void evdev_attach_client(struct evdev *evdev,
176 struct evdev_client *client)
178 spin_lock(&evdev->client_lock);
179 list_add_tail_rcu(&client->node, &evdev->client_list);
180 spin_unlock(&evdev->client_lock);
184 static void evdev_detach_client(struct evdev *evdev,
185 struct evdev_client *client)
187 spin_lock(&evdev->client_lock);
188 list_del_rcu(&client->node);
189 spin_unlock(&evdev->client_lock);
193 static int evdev_open_device(struct evdev *evdev)
197 retval = mutex_lock_interruptible(&evdev->mutex);
203 else if (!evdev->open++) {
204 retval = input_open_device(&evdev->handle);
209 mutex_unlock(&evdev->mutex);
213 static void evdev_close_device(struct evdev *evdev)
215 mutex_lock(&evdev->mutex);
217 if (evdev->exist && !--evdev->open)
218 input_close_device(&evdev->handle);
220 mutex_unlock(&evdev->mutex);
224 * Wake up users waiting for IO so they can disconnect from
227 static void evdev_hangup(struct evdev *evdev)
229 struct evdev_client *client;
231 spin_lock(&evdev->client_lock);
232 list_for_each_entry(client, &evdev->client_list, node)
233 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
234 spin_unlock(&evdev->client_lock);
236 wake_up_interruptible(&evdev->wait);
239 static int evdev_release(struct inode *inode, struct file *file)
241 struct evdev_client *client = file->private_data;
242 struct evdev *evdev = client->evdev;
244 mutex_lock(&evdev->mutex);
245 if (evdev->grab == client)
246 evdev_ungrab(evdev, client);
247 mutex_unlock(&evdev->mutex);
249 evdev_detach_client(evdev, client);
250 wake_lock_destroy(&client->wake_lock);
253 evdev_close_device(evdev);
254 put_device(&evdev->dev);
259 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
261 unsigned int n_events =
262 max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
263 EVDEV_MIN_BUFFER_SIZE);
265 return roundup_pow_of_two(n_events);
268 static int evdev_open(struct inode *inode, struct file *file)
271 struct evdev_client *client;
272 int i = iminor(inode) - EVDEV_MINOR_BASE;
273 unsigned int bufsize;
276 if (i >= EVDEV_MINORS)
279 error = mutex_lock_interruptible(&evdev_table_mutex);
282 evdev = evdev_table[i];
284 get_device(&evdev->dev);
285 mutex_unlock(&evdev_table_mutex);
290 bufsize = evdev_compute_buffer_size(evdev->handle.dev);
292 client = kzalloc(sizeof(struct evdev_client) +
293 bufsize * sizeof(struct input_event),
300 client->bufsize = bufsize;
301 spin_lock_init(&client->buffer_lock);
302 snprintf(client->name, sizeof(client->name), "%s-%d",
303 dev_name(&evdev->dev), task_tgid_vnr(current));
304 wake_lock_init(&client->wake_lock, WAKE_LOCK_SUSPEND, client->name);
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);
319 wake_lock_destroy(&client->wake_lock);
322 put_device(&evdev->dev);
326 static ssize_t evdev_write(struct file *file, const char __user *buffer,
327 size_t count, loff_t *ppos)
329 struct evdev_client *client = file->private_data;
330 struct evdev *evdev = client->evdev;
331 struct input_event event;
334 retval = mutex_lock_interruptible(&evdev->mutex);
343 while (retval < count) {
345 if (input_event_from_user(buffer + retval, &event)) {
350 input_inject_event(&evdev->handle,
351 event.type, event.code, event.value);
352 retval += input_event_size();
356 mutex_unlock(&evdev->mutex);
360 static int evdev_fetch_next_event(struct evdev_client *client,
361 struct input_event *event)
365 spin_lock_irq(&client->buffer_lock);
367 have_event = client->head != client->tail;
369 *event = client->buffer[client->tail++];
370 client->tail &= client->bufsize - 1;
371 if (client->head == client->tail)
372 wake_unlock(&client->wake_lock);
375 spin_unlock_irq(&client->buffer_lock);
380 static ssize_t evdev_read(struct file *file, char __user *buffer,
381 size_t count, loff_t *ppos)
383 struct evdev_client *client = file->private_data;
384 struct evdev *evdev = client->evdev;
385 struct input_event event;
388 if (count < input_event_size())
391 if (client->head == client->tail && evdev->exist &&
392 (file->f_flags & O_NONBLOCK))
395 retval = wait_event_interruptible(evdev->wait,
396 client->head != client->tail || !evdev->exist);
403 while (retval + input_event_size() <= count &&
404 evdev_fetch_next_event(client, &event)) {
406 if (input_event_to_user(buffer + retval, &event))
409 retval += input_event_size();
415 /* No kernel lock - fine */
416 static unsigned int evdev_poll(struct file *file, poll_table *wait)
418 struct evdev_client *client = file->private_data;
419 struct evdev *evdev = client->evdev;
422 poll_wait(file, &evdev->wait, wait);
424 mask = evdev->exist ? POLLOUT | POLLWRNORM : POLLHUP | POLLERR;
425 if (client->head != client->tail)
426 mask |= POLLIN | POLLRDNORM;
433 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
434 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
437 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
438 unsigned int maxlen, void __user *p, int compat)
443 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
447 for (i = 0; i < len / sizeof(compat_long_t); i++)
448 if (copy_to_user((compat_long_t __user *) p + i,
449 (compat_long_t *) bits +
450 i + 1 - ((i % 2) << 1),
451 sizeof(compat_long_t)))
454 len = BITS_TO_LONGS(maxbit) * sizeof(long);
458 if (copy_to_user(p, bits, len))
465 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
466 unsigned int maxlen, void __user *p, int compat)
469 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
470 BITS_TO_LONGS(maxbit) * sizeof(long);
475 return copy_to_user(p, bits, len) ? -EFAULT : len;
477 #endif /* __BIG_ENDIAN */
481 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
482 unsigned int maxlen, void __user *p, int compat)
484 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
489 return copy_to_user(p, bits, len) ? -EFAULT : len;
492 #endif /* CONFIG_COMPAT */
494 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
501 len = strlen(str) + 1;
505 return copy_to_user(p, str, len) ? -EFAULT : len;
508 #define OLD_KEY_MAX 0x1ff
509 static int handle_eviocgbit(struct input_dev *dev,
510 unsigned int type, unsigned int size,
511 void __user *p, int compat_mode)
513 static unsigned long keymax_warn_time;
519 case 0: bits = dev->evbit; len = EV_MAX; break;
520 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
521 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
522 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
523 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
524 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
525 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
526 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
527 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
528 default: return -EINVAL;
532 * Work around bugs in userspace programs that like to do
533 * EVIOCGBIT(EV_KEY, KEY_MAX) and not realize that 'len'
534 * should be in bytes, not in bits.
536 if (type == EV_KEY && size == OLD_KEY_MAX) {
538 if (printk_timed_ratelimit(&keymax_warn_time, 10 * 1000))
540 "evdev.c(EVIOCGBIT): Suspicious buffer size %u, "
541 "limiting output to %zu bytes. See "
542 "http://userweb.kernel.org/~dtor/eviocgbit-bug.html\n",
544 BITS_TO_LONGS(OLD_KEY_MAX) * sizeof(long));
547 return bits_to_user(bits, len, size, p, compat_mode);
551 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
552 void __user *p, int compat_mode)
554 struct evdev_client *client = file->private_data;
555 struct evdev *evdev = client->evdev;
556 struct input_dev *dev = evdev->handle.dev;
557 struct input_absinfo abs;
558 struct ff_effect effect;
559 int __user *ip = (int __user *)p;
560 unsigned int i, t, u, v;
564 /* First we check for fixed-length commands */
568 return put_user(EV_VERSION, ip);
571 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
576 if (!test_bit(EV_REP, dev->evbit))
578 if (put_user(dev->rep[REP_DELAY], ip))
580 if (put_user(dev->rep[REP_PERIOD], ip + 1))
585 if (!test_bit(EV_REP, dev->evbit))
589 if (get_user(v, ip + 1))
592 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
593 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
601 error = input_get_keycode(dev, t, &v);
605 if (put_user(v, ip + 1))
611 if (get_user(t, ip) || get_user(v, ip + 1))
614 return input_set_keycode(dev, t, v);
617 return input_ff_erase(dev, (int)(unsigned long) p, file);
620 i = test_bit(EV_FF, dev->evbit) ?
621 dev->ff->max_effects : 0;
628 return evdev_grab(evdev, client);
630 return evdev_ungrab(evdev, client);
633 size = _IOC_SIZE(cmd);
635 /* Now check variable-length commands */
636 #define EVIOC_MASK_SIZE(nr) ((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
638 switch (EVIOC_MASK_SIZE(cmd)) {
641 return bits_to_user(dev->key, KEY_MAX, size, p, compat_mode);
644 return bits_to_user(dev->led, LED_MAX, size, p, compat_mode);
647 return bits_to_user(dev->snd, SND_MAX, size, p, compat_mode);
650 return bits_to_user(dev->sw, SW_MAX, size, p, compat_mode);
653 return str_to_user(dev->name, size, p);
656 return str_to_user(dev->phys, size, p);
659 return str_to_user(dev->uniq, size, p);
661 case EVIOC_MASK_SIZE(EVIOCSFF):
662 if (input_ff_effect_from_user(p, size, &effect))
665 error = input_ff_upload(dev, &effect, file);
667 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
673 /* Multi-number variable-length handlers */
674 if (_IOC_TYPE(cmd) != 'E')
677 if (_IOC_DIR(cmd) == _IOC_READ) {
679 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
680 return handle_eviocgbit(dev,
681 _IOC_NR(cmd) & EV_MAX, size,
684 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
689 t = _IOC_NR(cmd) & ABS_MAX;
690 abs = dev->absinfo[t];
692 if (copy_to_user(p, &abs, min_t(size_t,
693 size, sizeof(struct input_absinfo))))
700 if (_IOC_DIR(cmd) == _IOC_WRITE) {
702 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
707 t = _IOC_NR(cmd) & ABS_MAX;
709 if (copy_from_user(&abs, p, min_t(size_t,
710 size, sizeof(struct input_absinfo))))
713 if (size < sizeof(struct input_absinfo))
716 /* We can't change number of reserved MT slots */
717 if (t == ABS_MT_SLOT)
721 * Take event lock to ensure that we are not
722 * changing device parameters in the middle
725 spin_lock_irq(&dev->event_lock);
726 dev->absinfo[t] = abs;
727 spin_unlock_irq(&dev->event_lock);
736 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
737 void __user *p, int compat_mode)
739 struct evdev_client *client = file->private_data;
740 struct evdev *evdev = client->evdev;
743 retval = mutex_lock_interruptible(&evdev->mutex);
752 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
755 mutex_unlock(&evdev->mutex);
759 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
761 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
765 static long evdev_ioctl_compat(struct file *file,
766 unsigned int cmd, unsigned long arg)
768 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
772 static const struct file_operations evdev_fops = {
773 .owner = THIS_MODULE,
775 .write = evdev_write,
778 .release = evdev_release,
779 .unlocked_ioctl = evdev_ioctl,
781 .compat_ioctl = evdev_ioctl_compat,
783 .fasync = evdev_fasync,
787 static int evdev_install_chrdev(struct evdev *evdev)
790 * No need to do any locking here as calls to connect and
791 * disconnect are serialized by the input core
793 evdev_table[evdev->minor] = evdev;
797 static void evdev_remove_chrdev(struct evdev *evdev)
800 * Lock evdev table to prevent race with evdev_open()
802 mutex_lock(&evdev_table_mutex);
803 evdev_table[evdev->minor] = NULL;
804 mutex_unlock(&evdev_table_mutex);
808 * Mark device non-existent. This disables writes, ioctls and
809 * prevents new users from opening the device. Already posted
810 * blocking reads will stay, however new ones will fail.
812 static void evdev_mark_dead(struct evdev *evdev)
814 mutex_lock(&evdev->mutex);
815 evdev->exist = false;
816 mutex_unlock(&evdev->mutex);
819 static void evdev_cleanup(struct evdev *evdev)
821 struct input_handle *handle = &evdev->handle;
823 evdev_mark_dead(evdev);
825 evdev_remove_chrdev(evdev);
827 /* evdev is marked dead so no one else accesses evdev->open */
829 input_flush_device(handle, NULL);
830 input_close_device(handle);
835 * Create new evdev device. Note that input core serializes calls
836 * to connect and disconnect so we don't need to lock evdev_table here.
838 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
839 const struct input_device_id *id)
845 for (minor = 0; minor < EVDEV_MINORS; minor++)
846 if (!evdev_table[minor])
849 if (minor == EVDEV_MINORS) {
850 printk(KERN_ERR "evdev: no more free evdev devices\n");
854 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
858 INIT_LIST_HEAD(&evdev->client_list);
859 spin_lock_init(&evdev->client_lock);
860 mutex_init(&evdev->mutex);
861 init_waitqueue_head(&evdev->wait);
863 dev_set_name(&evdev->dev, "event%d", minor);
865 evdev->minor = minor;
867 evdev->handle.dev = input_get_device(dev);
868 evdev->handle.name = dev_name(&evdev->dev);
869 evdev->handle.handler = handler;
870 evdev->handle.private = evdev;
872 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
873 evdev->dev.class = &input_class;
874 evdev->dev.parent = &dev->dev;
875 evdev->dev.release = evdev_free;
876 device_initialize(&evdev->dev);
878 error = input_register_handle(&evdev->handle);
882 error = evdev_install_chrdev(evdev);
884 goto err_unregister_handle;
886 error = device_add(&evdev->dev);
888 goto err_cleanup_evdev;
893 evdev_cleanup(evdev);
894 err_unregister_handle:
895 input_unregister_handle(&evdev->handle);
897 put_device(&evdev->dev);
901 static void evdev_disconnect(struct input_handle *handle)
903 struct evdev *evdev = handle->private;
905 device_del(&evdev->dev);
906 evdev_cleanup(evdev);
907 input_unregister_handle(handle);
908 put_device(&evdev->dev);
911 static const struct input_device_id evdev_ids[] = {
912 { .driver_info = 1 }, /* Matches all devices */
913 { }, /* Terminating zero entry */
916 MODULE_DEVICE_TABLE(input, evdev_ids);
918 static struct input_handler evdev_handler = {
919 .event = evdev_event,
920 .connect = evdev_connect,
921 .disconnect = evdev_disconnect,
923 .minor = EVDEV_MINOR_BASE,
925 .id_table = evdev_ids,
928 static int __init evdev_init(void)
930 return input_register_handler(&evdev_handler);
933 static void __exit evdev_exit(void)
935 input_unregister_handler(&evdev_handler);
938 module_init(evdev_init);
939 module_exit(evdev_exit);
941 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
942 MODULE_DESCRIPTION("Input driver event char devices");
943 MODULE_LICENSE("GPL");