ShellPkg: Add acpiview tool to dump ACPI tables

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

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
new file mode 100644 (file)
index 0000000..03561ea
--- /dev/null
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
@@ -0,0 +1,103 @@
+/**\r
+  Header file for AcpiView\r
+\r
+  Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+**/\r
+\r
+#ifndef ACPIVIEW_H_\r
+#define ACPIVIEW_H_\r
+\r
+/** A macro to define the max file name length\r
+*/\r
+#define MAX_FILE_NAME_LEN    128\r
+\r
+/** Offset to the RSDP revision from the start of the RSDP\r
+*/\r
+#define RSDP_REVISION_OFFSET 15\r
+\r
+/** Offset to the RSDP length from the start of the RSDP\r
+*/\r
+#define RSDP_LENGTH_OFFSET   20\r
+\r
+/** The EREPORT_OPTION enum describes ACPI table Reporting options.\r
+*/\r
+typedef enum ReportOption {\r
+  EREPORT_ALL,            ///< Report All tables.\r
+  EREPORT_SELECTED,       ///< Report Selected table.\r
+  EREPORT_TABLE_LIST,     ///< Report List of tables.\r
+  EREPORT_DUMP_BIN_FILE,  ///< Dump selected table to a file.\r
+  EREPORT_MAX\r
+} EREPORT_OPTION;\r
+\r
+/** This function resets the ACPI table error counter to Zero.\r
+*/\r
+VOID\r
+ResetErrorCount (\r
+  VOID\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
+/** This function resets the ACPI table warning counter to Zero.\r
+*/\r
+VOID\r
+ResetWarningCount (\r
+  VOID\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
+/** 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
+/** This function sets the colour highlighting status.\r
+\r
+*/\r
+VOID\r
+SetColourHighlighting (\r
+  BOOLEAN Highlight\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