ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h

   1 /**
   2   Header file for AcpiView
   3
   4   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 **/
  13
  14 #ifndef ACPIVIEW_H_
  15 #define ACPIVIEW_H_
  16
  17 /** A macro to define the max file name length
  18 */
  19 #define MAX_FILE_NAME_LEN    128
  20
  21 /** Offset to the RSDP revision from the start of the RSDP
  22 */
  23 #define RSDP_REVISION_OFFSET 15
  24
  25 /** Offset to the RSDP length from the start of the RSDP
  26 */
  27 #define RSDP_LENGTH_OFFSET   20
  28
  29 /** The EREPORT_OPTION enum describes ACPI table Reporting options.
  30 */
  31 typedef enum ReportOption {
  32   EREPORT_ALL,            ///< Report All tables.
  33   EREPORT_SELECTED,       ///< Report Selected table.
  34   EREPORT_TABLE_LIST,     ///< Report List of tables.
  35   EREPORT_DUMP_BIN_FILE,  ///< Dump selected table to a file.
  36   EREPORT_MAX
  37 } EREPORT_OPTION;
  38
  39 /** This function resets the ACPI table error counter to Zero.
  40 */
  41 VOID
  42 ResetErrorCount (
  43   VOID
  44   );
  45
  46 /** This function returns the ACPI table error count.
  47
  48   @retval Returns the count of errors detected in the ACPI tables.
  49 */
  50 UINT32
  51 GetErrorCount (
  52   VOID
  53   );
  54
  55 /** This function resets the ACPI table warning counter to Zero.
  56 */
  57 VOID
  58 ResetWarningCount (
  59   VOID
  60   );
  61
  62 /** This function returns the ACPI table warning count.
  63
  64   @retval Returns the count of warning detected in the ACPI tables.
  65 */
  66 UINT32
  67 GetWarningCount (
  68   VOID
  69   );
  70
  71 /** This function returns the colour highlighting status.
  72
  73   @retval TRUE if colour highlighting is enabled.
  74 */
  75 BOOLEAN
  76 GetColourHighlighting (
  77   VOID
  78   );
  79
  80 /** This function sets the colour highlighting status.
  81
  82 */
  83 VOID
  84 SetColourHighlighting (
  85   BOOLEAN Highlight
  86   );
  87
  88 /** This function processes the table reporting options for the ACPI table.
  89
  90   @param [in] Signature The ACPI table Signature.
  91   @param [in] TablePtr  Pointer to the ACPI table data.
  92   @param [in] Length    The length fo the ACPI table.
  93
  94   @retval Returns TRUE if the ACPI table should be traced.
  95 */
  96 BOOLEAN
  97 ProcessTableReportOptions (
  98   IN CONST UINT32  Signature,
  99   IN CONST UINT8*  TablePtr,
 100   IN CONST UINT32  Length
 101   );
 102
 103 #endif // ACPIVIEW_H_