]>
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 | |
ee4dc24f RN |
14 | #define MAX_FILE_NAME_LEN 128\r |
15 | \r | |
a6eaba4d DB |
16 | /**\r |
17 | Offset to the RSDP revision from the start of the RSDP\r | |
18 | **/\r | |
ee4dc24f RN |
19 | #define RSDP_REVISION_OFFSET 15\r |
20 | \r | |
a6eaba4d DB |
21 | /**\r |
22 | Offset to the RSDP length from the start of the RSDP\r | |
23 | **/\r | |
ee4dc24f RN |
24 | #define RSDP_LENGTH_OFFSET 20\r |
25 | \r | |
a6eaba4d DB |
26 | /**\r |
27 | The EREPORT_OPTION enum describes ACPI table Reporting options.\r | |
28 | **/\r | |
ee4dc24f | 29 | typedef enum ReportOption {\r |
f75c7478 DB |
30 | ReportAll, ///< Report All tables.\r |
31 | ReportSelected, ///< Report Selected table.\r | |
32 | ReportTableList, ///< Report List of tables.\r | |
33 | ReportDumpBinFile, ///< Dump selected table to a file.\r | |
34 | ReportMax,\r | |
ee4dc24f RN |
35 | } EREPORT_OPTION;\r |
36 | \r | |
a6eaba4d DB |
37 | /**\r |
38 | This function resets the ACPI table error counter to Zero.\r | |
39 | **/\r | |
ee4dc24f RN |
40 | VOID\r |
41 | ResetErrorCount (\r | |
42 | VOID\r | |
43 | );\r | |
44 | \r | |
a6eaba4d DB |
45 | /**\r |
46 | This function returns the ACPI table error count.\r | |
ee4dc24f RN |
47 | \r |
48 | @retval Returns the count of errors detected in the ACPI tables.\r | |
a6eaba4d | 49 | **/\r |
ee4dc24f RN |
50 | UINT32\r |
51 | GetErrorCount (\r | |
52 | VOID\r | |
53 | );\r | |
54 | \r | |
a6eaba4d DB |
55 | /**\r |
56 | This function resets the ACPI table warning counter to Zero.\r | |
57 | **/\r | |
ee4dc24f RN |
58 | VOID\r |
59 | ResetWarningCount (\r | |
60 | VOID\r | |
61 | );\r | |
62 | \r | |
a6eaba4d DB |
63 | /**\r |
64 | This function returns the ACPI table warning count.\r | |
ee4dc24f RN |
65 | \r |
66 | @retval Returns the count of warning detected in the ACPI tables.\r | |
a6eaba4d | 67 | **/\r |
ee4dc24f RN |
68 | UINT32\r |
69 | GetWarningCount (\r | |
70 | VOID\r | |
71 | );\r | |
72 | \r | |
a6eaba4d DB |
73 | /**\r |
74 | This function returns the colour highlighting status.\r | |
ee4dc24f RN |
75 | \r |
76 | @retval TRUE if colour highlighting is enabled.\r | |
a6eaba4d | 77 | **/\r |
ee4dc24f RN |
78 | BOOLEAN\r |
79 | GetColourHighlighting (\r | |
80 | VOID\r | |
81 | );\r | |
82 | \r | |
a6eaba4d DB |
83 | /**\r |
84 | This function sets the colour highlighting status.\r | |
85 | \r | |
86 | @param Highlight The Highlight status.\r | |
ee4dc24f | 87 | \r |
a6eaba4d | 88 | **/\r |
ee4dc24f RN |
89 | VOID\r |
90 | SetColourHighlighting (\r | |
91 | BOOLEAN Highlight\r | |
92 | );\r | |
93 | \r | |
f73843d5 KK |
94 | /**\r |
95 | This function returns the consistency checking status.\r | |
96 | \r | |
97 | @retval TRUE if consistency checking is enabled.\r | |
98 | **/\r | |
99 | BOOLEAN\r | |
100 | GetConsistencyChecking (\r | |
101 | VOID\r | |
102 | );\r | |
103 | \r | |
104 | /**\r | |
105 | This function sets the consistency checking status.\r | |
106 | \r | |
107 | @param ConsistencyChecking The consistency checking status.\r | |
108 | \r | |
109 | **/\r | |
110 | VOID\r | |
111 | SetConsistencyChecking (\r | |
112 | BOOLEAN ConsistencyChecking\r | |
113 | );\r | |
114 | \r | |
8af507c1 KK |
115 | /**\r |
116 | This function returns the ACPI table requirements validation flag.\r | |
117 | \r | |
118 | @retval TRUE if check for mandatory table presence should be performed.\r | |
119 | **/\r | |
120 | BOOLEAN\r | |
121 | GetMandatoryTableValidate (\r | |
122 | VOID\r | |
123 | );\r | |
124 | \r | |
125 | /**\r | |
126 | This function sets the ACPI table requirements validation flag.\r | |
127 | \r | |
128 | @param Validate Enable/Disable ACPI table requirements validation.\r | |
129 | **/\r | |
130 | VOID\r | |
131 | SetMandatoryTableValidate (\r | |
132 | BOOLEAN Validate\r | |
133 | );\r | |
134 | \r | |
135 | /**\r | |
136 | This function returns the identifier of specification to validate ACPI table\r | |
137 | requirements against.\r | |
138 | \r | |
139 | @return ID of specification listing mandatory tables.\r | |
140 | **/\r | |
141 | UINTN\r | |
142 | GetMandatoryTableSpec (\r | |
143 | VOID\r | |
144 | );\r | |
145 | \r | |
146 | /**\r | |
147 | This function sets the identifier of specification to validate ACPI table\r | |
148 | requirements against.\r | |
149 | \r | |
150 | @param Spec ID of specification listing mandatory tables.\r | |
151 | **/\r | |
152 | VOID\r | |
153 | SetMandatoryTableSpec (\r | |
154 | UINTN Spec\r | |
155 | );\r | |
156 | \r | |
a6eaba4d DB |
157 | /**\r |
158 | This function processes the table reporting options for the ACPI table.\r | |
ee4dc24f RN |
159 | \r |
160 | @param [in] Signature The ACPI table Signature.\r | |
161 | @param [in] TablePtr Pointer to the ACPI table data.\r | |
162 | @param [in] Length The length fo the ACPI table.\r | |
163 | \r | |
164 | @retval Returns TRUE if the ACPI table should be traced.\r | |
a6eaba4d | 165 | **/\r |
ee4dc24f RN |
166 | BOOLEAN\r |
167 | ProcessTableReportOptions (\r | |
168 | IN CONST UINT32 Signature,\r | |
169 | IN CONST UINT8* TablePtr,\r | |
170 | IN CONST UINT32 Length\r | |
171 | );\r | |
172 | \r | |
173 | #endif // ACPIVIEW_H_\r |