2 * User level driver support for input subsystem
4 * Heavily based on evdev.c by Vojtech Pavlik
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * - add UI_GET_SYSNAME ioctl
26 * - updated ff support for the changes in kernel interface
27 * - added MODULE_VERSION
29 * - added force feedback support
32 * - first public version
34 #include <linux/poll.h>
35 #include <linux/sched.h>
36 #include <linux/slab.h>
37 #include <linux/module.h>
38 #include <linux/init.h>
40 #include <linux/miscdevice.h>
41 #include <linux/uinput.h>
42 #include <linux/input/mt.h>
43 #include "../input-compat.h"
45 static int uinput_dev_event(struct input_dev *dev,
46 unsigned int type, unsigned int code, int value)
48 struct uinput_device *udev = input_get_drvdata(dev);
50 udev->buff[udev->head].type = type;
51 udev->buff[udev->head].code = code;
52 udev->buff[udev->head].value = value;
53 do_gettimeofday(&udev->buff[udev->head].time);
54 udev->head = (udev->head + 1) % UINPUT_BUFFER_SIZE;
56 wake_up_interruptible(&udev->waitq);
61 /* Atomically allocate an ID for the given request. Returns 0 on success. */
62 static bool uinput_request_alloc_id(struct uinput_device *udev,
63 struct uinput_request *request)
66 bool reserved = false;
68 spin_lock(&udev->requests_lock);
70 for (id = 0; id < UINPUT_NUM_REQUESTS; id++) {
71 if (!udev->requests[id]) {
73 udev->requests[id] = request;
79 spin_unlock(&udev->requests_lock);
83 static struct uinput_request *uinput_request_find(struct uinput_device *udev,
86 /* Find an input request, by ID. Returns NULL if the ID isn't valid. */
87 if (id >= UINPUT_NUM_REQUESTS)
90 return udev->requests[id];
93 static int uinput_request_reserve_slot(struct uinput_device *udev,
94 struct uinput_request *request)
96 /* Allocate slot. If none are available right away, wait. */
97 return wait_event_interruptible(udev->requests_waitq,
98 uinput_request_alloc_id(udev, request));
101 static void uinput_request_done(struct uinput_device *udev,
102 struct uinput_request *request)
104 /* Mark slot as available */
105 udev->requests[request->id] = NULL;
106 wake_up(&udev->requests_waitq);
108 complete(&request->done);
111 static int uinput_request_send(struct uinput_device *udev,
112 struct uinput_request *request)
116 retval = mutex_lock_interruptible(&udev->mutex);
120 if (udev->state != UIST_CREATED) {
125 init_completion(&request->done);
128 * Tell our userspace application about this new request
129 * by queueing an input event.
131 uinput_dev_event(udev->dev, EV_UINPUT, request->code, request->id);
134 mutex_unlock(&udev->mutex);
138 static int uinput_request_submit(struct uinput_device *udev,
139 struct uinput_request *request)
143 error = uinput_request_reserve_slot(udev, request);
147 error = uinput_request_send(udev, request);
149 uinput_request_done(udev, request);
153 wait_for_completion(&request->done);
154 return request->retval;
158 * Fail all outstanding requests so handlers don't wait for the userspace
159 * to finish processing them.
161 static void uinput_flush_requests(struct uinput_device *udev)
163 struct uinput_request *request;
166 spin_lock(&udev->requests_lock);
168 for (i = 0; i < UINPUT_NUM_REQUESTS; i++) {
169 request = udev->requests[i];
171 request->retval = -ENODEV;
172 uinput_request_done(udev, request);
176 spin_unlock(&udev->requests_lock);
179 static void uinput_dev_set_gain(struct input_dev *dev, u16 gain)
181 uinput_dev_event(dev, EV_FF, FF_GAIN, gain);
184 static void uinput_dev_set_autocenter(struct input_dev *dev, u16 magnitude)
186 uinput_dev_event(dev, EV_FF, FF_AUTOCENTER, magnitude);
189 static int uinput_dev_playback(struct input_dev *dev, int effect_id, int value)
191 return uinput_dev_event(dev, EV_FF, effect_id, value);
194 static int uinput_dev_upload_effect(struct input_dev *dev,
195 struct ff_effect *effect,
196 struct ff_effect *old)
198 struct uinput_device *udev = input_get_drvdata(dev);
199 struct uinput_request request;
202 * uinput driver does not currently support periodic effects with
203 * custom waveform since it does not have a way to pass buffer of
204 * samples (custom_data) to userspace. If ever there is a device
205 * supporting custom waveforms we would need to define an additional
206 * ioctl (UI_UPLOAD_SAMPLES) but for now we just bail out.
208 if (effect->type == FF_PERIODIC &&
209 effect->u.periodic.waveform == FF_CUSTOM)
212 request.code = UI_FF_UPLOAD;
213 request.u.upload.effect = effect;
214 request.u.upload.old = old;
216 return uinput_request_submit(udev, &request);
219 static int uinput_dev_erase_effect(struct input_dev *dev, int effect_id)
221 struct uinput_device *udev = input_get_drvdata(dev);
222 struct uinput_request request;
224 if (!test_bit(EV_FF, dev->evbit))
227 request.code = UI_FF_ERASE;
228 request.u.effect_id = effect_id;
230 return uinput_request_submit(udev, &request);
233 static void uinput_destroy_device(struct uinput_device *udev)
235 const char *name, *phys;
236 struct input_dev *dev = udev->dev;
237 enum uinput_state old_state = udev->state;
239 udev->state = UIST_NEW_DEVICE;
244 if (old_state == UIST_CREATED) {
245 uinput_flush_requests(udev);
246 input_unregister_device(dev);
248 input_free_device(dev);
256 static int uinput_create_device(struct uinput_device *udev)
258 struct input_dev *dev = udev->dev;
261 if (udev->state != UIST_SETUP_COMPLETE) {
262 printk(KERN_DEBUG "%s: write device info first\n", UINPUT_NAME);
266 if (test_bit(EV_ABS, dev->evbit)) {
267 input_alloc_absinfo(dev);
273 if (test_bit(ABS_MT_SLOT, dev->absbit)) {
274 nslot = input_abs_get_max(dev, ABS_MT_SLOT) + 1;
275 error = input_mt_init_slots(dev, nslot, 0);
278 } else if (test_bit(ABS_MT_POSITION_X, dev->absbit)) {
279 input_set_events_per_packet(dev, 60);
283 if (test_bit(EV_FF, dev->evbit) && !udev->ff_effects_max) {
284 printk(KERN_DEBUG "%s: ff_effects_max should be non-zero when FF_BIT is set\n",
290 if (udev->ff_effects_max) {
291 error = input_ff_create(dev, udev->ff_effects_max);
295 dev->ff->upload = uinput_dev_upload_effect;
296 dev->ff->erase = uinput_dev_erase_effect;
297 dev->ff->playback = uinput_dev_playback;
298 dev->ff->set_gain = uinput_dev_set_gain;
299 dev->ff->set_autocenter = uinput_dev_set_autocenter;
302 error = input_register_device(udev->dev);
306 udev->state = UIST_CREATED;
310 fail2: input_ff_destroy(dev);
311 fail1: uinput_destroy_device(udev);
315 static int uinput_open(struct inode *inode, struct file *file)
317 struct uinput_device *newdev;
319 newdev = kzalloc(sizeof(struct uinput_device), GFP_KERNEL);
323 mutex_init(&newdev->mutex);
324 spin_lock_init(&newdev->requests_lock);
325 init_waitqueue_head(&newdev->requests_waitq);
326 init_waitqueue_head(&newdev->waitq);
327 newdev->state = UIST_NEW_DEVICE;
329 file->private_data = newdev;
330 nonseekable_open(inode, file);
335 static int uinput_validate_absinfo(struct input_dev *dev, unsigned int code,
336 const struct input_absinfo *abs)
343 if ((min != 0 || max != 0) && max <= min) {
345 "%s: invalid abs[%02x] min:%d max:%d\n",
346 UINPUT_NAME, code, min, max);
350 if (abs->flat > max - min) {
352 "%s: abs_flat #%02x out of range: %d (min:%d/max:%d)\n",
353 UINPUT_NAME, code, abs->flat, min, max);
360 static int uinput_validate_absbits(struct input_dev *dev)
365 if (!test_bit(EV_ABS, dev->evbit))
369 * Check if absmin/absmax/absfuzz/absflat are sane.
372 for_each_set_bit(cnt, dev->absbit, ABS_CNT) {
376 error = uinput_validate_absinfo(dev, cnt, &dev->absinfo[cnt]);
384 static int uinput_allocate_device(struct uinput_device *udev)
386 udev->dev = input_allocate_device();
390 udev->dev->event = uinput_dev_event;
391 input_set_drvdata(udev->dev, udev);
396 static int uinput_dev_setup(struct uinput_device *udev,
397 struct uinput_setup __user *arg)
399 struct uinput_setup setup;
400 struct input_dev *dev;
402 if (udev->state == UIST_CREATED)
405 if (copy_from_user(&setup, arg, sizeof(setup)))
413 udev->ff_effects_max = setup.ff_effects_max;
416 dev->name = kstrndup(setup.name, UINPUT_MAX_NAME_SIZE, GFP_KERNEL);
420 udev->state = UIST_SETUP_COMPLETE;
424 static int uinput_abs_setup(struct uinput_device *udev,
425 struct uinput_setup __user *arg, size_t size)
427 struct uinput_abs_setup setup = {};
428 struct input_dev *dev;
431 if (size > sizeof(setup))
434 if (udev->state == UIST_CREATED)
437 if (copy_from_user(&setup, arg, size))
440 if (setup.code > ABS_MAX)
445 error = uinput_validate_absinfo(dev, setup.code, &setup.absinfo);
449 input_alloc_absinfo(dev);
453 set_bit(setup.code, dev->absbit);
454 dev->absinfo[setup.code] = setup.absinfo;
458 /* legacy setup via write() */
459 static int uinput_setup_device_legacy(struct uinput_device *udev,
460 const char __user *buffer, size_t count)
462 struct uinput_user_dev *user_dev;
463 struct input_dev *dev;
467 if (count != sizeof(struct uinput_user_dev))
471 retval = uinput_allocate_device(udev);
478 user_dev = memdup_user(buffer, sizeof(struct uinput_user_dev));
479 if (IS_ERR(user_dev))
480 return PTR_ERR(user_dev);
482 udev->ff_effects_max = user_dev->ff_effects_max;
484 /* Ensure name is filled in */
485 if (!user_dev->name[0]) {
491 dev->name = kstrndup(user_dev->name, UINPUT_MAX_NAME_SIZE,
498 dev->id.bustype = user_dev->id.bustype;
499 dev->id.vendor = user_dev->id.vendor;
500 dev->id.product = user_dev->id.product;
501 dev->id.version = user_dev->id.version;
503 for (i = 0; i < ABS_CNT; i++) {
504 input_abs_set_max(dev, i, user_dev->absmax[i]);
505 input_abs_set_min(dev, i, user_dev->absmin[i]);
506 input_abs_set_fuzz(dev, i, user_dev->absfuzz[i]);
507 input_abs_set_flat(dev, i, user_dev->absflat[i]);
510 retval = uinput_validate_absbits(dev);
514 udev->state = UIST_SETUP_COMPLETE;
522 static ssize_t uinput_inject_events(struct uinput_device *udev,
523 const char __user *buffer, size_t count)
525 struct input_event ev;
528 if (count != 0 && count < input_event_size())
531 while (bytes + input_event_size() <= count) {
533 * Note that even if some events were fetched successfully
534 * we are still going to return EFAULT instead of partial
535 * count to let userspace know that it got it's buffers
538 if (input_event_from_user(buffer + bytes, &ev))
541 input_event(udev->dev, ev.type, ev.code, ev.value);
542 bytes += input_event_size();
548 static ssize_t uinput_write(struct file *file, const char __user *buffer,
549 size_t count, loff_t *ppos)
551 struct uinput_device *udev = file->private_data;
557 retval = mutex_lock_interruptible(&udev->mutex);
561 retval = udev->state == UIST_CREATED ?
562 uinput_inject_events(udev, buffer, count) :
563 uinput_setup_device_legacy(udev, buffer, count);
565 mutex_unlock(&udev->mutex);
570 static bool uinput_fetch_next_event(struct uinput_device *udev,
571 struct input_event *event)
575 spin_lock_irq(&udev->dev->event_lock);
577 have_event = udev->head != udev->tail;
579 *event = udev->buff[udev->tail];
580 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
583 spin_unlock_irq(&udev->dev->event_lock);
588 static ssize_t uinput_events_to_user(struct uinput_device *udev,
589 char __user *buffer, size_t count)
591 struct input_event event;
594 while (read + input_event_size() <= count &&
595 uinput_fetch_next_event(udev, &event)) {
597 if (input_event_to_user(buffer + read, &event))
600 read += input_event_size();
606 static ssize_t uinput_read(struct file *file, char __user *buffer,
607 size_t count, loff_t *ppos)
609 struct uinput_device *udev = file->private_data;
612 if (count != 0 && count < input_event_size())
616 retval = mutex_lock_interruptible(&udev->mutex);
620 if (udev->state != UIST_CREATED)
622 else if (udev->head == udev->tail &&
623 (file->f_flags & O_NONBLOCK))
626 retval = uinput_events_to_user(udev, buffer, count);
628 mutex_unlock(&udev->mutex);
630 if (retval || count == 0)
633 if (!(file->f_flags & O_NONBLOCK))
634 retval = wait_event_interruptible(udev->waitq,
635 udev->head != udev->tail ||
636 udev->state != UIST_CREATED);
637 } while (retval == 0);
642 static unsigned int uinput_poll(struct file *file, poll_table *wait)
644 struct uinput_device *udev = file->private_data;
646 poll_wait(file, &udev->waitq, wait);
648 if (udev->head != udev->tail)
649 return POLLIN | POLLRDNORM;
654 static int uinput_release(struct inode *inode, struct file *file)
656 struct uinput_device *udev = file->private_data;
658 uinput_destroy_device(udev);
665 struct uinput_ff_upload_compat {
668 struct ff_effect_compat effect;
669 struct ff_effect_compat old;
672 static int uinput_ff_upload_to_user(char __user *buffer,
673 const struct uinput_ff_upload *ff_up)
675 if (in_compat_syscall()) {
676 struct uinput_ff_upload_compat ff_up_compat;
678 ff_up_compat.request_id = ff_up->request_id;
679 ff_up_compat.retval = ff_up->retval;
681 * It so happens that the pointer that gives us the trouble
682 * is the last field in the structure. Since we don't support
683 * custom waveforms in uinput anyway we can just copy the whole
684 * thing (to the compat size) and ignore the pointer.
686 memcpy(&ff_up_compat.effect, &ff_up->effect,
687 sizeof(struct ff_effect_compat));
688 memcpy(&ff_up_compat.old, &ff_up->old,
689 sizeof(struct ff_effect_compat));
691 if (copy_to_user(buffer, &ff_up_compat,
692 sizeof(struct uinput_ff_upload_compat)))
695 if (copy_to_user(buffer, ff_up,
696 sizeof(struct uinput_ff_upload)))
703 static int uinput_ff_upload_from_user(const char __user *buffer,
704 struct uinput_ff_upload *ff_up)
706 if (in_compat_syscall()) {
707 struct uinput_ff_upload_compat ff_up_compat;
709 if (copy_from_user(&ff_up_compat, buffer,
710 sizeof(struct uinput_ff_upload_compat)))
713 ff_up->request_id = ff_up_compat.request_id;
714 ff_up->retval = ff_up_compat.retval;
715 memcpy(&ff_up->effect, &ff_up_compat.effect,
716 sizeof(struct ff_effect_compat));
717 memcpy(&ff_up->old, &ff_up_compat.old,
718 sizeof(struct ff_effect_compat));
721 if (copy_from_user(ff_up, buffer,
722 sizeof(struct uinput_ff_upload)))
731 static int uinput_ff_upload_to_user(char __user *buffer,
732 const struct uinput_ff_upload *ff_up)
734 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
740 static int uinput_ff_upload_from_user(const char __user *buffer,
741 struct uinput_ff_upload *ff_up)
743 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
751 #define uinput_set_bit(_arg, _bit, _max) \
754 if (udev->state == UIST_CREATED) \
756 else if ((_arg) > (_max)) \
758 else set_bit((_arg), udev->dev->_bit); \
762 static int uinput_str_to_user(void __user *dest, const char *str,
765 char __user *p = dest;
774 len = strlen(str) + 1;
778 ret = copy_to_user(p, str, len);
782 /* force terminating '\0' */
783 ret = put_user(0, p + len - 1);
784 return ret ? -EFAULT : len;
787 static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
788 unsigned long arg, void __user *p)
791 struct uinput_device *udev = file->private_data;
792 struct uinput_ff_upload ff_up;
793 struct uinput_ff_erase ff_erase;
794 struct uinput_request *req;
799 retval = mutex_lock_interruptible(&udev->mutex);
804 retval = uinput_allocate_device(udev);
811 if (put_user(UINPUT_VERSION,
812 (unsigned int __user *)p))
817 retval = uinput_create_device(udev);
821 uinput_destroy_device(udev);
825 retval = uinput_dev_setup(udev, p);
828 /* UI_ABS_SETUP is handled in the variable size ioctls */
831 retval = uinput_set_bit(arg, evbit, EV_MAX);
835 retval = uinput_set_bit(arg, keybit, KEY_MAX);
839 retval = uinput_set_bit(arg, relbit, REL_MAX);
843 retval = uinput_set_bit(arg, absbit, ABS_MAX);
847 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
851 retval = uinput_set_bit(arg, ledbit, LED_MAX);
855 retval = uinput_set_bit(arg, sndbit, SND_MAX);
859 retval = uinput_set_bit(arg, ffbit, FF_MAX);
863 retval = uinput_set_bit(arg, swbit, SW_MAX);
867 retval = uinput_set_bit(arg, propbit, INPUT_PROP_MAX);
871 if (udev->state == UIST_CREATED) {
876 phys = strndup_user(p, 1024);
878 retval = PTR_ERR(phys);
882 kfree(udev->dev->phys);
883 udev->dev->phys = phys;
886 case UI_BEGIN_FF_UPLOAD:
887 retval = uinput_ff_upload_from_user(p, &ff_up);
891 req = uinput_request_find(udev, ff_up.request_id);
892 if (!req || req->code != UI_FF_UPLOAD ||
893 !req->u.upload.effect) {
899 ff_up.effect = *req->u.upload.effect;
900 if (req->u.upload.old)
901 ff_up.old = *req->u.upload.old;
903 memset(&ff_up.old, 0, sizeof(struct ff_effect));
905 retval = uinput_ff_upload_to_user(p, &ff_up);
908 case UI_BEGIN_FF_ERASE:
909 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
914 req = uinput_request_find(udev, ff_erase.request_id);
915 if (!req || req->code != UI_FF_ERASE) {
921 ff_erase.effect_id = req->u.effect_id;
922 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
929 case UI_END_FF_UPLOAD:
930 retval = uinput_ff_upload_from_user(p, &ff_up);
934 req = uinput_request_find(udev, ff_up.request_id);
935 if (!req || req->code != UI_FF_UPLOAD ||
936 !req->u.upload.effect) {
941 req->retval = ff_up.retval;
942 uinput_request_done(udev, req);
945 case UI_END_FF_ERASE:
946 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
951 req = uinput_request_find(udev, ff_erase.request_id);
952 if (!req || req->code != UI_FF_ERASE) {
957 req->retval = ff_erase.retval;
958 uinput_request_done(udev, req);
962 size = _IOC_SIZE(cmd);
964 /* Now check variable-length commands */
965 switch (cmd & ~IOCSIZE_MASK) {
966 case UI_GET_SYSNAME(0):
967 if (udev->state != UIST_CREATED) {
971 name = dev_name(&udev->dev->dev);
972 retval = uinput_str_to_user(p, name, size);
975 case UI_ABS_SETUP & ~IOCSIZE_MASK:
976 retval = uinput_abs_setup(udev, p, size);
982 mutex_unlock(&udev->mutex);
986 static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
988 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
993 #define UI_SET_PHYS_COMPAT _IOW(UINPUT_IOCTL_BASE, 108, compat_uptr_t)
995 static long uinput_compat_ioctl(struct file *file,
996 unsigned int cmd, unsigned long arg)
998 if (cmd == UI_SET_PHYS_COMPAT)
1001 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
1005 static const struct file_operations uinput_fops = {
1006 .owner = THIS_MODULE,
1007 .open = uinput_open,
1008 .release = uinput_release,
1009 .read = uinput_read,
1010 .write = uinput_write,
1011 .poll = uinput_poll,
1012 .unlocked_ioctl = uinput_ioctl,
1013 #ifdef CONFIG_COMPAT
1014 .compat_ioctl = uinput_compat_ioctl,
1016 .llseek = no_llseek,
1019 static struct miscdevice uinput_misc = {
1020 .fops = &uinput_fops,
1021 .minor = UINPUT_MINOR,
1022 .name = UINPUT_NAME,
1024 module_misc_device(uinput_misc);
1026 MODULE_ALIAS_MISCDEV(UINPUT_MINOR);
1027 MODULE_ALIAS("devname:" UINPUT_NAME);
1029 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
1030 MODULE_DESCRIPTION("User level driver support for input subsystem");
1031 MODULE_LICENSE("GPL");
1032 MODULE_VERSION("0.3");