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 } KBDState;
 128
 129 KBDState kbd_state;
 130
 131 /* update irq and KBD_STAT_[MOUSE_]OBF */
 132 /* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
 133    incorrect, but it avoids having to simulate exact delays */
 134 static void kbd_update_irq(KBDState *s)
 135 {
 136     int irq_kbd_level, irq_mouse_level;
 137
 138     irq_kbd_level = 0;
 139     irq_mouse_level = 0;
 140     s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
 141     if (s->pending) {
 142         s->status |= KBD_STAT_OBF;
 143         /* kdb data takes priority over aux data.  */
 144         if (s->pending == KBD_PENDING_AUX) {
 145             s->status |= KBD_STAT_MOUSE_OBF;
 146             if (s->mode & KBD_MODE_MOUSE_INT)
 147                 irq_mouse_level = 1;
 148         } else {
 149             if ((s->mode & KBD_MODE_KBD_INT) &&
 150                 !(s->mode & KBD_MODE_DISABLE_KBD))
 151                 irq_kbd_level = 1;
 152         }
 153     }
 154     qemu_set_irq(s->irq_kbd, irq_kbd_level);
 155     qemu_set_irq(s->irq_mouse, irq_mouse_level);
 156 }
 157
 158 static void kbd_update_kbd_irq(void *opaque, int level)
 159 {
 160     KBDState *s = (KBDState *)opaque;
 161
 162     if (level)
 163         s->pending |= KBD_PENDING_KBD;
 164     else
 165         s->pending &= ~KBD_PENDING_KBD;
 166     kbd_update_irq(s);
 167 }
 168
 169 static void kbd_update_aux_irq(void *opaque, int level)
 170 {
 171     KBDState *s = (KBDState *)opaque;
 172
 173     if (level)
 174         s->pending |= KBD_PENDING_AUX;
 175     else
 176         s->pending &= ~KBD_PENDING_AUX;
 177     kbd_update_irq(s);
 178 }
 179
 180 static uint32_t kbd_read_status(void *opaque, uint32_t addr)
 181 {
 182     KBDState *s = opaque;
 183     int val;
 184     val = s->status;
 185 #if defined(DEBUG_KBD)
 186     printf("kbd: read status=0x%02x\n", val);
 187 #endif
 188     return val;
 189 }
 190
 191 static void kbd_queue(KBDState *s, int b, int aux)
 192 {
 193     if (aux)
 194         ps2_queue(s->mouse, b);
 195     else
 196         ps2_queue(s->kbd, b);
 197 }
 198
 199 static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
 200 {
 201     KBDState *s = opaque;
 202
 203 #ifdef DEBUG_KBD
 204     printf("kbd: write cmd=0x%02x\n", val);
 205 #endif
 206     switch(val) {
 207     case KBD_CCMD_READ_MODE:
 208         kbd_queue(s, s->mode, 0);
 209         break;
 210     case KBD_CCMD_WRITE_MODE:
 211     case KBD_CCMD_WRITE_OBUF:
 212     case KBD_CCMD_WRITE_AUX_OBUF:
 213     case KBD_CCMD_WRITE_MOUSE:
 214     case KBD_CCMD_WRITE_OUTPORT:
 215         s->write_cmd = val;
 216         break;
 217     case KBD_CCMD_MOUSE_DISABLE:
 218         s->mode |= KBD_MODE_DISABLE_MOUSE;
 219         break;
 220     case KBD_CCMD_MOUSE_ENABLE:
 221         s->mode &= ~KBD_MODE_DISABLE_MOUSE;
 222         break;
 223     case KBD_CCMD_TEST_MOUSE:
 224         kbd_queue(s, 0x00, 0);
 225         break;
 226     case KBD_CCMD_SELF_TEST:
 227         s->status |= KBD_STAT_SELFTEST;
 228         kbd_queue(s, 0x55, 0);
 229         break;
 230     case KBD_CCMD_KBD_TEST:
 231         kbd_queue(s, 0x00, 0);
 232         break;
 233     case KBD_CCMD_KBD_DISABLE:
 234         s->mode |= KBD_MODE_DISABLE_KBD;
 235         kbd_update_irq(s);
 236         break;
 237     case KBD_CCMD_KBD_ENABLE:
 238         s->mode &= ~KBD_MODE_DISABLE_KBD;
 239         kbd_update_irq(s);
 240         break;
 241     case KBD_CCMD_READ_INPORT:
 242         kbd_queue(s, 0x00, 0);
 243         break;
 244     case KBD_CCMD_READ_OUTPORT:
 245         /* XXX: check that */
 246 #ifdef TARGET_I386
 247         val = 0x01 | (ioport_get_a20() << 1);
 248 #else
 249         val = 0x01;
 250 #endif
 251         if (s->status & KBD_STAT_OBF)
 252             val |= 0x10;
 253         if (s->status & KBD_STAT_MOUSE_OBF)
 254             val |= 0x20;
 255         kbd_queue(s, val, 0);
 256         break;
 257 #ifdef TARGET_I386
 258     case KBD_CCMD_ENABLE_A20:
 259         ioport_set_a20(1);
 260         break;
 261     case KBD_CCMD_DISABLE_A20:
 262         ioport_set_a20(0);
 263         break;
 264 #endif
 265     case KBD_CCMD_RESET:
 266         qemu_system_reset_request();
 267         break;
 268     case 0xff:
 269         /* ignore that - I don't know what is its use */
 270         break;
 271     default:
 272         fprintf(stderr, "qemu: unsupported keyboard cmd=0x%02x\n", val);
 273         break;
 274     }
 275 }
 276
 277 static uint32_t kbd_read_data(void *opaque, uint32_t addr)
 278 {
 279     KBDState *s = opaque;
 280
 281     if (s->pending == KBD_PENDING_AUX)
 282         return ps2_read_data(s->mouse);
 283
 284     return ps2_read_data(s->kbd);
 285 }
 286
 287 void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
 288 {
 289     KBDState *s = opaque;
 290
 291 #ifdef DEBUG_KBD
 292     printf("kbd: write data=0x%02x\n", val);
 293 #endif
 294
 295     switch(s->write_cmd) {
 296     case 0:
 297         ps2_write_keyboard(s->kbd, val);
 298         break;
 299     case KBD_CCMD_WRITE_MODE:
 300         s->mode = val;
 301         ps2_keyboard_set_translation(s->kbd, (s->mode & KBD_MODE_KCC) != 0);
 302         /* ??? */
 303         kbd_update_irq(s);
 304         break;
 305     case KBD_CCMD_WRITE_OBUF:
 306         kbd_queue(s, val, 0);
 307         break;
 308     case KBD_CCMD_WRITE_AUX_OBUF:
 309         kbd_queue(s, val, 1);
 310         break;
 311     case KBD_CCMD_WRITE_OUTPORT:
 312 #ifdef TARGET_I386
 313         ioport_set_a20((val >> 1) & 1);
 314 #endif
 315         if (!(val & 1)) {
 316             qemu_system_reset_request();
 317         }
 318         break;
 319     case KBD_CCMD_WRITE_MOUSE:
 320         ps2_write_mouse(s->mouse, val);
 321         break;
 322     default:
 323         break;
 324     }
 325     s->write_cmd = 0;
 326 }
 327
 328 static void kbd_reset(void *opaque)
 329 {
 330     KBDState *s = opaque;
 331
 332     s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
 333     s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
 334 }
 335
 336 static void kbd_save(QEMUFile* f, void* opaque)
 337 {
 338     KBDState *s = (KBDState*)opaque;
 339
 340     qemu_put_8s(f, &s->write_cmd);
 341     qemu_put_8s(f, &s->status);
 342     qemu_put_8s(f, &s->mode);
 343     qemu_put_8s(f, &s->pending);
 344 }
 345
 346 static int kbd_load(QEMUFile* f, void* opaque, int version_id)
 347 {
 348     KBDState *s = (KBDState*)opaque;
 349
 350     if (version_id != 3)
 351         return -EINVAL;
 352     qemu_get_8s(f, &s->write_cmd);
 353     qemu_get_8s(f, &s->status);
 354     qemu_get_8s(f, &s->mode);
 355     qemu_get_8s(f, &s->pending);
 356     return 0;
 357 }
 358
 359 void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base)
 360 {
 361     KBDState *s = &kbd_state;
 362
 363     s->irq_kbd = kbd_irq;
 364     s->irq_mouse = mouse_irq;
 365
 366     kbd_reset(s);
 367     register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
 368     register_ioport_read(io_base, 1, 1, kbd_read_data, s);
 369     register_ioport_write(io_base, 1, 1, kbd_write_data, s);
 370     register_ioport_read(io_base + 4, 1, 1, kbd_read_status, s);
 371     register_ioport_write(io_base + 4, 1, 1, kbd_write_command, s);
 372
 373     s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
 374     s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
 375 #ifdef TARGET_I386
 376     vmmouse_init(s->mouse);
 377 #endif
 378     qemu_register_reset(kbd_reset, s);
 379 }