input: Misc/hp_sdc_rtc: semaphore cleanup
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / input / misc / uinput.c
blob0d4266a533a524564adcc85cc546736248753628
1 /*
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>
22 * Changes/Revisions:
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
28 * - added UI_SET_PHYS
29 * 0.1 20/06/2002
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>
37 #include <linux/fs.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);
54 return 0;
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)
60 int id;
61 int err = -1;
63 spin_lock(&udev->requests_lock);
65 for (id = 0; id < UINPUT_NUM_REQUESTS; id++) {
66 if (!udev->requests[id]) {
67 request->id = id;
68 udev->requests[id] = request;
69 err = 0;
70 break;
74 spin_unlock(&udev->requests_lock);
75 return err;
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)
82 return NULL;
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)
105 int retval;
107 retval = uinput_request_reserve_slot(udev, request);
108 if (retval)
109 return retval;
111 retval = mutex_lock_interruptible(&udev->mutex);
112 if (retval)
113 return retval;
115 if (udev->state != UIST_CREATED) {
116 retval = -ENODEV;
117 goto out;
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);
123 out:
124 mutex_unlock(&udev->mutex);
125 return retval;
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;
135 int i;
137 spin_lock(&udev->requests_lock);
139 for (i = 0; i < UINPUT_NUM_REQUESTS; i++) {
140 request = udev->requests[i];
141 if (request) {
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;
169 int retval;
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)
180 return -EINVAL;
182 request.id = -1;
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);
189 if (!retval) {
190 wait_for_completion(&request.done);
191 retval = request.retval;
194 return 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;
201 int retval;
203 if (!test_bit(EV_FF, dev->evbit))
204 return -ENOSYS;
206 request.id = -1;
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);
212 if (!retval) {
213 wait_for_completion(&request.done);
214 retval = request.retval;
217 return 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;
228 if (dev) {
229 name = dev->name;
230 phys = dev->phys;
231 if (old_state == UIST_CREATED) {
232 uinput_flush_requests(udev);
233 input_unregister_device(dev);
234 } else {
235 input_free_device(dev);
237 kfree(name);
238 kfree(phys);
239 udev->dev = NULL;
243 static int uinput_create_device(struct uinput_device *udev)
245 struct input_dev *dev = udev->dev;
246 int error;
248 if (udev->state != UIST_SETUP_COMPLETE) {
249 printk(KERN_DEBUG "%s: write device info first\n", UINPUT_NAME);
250 return -EINVAL;
253 if (udev->ff_effects_max) {
254 error = input_ff_create(dev, udev->ff_effects_max);
255 if (error)
256 goto fail1;
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);
266 if (error)
267 goto fail2;
269 udev->state = UIST_CREATED;
271 return 0;
273 fail2: input_ff_destroy(dev);
274 fail1: uinput_destroy_device(udev);
275 return error;
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);
283 if (!newdev)
284 return -ENOMEM;
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;
293 nonseekable_open(inode, file);
295 return 0;
298 static int uinput_validate_absbits(struct input_dev *dev)
300 unsigned int cnt;
301 int retval = 0;
303 for (cnt = 0; cnt < ABS_CNT; cnt++) {
304 if (!test_bit(cnt, dev->absbit))
305 continue;
307 if (input_abs_get_max(dev, cnt) <= input_abs_get_min(dev, cnt)) {
308 printk(KERN_DEBUG
309 "%s: invalid abs[%02x] min:%d max:%d\n",
310 UINPUT_NAME, cnt,
311 input_abs_get_min(dev, cnt),
312 input_abs_get_max(dev, cnt));
313 retval = -EINVAL;
314 break;
317 if (input_abs_get_flat(dev, cnt) >
318 input_abs_get_max(dev, cnt) - input_abs_get_min(dev, cnt)) {
319 printk(KERN_DEBUG
320 "%s: abs_flat #%02x out of range: %d "
321 "(min:%d/max:%d)\n",
322 UINPUT_NAME, cnt,
323 input_abs_get_flat(dev, cnt),
324 input_abs_get_min(dev, cnt),
325 input_abs_get_max(dev, cnt));
326 retval = -EINVAL;
327 break;
330 return retval;
333 static int uinput_allocate_device(struct uinput_device *udev)
335 udev->dev = input_allocate_device();
336 if (!udev->dev)
337 return -ENOMEM;
339 udev->dev->event = uinput_dev_event;
340 input_set_drvdata(udev->dev, udev);
342 return 0;
345 static int uinput_setup_device(struct uinput_device *udev, const char __user *buffer, size_t count)
347 struct uinput_user_dev *user_dev;
348 struct input_dev *dev;
349 char *name;
350 int i, size;
351 int retval;
353 if (count != sizeof(struct uinput_user_dev))
354 return -EINVAL;
356 if (!udev->dev) {
357 retval = uinput_allocate_device(udev);
358 if (retval)
359 return retval;
362 dev = udev->dev;
364 user_dev = kmalloc(sizeof(struct uinput_user_dev), GFP_KERNEL);
365 if (!user_dev)
366 return -ENOMEM;
368 if (copy_from_user(user_dev, buffer, sizeof(struct uinput_user_dev))) {
369 retval = -EFAULT;
370 goto exit;
373 udev->ff_effects_max = user_dev->ff_effects_max;
375 size = strnlen(user_dev->name, UINPUT_MAX_NAME_SIZE) + 1;
376 if (!size) {
377 retval = -EINVAL;
378 goto exit;
381 kfree(dev->name);
382 dev->name = name = kmalloc(size, GFP_KERNEL);
383 if (!name) {
384 retval = -ENOMEM;
385 goto exit;
387 strlcpy(name, user_dev->name, size);
389 dev->id.bustype = user_dev->id.bustype;
390 dev->id.vendor = user_dev->id.vendor;
391 dev->id.product = user_dev->id.product;
392 dev->id.version = user_dev->id.version;
394 for (i = 0; i < ABS_CNT; i++) {
395 input_abs_set_max(dev, i, user_dev->absmax[i]);
396 input_abs_set_min(dev, i, user_dev->absmin[i]);
397 input_abs_set_fuzz(dev, i, user_dev->absfuzz[i]);
398 input_abs_set_flat(dev, i, user_dev->absflat[i]);
401 /* check if absmin/absmax/absfuzz/absflat are filled as
402 * told in Documentation/input/input-programming.txt */
403 if (test_bit(EV_ABS, dev->evbit)) {
404 retval = uinput_validate_absbits(dev);
405 if (retval < 0)
406 goto exit;
409 udev->state = UIST_SETUP_COMPLETE;
410 retval = count;
412 exit:
413 kfree(user_dev);
414 return retval;
417 static inline ssize_t uinput_inject_event(struct uinput_device *udev, const char __user *buffer, size_t count)
419 struct input_event ev;
421 if (count < input_event_size())
422 return -EINVAL;
424 if (input_event_from_user(buffer, &ev))
425 return -EFAULT;
427 input_event(udev->dev, ev.type, ev.code, ev.value);
429 return input_event_size();
432 static ssize_t uinput_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
434 struct uinput_device *udev = file->private_data;
435 int retval;
437 retval = mutex_lock_interruptible(&udev->mutex);
438 if (retval)
439 return retval;
441 retval = udev->state == UIST_CREATED ?
442 uinput_inject_event(udev, buffer, count) :
443 uinput_setup_device(udev, buffer, count);
445 mutex_unlock(&udev->mutex);
447 return retval;
450 static ssize_t uinput_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
452 struct uinput_device *udev = file->private_data;
453 int retval = 0;
455 if (udev->state != UIST_CREATED)
456 return -ENODEV;
458 if (udev->head == udev->tail && (file->f_flags & O_NONBLOCK))
459 return -EAGAIN;
461 retval = wait_event_interruptible(udev->waitq,
462 udev->head != udev->tail || udev->state != UIST_CREATED);
463 if (retval)
464 return retval;
466 retval = mutex_lock_interruptible(&udev->mutex);
467 if (retval)
468 return retval;
470 if (udev->state != UIST_CREATED) {
471 retval = -ENODEV;
472 goto out;
475 while (udev->head != udev->tail && retval + input_event_size() <= count) {
476 if (input_event_to_user(buffer + retval, &udev->buff[udev->tail])) {
477 retval = -EFAULT;
478 goto out;
480 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
481 retval += input_event_size();
484 out:
485 mutex_unlock(&udev->mutex);
487 return retval;
490 static unsigned int uinput_poll(struct file *file, poll_table *wait)
492 struct uinput_device *udev = file->private_data;
494 poll_wait(file, &udev->waitq, wait);
496 if (udev->head != udev->tail)
497 return POLLIN | POLLRDNORM;
499 return 0;
502 static int uinput_release(struct inode *inode, struct file *file)
504 struct uinput_device *udev = file->private_data;
506 uinput_destroy_device(udev);
507 kfree(udev);
509 return 0;
512 #ifdef CONFIG_COMPAT
513 struct uinput_ff_upload_compat {
514 int request_id;
515 int retval;
516 struct ff_effect_compat effect;
517 struct ff_effect_compat old;
520 static int uinput_ff_upload_to_user(char __user *buffer,
521 const struct uinput_ff_upload *ff_up)
523 if (INPUT_COMPAT_TEST) {
524 struct uinput_ff_upload_compat ff_up_compat;
526 ff_up_compat.request_id = ff_up->request_id;
527 ff_up_compat.retval = ff_up->retval;
529 * It so happens that the pointer that gives us the trouble
530 * is the last field in the structure. Since we don't support
531 * custom waveforms in uinput anyway we can just copy the whole
532 * thing (to the compat size) and ignore the pointer.
534 memcpy(&ff_up_compat.effect, &ff_up->effect,
535 sizeof(struct ff_effect_compat));
536 memcpy(&ff_up_compat.old, &ff_up->old,
537 sizeof(struct ff_effect_compat));
539 if (copy_to_user(buffer, &ff_up_compat,
540 sizeof(struct uinput_ff_upload_compat)))
541 return -EFAULT;
542 } else {
543 if (copy_to_user(buffer, ff_up,
544 sizeof(struct uinput_ff_upload)))
545 return -EFAULT;
548 return 0;
551 static int uinput_ff_upload_from_user(const char __user *buffer,
552 struct uinput_ff_upload *ff_up)
554 if (INPUT_COMPAT_TEST) {
555 struct uinput_ff_upload_compat ff_up_compat;
557 if (copy_from_user(&ff_up_compat, buffer,
558 sizeof(struct uinput_ff_upload_compat)))
559 return -EFAULT;
561 ff_up->request_id = ff_up_compat.request_id;
562 ff_up->retval = ff_up_compat.retval;
563 memcpy(&ff_up->effect, &ff_up_compat.effect,
564 sizeof(struct ff_effect_compat));
565 memcpy(&ff_up->old, &ff_up_compat.old,
566 sizeof(struct ff_effect_compat));
568 } else {
569 if (copy_from_user(ff_up, buffer,
570 sizeof(struct uinput_ff_upload)))
571 return -EFAULT;
574 return 0;
577 #else
579 static int uinput_ff_upload_to_user(char __user *buffer,
580 const struct uinput_ff_upload *ff_up)
582 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
583 return -EFAULT;
585 return 0;
588 static int uinput_ff_upload_from_user(const char __user *buffer,
589 struct uinput_ff_upload *ff_up)
591 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
592 return -EFAULT;
594 return 0;
597 #endif
599 #define uinput_set_bit(_arg, _bit, _max) \
600 ({ \
601 int __ret = 0; \
602 if (udev->state == UIST_CREATED) \
603 __ret = -EINVAL; \
604 else if ((_arg) > (_max)) \
605 __ret = -EINVAL; \
606 else set_bit((_arg), udev->dev->_bit); \
607 __ret; \
610 static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
611 unsigned long arg, void __user *p)
613 int retval;
614 struct uinput_device *udev = file->private_data;
615 struct uinput_ff_upload ff_up;
616 struct uinput_ff_erase ff_erase;
617 struct uinput_request *req;
618 int length;
619 char *phys;
621 retval = mutex_lock_interruptible(&udev->mutex);
622 if (retval)
623 return retval;
625 if (!udev->dev) {
626 retval = uinput_allocate_device(udev);
627 if (retval)
628 goto out;
631 switch (cmd) {
632 case UI_DEV_CREATE:
633 retval = uinput_create_device(udev);
634 break;
636 case UI_DEV_DESTROY:
637 uinput_destroy_device(udev);
638 break;
640 case UI_SET_EVBIT:
641 retval = uinput_set_bit(arg, evbit, EV_MAX);
642 break;
644 case UI_SET_KEYBIT:
645 retval = uinput_set_bit(arg, keybit, KEY_MAX);
646 break;
648 case UI_SET_RELBIT:
649 retval = uinput_set_bit(arg, relbit, REL_MAX);
650 break;
652 case UI_SET_ABSBIT:
653 retval = uinput_set_bit(arg, absbit, ABS_MAX);
654 break;
656 case UI_SET_MSCBIT:
657 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
658 break;
660 case UI_SET_LEDBIT:
661 retval = uinput_set_bit(arg, ledbit, LED_MAX);
662 break;
664 case UI_SET_SNDBIT:
665 retval = uinput_set_bit(arg, sndbit, SND_MAX);
666 break;
668 case UI_SET_FFBIT:
669 retval = uinput_set_bit(arg, ffbit, FF_MAX);
670 break;
672 case UI_SET_SWBIT:
673 retval = uinput_set_bit(arg, swbit, SW_MAX);
674 break;
676 case UI_SET_PHYS:
677 if (udev->state == UIST_CREATED) {
678 retval = -EINVAL;
679 goto out;
681 length = strnlen_user(p, 1024);
682 if (length <= 0) {
683 retval = -EFAULT;
684 break;
686 kfree(udev->dev->phys);
687 udev->dev->phys = phys = kmalloc(length, GFP_KERNEL);
688 if (!phys) {
689 retval = -ENOMEM;
690 break;
692 if (copy_from_user(phys, p, length)) {
693 udev->dev->phys = NULL;
694 kfree(phys);
695 retval = -EFAULT;
696 break;
698 phys[length - 1] = '\0';
699 break;
701 case UI_BEGIN_FF_UPLOAD:
702 retval = uinput_ff_upload_from_user(p, &ff_up);
703 if (retval)
704 break;
706 req = uinput_request_find(udev, ff_up.request_id);
707 if (!req || req->code != UI_FF_UPLOAD || !req->u.upload.effect) {
708 retval = -EINVAL;
709 break;
712 ff_up.retval = 0;
713 ff_up.effect = *req->u.upload.effect;
714 if (req->u.upload.old)
715 ff_up.old = *req->u.upload.old;
716 else
717 memset(&ff_up.old, 0, sizeof(struct ff_effect));
719 retval = uinput_ff_upload_to_user(p, &ff_up);
720 break;
722 case UI_BEGIN_FF_ERASE:
723 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
724 retval = -EFAULT;
725 break;
728 req = uinput_request_find(udev, ff_erase.request_id);
729 if (!req || req->code != UI_FF_ERASE) {
730 retval = -EINVAL;
731 break;
734 ff_erase.retval = 0;
735 ff_erase.effect_id = req->u.effect_id;
736 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
737 retval = -EFAULT;
738 break;
741 break;
743 case UI_END_FF_UPLOAD:
744 retval = uinput_ff_upload_from_user(p, &ff_up);
745 if (retval)
746 break;
748 req = uinput_request_find(udev, ff_up.request_id);
749 if (!req || req->code != UI_FF_UPLOAD ||
750 !req->u.upload.effect) {
751 retval = -EINVAL;
752 break;
755 req->retval = ff_up.retval;
756 uinput_request_done(udev, req);
757 break;
759 case UI_END_FF_ERASE:
760 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
761 retval = -EFAULT;
762 break;
765 req = uinput_request_find(udev, ff_erase.request_id);
766 if (!req || req->code != UI_FF_ERASE) {
767 retval = -EINVAL;
768 break;
771 req->retval = ff_erase.retval;
772 uinput_request_done(udev, req);
773 break;
775 default:
776 retval = -EINVAL;
779 out:
780 mutex_unlock(&udev->mutex);
781 return retval;
784 static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
786 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
789 #ifdef CONFIG_COMPAT
790 static long uinput_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
792 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
794 #endif
796 static const struct file_operations uinput_fops = {
797 .owner = THIS_MODULE,
798 .open = uinput_open,
799 .release = uinput_release,
800 .read = uinput_read,
801 .write = uinput_write,
802 .poll = uinput_poll,
803 .unlocked_ioctl = uinput_ioctl,
804 #ifdef CONFIG_COMPAT
805 .compat_ioctl = uinput_compat_ioctl,
806 #endif
809 static struct miscdevice uinput_misc = {
810 .fops = &uinput_fops,
811 .minor = UINPUT_MINOR,
812 .name = UINPUT_NAME,
814 MODULE_ALIAS_MISCDEV(UINPUT_MINOR);
815 MODULE_ALIAS("devname:" UINPUT_NAME);
817 static int __init uinput_init(void)
819 return misc_register(&uinput_misc);
822 static void __exit uinput_exit(void)
824 misc_deregister(&uinput_misc);
827 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
828 MODULE_DESCRIPTION("User level driver support for input subsystem");
829 MODULE_LICENSE("GPL");
830 MODULE_VERSION("0.3");
832 module_init(uinput_init);
833 module_exit(uinput_exit);