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. Note that we are
67 * caleld under a spinlock with interrupts off so we don't need
68 * to use rcu_read_lock() here. Writers will be using syncronize_sched()
69 * instead of synchrnoize_rcu().
71 static void evdev_event(struct input_handle *handle,
72 unsigned int type, unsigned int code, int value)
74 struct evdev *evdev = handle->private;
75 struct evdev_client *client;
76 struct input_event event;
78 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);
90 wake_up_interruptible(&evdev->wait);
93 static int evdev_fasync(int fd, struct file *file, int on)
95 struct evdev_client *client = file->private_data;
98 retval = fasync_helper(fd, file, on, &client->fasync);
100 return retval < 0 ? retval : 0;
103 static int evdev_flush(struct file *file, fl_owner_t id)
105 struct evdev_client *client = file->private_data;
106 struct evdev *evdev = client->evdev;
109 retval = mutex_lock_interruptible(&evdev->mutex);
116 retval = input_flush_device(&evdev->handle, file);
118 mutex_unlock(&evdev->mutex);
122 static void evdev_free(struct device *dev)
124 struct evdev *evdev = container_of(dev, struct evdev, 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);
146 * We don't use synchronize_rcu() here because read-side
147 * critical section is protected by a spinlock instead
148 * of rcu_read_lock().
155 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
157 if (evdev->grab != client)
160 rcu_assign_pointer(evdev->grab, NULL);
162 input_release_device(&evdev->handle);
167 static void evdev_attach_client(struct evdev *evdev,
168 struct evdev_client *client)
170 spin_lock(&evdev->client_lock);
171 list_add_tail_rcu(&client->node, &evdev->client_list);
172 spin_unlock(&evdev->client_lock);
176 static void evdev_detach_client(struct evdev *evdev,
177 struct evdev_client *client)
179 spin_lock(&evdev->client_lock);
180 list_del_rcu(&client->node);
181 spin_unlock(&evdev->client_lock);
185 static int evdev_open_device(struct evdev *evdev)
189 retval = mutex_lock_interruptible(&evdev->mutex);
195 else if (!evdev->open++) {
196 retval = input_open_device(&evdev->handle);
201 mutex_unlock(&evdev->mutex);
205 static void evdev_close_device(struct evdev *evdev)
207 mutex_lock(&evdev->mutex);
209 if (evdev->exist && !--evdev->open)
210 input_close_device(&evdev->handle);
212 mutex_unlock(&evdev->mutex);
216 * Wake up users waiting for IO so they can disconnect from
219 static void evdev_hangup(struct evdev *evdev)
221 struct evdev_client *client;
223 spin_lock(&evdev->client_lock);
224 list_for_each_entry(client, &evdev->client_list, node)
225 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
226 spin_unlock(&evdev->client_lock);
228 wake_up_interruptible(&evdev->wait);
231 static int evdev_release(struct inode *inode, struct file *file)
233 struct evdev_client *client = file->private_data;
234 struct evdev *evdev = client->evdev;
236 mutex_lock(&evdev->mutex);
237 if (evdev->grab == client)
238 evdev_ungrab(evdev, client);
239 mutex_unlock(&evdev->mutex);
241 evdev_fasync(-1, file, 0);
242 evdev_detach_client(evdev, client);
245 evdev_close_device(evdev);
246 put_device(&evdev->dev);
251 static int evdev_open(struct inode *inode, struct file *file)
254 struct evdev_client *client;
255 int i = iminor(inode) - EVDEV_MINOR_BASE;
258 if (i >= EVDEV_MINORS)
261 error = mutex_lock_interruptible(&evdev_table_mutex);
264 evdev = evdev_table[i];
266 get_device(&evdev->dev);
267 mutex_unlock(&evdev_table_mutex);
272 client = kzalloc(sizeof(struct evdev_client), GFP_KERNEL);
278 spin_lock_init(&client->buffer_lock);
279 client->evdev = evdev;
280 evdev_attach_client(evdev, client);
282 error = evdev_open_device(evdev);
284 goto err_free_client;
286 file->private_data = client;
290 evdev_detach_client(evdev, client);
293 put_device(&evdev->dev);
299 struct input_event_compat {
300 struct compat_timeval time;
306 /* Note to the author of this code: did it ever occur to
307 you why the ifdefs are needed? Think about it again. -AK */
309 # define COMPAT_TEST is_compat_task()
310 #elif defined(CONFIG_IA64)
311 # define COMPAT_TEST IS_IA32_PROCESS(task_pt_regs(current))
312 #elif defined(CONFIG_S390)
313 # define COMPAT_TEST test_thread_flag(TIF_31BIT)
314 #elif defined(CONFIG_MIPS)
315 # define COMPAT_TEST test_thread_flag(TIF_32BIT_ADDR)
317 # define COMPAT_TEST test_thread_flag(TIF_32BIT)
320 static inline size_t evdev_event_size(void)
323 sizeof(struct input_event_compat) : sizeof(struct input_event);
326 static int evdev_event_from_user(const char __user *buffer,
327 struct input_event *event)
330 struct input_event_compat compat_event;
332 if (copy_from_user(&compat_event, buffer,
333 sizeof(struct input_event_compat)))
336 event->time.tv_sec = compat_event.time.tv_sec;
337 event->time.tv_usec = compat_event.time.tv_usec;
338 event->type = compat_event.type;
339 event->code = compat_event.code;
340 event->value = compat_event.value;
343 if (copy_from_user(event, buffer, sizeof(struct input_event)))
350 static int evdev_event_to_user(char __user *buffer,
351 const struct input_event *event)
354 struct input_event_compat compat_event;
356 compat_event.time.tv_sec = event->time.tv_sec;
357 compat_event.time.tv_usec = event->time.tv_usec;
358 compat_event.type = event->type;
359 compat_event.code = event->code;
360 compat_event.value = event->value;
362 if (copy_to_user(buffer, &compat_event,
363 sizeof(struct input_event_compat)))
367 if (copy_to_user(buffer, event, sizeof(struct input_event)))
376 static inline size_t evdev_event_size(void)
378 return sizeof(struct input_event);
381 static int evdev_event_from_user(const char __user *buffer,
382 struct input_event *event)
384 if (copy_from_user(event, buffer, sizeof(struct input_event)))
390 static int evdev_event_to_user(char __user *buffer,
391 const struct input_event *event)
393 if (copy_to_user(buffer, event, sizeof(struct input_event)))
399 #endif /* CONFIG_COMPAT */
401 static ssize_t evdev_write(struct file *file, const char __user *buffer,
402 size_t count, loff_t *ppos)
404 struct evdev_client *client = file->private_data;
405 struct evdev *evdev = client->evdev;
406 struct input_event event;
409 retval = mutex_lock_interruptible(&evdev->mutex);
418 while (retval < count) {
420 if (evdev_event_from_user(buffer + retval, &event)) {
425 input_inject_event(&evdev->handle,
426 event.type, event.code, event.value);
427 retval += evdev_event_size();
431 mutex_unlock(&evdev->mutex);
435 static int evdev_fetch_next_event(struct evdev_client *client,
436 struct input_event *event)
440 spin_lock_irq(&client->buffer_lock);
442 have_event = client->head != client->tail;
444 *event = client->buffer[client->tail++];
445 client->tail &= EVDEV_BUFFER_SIZE - 1;
448 spin_unlock_irq(&client->buffer_lock);
453 static ssize_t evdev_read(struct file *file, char __user *buffer,
454 size_t count, loff_t *ppos)
456 struct evdev_client *client = file->private_data;
457 struct evdev *evdev = client->evdev;
458 struct input_event event;
461 if (count < evdev_event_size())
464 if (client->head == client->tail && evdev->exist &&
465 (file->f_flags & O_NONBLOCK))
468 retval = wait_event_interruptible(evdev->wait,
469 client->head != client->tail || !evdev->exist);
476 while (retval + evdev_event_size() <= count &&
477 evdev_fetch_next_event(client, &event)) {
479 if (evdev_event_to_user(buffer + retval, &event))
482 retval += evdev_event_size();
488 /* No kernel lock - fine */
489 static unsigned int evdev_poll(struct file *file, poll_table *wait)
491 struct evdev_client *client = file->private_data;
492 struct evdev *evdev = client->evdev;
494 poll_wait(file, &evdev->wait, wait);
495 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
496 (evdev->exist ? 0 : (POLLHUP | POLLERR));
501 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
502 #define NBITS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
505 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
506 unsigned int maxlen, void __user *p, int compat)
511 len = NBITS_COMPAT(maxbit) * sizeof(compat_long_t);
515 for (i = 0; i < len / sizeof(compat_long_t); i++)
516 if (copy_to_user((compat_long_t __user *) p + i,
517 (compat_long_t *) bits +
518 i + 1 - ((i % 2) << 1),
519 sizeof(compat_long_t)))
522 len = NBITS(maxbit) * sizeof(long);
526 if (copy_to_user(p, bits, len))
533 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
534 unsigned int maxlen, void __user *p, int compat)
537 NBITS_COMPAT(maxbit) * sizeof(compat_long_t) :
538 NBITS(maxbit) * sizeof(long);
543 return copy_to_user(p, bits, len) ? -EFAULT : len;
545 #endif /* __BIG_ENDIAN */
549 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
550 unsigned int maxlen, void __user *p, int compat)
552 int len = NBITS(maxbit) * sizeof(long);
557 return copy_to_user(p, bits, len) ? -EFAULT : len;
560 #endif /* CONFIG_COMPAT */
562 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
569 len = strlen(str) + 1;
573 return copy_to_user(p, str, len) ? -EFAULT : len;
576 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
577 void __user *p, int compat_mode)
579 struct evdev_client *client = file->private_data;
580 struct evdev *evdev = client->evdev;
581 struct input_dev *dev = evdev->handle.dev;
582 struct input_absinfo abs;
583 struct ff_effect effect;
584 int __user *ip = (int __user *)p;
591 return put_user(EV_VERSION, ip);
594 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
599 if (!test_bit(EV_REP, dev->evbit))
601 if (put_user(dev->rep[REP_DELAY], ip))
603 if (put_user(dev->rep[REP_PERIOD], ip + 1))
608 if (!test_bit(EV_REP, dev->evbit))
612 if (get_user(v, ip + 1))
615 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
616 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
624 error = dev->getkeycode(dev, t, &v);
628 if (put_user(v, ip + 1))
634 if (get_user(t, ip) || get_user(v, ip + 1))
637 return dev->setkeycode(dev, t, v);
640 if (copy_from_user(&effect, p, sizeof(effect)))
643 error = input_ff_upload(dev, &effect, file);
645 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
651 return input_ff_erase(dev, (int)(unsigned long) p, file);
654 i = test_bit(EV_FF, dev->evbit) ?
655 dev->ff->max_effects : 0;
662 return evdev_grab(evdev, client);
664 return evdev_ungrab(evdev, client);
668 if (_IOC_TYPE(cmd) != 'E')
671 if (_IOC_DIR(cmd) == _IOC_READ) {
673 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0))) {
678 switch (_IOC_NR(cmd) & EV_MAX) {
680 case 0: bits = dev->evbit; len = EV_MAX; break;
681 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
682 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
683 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
684 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
685 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
686 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
687 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
688 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
689 default: return -EINVAL;
691 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
694 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
695 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
698 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
699 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
702 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
703 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
706 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
707 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
710 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
711 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
713 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
714 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
716 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
717 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
719 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
721 t = _IOC_NR(cmd) & ABS_MAX;
723 abs.value = dev->abs[t];
724 abs.minimum = dev->absmin[t];
725 abs.maximum = dev->absmax[t];
726 abs.fuzz = dev->absfuzz[t];
727 abs.flat = dev->absflat[t];
729 if (copy_to_user(p, &abs, sizeof(struct input_absinfo)))
737 if (_IOC_DIR(cmd) == _IOC_WRITE) {
739 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
741 t = _IOC_NR(cmd) & ABS_MAX;
743 if (copy_from_user(&abs, p,
744 sizeof(struct input_absinfo)))
748 * Take event lock to ensure that we are not
749 * changing device parameters in the middle
752 spin_lock_irq(&dev->event_lock);
754 dev->abs[t] = abs.value;
755 dev->absmin[t] = abs.minimum;
756 dev->absmax[t] = abs.maximum;
757 dev->absfuzz[t] = abs.fuzz;
758 dev->absflat[t] = abs.flat;
760 spin_unlock_irq(&dev->event_lock);
769 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
770 void __user *p, int compat_mode)
772 struct evdev_client *client = file->private_data;
773 struct evdev *evdev = client->evdev;
776 retval = mutex_lock_interruptible(&evdev->mutex);
785 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
788 mutex_unlock(&evdev->mutex);
792 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
794 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
798 static long evdev_ioctl_compat(struct file *file,
799 unsigned int cmd, unsigned long arg)
801 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
805 static const struct file_operations evdev_fops = {
806 .owner = THIS_MODULE,
808 .write = evdev_write,
811 .release = evdev_release,
812 .unlocked_ioctl = evdev_ioctl,
814 .compat_ioctl = evdev_ioctl_compat,
816 .fasync = evdev_fasync,
820 static int evdev_install_chrdev(struct evdev *evdev)
823 * No need to do any locking here as calls to connect and
824 * disconnect are serialized by the input core
826 evdev_table[evdev->minor] = evdev;
830 static void evdev_remove_chrdev(struct evdev *evdev)
833 * Lock evdev table to prevent race with evdev_open()
835 mutex_lock(&evdev_table_mutex);
836 evdev_table[evdev->minor] = NULL;
837 mutex_unlock(&evdev_table_mutex);
841 * Mark device non-existent. This disables writes, ioctls and
842 * prevents new users from opening the device. Already posted
843 * blocking reads will stay, however new ones will fail.
845 static void evdev_mark_dead(struct evdev *evdev)
847 mutex_lock(&evdev->mutex);
849 mutex_unlock(&evdev->mutex);
852 static void evdev_cleanup(struct evdev *evdev)
854 struct input_handle *handle = &evdev->handle;
856 evdev_mark_dead(evdev);
858 evdev_remove_chrdev(evdev);
860 /* evdev is marked dead so no one else accesses evdev->open */
862 input_flush_device(handle, NULL);
863 input_close_device(handle);
868 * Create new evdev device. Note that input core serializes calls
869 * to connect and disconnect so we don't need to lock evdev_table here.
871 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
872 const struct input_device_id *id)
878 for (minor = 0; minor < EVDEV_MINORS; minor++)
879 if (!evdev_table[minor])
882 if (minor == EVDEV_MINORS) {
883 printk(KERN_ERR "evdev: no more free evdev devices\n");
887 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
891 INIT_LIST_HEAD(&evdev->client_list);
892 spin_lock_init(&evdev->client_lock);
893 mutex_init(&evdev->mutex);
894 init_waitqueue_head(&evdev->wait);
896 snprintf(evdev->name, sizeof(evdev->name), "event%d", minor);
898 evdev->minor = minor;
900 evdev->handle.dev = dev;
901 evdev->handle.name = evdev->name;
902 evdev->handle.handler = handler;
903 evdev->handle.private = evdev;
905 strlcpy(evdev->dev.bus_id, evdev->name, sizeof(evdev->dev.bus_id));
906 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
907 evdev->dev.class = &input_class;
908 evdev->dev.parent = &dev->dev;
909 evdev->dev.release = evdev_free;
910 device_initialize(&evdev->dev);
912 error = input_register_handle(&evdev->handle);
916 error = evdev_install_chrdev(evdev);
918 goto err_unregister_handle;
920 error = device_add(&evdev->dev);
922 goto err_cleanup_evdev;
927 evdev_cleanup(evdev);
928 err_unregister_handle:
929 input_unregister_handle(&evdev->handle);
931 put_device(&evdev->dev);
935 static void evdev_disconnect(struct input_handle *handle)
937 struct evdev *evdev = handle->private;
939 device_del(&evdev->dev);
940 evdev_cleanup(evdev);
941 input_unregister_handle(handle);
942 put_device(&evdev->dev);
945 static const struct input_device_id evdev_ids[] = {
946 { .driver_info = 1 }, /* Matches all devices */
947 { }, /* Terminating zero entry */
950 MODULE_DEVICE_TABLE(input, evdev_ids);
952 static struct input_handler evdev_handler = {
953 .event = evdev_event,
954 .connect = evdev_connect,
955 .disconnect = evdev_disconnect,
957 .minor = EVDEV_MINOR_BASE,
959 .id_table = evdev_ids,
962 static int __init evdev_init(void)
964 return input_register_handler(&evdev_handler);
967 static void __exit evdev_exit(void)
969 input_unregister_handler(&evdev_handler);
972 module_init(evdev_init);
973 module_exit(evdev_exit);
975 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
976 MODULE_DESCRIPTION("Input driver event char devices");
977 MODULE_LICENSE("GPL");