comp - add comments and add input verification

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
index 52612283a2bb4c1df26d14bb86ea54651e8744c8..e464d57fe48137bddd51208bbfbca62bf7c21253 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
@@ -1,7 +1,7 @@
 /** @file\r
   Main file for SerMode shell Debug1 function.\r
 \r
-  Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2005 - 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
@@ -16,9 +16,20 @@
 #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
@@ -147,6 +158,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 +186,7 @@ ShellCommandRunSerMode (
   LIST_ENTRY              *Package;\r
   CHAR16                  *ProblemParam;\r
   CONST CHAR16            *Temp;\r
+  UINT64                  Intermediate;\r
 \r
   ShellStatus = SHELL_SUCCESS;\r
   HandleIdx   = 0;\r
@@ -188,28 +206,29 @@ ShellCommandRunSerMode (
       ASSERT(FALSE);\r
     }\r
   } else {\r
-    if (ShellCommandLineGetCount(Package) < 5 && ShellCommandLineGetCount(Package) > 1) {\r
+    if (ShellCommandLineGetCount(Package) < 6 && ShellCommandLineGetCount(Package) > 2) {\r
       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle);\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
-    } else if (ShellCommandLineGetCount(Package) > 5) {\r
+    } else if (ShellCommandLineGetCount(Package) > 6) {\r
       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle);\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
@@ -252,7 +271,7 @@ ShellCommandRunSerMode (
       }\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
@@ -270,7 +289,7 @@ ShellCommandRunSerMode (
         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
@@ -328,7 +347,7 @@ ShellCommandRunSerMode (
     }\r
   }\r
 \r
-  if (Index == NoHandles) {\r
+  if (ShellStatus == SHELL_SUCCESS && Index == NoHandles) {\r
     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_BAD_HANDLE), gShellDebug1HiiHandle, HandleIdx);\r
     ShellStatus = SHELL_INVALID_PARAMETER;\r
   }\r