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