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
41 #include <netinet/in.h>
46 /* debug PC keyboard */
49 /* debug PC keyboard : only mouse */
52 /* Keyboard Controller Commands */
53 #define KBD_CCMD_READ_MODE 0x20 /* Read mode bits */
54 #define KBD_CCMD_WRITE_MODE 0x60 /* Write mode bits */
55 #define KBD_CCMD_GET_VERSION 0xA1 /* Get controller version */
56 #define KBD_CCMD_MOUSE_DISABLE 0xA7 /* Disable mouse interface */
57 #define KBD_CCMD_MOUSE_ENABLE 0xA8 /* Enable mouse interface */
58 #define KBD_CCMD_TEST_MOUSE 0xA9 /* Mouse interface test */
59 #define KBD_CCMD_SELF_TEST 0xAA /* Controller self test */
60 #define KBD_CCMD_KBD_TEST 0xAB /* Keyboard interface test */
61 #define KBD_CCMD_KBD_DISABLE 0xAD /* Keyboard interface disable */
62 #define KBD_CCMD_KBD_ENABLE 0xAE /* Keyboard interface enable */
63 #define KBD_CCMD_READ_INPORT 0xC0 /* read input port */
64 #define KBD_CCMD_READ_OUTPORT 0xD0 /* read output port */
65 #define KBD_CCMD_WRITE_OUTPORT 0xD1 /* write output port */
66 #define KBD_CCMD_WRITE_OBUF 0xD2
67 #define KBD_CCMD_WRITE_AUX_OBUF 0xD3 /* Write to output buffer as if
68 initiated by the auxiliary device */
69 #define KBD_CCMD_WRITE_MOUSE 0xD4 /* Write the following byte to the mouse */
70 #define KBD_CCMD_DISABLE_A20 0xDD /* HP vectra only ? */
71 #define KBD_CCMD_ENABLE_A20 0xDF /* HP vectra only ? */
72 #define KBD_CCMD_RESET 0xFE
74 /* Keyboard Commands */
75 #define KBD_CMD_SET_LEDS 0xED /* Set keyboard leds */
76 #define KBD_CMD_ECHO 0xEE
77 #define KBD_CMD_GET_ID 0xF2 /* get keyboard ID */
78 #define KBD_CMD_SET_RATE 0xF3 /* Set typematic rate */
79 #define KBD_CMD_ENABLE 0xF4 /* Enable scanning */
80 #define KBD_CMD_RESET_DISABLE 0xF5 /* reset and disable scanning */
81 #define KBD_CMD_RESET_ENABLE 0xF6 /* reset and enable scanning */
82 #define KBD_CMD_RESET 0xFF /* Reset */
84 /* Keyboard Replies */
85 #define KBD_REPLY_POR 0xAA /* Power on reset */
86 #define KBD_REPLY_ACK 0xFA /* Command ACK */
87 #define KBD_REPLY_RESEND 0xFE /* Command NACK, send the cmd again */
89 /* Status Register Bits */
90 #define KBD_STAT_OBF 0x01 /* Keyboard output buffer full */
91 #define KBD_STAT_IBF 0x02 /* Keyboard input buffer full */
92 #define KBD_STAT_SELFTEST 0x04 /* Self test successful */
93 #define KBD_STAT_CMD 0x08 /* Last write was a command write (0=data) */
94 #define KBD_STAT_UNLOCKED 0x10 /* Zero if keyboard locked */
95 #define KBD_STAT_MOUSE_OBF 0x20 /* Mouse output buffer full */
96 #define KBD_STAT_GTO 0x40 /* General receive/xmit timeout */
97 #define KBD_STAT_PERR 0x80 /* Parity error */
99 /* Controller Mode Register Bits */
100 #define KBD_MODE_KBD_INT 0x01 /* Keyboard data generate IRQ1 */
101 #define KBD_MODE_MOUSE_INT 0x02 /* Mouse data generate IRQ12 */
102 #define KBD_MODE_SYS 0x04 /* The system flag (?) */
103 #define KBD_MODE_NO_KEYLOCK 0x08 /* The keylock doesn't affect the keyboard if set */
104 #define KBD_MODE_DISABLE_KBD 0x10 /* Disable keyboard interface */
105 #define KBD_MODE_DISABLE_MOUSE 0x20 /* Disable mouse interface */
106 #define KBD_MODE_KCC 0x40 /* Scan code conversion to PC format */
107 #define KBD_MODE_RFU 0x80
110 #define AUX_SET_SCALE11 0xE6 /* Set 1:1 scaling */
111 #define AUX_SET_SCALE21 0xE7 /* Set 2:1 scaling */
112 #define AUX_SET_RES 0xE8 /* Set resolution */
113 #define AUX_GET_SCALE 0xE9 /* Get scaling factor */
114 #define AUX_SET_STREAM 0xEA /* Set stream mode */
115 #define AUX_POLL 0xEB /* Poll */
116 #define AUX_RESET_WRAP 0xEC /* Reset wrap mode */
117 #define AUX_SET_WRAP 0xEE /* Set wrap mode */
118 #define AUX_SET_REMOTE 0xF0 /* Set remote mode */
119 #define AUX_GET_TYPE 0xF2 /* Get type */
120 #define AUX_SET_SAMPLE 0xF3 /* Set sample rate */
121 #define AUX_ENABLE_DEV 0xF4 /* Enable aux device */
122 #define AUX_DISABLE_DEV 0xF5 /* Disable aux device */
123 #define AUX_SET_DEFAULT 0xF6
124 #define AUX_RESET 0xFF /* Reset aux device */
125 #define AUX_ACK 0xFA /* Command byte ACK. */
127 #define MOUSE_STATUS_REMOTE 0x40
128 #define MOUSE_STATUS_ENABLED 0x20
129 #define MOUSE_STATUS_SCALE21 0x10
131 #define KBD_QUEUE_SIZE 256
134 uint8_t data[KBD_QUEUE_SIZE];
135 int rptr, wptr, count;
138 typedef struct KBDState {
140 uint8_t write_cmd; /* if non zero, write data to port 60 is expected */
148 uint8_t mouse_status;
149 uint8_t mouse_resolution;
150 uint8_t mouse_sample_rate;
152 uint8_t mouse_type; /* 0 = PS2, 3 = IMPS/2, 4 = IMEX */
153 uint8_t mouse_detect_state;
154 int mouse_dx; /* current values, needed for 'poll' mode */
157 uint8_t mouse_buttons;
163 /* update irq and KBD_STAT_[MOUSE_]OBF */
164 /* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
165 incorrect, but it avoids having to simulate exact delays */
166 static void kbd_update_irq(KBDState *s)
168 int irq12_level, irq1_level;
172 s->status &= ~(KBD_STAT_OBF | KBD_STAT_MOUSE_OBF);
173 if (s->queues[0].count != 0 ||
174 s->queues[1].count != 0) {
175 s->status |= KBD_STAT_OBF;
176 if (s->queues[1].count != 0) {
177 s->status |= KBD_STAT_MOUSE_OBF;
178 if (s->mode & KBD_MODE_MOUSE_INT)
181 if ((s->mode & KBD_MODE_KBD_INT) &&
182 !(s->mode & KBD_MODE_DISABLE_KBD))
186 pic_set_irq(1, irq1_level);
187 pic_set_irq(12, irq12_level);
190 static void kbd_queue(KBDState *s, int b, int aux)
192 KBDQueue *q = &s->queues[aux];
194 #if defined(DEBUG_MOUSE) || defined(DEBUG_KBD)
196 printf("mouse event: 0x%02x\n", b);
199 printf("kbd event: 0x%02x\n", b);
202 if (q->count >= KBD_QUEUE_SIZE)
204 q->data[q->wptr] = b;
205 if (++q->wptr == KBD_QUEUE_SIZE)
211 void kbd_put_keycode(int keycode)
213 KBDState *s = &kbd_state;
214 kbd_queue(s, keycode, 0);
217 static uint32_t kbd_read_status(void *opaque, uint32_t addr)
219 KBDState *s = opaque;
222 #if defined(DEBUG_KBD)
223 printf("kbd: read status=0x%02x\n", val);
228 static void kbd_write_command(void *opaque, uint32_t addr, uint32_t val)
230 KBDState *s = opaque;
233 printf("kbd: write cmd=0x%02x\n", val);
236 case KBD_CCMD_READ_MODE:
237 kbd_queue(s, s->mode, 0);
239 case KBD_CCMD_WRITE_MODE:
240 case KBD_CCMD_WRITE_OBUF:
241 case KBD_CCMD_WRITE_AUX_OBUF:
242 case KBD_CCMD_WRITE_MOUSE:
243 case KBD_CCMD_WRITE_OUTPORT:
246 case KBD_CCMD_MOUSE_DISABLE:
247 s->mode |= KBD_MODE_DISABLE_MOUSE;
249 case KBD_CCMD_MOUSE_ENABLE:
250 s->mode &= ~KBD_MODE_DISABLE_MOUSE;
252 case KBD_CCMD_TEST_MOUSE:
253 kbd_queue(s, 0x00, 0);
255 case KBD_CCMD_SELF_TEST:
256 s->status |= KBD_STAT_SELFTEST;
257 kbd_queue(s, 0x55, 0);
259 case KBD_CCMD_KBD_TEST:
260 kbd_queue(s, 0x00, 0);
262 case KBD_CCMD_KBD_DISABLE:
263 s->mode |= KBD_MODE_DISABLE_KBD;
266 case KBD_CCMD_KBD_ENABLE:
267 s->mode &= ~KBD_MODE_DISABLE_KBD;
270 case KBD_CCMD_READ_INPORT:
271 kbd_queue(s, 0x00, 0);
273 case KBD_CCMD_READ_OUTPORT:
274 /* XXX: check that */
276 val = 0x01 | (((cpu_single_env->a20_mask >> 20) & 1) << 1);
280 if (s->status & KBD_STAT_OBF)
282 if (s->status & KBD_STAT_MOUSE_OBF)
284 kbd_queue(s, val, 0);
287 case KBD_CCMD_ENABLE_A20:
288 cpu_x86_set_a20(cpu_single_env, 1);
290 case KBD_CCMD_DISABLE_A20:
291 cpu_x86_set_a20(cpu_single_env, 0);
296 cpu_interrupt(cpu_single_env, CPU_INTERRUPT_EXIT);
299 /* ignore that - I don't know what is its use */
302 fprintf(stderr, "qemu: unsupported keyboard cmd=0x%02x\n", val);
307 static uint32_t kbd_read_data(void *opaque, uint32_t addr)
309 KBDState *s = opaque;
313 q = &s->queues[0]; /* first check KBD data */
315 q = &s->queues[1]; /* then check AUX data */
317 /* NOTE: if no data left, we return the last keyboard one
318 (needed for EMM386) */
319 /* XXX: need a timer to do things correctly */
323 index = KBD_QUEUE_SIZE - 1;
324 val = q->data[index];
326 val = q->data[q->rptr];
327 if (++q->rptr == KBD_QUEUE_SIZE)
330 /* reading deasserts IRQ */
331 if (q == &s->queues[0])
336 /* reassert IRQs if data left */
339 printf("kbd: read data=0x%02x\n", val);
344 static void kbd_reset_keyboard(KBDState *s)
349 static void kbd_write_keyboard(KBDState *s, int val)
351 switch(s->kbd_write_cmd) {
356 kbd_queue(s, KBD_REPLY_ACK, 0);
359 kbd_queue(s, KBD_REPLY_RESEND, 0);
362 kbd_queue(s, KBD_REPLY_ACK, 0);
363 kbd_queue(s, 0xab, 0);
364 kbd_queue(s, 0x83, 0);
367 kbd_queue(s, KBD_CMD_ECHO, 0);
371 kbd_queue(s, KBD_REPLY_ACK, 0);
373 case KBD_CMD_SET_LEDS:
374 case KBD_CMD_SET_RATE:
375 s->kbd_write_cmd = val;
376 kbd_queue(s, KBD_REPLY_ACK, 0);
378 case KBD_CMD_RESET_DISABLE:
379 kbd_reset_keyboard(s);
381 kbd_queue(s, KBD_REPLY_ACK, 0);
383 case KBD_CMD_RESET_ENABLE:
384 kbd_reset_keyboard(s);
386 kbd_queue(s, KBD_REPLY_ACK, 0);
389 kbd_reset_keyboard(s);
390 kbd_queue(s, KBD_REPLY_ACK, 0);
391 kbd_queue(s, KBD_REPLY_POR, 0);
394 kbd_queue(s, KBD_REPLY_ACK, 0);
398 case KBD_CMD_SET_LEDS:
399 kbd_queue(s, KBD_REPLY_ACK, 0);
400 s->kbd_write_cmd = -1;
402 case KBD_CMD_SET_RATE:
403 kbd_queue(s, KBD_REPLY_ACK, 0);
404 s->kbd_write_cmd = -1;
409 static void kbd_mouse_send_packet(KBDState *s)
417 /* XXX: increase range to 8 bits ? */
426 b = 0x08 | ((dx1 < 0) << 4) | ((dy1 < 0) << 5) | (s->mouse_buttons & 0x07);
428 kbd_queue(s, dx1 & 0xff, 1);
429 kbd_queue(s, dy1 & 0xff, 1);
430 /* extra byte for IMPS/2 or IMEX */
431 switch(s->mouse_type) {
439 kbd_queue(s, dz1 & 0xff, 1);
446 b = (dz1 & 0x0f) | ((s->mouse_buttons & 0x18) << 1);
457 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state)
459 KBDState *s = &kbd_state;
461 /* check if deltas are recorded when disabled */
462 if (!(s->mouse_status & MOUSE_STATUS_ENABLED))
468 s->mouse_buttons = buttons_state;
470 if (!(s->mouse_status & MOUSE_STATUS_REMOTE) &&
471 (s->queues[1].count < (KBD_QUEUE_SIZE - 16))) {
473 /* if not remote, send event. Multiple events are sent if
475 kbd_mouse_send_packet(s);
476 if (s->mouse_dx == 0 && s->mouse_dy == 0 && s->mouse_dz == 0)
482 static void kbd_write_mouse(KBDState *s, int val)
485 printf("kbd: write mouse 0x%02x\n", val);
487 switch(s->mouse_write_cmd) {
492 if (val == AUX_RESET_WRAP) {
494 kbd_queue(s, AUX_ACK, 1);
496 } else if (val != AUX_RESET) {
497 kbd_queue(s, val, 1);
502 case AUX_SET_SCALE11:
503 s->mouse_status &= ~MOUSE_STATUS_SCALE21;
504 kbd_queue(s, AUX_ACK, 1);
506 case AUX_SET_SCALE21:
507 s->mouse_status |= MOUSE_STATUS_SCALE21;
508 kbd_queue(s, AUX_ACK, 1);
511 s->mouse_status &= ~MOUSE_STATUS_REMOTE;
512 kbd_queue(s, AUX_ACK, 1);
516 kbd_queue(s, AUX_ACK, 1);
519 s->mouse_status |= MOUSE_STATUS_REMOTE;
520 kbd_queue(s, AUX_ACK, 1);
523 kbd_queue(s, AUX_ACK, 1);
524 kbd_queue(s, s->mouse_type, 1);
528 s->mouse_write_cmd = val;
529 kbd_queue(s, AUX_ACK, 1);
532 kbd_queue(s, AUX_ACK, 1);
533 kbd_queue(s, s->mouse_status, 1);
534 kbd_queue(s, s->mouse_resolution, 1);
535 kbd_queue(s, s->mouse_sample_rate, 1);
538 kbd_queue(s, AUX_ACK, 1);
539 kbd_mouse_send_packet(s);
542 s->mouse_status |= MOUSE_STATUS_ENABLED;
543 kbd_queue(s, AUX_ACK, 1);
545 case AUX_DISABLE_DEV:
546 s->mouse_status &= ~MOUSE_STATUS_ENABLED;
547 kbd_queue(s, AUX_ACK, 1);
549 case AUX_SET_DEFAULT:
550 s->mouse_sample_rate = 100;
551 s->mouse_resolution = 2;
553 kbd_queue(s, AUX_ACK, 1);
556 s->mouse_sample_rate = 100;
557 s->mouse_resolution = 2;
559 kbd_queue(s, AUX_ACK, 1);
560 kbd_queue(s, 0xaa, 1);
561 kbd_queue(s, s->mouse_type, 1);
568 s->mouse_sample_rate = val;
570 /* detect IMPS/2 or IMEX */
571 switch(s->mouse_detect_state) {
575 s->mouse_detect_state = 1;
579 s->mouse_detect_state = 2;
581 s->mouse_detect_state = 3;
583 s->mouse_detect_state = 0;
587 s->mouse_type = 3; /* IMPS/2 */
588 s->mouse_detect_state = 0;
592 s->mouse_type = 4; /* IMEX */
593 s->mouse_detect_state = 0;
597 kbd_queue(s, AUX_ACK, 1);
598 s->mouse_write_cmd = -1;
601 s->mouse_resolution = val;
602 kbd_queue(s, AUX_ACK, 1);
603 s->mouse_write_cmd = -1;
608 void kbd_write_data(void *opaque, uint32_t addr, uint32_t val)
610 KBDState *s = opaque;
613 printf("kbd: write data=0x%02x\n", val);
616 switch(s->write_cmd) {
618 kbd_write_keyboard(s, val);
620 case KBD_CCMD_WRITE_MODE:
624 case KBD_CCMD_WRITE_OBUF:
625 kbd_queue(s, val, 0);
627 case KBD_CCMD_WRITE_AUX_OBUF:
628 kbd_queue(s, val, 1);
630 case KBD_CCMD_WRITE_OUTPORT:
632 cpu_x86_set_a20(cpu_single_env, (val >> 1) & 1);
636 cpu_interrupt(cpu_single_env, CPU_INTERRUPT_EXIT);
639 case KBD_CCMD_WRITE_MOUSE:
640 kbd_write_mouse(s, val);
648 void kbd_reset(KBDState *s)
653 s->kbd_write_cmd = -1;
654 s->mouse_write_cmd = -1;
655 s->mode = KBD_MODE_KBD_INT | KBD_MODE_MOUSE_INT;
656 s->status = KBD_STAT_CMD | KBD_STAT_UNLOCKED;
657 for(i = 0; i < 2; i++) {
667 KBDState *s = &kbd_state;
670 register_ioport_read(0x60, 1, 1, kbd_read_data, s);
671 register_ioport_write(0x60, 1, 1, kbd_write_data, s);
672 register_ioport_read(0x64, 1, 1, kbd_read_status, s);
673 register_ioport_write(0x64, 1, 1, kbd_write_command, s);