ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h

   1 /** @file
   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 /**
  18   A macro to define the max file name length
  19 **/
  20 #define MAX_FILE_NAME_LEN    128
  21
  22 /**
  23   Offset to the RSDP revision from the start of the RSDP
  24 **/
  25 #define RSDP_REVISION_OFFSET 15
  26
  27 /**
  28   Offset to the RSDP length from the start of the RSDP
  29 **/
  30 #define RSDP_LENGTH_OFFSET   20
  31
  32 /**
  33   The EREPORT_OPTION enum describes ACPI table Reporting options.
  34 **/
  35 typedef enum ReportOption {
  36   ReportAll,            ///< Report All tables.
  37   ReportSelected,       ///< Report Selected table.
  38   ReportTableList,      ///< Report List of tables.
  39   ReportDumpBinFile,    ///< Dump selected table to a file.
  40   ReportMax,
  41 } EREPORT_OPTION;
  42
  43 /**
  44   This function resets the ACPI table error counter to Zero.
  45 **/
  46 VOID
  47 ResetErrorCount (
  48   VOID
  49   );
  50
  51 /**
  52   This function returns the ACPI table error count.
  53
  54   @retval Returns the count of errors detected in the ACPI tables.
  55 **/
  56 UINT32
  57 GetErrorCount (
  58   VOID
  59   );
  60
  61 /**
  62   This function resets the ACPI table warning counter to Zero.
  63 **/
  64 VOID
  65 ResetWarningCount (
  66   VOID
  67   );
  68
  69 /**
  70   This function returns the ACPI table warning count.
  71
  72   @retval Returns the count of warning detected in the ACPI tables.
  73 **/
  74 UINT32
  75 GetWarningCount (
  76   VOID
  77   );
  78
  79 /**
  80   This function returns the colour highlighting status.
  81
  82   @retval TRUE if colour highlighting is enabled.
  83 **/
  84 BOOLEAN
  85 GetColourHighlighting (
  86   VOID
  87   );
  88
  89 /**
  90   This function sets the colour highlighting status.
  91
  92   @param  Highlight       The Highlight status.
  93
  94 **/
  95 VOID
  96 SetColourHighlighting (
  97   BOOLEAN Highlight
  98   );
  99
 100 /**
 101   This function processes the table reporting options for the ACPI table.
 102
 103   @param [in] Signature The ACPI table Signature.
 104   @param [in] TablePtr  Pointer to the ACPI table data.
 105   @param [in] Length    The length fo the ACPI table.
 106
 107   @retval Returns TRUE if the ACPI table should be traced.
 108 **/
 109 BOOLEAN
 110 ProcessTableReportOptions (
 111   IN CONST UINT32  Signature,
 112   IN CONST UINT8*  TablePtr,
 113   IN CONST UINT32  Length
 114   );
 115
 116 #endif // ACPIVIEW_H_