ui/input.c

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "sysemu/sysemu.h"
  26 #include "monitor/monitor.h"
  27 #include "ui/console.h"
  28 #include "qapi/error.h"
  29 #include "qmp-commands.h"
  30 #include "qapi-types.h"
  31
  32 struct QEMUPutMouseEntry {
  33     QEMUPutMouseEvent *qemu_put_mouse_event;
  34     void *qemu_put_mouse_event_opaque;
  35     int qemu_put_mouse_event_absolute;
  36     char *qemu_put_mouse_event_name;
  37
  38     int index;
  39
  40     /* used internally by qemu for handling mice */
  41     QTAILQ_ENTRY(QEMUPutMouseEntry) node;
  42 };
  43
  44 struct QEMUPutLEDEntry {
  45     QEMUPutLEDEvent *put_led;
  46     void *opaque;
  47     QTAILQ_ENTRY(QEMUPutLEDEntry) next;
  48 };
  49
  50 static QEMUPutKBDEvent *qemu_put_kbd_event;
  51 static void *qemu_put_kbd_event_opaque;
  52 static QTAILQ_HEAD(, QEMUPutLEDEntry) led_handlers = QTAILQ_HEAD_INITIALIZER(led_handlers);
  53 static QTAILQ_HEAD(, QEMUPutMouseEntry) mouse_handlers =
  54     QTAILQ_HEAD_INITIALIZER(mouse_handlers);
  55 static NotifierList mouse_mode_notifiers =
  56     NOTIFIER_LIST_INITIALIZER(mouse_mode_notifiers);
  57
  58 static const int key_defs[] = {
  59     [Q_KEY_CODE_SHIFT] = 0x2a,
  60     [Q_KEY_CODE_SHIFT_R] = 0x36,
  61
  62     [Q_KEY_CODE_ALT] = 0x38,
  63     [Q_KEY_CODE_ALT_R] = 0xb8,
  64     [Q_KEY_CODE_ALTGR] = 0x64,
  65     [Q_KEY_CODE_ALTGR_R] = 0xe4,
  66     [Q_KEY_CODE_CTRL] = 0x1d,
  67     [Q_KEY_CODE_CTRL_R] = 0x9d,
  68
  69     [Q_KEY_CODE_MENU] = 0xdd,
  70
  71     [Q_KEY_CODE_ESC] = 0x01,
  72
  73     [Q_KEY_CODE_1] = 0x02,
  74     [Q_KEY_CODE_2] = 0x03,
  75     [Q_KEY_CODE_3] = 0x04,
  76     [Q_KEY_CODE_4] = 0x05,
  77     [Q_KEY_CODE_5] = 0x06,
  78     [Q_KEY_CODE_6] = 0x07,
  79     [Q_KEY_CODE_7] = 0x08,
  80     [Q_KEY_CODE_8] = 0x09,
  81     [Q_KEY_CODE_9] = 0x0a,
  82     [Q_KEY_CODE_0] = 0x0b,
  83     [Q_KEY_CODE_MINUS] = 0x0c,
  84     [Q_KEY_CODE_EQUAL] = 0x0d,
  85     [Q_KEY_CODE_BACKSPACE] = 0x0e,
  86
  87     [Q_KEY_CODE_TAB] = 0x0f,
  88     [Q_KEY_CODE_Q] = 0x10,
  89     [Q_KEY_CODE_W] = 0x11,
  90     [Q_KEY_CODE_E] = 0x12,
  91     [Q_KEY_CODE_R] = 0x13,
  92     [Q_KEY_CODE_T] = 0x14,
  93     [Q_KEY_CODE_Y] = 0x15,
  94     [Q_KEY_CODE_U] = 0x16,
  95     [Q_KEY_CODE_I] = 0x17,
  96     [Q_KEY_CODE_O] = 0x18,
  97     [Q_KEY_CODE_P] = 0x19,
  98     [Q_KEY_CODE_BRACKET_LEFT] = 0x1a,
  99     [Q_KEY_CODE_BRACKET_RIGHT] = 0x1b,
 100     [Q_KEY_CODE_RET] = 0x1c,
 101
 102     [Q_KEY_CODE_A] = 0x1e,
 103     [Q_KEY_CODE_S] = 0x1f,
 104     [Q_KEY_CODE_D] = 0x20,
 105     [Q_KEY_CODE_F] = 0x21,
 106     [Q_KEY_CODE_G] = 0x22,
 107     [Q_KEY_CODE_H] = 0x23,
 108     [Q_KEY_CODE_J] = 0x24,
 109     [Q_KEY_CODE_K] = 0x25,
 110     [Q_KEY_CODE_L] = 0x26,
 111     [Q_KEY_CODE_SEMICOLON] = 0x27,
 112     [Q_KEY_CODE_APOSTROPHE] = 0x28,
 113     [Q_KEY_CODE_GRAVE_ACCENT] = 0x29,
 114
 115     [Q_KEY_CODE_BACKSLASH] = 0x2b,
 116     [Q_KEY_CODE_Z] = 0x2c,
 117     [Q_KEY_CODE_X] = 0x2d,
 118     [Q_KEY_CODE_C] = 0x2e,
 119     [Q_KEY_CODE_V] = 0x2f,
 120     [Q_KEY_CODE_B] = 0x30,
 121     [Q_KEY_CODE_N] = 0x31,
 122     [Q_KEY_CODE_M] = 0x32,
 123     [Q_KEY_CODE_COMMA] = 0x33,
 124     [Q_KEY_CODE_DOT] = 0x34,
 125     [Q_KEY_CODE_SLASH] = 0x35,
 126
 127     [Q_KEY_CODE_ASTERISK] = 0x37,
 128
 129     [Q_KEY_CODE_SPC] = 0x39,
 130     [Q_KEY_CODE_CAPS_LOCK] = 0x3a,
 131     [Q_KEY_CODE_F1] = 0x3b,
 132     [Q_KEY_CODE_F2] = 0x3c,
 133     [Q_KEY_CODE_F3] = 0x3d,
 134     [Q_KEY_CODE_F4] = 0x3e,
 135     [Q_KEY_CODE_F5] = 0x3f,
 136     [Q_KEY_CODE_F6] = 0x40,
 137     [Q_KEY_CODE_F7] = 0x41,
 138     [Q_KEY_CODE_F8] = 0x42,
 139     [Q_KEY_CODE_F9] = 0x43,
 140     [Q_KEY_CODE_F10] = 0x44,
 141     [Q_KEY_CODE_NUM_LOCK] = 0x45,
 142     [Q_KEY_CODE_SCROLL_LOCK] = 0x46,
 143
 144     [Q_KEY_CODE_KP_DIVIDE] = 0xb5,
 145     [Q_KEY_CODE_KP_MULTIPLY] = 0x37,
 146     [Q_KEY_CODE_KP_SUBTRACT] = 0x4a,
 147     [Q_KEY_CODE_KP_ADD] = 0x4e,
 148     [Q_KEY_CODE_KP_ENTER] = 0x9c,
 149     [Q_KEY_CODE_KP_DECIMAL] = 0x53,
 150     [Q_KEY_CODE_SYSRQ] = 0x54,
 151
 152     [Q_KEY_CODE_KP_0] = 0x52,
 153     [Q_KEY_CODE_KP_1] = 0x4f,
 154     [Q_KEY_CODE_KP_2] = 0x50,
 155     [Q_KEY_CODE_KP_3] = 0x51,
 156     [Q_KEY_CODE_KP_4] = 0x4b,
 157     [Q_KEY_CODE_KP_5] = 0x4c,
 158     [Q_KEY_CODE_KP_6] = 0x4d,
 159     [Q_KEY_CODE_KP_7] = 0x47,
 160     [Q_KEY_CODE_KP_8] = 0x48,
 161     [Q_KEY_CODE_KP_9] = 0x49,
 162
 163     [Q_KEY_CODE_LESS] = 0x56,
 164
 165     [Q_KEY_CODE_F11] = 0x57,
 166     [Q_KEY_CODE_F12] = 0x58,
 167
 168     [Q_KEY_CODE_PRINT] = 0xb7,
 169
 170     [Q_KEY_CODE_HOME] = 0xc7,
 171     [Q_KEY_CODE_PGUP] = 0xc9,
 172     [Q_KEY_CODE_PGDN] = 0xd1,
 173     [Q_KEY_CODE_END] = 0xcf,
 174
 175     [Q_KEY_CODE_LEFT] = 0xcb,
 176     [Q_KEY_CODE_UP] = 0xc8,
 177     [Q_KEY_CODE_DOWN] = 0xd0,
 178     [Q_KEY_CODE_RIGHT] = 0xcd,
 179
 180     [Q_KEY_CODE_INSERT] = 0xd2,
 181     [Q_KEY_CODE_DELETE] = 0xd3,
 182 #ifdef NEED_CPU_H
 183 #if defined(TARGET_SPARC) && !defined(TARGET_SPARC64)
 184     [Q_KEY_CODE_STOP] = 0xf0,
 185     [Q_KEY_CODE_AGAIN] = 0xf1,
 186     [Q_KEY_CODE_PROPS] = 0xf2,
 187     [Q_KEY_CODE_UNDO] = 0xf3,
 188     [Q_KEY_CODE_FRONT] = 0xf4,
 189     [Q_KEY_CODE_COPY] = 0xf5,
 190     [Q_KEY_CODE_OPEN] = 0xf6,
 191     [Q_KEY_CODE_PASTE] = 0xf7,
 192     [Q_KEY_CODE_FIND] = 0xf8,
 193     [Q_KEY_CODE_CUT] = 0xf9,
 194     [Q_KEY_CODE_LF] = 0xfa,
 195     [Q_KEY_CODE_HELP] = 0xfb,
 196     [Q_KEY_CODE_META_L] = 0xfc,
 197     [Q_KEY_CODE_META_R] = 0xfd,
 198     [Q_KEY_CODE_COMPOSE] = 0xfe,
 199 #endif
 200 #endif
 201     [Q_KEY_CODE_MAX] = 0,
 202 };
 203
 204 int index_from_key(const char *key)
 205 {
 206     int i;
 207
 208     for (i = 0; QKeyCode_lookup[i] != NULL; i++) {
 209         if (!strcmp(key, QKeyCode_lookup[i])) {
 210             break;
 211         }
 212     }
 213
 214     /* Return Q_KEY_CODE_MAX if the key is invalid */
 215     return i;
 216 }
 217
 218 int index_from_keycode(int code)
 219 {
 220     int i;
 221
 222     for (i = 0; i < Q_KEY_CODE_MAX; i++) {
 223         if (key_defs[i] == code) {
 224             break;
 225         }
 226     }
 227
 228     /* Return Q_KEY_CODE_MAX if the code is invalid */
 229     return i;
 230 }
 231
 232 static int *keycodes;
 233 static int keycodes_size;
 234 static QEMUTimer *key_timer;
 235
 236 static int keycode_from_keyvalue(const KeyValue *value)
 237 {
 238     if (value->kind == KEY_VALUE_KIND_QCODE) {
 239         return key_defs[value->qcode];
 240     } else {
 241         assert(value->kind == KEY_VALUE_KIND_NUMBER);
 242         return value->number;
 243     }
 244 }
 245
 246 static void free_keycodes(void)
 247 {
 248     g_free(keycodes);
 249     keycodes = NULL;
 250     keycodes_size = 0;
 251 }
 252
 253 static void release_keys(void *opaque)
 254 {
 255     while (keycodes_size > 0) {
 256         if (keycodes[--keycodes_size] & 0x80) {
 257             kbd_put_keycode(0xe0);
 258         }
 259         kbd_put_keycode(keycodes[keycodes_size] | 0x80);
 260     }
 261
 262     free_keycodes();
 263 }
 264
 265 void qmp_send_key(KeyValueList *keys, bool has_hold_time, int64_t hold_time,
 266                   Error **errp)
 267 {
 268     int keycode;
 269     KeyValueList *p;
 270
 271     if (!key_timer) {
 272         key_timer = qemu_new_timer_ns(vm_clock, release_keys, NULL);
 273     }
 274
 275     if (keycodes != NULL) {
 276         qemu_del_timer(key_timer);
 277         release_keys(NULL);
 278     }
 279
 280     if (!has_hold_time) {
 281         hold_time = 100;
 282     }
 283
 284     for (p = keys; p != NULL; p = p->next) {
 285         /* key down events */
 286         keycode = keycode_from_keyvalue(p->value);
 287         if (keycode < 0x01 || keycode > 0xff) {
 288             error_setg(errp, "invalid hex keycode 0x%x", keycode);
 289             free_keycodes();
 290             return;
 291         }
 292
 293         if (keycode & 0x80) {
 294             kbd_put_keycode(0xe0);
 295         }
 296         kbd_put_keycode(keycode & 0x7f);
 297
 298         keycodes = g_realloc(keycodes, sizeof(int) * (keycodes_size + 1));
 299         keycodes[keycodes_size++] = keycode;
 300     }
 301
 302     /* delayed key up events */
 303     qemu_mod_timer(key_timer, qemu_get_clock_ns(vm_clock) +
 304                    muldiv64(get_ticks_per_sec(), hold_time, 1000));
 305 }
 306
 307 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque)
 308 {
 309     qemu_put_kbd_event_opaque = opaque;
 310     qemu_put_kbd_event = func;
 311 }
 312
 313 void qemu_remove_kbd_event_handler(void)
 314 {
 315     qemu_put_kbd_event_opaque = NULL;
 316     qemu_put_kbd_event = NULL;
 317 }
 318
 319 static void check_mode_change(void)
 320 {
 321     static int current_is_absolute, current_has_absolute;
 322     int is_absolute;
 323     int has_absolute;
 324
 325     is_absolute = kbd_mouse_is_absolute();
 326     has_absolute = kbd_mouse_has_absolute();
 327
 328     if (is_absolute != current_is_absolute ||
 329         has_absolute != current_has_absolute) {
 330         notifier_list_notify(&mouse_mode_notifiers, NULL);
 331     }
 332
 333     current_is_absolute = is_absolute;
 334     current_has_absolute = has_absolute;
 335 }
 336
 337 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
 338                                                 void *opaque, int absolute,
 339                                                 const char *name)
 340 {
 341     QEMUPutMouseEntry *s;
 342     static int mouse_index = 0;
 343
 344     s = g_malloc0(sizeof(QEMUPutMouseEntry));
 345
 346     s->qemu_put_mouse_event = func;
 347     s->qemu_put_mouse_event_opaque = opaque;
 348     s->qemu_put_mouse_event_absolute = absolute;
 349     s->qemu_put_mouse_event_name = g_strdup(name);
 350     s->index = mouse_index++;
 351
 352     QTAILQ_INSERT_TAIL(&mouse_handlers, s, node);
 353
 354     check_mode_change();
 355
 356     return s;
 357 }
 358
 359 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry)
 360 {
 361     QTAILQ_REMOVE(&mouse_handlers, entry, node);
 362     QTAILQ_INSERT_HEAD(&mouse_handlers, entry, node);
 363
 364     check_mode_change();
 365 }
 366
 367 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry)
 368 {
 369     QTAILQ_REMOVE(&mouse_handlers, entry, node);
 370
 371     g_free(entry->qemu_put_mouse_event_name);
 372     g_free(entry);
 373
 374     check_mode_change();
 375 }
 376
 377 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func,
 378                                             void *opaque)
 379 {
 380     QEMUPutLEDEntry *s;
 381
 382     s = g_malloc0(sizeof(QEMUPutLEDEntry));
 383
 384     s->put_led = func;
 385     s->opaque = opaque;
 386     QTAILQ_INSERT_TAIL(&led_handlers, s, next);
 387     return s;
 388 }
 389
 390 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry)
 391 {
 392     if (entry == NULL)
 393         return;
 394     QTAILQ_REMOVE(&led_handlers, entry, next);
 395     g_free(entry);
 396 }
 397
 398 void kbd_put_keycode(int keycode)
 399 {
 400     if (!runstate_is_running() && !runstate_check(RUN_STATE_SUSPENDED)) {
 401         return;
 402     }
 403     if (qemu_put_kbd_event) {
 404         qemu_put_kbd_event(qemu_put_kbd_event_opaque, keycode);
 405     }
 406 }
 407
 408 void kbd_put_ledstate(int ledstate)
 409 {
 410     QEMUPutLEDEntry *cursor;
 411
 412     QTAILQ_FOREACH(cursor, &led_handlers, next) {
 413         cursor->put_led(cursor->opaque, ledstate);
 414     }
 415 }
 416
 417 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state)
 418 {
 419     QEMUPutMouseEntry *entry;
 420     QEMUPutMouseEvent *mouse_event;
 421     void *mouse_event_opaque;
 422     int width, height;
 423
 424     if (!runstate_is_running() && !runstate_check(RUN_STATE_SUSPENDED)) {
 425         return;
 426     }
 427     if (QTAILQ_EMPTY(&mouse_handlers)) {
 428         return;
 429     }
 430
 431     entry = QTAILQ_FIRST(&mouse_handlers);
 432
 433     mouse_event = entry->qemu_put_mouse_event;
 434     mouse_event_opaque = entry->qemu_put_mouse_event_opaque;
 435
 436     if (mouse_event) {
 437         if (entry->qemu_put_mouse_event_absolute) {
 438             width = 0x7fff;
 439             height = 0x7fff;
 440         } else {
 441             width = graphic_width - 1;
 442             height = graphic_height - 1;
 443         }
 444
 445         switch (graphic_rotate) {
 446         case 0:
 447             mouse_event(mouse_event_opaque,
 448                         dx, dy, dz, buttons_state);
 449             break;
 450         case 90:
 451             mouse_event(mouse_event_opaque,
 452                         width - dy, dx, dz, buttons_state);
 453             break;
 454         case 180:
 455             mouse_event(mouse_event_opaque,
 456                         width - dx, height - dy, dz, buttons_state);
 457             break;
 458         case 270:
 459             mouse_event(mouse_event_opaque,
 460                         dy, height - dx, dz, buttons_state);
 461             break;
 462         }
 463     }
 464 }
 465
 466 int kbd_mouse_is_absolute(void)
 467 {
 468     if (QTAILQ_EMPTY(&mouse_handlers)) {
 469         return 0;
 470     }
 471
 472     return QTAILQ_FIRST(&mouse_handlers)->qemu_put_mouse_event_absolute;
 473 }
 474
 475 int kbd_mouse_has_absolute(void)
 476 {
 477     QEMUPutMouseEntry *entry;
 478
 479     QTAILQ_FOREACH(entry, &mouse_handlers, node) {
 480         if (entry->qemu_put_mouse_event_absolute) {
 481             return 1;
 482         }
 483     }
 484
 485     return 0;
 486 }
 487
 488 MouseInfoList *qmp_query_mice(Error **errp)
 489 {
 490     MouseInfoList *mice_list = NULL;
 491     QEMUPutMouseEntry *cursor;
 492     bool current = true;
 493
 494     QTAILQ_FOREACH(cursor, &mouse_handlers, node) {
 495         MouseInfoList *info = g_malloc0(sizeof(*info));
 496         info->value = g_malloc0(sizeof(*info->value));
 497         info->value->name = g_strdup(cursor->qemu_put_mouse_event_name);
 498         info->value->index = cursor->index;
 499         info->value->absolute = !!cursor->qemu_put_mouse_event_absolute;
 500         info->value->current = current;
 501
 502         current = false;
 503
 504         info->next = mice_list;
 505         mice_list = info;
 506     }
 507
 508     return mice_list;
 509 }
 510
 511 void do_mouse_set(Monitor *mon, const QDict *qdict)
 512 {
 513     QEMUPutMouseEntry *cursor;
 514     int index = qdict_get_int(qdict, "index");
 515     int found = 0;
 516
 517     if (QTAILQ_EMPTY(&mouse_handlers)) {
 518         monitor_printf(mon, "No mouse devices connected\n");
 519         return;
 520     }
 521
 522     QTAILQ_FOREACH(cursor, &mouse_handlers, node) {
 523         if (cursor->index == index) {
 524             found = 1;
 525             qemu_activate_mouse_event_handler(cursor);
 526             break;
 527         }
 528     }
 529
 530     if (!found) {
 531         monitor_printf(mon, "Mouse at given index not found\n");
 532     }
 533
 534     check_mode_change();
 535 }
 536
 537 void qemu_add_mouse_mode_change_notifier(Notifier *notify)
 538 {
 539     notifier_list_add(&mouse_mode_notifiers, notify);
 540 }
 541
 542 void qemu_remove_mouse_mode_change_notifier(Notifier *notify)
 543 {
 544     notifier_remove(notify);
 545 }