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