]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
MdeModulePkg TerminalDxe: Execute key notify func at TPL_CALLBACK
[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / TerminalConIn.c
index c216ed900fc5f9f6c7085e4c268449574fea2605..016241017a42693ec05ab57fa4d84953256cdd84 100644 (file)
@@ -2,7 +2,8 @@
   Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.\r
 \r
 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (C) 2016 Silicon Graphics, Inc. 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
@@ -93,6 +94,7 @@ TerminalConInReset (
   TerminalDevice->RawFiFo->Head     = TerminalDevice->RawFiFo->Tail;\r
   TerminalDevice->UnicodeFiFo->Head = TerminalDevice->UnicodeFiFo->Tail;\r
   TerminalDevice->EfiKeyFiFo->Head  = TerminalDevice->EfiKeyFiFo->Tail;\r
+  TerminalDevice->EfiKeyFiFoForNotify->Head = TerminalDevice->EfiKeyFiFoForNotify->Tail;\r
 \r
   if (EFI_ERROR (Status)) {\r
     REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
@@ -562,10 +564,11 @@ TerminalConInTimerHandler (
   }\r
   //\r
   // Check whether serial buffer is empty.\r
+  // Skip the key transfer loop only if the SerialIo protocol instance\r
+  // successfully reports EFI_SERIAL_INPUT_BUFFER_EMPTY.\r
   //\r
   Status = SerialIo->GetControl (SerialIo, &Control);\r
-\r
-  if ((Control & EFI_SERIAL_INPUT_BUFFER_EMPTY) == 0) {\r
+  if (EFI_ERROR (Status) || ((Control & EFI_SERIAL_INPUT_BUFFER_EMPTY) == 0)) {\r
     //\r
     // Fetch all the keys in the serial buffer,\r
     // and insert the byte stream into RawFIFO.\r
@@ -596,6 +599,59 @@ TerminalConInTimerHandler (
   TranslateRawDataToEfiKey (TerminalDevice);\r
 }\r
 \r
+/**\r
+  Process key notify.\r
+\r
+  @param  Event                 Indicates the event that invoke this function.\r
+  @param  Context               Indicates the calling context.\r
+**/\r
+VOID\r
+EFIAPI\r
+KeyNotifyProcessHandler (\r
+  IN  EFI_EVENT                 Event,\r
+  IN  VOID                      *Context\r
+  )\r
+{\r
+  BOOLEAN                       HasKey;\r
+  TERMINAL_DEV                  *TerminalDevice;\r
+  EFI_INPUT_KEY                 Key;\r
+  EFI_KEY_DATA                  KeyData;\r
+  LIST_ENTRY                    *Link;\r
+  LIST_ENTRY                    *NotifyList;\r
+  TERMINAL_CONSOLE_IN_EX_NOTIFY *CurrentNotify;\r
+  EFI_TPL                       OldTpl;\r
+\r
+  TerminalDevice = (TERMINAL_DEV *) Context;\r
+\r
+  //\r
+  // Invoke notification functions.\r
+  //\r
+  NotifyList = &TerminalDevice->NotifyList;\r
+  while (TRUE) {\r
+    //\r
+    // Enter critical section\r
+    //  \r
+    OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
+    HasKey = EfiKeyFiFoForNotifyRemoveOneKey (TerminalDevice->EfiKeyFiFoForNotify, &Key);\r
+    CopyMem (&KeyData.Key, &Key, sizeof (EFI_INPUT_KEY));\r
+    KeyData.KeyState.KeyShiftState  = 0;\r
+    KeyData.KeyState.KeyToggleState = 0;\r
+    //\r
+    // Leave critical section\r
+    //\r
+    gBS->RestoreTPL (OldTpl);\r
+    if (!HasKey) {\r
+      break;\r
+    }\r
+    for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList, Link); Link = GetNextNode (NotifyList, Link)) {\r
+      CurrentNotify = CR (Link, TERMINAL_CONSOLE_IN_EX_NOTIFY, NotifyEntry, TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE);\r
+      if (IsKeyRegistered (&CurrentNotify->KeyData, &KeyData)) {\r
+        CurrentNotify->KeyNotificationFn (&KeyData);\r
+      }\r
+    }\r
+  }\r
+}\r
+\r
 /**\r
   Get one key out of serial buffer.\r
 \r
@@ -761,6 +817,126 @@ IsRawFiFoFull (
   return FALSE;\r
 }\r
 \r
+/**\r
+  Insert one pre-fetched key into the FIFO buffer.\r
+\r
+  @param  EfiKeyFiFo            Pointer to instance of EFI_KEY_FIFO.\r
+  @param  Input                 The key will be input.\r
+\r
+  @retval TRUE                  If insert successfully.\r
+  @retval FALSE                 If FIFO buffer is full before key insertion,\r
+                                and the key is lost.\r
+\r
+**/\r
+BOOLEAN\r
+EfiKeyFiFoForNotifyInsertOneKey (\r
+  EFI_KEY_FIFO                  *EfiKeyFiFo,\r
+  EFI_INPUT_KEY                 *Input\r
+  )\r
+{\r
+  UINT8                         Tail;\r
+\r
+  Tail = EfiKeyFiFo->Tail;\r
+\r
+  if (IsEfiKeyFiFoForNotifyFull (EfiKeyFiFo)) {\r
+    //\r
+    // FIFO is full\r
+    //\r
+    return FALSE;\r
+  }\r
+\r
+  CopyMem (&EfiKeyFiFo->Data[Tail], Input, sizeof (EFI_INPUT_KEY));\r
+\r
+  EfiKeyFiFo->Tail = (UINT8) ((Tail + 1) % (FIFO_MAX_NUMBER + 1));\r
+\r
+  return TRUE;\r
+}\r
+\r
+/**\r
+  Remove one pre-fetched key out of the FIFO buffer.\r
+\r
+  @param  EfiKeyFiFo            Pointer to instance of EFI_KEY_FIFO.\r
+  @param  Output                The key will be removed.\r
+\r
+  @retval TRUE                  If remove successfully.\r
+  @retval FALSE                 If FIFO buffer is empty before remove operation.\r
+\r
+**/\r
+BOOLEAN\r
+EfiKeyFiFoForNotifyRemoveOneKey (\r
+  EFI_KEY_FIFO                  *EfiKeyFiFo,\r
+  EFI_INPUT_KEY                 *Output\r
+  )\r
+{\r
+  UINT8                         Head;\r
+\r
+  Head = EfiKeyFiFo->Head;\r
+  ASSERT (Head < FIFO_MAX_NUMBER + 1);\r
+\r
+  if (IsEfiKeyFiFoForNotifyEmpty (EfiKeyFiFo)) {\r
+    //\r
+    // FIFO is empty\r
+    //\r
+    Output->ScanCode    = SCAN_NULL;\r
+    Output->UnicodeChar = 0;\r
+    return FALSE;\r
+  }\r
+\r
+  CopyMem (Output, &EfiKeyFiFo->Data[Head], sizeof (EFI_INPUT_KEY));\r
+\r
+  EfiKeyFiFo->Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
+\r
+  return TRUE;\r
+}\r
+\r
+/**\r
+  Clarify whether FIFO buffer is empty.\r
+\r
+  @param  EfiKeyFiFo            Pointer to instance of EFI_KEY_FIFO.\r
+\r
+  @retval TRUE                  If FIFO buffer is empty.\r
+  @retval FALSE                 If FIFO buffer is not empty.\r
+\r
+**/\r
+BOOLEAN\r
+IsEfiKeyFiFoForNotifyEmpty (\r
+  EFI_KEY_FIFO                  *EfiKeyFiFo\r
+  )\r
+{\r
+  if (EfiKeyFiFo->Head == EfiKeyFiFo->Tail) {\r
+    return TRUE;\r
+  } else {\r
+    return FALSE;\r
+  }\r
+}\r
+\r
+/**\r
+  Clarify whether FIFO buffer is full.\r
+\r
+  @param  EfiKeyFiFo            Pointer to instance of EFI_KEY_FIFO.\r
+\r
+  @retval TRUE                  If FIFO buffer is full.\r
+  @retval FALSE                 If FIFO buffer is not full.\r
+\r
+**/\r
+BOOLEAN\r
+IsEfiKeyFiFoForNotifyFull (\r
+  EFI_KEY_FIFO                  *EfiKeyFiFo\r
+  )\r
+{\r
+  UINT8                         Tail;\r
+  UINT8                         Head;\r
+\r
+  Tail = EfiKeyFiFo->Tail;\r
+  Head = EfiKeyFiFo->Head;\r
+\r
+  if (((Tail + 1) % (FIFO_MAX_NUMBER + 1)) == Head) {\r
+    return TRUE;\r
+  }\r
+\r
+  return FALSE;\r
+}\r
+\r
 /**\r
   Insert one pre-fetched key into the FIFO buffer.\r
 \r
@@ -791,7 +967,7 @@ EfiKeyFiFoInsertOneKey (
   KeyData.KeyState.KeyToggleState = 0;\r
 \r
   //\r
-  // Invoke notification functions if exist\r
+  // Signal KeyNotify process event if this key pressed matches any key registered.\r
   //\r
   NotifyList = &TerminalDevice->NotifyList;\r
   for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {\r
@@ -802,7 +978,13 @@ EfiKeyFiFoInsertOneKey (
                       TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE\r
                       );\r
     if (IsKeyRegistered (&CurrentNotify->KeyData, &KeyData)) {\r
-      CurrentNotify->KeyNotificationFn (&KeyData);\r
+      //\r
+      // The key notification function needs to run at TPL_CALLBACK\r
+      // while current TPL is TPL_NOTIFY. It will be invoked in\r
+      // KeyNotifyProcessHandler() which runs at TPL_CALLBACK.\r
+      //\r
+      EfiKeyFiFoForNotifyInsertOneKey (TerminalDevice->EfiKeyFiFoForNotify, Key);\r
+      gBS->SignalEvent (TerminalDevice->KeyNotifyProcessEvent);\r
     }\r
   }\r
   if (IsEfiKeyFiFoFull (TerminalDevice)) {\r
@@ -1373,7 +1555,7 @@ UnicodeToEfiKey (
           break;\r
         }\r
       } else if (TerminalDevice->TerminalType == TTYTERMTYPE) {\r
-        /* Also accept VT100 escape codes for F1-F4 for TTY term */\r
+        /* Also accept VT100 escape codes for F1-F4, HOME and END for TTY term */\r
         switch (UnicodeChar) {\r
         case 'P':\r
           Key.ScanCode = SCAN_F1;\r
@@ -1387,6 +1569,12 @@ UnicodeToEfiKey (
         case 'S':\r
           Key.ScanCode = SCAN_F4;\r
           break;\r
+        case 'H':\r
+          Key.ScanCode = SCAN_HOME;\r
+          break;\r
+        case 'F':\r
+          Key.ScanCode = SCAN_END;\r
+          break;\r
         }\r
       }\r
 \r
@@ -1428,12 +1616,14 @@ UnicodeToEfiKey (
           break;\r
         case 'H':\r
           if (TerminalDevice->TerminalType == PCANSITYPE ||\r
-              TerminalDevice->TerminalType == VT100TYPE) {\r
+              TerminalDevice->TerminalType == VT100TYPE  ||\r
+              TerminalDevice->TerminalType == TTYTERMTYPE) {\r
             Key.ScanCode = SCAN_HOME;\r
           }\r
           break;\r
         case 'F':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == PCANSITYPE ||\r
+              TerminalDevice->TerminalType == TTYTERMTYPE) {\r
             Key.ScanCode = SCAN_END;\r
           }\r
           break;\r
@@ -1572,9 +1762,18 @@ UnicodeToEfiKey (
           TerminalDevice->TtyEscapeStr[TerminalDevice->TtyEscapeIndex] = 0; /* Terminate string */\r
           EscCode = (UINT16) StrDecimalToUintn(TerminalDevice->TtyEscapeStr);\r
           switch (EscCode) {\r
+          case 2:\r
+              Key.ScanCode = SCAN_INSERT;\r
+              break;\r
           case 3:\r
               Key.ScanCode = SCAN_DELETE;\r
               break;\r
+          case 5:\r
+              Key.ScanCode = SCAN_PAGE_UP;\r
+              break;\r
+          case 6:\r
+              Key.ScanCode = SCAN_PAGE_DOWN;\r
+              break;\r
           case 11:\r
           case 12:\r
           case 13:\r