VirtualBox

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

Last change on this file since 55364 was 55077, checked in by vboxsync, 10 years ago

PS2K: group IN_RING3 code.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 57.9 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 /* Also a 'release keys' signal. */
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. */
133typedef 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. */
140typedef 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
148DEF_PS2Q_TYPE(KbdKeyQ, KBD_KEY_QUEUE_SIZE);
149DEF_PS2Q_TYPE(KbdCmdQ, KBD_CMD_QUEUE_SIZE);
150DEF_PS2Q_TYPE(GeneriQ, 1);
151
152/**
153 * The PS/2 keyboard instance data.
154 */
155typedef 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
232AssertCompile(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. */
258typedef 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. */
267static 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. */
449static 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* Internal Functions *
466*******************************************************************************/
467
468
469/**
470 * Clear a queue.
471 *
472 * @param pQ Pointer to the queue.
473 */
474static void ps2kClearQueue(GeneriQ *pQ)
475{
476 LogFlowFunc(("Clearing queue %p\n", pQ));
477 pQ->wpos = pQ->rpos;
478 pQ->cUsed = 0;
479}
480
481
482/**
483 * Add a byte to a queue.
484 *
485 * @param pQ Pointer to the queue.
486 * @param val The byte to store.
487 */
488static void ps2kInsertQueue(GeneriQ *pQ, uint8_t val)
489{
490 /* Check if queue is full. */
491 if (pQ->cUsed >= pQ->cSize)
492 {
493 LogFlowFunc(("queue %p full (%d entries)\n", pQ, pQ->cUsed));
494 return;
495 }
496 /* Insert data and update circular buffer write position. */
497 pQ->abQueue[pQ->wpos] = val;
498 if (++pQ->wpos == pQ->cSize)
499 pQ->wpos = 0; /* Roll over. */
500 ++pQ->cUsed;
501 LogFlowFunc(("inserted 0x%02X into queue %p\n", val, pQ));
502}
503
504#ifdef IN_RING3
505
506/**
507 * Save a queue state.
508 *
509 * @param pSSM SSM handle to write the state to.
510 * @param pQ Pointer to the queue.
511 */
512static void ps2kSaveQueue(PSSMHANDLE pSSM, GeneriQ *pQ)
513{
514 uint32_t cItems = pQ->cUsed;
515 int i;
516
517 /* Only save the number of items. Note that the read/write
518 * positions aren't saved as they will be rebuilt on load.
519 */
520 SSMR3PutU32(pSSM, cItems);
521
522 LogFlow(("Storing %d items from queue %p\n", cItems, pQ));
523
524 /* Save queue data - only the bytes actually used (typically zero). */
525 for (i = pQ->rpos; cItems-- > 0; i = (i + 1) % pQ->cSize)
526 SSMR3PutU8(pSSM, pQ->abQueue[i]);
527}
528
529/**
530 * Load a queue state.
531 *
532 * @param pSSM SSM handle to read the state from.
533 * @param pQ Pointer to the queue.
534 *
535 * @return int VBox status/error code.
536 */
537static int ps2kLoadQueue(PSSMHANDLE pSSM, GeneriQ *pQ)
538{
539 /* On load, always put the read pointer at zero. */
540 int rc = SSMR3GetU32(pSSM, &pQ->cUsed);
541 AssertRCReturn(rc, rc);
542 LogFlow(("Loading %u items to queue %p\n", pQ->cUsed, pQ));
543 AssertMsgReturn(pQ->cUsed <= pQ->cSize, ("Saved size=%u, actual=%u\n", pQ->cUsed, pQ->cSize),
544 VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
545
546 /* Recalculate queue positions and load data in one go. */
547 pQ->rpos = 0;
548 pQ->wpos = pQ->cUsed;
549 rc = SSMR3GetMem(pSSM, pQ->abQueue, pQ->cUsed);
550
551 return rc;
552}
553
554/**
555 * Notify listener about LEDs state change.
556 *
557 * @param pThis The PS/2 keyboard instance data.
558 * @param u8State Bitfield which reflects LEDs state.
559 */
560static void ps2kNotifyLedsState(PPS2K pThis, uint8_t u8State)
561{
562
563 PDMKEYBLEDS enmLeds = PDMKEYBLEDS_NONE;
564
565 if (u8State & 0x01)
566 enmLeds = (PDMKEYBLEDS)(enmLeds | PDMKEYBLEDS_SCROLLLOCK);
567 if (u8State & 0x02)
568 enmLeds = (PDMKEYBLEDS)(enmLeds | PDMKEYBLEDS_NUMLOCK);
569 if (u8State & 0x04)
570 enmLeds = (PDMKEYBLEDS)(enmLeds | PDMKEYBLEDS_CAPSLOCK);
571
572 pThis->Keyboard.pDrv->pfnLedStatusChange(pThis->Keyboard.pDrv, enmLeds);
573
574}
575#endif /* IN_RING3 */
576
577/**
578 * Retrieve a byte from a queue.
579 *
580 * @param pQ Pointer to the queue.
581 * @param pVal Pointer to storage for the byte.
582 *
583 * @return int VINF_TRY_AGAIN if queue is empty,
584 * VINF_SUCCESS if a byte was read.
585 */
586static int ps2kRemoveQueue(GeneriQ *pQ, uint8_t *pVal)
587{
588 int rc = VINF_TRY_AGAIN;
589
590 Assert(pVal);
591 if (pQ->cUsed)
592 {
593 *pVal = pQ->abQueue[pQ->rpos];
594 if (++pQ->rpos == pQ->cSize)
595 pQ->rpos = 0; /* Roll over. */
596 --pQ->cUsed;
597 rc = VINF_SUCCESS;
598 LogFlowFunc(("removed 0x%02X from queue %p\n", *pVal, pQ));
599 } else
600 LogFlowFunc(("queue %p empty\n", pQ));
601 return rc;
602}
603
604/* Convert encoded typematic value to milliseconds. Note that the values are rated
605 * with +/- 20% accuracy, so there's no need for high precision.
606 */
607static void ps2kSetupTypematic(PPS2K pThis, uint8_t val)
608{
609 int A, B;
610 unsigned period;
611
612 pThis->u8Typematic = val;
613 /* The delay is easy: (1 + value) * 250 ms */
614 pThis->uTypematicDelay = (1 + ((val >> 5) & 3)) * 250;
615 /* The rate is more complicated: (8 + A) * 2^B * 4.17 ms */
616 A = val & 7;
617 B = (val >> 3) & 3;
618 period = (8 + A) * (1 << B) * 417 / 100;
619 pThis->uTypematicRepeat = period;
620 Log(("Typematic delay %u ms, repeat period %u ms\n",
621 pThis->uTypematicDelay, pThis->uTypematicRepeat));
622}
623
624static void ps2kSetDefaults(PPS2K pThis)
625{
626 LogFlowFunc(("Set keyboard defaults\n"));
627 ps2kClearQueue((GeneriQ *)&pThis->keyQ);
628 /* Set default Scan Set 3 typematic values. */
629 /* Set default typematic rate/delay. */
630 ps2kSetupTypematic(pThis, KBD_DFL_RATE_DELAY);
631 /* Clear last typematic key?? */
632}
633
634/**
635 * Receive and process a byte sent by the keyboard controller.
636 *
637 * @param pThis The PS/2 keyboard instance data.
638 * @param cmd The command (or data) byte.
639 */
640int PS2KByteToKbd(PPS2K pThis, uint8_t cmd)
641{
642 bool fHandled = true;
643
644 LogFlowFunc(("new cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
645
646 if (pThis->u8CurrCmd == KCMD_RESET)
647 /* In reset mode, do not respond at all. */
648 return VINF_SUCCESS;
649
650 switch (cmd)
651 {
652 case KCMD_ECHO:
653 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ECHO);
654 pThis->u8CurrCmd = 0;
655 break;
656 case KCMD_READ_ID:
657 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
658 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ID1);
659 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ID2);
660 pThis->u8CurrCmd = 0;
661 break;
662 case KCMD_ENABLE:
663 pThis->fScanning = true;
664 ps2kClearQueue((GeneriQ *)&pThis->keyQ);
665 /* Clear last typematic key?? */
666 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
667 pThis->u8CurrCmd = 0;
668 break;
669 case KCMD_DFLT_DISABLE:
670 pThis->fScanning = false;
671 ps2kSetDefaults(pThis);
672 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
673 pThis->u8CurrCmd = 0;
674 break;
675 case KCMD_SET_DEFAULT:
676 ps2kSetDefaults(pThis);
677 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
678 pThis->u8CurrCmd = 0;
679 break;
680 case KCMD_ALL_TYPEMATIC:
681 case KCMD_ALL_MK_BRK:
682 case KCMD_ALL_MAKE:
683 case KCMD_ALL_TMB:
684 ///@todo Set the key types here.
685 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
686 pThis->u8CurrCmd = 0;
687 break;
688 case KCMD_RESEND:
689 pThis->u8CurrCmd = 0;
690 break;
691 case KCMD_RESET:
692 pThis->u8ScanSet = 2;
693 ps2kSetDefaults(pThis);
694 ///@todo reset more?
695 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
696 pThis->u8CurrCmd = cmd;
697 /* Delay BAT completion; the test may take hundreds of ms. */
698 TMTimerSetMillies(pThis->CTX_SUFF(pKbdDelayTimer), 2);
699 break;
700 /* The following commands need a parameter. */
701 case KCMD_LEDS:
702 case KCMD_SCANSET:
703 case KCMD_RATE_DELAY:
704 case KCMD_TYPE_MATIC:
705 case KCMD_TYPE_MK_BRK:
706 case KCMD_TYPE_MAKE:
707 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
708 pThis->u8CurrCmd = cmd;
709 break;
710 default:
711 /* Sending a command instead of a parameter starts the new command. */
712 switch (pThis->u8CurrCmd)
713 {
714 case KCMD_LEDS:
715#ifndef IN_RING3
716 return VINF_IOM_R3_IOPORT_WRITE;
717#else
718 {
719 ps2kNotifyLedsState(pThis, cmd);
720 pThis->fNumLockOn = !!(cmd & 0x02); /* Sync internal Num Lock state. */
721 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
722 pThis->u8LEDs = cmd;
723 pThis->u8CurrCmd = 0;
724 }
725#endif
726 break;
727 case KCMD_SCANSET:
728 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
729 if (cmd == 0)
730 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8ScanSet);
731 else if (cmd < 4)
732 {
733 pThis->u8ScanSet = cmd;
734 LogRel(("PS2K: Selected scan set %d.\n", cmd));
735 }
736 /* Other values are simply ignored. */
737 pThis->u8CurrCmd = 0;
738 break;
739 case KCMD_RATE_DELAY:
740 ps2kSetupTypematic(pThis, cmd);
741 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_ACK);
742 pThis->u8CurrCmd = 0;
743 break;
744 default:
745 fHandled = false;
746 }
747 /* Fall through only to handle unrecognized commands. */
748 if (fHandled)
749 break;
750
751 case KCMD_INVALID_1:
752 case KCMD_INVALID_2:
753 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_RESEND);
754 pThis->u8CurrCmd = 0;
755 break;
756 }
757 LogFlowFunc(("Active cmd now 0x%02X; updating interrupts\n", pThis->u8CurrCmd));
758// KBCUpdateInterrupts(pThis->pParent);
759 return VINF_SUCCESS;
760}
761
762/**
763 * Send a byte (keystroke or command response) to the keyboard controller.
764 *
765 * @returns VINF_SUCCESS or VINF_TRY_AGAIN.
766 * @param pThis The PS/2 keyboard instance data.
767 * @param pb Where to return the byte we've read.
768 * @remarks Caller must have entered the device critical section.
769 */
770int PS2KByteFromKbd(PPS2K pThis, uint8_t *pb)
771{
772 int rc;
773
774 AssertPtr(pb);
775
776 /* Anything in the command queue has priority over data
777 * in the keystroke queue. Additionally, keystrokes are
778 * blocked if a command is currently in progress, even if
779 * the command queue is empty.
780 */
781 rc = ps2kRemoveQueue((GeneriQ *)&pThis->cmdQ, pb);
782 if (rc != VINF_SUCCESS && !pThis->u8CurrCmd && pThis->fScanning)
783 rc = ps2kRemoveQueue((GeneriQ *)&pThis->keyQ, pb);
784
785 LogFlowFunc(("keyboard sends 0x%02x (%svalid data)\n", *pb, rc == VINF_SUCCESS ? "" : "not "));
786 return rc;
787}
788
789#ifdef IN_RING3
790
791static int ps2kProcessKeyEvent(PPS2K pThis, uint8_t u8HidCode, bool fKeyDown)
792{
793 unsigned int i = 0;
794 key_def const *pKeyDef;
795 uint8_t abCodes[16];
796 uint8_t u8MakeCode;
797
798 LogFlowFunc(("key %s: 0x%02x (set %d)\n", fKeyDown ? "down" : "up", u8HidCode, pThis->u8ScanSet));
799
800 /* Find the key definition in somewhat sparse storage. */
801 pKeyDef = u8HidCode >= HID_MODIFIER_FIRST ? &aPS2ModKeys[u8HidCode - HID_MODIFIER_FIRST] : &aPS2Keys[u8HidCode];
802
803 /* Some keys are not processed at all; early return. */
804 if (pKeyDef->makeS1 == NONE)
805 {
806 LogFlow(("Skipping key processing.\n"));
807 return VINF_SUCCESS;
808 }
809
810 /* Handle modifier keys (Ctrl/Alt/Shift/GUI). We need to keep track
811 * of their state in addition to sending the scan code.
812 */
813 if (u8HidCode >= HID_MODIFIER_FIRST)
814 {
815 unsigned mod_bit = 1 << (u8HidCode - HID_MODIFIER_FIRST);
816
817 Assert((u8HidCode <= HID_MODIFIER_LAST));
818 if (fKeyDown)
819 pThis->u8Modifiers |= mod_bit;
820 else
821 pThis->u8Modifiers &= ~mod_bit;
822 }
823
824 /* Toggle NumLock state. */
825 if ((pKeyDef->keyFlags & KF_NL) && fKeyDown)
826 pThis->fNumLockOn ^= true;
827
828 if (pThis->u8ScanSet == 1 || pThis->u8ScanSet == 2)
829 {
830 /* The basic scan set 1 and 2 logic is the same, only the scan codes differ.
831 * Since scan set 2 is used almost all the time, that case is handled first.
832 */
833 abCodes[0] = 0;
834 if (fKeyDown)
835 {
836 /* Process key down event. */
837 if (pKeyDef->keyFlags & KF_PB)
838 {
839 /* Pause/Break sends different data if either Ctrl is held. */
840 if (pThis->u8Modifiers & (MOD_LCTRL | MOD_RCTRL))
841 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
842 "\xE0\x7E\xE0\xF0\x7E" : "\xE0\x46\xE0\xC6");
843 else
844 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
845 "\xE1\x14\x77\xE1\xF0\x14\xF0\x77" : "\xE1\x1D\x45\xE1\x9D\xC5");
846 }
847 else if (pKeyDef->keyFlags & KF_PS)
848 {
849 /* Print Screen depends on all of Ctrl, Shift, *and* Alt! */
850 if (pThis->u8Modifiers & (MOD_LALT | MOD_RALT))
851 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
852 "\x84" : "\x54");
853 else if (pThis->u8Modifiers & (MOD_LSHIFT | MOD_RSHIFT))
854 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
855 "\xE0\x7C" : "\xE0\x37");
856 else
857 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
858 "\xE0\x12\xE0\x7C" : "\xE0\x2A\xE0\x37");
859 }
860 else if (pKeyDef->keyFlags & (KF_GK | KF_NS))
861 {
862 /* The numeric pad keys fake Shift presses or releases
863 * depending on Num Lock and Shift key state. The '/'
864 * key behaves in a similar manner but does not depend on
865 * the Num Lock state.
866 */
867 if (!pThis->fNumLockOn || (pKeyDef->keyFlags & KF_NS))
868 {
869 if (pThis->u8Modifiers & MOD_LSHIFT)
870 strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
871 "\xE0\xF0\x12" : "\xE0\xAA");
872 if (pThis->u8Modifiers & MOD_RSHIFT)
873 strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
874 "\xE0\xF0\x59" : "\xE0\xB6");
875 }
876 else
877 {
878 Assert(pThis->fNumLockOn); /* Not for KF_NS! */
879 if ((pThis->u8Modifiers & (MOD_LSHIFT | MOD_RSHIFT)) == 0)
880 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
881 "\xE0\x12" : "\xE0\x2A");
882 /* Else Shift cancels NumLock, so no prefix! */
883 }
884 }
885 /* Feed the bytes to the queue if there is room. */
886 ///@todo check empty space!
887 while (abCodes[i])
888 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, abCodes[i++]);
889 Assert(i < sizeof(abCodes));
890
891 /* Standard processing for regular keys only. */
892 u8MakeCode = pThis->u8ScanSet == 2 ? pKeyDef->makeS2 : pKeyDef->makeS1;
893 if (!(pKeyDef->keyFlags & (KF_PB | KF_PS)))
894 {
895 if (pKeyDef->keyFlags & (KF_E0 | KF_GK | KF_NS))
896 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xE0);
897 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, u8MakeCode);
898 }
899 }
900 else if (!(pKeyDef->keyFlags & (KF_NB | KF_PB)))
901 {
902 /* Process key up event except for keys which produce none. */
903
904 /* Handle Print Screen release. */
905 if (pKeyDef->keyFlags & KF_PS)
906 {
907 /* Undo faked Print Screen state as needed. */
908 if (pThis->u8Modifiers & (MOD_LALT | MOD_RALT))
909 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
910 "\xF0\x84" : "\xD4");
911 else if (pThis->u8Modifiers & (MOD_LSHIFT | MOD_RSHIFT))
912 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
913 "\xE0\xF0\x7C" : "\xE0\xB7");
914 else
915 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
916 "\xE0\xF0\x7C\xE0\xF0\x12" : "\xE0\xB7\xE0\xAA");
917 }
918 else
919 {
920 /* Process base scan code for less unusual keys. */
921 if (pKeyDef->keyFlags & (KF_E0 | KF_GK | KF_NS))
922 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xE0);
923 if (pThis->u8ScanSet == 2) {
924 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xF0);
925 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS2);
926 } else {
927 Assert(pThis->u8ScanSet == 1);
928 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS1 | 0x80);
929 }
930
931 /* Restore shift state for gray keys. */
932 if (pKeyDef->keyFlags & (KF_GK | KF_NS))
933 {
934 if (!pThis->fNumLockOn || (pKeyDef->keyFlags & KF_NS))
935 {
936 if (pThis->u8Modifiers & MOD_LSHIFT)
937 strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
938 "\xE0\x12" : "\xE0\x2A");
939 if (pThis->u8Modifiers & MOD_RSHIFT)
940 strcat((char *)abCodes, pThis->u8ScanSet == 2 ?
941 "\xE0\x59" : "\xE0\x36");
942 }
943 else
944 {
945 Assert(pThis->fNumLockOn); /* Not for KF_NS! */
946 if ((pThis->u8Modifiers & (MOD_LSHIFT | MOD_RSHIFT)) == 0)
947 strcpy((char *)abCodes, pThis->u8ScanSet == 2 ?
948 "\xE0\xF0\x12" : "\xE0\xAA");
949 }
950 }
951 }
952
953 /* Feed any additional bytes to the queue if there is room. */
954 ///@todo check empty space!
955 while (abCodes[i])
956 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, abCodes[i++]);
957 Assert(i < sizeof(abCodes));
958 }
959 }
960 else
961 {
962 /* Handle Scan Set 3 - very straightforward. */
963 Assert(pThis->u8ScanSet == 3);
964 if (fKeyDown)
965 {
966 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS3);
967 }
968 else
969 {
970 /* Send a key release code unless it's a make only key. */
971 ///@todo Look up the current typematic setting, not the default!
972 if (pKeyDef->keyMatic != T_M)
973 {
974 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, 0xF0);
975 ps2kInsertQueue((GeneriQ *)&pThis->keyQ, pKeyDef->makeS3);
976 }
977 }
978 }
979
980 /* Set up or cancel typematic key repeat. */
981 if (fKeyDown)
982 {
983 if (pThis->u8TypematicKey != u8HidCode)
984 {
985 pThis->enmTypematicState = KBD_TMS_DELAY;
986 pThis->u8TypematicKey = u8HidCode;
987 TMTimerSetMillies(pThis->CTX_SUFF(pKbdTypematicTimer), pThis->uTypematicDelay);
988 Log(("Typematic delay %u ms, key %02X\n", pThis->uTypematicDelay, u8HidCode));
989 }
990 }
991 else
992 {
993 pThis->u8TypematicKey = 0;
994 pThis->enmTypematicState = KBD_TMS_IDLE;
995 ///@todo Cancel timer right away?
996 ///@todo Cancel timer before pushing key up code!?
997 }
998
999 /* Poke the KBC to update its state. */
1000 KBCUpdateInterrupts(pThis->pParent);
1001
1002 return VINF_SUCCESS;
1003}
1004
1005/* Timer handler for emulating typematic keys. Note that only the last key
1006 * held down repeats (if typematic).
1007 */
1008static DECLCALLBACK(void) ps2kTypematicTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
1009{
1010 PPS2K pThis = (PS2K *)pvUser; NOREF(pDevIns);
1011 LogFlowFunc(("Typematic state=%d, key %02X\n", pThis->enmTypematicState, pThis->u8TypematicKey));
1012
1013 /* If the current typematic key is zero, the repeat was canceled just when
1014 * the timer was about to run. In that case, do nothing.
1015 */
1016 if (pThis->u8TypematicKey)
1017 {
1018 if (pThis->enmTypematicState == KBD_TMS_DELAY)
1019 pThis->enmTypematicState = KBD_TMS_REPEAT;
1020
1021 if (pThis->enmTypematicState == KBD_TMS_REPEAT)
1022 {
1023 ps2kProcessKeyEvent(pThis, pThis->u8TypematicKey, true /* Key down */ );
1024 TMTimerSetMillies(pThis->CTX_SUFF(pKbdTypematicTimer), pThis->uTypematicRepeat);
1025 }
1026 }
1027}
1028
1029/* The keyboard BAT is specified to take several hundred milliseconds. We need
1030 * to delay sending the result to the host for at least a tiny little while.
1031 */
1032static DECLCALLBACK(void) ps2kDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
1033{
1034 PPS2K pThis = (PS2K *)pvUser; NOREF(pDevIns);
1035
1036 LogFlowFunc(("Delay timer: cmd %02X\n", pThis->u8CurrCmd));
1037
1038 AssertMsg(pThis->u8CurrCmd == KCMD_RESET, ("u8CurrCmd=%02x\n", pThis->u8CurrCmd));
1039 ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, KRSP_BAT_OK);
1040 pThis->fScanning = true; /* BAT completion enables scanning! */
1041 pThis->u8CurrCmd = 0;
1042
1043 ///@todo Might want a PS2KCompleteCommand() to push last response, clear command, and kick the KBC...
1044 /* Give the KBC a kick. */
1045 KBCUpdateInterrupts(pThis->pParent);
1046}
1047
1048/* Release any and all currently depressed keys. Used whenever the guest keyboard
1049 * is likely to be out of sync with the host, such as when loading a saved state
1050 * or resuming a suspended host.
1051 */
1052static void ps2kReleaseKeys(PPS2K pThis)
1053{
1054 LogFlowFunc(("Releasing keys...\n"));
1055
1056 for (unsigned uKey = 0; uKey < sizeof(pThis->abDepressedKeys); ++uKey)
1057 if (pThis->abDepressedKeys[uKey])
1058 {
1059 ps2kProcessKeyEvent(pThis, uKey, false /* key up */);
1060 pThis->abDepressedKeys[uKey] = 0;
1061 }
1062 LogFlowFunc(("Done releasing keys\n"));
1063}
1064
1065
1066/**
1067 * Debug device info handler. Prints basic keyboard state.
1068 *
1069 * @param pDevIns Device instance which registered the info.
1070 * @param pHlp Callback functions for doing output.
1071 * @param pszArgs Argument string. Optional and specific to the handler.
1072 */
1073static DECLCALLBACK(void) ps2kInfoState(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1074{
1075 PPS2K pThis = KBDGetPS2KFromDevIns(pDevIns);
1076 NOREF(pszArgs);
1077
1078 pHlp->pfnPrintf(pHlp, "PS/2 Keyboard: scan set %d, scanning %s\n",
1079 pThis->u8ScanSet, pThis->fScanning ? "enabled" : "disabled");
1080 pHlp->pfnPrintf(pHlp, "Active command %02X\n", pThis->u8CurrCmd);
1081 pHlp->pfnPrintf(pHlp, "LED state %02X, Num Lock %s\n", pThis->u8LEDs,
1082 pThis->fNumLockOn ? "on" : "off");
1083 pHlp->pfnPrintf(pHlp, "Typematic delay %ums, repeat period %ums\n",
1084 pThis->uTypematicDelay, pThis->uTypematicRepeat);
1085 pHlp->pfnPrintf(pHlp, "Command queue: %d items (%d max)\n",
1086 pThis->cmdQ.cUsed, pThis->cmdQ.cSize);
1087 pHlp->pfnPrintf(pHlp, "Input queue : %d items (%d max)\n",
1088 pThis->keyQ.cUsed, pThis->keyQ.cSize);
1089 if (pThis->enmTypematicState != KBD_TMS_IDLE)
1090 pHlp->pfnPrintf(pHlp, "Active typematic key %02X (%s)\n", pThis->u8Typematic,
1091 pThis->enmTypematicState == KBD_TMS_DELAY ? "delay" : "repeat");
1092}
1093
1094/* -=-=-=-=-=- Keyboard: IBase -=-=-=-=-=- */
1095
1096/**
1097 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
1098 */
1099static DECLCALLBACK(void *) ps2kQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1100{
1101 PPS2K pThis = RT_FROM_MEMBER(pInterface, PS2K, Keyboard.IBase);
1102 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->Keyboard.IBase);
1103 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIKEYBOARDPORT, &pThis->Keyboard.IPort);
1104 return NULL;
1105}
1106
1107
1108/* -=-=-=-=-=- Keyboard: IKeyboardPort -=-=-=-=-=- */
1109
1110/**
1111 * Keyboard event handler.
1112 *
1113 * @returns VBox status code.
1114 * @param pThis The PS2 keyboard instance data.
1115 * @param u32Usage USB HID usage code with key
1116 * press/release flag.
1117 */
1118static int ps2kPutEventWorker(PPS2K pThis, uint32_t u32Usage)
1119{
1120 uint8_t u8HidCode;
1121 bool fKeyDown;
1122 bool fHaveEvent = true;
1123 int rc = VINF_SUCCESS;
1124
1125 /* Extract the usage code and ensure it's valid. */
1126 fKeyDown = !(u32Usage & 0x80000000);
1127 u8HidCode = u32Usage & 0xFF;
1128 AssertReturn(u8HidCode <= VBOX_USB_MAX_USAGE_CODE, VERR_INTERNAL_ERROR);
1129
1130 if (fKeyDown)
1131 {
1132 /* Due to host key repeat, we can get key events for keys which are
1133 * already depressed. We need to ignore those. */
1134 if (pThis->abDepressedKeys[u8HidCode])
1135 fHaveEvent = false;
1136 pThis->abDepressedKeys[u8HidCode] = 1;
1137 }
1138 else
1139 {
1140 /* NB: We allow key release events for keys which aren't depressed.
1141 * That is unlikely to happen and should not cause trouble.
1142 */
1143 pThis->abDepressedKeys[u8HidCode] = 0;
1144 }
1145
1146 /* Unless this is a new key press/release, don't even bother. */
1147 if (fHaveEvent)
1148 {
1149 rc = PDMCritSectEnter(pThis->pCritSectR3, VERR_SEM_BUSY);
1150 AssertReleaseRC(rc);
1151
1152 rc = ps2kProcessKeyEvent(pThis, u8HidCode, fKeyDown);
1153
1154 PDMCritSectLeave(pThis->pCritSectR3);
1155 }
1156
1157 return rc;
1158}
1159
1160static DECLCALLBACK(int) ps2kPutEventWrapper(PPDMIKEYBOARDPORT pInterface, uint32_t u32UsageCode)
1161{
1162 PPS2K pThis = RT_FROM_MEMBER(pInterface, PS2K, Keyboard.IPort);
1163 int rc;
1164
1165 LogFlowFunc(("key code %08X\n", u32UsageCode));
1166
1167 rc = PDMCritSectEnter(pThis->pCritSectR3, VERR_SEM_BUSY);
1168 AssertReleaseRC(rc);
1169
1170 /* The 'BAT fail' scancode is reused as a signal to release keys. No actual
1171 * key is allowed to use this scancode.
1172 */
1173 if (RT_UNLIKELY(u32UsageCode == KRSP_BAT_FAIL))
1174 {
1175 ps2kReleaseKeys(pThis);
1176 }
1177 else
1178 {
1179 ps2kPutEventWorker(pThis, u32UsageCode);
1180 }
1181
1182 PDMCritSectLeave(pThis->pCritSectR3);
1183
1184 return VINF_SUCCESS;
1185}
1186
1187
1188/**
1189 * Attach command.
1190 *
1191 * This is called to let the device attach to a driver for a
1192 * specified LUN.
1193 *
1194 * This is like plugging in the keyboard after turning on the
1195 * system.
1196 *
1197 * @returns VBox status code.
1198 * @param pThis The PS/2 keyboard instance data.
1199 * @param pDevIns The device instance.
1200 * @param iLUN The logical unit which is being detached.
1201 * @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
1202 */
1203int PS2KAttach(PPS2K pThis, PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
1204{
1205 int rc;
1206
1207 /* The LUN must be 0, i.e. keyboard. */
1208 Assert(iLUN == 0);
1209 AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
1210 ("PS/2 keyboard does not support hotplugging\n"),
1211 VERR_INVALID_PARAMETER);
1212
1213 LogFlowFunc(("iLUN=%d\n", iLUN));
1214
1215 rc = PDMDevHlpDriverAttach(pDevIns, iLUN, &pThis->Keyboard.IBase, &pThis->Keyboard.pDrvBase, "Keyboard Port");
1216 if (RT_SUCCESS(rc))
1217 {
1218 pThis->Keyboard.pDrv = PDMIBASE_QUERY_INTERFACE(pThis->Keyboard.pDrvBase, PDMIKEYBOARDCONNECTOR);
1219 if (!pThis->Keyboard.pDrv)
1220 {
1221 AssertLogRelMsgFailed(("LUN #0 doesn't have a keyboard interface! rc=%Rrc\n", rc));
1222 rc = VERR_PDM_MISSING_INTERFACE;
1223 }
1224 }
1225 else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
1226 {
1227 Log(("%s/%d: warning: no driver attached to LUN #0!\n", pDevIns->pReg->szName, pDevIns->iInstance));
1228 rc = VINF_SUCCESS;
1229 }
1230 else
1231 AssertLogRelMsgFailed(("Failed to attach LUN #0! rc=%Rrc\n", rc));
1232
1233 return rc;
1234}
1235
1236void PS2KSaveState(PPS2K pThis, PSSMHANDLE pSSM)
1237{
1238 uint32_t cPressed = 0;
1239 uint32_t cbTMSSize = 0;
1240
1241 LogFlowFunc(("Saving PS2K state\n"));
1242
1243 /* Save the basic keyboard state. */
1244 SSMR3PutU8(pSSM, pThis->u8CurrCmd);
1245 SSMR3PutU8(pSSM, pThis->u8LEDs);
1246 SSMR3PutU8(pSSM, pThis->u8Typematic);
1247 SSMR3PutU8(pSSM, pThis->u8TypematicKey);
1248 SSMR3PutU8(pSSM, pThis->u8Modifiers);
1249 SSMR3PutU8(pSSM, pThis->u8ScanSet);
1250 SSMR3PutU8(pSSM, pThis->enmTypematicState);
1251 SSMR3PutBool(pSSM, pThis->fNumLockOn);
1252 SSMR3PutBool(pSSM, pThis->fScanning);
1253
1254 /* Save the command and keystroke queues. */
1255 ps2kSaveQueue(pSSM, (GeneriQ *)&pThis->cmdQ);
1256 ps2kSaveQueue(pSSM, (GeneriQ *)&pThis->keyQ);
1257
1258 /* Save the command delay timer. Note that the typematic repeat
1259 * timer is *not* saved.
1260 */
1261 TMR3TimerSave(pThis->CTX_SUFF(pKbdDelayTimer), pSSM);
1262
1263 /* Save any pressed keys. This is necessary to avoid "stuck"
1264 * keys after a restore. Needs two passes.
1265 */
1266 for (unsigned i = 0; i < sizeof(pThis->abDepressedKeys); ++i)
1267 if (pThis->abDepressedKeys[i])
1268 ++cPressed;
1269
1270 SSMR3PutU32(pSSM, cPressed);
1271
1272 for (unsigned uKey = 0; uKey < sizeof(pThis->abDepressedKeys); ++uKey)
1273 if (pThis->abDepressedKeys[uKey])
1274 SSMR3PutU8(pSSM, uKey);
1275
1276 /* Save the typematic settings for Scan Set 3. */
1277 SSMR3PutU32(pSSM, cbTMSSize);
1278 /* Currently not implemented. */
1279}
1280
1281int PS2KLoadState(PPS2K pThis, PSSMHANDLE pSSM, uint32_t uVersion)
1282{
1283 uint8_t u8;
1284 uint32_t cPressed;
1285 uint32_t cbTMSSize;
1286 int rc;
1287
1288 NOREF(uVersion);
1289 LogFlowFunc(("Loading PS2K state version %u\n", uVersion));
1290
1291 /* Load the basic keyboard state. */
1292 SSMR3GetU8(pSSM, &pThis->u8CurrCmd);
1293 SSMR3GetU8(pSSM, &pThis->u8LEDs);
1294 SSMR3GetU8(pSSM, &pThis->u8Typematic);
1295 SSMR3GetU8(pSSM, &pThis->u8TypematicKey);
1296 SSMR3GetU8(pSSM, &pThis->u8Modifiers);
1297 SSMR3GetU8(pSSM, &pThis->u8ScanSet);
1298 SSMR3GetU8(pSSM, &u8);
1299 pThis->enmTypematicState = (tmatic_state_t)u8;
1300 SSMR3GetBool(pSSM, &pThis->fNumLockOn);
1301 SSMR3GetBool(pSSM, &pThis->fScanning);
1302
1303 /* Load the command and keystroke queues. */
1304 rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->cmdQ);
1305 AssertRCReturn(rc, rc);
1306 rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->keyQ);
1307 AssertRCReturn(rc, rc);
1308
1309 /* Load the command delay timer, just in case. */
1310 rc = TMR3TimerLoad(pThis->CTX_SUFF(pKbdDelayTimer), pSSM);
1311 AssertRCReturn(rc, rc);
1312
1313 /* Recalculate the typematic delay/rate. */
1314 ps2kSetupTypematic(pThis, pThis->u8Typematic);
1315
1316 /* Fake key up events for keys that were held down at the time the state was saved. */
1317 rc = SSMR3GetU32(pSSM, &cPressed);
1318 AssertRCReturn(rc, rc);
1319
1320 /* If any keys were down, load and then release them. */
1321 if (cPressed)
1322 {
1323 for (unsigned i = 0; i < cPressed; ++i)
1324 {
1325 rc = SSMR3GetU8(pSSM, &u8);
1326 AssertRCReturn(rc, rc);
1327 pThis->abDepressedKeys[u8] = 1;
1328 }
1329 }
1330
1331 /* Load typematic settings for Scan Set 3. */
1332 rc = SSMR3GetU32(pSSM, &cbTMSSize);
1333 AssertRCReturn(rc, rc);
1334
1335 while (cbTMSSize--)
1336 {
1337 rc = SSMR3GetU8(pSSM, &u8);
1338 AssertRCReturn(rc, rc);
1339 }
1340
1341 return rc;
1342}
1343
1344int PS2KLoadDone(PPS2K pThis, PSSMHANDLE pSSM)
1345{
1346 /* This *must* be done after the inital load because it may trigger
1347 * interrupts and change the interrupt controller state.
1348 */
1349 ps2kReleaseKeys(pThis);
1350 ps2kNotifyLedsState(pThis, pThis->u8LEDs);
1351 return VINF_SUCCESS;
1352}
1353
1354void PS2KReset(PPS2K pThis)
1355{
1356 LogFlowFunc(("Resetting PS2K\n"));
1357
1358 pThis->fScanning = true;
1359 pThis->u8ScanSet = 2;
1360 pThis->u8CurrCmd = 0;
1361 pThis->u8Modifiers = 0;
1362 pThis->u8TypematicKey = 0;
1363 pThis->enmTypematicState = KBD_TMS_IDLE;
1364
1365 /* Clear queues and any pressed keys. */
1366 memset(pThis->abDepressedKeys, 0, sizeof(pThis->abDepressedKeys));
1367 ps2kClearQueue((GeneriQ *)&pThis->cmdQ);
1368 ps2kSetDefaults(pThis); /* Also clears keystroke queue. */
1369
1370 /* Activate the PS/2 keyboard by default. */
1371 if (pThis->Keyboard.pDrv)
1372 pThis->Keyboard.pDrv->pfnSetActive(pThis->Keyboard.pDrv, true);
1373}
1374
1375void PS2KRelocate(PPS2K pThis, RTGCINTPTR offDelta, PPDMDEVINS pDevIns)
1376{
1377 LogFlowFunc(("Relocating PS2K\n"));
1378 pThis->pKbdDelayTimerRC = TMTimerRCPtr(pThis->pKbdDelayTimerR3);
1379 pThis->pKbdTypematicTimerRC = TMTimerRCPtr(pThis->pKbdTypematicTimerR3);
1380 NOREF(offDelta);
1381}
1382
1383int PS2KConstruct(PPS2K pThis, PPDMDEVINS pDevIns, void *pParent, int iInstance)
1384{
1385 int rc;
1386
1387 LogFlowFunc(("iInstance=%d\n", iInstance));
1388
1389 pThis->pParent = pParent;
1390
1391 /* Initialize the queues. */
1392 pThis->keyQ.cSize = KBD_KEY_QUEUE_SIZE;
1393 pThis->cmdQ.cSize = KBD_CMD_QUEUE_SIZE;
1394
1395 pThis->Keyboard.IBase.pfnQueryInterface = ps2kQueryInterface;
1396 pThis->Keyboard.IPort.pfnPutEventHid = ps2kPutEventWrapper;
1397
1398 /*
1399 * Initialize the critical section pointer(s).
1400 */
1401 pThis->pCritSectR3 = pDevIns->pCritSectRoR3;
1402
1403 /*
1404 * Create the typematic delay/repeat timer. Does not use virtual time!
1405 */
1406 PTMTIMER pTimer;
1407 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_REAL, ps2kTypematicTimer, pThis,
1408 TMTIMER_FLAGS_DEFAULT_CRIT_SECT, "PS2K Typematic Timer", &pTimer);
1409 if (RT_FAILURE(rc))
1410 return rc;
1411
1412 pThis->pKbdTypematicTimerR3 = pTimer;
1413 pThis->pKbdTypematicTimerR0 = TMTimerR0Ptr(pTimer);
1414 pThis->pKbdTypematicTimerRC = TMTimerRCPtr(pTimer);
1415
1416 /*
1417 * Create the command delay timer.
1418 */
1419 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, ps2kDelayTimer, pThis,
1420 TMTIMER_FLAGS_DEFAULT_CRIT_SECT, "PS2K Delay Timer", &pTimer);
1421 if (RT_FAILURE(rc))
1422 return rc;
1423
1424 pThis->pKbdDelayTimerR3 = pTimer;
1425 pThis->pKbdDelayTimerR0 = TMTimerR0Ptr(pTimer);
1426 pThis->pKbdDelayTimerRC = TMTimerRCPtr(pTimer);
1427
1428 /*
1429 * Register debugger info callbacks.
1430 */
1431 PDMDevHlpDBGFInfoRegister(pDevIns, "ps2k", "Display PS/2 keyboard state.", ps2kInfoState);
1432
1433 return rc;
1434}
1435
1436#endif
1437
1438///@todo The following should live with the KBC implementation.
1439
1440/* Table used by the keyboard controller to optionally translate the incoming
1441 * keyboard data. Note that the translation is designed for essentially taking
1442 * Scan Set 2 input and producing Scan Set 1 output, but can be turned on and
1443 * off regardless of what the keyboard is sending.
1444 */
1445static uint8_t aAT2PC[128] = {
1446 0xff,0x43,0x41,0x3f,0x3d,0x3b,0x3c,0x58,0x64,0x44,0x42,0x40,0x3e,0x0f,0x29,0x59,
1447 0x65,0x38,0x2a,0x70,0x1d,0x10,0x02,0x5a,0x66,0x71,0x2c,0x1f,0x1e,0x11,0x03,0x5b,
1448 0x67,0x2e,0x2d,0x20,0x12,0x05,0x04,0x5c,0x68,0x39,0x2f,0x21,0x14,0x13,0x06,0x5d,
1449 0x69,0x31,0x30,0x23,0x22,0x15,0x07,0x5e,0x6a,0x72,0x32,0x24,0x16,0x08,0x09,0x5f,
1450 0x6b,0x33,0x25,0x17,0x18,0x0b,0x0a,0x60,0x6c,0x34,0x35,0x26,0x27,0x19,0x0c,0x61,
1451 0x6d,0x73,0x28,0x74,0x1a,0x0d,0x62,0x6e,0x3a,0x36,0x1c,0x1b,0x75,0x2b,0x63,0x76,
1452 0x55,0x56,0x77,0x78,0x79,0x7a,0x0e,0x7b,0x7c,0x4f,0x7d,0x4b,0x47,0x7e,0x7f,0x6f,
1453 0x52,0x53,0x50,0x4c,0x4d,0x48,0x01,0x45,0x57,0x4e,0x51,0x4a,0x37,0x49,0x46,0x54
1454};
1455
1456/**
1457 * Convert an AT (Scan Set 2) scancode to PC (Scan Set 1).
1458 *
1459 * @param state Current state of the translator
1460 * (xlat_state_t).
1461 * @param scanIn Incoming scan code.
1462 * @param pScanOut Pointer to outgoing scan code. The
1463 * contents are only valid if returned
1464 * state is not XS_BREAK.
1465 *
1466 * @return xlat_state_t New state of the translator.
1467 */
1468int32_t XlateAT2PC(int32_t state, uint8_t scanIn, uint8_t *pScanOut)
1469{
1470 uint8_t scan_in;
1471 uint8_t scan_out;
1472
1473 Assert(pScanOut);
1474 Assert(state == XS_IDLE || state == XS_BREAK || state == XS_HIBIT);
1475
1476 /* Preprocess the scan code for a 128-entry translation table. */
1477 if (scanIn == 0x83) /* Check for F7 key. */
1478 scan_in = 0x02;
1479 else if (scanIn == 0x84) /* Check for SysRq key. */
1480 scan_in = 0x7f;
1481 else
1482 scan_in = scanIn;
1483
1484 /* Values 0x80 and above are passed through, except for 0xF0
1485 * which indicates a key release.
1486 */
1487 if (scan_in < 0x80)
1488 {
1489 scan_out = aAT2PC[scan_in];
1490 /* Turn into break code if required. */
1491 if (state == XS_BREAK || state == XS_HIBIT)
1492 scan_out |= 0x80;
1493
1494 state = XS_IDLE;
1495 }
1496 else
1497 {
1498 /* NB: F0 E0 10 will be translated to E0 E5 (high bit set on last byte)! */
1499 if (scan_in == 0xF0) /* Check for break code. */
1500 state = XS_BREAK;
1501 else if (state == XS_BREAK)
1502 state = XS_HIBIT; /* Remember the break bit. */
1503 scan_out = scan_in;
1504 }
1505 LogFlowFunc(("scan code %02X translated to %02X; new state is %d\n",
1506 scanIn, scan_out, state));
1507
1508 *pScanOut = scan_out;
1509 return state;
1510}
1511
1512#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette