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
290 Initialize Key Convertion Table by using default keyboard layout.
292 @param UsbKeyboardDevice The USB_KB_DEV instance.
297 LoadDefaultKeyboardLayout (
298 IN OUT USB_KB_DEV
*UsbKeyboardDevice
302 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
305 // Construct KeyConvertionTable by default keyboard layout
307 KeyDescriptor
= &UsbKeyboardDevice
->KeyConvertionTable
[0];
309 for (Index
= 0; Index
< (NUMBER_OF_VALID_USB_KEYCODE
); Index
++) {
310 KeyDescriptor
->Key
= (EFI_KEY
) KeyboardLayoutTable
[Index
][0];
311 KeyDescriptor
->Unicode
= KeyboardLayoutTable
[Index
][1];
312 KeyDescriptor
->ShiftedUnicode
= KeyboardLayoutTable
[Index
][2];
313 KeyDescriptor
->AltGrUnicode
= 0;
314 KeyDescriptor
->ShiftedAltGrUnicode
= 0;
315 KeyDescriptor
->Modifier
= KeyboardLayoutTable
[Index
][3];
316 KeyDescriptor
->AffectedAttribute
= KeyboardLayoutTable
[Index
][4];
323 Uses USB I/O to check whether the device is a USB keyboard device.
325 @param UsbIo Pointer to a USB I/O protocol instance.
327 @retval TRUE Device is a USB keyboard device.
328 @retval FALSE Device is a not USB keyboard device.
334 IN EFI_USB_IO_PROTOCOL
*UsbIo
338 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
341 // Get the default interface descriptor
343 Status
= UsbIo
->UsbGetInterfaceDescriptor (
348 if (EFI_ERROR (Status
)) {
352 if (InterfaceDescriptor
.InterfaceClass
== CLASS_HID
&&
353 InterfaceDescriptor
.InterfaceSubClass
== SUBCLASS_BOOT
&&
354 InterfaceDescriptor
.InterfaceProtocol
== PROTOCOL_KEYBOARD
363 Get current keyboard layout from HII database.
365 @return Pointer to HII Keyboard Layout.
366 NULL means failure occurred while trying to get keyboard layout.
369 EFI_HII_KEYBOARD_LAYOUT
*
371 GetCurrentKeyboardLayout (
376 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
377 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
381 // Locate HII Database Protocol
383 Status
= gBS
->LocateProtocol (
384 &gEfiHiiDatabaseProtocolGuid
,
386 (VOID
**) &HiiDatabase
388 if (EFI_ERROR (Status
)) {
393 // Get current keyboard layout from HII database
396 KeyboardLayout
= NULL
;
397 Status
= HiiDatabase
->GetKeyboardLayout (
403 if (Status
== EFI_BUFFER_TOO_SMALL
) {
404 KeyboardLayout
= AllocatePool (Length
);
405 ASSERT (KeyboardLayout
!= NULL
);
407 Status
= HiiDatabase
->GetKeyboardLayout (
413 if (EFI_ERROR (Status
)) {
414 FreePool (KeyboardLayout
);
415 KeyboardLayout
= NULL
;
419 return KeyboardLayout
;
423 Find Key Descriptor in Key Convertion Table given its USB keycode.
425 @param UsbKeyboardDevice The USB_KB_DEV instance.
426 @param KeyCode USB Keycode.
428 @return The Key Descriptor in Key Convertion Table.
429 NULL means not found.
435 IN USB_KB_DEV
*UsbKeyboardDevice
,
442 // Make sure KeyCode is in the range of [0x4, 0x65] or [0xe0, 0xe7]
444 if ((!USBKBD_VALID_KEYCODE (KeyCode
)) || ((KeyCode
> 0x65) && (KeyCode
< 0xe0)) || (KeyCode
> 0xe7)) {
449 // Calculate the index of Key Descriptor in Key Convertion Table
451 if (KeyCode
<= 0x65) {
452 Index
= (UINT8
) (KeyCode
- 4);
454 Index
= (UINT8
) (KeyCode
- 0xe0 + NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
);
457 return &UsbKeyboardDevice
->KeyConvertionTable
[Index
];
461 Find Non-Spacing key for given Key descriptor.
463 @param UsbKeyboardDevice The USB_KB_DEV instance.
464 @param KeyDescriptor Key descriptor.
466 @return The Non-Spacing key corresponding to KeyDescriptor
467 NULL means not found.
473 IN USB_KB_DEV
*UsbKeyboardDevice
,
474 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
478 LIST_ENTRY
*NsKeyList
;
479 USB_NS_KEY
*UsbNsKey
;
481 NsKeyList
= &UsbKeyboardDevice
->NsKeyList
;
482 Link
= GetFirstNode (NsKeyList
);
483 while (!IsNull (NsKeyList
, Link
)) {
484 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
486 if (UsbNsKey
->NsKey
[0].Key
== KeyDescriptor
->Key
) {
490 Link
= GetNextNode (NsKeyList
, Link
);
497 Find physical key definition for a given key descriptor.
499 For a specified non-spacing key, there are a list of physical
500 keys following it. This function traverses the list of
501 physical keys and tries to find the physical key matching
504 @param UsbNsKey The non-spacing key information.
505 @param KeyDescriptor The key descriptor.
507 @return The physical key definition.
508 If no physical key is found, parameter KeyDescriptor is returned.
514 IN USB_NS_KEY
*UsbNsKey
,
515 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
519 EFI_KEY_DESCRIPTOR
*PhysicalKey
;
521 PhysicalKey
= &UsbNsKey
->NsKey
[1];
522 for (Index
= 0; Index
< UsbNsKey
->KeyCount
; Index
++) {
523 if (KeyDescriptor
->Key
== PhysicalKey
->Key
) {
531 // No children definition matched, return original key
533 return KeyDescriptor
;
537 The notification function for EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID.
539 This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
540 group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
541 It tries to get curent keyboard layout from HII database.
543 @param Event Event being signaled.
544 @param Context Points to USB_KB_DEV instance.
549 SetKeyboardLayoutEvent (
554 USB_KB_DEV
*UsbKeyboardDevice
;
555 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
556 EFI_KEY_DESCRIPTOR TempKey
;
557 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
558 EFI_KEY_DESCRIPTOR
*TableEntry
;
559 EFI_KEY_DESCRIPTOR
*NsKey
;
560 USB_NS_KEY
*UsbNsKey
;
566 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
569 // Try to get current keyboard layout from HII database
571 KeyboardLayout
= GetCurrentKeyboardLayout ();
572 if (KeyboardLayout
== NULL
) {
577 // Re-allocate resource for KeyConvertionTable
579 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
580 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
581 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
584 // Traverse the list of key descriptors following the header of EFI_HII_KEYBOARD_LAYOUT
586 KeyDescriptor
= (EFI_KEY_DESCRIPTOR
*) (((UINT8
*) KeyboardLayout
) + sizeof (EFI_HII_KEYBOARD_LAYOUT
));
587 for (Index
= 0; Index
< KeyboardLayout
->DescriptorCount
; Index
++) {
589 // Copy from HII keyboard layout package binary for alignment
591 CopyMem (&TempKey
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
594 // Fill the key into KeyConvertionTable, whose index is calculated from USB keycode.
596 KeyCode
= EfiKeyToUsbKeyCodeConvertionTable
[(UINT8
) (TempKey
.Key
)];
597 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
598 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
601 // For non-spacing key, create the list with a non-spacing key followed by physical keys.
603 if (TempKey
.Modifier
== EFI_NS_KEY_MODIFIER
) {
604 UsbNsKey
= AllocatePool (sizeof (USB_NS_KEY
));
605 ASSERT (UsbNsKey
!= NULL
);
608 // Search for sequential children physical key definitions
611 NsKey
= KeyDescriptor
+ 1;
612 for (Index2
= Index
+ 1; Index2
< KeyboardLayout
->DescriptorCount
; Index2
++) {
613 CopyMem (&TempKey
, NsKey
, sizeof (EFI_KEY_DESCRIPTOR
));
614 if (TempKey
.Modifier
& EFI_NS_KEY_DEPENDENCY_MODIFIER
) {
622 UsbNsKey
->Signature
= USB_NS_KEY_SIGNATURE
;
623 UsbNsKey
->KeyCount
= KeyCount
;
624 UsbNsKey
->NsKey
= AllocateCopyPool (
625 (KeyCount
+ 1) * sizeof (EFI_KEY_DESCRIPTOR
),
628 InsertTailList (&UsbKeyboardDevice
->NsKeyList
, &UsbNsKey
->Link
);
631 // Skip over the child physical keys
634 KeyDescriptor
+= KeyCount
;
641 // There are two EfiKeyEnter, duplicate its key descriptor
643 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, 0x58);
644 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, 0x28);
645 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
647 FreePool (KeyboardLayout
);
651 Destroy resources for keyboard layout.
653 @param UsbKeyboardDevice The USB_KB_DEV instance.
658 ReleaseKeyboardLayoutResources (
659 IN OUT USB_KB_DEV
*UsbKeyboardDevice
662 USB_NS_KEY
*UsbNsKey
;
665 if (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
) {
666 FreePool (UsbKeyboardDevice
->KeyConvertionTable
);
668 UsbKeyboardDevice
->KeyConvertionTable
= NULL
;
670 while (!IsListEmpty (&UsbKeyboardDevice
->NsKeyList
)) {
671 Link
= GetFirstNode (&UsbKeyboardDevice
->NsKeyList
);
672 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
673 RemoveEntryList (&UsbNsKey
->Link
);
675 FreePool (UsbNsKey
->NsKey
);
681 Initialize USB keyboard layout.
683 This function initializes Key Convertion Table for the USB keyboard device.
684 It first tries to retrieve layout from HII database. If failed and default
685 layout is enabled, then it just uses the default layout.
687 @param UsbKeyboardDevice The USB_KB_DEV instance.
689 @retval EFI_SUCCESS Initialization succeeded.
690 @retval EFI_NOT_READY Keyboard layout cannot be retrieve from HII
691 database, and default layout is disabled.
692 @retval Other Fail to register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group.
698 OUT USB_KB_DEV
*UsbKeyboardDevice
701 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
704 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
705 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
707 InitializeListHead (&UsbKeyboardDevice
->NsKeyList
);
708 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
709 UsbKeyboardDevice
->KeyboardLayoutEvent
= NULL
;
712 // Register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
713 // which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
715 Status
= gBS
->CreateEventEx (
718 SetKeyboardLayoutEvent
,
720 &gEfiHiiKeyBoardLayoutGuid
,
721 &UsbKeyboardDevice
->KeyboardLayoutEvent
723 if (EFI_ERROR (Status
)) {
727 KeyboardLayout
= GetCurrentKeyboardLayout ();
728 if (KeyboardLayout
!= NULL
) {
730 // If current keyboard layout is successfully retrieved from HII database,
731 // force to initialize the keyboard layout.
733 gBS
->SignalEvent (UsbKeyboardDevice
->KeyboardLayoutEvent
);
735 if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver
)) {
737 // If no keyboard layout can be retrieved from HII database, and default layout
738 // is disabled, then return EFI_NOT_READY.
740 return EFI_NOT_READY
;
743 // If no keyboard layout can be retrieved from HII database, and default layout
744 // is enabled, then load the default keyboard layout.
746 LoadDefaultKeyboardLayout (UsbKeyboardDevice
);
754 Initialize USB keyboard device and all private data structures.
756 @param UsbKeyboardDevice The USB_KB_DEV instance.
758 @retval EFI_SUCCESS Initialization is successful.
759 @retval EFI_DEVICE_ERROR Keyboard initialization failed.
765 IN OUT USB_KB_DEV
*UsbKeyboardDevice
773 UINT32 TransferResult
;
775 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
777 PcdGet32 (PcdStatusCodeValueKeyboardSelfTest
),
778 UsbKeyboardDevice
->DevicePath
781 InitUSBKeyBuffer (&(UsbKeyboardDevice
->KeyboardBuffer
));
784 // Uses default configuration to configure the USB keyboard device.
787 Status
= UsbSetConfiguration (
788 UsbKeyboardDevice
->UsbIo
,
789 (UINT16
) ConfigValue
,
792 if (EFI_ERROR (Status
)) {
794 // If configuration could not be set here, it means
795 // the keyboard interface has some errors and could
796 // not be initialized
798 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
799 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
800 PcdGet32 (PcdStatusCodeValueKeyboardInterfaceError
),
801 UsbKeyboardDevice
->DevicePath
804 return EFI_DEVICE_ERROR
;
807 UsbGetProtocolRequest (
808 UsbKeyboardDevice
->UsbIo
,
809 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
813 // Set boot protocol for the USB Keyboard.
814 // This driver only supports boot protocol.
816 if (Protocol
!= BOOT_PROTOCOL
) {
817 UsbSetProtocolRequest (
818 UsbKeyboardDevice
->UsbIo
,
819 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
825 // ReportId is zero, which means the idle rate applies to all input reports.
829 // Duration is zero, which means the duration is infinite.
830 // so the endpoint will inhibit reporting forever,
831 // and only reporting when a change is detected in the report data.
835 UsbKeyboardDevice
->UsbIo
,
836 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
841 UsbKeyboardDevice
->CtrlOn
= FALSE
;
842 UsbKeyboardDevice
->AltOn
= FALSE
;
843 UsbKeyboardDevice
->ShiftOn
= FALSE
;
844 UsbKeyboardDevice
->NumLockOn
= FALSE
;
845 UsbKeyboardDevice
->CapsOn
= FALSE
;
846 UsbKeyboardDevice
->ScrollOn
= FALSE
;
848 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
849 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
850 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
851 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
852 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
853 UsbKeyboardDevice
->RightAltOn
= FALSE
;
854 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
855 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
856 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
857 UsbKeyboardDevice
->SysReqOn
= FALSE
;
859 UsbKeyboardDevice
->AltGrOn
= FALSE
;
861 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
864 // Sync the initial state of lights on keyboard.
866 SetKeyLED (UsbKeyboardDevice
);
868 ZeroMem (UsbKeyboardDevice
->LastKeyCodeArray
, sizeof (UINT8
) * 8);
871 // Create event for repeat keys' generation.
873 if (UsbKeyboardDevice
->RepeatTimer
!= NULL
) {
874 gBS
->CloseEvent (UsbKeyboardDevice
->RepeatTimer
);
875 UsbKeyboardDevice
->RepeatTimer
= NULL
;
879 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
881 USBKeyboardRepeatHandler
,
883 &UsbKeyboardDevice
->RepeatTimer
887 // Create event for delayed recovery, which deals with device error.
889 if (UsbKeyboardDevice
->DelayedRecoveryEvent
!= NULL
) {
890 gBS
->CloseEvent (UsbKeyboardDevice
->DelayedRecoveryEvent
);
891 UsbKeyboardDevice
->DelayedRecoveryEvent
= NULL
;
895 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
897 USBKeyboardRecoveryHandler
,
899 &UsbKeyboardDevice
->DelayedRecoveryEvent
907 Handler function for USB keyboard's asynchronous interrupt transfer.
909 This function is the handler function for USB keyboard's asynchronous interrupt transfer
910 to manage the keyboard. It parses the USB keyboard input report, and inserts data to
911 keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key
912 is also set accordingly.
914 @param Data A pointer to a buffer that is filled with key data which is
915 retrieved via asynchronous interrupt transfer.
916 @param DataLength Indicates the size of the data buffer.
917 @param Context Pointing to USB_KB_DEV instance.
918 @param Result Indicates the result of the asynchronous interrupt transfer.
920 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.
921 @retval EFI_DEVICE_ERROR Hardware error occurs.
933 USB_KB_DEV
*UsbKeyboardDevice
;
934 EFI_USB_IO_PROTOCOL
*UsbIo
;
935 UINT8
*CurKeyCodeBuffer
;
936 UINT8
*OldKeyCodeBuffer
;
937 UINT8 CurModifierMap
;
938 UINT8 OldModifierMap
;
949 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
951 ASSERT (Context
!= NULL
);
954 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
955 UsbIo
= UsbKeyboardDevice
->UsbIo
;
958 // Analyzes Result and performs corresponding action.
960 if (Result
!= EFI_USB_NOERROR
) {
962 // Some errors happen during the process
964 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
965 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
966 PcdGet32 (PcdStatusCodeValueKeyboardInputError
),
967 UsbKeyboardDevice
->DevicePath
971 // Stop the repeat key generation if any
973 UsbKeyboardDevice
->RepeatKey
= 0;
976 UsbKeyboardDevice
->RepeatTimer
,
981 if ((Result
& EFI_USB_ERR_STALL
) == EFI_USB_ERR_STALL
) {
982 UsbClearEndpointHalt (
984 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
990 // Delete & Submit this interrupt again
991 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.
993 UsbIo
->UsbAsyncInterruptTransfer (
995 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1003 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.
1006 UsbKeyboardDevice
->DelayedRecoveryEvent
,
1008 EFI_USB_INTERRUPT_DELAY
1011 return EFI_DEVICE_ERROR
;
1015 // If no error and no data, just return EFI_SUCCESS.
1017 if (DataLength
== 0 || Data
== NULL
) {
1022 // Following code checks current keyboard input report against old key code buffer.
1023 // According to USB HID Firmware Specification, the report consists of 8 bytes.
1024 // Byte 0 is map of Modifier keys.
1025 // Byte 1 is reserved.
1026 // Bytes 2 to 7 are keycodes.
1028 CurKeyCodeBuffer
= (UINT8
*) Data
;
1029 OldKeyCodeBuffer
= UsbKeyboardDevice
->LastKeyCodeArray
;
1032 // Checks for new key stroke.
1034 for (Index
= 0; Index
< 8; Index
++) {
1035 if (OldKeyCodeBuffer
[Index
] != CurKeyCodeBuffer
[Index
]) {
1041 // If no new key, return EFI_SUCCESS immediately.
1048 // Parse the modifier key, which is the first byte of keyboard input report.
1050 CurModifierMap
= CurKeyCodeBuffer
[0];
1051 OldModifierMap
= OldKeyCodeBuffer
[0];
1054 // Handle modifier key's pressing or releasing situation.
1055 // According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:
1056 // Bit0: Left Control, Keycode: 0xe0
1057 // Bit1: Left Shift, Keycode: 0xe1
1058 // Bit2: Left Alt, Keycode: 0xe2
1059 // Bit3: Left GUI, Keycode: 0xe3
1060 // Bit4: Right Control, Keycode: 0xe4
1061 // Bit5: Right Shift, Keycode: 0xe5
1062 // Bit6: Right Alt, Keycode: 0xe6
1063 // Bit7: Right GUI, Keycode: 0xe7
1065 for (Index
= 0; Index
< 8; Index
++) {
1066 Mask
= (UINT8
) (1 << Index
);
1067 if ((CurModifierMap
& Mask
) != (OldModifierMap
& Mask
)) {
1069 // If current modifier key is up, then CurModifierMap & Mask = 0;
1070 // otherwise it is a non-zero value.
1071 // Insert the changed modifier key into key buffer.
1073 Down
= (BOOLEAN
) ((CurModifierMap
& Mask
) != 0);
1074 InsertKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), (UINT8
) (0xe0 + Index
), Down
);
1079 // Handle normal key's releasing situation
1080 // Bytes 2 to 7 are for normal keycodes
1083 for (Index
= 2; Index
< 8; Index
++) {
1085 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index
])) {
1089 // For any key in old keycode buffer, if it is not in current keycode buffer,
1090 // then it is released. Otherwise, it is not released.
1093 for (Index2
= 2; Index2
< 8; Index2
++) {
1095 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index2
])) {
1099 if (OldKeyCodeBuffer
[Index
] == CurKeyCodeBuffer
[Index2
]) {
1107 &(UsbKeyboardDevice
->KeyboardBuffer
),
1108 OldKeyCodeBuffer
[Index
],
1112 // The original repeat key is released.
1114 if (OldKeyCodeBuffer
[Index
] == UsbKeyboardDevice
->RepeatKey
) {
1115 UsbKeyboardDevice
->RepeatKey
= 0;
1121 // If original repeat key is released, cancel the repeat timer
1123 if (UsbKeyboardDevice
->RepeatKey
== 0) {
1125 UsbKeyboardDevice
->RepeatTimer
,
1132 // Handle normal key's pressing situation
1135 for (Index
= 2; Index
< 8; Index
++) {
1137 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index
])) {
1141 // For any key in current keycode buffer, if it is not in old keycode buffer,
1142 // then it is pressed. Otherwise, it is not pressed.
1145 for (Index2
= 2; Index2
< 8; Index2
++) {
1147 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index2
])) {
1151 if (CurKeyCodeBuffer
[Index
] == OldKeyCodeBuffer
[Index2
]) {
1158 InsertKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), CurKeyCodeBuffer
[Index
], TRUE
);
1161 // Handle repeat key
1163 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, CurKeyCodeBuffer
[Index
]);
1164 ASSERT (KeyDescriptor
!= NULL
);
1166 if (KeyDescriptor
->Modifier
== EFI_NUM_LOCK_MODIFIER
|| KeyDescriptor
->Modifier
== EFI_CAPS_LOCK_MODIFIER
) {
1168 // For NumLock or CapsLock pressed, there is no need to handle repeat key for them.
1170 UsbKeyboardDevice
->RepeatKey
= 0;
1173 // Prepare new repeat key, and clear the original one.
1175 NewRepeatKey
= CurKeyCodeBuffer
[Index
];
1176 UsbKeyboardDevice
->RepeatKey
= 0;
1182 // Update LastKeycodeArray buffer in the UsbKeyboardDevice data structure.
1184 for (Index
= 0; Index
< 8; Index
++) {
1185 UsbKeyboardDevice
->LastKeyCodeArray
[Index
] = CurKeyCodeBuffer
[Index
];
1189 // Pre-process KeyboardBuffer to check if Ctrl + Alt + Del is pressed.
1191 SavedTail
= UsbKeyboardDevice
->KeyboardBuffer
.BufferTail
;
1192 Index
= UsbKeyboardDevice
->KeyboardBuffer
.BufferHead
;
1193 while (Index
!= SavedTail
) {
1194 RemoveKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), &UsbKey
);
1196 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1197 ASSERT (KeyDescriptor
!= NULL
);
1199 switch (KeyDescriptor
->Modifier
) {
1201 case EFI_LEFT_CONTROL_MODIFIER
:
1202 case EFI_RIGHT_CONTROL_MODIFIER
:
1204 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1206 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1210 case EFI_LEFT_ALT_MODIFIER
:
1211 case EFI_RIGHT_ALT_MODIFIER
:
1213 UsbKeyboardDevice
->AltOn
= TRUE
;
1215 UsbKeyboardDevice
->AltOn
= FALSE
;
1219 case EFI_ALT_GR_MODIFIER
:
1221 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1223 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1228 // For Del Key, check if Ctrl + Alt + Del occurs for reset.
1230 case EFI_DELETE_MODIFIER
:
1232 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1233 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1243 // Insert the key back to the buffer,
1244 // so the key sequence will not be destroyed.
1247 &(UsbKeyboardDevice
->KeyboardBuffer
),
1251 Index
= UsbKeyboardDevice
->KeyboardBuffer
.BufferHead
;
1255 // If there is new key pressed, update the RepeatKey value, and set the
1256 // timer to repeate delay timer
1258 if (NewRepeatKey
!= 0) {
1260 // Sets trigger time to "Repeat Delay Time",
1261 // to trigger the repeat timer when the key is hold long
1265 UsbKeyboardDevice
->RepeatTimer
,
1269 UsbKeyboardDevice
->RepeatKey
= NewRepeatKey
;
1277 Retrieves a USB keycode after parsing the raw data in keyboard buffer.
1279 This function parses keyboard buffer. It updates state of modifier key for
1280 USB_KB_DEV instancem, and returns keycode for output.
1282 @param UsbKeyboardDevice The USB_KB_DEV instance.
1283 @param KeyCode Pointer to the USB keycode for output.
1285 @retval EFI_SUCCESS Keycode successfully parsed.
1286 @retval EFI_NOT_READY Keyboard buffer is not ready for a valid keycode
1292 IN OUT USB_KB_DEV
*UsbKeyboardDevice
,
1297 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1301 while (!IsUSBKeyboardBufferEmpty (&UsbKeyboardDevice
->KeyboardBuffer
)) {
1303 // Pops one raw data off.
1305 RemoveKeyCode (&(UsbKeyboardDevice
->KeyboardBuffer
), &UsbKey
);
1307 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1308 ASSERT (KeyDescriptor
!= NULL
);
1314 switch (KeyDescriptor
->Modifier
) {
1319 case EFI_LEFT_CONTROL_MODIFIER
:
1320 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
1321 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1323 case EFI_RIGHT_CONTROL_MODIFIER
:
1324 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
1325 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1331 case EFI_LEFT_SHIFT_MODIFIER
:
1332 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1333 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1335 case EFI_RIGHT_SHIFT_MODIFIER
:
1336 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1337 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1343 case EFI_LEFT_ALT_MODIFIER
:
1344 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
1345 UsbKeyboardDevice
->AltOn
= FALSE
;
1347 case EFI_RIGHT_ALT_MODIFIER
:
1348 UsbKeyboardDevice
->RightAltOn
= FALSE
;
1349 UsbKeyboardDevice
->AltOn
= FALSE
;
1353 // Left Logo release
1355 case EFI_LEFT_LOGO_MODIFIER
:
1356 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
1360 // Right Logo release
1362 case EFI_RIGHT_LOGO_MODIFIER
:
1363 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
1369 case EFI_MENU_MODIFIER
:
1370 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
1376 case EFI_PRINT_MODIFIER
:
1377 case EFI_SYS_REQUEST_MODIFIER
:
1378 UsbKeyboardDevice
->SysReqOn
= FALSE
;
1384 case EFI_ALT_GR_MODIFIER
:
1385 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1396 // Analyzes key pressing situation
1398 switch (KeyDescriptor
->Modifier
) {
1403 case EFI_LEFT_CONTROL_MODIFIER
:
1404 UsbKeyboardDevice
->LeftCtrlOn
= TRUE
;
1405 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1408 case EFI_RIGHT_CONTROL_MODIFIER
:
1409 UsbKeyboardDevice
->RightCtrlOn
= TRUE
;
1410 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1417 case EFI_LEFT_SHIFT_MODIFIER
:
1418 UsbKeyboardDevice
->LeftShiftOn
= TRUE
;
1419 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1422 case EFI_RIGHT_SHIFT_MODIFIER
:
1423 UsbKeyboardDevice
->RightShiftOn
= TRUE
;
1424 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1431 case EFI_LEFT_ALT_MODIFIER
:
1432 UsbKeyboardDevice
->LeftAltOn
= TRUE
;
1433 UsbKeyboardDevice
->AltOn
= TRUE
;
1436 case EFI_RIGHT_ALT_MODIFIER
:
1437 UsbKeyboardDevice
->RightAltOn
= TRUE
;
1438 UsbKeyboardDevice
->AltOn
= TRUE
;
1445 case EFI_LEFT_LOGO_MODIFIER
:
1446 UsbKeyboardDevice
->LeftLogoOn
= TRUE
;
1452 case EFI_RIGHT_LOGO_MODIFIER
:
1453 UsbKeyboardDevice
->RightLogoOn
= TRUE
;
1459 case EFI_MENU_MODIFIER
:
1460 UsbKeyboardDevice
->MenuKeyOn
= TRUE
;
1466 case EFI_PRINT_MODIFIER
:
1467 case EFI_SYS_REQUEST_MODIFIER
:
1468 UsbKeyboardDevice
->SysReqOn
= TRUE
;
1475 case EFI_ALT_GR_MODIFIER
:
1476 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1479 case EFI_NUM_LOCK_MODIFIER
:
1483 UsbKeyboardDevice
->NumLockOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->NumLockOn
));
1484 SetKeyLED (UsbKeyboardDevice
);
1488 case EFI_CAPS_LOCK_MODIFIER
:
1492 UsbKeyboardDevice
->CapsOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->CapsOn
));
1493 SetKeyLED (UsbKeyboardDevice
);
1497 case EFI_SCROLL_LOCK_MODIFIER
:
1499 // Toggle ScrollLock
1501 UsbKeyboardDevice
->ScrollOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->ScrollOn
));
1502 SetKeyLED (UsbKeyboardDevice
);
1507 // F11, F12, PrintScreen, Pause/Break
1508 // could not be retrieved via SimpleTextInEx protocol
1510 case EFI_FUNCTION_KEY_ELEVEN_MODIFIER
:
1511 case EFI_FUNCTION_KEY_TWELVE_MODIFIER
:
1512 case EFI_PAUSE_MODIFIER
:
1513 case EFI_BREAK_MODIFIER
:
1525 // When encountering Ctrl + Alt + Del, then warm reset.
1527 if (KeyDescriptor
->Modifier
== EFI_DELETE_MODIFIER
) {
1528 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1529 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1533 *KeyCode
= UsbKey
.KeyCode
;
1537 return EFI_NOT_READY
;
1542 Converts USB Keycode ranging from 0x4 to 0x65 to EFI_INPUT_KEY.
1544 @param UsbKeyboardDevice The USB_KB_DEV instance.
1545 @param KeyCode Indicates the key code that will be interpreted.
1546 @param Key A pointer to a buffer that is filled in with
1547 the keystroke information for the key that
1550 @retval EFI_SUCCESS Success.
1551 @retval EFI_INVALID_PARAMETER KeyCode is not in the range of 0x4 to 0x65.
1552 @retval EFI_INVALID_PARAMETER Translated EFI_INPUT_KEY has zero for both ScanCode and UnicodeChar.
1553 @retval EFI_NOT_READY KeyCode represents a dead key with EFI_NS_KEY_MODIFIER
1554 @retval EFI_DEVICE_ERROR Keyboard layout is invalid.
1559 UsbKeyCodeToEfiInputKey (
1560 IN USB_KB_DEV
*UsbKeyboardDevice
,
1562 OUT EFI_INPUT_KEY
*Key
1565 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1568 // KeyCode must in the range of 0x4 to 0x65
1570 if (!USBKBD_VALID_KEYCODE (KeyCode
)) {
1571 return EFI_INVALID_PARAMETER
;
1573 if ((KeyCode
- 4) >= NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
) {
1574 return EFI_INVALID_PARAMETER
;
1577 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
1578 ASSERT (KeyDescriptor
!= NULL
);
1580 if (KeyDescriptor
->Modifier
== EFI_NS_KEY_MODIFIER
) {
1582 // If this is a dead key with EFI_NS_KEY_MODIFIER, then record it and return.
1584 UsbKeyboardDevice
->CurrentNsKey
= FindUsbNsKey (UsbKeyboardDevice
, KeyDescriptor
);
1585 return EFI_NOT_READY
;
1588 if (UsbKeyboardDevice
->CurrentNsKey
!= NULL
) {
1590 // If this keystroke follows a non-spacing key, then find the descriptor for corresponding
1593 KeyDescriptor
= FindPhysicalKey (UsbKeyboardDevice
->CurrentNsKey
, KeyDescriptor
);
1594 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
1598 // Make sure modifier of Key Descriptor is in the valid range according to UEFI spec.
1600 if (KeyDescriptor
->Modifier
> EFI_FUNCTION_KEY_TWELVE_MODIFIER
) {
1601 return EFI_DEVICE_ERROR
;
1604 Key
->ScanCode
= ModifierValueToEfiScanCodeConvertionTable
[KeyDescriptor
->Modifier
];
1605 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1607 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_STANDARD_SHIFT
)!= 0) {
1608 if (UsbKeyboardDevice
->ShiftOn
) {
1609 Key
->UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1612 // Need not return associated shift state if a class of printable characters that
1613 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'
1615 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1616 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1617 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1620 if (UsbKeyboardDevice
->AltGrOn
) {
1621 Key
->UnicodeChar
= KeyDescriptor
->ShiftedAltGrUnicode
;
1627 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1629 if (UsbKeyboardDevice
->AltGrOn
) {
1630 Key
->UnicodeChar
= KeyDescriptor
->AltGrUnicode
;
1635 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1636 if (UsbKeyboardDevice
->CapsOn
) {
1637 if (Key
->UnicodeChar
== KeyDescriptor
->Unicode
) {
1638 Key
->UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1639 } else if (Key
->UnicodeChar
== KeyDescriptor
->ShiftedUnicode
) {
1640 Key
->UnicodeChar
= KeyDescriptor
->Unicode
;
1646 // Translate the CTRL-Alpha characters to their corresponding control value
1647 // (ctrl-a = 0x0001 through ctrl-Z = 0x001A)
1649 if (UsbKeyboardDevice
->CtrlOn
) {
1650 if (Key
->UnicodeChar
>= 'a' && Key
->UnicodeChar
<= 'z') {
1651 Key
->UnicodeChar
= (UINT8
) (Key
->UnicodeChar
- 'a' + 1);
1652 } else if (Key
->UnicodeChar
>= 'A' && Key
->UnicodeChar
<= 'Z') {
1653 Key
->UnicodeChar
= (UINT8
) (Key
->UnicodeChar
- 'A' + 1);
1657 if (KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_NUM_LOCK
) {
1659 // For key affected by NumLock, if NumLock is on and Shift is not pressed, then it means
1660 // normal key, instead of original control key. So the ScanCode should be cleaned.
1661 // Otherwise, it means control key, so preserve the EFI Scan Code and clear the unicode keycode.
1663 if ((UsbKeyboardDevice
->NumLockOn
) && (!(UsbKeyboardDevice
->ShiftOn
))) {
1664 Key
->ScanCode
= SCAN_NULL
;
1666 Key
->UnicodeChar
= 0x00;
1671 // Translate Unicode 0x1B (ESC) to EFI Scan Code
1673 if (Key
->UnicodeChar
== 0x1B && Key
->ScanCode
== SCAN_NULL
) {
1674 Key
->ScanCode
= SCAN_ESC
;
1675 Key
->UnicodeChar
= 0x00;
1679 // Not valid for key without both unicode key code and EFI Scan Code.
1681 if (Key
->UnicodeChar
== 0 && Key
->ScanCode
== SCAN_NULL
) {
1682 return EFI_NOT_READY
;
1687 // Save Shift/Toggle state
1689 if (UsbKeyboardDevice
->LeftCtrlOn
) {
1690 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_CONTROL_PRESSED
;
1692 if (UsbKeyboardDevice
->RightCtrlOn
) {
1693 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_CONTROL_PRESSED
;
1695 if (UsbKeyboardDevice
->LeftAltOn
) {
1696 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_ALT_PRESSED
;
1698 if (UsbKeyboardDevice
->RightAltOn
) {
1699 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_ALT_PRESSED
;
1701 if (UsbKeyboardDevice
->LeftShiftOn
) {
1702 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_SHIFT_PRESSED
;
1704 if (UsbKeyboardDevice
->RightShiftOn
) {
1705 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_SHIFT_PRESSED
;
1707 if (UsbKeyboardDevice
->LeftLogoOn
) {
1708 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_LEFT_LOGO_PRESSED
;
1710 if (UsbKeyboardDevice
->RightLogoOn
) {
1711 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_RIGHT_LOGO_PRESSED
;
1713 if (UsbKeyboardDevice
->MenuKeyOn
) {
1714 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_MENU_KEY_PRESSED
;
1716 if (UsbKeyboardDevice
->SysReqOn
) {
1717 UsbKeyboardDevice
->KeyState
.KeyShiftState
|= EFI_SYS_REQ_PRESSED
;
1720 if (UsbKeyboardDevice
->ScrollOn
) {
1721 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_SCROLL_LOCK_ACTIVE
;
1723 if (UsbKeyboardDevice
->NumLockOn
) {
1724 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_NUM_LOCK_ACTIVE
;
1726 if (UsbKeyboardDevice
->CapsOn
) {
1727 UsbKeyboardDevice
->KeyState
.KeyToggleState
|= EFI_CAPS_LOCK_ACTIVE
;
1736 Resets USB keyboard buffer.
1738 @param KeyboardBuffer Points to the USB keyboard buffer.
1744 OUT USB_KB_BUFFER
*KeyboardBuffer
1747 ZeroMem (KeyboardBuffer
, sizeof (USB_KB_BUFFER
));
1749 KeyboardBuffer
->BufferHead
= KeyboardBuffer
->BufferTail
;
1754 Check whether USB keyboard buffer is empty.
1756 @param KeyboardBuffer USB keyboard buffer
1758 @retval TRUE Keyboard buffer is empty.
1759 @retval FALSE Keyboard buffer is not empty.
1764 IsUSBKeyboardBufferEmpty (
1765 IN USB_KB_BUFFER
*KeyboardBuffer
1769 // Meet FIFO empty condition
1771 return (BOOLEAN
) (KeyboardBuffer
->BufferHead
== KeyboardBuffer
->BufferTail
);
1776 Check whether USB keyboard buffer is full.
1778 @param KeyboardBuffer USB keyboard buffer
1780 @retval TRUE Keyboard buffer is full.
1781 @retval FALSE Keyboard buffer is not full.
1786 IsUSBKeyboardBufferFull (
1787 IN USB_KB_BUFFER
*KeyboardBuffer
1790 return (BOOLEAN
)(((KeyboardBuffer
->BufferTail
+ 1) % (MAX_KEY_ALLOWED
+ 1)) == KeyboardBuffer
->BufferHead
);
1795 Inserts a keycode into keyboard buffer.
1797 @param KeyboardBuffer Points to the USB keyboard buffer.
1798 @param Key Keycode to insert.
1799 @param Down TRUE means key is pressed.
1800 FALSE means key is released.
1806 IN OUT USB_KB_BUFFER
*KeyboardBuffer
,
1814 // If keyboard buffer is full, throw the
1815 // first key out of the keyboard buffer.
1817 if (IsUSBKeyboardBufferFull (KeyboardBuffer
)) {
1818 RemoveKeyCode (KeyboardBuffer
, &UsbKey
);
1821 ASSERT (KeyboardBuffer
->BufferTail
<= MAX_KEY_ALLOWED
);
1823 KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferTail
].KeyCode
= Key
;
1824 KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferTail
].Down
= Down
;
1827 // Adjust the tail pointer of the FIFO keyboard buffer.
1829 KeyboardBuffer
->BufferTail
= (UINT8
) ((KeyboardBuffer
->BufferTail
+ 1) % (MAX_KEY_ALLOWED
+ 1));
1834 Remove a keycode from keyboard buffer and return it.
1836 @param KeyboardBuffer Points to the USB keyboard buffer.
1837 @param UsbKey Points to the buffer that contains keycode for output.
1839 @retval EFI_SUCCESS Keycode successfully removed from keyboard buffer.
1840 @retval EFI_DEVICE_ERROR Keyboard buffer is empty.
1846 IN OUT USB_KB_BUFFER
*KeyboardBuffer
,
1850 if (IsUSBKeyboardBufferEmpty (KeyboardBuffer
)) {
1851 return EFI_DEVICE_ERROR
;
1854 ASSERT (KeyboardBuffer
->BufferHead
<= MAX_KEY_ALLOWED
);
1856 UsbKey
->KeyCode
= KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferHead
].KeyCode
;
1857 UsbKey
->Down
= KeyboardBuffer
->Buffer
[KeyboardBuffer
->BufferHead
].Down
;
1860 // Adjust the head pointer of the FIFO keyboard buffer.
1862 KeyboardBuffer
->BufferHead
= (UINT8
) ((KeyboardBuffer
->BufferHead
+ 1) % (MAX_KEY_ALLOWED
+ 1));
1869 Sets USB keyboard LED state.
1871 @param UsbKeyboardDevice The USB_KB_DEV instance.
1877 IN USB_KB_DEV
*UsbKeyboardDevice
1884 // Set each field in Led map.
1886 Led
.NumLock
= (UINT8
) ((UsbKeyboardDevice
->NumLockOn
) ? 1 : 0);
1887 Led
.CapsLock
= (UINT8
) ((UsbKeyboardDevice
->CapsOn
) ? 1 : 0);
1888 Led
.ScrollLock
= (UINT8
) ((UsbKeyboardDevice
->ScrollOn
) ? 1 : 0);
1893 // Call Set_Report Request to lighten the LED.
1895 UsbSetReportRequest (
1896 UsbKeyboardDevice
->UsbIo
,
1897 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
1907 Handler for Repeat Key event.
1909 This function is the handler for Repeat Key event triggered
1911 After a repeatable key is pressed, the event would be triggered
1912 with interval of USBKBD_REPEAT_DELAY. Once the event is triggered,
1913 following trigger will come with interval of USBKBD_REPEAT_RATE.
1915 @param Event The Repeat Key event.
1916 @param Context Points to the USB_KB_DEV instance.
1921 USBKeyboardRepeatHandler (
1926 USB_KB_DEV
*UsbKeyboardDevice
;
1928 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1931 // Do nothing when there is no repeat key.
1933 if (UsbKeyboardDevice
->RepeatKey
!= 0) {
1935 // Inserts the repeat key into keyboard buffer,
1938 &(UsbKeyboardDevice
->KeyboardBuffer
),
1939 UsbKeyboardDevice
->RepeatKey
,
1944 // Set repeat rate for next repeat key generation.
1947 UsbKeyboardDevice
->RepeatTimer
,
1956 Handler for Delayed Recovery event.
1958 This function is the handler for Delayed Recovery event triggered
1960 After a device error occurs, the event would be triggered
1961 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY
1962 is defined in USB standard for error handling.
1964 @param Event The Delayed Recovery event.
1965 @param Context Points to the USB_KB_DEV instance.
1970 USBKeyboardRecoveryHandler (
1976 USB_KB_DEV
*UsbKeyboardDevice
;
1977 EFI_USB_IO_PROTOCOL
*UsbIo
;
1980 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1982 UsbIo
= UsbKeyboardDevice
->UsbIo
;
1984 PacketSize
= (UINT8
) (UsbKeyboardDevice
->IntEndpointDescriptor
.MaxPacketSize
);
1987 // Re-submit Asynchronous Interrupt Transfer for recovery.
1989 UsbIo
->UsbAsyncInterruptTransfer (
1991 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1993 UsbKeyboardDevice
->IntEndpointDescriptor
.Interval
,