AcpiView.h 2.0 KB

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