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
26 /* debug PC keyboard */
29 /* debug PC keyboard : only mouse */
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
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 */
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 */
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 */
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
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. */
107 #define MOUSE_STATUS_REMOTE 0x40
108 #define MOUSE_STATUS_ENABLED 0x20
109 #define MOUSE_STATUS_SCALE21 0x10
111 #define KBD_QUEUE_SIZE 256
113 #define KBD_PENDING_KBD 1
114 #define KBD_PENDING_AUX 2
116 typedef struct KBDState {
117 uint8_t write_cmd; /* if non zero, write data to port 60 is expected */
120 /* Bitmask of devices with data available. */
128 /* update irq and KBD_STAT_[MOUSE_]OBF */
129 /* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
130 incorrect, but it avoids having to simulate exact delays */
131 static void kbd_update_irq(KBDState *s)
133 int irq12_level, irq1_level;
137 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
139 s->status |= KBD_STAT_OBF;
140 /* kdb data takes priority over aux data. */
141 if (s->pending == KBD_PENDING_AUX) {
142 s->status |= KBD_STAT_MOUSE_OBF;
143 if (s->mode & KBD_MODE_MOUSE_INT)
146 if ((s->mode & KBD_MODE_KBD_INT) &&
147 !(s->mode & KBD_MODE_DISABLE_KBD))
151 pic_set_irq(1, irq1_level);
152 pic_set_irq(12, irq12_level);
155 static void kbd_update_kbd_irq(void *opaque, int level)
157 KBDState *s = (KBDState *)opaque;
160 s->pending |= KBD_PENDING_KBD;
162 s->pending &= ~KBD_PENDING_KBD;
166 static void kbd_update_aux_irq(void *opaque, int level)
168 KBDState *s = (KBDState *)opaque;
171 s->pending |= KBD_PENDING_AUX;
173 s->pending &= ~KBD_PENDING_AUX;
177 static uint32_t kbd_read_status(void *opaque, uint32_t addr)
179 KBDState *s = opaque;
182 #if defined(DEBUG_KBD)
183 printf("kbd: read status=0x%02x\n", val);
188 static void kbd_queue(KBDState *s, int b, int aux)
191 ps2_queue(s->mouse, b);
193 ps2_queue(s->kbd, b);
196 static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
198 KBDState *s = opaque;
201 printf("kbd: write cmd=0x%02x\n", val);
204 case KBD_CCMD_READ_MODE:
205 kbd_queue(s, s->mode, 0);
207 case KBD_CCMD_WRITE_MODE:
208 case KBD_CCMD_WRITE_OBUF:
209 case KBD_CCMD_WRITE_AUX_OBUF:
210 case KBD_CCMD_WRITE_MOUSE:
211 case KBD_CCMD_WRITE_OUTPORT:
214 case KBD_CCMD_MOUSE_DISABLE:
215 s->mode |= KBD_MODE_DISABLE_MOUSE;
217 case KBD_CCMD_MOUSE_ENABLE:
218 s->mode &= ~KBD_MODE_DISABLE_MOUSE;
220 case KBD_CCMD_TEST_MOUSE:
221 kbd_queue(s, 0x00, 0);
223 case KBD_CCMD_SELF_TEST:
224 s->status |= KBD_STAT_SELFTEST;
225 kbd_queue(s, 0x55, 0);
227 case KBD_CCMD_KBD_TEST:
228 kbd_queue(s, 0x00, 0);
230 case KBD_CCMD_KBD_DISABLE:
231 s->mode |= KBD_MODE_DISABLE_KBD;
234 case KBD_CCMD_KBD_ENABLE:
235 s->mode &= ~KBD_MODE_DISABLE_KBD;
238 case KBD_CCMD_READ_INPORT:
239 kbd_queue(s, 0x00, 0);
241 case KBD_CCMD_READ_OUTPORT:
242 /* XXX: check that */
244 val = 0x01 | (ioport_get_a20() << 1);
248 if (s->status & KBD_STAT_OBF)
250 if (s->status & KBD_STAT_MOUSE_OBF)
252 kbd_queue(s, val, 0);
255 case KBD_CCMD_ENABLE_A20:
258 case KBD_CCMD_DISABLE_A20:
263 qemu_system_reset_request();
266 /* ignore that - I don't know what is its use */
269 fprintf(stderr, "qemu: unsupported keyboard cmd=0x%02x\n", val);
274 static uint32_t kbd_read_data(void *opaque, uint32_t addr)
276 KBDState *s = opaque;
278 if (s->pending == KBD_PENDING_AUX)
279 return ps2_read_data(s->mouse);
281 return ps2_read_data(s->kbd);
284 void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
286 KBDState *s = opaque;
289 printf("kbd: write data=0x%02x\n", val);
292 switch(s->write_cmd) {
294 ps2_write_keyboard(s->kbd, val);
296 case KBD_CCMD_WRITE_MODE:
298 ps2_keyboard_set_translation(s->kbd, (s->mode & KBD_MODE_KCC) != 0);
302 case KBD_CCMD_WRITE_OBUF:
303 kbd_queue(s, val, 0);
305 case KBD_CCMD_WRITE_AUX_OBUF:
306 kbd_queue(s, val, 1);
308 case KBD_CCMD_WRITE_OUTPORT:
310 ioport_set_a20((val >> 1) & 1);
313 qemu_system_reset_request();
316 case KBD_CCMD_WRITE_MOUSE:
317 ps2_write_mouse(s->mouse, val);
325 static void kbd_reset(void *opaque)
327 KBDState *s = opaque;
329 s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
330 s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
333 static void kbd_save(QEMUFile* f, void* opaque)
335 KBDState *s = (KBDState*)opaque;
337 qemu_put_8s(f, &s->write_cmd);
338 qemu_put_8s(f, &s->status);
339 qemu_put_8s(f, &s->mode);
342 static int kbd_load(QEMUFile* f, void* opaque, int version_id)
344 KBDState *s = (KBDState*)opaque;
348 qemu_get_8s(f, &s->write_cmd);
349 qemu_get_8s(f, &s->status);
350 qemu_get_8s(f, &s->mode);
356 KBDState *s = &kbd_state;
359 register_savevm("pckbd", 0, 2, kbd_save, kbd_load, s);
360 register_ioport_read(0x60, 1, 1, kbd_read_data, s);
361 register_ioport_write(0x60, 1, 1, kbd_write_data, s);
362 register_ioport_read(0x64, 1, 1, kbd_read_status, s);
363 register_ioport_write(0x64, 1, 1, kbd_write_command, s);
365 s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
366 s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
367 qemu_register_reset(kbd_reset, s);