ShellPkg: acpiview: Add -r parameter for table requirements validation

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / UefiShellAcpiViewCommandLib.c

/** @file\r
  Main file for 'acpiview' Shell command function.\r
\r
  Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Guid/ShellLibHiiGuid.h>\r
#include <IndustryStandard/Acpi.h>\r
#include <Library/HiiLib.h>\r
#include <Library/ShellCommandLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Uefi.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
#include "AcpiView.h"\r
#include "UefiShellAcpiViewCommandLib.h"\r
\r
CONST CHAR16 gShellAcpiViewFileName[] = L"ShellCommand";\r
\r
/**\r
  A list of available table parsers.\r
*/\r
STATIC\r
CONST\r
ACPI_TABLE_PARSER ParserList[] = {\r
  {EFI_ACPI_6_2_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE, ParseAcpiBgrt},\r
  {EFI_ACPI_6_2_DEBUG_PORT_2_TABLE_SIGNATURE, ParseAcpiDbg2},\r
  {EFI_ACPI_6_2_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,\r
   ParseAcpiDsdt},\r
  {EFI_ACPI_6_3_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE, ParseAcpiFacs},\r
  {EFI_ACPI_6_2_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiFadt},\r
  {EFI_ACPI_6_2_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiGtdt},\r
  {EFI_ACPI_6_2_IO_REMAPPING_TABLE_SIGNATURE, ParseAcpiIort},\r
  {EFI_ACPI_6_2_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiMadt},\r
  {EFI_ACPI_6_2_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE,\r
   ParseAcpiMcfg},\r
  {EFI_ACPI_6_2_PROCESSOR_PROPERTIES_TOPOLOGY_TABLE_STRUCTURE_SIGNATURE,\r
   ParseAcpiPptt},\r
  {RSDP_TABLE_INFO, ParseAcpiRsdp},\r
  {EFI_ACPI_6_2_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE, ParseAcpiSlit},\r
  {EFI_ACPI_6_2_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE, ParseAcpiSpcr},\r
  {EFI_ACPI_6_2_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE, ParseAcpiSrat},\r
  {EFI_ACPI_6_2_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiSsdt},\r
  {EFI_ACPI_6_2_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiXsdt}\r
};\r
\r
/**\r
  This function registers all the available table parsers.\r
\r
  @retval EFI_SUCCESS           The parser is registered.\r
  @retval EFI_ALREADY_STARTED   The parser for the ACPI Table\r
                                was already registered.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_OUT_OF_RESOURCES  No space to register the\r
                                parser.\r
**/\r
EFI_STATUS\r
RegisterAllParsers (\r
  )\r
{\r
  EFI_STATUS Status;\r
  UINTN Count;\r
\r
  Status = EFI_SUCCESS;\r
  Count = sizeof (ParserList) / sizeof (ParserList[0]);\r
\r
  while (Count-- != 0) {\r
    Status = RegisterParser (\r
               ParserList[Count].Signature,\r
               ParserList[Count].Parser\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Return the file name of the help text file if not using HII.\r
\r
  @return The string pointer to the file name.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
ShellCommandGetManFileNameAcpiView (\r
  VOID\r
  )\r
{\r
  return gShellAcpiViewFileName;\r
}\r
\r
/**\r
  Constructor for the Shell AcpiView Command library.\r
\r
  Install the handlers for acpiview UEFI Shell command.\r
\r
  @param ImageHandle            The image handle of the process.\r
  @param SystemTable            The EFI System Table pointer.\r
\r
  @retval EFI_SUCCESS           The Shell command handlers were installed\r
                                successfully.\r
  @retval EFI_DEVICE_ERROR      Hii package failed to install.\r
**/\r
EFI_STATUS\r
EFIAPI\r
UefiShellAcpiViewCommandLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS Status;\r
  gShellAcpiViewHiiHandle = NULL;\r
\r
  // Check Shell Profile Debug1 bit of the profiles mask\r
  if ((PcdGet8 (PcdShellProfileMask) & BIT1) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = RegisterAllParsers ();\r
  if (EFI_ERROR (Status)) {\r
    Print (L"acpiview: Error failed to register parser.\n");\r
    return Status;\r
  }\r
\r
  gShellAcpiViewHiiHandle = HiiAddPackages (\r
                              &gShellAcpiViewHiiGuid,\r
                              gImageHandle,\r
                              UefiShellAcpiViewCommandLibStrings,\r
                              NULL\r
                              );\r
  if (gShellAcpiViewHiiHandle == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
  // Install our Shell command handler\r
  ShellCommandRegisterCommandName (\r
    L"acpiview",\r
    ShellCommandRunAcpiView,\r
    ShellCommandGetManFileNameAcpiView,\r
    0,\r
    L"acpiview",\r
    TRUE,\r
    gShellAcpiViewHiiHandle,\r
    STRING_TOKEN (STR_GET_HELP_ACPIVIEW)\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Destructor for the library. free any resources.\r
\r
  @param ImageHandle            The image handle of the process.\r
  @param SystemTable            The EFI System Table pointer.\r
**/\r
EFI_STATUS\r
EFIAPI\r
UefiShellAcpiViewCommandLibDestructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  if (gShellAcpiViewHiiHandle != NULL) {\r
    HiiRemovePackages (gShellAcpiViewHiiHandle);\r
  }\r
  return EFI_SUCCESS;\r
}\r