]>
Commit | Line | Data |
---|---|---|
a6eaba4d | 1 | /** @file\r |
ee4dc24f RN |
2 | ACPI table parser\r |
3 | \r | |
4 | Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r | |
56ba3746 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
ee4dc24f RN |
6 | **/\r |
7 | \r | |
8 | #include <Uefi.h>\r | |
9 | #include <IndustryStandard/Acpi.h>\r | |
10 | #include <Library/UefiLib.h>\r | |
11 | #include "AcpiParser.h"\r | |
12 | #include "AcpiTableParser.h"\r | |
13 | #include "AcpiView.h"\r | |
14 | \r | |
a6eaba4d DB |
15 | /**\r |
16 | A list of registered ACPI table parsers.\r | |
17 | **/\r | |
ee4dc24f RN |
18 | STATIC ACPI_TABLE_PARSER mTableParserList[MAX_ACPI_TABLE_PARSERS];\r |
19 | \r | |
a6eaba4d DB |
20 | /**\r |
21 | Register the ACPI table Parser\r | |
ee4dc24f RN |
22 | \r |
23 | This function registers the ACPI table parser.\r | |
24 | \r | |
25 | @param [in] Signature The ACPI table signature.\r | |
26 | @param [in] ParserProc The ACPI table parser.\r | |
27 | \r | |
28 | @retval EFI_SUCCESS The parser is registered.\r | |
29 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
30 | @retval EFI_ALREADY_STARTED The parser for the Table\r | |
31 | was already registered.\r | |
32 | @retval EFI_OUT_OF_RESOURCES No space to register the\r | |
33 | parser.\r | |
a6eaba4d | 34 | **/\r |
ee4dc24f RN |
35 | EFI_STATUS\r |
36 | EFIAPI\r | |
37 | RegisterParser (\r | |
38 | IN UINT32 Signature,\r | |
39 | IN PARSE_ACPI_TABLE_PROC ParserProc\r | |
40 | )\r | |
41 | {\r | |
f75c7478 | 42 | UINT32 Index;\r |
ee4dc24f RN |
43 | \r |
44 | if ((ParserProc == NULL) || (Signature == ACPI_PARSER_SIGNATURE_NULL)) {\r | |
45 | return EFI_INVALID_PARAMETER;\r | |
46 | }\r | |
47 | \r | |
48 | // Search if a parser is already installed\r | |
f75c7478 DB |
49 | for (Index = 0;\r |
50 | Index < (sizeof (mTableParserList) / sizeof (mTableParserList[0]));\r | |
51 | Index++)\r | |
ee4dc24f | 52 | {\r |
f75c7478 DB |
53 | if (Signature == mTableParserList[Index].Signature) {\r |
54 | if (mTableParserList[Index].Parser != NULL) {\r | |
ee4dc24f RN |
55 | return EFI_ALREADY_STARTED;\r |
56 | }\r | |
57 | }\r | |
58 | }\r | |
59 | \r | |
60 | // Find the first free slot and register the parser\r | |
f75c7478 DB |
61 | for (Index = 0;\r |
62 | Index < (sizeof (mTableParserList) / sizeof (mTableParserList[0]));\r | |
63 | Index++)\r | |
ee4dc24f | 64 | {\r |
f75c7478 DB |
65 | if (mTableParserList[Index].Signature == ACPI_PARSER_SIGNATURE_NULL) {\r |
66 | mTableParserList[Index].Signature = Signature;\r | |
67 | mTableParserList[Index].Parser = ParserProc;\r | |
ee4dc24f RN |
68 | return EFI_SUCCESS;\r |
69 | }\r | |
70 | }\r | |
71 | \r | |
72 | // No free slot found\r | |
73 | return EFI_OUT_OF_RESOURCES;\r | |
74 | }\r | |
75 | \r | |
a6eaba4d DB |
76 | /**\r |
77 | Deregister the ACPI table Parser\r | |
ee4dc24f RN |
78 | \r |
79 | This function deregisters the ACPI table parser.\r | |
80 | \r | |
81 | @param [in] Signature The ACPI table signature.\r | |
82 | \r | |
83 | @retval EFI_SUCCESS The parser was deregistered.\r | |
84 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
85 | @retval EFI_NOT_FOUND A registered parser was not found.\r | |
a6eaba4d | 86 | **/\r |
ee4dc24f RN |
87 | EFI_STATUS\r |
88 | EFIAPI\r | |
89 | DeregisterParser (\r | |
90 | IN UINT32 Signature\r | |
91 | )\r | |
92 | {\r | |
f75c7478 | 93 | UINT32 Index;\r |
ee4dc24f RN |
94 | \r |
95 | if (Signature == ACPI_PARSER_SIGNATURE_NULL) {\r | |
96 | return EFI_INVALID_PARAMETER;\r | |
97 | }\r | |
98 | \r | |
f75c7478 DB |
99 | for (Index = 0;\r |
100 | Index < (sizeof (mTableParserList) / sizeof (mTableParserList[0]));\r | |
101 | Index++)\r | |
ee4dc24f | 102 | {\r |
f75c7478 DB |
103 | if (Signature == mTableParserList[Index].Signature) {\r |
104 | mTableParserList[Index].Signature = ACPI_PARSER_SIGNATURE_NULL;\r | |
105 | mTableParserList[Index].Parser = NULL;\r | |
ee4dc24f RN |
106 | return EFI_SUCCESS;\r |
107 | }\r | |
108 | }\r | |
109 | \r | |
110 | // No matching registered parser found.\r | |
111 | return EFI_NOT_FOUND;\r | |
112 | }\r | |
113 | \r | |
a6eaba4d DB |
114 | /**\r |
115 | Get the ACPI table Parser\r | |
ee4dc24f RN |
116 | \r |
117 | This function returns the ACPI table parser proc from the list of\r | |
118 | registered parsers.\r | |
119 | \r | |
120 | @param [in] Signature The ACPI table signature.\r | |
121 | @param [out] ParserProc Pointer to a ACPI table parser proc.\r | |
122 | \r | |
123 | @retval EFI_SUCCESS The parser was returned successfully.\r | |
124 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
125 | @retval EFI_NOT_FOUND A registered parser was not found.\r | |
a6eaba4d | 126 | **/\r |
ee4dc24f RN |
127 | EFI_STATUS\r |
128 | EFIAPI\r | |
129 | GetParser (\r | |
130 | IN UINT32 Signature,\r | |
131 | OUT PARSE_ACPI_TABLE_PROC * ParserProc\r | |
132 | )\r | |
133 | {\r | |
f75c7478 | 134 | UINT32 Index;\r |
ee4dc24f RN |
135 | \r |
136 | if ((ParserProc == NULL) || (Signature == ACPI_PARSER_SIGNATURE_NULL)) {\r | |
137 | return EFI_INVALID_PARAMETER;\r | |
138 | }\r | |
139 | \r | |
f75c7478 DB |
140 | for (Index = 0;\r |
141 | Index < (sizeof (mTableParserList) / sizeof (mTableParserList[0]));\r | |
142 | Index++)\r | |
ee4dc24f | 143 | {\r |
f75c7478 DB |
144 | if (Signature == mTableParserList[Index].Signature) {\r |
145 | *ParserProc = mTableParserList[Index].Parser;\r | |
ee4dc24f RN |
146 | return EFI_SUCCESS;\r |
147 | }\r | |
148 | }\r | |
149 | \r | |
150 | // No matching registered parser found.\r | |
151 | return EFI_NOT_FOUND;\r | |
152 | }\r | |
153 | \r | |
a6eaba4d DB |
154 | /**\r |
155 | This function processes the ACPI tables.\r | |
ee4dc24f RN |
156 | This function calls ProcessTableReportOptions() to list the ACPI\r |
157 | tables, perform binary dump of the tables and determine if the\r | |
158 | ACPI fields should be traced.\r | |
159 | \r | |
160 | This function also invokes the parser for the ACPI tables.\r | |
161 | \r | |
162 | This function also performs a RAW dump of the ACPI table including\r | |
163 | the unknown/unparsed ACPI tables and validates the checksum.\r | |
164 | \r | |
165 | @param [in] Ptr Pointer to the start of the ACPI\r | |
166 | table data buffer.\r | |
a6eaba4d | 167 | **/\r |
ee4dc24f RN |
168 | VOID\r |
169 | EFIAPI\r | |
170 | ProcessAcpiTable (\r | |
171 | IN UINT8* Ptr\r | |
172 | )\r | |
173 | {\r | |
174 | EFI_STATUS Status;\r | |
175 | BOOLEAN Trace;\r | |
176 | CONST UINT32* AcpiTableSignature;\r | |
177 | CONST UINT32* AcpiTableLength;\r | |
178 | CONST UINT8* AcpiTableRevision;\r | |
179 | PARSE_ACPI_TABLE_PROC ParserProc;\r | |
180 | \r | |
181 | ParseAcpiHeader (\r | |
182 | Ptr,\r | |
183 | &AcpiTableSignature,\r | |
184 | &AcpiTableLength,\r | |
185 | &AcpiTableRevision\r | |
186 | );\r | |
187 | \r | |
188 | Trace = ProcessTableReportOptions (\r | |
189 | *AcpiTableSignature,\r | |
190 | Ptr,\r | |
191 | *AcpiTableLength\r | |
192 | );\r | |
193 | \r | |
194 | if (Trace) {\r | |
195 | DumpRaw (Ptr, *AcpiTableLength);\r | |
196 | VerifyChecksum (TRUE, Ptr, *AcpiTableLength);\r | |
197 | }\r | |
198 | \r | |
199 | Status = GetParser (*AcpiTableSignature, &ParserProc);\r | |
200 | if (EFI_ERROR (Status)) {\r | |
201 | // No registered parser found, do default handling.\r | |
202 | if (Trace) {\r | |
203 | DumpAcpiHeader (Ptr);\r | |
204 | }\r | |
205 | return;\r | |
206 | }\r | |
207 | \r | |
208 | ParserProc (\r | |
209 | Trace,\r | |
210 | Ptr,\r | |
211 | *AcpiTableLength,\r | |
212 | *AcpiTableRevision\r | |
213 | );\r | |
214 | }\r |