ShellPkg/UefiShellLib: clarify workaround for unfixable EdkShell bug

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

/** @file\r
  Main file for Unload 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
/**\r
  Function to dump LoadedImage info from TheHandle.\r
\r
  @param[in] TheHandle              The handle to dump info from.\r
\r
  @retval EFI_SUCCESS               The info was dumped.\r
  @retval EFI_INVALID_PARAMETER     The handle did not have LoadedImage\r
**/\r
EFI_STATUS\r
DumpLoadedImageProtocolInfo (\r
  IN EFI_HANDLE   TheHandle\r
  )\r
{\r
  CHAR16 *TheString;\r
\r
  TheString = GetProtocolInformationDump(TheHandle, &gEfiLoadedImageProtocolGuid, TRUE);\r
\r
  ShellPrintEx(-1, -1, L"%s", TheString);\r
\r
  SHELL_FREE_NON_NULL(TheString);\r
\r
  return (EFI_SUCCESS);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-n", TypeFlag},\r
  {L"-v", TypeFlag},\r
  {L"-verbose", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'unload' 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
ShellCommandRunUnload (\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
  EFI_HANDLE            TheHandle;\r
  CONST CHAR16          *Param1;\r
  SHELL_PROMPT_RESPONSE *Resp;\r
  UINT64                Value;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Package             = NULL;\r
  Resp                = NULL;\r
  Value               = 0;\r
  TheHandle           = 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
  //\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"unload", ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    if (ShellCommandLineGetCount(Package) > 2){\r
      //\r
      // error for too many parameters\r
      //\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"unload");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (ShellCommandLineGetCount(Package) < 2) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"unload");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      Param1    = ShellCommandLineGetRawValue(Package, 1);\r
      if (Param1 != NULL) {\r
        Status    = ShellConvertStringToUint64(Param1, &Value, TRUE, FALSE);\r
        TheHandle = ConvertHandleIndexToHandle((UINTN)Value);\r
      }\r
\r
      if (EFI_ERROR(Status) || Param1 == NULL || TheHandle == NULL){\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"unload", Param1);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        ASSERT(TheHandle != NULL);\r
        if (ShellCommandLineGetFlag(Package, L"-v") || ShellCommandLineGetFlag(Package, L"-verbose")) {\r
          DumpLoadedImageProtocolInfo(TheHandle);\r
        }\r
\r
        if (!ShellCommandLineGetFlag(Package, L"-n")) {\r
          Status = ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_UNLOAD_CONF), gShellDriver1HiiHandle, (UINTN)TheHandle);\r
          Status = ShellPromptForResponse(ShellPromptResponseTypeYesNo, NULL, (VOID**)&Resp);\r
        }\r
        if (ShellCommandLineGetFlag(Package, L"-n") || (Resp != NULL && *Resp == ShellPromptResponseYes)) {\r
          Status = gBS->UnloadImage(TheHandle);\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HANDLE_RESULT), gShellDriver1HiiHandle, L"Unload", (UINTN)TheHandle, Status);\r
        }\r
        SHELL_FREE_NON_NULL(Resp);\r
      }\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 (EFI_ERROR(Status)) {\r
      ShellStatus = SHELL_NOT_FOUND;\r
    }\r
  }\r
\r
  if (Package != NULL) {\r
    ShellCommandLineFreeVarList(Package);\r
  }\r
\r
  return (ShellStatus);\r
}\r