2 Helper functions for USB Keyboard Driver.
4 Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
5 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.
17 USB_KEYBOARD_LAYOUT_PACK_BIN mUsbKeyboardLayoutBin
= {
18 sizeof (USB_KEYBOARD_LAYOUT_PACK_BIN
), // Binary size
21 // EFI_HII_PACKAGE_HEADER
24 sizeof (USB_KEYBOARD_LAYOUT_PACK_BIN
) - sizeof (UINT32
),
25 EFI_HII_PACKAGE_KEYBOARD_LAYOUT
28 sizeof (USB_KEYBOARD_LAYOUT_PACK_BIN
) - sizeof (UINT32
) - sizeof (EFI_HII_PACKAGE_HEADER
) - sizeof (UINT16
), // LayoutLength
29 USB_KEYBOARD_LAYOUT_KEY_GUID
, // KeyGuid
30 sizeof (UINT16
) + sizeof (EFI_GUID
) + sizeof (UINT32
) + sizeof (UINT8
) + (USB_KEYBOARD_KEY_COUNT
* sizeof (EFI_KEY_DESCRIPTOR
)), // LayoutDescriptorStringOffset
31 USB_KEYBOARD_KEY_COUNT
, // DescriptorCount
34 // EFI_KEY_DESCRIPTOR (total number is USB_KEYBOARD_KEY_COUNT)
36 {EfiKeyC1
, 'a', 'A', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
37 {EfiKeyB5
, 'b', 'B', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
38 {EfiKeyB3
, 'c', 'C', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
39 {EfiKeyC3
, 'd', 'D', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
40 {EfiKeyD3
, 'e', 'E', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
41 {EfiKeyC4
, 'f', 'F', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
42 {EfiKeyC5
, 'g', 'G', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
43 {EfiKeyC6
, 'h', 'H', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
44 {EfiKeyD8
, 'i', 'I', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
45 {EfiKeyC7
, 'j', 'J', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
46 {EfiKeyC8
, 'k', 'K', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
47 {EfiKeyC9
, 'l', 'L', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
48 {EfiKeyB7
, 'm', 'M', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
49 {EfiKeyB6
, 'n', 'N', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
50 {EfiKeyD9
, 'o', 'O', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
51 {EfiKeyD10
, 'p', 'P', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
52 {EfiKeyD1
, 'q', 'Q', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
53 {EfiKeyD4
, 'r', 'R', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
54 {EfiKeyC2
, 's', 'S', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
55 {EfiKeyD5
, 't', 'T', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
56 {EfiKeyD7
, 'u', 'U', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
57 {EfiKeyB4
, 'v', 'V', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
58 {EfiKeyD2
, 'w', 'W', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
59 {EfiKeyB2
, 'x', 'X', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
60 {EfiKeyD6
, 'y', 'Y', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
61 {EfiKeyB1
, 'z', 'Z', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_CAPS_LOCK
},
62 {EfiKeyE1
, '1', '!', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
63 {EfiKeyE2
, '2', '@', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
64 {EfiKeyE3
, '3', '#', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
65 {EfiKeyE4
, '4', '$', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
66 {EfiKeyE5
, '5', '%', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
67 {EfiKeyE6
, '6', '^', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
68 {EfiKeyE7
, '7', '&', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
69 {EfiKeyE8
, '8', '*', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
70 {EfiKeyE9
, '9', '(', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
71 {EfiKeyE10
, '0', ')', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
72 {EfiKeyEnter
, 0x0d, 0x0d, 0, 0, EFI_NULL_MODIFIER
, 0},
73 {EfiKeyEsc
, 0x1b, 0x1b, 0, 0, EFI_NULL_MODIFIER
, 0},
74 {EfiKeyBackSpace
, 0x08, 0x08, 0, 0, EFI_NULL_MODIFIER
, 0},
75 {EfiKeyTab
, 0x09, 0x09, 0, 0, EFI_NULL_MODIFIER
, 0},
76 {EfiKeySpaceBar
, ' ', ' ', 0, 0, EFI_NULL_MODIFIER
, 0},
77 {EfiKeyE11
, '-', '_', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
78 {EfiKeyE12
, '=', '+', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
79 {EfiKeyD11
, '[', '{', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
80 {EfiKeyD12
, ']', '}', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
81 {EfiKeyD13
, '\\', '|', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
82 {EfiKeyC10
, ';', ':', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
83 {EfiKeyC11
, '\'', '"', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
84 {EfiKeyE0
, '`', '~', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
85 {EfiKeyB8
, ',', '<', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
86 {EfiKeyB9
, '.', '>', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
87 {EfiKeyB10
, '/', '?', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
88 {EfiKeyCapsLock
, 0x00, 0x00, 0, 0, EFI_CAPS_LOCK_MODIFIER
, 0},
89 {EfiKeyF1
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_ONE_MODIFIER
, 0},
90 {EfiKeyF2
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TWO_MODIFIER
, 0},
91 {EfiKeyF3
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_THREE_MODIFIER
, 0},
92 {EfiKeyF4
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_FOUR_MODIFIER
, 0},
93 {EfiKeyF5
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_FIVE_MODIFIER
, 0},
94 {EfiKeyF6
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_SIX_MODIFIER
, 0},
95 {EfiKeyF7
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_SEVEN_MODIFIER
, 0},
96 {EfiKeyF8
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_EIGHT_MODIFIER
, 0},
97 {EfiKeyF9
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_NINE_MODIFIER
, 0},
98 {EfiKeyF10
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TEN_MODIFIER
, 0},
99 {EfiKeyF11
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_ELEVEN_MODIFIER
, 0},
100 {EfiKeyF12
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TWELVE_MODIFIER
, 0},
101 {EfiKeyPrint
, 0x00, 0x00, 0, 0, EFI_PRINT_MODIFIER
, 0},
102 {EfiKeySLck
, 0x00, 0x00, 0, 0, EFI_SCROLL_LOCK_MODIFIER
, 0},
103 {EfiKeyPause
, 0x00, 0x00, 0, 0, EFI_PAUSE_MODIFIER
, 0},
104 {EfiKeyIns
, 0x00, 0x00, 0, 0, EFI_INSERT_MODIFIER
, 0},
105 {EfiKeyHome
, 0x00, 0x00, 0, 0, EFI_HOME_MODIFIER
, 0},
106 {EfiKeyPgUp
, 0x00, 0x00, 0, 0, EFI_PAGE_UP_MODIFIER
, 0},
107 {EfiKeyDel
, 0x00, 0x00, 0, 0, EFI_DELETE_MODIFIER
, 0},
108 {EfiKeyEnd
, 0x00, 0x00, 0, 0, EFI_END_MODIFIER
, 0},
109 {EfiKeyPgDn
, 0x00, 0x00, 0, 0, EFI_PAGE_DOWN_MODIFIER
, 0},
110 {EfiKeyRightArrow
, 0x00, 0x00, 0, 0, EFI_RIGHT_ARROW_MODIFIER
, 0},
111 {EfiKeyLeftArrow
, 0x00, 0x00, 0, 0, EFI_LEFT_ARROW_MODIFIER
, 0},
112 {EfiKeyDownArrow
, 0x00, 0x00, 0, 0, EFI_DOWN_ARROW_MODIFIER
, 0},
113 {EfiKeyUpArrow
, 0x00, 0x00, 0, 0, EFI_UP_ARROW_MODIFIER
, 0},
114 {EfiKeyNLck
, 0x00, 0x00, 0, 0, EFI_NUM_LOCK_MODIFIER
, 0},
115 {EfiKeySlash
, '/', '/', 0, 0, EFI_NULL_MODIFIER
, 0},
116 {EfiKeyAsterisk
, '*', '*', 0, 0, EFI_NULL_MODIFIER
, 0},
117 {EfiKeyMinus
, '-', '-', 0, 0, EFI_NULL_MODIFIER
, 0},
118 {EfiKeyPlus
, '+', '+', 0, 0, EFI_NULL_MODIFIER
, 0},
119 {EfiKeyEnter
, 0x0d, 0x0d, 0, 0, EFI_NULL_MODIFIER
, 0},
120 {EfiKeyOne
, '1', '1', 0, 0, EFI_END_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
121 {EfiKeyTwo
, '2', '2', 0, 0, EFI_DOWN_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
122 {EfiKeyThree
, '3', '3', 0, 0, EFI_PAGE_DOWN_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
123 {EfiKeyFour
, '4', '4', 0, 0, EFI_LEFT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
124 {EfiKeyFive
, '5', '5', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
125 {EfiKeySix
, '6', '6', 0, 0, EFI_RIGHT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
126 {EfiKeySeven
, '7', '7', 0, 0, EFI_HOME_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
127 {EfiKeyEight
, '8', '8', 0, 0, EFI_UP_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
128 {EfiKeyNine
, '9', '9', 0, 0, EFI_PAGE_UP_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
129 {EfiKeyZero
, '0', '0', 0, 0, EFI_INSERT_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
130 {EfiKeyPeriod
, '.', '.', 0, 0, EFI_DELETE_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
131 {EfiKeyA4
, 0x00, 0x00, 0, 0, EFI_MENU_MODIFIER
, 0},
132 {EfiKeyLCtrl
, 0, 0, 0, 0, EFI_LEFT_CONTROL_MODIFIER
, 0},
133 {EfiKeyLShift
, 0, 0, 0, 0, EFI_LEFT_SHIFT_MODIFIER
, 0},
134 {EfiKeyLAlt
, 0, 0, 0, 0, EFI_LEFT_ALT_MODIFIER
, 0},
135 {EfiKeyA0
, 0, 0, 0, 0, EFI_LEFT_LOGO_MODIFIER
, 0},
136 {EfiKeyRCtrl
, 0, 0, 0, 0, EFI_RIGHT_CONTROL_MODIFIER
, 0},
137 {EfiKeyRShift
, 0, 0, 0, 0, EFI_RIGHT_SHIFT_MODIFIER
, 0},
138 {EfiKeyA2
, 0, 0, 0, 0, EFI_RIGHT_ALT_MODIFIER
, 0},
139 {EfiKeyA3
, 0, 0, 0, 0, EFI_RIGHT_LOGO_MODIFIER
, 0},
141 1, // DescriptionCount
142 {'e', 'n', '-', 'U', 'S'}, // RFC4646 language code
144 {'E', 'n', 'g', 'l', 'i', 's', 'h', ' ', 'K', 'e', 'y', 'b', 'o', 'a', 'r', 'd', '\0'}, // DescriptionString[]
148 // EFI_KEY to USB Keycode conversion table
149 // EFI_KEY is defined in UEFI spec.
150 // USB Keycode is defined in USB HID Firmware spec.
152 UINT8 EfiKeyToUsbKeyCodeConvertionTable
[] = {
156 0x2c, // EfiKeySpaceBar
161 0x50, // EfiKeyLeftArrow
162 0x51, // EfiKeyDownArrow
163 0x4F, // EfiKeyRightArrow
165 0x63, // EfiKeyPeriod
167 0xe1, // EfiKeyLShift
179 0xe5, // EfiKeyRShift
180 0x52, // EfiKeyUpArrow
184 0x39, // EfiKeyCapsLock
234 0x2A, // EfiKeyBackSpace
240 0x55, // EfiKeyAsterisk
261 // Keyboard modifier value to EFI Scan Code convertion table
262 // EFI Scan Code and the modifier values are defined in UEFI spec.
264 UINT8 ModifierValueToEfiScanCodeConvertionTable
[] = {
265 SCAN_NULL
, // EFI_NULL_MODIFIER
266 SCAN_NULL
, // EFI_LEFT_CONTROL_MODIFIER
267 SCAN_NULL
, // EFI_RIGHT_CONTROL_MODIFIER
268 SCAN_NULL
, // EFI_LEFT_ALT_MODIFIER
269 SCAN_NULL
, // EFI_RIGHT_ALT_MODIFIER
270 SCAN_NULL
, // EFI_ALT_GR_MODIFIER
271 SCAN_INSERT
, // EFI_INSERT_MODIFIER
272 SCAN_DELETE
, // EFI_DELETE_MODIFIER
273 SCAN_PAGE_DOWN
, // EFI_PAGE_DOWN_MODIFIER
274 SCAN_PAGE_UP
, // EFI_PAGE_UP_MODIFIER
275 SCAN_HOME
, // EFI_HOME_MODIFIER
276 SCAN_END
, // EFI_END_MODIFIER
277 SCAN_NULL
, // EFI_LEFT_SHIFT_MODIFIER
278 SCAN_NULL
, // EFI_RIGHT_SHIFT_MODIFIER
279 SCAN_NULL
, // EFI_CAPS_LOCK_MODIFIER
280 SCAN_NULL
, // EFI_NUM_LOCK_MODIFIER
281 SCAN_LEFT
, // EFI_LEFT_ARROW_MODIFIER
282 SCAN_RIGHT
, // EFI_RIGHT_ARROW_MODIFIER
283 SCAN_DOWN
, // EFI_DOWN_ARROW_MODIFIER
284 SCAN_UP
, // EFI_UP_ARROW_MODIFIER
285 SCAN_NULL
, // EFI_NS_KEY_MODIFIER
286 SCAN_NULL
, // EFI_NS_KEY_DEPENDENCY_MODIFIER
287 SCAN_F1
, // EFI_FUNCTION_KEY_ONE_MODIFIER
288 SCAN_F2
, // EFI_FUNCTION_KEY_TWO_MODIFIER
289 SCAN_F3
, // EFI_FUNCTION_KEY_THREE_MODIFIER
290 SCAN_F4
, // EFI_FUNCTION_KEY_FOUR_MODIFIER
291 SCAN_F5
, // EFI_FUNCTION_KEY_FIVE_MODIFIER
292 SCAN_F6
, // EFI_FUNCTION_KEY_SIX_MODIFIER
293 SCAN_F7
, // EFI_FUNCTION_KEY_SEVEN_MODIFIER
294 SCAN_F8
, // EFI_FUNCTION_KEY_EIGHT_MODIFIER
295 SCAN_F9
, // EFI_FUNCTION_KEY_NINE_MODIFIER
296 SCAN_F10
, // EFI_FUNCTION_KEY_TEN_MODIFIER
297 SCAN_F11
, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER
298 SCAN_F12
, // EFI_FUNCTION_KEY_TWELVE_MODIFIER
299 SCAN_NULL
, // EFI_PRINT_MODIFIER
300 SCAN_NULL
, // EFI_SYS_REQUEST_MODIFIER
301 SCAN_NULL
, // EFI_SCROLL_LOCK_MODIFIER
302 SCAN_PAUSE
// EFI_PAUSE_MODIFIER
306 Initialize Key Convention Table by using default keyboard layout.
308 @param UsbKeyboardDevice The USB_KB_DEV instance.
310 @retval EFI_SUCCESS The default keyboard layout was installed successfully
311 @retval Others Failure to install default keyboard layout.
314 InstallDefaultKeyboardLayout (
315 IN OUT USB_KB_DEV
*UsbKeyboardDevice
319 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
320 EFI_HII_HANDLE HiiHandle
;
323 // Locate Hii database protocol
325 Status
= gBS
->LocateProtocol (
326 &gEfiHiiDatabaseProtocolGuid
,
328 (VOID
**) &HiiDatabase
330 if (EFI_ERROR (Status
)) {
335 // Install Keyboard Layout package to HII database
337 HiiHandle
= HiiAddPackages (
338 &gUsbKeyboardLayoutPackageGuid
,
339 UsbKeyboardDevice
->ControllerHandle
,
340 &mUsbKeyboardLayoutBin
,
343 if (HiiHandle
== NULL
) {
344 return EFI_OUT_OF_RESOURCES
;
348 // Set current keyboard layout
350 Status
= HiiDatabase
->SetKeyboardLayout (HiiDatabase
, &gUsbKeyboardLayoutKeyGuid
);
357 Uses USB I/O to check whether the device is a USB keyboard device.
359 @param UsbIo Pointer to a USB I/O protocol instance.
361 @retval TRUE Device is a USB keyboard device.
362 @retval FALSE Device is a not USB keyboard device.
367 IN EFI_USB_IO_PROTOCOL
*UsbIo
371 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
374 // Get the default interface descriptor
376 Status
= UsbIo
->UsbGetInterfaceDescriptor (
381 if (EFI_ERROR (Status
)) {
385 if (InterfaceDescriptor
.InterfaceClass
== CLASS_HID
&&
386 InterfaceDescriptor
.InterfaceSubClass
== SUBCLASS_BOOT
&&
387 InterfaceDescriptor
.InterfaceProtocol
== PROTOCOL_KEYBOARD
396 Get current keyboard layout from HII database.
398 @return Pointer to HII Keyboard Layout.
399 NULL means failure occurred while trying to get keyboard layout.
402 EFI_HII_KEYBOARD_LAYOUT
*
403 GetCurrentKeyboardLayout (
408 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
409 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
413 // Locate HII Database Protocol
415 Status
= gBS
->LocateProtocol (
416 &gEfiHiiDatabaseProtocolGuid
,
418 (VOID
**) &HiiDatabase
420 if (EFI_ERROR (Status
)) {
425 // Get current keyboard layout from HII database
428 KeyboardLayout
= NULL
;
429 Status
= HiiDatabase
->GetKeyboardLayout (
435 if (Status
== EFI_BUFFER_TOO_SMALL
) {
436 KeyboardLayout
= AllocatePool (Length
);
437 ASSERT (KeyboardLayout
!= NULL
);
439 Status
= HiiDatabase
->GetKeyboardLayout (
445 if (EFI_ERROR (Status
)) {
446 FreePool (KeyboardLayout
);
447 KeyboardLayout
= NULL
;
451 return KeyboardLayout
;
455 Find Key Descriptor in Key Convertion Table given its USB keycode.
457 @param UsbKeyboardDevice The USB_KB_DEV instance.
458 @param KeyCode USB Keycode.
460 @return The Key Descriptor in Key Convertion Table.
461 NULL means not found.
466 IN USB_KB_DEV
*UsbKeyboardDevice
,
473 // Make sure KeyCode is in the range of [0x4, 0x65] or [0xe0, 0xe7]
475 if ((!USBKBD_VALID_KEYCODE (KeyCode
)) || ((KeyCode
> 0x65) && (KeyCode
< 0xe0)) || (KeyCode
> 0xe7)) {
480 // Calculate the index of Key Descriptor in Key Convertion Table
482 if (KeyCode
<= 0x65) {
483 Index
= (UINT8
) (KeyCode
- 4);
485 Index
= (UINT8
) (KeyCode
- 0xe0 + NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
);
488 return &UsbKeyboardDevice
->KeyConvertionTable
[Index
];
492 Find Non-Spacing key for given Key descriptor.
494 @param UsbKeyboardDevice The USB_KB_DEV instance.
495 @param KeyDescriptor Key descriptor.
497 @return The Non-Spacing key corresponding to KeyDescriptor
498 NULL means not found.
503 IN USB_KB_DEV
*UsbKeyboardDevice
,
504 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
508 LIST_ENTRY
*NsKeyList
;
509 USB_NS_KEY
*UsbNsKey
;
511 NsKeyList
= &UsbKeyboardDevice
->NsKeyList
;
512 Link
= GetFirstNode (NsKeyList
);
513 while (!IsNull (NsKeyList
, Link
)) {
514 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
516 if (UsbNsKey
->NsKey
[0].Key
== KeyDescriptor
->Key
) {
520 Link
= GetNextNode (NsKeyList
, Link
);
527 Find physical key definition for a given key descriptor.
529 For a specified non-spacing key, there are a list of physical
530 keys following it. This function traverses the list of
531 physical keys and tries to find the physical key matching
534 @param UsbNsKey The non-spacing key information.
535 @param KeyDescriptor The key descriptor.
537 @return The physical key definition.
538 If no physical key is found, parameter KeyDescriptor is returned.
543 IN USB_NS_KEY
*UsbNsKey
,
544 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
548 EFI_KEY_DESCRIPTOR
*PhysicalKey
;
550 PhysicalKey
= &UsbNsKey
->NsKey
[1];
551 for (Index
= 0; Index
< UsbNsKey
->KeyCount
; Index
++) {
552 if (KeyDescriptor
->Key
== PhysicalKey
->Key
) {
560 // No children definition matched, return original key
562 return KeyDescriptor
;
566 The notification function for EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID.
568 This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
569 group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
570 It tries to get curent keyboard layout from HII database.
572 @param Event Event being signaled.
573 @param Context Points to USB_KB_DEV instance.
578 SetKeyboardLayoutEvent (
583 USB_KB_DEV
*UsbKeyboardDevice
;
584 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
585 EFI_KEY_DESCRIPTOR TempKey
;
586 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
587 EFI_KEY_DESCRIPTOR
*TableEntry
;
588 EFI_KEY_DESCRIPTOR
*NsKey
;
589 USB_NS_KEY
*UsbNsKey
;
595 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
596 if (UsbKeyboardDevice
->Signature
!= USB_KB_DEV_SIGNATURE
) {
601 // Try to get current keyboard layout from HII database
603 KeyboardLayout
= GetCurrentKeyboardLayout ();
604 if (KeyboardLayout
== NULL
) {
609 // Re-allocate resource for KeyConvertionTable
611 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
612 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
613 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
616 // Traverse the list of key descriptors following the header of EFI_HII_KEYBOARD_LAYOUT
618 KeyDescriptor
= (EFI_KEY_DESCRIPTOR
*) (((UINT8
*) KeyboardLayout
) + sizeof (EFI_HII_KEYBOARD_LAYOUT
));
619 for (Index
= 0; Index
< KeyboardLayout
->DescriptorCount
; Index
++) {
621 // Copy from HII keyboard layout package binary for alignment
623 CopyMem (&TempKey
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
626 // Fill the key into KeyConvertionTable, whose index is calculated from USB keycode.
628 KeyCode
= EfiKeyToUsbKeyCodeConvertionTable
[(UINT8
) (TempKey
.Key
)];
629 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
630 if (TableEntry
== NULL
) {
631 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
632 FreePool (KeyboardLayout
);
635 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
638 // For non-spacing key, create the list with a non-spacing key followed by physical keys.
640 if (TempKey
.Modifier
== EFI_NS_KEY_MODIFIER
) {
641 UsbNsKey
= AllocateZeroPool (sizeof (USB_NS_KEY
));
642 ASSERT (UsbNsKey
!= NULL
);
645 // Search for sequential children physical key definitions
648 NsKey
= KeyDescriptor
+ 1;
649 for (Index2
= (UINT8
) Index
+ 1; Index2
< KeyboardLayout
->DescriptorCount
; Index2
++) {
650 CopyMem (&TempKey
, NsKey
, sizeof (EFI_KEY_DESCRIPTOR
));
651 if (TempKey
.Modifier
== EFI_NS_KEY_DEPENDENCY_MODIFIER
) {
659 UsbNsKey
->Signature
= USB_NS_KEY_SIGNATURE
;
660 UsbNsKey
->KeyCount
= KeyCount
;
661 UsbNsKey
->NsKey
= AllocateCopyPool (
662 (KeyCount
+ 1) * sizeof (EFI_KEY_DESCRIPTOR
),
665 InsertTailList (&UsbKeyboardDevice
->NsKeyList
, &UsbNsKey
->Link
);
668 // Skip over the child physical keys
671 KeyDescriptor
+= KeyCount
;
678 // There are two EfiKeyEnter, duplicate its key descriptor
680 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, 0x58);
681 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, 0x28);
682 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
684 FreePool (KeyboardLayout
);
688 Destroy resources for keyboard layout.
690 @param UsbKeyboardDevice The USB_KB_DEV instance.
694 ReleaseKeyboardLayoutResources (
695 IN OUT USB_KB_DEV
*UsbKeyboardDevice
698 USB_NS_KEY
*UsbNsKey
;
701 if (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
) {
702 FreePool (UsbKeyboardDevice
->KeyConvertionTable
);
704 UsbKeyboardDevice
->KeyConvertionTable
= NULL
;
706 while (!IsListEmpty (&UsbKeyboardDevice
->NsKeyList
)) {
707 Link
= GetFirstNode (&UsbKeyboardDevice
->NsKeyList
);
708 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
709 RemoveEntryList (&UsbNsKey
->Link
);
711 FreePool (UsbNsKey
->NsKey
);
717 Initialize USB keyboard layout.
719 This function initializes Key Convertion Table for the USB keyboard device.
720 It first tries to retrieve layout from HII database. If failed and default
721 layout is enabled, then it just uses the default layout.
723 @param UsbKeyboardDevice The USB_KB_DEV instance.
725 @retval EFI_SUCCESS Initialization succeeded.
726 @retval EFI_NOT_READY Keyboard layout cannot be retrieve from HII
727 database, and default layout is disabled.
728 @retval Other Fail to register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group.
733 OUT USB_KB_DEV
*UsbKeyboardDevice
736 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
739 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
740 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
742 InitializeListHead (&UsbKeyboardDevice
->NsKeyList
);
743 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
744 UsbKeyboardDevice
->KeyboardLayoutEvent
= NULL
;
747 // Register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
748 // which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
750 Status
= gBS
->CreateEventEx (
753 SetKeyboardLayoutEvent
,
755 &gEfiHiiKeyBoardLayoutGuid
,
756 &UsbKeyboardDevice
->KeyboardLayoutEvent
758 if (EFI_ERROR (Status
)) {
762 KeyboardLayout
= GetCurrentKeyboardLayout ();
763 if (KeyboardLayout
!= NULL
) {
765 // If current keyboard layout is successfully retrieved from HII database,
766 // force to initialize the keyboard layout.
768 gBS
->SignalEvent (UsbKeyboardDevice
->KeyboardLayoutEvent
);
770 if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver
)) {
772 // If no keyboard layout can be retrieved from HII database, and default layout
773 // is disabled, then return EFI_NOT_READY.
775 return EFI_NOT_READY
;
778 // If no keyboard layout can be retrieved from HII database, and default layout
779 // is enabled, then load the default keyboard layout.
781 InstallDefaultKeyboardLayout (UsbKeyboardDevice
);
789 Initialize USB keyboard device and all private data structures.
791 @param UsbKeyboardDevice The USB_KB_DEV instance.
793 @retval EFI_SUCCESS Initialization is successful.
794 @retval EFI_DEVICE_ERROR Keyboard initialization failed.
799 IN OUT USB_KB_DEV
*UsbKeyboardDevice
807 UINT32 TransferResult
;
809 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
811 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_KEYBOARD_PC_SELF_TEST
),
812 UsbKeyboardDevice
->DevicePath
815 InitQueue (&UsbKeyboardDevice
->UsbKeyQueue
, sizeof (USB_KEY
));
816 InitQueue (&UsbKeyboardDevice
->EfiKeyQueue
, sizeof (EFI_KEY_DATA
));
819 // Use the config out of the descriptor
820 // Assumed the first config is the correct one and this is not always the case
822 Status
= UsbGetConfiguration (
823 UsbKeyboardDevice
->UsbIo
,
827 if (EFI_ERROR (Status
)) {
832 // Uses default configuration to configure the USB Keyboard device.
834 Status
= UsbSetConfiguration (
835 UsbKeyboardDevice
->UsbIo
,
839 if (EFI_ERROR (Status
)) {
841 // If configuration could not be set here, it means
842 // the keyboard interface has some errors and could
843 // not be initialized
845 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
846 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
847 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_INTERFACE_ERROR
),
848 UsbKeyboardDevice
->DevicePath
851 return EFI_DEVICE_ERROR
;
854 UsbGetProtocolRequest (
855 UsbKeyboardDevice
->UsbIo
,
856 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
860 // Set boot protocol for the USB Keyboard.
861 // This driver only supports boot protocol.
863 if (Protocol
!= BOOT_PROTOCOL
) {
864 UsbSetProtocolRequest (
865 UsbKeyboardDevice
->UsbIo
,
866 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
872 // ReportId is zero, which means the idle rate applies to all input reports.
876 // Duration is zero, which means the duration is infinite.
877 // so the endpoint will inhibit reporting forever,
878 // and only reporting when a change is detected in the report data.
882 UsbKeyboardDevice
->UsbIo
,
883 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
888 UsbKeyboardDevice
->CtrlOn
= FALSE
;
889 UsbKeyboardDevice
->AltOn
= FALSE
;
890 UsbKeyboardDevice
->ShiftOn
= FALSE
;
891 UsbKeyboardDevice
->NumLockOn
= FALSE
;
892 UsbKeyboardDevice
->CapsOn
= FALSE
;
893 UsbKeyboardDevice
->ScrollOn
= FALSE
;
895 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
896 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
897 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
898 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
899 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
900 UsbKeyboardDevice
->RightAltOn
= FALSE
;
901 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
902 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
903 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
904 UsbKeyboardDevice
->SysReqOn
= FALSE
;
906 UsbKeyboardDevice
->AltGrOn
= FALSE
;
908 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
911 // Sync the initial state of lights on keyboard.
913 SetKeyLED (UsbKeyboardDevice
);
915 ZeroMem (UsbKeyboardDevice
->LastKeyCodeArray
, sizeof (UINT8
) * 8);
918 // Create event for repeat keys' generation.
920 if (UsbKeyboardDevice
->RepeatTimer
!= NULL
) {
921 gBS
->CloseEvent (UsbKeyboardDevice
->RepeatTimer
);
922 UsbKeyboardDevice
->RepeatTimer
= NULL
;
926 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
928 USBKeyboardRepeatHandler
,
930 &UsbKeyboardDevice
->RepeatTimer
934 // Create event for delayed recovery, which deals with device error.
936 if (UsbKeyboardDevice
->DelayedRecoveryEvent
!= NULL
) {
937 gBS
->CloseEvent (UsbKeyboardDevice
->DelayedRecoveryEvent
);
938 UsbKeyboardDevice
->DelayedRecoveryEvent
= NULL
;
942 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
944 USBKeyboardRecoveryHandler
,
946 &UsbKeyboardDevice
->DelayedRecoveryEvent
954 Handler function for USB keyboard's asynchronous interrupt transfer.
956 This function is the handler function for USB keyboard's asynchronous interrupt transfer
957 to manage the keyboard. It parses the USB keyboard input report, and inserts data to
958 keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key
959 is also set accordingly.
961 @param Data A pointer to a buffer that is filled with key data which is
962 retrieved via asynchronous interrupt transfer.
963 @param DataLength Indicates the size of the data buffer.
964 @param Context Pointing to USB_KB_DEV instance.
965 @param Result Indicates the result of the asynchronous interrupt transfer.
967 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.
968 @retval EFI_DEVICE_ERROR Hardware error occurs.
980 USB_KB_DEV
*UsbKeyboardDevice
;
981 EFI_USB_IO_PROTOCOL
*UsbIo
;
982 UINT8
*CurKeyCodeBuffer
;
983 UINT8
*OldKeyCodeBuffer
;
984 UINT8 CurModifierMap
;
985 UINT8 OldModifierMap
;
994 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
996 ASSERT (Context
!= NULL
);
999 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1000 UsbIo
= UsbKeyboardDevice
->UsbIo
;
1003 // Analyzes Result and performs corresponding action.
1005 if (Result
!= EFI_USB_NOERROR
) {
1007 // Some errors happen during the process
1009 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
1010 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
1011 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_INPUT_ERROR
),
1012 UsbKeyboardDevice
->DevicePath
1016 // Stop the repeat key generation if any
1018 UsbKeyboardDevice
->RepeatKey
= 0;
1021 UsbKeyboardDevice
->RepeatTimer
,
1026 if ((Result
& EFI_USB_ERR_STALL
) == EFI_USB_ERR_STALL
) {
1027 UsbClearEndpointHalt (
1029 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1035 // Delete & Submit this interrupt again
1036 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.
1038 UsbIo
->UsbAsyncInterruptTransfer (
1040 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1048 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.
1051 UsbKeyboardDevice
->DelayedRecoveryEvent
,
1053 EFI_USB_INTERRUPT_DELAY
1056 return EFI_DEVICE_ERROR
;
1060 // If no error and no data, just return EFI_SUCCESS.
1062 if (DataLength
== 0 || Data
== NULL
) {
1067 // Following code checks current keyboard input report against old key code buffer.
1068 // According to USB HID Firmware Specification, the report consists of 8 bytes.
1069 // Byte 0 is map of Modifier keys.
1070 // Byte 1 is reserved.
1071 // Bytes 2 to 7 are keycodes.
1073 CurKeyCodeBuffer
= (UINT8
*) Data
;
1074 OldKeyCodeBuffer
= UsbKeyboardDevice
->LastKeyCodeArray
;
1077 // Checks for new key stroke.
1079 for (Index
= 0; Index
< 8; Index
++) {
1080 if (OldKeyCodeBuffer
[Index
] != CurKeyCodeBuffer
[Index
]) {
1086 // If no new key, return EFI_SUCCESS immediately.
1093 // Parse the modifier key, which is the first byte of keyboard input report.
1095 CurModifierMap
= CurKeyCodeBuffer
[0];
1096 OldModifierMap
= OldKeyCodeBuffer
[0];
1099 // Handle modifier key's pressing or releasing situation.
1100 // According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:
1101 // Bit0: Left Control, Keycode: 0xe0
1102 // Bit1: Left Shift, Keycode: 0xe1
1103 // Bit2: Left Alt, Keycode: 0xe2
1104 // Bit3: Left GUI, Keycode: 0xe3
1105 // Bit4: Right Control, Keycode: 0xe4
1106 // Bit5: Right Shift, Keycode: 0xe5
1107 // Bit6: Right Alt, Keycode: 0xe6
1108 // Bit7: Right GUI, Keycode: 0xe7
1110 for (Index
= 0; Index
< 8; Index
++) {
1111 Mask
= (UINT8
) (1 << Index
);
1112 if ((CurModifierMap
& Mask
) != (OldModifierMap
& Mask
)) {
1114 // If current modifier key is up, then CurModifierMap & Mask = 0;
1115 // otherwise it is a non-zero value.
1116 // Insert the changed modifier key into key buffer.
1118 UsbKey
.KeyCode
= (UINT8
) (0xe0 + Index
);
1119 UsbKey
.Down
= (BOOLEAN
) ((CurModifierMap
& Mask
) != 0);
1120 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1125 // Handle normal key's releasing situation
1126 // Bytes 2 to 7 are for normal keycodes
1129 for (Index
= 2; Index
< 8; Index
++) {
1131 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index
])) {
1135 // For any key in old keycode buffer, if it is not in current keycode buffer,
1136 // then it is released. Otherwise, it is not released.
1139 for (Index2
= 2; Index2
< 8; Index2
++) {
1141 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index2
])) {
1145 if (OldKeyCodeBuffer
[Index
] == CurKeyCodeBuffer
[Index2
]) {
1152 UsbKey
.KeyCode
= OldKeyCodeBuffer
[Index
];
1153 UsbKey
.Down
= FALSE
;
1154 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1156 // The original repeat key is released.
1158 if (OldKeyCodeBuffer
[Index
] == UsbKeyboardDevice
->RepeatKey
) {
1159 UsbKeyboardDevice
->RepeatKey
= 0;
1165 // If original repeat key is released, cancel the repeat timer
1167 if (UsbKeyboardDevice
->RepeatKey
== 0) {
1169 UsbKeyboardDevice
->RepeatTimer
,
1176 // Handle normal key's pressing situation
1179 for (Index
= 2; Index
< 8; Index
++) {
1181 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index
])) {
1185 // For any key in current keycode buffer, if it is not in old keycode buffer,
1186 // then it is pressed. Otherwise, it is not pressed.
1189 for (Index2
= 2; Index2
< 8; Index2
++) {
1191 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index2
])) {
1195 if (CurKeyCodeBuffer
[Index
] == OldKeyCodeBuffer
[Index2
]) {
1202 UsbKey
.KeyCode
= CurKeyCodeBuffer
[Index
];
1204 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1207 // Handle repeat key
1209 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, CurKeyCodeBuffer
[Index
]);
1210 ASSERT (KeyDescriptor
!= NULL
);
1212 if (KeyDescriptor
->Modifier
== EFI_NUM_LOCK_MODIFIER
|| KeyDescriptor
->Modifier
== EFI_CAPS_LOCK_MODIFIER
) {
1214 // For NumLock or CapsLock pressed, there is no need to handle repeat key for them.
1216 UsbKeyboardDevice
->RepeatKey
= 0;
1219 // Prepare new repeat key, and clear the original one.
1221 NewRepeatKey
= CurKeyCodeBuffer
[Index
];
1222 UsbKeyboardDevice
->RepeatKey
= 0;
1228 // Update LastKeycodeArray buffer in the UsbKeyboardDevice data structure.
1230 for (Index
= 0; Index
< 8; Index
++) {
1231 UsbKeyboardDevice
->LastKeyCodeArray
[Index
] = CurKeyCodeBuffer
[Index
];
1235 // If there is new key pressed, update the RepeatKey value, and set the
1236 // timer to repeate delay timer
1238 if (NewRepeatKey
!= 0) {
1240 // Sets trigger time to "Repeat Delay Time",
1241 // to trigger the repeat timer when the key is hold long
1245 UsbKeyboardDevice
->RepeatTimer
,
1249 UsbKeyboardDevice
->RepeatKey
= NewRepeatKey
;
1257 Retrieves a USB keycode after parsing the raw data in keyboard buffer.
1259 This function parses keyboard buffer. It updates state of modifier key for
1260 USB_KB_DEV instancem, and returns keycode for output.
1262 @param UsbKeyboardDevice The USB_KB_DEV instance.
1263 @param KeyCode Pointer to the USB keycode for output.
1265 @retval EFI_SUCCESS Keycode successfully parsed.
1266 @retval EFI_NOT_READY Keyboard buffer is not ready for a valid keycode
1271 IN OUT USB_KB_DEV
*UsbKeyboardDevice
,
1276 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1280 while (!IsQueueEmpty (&UsbKeyboardDevice
->UsbKeyQueue
)) {
1282 // Pops one raw data off.
1284 Dequeue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1286 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1287 ASSERT (KeyDescriptor
!= NULL
);
1293 switch (KeyDescriptor
->Modifier
) {
1298 case EFI_LEFT_CONTROL_MODIFIER
:
1299 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
1300 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1302 case EFI_RIGHT_CONTROL_MODIFIER
:
1303 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
1304 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1310 case EFI_LEFT_SHIFT_MODIFIER
:
1311 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1312 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1314 case EFI_RIGHT_SHIFT_MODIFIER
:
1315 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1316 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1322 case EFI_LEFT_ALT_MODIFIER
:
1323 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
1324 UsbKeyboardDevice
->AltOn
= FALSE
;
1326 case EFI_RIGHT_ALT_MODIFIER
:
1327 UsbKeyboardDevice
->RightAltOn
= FALSE
;
1328 UsbKeyboardDevice
->AltOn
= FALSE
;
1332 // Left Logo release
1334 case EFI_LEFT_LOGO_MODIFIER
:
1335 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
1339 // Right Logo release
1341 case EFI_RIGHT_LOGO_MODIFIER
:
1342 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
1348 case EFI_MENU_MODIFIER
:
1349 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
1355 case EFI_PRINT_MODIFIER
:
1356 case EFI_SYS_REQUEST_MODIFIER
:
1357 UsbKeyboardDevice
->SysReqOn
= FALSE
;
1363 case EFI_ALT_GR_MODIFIER
:
1364 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1375 // Analyzes key pressing situation
1377 switch (KeyDescriptor
->Modifier
) {
1382 case EFI_LEFT_CONTROL_MODIFIER
:
1383 UsbKeyboardDevice
->LeftCtrlOn
= TRUE
;
1384 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1387 case EFI_RIGHT_CONTROL_MODIFIER
:
1388 UsbKeyboardDevice
->RightCtrlOn
= TRUE
;
1389 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1396 case EFI_LEFT_SHIFT_MODIFIER
:
1397 UsbKeyboardDevice
->LeftShiftOn
= TRUE
;
1398 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1401 case EFI_RIGHT_SHIFT_MODIFIER
:
1402 UsbKeyboardDevice
->RightShiftOn
= TRUE
;
1403 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1410 case EFI_LEFT_ALT_MODIFIER
:
1411 UsbKeyboardDevice
->LeftAltOn
= TRUE
;
1412 UsbKeyboardDevice
->AltOn
= TRUE
;
1415 case EFI_RIGHT_ALT_MODIFIER
:
1416 UsbKeyboardDevice
->RightAltOn
= TRUE
;
1417 UsbKeyboardDevice
->AltOn
= TRUE
;
1424 case EFI_LEFT_LOGO_MODIFIER
:
1425 UsbKeyboardDevice
->LeftLogoOn
= TRUE
;
1431 case EFI_RIGHT_LOGO_MODIFIER
:
1432 UsbKeyboardDevice
->RightLogoOn
= TRUE
;
1438 case EFI_MENU_MODIFIER
:
1439 UsbKeyboardDevice
->MenuKeyOn
= TRUE
;
1445 case EFI_PRINT_MODIFIER
:
1446 case EFI_SYS_REQUEST_MODIFIER
:
1447 UsbKeyboardDevice
->SysReqOn
= TRUE
;
1454 case EFI_ALT_GR_MODIFIER
:
1455 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1458 case EFI_NUM_LOCK_MODIFIER
:
1462 UsbKeyboardDevice
->NumLockOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->NumLockOn
));
1463 SetKeyLED (UsbKeyboardDevice
);
1467 case EFI_CAPS_LOCK_MODIFIER
:
1471 UsbKeyboardDevice
->CapsOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->CapsOn
));
1472 SetKeyLED (UsbKeyboardDevice
);
1476 case EFI_SCROLL_LOCK_MODIFIER
:
1478 // Toggle ScrollLock
1480 UsbKeyboardDevice
->ScrollOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->ScrollOn
));
1481 SetKeyLED (UsbKeyboardDevice
);
1490 // When encountering Ctrl + Alt + Del, then warm reset.
1492 if (KeyDescriptor
->Modifier
== EFI_DELETE_MODIFIER
) {
1493 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1494 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1498 *KeyCode
= UsbKey
.KeyCode
;
1502 return EFI_NOT_READY
;
1507 Converts USB Keycode ranging from 0x4 to 0x65 to EFI_INPUT_KEY.
1509 @param UsbKeyboardDevice The USB_KB_DEV instance.
1510 @param KeyCode Indicates the key code that will be interpreted.
1511 @param KeyData A pointer to a buffer that is filled in with
1512 the keystroke information for the key that
1515 @retval EFI_SUCCESS Success.
1516 @retval EFI_INVALID_PARAMETER KeyCode is not in the range of 0x4 to 0x65.
1517 @retval EFI_INVALID_PARAMETER Translated EFI_INPUT_KEY has zero for both ScanCode and UnicodeChar.
1518 @retval EFI_NOT_READY KeyCode represents a dead key with EFI_NS_KEY_MODIFIER
1519 @retval EFI_DEVICE_ERROR Keyboard layout is invalid.
1523 UsbKeyCodeToEfiInputKey (
1524 IN USB_KB_DEV
*UsbKeyboardDevice
,
1526 OUT EFI_KEY_DATA
*KeyData
1529 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1531 LIST_ENTRY
*NotifyList
;
1532 KEYBOARD_CONSOLE_IN_EX_NOTIFY
*CurrentNotify
;
1535 // KeyCode must in the range of 0x4 to 0x65
1537 if (!USBKBD_VALID_KEYCODE (KeyCode
)) {
1538 return EFI_INVALID_PARAMETER
;
1540 if ((KeyCode
- 4) >= NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
) {
1541 return EFI_INVALID_PARAMETER
;
1544 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
1545 ASSERT (KeyDescriptor
!= NULL
);
1547 if (KeyDescriptor
->Modifier
== EFI_NS_KEY_MODIFIER
) {
1549 // If this is a dead key with EFI_NS_KEY_MODIFIER, then record it and return.
1551 UsbKeyboardDevice
->CurrentNsKey
= FindUsbNsKey (UsbKeyboardDevice
, KeyDescriptor
);
1552 return EFI_NOT_READY
;
1555 if (UsbKeyboardDevice
->CurrentNsKey
!= NULL
) {
1557 // If this keystroke follows a non-spacing key, then find the descriptor for corresponding
1560 KeyDescriptor
= FindPhysicalKey (UsbKeyboardDevice
->CurrentNsKey
, KeyDescriptor
);
1561 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
1565 // Make sure modifier of Key Descriptor is in the valid range according to UEFI spec.
1567 if (KeyDescriptor
->Modifier
>= (sizeof (ModifierValueToEfiScanCodeConvertionTable
) / sizeof (UINT8
))) {
1568 return EFI_DEVICE_ERROR
;
1571 KeyData
->Key
.ScanCode
= ModifierValueToEfiScanCodeConvertionTable
[KeyDescriptor
->Modifier
];
1572 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1574 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_STANDARD_SHIFT
)!= 0) {
1575 if (UsbKeyboardDevice
->ShiftOn
) {
1576 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1579 // Need not return associated shift state if a class of printable characters that
1580 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'
1582 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1583 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1584 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1587 if (UsbKeyboardDevice
->AltGrOn
) {
1588 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedAltGrUnicode
;
1594 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1596 if (UsbKeyboardDevice
->AltGrOn
) {
1597 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->AltGrUnicode
;
1602 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1603 if (UsbKeyboardDevice
->CapsOn
) {
1604 if (KeyData
->Key
.UnicodeChar
== KeyDescriptor
->Unicode
) {
1605 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1606 } else if (KeyData
->Key
.UnicodeChar
== KeyDescriptor
->ShiftedUnicode
) {
1607 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1612 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_NUM_LOCK
) != 0) {
1614 // For key affected by NumLock, if NumLock is on and Shift is not pressed, then it means
1615 // normal key, instead of original control key. So the ScanCode should be cleaned.
1616 // Otherwise, it means control key, so preserve the EFI Scan Code and clear the unicode keycode.
1618 if ((UsbKeyboardDevice
->NumLockOn
) && (!(UsbKeyboardDevice
->ShiftOn
))) {
1619 KeyData
->Key
.ScanCode
= SCAN_NULL
;
1621 KeyData
->Key
.UnicodeChar
= 0x00;
1626 // Translate Unicode 0x1B (ESC) to EFI Scan Code
1628 if (KeyData
->Key
.UnicodeChar
== 0x1B && KeyData
->Key
.ScanCode
== SCAN_NULL
) {
1629 KeyData
->Key
.ScanCode
= SCAN_ESC
;
1630 KeyData
->Key
.UnicodeChar
= 0x00;
1634 // Not valid for key without both unicode key code and EFI Scan Code.
1636 if (KeyData
->Key
.UnicodeChar
== 0 && KeyData
->Key
.ScanCode
== SCAN_NULL
) {
1637 return EFI_NOT_READY
;
1641 // Save Shift/Toggle state
1643 KeyData
->KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
;
1644 KeyData
->KeyState
.KeyToggleState
= EFI_TOGGLE_STATE_VALID
;
1646 if (UsbKeyboardDevice
->LeftCtrlOn
) {
1647 KeyData
->KeyState
.KeyShiftState
|= EFI_LEFT_CONTROL_PRESSED
;
1649 if (UsbKeyboardDevice
->RightCtrlOn
) {
1650 KeyData
->KeyState
.KeyShiftState
|= EFI_RIGHT_CONTROL_PRESSED
;
1652 if (UsbKeyboardDevice
->LeftAltOn
) {
1653 KeyData
->KeyState
.KeyShiftState
|= EFI_LEFT_ALT_PRESSED
;
1655 if (UsbKeyboardDevice
->RightAltOn
) {
1656 KeyData
->KeyState
.KeyShiftState
|= EFI_RIGHT_ALT_PRESSED
;
1658 if (UsbKeyboardDevice
->LeftShiftOn
) {
1659 KeyData
->KeyState
.KeyShiftState
|= EFI_LEFT_SHIFT_PRESSED
;
1661 if (UsbKeyboardDevice
->RightShiftOn
) {
1662 KeyData
->KeyState
.KeyShiftState
|= EFI_RIGHT_SHIFT_PRESSED
;
1664 if (UsbKeyboardDevice
->LeftLogoOn
) {
1665 KeyData
->KeyState
.KeyShiftState
|= EFI_LEFT_LOGO_PRESSED
;
1667 if (UsbKeyboardDevice
->RightLogoOn
) {
1668 KeyData
->KeyState
.KeyShiftState
|= EFI_RIGHT_LOGO_PRESSED
;
1670 if (UsbKeyboardDevice
->MenuKeyOn
) {
1671 KeyData
->KeyState
.KeyShiftState
|= EFI_MENU_KEY_PRESSED
;
1673 if (UsbKeyboardDevice
->SysReqOn
) {
1674 KeyData
->KeyState
.KeyShiftState
|= EFI_SYS_REQ_PRESSED
;
1677 if (UsbKeyboardDevice
->ScrollOn
) {
1678 KeyData
->KeyState
.KeyToggleState
|= EFI_SCROLL_LOCK_ACTIVE
;
1680 if (UsbKeyboardDevice
->NumLockOn
) {
1681 KeyData
->KeyState
.KeyToggleState
|= EFI_NUM_LOCK_ACTIVE
;
1683 if (UsbKeyboardDevice
->CapsOn
) {
1684 KeyData
->KeyState
.KeyToggleState
|= EFI_CAPS_LOCK_ACTIVE
;
1688 // Invoke notification functions if the key is registered.
1690 NotifyList
= &UsbKeyboardDevice
->NotifyList
;
1691 for (Link
= GetFirstNode (NotifyList
); !IsNull (NotifyList
, Link
); Link
= GetNextNode (NotifyList
, Link
)) {
1692 CurrentNotify
= CR (Link
, KEYBOARD_CONSOLE_IN_EX_NOTIFY
, NotifyEntry
, USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE
);
1693 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
1694 CurrentNotify
->KeyNotificationFn (KeyData
);
1699 // Translate the CTRL-Alpha characters to their corresponding control value
1700 // (ctrl-a = 0x0001 through ctrl-Z = 0x001A)
1702 if (UsbKeyboardDevice
->CtrlOn
) {
1703 if (KeyData
->Key
.UnicodeChar
>= 'a' && KeyData
->Key
.UnicodeChar
<= 'z') {
1704 KeyData
->Key
.UnicodeChar
= (UINT8
) (KeyData
->Key
.UnicodeChar
- 'a' + 1);
1705 } else if (KeyData
->Key
.UnicodeChar
>= 'A' && KeyData
->Key
.UnicodeChar
<= 'Z') {
1706 KeyData
->Key
.UnicodeChar
= (UINT8
) (KeyData
->Key
.UnicodeChar
- 'A' + 1);
1717 @param Queue Points to the queue.
1718 @param ItemSize Size of the single item.
1723 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1729 Queue
->ItemSize
= ItemSize
;
1733 if (Queue
->Buffer
[0] != NULL
) {
1734 FreePool (Queue
->Buffer
[0]);
1737 Queue
->Buffer
[0] = AllocatePool (sizeof (Queue
->Buffer
) / sizeof (Queue
->Buffer
[0]) * ItemSize
);
1738 ASSERT (Queue
->Buffer
[0] != NULL
);
1740 for (Index
= 1; Index
< sizeof (Queue
->Buffer
) / sizeof (Queue
->Buffer
[0]); Index
++) {
1741 Queue
->Buffer
[Index
] = ((UINT8
*) Queue
->Buffer
[Index
- 1]) + ItemSize
;
1748 @param Queue Points to the queue.
1752 IN OUT USB_SIMPLE_QUEUE
*Queue
1755 FreePool (Queue
->Buffer
[0]);
1760 Check whether the queue is empty.
1762 @param Queue Points to the queue.
1764 @retval TRUE Queue is empty.
1765 @retval FALSE Queue is not empty.
1770 IN USB_SIMPLE_QUEUE
*Queue
1774 // Meet FIFO empty condition
1776 return (BOOLEAN
) (Queue
->Head
== Queue
->Tail
);
1781 Check whether the queue is full.
1783 @param Queue Points to the queue.
1785 @retval TRUE Queue is full.
1786 @retval FALSE Queue is not full.
1791 IN USB_SIMPLE_QUEUE
*Queue
1794 return (BOOLEAN
) (((Queue
->Tail
+ 1) % (MAX_KEY_ALLOWED
+ 1)) == Queue
->Head
);
1799 Enqueue the item to the queue.
1801 @param Queue Points to the queue.
1802 @param Item Points to the item to be enqueued.
1803 @param ItemSize Size of the item.
1807 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1812 ASSERT (ItemSize
== Queue
->ItemSize
);
1814 // If keyboard buffer is full, throw the
1815 // first key out of the keyboard buffer.
1817 if (IsQueueFull (Queue
)) {
1818 Queue
->Head
= (Queue
->Head
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1821 CopyMem (Queue
->Buffer
[Queue
->Tail
], Item
, ItemSize
);
1824 // Adjust the tail pointer of the FIFO keyboard buffer.
1826 Queue
->Tail
= (Queue
->Tail
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1831 Dequeue a item from the queue.
1833 @param Queue Points to the queue.
1834 @param Item Receives the item.
1835 @param ItemSize Size of the item.
1837 @retval EFI_SUCCESS Item was successfully dequeued.
1838 @retval EFI_DEVICE_ERROR The queue is empty.
1843 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1848 ASSERT (Queue
->ItemSize
== ItemSize
);
1850 if (IsQueueEmpty (Queue
)) {
1851 return EFI_DEVICE_ERROR
;
1854 CopyMem (Item
, Queue
->Buffer
[Queue
->Head
], ItemSize
);
1857 // Adjust the head pointer of the FIFO keyboard buffer.
1859 Queue
->Head
= (Queue
->Head
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1866 Sets USB keyboard LED state.
1868 @param UsbKeyboardDevice The USB_KB_DEV instance.
1873 IN USB_KB_DEV
*UsbKeyboardDevice
1880 // Set each field in Led map.
1882 Led
.NumLock
= (UINT8
) ((UsbKeyboardDevice
->NumLockOn
) ? 1 : 0);
1883 Led
.CapsLock
= (UINT8
) ((UsbKeyboardDevice
->CapsOn
) ? 1 : 0);
1884 Led
.ScrollLock
= (UINT8
) ((UsbKeyboardDevice
->ScrollOn
) ? 1 : 0);
1889 // Call Set_Report Request to lighten the LED.
1891 UsbSetReportRequest (
1892 UsbKeyboardDevice
->UsbIo
,
1893 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
1903 Handler for Repeat Key event.
1905 This function is the handler for Repeat Key event triggered
1907 After a repeatable key is pressed, the event would be triggered
1908 with interval of USBKBD_REPEAT_DELAY. Once the event is triggered,
1909 following trigger will come with interval of USBKBD_REPEAT_RATE.
1911 @param Event The Repeat Key event.
1912 @param Context Points to the USB_KB_DEV instance.
1917 USBKeyboardRepeatHandler (
1922 USB_KB_DEV
*UsbKeyboardDevice
;
1925 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1928 // Do nothing when there is no repeat key.
1930 if (UsbKeyboardDevice
->RepeatKey
!= 0) {
1932 // Inserts the repeat key into keyboard buffer,
1934 UsbKey
.KeyCode
= UsbKeyboardDevice
->RepeatKey
;
1936 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1939 // Set repeat rate for next repeat key generation.
1942 UsbKeyboardDevice
->RepeatTimer
,
1951 Handler for Delayed Recovery event.
1953 This function is the handler for Delayed Recovery event triggered
1955 After a device error occurs, the event would be triggered
1956 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY
1957 is defined in USB standard for error handling.
1959 @param Event The Delayed Recovery event.
1960 @param Context Points to the USB_KB_DEV instance.
1965 USBKeyboardRecoveryHandler (
1971 USB_KB_DEV
*UsbKeyboardDevice
;
1972 EFI_USB_IO_PROTOCOL
*UsbIo
;
1975 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1977 UsbIo
= UsbKeyboardDevice
->UsbIo
;
1979 PacketSize
= (UINT8
) (UsbKeyboardDevice
->IntEndpointDescriptor
.MaxPacketSize
);
1982 // Re-submit Asynchronous Interrupt Transfer for recovery.
1984 UsbIo
->UsbAsyncInterruptTransfer (
1986 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1988 UsbKeyboardDevice
->IntEndpointDescriptor
.Interval
,