]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Header file for AcpiView\r | |
3 | \r | |
4 | Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | **/\r | |
13 | \r | |
14 | #ifndef ACPIVIEW_H_\r | |
15 | #define ACPIVIEW_H_\r | |
16 | \r | |
17 | /**\r | |
18 | A macro to define the max file name length\r | |
19 | **/\r | |
20 | #define MAX_FILE_NAME_LEN 128\r | |
21 | \r | |
22 | /**\r | |
23 | Offset to the RSDP revision from the start of the RSDP\r | |
24 | **/\r | |
25 | #define RSDP_REVISION_OFFSET 15\r | |
26 | \r | |
27 | /**\r | |
28 | Offset to the RSDP length from the start of the RSDP\r | |
29 | **/\r | |
30 | #define RSDP_LENGTH_OFFSET 20\r | |
31 | \r | |
32 | /**\r | |
33 | The EREPORT_OPTION enum describes ACPI table Reporting options.\r | |
34 | **/\r | |
35 | typedef enum ReportOption {\r | |
36 | ReportAll, ///< Report All tables.\r | |
37 | ReportSelected, ///< Report Selected table.\r | |
38 | ReportTableList, ///< Report List of tables.\r | |
39 | ReportDumpBinFile, ///< Dump selected table to a file.\r | |
40 | ReportMax,\r | |
41 | } EREPORT_OPTION;\r | |
42 | \r | |
43 | /**\r | |
44 | This function resets the ACPI table error counter to Zero.\r | |
45 | **/\r | |
46 | VOID\r | |
47 | ResetErrorCount (\r | |
48 | VOID\r | |
49 | );\r | |
50 | \r | |
51 | /**\r | |
52 | This function returns the ACPI table error count.\r | |
53 | \r | |
54 | @retval Returns the count of errors detected in the ACPI tables.\r | |
55 | **/\r | |
56 | UINT32\r | |
57 | GetErrorCount (\r | |
58 | VOID\r | |
59 | );\r | |
60 | \r | |
61 | /**\r | |
62 | This function resets the ACPI table warning counter to Zero.\r | |
63 | **/\r | |
64 | VOID\r | |
65 | ResetWarningCount (\r | |
66 | VOID\r | |
67 | );\r | |
68 | \r | |
69 | /**\r | |
70 | This function returns the ACPI table warning count.\r | |
71 | \r | |
72 | @retval Returns the count of warning detected in the ACPI tables.\r | |
73 | **/\r | |
74 | UINT32\r | |
75 | GetWarningCount (\r | |
76 | VOID\r | |
77 | );\r | |
78 | \r | |
79 | /**\r | |
80 | This function returns the colour highlighting status.\r | |
81 | \r | |
82 | @retval TRUE if colour highlighting is enabled.\r | |
83 | **/\r | |
84 | BOOLEAN\r | |
85 | GetColourHighlighting (\r | |
86 | VOID\r | |
87 | );\r | |
88 | \r | |
89 | /**\r | |
90 | This function sets the colour highlighting status.\r | |
91 | \r | |
92 | @param Highlight The Highlight status.\r | |
93 | \r | |
94 | **/\r | |
95 | VOID\r | |
96 | SetColourHighlighting (\r | |
97 | BOOLEAN Highlight\r | |
98 | );\r | |
99 | \r | |
100 | /**\r | |
101 | This function processes the table reporting options for the ACPI table.\r | |
102 | \r | |
103 | @param [in] Signature The ACPI table Signature.\r | |
104 | @param [in] TablePtr Pointer to the ACPI table data.\r | |
105 | @param [in] Length The length fo the ACPI table.\r | |
106 | \r | |
107 | @retval Returns TRUE if the ACPI table should be traced.\r | |
108 | **/\r | |
109 | BOOLEAN\r | |
110 | ProcessTableReportOptions (\r | |
111 | IN CONST UINT32 Signature,\r | |
112 | IN CONST UINT8* TablePtr,\r | |
113 | IN CONST UINT32 Length\r | |
114 | );\r | |
115 | \r | |
116 | #endif // ACPIVIEW_H_\r |