]>
git.proxmox.com Git - qemu.git/blob - hw/pckbd.c
be559eb4f6de3b2ca1562d77fee6f9a137a32c9b
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
114 uint8_t aux
[KBD_QUEUE_SIZE
];
115 uint8_t data
[KBD_QUEUE_SIZE
];
116 int rptr
, wptr
, count
;
119 typedef struct KBDState
{
121 uint8_t write_cmd
; /* if non zero, write data to port 60 is expected */
129 uint8_t mouse_status
;
130 uint8_t mouse_resolution
;
131 uint8_t mouse_sample_rate
;
133 uint8_t mouse_type
; /* 0 = PS2, 3 = IMPS/2, 4 = IMEX */
134 uint8_t mouse_detect_state
;
135 int mouse_dx
; /* current values, needed for 'poll' mode */
138 uint8_t mouse_buttons
;
143 /* update irq and KBD_STAT_[MOUSE_]OBF */
144 /* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
145 incorrect, but it avoids having to simulate exact delays */
146 static void kbd_update_irq(KBDState
*s
)
148 KBDQueue
*q
= &s
->queue
;
149 int irq12_level
, irq1_level
;
153 s
->status
&= ~(KBD_STAT_OBF
| KBD_STAT_MOUSE_OBF
);
155 s
->status
|= KBD_STAT_OBF
;
156 if (q
->aux
[q
->rptr
]) {
157 s
->status
|= KBD_STAT_MOUSE_OBF
;
158 if (s
->mode
& KBD_MODE_MOUSE_INT
)
161 if ((s
->mode
& KBD_MODE_KBD_INT
) &&
162 !(s
->mode
& KBD_MODE_DISABLE_KBD
))
166 pic_set_irq(1, irq1_level
);
167 pic_set_irq(12, irq12_level
);
170 static void kbd_queue(KBDState
*s
, int b
, int aux
)
172 KBDQueue
*q
= &s
->queue
;
174 #if defined(DEBUG_MOUSE) || defined(DEBUG_KBD)
176 printf("mouse event: 0x%02x\n", b
);
179 printf("kbd event: 0x%02x\n", b
);
182 if (q
->count
>= KBD_QUEUE_SIZE
)
184 q
->aux
[q
->wptr
] = aux
;
185 q
->data
[q
->wptr
] = b
;
186 if (++q
->wptr
== KBD_QUEUE_SIZE
)
192 static void pc_kbd_put_keycode(void *opaque
, int keycode
)
194 KBDState
*s
= opaque
;
195 kbd_queue(s
, keycode
, 0);
198 static uint32_t kbd_read_status(void *opaque
, uint32_t addr
)
200 KBDState
*s
= opaque
;
203 #if defined(DEBUG_KBD)
204 printf("kbd: read status=0x%02x\n", val
);
209 static void kbd_write_command(void *opaque
, uint32_t addr
, uint32_t val
)
211 KBDState
*s
= opaque
;
214 printf("kbd: write cmd=0x%02x\n", val
);
217 case KBD_CCMD_READ_MODE
:
218 kbd_queue(s
, s
->mode
, 0);
220 case KBD_CCMD_WRITE_MODE
:
221 case KBD_CCMD_WRITE_OBUF
:
222 case KBD_CCMD_WRITE_AUX_OBUF
:
223 case KBD_CCMD_WRITE_MOUSE
:
224 case KBD_CCMD_WRITE_OUTPORT
:
227 case KBD_CCMD_MOUSE_DISABLE
:
228 s
->mode
|= KBD_MODE_DISABLE_MOUSE
;
230 case KBD_CCMD_MOUSE_ENABLE
:
231 s
->mode
&= ~KBD_MODE_DISABLE_MOUSE
;
233 case KBD_CCMD_TEST_MOUSE
:
234 kbd_queue(s
, 0x00, 0);
236 case KBD_CCMD_SELF_TEST
:
237 s
->status
|= KBD_STAT_SELFTEST
;
238 kbd_queue(s
, 0x55, 0);
240 case KBD_CCMD_KBD_TEST
:
241 kbd_queue(s
, 0x00, 0);
243 case KBD_CCMD_KBD_DISABLE
:
244 s
->mode
|= KBD_MODE_DISABLE_KBD
;
247 case KBD_CCMD_KBD_ENABLE
:
248 s
->mode
&= ~KBD_MODE_DISABLE_KBD
;
251 case KBD_CCMD_READ_INPORT
:
252 kbd_queue(s
, 0x00, 0);
254 case KBD_CCMD_READ_OUTPORT
:
255 /* XXX: check that */
257 val
= 0x01 | (((cpu_single_env
->a20_mask
>> 20) & 1) << 1);
261 if (s
->status
& KBD_STAT_OBF
)
263 if (s
->status
& KBD_STAT_MOUSE_OBF
)
265 kbd_queue(s
, val
, 0);
268 case KBD_CCMD_ENABLE_A20
:
269 cpu_x86_set_a20(cpu_single_env
, 1);
271 case KBD_CCMD_DISABLE_A20
:
272 cpu_x86_set_a20(cpu_single_env
, 0);
276 qemu_system_reset_request();
279 /* ignore that - I don't know what is its use */
282 fprintf(stderr
, "qemu: unsupported keyboard cmd=0x%02x\n", val
);
287 static uint32_t kbd_read_data(void *opaque
, uint32_t addr
)
289 KBDState
*s
= opaque
;
295 /* NOTE: if no data left, we return the last keyboard one
296 (needed for EMM386) */
297 /* XXX: need a timer to do things correctly */
300 index
= KBD_QUEUE_SIZE
- 1;
301 val
= q
->data
[index
];
303 aux
= q
->aux
[q
->rptr
];
304 val
= q
->data
[q
->rptr
];
305 if (++q
->rptr
== KBD_QUEUE_SIZE
)
308 /* reading deasserts IRQ */
314 /* reassert IRQs if data left */
317 printf("kbd: read data=0x%02x\n", val
);
322 static void kbd_reset_keyboard(KBDState
*s
)
327 static void kbd_write_keyboard(KBDState
*s
, int val
)
329 switch(s
->kbd_write_cmd
) {
334 kbd_queue(s
, KBD_REPLY_ACK
, 0);
337 kbd_queue(s
, KBD_REPLY_RESEND
, 0);
340 kbd_queue(s
, KBD_REPLY_ACK
, 0);
341 kbd_queue(s
, 0xab, 0);
342 kbd_queue(s
, 0x83, 0);
345 kbd_queue(s
, KBD_CMD_ECHO
, 0);
349 kbd_queue(s
, KBD_REPLY_ACK
, 0);
351 case KBD_CMD_SET_LEDS
:
352 case KBD_CMD_SET_RATE
:
353 s
->kbd_write_cmd
= val
;
354 kbd_queue(s
, KBD_REPLY_ACK
, 0);
356 case KBD_CMD_RESET_DISABLE
:
357 kbd_reset_keyboard(s
);
359 kbd_queue(s
, KBD_REPLY_ACK
, 0);
361 case KBD_CMD_RESET_ENABLE
:
362 kbd_reset_keyboard(s
);
364 kbd_queue(s
, KBD_REPLY_ACK
, 0);
367 kbd_reset_keyboard(s
);
368 kbd_queue(s
, KBD_REPLY_ACK
, 0);
369 kbd_queue(s
, KBD_REPLY_POR
, 0);
372 kbd_queue(s
, KBD_REPLY_ACK
, 0);
376 case KBD_CMD_SET_LEDS
:
377 kbd_queue(s
, KBD_REPLY_ACK
, 0);
378 s
->kbd_write_cmd
= -1;
380 case KBD_CMD_SET_RATE
:
381 kbd_queue(s
, KBD_REPLY_ACK
, 0);
382 s
->kbd_write_cmd
= -1;
387 static void kbd_mouse_send_packet(KBDState
*s
)
395 /* XXX: increase range to 8 bits ? */
404 b
= 0x08 | ((dx1
< 0) << 4) | ((dy1
< 0) << 5) | (s
->mouse_buttons
& 0x07);
406 kbd_queue(s
, dx1
& 0xff, 1);
407 kbd_queue(s
, dy1
& 0xff, 1);
408 /* extra byte for IMPS/2 or IMEX */
409 switch(s
->mouse_type
) {
417 kbd_queue(s
, dz1
& 0xff, 1);
424 b
= (dz1
& 0x0f) | ((s
->mouse_buttons
& 0x18) << 1);
435 static void pc_kbd_mouse_event(void *opaque
,
436 int dx
, int dy
, int dz
, int buttons_state
)
438 KBDState
*s
= opaque
;
440 /* check if deltas are recorded when disabled */
441 if (!(s
->mouse_status
& MOUSE_STATUS_ENABLED
))
447 /* XXX: SDL sometimes generates nul events: we delete them */
448 if (s
->mouse_dx
== 0 && s
->mouse_dy
== 0 && s
->mouse_dz
== 0 &&
449 s
->mouse_buttons
== buttons_state
)
451 s
->mouse_buttons
= buttons_state
;
453 if (!(s
->mouse_status
& MOUSE_STATUS_REMOTE
) &&
454 (s
->queue
.count
< (KBD_QUEUE_SIZE
- 16))) {
456 /* if not remote, send event. Multiple events are sent if
458 kbd_mouse_send_packet(s
);
459 if (s
->mouse_dx
== 0 && s
->mouse_dy
== 0 && s
->mouse_dz
== 0)
465 static void kbd_write_mouse(KBDState
*s
, int val
)
468 printf("kbd: write mouse 0x%02x\n", val
);
470 switch(s
->mouse_write_cmd
) {
475 if (val
== AUX_RESET_WRAP
) {
477 kbd_queue(s
, AUX_ACK
, 1);
479 } else if (val
!= AUX_RESET
) {
480 kbd_queue(s
, val
, 1);
485 case AUX_SET_SCALE11
:
486 s
->mouse_status
&= ~MOUSE_STATUS_SCALE21
;
487 kbd_queue(s
, AUX_ACK
, 1);
489 case AUX_SET_SCALE21
:
490 s
->mouse_status
|= MOUSE_STATUS_SCALE21
;
491 kbd_queue(s
, AUX_ACK
, 1);
494 s
->mouse_status
&= ~MOUSE_STATUS_REMOTE
;
495 kbd_queue(s
, AUX_ACK
, 1);
499 kbd_queue(s
, AUX_ACK
, 1);
502 s
->mouse_status
|= MOUSE_STATUS_REMOTE
;
503 kbd_queue(s
, AUX_ACK
, 1);
506 kbd_queue(s
, AUX_ACK
, 1);
507 kbd_queue(s
, s
->mouse_type
, 1);
511 s
->mouse_write_cmd
= val
;
512 kbd_queue(s
, AUX_ACK
, 1);
515 kbd_queue(s
, AUX_ACK
, 1);
516 kbd_queue(s
, s
->mouse_status
, 1);
517 kbd_queue(s
, s
->mouse_resolution
, 1);
518 kbd_queue(s
, s
->mouse_sample_rate
, 1);
521 kbd_queue(s
, AUX_ACK
, 1);
522 kbd_mouse_send_packet(s
);
525 s
->mouse_status
|= MOUSE_STATUS_ENABLED
;
526 kbd_queue(s
, AUX_ACK
, 1);
528 case AUX_DISABLE_DEV
:
529 s
->mouse_status
&= ~MOUSE_STATUS_ENABLED
;
530 kbd_queue(s
, AUX_ACK
, 1);
532 case AUX_SET_DEFAULT
:
533 s
->mouse_sample_rate
= 100;
534 s
->mouse_resolution
= 2;
536 kbd_queue(s
, AUX_ACK
, 1);
539 s
->mouse_sample_rate
= 100;
540 s
->mouse_resolution
= 2;
543 kbd_queue(s
, AUX_ACK
, 1);
544 kbd_queue(s
, 0xaa, 1);
545 kbd_queue(s
, s
->mouse_type
, 1);
552 s
->mouse_sample_rate
= val
;
553 /* detect IMPS/2 or IMEX */
554 switch(s
->mouse_detect_state
) {
558 s
->mouse_detect_state
= 1;
562 s
->mouse_detect_state
= 2;
564 s
->mouse_detect_state
= 3;
566 s
->mouse_detect_state
= 0;
570 s
->mouse_type
= 3; /* IMPS/2 */
571 s
->mouse_detect_state
= 0;
575 s
->mouse_type
= 4; /* IMEX */
576 s
->mouse_detect_state
= 0;
579 kbd_queue(s
, AUX_ACK
, 1);
580 s
->mouse_write_cmd
= -1;
583 s
->mouse_resolution
= val
;
584 kbd_queue(s
, AUX_ACK
, 1);
585 s
->mouse_write_cmd
= -1;
590 void kbd_write_data(void *opaque
, uint32_t addr
, uint32_t val
)
592 KBDState
*s
= opaque
;
595 printf("kbd: write data=0x%02x\n", val
);
598 switch(s
->write_cmd
) {
600 kbd_write_keyboard(s
, val
);
602 case KBD_CCMD_WRITE_MODE
:
606 case KBD_CCMD_WRITE_OBUF
:
607 kbd_queue(s
, val
, 0);
609 case KBD_CCMD_WRITE_AUX_OBUF
:
610 kbd_queue(s
, val
, 1);
612 case KBD_CCMD_WRITE_OUTPORT
:
614 cpu_x86_set_a20(cpu_single_env
, (val
>> 1) & 1);
617 qemu_system_reset_request();
620 case KBD_CCMD_WRITE_MOUSE
:
621 kbd_write_mouse(s
, val
);
629 static void kbd_reset(void *opaque
)
631 KBDState
*s
= opaque
;
634 s
->kbd_write_cmd
= -1;
635 s
->mouse_write_cmd
= -1;
636 s
->mode
= KBD_MODE_KBD_INT
| KBD_MODE_MOUSE_INT
;
637 s
->status
= KBD_STAT_CMD
| KBD_STAT_UNLOCKED
;
644 static void kbd_save(QEMUFile
* f
, void* opaque
)
646 KBDState
*s
= (KBDState
*)opaque
;
648 qemu_put_8s(f
, &s
->write_cmd
);
649 qemu_put_8s(f
, &s
->status
);
650 qemu_put_8s(f
, &s
->mode
);
651 qemu_put_be32s(f
, &s
->kbd_write_cmd
);
652 qemu_put_be32s(f
, &s
->scan_enabled
);
653 qemu_put_be32s(f
, &s
->mouse_write_cmd
);
654 qemu_put_8s(f
, &s
->mouse_status
);
655 qemu_put_8s(f
, &s
->mouse_resolution
);
656 qemu_put_8s(f
, &s
->mouse_sample_rate
);
657 qemu_put_8s(f
, &s
->mouse_wrap
);
658 qemu_put_8s(f
, &s
->mouse_type
);
659 qemu_put_8s(f
, &s
->mouse_detect_state
);
660 qemu_put_be32s(f
, &s
->mouse_dx
);
661 qemu_put_be32s(f
, &s
->mouse_dy
);
662 qemu_put_be32s(f
, &s
->mouse_dz
);
663 qemu_put_8s(f
, &s
->mouse_buttons
);
666 static int kbd_load(QEMUFile
* f
, void* opaque
, int version_id
)
668 KBDState
*s
= (KBDState
*)opaque
;
672 qemu_get_8s(f
, &s
->write_cmd
);
673 qemu_get_8s(f
, &s
->status
);
674 qemu_get_8s(f
, &s
->mode
);
675 qemu_get_be32s(f
, &s
->kbd_write_cmd
);
676 qemu_get_be32s(f
, &s
->scan_enabled
);
677 qemu_get_be32s(f
, &s
->mouse_write_cmd
);
678 qemu_get_8s(f
, &s
->mouse_status
);
679 qemu_get_8s(f
, &s
->mouse_resolution
);
680 qemu_get_8s(f
, &s
->mouse_sample_rate
);
681 qemu_get_8s(f
, &s
->mouse_wrap
);
682 qemu_get_8s(f
, &s
->mouse_type
);
683 qemu_get_8s(f
, &s
->mouse_detect_state
);
684 qemu_get_be32s(f
, &s
->mouse_dx
);
685 qemu_get_be32s(f
, &s
->mouse_dy
);
686 qemu_get_be32s(f
, &s
->mouse_dz
);
687 qemu_get_8s(f
, &s
->mouse_buttons
);
693 KBDState
*s
= &kbd_state
;
696 register_savevm("pckbd", 0, 1, kbd_save
, kbd_load
, s
);
697 register_ioport_read(0x60, 1, 1, kbd_read_data
, s
);
698 register_ioport_write(0x60, 1, 1, kbd_write_data
, s
);
699 register_ioport_read(0x64, 1, 1, kbd_read_status
, s
);
700 register_ioport_write(0x64, 1, 1, kbd_write_command
, s
);
702 qemu_add_kbd_event_handler(pc_kbd_put_keycode
, s
);
703 qemu_add_mouse_event_handler(pc_kbd_mouse_event
, s
);
704 qemu_register_reset(kbd_reset
, s
);