]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
MdeModulePkg: Use PcdSet##S to replace PcdSet##
[mirror_edk2.git] / MdeModulePkg / Universal / Console / TerminalDxe / TerminalConIn.c
index 547ef832f6e699f4e2c360fd95b631b7adbcf0e6..c216ed900fc5f9f6c7085e4c268449574fea2605 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
   Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.\r
 \r
-Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
+Copyright (c) 2006 - 2014, 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
@@ -157,7 +158,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 +296,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
@@ -324,7 +329,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 +357,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 +373,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 +398,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
@@ -416,7 +420,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
@@ -450,6 +454,7 @@ TranslateRawDataToEfiKey (
   case PCANSITYPE:\r
   case VT100TYPE:\r
   case VT100PLUSTYPE:\r
+  case TTYTERMTYPE:\r
     AnsiRawDataToUnicode (TerminalDevice);\r
     UnicodeToEfiKey (TerminalDevice);\r
     break;\r
@@ -644,7 +649,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
@@ -679,7 +684,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
@@ -713,7 +718,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
@@ -734,7 +739,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
@@ -763,7 +768,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
@@ -821,7 +826,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
@@ -844,7 +849,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
@@ -857,7 +862,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
@@ -878,7 +883,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
@@ -907,7 +912,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
@@ -939,15 +944,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
@@ -958,19 +962,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
@@ -979,7 +973,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
@@ -1000,7 +994,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
@@ -1229,7 +1223,8 @@ UnicodeToEfiKey (
         continue;\r
       }\r
 \r
-      if (UnicodeChar == 'O' && TerminalDevice->TerminalType == VT100TYPE) {\r
+      if (UnicodeChar == 'O' && (TerminalDevice->TerminalType == VT100TYPE ||\r
+                                 TerminalDevice->TerminalType == TTYTERMTYPE)) {\r
         TerminalDevice->InputState |= INPUT_STATE_O;\r
         TerminalDevice->ResetState = RESET_STATE_DEFAULT;\r
         continue;\r
@@ -1377,6 +1372,22 @@ UnicodeToEfiKey (
         default :\r
           break;\r
         }\r
+      } else if (TerminalDevice->TerminalType == TTYTERMTYPE) {\r
+        /* Also accept VT100 escape codes for F1-F4 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
+        }\r
       }\r
 \r
       if (Key.ScanCode != SCAN_NULL) {\r
@@ -1400,7 +1411,8 @@ UnicodeToEfiKey (
       if (TerminalDevice->TerminalType == PCANSITYPE    ||\r
           TerminalDevice->TerminalType == VT100TYPE     ||\r
           TerminalDevice->TerminalType == VT100PLUSTYPE ||\r
-          TerminalDevice->TerminalType == VTUTF8TYPE) {\r
+          TerminalDevice->TerminalType == VTUTF8TYPE    ||\r
+          TerminalDevice->TerminalType == TTYTERMTYPE) {\r
         switch (UnicodeChar) {\r
         case 'A':\r
           Key.ScanCode = SCAN_UP;\r
@@ -1458,6 +1470,7 @@ UnicodeToEfiKey (
           if (TerminalDevice->TerminalType == PCANSITYPE) {\r
             Key.ScanCode = SCAN_F10;\r
           }\r
+          break;\r
         case '?':\r
           if (TerminalDevice->TerminalType == VT100TYPE) {\r
             Key.ScanCode = SCAN_PAGE_UP;\r
@@ -1472,6 +1485,7 @@ UnicodeToEfiKey (
           if (TerminalDevice->TerminalType == PCANSITYPE) {\r
             Key.ScanCode = SCAN_F9;\r
           }\r
+          break;\r
         case '/':\r
           if (TerminalDevice->TerminalType == VT100TYPE) {\r
             Key.ScanCode = SCAN_PAGE_DOWN;\r
@@ -1517,6 +1531,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 == TTYTERMTYPE &&\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
@@ -1530,6 +1559,65 @@ 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 == TTYTERMTYPE) {\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 3:\r
+              Key.ScanCode = SCAN_DELETE;\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
@@ -1564,8 +1652,14 @@ UnicodeToEfiKey (
     }\r
 \r
     if (UnicodeChar == DEL) {\r
-      Key.ScanCode    = SCAN_DELETE;\r
-      Key.UnicodeChar = 0;\r
+      if (TerminalDevice->TerminalType == TTYTERMTYPE) {\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