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

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

/** @file\r
  Header file for AcpiView\r
\r
  Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef ACPIVIEW_H_\r
#define ACPIVIEW_H_\r
\r
/**\r
  A macro to define the max file name length\r
**/\r
#define MAX_FILE_NAME_LEN    128\r
\r
/**\r
  Offset to the RSDP revision from the start of the RSDP\r
**/\r
#define RSDP_REVISION_OFFSET 15\r
\r
/**\r
  Offset to the RSDP length from the start of the RSDP\r
**/\r
#define RSDP_LENGTH_OFFSET   20\r
\r
/**\r
  The EREPORT_OPTION enum describes ACPI table Reporting options.\r
**/\r
typedef enum ReportOption {\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 resets the ACPI table error counter to Zero.\r
**/\r
VOID\r
ResetErrorCount (\r
  VOID\r
  );\r
\r
/**\r
  This function returns the ACPI table error count.\r
\r
  @retval Returns the count of errors detected in the ACPI tables.\r
**/\r
UINT32\r
GetErrorCount (\r
  VOID\r
  );\r
\r
/**\r
  This function resets the ACPI table warning counter to Zero.\r
**/\r
VOID\r
ResetWarningCount (\r
  VOID\r
  );\r
\r
/**\r
  This function returns the ACPI table warning count.\r
\r
  @retval Returns the count of warning detected in the ACPI tables.\r
**/\r
UINT32\r
GetWarningCount (\r
  VOID\r
  );\r
\r
/**\r
  This function returns the colour highlighting status.\r
\r
  @retval TRUE if colour highlighting is enabled.\r
**/\r
BOOLEAN\r
GetColourHighlighting (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the colour highlighting status.\r
\r
  @param  Highlight       The Highlight status.\r
\r
**/\r
VOID\r
SetColourHighlighting (\r
  BOOLEAN Highlight\r
  );\r
\r
/**\r
  This function returns the consistency checking status.\r
\r
  @retval TRUE if consistency checking is enabled.\r
**/\r
BOOLEAN\r
GetConsistencyChecking (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the consistency checking status.\r
\r
  @param  ConsistencyChecking   The consistency checking status.\r
\r
**/\r
VOID\r
SetConsistencyChecking (\r
  BOOLEAN ConsistencyChecking\r
  );\r
\r
/**\r
  This function returns the ACPI table requirements validation flag.\r
\r
  @retval TRUE if check for mandatory table presence should be performed.\r
**/\r
BOOLEAN\r
GetMandatoryTableValidate (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the ACPI table requirements validation flag.\r
\r
  @param  Validate    Enable/Disable ACPI table requirements validation.\r
**/\r
VOID\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
GetMandatoryTableSpec (\r
  VOID\r
  );\r
\r
/**\r
  This function sets the identifier of specification to validate ACPI table\r
  requirements against.\r
\r
  @param  Spec      ID of specification listing mandatory tables.\r
**/\r
VOID\r
SetMandatoryTableSpec (\r
  UINTN Spec\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
#endif // ACPIVIEW_H_\r