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 <linux/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);
131 * Grabs an event device (along with underlying input device).
132 * This function is called with evdev->mutex taken.
134 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
141 error = input_grab_device(&evdev->handle);
145 rcu_assign_pointer(evdev->grab, client);
151 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
153 if (evdev->grab != client)
156 rcu_assign_pointer(evdev->grab, NULL);
158 input_release_device(&evdev->handle);
163 static void evdev_attach_client(struct evdev *evdev,
164 struct evdev_client *client)
166 spin_lock(&evdev->client_lock);
167 list_add_tail_rcu(&client->node, &evdev->client_list);
168 spin_unlock(&evdev->client_lock);
172 static void evdev_detach_client(struct evdev *evdev,
173 struct evdev_client *client)
175 spin_lock(&evdev->client_lock);
176 list_del_rcu(&client->node);
177 spin_unlock(&evdev->client_lock);
181 static int evdev_open_device(struct evdev *evdev)
185 retval = mutex_lock_interruptible(&evdev->mutex);
191 else if (!evdev->open++) {
192 retval = input_open_device(&evdev->handle);
197 mutex_unlock(&evdev->mutex);
201 static void evdev_close_device(struct evdev *evdev)
203 mutex_lock(&evdev->mutex);
205 if (evdev->exist && !--evdev->open)
206 input_close_device(&evdev->handle);
208 mutex_unlock(&evdev->mutex);
212 * Wake up users waiting for IO so they can disconnect from
215 static void evdev_hangup(struct evdev *evdev)
217 struct evdev_client *client;
219 spin_lock(&evdev->client_lock);
220 list_for_each_entry(client, &evdev->client_list, node)
221 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
222 spin_unlock(&evdev->client_lock);
224 wake_up_interruptible(&evdev->wait);
227 static int evdev_release(struct inode *inode, struct file *file)
229 struct evdev_client *client = file->private_data;
230 struct evdev *evdev = client->evdev;
232 mutex_lock(&evdev->mutex);
233 if (evdev->grab == client)
234 evdev_ungrab(evdev, client);
235 mutex_unlock(&evdev->mutex);
237 evdev_fasync(-1, file, 0);
238 evdev_detach_client(evdev, client);
241 evdev_close_device(evdev);
242 put_device(&evdev->dev);
247 static int evdev_open(struct inode *inode, struct file *file)
250 struct evdev_client *client;
251 int i = iminor(inode) - EVDEV_MINOR_BASE;
254 if (i >= EVDEV_MINORS)
257 error = mutex_lock_interruptible(&evdev_table_mutex);
260 evdev = evdev_table[i];
262 get_device(&evdev->dev);
263 mutex_unlock(&evdev_table_mutex);
268 client = kzalloc(sizeof(struct evdev_client), GFP_KERNEL);
274 spin_lock_init(&client->buffer_lock);
275 client->evdev = evdev;
276 evdev_attach_client(evdev, client);
278 error = evdev_open_device(evdev);
280 goto err_free_client;
282 file->private_data = client;
286 evdev_detach_client(evdev, client);
289 put_device(&evdev->dev);
295 struct input_event_compat {
296 struct compat_timeval time;
302 /* Note to the author of this code: did it ever occur to
303 you why the ifdefs are needed? Think about it again. -AK */
305 # define COMPAT_TEST is_compat_task()
306 #elif defined(CONFIG_IA64)
307 # define COMPAT_TEST IS_IA32_PROCESS(task_pt_regs(current))
308 #elif defined(CONFIG_S390)
309 # define COMPAT_TEST test_thread_flag(TIF_31BIT)
310 #elif defined(CONFIG_MIPS)
311 # define COMPAT_TEST test_thread_flag(TIF_32BIT_ADDR)
313 # define COMPAT_TEST test_thread_flag(TIF_32BIT)
316 static inline size_t evdev_event_size(void)
319 sizeof(struct input_event_compat) : sizeof(struct input_event);
322 static int evdev_event_from_user(const char __user *buffer,
323 struct input_event *event)
326 struct input_event_compat compat_event;
328 if (copy_from_user(&compat_event, buffer,
329 sizeof(struct input_event_compat)))
332 event->time.tv_sec = compat_event.time.tv_sec;
333 event->time.tv_usec = compat_event.time.tv_usec;
334 event->type = compat_event.type;
335 event->code = compat_event.code;
336 event->value = compat_event.value;
339 if (copy_from_user(event, buffer, sizeof(struct input_event)))
346 static int evdev_event_to_user(char __user *buffer,
347 const struct input_event *event)
350 struct input_event_compat compat_event;
352 compat_event.time.tv_sec = event->time.tv_sec;
353 compat_event.time.tv_usec = event->time.tv_usec;
354 compat_event.type = event->type;
355 compat_event.code = event->code;
356 compat_event.value = event->value;
358 if (copy_to_user(buffer, &compat_event,
359 sizeof(struct input_event_compat)))
363 if (copy_to_user(buffer, event, sizeof(struct input_event)))
372 static inline size_t evdev_event_size(void)
374 return sizeof(struct input_event);
377 static int evdev_event_from_user(const char __user *buffer,
378 struct input_event *event)
380 if (copy_from_user(event, buffer, sizeof(struct input_event)))
386 static int evdev_event_to_user(char __user *buffer,
387 const struct input_event *event)
389 if (copy_to_user(buffer, event, sizeof(struct input_event)))
395 #endif /* CONFIG_COMPAT */
397 static ssize_t evdev_write(struct file *file, const char __user *buffer,
398 size_t count, loff_t *ppos)
400 struct evdev_client *client = file->private_data;
401 struct evdev *evdev = client->evdev;
402 struct input_event event;
405 retval = mutex_lock_interruptible(&evdev->mutex);
414 while (retval < count) {
416 if (evdev_event_from_user(buffer + retval, &event)) {
421 input_inject_event(&evdev->handle,
422 event.type, event.code, event.value);
423 retval += evdev_event_size();
427 mutex_unlock(&evdev->mutex);
431 static int evdev_fetch_next_event(struct evdev_client *client,
432 struct input_event *event)
436 spin_lock_irq(&client->buffer_lock);
438 have_event = client->head != client->tail;
440 *event = client->buffer[client->tail++];
441 client->tail &= EVDEV_BUFFER_SIZE - 1;
444 spin_unlock_irq(&client->buffer_lock);
449 static ssize_t evdev_read(struct file *file, char __user *buffer,
450 size_t count, loff_t *ppos)
452 struct evdev_client *client = file->private_data;
453 struct evdev *evdev = client->evdev;
454 struct input_event event;
457 if (count < evdev_event_size())
460 if (client->head == client->tail && evdev->exist &&
461 (file->f_flags & O_NONBLOCK))
464 retval = wait_event_interruptible(evdev->wait,
465 client->head != client->tail || !evdev->exist);
472 while (retval + evdev_event_size() <= count &&
473 evdev_fetch_next_event(client, &event)) {
475 if (evdev_event_to_user(buffer + retval, &event))
478 retval += evdev_event_size();
484 /* No kernel lock - fine */
485 static unsigned int evdev_poll(struct file *file, poll_table *wait)
487 struct evdev_client *client = file->private_data;
488 struct evdev *evdev = client->evdev;
490 poll_wait(file, &evdev->wait, wait);
491 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
492 (evdev->exist ? 0 : (POLLHUP | POLLERR));
497 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
498 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
501 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
502 unsigned int maxlen, void __user *p, int compat)
507 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
511 for (i = 0; i < len / sizeof(compat_long_t); i++)
512 if (copy_to_user((compat_long_t __user *) p + i,
513 (compat_long_t *) bits +
514 i + 1 - ((i % 2) << 1),
515 sizeof(compat_long_t)))
518 len = BITS_TO_LONGS(maxbit) * sizeof(long);
522 if (copy_to_user(p, bits, len))
529 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
530 unsigned int maxlen, void __user *p, int compat)
533 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
534 BITS_TO_LONGS(maxbit) * sizeof(long);
539 return copy_to_user(p, bits, len) ? -EFAULT : len;
541 #endif /* __BIG_ENDIAN */
545 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
546 unsigned int maxlen, void __user *p, int compat)
548 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
553 return copy_to_user(p, bits, len) ? -EFAULT : len;
556 #endif /* CONFIG_COMPAT */
558 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
565 len = strlen(str) + 1;
569 return copy_to_user(p, str, len) ? -EFAULT : len;
572 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
573 void __user *p, int compat_mode)
575 struct evdev_client *client = file->private_data;
576 struct evdev *evdev = client->evdev;
577 struct input_dev *dev = evdev->handle.dev;
578 struct input_absinfo abs;
579 struct ff_effect effect;
580 int __user *ip = (int __user *)p;
587 return put_user(EV_VERSION, ip);
590 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
595 if (!test_bit(EV_REP, dev->evbit))
597 if (put_user(dev->rep[REP_DELAY], ip))
599 if (put_user(dev->rep[REP_PERIOD], ip + 1))
604 if (!test_bit(EV_REP, dev->evbit))
608 if (get_user(v, ip + 1))
611 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
612 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
620 error = dev->getkeycode(dev, t, &v);
624 if (put_user(v, ip + 1))
630 if (get_user(t, ip) || get_user(v, ip + 1))
633 return dev->setkeycode(dev, t, v);
636 if (copy_from_user(&effect, p, sizeof(effect)))
639 error = input_ff_upload(dev, &effect, file);
641 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
647 return input_ff_erase(dev, (int)(unsigned long) p, file);
650 i = test_bit(EV_FF, dev->evbit) ?
651 dev->ff->max_effects : 0;
658 return evdev_grab(evdev, client);
660 return evdev_ungrab(evdev, client);
664 if (_IOC_TYPE(cmd) != 'E')
667 if (_IOC_DIR(cmd) == _IOC_READ) {
669 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0))) {
674 switch (_IOC_NR(cmd) & EV_MAX) {
676 case 0: bits = dev->evbit; len = EV_MAX; break;
677 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
678 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
679 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
680 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
681 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
682 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
683 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
684 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
685 default: return -EINVAL;
687 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
690 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
691 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
694 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
695 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
698 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
699 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
702 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
703 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
706 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
707 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
709 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
710 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
712 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
713 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
715 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
717 t = _IOC_NR(cmd) & ABS_MAX;
719 abs.value = dev->abs[t];
720 abs.minimum = dev->absmin[t];
721 abs.maximum = dev->absmax[t];
722 abs.fuzz = dev->absfuzz[t];
723 abs.flat = dev->absflat[t];
725 if (copy_to_user(p, &abs, sizeof(struct input_absinfo)))
733 if (_IOC_DIR(cmd) == _IOC_WRITE) {
735 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
737 t = _IOC_NR(cmd) & ABS_MAX;
739 if (copy_from_user(&abs, p,
740 sizeof(struct input_absinfo)))
744 * Take event lock to ensure that we are not
745 * changing device parameters in the middle
748 spin_lock_irq(&dev->event_lock);
750 dev->abs[t] = abs.value;
751 dev->absmin[t] = abs.minimum;
752 dev->absmax[t] = abs.maximum;
753 dev->absfuzz[t] = abs.fuzz;
754 dev->absflat[t] = abs.flat;
756 spin_unlock_irq(&dev->event_lock);
765 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
766 void __user *p, int compat_mode)
768 struct evdev_client *client = file->private_data;
769 struct evdev *evdev = client->evdev;
772 retval = mutex_lock_interruptible(&evdev->mutex);
781 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
784 mutex_unlock(&evdev->mutex);
788 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
790 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
794 static long evdev_ioctl_compat(struct file *file,
795 unsigned int cmd, unsigned long arg)
797 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
801 static const struct file_operations evdev_fops = {
802 .owner = THIS_MODULE,
804 .write = evdev_write,
807 .release = evdev_release,
808 .unlocked_ioctl = evdev_ioctl,
810 .compat_ioctl = evdev_ioctl_compat,
812 .fasync = evdev_fasync,
816 static int evdev_install_chrdev(struct evdev *evdev)
819 * No need to do any locking here as calls to connect and
820 * disconnect are serialized by the input core
822 evdev_table[evdev->minor] = evdev;
826 static void evdev_remove_chrdev(struct evdev *evdev)
829 * Lock evdev table to prevent race with evdev_open()
831 mutex_lock(&evdev_table_mutex);
832 evdev_table[evdev->minor] = NULL;
833 mutex_unlock(&evdev_table_mutex);
837 * Mark device non-existent. This disables writes, ioctls and
838 * prevents new users from opening the device. Already posted
839 * blocking reads will stay, however new ones will fail.
841 static void evdev_mark_dead(struct evdev *evdev)
843 mutex_lock(&evdev->mutex);
845 mutex_unlock(&evdev->mutex);
848 static void evdev_cleanup(struct evdev *evdev)
850 struct input_handle *handle = &evdev->handle;
852 evdev_mark_dead(evdev);
854 evdev_remove_chrdev(evdev);
856 /* evdev is marked dead so no one else accesses evdev->open */
858 input_flush_device(handle, NULL);
859 input_close_device(handle);
864 * Create new evdev device. Note that input core serializes calls
865 * to connect and disconnect so we don't need to lock evdev_table here.
867 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
868 const struct input_device_id *id)
874 for (minor = 0; minor < EVDEV_MINORS; minor++)
875 if (!evdev_table[minor])
878 if (minor == EVDEV_MINORS) {
879 printk(KERN_ERR "evdev: no more free evdev devices\n");
883 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
887 INIT_LIST_HEAD(&evdev->client_list);
888 spin_lock_init(&evdev->client_lock);
889 mutex_init(&evdev->mutex);
890 init_waitqueue_head(&evdev->wait);
892 snprintf(evdev->name, sizeof(evdev->name), "event%d", minor);
894 evdev->minor = minor;
896 evdev->handle.dev = dev;
897 evdev->handle.name = evdev->name;
898 evdev->handle.handler = handler;
899 evdev->handle.private = evdev;
901 strlcpy(evdev->dev.bus_id, evdev->name, sizeof(evdev->dev.bus_id));
902 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
903 evdev->dev.class = &input_class;
904 evdev->dev.parent = &dev->dev;
905 evdev->dev.release = evdev_free;
906 device_initialize(&evdev->dev);
908 error = input_register_handle(&evdev->handle);
912 error = evdev_install_chrdev(evdev);
914 goto err_unregister_handle;
916 error = device_add(&evdev->dev);
918 goto err_cleanup_evdev;
923 evdev_cleanup(evdev);
924 err_unregister_handle:
925 input_unregister_handle(&evdev->handle);
927 put_device(&evdev->dev);
931 static void evdev_disconnect(struct input_handle *handle)
933 struct evdev *evdev = handle->private;
935 device_del(&evdev->dev);
936 evdev_cleanup(evdev);
937 input_unregister_handle(handle);
938 put_device(&evdev->dev);
941 static const struct input_device_id evdev_ids[] = {
942 { .driver_info = 1 }, /* Matches all devices */
943 { }, /* Terminating zero entry */
946 MODULE_DEVICE_TABLE(input, evdev_ids);
948 static struct input_handler evdev_handler = {
949 .event = evdev_event,
950 .connect = evdev_connect,
951 .disconnect = evdev_disconnect,
953 .minor = EVDEV_MINOR_BASE,
955 .id_table = evdev_ids,
958 static int __init evdev_init(void)
960 return input_register_handler(&evdev_handler);
963 static void __exit evdev_exit(void)
965 input_unregister_handler(&evdev_handler);
968 module_init(evdev_init);
969 module_exit(evdev_exit);
971 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
972 MODULE_DESCRIPTION("Input driver event char devices");
973 MODULE_LICENSE("GPL");