evdev: fix input lag when processing input from output repaint
[profile/ivi/weston.git] / src / evdev.c
1 /*
2  * Copyright © 2010 Intel Corporation
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation for any purpose is hereby granted without fee, provided
6  * that the above copyright notice appear in all copies and that both that
7  * copyright notice and this permission notice appear in supporting
8  * documentation, and that the name of the copyright holders not be used in
9  * advertising or publicity pertaining to distribution of the software
10  * without specific, written prior permission.  The copyright holders make
11  * no representations about the suitability of this software for any
12  * purpose.  It is provided "as is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21  */
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <linux/input.h>
27 #include <unistd.h>
28 #include <fcntl.h>
29 #include <mtdev.h>
30
31 #include "compositor.h"
32 #include "evdev.h"
33
34 struct evdev_input {
35         struct weston_input_device base;
36         struct wl_list devices_list;
37         struct udev_monitor *udev_monitor;
38         char *seat_id;
39 };
40
41 #define MAX_SLOTS 16
42
43 struct evdev_input_device {
44         struct evdev_input *master;
45         struct wl_list link;
46         struct wl_event_source *source;
47         struct weston_output *output;
48         char *devnode;
49         int fd;
50         struct {
51                 int min_x, max_x, min_y, max_y;
52                 int old_x, old_y, reset_x, reset_y;
53                 int32_t x, y;
54         } abs;
55
56         struct {
57                 int slot;
58                 int32_t x[MAX_SLOTS];
59                 int32_t y[MAX_SLOTS];
60         } mt;
61         struct mtdev *mtdev;
62
63         struct {
64                 int dx, dy;
65         } rel;
66
67         int type; /* event type flags */
68
69         int is_touchpad, is_mt;
70 };
71
72 /* event type flags */
73 #define EVDEV_ABSOLUTE_MOTION           (1 << 0)
74 #define EVDEV_ABSOLUTE_MT_DOWN          (1 << 1)
75 #define EVDEV_ABSOLUTE_MT_MOTION        (1 << 2)
76 #define EVDEV_ABSOLUTE_MT_UP            (1 << 3)
77 #define EVDEV_RELATIVE_MOTION           (1 << 4)
78
79 static inline void
80 evdev_process_key(struct evdev_input_device *device,
81                         struct input_event *e, int time)
82 {
83         if (e->value == 2)
84                 return;
85
86         switch (e->code) {
87         case BTN_TOOL_PEN:
88         case BTN_TOOL_RUBBER:
89         case BTN_TOOL_BRUSH:
90         case BTN_TOOL_PENCIL:
91         case BTN_TOOL_AIRBRUSH:
92         case BTN_TOOL_FINGER:
93         case BTN_TOOL_MOUSE:
94         case BTN_TOOL_LENS:
95                 if (device->is_touchpad)
96                 {
97                         device->abs.reset_x = 1;
98                         device->abs.reset_y = 1;
99                 }
100                 break;
101         case BTN_TOUCH:
102                 /* Multitouch touchscreen devices might not send individually
103                  * button events each time a new finger is down. So we don't
104                  * send notification for such devices and we solve the button
105                  * case emulating on compositor side. */
106                 if (device->is_mt)
107                         break;
108
109                 /* Treat BTN_TOUCH from devices that only have BTN_TOUCH as
110                  * BTN_LEFT */
111                 e->code = BTN_LEFT;
112                 /* Intentional fallthrough! */
113         case BTN_LEFT:
114         case BTN_RIGHT:
115         case BTN_MIDDLE:
116         case BTN_SIDE:
117         case BTN_EXTRA:
118         case BTN_FORWARD:
119         case BTN_BACK:
120         case BTN_TASK:
121                 notify_button(&device->master->base.input_device,
122                               time, e->code, e->value);
123                 break;
124
125         default:
126                 notify_key(&device->master->base.input_device,
127                            time, e->code, e->value);
128                 break;
129         }
130 }
131
132 static void
133 evdev_process_touch(struct evdev_input_device *device,
134                     struct input_event *e)
135 {
136         const int screen_width = device->output->current->width;
137         const int screen_height = device->output->current->height;
138
139         switch (e->code) {
140         case ABS_MT_SLOT:
141                 device->mt.slot = e->value;
142                 break;
143         case ABS_MT_TRACKING_ID:
144                 if (e->value >= 0)
145                         device->type |= EVDEV_ABSOLUTE_MT_DOWN;
146                 else
147                         device->type |= EVDEV_ABSOLUTE_MT_UP;
148                 break;
149         case ABS_MT_POSITION_X:
150                 device->mt.x[device->mt.slot] =
151                         (e->value - device->abs.min_x) * screen_width /
152                         (device->abs.max_x - device->abs.min_x) +
153                         device->output->x;
154                 device->type |= EVDEV_ABSOLUTE_MT_MOTION;
155                 break;
156         case ABS_MT_POSITION_Y:
157                 device->mt.y[device->mt.slot] =
158                         (e->value - device->abs.min_y) * screen_height /
159                         (device->abs.max_y - device->abs.min_y) +
160                         device->output->y;
161                 device->type |= EVDEV_ABSOLUTE_MT_MOTION;
162                 break;
163         }
164 }
165
166 static inline void
167 evdev_process_absolute_motion(struct evdev_input_device *device,
168                               struct input_event *e)
169 {
170         const int screen_width = device->output->current->width;
171         const int screen_height = device->output->current->height;
172
173         switch (e->code) {
174         case ABS_X:
175                 device->abs.x =
176                         (e->value - device->abs.min_x) * screen_width /
177                         (device->abs.max_x - device->abs.min_x) +
178                         device->output->x;
179                 device->type |= EVDEV_ABSOLUTE_MOTION;
180                 break;
181         case ABS_Y:
182                 device->abs.y =
183                         (e->value - device->abs.min_y) * screen_height /
184                         (device->abs.max_y - device->abs.min_y) +
185                         device->output->y;
186                 device->type |= EVDEV_ABSOLUTE_MOTION;
187                 break;
188         }
189 }
190
191 static inline void
192 evdev_process_absolute_motion_touchpad(struct evdev_input_device *device,
193                                        struct input_event *e)
194 {
195         /* FIXME: Make this configurable somehow. */
196         const int touchpad_speed = 700;
197
198         switch (e->code) {
199         case ABS_X:
200                 e->value -= device->abs.min_x;
201                 if (device->abs.reset_x)
202                         device->abs.reset_x = 0;
203                 else {
204                         device->rel.dx =
205                                 (e->value - device->abs.old_x) *
206                                 touchpad_speed /
207                                 (device->abs.max_x - device->abs.min_x);
208                 }
209                 device->abs.old_x = e->value;
210                 device->type |= EVDEV_RELATIVE_MOTION;
211                 break;
212         case ABS_Y:
213                 e->value -= device->abs.min_y;
214                 if (device->abs.reset_y)
215                         device->abs.reset_y = 0;
216                 else {
217                         device->rel.dy =
218                                 (e->value - device->abs.old_y) *
219                                 touchpad_speed /
220                                 /* maybe use x size here to have the same scale? */
221                                 (device->abs.max_y - device->abs.min_y);
222                 }
223                 device->abs.old_y = e->value;
224                 device->type |= EVDEV_RELATIVE_MOTION;
225                 break;
226         }
227 }
228
229 static inline void
230 evdev_process_relative_motion(struct evdev_input_device *device,
231                               struct input_event *e)
232 {
233         switch (e->code) {
234         case REL_X:
235                 device->rel.dx += e->value;
236                 device->type |= EVDEV_RELATIVE_MOTION;
237                 break;
238         case REL_Y:
239                 device->rel.dy += e->value;
240                 device->type |= EVDEV_RELATIVE_MOTION;
241                 break;
242         }
243 }
244
245 static inline void
246 evdev_process_absolute(struct evdev_input_device *device,
247                        struct input_event *e)
248 {
249         if (device->is_touchpad) {
250                 evdev_process_absolute_motion_touchpad(device, e);
251         } else if (device->is_mt) {
252                 evdev_process_touch(device, e);
253         } else {
254                 evdev_process_absolute_motion(device, e);
255         }
256 }
257
258 static int
259 is_motion_event(struct input_event *e)
260 {
261         switch (e->type) {
262         case EV_REL:
263                 switch (e->code) {
264                 case REL_X:
265                 case REL_Y:
266                         return 1;
267                 }
268         case EV_ABS:
269                 switch (e->code) {
270                 case ABS_X:
271                 case ABS_Y:
272                 case ABS_MT_POSITION_X:
273                 case ABS_MT_POSITION_Y:
274                         return 1;
275                 }
276         }
277
278         return 0;
279 }
280
281 static void
282 evdev_flush_motion(struct evdev_input_device *device, uint32_t time)
283 {
284         struct wl_input_device *master = &device->master->base.input_device;
285
286         if (!device->type)
287                 return;
288
289         if (device->type & EVDEV_RELATIVE_MOTION) {
290                 notify_motion(master, time,
291                               master->x + device->rel.dx,
292                               master->y + device->rel.dy);
293                 device->type &= ~EVDEV_RELATIVE_MOTION;
294                 device->rel.dx = 0;
295                 device->rel.dy = 0;
296         }
297         if (device->type & EVDEV_ABSOLUTE_MT_DOWN) {
298                 notify_touch(master, time,
299                              device->mt.slot,
300                              device->mt.x[device->mt.slot],
301                              device->mt.y[device->mt.slot],
302                              WL_INPUT_DEVICE_TOUCH_DOWN);
303                 device->type &= ~EVDEV_ABSOLUTE_MT_DOWN;
304                 device->type &= ~EVDEV_ABSOLUTE_MT_MOTION;
305         }
306         if (device->type & EVDEV_ABSOLUTE_MT_MOTION) {
307                 notify_touch(master, time,
308                              device->mt.slot,
309                              device->mt.x[device->mt.slot],
310                              device->mt.y[device->mt.slot],
311                              WL_INPUT_DEVICE_TOUCH_MOTION);
312                 device->type &= ~EVDEV_ABSOLUTE_MT_DOWN;
313                 device->type &= ~EVDEV_ABSOLUTE_MT_MOTION;
314         }
315         if (device->type & EVDEV_ABSOLUTE_MT_UP) {
316                 notify_touch(master, time, device->mt.slot, 0, 0,
317                              WL_INPUT_DEVICE_TOUCH_UP);
318                 device->type &= ~EVDEV_ABSOLUTE_MT_UP;
319         }
320         if (device->type & EVDEV_ABSOLUTE_MOTION) {
321                 notify_motion(master, time, device->abs.x, device->abs.y);
322                 device->type &= ~EVDEV_ABSOLUTE_MOTION;
323         }
324 }
325
326 static void
327 evdev_process_events(struct evdev_input_device *device,
328                      struct input_event *ev, int count)
329 {
330         struct input_event *e, *end;
331         uint32_t time = 0;
332
333         device->type = 0;
334
335         e = ev;
336         end = e + count;
337         for (e = ev; e < end; e++) {
338                 time = e->time.tv_sec * 1000 + e->time.tv_usec / 1000;
339
340                 /* we try to minimize the amount of notifications to be
341                  * forwarded to the compositor, so we accumulate motion
342                  * events and send as a bunch */
343                 if (!is_motion_event(e))
344                         evdev_flush_motion(device, time);
345                 switch (e->type) {
346                 case EV_REL:
347                         evdev_process_relative_motion(device, e);
348                         break;
349                 case EV_ABS:
350                         evdev_process_absolute(device, e);
351                         break;
352                 case EV_KEY:
353                         evdev_process_key(device, e, time);
354                         break;
355                 }
356         }
357
358         evdev_flush_motion(device, time);
359 }
360
361 static int
362 evdev_input_device_data(int fd, uint32_t mask, void *data)
363 {
364         struct weston_compositor *ec;
365         struct evdev_input_device *device = data;
366         struct input_event ev[32];
367         int len;
368
369         ec = device->master->base.compositor;
370         if (!ec->focus)
371                 return 1;
372
373         /* If the compositor is repainting, this function is called only once
374          * per frame and we have to process all the events available on the
375          * fd, otherwise there will be input lag. */
376         do {
377                 if (device->mtdev)
378                         len = mtdev_get(device->mtdev, fd, ev,
379                                         ARRAY_LENGTH(ev)) *
380                                 sizeof (struct input_event);
381                 else
382                         len = read(fd, &ev, sizeof ev);
383
384                 if (len < 0 || len % sizeof ev[0] != 0) {
385                         /* FIXME: call device_removed when errno is ENODEV. */
386                         return 1;
387                 }
388
389                 evdev_process_events(device, ev, len / sizeof ev[0]);
390
391         } while (len > 0);
392
393         return 1;
394 }
395
396 /* copied from udev/extras/input_id/input_id.c */
397 /* we must use this kernel-compatible implementation */
398 #define BITS_PER_LONG (sizeof(unsigned long) * 8)
399 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
400 #define OFF(x)  ((x)%BITS_PER_LONG)
401 #define BIT(x)  (1UL<<OFF(x))
402 #define LONG(x) ((x)/BITS_PER_LONG)
403 #define TEST_BIT(array, bit)    ((array[LONG(bit)] >> OFF(bit)) & 1)
404 /* end copied */
405
406 static int
407 evdev_configure_device(struct evdev_input_device *device)
408 {
409         struct input_absinfo absinfo;
410         unsigned long ev_bits[NBITS(EV_MAX)];
411         unsigned long abs_bits[NBITS(ABS_MAX)];
412         unsigned long key_bits[NBITS(KEY_MAX)];
413         int has_key, has_abs;
414
415         has_key = 0;
416         has_abs = 0;
417
418         ioctl(device->fd, EVIOCGBIT(0, sizeof(ev_bits)), ev_bits);
419         if (TEST_BIT(ev_bits, EV_ABS)) {
420                 has_abs = 1;
421
422                 ioctl(device->fd, EVIOCGBIT(EV_ABS, sizeof(abs_bits)),
423                       abs_bits);
424                 if (TEST_BIT(abs_bits, ABS_X)) {
425                         ioctl(device->fd, EVIOCGABS(ABS_X), &absinfo);
426                         device->abs.min_x = absinfo.minimum;
427                         device->abs.max_x = absinfo.maximum;
428                 }
429                 if (TEST_BIT(abs_bits, ABS_Y)) {
430                         ioctl(device->fd, EVIOCGABS(ABS_Y), &absinfo);
431                         device->abs.min_y = absinfo.minimum;
432                         device->abs.max_y = absinfo.maximum;
433                 }
434                 if (TEST_BIT(abs_bits, ABS_MT_SLOT)) {
435                         device->is_mt = 1;
436                         device->mt.slot = 0;
437                 }
438         }
439         if (TEST_BIT(ev_bits, EV_KEY)) {
440                 has_key = 1;
441                 ioctl(device->fd, EVIOCGBIT(EV_KEY, sizeof(key_bits)),
442                       key_bits);
443                 if (TEST_BIT(key_bits, BTN_TOOL_FINGER) &&
444                              !TEST_BIT(key_bits, BTN_TOOL_PEN))
445                         device->is_touchpad = 1;
446         }
447
448         /* This rule tries to catch accelerometer devices and opt out. We may
449          * want to adjust the protocol later adding a proper event for dealing
450          * with accelerometers and implement here accordingly */
451         if (has_abs && !has_key)
452                 return -1;
453
454         return 0;
455 }
456
457 static struct evdev_input_device *
458 evdev_input_device_create(struct evdev_input *master,
459                           struct wl_display *display, const char *path)
460 {
461         struct evdev_input_device *device;
462         struct weston_compositor *ec;
463
464         device = malloc(sizeof *device);
465         if (device == NULL)
466                 return NULL;
467
468         ec = master->base.compositor;
469         device->output =
470                 container_of(ec->output_list.next, struct weston_output, link);
471
472         device->master = master;
473         device->is_touchpad = 0;
474         device->is_mt = 0;
475         device->mtdev = NULL;
476         device->devnode = strdup(path);
477         device->mt.slot = -1;
478         device->rel.dx = 0;
479         device->rel.dy = 0;
480
481         /* Use non-blocking mode so that we can loop on read on
482          * evdev_input_device_data() until all events on the fd are
483          * read.  mtdev_get() also expects this. */
484         device->fd = open(path, O_RDONLY | O_NONBLOCK);
485         if (device->fd < 0)
486                 goto err0;
487
488         if (evdev_configure_device(device) == -1)
489                 goto err1;
490
491         if (device->is_mt) {
492                 device->mtdev = mtdev_new_open(device->fd);
493                 if (!device->mtdev)
494                         fprintf(stderr, "mtdev failed to open for %s\n", path);
495         }
496
497         device->source = wl_event_loop_add_fd(ec->input_loop, device->fd,
498                                               WL_EVENT_READABLE,
499                                               evdev_input_device_data, device);
500         if (device->source == NULL)
501                 goto err1;
502
503         wl_list_insert(master->devices_list.prev, &device->link);
504
505         return device;
506
507 err1:
508         close(device->fd);
509 err0:
510         free(device->devnode);
511         free(device);
512         return NULL;
513 }
514
515 static const char default_seat[] = "seat0";
516
517 static void
518 device_added(struct udev_device *udev_device, struct evdev_input *master)
519 {
520         struct weston_compositor *c;
521         const char *devnode;
522         const char *device_seat;
523
524         device_seat = udev_device_get_property_value(udev_device, "ID_SEAT");
525         if (!device_seat)
526                 device_seat = default_seat;
527
528         if (strcmp(device_seat, master->seat_id))
529                 return;
530
531         c = master->base.compositor;
532         devnode = udev_device_get_devnode(udev_device);
533         evdev_input_device_create(master, c->wl_display, devnode);
534 }
535
536 static void
537 device_removed(struct udev_device *udev_device, struct evdev_input *master)
538 {
539         const char *devnode = udev_device_get_devnode(udev_device);
540         struct evdev_input_device *device, *next;
541
542         wl_list_for_each_safe(device, next, &master->devices_list, link) {
543                 if (!strcmp(device->devnode, devnode)) {
544                         wl_event_source_remove(device->source);
545                         wl_list_remove(&device->link);
546                         if (device->mtdev)
547                                 mtdev_close_delete(device->mtdev);
548                         close(device->fd);
549                         free(device->devnode);
550                         free(device);
551                         break;
552                 }
553         }
554 }
555
556 void
557 evdev_add_devices(struct udev *udev, struct weston_input_device *input_base)
558 {
559         struct evdev_input *input = (struct evdev_input *) input_base;
560         struct udev_enumerate *e;
561         struct udev_list_entry *entry;
562         struct udev_device *device;
563         const char *path;
564
565         e = udev_enumerate_new(udev);
566         udev_enumerate_add_match_subsystem(e, "input");
567         udev_enumerate_scan_devices(e);
568         udev_list_entry_foreach(entry, udev_enumerate_get_list_entry(e)) {
569                 path = udev_list_entry_get_name(entry);
570                 device = udev_device_new_from_syspath(udev, path);
571
572                 if (strncmp("event", udev_device_get_sysname(device), 5) != 0)
573                         continue;
574
575                 device_added(device, input);
576
577                 udev_device_unref(device);
578         }
579         udev_enumerate_unref(e);
580
581         if (wl_list_empty(&input->devices_list)) {
582                 fprintf(stderr,
583                         "warning: no input devices on entering Weston. "
584                         "Possible causes:\n"
585                         "\t- no permissions to read /dev/input/event*\n"
586                         "\t- seats misconfigured "
587                         "(Weston backend option 'seat', "
588                         "udev device property ID_SEAT)\n");
589         }
590 }
591
592 static int
593 evdev_udev_handler(int fd, uint32_t mask, void *data)
594 {
595         struct evdev_input *master = data;
596         struct udev_device *udev_device;
597         const char *action;
598
599         udev_device = udev_monitor_receive_device(master->udev_monitor);
600         if (!udev_device)
601                 return 1;
602
603         action = udev_device_get_action(udev_device);
604         if (action) {
605                 if (strncmp("event", udev_device_get_sysname(udev_device), 5) != 0)
606                         return 0;
607
608                 if (!strcmp(action, "add")) {
609                         device_added(udev_device, master);
610                 }
611                 else if (!strcmp(action, "remove"))
612                         device_removed(udev_device, master);
613         }
614         udev_device_unref(udev_device);
615
616         return 0;
617 }
618
619 static int
620 evdev_config_udev_monitor(struct udev *udev, struct evdev_input *master)
621 {
622         struct wl_event_loop *loop;
623         struct weston_compositor *c = master->base.compositor;
624
625         master->udev_monitor = udev_monitor_new_from_netlink(udev, "udev");
626         if (!master->udev_monitor) {
627                 fprintf(stderr, "udev: failed to create the udev monitor\n");
628                 return 0;
629         }
630
631         udev_monitor_filter_add_match_subsystem_devtype(master->udev_monitor,
632                         "input", NULL);
633
634         if (udev_monitor_enable_receiving(master->udev_monitor)) {
635                 fprintf(stderr, "udev: failed to bind the udev monitor\n");
636                 return 0;
637         }
638
639         loop = wl_display_get_event_loop(c->wl_display);
640         wl_event_loop_add_fd(loop, udev_monitor_get_fd(master->udev_monitor),
641                              WL_EVENT_READABLE, evdev_udev_handler, master);
642
643         return 1;
644 }
645
646 void
647 evdev_input_create(struct weston_compositor *c, struct udev *udev,
648                    const char *seat)
649 {
650         struct evdev_input *input;
651
652         input = malloc(sizeof *input);
653         if (input == NULL)
654                 return;
655
656         memset(input, 0, sizeof *input);
657         weston_input_device_init(&input->base, c);
658
659         wl_list_init(&input->devices_list);
660         input->seat_id = strdup(seat);
661         if (!evdev_config_udev_monitor(udev, input)) {
662                 free(input->seat_id);
663                 free(input);
664                 return;
665         }
666
667         evdev_add_devices(udev, &input->base);
668
669         c->input_device = &input->base.input_device;
670 }
671
672 void
673 evdev_remove_devices(struct weston_input_device *input_base)
674 {
675         struct evdev_input *input = (struct evdev_input *) input_base;
676         struct evdev_input_device *device, *next;
677
678         wl_list_for_each_safe(device, next, &input->devices_list, link) {
679                 wl_event_source_remove(device->source);
680                 wl_list_remove(&device->link);
681                 close(device->fd);
682                 free(device->devnode);
683                 free(device);
684         }
685 }
686
687 void
688 evdev_input_destroy(struct weston_input_device *input_base)
689 {
690         struct evdev_input *input = (struct evdev_input *) input_base;
691
692         evdev_remove_devices(input_base);
693         wl_list_remove(&input->base.link);
694         free(input->seat_id);
695         free(input);
696 }