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 "../input-compat.h"
42 static int uinput_dev_event(struct input_dev *dev, unsigned int type, unsigned int code, int value)
44 struct uinput_device *udev = input_get_drvdata(dev);
46 udev->buff[udev->head].type = type;
47 udev->buff[udev->head].code = code;
48 udev->buff[udev->head].value = value;
49 do_gettimeofday(&udev->buff[udev->head].time);
50 udev->head = (udev->head + 1) % UINPUT_BUFFER_SIZE;
52 wake_up_interruptible(&udev->waitq);
57 /* Atomically allocate an ID for the given request. Returns 0 on success. */
58 static int uinput_request_alloc_id(struct uinput_device *udev, struct uinput_request *request)
63 spin_lock(&udev->requests_lock);
65 for (id = 0; id < UINPUT_NUM_REQUESTS; id++) {
66 if (!udev->requests[id]) {
68 udev->requests[id] = request;
74 spin_unlock(&udev->requests_lock);
78 static struct uinput_request *uinput_request_find(struct uinput_device *udev, int id)
80 /* Find an input request, by ID. Returns NULL if the ID isn't valid. */
81 if (id >= UINPUT_NUM_REQUESTS || id < 0)
84 return udev->requests[id];
87 static inline int uinput_request_reserve_slot(struct uinput_device *udev, struct uinput_request *request)
89 /* Allocate slot. If none are available right away, wait. */
90 return wait_event_interruptible(udev->requests_waitq,
91 !uinput_request_alloc_id(udev, request));
94 static void uinput_request_done(struct uinput_device *udev, struct uinput_request *request)
96 /* Mark slot as available */
97 udev->requests[request->id] = NULL;
98 wake_up(&udev->requests_waitq);
100 complete(&request->done);
103 static int uinput_request_submit(struct uinput_device *udev, struct uinput_request *request)
107 retval = uinput_request_reserve_slot(udev, request);
111 retval = mutex_lock_interruptible(&udev->mutex);
115 if (udev->state != UIST_CREATED) {
120 /* Tell our userspace app about this new request by queueing an input event */
121 uinput_dev_event(udev->dev, EV_UINPUT, request->code, request->id);
124 mutex_unlock(&udev->mutex);
129 * Fail all ouitstanding requests so handlers don't wait for the userspace
130 * to finish processing them.
132 static void uinput_flush_requests(struct uinput_device *udev)
134 struct uinput_request *request;
137 spin_lock(&udev->requests_lock);
139 for (i = 0; i < UINPUT_NUM_REQUESTS; i++) {
140 request = udev->requests[i];
142 request->retval = -ENODEV;
143 uinput_request_done(udev, request);
147 spin_unlock(&udev->requests_lock);
150 static void uinput_dev_set_gain(struct input_dev *dev, u16 gain)
152 uinput_dev_event(dev, EV_FF, FF_GAIN, gain);
155 static void uinput_dev_set_autocenter(struct input_dev *dev, u16 magnitude)
157 uinput_dev_event(dev, EV_FF, FF_AUTOCENTER, magnitude);
160 static int uinput_dev_playback(struct input_dev *dev, int effect_id, int value)
162 return uinput_dev_event(dev, EV_FF, effect_id, value);
165 static int uinput_dev_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
167 struct uinput_device *udev = input_get_drvdata(dev);
168 struct uinput_request request;
172 * uinput driver does not currently support periodic effects with
173 * custom waveform since it does not have a way to pass buffer of
174 * samples (custom_data) to userspace. If ever there is a device
175 * supporting custom waveforms we would need to define an additional
176 * ioctl (UI_UPLOAD_SAMPLES) but for now we just bail out.
178 if (effect->type == FF_PERIODIC &&
179 effect->u.periodic.waveform == FF_CUSTOM)
183 init_completion(&request.done);
184 request.code = UI_FF_UPLOAD;
185 request.u.upload.effect = effect;
186 request.u.upload.old = old;
188 retval = uinput_request_submit(udev, &request);
190 wait_for_completion(&request.done);
191 retval = request.retval;
197 static int uinput_dev_erase_effect(struct input_dev *dev, int effect_id)
199 struct uinput_device *udev = input_get_drvdata(dev);
200 struct uinput_request request;
203 if (!test_bit(EV_FF, dev->evbit))
207 init_completion(&request.done);
208 request.code = UI_FF_ERASE;
209 request.u.effect_id = effect_id;
211 retval = uinput_request_submit(udev, &request);
213 wait_for_completion(&request.done);
214 retval = request.retval;
220 static void uinput_destroy_device(struct uinput_device *udev)
222 const char *name, *phys;
223 struct input_dev *dev = udev->dev;
224 enum uinput_state old_state = udev->state;
226 udev->state = UIST_NEW_DEVICE;
231 if (old_state == UIST_CREATED) {
232 uinput_flush_requests(udev);
233 input_unregister_device(dev);
235 input_free_device(dev);
243 static int uinput_create_device(struct uinput_device *udev)
245 struct input_dev *dev = udev->dev;
248 if (udev->state != UIST_SETUP_COMPLETE) {
249 printk(KERN_DEBUG "%s: write device info first\n", UINPUT_NAME);
253 if (udev->ff_effects_max) {
254 error = input_ff_create(dev, udev->ff_effects_max);
258 dev->ff->upload = uinput_dev_upload_effect;
259 dev->ff->erase = uinput_dev_erase_effect;
260 dev->ff->playback = uinput_dev_playback;
261 dev->ff->set_gain = uinput_dev_set_gain;
262 dev->ff->set_autocenter = uinput_dev_set_autocenter;
265 error = input_register_device(udev->dev);
269 udev->state = UIST_CREATED;
273 fail2: input_ff_destroy(dev);
274 fail1: uinput_destroy_device(udev);
278 static int uinput_open(struct inode *inode, struct file *file)
280 struct uinput_device *newdev;
282 newdev = kzalloc(sizeof(struct uinput_device), GFP_KERNEL);
286 mutex_init(&newdev->mutex);
287 spin_lock_init(&newdev->requests_lock);
288 init_waitqueue_head(&newdev->requests_waitq);
289 init_waitqueue_head(&newdev->waitq);
290 newdev->state = UIST_NEW_DEVICE;
292 file->private_data = newdev;
297 static int uinput_validate_absbits(struct input_dev *dev)
302 for (cnt = 0; cnt < ABS_MAX + 1; cnt++) {
303 if (!test_bit(cnt, dev->absbit))
306 if ((dev->absmax[cnt] <= dev->absmin[cnt])) {
308 "%s: invalid abs[%02x] min:%d max:%d\n",
310 dev->absmin[cnt], dev->absmax[cnt]);
315 if (dev->absflat[cnt] > (dev->absmax[cnt] - dev->absmin[cnt])) {
317 "%s: absflat[%02x] out of range: %d "
319 UINPUT_NAME, cnt, dev->absflat[cnt],
320 dev->absmin[cnt], dev->absmax[cnt]);
328 static int uinput_allocate_device(struct uinput_device *udev)
330 udev->dev = input_allocate_device();
334 udev->dev->event = uinput_dev_event;
335 input_set_drvdata(udev->dev, udev);
340 static int uinput_setup_device(struct uinput_device *udev, const char __user *buffer, size_t count)
342 struct uinput_user_dev *user_dev;
343 struct input_dev *dev;
348 if (count != sizeof(struct uinput_user_dev))
352 retval = uinput_allocate_device(udev);
359 user_dev = kmalloc(sizeof(struct uinput_user_dev), GFP_KERNEL);
363 if (copy_from_user(user_dev, buffer, sizeof(struct uinput_user_dev))) {
368 udev->ff_effects_max = user_dev->ff_effects_max;
370 size = strnlen(user_dev->name, UINPUT_MAX_NAME_SIZE) + 1;
377 dev->name = name = kmalloc(size, GFP_KERNEL);
382 strlcpy(name, user_dev->name, size);
384 dev->id.bustype = user_dev->id.bustype;
385 dev->id.vendor = user_dev->id.vendor;
386 dev->id.product = user_dev->id.product;
387 dev->id.version = user_dev->id.version;
389 size = sizeof(int) * (ABS_MAX + 1);
390 memcpy(dev->absmax, user_dev->absmax, size);
391 memcpy(dev->absmin, user_dev->absmin, size);
392 memcpy(dev->absfuzz, user_dev->absfuzz, size);
393 memcpy(dev->absflat, user_dev->absflat, size);
395 /* check if absmin/absmax/absfuzz/absflat are filled as
396 * told in Documentation/input/input-programming.txt */
397 if (test_bit(EV_ABS, dev->evbit)) {
398 retval = uinput_validate_absbits(dev);
403 udev->state = UIST_SETUP_COMPLETE;
411 static inline ssize_t uinput_inject_event(struct uinput_device *udev, const char __user *buffer, size_t count)
413 struct input_event ev;
415 if (count < input_event_size())
418 if (input_event_from_user(buffer, &ev))
421 input_event(udev->dev, ev.type, ev.code, ev.value);
423 return input_event_size();
426 static ssize_t uinput_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
428 struct uinput_device *udev = file->private_data;
431 retval = mutex_lock_interruptible(&udev->mutex);
435 retval = udev->state == UIST_CREATED ?
436 uinput_inject_event(udev, buffer, count) :
437 uinput_setup_device(udev, buffer, count);
439 mutex_unlock(&udev->mutex);
444 static ssize_t uinput_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
446 struct uinput_device *udev = file->private_data;
449 if (udev->state != UIST_CREATED)
452 if (udev->head == udev->tail && (file->f_flags & O_NONBLOCK))
455 retval = wait_event_interruptible(udev->waitq,
456 udev->head != udev->tail || udev->state != UIST_CREATED);
460 retval = mutex_lock_interruptible(&udev->mutex);
464 if (udev->state != UIST_CREATED) {
469 while (udev->head != udev->tail && retval + input_event_size() <= count) {
470 if (input_event_to_user(buffer + retval, &udev->buff[udev->tail])) {
474 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
475 retval += input_event_size();
479 mutex_unlock(&udev->mutex);
484 static unsigned int uinput_poll(struct file *file, poll_table *wait)
486 struct uinput_device *udev = file->private_data;
488 poll_wait(file, &udev->waitq, wait);
490 if (udev->head != udev->tail)
491 return POLLIN | POLLRDNORM;
496 static int uinput_release(struct inode *inode, struct file *file)
498 struct uinput_device *udev = file->private_data;
500 uinput_destroy_device(udev);
507 struct uinput_ff_upload_compat {
510 struct ff_effect_compat effect;
511 struct ff_effect_compat old;
514 static int uinput_ff_upload_to_user(char __user *buffer,
515 const struct uinput_ff_upload *ff_up)
517 if (INPUT_COMPAT_TEST) {
518 struct uinput_ff_upload_compat ff_up_compat;
520 ff_up_compat.request_id = ff_up->request_id;
521 ff_up_compat.retval = ff_up->retval;
523 * It so happens that the pointer that gives us the trouble
524 * is the last field in the structure. Since we don't support
525 * custom waveforms in uinput anyway we can just copy the whole
526 * thing (to the compat size) and ignore the pointer.
528 memcpy(&ff_up_compat.effect, &ff_up->effect,
529 sizeof(struct ff_effect_compat));
530 memcpy(&ff_up_compat.old, &ff_up->old,
531 sizeof(struct ff_effect_compat));
533 if (copy_to_user(buffer, &ff_up_compat,
534 sizeof(struct uinput_ff_upload_compat)))
537 if (copy_to_user(buffer, ff_up,
538 sizeof(struct uinput_ff_upload)))
545 static int uinput_ff_upload_from_user(const char __user *buffer,
546 struct uinput_ff_upload *ff_up)
548 if (INPUT_COMPAT_TEST) {
549 struct uinput_ff_upload_compat ff_up_compat;
551 if (copy_from_user(&ff_up_compat, buffer,
552 sizeof(struct uinput_ff_upload_compat)))
555 ff_up->request_id = ff_up_compat.request_id;
556 ff_up->retval = ff_up_compat.retval;
557 memcpy(&ff_up->effect, &ff_up_compat.effect,
558 sizeof(struct ff_effect_compat));
559 memcpy(&ff_up->old, &ff_up_compat.old,
560 sizeof(struct ff_effect_compat));
563 if (copy_from_user(ff_up, buffer,
564 sizeof(struct uinput_ff_upload)))
573 static int uinput_ff_upload_to_user(char __user *buffer,
574 const struct uinput_ff_upload *ff_up)
576 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
582 static int uinput_ff_upload_from_user(const char __user *buffer,
583 struct uinput_ff_upload *ff_up)
585 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
593 #define uinput_set_bit(_arg, _bit, _max) \
596 if (udev->state == UIST_CREATED) \
598 else if ((_arg) > (_max)) \
600 else set_bit((_arg), udev->dev->_bit); \
604 static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
605 unsigned long arg, void __user *p)
608 struct uinput_device *udev = file->private_data;
609 struct uinput_ff_upload ff_up;
610 struct uinput_ff_erase ff_erase;
611 struct uinput_request *req;
615 retval = mutex_lock_interruptible(&udev->mutex);
620 retval = uinput_allocate_device(udev);
627 retval = uinput_create_device(udev);
631 uinput_destroy_device(udev);
635 retval = uinput_set_bit(arg, evbit, EV_MAX);
639 retval = uinput_set_bit(arg, keybit, KEY_MAX);
643 retval = uinput_set_bit(arg, relbit, REL_MAX);
647 retval = uinput_set_bit(arg, absbit, ABS_MAX);
651 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
655 retval = uinput_set_bit(arg, ledbit, LED_MAX);
659 retval = uinput_set_bit(arg, sndbit, SND_MAX);
663 retval = uinput_set_bit(arg, ffbit, FF_MAX);
667 retval = uinput_set_bit(arg, swbit, SW_MAX);
671 if (udev->state == UIST_CREATED) {
675 length = strnlen_user(p, 1024);
680 kfree(udev->dev->phys);
681 udev->dev->phys = phys = kmalloc(length, GFP_KERNEL);
686 if (copy_from_user(phys, p, length)) {
687 udev->dev->phys = NULL;
692 phys[length - 1] = '\0';
695 case UI_BEGIN_FF_UPLOAD:
696 retval = uinput_ff_upload_from_user(p, &ff_up);
700 req = uinput_request_find(udev, ff_up.request_id);
701 if (!req || req->code != UI_FF_UPLOAD || !req->u.upload.effect) {
707 ff_up.effect = *req->u.upload.effect;
708 if (req->u.upload.old)
709 ff_up.old = *req->u.upload.old;
711 memset(&ff_up.old, 0, sizeof(struct ff_effect));
713 retval = uinput_ff_upload_to_user(p, &ff_up);
716 case UI_BEGIN_FF_ERASE:
717 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
722 req = uinput_request_find(udev, ff_erase.request_id);
723 if (!req || req->code != UI_FF_ERASE) {
729 ff_erase.effect_id = req->u.effect_id;
730 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
737 case UI_END_FF_UPLOAD:
738 retval = uinput_ff_upload_from_user(p, &ff_up);
742 req = uinput_request_find(udev, ff_up.request_id);
743 if (!req || req->code != UI_FF_UPLOAD ||
744 !req->u.upload.effect) {
749 req->retval = ff_up.retval;
750 uinput_request_done(udev, req);
753 case UI_END_FF_ERASE:
754 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
759 req = uinput_request_find(udev, ff_erase.request_id);
760 if (!req || req->code != UI_FF_ERASE) {
765 req->retval = ff_erase.retval;
766 uinput_request_done(udev, req);
774 mutex_unlock(&udev->mutex);
778 static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
780 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
784 static long uinput_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
786 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
790 static const struct file_operations uinput_fops = {
791 .owner = THIS_MODULE,
793 .release = uinput_release,
795 .write = uinput_write,
797 .unlocked_ioctl = uinput_ioctl,
799 .compat_ioctl = uinput_compat_ioctl,
803 static struct miscdevice uinput_misc = {
804 .fops = &uinput_fops,
805 .minor = UINPUT_MINOR,
809 static int __init uinput_init(void)
811 return misc_register(&uinput_misc);
814 static void __exit uinput_exit(void)
816 misc_deregister(&uinput_misc);
819 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
820 MODULE_DESCRIPTION("User level driver support for input subsystem");
821 MODULE_LICENSE("GPL");
822 MODULE_VERSION("0.3");
824 module_init(uinput_init);
825 module_exit(uinput_exit);