ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SerMode.c

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
index f86e8ba9685e884312960197c23ab95e39b451d9..eb415a3f16ad2e2d1c6ba1d8ce5ce2004033d904 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
@@ -1,14 +1,9 @@
 /** @file\r
   Main file for SerMode shell Debug1 function.\r
 \r
-  Copyright (c) 20052010, 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
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
+  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -16,9 +11,19 @@
 #include <Library/ShellLib.h>\r
 #include <Protocol/SerialIo.h>\r
 \r
+/**\r
+  Display information about a serial device by it's handle.\r
+\r
+  If HandleValid is FALSE, do all devices.\r
+\r
+  @param[in] HandleIdx      The handle index for the device.\r
+  @param[in] HandleValid    TRUE if HandleIdx is valid.\r
+\r
+  @retval SHELL_INVALID_PARAMETER   A parameter was invalid.\r
+  @retval SHELL_SUCCESS             The operation was successful.\r
+**/\r
 SHELL_STATUS\r
-EFIAPI\r
-iDisplaySettings (\r
+DisplaySettings (\r
   IN UINTN                   HandleIdx,\r
   IN BOOLEAN                 HandleValid\r
   )\r
@@ -39,7 +44,7 @@ iDisplaySettings (
 \r
   Status    = gBS->LocateHandleBuffer (ByProtocol, &gEfiSerialIoProtocolGuid, NULL, &NoHandles, &Handles);\r
   if (EFI_ERROR (Status)) {\r
-    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle);\r
+    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode");\r
     return SHELL_INVALID_PARAMETER;\r
   }\r
 \r
@@ -127,7 +132,7 @@ iDisplaySettings (
         StopBits\r
        );\r
     } else {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode");\r
       ShellStatus = SHELL_NOT_FOUND;\r
       break;\r
     }\r
@@ -139,7 +144,7 @@ iDisplaySettings (
 \r
   if (Index == NoHandles) {\r
     if ((NoHandles != 0 && HandleValid) || 0 == NoHandles) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NOT_FOUND), gShellDebug1HiiHandle);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NOT_FOUND), gShellDebug1HiiHandle, L"sermode");\r
       ShellStatus = SHELL_NOT_FOUND;\r
     }\r
   }\r
@@ -147,6 +152,12 @@ iDisplaySettings (
   return ShellStatus;\r
 }\r
 \r
+/**\r
+  Function for 'sermode' command.\r
+\r
+  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
+  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
+**/\r
 SHELL_STATUS\r
 EFIAPI\r
 ShellCommandRunSerMode (\r
@@ -169,6 +180,7 @@ ShellCommandRunSerMode (
   LIST_ENTRY              *Package;\r
   CHAR16                  *ProblemParam;\r
   CONST CHAR16            *Temp;\r
+  UINT64                  Intermediate;\r
 \r
   ShellStatus = SHELL_SUCCESS;\r
   HandleIdx   = 0;\r
@@ -181,42 +193,43 @@ ShellCommandRunSerMode (
   Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);\r
   if (EFI_ERROR(Status)) {\r
     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, ProblemParam);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"sermode", ProblemParam);\r
       FreePool(ProblemParam);\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else {\r
       ASSERT(FALSE);\r
     }\r
   } else {\r
-    if (ShellCommandLineGetCount(Package) < 5 && ShellCommandLineGetCount(Package) > 1) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle);\r
+    if (ShellCommandLineGetCount(Package) < 6 && ShellCommandLineGetCount(Package) > 2) {\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"sermode");\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
-    } else if (ShellCommandLineGetCount(Package) > 5) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle);\r
+    } else if (ShellCommandLineGetCount(Package) > 6) {\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"sermode");\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else {\r
       Temp = ShellCommandLineGetRawValue(Package, 1);\r
       if (Temp != NULL) {\r
-        HandleIdx = StrHexToUintn(Temp);\r
+        Status = ShellConvertStringToUint64(Temp, &Intermediate, TRUE, FALSE);\r
+        HandleIdx = (UINTN)Intermediate;\r
         Temp = ShellCommandLineGetRawValue(Package, 2);\r
         if (Temp == NULL) {\r
-          ShellStatus = iDisplaySettings (HandleIdx, TRUE);\r
+          ShellStatus = DisplaySettings (HandleIdx, TRUE);\r
           goto Done;\r
         }\r
       } else {\r
-        ShellStatus = iDisplaySettings (0, FALSE);\r
+        ShellStatus = DisplaySettings (0, FALSE);\r
         goto Done;\r
       }\r
       Temp = ShellCommandLineGetRawValue(Package, 2);\r
       if (Temp != NULL) {\r
-        BaudRate = StrHexToUintn(Temp);\r
+        BaudRate = ShellStrToUintn(Temp);\r
       } else {\r
         ASSERT(FALSE);\r
         BaudRate = 0;\r
       }\r
       Temp = ShellCommandLineGetRawValue(Package, 3);\r
       if (Temp == NULL || StrLen(Temp)>1) {\r
-        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, Temp);\r
+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp);\r
         ShellStatus = SHELL_INVALID_PARAMETER;\r
       } else {\r
         switch(Temp[0]){\r
@@ -245,14 +258,14 @@ ShellCommandRunSerMode (
           Parity = SpaceParity;\r
           break;\r
         default:\r
-          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, Temp);\r
+          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp);\r
           ShellStatus = SHELL_INVALID_PARAMETER;\r
           goto Done;\r
         }\r
       }\r
       Temp = ShellCommandLineGetRawValue(Package, 4);\r
       if (Temp != NULL) {\r
-        DataBits = StrHexToUintn(Temp);\r
+        DataBits = ShellStrToUintn(Temp);\r
       } else {\r
         //\r
         // make sure this is some number not in the list below.\r
@@ -265,12 +278,12 @@ ShellCommandRunSerMode (
       case 8:\r
         break;\r
       default:\r
-        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, Temp);\r
+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp);\r
         ShellStatus = SHELL_INVALID_PARAMETER;\r
         goto Done;\r
       }\r
       Temp = ShellCommandLineGetRawValue(Package, 5);\r
-      Value = StrHexToUintn(Temp);\r
+      Value = ShellStrToUintn(Temp);\r
       switch (Value) {\r
       case 0:\r
         StopBits = DefaultStopBits;\r
@@ -289,13 +302,13 @@ ShellCommandRunSerMode (
         break;\r
 \r
       default:\r
-        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, Temp);\r
+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp);\r
         ShellStatus = SHELL_INVALID_PARAMETER;\r
         goto Done;\r
       }\r
       Status = gBS->LocateHandleBuffer(ByProtocol, &gEfiSerialIoProtocolGuid, NULL, &NoHandles, &Handles);\r
       if (EFI_ERROR (Status)) {\r
-        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle);\r
+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode");\r
         ShellStatus = SHELL_INVALID_PARAMETER;\r
         goto Done;\r
       }\r
@@ -317,8 +330,16 @@ ShellCommandRunSerMode (
                               StopBits\r
                              );\r
           if (EFI_ERROR (Status)) {\r
-            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_FAIL), gShellDebug1HiiHandle, ConvertHandleToHandleIndex(Handles[Index]), Status);\r
-            ShellStatus = SHELL_ACCESS_DENIED;\r
+            if (Status == EFI_INVALID_PARAMETER) {\r
+              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_UNSUPPORTED), gShellDebug1HiiHandle, L"sermode", ConvertHandleToHandleIndex(Handles[Index]));\r
+              ShellStatus = SHELL_UNSUPPORTED;\r
+            } else if (Status == EFI_DEVICE_ERROR) {\r
+              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_DEV_ERROR), gShellDebug1HiiHandle, L"sermode", ConvertHandleToHandleIndex(Handles[Index]));\r
+              ShellStatus = SHELL_ACCESS_DENIED;\r
+            } else {\r
+              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_FAIL), gShellDebug1HiiHandle, L"sermode", ConvertHandleToHandleIndex(Handles[Index]));\r
+              ShellStatus = SHELL_ACCESS_DENIED;\r
+            }\r
           } else {\r
             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_HANDLE), gShellDebug1HiiHandle, ConvertHandleToHandleIndex(Handles[Index]));\r
           }\r
@@ -328,8 +349,8 @@ ShellCommandRunSerMode (
     }\r
   }\r
 \r
-  if (Index == NoHandles) {\r
-    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_BAD_HANDLE), gShellDebug1HiiHandle, HandleIdx);\r
+  if (ShellStatus == SHELL_SUCCESS && Index == NoHandles) {\r
+    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_BAD_HANDLE), gShellDebug1HiiHandle, L"sermode", HandleIdx);\r
     ShellStatus = SHELL_INVALID_PARAMETER;\r
   }\r
 \r