ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h

   1 /** @file
   2   Header file for AcpiView
   3
   4   Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6 **/
   7
   8 #ifndef ACPIVIEW_H_
   9 #define ACPIVIEW_H_
  10
  11 /**
  12   A macro to define the max file name length
  13 **/
  14 #define MAX_FILE_NAME_LEN  128
  15
  16 /**
  17   Offset to the RSDP revision from the start of the RSDP
  18 **/
  19 #define RSDP_REVISION_OFFSET  15
  20
  21 /**
  22   Offset to the RSDP length from the start of the RSDP
  23 **/
  24 #define RSDP_LENGTH_OFFSET  20
  25
  26 /**
  27   This function resets the ACPI table error counter to Zero.
  28 **/
  29 VOID
  30 ResetErrorCount (
  31   VOID
  32   );
  33
  34 /**
  35   This function returns the ACPI table error count.
  36
  37   @retval Returns the count of errors detected in the ACPI tables.
  38 **/
  39 UINT32
  40 GetErrorCount (
  41   VOID
  42   );
  43
  44 /**
  45   This function resets the ACPI table warning counter to Zero.
  46 **/
  47 VOID
  48 ResetWarningCount (
  49   VOID
  50   );
  51
  52 /**
  53   This function returns the ACPI table warning count.
  54
  55   @retval Returns the count of warning detected in the ACPI tables.
  56 **/
  57 UINT32
  58 GetWarningCount (
  59   VOID
  60   );
  61
  62 /**
  63   This function processes the table reporting options for the ACPI table.
  64
  65   @param [in] Signature The ACPI table Signature.
  66   @param [in] TablePtr  Pointer to the ACPI table data.
  67   @param [in] Length    The length of the ACPI table.
  68
  69   @retval Returns TRUE if the ACPI table should be traced.
  70 **/
  71 BOOLEAN
  72 ProcessTableReportOptions (
  73   IN CONST UINT32  Signature,
  74   IN CONST UINT8   *TablePtr,
  75   IN CONST UINT32  Length
  76   );
  77
  78 /**
  79   This function iterates the configuration table entries in the
  80   system table, retrieves the RSDP pointer and starts parsing the ACPI tables.
  81
  82   @param [in] SystemTable Pointer to the EFI system table.
  83
  84   @retval EFI_NOT_FOUND   The RSDP pointer was not found.
  85   @retval EFI_UNSUPPORTED The RSDP version was less than 2.
  86   @retval EFI_SUCCESS     The command was successful.
  87 **/
  88 EFI_STATUS
  89 EFIAPI
  90 AcpiView (
  91   IN EFI_SYSTEM_TABLE  *SystemTable
  92   );
  93
  94 #endif // ACPIVIEW_H_