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);
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);
296 struct input_event_compat {
297 struct compat_timeval time;
303 struct ff_periodic_effect_compat {
310 struct ff_envelope envelope;
313 compat_uptr_t custom_data;
316 struct ff_effect_compat {
320 struct ff_trigger trigger;
321 struct ff_replay replay;
324 struct ff_constant_effect constant;
325 struct ff_ramp_effect ramp;
326 struct ff_periodic_effect_compat periodic;
327 struct ff_condition_effect condition[2]; /* One for each axis */
328 struct ff_rumble_effect rumble;
332 /* Note to the author of this code: did it ever occur to
333 you why the ifdefs are needed? Think about it again. -AK */
335 # define COMPAT_TEST is_compat_task()
336 #elif defined(CONFIG_IA64)
337 # define COMPAT_TEST IS_IA32_PROCESS(task_pt_regs(current))
338 #elif defined(CONFIG_S390)
339 # define COMPAT_TEST test_thread_flag(TIF_31BIT)
340 #elif defined(CONFIG_MIPS)
341 # define COMPAT_TEST test_thread_flag(TIF_32BIT_ADDR)
343 # define COMPAT_TEST test_thread_flag(TIF_32BIT)
346 static inline size_t evdev_event_size(void)
349 sizeof(struct input_event_compat) : sizeof(struct input_event);
352 static int evdev_event_from_user(const char __user *buffer,
353 struct input_event *event)
356 struct input_event_compat compat_event;
358 if (copy_from_user(&compat_event, buffer,
359 sizeof(struct input_event_compat)))
362 event->time.tv_sec = compat_event.time.tv_sec;
363 event->time.tv_usec = compat_event.time.tv_usec;
364 event->type = compat_event.type;
365 event->code = compat_event.code;
366 event->value = compat_event.value;
369 if (copy_from_user(event, buffer, sizeof(struct input_event)))
376 static int evdev_event_to_user(char __user *buffer,
377 const struct input_event *event)
380 struct input_event_compat compat_event;
382 compat_event.time.tv_sec = event->time.tv_sec;
383 compat_event.time.tv_usec = event->time.tv_usec;
384 compat_event.type = event->type;
385 compat_event.code = event->code;
386 compat_event.value = event->value;
388 if (copy_to_user(buffer, &compat_event,
389 sizeof(struct input_event_compat)))
393 if (copy_to_user(buffer, event, sizeof(struct input_event)))
400 static int evdev_ff_effect_from_user(const char __user *buffer, size_t size,
401 struct ff_effect *effect)
404 struct ff_effect_compat *compat_effect;
406 if (size != sizeof(struct ff_effect_compat))
410 * It so happens that the pointer which needs to be changed
411 * is the last field in the structure, so we can copy the
412 * whole thing and replace just the pointer.
415 compat_effect = (struct ff_effect_compat *)effect;
417 if (copy_from_user(compat_effect, buffer,
418 sizeof(struct ff_effect_compat)))
421 if (compat_effect->type == FF_PERIODIC &&
422 compat_effect->u.periodic.waveform == FF_CUSTOM)
423 effect->u.periodic.custom_data =
424 compat_ptr(compat_effect->u.periodic.custom_data);
426 if (size != sizeof(struct ff_effect))
429 if (copy_from_user(effect, buffer, sizeof(struct ff_effect)))
438 static inline size_t evdev_event_size(void)
440 return sizeof(struct input_event);
443 static int evdev_event_from_user(const char __user *buffer,
444 struct input_event *event)
446 if (copy_from_user(event, buffer, sizeof(struct input_event)))
452 static int evdev_event_to_user(char __user *buffer,
453 const struct input_event *event)
455 if (copy_to_user(buffer, event, sizeof(struct input_event)))
461 static int evdev_ff_effect_from_user(const char __user *buffer, size_t size,
462 struct ff_effect *effect)
464 if (size != sizeof(struct ff_effect))
467 if (copy_from_user(effect, buffer, sizeof(struct ff_effect)))
473 #endif /* CONFIG_COMPAT */
475 static ssize_t evdev_write(struct file *file, const char __user *buffer,
476 size_t count, loff_t *ppos)
478 struct evdev_client *client = file->private_data;
479 struct evdev *evdev = client->evdev;
480 struct input_event event;
483 retval = mutex_lock_interruptible(&evdev->mutex);
492 while (retval < count) {
494 if (evdev_event_from_user(buffer + retval, &event)) {
499 input_inject_event(&evdev->handle,
500 event.type, event.code, event.value);
501 retval += evdev_event_size();
505 mutex_unlock(&evdev->mutex);
509 static int evdev_fetch_next_event(struct evdev_client *client,
510 struct input_event *event)
514 spin_lock_irq(&client->buffer_lock);
516 have_event = client->head != client->tail;
518 *event = client->buffer[client->tail++];
519 client->tail &= EVDEV_BUFFER_SIZE - 1;
522 spin_unlock_irq(&client->buffer_lock);
527 static ssize_t evdev_read(struct file *file, char __user *buffer,
528 size_t count, loff_t *ppos)
530 struct evdev_client *client = file->private_data;
531 struct evdev *evdev = client->evdev;
532 struct input_event event;
535 if (count < evdev_event_size())
538 if (client->head == client->tail && evdev->exist &&
539 (file->f_flags & O_NONBLOCK))
542 retval = wait_event_interruptible(evdev->wait,
543 client->head != client->tail || !evdev->exist);
550 while (retval + evdev_event_size() <= count &&
551 evdev_fetch_next_event(client, &event)) {
553 if (evdev_event_to_user(buffer + retval, &event))
556 retval += evdev_event_size();
562 /* No kernel lock - fine */
563 static unsigned int evdev_poll(struct file *file, poll_table *wait)
565 struct evdev_client *client = file->private_data;
566 struct evdev *evdev = client->evdev;
568 poll_wait(file, &evdev->wait, wait);
569 return ((client->head == client->tail) ? 0 : (POLLIN | POLLRDNORM)) |
570 (evdev->exist ? 0 : (POLLHUP | POLLERR));
575 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
576 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
579 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
580 unsigned int maxlen, void __user *p, int compat)
585 len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
589 for (i = 0; i < len / sizeof(compat_long_t); i++)
590 if (copy_to_user((compat_long_t __user *) p + i,
591 (compat_long_t *) bits +
592 i + 1 - ((i % 2) << 1),
593 sizeof(compat_long_t)))
596 len = BITS_TO_LONGS(maxbit) * sizeof(long);
600 if (copy_to_user(p, bits, len))
607 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
608 unsigned int maxlen, void __user *p, int compat)
611 BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
612 BITS_TO_LONGS(maxbit) * sizeof(long);
617 return copy_to_user(p, bits, len) ? -EFAULT : len;
619 #endif /* __BIG_ENDIAN */
623 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
624 unsigned int maxlen, void __user *p, int compat)
626 int len = BITS_TO_LONGS(maxbit) * sizeof(long);
631 return copy_to_user(p, bits, len) ? -EFAULT : len;
634 #endif /* CONFIG_COMPAT */
636 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
643 len = strlen(str) + 1;
647 return copy_to_user(p, str, len) ? -EFAULT : len;
650 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
651 void __user *p, int compat_mode)
653 struct evdev_client *client = file->private_data;
654 struct evdev *evdev = client->evdev;
655 struct input_dev *dev = evdev->handle.dev;
656 struct input_absinfo abs;
657 struct ff_effect effect;
658 int __user *ip = (int __user *)p;
665 return put_user(EV_VERSION, ip);
668 if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
673 if (!test_bit(EV_REP, dev->evbit))
675 if (put_user(dev->rep[REP_DELAY], ip))
677 if (put_user(dev->rep[REP_PERIOD], ip + 1))
682 if (!test_bit(EV_REP, dev->evbit))
686 if (get_user(v, ip + 1))
689 input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
690 input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
698 error = input_get_keycode(dev, t, &v);
702 if (put_user(v, ip + 1))
708 if (get_user(t, ip) || get_user(v, ip + 1))
711 return input_set_keycode(dev, t, v);
714 return input_ff_erase(dev, (int)(unsigned long) p, file);
717 i = test_bit(EV_FF, dev->evbit) ?
718 dev->ff->max_effects : 0;
725 return evdev_grab(evdev, client);
727 return evdev_ungrab(evdev, client);
731 if (_IOC_TYPE(cmd) != 'E')
734 if (_IOC_DIR(cmd) == _IOC_READ) {
736 if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0))) {
741 switch (_IOC_NR(cmd) & EV_MAX) {
743 case 0: bits = dev->evbit; len = EV_MAX; break;
744 case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
745 case EV_REL: bits = dev->relbit; len = REL_MAX; break;
746 case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
747 case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
748 case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
749 case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
750 case EV_FF: bits = dev->ffbit; len = FF_MAX; break;
751 case EV_SW: bits = dev->swbit; len = SW_MAX; break;
752 default: return -EINVAL;
754 return bits_to_user(bits, len, _IOC_SIZE(cmd), p, compat_mode);
757 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGKEY(0)))
758 return bits_to_user(dev->key, KEY_MAX, _IOC_SIZE(cmd),
761 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGLED(0)))
762 return bits_to_user(dev->led, LED_MAX, _IOC_SIZE(cmd),
765 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSND(0)))
766 return bits_to_user(dev->snd, SND_MAX, _IOC_SIZE(cmd),
769 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGSW(0)))
770 return bits_to_user(dev->sw, SW_MAX, _IOC_SIZE(cmd),
773 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGNAME(0)))
774 return str_to_user(dev->name, _IOC_SIZE(cmd), p);
776 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGPHYS(0)))
777 return str_to_user(dev->phys, _IOC_SIZE(cmd), p);
779 if (_IOC_NR(cmd) == _IOC_NR(EVIOCGUNIQ(0)))
780 return str_to_user(dev->uniq, _IOC_SIZE(cmd), p);
782 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
784 t = _IOC_NR(cmd) & ABS_MAX;
786 abs.value = dev->abs[t];
787 abs.minimum = dev->absmin[t];
788 abs.maximum = dev->absmax[t];
789 abs.fuzz = dev->absfuzz[t];
790 abs.flat = dev->absflat[t];
792 if (copy_to_user(p, &abs, sizeof(struct input_absinfo)))
800 if (_IOC_DIR(cmd) == _IOC_WRITE) {
802 if (_IOC_NR(cmd) == _IOC_NR(EVIOCSFF)) {
804 if (evdev_ff_effect_from_user(p, _IOC_SIZE(cmd), &effect))
807 error = input_ff_upload(dev, &effect, file);
809 if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
815 if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
817 t = _IOC_NR(cmd) & ABS_MAX;
819 if (copy_from_user(&abs, p,
820 sizeof(struct input_absinfo)))
824 * Take event lock to ensure that we are not
825 * changing device parameters in the middle
828 spin_lock_irq(&dev->event_lock);
830 dev->abs[t] = abs.value;
831 dev->absmin[t] = abs.minimum;
832 dev->absmax[t] = abs.maximum;
833 dev->absfuzz[t] = abs.fuzz;
834 dev->absflat[t] = abs.flat;
836 spin_unlock_irq(&dev->event_lock);
845 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
846 void __user *p, int compat_mode)
848 struct evdev_client *client = file->private_data;
849 struct evdev *evdev = client->evdev;
852 retval = mutex_lock_interruptible(&evdev->mutex);
861 retval = evdev_do_ioctl(file, cmd, p, compat_mode);
864 mutex_unlock(&evdev->mutex);
868 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
870 return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
874 static long evdev_ioctl_compat(struct file *file,
875 unsigned int cmd, unsigned long arg)
877 return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
881 static const struct file_operations evdev_fops = {
882 .owner = THIS_MODULE,
884 .write = evdev_write,
887 .release = evdev_release,
888 .unlocked_ioctl = evdev_ioctl,
890 .compat_ioctl = evdev_ioctl_compat,
892 .fasync = evdev_fasync,
896 static int evdev_install_chrdev(struct evdev *evdev)
899 * No need to do any locking here as calls to connect and
900 * disconnect are serialized by the input core
902 evdev_table[evdev->minor] = evdev;
906 static void evdev_remove_chrdev(struct evdev *evdev)
909 * Lock evdev table to prevent race with evdev_open()
911 mutex_lock(&evdev_table_mutex);
912 evdev_table[evdev->minor] = NULL;
913 mutex_unlock(&evdev_table_mutex);
917 * Mark device non-existent. This disables writes, ioctls and
918 * prevents new users from opening the device. Already posted
919 * blocking reads will stay, however new ones will fail.
921 static void evdev_mark_dead(struct evdev *evdev)
923 mutex_lock(&evdev->mutex);
925 mutex_unlock(&evdev->mutex);
928 static void evdev_cleanup(struct evdev *evdev)
930 struct input_handle *handle = &evdev->handle;
932 evdev_mark_dead(evdev);
934 evdev_remove_chrdev(evdev);
936 /* evdev is marked dead so no one else accesses evdev->open */
938 input_flush_device(handle, NULL);
939 input_close_device(handle);
944 * Create new evdev device. Note that input core serializes calls
945 * to connect and disconnect so we don't need to lock evdev_table here.
947 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
948 const struct input_device_id *id)
954 for (minor = 0; minor < EVDEV_MINORS; minor++)
955 if (!evdev_table[minor])
958 if (minor == EVDEV_MINORS) {
959 printk(KERN_ERR "evdev: no more free evdev devices\n");
963 evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
967 INIT_LIST_HEAD(&evdev->client_list);
968 spin_lock_init(&evdev->client_lock);
969 mutex_init(&evdev->mutex);
970 init_waitqueue_head(&evdev->wait);
972 snprintf(evdev->name, sizeof(evdev->name), "event%d", minor);
974 evdev->minor = minor;
976 evdev->handle.dev = input_get_device(dev);
977 evdev->handle.name = evdev->name;
978 evdev->handle.handler = handler;
979 evdev->handle.private = evdev;
981 strlcpy(evdev->dev.bus_id, evdev->name, sizeof(evdev->dev.bus_id));
982 evdev->dev.devt = MKDEV(INPUT_MAJOR, EVDEV_MINOR_BASE + minor);
983 evdev->dev.class = &input_class;
984 evdev->dev.parent = &dev->dev;
985 evdev->dev.release = evdev_free;
986 device_initialize(&evdev->dev);
988 error = input_register_handle(&evdev->handle);
992 error = evdev_install_chrdev(evdev);
994 goto err_unregister_handle;
996 error = device_add(&evdev->dev);
998 goto err_cleanup_evdev;
1003 evdev_cleanup(evdev);
1004 err_unregister_handle:
1005 input_unregister_handle(&evdev->handle);
1007 put_device(&evdev->dev);
1011 static void evdev_disconnect(struct input_handle *handle)
1013 struct evdev *evdev = handle->private;
1015 device_del(&evdev->dev);
1016 evdev_cleanup(evdev);
1017 input_unregister_handle(handle);
1018 put_device(&evdev->dev);
1021 static const struct input_device_id evdev_ids[] = {
1022 { .driver_info = 1 }, /* Matches all devices */
1023 { }, /* Terminating zero entry */
1026 MODULE_DEVICE_TABLE(input, evdev_ids);
1028 static struct input_handler evdev_handler = {
1029 .event = evdev_event,
1030 .connect = evdev_connect,
1031 .disconnect = evdev_disconnect,
1032 .fops = &evdev_fops,
1033 .minor = EVDEV_MINOR_BASE,
1035 .id_table = evdev_ids,
1038 static int __init evdev_init(void)
1040 return input_register_handler(&evdev_handler);
1043 static void __exit evdev_exit(void)
1045 input_unregister_handler(&evdev_handler);
1048 module_init(evdev_init);
1049 module_exit(evdev_exit);
1051 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
1052 MODULE_DESCRIPTION("Input driver event char devices");
1053 MODULE_LICENSE("GPL");