[mirror_edk2.git] / ShellPkg / Library / UefiShellDriver1CommandsLib / DrvDiag.c

/** @file\r
  Main file for DrvDiag shell Driver1 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UefiShellDriver1CommandsLib.h"\r
\r
STATIC CONST EFI_GUID *DiagGuidList[] = {&gEfiDriverDiagnosticsProtocolGuid, &gEfiDriverDiagnostics2ProtocolGuid, NULL};\r
//\r
// We need 1 more item on the list...\r
//\r
typedef enum {\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
DoDiagnostics (\r
  IN CONST DRV_DIAG_TEST_MODE Mode,\r
  IN CONST CHAR8              *Lang,\r
  IN CONST BOOLEAN            AllChilds,\r
  IN CONST EFI_HANDLE         DriverHandle,\r
  IN CONST EFI_HANDLE         ControllerHandle,\r
  IN CONST EFI_HANDLE         ChildHandle\r
  )\r
{\r
  EFI_DRIVER_DIAGNOSTICS_PROTOCOL     *DriverDiagnostics;\r
  EFI_DRIVER_DIAGNOSTICS2_PROTOCOL    *DriverDiagnostics2;\r
  EFI_HANDLE                          *DriverHandleList;\r
  EFI_HANDLE                          *ControllerHandleList;\r
  EFI_HANDLE                          *ChildHandleList;\r
  EFI_HANDLE                          *Walker;\r
  UINTN                               DriverHandleListCount;\r
  UINTN                               ControllerHandleListCount;\r
  UINTN                               ChildHandleListCount;\r
  UINTN                               DriverHandleListLoop;\r
  UINTN                               ControllerHandleListLoop;\r
  UINTN                               ChildHandleListLoop;\r
  EFI_STATUS                          Status;\r
  EFI_STATUS                          Status2;\r
  EFI_GUID                            *ErrorType;\r
  UINTN                               OutBufferSize;\r
  CHAR16                              *OutBuffer;\r
  UINTN                               HandleIndex1;\r
  UINTN                               HandleIndex2;\r
  CHAR8                               *Language;\r
  BOOLEAN                             Found;\r
\r
  if ((ChildHandle != NULL && AllChilds) || (Mode >= TestModeMax)){\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  DriverDiagnostics                   = NULL;\r
  DriverDiagnostics2                  = NULL;\r
  Status                              = EFI_SUCCESS;\r
  Status2                             = EFI_SUCCESS;\r
  DriverHandleList                    = NULL;\r
  ControllerHandleList                = NULL;\r
  ChildHandleList                     = NULL;\r
  Language                            = NULL;\r
  OutBuffer                           = NULL;\r
  ErrorType                           = NULL;\r
  DriverHandleListCount               = 0;\r
  ControllerHandleListCount           = 0;\r
  ChildHandleListCount                = 0;\r
\r
  if (DriverHandle != NULL) {\r
    DriverHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
    if (DriverHandleList == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    DriverHandleList[0] = DriverHandle;\r
    DriverHandleListCount = 1;\r
  } else {\r
    DriverHandleList = GetHandleListByProtocolList(DiagGuidList);\r
    if (DriverHandleList == NULL) {\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
  }\r
\r
  if (ControllerHandle != NULL) {\r
    ControllerHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
    if (ControllerHandleList == NULL) {\r
      SHELL_FREE_NON_NULL (DriverHandleList);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    ControllerHandleList[0] = ControllerHandle;\r
    ControllerHandleListCount = 1;\r
  } else {\r
    ControllerHandleList = NULL;\r
  }\r
\r
  if (ChildHandle != NULL) {\r
    ChildHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
    if (ChildHandleList == NULL) {\r
      SHELL_FREE_NON_NULL (ControllerHandleList);\r
      SHELL_FREE_NON_NULL (DriverHandleList);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    ChildHandleList[0] = ChildHandle;\r
    ChildHandleListCount = 1;\r
  } else if (AllChilds) {\r
    ChildHandleList = NULL;\r
    //\r
    // This gets handled in the loop below.\r
    //\r
  } else {\r
    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
    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 (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
        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
              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
            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
              STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE),\r
              gShellDriver1HiiHandle,\r
              HandleIndex1,\r
              HandleIndex2,\r
              ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop])\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
          }\r
        }\r
        if (AllChilds) {\r
          SHELL_FREE_NON_NULL(ChildHandleList);\r
          ChildHandleList       = NULL;\r
          ChildHandleListCount  = 0;\r
        }\r
      }\r
      if (ControllerHandle == NULL) {\r
        SHELL_FREE_NON_NULL(ControllerHandleList);\r
        ControllerHandleList      = NULL;\r
        ControllerHandleListCount = 0;\r
      }\r
      }\r
  }\r
\r
  if (DriverHandleList != NULL) {\r
    FreePool(DriverHandleList);\r
  }\r
  if (ControllerHandleList != NULL) {\r
    FreePool(ControllerHandleList);\r
  }\r
  if (ChildHandleList != NULL) {\r
    FreePool(ChildHandleList);\r
  }\r
  return (Status2);\r
}\r
\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-c", TypeFlag},\r
  {L"-s", TypeFlag},\r
  {L"-e", TypeFlag},\r
  {L"-m", TypeFlag},\r
  {L"-l", TypeValue},\r
  {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
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  LIST_ENTRY          *Package;\r
  CHAR16              *ProblemParam;\r
  SHELL_STATUS        ShellStatus;\r
  DRV_DIAG_TEST_MODE  Mode;\r
  CHAR8               *Language;\r
  CONST CHAR16        *DriverHandleStr;\r
  CONST CHAR16        *ControllerHandleStr;\r
  CONST CHAR16        *ChildHandleStr;\r
  CONST CHAR16        *Lang;\r
  EFI_HANDLE          Handle1;\r
  EFI_HANDLE          Handle2;\r
  EFI_HANDLE          Handle3;\r
  UINT64              Intermediate;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Mode                = TestModeMax;\r
  Language            = NULL;\r
\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  Status = CommandInit();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  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, L"drvdiag", ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    //\r
    // if more than 3 'value' parameters (plus the name one) or we have any 2 mode flags\r
    //\r
    if ((ShellCommandLineGetCount(Package) > 4)\r
      ||(ShellCommandLineGetFlag(Package, L"-s") && ShellCommandLineGetFlag(Package, L"-e"))\r
      ||(ShellCommandLineGetFlag(Package, L"-s") && ShellCommandLineGetFlag(Package, L"-m"))\r
      ||(ShellCommandLineGetFlag(Package, L"-e") && ShellCommandLineGetFlag(Package, L"-m"))\r
     ){\r
      //\r
      // error for too many parameters\r
      //\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
            || (ShellCommandLineGetFlag(Package, L"-m"))\r
           ){\r
      //\r
      // Run the appropriate test\r
      //\r
      if        (ShellCommandLineGetFlag(Package, L"-s")) {\r
        Mode =   TestModeStandard;\r
      } else if (ShellCommandLineGetFlag(Package, L"-e")) {\r
        Mode = TestModeExtended;\r
      } else if (ShellCommandLineGetFlag(Package, L"-m")) {\r
        Mode = TestModeManufacturing;\r
      } else {\r
        ASSERT(FALSE);\r
      }\r
    } else {\r
      //\r
      // Do a listing of what's available to test\r
      //\r
      Mode = TestModeList;\r
    }\r
\r
    Lang = ShellCommandLineGetValue(Package, L"-l");\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"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
    ControllerHandleStr = ShellCommandLineGetRawValue(Package, 2);\r
    ChildHandleStr      = ShellCommandLineGetRawValue(Package, 3);\r
\r
    if (DriverHandleStr == NULL) {\r
      Handle1 = NULL;\r
    } else {\r
      ShellConvertStringToUint64(DriverHandleStr, &Intermediate, TRUE, FALSE);\r
      Handle1 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
    }\r
    if (ControllerHandleStr == NULL) {\r
      Handle2 = NULL;\r
    } else {\r
      ShellConvertStringToUint64(ControllerHandleStr, &Intermediate, TRUE, FALSE);\r
      Handle2 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
    }\r
    if (ChildHandleStr == NULL) {\r
      Handle3 = NULL;\r
    } else {\r
      ShellConvertStringToUint64(ChildHandleStr, &Intermediate, TRUE, FALSE);\r
      Handle3 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
    }\r
\r
    Status = DoDiagnostics (\r
      Mode,\r
      Language,\r
      ShellCommandLineGetFlag(Package, L"-c"),\r
      Handle1,\r
      Handle2,\r
      Handle3\r
      );\r
\r
    SHELL_FREE_NON_NULL(Language);\r
    ShellCommandLineFreeVarList (Package);\r
\r
  }\r
  if (ShellStatus == SHELL_SUCCESS) {\r
    if (Status == EFI_SECURITY_VIOLATION) {\r
      ShellStatus = SHELL_SECURITY_VIOLATION;\r
    } else if (Status == EFI_INVALID_PARAMETER) {\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (Status == EFI_NOT_FOUND) {\r
      ShellStatus = SHELL_NOT_FOUND;\r
    } else if (EFI_ERROR(Status)) {\r
      ShellStatus = SHELL_NOT_FOUND;\r
    }\r
  }\r
\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
4ba49616	1	/** @file\r
	2	Main file for DrvDiag shell Driver1 function.\r
	3	\r
c011b6c9	4	(C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
ba0014b9	5	Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
56ba3746	6	SPDX-License-Identifier: BSD-2-Clause-Patent\r
4ba49616	7	\r
	8	**/\r
	9	\r
	10	#include "UefiShellDriver1CommandsLib.h"\r
	11	\r
	12	STATIC CONST EFI_GUID *DiagGuidList[] = {&gEfiDriverDiagnosticsProtocolGuid, &gEfiDriverDiagnostics2ProtocolGuid, NULL};\r
	13	//\r
	14	// We need 1 more item on the list...\r
	15	//\r
	16	typedef enum {\r
361a8267	17	TestModeStandard = EfiDriverDiagnosticTypeStandard,\r
	18	TestModeExtended = EfiDriverDiagnosticTypeExtended,\r
	19	TestModeManufacturing = EfiDriverDiagnosticTypeManufacturing,\r
	20	TestModeList,\r
	21	TestModeMax\r
4ba49616	22	} DRV_DIAG_TEST_MODE;\r
4ba49616	23	\r
361a8267	24	/**\r
	25	Do the diagnostics call for some set of handles.\r
	26	\r
	27	@param[in] Mode The type of diagnostic test to run.\r
	28	@param[in] Lang The language code to use.\r
	29	@param[in] AllChilds Should the test be on all children.\r
	30	@param[in] DriverHandle The driver handle to test with.\r
	31	@param[in] ControllerHandle The specific controller handle to test.\r
	32	@param[in] ChildHandle The specific child handle to test.\r
	33	\r
	34	@retval EFI_SUCCESS The operation was successful.\r
	35	@retval EFI_INVALID_PARAMETER A parameter had an invalid value.\r
	36	@retval EFI_NOT_FOUND No diagnostic handle could be found.\r
	37	**/\r
4ba49616	38	EFI_STATUS\r
4ba49616	39	DoDiagnostics (\r
	40	IN CONST DRV_DIAG_TEST_MODE Mode,\r
	41	IN CONST CHAR8 *Lang,\r
	42	IN CONST BOOLEAN AllChilds,\r
	43	IN CONST EFI_HANDLE DriverHandle,\r
	44	IN CONST EFI_HANDLE ControllerHandle,\r
	45	IN CONST EFI_HANDLE ChildHandle\r
	46	)\r
	47	{\r
	48	EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics;\r
	49	EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2;\r
	50	EFI_HANDLE *DriverHandleList;\r
	51	EFI_HANDLE *ControllerHandleList;\r
	52	EFI_HANDLE *ChildHandleList;\r
	53	EFI_HANDLE *Walker;\r
	54	UINTN DriverHandleListCount;\r
	55	UINTN ControllerHandleListCount;\r
	56	UINTN ChildHandleListCount;\r
	57	UINTN DriverHandleListLoop;\r
	58	UINTN ControllerHandleListLoop;\r
	59	UINTN ChildHandleListLoop;\r
	60	EFI_STATUS Status;\r
	61	EFI_STATUS Status2;\r
	62	EFI_GUID *ErrorType;\r
	63	UINTN OutBufferSize;\r
	64	CHAR16 *OutBuffer;\r
	65	UINTN HandleIndex1;\r
	66	UINTN HandleIndex2;\r
361a8267	67	CHAR8 *Language;\r
361a8267	68	BOOLEAN Found;\r
4ba49616	69	\r
361a8267	70	if ((ChildHandle != NULL && AllChilds) \|\| (Mode >= TestModeMax)){\r
4ba49616	71	return (EFI_INVALID_PARAMETER);\r
	72	}\r
	73	\r
	74	DriverDiagnostics = NULL;\r
	75	DriverDiagnostics2 = NULL;\r
	76	Status = EFI_SUCCESS;\r
	77	Status2 = EFI_SUCCESS;\r
	78	DriverHandleList = NULL;\r
	79	ControllerHandleList = NULL;\r
	80	ChildHandleList = NULL;\r
361a8267	81	Language = NULL;\r
4ba49616	82	OutBuffer = NULL;\r
	83	ErrorType = NULL;\r
	84	DriverHandleListCount = 0;\r
	85	ControllerHandleListCount = 0;\r
	86	ChildHandleListCount = 0;\r
	87	\r
	88	if (DriverHandle != NULL) {\r
	89	DriverHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
26ca45a8 RN	90	if (DriverHandleList == NULL) {\r
	91	return EFI_OUT_OF_RESOURCES;\r
	92	}\r
4ba49616	93	DriverHandleList[0] = DriverHandle;\r
	94	DriverHandleListCount = 1;\r
	95	} else {\r
	96	DriverHandleList = GetHandleListByProtocolList(DiagGuidList);\r
	97	if (DriverHandleList == NULL) {\r
ba0014b9 LG	98	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"drvdiag", L"gEfiDriverDiagnosticsProtocolGuid", &gEfiDriverDiagnosticsProtocolGuid);\r
ba0014b9 LG	99	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"drvdiag", L"gEfiDriverDiagnostics2ProtocolGuid", &gEfiDriverDiagnostics2ProtocolGuid);\r
4ba49616	100	return (EFI_NOT_FOUND);\r
ba0014b9	101	}\r
4ba49616	102	for (Walker = DriverHandleList ; Walker != NULL && *Walker != NULL ; DriverHandleListCount++, Walker++);\r
	103	}\r
	104	\r
	105	if (ControllerHandle != NULL) {\r
	106	ControllerHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
26ca45a8 RN	107	if (ControllerHandleList == NULL) {\r
	108	SHELL_FREE_NON_NULL (DriverHandleList);\r
	109	return EFI_OUT_OF_RESOURCES;\r
	110	}\r
4ba49616	111	ControllerHandleList[0] = ControllerHandle;\r
	112	ControllerHandleListCount = 1;\r
	113	} else {\r
	114	ControllerHandleList = NULL;\r
	115	}\r
	116	\r
	117	if (ChildHandle != NULL) {\r
	118	ChildHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
cb9f3a59	119	if (ChildHandleList == NULL) {\r
26ca45a8 RN	120	SHELL_FREE_NON_NULL (ControllerHandleList);\r
	121	SHELL_FREE_NON_NULL (DriverHandleList);\r
	122	return EFI_OUT_OF_RESOURCES;\r
	123	}\r
4ba49616	124	ChildHandleList[0] = ChildHandle;\r
	125	ChildHandleListCount = 1;\r
	126	} else if (AllChilds) {\r
	127	ChildHandleList = NULL;\r
	128	//\r
	129	// This gets handled in the loop below.\r
	130	//\r
	131	} else {\r
	132	ChildHandleList = NULL;\r
	133	}\r
	134	\r
361a8267	135	if (Mode == TestModeList) {\r
	136	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_HEADER), gShellDriver1HiiHandle);\r
	137	}\r
4ba49616	138	for (DriverHandleListLoop = 0\r
	139	; DriverHandleListLoop < DriverHandleListCount\r
	140	; DriverHandleListLoop++\r
	141	){\r
361a8267	142	if (Mode == TestModeList) {\r
	143	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_HEADER), gShellDriver1HiiHandle, ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]));\r
	144	}\r
4ba49616	145	if (ControllerHandle == NULL) {\r
4ba49616	146	PARSE_HANDLE_DATABASE_DEVICES(DriverHandleList[DriverHandleListLoop], &ControllerHandleListCount, &ControllerHandleList);\r
ba0014b9	147	}\r
361a8267	148	if (ControllerHandleListCount == 0) {\r
	149	if (Mode == TestModeList) {\r
	150	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_NO_HANDLES), gShellDriver1HiiHandle);\r
	151	}\r
	152	} else {\r
	153	if (Mode == TestModeList) {\r
	154	ShellPrintEx(-1, -1, L"\r\n");\r
4ba49616	155	}\r
361a8267	156	for (ControllerHandleListLoop = 0\r
	157	; ControllerHandleListLoop < ControllerHandleListCount\r
	158	; ControllerHandleListLoop++\r
4ba49616	159	){\r
361a8267	160	if (AllChilds) {\r
	161	ASSERT(ChildHandleList == NULL);\r
	162	PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(\r
ba0014b9	163	DriverHandleList[DriverHandleListLoop],\r
361a8267	164	ControllerHandleList[ControllerHandleListLoop],\r
	165	&ChildHandleListCount,\r
	166	&ChildHandleList);\r
	167	}\r
	168	for (ChildHandleListLoop = 0\r
	169	; (ChildHandleListLoop < ChildHandleListCount \|\| ChildHandleList == NULL)\r
	170	; ChildHandleListLoop++\r
	171	){\r
	172	Found = FALSE;\r
	173	if (Mode != TestModeList) {\r
	174	if (Lang == NULL \|\| Lang[2] == '-') {\r
	175	//\r
	176	// Get the protocol pointer and call the function\r
	177	//\r
	178	Status = gBS->OpenProtocol(\r
	179	DriverHandleList[DriverHandleListLoop],\r
	180	&gEfiDriverDiagnostics2ProtocolGuid,\r
	181	(VOID**)&DriverDiagnostics2,\r
	182	gImageHandle,\r
	183	NULL,\r
	184	EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
a71003f2 ED	185	if (!EFI_ERROR(Status) && (DriverDiagnostics2 != NULL)) {\r
a71003f2 ED	186	Language = GetBestLanguageForDriver(DriverDiagnostics2->SupportedLanguages, Lang, FALSE);\r
361a8267	187	Found = TRUE;\r
	188	Status = DriverDiagnostics2->RunDiagnostics(\r
	189	DriverDiagnostics2,\r
	190	ControllerHandleList[ControllerHandleListLoop],\r
	191	ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
	192	(EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
	193	Language,\r
	194	&ErrorType,\r
	195	&OutBufferSize,\r
	196	&OutBuffer);\r
	197	FreePool(Language);\r
	198	}\r
ba0014b9	199	}\r
a1d4bfcc	200	if (!Found && (Lang == NULL\|\|(Lang!=NULL&&(Lang[2]!='-')))){\r
361a8267	201	Status = gBS->OpenProtocol(\r
	202	DriverHandleList[DriverHandleListLoop],\r
	203	&gEfiDriverDiagnosticsProtocolGuid,\r
	204	(VOID**)&DriverDiagnostics,\r
	205	gImageHandle,\r
	206	NULL,\r
	207	EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
	208	if (!EFI_ERROR(Status)) {\r
a71003f2	209	Language = GetBestLanguageForDriver(DriverDiagnostics->SupportedLanguages, Lang, FALSE);\r
361a8267	210	Status = DriverDiagnostics->RunDiagnostics(\r
	211	DriverDiagnostics,\r
	212	ControllerHandleList[ControllerHandleListLoop],\r
	213	ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop],\r
	214	(EFI_DRIVER_DIAGNOSTIC_TYPE)Mode,\r
	215	Language,\r
	216	&ErrorType,\r
	217	&OutBufferSize,\r
	218	&OutBuffer);\r
	219	FreePool(Language);\r
	220	}\r
	221	}\r
	222	if (EFI_ERROR(Status)) {\r
	223	Status2 = Status;\r
	224	}\r
	225	HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
	226	HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
	227	ShellPrintHiiEx(\r
	228	-1,\r
	229	-1,\r
4ba49616	230	NULL,\r
361a8267	231	STRING_TOKEN (STR_3P_RESULT),\r
	232	gShellDriver1HiiHandle,\r
	233	L"DrvDiag",\r
	234	HandleIndex1,\r
	235	HandleIndex2,\r
	236	ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop]),\r
	237	Status);\r
	238	if (OutBuffer!=NULL) {\r
	239	FreePool(OutBuffer);\r
	240	OutBuffer = NULL;\r
	241	}\r
	242	if (ErrorType!=NULL) {\r
	243	FreePool(ErrorType);\r
	244	ErrorType = NULL;\r
4ba49616	245	}\r
4ba49616	246	} else {\r
361a8267	247	HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]);\r
	248	HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]);\r
	249	//\r
	250	// Print out the information that this set can be tested\r
	251	//\r
	252	ShellPrintHiiEx(\r
	253	-1,\r
	254	-1,\r
4ba49616	255	NULL,\r
361a8267	256	STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE),\r
	257	gShellDriver1HiiHandle,\r
	258	HandleIndex1,\r
	259	HandleIndex2,\r
	260	ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop])\r
	261	);\r
4ba49616	262	}\r
361a8267	263	\r
4ba49616	264	//\r
361a8267	265	// If we are doing a single pass with NULL child jump out after a single loop\r
4ba49616	266	//\r
361a8267	267	if (ChildHandleList == NULL) {\r
	268	break;\r
	269	}\r
4ba49616	270	}\r
361a8267	271	if (AllChilds) {\r
	272	SHELL_FREE_NON_NULL(ChildHandleList);\r
	273	ChildHandleList = NULL;\r
	274	ChildHandleListCount = 0;\r
4ba49616	275	}\r
4ba49616	276	}\r
361a8267	277	if (ControllerHandle == NULL) {\r
	278	SHELL_FREE_NON_NULL(ControllerHandleList);\r
	279	ControllerHandleList = NULL;\r
	280	ControllerHandleListCount = 0;\r
	281	}\r
4ba49616	282	}\r
4ba49616	283	}\r
	284	\r
	285	if (DriverHandleList != NULL) {\r
	286	FreePool(DriverHandleList);\r
	287	}\r
	288	if (ControllerHandleList != NULL) {\r
	289	FreePool(ControllerHandleList);\r
	290	}\r
	291	if (ChildHandleList != NULL) {\r
	292	FreePool(ChildHandleList);\r
	293	}\r
	294	return (Status2);\r
	295	}\r
	296	\r
	297	\r
	298	STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
	299	{L"-c", TypeFlag},\r
	300	{L"-s", TypeFlag},\r
	301	{L"-e", TypeFlag},\r
	302	{L"-m", TypeFlag},\r
	303	{L"-l", TypeValue},\r
	304	{NULL, TypeMax}\r
	305	};\r
	306	\r
361a8267	307	/**\r
	308	Function for 'drvdiag' command.\r
	309	\r
	310	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	311	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	312	**/\r
4ba49616	313	SHELL_STATUS\r
	314	EFIAPI\r
	315	ShellCommandRunDrvDiag (\r
	316	IN EFI_HANDLE ImageHandle,\r
	317	IN EFI_SYSTEM_TABLE *SystemTable\r
	318	)\r
	319	{\r
	320	EFI_STATUS Status;\r
	321	LIST_ENTRY *Package;\r
	322	CHAR16 *ProblemParam;\r
	323	SHELL_STATUS ShellStatus;\r
	324	DRV_DIAG_TEST_MODE Mode;\r
	325	CHAR8 *Language;\r
	326	CONST CHAR16 *DriverHandleStr;\r
	327	CONST CHAR16 *ControllerHandleStr;\r
	328	CONST CHAR16 *ChildHandleStr;\r
	329	CONST CHAR16 *Lang;\r
	330	EFI_HANDLE Handle1;\r
	331	EFI_HANDLE Handle2;\r
	332	EFI_HANDLE Handle3;\r
361a8267	333	UINT64 Intermediate;\r
4ba49616	334	\r
4ba49616	335	ShellStatus = SHELL_SUCCESS;\r
361a8267	336	Mode = TestModeMax;\r
4ba49616	337	Language = NULL;\r
	338	\r
	339	//\r
	340	// initialize the shell lib (we must be in non-auto-init...)\r
	341	//\r
	342	Status = ShellInitialize();\r
	343	ASSERT_EFI_ERROR(Status);\r
	344	\r
	345	Status = CommandInit();\r
	346	ASSERT_EFI_ERROR(Status);\r
	347	\r
	348	//\r
	349	// parse the command line\r
	350	//\r
	351	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	352	if (EFI_ERROR(Status)) {\r
	353	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
ba0014b9	354	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"drvdiag", ProblemParam);\r
4ba49616	355	FreePool(ProblemParam);\r
	356	ShellStatus = SHELL_INVALID_PARAMETER;\r
	357	} else {\r
	358	ASSERT(FALSE);\r
	359	}\r
	360	} else {\r
	361	//\r
	362	// if more than 3 'value' parameters (plus the name one) or we have any 2 mode flags\r
	363	//\r
	364	if ((ShellCommandLineGetCount(Package) > 4)\r
	365	\|\|(ShellCommandLineGetFlag(Package, L"-s") && ShellCommandLineGetFlag(Package, L"-e"))\r
	366	\|\|(ShellCommandLineGetFlag(Package, L"-s") && ShellCommandLineGetFlag(Package, L"-m"))\r
	367	\|\|(ShellCommandLineGetFlag(Package, L"-e") && ShellCommandLineGetFlag(Package, L"-m"))\r
	368	){\r
	369	//\r
	370	// error for too many parameters\r
	371	//\r
ba0014b9	372	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"drvdiag");\r
4ba49616	373	ShellStatus = SHELL_INVALID_PARAMETER;\r
	374	} else if ((ShellCommandLineGetFlag(Package, L"-s"))\r
	375	\|\| (ShellCommandLineGetFlag(Package, L"-e"))\r
	376	\|\| (ShellCommandLineGetFlag(Package, L"-m"))\r
	377	){\r
	378	//\r
1d322461	379	// Run the appropriate test\r
4ba49616	380	//\r
4ba49616	381	if (ShellCommandLineGetFlag(Package, L"-s")) {\r
361a8267	382	Mode = TestModeStandard;\r
4ba49616	383	} else if (ShellCommandLineGetFlag(Package, L"-e")) {\r
361a8267	384	Mode = TestModeExtended;\r
4ba49616	385	} else if (ShellCommandLineGetFlag(Package, L"-m")) {\r
361a8267	386	Mode = TestModeManufacturing;\r
4ba49616	387	} else {\r
	388	ASSERT(FALSE);\r
	389	}\r
	390	} else {\r
	391	//\r
	392	// Do a listing of what's available to test\r
	393	//\r
361a8267	394	Mode = TestModeList;\r
4ba49616	395	}\r
	396	\r
	397	Lang = ShellCommandLineGetValue(Package, L"-l");\r
361a8267	398	if (ShellCommandLineGetFlag(Package, L"-l") && Lang == NULL) {\r
4ba49616	399	ASSERT(Language == NULL);\r
ba0014b9	400	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"drvdiag", L"-l");\r
4ba49616	401	ShellCommandLineFreeVarList (Package);\r
4ba49616	402	return (SHELL_INVALID_PARAMETER);\r
361a8267	403	} else if (Lang != NULL) {\r
	404	Language = AllocateZeroPool(StrSize(Lang));\r
	405	AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
4ba49616	406	}\r
	407	\r
	408	DriverHandleStr = ShellCommandLineGetRawValue(Package, 1);\r
	409	ControllerHandleStr = ShellCommandLineGetRawValue(Package, 2);\r
	410	ChildHandleStr = ShellCommandLineGetRawValue(Package, 3);\r
	411	\r
	412	if (DriverHandleStr == NULL) {\r
	413	Handle1 = NULL;\r
	414	} else {\r
361a8267	415	ShellConvertStringToUint64(DriverHandleStr, &Intermediate, TRUE, FALSE);\r
361a8267	416	Handle1 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
4ba49616	417	}\r
	418	if (ControllerHandleStr == NULL) {\r
	419	Handle2 = NULL;\r
	420	} else {\r
361a8267	421	ShellConvertStringToUint64(ControllerHandleStr, &Intermediate, TRUE, FALSE);\r
361a8267	422	Handle2 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
4ba49616	423	}\r
	424	if (ChildHandleStr == NULL) {\r
	425	Handle3 = NULL;\r
	426	} else {\r
361a8267	427	ShellConvertStringToUint64(ChildHandleStr, &Intermediate, TRUE, FALSE);\r
361a8267	428	Handle3 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
4ba49616	429	}\r
	430	\r
	431	Status = DoDiagnostics (\r
	432	Mode,\r
	433	Language,\r
	434	ShellCommandLineGetFlag(Package, L"-c"),\r
ba0014b9 LG	435	Handle1,\r
ba0014b9 LG	436	Handle2,\r
4ba49616	437	Handle3\r
	438	);\r
	439	\r
	440	SHELL_FREE_NON_NULL(Language);\r
	441	ShellCommandLineFreeVarList (Package);\r
	442	\r
	443	}\r
	444	if (ShellStatus == SHELL_SUCCESS) {\r
	445	if (Status == EFI_SECURITY_VIOLATION) {\r
	446	ShellStatus = SHELL_SECURITY_VIOLATION;\r
	447	} else if (Status == EFI_INVALID_PARAMETER) {\r
	448	ShellStatus = SHELL_INVALID_PARAMETER;\r
	449	} else if (Status == EFI_NOT_FOUND) {\r
	450	ShellStatus = SHELL_NOT_FOUND;\r
	451	} else if (EFI_ERROR(Status)) {\r
	452	ShellStatus = SHELL_NOT_FOUND;\r
	453	}\r
	454	}\r
	455	\r
	456	return (ShellStatus);\r
	457	}\r