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 (udev->ff_effects_max) {
267 error = input_ff_create(dev, udev->ff_effects_max);
271 dev->ff->upload = uinput_dev_upload_effect;
272 dev->ff->erase = uinput_dev_erase_effect;
273 dev->ff->playback = uinput_dev_playback;
274 dev->ff->set_gain = uinput_dev_set_gain;
275 dev->ff->set_autocenter = uinput_dev_set_autocenter;
278 error = input_register_device(udev->dev);
282 udev->state = UIST_CREATED;
286 fail2: input_ff_destroy(dev);
287 fail1: uinput_destroy_device(udev);
291 static int uinput_open(struct inode *inode, struct file *file)
293 struct uinput_device *newdev;
295 newdev = kzalloc(sizeof(struct uinput_device), GFP_KERNEL);
299 mutex_init(&newdev->mutex);
300 spin_lock_init(&newdev->requests_lock);
301 init_waitqueue_head(&newdev->requests_waitq);
302 init_waitqueue_head(&newdev->waitq);
303 newdev->state = UIST_NEW_DEVICE;
305 file->private_data = newdev;
306 nonseekable_open(inode, file);
311 static int uinput_validate_absbits(struct input_dev *dev)
316 for (cnt = 0; cnt < ABS_CNT; cnt++) {
318 if (!test_bit(cnt, dev->absbit))
321 min = input_abs_get_min(dev, cnt);
322 max = input_abs_get_max(dev, cnt);
324 if ((min != 0 || max != 0) && max <= min) {
326 "%s: invalid abs[%02x] min:%d max:%d\n",
328 input_abs_get_min(dev, cnt),
329 input_abs_get_max(dev, cnt));
334 if (input_abs_get_flat(dev, cnt) >
335 input_abs_get_max(dev, cnt) - input_abs_get_min(dev, cnt)) {
337 "%s: abs_flat #%02x out of range: %d "
340 input_abs_get_flat(dev, cnt),
341 input_abs_get_min(dev, cnt),
342 input_abs_get_max(dev, cnt));
350 static int uinput_allocate_device(struct uinput_device *udev)
352 udev->dev = input_allocate_device();
356 udev->dev->event = uinput_dev_event;
357 input_set_drvdata(udev->dev, udev);
362 static int uinput_setup_device(struct uinput_device *udev,
363 const char __user *buffer, size_t count)
365 struct uinput_user_dev *user_dev;
366 struct input_dev *dev;
370 if (count != sizeof(struct uinput_user_dev))
374 retval = uinput_allocate_device(udev);
381 user_dev = memdup_user(buffer, sizeof(struct uinput_user_dev));
382 if (IS_ERR(user_dev))
383 return PTR_ERR(user_dev);
385 udev->ff_effects_max = user_dev->ff_effects_max;
387 /* Ensure name is filled in */
388 if (!user_dev->name[0]) {
394 dev->name = kstrndup(user_dev->name, UINPUT_MAX_NAME_SIZE,
401 dev->id.bustype = user_dev->id.bustype;
402 dev->id.vendor = user_dev->id.vendor;
403 dev->id.product = user_dev->id.product;
404 dev->id.version = user_dev->id.version;
406 for (i = 0; i < ABS_CNT; i++) {
407 input_abs_set_max(dev, i, user_dev->absmax[i]);
408 input_abs_set_min(dev, i, user_dev->absmin[i]);
409 input_abs_set_fuzz(dev, i, user_dev->absfuzz[i]);
410 input_abs_set_flat(dev, i, user_dev->absflat[i]);
413 /* check if absmin/absmax/absfuzz/absflat are filled as
414 * told in Documentation/input/input-programming.txt */
415 if (test_bit(EV_ABS, dev->evbit)) {
416 retval = uinput_validate_absbits(dev);
419 if (test_bit(ABS_MT_SLOT, dev->absbit)) {
420 int nslot = input_abs_get_max(dev, ABS_MT_SLOT) + 1;
421 input_mt_init_slots(dev, nslot, 0);
422 } else if (test_bit(ABS_MT_POSITION_X, dev->absbit)) {
423 input_set_events_per_packet(dev, 60);
427 udev->state = UIST_SETUP_COMPLETE;
435 static ssize_t uinput_inject_events(struct uinput_device *udev,
436 const char __user *buffer, size_t count)
438 struct input_event ev;
441 if (count != 0 && count < input_event_size())
444 while (bytes + input_event_size() <= count) {
446 * Note that even if some events were fetched successfully
447 * we are still going to return EFAULT instead of partial
448 * count to let userspace know that it got it's buffers
451 if (input_event_from_user(buffer + bytes, &ev))
454 input_event(udev->dev, ev.type, ev.code, ev.value);
455 bytes += input_event_size();
461 static ssize_t uinput_write(struct file *file, const char __user *buffer,
462 size_t count, loff_t *ppos)
464 struct uinput_device *udev = file->private_data;
470 retval = mutex_lock_interruptible(&udev->mutex);
474 retval = udev->state == UIST_CREATED ?
475 uinput_inject_events(udev, buffer, count) :
476 uinput_setup_device(udev, buffer, count);
478 mutex_unlock(&udev->mutex);
483 static bool uinput_fetch_next_event(struct uinput_device *udev,
484 struct input_event *event)
488 spin_lock_irq(&udev->dev->event_lock);
490 have_event = udev->head != udev->tail;
492 *event = udev->buff[udev->tail];
493 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
496 spin_unlock_irq(&udev->dev->event_lock);
501 static ssize_t uinput_events_to_user(struct uinput_device *udev,
502 char __user *buffer, size_t count)
504 struct input_event event;
507 while (read + input_event_size() <= count &&
508 uinput_fetch_next_event(udev, &event)) {
510 if (input_event_to_user(buffer + read, &event))
513 read += input_event_size();
519 static ssize_t uinput_read(struct file *file, char __user *buffer,
520 size_t count, loff_t *ppos)
522 struct uinput_device *udev = file->private_data;
525 if (count != 0 && count < input_event_size())
529 retval = mutex_lock_interruptible(&udev->mutex);
533 if (udev->state != UIST_CREATED)
535 else if (udev->head == udev->tail &&
536 (file->f_flags & O_NONBLOCK))
539 retval = uinput_events_to_user(udev, buffer, count);
541 mutex_unlock(&udev->mutex);
543 if (retval || count == 0)
546 if (!(file->f_flags & O_NONBLOCK))
547 retval = wait_event_interruptible(udev->waitq,
548 udev->head != udev->tail ||
549 udev->state != UIST_CREATED);
550 } while (retval == 0);
555 static unsigned int uinput_poll(struct file *file, poll_table *wait)
557 struct uinput_device *udev = file->private_data;
559 poll_wait(file, &udev->waitq, wait);
561 if (udev->head != udev->tail)
562 return POLLIN | POLLRDNORM;
567 static int uinput_release(struct inode *inode, struct file *file)
569 struct uinput_device *udev = file->private_data;
571 uinput_destroy_device(udev);
578 struct uinput_ff_upload_compat {
581 struct ff_effect_compat effect;
582 struct ff_effect_compat old;
585 static int uinput_ff_upload_to_user(char __user *buffer,
586 const struct uinput_ff_upload *ff_up)
588 if (INPUT_COMPAT_TEST) {
589 struct uinput_ff_upload_compat ff_up_compat;
591 ff_up_compat.request_id = ff_up->request_id;
592 ff_up_compat.retval = ff_up->retval;
594 * It so happens that the pointer that gives us the trouble
595 * is the last field in the structure. Since we don't support
596 * custom waveforms in uinput anyway we can just copy the whole
597 * thing (to the compat size) and ignore the pointer.
599 memcpy(&ff_up_compat.effect, &ff_up->effect,
600 sizeof(struct ff_effect_compat));
601 memcpy(&ff_up_compat.old, &ff_up->old,
602 sizeof(struct ff_effect_compat));
604 if (copy_to_user(buffer, &ff_up_compat,
605 sizeof(struct uinput_ff_upload_compat)))
608 if (copy_to_user(buffer, ff_up,
609 sizeof(struct uinput_ff_upload)))
616 static int uinput_ff_upload_from_user(const char __user *buffer,
617 struct uinput_ff_upload *ff_up)
619 if (INPUT_COMPAT_TEST) {
620 struct uinput_ff_upload_compat ff_up_compat;
622 if (copy_from_user(&ff_up_compat, buffer,
623 sizeof(struct uinput_ff_upload_compat)))
626 ff_up->request_id = ff_up_compat.request_id;
627 ff_up->retval = ff_up_compat.retval;
628 memcpy(&ff_up->effect, &ff_up_compat.effect,
629 sizeof(struct ff_effect_compat));
630 memcpy(&ff_up->old, &ff_up_compat.old,
631 sizeof(struct ff_effect_compat));
634 if (copy_from_user(ff_up, buffer,
635 sizeof(struct uinput_ff_upload)))
644 static int uinput_ff_upload_to_user(char __user *buffer,
645 const struct uinput_ff_upload *ff_up)
647 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
653 static int uinput_ff_upload_from_user(const char __user *buffer,
654 struct uinput_ff_upload *ff_up)
656 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
664 #define uinput_set_bit(_arg, _bit, _max) \
667 if (udev->state == UIST_CREATED) \
669 else if ((_arg) > (_max)) \
671 else set_bit((_arg), udev->dev->_bit); \
675 static int uinput_str_to_user(void __user *dest, const char *str,
678 char __user *p = dest;
687 len = strlen(str) + 1;
691 ret = copy_to_user(p, str, len);
695 /* force terminating '\0' */
696 ret = put_user(0, p + len - 1);
697 return ret ? -EFAULT : len;
700 static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
701 unsigned long arg, void __user *p)
704 struct uinput_device *udev = file->private_data;
705 struct uinput_ff_upload ff_up;
706 struct uinput_ff_erase ff_erase;
707 struct uinput_request *req;
712 retval = mutex_lock_interruptible(&udev->mutex);
717 retval = uinput_allocate_device(udev);
724 retval = uinput_create_device(udev);
728 uinput_destroy_device(udev);
732 retval = uinput_set_bit(arg, evbit, EV_MAX);
736 retval = uinput_set_bit(arg, keybit, KEY_MAX);
740 retval = uinput_set_bit(arg, relbit, REL_MAX);
744 retval = uinput_set_bit(arg, absbit, ABS_MAX);
748 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
752 retval = uinput_set_bit(arg, ledbit, LED_MAX);
756 retval = uinput_set_bit(arg, sndbit, SND_MAX);
760 retval = uinput_set_bit(arg, ffbit, FF_MAX);
764 retval = uinput_set_bit(arg, swbit, SW_MAX);
768 retval = uinput_set_bit(arg, propbit, INPUT_PROP_MAX);
772 if (udev->state == UIST_CREATED) {
777 phys = strndup_user(p, 1024);
779 retval = PTR_ERR(phys);
783 kfree(udev->dev->phys);
784 udev->dev->phys = phys;
787 case UI_BEGIN_FF_UPLOAD:
788 retval = uinput_ff_upload_from_user(p, &ff_up);
792 req = uinput_request_find(udev, ff_up.request_id);
793 if (!req || req->code != UI_FF_UPLOAD ||
794 !req->u.upload.effect) {
800 ff_up.effect = *req->u.upload.effect;
801 if (req->u.upload.old)
802 ff_up.old = *req->u.upload.old;
804 memset(&ff_up.old, 0, sizeof(struct ff_effect));
806 retval = uinput_ff_upload_to_user(p, &ff_up);
809 case UI_BEGIN_FF_ERASE:
810 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
815 req = uinput_request_find(udev, ff_erase.request_id);
816 if (!req || req->code != UI_FF_ERASE) {
822 ff_erase.effect_id = req->u.effect_id;
823 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
830 case UI_END_FF_UPLOAD:
831 retval = uinput_ff_upload_from_user(p, &ff_up);
835 req = uinput_request_find(udev, ff_up.request_id);
836 if (!req || req->code != UI_FF_UPLOAD ||
837 !req->u.upload.effect) {
842 req->retval = ff_up.retval;
843 uinput_request_done(udev, req);
846 case UI_END_FF_ERASE:
847 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
852 req = uinput_request_find(udev, ff_erase.request_id);
853 if (!req || req->code != UI_FF_ERASE) {
858 req->retval = ff_erase.retval;
859 uinput_request_done(udev, req);
863 size = _IOC_SIZE(cmd);
865 /* Now check variable-length commands */
866 switch (cmd & ~IOCSIZE_MASK) {
867 case UI_GET_SYSNAME(0):
868 if (udev->state != UIST_CREATED) {
872 name = dev_name(&udev->dev->dev);
873 retval = uinput_str_to_user(p, name, size);
879 mutex_unlock(&udev->mutex);
883 static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
885 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
889 static long uinput_compat_ioctl(struct file *file,
890 unsigned int cmd, unsigned long arg)
892 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
896 static const struct file_operations uinput_fops = {
897 .owner = THIS_MODULE,
899 .release = uinput_release,
901 .write = uinput_write,
903 .unlocked_ioctl = uinput_ioctl,
905 .compat_ioctl = uinput_compat_ioctl,
910 static struct miscdevice uinput_misc = {
911 .fops = &uinput_fops,
912 .minor = UINPUT_MINOR,
915 MODULE_ALIAS_MISCDEV(UINPUT_MINOR);
916 MODULE_ALIAS("devname:" UINPUT_NAME);
918 static int __init uinput_init(void)
920 return misc_register(&uinput_misc);
923 static void __exit uinput_exit(void)
925 misc_deregister(&uinput_misc);
928 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
929 MODULE_DESCRIPTION("User level driver support for input subsystem");
930 MODULE_LICENSE("GPL");
931 MODULE_VERSION("0.3");
933 module_init(uinput_init);
934 module_exit(uinput_exit);