]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7
[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / TerminalConIn.c
index 90bac164bce2a01e3a8e13a193ff4d83f81192a4..3c1102dac4a1e6db323d15a49f1f67f0db013514 100644 (file)
@@ -1,7 +1,9 @@
 /** @file\r
   Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
+Copyright (c) 2006 - 2017, 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
@@ -92,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
@@ -157,7 +160,7 @@ TerminalConInReadKeyStroke (
                                    pressed.\r
 \r
   @retval TRUE                     Key be pressed matches a registered key.\r
-  @retval FLASE                    Match failed.\r
+  @retval FALSE                    Match failed.\r
 \r
 **/\r
 BOOLEAN\r
@@ -295,6 +298,10 @@ TerminalConInSetState (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
+  if ((*KeyToggleState & EFI_TOGGLE_STATE_VALID) != EFI_TOGGLE_STATE_VALID) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -303,11 +310,14 @@ TerminalConInSetState (
   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\r
-                                   keystroke information data for the key that was\r
-                                   pressed.\r
+  @param  KeyData                  A pointer to a buffer that is filled in with\r
+                                   the keystroke information for the key that was\r
+                                   pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState\r
+                                   and KeyData.KeyState.KeyShiftState are 0, then any incomplete\r
+                                   keystroke will trigger a notification of the KeyNotificationFunction.\r
   @param  KeyNotificationFunction  Points to the function to be called when the key\r
-                                   sequence is typed specified by KeyData.\r
+                                   sequence is typed specified by KeyData. This notification function\r
+                                   should be called at <=TPL_CALLBACK.\r
   @param  NotifyHandle             Points to the unique handle assigned to the\r
                                    registered notification.\r
 \r
@@ -324,7 +334,7 @@ TerminalConInRegisterKeyNotify (
   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
   TERMINAL_DEV                    *TerminalDevice;\r
@@ -352,7 +362,7 @@ TerminalConInRegisterKeyNotify (
                       );\r
     if (IsKeyRegistered (&CurrentNotify->KeyData, KeyData)) {\r
       if (CurrentNotify->KeyNotificationFn == KeyNotificationFunction) {\r
-        *NotifyHandle = CurrentNotify->NotifyHandle;\r
+        *NotifyHandle = CurrentNotify;\r
         return EFI_SUCCESS;\r
       }\r
     }\r
@@ -368,11 +378,10 @@ TerminalConInRegisterKeyNotify (
 \r
   NewNotify->Signature         = TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE;\r
   NewNotify->KeyNotificationFn = KeyNotificationFunction;\r
-  NewNotify->NotifyHandle      = (EFI_HANDLE) NewNotify;\r
-  CopyMem (&NewNotify->KeyData, KeyData, sizeof (KeyData));\r
+  CopyMem (&NewNotify->KeyData, KeyData, sizeof (EFI_KEY_DATA));\r
   InsertTailList (&TerminalDevice->NotifyList, &NewNotify->NotifyEntry);\r
 \r
-  *NotifyHandle                = NewNotify->NotifyHandle;\r
+  *NotifyHandle                = NewNotify;\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -394,7 +403,7 @@ EFI_STATUS
 EFIAPI\r
 TerminalConInUnregisterKeyNotify (\r
   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,\r
-  IN EFI_HANDLE                         NotificationHandle\r
+  IN VOID                               *NotificationHandle\r
   )\r
 {\r
   TERMINAL_DEV                    *TerminalDevice;\r
@@ -406,10 +415,6 @@ TerminalConInUnregisterKeyNotify (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if (((TERMINAL_CONSOLE_IN_EX_NOTIFY *) NotificationHandle)->Signature != TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE) {\r
-    return EFI_INVALID_PARAMETER;\r
-  } \r
-  \r
   TerminalDevice = TERMINAL_CON_IN_EX_DEV_FROM_THIS (This);\r
 \r
   NotifyList = &TerminalDevice->NotifyList;\r
@@ -420,7 +425,7 @@ TerminalConInUnregisterKeyNotify (
                       NotifyEntry,\r
                       TERMINAL_CONSOLE_IN_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
@@ -451,14 +456,15 @@ TranslateRawDataToEfiKey (
 {\r
   switch (TerminalDevice->TerminalType) {\r
 \r
-  case PCANSITYPE:\r
-  case VT100TYPE:\r
-  case VT100PLUSTYPE:\r
+  case TerminalTypePcAnsi:\r
+  case TerminalTypeVt100:\r
+  case TerminalTypeVt100Plus:\r
+  case TerminalTypeTtyTerm:\r
     AnsiRawDataToUnicode (TerminalDevice);\r
     UnicodeToEfiKey (TerminalDevice);\r
     break;\r
 \r
-  case VTUTF8TYPE:\r
+  case TerminalTypeVtUtf8:\r
     //\r
     // Process all the raw data in the RawFIFO,\r
     // put the processed key into UnicodeFIFO.\r
@@ -561,10 +567,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
@@ -595,6 +602,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
@@ -648,7 +708,7 @@ GetOneKeyFromSerial (
   @param  Input                The key will be input.\r
 \r
   @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If Raw Data buffer is full before key insertion,\r
+  @retval FALSE                If Raw Data buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -683,7 +743,7 @@ RawFiFoInsertOneKey (
   @param  Output               The key will be removed.\r
 \r
   @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If Raw Data FIFO buffer is empty before remove operation.\r
+  @retval FALSE                If Raw Data FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -717,7 +777,7 @@ RawFiFoRemoveOneKey (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If Raw Data FIFO buffer is empty.\r
-  @retval FLASE                If Raw Data FIFO buffer is not empty.\r
+  @retval FALSE                If Raw Data FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -738,7 +798,7 @@ IsRawFiFoEmpty (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If Raw Data FIFO buffer is full.\r
-  @retval FLASE                If Raw Data FIFO buffer is not full.\r
+  @retval FALSE                If Raw Data FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -760,6 +820,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
@@ -767,7 +947,7 @@ IsRawFiFoFull (
   @param  Key                  The key will be input.\r
 \r
   @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If FIFO buffer is full before key insertion,\r
+  @retval FALSE                If FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -790,7 +970,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
@@ -801,7 +981,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
@@ -825,7 +1011,7 @@ EfiKeyFiFoInsertOneKey (
   @param  Output               The key will be removed.\r
 \r
   @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If FIFO buffer is empty before remove operation.\r
+  @retval FALSE                If FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -848,7 +1034,7 @@ EfiKeyFiFoRemoveOneKey (
     return FALSE;\r
   }\r
 \r
-  *Output                         = TerminalDevice->EfiKeyFiFo->Data[Head];\r
+  CopyMem (Output, &TerminalDevice->EfiKeyFiFo->Data[Head], sizeof (EFI_INPUT_KEY));\r
 \r
   TerminalDevice->EfiKeyFiFo->Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
 \r
@@ -861,7 +1047,7 @@ EfiKeyFiFoRemoveOneKey (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If FIFO buffer is empty.\r
-  @retval FLASE                If FIFO buffer is not empty.\r
+  @retval FALSE                If FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -882,7 +1068,7 @@ IsEfiKeyFiFoEmpty (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If FIFO buffer is full.\r
-  @retval FLASE                If FIFO buffer is not full.\r
+  @retval FALSE                If FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -911,7 +1097,7 @@ IsEfiKeyFiFoFull (
   @param  Input                The key will be input.\r
 \r
   @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If Unicode FIFO buffer is full before key insertion,\r
+  @retval FALSE                If Unicode FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -943,15 +1129,14 @@ UnicodeFiFoInsertOneKey (
 \r
 /**\r
   Remove one pre-fetched key out of the Unicode FIFO buffer.\r
+  The caller should guarantee that Unicode FIFO buffer is not empty \r
+  by IsUnicodeFiFoEmpty ().\r
 \r
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @retval TRUE                 If insert successfully.\r
-  @retval FLASE                If Unicode FIFO buffer is empty before remove operation.\r
-\r
 **/\r
-BOOLEAN\r
+VOID\r
 UnicodeFiFoRemoveOneKey (\r
   TERMINAL_DEV  *TerminalDevice,\r
   UINT16        *Output\r
@@ -962,19 +1147,9 @@ UnicodeFiFoRemoveOneKey (
   Head = TerminalDevice->UnicodeFiFo->Head;\r
   ASSERT (Head < FIFO_MAX_NUMBER + 1);\r
 \r
-  if (IsUnicodeFiFoEmpty (TerminalDevice)) {\r
-    //\r
-    //  FIFO is empty\r
-    //\r
-    Output = NULL;\r
-    return FALSE;\r
-  }\r
-\r
   *Output = TerminalDevice->UnicodeFiFo->Data[Head];\r
 \r
   TerminalDevice->UnicodeFiFo->Head = (UINT8) ((Head + 1) % (FIFO_MAX_NUMBER + 1));\r
-\r
-  return TRUE;\r
 }\r
 \r
 /**\r
@@ -983,7 +1158,7 @@ UnicodeFiFoRemoveOneKey (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If Unicode FIFO buffer is empty.\r
-  @retval FLASE                If Unicode FIFO buffer is not empty.\r
+  @retval FALSE                If Unicode FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1004,7 +1179,7 @@ IsUnicodeFiFoEmpty (
   @param  TerminalDevice       Terminal driver private structure\r
 \r
   @retval TRUE                 If Unicode FIFO buffer is full.\r
-  @retval FLASE                If Unicode FIFO buffer is not full.\r
+  @retval FALSE                If Unicode FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1233,7 +1408,8 @@ UnicodeToEfiKey (
         continue;\r
       }\r
 \r
-      if (UnicodeChar == 'O' && TerminalDevice->TerminalType == VT100TYPE) {\r
+      if (UnicodeChar == 'O' && (TerminalDevice->TerminalType == TerminalTypeVt100 ||\r
+                                 TerminalDevice->TerminalType == TerminalTypeTtyTerm)) {\r
         TerminalDevice->InputState |= INPUT_STATE_O;\r
         TerminalDevice->ResetState = RESET_STATE_DEFAULT;\r
         continue;\r
@@ -1241,8 +1417,8 @@ UnicodeToEfiKey (
 \r
       Key.ScanCode = SCAN_NULL;\r
 \r
-      if (TerminalDevice->TerminalType == VT100PLUSTYPE ||\r
-          TerminalDevice->TerminalType == VTUTF8TYPE) {\r
+      if (TerminalDevice->TerminalType == TerminalTypeVt100Plus ||\r
+          TerminalDevice->TerminalType == TerminalTypeVtUtf8) {\r
         switch (UnicodeChar) {\r
         case '1':\r
           Key.ScanCode = SCAN_F1;\r
@@ -1346,7 +1522,7 @@ UnicodeToEfiKey (
 \r
       Key.ScanCode = SCAN_NULL;\r
 \r
-      if (TerminalDevice->TerminalType == VT100TYPE) {\r
+      if (TerminalDevice->TerminalType == TerminalTypeVt100) {\r
         switch (UnicodeChar) {\r
         case 'P':\r
           Key.ScanCode = SCAN_F1;\r
@@ -1381,6 +1557,28 @@ UnicodeToEfiKey (
         default :\r
           break;\r
         }\r
+      } else if (TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\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
+          break;\r
+        case 'Q':\r
+          Key.ScanCode = SCAN_F2;\r
+          break;\r
+        case 'R':\r
+          Key.ScanCode = SCAN_F3;\r
+          break;\r
+        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
       if (Key.ScanCode != SCAN_NULL) {\r
@@ -1401,10 +1599,11 @@ UnicodeToEfiKey (
 \r
       Key.ScanCode = SCAN_NULL;\r
 \r
-      if (TerminalDevice->TerminalType == PCANSITYPE    ||\r
-          TerminalDevice->TerminalType == VT100TYPE     ||\r
-          TerminalDevice->TerminalType == VT100PLUSTYPE ||\r
-          TerminalDevice->TerminalType == VTUTF8TYPE) {\r
+      if (TerminalDevice->TerminalType == TerminalTypePcAnsi    ||\r
+          TerminalDevice->TerminalType == TerminalTypeVt100     ||\r
+          TerminalDevice->TerminalType == TerminalTypeVt100Plus ||\r
+          TerminalDevice->TerminalType == TerminalTypeVtUtf8    ||\r
+          TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\r
         switch (UnicodeChar) {\r
         case 'A':\r
           Key.ScanCode = SCAN_UP;\r
@@ -1419,100 +1618,104 @@ UnicodeToEfiKey (
           Key.ScanCode = SCAN_LEFT;\r
           break;\r
         case 'H':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE ||\r
-              TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi ||\r
+              TerminalDevice->TerminalType == TerminalTypeVt100  ||\r
+              TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\r
             Key.ScanCode = SCAN_HOME;\r
           }\r
           break;\r
         case 'F':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi ||\r
+              TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\r
             Key.ScanCode = SCAN_END;\r
           }\r
           break;\r
         case 'K':\r
-          if (TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypeVt100) {\r
             Key.ScanCode = SCAN_END;\r
           }\r
           break;\r
         case 'L':\r
         case '@':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE ||\r
-              TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi ||\r
+              TerminalDevice->TerminalType == TerminalTypeVt100) {\r
             Key.ScanCode = SCAN_INSERT;\r
           }\r
           break;\r
         case 'X':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_DELETE;\r
           }\r
           break;\r
         case 'P':\r
-          if (TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypeVt100) {\r
             Key.ScanCode = SCAN_DELETE;\r
-          } else if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          } else if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F4;\r
           }\r
           break;\r
         case 'I':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_PAGE_UP;\r
           }\r
           break;\r
         case 'V':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F10;\r
           }\r
+          break;\r
         case '?':\r
-          if (TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypeVt100) {\r
             Key.ScanCode = SCAN_PAGE_UP;\r
           }\r
           break;\r
         case 'G':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_PAGE_DOWN;\r
           }\r
           break;\r
         case 'U':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F9;\r
           }\r
+          break;\r
         case '/':\r
-          if (TerminalDevice->TerminalType == VT100TYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypeVt100) {\r
             Key.ScanCode = SCAN_PAGE_DOWN;\r
           }\r
           break;\r
         case 'M':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F1;\r
           }\r
           break;\r
         case 'N':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F2;\r
           }\r
           break;\r
         case 'O':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F3;\r
           }\r
           break;\r
         case 'Q':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F5;\r
           }\r
           break;\r
         case 'R':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F6;\r
           }\r
           break;\r
         case 'S':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F7;\r
           }\r
           break;\r
         case 'T':\r
-          if (TerminalDevice->TerminalType == PCANSITYPE) {\r
+          if (TerminalDevice->TerminalType == TerminalTypePcAnsi) {\r
             Key.ScanCode = SCAN_F8;\r
           }\r
           break;\r
@@ -1521,6 +1724,21 @@ UnicodeToEfiKey (
         }\r
       }\r
 \r
+      /*\r
+       * The VT220 escape codes that the TTY terminal accepts all have\r
+       * numeric codes, and there are no ambiguous prefixes shared with\r
+       * other terminal types.\r
+       */\r
+      if (TerminalDevice->TerminalType == TerminalTypeTtyTerm &&\r
+          Key.ScanCode == SCAN_NULL &&\r
+          UnicodeChar >= '0' &&\r
+          UnicodeChar <= '9') {\r
+        TerminalDevice->TtyEscapeStr[0] = UnicodeChar;\r
+        TerminalDevice->TtyEscapeIndex = 1;\r
+        TerminalDevice->InputState |= INPUT_STATE_LEFTOPENBRACKET_2;\r
+        continue;\r
+      }\r
+\r
       if (Key.ScanCode != SCAN_NULL) {\r
         Key.UnicodeChar = 0;\r
         EfiKeyFiFoInsertOneKey (TerminalDevice, &Key);\r
@@ -1534,6 +1752,74 @@ UnicodeToEfiKey (
       break;\r
 \r
 \r
+    case INPUT_STATE_ESC | INPUT_STATE_LEFTOPENBRACKET | INPUT_STATE_LEFTOPENBRACKET_2:\r
+      /*\r
+       * Here we handle the VT220 escape codes that we accept.  This\r
+       * state is only used by the TTY terminal type.\r
+       */\r
+      Key.ScanCode = SCAN_NULL;\r
+      if (TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\r
+\r
+        if (UnicodeChar == '~' && TerminalDevice->TtyEscapeIndex <= 2) {\r
+          UINT16 EscCode;\r
+          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
+          case 14:\r
+          case 15:\r
+            Key.ScanCode = SCAN_F1 + EscCode - 11;\r
+            break;\r
+          case 17:\r
+          case 18:\r
+          case 19:\r
+          case 20:\r
+          case 21:\r
+            Key.ScanCode = SCAN_F6 + EscCode - 17;\r
+            break;\r
+          case 23:\r
+          case 24:\r
+            Key.ScanCode = SCAN_F11 + EscCode - 23;\r
+            break;\r
+          default:\r
+            break;\r
+          }\r
+        } else if (TerminalDevice->TtyEscapeIndex == 1){\r
+          /* 2 character escape code   */\r
+          TerminalDevice->TtyEscapeStr[TerminalDevice->TtyEscapeIndex++] = UnicodeChar;\r
+          continue;\r
+        }\r
+        else {\r
+          DEBUG ((EFI_D_ERROR, "Unexpected state in escape2\n"));\r
+        }\r
+      }\r
+      TerminalDevice->ResetState = RESET_STATE_DEFAULT;\r
+\r
+      if (Key.ScanCode != SCAN_NULL) {\r
+        Key.UnicodeChar = 0;\r
+        EfiKeyFiFoInsertOneKey (TerminalDevice, &Key);\r
+        TerminalDevice->InputState = INPUT_STATE_DEFAULT;\r
+        UnicodeToEfiKeyFlushState (TerminalDevice);\r
+        continue;\r
+      }\r
+\r
+      UnicodeToEfiKeyFlushState (TerminalDevice);\r
+      break;\r
+\r
     default:\r
       //\r
       // Invalid state. This should never happen.\r
@@ -1568,8 +1854,14 @@ UnicodeToEfiKey (
     }\r
 \r
     if (UnicodeChar == DEL) {\r
-      Key.ScanCode    = SCAN_DELETE;\r
-      Key.UnicodeChar = 0;\r
+      if (TerminalDevice->TerminalType == TerminalTypeTtyTerm) {\r
+        Key.ScanCode    = SCAN_NULL;\r
+        Key.UnicodeChar = CHAR_BACKSPACE;\r
+      }\r
+      else {\r
+        Key.ScanCode    = SCAN_DELETE;\r
+        Key.UnicodeChar = 0;\r
+      }\r
     } else {\r
       Key.ScanCode    = SCAN_NULL;\r
       Key.UnicodeChar = UnicodeChar;\r