]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Library/UefiShellDriver1CommandsLib/DrvDiag.c
ShellPkg: Standardized HP Copyright Message String
[mirror_edk2.git] / ShellPkg / Library / UefiShellDriver1CommandsLib / DrvDiag.c
index 9a8daecc9c36604b0a278c200b6590768e166c3f..271271120b0f1919db6ac92569653303250c9869 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
   Main file for DrvDiag shell Driver1 function.\r
 \r
-  Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
+  Copyright (c) 2010 - 2013, 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
@@ -19,13 +20,27 @@ STATIC CONST EFI_GUID *DiagGuidList[] = {&gEfiDriverDiagnosticsProtocolGuid, &gE
 // We need 1 more item on the list...\r
 //\r
 typedef enum {\r
-  TEST_MODE_STANDARD      = EfiDriverDiagnosticTypeStandard,\r
-  TEST_MODE_EXTENDED      = EfiDriverDiagnosticTypeExtended,\r
-  TEST_MODE_MANUFACTURING = EfiDriverDiagnosticTypeManufacturing,\r
-  TEST_MODE_LIST,\r
-  TEST_MODE_MAX\r
+  TestModeStandard      = EfiDriverDiagnosticTypeStandard,\r
+  TestModeExtended      = EfiDriverDiagnosticTypeExtended,\r
+  TestModeManufacturing = EfiDriverDiagnosticTypeManufacturing,\r
+  TestModeList,\r
+  TestModeMax\r
 } DRV_DIAG_TEST_MODE;\r
 \r
+/**\r
+  Do the diagnostics call for some set of handles.\r
+\r
+  @param[in] Mode               The type of diagnostic test to run.\r
+  @param[in] Lang               The language code to use.\r
+  @param[in] AllChilds          Should the test be on all children.\r
+  @param[in] DriverHandle       The driver handle to test with.\r
+  @param[in] ControllerHandle   The specific controller handle to test.\r
+  @param[in] ChildHandle        The specific child handle to test.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_INVALID_PARAMETER A parameter had an invalid value.\r
+  @retval EFI_NOT_FOUND         No diagnostic handle could be found.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DoDiagnostics (\r
@@ -56,13 +71,10 @@ DoDiagnostics (
   CHAR16                              *OutBuffer;\r
   UINTN                               HandleIndex1;\r
   UINTN                               HandleIndex2;\r
+  CHAR8                               *Language;\r
+  BOOLEAN                             Found;\r
 \r
-  if ((ChildHandle != NULL && AllChilds) || (Mode >= TEST_MODE_MAX)){\r
-    return (EFI_INVALID_PARAMETER);\r
-  }\r
-\r
-  if (Lang == NULL || AsciiStrLen(Lang) < 3) {\r
-    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"-l <value>");\r
+  if ((ChildHandle != NULL && AllChilds) || (Mode >= TestModeMax)){\r
     return (EFI_INVALID_PARAMETER);\r
   }\r
 \r
@@ -73,6 +85,7 @@ DoDiagnostics (
   DriverHandleList                    = NULL;\r
   ControllerHandleList                = NULL;\r
   ChildHandleList                     = NULL;\r
+  Language                            = NULL;\r
   OutBuffer                           = NULL;\r
   ErrorType                           = NULL;\r
   DriverHandleListCount               = 0;\r
@@ -87,7 +100,8 @@ DoDiagnostics (
   } else {\r
     DriverHandleList = GetHandleListByProtocolList(DiagGuidList);\r
     if (DriverHandleList == NULL) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVCFG_NONE), gShellDriver1HiiHandle);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"drvdiag", L"gEfiDriverDiagnosticsProtocolGuid", &gEfiDriverDiagnosticsProtocolGuid);  \r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"drvdiag", L"gEfiDriverDiagnostics2ProtocolGuid", &gEfiDriverDiagnostics2ProtocolGuid);  \r
       return (EFI_NOT_FOUND);\r
     } \r
     for (Walker = DriverHandleList ; Walker != NULL && *Walker != NULL ; DriverHandleListCount++, Walker++);\r
@@ -116,132 +130,154 @@ DoDiagnostics (
     ChildHandleList = NULL;\r
   }\r
 \r
+  if (Mode == TestModeList) {\r
+    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_HEADER), gShellDriver1HiiHandle);\r
+  }\r
   for (DriverHandleListLoop = 0\r
     ;  DriverHandleListLoop < DriverHandleListCount\r
     ;  DriverHandleListLoop++\r
     ){\r
+    if (Mode == TestModeList) {\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_HEADER), gShellDriver1HiiHandle, ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]));\r
+    }\r
     if (ControllerHandle == NULL) {\r
       PARSE_HANDLE_DATABASE_DEVICES(DriverHandleList[DriverHandleListLoop], &ControllerHandleListCount, &ControllerHandleList);\r
-    }\r
-    for (ControllerHandleListLoop = 0\r
-      ;  ControllerHandleListLoop < ControllerHandleListCount\r
-      ;  ControllerHandleListLoop++\r
-     ){\r
-      if (AllChilds) {\r
-        ASSERT(ChildHandleList == NULL);\r
-        PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(\r
-          DriverHandleList[DriverHandleListLoop], \r
-          ControllerHandleList[ControllerHandleListLoop],\r
-          &ChildHandleListCount,\r
-          &ChildHandleList);\r
+    } \r
+    if (ControllerHandleListCount == 0) {\r
+      if (Mode == TestModeList) {\r
+        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_NO_HANDLES), gShellDriver1HiiHandle);\r
+      }\r
+    } else {\r
+      if (Mode == TestModeList) {\r
+        ShellPrintEx(-1, -1, L"\r\n");\r
       }\r
-      for (ChildHandleListLoop = 0\r
-        ;  (ChildHandleListLoop < ChildHandleListCount || ChildHandleList == NULL)\r
-        ;  ChildHandleListLoop++\r
+      for (ControllerHandleListLoop = 0\r
+        ;  ControllerHandleListLoop < ControllerHandleListCount\r
+        ;  ControllerHandleListLoop++\r
         ){\r
-        if (Mode != TEST_MODE_LIST) {\r
-          if (Lang[2] == '-') {\r
-            //\r
-            // Get the protocol pointer and call the function\r
-            //\r
-            Status = gBS->OpenProtocol(\r
-              DriverHandleList[DriverHandleListLoop],\r
-              &gEfiDriverDiagnostics2ProtocolGuid,\r
-              (VOID**)&DriverDiagnostics2,\r
-              gImageHandle,\r
+        if (AllChilds) {\r
+          ASSERT(ChildHandleList == NULL);\r
+          PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(\r
+            DriverHandleList[DriverHandleListLoop], \r
+            ControllerHandleList[ControllerHandleListLoop],\r
+            &ChildHandleListCount,\r
+            &ChildHandleList);\r
+        }\r
+        for (ChildHandleListLoop = 0\r
+          ;  (ChildHandleListLoop < ChildHandleListCount || ChildHandleList == NULL)\r
+          ;  ChildHandleListLoop++\r
+          ){\r
+          Found = FALSE;\r
+          if (Mode != TestModeList) {\r
+            if (Lang == NULL || Lang[2] == '-') {\r
+              //\r
+              // Get the protocol pointer and call the function\r
+              //\r
+              Status = gBS->OpenProtocol(\r
+                DriverHandleList[DriverHandleListLoop],\r
+                &gEfiDriverDiagnostics2ProtocolGuid,\r
+                (VOID**)&DriverDiagnostics2,\r
+                gImageHandle,\r
+                NULL,\r
+                EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
+              if (!EFI_ERROR(Status) && (DriverDiagnostics2 != NULL)) {\r
+                Language = GetBestLanguageForDriver(DriverDiagnostics2->SupportedLanguages, Lang, FALSE);\r
+                Found = TRUE;\r
+                Status = DriverDiagnostics2->RunDiagnostics(\r
+                  DriverDiagnostics2,\r
+                  ControllerHandleList[ControllerHandleListLoop],\r
+                  ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
+                  (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
+                  Language,\r
+                  &ErrorType,\r
+                  &OutBufferSize,\r
+                  &OutBuffer);\r
+                FreePool(Language);\r
+              }\r
+            } \r
+            if (!Found && (Lang == NULL||(Lang!=NULL&&(Lang[2]!='-')))){\r
+              Status = gBS->OpenProtocol(\r
+                DriverHandleList[DriverHandleListLoop],\r
+                &gEfiDriverDiagnosticsProtocolGuid,\r
+                (VOID**)&DriverDiagnostics,\r
+                gImageHandle,\r
+                NULL,\r
+                EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
+              if (!EFI_ERROR(Status)) {\r
+                Language = GetBestLanguageForDriver(DriverDiagnostics->SupportedLanguages, Lang, FALSE);\r
+                Status = DriverDiagnostics->RunDiagnostics(\r
+                  DriverDiagnostics,\r
+                  ControllerHandleList[ControllerHandleListLoop],\r
+                  ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
+                  (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
+                  Language,\r
+                  &ErrorType,\r
+                  &OutBufferSize,\r
+                  &OutBuffer);\r
+                FreePool(Language);\r
+              }\r
+            }\r
+            if (EFI_ERROR(Status)) {\r
+              Status2 = Status;\r
+            }\r
+            HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
+            HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
+            ShellPrintHiiEx(\r
+              -1,\r
+              -1,\r
               NULL,\r
-              EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
-            if (!EFI_ERROR(Status)) {\r
-              Status = DriverDiagnostics2->RunDiagnostics(\r
-                DriverDiagnostics2,\r
-                ControllerHandleList[ControllerHandleListLoop],\r
-                ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
-                (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
-                (CHAR8*)Lang,\r
-                &ErrorType,\r
-                &OutBufferSize,\r
-                &OutBuffer);\r
+              STRING_TOKEN (STR_3P_RESULT),\r
+              gShellDriver1HiiHandle,\r
+              L"DrvDiag",\r
+              HandleIndex1,\r
+              HandleIndex2,\r
+              ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop]),\r
+              Status);\r
+            if (OutBuffer!=NULL) {\r
+              FreePool(OutBuffer);\r
+              OutBuffer = NULL;\r
+            }\r
+            if (ErrorType!=NULL) {\r
+              FreePool(ErrorType);\r
+              ErrorType = NULL;\r
             }\r
           } else {\r
-            Status = gBS->OpenProtocol(\r
-              DriverHandleList[DriverHandleListLoop],\r
-              &gEfiDriverDiagnosticsProtocolGuid,\r
-              (VOID**)&DriverDiagnostics,\r
-              gImageHandle,\r
+            HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
+            HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
+            //\r
+            // Print out the information that this set can be tested\r
+            //\r
+            ShellPrintHiiEx(\r
+              -1,\r
+              -1,\r
               NULL,\r
-              EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
-            if (!EFI_ERROR(Status)) {\r
-              Status = DriverDiagnostics->RunDiagnostics(\r
-                DriverDiagnostics,\r
-                ControllerHandleList[ControllerHandleListLoop],\r
-                ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
-                (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
-                (CHAR8*)Lang,\r
-                &ErrorType,\r
-                &OutBufferSize,\r
-                &OutBuffer);\r
-            }\r
-          }\r
-          if (EFI_ERROR(Status)) {\r
-            Status2 = Status;\r
-          }\r
-          HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
-          HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
-          ShellPrintHiiEx(\r
-            -1,\r
-            -1,\r
-            NULL,\r
-            STRING_TOKEN (STR_3P_RESULT),\r
-            gShellDriver1HiiHandle,\r
-            L"DrvDiag",\r
-            HandleIndex1,\r
-            HandleIndex2,\r
-            ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop]),\r
-            Status);\r
-          if (OutBuffer!=NULL) {\r
-            FreePool(OutBuffer);\r
-            OutBuffer = NULL;\r
-          }\r
-          if (ErrorType!=NULL) {\r
-            FreePool(ErrorType);\r
-            ErrorType = NULL;\r
+              STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE),\r
+              gShellDriver1HiiHandle,\r
+              HandleIndex1,\r
+              HandleIndex2,\r
+              ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop])\r
+           );\r
           }\r
-        } else {\r
-          HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
-          HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
+\r
           //\r
-          // Print out the information that this set can be tested\r
+          // If we are doing a single pass with NULL child jump out after a single loop\r
           //\r
-          ShellPrintHiiEx(\r
-            -1,\r
-            -1,\r
-            NULL,\r
-            STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE),\r
-            gShellDriver1HiiHandle,\r
-            HandleIndex1,\r
-            HandleIndex2,\r
-            ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop])\r
-         );\r
+          if (ChildHandleList == NULL) {\r
+            break;\r
+          }\r
         }\r
-\r
-        //\r
-        // If we are doing a single pass with NULL child jump out after a single loop\r
-        //\r
-        if (ChildHandleList == NULL) {\r
-          break;\r
+        if (AllChilds) {\r
+          SHELL_FREE_NON_NULL(ChildHandleList);\r
+          ChildHandleList       = NULL;\r
+          ChildHandleListCount  = 0;\r
         }\r
       }\r
-      if (AllChilds) {\r
-        SHELL_FREE_NON_NULL(ChildHandleList);\r
-        ChildHandleList       = NULL;\r
-        ChildHandleListCount  = 0;\r
+      if (ControllerHandle == NULL) {\r
+        SHELL_FREE_NON_NULL(ControllerHandleList);\r
+        ControllerHandleList      = NULL;\r
+        ControllerHandleListCount = 0;\r
+      }\r
       }\r
-    }\r
-    if (ControllerHandle == NULL) {\r
-      SHELL_FREE_NON_NULL(ControllerHandleList);\r
-      ControllerHandleList      = NULL;\r
-      ControllerHandleListCount = 0;\r
-    }\r
   }\r
 \r
   if (DriverHandleList != NULL) {\r
@@ -266,6 +302,12 @@ STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
   {NULL, TypeMax}\r
   };\r
 \r
+/**\r
+  Function for 'drvdiag' 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
 ShellCommandRunDrvDiag (\r
@@ -286,9 +328,10 @@ ShellCommandRunDrvDiag (
   EFI_HANDLE          Handle1;\r
   EFI_HANDLE          Handle2;\r
   EFI_HANDLE          Handle3;\r
+  UINT64              Intermediate;\r
 \r
   ShellStatus         = SHELL_SUCCESS;\r
-  Mode                = TEST_MODE_MAX;\r
+  Mode                = TestModeMax;\r
   Language            = NULL;\r
 \r
   //\r
@@ -306,7 +349,7 @@ ShellCommandRunDrvDiag (
   Status = ShellCommandLineParse (ParamList, &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), gShellDriver1HiiHandle, ProblemParam);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"drvdiag", ProblemParam);  \r
       FreePool(ProblemParam);\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else {\r
@@ -324,7 +367,7 @@ ShellCommandRunDrvDiag (
       //\r
       // error for too many parameters\r
       //\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"drvdiag");  \r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else if ((ShellCommandLineGetFlag(Package, L"-s"))\r
             || (ShellCommandLineGetFlag(Package, L"-e"))\r
@@ -334,11 +377,11 @@ ShellCommandRunDrvDiag (
       // Run the apropriate test\r
       //\r
       if        (ShellCommandLineGetFlag(Package, L"-s")) {\r
-        Mode =   TEST_MODE_STANDARD;\r
+        Mode =   TestModeStandard;\r
       } else if (ShellCommandLineGetFlag(Package, L"-e")) {\r
-        Mode = TEST_MODE_EXTENDED;\r
+        Mode = TestModeExtended;\r
       } else if (ShellCommandLineGetFlag(Package, L"-m")) {\r
-        Mode = TEST_MODE_MANUFACTURING;\r
+        Mode = TestModeManufacturing;\r
       } else {\r
         ASSERT(FALSE);\r
       }\r
@@ -346,21 +389,18 @@ ShellCommandRunDrvDiag (
       //\r
       // Do a listing of what's available to test\r
       //\r
-      Mode = TEST_MODE_LIST;\r
+      Mode = TestModeList;\r
     }\r
 \r
     Lang = ShellCommandLineGetValue(Package, L"-l");\r
-    if (Lang != NULL) {\r
-      Language = AllocateZeroPool(StrSize(Lang));\r
-      AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
-    } else if (!ShellCommandLineGetFlag(Package, L"-l")){\r
-      Language = AllocateZeroPool(10);\r
-      AsciiSPrint(Language, 10, "en-us");\r
-    } else {\r
+    if (ShellCommandLineGetFlag(Package, L"-l") && Lang == NULL) {\r
       ASSERT(Language == NULL);\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"drvdiag",  L"-l");  \r
       ShellCommandLineFreeVarList (Package);\r
       return (SHELL_INVALID_PARAMETER);\r
+    } else if (Lang != NULL) {\r
+      Language = AllocateZeroPool(StrSize(Lang));\r
+      AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
     }\r
 \r
     DriverHandleStr     = ShellCommandLineGetRawValue(Package, 1);\r
@@ -370,17 +410,20 @@ ShellCommandRunDrvDiag (
     if (DriverHandleStr == NULL) {\r
       Handle1 = NULL;\r
     } else {\r
-      Handle1 = ConvertHandleIndexToHandle(StrHexToUintn(DriverHandleStr    ));\r
+      ShellConvertStringToUint64(DriverHandleStr, &Intermediate, TRUE, FALSE);\r
+      Handle1 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
     }\r
     if (ControllerHandleStr == NULL) {\r
       Handle2 = NULL;\r
     } else {\r
-      Handle2 = ConvertHandleIndexToHandle(StrHexToUintn(ControllerHandleStr));\r
+      ShellConvertStringToUint64(ControllerHandleStr, &Intermediate, TRUE, FALSE);\r
+      Handle2 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
     }\r
     if (ChildHandleStr == NULL) {\r
       Handle3 = NULL;\r
     } else {\r
-      Handle3 = ConvertHandleIndexToHandle(StrHexToUintn(ChildHandleStr     ));\r
+      ShellConvertStringToUint64(ChildHandleStr, &Intermediate, TRUE, FALSE);\r
+      Handle3 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
     }\r
 \r
     Status = DoDiagnostics (\r