ShellPkg/UefiHandleParsingLib: Remove some unused Guids

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

/** @file\r
  Main file for DevTree shell Driver1 function.\r
\r
  (C) Copyright 2014-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 SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-d", TypeFlag},\r
  {L"-l", TypeValue},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Display a tree starting from this handle.\r
\r
  @param[in] TheHandle      The handle to start with.\r
  @param[in] Lang           Optionally, a UEFI defined language code.\r
  @param[in] UseDevPaths    TRUE to display info from DevPath as identifiers.\r
                            FALSE will use component name protocol instead.\r
  @param[in] IndentCharCount   How many characters to indent (allows for recursion).\r
  @param[in] HiiString      The string from HII to use for output.\r
\r
  @retval SHELL_SUCCESS     The operation was successful.\r
**/\r
SHELL_STATUS\r
DoDevTreeForHandle(\r
  IN CONST EFI_HANDLE TheHandle,\r
  IN CONST CHAR8      *Lang OPTIONAL,\r
  IN CONST BOOLEAN    UseDevPaths,\r
  IN CONST UINTN      IndentCharCount,\r
  IN CONST CHAR16     *HiiString\r
  )\r
{\r
  SHELL_STATUS        ShellStatus;\r
  EFI_STATUS          Status;\r
  CHAR16              *FormatString;\r
  CHAR16              *Name;\r
  EFI_HANDLE          *ChildHandleBuffer;\r
  UINTN               ChildCount;\r
  UINTN               LoopVar;\r
\r
  Status              = EFI_SUCCESS;\r
  ShellStatus         = SHELL_SUCCESS;\r
  Name                = NULL;\r
  ChildHandleBuffer   = NULL;\r
  ChildCount          = 0;\r
\r
  ASSERT (TheHandle != NULL);\r
  ASSERT (HiiString != NULL);\r
\r
  if (ShellGetExecutionBreakFlag()) {\r
    ShellStatus = SHELL_ABORTED;\r
    return ShellStatus;\r
  }\r
\r
  //\r
  // We want controller handles.  they will not have LoadedImage or DriverBinding (or others...)\r
  //\r
  Status = gBS->OpenProtocol (\r
                TheHandle,\r
                &gEfiDriverBindingProtocolGuid,\r
                NULL,\r
                NULL,\r
                NULL,\r
                EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
               );\r
  if (!EFI_ERROR (Status)) {\r
    return SHELL_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                TheHandle,\r
                &gEfiLoadedImageProtocolGuid,\r
                NULL,\r
                NULL,\r
                NULL,\r
                EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
               );\r
  if (!EFI_ERROR (Status)) {\r
    return SHELL_SUCCESS;\r
  }\r
\r
  FormatString = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r
  if (FormatString == NULL) {\r
    return SHELL_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // we generate the format string on the fly so that we can control the\r
  // number of space characters that the first (empty) string has.  this\r
  // handles the indenting.\r
  //\r
\r
  UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r
  gEfiShellProtocol->GetDeviceName((EFI_HANDLE)TheHandle, !UseDevPaths?EFI_DEVICE_NAME_USE_COMPONENT_NAME|EFI_DEVICE_NAME_USE_DEVICE_PATH:EFI_DEVICE_NAME_USE_DEVICE_PATH, (CHAR8*)Lang, &Name);\r
  //\r
  // print out the information for ourselves\r
  //\r
  ShellPrintEx(\r
    -1,\r
    -1,\r
    FormatString,\r
    L"",\r
    ConvertHandleToHandleIndex(TheHandle),\r
    Name==NULL?L"Unknown":Name);\r
\r
  FreePool(FormatString);\r
  if (Name != NULL) {\r
    FreePool(Name);\r
  }\r
\r
  //\r
  // recurse on each child handle with IndentCharCount + 2\r
  //\r
  ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r
  for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r
    ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r
    if (ShellStatus == SHELL_ABORTED) {\r
      break;\r
    }\r
  }\r
\r
  if (ChildHandleBuffer != NULL) {\r
    FreePool(ChildHandleBuffer);\r
  }\r
\r
  return (ShellStatus);\r
}\r
\r
/**\r
  Function for 'devtree' 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
ShellCommandRunDevTree (\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
  CHAR8               *Language;\r
  CONST CHAR16        *Lang;\r
  CHAR16              *HiiString;\r
  UINTN               LoopVar;\r
  EFI_HANDLE          TheHandle;\r
  BOOLEAN             FlagD;\r
  UINT64              Intermediate;\r
  UINTN               ParentControllerHandleCount;\r
  EFI_HANDLE          *ParentControllerHandleBuffer;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Status              = EFI_SUCCESS;\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"devtree", ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    if (ShellCommandLineGetCount(Package) > 2) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"devtree");\r
      ShellCommandLineFreeVarList (Package);\r
      return (SHELL_INVALID_PARAMETER);\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
      ASSERT(Language == NULL);\r
//      Language = AllocateZeroPool(10);\r
//      AsciiSPrint(Language, 10, "en-us");\r
    } else {\r
      ASSERT(Language == NULL);\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"devtree",  L"-l");\r
      ShellCommandLineFreeVarList (Package);\r
      return (SHELL_INVALID_PARAMETER);\r
    }\r
    FlagD = ShellCommandLineGetFlag(Package, L"-d");\r
\r
    Lang = ShellCommandLineGetRawValue(Package, 1);\r
    HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r
\r
    if (Lang == NULL) {\r
      for (LoopVar = 1 ; ; LoopVar++){\r
        TheHandle = ConvertHandleIndexToHandle(LoopVar);\r
        if (TheHandle == NULL){\r
          break;\r
        }\r
\r
        //\r
        // Skip handles that do not have device path protocol\r
        //\r
        Status = gBS->OpenProtocol (\r
                      TheHandle,\r
                      &gEfiDevicePathProtocolGuid,\r
                      NULL,\r
                      NULL,\r
                      NULL,\r
                      EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                     );\r
        if (EFI_ERROR (Status)) {\r
          continue;\r
        }\r
\r
        //\r
        // Skip handles that do have parents\r
        //\r
        ParentControllerHandleBuffer = NULL;\r
        Status = PARSE_HANDLE_DATABASE_PARENTS (\r
                   TheHandle,\r
                   &ParentControllerHandleCount,\r
                   &ParentControllerHandleBuffer\r
                   );\r
        SHELL_FREE_NON_NULL (ParentControllerHandleBuffer);\r
        if (ParentControllerHandleCount > 0) {\r
          continue;\r
        }\r
\r
        //\r
        // Start a devtree from TheHandle that has a device path and no parents\r
        //\r
        ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r
      }\r
    } else {\r
      Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r
      if (EFI_ERROR(Status) || ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"devtree", Lang);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r
      }\r
    }\r
\r
    if (HiiString != NULL) {\r
      FreePool(HiiString);\r
    }\r
    SHELL_FREE_NON_NULL(Language);\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
\r
  return (ShellStatus);\r
}\r