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