hw/pckbd.c

   1 /*
   2  * QEMU PC keyboard emulation
   3  *
   4  * Copyright (c) 2003 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 #include "vl.h"
  25
  26 /* debug PC keyboard */
  27 //#define DEBUG_KBD
  28
  29 /* debug PC keyboard : only mouse */
  30 //#define DEBUG_MOUSE
  31
  32 /*      Keyboard Controller Commands */
  33 #define KBD_CCMD_READ_MODE      0x20    /* Read mode bits */
  34 #define KBD_CCMD_WRITE_MODE     0x60    /* Write mode bits */
  35 #define KBD_CCMD_GET_VERSION    0xA1    /* Get controller version */
  36 #define KBD_CCMD_MOUSE_DISABLE  0xA7    /* Disable mouse interface */
  37 #define KBD_CCMD_MOUSE_ENABLE   0xA8    /* Enable mouse interface */
  38 #define KBD_CCMD_TEST_MOUSE     0xA9    /* Mouse interface test */
  39 #define KBD_CCMD_SELF_TEST      0xAA    /* Controller self test */
  40 #define KBD_CCMD_KBD_TEST       0xAB    /* Keyboard interface test */
  41 #define KBD_CCMD_KBD_DISABLE    0xAD    /* Keyboard interface disable */
  42 #define KBD_CCMD_KBD_ENABLE     0xAE    /* Keyboard interface enable */
  43 #define KBD_CCMD_READ_INPORT    0xC0    /* read input port */
  44 #define KBD_CCMD_READ_OUTPORT   0xD0    /* read output port */
  45 #define KBD_CCMD_WRITE_OUTPORT  0xD1    /* write output port */
  46 #define KBD_CCMD_WRITE_OBUF     0xD2
  47 #define KBD_CCMD_WRITE_AUX_OBUF 0xD3    /* Write to output buffer as if
  48                                            initiated by the auxiliary device */
  49 #define KBD_CCMD_WRITE_MOUSE    0xD4    /* Write the following byte to the mouse */
  50 #define KBD_CCMD_DISABLE_A20    0xDD    /* HP vectra only ? */
  51 #define KBD_CCMD_ENABLE_A20     0xDF    /* HP vectra only ? */
  52 #define KBD_CCMD_RESET          0xFE
  53
  54 /* Keyboard Commands */
  55 #define KBD_CMD_SET_LEDS        0xED    /* Set keyboard leds */
  56 #define KBD_CMD_ECHO            0xEE
  57 #define KBD_CMD_GET_ID          0xF2    /* get keyboard ID */
  58 #define KBD_CMD_SET_RATE        0xF3    /* Set typematic rate */
  59 #define KBD_CMD_ENABLE          0xF4    /* Enable scanning */
  60 #define KBD_CMD_RESET_DISABLE   0xF5    /* reset and disable scanning */
  61 #define KBD_CMD_RESET_ENABLE    0xF6    /* reset and enable scanning */
  62 #define KBD_CMD_RESET           0xFF    /* Reset */
  63
  64 /* Keyboard Replies */
  65 #define KBD_REPLY_POR           0xAA    /* Power on reset */
  66 #define KBD_REPLY_ACK           0xFA    /* Command ACK */
  67 #define KBD_REPLY_RESEND        0xFE    /* Command NACK, send the cmd again */
  68
  69 /* Status Register Bits */
  70 #define KBD_STAT_OBF            0x01    /* Keyboard output buffer full */
  71 #define KBD_STAT_IBF            0x02    /* Keyboard input buffer full */
  72 #define KBD_STAT_SELFTEST       0x04    /* Self test successful */
  73 #define KBD_STAT_CMD            0x08    /* Last write was a command write (0=data) */
  74 #define KBD_STAT_UNLOCKED       0x10    /* Zero if keyboard locked */
  75 #define KBD_STAT_MOUSE_OBF      0x20    /* Mouse output buffer full */
  76 #define KBD_STAT_GTO            0x40    /* General receive/xmit timeout */
  77 #define KBD_STAT_PERR           0x80    /* Parity error */
  78
  79 /* Controller Mode Register Bits */
  80 #define KBD_MODE_KBD_INT        0x01    /* Keyboard data generate IRQ1 */
  81 #define KBD_MODE_MOUSE_INT      0x02    /* Mouse data generate IRQ12 */
  82 #define KBD_MODE_SYS            0x04    /* The system flag (?) */
  83 #define KBD_MODE_NO_KEYLOCK     0x08    /* The keylock doesn't affect the keyboard if set */
  84 #define KBD_MODE_DISABLE_KBD    0x10    /* Disable keyboard interface */
  85 #define KBD_MODE_DISABLE_MOUSE  0x20    /* Disable mouse interface */
  86 #define KBD_MODE_KCC            0x40    /* Scan code conversion to PC format */
  87 #define KBD_MODE_RFU            0x80
  88
  89 /* Mouse Commands */
  90 #define AUX_SET_SCALE11         0xE6    /* Set 1:1 scaling */
  91 #define AUX_SET_SCALE21         0xE7    /* Set 2:1 scaling */
  92 #define AUX_SET_RES             0xE8    /* Set resolution */
  93 #define AUX_GET_SCALE           0xE9    /* Get scaling factor */
  94 #define AUX_SET_STREAM          0xEA    /* Set stream mode */
  95 #define AUX_POLL                0xEB    /* Poll */
  96 #define AUX_RESET_WRAP          0xEC    /* Reset wrap mode */
  97 #define AUX_SET_WRAP            0xEE    /* Set wrap mode */
  98 #define AUX_SET_REMOTE          0xF0    /* Set remote mode */
  99 #define AUX_GET_TYPE            0xF2    /* Get type */
 100 #define AUX_SET_SAMPLE          0xF3    /* Set sample rate */
 101 #define AUX_ENABLE_DEV          0xF4    /* Enable aux device */
 102 #define AUX_DISABLE_DEV         0xF5    /* Disable aux device */
 103 #define AUX_SET_DEFAULT         0xF6
 104 #define AUX_RESET               0xFF    /* Reset aux device */
 105 #define AUX_ACK                 0xFA    /* Command byte ACK. */
 106
 107 #define MOUSE_STATUS_REMOTE     0x40
 108 #define MOUSE_STATUS_ENABLED    0x20
 109 #define MOUSE_STATUS_SCALE21    0x10
 110
 111 #define KBD_QUEUE_SIZE 256
 112
 113 #define KBD_PENDING_KBD         1
 114 #define KBD_PENDING_AUX         2
 115
 116 typedef struct KBDState {
 117     uint8_t write_cmd; /* if non zero, write data to port 60 is expected */
 118     uint8_t status;
 119     uint8_t mode;
 120     /* Bitmask of devices with data available.  */
 121     uint8_t pending;
 122     void *kbd;
 123     void *mouse;
 124
 125     qemu_irq irq_kbd;
 126     qemu_irq irq_mouse;
 127     target_phys_addr_t base;
 128     int it_shift;
 129 } KBDState;
 130
 131 KBDState kbd_state;
 132
 133 /* update irq and KBD_STAT_[MOUSE_]OBF */
 134 /* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
 135    incorrect, but it avoids having to simulate exact delays */
 136 static void kbd_update_irq(KBDState *s)
 137 {
 138     int irq_kbd_level, irq_mouse_level;
 139
 140     irq_kbd_level = 0;
 141     irq_mouse_level = 0;
 142     s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
 143     if (s->pending) {
 144         s->status |= KBD_STAT_OBF;
 145         /* kbd data takes priority over aux data.  */
 146         if (s->pending == KBD_PENDING_AUX) {
 147             s->status |= KBD_STAT_MOUSE_OBF;
 148             if (s->mode & KBD_MODE_MOUSE_INT)
 149                 irq_mouse_level = 1;
 150         } else {
 151             if ((s->mode & KBD_MODE_KBD_INT) &&
 152                 !(s->mode & KBD_MODE_DISABLE_KBD))
 153                 irq_kbd_level = 1;
 154         }
 155     }
 156     qemu_set_irq(s->irq_kbd, irq_kbd_level);
 157     qemu_set_irq(s->irq_mouse, irq_mouse_level);
 158 }
 159
 160 static void kbd_update_kbd_irq(void *opaque, int level)
 161 {
 162     KBDState *s = (KBDState *)opaque;
 163
 164     if (level)
 165         s->pending |= KBD_PENDING_KBD;
 166     else
 167         s->pending &= ~KBD_PENDING_KBD;
 168     kbd_update_irq(s);
 169 }
 170
 171 static void kbd_update_aux_irq(void *opaque, int level)
 172 {
 173     KBDState *s = (KBDState *)opaque;
 174
 175     if (level)
 176         s->pending |= KBD_PENDING_AUX;
 177     else
 178         s->pending &= ~KBD_PENDING_AUX;
 179     kbd_update_irq(s);
 180 }
 181
 182 static uint32_t kbd_read_status(void *opaque, uint32_t addr)
 183 {
 184     KBDState *s = opaque;
 185     int val;
 186     val = s->status;
 187 #if defined(DEBUG_KBD)
 188     printf("kbd: read status=0x%02x\n", val);
 189 #endif
 190     return val;
 191 }
 192
 193 static void kbd_queue(KBDState *s, int b, int aux)
 194 {
 195     if (aux)
 196         ps2_queue(s->mouse, b);
 197     else
 198         ps2_queue(s->kbd, b);
 199 }
 200
 201 static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
 202 {
 203     KBDState *s = opaque;
 204
 205 #ifdef DEBUG_KBD
 206     printf("kbd: write cmd=0x%02x\n", val);
 207 #endif
 208     switch(val) {
 209     case KBD_CCMD_READ_MODE:
 210         kbd_queue(s, s->mode, 0);
 211         break;
 212     case KBD_CCMD_WRITE_MODE:
 213     case KBD_CCMD_WRITE_OBUF:
 214     case KBD_CCMD_WRITE_AUX_OBUF:
 215     case KBD_CCMD_WRITE_MOUSE:
 216     case KBD_CCMD_WRITE_OUTPORT:
 217         s->write_cmd = val;
 218         break;
 219     case KBD_CCMD_MOUSE_DISABLE:
 220         s->mode |= KBD_MODE_DISABLE_MOUSE;
 221         break;
 222     case KBD_CCMD_MOUSE_ENABLE:
 223         s->mode &= ~KBD_MODE_DISABLE_MOUSE;
 224         break;
 225     case KBD_CCMD_TEST_MOUSE:
 226         kbd_queue(s, 0x00, 0);
 227         break;
 228     case KBD_CCMD_SELF_TEST:
 229         s->status |= KBD_STAT_SELFTEST;
 230         kbd_queue(s, 0x55, 0);
 231         break;
 232     case KBD_CCMD_KBD_TEST:
 233         kbd_queue(s, 0x00, 0);
 234         break;
 235     case KBD_CCMD_KBD_DISABLE:
 236         s->mode |= KBD_MODE_DISABLE_KBD;
 237         kbd_update_irq(s);
 238         break;
 239     case KBD_CCMD_KBD_ENABLE:
 240         s->mode &= ~KBD_MODE_DISABLE_KBD;
 241         kbd_update_irq(s);
 242         break;
 243     case KBD_CCMD_READ_INPORT:
 244         kbd_queue(s, 0x00, 0);
 245         break;
 246     case KBD_CCMD_READ_OUTPORT:
 247         /* XXX: check that */
 248 #ifdef TARGET_I386
 249         val = 0x01 | (ioport_get_a20() << 1);
 250 #else
 251         val = 0x01;
 252 #endif
 253         if (s->status & KBD_STAT_OBF)
 254             val |= 0x10;
 255         if (s->status & KBD_STAT_MOUSE_OBF)
 256             val |= 0x20;
 257         kbd_queue(s, val, 0);
 258         break;
 259 #ifdef TARGET_I386
 260     case KBD_CCMD_ENABLE_A20:
 261         ioport_set_a20(1);
 262         break;
 263     case KBD_CCMD_DISABLE_A20:
 264         ioport_set_a20(0);
 265         break;
 266 #endif
 267     case KBD_CCMD_RESET:
 268         qemu_system_reset_request();
 269         break;
 270     case 0xff:
 271         /* ignore that - I don't know what is its use */
 272         break;
 273     default:
 274         fprintf(stderr, "qemu: unsupported keyboard cmd=0x%02x\n", val);
 275         break;
 276     }
 277 }
 278
 279 static uint32_t kbd_read_data(void *opaque, uint32_t addr)
 280 {
 281     KBDState *s = opaque;
 282
 283     if (s->pending == KBD_PENDING_AUX)
 284         return ps2_read_data(s->mouse);
 285
 286     return ps2_read_data(s->kbd);
 287 }
 288
 289 void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
 290 {
 291     KBDState *s = opaque;
 292
 293 #ifdef DEBUG_KBD
 294     printf("kbd: write data=0x%02x\n", val);
 295 #endif
 296
 297     switch(s->write_cmd) {
 298     case 0:
 299         ps2_write_keyboard(s->kbd, val);
 300         break;
 301     case KBD_CCMD_WRITE_MODE:
 302         s->mode = val;
 303         ps2_keyboard_set_translation(s->kbd, (s->mode & KBD_MODE_KCC) != 0);
 304         /* ??? */
 305         kbd_update_irq(s);
 306         break;
 307     case KBD_CCMD_WRITE_OBUF:
 308         kbd_queue(s, val, 0);
 309         break;
 310     case KBD_CCMD_WRITE_AUX_OBUF:
 311         kbd_queue(s, val, 1);
 312         break;
 313     case KBD_CCMD_WRITE_OUTPORT:
 314 #ifdef TARGET_I386
 315         ioport_set_a20((val >> 1) & 1);
 316 #endif
 317         if (!(val & 1)) {
 318             qemu_system_reset_request();
 319         }
 320         break;
 321     case KBD_CCMD_WRITE_MOUSE:
 322         ps2_write_mouse(s->mouse, val);
 323         break;
 324     default:
 325         break;
 326     }
 327     s->write_cmd = 0;
 328 }
 329
 330 static void kbd_reset(void *opaque)
 331 {
 332     KBDState *s = opaque;
 333
 334     s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
 335     s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
 336 }
 337
 338 static void kbd_save(QEMUFile* f, void* opaque)
 339 {
 340     KBDState *s = (KBDState*)opaque;
 341
 342     qemu_put_8s(f, &s->write_cmd);
 343     qemu_put_8s(f, &s->status);
 344     qemu_put_8s(f, &s->mode);
 345     qemu_put_8s(f, &s->pending);
 346 }
 347
 348 static int kbd_load(QEMUFile* f, void* opaque, int version_id)
 349 {
 350     KBDState *s = (KBDState*)opaque;
 351
 352     if (version_id != 3)
 353         return -EINVAL;
 354     qemu_get_8s(f, &s->write_cmd);
 355     qemu_get_8s(f, &s->status);
 356     qemu_get_8s(f, &s->mode);
 357     qemu_get_8s(f, &s->pending);
 358     return 0;
 359 }
 360
 361 void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base)
 362 {
 363     KBDState *s = &kbd_state;
 364
 365     s->irq_kbd = kbd_irq;
 366     s->irq_mouse = mouse_irq;
 367
 368     kbd_reset(s);
 369     register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
 370     register_ioport_read(io_base, 1, 1, kbd_read_data, s);
 371     register_ioport_write(io_base, 1, 1, kbd_write_data, s);
 372     register_ioport_read(io_base + 4, 1, 1, kbd_read_status, s);
 373     register_ioport_write(io_base + 4, 1, 1, kbd_write_command, s);
 374
 375     s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
 376     s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
 377 #ifdef TARGET_I386
 378     vmmouse_init(s->mouse);
 379 #endif
 380     qemu_register_reset(kbd_reset, s);
 381 }
 382
 383 /* Memory mapped interface */
 384 uint32_t kbd_mm_readb (void *opaque, target_phys_addr_t addr)
 385 {
 386     KBDState *s = opaque;
 387
 388     switch ((addr - s->base) >> s->it_shift) {
 389     case 0:
 390         return kbd_read_data(s, 0) & 0xff;
 391     case 1:
 392         return kbd_read_status(s, 0) & 0xff;
 393     default:
 394         return 0xff;
 395     }
 396 }
 397
 398 void kbd_mm_writeb (void *opaque, target_phys_addr_t addr, uint32_t value)
 399 {
 400     KBDState *s = opaque;
 401
 402     switch ((addr - s->base) >> s->it_shift) {
 403     case 0:
 404         kbd_write_data(s, 0, value & 0xff);
 405         break;
 406     case 1:
 407         kbd_write_command(s, 0, value & 0xff);
 408         break;
 409     }
 410 }
 411
 412 static CPUReadMemoryFunc *kbd_mm_read[] = {
 413     &kbd_mm_readb,
 414     &kbd_mm_readb,
 415     &kbd_mm_readb,
 416 };
 417
 418 static CPUWriteMemoryFunc *kbd_mm_write[] = {
 419     &kbd_mm_writeb,
 420     &kbd_mm_writeb,
 421     &kbd_mm_writeb,
 422 };
 423
 424 void i8042_mm_init(qemu_irq kbd_irq, qemu_irq mouse_irq,
 425                    target_phys_addr_t base, int it_shift)
 426 {
 427     KBDState *s = &kbd_state;
 428     int s_io_memory;
 429
 430     s->irq_kbd = kbd_irq;
 431     s->irq_mouse = mouse_irq;
 432     s->base = base;
 433     s->it_shift = it_shift;
 434
 435     kbd_reset(s);
 436     register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
 437     s_io_memory = cpu_register_io_memory(0, kbd_mm_read, kbd_mm_write, s);
 438     cpu_register_physical_memory(base, 8 << it_shift, s_io_memory);
 439
 440     s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
 441     s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
 442 #ifdef TARGET_I386
 443     vmmouse_init(s->mouse);
 444 #endif
 445     qemu_register_reset(kbd_reset, s);
 446 }