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.2 16/10/2004 (Micah Dowty <micah@navi.cx>)
24 * - added force feedback support
27 * - first public version
29 #include <linux/poll.h>
30 #include <linux/slab.h>
31 #include <linux/module.h>
32 #include <linux/init.h>
33 #include <linux/input.h>
34 #include <linux/smp_lock.h>
36 #include <linux/miscdevice.h>
37 #include <linux/uinput.h>
39 static int uinput_dev_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
)
41 struct uinput_device
*udev
;
45 udev
->buff
[udev
->head
].type
= type
;
46 udev
->buff
[udev
->head
].code
= code
;
47 udev
->buff
[udev
->head
].value
= value
;
48 do_gettimeofday(&udev
->buff
[udev
->head
].time
);
49 udev
->head
= (udev
->head
+ 1) % UINPUT_BUFFER_SIZE
;
51 wake_up_interruptible(&udev
->waitq
);
56 static int uinput_request_alloc_id(struct uinput_device
*udev
, struct uinput_request
*request
)
58 /* Atomically allocate an ID for the given request. Returns 0 on success. */
62 spin_lock(&udev
->requests_lock
);
64 for (id
= 0; id
< UINPUT_NUM_REQUESTS
; id
++)
65 if (!udev
->requests
[id
]) {
67 udev
->requests
[id
] = request
;
72 spin_unlock(&udev
->requests_lock
);
76 static struct uinput_request
* uinput_request_find(struct uinput_device
*udev
, int id
)
78 /* Find an input request, by ID. Returns NULL if the ID isn't valid. */
79 if (id
>= UINPUT_NUM_REQUESTS
|| id
< 0)
81 return udev
->requests
[id
];
84 static inline int uinput_request_reserve_slot(struct uinput_device
*udev
, struct uinput_request
*request
)
86 /* Allocate slot. If none are available right away, wait. */
87 return wait_event_interruptible(udev
->requests_waitq
,
88 !uinput_request_alloc_id(udev
, request
));
91 static void uinput_request_done(struct uinput_device
*udev
, struct uinput_request
*request
)
93 /* Mark slot as available */
94 udev
->requests
[request
->id
] = NULL
;
95 wake_up(&udev
->requests_waitq
);
97 complete(&request
->done
);
100 static int uinput_request_submit(struct input_dev
*dev
, struct uinput_request
*request
)
102 /* Tell our userspace app about this new request by queueing an input event */
103 uinput_dev_event(dev
, EV_UINPUT
, request
->code
, request
->id
);
105 /* Wait for the request to complete */
106 wait_for_completion(&request
->done
);
107 return request
->retval
;
110 static int uinput_dev_upload_effect(struct input_dev
*dev
, struct ff_effect
*effect
)
112 struct uinput_request request
;
115 if (!test_bit(EV_FF
, dev
->evbit
))
119 init_completion(&request
.done
);
120 request
.code
= UI_FF_UPLOAD
;
121 request
.u
.effect
= effect
;
123 retval
= uinput_request_reserve_slot(dev
->private, &request
);
125 retval
= uinput_request_submit(dev
, &request
);
130 static int uinput_dev_erase_effect(struct input_dev
*dev
, int effect_id
)
132 struct uinput_request request
;
135 if (!test_bit(EV_FF
, dev
->evbit
))
139 init_completion(&request
.done
);
140 request
.code
= UI_FF_ERASE
;
141 request
.u
.effect_id
= effect_id
;
143 retval
= uinput_request_reserve_slot(dev
->private, &request
);
145 retval
= uinput_request_submit(dev
, &request
);
150 static void uinput_destroy_device(struct uinput_device
*udev
)
152 const char *name
, *phys
;
155 name
= udev
->dev
->name
;
156 phys
= udev
->dev
->phys
;
157 if (udev
->state
== UIST_CREATED
)
158 input_unregister_device(udev
->dev
);
160 input_free_device(udev
->dev
);
166 udev
->state
= UIST_NEW_DEVICE
;
169 static int uinput_create_device(struct uinput_device
*udev
)
173 if (udev
->state
!= UIST_SETUP_COMPLETE
) {
174 printk(KERN_DEBUG
"%s: write device info first\n", UINPUT_NAME
);
178 error
= input_register_device(udev
->dev
);
180 uinput_destroy_device(udev
);
184 udev
->state
= UIST_CREATED
;
189 static int uinput_open(struct inode
*inode
, struct file
*file
)
191 struct uinput_device
*newdev
;
193 newdev
= kzalloc(sizeof(struct uinput_device
), GFP_KERNEL
);
197 init_MUTEX(&newdev
->sem
);
198 spin_lock_init(&newdev
->requests_lock
);
199 init_waitqueue_head(&newdev
->requests_waitq
);
200 init_waitqueue_head(&newdev
->waitq
);
201 newdev
->state
= UIST_NEW_DEVICE
;
203 file
->private_data
= newdev
;
208 static int uinput_validate_absbits(struct input_dev
*dev
)
213 for (cnt
= 0; cnt
< ABS_MAX
+ 1; cnt
++) {
214 if (!test_bit(cnt
, dev
->absbit
))
217 if ((dev
->absmax
[cnt
] <= dev
->absmin
[cnt
])) {
219 "%s: invalid abs[%02x] min:%d max:%d\n",
221 dev
->absmin
[cnt
], dev
->absmax
[cnt
]);
226 if (dev
->absflat
[cnt
] > (dev
->absmax
[cnt
] - dev
->absmin
[cnt
])) {
228 "%s: absflat[%02x] out of range: %d "
230 UINPUT_NAME
, cnt
, dev
->absflat
[cnt
],
231 dev
->absmin
[cnt
], dev
->absmax
[cnt
]);
239 static int uinput_allocate_device(struct uinput_device
*udev
)
241 udev
->dev
= input_allocate_device();
245 udev
->dev
->event
= uinput_dev_event
;
246 udev
->dev
->upload_effect
= uinput_dev_upload_effect
;
247 udev
->dev
->erase_effect
= uinput_dev_erase_effect
;
248 udev
->dev
->private = udev
;
253 static int uinput_setup_device(struct uinput_device
*udev
, const char __user
*buffer
, size_t count
)
255 struct uinput_user_dev
*user_dev
;
256 struct input_dev
*dev
;
261 if (count
!= sizeof(struct uinput_user_dev
))
265 retval
= uinput_allocate_device(udev
);
272 user_dev
= kmalloc(sizeof(struct uinput_user_dev
), GFP_KERNEL
);
276 if (copy_from_user(user_dev
, buffer
, sizeof(struct uinput_user_dev
))) {
281 size
= strnlen(user_dev
->name
, UINPUT_MAX_NAME_SIZE
) + 1;
288 dev
->name
= name
= kmalloc(size
, GFP_KERNEL
);
293 strlcpy(name
, user_dev
->name
, size
);
295 dev
->id
.bustype
= user_dev
->id
.bustype
;
296 dev
->id
.vendor
= user_dev
->id
.vendor
;
297 dev
->id
.product
= user_dev
->id
.product
;
298 dev
->id
.version
= user_dev
->id
.version
;
299 dev
->ff_effects_max
= user_dev
->ff_effects_max
;
301 size
= sizeof(int) * (ABS_MAX
+ 1);
302 memcpy(dev
->absmax
, user_dev
->absmax
, size
);
303 memcpy(dev
->absmin
, user_dev
->absmin
, size
);
304 memcpy(dev
->absfuzz
, user_dev
->absfuzz
, size
);
305 memcpy(dev
->absflat
, user_dev
->absflat
, size
);
307 /* check if absmin/absmax/absfuzz/absflat are filled as
308 * told in Documentation/input/input-programming.txt */
309 if (test_bit(EV_ABS
, dev
->evbit
)) {
310 retval
= uinput_validate_absbits(dev
);
315 udev
->state
= UIST_SETUP_COMPLETE
;
323 static inline ssize_t
uinput_inject_event(struct uinput_device
*udev
, const char __user
*buffer
, size_t count
)
325 struct input_event ev
;
327 if (count
!= sizeof(struct input_event
))
330 if (copy_from_user(&ev
, buffer
, sizeof(struct input_event
)))
333 input_event(udev
->dev
, ev
.type
, ev
.code
, ev
.value
);
335 return sizeof(struct input_event
);
338 static ssize_t
uinput_write(struct file
*file
, const char __user
*buffer
, size_t count
, loff_t
*ppos
)
340 struct uinput_device
*udev
= file
->private_data
;
343 retval
= down_interruptible(&udev
->sem
);
347 retval
= udev
->state
== UIST_CREATED
?
348 uinput_inject_event(udev
, buffer
, count
) :
349 uinput_setup_device(udev
, buffer
, count
);
356 static ssize_t
uinput_read(struct file
*file
, char __user
*buffer
, size_t count
, loff_t
*ppos
)
358 struct uinput_device
*udev
= file
->private_data
;
361 if (udev
->state
!= UIST_CREATED
)
364 if (udev
->head
== udev
->tail
&& (file
->f_flags
& O_NONBLOCK
))
367 retval
= wait_event_interruptible(udev
->waitq
,
368 udev
->head
!= udev
->tail
|| udev
->state
!= UIST_CREATED
);
372 retval
= down_interruptible(&udev
->sem
);
376 if (udev
->state
!= UIST_CREATED
) {
381 while (udev
->head
!= udev
->tail
&& retval
+ sizeof(struct input_event
) <= count
) {
382 if (copy_to_user(buffer
+ retval
, &udev
->buff
[udev
->tail
], sizeof(struct input_event
))) {
386 udev
->tail
= (udev
->tail
+ 1) % UINPUT_BUFFER_SIZE
;
387 retval
+= sizeof(struct input_event
);
396 static unsigned int uinput_poll(struct file
*file
, poll_table
*wait
)
398 struct uinput_device
*udev
= file
->private_data
;
400 poll_wait(file
, &udev
->waitq
, wait
);
402 if (udev
->head
!= udev
->tail
)
403 return POLLIN
| POLLRDNORM
;
408 static int uinput_release(struct inode
*inode
, struct file
*file
)
410 struct uinput_device
*udev
= file
->private_data
;
412 uinput_destroy_device(udev
);
418 #define uinput_set_bit(_arg, _bit, _max) \
421 if (udev->state == UIST_CREATED) \
423 else if ((_arg) > (_max)) \
425 else set_bit((_arg), udev->dev->_bit); \
429 static long uinput_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
432 struct uinput_device
*udev
;
433 void __user
*p
= (void __user
*)arg
;
434 struct uinput_ff_upload ff_up
;
435 struct uinput_ff_erase ff_erase
;
436 struct uinput_request
*req
;
440 udev
= file
->private_data
;
442 retval
= down_interruptible(&udev
->sem
);
447 retval
= uinput_allocate_device(udev
);
454 retval
= uinput_create_device(udev
);
458 uinput_destroy_device(udev
);
462 retval
= uinput_set_bit(arg
, evbit
, EV_MAX
);
466 retval
= uinput_set_bit(arg
, keybit
, KEY_MAX
);
470 retval
= uinput_set_bit(arg
, relbit
, REL_MAX
);
474 retval
= uinput_set_bit(arg
, absbit
, ABS_MAX
);
478 retval
= uinput_set_bit(arg
, mscbit
, MSC_MAX
);
482 retval
= uinput_set_bit(arg
, ledbit
, LED_MAX
);
486 retval
= uinput_set_bit(arg
, sndbit
, SND_MAX
);
490 retval
= uinput_set_bit(arg
, ffbit
, FF_MAX
);
494 retval
= uinput_set_bit(arg
, swbit
, SW_MAX
);
498 if (udev
->state
== UIST_CREATED
) {
502 length
= strnlen_user(p
, 1024);
507 kfree(udev
->dev
->phys
);
508 udev
->dev
->phys
= phys
= kmalloc(length
, GFP_KERNEL
);
513 if (copy_from_user(phys
, p
, length
)) {
514 udev
->dev
->phys
= NULL
;
519 phys
[length
- 1] = '\0';
522 case UI_BEGIN_FF_UPLOAD
:
523 if (copy_from_user(&ff_up
, p
, sizeof(ff_up
))) {
527 req
= uinput_request_find(udev
, ff_up
.request_id
);
528 if (!(req
&& req
->code
== UI_FF_UPLOAD
&& req
->u
.effect
)) {
533 memcpy(&ff_up
.effect
, req
->u
.effect
, sizeof(struct ff_effect
));
534 if (copy_to_user(p
, &ff_up
, sizeof(ff_up
))) {
540 case UI_BEGIN_FF_ERASE
:
541 if (copy_from_user(&ff_erase
, p
, sizeof(ff_erase
))) {
545 req
= uinput_request_find(udev
, ff_erase
.request_id
);
546 if (!(req
&& req
->code
== UI_FF_ERASE
)) {
551 ff_erase
.effect_id
= req
->u
.effect_id
;
552 if (copy_to_user(p
, &ff_erase
, sizeof(ff_erase
))) {
558 case UI_END_FF_UPLOAD
:
559 if (copy_from_user(&ff_up
, p
, sizeof(ff_up
))) {
563 req
= uinput_request_find(udev
, ff_up
.request_id
);
564 if (!(req
&& req
->code
== UI_FF_UPLOAD
&& req
->u
.effect
)) {
568 req
->retval
= ff_up
.retval
;
569 memcpy(req
->u
.effect
, &ff_up
.effect
, sizeof(struct ff_effect
));
570 uinput_request_done(udev
, req
);
573 case UI_END_FF_ERASE
:
574 if (copy_from_user(&ff_erase
, p
, sizeof(ff_erase
))) {
578 req
= uinput_request_find(udev
, ff_erase
.request_id
);
579 if (!(req
&& req
->code
== UI_FF_ERASE
)) {
583 req
->retval
= ff_erase
.retval
;
584 uinput_request_done(udev
, req
);
596 static struct file_operations uinput_fops
= {
597 .owner
= THIS_MODULE
,
599 .release
= uinput_release
,
601 .write
= uinput_write
,
603 .unlocked_ioctl
= uinput_ioctl
,
606 static struct miscdevice uinput_misc
= {
607 .fops
= &uinput_fops
,
608 .minor
= UINPUT_MINOR
,
612 static int __init
uinput_init(void)
614 return misc_register(&uinput_misc
);
617 static void __exit
uinput_exit(void)
619 misc_deregister(&uinput_misc
);
622 MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
623 MODULE_DESCRIPTION("User level driver support for input subsystem");
624 MODULE_LICENSE("GPL");
626 module_init(uinput_init
);
627 module_exit(uinput_exit
);