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 #define NUM_EVENTS 8
 326
 327 static int
 328 evdev_input_device_data(int fd, uint32_t mask, void *data)
 329 {
 330         struct weston_compositor *ec;
 331         struct evdev_input_device *device = data;
 332         struct input_event ev[NUM_EVENTS], *e, *end;
 333         int len;
 334         uint32_t time = 0;
 335
 336         ec = device->master->base.compositor;
 337         if (!ec->focus)
 338                 return 1;
 339
 340         if (device->mtdev)
 341                 len = mtdev_get(device->mtdev, fd, ev, NUM_EVENTS) *
 342                       sizeof (struct input_event);
 343         else
 344                 len = read(fd, &ev, sizeof ev);
 345         if (len < 0 || len % sizeof e[0] != 0) {
 346                 /* FIXME: call device_removed when errno is ENODEV. */;
 347                 return 1;
 348         }
 349
 350         device->type = 0;
 351
 352         e = ev;
 353         end = (void *) ev + len;
 354         for (e = ev; e < end; e++) {
 355                 time = e->time.tv_sec * 1000 + e->time.tv_usec / 1000;
 356
 357                 /* we try to minimize the amount of notifications to be
 358                  * forwarded to the compositor, so we accumulate motion
 359                  * events and send as a bunch */
 360                 if (!is_motion_event(e))
 361                         evdev_flush_motion(device, time);
 362                 switch (e->type) {
 363                 case EV_REL:
 364                         evdev_process_relative_motion(device, e);
 365                         break;
 366                 case EV_ABS:
 367                         evdev_process_absolute(device, e);
 368                         break;
 369                 case EV_KEY:
 370                         evdev_process_key(device, e, time);
 371                         break;
 372                 }
 373         }
 374
 375         evdev_flush_motion(device, time);
 376
 377         return 1;
 378 }
 379
 380
 381 /* copied from udev/extras/input_id/input_id.c */
 382 /* we must use this kernel-compatible implementation */
 383 #define BITS_PER_LONG (sizeof(unsigned long) * 8)
 384 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
 385 #define OFF(x)  ((x)%BITS_PER_LONG)
 386 #define BIT(x)  (1UL<<OFF(x))
 387 #define LONG(x) ((x)/BITS_PER_LONG)
 388 #define TEST_BIT(array, bit)    ((array[LONG(bit)] >> OFF(bit)) & 1)
 389 /* end copied */
 390
 391 static int
 392 evdev_configure_device(struct evdev_input_device *device)
 393 {
 394         struct input_absinfo absinfo;
 395         unsigned long ev_bits[NBITS(EV_MAX)];
 396         unsigned long abs_bits[NBITS(ABS_MAX)];
 397         unsigned long key_bits[NBITS(KEY_MAX)];
 398         int has_key, has_abs;
 399
 400         has_key = 0;
 401         has_abs = 0;
 402
 403         ioctl(device->fd, EVIOCGBIT(0, sizeof(ev_bits)), ev_bits);
 404         if (TEST_BIT(ev_bits, EV_ABS)) {
 405                 has_abs = 1;
 406
 407                 ioctl(device->fd, EVIOCGBIT(EV_ABS, sizeof(abs_bits)),
 408                       abs_bits);
 409                 if (TEST_BIT(abs_bits, ABS_X)) {
 410                         ioctl(device->fd, EVIOCGABS(ABS_X), &absinfo);
 411                         device->abs.min_x = absinfo.minimum;
 412                         device->abs.max_x = absinfo.maximum;
 413                 }
 414                 if (TEST_BIT(abs_bits, ABS_Y)) {
 415                         ioctl(device->fd, EVIOCGABS(ABS_Y), &absinfo);
 416                         device->abs.min_y = absinfo.minimum;
 417                         device->abs.max_y = absinfo.maximum;
 418                 }
 419                 if (TEST_BIT(abs_bits, ABS_MT_SLOT)) {
 420                         device->is_mt = 1;
 421                         device->mt.slot = 0;
 422                 }
 423         }
 424         if (TEST_BIT(ev_bits, EV_KEY)) {
 425                 has_key = 1;
 426                 ioctl(device->fd, EVIOCGBIT(EV_KEY, sizeof(key_bits)),
 427                       key_bits);
 428                 if (TEST_BIT(key_bits, BTN_TOOL_FINGER) &&
 429                              !TEST_BIT(key_bits, BTN_TOOL_PEN))
 430                         device->is_touchpad = 1;
 431         }
 432
 433         /* This rule tries to catch accelerometer devices and opt out. We may
 434          * want to adjust the protocol later adding a proper event for dealing
 435          * with accelerometers and implement here accordingly */
 436         if (has_abs && !has_key)
 437                 return -1;
 438
 439         return 0;
 440 }
 441
 442 static struct evdev_input_device *
 443 evdev_input_device_create(struct evdev_input *master,
 444                           struct wl_display *display, const char *path)
 445 {
 446         struct evdev_input_device *device;
 447         struct weston_compositor *ec;
 448
 449         device = malloc(sizeof *device);
 450         if (device == NULL)
 451                 return NULL;
 452
 453         ec = master->base.compositor;
 454         device->output =
 455                 container_of(ec->output_list.next, struct weston_output, link);
 456
 457         device->master = master;
 458         device->is_touchpad = 0;
 459         device->is_mt = 0;
 460         device->mtdev = NULL;
 461         device->devnode = strdup(path);
 462         device->mt.slot = -1;
 463         device->rel.dx = 0;
 464         device->rel.dy = 0;
 465
 466         /* if O_NONBLOCK is not set, mtdev_get() blocks */
 467         device->fd = open(path, O_RDONLY | O_NONBLOCK);
 468         if (device->fd < 0)
 469                 goto err0;
 470
 471         if (evdev_configure_device(device) == -1)
 472                 goto err1;
 473
 474         if (device->is_mt) {
 475                 device->mtdev = mtdev_new_open(device->fd);
 476                 if (!device->mtdev)
 477                         fprintf(stderr, "mtdev failed to open for %s\n", path);
 478         }
 479
 480         device->source = wl_event_loop_add_fd(ec->input_loop, device->fd,
 481                                               WL_EVENT_READABLE,
 482                                               evdev_input_device_data, device);
 483         if (device->source == NULL)
 484                 goto err1;
 485
 486         wl_list_insert(master->devices_list.prev, &device->link);
 487
 488         return device;
 489
 490 err1:
 491         close(device->fd);
 492 err0:
 493         free(device->devnode);
 494         free(device);
 495         return NULL;
 496 }
 497
 498 static const char default_seat[] = "seat0";
 499
 500 static void
 501 device_added(struct udev_device *udev_device, struct evdev_input *master)
 502 {
 503         struct weston_compositor *c;
 504         const char *devnode;
 505         const char *device_seat;
 506
 507         device_seat = udev_device_get_property_value(udev_device, "ID_SEAT");
 508         if (!device_seat)
 509                 device_seat = default_seat;
 510
 511         if (strcmp(device_seat, master->seat_id))
 512                 return;
 513
 514         c = master->base.compositor;
 515         devnode = udev_device_get_devnode(udev_device);
 516         evdev_input_device_create(master, c->wl_display, devnode);
 517 }
 518
 519 static void
 520 device_removed(struct udev_device *udev_device, struct evdev_input *master)
 521 {
 522         const char *devnode = udev_device_get_devnode(udev_device);
 523         struct evdev_input_device *device, *next;
 524
 525         wl_list_for_each_safe(device, next, &master->devices_list, link) {
 526                 if (!strcmp(device->devnode, devnode)) {
 527                         wl_event_source_remove(device->source);
 528                         wl_list_remove(&device->link);
 529                         if (device->mtdev)
 530                                 mtdev_close_delete(device->mtdev);
 531                         close(device->fd);
 532                         free(device->devnode);
 533                         free(device);
 534                         break;
 535                 }
 536         }
 537 }
 538
 539 void
 540 evdev_add_devices(struct udev *udev, struct weston_input_device *input_base)
 541 {
 542         struct evdev_input *input = (struct evdev_input *) input_base;
 543         struct udev_enumerate *e;
 544         struct udev_list_entry *entry;
 545         struct udev_device *device;
 546         const char *path;
 547
 548         e = udev_enumerate_new(udev);
 549         udev_enumerate_add_match_subsystem(e, "input");
 550         udev_enumerate_scan_devices(e);
 551         udev_list_entry_foreach(entry, udev_enumerate_get_list_entry(e)) {
 552                 path = udev_list_entry_get_name(entry);
 553                 device = udev_device_new_from_syspath(udev, path);
 554
 555                 if (strncmp("event", udev_device_get_sysname(device), 5) != 0)
 556                         continue;
 557
 558                 device_added(device, input);
 559
 560                 udev_device_unref(device);
 561         }
 562         udev_enumerate_unref(e);
 563
 564         if (wl_list_empty(&input->devices_list)) {
 565                 fprintf(stderr,
 566                         "warning: no input devices on entering Weston. "
 567                         "Possible causes:\n"
 568                         "\t- no permissions to read /dev/input/event*\n"
 569                         "\t- seats misconfigured "
 570                         "(Weston backend option 'seat', "
 571                         "udev device property ID_SEAT)\n");
 572         }
 573 }
 574
 575 static int
 576 evdev_udev_handler(int fd, uint32_t mask, void *data)
 577 {
 578         struct evdev_input *master = data;
 579         struct udev_device *udev_device;
 580         const char *action;
 581
 582         udev_device = udev_monitor_receive_device(master->udev_monitor);
 583         if (!udev_device)
 584                 return 1;
 585
 586         action = udev_device_get_action(udev_device);
 587         if (action) {
 588                 if (strncmp("event", udev_device_get_sysname(udev_device), 5) != 0)
 589                         return 0;
 590
 591                 if (!strcmp(action, "add")) {
 592                         device_added(udev_device, master);
 593                 }
 594                 else if (!strcmp(action, "remove"))
 595                         device_removed(udev_device, master);
 596         }
 597         udev_device_unref(udev_device);
 598
 599         return 0;
 600 }
 601
 602 static int
 603 evdev_config_udev_monitor(struct udev *udev, struct evdev_input *master)
 604 {
 605         struct wl_event_loop *loop;
 606         struct weston_compositor *c = master->base.compositor;
 607
 608         master->udev_monitor = udev_monitor_new_from_netlink(udev, "udev");
 609         if (!master->udev_monitor) {
 610                 fprintf(stderr, "udev: failed to create the udev monitor\n");
 611                 return 0;
 612         }
 613
 614         udev_monitor_filter_add_match_subsystem_devtype(master->udev_monitor,
 615                         "input", NULL);
 616
 617         if (udev_monitor_enable_receiving(master->udev_monitor)) {
 618                 fprintf(stderr, "udev: failed to bind the udev monitor\n");
 619                 return 0;
 620         }
 621
 622         loop = wl_display_get_event_loop(c->wl_display);
 623         wl_event_loop_add_fd(loop, udev_monitor_get_fd(master->udev_monitor),
 624                              WL_EVENT_READABLE, evdev_udev_handler, master);
 625
 626         return 1;
 627 }
 628
 629 void
 630 evdev_input_create(struct weston_compositor *c, struct udev *udev,
 631                    const char *seat)
 632 {
 633         struct evdev_input *input;
 634
 635         input = malloc(sizeof *input);
 636         if (input == NULL)
 637                 return;
 638
 639         memset(input, 0, sizeof *input);
 640         weston_input_device_init(&input->base, c);
 641
 642         wl_list_init(&input->devices_list);
 643         input->seat_id = strdup(seat);
 644         if (!evdev_config_udev_monitor(udev, input)) {
 645                 free(input->seat_id);
 646                 free(input);
 647                 return;
 648         }
 649
 650         evdev_add_devices(udev, &input->base);
 651
 652         c->input_device = &input->base.input_device;
 653 }
 654
 655 void
 656 evdev_remove_devices(struct weston_input_device *input_base)
 657 {
 658         struct evdev_input *input = (struct evdev_input *) input_base;
 659         struct evdev_input_device *device, *next;
 660
 661         wl_list_for_each_safe(device, next, &input->devices_list, link) {
 662                 wl_event_source_remove(device->source);
 663                 wl_list_remove(&device->link);
 664                 close(device->fd);
 665                 free(device->devnode);
 666                 free(device);
 667         }
 668 }
 669
 670 void
 671 evdev_input_destroy(struct weston_input_device *input_base)
 672 {
 673         struct evdev_input *input = (struct evdev_input *) input_base;
 674
 675         evdev_remove_devices(input_base);
 676         wl_list_remove(&input->base.link);
 677         free(input->seat_id);
 678         free(input);
 679 }