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

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / AcpiViewConfig.h

/** @file\r
  Header file for 'acpiview' configuration.\r
\r
  Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef ACPI_VIEW_CONFIG_H_\r
#define ACPI_VIEW_CONFIG_H_\r
\r
/**\r
  This function returns the colour highlighting status.\r
\r
  @retval TRUE Colour highlighting is enabled.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetColourHighlighting (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the colour highlighting status.\r
\r
  @param [in] Highlight The highlight status.\r
**/\r
VOID\r
EFIAPI\r
SetColourHighlighting (\r
  BOOLEAN  Highlight\r
  );\r
\r
/**\r
  This function returns the consistency checking status.\r
\r
  @retval TRUE Consistency checking is enabled.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetConsistencyChecking (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the consistency checking status.\r
\r
  @param [in] ConsistencyChecking   The consistency checking status.\r
**/\r
VOID\r
EFIAPI\r
SetConsistencyChecking (\r
  BOOLEAN  ConsistencyChecking\r
  );\r
\r
/**\r
  This function returns the ACPI table requirements validation flag.\r
\r
  @retval TRUE Check for mandatory table presence should be performed.\r
**/\r
BOOLEAN\r
EFIAPI\r
GetMandatoryTableValidate (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the ACPI table requirements validation flag.\r
\r
  @param [in] Validate Enable/Disable ACPI table requirements validation.\r
**/\r
VOID\r
EFIAPI\r
SetMandatoryTableValidate (\r
  BOOLEAN  Validate\r
  );\r
\r
/**\r
  This function returns the identifier of specification to validate ACPI table\r
  requirements against.\r
\r
  @return ID of specification listing mandatory tables.\r
**/\r
UINTN\r
EFIAPI\r
GetMandatoryTableSpec (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the identifier of specification to validate ACPI table\r
  requirements against.\r
\r
  @param [in] Spec ID of specification listing mandatory tables.\r
**/\r
VOID\r
EFIAPI\r
SetMandatoryTableSpec (\r
  UINTN  Spec\r
  );\r
\r
/**\r
  The EREPORT_OPTION enum describes ACPI table Reporting options.\r
**/\r
typedef enum {\r
  ReportAll,          ///< Report All tables.\r
  ReportSelected,     ///< Report Selected table.\r
  ReportTableList,    ///< Report List of tables.\r
  ReportDumpBinFile,  ///< Dump selected table to a file.\r
  ReportMax,\r
} EREPORT_OPTION;\r
\r
/**\r
  This function returns the report options.\r
\r
  @return The current report option.\r
**/\r
EREPORT_OPTION\r
EFIAPI\r
GetReportOption (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the report options.\r
\r
  @param [in] ReportType The report option to set.\r
**/\r
VOID\r
EFIAPI\r
SetReportOption (\r
  EREPORT_OPTION  ReportType\r
  );\r
\r
/**\r
  A structure holding the user selection detailing which\r
  ACPI table is to be examined by the AcpiView code.\r
**/\r
typedef struct {\r
  UINT32          Type;        ///< 32bit signature of the selected ACPI table.\r
  CONST CHAR16    *Name;       ///< User friendly name of the selected ACPI table.\r
  BOOLEAN         Found;       ///< The selected table has been found in the system.\r
} SELECTED_ACPI_TABLE;\r
\r
/**\r
  This function returns the selected ACPI table.\r
\r
  @param [out] SelectedAcpiTable Pointer that will contain the returned struct.\r
**/\r
VOID\r
EFIAPI\r
GetSelectedAcpiTable (\r
  OUT SELECTED_ACPI_TABLE  **SelectedAcpiTable\r
  );\r
\r
/**\r
  This function selects an ACPI table in current context.\r
  The string name of the table is converted into UINT32\r
  table signature.\r
\r
  @param [in] TableName The name of the ACPI table to select.\r
**/\r
VOID\r
EFIAPI\r
SelectAcpiTable (\r
  CONST CHAR16  *TableName\r
  );\r
\r
/**\r
  Reset the AcpiView user configuration to defaults.\r
**/\r
VOID\r
EFIAPI\r
AcpiConfigSetDefaults (\r
  VOID\r
  );\r
\r
#endif // ACPI_VIEW_CONFIG_H_\r