qemu/hw/input/adb-kbd.c
<<
>>
Prefs
   1/*
   2 * QEMU ADB keyboard support
   3 *
   4 * Copyright (c) 2004 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 "qemu/osdep.h"
  26#include "hw/input/adb.h"
  27#include "migration/vmstate.h"
  28#include "qemu/module.h"
  29#include "ui/input.h"
  30#include "hw/input/adb-keys.h"
  31#include "adb-internal.h"
  32#include "trace.h"
  33#include "qom/object.h"
  34
  35OBJECT_DECLARE_TYPE(KBDState, ADBKeyboardClass, ADB_KEYBOARD)
  36
  37struct KBDState {
  38    /*< private >*/
  39    ADBDevice parent_obj;
  40    /*< public >*/
  41
  42    uint8_t data[128];
  43    int rptr, wptr, count;
  44};
  45
  46
  47struct ADBKeyboardClass {
  48    /*< private >*/
  49    ADBDeviceClass parent_class;
  50    /*< public >*/
  51
  52    DeviceRealize parent_realize;
  53};
  54
  55/* The adb keyboard doesn't have every key imaginable */
  56#define NO_KEY 0xff
  57
  58int qcode_to_adb_keycode[] = {
  59     /* Make sure future additions are automatically set to NO_KEY */
  60    [0 ... 0xff]               = NO_KEY,
  61
  62    [Q_KEY_CODE_SHIFT]         = ADB_KEY_LEFT_SHIFT,
  63    [Q_KEY_CODE_SHIFT_R]       = ADB_KEY_RIGHT_SHIFT,
  64    [Q_KEY_CODE_ALT]           = ADB_KEY_LEFT_OPTION,
  65    [Q_KEY_CODE_ALT_R]         = ADB_KEY_RIGHT_OPTION,
  66    [Q_KEY_CODE_CTRL]          = ADB_KEY_LEFT_CONTROL,
  67    [Q_KEY_CODE_CTRL_R]        = ADB_KEY_RIGHT_CONTROL,
  68    [Q_KEY_CODE_META_L]        = ADB_KEY_COMMAND,
  69    [Q_KEY_CODE_META_R]        = ADB_KEY_COMMAND,
  70    [Q_KEY_CODE_SPC]           = ADB_KEY_SPACEBAR,
  71
  72    [Q_KEY_CODE_ESC]           = ADB_KEY_ESC,
  73    [Q_KEY_CODE_1]             = ADB_KEY_1,
  74    [Q_KEY_CODE_2]             = ADB_KEY_2,
  75    [Q_KEY_CODE_3]             = ADB_KEY_3,
  76    [Q_KEY_CODE_4]             = ADB_KEY_4,
  77    [Q_KEY_CODE_5]             = ADB_KEY_5,
  78    [Q_KEY_CODE_6]             = ADB_KEY_6,
  79    [Q_KEY_CODE_7]             = ADB_KEY_7,
  80    [Q_KEY_CODE_8]             = ADB_KEY_8,
  81    [Q_KEY_CODE_9]             = ADB_KEY_9,
  82    [Q_KEY_CODE_0]             = ADB_KEY_0,
  83    [Q_KEY_CODE_MINUS]         = ADB_KEY_MINUS,
  84    [Q_KEY_CODE_EQUAL]         = ADB_KEY_EQUAL,
  85    [Q_KEY_CODE_BACKSPACE]     = ADB_KEY_DELETE,
  86    [Q_KEY_CODE_TAB]           = ADB_KEY_TAB,
  87    [Q_KEY_CODE_Q]             = ADB_KEY_Q,
  88    [Q_KEY_CODE_W]             = ADB_KEY_W,
  89    [Q_KEY_CODE_E]             = ADB_KEY_E,
  90    [Q_KEY_CODE_R]             = ADB_KEY_R,
  91    [Q_KEY_CODE_T]             = ADB_KEY_T,
  92    [Q_KEY_CODE_Y]             = ADB_KEY_Y,
  93    [Q_KEY_CODE_U]             = ADB_KEY_U,
  94    [Q_KEY_CODE_I]             = ADB_KEY_I,
  95    [Q_KEY_CODE_O]             = ADB_KEY_O,
  96    [Q_KEY_CODE_P]             = ADB_KEY_P,
  97    [Q_KEY_CODE_BRACKET_LEFT]  = ADB_KEY_LEFT_BRACKET,
  98    [Q_KEY_CODE_BRACKET_RIGHT] = ADB_KEY_RIGHT_BRACKET,
  99    [Q_KEY_CODE_RET]           = ADB_KEY_RETURN,
 100    [Q_KEY_CODE_A]             = ADB_KEY_A,
 101    [Q_KEY_CODE_S]             = ADB_KEY_S,
 102    [Q_KEY_CODE_D]             = ADB_KEY_D,
 103    [Q_KEY_CODE_F]             = ADB_KEY_F,
 104    [Q_KEY_CODE_G]             = ADB_KEY_G,
 105    [Q_KEY_CODE_H]             = ADB_KEY_H,
 106    [Q_KEY_CODE_J]             = ADB_KEY_J,
 107    [Q_KEY_CODE_K]             = ADB_KEY_K,
 108    [Q_KEY_CODE_L]             = ADB_KEY_L,
 109    [Q_KEY_CODE_SEMICOLON]     = ADB_KEY_SEMICOLON,
 110    [Q_KEY_CODE_APOSTROPHE]    = ADB_KEY_APOSTROPHE,
 111    [Q_KEY_CODE_GRAVE_ACCENT]  = ADB_KEY_GRAVE_ACCENT,
 112    [Q_KEY_CODE_BACKSLASH]     = ADB_KEY_BACKSLASH,
 113    [Q_KEY_CODE_Z]             = ADB_KEY_Z,
 114    [Q_KEY_CODE_X]             = ADB_KEY_X,
 115    [Q_KEY_CODE_C]             = ADB_KEY_C,
 116    [Q_KEY_CODE_V]             = ADB_KEY_V,
 117    [Q_KEY_CODE_B]             = ADB_KEY_B,
 118    [Q_KEY_CODE_N]             = ADB_KEY_N,
 119    [Q_KEY_CODE_M]             = ADB_KEY_M,
 120    [Q_KEY_CODE_COMMA]         = ADB_KEY_COMMA,
 121    [Q_KEY_CODE_DOT]           = ADB_KEY_PERIOD,
 122    [Q_KEY_CODE_SLASH]         = ADB_KEY_FORWARD_SLASH,
 123    [Q_KEY_CODE_ASTERISK]      = ADB_KEY_KP_MULTIPLY,
 124    [Q_KEY_CODE_CAPS_LOCK]     = ADB_KEY_CAPS_LOCK,
 125
 126    [Q_KEY_CODE_F1]            = ADB_KEY_F1,
 127    [Q_KEY_CODE_F2]            = ADB_KEY_F2,
 128    [Q_KEY_CODE_F3]            = ADB_KEY_F3,
 129    [Q_KEY_CODE_F4]            = ADB_KEY_F4,
 130    [Q_KEY_CODE_F5]            = ADB_KEY_F5,
 131    [Q_KEY_CODE_F6]            = ADB_KEY_F6,
 132    [Q_KEY_CODE_F7]            = ADB_KEY_F7,
 133    [Q_KEY_CODE_F8]            = ADB_KEY_F8,
 134    [Q_KEY_CODE_F9]            = ADB_KEY_F9,
 135    [Q_KEY_CODE_F10]           = ADB_KEY_F10,
 136    [Q_KEY_CODE_F11]           = ADB_KEY_F11,
 137    [Q_KEY_CODE_F12]           = ADB_KEY_F12,
 138    [Q_KEY_CODE_PRINT]         = ADB_KEY_F13,
 139    [Q_KEY_CODE_SYSRQ]         = ADB_KEY_F13,
 140    [Q_KEY_CODE_SCROLL_LOCK]   = ADB_KEY_F14,
 141    [Q_KEY_CODE_PAUSE]         = ADB_KEY_F15,
 142
 143    [Q_KEY_CODE_NUM_LOCK]      = ADB_KEY_KP_CLEAR,
 144    [Q_KEY_CODE_KP_EQUALS]     = ADB_KEY_KP_EQUAL,
 145    [Q_KEY_CODE_KP_DIVIDE]     = ADB_KEY_KP_DIVIDE,
 146    [Q_KEY_CODE_KP_MULTIPLY]   = ADB_KEY_KP_MULTIPLY,
 147    [Q_KEY_CODE_KP_SUBTRACT]   = ADB_KEY_KP_SUBTRACT,
 148    [Q_KEY_CODE_KP_ADD]        = ADB_KEY_KP_PLUS,
 149    [Q_KEY_CODE_KP_ENTER]      = ADB_KEY_KP_ENTER,
 150    [Q_KEY_CODE_KP_DECIMAL]    = ADB_KEY_KP_PERIOD,
 151    [Q_KEY_CODE_KP_0]          = ADB_KEY_KP_0,
 152    [Q_KEY_CODE_KP_1]          = ADB_KEY_KP_1,
 153    [Q_KEY_CODE_KP_2]          = ADB_KEY_KP_2,
 154    [Q_KEY_CODE_KP_3]          = ADB_KEY_KP_3,
 155    [Q_KEY_CODE_KP_4]          = ADB_KEY_KP_4,
 156    [Q_KEY_CODE_KP_5]          = ADB_KEY_KP_5,
 157    [Q_KEY_CODE_KP_6]          = ADB_KEY_KP_6,
 158    [Q_KEY_CODE_KP_7]          = ADB_KEY_KP_7,
 159    [Q_KEY_CODE_KP_8]          = ADB_KEY_KP_8,
 160    [Q_KEY_CODE_KP_9]          = ADB_KEY_KP_9,
 161
 162    [Q_KEY_CODE_UP]            = ADB_KEY_UP,
 163    [Q_KEY_CODE_DOWN]          = ADB_KEY_DOWN,
 164    [Q_KEY_CODE_LEFT]          = ADB_KEY_LEFT,
 165    [Q_KEY_CODE_RIGHT]         = ADB_KEY_RIGHT,
 166
 167    [Q_KEY_CODE_HELP]          = ADB_KEY_HELP,
 168    [Q_KEY_CODE_INSERT]        = ADB_KEY_HELP,
 169    [Q_KEY_CODE_DELETE]        = ADB_KEY_FORWARD_DELETE,
 170    [Q_KEY_CODE_HOME]          = ADB_KEY_HOME,
 171    [Q_KEY_CODE_END]           = ADB_KEY_END,
 172    [Q_KEY_CODE_PGUP]          = ADB_KEY_PAGE_UP,
 173    [Q_KEY_CODE_PGDN]          = ADB_KEY_PAGE_DOWN,
 174
 175    [Q_KEY_CODE_POWER]         = ADB_KEY_POWER
 176};
 177
 178static void adb_kbd_put_keycode(void *opaque, int keycode)
 179{
 180    KBDState *s = opaque;
 181
 182    if (s->count < sizeof(s->data)) {
 183        s->data[s->wptr] = keycode;
 184        if (++s->wptr == sizeof(s->data)) {
 185            s->wptr = 0;
 186        }
 187        s->count++;
 188    }
 189}
 190
 191static int adb_kbd_poll(ADBDevice *d, uint8_t *obuf)
 192{
 193    KBDState *s = ADB_KEYBOARD(d);
 194    int keycode;
 195
 196    if (s->count == 0) {
 197        return 0;
 198    }
 199    keycode = s->data[s->rptr];
 200    s->rptr++;
 201    if (s->rptr == sizeof(s->data)) {
 202        s->rptr = 0;
 203    }
 204    s->count--;
 205    /*
 206     * The power key is the only two byte value key, so it is a special case.
 207     * Since 0x7f is not a used keycode for ADB we overload it to indicate the
 208     * power button when we're storing keycodes in our internal buffer, and
 209     * expand it out to two bytes when we send to the guest.
 210     */
 211    if (keycode == 0x7f) {
 212        obuf[0] = 0x7f;
 213        obuf[1] = 0x7f;
 214    } else {
 215        obuf[0] = keycode;
 216        /* NOTE: the power key key-up is the two byte sequence 0xff 0xff;
 217         * otherwise we could in theory send a second keycode in the second
 218         * byte, but choose not to bother.
 219         */
 220        obuf[1] = 0xff;
 221    }
 222
 223    return 2;
 224}
 225
 226static int adb_kbd_request(ADBDevice *d, uint8_t *obuf,
 227                           const uint8_t *buf, int len)
 228{
 229    KBDState *s = ADB_KEYBOARD(d);
 230    int cmd, reg, olen;
 231
 232    if ((buf[0] & 0x0f) == ADB_FLUSH) {
 233        /* flush keyboard fifo */
 234        s->wptr = s->rptr = s->count = 0;
 235        return 0;
 236    }
 237
 238    cmd = buf[0] & 0xc;
 239    reg = buf[0] & 0x3;
 240    olen = 0;
 241    switch (cmd) {
 242    case ADB_WRITEREG:
 243        trace_adb_device_kbd_writereg(reg, buf[1]);
 244        switch (reg) {
 245        case 2:
 246            /* LED status */
 247            break;
 248        case 3:
 249            switch (buf[2]) {
 250            case ADB_CMD_SELF_TEST:
 251                break;
 252            case ADB_CMD_CHANGE_ID:
 253            case ADB_CMD_CHANGE_ID_AND_ACT:
 254            case ADB_CMD_CHANGE_ID_AND_ENABLE:
 255                d->devaddr = buf[1] & 0xf;
 256                trace_adb_device_kbd_request_change_addr(d->devaddr);
 257                break;
 258            default:
 259                d->devaddr = buf[1] & 0xf;
 260                /*
 261                 * we support handlers:
 262                 * 1: Apple Standard Keyboard
 263                 * 2: Apple Extended Keyboard (LShift = RShift)
 264                 * 3: Apple Extended Keyboard (LShift != RShift)
 265                 */
 266                if (buf[2] == 1 || buf[2] == 2 || buf[2] == 3) {
 267                    d->handler = buf[2];
 268                }
 269
 270                trace_adb_device_kbd_request_change_addr_and_handler(
 271                    d->devaddr, d->handler);
 272                break;
 273            }
 274        }
 275        break;
 276    case ADB_READREG:
 277        switch (reg) {
 278        case 0:
 279            olen = adb_kbd_poll(d, obuf);
 280            break;
 281        case 1:
 282            break;
 283        case 2:
 284            obuf[0] = 0x00; /* XXX: check this */
 285            obuf[1] = 0x07; /* led status */
 286            olen = 2;
 287            break;
 288        case 3:
 289            obuf[0] = d->devaddr;
 290            obuf[1] = d->handler;
 291            olen = 2;
 292            break;
 293        }
 294        trace_adb_device_kbd_readreg(reg, obuf[0], obuf[1]);
 295        break;
 296    }
 297    return olen;
 298}
 299
 300static bool adb_kbd_has_data(ADBDevice *d)
 301{
 302    KBDState *s = ADB_KEYBOARD(d);
 303
 304    return s->count > 0;
 305}
 306
 307/* This is where keyboard events enter this file */
 308static void adb_keyboard_event(DeviceState *dev, QemuConsole *src,
 309                               InputEvent *evt)
 310{
 311    KBDState *s = (KBDState *)dev;
 312    int qcode, keycode;
 313
 314    qcode = qemu_input_key_value_to_qcode(evt->u.key.data->key);
 315    if (qcode >= ARRAY_SIZE(qcode_to_adb_keycode)) {
 316        return;
 317    }
 318    /* FIXME: take handler into account when translating qcode */
 319    keycode = qcode_to_adb_keycode[qcode];
 320    if (keycode == NO_KEY) {  /* We don't want to send this to the guest */
 321        trace_adb_device_kbd_no_key();
 322        return;
 323    }
 324    if (evt->u.key.data->down == false) { /* if key release event */
 325        keycode = keycode | 0x80;   /* create keyboard break code */
 326    }
 327
 328    adb_kbd_put_keycode(s, keycode);
 329}
 330
 331static const VMStateDescription vmstate_adb_kbd = {
 332    .name = "adb_kbd",
 333    .version_id = 2,
 334    .minimum_version_id = 2,
 335    .fields = (VMStateField[]) {
 336        VMSTATE_STRUCT(parent_obj, KBDState, 0, vmstate_adb_device, ADBDevice),
 337        VMSTATE_BUFFER(data, KBDState),
 338        VMSTATE_INT32(rptr, KBDState),
 339        VMSTATE_INT32(wptr, KBDState),
 340        VMSTATE_INT32(count, KBDState),
 341        VMSTATE_END_OF_LIST()
 342    }
 343};
 344
 345static void adb_kbd_reset(DeviceState *dev)
 346{
 347    ADBDevice *d = ADB_DEVICE(dev);
 348    KBDState *s = ADB_KEYBOARD(dev);
 349
 350    d->handler = 1;
 351    d->devaddr = ADB_DEVID_KEYBOARD;
 352    memset(s->data, 0, sizeof(s->data));
 353    s->rptr = 0;
 354    s->wptr = 0;
 355    s->count = 0;
 356}
 357
 358static QemuInputHandler adb_keyboard_handler = {
 359    .name  = "QEMU ADB Keyboard",
 360    .mask  = INPUT_EVENT_MASK_KEY,
 361    .event = adb_keyboard_event,
 362};
 363
 364static void adb_kbd_realizefn(DeviceState *dev, Error **errp)
 365{
 366    ADBKeyboardClass *akc = ADB_KEYBOARD_GET_CLASS(dev);
 367    akc->parent_realize(dev, errp);
 368    qemu_input_handler_register(dev, &adb_keyboard_handler);
 369}
 370
 371static void adb_kbd_initfn(Object *obj)
 372{
 373    ADBDevice *d = ADB_DEVICE(obj);
 374
 375    d->devaddr = ADB_DEVID_KEYBOARD;
 376}
 377
 378static void adb_kbd_class_init(ObjectClass *oc, void *data)
 379{
 380    DeviceClass *dc = DEVICE_CLASS(oc);
 381    ADBDeviceClass *adc = ADB_DEVICE_CLASS(oc);
 382    ADBKeyboardClass *akc = ADB_KEYBOARD_CLASS(oc);
 383
 384    device_class_set_parent_realize(dc, adb_kbd_realizefn,
 385                                    &akc->parent_realize);
 386    set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
 387
 388    adc->devreq = adb_kbd_request;
 389    adc->devhasdata = adb_kbd_has_data;
 390    dc->reset = adb_kbd_reset;
 391    dc->vmsd = &vmstate_adb_kbd;
 392}
 393
 394static const TypeInfo adb_kbd_type_info = {
 395    .name = TYPE_ADB_KEYBOARD,
 396    .parent = TYPE_ADB_DEVICE,
 397    .instance_size = sizeof(KBDState),
 398    .instance_init = adb_kbd_initfn,
 399    .class_init = adb_kbd_class_init,
 400    .class_size = sizeof(ADBKeyboardClass),
 401};
 402
 403static void adb_kbd_register_types(void)
 404{
 405    type_register_static(&adb_kbd_type_info);
 406}
 407
 408type_init(adb_kbd_register_types)
 409