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.4 01/09/2014 (Benjamin Tissoires <benjamin.tissoires@redhat.com>)
24 * - add UI_GET_SYSNAME ioctl
25 * 0.3 09/04/2006 (Anssi Hannula <anssi.hannula@gmail.com>)
26 * - updated ff support for the changes in kernel interface
27 * - added MODULE_VERSION
28 * 0.2 16/10/2004 (Micah Dowty <micah@navi.cx>)
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 if (!test_bit(EV_ABS
, dev
->evbit
))
320 * Check if absmin/absmax/absfuzz/absflat are sane.
323 for (cnt
= 0; cnt
< ABS_CNT
; cnt
++) {
325 if (!test_bit(cnt
, dev
->absbit
))
328 min
= input_abs_get_min(dev
, cnt
);
329 max
= input_abs_get_max(dev
, cnt
);
331 if ((min
!= 0 || max
!= 0) && max
<= min
) {
333 "%s: invalid abs[%02x] min:%d max:%d\n",
335 input_abs_get_min(dev
, cnt
),
336 input_abs_get_max(dev
, cnt
));
340 if (input_abs_get_flat(dev
, cnt
) >
341 input_abs_get_max(dev
, cnt
) - input_abs_get_min(dev
, cnt
)) {
343 "%s: abs_flat #%02x out of range: %d "
346 input_abs_get_flat(dev
, cnt
),
347 input_abs_get_min(dev
, cnt
),
348 input_abs_get_max(dev
, cnt
));
353 if (test_bit(ABS_MT_SLOT
, dev
->absbit
)) {
354 nslot
= input_abs_get_max(dev
, ABS_MT_SLOT
) + 1;
355 input_mt_init_slots(dev
, nslot
, 0);
356 } else if (test_bit(ABS_MT_POSITION_X
, dev
->absbit
)) {
357 input_set_events_per_packet(dev
, 60);
363 static int uinput_allocate_device(struct uinput_device
*udev
)
365 udev
->dev
= input_allocate_device();
369 udev
->dev
->event
= uinput_dev_event
;
370 input_set_drvdata(udev
->dev
, udev
);
375 static int uinput_setup_device(struct uinput_device
*udev
,
376 const char __user
*buffer
, size_t count
)
378 struct uinput_user_dev
*user_dev
;
379 struct input_dev
*dev
;
383 if (count
!= sizeof(struct uinput_user_dev
))
387 retval
= uinput_allocate_device(udev
);
394 user_dev
= memdup_user(buffer
, sizeof(struct uinput_user_dev
));
395 if (IS_ERR(user_dev
))
396 return PTR_ERR(user_dev
);
398 udev
->ff_effects_max
= user_dev
->ff_effects_max
;
400 /* Ensure name is filled in */
401 if (!user_dev
->name
[0]) {
407 dev
->name
= kstrndup(user_dev
->name
, UINPUT_MAX_NAME_SIZE
,
414 dev
->id
.bustype
= user_dev
->id
.bustype
;
415 dev
->id
.vendor
= user_dev
->id
.vendor
;
416 dev
->id
.product
= user_dev
->id
.product
;
417 dev
->id
.version
= user_dev
->id
.version
;
419 for (i
= 0; i
< ABS_CNT
; i
++) {
420 input_abs_set_max(dev
, i
, user_dev
->absmax
[i
]);
421 input_abs_set_min(dev
, i
, user_dev
->absmin
[i
]);
422 input_abs_set_fuzz(dev
, i
, user_dev
->absfuzz
[i
]);
423 input_abs_set_flat(dev
, i
, user_dev
->absflat
[i
]);
426 retval
= uinput_validate_absbits(dev
);
430 udev
->state
= UIST_SETUP_COMPLETE
;
438 static ssize_t
uinput_inject_events(struct uinput_device
*udev
,
439 const char __user
*buffer
, size_t count
)
441 struct input_event ev
;
444 if (count
!= 0 && count
< input_event_size())
447 while (bytes
+ input_event_size() <= count
) {
449 * Note that even if some events were fetched successfully
450 * we are still going to return EFAULT instead of partial
451 * count to let userspace know that it got it's buffers
454 if (input_event_from_user(buffer
+ bytes
, &ev
))
457 input_event(udev
->dev
, ev
.type
, ev
.code
, ev
.value
);
458 bytes
+= input_event_size();
464 static ssize_t
uinput_write(struct file
*file
, const char __user
*buffer
,
465 size_t count
, loff_t
*ppos
)
467 struct uinput_device
*udev
= file
->private_data
;
473 retval
= mutex_lock_interruptible(&udev
->mutex
);
477 retval
= udev
->state
== UIST_CREATED
?
478 uinput_inject_events(udev
, buffer
, count
) :
479 uinput_setup_device(udev
, buffer
, count
);
481 mutex_unlock(&udev
->mutex
);
486 static bool uinput_fetch_next_event(struct uinput_device
*udev
,
487 struct input_event
*event
)
491 spin_lock_irq(&udev
->dev
->event_lock
);
493 have_event
= udev
->head
!= udev
->tail
;
495 *event
= udev
->buff
[udev
->tail
];
496 udev
->tail
= (udev
->tail
+ 1) % UINPUT_BUFFER_SIZE
;
499 spin_unlock_irq(&udev
->dev
->event_lock
);
504 static ssize_t
uinput_events_to_user(struct uinput_device
*udev
,
505 char __user
*buffer
, size_t count
)
507 struct input_event event
;
510 while (read
+ input_event_size() <= count
&&
511 uinput_fetch_next_event(udev
, &event
)) {
513 if (input_event_to_user(buffer
+ read
, &event
))
516 read
+= input_event_size();
522 static ssize_t
uinput_read(struct file
*file
, char __user
*buffer
,
523 size_t count
, loff_t
*ppos
)
525 struct uinput_device
*udev
= file
->private_data
;
528 if (count
!= 0 && count
< input_event_size())
532 retval
= mutex_lock_interruptible(&udev
->mutex
);
536 if (udev
->state
!= UIST_CREATED
)
538 else if (udev
->head
== udev
->tail
&&
539 (file
->f_flags
& O_NONBLOCK
))
542 retval
= uinput_events_to_user(udev
, buffer
, count
);
544 mutex_unlock(&udev
->mutex
);
546 if (retval
|| count
== 0)
549 if (!(file
->f_flags
& O_NONBLOCK
))
550 retval
= wait_event_interruptible(udev
->waitq
,
551 udev
->head
!= udev
->tail
||
552 udev
->state
!= UIST_CREATED
);
553 } while (retval
== 0);
558 static unsigned int uinput_poll(struct file
*file
, poll_table
*wait
)
560 struct uinput_device
*udev
= file
->private_data
;
562 poll_wait(file
, &udev
->waitq
, wait
);
564 if (udev
->head
!= udev
->tail
)
565 return POLLIN
| POLLRDNORM
;
570 static int uinput_release(struct inode
*inode
, struct file
*file
)
572 struct uinput_device
*udev
= file
->private_data
;
574 uinput_destroy_device(udev
);
581 struct uinput_ff_upload_compat
{
584 struct ff_effect_compat effect
;
585 struct ff_effect_compat old
;
588 static int uinput_ff_upload_to_user(char __user
*buffer
,
589 const struct uinput_ff_upload
*ff_up
)
591 if (INPUT_COMPAT_TEST
) {
592 struct uinput_ff_upload_compat ff_up_compat
;
594 ff_up_compat
.request_id
= ff_up
->request_id
;
595 ff_up_compat
.retval
= ff_up
->retval
;
597 * It so happens that the pointer that gives us the trouble
598 * is the last field in the structure. Since we don't support
599 * custom waveforms in uinput anyway we can just copy the whole
600 * thing (to the compat size) and ignore the pointer.
602 memcpy(&ff_up_compat
.effect
, &ff_up
->effect
,
603 sizeof(struct ff_effect_compat
));
604 memcpy(&ff_up_compat
.old
, &ff_up
->old
,
605 sizeof(struct ff_effect_compat
));
607 if (copy_to_user(buffer
, &ff_up_compat
,
608 sizeof(struct uinput_ff_upload_compat
)))
611 if (copy_to_user(buffer
, ff_up
,
612 sizeof(struct uinput_ff_upload
)))
619 static int uinput_ff_upload_from_user(const char __user
*buffer
,
620 struct uinput_ff_upload
*ff_up
)
622 if (INPUT_COMPAT_TEST
) {
623 struct uinput_ff_upload_compat ff_up_compat
;
625 if (copy_from_user(&ff_up_compat
, buffer
,
626 sizeof(struct uinput_ff_upload_compat
)))
629 ff_up
->request_id
= ff_up_compat
.request_id
;
630 ff_up
->retval
= ff_up_compat
.retval
;
631 memcpy(&ff_up
->effect
, &ff_up_compat
.effect
,
632 sizeof(struct ff_effect_compat
));
633 memcpy(&ff_up
->old
, &ff_up_compat
.old
,
634 sizeof(struct ff_effect_compat
));
637 if (copy_from_user(ff_up
, buffer
,
638 sizeof(struct uinput_ff_upload
)))
647 static int uinput_ff_upload_to_user(char __user
*buffer
,
648 const struct uinput_ff_upload
*ff_up
)
650 if (copy_to_user(buffer
, ff_up
, sizeof(struct uinput_ff_upload
)))
656 static int uinput_ff_upload_from_user(const char __user
*buffer
,
657 struct uinput_ff_upload
*ff_up
)
659 if (copy_from_user(ff_up
, buffer
, sizeof(struct uinput_ff_upload
)))
667 #define uinput_set_bit(_arg, _bit, _max) \
670 if (udev->state == UIST_CREATED) \
672 else if ((_arg) > (_max)) \
674 else set_bit((_arg), udev->dev->_bit); \
678 static int uinput_str_to_user(void __user
*dest
, const char *str
,
681 char __user
*p
= dest
;
690 len
= strlen(str
) + 1;
694 ret
= copy_to_user(p
, str
, len
);
698 /* force terminating '\0' */
699 ret
= put_user(0, p
+ len
- 1);
700 return ret
? -EFAULT
: len
;
703 static long uinput_ioctl_handler(struct file
*file
, unsigned int cmd
,
704 unsigned long arg
, void __user
*p
)
707 struct uinput_device
*udev
= file
->private_data
;
708 struct uinput_ff_upload ff_up
;
709 struct uinput_ff_erase ff_erase
;
710 struct uinput_request
*req
;
715 retval
= mutex_lock_interruptible(&udev
->mutex
);
720 retval
= uinput_allocate_device(udev
);
727 if (put_user(UINPUT_VERSION
,
728 (unsigned int __user
*)p
))
733 retval
= uinput_create_device(udev
);
737 uinput_destroy_device(udev
);
741 retval
= uinput_set_bit(arg
, evbit
, EV_MAX
);
745 retval
= uinput_set_bit(arg
, keybit
, KEY_MAX
);
749 retval
= uinput_set_bit(arg
, relbit
, REL_MAX
);
753 retval
= uinput_set_bit(arg
, absbit
, ABS_MAX
);
757 retval
= uinput_set_bit(arg
, mscbit
, MSC_MAX
);
761 retval
= uinput_set_bit(arg
, ledbit
, LED_MAX
);
765 retval
= uinput_set_bit(arg
, sndbit
, SND_MAX
);
769 retval
= uinput_set_bit(arg
, ffbit
, FF_MAX
);
773 retval
= uinput_set_bit(arg
, swbit
, SW_MAX
);
777 retval
= uinput_set_bit(arg
, propbit
, INPUT_PROP_MAX
);
781 if (udev
->state
== UIST_CREATED
) {
786 phys
= strndup_user(p
, 1024);
788 retval
= PTR_ERR(phys
);
792 kfree(udev
->dev
->phys
);
793 udev
->dev
->phys
= phys
;
796 case UI_BEGIN_FF_UPLOAD
:
797 retval
= uinput_ff_upload_from_user(p
, &ff_up
);
801 req
= uinput_request_find(udev
, ff_up
.request_id
);
802 if (!req
|| req
->code
!= UI_FF_UPLOAD
||
803 !req
->u
.upload
.effect
) {
809 ff_up
.effect
= *req
->u
.upload
.effect
;
810 if (req
->u
.upload
.old
)
811 ff_up
.old
= *req
->u
.upload
.old
;
813 memset(&ff_up
.old
, 0, sizeof(struct ff_effect
));
815 retval
= uinput_ff_upload_to_user(p
, &ff_up
);
818 case UI_BEGIN_FF_ERASE
:
819 if (copy_from_user(&ff_erase
, p
, sizeof(ff_erase
))) {
824 req
= uinput_request_find(udev
, ff_erase
.request_id
);
825 if (!req
|| req
->code
!= UI_FF_ERASE
) {
831 ff_erase
.effect_id
= req
->u
.effect_id
;
832 if (copy_to_user(p
, &ff_erase
, sizeof(ff_erase
))) {
839 case UI_END_FF_UPLOAD
:
840 retval
= uinput_ff_upload_from_user(p
, &ff_up
);
844 req
= uinput_request_find(udev
, ff_up
.request_id
);
845 if (!req
|| req
->code
!= UI_FF_UPLOAD
||
846 !req
->u
.upload
.effect
) {
851 req
->retval
= ff_up
.retval
;
852 uinput_request_done(udev
, req
);
855 case UI_END_FF_ERASE
:
856 if (copy_from_user(&ff_erase
, p
, sizeof(ff_erase
))) {
861 req
= uinput_request_find(udev
, ff_erase
.request_id
);
862 if (!req
|| req
->code
!= UI_FF_ERASE
) {
867 req
->retval
= ff_erase
.retval
;
868 uinput_request_done(udev
, req
);
872 size
= _IOC_SIZE(cmd
);
874 /* Now check variable-length commands */
875 switch (cmd
& ~IOCSIZE_MASK
) {
876 case UI_GET_SYSNAME(0):
877 if (udev
->state
!= UIST_CREATED
) {
881 name
= dev_name(&udev
->dev
->dev
);
882 retval
= uinput_str_to_user(p
, name
, size
);
888 mutex_unlock(&udev
->mutex
);
892 static long uinput_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
894 return uinput_ioctl_handler(file
, cmd
, arg
, (void __user
*)arg
);
899 #define UI_SET_PHYS_COMPAT _IOW(UINPUT_IOCTL_BASE, 108, compat_uptr_t)
901 static long uinput_compat_ioctl(struct file
*file
,
902 unsigned int cmd
, unsigned long arg
)
904 if (cmd
== UI_SET_PHYS_COMPAT
)
907 return uinput_ioctl_handler(file
, cmd
, arg
, compat_ptr(arg
));
911 static const struct file_operations uinput_fops
= {
912 .owner
= THIS_MODULE
,
914 .release
= uinput_release
,
916 .write
= uinput_write
,
918 .unlocked_ioctl
= uinput_ioctl
,
920 .compat_ioctl
= uinput_compat_ioctl
,
925 static struct miscdevice uinput_misc
= {
926 .fops
= &uinput_fops
,
927 .minor
= UINPUT_MINOR
,
930 MODULE_ALIAS_MISCDEV(UINPUT_MINOR
);
931 MODULE_ALIAS("devname:" UINPUT_NAME
);
933 static int __init
uinput_init(void)
935 return misc_register(&uinput_misc
);
938 static void __exit
uinput_exit(void)
940 misc_deregister(&uinput_misc
);
943 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
944 MODULE_DESCRIPTION("User level driver support for input subsystem");
945 MODULE_LICENSE("GPL");
946 MODULE_VERSION("0.3");
948 module_init(uinput_init
);
949 module_exit(uinput_exit
);