Update return value.

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

/** @file\r
  Main file for devices shell Driver1 function.\r
\r
  Copyright (c) 2010, 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
\r
**/\r
\r
#include "UefiShellDriver1CommandsLib.h"\r
\r
EFI_STATUS\r
EFIAPI\r
GetDeviceHandleInfo (\r
  IN EFI_HANDLE   TheHandle,\r
  IN CHAR16       *Type,\r
  IN BOOLEAN      *Cfg,\r
  IN BOOLEAN      *Diag,\r
  IN UINTN        *Parents,\r
  IN UINTN        *Devices,\r
  IN UINTN        *Children,\r
  OUT CHAR16      **Name,\r
  IN CONST CHAR8  *Language\r
  )\r
{\r
  EFI_STATUS    Status;\r
  EFI_HANDLE    *HandleBuffer;\r
  UINTN         Count;\r
\r
  if (TheHandle == NULL \r
    || Type == NULL\r
    || Cfg == NULL\r
    || Diag == NULL\r
    || Parents == NULL\r
    || Devices == NULL\r
    || Children == NULL\r
    || Name == NULL ) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  *Cfg          = FALSE;\r
  *Diag         = FALSE;\r
  *Children     = 0;\r
  *Parents      = 0;\r
  *Devices      = 0;\r
  *Type         = L' ';\r
  *Name         = CHAR_NULL;\r
  HandleBuffer  = NULL;\r
  Status        = EFI_SUCCESS;\r
\r
  gEfiShellProtocol->GetDeviceName(TheHandle, EFI_DEVICE_NAME_USE_COMPONENT_NAME|EFI_DEVICE_NAME_USE_DEVICE_PATH, (CHAR8*)Language, Name);\r
\r
  Status = ParseHandleDatabaseForChildControllers(TheHandle, Children, NULL);\r
  if (!EFI_ERROR(Status)) {\r
    Status = PARSE_HANDLE_DATABASE_PARENTS(TheHandle, Parents, NULL);\r
    if (/*!EFI_ERROR(Status) && */Parents != NULL && Children != NULL) {\r
      if (*Parents == 0) {\r
        *Type = L'R';\r
      } else if (*Children > 0) {\r
        *Type = L'B';\r
      } else {\r
        *Type = L'D';\r
      }\r
    }\r
  }\r
  Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS(TheHandle, Devices, &HandleBuffer);\r
  if (!EFI_ERROR(Status) && Devices != NULL && HandleBuffer != NULL) {\r
    for (Count = 0 ; Count < *Devices ; Count++) {\r
      if (!EFI_ERROR(gBS->OpenProtocol(HandleBuffer[Count], &gEfiDriverConfigurationProtocolGuid, NULL, NULL, gImageHandle, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
        *Cfg = TRUE;\r
      }\r
      if (!EFI_ERROR(gBS->OpenProtocol(HandleBuffer[Count], &gEfiDriverDiagnosticsProtocolGuid, NULL, NULL, gImageHandle, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
        *Diag = TRUE;\r
      }\r
      if (!EFI_ERROR(gBS->OpenProtocol(HandleBuffer[Count], &gEfiDriverDiagnostics2ProtocolGuid, NULL, NULL, gImageHandle, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
        *Diag = TRUE;\r
      }\r
    }\r
    SHELL_FREE_NON_NULL(HandleBuffer);\r
  }\r
\r
  return (Status);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-l", TypeValue},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'devices' 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
ShellCommandRunDevices (\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
  EFI_HANDLE          *HandleList;\r
  EFI_HANDLE          *HandleListWalker;\r
  CHAR16              Type;\r
  BOOLEAN             Cfg;\r
  BOOLEAN             Diag;\r
  UINTN               Parents;\r
  UINTN               Devices;\r
  UINTN               Children;\r
  CHAR16              *Name;\r
  CONST CHAR16        *Lang;\r
\r
  ShellStatus         = SHELL_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, ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    //\r
    // if more than 0 'value' parameters  we have too many parameters\r
    //\r
    if (ShellCommandLineGetRawValue(Package, 1) != NULL){\r
      //\r
      // error for too many parameters\r
      //\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      //\r
      // get the language if necessary\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"-l");\r
        ShellCommandLineFreeVarList (Package);\r
        return (SHELL_INVALID_PARAMETER);\r
      }\r
\r
\r
      //\r
      // Print Header\r
      //\r
      ShellPrintHiiEx(-1, -1, Language, STRING_TOKEN (STR_DEVICES_HEADER_LINES), gShellDriver1HiiHandle);\r
\r
      //\r
      // loop through each handle\r
      //\r
      HandleList = GetHandleListByProtocol(NULL);\r
      ASSERT(HandleList != NULL);\r
      for (HandleListWalker = HandleList\r
        ;  HandleListWalker != NULL && *HandleListWalker != NULL /*&& !EFI_ERROR(Status)*/\r
        ;  HandleListWalker++\r
       ){\r
\r
        //\r
        // get all the info on each handle\r
        //\r
        Name = NULL;\r
        Status = GetDeviceHandleInfo(*HandleListWalker, &Type, &Cfg, &Diag, &Parents, &Devices, &Children, &Name, Language);\r
        if (Parents != 0 || Devices != 0 || Children != 0) {\r
          ShellPrintHiiEx(\r
            -1,\r
            -1,\r
            Language,\r
            STRING_TOKEN (STR_DEVICES_ITEM_LINE),\r
            gShellDriver1HiiHandle,\r
            ConvertHandleToHandleIndex(*HandleListWalker),\r
            Type,\r
            Cfg?L'X':L'-',\r
            Diag?L'X':L'-',\r
            Parents,\r
            Devices,\r
            Children,\r
            Name!=NULL?Name:L"<UNKNOWN>");\r
        }\r
        if (Name != NULL) {\r
          FreePool(Name);\r
        }\r
      }\r
\r
      if (HandleList != NULL) {\r
        FreePool(HandleList);\r
      }\r
 \r
    }\r
    SHELL_FREE_NON_NULL(Language);\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
  return (ShellStatus);\r
}\r
\r