]> git.proxmox.com Git - mirror_edk2.git/blame - OvmfPkg/AcpiPlatformDxe/Xen.c
ShellPkg/for: Fix potential null pointer deference
[mirror_edk2.git] / OvmfPkg / AcpiPlatformDxe / Xen.c
CommitLineData
522203de 1/** @file\r
377e758c 2 OVMF ACPI Xen support\r
522203de 3\r
4 Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.<BR>\r
377e758c 5 Copyright (c) 2012, Bei Guan <gbtju85@gmail.com>\r
6\r
522203de 7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/ \r
16\r
17#include "AcpiPlatform.h"\r
18#include <Library/HobLib.h>\r
19#include <Guid/XenInfo.h>\r
4804ef49 20#include <Library/BaseLib.h>\r
522203de 21\r
377e758c 22#define XEN_ACPI_PHYSICAL_ADDRESS 0x000EA020\r
23#define XEN_BIOS_PHYSICAL_END 0x000FFFFF\r
24\r
25EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER *XenAcpiRsdpStructurePtr = NULL;\r
26\r
377e758c 27/**\r
28 This function detects if OVMF is running on Xen.\r
522203de 29\r
377e758c 30**/\r
522203de 31BOOLEAN\r
32XenDetected (\r
33 VOID\r
34 )\r
35{\r
36 EFI_HOB_GUID_TYPE *GuidHob;\r
37\r
38 //\r
39 // See if a XenInfo HOB is available\r
40 //\r
41 GuidHob = GetFirstGuidHob (&gEfiXenInfoGuid);\r
42 if (GuidHob == NULL) {\r
43 return FALSE;\r
44 }\r
45\r
46 return TRUE;\r
47}\r
48\r
377e758c 49/**\r
50 Get the address of Xen ACPI Root System Description Pointer (RSDP)\r
51 structure.\r
522203de 52\r
377e758c 53 @param RsdpStructurePtr Return pointer to RSDP structure\r
54\r
55 @return EFI_SUCCESS Find Xen RSDP structure successfully.\r
56 @return EFI_NOT_FOUND Don't find Xen RSDP structure.\r
57 @return EFI_ABORTED Find Xen RSDP structure, but it's not integrated.\r
58\r
59**/\r
522203de 60EFI_STATUS\r
61EFIAPI\r
377e758c 62GetXenAcpiRsdp (\r
63 OUT EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER **RsdpPtr\r
522203de 64 )\r
65{\r
377e758c 66 EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER *RsdpStructurePtr;\r
67 UINT8 *XenAcpiPtr;\r
68 UINT8 Sum;\r
69\r
70 //\r
71 // Detect the RSDP structure\r
72 //\r
73 for (XenAcpiPtr = (UINT8*)(UINTN) XEN_ACPI_PHYSICAL_ADDRESS;\r
74 XenAcpiPtr < (UINT8*)(UINTN) XEN_BIOS_PHYSICAL_END;\r
75 XenAcpiPtr += 0x10) {\r
76\r
77 RsdpStructurePtr = (EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER *)\r
78 (UINTN) XenAcpiPtr;\r
79\r
80 if (!AsciiStrnCmp ((CHAR8 *) &RsdpStructurePtr->Signature, "RSD PTR ", 8)) {\r
81 //\r
82 // RSDP ACPI 1.0 checksum for 1.0/2.0/3.0 table.\r
83 // This is only the first 20 bytes of the structure\r
84 //\r
4804ef49 85 Sum = CalculateSum8 (\r
86 (CONST UINT8 *)RsdpStructurePtr,\r
377e758c 87 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER)\r
88 );\r
89 if (Sum != 0) {\r
90 return EFI_ABORTED;\r
91 }\r
92\r
93 if (RsdpStructurePtr->Revision >= 2) {\r
94 //\r
95 // RSDP ACPI 2.0/3.0 checksum, this is the entire table\r
96 //\r
4804ef49 97 Sum = CalculateSum8 (\r
98 (CONST UINT8 *)RsdpStructurePtr,\r
377e758c 99 sizeof (EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER)\r
100 );\r
101 if (Sum != 0) {\r
102 return EFI_ABORTED;\r
103 }\r
104 }\r
105 *RsdpPtr = RsdpStructurePtr;\r
106 return EFI_SUCCESS;\r
107 }\r
108 }\r
109\r
110 return EFI_NOT_FOUND;\r
111}\r
112\r
113/**\r
114 Get Xen Acpi tables from the RSDP structure. And installs Xen ACPI tables\r
115 into the RSDT/XSDT using InstallAcpiTable. Some signature of the installed\r
116 ACPI tables are: FACP, APIC, HPET, WAET, SSDT, FACS, DSDT.\r
117\r
118 @param AcpiProtocol Protocol instance pointer.\r
119\r
120 @return EFI_SUCCESS The table was successfully inserted.\r
121 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableHandle is\r
122 NULL, or AcpiTableBufferSize and the size\r
123 field embedded in the ACPI table pointed to\r
124 by AcpiTableBuffer are not in sync.\r
125 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.\r
126\r
127**/\r
128EFI_STATUS\r
129EFIAPI\r
130InstallXenTables (\r
131 IN EFI_ACPI_TABLE_PROTOCOL *AcpiProtocol\r
132 )\r
133{\r
134 EFI_STATUS Status;\r
135 UINTN TableHandle;\r
136\r
137 EFI_ACPI_DESCRIPTION_HEADER *Rsdt;\r
138 EFI_ACPI_DESCRIPTION_HEADER *Xsdt;\r
139 VOID *CurrentTableEntry;\r
140 UINTN CurrentTablePointer;\r
141 EFI_ACPI_DESCRIPTION_HEADER *CurrentTable;\r
142 UINTN Index;\r
143 UINTN NumberOfTableEntries;\r
144 EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *Fadt2Table;\r
145 EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *Fadt1Table;\r
146 EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs2Table;\r
147 EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs1Table;\r
148 EFI_ACPI_DESCRIPTION_HEADER *DsdtTable;\r
149\r
150 Fadt2Table = NULL;\r
151 Fadt1Table = NULL;\r
152 Facs2Table = NULL;\r
153 Facs1Table = NULL;\r
154 DsdtTable = NULL;\r
155 TableHandle = 0;\r
156 NumberOfTableEntries = 0;\r
157\r
158 //\r
159 // Try to find Xen ACPI tables\r
160 //\r
161 Status = GetXenAcpiRsdp (&XenAcpiRsdpStructurePtr);\r
162 if (EFI_ERROR (Status)) {\r
163 return Status;\r
164 }\r
165\r
166 //\r
167 // If XSDT table is find, just install its tables. \r
168 // Otherwise, try to find and install the RSDT tables.\r
169 //\r
170 if (XenAcpiRsdpStructurePtr->XsdtAddress) {\r
171 //\r
172 // Retrieve the addresses of XSDT and \r
173 // calculate the number of its table entries.\r
174 //\r
175 Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) (UINTN)\r
176 XenAcpiRsdpStructurePtr->XsdtAddress;\r
177 NumberOfTableEntries = (Xsdt->Length -\r
178 sizeof (EFI_ACPI_DESCRIPTION_HEADER)) /\r
179 sizeof (UINT64);\r
180\r
181 //\r
182 // Install ACPI tables found in XSDT.\r
183 //\r
184 for (Index = 0; Index < NumberOfTableEntries; Index++) {\r
185 //\r
186 // Get the table entry from XSDT\r
187 //\r
188 CurrentTableEntry = (VOID *) ((UINT8 *) Xsdt +\r
189 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
190 Index * sizeof (UINT64));\r
26af9aca 191 CurrentTablePointer = (UINTN) *(UINT64 *)CurrentTableEntry;\r
377e758c 192 CurrentTable = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTablePointer;\r
193\r
194 //\r
195 // Install the XSDT tables\r
196 //\r
197 Status = InstallAcpiTable (\r
198 AcpiProtocol,\r
199 CurrentTable,\r
200 CurrentTable->Length,\r
201 &TableHandle\r
202 );\r
203\r
204 if (EFI_ERROR (Status)) {\r
205 return Status;\r
206 }\r
207\r
208 //\r
209 // Get the FACS and DSDT table address from the table FADT\r
210 //\r
211 if (!AsciiStrnCmp ((CHAR8 *) &CurrentTable->Signature, "FACP", 4)) {\r
212 Fadt2Table = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)\r
213 (UINTN) CurrentTablePointer;\r
214 Facs2Table = (EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)\r
215 (UINTN) Fadt2Table->FirmwareCtrl;\r
216 DsdtTable = (EFI_ACPI_DESCRIPTION_HEADER *) (UINTN) Fadt2Table->Dsdt;\r
217 }\r
218 }\r
219 }\r
220 else if (XenAcpiRsdpStructurePtr->RsdtAddress) {\r
221 //\r
222 // Retrieve the addresses of RSDT and\r
223 // calculate the number of its table entries.\r
224 //\r
225 Rsdt = (EFI_ACPI_DESCRIPTION_HEADER *) (UINTN)\r
226 XenAcpiRsdpStructurePtr->RsdtAddress;\r
227 NumberOfTableEntries = (Rsdt->Length -\r
228 sizeof (EFI_ACPI_DESCRIPTION_HEADER)) / \r
229 sizeof (UINT32);\r
230\r
231 //\r
232 // Install ACPI tables found in XSDT.\r
233 //\r
234 for (Index = 0; Index < NumberOfTableEntries; Index++) {\r
235 //\r
236 // Get the table entry from RSDT\r
237 //\r
238 CurrentTableEntry = (UINT32 *) ((UINT8 *) Rsdt +\r
239 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
240 Index * sizeof (UINT32));\r
241 CurrentTablePointer = *(UINT32 *)CurrentTableEntry;\r
242 CurrentTable = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTablePointer;\r
243\r
244 //\r
245 // Install the RSDT tables\r
246 //\r
247 Status = InstallAcpiTable (\r
248 AcpiProtocol,\r
249 CurrentTable,\r
250 CurrentTable->Length,\r
251 &TableHandle\r
252 );\r
253\r
254 if (EFI_ERROR (Status)) {\r
255 return Status;\r
256 }\r
257\r
258 //\r
259 // Get the FACS and DSDT table address from the table FADT\r
260 //\r
261 if (!AsciiStrnCmp ((CHAR8 *) &CurrentTable->Signature, "FACP", 4)) {\r
262 Fadt1Table = (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *)\r
263 (UINTN) CurrentTablePointer;\r
264 Facs1Table = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *)\r
265 (UINTN) Fadt1Table->FirmwareCtrl;\r
266 DsdtTable = (EFI_ACPI_DESCRIPTION_HEADER *) (UINTN) Fadt1Table->Dsdt;\r
267 }\r
268 }\r
269 }\r
270\r
271 //\r
272 // Install the FACS table.\r
273 //\r
274 if (Fadt2Table) {\r
275 //\r
276 // FACS 2.0\r
277 //\r
278 Status = InstallAcpiTable (\r
279 AcpiProtocol,\r
280 Facs2Table,\r
281 Facs2Table->Length,\r
282 &TableHandle\r
283 );\r
284 if (EFI_ERROR (Status)) {\r
285 return Status;\r
286 }\r
287 }\r
288 else if (Fadt1Table) {\r
289 //\r
290 // FACS 1.0\r
291 //\r
292 Status = InstallAcpiTable (\r
293 AcpiProtocol,\r
294 Facs1Table,\r
295 Facs1Table->Length,\r
296 &TableHandle\r
297 );\r
298 if (EFI_ERROR (Status)) {\r
299 return Status;\r
300 }\r
301 }\r
302\r
303 //\r
304 // Install DSDT table.\r
305 //\r
306 Status = InstallAcpiTable (\r
307 AcpiProtocol,\r
308 DsdtTable,\r
309 DsdtTable->Length,\r
310 &TableHandle\r
311 );\r
312 if (EFI_ERROR (Status)) {\r
313 return Status;\r
314 }\r
315\r
316 return EFI_SUCCESS;\r
522203de 317}\r
318\r