/** @file\r
\r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+ UEFI Component Name(2) protocol implementation for Usb Keyboard driver.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
\r
-#include "keyboard.h"\r
+#include "KeyBoard.h"\r
\r
//\r
// EFI Component Name Functions\r
--- /dev/null
+/** @file\r
+\r
+ USB Keyboard Driver that includes the implementation of interface.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "EfiKey.h"\r
+#include "KeyBoard.h"\r
+\r
+/**\r
+ The Usb Keyboard Driver Entry Point.\r
+\r
+ @param ImageHandle The driver image handle.\r
+ @param SystemTable The system table.\r
+\r
+ @return EFI_SUCCESS The component name protocol is installed.\r
+ @return Others Failed to install.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingEntryPoint (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );\r
+\r
+/**\r
+ Check whether USB keyboard driver support this device.\r
+\r
+ @param This The USB keyboard driver binding protocol.\r
+ @param Controller The controller handle to check.\r
+ @param RemainingDevicePath The remaining device path.\r
+\r
+ @retval EFI_SUCCESS The driver supports this controller.\r
+ @retval EFI_UNSUPPORTED This device isn't supported.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingSupported (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ );\r
+\r
+/**\r
+ Start running driver on the controller.\r
+\r
+ @param This The USB keyboard driver binding instance.\r
+ @param Controller The controller to check.\r
+ @param RemainingDevicePath The remaining device patch.\r
+\r
+ @retval EFI_SUCCESS The controller is controlled by the usb keyboard driver.\r
+ @return Other The keyboard driver doesn't support this controller.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingStart (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ );\r
+\r
+/**\r
+ Stop handle the controller by this USB keyboard driver.\r
+\r
+ @param This The USB keyboard driver binding protocol.\r
+ @param Controller The controller to release.\r
+ @param NumberOfChildren The number of handles in ChildHandleBuffer.\r
+ @param ChildHandleBuffer The array of child handle.\r
+\r
+ @retval EFI_SUCCESS The controller or children are stopped.\r
+ @retval EFI_DEVICE_ERROR Failed to stop the driver.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingStop (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN UINTN NumberOfChildren,\r
+ IN EFI_HANDLE *ChildHandleBuffer\r
+ );\r
+\r
+/**\r
+ Reset Usb Keyboard.\r
+\r
+ @param This The protocol instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL.\r
+ @param ExtendedVerification Whether completely reset keyboard or not.\r
+\r
+ @retval EFI_SUCCESS Reset keyboard successfully.\r
+ @retval EFI_DEVICE_ERROR Reset keyboard failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReset (\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
+ );\r
+\r
+/**\r
+ Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke() function.\r
+\r
+ @param This The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.\r
+ @param Key A pointer to a buffer that is filled in with the keystroke\r
+ information for the key that was pressed.\r
+\r
+ @retval EFI_SUCCESS Read key stroke successfully.\r
+ @retval Other Read key stroke failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReadKeyStroke (\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ OUT EFI_INPUT_KEY *Key\r
+ );\r
+\r
+/**\r
+ Handler function for WaitForKey event.\r
+\r
+ @param Event Event to be signaled when a key is pressed.\r
+ @param Context Points to USB_KB_DEV instance.\r
+\r
+ @return None.\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardWaitForKey (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ );\r
+\r
+/**\r
+ Check whether there is key pending.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Have key pending to read.\r
+ @retval Other Parse key failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardCheckForKey (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ );\r
+\r
+EFI_GUID gEfiUsbKeyboardDriverGuid = {\r
+ 0xa05f5f78, 0xfb3, 0x4d10, {0x90, 0x90, 0xac, 0x4, 0x6e, 0xeb, 0x7c, 0x3c}\r
+};\r
+\r
+/**\r
+ Free keyboard notify list.\r
+\r
+ @param ListHead The list head.\r
+\r
+ @retval EFI_SUCCESS Free the notify list successfully.\r
+ @retval EFI_INVALID_PARAMETER ListHead is invalid.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+KbdFreeNotifyList (\r
+ IN OUT LIST_ENTRY *ListHead\r
+ ); \r
+\r
+/**\r
+ Whether the pressed key matches a registered key or not.\r
+\r
+ @param RegsiteredData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was registered.\r
+ @param InputData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was pressed.\r
+\r
+ @retval TRUE Key pressed matches a registered key.\r
+ @retval FLASE Match failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsKeyRegistered (\r
+ IN EFI_KEY_DATA *RegsiteredData,\r
+ IN EFI_KEY_DATA *InputData\r
+ );\r
+\r
+\r
+//\r
+// USB Keyboard Driver Global Variables\r
+//\r
+EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding = {\r
+ USBKeyboardDriverBindingSupported,\r
+ USBKeyboardDriverBindingStart,\r
+ USBKeyboardDriverBindingStop,\r
+ 0xa,\r
+ NULL,\r
+ NULL\r
+};\r
+\r
+/**\r
+ The Usb Keyboard Driver Entry Point.\r
+\r
+ @param ImageHandle The driver image handle.\r
+ @param SystemTable The system table.\r
+\r
+ @return EFI_SUCCESS The component name protocol is installed.\r
+ @return Others Failed to install.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingEntryPoint (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ return EfiLibInstallDriverBindingComponentName2 (\r
+ ImageHandle,\r
+ SystemTable,\r
+ &gUsbKeyboardDriverBinding,\r
+ ImageHandle,\r
+ &gUsbKeyboardComponentName,\r
+ &gUsbKeyboardComponentName2\r
+ );\r
+}\r
+\r
+/**\r
+ Check whether USB keyboard driver support this device.\r
+\r
+ @param This The USB keyboard driver binding protocol.\r
+ @param Controller The controller handle to check.\r
+ @param RemainingDevicePath The remaining device path.\r
+\r
+ @retval EFI_SUCCESS The driver supports this controller.\r
+ @retval EFI_UNSUPPORTED This device isn't supported.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingSupported (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ )\r
+{\r
+ EFI_STATUS OpenStatus;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Check if USB_IO protocol is attached on the controller handle.\r
+ //\r
+ OpenStatus = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ (VOID **) &UsbIo,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_BY_DRIVER\r
+ );\r
+ if (EFI_ERROR (OpenStatus)) {\r
+ return OpenStatus;\r
+ }\r
+\r
+ //\r
+ // Use the USB I/O protocol interface to check whether the Controller is\r
+ // the Keyboard controller that can be managed by this driver.\r
+ //\r
+ Status = EFI_SUCCESS;\r
+\r
+ if (!IsUSBKeyboard (UsbIo)) {\r
+ Status = EFI_UNSUPPORTED;\r
+ }\r
+\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Start running driver on the controller.\r
+\r
+ @param This The USB keyboard driver binding instance.\r
+ @param Controller The controller to check.\r
+ @param RemainingDevicePath The remaining device patch.\r
+\r
+ @retval EFI_SUCCESS The controller is controlled by the usb keyboard driver.\r
+ @return Other The keyboard driver doesn't support this controller.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingStart (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ UINT8 EndpointNumber;\r
+ EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
+ UINT8 Index;\r
+ UINT8 EndpointAddr;\r
+ UINT8 PollingInterval;\r
+ UINT8 PacketSize;\r
+ BOOLEAN Found;\r
+\r
+ UsbKeyboardDevice = NULL;\r
+ Found = FALSE;\r
+\r
+ //\r
+ // Open USB_IO Protocol\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ (VOID **) &UsbIo,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_BY_DRIVER\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ UsbKeyboardDevice = AllocateZeroPool (sizeof (USB_KB_DEV));\r
+ if (UsbKeyboardDevice == NULL) {\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ //\r
+ // Get the Device Path Protocol on Controller's handle\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiDevicePathProtocolGuid,\r
+ (VOID **) &UsbKeyboardDevice->DevicePath,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+ }\r
+ //\r
+ // Report that the usb keyboard is being enabled\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardEnable)\r
+ );\r
+\r
+ //\r
+ // This is pretty close to keyboard detection, so log progress\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardPresenceDetect)\r
+ );\r
+\r
+ //\r
+ // Initialize UsbKeyboardDevice\r
+ //\r
+ UsbKeyboardDevice->UsbIo = UsbIo;\r
+\r
+ //\r
+ // Get interface & endpoint descriptor\r
+ //\r
+ UsbIo->UsbGetInterfaceDescriptor (\r
+ UsbIo,\r
+ &UsbKeyboardDevice->InterfaceDescriptor\r
+ );\r
+\r
+ EndpointNumber = UsbKeyboardDevice->InterfaceDescriptor.NumEndpoints;\r
+\r
+ for (Index = 0; Index < EndpointNumber; Index++) {\r
+\r
+ UsbIo->UsbGetEndpointDescriptor (\r
+ UsbIo,\r
+ Index,\r
+ &EndpointDescriptor\r
+ );\r
+\r
+ if ((EndpointDescriptor.Attributes & 0x03) == 0x03) {\r
+ //\r
+ // We only care interrupt endpoint here\r
+ //\r
+ CopyMem(&UsbKeyboardDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));\r
+ Found = TRUE;\r
+ }\r
+ }\r
+\r
+ if (!Found) {\r
+ //\r
+ // No interrupt endpoint found, then return unsupported.\r
+ //\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ UsbKeyboardDevice->Signature = USB_KB_DEV_SIGNATURE;\r
+ UsbKeyboardDevice->SimpleInput.Reset = USBKeyboardReset;\r
+ UsbKeyboardDevice->SimpleInput.ReadKeyStroke = USBKeyboardReadKeyStroke;\r
+\r
+ UsbKeyboardDevice->SimpleInputEx.Reset = USBKeyboardResetEx;\r
+ UsbKeyboardDevice->SimpleInputEx.ReadKeyStrokeEx = USBKeyboardReadKeyStrokeEx;\r
+ UsbKeyboardDevice->SimpleInputEx.SetState = USBKeyboardSetState;\r
+ UsbKeyboardDevice->SimpleInputEx.RegisterKeyNotify = USBKeyboardRegisterKeyNotify;\r
+ UsbKeyboardDevice->SimpleInputEx.UnregisterKeyNotify = USBKeyboardUnregisterKeyNotify; \r
+ \r
+ InitializeListHead (&UsbKeyboardDevice->NotifyList);\r
+ \r
+ Status = gBS->CreateEvent (\r
+ EVT_NOTIFY_WAIT,\r
+ TPL_NOTIFY,\r
+ USBKeyboardWaitForKey,\r
+ UsbKeyboardDevice,\r
+ &(UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx)\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ goto ErrorExit;\r
+ }\r
+\r
+ Status = InitKeyboardLayout (UsbKeyboardDevice);\r
+ if (EFI_ERROR (Status)) {\r
+ goto ErrorExit;\r
+ }\r
+\r
+ Status = gBS->CreateEvent (\r
+ EVT_NOTIFY_WAIT,\r
+ TPL_NOTIFY,\r
+ USBKeyboardWaitForKey,\r
+ UsbKeyboardDevice,\r
+ &(UsbKeyboardDevice->SimpleInput.WaitForKey)\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Install simple txt in protocol interface\r
+ // for the usb keyboard device.\r
+ // Usb keyboard is a hot plug device, and expected to work immediately\r
+ // when plugging into system, so a HotPlugDeviceGuid is installed onto\r
+ // the usb keyboard device handle, to distinguish it from other conventional\r
+ // console devices.\r
+ //\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInput,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInputEx,\r
+ &gEfiHotPlugDeviceGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Reset USB Keyboard Device\r
+ //\r
+ Status = UsbKeyboardDevice->SimpleInput.Reset (\r
+ &UsbKeyboardDevice->SimpleInput,\r
+ TRUE\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInput,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInputEx,\r
+ &gEfiHotPlugDeviceGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+ }\r
+ //\r
+ // submit async interrupt transfer\r
+ //\r
+ EndpointAddr = UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress;\r
+ PollingInterval = UsbKeyboardDevice->IntEndpointDescriptor.Interval;\r
+ PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
+\r
+ Status = UsbIo->UsbAsyncInterruptTransfer (\r
+ UsbIo,\r
+ EndpointAddr,\r
+ TRUE,\r
+ PollingInterval,\r
+ PacketSize,\r
+ KeyboardHandler,\r
+ UsbKeyboardDevice\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInput,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInputEx,\r
+ &gEfiHotPlugDeviceGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+ }\r
+\r
+ UsbKeyboardDevice->ControllerNameTable = NULL;\r
+ AddUnicodeString2 (\r
+ "eng",\r
+ gUsbKeyboardComponentName.SupportedLanguages,\r
+ &UsbKeyboardDevice->ControllerNameTable,\r
+ L"Generic Usb Keyboard",\r
+ TRUE\r
+ );\r
+ AddUnicodeString2 (\r
+ "en",\r
+ gUsbKeyboardComponentName2.SupportedLanguages,\r
+ &UsbKeyboardDevice->ControllerNameTable,\r
+ L"Generic Usb Keyboard",\r
+ FALSE\r
+ );\r
+\r
+\r
+ return EFI_SUCCESS;\r
+\r
+ErrorExit:\r
+ if (UsbKeyboardDevice != NULL) {\r
+ if (UsbKeyboardDevice->SimpleInput.WaitForKey != NULL) {\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
+ }\r
+ if (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx != NULL) {\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx);\r
+ }\r
+ KbdFreeNotifyList (&UsbKeyboardDevice->NotifyList); \r
+ gBS->FreePool (UsbKeyboardDevice);\r
+ UsbKeyboardDevice = NULL;\r
+ }\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return Status;\r
+\r
+}\r
+\r
+\r
+/**\r
+ Stop handle the controller by this USB keyboard driver.\r
+\r
+ @param This The USB keyboard driver binding protocol.\r
+ @param Controller The controller to release.\r
+ @param NumberOfChildren The number of handles in ChildHandleBuffer.\r
+ @param ChildHandleBuffer The array of child handle.\r
+\r
+ @retval EFI_SUCCESS The controller or children are stopped.\r
+ @retval EFI_DEVICE_ERROR Failed to stop the driver.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardDriverBindingStop (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN UINTN NumberOfChildren,\r
+ IN EFI_HANDLE *ChildHandleBuffer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleInput;\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ (VOID **) &SimpleInput,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ NULL,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ //\r
+ // Get USB_KB_DEV instance.\r
+ //\r
+ UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (SimpleInput);\r
+\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ //\r
+ // Uninstall the Asyn Interrupt Transfer from this device\r
+ // will disable the key data input from this device\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardDisable)\r
+ );\r
+\r
+ //\r
+ // Destroy asynchronous interrupt transfer\r
+ //\r
+ UsbKeyboardDevice->UsbIo->UsbAsyncInterruptTransfer (\r
+ UsbKeyboardDevice->UsbIo,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
+ FALSE,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
+ 0,\r
+ NULL,\r
+ NULL\r
+ );\r
+\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ Status = gBS->UninstallMultipleProtocolInterfaces (\r
+ Controller,\r
+ &gEfiSimpleTextInProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInput,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ &UsbKeyboardDevice->SimpleInputEx,\r
+ &gEfiHotPlugDeviceGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ //\r
+ // free all the resources.\r
+ //\r
+ gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
+ gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
+ gBS->CloseEvent ((UsbKeyboardDevice->SimpleInput).WaitForKey);\r
+ gBS->CloseEvent (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx); \r
+ KbdFreeNotifyList (&UsbKeyboardDevice->NotifyList); \r
+\r
+ ReleaseKeyboardLayoutResources (UsbKeyboardDevice);\r
+ gBS->CloseEvent (UsbKeyboardDevice->KeyboardLayoutEvent);\r
+\r
+ if (UsbKeyboardDevice->ControllerNameTable != NULL) {\r
+ FreeUnicodeStringTable (UsbKeyboardDevice->ControllerNameTable);\r
+ }\r
+\r
+ gBS->FreePool (UsbKeyboardDevice);\r
+\r
+ return Status;\r
+\r
+}\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param UsbKeyboardDevice Usb keyboard's private structure.\r
+ @param KeyData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was pressed.\r
+\r
+ @return EFI_SUCCESS The keystroke information was returned.\r
+ @return EFI_NOT_READY There was no keystroke data availiable.\r
+ @return EFI_DEVICE_ERROR The keystroke information was not returned due to\r
+ hardware errors.\r
+ @return EFI_INVALID_PARAMETER KeyData is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReadKeyStrokeWorker (\r
+ IN USB_KB_DEV *UsbKeyboardDevice,\r
+ OUT EFI_KEY_DATA *KeyData\r
+ )\r
+{\r
+\r
+ EFI_STATUS Status;\r
+ UINT8 KeyChar; \r
+ LIST_ENTRY *Link;\r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; \r
+ EFI_KEY_DATA OriginalKeyData;\r
+\r
+ if (KeyData == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // if there is no saved ASCII byte, fetch it\r
+ // by calling USBKeyboardCheckForKey().\r
+ //\r
+ if (UsbKeyboardDevice->CurKeyChar == 0) {\r
+ Status = USBKeyboardCheckForKey (UsbKeyboardDevice);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ }\r
+\r
+ KeyData->Key.UnicodeChar = 0;\r
+ KeyData->Key.ScanCode = SCAN_NULL;\r
+\r
+ KeyChar = UsbKeyboardDevice->CurKeyChar;\r
+\r
+ UsbKeyboardDevice->CurKeyChar = 0;\r
+\r
+ //\r
+ // Translate saved ASCII byte into EFI_INPUT_KEY\r
+ //\r
+ Status = USBKeyCodeToEFIScanCode (UsbKeyboardDevice, KeyChar, &KeyData->Key);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ CopyMem (&KeyData->KeyState, &UsbKeyboardDevice->KeyState, sizeof (KeyData->KeyState));\r
+ \r
+ UsbKeyboardDevice->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;\r
+ UsbKeyboardDevice->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
+\r
+ //\r
+ //Switch the control value to their original characters. In USBKeyCodeToEFIScanCode() the CTRL-Alpha characters have been switched to \r
+ // their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A), here switch them back for notification function.\r
+ //\r
+ CopyMem (&OriginalKeyData, KeyData, sizeof (EFI_KEY_DATA));\r
+ if (UsbKeyboardDevice->CtrlOn != 0) {\r
+ if (OriginalKeyData.Key.UnicodeChar >= 0x01 && OriginalKeyData.Key.UnicodeChar <= 0x1A) {\r
+ if (UsbKeyboardDevice->CapsOn != 0) {\r
+ OriginalKeyData.Key.UnicodeChar = (CHAR16)(OriginalKeyData.Key.UnicodeChar + 'A' - 1);\r
+ } else {\r
+ OriginalKeyData.Key.UnicodeChar = (CHAR16)(OriginalKeyData.Key.UnicodeChar + 'a' - 1);\r
+ } \r
+ }\r
+ }\r
+ \r
+ //\r
+ // Invoke notification functions if exist\r
+ //\r
+ for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
+ CurrentNotify = CR (\r
+ Link, \r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
+ NotifyEntry, \r
+ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
+ );\r
+ if (IsKeyRegistered (&CurrentNotify->KeyData, &OriginalKeyData)) { \r
+ CurrentNotify->KeyNotificationFn (&OriginalKeyData);\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+ \r
+}\r
+\r
+/**\r
+ Reset Usb Keyboard.\r
+\r
+ @param This The protocol instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL.\r
+ @param ExtendedVerification Whether completely reset keyboard or not.\r
+\r
+ @retval EFI_SUCCESS Reset keyboard successfully.\r
+ @retval EFI_DEVICE_ERROR Reset keyboard failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReset (\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
+\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardReset)\r
+ );\r
+\r
+ //\r
+ // Non Exhaustive reset:\r
+ // only reset private data structures.\r
+ //\r
+ if (!ExtendedVerification) {\r
+ //\r
+ // Clear the key buffer of this Usb keyboard\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardClearBuffer)\r
+ );\r
+\r
+ InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
+ UsbKeyboardDevice->CurKeyChar = 0;\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Exhaustive reset\r
+ //\r
+ Status = InitUSBKeyboard (UsbKeyboardDevice);\r
+ UsbKeyboardDevice->CurKeyChar = 0;\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke() function.\r
+\r
+ @param This The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.\r
+ @param Key A pointer to a buffer that is filled in with the keystroke\r
+ information for the key that was pressed.\r
+\r
+ @retval EFI_SUCCESS Read key stroke successfully.\r
+ @retval Other Read key stroke failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReadKeyStroke (\r
+ IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
+ OUT EFI_INPUT_KEY *Key\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_STATUS Status;\r
+ EFI_KEY_DATA KeyData;\r
+\r
+ UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
+\r
+ Status = USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, &KeyData);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));\r
+\r
+ return EFI_SUCCESS;\r
+\r
+}\r
+\r
+\r
+/**\r
+ Handler function for WaitForKey event.\r
+\r
+ @param Event Event to be signaled when a key is pressed.\r
+ @param Context Points to USB_KB_DEV instance.\r
+\r
+ @return None.\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardWaitForKey (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
+\r
+ if (UsbKeyboardDevice->CurKeyChar == 0) {\r
+\r
+ if (EFI_ERROR (USBKeyboardCheckForKey (UsbKeyboardDevice))) {\r
+ return ;\r
+ }\r
+ }\r
+ //\r
+ // If has key pending, signal the event.\r
+ //\r
+ gBS->SignalEvent (Event);\r
+}\r
+\r
+\r
+/**\r
+ Check whether there is key pending.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Have key pending to read.\r
+ @retval Other Parse key failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardCheckForKey (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT8 KeyChar;\r
+\r
+ //\r
+ // Fetch raw data from the USB keyboard input,\r
+ // and translate it into ASCII data.\r
+ //\r
+ Status = USBParseKey (UsbKeyboardDevice, &KeyChar);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ UsbKeyboardDevice->CurKeyChar = KeyChar;\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Report Status Code in Usb Keyboard Driver.\r
+\r
+ @param DevicePath Use this to get Device Path.\r
+ @param CodeType Status Code Type.\r
+ @param CodeValue Status Code Value.\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+KbdReportStatusCode (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
+ IN EFI_STATUS_CODE_TYPE CodeType,\r
+ IN EFI_STATUS_CODE_VALUE Value\r
+ )\r
+{\r
+\r
+ REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
+ CodeType,\r
+ Value,\r
+ DevicePath\r
+ );\r
+}\r
+\r
+/**\r
+ Free keyboard notify list.\r
+\r
+ @param ListHead The list head.\r
+\r
+ @retval EFI_SUCCESS Free the notify list successfully.\r
+ @retval EFI_INVALID_PARAMETER ListHead is invalid.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+KbdFreeNotifyList (\r
+ IN OUT LIST_ENTRY *ListHead\r
+ )\r
+{\r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
+\r
+ if (ListHead == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ while (!IsListEmpty (ListHead)) {\r
+ NotifyNode = CR (\r
+ ListHead->ForwardLink, \r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
+ NotifyEntry, \r
+ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
+ );\r
+ RemoveEntryList (ListHead->ForwardLink);\r
+ gBS->FreePool (NotifyNode);\r
+ }\r
+ \r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Whether the pressed key matches a registered key or not.\r
+\r
+ @param RegsiteredData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was registered.\r
+ @param InputData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was pressed.\r
+\r
+ @retval TRUE Key pressed matches a registered key.\r
+ @retval FLASE Match failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsKeyRegistered (\r
+ IN EFI_KEY_DATA *RegsiteredData,\r
+ IN EFI_KEY_DATA *InputData\r
+ )\r
+{\r
+ ASSERT (RegsiteredData != NULL && InputData != NULL);\r
+ \r
+ if ((RegsiteredData->Key.ScanCode != InputData->Key.ScanCode) ||\r
+ (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) {\r
+ return FALSE; \r
+ } \r
+ \r
+ //\r
+ // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.\r
+ //\r
+ if (RegsiteredData->KeyState.KeyShiftState != 0 &&\r
+ RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) {\r
+ return FALSE; \r
+ } \r
+ if (RegsiteredData->KeyState.KeyToggleState != 0 &&\r
+ RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) {\r
+ return FALSE; \r
+ } \r
+ \r
+ return TRUE;\r
+\r
+}\r
+\r
+//\r
+// Simple Text Input Ex protocol functions \r
+//\r
+/**\r
+ The extension routine to reset the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardResetEx (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_TPL OldTpl;\r
+ \r
+\r
+ UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
+\r
+ Status = UsbKeyboardDevice->SimpleInput.Reset (&UsbKeyboardDevice->SimpleInput, ExtendedVerification);\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
+ UsbKeyboardDevice->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;\r
+ UsbKeyboardDevice->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
+ gBS->RestoreTPL (OldTpl);\r
+\r
+ return EFI_SUCCESS;\r
+\r
+}\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was pressed.\r
+\r
+ @return EFI_SUCCESS The keystroke information was returned successfully.\r
+ @retval EFI_INVALID_PARAMETER KeyData is NULL.\r
+ @retval Other Read key stroke information failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReadKeyStrokeEx (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ OUT EFI_KEY_DATA *KeyData\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ if (KeyData == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
+\r
+ return USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, KeyData);\r
+ \r
+}\r
+\r
+/**\r
+ Set certain state for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
+ state for the input device.\r
+\r
+ @retval EFI_SUCCESS The device state was set successfully.\r
+ @retval EFI_UNSUPPORTED The device does not have the ability to set its state.\r
+ @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardSetState (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ if (KeyToggleState == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
+\r
+ if (((UsbKeyboardDevice->KeyState.KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) ||\r
+ ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Update the status light\r
+ //\r
+\r
+ UsbKeyboardDevice->ScrollOn = 0;\r
+ UsbKeyboardDevice->NumLockOn = 0;\r
+ UsbKeyboardDevice->CapsOn = 0;\r
+ \r
+ if ((*KeyToggleState & EFI_SCROLL_LOCK_ACTIVE) == EFI_SCROLL_LOCK_ACTIVE) {\r
+ UsbKeyboardDevice->ScrollOn = 1;\r
+ }\r
+ if ((*KeyToggleState & EFI_NUM_LOCK_ACTIVE) == EFI_NUM_LOCK_ACTIVE) {\r
+ UsbKeyboardDevice->NumLockOn = 1;\r
+ }\r
+ if ((*KeyToggleState & EFI_CAPS_LOCK_ACTIVE) == EFI_CAPS_LOCK_ACTIVE) {\r
+ UsbKeyboardDevice->CapsOn = 1;\r
+ }\r
+\r
+ SetKeyLED (UsbKeyboardDevice);\r
+\r
+ UsbKeyboardDevice->KeyState.KeyToggleState = *KeyToggleState;\r
+\r
+ return EFI_SUCCESS;\r
+ \r
+}\r
+\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the keystroke\r
+ information data for the key that was pressed.\r
+ @param KeyNotificationFunction Points to the function to be called when the key\r
+ sequence is typed specified by KeyData.\r
+ @param NotifyHandle Points to the unique handle assigned to the registered notification.\r
+\r
+ @retval EFI_SUCCESS The notification function was registered successfully.\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data structures.\r
+ @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardRegisterKeyNotify (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_KEY_DATA *KeyData,\r
+ IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
+ OUT EFI_HANDLE *NotifyHandle\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_STATUS Status;\r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY *NewNotify;\r
+ LIST_ENTRY *Link;\r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; \r
+\r
+ if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
+\r
+ //\r
+ // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.\r
+ //\r
+ for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
+ CurrentNotify = CR (\r
+ Link, \r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
+ NotifyEntry, \r
+ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
+ );\r
+ if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { \r
+ if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
+ *NotifyHandle = CurrentNotify->NotifyHandle; \r
+ return EFI_SUCCESS;\r
+ }\r
+ }\r
+ }\r
+ \r
+ //\r
+ // Allocate resource to save the notification function\r
+ // \r
+ NewNotify = (KEYBOARD_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_EX_NOTIFY));\r
+ if (NewNotify == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ NewNotify->Signature = USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE; \r
+ NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
+ CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));\r
+ InsertTailList (&UsbKeyboardDevice->NotifyList, &NewNotify->NotifyEntry);\r
+\r
+ //\r
+ // Use gSimpleTextInExNotifyGuid to get a valid EFI_HANDLE\r
+ // \r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &NewNotify->NotifyHandle,\r
+ &gSimpleTextInExNotifyGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ \r
+ *NotifyHandle = NewNotify->NotifyHandle; \r
+ \r
+ return EFI_SUCCESS;\r
+ \r
+}\r
+\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param NotificationHandle The handle of the notification function being unregistered.\r
+\r
+ @retval EFI_SUCCESS The notification function was unregistered successfully.\r
+ @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid or opening gSimpleTextInExNotifyGuid\r
+ on NotificationHandle fails.\r
+ @retval EFI_NOT_FOUND Can not find the matching entry in database.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardUnregisterKeyNotify (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_HANDLE NotificationHandle\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_STATUS Status;\r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
+ LIST_ENTRY *Link;\r
+\r
+ if (NotificationHandle == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } \r
+ \r
+ UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
+ \r
+ Status = gBS->OpenProtocol (\r
+ NotificationHandle,\r
+ &gSimpleTextInExNotifyGuid,\r
+ NULL,\r
+ NULL,\r
+ NULL,\r
+ EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
+ CurrentNotify = CR (\r
+ Link, \r
+ KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
+ NotifyEntry, \r
+ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
+ ); \r
+ if (CurrentNotify->NotifyHandle == NotificationHandle) {\r
+ //\r
+ // Remove the notification function from NotifyList and free resources\r
+ //\r
+ RemoveEntryList (&CurrentNotify->NotifyEntry); \r
+ Status = gBS->UninstallMultipleProtocolInterfaces (\r
+ CurrentNotify->NotifyHandle,\r
+ &gSimpleTextInExNotifyGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ gBS->FreePool (CurrentNotify); \r
+ return EFI_SUCCESS;\r
+ }\r
+ }\r
+\r
+ return EFI_NOT_FOUND; \r
+}\r
+\r
--- /dev/null
+/** @file\r
+\r
+ Header file for USB Keyboard Driver's Data Structures.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+#ifndef _EFI_USB_KB_H_\r
+#define _EFI_USB_KB_H_\r
+\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Protocol/SimpleTextIn.h>\r
+#include <Protocol/SimpleTextInEx.h>\r
+#include <Protocol/HiiDatabase.h>\r
+#include <Protocol/UsbIo.h>\r
+#include <Protocol/DevicePath.h>\r
+#include <Guid/HiiKeyBoardLayout.h>\r
+#include <Guid/HotPlugDevice.h>\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Library/ReportStatusCodeLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
+#include <Library/UefiDriverEntryPoint.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/UsbLib.h>\r
+#include <Library/BaseLib.h>\r
+\r
+#include <IndustryStandard/Usb.h>\r
+\r
+#define MAX_KEY_ALLOWED 32\r
+\r
+#define HZ 1000 * 1000 * 10\r
+#define USBKBD_REPEAT_DELAY ((HZ) / 2)\r
+#define USBKBD_REPEAT_RATE ((HZ) / 50)\r
+\r
+#define CLASS_HID 3\r
+#define SUBCLASS_BOOT 1\r
+#define PROTOCOL_KEYBOARD 1\r
+\r
+#define BOOT_PROTOCOL 0\r
+#define REPORT_PROTOCOL 1\r
+\r
+typedef struct {\r
+ UINT8 Down;\r
+ UINT8 KeyCode;\r
+} USB_KEY;\r
+\r
+typedef struct {\r
+ USB_KEY buffer[MAX_KEY_ALLOWED + 1];\r
+ UINT8 bHead;\r
+ UINT8 bTail;\r
+} USB_KB_BUFFER;\r
+\r
+#define USB_KB_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'k', 'b', 'd')\r
+#define USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE EFI_SIGNATURE_32 ('u', 'k', 'b', 'x')\r
+\r
+typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {\r
+ UINTN Signature;\r
+ EFI_HANDLE NotifyHandle;\r
+ EFI_KEY_DATA KeyData;\r
+ EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
+ LIST_ENTRY NotifyEntry;\r
+} KEYBOARD_CONSOLE_IN_EX_NOTIFY;\r
+\r
+#define USB_NS_KEY_SIGNATURE EFI_SIGNATURE_32 ('u', 'n', 's', 'k')\r
+\r
+typedef struct {\r
+ UINTN Signature;\r
+ LIST_ENTRY Link;\r
+\r
+ //\r
+ // The number of EFI_NS_KEY_MODIFIER children definitions\r
+ //\r
+ UINTN KeyCount;\r
+\r
+ //\r
+ // NsKey[0] : Non-spacing key\r
+ // NsKey[1] ~ NsKey[KeyCount] : Physical keys\r
+ //\r
+ EFI_KEY_DESCRIPTOR *NsKey;\r
+} USB_NS_KEY;\r
+\r
+#define USB_NS_KEY_FORM_FROM_LINK(a) CR (a, USB_NS_KEY, Link, USB_NS_KEY_SIGNATURE)\r
+\r
+typedef struct {\r
+ UINTN Signature;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_EVENT DelayedRecoveryEvent;\r
+ EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput;\r
+ EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleInputEx;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+\r
+ EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
+ EFI_USB_ENDPOINT_DESCRIPTOR IntEndpointDescriptor;\r
+\r
+ USB_KB_BUFFER KeyboardBuffer;\r
+ UINT8 CtrlOn;\r
+ UINT8 AltOn;\r
+ UINT8 ShiftOn;\r
+ UINT8 NumLockOn;\r
+ UINT8 CapsOn;\r
+ UINT8 ScrollOn;\r
+ UINT8 LastKeyCodeArray[8];\r
+ UINT8 CurKeyChar;\r
+\r
+ UINT8 RepeatKey;\r
+ EFI_EVENT RepeatTimer;\r
+\r
+ EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
+ \r
+ UINT8 LeftCtrlOn;\r
+ UINT8 LeftAltOn;\r
+ UINT8 LeftShiftOn;\r
+ UINT8 LeftLogoOn;\r
+ UINT8 RightCtrlOn;\r
+ UINT8 RightAltOn;\r
+ UINT8 RightShiftOn;\r
+ UINT8 RightLogoOn; \r
+ UINT8 MenuKeyOn;\r
+ UINT8 SysReqOn;\r
+ UINT8 AltGrOn;\r
+\r
+ EFI_KEY_STATE KeyState;\r
+ //\r
+ // Notification function list\r
+ //\r
+ LIST_ENTRY NotifyList;\r
+\r
+ //\r
+ // Non-spacing key list\r
+ //\r
+ LIST_ENTRY NsKeyList;\r
+ USB_NS_KEY *CurrentNsKey;\r
+ EFI_KEY_DESCRIPTOR *KeyConvertionTable;\r
+ EFI_EVENT KeyboardLayoutEvent;\r
+} USB_KB_DEV;\r
+\r
+//\r
+// Global Variables\r
+//\r
+extern EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding;\r
+extern EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName;\r
+extern EFI_COMPONENT_NAME2_PROTOCOL gUsbKeyboardComponentName2;\r
+extern EFI_GUID gEfiUsbKeyboardDriverGuid;\r
+extern EFI_GUID gSimpleTextInExNotifyGuid;\r
+\r
+/**\r
+ Report Status Code in Usb Keyboard Driver.\r
+\r
+ @param DevicePath Use this to get Device Path.\r
+ @param CodeType Status Code Type.\r
+ @param CodeValue Status Code Value.\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+KbdReportStatusCode (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
+ IN EFI_STATUS_CODE_TYPE CodeType,\r
+ IN EFI_STATUS_CODE_VALUE Value\r
+ );\r
+\r
+#define USB_KB_DEV_FROM_THIS(a) \\r
+ CR(a, USB_KB_DEV, SimpleInput, USB_KB_DEV_SIGNATURE)\r
+#define TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS(a) \\r
+ CR(a, USB_KB_DEV, SimpleInputEx, USB_KB_DEV_SIGNATURE)\r
+\r
+\r
+#define MOD_CONTROL_L 0x01\r
+#define MOD_CONTROL_R 0x10\r
+#define MOD_SHIFT_L 0x02\r
+#define MOD_SHIFT_R 0x20\r
+#define MOD_ALT_L 0x04\r
+#define MOD_ALT_R 0x40\r
+#define MOD_WIN_L 0x08\r
+#define MOD_WIN_R 0x80\r
+\r
+typedef struct {\r
+ UINT8 Mask;\r
+ UINT8 Key;\r
+} KB_MODIFIER;\r
+\r
+#define USB_KEYCODE_MAX_MAKE 0x62\r
+\r
+#define USBKBD_VALID_KEYCODE(key) ((UINT8) (key) > 3)\r
+\r
+typedef struct {\r
+ UINT8 NumLock : 1;\r
+ UINT8 CapsLock : 1;\r
+ UINT8 ScrollLock : 1;\r
+ UINT8 Resrvd : 5;\r
+} LED_MAP;\r
+\r
+//\r
+// Simple Text Input Ex protocol functions\r
+//\r
+/**\r
+ The extension routine to reset the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardResetEx (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
+ )\r
+;\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the keystroke\r
+ state data for the key that was pressed.\r
+\r
+ @return EFI_SUCCESS The keystroke information was returned successfully.\r
+ @retval EFI_INVALID_PARAMETER KeyData is NULL.\r
+ @retval Other Read key stroke information failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardReadKeyStrokeEx (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ OUT EFI_KEY_DATA *KeyData\r
+ )\r
+;\r
+\r
+/**\r
+ Set certain state for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
+ state for the input device.\r
+\r
+ @retval EFI_SUCCESS The device state was set successfully.\r
+ @retval EFI_UNSUPPORTED The device does not have the ability to set its state.\r
+ @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardSetState (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
+ )\r
+;\r
+\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the keystroke\r
+ information data for the key that was pressed.\r
+ @param KeyNotificationFunction Points to the function to be called when the key\r
+ sequence is typed specified by KeyData.\r
+ @param NotifyHandle Points to the unique handle assigned to the registered notification.\r
+\r
+ @retval EFI_SUCCESS The notification function was registered successfully.\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data structures.\r
+ @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardRegisterKeyNotify (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_KEY_DATA *KeyData,\r
+ IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
+ OUT EFI_HANDLE *NotifyHandle\r
+ )\r
+;\r
+\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param NotificationHandle The handle of the notification function being unregistered.\r
+\r
+ @retval EFI_SUCCESS The notification function was unregistered successfully.\r
+ @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid or opening gSimpleTextInExNotifyGuid\r
+ on NotificationHandle fails.\r
+ @retval EFI_NOT_FOUND Can not find the matching entry in database.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyboardUnregisterKeyNotify (\r
+ IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
+ IN EFI_HANDLE NotificationHandle\r
+ )\r
+;\r
+\r
+#endif\r
+\r
--- /dev/null
+/** @file\r
+\r
+ Helper functions for USB Keyboard Driver.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "KeyBoard.h"\r
+#include <Library/UsbLib.h>\r
+\r
+//\r
+// Static English keyboard layout\r
+// Format:<efi key>, <unicode without shift>, <unicode with shift>, <Modifier>, <AffectedAttribute>\r
+//\r
+STATIC\r
+UINT8 KeyboardLayoutTable[USB_KEYCODE_MAX_MAKE + 8][5] = {\r
+ {EfiKeyC1, 'a', 'A', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x04\r
+ {EfiKeyB5, 'b', 'B', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x05\r
+ {EfiKeyB3, 'c', 'C', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x06\r
+ {EfiKeyC3, 'd', 'D', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x07\r
+ {EfiKeyD3, 'e', 'E', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x08\r
+ {EfiKeyC4, 'f', 'F', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x09\r
+ {EfiKeyC5, 'g', 'G', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0A\r
+ {EfiKeyC6, 'h', 'H', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0B\r
+ {EfiKeyD8, 'i', 'I', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0C\r
+ {EfiKeyC7, 'j', 'J', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0D\r
+ {EfiKeyC8, 'k', 'K', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0E\r
+ {EfiKeyC9, 'l', 'L', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0F\r
+ {EfiKeyB7, 'm', 'M', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x10\r
+ {EfiKeyB6, 'n', 'N', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x11\r
+ {EfiKeyD9, 'o', 'O', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x12\r
+ {EfiKeyD10, 'p', 'P', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x13\r
+ {EfiKeyD1, 'q', 'Q', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x14\r
+ {EfiKeyD4, 'r', 'R', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x15\r
+ {EfiKeyC2, 's', 'S', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x16\r
+ {EfiKeyD5, 't', 'T', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x17\r
+ {EfiKeyD7, 'u', 'U', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x18\r
+ {EfiKeyB4, 'v', 'V', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x19\r
+ {EfiKeyD2, 'w', 'W', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1A\r
+ {EfiKeyB2, 'x', 'X', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1B\r
+ {EfiKeyD6, 'y', 'Y', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1C\r
+ {EfiKeyB1, 'z', 'Z', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1D\r
+ {EfiKeyE1, '1', '!', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1E\r
+ {EfiKeyE2, '2', '@', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1F\r
+ {EfiKeyE3, '3', '#', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x20\r
+ {EfiKeyE4, '4', '$', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x21\r
+ {EfiKeyE5, '5', '%', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x22\r
+ {EfiKeyE6, '6', '^', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x23\r
+ {EfiKeyE7, '7', '&', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x24\r
+ {EfiKeyE8, '8', '*', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x25\r
+ {EfiKeyE9, '9', '(', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x26\r
+ {EfiKeyE10, '0', ')', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x27\r
+ {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x28 Enter\r
+ {EfiKeyEsc, 0x1b, 0x1b, EFI_NULL_MODIFIER, 0}, // 0x29 Esc\r
+ {EfiKeyBackSpace, 0x08, 0x08, EFI_NULL_MODIFIER, 0}, // 0x2A Backspace\r
+ {EfiKeyTab, 0x09, 0x09, EFI_NULL_MODIFIER, 0}, // 0x2B Tab\r
+ {EfiKeySpaceBar, ' ', ' ', EFI_NULL_MODIFIER, 0}, // 0x2C Spacebar\r
+ {EfiKeyE11, '-', '_', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2D\r
+ {EfiKeyE12, '=', '+', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2E\r
+ {EfiKeyD11, '[', '{', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2F\r
+ {EfiKeyD12, ']', '}', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x30\r
+ {EfiKeyD13, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x31\r
+ {EfiKeyC12, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x32 Keyboard Non-US # and ~\r
+ {EfiKeyC10, ';', ':', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x33\r
+ {EfiKeyC11, '\'', '"', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x34\r
+ {EfiKeyE0, '`', '~', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x35 Keyboard Grave Accent and Tlide\r
+ {EfiKeyB8, ',', '<', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x36\r
+ {EfiKeyB9, '.', '>', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x37\r
+ {EfiKeyB10, '/', '?', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x38\r
+ {EfiKeyCapsLock, 0x00, 0x00, EFI_CAPS_LOCK_MODIFIER, 0}, // 0x39 CapsLock\r
+ {EfiKeyF1, 0x00, 0x00, EFI_FUNCTION_KEY_ONE_MODIFIER, 0}, // 0x3A\r
+ {EfiKeyF2, 0x00, 0x00, EFI_FUNCTION_KEY_TWO_MODIFIER, 0}, // 0x3B\r
+ {EfiKeyF3, 0x00, 0x00, EFI_FUNCTION_KEY_THREE_MODIFIER, 0}, // 0x3C\r
+ {EfiKeyF4, 0x00, 0x00, EFI_FUNCTION_KEY_FOUR_MODIFIER, 0}, // 0x3D\r
+ {EfiKeyF5, 0x00, 0x00, EFI_FUNCTION_KEY_FIVE_MODIFIER, 0}, // 0x3E\r
+ {EfiKeyF6, 0x00, 0x00, EFI_FUNCTION_KEY_SIX_MODIFIER, 0}, // 0x3F\r
+ {EfiKeyF7, 0x00, 0x00, EFI_FUNCTION_KEY_SEVEN_MODIFIER, 0}, // 0x40\r
+ {EfiKeyF8, 0x00, 0x00, EFI_FUNCTION_KEY_EIGHT_MODIFIER, 0}, // 0x41\r
+ {EfiKeyF9, 0x00, 0x00, EFI_FUNCTION_KEY_NINE_MODIFIER, 0}, // 0x42\r
+ {EfiKeyF10, 0x00, 0x00, EFI_FUNCTION_KEY_TEN_MODIFIER, 0}, // 0x43\r
+ {EfiKeyF11, 0x00, 0x00, EFI_FUNCTION_KEY_ELEVEN_MODIFIER, 0}, // 0x44 F11\r
+ {EfiKeyF12, 0x00, 0x00, EFI_FUNCTION_KEY_TWELVE_MODIFIER, 0}, // 0x45 F12\r
+ {EfiKeyPrint, 0x00, 0x00, EFI_PRINT_MODIFIER, 0}, // 0x46 PrintScreen\r
+ {EfiKeySLck, 0x00, 0x00, EFI_SCROLL_LOCK_MODIFIER, 0}, // 0x47 Scroll Lock\r
+ {EfiKeyPause, 0x00, 0x00, EFI_PAUSE_MODIFIER, 0}, // 0x48 Pause\r
+ {EfiKeyIns, 0x00, 0x00, EFI_INSERT_MODIFIER, 0}, // 0x49\r
+ {EfiKeyHome, 0x00, 0x00, EFI_HOME_MODIFIER, 0}, // 0x4A\r
+ {EfiKeyPgUp, 0x00, 0x00, EFI_PAGE_UP_MODIFIER, 0}, // 0x4B\r
+ {EfiKeyDel, 0x00, 0x00, EFI_DELETE_MODIFIER, 0}, // 0x4C\r
+ {EfiKeyEnd, 0x00, 0x00, EFI_END_MODIFIER, 0}, // 0x4D\r
+ {EfiKeyPgDn, 0x00, 0x00, EFI_PAGE_DOWN_MODIFIER, 0}, // 0x4E\r
+ {EfiKeyRightArrow, 0x00, 0x00, EFI_RIGHT_ARROW_MODIFIER, 0}, // 0x4F\r
+ {EfiKeyLeftArrow, 0x00, 0x00, EFI_LEFT_ARROW_MODIFIER, 0}, // 0x50\r
+ {EfiKeyDownArrow, 0x00, 0x00, EFI_DOWN_ARROW_MODIFIER, 0}, // 0x51\r
+ {EfiKeyUpArrow, 0x00, 0x00, EFI_UP_ARROW_MODIFIER, 0}, // 0x52\r
+ {EfiKeyNLck, 0x00, 0x00, EFI_NUM_LOCK_MODIFIER, 0}, // 0x53 NumLock\r
+ {EfiKeySlash, '/', '/', EFI_NULL_MODIFIER, 0}, // 0x54\r
+ {EfiKeyAsterisk, '*', '*', EFI_NULL_MODIFIER, 0}, // 0x55\r
+ {EfiKeyMinus, '-', '-', EFI_NULL_MODIFIER, 0}, // 0x56\r
+ {EfiKeyPlus, '+', '+', EFI_NULL_MODIFIER, 0}, // 0x57\r
+ {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x58\r
+ {EfiKeyOne, '1', '1', EFI_END_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x59\r
+ {EfiKeyTwo, '2', '2', EFI_DOWN_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5A\r
+ {EfiKeyThree, '3', '3', EFI_PAGE_DOWN_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5B\r
+ {EfiKeyFour, '4', '4', EFI_LEFT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5C\r
+ {EfiKeyFive, '5', '5', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5D\r
+ {EfiKeySix, '6', '6', EFI_RIGHT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5E\r
+ {EfiKeySeven, '7', '7', EFI_HOME_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5F\r
+ {EfiKeyEight, '8', '8', EFI_UP_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x60\r
+ {EfiKeyNine, '9', '9', EFI_PAGE_UP_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x61\r
+ {EfiKeyZero, '0', '0', EFI_INSERT_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x62\r
+ {EfiKeyPeriod, '.', '.', EFI_DELETE_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x63\r
+ {EfiKeyB0, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x64 Keyboard Non-US \ and |\r
+ {EfiKeyA4, 0x00, 0x00, EFI_MENU_MODIFIER, 0}, // 0x65 Keyboard Application\r
+\r
+ {EfiKeyLCtrl, 0, 0, EFI_LEFT_CONTROL_MODIFIER, 0}, // 0xe0\r
+ {EfiKeyLShift, 0, 0, EFI_LEFT_SHIFT_MODIFIER, 0}, // 0xe1\r
+ {EfiKeyLAlt, 0, 0, EFI_LEFT_ALT_MODIFIER, 0}, // 0xe2\r
+ {EfiKeyA0, 0, 0, EFI_LEFT_LOGO_MODIFIER, 0}, // 0xe3\r
+ {EfiKeyRCtrl, 0, 0, EFI_RIGHT_CONTROL_MODIFIER, 0}, // 0xe4\r
+ {EfiKeyRShift, 0, 0, EFI_RIGHT_SHIFT_MODIFIER, 0}, // 0xe5\r
+ {EfiKeyA2, 0, 0, EFI_RIGHT_ALT_MODIFIER, 0}, // 0xe6\r
+ {EfiKeyA3, 0, 0, EFI_RIGHT_LOGO_MODIFIER, 0}, // 0xe7\r
+};\r
+\r
+/**\r
+ Initialize KeyConvertionTable by using default keyboard layout.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @retval None.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+LoadDefaultKeyboardLayout (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ UINTN Index;\r
+ EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
+\r
+ //\r
+ // Construct KeyConvertionTable by default keyboard layout\r
+ //\r
+ KeyDescriptor = &UsbKeyboardDevice->KeyConvertionTable[0];\r
+\r
+ for (Index = 0; Index < (USB_KEYCODE_MAX_MAKE + 8); Index++) {\r
+ KeyDescriptor->Key = (EFI_KEY) KeyboardLayoutTable[Index][0];\r
+ KeyDescriptor->Unicode = KeyboardLayoutTable[Index][1];\r
+ KeyDescriptor->ShiftedUnicode = KeyboardLayoutTable[Index][2];\r
+ KeyDescriptor->AltGrUnicode = 0;\r
+ KeyDescriptor->ShiftedAltGrUnicode = 0;\r
+ KeyDescriptor->Modifier = KeyboardLayoutTable[Index][3];\r
+ KeyDescriptor->AffectedAttribute = KeyboardLayoutTable[Index][4];\r
+\r
+ KeyDescriptor++;\r
+ }\r
+}\r
+\r
+//\r
+// EFI_KEY to USB Scan Code convertion table\r
+//\r
+STATIC\r
+UINT8 UsbScanCodeConvertionTable[] = {\r
+ 0xe0, // EfiKeyLCtrl\r
+ 0xe3, // EfiKeyA0\r
+ 0xe2, // EfiKeyLAlt\r
+ 0x2c, // EfiKeySpaceBar\r
+ 0xe6, // EfiKeyA2\r
+ 0xe7, // EfiKeyA3\r
+ 0x65, // EfiKeyA4\r
+ 0xe4, // EfiKeyRCtrl\r
+ 0x50, // EfiKeyLeftArrow\r
+ 0x51, // EfiKeyDownArrow\r
+ 0x4F, // EfiKeyRightArrow\r
+ 0x62, // EfiKeyZero\r
+ 0x63, // EfiKeyPeriod\r
+ 0x28, // EfiKeyEnter\r
+ 0xe1, // EfiKeyLShift\r
+ 0x64, // EfiKeyB0\r
+ 0x1D, // EfiKeyB1\r
+ 0x1B, // EfiKeyB2\r
+ 0x06, // EfiKeyB3\r
+ 0x19, // EfiKeyB4\r
+ 0x05, // EfiKeyB5\r
+ 0x11, // EfiKeyB6\r
+ 0x10, // EfiKeyB7\r
+ 0x36, // EfiKeyB8\r
+ 0x37, // EfiKeyB9\r
+ 0x38, // EfiKeyB10\r
+ 0xe5, // EfiKeyRShift\r
+ 0x52, // EfiKeyUpArrow\r
+ 0x59, // EfiKeyOne\r
+ 0x5A, // EfiKeyTwo\r
+ 0x5B, // EfiKeyThree\r
+ 0x39, // EfiKeyCapsLock\r
+ 0x04, // EfiKeyC1\r
+ 0x16, // EfiKeyC2\r
+ 0x07, // EfiKeyC3\r
+ 0x09, // EfiKeyC4\r
+ 0x0A, // EfiKeyC5\r
+ 0x0B, // EfiKeyC6\r
+ 0x0D, // EfiKeyC7\r
+ 0x0E, // EfiKeyC8\r
+ 0x0F, // EfiKeyC9\r
+ 0x33, // EfiKeyC10\r
+ 0x34, // EfiKeyC11\r
+ 0x32, // EfiKeyC12\r
+ 0x5C, // EfiKeyFour\r
+ 0x5D, // EfiKeyFive\r
+ 0x5E, // EfiKeySix\r
+ 0x57, // EfiKeyPlus\r
+ 0x2B, // EfiKeyTab\r
+ 0x14, // EfiKeyD1\r
+ 0x1A, // EfiKeyD2\r
+ 0x08, // EfiKeyD3\r
+ 0x15, // EfiKeyD4\r
+ 0x17, // EfiKeyD5\r
+ 0x1C, // EfiKeyD6\r
+ 0x18, // EfiKeyD7\r
+ 0x0C, // EfiKeyD8\r
+ 0x12, // EfiKeyD9\r
+ 0x13, // EfiKeyD10\r
+ 0x2F, // EfiKeyD11\r
+ 0x30, // EfiKeyD12\r
+ 0x31, // EfiKeyD13\r
+ 0x4C, // EfiKeyDel\r
+ 0x4D, // EfiKeyEnd\r
+ 0x4E, // EfiKeyPgDn\r
+ 0x5F, // EfiKeySeven\r
+ 0x60, // EfiKeyEight\r
+ 0x61, // EfiKeyNine\r
+ 0x35, // EfiKeyE0\r
+ 0x1E, // EfiKeyE1\r
+ 0x1F, // EfiKeyE2\r
+ 0x20, // EfiKeyE3\r
+ 0x21, // EfiKeyE4\r
+ 0x22, // EfiKeyE5\r
+ 0x23, // EfiKeyE6\r
+ 0x24, // EfiKeyE7\r
+ 0x25, // EfiKeyE8\r
+ 0x26, // EfiKeyE9\r
+ 0x27, // EfiKeyE10\r
+ 0x2D, // EfiKeyE11\r
+ 0x2E, // EfiKeyE12\r
+ 0x2A, // EfiKeyBackSpace\r
+ 0x49, // EfiKeyIns\r
+ 0x4A, // EfiKeyHome\r
+ 0x4B, // EfiKeyPgUp\r
+ 0x53, // EfiKeyNLck\r
+ 0x54, // EfiKeySlash\r
+ 0x55, // EfiKeyAsterisk\r
+ 0x56, // EfiKeyMinus\r
+ 0x29, // EfiKeyEsc\r
+ 0x3A, // EfiKeyF1\r
+ 0x3B, // EfiKeyF2\r
+ 0x3C, // EfiKeyF3\r
+ 0x3D, // EfiKeyF4\r
+ 0x3E, // EfiKeyF5\r
+ 0x3F, // EfiKeyF6\r
+ 0x40, // EfiKeyF7\r
+ 0x41, // EfiKeyF8\r
+ 0x42, // EfiKeyF9\r
+ 0x43, // EfiKeyF10\r
+ 0x44, // EfiKeyF11\r
+ 0x45, // EfiKeyF12\r
+ 0x46, // EfiKeyPrint\r
+ 0x47, // EfiKeySLck\r
+ 0x48 // EfiKeyPause\r
+};\r
+\r
+//\r
+// Keyboard Layout Modifier to EFI Scan Code convertion table\r
+//\r
+STATIC\r
+UINT8 EfiScanCodeConvertionTable[] = {\r
+ SCAN_NULL, // EFI_NULL_MODIFIER\r
+ SCAN_NULL, // EFI_LEFT_CONTROL_MODIFIER\r
+ SCAN_NULL, // EFI_RIGHT_CONTROL_MODIFIER\r
+ SCAN_NULL, // EFI_LEFT_ALT_MODIFIER\r
+ SCAN_NULL, // EFI_RIGHT_ALT_MODIFIER\r
+ SCAN_NULL, // EFI_ALT_GR_MODIFIER\r
+ SCAN_INSERT, // EFI_INSERT_MODIFIER\r
+ SCAN_DELETE, // EFI_DELETE_MODIFIER\r
+ SCAN_PAGE_DOWN, // EFI_PAGE_DOWN_MODIFIER\r
+ SCAN_PAGE_UP, // EFI_PAGE_UP_MODIFIER\r
+ SCAN_HOME, // EFI_HOME_MODIFIER\r
+ SCAN_END, // EFI_END_MODIFIER\r
+ SCAN_NULL, // EFI_LEFT_SHIFT_MODIFIER\r
+ SCAN_NULL, // EFI_RIGHT_SHIFT_MODIFIER\r
+ SCAN_NULL, // EFI_CAPS_LOCK_MODIFIER\r
+ SCAN_NULL, // EFI_NUM_LOCK_MODIFIER\r
+ SCAN_LEFT, // EFI_LEFT_ARROW_MODIFIER\r
+ SCAN_RIGHT, // EFI_RIGHT_ARROW_MODIFIER\r
+ SCAN_DOWN, // EFI_DOWN_ARROW_MODIFIER\r
+ SCAN_UP, // EFI_UP_ARROW_MODIFIER\r
+ SCAN_NULL, // EFI_NS_KEY_MODIFIER\r
+ SCAN_NULL, // EFI_NS_KEY_DEPENDENCY_MODIFIER\r
+ SCAN_F1, // EFI_FUNCTION_KEY_ONE_MODIFIER\r
+ SCAN_F2, // EFI_FUNCTION_KEY_TWO_MODIFIER\r
+ SCAN_F3, // EFI_FUNCTION_KEY_THREE_MODIFIER\r
+ SCAN_F4, // EFI_FUNCTION_KEY_FOUR_MODIFIER\r
+ SCAN_F5, // EFI_FUNCTION_KEY_FIVE_MODIFIER\r
+ SCAN_F6, // EFI_FUNCTION_KEY_SIX_MODIFIER\r
+ SCAN_F7, // EFI_FUNCTION_KEY_SEVEN_MODIFIER\r
+ SCAN_F8, // EFI_FUNCTION_KEY_EIGHT_MODIFIER\r
+ SCAN_F9, // EFI_FUNCTION_KEY_NINE_MODIFIER\r
+ SCAN_F10, // EFI_FUNCTION_KEY_TEN_MODIFIER\r
+ SCAN_F11, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER\r
+ SCAN_F12, // EFI_FUNCTION_KEY_TWELVE_MODIFIER\r
+};\r
+\r
+EFI_GUID mKeyboardLayoutEventGuid = EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID;\r
+\r
+\r
+STATIC KB_MODIFIER KB_Mod[8] = {\r
+ { MOD_CONTROL_L, 0xe0 }, // 11100000\r
+ { MOD_CONTROL_R, 0xe4 }, // 11100100\r
+ { MOD_SHIFT_L, 0xe1 }, // 11100001\r
+ { MOD_SHIFT_R, 0xe5 }, // 11100101\r
+ { MOD_ALT_L, 0xe2 }, // 11100010\r
+ { MOD_ALT_R, 0xe6 }, // 11100110\r
+ { MOD_WIN_L, 0xe3 }, // 11100011\r
+ { MOD_WIN_R, 0xe7 }, // 11100111 \r
+};\r
+\r
+\r
+\r
+/**\r
+ Uses USB I/O to check whether the device is a USB Keyboard device.\r
+\r
+ @param UsbIo Points to a USB I/O protocol instance.\r
+ @retval None\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboard (\r
+ IN EFI_USB_IO_PROTOCOL *UsbIo\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
+\r
+ //\r
+ // Get the Default interface descriptor, currently we\r
+ // assume it is interface 1\r
+ //\r
+ Status = UsbIo->UsbGetInterfaceDescriptor (\r
+ UsbIo,\r
+ &InterfaceDescriptor\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ return FALSE;\r
+ }\r
+\r
+ if (InterfaceDescriptor.InterfaceClass == CLASS_HID &&\r
+ InterfaceDescriptor.InterfaceSubClass == SUBCLASS_BOOT &&\r
+ InterfaceDescriptor.InterfaceProtocol == PROTOCOL_KEYBOARD\r
+ ) {\r
+\r
+ return TRUE;\r
+ }\r
+\r
+ return FALSE;\r
+}\r
+\r
+/**\r
+ Get current keyboard layout from HII database.\r
+\r
+ @retval Pointer to EFI_HII_KEYBOARD_LAYOUT.\r
+\r
+**/\r
+EFI_HII_KEYBOARD_LAYOUT *\r
+EFIAPI\r
+GetCurrentKeyboardLayout (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
+ EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
+ UINT16 Length;\r
+\r
+ //\r
+ // Locate Hii database protocol\r
+ //\r
+ Status = gBS->LocateProtocol (\r
+ &gEfiHiiDatabaseProtocolGuid,\r
+ NULL,\r
+ (VOID **) &HiiDatabase\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Get current keyboard layout from HII database\r
+ //\r
+ Length = 0;\r
+ KeyboardLayout = NULL;\r
+ Status = HiiDatabase->GetKeyboardLayout (\r
+ HiiDatabase,\r
+ NULL,\r
+ &Length,\r
+ KeyboardLayout\r
+ );\r
+ if (Status == EFI_BUFFER_TOO_SMALL) {\r
+ KeyboardLayout = AllocatePool (Length);\r
+ ASSERT (KeyboardLayout != NULL);\r
+\r
+ Status = HiiDatabase->GetKeyboardLayout (\r
+ HiiDatabase,\r
+ NULL,\r
+ &Length,\r
+ KeyboardLayout\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->FreePool (KeyboardLayout);\r
+ KeyboardLayout = NULL;\r
+ }\r
+ }\r
+\r
+ return KeyboardLayout;\r
+}\r
+\r
+/**\r
+ Find Key Descriptor in KeyConvertionTable given its scan code.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param ScanCode USB scan code.\r
+\r
+ @return The Key descriptor in KeyConvertionTable.\r
+\r
+**/\r
+EFI_KEY_DESCRIPTOR *\r
+EFIAPI\r
+GetKeyDescriptor (\r
+ IN USB_KB_DEV *UsbKeyboardDevice,\r
+ IN UINT8 ScanCode\r
+ )\r
+{\r
+ UINT8 Index;\r
+\r
+ if (((ScanCode > 0x65) && (ScanCode < 0xe0)) || (ScanCode > 0xe7)) {\r
+ return NULL;\r
+ }\r
+\r
+ if (ScanCode <= 0x65) {\r
+ Index = (UINT8) (ScanCode - 4);\r
+ } else {\r
+ Index = (UINT8) (ScanCode - 0xe0 + USB_KEYCODE_MAX_MAKE);\r
+ }\r
+\r
+ return &UsbKeyboardDevice->KeyConvertionTable[Index];\r
+}\r
+\r
+/**\r
+ Find Non-Spacing key for given KeyDescriptor.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param KeyDescriptor Key descriptor.\r
+\r
+ @retval NULL Key list is empty.\r
+ @return Other The Non-Spacing key.\r
+\r
+**/\r
+USB_NS_KEY *\r
+EFIAPI\r
+FindUsbNsKey (\r
+ IN USB_KB_DEV *UsbKeyboardDevice,\r
+ IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ USB_NS_KEY *UsbNsKey;\r
+\r
+ Link = GetFirstNode (&UsbKeyboardDevice->NsKeyList);\r
+ while (!IsNull (&UsbKeyboardDevice->NsKeyList, Link)) {\r
+ UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
+\r
+ if (UsbNsKey->NsKey[0].Key == KeyDescriptor->Key) {\r
+ return UsbNsKey;\r
+ }\r
+\r
+ Link = GetNextNode (&UsbKeyboardDevice->NsKeyList, Link);\r
+ }\r
+\r
+ return NULL;\r
+}\r
+\r
+/**\r
+ Find physical key definition for a given Key stroke.\r
+\r
+ @param UsbNsKey The Non-Spacing key information.\r
+ @param KeyDescriptor The key stroke.\r
+\r
+ @return The physical key definition.\r
+\r
+**/\r
+EFI_KEY_DESCRIPTOR *\r
+EFIAPI\r
+FindPhysicalKey (\r
+ IN USB_NS_KEY *UsbNsKey,\r
+ IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
+ )\r
+{\r
+ UINTN Index;\r
+ EFI_KEY_DESCRIPTOR *PhysicalKey;\r
+\r
+ PhysicalKey = &UsbNsKey->NsKey[1];\r
+ for (Index = 0; Index < UsbNsKey->KeyCount; Index++) {\r
+ if (KeyDescriptor->Key == PhysicalKey->Key) {\r
+ return PhysicalKey;\r
+ }\r
+\r
+ PhysicalKey++;\r
+ }\r
+\r
+ //\r
+ // No children definition matched, return original key\r
+ //\r
+ return KeyDescriptor;\r
+}\r
+\r
+/**\r
+ The notification function for SET_KEYBOARD_LAYOUT_EVENT.\r
+\r
+ @param Event The instance of EFI_EVENT.\r
+ @param Context passing parameter.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+SetKeyboardLayoutEvent (\r
+ EFI_EVENT Event,\r
+ VOID *Context\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
+ EFI_KEY_DESCRIPTOR TempKey;\r
+ EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
+ EFI_KEY_DESCRIPTOR *TableEntry;\r
+ EFI_KEY_DESCRIPTOR *NsKey;\r
+ USB_NS_KEY *UsbNsKey;\r
+ UINTN Index;\r
+ UINTN Index2;\r
+ UINTN KeyCount;\r
+ UINT8 ScanCode;\r
+\r
+ UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
+\r
+ //\r
+ // Try to get current Keyboard Layout from HII database\r
+ //\r
+ KeyboardLayout = GetCurrentKeyboardLayout ();\r
+ if (KeyboardLayout == NULL) {\r
+ return;\r
+ }\r
+\r
+ //\r
+ // Allocate resource for KeyConvertionTable\r
+ //\r
+ ReleaseKeyboardLayoutResources (UsbKeyboardDevice);\r
+ UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((USB_KEYCODE_MAX_MAKE + 8) * sizeof (EFI_KEY_DESCRIPTOR));\r
+ ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
+\r
+ KeyDescriptor = (EFI_KEY_DESCRIPTOR *) (((UINT8 *) KeyboardLayout) + sizeof (EFI_HII_KEYBOARD_LAYOUT));\r
+ for (Index = 0; Index < KeyboardLayout->DescriptorCount; Index++) {\r
+ //\r
+ // Copy from HII keyboard layout package binary for alignment\r
+ //\r
+ CopyMem (&TempKey, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
+\r
+ //\r
+ // Fill the key into KeyConvertionTable (which use USB Scan Code as index)\r
+ //\r
+ ScanCode = UsbScanCodeConvertionTable [(UINT8) (TempKey.Key)];\r
+ TableEntry = GetKeyDescriptor (UsbKeyboardDevice, ScanCode);\r
+ CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
+\r
+ if (TempKey.Modifier == EFI_NS_KEY_MODIFIER) {\r
+ //\r
+ // Non-spacing key\r
+ //\r
+ UsbNsKey = AllocatePool (sizeof (USB_NS_KEY));\r
+ ASSERT (UsbNsKey != NULL);\r
+\r
+ //\r
+ // Search for sequential children physical key definitions\r
+ //\r
+ KeyCount = 0;\r
+ NsKey = KeyDescriptor + 1;\r
+ for (Index2 = Index + 1; Index2 < KeyboardLayout->DescriptorCount; Index2++) {\r
+ CopyMem (&TempKey, NsKey, sizeof (EFI_KEY_DESCRIPTOR));\r
+ if (TempKey.Modifier & EFI_NS_KEY_DEPENDENCY_MODIFIER) {\r
+ KeyCount++;\r
+ } else {\r
+ break;\r
+ }\r
+ NsKey++;\r
+ }\r
+\r
+ UsbNsKey->Signature = USB_NS_KEY_SIGNATURE;\r
+ UsbNsKey->KeyCount = KeyCount;\r
+ UsbNsKey->NsKey = AllocateCopyPool (\r
+ (KeyCount + 1) * sizeof (EFI_KEY_DESCRIPTOR),\r
+ KeyDescriptor\r
+ );\r
+ InsertTailList (&UsbKeyboardDevice->NsKeyList, &UsbNsKey->Link);\r
+\r
+ //\r
+ // Skip over the child physical keys\r
+ //\r
+ Index += KeyCount;\r
+ KeyDescriptor += KeyCount;\r
+ }\r
+\r
+ KeyDescriptor++;\r
+ }\r
+\r
+ //\r
+ // There are two EfiKeyEnter, duplicate its Key Descriptor\r
+ //\r
+ TableEntry = GetKeyDescriptor (UsbKeyboardDevice, 0x58);\r
+ KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, 0x28);\r
+ CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
+\r
+ gBS->FreePool (KeyboardLayout);\r
+}\r
+\r
+/**\r
+ Destroy resources for Keyboard layout.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ReleaseKeyboardLayoutResources (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ USB_NS_KEY *UsbNsKey;\r
+ LIST_ENTRY *Link;\r
+\r
+ SafeFreePool (UsbKeyboardDevice->KeyConvertionTable);\r
+ UsbKeyboardDevice->KeyConvertionTable = NULL;\r
+\r
+ while (!IsListEmpty (&UsbKeyboardDevice->NsKeyList)) {\r
+ Link = GetFirstNode (&UsbKeyboardDevice->NsKeyList);\r
+ UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
+ RemoveEntryList (&UsbNsKey->Link);\r
+\r
+ gBS->FreePool (UsbNsKey->NsKey);\r
+ gBS->FreePool (UsbNsKey);\r
+ }\r
+}\r
+\r
+/**\r
+ Initialize USB Keyboard layout.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Initialization Success.\r
+ @retval Other Keyboard layout initial failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitKeyboardLayout (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
+ EFI_STATUS Status;\r
+\r
+ UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((USB_KEYCODE_MAX_MAKE + 8) * sizeof (EFI_KEY_DESCRIPTOR));\r
+ ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
+\r
+ InitializeListHead (&UsbKeyboardDevice->NsKeyList);\r
+ UsbKeyboardDevice->CurrentNsKey = NULL;\r
+ UsbKeyboardDevice->KeyboardLayoutEvent = NULL;\r
+\r
+ //\r
+ // Register SET_KEYBOARD_LAYOUT_EVENT notification\r
+ //\r
+ Status = gBS->CreateEventEx (\r
+ EFI_EVENT_NOTIFY_SIGNAL,\r
+ TPL_NOTIFY,\r
+ SetKeyboardLayoutEvent,\r
+ UsbKeyboardDevice,\r
+ &mKeyboardLayoutEventGuid,\r
+ &UsbKeyboardDevice->KeyboardLayoutEvent\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Try to get current keyboard layout from HII database\r
+ //\r
+ KeyboardLayout = GetCurrentKeyboardLayout ();\r
+ if (KeyboardLayout != NULL) {\r
+ //\r
+ // Force to initialize the keyboard layout\r
+ //\r
+ gBS->SignalEvent (UsbKeyboardDevice->KeyboardLayoutEvent);\r
+ } else {\r
+ if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver)) {\r
+ return EFI_NOT_READY;\r
+ } else {\r
+\r
+ //\r
+ // Fail to get keyboard layout from HII database,\r
+ // use default keyboard layout\r
+ //\r
+ LoadDefaultKeyboardLayout (UsbKeyboardDevice);\r
+ }\r
+ }\r
+ \r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Initialize USB Keyboard device and all private data structures.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Initialization is successful.\r
+ @retval EFI_DEVICE_ERROR Configure hardware failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitUSBKeyboard (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ UINT8 ConfigValue;\r
+ UINT8 Protocol;\r
+ UINT8 ReportId;\r
+ UINT8 Duration;\r
+ EFI_STATUS Status;\r
+ UINT32 TransferResult;\r
+\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_PROGRESS_CODE,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardSelfTest)\r
+ );\r
+\r
+ InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
+\r
+ //\r
+ // default configurations\r
+ //\r
+ ConfigValue = 0x01;\r
+\r
+ //\r
+ // Uses default configuration to configure the USB Keyboard device.\r
+ //\r
+ Status = UsbSetConfiguration (\r
+ UsbKeyboardDevice->UsbIo,\r
+ (UINT16) ConfigValue,\r
+ &TransferResult\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // If configuration could not be set here, it means\r
+ // the keyboard interface has some errors and could\r
+ // not be initialized\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardInterfaceError)\r
+ );\r
+\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ UsbGetProtocolRequest (\r
+ UsbKeyboardDevice->UsbIo,\r
+ UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
+ &Protocol\r
+ );\r
+ //\r
+ // Sets boot protocol for the USB Keyboard.\r
+ // This driver only supports boot protocol.\r
+ // !!BugBug: How about the device that does not support boot protocol?\r
+ //\r
+ if (Protocol != BOOT_PROTOCOL) {\r
+ UsbSetProtocolRequest (\r
+ UsbKeyboardDevice->UsbIo,\r
+ UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
+ BOOT_PROTOCOL\r
+ );\r
+ }\r
+ //\r
+ // the duration is indefinite, so the endpoint will inhibit reporting forever,\r
+ // and only reporting when a change is detected in the report data.\r
+ //\r
+\r
+ //\r
+ // idle value for all report ID\r
+ //\r
+ ReportId = 0;\r
+ //\r
+ // idle forever until there is a key pressed and released.\r
+ //\r
+ Duration = 0;\r
+ UsbSetIdleRequest (\r
+ UsbKeyboardDevice->UsbIo,\r
+ UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
+ ReportId,\r
+ Duration\r
+ );\r
+\r
+ UsbKeyboardDevice->CtrlOn = 0;\r
+ UsbKeyboardDevice->AltOn = 0;\r
+ UsbKeyboardDevice->ShiftOn = 0;\r
+ UsbKeyboardDevice->NumLockOn = 0;\r
+ UsbKeyboardDevice->CapsOn = 0;\r
+ UsbKeyboardDevice->ScrollOn = 0;\r
+ \r
+ UsbKeyboardDevice->LeftCtrlOn = 0;\r
+ UsbKeyboardDevice->LeftAltOn = 0;\r
+ UsbKeyboardDevice->LeftShiftOn = 0;\r
+ UsbKeyboardDevice->LeftLogoOn = 0;\r
+ UsbKeyboardDevice->RightCtrlOn = 0;\r
+ UsbKeyboardDevice->RightAltOn = 0;\r
+ UsbKeyboardDevice->RightShiftOn = 0;\r
+ UsbKeyboardDevice->RightLogoOn = 0;\r
+ UsbKeyboardDevice->MenuKeyOn = 0;\r
+ UsbKeyboardDevice->SysReqOn = 0;\r
+\r
+ UsbKeyboardDevice->AltGrOn = 0;\r
+\r
+ UsbKeyboardDevice->CurrentNsKey = NULL;\r
+\r
+ //\r
+ // Sync the initial state of lights\r
+ //\r
+ SetKeyLED (UsbKeyboardDevice);\r
+\r
+ ZeroMem (UsbKeyboardDevice->LastKeyCodeArray, sizeof (UINT8) * 8);\r
+\r
+ //\r
+ // Set a timer for repeat keys' generation.\r
+ //\r
+ if (UsbKeyboardDevice->RepeatTimer != NULL) {\r
+ gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
+ UsbKeyboardDevice->RepeatTimer = 0;\r
+ }\r
+\r
+ Status = gBS->CreateEvent (\r
+ EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
+ TPL_NOTIFY,\r
+ USBKeyboardRepeatHandler,\r
+ UsbKeyboardDevice,\r
+ &UsbKeyboardDevice->RepeatTimer\r
+ );\r
+\r
+ if (UsbKeyboardDevice->DelayedRecoveryEvent != NULL) {\r
+ gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
+ UsbKeyboardDevice->DelayedRecoveryEvent = 0;\r
+ }\r
+\r
+ Status = gBS->CreateEvent (\r
+ EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
+ TPL_NOTIFY,\r
+ USBKeyboardRecoveryHandler,\r
+ UsbKeyboardDevice,\r
+ &UsbKeyboardDevice->DelayedRecoveryEvent\r
+ );\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Handler function for USB Keyboard's asynchronous interrupt transfer.\r
+\r
+ @param Data A pointer to a buffer that is filled with key data which is\r
+ retrieved via asynchronous interrupt transfer.\r
+ @param DataLength Indicates the size of the data buffer.\r
+ @param Context Pointing to USB_KB_DEV instance.\r
+ @param Result Indicates the result of the asynchronous interrupt transfer.\r
+\r
+ @retval EFI_SUCCESS Handler is successful.\r
+ @retval EFI_DEVICE_ERROR Hardware Error\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+KeyboardHandler (\r
+ IN VOID *Data,\r
+ IN UINTN DataLength,\r
+ IN VOID *Context,\r
+ IN UINT32 Result\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ UINT8 *CurKeyCodeBuffer;\r
+ UINT8 *OldKeyCodeBuffer;\r
+ UINT8 CurModifierMap;\r
+ UINT8 OldModifierMap;\r
+ UINT8 Index;\r
+ UINT8 Index2;\r
+ BOOLEAN Down;\r
+ BOOLEAN KeyRelease;\r
+ BOOLEAN KeyPress;\r
+ UINT8 SavedTail;\r
+ USB_KEY UsbKey;\r
+ UINT8 NewRepeatKey;\r
+ UINT32 UsbStatus;\r
+ EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
+\r
+ ASSERT (Context);\r
+\r
+ NewRepeatKey = 0;\r
+ UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
+ UsbIo = UsbKeyboardDevice->UsbIo;\r
+\r
+ //\r
+ // Analyzes the Result and performs corresponding action.\r
+ //\r
+ if (Result != EFI_USB_NOERROR) {\r
+ //\r
+ // Some errors happen during the process\r
+ //\r
+ KbdReportStatusCode (\r
+ UsbKeyboardDevice->DevicePath,\r
+ EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+ PcdGet32 (PcdStatusCodeValueKeyboardInputError)\r
+ );\r
+\r
+ //\r
+ // stop the repeat key generation if any\r
+ //\r
+ UsbKeyboardDevice->RepeatKey = 0;\r
+\r
+ gBS->SetTimer (\r
+ UsbKeyboardDevice->RepeatTimer,\r
+ TimerCancel,\r
+ USBKBD_REPEAT_RATE\r
+ );\r
+\r
+ if ((Result & EFI_USB_ERR_STALL) == EFI_USB_ERR_STALL) {\r
+ UsbClearEndpointHalt (\r
+ UsbIo,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
+ &UsbStatus\r
+ );\r
+ }\r
+\r
+ //\r
+ // Delete & Submit this interrupt again\r
+ //\r
+\r
+ UsbIo->UsbAsyncInterruptTransfer (\r
+ UsbIo,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
+ FALSE,\r
+ 0,\r
+ 0,\r
+ NULL,\r
+ NULL\r
+ );\r
+\r
+ gBS->SetTimer (\r
+ UsbKeyboardDevice->DelayedRecoveryEvent,\r
+ TimerRelative,\r
+ EFI_USB_INTERRUPT_DELAY\r
+ );\r
+\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ if (DataLength == 0 || Data == NULL) {\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ CurKeyCodeBuffer = (UINT8 *) Data;\r
+ OldKeyCodeBuffer = UsbKeyboardDevice->LastKeyCodeArray;\r
+\r
+ //\r
+ // checks for new key stroke.\r
+ // if no new key got, return immediately.\r
+ //\r
+ for (Index = 0; Index < 8; Index++) {\r
+ if (OldKeyCodeBuffer[Index] != CurKeyCodeBuffer[Index]) {\r
+ break;\r
+ }\r
+ }\r
+\r
+ if (Index == 8) {\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ // Parse the modifier key\r
+ //\r
+ CurModifierMap = CurKeyCodeBuffer[0];\r
+ OldModifierMap = OldKeyCodeBuffer[0];\r
+\r
+ //\r
+ // handle modifier key's pressing or releasing situation.\r
+ //\r
+ for (Index = 0; Index < 8; Index++) {\r
+\r
+ if ((CurModifierMap & KB_Mod[Index].Mask) != (OldModifierMap & KB_Mod[Index].Mask)) {\r
+ //\r
+ // if current modifier key is up, then\r
+ // CurModifierMap & KB_Mod[Index].Mask = 0;\r
+ // otherwize it is a non-zero value.\r
+ // Inserts the pressed modifier key into key buffer.\r
+ //\r
+ Down = (UINT8) (CurModifierMap & KB_Mod[Index].Mask);\r
+ InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), KB_Mod[Index].Key, Down);\r
+ }\r
+ }\r
+\r
+ //\r
+ // handle normal key's releasing situation\r
+ //\r
+ KeyRelease = FALSE;\r
+ for (Index = 2; Index < 8; Index++) {\r
+\r
+ if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index])) {\r
+ continue;\r
+ }\r
+\r
+ KeyRelease = TRUE;\r
+ for (Index2 = 2; Index2 < 8; Index2++) {\r
+\r
+ if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index2])) {\r
+ continue;\r
+ }\r
+\r
+ if (OldKeyCodeBuffer[Index] == CurKeyCodeBuffer[Index2]) {\r
+ KeyRelease = FALSE;\r
+ break;\r
+ }\r
+ }\r
+\r
+ if (KeyRelease) {\r
+ InsertKeyCode (\r
+ &(UsbKeyboardDevice->KeyboardBuffer),\r
+ OldKeyCodeBuffer[Index],\r
+ 0\r
+ );\r
+ //\r
+ // the original reapeat key is released.\r
+ //\r
+ if (OldKeyCodeBuffer[Index] == UsbKeyboardDevice->RepeatKey) {\r
+ UsbKeyboardDevice->RepeatKey = 0;\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // original repeat key is released, cancel the repeat timer\r
+ //\r
+ if (UsbKeyboardDevice->RepeatKey == 0) {\r
+ gBS->SetTimer (\r
+ UsbKeyboardDevice->RepeatTimer,\r
+ TimerCancel,\r
+ USBKBD_REPEAT_RATE\r
+ );\r
+ }\r
+\r
+ //\r
+ // handle normal key's pressing situation\r
+ //\r
+ KeyPress = FALSE;\r
+ for (Index = 2; Index < 8; Index++) {\r
+\r
+ if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index])) {\r
+ continue;\r
+ }\r
+\r
+ KeyPress = TRUE;\r
+ for (Index2 = 2; Index2 < 8; Index2++) {\r
+\r
+ if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index2])) {\r
+ continue;\r
+ }\r
+\r
+ if (CurKeyCodeBuffer[Index] == OldKeyCodeBuffer[Index2]) {\r
+ KeyPress = FALSE;\r
+ break;\r
+ }\r
+ }\r
+\r
+ if (KeyPress) {\r
+ InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), CurKeyCodeBuffer[Index], 1);\r
+ //\r
+ // NumLock pressed or CapsLock pressed\r
+ //\r
+ KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, CurKeyCodeBuffer[Index]);\r
+ if (KeyDescriptor->Modifier == EFI_NUM_LOCK_MODIFIER || KeyDescriptor->Modifier == EFI_CAPS_LOCK_MODIFIER) {\r
+ UsbKeyboardDevice->RepeatKey = 0;\r
+ } else {\r
+ NewRepeatKey = CurKeyCodeBuffer[Index];\r
+ //\r
+ // do not repeat the original repeated key\r
+ //\r
+ UsbKeyboardDevice->RepeatKey = 0;\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Update LastKeycodeArray[] buffer in the\r
+ // Usb Keyboard Device data structure.\r
+ //\r
+ for (Index = 0; Index < 8; Index++) {\r
+ UsbKeyboardDevice->LastKeyCodeArray[Index] = CurKeyCodeBuffer[Index];\r
+ }\r
+\r
+ //\r
+ // pre-process KeyboardBuffer, pop out the ctrl,alt,del key in sequence\r
+ // and judge whether it will invoke reset event.\r
+ //\r
+ SavedTail = UsbKeyboardDevice->KeyboardBuffer.bTail;\r
+ Index = UsbKeyboardDevice->KeyboardBuffer.bHead;\r
+ while (Index != SavedTail) {\r
+ RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
+\r
+ KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
+\r
+ switch (KeyDescriptor->Modifier) {\r
+\r
+ case EFI_LEFT_CONTROL_MODIFIER:\r
+ case EFI_RIGHT_CONTROL_MODIFIER:\r
+ if (UsbKey.Down != 0) {\r
+ UsbKeyboardDevice->CtrlOn = 1;\r
+ } else {\r
+ UsbKeyboardDevice->CtrlOn = 0;\r
+ }\r
+ break;\r
+\r
+ case EFI_LEFT_ALT_MODIFIER:\r
+ case EFI_RIGHT_ALT_MODIFIER:\r
+ if (UsbKey.Down != 0) {\r
+ UsbKeyboardDevice->AltOn = 1;\r
+ } else {\r
+ UsbKeyboardDevice->AltOn = 0;\r
+ }\r
+ break;\r
+\r
+ case EFI_ALT_GR_MODIFIER:\r
+ if (UsbKey.Down != 0) {\r
+ UsbKeyboardDevice->AltGrOn = 1;\r
+ } else {\r
+ UsbKeyboardDevice->AltGrOn = 0;\r
+ }\r
+ break;\r
+\r
+ //\r
+ // Del Key Code\r
+ //\r
+ case EFI_DELETE_MODIFIER:\r
+ if (UsbKey.Down != 0) {\r
+ if ((UsbKeyboardDevice->CtrlOn != 0) && (UsbKeyboardDevice->AltOn != 0)) {\r
+ gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
+ }\r
+ }\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+\r
+ //\r
+ // insert the key back to the buffer.\r
+ // so the key sequence will not be destroyed.\r
+ //\r
+ InsertKeyCode (\r
+ &(UsbKeyboardDevice->KeyboardBuffer),\r
+ UsbKey.KeyCode,\r
+ UsbKey.Down\r
+ );\r
+ Index = UsbKeyboardDevice->KeyboardBuffer.bHead;\r
+\r
+ }\r
+ //\r
+ // If have new key pressed, update the RepeatKey value, and set the\r
+ // timer to repeate delay timer\r
+ //\r
+ if (NewRepeatKey != 0) {\r
+ //\r
+ // sets trigger time to "Repeat Delay Time",\r
+ // to trigger the repeat timer when the key is hold long\r
+ // enough time.\r
+ //\r
+ gBS->SetTimer (\r
+ UsbKeyboardDevice->RepeatTimer,\r
+ TimerRelative,\r
+ USBKBD_REPEAT_DELAY\r
+ );\r
+ UsbKeyboardDevice->RepeatKey = NewRepeatKey;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Retrieves a key character after parsing the raw data in keyboard buffer.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param KeyChar Points to the Key character after key parsing.\r
+\r
+ @retval EFI_SUCCESS Parse key is successful.\r
+ @retval EFI_NOT_READY Device is not ready.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBParseKey (\r
+ IN OUT USB_KB_DEV *UsbKeyboardDevice,\r
+ OUT UINT8 *KeyChar\r
+ )\r
+{\r
+ USB_KEY UsbKey;\r
+ EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
+\r
+ *KeyChar = 0;\r
+\r
+ while (!IsUSBKeyboardBufferEmpty (&UsbKeyboardDevice->KeyboardBuffer)) {\r
+ //\r
+ // pops one raw data off.\r
+ //\r
+ RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
+\r
+ KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
+ if (UsbKey.Down == 0) {\r
+ switch (KeyDescriptor->Modifier) {\r
+\r
+ //\r
+ // CTRL release\r
+ //\r
+ case EFI_LEFT_CONTROL_MODIFIER:\r
+ UsbKeyboardDevice->LeftCtrlOn = 0;\r
+ UsbKeyboardDevice->CtrlOn = 0;\r
+ break;\r
+ case EFI_RIGHT_CONTROL_MODIFIER:\r
+ UsbKeyboardDevice->RightCtrlOn = 0;\r
+ UsbKeyboardDevice->CtrlOn = 0;\r
+ break;\r
+\r
+ //\r
+ // Shift release\r
+ //\r
+ case EFI_LEFT_SHIFT_MODIFIER:\r
+ UsbKeyboardDevice->LeftShiftOn = 0;\r
+ UsbKeyboardDevice->ShiftOn = 0;\r
+ break;\r
+ case EFI_RIGHT_SHIFT_MODIFIER:\r
+ UsbKeyboardDevice->RightShiftOn = 0;\r
+ UsbKeyboardDevice->ShiftOn = 0;\r
+ break;\r
+\r
+ //\r
+ // Alt release\r
+ //\r
+ case EFI_LEFT_ALT_MODIFIER:\r
+ UsbKeyboardDevice->LeftAltOn = 0;\r
+ UsbKeyboardDevice->AltOn = 0;\r
+ break;\r
+ case EFI_RIGHT_ALT_MODIFIER:\r
+ UsbKeyboardDevice->RightAltOn = 0;\r
+ UsbKeyboardDevice->AltOn = 0;\r
+ break;\r
+\r
+ //\r
+ // Left Logo release\r
+ //\r
+ case EFI_LEFT_LOGO_MODIFIER:\r
+ UsbKeyboardDevice->LeftLogoOn = 0;\r
+ break;\r
+\r
+ //\r
+ // Right Logo release\r
+ //\r
+ case EFI_RIGHT_LOGO_MODIFIER:\r
+ UsbKeyboardDevice->RightLogoOn = 0;\r
+ break;\r
+\r
+ //\r
+ // Menu key release\r
+ //\r
+ case EFI_MENU_MODIFIER:\r
+ UsbKeyboardDevice->MenuKeyOn = 0;\r
+ break;\r
+\r
+ //\r
+ // SysReq release\r
+ //\r
+ case EFI_PRINT_MODIFIER:\r
+ case EFI_SYS_REQUEST_MODIFIER:\r
+ UsbKeyboardDevice->SysReqOn = 0;\r
+ break;\r
+\r
+ //\r
+ // AltGr release\r
+ //\r
+ case EFI_ALT_GR_MODIFIER:\r
+ UsbKeyboardDevice->AltGrOn = 0;\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Analyzes key pressing situation\r
+ //\r
+ switch (KeyDescriptor->Modifier) {\r
+\r
+ //\r
+ // CTRL press\r
+ //\r
+ case EFI_LEFT_CONTROL_MODIFIER:\r
+ UsbKeyboardDevice->LeftCtrlOn = 1;\r
+ UsbKeyboardDevice->CtrlOn = 1;\r
+ continue;\r
+ break;\r
+ case EFI_RIGHT_CONTROL_MODIFIER:\r
+ UsbKeyboardDevice->RightCtrlOn = 1;\r
+ UsbKeyboardDevice->CtrlOn = 1;\r
+ continue;\r
+ break;\r
+\r
+ //\r
+ // Shift press\r
+ //\r
+ case EFI_LEFT_SHIFT_MODIFIER:\r
+ UsbKeyboardDevice->LeftShiftOn = 1;\r
+ UsbKeyboardDevice->ShiftOn = 1;\r
+ continue;\r
+ break;\r
+ case EFI_RIGHT_SHIFT_MODIFIER:\r
+ UsbKeyboardDevice->RightShiftOn = 1;\r
+ UsbKeyboardDevice->ShiftOn = 1;\r
+ continue;\r
+ break;\r
+\r
+ //\r
+ // Alt press\r
+ //\r
+ case EFI_LEFT_ALT_MODIFIER:\r
+ UsbKeyboardDevice->LeftAltOn = 1;\r
+ UsbKeyboardDevice->AltOn = 1;\r
+ continue;\r
+ break;\r
+ case EFI_RIGHT_ALT_MODIFIER:\r
+ UsbKeyboardDevice->RightAltOn = 1;\r
+ UsbKeyboardDevice->AltOn = 1;\r
+ continue;\r
+ break;\r
+\r
+ //\r
+ // Left Logo press\r
+ //\r
+ case EFI_LEFT_LOGO_MODIFIER:\r
+ UsbKeyboardDevice->LeftLogoOn = 1;\r
+ break;\r
+\r
+ //\r
+ // Right Logo press\r
+ //\r
+ case EFI_RIGHT_LOGO_MODIFIER:\r
+ UsbKeyboardDevice->RightLogoOn = 1;\r
+ break;\r
+\r
+ //\r
+ // Menu key press\r
+ //\r
+ case EFI_MENU_MODIFIER:\r
+ UsbKeyboardDevice->MenuKeyOn = 1;\r
+ break;\r
+\r
+ //\r
+ // SysReq press\r
+ //\r
+ case EFI_PRINT_MODIFIER:\r
+ case EFI_SYS_REQUEST_MODIFIER:\r
+ UsbKeyboardDevice->SysReqOn = 1;\r
+ continue;\r
+ break;\r
+\r
+ //\r
+ // AltGr press\r
+ //\r
+ case EFI_ALT_GR_MODIFIER:\r
+ UsbKeyboardDevice->AltGrOn = 1;\r
+ break;\r
+\r
+ case EFI_NUM_LOCK_MODIFIER:\r
+ UsbKeyboardDevice->NumLockOn ^= 1;\r
+ //\r
+ // Turn on the NumLock light on KB\r
+ //\r
+ SetKeyLED (UsbKeyboardDevice);\r
+ continue;\r
+ break;\r
+\r
+ case EFI_CAPS_LOCK_MODIFIER:\r
+ UsbKeyboardDevice->CapsOn ^= 1;\r
+ //\r
+ // Turn on the CapsLock light on KB\r
+ //\r
+ SetKeyLED (UsbKeyboardDevice);\r
+ continue;\r
+ break;\r
+\r
+ case EFI_SCROLL_LOCK_MODIFIER:\r
+ UsbKeyboardDevice->ScrollOn ^= 1;\r
+ //\r
+ // Turn on the ScrollLock light on KB\r
+ //\r
+ SetKeyLED (UsbKeyboardDevice);\r
+ continue;\r
+ break;\r
+\r
+ //\r
+ // F11,F12,PrintScreen,Pause/Break\r
+ // could not be retrieved via SimpleTxtInEx protocol\r
+ //\r
+ case EFI_FUNCTION_KEY_ELEVEN_MODIFIER:\r
+ case EFI_FUNCTION_KEY_TWELVE_MODIFIER:\r
+ case EFI_PAUSE_MODIFIER:\r
+ case EFI_BREAK_MODIFIER:\r
+ //\r
+ // fall through\r
+ //\r
+ continue;\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+\r
+ //\r
+ // When encountered Del Key...\r
+ //\r
+ if (KeyDescriptor->Modifier == EFI_DELETE_MODIFIER) {\r
+ if ((UsbKeyboardDevice->CtrlOn != 0) && (UsbKeyboardDevice->AltOn != 0)) {\r
+ gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
+ }\r
+ }\r
+\r
+ *KeyChar = UsbKey.KeyCode;\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ return EFI_NOT_READY;\r
+}\r
+\r
+\r
+/**\r
+ Converts USB Keyboard code to EFI Scan Code.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param KeyChar Indicates the key code that will be interpreted.\r
+ @param Key A pointer to a buffer that is filled in with\r
+ the keystroke information for the key that\r
+ was pressed.\r
+\r
+ @retval EFI_NOT_READY Device is not ready\r
+ @retval EFI_SUCCESS Success.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyCodeToEFIScanCode (\r
+ IN USB_KB_DEV *UsbKeyboardDevice,\r
+ IN UINT8 KeyChar,\r
+ OUT EFI_INPUT_KEY *Key\r
+ )\r
+{\r
+ UINT8 Index;\r
+ EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
+\r
+ if (!USBKBD_VALID_KEYCODE (KeyChar)) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ //\r
+ // valid USB Key Code starts from 4\r
+ //\r
+ Index = (UINT8) (KeyChar - 4);\r
+\r
+ if (Index >= USB_KEYCODE_MAX_MAKE) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, KeyChar);\r
+\r
+ //\r
+ // Check for Non-spacing key\r
+ //\r
+ if (KeyDescriptor->Modifier == EFI_NS_KEY_MODIFIER) {\r
+ UsbKeyboardDevice->CurrentNsKey = FindUsbNsKey (UsbKeyboardDevice, KeyDescriptor);\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ //\r
+ // Check whether this keystroke follows a Non-spacing key\r
+ //\r
+ if (UsbKeyboardDevice->CurrentNsKey != NULL) {\r
+ KeyDescriptor = FindPhysicalKey (UsbKeyboardDevice->CurrentNsKey, KeyDescriptor);\r
+ UsbKeyboardDevice->CurrentNsKey = NULL;\r
+ }\r
+\r
+ Key->ScanCode = EfiScanCodeConvertionTable[KeyDescriptor->Modifier];\r
+ Key->UnicodeChar = KeyDescriptor->Unicode;\r
+\r
+ if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_STANDARD_SHIFT) {\r
+ if (UsbKeyboardDevice->ShiftOn != 0) {\r
+ Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
+\r
+ //\r
+ // Need not return associated shift state if a class of printable characters that\r
+ // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'\r
+ //\r
+ if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) {\r
+ UsbKeyboardDevice->LeftShiftOn = 0;\r
+ UsbKeyboardDevice->RightShiftOn = 0;\r
+ }\r
+\r
+ if (UsbKeyboardDevice->AltGrOn != 0) {\r
+ Key->UnicodeChar = KeyDescriptor->ShiftedAltGrUnicode;\r
+ }\r
+ } else {\r
+ //\r
+ // Shift off\r
+ //\r
+ Key->UnicodeChar = KeyDescriptor->Unicode;\r
+\r
+ if (UsbKeyboardDevice->AltGrOn != 0) {\r
+ Key->UnicodeChar = KeyDescriptor->AltGrUnicode;\r
+ }\r
+ }\r
+ }\r
+\r
+ if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) {\r
+ if (UsbKeyboardDevice->CapsOn != 0) {\r
+\r
+ if (Key->UnicodeChar == KeyDescriptor->Unicode) {\r
+\r
+ Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
+\r
+ } else if (Key->UnicodeChar == KeyDescriptor->ShiftedUnicode) {\r
+\r
+ Key->UnicodeChar = KeyDescriptor->Unicode;\r
+\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Translate the CTRL-Alpha characters to their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
+ //\r
+ if (UsbKeyboardDevice->CtrlOn != 0) {\r
+ if (Key->UnicodeChar >= 'a' && Key->UnicodeChar <= 'z') {\r
+ Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'a' + 1);\r
+ } else if (Key->UnicodeChar >= 'A' && Key->UnicodeChar <= 'Z') {\r
+ Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'A' + 1);\r
+ }\r
+ }\r
+\r
+ if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_NUM_LOCK) {\r
+\r
+ if ((UsbKeyboardDevice->NumLockOn != 0) && (UsbKeyboardDevice->ShiftOn == 0)) {\r
+\r
+ Key->ScanCode = SCAN_NULL;\r
+\r
+ } else {\r
+ Key->UnicodeChar = 0x00;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Translate Unicode 0x1B (ESC) to EFI Scan Code\r
+ //\r
+ if (Key->UnicodeChar == 0x1B && Key->ScanCode == SCAN_NULL) {\r
+ Key->ScanCode = SCAN_ESC;\r
+ Key->UnicodeChar = 0x00;\r
+ }\r
+\r
+ if (Key->UnicodeChar == 0 && Key->ScanCode == SCAN_NULL) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+\r
+ //\r
+ // Save Shift/Toggle state\r
+ //\r
+ if (UsbKeyboardDevice->LeftCtrlOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_CONTROL_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->RightCtrlOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_CONTROL_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->LeftAltOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_ALT_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->RightAltOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_ALT_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->LeftShiftOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->RightShiftOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->LeftLogoOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->RightLogoOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->MenuKeyOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;\r
+ }\r
+ if (UsbKeyboardDevice->SysReqOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;\r
+ }\r
+\r
+ if (UsbKeyboardDevice->ScrollOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
+ }\r
+ if (UsbKeyboardDevice->NumLockOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
+ }\r
+ if (UsbKeyboardDevice->CapsOn == 1) {\r
+ UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+\r
+}\r
+\r
+\r
+/**\r
+ Resets USB Keyboard Buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+\r
+ @retval EFI_SUCCESS Init key buffer successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitUSBKeyBuffer (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer\r
+ )\r
+{\r
+ ZeroMem (KeyboardBuffer, sizeof (USB_KB_BUFFER));\r
+\r
+ KeyboardBuffer->bHead = KeyboardBuffer->bTail;\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Check whether USB Keyboard buffer is empty.\r
+\r
+ @param KeyboardBuffer USB Keyboard Buffer.\r
+\r
+ @retval TRUE Key buffer is empty.\r
+ @retval FALSE Key buffer is not empty.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboardBufferEmpty (\r
+ IN USB_KB_BUFFER *KeyboardBuffer\r
+ )\r
+{\r
+ //\r
+ // meet FIFO empty condition\r
+ //\r
+ return (BOOLEAN) (KeyboardBuffer->bHead == KeyboardBuffer->bTail);\r
+}\r
+\r
+\r
+/**\r
+ Check whether USB Keyboard buffer is full.\r
+\r
+ @param KeyboardBuffer USB Keyboard Buffer.\r
+\r
+ @retval TRUE Key buffer is full.\r
+ @retval FALSE Key buffer is not full.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboardBufferFull (\r
+ IN USB_KB_BUFFER *KeyboardBuffer\r
+ )\r
+{\r
+ return (BOOLEAN)(((KeyboardBuffer->bTail + 1) % (MAX_KEY_ALLOWED + 1)) ==\r
+ KeyboardBuffer->bHead);\r
+}\r
+\r
+\r
+/**\r
+ Inserts a key code into keyboard buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+ @param Key Key code\r
+ @param Down Special key\r
+\r
+ @retval EFI_SUCCESS Success\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InsertKeyCode (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
+ IN UINT8 Key,\r
+ IN UINT8 Down\r
+ )\r
+{\r
+ USB_KEY UsbKey;\r
+\r
+ //\r
+ // if keyboard buffer is full, throw the\r
+ // first key out of the keyboard buffer.\r
+ //\r
+ if (IsUSBKeyboardBufferFull (KeyboardBuffer)) {\r
+ RemoveKeyCode (KeyboardBuffer, &UsbKey);\r
+ }\r
+\r
+ KeyboardBuffer->buffer[KeyboardBuffer->bTail].KeyCode = Key;\r
+ KeyboardBuffer->buffer[KeyboardBuffer->bTail].Down = Down;\r
+\r
+ //\r
+ // adjust the tail pointer of the FIFO keyboard buffer.\r
+ //\r
+ KeyboardBuffer->bTail = (UINT8) ((KeyboardBuffer->bTail + 1) % (MAX_KEY_ALLOWED + 1));\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Pops a key code off from keyboard buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+ @param UsbKey Points to the buffer that contains a usb key code.\r
+\r
+ @retval EFI_SUCCESS Success\r
+ @retval EFI_DEVICE_ERROR Hardware Error\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RemoveKeyCode (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
+ OUT USB_KEY *UsbKey\r
+ )\r
+{\r
+ if (IsUSBKeyboardBufferEmpty (KeyboardBuffer)) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ UsbKey->KeyCode = KeyboardBuffer->buffer[KeyboardBuffer->bHead].KeyCode;\r
+ UsbKey->Down = KeyboardBuffer->buffer[KeyboardBuffer->bHead].Down;\r
+\r
+ //\r
+ // adjust the head pointer of the FIFO keyboard buffer.\r
+ //\r
+ KeyboardBuffer->bHead = (UINT8) ((KeyboardBuffer->bHead + 1) % (MAX_KEY_ALLOWED + 1));\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Sets USB Keyboard LED state.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Success\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SetKeyLED (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ )\r
+{\r
+ LED_MAP Led;\r
+ UINT8 ReportId;\r
+\r
+ //\r
+ // Set each field in Led map.\r
+ //\r
+ Led.NumLock = (UINT8) UsbKeyboardDevice->NumLockOn;\r
+ Led.CapsLock = (UINT8) UsbKeyboardDevice->CapsOn;\r
+ Led.ScrollLock = (UINT8) UsbKeyboardDevice->ScrollOn;\r
+ Led.Resrvd = 0;\r
+\r
+ ReportId = 0;\r
+ //\r
+ // call Set Report Request to lighten the LED.\r
+ //\r
+ UsbSetReportRequest (\r
+ UsbKeyboardDevice->UsbIo,\r
+ UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
+ ReportId,\r
+ HID_OUTPUT_REPORT,\r
+ 1,\r
+ (UINT8 *) &Led\r
+ );\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+ Timer handler for Repeat Key timer.\r
+\r
+ @param Event The Repeat Key event.\r
+ @param Context Points to the USB_KB_DEV instance.\r
+\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardRepeatHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+\r
+ UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
+\r
+ //\r
+ // Do nothing when there is no repeat key.\r
+ //\r
+ if (UsbKeyboardDevice->RepeatKey != 0) {\r
+ //\r
+ // Inserts one Repeat key into keyboard buffer,\r
+ //\r
+ InsertKeyCode (\r
+ &(UsbKeyboardDevice->KeyboardBuffer),\r
+ UsbKeyboardDevice->RepeatKey,\r
+ 1\r
+ );\r
+\r
+ //\r
+ // set repeate rate for repeat key generation.\r
+ //\r
+ gBS->SetTimer (\r
+ UsbKeyboardDevice->RepeatTimer,\r
+ TimerRelative,\r
+ USBKBD_REPEAT_RATE\r
+ );\r
+\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Timer handler for Delayed Recovery timer.\r
+\r
+ @param Event The Delayed Recovery event.\r
+ @param Context Points to the USB_KB_DEV instance.\r
+\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardRecoveryHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+\r
+ USB_KB_DEV *UsbKeyboardDevice;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ UINT8 PacketSize;\r
+\r
+ UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
+\r
+ UsbIo = UsbKeyboardDevice->UsbIo;\r
+\r
+ PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
+\r
+ UsbIo->UsbAsyncInterruptTransfer (\r
+ UsbIo,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
+ TRUE,\r
+ UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
+ PacketSize,\r
+ KeyboardHandler,\r
+ UsbKeyboardDevice\r
+ );\r
+}\r
--- /dev/null
+/** @file\r
+\r
+ Function prototype for USB Keyboard Driver.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef _EFI_KEYBOARD_H_\r
+#define _EFI_KEYBOARD_H_\r
+\r
+\r
+#include "EfiKey.h"\r
+\r
+/**\r
+ Uses USB I/O to check whether the device is a USB Keyboard device.\r
+\r
+ @param UsbIo Points to a USB I/O protocol instance.\r
+ @retval None\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboard (\r
+ IN EFI_USB_IO_PROTOCOL *UsbIo\r
+ );\r
+\r
+/**\r
+ Initialize USB Keyboard device and all private data structures.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Initialization is successful.\r
+ @retval EFI_DEVICE_ERROR Configure hardware failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitUSBKeyboard (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ );\r
+\r
+/**\r
+ Initialize USB Keyboard layout.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Initialization Success.\r
+ @retval Other Keyboard layout initial failed.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitKeyboardLayout (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ );\r
+\r
+/**\r
+ Destroy resources for Keyboard layout.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ReleaseKeyboardLayoutResources (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ );\r
+\r
+/**\r
+ Handler function for USB Keyboard's asynchronous interrupt transfer.\r
+\r
+ @param Data A pointer to a buffer that is filled with key data which is\r
+ retrieved via asynchronous interrupt transfer.\r
+ @param DataLength Indicates the size of the data buffer.\r
+ @param Context Pointing to USB_KB_DEV instance.\r
+ @param Result Indicates the result of the asynchronous interrupt transfer.\r
+\r
+ @retval EFI_SUCCESS Handler is successful.\r
+ @retval EFI_DEVICE_ERROR Hardware Error\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+KeyboardHandler (\r
+ IN VOID *Data,\r
+ IN UINTN DataLength,\r
+ IN VOID *Context,\r
+ IN UINT32 Result\r
+ );\r
+\r
+/**\r
+ Timer handler for Delayed Recovery timer.\r
+\r
+ @param Event The Delayed Recovery event.\r
+ @param Context Points to the USB_KB_DEV instance.\r
+\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardRecoveryHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ );\r
+\r
+/**\r
+ Retrieves a key character after parsing the raw data in keyboard buffer.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param KeyChar Points to the Key character after key parsing.\r
+\r
+ @retval EFI_SUCCESS Parse key is successful.\r
+ @retval EFI_NOT_READY Device is not ready.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBParseKey (\r
+ IN OUT USB_KB_DEV *UsbKeyboardDevice,\r
+ OUT UINT8 *KeyChar\r
+ );\r
+\r
+/**\r
+ Converts USB Keyboard code to EFI Scan Code.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+ @param KeyChar Indicates the key code that will be interpreted.\r
+ @param Key A pointer to a buffer that is filled in with\r
+ the keystroke information for the key that\r
+ was pressed.\r
+\r
+ @retval EFI_NOT_READY Device is not ready\r
+ @retval EFI_SUCCESS Success.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+USBKeyCodeToEFIScanCode (\r
+ IN USB_KB_DEV *UsbKeyboardDevice,\r
+ IN UINT8 KeyChar,\r
+ OUT EFI_INPUT_KEY *Key\r
+ );\r
+\r
+/**\r
+ Resets USB Keyboard Buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+\r
+ @retval EFI_SUCCESS Init key buffer successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitUSBKeyBuffer (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer\r
+ );\r
+\r
+/**\r
+ Check whether USB Keyboard buffer is empty.\r
+\r
+ @param KeyboardBuffer USB Keyboard Buffer.\r
+\r
+ @retval TRUE Key buffer is empty.\r
+ @retval FALSE Key buffer is not empty.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboardBufferEmpty (\r
+ IN USB_KB_BUFFER *KeyboardBuffer\r
+ );\r
+\r
+/**\r
+ Check whether USB Keyboard buffer is full.\r
+\r
+ @param KeyboardBuffer USB Keyboard Buffer.\r
+\r
+ @retval TRUE Key buffer is full.\r
+ @retval FALSE Key buffer is not full.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsUSBKeyboardBufferFull (\r
+ IN USB_KB_BUFFER *KeyboardBuffer\r
+ );\r
+\r
+/**\r
+ Inserts a key code into keyboard buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+ @param Key Key code\r
+ @param Down Special key\r
+\r
+ @retval EFI_SUCCESS Success\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InsertKeyCode (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
+ IN UINT8 Key,\r
+ IN UINT8 Down\r
+ );\r
+\r
+/**\r
+ Pops a key code off from keyboard buffer.\r
+\r
+ @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
+ @param UsbKey Points to the buffer that contains a usb key code.\r
+\r
+ @retval EFI_SUCCESS Success\r
+ @retval EFI_DEVICE_ERROR Hardware Error\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RemoveKeyCode (\r
+ IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
+ OUT USB_KEY *UsbKey\r
+ );\r
+\r
+/**\r
+ Timer handler for Repeat Key timer.\r
+\r
+ @param Event The Repeat Key event.\r
+ @param Context Points to the USB_KB_DEV instance.\r
+\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+USBKeyboardRepeatHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ );\r
+\r
+/**\r
+ Sets USB Keyboard LED state.\r
+\r
+ @param UsbKeyboardDevice The USB_KB_DEV instance.\r
+\r
+ @retval EFI_SUCCESS Success\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SetKeyLED (\r
+ IN USB_KB_DEV *UsbKeyboardDevice\r
+ );\r
+\r
+#endif\r
#\r
\r
[Sources.common]\r
- efikey.c\r
- efikey.h\r
- keyboard.c\r
+ EfiKey.c\r
+ EfiKey.h\r
+ KeyBoard.c\r
ComponentName.c\r
- keyboard.h\r
+ KeyBoard.h\r
\r
[Packages]\r
MdePkg/MdePkg.dec\r
+++ /dev/null
-/** @file\r
-\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- EfiKey.c\r
-\r
-Abstract:\r
-\r
- USB Keyboard Driver\r
-\r
-Revision History\r
-\r
-\r
-**/\r
-\r
-#include "efikey.h"\r
-#include "keyboard.h"\r
-\r
-//\r
-// Prototypes\r
-// Driver model protocol interface\r
-//\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingEntryPoint (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
- );\r
-\r
-//\r
-// Simple Text In Protocol Interface\r
-//\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReset (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReadKeyStroke (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- OUT EFI_INPUT_KEY *Key\r
- );\r
-\r
-STATIC\r
-VOID\r
-EFIAPI\r
-USBKeyboardWaitForKey (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- );\r
-\r
-//\r
-// Helper functions\r
-//\r
-STATIC\r
-EFI_STATUS\r
-USBKeyboardCheckForKey (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- );\r
-\r
-EFI_GUID gEfiUsbKeyboardDriverGuid = {\r
- 0xa05f5f78, 0xfb3, 0x4d10, {0x90, 0x90, 0xac, 0x4, 0x6e, 0xeb, 0x7c, 0x3c}\r
-};\r
-STATIC\r
-EFI_STATUS\r
-KbdFreeNotifyList (\r
- IN OUT LIST_ENTRY *ListHead\r
- ); \r
-STATIC\r
-BOOLEAN\r
-IsKeyRegistered (\r
- IN EFI_KEY_DATA *RegsiteredData,\r
- IN EFI_KEY_DATA *InputData\r
- );\r
-\r
-\r
-//\r
-// USB Keyboard Driver Global Variables\r
-//\r
-EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding = {\r
- USBKeyboardDriverBindingSupported,\r
- USBKeyboardDriverBindingStart,\r
- USBKeyboardDriverBindingStop,\r
- 0xa,\r
- NULL,\r
- NULL\r
-};\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingEntryPoint (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Driver Entry Point.\r
-\r
- Arguments:\r
- ImageHandle - EFI_HANDLE\r
- SystemTable - EFI_SYSTEM_TABLE\r
- Returns:\r
- EFI_STATUS\r
-\r
---*/\r
-{\r
- return EfiLibInstallDriverBindingComponentName2 (\r
- ImageHandle,\r
- SystemTable,\r
- &gUsbKeyboardDriverBinding,\r
- ImageHandle,\r
- &gUsbKeyboardComponentName,\r
- &gUsbKeyboardComponentName2\r
- );\r
-}\r
-\r
-\r
-\r
-/**\r
- Supported.\r
-\r
- @param This EFI_DRIVER_BINDING_PROTOCOL\r
- @param Controller Controller handle\r
- @param RemainingDevicePath EFI_DEVICE_PATH_PROTOCOL\r
- EFI_STATUS\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-{\r
- EFI_STATUS OpenStatus;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Check if USB_IO protocol is attached on the controller handle.\r
- //\r
- OpenStatus = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- (VOID **) &UsbIo,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (OpenStatus)) {\r
- return OpenStatus;\r
- }\r
-\r
- //\r
- // Use the USB I/O protocol interface to check whether the Controller is\r
- // the Keyboard controller that can be managed by this driver.\r
- //\r
- Status = EFI_SUCCESS;\r
-\r
- if (!IsUSBKeyboard (UsbIo)) {\r
- Status = EFI_UNSUPPORTED;\r
- }\r
-\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
-\r
- return Status;\r
-}\r
-\r
-\r
-/**\r
- Start.\r
-\r
- @param This EFI_DRIVER_BINDING_PROTOCOL\r
- @param Controller Controller handle\r
- @param RemainingDevicePath EFI_DEVICE_PATH_PROTOCOL\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_OUT_OF_RESOURCES Can't allocate memory\r
- @retval EFI_UNSUPPORTED The Start routine fail\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- UINT8 EndpointNumber;\r
- EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
- UINT8 Index;\r
- UINT8 EndpointAddr;\r
- UINT8 PollingInterval;\r
- UINT8 PacketSize;\r
- BOOLEAN Found;\r
-\r
- UsbKeyboardDevice = NULL;\r
- Found = FALSE;\r
-\r
- //\r
- // Open USB_IO Protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- (VOID **) &UsbIo,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- UsbKeyboardDevice = AllocateZeroPool (sizeof (USB_KB_DEV));\r
- if (UsbKeyboardDevice == NULL) {\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- //\r
- // Get the Device Path Protocol on Controller's handle\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiDevicePathProtocolGuid,\r
- (VOID **) &UsbKeyboardDevice->DevicePath,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
- }\r
- //\r
- // Report that the usb keyboard is being enabled\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardEnable)\r
- );\r
-\r
- //\r
- // This is pretty close to keyboard detection, so log progress\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardPresenceDetect)\r
- );\r
-\r
- //\r
- // Initialize UsbKeyboardDevice\r
- //\r
- UsbKeyboardDevice->UsbIo = UsbIo;\r
-\r
- //\r
- // Get interface & endpoint descriptor\r
- //\r
- UsbIo->UsbGetInterfaceDescriptor (\r
- UsbIo,\r
- &UsbKeyboardDevice->InterfaceDescriptor\r
- );\r
-\r
- EndpointNumber = UsbKeyboardDevice->InterfaceDescriptor.NumEndpoints;\r
-\r
- for (Index = 0; Index < EndpointNumber; Index++) {\r
-\r
- UsbIo->UsbGetEndpointDescriptor (\r
- UsbIo,\r
- Index,\r
- &EndpointDescriptor\r
- );\r
-\r
- if ((EndpointDescriptor.Attributes & 0x03) == 0x03) {\r
- //\r
- // We only care interrupt endpoint here\r
- //\r
- CopyMem(&UsbKeyboardDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));\r
- Found = TRUE;\r
- }\r
- }\r
-\r
- if (!Found) {\r
- //\r
- // No interrupt endpoint found, then return unsupported.\r
- //\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- UsbKeyboardDevice->Signature = USB_KB_DEV_SIGNATURE;\r
- UsbKeyboardDevice->SimpleInput.Reset = USBKeyboardReset;\r
- UsbKeyboardDevice->SimpleInput.ReadKeyStroke = USBKeyboardReadKeyStroke;\r
-\r
- UsbKeyboardDevice->SimpleInputEx.Reset = USBKeyboardResetEx;\r
- UsbKeyboardDevice->SimpleInputEx.ReadKeyStrokeEx = USBKeyboardReadKeyStrokeEx;\r
- UsbKeyboardDevice->SimpleInputEx.SetState = USBKeyboardSetState;\r
- UsbKeyboardDevice->SimpleInputEx.RegisterKeyNotify = USBKeyboardRegisterKeyNotify;\r
- UsbKeyboardDevice->SimpleInputEx.UnregisterKeyNotify = USBKeyboardUnregisterKeyNotify; \r
- \r
- InitializeListHead (&UsbKeyboardDevice->NotifyList);\r
- \r
- Status = gBS->CreateEvent (\r
- EVT_NOTIFY_WAIT,\r
- TPL_NOTIFY,\r
- USBKeyboardWaitForKey,\r
- UsbKeyboardDevice,\r
- &(UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx)\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- goto ErrorExit;\r
- }\r
-\r
- Status = InitKeyboardLayout (UsbKeyboardDevice);\r
- if (EFI_ERROR (Status)) {\r
- goto ErrorExit;\r
- }\r
-\r
- Status = gBS->CreateEvent (\r
- EVT_NOTIFY_WAIT,\r
- TPL_NOTIFY,\r
- USBKeyboardWaitForKey,\r
- UsbKeyboardDevice,\r
- &(UsbKeyboardDevice->SimpleInput.WaitForKey)\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
- }\r
-\r
- //\r
- // Install simple txt in protocol interface\r
- // for the usb keyboard device.\r
- // Usb keyboard is a hot plug device, and expected to work immediately\r
- // when plugging into system, so a HotPlugDeviceGuid is installed onto\r
- // the usb keyboard device handle, to distinguish it from other conventional\r
- // console devices.\r
- //\r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInput,\r
- &gEfiSimpleTextInputExProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInputEx,\r
- &gEfiHotPlugDeviceGuid,\r
- NULL,\r
- NULL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
- }\r
-\r
- //\r
- // Reset USB Keyboard Device\r
- //\r
- Status = UsbKeyboardDevice->SimpleInput.Reset (\r
- &UsbKeyboardDevice->SimpleInput,\r
- TRUE\r
- );\r
- if (EFI_ERROR (Status)) {\r
- gBS->UninstallMultipleProtocolInterfaces (\r
- Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInput,\r
- &gEfiSimpleTextInputExProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInputEx,\r
- &gEfiHotPlugDeviceGuid,\r
- NULL,\r
- NULL\r
- );\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
- }\r
- //\r
- // submit async interrupt transfer\r
- //\r
- EndpointAddr = UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress;\r
- PollingInterval = UsbKeyboardDevice->IntEndpointDescriptor.Interval;\r
- PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
-\r
- Status = UsbIo->UsbAsyncInterruptTransfer (\r
- UsbIo,\r
- EndpointAddr,\r
- TRUE,\r
- PollingInterval,\r
- PacketSize,\r
- KeyboardHandler,\r
- UsbKeyboardDevice\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
-\r
- gBS->UninstallMultipleProtocolInterfaces (\r
- Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInput,\r
- &gEfiSimpleTextInputExProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInputEx,\r
- &gEfiHotPlugDeviceGuid,\r
- NULL,\r
- NULL\r
- );\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
- gBS->FreePool (UsbKeyboardDevice);\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
- }\r
-\r
- UsbKeyboardDevice->ControllerNameTable = NULL;\r
- AddUnicodeString2 (\r
- "eng",\r
- gUsbKeyboardComponentName.SupportedLanguages,\r
- &UsbKeyboardDevice->ControllerNameTable,\r
- L"Generic Usb Keyboard",\r
- TRUE\r
- );\r
- AddUnicodeString2 (\r
- "en",\r
- gUsbKeyboardComponentName2.SupportedLanguages,\r
- &UsbKeyboardDevice->ControllerNameTable,\r
- L"Generic Usb Keyboard",\r
- FALSE\r
- );\r
-\r
-\r
- return EFI_SUCCESS;\r
-\r
-ErrorExit:\r
- if (UsbKeyboardDevice != NULL) {\r
- if (UsbKeyboardDevice->SimpleInput.WaitForKey != NULL) {\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInput.WaitForKey);\r
- }\r
- if (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx != NULL) {\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx);\r
- }\r
- KbdFreeNotifyList (&UsbKeyboardDevice->NotifyList); \r
- gBS->FreePool (UsbKeyboardDevice);\r
- UsbKeyboardDevice = NULL;\r
- }\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- return Status;\r
-\r
-}\r
-\r
-\r
-\r
-/**\r
- Stop.\r
-\r
- @param This EFI_DRIVER_BINDING_PROTOCOL\r
- @param Controller Controller handle\r
- @param NumberOfChildren Child handle number\r
- @param ChildHandleBuffer Child handle buffer\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_UNSUPPORTED Can't support\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardDriverBindingStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleInput;\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- (VOID **) &SimpleInput,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiSimpleTextInputExProtocolGuid,\r
- NULL,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
- //\r
- // Get USB_KB_DEV instance.\r
- //\r
- UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (SimpleInput);\r
-\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
-\r
- //\r
- // Uninstall the Asyn Interrupt Transfer from this device\r
- // will disable the key data input from this device\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardDisable)\r
- );\r
-\r
- //\r
- // Destroy asynchronous interrupt transfer\r
- //\r
- UsbKeyboardDevice->UsbIo->UsbAsyncInterruptTransfer (\r
- UsbKeyboardDevice->UsbIo,\r
- UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
- FALSE,\r
- UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
- 0,\r
- NULL,\r
- NULL\r
- );\r
-\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
-\r
- Status = gBS->UninstallMultipleProtocolInterfaces (\r
- Controller,\r
- &gEfiSimpleTextInProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInput,\r
- &gEfiSimpleTextInputExProtocolGuid,\r
- &UsbKeyboardDevice->SimpleInputEx,\r
- &gEfiHotPlugDeviceGuid,\r
- NULL,\r
- NULL\r
- );\r
- //\r
- // free all the resources.\r
- //\r
- gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
- gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
- gBS->CloseEvent ((UsbKeyboardDevice->SimpleInput).WaitForKey);\r
- gBS->CloseEvent (UsbKeyboardDevice->SimpleInputEx.WaitForKeyEx); \r
- KbdFreeNotifyList (&UsbKeyboardDevice->NotifyList); \r
-\r
- ReleaseKeyboardLayoutResources (UsbKeyboardDevice);\r
- gBS->CloseEvent (UsbKeyboardDevice->KeyboardLayoutEvent);\r
-\r
- if (UsbKeyboardDevice->ControllerNameTable != NULL) {\r
- FreeUnicodeStringTable (UsbKeyboardDevice->ControllerNameTable);\r
- }\r
-\r
- gBS->FreePool (UsbKeyboardDevice);\r
-\r
- return Status;\r
-\r
-}\r
-\r
-STATIC\r
-EFI_STATUS\r
-USBKeyboardReadKeyStrokeWorker (\r
- IN USB_KB_DEV *UsbKeyboardDevice,\r
- OUT EFI_KEY_DATA *KeyData\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- UsbKeyboardDevice - Usb keyboard private structure.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
-\r
---*/\r
-{\r
-\r
- EFI_STATUS Status;\r
- UINT8 KeyChar; \r
- LIST_ENTRY *Link;\r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; \r
- EFI_KEY_DATA OriginalKeyData;\r
-\r
- if (KeyData == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- //\r
- // if there is no saved ASCII byte, fetch it\r
- // by calling USBKeyboardCheckForKey().\r
- //\r
- if (UsbKeyboardDevice->CurKeyChar == 0) {\r
- Status = USBKeyboardCheckForKey (UsbKeyboardDevice);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- }\r
-\r
- KeyData->Key.UnicodeChar = 0;\r
- KeyData->Key.ScanCode = SCAN_NULL;\r
-\r
- KeyChar = UsbKeyboardDevice->CurKeyChar;\r
-\r
- UsbKeyboardDevice->CurKeyChar = 0;\r
-\r
- //\r
- // Translate saved ASCII byte into EFI_INPUT_KEY\r
- //\r
- Status = USBKeyCodeToEFIScanCode (UsbKeyboardDevice, KeyChar, &KeyData->Key);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- CopyMem (&KeyData->KeyState, &UsbKeyboardDevice->KeyState, sizeof (KeyData->KeyState));\r
- \r
- UsbKeyboardDevice->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;\r
- UsbKeyboardDevice->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
-\r
- //\r
- //Switch the control value to their original characters. In USBKeyCodeToEFIScanCode() the CTRL-Alpha characters have been switched to \r
- // their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A), here switch them back for notification function.\r
- //\r
- CopyMem (&OriginalKeyData, KeyData, sizeof (EFI_KEY_DATA));\r
- if (UsbKeyboardDevice->CtrlOn) {\r
- if (OriginalKeyData.Key.UnicodeChar >= 0x01 && OriginalKeyData.Key.UnicodeChar <= 0x1A) {\r
- if (UsbKeyboardDevice->CapsOn) {\r
- OriginalKeyData.Key.UnicodeChar = (CHAR16)(OriginalKeyData.Key.UnicodeChar + 'A' - 1);\r
- } else {\r
- OriginalKeyData.Key.UnicodeChar = (CHAR16)(OriginalKeyData.Key.UnicodeChar + 'a' - 1);\r
- } \r
- }\r
- }\r
- \r
- //\r
- // Invoke notification functions if exist\r
- //\r
- for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
- CurrentNotify = CR (\r
- Link, \r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
- NotifyEntry, \r
- USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
- );\r
- if (IsKeyRegistered (&CurrentNotify->KeyData, &OriginalKeyData)) { \r
- CurrentNotify->KeyNotificationFn (&OriginalKeyData);\r
- }\r
- }\r
-\r
- return EFI_SUCCESS;\r
- \r
-}\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReset (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
- )\r
-{\r
- EFI_STATUS Status;\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
-\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardReset)\r
- );\r
-\r
- //\r
- // Non Exhaustive reset:\r
- // only reset private data structures.\r
- //\r
- if (!ExtendedVerification) {\r
- //\r
- // Clear the key buffer of this Usb keyboard\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardClearBuffer)\r
- );\r
-\r
- InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
- UsbKeyboardDevice->CurKeyChar = 0;\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Exhaustive reset\r
- //\r
- Status = InitUSBKeyboard (UsbKeyboardDevice);\r
- UsbKeyboardDevice->CurKeyChar = 0;\r
- if (EFI_ERROR (Status)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke() function.\r
-\r
- This The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.\r
- Key A pointer to a buffer that is filled in with the keystroke\r
- information for the key that was pressed.\r
-\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReadKeyStroke (\r
- IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
- OUT EFI_INPUT_KEY *Key\r
- )\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_STATUS Status;\r
- EFI_KEY_DATA KeyData;\r
-\r
- UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This);\r
-\r
- Status = USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, &KeyData);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY));\r
-\r
- return EFI_SUCCESS;\r
-\r
-}\r
-\r
-\r
-/**\r
- Handler function for WaitForKey event.\r
-\r
- Event Event to be signaled when a key is pressed.\r
- Context Points to USB_KB_DEV instance.\r
-\r
- @return VOID\r
-\r
-**/\r
-STATIC\r
-VOID\r
-EFIAPI\r
-USBKeyboardWaitForKey (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
-\r
- if (UsbKeyboardDevice->CurKeyChar == 0) {\r
-\r
- if (EFI_ERROR (USBKeyboardCheckForKey (UsbKeyboardDevice))) {\r
- return ;\r
- }\r
- }\r
- //\r
- // If has key pending, signal the event.\r
- //\r
- gBS->SignalEvent (Event);\r
-}\r
-\r
-\r
-\r
-/**\r
- Check whether there is key pending.\r
-\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
-\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-STATIC\r
-EFI_STATUS\r
-USBKeyboardCheckForKey (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINT8 KeyChar;\r
-\r
- //\r
- // Fetch raw data from the USB keyboard input,\r
- // and translate it into ASCII data.\r
- //\r
- Status = USBParseKey (UsbKeyboardDevice, &KeyChar);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- UsbKeyboardDevice->CurKeyChar = KeyChar;\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Report Status Code in Usb Bot Driver\r
-\r
- @param DevicePath Use this to get Device Path\r
- @param CodeType Status Code Type\r
- @param CodeValue Status Code Value\r
-\r
- @return None\r
-\r
-**/\r
-VOID\r
-KbdReportStatusCode (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value\r
- )\r
-{\r
-\r
- REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
- CodeType,\r
- Value,\r
- DevicePath\r
- );\r
-}\r
-STATIC\r
-EFI_STATUS\r
-KbdFreeNotifyList (\r
- IN OUT LIST_ENTRY *ListHead\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- ListHead - The list head\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Free the notify list successfully\r
- EFI_INVALID_PARAMETER - ListHead is invalid.\r
-\r
---*/\r
-{\r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY *NotifyNode;\r
-\r
- if (ListHead == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
- while (!IsListEmpty (ListHead)) {\r
- NotifyNode = CR (\r
- ListHead->ForwardLink, \r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
- NotifyEntry, \r
- USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
- );\r
- RemoveEntryList (ListHead->ForwardLink);\r
- gBS->FreePool (NotifyNode);\r
- }\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-STATIC\r
-BOOLEAN\r
-IsKeyRegistered (\r
- IN EFI_KEY_DATA *RegsiteredData,\r
- IN EFI_KEY_DATA *InputData\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was registered.\r
- InputData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
-\r
-Returns:\r
- TRUE - Key be pressed matches a registered key.\r
- FLASE - Match failed. \r
- \r
---*/\r
-{\r
- ASSERT (RegsiteredData != NULL && InputData != NULL);\r
- \r
- if ((RegsiteredData->Key.ScanCode != InputData->Key.ScanCode) ||\r
- (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) {\r
- return FALSE; \r
- } \r
- \r
- //\r
- // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored.\r
- //\r
- if (RegsiteredData->KeyState.KeyShiftState != 0 &&\r
- RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) {\r
- return FALSE; \r
- } \r
- if (RegsiteredData->KeyState.KeyToggleState != 0 &&\r
- RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) {\r
- return FALSE; \r
- } \r
- \r
- return TRUE;\r
-\r
-}\r
-\r
-//\r
-// Simple Text Input Ex protocol functions \r
-//\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardResetEx (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could \r
- not be reset.\r
-\r
---*/\r
-{\r
- EFI_STATUS Status;\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_TPL OldTpl;\r
- \r
-\r
- UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
-\r
- Status = UsbKeyboardDevice->SimpleInput.Reset (&UsbKeyboardDevice->SimpleInput, ExtendedVerification);\r
- if (EFI_ERROR (Status)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
- UsbKeyboardDevice->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID;\r
- UsbKeyboardDevice->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
- gBS->RestoreTPL (OldTpl);\r
-\r
- return EFI_SUCCESS;\r
-\r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReadKeyStrokeEx (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- OUT EFI_KEY_DATA *KeyData\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
-\r
---*/\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- if (KeyData == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
-\r
- return USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, KeyData);\r
- \r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardSetState (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
- state for the input device.\r
- \r
- Returns: \r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
-\r
---*/ \r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- if (KeyToggleState == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
-\r
- if (((UsbKeyboardDevice->KeyState.KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) ||\r
- ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- //\r
- // Update the status light\r
- //\r
-\r
- UsbKeyboardDevice->ScrollOn = 0;\r
- UsbKeyboardDevice->NumLockOn = 0;\r
- UsbKeyboardDevice->CapsOn = 0;\r
- \r
- if ((*KeyToggleState & EFI_SCROLL_LOCK_ACTIVE) == EFI_SCROLL_LOCK_ACTIVE) {\r
- UsbKeyboardDevice->ScrollOn = 1;\r
- }\r
- if ((*KeyToggleState & EFI_NUM_LOCK_ACTIVE) == EFI_NUM_LOCK_ACTIVE) {\r
- UsbKeyboardDevice->NumLockOn = 1;\r
- }\r
- if ((*KeyToggleState & EFI_CAPS_LOCK_ACTIVE) == EFI_CAPS_LOCK_ACTIVE) {\r
- UsbKeyboardDevice->CapsOn = 1;\r
- }\r
-\r
- SetKeyLED (UsbKeyboardDevice);\r
-\r
- UsbKeyboardDevice->KeyState.KeyToggleState = *KeyToggleState;\r
-\r
- return EFI_SUCCESS;\r
- \r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardRegisterKeyNotify (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_KEY_DATA *KeyData,\r
- IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
- OUT EFI_HANDLE *NotifyHandle\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key \r
- sequence is typed specified by KeyData. \r
- NotifyHandle - Points to the unique handle assigned to the registered notification. \r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
- \r
---*/ \r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_STATUS Status;\r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY *NewNotify;\r
- LIST_ENTRY *Link;\r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; \r
-\r
- if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
-\r
- //\r
- // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.\r
- //\r
- for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
- CurrentNotify = CR (\r
- Link, \r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
- NotifyEntry, \r
- USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
- );\r
- if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { \r
- if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
- *NotifyHandle = CurrentNotify->NotifyHandle; \r
- return EFI_SUCCESS;\r
- }\r
- }\r
- }\r
- \r
- //\r
- // Allocate resource to save the notification function\r
- // \r
- NewNotify = (KEYBOARD_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_EX_NOTIFY));\r
- if (NewNotify == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- NewNotify->Signature = USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE; \r
- NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
- CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));\r
- InsertTailList (&UsbKeyboardDevice->NotifyList, &NewNotify->NotifyEntry);\r
-\r
- //\r
- // Use gSimpleTextInExNotifyGuid to get a valid EFI_HANDLE\r
- // \r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &NewNotify->NotifyHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- *NotifyHandle = NewNotify->NotifyHandle; \r
- \r
- return EFI_SUCCESS;\r
- \r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardUnregisterKeyNotify (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_HANDLE NotificationHandle\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer. \r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database. \r
- \r
---*/ \r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_STATUS Status;\r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
- LIST_ENTRY *Link;\r
-\r
- if (NotificationHandle == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- } \r
- \r
- UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This);\r
- \r
- Status = gBS->OpenProtocol (\r
- NotificationHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL,\r
- NULL,\r
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- for (Link = UsbKeyboardDevice->NotifyList.ForwardLink; Link != &UsbKeyboardDevice->NotifyList; Link = Link->ForwardLink) {\r
- CurrentNotify = CR (\r
- Link, \r
- KEYBOARD_CONSOLE_IN_EX_NOTIFY, \r
- NotifyEntry, \r
- USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
- ); \r
- if (CurrentNotify->NotifyHandle == NotificationHandle) {\r
- //\r
- // Remove the notification function from NotifyList and free resources\r
- //\r
- RemoveEntryList (&CurrentNotify->NotifyEntry); \r
- Status = gBS->UninstallMultipleProtocolInterfaces (\r
- CurrentNotify->NotifyHandle,\r
- &gSimpleTextInExNotifyGuid,\r
- NULL,\r
- NULL\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
- gBS->FreePool (CurrentNotify); \r
- return EFI_SUCCESS;\r
- }\r
- }\r
-\r
- return EFI_NOT_FOUND; \r
-}\r
-\r
+++ /dev/null
-/** @file\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- EfiKey.h\r
-\r
-Abstract:\r
-\r
- Header file for USB Keyboard Driver's Data Structures\r
-\r
-Revision History\r
-\r
-**/\r
-#ifndef _USB_KB_H\r
-#define _USB_KB_H\r
-\r
-\r
-#include <PiDxe.h>\r
-\r
-#include <Protocol/SimpleTextIn.h>\r
-#include <Protocol/SimpleTextInEx.h>\r
-#include <Protocol/HiiDatabase.h>\r
-#include <Protocol/UsbIo.h>\r
-#include <Protocol/DevicePath.h>\r
-#include <Guid/HiiKeyBoardLayout.h>\r
-#include <Guid/HotPlugDevice.h>\r
-\r
-#include <Library/DebugLib.h>\r
-#include <Library/ReportStatusCodeLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/UefiRuntimeServicesTableLib.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/UefiLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/PcdLib.h>\r
-#include <Library/UsbLib.h>\r
-#include <Library/BaseLib.h>\r
-\r
-#include <IndustryStandard/Usb.h>\r
-\r
-#define MAX_KEY_ALLOWED 32\r
-\r
-#define HZ 1000 * 1000 * 10\r
-#define USBKBD_REPEAT_DELAY ((HZ) / 2)\r
-#define USBKBD_REPEAT_RATE ((HZ) / 50)\r
-\r
-#define CLASS_HID 3\r
-#define SUBCLASS_BOOT 1\r
-#define PROTOCOL_KEYBOARD 1\r
-\r
-#define BOOT_PROTOCOL 0\r
-#define REPORT_PROTOCOL 1\r
-\r
-typedef struct {\r
- UINT8 Down;\r
- UINT8 KeyCode;\r
-} USB_KEY;\r
-\r
-typedef struct {\r
- USB_KEY buffer[MAX_KEY_ALLOWED + 1];\r
- UINT8 bHead;\r
- UINT8 bTail;\r
-} USB_KB_BUFFER;\r
-\r
-#define USB_KB_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'k', 'b', 'd')\r
-#define USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE EFI_SIGNATURE_32 ('u', 'k', 'b', 'x')\r
-\r
-typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {\r
- UINTN Signature;\r
- EFI_HANDLE NotifyHandle;\r
- EFI_KEY_DATA KeyData;\r
- EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r
- LIST_ENTRY NotifyEntry;\r
-} KEYBOARD_CONSOLE_IN_EX_NOTIFY;\r
-\r
-#define USB_NS_KEY_SIGNATURE EFI_SIGNATURE_32 ('u', 'n', 's', 'k')\r
-\r
-typedef struct {\r
- UINTN Signature;\r
- LIST_ENTRY Link;\r
-\r
- //\r
- // The number of EFI_NS_KEY_MODIFIER children definitions\r
- //\r
- UINTN KeyCount;\r
-\r
- //\r
- // NsKey[0] : Non-spacing key\r
- // NsKey[1] ~ NsKey[KeyCount] : Physical keys\r
- //\r
- EFI_KEY_DESCRIPTOR *NsKey;\r
-} USB_NS_KEY;\r
-\r
-#define USB_NS_KEY_FORM_FROM_LINK(a) CR (a, USB_NS_KEY, Link, USB_NS_KEY_SIGNATURE)\r
-\r
-typedef struct {\r
- UINTN Signature;\r
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
- EFI_EVENT DelayedRecoveryEvent;\r
- EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput;\r
- EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL SimpleInputEx;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
-\r
- EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
- EFI_USB_ENDPOINT_DESCRIPTOR IntEndpointDescriptor;\r
-\r
- USB_KB_BUFFER KeyboardBuffer;\r
- UINT8 CtrlOn;\r
- UINT8 AltOn;\r
- UINT8 ShiftOn;\r
- UINT8 NumLockOn;\r
- UINT8 CapsOn;\r
- UINT8 ScrollOn;\r
- UINT8 LastKeyCodeArray[8];\r
- UINT8 CurKeyChar;\r
-\r
- UINT8 RepeatKey;\r
- EFI_EVENT RepeatTimer;\r
-\r
- EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
- \r
- UINT8 LeftCtrlOn;\r
- UINT8 LeftAltOn;\r
- UINT8 LeftShiftOn;\r
- UINT8 LeftLogoOn;\r
- UINT8 RightCtrlOn;\r
- UINT8 RightAltOn;\r
- UINT8 RightShiftOn;\r
- UINT8 RightLogoOn; \r
- UINT8 MenuKeyOn;\r
- UINT8 SysReqOn;\r
- UINT8 AltGrOn;\r
-\r
- EFI_KEY_STATE KeyState;\r
- //\r
- // Notification function list\r
- //\r
- LIST_ENTRY NotifyList;\r
-\r
- //\r
- // Non-spacing key list\r
- //\r
- LIST_ENTRY NsKeyList;\r
- USB_NS_KEY *CurrentNsKey;\r
- EFI_KEY_DESCRIPTOR *KeyConvertionTable;\r
- EFI_EVENT KeyboardLayoutEvent;\r
-} USB_KB_DEV;\r
-\r
-//\r
-// Global Variables\r
-//\r
-extern EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding;\r
-extern EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName;\r
-extern EFI_COMPONENT_NAME2_PROTOCOL gUsbKeyboardComponentName2;\r
-extern EFI_GUID gEfiUsbKeyboardDriverGuid;\r
-extern EFI_GUID gSimpleTextInExNotifyGuid;\r
-\r
-VOID\r
-KbdReportStatusCode (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value\r
- );\r
-\r
-#define USB_KB_DEV_FROM_THIS(a) \\r
- CR(a, USB_KB_DEV, SimpleInput, USB_KB_DEV_SIGNATURE)\r
-#define TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS(a) \\r
- CR(a, USB_KB_DEV, SimpleInputEx, USB_KB_DEV_SIGNATURE)\r
-\r
-\r
-#define MOD_CONTROL_L 0x01\r
-#define MOD_CONTROL_R 0x10\r
-#define MOD_SHIFT_L 0x02\r
-#define MOD_SHIFT_R 0x20\r
-#define MOD_ALT_L 0x04\r
-#define MOD_ALT_R 0x40\r
-#define MOD_WIN_L 0x08\r
-#define MOD_WIN_R 0x80\r
-\r
-typedef struct {\r
- UINT8 Mask;\r
- UINT8 Key;\r
-} KB_MODIFIER;\r
-\r
-#define USB_KEYCODE_MAX_MAKE 0x62\r
-\r
-#define USBKBD_VALID_KEYCODE(key) ((UINT8) (key) > 3)\r
-\r
-typedef struct {\r
- UINT8 NumLock : 1;\r
- UINT8 CapsLock : 1;\r
- UINT8 ScrollLock : 1;\r
- UINT8 Resrvd : 5;\r
-} LED_MAP;\r
-\r
-//\r
-// Simple Text Input Ex protocol functions\r
-//\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardResetEx (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could \r
- not be reset.\r
-\r
---*/\r
-;\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardReadKeyStrokeEx (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- OUT EFI_KEY_DATA *KeyData\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- state data for the key that was pressed.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
-\r
---*/\r
-;\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardSetState (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
- state for the input device.\r
- \r
- Returns: \r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
-\r
---*/ \r
-;\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardRegisterKeyNotify (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_KEY_DATA *KeyData,\r
- IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
- OUT EFI_HANDLE *NotifyHandle\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key \r
- sequence is typed specified by KeyData. \r
- NotifyHandle - Points to the unique handle assigned to the registered notification. \r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
- \r
---*/ \r
-;\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-USBKeyboardUnregisterKeyNotify (\r
- IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
- IN EFI_HANDLE NotificationHandle\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer. \r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database. \r
- \r
---*/ \r
-;\r
-\r
-#endif\r
-\r
+++ /dev/null
-/** @file\r
-\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- Keyboard.c\r
-\r
-Abstract:\r
-\r
- Helper functions for USB Keyboard Driver\r
-\r
-Revision History\r
-\r
-\r
-**/\r
-\r
-#include "keyboard.h"\r
-#include <Library/UsbLib.h>\r
-\r
-//\r
-// Static English keyboard layout\r
-// Format:<efi key>, <unicode without shift>, <unicode with shift>, <Modifier>, <AffectedAttribute>\r
-//\r
-STATIC\r
-UINT8 KeyboardLayoutTable[USB_KEYCODE_MAX_MAKE + 8][5] = {\r
- {EfiKeyC1, 'a', 'A', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x04\r
- {EfiKeyB5, 'b', 'B', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x05\r
- {EfiKeyB3, 'c', 'C', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x06\r
- {EfiKeyC3, 'd', 'D', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x07\r
- {EfiKeyD3, 'e', 'E', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x08\r
- {EfiKeyC4, 'f', 'F', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x09\r
- {EfiKeyC5, 'g', 'G', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0A\r
- {EfiKeyC6, 'h', 'H', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0B\r
- {EfiKeyD8, 'i', 'I', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0C\r
- {EfiKeyC7, 'j', 'J', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0D\r
- {EfiKeyC8, 'k', 'K', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0E\r
- {EfiKeyC9, 'l', 'L', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x0F\r
- {EfiKeyB7, 'm', 'M', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x10\r
- {EfiKeyB6, 'n', 'N', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x11\r
- {EfiKeyD9, 'o', 'O', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x12\r
- {EfiKeyD10, 'p', 'P', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x13\r
- {EfiKeyD1, 'q', 'Q', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x14\r
- {EfiKeyD4, 'r', 'R', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x15\r
- {EfiKeyC2, 's', 'S', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x16\r
- {EfiKeyD5, 't', 'T', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x17\r
- {EfiKeyD7, 'u', 'U', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x18\r
- {EfiKeyB4, 'v', 'V', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x19\r
- {EfiKeyD2, 'w', 'W', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1A\r
- {EfiKeyB2, 'x', 'X', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1B\r
- {EfiKeyD6, 'y', 'Y', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1C\r
- {EfiKeyB1, 'z', 'Z', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_CAPS_LOCK}, // 0x1D\r
- {EfiKeyE1, '1', '!', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1E\r
- {EfiKeyE2, '2', '@', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x1F\r
- {EfiKeyE3, '3', '#', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x20\r
- {EfiKeyE4, '4', '$', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x21\r
- {EfiKeyE5, '5', '%', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x22\r
- {EfiKeyE6, '6', '^', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x23\r
- {EfiKeyE7, '7', '&', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x24\r
- {EfiKeyE8, '8', '*', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x25\r
- {EfiKeyE9, '9', '(', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x26\r
- {EfiKeyE10, '0', ')', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x27\r
- {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x28 Enter\r
- {EfiKeyEsc, 0x1b, 0x1b, EFI_NULL_MODIFIER, 0}, // 0x29 Esc\r
- {EfiKeyBackSpace, 0x08, 0x08, EFI_NULL_MODIFIER, 0}, // 0x2A Backspace\r
- {EfiKeyTab, 0x09, 0x09, EFI_NULL_MODIFIER, 0}, // 0x2B Tab\r
- {EfiKeySpaceBar, ' ', ' ', EFI_NULL_MODIFIER, 0}, // 0x2C Spacebar\r
- {EfiKeyE11, '-', '_', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2D\r
- {EfiKeyE12, '=', '+', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2E\r
- {EfiKeyD11, '[', '{', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x2F\r
- {EfiKeyD12, ']', '}', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x30\r
- {EfiKeyD13, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x31\r
- {EfiKeyC12, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x32 Keyboard Non-US # and ~\r
- {EfiKeyC10, ';', ':', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x33\r
- {EfiKeyC11, '\'', '"', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x34\r
- {EfiKeyE0, '`', '~', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x35 Keyboard Grave Accent and Tlide\r
- {EfiKeyB8, ',', '<', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x36\r
- {EfiKeyB9, '.', '>', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x37\r
- {EfiKeyB10, '/', '?', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x38\r
- {EfiKeyCapsLock, 0x00, 0x00, EFI_CAPS_LOCK_MODIFIER, 0}, // 0x39 CapsLock\r
- {EfiKeyF1, 0x00, 0x00, EFI_FUNCTION_KEY_ONE_MODIFIER, 0}, // 0x3A\r
- {EfiKeyF2, 0x00, 0x00, EFI_FUNCTION_KEY_TWO_MODIFIER, 0}, // 0x3B\r
- {EfiKeyF3, 0x00, 0x00, EFI_FUNCTION_KEY_THREE_MODIFIER, 0}, // 0x3C\r
- {EfiKeyF4, 0x00, 0x00, EFI_FUNCTION_KEY_FOUR_MODIFIER, 0}, // 0x3D\r
- {EfiKeyF5, 0x00, 0x00, EFI_FUNCTION_KEY_FIVE_MODIFIER, 0}, // 0x3E\r
- {EfiKeyF6, 0x00, 0x00, EFI_FUNCTION_KEY_SIX_MODIFIER, 0}, // 0x3F\r
- {EfiKeyF7, 0x00, 0x00, EFI_FUNCTION_KEY_SEVEN_MODIFIER, 0}, // 0x40\r
- {EfiKeyF8, 0x00, 0x00, EFI_FUNCTION_KEY_EIGHT_MODIFIER, 0}, // 0x41\r
- {EfiKeyF9, 0x00, 0x00, EFI_FUNCTION_KEY_NINE_MODIFIER, 0}, // 0x42\r
- {EfiKeyF10, 0x00, 0x00, EFI_FUNCTION_KEY_TEN_MODIFIER, 0}, // 0x43\r
- {EfiKeyF11, 0x00, 0x00, EFI_FUNCTION_KEY_ELEVEN_MODIFIER, 0}, // 0x44 F11\r
- {EfiKeyF12, 0x00, 0x00, EFI_FUNCTION_KEY_TWELVE_MODIFIER, 0}, // 0x45 F12\r
- {EfiKeyPrint, 0x00, 0x00, EFI_PRINT_MODIFIER, 0}, // 0x46 PrintScreen\r
- {EfiKeySLck, 0x00, 0x00, EFI_SCROLL_LOCK_MODIFIER, 0}, // 0x47 Scroll Lock\r
- {EfiKeyPause, 0x00, 0x00, EFI_PAUSE_MODIFIER, 0}, // 0x48 Pause\r
- {EfiKeyIns, 0x00, 0x00, EFI_INSERT_MODIFIER, 0}, // 0x49\r
- {EfiKeyHome, 0x00, 0x00, EFI_HOME_MODIFIER, 0}, // 0x4A\r
- {EfiKeyPgUp, 0x00, 0x00, EFI_PAGE_UP_MODIFIER, 0}, // 0x4B\r
- {EfiKeyDel, 0x00, 0x00, EFI_DELETE_MODIFIER, 0}, // 0x4C\r
- {EfiKeyEnd, 0x00, 0x00, EFI_END_MODIFIER, 0}, // 0x4D\r
- {EfiKeyPgDn, 0x00, 0x00, EFI_PAGE_DOWN_MODIFIER, 0}, // 0x4E\r
- {EfiKeyRightArrow, 0x00, 0x00, EFI_RIGHT_ARROW_MODIFIER, 0}, // 0x4F\r
- {EfiKeyLeftArrow, 0x00, 0x00, EFI_LEFT_ARROW_MODIFIER, 0}, // 0x50\r
- {EfiKeyDownArrow, 0x00, 0x00, EFI_DOWN_ARROW_MODIFIER, 0}, // 0x51\r
- {EfiKeyUpArrow, 0x00, 0x00, EFI_UP_ARROW_MODIFIER, 0}, // 0x52\r
- {EfiKeyNLck, 0x00, 0x00, EFI_NUM_LOCK_MODIFIER, 0}, // 0x53 NumLock\r
- {EfiKeySlash, '/', '/', EFI_NULL_MODIFIER, 0}, // 0x54\r
- {EfiKeyAsterisk, '*', '*', EFI_NULL_MODIFIER, 0}, // 0x55\r
- {EfiKeyMinus, '-', '-', EFI_NULL_MODIFIER, 0}, // 0x56\r
- {EfiKeyPlus, '+', '+', EFI_NULL_MODIFIER, 0}, // 0x57\r
- {EfiKeyEnter, 0x0d, 0x0d, EFI_NULL_MODIFIER, 0}, // 0x58\r
- {EfiKeyOne, '1', '1', EFI_END_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x59\r
- {EfiKeyTwo, '2', '2', EFI_DOWN_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5A\r
- {EfiKeyThree, '3', '3', EFI_PAGE_DOWN_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5B\r
- {EfiKeyFour, '4', '4', EFI_LEFT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5C\r
- {EfiKeyFive, '5', '5', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5D\r
- {EfiKeySix, '6', '6', EFI_RIGHT_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5E\r
- {EfiKeySeven, '7', '7', EFI_HOME_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x5F\r
- {EfiKeyEight, '8', '8', EFI_UP_ARROW_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x60\r
- {EfiKeyNine, '9', '9', EFI_PAGE_UP_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x61\r
- {EfiKeyZero, '0', '0', EFI_INSERT_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x62\r
- {EfiKeyPeriod, '.', '.', EFI_DELETE_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT | EFI_AFFECTED_BY_NUM_LOCK}, // 0x63\r
- {EfiKeyB0, '\\', '|', EFI_NULL_MODIFIER, EFI_AFFECTED_BY_STANDARD_SHIFT}, // 0x64 Keyboard Non-US \ and |\r
- {EfiKeyA4, 0x00, 0x00, EFI_MENU_MODIFIER, 0}, // 0x65 Keyboard Application\r
-\r
- {EfiKeyLCtrl, 0, 0, EFI_LEFT_CONTROL_MODIFIER, 0}, // 0xe0\r
- {EfiKeyLShift, 0, 0, EFI_LEFT_SHIFT_MODIFIER, 0}, // 0xe1\r
- {EfiKeyLAlt, 0, 0, EFI_LEFT_ALT_MODIFIER, 0}, // 0xe2\r
- {EfiKeyA0, 0, 0, EFI_LEFT_LOGO_MODIFIER, 0}, // 0xe3\r
- {EfiKeyRCtrl, 0, 0, EFI_RIGHT_CONTROL_MODIFIER, 0}, // 0xe4\r
- {EfiKeyRShift, 0, 0, EFI_RIGHT_SHIFT_MODIFIER, 0}, // 0xe5\r
- {EfiKeyA2, 0, 0, EFI_RIGHT_ALT_MODIFIER, 0}, // 0xe6\r
- {EfiKeyA3, 0, 0, EFI_RIGHT_LOGO_MODIFIER, 0}, // 0xe7\r
-};\r
-\r
-VOID\r
-LoadDefaultKeyboardLayout (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Initialize KeyConvertionTable by using default keyboard layout.\r
-\r
- Arguments:\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
-\r
- Returns:\r
- None.\r
-\r
---*/\r
-{\r
- UINTN Index;\r
- EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
-\r
- //\r
- // Construct KeyConvertionTable by default keyboard layout\r
- //\r
- KeyDescriptor = &UsbKeyboardDevice->KeyConvertionTable[0];\r
-\r
- for (Index = 0; Index < (USB_KEYCODE_MAX_MAKE + 8); Index++) {\r
- KeyDescriptor->Key = (EFI_KEY) KeyboardLayoutTable[Index][0];\r
- KeyDescriptor->Unicode = KeyboardLayoutTable[Index][1];\r
- KeyDescriptor->ShiftedUnicode = KeyboardLayoutTable[Index][2];\r
- KeyDescriptor->AltGrUnicode = 0;\r
- KeyDescriptor->ShiftedAltGrUnicode = 0;\r
- KeyDescriptor->Modifier = KeyboardLayoutTable[Index][3];\r
- KeyDescriptor->AffectedAttribute = KeyboardLayoutTable[Index][4];\r
-\r
- KeyDescriptor++;\r
- }\r
-}\r
-\r
-//\r
-// EFI_KEY to USB Scan Code convertion table\r
-//\r
-STATIC\r
-UINT8 UsbScanCodeConvertionTable[] = {\r
- 0xe0, // EfiKeyLCtrl\r
- 0xe3, // EfiKeyA0\r
- 0xe2, // EfiKeyLAlt\r
- 0x2c, // EfiKeySpaceBar\r
- 0xe6, // EfiKeyA2\r
- 0xe7, // EfiKeyA3\r
- 0x65, // EfiKeyA4\r
- 0xe4, // EfiKeyRCtrl\r
- 0x50, // EfiKeyLeftArrow\r
- 0x51, // EfiKeyDownArrow\r
- 0x4F, // EfiKeyRightArrow\r
- 0x62, // EfiKeyZero\r
- 0x63, // EfiKeyPeriod\r
- 0x28, // EfiKeyEnter\r
- 0xe1, // EfiKeyLShift\r
- 0x64, // EfiKeyB0\r
- 0x1D, // EfiKeyB1\r
- 0x1B, // EfiKeyB2\r
- 0x06, // EfiKeyB3\r
- 0x19, // EfiKeyB4\r
- 0x05, // EfiKeyB5\r
- 0x11, // EfiKeyB6\r
- 0x10, // EfiKeyB7\r
- 0x36, // EfiKeyB8\r
- 0x37, // EfiKeyB9\r
- 0x38, // EfiKeyB10\r
- 0xe5, // EfiKeyRShift\r
- 0x52, // EfiKeyUpArrow\r
- 0x59, // EfiKeyOne\r
- 0x5A, // EfiKeyTwo\r
- 0x5B, // EfiKeyThree\r
- 0x39, // EfiKeyCapsLock\r
- 0x04, // EfiKeyC1\r
- 0x16, // EfiKeyC2\r
- 0x07, // EfiKeyC3\r
- 0x09, // EfiKeyC4\r
- 0x0A, // EfiKeyC5\r
- 0x0B, // EfiKeyC6\r
- 0x0D, // EfiKeyC7\r
- 0x0E, // EfiKeyC8\r
- 0x0F, // EfiKeyC9\r
- 0x33, // EfiKeyC10\r
- 0x34, // EfiKeyC11\r
- 0x32, // EfiKeyC12\r
- 0x5C, // EfiKeyFour\r
- 0x5D, // EfiKeyFive\r
- 0x5E, // EfiKeySix\r
- 0x57, // EfiKeyPlus\r
- 0x2B, // EfiKeyTab\r
- 0x14, // EfiKeyD1\r
- 0x1A, // EfiKeyD2\r
- 0x08, // EfiKeyD3\r
- 0x15, // EfiKeyD4\r
- 0x17, // EfiKeyD5\r
- 0x1C, // EfiKeyD6\r
- 0x18, // EfiKeyD7\r
- 0x0C, // EfiKeyD8\r
- 0x12, // EfiKeyD9\r
- 0x13, // EfiKeyD10\r
- 0x2F, // EfiKeyD11\r
- 0x30, // EfiKeyD12\r
- 0x31, // EfiKeyD13\r
- 0x4C, // EfiKeyDel\r
- 0x4D, // EfiKeyEnd\r
- 0x4E, // EfiKeyPgDn\r
- 0x5F, // EfiKeySeven\r
- 0x60, // EfiKeyEight\r
- 0x61, // EfiKeyNine\r
- 0x35, // EfiKeyE0\r
- 0x1E, // EfiKeyE1\r
- 0x1F, // EfiKeyE2\r
- 0x20, // EfiKeyE3\r
- 0x21, // EfiKeyE4\r
- 0x22, // EfiKeyE5\r
- 0x23, // EfiKeyE6\r
- 0x24, // EfiKeyE7\r
- 0x25, // EfiKeyE8\r
- 0x26, // EfiKeyE9\r
- 0x27, // EfiKeyE10\r
- 0x2D, // EfiKeyE11\r
- 0x2E, // EfiKeyE12\r
- 0x2A, // EfiKeyBackSpace\r
- 0x49, // EfiKeyIns\r
- 0x4A, // EfiKeyHome\r
- 0x4B, // EfiKeyPgUp\r
- 0x53, // EfiKeyNLck\r
- 0x54, // EfiKeySlash\r
- 0x55, // EfiKeyAsterisk\r
- 0x56, // EfiKeyMinus\r
- 0x29, // EfiKeyEsc\r
- 0x3A, // EfiKeyF1\r
- 0x3B, // EfiKeyF2\r
- 0x3C, // EfiKeyF3\r
- 0x3D, // EfiKeyF4\r
- 0x3E, // EfiKeyF5\r
- 0x3F, // EfiKeyF6\r
- 0x40, // EfiKeyF7\r
- 0x41, // EfiKeyF8\r
- 0x42, // EfiKeyF9\r
- 0x43, // EfiKeyF10\r
- 0x44, // EfiKeyF11\r
- 0x45, // EfiKeyF12\r
- 0x46, // EfiKeyPrint\r
- 0x47, // EfiKeySLck\r
- 0x48 // EfiKeyPause\r
-};\r
-\r
-//\r
-// Keyboard Layout Modifier to EFI Scan Code convertion table\r
-//\r
-STATIC\r
-UINT8 EfiScanCodeConvertionTable[] = {\r
- SCAN_NULL, // EFI_NULL_MODIFIER\r
- SCAN_NULL, // EFI_LEFT_CONTROL_MODIFIER\r
- SCAN_NULL, // EFI_RIGHT_CONTROL_MODIFIER\r
- SCAN_NULL, // EFI_LEFT_ALT_MODIFIER\r
- SCAN_NULL, // EFI_RIGHT_ALT_MODIFIER\r
- SCAN_NULL, // EFI_ALT_GR_MODIFIER\r
- SCAN_INSERT, // EFI_INSERT_MODIFIER\r
- SCAN_DELETE, // EFI_DELETE_MODIFIER\r
- SCAN_PAGE_DOWN, // EFI_PAGE_DOWN_MODIFIER\r
- SCAN_PAGE_UP, // EFI_PAGE_UP_MODIFIER\r
- SCAN_HOME, // EFI_HOME_MODIFIER\r
- SCAN_END, // EFI_END_MODIFIER\r
- SCAN_NULL, // EFI_LEFT_SHIFT_MODIFIER\r
- SCAN_NULL, // EFI_RIGHT_SHIFT_MODIFIER\r
- SCAN_NULL, // EFI_CAPS_LOCK_MODIFIER\r
- SCAN_NULL, // EFI_NUM_LOCK_MODIFIER\r
- SCAN_LEFT, // EFI_LEFT_ARROW_MODIFIER\r
- SCAN_RIGHT, // EFI_RIGHT_ARROW_MODIFIER\r
- SCAN_DOWN, // EFI_DOWN_ARROW_MODIFIER\r
- SCAN_UP, // EFI_UP_ARROW_MODIFIER\r
- SCAN_NULL, // EFI_NS_KEY_MODIFIER\r
- SCAN_NULL, // EFI_NS_KEY_DEPENDENCY_MODIFIER\r
- SCAN_F1, // EFI_FUNCTION_KEY_ONE_MODIFIER\r
- SCAN_F2, // EFI_FUNCTION_KEY_TWO_MODIFIER\r
- SCAN_F3, // EFI_FUNCTION_KEY_THREE_MODIFIER\r
- SCAN_F4, // EFI_FUNCTION_KEY_FOUR_MODIFIER\r
- SCAN_F5, // EFI_FUNCTION_KEY_FIVE_MODIFIER\r
- SCAN_F6, // EFI_FUNCTION_KEY_SIX_MODIFIER\r
- SCAN_F7, // EFI_FUNCTION_KEY_SEVEN_MODIFIER\r
- SCAN_F8, // EFI_FUNCTION_KEY_EIGHT_MODIFIER\r
- SCAN_F9, // EFI_FUNCTION_KEY_NINE_MODIFIER\r
- SCAN_F10, // EFI_FUNCTION_KEY_TEN_MODIFIER\r
- SCAN_F11, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER\r
- SCAN_F12, // EFI_FUNCTION_KEY_TWELVE_MODIFIER\r
-};\r
-\r
-EFI_GUID mKeyboardLayoutEventGuid = EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID;\r
-\r
-\r
-STATIC KB_MODIFIER KB_Mod[8] = {\r
- { MOD_CONTROL_L, 0xe0 }, // 11100000\r
- { MOD_CONTROL_R, 0xe4 }, // 11100100\r
- { MOD_SHIFT_L, 0xe1 }, // 11100001\r
- { MOD_SHIFT_R, 0xe5 }, // 11100101\r
- { MOD_ALT_L, 0xe2 }, // 11100010\r
- { MOD_ALT_R, 0xe6 }, // 11100110\r
- { MOD_WIN_L, 0xe3 }, // 11100011\r
- { MOD_WIN_R, 0xe7 }, // 11100111 \r
-};\r
-\r
-\r
-\r
-/**\r
- Uses USB I/O to check whether the device is a USB Keyboard device.\r
-\r
- UsbIo: Points to a USB I/O protocol instance.\r
-\r
-\r
-**/\r
-BOOLEAN\r
-IsUSBKeyboard (\r
- IN EFI_USB_IO_PROTOCOL *UsbIo\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
-\r
- //\r
- // Get the Default interface descriptor, currently we\r
- // assume it is interface 1\r
- //\r
- Status = UsbIo->UsbGetInterfaceDescriptor (\r
- UsbIo,\r
- &InterfaceDescriptor\r
- );\r
-\r
- if (EFI_ERROR (Status)) {\r
- return FALSE;\r
- }\r
-\r
- if (InterfaceDescriptor.InterfaceClass == CLASS_HID &&\r
- InterfaceDescriptor.InterfaceSubClass == SUBCLASS_BOOT &&\r
- InterfaceDescriptor.InterfaceProtocol == PROTOCOL_KEYBOARD\r
- ) {\r
-\r
- return TRUE;\r
- }\r
-\r
- return FALSE;\r
-}\r
-\r
-\r
-EFI_HII_KEYBOARD_LAYOUT *\r
-GetCurrentKeyboardLayout (\r
- VOID\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Get current keyboard layout from HII database.\r
-\r
- Arguments:\r
- None.\r
-\r
- Returns:\r
- Pointer to EFI_HII_KEYBOARD_LAYOUT.\r
-\r
---*/\r
-{\r
- EFI_STATUS Status;\r
- EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
- EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
- UINT16 Length;\r
-\r
- //\r
- // Locate Hii database protocol\r
- //\r
- Status = gBS->LocateProtocol (\r
- &gEfiHiiDatabaseProtocolGuid,\r
- NULL,\r
- (VOID **) &HiiDatabase\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return NULL;\r
- }\r
-\r
- //\r
- // Get current keyboard layout from HII database\r
- //\r
- Length = 0;\r
- KeyboardLayout = NULL;\r
- Status = HiiDatabase->GetKeyboardLayout (\r
- HiiDatabase,\r
- NULL,\r
- &Length,\r
- KeyboardLayout\r
- );\r
- if (Status == EFI_BUFFER_TOO_SMALL) {\r
- KeyboardLayout = AllocatePool (Length);\r
- ASSERT (KeyboardLayout != NULL);\r
-\r
- Status = HiiDatabase->GetKeyboardLayout (\r
- HiiDatabase,\r
- NULL,\r
- &Length,\r
- KeyboardLayout\r
- );\r
- if (EFI_ERROR (Status)) {\r
- gBS->FreePool (KeyboardLayout);\r
- KeyboardLayout = NULL;\r
- }\r
- }\r
-\r
- return KeyboardLayout;\r
-}\r
-\r
-EFI_KEY_DESCRIPTOR *\r
-GetKeyDescriptor (\r
- IN USB_KB_DEV *UsbKeyboardDevice,\r
- IN UINT8 ScanCode\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Find Key Descriptor in KeyConvertionTable given its scan code.\r
-\r
- Arguments:\r
- UsbKeyboardDevice - The USB_KB_DEV instance.\r
- ScanCode - USB scan code.\r
-\r
- Returns:\r
- The Key descriptor in KeyConvertionTable.\r
-\r
---*/\r
-{\r
- UINT8 Index;\r
-\r
- if (((ScanCode > 0x65) && (ScanCode < 0xe0)) || (ScanCode > 0xe7)) {\r
- return NULL;\r
- }\r
-\r
- if (ScanCode <= 0x65) {\r
- Index = (UINT8) (ScanCode - 4);\r
- } else {\r
- Index = (UINT8) (ScanCode - 0xe0 + USB_KEYCODE_MAX_MAKE);\r
- }\r
-\r
- return &UsbKeyboardDevice->KeyConvertionTable[Index];\r
-}\r
-\r
-USB_NS_KEY *\r
-FindUsbNsKey (\r
- IN USB_KB_DEV *UsbKeyboardDevice,\r
- IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Find Non-Spacing key for given KeyDescriptor.\r
-\r
- Arguments:\r
- UsbKeyboardDevice - The USB_KB_DEV instance.\r
- KeyDescriptor - Key descriptor.\r
-\r
- Returns:\r
- The Non-Spacing key.\r
-\r
---*/\r
-{\r
- LIST_ENTRY *Link;\r
- USB_NS_KEY *UsbNsKey;\r
-\r
- Link = GetFirstNode (&UsbKeyboardDevice->NsKeyList);\r
- while (!IsNull (&UsbKeyboardDevice->NsKeyList, Link)) {\r
- UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
-\r
- if (UsbNsKey->NsKey[0].Key == KeyDescriptor->Key) {\r
- return UsbNsKey;\r
- }\r
-\r
- Link = GetNextNode (&UsbKeyboardDevice->NsKeyList, Link);\r
- }\r
-\r
- return NULL;\r
-}\r
-\r
-EFI_KEY_DESCRIPTOR *\r
-FindPhysicalKey (\r
- IN USB_NS_KEY *UsbNsKey,\r
- IN EFI_KEY_DESCRIPTOR *KeyDescriptor\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Find physical key definition for a given Key stroke.\r
-\r
- Arguments:\r
- UsbNsKey - The Non-Spacing key information.\r
- KeyDescriptor - The key stroke.\r
-\r
- Returns:\r
- The physical key definition.\r
-\r
---*/\r
-{\r
- UINTN Index;\r
- EFI_KEY_DESCRIPTOR *PhysicalKey;\r
-\r
- PhysicalKey = &UsbNsKey->NsKey[1];\r
- for (Index = 0; Index < UsbNsKey->KeyCount; Index++) {\r
- if (KeyDescriptor->Key == PhysicalKey->Key) {\r
- return PhysicalKey;\r
- }\r
-\r
- PhysicalKey++;\r
- }\r
-\r
- //\r
- // No children definition matched, return original key\r
- //\r
- return KeyDescriptor;\r
-}\r
-\r
-VOID\r
-EFIAPI\r
-SetKeyboardLayoutEvent (\r
- EFI_EVENT Event,\r
- VOID *Context\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- The notification function for SET_KEYBOARD_LAYOUT_EVENT.\r
-\r
- Arguments:\r
-\r
- Returns:\r
-\r
---*/\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
- EFI_KEY_DESCRIPTOR TempKey;\r
- EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
- EFI_KEY_DESCRIPTOR *TableEntry;\r
- EFI_KEY_DESCRIPTOR *NsKey;\r
- USB_NS_KEY *UsbNsKey;\r
- UINTN Index;\r
- UINTN Index2;\r
- UINTN KeyCount;\r
- UINT8 ScanCode;\r
-\r
- UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
-\r
- //\r
- // Try to get current Keyboard Layout from HII database\r
- //\r
- KeyboardLayout = GetCurrentKeyboardLayout ();\r
- if (KeyboardLayout == NULL) {\r
- return;\r
- }\r
-\r
- //\r
- // Allocate resource for KeyConvertionTable\r
- //\r
- ReleaseKeyboardLayoutResources (UsbKeyboardDevice);\r
- UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((USB_KEYCODE_MAX_MAKE + 8) * sizeof (EFI_KEY_DESCRIPTOR));\r
- ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
-\r
- KeyDescriptor = (EFI_KEY_DESCRIPTOR *) (((UINT8 *) KeyboardLayout) + sizeof (EFI_HII_KEYBOARD_LAYOUT));\r
- for (Index = 0; Index < KeyboardLayout->DescriptorCount; Index++) {\r
- //\r
- // Copy from HII keyboard layout package binary for alignment\r
- //\r
- CopyMem (&TempKey, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
-\r
- //\r
- // Fill the key into KeyConvertionTable (which use USB Scan Code as index)\r
- //\r
- ScanCode = UsbScanCodeConvertionTable [(UINT8) (TempKey.Key)];\r
- TableEntry = GetKeyDescriptor (UsbKeyboardDevice, ScanCode);\r
- CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
-\r
- if (TempKey.Modifier == EFI_NS_KEY_MODIFIER) {\r
- //\r
- // Non-spacing key\r
- //\r
- UsbNsKey = AllocatePool (sizeof (USB_NS_KEY));\r
- ASSERT (UsbNsKey != NULL);\r
-\r
- //\r
- // Search for sequential children physical key definitions\r
- //\r
- KeyCount = 0;\r
- NsKey = KeyDescriptor + 1;\r
- for (Index2 = Index + 1; Index2 < KeyboardLayout->DescriptorCount; Index2++) {\r
- CopyMem (&TempKey, NsKey, sizeof (EFI_KEY_DESCRIPTOR));\r
- if (TempKey.Modifier & EFI_NS_KEY_DEPENDENCY_MODIFIER) {\r
- KeyCount++;\r
- } else {\r
- break;\r
- }\r
- NsKey++;\r
- }\r
-\r
- UsbNsKey->Signature = USB_NS_KEY_SIGNATURE;\r
- UsbNsKey->KeyCount = KeyCount;\r
- UsbNsKey->NsKey = AllocateCopyPool (\r
- (KeyCount + 1) * sizeof (EFI_KEY_DESCRIPTOR),\r
- KeyDescriptor\r
- );\r
- InsertTailList (&UsbKeyboardDevice->NsKeyList, &UsbNsKey->Link);\r
-\r
- //\r
- // Skip over the child physical keys\r
- //\r
- Index += KeyCount;\r
- KeyDescriptor += KeyCount;\r
- }\r
-\r
- KeyDescriptor++;\r
- }\r
-\r
- //\r
- // There are two EfiKeyEnter, duplicate its Key Descriptor\r
- //\r
- TableEntry = GetKeyDescriptor (UsbKeyboardDevice, 0x58);\r
- KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, 0x28);\r
- CopyMem (TableEntry, KeyDescriptor, sizeof (EFI_KEY_DESCRIPTOR));\r
-\r
- gBS->FreePool (KeyboardLayout);\r
-}\r
-\r
-VOID\r
-ReleaseKeyboardLayoutResources (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Destroy resources for Keyboard layout.\r
-\r
- Arguments:\r
- UsbKeyboardDevice - The USB_KB_DEV instance.\r
-\r
- Returns:\r
- None.\r
-\r
---*/\r
-{\r
- USB_NS_KEY *UsbNsKey;\r
- LIST_ENTRY *Link;\r
-\r
- SafeFreePool (UsbKeyboardDevice->KeyConvertionTable);\r
- UsbKeyboardDevice->KeyConvertionTable = NULL;\r
-\r
- while (!IsListEmpty (&UsbKeyboardDevice->NsKeyList)) {\r
- Link = GetFirstNode (&UsbKeyboardDevice->NsKeyList);\r
- UsbNsKey = USB_NS_KEY_FORM_FROM_LINK (Link);\r
- RemoveEntryList (&UsbNsKey->Link);\r
-\r
- gBS->FreePool (UsbNsKey->NsKey);\r
- gBS->FreePool (UsbNsKey);\r
- }\r
-}\r
-\r
-EFI_STATUS\r
-InitKeyboardLayout (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-/*++\r
-\r
- Routine Description:\r
- Initialize USB Keyboard layout.\r
-\r
- Arguments:\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
-\r
- Returns:\r
- EFI_SUCCESS - Success\r
- Other - Keyboard layout initial failed.\r
---*/\r
-{\r
- EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout;\r
- EFI_STATUS Status;\r
-\r
- UsbKeyboardDevice->KeyConvertionTable = AllocateZeroPool ((USB_KEYCODE_MAX_MAKE + 8) * sizeof (EFI_KEY_DESCRIPTOR));\r
- ASSERT (UsbKeyboardDevice->KeyConvertionTable != NULL);\r
-\r
- InitializeListHead (&UsbKeyboardDevice->NsKeyList);\r
- UsbKeyboardDevice->CurrentNsKey = NULL;\r
- UsbKeyboardDevice->KeyboardLayoutEvent = NULL;\r
-\r
- //\r
- // Register SET_KEYBOARD_LAYOUT_EVENT notification\r
- //\r
- Status = gBS->CreateEventEx (\r
- EFI_EVENT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- SetKeyboardLayoutEvent,\r
- UsbKeyboardDevice,\r
- &mKeyboardLayoutEventGuid,\r
- &UsbKeyboardDevice->KeyboardLayoutEvent\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Try to get current keyboard layout from HII database\r
- //\r
- KeyboardLayout = GetCurrentKeyboardLayout ();\r
- if (KeyboardLayout != NULL) {\r
- //\r
- // Force to initialize the keyboard layout\r
- //\r
- gBS->SignalEvent (UsbKeyboardDevice->KeyboardLayoutEvent);\r
- } else {\r
- if (FeaturePcdGet (PcdDisableDefaultKeyboardLayoutInUsbKbDriver)) {\r
- return EFI_NOT_READY;\r
- } else {\r
-\r
- //\r
- // Fail to get keyboard layout from HII database,\r
- // use default keyboard layout\r
- //\r
- LoadDefaultKeyboardLayout (UsbKeyboardDevice);\r
- }\r
- }\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Initialize USB Keyboard device and all private data structures.\r
-\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_DEVICE_ERROR Hardware Error\r
-\r
-**/\r
-EFI_STATUS\r
-InitUSBKeyboard (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-{\r
- UINT8 ConfigValue;\r
- UINT8 Protocol;\r
- UINT8 ReportId;\r
- UINT8 Duration;\r
- EFI_STATUS Status;\r
- UINT32 TransferResult;\r
-\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueKeyboardSelfTest)\r
- );\r
-\r
- InitUSBKeyBuffer (&(UsbKeyboardDevice->KeyboardBuffer));\r
-\r
- //\r
- // default configurations\r
- //\r
- ConfigValue = 0x01;\r
-\r
- //\r
- // Uses default configuration to configure the USB Keyboard device.\r
- //\r
- Status = UsbSetConfiguration (\r
- UsbKeyboardDevice->UsbIo,\r
- (UINT16) ConfigValue,\r
- &TransferResult\r
- );\r
- if (EFI_ERROR (Status)) {\r
- //\r
- // If configuration could not be set here, it means\r
- // the keyboard interface has some errors and could\r
- // not be initialized\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueKeyboardInterfaceError)\r
- );\r
-\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- UsbGetProtocolRequest (\r
- UsbKeyboardDevice->UsbIo,\r
- UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
- &Protocol\r
- );\r
- //\r
- // Sets boot protocol for the USB Keyboard.\r
- // This driver only supports boot protocol.\r
- // !!BugBug: How about the device that does not support boot protocol?\r
- //\r
- if (Protocol != BOOT_PROTOCOL) {\r
- UsbSetProtocolRequest (\r
- UsbKeyboardDevice->UsbIo,\r
- UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
- BOOT_PROTOCOL\r
- );\r
- }\r
- //\r
- // the duration is indefinite, so the endpoint will inhibit reporting forever,\r
- // and only reporting when a change is detected in the report data.\r
- //\r
-\r
- //\r
- // idle value for all report ID\r
- //\r
- ReportId = 0;\r
- //\r
- // idle forever until there is a key pressed and released.\r
- //\r
- Duration = 0;\r
- UsbSetIdleRequest (\r
- UsbKeyboardDevice->UsbIo,\r
- UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
- ReportId,\r
- Duration\r
- );\r
-\r
- UsbKeyboardDevice->CtrlOn = 0;\r
- UsbKeyboardDevice->AltOn = 0;\r
- UsbKeyboardDevice->ShiftOn = 0;\r
- UsbKeyboardDevice->NumLockOn = 0;\r
- UsbKeyboardDevice->CapsOn = 0;\r
- UsbKeyboardDevice->ScrollOn = 0;\r
- \r
- UsbKeyboardDevice->LeftCtrlOn = 0;\r
- UsbKeyboardDevice->LeftAltOn = 0;\r
- UsbKeyboardDevice->LeftShiftOn = 0;\r
- UsbKeyboardDevice->LeftLogoOn = 0;\r
- UsbKeyboardDevice->RightCtrlOn = 0;\r
- UsbKeyboardDevice->RightAltOn = 0;\r
- UsbKeyboardDevice->RightShiftOn = 0;\r
- UsbKeyboardDevice->RightLogoOn = 0;\r
- UsbKeyboardDevice->MenuKeyOn = 0;\r
- UsbKeyboardDevice->SysReqOn = 0;\r
-\r
- UsbKeyboardDevice->AltGrOn = 0;\r
-\r
- UsbKeyboardDevice->CurrentNsKey = NULL;\r
-\r
- //\r
- // Sync the initial state of lights\r
- //\r
- SetKeyLED (UsbKeyboardDevice);\r
-\r
- ZeroMem (UsbKeyboardDevice->LastKeyCodeArray, sizeof (UINT8) * 8);\r
-\r
- //\r
- // Set a timer for repeat keys' generation.\r
- //\r
- if (UsbKeyboardDevice->RepeatTimer) {\r
- gBS->CloseEvent (UsbKeyboardDevice->RepeatTimer);\r
- UsbKeyboardDevice->RepeatTimer = 0;\r
- }\r
-\r
- Status = gBS->CreateEvent (\r
- EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- USBKeyboardRepeatHandler,\r
- UsbKeyboardDevice,\r
- &UsbKeyboardDevice->RepeatTimer\r
- );\r
-\r
- if (UsbKeyboardDevice->DelayedRecoveryEvent) {\r
- gBS->CloseEvent (UsbKeyboardDevice->DelayedRecoveryEvent);\r
- UsbKeyboardDevice->DelayedRecoveryEvent = 0;\r
- }\r
-\r
- Status = gBS->CreateEvent (\r
- EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- USBKeyboardRecoveryHandler,\r
- UsbKeyboardDevice,\r
- &UsbKeyboardDevice->DelayedRecoveryEvent\r
- );\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Handler function for USB Keyboard's asynchronous interrupt transfer.\r
-\r
- Data A pointer to a buffer that is filled with key data which is\r
- retrieved via asynchronous interrupt transfer.\r
- DataLength Indicates the size of the data buffer.\r
- Context Pointing to USB_KB_DEV instance.\r
- Result Indicates the result of the asynchronous interrupt transfer.\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_DEVICE_ERROR Hardware Error\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-KeyboardHandler (\r
- IN VOID *Data,\r
- IN UINTN DataLength,\r
- IN VOID *Context,\r
- IN UINT32 Result\r
- )\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- UINT8 *CurKeyCodeBuffer;\r
- UINT8 *OldKeyCodeBuffer;\r
- UINT8 CurModifierMap;\r
- UINT8 OldModifierMap;\r
- UINT8 Index;\r
- UINT8 Index2;\r
- BOOLEAN Down;\r
- BOOLEAN KeyRelease;\r
- BOOLEAN KeyPress;\r
- UINT8 SavedTail;\r
- USB_KEY UsbKey;\r
- UINT8 NewRepeatKey;\r
- UINT32 UsbStatus;\r
- EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
-\r
- ASSERT (Context);\r
-\r
- NewRepeatKey = 0;\r
- UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
- UsbIo = UsbKeyboardDevice->UsbIo;\r
-\r
- //\r
- // Analyzes the Result and performs corresponding action.\r
- //\r
- if (Result != EFI_USB_NOERROR) {\r
- //\r
- // Some errors happen during the process\r
- //\r
- KbdReportStatusCode (\r
- UsbKeyboardDevice->DevicePath,\r
- EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueKeyboardInputError)\r
- );\r
-\r
- //\r
- // stop the repeat key generation if any\r
- //\r
- UsbKeyboardDevice->RepeatKey = 0;\r
-\r
- gBS->SetTimer (\r
- UsbKeyboardDevice->RepeatTimer,\r
- TimerCancel,\r
- USBKBD_REPEAT_RATE\r
- );\r
-\r
- if ((Result & EFI_USB_ERR_STALL) == EFI_USB_ERR_STALL) {\r
- UsbClearEndpointHalt (\r
- UsbIo,\r
- UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
- &UsbStatus\r
- );\r
- }\r
-\r
- //\r
- // Delete & Submit this interrupt again\r
- //\r
-\r
- UsbIo->UsbAsyncInterruptTransfer (\r
- UsbIo,\r
- UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
- FALSE,\r
- 0,\r
- 0,\r
- NULL,\r
- NULL\r
- );\r
-\r
- gBS->SetTimer (\r
- UsbKeyboardDevice->DelayedRecoveryEvent,\r
- TimerRelative,\r
- EFI_USB_INTERRUPT_DELAY\r
- );\r
-\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- if (DataLength == 0 || Data == NULL) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- CurKeyCodeBuffer = (UINT8 *) Data;\r
- OldKeyCodeBuffer = UsbKeyboardDevice->LastKeyCodeArray;\r
-\r
- //\r
- // checks for new key stroke.\r
- // if no new key got, return immediately.\r
- //\r
- for (Index = 0; Index < 8; Index++) {\r
- if (OldKeyCodeBuffer[Index] != CurKeyCodeBuffer[Index]) {\r
- break;\r
- }\r
- }\r
-\r
- if (Index == 8) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Parse the modifier key\r
- //\r
- CurModifierMap = CurKeyCodeBuffer[0];\r
- OldModifierMap = OldKeyCodeBuffer[0];\r
-\r
- //\r
- // handle modifier key's pressing or releasing situation.\r
- //\r
- for (Index = 0; Index < 8; Index++) {\r
-\r
- if ((CurModifierMap & KB_Mod[Index].Mask) != (OldModifierMap & KB_Mod[Index].Mask)) {\r
- //\r
- // if current modifier key is up, then\r
- // CurModifierMap & KB_Mod[Index].Mask = 0;\r
- // otherwize it is a non-zero value.\r
- // Inserts the pressed modifier key into key buffer.\r
- //\r
- Down = (UINT8) (CurModifierMap & KB_Mod[Index].Mask);\r
- InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), KB_Mod[Index].Key, Down);\r
- }\r
- }\r
-\r
- //\r
- // handle normal key's releasing situation\r
- //\r
- KeyRelease = FALSE;\r
- for (Index = 2; Index < 8; Index++) {\r
-\r
- if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index])) {\r
- continue;\r
- }\r
-\r
- KeyRelease = TRUE;\r
- for (Index2 = 2; Index2 < 8; Index2++) {\r
-\r
- if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index2])) {\r
- continue;\r
- }\r
-\r
- if (OldKeyCodeBuffer[Index] == CurKeyCodeBuffer[Index2]) {\r
- KeyRelease = FALSE;\r
- break;\r
- }\r
- }\r
-\r
- if (KeyRelease) {\r
- InsertKeyCode (\r
- &(UsbKeyboardDevice->KeyboardBuffer),\r
- OldKeyCodeBuffer[Index],\r
- 0\r
- );\r
- //\r
- // the original reapeat key is released.\r
- //\r
- if (OldKeyCodeBuffer[Index] == UsbKeyboardDevice->RepeatKey) {\r
- UsbKeyboardDevice->RepeatKey = 0;\r
- }\r
- }\r
- }\r
-\r
- //\r
- // original repeat key is released, cancel the repeat timer\r
- //\r
- if (UsbKeyboardDevice->RepeatKey == 0) {\r
- gBS->SetTimer (\r
- UsbKeyboardDevice->RepeatTimer,\r
- TimerCancel,\r
- USBKBD_REPEAT_RATE\r
- );\r
- }\r
-\r
- //\r
- // handle normal key's pressing situation\r
- //\r
- KeyPress = FALSE;\r
- for (Index = 2; Index < 8; Index++) {\r
-\r
- if (!USBKBD_VALID_KEYCODE (CurKeyCodeBuffer[Index])) {\r
- continue;\r
- }\r
-\r
- KeyPress = TRUE;\r
- for (Index2 = 2; Index2 < 8; Index2++) {\r
-\r
- if (!USBKBD_VALID_KEYCODE (OldKeyCodeBuffer[Index2])) {\r
- continue;\r
- }\r
-\r
- if (CurKeyCodeBuffer[Index] == OldKeyCodeBuffer[Index2]) {\r
- KeyPress = FALSE;\r
- break;\r
- }\r
- }\r
-\r
- if (KeyPress) {\r
- InsertKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), CurKeyCodeBuffer[Index], 1);\r
- //\r
- // NumLock pressed or CapsLock pressed\r
- //\r
- KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, CurKeyCodeBuffer[Index]);\r
- if (KeyDescriptor->Modifier == EFI_NUM_LOCK_MODIFIER || KeyDescriptor->Modifier == EFI_CAPS_LOCK_MODIFIER) {\r
- UsbKeyboardDevice->RepeatKey = 0;\r
- } else {\r
- NewRepeatKey = CurKeyCodeBuffer[Index];\r
- //\r
- // do not repeat the original repeated key\r
- //\r
- UsbKeyboardDevice->RepeatKey = 0;\r
- }\r
- }\r
- }\r
-\r
- //\r
- // Update LastKeycodeArray[] buffer in the\r
- // Usb Keyboard Device data structure.\r
- //\r
- for (Index = 0; Index < 8; Index++) {\r
- UsbKeyboardDevice->LastKeyCodeArray[Index] = CurKeyCodeBuffer[Index];\r
- }\r
-\r
- //\r
- // pre-process KeyboardBuffer, pop out the ctrl,alt,del key in sequence\r
- // and judge whether it will invoke reset event.\r
- //\r
- SavedTail = UsbKeyboardDevice->KeyboardBuffer.bTail;\r
- Index = UsbKeyboardDevice->KeyboardBuffer.bHead;\r
- while (Index != SavedTail) {\r
- RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
-\r
- KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
-\r
- switch (KeyDescriptor->Modifier) {\r
-\r
- case EFI_LEFT_CONTROL_MODIFIER:\r
- case EFI_RIGHT_CONTROL_MODIFIER:\r
- if (UsbKey.Down) {\r
- UsbKeyboardDevice->CtrlOn = 1;\r
- } else {\r
- UsbKeyboardDevice->CtrlOn = 0;\r
- }\r
- break;\r
-\r
- case EFI_LEFT_ALT_MODIFIER:\r
- case EFI_RIGHT_ALT_MODIFIER:\r
- if (UsbKey.Down) {\r
- UsbKeyboardDevice->AltOn = 1;\r
- } else {\r
- UsbKeyboardDevice->AltOn = 0;\r
- }\r
- break;\r
-\r
- case EFI_ALT_GR_MODIFIER:\r
- if (UsbKey.Down) {\r
- UsbKeyboardDevice->AltGrOn = 1;\r
- } else {\r
- UsbKeyboardDevice->AltGrOn = 0;\r
- }\r
- break;\r
-\r
- //\r
- // Del Key Code\r
- //\r
- case EFI_DELETE_MODIFIER:\r
- if (UsbKey.Down) {\r
- if (UsbKeyboardDevice->CtrlOn && UsbKeyboardDevice->AltOn) {\r
- gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
- }\r
- }\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
- //\r
- // insert the key back to the buffer.\r
- // so the key sequence will not be destroyed.\r
- //\r
- InsertKeyCode (\r
- &(UsbKeyboardDevice->KeyboardBuffer),\r
- UsbKey.KeyCode,\r
- UsbKey.Down\r
- );\r
- Index = UsbKeyboardDevice->KeyboardBuffer.bHead;\r
-\r
- }\r
- //\r
- // If have new key pressed, update the RepeatKey value, and set the\r
- // timer to repeate delay timer\r
- //\r
- if (NewRepeatKey != 0) {\r
- //\r
- // sets trigger time to "Repeat Delay Time",\r
- // to trigger the repeat timer when the key is hold long\r
- // enough time.\r
- //\r
- gBS->SetTimer (\r
- UsbKeyboardDevice->RepeatTimer,\r
- TimerRelative,\r
- USBKBD_REPEAT_DELAY\r
- );\r
- UsbKeyboardDevice->RepeatKey = NewRepeatKey;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Retrieves a key character after parsing the raw data in keyboard buffer.\r
-\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
- KeyChar Points to the Key character after key parsing.\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_NOT_READY Device is not ready\r
-\r
-**/\r
-EFI_STATUS\r
-USBParseKey (\r
- IN OUT USB_KB_DEV *UsbKeyboardDevice,\r
- OUT UINT8 *KeyChar\r
- )\r
-{\r
- USB_KEY UsbKey;\r
- EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
-\r
- *KeyChar = 0;\r
-\r
- while (!IsUSBKeyboardBufferEmpty (&UsbKeyboardDevice->KeyboardBuffer)) {\r
- //\r
- // pops one raw data off.\r
- //\r
- RemoveKeyCode (&(UsbKeyboardDevice->KeyboardBuffer), &UsbKey);\r
-\r
- KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, UsbKey.KeyCode);\r
- if (!UsbKey.Down) {\r
- switch (KeyDescriptor->Modifier) {\r
-\r
- //\r
- // CTRL release\r
- //\r
- case EFI_LEFT_CONTROL_MODIFIER:\r
- UsbKeyboardDevice->LeftCtrlOn = 0;\r
- UsbKeyboardDevice->CtrlOn = 0;\r
- break;\r
- case EFI_RIGHT_CONTROL_MODIFIER:\r
- UsbKeyboardDevice->RightCtrlOn = 0;\r
- UsbKeyboardDevice->CtrlOn = 0;\r
- break;\r
-\r
- //\r
- // Shift release\r
- //\r
- case EFI_LEFT_SHIFT_MODIFIER:\r
- UsbKeyboardDevice->LeftShiftOn = 0;\r
- UsbKeyboardDevice->ShiftOn = 0;\r
- break;\r
- case EFI_RIGHT_SHIFT_MODIFIER:\r
- UsbKeyboardDevice->RightShiftOn = 0;\r
- UsbKeyboardDevice->ShiftOn = 0;\r
- break;\r
-\r
- //\r
- // Alt release\r
- //\r
- case EFI_LEFT_ALT_MODIFIER:\r
- UsbKeyboardDevice->LeftAltOn = 0;\r
- UsbKeyboardDevice->AltOn = 0;\r
- break;\r
- case EFI_RIGHT_ALT_MODIFIER:\r
- UsbKeyboardDevice->RightAltOn = 0;\r
- UsbKeyboardDevice->AltOn = 0;\r
- break;\r
-\r
- //\r
- // Left Logo release\r
- //\r
- case EFI_LEFT_LOGO_MODIFIER:\r
- UsbKeyboardDevice->LeftLogoOn = 0;\r
- break;\r
-\r
- //\r
- // Right Logo release\r
- //\r
- case EFI_RIGHT_LOGO_MODIFIER:\r
- UsbKeyboardDevice->RightLogoOn = 0;\r
- break;\r
-\r
- //\r
- // Menu key release\r
- //\r
- case EFI_MENU_MODIFIER:\r
- UsbKeyboardDevice->MenuKeyOn = 0;\r
- break;\r
-\r
- //\r
- // SysReq release\r
- //\r
- case EFI_PRINT_MODIFIER:\r
- case EFI_SYS_REQUEST_MODIFIER:\r
- UsbKeyboardDevice->SysReqOn = 0;\r
- break;\r
-\r
- //\r
- // AltGr release\r
- //\r
- case EFI_ALT_GR_MODIFIER:\r
- UsbKeyboardDevice->AltGrOn = 0;\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
- continue;\r
- }\r
-\r
- //\r
- // Analyzes key pressing situation\r
- //\r
- switch (KeyDescriptor->Modifier) {\r
-\r
- //\r
- // CTRL press\r
- //\r
- case EFI_LEFT_CONTROL_MODIFIER:\r
- UsbKeyboardDevice->LeftCtrlOn = 1;\r
- UsbKeyboardDevice->CtrlOn = 1;\r
- continue;\r
- break;\r
- case EFI_RIGHT_CONTROL_MODIFIER:\r
- UsbKeyboardDevice->RightCtrlOn = 1;\r
- UsbKeyboardDevice->CtrlOn = 1;\r
- continue;\r
- break;\r
-\r
- //\r
- // Shift press\r
- //\r
- case EFI_LEFT_SHIFT_MODIFIER:\r
- UsbKeyboardDevice->LeftShiftOn = 1;\r
- UsbKeyboardDevice->ShiftOn = 1;\r
- continue;\r
- break;\r
- case EFI_RIGHT_SHIFT_MODIFIER:\r
- UsbKeyboardDevice->RightShiftOn = 1;\r
- UsbKeyboardDevice->ShiftOn = 1;\r
- continue;\r
- break;\r
-\r
- //\r
- // Alt press\r
- //\r
- case EFI_LEFT_ALT_MODIFIER:\r
- UsbKeyboardDevice->LeftAltOn = 1;\r
- UsbKeyboardDevice->AltOn = 1;\r
- continue;\r
- break;\r
- case EFI_RIGHT_ALT_MODIFIER:\r
- UsbKeyboardDevice->RightAltOn = 1;\r
- UsbKeyboardDevice->AltOn = 1;\r
- continue;\r
- break;\r
-\r
- //\r
- // Left Logo press\r
- //\r
- case EFI_LEFT_LOGO_MODIFIER:\r
- UsbKeyboardDevice->LeftLogoOn = 1;\r
- break;\r
-\r
- //\r
- // Right Logo press\r
- //\r
- case EFI_RIGHT_LOGO_MODIFIER:\r
- UsbKeyboardDevice->RightLogoOn = 1;\r
- break;\r
-\r
- //\r
- // Menu key press\r
- //\r
- case EFI_MENU_MODIFIER:\r
- UsbKeyboardDevice->MenuKeyOn = 1;\r
- break;\r
-\r
- //\r
- // SysReq press\r
- //\r
- case EFI_PRINT_MODIFIER:\r
- case EFI_SYS_REQUEST_MODIFIER:\r
- UsbKeyboardDevice->SysReqOn = 1;\r
- continue;\r
- break;\r
-\r
- //\r
- // AltGr press\r
- //\r
- case EFI_ALT_GR_MODIFIER:\r
- UsbKeyboardDevice->AltGrOn = 1;\r
- break;\r
-\r
- case EFI_NUM_LOCK_MODIFIER:\r
- UsbKeyboardDevice->NumLockOn ^= 1;\r
- //\r
- // Turn on the NumLock light on KB\r
- //\r
- SetKeyLED (UsbKeyboardDevice);\r
- continue;\r
- break;\r
-\r
- case EFI_CAPS_LOCK_MODIFIER:\r
- UsbKeyboardDevice->CapsOn ^= 1;\r
- //\r
- // Turn on the CapsLock light on KB\r
- //\r
- SetKeyLED (UsbKeyboardDevice);\r
- continue;\r
- break;\r
-\r
- case EFI_SCROLL_LOCK_MODIFIER:\r
- UsbKeyboardDevice->ScrollOn ^= 1;\r
- //\r
- // Turn on the ScrollLock light on KB\r
- //\r
- SetKeyLED (UsbKeyboardDevice);\r
- continue;\r
- break;\r
-\r
- //\r
- // F11,F12,PrintScreen,Pause/Break\r
- // could not be retrieved via SimpleTxtInEx protocol\r
- //\r
- case EFI_FUNCTION_KEY_ELEVEN_MODIFIER:\r
- case EFI_FUNCTION_KEY_TWELVE_MODIFIER:\r
- case EFI_PAUSE_MODIFIER:\r
- case EFI_BREAK_MODIFIER:\r
- //\r
- // fall through\r
- //\r
- continue;\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
- //\r
- // When encountered Del Key...\r
- //\r
- if (KeyDescriptor->Modifier == EFI_DELETE_MODIFIER) {\r
- if (UsbKeyboardDevice->CtrlOn && UsbKeyboardDevice->AltOn) {\r
- gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
- }\r
- }\r
-\r
- *KeyChar = UsbKey.KeyCode;\r
- return EFI_SUCCESS;\r
- }\r
-\r
- return EFI_NOT_READY;\r
-}\r
-\r
-\r
-\r
-/**\r
- Converts USB Keyboard code to EFI Scan Code.\r
-\r
- UsbKeyboardDevice The USB_KB_DEV instance.\r
- KeyChar Indicates the key code that will be interpreted.\r
- Key A pointer to a buffer that is filled in with\r
- the keystroke information for the key that\r
- was pressed.\r
-\r
- @retval EFI_NOT_READY Device is not ready\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-EFI_STATUS\r
-USBKeyCodeToEFIScanCode (\r
- IN USB_KB_DEV *UsbKeyboardDevice,\r
- IN UINT8 KeyChar,\r
- OUT EFI_INPUT_KEY *Key\r
- )\r
-{\r
- UINT8 Index;\r
- EFI_KEY_DESCRIPTOR *KeyDescriptor;\r
-\r
- if (!USBKBD_VALID_KEYCODE (KeyChar)) {\r
- return EFI_NOT_READY;\r
- }\r
-\r
- //\r
- // valid USB Key Code starts from 4\r
- //\r
- Index = (UINT8) (KeyChar - 4);\r
-\r
- if (Index >= USB_KEYCODE_MAX_MAKE) {\r
- return EFI_NOT_READY;\r
- }\r
-\r
- KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, KeyChar);\r
-\r
- //\r
- // Check for Non-spacing key\r
- //\r
- if (KeyDescriptor->Modifier == EFI_NS_KEY_MODIFIER) {\r
- UsbKeyboardDevice->CurrentNsKey = FindUsbNsKey (UsbKeyboardDevice, KeyDescriptor);\r
- return EFI_NOT_READY;\r
- }\r
-\r
- //\r
- // Check whether this keystroke follows a Non-spacing key\r
- //\r
- if (UsbKeyboardDevice->CurrentNsKey != NULL) {\r
- KeyDescriptor = FindPhysicalKey (UsbKeyboardDevice->CurrentNsKey, KeyDescriptor);\r
- UsbKeyboardDevice->CurrentNsKey = NULL;\r
- }\r
-\r
- Key->ScanCode = EfiScanCodeConvertionTable[KeyDescriptor->Modifier];\r
- Key->UnicodeChar = KeyDescriptor->Unicode;\r
-\r
- if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_STANDARD_SHIFT) {\r
- if (UsbKeyboardDevice->ShiftOn) {\r
- Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
-\r
- //\r
- // Need not return associated shift state if a class of printable characters that\r
- // are normally adjusted by shift modifiers. e.g. Shift Key + 'f' key = 'F'\r
- //\r
- if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) {\r
- UsbKeyboardDevice->LeftShiftOn = 0;\r
- UsbKeyboardDevice->RightShiftOn = 0;\r
- }\r
-\r
- if (UsbKeyboardDevice->AltGrOn) {\r
- Key->UnicodeChar = KeyDescriptor->ShiftedAltGrUnicode;\r
- }\r
- } else {\r
- //\r
- // Shift off\r
- //\r
- Key->UnicodeChar = KeyDescriptor->Unicode;\r
-\r
- if (UsbKeyboardDevice->AltGrOn) {\r
- Key->UnicodeChar = KeyDescriptor->AltGrUnicode;\r
- }\r
- }\r
- }\r
-\r
- if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_CAPS_LOCK) {\r
- if (UsbKeyboardDevice->CapsOn) {\r
-\r
- if (Key->UnicodeChar == KeyDescriptor->Unicode) {\r
-\r
- Key->UnicodeChar = KeyDescriptor->ShiftedUnicode;\r
-\r
- } else if (Key->UnicodeChar == KeyDescriptor->ShiftedUnicode) {\r
-\r
- Key->UnicodeChar = KeyDescriptor->Unicode;\r
-\r
- }\r
- }\r
- }\r
-\r
- //\r
- // Translate the CTRL-Alpha characters to their corresponding control value (ctrl-a = 0x0001 through ctrl-Z = 0x001A)\r
- //\r
- if (UsbKeyboardDevice->CtrlOn) {\r
- if (Key->UnicodeChar >= 'a' && Key->UnicodeChar <= 'z') {\r
- Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'a' + 1);\r
- } else if (Key->UnicodeChar >= 'A' && Key->UnicodeChar <= 'Z') {\r
- Key->UnicodeChar = (UINT8) (Key->UnicodeChar - 'A' + 1);\r
- }\r
- }\r
-\r
- if (KeyDescriptor->AffectedAttribute & EFI_AFFECTED_BY_NUM_LOCK) {\r
-\r
- if (UsbKeyboardDevice->NumLockOn && !UsbKeyboardDevice->ShiftOn) {\r
-\r
- Key->ScanCode = SCAN_NULL;\r
-\r
- } else {\r
- Key->UnicodeChar = 0x00;\r
- }\r
- }\r
-\r
- //\r
- // Translate Unicode 0x1B (ESC) to EFI Scan Code\r
- //\r
- if (Key->UnicodeChar == 0x1B && Key->ScanCode == SCAN_NULL) {\r
- Key->ScanCode = SCAN_ESC;\r
- Key->UnicodeChar = 0x00;\r
- }\r
-\r
- if (Key->UnicodeChar == 0 && Key->ScanCode == SCAN_NULL) {\r
- return EFI_NOT_READY;\r
- }\r
-\r
-\r
- //\r
- // Save Shift/Toggle state\r
- //\r
- if (UsbKeyboardDevice->LeftCtrlOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_CONTROL_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->RightCtrlOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_CONTROL_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->LeftAltOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_ALT_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->RightAltOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_ALT_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->LeftShiftOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_SHIFT_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->RightShiftOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_SHIFT_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->LeftLogoOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_LEFT_LOGO_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->RightLogoOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_RIGHT_LOGO_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->MenuKeyOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_MENU_KEY_PRESSED;\r
- }\r
- if (UsbKeyboardDevice->SysReqOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyShiftState |= EFI_SYS_REQ_PRESSED;\r
- }\r
-\r
- if (UsbKeyboardDevice->ScrollOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
- }\r
- if (UsbKeyboardDevice->NumLockOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
- }\r
- if (UsbKeyboardDevice->CapsOn == 1) {\r
- UsbKeyboardDevice->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-\r
-}\r
-\r
-\r
-\r
-/**\r
- Resets USB Keyboard Buffer.\r
-\r
- @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
-\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-EFI_STATUS\r
-InitUSBKeyBuffer (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer\r
- )\r
-{\r
- ZeroMem (KeyboardBuffer, sizeof (USB_KB_BUFFER));\r
-\r
- KeyboardBuffer->bHead = KeyboardBuffer->bTail;\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Check whether USB Keyboard buffer is empty.\r
-\r
- @param KeyboardBuffer USB Keyboard Buffer.\r
-\r
-\r
-**/\r
-BOOLEAN\r
-IsUSBKeyboardBufferEmpty (\r
- IN USB_KB_BUFFER *KeyboardBuffer\r
- )\r
-{\r
- //\r
- // meet FIFO empty condition\r
- //\r
- return (BOOLEAN) (KeyboardBuffer->bHead == KeyboardBuffer->bTail);\r
-}\r
-\r
-\r
-\r
-/**\r
- Check whether USB Keyboard buffer is full.\r
-\r
- @param KeyboardBuffer USB Keyboard Buffer.\r
-\r
-\r
-**/\r
-BOOLEAN\r
-IsUSBKeyboardBufferFull (\r
- IN USB_KB_BUFFER *KeyboardBuffer\r
- )\r
-{\r
- return (BOOLEAN)(((KeyboardBuffer->bTail + 1) % (MAX_KEY_ALLOWED + 1)) ==\r
- KeyboardBuffer->bHead);\r
-}\r
-\r
-\r
-\r
-/**\r
- Inserts a key code into keyboard buffer.\r
-\r
- @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
- @param Key Key code\r
- @param Down Special key\r
-\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-EFI_STATUS\r
-InsertKeyCode (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
- IN UINT8 Key,\r
- IN UINT8 Down\r
- )\r
-{\r
- USB_KEY UsbKey;\r
-\r
- //\r
- // if keyboard buffer is full, throw the\r
- // first key out of the keyboard buffer.\r
- //\r
- if (IsUSBKeyboardBufferFull (KeyboardBuffer)) {\r
- RemoveKeyCode (KeyboardBuffer, &UsbKey);\r
- }\r
-\r
- KeyboardBuffer->buffer[KeyboardBuffer->bTail].KeyCode = Key;\r
- KeyboardBuffer->buffer[KeyboardBuffer->bTail].Down = Down;\r
-\r
- //\r
- // adjust the tail pointer of the FIFO keyboard buffer.\r
- //\r
- KeyboardBuffer->bTail = (UINT8) ((KeyboardBuffer->bTail + 1) % (MAX_KEY_ALLOWED + 1));\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Pops a key code off from keyboard buffer.\r
-\r
- @param KeyboardBuffer Points to the USB Keyboard Buffer.\r
- @param UsbKey Points to the buffer that contains a usb key code.\r
-\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_DEVICE_ERROR Hardware Error\r
-\r
-**/\r
-EFI_STATUS\r
-RemoveKeyCode (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
- OUT USB_KEY *UsbKey\r
- )\r
-{\r
- if (IsUSBKeyboardBufferEmpty (KeyboardBuffer)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- UsbKey->KeyCode = KeyboardBuffer->buffer[KeyboardBuffer->bHead].KeyCode;\r
- UsbKey->Down = KeyboardBuffer->buffer[KeyboardBuffer->bHead].Down;\r
-\r
- //\r
- // adjust the head pointer of the FIFO keyboard buffer.\r
- //\r
- KeyboardBuffer->bHead = (UINT8) ((KeyboardBuffer->bHead + 1) % (MAX_KEY_ALLOWED + 1));\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Sets USB Keyboard LED state.\r
-\r
- @param UsbKeyboardDevice The USB_KB_DEV instance.\r
-\r
- @retval EFI_SUCCESS Success\r
-\r
-**/\r
-EFI_STATUS\r
-SetKeyLED (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- )\r
-{\r
- LED_MAP Led;\r
- UINT8 ReportId;\r
-\r
- //\r
- // Set each field in Led map.\r
- //\r
- Led.NumLock = (UINT8) UsbKeyboardDevice->NumLockOn;\r
- Led.CapsLock = (UINT8) UsbKeyboardDevice->CapsOn;\r
- Led.ScrollLock = (UINT8) UsbKeyboardDevice->ScrollOn;\r
- Led.Resrvd = 0;\r
-\r
- ReportId = 0;\r
- //\r
- // call Set Report Request to lighten the LED.\r
- //\r
- UsbSetReportRequest (\r
- UsbKeyboardDevice->UsbIo,\r
- UsbKeyboardDevice->InterfaceDescriptor.InterfaceNumber,\r
- ReportId,\r
- HID_OUTPUT_REPORT,\r
- 1,\r
- (UINT8 *) &Led\r
- );\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Timer handler for Repeat Key timer.\r
-\r
- @param Event The Repeat Key event.\r
- @param Context Points to the USB_KB_DEV instance.\r
-\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-USBKeyboardRepeatHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
- USB_KB_DEV *UsbKeyboardDevice;\r
-\r
- UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
-\r
- //\r
- // Do nothing when there is no repeat key.\r
- //\r
- if (UsbKeyboardDevice->RepeatKey != 0) {\r
- //\r
- // Inserts one Repeat key into keyboard buffer,\r
- //\r
- InsertKeyCode (\r
- &(UsbKeyboardDevice->KeyboardBuffer),\r
- UsbKeyboardDevice->RepeatKey,\r
- 1\r
- );\r
-\r
- //\r
- // set repeate rate for repeat key generation.\r
- //\r
- gBS->SetTimer (\r
- UsbKeyboardDevice->RepeatTimer,\r
- TimerRelative,\r
- USBKBD_REPEAT_RATE\r
- );\r
-\r
- }\r
-}\r
-\r
-\r
-/**\r
- Timer handler for Delayed Recovery timer.\r
-\r
- @param Event The Delayed Recovery event.\r
- @param Context Points to the USB_KB_DEV instance.\r
-\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-USBKeyboardRecoveryHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
-\r
- USB_KB_DEV *UsbKeyboardDevice;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- UINT8 PacketSize;\r
-\r
- UsbKeyboardDevice = (USB_KB_DEV *) Context;\r
-\r
- UsbIo = UsbKeyboardDevice->UsbIo;\r
-\r
- PacketSize = (UINT8) (UsbKeyboardDevice->IntEndpointDescriptor.MaxPacketSize);\r
-\r
- UsbIo->UsbAsyncInterruptTransfer (\r
- UsbIo,\r
- UsbKeyboardDevice->IntEndpointDescriptor.EndpointAddress,\r
- TRUE,\r
- UsbKeyboardDevice->IntEndpointDescriptor.Interval,\r
- PacketSize,\r
- KeyboardHandler,\r
- UsbKeyboardDevice\r
- );\r
-}\r
+++ /dev/null
-/** @file\r
-Copyright (c) 2004 - 2005, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
- Keyboard.h\r
-\r
-Abstract:\r
-\r
- Function prototype for USB Keyboard Driver\r
-\r
-Revision History\r
-\r
-**/\r
-\r
-#ifndef _KEYBOARD_H\r
-#define _KEYBOARD_H\r
-\r
-\r
-#include "efikey.h"\r
-\r
-BOOLEAN\r
-IsUSBKeyboard (\r
- IN EFI_USB_IO_PROTOCOL *UsbIo\r
- );\r
-\r
-EFI_STATUS\r
-InitUSBKeyboard (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- );\r
-\r
-EFI_STATUS\r
-InitKeyboardLayout (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- );\r
-\r
-VOID\r
-ReleaseKeyboardLayoutResources (\r
- USB_KB_DEV *UsbKeyboardDevice\r
- );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-KeyboardHandler (\r
- IN VOID *Data,\r
- IN UINTN DataLength,\r
- IN VOID *Context,\r
- IN UINT32 Result\r
- );\r
-\r
-VOID\r
-EFIAPI\r
-USBKeyboardRecoveryHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- );\r
-\r
-EFI_STATUS\r
-USBParseKey (\r
- IN OUT USB_KB_DEV *UsbKeyboardDevice,\r
- OUT UINT8 *KeyChar\r
- );\r
-\r
-EFI_STATUS\r
-USBKeyCodeToEFIScanCode (\r
- IN USB_KB_DEV *UsbKeyboardDevice,\r
- IN UINT8 KeyChar,\r
- OUT EFI_INPUT_KEY *Key\r
- );\r
-\r
-EFI_STATUS\r
-InitUSBKeyBuffer (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer\r
- );\r
-\r
-BOOLEAN\r
-IsUSBKeyboardBufferEmpty (\r
- IN USB_KB_BUFFER *KeyboardBuffer\r
- );\r
-\r
-BOOLEAN\r
-IsUSBKeyboardBufferFull (\r
- IN USB_KB_BUFFER *KeyboardBuffer\r
- );\r
-\r
-EFI_STATUS\r
-InsertKeyCode (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
- IN UINT8 Key,\r
- IN UINT8 Down\r
- );\r
-\r
-EFI_STATUS\r
-RemoveKeyCode (\r
- IN OUT USB_KB_BUFFER *KeyboardBuffer,\r
- OUT USB_KEY *UsbKey\r
- );\r
-\r
-VOID\r
-EFIAPI\r
-USBKeyboardRepeatHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- );\r
-\r
-EFI_STATUS\r
-SetKeyLED (\r
- IN USB_KB_DEV *UsbKeyboardDevice\r
- );\r
-\r
-#endif\r
projects / mirror_edk2.git / commitdiff