hw/input/virtio-input-hid.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/iov.h"
   8
   9 #include "hw/qdev.h"
  10 #include "hw/virtio/virtio.h"
  11 #include "hw/virtio/virtio-input.h"
  12
  13 #undef CONFIG_CURSES
  14 #include "ui/console.h"
  15
  16 #include "standard-headers/linux/input.h"
  17
  18 #define VIRTIO_ID_NAME_KEYBOARD "QEMU Virtio Keyboard"
  19 #define VIRTIO_ID_NAME_MOUSE    "QEMU Virtio Mouse"
  20 #define VIRTIO_ID_NAME_TABLET   "QEMU Virtio Tablet"
  21
  22 /* ----------------------------------------------------------------- */
  23
  24 static const unsigned int keymap_qcode[Q_KEY_CODE_MAX] = {
  25     [Q_KEY_CODE_ESC]                 = KEY_ESC,
  26     [Q_KEY_CODE_1]                   = KEY_1,
  27     [Q_KEY_CODE_2]                   = KEY_2,
  28     [Q_KEY_CODE_3]                   = KEY_3,
  29     [Q_KEY_CODE_4]                   = KEY_4,
  30     [Q_KEY_CODE_5]                   = KEY_5,
  31     [Q_KEY_CODE_6]                   = KEY_6,
  32     [Q_KEY_CODE_7]                   = KEY_7,
  33     [Q_KEY_CODE_8]                   = KEY_8,
  34     [Q_KEY_CODE_9]                   = KEY_9,
  35     [Q_KEY_CODE_0]                   = KEY_0,
  36     [Q_KEY_CODE_MINUS]               = KEY_MINUS,
  37     [Q_KEY_CODE_EQUAL]               = KEY_EQUAL,
  38     [Q_KEY_CODE_BACKSPACE]           = KEY_BACKSPACE,
  39
  40     [Q_KEY_CODE_TAB]                 = KEY_TAB,
  41     [Q_KEY_CODE_Q]                   = KEY_Q,
  42     [Q_KEY_CODE_W]                   = KEY_W,
  43     [Q_KEY_CODE_E]                   = KEY_E,
  44     [Q_KEY_CODE_R]                   = KEY_R,
  45     [Q_KEY_CODE_T]                   = KEY_T,
  46     [Q_KEY_CODE_Y]                   = KEY_Y,
  47     [Q_KEY_CODE_U]                   = KEY_U,
  48     [Q_KEY_CODE_I]                   = KEY_I,
  49     [Q_KEY_CODE_O]                   = KEY_O,
  50     [Q_KEY_CODE_P]                   = KEY_P,
  51     [Q_KEY_CODE_BRACKET_LEFT]        = KEY_LEFTBRACE,
  52     [Q_KEY_CODE_BRACKET_RIGHT]       = KEY_RIGHTBRACE,
  53     [Q_KEY_CODE_RET]                 = KEY_ENTER,
  54
  55     [Q_KEY_CODE_CTRL]                = KEY_LEFTCTRL,
  56     [Q_KEY_CODE_A]                   = KEY_A,
  57     [Q_KEY_CODE_S]                   = KEY_S,
  58     [Q_KEY_CODE_D]                   = KEY_D,
  59     [Q_KEY_CODE_F]                   = KEY_F,
  60     [Q_KEY_CODE_G]                   = KEY_G,
  61     [Q_KEY_CODE_H]                   = KEY_H,
  62     [Q_KEY_CODE_J]                   = KEY_J,
  63     [Q_KEY_CODE_K]                   = KEY_K,
  64     [Q_KEY_CODE_L]                   = KEY_L,
  65     [Q_KEY_CODE_SEMICOLON]           = KEY_SEMICOLON,
  66     [Q_KEY_CODE_APOSTROPHE]          = KEY_APOSTROPHE,
  67     [Q_KEY_CODE_GRAVE_ACCENT]        = KEY_GRAVE,
  68
  69     [Q_KEY_CODE_SHIFT]               = KEY_LEFTSHIFT,
  70     [Q_KEY_CODE_BACKSLASH]           = KEY_BACKSLASH,
  71     [Q_KEY_CODE_LESS]                = KEY_102ND,
  72     [Q_KEY_CODE_Z]                   = KEY_Z,
  73     [Q_KEY_CODE_X]                   = KEY_X,
  74     [Q_KEY_CODE_C]                   = KEY_C,
  75     [Q_KEY_CODE_V]                   = KEY_V,
  76     [Q_KEY_CODE_B]                   = KEY_B,
  77     [Q_KEY_CODE_N]                   = KEY_N,
  78     [Q_KEY_CODE_M]                   = KEY_M,
  79     [Q_KEY_CODE_COMMA]               = KEY_COMMA,
  80     [Q_KEY_CODE_DOT]                 = KEY_DOT,
  81     [Q_KEY_CODE_SLASH]               = KEY_SLASH,
  82     [Q_KEY_CODE_SHIFT_R]             = KEY_RIGHTSHIFT,
  83
  84     [Q_KEY_CODE_ALT]                 = KEY_LEFTALT,
  85     [Q_KEY_CODE_SPC]                 = KEY_SPACE,
  86     [Q_KEY_CODE_CAPS_LOCK]           = KEY_CAPSLOCK,
  87
  88     [Q_KEY_CODE_F1]                  = KEY_F1,
  89     [Q_KEY_CODE_F2]                  = KEY_F2,
  90     [Q_KEY_CODE_F3]                  = KEY_F3,
  91     [Q_KEY_CODE_F4]                  = KEY_F4,
  92     [Q_KEY_CODE_F5]                  = KEY_F5,
  93     [Q_KEY_CODE_F6]                  = KEY_F6,
  94     [Q_KEY_CODE_F7]                  = KEY_F7,
  95     [Q_KEY_CODE_F8]                  = KEY_F8,
  96     [Q_KEY_CODE_F9]                  = KEY_F9,
  97     [Q_KEY_CODE_F10]                 = KEY_F10,
  98     [Q_KEY_CODE_NUM_LOCK]            = KEY_NUMLOCK,
  99     [Q_KEY_CODE_SCROLL_LOCK]         = KEY_SCROLLLOCK,
 100
 101     [Q_KEY_CODE_KP_0]                = KEY_KP0,
 102     [Q_KEY_CODE_KP_1]                = KEY_KP1,
 103     [Q_KEY_CODE_KP_2]                = KEY_KP2,
 104     [Q_KEY_CODE_KP_3]                = KEY_KP3,
 105     [Q_KEY_CODE_KP_4]                = KEY_KP4,
 106     [Q_KEY_CODE_KP_5]                = KEY_KP5,
 107     [Q_KEY_CODE_KP_6]                = KEY_KP6,
 108     [Q_KEY_CODE_KP_7]                = KEY_KP7,
 109     [Q_KEY_CODE_KP_8]                = KEY_KP8,
 110     [Q_KEY_CODE_KP_9]                = KEY_KP9,
 111     [Q_KEY_CODE_KP_SUBTRACT]         = KEY_KPMINUS,
 112     [Q_KEY_CODE_KP_ADD]              = KEY_KPPLUS,
 113     [Q_KEY_CODE_KP_DECIMAL]          = KEY_KPDOT,
 114     [Q_KEY_CODE_KP_ENTER]            = KEY_KPENTER,
 115     [Q_KEY_CODE_KP_DIVIDE]           = KEY_KPSLASH,
 116     [Q_KEY_CODE_KP_MULTIPLY]         = KEY_KPASTERISK,
 117
 118     [Q_KEY_CODE_F11]                 = KEY_F11,
 119     [Q_KEY_CODE_F12]                 = KEY_F12,
 120
 121     [Q_KEY_CODE_CTRL_R]              = KEY_RIGHTCTRL,
 122     [Q_KEY_CODE_SYSRQ]               = KEY_SYSRQ,
 123     [Q_KEY_CODE_ALT_R]               = KEY_RIGHTALT,
 124
 125     [Q_KEY_CODE_HOME]                = KEY_HOME,
 126     [Q_KEY_CODE_UP]                  = KEY_UP,
 127     [Q_KEY_CODE_PGUP]                = KEY_PAGEUP,
 128     [Q_KEY_CODE_LEFT]                = KEY_LEFT,
 129     [Q_KEY_CODE_RIGHT]               = KEY_RIGHT,
 130     [Q_KEY_CODE_END]                 = KEY_END,
 131     [Q_KEY_CODE_DOWN]                = KEY_DOWN,
 132     [Q_KEY_CODE_PGDN]                = KEY_PAGEDOWN,
 133     [Q_KEY_CODE_INSERT]              = KEY_INSERT,
 134     [Q_KEY_CODE_DELETE]              = KEY_DELETE,
 135
 136     [Q_KEY_CODE_META_L]              = KEY_LEFTMETA,
 137     [Q_KEY_CODE_META_R]              = KEY_RIGHTMETA,
 138     [Q_KEY_CODE_MENU]                = KEY_MENU,
 139 };
 140
 141 static const unsigned int keymap_button[INPUT_BUTTON_MAX] = {
 142     [INPUT_BUTTON_LEFT]              = BTN_LEFT,
 143     [INPUT_BUTTON_RIGHT]             = BTN_RIGHT,
 144     [INPUT_BUTTON_MIDDLE]            = BTN_MIDDLE,
 145     [INPUT_BUTTON_WHEEL_UP]          = BTN_GEAR_UP,
 146     [INPUT_BUTTON_WHEEL_DOWN]        = BTN_GEAR_DOWN,
 147 };
 148
 149 static const unsigned int axismap_rel[INPUT_AXIS_MAX] = {
 150     [INPUT_AXIS_X]                   = REL_X,
 151     [INPUT_AXIS_Y]                   = REL_Y,
 152 };
 153
 154 static const unsigned int axismap_abs[INPUT_AXIS_MAX] = {
 155     [INPUT_AXIS_X]                   = ABS_X,
 156     [INPUT_AXIS_Y]                   = ABS_Y,
 157 };
 158
 159 /* ----------------------------------------------------------------- */
 160
 161 static void virtio_input_key_config(VirtIOInput *vinput,
 162                                     const unsigned int *keymap,
 163                                     size_t mapsize)
 164 {
 165     virtio_input_config keys;
 166     int i, bit, byte, bmax = 0;
 167
 168     memset(&keys, 0, sizeof(keys));
 169     for (i = 0; i < mapsize; i++) {
 170         bit = keymap[i];
 171         if (!bit) {
 172             continue;
 173         }
 174         byte = bit / 8;
 175         bit  = bit % 8;
 176         keys.u.bitmap[byte] |= (1 << bit);
 177         if (bmax < byte+1) {
 178             bmax = byte+1;
 179         }
 180     }
 181     keys.select = VIRTIO_INPUT_CFG_EV_BITS;
 182     keys.subsel = EV_KEY;
 183     keys.size   = bmax;
 184     virtio_input_add_config(vinput, &keys);
 185 }
 186
 187 static void virtio_input_handle_event(DeviceState *dev, QemuConsole *src,
 188                                       InputEvent *evt)
 189 {
 190     VirtIOInput *vinput = VIRTIO_INPUT(dev);
 191     virtio_input_event event;
 192     int qcode;
 193
 194     switch (evt->kind) {
 195     case INPUT_EVENT_KIND_KEY:
 196         qcode = qemu_input_key_value_to_qcode(evt->key->key);
 197         if (qcode && keymap_qcode[qcode]) {
 198             event.type  = cpu_to_le16(EV_KEY);
 199             event.code  = cpu_to_le16(keymap_qcode[qcode]);
 200             event.value = cpu_to_le32(evt->key->down ? 1 : 0);
 201             virtio_input_send(vinput, &event);
 202         } else {
 203             if (evt->key->down) {
 204                 fprintf(stderr, "%s: unmapped key: %d [%s]\n", __func__,
 205                         qcode, QKeyCode_lookup[qcode]);
 206             }
 207         }
 208         break;
 209     case INPUT_EVENT_KIND_BTN:
 210         if (keymap_button[evt->btn->button]) {
 211             event.type  = cpu_to_le16(EV_KEY);
 212             event.code  = cpu_to_le16(keymap_button[evt->btn->button]);
 213             event.value = cpu_to_le32(evt->btn->down ? 1 : 0);
 214             virtio_input_send(vinput, &event);
 215         } else {
 216             if (evt->btn->down) {
 217                 fprintf(stderr, "%s: unmapped button: %d [%s]\n", __func__,
 218                         evt->btn->button, InputButton_lookup[evt->btn->button]);
 219             }
 220         }
 221         break;
 222     case INPUT_EVENT_KIND_REL:
 223         event.type  = cpu_to_le16(EV_REL);
 224         event.code  = cpu_to_le16(axismap_rel[evt->rel->axis]);
 225         event.value = cpu_to_le32(evt->rel->value);
 226         virtio_input_send(vinput, &event);
 227         break;
 228     case INPUT_EVENT_KIND_ABS:
 229         event.type  = cpu_to_le16(EV_ABS);
 230         event.code  = cpu_to_le16(axismap_abs[evt->abs->axis]);
 231         event.value = cpu_to_le32(evt->abs->value);
 232         virtio_input_send(vinput, &event);
 233         break;
 234     default:
 235         /* keep gcc happy */
 236         break;
 237     }
 238 }
 239
 240 static void virtio_input_handle_sync(DeviceState *dev)
 241 {
 242     VirtIOInput *vinput = VIRTIO_INPUT(dev);
 243     virtio_input_event event = {
 244         .type  = cpu_to_le16(EV_SYN),
 245         .code  = cpu_to_le16(SYN_REPORT),
 246         .value = 0,
 247     };
 248
 249     virtio_input_send(vinput, &event);
 250 }
 251
 252 static void virtio_input_hid_realize(DeviceState *dev, Error **errp)
 253 {
 254     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(dev);
 255     vhid->hs = qemu_input_handler_register(dev, vhid->handler);
 256 }
 257
 258 static void virtio_input_hid_unrealize(DeviceState *dev, Error **errp)
 259 {
 260     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(dev);
 261     qemu_input_handler_unregister(vhid->hs);
 262 }
 263
 264 static void virtio_input_hid_change_active(VirtIOInput *vinput)
 265 {
 266     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(vinput);
 267
 268     if (vinput->active) {
 269         qemu_input_handler_activate(vhid->hs);
 270     } else {
 271         qemu_input_handler_deactivate(vhid->hs);
 272     }
 273 }
 274
 275 static void virtio_input_hid_handle_status(VirtIOInput *vinput,
 276                                            virtio_input_event *event)
 277 {
 278     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(vinput);
 279     int ledbit = 0;
 280
 281     switch (le16_to_cpu(event->type)) {
 282     case EV_LED:
 283         if (event->code == LED_NUML) {
 284             ledbit = QEMU_NUM_LOCK_LED;
 285         } else if (event->code == LED_CAPSL) {
 286             ledbit = QEMU_CAPS_LOCK_LED;
 287         } else if (event->code == LED_SCROLLL) {
 288             ledbit = QEMU_SCROLL_LOCK_LED;
 289         }
 290         if (event->value) {
 291             vhid->ledstate |= ledbit;
 292         } else {
 293             vhid->ledstate &= ~ledbit;
 294         }
 295         kbd_put_ledstate(vhid->ledstate);
 296         break;
 297     default:
 298         fprintf(stderr, "%s: unknown type %d\n", __func__,
 299                 le16_to_cpu(event->type));
 300         break;
 301     }
 302 }
 303
 304 static void virtio_input_hid_class_init(ObjectClass *klass, void *data)
 305 {
 306     VirtIOInputClass *vic = VIRTIO_INPUT_CLASS(klass);
 307
 308     vic->realize       = virtio_input_hid_realize;
 309     vic->unrealize     = virtio_input_hid_unrealize;
 310     vic->change_active = virtio_input_hid_change_active;
 311     vic->handle_status = virtio_input_hid_handle_status;
 312 }
 313
 314 static const TypeInfo virtio_input_hid_info = {
 315     .name          = TYPE_VIRTIO_INPUT_HID,
 316     .parent        = TYPE_VIRTIO_INPUT,
 317     .instance_size = sizeof(VirtIOInputHID),
 318     .class_init    = virtio_input_hid_class_init,
 319     .abstract      = true,
 320 };
 321
 322 /* ----------------------------------------------------------------- */
 323
 324 static QemuInputHandler virtio_keyboard_handler = {
 325     .name  = VIRTIO_ID_NAME_KEYBOARD,
 326     .mask  = INPUT_EVENT_MASK_KEY,
 327     .event = virtio_input_handle_event,
 328     .sync  = virtio_input_handle_sync,
 329 };
 330
 331 static struct virtio_input_config virtio_keyboard_config[] = {
 332     {
 333         .select    = VIRTIO_INPUT_CFG_ID_NAME,
 334         .size      = sizeof(VIRTIO_ID_NAME_KEYBOARD),
 335         .u.string  = VIRTIO_ID_NAME_KEYBOARD,
 336     },{
 337         .select    = VIRTIO_INPUT_CFG_ID_DEVIDS,
 338         .size      = sizeof(struct virtio_input_devids),
 339         .u.ids     = {
 340             .bustype = const_le16(BUS_VIRTUAL),
 341             .vendor  = const_le16(0x0627), /* same we use for usb hid devices */
 342             .product = const_le16(0x0001),
 343             .version = const_le16(0x0001),
 344         },
 345     },{
 346         .select    = VIRTIO_INPUT_CFG_EV_BITS,
 347         .subsel    = EV_REP,
 348         .size      = 1,
 349     },{
 350         .select    = VIRTIO_INPUT_CFG_EV_BITS,
 351         .subsel    = EV_LED,
 352         .size      = 1,
 353         .u.bitmap  = {
 354             (1 << LED_NUML) | (1 << LED_CAPSL) | (1 << LED_SCROLLL),
 355         },
 356     },
 357     { /* end of list */ },
 358 };
 359
 360 static void virtio_keyboard_init(Object *obj)
 361 {
 362     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(obj);
 363     VirtIOInput *vinput = VIRTIO_INPUT(obj);
 364
 365     vhid->handler = &virtio_keyboard_handler;
 366     virtio_input_init_config(vinput, virtio_keyboard_config);
 367     virtio_input_key_config(vinput, keymap_qcode,
 368                             ARRAY_SIZE(keymap_qcode));
 369 }
 370
 371 static const TypeInfo virtio_keyboard_info = {
 372     .name          = TYPE_VIRTIO_KEYBOARD,
 373     .parent        = TYPE_VIRTIO_INPUT_HID,
 374     .instance_size = sizeof(VirtIOInputHID),
 375     .instance_init = virtio_keyboard_init,
 376 };
 377
 378 /* ----------------------------------------------------------------- */
 379
 380 static QemuInputHandler virtio_mouse_handler = {
 381     .name  = VIRTIO_ID_NAME_MOUSE,
 382     .mask  = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_REL,
 383     .event = virtio_input_handle_event,
 384     .sync  = virtio_input_handle_sync,
 385 };
 386
 387 static struct virtio_input_config virtio_mouse_config[] = {
 388     {
 389         .select    = VIRTIO_INPUT_CFG_ID_NAME,
 390         .size      = sizeof(VIRTIO_ID_NAME_MOUSE),
 391         .u.string  = VIRTIO_ID_NAME_MOUSE,
 392     },{
 393         .select    = VIRTIO_INPUT_CFG_ID_DEVIDS,
 394         .size      = sizeof(struct virtio_input_devids),
 395         .u.ids     = {
 396             .bustype = const_le16(BUS_VIRTUAL),
 397             .vendor  = const_le16(0x0627), /* same we use for usb hid devices */
 398             .product = const_le16(0x0002),
 399             .version = const_le16(0x0001),
 400         },
 401     },{
 402         .select    = VIRTIO_INPUT_CFG_EV_BITS,
 403         .subsel    = EV_REL,
 404         .size      = 1,
 405         .u.bitmap  = {
 406             (1 << REL_X) | (1 << REL_Y),
 407         },
 408     },
 409     { /* end of list */ },
 410 };
 411
 412 static void virtio_mouse_init(Object *obj)
 413 {
 414     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(obj);
 415     VirtIOInput *vinput = VIRTIO_INPUT(obj);
 416
 417     vhid->handler = &virtio_mouse_handler;
 418     virtio_input_init_config(vinput, virtio_mouse_config);
 419     virtio_input_key_config(vinput, keymap_button,
 420                             ARRAY_SIZE(keymap_button));
 421 }
 422
 423 static const TypeInfo virtio_mouse_info = {
 424     .name          = TYPE_VIRTIO_MOUSE,
 425     .parent        = TYPE_VIRTIO_INPUT_HID,
 426     .instance_size = sizeof(VirtIOInputHID),
 427     .instance_init = virtio_mouse_init,
 428 };
 429
 430 /* ----------------------------------------------------------------- */
 431
 432 static QemuInputHandler virtio_tablet_handler = {
 433     .name  = VIRTIO_ID_NAME_TABLET,
 434     .mask  = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_ABS,
 435     .event = virtio_input_handle_event,
 436     .sync  = virtio_input_handle_sync,
 437 };
 438
 439 static struct virtio_input_config virtio_tablet_config[] = {
 440     {
 441         .select    = VIRTIO_INPUT_CFG_ID_NAME,
 442         .size      = sizeof(VIRTIO_ID_NAME_TABLET),
 443         .u.string  = VIRTIO_ID_NAME_TABLET,
 444     },{
 445         .select    = VIRTIO_INPUT_CFG_ID_DEVIDS,
 446         .size      = sizeof(struct virtio_input_devids),
 447         .u.ids     = {
 448             .bustype = const_le16(BUS_VIRTUAL),
 449             .vendor  = const_le16(0x0627), /* same we use for usb hid devices */
 450             .product = const_le16(0x0003),
 451             .version = const_le16(0x0001),
 452         },
 453     },{
 454         .select    = VIRTIO_INPUT_CFG_EV_BITS,
 455         .subsel    = EV_ABS,
 456         .size      = 1,
 457         .u.bitmap  = {
 458             (1 << ABS_X) | (1 << ABS_Y),
 459         },
 460     },{
 461         .select    = VIRTIO_INPUT_CFG_ABS_INFO,
 462         .subsel    = ABS_X,
 463         .size      = sizeof(virtio_input_absinfo),
 464         .u.abs.max = const_le32(INPUT_EVENT_ABS_SIZE),
 465     },{
 466         .select    = VIRTIO_INPUT_CFG_ABS_INFO,
 467         .subsel    = ABS_Y,
 468         .size      = sizeof(virtio_input_absinfo),
 469         .u.abs.max = const_le32(INPUT_EVENT_ABS_SIZE),
 470     },
 471     { /* end of list */ },
 472 };
 473
 474 static void virtio_tablet_init(Object *obj)
 475 {
 476     VirtIOInputHID *vhid = VIRTIO_INPUT_HID(obj);
 477     VirtIOInput *vinput = VIRTIO_INPUT(obj);
 478
 479     vhid->handler = &virtio_tablet_handler;
 480     virtio_input_init_config(vinput, virtio_tablet_config);
 481     virtio_input_key_config(vinput, keymap_button,
 482                             ARRAY_SIZE(keymap_button));
 483 }
 484
 485 static const TypeInfo virtio_tablet_info = {
 486     .name          = TYPE_VIRTIO_TABLET,
 487     .parent        = TYPE_VIRTIO_INPUT_HID,
 488     .instance_size = sizeof(VirtIOInputHID),
 489     .instance_init = virtio_tablet_init,
 490 };
 491
 492 /* ----------------------------------------------------------------- */
 493
 494 static void virtio_register_types(void)
 495 {
 496     type_register_static(&virtio_input_hid_info);
 497     type_register_static(&virtio_keyboard_info);
 498     type_register_static(&virtio_mouse_info);
 499     type_register_static(&virtio_tablet_info);
 500 }
 501
 502 type_init(virtio_register_types)