2 Helper functions for USB Keyboard Driver.
4 Copyright (c) 2004 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // Default English keyboard layout
19 // Format:<efi key>, <unicode without shift>, <unicode with shift>, <Modifier>, <AffectedAttribute>
21 // According to Universal Serial Bus HID Usage Tables document ver 1.12,
22 // a Boot Keyboard should support the keycode range from 0x0 to 0x65 and 0xE0 to 0xE7.
23 // 0x0 to 0x3 are reserved for typical keyboard status or keyboard errors, so they are excluded.
25 UINT8 KeyboardLayoutTable
[NUMBER_OF_VALID_USB_KEYCODE
][5] = {
26 {EfiKeyC1
, 'a', 'A', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x04
27 {EfiKeyB5
, 'b', 'B', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x05
28 {EfiKeyB3
, 'c', 'C', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x06
29 {EfiKeyC3
, 'd', 'D', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x07
30 {EfiKeyD3
, 'e', 'E', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x08
31 {EfiKeyC4
, 'f', 'F', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x09
32 {EfiKeyC5
, 'g', 'G', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0A
33 {EfiKeyC6
, 'h', 'H', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0B
34 {EfiKeyD8
, 'i', 'I', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0C
35 {EfiKeyC7
, 'j', 'J', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0D
36 {EfiKeyC8
, 'k', 'K', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0E
37 {EfiKeyC9
, 'l', 'L', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x0F
38 {EfiKeyB7
, 'm', 'M', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x10
39 {EfiKeyB6
, 'n', 'N', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x11
40 {EfiKeyD9
, 'o', 'O', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x12
41 {EfiKeyD10
, 'p', 'P', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x13
42 {EfiKeyD1
, 'q', 'Q', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x14
43 {EfiKeyD4
, 'r', 'R', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x15
44 {EfiKeyC2
, 's', 'S', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x16
45 {EfiKeyD5
, 't', 'T', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x17
46 {EfiKeyD7
, 'u', 'U', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x18
47 {EfiKeyB4
, 'v', 'V', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x19
48 {EfiKeyD2
, 'w', 'W', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x1A
49 {EfiKeyB2
, 'x', 'X', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x1B
50 {EfiKeyD6
, 'y', 'Y', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x1C
51 {EfiKeyB1
, 'z', 'Z', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
}, // 0x1D
52 {EfiKeyE1
, '1', '!', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x1E
53 {EfiKeyE2
, '2', '@', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x1F
54 {EfiKeyE3
, '3', '#', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x20
55 {EfiKeyE4
, '4', '$', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x21
56 {EfiKeyE5
, '5', '%', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x22
57 {EfiKeyE6
, '6', '^', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x23
58 {EfiKeyE7
, '7', '&', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x24
59 {EfiKeyE8
, '8', '*', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x25
60 {EfiKeyE9
, '9', '(', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x26
61 {EfiKeyE10
, '0', ')', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x27
62 {EfiKeyEnter
, 0x0d, 0x0d, EFI_NULL_MODIFIER
, 0}, // 0x28 Enter
63 {EfiKeyEsc
, 0x1b, 0x1b, EFI_NULL_MODIFIER
, 0}, // 0x29 Esc
64 {EfiKeyBackSpace
, 0x08, 0x08, EFI_NULL_MODIFIER
, 0}, // 0x2A Backspace
65 {EfiKeyTab
, 0x09, 0x09, EFI_NULL_MODIFIER
, 0}, // 0x2B Tab
66 {EfiKeySpaceBar
, ' ', ' ', EFI_NULL_MODIFIER
, 0}, // 0x2C Spacebar
67 {EfiKeyE11
, '-', '_', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x2D
68 {EfiKeyE12
, '=', '+', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x2E
69 {EfiKeyD11
, '[', '{', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x2F
70 {EfiKeyD12
, ']', '}', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x30
71 {EfiKeyD13
, '\\', '|', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x31
72 {EfiKeyC12
, '\\', '|', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x32 Keyboard Non-US # and ~
73 {EfiKeyC10
, ';', ':', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x33
74 {EfiKeyC11
, '\'', '"', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x34
75 {EfiKeyE0
, '`', '~', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x35 Keyboard Grave Accent and Tlide
76 {EfiKeyB8
, ',', '<', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x36
77 {EfiKeyB9
, '.', '>', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x37
78 {EfiKeyB10
, '/', '?', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x38
79 {EfiKeyCapsLock
, 0x00, 0x00, EFI_CAPS_LOCK_MODIFIER
, 0}, // 0x39 CapsLock
80 {EfiKeyF1
, 0x00, 0x00, EFI_FUNCTION_KEY_ONE_MODIFIER
, 0}, // 0x3A
81 {EfiKeyF2
, 0x00, 0x00, EFI_FUNCTION_KEY_TWO_MODIFIER
, 0}, // 0x3B
82 {EfiKeyF3
, 0x00, 0x00, EFI_FUNCTION_KEY_THREE_MODIFIER
, 0}, // 0x3C
83 {EfiKeyF4
, 0x00, 0x00, EFI_FUNCTION_KEY_FOUR_MODIFIER
, 0}, // 0x3D
84 {EfiKeyF5
, 0x00, 0x00, EFI_FUNCTION_KEY_FIVE_MODIFIER
, 0}, // 0x3E
85 {EfiKeyF6
, 0x00, 0x00, EFI_FUNCTION_KEY_SIX_MODIFIER
, 0}, // 0x3F
86 {EfiKeyF7
, 0x00, 0x00, EFI_FUNCTION_KEY_SEVEN_MODIFIER
, 0}, // 0x40
87 {EfiKeyF8
, 0x00, 0x00, EFI_FUNCTION_KEY_EIGHT_MODIFIER
, 0}, // 0x41
88 {EfiKeyF9
, 0x00, 0x00, EFI_FUNCTION_KEY_NINE_MODIFIER
, 0}, // 0x42
89 {EfiKeyF10
, 0x00, 0x00, EFI_FUNCTION_KEY_TEN_MODIFIER
, 0}, // 0x43
90 {EfiKeyF11
, 0x00, 0x00, EFI_FUNCTION_KEY_ELEVEN_MODIFIER
, 0}, // 0x44 F11
91 {EfiKeyF12
, 0x00, 0x00, EFI_FUNCTION_KEY_TWELVE_MODIFIER
, 0}, // 0x45 F12
92 {EfiKeyPrint
, 0x00, 0x00, EFI_PRINT_MODIFIER
, 0}, // 0x46 PrintScreen
93 {EfiKeySLck
, 0x00, 0x00, EFI_SCROLL_LOCK_MODIFIER
, 0}, // 0x47 Scroll Lock
94 {EfiKeyPause
, 0x00, 0x00, EFI_PAUSE_MODIFIER
, 0}, // 0x48 Pause
95 {EfiKeyIns
, 0x00, 0x00, EFI_INSERT_MODIFIER
, 0}, // 0x49
96 {EfiKeyHome
, 0x00, 0x00, EFI_HOME_MODIFIER
, 0}, // 0x4A
97 {EfiKeyPgUp
, 0x00, 0x00, EFI_PAGE_UP_MODIFIER
, 0}, // 0x4B
98 {EfiKeyDel
, 0x00, 0x00, EFI_DELETE_MODIFIER
, 0}, // 0x4C
99 {EfiKeyEnd
, 0x00, 0x00, EFI_END_MODIFIER
, 0}, // 0x4D
100 {EfiKeyPgDn
, 0x00, 0x00, EFI_PAGE_DOWN_MODIFIER
, 0}, // 0x4E
101 {EfiKeyRightArrow
, 0x00, 0x00, EFI_RIGHT_ARROW_MODIFIER
, 0}, // 0x4F
102 {EfiKeyLeftArrow
, 0x00, 0x00, EFI_LEFT_ARROW_MODIFIER
, 0}, // 0x50
103 {EfiKeyDownArrow
, 0x00, 0x00, EFI_DOWN_ARROW_MODIFIER
, 0}, // 0x51
104 {EfiKeyUpArrow
, 0x00, 0x00, EFI_UP_ARROW_MODIFIER
, 0}, // 0x52
105 {EfiKeyNLck
, 0x00, 0x00, EFI_NUM_LOCK_MODIFIER
, 0}, // 0x53 NumLock
106 {EfiKeySlash
, '/', '/', EFI_NULL_MODIFIER
, 0}, // 0x54
107 {EfiKeyAsterisk
, '*', '*', EFI_NULL_MODIFIER
, 0}, // 0x55
108 {EfiKeyMinus
, '-', '-', EFI_NULL_MODIFIER
, 0}, // 0x56
109 {EfiKeyPlus
, '+', '+', EFI_NULL_MODIFIER
, 0}, // 0x57
110 {EfiKeyEnter
, 0x0d, 0x0d, EFI_NULL_MODIFIER
, 0}, // 0x58
111 {EfiKeyOne
, '1', '1', EFI_END_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x59
112 {EfiKeyTwo
, '2', '2', EFI_DOWN_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5A
113 {EfiKeyThree
, '3', '3', EFI_PAGE_DOWN_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5B
114 {EfiKeyFour
, '4', '4', EFI_LEFT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5C
115 {EfiKeyFive
, '5', '5', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5D
116 {EfiKeySix
, '6', '6', EFI_RIGHT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5E
117 {EfiKeySeven
, '7', '7', EFI_HOME_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x5F
118 {EfiKeyEight
, '8', '8', EFI_UP_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x60
119 {EfiKeyNine
, '9', '9', EFI_PAGE_UP_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x61
120 {EfiKeyZero
, '0', '0', EFI_INSERT_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x62
121 {EfiKeyPeriod
, '.', '.', EFI_DELETE_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
}, // 0x63
122 {EfiKeyB0
, '\\', '|', EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
}, // 0x64 Keyboard Non-US \ and |
123 {EfiKeyA4
, 0x00, 0x00, EFI_MENU_MODIFIER
, 0}, // 0x65 Keyboard Application
125 {EfiKeyLCtrl
, 0, 0, EFI_LEFT_CONTROL_MODIFIER
, 0}, // 0xe0
126 {EfiKeyLShift
, 0, 0, EFI_LEFT_SHIFT_MODIFIER
, 0}, // 0xe1
127 {EfiKeyLAlt
, 0, 0, EFI_LEFT_ALT_MODIFIER
, 0}, // 0xe2
128 {EfiKeyA0
, 0, 0, EFI_LEFT_LOGO_MODIFIER
, 0}, // 0xe3
129 {EfiKeyRCtrl
, 0, 0, EFI_RIGHT_CONTROL_MODIFIER
, 0}, // 0xe4
130 {EfiKeyRShift
, 0, 0, EFI_RIGHT_SHIFT_MODIFIER
, 0}, // 0xe5
131 {EfiKeyA2
, 0, 0, EFI_RIGHT_ALT_MODIFIER
, 0}, // 0xe6
132 {EfiKeyA3
, 0, 0, EFI_RIGHT_LOGO_MODIFIER
, 0}, // 0xe7
136 // EFI_KEY to USB Keycode convertion table
137 // EFI_KEY is defined in UEFI spec.
138 // USB Keycode is defined in USB HID Firmware spec.
140 UINT8 EfiKeyToUsbKeyCodeConvertionTable
[] = {
144 0x2c, // EfiKeySpaceBar
149 0x50, // EfiKeyLeftArrow
150 0x51, // EfiKeyDownArrow
151 0x4F, // EfiKeyRightArrow
153 0x63, // EfiKeyPeriod
155 0xe1, // EfiKeyLShift
167 0xe5, // EfiKeyRShift
168 0x52, // EfiKeyUpArrow
172 0x39, // EfiKeyCapsLock
222 0x2A, // EfiKeyBackSpace
228 0x55, // EfiKeyAsterisk
249 // Keyboard modifier value to EFI Scan Code convertion table
250 // EFI Scan Code and the modifier values are defined in UEFI spec.
252 UINT8 ModifierValueToEfiScanCodeConvertionTable
[] = {
253 SCAN_NULL
, // EFI_NULL_MODIFIER
254 SCAN_NULL
, // EFI_LEFT_CONTROL_MODIFIER
255 SCAN_NULL
, // EFI_RIGHT_CONTROL_MODIFIER
256 SCAN_NULL
, // EFI_LEFT_ALT_MODIFIER
257 SCAN_NULL
, // EFI_RIGHT_ALT_MODIFIER
258 SCAN_NULL
, // EFI_ALT_GR_MODIFIER
259 SCAN_INSERT
, // EFI_INSERT_MODIFIER
260 SCAN_DELETE
, // EFI_DELETE_MODIFIER
261 SCAN_PAGE_DOWN
, // EFI_PAGE_DOWN_MODIFIER
262 SCAN_PAGE_UP
, // EFI_PAGE_UP_MODIFIER
263 SCAN_HOME
, // EFI_HOME_MODIFIER
264 SCAN_END
, // EFI_END_MODIFIER
265 SCAN_NULL
, // EFI_LEFT_SHIFT_MODIFIER
266 SCAN_NULL
, // EFI_RIGHT_SHIFT_MODIFIER
267 SCAN_NULL
, // EFI_CAPS_LOCK_MODIFIER
268 SCAN_NULL
, // EFI_NUM_LOCK_MODIFIER
269 SCAN_LEFT
, // EFI_LEFT_ARROW_MODIFIER
270 SCAN_RIGHT
, // EFI_RIGHT_ARROW_MODIFIER
271 SCAN_DOWN
, // EFI_DOWN_ARROW_MODIFIER
272 SCAN_UP
, // EFI_UP_ARROW_MODIFIER
273 SCAN_NULL
, // EFI_NS_KEY_MODIFIER
274 SCAN_NULL
, // EFI_NS_KEY_DEPENDENCY_MODIFIER
275 SCAN_F1
, // EFI_FUNCTION_KEY_ONE_MODIFIER
276 SCAN_F2
, // EFI_FUNCTION_KEY_TWO_MODIFIER
277 SCAN_F3
, // EFI_FUNCTION_KEY_THREE_MODIFIER
278 SCAN_F4
, // EFI_FUNCTION_KEY_FOUR_MODIFIER
279 SCAN_F5
, // EFI_FUNCTION_KEY_FIVE_MODIFIER
280 SCAN_F6
, // EFI_FUNCTION_KEY_SIX_MODIFIER
281 SCAN_F7
, // EFI_FUNCTION_KEY_SEVEN_MODIFIER
282 SCAN_F8
, // EFI_FUNCTION_KEY_EIGHT_MODIFIER
283 SCAN_F9
, // EFI_FUNCTION_KEY_NINE_MODIFIER
284 SCAN_F10
, // EFI_FUNCTION_KEY_TEN_MODIFIER
285 SCAN_F11
, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER
286 SCAN_F12
, // EFI_FUNCTION_KEY_TWELVE_MODIFIER
289 EFI_GUID mKeyboardLayoutEventGuid
= EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
;
292 Initialize Key Convertion Table by using default keyboard layout.
294 @param UsbKeyboardDevice The USB_KB_DEV instance.
299 LoadDefaultKeyboardLayout (
300 IN OUT USB_KB_DEV
*UsbKeyboardDevice
304 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
307 // Construct KeyConvertionTable by default keyboard layout
309 KeyDescriptor
= &UsbKeyboardDevice
->KeyConvertionTable
[0];
311 for (Index
= 0; Index
< (NUMBER_OF_VALID_USB_KEYCODE
); Index
++) {
312 KeyDescriptor
->Key
= (EFI_KEY
) KeyboardLayoutTable
[Index
][0];
313 KeyDescriptor
->Unicode
= KeyboardLayoutTable
[Index
][1];
314 KeyDescriptor
->ShiftedUnicode
= KeyboardLayoutTable
[Index
][2];
315 KeyDescriptor
->AltGrUnicode
= 0;
316 KeyDescriptor
->ShiftedAltGrUnicode
= 0;
317 KeyDescriptor
->Modifier
= KeyboardLayoutTable
[Index
][3];
318 KeyDescriptor
->AffectedAttribute
= KeyboardLayoutTable
[Index
][4];
325 Uses USB I/O to check whether the device is a USB keyboard device.
327 @param UsbIo Pointer to a USB I/O protocol instance.
329 @retval TRUE Device is a USB keyboard device.
330 @retval FALSE Device is a not USB keyboard device.
336 IN EFI_USB_IO_PROTOCOL
*UsbIo
340 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
343 // Get the default interface descriptor
345 Status
= UsbIo
->UsbGetInterfaceDescriptor (
350 if (EFI_ERROR (Status
)) {
354 if (InterfaceDescriptor
.InterfaceClass
== CLASS_HID
&&
355 InterfaceDescriptor
.InterfaceSubClass
== SUBCLASS_BOOT
&&
356 InterfaceDescriptor
.InterfaceProtocol
== PROTOCOL_KEYBOARD
365 Get current keyboard layout from HII database.
367 @return Pointer to HII Keyboard Layout.
368 NULL means failure occurred while trying to get keyboard layout.
371 EFI_HII_KEYBOARD_LAYOUT
*
373 GetCurrentKeyboardLayout (
378 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
379 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
383 // Locate HII Database Protocol
385 Status
= gBS
->LocateProtocol (
386 &gEfiHiiDatabaseProtocolGuid
,
388 (VOID
**) &HiiDatabase
390 if (EFI_ERROR (Status
)) {
395 // Get current keyboard layout from HII database
398 KeyboardLayout
= NULL
;
399 Status
= HiiDatabase
->GetKeyboardLayout (
405 if (Status
== EFI_BUFFER_TOO_SMALL
) {
406 KeyboardLayout
= AllocatePool (Length
);
407 ASSERT (KeyboardLayout
!= NULL
);
409 Status
= HiiDatabase
->GetKeyboardLayout (
415 if (EFI_ERROR (Status
)) {
416 FreePool (KeyboardLayout
);
417 KeyboardLayout
= NULL
;
421 return KeyboardLayout
;
425 Find Key Descriptor in Key Convertion Table given its USB keycode.
427 @param UsbKeyboardDevice The USB_KB_DEV instance.
428 @param KeyCode USB Keycode.
430 @return The Key Descriptor in Key Convertion Table.
431 NULL means not found.
437 IN USB_KB_DEV
*UsbKeyboardDevice
,
444 // Make sure KeyCode is in the range of [0x4, 0x65] or [0xe0, 0xe7]
446 if ((!USBKBD_VALID_KEYCODE (KeyCode
)) || ((KeyCode
> 0x65) && (KeyCode
< 0xe0)) || (KeyCode
> 0xe7)) {
451 // Calculate the index of Key Descriptor in Key Convertion Table
453 if (KeyCode
<= 0x65) {
454 Index
= (UINT8
) (KeyCode
- 4);
456 Index
= (UINT8
) (KeyCode
- 0xe0 + NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
);
459 return &UsbKeyboardDevice
->KeyConvertionTable
[Index
];
463 Find Non-Spacing key for given Key descriptor.
465 @param UsbKeyboardDevice The USB_KB_DEV instance.
466 @param KeyDescriptor Key descriptor.
468 @return The Non-Spacing key corresponding to KeyDescriptor
469 NULL means not found.
475 IN USB_KB_DEV
*UsbKeyboardDevice
,
476 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
480 LIST_ENTRY
*NsKeyList
;
481 USB_NS_KEY
*UsbNsKey
;
483 NsKeyList
= &UsbKeyboardDevice
->NsKeyList
;
484 Link
= GetFirstNode (NsKeyList
);
485 while (!IsNull (NsKeyList
, Link
)) {
486 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
488 if (UsbNsKey
->NsKey
[0].Key
== KeyDescriptor
->Key
) {
492 Link
= GetNextNode (NsKeyList
, Link
);
499 Find physical key definition for a given key descriptor.
501 For a specified non-spacing key, there are a list of physical
502 keys following it. This function traverses the list of
503 physical keys and tries to find the physical key matching
506 @param UsbNsKey The non-spacing key information.
507 @param KeyDescriptor The key descriptor.
509 @return The physical key definition.
510 If no physical key is found, parameter KeyDescriptor is returned.
516 IN USB_NS_KEY
*UsbNsKey
,
517 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
521 EFI_KEY_DESCRIPTOR
*PhysicalKey
;
523 PhysicalKey
= &UsbNsKey
->NsKey
[1];
524 for (Index
= 0; Index
< UsbNsKey
->KeyCount
; Index
++) {
525 if (KeyDescriptor
->Key
== PhysicalKey
->Key
) {
533 // No children definition matched, return original key
535 return KeyDescriptor
;
539 The notification function for EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID.
541 This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
542 group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
543 It tries to get curent keyboard layout from HII database.
545 @param Event Event being signaled.
546 @param Context Points to USB_KB_DEV instance.
551 SetKeyboardLayoutEvent (
556 USB_KB_DEV
*UsbKeyboardDevice
;
557 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
558 EFI_KEY_DESCRIPTOR TempKey
;
559 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
560 EFI_KEY_DESCRIPTOR
*TableEntry
;
561 EFI_KEY_DESCRIPTOR
*NsKey
;
562 USB_NS_KEY
*UsbNsKey
;
568 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
571 // Try to get current keyboard layout from HII database
573 KeyboardLayout
= GetCurrentKeyboardLayout ();
574 if (KeyboardLayout
== NULL
) {
579 // Re-allocate resource for KeyConvertionTable
581 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
582 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
583 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
586 // Traverse the list of key descriptors following the header of EFI_HII_KEYBOARD_LAYOUT
588 KeyDescriptor
= (EFI_KEY_DESCRIPTOR
*) (((UINT8
*) KeyboardLayout
) + sizeof (EFI_HII_KEYBOARD_LAYOUT
));
589 for (Index
= 0; Index
< KeyboardLayout
->DescriptorCount
; Index
++) {
591 // Copy from HII keyboard layout package binary for alignment
593 CopyMem (&TempKey
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
596 // Fill the key into KeyConvertionTable, whose index is calculated from USB keycode.
598 KeyCode
= EfiKeyToUsbKeyCodeConvertionTable
[(UINT8
) (TempKey
.Key
)];
599 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
600 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
603 // For non-spacing key, create the list with a non-spacing key followed by physical keys.
605 if (TempKey
.Modifier
== EFI_NS_KEY_MODIFIER
) {
606 UsbNsKey
= AllocatePool (sizeof (USB_NS_KEY
));
607 ASSERT (UsbNsKey
!= NULL
);
610 // Search for sequential children physical key definitions
613 NsKey
= KeyDescriptor
+ 1;
614 for (Index2
= Index
+ 1; Index2
< KeyboardLayout
->DescriptorCount
; Index2
++) {
615 CopyMem (&TempKey
, NsKey
, sizeof (EFI_KEY_DESCRIPTOR
));
616 if (TempKey
.Modifier
& EFI_NS_KEY_DEPENDENCY_MODIFIER
) {
624 UsbNsKey
->Signature
= USB_NS_KEY_SIGNATURE
;
625 UsbNsKey
->KeyCount
= KeyCount
;
626 UsbNsKey
->NsKey
= AllocateCopyPool (
627 (KeyCount
+ 1) * sizeof (EFI_KEY_DESCRIPTOR
),
630 InsertTailList (&UsbKeyboardDevice
->NsKeyList
, &UsbNsKey
->Link
);
633 // Skip over the child physical keys
636 KeyDescriptor
+= KeyCount
;
643 // There are two EfiKeyEnter, duplicate its key descriptor
645 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, 0x58);
646 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, 0x28);
647 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
649 FreePool (KeyboardLayout
);
653 Destroy resources for keyboard layout.
655 @param UsbKeyboardDevice The USB_KB_DEV instance.
660 ReleaseKeyboardLayoutResources (
661 IN OUT USB_KB_DEV
*UsbKeyboardDevice
664 USB_NS_KEY
*UsbNsKey
;
667 if (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
) {
668 FreePool (UsbKeyboardDevice
->KeyConvertionTable
);
670 UsbKeyboardDevice
->KeyConvertionTable
= NULL
;
672 while (!IsListEmpty (&UsbKeyboardDevice
->NsKeyList
)) {
673 Link
= GetFirstNode (&UsbKeyboardDevice
->NsKeyList
);
674 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
675 RemoveEntryList (&UsbNsKey
->Link
);
677 FreePool (UsbNsKey
->NsKey
);
683 Initialize USB keyboard layout.
685 This function initializes Key Convertion Table for the USB keyboard device.
686 It first tries to retrieve layout from HII database. If failed and default
687 layout is enabled, then it just uses the default layout.
689 @param UsbKeyboardDevice The USB_KB_DEV instance.
691 @retval EFI_SUCCESS Initialization succeeded.
692 @retval EFI_NOT_READY Keyboard layout cannot be retrieve from HII
693 database, and default layout is disabled.
694 @retval Other Fail to register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group.
700 OUT USB_KB_DEV
*UsbKeyboardDevice
703 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
706 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
707 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
709 InitializeListHead (&UsbKeyboardDevice
->NsKeyList
);
710 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
711 UsbKeyboardDevice
->KeyboardLayoutEvent
= NULL
;
714 // Register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
715 // which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
717 Status
= gBS
->CreateEventEx (
720 SetKeyboardLayoutEvent
,
722 &mKeyboardLayoutEventGuid
,
723 &UsbKeyboardDevice
->KeyboardLayoutEvent
725 if (EFI_ERROR (Status
)) {
729 KeyboardLayout
= GetCurrentKeyboardLayout ();
730 if (KeyboardLayout
!= NULL
) {
732 // If current keyboard layout is successfully retrieved from HII database,
733 // force to initialize the keyboard layout.
735 gBS
->SignalEvent (UsbKeyboardDevice
->KeyboardLayoutEvent
);
737 if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver
)) {
739 // If no keyboard layout can be retrieved from HII database, and default layout
740 // is disabled, then return EFI_NOT_READY.
742 return EFI_NOT_READY
;
745 // If no keyboard layout can be retrieved from HII database, and default layout
746 // is enabled, then load the default keyboard layout.
748 LoadDefaultKeyboardLayout (UsbKeyboardDevice
);
756 Initialize USB keyboard device and all private data structures.
758 @param UsbKeyboardDevice The USB_KB_DEV instance.
760 @retval EFI_SUCCESS Initialization is successful.
761 @retval EFI_DEVICE_ERROR Keyboard initialization failed.
767 IN OUT USB_KB_DEV
*UsbKeyboardDevice
775 UINT32 TransferResult
;
777 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
779 PcdGet32 (PcdStatusCodeValueKeyboardSelfTest
),
780 UsbKeyboardDevice
->DevicePath
783 InitUSBKeyBuffer (&(UsbKeyboardDevice
->KeyboardBuffer
));
786 // Uses default configuration to configure the USB keyboard device.
789 Status
= UsbSetConfiguration (
790 UsbKeyboardDevice
->UsbIo
,
791 (UINT16
) ConfigValue
,
794 if (EFI_ERROR (Status
)) {
796 // If configuration could not be set here, it means
797 // the keyboard interface has some errors and could
798 // not be initialized
800 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
801 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
802 PcdGet32 (PcdStatusCodeValueKeyboardInterfaceError
),
803 UsbKeyboardDevice
->DevicePath
806 return EFI_DEVICE_ERROR
;
809 UsbGetProtocolRequest (
810 UsbKeyboardDevice
->UsbIo
,
811 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
815 // Set boot protocol for the USB Keyboard.
816 // This driver only supports boot protocol.
818 if (Protocol
!= BOOT_PROTOCOL
) {
819 UsbSetProtocolRequest (
820 UsbKeyboardDevice
->UsbIo
,
821 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
827 // ReportId is zero, which means the idle rate applies to all input reports.
831 // Duration is zero, which means the duration is infinite.
832 // so the endpoint will inhibit reporting forever,
833 // and only reporting when a change is detected in the report data.
837 UsbKeyboardDevice
->UsbIo
,
838 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
843 UsbKeyboardDevice
->CtrlOn
= FALSE
;
844 UsbKeyboardDevice
->AltOn
= FALSE
;
845 UsbKeyboardDevice
->ShiftOn
= FALSE
;
846 UsbKeyboardDevice
->NumLockOn
= FALSE
;
847 UsbKeyboardDevice
->CapsOn
= FALSE
;
848 UsbKeyboardDevice
->ScrollOn
= FALSE
;
850 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
851 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
852 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
853 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
854 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
855 UsbKeyboardDevice
->RightAltOn
= FALSE
;
856 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
857 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
858 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
859 UsbKeyboardDevice
->SysReqOn
= FALSE
;
861 UsbKeyboardDevice
->AltGrOn
= FALSE
;
863 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
866 // Sync the initial state of lights on keyboard.
868 SetKeyLED (UsbKeyboardDevice
);
870 ZeroMem (UsbKeyboardDevice
->LastKeyCodeArray
, sizeof (UINT8
) * 8);
873 // Create event for repeat keys' generation.
875 if (UsbKeyboardDevice
->RepeatTimer
!= NULL
) {
876 gBS
->CloseEvent (UsbKeyboardDevice
->RepeatTimer
);
877 UsbKeyboardDevice
->RepeatTimer
= NULL
;
881 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
883 USBKeyboardRepeatHandler
,
885 &UsbKeyboardDevice
->RepeatTimer
889 // Create event for delayed recovery, which deals with device error.
891 if (UsbKeyboardDevice
->DelayedRecoveryEvent
!= NULL
) {
892 gBS
->CloseEvent (UsbKeyboardDevice
->DelayedRecoveryEvent
);
893 UsbKeyboardDevice
->DelayedRecoveryEvent
= NULL
;
897 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
899 USBKeyboardRecoveryHandler
,
901 &UsbKeyboardDevice
->DelayedRecoveryEvent
909 Handler function for USB keyboard's asynchronous interrupt transfer.
911 This function is the handler function for USB keyboard's asynchronous interrupt transfer
912 to manage the keyboard. It parses the USB keyboard input report, and inserts data to
913 keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key
914 is also set accordingly.
916 @param Data A pointer to a buffer that is filled with key data which is
917 retrieved via asynchronous interrupt transfer.
918 @param DataLength Indicates the size of the data buffer.
919 @param Context Pointing to USB_KB_DEV instance.
920 @param Result Indicates the result of the asynchronous interrupt transfer.
922 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.
923 @retval EFI_DEVICE_ERROR Hardware error occurs.
935 USB_KB_DEV
*UsbKeyboardDevice
;
936 EFI_USB_IO_PROTOCOL
*UsbIo
;
937 UINT8
*CurKeyCodeBuffer
;
938 UINT8
*OldKeyCodeBuffer
;
939 UINT8 CurModifierMap
;
940 UINT8 OldModifierMap
;
951 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
953 ASSERT (Context
!= NULL
);
956 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
957 UsbIo
= UsbKeyboardDevice
->UsbIo
;
960 // Analyzes Result and performs corresponding action.
962 if (Result
!= EFI_USB_NOERROR
) {
964 // Some errors happen during the process
966 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
967 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
968 PcdGet32 (PcdStatusCodeValueKeyboardInputError
),
969 UsbKeyboardDevice
->DevicePath
973 // Stop the repeat key generation if any
975 UsbKeyboardDevice
->RepeatKey
= 0;
978 UsbKeyboardDevice
->RepeatTimer
,
983 if ((Result
& EFI_USB_ERR_STALL
) == EFI_USB_ERR_STALL
) {
984 UsbClearEndpointHalt (
986 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
992 // Delete & Submit this interrupt again
993 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.
995 UsbIo
->UsbAsyncInterruptTransfer (
997 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1005 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.
1008 UsbKeyboardDevice
->DelayedRecoveryEvent
,
1010 EFI_USB_INTERRUPT_DELAY
1013 return EFI_DEVICE_ERROR
;
1017 // If no error and no data, just return EFI_SUCCESS.
1019 if (DataLength
== 0 || Data
== NULL
) {
1024 // Following code checks current keyboard input report against old key code buffer.
1025 // According to USB HID Firmware Specification, the report consists of 8 bytes.
1026 // Byte 0 is map of Modifier keys.
1027 // Byte 1 is reserved.
1028 // Bytes 2 to 7 are keycodes.
1030 CurKeyCodeBuffer
= (UINT8
*) Data
;
1031 OldKeyCodeBuffer
= UsbKeyboardDevice
->LastKeyCodeArray
;
1034 // Checks for new key stroke.
1036 for (Index
= 0; Index
< 8; Index
++) {
1037 if (OldKeyCodeBuffer
[Index
] != CurKeyCodeBuffer
[Index
]) {
1043 // If no new key, return EFI_SUCCESS immediately.
1050 // Parse the modifier key, which is the first byte of keyboard input report.
1052 CurModifierMap
= CurKeyCodeBuffer
[0];
1053 OldModifierMap
= OldKeyCodeBuffer
[0];
1056 // Handle modifier key's pressing or releasing situation.
1057 // According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:
1058 // Bit0: Left Control, Keycode: 0xe0
1059 // Bit1: Left Shift, Keycode: 0xe1
1060 // Bit2: Left Alt, Keycode: 0xe2
1061 // Bit3: Left GUI, Keycode: 0xe3
1062 // Bit4: Right Control, Keycode: 0xe4
1063 // Bit5: Right Shift, Keycode: 0xe5
1064 // Bit6: Right Alt, Keycode: 0xe6
1065 // Bit7: Right GUI, Keycode: 0xe7
1067 for (Index
= 0; Index
< 8; Index
++) {
1068 Mask
= (UINT8
) (1 << Index
);
1069 if ((CurModifierMap
& Mask
) != (OldModifierMap
& Mask
)) {
1071 // If current modifier key is up, then CurModifierMap & Mask = 0;
1072 // otherwise it is a non-zero value.
1073 // Insert the changed modifier key into key buffer.
1075 Down
= (BOOLEAN
) ((CurModifierMap
& Mask
) != 0);
1076 InsertKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), (UINT8
) (0xe0 + Index
), Down
);
1081 // Handle normal key's releasing situation
1082 // Bytes 2 to 7 are for normal keycodes
1085 for (Index
= 2; Index
< 8; Index
++) {
1087 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index
])) {
1091 // For any key in old keycode buffer, if it is not in current keycode buffer,
1092 // then it is released. Otherwise, it is not released.
1095 for (Index2
= 2; Index2
< 8; Index2
++) {
1097 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index2
])) {
1101 if (OldKeyCodeBuffer
[Index
] == CurKeyCodeBuffer
[Index2
]) {
1109 &(UsbKeyboardDevice
->KeyboardBuffer
),
1110 OldKeyCodeBuffer
[Index
],
1114 // The original repeat key is released.
1116 if (OldKeyCodeBuffer
[Index
] == UsbKeyboardDevice
->RepeatKey
) {
1117 UsbKeyboardDevice
->RepeatKey
= 0;
1123 // If original repeat key is released, cancel the repeat timer
1125 if (UsbKeyboardDevice
->RepeatKey
== 0) {
1127 UsbKeyboardDevice
->RepeatTimer
,
1134 // Handle normal key's pressing situation
1137 for (Index
= 2; Index
< 8; Index
++) {
1139 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index
])) {
1143 // For any key in current keycode buffer, if it is not in old keycode buffer,
1144 // then it is pressed. Otherwise, it is not pressed.
1147 for (Index2
= 2; Index2
< 8; Index2
++) {
1149 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index2
])) {
1153 if (CurKeyCodeBuffer
[Index
] == OldKeyCodeBuffer
[Index2
]) {
1160 InsertKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), CurKeyCodeBuffer
[Index
], TRUE
);
1163 // Handle repeat key
1165 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, CurKeyCodeBuffer
[Index
]);
1166 ASSERT (KeyDescriptor
!= NULL
);
1168 if (KeyDescriptor
->Modifier
== EFI_NUM_LOCK_MODIFIER
|| KeyDescriptor
->Modifier
== EFI_CAPS_LOCK_MODIFIER
) {
1170 // For NumLock or CapsLock pressed, there is no need to handle repeat key for them.
1172 UsbKeyboardDevice
->RepeatKey
= 0;
1175 // Prepare new repeat key, and clear the original one.
1177 NewRepeatKey
= CurKeyCodeBuffer
[Index
];
1178 UsbKeyboardDevice
->RepeatKey
= 0;
1184 // Update LastKeycodeArray buffer in the UsbKeyboardDevice data structure.
1186 for (Index
= 0; Index
< 8; Index
++) {
1187 UsbKeyboardDevice
->LastKeyCodeArray
[Index
] = CurKeyCodeBuffer
[Index
];
1191 // Pre-process KeyboardBuffer to check if Ctrl + Alt + Del is pressed.
1193 SavedTail
= UsbKeyboardDevice
->KeyboardBuffer
.BufferTail
;
1194 Index
= UsbKeyboardDevice
->KeyboardBuffer
.BufferHead
;
1195 while (Index
!= SavedTail
) {
1196 RemoveKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), &UsbKey
);
1198 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1200 switch (KeyDescriptor
->Modifier
) {
1202 case EFI_LEFT_CONTROL_MODIFIER
:
1203 case EFI_RIGHT_CONTROL_MODIFIER
:
1205 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1207 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1211 case EFI_LEFT_ALT_MODIFIER
:
1212 case EFI_RIGHT_ALT_MODIFIER
:
1214 UsbKeyboardDevice
->AltOn
= TRUE
;
1216 UsbKeyboardDevice
->AltOn
= FALSE
;
1220 case EFI_ALT_GR_MODIFIER
:
1222 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1224 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1229 // For Del Key, check if Ctrl + Alt + Del occurs for reset.
1231 case EFI_DELETE_MODIFIER
:
1233 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1234 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1244 // Insert the key back to the buffer,
1245 // so the key sequence will not be destroyed.
1248 &(UsbKeyboardDevice
->KeyboardBuffer
),
1252 Index
= UsbKeyboardDevice
->KeyboardBuffer
.BufferHead
;
1256 // If there is new key pressed, update the RepeatKey value, and set the
1257 // timer to repeate delay timer
1259 if (NewRepeatKey
!= 0) {
1261 // Sets trigger time to "Repeat Delay Time",
1262 // to trigger the repeat timer when the key is hold long
1266 UsbKeyboardDevice
->RepeatTimer
,
1270 UsbKeyboardDevice
->RepeatKey
= NewRepeatKey
;
1278 Retrieves a USB keycode after parsing the raw data in keyboard buffer.
1280 This function parses keyboard buffer. It updates state of modifier key for
1281 USB_KB_DEV instancem, and returns keycode for output.
1283 @param UsbKeyboardDevice The USB_KB_DEV instance.
1284 @param KeyCode Pointer to the USB keycode for output.
1286 @retval EFI_SUCCESS Keycode successfully parsed.
1287 @retval EFI_NOT_READY Keyboard buffer is not ready for a valid keycode
1293 IN OUT USB_KB_DEV
*UsbKeyboardDevice
,
1298 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1302 while (!IsUSBKeyboardBufferEmpty (&UsbKeyboardDevice
->KeyboardBuffer
)) {
1304 // Pops one raw data off.
1306 RemoveKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), &UsbKey
);
1308 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1309 ASSERT (KeyDescriptor
!= NULL
);
1315 switch (KeyDescriptor
->Modifier
) {
1320 case EFI_LEFT_CONTROL_MODIFIER
:
1321 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
1322 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1324 case EFI_RIGHT_CONTROL_MODIFIER
:
1325 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
1326 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1332 case EFI_LEFT_SHIFT_MODIFIER
:
1333 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1334 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1336 case EFI_RIGHT_SHIFT_MODIFIER
:
1337 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1338 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1344 case EFI_LEFT_ALT_MODIFIER
:
1345 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
1346 UsbKeyboardDevice
->AltOn
= FALSE
;
1348 case EFI_RIGHT_ALT_MODIFIER
:
1349 UsbKeyboardDevice
->RightAltOn
= FALSE
;
1350 UsbKeyboardDevice
->AltOn
= FALSE
;
1354 // Left Logo release
1356 case EFI_LEFT_LOGO_MODIFIER
:
1357 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
1361 // Right Logo release
1363 case EFI_RIGHT_LOGO_MODIFIER
:
1364 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
1370 case EFI_MENU_MODIFIER
:
1371 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
1377 case EFI_PRINT_MODIFIER
:
1378 case EFI_SYS_REQUEST_MODIFIER
:
1379 UsbKeyboardDevice
->SysReqOn
= FALSE
;
1385 case EFI_ALT_GR_MODIFIER
:
1386 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1397 // Analyzes key pressing situation
1399 switch (KeyDescriptor
->Modifier
) {
1404 case EFI_LEFT_CONTROL_MODIFIER
:
1405 UsbKeyboardDevice
->LeftCtrlOn
= TRUE
;
1406 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1409 case EFI_RIGHT_CONTROL_MODIFIER
:
1410 UsbKeyboardDevice
->RightCtrlOn
= TRUE
;
1411 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1418 case EFI_LEFT_SHIFT_MODIFIER
:
1419 UsbKeyboardDevice
->LeftShiftOn
= TRUE
;
1420 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1423 case EFI_RIGHT_SHIFT_MODIFIER
:
1424 UsbKeyboardDevice
->RightShiftOn
= TRUE
;
1425 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1432 case EFI_LEFT_ALT_MODIFIER
:
1433 UsbKeyboardDevice
->LeftAltOn
= TRUE
;
1434 UsbKeyboardDevice
->AltOn
= TRUE
;
1437 case EFI_RIGHT_ALT_MODIFIER
:
1438 UsbKeyboardDevice
->RightAltOn
= TRUE
;
1439 UsbKeyboardDevice
->AltOn
= TRUE
;
1446 case EFI_LEFT_LOGO_MODIFIER
:
1447 UsbKeyboardDevice
->LeftLogoOn
= TRUE
;
1453 case EFI_RIGHT_LOGO_MODIFIER
:
1454 UsbKeyboardDevice
->RightLogoOn
= TRUE
;
1460 case EFI_MENU_MODIFIER
:
1461 UsbKeyboardDevice
->MenuKeyOn
= TRUE
;
1467 case EFI_PRINT_MODIFIER
:
1468 case EFI_SYS_REQUEST_MODIFIER
:
1469 UsbKeyboardDevice
->SysReqOn
= TRUE
;
1476 case EFI_ALT_GR_MODIFIER
:
1477 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1480 case EFI_NUM_LOCK_MODIFIER
:
1484 UsbKeyboardDevice
->NumLockOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->NumLockOn
));
1485 SetKeyLED (UsbKeyboardDevice
);
1489 case EFI_CAPS_LOCK_MODIFIER
:
1493 UsbKeyboardDevice
->CapsOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->CapsOn
));
1494 SetKeyLED (UsbKeyboardDevice
);
1498 case EFI_SCROLL_LOCK_MODIFIER
:
1500 // Toggle ScrollLock
1502 UsbKeyboardDevice
->ScrollOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->ScrollOn
));
1503 SetKeyLED (UsbKeyboardDevice
);
1508 // F11, F12, PrintScreen, Pause/Break
1509 // could not be retrieved via SimpleTextInEx protocol
1511 case EFI_FUNCTION_KEY_ELEVEN_MODIFIER
:
1512 case EFI_FUNCTION_KEY_TWELVE_MODIFIER
:
1513 case EFI_PAUSE_MODIFIER
:
1514 case EFI_BREAK_MODIFIER
:
1526 // When encountering Ctrl + Alt + Del, then warm reset.
1528 if (KeyDescriptor
->Modifier
== EFI_DELETE_MODIFIER
) {
1529 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1530 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1534 *KeyCode
= UsbKey
.KeyCode
;
1538 return EFI_NOT_READY
;
1543 Converts USB Keycode ranging from 0x4 to 0x65 to EFI_INPUT_KEY.
1545 @param UsbKeyboardDevice The USB_KB_DEV instance.
1546 @param KeyCode Indicates the key code that will be interpreted.
1547 @param Key A pointer to a buffer that is filled in with
1548 the keystroke information for the key that
1551 @retval EFI_SUCCESS Success.
1552 @retval EFI_INVALID_PARAMETER KeyCode is not in the range of 0x4 to 0x65.
1553 @retval EFI_INVALID_PARAMETER Translated EFI_INPUT_KEY has zero for both ScanCode and UnicodeChar.
1554 @retval EFI_NOT_READY KeyCode represents a dead key with EFI_NS_KEY_MODIFIER
1555 @retval EFI_DEVICE_ERROR Keyboard layout is invalid.
1560 UsbKeyCodeToEfiInputKey (
1561 IN USB_KB_DEV
*UsbKeyboardDevice
,
1563 OUT EFI_INPUT_KEY
*Key
1566 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1569 // KeyCode must in the range of 0x4 to 0x65
1571 if (!USBKBD_VALID_KEYCODE (KeyCode
)) {
1572 return EFI_INVALID_PARAMETER
;
1574 if ((KeyCode
- 4) >= NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
) {
1575 return EFI_INVALID_PARAMETER
;
1578 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
1579 ASSERT (KeyDescriptor
!= NULL
);
1581 if (KeyDescriptor
->Modifier
== EFI_NS_KEY_MODIFIER
) {
1583 // If this is a dead key with EFI_NS_KEY_MODIFIER, then record it and return.
1585 UsbKeyboardDevice
->CurrentNsKey
= FindUsbNsKey (UsbKeyboardDevice
, KeyDescriptor
);
1586 return EFI_NOT_READY
;
1589 if (UsbKeyboardDevice
->CurrentNsKey
!= NULL
) {
1591 // If this keystroke follows a non-spacing key, then find the descriptor for corresponding
1594 KeyDescriptor
= FindPhysicalKey (UsbKeyboardDevice
->CurrentNsKey
, KeyDescriptor
);
1595 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
1599 // Make sure modifier of Key Descriptor is in the valid range according to UEFI spec.
1601 if (KeyDescriptor
->Modifier
> EFI_FUNCTION_KEY_TWELVE_MODIFIER
) {
1602 return EFI_DEVICE_ERROR
;
1605 Key
->ScanCode
= ModifierValueToEfiScanCodeConvertionTable
[KeyDescriptor
->Modifier
];
1606 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1608 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_STANDARD_SHIFT
)!= 0) {
1609 if (UsbKeyboardDevice
->ShiftOn
) {
1610 Key
->UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1613 // Need not return associated shift state if a class of printable characters that
1614 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'
1616 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1617 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1618 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1621 if (UsbKeyboardDevice
->AltGrOn
) {
1622 Key
->UnicodeChar
= KeyDescriptor
->ShiftedAltGrUnicode
;
1628 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1630 if (UsbKeyboardDevice
->AltGrOn
) {
1631 Key
->UnicodeChar
= KeyDescriptor
->AltGrUnicode
;
1636 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1637 if (UsbKeyboardDevice
->CapsOn
) {
1638 if (Key
->UnicodeChar
== KeyDescriptor
->Unicode
) {
1639 Key
->UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1640 } else if (Key
->UnicodeChar
== KeyDescriptor
->ShiftedUnicode
) {
1641 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1647 // Translate the CTRL-Alpha characters to their corresponding control value
1648 // (ctrl-a = 0x0001 through ctrl-Z = 0x001A)
1650 if (UsbKeyboardDevice
->CtrlOn
) {
1651 if (Key
->UnicodeChar
>= 'a' && Key
->UnicodeChar
<= 'z') {
1652 Key
->UnicodeChar
= (UINT8
) (Key
->UnicodeChar
- 'a' + 1);
1653 } else if (Key
->UnicodeChar
>= 'A' && Key
->UnicodeChar
<= 'Z') {
1654 Key
->UnicodeChar
= (UINT8
) (Key
->UnicodeChar
- 'A' + 1);
1658 if (KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_NUM_LOCK
) {
1660 // For key affected by NumLock, if NumLock is on and Shift is not pressed, then it means
1661 // normal key, instead of original control key. So the ScanCode should be cleaned.
1662 // Otherwise, it means control key, so preserve the EFI Scan Code and clear the unicode keycode.
1664 if ((UsbKeyboardDevice
->NumLockOn
) && (!(UsbKeyboardDevice
->ShiftOn
))) {
1665 Key
->ScanCode
= SCAN_NULL
;
1667 Key
->UnicodeChar
= 0x00;
1672 // Translate Unicode 0x1B (ESC) to EFI Scan Code
1674 if (Key
->UnicodeChar
== 0x1B && Key
->ScanCode
== SCAN_NULL
) {
1675 Key
->ScanCode
= SCAN_ESC
;
1676 Key
->UnicodeChar
= 0x00;
1680 // Not valid for key without both unicode key code and EFI Scan Code.
1682 if (Key
->UnicodeChar
== 0 && Key
->ScanCode
== SCAN_NULL
) {
1683 return EFI_NOT_READY
;
1688 // Save Shift/Toggle state
1690 if (UsbKeyboardDevice
->LeftCtrlOn
) {
1691 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_CONTROL_PRESSED
;
1693 if (UsbKeyboardDevice
->RightCtrlOn
) {
1694 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_CONTROL_PRESSED
;
1696 if (UsbKeyboardDevice
->LeftAltOn
) {
1697 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_ALT_PRESSED
;
1699 if (UsbKeyboardDevice
->RightAltOn
) {
1700 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_ALT_PRESSED
;
1702 if (UsbKeyboardDevice
->LeftShiftOn
) {
1703 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_SHIFT_PRESSED
;
1705 if (UsbKeyboardDevice
->RightShiftOn
) {
1706 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_SHIFT_PRESSED
;
1708 if (UsbKeyboardDevice
->LeftLogoOn
) {
1709 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_LOGO_PRESSED
;
1711 if (UsbKeyboardDevice
->RightLogoOn
) {
1712 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_LOGO_PRESSED
;
1714 if (UsbKeyboardDevice
->MenuKeyOn
) {
1715 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_MENU_KEY_PRESSED
;
1717 if (UsbKeyboardDevice
->SysReqOn
) {
1718 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_SYS_REQ_PRESSED
;
1721 if (UsbKeyboardDevice
->ScrollOn
) {
1722 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_SCROLL_LOCK_ACTIVE
;
1724 if (UsbKeyboardDevice
->NumLockOn
) {
1725 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_NUM_LOCK_ACTIVE
;
1727 if (UsbKeyboardDevice
->CapsOn
) {
1728 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_CAPS_LOCK_ACTIVE
;
1737 Resets USB keyboard buffer.
1739 @param KeyboardBuffer Points to the USB keyboard buffer.
1745 OUT USB_KB_BUFFER
*KeyboardBuffer
1748 ZeroMem (KeyboardBuffer
, sizeof (USB_KB_BUFFER
));
1750 KeyboardBuffer
->BufferHead
= KeyboardBuffer
->BufferTail
;
1755 Check whether USB keyboard buffer is empty.
1757 @param KeyboardBuffer USB keyboard buffer
1759 @retval TRUE Keyboard buffer is empty.
1760 @retval FALSE Keyboard buffer is not empty.
1765 IsUSBKeyboardBufferEmpty (
1766 IN USB_KB_BUFFER
*KeyboardBuffer
1770 // Meet FIFO empty condition
1772 return (BOOLEAN
) (KeyboardBuffer
->BufferHead
== KeyboardBuffer
->BufferTail
);
1777 Check whether USB keyboard buffer is full.
1779 @param KeyboardBuffer USB keyboard buffer
1781 @retval TRUE Keyboard buffer is full.
1782 @retval FALSE Keyboard buffer is not full.
1787 IsUSBKeyboardBufferFull (
1788 IN USB_KB_BUFFER
*KeyboardBuffer
1791 return (BOOLEAN
)(((KeyboardBuffer
->BufferTail
+ 1) % (MAX_KEY_ALLOWED
+ 1)) == KeyboardBuffer
->BufferHead
);
1796 Inserts a keycode into keyboard buffer.
1798 @param KeyboardBuffer Points to the USB keyboard buffer.
1799 @param Key Keycode to insert.
1800 @param Down TRUE means key is pressed.
1801 FALSE means key is released.
1807 IN OUT USB_KB_BUFFER
*KeyboardBuffer
,
1815 // If keyboard buffer is full, throw the
1816 // first key out of the keyboard buffer.
1818 if (IsUSBKeyboardBufferFull (KeyboardBuffer
)) {
1819 RemoveKeyCode (KeyboardBuffer
, &UsbKey
);
1822 ASSERT (KeyboardBuffer
->BufferTail
<= MAX_KEY_ALLOWED
);
1824 KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferTail
].KeyCode
= Key
;
1825 KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferTail
].Down
= Down
;
1828 // Adjust the tail pointer of the FIFO keyboard buffer.
1830 KeyboardBuffer
->BufferTail
= (UINT8
) ((KeyboardBuffer
->BufferTail
+ 1) % (MAX_KEY_ALLOWED
+ 1));
1835 Remove a keycode from keyboard buffer and return it.
1837 @param KeyboardBuffer Points to the USB keyboard buffer.
1838 @param UsbKey Points to the buffer that contains keycode for output.
1840 @retval EFI_SUCCESS Keycode successfully removed from keyboard buffer.
1841 @retval EFI_DEVICE_ERROR Keyboard buffer is empty.
1847 IN OUT USB_KB_BUFFER
*KeyboardBuffer
,
1851 if (IsUSBKeyboardBufferEmpty (KeyboardBuffer
)) {
1852 return EFI_DEVICE_ERROR
;
1855 ASSERT (KeyboardBuffer
->BufferHead
<= MAX_KEY_ALLOWED
);
1857 UsbKey
->KeyCode
= KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferHead
].KeyCode
;
1858 UsbKey
->Down
= KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferHead
].Down
;
1861 // Adjust the head pointer of the FIFO keyboard buffer.
1863 KeyboardBuffer
->BufferHead
= (UINT8
) ((KeyboardBuffer
->BufferHead
+ 1) % (MAX_KEY_ALLOWED
+ 1));
1870 Sets USB keyboard LED state.
1872 @param UsbKeyboardDevice The USB_KB_DEV instance.
1878 IN USB_KB_DEV
*UsbKeyboardDevice
1885 // Set each field in Led map.
1887 Led
.NumLock
= (UINT8
) ((UsbKeyboardDevice
->NumLockOn
) ? 1 : 0);
1888 Led
.CapsLock
= (UINT8
) ((UsbKeyboardDevice
->CapsOn
) ? 1 : 0);
1889 Led
.ScrollLock
= (UINT8
) ((UsbKeyboardDevice
->ScrollOn
) ? 1 : 0);
1894 // Call Set_Report Request to lighten the LED.
1896 UsbSetReportRequest (
1897 UsbKeyboardDevice
->UsbIo
,
1898 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
1908 Handler for Repeat Key event.
1910 This function is the handler for Repeat Key event triggered
1912 After a repeatable key is pressed, the event would be triggered
1913 with interval of USBKBD_REPEAT_DELAY. Once the event is triggered,
1914 following trigger will come with interval of USBKBD_REPEAT_RATE.
1916 @param Event The Repeat Key event.
1917 @param Context Points to the USB_KB_DEV instance.
1922 USBKeyboardRepeatHandler (
1927 USB_KB_DEV
*UsbKeyboardDevice
;
1929 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1932 // Do nothing when there is no repeat key.
1934 if (UsbKeyboardDevice
->RepeatKey
!= 0) {
1936 // Inserts the repeat key into keyboard buffer,
1939 &(UsbKeyboardDevice
->KeyboardBuffer
),
1940 UsbKeyboardDevice
->RepeatKey
,
1945 // Set repeat rate for next repeat key generation.
1948 UsbKeyboardDevice
->RepeatTimer
,
1957 Handler for Delayed Recovery event.
1959 This function is the handler for Delayed Recovery event triggered
1961 After a device error occurs, the event would be triggered
1962 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY
1963 is defined in USB standard for error handling.
1965 @param Event The Delayed Recovery event.
1966 @param Context Points to the USB_KB_DEV instance.
1971 USBKeyboardRecoveryHandler (
1977 USB_KB_DEV
*UsbKeyboardDevice
;
1978 EFI_USB_IO_PROTOCOL
*UsbIo
;
1981 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1983 UsbIo
= UsbKeyboardDevice
->UsbIo
;
1985 PacketSize
= (UINT8
) (UsbKeyboardDevice
->IntEndpointDescriptor
.MaxPacketSize
);
1988 // Re-submit Asynchronous Interrupt Transfer for recovery.
1990 UsbIo
->UsbAsyncInterruptTransfer (
1992 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1994 UsbKeyboardDevice
->IntEndpointDescriptor
.Interval
,