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
20 * Author: Aristeu Sergio Rozanski Filho <aris@cathedrallabs.org>
23 * 0.3 09/04/2006 (Anssi Hannula <anssi.hannula@gmail.com>)
24 * - updated ff support for the changes in kernel interface
25 * - added MODULE_VERSION
26 * 0.2 16/10/2004 (Micah Dowty <micah@navi.cx>)
27 * - added force feedback support
30 * - first public version
32 #include <linux/poll.h>
33 #include <linux/sched.h>
34 #include <linux/slab.h>
35 #include <linux/module.h>
36 #include <linux/init.h>
38 #include <linux/miscdevice.h>
39 #include <linux/uinput.h>
40 #include <linux/input/mt.h>
41 #include "../input-compat.h"
43 static int uinput_dev_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
45 struct uinput_device *udev = input_get_drvdata(dev);
47 udev->buff[udev->head].type = type;
48 udev->buff[udev->head].code = code;
49 udev->buff[udev->head].value = value;
50 do_gettimeofday(&udev->buff[udev->head].time);
51 udev->head = (udev->head + 1) % UINPUT_BUFFER_SIZE;
53 wake_up_interruptible(&udev->waitq);
58 /* Atomically allocate an ID for the given request. Returns 0 on success. */
59 static bool uinput_request_alloc_id(struct uinput_device *udev,
60 struct uinput_request *request)
63 bool reserved = false;
65 spin_lock(&udev->requests_lock);
67 for (id = 0; id < UINPUT_NUM_REQUESTS; id++) {
68 if (!udev->requests[id]) {
70 udev->requests[id] = request;
76 spin_unlock(&udev->requests_lock);
80 static struct uinput_request *uinput_request_find(struct uinput_device *udev,
83 /* Find an input request, by ID. Returns NULL if the ID isn't valid. */
84 if (id >= UINPUT_NUM_REQUESTS)
87 return udev->requests[id];
90 static int uinput_request_reserve_slot(struct uinput_device *udev,
91 struct uinput_request *request)
93 /* Allocate slot. If none are available right away, wait. */
94 return wait_event_interruptible(udev->requests_waitq,
95 uinput_request_alloc_id(udev, request));
98 static void uinput_request_done(struct uinput_device *udev, struct uinput_request *request)
100 /* Mark slot as available */
101 udev->requests[request->id] = NULL;
102 wake_up(&udev->requests_waitq);
104 complete(&request->done);
107 static int uinput_request_send(struct uinput_device *udev,
108 struct uinput_request *request)
112 retval = mutex_lock_interruptible(&udev->mutex);
116 if (udev->state != UIST_CREATED) {
121 init_completion(&request->done);
124 * Tell our userspace application about this new request
125 * by queueing an input event.
127 uinput_dev_event(udev->dev, EV_UINPUT, request->code, request->id);
130 mutex_unlock(&udev->mutex);
134 static int uinput_request_submit(struct uinput_device *udev,
135 struct uinput_request *request)
139 error = uinput_request_reserve_slot(udev, request);
143 error = uinput_request_send(udev, request);
145 uinput_request_done(udev, request);
149 wait_for_completion(&request->done);
150 return request->retval;
154 * Fail all ouitstanding requests so handlers don't wait for the userspace
155 * to finish processing them.
157 static void uinput_flush_requests(struct uinput_device *udev)
159 struct uinput_request *request;
162 spin_lock(&udev->requests_lock);
164 for (i = 0; i < UINPUT_NUM_REQUESTS; i++) {
165 request = udev->requests[i];
167 request->retval = -ENODEV;
168 uinput_request_done(udev, request);
172 spin_unlock(&udev->requests_lock);
175 static void uinput_dev_set_gain(struct input_dev *dev, u16 gain)
177 uinput_dev_event(dev, EV_FF, FF_GAIN, gain);
180 static void uinput_dev_set_autocenter(struct input_dev *dev, u16 magnitude)
182 uinput_dev_event(dev, EV_FF, FF_AUTOCENTER, magnitude);
185 static int uinput_dev_playback(struct input_dev *dev, int effect_id, int value)
187 return uinput_dev_event(dev, EV_FF, effect_id, value);
190 static int uinput_dev_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
192 struct uinput_device *udev = input_get_drvdata(dev);
193 struct uinput_request request;
196 * uinput driver does not currently support periodic effects with
197 * custom waveform since it does not have a way to pass buffer of
198 * samples (custom_data) to userspace. If ever there is a device
199 * supporting custom waveforms we would need to define an additional
200 * ioctl (UI_UPLOAD_SAMPLES) but for now we just bail out.
202 if (effect->type == FF_PERIODIC &&
203 effect->u.periodic.waveform == FF_CUSTOM)
206 request.code = UI_FF_UPLOAD;
207 request.u.upload.effect = effect;
208 request.u.upload.old = old;
210 return uinput_request_submit(udev, &request);
213 static int uinput_dev_erase_effect(struct input_dev *dev, int effect_id)
215 struct uinput_device *udev = input_get_drvdata(dev);
216 struct uinput_request request;
218 if (!test_bit(EV_FF, dev->evbit))
221 request.code = UI_FF_ERASE;
222 request.u.effect_id = effect_id;
224 return uinput_request_submit(udev, &request);
227 static void uinput_destroy_device(struct uinput_device *udev)
229 const char *name, *phys;
230 struct input_dev *dev = udev->dev;
231 enum uinput_state old_state = udev->state;
233 udev->state = UIST_NEW_DEVICE;
238 if (old_state == UIST_CREATED) {
239 uinput_flush_requests(udev);
240 input_unregister_device(dev);
242 input_free_device(dev);
250 static int uinput_create_device(struct uinput_device *udev)
252 struct input_dev *dev = udev->dev;
255 if (udev->state != UIST_SETUP_COMPLETE) {
256 printk(KERN_DEBUG "%s: write device info first\n", UINPUT_NAME);
260 if (udev->ff_effects_max) {
261 error = input_ff_create(dev, udev->ff_effects_max);
265 dev->ff->upload = uinput_dev_upload_effect;
266 dev->ff->erase = uinput_dev_erase_effect;
267 dev->ff->playback = uinput_dev_playback;
268 dev->ff->set_gain = uinput_dev_set_gain;
269 dev->ff->set_autocenter = uinput_dev_set_autocenter;
272 error = input_register_device(udev->dev);
276 udev->state = UIST_CREATED;
280 fail2: input_ff_destroy(dev);
281 fail1: uinput_destroy_device(udev);
285 static int uinput_open(struct inode *inode, struct file *file)
287 struct uinput_device *newdev;
289 newdev = kzalloc(sizeof(struct uinput_device), GFP_KERNEL);
293 mutex_init(&newdev->mutex);
294 spin_lock_init(&newdev->requests_lock);
295 init_waitqueue_head(&newdev->requests_waitq);
296 init_waitqueue_head(&newdev->waitq);
297 newdev->state = UIST_NEW_DEVICE;
299 file->private_data = newdev;
300 nonseekable_open(inode, file);
305 static int uinput_validate_absbits(struct input_dev *dev)
310 for (cnt = 0; cnt < ABS_CNT; cnt++) {
312 if (!test_bit(cnt, dev->absbit))
315 min = input_abs_get_min(dev, cnt);
316 max = input_abs_get_max(dev, cnt);
318 if ((min != 0 || max != 0) && max <= min) {
320 "%s: invalid abs[%02x] min:%d max:%d\n",
322 input_abs_get_min(dev, cnt),
323 input_abs_get_max(dev, cnt));
328 if (input_abs_get_flat(dev, cnt) >
329 input_abs_get_max(dev, cnt) - input_abs_get_min(dev, cnt)) {
331 "%s: abs_flat #%02x out of range: %d "
334 input_abs_get_flat(dev, cnt),
335 input_abs_get_min(dev, cnt),
336 input_abs_get_max(dev, cnt));
344 static int uinput_allocate_device(struct uinput_device *udev)
346 udev->dev = input_allocate_device();
350 udev->dev->event = uinput_dev_event;
351 input_set_drvdata(udev->dev, udev);
356 static int uinput_setup_device(struct uinput_device *udev, const char __user *buffer, size_t count)
358 struct uinput_user_dev *user_dev;
359 struct input_dev *dev;
363 if (count != sizeof(struct uinput_user_dev))
367 retval = uinput_allocate_device(udev);
374 user_dev = memdup_user(buffer, sizeof(struct uinput_user_dev));
375 if (IS_ERR(user_dev))
376 return PTR_ERR(user_dev);
378 udev->ff_effects_max = user_dev->ff_effects_max;
380 /* Ensure name is filled in */
381 if (!user_dev->name[0]) {
387 dev->name = kstrndup(user_dev->name, UINPUT_MAX_NAME_SIZE,
394 dev->id.bustype = user_dev->id.bustype;
395 dev->id.vendor = user_dev->id.vendor;
396 dev->id.product = user_dev->id.product;
397 dev->id.version = user_dev->id.version;
399 for (i = 0; i < ABS_CNT; i++) {
400 input_abs_set_max(dev, i, user_dev->absmax[i]);
401 input_abs_set_min(dev, i, user_dev->absmin[i]);
402 input_abs_set_fuzz(dev, i, user_dev->absfuzz[i]);
403 input_abs_set_flat(dev, i, user_dev->absflat[i]);
406 /* check if absmin/absmax/absfuzz/absflat are filled as
407 * told in Documentation/input/input-programming.txt */
408 if (test_bit(EV_ABS, dev->evbit)) {
409 retval = uinput_validate_absbits(dev);
412 if (test_bit(ABS_MT_SLOT, dev->absbit)) {
413 int nslot = input_abs_get_max(dev, ABS_MT_SLOT) + 1;
414 input_mt_init_slots(dev, nslot);
415 } else if (test_bit(ABS_MT_POSITION_X, dev->absbit)) {
416 input_set_events_per_packet(dev, 60);
420 udev->state = UIST_SETUP_COMPLETE;
428 static inline ssize_t uinput_inject_event(struct uinput_device *udev, const char __user *buffer, size_t count)
430 struct input_event ev;
432 if (count < input_event_size())
435 if (input_event_from_user(buffer, &ev))
438 input_event(udev->dev, ev.type, ev.code, ev.value);
440 return input_event_size();
443 static ssize_t uinput_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
445 struct uinput_device *udev = file->private_data;
451 retval = mutex_lock_interruptible(&udev->mutex);
455 retval = udev->state == UIST_CREATED ?
456 uinput_inject_event(udev, buffer, count) :
457 uinput_setup_device(udev, buffer, count);
459 mutex_unlock(&udev->mutex);
464 static bool uinput_fetch_next_event(struct uinput_device *udev,
465 struct input_event *event)
469 spin_lock_irq(&udev->dev->event_lock);
471 have_event = udev->head != udev->tail;
473 *event = udev->buff[udev->tail];
474 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
477 spin_unlock_irq(&udev->dev->event_lock);
482 static ssize_t uinput_events_to_user(struct uinput_device *udev,
483 char __user *buffer, size_t count)
485 struct input_event event;
488 while (read + input_event_size() <= count &&
489 uinput_fetch_next_event(udev, &event)) {
491 if (input_event_to_user(buffer + read, &event))
494 read += input_event_size();
500 static ssize_t uinput_read(struct file *file, char __user *buffer,
501 size_t count, loff_t *ppos)
503 struct uinput_device *udev = file->private_data;
506 if (count != 0 && count < input_event_size())
510 retval = mutex_lock_interruptible(&udev->mutex);
514 if (udev->state != UIST_CREATED)
516 else if (udev->head == udev->tail &&
517 (file->f_flags & O_NONBLOCK))
520 retval = uinput_events_to_user(udev, buffer, count);
522 mutex_unlock(&udev->mutex);
524 if (retval || count == 0)
527 if (!(file->f_flags & O_NONBLOCK))
528 retval = wait_event_interruptible(udev->waitq,
529 udev->head != udev->tail ||
530 udev->state != UIST_CREATED);
531 } while (retval == 0);
536 static unsigned int uinput_poll(struct file *file, poll_table *wait)
538 struct uinput_device *udev = file->private_data;
540 poll_wait(file, &udev->waitq, wait);
542 if (udev->head != udev->tail)
543 return POLLIN | POLLRDNORM;
548 static int uinput_release(struct inode *inode, struct file *file)
550 struct uinput_device *udev = file->private_data;
552 uinput_destroy_device(udev);
559 struct uinput_ff_upload_compat {
562 struct ff_effect_compat effect;
563 struct ff_effect_compat old;
566 static int uinput_ff_upload_to_user(char __user *buffer,
567 const struct uinput_ff_upload *ff_up)
569 if (INPUT_COMPAT_TEST) {
570 struct uinput_ff_upload_compat ff_up_compat;
572 ff_up_compat.request_id = ff_up->request_id;
573 ff_up_compat.retval = ff_up->retval;
575 * It so happens that the pointer that gives us the trouble
576 * is the last field in the structure. Since we don't support
577 * custom waveforms in uinput anyway we can just copy the whole
578 * thing (to the compat size) and ignore the pointer.
580 memcpy(&ff_up_compat.effect, &ff_up->effect,
581 sizeof(struct ff_effect_compat));
582 memcpy(&ff_up_compat.old, &ff_up->old,
583 sizeof(struct ff_effect_compat));
585 if (copy_to_user(buffer, &ff_up_compat,
586 sizeof(struct uinput_ff_upload_compat)))
589 if (copy_to_user(buffer, ff_up,
590 sizeof(struct uinput_ff_upload)))
597 static int uinput_ff_upload_from_user(const char __user *buffer,
598 struct uinput_ff_upload *ff_up)
600 if (INPUT_COMPAT_TEST) {
601 struct uinput_ff_upload_compat ff_up_compat;
603 if (copy_from_user(&ff_up_compat, buffer,
604 sizeof(struct uinput_ff_upload_compat)))
607 ff_up->request_id = ff_up_compat.request_id;
608 ff_up->retval = ff_up_compat.retval;
609 memcpy(&ff_up->effect, &ff_up_compat.effect,
610 sizeof(struct ff_effect_compat));
611 memcpy(&ff_up->old, &ff_up_compat.old,
612 sizeof(struct ff_effect_compat));
615 if (copy_from_user(ff_up, buffer,
616 sizeof(struct uinput_ff_upload)))
625 static int uinput_ff_upload_to_user(char __user *buffer,
626 const struct uinput_ff_upload *ff_up)
628 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
634 static int uinput_ff_upload_from_user(const char __user *buffer,
635 struct uinput_ff_upload *ff_up)
637 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
645 #define uinput_set_bit(_arg, _bit, _max) \
648 if (udev->state == UIST_CREATED) \
650 else if ((_arg) > (_max)) \
652 else set_bit((_arg), udev->dev->_bit); \
656 static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
657 unsigned long arg, void __user *p)
660 struct uinput_device *udev = file->private_data;
661 struct uinput_ff_upload ff_up;
662 struct uinput_ff_erase ff_erase;
663 struct uinput_request *req;
666 retval = mutex_lock_interruptible(&udev->mutex);
671 retval = uinput_allocate_device(udev);
678 retval = uinput_create_device(udev);
682 uinput_destroy_device(udev);
686 retval = uinput_set_bit(arg, evbit, EV_MAX);
690 retval = uinput_set_bit(arg, keybit, KEY_MAX);
694 retval = uinput_set_bit(arg, relbit, REL_MAX);
698 retval = uinput_set_bit(arg, absbit, ABS_MAX);
702 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
706 retval = uinput_set_bit(arg, ledbit, LED_MAX);
710 retval = uinput_set_bit(arg, sndbit, SND_MAX);
714 retval = uinput_set_bit(arg, ffbit, FF_MAX);
718 retval = uinput_set_bit(arg, swbit, SW_MAX);
722 retval = uinput_set_bit(arg, propbit, INPUT_PROP_MAX);
726 if (udev->state == UIST_CREATED) {
731 phys = strndup_user(p, 1024);
733 retval = PTR_ERR(phys);
737 kfree(udev->dev->phys);
738 udev->dev->phys = phys;
741 case UI_BEGIN_FF_UPLOAD:
742 retval = uinput_ff_upload_from_user(p, &ff_up);
746 req = uinput_request_find(udev, ff_up.request_id);
747 if (!req || req->code != UI_FF_UPLOAD || !req->u.upload.effect) {
753 ff_up.effect = *req->u.upload.effect;
754 if (req->u.upload.old)
755 ff_up.old = *req->u.upload.old;
757 memset(&ff_up.old, 0, sizeof(struct ff_effect));
759 retval = uinput_ff_upload_to_user(p, &ff_up);
762 case UI_BEGIN_FF_ERASE:
763 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
768 req = uinput_request_find(udev, ff_erase.request_id);
769 if (!req || req->code != UI_FF_ERASE) {
775 ff_erase.effect_id = req->u.effect_id;
776 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
783 case UI_END_FF_UPLOAD:
784 retval = uinput_ff_upload_from_user(p, &ff_up);
788 req = uinput_request_find(udev, ff_up.request_id);
789 if (!req || req->code != UI_FF_UPLOAD ||
790 !req->u.upload.effect) {
795 req->retval = ff_up.retval;
796 uinput_request_done(udev, req);
799 case UI_END_FF_ERASE:
800 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
805 req = uinput_request_find(udev, ff_erase.request_id);
806 if (!req || req->code != UI_FF_ERASE) {
811 req->retval = ff_erase.retval;
812 uinput_request_done(udev, req);
820 mutex_unlock(&udev->mutex);
824 static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
826 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
830 static long uinput_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
832 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
836 static const struct file_operations uinput_fops = {
837 .owner = THIS_MODULE,
839 .release = uinput_release,
841 .write = uinput_write,
843 .unlocked_ioctl = uinput_ioctl,
845 .compat_ioctl = uinput_compat_ioctl,
850 static struct miscdevice uinput_misc = {
851 .fops = &uinput_fops,
852 .minor = UINPUT_MINOR,
855 MODULE_ALIAS_MISCDEV(UINPUT_MINOR);
856 MODULE_ALIAS("devname:" UINPUT_NAME);
858 static int __init uinput_init(void)
860 return misc_register(&uinput_misc);
863 static void __exit uinput_exit(void)
865 misc_deregister(&uinput_misc);
868 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
869 MODULE_DESCRIPTION("User level driver support for input subsystem");
870 MODULE_LICENSE("GPL");
871 MODULE_VERSION("0.3");
873 module_init(uinput_init);
874 module_exit(uinput_exit);