Nt32Pkg/NtGopInput: ReadKeyStrokeEx always return key state

[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGopInput.c

diff --git a/Nt32Pkg/WinNtGopDxe/WinNtGopInput.c b/Nt32Pkg/WinNtGopDxe/WinNtGopInput.c
index 812b02e2dacbfdd8f5988722445a77e978bd2c78..b19dfdc2ec0d34f01584683003f9531bafb7d9fb 100644 (file)
--- a/Nt32Pkg/WinNtGopDxe/WinNtGopInput.c
+++ b/Nt32Pkg/WinNtGopDxe/WinNtGopInput.c
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -270,73 +270,87 @@ WinNtGopSimpleTextInTimerHandler (
 }\r
 \r
 /**\r
-  TODO: Add function description\r
-\r
-  @param  Private               TODO: add argument description\r
-  @param  Key                   TODO: add argument description\r
-\r
-  @retval EFI_NOT_READY         TODO: Add description for return value\r
-  @retval EFI_SUCCESS           TODO: Add description for return value\r
+  Initialize the key state.\r
 \r
+  @param  Private               The GOP_PRIVATE_DATA instance.\r
+  @param  KeyState              A pointer to receive the key state information.\r
 **/\r
-EFI_STATUS\r
-GopPrivateAddKey (\r
+VOID\r
+InitializeKeyState (\r
   IN  GOP_PRIVATE_DATA    *Private,\r
-  IN  EFI_INPUT_KEY       Key\r
+  IN  EFI_KEY_STATE       *KeyState\r
   )\r
 {\r
-  EFI_KEY_DATA            KeyData;\r
-\r
-  KeyData.Key = Key;\r
-\r
-  KeyData.KeyState.KeyShiftState  = EFI_SHIFT_STATE_VALID;\r
-  KeyData.KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
+  KeyState->KeyShiftState  = EFI_SHIFT_STATE_VALID;\r
+  KeyState->KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
 \r
   //\r
   // Record Key shift state and toggle state\r
   //\r
   if (Private->LeftCtrl) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_CONTROL_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_LEFT_CONTROL_PRESSED;\r
   }\r
   if (Private->RightCtrl) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_CONTROL_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_RIGHT_CONTROL_PRESSED;\r
   }\r
   if (Private->LeftAlt) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_ALT_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_LEFT_ALT_PRESSED;\r
   }\r
   if (Private->RightAlt) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_ALT_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_RIGHT_ALT_PRESSED;\r
   }\r
   if (Private->LeftShift) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_SHIFT_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_LEFT_SHIFT_PRESSED;\r
   }\r
   if (Private->RightShift) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_SHIFT_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_RIGHT_SHIFT_PRESSED;\r
   }\r
   if (Private->LeftLogo) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_LOGO_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_LEFT_LOGO_PRESSED;\r
   }\r
   if (Private->RightLogo) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_LOGO_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_RIGHT_LOGO_PRESSED;\r
   }\r
   if (Private->Menu) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_MENU_KEY_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_MENU_KEY_PRESSED;\r
   }\r
   if (Private->SysReq) {\r
-    KeyData.KeyState.KeyShiftState  |= EFI_SYS_REQ_PRESSED;\r
+    KeyState->KeyShiftState  |= EFI_SYS_REQ_PRESSED;\r
   }\r
   if (Private->CapsLock) {\r
-    KeyData.KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
+    KeyState->KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
   }\r
   if (Private->NumLock) {\r
-    KeyData.KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
+    KeyState->KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
   }\r
   if (Private->ScrollLock) {\r
-    KeyData.KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
+    KeyState->KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
   }\r
   if (Private->IsPartialKeySupport) {\r
-    KeyData.KeyState.KeyToggleState |= EFI_KEY_STATE_EXPOSED;\r
+    KeyState->KeyToggleState |= EFI_KEY_STATE_EXPOSED;\r
   }\r
+}\r
+\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  Private               TODO: add argument description\r
+  @param  Key                   TODO: add argument description\r
+\r
+  @retval EFI_NOT_READY         TODO: Add description for return value\r
+  @retval EFI_SUCCESS           TODO: Add description for return value\r
+\r
+**/\r
+EFI_STATUS\r
+GopPrivateAddKey (\r
+  IN  GOP_PRIVATE_DATA    *Private,\r
+  IN  EFI_INPUT_KEY       Key\r
+  )\r
+{\r
+  EFI_KEY_DATA            KeyData;\r
+\r
+  KeyData.Key = Key;\r
+  InitializeKeyState (Private, &KeyData.KeyState);\r
 \r
   //\r
   // Convert Ctrl+[1-26] to Ctrl+[A-Z]\r
@@ -503,6 +517,9 @@ GopPrivateReadKeyStrokeWorker (
   //\r
   WinNtGopSimpleTextInTimerHandler (NULL, Private);\r
 \r
+  ZeroMem (&KeyData->Key, sizeof (KeyData->Key));\r
+  InitializeKeyState (Private, &KeyData->KeyState);\r
+\r
   Status  = GopPrivateCheckQ (&Private->QueueForRead);\r
   if (!EFI_ERROR (Status)) {\r
     //\r
@@ -822,7 +839,7 @@ WinNtGopSimpleTextInExRegisterKeyNotify (
   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
+  OUT VOID                              **NotifyHandle\r
   )\r
 /*++\r
 \r
@@ -867,7 +884,7 @@ WinNtGopSimpleTextInExRegisterKeyNotify (
                       );\r
     if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
       if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
-        *NotifyHandle = CurrentNotify->NotifyHandle;\r
+        *NotifyHandle = CurrentNotify;\r
         return EFI_SUCCESS;\r
       }\r
     }\r
@@ -883,11 +900,10 @@ WinNtGopSimpleTextInExRegisterKeyNotify (
 \r
   NewNotify->Signature         = WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE;\r
   NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
-  NewNotify->NotifyHandle      = (EFI_HANDLE) NewNotify;\r
   CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));\r
   InsertTailList (&Private->NotifyList, &NewNotify->NotifyEntry);\r
 \r
-  *NotifyHandle = NewNotify->NotifyHandle;\r
+  *NotifyHandle = NewNotify;\r
 \r
   return EFI_SUCCESS;\r
 \r
@@ -897,7 +913,7 @@ EFI_STATUS
 EFIAPI\r
 WinNtGopSimpleTextInExUnregisterKeyNotify (\r
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
-  IN EFI_HANDLE                         NotificationHandle\r
+  IN VOID                               *NotificationHandle\r
   )\r
 /*++\r
 \r
@@ -931,7 +947,7 @@ WinNtGopSimpleTextInExUnregisterKeyNotify (
                       NotifyEntry,\r
                       WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                       );\r
-    if (CurrentNotify->NotifyHandle == NotificationHandle) {\r
+    if (CurrentNotify == NotificationHandle) {\r
       //\r
       // Remove the notification function from NotifyList and free resources\r
       //\r