]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Nt32Pkg/WinNtGopDxe/WinNtGopInput.c
Fix NT32 Keyboard driver to call hotkey callback even no one is calling ReadKeyStroke().
[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGopInput.c
index 215f95ae939301fcd0c46bd7b579c5ca9f0c2fec..3b91da8f9f49d87e39eb2fd8833955f694c187ad 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -42,14 +42,13 @@ Abstract:
 **/\r
 EFI_STATUS\r
 GopPrivateCreateQ (\r
-  IN  GOP_PRIVATE_DATA    *Private\r
+  IN  GOP_PRIVATE_DATA    *Private,\r
+  IN  GOP_QUEUE_FIXED     *Queue\r
   )\r
 {\r
-  Private->WinNtThunk->InitializeCriticalSection (&Private->QCriticalSection);\r
-\r
-  Private->Queue.Front  = 0;\r
-  Private->Queue.Rear   = MAX_Q - 1;\r
-  Private->Queue.Count  = 0;\r
+  Private->WinNtThunk->InitializeCriticalSection (&Queue->Cs);\r
+  Queue->Front = 0;\r
+  Queue->Rear  = 0;\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -64,11 +63,13 @@ GopPrivateCreateQ (
 **/\r
 EFI_STATUS\r
 GopPrivateDestroyQ (\r
-  IN  GOP_PRIVATE_DATA    *Private\r
+  IN  GOP_PRIVATE_DATA    *Private,\r
+  IN  GOP_QUEUE_FIXED     *Queue\r
   )\r
 {\r
-  Private->Queue.Count = 0;\r
-  Private->WinNtThunk->DeleteCriticalSection (&Private->QCriticalSection);\r
+  Queue->Front = 0;\r
+  Queue->Rear  = 0;\r
+  Private->WinNtThunk->DeleteCriticalSection (&Queue->Cs);\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -85,22 +86,22 @@ GopPrivateDestroyQ (
 **/\r
 EFI_STATUS\r
 GopPrivateAddQ (\r
-  IN  GOP_PRIVATE_DATA    *Private,\r
-  IN  EFI_INPUT_KEY       Key\r
+  IN GOP_PRIVATE_DATA     *Private,\r
+  IN GOP_QUEUE_FIXED      *Queue,\r
+  IN EFI_KEY_DATA         *KeyData\r
   )\r
 {\r
-  Private->WinNtThunk->EnterCriticalSection (&Private->QCriticalSection);\r
+  Private->WinNtThunk->EnterCriticalSection (&Queue->Cs);\r
 \r
-  if (Private->Queue.Count == MAX_Q) {\r
-    Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection);\r
+  if ((Queue->Rear + 1) % MAX_Q == Queue->Front) {\r
+    Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);\r
     return EFI_NOT_READY;\r
   }\r
 \r
-  Private->Queue.Rear                   = (Private->Queue.Rear + 1) % MAX_Q;\r
-  Private->Queue.Q[Private->Queue.Rear] = Key;\r
-  Private->Queue.Count++;\r
+  CopyMem (&Queue->Q[Queue->Rear], KeyData, sizeof (EFI_KEY_DATA));\r
+  Queue->Rear           = (Queue->Rear + 1) % MAX_Q;\r
 \r
-  Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection);\r
+  Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -118,21 +119,21 @@ GopPrivateAddQ (
 EFI_STATUS\r
 GopPrivateDeleteQ (\r
   IN  GOP_PRIVATE_DATA    *Private,\r
-  OUT EFI_INPUT_KEY       *Key\r
+  IN  GOP_QUEUE_FIXED     *Queue,\r
+  OUT EFI_KEY_DATA        *Key\r
   )\r
 {\r
-  Private->WinNtThunk->EnterCriticalSection (&Private->QCriticalSection);\r
+  Private->WinNtThunk->EnterCriticalSection (&Queue->Cs);\r
 \r
-  if (Private->Queue.Count == 0) {\r
-    Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection);\r
+  if (Queue->Front == Queue->Rear) {\r
+    Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);\r
     return EFI_NOT_READY;\r
   }\r
 \r
-  *Key                  = Private->Queue.Q[Private->Queue.Front];\r
-  Private->Queue.Front  = (Private->Queue.Front + 1) % MAX_Q;\r
-  Private->Queue.Count--;\r
+  CopyMem (Key, &Queue->Q[Queue->Front], sizeof (EFI_KEY_DATA));\r
+  Queue->Front  = (Queue->Front + 1) % MAX_Q;\r
 \r
-  Private->WinNtThunk->LeaveCriticalSection (&Private->QCriticalSection);\r
+  Private->WinNtThunk->LeaveCriticalSection (&Queue->Cs);\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -148,10 +149,10 @@ GopPrivateDeleteQ (
 **/\r
 EFI_STATUS\r
 GopPrivateCheckQ (\r
-  IN  GOP_PRIVATE_DATA    *Private\r
+  IN  GOP_QUEUE_FIXED     *Queue\r
   )\r
 {\r
-  if (Private->Queue.Count == 0) {\r
+  if (Queue->Front == Queue->Rear) {\r
     return EFI_NOT_READY;\r
   }\r
 \r
@@ -237,12 +238,130 @@ Returns:
                       NotifyEntry, \r
                       WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                       );\r
-    if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) { \r
+    if (GopPrivateIsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
       CurrentNotify->KeyNotificationFn (KeyData);\r
     }\r
   }    \r
 }\r
 \r
+VOID\r
+WinNtGopSimpleTextInTimerHandler (\r
+  IN EFI_EVENT          Event,\r
+  IN GOP_PRIVATE_DATA   *Private\r
+  )\r
+{\r
+  EFI_KEY_DATA          KeyData;\r
+\r
+  while (GopPrivateDeleteQ (Private, &Private->QueueForNotify, &KeyData) == EFI_SUCCESS) {\r
+    GopPrivateInvokeRegisteredFunction (Private, &KeyData);\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
+\r
+  KeyData.KeyState.KeyShiftState  = EFI_SHIFT_STATE_VALID;\r
+  KeyData.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
+  }\r
+  if (Private->RightCtrl) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_CONTROL_PRESSED;\r
+  }\r
+  if (Private->LeftAlt) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_ALT_PRESSED;\r
+  }\r
+  if (Private->RightAlt) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_ALT_PRESSED;\r
+  }\r
+  if (Private->LeftShift) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_SHIFT_PRESSED;\r
+  }                                    \r
+  if (Private->RightShift) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_SHIFT_PRESSED;\r
+  }\r
+  if (Private->LeftLogo) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_LEFT_LOGO_PRESSED;\r
+  }\r
+  if (Private->RightLogo) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_RIGHT_LOGO_PRESSED;\r
+  }\r
+  if (Private->Menu) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_MENU_KEY_PRESSED;\r
+  }\r
+  if (Private->SysReq) {\r
+    KeyData.KeyState.KeyShiftState  |= EFI_SYS_REQ_PRESSED;\r
+  }  \r
+  if (Private->CapsLock) {\r
+    KeyData.KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
+  }\r
+  if (Private->NumLock) {\r
+    KeyData.KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
+  }\r
+  if (Private->ScrollLock) {\r
+    KeyData.KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
+  }\r
+  \r
+  //\r
+  // Convert Ctrl+[1-26] to Ctrl+[A-Z]\r
+  //\r
+  if ((Private->LeftCtrl || Private->RightCtrl) && \r
+      (KeyData.Key.UnicodeChar >= 1) && (KeyData.Key.UnicodeChar <= 26)\r
+     ) {\r
+    if ((Private->LeftShift || Private->RightShift) == Private->CapsLock) {\r
+      KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar + L'a' - 1;\r
+    } else {\r
+      KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar + L'A' - 1;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Unmask the Shift bit for printable char\r
+  //\r
+  if (((KeyData.Key.UnicodeChar >= L'a') && (KeyData.Key.UnicodeChar <= L'z')) ||\r
+      ((KeyData.Key.UnicodeChar >= L'A') && (KeyData.Key.UnicodeChar <= L'Z'))\r
+     ) {\r
+    KeyData.KeyState.KeyShiftState &= ~(EFI_LEFT_SHIFT_PRESSED | EFI_RIGHT_SHIFT_PRESSED);\r
+  }\r
+\r
+  GopPrivateAddQ (Private, &Private->QueueForNotify, &KeyData);\r
+\r
+  //\r
+  // Convert Ctrl+[A-Z] to Ctrl+[1-26]\r
+  //\r
+  if (Private->LeftCtrl || Private->RightCtrl) {\r
+    if ((KeyData.Key.UnicodeChar >= L'a') && (KeyData.Key.UnicodeChar <= L'z')) {\r
+      KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar - L'a' + 1;\r
+    } else if ((KeyData.Key.UnicodeChar >= L'A') && (KeyData.Key.UnicodeChar <= L'Z')) {\r
+      KeyData.Key.UnicodeChar = KeyData.Key.UnicodeChar - L'A' + 1;\r
+    }\r
+  }\r
+  GopPrivateAddQ (Private, &Private->QueueForRead, &KeyData);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
 EFI_STATUS\r
 GopPrivateUpdateStatusLight (\r
   IN GOP_PRIVATE_DATA                     *Private\r
@@ -294,7 +413,7 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_INPUT_KEY     Key;\r
+  EFI_KEY_DATA      KeyData;\r
   EFI_TPL           OldTpl;\r
 \r
   //\r
@@ -305,7 +424,9 @@ Returns:
   //\r
   // A reset is draining the Queue\r
   //\r
-  while (GopPrivateDeleteQ (Private, &Key) == EFI_SUCCESS)\r
+  while (GopPrivateDeleteQ (Private, &Private->QueueForRead, &KeyData) == EFI_SUCCESS)\r
+    ;\r
+  while (GopPrivateDeleteQ (Private, &Private->QueueForNotify, &KeyData) == EFI_SUCCESS)\r
     ;\r
 \r
   Private->LeftShift               = FALSE;\r
@@ -371,69 +492,22 @@ GopPrivateReadKeyStrokeWorker (
   //\r
   OldTpl  = gBS->RaiseTPL (TPL_NOTIFY);\r
 \r
-  Status  = GopPrivateCheckQ (Private);\r
+  //\r
+  // Call hot key callback before telling caller there is a key available\r
+  //\r
+  WinNtGopSimpleTextInTimerHandler (NULL, Private);\r
+\r
+  Status  = GopPrivateCheckQ (&Private->QueueForRead);\r
   if (!EFI_ERROR (Status)) {\r
     //\r
     // If a Key press exists try and read it.\r
     //\r
-    Status = GopPrivateDeleteQ (Private, &KeyData->Key);\r
+    Status = GopPrivateDeleteQ (Private, &Private->QueueForRead, KeyData);\r
     if (!EFI_ERROR (Status)) {\r
-      //\r
-      // Record Key shift state and toggle state\r
-      //      \r
-      if (Private->LeftCtrl) {\r
-        Private->KeyState.KeyShiftState  |= EFI_LEFT_CONTROL_PRESSED;\r
-      }                                    \r
-      if (Private->RightCtrl) {\r
-        Private->KeyState.KeyShiftState  |= EFI_RIGHT_CONTROL_PRESSED;\r
-      }                                    \r
-      if (Private->LeftAlt) {                \r
-        Private->KeyState.KeyShiftState  |= EFI_LEFT_ALT_PRESSED;\r
-      }                                    \r
-      if (Private->RightAlt) {                \r
-        Private->KeyState.KeyShiftState  |= EFI_RIGHT_ALT_PRESSED;\r
-      }                                      \r
-      if (Private->LeftShift) {          \r
-        Private->KeyState.KeyShiftState  |= EFI_LEFT_SHIFT_PRESSED;\r
-      }                                    \r
-      if (Private->RightShift) {         \r
-        Private->KeyState.KeyShiftState  |= EFI_RIGHT_SHIFT_PRESSED;\r
-      }                                    \r
-      if (Private->LeftLogo) {           \r
-        Private->KeyState.KeyShiftState  |= EFI_LEFT_LOGO_PRESSED;\r
-      }                                    \r
-      if (Private->RightLogo) {          \r
-        Private->KeyState.KeyShiftState  |= EFI_RIGHT_LOGO_PRESSED;\r
-      }                                    \r
-      if (Private->Menu) {               \r
-        Private->KeyState.KeyShiftState  |= EFI_MENU_KEY_PRESSED;\r
-      }                                    \r
-      if (Private->SysReq) {             \r
-        Private->KeyState.KeyShiftState  |= EFI_SYS_REQ_PRESSED;\r
-      }  \r
-      if (Private->CapsLock) {\r
-        Private->KeyState.KeyToggleState |= EFI_CAPS_LOCK_ACTIVE;\r
-      }\r
-      if (Private->NumLock) {\r
-        Private->KeyState.KeyToggleState |= EFI_NUM_LOCK_ACTIVE;\r
-      }\r
-      if (Private->ScrollLock) {\r
-        Private->KeyState.KeyToggleState |= EFI_SCROLL_LOCK_ACTIVE;\r
-      }\r
-      \r
-      KeyData->KeyState.KeyShiftState  = Private->KeyState.KeyShiftState;\r
-      KeyData->KeyState.KeyToggleState = Private->KeyState.KeyToggleState;\r
-      \r
-      Private->KeyState.KeyShiftState  = EFI_SHIFT_STATE_VALID;\r
-      Private->KeyState.KeyToggleState = EFI_TOGGLE_STATE_VALID;\r
-  \r
       //\r
       // Leave critical section and return\r
       //\r
       gBS->RestoreTPL (OldTpl);\r
-      \r
-      GopPrivateInvokeRegisteredFunction (Private, KeyData);\r
-      \r
       return EFI_SUCCESS;\r
     }\r
   }\r
@@ -536,8 +610,13 @@ WinNtGopSimpleTextInWaitForKey (
   // Enter critical section\r
   //\r
   OldTpl  = gBS->RaiseTPL (TPL_NOTIFY);\r
+  \r
+  //\r
+  // Call hot key callback before telling caller there is a key available\r
+  //\r
+  WinNtGopSimpleTextInTimerHandler (NULL, Private);\r
 \r
-  Status  = GopPrivateCheckQ (Private);\r
+  Status  = GopPrivateCheckQ (&Private->QueueForRead);\r
   if (!EFI_ERROR (Status)) {\r
     //\r
     // If a there is a key in the queue signal our event.\r
@@ -827,6 +906,7 @@ WinNtGopSimpleTextInExUnregisterKeyNotify (
   return EFI_INVALID_PARAMETER;\r
 }\r
 \r
+\r
 /**\r
   TODO: Add function description\r
 \r
@@ -842,7 +922,8 @@ WinNtGopInitializeSimpleTextInForWindow (
 {\r
   EFI_STATUS  Status;\r
 \r
-  GopPrivateCreateQ (Private);\r
+  GopPrivateCreateQ (Private, &Private->QueueForRead);\r
+  GopPrivateCreateQ (Private, &Private->QueueForNotify);\r
 \r
   //\r
   // Initialize Simple Text In protoocol\r
@@ -878,6 +959,24 @@ WinNtGopInitializeSimpleTextInForWindow (
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  //\r
+  // Create the Timer to trigger hot key notifications\r
+  //\r
+  Status = gBS->CreateEvent (\r
+                  EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
+                  TPL_NOTIFY,\r
+                  WinNtGopSimpleTextInTimerHandler,\r
+                  Private,\r
+                  &Private->TimerEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+  \r
+  Status = gBS->SetTimer (\r
+                  Private->TimerEvent,\r
+                  TimerPeriodic,\r
+                  KEYBOARD_TIMER_INTERVAL\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
 \r
   return Status;\r
 }\r
@@ -897,6 +996,10 @@ WinNtGopDestroySimpleTextInForWindow (
   IN  GOP_PRIVATE_DATA    *Private\r
   )\r
 {\r
-  GopPrivateDestroyQ (Private);\r
+  gBS->CloseEvent (Private->TimerEvent);\r
+\r
+  GopPrivateDestroyQ (Private, &Private->QueueForRead);\r
+  GopPrivateDestroyQ (Private, &Private->QueueForNotify);\r
+\r
   return EFI_SUCCESS;\r
 }\r