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, device->rel.dx, device->rel.dy);
 258                 device->pending_events &= ~EVDEV_RELATIVE_MOTION;
 259                 device->rel.dx = 0;
 260                 device->rel.dy = 0;
 261         }
 262         if (device->pending_events & EVDEV_ABSOLUTE_MT_DOWN) {
 263                 notify_touch(master, time,
 264                              device->mt.slot,
 265                              wl_fixed_from_int(device->mt.x[device->mt.slot]),
 266                              wl_fixed_from_int(device->mt.y[device->mt.slot]),
 267                              WL_TOUCH_DOWN);
 268                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_DOWN;
 269                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_MOTION;
 270         }
 271         if (device->pending_events & EVDEV_ABSOLUTE_MT_MOTION) {
 272                 notify_touch(master, time,
 273                              device->mt.slot,
 274                              wl_fixed_from_int(device->mt.x[device->mt.slot]),
 275                              wl_fixed_from_int(device->mt.y[device->mt.slot]),
 276                              WL_TOUCH_MOTION);
 277                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_DOWN;
 278                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_MOTION;
 279         }
 280         if (device->pending_events & EVDEV_ABSOLUTE_MT_UP) {
 281                 notify_touch(master, time, device->mt.slot, 0, 0,
 282                              WL_TOUCH_UP);
 283                 device->pending_events &= ~EVDEV_ABSOLUTE_MT_UP;
 284         }
 285         if (device->pending_events & EVDEV_ABSOLUTE_MOTION) {
 286                 transform_absolute(device);
 287                 notify_motion_absolute(master, time,
 288                               wl_fixed_from_int(device->abs.x),
 289                               wl_fixed_from_int(device->abs.y));
 290                 device->pending_events &= ~EVDEV_ABSOLUTE_MOTION;
 291         }
 292 }
 293
 294 static void
 295 fallback_process(struct evdev_dispatch *dispatch,
 296                  struct evdev_device *device,
 297                  struct input_event *event,
 298                  uint32_t time)
 299 {
 300         switch (event->type) {
 301         case EV_REL:
 302                 evdev_process_relative(device, event, time);
 303                 break;
 304         case EV_ABS:
 305                 evdev_process_absolute(device, event);
 306                 break;
 307         case EV_KEY:
 308                 evdev_process_key(device, event, time);
 309                 break;
 310         case EV_SYN:
 311                 device->pending_events |= EVDEV_SYN;
 312                 break;
 313         }
 314 }
 315
 316 static void
 317 fallback_destroy(struct evdev_dispatch *dispatch)
 318 {
 319         free(dispatch);
 320 }
 321
 322 struct evdev_dispatch_interface fallback_interface = {
 323         fallback_process,
 324         fallback_destroy
 325 };
 326
 327 static struct evdev_dispatch *
 328 fallback_dispatch_create(void)
 329 {
 330         struct evdev_dispatch *dispatch = malloc(sizeof *dispatch);
 331         if (dispatch == NULL)
 332                 return NULL;
 333
 334         dispatch->interface = &fallback_interface;
 335
 336         return dispatch;
 337 }
 338
 339 static void
 340 evdev_process_events(struct evdev_device *device,
 341                      struct input_event *ev, int count)
 342 {
 343         struct evdev_dispatch *dispatch = device->dispatch;
 344         struct input_event *e, *end;
 345         uint32_t time = 0;
 346
 347         device->pending_events = 0;
 348
 349         e = ev;
 350         end = e + count;
 351         for (e = ev; e < end; e++) {
 352                 time = e->time.tv_sec * 1000 + e->time.tv_usec / 1000;
 353
 354                 /* we try to minimize the amount of notifications to be
 355                  * forwarded to the compositor, so we accumulate motion
 356                  * events and send as a bunch */
 357                 if (!is_motion_event(e))
 358                         evdev_flush_motion(device, time);
 359
 360                 dispatch->interface->process(dispatch, device, e, time);
 361         }
 362
 363         evdev_flush_motion(device, time);
 364 }
 365
 366 static int
 367 evdev_device_data(int fd, uint32_t mask, void *data)
 368 {
 369         struct weston_compositor *ec;
 370         struct evdev_device *device = data;
 371         struct input_event ev[32];
 372         int len;
 373
 374         ec = device->seat->compositor;
 375         if (!ec->focus)
 376                 return 1;
 377
 378         /* If the compositor is repainting, this function is called only once
 379          * per frame and we have to process all the events available on the
 380          * fd, otherwise there will be input lag. */
 381         do {
 382                 if (device->mtdev)
 383                         len = mtdev_get(device->mtdev, fd, ev,
 384                                         ARRAY_LENGTH(ev)) *
 385                                 sizeof (struct input_event);
 386                 else
 387                         len = read(fd, &ev, sizeof ev);
 388
 389                 if (len < 0 || len % sizeof ev[0] != 0) {
 390                         /* FIXME: call evdev_device_destroy when errno is ENODEV. */
 391                         return 1;
 392                 }
 393
 394                 evdev_process_events(device, ev, len / sizeof ev[0]);
 395
 396         } while (len > 0);
 397
 398         return 1;
 399 }
 400
 401 static int
 402 evdev_handle_device(struct evdev_device *device)
 403 {
 404         struct input_absinfo absinfo;
 405         unsigned long ev_bits[NBITS(EV_MAX)];
 406         unsigned long abs_bits[NBITS(ABS_MAX)];
 407         unsigned long rel_bits[NBITS(REL_MAX)];
 408         unsigned long key_bits[NBITS(KEY_MAX)];
 409         int has_key, has_abs;
 410         unsigned int i;
 411
 412         has_key = 0;
 413         has_abs = 0;
 414         device->caps = 0;
 415
 416         ioctl(device->fd, EVIOCGBIT(0, sizeof(ev_bits)), ev_bits);
 417         if (TEST_BIT(ev_bits, EV_ABS)) {
 418                 has_abs = 1;
 419
 420                 ioctl(device->fd, EVIOCGBIT(EV_ABS, sizeof(abs_bits)),
 421                       abs_bits);
 422                 if (TEST_BIT(abs_bits, ABS_X)) {
 423                         ioctl(device->fd, EVIOCGABS(ABS_X), &absinfo);
 424                         device->abs.min_x = absinfo.minimum;
 425                         device->abs.max_x = absinfo.maximum;
 426                         device->caps |= EVDEV_MOTION_ABS;
 427                 }
 428                 if (TEST_BIT(abs_bits, ABS_Y)) {
 429                         ioctl(device->fd, EVIOCGABS(ABS_Y), &absinfo);
 430                         device->abs.min_y = absinfo.minimum;
 431                         device->abs.max_y = absinfo.maximum;
 432                         device->caps |= EVDEV_MOTION_ABS;
 433                 }
 434                 if (TEST_BIT(abs_bits, ABS_MT_SLOT)) {
 435                         ioctl(device->fd, EVIOCGABS(ABS_MT_POSITION_X),
 436                               &absinfo);
 437                         device->abs.min_x = absinfo.minimum;
 438                         device->abs.max_x = absinfo.maximum;
 439                         ioctl(device->fd, EVIOCGABS(ABS_MT_POSITION_Y),
 440                               &absinfo);
 441                         device->abs.min_y = absinfo.minimum;
 442                         device->abs.max_y = absinfo.maximum;
 443                         device->is_mt = 1;
 444                         device->mt.slot = 0;
 445                         device->caps |= EVDEV_TOUCH;
 446                 }
 447         }
 448         if (TEST_BIT(ev_bits, EV_REL)) {
 449                 ioctl(device->fd, EVIOCGBIT(EV_REL, sizeof(rel_bits)),
 450                       rel_bits);
 451                 if (TEST_BIT(rel_bits, REL_X) || TEST_BIT(rel_bits, REL_Y))
 452                         device->caps |= EVDEV_MOTION_REL;
 453         }
 454         if (TEST_BIT(ev_bits, EV_KEY)) {
 455                 has_key = 1;
 456                 ioctl(device->fd, EVIOCGBIT(EV_KEY, sizeof(key_bits)),
 457                       key_bits);
 458                 if (TEST_BIT(key_bits, BTN_TOOL_FINGER) &&
 459                     !TEST_BIT(key_bits, BTN_TOOL_PEN) &&
 460                     has_abs)
 461                         device->dispatch = evdev_touchpad_create(device);
 462                 for (i = KEY_ESC; i < KEY_MAX; i++) {
 463                         if (i >= BTN_MISC && i < KEY_OK)
 464                                 continue;
 465                         if (TEST_BIT(key_bits, i)) {
 466                                 device->caps |= EVDEV_KEYBOARD;
 467                                 break;
 468                         }
 469                 }
 470                 for (i = BTN_MISC; i < KEY_OK; i++) {
 471                         if (TEST_BIT(key_bits, i)) {
 472                                 device->caps |= EVDEV_BUTTON;
 473                                 break;
 474                         }
 475                 }
 476         }
 477         if (TEST_BIT(ev_bits, EV_LED)) {
 478                 device->caps |= EVDEV_KEYBOARD;
 479         }
 480
 481         /* This rule tries to catch accelerometer devices and opt out. We may
 482          * want to adjust the protocol later adding a proper event for dealing
 483          * with accelerometers and implement here accordingly */
 484         if (has_abs && !has_key && !device->is_mt) {
 485                 weston_log("input device %s, %s "
 486                            "ignored: unsupported device type\n",
 487                            device->devname, device->devnode);
 488                 return 0;
 489         }
 490
 491         return 1;
 492 }
 493
 494 static int
 495 evdev_configure_device(struct evdev_device *device)
 496 {
 497         if ((device->caps &
 498              (EVDEV_MOTION_ABS | EVDEV_MOTION_REL | EVDEV_BUTTON))) {
 499                 weston_seat_init_pointer(device->seat);
 500                 weston_log("input device %s, %s is a pointer caps =%s%s%s\n",
 501                            device->devname, device->devnode,
 502                            device->caps & EVDEV_MOTION_ABS ? " absolute-motion" : "",
 503                            device->caps & EVDEV_MOTION_REL ? " relative-motion": "",
 504                            device->caps & EVDEV_BUTTON ? " button" : "");
 505         }
 506         if ((device->caps & EVDEV_KEYBOARD)) {
 507                 if (weston_seat_init_keyboard(device->seat, NULL) < 0)
 508                         return -1;
 509                 weston_log("input device %s, %s is a keyboard\n",
 510                            device->devname, device->devnode);
 511         }
 512         if ((device->caps & EVDEV_TOUCH)) {
 513                 weston_seat_init_touch(device->seat);
 514                 weston_log("input device %s, %s is a touch device\n",
 515                            device->devname, device->devnode);
 516         }
 517
 518         return 0;
 519 }
 520
 521 struct evdev_device *
 522 evdev_device_create(struct weston_seat *seat, const char *path, int device_fd)
 523 {
 524         struct evdev_device *device;
 525         struct weston_compositor *ec;
 526         char devname[256] = "unknown";
 527
 528         device = malloc(sizeof *device);
 529         if (device == NULL)
 530                 return NULL;
 531         memset(device, 0, sizeof *device);
 532
 533         ec = seat->compositor;
 534         device->output =
 535                 container_of(ec->output_list.next, struct weston_output, link);
 536
 537         device->seat = seat;
 538         device->is_mt = 0;
 539         device->mtdev = NULL;
 540         device->devnode = strdup(path);
 541         device->mt.slot = -1;
 542         device->rel.dx = 0;
 543         device->rel.dy = 0;
 544         device->dispatch = NULL;
 545         device->fd = device_fd;
 546
 547         ioctl(device->fd, EVIOCGNAME(sizeof(devname)), devname);
 548         device->devname = strdup(devname);
 549
 550         if (!evdev_handle_device(device)) {
 551                 free(device->devnode);
 552                 free(device->devname);
 553                 free(device);
 554                 return EVDEV_UNHANDLED_DEVICE;
 555         }
 556
 557         if (evdev_configure_device(device) == -1)
 558                 goto err1;
 559
 560         /* If the dispatch was not set up use the fallback. */
 561         if (device->dispatch == NULL)
 562                 device->dispatch = fallback_dispatch_create();
 563         if (device->dispatch == NULL)
 564                 goto err1;
 565
 566
 567         if (device->is_mt) {
 568                 device->mtdev = mtdev_new_open(device->fd);
 569                 if (!device->mtdev)
 570                         weston_log("mtdev failed to open for %s\n", path);
 571         }
 572
 573         device->source = wl_event_loop_add_fd(ec->input_loop, device->fd,
 574                                               WL_EVENT_READABLE,
 575                                               evdev_device_data, device);
 576         if (device->source == NULL)
 577                 goto err2;
 578
 579         return device;
 580
 581 err2:
 582         device->dispatch->interface->destroy(device->dispatch);
 583 err1:
 584         free(device->devname);
 585         free(device->devnode);
 586         free(device);
 587         return NULL;
 588 }
 589
 590 void
 591 evdev_device_destroy(struct evdev_device *device)
 592 {
 593         struct evdev_dispatch *dispatch;
 594
 595         dispatch = device->dispatch;
 596         if (dispatch)
 597                 dispatch->interface->destroy(dispatch);
 598
 599         wl_event_source_remove(device->source);
 600         wl_list_remove(&device->link);
 601         if (device->mtdev)
 602                 mtdev_close_delete(device->mtdev);
 603         close(device->fd);
 604         free(device->devname);
 605         free(device->devnode);
 606         free(device);
 607 }
 608
 609 void
 610 evdev_notify_keyboard_focus(struct weston_seat *seat,
 611                             struct wl_list *evdev_devices)
 612 {
 613         struct evdev_device *device;
 614         struct wl_array keys;
 615         unsigned int i, set;
 616         char evdev_keys[(KEY_CNT + 7) / 8];
 617         char all_keys[(KEY_CNT + 7) / 8];
 618         uint32_t *k;
 619         int ret;
 620
 621         if (!seat->keyboard)
 622                 return;
 623
 624         memset(all_keys, 0, sizeof all_keys);
 625         wl_list_for_each(device, evdev_devices, link) {
 626                 memset(evdev_keys, 0, sizeof evdev_keys);
 627                 ret = ioctl(device->fd,
 628                             EVIOCGKEY(sizeof evdev_keys), evdev_keys);
 629                 if (ret < 0) {
 630                         weston_log("failed to get keys for device %s\n",
 631                                 device->devnode);
 632                         continue;
 633                 }
 634                 for (i = 0; i < ARRAY_LENGTH(evdev_keys); i++)
 635                         all_keys[i] |= evdev_keys[i];
 636         }
 637
 638         wl_array_init(&keys);
 639         for (i = 0; i < KEY_CNT; i++) {
 640                 set = all_keys[i >> 3] & (1 << (i & 7));
 641                 if (set) {
 642                         k = wl_array_add(&keys, sizeof *k);
 643                         *k = i;
 644                 }
 645         }
 646
 647         notify_keyboard_focus_in(seat, &keys, STATE_UPDATE_AUTOMATIC);
 648
 649         wl_array_release(&keys);
 650 }