From 3765794ca3c034c792bc3009fb96e12b4582ecee Mon Sep 17 00:00:00 2001 From: qianouyang Date: Fri, 30 Sep 2011 07:28:16 +0000 Subject: [PATCH] 1. Add Partial Keystroke Support in UsbKb drivers. See the Uefi2.3.1a chapter 11.2 Signed-off-by: qianouyang Reviewed-by: niruiyu vanjeff git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12494 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 150 +++++++++++++++-------- MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 8 +- MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c | 56 ++++----- 3 files changed, 130 insertions(+), 84 deletions(-) diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c index fa1c7e076b..c576b70f46 100644 --- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c +++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c @@ -259,9 +259,9 @@ USBKeyboardDriverBindingStart ( UsbKeyboardDevice->SimpleInputEx.SetState = USBKeyboardSetState; UsbKeyboardDevice->SimpleInputEx.RegisterKeyNotify = USBKeyboardRegisterKeyNotify; UsbKeyboardDevice->SimpleInputEx.UnregisterKeyNotify = USBKeyboardUnregisterKeyNotify; - + InitializeListHead (&UsbKeyboardDevice->NotifyList); - + Status = gBS->CreateEvent ( EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_NOTIFY, @@ -546,7 +546,7 @@ USBKeyboardDriverBindingStop ( DestroyQueue (&UsbKeyboardDevice->UsbKeyQueue); DestroyQueue (&UsbKeyboardDevice->EfiKeyQueue); - + FreePool (UsbKeyboardDevice); return Status; @@ -676,14 +676,25 @@ USBKeyboardReadKeyStroke ( UsbKeyboardDevice = USB_KB_DEV_FROM_THIS (This); - Status = USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, &KeyData); - if (EFI_ERROR (Status)) { - return Status; + // + // Considering if the partial keystroke is enabled, there maybe a partial + // keystroke in the queue, so here skip the partial keystroke and get the + // next key from the queue + // + while (1) { + Status = USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, &KeyData); + if (EFI_ERROR (Status)) { + return Status; + } + // + // SimpleTextIn Protocol doesn't support partial keystroke; + // + if (KeyData.Key.ScanCode == CHAR_NULL && KeyData.Key.UnicodeChar == SCAN_NULL) { + continue; + } + CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY)); + return EFI_SUCCESS; } - - CopyMem (Key, &KeyData.Key, sizeof (EFI_INPUT_KEY)); - - return EFI_SUCCESS; } @@ -703,15 +714,42 @@ USBKeyboardWaitForKey ( ) { USB_KB_DEV *UsbKeyboardDevice; + EFI_KEY_DATA KeyData; + EFI_TPL OldTpl; UsbKeyboardDevice = (USB_KB_DEV *) Context; - if (!IsQueueEmpty (&UsbKeyboardDevice->EfiKeyQueue)) { + // + // Enter critical section + // + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + + // + // WaitforKey doesn't suppor the partial key. + // Considering if the partial keystroke is enabled, there maybe a partial + // keystroke in the queue, so here skip the partial keystroke and get the + // next key from the queue + // + while (!IsQueueEmpty (&UsbKeyboardDevice->EfiKeyQueue)) { // // If there is pending key, signal the event. // + CopyMem ( + &KeyData, + UsbKeyboardDevice->EfiKeyQueue.Buffer[UsbKeyboardDevice->EfiKeyQueue.Head], + sizeof (EFI_KEY_DATA) + ); + if (KeyData.Key.ScanCode == SCAN_NULL && KeyData.Key.UnicodeChar == CHAR_NULL) { + Dequeue (&UsbKeyboardDevice->EfiKeyQueue, &KeyData, sizeof (EFI_KEY_DATA)); + continue; + } gBS->SignalEvent (Event); + break; } + // + // Leave critical section and return + // + gBS->RestoreTPL (OldTpl); } /** @@ -733,7 +771,7 @@ USBKeyboardTimerHandler ( EFI_KEY_DATA KeyData; UsbKeyboardDevice = (USB_KB_DEV *) Context; - + // // Fetch raw data from the USB keyboard buffer, // and translate it into USB keycode. @@ -783,7 +821,7 @@ KbdFreeNotifyList ( RemoveEntryList (Link); FreePool (NotifyNode); } - + return EFI_SUCCESS; } @@ -804,29 +842,29 @@ IsKeyRegistered ( ) { ASSERT (RegsiteredData != NULL && InputData != NULL); - + if ((RegsiteredData->Key.ScanCode != InputData->Key.ScanCode) || (RegsiteredData->Key.UnicodeChar != InputData->Key.UnicodeChar)) { - return FALSE; - } - + return FALSE; + } + // // Assume KeyShiftState/KeyToggleState = 0 in Registered key data means these state could be ignored. // if (RegsiteredData->KeyState.KeyShiftState != 0 && RegsiteredData->KeyState.KeyShiftState != InputData->KeyState.KeyShiftState) { - return FALSE; - } + return FALSE; + } if (RegsiteredData->KeyState.KeyToggleState != 0 && RegsiteredData->KeyState.KeyToggleState != InputData->KeyState.KeyToggleState) { - return FALSE; - } - + return FALSE; + } + return TRUE; } // -// Simple Text Input Ex protocol functions +// Simple Text Input Ex protocol functions // /** Resets the input device hardware. @@ -867,6 +905,9 @@ USBKeyboardResetEx ( return EFI_DEVICE_ERROR; } + UsbKeyboardDevice->KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID; + UsbKeyboardDevice->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID; + return EFI_SUCCESS; } @@ -901,7 +942,7 @@ USBKeyboardReadKeyStrokeEx ( UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This); return USBKeyboardReadKeyStrokeWorker (UsbKeyboardDevice, KeyData); - + } /** @@ -933,7 +974,8 @@ USBKeyboardSetState ( UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This); - if ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) { + if (((UsbKeyboardDevice->KeyState.KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) || + ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID)) { return EFI_UNSUPPORTED; } @@ -944,7 +986,8 @@ USBKeyboardSetState ( UsbKeyboardDevice->ScrollOn = FALSE; UsbKeyboardDevice->NumLockOn = FALSE; UsbKeyboardDevice->CapsOn = FALSE; - + UsbKeyboardDevice->IsSupportPartialKey = FALSE; + if ((*KeyToggleState & EFI_SCROLL_LOCK_ACTIVE) == EFI_SCROLL_LOCK_ACTIVE) { UsbKeyboardDevice->ScrollOn = TRUE; } @@ -954,11 +997,16 @@ USBKeyboardSetState ( if ((*KeyToggleState & EFI_CAPS_LOCK_ACTIVE) == EFI_CAPS_LOCK_ACTIVE) { UsbKeyboardDevice->CapsOn = TRUE; } + if ((*KeyToggleState & EFI_KEY_STATE_EXPOSED) == EFI_KEY_STATE_EXPOSED) { + UsbKeyboardDevice->IsSupportPartialKey = TRUE; + } SetKeyLED (UsbKeyboardDevice); + UsbKeyboardDevice->KeyState.KeyToggleState = *KeyToggleState; + return EFI_SUCCESS; - + } /** @@ -989,7 +1037,7 @@ USBKeyboardRegisterKeyNotify ( KEYBOARD_CONSOLE_IN_EX_NOTIFY *NewNotify; LIST_ENTRY *Link; LIST_ENTRY *NotifyList; - KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; + KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; if (KeyData == NULL || NotifyHandle == NULL || KeyNotificationFunction == NULL) { return EFI_INVALID_PARAMETER; @@ -1001,43 +1049,43 @@ USBKeyboardRegisterKeyNotify ( // Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered. // NotifyList = &UsbKeyboardDevice->NotifyList; - + for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList, Link); Link = GetNextNode (NotifyList, Link)) { CurrentNotify = CR ( - Link, - KEYBOARD_CONSOLE_IN_EX_NOTIFY, - NotifyEntry, + Link, + KEYBOARD_CONSOLE_IN_EX_NOTIFY, + NotifyEntry, USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE ); - if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { + if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) { - *NotifyHandle = CurrentNotify->NotifyHandle; + *NotifyHandle = CurrentNotify->NotifyHandle; return EFI_SUCCESS; } } } - + // // Allocate resource to save the notification function - // + // NewNotify = (KEYBOARD_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (KEYBOARD_CONSOLE_IN_EX_NOTIFY)); if (NewNotify == NULL) { return EFI_OUT_OF_RESOURCES; } - NewNotify->Signature = USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE; + NewNotify->Signature = USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE; NewNotify->KeyNotificationFn = KeyNotificationFunction; NewNotify->NotifyHandle = (EFI_HANDLE) NewNotify; CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA)); InsertTailList (&UsbKeyboardDevice->NotifyList, &NewNotify->NotifyEntry); - *NotifyHandle = NewNotify->NotifyHandle; - + *NotifyHandle = NewNotify->NotifyHandle; + return EFI_SUCCESS; - + } /** @@ -1064,14 +1112,14 @@ USBKeyboardUnregisterKeyNotify ( if (NotificationHandle == NULL) { return EFI_INVALID_PARAMETER; - } + } if (((KEYBOARD_CONSOLE_IN_EX_NOTIFY *) NotificationHandle)->Signature != USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE) { return EFI_INVALID_PARAMETER; - } - + } + UsbKeyboardDevice = TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS (This); - + // // Traverse notify list of USB keyboard and remove the entry of NotificationHandle. // @@ -1080,18 +1128,18 @@ USBKeyboardUnregisterKeyNotify ( !IsNull (NotifyList, Link); Link = GetNextNode (NotifyList, Link)) { CurrentNotify = CR ( - Link, - KEYBOARD_CONSOLE_IN_EX_NOTIFY, - NotifyEntry, + Link, + KEYBOARD_CONSOLE_IN_EX_NOTIFY, + NotifyEntry, USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE - ); + ); if (CurrentNotify->NotifyHandle == NotificationHandle) { // // Remove the notification function from NotifyList and free resources // - RemoveEntryList (&CurrentNotify->NotifyEntry); + RemoveEntryList (&CurrentNotify->NotifyEntry); - FreePool (CurrentNotify); + FreePool (CurrentNotify); return EFI_SUCCESS; } } @@ -1099,6 +1147,6 @@ USBKeyboardUnregisterKeyNotify ( // // Cannot find the matching entry in database. // - return EFI_INVALID_PARAMETER; + return EFI_INVALID_PARAMETER; } diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h index 2066c38e7e..3ce383b33e 100644 --- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h +++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h @@ -130,7 +130,7 @@ typedef struct { EFI_EVENT RepeatTimer; EFI_UNICODE_STRING_TABLE *ControllerNameTable; - + BOOLEAN LeftCtrlOn; BOOLEAN LeftAltOn; BOOLEAN LeftShiftOn; @@ -138,10 +138,14 @@ typedef struct { BOOLEAN RightCtrlOn; BOOLEAN RightAltOn; BOOLEAN RightShiftOn; - BOOLEAN RightLogoOn; + BOOLEAN RightLogoOn; BOOLEAN MenuKeyOn; BOOLEAN SysReqOn; BOOLEAN AltGrOn; + + BOOLEAN IsSupportPartialKey; + + EFI_KEY_STATE KeyState; // // Notification function list // diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c index fe6121985c..8c67f67561 100644 --- a/MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c +++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/KeyBoard.c @@ -296,10 +296,17 @@ UINT8 ModifierValueToEfiScanCodeConvertionTable[] = { SCAN_F10, // EFI_FUNCTION_KEY_TEN_MODIFIER SCAN_F11, // EFI_FUNCTION_KEY_ELEVEN_MODIFIER SCAN_F12, // EFI_FUNCTION_KEY_TWELVE_MODIFIER + // + // For Partial Keystroke support + // SCAN_NULL, // EFI_PRINT_MODIFIER SCAN_NULL, // EFI_SYS_REQUEST_MODIFIER SCAN_NULL, // EFI_SCROLL_LOCK_MODIFIER - SCAN_PAUSE // EFI_PAUSE_MODIFIER + SCAN_PAUSE, // EFI_PAUSE_MODIFIER + SCAN_NULL, // EFI_BREAK_MODIFIER + SCAN_NULL, // EFI_LEFT_LOGO_MODIFIER + SCAN_NULL, // EFI_RIGHT_LOGO_MODIFER + SCAN_NULL, // EFI_MENU_MODIFER }; /** @@ -507,7 +514,7 @@ FindUsbNsKey ( LIST_ENTRY *Link; LIST_ENTRY *NsKeyList; USB_NS_KEY *UsbNsKey; - + NsKeyList = &UsbKeyboardDevice->NsKeyList; Link = GetFirstNode (NsKeyList); while (!IsNull (NsKeyList, Link)) { @@ -780,7 +787,7 @@ InitKeyboardLayout ( // InstallDefaultKeyboardLayout (UsbKeyboardDevice); } - + return EFI_SUCCESS; } @@ -820,14 +827,14 @@ InitUSBKeyboard ( // Assumed the first config is the correct one and this is not always the case // Status = UsbGetConfiguration ( - UsbKeyboardDevice->UsbIo, - &ConfigValue, + UsbKeyboardDevice->UsbIo, + &ConfigValue, &TransferResult ); if (EFI_ERROR (Status)) { ConfigValue = 0x01; } - + // // Uses default configuration to configure the USB Keyboard device. // @@ -891,7 +898,7 @@ InitUSBKeyboard ( UsbKeyboardDevice->NumLockOn = FALSE; UsbKeyboardDevice->CapsOn = FALSE; UsbKeyboardDevice->ScrollOn = FALSE; - + UsbKeyboardDevice->LeftCtrlOn = FALSE; UsbKeyboardDevice->LeftAltOn = FALSE; UsbKeyboardDevice->LeftShiftOn = FALSE; @@ -1033,7 +1040,7 @@ KeyboardHandler ( // // Delete & Submit this interrupt again - // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt. + // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt. // UsbIo->UsbAsyncInterruptTransfer ( UsbIo, @@ -1382,12 +1389,10 @@ USBParseKey ( case EFI_LEFT_CONTROL_MODIFIER: UsbKeyboardDevice->LeftCtrlOn = TRUE; UsbKeyboardDevice->CtrlOn = TRUE; - continue; break; case EFI_RIGHT_CONTROL_MODIFIER: UsbKeyboardDevice->RightCtrlOn = TRUE; UsbKeyboardDevice->CtrlOn = TRUE; - continue; break; // @@ -1396,12 +1401,10 @@ USBParseKey ( case EFI_LEFT_SHIFT_MODIFIER: UsbKeyboardDevice->LeftShiftOn = TRUE; UsbKeyboardDevice->ShiftOn = TRUE; - continue; break; case EFI_RIGHT_SHIFT_MODIFIER: UsbKeyboardDevice->RightShiftOn = TRUE; UsbKeyboardDevice->ShiftOn = TRUE; - continue; break; // @@ -1410,12 +1413,10 @@ USBParseKey ( case EFI_LEFT_ALT_MODIFIER: UsbKeyboardDevice->LeftAltOn = TRUE; UsbKeyboardDevice->AltOn = TRUE; - continue; break; case EFI_RIGHT_ALT_MODIFIER: UsbKeyboardDevice->RightAltOn = TRUE; UsbKeyboardDevice->AltOn = TRUE; - continue; break; // @@ -1445,7 +1446,6 @@ USBParseKey ( case EFI_PRINT_MODIFIER: case EFI_SYS_REQUEST_MODIFIER: UsbKeyboardDevice->SysReqOn = TRUE; - continue; break; // @@ -1461,7 +1461,6 @@ USBParseKey ( // UsbKeyboardDevice->NumLockOn = (BOOLEAN) (!(UsbKeyboardDevice->NumLockOn)); SetKeyLED (UsbKeyboardDevice); - continue; break; case EFI_CAPS_LOCK_MODIFIER: @@ -1470,7 +1469,6 @@ USBParseKey ( // UsbKeyboardDevice->CapsOn = (BOOLEAN) (!(UsbKeyboardDevice->CapsOn)); SetKeyLED (UsbKeyboardDevice); - continue; break; case EFI_SCROLL_LOCK_MODIFIER: @@ -1479,7 +1477,6 @@ USBParseKey ( // UsbKeyboardDevice->ScrollOn = (BOOLEAN) (!(UsbKeyboardDevice->ScrollOn)); SetKeyLED (UsbKeyboardDevice); - continue; break; default: @@ -1529,18 +1526,11 @@ UsbKeyCodeToEfiInputKey ( EFI_KEY_DESCRIPTOR *KeyDescriptor; LIST_ENTRY *Link; LIST_ENTRY *NotifyList; - KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; + KEYBOARD_CONSOLE_IN_EX_NOTIFY *CurrentNotify; // - // KeyCode must in the range of 0x4 to 0x65 + // KeyCode must in the range of [0x4, 0x65] or [0xe0, 0xe7]. // - if (!USBKBD_VALID_KEYCODE (KeyCode)) { - return EFI_INVALID_PARAMETER; - } - if ((KeyCode - 4) >= NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE) { - return EFI_INVALID_PARAMETER; - } - KeyDescriptor = GetKeyDescriptor (UsbKeyboardDevice, KeyCode); ASSERT (KeyDescriptor != NULL); @@ -1618,7 +1608,7 @@ UsbKeyCodeToEfiInputKey ( if ((UsbKeyboardDevice->NumLockOn) && (!(UsbKeyboardDevice->ShiftOn))) { KeyData->Key.ScanCode = SCAN_NULL; } else { - KeyData->Key.UnicodeChar = 0x00; + KeyData->Key.UnicodeChar = CHAR_NULL; } } @@ -1627,14 +1617,16 @@ UsbKeyCodeToEfiInputKey ( // if (KeyData->Key.UnicodeChar == 0x1B && KeyData->Key.ScanCode == SCAN_NULL) { KeyData->Key.ScanCode = SCAN_ESC; - KeyData->Key.UnicodeChar = 0x00; + KeyData->Key.UnicodeChar = CHAR_NULL; } // // Not valid for key without both unicode key code and EFI Scan Code. // if (KeyData->Key.UnicodeChar == 0 && KeyData->Key.ScanCode == SCAN_NULL) { + if (!UsbKeyboardDevice->IsSupportPartialKey) { return EFI_NOT_READY; + } } // @@ -1683,14 +1675,16 @@ UsbKeyCodeToEfiInputKey ( if (UsbKeyboardDevice->CapsOn) { KeyData->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE; } - + if (UsbKeyboardDevice->IsSupportPartialKey) { + KeyData->KeyState.KeyToggleState |= EFI_KEY_STATE_EXPOSED; + } // // Invoke notification functions if the key is registered. // NotifyList = &UsbKeyboardDevice->NotifyList; for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList, Link); Link = GetNextNode (NotifyList, Link)) { CurrentNotify = CR (Link, KEYBOARD_CONSOLE_IN_EX_NOTIFY, NotifyEntry, USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE); - if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { + if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { CurrentNotify->KeyNotificationFn (KeyData); } } -- 2.39.2