UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

/** @file\r
\r
  Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Glossary:\r
    - Sbbr or SBBR   - Server Base Boot Requirements\r
\r
  @par Reference(s):\r
    - Arm Server Base Boot Requirements 1.2, September 2019\r
**/\r
\r
#include <Library/PrintLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/AcpiViewCommandLib.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
#include "AcpiView.h"\r
#include "AcpiViewConfig.h"\r
\r
#if defined (MDE_CPU_ARM) || defined (MDE_CPU_AARCH64)\r
  #include "Arm/SbbrValidator.h"\r
#endif\r
\r
STATIC UINT32  mTableCount;\r
STATIC UINT32  mBinTableCount;\r
\r
/**\r
  This function dumps the ACPI table to a file.\r
\r
  @param [in] Ptr       Pointer to the ACPI table data.\r
  @param [in] Length    The length of the ACPI table.\r
\r
  @retval TRUE          Success.\r
  @retval FALSE         Failure.\r
**/\r
STATIC\r
BOOLEAN\r
DumpAcpiTableToFile (\r
  IN CONST UINT8  *Ptr,\r
  IN CONST UINTN  Length\r
  )\r
{\r
  CHAR16               FileNameBuffer[MAX_FILE_NAME_LEN];\r
  UINTN                TransferBytes;\r
  SELECTED_ACPI_TABLE  *SelectedTable;\r
\r
  GetSelectedAcpiTable (&SelectedTable);\r
\r
  UnicodeSPrint (\r
    FileNameBuffer,\r
    sizeof (FileNameBuffer),\r
    L".\\%s%04d.bin",\r
    SelectedTable->Name,\r
    mBinTableCount++\r
    );\r
\r
  Print (L"Dumping ACPI table to : %s ... ", FileNameBuffer);\r
\r
  TransferBytes = ShellDumpBufferToFile (FileNameBuffer, Ptr, Length);\r
  return (Length == TransferBytes);\r
}\r
\r
/**\r
  This function processes the table reporting options for the ACPI table.\r
\r
  @param [in] Signature The ACPI table Signature.\r
  @param [in] TablePtr  Pointer to the ACPI table data.\r
  @param [in] Length    The length fo the ACPI table.\r
\r
  @retval Returns TRUE if the ACPI table should be traced.\r
**/\r
BOOLEAN\r
ProcessTableReportOptions (\r
  IN CONST UINT32  Signature,\r
  IN CONST UINT8   *TablePtr,\r
  IN CONST UINT32  Length\r
  )\r
{\r
  UINTN                OriginalAttribute;\r
  UINT8                *SignaturePtr;\r
  BOOLEAN              Log;\r
  BOOLEAN              HighLight;\r
  SELECTED_ACPI_TABLE  *SelectedTable;\r
\r
  //\r
  // set local variables to suppress incorrect compiler/analyzer warnings\r
  //\r
  OriginalAttribute = 0;\r
  SignaturePtr      = (UINT8 *)(UINTN)&Signature;\r
  Log               = FALSE;\r
  HighLight         = GetColourHighlighting ();\r
  GetSelectedAcpiTable (&SelectedTable);\r
\r
  switch (GetReportOption ()) {\r
    case ReportAll:\r
      Log = TRUE;\r
      break;\r
    case ReportSelected:\r
      if (Signature == SelectedTable->Type) {\r
        Log                  = TRUE;\r
        SelectedTable->Found = TRUE;\r
      }\r
\r
      break;\r
    case ReportTableList:\r
      if (mTableCount == 0) {\r
        if (HighLight) {\r
          OriginalAttribute = gST->ConOut->Mode->Attribute;\r
          gST->ConOut->SetAttribute (\r
                         gST->ConOut,\r
                         EFI_TEXT_ATTR (\r
                           EFI_CYAN,\r
                           ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)\r
                           )\r
                         );\r
        }\r
\r
        Print (L"\nInstalled Table(s):\n");\r
        if (HighLight) {\r
          gST->ConOut->SetAttribute (gST->ConOut, OriginalAttribute);\r
        }\r
      }\r
\r
      Print (\r
        L"\t%4d. %c%c%c%c\n",\r
        ++mTableCount,\r
        SignaturePtr[0],\r
        SignaturePtr[1],\r
        SignaturePtr[2],\r
        SignaturePtr[3]\r
        );\r
      break;\r
    case ReportDumpBinFile:\r
      if (Signature == SelectedTable->Type) {\r
        SelectedTable->Found = TRUE;\r
        DumpAcpiTableToFile (TablePtr, Length);\r
      }\r
\r
      break;\r
    case ReportMax:\r
      // We should never be here.\r
      // This case is only present to prevent compiler warning.\r
      break;\r
  } // switch\r
\r
  if (Log) {\r
    if (HighLight) {\r
      OriginalAttribute = gST->ConOut->Mode->Attribute;\r
      gST->ConOut->SetAttribute (\r
                     gST->ConOut,\r
                     EFI_TEXT_ATTR (\r
                       EFI_LIGHTBLUE,\r
                       ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)\r
                       )\r
                     );\r
    }\r
\r
    Print (\r
      L"\n\n --------------- %c%c%c%c Table --------------- \n\n",\r
      SignaturePtr[0],\r
      SignaturePtr[1],\r
      SignaturePtr[2],\r
      SignaturePtr[3]\r
      );\r
    if (HighLight) {\r
      gST->ConOut->SetAttribute (gST->ConOut, OriginalAttribute);\r
    }\r
  }\r
\r
  return Log;\r
}\r
\r
/**\r
  This function iterates the configuration table entries in the\r
  system table, retrieves the RSDP pointer and starts parsing the ACPI tables.\r
\r
  @param [in] SystemTable Pointer to the EFI system table.\r
\r
  @retval Returns EFI_NOT_FOUND   if the RSDP pointer is not found.\r
          Returns EFI_UNSUPPORTED if the RSDP version is less than 2.\r
          Returns EFI_SUCCESS     if successful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiView (\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS               Status;\r
  UINTN                    Index;\r
  EFI_CONFIGURATION_TABLE  *EfiConfigurationTable;\r
  BOOLEAN                  FoundAcpiTable;\r
  UINTN                    OriginalAttribute;\r
  UINTN                    PrintAttribute;\r
  EREPORT_OPTION           ReportOption;\r
  UINT8                    *RsdpPtr;\r
  UINT32                   RsdpLength;\r
  UINT8                    RsdpRevision;\r
  PARSE_ACPI_TABLE_PROC    RsdpParserProc;\r
  BOOLEAN                  Trace;\r
  SELECTED_ACPI_TABLE      *SelectedTable;\r
\r
  //\r
  // set local variables to suppress incorrect compiler/analyzer warnings\r
  //\r
  EfiConfigurationTable = NULL;\r
  OriginalAttribute     = 0;\r
\r
  // Reset Table counts\r
  mTableCount    = 0;\r
  mBinTableCount = 0;\r
\r
  // Reset The error/warning counters\r
  ResetErrorCount ();\r
  ResetWarningCount ();\r
\r
  // Retrieve the user selection of ACPI table to process\r
  GetSelectedAcpiTable (&SelectedTable);\r
\r
  // Search the table for an entry that matches the ACPI Table Guid\r
  FoundAcpiTable = FALSE;\r
  for (Index = 0; Index < SystemTable->NumberOfTableEntries; Index++) {\r
    if (CompareGuid (\r
          &gEfiAcpiTableGuid,\r
          &(SystemTable->ConfigurationTable[Index].VendorGuid)\r
          ))\r
    {\r
      EfiConfigurationTable = &SystemTable->ConfigurationTable[Index];\r
      FoundAcpiTable        = TRUE;\r
      break;\r
    }\r
  }\r
\r
  if (FoundAcpiTable) {\r
    RsdpPtr = (UINT8 *)EfiConfigurationTable->VendorTable;\r
\r
    // The RSDP revision is 1 byte starting at offset 15\r
    RsdpRevision = *(RsdpPtr + RSDP_REVISION_OFFSET);\r
\r
    if (RsdpRevision < 2) {\r
      Print (\r
        L"ERROR: RSDP version less than 2 is not supported.\n"\r
        );\r
      return EFI_UNSUPPORTED;\r
    }\r
\r
 #if defined (MDE_CPU_ARM) || defined (MDE_CPU_AARCH64)\r
    if (GetMandatoryTableValidate ()) {\r
      ArmSbbrResetTableCounts ();\r
    }\r
\r
 #endif\r
\r
    // The RSDP length is 4 bytes starting at offset 20\r
    RsdpLength = *(UINT32 *)(RsdpPtr + RSDP_LENGTH_OFFSET);\r
\r
    Trace = ProcessTableReportOptions (RSDP_TABLE_INFO, RsdpPtr, RsdpLength);\r
\r
    Status = GetParser (RSDP_TABLE_INFO, &RsdpParserProc);\r
    if (EFI_ERROR (Status)) {\r
      Print (\r
        L"ERROR: No registered parser found for RSDP.\n"\r
        );\r
      return Status;\r
    }\r
\r
    RsdpParserProc (\r
      Trace,\r
      RsdpPtr,\r
      RsdpLength,\r
      RsdpRevision\r
      );\r
  } else {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Failed to find ACPI Table Guid in System Configuration Table.\n"\r
      );\r
    return EFI_NOT_FOUND;\r
  }\r
\r
 #if defined (MDE_CPU_ARM) || defined (MDE_CPU_AARCH64)\r
  if (GetMandatoryTableValidate ()) {\r
    ArmSbbrReqsValidate ((ARM_SBBR_VERSION)GetMandatoryTableSpec ());\r
  }\r
\r
 #endif\r
\r
  ReportOption = GetReportOption ();\r
  if (ReportTableList != ReportOption) {\r
    if (((ReportSelected == ReportOption)  ||\r
         (ReportDumpBinFile == ReportOption)) &&\r
        (!SelectedTable->Found))\r
    {\r
      Print (L"\nRequested ACPI Table not found.\n");\r
    } else if (GetConsistencyChecking () &&\r
               (ReportDumpBinFile != ReportOption))\r
    {\r
      OriginalAttribute = gST->ConOut->Mode->Attribute;\r
\r
      Print (L"\nTable Statistics:\n");\r
\r
      if (GetColourHighlighting ()) {\r
        PrintAttribute = (GetErrorCount () > 0) ?\r
                         EFI_TEXT_ATTR (\r
                           EFI_RED,\r
                           ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)\r
                           ) :\r
                         OriginalAttribute;\r
        gST->ConOut->SetAttribute (gST->ConOut, PrintAttribute);\r
      }\r
\r
      Print (L"\t%d Error(s)\n", GetErrorCount ());\r
\r
      if (GetColourHighlighting ()) {\r
        PrintAttribute = (GetWarningCount () > 0) ?\r
                         EFI_TEXT_ATTR (\r
                           EFI_RED,\r
                           ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)\r
                           ) :\r
                         OriginalAttribute;\r
\r
        gST->ConOut->SetAttribute (gST->ConOut, PrintAttribute);\r
      }\r
\r
      Print (L"\t%d Warning(s)\n", GetWarningCount ());\r
\r
      if (GetColourHighlighting ()) {\r
        gST->ConOut->SetAttribute (gST->ConOut, OriginalAttribute);\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r