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