PS2K.cpp@ 47791

Last change on this file since 47791 was 47321, checked in by vboxsync, 11 years ago
PS2K: Merged and extended scan set 1/2 processing.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 60.8 KB

Line
1	/** @file
2	* PS2K - PS/2 keyboard emulation.
3	*/
4
5	/*
6	* Copyright (C) 2007-2012 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*/
16
17	/*
18	* References:
19	*
20	* IBM PS/2 Technical Reference, Keyboards (101- and 102-Key), 1990
21	* Keyboard Scan Code Specification, Microsoft, 2000
22	*
23	* Notes:
24	* - The keyboard never sends partial scan-code sequences; if there isn't enough
25	* room left in the buffer for the entire sequence, the keystroke is discarded
26	* and an overrun code is sent instead.
27	* - Command responses do not disturb stored keystrokes and always have priority.
28	* - Caps Lock and Scroll Lock are normal keys from the keyboard's point of view.
29	* However, Num Lock is not and the keyboard internally tracks its state.
30	* - The way Print Screen works in scan set 1/2 is totally insane.
31	*/
32
33
34	/*******************************************************************************
35	* Header Files *
36	*******************************************************************************/
37	#define LOG_GROUP LOG_GROUP_DEV_KBD
38	#include <VBox/vmm/pdmdev.h>
39	#include <VBox/err.h>
40	#include <iprt/assert.h>
41	#include <iprt/uuid.h>
42	#include "VBoxDD.h"
43	#define IN_PS2K
44	#include "PS2Dev.h"
45
46	/*******************************************************************************
47	* Defined Constants And Macros *
48	*******************************************************************************/
49	/** @name Keyboard commands sent by the system.
50	* @{ */
51	#define KCMD_LEDS 0xED
52	#define KCMD_ECHO 0xEE
53	#define KCMD_INVALID_1 0xEF
54	#define KCMD_SCANSET 0xF0
55	#define KCMD_INVALID_2 0xF1
56	#define KCMD_READ_ID 0xF2
57	#define KCMD_RATE_DELAY 0xF3
58	#define KCMD_ENABLE 0xF4
59	#define KCMD_DFLT_DISABLE 0xF5
60	#define KCMD_SET_DEFAULT 0xF6
61	#define KCMD_ALL_TYPEMATIC 0xF7
62	#define KCMD_ALL_MK_BRK 0xF8
63	#define KCMD_ALL_MAKE 0xF9
64	#define KCMD_ALL_TMB 0xFA
65	#define KCMD_TYPE_MATIC 0xFB
66	#define KCMD_TYPE_MK_BRK 0xFC
67	#define KCMD_TYPE_MAKE 0xFD
68	#define KCMD_RESEND 0xFE
69	#define KCMD_RESET 0xFF
70	/** @} */
71
72	/** @name Keyboard responses sent to the system.
73	* @{ */
74	#define KRSP_ID1 0xAB
75	#define KRSP_ID2 0x83
76	#define KRSP_BAT_OK 0xAA
77	#define KRSP_BAT_FAIL 0xFC
78	#define KRSP_ECHO 0xEE
79	#define KRSP_ACK 0xFA
80	#define KRSP_RESEND 0xFE
81	/** @} */
82
83	/** @name HID modifier range.
84	* @{ */
85	#define HID_MODIFIER_FIRST 0xE0
86	#define HID_MODIFIER_LAST 0xE8
87	/** @} */
88
89	/** @name USB HID additional constants
90	* @{ */
91	/** The highest USB usage code reported by VirtualBox. */
92	#define VBOX_USB_MAX_USAGE_CODE 0xE7
93	/** The size of an array needed to store all USB usage codes */
94	#define VBOX_USB_USAGE_ARRAY_SIZE (VBOX_USB_MAX_USAGE_CODE + 1)
95	/** @} */
96
97	/** @name Modifier key states. Sorted in USB HID code order.
98	* @{ */
99	#define MOD_LCTRL 0x01
100	#define MOD_LSHIFT 0x02
101	#define MOD_LALT 0x04
102	#define MOD_LGUI 0x08
103	#define MOD_RCTRL 0x10
104	#define MOD_RSHIFT 0x20
105	#define MOD_RALT 0x40
106	#define MOD_RGUI 0x80
107	/** @} */
108
109	/* Default typematic value. */
110	#define KBD_DFL_RATE_DELAY 0x2B
111
112	/** Define a simple PS/2 input device queue. */
113	#define DEF_PS2Q_TYPE(name, size) \
114	typedef struct { \
115	uint32_t rpos; \
116	uint32_t wpos; \
117	uint32_t cUsed; \
118	uint32_t cSize; \
119	uint8_t abQueue[size]; \
120	} name
121
122	/* Internal keyboard queue sizes. The input queue doesn't need to be
123	* extra huge and the command queue only needs to handle a few bytes.
124	*/
125	#define KBD_KEY_QUEUE_SIZE 64
126	#define KBD_CMD_QUEUE_SIZE 4
127
128	/*******************************************************************************
129	* Structures and Typedefs *
130	*******************************************************************************/
131
132	/** Scancode translator state. */
133	typedef enum {
134	SS_IDLE, /*< Starting state. /
135	SS_EXT, /*< E0 byte was received. /
136	SS_EXT1 /*< E1 byte was received. /
137	} scan_state_t;
138
139	/** Typematic state. */
140	typedef enum {
141	KBD_TMS_IDLE = 0, /* No typematic key active. */
142	KBD_TMS_DELAY = 1, /* In the initial delay period. */
143	KBD_TMS_REPEAT = 2, /* Key repeating at set rate. */
144	KBD_TMS_32BIT_HACK = 0x7fffffff
145	} tmatic_state_t;
146
147
148	DEF_PS2Q_TYPE(KbdKeyQ, KBD_KEY_QUEUE_SIZE);
149	DEF_PS2Q_TYPE(KbdCmdQ, KBD_CMD_QUEUE_SIZE);
150	DEF_PS2Q_TYPE(GeneriQ, 1);
151
152	/**
153	* The PS/2 keyboard instance data.
154	*/
155	typedef struct PS2K
156	{
157	/** Pointer to parent device (keyboard controller). */
158	R3PTRTYPE(void *) pParent;
159	/** Set if keyboard is enabled ('scans' for input). */
160	bool fScanning;
161	/** Set NumLock is on. */
162	bool fNumLockOn;
163	/** Selected scan set. */
164	uint8_t u8ScanSet;
165	/** Modifier key state. */
166	uint8_t u8Modifiers;
167	/** Currently processed command (if any). */
168	uint8_t u8CurrCmd;
169	/** Status indicator (LED) state. */
170	uint8_t u8LEDs;
171	/** Selected typematic delay/rate. */
172	uint8_t u8Typematic;
173	/** Usage code of current typematic key, if any. */
174	uint8_t u8TypematicKey;
175	/** Current typematic repeat state. */
176	tmatic_state_t enmTypematicState;
177	/** Buffer holding scan codes to be sent to the host. */
178	KbdKeyQ keyQ;
179	/** Command response queue (priority). */
180	KbdCmdQ cmdQ;
181	/** Currently depressed keys. */
182	uint8_t abDepressedKeys[VBOX_USB_USAGE_ARRAY_SIZE];
183	/** Typematic delay in milliseconds. */
184	unsigned uTypematicDelay;
185	/** Typematic repeat period in milliseconds. */
186	unsigned uTypematicRepeat;
187	#if HC_ARCH_BITS == 32
188	uint32_t Alignment0;
189	#endif
190
191	/** Command delay timer - RC Ptr. */
192	PTMTIMERRC pKbdDelayTimerRC;
193	/** Typematic timer - RC Ptr. */
194	PTMTIMERRC pKbdTypematicTimerRC;
195
196	/** The device critical section protecting everything - R3 Ptr */
197	R3PTRTYPE(PPDMCRITSECT) pCritSectR3;
198	/** Command delay timer - R3 Ptr. */
199	PTMTIMERR3 pKbdDelayTimerR3;
200	/** Typematic timer - R3 Ptr. */
201	PTMTIMERR3 pKbdTypematicTimerR3;
202	RTR3PTR Alignment2;
203
204	/** Command delay timer - R0 Ptr. */
205	PTMTIMERR0 pKbdDelayTimerR0;
206	/** Typematic timer - R0 Ptr. */
207	PTMTIMERR0 pKbdTypematicTimerR0;
208
209	scan_state_t XlatState; ///@todo: temporary
210	uint32_t Alignment1;
211
212	/**
213	* Keyboard port - LUN#0.
214	*
215	* @implements PDMIBASE
216	* @implements PDMIKEYBOARDPORT
217	*/
218	struct
219	{
220	/** The base interface for the keyboard port. */
221	PDMIBASE IBase;
222	/** The keyboard port base interface. */
223	PDMIKEYBOARDPORT IPort;
224
225	/** The base interface of the attached keyboard driver. */
226	R3PTRTYPE(PPDMIBASE) pDrvBase;
227	/** The keyboard interface of the attached keyboard driver. */
228	R3PTRTYPE(PPDMIKEYBOARDCONNECTOR) pDrv;
229	} Keyboard;
230	} PS2K, *PPS2K;
231
232	AssertCompile(PS2K_STRUCT_FILLER >= sizeof(PS2K));
233
234	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
235
236	/* Key type flags. */
237	#define KF_E0 0x01 /* E0 prefix. */
238	#define KF_NB 0x02 /* No break code. */
239	#define KF_GK 0x04 /* Gray navigation key. */
240	#define KF_PS 0x08 /* Print Screen key. */
241	#define KF_PB 0x10 /* Pause/Break key. */
242	#define KF_NL 0x20 /* Num Lock key. */
243	#define KF_NS 0x40 /* NumPad '/' key. */
244
245	/* Scan Set 3 typematic defaults. */
246	#define T_U 0x00 /* Unknown value. */
247	#define T_T 0x01 /* Key is typematic. */
248	#define T_M 0x02 /* Key is make only. */
249	#define T_B 0x04 /* Key is make/break. */
250
251	/* Special key values. */
252	#define NONE 0x93 /* No PS/2 scan code returned. */
253	#define UNAS 0x94 /* No PS/2 scan assigned to key. */
254	#define RSVD 0x95 /* Reserved, do not use. */
255	#define UNKN 0x96 /* Translation unknown. */
256
257	/* Key definition structure. */
258	typedef struct {
259	uint8_t makeS1; /* Set 1 make code. */
260	uint8_t makeS2; /* Set 2 make code. */
261	uint8_t makeS3; /* Set 3 make code. */
262	uint8_t keyFlags; /* Key flags. */
263	uint8_t keyMatic; /* Set 3 typematic default. */
264	} key_def;
265
266	/* USB to PS/2 conversion table for regular keys. */
267	static const key_def aPS2Keys[] = {
268	/* 00 / {NONE, NONE, NONE, KF_NB, T_U }, / Key N/A: No Event */
269	/* 01 / {0xFF, 0x00, 0x00, KF_NB, T_U }, / Key N/A: Overrun Error */
270	/* 02 / {0xFC, 0xFC, 0xFC, KF_NB, T_U }, / Key N/A: POST Fail */
271	/* 03 / {UNAS, UNAS, UNAS, 0, T_U }, / Key N/A: ErrorUndefined */
272	/* 04 / {0x1E, 0x1C, 0x1C, 0, T_T }, / Key 31: a A */
273	/* 05 / {0x30, 0x32, 0x32, 0, T_T }, / Key 50: b B */
274	/* 06 / {0x2E, 0x21, 0x21, 0, T_T }, / Key 48: c C */
275	/* 07 / {0x20, 0x23, 0x23, 0, T_T }, / Key 33: d D */
276	/* 08 / {0x12, 0x24, 0x24, 0, T_T }, / Key 19: e E */
277	/* 09 / {0x21, 0x2B, 0x2B, 0, T_T }, / Key 34: f F */
278	/* 0A / {0x22, 0x34, 0x34, 0, T_T }, / Key 35: g G */
279	/* 0B / {0x23, 0x33, 0x33, 0, T_T }, / Key 36: h H */
280	/* 0C / {0x17, 0x43, 0x43, 0, T_T }, / Key 24: i I */
281	/* 0D / {0x24, 0x3B, 0x3B, 0, T_T }, / Key 37: j J */
282	/* 0E / {0x25, 0x42, 0x42, 0, T_T }, / Key 38: k K */
283	/* 0F / {0x26, 0x4B, 0x4B, 0, T_T }, / Key 39: l L */
284	/* 10 / {0x32, 0x3A, 0x3A, 0, T_T }, / Key 52: m M */
285	/* 11 / {0x31, 0x31, 0x31, 0, T_T }, / Key 51: n N */
286	/* 12 / {0x18, 0x44, 0x44, 0, T_T }, / Key 25: o O */
287	/* 13 / {0x19, 0x4D, 0x4D, 0, T_T }, / Key 26: p P */
288	/* 14 / {0x10, 0x15, 0x15, 0, T_T }, / Key 17: q Q */
289	/* 15 / {0x13, 0x2D, 0x2D, 0, T_T }, / Key 20: r R */
290	/* 16 / {0x1F, 0x1B, 0x1B, 0, T_T }, / Key 32: s S */
291	/* 17 / {0x14, 0x2C, 0x2C, 0, T_T }, / Key 21: t T */
292	/* 18 / {0x16, 0x3C, 0x3C, 0, T_T }, / Key 23: u U */
293	/* 19 / {0x2F, 0x2A, 0x2A, 0, T_T }, / Key 49: v V */
294	/* 1A / {0x11, 0x1D, 0x1D, 0, T_T }, / Key 18: w W */
295	/* 1B / {0x2D, 0x22, 0x22, 0, T_T }, / Key 47: x X */
296	/* 1C / {0x15, 0x35, 0x35, 0, T_T }, / Key 22: y Y */
297	/* 1D / {0x2C, 0x1A, 0x1A, 0, T_T }, / Key 46: z Z */
298	/* 1E / {0x02, 0x16, 0x16, 0, T_T }, / Key 2: 1 ! */
299	/* 1F / {0x03, 0x1E, 0x1E, 0, T_T }, / Key 3: 2 @ */
300	/* 20 / {0x04, 0x26, 0x26, 0, T_T }, / Key 4: 3 # */
301	/* 21 / {0x05, 0x25, 0x25, 0, T_T }, / Key 5: 4 $ */
302	/* 22 / {0x06, 0x2E, 0x2E, 0, T_T }, / Key 6: 5 % */
303	/* 23 / {0x07, 0x36, 0x36, 0, T_T }, / Key 7: 6 ^ */
304	/* 24 / {0x08, 0x3D, 0x3D, 0, T_T }, / Key 8: 7 & */
305	/* 25 / {0x09, 0x3E, 0x3E, 0, T_T }, / Key 9: 8 * */
306	/* 26 / {0x0A, 0x46, 0x46, 0, T_T }, / Key 10: 9 ( */
307	/* 27 / {0x0B, 0x45, 0x45, 0, T_T }, / Key 11: 0 ) */
308	/* 28 / {0x1C, 0x5A, 0x5A, 0, T_T }, / Key 43: Return */
309	/* 29 / {0x01, 0x76, 0x08, 0, T_M }, / Key 110: Escape */
310	/* 2A / {0x0E, 0x66, 0x66, 0, T_T }, / Key 15: Backspace */
311	/* 2B / {0x0F, 0x0D, 0x0D, 0, T_T }, / Key 16: Tab */
312	/* 2C / {0x39, 0x29, 0x29, 0, T_T }, / Key 61: Space */
313	/* 2D / {0x0C, 0x4E, 0x4E, 0, T_T }, / Key 12: - _ */
314	/* 2E / {0x0D, 0x55, 0x55, 0, T_T }, / Key 13: = + */
315	/* 2F / {0x1A, 0x54, 0x54, 0, T_T }, / Key 27: [ { */
316	/* 30 / {0x1B, 0x5B, 0x5B, 0, T_T }, / Key 28: ] } */
317	/* 31 / {0x2B, 0x5D, 0x5C, 0, T_T }, / Key 29: \ \| */
318	/* 32 / {0x2B, 0x5D, 0x5D, 0, T_T }, / Key 42: Europe 1 (Note 2) */
319	/* 33 / {0x27, 0x4C, 0x4C, 0, T_T }, / Key 40: ; : */
320	/* 34 / {0x28, 0x52, 0x52, 0, T_T }, / Key 41: ' " */
321	/* 35 / {0x29, 0x0E, 0x0E, 0, T_T }, / Key 1: ` ~ */
322	/* 36 / {0x33, 0x41, 0x41, 0, T_T }, / Key 53: , < */
323	/* 37 / {0x34, 0x49, 0x49, 0, T_T }, / Key 54: . > */
324	/* 38 / {0x35, 0x4A, 0x4A, 0, T_T }, / Key 55: / ? */
325	/* 39 / {0x3A, 0x58, 0x14, 0, T_B }, / Key 30: Caps Lock */
326	/* 3A / {0x3B, 0x05, 0x07, 0, T_M }, / Key 112: F1 */
327	/* 3B / {0x3C, 0x06, 0x0F, 0, T_M }, / Key 113: F2 */
328	/* 3C / {0x3D, 0x04, 0x17, 0, T_M }, / Key 114: F3 */
329	/* 3D / {0x3E, 0x0C, 0x1F, 0, T_M }, / Key 115: F4 */
330	/* 3E / {0x3F, 0x03, 0x27, 0, T_M }, / Key 116: F5 */
331	/* 3F / {0x40, 0x0B, 0x2F, 0, T_M }, / Key 117: F6 */
332	/* 40 / {0x41, 0x83, 0x37, 0, T_M }, / Key 118: F7 */
333	/* 41 / {0x42, 0x0A, 0x3F, 0, T_M }, / Key 119: F8 */
334	/* 42 / {0x43, 0x01, 0x47, 0, T_M }, / Key 120: F9 */
335	/* 43 / {0x44, 0x09, 0x4F, 0, T_M }, / Key 121: F10 */
336	/* 44 / {0x57, 0x78, 0x56, 0, T_M }, / Key 122: F11 */
337	/* 45 / {0x58, 0x07, 0x5E, 0, T_M }, / Key 123: F12 */
338	/* 46 / {0x37, 0x7C, 0x57, KF_PS, T_M }, / Key 124: Print Screen (Note 1) */
339	/* 47 / {0x46, 0x7E, 0x5F, 0, T_M }, / Key 125: Scroll Lock */
340	/* 48 / {RSVD, RSVD, RSVD, KF_PB, T_M }, / Key 126: Break (Ctrl-Pause) */
341	/* 49 / {0x52, 0x70, 0x67, KF_GK, T_M }, / Key 75: Insert (Note 1) */
342	/* 4A / {0x47, 0x6C, 0x6E, KF_GK, T_M }, / Key 80: Home (Note 1) */
343	/* 4B / {0x49, 0x7D, 0x6F, KF_GK, T_M }, / Key 85: Page Up (Note 1) */
344	/* 4C / {0x53, 0x71, 0x64, KF_GK, T_T }, / Key 76: Delete (Note 1) */
345	/* 4D / {0x4F, 0x69, 0x65, KF_GK, T_M }, / Key 81: End (Note 1) */
346	/* 4E / {0x51, 0x7A, 0x6D, KF_GK, T_M }, / Key 86: Page Down (Note 1) */
347	/* 4F / {0x4D, 0x74, 0x6A, KF_GK, T_T }, / Key 89: Right Arrow (Note 1) */
348	/* 50 / {0x4B, 0x6B, 0x61, KF_GK, T_T }, / Key 79: Left Arrow (Note 1) */
349	/* 51 / {0x50, 0x72, 0x60, KF_GK, T_T }, / Key 84: Down Arrow (Note 1) */
350	/* 52 / {0x48, 0x75, 0x63, KF_GK, T_T }, / Key 83: Up Arrow (Note 1) */
351	/* 53 / {0x45, 0x77, 0x76, KF_NL, T_M }, / Key 90: Num Lock */
352	/* 54 / {0x35, 0x4A, 0x77, KF_NS, T_M }, / Key 95: Keypad / (Note 1) */
353	/* 55 / {0x37, 0x7C, 0x7E, 0, T_M }, / Key 100: Keypad * */
354	/* 56 / {0x4A, 0x7B, 0x84, 0, T_M }, / Key 105: Keypad - */
355	/* 57 / {0x4E, 0x79, 0x7C, 0, T_T }, / Key 106: Keypad + */
356	/* 58 / {0x1C, 0x5A, 0x79, KF_E0, T_M }, / Key 108: Keypad Enter */
357	/* 59 / {0x4F, 0x69, 0x69, 0, T_M }, / Key 93: Keypad 1 End */
358	/* 5A / {0x50, 0x72, 0x72, 0, T_M }, / Key 98: Keypad 2 Down */
359	/* 5B / {0x51, 0x7A, 0x7A, 0, T_M }, / Key 103: Keypad 3 PageDn */
360	/* 5C / {0x4B, 0x6B, 0x6B, 0, T_M }, / Key 92: Keypad 4 Left */
361	/* 5D / {0x4C, 0x73, 0x73, 0, T_M }, / Key 97: Keypad 5 */
362	/* 5E / {0x4D, 0x74, 0x74, 0, T_M }, / Key 102: Keypad 6 Right */
363	/* 5F / {0x47, 0x6C, 0x6C, 0, T_M }, / Key 91: Keypad 7 Home */
364	/* 60 / {0x48, 0x75, 0x75, 0, T_M }, / Key 96: Keypad 8 Up */
365	/* 61 / {0x49, 0x7D, 0x7D, 0, T_M }, / Key 101: Keypad 9 PageUp */
366	/* 62 / {0x52, 0x70, 0x70, 0, T_M }, / Key 99: Keypad 0 Insert */
367	/* 63 / {0x53, 0x71, 0x71, 0, T_M }, / Key 104: Keypad . Delete */
368	/* 64 / {0x56, 0x61, 0x13, 0, T_T }, / Key 45: Europe 2 (Note 2) */
369	/* 65 / {0x5D, 0x2F, UNKN, KF_E0, T_U }, / Key 129: App */
370	/* 66 / {0x5E, 0x37, UNKN, KF_E0, T_U }, / Key Unk: Keyboard Power */
371	/* 67 / {0x59, 0x0F, UNKN, 0, T_U }, / Key Unk: Keypad = */
372	/* 68 / {0x64, 0x08, UNKN, 0, T_U }, / Key Unk: F13 */
373	/* 69 / {0x65, 0x10, UNKN, 0, T_U }, / Key Unk: F14 */
374	/* 6A / {0x66, 0x18, UNKN, 0, T_U }, / Key Unk: F15 */
375	/* 6B / {0x67, 0x20, UNKN, 0, T_U }, / Key Unk: F16 */
376	/* 6C / {0x68, 0x28, UNKN, 0, T_U }, / Key Unk: F17 */
377	/* 6D / {0x69, 0x30, UNKN, 0, T_U }, / Key Unk: F18 */
378	/* 6E / {0x6A, 0x38, UNKN, 0, T_U }, / Key Unk: F19 */
379	/* 6F / {0x6B, 0x40, UNKN, 0, T_U }, / Key Unk: F20 */
380	/* 70 / {0x6C, 0x48, UNKN, 0, T_U }, / Key Unk: F21 */
381	/* 71 / {0x6D, 0x50, UNKN, 0, T_U }, / Key Unk: F22 */
382	/* 72 / {0x6E, 0x57, UNKN, 0, T_U }, / Key Unk: F23 */
383	/* 73 / {0x76, 0x5F, UNKN, 0, T_U }, / Key Unk: F24 */
384	/* 74 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Execute */
385	/* 75 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Help */
386	/* 76 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Menu */
387	/* 77 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Select */
388	/* 78 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Stop */
389	/* 79 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Again */
390	/* 7A / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Undo */
391	/* 7B / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Cut */
392	/* 7C / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Copy */
393	/* 7D / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Paste */
394	/* 7E / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Find */
395	/* 7F / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Mute */
396	/* 80 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Volume Up */
397	/* 81 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Volume Dn */
398	/* 82 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Locking Caps Lock */
399	/* 83 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Locking Num Lock */
400	/* 84 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Locking Scroll Lock */
401	/* 85 / {0x7E, 0x6D, UNKN, 0, T_U }, / Key Unk: Keypad , (Brazilian Keypad .) */
402	/* 86 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Equal Sign */
403	/* 87 / {0x73, 0x51, UNKN, 0, T_U }, / Key Unk: Keyboard Intl 1 (Ro) */
404	/* 88 / {0x70, 0x13, UNKN, 0, T_U }, / Key Unk: Keyboard Intl2 (K'kana/H'gana) */
405	/* 89 / {0x7D, 0x6A, UNKN, 0, T_U }, / Key Unk: Keyboard Intl 2 (Yen) */
406	/* 8A / {0x79, 0x64, UNKN, 0, T_U }, / Key Unk: Keyboard Intl 4 (Henkan) */
407	/* 8B / {0x7B, 0x67, UNKN, 0, T_U }, / Key Unk: Keyboard Intl 5 (Muhenkan) */
408	/* 8C / {0x5C, 0x27, UNKN, 0, T_U }, / Key Unk: Keyboard Intl 6 (PC9800 Pad ,) */
409	/* 8D / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Intl 7 */
410	/* 8E / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Intl 8 */
411	/* 8F / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Intl 9 */
412	/* 90 / {0xF2, 0xF2, UNKN, KF_NB, T_U }, / Key Unk: Keyboard Lang 1 (Hang'l/Engl) */
413	/* 91 / {0xF1, 0xF1, UNKN, KF_NB, T_U }, / Key Unk: Keyboard Lang 2 (Hanja) */
414	/* 92 / {0x78, 0x63, UNKN, 0, T_U }, / Key Unk: Keyboard Lang 3 (Katakana) */
415	/* 93 / {0x77, 0x62, UNKN, 0, T_U }, / Key Unk: Keyboard Lang 4 (Hiragana) */
416	/* 94 / {0x76, 0x5F, UNKN, 0, T_U }, / Key Unk: Keyboard Lang 5 (Zen/Han) */
417	/* 95 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Lang 6 */
418	/* 96 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Lang 7 */
419	/* 97 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Lang 8 */
420	/* 98 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Lang 9 */
421	/* 99 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Alternate Erase */
422	/* 9A / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard SysReq/Attention (Note 3) */
423	/* 9B / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Cancel */
424	/* 9C / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Clear */
425	/* 9D / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Prior */
426	/* 9E / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Return */
427	/* 9F / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Separator */
428	/* A0 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Out */
429	/* A1 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Oper */
430	/* A2 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard Clear/Again */
431	/* A3 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard CrSel/Props */
432	/* A4 / {UNAS, UNAS, UNAS, 0, T_U }, / Key Unk: Keyboard ExSel */
433	};
434
435	/*
436	* Note 1: The behavior of these keys depends on the state of modifier keys
437	* at the time the key was pressed.
438	*
439	* Note 2: The key label depends on the national version of the keyboard.
440	*
441	* Note 3: Certain keys which have their own PS/2 scancodes do not exist on
442	* USB keyboards; the SysReq key is an example. The SysReq key scancode needs
443	* to be translated to the Print Screen HID usage code. The HID usage to PS/2
444	* scancode conversion then generates the correct sequence depending on the
445	* keyboard state.
446	*/
447
448	/* USB to PS/2 conversion table for modifier keys. */
449	static const key_def aPS2ModKeys[] = {
450	/* E0 / {0x1D, 0x14, 0x11, 0, T_B }, / Key 58: Left Control */
451	/* E1 / {0x2A, 0x12, 0x12, 0, T_B }, / Key 44: Left Shift */
452	/* E2 / {0x38, 0x11, 0x19, 0, T_B }, / Key 60: Left Alt */
453	/* E3 / {0x5B, 0x1F, UNKN, KF_E0, T_U }, / Key 127: Left GUI */
454	/* E4 / {0x1D, 0x14, 0x58, KF_E0, T_M }, / Key 64: Right Control */
455	/* E5 / {0x36, 0x59, 0x59, 0, T_B }, / Key 57: Right Shift */
456	/* E6 / {0x38, 0x11, 0x39, KF_E0, T_M }, / Key 62: Right Alt */
457	/* E7 / {0x5C, 0x27, UNKN, KF_E0, T_U }, / Key 128: Right GUI */
458	};
459
460	/*******************************************************************************
461	* Global Variables *
462	*******************************************************************************/
463
464	/*
465	* Because of historical reasons and poor design, VirtualBox internally uses BIOS
466	* PC/XT style scan codes to represent keyboard events. Each key press and release is
467	* represented as a stream of bytes, typically only one byte but up to four-byte
468	* sequences are possible. In the typical case, the GUI front end generates the stream
469	* of scan codes which we need to translate back to a single up/down event.
470	*
471	* This function could possibly live somewhere else.
472	*/
473
474	/** Lookup table for converting PC/XT scan codes to USB HID usage codes. */
475	static uint8_t aScancode2Hid[] =
476	{
477	0x00, 0x29, 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23, /* 00-07 */
478	0x24, 0x25, 0x26, 0x27, 0x2d, 0x2e, 0x2a, 0x2b, /* 08-1F */
479	0x14, 0x1a, 0x08, 0x15, 0x17, 0x1c, 0x18, 0x0c, /* 10-17 */
480	0x12, 0x13, 0x2f, 0x30, 0x28, 0xe0, 0x04, 0x16, /* 18-1F */
481	0x07, 0x09, 0x0a, 0x0b, 0x0d, 0x0e, 0x0f, 0x33, /* 20-27 */
482	0x34, 0x35, 0xe1, 0x31, 0x1d, 0x1b, 0x06, 0x19, /* 28-2F */
483	0x05, 0x11, 0x10, 0x36, 0x37, 0x38, 0xe5, 0x55, /* 30-37 */
484	0xe2, 0x2c, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, /* 38-3F */
485	0x3f, 0x40, 0x41, 0x42, 0x43, 0x53, 0x47, 0x5f, /* 40-47 */
486	0x60, 0x61, 0x56, 0x5c, 0x5d, 0x5e, 0x57, 0x59, /* 48-4F */
487	0x5a, 0x5b, 0x62, 0x63, 0x46, 0x00, 0x64, 0x44, /* 50-57 */
488	0x45, 0x67, 0x00, 0x00, 0x8c, 0x00, 0x00, 0x00, /* 58-5F */
489	0x00, 0x00, 0x00, 0x00, 0x68, 0x69, 0x6a, 0x6b, /* 60-67 */
490	0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x00, /* 68-6F */
491	0x88, 0x91, 0x90, 0x87, 0x00, 0x00, 0x00, 0x00, /* 70-77 */
492	0x00, 0x8a, 0x00, 0x8b, 0x00, 0x89, 0x85, 0x00 /* 78-7F */
493	};
494
495	/** Lookup table for extended scancodes (arrow keys etc.). */
496	static uint8_t aExtScan2Hid[] =
497	{
498	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 00-07 */
499	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 08-1F */
500	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 10-17 */
501	0x00, 0x00, 0x00, 0x00, 0x58, 0xe4, 0x00, 0x00, /* 18-1F */
502	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 20-27 */
503	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 28-2F */
504	0x00, 0x00, 0x00, 0x00, 0x00, 0x54, 0x00, 0x46, /* 30-37 */
505	/* Sun-specific keys. Most of the XT codes are made up */
506	0xe6, 0x00, 0x00, 0x75, 0x76, 0x77, 0xA3, 0x78, /* 38-3F */
507	0x80, 0x81, 0x82, 0x79, 0x00, 0x00, 0x48, 0x4a, /* 40-47 */
508	0x52, 0x4b, 0x00, 0x50, 0x00, 0x4f, 0x00, 0x4d, /* 48-4F */
509	0x51, 0x4e, 0x49, 0x4c, 0x00, 0x00, 0x00, 0x00, /* 50-57 */
510	0x00, 0x00, 0x00, 0xe3, 0xe7, 0x65, 0x66, 0x00, /* 58-5F */
511	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 60-67 */
512	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 68-6F */
513	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 70-77 */
514	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 /* 78-7F */
515	};
516
517	/**
518	* Convert a PC scan code to a USB HID usage byte.
519	*
520	* @param state Current state of the translator (scan_state_t).
521	* @param scanCode Incoming scan code.
522	* @param pUsage Pointer to usage; high bit set for key up events. The
523	* contents are only valid if returned state is SS_IDLE.
524	*
525	* @return scan_state_t New state of the translator.
526	*/
527	static scan_state_t ScancodeToHidUsage(scan_state_t state, uint8_t scanCode, uint32_t *pUsage)
528	{
529	uint32_t keyUp;
530	uint8_t usage;
531
532	Assert(pUsage);
533
534	/* Isolate the scan code and key break flag. */
535	keyUp = (scanCode & 0x80) << 24;
536
537	switch (state) {
538	case SS_IDLE:
539	if (scanCode == 0xE0) {
540	state = SS_EXT;
541	} else if (scanCode == 0xE1) {
542	state = SS_EXT1;
543	} else {
544	usage = aScancode2Hid[scanCode & 0x7F];
545	*pUsage = usage \| keyUp;
546	/* Remain in SS_IDLE state. */
547	}
548	break;
549	case SS_EXT:
550	usage = aExtScan2Hid[scanCode & 0x7F];
551	*pUsage = usage \| keyUp;
552	state = SS_IDLE;
553	break;
554	case SS_EXT1:
555	/* The sequence is E1 1D 45 E1 9D C5. We take the easy way out and remain
556	* in the SS_EXT1 state until 45 or C5 is received.
557	*/
558	if ((scanCode & 0x7F) == 0x45) {
559	*pUsage = 0x48;
560	if (scanCode == 0xC5)
561	*pUsage \|= keyUp;
562	state = SS_IDLE;
563	}
564	/* Else remain in SS_EXT1 state. */
565	break;
566	}
567	return state;
568	}
569
570	/*******************************************************************************
571	* Internal Functions *
572	*******************************************************************************/
573
574
575	/**
576	* Clear a queue.
577	*
578	* @param pQ Pointer to the queue.
579	*/
580	static void ps2kClearQueue(GeneriQ *pQ)
581	{
582	LogFlowFunc(("Clearing queue %p\n", pQ));
583	pQ->wpos = pQ->rpos;
584	pQ->cUsed = 0;
585	}
586
587
588	/**
589	* Add a byte to a queue.
590	*
591	* @param pQ Pointer to the queue.
592	* @param val The byte to store.
593	*/
594	static void ps2kInsertQueue(GeneriQ *pQ, uint8_t val)
595	{
596	/* Check if queue is full. */
597	if (pQ->cUsed >= pQ->cSize)
598	{
599	LogFlowFunc(("queue %p full (%d entries)\n", pQ, pQ->cUsed));
600	return;
601	}
602	/* Insert data and update circular buffer write position. */
603	pQ->abQueue[pQ->wpos] = val;
604	if (++pQ->wpos == pQ->cSize)
605	pQ->wpos = 0; /* Roll over. */
606	++pQ->cUsed;
607	LogFlowFunc(("inserted 0x%02X into queue %p\n", val, pQ));
608	}
609
610	#ifdef IN_RING3
611
612	/**
613	* Save a queue state.
614	*
615	* @param pSSM SSM handle to write the state to.
616	* @param pQ Pointer to the queue.
617	*/
618	static void ps2kSaveQueue(PSSMHANDLE pSSM, GeneriQ *pQ)
619	{
620	uint32_t cItems = pQ->cUsed;
621	int i;
622
623	/* Only save the number of items. Note that the read/write
624	* positions aren't saved as they will be rebuilt on load.
625	*/
626	SSMR3PutU32(pSSM, cItems);
627
628	LogFlow(("Storing %d items from queue %p\n", cItems, pQ));
629
630	/* Save queue data - only the bytes actually used (typically zero). */
631	for (i = pQ->rpos; cItems-- > 0; i = (i + 1) % pQ->cSize)
632	SSMR3PutU8(pSSM, pQ->abQueue[i]);
633	}
634
635	/**
636	* Load a queue state.
637	*
638	* @param pSSM SSM handle to read the state from.
639	* @param pQ Pointer to the queue.
640	*
641	* @return int VBox status/error code.
642	*/
643	static int ps2kLoadQueue(PSSMHANDLE pSSM, GeneriQ *pQ)
644	{
645	int rc;
646
647	/* On load, always put the read pointer at zero. */
648	SSMR3GetU32(pSSM, &pQ->cUsed);
649
650	LogFlow(("Loading %d items to queue %p\n", pQ->cUsed, pQ));
651
652	if (pQ->cUsed > pQ->cSize)
653	{
654	AssertMsgFailed(("Saved size=%u, actual=%u\n", pQ->cUsed, pQ->cSize));
655	return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
656	}
657
658	/* Recalculate queue positions and load data in one go. */
659	pQ->rpos = 0;
660	pQ->wpos = pQ->cUsed;
661	rc = SSMR3GetMem(pSSM, pQ->abQueue, pQ->cUsed);
662
663	return rc;
664	}
665
666	#endif /* IN_RING3 */
667
668	/**
669	* Retrieve a byte from a queue.
670	*
671	* @param pQ Pointer to the queue.
672	* @param pVal Pointer to storage for the byte.
673	*
674	* @return int VINF_TRY_AGAIN if queue is empty,
675	* VINF_SUCCESS if a byte was read.
676	*/
677	static int ps2kRemoveQueue(GeneriQ pQ, uint8_t pVal)
678	{
679	int rc = VINF_TRY_AGAIN;
680
681	Assert(pVal);
682	if (pQ->cUsed)
683	{
684	*pVal = pQ->abQueue[pQ->rpos];
685	if (++pQ->rpos == pQ->cSize)
686	pQ->rpos = 0; /* Roll over. */
687	--pQ->cUsed;
688	rc = VINF_SUCCESS;
689	LogFlowFunc(("removed 0x%02X from queue %p\n", *pVal, pQ));
690	} else
691	LogFlowFunc(("queue %p empty\n", pQ));
692	return rc;
693	}
694
695	/* Convert encoded typematic value to milliseconds. Note that the values are rated
696	* with +/- 20% accuracy, so there's no need for high precision.
697	*/
698	static void ps2kSetupTypematic(PPS2K pThis, uint8_t val)
699	{
700	int A, B;
701	unsigned period;
702
703	pThis->u8Typematic = val;
704	/* The delay is easy: (1 + value) * 250 ms */
705	pThis->uTypematicDelay = (1 + ((val >> 5) & 3)) * 250;
706	/* The rate is more complicated: (8 + A) * 2^B * 4.17 ms */
707	A = val & 7;
708	B = (val >> 3) & 3;
709	period = (8 + A) * (1 << B) * 417 / 100;
710	pThis->uTypematicRepeat = period;
711	Log(("Typematic delay %u ms, repeat period %u ms\n",
712	pThis->uTypematicDelay, pThis->uTypematicRepeat));
713	}
714
715	static void ps2kSetDefaults(PPS2K pThis)
716	{
717	LogFlowFunc(("Set keyboard defaults\n"));
718	ps2kClearQueue((GeneriQ *)&pThis->keyQ);
719	/* Set default Scan Set 3 typematic values. */
720	/* Set default typematic rate/delay. */
721	ps2kSetupTypematic(pThis, KBD_DFL_RATE_DELAY);
722	/* Clear last typematic key?? */
723	}
724
725	/**
726	* Receive and process a byte sent by the keyboard controller.
727	*
728	* @param pThis The PS/2 keyboard instance data.
729	* @param cmd The command (or data) byte.
730	*/
731	int PS2KByteToKbd(PPS2K pThis, uint8_t cmd)
732	{
733	bool fHandled = true;
734
735	LogFlowFunc(("new cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
736
737	switch (cmd)
738	{
739	case KCMD_ECHO:
740	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ECHO);
741	pThis->u8CurrCmd = 0;
742	break;
743	case KCMD_READ_ID:
744	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
745	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ID1);
746	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ID2);
747	pThis->u8CurrCmd = 0;
748	break;
749	case KCMD_ENABLE:
750	pThis->fScanning = true;
751	ps2kClearQueue((GeneriQ *)&pThis->keyQ);
752	/* Clear last typematic key?? */
753	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
754	pThis->u8CurrCmd = 0;
755	break;
756	case KCMD_DFLT_DISABLE:
757	pThis->fScanning = false;
758	ps2kSetDefaults(pThis);
759	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
760	pThis->u8CurrCmd = 0;
761	break;
762	case KCMD_SET_DEFAULT:
763	ps2kSetDefaults(pThis);
764	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
765	pThis->u8CurrCmd = 0;
766	break;
767	case KCMD_ALL_TYPEMATIC:
768	case KCMD_ALL_MK_BRK:
769	case KCMD_ALL_MAKE:
770	case KCMD_ALL_TMB:
771	///@todo Set the key types here.
772	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
773	pThis->u8CurrCmd = 0;
774	break;
775	case KCMD_RESEND:
776	pThis->u8CurrCmd = 0;
777	break;
778	case KCMD_RESET:
779	pThis->u8ScanSet = 2;
780	ps2kSetDefaults(pThis);
781	///@todo reset more?
782	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
783	pThis->u8CurrCmd = cmd;
784	/* Delay BAT completion; the test may take hundreds of ms. */
785	TMTimerSetMillies(pThis->CTX_SUFF(pKbdDelayTimer), 2);
786	break;
787	/* The following commands need a parameter. */
788	case KCMD_LEDS:
789	case KCMD_SCANSET:
790	case KCMD_RATE_DELAY:
791	case KCMD_TYPE_MATIC:
792	case KCMD_TYPE_MK_BRK:
793	case KCMD_TYPE_MAKE:
794	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
795	pThis->u8CurrCmd = cmd;
796	break;
797	default:
798	/* Sending a command instead of a parameter starts the new command. */
799	switch (pThis->u8CurrCmd)
800	{
801	case KCMD_LEDS:
802	#ifndef IN_RING3
803	return VINF_IOM_R3_IOPORT_WRITE;
804	#else
805	{
806	PDMKEYBLEDS enmLeds = PDMKEYBLEDS_NONE;
807
808	if (cmd & 0x01)
809	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_SCROLLLOCK);
810	if (cmd & 0x02)
811	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_NUMLOCK);
812	if (cmd & 0x04)
813	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_CAPSLOCK);
814	pThis->Keyboard.pDrv->pfnLedStatusChange(pThis->Keyboard.pDrv, enmLeds);
815	pThis->fNumLockOn = !!(cmd & 0x02); /* Sync internal Num Lock state. */
816	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
817	pThis->u8LEDs = cmd;
818	pThis->u8CurrCmd = 0;
819	}
820	#endif
821	break;
822	case KCMD_SCANSET:
823	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
824	if (cmd == 0)
825	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8ScanSet);
826	else if (cmd < 4)
827	{
828	pThis->u8ScanSet = cmd;
829	LogRel(("PS2K: Selected scan set %d.\n", cmd));
830	}
831	/* Other values are simply ignored. */
832	pThis->u8CurrCmd = 0;
833	break;
834	case KCMD_RATE_DELAY:
835	ps2kSetupTypematic(pThis, cmd);
836	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
837	pThis->u8CurrCmd = 0;
838	break;
839	default:
840	fHandled = false;
841	}
842	/* Fall through only to handle unrecognized commands. */
843	if (fHandled)
844	break;
845
846	case KCMD_INVALID_1:
847	case KCMD_INVALID_2:
848	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_RESEND);
849	pThis->u8CurrCmd = 0;
850	break;
851	}
852	LogFlowFunc(("Active cmd now 0x%02X; updating interrupts\n", pThis->u8CurrCmd));
853	// KBCUpdateInterrupts(pThis->pParent);
854	return VINF_SUCCESS;
855	}
856
857	/**
858	* Send a byte (keystroke or command response) to the keyboard controller.
859	*
860	* @returns VINF_SUCCESS or VINF_TRY_AGAIN.
861	* @param pThis The PS/2 keyboard instance data.
862	* @param pb Where to return the byte we've read.
863	* @remarks Caller must have entered the device critical section.
864	*/
865	int PS2KByteFromKbd(PPS2K pThis, uint8_t *pb)
866	{
867	int rc;
868
869	AssertPtr(pb);
870
871	/* Anything in the command queue has priority over data
872	* in the keystroke queue. Additionally, keystrokes are
873	* blocked if a command is currently in progress, even if
874	* the command queue is empty.
875	*/
876	rc = ps2kRemoveQueue((GeneriQ *)&pThis->cmdQ, pb);
877	if (rc != VINF_SUCCESS && !pThis->u8CurrCmd && pThis->fScanning)
878	rc = ps2kRemoveQueue((GeneriQ *)&pThis->keyQ, pb);
879
880	LogFlowFunc(("keyboard sends 0x%02x (%svalid data)\n", *pb, rc == VINF_SUCCESS ? "" : "not "));
881	return rc;
882	}
883
884	#ifdef IN_RING3
885
886	static int psk2ProcessKeyEvent(PPS2K pThis, uint8_t u8HidCode, bool fKeyDown)
887	{
888	unsigned int i = 0;
889	key_def const *pKeyDef;
890	uint8_t abCodes[16];
891	uint8_t u8MakeCode;
892
893	LogFlowFunc(("key %s: 0x%02x (set %d)\n", fKeyDown ? "down" : "up", u8HidCode, pThis->u8ScanSet));
894
895	/* Find the key definition in somewhat sparse storage. */
896	pKeyDef = u8HidCode >= HID_MODIFIER_FIRST ? &aPS2ModKeys[u8HidCode - HID_MODIFIER_FIRST] : &aPS2Keys[u8HidCode];
897
898	/* Some keys are not processed at all; early return. */
899	if (pKeyDef->makeS1 == NONE)
900	{
901	LogFlow(("Skipping key processing.\n"));
902	return VINF_SUCCESS;
903	}
904
905	/* Handle modifier keys (Ctrl/Alt/Shift/GUI). We need to keep track
906	* of their state in addition to sending the scan code.
907	*/
908	if (u8HidCode >= HID_MODIFIER_FIRST)
909	{
910	unsigned mod_bit = 1 << (u8HidCode - HID_MODIFIER_FIRST);
911
912	Assert((u8HidCode <= HID_MODIFIER_LAST));
913	if (fKeyDown)
914	pThis->u8Modifiers \|= mod_bit;
915	else
916	pThis->u8Modifiers &= ~mod_bit;
917	}
918
919	/* Toggle NumLock state. */
920	if ((pKeyDef->keyFlags & KF_NL) && fKeyDown)
921	pThis->fNumLockOn ^= true;
922
923	if (pThis->u8ScanSet == 1 \|\| pThis->u8ScanSet == 2)
924	{
925	/* The basic scan set 1 and 2 logic is the same, only the scan codes differ.
926	* Since scan set 2 is used almost all the time, that case is handled first.
927	*/
928	abCodes[0] = 0;
929	if (fKeyDown)
930	{
931	/* Process key down event. */
932	if (pKeyDef->keyFlags & KF_PB)
933	{
934	/* Pause/Break sends different data if either Ctrl is held. */
935	if (pThis->u8Modifiers & (MOD_LCTRL \| MOD_RCTRL))
936	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
937	"\xE0\x7E\xE0\xF0\x7E" : "\xE0\x46\xE0\xC6");
938	else
939	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
940	"\xE1\x14\x77\xE1\xF0\x14\xF0\x77" : "\xE1\x1D\x45\xE1\x9D\xC5");
941	}
942	else if (pKeyDef->keyFlags & KF_PS)
943	{
944	/* Print Screen depends on all of Ctrl, Shift, and Alt! */
945	if (pThis->u8Modifiers & (MOD_LALT \| MOD_RALT))
946	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
947	"\x84" : "\x54");
948	else if (pThis->u8Modifiers & (MOD_LSHIFT \| MOD_RSHIFT))
949	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
950	"\xE0\x7C" : "\xE0\x37");
951	else
952	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
953	"\xE0\x12\xE0\x7C" : "\xE0\x2A\xE0\x37");
954	}
955	else if (pKeyDef->keyFlags & (KF_GK \| KF_NS))
956	{
957	/* The numeric pad keys fake Shift presses or releases
958	* depending on Num Lock and Shift key state. The '/'
959	* key behaves in a similar manner but does not depend on
960	* the Num Lock state.
961	*/
962	if (!pThis->fNumLockOn \|\| (pKeyDef->keyFlags & KF_NS))
963	{
964	if (pThis->u8Modifiers & MOD_LSHIFT)
965	strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
966	"\xE0\xF0\x12" : "\xE0\xAA");
967	if (pThis->u8Modifiers & MOD_RSHIFT)
968	strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
969	"\xE0\xF0\x59" : "\xE0\xB6");
970	}
971	else
972	{
973	Assert(pThis->fNumLockOn); /* Not for KF_NS! */
974	if ((pThis->u8Modifiers & (MOD_LSHIFT \| MOD_RSHIFT)) == 0)
975	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
976	"\xE0\x12" : "\xE0\x2A");
977	/* Else Shift cancels NumLock, so no prefix! */
978	}
979	}
980	/* Feed the bytes to the queue if there is room. */
981	///@todo check empty space!
982	while (abCodes[i])
983	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, abCodes[i++]);
984	Assert(i < sizeof(abCodes));
985
986	/* Standard processing for regular keys only. */
987	u8MakeCode = pThis->u8ScanSet == 2 ? pKeyDef->makeS2 : pKeyDef->makeS1;
988	if (!(pKeyDef->keyFlags & (KF_PB \| KF_PS)))
989	{
990	if (pKeyDef->keyFlags & (KF_E0 \| KF_GK \| KF_NS))
991	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xE0);
992	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, u8MakeCode);
993	}
994	}
995	else if (!(pKeyDef->keyFlags & (KF_NB \| KF_PB)))
996	{
997	/* Process key up event except for keys which produce none. */
998
999	/* Handle Print Screen release. */
1000	if (pKeyDef->keyFlags & KF_PS)
1001	{
1002	/* Undo faked Print Screen state as needed. */
1003	if (pThis->u8Modifiers & (MOD_LALT \| MOD_RALT))
1004	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
1005	"\xF0\x84" : "\xD4");
1006	else if (pThis->u8Modifiers & (MOD_LSHIFT \| MOD_RSHIFT))
1007	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
1008	"\xE0\xF0\x7C" : "\xE0\xB7");
1009	else
1010	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
1011	"\xE0\xF0\x7C\xE0\xF0\x12" : "\xE0\xB7\xE0\xAA");
1012	}
1013	else
1014	{
1015	/* Process base scan code for less unusual keys. */
1016	if (pKeyDef->keyFlags & (KF_E0 \| KF_GK \| KF_NS))
1017	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xE0);
1018	if (pThis->u8ScanSet == 2) {
1019	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xF0);
1020	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS2);
1021	} else {
1022	Assert(pThis->u8ScanSet == 1);
1023	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS1 \| 0x80);
1024	}
1025
1026	/* Restore shift state for gray keys. */
1027	if (pKeyDef->keyFlags & (KF_GK \| KF_NS))
1028	{
1029	if (!pThis->fNumLockOn \|\| (pKeyDef->keyFlags & KF_NS))
1030	{
1031	if (pThis->u8Modifiers & MOD_LSHIFT)
1032	strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
1033	"\xE0\x12" : "\xE0\x2A");
1034	if (pThis->u8Modifiers & MOD_RSHIFT)
1035	strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
1036	"\xE0\x59" : "\xE0\x36");
1037	}
1038	else
1039	{
1040	Assert(pThis->fNumLockOn); /* Not for KF_NS! */
1041	if ((pThis->u8Modifiers & (MOD_LSHIFT \| MOD_RSHIFT)) == 0)
1042	strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
1043	"\xE0\xF0\x12" : "\xE0\xAA");
1044	}
1045	}
1046	}
1047
1048	/* Feed any additional bytes to the queue if there is room. */
1049	///@todo check empty space!
1050	while (abCodes[i])
1051	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, abCodes[i++]);
1052	Assert(i < sizeof(abCodes));
1053	}
1054	}
1055	else
1056	{
1057	/* Handle Scan Set 3 - very straightforward. */
1058	Assert(pThis->u8ScanSet == 3);
1059	if (fKeyDown)
1060	{
1061	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS3);
1062	}
1063	else
1064	{
1065	/* Send a key release code unless it's a make only key. */
1066	///@todo Look up the current typematic setting, not the default!
1067	if (pKeyDef->keyMatic != T_M)
1068	{
1069	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xF0);
1070	ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS3);
1071	}
1072	}
1073	}
1074
1075	/* Set up or cancel typematic key repeat. */
1076	if (fKeyDown)
1077	{
1078	if (pThis->u8TypematicKey != u8HidCode)
1079	{
1080	pThis->enmTypematicState = KBD_TMS_DELAY;
1081	pThis->u8TypematicKey = u8HidCode;
1082	TMTimerSetMillies(pThis->CTX_SUFF(pKbdTypematicTimer), pThis->uTypematicDelay);
1083	Log(("Typematic delay %u ms, key %02X\n", pThis->uTypematicDelay, u8HidCode));
1084	}
1085	}
1086	else
1087	{
1088	pThis->u8TypematicKey = 0;
1089	pThis->enmTypematicState = KBD_TMS_IDLE;
1090	///@todo Cancel timer right away?
1091	///@todo Cancel timer before pushing key up code!?
1092	}
1093
1094	/* Poke the KBC to update its state. */
1095	KBCUpdateInterrupts(pThis->pParent);
1096
1097	return VINF_SUCCESS;
1098	}
1099
1100	/* Timer handler for emulating typematic keys. Note that only the last key
1101	* held down repeats (if typematic).
1102	*/
1103	static DECLCALLBACK(void) ps2kTypematicTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
1104	{
1105	PPS2K pThis = (PS2K *)pvUser; NOREF(pDevIns);
1106	LogFlowFunc(("Typematic state=%d, key %02X\n", pThis->enmTypematicState, pThis->u8TypematicKey));
1107
1108	/* If the current typematic key is zero, the repeat was canceled just when
1109	* the timer was about to run. In that case, do nothing.
1110	*/
1111	if (pThis->u8TypematicKey)
1112	{
1113	if (pThis->enmTypematicState == KBD_TMS_DELAY)
1114	pThis->enmTypematicState = KBD_TMS_REPEAT;
1115
1116	if (pThis->enmTypematicState == KBD_TMS_REPEAT)
1117	{
1118	psk2ProcessKeyEvent(pThis, pThis->u8TypematicKey, true /* Key down */ );
1119	TMTimerSetMillies(pThis->CTX_SUFF(pKbdTypematicTimer), pThis->uTypematicRepeat);
1120	}
1121	}
1122	}
1123
1124	/* The keyboard BAT is specified to take several hundred milliseconds. We need
1125	* to delay sending the result to the host for at least a tiny little while.
1126	*/
1127	static DECLCALLBACK(void) ps2kDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
1128	{
1129	PPS2K pThis = (PS2K *)pvUser; NOREF(pDevIns);
1130
1131	LogFlowFunc(("Delay timer: cmd %02X\n", pThis->u8CurrCmd));
1132
1133	Assert(pThis->u8CurrCmd == KCMD_RESET);
1134	ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_BAT_OK);
1135	pThis->fScanning = true; /* BAT completion enables scanning! */
1136	pThis->u8CurrCmd = 0;
1137
1138	///@todo Might want a PS2KCompleteCommand() to push last response, clear command, and kick the KBC...
1139	/* Give the KBC a kick. */
1140	KBCUpdateInterrupts(pThis->pParent);
1141	}
1142
1143
1144	/**
1145	* Debug device info handler. Prints basic keyboard state.
1146	*
1147	* @param pDevIns Device instance which registered the info.
1148	* @param pHlp Callback functions for doing output.
1149	* @param pszArgs Argument string. Optional and specific to the handler.
1150	*/
1151	static DECLCALLBACK(void) ps2kInfoState(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1152	{
1153	PPS2K pThis = KBDGetPS2KFromDevIns(pDevIns);
1154	NOREF(pszArgs);
1155
1156	pHlp->pfnPrintf(pHlp, "PS/2 Keyboard: scan set %d, scanning %s\n",
1157	pThis->u8ScanSet, pThis->fScanning ? "enabled" : "disabled");
1158	pHlp->pfnPrintf(pHlp, "Active command %02X\n", pThis->u8CurrCmd);
1159	pHlp->pfnPrintf(pHlp, "LED state %02X, Num Lock %s\n", pThis->u8LEDs,
1160	pThis->fNumLockOn ? "on" : "off");
1161	pHlp->pfnPrintf(pHlp, "Typematic delay %ums, repeat period %ums\n",
1162	pThis->uTypematicDelay, pThis->uTypematicRepeat);
1163	pHlp->pfnPrintf(pHlp, "Command queue: %d items (%d max)\n",
1164	pThis->cmdQ.cUsed, pThis->cmdQ.cSize);
1165	pHlp->pfnPrintf(pHlp, "Input queue : %d items (%d max)\n",
1166	pThis->keyQ.cUsed, pThis->keyQ.cSize);
1167	if (pThis->enmTypematicState != KBD_TMS_IDLE)
1168	pHlp->pfnPrintf(pHlp, "Active typematic key %02X (%s)\n", pThis->u8Typematic,
1169	pThis->enmTypematicState == KBD_TMS_DELAY ? "delay" : "repeat");
1170	}
1171
1172	/* -=-=-=-=-=- Keyboard: IBase -=-=-=-=-=- */
1173
1174	/**
1175	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
1176	*/
1177	static DECLCALLBACK(void ) ps2kQueryInterface(PPDMIBASE pInterface, const char pszIID)
1178	{
1179	PPS2K pThis = RT_FROM_MEMBER(pInterface, PS2K, Keyboard.IBase);
1180	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->Keyboard.IBase);
1181	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIKEYBOARDPORT, &pThis->Keyboard.IPort);
1182	return NULL;
1183	}
1184
1185
1186	/* -=-=-=-=-=- Keyboard: IKeyboardPort -=-=-=-=-=- */
1187
1188	/**
1189	* Keyboard event handler.
1190	*
1191	* @returns VBox status code.
1192	* @param pThis The PS2 keyboard instance data.
1193	* @param u32Usage USB HID usage code with key
1194	* press/release flag.
1195	*/
1196	static int ps2kPutEventWorker(PPS2K pThis, uint32_t u32Usage)
1197	{
1198	uint8_t u8HidCode;
1199	bool fKeyDown;
1200	bool fHaveEvent = true;
1201	int rc = VINF_SUCCESS;
1202
1203	/* Extract the usage code and ensure it's valid. */
1204	fKeyDown = !(u32Usage & 0x80000000);
1205	u8HidCode = u32Usage & 0xFF;
1206	AssertReturn(u8HidCode <= VBOX_USB_MAX_USAGE_CODE, VERR_INTERNAL_ERROR);
1207
1208	if (fKeyDown)
1209	{
1210	/* Due to host key repeat, we can get key events for keys which are
1211	* already depressed. We need to ignore those. */
1212	if (pThis->abDepressedKeys[u8HidCode])
1213	fHaveEvent = false;
1214	pThis->abDepressedKeys[u8HidCode] = 1;
1215	}
1216	else
1217	{
1218	/* NB: We allow key release events for keys which aren't depressed.
1219	* That is unlikely to happen and should not cause trouble.
1220	*/
1221	pThis->abDepressedKeys[u8HidCode] = 0;
1222	}
1223
1224	/* Unless this is a new key press/release, don't even bother. */
1225	if (fHaveEvent)
1226	{
1227	rc = PDMCritSectEnter(pThis->pCritSectR3, VERR_SEM_BUSY);
1228	AssertReleaseRC(rc);
1229
1230	rc = psk2ProcessKeyEvent(pThis, u8HidCode, fKeyDown);
1231
1232	PDMCritSectLeave(pThis->pCritSectR3);
1233	}
1234
1235	return rc;
1236	}
1237
1238	static DECLCALLBACK(int) ps2kPutEventWrapper(PPDMIKEYBOARDPORT pInterface, uint8_t u8KeyCode)
1239	{
1240	PPS2K pThis = RT_FROM_MEMBER(pInterface, PS2K, Keyboard.IPort);
1241	uint32_t u32Usage = 0;
1242
1243	LogFlowFunc(("key code %02X\n", u8KeyCode));
1244	pThis->XlatState = ScancodeToHidUsage(pThis->XlatState, u8KeyCode, &u32Usage);
1245
1246	if (pThis->XlatState == SS_IDLE)
1247	{
1248	/* Stupid Korean key hack: convert a lone break key into a press/release sequence. */
1249	if (u32Usage == 0x80000090 \|\| u32Usage == 0x80000091)
1250	ps2kPutEventWorker(pThis, u32Usage & ~0x80000000);
1251
1252	ps2kPutEventWorker(pThis, u32Usage);
1253	}
1254
1255	return VINF_SUCCESS;
1256	}
1257
1258
1259	/**
1260	* Attach command.
1261	*
1262	* This is called to let the device attach to a driver for a
1263	* specified LUN.
1264	*
1265	* This is like plugging in the keyboard after turning on the
1266	* system.
1267	*
1268	* @returns VBox status code.
1269	* @param pThis The PS/2 keyboard instance data.
1270	* @param pDevIns The device instance.
1271	* @param iLUN The logical unit which is being detached.
1272	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
1273	*/
1274	int PS2KAttach(PPS2K pThis, PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
1275	{
1276	int rc;
1277
1278	/* The LUN must be 0, i.e. keyboard. */
1279	Assert(iLUN == 0);
1280	AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
1281	("PS/2 keyboard does not support hotplugging\n"),
1282	VERR_INVALID_PARAMETER);
1283
1284	LogFlowFunc(("iLUN=%d\n", iLUN));
1285
1286	rc = PDMDevHlpDriverAttach(pDevIns, iLUN, &pThis->Keyboard.IBase, &pThis->Keyboard.pDrvBase, "Keyboard Port");
1287	if (RT_SUCCESS(rc))
1288	{
1289	pThis->Keyboard.pDrv = PDMIBASE_QUERY_INTERFACE(pThis->Keyboard.pDrvBase, PDMIKEYBOARDCONNECTOR);
1290	if (!pThis->Keyboard.pDrv)
1291	{
1292	AssertLogRelMsgFailed(("LUN #0 doesn't have a keyboard interface! rc=%Rrc\n", rc));
1293	rc = VERR_PDM_MISSING_INTERFACE;
1294	}
1295	}
1296	else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
1297	{
1298	Log(("%s/%d: warning: no driver attached to LUN #0!\n", pDevIns->pReg->szName, pDevIns->iInstance));
1299	rc = VINF_SUCCESS;
1300	}
1301	else
1302	AssertLogRelMsgFailed(("Failed to attach LUN #0! rc=%Rrc\n", rc));
1303
1304	return rc;
1305	}
1306
1307	void PS2KSaveState(PPS2K pThis, PSSMHANDLE pSSM)
1308	{
1309	uint32_t cPressed = 0;
1310	uint32_t cbTMSSize = 0;
1311
1312	LogFlowFunc(("Saving PS2K state\n"));
1313
1314	/* Save the basic keyboard state. */
1315	SSMR3PutU8(pSSM, pThis->u8CurrCmd);
1316	SSMR3PutU8(pSSM, pThis->u8LEDs);
1317	SSMR3PutU8(pSSM, pThis->u8Typematic);
1318	SSMR3PutU8(pSSM, pThis->u8TypematicKey);
1319	SSMR3PutU8(pSSM, pThis->u8Modifiers);
1320	SSMR3PutU8(pSSM, pThis->u8ScanSet);
1321	SSMR3PutU8(pSSM, pThis->enmTypematicState);
1322	SSMR3PutBool(pSSM, pThis->fNumLockOn);
1323	SSMR3PutBool(pSSM, pThis->fScanning);
1324
1325	/* Save the command and keystroke queues. */
1326	ps2kSaveQueue(pSSM, (GeneriQ *)&pThis->cmdQ);
1327	ps2kSaveQueue(pSSM, (GeneriQ *)&pThis->keyQ);
1328
1329	/* Save the command delay timer. Note that the typematic repeat
1330	* timer is not saved.
1331	*/
1332	TMR3TimerSave(pThis->CTX_SUFF(pKbdDelayTimer), pSSM);
1333
1334	/* Save any pressed keys. This is necessary to avoid "stuck"
1335	* keys after a restore. Needs two passes.
1336	*/
1337	for (unsigned i = 0; i < sizeof(pThis->abDepressedKeys); ++i)
1338	if (pThis->abDepressedKeys[i])
1339	++cPressed;
1340
1341	SSMR3PutU32(pSSM, cPressed);
1342
1343	for (unsigned i = 0; i < sizeof(pThis->abDepressedKeys); ++i)
1344	if (pThis->abDepressedKeys[i])
1345	SSMR3PutU8(pSSM, pThis->abDepressedKeys[i]);
1346
1347	/* Save the typematic settings for Scan Set 3. */
1348	SSMR3PutU32(pSSM, cbTMSSize);
1349	/* Currently not implemented. */
1350	}
1351
1352	int PS2KLoadState(PPS2K pThis, PSSMHANDLE pSSM, uint32_t uVersion)
1353	{
1354	uint8_t u8;
1355	uint32_t cPressed;
1356	uint32_t cbTMSSize;
1357	int rc;
1358
1359	NOREF(uVersion);
1360	LogFlowFunc(("Loading PS2K state version %u\n", uVersion));
1361
1362	/* Load the basic keyboard state. */
1363	SSMR3GetU8(pSSM, &pThis->u8CurrCmd);
1364	SSMR3GetU8(pSSM, &pThis->u8LEDs);
1365	SSMR3GetU8(pSSM, &pThis->u8Typematic);
1366	SSMR3GetU8(pSSM, &pThis->u8TypematicKey);
1367	SSMR3GetU8(pSSM, &pThis->u8Modifiers);
1368	SSMR3GetU8(pSSM, &pThis->u8ScanSet);
1369	SSMR3GetU8(pSSM, &u8);
1370	pThis->enmTypematicState = (tmatic_state_t)u8;
1371	SSMR3GetBool(pSSM, &pThis->fNumLockOn);
1372	SSMR3GetBool(pSSM, &pThis->fScanning);
1373
1374	/* Load the command and keystroke queues. */
1375	rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->cmdQ);
1376	AssertRCReturn(rc, rc);
1377	rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->keyQ);
1378	AssertRCReturn(rc, rc);
1379
1380	/* Load the command delay timer, just in case. */
1381	rc = TMR3TimerLoad(pThis->CTX_SUFF(pKbdDelayTimer), pSSM);
1382	AssertRCReturn(rc, rc);
1383
1384	/* Recalculate the typematic delay/rate. */
1385	ps2kSetupTypematic(pThis, pThis->u8Typematic);
1386
1387	/* Fake key up events for keys that were held down at the time the state was saved. */
1388	rc = SSMR3GetU32(pSSM, &cPressed);
1389	AssertRCReturn(rc, rc);
1390
1391	while (cPressed--)
1392	{
1393	rc = SSMR3GetU8(pSSM, &u8);
1394	AssertRCReturn(rc, rc);
1395	psk2ProcessKeyEvent(pThis, u8, false /* key up */);
1396	}
1397
1398	/* Load typematic settings for Scan Set 3. */
1399	rc = SSMR3GetU32(pSSM, &cbTMSSize);
1400	AssertRCReturn(rc, rc);
1401
1402	while (cbTMSSize--)
1403	{
1404	rc = SSMR3GetU8(pSSM, &u8);
1405	AssertRCReturn(rc, rc);
1406	}
1407
1408	return rc;
1409	}
1410
1411	void PS2KReset(PPS2K pThis)
1412	{
1413	LogFlowFunc(("Resetting PS2K\n"));
1414
1415	pThis->fScanning = true;
1416	pThis->u8ScanSet = 2;
1417	pThis->u8CurrCmd = 0;
1418	pThis->u8Modifiers = 0;
1419	pThis->u8TypematicKey = 0;
1420	pThis->enmTypematicState = KBD_TMS_IDLE;
1421
1422	/* Clear queues and any pressed keys. */
1423	memset(pThis->abDepressedKeys, 0, sizeof(pThis->abDepressedKeys));
1424	ps2kClearQueue((GeneriQ *)&pThis->cmdQ);
1425	ps2kSetDefaults(pThis); /* Also clears keystroke queue. */
1426
1427	/* Activate the PS/2 keyboard by default. */
1428	if (pThis->Keyboard.pDrv)
1429	pThis->Keyboard.pDrv->pfnSetActive(pThis->Keyboard.pDrv, true);
1430	}
1431
1432	void PS2KRelocate(PPS2K pThis, RTGCINTPTR offDelta, PPDMDEVINS pDevIns)
1433	{
1434	LogFlowFunc(("Relocating PS2K\n"));
1435	pThis->pKbdDelayTimerRC = TMTimerRCPtr(pThis->pKbdDelayTimerR3);
1436	pThis->pKbdTypematicTimerRC = TMTimerRCPtr(pThis->pKbdTypematicTimerR3);
1437	NOREF(offDelta);
1438	}
1439
1440	int PS2KConstruct(PPS2K pThis, PPDMDEVINS pDevIns, void *pParent, int iInstance)
1441	{
1442	int rc;
1443
1444	LogFlowFunc(("iInstance=%d\n", iInstance));
1445
1446	pThis->pParent = pParent;
1447
1448	/* Initialize the queues. */
1449	pThis->keyQ.cSize = KBD_KEY_QUEUE_SIZE;
1450	pThis->cmdQ.cSize = KBD_CMD_QUEUE_SIZE;
1451
1452	pThis->Keyboard.IBase.pfnQueryInterface = ps2kQueryInterface;
1453	pThis->Keyboard.IPort.pfnPutEvent = ps2kPutEventWrapper;
1454
1455	/*
1456	* Initialize the critical section pointer(s).
1457	*/
1458	pThis->pCritSectR3 = pDevIns->pCritSectRoR3;
1459
1460	/*
1461	* Create the typematic delay/repeat timer. Does not use virtual time!
1462	*/
1463	PTMTIMER pTimer;
1464	rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_REAL, ps2kTypematicTimer, pThis,
1465	TMTIMER_FLAGS_NO_CRIT_SECT, "PS2K Typematic Timer", &pTimer);
1466	if (RT_FAILURE(rc))
1467	return rc;
1468
1469	pThis->pKbdTypematicTimerR3 = pTimer;
1470	pThis->pKbdTypematicTimerR0 = TMTimerR0Ptr(pTimer);
1471	pThis->pKbdTypematicTimerRC = TMTimerRCPtr(pTimer);
1472
1473	/*
1474	* Create the command delay timer.
1475	*/
1476	rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, ps2kDelayTimer, pThis,
1477	TMTIMER_FLAGS_NO_CRIT_SECT, "PS2K Delay Timer", &pTimer);
1478	if (RT_FAILURE(rc))
1479	return rc;
1480
1481	pThis->pKbdDelayTimerR3 = pTimer;
1482	pThis->pKbdDelayTimerR0 = TMTimerR0Ptr(pTimer);
1483	pThis->pKbdDelayTimerRC = TMTimerRCPtr(pTimer);
1484
1485	/*
1486	* Register debugger info callbacks.
1487	*/
1488	PDMDevHlpDBGFInfoRegister(pDevIns, "ps2k", "Display PS/2 keyboard state.", ps2kInfoState);
1489
1490	return rc;
1491	}
1492
1493	#endif
1494
1495	///@todo The following should live with the KBC implementation.
1496
1497	/* Table used by the keyboard controller to optionally translate the incoming
1498	* keyboard data. Note that the translation is designed for essentially taking
1499	* Scan Set 2 input and producing Scan Set 1 output, but can be turned on and
1500	* off regardless of what the keyboard is sending.
1501	*/
1502	static uint8_t aAT2PC[128] = {
1503	0xff,0x43,0x41,0x3f,0x3d,0x3b,0x3c,0x58,0x64,0x44,0x42,0x40,0x3e,0x0f,0x29,0x59,
1504	0x65,0x38,0x2a,0x70,0x1d,0x10,0x02,0x5a,0x66,0x71,0x2c,0x1f,0x1e,0x11,0x03,0x5b,
1505	0x67,0x2e,0x2d,0x20,0x12,0x05,0x04,0x5c,0x68,0x39,0x2f,0x21,0x14,0x13,0x06,0x5d,
1506	0x69,0x31,0x30,0x23,0x22,0x15,0x07,0x5e,0x6a,0x72,0x32,0x24,0x16,0x08,0x09,0x5f,
1507	0x6b,0x33,0x25,0x17,0x18,0x0b,0x0a,0x60,0x6c,0x34,0x35,0x26,0x27,0x19,0x0c,0x61,
1508	0x6d,0x73,0x28,0x74,0x1a,0x0d,0x62,0x6e,0x3a,0x36,0x1c,0x1b,0x75,0x2b,0x63,0x76,
1509	0x55,0x56,0x77,0x78,0x79,0x7a,0x0e,0x7b,0x7c,0x4f,0x7d,0x4b,0x47,0x7e,0x7f,0x6f,
1510	0x52,0x53,0x50,0x4c,0x4d,0x48,0x01,0x45,0x57,0x4e,0x51,0x4a,0x37,0x49,0x46,0x54
1511	};
1512
1513	/**
1514	* Convert an AT (Scan Set 2) scancode to PC (Scan Set 1).
1515	*
1516	* @param state Current state of the translator
1517	* (xlat_state_t).
1518	* @param scanIn Incoming scan code.
1519	* @param pScanOut Pointer to outgoing scan code. The
1520	* contents are only valid if returned
1521	* state is not XS_BREAK.
1522	*
1523	* @return xlat_state_t New state of the translator.
1524	*/
1525	int32_t XlateAT2PC(int32_t state, uint8_t scanIn, uint8_t *pScanOut)
1526	{
1527	uint8_t scan_in;
1528	uint8_t scan_out;
1529
1530	Assert(pScanOut);
1531	Assert(state == XS_IDLE \|\| state == XS_BREAK \|\| state == XS_HIBIT);
1532
1533	/* Preprocess the scan code for a 128-entry translation table. */
1534	if (scanIn == 0x83) /* Check for F7 key. */
1535	scan_in = 0x02;
1536	else if (scanIn == 0x84) /* Check for SysRq key. */
1537	scan_in = 0x7f;
1538	else
1539	scan_in = scanIn;
1540
1541	/* Values 0x80 and above are passed through, except for 0xF0
1542	* which indicates a key release.
1543	*/
1544	if (scan_in < 0x80)
1545	{
1546	scan_out = aAT2PC[scan_in];
1547	/* Turn into break code if required. */
1548	if (state == XS_BREAK \|\| state == XS_HIBIT)
1549	scan_out \|= 0x80;
1550
1551	state = XS_IDLE;
1552	}
1553	else
1554	{
1555	/* NB: F0 E0 10 will be translated to E0 E5 (high bit set on last byte)! */
1556	if (scan_in == 0xF0) /* Check for break code. */
1557	state = XS_BREAK;
1558	else if (state == XS_BREAK)
1559	state = XS_HIBIT; /* Remember the break bit. */
1560	scan_out = scan_in;
1561	}
1562	LogFlowFunc(("scan code %02X translated to %02X; new state is %d\n",
1563	scanIn, scan_out, state));
1564
1565	*pScanOut = scan_out;
1566	return state;
1567	}
1568
1569	#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/Input/PS2K.cpp@ 47791

Download in other formats: