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 <stdlib.h>
  24 #include <string.h>
  25 #include <linux/input.h>
  26 #include <unistd.h>
  27 #include <fcntl.h>
  28 #include <mtdev.h>
  29
  30 #include "compositor.h"
  31 #include "evdev.h"
  32
  33 #define DEFAULT_AXIS_STEP_DISTANCE wl_fixed_from_int(10)
  34
  35 void
  36 evdev_led_update(struct evdev_device *device, enum weston_led leds)
  37 {
  38         static const struct {
  39                 enum weston_led weston;
  40                 int evdev;
  41         } map[] = {
  42                 { LED_NUM_LOCK, LED_NUML },
  43                 { LED_CAPS_LOCK, LED_CAPSL },
  44                 { LED_SCROLL_LOCK, LED_SCROLLL },
  45         };
  46         struct input_event ev[ARRAY_LENGTH(map)];
  47         unsigned int i;
  48
  49         if (!device->caps & EVDEV_KEYBOARD)
  50                 return;
  51
  52         memset(ev, 0, sizeof(ev));
  53         for (i = 0; i < ARRAY_LENGTH(map); i++) {
  54                 ev[i].type = EV_LED;
  55                 ev[i].code = map[i].evdev;
  56                 ev[i].value = !!(leds & map[i].weston);
  57         }
  58
  59         i = write(device->fd, ev, sizeof ev);
  60         (void)i; /* no, we really don't care about the return value */
  61 }
  62
  63 static inline void
  64 evdev_process_key(struct evdev_device *device, struct input_event *e, int time)
  65 {
  66         if (e->value == 2)
  67                 return;
  68
  69         switch (e->code) {
  70         case BTN_LEFT:
  71         case BTN_RIGHT:
  72         case BTN_MIDDLE:
  73         case BTN_SIDE:
  74         case BTN_EXTRA:
  75         case BTN_FORWARD:
  76         case BTN_BACK:
  77         case BTN_TASK:
  78                 notify_button(device->seat,
  79                               time, e->code,
  80                               e->value ? WL_POINTER_BUTTON_STATE_PRESSED :
  81                                          WL_POINTER_BUTTON_STATE_RELEASED);
  82                 break;
  83
  84         default:
  85                 notify_key(device->seat,
  86                            time, e->code,
  87                            e->value ? WL_KEYBOARD_KEY_STATE_PRESSED :
  88                                       WL_KEYBOARD_KEY_STATE_RELEASED,
  89                            STATE_UPDATE_AUTOMATIC);
  90                 break;
  91         }
  92 }
  93
  94 static void
  95 evdev_process_touch(struct evdev_device *device, struct input_event *e)
  96 {
  97         const int screen_width = device->output->current->width;
  98         const int screen_height = device->output->current->height;
  99
 100         switch (e->code) {
 101         case ABS_MT_SLOT:
 102                 device->mt.slot = e->value;
 103                 break;
 104         case ABS_MT_TRACKING_ID:
 105                 if (e->value >= 0)
 106                         device->pending_events |= EVDEV_ABSOLUTE_MT_DOWN;
 107                 else
 108                         device->pending_events |= EVDEV_ABSOLUTE_MT_UP;
 109                 break;
 110         case ABS_MT_POSITION_X:
 111                 device->mt.x[device->mt.slot] =
 112                         (e->value - device->abs.min_x) * screen_width /
 113                         (device->abs.max_x - device->abs.min_x) +
 114                         device->output->x;
 115                 device->pending_events |= EVDEV_ABSOLUTE_MT_MOTION;
 116                 break;
 117         case ABS_MT_POSITION_Y:
 118                 device->mt.y[device->mt.slot] =
 119                         (e->value - device->abs.min_y) * screen_height /
 120                         (device->abs.max_y - device->abs.min_y) +
 121                         device->output->y;
 122                 device->pending_events |= EVDEV_ABSOLUTE_MT_MOTION;
 123                 break;
 124         }
 125 }
 126
 127 static inline void
 128 evdev_process_absolute_motion(struct evdev_device *device,
 129                               struct input_event *e)
 130 {
 131         const int screen_width = device->output->current->width;
 132         const int screen_height = device->output->current->height;
 133
 134         switch (e->code) {
 135         case ABS_X:
 136                 device->abs.x =
 137                         (e->value - device->abs.min_x) * screen_width /
 138                         (device->abs.max_x - device->abs.min_x) +
 139                         device->output->x;
 140                 device->pending_events |= EVDEV_ABSOLUTE_MOTION;
 141                 break;
 142         case ABS_Y:
 143                 device->abs.y =
 144                         (e->value - device->abs.min_y) * screen_height /
 145                         (device->abs.max_y - device->abs.min_y) +
 146                         device->output->y;
 147                 device->pending_events |= EVDEV_ABSOLUTE_MOTION;
 148                 break;
 149         }
 150 }
 151
 152 static inline void
 153 evdev_process_relative(struct evdev_device *device,
 154                        struct input_event *e, uint32_t time)
 155 {
 156         switch (e->code) {
 157         case REL_X:
 158                 device->rel.dx += wl_fixed_from_int(e->value);
 159                 device->pending_events |= EVDEV_RELATIVE_MOTION;
 160                 break;
 161         case REL_Y:
 162                 device->rel.dy += wl_fixed_from_int(e->value);
 163                 device->pending_events |= EVDEV_RELATIVE_MOTION;
 164                 break;
 165         case REL_WHEEL:
 166                 switch (e->value) {
 167                 case -1:
 168                         /* Scroll down */
 169                 case 1:
 170                         /* Scroll up */
 171                         notify_axis(device->seat,
 172                                     time,
 173                                     WL_POINTER_AXIS_VERTICAL_SCROLL,
 174                                     -1 * e->value * DEFAULT_AXIS_STEP_DISTANCE);
 175                         break;
 176                 default:
 177                         break;
 178                 }
 179                 break;
 180         case REL_HWHEEL:
 181                 switch (e->value) {
 182                 case -1:
 183                         /* Scroll left */
 184                 case 1:
 185                         /* Scroll right */
 186                         notify_axis(device->seat,
 187                                     time,
 188                                     WL_POINTER_AXIS_HORIZONTAL_SCROLL,
 189                                     e->value * DEFAULT_AXIS_STEP_DISTANCE);
 190                         break;
 191                 default:
 192                         break;
 193
 194                 }
 195         }
 196 }
 197
 198 static inline void
 199 evdev_process_absolute(struct evdev_device *device, struct input_event *e)
 200 {
 201         if (device->is_mt) {
 202                 evdev_process_touch(device, e);
 203         } else {
 204                 evdev_process_absolute_motion(device, e);
 205         }
 206 }
 207
 208 static int
 209 is_motion_event(struct input_event *e)
 210 {
 211         switch (e->type) {
 212         case EV_REL:
 213                 switch (e->code) {
 214                 case REL_X:
 215                 case REL_Y:
 216                         return 1;
 217                 }
 218                 break;
 219         case EV_ABS:
 220                 switch (e->code) {
 221                 case ABS_X:
 222                 case ABS_Y:
 223                 case ABS_MT_POSITION_X:
 224                 case ABS_MT_POSITION_Y:
 225                         return 1;
 226                 }
 227         }
 228
 229         return 0;
 230 }
 231
 232 static void
 233 transform_absolute(struct evdev_device *device)
 234 {
 235         if (!device->abs.apply_calibration)
 236                 return;
 237
 238         device->abs.x = device->abs.x * device->abs.calibration[0] +
 239                         device->abs.y * device->abs.calibration[1] +
 240                         device->abs.calibration[2];
 241
 242         device->abs.y = device->abs.x * device->abs.calibration[3] +
 243                         device->abs.y * device->abs.calibration[4] +
 244                         device->abs.calibration[5];
 245 }
 246
 247 static void
 248 evdev_flush_motion(struct evdev_device *device, uint32_t time)
 249 {
 250         struct weston_seat *master = device->seat;
 251
 252         if (!(device->pending_events & EVDEV_SYN))
 253                 return;
 254
 255         device->pending_events &= ~EVDEV_SYN;
 256         if (device->pending_events & EVDEV_RELATIVE_MOTION) {
 257                 notify_motion(master, time,
 258                               master->seat.pointer->x + device->rel.dx,
 259                               master->seat.pointer->y + device->rel.dy);
 260                 device->pending_events &= ~EVDEV_RELATIVE_MOTION;
 261                 device->rel.dx = 0;
 262                 device->rel.dy = 0;
 263         }
 264         if (device->pending_events & EVDEV_ABSOLUTE_MT_DOWN) {
 265                 notify_touch(master, time,
 266                              device->mt.slot,
 267                              wl_fixed_from_int(device->mt.x[device->mt.slot]),
 268                              wl_fixed_from_int(device->mt.y[device->mt.slot]),
 269                              WL_TOUCH_DOWN);
 270                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_DOWN;
 271                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_MOTION;
 272         }
 273         if (device->pending_events & EVDEV_ABSOLUTE_MT_MOTION) {
 274                 notify_touch(master, time,
 275                              device->mt.slot,
 276                              wl_fixed_from_int(device->mt.x[device->mt.slot]),
 277                              wl_fixed_from_int(device->mt.y[device->mt.slot]),
 278                              WL_TOUCH_MOTION);
 279                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_DOWN;
 280                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_MOTION;
 281         }
 282         if (device->pending_events & EVDEV_ABSOLUTE_MT_UP) {
 283                 notify_touch(master, time, device->mt.slot, 0, 0,
 284                              WL_TOUCH_UP);
 285                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_UP;
 286         }
 287         if (device->pending_events & EVDEV_ABSOLUTE_MOTION) {
 288                 transform_absolute(device);
 289                 notify_motion(master, time,
 290                               wl_fixed_from_int(device->abs.x),
 291                               wl_fixed_from_int(device->abs.y));
 292                 device->pending_events &= ~EVDEV_ABSOLUTE_MOTION;
 293         }
 294 }
 295
 296 static void
 297 fallback_process(struct evdev_dispatch *dispatch,
 298                  struct evdev_device *device,
 299                  struct input_event *event,
 300                  uint32_t time)
 301 {
 302         switch (event->type) {
 303         case EV_REL:
 304                 evdev_process_relative(device, event, time);
 305                 break;
 306         case EV_ABS:
 307                 evdev_process_absolute(device, event);
 308                 break;
 309         case EV_KEY:
 310                 evdev_process_key(device, event, time);
 311                 break;
 312         case EV_SYN:
 313                 device->pending_events |= EVDEV_SYN;
 314                 break;
 315         }
 316 }
 317
 318 static void
 319 fallback_destroy(struct evdev_dispatch *dispatch)
 320 {
 321         free(dispatch);
 322 }
 323
 324 struct evdev_dispatch_interface fallback_interface = {
 325         fallback_process,
 326         fallback_destroy
 327 };
 328
 329 static struct evdev_dispatch *
 330 fallback_dispatch_create(void)
 331 {
 332         struct evdev_dispatch *dispatch = malloc(sizeof *dispatch);
 333         if (dispatch == NULL)
 334                 return NULL;
 335
 336         dispatch->interface = &fallback_interface;
 337
 338         return dispatch;
 339 }
 340
 341 static void
 342 evdev_process_events(struct evdev_device *device,
 343                      struct input_event *ev, int count)
 344 {
 345         struct evdev_dispatch *dispatch = device->dispatch;
 346         struct input_event *e, *end;
 347         uint32_t time = 0;
 348
 349         device->pending_events = 0;
 350
 351         e = ev;
 352         end = e + count;
 353         for (e = ev; e < end; e++) {
 354                 time = e->time.tv_sec * 1000 + e->time.tv_usec / 1000;
 355
 356                 /* we try to minimize the amount of notifications to be
 357                  * forwarded to the compositor, so we accumulate motion
 358                  * events and send as a bunch */
 359                 if (!is_motion_event(e))
 360                         evdev_flush_motion(device, time);
 361
 362                 dispatch->interface->process(dispatch, device, e, time);
 363         }
 364
 365         evdev_flush_motion(device, time);
 366 }
 367
 368 static int
 369 evdev_device_data(int fd, uint32_t mask, void *data)
 370 {
 371         struct weston_compositor *ec;
 372         struct evdev_device *device = data;
 373         struct input_event ev[32];
 374         int len;
 375
 376         ec = device->seat->compositor;
 377         if (!ec->focus)
 378                 return 1;
 379
 380         /* If the compositor is repainting, this function is called only once
 381          * per frame and we have to process all the events available on the
 382          * fd, otherwise there will be input lag. */
 383         do {
 384                 if (device->mtdev)
 385                         len = mtdev_get(device->mtdev, fd, ev,
 386                                         ARRAY_LENGTH(ev)) *
 387                                 sizeof (struct input_event);
 388                 else
 389                         len = read(fd, &ev, sizeof ev);
 390
 391                 if (len < 0 || len % sizeof ev[0] != 0) {
 392                         /* FIXME: call evdev_device_destroy when errno is ENODEV. */
 393                         return 1;
 394                 }
 395
 396                 evdev_process_events(device, ev, len / sizeof ev[0]);
 397
 398         } while (len > 0);
 399
 400         return 1;
 401 }
 402
 403 static int
 404 evdev_handle_device(struct evdev_device *device)
 405 {
 406         struct input_absinfo absinfo;
 407         unsigned long ev_bits[NBITS(EV_MAX)];
 408         unsigned long abs_bits[NBITS(ABS_MAX)];
 409         unsigned long rel_bits[NBITS(REL_MAX)];
 410         unsigned long key_bits[NBITS(KEY_MAX)];
 411         int has_key, has_abs;
 412         unsigned int i;
 413
 414         has_key = 0;
 415         has_abs = 0;
 416         device->caps = 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                         device->caps |= EVDEV_MOTION_ABS;
 429                 }
 430                 if (TEST_BIT(abs_bits, ABS_Y)) {
 431                         ioctl(device->fd, EVIOCGABS(ABS_Y), &absinfo);
 432                         device->abs.min_y = absinfo.minimum;
 433                         device->abs.max_y = absinfo.maximum;
 434                         device->caps |= EVDEV_MOTION_ABS;
 435                 }
 436                 if (TEST_BIT(abs_bits, ABS_MT_SLOT)) {
 437                         ioctl(device->fd, EVIOCGABS(ABS_MT_POSITION_X),
 438                               &absinfo);
 439                         device->abs.min_x = absinfo.minimum;
 440                         device->abs.max_x = absinfo.maximum;
 441                         ioctl(device->fd, EVIOCGABS(ABS_MT_POSITION_Y),
 442                               &absinfo);
 443                         device->abs.min_y = absinfo.minimum;
 444                         device->abs.max_y = absinfo.maximum;
 445                         device->is_mt = 1;
 446                         device->mt.slot = 0;
 447                         device->caps |= EVDEV_TOUCH;
 448                 }
 449         }
 450         if (TEST_BIT(ev_bits, EV_REL)) {
 451                 ioctl(device->fd, EVIOCGBIT(EV_REL, sizeof(rel_bits)),
 452                       rel_bits);
 453                 if (TEST_BIT(rel_bits, REL_X) || TEST_BIT(rel_bits, REL_Y))
 454                         device->caps |= EVDEV_MOTION_REL;
 455         }
 456         if (TEST_BIT(ev_bits, EV_KEY)) {
 457                 has_key = 1;
 458                 ioctl(device->fd, EVIOCGBIT(EV_KEY, sizeof(key_bits)),
 459                       key_bits);
 460                 if (TEST_BIT(key_bits, BTN_TOOL_FINGER) &&
 461                     !TEST_BIT(key_bits, BTN_TOOL_PEN) &&
 462                     has_abs)
 463                         device->dispatch = evdev_touchpad_create(device);
 464                 for (i = KEY_ESC; i < KEY_MAX; i++) {
 465                         if (i >= BTN_MISC && i < KEY_OK)
 466                                 continue;
 467                         if (TEST_BIT(key_bits, i)) {
 468                                 device->caps |= EVDEV_KEYBOARD;
 469                                 break;
 470                         }
 471                 }
 472                 for (i = BTN_MISC; i < KEY_OK; i++) {
 473                         if (TEST_BIT(key_bits, i)) {
 474                                 device->caps |= EVDEV_BUTTON;
 475                                 break;
 476                         }
 477                 }
 478         }
 479         if (TEST_BIT(ev_bits, EV_LED)) {
 480                 device->caps |= EVDEV_KEYBOARD;
 481         }
 482
 483         /* This rule tries to catch accelerometer devices and opt out. We may
 484          * want to adjust the protocol later adding a proper event for dealing
 485          * with accelerometers and implement here accordingly */
 486         if (has_abs && !has_key && !device->is_mt) {
 487                 weston_log("input device %s, %s "
 488                            "ignored: unsupported device type\n",
 489                            device->devname, device->devnode);
 490                 return 0;
 491         }
 492
 493         return 1;
 494 }
 495
 496 static int
 497 evdev_configure_device(struct evdev_device *device)
 498 {
 499         if ((device->caps &
 500              (EVDEV_MOTION_ABS | EVDEV_MOTION_REL | EVDEV_BUTTON))) {
 501                 weston_seat_init_pointer(device->seat);
 502                 weston_log("input device %s, %s is a pointer caps =%s%s%s\n",
 503                            device->devname, device->devnode,
 504                            device->caps & EVDEV_MOTION_ABS ? " absolute-motion" : "",
 505                            device->caps & EVDEV_MOTION_REL ? " relative-motion": "",
 506                            device->caps & EVDEV_BUTTON ? " button" : "");
 507         }
 508         if ((device->caps & EVDEV_KEYBOARD)) {
 509                 if (weston_seat_init_keyboard(device->seat, NULL) < 0)
 510                         return -1;
 511                 weston_log("input device %s, %s is a keyboard\n",
 512                            device->devname, device->devnode);
 513         }
 514         if ((device->caps & EVDEV_TOUCH)) {
 515                 weston_seat_init_touch(device->seat);
 516                 weston_log("input device %s, %s is a touch device\n",
 517                            device->devname, device->devnode);
 518         }
 519
 520         return 0;
 521 }
 522
 523 struct evdev_device *
 524 evdev_device_create(struct weston_seat *seat, const char *path, int device_fd)
 525 {
 526         struct evdev_device *device;
 527         struct weston_compositor *ec;
 528         char devname[256] = "unknown";
 529
 530         device = malloc(sizeof *device);
 531         if (device == NULL)
 532                 return NULL;
 533         memset(device, 0, sizeof *device);
 534
 535         ec = seat->compositor;
 536         device->output =
 537                 container_of(ec->output_list.next, struct weston_output, link);
 538
 539         device->seat = seat;
 540         device->is_mt = 0;
 541         device->mtdev = NULL;
 542         device->devnode = strdup(path);
 543         device->mt.slot = -1;
 544         device->rel.dx = 0;
 545         device->rel.dy = 0;
 546         device->dispatch = NULL;
 547         device->fd = device_fd;
 548
 549         ioctl(device->fd, EVIOCGNAME(sizeof(devname)), devname);
 550         device->devname = strdup(devname);
 551
 552         if (!evdev_handle_device(device)) {
 553                 free(device->devnode);
 554                 free(device->devname);
 555                 free(device);
 556                 return EVDEV_UNHANDLED_DEVICE;
 557         }
 558
 559         if (evdev_configure_device(device) == -1)
 560                 goto err1;
 561
 562         /* If the dispatch was not set up use the fallback. */
 563         if (device->dispatch == NULL)
 564                 device->dispatch = fallback_dispatch_create();
 565         if (device->dispatch == NULL)
 566                 goto err1;
 567
 568
 569         if (device->is_mt) {
 570                 device->mtdev = mtdev_new_open(device->fd);
 571                 if (!device->mtdev)
 572                         weston_log("mtdev failed to open for %s\n", path);
 573         }
 574
 575         device->source = wl_event_loop_add_fd(ec->input_loop, device->fd,
 576                                               WL_EVENT_READABLE,
 577                                               evdev_device_data, device);
 578         if (device->source == NULL)
 579                 goto err2;
 580
 581         return device;
 582
 583 err2:
 584         device->dispatch->interface->destroy(device->dispatch);
 585 err1:
 586         free(device->devname);
 587         free(device->devnode);
 588         free(device);
 589         return NULL;
 590 }
 591
 592 void
 593 evdev_device_destroy(struct evdev_device *device)
 594 {
 595         struct evdev_dispatch *dispatch;
 596
 597         dispatch = device->dispatch;
 598         if (dispatch)
 599                 dispatch->interface->destroy(dispatch);
 600
 601         wl_event_source_remove(device->source);
 602         wl_list_remove(&device->link);
 603         if (device->mtdev)
 604                 mtdev_close_delete(device->mtdev);
 605         close(device->fd);
 606         free(device->devname);
 607         free(device->devnode);
 608         free(device);
 609 }
 610
 611 void
 612 evdev_notify_keyboard_focus(struct weston_seat *seat,
 613                             struct wl_list *evdev_devices)
 614 {
 615         struct evdev_device *device;
 616         struct wl_array keys;
 617         unsigned int i, set;
 618         char evdev_keys[(KEY_CNT + 7) / 8];
 619         char all_keys[(KEY_CNT + 7) / 8];
 620         uint32_t *k;
 621         int ret;
 622
 623         if (!seat->seat.keyboard)
 624                 return;
 625
 626         memset(all_keys, 0, sizeof all_keys);
 627         wl_list_for_each(device, evdev_devices, link) {
 628                 memset(evdev_keys, 0, sizeof evdev_keys);
 629                 ret = ioctl(device->fd,
 630                             EVIOCGKEY(sizeof evdev_keys), evdev_keys);
 631                 if (ret < 0) {
 632                         weston_log("failed to get keys for device %s\n",
 633                                 device->devnode);
 634                         continue;
 635                 }
 636                 for (i = 0; i < ARRAY_LENGTH(evdev_keys); i++)
 637                         all_keys[i] |= evdev_keys[i];
 638         }
 639
 640         wl_array_init(&keys);
 641         for (i = 0; i < KEY_CNT; i++) {
 642                 set = all_keys[i >> 3] & (1 << (i & 7));
 643                 if (set) {
 644                         k = wl_array_add(&keys, sizeof *k);
 645                         *k = i;
 646                 }
 647         }
 648
 649         notify_keyboard_focus_in(seat, &keys, STATE_UPDATE_AUTOMATIC);
 650
 651         wl_array_release(&keys);
 652 }