ui/input-linux.c

   1 /*
   2  * This work is licensed under the terms of the GNU GPL, version 2 or
   3  * (at your option) any later version.  See the COPYING file in the
   4  * top-level directory.
   5  */
   6
   7 #include "qemu/osdep.h"
   8 #include "qapi/error.h"
   9 #include "qemu-common.h"
  10 #include "qemu/config-file.h"
  11 #include "qemu/sockets.h"
  12 #include "sysemu/sysemu.h"
  13 #include "ui/input.h"
  14 #include "qom/object_interfaces.h"
  15
  16 #include <sys/ioctl.h>
  17 #include "standard-headers/linux/input.h"
  18
  19 static int linux_to_qcode[KEY_CNT] = {
  20     [KEY_ESC]            = Q_KEY_CODE_ESC,
  21     [KEY_1]              = Q_KEY_CODE_1,
  22     [KEY_2]              = Q_KEY_CODE_2,
  23     [KEY_3]              = Q_KEY_CODE_3,
  24     [KEY_4]              = Q_KEY_CODE_4,
  25     [KEY_5]              = Q_KEY_CODE_5,
  26     [KEY_6]              = Q_KEY_CODE_6,
  27     [KEY_7]              = Q_KEY_CODE_7,
  28     [KEY_8]              = Q_KEY_CODE_8,
  29     [KEY_9]              = Q_KEY_CODE_9,
  30     [KEY_0]              = Q_KEY_CODE_0,
  31     [KEY_MINUS]          = Q_KEY_CODE_MINUS,
  32     [KEY_EQUAL]          = Q_KEY_CODE_EQUAL,
  33     [KEY_BACKSPACE]      = Q_KEY_CODE_BACKSPACE,
  34     [KEY_TAB]            = Q_KEY_CODE_TAB,
  35     [KEY_Q]              = Q_KEY_CODE_Q,
  36     [KEY_W]              = Q_KEY_CODE_W,
  37     [KEY_E]              = Q_KEY_CODE_E,
  38     [KEY_R]              = Q_KEY_CODE_R,
  39     [KEY_T]              = Q_KEY_CODE_T,
  40     [KEY_Y]              = Q_KEY_CODE_Y,
  41     [KEY_U]              = Q_KEY_CODE_U,
  42     [KEY_I]              = Q_KEY_CODE_I,
  43     [KEY_O]              = Q_KEY_CODE_O,
  44     [KEY_P]              = Q_KEY_CODE_P,
  45     [KEY_LEFTBRACE]      = Q_KEY_CODE_BRACKET_LEFT,
  46     [KEY_RIGHTBRACE]     = Q_KEY_CODE_BRACKET_RIGHT,
  47     [KEY_ENTER]          = Q_KEY_CODE_RET,
  48     [KEY_LEFTCTRL]       = Q_KEY_CODE_CTRL,
  49     [KEY_A]              = Q_KEY_CODE_A,
  50     [KEY_S]              = Q_KEY_CODE_S,
  51     [KEY_D]              = Q_KEY_CODE_D,
  52     [KEY_F]              = Q_KEY_CODE_F,
  53     [KEY_G]              = Q_KEY_CODE_G,
  54     [KEY_H]              = Q_KEY_CODE_H,
  55     [KEY_J]              = Q_KEY_CODE_J,
  56     [KEY_K]              = Q_KEY_CODE_K,
  57     [KEY_L]              = Q_KEY_CODE_L,
  58     [KEY_SEMICOLON]      = Q_KEY_CODE_SEMICOLON,
  59     [KEY_APOSTROPHE]     = Q_KEY_CODE_APOSTROPHE,
  60     [KEY_GRAVE]          = Q_KEY_CODE_GRAVE_ACCENT,
  61     [KEY_LEFTSHIFT]      = Q_KEY_CODE_SHIFT,
  62     [KEY_BACKSLASH]      = Q_KEY_CODE_BACKSLASH,
  63     [KEY_102ND]          = Q_KEY_CODE_LESS,
  64     [KEY_Z]              = Q_KEY_CODE_Z,
  65     [KEY_X]              = Q_KEY_CODE_X,
  66     [KEY_C]              = Q_KEY_CODE_C,
  67     [KEY_V]              = Q_KEY_CODE_V,
  68     [KEY_B]              = Q_KEY_CODE_B,
  69     [KEY_N]              = Q_KEY_CODE_N,
  70     [KEY_M]              = Q_KEY_CODE_M,
  71     [KEY_COMMA]          = Q_KEY_CODE_COMMA,
  72     [KEY_DOT]            = Q_KEY_CODE_DOT,
  73     [KEY_SLASH]          = Q_KEY_CODE_SLASH,
  74     [KEY_RIGHTSHIFT]     = Q_KEY_CODE_SHIFT_R,
  75     [KEY_LEFTALT]        = Q_KEY_CODE_ALT,
  76     [KEY_SPACE]          = Q_KEY_CODE_SPC,
  77     [KEY_CAPSLOCK]       = Q_KEY_CODE_CAPS_LOCK,
  78     [KEY_F1]             = Q_KEY_CODE_F1,
  79     [KEY_F2]             = Q_KEY_CODE_F2,
  80     [KEY_F3]             = Q_KEY_CODE_F3,
  81     [KEY_F4]             = Q_KEY_CODE_F4,
  82     [KEY_F5]             = Q_KEY_CODE_F5,
  83     [KEY_F6]             = Q_KEY_CODE_F6,
  84     [KEY_F7]             = Q_KEY_CODE_F7,
  85     [KEY_F8]             = Q_KEY_CODE_F8,
  86     [KEY_F9]             = Q_KEY_CODE_F9,
  87     [KEY_F10]            = Q_KEY_CODE_F10,
  88     [KEY_NUMLOCK]        = Q_KEY_CODE_NUM_LOCK,
  89     [KEY_SCROLLLOCK]     = Q_KEY_CODE_SCROLL_LOCK,
  90     [KEY_KP0]            = Q_KEY_CODE_KP_0,
  91     [KEY_KP1]            = Q_KEY_CODE_KP_1,
  92     [KEY_KP2]            = Q_KEY_CODE_KP_2,
  93     [KEY_KP3]            = Q_KEY_CODE_KP_3,
  94     [KEY_KP4]            = Q_KEY_CODE_KP_4,
  95     [KEY_KP5]            = Q_KEY_CODE_KP_5,
  96     [KEY_KP6]            = Q_KEY_CODE_KP_6,
  97     [KEY_KP7]            = Q_KEY_CODE_KP_7,
  98     [KEY_KP8]            = Q_KEY_CODE_KP_8,
  99     [KEY_KP9]            = Q_KEY_CODE_KP_9,
 100     [KEY_KPMINUS]        = Q_KEY_CODE_KP_SUBTRACT,
 101     [KEY_KPPLUS]         = Q_KEY_CODE_KP_ADD,
 102     [KEY_KPDOT]          = Q_KEY_CODE_KP_DECIMAL,
 103     [KEY_KPENTER]        = Q_KEY_CODE_KP_ENTER,
 104     [KEY_KPSLASH]        = Q_KEY_CODE_KP_DIVIDE,
 105     [KEY_KPASTERISK]     = Q_KEY_CODE_KP_MULTIPLY,
 106     [KEY_F11]            = Q_KEY_CODE_F11,
 107     [KEY_F12]            = Q_KEY_CODE_F12,
 108     [KEY_RIGHTCTRL]      = Q_KEY_CODE_CTRL_R,
 109     [KEY_SYSRQ]          = Q_KEY_CODE_SYSRQ,
 110     [KEY_RIGHTALT]       = Q_KEY_CODE_ALT_R,
 111     [KEY_HOME]           = Q_KEY_CODE_HOME,
 112     [KEY_UP]             = Q_KEY_CODE_UP,
 113     [KEY_PAGEUP]         = Q_KEY_CODE_PGUP,
 114     [KEY_LEFT]           = Q_KEY_CODE_LEFT,
 115     [KEY_RIGHT]          = Q_KEY_CODE_RIGHT,
 116     [KEY_END]            = Q_KEY_CODE_END,
 117     [KEY_DOWN]           = Q_KEY_CODE_DOWN,
 118     [KEY_PAGEDOWN]       = Q_KEY_CODE_PGDN,
 119     [KEY_INSERT]         = Q_KEY_CODE_INSERT,
 120     [KEY_DELETE]         = Q_KEY_CODE_DELETE,
 121     [KEY_LEFTMETA]       = Q_KEY_CODE_META_L,
 122     [KEY_RIGHTMETA]      = Q_KEY_CODE_META_R,
 123     [KEY_MENU]           = Q_KEY_CODE_MENU,
 124 };
 125
 126 static int qemu_input_linux_to_qcode(unsigned int lnx)
 127 {
 128     assert(lnx < KEY_CNT);
 129     return linux_to_qcode[lnx];
 130 }
 131
 132 #define TYPE_INPUT_LINUX "input-linux"
 133 #define INPUT_LINUX(obj) \
 134     OBJECT_CHECK(InputLinux, (obj), TYPE_INPUT_LINUX)
 135 #define INPUT_LINUX_GET_CLASS(obj) \
 136     OBJECT_GET_CLASS(InputLinuxClass, (obj), TYPE_INPUT_LINUX)
 137 #define INPUT_LINUX_CLASS(klass) \
 138     OBJECT_CLASS_CHECK(InputLinuxClass, (klass), TYPE_INPUT_LINUX)
 139
 140 typedef struct InputLinux InputLinux;
 141 typedef struct InputLinuxClass InputLinuxClass;
 142
 143 struct InputLinux {
 144     Object parent;
 145
 146     char        *evdev;
 147     int         fd;
 148     bool        repeat;
 149     bool        grab_request;
 150     bool        grab_active;
 151     bool        grab_all;
 152     bool        keydown[KEY_CNT];
 153     int         keycount;
 154     int         wheel;
 155     bool        initialized;
 156     QTAILQ_ENTRY(InputLinux) next;
 157 };
 158
 159 struct InputLinuxClass {
 160     ObjectClass parent_class;
 161 };
 162
 163 static QTAILQ_HEAD(, InputLinux) inputs = QTAILQ_HEAD_INITIALIZER(inputs);
 164
 165 static void input_linux_toggle_grab(InputLinux *il)
 166 {
 167     intptr_t request = !il->grab_active;
 168     InputLinux *item;
 169     int rc;
 170
 171     rc = ioctl(il->fd, EVIOCGRAB, request);
 172     if (rc < 0) {
 173         return;
 174     }
 175     il->grab_active = !il->grab_active;
 176
 177     if (!il->grab_all) {
 178         return;
 179     }
 180     QTAILQ_FOREACH(item, &inputs, next) {
 181         if (item == il || item->grab_all) {
 182             /* avoid endless loops */
 183             continue;
 184         }
 185         if (item->grab_active != il->grab_active) {
 186             input_linux_toggle_grab(item);
 187         }
 188     }
 189 }
 190
 191 static void input_linux_handle_keyboard(InputLinux *il,
 192                                         struct input_event *event)
 193 {
 194     if (event->type == EV_KEY) {
 195         if (event->value > 2 || (event->value > 1 && !il->repeat)) {
 196             /*
 197              * ignore autorepeat + unknown key events
 198              * 0 == up, 1 == down, 2 == autorepeat, other == undefined
 199              */
 200             return;
 201         }
 202         if (event->code >= KEY_CNT) {
 203             /*
 204              * Should not happen.  But better safe than sorry,
 205              * and we make Coverity happy too.
 206              */
 207             return;
 208         }
 209
 210         /* keep track of key state */
 211         if (!il->keydown[event->code] && event->value) {
 212             il->keydown[event->code] = true;
 213             il->keycount++;
 214         }
 215         if (il->keydown[event->code] && !event->value) {
 216             il->keydown[event->code] = false;
 217             il->keycount--;
 218         }
 219
 220         /* send event to guest when grab is active */
 221         if (il->grab_active) {
 222             int qcode = qemu_input_linux_to_qcode(event->code);
 223             qemu_input_event_send_key_qcode(NULL, qcode, event->value);
 224         }
 225
 226         /* hotkey -> record switch request ... */
 227         if (il->keydown[KEY_LEFTCTRL] &&
 228             il->keydown[KEY_RIGHTCTRL]) {
 229             il->grab_request = true;
 230         }
 231
 232         /*
 233          * ... and do the switch when all keys are lifted, so we
 234          * confuse neither guest nor host with keys which seem to
 235          * be stuck due to missing key-up events.
 236          */
 237         if (il->grab_request && !il->keycount) {
 238             il->grab_request = false;
 239             input_linux_toggle_grab(il);
 240         }
 241     }
 242 }
 243
 244 static void input_linux_event_keyboard(void *opaque)
 245 {
 246     InputLinux *il = opaque;
 247     struct input_event event;
 248     int rc;
 249
 250     for (;;) {
 251         rc = read(il->fd, &event, sizeof(event));
 252         if (rc != sizeof(event)) {
 253             if (rc < 0 && errno != EAGAIN) {
 254                 fprintf(stderr, "%s: read: %s\n", __func__, strerror(errno));
 255                 qemu_set_fd_handler(il->fd, NULL, NULL, NULL);
 256                 close(il->fd);
 257             }
 258             break;
 259         }
 260
 261         input_linux_handle_keyboard(il, &event);
 262     }
 263 }
 264
 265 static void input_linux_event_mouse_button(int button)
 266 {
 267     qemu_input_queue_btn(NULL, button, true);
 268     qemu_input_event_sync();
 269     qemu_input_queue_btn(NULL, button, false);
 270     qemu_input_event_sync();
 271 }
 272
 273 static void input_linux_handle_mouse(InputLinux *il, struct input_event *event)
 274 {
 275     if (!il->grab_active) {
 276         return;
 277     }
 278
 279     switch (event->type) {
 280     case EV_KEY:
 281         switch (event->code) {
 282         case BTN_LEFT:
 283             qemu_input_queue_btn(NULL, INPUT_BUTTON_LEFT, event->value);
 284             break;
 285         case BTN_RIGHT:
 286             qemu_input_queue_btn(NULL, INPUT_BUTTON_RIGHT, event->value);
 287             break;
 288         case BTN_MIDDLE:
 289             qemu_input_queue_btn(NULL, INPUT_BUTTON_MIDDLE, event->value);
 290             break;
 291         case BTN_GEAR_UP:
 292             qemu_input_queue_btn(NULL, INPUT_BUTTON_WHEEL_UP, event->value);
 293             break;
 294         case BTN_GEAR_DOWN:
 295             qemu_input_queue_btn(NULL, INPUT_BUTTON_WHEEL_DOWN,
 296                                  event->value);
 297             break;
 298         };
 299         break;
 300     case EV_REL:
 301         switch (event->code) {
 302         case REL_X:
 303             qemu_input_queue_rel(NULL, INPUT_AXIS_X, event->value);
 304             break;
 305         case REL_Y:
 306             qemu_input_queue_rel(NULL, INPUT_AXIS_Y, event->value);
 307             break;
 308         case REL_WHEEL:
 309             il->wheel = event->value;
 310             break;
 311         }
 312         break;
 313     case EV_SYN:
 314         qemu_input_event_sync();
 315         if (il->wheel != 0) {
 316             input_linux_event_mouse_button((il->wheel > 0)
 317                                            ? INPUT_BUTTON_WHEEL_UP
 318                                            : INPUT_BUTTON_WHEEL_DOWN);
 319             il->wheel = 0;
 320         }
 321         break;
 322     }
 323 }
 324
 325 static void input_linux_event_mouse(void *opaque)
 326 {
 327     InputLinux *il = opaque;
 328     struct input_event event;
 329     int rc;
 330
 331     for (;;) {
 332         rc = read(il->fd, &event, sizeof(event));
 333         if (rc != sizeof(event)) {
 334             if (rc < 0 && errno != EAGAIN) {
 335                 fprintf(stderr, "%s: read: %s\n", __func__, strerror(errno));
 336                 qemu_set_fd_handler(il->fd, NULL, NULL, NULL);
 337                 close(il->fd);
 338             }
 339             break;
 340         }
 341
 342         input_linux_handle_mouse(il, &event);
 343     }
 344 }
 345
 346 static void input_linux_complete(UserCreatable *uc, Error **errp)
 347 {
 348     InputLinux *il = INPUT_LINUX(uc);
 349     uint32_t evtmap, relmap, absmap;
 350     int rc, ver;
 351
 352     if (!il->evdev) {
 353         error_setg(errp, "no input device specified");
 354         return;
 355     }
 356
 357     il->fd = open(il->evdev, O_RDWR);
 358     if (il->fd < 0)  {
 359         error_setg_file_open(errp, errno, il->evdev);
 360         return;
 361     }
 362     qemu_set_nonblock(il->fd);
 363
 364     rc = ioctl(il->fd, EVIOCGVERSION, &ver);
 365     if (rc < 0) {
 366         error_setg(errp, "%s: is not an evdev device", il->evdev);
 367         goto err_close;
 368     }
 369
 370     rc = ioctl(il->fd, EVIOCGBIT(0, sizeof(evtmap)), &evtmap);
 371     if (rc < 0) {
 372         error_setg(errp, "%s: failed to read event bits", il->evdev);
 373         goto err_close;
 374     }
 375
 376     if (evtmap & (1 << EV_REL)) {
 377         rc = ioctl(il->fd, EVIOCGBIT(EV_REL, sizeof(relmap)), &relmap);
 378         if (rc < 0) {
 379             relmap = 0;
 380         }
 381     }
 382
 383     if (evtmap & (1 << EV_ABS)) {
 384         ioctl(il->fd, EVIOCGBIT(EV_ABS, sizeof(absmap)), &absmap);
 385         if (rc < 0) {
 386             absmap = 0;
 387         }
 388     }
 389
 390     if ((evtmap & (1 << EV_REL)) &&
 391         (relmap & (1 << REL_X))) {
 392         /* has relative x axis -> assume mouse */
 393         qemu_set_fd_handler(il->fd, input_linux_event_mouse, NULL, il);
 394     } else if ((evtmap & (1 << EV_ABS)) &&
 395                (absmap & (1 << ABS_X))) {
 396         /* has absolute x axis -> not supported */
 397         error_setg(errp, "tablet/touchscreen not supported");
 398         goto err_close;
 399     } else if (evtmap & (1 << EV_KEY)) {
 400         /* has keys/buttons (and no x axis) -> assume keyboard */
 401         qemu_set_fd_handler(il->fd, input_linux_event_keyboard, NULL, il);
 402     } else {
 403         /* Huh? What is this? */
 404         error_setg(errp, "unknown kind of input device");
 405         goto err_close;
 406     }
 407     input_linux_toggle_grab(il);
 408     QTAILQ_INSERT_TAIL(&inputs, il, next);
 409     il->initialized = true;
 410     return;
 411
 412 err_close:
 413     close(il->fd);
 414     return;
 415 }
 416
 417 static void input_linux_instance_finalize(Object *obj)
 418 {
 419     InputLinux *il = INPUT_LINUX(obj);
 420
 421     if (il->initialized) {
 422         QTAILQ_REMOVE(&inputs, il, next);
 423         close(il->fd);
 424     }
 425     g_free(il->evdev);
 426 }
 427
 428 static char *input_linux_get_evdev(Object *obj, Error **errp)
 429 {
 430     InputLinux *il = INPUT_LINUX(obj);
 431
 432     return g_strdup(il->evdev);
 433 }
 434
 435 static void input_linux_set_evdev(Object *obj, const char *value,
 436                                   Error **errp)
 437 {
 438     InputLinux *il = INPUT_LINUX(obj);
 439
 440     if (il->evdev) {
 441         error_setg(errp, "evdev property already set");
 442         return;
 443     }
 444     il->evdev = g_strdup(value);
 445 }
 446
 447 static bool input_linux_get_grab_all(Object *obj, Error **errp)
 448 {
 449     InputLinux *il = INPUT_LINUX(obj);
 450
 451     return il->grab_all;
 452 }
 453
 454 static void input_linux_set_grab_all(Object *obj, bool value,
 455                                    Error **errp)
 456 {
 457     InputLinux *il = INPUT_LINUX(obj);
 458
 459     il->grab_all = value;
 460 }
 461
 462 static bool input_linux_get_repeat(Object *obj, Error **errp)
 463 {
 464     InputLinux *il = INPUT_LINUX(obj);
 465
 466     return il->repeat;
 467 }
 468
 469 static void input_linux_set_repeat(Object *obj, bool value,
 470                                    Error **errp)
 471 {
 472     InputLinux *il = INPUT_LINUX(obj);
 473
 474     il->repeat = value;
 475 }
 476
 477 static void input_linux_instance_init(Object *obj)
 478 {
 479     object_property_add_str(obj, "evdev",
 480                             input_linux_get_evdev,
 481                             input_linux_set_evdev, NULL);
 482     object_property_add_bool(obj, "grab_all",
 483                              input_linux_get_grab_all,
 484                              input_linux_set_grab_all, NULL);
 485     object_property_add_bool(obj, "repeat",
 486                              input_linux_get_repeat,
 487                              input_linux_set_repeat, NULL);
 488 }
 489
 490 static void input_linux_class_init(ObjectClass *oc, void *data)
 491 {
 492     UserCreatableClass *ucc = USER_CREATABLE_CLASS(oc);
 493
 494     ucc->complete = input_linux_complete;
 495 }
 496
 497 static const TypeInfo input_linux_info = {
 498     .name = TYPE_INPUT_LINUX,
 499     .parent = TYPE_OBJECT,
 500     .class_size = sizeof(InputLinuxClass),
 501     .class_init = input_linux_class_init,
 502     .instance_size = sizeof(InputLinux),
 503     .instance_init = input_linux_instance_init,
 504     .instance_finalize = input_linux_instance_finalize,
 505     .interfaces = (InterfaceInfo[]) {
 506         { TYPE_USER_CREATABLE },
 507         { }
 508     }
 509 };
 510
 511 static void register_types(void)
 512 {
 513     type_register_static(&input_linux_info);
 514 }
 515
 516 type_init(register_types);