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