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_lock(void *arg, int what)
151 if (what == LA_LOCKED)
152 sx_assert((struct sx*)arg, SA_XLOCKED);
154 sx_assert((struct sx*)arg, SA_UNLOCKED);
158 uinput_ev_event(struct evdev_dev *evdev, uint16_t type, uint16_t code,
161 struct uinput_cdev_state *state = evdev_get_softc(evdev);
164 evdev_push_event(evdev, type, code, value);
167 if (state->ucs_state == UINPUT_RUNNING) {
168 uinput_enqueue_event(state, type, code, value);
169 uinput_notify(state);
171 UINPUT_UNLOCK(state);
175 uinput_enqueue_event(struct uinput_cdev_state *state, uint16_t type,
176 uint16_t code, int32_t value)
180 UINPUT_LOCK_ASSERT(state);
182 head = state->ucs_buffer_head;
183 tail = (state->ucs_buffer_tail + 1) % UINPUT_BUFFER_SIZE;
185 microtime(&state->ucs_buffer[tail].time);
186 state->ucs_buffer[tail].type = type;
187 state->ucs_buffer[tail].code = code;
188 state->ucs_buffer[tail].value = value;
189 state->ucs_buffer_tail = tail;
191 /* If queue is full remove oldest event */
193 debugf(state, "state %p: buffer overflow", state);
195 head = (head + 1) % UINPUT_BUFFER_SIZE;
196 state->ucs_buffer_head = head;
201 uinput_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
203 struct uinput_cdev_state *state;
205 state = malloc(sizeof(struct uinput_cdev_state), M_EVDEV,
207 state->ucs_evdev = evdev_alloc();
209 sx_init(&state->ucs_lock, "uinput");
210 knlist_init(&state->ucs_selp.si_note, &state->ucs_lock, uinput_knllock,
211 uinput_knlunlock, uinput_knl_assert_lock);
213 devfs_set_cdevpriv(state, uinput_dtor);
218 uinput_dtor(void *data)
220 struct uinput_cdev_state *state = (struct uinput_cdev_state *)data;
222 evdev_free(state->ucs_evdev);
224 knlist_clear(&state->ucs_selp.si_note, 0);
225 seldrain(&state->ucs_selp);
226 knlist_destroy(&state->ucs_selp.si_note);
227 sx_destroy(&state->ucs_lock);
232 uinput_read(struct cdev *dev, struct uio *uio, int ioflag)
234 struct uinput_cdev_state *state;
235 struct input_event *event;
238 ret = devfs_get_cdevpriv((void **)&state);
242 debugf(state, "read %zd bytes by thread %d", uio->uio_resid,
243 uio->uio_td->td_tid);
245 /* Zero-sized reads are allowed for error checking */
246 if (uio->uio_resid != 0 && uio->uio_resid < sizeof(struct input_event))
249 remaining = uio->uio_resid / sizeof(struct input_event);
253 if (state->ucs_state != UINPUT_RUNNING)
256 if (ret == 0 && UINPUT_EMPTYQ(state)) {
257 if (ioflag & O_NONBLOCK)
260 if (remaining != 0) {
261 state->ucs_blocked = true;
262 ret = sx_sleep(state, &state->ucs_lock,
263 PCATCH, "uiread", 0);
268 while (ret == 0 && !UINPUT_EMPTYQ(state) && remaining > 0) {
269 event = &state->ucs_buffer[state->ucs_buffer_head];
270 state->ucs_buffer_head = (state->ucs_buffer_head + 1) %
273 ret = uiomove(event, sizeof(struct input_event), uio);
276 UINPUT_UNLOCK(state);
282 uinput_write(struct cdev *dev, struct uio *uio, int ioflag)
284 struct uinput_cdev_state *state;
285 struct uinput_user_dev userdev;
286 struct input_event event;
289 ret = devfs_get_cdevpriv((void **)&state);
293 debugf(state, "write %zd bytes by thread %d", uio->uio_resid,
294 uio->uio_td->td_tid);
298 if (state->ucs_state != UINPUT_RUNNING) {
299 /* Process written struct uinput_user_dev */
300 if (uio->uio_resid != sizeof(struct uinput_user_dev)) {
301 debugf(state, "write size not multiple of "
302 "struct uinput_user_dev size");
305 ret = uiomove(&userdev, sizeof(struct uinput_user_dev),
308 uinput_setup_provider(state, &userdev);
311 /* Process written event */
312 if (uio->uio_resid % sizeof(struct input_event) != 0) {
313 debugf(state, "write size not multiple of "
314 "struct input_event size");
318 while (ret == 0 && uio->uio_resid > 0) {
319 uiomove(&event, sizeof(struct input_event), uio);
320 ret = evdev_push_event(state->ucs_evdev, event.type,
321 event.code, event.value);
325 UINPUT_UNLOCK(state);
331 uinput_setup_dev(struct uinput_cdev_state *state, struct input_id *id,
332 char *name, uint32_t ff_effects_max)
338 evdev_set_name(state->ucs_evdev, name);
339 evdev_set_id(state->ucs_evdev, id->bustype, id->vendor, id->product,
341 state->ucs_state = UINPUT_CONFIGURED;
347 uinput_setup_provider(struct uinput_cdev_state *state,
348 struct uinput_user_dev *udev)
350 struct input_absinfo absinfo;
353 debugf(state, "setup_provider called, udev=%p", udev);
355 ret = uinput_setup_dev(state, &udev->id, udev->name,
356 udev->ff_effects_max);
360 bzero(&absinfo, sizeof(struct input_absinfo));
361 for (i = 0; i < ABS_CNT; i++) {
362 if (!bit_test(state->ucs_evdev->ev_abs_flags, i))
365 absinfo.minimum = udev->absmin[i];
366 absinfo.maximum = udev->absmax[i];
367 absinfo.fuzz = udev->absfuzz[i];
368 absinfo.flat = udev->absflat[i];
369 evdev_set_absinfo(state->ucs_evdev, i, &absinfo);
376 uinput_poll(struct cdev *dev, int events, struct thread *td)
378 struct uinput_cdev_state *state;
381 if (devfs_get_cdevpriv((void **)&state) != 0)
384 debugf(state, "poll by thread %d", td->td_tid);
386 /* Always allow write */
387 if (events & (POLLOUT | POLLWRNORM))
388 revents |= (events & (POLLOUT | POLLWRNORM));
390 if (events & (POLLIN | POLLRDNORM)) {
392 if (!UINPUT_EMPTYQ(state))
393 revents = events & (POLLIN | POLLRDNORM);
395 state->ucs_selected = true;
396 selrecord(td, &state->ucs_selp);
398 UINPUT_UNLOCK(state);
405 uinput_kqfilter(struct cdev *dev, struct knote *kn)
407 struct uinput_cdev_state *state;
410 ret = devfs_get_cdevpriv((void **)&state);
414 switch(kn->kn_filter) {
416 kn->kn_fop = &uinput_filterops;
421 kn->kn_hook = (caddr_t)state;
423 knlist_add(&state->ucs_selp.si_note, kn, 0);
428 uinput_kqread(struct knote *kn, long hint)
430 struct uinput_cdev_state *state;
433 state = (struct uinput_cdev_state *)kn->kn_hook;
435 UINPUT_LOCK_ASSERT(state);
437 ret = !UINPUT_EMPTYQ(state);
442 uinput_kqdetach(struct knote *kn)
444 struct uinput_cdev_state *state;
446 state = (struct uinput_cdev_state *)kn->kn_hook;
447 knlist_remove(&state->ucs_selp.si_note, kn, 0);
451 uinput_notify(struct uinput_cdev_state *state)
454 UINPUT_LOCK_ASSERT(state);
456 if (state->ucs_blocked) {
457 state->ucs_blocked = false;
460 if (state->ucs_selected) {
461 state->ucs_selected = false;
462 selwakeup(&state->ucs_selp);
464 KNOTE_LOCKED(&state->ucs_selp.si_note, 0);
468 uinput_ioctl_sub(struct uinput_cdev_state *state, u_long cmd, caddr_t data)
470 struct uinput_setup *us;
471 struct uinput_abs_setup *uabs;
472 int ret, len, intdata;
475 UINPUT_LOCK_ASSERT(state);
477 len = IOCPARM_LEN(cmd);
478 if ((cmd & IOC_DIRMASK) == IOC_VOID && len == sizeof(int))
479 intdata = *(int *)data;
481 switch (IOCBASECMD(cmd)) {
482 case UI_GET_SYSNAME(0):
483 if (state->ucs_state != UINPUT_RUNNING)
487 snprintf(data, len, "event%d", state->ucs_evdev->ev_unit);
493 if (state->ucs_state != UINPUT_CONFIGURED)
496 evdev_set_methods(state->ucs_evdev, state, &uinput_ev_methods);
497 evdev_set_flag(state->ucs_evdev, EVDEV_FLAG_SOFTREPEAT);
498 ret = evdev_register(state->ucs_evdev);
500 state->ucs_state = UINPUT_RUNNING;
504 if (state->ucs_state != UINPUT_RUNNING)
507 evdev_unregister(state->ucs_evdev);
508 bzero(state->ucs_evdev, sizeof(struct evdev_dev));
509 state->ucs_state = UINPUT_NEW;
513 if (state->ucs_state == UINPUT_RUNNING)
516 us = (struct uinput_setup *)data;
517 return (uinput_setup_dev(state, &us->id, us->name,
518 us->ff_effects_max));
521 if (state->ucs_state == UINPUT_RUNNING)
524 uabs = (struct uinput_abs_setup *)data;
525 if (uabs->code > ABS_MAX)
528 evdev_support_abs(state->ucs_evdev, uabs->code,
529 uabs->absinfo.value, uabs->absinfo.minimum,
530 uabs->absinfo.maximum, uabs->absinfo.fuzz,
531 uabs->absinfo.flat, uabs->absinfo.resolution);
535 if (state->ucs_state == UINPUT_RUNNING ||
536 intdata > EV_MAX || intdata < 0)
538 evdev_support_event(state->ucs_evdev, intdata);
542 if (state->ucs_state == UINPUT_RUNNING ||
543 intdata > KEY_MAX || intdata < 0)
545 evdev_support_key(state->ucs_evdev, intdata);
549 if (state->ucs_state == UINPUT_RUNNING ||
550 intdata > REL_MAX || intdata < 0)
552 evdev_support_rel(state->ucs_evdev, intdata);
556 if (state->ucs_state == UINPUT_RUNNING ||
557 intdata > ABS_MAX || intdata < 0)
559 evdev_set_abs_bit(state->ucs_evdev, intdata);
563 if (state->ucs_state == UINPUT_RUNNING ||
564 intdata > MSC_MAX || intdata < 0)
566 evdev_support_msc(state->ucs_evdev, intdata);
570 if (state->ucs_state == UINPUT_RUNNING ||
571 intdata > LED_MAX || intdata < 0)
573 evdev_support_led(state->ucs_evdev, intdata);
577 if (state->ucs_state == UINPUT_RUNNING ||
578 intdata > SND_MAX || intdata < 0)
580 evdev_support_snd(state->ucs_evdev, intdata);
584 if (state->ucs_state == UINPUT_RUNNING ||
585 intdata > FF_MAX || intdata < 0)
587 /* Fake unsupported ioctl */
591 if (state->ucs_state == UINPUT_RUNNING)
593 ret = copyinstr(*(void **)data, buf, sizeof(buf), NULL);
594 /* Linux returns EINVAL when string does not fit the buffer */
595 if (ret == ENAMETOOLONG)
599 evdev_set_phys(state->ucs_evdev, buf);
603 if (state->ucs_state == UINPUT_RUNNING)
605 ret = copyinstr(*(void **)data, buf, sizeof(buf), NULL);
608 evdev_set_serial(state->ucs_evdev, buf);
612 if (state->ucs_state == UINPUT_RUNNING ||
613 intdata > SW_MAX || intdata < 0)
615 evdev_support_sw(state->ucs_evdev, intdata);
619 if (state->ucs_state == UINPUT_RUNNING ||
620 intdata > INPUT_PROP_MAX || intdata < 0)
622 evdev_support_prop(state->ucs_evdev, intdata);
625 case UI_BEGIN_FF_UPLOAD:
626 case UI_END_FF_UPLOAD:
627 case UI_BEGIN_FF_ERASE:
628 case UI_END_FF_ERASE:
629 if (state->ucs_state == UINPUT_RUNNING)
631 /* Fake unsupported ioctl */
635 *(unsigned int *)data = UINPUT_VERSION;
643 uinput_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
646 struct uinput_cdev_state *state;
649 ret = devfs_get_cdevpriv((void **)&state);
653 debugf(state, "ioctl called: cmd=0x%08lx, data=%p", cmd, data);
656 ret = uinput_ioctl_sub(state, cmd, data);
657 UINPUT_UNLOCK(state);
663 uinput_cdev_create(void)
665 struct make_dev_args mda;
668 make_dev_args_init(&mda);
669 mda.mda_flags = MAKEDEV_WAITOK | MAKEDEV_CHECKNAME;
670 mda.mda_devsw = &uinput_cdevsw;
671 mda.mda_uid = UID_ROOT;
672 mda.mda_gid = GID_WHEEL;
675 ret = make_dev_s(&mda, &uinput_cdev, "uinput");
681 uinput_cdev_destroy(void)
684 destroy_dev(uinput_cdev);
690 uinput_modevent(module_t mod __unused, int cmd, void *data)
696 ret = uinput_cdev_create();
700 ret = uinput_cdev_destroy();
714 DEV_MODULE(uinput, uinput_modevent, NULL);
715 MODULE_VERSION(uinput, 1);
716 MODULE_DEPEND(uinput, evdev, 1, 1, 1);