2 Helper functions for USB Keyboard Driver.
4 Copyright (c) 2004 - 2018, 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 {EfiKeyC12
, '\\', '|', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
83 {EfiKeyC10
, ';', ':', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
84 {EfiKeyC11
, '\'', '"', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
85 {EfiKeyE0
, '`', '~', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
86 {EfiKeyB8
, ',', '<', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
87 {EfiKeyB9
, '.', '>', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
88 {EfiKeyB10
, '/', '?', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
},
89 {EfiKeyCapsLock
, 0x00, 0x00, 0, 0, EFI_CAPS_LOCK_MODIFIER
, 0},
90 {EfiKeyF1
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_ONE_MODIFIER
, 0},
91 {EfiKeyF2
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TWO_MODIFIER
, 0},
92 {EfiKeyF3
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_THREE_MODIFIER
, 0},
93 {EfiKeyF4
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_FOUR_MODIFIER
, 0},
94 {EfiKeyF5
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_FIVE_MODIFIER
, 0},
95 {EfiKeyF6
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_SIX_MODIFIER
, 0},
96 {EfiKeyF7
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_SEVEN_MODIFIER
, 0},
97 {EfiKeyF8
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_EIGHT_MODIFIER
, 0},
98 {EfiKeyF9
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_NINE_MODIFIER
, 0},
99 {EfiKeyF10
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TEN_MODIFIER
, 0},
100 {EfiKeyF11
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_ELEVEN_MODIFIER
, 0},
101 {EfiKeyF12
, 0x00, 0x00, 0, 0, EFI_FUNCTION_KEY_TWELVE_MODIFIER
, 0},
102 {EfiKeyPrint
, 0x00, 0x00, 0, 0, EFI_PRINT_MODIFIER
, 0},
103 {EfiKeySLck
, 0x00, 0x00, 0, 0, EFI_SCROLL_LOCK_MODIFIER
, 0},
104 {EfiKeyPause
, 0x00, 0x00, 0, 0, EFI_PAUSE_MODIFIER
, 0},
105 {EfiKeyIns
, 0x00, 0x00, 0, 0, EFI_INSERT_MODIFIER
, 0},
106 {EfiKeyHome
, 0x00, 0x00, 0, 0, EFI_HOME_MODIFIER
, 0},
107 {EfiKeyPgUp
, 0x00, 0x00, 0, 0, EFI_PAGE_UP_MODIFIER
, 0},
108 {EfiKeyDel
, 0x00, 0x00, 0, 0, EFI_DELETE_MODIFIER
, 0},
109 {EfiKeyEnd
, 0x00, 0x00, 0, 0, EFI_END_MODIFIER
, 0},
110 {EfiKeyPgDn
, 0x00, 0x00, 0, 0, EFI_PAGE_DOWN_MODIFIER
, 0},
111 {EfiKeyRightArrow
, 0x00, 0x00, 0, 0, EFI_RIGHT_ARROW_MODIFIER
, 0},
112 {EfiKeyLeftArrow
, 0x00, 0x00, 0, 0, EFI_LEFT_ARROW_MODIFIER
, 0},
113 {EfiKeyDownArrow
, 0x00, 0x00, 0, 0, EFI_DOWN_ARROW_MODIFIER
, 0},
114 {EfiKeyUpArrow
, 0x00, 0x00, 0, 0, EFI_UP_ARROW_MODIFIER
, 0},
115 {EfiKeyNLck
, 0x00, 0x00, 0, 0, EFI_NUM_LOCK_MODIFIER
, 0},
116 {EfiKeySlash
, '/', '/', 0, 0, EFI_NULL_MODIFIER
, 0},
117 {EfiKeyAsterisk
, '*', '*', 0, 0, EFI_NULL_MODIFIER
, 0},
118 {EfiKeyMinus
, '-', '-', 0, 0, EFI_NULL_MODIFIER
, 0},
119 {EfiKeyPlus
, '+', '+', 0, 0, EFI_NULL_MODIFIER
, 0},
120 {EfiKeyEnter
, 0x0d, 0x0d, 0, 0, EFI_NULL_MODIFIER
, 0},
121 {EfiKeyOne
, '1', '1', 0, 0, EFI_END_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
122 {EfiKeyTwo
, '2', '2', 0, 0, EFI_DOWN_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
123 {EfiKeyThree
, '3', '3', 0, 0, EFI_PAGE_DOWN_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
124 {EfiKeyFour
, '4', '4', 0, 0, EFI_LEFT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
125 {EfiKeyFive
, '5', '5', 0, 0, EFI_NULL_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
126 {EfiKeySix
, '6', '6', 0, 0, EFI_RIGHT_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
127 {EfiKeySeven
, '7', '7', 0, 0, EFI_HOME_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
128 {EfiKeyEight
, '8', '8', 0, 0, EFI_UP_ARROW_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
129 {EfiKeyNine
, '9', '9', 0, 0, EFI_PAGE_UP_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
130 {EfiKeyZero
, '0', '0', 0, 0, EFI_INSERT_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
131 {EfiKeyPeriod
, '.', '.', 0, 0, EFI_DELETE_MODIFIER
, EFI_AFFECTED_BY_STANDARD_SHIFT
| EFI_AFFECTED_BY_NUM_LOCK
},
132 {EfiKeyA4
, 0x00, 0x00, 0, 0, EFI_MENU_MODIFIER
, 0},
133 {EfiKeyLCtrl
, 0, 0, 0, 0, EFI_LEFT_CONTROL_MODIFIER
, 0},
134 {EfiKeyLShift
, 0, 0, 0, 0, EFI_LEFT_SHIFT_MODIFIER
, 0},
135 {EfiKeyLAlt
, 0, 0, 0, 0, EFI_LEFT_ALT_MODIFIER
, 0},
136 {EfiKeyA0
, 0, 0, 0, 0, EFI_LEFT_LOGO_MODIFIER
, 0},
137 {EfiKeyRCtrl
, 0, 0, 0, 0, EFI_RIGHT_CONTROL_MODIFIER
, 0},
138 {EfiKeyRShift
, 0, 0, 0, 0, EFI_RIGHT_SHIFT_MODIFIER
, 0},
139 {EfiKeyA2
, 0, 0, 0, 0, EFI_RIGHT_ALT_MODIFIER
, 0},
140 {EfiKeyA3
, 0, 0, 0, 0, EFI_RIGHT_LOGO_MODIFIER
, 0},
142 1, // DescriptionCount
143 {'e', 'n', '-', 'U', 'S'}, // RFC4646 language code
145 {'E', 'n', 'g', 'l', 'i', 's', 'h', ' ', 'K', 'e', 'y', 'b', 'o', 'a', 'r', 'd', '\0'}, // DescriptionString[]
149 // EFI_KEY to USB Keycode conversion table
150 // EFI_KEY is defined in UEFI spec.
151 // USB Keycode is defined in USB HID Firmware spec.
153 UINT8 EfiKeyToUsbKeyCodeConvertionTable
[] = {
157 0x2c, // EfiKeySpaceBar
162 0x50, // EfiKeyLeftArrow
163 0x51, // EfiKeyDownArrow
164 0x4F, // EfiKeyRightArrow
166 0x63, // EfiKeyPeriod
168 0xe1, // EfiKeyLShift
180 0xe5, // EfiKeyRShift
181 0x52, // EfiKeyUpArrow
185 0x39, // EfiKeyCapsLock
235 0x2A, // EfiKeyBackSpace
241 0x55, // EfiKeyAsterisk
262 // Keyboard modifier value to EFI Scan Code convertion table
263 // EFI Scan Code and the modifier values are defined in UEFI spec.
265 UINT8 ModifierValueToEfiScanCodeConvertionTable
[] = {
266 SCAN_NULL
, // EFI_NULL_MODIFIER
267 SCAN_NULL
, // EFI_LEFT_CONTROL_MODIFIER
268 SCAN_NULL
, // EFI_RIGHT_CONTROL_MODIFIER
269 SCAN_NULL
, // EFI_LEFT_ALT_MODIFIER
270 SCAN_NULL
, // EFI_RIGHT_ALT_MODIFIER
271 SCAN_NULL
, // EFI_ALT_GR_MODIFIER
272 SCAN_INSERT
, // EFI_INSERT_MODIFIER
273 SCAN_DELETE
, // EFI_DELETE_MODIFIER
274 SCAN_PAGE_DOWN
, // EFI_PAGE_DOWN_MODIFIER
275 SCAN_PAGE_UP
, // EFI_PAGE_UP_MODIFIER
276 SCAN_HOME
, // EFI_HOME_MODIFIER
277 SCAN_END
, // EFI_END_MODIFIER
278 SCAN_NULL
, // EFI_LEFT_SHIFT_MODIFIER
279 SCAN_NULL
, // EFI_RIGHT_SHIFT_MODIFIER
280 SCAN_NULL
, // EFI_CAPS_LOCK_MODIFIER
281 SCAN_NULL
, // EFI_NUM_LOCK_MODIFIER
282 SCAN_LEFT
, // EFI_LEFT_ARROW_MODIFIER
283 SCAN_RIGHT
, // EFI_RIGHT_ARROW_MODIFIER
284 SCAN_DOWN
, // EFI_DOWN_ARROW_MODIFIER
285 SCAN_UP
, // EFI_UP_ARROW_MODIFIER
286 SCAN_NULL
, // EFI_NS_KEY_MODIFIER
287 SCAN_NULL
, // EFI_NS_KEY_DEPENDENCY_MODIFIER
288 SCAN_F1
, // EFI_FUNCTION_KEY_ONE_MODIFIER
289 SCAN_F2
, // EFI_FUNCTION_KEY_TWO_MODIFIER
290 SCAN_F3
, // EFI_FUNCTION_KEY_THREE_MODIFIER
291 SCAN_F4
, // EFI_FUNCTION_KEY_FOUR_MODIFIER
292 SCAN_F5
, // EFI_FUNCTION_KEY_FIVE_MODIFIER
293 SCAN_F6
, // EFI_FUNCTION_KEY_SIX_MODIFIER
294 SCAN_F7
, // EFI_FUNCTION_KEY_SEVEN_MODIFIER
295 SCAN_F8
, // EFI_FUNCTION_KEY_EIGHT_MODIFIER
296 SCAN_F9
, // EFI_FUNCTION_KEY_NINE_MODIFIER
297 SCAN_F10
, // EFI_FUNCTION_KEY_TEN_MODIFIER
298 SCAN_F11
, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER
299 SCAN_F12
, // EFI_FUNCTION_KEY_TWELVE_MODIFIER
301 // For Partial Keystroke support
303 SCAN_NULL
, // EFI_PRINT_MODIFIER
304 SCAN_NULL
, // EFI_SYS_REQUEST_MODIFIER
305 SCAN_NULL
, // EFI_SCROLL_LOCK_MODIFIER
306 SCAN_PAUSE
, // EFI_PAUSE_MODIFIER
307 SCAN_NULL
, // EFI_BREAK_MODIFIER
308 SCAN_NULL
, // EFI_LEFT_LOGO_MODIFIER
309 SCAN_NULL
, // EFI_RIGHT_LOGO_MODIFER
310 SCAN_NULL
, // EFI_MENU_MODIFER
314 Initialize Key Convention Table by using default keyboard layout.
316 @param UsbKeyboardDevice The USB_KB_DEV instance.
318 @retval EFI_SUCCESS The default keyboard layout was installed successfully
319 @retval Others Failure to install default keyboard layout.
322 InstallDefaultKeyboardLayout (
323 IN OUT USB_KB_DEV
*UsbKeyboardDevice
327 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
328 EFI_HII_HANDLE HiiHandle
;
331 // Locate Hii database protocol
333 Status
= gBS
->LocateProtocol (
334 &gEfiHiiDatabaseProtocolGuid
,
336 (VOID
**) &HiiDatabase
338 if (EFI_ERROR (Status
)) {
343 // Install Keyboard Layout package to HII database
345 HiiHandle
= HiiAddPackages (
346 &gUsbKeyboardLayoutPackageGuid
,
347 UsbKeyboardDevice
->ControllerHandle
,
348 &mUsbKeyboardLayoutBin
,
351 if (HiiHandle
== NULL
) {
352 return EFI_OUT_OF_RESOURCES
;
356 // Set current keyboard layout
358 Status
= HiiDatabase
->SetKeyboardLayout (HiiDatabase
, &gUsbKeyboardLayoutKeyGuid
);
365 Uses USB I/O to check whether the device is a USB keyboard device.
367 @param UsbIo Pointer to a USB I/O protocol instance.
369 @retval TRUE Device is a USB keyboard device.
370 @retval FALSE Device is a not USB keyboard device.
375 IN EFI_USB_IO_PROTOCOL
*UsbIo
379 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor
;
382 // Get the default interface descriptor
384 Status
= UsbIo
->UsbGetInterfaceDescriptor (
389 if (EFI_ERROR (Status
)) {
393 if (InterfaceDescriptor
.InterfaceClass
== CLASS_HID
&&
394 InterfaceDescriptor
.InterfaceSubClass
== SUBCLASS_BOOT
&&
395 InterfaceDescriptor
.InterfaceProtocol
== PROTOCOL_KEYBOARD
404 Get current keyboard layout from HII database.
406 @return Pointer to HII Keyboard Layout.
407 NULL means failure occurred while trying to get keyboard layout.
410 EFI_HII_KEYBOARD_LAYOUT
*
411 GetCurrentKeyboardLayout (
416 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
417 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
421 // Locate HII Database Protocol
423 Status
= gBS
->LocateProtocol (
424 &gEfiHiiDatabaseProtocolGuid
,
426 (VOID
**) &HiiDatabase
428 if (EFI_ERROR (Status
)) {
433 // Get current keyboard layout from HII database
436 KeyboardLayout
= NULL
;
437 Status
= HiiDatabase
->GetKeyboardLayout (
443 if (Status
== EFI_BUFFER_TOO_SMALL
) {
444 KeyboardLayout
= AllocatePool (Length
);
445 ASSERT (KeyboardLayout
!= NULL
);
447 Status
= HiiDatabase
->GetKeyboardLayout (
453 if (EFI_ERROR (Status
)) {
454 FreePool (KeyboardLayout
);
455 KeyboardLayout
= NULL
;
459 return KeyboardLayout
;
463 Find Key Descriptor in Key Convertion Table given its USB keycode.
465 @param UsbKeyboardDevice The USB_KB_DEV instance.
466 @param KeyCode USB Keycode.
468 @return The Key Descriptor in Key Convertion Table.
469 NULL means not found.
474 IN USB_KB_DEV
*UsbKeyboardDevice
,
481 // Make sure KeyCode is in the range of [0x4, 0x65] or [0xe0, 0xe7]
483 if ((!USBKBD_VALID_KEYCODE (KeyCode
)) || ((KeyCode
> 0x65) && (KeyCode
< 0xe0)) || (KeyCode
> 0xe7)) {
488 // Calculate the index of Key Descriptor in Key Convertion Table
490 if (KeyCode
<= 0x65) {
491 Index
= (UINT8
) (KeyCode
- 4);
493 Index
= (UINT8
) (KeyCode
- 0xe0 + NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE
);
496 return &UsbKeyboardDevice
->KeyConvertionTable
[Index
];
500 Find Non-Spacing key for given Key descriptor.
502 @param UsbKeyboardDevice The USB_KB_DEV instance.
503 @param KeyDescriptor Key descriptor.
505 @return The Non-Spacing key corresponding to KeyDescriptor
506 NULL means not found.
511 IN USB_KB_DEV
*UsbKeyboardDevice
,
512 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
516 LIST_ENTRY
*NsKeyList
;
517 USB_NS_KEY
*UsbNsKey
;
519 NsKeyList
= &UsbKeyboardDevice
->NsKeyList
;
520 Link
= GetFirstNode (NsKeyList
);
521 while (!IsNull (NsKeyList
, Link
)) {
522 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
524 if (UsbNsKey
->NsKey
[0].Key
== KeyDescriptor
->Key
) {
528 Link
= GetNextNode (NsKeyList
, Link
);
535 Find physical key definition for a given key descriptor.
537 For a specified non-spacing key, there are a list of physical
538 keys following it. This function traverses the list of
539 physical keys and tries to find the physical key matching
542 @param UsbNsKey The non-spacing key information.
543 @param KeyDescriptor The key descriptor.
545 @return The physical key definition.
546 If no physical key is found, parameter KeyDescriptor is returned.
551 IN USB_NS_KEY
*UsbNsKey
,
552 IN EFI_KEY_DESCRIPTOR
*KeyDescriptor
556 EFI_KEY_DESCRIPTOR
*PhysicalKey
;
558 PhysicalKey
= &UsbNsKey
->NsKey
[1];
559 for (Index
= 0; Index
< UsbNsKey
->KeyCount
; Index
++) {
560 if (KeyDescriptor
->Key
== PhysicalKey
->Key
) {
568 // No children definition matched, return original key
570 return KeyDescriptor
;
574 The notification function for EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID.
576 This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
577 group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
578 It tries to get curent keyboard layout from HII database.
580 @param Event Event being signaled.
581 @param Context Points to USB_KB_DEV instance.
586 SetKeyboardLayoutEvent (
591 USB_KB_DEV
*UsbKeyboardDevice
;
592 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
593 EFI_KEY_DESCRIPTOR TempKey
;
594 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
595 EFI_KEY_DESCRIPTOR
*TableEntry
;
596 EFI_KEY_DESCRIPTOR
*NsKey
;
597 USB_NS_KEY
*UsbNsKey
;
603 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
604 if (UsbKeyboardDevice
->Signature
!= USB_KB_DEV_SIGNATURE
) {
609 // Try to get current keyboard layout from HII database
611 KeyboardLayout
= GetCurrentKeyboardLayout ();
612 if (KeyboardLayout
== NULL
) {
617 // Re-allocate resource for KeyConvertionTable
619 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
620 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
621 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
624 // Traverse the list of key descriptors following the header of EFI_HII_KEYBOARD_LAYOUT
626 KeyDescriptor
= (EFI_KEY_DESCRIPTOR
*) (((UINT8
*) KeyboardLayout
) + sizeof (EFI_HII_KEYBOARD_LAYOUT
));
627 for (Index
= 0; Index
< KeyboardLayout
->DescriptorCount
; Index
++) {
629 // Copy from HII keyboard layout package binary for alignment
631 CopyMem (&TempKey
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
634 // Fill the key into KeyConvertionTable, whose index is calculated from USB keycode.
636 KeyCode
= EfiKeyToUsbKeyCodeConvertionTable
[(UINT8
) (TempKey
.Key
)];
637 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
638 if (TableEntry
== NULL
) {
639 ReleaseKeyboardLayoutResources (UsbKeyboardDevice
);
640 FreePool (KeyboardLayout
);
643 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
646 // For non-spacing key, create the list with a non-spacing key followed by physical keys.
648 if (TempKey
.Modifier
== EFI_NS_KEY_MODIFIER
) {
649 UsbNsKey
= AllocateZeroPool (sizeof (USB_NS_KEY
));
650 ASSERT (UsbNsKey
!= NULL
);
653 // Search for sequential children physical key definitions
656 NsKey
= KeyDescriptor
+ 1;
657 for (Index2
= (UINT8
) Index
+ 1; Index2
< KeyboardLayout
->DescriptorCount
; Index2
++) {
658 CopyMem (&TempKey
, NsKey
, sizeof (EFI_KEY_DESCRIPTOR
));
659 if (TempKey
.Modifier
== EFI_NS_KEY_DEPENDENCY_MODIFIER
) {
667 UsbNsKey
->Signature
= USB_NS_KEY_SIGNATURE
;
668 UsbNsKey
->KeyCount
= KeyCount
;
669 UsbNsKey
->NsKey
= AllocateCopyPool (
670 (KeyCount
+ 1) * sizeof (EFI_KEY_DESCRIPTOR
),
673 InsertTailList (&UsbKeyboardDevice
->NsKeyList
, &UsbNsKey
->Link
);
676 // Skip over the child physical keys
679 KeyDescriptor
+= KeyCount
;
686 // There are two EfiKeyEnter, duplicate its key descriptor
688 TableEntry
= GetKeyDescriptor (UsbKeyboardDevice
, 0x58);
689 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, 0x28);
690 CopyMem (TableEntry
, KeyDescriptor
, sizeof (EFI_KEY_DESCRIPTOR
));
692 FreePool (KeyboardLayout
);
696 Destroy resources for keyboard layout.
698 @param UsbKeyboardDevice The USB_KB_DEV instance.
702 ReleaseKeyboardLayoutResources (
703 IN OUT USB_KB_DEV
*UsbKeyboardDevice
706 USB_NS_KEY
*UsbNsKey
;
709 if (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
) {
710 FreePool (UsbKeyboardDevice
->KeyConvertionTable
);
712 UsbKeyboardDevice
->KeyConvertionTable
= NULL
;
714 while (!IsListEmpty (&UsbKeyboardDevice
->NsKeyList
)) {
715 Link
= GetFirstNode (&UsbKeyboardDevice
->NsKeyList
);
716 UsbNsKey
= USB_NS_KEY_FORM_FROM_LINK (Link
);
717 RemoveEntryList (&UsbNsKey
->Link
);
719 FreePool (UsbNsKey
->NsKey
);
725 Initialize USB keyboard layout.
727 This function initializes Key Convertion Table for the USB keyboard device.
728 It first tries to retrieve layout from HII database. If failed and default
729 layout is enabled, then it just uses the default layout.
731 @param UsbKeyboardDevice The USB_KB_DEV instance.
733 @retval EFI_SUCCESS Initialization succeeded.
734 @retval EFI_NOT_READY Keyboard layout cannot be retrieve from HII
735 database, and default layout is disabled.
736 @retval Other Fail to register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group.
741 OUT USB_KB_DEV
*UsbKeyboardDevice
744 EFI_HII_KEYBOARD_LAYOUT
*KeyboardLayout
;
747 UsbKeyboardDevice
->KeyConvertionTable
= AllocateZeroPool ((NUMBER_OF_VALID_USB_KEYCODE
) * sizeof (EFI_KEY_DESCRIPTOR
));
748 ASSERT (UsbKeyboardDevice
->KeyConvertionTable
!= NULL
);
750 InitializeListHead (&UsbKeyboardDevice
->NsKeyList
);
751 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
752 UsbKeyboardDevice
->KeyboardLayoutEvent
= NULL
;
755 // Register event to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
756 // which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
758 Status
= gBS
->CreateEventEx (
761 SetKeyboardLayoutEvent
,
763 &gEfiHiiKeyBoardLayoutGuid
,
764 &UsbKeyboardDevice
->KeyboardLayoutEvent
766 if (EFI_ERROR (Status
)) {
770 KeyboardLayout
= GetCurrentKeyboardLayout ();
771 if (KeyboardLayout
!= NULL
) {
773 // If current keyboard layout is successfully retrieved from HII database,
774 // force to initialize the keyboard layout.
776 gBS
->SignalEvent (UsbKeyboardDevice
->KeyboardLayoutEvent
);
778 if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver
)) {
780 // If no keyboard layout can be retrieved from HII database, and default layout
781 // is disabled, then return EFI_NOT_READY.
783 return EFI_NOT_READY
;
786 // If no keyboard layout can be retrieved from HII database, and default layout
787 // is enabled, then load the default keyboard layout.
789 InstallDefaultKeyboardLayout (UsbKeyboardDevice
);
797 Initialize USB keyboard device and all private data structures.
799 @param UsbKeyboardDevice The USB_KB_DEV instance.
801 @retval EFI_SUCCESS Initialization is successful.
802 @retval EFI_DEVICE_ERROR Keyboard initialization failed.
807 IN OUT USB_KB_DEV
*UsbKeyboardDevice
813 UINT32 TransferResult
;
815 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
817 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_KEYBOARD_PC_SELF_TEST
),
818 UsbKeyboardDevice
->DevicePath
821 InitQueue (&UsbKeyboardDevice
->UsbKeyQueue
, sizeof (USB_KEY
));
822 InitQueue (&UsbKeyboardDevice
->EfiKeyQueue
, sizeof (EFI_KEY_DATA
));
823 InitQueue (&UsbKeyboardDevice
->EfiKeyQueueForNotify
, sizeof (EFI_KEY_DATA
));
826 // Use the config out of the descriptor
827 // Assumed the first config is the correct one and this is not always the case
829 Status
= UsbGetConfiguration (
830 UsbKeyboardDevice
->UsbIo
,
834 if (EFI_ERROR (Status
)) {
837 // Uses default configuration to configure the USB Keyboard device.
839 Status
= UsbSetConfiguration (
840 UsbKeyboardDevice
->UsbIo
,
844 if (EFI_ERROR (Status
)) {
846 // If configuration could not be set here, it means
847 // the keyboard interface has some errors and could
848 // not be initialized
850 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
851 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
852 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_INTERFACE_ERROR
),
853 UsbKeyboardDevice
->DevicePath
856 return EFI_DEVICE_ERROR
;
860 UsbGetProtocolRequest (
861 UsbKeyboardDevice
->UsbIo
,
862 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
866 // Set boot protocol for the USB Keyboard.
867 // This driver only supports boot protocol.
869 if (Protocol
!= BOOT_PROTOCOL
) {
870 UsbSetProtocolRequest (
871 UsbKeyboardDevice
->UsbIo
,
872 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
877 UsbKeyboardDevice
->CtrlOn
= FALSE
;
878 UsbKeyboardDevice
->AltOn
= FALSE
;
879 UsbKeyboardDevice
->ShiftOn
= FALSE
;
880 UsbKeyboardDevice
->NumLockOn
= FALSE
;
881 UsbKeyboardDevice
->CapsOn
= FALSE
;
882 UsbKeyboardDevice
->ScrollOn
= FALSE
;
884 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
885 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
886 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
887 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
888 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
889 UsbKeyboardDevice
->RightAltOn
= FALSE
;
890 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
891 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
892 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
893 UsbKeyboardDevice
->SysReqOn
= FALSE
;
895 UsbKeyboardDevice
->AltGrOn
= FALSE
;
897 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
900 // Sync the initial state of lights on keyboard.
902 SetKeyLED (UsbKeyboardDevice
);
904 ZeroMem (UsbKeyboardDevice
->LastKeyCodeArray
, sizeof (UINT8
) * 8);
907 // Create event for repeat keys' generation.
909 if (UsbKeyboardDevice
->RepeatTimer
!= NULL
) {
910 gBS
->CloseEvent (UsbKeyboardDevice
->RepeatTimer
);
911 UsbKeyboardDevice
->RepeatTimer
= NULL
;
915 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
917 USBKeyboardRepeatHandler
,
919 &UsbKeyboardDevice
->RepeatTimer
923 // Create event for delayed recovery, which deals with device error.
925 if (UsbKeyboardDevice
->DelayedRecoveryEvent
!= NULL
) {
926 gBS
->CloseEvent (UsbKeyboardDevice
->DelayedRecoveryEvent
);
927 UsbKeyboardDevice
->DelayedRecoveryEvent
= NULL
;
931 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
933 USBKeyboardRecoveryHandler
,
935 &UsbKeyboardDevice
->DelayedRecoveryEvent
943 Handler function for USB keyboard's asynchronous interrupt transfer.
945 This function is the handler function for USB keyboard's asynchronous interrupt transfer
946 to manage the keyboard. It parses the USB keyboard input report, and inserts data to
947 keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key
948 is also set accordingly.
950 @param Data A pointer to a buffer that is filled with key data which is
951 retrieved via asynchronous interrupt transfer.
952 @param DataLength Indicates the size of the data buffer.
953 @param Context Pointing to USB_KB_DEV instance.
954 @param Result Indicates the result of the asynchronous interrupt transfer.
956 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.
957 @retval EFI_DEVICE_ERROR Hardware error occurs.
969 USB_KB_DEV
*UsbKeyboardDevice
;
970 EFI_USB_IO_PROTOCOL
*UsbIo
;
971 UINT8
*CurKeyCodeBuffer
;
972 UINT8
*OldKeyCodeBuffer
;
973 UINT8 CurModifierMap
;
974 UINT8 OldModifierMap
;
983 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
985 ASSERT (Context
!= NULL
);
988 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
989 UsbIo
= UsbKeyboardDevice
->UsbIo
;
992 // Analyzes Result and performs corresponding action.
994 if (Result
!= EFI_USB_NOERROR
) {
996 // Some errors happen during the process
998 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
999 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
1000 (EFI_PERIPHERAL_KEYBOARD
| EFI_P_EC_INPUT_ERROR
),
1001 UsbKeyboardDevice
->DevicePath
1005 // Stop the repeat key generation if any
1007 UsbKeyboardDevice
->RepeatKey
= 0;
1010 UsbKeyboardDevice
->RepeatTimer
,
1015 if ((Result
& EFI_USB_ERR_STALL
) == EFI_USB_ERR_STALL
) {
1016 UsbClearEndpointHalt (
1018 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1024 // Delete & Submit this interrupt again
1025 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.
1027 UsbIo
->UsbAsyncInterruptTransfer (
1029 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1037 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.
1040 UsbKeyboardDevice
->DelayedRecoveryEvent
,
1042 EFI_USB_INTERRUPT_DELAY
1045 return EFI_DEVICE_ERROR
;
1049 // If no error and no data, just return EFI_SUCCESS.
1051 if (DataLength
== 0 || Data
== NULL
) {
1056 // Following code checks current keyboard input report against old key code buffer.
1057 // According to USB HID Firmware Specification, the report consists of 8 bytes.
1058 // Byte 0 is map of Modifier keys.
1059 // Byte 1 is reserved.
1060 // Bytes 2 to 7 are keycodes.
1062 CurKeyCodeBuffer
= (UINT8
*) Data
;
1063 OldKeyCodeBuffer
= UsbKeyboardDevice
->LastKeyCodeArray
;
1066 // Checks for new key stroke.
1068 for (Index
= 0; Index
< 8; Index
++) {
1069 if (OldKeyCodeBuffer
[Index
] != CurKeyCodeBuffer
[Index
]) {
1075 // If no new key, return EFI_SUCCESS immediately.
1082 // Parse the modifier key, which is the first byte of keyboard input report.
1084 CurModifierMap
= CurKeyCodeBuffer
[0];
1085 OldModifierMap
= OldKeyCodeBuffer
[0];
1088 // Handle modifier key's pressing or releasing situation.
1089 // According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:
1090 // Bit0: Left Control, Keycode: 0xe0
1091 // Bit1: Left Shift, Keycode: 0xe1
1092 // Bit2: Left Alt, Keycode: 0xe2
1093 // Bit3: Left GUI, Keycode: 0xe3
1094 // Bit4: Right Control, Keycode: 0xe4
1095 // Bit5: Right Shift, Keycode: 0xe5
1096 // Bit6: Right Alt, Keycode: 0xe6
1097 // Bit7: Right GUI, Keycode: 0xe7
1099 for (Index
= 0; Index
< 8; Index
++) {
1100 Mask
= (UINT8
) (1 << Index
);
1101 if ((CurModifierMap
& Mask
) != (OldModifierMap
& Mask
)) {
1103 // If current modifier key is up, then CurModifierMap & Mask = 0;
1104 // otherwise it is a non-zero value.
1105 // Insert the changed modifier key into key buffer.
1107 UsbKey
.KeyCode
= (UINT8
) (0xe0 + Index
);
1108 UsbKey
.Down
= (BOOLEAN
) ((CurModifierMap
& Mask
) != 0);
1109 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1114 // Handle normal key's releasing situation
1115 // Bytes 2 to 7 are for normal keycodes
1118 for (Index
= 2; Index
< 8; Index
++) {
1120 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index
])) {
1124 // For any key in old keycode buffer, if it is not in current keycode buffer,
1125 // then it is released. Otherwise, it is not released.
1128 for (Index2
= 2; Index2
< 8; Index2
++) {
1130 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index2
])) {
1134 if (OldKeyCodeBuffer
[Index
] == CurKeyCodeBuffer
[Index2
]) {
1141 UsbKey
.KeyCode
= OldKeyCodeBuffer
[Index
];
1142 UsbKey
.Down
= FALSE
;
1143 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1145 // The original repeat key is released.
1147 if (OldKeyCodeBuffer
[Index
] == UsbKeyboardDevice
->RepeatKey
) {
1148 UsbKeyboardDevice
->RepeatKey
= 0;
1154 // If original repeat key is released, cancel the repeat timer
1156 if (UsbKeyboardDevice
->RepeatKey
== 0) {
1158 UsbKeyboardDevice
->RepeatTimer
,
1165 // Handle normal key's pressing situation
1168 for (Index
= 2; Index
< 8; Index
++) {
1170 if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer
[Index
])) {
1174 // For any key in current keycode buffer, if it is not in old keycode buffer,
1175 // then it is pressed. Otherwise, it is not pressed.
1178 for (Index2
= 2; Index2
< 8; Index2
++) {
1180 if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer
[Index2
])) {
1184 if (CurKeyCodeBuffer
[Index
] == OldKeyCodeBuffer
[Index2
]) {
1191 UsbKey
.KeyCode
= CurKeyCodeBuffer
[Index
];
1193 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1196 // Handle repeat key
1198 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, CurKeyCodeBuffer
[Index
]);
1199 if (KeyDescriptor
== NULL
) {
1203 if (KeyDescriptor
->Modifier
== EFI_NUM_LOCK_MODIFIER
|| KeyDescriptor
->Modifier
== EFI_CAPS_LOCK_MODIFIER
) {
1205 // For NumLock or CapsLock pressed, there is no need to handle repeat key for them.
1207 UsbKeyboardDevice
->RepeatKey
= 0;
1210 // Prepare new repeat key, and clear the original one.
1212 NewRepeatKey
= CurKeyCodeBuffer
[Index
];
1213 UsbKeyboardDevice
->RepeatKey
= 0;
1219 // Update LastKeycodeArray buffer in the UsbKeyboardDevice data structure.
1221 for (Index
= 0; Index
< 8; Index
++) {
1222 UsbKeyboardDevice
->LastKeyCodeArray
[Index
] = CurKeyCodeBuffer
[Index
];
1226 // If there is new key pressed, update the RepeatKey value, and set the
1227 // timer to repeate delay timer
1229 if (NewRepeatKey
!= 0) {
1231 // Sets trigger time to "Repeat Delay Time",
1232 // to trigger the repeat timer when the key is hold long
1236 UsbKeyboardDevice
->RepeatTimer
,
1240 UsbKeyboardDevice
->RepeatKey
= NewRepeatKey
;
1248 Retrieves a USB keycode after parsing the raw data in keyboard buffer.
1250 This function parses keyboard buffer. It updates state of modifier key for
1251 USB_KB_DEV instancem, and returns keycode for output.
1253 @param UsbKeyboardDevice The USB_KB_DEV instance.
1254 @param KeyCode Pointer to the USB keycode for output.
1256 @retval EFI_SUCCESS Keycode successfully parsed.
1257 @retval EFI_NOT_READY Keyboard buffer is not ready for a valid keycode
1262 IN OUT USB_KB_DEV
*UsbKeyboardDevice
,
1267 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1271 while (!IsQueueEmpty (&UsbKeyboardDevice
->UsbKeyQueue
)) {
1273 // Pops one raw data off.
1275 Dequeue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1277 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, UsbKey
.KeyCode
);
1278 if (KeyDescriptor
== NULL
) {
1285 switch (KeyDescriptor
->Modifier
) {
1290 case EFI_LEFT_CONTROL_MODIFIER
:
1291 UsbKeyboardDevice
->LeftCtrlOn
= FALSE
;
1292 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1294 case EFI_RIGHT_CONTROL_MODIFIER
:
1295 UsbKeyboardDevice
->RightCtrlOn
= FALSE
;
1296 UsbKeyboardDevice
->CtrlOn
= FALSE
;
1302 case EFI_LEFT_SHIFT_MODIFIER
:
1303 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1304 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1306 case EFI_RIGHT_SHIFT_MODIFIER
:
1307 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1308 UsbKeyboardDevice
->ShiftOn
= FALSE
;
1314 case EFI_LEFT_ALT_MODIFIER
:
1315 UsbKeyboardDevice
->LeftAltOn
= FALSE
;
1316 UsbKeyboardDevice
->AltOn
= FALSE
;
1318 case EFI_RIGHT_ALT_MODIFIER
:
1319 UsbKeyboardDevice
->RightAltOn
= FALSE
;
1320 UsbKeyboardDevice
->AltOn
= FALSE
;
1324 // Left Logo release
1326 case EFI_LEFT_LOGO_MODIFIER
:
1327 UsbKeyboardDevice
->LeftLogoOn
= FALSE
;
1331 // Right Logo release
1333 case EFI_RIGHT_LOGO_MODIFIER
:
1334 UsbKeyboardDevice
->RightLogoOn
= FALSE
;
1340 case EFI_MENU_MODIFIER
:
1341 UsbKeyboardDevice
->MenuKeyOn
= FALSE
;
1347 case EFI_PRINT_MODIFIER
:
1348 case EFI_SYS_REQUEST_MODIFIER
:
1349 UsbKeyboardDevice
->SysReqOn
= FALSE
;
1355 case EFI_ALT_GR_MODIFIER
:
1356 UsbKeyboardDevice
->AltGrOn
= FALSE
;
1367 // Analyzes key pressing situation
1369 switch (KeyDescriptor
->Modifier
) {
1374 case EFI_LEFT_CONTROL_MODIFIER
:
1375 UsbKeyboardDevice
->LeftCtrlOn
= TRUE
;
1376 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1378 case EFI_RIGHT_CONTROL_MODIFIER
:
1379 UsbKeyboardDevice
->RightCtrlOn
= TRUE
;
1380 UsbKeyboardDevice
->CtrlOn
= TRUE
;
1386 case EFI_LEFT_SHIFT_MODIFIER
:
1387 UsbKeyboardDevice
->LeftShiftOn
= TRUE
;
1388 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1390 case EFI_RIGHT_SHIFT_MODIFIER
:
1391 UsbKeyboardDevice
->RightShiftOn
= TRUE
;
1392 UsbKeyboardDevice
->ShiftOn
= TRUE
;
1398 case EFI_LEFT_ALT_MODIFIER
:
1399 UsbKeyboardDevice
->LeftAltOn
= TRUE
;
1400 UsbKeyboardDevice
->AltOn
= TRUE
;
1402 case EFI_RIGHT_ALT_MODIFIER
:
1403 UsbKeyboardDevice
->RightAltOn
= TRUE
;
1404 UsbKeyboardDevice
->AltOn
= TRUE
;
1410 case EFI_LEFT_LOGO_MODIFIER
:
1411 UsbKeyboardDevice
->LeftLogoOn
= TRUE
;
1417 case EFI_RIGHT_LOGO_MODIFIER
:
1418 UsbKeyboardDevice
->RightLogoOn
= TRUE
;
1424 case EFI_MENU_MODIFIER
:
1425 UsbKeyboardDevice
->MenuKeyOn
= TRUE
;
1431 case EFI_PRINT_MODIFIER
:
1432 case EFI_SYS_REQUEST_MODIFIER
:
1433 UsbKeyboardDevice
->SysReqOn
= TRUE
;
1439 case EFI_ALT_GR_MODIFIER
:
1440 UsbKeyboardDevice
->AltGrOn
= TRUE
;
1443 case EFI_NUM_LOCK_MODIFIER
:
1447 UsbKeyboardDevice
->NumLockOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->NumLockOn
));
1448 SetKeyLED (UsbKeyboardDevice
);
1451 case EFI_CAPS_LOCK_MODIFIER
:
1455 UsbKeyboardDevice
->CapsOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->CapsOn
));
1456 SetKeyLED (UsbKeyboardDevice
);
1459 case EFI_SCROLL_LOCK_MODIFIER
:
1461 // Toggle ScrollLock
1463 UsbKeyboardDevice
->ScrollOn
= (BOOLEAN
) (!(UsbKeyboardDevice
->ScrollOn
));
1464 SetKeyLED (UsbKeyboardDevice
);
1472 // When encountering Ctrl + Alt + Del, then warm reset.
1474 if (KeyDescriptor
->Modifier
== EFI_DELETE_MODIFIER
) {
1475 if ((UsbKeyboardDevice
->CtrlOn
) && (UsbKeyboardDevice
->AltOn
)) {
1476 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1480 *KeyCode
= UsbKey
.KeyCode
;
1484 return EFI_NOT_READY
;
1488 Initialize the key state.
1490 @param UsbKeyboardDevice The USB_KB_DEV instance.
1491 @param KeyState A pointer to receive the key state information.
1494 InitializeKeyState (
1495 IN USB_KB_DEV
*UsbKeyboardDevice
,
1496 OUT EFI_KEY_STATE
*KeyState
1499 KeyState
->KeyShiftState
= EFI_SHIFT_STATE_VALID
;
1500 KeyState
->KeyToggleState
= EFI_TOGGLE_STATE_VALID
;
1502 if (UsbKeyboardDevice
->LeftCtrlOn
) {
1503 KeyState
->KeyShiftState
|= EFI_LEFT_CONTROL_PRESSED
;
1505 if (UsbKeyboardDevice
->RightCtrlOn
) {
1506 KeyState
->KeyShiftState
|= EFI_RIGHT_CONTROL_PRESSED
;
1508 if (UsbKeyboardDevice
->LeftAltOn
) {
1509 KeyState
->KeyShiftState
|= EFI_LEFT_ALT_PRESSED
;
1511 if (UsbKeyboardDevice
->RightAltOn
) {
1512 KeyState
->KeyShiftState
|= EFI_RIGHT_ALT_PRESSED
;
1514 if (UsbKeyboardDevice
->LeftShiftOn
) {
1515 KeyState
->KeyShiftState
|= EFI_LEFT_SHIFT_PRESSED
;
1517 if (UsbKeyboardDevice
->RightShiftOn
) {
1518 KeyState
->KeyShiftState
|= EFI_RIGHT_SHIFT_PRESSED
;
1520 if (UsbKeyboardDevice
->LeftLogoOn
) {
1521 KeyState
->KeyShiftState
|= EFI_LEFT_LOGO_PRESSED
;
1523 if (UsbKeyboardDevice
->RightLogoOn
) {
1524 KeyState
->KeyShiftState
|= EFI_RIGHT_LOGO_PRESSED
;
1526 if (UsbKeyboardDevice
->MenuKeyOn
) {
1527 KeyState
->KeyShiftState
|= EFI_MENU_KEY_PRESSED
;
1529 if (UsbKeyboardDevice
->SysReqOn
) {
1530 KeyState
->KeyShiftState
|= EFI_SYS_REQ_PRESSED
;
1533 if (UsbKeyboardDevice
->ScrollOn
) {
1534 KeyState
->KeyToggleState
|= EFI_SCROLL_LOCK_ACTIVE
;
1536 if (UsbKeyboardDevice
->NumLockOn
) {
1537 KeyState
->KeyToggleState
|= EFI_NUM_LOCK_ACTIVE
;
1539 if (UsbKeyboardDevice
->CapsOn
) {
1540 KeyState
->KeyToggleState
|= EFI_CAPS_LOCK_ACTIVE
;
1542 if (UsbKeyboardDevice
->IsSupportPartialKey
) {
1543 KeyState
->KeyToggleState
|= EFI_KEY_STATE_EXPOSED
;
1548 Converts USB Keycode ranging from 0x4 to 0x65 to EFI_INPUT_KEY.
1550 @param UsbKeyboardDevice The USB_KB_DEV instance.
1551 @param KeyCode Indicates the key code that will be interpreted.
1552 @param KeyData A pointer to a buffer that is filled in with
1553 the keystroke information for the key that
1556 @retval EFI_SUCCESS Success.
1557 @retval EFI_INVALID_PARAMETER KeyCode is not in the range of 0x4 to 0x65.
1558 @retval EFI_INVALID_PARAMETER Translated EFI_INPUT_KEY has zero for both ScanCode and UnicodeChar.
1559 @retval EFI_NOT_READY KeyCode represents a dead key with EFI_NS_KEY_MODIFIER
1560 @retval EFI_DEVICE_ERROR Keyboard layout is invalid.
1564 UsbKeyCodeToEfiInputKey (
1565 IN USB_KB_DEV
*UsbKeyboardDevice
,
1567 OUT EFI_KEY_DATA
*KeyData
1570 EFI_KEY_DESCRIPTOR
*KeyDescriptor
;
1572 LIST_ENTRY
*NotifyList
;
1573 KEYBOARD_CONSOLE_IN_EX_NOTIFY
*CurrentNotify
;
1576 // KeyCode must in the range of [0x4, 0x65] or [0xe0, 0xe7].
1578 KeyDescriptor
= GetKeyDescriptor (UsbKeyboardDevice
, KeyCode
);
1579 if (KeyDescriptor
== NULL
) {
1580 return EFI_DEVICE_ERROR
;
1583 if (KeyDescriptor
->Modifier
== EFI_NS_KEY_MODIFIER
) {
1585 // If this is a dead key with EFI_NS_KEY_MODIFIER, then record it and return.
1587 UsbKeyboardDevice
->CurrentNsKey
= FindUsbNsKey (UsbKeyboardDevice
, KeyDescriptor
);
1588 return EFI_NOT_READY
;
1591 if (UsbKeyboardDevice
->CurrentNsKey
!= NULL
) {
1593 // If this keystroke follows a non-spacing key, then find the descriptor for corresponding
1596 KeyDescriptor
= FindPhysicalKey (UsbKeyboardDevice
->CurrentNsKey
, KeyDescriptor
);
1597 UsbKeyboardDevice
->CurrentNsKey
= NULL
;
1601 // Make sure modifier of Key Descriptor is in the valid range according to UEFI spec.
1603 if (KeyDescriptor
->Modifier
>= (sizeof (ModifierValueToEfiScanCodeConvertionTable
) / sizeof (UINT8
))) {
1604 return EFI_DEVICE_ERROR
;
1607 KeyData
->Key
.ScanCode
= ModifierValueToEfiScanCodeConvertionTable
[KeyDescriptor
->Modifier
];
1608 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1610 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_STANDARD_SHIFT
)!= 0) {
1611 if (UsbKeyboardDevice
->ShiftOn
) {
1612 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1615 // Need not return associated shift state if a class of printable characters that
1616 // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'
1618 if ((KeyDescriptor
->Unicode
!= CHAR_NULL
) && (KeyDescriptor
->ShiftedUnicode
!= CHAR_NULL
) &&
1619 (KeyDescriptor
->Unicode
!= KeyDescriptor
->ShiftedUnicode
)) {
1620 UsbKeyboardDevice
->LeftShiftOn
= FALSE
;
1621 UsbKeyboardDevice
->RightShiftOn
= FALSE
;
1624 if (UsbKeyboardDevice
->AltGrOn
) {
1625 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedAltGrUnicode
;
1631 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1633 if (UsbKeyboardDevice
->AltGrOn
) {
1634 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->AltGrUnicode
;
1639 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_CAPS_LOCK
) != 0) {
1640 if (UsbKeyboardDevice
->CapsOn
) {
1641 if (KeyData
->Key
.UnicodeChar
== KeyDescriptor
->Unicode
) {
1642 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->ShiftedUnicode
;
1643 } else if (KeyData
->Key
.UnicodeChar
== KeyDescriptor
->ShiftedUnicode
) {
1644 KeyData
->Key
.UnicodeChar
= KeyDescriptor
->Unicode
;
1649 if ((KeyDescriptor
->AffectedAttribute
& EFI_AFFECTED_BY_NUM_LOCK
) != 0) {
1651 // For key affected by NumLock, if NumLock is on and Shift is not pressed, then it means
1652 // normal key, instead of original control key. So the ScanCode should be cleaned.
1653 // Otherwise, it means control key, so preserve the EFI Scan Code and clear the unicode keycode.
1655 if ((UsbKeyboardDevice
->NumLockOn
) && (!(UsbKeyboardDevice
->ShiftOn
))) {
1656 KeyData
->Key
.ScanCode
= SCAN_NULL
;
1658 KeyData
->Key
.UnicodeChar
= CHAR_NULL
;
1663 // Translate Unicode 0x1B (ESC) to EFI Scan Code
1665 if (KeyData
->Key
.UnicodeChar
== 0x1B && KeyData
->Key
.ScanCode
== SCAN_NULL
) {
1666 KeyData
->Key
.ScanCode
= SCAN_ESC
;
1667 KeyData
->Key
.UnicodeChar
= CHAR_NULL
;
1671 // Not valid for key without both unicode key code and EFI Scan Code.
1673 if (KeyData
->Key
.UnicodeChar
== 0 && KeyData
->Key
.ScanCode
== SCAN_NULL
) {
1674 if (!UsbKeyboardDevice
->IsSupportPartialKey
) {
1675 return EFI_NOT_READY
;
1680 // Save Shift/Toggle state
1682 InitializeKeyState (UsbKeyboardDevice
, &KeyData
->KeyState
);
1685 // Signal KeyNotify process event if this key pressed matches any key registered.
1687 NotifyList
= &UsbKeyboardDevice
->NotifyList
;
1688 for (Link
= GetFirstNode (NotifyList
); !IsNull (NotifyList
, Link
); Link
= GetNextNode (NotifyList
, Link
)) {
1689 CurrentNotify
= CR (Link
, KEYBOARD_CONSOLE_IN_EX_NOTIFY
, NotifyEntry
, USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE
);
1690 if (IsKeyRegistered (&CurrentNotify
->KeyData
, KeyData
)) {
1692 // The key notification function needs to run at TPL_CALLBACK
1693 // while current TPL is TPL_NOTIFY. It will be invoked in
1694 // KeyNotifyProcessHandler() which runs at TPL_CALLBACK.
1696 Enqueue (&UsbKeyboardDevice
->EfiKeyQueueForNotify
, KeyData
, sizeof (*KeyData
));
1697 gBS
->SignalEvent (UsbKeyboardDevice
->KeyNotifyProcessEvent
);
1708 @param Queue Points to the queue.
1709 @param ItemSize Size of the single item.
1714 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1720 Queue
->ItemSize
= ItemSize
;
1724 if (Queue
->Buffer
[0] != NULL
) {
1725 FreePool (Queue
->Buffer
[0]);
1728 Queue
->Buffer
[0] = AllocatePool (sizeof (Queue
->Buffer
) / sizeof (Queue
->Buffer
[0]) * ItemSize
);
1729 ASSERT (Queue
->Buffer
[0] != NULL
);
1731 for (Index
= 1; Index
< sizeof (Queue
->Buffer
) / sizeof (Queue
->Buffer
[0]); Index
++) {
1732 Queue
->Buffer
[Index
] = ((UINT8
*) Queue
->Buffer
[Index
- 1]) + ItemSize
;
1739 @param Queue Points to the queue.
1743 IN OUT USB_SIMPLE_QUEUE
*Queue
1746 FreePool (Queue
->Buffer
[0]);
1751 Check whether the queue is empty.
1753 @param Queue Points to the queue.
1755 @retval TRUE Queue is empty.
1756 @retval FALSE Queue is not empty.
1761 IN USB_SIMPLE_QUEUE
*Queue
1765 // Meet FIFO empty condition
1767 return (BOOLEAN
) (Queue
->Head
== Queue
->Tail
);
1772 Check whether the queue is full.
1774 @param Queue Points to the queue.
1776 @retval TRUE Queue is full.
1777 @retval FALSE Queue is not full.
1782 IN USB_SIMPLE_QUEUE
*Queue
1785 return (BOOLEAN
) (((Queue
->Tail
+ 1) % (MAX_KEY_ALLOWED
+ 1)) == Queue
->Head
);
1790 Enqueue the item to the queue.
1792 @param Queue Points to the queue.
1793 @param Item Points to the item to be enqueued.
1794 @param ItemSize Size of the item.
1798 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1803 ASSERT (ItemSize
== Queue
->ItemSize
);
1805 // If keyboard buffer is full, throw the
1806 // first key out of the keyboard buffer.
1808 if (IsQueueFull (Queue
)) {
1809 Queue
->Head
= (Queue
->Head
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1812 CopyMem (Queue
->Buffer
[Queue
->Tail
], Item
, ItemSize
);
1815 // Adjust the tail pointer of the FIFO keyboard buffer.
1817 Queue
->Tail
= (Queue
->Tail
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1822 Dequeue a item from the queue.
1824 @param Queue Points to the queue.
1825 @param Item Receives the item.
1826 @param ItemSize Size of the item.
1828 @retval EFI_SUCCESS Item was successfully dequeued.
1829 @retval EFI_DEVICE_ERROR The queue is empty.
1834 IN OUT USB_SIMPLE_QUEUE
*Queue
,
1839 ASSERT (Queue
->ItemSize
== ItemSize
);
1841 if (IsQueueEmpty (Queue
)) {
1842 return EFI_DEVICE_ERROR
;
1845 CopyMem (Item
, Queue
->Buffer
[Queue
->Head
], ItemSize
);
1848 // Adjust the head pointer of the FIFO keyboard buffer.
1850 Queue
->Head
= (Queue
->Head
+ 1) % (MAX_KEY_ALLOWED
+ 1);
1857 Sets USB keyboard LED state.
1859 @param UsbKeyboardDevice The USB_KB_DEV instance.
1864 IN USB_KB_DEV
*UsbKeyboardDevice
1871 // Set each field in Led map.
1873 Led
.NumLock
= (UINT8
) ((UsbKeyboardDevice
->NumLockOn
) ? 1 : 0);
1874 Led
.CapsLock
= (UINT8
) ((UsbKeyboardDevice
->CapsOn
) ? 1 : 0);
1875 Led
.ScrollLock
= (UINT8
) ((UsbKeyboardDevice
->ScrollOn
) ? 1 : 0);
1880 // Call Set_Report Request to lighten the LED.
1882 UsbSetReportRequest (
1883 UsbKeyboardDevice
->UsbIo
,
1884 UsbKeyboardDevice
->InterfaceDescriptor
.InterfaceNumber
,
1894 Handler for Repeat Key event.
1896 This function is the handler for Repeat Key event triggered
1898 After a repeatable key is pressed, the event would be triggered
1899 with interval of USBKBD_REPEAT_DELAY. Once the event is triggered,
1900 following trigger will come with interval of USBKBD_REPEAT_RATE.
1902 @param Event The Repeat Key event.
1903 @param Context Points to the USB_KB_DEV instance.
1908 USBKeyboardRepeatHandler (
1913 USB_KB_DEV
*UsbKeyboardDevice
;
1916 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1919 // Do nothing when there is no repeat key.
1921 if (UsbKeyboardDevice
->RepeatKey
!= 0) {
1923 // Inserts the repeat key into keyboard buffer,
1925 UsbKey
.KeyCode
= UsbKeyboardDevice
->RepeatKey
;
1927 Enqueue (&UsbKeyboardDevice
->UsbKeyQueue
, &UsbKey
, sizeof (UsbKey
));
1930 // Set repeat rate for next repeat key generation.
1933 UsbKeyboardDevice
->RepeatTimer
,
1942 Handler for Delayed Recovery event.
1944 This function is the handler for Delayed Recovery event triggered
1946 After a device error occurs, the event would be triggered
1947 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY
1948 is defined in USB standard for error handling.
1950 @param Event The Delayed Recovery event.
1951 @param Context Points to the USB_KB_DEV instance.
1956 USBKeyboardRecoveryHandler (
1962 USB_KB_DEV
*UsbKeyboardDevice
;
1963 EFI_USB_IO_PROTOCOL
*UsbIo
;
1966 UsbKeyboardDevice
= (USB_KB_DEV
*) Context
;
1968 UsbIo
= UsbKeyboardDevice
->UsbIo
;
1970 PacketSize
= (UINT8
) (UsbKeyboardDevice
->IntEndpointDescriptor
.MaxPacketSize
);
1973 // Re-submit Asynchronous Interrupt Transfer for recovery.
1975 UsbIo
->UsbAsyncInterruptTransfer (
1977 UsbKeyboardDevice
->IntEndpointDescriptor
.EndpointAddress
,
1979 UsbKeyboardDevice
->IntEndpointDescriptor
.Interval
,