2 * QEMU PC keyboard emulation
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
30 /* debug PC keyboard */
33 /* Keyboard Controller Commands */
34 #define KBD_CCMD_READ_MODE 0x20 /* Read mode bits */
35 #define KBD_CCMD_WRITE_MODE 0x60 /* Write mode bits */
36 #define KBD_CCMD_GET_VERSION 0xA1 /* Get controller version */
37 #define KBD_CCMD_MOUSE_DISABLE 0xA7 /* Disable mouse interface */
38 #define KBD_CCMD_MOUSE_ENABLE 0xA8 /* Enable mouse interface */
39 #define KBD_CCMD_TEST_MOUSE 0xA9 /* Mouse interface test */
40 #define KBD_CCMD_SELF_TEST 0xAA /* Controller self test */
41 #define KBD_CCMD_KBD_TEST 0xAB /* Keyboard interface test */
42 #define KBD_CCMD_KBD_DISABLE 0xAD /* Keyboard interface disable */
43 #define KBD_CCMD_KBD_ENABLE 0xAE /* Keyboard interface enable */
44 #define KBD_CCMD_READ_INPORT 0xC0 /* read input port */
45 #define KBD_CCMD_READ_OUTPORT 0xD0 /* read output port */
46 #define KBD_CCMD_WRITE_OUTPORT 0xD1 /* write output port */
47 #define KBD_CCMD_WRITE_OBUF 0xD2
48 #define KBD_CCMD_WRITE_AUX_OBUF 0xD3 /* Write to output buffer as if
49 initiated by the auxiliary device */
50 #define KBD_CCMD_WRITE_MOUSE 0xD4 /* Write the following byte to the mouse */
51 #define KBD_CCMD_DISABLE_A20 0xDD /* HP vectra only ? */
52 #define KBD_CCMD_ENABLE_A20 0xDF /* HP vectra only ? */
53 #define KBD_CCMD_RESET 0xFE
55 /* Keyboard Commands */
56 #define KBD_CMD_SET_LEDS 0xED /* Set keyboard leds */
57 #define KBD_CMD_ECHO 0xEE
58 #define KBD_CMD_GET_ID 0xF2 /* get keyboard ID */
59 #define KBD_CMD_SET_RATE 0xF3 /* Set typematic rate */
60 #define KBD_CMD_ENABLE 0xF4 /* Enable scanning */
61 #define KBD_CMD_RESET_DISABLE 0xF5 /* reset and disable scanning */
62 #define KBD_CMD_RESET_ENABLE 0xF6 /* reset and enable scanning */
63 #define KBD_CMD_RESET 0xFF /* Reset */
65 /* Keyboard Replies */
66 #define KBD_REPLY_POR 0xAA /* Power on reset */
67 #define KBD_REPLY_ACK 0xFA /* Command ACK */
68 #define KBD_REPLY_RESEND 0xFE /* Command NACK, send the cmd again */
70 /* Status Register Bits */
71 #define KBD_STAT_OBF 0x01 /* Keyboard output buffer full */
72 #define KBD_STAT_IBF 0x02 /* Keyboard input buffer full */
73 #define KBD_STAT_SELFTEST 0x04 /* Self test successful */
74 #define KBD_STAT_CMD 0x08 /* Last write was a command write (0=data) */
75 #define KBD_STAT_UNLOCKED 0x10 /* Zero if keyboard locked */
76 #define KBD_STAT_MOUSE_OBF 0x20 /* Mouse output buffer full */
77 #define KBD_STAT_GTO 0x40 /* General receive/xmit timeout */
78 #define KBD_STAT_PERR 0x80 /* Parity error */
80 /* Controller Mode Register Bits */
81 #define KBD_MODE_KBD_INT 0x01 /* Keyboard data generate IRQ1 */
82 #define KBD_MODE_MOUSE_INT 0x02 /* Mouse data generate IRQ12 */
83 #define KBD_MODE_SYS 0x04 /* The system flag (?) */
84 #define KBD_MODE_NO_KEYLOCK 0x08 /* The keylock doesn't affect the keyboard if set */
85 #define KBD_MODE_DISABLE_KBD 0x10 /* Disable keyboard interface */
86 #define KBD_MODE_DISABLE_MOUSE 0x20 /* Disable mouse interface */
87 #define KBD_MODE_KCC 0x40 /* Scan code conversion to PC format */
88 #define KBD_MODE_RFU 0x80
91 #define AUX_SET_SCALE11 0xE6 /* Set 1:1 scaling */
92 #define AUX_SET_SCALE21 0xE7 /* Set 2:1 scaling */
93 #define AUX_SET_RES 0xE8 /* Set resolution */
94 #define AUX_GET_SCALE 0xE9 /* Get scaling factor */
95 #define AUX_SET_STREAM 0xEA /* Set stream mode */
96 #define AUX_POLL 0xEB /* Poll */
97 #define AUX_RESET_WRAP 0xEC /* Reset wrap mode */
98 #define AUX_SET_WRAP 0xEE /* Set wrap mode */
99 #define AUX_SET_REMOTE 0xF0 /* Set remote mode */
100 #define AUX_GET_TYPE 0xF2 /* Get type */
101 #define AUX_SET_SAMPLE 0xF3 /* Set sample rate */
102 #define AUX_ENABLE_DEV 0xF4 /* Enable aux device */
103 #define AUX_DISABLE_DEV 0xF5 /* Disable aux device */
104 #define AUX_SET_DEFAULT 0xF6
105 #define AUX_RESET 0xFF /* Reset aux device */
106 #define AUX_ACK 0xFA /* Command byte ACK. */
108 #define MOUSE_STATUS_REMOTE 0x40
109 #define MOUSE_STATUS_ENABLED 0x20
110 #define MOUSE_STATUS_SCALE21 0x10
112 #define KBD_QUEUE_SIZE 256
114 #define KBD_PENDING_KBD 1
115 #define KBD_PENDING_AUX 2
117 typedef struct KBDState {
118 uint8_t write_cmd; /* if non zero, write data to port 60 is expected */
121 /* Bitmask of devices with data available. */
131 static KBDState kbd_state;
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)
138 int irq_kbd_level, irq_mouse_level;
142 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
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)
151 if ((s->mode & KBD_MODE_KBD_INT) &&
152 !(s->mode & KBD_MODE_DISABLE_KBD))
156 qemu_set_irq(s->irq_kbd, irq_kbd_level);
157 qemu_set_irq(s->irq_mouse, irq_mouse_level);
160 static void kbd_update_kbd_irq(void *opaque, int level)
162 KBDState *s = (KBDState *)opaque;
165 s->pending |= KBD_PENDING_KBD;
167 s->pending &= ~KBD_PENDING_KBD;
171 static void kbd_update_aux_irq(void *opaque, int level)
173 KBDState *s = (KBDState *)opaque;
176 s->pending |= KBD_PENDING_AUX;
178 s->pending &= ~KBD_PENDING_AUX;
182 static uint32_t kbd_read_status(void *opaque, uint32_t addr)
184 KBDState *s = opaque;
187 #if defined(DEBUG_KBD)
188 printf("kbd: read status=0x%02x\n", val);
193 static void kbd_queue(KBDState *s, int b, int aux)
196 ps2_queue(s->mouse, b);
198 ps2_queue(s->kbd, b);
201 static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
203 KBDState *s = opaque;
206 printf("kbd: write cmd=0x%02x\n", val);
209 case KBD_CCMD_READ_MODE:
210 kbd_queue(s, s->mode, 0);
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:
219 case KBD_CCMD_MOUSE_DISABLE:
220 s->mode |= KBD_MODE_DISABLE_MOUSE;
222 case KBD_CCMD_MOUSE_ENABLE:
223 s->mode &= ~KBD_MODE_DISABLE_MOUSE;
225 case KBD_CCMD_TEST_MOUSE:
226 kbd_queue(s, 0x00, 0);
228 case KBD_CCMD_SELF_TEST:
229 s->status |= KBD_STAT_SELFTEST;
230 kbd_queue(s, 0x55, 0);
232 case KBD_CCMD_KBD_TEST:
233 kbd_queue(s, 0x00, 0);
235 case KBD_CCMD_KBD_DISABLE:
236 s->mode |= KBD_MODE_DISABLE_KBD;
239 case KBD_CCMD_KBD_ENABLE:
240 s->mode &= ~KBD_MODE_DISABLE_KBD;
243 case KBD_CCMD_READ_INPORT:
244 kbd_queue(s, 0x00, 0);
246 case KBD_CCMD_READ_OUTPORT:
247 /* XXX: check that */
249 val = 0x01 | (ioport_get_a20() << 1);
253 if (s->status & KBD_STAT_OBF)
255 if (s->status & KBD_STAT_MOUSE_OBF)
257 kbd_queue(s, val, 0);
260 case KBD_CCMD_ENABLE_A20:
263 case KBD_CCMD_DISABLE_A20:
268 qemu_system_reset_request();
271 /* ignore that - I don't know what is its use */
274 fprintf(stderr, "qemu: unsupported keyboard cmd=0x%02x\n", val);
279 static uint32_t kbd_read_data(void *opaque, uint32_t addr)
281 KBDState *s = opaque;
284 if (s->pending == KBD_PENDING_AUX)
285 val = ps2_read_data(s->mouse);
287 val = ps2_read_data(s->kbd);
289 #if defined(DEBUG_KBD)
290 printf("kbd: read data=0x%02x\n", val);
295 static void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
297 KBDState *s = opaque;
300 printf("kbd: write data=0x%02x\n", val);
303 switch(s->write_cmd) {
305 ps2_write_keyboard(s->kbd, val);
307 case KBD_CCMD_WRITE_MODE:
309 ps2_keyboard_set_translation(s->kbd, (s->mode & KBD_MODE_KCC) != 0);
313 case KBD_CCMD_WRITE_OBUF:
314 kbd_queue(s, val, 0);
316 case KBD_CCMD_WRITE_AUX_OBUF:
317 kbd_queue(s, val, 1);
319 case KBD_CCMD_WRITE_OUTPORT:
321 ioport_set_a20((val >> 1) & 1);
324 qemu_system_reset_request();
327 case KBD_CCMD_WRITE_MOUSE:
328 ps2_write_mouse(s->mouse, val);
336 static void kbd_reset(void *opaque)
338 KBDState *s = opaque;
340 s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
341 s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
344 static void kbd_save(QEMUFile* f, void* opaque)
346 KBDState *s = (KBDState*)opaque;
348 qemu_put_8s(f, &s->write_cmd);
349 qemu_put_8s(f, &s->status);
350 qemu_put_8s(f, &s->mode);
351 qemu_put_8s(f, &s->pending);
354 static int kbd_load(QEMUFile* f, void* opaque, int version_id)
356 KBDState *s = (KBDState*)opaque;
360 qemu_get_8s(f, &s->write_cmd);
361 qemu_get_8s(f, &s->status);
362 qemu_get_8s(f, &s->mode);
363 qemu_get_8s(f, &s->pending);
367 void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base)
369 KBDState *s = &kbd_state;
371 s->irq_kbd = kbd_irq;
372 s->irq_mouse = mouse_irq;
375 register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
376 register_ioport_read(io_base, 1, 1, kbd_read_data, s);
377 register_ioport_write(io_base, 1, 1, kbd_write_data, s);
378 register_ioport_read(io_base + 4, 1, 1, kbd_read_status, s);
379 register_ioport_write(io_base + 4, 1, 1, kbd_write_command, s);
381 s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
382 s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
384 vmmouse_init(s->mouse);
386 qemu_register_reset(kbd_reset, s);
389 /* Memory mapped interface */
390 static uint32_t kbd_mm_readb (void *opaque, target_phys_addr_t addr)
392 KBDState *s = opaque;
394 switch (addr >> s->it_shift) {
396 return kbd_read_data(s, 0) & 0xff;
398 return kbd_read_status(s, 0) & 0xff;
404 static void kbd_mm_writeb (void *opaque, target_phys_addr_t addr, uint32_t value)
406 KBDState *s = opaque;
408 switch (addr >> s->it_shift) {
410 kbd_write_data(s, 0, value & 0xff);
413 kbd_write_command(s, 0, value & 0xff);
418 static CPUReadMemoryFunc *kbd_mm_read[] = {
424 static CPUWriteMemoryFunc *kbd_mm_write[] = {
430 void i8042_mm_init(qemu_irq kbd_irq, qemu_irq mouse_irq,
431 target_phys_addr_t base, int it_shift)
433 KBDState *s = &kbd_state;
436 s->irq_kbd = kbd_irq;
437 s->irq_mouse = mouse_irq;
438 s->it_shift = it_shift;
441 register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
442 s_io_memory = cpu_register_io_memory(0, kbd_mm_read, kbd_mm_write, s);
443 cpu_register_physical_memory(base, 2 << it_shift, s_io_memory);
445 s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
446 s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
448 vmmouse_init(s->mouse);
450 qemu_register_reset(kbd_reset, s);