2 * Copyright (c) 2014 Jakub Wojciech Klama <jceel@FreeBSD.org>
3 * Copyright (c) 2015-2016 Vladimir Kondratyev <wulf@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include "opt_evdev.h"
32 #include <sys/param.h>
34 #include <sys/fcntl.h>
35 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
41 #include <sys/selinfo.h>
42 #include <sys/systm.h>
46 #include <dev/evdev/evdev.h>
47 #include <dev/evdev/evdev_private.h>
48 #include <dev/evdev/input.h>
49 #include <dev/evdev/uinput.h>
52 #define debugf(state, fmt, args...) printf("uinput: " fmt "\n", ##args)
54 #define debugf(state, fmt, args...)
57 #define UINPUT_BUFFER_SIZE 16
59 #define UINPUT_LOCK(state) sx_xlock(&(state)->ucs_lock)
60 #define UINPUT_UNLOCK(state) sx_unlock(&(state)->ucs_lock)
61 #define UINPUT_LOCK_ASSERT(state) sx_assert(&(state)->ucs_lock, SA_LOCKED)
62 #define UINPUT_EMPTYQ(state) \
63 ((state)->ucs_buffer_head == (state)->ucs_buffer_tail)
72 static evdev_event_t uinput_ev_event;
74 static d_open_t uinput_open;
75 static d_read_t uinput_read;
76 static d_write_t uinput_write;
77 static d_ioctl_t uinput_ioctl;
78 static d_poll_t uinput_poll;
79 static d_kqfilter_t uinput_kqfilter;
80 static void uinput_dtor(void *);
82 static int uinput_kqread(struct knote *kn, long hint);
83 static void uinput_kqdetach(struct knote *kn);
85 static struct cdevsw uinput_cdevsw = {
86 .d_version = D_VERSION,
87 .d_open = uinput_open,
88 .d_read = uinput_read,
89 .d_write = uinput_write,
90 .d_ioctl = uinput_ioctl,
91 .d_poll = uinput_poll,
92 .d_kqfilter = uinput_kqfilter,
96 static struct cdev *uinput_cdev;
98 static struct evdev_methods uinput_ev_methods = {
101 .ev_event = uinput_ev_event,
104 static struct filterops uinput_filterops = {
107 .f_detach = uinput_kqdetach,
108 .f_event = uinput_kqread,
111 struct uinput_cdev_state
113 enum uinput_state ucs_state;
114 struct evdev_dev * ucs_evdev;
116 size_t ucs_buffer_head;
117 size_t ucs_buffer_tail;
118 struct selinfo ucs_selp;
121 struct input_event ucs_buffer[UINPUT_BUFFER_SIZE];
124 static void uinput_enqueue_event(struct uinput_cdev_state *, uint16_t,
126 static int uinput_setup_provider(struct uinput_cdev_state *,
127 struct uinput_user_dev *);
128 static int uinput_cdev_create(void);
129 static void uinput_notify(struct uinput_cdev_state *);
132 uinput_knllock(void *arg)
140 uinput_knlunlock(void *arg)
148 uinput_knl_assert_locked(void *arg)
151 sx_assert((struct sx*)arg, SA_XLOCKED);
155 uinput_knl_assert_unlocked(void *arg)
158 sx_assert((struct sx*)arg, SA_UNLOCKED);
162 uinput_ev_event(struct evdev_dev *evdev, void *softc, uint16_t type,
163 uint16_t code, int32_t value)
165 struct uinput_cdev_state *state = softc;
168 evdev_push_event(evdev, type, code, value);
171 if (state->ucs_state == UINPUT_RUNNING) {
172 uinput_enqueue_event(state, type, code, value);
173 uinput_notify(state);
175 UINPUT_UNLOCK(state);
179 uinput_enqueue_event(struct uinput_cdev_state *state, uint16_t type,
180 uint16_t code, int32_t value)
184 UINPUT_LOCK_ASSERT(state);
186 head = state->ucs_buffer_head;
187 tail = (state->ucs_buffer_tail + 1) % UINPUT_BUFFER_SIZE;
189 microtime(&state->ucs_buffer[tail].time);
190 state->ucs_buffer[tail].type = type;
191 state->ucs_buffer[tail].code = code;
192 state->ucs_buffer[tail].value = value;
193 state->ucs_buffer_tail = tail;
195 /* If queue is full remove oldest event */
197 debugf(state, "state %p: buffer overflow", state);
199 head = (head + 1) % UINPUT_BUFFER_SIZE;
200 state->ucs_buffer_head = head;
205 uinput_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
207 struct uinput_cdev_state *state;
209 state = malloc(sizeof(struct uinput_cdev_state), M_EVDEV,
211 state->ucs_evdev = evdev_alloc();
213 sx_init(&state->ucs_lock, "uinput");
214 knlist_init(&state->ucs_selp.si_note, &state->ucs_lock, uinput_knllock,
215 uinput_knlunlock, uinput_knl_assert_locked,
216 uinput_knl_assert_unlocked);
218 devfs_set_cdevpriv(state, uinput_dtor);
223 uinput_dtor(void *data)
225 struct uinput_cdev_state *state = (struct uinput_cdev_state *)data;
227 evdev_free(state->ucs_evdev);
229 knlist_clear(&state->ucs_selp.si_note, 0);
230 seldrain(&state->ucs_selp);
231 knlist_destroy(&state->ucs_selp.si_note);
232 sx_destroy(&state->ucs_lock);
237 uinput_read(struct cdev *dev, struct uio *uio, int ioflag)
239 struct uinput_cdev_state *state;
240 struct input_event *event;
243 ret = devfs_get_cdevpriv((void **)&state);
247 debugf(state, "read %zd bytes by thread %d", uio->uio_resid,
248 uio->uio_td->td_tid);
250 /* Zero-sized reads are allowed for error checking */
251 if (uio->uio_resid != 0 && uio->uio_resid < sizeof(struct input_event))
254 remaining = uio->uio_resid / sizeof(struct input_event);
258 if (state->ucs_state != UINPUT_RUNNING)
261 if (ret == 0 && UINPUT_EMPTYQ(state)) {
262 if (ioflag & O_NONBLOCK)
265 if (remaining != 0) {
266 state->ucs_blocked = true;
267 ret = sx_sleep(state, &state->ucs_lock,
268 PCATCH, "uiread", 0);
273 while (ret == 0 && !UINPUT_EMPTYQ(state) && remaining > 0) {
274 event = &state->ucs_buffer[state->ucs_buffer_head];
275 state->ucs_buffer_head = (state->ucs_buffer_head + 1) %
278 ret = uiomove(event, sizeof(struct input_event), uio);
281 UINPUT_UNLOCK(state);
287 uinput_write(struct cdev *dev, struct uio *uio, int ioflag)
289 struct uinput_cdev_state *state;
290 struct uinput_user_dev userdev;
291 struct input_event event;
294 ret = devfs_get_cdevpriv((void **)&state);
298 debugf(state, "write %zd bytes by thread %d", uio->uio_resid,
299 uio->uio_td->td_tid);
303 if (state->ucs_state != UINPUT_RUNNING) {
304 /* Process written struct uinput_user_dev */
305 if (uio->uio_resid != sizeof(struct uinput_user_dev)) {
306 debugf(state, "write size not multiple of "
307 "struct uinput_user_dev size");
310 ret = uiomove(&userdev, sizeof(struct uinput_user_dev),
313 uinput_setup_provider(state, &userdev);
316 /* Process written event */
317 if (uio->uio_resid % sizeof(struct input_event) != 0) {
318 debugf(state, "write size not multiple of "
319 "struct input_event size");
323 while (ret == 0 && uio->uio_resid > 0) {
324 uiomove(&event, sizeof(struct input_event), uio);
325 ret = evdev_push_event(state->ucs_evdev, event.type,
326 event.code, event.value);
330 UINPUT_UNLOCK(state);
336 uinput_setup_dev(struct uinput_cdev_state *state, struct input_id *id,
337 char *name, uint32_t ff_effects_max)
343 evdev_set_name(state->ucs_evdev, name);
344 evdev_set_id(state->ucs_evdev, id->bustype, id->vendor, id->product,
346 state->ucs_state = UINPUT_CONFIGURED;
352 uinput_setup_provider(struct uinput_cdev_state *state,
353 struct uinput_user_dev *udev)
355 struct input_absinfo absinfo;
358 debugf(state, "setup_provider called, udev=%p", udev);
360 ret = uinput_setup_dev(state, &udev->id, udev->name,
361 udev->ff_effects_max);
365 bzero(&absinfo, sizeof(struct input_absinfo));
366 for (i = 0; i < ABS_CNT; i++) {
367 if (!bit_test(state->ucs_evdev->ev_abs_flags, i))
370 absinfo.minimum = udev->absmin[i];
371 absinfo.maximum = udev->absmax[i];
372 absinfo.fuzz = udev->absfuzz[i];
373 absinfo.flat = udev->absflat[i];
374 evdev_set_absinfo(state->ucs_evdev, i, &absinfo);
381 uinput_poll(struct cdev *dev, int events, struct thread *td)
383 struct uinput_cdev_state *state;
386 if (devfs_get_cdevpriv((void **)&state) != 0)
389 debugf(state, "poll by thread %d", td->td_tid);
391 /* Always allow write */
392 if (events & (POLLOUT | POLLWRNORM))
393 revents |= (events & (POLLOUT | POLLWRNORM));
395 if (events & (POLLIN | POLLRDNORM)) {
397 if (!UINPUT_EMPTYQ(state))
398 revents = events & (POLLIN | POLLRDNORM);
400 state->ucs_selected = true;
401 selrecord(td, &state->ucs_selp);
403 UINPUT_UNLOCK(state);
410 uinput_kqfilter(struct cdev *dev, struct knote *kn)
412 struct uinput_cdev_state *state;
415 ret = devfs_get_cdevpriv((void **)&state);
419 switch(kn->kn_filter) {
421 kn->kn_fop = &uinput_filterops;
426 kn->kn_hook = (caddr_t)state;
428 knlist_add(&state->ucs_selp.si_note, kn, 0);
433 uinput_kqread(struct knote *kn, long hint)
435 struct uinput_cdev_state *state;
438 state = (struct uinput_cdev_state *)kn->kn_hook;
440 UINPUT_LOCK_ASSERT(state);
442 ret = !UINPUT_EMPTYQ(state);
447 uinput_kqdetach(struct knote *kn)
449 struct uinput_cdev_state *state;
451 state = (struct uinput_cdev_state *)kn->kn_hook;
452 knlist_remove(&state->ucs_selp.si_note, kn, 0);
456 uinput_notify(struct uinput_cdev_state *state)
459 UINPUT_LOCK_ASSERT(state);
461 if (state->ucs_blocked) {
462 state->ucs_blocked = false;
465 if (state->ucs_selected) {
466 state->ucs_selected = false;
467 selwakeup(&state->ucs_selp);
469 KNOTE_LOCKED(&state->ucs_selp.si_note, 0);
473 uinput_ioctl_sub(struct uinput_cdev_state *state, u_long cmd, caddr_t data)
475 struct uinput_setup *us;
476 struct uinput_abs_setup *uabs;
477 int ret, len, intdata;
480 UINPUT_LOCK_ASSERT(state);
482 len = IOCPARM_LEN(cmd);
483 if ((cmd & IOC_DIRMASK) == IOC_VOID && len == sizeof(int))
484 intdata = *(int *)data;
486 switch (IOCBASECMD(cmd)) {
487 case UI_GET_SYSNAME(0):
488 if (state->ucs_state != UINPUT_RUNNING)
492 snprintf(data, len, "event%d", state->ucs_evdev->ev_unit);
498 if (state->ucs_state != UINPUT_CONFIGURED)
501 evdev_set_methods(state->ucs_evdev, state, &uinput_ev_methods);
502 evdev_set_flag(state->ucs_evdev, EVDEV_FLAG_SOFTREPEAT);
503 ret = evdev_register(state->ucs_evdev);
505 state->ucs_state = UINPUT_RUNNING;
509 if (state->ucs_state != UINPUT_RUNNING)
512 evdev_unregister(state->ucs_evdev);
513 bzero(state->ucs_evdev, sizeof(struct evdev_dev));
514 state->ucs_state = UINPUT_NEW;
518 if (state->ucs_state == UINPUT_RUNNING)
521 us = (struct uinput_setup *)data;
522 return (uinput_setup_dev(state, &us->id, us->name,
523 us->ff_effects_max));
526 if (state->ucs_state == UINPUT_RUNNING)
529 uabs = (struct uinput_abs_setup *)data;
530 if (uabs->code > ABS_MAX)
533 evdev_support_abs(state->ucs_evdev, uabs->code,
534 uabs->absinfo.value, uabs->absinfo.minimum,
535 uabs->absinfo.maximum, uabs->absinfo.fuzz,
536 uabs->absinfo.flat, uabs->absinfo.resolution);
540 if (state->ucs_state == UINPUT_RUNNING ||
541 intdata > EV_MAX || intdata < 0)
543 evdev_support_event(state->ucs_evdev, intdata);
547 if (state->ucs_state == UINPUT_RUNNING ||
548 intdata > KEY_MAX || intdata < 0)
550 evdev_support_key(state->ucs_evdev, intdata);
554 if (state->ucs_state == UINPUT_RUNNING ||
555 intdata > REL_MAX || intdata < 0)
557 evdev_support_rel(state->ucs_evdev, intdata);
561 if (state->ucs_state == UINPUT_RUNNING ||
562 intdata > ABS_MAX || intdata < 0)
564 evdev_set_abs_bit(state->ucs_evdev, intdata);
568 if (state->ucs_state == UINPUT_RUNNING ||
569 intdata > MSC_MAX || intdata < 0)
571 evdev_support_msc(state->ucs_evdev, intdata);
575 if (state->ucs_state == UINPUT_RUNNING ||
576 intdata > LED_MAX || intdata < 0)
578 evdev_support_led(state->ucs_evdev, intdata);
582 if (state->ucs_state == UINPUT_RUNNING ||
583 intdata > SND_MAX || intdata < 0)
585 evdev_support_snd(state->ucs_evdev, intdata);
589 if (state->ucs_state == UINPUT_RUNNING ||
590 intdata > FF_MAX || intdata < 0)
592 /* Fake unsupported ioctl */
596 if (state->ucs_state == UINPUT_RUNNING)
598 ret = copyinstr(*(void **)data, buf, sizeof(buf), NULL);
599 /* Linux returns EINVAL when string does not fit the buffer */
600 if (ret == ENAMETOOLONG)
604 evdev_set_phys(state->ucs_evdev, buf);
608 if (state->ucs_state == UINPUT_RUNNING ||
609 intdata > SW_MAX || intdata < 0)
611 evdev_support_sw(state->ucs_evdev, intdata);
615 if (state->ucs_state == UINPUT_RUNNING ||
616 intdata > INPUT_PROP_MAX || intdata < 0)
618 evdev_support_prop(state->ucs_evdev, intdata);
621 case UI_BEGIN_FF_UPLOAD:
622 case UI_END_FF_UPLOAD:
623 case UI_BEGIN_FF_ERASE:
624 case UI_END_FF_ERASE:
625 if (state->ucs_state == UINPUT_RUNNING)
627 /* Fake unsupported ioctl */
631 *(unsigned int *)data = UINPUT_VERSION;
639 uinput_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
642 struct uinput_cdev_state *state;
645 ret = devfs_get_cdevpriv((void **)&state);
649 debugf(state, "ioctl called: cmd=0x%08lx, data=%p", cmd, data);
652 ret = uinput_ioctl_sub(state, cmd, data);
653 UINPUT_UNLOCK(state);
659 uinput_cdev_create(void)
661 struct make_dev_args mda;
664 make_dev_args_init(&mda);
665 mda.mda_flags = MAKEDEV_WAITOK | MAKEDEV_CHECKNAME;
666 mda.mda_devsw = &uinput_cdevsw;
667 mda.mda_uid = UID_ROOT;
668 mda.mda_gid = GID_WHEEL;
671 ret = make_dev_s(&mda, &uinput_cdev, "uinput");
677 uinput_cdev_destroy(void)
680 destroy_dev(uinput_cdev);
686 uinput_modevent(module_t mod __unused, int cmd, void *data)
692 ret = uinput_cdev_create();
696 ret = uinput_cdev_destroy();
710 DEV_MODULE(uinput, uinput_modevent, NULL);
711 MODULE_VERSION(uinput, 1);
712 MODULE_DEPEND(uinput, evdev, 1, 1, 1);