2 * QEMU PS/2 keyboard/mouse 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
28 /* debug PC keyboard */
31 /* debug PC keyboard : only mouse */
34 /* Keyboard Commands */
35 #define KBD_CMD_SET_LEDS 0xED /* Set keyboard leds */
36 #define KBD_CMD_ECHO 0xEE
37 #define KBD_CMD_SCANCODE 0xF0 /* Get/set scancode set */
38 #define KBD_CMD_GET_ID 0xF2 /* get keyboard ID */
39 #define KBD_CMD_SET_RATE 0xF3 /* Set typematic rate */
40 #define KBD_CMD_ENABLE 0xF4 /* Enable scanning */
41 #define KBD_CMD_RESET_DISABLE 0xF5 /* reset and disable scanning */
42 #define KBD_CMD_RESET_ENABLE 0xF6 /* reset and enable scanning */
43 #define KBD_CMD_RESET 0xFF /* Reset */
45 /* Keyboard Replies */
46 #define KBD_REPLY_POR 0xAA /* Power on reset */
47 #define KBD_REPLY_ID 0xAB /* Keyboard ID */
48 #define KBD_REPLY_ACK 0xFA /* Command ACK */
49 #define KBD_REPLY_RESEND 0xFE /* Command NACK, send the cmd again */
52 #define AUX_SET_SCALE11 0xE6 /* Set 1:1 scaling */
53 #define AUX_SET_SCALE21 0xE7 /* Set 2:1 scaling */
54 #define AUX_SET_RES 0xE8 /* Set resolution */
55 #define AUX_GET_SCALE 0xE9 /* Get scaling factor */
56 #define AUX_SET_STREAM 0xEA /* Set stream mode */
57 #define AUX_POLL 0xEB /* Poll */
58 #define AUX_RESET_WRAP 0xEC /* Reset wrap mode */
59 #define AUX_SET_WRAP 0xEE /* Set wrap mode */
60 #define AUX_SET_REMOTE 0xF0 /* Set remote mode */
61 #define AUX_GET_TYPE 0xF2 /* Get type */
62 #define AUX_SET_SAMPLE 0xF3 /* Set sample rate */
63 #define AUX_ENABLE_DEV 0xF4 /* Enable aux device */
64 #define AUX_DISABLE_DEV 0xF5 /* Disable aux device */
65 #define AUX_SET_DEFAULT 0xF6
66 #define AUX_RESET 0xFF /* Reset aux device */
67 #define AUX_ACK 0xFA /* Command byte ACK. */
69 #define MOUSE_STATUS_REMOTE 0x40
70 #define MOUSE_STATUS_ENABLED 0x20
71 #define MOUSE_STATUS_SCALE21 0x10
73 #define PS2_QUEUE_SIZE 256
76 uint8_t data
[PS2_QUEUE_SIZE
];
77 int rptr
, wptr
, count
;
83 void (*update_irq
)(void *, int);
90 /* Qemu uses translated PC scancodes internally. To avoid multiple
91 conversions we do the translation (if any) in the PS/2 emulation
92 not the keyboard controller. */
94 int scancode_set
; /* 1=XT, 2=AT, 3=PS/2 */
100 uint8_t mouse_resolution
;
101 uint8_t mouse_sample_rate
;
103 uint8_t mouse_type
; /* 0 = PS2, 3 = IMPS/2, 4 = IMEX */
104 uint8_t mouse_detect_state
;
105 int mouse_dx
; /* current values, needed for 'poll' mode */
108 uint8_t mouse_buttons
;
111 /* Table to convert from PC scancodes to raw scancodes. */
112 static const unsigned char ps2_raw_keycode
[128] = {
113 0,118, 22, 30, 38, 37, 46, 54, 61, 62, 70, 69, 78, 85,102, 13,
114 21, 29, 36, 45, 44, 53, 60, 67, 68, 77, 84, 91, 90, 20, 28, 27,
115 35, 43, 52, 51, 59, 66, 75, 76, 82, 14, 18, 93, 26, 34, 33, 42,
116 50, 49, 58, 65, 73, 74, 89,124, 17, 41, 88, 5, 6, 4, 12, 3,
117 11, 2, 10, 1, 9,119,126,108,117,125,123,107,115,116,121,105,
118 114,122,112,113,127, 96, 97,120, 7, 15, 23, 31, 39, 47, 55, 63,
119 71, 79, 86, 94, 8, 16, 24, 32, 40, 48, 56, 64, 72, 80, 87,111,
120 19, 25, 57, 81, 83, 92, 95, 98, 99,100,101,103,104,106,109,110
123 void ps2_queue(void *opaque
, int b
)
125 PS2State
*s
= (PS2State
*)opaque
;
126 PS2Queue
*q
= &s
->queue
;
128 if (q
->count
>= PS2_QUEUE_SIZE
)
130 q
->data
[q
->wptr
] = b
;
131 if (++q
->wptr
== PS2_QUEUE_SIZE
)
134 s
->update_irq(s
->update_arg
, 1);
138 keycode is expressed as follow:
139 bit 7 - 0 key pressed, 1 = key released
140 bits 6-0 - translated scancode set 2
142 static void ps2_put_keycode(void *opaque
, int keycode
)
144 PS2KbdState
*s
= opaque
;
146 /* XXX: add support for scancode sets 1 and 3 */
147 if (!s
->translate
&& keycode
< 0xe0 && s
->scancode_set
== 2)
150 ps2_queue(&s
->common
, 0xf0);
151 keycode
= ps2_raw_keycode
[keycode
& 0x7f];
153 ps2_queue(&s
->common
, keycode
);
156 uint32_t ps2_read_data(void *opaque
)
158 PS2State
*s
= (PS2State
*)opaque
;
164 /* NOTE: if no data left, we return the last keyboard one
165 (needed for EMM386) */
166 /* XXX: need a timer to do things correctly */
169 index
= PS2_QUEUE_SIZE
- 1;
170 val
= q
->data
[index
];
172 val
= q
->data
[q
->rptr
];
173 if (++q
->rptr
== PS2_QUEUE_SIZE
)
176 /* reading deasserts IRQ */
177 s
->update_irq(s
->update_arg
, 0);
178 /* reassert IRQs if data left */
179 s
->update_irq(s
->update_arg
, q
->count
!= 0);
184 static void ps2_reset_keyboard(PS2KbdState
*s
)
190 void ps2_write_keyboard(void *opaque
, int val
)
192 PS2KbdState
*s
= (PS2KbdState
*)opaque
;
194 switch(s
->common
.write_cmd
) {
199 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
202 ps2_queue(&s
->common
, KBD_REPLY_RESEND
);
205 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
206 /* We emulate a MF2 AT keyboard here */
207 ps2_queue(&s
->common
, KBD_REPLY_ID
);
209 ps2_queue(&s
->common
, 0x41);
211 ps2_queue(&s
->common
, 0x83);
214 ps2_queue(&s
->common
, KBD_CMD_ECHO
);
218 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
220 case KBD_CMD_SCANCODE
:
221 case KBD_CMD_SET_LEDS
:
222 case KBD_CMD_SET_RATE
:
223 s
->common
.write_cmd
= val
;
224 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
226 case KBD_CMD_RESET_DISABLE
:
227 ps2_reset_keyboard(s
);
229 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
231 case KBD_CMD_RESET_ENABLE
:
232 ps2_reset_keyboard(s
);
234 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
237 ps2_reset_keyboard(s
);
238 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
239 ps2_queue(&s
->common
, KBD_REPLY_POR
);
242 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
246 case KBD_CMD_SCANCODE
:
248 if (s
->scancode_set
== 1)
249 ps2_put_keycode(s
, 0x43);
250 else if (s
->scancode_set
== 2)
251 ps2_put_keycode(s
, 0x41);
252 else if (s
->scancode_set
== 3)
253 ps2_put_keycode(s
, 0x3f);
255 if (val
>= 1 && val
<= 3)
256 s
->scancode_set
= val
;
257 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
259 s
->common
.write_cmd
= -1;
261 case KBD_CMD_SET_LEDS
:
262 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
263 s
->common
.write_cmd
= -1;
265 case KBD_CMD_SET_RATE
:
266 ps2_queue(&s
->common
, KBD_REPLY_ACK
);
267 s
->common
.write_cmd
= -1;
272 /* Set the scancode translation mode.
274 1 = translated scancodes (used by qemu internally). */
276 void ps2_keyboard_set_translation(void *opaque
, int mode
)
278 PS2KbdState
*s
= (PS2KbdState
*)opaque
;
282 static void ps2_mouse_send_packet(PS2MouseState
*s
)
290 /* XXX: increase range to 8 bits ? */
299 b
= 0x08 | ((dx1
< 0) << 4) | ((dy1
< 0) << 5) | (s
->mouse_buttons
& 0x07);
300 ps2_queue(&s
->common
, b
);
301 ps2_queue(&s
->common
, dx1
& 0xff);
302 ps2_queue(&s
->common
, dy1
& 0xff);
303 /* extra byte for IMPS/2 or IMEX */
304 switch(s
->mouse_type
) {
312 ps2_queue(&s
->common
, dz1
& 0xff);
319 b
= (dz1
& 0x0f) | ((s
->mouse_buttons
& 0x18) << 1);
320 ps2_queue(&s
->common
, b
);
330 static void ps2_mouse_event(void *opaque
,
331 int dx
, int dy
, int dz
, int buttons_state
)
333 PS2MouseState
*s
= opaque
;
335 /* check if deltas are recorded when disabled */
336 if (!(s
->mouse_status
& MOUSE_STATUS_ENABLED
))
342 /* XXX: SDL sometimes generates nul events: we delete them */
343 if (s
->mouse_dx
== 0 && s
->mouse_dy
== 0 && s
->mouse_dz
== 0 &&
344 s
->mouse_buttons
== buttons_state
)
346 s
->mouse_buttons
= buttons_state
;
348 if (!(s
->mouse_status
& MOUSE_STATUS_REMOTE
) &&
349 (s
->common
.queue
.count
< (PS2_QUEUE_SIZE
- 16))) {
351 /* if not remote, send event. Multiple events are sent if
353 ps2_mouse_send_packet(s
);
354 if (s
->mouse_dx
== 0 && s
->mouse_dy
== 0 && s
->mouse_dz
== 0)
360 void ps2_mouse_fake_event(void *opaque
)
362 ps2_mouse_event(opaque
, 1, 0, 0, 0);
365 void ps2_write_mouse(void *opaque
, int val
)
367 PS2MouseState
*s
= (PS2MouseState
*)opaque
;
369 printf("kbd: write mouse 0x%02x\n", val
);
371 switch(s
->common
.write_cmd
) {
376 if (val
== AUX_RESET_WRAP
) {
378 ps2_queue(&s
->common
, AUX_ACK
);
380 } else if (val
!= AUX_RESET
) {
381 ps2_queue(&s
->common
, val
);
386 case AUX_SET_SCALE11
:
387 s
->mouse_status
&= ~MOUSE_STATUS_SCALE21
;
388 ps2_queue(&s
->common
, AUX_ACK
);
390 case AUX_SET_SCALE21
:
391 s
->mouse_status
|= MOUSE_STATUS_SCALE21
;
392 ps2_queue(&s
->common
, AUX_ACK
);
395 s
->mouse_status
&= ~MOUSE_STATUS_REMOTE
;
396 ps2_queue(&s
->common
, AUX_ACK
);
400 ps2_queue(&s
->common
, AUX_ACK
);
403 s
->mouse_status
|= MOUSE_STATUS_REMOTE
;
404 ps2_queue(&s
->common
, AUX_ACK
);
407 ps2_queue(&s
->common
, AUX_ACK
);
408 ps2_queue(&s
->common
, s
->mouse_type
);
412 s
->common
.write_cmd
= val
;
413 ps2_queue(&s
->common
, AUX_ACK
);
416 ps2_queue(&s
->common
, AUX_ACK
);
417 ps2_queue(&s
->common
, s
->mouse_status
);
418 ps2_queue(&s
->common
, s
->mouse_resolution
);
419 ps2_queue(&s
->common
, s
->mouse_sample_rate
);
422 ps2_queue(&s
->common
, AUX_ACK
);
423 ps2_mouse_send_packet(s
);
426 s
->mouse_status
|= MOUSE_STATUS_ENABLED
;
427 ps2_queue(&s
->common
, AUX_ACK
);
429 case AUX_DISABLE_DEV
:
430 s
->mouse_status
&= ~MOUSE_STATUS_ENABLED
;
431 ps2_queue(&s
->common
, AUX_ACK
);
433 case AUX_SET_DEFAULT
:
434 s
->mouse_sample_rate
= 100;
435 s
->mouse_resolution
= 2;
437 ps2_queue(&s
->common
, AUX_ACK
);
440 s
->mouse_sample_rate
= 100;
441 s
->mouse_resolution
= 2;
444 ps2_queue(&s
->common
, AUX_ACK
);
445 ps2_queue(&s
->common
, 0xaa);
446 ps2_queue(&s
->common
, s
->mouse_type
);
453 s
->mouse_sample_rate
= val
;
454 /* detect IMPS/2 or IMEX */
455 switch(s
->mouse_detect_state
) {
459 s
->mouse_detect_state
= 1;
463 s
->mouse_detect_state
= 2;
465 s
->mouse_detect_state
= 3;
467 s
->mouse_detect_state
= 0;
471 s
->mouse_type
= 3; /* IMPS/2 */
472 s
->mouse_detect_state
= 0;
476 s
->mouse_type
= 4; /* IMEX */
477 s
->mouse_detect_state
= 0;
480 ps2_queue(&s
->common
, AUX_ACK
);
481 s
->common
.write_cmd
= -1;
484 s
->mouse_resolution
= val
;
485 ps2_queue(&s
->common
, AUX_ACK
);
486 s
->common
.write_cmd
= -1;
491 static void ps2_common_reset(PS2State
*s
)
499 s
->update_irq(s
->update_arg
, 0);
502 static void ps2_kbd_reset(void *opaque
)
504 PS2KbdState
*s
= (PS2KbdState
*) opaque
;
506 ps2_common_reset(&s
->common
);
512 static void ps2_mouse_reset(void *opaque
)
514 PS2MouseState
*s
= (PS2MouseState
*) opaque
;
516 ps2_common_reset(&s
->common
);
518 s
->mouse_resolution
= 0;
519 s
->mouse_sample_rate
= 0;
522 s
->mouse_detect_state
= 0;
526 s
->mouse_buttons
= 0;
529 static const VMStateDescription vmstate_ps2_common
= {
530 .name
= "PS2 Common State",
532 .minimum_version_id
= 2,
533 .minimum_version_id_old
= 2,
534 .fields
= (VMStateField
[]) {
535 VMSTATE_INT32(write_cmd
, PS2State
),
536 VMSTATE_INT32(queue
.rptr
, PS2State
),
537 VMSTATE_INT32(queue
.wptr
, PS2State
),
538 VMSTATE_INT32(queue
.count
, PS2State
),
539 VMSTATE_BUFFER(queue
.data
, PS2State
),
540 VMSTATE_END_OF_LIST()
544 static int ps2_kbd_load_old(QEMUFile
* f
, void* opaque
, int version_id
)
546 PS2KbdState
*s
= (PS2KbdState
*)opaque
;
548 if (version_id
!= 2 && version_id
!= 3)
551 vmstate_load_state(f
, &vmstate_ps2_common
, &s
->common
, version_id
);
552 s
->scan_enabled
=qemu_get_be32(f
);
553 s
->translate
=qemu_get_be32(f
);
555 s
->scancode_set
=qemu_get_be32(f
);
561 static const VMStateDescription vmstate_ps2_keyboard
= {
564 .minimum_version_id
= 3,
565 .minimum_version_id_old
= 2,
566 .load_state_old
= ps2_kbd_load_old
,
567 .fields
= (VMStateField
[]) {
568 VMSTATE_STRUCT(common
, PS2KbdState
, 0, vmstate_ps2_common
, PS2State
),
569 VMSTATE_INT32(scan_enabled
, PS2KbdState
),
570 VMSTATE_INT32(translate
, PS2KbdState
),
571 VMSTATE_INT32_V(scancode_set
, PS2KbdState
,3),
572 VMSTATE_END_OF_LIST()
576 static const VMStateDescription vmstate_ps2_mouse
= {
579 .minimum_version_id
= 2,
580 .minimum_version_id_old
= 2,
581 .fields
= (VMStateField
[]) {
582 VMSTATE_STRUCT(common
, PS2MouseState
, 0, vmstate_ps2_common
, PS2State
),
583 VMSTATE_UINT8(mouse_status
, PS2MouseState
),
584 VMSTATE_UINT8(mouse_resolution
, PS2MouseState
),
585 VMSTATE_UINT8(mouse_sample_rate
, PS2MouseState
),
586 VMSTATE_UINT8(mouse_wrap
, PS2MouseState
),
587 VMSTATE_UINT8(mouse_type
, PS2MouseState
),
588 VMSTATE_UINT8(mouse_detect_state
, PS2MouseState
),
589 VMSTATE_INT32(mouse_dx
, PS2MouseState
),
590 VMSTATE_INT32(mouse_dy
, PS2MouseState
),
591 VMSTATE_INT32(mouse_dz
, PS2MouseState
),
592 VMSTATE_UINT8(mouse_buttons
, PS2MouseState
),
593 VMSTATE_END_OF_LIST()
597 void *ps2_kbd_init(void (*update_irq
)(void *, int), void *update_arg
)
599 PS2KbdState
*s
= (PS2KbdState
*)qemu_mallocz(sizeof(PS2KbdState
));
601 s
->common
.update_irq
= update_irq
;
602 s
->common
.update_arg
= update_arg
;
605 vmstate_register(0, &vmstate_ps2_keyboard
, s
);
606 qemu_add_kbd_event_handler(ps2_put_keycode
, s
);
607 qemu_register_reset(ps2_kbd_reset
, s
);
611 void *ps2_mouse_init(void (*update_irq
)(void *, int), void *update_arg
)
613 PS2MouseState
*s
= (PS2MouseState
*)qemu_mallocz(sizeof(PS2MouseState
));
615 s
->common
.update_irq
= update_irq
;
616 s
->common
.update_arg
= update_arg
;
618 vmstate_register(0, &vmstate_ps2_mouse
, s
);
619 qemu_add_mouse_event_handler(ps2_mouse_event
, s
, 0, "QEMU PS/2 Mouse");
620 qemu_register_reset(ps2_mouse_reset
, s
);