]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Update for code security.
[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbKbDxe / KeyBoard.c
CommitLineData
ed838d0c 1/** @file\r
a7022cec 2 Helper functions for USB Keyboard Driver.\r
3\r
813acf3a 4Copyright (c) 2004 - 2008, Intel Corporation\r
ed838d0c 5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
ed838d0c 13**/\r
14\r
a7022cec 15#include "KeyBoard.h"\r
813acf3a 16\r
17//\r
b4e73a63 18// Default English keyboard layout\r
813acf3a 19// Format:<efi key>, <unicode without shift>, <unicode with shift>, <Modifier>, <AffectedAttribute>\r
20//\r
b4e73a63 21// According to Universal Serial Bus HID Usage Tables document ver 1.12,\r
22// a Boot Keyboard should support the keycode range from 0x0 to 0x65 and 0xE0 to 0xE7.\r
23// 0x0 to 0x3 are reserved for typical keyboard status or keyboard errors, so they are excluded.\r
24//\r
25UINT8 KeyboardLayoutTable[NUMBER_OF_VALID_USB_KEYCODE][5] = {\r
813acf3a 26 {EfiKeyC1, 'a', 'A', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x04\r
27 {EfiKeyB5, 'b', 'B', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x05\r
28 {EfiKeyB3, 'c', 'C', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x06\r
29 {EfiKeyC3, 'd', 'D', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x07\r
30 {EfiKeyD3, 'e', 'E', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x08\r
31 {EfiKeyC4, 'f', 'F', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x09\r
32 {EfiKeyC5, 'g', 'G', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0A\r
33 {EfiKeyC6, 'h', 'H', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0B\r
34 {EfiKeyD8, 'i', 'I', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0C\r
35 {EfiKeyC7, 'j', 'J', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0D\r
36 {EfiKeyC8, 'k', 'K', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0E\r
37 {EfiKeyC9, 'l', 'L', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0F\r
38 {EfiKeyB7, 'm', 'M', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x10\r
39 {EfiKeyB6, 'n', 'N', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x11\r
40 {EfiKeyD9, 'o', 'O', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x12\r
41 {EfiKeyD10, 'p', 'P', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x13\r
42 {EfiKeyD1, 'q', 'Q', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x14\r
43 {EfiKeyD4, 'r', 'R', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x15\r
44 {EfiKeyC2, 's', 'S', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x16\r
45 {EfiKeyD5, 't', 'T', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x17\r
46 {EfiKeyD7, 'u', 'U', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x18\r
47 {EfiKeyB4, 'v', 'V', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x19\r
48 {EfiKeyD2, 'w', 'W', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1A\r
49 {EfiKeyB2, 'x', 'X', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1B\r
50 {EfiKeyD6, 'y', 'Y', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1C\r
51 {EfiKeyB1, 'z', 'Z', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1D\r
52 {EfiKeyE1, '1', '!', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1E\r
53 {EfiKeyE2, '2', '@', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1F\r
54 {EfiKeyE3, '3', '#', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x20\r
55 {EfiKeyE4, '4', '$', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x21\r
56 {EfiKeyE5, '5', '%', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x22\r
57 {EfiKeyE6, '6', '^', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x23\r
58 {EfiKeyE7, '7', '&', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x24\r
59 {EfiKeyE8, '8', '*', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x25\r
60 {EfiKeyE9, '9', '(', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x26\r
61 {EfiKeyE10, '0', ')', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x27\r
62 {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x28 Enter\r
63 {EfiKeyEsc, 0x1b, 0x1b, EFI_NULL_MODIFIER, 0}, // 0x29 Esc\r
64 {EfiKeyBackSpace, 0x08, 0x08, EFI_NULL_MODIFIER, 0}, // 0x2A Backspace\r
65 {EfiKeyTab, 0x09, 0x09, EFI_NULL_MODIFIER, 0}, // 0x2B Tab\r
66 {EfiKeySpaceBar, ' ', ' ', EFI_NULL_MODIFIER, 0}, // 0x2C Spacebar\r
67 {EfiKeyE11, '-', '_', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2D\r
68 {EfiKeyE12, '=', '+', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2E\r
69 {EfiKeyD11, '[', '{', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2F\r
70 {EfiKeyD12, ']', '}', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x30\r
71 {EfiKeyD13, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x31\r
72 {EfiKeyC12, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x32 Keyboard Non-US # and ~\r
73 {EfiKeyC10, ';', ':', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x33\r
74 {EfiKeyC11, '\'', '"', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x34\r
75 {EfiKeyE0, '`', '~', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x35 Keyboard Grave Accent and Tlide\r
76 {EfiKeyB8, ',', '<', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x36\r
77 {EfiKeyB9, '.', '>', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x37\r
78 {EfiKeyB10, '/', '?', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x38\r
79 {EfiKeyCapsLock, 0x00, 0x00, EFI_CAPS_LOCK_MODIFIER, 0}, // 0x39 CapsLock\r
80 {EfiKeyF1, 0x00, 0x00, EFI_FUNCTION_KEY_ONE_MODIFIER, 0}, // 0x3A\r
81 {EfiKeyF2, 0x00, 0x00, EFI_FUNCTION_KEY_TWO_MODIFIER, 0}, // 0x3B\r
82 {EfiKeyF3, 0x00, 0x00, EFI_FUNCTION_KEY_THREE_MODIFIER, 0}, // 0x3C\r
83 {EfiKeyF4, 0x00, 0x00, EFI_FUNCTION_KEY_FOUR_MODIFIER, 0}, // 0x3D\r
84 {EfiKeyF5, 0x00, 0x00, EFI_FUNCTION_KEY_FIVE_MODIFIER, 0}, // 0x3E\r
85 {EfiKeyF6, 0x00, 0x00, EFI_FUNCTION_KEY_SIX_MODIFIER, 0}, // 0x3F\r
86 {EfiKeyF7, 0x00, 0x00, EFI_FUNCTION_KEY_SEVEN_MODIFIER, 0}, // 0x40\r
87 {EfiKeyF8, 0x00, 0x00, EFI_FUNCTION_KEY_EIGHT_MODIFIER, 0}, // 0x41\r
88 {EfiKeyF9, 0x00, 0x00, EFI_FUNCTION_KEY_NINE_MODIFIER, 0}, // 0x42\r
89 {EfiKeyF10, 0x00, 0x00, EFI_FUNCTION_KEY_TEN_MODIFIER, 0}, // 0x43\r
90 {EfiKeyF11, 0x00, 0x00, EFI_FUNCTION_KEY_ELEVEN_MODIFIER, 0}, // 0x44 F11\r
91 {EfiKeyF12, 0x00, 0x00, EFI_FUNCTION_KEY_TWELVE_MODIFIER, 0}, // 0x45 F12\r
92 {EfiKeyPrint, 0x00, 0x00, EFI_PRINT_MODIFIER, 0}, // 0x46 PrintScreen\r
93 {EfiKeySLck, 0x00, 0x00, EFI_SCROLL_LOCK_MODIFIER, 0}, // 0x47 Scroll Lock\r
94 {EfiKeyPause, 0x00, 0x00, EFI_PAUSE_MODIFIER, 0}, // 0x48 Pause\r
95 {EfiKeyIns, 0x00, 0x00, EFI_INSERT_MODIFIER, 0}, // 0x49\r
96 {EfiKeyHome, 0x00, 0x00, EFI_HOME_MODIFIER, 0}, // 0x4A\r
97 {EfiKeyPgUp, 0x00, 0x00, EFI_PAGE_UP_MODIFIER, 0}, // 0x4B\r
98 {EfiKeyDel, 0x00, 0x00, EFI_DELETE_MODIFIER, 0}, // 0x4C\r
99 {EfiKeyEnd, 0x00, 0x00, EFI_END_MODIFIER, 0}, // 0x4D\r
100 {EfiKeyPgDn, 0x00, 0x00, EFI_PAGE_DOWN_MODIFIER, 0}, // 0x4E\r
101 {EfiKeyRightArrow, 0x00, 0x00, EFI_RIGHT_ARROW_MODIFIER, 0}, // 0x4F\r
102 {EfiKeyLeftArrow, 0x00, 0x00, EFI_LEFT_ARROW_MODIFIER, 0}, // 0x50\r
103 {EfiKeyDownArrow, 0x00, 0x00, EFI_DOWN_ARROW_MODIFIER, 0}, // 0x51\r
104 {EfiKeyUpArrow, 0x00, 0x00, EFI_UP_ARROW_MODIFIER, 0}, // 0x52\r
105 {EfiKeyNLck, 0x00, 0x00, EFI_NUM_LOCK_MODIFIER, 0}, // 0x53 NumLock\r
106 {EfiKeySlash, '/', '/', EFI_NULL_MODIFIER, 0}, // 0x54\r
107 {EfiKeyAsterisk, '*', '*', EFI_NULL_MODIFIER, 0}, // 0x55\r
108 {EfiKeyMinus, '-', '-', EFI_NULL_MODIFIER, 0}, // 0x56\r
109 {EfiKeyPlus, '+', '+', EFI_NULL_MODIFIER, 0}, // 0x57\r
110 {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x58\r
111 {EfiKeyOne, '1', '1', EFI_END_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x59\r
112 {EfiKeyTwo, '2', '2', EFI_DOWN_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5A\r
113 {EfiKeyThree, '3', '3', EFI_PAGE_DOWN_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5B\r
114 {EfiKeyFour, '4', '4', EFI_LEFT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5C\r
115 {EfiKeyFive, '5', '5', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5D\r
116 {EfiKeySix, '6', '6', EFI_RIGHT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5E\r
117 {EfiKeySeven, '7', '7', EFI_HOME_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5F\r
118 {EfiKeyEight, '8', '8', EFI_UP_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x60\r
119 {EfiKeyNine, '9', '9', EFI_PAGE_UP_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x61\r
120 {EfiKeyZero, '0', '0', EFI_INSERT_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x62\r
121 {EfiKeyPeriod, '.', '.', EFI_DELETE_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x63\r
122 {EfiKeyB0, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x64 Keyboard Non-US \ and |\r
a77267d2 123 {EfiKeyA4, 0x00, 0x00, EFI_MENU_MODIFIER, 0}, // 0x65 Keyboard Application\r
813acf3a 124\r
125 {EfiKeyLCtrl, 0, 0, EFI_LEFT_CONTROL_MODIFIER, 0}, // 0xe0\r
126 {EfiKeyLShift, 0, 0, EFI_LEFT_SHIFT_MODIFIER, 0}, // 0xe1\r
127 {EfiKeyLAlt, 0, 0, EFI_LEFT_ALT_MODIFIER, 0}, // 0xe2\r
a77267d2 128 {EfiKeyA0, 0, 0, EFI_LEFT_LOGO_MODIFIER, 0}, // 0xe3\r
813acf3a 129 {EfiKeyRCtrl, 0, 0, EFI_RIGHT_CONTROL_MODIFIER, 0}, // 0xe4\r
130 {EfiKeyRShift, 0, 0, EFI_RIGHT_SHIFT_MODIFIER, 0}, // 0xe5\r
131 {EfiKeyA2, 0, 0, EFI_RIGHT_ALT_MODIFIER, 0}, // 0xe6\r
a77267d2 132 {EfiKeyA3, 0, 0, EFI_RIGHT_LOGO_MODIFIER, 0}, // 0xe7\r
813acf3a 133};\r
134\r
813acf3a 135//\r
b4e73a63 136// EFI_KEY to USB Keycode convertion table\r
137// EFI_KEY is defined in UEFI spec.\r
138// USB Keycode is defined in USB HID Firmware spec.\r
813acf3a 139//\r
b4e73a63 140UINT8 EfiKeyToUsbKeyCodeConvertionTable[] = {\r
813acf3a 141 0xe0, // EfiKeyLCtrl\r
142 0xe3, // EfiKeyA0\r
143 0xe2, // EfiKeyLAlt\r
144 0x2c, // EfiKeySpaceBar\r
145 0xe6, // EfiKeyA2\r
146 0xe7, // EfiKeyA3\r
147 0x65, // EfiKeyA4\r
148 0xe4, // EfiKeyRCtrl\r
149 0x50, // EfiKeyLeftArrow\r
150 0x51, // EfiKeyDownArrow\r
151 0x4F, // EfiKeyRightArrow\r
152 0x62, // EfiKeyZero\r
153 0x63, // EfiKeyPeriod\r
154 0x28, // EfiKeyEnter\r
155 0xe1, // EfiKeyLShift\r
156 0x64, // EfiKeyB0\r
157 0x1D, // EfiKeyB1\r
158 0x1B, // EfiKeyB2\r
159 0x06, // EfiKeyB3\r
160 0x19, // EfiKeyB4\r
161 0x05, // EfiKeyB5\r
162 0x11, // EfiKeyB6\r
163 0x10, // EfiKeyB7\r
164 0x36, // EfiKeyB8\r
165 0x37, // EfiKeyB9\r
166 0x38, // EfiKeyB10\r
167 0xe5, // EfiKeyRShift\r
168 0x52, // EfiKeyUpArrow\r
169 0x59, // EfiKeyOne\r
170 0x5A, // EfiKeyTwo\r
171 0x5B, // EfiKeyThree\r
172 0x39, // EfiKeyCapsLock\r
173 0x04, // EfiKeyC1\r
174 0x16, // EfiKeyC2\r
175 0x07, // EfiKeyC3\r
176 0x09, // EfiKeyC4\r
177 0x0A, // EfiKeyC5\r
178 0x0B, // EfiKeyC6\r
179 0x0D, // EfiKeyC7\r
180 0x0E, // EfiKeyC8\r
181 0x0F, // EfiKeyC9\r
182 0x33, // EfiKeyC10\r
183 0x34, // EfiKeyC11\r
184 0x32, // EfiKeyC12\r
185 0x5C, // EfiKeyFour\r
186 0x5D, // EfiKeyFive\r
187 0x5E, // EfiKeySix\r
188 0x57, // EfiKeyPlus\r
189 0x2B, // EfiKeyTab\r
190 0x14, // EfiKeyD1\r
191 0x1A, // EfiKeyD2\r
192 0x08, // EfiKeyD3\r
193 0x15, // EfiKeyD4\r
194 0x17, // EfiKeyD5\r
195 0x1C, // EfiKeyD6\r
196 0x18, // EfiKeyD7\r
197 0x0C, // EfiKeyD8\r
198 0x12, // EfiKeyD9\r
199 0x13, // EfiKeyD10\r
200 0x2F, // EfiKeyD11\r
201 0x30, // EfiKeyD12\r
202 0x31, // EfiKeyD13\r
203 0x4C, // EfiKeyDel\r
204 0x4D, // EfiKeyEnd\r
205 0x4E, // EfiKeyPgDn\r
206 0x5F, // EfiKeySeven\r
207 0x60, // EfiKeyEight\r
208 0x61, // EfiKeyNine\r
209 0x35, // EfiKeyE0\r
210 0x1E, // EfiKeyE1\r
211 0x1F, // EfiKeyE2\r
212 0x20, // EfiKeyE3\r
213 0x21, // EfiKeyE4\r
214 0x22, // EfiKeyE5\r
215 0x23, // EfiKeyE6\r
216 0x24, // EfiKeyE7\r
217 0x25, // EfiKeyE8\r
218 0x26, // EfiKeyE9\r
219 0x27, // EfiKeyE10\r
220 0x2D, // EfiKeyE11\r
221 0x2E, // EfiKeyE12\r
222 0x2A, // EfiKeyBackSpace\r
223 0x49, // EfiKeyIns\r
224 0x4A, // EfiKeyHome\r
225 0x4B, // EfiKeyPgUp\r
226 0x53, // EfiKeyNLck\r
227 0x54, // EfiKeySlash\r
228 0x55, // EfiKeyAsterisk\r
229 0x56, // EfiKeyMinus\r
230 0x29, // EfiKeyEsc\r
231 0x3A, // EfiKeyF1\r
232 0x3B, // EfiKeyF2\r
233 0x3C, // EfiKeyF3\r
234 0x3D, // EfiKeyF4\r
235 0x3E, // EfiKeyF5\r
236 0x3F, // EfiKeyF6\r
237 0x40, // EfiKeyF7\r
238 0x41, // EfiKeyF8\r
239 0x42, // EfiKeyF9\r
240 0x43, // EfiKeyF10\r
241 0x44, // EfiKeyF11\r
242 0x45, // EfiKeyF12\r
243 0x46, // EfiKeyPrint\r
244 0x47, // EfiKeySLck\r
245 0x48 // EfiKeyPause\r
246};\r
247\r
ed838d0c 248//\r
b4e73a63 249// Keyboard modifier value to EFI Scan Code convertion table\r
250// EFI Scan Code and the modifier values are defined in UEFI spec.\r
ed838d0c 251//\r
b4e73a63 252UINT8 ModifierValueToEfiScanCodeConvertionTable[] = {\r
813acf3a 253 SCAN_NULL, // EFI_NULL_MODIFIER\r
254 SCAN_NULL, // EFI_LEFT_CONTROL_MODIFIER\r
255 SCAN_NULL, // EFI_RIGHT_CONTROL_MODIFIER\r
256 SCAN_NULL, // EFI_LEFT_ALT_MODIFIER\r
257 SCAN_NULL, // EFI_RIGHT_ALT_MODIFIER\r
258 SCAN_NULL, // EFI_ALT_GR_MODIFIER\r
259 SCAN_INSERT, // EFI_INSERT_MODIFIER\r
260 SCAN_DELETE, // EFI_DELETE_MODIFIER\r
261 SCAN_PAGE_DOWN, // EFI_PAGE_DOWN_MODIFIER\r
262 SCAN_PAGE_UP, // EFI_PAGE_UP_MODIFIER\r
263 SCAN_HOME, // EFI_HOME_MODIFIER\r
264 SCAN_END, // EFI_END_MODIFIER\r
265 SCAN_NULL, // EFI_LEFT_SHIFT_MODIFIER\r
266 SCAN_NULL, // EFI_RIGHT_SHIFT_MODIFIER\r
267 SCAN_NULL, // EFI_CAPS_LOCK_MODIFIER\r
268 SCAN_NULL, // EFI_NUM_LOCK_MODIFIER\r
269 SCAN_LEFT, // EFI_LEFT_ARROW_MODIFIER\r
270 SCAN_RIGHT, // EFI_RIGHT_ARROW_MODIFIER\r
271 SCAN_DOWN, // EFI_DOWN_ARROW_MODIFIER\r
272 SCAN_UP, // EFI_UP_ARROW_MODIFIER\r
273 SCAN_NULL, // EFI_NS_KEY_MODIFIER\r
274 SCAN_NULL, // EFI_NS_KEY_DEPENDENCY_MODIFIER\r
275 SCAN_F1, // EFI_FUNCTION_KEY_ONE_MODIFIER\r
276 SCAN_F2, // EFI_FUNCTION_KEY_TWO_MODIFIER\r
277 SCAN_F3, // EFI_FUNCTION_KEY_THREE_MODIFIER\r
278 SCAN_F4, // EFI_FUNCTION_KEY_FOUR_MODIFIER\r
279 SCAN_F5, // EFI_FUNCTION_KEY_FIVE_MODIFIER\r
280 SCAN_F6, // EFI_FUNCTION_KEY_SIX_MODIFIER\r
281 SCAN_F7, // EFI_FUNCTION_KEY_SEVEN_MODIFIER\r
282 SCAN_F8, // EFI_FUNCTION_KEY_EIGHT_MODIFIER\r
283 SCAN_F9, // EFI_FUNCTION_KEY_NINE_MODIFIER\r
284 SCAN_F10, // EFI_FUNCTION_KEY_TEN_MODIFIER\r
285 SCAN_F11, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER\r
286 SCAN_F12, // EFI_FUNCTION_KEY_TWELVE_MODIFIER\r
ed838d0c 287};\r
288\r
813acf3a 289EFI_GUID mKeyboardLayoutEventGuid = EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID;\r
290\r
aa79b0b3 291/**\r
b4e73a63 292 Initialize Key Convertion Table by using default keyboard layout.\r
aa79b0b3 293\r
294 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
aa79b0b3 295\r
296**/\r
297VOID\r
298EFIAPI\r
299LoadDefaultKeyboardLayout (\r
b4e73a63 300 IN OUT USB_KB_DEV *UsbKeyboardDevice\r
aa79b0b3 301 )\r
302{\r
303 UINTN Index;\r
304 EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
305\r
306 //\r
307 // Construct KeyConvertionTable by default keyboard layout\r
308 //\r
309 KeyDescriptor = &UsbKeyboardDevice->KeyConvertionTable[0];\r
310\r
b4e73a63 311 for (Index = 0; Index < (NUMBER_OF_VALID_USB_KEYCODE); Index++) {\r
aa79b0b3 312 KeyDescriptor->Key = (EFI_KEY) KeyboardLayoutTable[Index][0];\r
313 KeyDescriptor->Unicode = KeyboardLayoutTable[Index][1];\r
314 KeyDescriptor->ShiftedUnicode = KeyboardLayoutTable[Index][2];\r
315 KeyDescriptor->AltGrUnicode = 0;\r
316 KeyDescriptor->ShiftedAltGrUnicode = 0;\r
317 KeyDescriptor->Modifier = KeyboardLayoutTable[Index][3];\r
318 KeyDescriptor->AffectedAttribute = KeyboardLayoutTable[Index][4];\r
319\r
320 KeyDescriptor++;\r
321 }\r
322}\r
323\r
ed838d0c 324/**\r
b4e73a63 325 Uses USB I/O to check whether the device is a USB keyboard device.\r
326\r
327 @param UsbIo Pointer to a USB I/O protocol instance.\r
ed838d0c 328\r
b4e73a63 329 @retval TRUE Device is a USB keyboard device.\r
330 @retval FALSE Device is a not USB keyboard device.\r
ed838d0c 331\r
332**/\r
333BOOLEAN\r
a7022cec 334EFIAPI\r
ed838d0c 335IsUSBKeyboard (\r
336 IN EFI_USB_IO_PROTOCOL *UsbIo\r
337 )\r
338{\r
339 EFI_STATUS Status;\r
340 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
341\r
342 //\r
b4e73a63 343 // Get the default interface descriptor\r
ed838d0c 344 //\r
345 Status = UsbIo->UsbGetInterfaceDescriptor (\r
346 UsbIo,\r
347 &InterfaceDescriptor\r
348 );\r
349\r
350 if (EFI_ERROR (Status)) {\r
351 return FALSE;\r
352 }\r
353\r
354 if (InterfaceDescriptor.InterfaceClass == CLASS_HID &&\r
355 InterfaceDescriptor.InterfaceSubClass == SUBCLASS_BOOT &&\r
356 InterfaceDescriptor.InterfaceProtocol == PROTOCOL_KEYBOARD\r
357 ) {\r
ed838d0c 358 return TRUE;\r
359 }\r
360\r
361 return FALSE;\r
362}\r
363\r
a7022cec 364/**\r
365 Get current keyboard layout from HII database.\r
366\r
b4e73a63 367 @return Pointer to HII Keyboard Layout.\r
368 NULL means failure occurred while trying to get keyboard layout.\r
ed838d0c 369\r
a7022cec 370**/\r
813acf3a 371EFI_HII_KEYBOARD_LAYOUT *\r
a7022cec 372EFIAPI\r
813acf3a 373GetCurrentKeyboardLayout (\r
374 VOID\r
375 )\r
813acf3a 376{\r
377 EFI_STATUS Status;\r
378 EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
379 EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
380 UINT16 Length;\r
381\r
382 //\r
b4e73a63 383 // Locate HII Database Protocol\r
813acf3a 384 //\r
385 Status = gBS->LocateProtocol (\r
386 &gEfiHiiDatabaseProtocolGuid,\r
387 NULL,\r
388 (VOID **) &HiiDatabase\r
389 );\r
390 if (EFI_ERROR (Status)) {\r
391 return NULL;\r
392 }\r
393\r
394 //\r
395 // Get current keyboard layout from HII database\r
396 //\r
397 Length = 0;\r
398 KeyboardLayout = NULL;\r
399 Status = HiiDatabase->GetKeyboardLayout (\r
400 HiiDatabase,\r
401 NULL,\r
402 &Length,\r
403 KeyboardLayout\r
404 );\r
405 if (Status == EFI_BUFFER_TOO_SMALL) {\r
406 KeyboardLayout = AllocatePool (Length);\r
407 ASSERT (KeyboardLayout != NULL);\r
408\r
409 Status = HiiDatabase->GetKeyboardLayout (\r
410 HiiDatabase,\r
411 NULL,\r
412 &Length,\r
413 KeyboardLayout\r
414 );\r
415 if (EFI_ERROR (Status)) {\r
416 gBS->FreePool (KeyboardLayout);\r
417 KeyboardLayout = NULL;\r
418 }\r
419 }\r
420\r
421 return KeyboardLayout;\r
422}\r
423\r
a7022cec 424/**\r
b4e73a63 425 Find Key Descriptor in Key Convertion Table given its USB keycode.\r
a7022cec 426\r
427 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
b4e73a63 428 @param KeyCode USB Keycode.\r
a7022cec 429\r
b4e73a63 430 @return The Key Descriptor in Key Convertion Table.\r
5899f27e 431 NULL means not found.\r
a7022cec 432\r
433**/\r
813acf3a 434EFI_KEY_DESCRIPTOR *\r
a7022cec 435EFIAPI\r
813acf3a 436GetKeyDescriptor (\r
437 IN USB_KB_DEV *UsbKeyboardDevice,\r
b4e73a63 438 IN UINT8 KeyCode\r
813acf3a 439 )\r
813acf3a 440{\r
441 UINT8 Index;\r
442\r
b4e73a63 443 //\r
444 // Make sure KeyCode is in the range of [0x4, 0x65] or [0xe0, 0xe7]\r
445 //\r
446 if ((!USBKBD_VALID_KEYCODE (KeyCode)) || ((KeyCode > 0x65) && (KeyCode < 0xe0)) || (KeyCode > 0xe7)) {\r
813acf3a 447 return NULL;\r
448 }\r
449\r
b4e73a63 450 //\r
451 // Calculate the index of Key Descriptor in Key Convertion Table\r
452 //\r
453 if (KeyCode <= 0x65) {\r
454 Index = (UINT8) (KeyCode - 4);\r
813acf3a 455 } else {\r
b4e73a63 456 Index = (UINT8) (KeyCode - 0xe0 + NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE);\r
813acf3a 457 }\r
458\r
459 return &UsbKeyboardDevice->KeyConvertionTable[Index];\r
460}\r
461\r
a7022cec 462/**\r
b4e73a63 463 Find Non-Spacing key for given Key descriptor.\r
a7022cec 464\r
465 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
466 @param KeyDescriptor Key descriptor.\r
467\r
5899f27e 468 @return The Non-Spacing key corresponding to KeyDescriptor\r
469 NULL means not found.\r
a7022cec 470\r
471**/\r
813acf3a 472USB_NS_KEY *\r
a7022cec 473EFIAPI\r
813acf3a 474FindUsbNsKey (\r
475 IN USB_KB_DEV *UsbKeyboardDevice,\r
476 IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
477 )\r
813acf3a 478{\r
479 LIST_ENTRY *Link;\r
e15c65a3 480 LIST_ENTRY *NsKeyList;\r
813acf3a 481 USB_NS_KEY *UsbNsKey;\r
e15c65a3 482 \r
483 NsKeyList = &UsbKeyboardDevice->NsKeyList;\r
484 Link = GetFirstNode (NsKeyList);\r
485 while (!IsNull (NsKeyList, Link)) {\r
813acf3a 486 UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
487\r
488 if (UsbNsKey->NsKey[0].Key == KeyDescriptor->Key) {\r
489 return UsbNsKey;\r
490 }\r
491\r
e15c65a3 492 Link = GetNextNode (NsKeyList, Link);\r
813acf3a 493 }\r
494\r
495 return NULL;\r
496}\r
497\r
a7022cec 498/**\r
b4e73a63 499 Find physical key definition for a given key descriptor.\r
500\r
501 For a specified non-spacing key, there are a list of physical\r
502 keys following it. This function traverses the list of\r
503 physical keys and tries to find the physical key matching\r
504 the KeyDescriptor.\r
a7022cec 505\r
b4e73a63 506 @param UsbNsKey The non-spacing key information.\r
507 @param KeyDescriptor The key descriptor.\r
a7022cec 508\r
509 @return The physical key definition.\r
b4e73a63 510 If no physical key is found, parameter KeyDescriptor is returned.\r
a7022cec 511\r
512**/\r
813acf3a 513EFI_KEY_DESCRIPTOR *\r
a7022cec 514EFIAPI\r
813acf3a 515FindPhysicalKey (\r
516 IN USB_NS_KEY *UsbNsKey,\r
517 IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
518 )\r
813acf3a 519{\r
520 UINTN Index;\r
521 EFI_KEY_DESCRIPTOR *PhysicalKey;\r
522\r
523 PhysicalKey = &UsbNsKey->NsKey[1];\r
524 for (Index = 0; Index < UsbNsKey->KeyCount; Index++) {\r
525 if (KeyDescriptor->Key == PhysicalKey->Key) {\r
526 return PhysicalKey;\r
527 }\r
528\r
529 PhysicalKey++;\r
530 }\r
531\r
532 //\r
533 // No children definition matched, return original key\r
534 //\r
535 return KeyDescriptor;\r
536}\r
537\r
a7022cec 538/**\r
b4e73a63 539 The notification function for EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID.\r
a7022cec 540\r
b4e73a63 541 This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID\r
542 group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().\r
543 It tries to get curent keyboard layout from HII database.\r
544\r
545 @param Event Event being signaled.\r
546 @param Context Points to USB_KB_DEV instance.\r
a7022cec 547\r
548**/\r
813acf3a 549VOID\r
550EFIAPI\r
551SetKeyboardLayoutEvent (\r
b4e73a63 552 IN EFI_EVENT Event,\r
553 IN VOID *Context\r
813acf3a 554 )\r
813acf3a 555{\r
556 USB_KB_DEV *UsbKeyboardDevice;\r
557 EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
558 EFI_KEY_DESCRIPTOR TempKey;\r
559 EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
560 EFI_KEY_DESCRIPTOR *TableEntry;\r
561 EFI_KEY_DESCRIPTOR *NsKey;\r
562 USB_NS_KEY *UsbNsKey;\r
563 UINTN Index;\r
564 UINTN Index2;\r
565 UINTN KeyCount;\r
b4e73a63 566 UINT8 KeyCode;\r
813acf3a 567\r
568 UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
569\r
570 //\r
b4e73a63 571 // Try to get current keyboard layout from HII database\r
813acf3a 572 //\r
573 KeyboardLayout = GetCurrentKeyboardLayout ();\r
574 if (KeyboardLayout == NULL) {\r
575 return;\r
576 }\r
577\r
578 //\r
5899f27e 579 // Re-allocate resource for KeyConvertionTable\r
813acf3a 580 //\r
581 ReleaseKeyboardLayoutResources (UsbKeyboardDevice);\r
b4e73a63 582 UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE) * sizeof (EFI_KEY_DESCRIPTOR));\r
813acf3a 583 ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
584\r
5899f27e 585 //\r
586 // Traverse the list of key descriptors following the header of EFI_HII_KEYBOARD_LAYOUT\r
587 //\r
813acf3a 588 KeyDescriptor = (EFI_KEY_DESCRIPTOR *) (((UINT8 *) KeyboardLayout) + sizeof (EFI_HII_KEYBOARD_LAYOUT));\r
589 for (Index = 0; Index < KeyboardLayout->DescriptorCount; Index++) {\r
590 //\r
591 // Copy from HII keyboard layout package binary for alignment\r
592 //\r
593 CopyMem (&TempKey, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
594\r
595 //\r
b4e73a63 596 // Fill the key into KeyConvertionTable, whose index is calculated from USB keycode.\r
813acf3a 597 //\r
b4e73a63 598 KeyCode = EfiKeyToUsbKeyCodeConvertionTable [(UINT8) (TempKey.Key)];\r
599 TableEntry = GetKeyDescriptor (UsbKeyboardDevice, KeyCode);\r
813acf3a 600 CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
601\r
b4e73a63 602 //\r
603 // For non-spacing key, create the list with a non-spacing key followed by physical keys.\r
604 //\r
813acf3a 605 if (TempKey.Modifier == EFI_NS_KEY_MODIFIER) {\r
813acf3a 606 UsbNsKey = AllocatePool (sizeof (USB_NS_KEY));\r
607 ASSERT (UsbNsKey != NULL);\r
608\r
609 //\r
610 // Search for sequential children physical key definitions\r
611 //\r
612 KeyCount = 0;\r
613 NsKey = KeyDescriptor + 1;\r
614 for (Index2 = Index + 1; Index2 < KeyboardLayout->DescriptorCount; Index2++) {\r
615 CopyMem (&TempKey, NsKey, sizeof (EFI_KEY_DESCRIPTOR));\r
616 if (TempKey.Modifier & EFI_NS_KEY_DEPENDENCY_MODIFIER) {\r
617 KeyCount++;\r
618 } else {\r
619 break;\r
620 }\r
621 NsKey++;\r
622 }\r
623\r
624 UsbNsKey->Signature = USB_NS_KEY_SIGNATURE;\r
625 UsbNsKey->KeyCount = KeyCount;\r
626 UsbNsKey->NsKey = AllocateCopyPool (\r
627 (KeyCount + 1) * sizeof (EFI_KEY_DESCRIPTOR),\r
628 KeyDescriptor\r
629 );\r
630 InsertTailList (&UsbKeyboardDevice->NsKeyList, &UsbNsKey->Link);\r
631\r
632 //\r
633 // Skip over the child physical keys\r
634 //\r
635 Index += KeyCount;\r
636 KeyDescriptor += KeyCount;\r
637 }\r
638\r
639 KeyDescriptor++;\r
640 }\r
641\r
642 //\r
b4e73a63 643 // There are two EfiKeyEnter, duplicate its key descriptor\r
813acf3a 644 //\r
645 TableEntry = GetKeyDescriptor (UsbKeyboardDevice, 0x58);\r
646 KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, 0x28);\r
647 CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
648\r
e15c65a3 649 FreePool (KeyboardLayout);\r
813acf3a 650}\r
651\r
a7022cec 652/**\r
b4e73a63 653 Destroy resources for keyboard layout.\r
a7022cec 654\r
655 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
656\r
657**/\r
813acf3a 658VOID\r
a7022cec 659EFIAPI\r
813acf3a 660ReleaseKeyboardLayoutResources (\r
b4e73a63 661 IN OUT USB_KB_DEV *UsbKeyboardDevice\r
813acf3a 662 )\r
813acf3a 663{\r
664 USB_NS_KEY *UsbNsKey;\r
665 LIST_ENTRY *Link;\r
666\r
676df92c 667 if (UsbKeyboardDevice->KeyConvertionTable != NULL) {\r
668 FreePool (UsbKeyboardDevice->KeyConvertionTable);\r
669 }\r
813acf3a 670 UsbKeyboardDevice->KeyConvertionTable = NULL;\r
671\r
672 while (!IsListEmpty (&UsbKeyboardDevice->NsKeyList)) {\r
673 Link = GetFirstNode (&UsbKeyboardDevice->NsKeyList);\r
674 UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
675 RemoveEntryList (&UsbNsKey->Link);\r
676\r
676df92c 677 FreePool (UsbNsKey->NsKey);\r
678 FreePool (UsbNsKey);\r
813acf3a 679 }\r
680}\r
681\r
a7022cec 682/**\r
b4e73a63 683 Initialize USB keyboard layout.\r
684\r
685 This function initializes Key Convertion Table for the USB keyboard device.\r
686 It first tries to retrieve layout from HII database. If failed and default\r
687 layout is enabled, then it just uses the default layout.\r
a7022cec 688\r
689 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
690\r
b4e73a63 691 @retval EFI_SUCCESS Initialization succeeded.\r
692 @retval EFI_NOT_READY Keyboard layout cannot be retrieve from HII\r
693 database, and default layout is disabled.\r
694 @retval Other Fail to register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group.\r
a7022cec 695\r
696**/\r
813acf3a 697EFI_STATUS\r
a7022cec 698EFIAPI\r
813acf3a 699InitKeyboardLayout (\r
b4e73a63 700 OUT USB_KB_DEV *UsbKeyboardDevice\r
813acf3a 701 )\r
813acf3a 702{\r
703 EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
704 EFI_STATUS Status;\r
705\r
b4e73a63 706 UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE) * sizeof (EFI_KEY_DESCRIPTOR));\r
813acf3a 707 ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
708\r
709 InitializeListHead (&UsbKeyboardDevice->NsKeyList);\r
710 UsbKeyboardDevice->CurrentNsKey = NULL;\r
711 UsbKeyboardDevice->KeyboardLayoutEvent = NULL;\r
712\r
713 //\r
5899f27e 714 // Register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,\r
b4e73a63 715 // which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().\r
813acf3a 716 //\r
717 Status = gBS->CreateEventEx (\r
e53a6ea9 718 EVT_NOTIFY_SIGNAL,\r
813acf3a 719 TPL_NOTIFY,\r
720 SetKeyboardLayoutEvent,\r
721 UsbKeyboardDevice,\r
722 &mKeyboardLayoutEventGuid,\r
723 &UsbKeyboardDevice->KeyboardLayoutEvent\r
724 );\r
725 if (EFI_ERROR (Status)) {\r
726 return Status;\r
727 }\r
728\r
813acf3a 729 KeyboardLayout = GetCurrentKeyboardLayout ();\r
730 if (KeyboardLayout != NULL) {\r
731 //\r
5899f27e 732 // If current keyboard layout is successfully retrieved from HII database,\r
733 // force to initialize the keyboard layout.\r
813acf3a 734 //\r
735 gBS->SignalEvent (UsbKeyboardDevice->KeyboardLayoutEvent);\r
736 } else {\r
737 if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver)) {\r
813acf3a 738 //\r
5899f27e 739 // If no keyboard layout can be retrieved from HII database, and default layout\r
740 // is disabled, then return EFI_NOT_READY.\r
813acf3a 741 //\r
5899f27e 742 return EFI_NOT_READY;\r
813acf3a 743 }\r
5899f27e 744 //\r
745 // If no keyboard layout can be retrieved from HII database, and default layout\r
746 // is enabled, then load the default keyboard layout.\r
747 //\r
748 LoadDefaultKeyboardLayout (UsbKeyboardDevice);\r
813acf3a 749 }\r
750 \r
751 return EFI_SUCCESS;\r
752}\r
753\r
ed838d0c 754\r
755/**\r
b4e73a63 756 Initialize USB keyboard device and all private data structures.\r
ed838d0c 757\r
a7022cec 758 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
ed838d0c 759\r
a7022cec 760 @retval EFI_SUCCESS Initialization is successful.\r
b4e73a63 761 @retval EFI_DEVICE_ERROR Keyboard initialization failed.\r
ed838d0c 762\r
763**/\r
764EFI_STATUS\r
a7022cec 765EFIAPI\r
ed838d0c 766InitUSBKeyboard (\r
b4e73a63 767 IN OUT USB_KB_DEV *UsbKeyboardDevice\r
ed838d0c 768 )\r
769{\r
770 UINT8 ConfigValue;\r
771 UINT8 Protocol;\r
772 UINT8 ReportId;\r
773 UINT8 Duration;\r
774 EFI_STATUS Status;\r
775 UINT32 TransferResult;\r
ed838d0c 776\r
5899f27e 777 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
ed838d0c 778 EFI_PROGRESS_CODE,\r
5899f27e 779 PcdGet32 (PcdStatusCodeValueKeyboardSelfTest),\r
780 UsbKeyboardDevice->DevicePath\r
ed838d0c 781 );\r
782\r
783 InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
784\r
785 //\r
b4e73a63 786 // Uses default configuration to configure the USB keyboard device.\r
ed838d0c 787 //\r
788 ConfigValue = 0x01;\r
ed838d0c 789 Status = UsbSetConfiguration (\r
5899f27e 790 UsbKeyboardDevice->UsbIo,\r
791 (UINT16) ConfigValue,\r
792 &TransferResult\r
793 );\r
ed838d0c 794 if (EFI_ERROR (Status)) {\r
795 //\r
796 // If configuration could not be set here, it means\r
797 // the keyboard interface has some errors and could\r
798 // not be initialized\r
799 //\r
5899f27e 800 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
ed838d0c 801 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
5899f27e 802 PcdGet32 (PcdStatusCodeValueKeyboardInterfaceError),\r
803 UsbKeyboardDevice->DevicePath\r
ed838d0c 804 );\r
805\r
806 return EFI_DEVICE_ERROR;\r
807 }\r
808\r
809 UsbGetProtocolRequest (\r
810 UsbKeyboardDevice->UsbIo,\r
811 UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
812 &Protocol\r
813 );\r
814 //\r
5899f27e 815 // Set boot protocol for the USB Keyboard.\r
ed838d0c 816 // This driver only supports boot protocol.\r
5899f27e 817 // The device that does not support boot protocol is not supported.\r
ed838d0c 818 //\r
819 if (Protocol != BOOT_PROTOCOL) {\r
820 UsbSetProtocolRequest (\r
821 UsbKeyboardDevice->UsbIo,\r
822 UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
823 BOOT_PROTOCOL\r
824 );\r
825 }\r
ed838d0c 826\r
827 //\r
5899f27e 828 // ReportId is zero, which means the idle rate applies to all input reports.\r
ed838d0c 829 //\r
830 ReportId = 0;\r
831 //\r
b4e73a63 832 // Duration is zero, which means the duration is infinite.\r
5899f27e 833 // so the endpoint will inhibit reporting forever,\r
834 // and only reporting when a change is detected in the report data.\r
ed838d0c 835 //\r
836 Duration = 0;\r
837 UsbSetIdleRequest (\r
838 UsbKeyboardDevice->UsbIo,\r
839 UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
840 ReportId,\r
841 Duration\r
842 );\r
843\r
b4e73a63 844 UsbKeyboardDevice->CtrlOn = FALSE;\r
845 UsbKeyboardDevice->AltOn = FALSE;\r
846 UsbKeyboardDevice->ShiftOn = FALSE;\r
847 UsbKeyboardDevice->NumLockOn = FALSE;\r
848 UsbKeyboardDevice->CapsOn = FALSE;\r
849 UsbKeyboardDevice->ScrollOn = FALSE;\r
66aa04e4 850 \r
b4e73a63 851 UsbKeyboardDevice->LeftCtrlOn = FALSE;\r
852 UsbKeyboardDevice->LeftAltOn = FALSE;\r
853 UsbKeyboardDevice->LeftShiftOn = FALSE;\r
854 UsbKeyboardDevice->LeftLogoOn = FALSE;\r
855 UsbKeyboardDevice->RightCtrlOn = FALSE;\r
856 UsbKeyboardDevice->RightAltOn = FALSE;\r
857 UsbKeyboardDevice->RightShiftOn = FALSE;\r
858 UsbKeyboardDevice->RightLogoOn = FALSE;\r
859 UsbKeyboardDevice->MenuKeyOn = FALSE;\r
860 UsbKeyboardDevice->SysReqOn = FALSE;\r
861\r
862 UsbKeyboardDevice->AltGrOn = FALSE;\r
813acf3a 863\r
864 UsbKeyboardDevice->CurrentNsKey = NULL;\r
ed838d0c 865\r
866 //\r
b4e73a63 867 // Sync the initial state of lights on keyboard.\r
ed838d0c 868 //\r
869 SetKeyLED (UsbKeyboardDevice);\r
870\r
871 ZeroMem (UsbKeyboardDevice->LastKeyCodeArray, sizeof (UINT8) * 8);\r
872\r
873 //\r
874 // Set a timer for repeat keys' generation.\r
875 //\r
a7022cec 876 if (UsbKeyboardDevice->RepeatTimer != NULL) {\r
ed838d0c 877 gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
5899f27e 878 UsbKeyboardDevice->RepeatTimer = NULL;\r
ed838d0c 879 }\r
880\r
881 Status = gBS->CreateEvent (\r
882 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
883 TPL_NOTIFY,\r
884 USBKeyboardRepeatHandler,\r
885 UsbKeyboardDevice,\r
886 &UsbKeyboardDevice->RepeatTimer\r
887 );\r
888\r
a7022cec 889 if (UsbKeyboardDevice->DelayedRecoveryEvent != NULL) {\r
ed838d0c 890 gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
5899f27e 891 UsbKeyboardDevice->DelayedRecoveryEvent = NULL;\r
ed838d0c 892 }\r
893\r
894 Status = gBS->CreateEvent (\r
895 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
896 TPL_NOTIFY,\r
897 USBKeyboardRecoveryHandler,\r
898 UsbKeyboardDevice,\r
899 &UsbKeyboardDevice->DelayedRecoveryEvent\r
900 );\r
901\r
902 return EFI_SUCCESS;\r
903}\r
904\r
905\r
906/**\r
b4e73a63 907 Handler function for USB keyboard's asynchronous interrupt transfer.\r
908\r
909 This function is the handler function for USB keyboard's asynchronous interrupt transfer\r
910 to manage the keyboard. It parses the USB keyboard input report, and inserts data to\r
911 keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key\r
912 is also set accordingly.\r
ed838d0c 913\r
a7022cec 914 @param Data A pointer to a buffer that is filled with key data which is\r
915 retrieved via asynchronous interrupt transfer.\r
916 @param DataLength Indicates the size of the data buffer.\r
917 @param Context Pointing to USB_KB_DEV instance.\r
918 @param Result Indicates the result of the asynchronous interrupt transfer.\r
ed838d0c 919\r
b4e73a63 920 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.\r
921 @retval EFI_DEVICE_ERROR Hardware error occurs.\r
ed838d0c 922\r
923**/\r
924EFI_STATUS\r
925EFIAPI\r
926KeyboardHandler (\r
927 IN VOID *Data,\r
928 IN UINTN DataLength,\r
929 IN VOID *Context,\r
930 IN UINT32 Result\r
931 )\r
932{\r
933 USB_KB_DEV *UsbKeyboardDevice;\r
934 EFI_USB_IO_PROTOCOL *UsbIo;\r
935 UINT8 *CurKeyCodeBuffer;\r
936 UINT8 *OldKeyCodeBuffer;\r
937 UINT8 CurModifierMap;\r
938 UINT8 OldModifierMap;\r
b4e73a63 939 UINT8 Mask;\r
ed838d0c 940 UINT8 Index;\r
941 UINT8 Index2;\r
942 BOOLEAN Down;\r
ed838d0c 943 BOOLEAN KeyRelease;\r
944 BOOLEAN KeyPress;\r
945 UINT8 SavedTail;\r
946 USB_KEY UsbKey;\r
947 UINT8 NewRepeatKey;\r
948 UINT32 UsbStatus;\r
813acf3a 949 EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
ed838d0c 950\r
5899f27e 951 ASSERT (Context != NULL);\r
ed838d0c 952\r
953 NewRepeatKey = 0;\r
ed838d0c 954 UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
955 UsbIo = UsbKeyboardDevice->UsbIo;\r
956\r
957 //\r
b4e73a63 958 // Analyzes Result and performs corresponding action.\r
ed838d0c 959 //\r
960 if (Result != EFI_USB_NOERROR) {\r
961 //\r
962 // Some errors happen during the process\r
963 //\r
5899f27e 964 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
ed838d0c 965 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
5899f27e 966 PcdGet32 (PcdStatusCodeValueKeyboardInputError),\r
967 UsbKeyboardDevice->DevicePath\r
ed838d0c 968 );\r
969\r
970 //\r
b4e73a63 971 // Stop the repeat key generation if any\r
ed838d0c 972 //\r
973 UsbKeyboardDevice->RepeatKey = 0;\r
974\r
975 gBS->SetTimer (\r
976 UsbKeyboardDevice->RepeatTimer,\r
977 TimerCancel,\r
978 USBKBD_REPEAT_RATE\r
979 );\r
980\r
981 if ((Result & EFI_USB_ERR_STALL) == EFI_USB_ERR_STALL) {\r
982 UsbClearEndpointHalt (\r
983 UsbIo,\r
984 UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
985 &UsbStatus\r
986 );\r
987 }\r
988\r
989 //\r
990 // Delete & Submit this interrupt again\r
5899f27e 991 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt. \r
ed838d0c 992 //\r
c52fa98c 993 UsbIo->UsbAsyncInterruptTransfer (\r
5899f27e 994 UsbIo,\r
995 UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
996 FALSE,\r
997 0,\r
998 0,\r
999 NULL,\r
1000 NULL\r
1001 );\r
1002 //\r
b4e73a63 1003 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.\r
5899f27e 1004 //\r
ed838d0c 1005 gBS->SetTimer (\r
5899f27e 1006 UsbKeyboardDevice->DelayedRecoveryEvent,\r
1007 TimerRelative,\r
1008 EFI_USB_INTERRUPT_DELAY\r
1009 );\r
ed838d0c 1010\r
1011 return EFI_DEVICE_ERROR;\r
1012 }\r
1013\r
5899f27e 1014 //\r
1015 // If no error and no data, just return EFI_SUCCESS.\r
1016 //\r
ed838d0c 1017 if (DataLength == 0 || Data == NULL) {\r
1018 return EFI_SUCCESS;\r
1019 }\r
1020\r
5899f27e 1021 //\r
1022 // Following code checks current keyboard input report against old key code buffer.\r
1023 // According to USB HID Firmware Specification, the report consists of 8 bytes.\r
1024 // Byte 0 is map of Modifier keys.\r
1025 // Byte 1 is reserved.\r
1026 // Bytes 2 to 7 are keycodes.\r
1027 //\r
ed838d0c 1028 CurKeyCodeBuffer = (UINT8 *) Data;\r
1029 OldKeyCodeBuffer = UsbKeyboardDevice->LastKeyCodeArray;\r
1030\r
1031 //\r
5899f27e 1032 // Checks for new key stroke.\r
ed838d0c 1033 //\r
1034 for (Index = 0; Index < 8; Index++) {\r
1035 if (OldKeyCodeBuffer[Index] != CurKeyCodeBuffer[Index]) {\r
1036 break;\r
1037 }\r
1038 }\r
1039\r
5899f27e 1040 //\r
1041 // If no new key, return EFI_SUCCESS immediately.\r
1042 //\r
ed838d0c 1043 if (Index == 8) {\r
1044 return EFI_SUCCESS;\r
1045 }\r
1046\r
1047 //\r
5899f27e 1048 // Parse the modifier key, which is the first byte of keyboard input report.\r
ed838d0c 1049 //\r
1050 CurModifierMap = CurKeyCodeBuffer[0];\r
1051 OldModifierMap = OldKeyCodeBuffer[0];\r
1052\r
1053 //\r
5899f27e 1054 // Handle modifier key's pressing or releasing situation.\r
b4e73a63 1055 // According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:\r
1056 // Bit0: Left Control, Keycode: 0xe0\r
1057 // Bit1: Left Shift, Keycode: 0xe1\r
1058 // Bit2: Left Alt, Keycode: 0xe2\r
1059 // Bit3: Left GUI, Keycode: 0xe3\r
1060 // Bit4: Right Control, Keycode: 0xe4\r
1061 // Bit5: Right Shift, Keycode: 0xe5\r
1062 // Bit6: Right Alt, Keycode: 0xe6\r
1063 // Bit7: Right GUI, Keycode: 0xe7\r
ed838d0c 1064 //\r
1065 for (Index = 0; Index < 8; Index++) {\r
b4e73a63 1066 Mask = (UINT8) (1 << Index);\r
1067 if ((CurModifierMap & Mask) != (OldModifierMap & Mask)) {\r
ed838d0c 1068 //\r
b4e73a63 1069 // If current modifier key is up, then CurModifierMap & Mask = 0;\r
5899f27e 1070 // otherwise it is a non-zero value.\r
b4e73a63 1071 // Insert the changed modifier key into key buffer.\r
ed838d0c 1072 //\r
b4e73a63 1073 Down = (BOOLEAN) ((CurModifierMap & Mask) != 0);\r
1074 InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), (UINT8) (0xe0 + Index), Down);\r
ed838d0c 1075 }\r
1076 }\r
1077\r
1078 //\r
5899f27e 1079 // Handle normal key's releasing situation\r
b4e73a63 1080 // Bytes 2 to 7 are for normal keycodes\r
ed838d0c 1081 //\r
1082 KeyRelease = FALSE;\r
1083 for (Index = 2; Index < 8; Index++) {\r
1084\r
1085 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index])) {\r
1086 continue;\r
1087 }\r
5899f27e 1088 //\r
1089 // For any key in old keycode buffer, if it is not in current keycode buffer,\r
1090 // then it is released. Otherwise, it is not released.\r
1091 //\r
ed838d0c 1092 KeyRelease = TRUE;\r
1093 for (Index2 = 2; Index2 < 8; Index2++) {\r
1094\r
1095 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index2])) {\r
1096 continue;\r
1097 }\r
1098\r
1099 if (OldKeyCodeBuffer[Index] == CurKeyCodeBuffer[Index2]) {\r
1100 KeyRelease = FALSE;\r
1101 break;\r
1102 }\r
1103 }\r
1104\r
1105 if (KeyRelease) {\r
1106 InsertKeyCode (\r
1107 &(UsbKeyboardDevice->KeyboardBuffer),\r
1108 OldKeyCodeBuffer[Index],\r
b4e73a63 1109 FALSE\r
ed838d0c 1110 );\r
1111 //\r
5899f27e 1112 // The original repeat key is released.\r
ed838d0c 1113 //\r
1114 if (OldKeyCodeBuffer[Index] == UsbKeyboardDevice->RepeatKey) {\r
1115 UsbKeyboardDevice->RepeatKey = 0;\r
1116 }\r
1117 }\r
1118 }\r
1119\r
1120 //\r
5899f27e 1121 // If original repeat key is released, cancel the repeat timer\r
ed838d0c 1122 //\r
1123 if (UsbKeyboardDevice->RepeatKey == 0) {\r
1124 gBS->SetTimer (\r
5899f27e 1125 UsbKeyboardDevice->RepeatTimer,\r
1126 TimerCancel,\r
1127 USBKBD_REPEAT_RATE\r
1128 );\r
ed838d0c 1129 }\r
1130\r
1131 //\r
5899f27e 1132 // Handle normal key's pressing situation\r
ed838d0c 1133 //\r
1134 KeyPress = FALSE;\r
1135 for (Index = 2; Index < 8; Index++) {\r
1136\r
1137 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index])) {\r
1138 continue;\r
1139 }\r
5899f27e 1140 //\r
1141 // For any key in current keycode buffer, if it is not in old keycode buffer,\r
1142 // then it is pressed. Otherwise, it is not pressed.\r
1143 //\r
ed838d0c 1144 KeyPress = TRUE;\r
1145 for (Index2 = 2; Index2 < 8; Index2++) {\r
1146\r
1147 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index2])) {\r
1148 continue;\r
1149 }\r
1150\r
1151 if (CurKeyCodeBuffer[Index] == OldKeyCodeBuffer[Index2]) {\r
1152 KeyPress = FALSE;\r
1153 break;\r
1154 }\r
1155 }\r
1156\r
1157 if (KeyPress) {\r
b4e73a63 1158 InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), CurKeyCodeBuffer[Index], TRUE);\r
5899f27e 1159\r
ed838d0c 1160 //\r
5899f27e 1161 // Handle repeat key\r
ed838d0c 1162 //\r
813acf3a 1163 KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, CurKeyCodeBuffer[Index]);\r
81464cf1 1164 ASSERT (KeyDescriptor != NULL);\r
1165\r
813acf3a 1166 if (KeyDescriptor->Modifier == EFI_NUM_LOCK_MODIFIER || KeyDescriptor->Modifier == EFI_CAPS_LOCK_MODIFIER) {\r
5899f27e 1167 //\r
1168 // For NumLock or CapsLock pressed, there is no need to handle repeat key for them.\r
1169 //\r
ed838d0c 1170 UsbKeyboardDevice->RepeatKey = 0;\r
1171 } else {\r
ed838d0c 1172 //\r
5899f27e 1173 // Prepare new repeat key, and clear the original one.\r
ed838d0c 1174 //\r
5899f27e 1175 NewRepeatKey = CurKeyCodeBuffer[Index];\r
ed838d0c 1176 UsbKeyboardDevice->RepeatKey = 0;\r
1177 }\r
1178 }\r
1179 }\r
1180\r
1181 //\r
b4e73a63 1182 // Update LastKeycodeArray buffer in the UsbKeyboardDevice data structure.\r
ed838d0c 1183 //\r
1184 for (Index = 0; Index < 8; Index++) {\r
1185 UsbKeyboardDevice->LastKeyCodeArray[Index] = CurKeyCodeBuffer[Index];\r
1186 }\r
1187\r
1188 //\r
b4e73a63 1189 // Pre-process KeyboardBuffer to check if Ctrl + Alt + Del is pressed.\r
ed838d0c 1190 //\r
5899f27e 1191 SavedTail = UsbKeyboardDevice->KeyboardBuffer.BufferTail;\r
1192 Index = UsbKeyboardDevice->KeyboardBuffer.BufferHead;\r
ed838d0c 1193 while (Index != SavedTail) {\r
1194 RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
1195\r
813acf3a 1196 KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
1197\r
1198 switch (KeyDescriptor->Modifier) {\r
ed838d0c 1199\r
813acf3a 1200 case EFI_LEFT_CONTROL_MODIFIER:\r
1201 case EFI_RIGHT_CONTROL_MODIFIER:\r
b4e73a63 1202 if (UsbKey.Down) {\r
1203 UsbKeyboardDevice->CtrlOn = TRUE;\r
ed838d0c 1204 } else {\r
b4e73a63 1205 UsbKeyboardDevice->CtrlOn = FALSE;\r
ed838d0c 1206 }\r
1207 break;\r
1208\r
813acf3a 1209 case EFI_LEFT_ALT_MODIFIER:\r
1210 case EFI_RIGHT_ALT_MODIFIER:\r
b4e73a63 1211 if (UsbKey.Down) {\r
1212 UsbKeyboardDevice->AltOn = TRUE;\r
ed838d0c 1213 } else {\r
b4e73a63 1214 UsbKeyboardDevice->AltOn = FALSE;\r
ed838d0c 1215 }\r
1216 break;\r
1217\r
813acf3a 1218 case EFI_ALT_GR_MODIFIER:\r
b4e73a63 1219 if (UsbKey.Down) {\r
1220 UsbKeyboardDevice->AltGrOn = TRUE;\r
813acf3a 1221 } else {\r
b4e73a63 1222 UsbKeyboardDevice->AltGrOn = FALSE;\r
813acf3a 1223 }\r
1224 break;\r
1225\r
ed838d0c 1226 //\r
5899f27e 1227 // For Del Key, check if Ctrl + Alt + Del occurs for reset.\r
ed838d0c 1228 //\r
813acf3a 1229 case EFI_DELETE_MODIFIER:\r
b4e73a63 1230 if (UsbKey.Down) {\r
1231 if ((UsbKeyboardDevice->CtrlOn) && (UsbKeyboardDevice->AltOn)) {\r
ed838d0c 1232 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
1233 }\r
1234 }\r
1235 break;\r
1236\r
1237 default:\r
1238 break;\r
1239 }\r
1240\r
1241 //\r
5899f27e 1242 // Insert the key back to the buffer,\r
ed838d0c 1243 // so the key sequence will not be destroyed.\r
1244 //\r
1245 InsertKeyCode (\r
1246 &(UsbKeyboardDevice->KeyboardBuffer),\r
1247 UsbKey.KeyCode,\r
1248 UsbKey.Down\r
1249 );\r
5899f27e 1250 Index = UsbKeyboardDevice->KeyboardBuffer.BufferHead;\r
ed838d0c 1251\r
1252 }\r
1253 //\r
b4e73a63 1254 // If there is new key pressed, update the RepeatKey value, and set the\r
ed838d0c 1255 // timer to repeate delay timer\r
1256 //\r
1257 if (NewRepeatKey != 0) {\r
1258 //\r
5899f27e 1259 // Sets trigger time to "Repeat Delay Time",\r
ed838d0c 1260 // to trigger the repeat timer when the key is hold long\r
1261 // enough time.\r
1262 //\r
1263 gBS->SetTimer (\r
b4e73a63 1264 UsbKeyboardDevice->RepeatTimer,\r
1265 TimerRelative,\r
1266 USBKBD_REPEAT_DELAY\r
1267 );\r
ed838d0c 1268 UsbKeyboardDevice->RepeatKey = NewRepeatKey;\r
1269 }\r
1270\r
1271 return EFI_SUCCESS;\r
1272}\r
1273\r
1274\r
1275/**\r
b4e73a63 1276 Retrieves a USB keycode after parsing the raw data in keyboard buffer.\r
1277\r
1278 This function parses keyboard buffer. It updates state of modifier key for\r
1279 USB_KB_DEV instancem, and returns keycode for output.\r
ed838d0c 1280\r
a7022cec 1281 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
b4e73a63 1282 @param KeyCode Pointer to the USB keycode for output.\r
ed838d0c 1283\r
b4e73a63 1284 @retval EFI_SUCCESS Keycode successfully parsed.\r
1285 @retval EFI_NOT_READY Keyboard buffer is not ready for a valid keycode\r
ed838d0c 1286\r
1287**/\r
1288EFI_STATUS\r
a7022cec 1289EFIAPI\r
ed838d0c 1290USBParseKey (\r
1291 IN OUT USB_KB_DEV *UsbKeyboardDevice,\r
b4e73a63 1292 OUT UINT8 *KeyCode\r
ed838d0c 1293 )\r
1294{\r
813acf3a 1295 USB_KEY UsbKey;\r
1296 EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
ed838d0c 1297\r
b4e73a63 1298 *KeyCode = 0;\r
ed838d0c 1299\r
1300 while (!IsUSBKeyboardBufferEmpty (&UsbKeyboardDevice->KeyboardBuffer)) {\r
1301 //\r
5899f27e 1302 // Pops one raw data off.\r
ed838d0c 1303 //\r
1304 RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
1305\r
813acf3a 1306 KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
81464cf1 1307 ASSERT (KeyDescriptor != NULL);\r
1308\r
b4e73a63 1309 if (!UsbKey.Down) {\r
5899f27e 1310 //\r
1311 // Key is released.\r
1312 //\r
813acf3a 1313 switch (KeyDescriptor->Modifier) {\r
ed838d0c 1314\r
66aa04e4 1315 //\r
b4e73a63 1316 // Ctrl release\r
66aa04e4 1317 //\r
813acf3a 1318 case EFI_LEFT_CONTROL_MODIFIER:\r
b4e73a63 1319 UsbKeyboardDevice->LeftCtrlOn = FALSE;\r
1320 UsbKeyboardDevice->CtrlOn = FALSE;\r
66aa04e4 1321 break;\r
813acf3a 1322 case EFI_RIGHT_CONTROL_MODIFIER:\r
b4e73a63 1323 UsbKeyboardDevice->RightCtrlOn = FALSE;\r
1324 UsbKeyboardDevice->CtrlOn = FALSE;\r
ed838d0c 1325 break;\r
1326\r
66aa04e4 1327 //\r
1328 // Shift release\r
1329 //\r
813acf3a 1330 case EFI_LEFT_SHIFT_MODIFIER:\r
b4e73a63 1331 UsbKeyboardDevice->LeftShiftOn = FALSE;\r
1332 UsbKeyboardDevice->ShiftOn = FALSE;\r
66aa04e4 1333 break;\r
813acf3a 1334 case EFI_RIGHT_SHIFT_MODIFIER:\r
b4e73a63 1335 UsbKeyboardDevice->RightShiftOn = FALSE;\r
1336 UsbKeyboardDevice->ShiftOn = FALSE;\r
ed838d0c 1337 break;\r
1338\r
66aa04e4 1339 //\r
1340 // Alt release\r
1341 //\r
813acf3a 1342 case EFI_LEFT_ALT_MODIFIER:\r
b4e73a63 1343 UsbKeyboardDevice->LeftAltOn = FALSE;\r
1344 UsbKeyboardDevice->AltOn = FALSE;\r
66aa04e4 1345 break;\r
813acf3a 1346 case EFI_RIGHT_ALT_MODIFIER:\r
b4e73a63 1347 UsbKeyboardDevice->RightAltOn = FALSE;\r
1348 UsbKeyboardDevice->AltOn = FALSE;\r
ed838d0c 1349 break;\r
1350\r
66aa04e4 1351 //\r
813acf3a 1352 // Left Logo release\r
66aa04e4 1353 //\r
813acf3a 1354 case EFI_LEFT_LOGO_MODIFIER:\r
b4e73a63 1355 UsbKeyboardDevice->LeftLogoOn = FALSE;\r
66aa04e4 1356 break;\r
813acf3a 1357\r
1358 //\r
1359 // Right Logo release\r
1360 //\r
1361 case EFI_RIGHT_LOGO_MODIFIER:\r
b4e73a63 1362 UsbKeyboardDevice->RightLogoOn = FALSE;\r
66aa04e4 1363 break;\r
1364\r
1365 //\r
813acf3a 1366 // Menu key release\r
66aa04e4 1367 //\r
813acf3a 1368 case EFI_MENU_MODIFIER:\r
b4e73a63 1369 UsbKeyboardDevice->MenuKeyOn = FALSE;\r
66aa04e4 1370 break;\r
1371\r
1372 //\r
1373 // SysReq release\r
1374 //\r
a77267d2 1375 case EFI_PRINT_MODIFIER:\r
813acf3a 1376 case EFI_SYS_REQUEST_MODIFIER:\r
b4e73a63 1377 UsbKeyboardDevice->SysReqOn = FALSE;\r
66aa04e4 1378 break;\r
813acf3a 1379\r
1380 //\r
1381 // AltGr release\r
1382 //\r
1383 case EFI_ALT_GR_MODIFIER:\r
b4e73a63 1384 UsbKeyboardDevice->AltGrOn = FALSE;\r
813acf3a 1385 break;\r
1386\r
ed838d0c 1387 default:\r
1388 break;\r
1389 }\r
1390\r
1391 continue;\r
1392 }\r
1393\r
1394 //\r
1395 // Analyzes key pressing situation\r
1396 //\r
813acf3a 1397 switch (KeyDescriptor->Modifier) {\r
ed838d0c 1398\r
813acf3a 1399 //\r
b4e73a63 1400 // Ctrl press\r
813acf3a 1401 //\r
1402 case EFI_LEFT_CONTROL_MODIFIER:\r
b4e73a63 1403 UsbKeyboardDevice->LeftCtrlOn = TRUE;\r
1404 UsbKeyboardDevice->CtrlOn = TRUE;\r
813acf3a 1405 continue;\r
66aa04e4 1406 break;\r
813acf3a 1407 case EFI_RIGHT_CONTROL_MODIFIER:\r
b4e73a63 1408 UsbKeyboardDevice->RightCtrlOn = TRUE;\r
1409 UsbKeyboardDevice->CtrlOn = TRUE;\r
ed838d0c 1410 continue;\r
1411 break;\r
1412\r
66aa04e4 1413 //\r
1414 // Shift press\r
1415 //\r
813acf3a 1416 case EFI_LEFT_SHIFT_MODIFIER:\r
b4e73a63 1417 UsbKeyboardDevice->LeftShiftOn = TRUE;\r
1418 UsbKeyboardDevice->ShiftOn = TRUE;\r
66aa04e4 1419 continue;\r
1420 break;\r
813acf3a 1421 case EFI_RIGHT_SHIFT_MODIFIER:\r
b4e73a63 1422 UsbKeyboardDevice->RightShiftOn = TRUE;\r
1423 UsbKeyboardDevice->ShiftOn = TRUE;\r
ed838d0c 1424 continue;\r
1425 break;\r
1426\r
66aa04e4 1427 //\r
1428 // Alt press\r
1429 //\r
813acf3a 1430 case EFI_LEFT_ALT_MODIFIER:\r
b4e73a63 1431 UsbKeyboardDevice->LeftAltOn = TRUE;\r
1432 UsbKeyboardDevice->AltOn = TRUE;\r
66aa04e4 1433 continue;\r
1434 break;\r
813acf3a 1435 case EFI_RIGHT_ALT_MODIFIER:\r
b4e73a63 1436 UsbKeyboardDevice->RightAltOn = TRUE;\r
1437 UsbKeyboardDevice->AltOn = TRUE;\r
ed838d0c 1438 continue;\r
1439 break;\r
1440\r
66aa04e4 1441 //\r
813acf3a 1442 // Left Logo press\r
66aa04e4 1443 //\r
813acf3a 1444 case EFI_LEFT_LOGO_MODIFIER:\r
b4e73a63 1445 UsbKeyboardDevice->LeftLogoOn = TRUE;\r
66aa04e4 1446 break;\r
813acf3a 1447\r
1448 //\r
1449 // Right Logo press\r
1450 //\r
1451 case EFI_RIGHT_LOGO_MODIFIER:\r
b4e73a63 1452 UsbKeyboardDevice->RightLogoOn = TRUE;\r
ed838d0c 1453 break;\r
1454\r
ed838d0c 1455 //\r
813acf3a 1456 // Menu key press\r
66aa04e4 1457 //\r
813acf3a 1458 case EFI_MENU_MODIFIER:\r
b4e73a63 1459 UsbKeyboardDevice->MenuKeyOn = TRUE;\r
66aa04e4 1460 break;\r
1461\r
1462 //\r
1463 // SysReq press\r
ed838d0c 1464 //\r
a77267d2 1465 case EFI_PRINT_MODIFIER:\r
813acf3a 1466 case EFI_SYS_REQUEST_MODIFIER:\r
b4e73a63 1467 UsbKeyboardDevice->SysReqOn = TRUE;\r
813acf3a 1468 continue;\r
66aa04e4 1469 break;\r
1470\r
813acf3a 1471 //\r
1472 // AltGr press\r
1473 //\r
1474 case EFI_ALT_GR_MODIFIER:\r
b4e73a63 1475 UsbKeyboardDevice->AltGrOn = TRUE;\r
813acf3a 1476 break;\r
1477\r
1478 case EFI_NUM_LOCK_MODIFIER:\r
66aa04e4 1479 //\r
b4e73a63 1480 // Toggle NumLock\r
66aa04e4 1481 //\r
b4e73a63 1482 UsbKeyboardDevice->NumLockOn = (BOOLEAN) (!(UsbKeyboardDevice->NumLockOn));\r
ed838d0c 1483 SetKeyLED (UsbKeyboardDevice);\r
1484 continue;\r
1485 break;\r
1486\r
813acf3a 1487 case EFI_CAPS_LOCK_MODIFIER:\r
66aa04e4 1488 //\r
b4e73a63 1489 // Toggle CapsLock\r
66aa04e4 1490 //\r
b4e73a63 1491 UsbKeyboardDevice->CapsOn = (BOOLEAN) (!(UsbKeyboardDevice->CapsOn));\r
ed838d0c 1492 SetKeyLED (UsbKeyboardDevice);\r
1493 continue;\r
1494 break;\r
1495\r
813acf3a 1496 case EFI_SCROLL_LOCK_MODIFIER:\r
66aa04e4 1497 //\r
b4e73a63 1498 // Toggle ScrollLock\r
66aa04e4 1499 //\r
b4e73a63 1500 UsbKeyboardDevice->ScrollOn = (BOOLEAN) (!(UsbKeyboardDevice->ScrollOn));\r
ed838d0c 1501 SetKeyLED (UsbKeyboardDevice);\r
1502 continue;\r
1503 break;\r
1504\r
1505 //\r
5899f27e 1506 // F11, F12, PrintScreen, Pause/Break\r
1507 // could not be retrieved via SimpleTextInEx protocol\r
ed838d0c 1508 //\r
813acf3a 1509 case EFI_FUNCTION_KEY_ELEVEN_MODIFIER:\r
1510 case EFI_FUNCTION_KEY_TWELVE_MODIFIER:\r
813acf3a 1511 case EFI_PAUSE_MODIFIER:\r
1512 case EFI_BREAK_MODIFIER:\r
1513 //\r
5899f27e 1514 // Fall through\r
813acf3a 1515 //\r
ed838d0c 1516 continue;\r
1517 break;\r
1518\r
1519 default:\r
1520 break;\r
1521 }\r
1522\r
1523 //\r
5899f27e 1524 // When encountering Ctrl + Alt + Del, then warm reset.\r
ed838d0c 1525 //\r
813acf3a 1526 if (KeyDescriptor->Modifier == EFI_DELETE_MODIFIER) {\r
b4e73a63 1527 if ((UsbKeyboardDevice->CtrlOn) && (UsbKeyboardDevice->AltOn)) {\r
ed838d0c 1528 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
1529 }\r
1530 }\r
1531\r
b4e73a63 1532 *KeyCode = UsbKey.KeyCode;\r
ed838d0c 1533 return EFI_SUCCESS;\r
1534 }\r
1535\r
1536 return EFI_NOT_READY;\r
ed838d0c 1537}\r
1538\r
1539\r
ed838d0c 1540/**\r
b4e73a63 1541 Converts USB Keycode ranging from 0x4 to 0x65 to EFI_INPUT_KEY.\r
ed838d0c 1542\r
b4e73a63 1543 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
1544 @param KeyCode Indicates the key code that will be interpreted.\r
1545 @param Key A pointer to a buffer that is filled in with\r
1546 the keystroke information for the key that\r
1547 was pressed.\r
ed838d0c 1548\r
b4e73a63 1549 @retval EFI_SUCCESS Success.\r
1550 @retval EFI_INVALID_PARAMETER KeyCode is not in the range of 0x4 to 0x65.\r
1551 @retval EFI_INVALID_PARAMETER Translated EFI_INPUT_KEY has zero for both ScanCode and UnicodeChar.\r
1552 @retval EFI_NOT_READY KeyCode represents a dead key with EFI_NS_KEY_MODIFIER\r
81464cf1 1553 @retval EFI_DEVICE_ERROR Keyboard layout is invalid.\r
ed838d0c 1554\r
1555**/\r
1556EFI_STATUS\r
a7022cec 1557EFIAPI\r
5899f27e 1558UsbKeyCodeToEfiInputKey (\r
ed838d0c 1559 IN USB_KB_DEV *UsbKeyboardDevice,\r
b4e73a63 1560 IN UINT8 KeyCode,\r
ed838d0c 1561 OUT EFI_INPUT_KEY *Key\r
1562 )\r
1563{\r
813acf3a 1564 EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
ed838d0c 1565\r
ed838d0c 1566 //\r
b4e73a63 1567 // KeyCode must in the range of 0x4 to 0x65\r
ed838d0c 1568 //\r
b4e73a63 1569 if (!USBKBD_VALID_KEYCODE (KeyCode)) {\r
1570 return EFI_INVALID_PARAMETER;\r
1571 }\r
1572 if ((KeyCode - 4) >= NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE) {\r
1573 return EFI_INVALID_PARAMETER;\r
ed838d0c 1574 }\r
1575\r
b4e73a63 1576 KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, KeyCode);\r
81464cf1 1577 ASSERT (KeyDescriptor != NULL);\r
813acf3a 1578\r
813acf3a 1579 if (KeyDescriptor->Modifier == EFI_NS_KEY_MODIFIER) {\r
5899f27e 1580 //\r
1581 // If this is a dead key with EFI_NS_KEY_MODIFIER, then record it and return.\r
1582 //\r
813acf3a 1583 UsbKeyboardDevice->CurrentNsKey = FindUsbNsKey (UsbKeyboardDevice, KeyDescriptor);\r
1584 return EFI_NOT_READY;\r
1585 }\r
1586\r
813acf3a 1587 if (UsbKeyboardDevice->CurrentNsKey != NULL) {\r
5899f27e 1588 //\r
1589 // If this keystroke follows a non-spacing key, then find the descriptor for corresponding\r
1590 // physical key.\r
1591 //\r
813acf3a 1592 KeyDescriptor = FindPhysicalKey (UsbKeyboardDevice->CurrentNsKey, KeyDescriptor);\r
1593 UsbKeyboardDevice->CurrentNsKey = NULL;\r
66aa04e4 1594 }\r
1595\r
81464cf1 1596 //\r
1597 // Make sure modifier of Key Descriptor is in the valid range according to UEFI spec.\r
1598 //\r
1599 if (KeyDescriptor->Modifier > EFI_FUNCTION_KEY_TWELVE_MODIFIER) {\r
1600 return EFI_DEVICE_ERROR;\r
1601 }\r
1602\r
b4e73a63 1603 Key->ScanCode = ModifierValueToEfiScanCodeConvertionTable[KeyDescriptor->Modifier];\r
813acf3a 1604 Key->UnicodeChar = KeyDescriptor->Unicode;\r
ed838d0c 1605\r
5899f27e 1606 if ((KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_STANDARD_SHIFT)!= 0) {\r
b4e73a63 1607 if (UsbKeyboardDevice->ShiftOn) {\r
813acf3a 1608 Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
ed838d0c 1609\r
813acf3a 1610 //\r
1611 // Need not return associated shift state if a class of printable characters that\r
1612 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'\r
1613 //\r
5899f27e 1614 if ((KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) != 0) {\r
b4e73a63 1615 UsbKeyboardDevice->LeftShiftOn = FALSE;\r
1616 UsbKeyboardDevice->RightShiftOn = FALSE;\r
813acf3a 1617 }\r
ed838d0c 1618\r
b4e73a63 1619 if (UsbKeyboardDevice->AltGrOn) {\r
813acf3a 1620 Key->UnicodeChar = KeyDescriptor->ShiftedAltGrUnicode;\r
1621 }\r
1622 } else {\r
1623 //\r
1624 // Shift off\r
1625 //\r
1626 Key->UnicodeChar = KeyDescriptor->Unicode;\r
ed838d0c 1627\r
b4e73a63 1628 if (UsbKeyboardDevice->AltGrOn) {\r
813acf3a 1629 Key->UnicodeChar = KeyDescriptor->AltGrUnicode;\r
1630 }\r
1631 }\r
ed838d0c 1632 }\r
1633\r
5899f27e 1634 if ((KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) != 0) {\r
b4e73a63 1635 if (UsbKeyboardDevice->CapsOn) {\r
813acf3a 1636 if (Key->UnicodeChar == KeyDescriptor->Unicode) {\r
813acf3a 1637 Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
813acf3a 1638 } else if (Key->UnicodeChar == KeyDescriptor->ShiftedUnicode) {\r
813acf3a 1639 Key->UnicodeChar = KeyDescriptor->Unicode;\r
813acf3a 1640 }\r
ed838d0c 1641 }\r
1642 }\r
813acf3a 1643\r
1f771698 1644 //\r
5899f27e 1645 // Translate the CTRL-Alpha characters to their corresponding control value\r
1646 // (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
1f771698 1647 //\r
b4e73a63 1648 if (UsbKeyboardDevice->CtrlOn) {\r
1f771698 1649 if (Key->UnicodeChar >= 'a' && Key->UnicodeChar <= 'z') {\r
813acf3a 1650 Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'a' + 1);\r
1f771698 1651 } else if (Key->UnicodeChar >= 'A' && Key->UnicodeChar <= 'Z') {\r
813acf3a 1652 Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'A' + 1);\r
1f771698 1653 }\r
1654 }\r
813acf3a 1655\r
1656 if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_NUM_LOCK) {\r
5899f27e 1657 //\r
1658 // For key affected by NumLock, if NumLock is on and Shift is not pressed, then it means\r
1659 // normal key, instead of original control key. So the ScanCode should be cleaned.\r
1660 // Otherwise, it means control key, so preserve the EFI Scan Code and clear the unicode keycode.\r
1661 //\r
b4e73a63 1662 if ((UsbKeyboardDevice->NumLockOn) && (!(UsbKeyboardDevice->ShiftOn))) {\r
ed838d0c 1663 Key->ScanCode = SCAN_NULL;\r
ed838d0c 1664 } else {\r
ed838d0c 1665 Key->UnicodeChar = 0x00;\r
1666 }\r
1667 }\r
1668\r
813acf3a 1669 //\r
1670 // Translate Unicode 0x1B (ESC) to EFI Scan Code\r
1671 //\r
1672 if (Key->UnicodeChar == 0x1B && Key->ScanCode == SCAN_NULL) {\r
1673 Key->ScanCode = SCAN_ESC;\r
1674 Key->UnicodeChar = 0x00;\r
1675 }\r
1676\r
5899f27e 1677 //\r
1678 // Not valid for key without both unicode key code and EFI Scan Code.\r
1679 //\r
ed838d0c 1680 if (Key->UnicodeChar == 0 && Key->ScanCode == SCAN_NULL) {\r
1681 return EFI_NOT_READY;\r
1682 }\r
1683\r
66aa04e4 1684\r
1685 //\r
1686 // Save Shift/Toggle state\r
1687 //\r
b4e73a63 1688 if (UsbKeyboardDevice->LeftCtrlOn) {\r
66aa04e4 1689 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_CONTROL_PRESSED;\r
1690 }\r
b4e73a63 1691 if (UsbKeyboardDevice->RightCtrlOn) {\r
66aa04e4 1692 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_CONTROL_PRESSED;\r
1693 }\r
b4e73a63 1694 if (UsbKeyboardDevice->LeftAltOn) {\r
66aa04e4 1695 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_ALT_PRESSED;\r
1696 }\r
b4e73a63 1697 if (UsbKeyboardDevice->RightAltOn) {\r
66aa04e4 1698 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_ALT_PRESSED;\r
1699 }\r
b4e73a63 1700 if (UsbKeyboardDevice->LeftShiftOn) {\r
66aa04e4 1701 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;\r
1702 }\r
b4e73a63 1703 if (UsbKeyboardDevice->RightShiftOn) {\r
66aa04e4 1704 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;\r
1705 }\r
b4e73a63 1706 if (UsbKeyboardDevice->LeftLogoOn) {\r
66aa04e4 1707 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;\r
1708 }\r
b4e73a63 1709 if (UsbKeyboardDevice->RightLogoOn) {\r
66aa04e4 1710 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;\r
1711 }\r
b4e73a63 1712 if (UsbKeyboardDevice->MenuKeyOn) {\r
66aa04e4 1713 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;\r
1714 }\r
b4e73a63 1715 if (UsbKeyboardDevice->SysReqOn) {\r
66aa04e4 1716 UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;\r
813acf3a 1717 }\r
66aa04e4 1718\r
b4e73a63 1719 if (UsbKeyboardDevice->ScrollOn) {\r
66aa04e4 1720 UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
1721 }\r
b4e73a63 1722 if (UsbKeyboardDevice->NumLockOn) {\r
66aa04e4 1723 UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
1724 }\r
b4e73a63 1725 if (UsbKeyboardDevice->CapsOn) {\r
66aa04e4 1726 UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
1727 }\r
1728\r
ed838d0c 1729 return EFI_SUCCESS;\r
1730\r
1731}\r
1732\r
1733\r
ed838d0c 1734/**\r
b4e73a63 1735 Resets USB keyboard buffer.\r
ed838d0c 1736\r
b4e73a63 1737 @param KeyboardBuffer Points to the USB keyboard buffer.\r
ed838d0c 1738\r
ed838d0c 1739**/\r
5899f27e 1740VOID\r
a7022cec 1741EFIAPI\r
ed838d0c 1742InitUSBKeyBuffer (\r
b4e73a63 1743 OUT USB_KB_BUFFER *KeyboardBuffer\r
ed838d0c 1744 )\r
1745{\r
1746 ZeroMem (KeyboardBuffer, sizeof (USB_KB_BUFFER));\r
1747\r
5899f27e 1748 KeyboardBuffer->BufferHead = KeyboardBuffer->BufferTail;\r
ed838d0c 1749}\r
1750\r
1751\r
1752/**\r
b4e73a63 1753 Check whether USB keyboard buffer is empty.\r
ed838d0c 1754\r
b4e73a63 1755 @param KeyboardBuffer USB keyboard buffer\r
ed838d0c 1756\r
b4e73a63 1757 @retval TRUE Keyboard buffer is empty.\r
1758 @retval FALSE Keyboard buffer is not empty.\r
ed838d0c 1759\r
1760**/\r
1761BOOLEAN\r
a7022cec 1762EFIAPI\r
ed838d0c 1763IsUSBKeyboardBufferEmpty (\r
1764 IN USB_KB_BUFFER *KeyboardBuffer\r
1765 )\r
1766{\r
1767 //\r
b4e73a63 1768 // Meet FIFO empty condition\r
ed838d0c 1769 //\r
5899f27e 1770 return (BOOLEAN) (KeyboardBuffer->BufferHead == KeyboardBuffer->BufferTail);\r
ed838d0c 1771}\r
1772\r
1773\r
ed838d0c 1774/**\r
b4e73a63 1775 Check whether USB keyboard buffer is full.\r
ed838d0c 1776\r
b4e73a63 1777 @param KeyboardBuffer USB keyboard buffer\r
ed838d0c 1778\r
b4e73a63 1779 @retval TRUE Keyboard buffer is full.\r
1780 @retval FALSE Keyboard buffer is not full.\r
ed838d0c 1781\r
1782**/\r
1783BOOLEAN\r
a7022cec 1784EFIAPI\r
ed838d0c 1785IsUSBKeyboardBufferFull (\r
1786 IN USB_KB_BUFFER *KeyboardBuffer\r
1787 )\r
1788{\r
5899f27e 1789 return (BOOLEAN)(((KeyboardBuffer->BufferTail + 1) % (MAX_KEY_ALLOWED + 1)) == KeyboardBuffer->BufferHead);\r
ed838d0c 1790}\r
1791\r
1792\r
ed838d0c 1793/**\r
b4e73a63 1794 Inserts a keycode into keyboard buffer.\r
ed838d0c 1795\r
b4e73a63 1796 @param KeyboardBuffer Points to the USB keyboard buffer.\r
1797 @param Key Keycode to insert.\r
1798 @param Down TRUE means key is pressed.\r
1799 FALSE means key is released.\r
ed838d0c 1800\r
ed838d0c 1801**/\r
5899f27e 1802VOID\r
a7022cec 1803EFIAPI\r
ed838d0c 1804InsertKeyCode (\r
1805 IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
1806 IN UINT8 Key,\r
b4e73a63 1807 IN BOOLEAN Down\r
ed838d0c 1808 )\r
1809{\r
1810 USB_KEY UsbKey;\r
1811\r
1812 //\r
b4e73a63 1813 // If keyboard buffer is full, throw the\r
ed838d0c 1814 // first key out of the keyboard buffer.\r
1815 //\r
1816 if (IsUSBKeyboardBufferFull (KeyboardBuffer)) {\r
1817 RemoveKeyCode (KeyboardBuffer, &UsbKey);\r
1818 }\r
1819\r
81464cf1 1820 ASSERT (KeyboardBuffer->BufferTail <= MAX_KEY_ALLOWED);\r
1821\r
5899f27e 1822 KeyboardBuffer->Buffer[KeyboardBuffer->BufferTail].KeyCode = Key;\r
1823 KeyboardBuffer->Buffer[KeyboardBuffer->BufferTail].Down = Down;\r
ed838d0c 1824\r
1825 //\r
5899f27e 1826 // Adjust the tail pointer of the FIFO keyboard buffer.\r
ed838d0c 1827 //\r
5899f27e 1828 KeyboardBuffer->BufferTail = (UINT8) ((KeyboardBuffer->BufferTail + 1) % (MAX_KEY_ALLOWED + 1));\r
ed838d0c 1829}\r
1830\r
1831\r
1832/**\r
b4e73a63 1833 Remove a keycode from keyboard buffer and return it.\r
ed838d0c 1834\r
b4e73a63 1835 @param KeyboardBuffer Points to the USB keyboard buffer.\r
1836 @param UsbKey Points to the buffer that contains keycode for output.\r
ed838d0c 1837\r
b4e73a63 1838 @retval EFI_SUCCESS Keycode successfully removed from keyboard buffer.\r
5899f27e 1839 @retval EFI_DEVICE_ERROR Keyboard buffer is empty.\r
ed838d0c 1840\r
1841**/\r
1842EFI_STATUS\r
a7022cec 1843EFIAPI\r
ed838d0c 1844RemoveKeyCode (\r
1845 IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
b4e73a63 1846 OUT USB_KEY *UsbKey\r
ed838d0c 1847 )\r
1848{\r
1849 if (IsUSBKeyboardBufferEmpty (KeyboardBuffer)) {\r
1850 return EFI_DEVICE_ERROR;\r
1851 }\r
1852\r
81464cf1 1853 ASSERT (KeyboardBuffer->BufferHead <= MAX_KEY_ALLOWED);\r
1854\r
5899f27e 1855 UsbKey->KeyCode = KeyboardBuffer->Buffer[KeyboardBuffer->BufferHead].KeyCode;\r
1856 UsbKey->Down = KeyboardBuffer->Buffer[KeyboardBuffer->BufferHead].Down;\r
ed838d0c 1857\r
1858 //\r
5899f27e 1859 // Adjust the head pointer of the FIFO keyboard buffer.\r
ed838d0c 1860 //\r
5899f27e 1861 KeyboardBuffer->BufferHead = (UINT8) ((KeyboardBuffer->BufferHead + 1) % (MAX_KEY_ALLOWED + 1));\r
ed838d0c 1862\r
1863 return EFI_SUCCESS;\r
1864}\r
1865\r
1866\r
1867/**\r
b4e73a63 1868 Sets USB keyboard LED state.\r
ed838d0c 1869\r
1870 @param UsbKeyboardDevice The USB_KB_DEV instance.\r
1871\r
ed838d0c 1872**/\r
5899f27e 1873VOID\r
a7022cec 1874EFIAPI\r
ed838d0c 1875SetKeyLED (\r
1876 IN USB_KB_DEV *UsbKeyboardDevice\r
1877 )\r
1878{\r
1879 LED_MAP Led;\r
1880 UINT8 ReportId;\r
1881\r
1882 //\r
1883 // Set each field in Led map.\r
1884 //\r
b4e73a63 1885 Led.NumLock = (UINT8) ((UsbKeyboardDevice->NumLockOn) ? 1 : 0);\r
1886 Led.CapsLock = (UINT8) ((UsbKeyboardDevice->CapsOn) ? 1 : 0);\r
1887 Led.ScrollLock = (UINT8) ((UsbKeyboardDevice->ScrollOn) ? 1 : 0);\r
ed838d0c 1888 Led.Resrvd = 0;\r
1889\r
1890 ReportId = 0;\r
1891 //\r
5899f27e 1892 // Call Set_Report Request to lighten the LED.\r
ed838d0c 1893 //\r
1894 UsbSetReportRequest (\r
1895 UsbKeyboardDevice->UsbIo,\r
1896 UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
1897 ReportId,\r
1898 HID_OUTPUT_REPORT,\r
1899 1,\r
1900 (UINT8 *) &Led\r
1901 );\r
ed838d0c 1902}\r
1903\r
1904\r
1905/**\r
b4e73a63 1906 Handler for Repeat Key event.\r
1907\r
1908 This function is the handler for Repeat Key event triggered\r
1909 by timer.\r
1910 After a repeatable key is pressed, the event would be triggered\r
1911 with interval of USBKBD_REPEAT_DELAY. Once the event is triggered,\r
1912 following trigger will come with interval of USBKBD_REPEAT_RATE.\r
ed838d0c 1913\r
1914 @param Event The Repeat Key event.\r
1915 @param Context Points to the USB_KB_DEV instance.\r
1916\r
ed838d0c 1917**/\r
1918VOID\r
1919EFIAPI\r
1920USBKeyboardRepeatHandler (\r
1921 IN EFI_EVENT Event,\r
1922 IN VOID *Context\r
1923 )\r
1924{\r
1925 USB_KB_DEV *UsbKeyboardDevice;\r
1926\r
1927 UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
1928\r
1929 //\r
1930 // Do nothing when there is no repeat key.\r
1931 //\r
1932 if (UsbKeyboardDevice->RepeatKey != 0) {\r
1933 //\r
b4e73a63 1934 // Inserts the repeat key into keyboard buffer,\r
ed838d0c 1935 //\r
1936 InsertKeyCode (\r
1937 &(UsbKeyboardDevice->KeyboardBuffer),\r
1938 UsbKeyboardDevice->RepeatKey,\r
b4e73a63 1939 TRUE\r
ed838d0c 1940 );\r
1941\r
1942 //\r
e15c65a3 1943 // Set repeat rate for next repeat key generation.\r
ed838d0c 1944 //\r
1945 gBS->SetTimer (\r
5899f27e 1946 UsbKeyboardDevice->RepeatTimer,\r
1947 TimerRelative,\r
1948 USBKBD_REPEAT_RATE\r
1949 );\r
ed838d0c 1950 }\r
1951}\r
1952\r
1953\r
1954/**\r
b4e73a63 1955 Handler for Delayed Recovery event.\r
1956\r
1957 This function is the handler for Delayed Recovery event triggered\r
1958 by timer.\r
1959 After a device error occurs, the event would be triggered\r
1960 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY\r
1961 is defined in USB standard for error handling.\r
ed838d0c 1962\r
1963 @param Event The Delayed Recovery event.\r
1964 @param Context Points to the USB_KB_DEV instance.\r
1965\r
ed838d0c 1966**/\r
1967VOID\r
1968EFIAPI\r
1969USBKeyboardRecoveryHandler (\r
1970 IN EFI_EVENT Event,\r
1971 IN VOID *Context\r
1972 )\r
1973{\r
1974\r
1975 USB_KB_DEV *UsbKeyboardDevice;\r
1976 EFI_USB_IO_PROTOCOL *UsbIo;\r
1977 UINT8 PacketSize;\r
1978\r
1979 UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
1980\r
1981 UsbIo = UsbKeyboardDevice->UsbIo;\r
1982\r
1983 PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
1984\r
5899f27e 1985 //\r
1986 // Re-submit Asynchronous Interrupt Transfer for recovery.\r
1987 //\r
ed838d0c 1988 UsbIo->UsbAsyncInterruptTransfer (\r
5899f27e 1989 UsbIo,\r
1990 UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
1991 TRUE,\r
1992 UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
1993 PacketSize,\r
1994 KeyboardHandler,\r
1995 UsbKeyboardDevice\r
1996 );\r
ed838d0c 1997}\r
EFI Development Kit II mirror for PVE