]> git.proxmox.com Git - qemu.git/blame - hw/pckbd.c
Revert "Introduce reset notifier order"
[qemu.git] / hw / pckbd.c
CommitLineData
80cabfad
FB
1/*
2 * QEMU PC keyboard emulation
5fafdf24 3 *
80cabfad 4 * Copyright (c) 2003 Fabrice Bellard
5fafdf24 5 *
80cabfad
FB
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 */
87ecb68b
PB
24#include "hw.h"
25#include "isa.h"
26#include "pc.h"
27#include "ps2.h"
28#include "sysemu.h"
80cabfad
FB
29
30/* debug PC keyboard */
31//#define DEBUG_KBD
32
80cabfad
FB
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
54
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 */
64
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 */
69
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 */
79
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
89
90/* Mouse Commands */
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. */
107
108#define MOUSE_STATUS_REMOTE 0x40
109#define MOUSE_STATUS_ENABLED 0x20
110#define MOUSE_STATUS_SCALE21 0x10
111
daa57963
FB
112#define KBD_PENDING_KBD 1
113#define KBD_PENDING_AUX 2
80cabfad
FB
114
115typedef struct KBDState {
80cabfad
FB
116 uint8_t write_cmd; /* if non zero, write data to port 60 is expected */
117 uint8_t status;
118 uint8_t mode;
daa57963 119 /* Bitmask of devices with data available. */
7783e9f0 120 uint8_t pending;
daa57963
FB
121 void *kbd;
122 void *mouse;
b7678d96 123
d537cf6c
PB
124 qemu_irq irq_kbd;
125 qemu_irq irq_mouse;
4efbe58f 126 target_phys_addr_t mask;
80cabfad
FB
127} KBDState;
128
b1d8e52e 129static KBDState kbd_state;
80cabfad
FB
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 */
134static void kbd_update_irq(KBDState *s)
135{
b7678d96 136 int irq_kbd_level, irq_mouse_level;
80cabfad 137
b7678d96
TS
138 irq_kbd_level = 0;
139 irq_mouse_level = 0;
80cabfad 140 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
daa57963 141 if (s->pending) {
80cabfad 142 s->status |= KBD_STAT_OBF;
b92bb99b 143 /* kbd data takes priority over aux data. */
daa57963 144 if (s->pending == KBD_PENDING_AUX) {
80cabfad
FB
145 s->status |= KBD_STAT_MOUSE_OBF;
146 if (s->mode & KBD_MODE_MOUSE_INT)
b7678d96 147 irq_mouse_level = 1;
80cabfad 148 } else {
5fafdf24 149 if ((s->mode & KBD_MODE_KBD_INT) &&
80cabfad 150 !(s->mode & KBD_MODE_DISABLE_KBD))
b7678d96 151 irq_kbd_level = 1;
80cabfad
FB
152 }
153 }
d537cf6c
PB
154 qemu_set_irq(s->irq_kbd, irq_kbd_level);
155 qemu_set_irq(s->irq_mouse, irq_mouse_level);
80cabfad
FB
156}
157
daa57963 158static void kbd_update_kbd_irq(void *opaque, int level)
80cabfad 159{
daa57963 160 KBDState *s = (KBDState *)opaque;
80cabfad 161
daa57963
FB
162 if (level)
163 s->pending |= KBD_PENDING_KBD;
80cabfad 164 else
daa57963 165 s->pending &= ~KBD_PENDING_KBD;
80cabfad
FB
166 kbd_update_irq(s);
167}
168
daa57963 169static void kbd_update_aux_irq(void *opaque, int level)
80cabfad 170{
daa57963
FB
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);
80cabfad
FB
178}
179
b41a2cd1 180static uint32_t kbd_read_status(void *opaque, uint32_t addr)
80cabfad 181{
b41a2cd1 182 KBDState *s = opaque;
80cabfad
FB
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
daa57963
FB
191static 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
b41a2cd1 199static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
80cabfad 200{
b41a2cd1 201 KBDState *s = opaque;
80cabfad
FB
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:
889bec69 208 kbd_queue(s, s->mode, 0);
80cabfad
FB
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
c68ea704 247 val = 0x01 | (ioport_get_a20() << 1);
80cabfad
FB
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:
c68ea704 259 ioport_set_a20(1);
80cabfad
FB
260 break;
261 case KBD_CCMD_DISABLE_A20:
c68ea704 262 ioport_set_a20(0);
80cabfad
FB
263 break;
264#endif
265 case KBD_CCMD_RESET:
d7d02e3c 266 qemu_system_reset_request();
80cabfad
FB
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
b41a2cd1 277static uint32_t kbd_read_data(void *opaque, uint32_t addr)
80cabfad 278{
63066f4f 279 KBDState *s = opaque;
e41c0f26 280 uint32_t val;
80cabfad 281
daa57963 282 if (s->pending == KBD_PENDING_AUX)
e41c0f26
AZ
283 val = ps2_read_data(s->mouse);
284 else
285 val = ps2_read_data(s->kbd);
80cabfad 286
e41c0f26
AZ
287#if defined(DEBUG_KBD)
288 printf("kbd: read data=0x%02x\n", val);
289#endif
290 return val;
80cabfad
FB
291}
292
9596ebb7 293static void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
80cabfad 294{
b41a2cd1 295 KBDState *s = opaque;
80cabfad
FB
296
297#ifdef DEBUG_KBD
298 printf("kbd: write data=0x%02x\n", val);
299#endif
300
301 switch(s->write_cmd) {
302 case 0:
daa57963 303 ps2_write_keyboard(s->kbd, val);
80cabfad
FB
304 break;
305 case KBD_CCMD_WRITE_MODE:
306 s->mode = val;
f94f5d71 307 ps2_keyboard_set_translation(s->kbd, (s->mode & KBD_MODE_KCC) != 0);
daa57963 308 /* ??? */
80cabfad
FB
309 kbd_update_irq(s);
310 break;
311 case KBD_CCMD_WRITE_OBUF:
312 kbd_queue(s, val, 0);
313 break;
314 case KBD_CCMD_WRITE_AUX_OBUF:
315 kbd_queue(s, val, 1);
316 break;
317 case KBD_CCMD_WRITE_OUTPORT:
318#ifdef TARGET_I386
c68ea704 319 ioport_set_a20((val >> 1) & 1);
80cabfad
FB
320#endif
321 if (!(val & 1)) {
d7d02e3c 322 qemu_system_reset_request();
80cabfad
FB
323 }
324 break;
325 case KBD_CCMD_WRITE_MOUSE:
daa57963 326 ps2_write_mouse(s->mouse, val);
80cabfad
FB
327 break;
328 default:
329 break;
330 }
331 s->write_cmd = 0;
332}
333
d7d02e3c 334static void kbd_reset(void *opaque)
80cabfad 335{
d7d02e3c 336 KBDState *s = opaque;
80cabfad 337
80cabfad
FB
338 s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
339 s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
80cabfad
FB
340}
341
675376f2
FB
342static void kbd_save(QEMUFile* f, void* opaque)
343{
344 KBDState *s = (KBDState*)opaque;
3b46e624 345
675376f2
FB
346 qemu_put_8s(f, &s->write_cmd);
347 qemu_put_8s(f, &s->status);
348 qemu_put_8s(f, &s->mode);
7783e9f0 349 qemu_put_8s(f, &s->pending);
675376f2
FB
350}
351
352static int kbd_load(QEMUFile* f, void* opaque, int version_id)
353{
354 KBDState *s = (KBDState*)opaque;
3b46e624 355
7783e9f0 356 if (version_id != 3)
675376f2
FB
357 return -EINVAL;
358 qemu_get_8s(f, &s->write_cmd);
359 qemu_get_8s(f, &s->status);
360 qemu_get_8s(f, &s->mode);
7783e9f0 361 qemu_get_8s(f, &s->pending);
675376f2
FB
362 return 0;
363}
364
d537cf6c 365void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base)
80cabfad 366{
b41a2cd1 367 KBDState *s = &kbd_state;
b7678d96 368
d537cf6c
PB
369 s->irq_kbd = kbd_irq;
370 s->irq_mouse = mouse_irq;
b92bb99b 371
b41a2cd1 372 kbd_reset(s);
7783e9f0 373 register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
b7678d96
TS
374 register_ioport_read(io_base, 1, 1, kbd_read_data, s);
375 register_ioport_write(io_base, 1, 1, kbd_write_data, s);
376 register_ioport_read(io_base + 4, 1, 1, kbd_read_status, s);
377 register_ioport_write(io_base + 4, 1, 1, kbd_write_command, s);
63066f4f 378
daa57963
FB
379 s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
380 s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
548df2ac
TS
381#ifdef TARGET_I386
382 vmmouse_init(s->mouse);
383#endif
a08d4367 384 qemu_register_reset(kbd_reset, s);
80cabfad 385}
b92bb99b
TS
386
387/* Memory mapped interface */
9596ebb7 388static uint32_t kbd_mm_readb (void *opaque, target_phys_addr_t addr)
b92bb99b
TS
389{
390 KBDState *s = opaque;
391
4efbe58f 392 if (addr & s->mask)
80355292 393 return kbd_read_status(s, 0) & 0xff;
4efbe58f
AJ
394 else
395 return kbd_read_data(s, 0) & 0xff;
b92bb99b
TS
396}
397
9596ebb7 398static void kbd_mm_writeb (void *opaque, target_phys_addr_t addr, uint32_t value)
b92bb99b
TS
399{
400 KBDState *s = opaque;
401
4efbe58f 402 if (addr & s->mask)
80355292 403 kbd_write_command(s, 0, value & 0xff);
4efbe58f
AJ
404 else
405 kbd_write_data(s, 0, value & 0xff);
b92bb99b
TS
406}
407
408static CPUReadMemoryFunc *kbd_mm_read[] = {
409 &kbd_mm_readb,
410 &kbd_mm_readb,
411 &kbd_mm_readb,
412};
413
414static CPUWriteMemoryFunc *kbd_mm_write[] = {
415 &kbd_mm_writeb,
416 &kbd_mm_writeb,
417 &kbd_mm_writeb,
418};
419
71db710f 420void i8042_mm_init(qemu_irq kbd_irq, qemu_irq mouse_irq,
4efbe58f
AJ
421 target_phys_addr_t base, ram_addr_t size,
422 target_phys_addr_t mask)
b92bb99b
TS
423{
424 KBDState *s = &kbd_state;
425 int s_io_memory;
426
427 s->irq_kbd = kbd_irq;
428 s->irq_mouse = mouse_irq;
4efbe58f 429 s->mask = mask;
b92bb99b
TS
430
431 kbd_reset(s);
432 register_savevm("pckbd", 0, 3, kbd_save, kbd_load, s);
1eed09cb 433 s_io_memory = cpu_register_io_memory(kbd_mm_read, kbd_mm_write, s);
4efbe58f 434 cpu_register_physical_memory(base, size, s_io_memory);
b92bb99b
TS
435
436 s->kbd = ps2_kbd_init(kbd_update_kbd_irq, s);
437 s->mouse = ps2_mouse_init(kbd_update_aux_irq, s);
438#ifdef TARGET_I386
439 vmmouse_init(s->mouse);
440#endif
a08d4367 441 qemu_register_reset(kbd_reset, s);
b92bb99b 442}