]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableProtocol.c
MdeModulePkg/AcpiTableDxe: improve FADT.{DSDT,X_DSDT} mutual exclusion
[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiTableProtocol.c
CommitLineData
5f55c700 1/** @file\r
2 ACPI Table Protocol Implementation\r
3\r
efef6ad6 4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
f9bbb8d9 5 Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>\r
e5eed7d3 6 This program and the accompanying materials\r
5f55c700 7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16//\r
17// Includes\r
18//\r
19#include "AcpiTable.h"\r
da935a5c 20//\r
21// The maximum number of tables that pre-allocated. \r
22//\r
23UINTN mEfiAcpiMaxNumTables = EFI_ACPI_MAX_NUM_TABLES; \r
5f55c700 24\r
f9bbb8d9
AB
25//\r
26// Allocation strategy to use for AllocatePages ().\r
27// Runtime value depends on PcdExposedAcpiTableVersions.\r
28//\r
29STATIC EFI_ALLOCATE_TYPE mAcpiTableAllocType;\r
30\r
5f55c700 31/**\r
32 This function adds an ACPI table to the table list. It will detect FACS and\r
33 allocate the correct type of memory and properly align the table.\r
34\r
35 @param AcpiTableInstance Instance of the protocol.\r
36 @param Table Table to add.\r
37 @param Checksum Does the table require checksumming.\r
38 @param Version The version of the list to add the table to.\r
39 @param Handle Pointer for returning the handle.\r
40\r
41 @return EFI_SUCCESS The function completed successfully.\r
42 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.\r
43 @return EFI_ABORTED The table is a duplicate of a table that is required\r
44 to be unique.\r
45\r
46**/\r
47EFI_STATUS\r
48AddTableToList (\r
49 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
50 IN VOID *Table,\r
51 IN BOOLEAN Checksum,\r
52 IN EFI_ACPI_TABLE_VERSION Version,\r
53 OUT UINTN *Handle\r
54 );\r
55\r
56/**\r
57 This function finds and removes the table specified by the handle.\r
58\r
59 @param AcpiTableInstance Instance of the protocol.\r
60 @param Version Bitmask of which versions to remove.\r
61 @param Handle Table to remove.\r
62\r
63 @return EFI_SUCCESS The function completed successfully.\r
64 @return EFI_ABORTED An error occurred.\r
65 @return EFI_NOT_FOUND Handle not found in table list.\r
66\r
67**/\r
68EFI_STATUS\r
69RemoveTableFromList (\r
70 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
71 IN EFI_ACPI_TABLE_VERSION Version,\r
72 IN UINTN Handle\r
73 );\r
74\r
75/**\r
76 This function calculates and updates an UINT8 checksum.\r
77\r
78 @param Buffer Pointer to buffer to checksum\r
79 @param Size Number of bytes to checksum\r
80 @param ChecksumOffset Offset to place the checksum result in\r
81\r
82 @return EFI_SUCCESS The function completed successfully.\r
5f55c700 83**/\r
84EFI_STATUS\r
85AcpiPlatformChecksum (\r
86 IN VOID *Buffer,\r
87 IN UINTN Size,\r
88 IN UINTN ChecksumOffset\r
89 );\r
90\r
91/**\r
92 Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
93\r
94 @param AcpiTableInstance Protocol instance private data.\r
95\r
96 @return EFI_SUCCESS The function completed successfully.\r
97\r
98**/\r
99EFI_STATUS\r
100ChecksumCommonTables (\r
101 IN OUT EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
102 );\r
103\r
104//\r
105// Protocol function implementations.\r
106//\r
107\r
5f55c700 108/**\r
109 This function publishes the specified versions of the ACPI tables by\r
110 installing EFI configuration table entries for them. Any combination of\r
111 table versions can be published.\r
112\r
113 @param AcpiTableInstance Instance of the protocol.\r
114 @param Version Version(s) to publish.\r
115\r
116 @return EFI_SUCCESS The function completed successfully.\r
117 @return EFI_ABORTED The function could not complete successfully.\r
118\r
119**/\r
120EFI_STATUS\r
121EFIAPI\r
122PublishTables (\r
123 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
124 IN EFI_ACPI_TABLE_VERSION Version\r
125 )\r
126{\r
127 EFI_STATUS Status;\r
128 UINT32 *CurrentRsdtEntry;\r
129 VOID *CurrentXsdtEntry;\r
130 UINT64 Buffer64;\r
131\r
132 //\r
133 // Reorder tables as some operating systems don't seem to find the\r
134 // FADT correctly if it is not in the first few entries\r
135 //\r
136\r
137 //\r
138 // Add FADT as the first entry\r
139 //\r
140 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
141 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) AcpiTableInstance->Rsdt1 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
142 *CurrentRsdtEntry = (UINT32) (UINTN) AcpiTableInstance->Fadt1;\r
f9bbb8d9 143\r
5f55c700 144 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) AcpiTableInstance->Rsdt3 + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
145 *CurrentRsdtEntry = (UINT32) (UINTN) AcpiTableInstance->Fadt3;\r
f9bbb8d9
AB
146 }\r
147 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 148 CurrentXsdtEntry = (VOID *) ((UINT8 *) AcpiTableInstance->Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
149 //\r
150 // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
151 // the table pointers in XSDT are not aligned on 8 byte boundary.\r
152 //\r
153 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Fadt3;\r
154 CopyMem (\r
155 CurrentXsdtEntry,\r
156 &Buffer64,\r
157 sizeof (UINT64)\r
158 );\r
159 }\r
160\r
161 //\r
162 // Do checksum again because Dsdt/Xsdt is updated.\r
163 //\r
164 ChecksumCommonTables (AcpiTableInstance);\r
165\r
166 //\r
167 // Add the RSD_PTR to the system table and store that we have installed the\r
168 // tables.\r
169 //\r
01267e22 170 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
5f55c700 171 Status = gBS->InstallConfigurationTable (&gEfiAcpi10TableGuid, AcpiTableInstance->Rsdp1);\r
172 if (EFI_ERROR (Status)) {\r
173 return EFI_ABORTED;\r
174 }\r
5f55c700 175 }\r
176\r
01267e22 177 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 178 Status = gBS->InstallConfigurationTable (&gEfiAcpiTableGuid, AcpiTableInstance->Rsdp3);\r
179 if (EFI_ERROR (Status)) {\r
180 return EFI_ABORTED;\r
181 }\r
5f55c700 182 }\r
183\r
184 return EFI_SUCCESS;\r
185}\r
186\r
187\r
188/**\r
189 Installs an ACPI table into the RSDT/XSDT.\r
2fd3009f 190 Note that the ACPI table should be checksumed before installing it.\r
191 Otherwise it will assert.\r
5f55c700 192\r
193 @param This Protocol instance pointer.\r
194 @param AcpiTableBuffer A pointer to a buffer containing the ACPI table to be installed.\r
195 @param AcpiTableBufferSize Specifies the size, in bytes, of the AcpiTableBuffer buffer.\r
196 @param TableKey Reurns a key to refer to the ACPI table.\r
197\r
198 @return EFI_SUCCESS The table was successfully inserted.\r
199 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize \r
200 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer\r
201 are not in sync.\r
202 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.\r
5966402e
SZ
203 @retval EFI_ACCESS_DENIED The table signature matches a table already\r
204 present in the system and platform policy\r
205 does not allow duplicate tables of this type.\r
5f55c700 206\r
207**/\r
208EFI_STATUS\r
209EFIAPI\r
210InstallAcpiTable (\r
db0f0d3c 211 IN EFI_ACPI_TABLE_PROTOCOL *This,\r
212 IN VOID *AcpiTableBuffer,\r
213 IN UINTN AcpiTableBufferSize,\r
214 OUT UINTN *TableKey\r
5f55c700 215 )\r
216{\r
217 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance;\r
218 EFI_STATUS Status;\r
219 VOID *AcpiTableBufferConst;\r
f9bbb8d9 220 EFI_ACPI_TABLE_VERSION Version;\r
5f55c700 221\r
222 //\r
223 // Check for invalid input parameters\r
224 //\r
225 if ((AcpiTableBuffer == NULL) || (TableKey == NULL)\r
226 || (((EFI_ACPI_DESCRIPTION_HEADER *) AcpiTableBuffer)->Length != AcpiTableBufferSize)) {\r
227 return EFI_INVALID_PARAMETER;\r
228 }\r
229\r
f9bbb8d9
AB
230 Version = PcdGet32 (PcdAcpiExposedTableVersions);\r
231\r
5f55c700 232 //\r
233 // Get the instance of the ACPI table protocol\r
234 //\r
235 AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
236\r
237 //\r
238 // Install the ACPI table\r
239 //\r
240 AcpiTableBufferConst = AllocateCopyPool (AcpiTableBufferSize,AcpiTableBuffer);\r
241 *TableKey = 0;\r
5966402e 242 Status = AddTableToList (\r
5f55c700 243 AcpiTableInstance,\r
244 AcpiTableBufferConst,\r
71824dd8 245 TRUE,\r
f9bbb8d9 246 Version,\r
5f55c700 247 TableKey\r
248 );\r
249 if (!EFI_ERROR (Status)) {\r
250 Status = PublishTables (\r
251 AcpiTableInstance,\r
f9bbb8d9 252 Version\r
5f55c700 253 );\r
254 }\r
255 FreePool (AcpiTableBufferConst);\r
256 \r
3dc8585e
JY
257 //\r
258 // Add a new table successfully, notify registed callback\r
259 //\r
260 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
261 if (!EFI_ERROR (Status)) {\r
262 SdtNotifyAcpiList (\r
263 AcpiTableInstance,\r
f9bbb8d9 264 Version,\r
3dc8585e
JY
265 *TableKey\r
266 );\r
267 }\r
268 }\r
269\r
5f55c700 270 return Status;\r
271}\r
272\r
273\r
274/**\r
275 Removes an ACPI table from the RSDT/XSDT.\r
276\r
277 @param This Protocol instance pointer.\r
278 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().\r
279\r
280 @return EFI_SUCCESS The table was successfully uninstalled.\r
281 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.\r
282\r
283**/\r
284EFI_STATUS\r
285EFIAPI\r
286UninstallAcpiTable (\r
db0f0d3c 287 IN EFI_ACPI_TABLE_PROTOCOL *This,\r
288 IN UINTN TableKey\r
5f55c700 289 )\r
290{\r
291 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance;\r
292 EFI_STATUS Status;\r
293\r
294 //\r
295 // Get the instance of the ACPI table protocol\r
296 //\r
297 AcpiTableInstance = EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This);\r
298\r
299 //\r
300 // Uninstall the ACPI table\r
301 //\r
5966402e 302 Status = RemoveTableFromList (\r
5f55c700 303 AcpiTableInstance,\r
f0071740 304 EFI_ACPI_TABLE_VERSION_1_0B | ACPI_TABLE_VERSION_GTE_2_0,\r
5966402e 305 TableKey\r
5f55c700 306 );\r
307 if (!EFI_ERROR (Status)) {\r
308 Status = PublishTables (\r
309 AcpiTableInstance,\r
f0071740 310 EFI_ACPI_TABLE_VERSION_1_0B | ACPI_TABLE_VERSION_GTE_2_0\r
5f55c700 311 );\r
312 }\r
313\r
314 if (EFI_ERROR (Status)) {\r
315 return EFI_NOT_FOUND;\r
316 } else {\r
317 return EFI_SUCCESS;\r
318 }\r
319}\r
320\r
da935a5c 321/**\r
322 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.\r
323\r
324 @param AcpiTableInstance ACPI table protocol instance data structure.\r
325\r
326 @return EFI_SUCCESS reallocate the table beffer successfully.\r
327 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.\r
328\r
329**/\r
330EFI_STATUS\r
331ReallocateAcpiTableBuffer (\r
332 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
333 )\r
334{\r
335 UINTN NewMaxTableNumber;\r
336 UINTN TotalSize;\r
337 UINT8 *Pointer;\r
338 EFI_PHYSICAL_ADDRESS PageAddress;\r
339 EFI_ACPI_TABLE_INSTANCE TempPrivateData;\r
340 EFI_STATUS Status;\r
341 UINT64 CurrentData;\r
342 \r
343 CopyMem (&TempPrivateData, AcpiTableInstance, sizeof (EFI_ACPI_TABLE_INSTANCE)); \r
344 //\r
345 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES\r
346 //\r
347 NewMaxTableNumber = mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES;\r
348 //\r
37abfb7e 349 // Create RSDT, XSDT structures and allocate buffers.\r
da935a5c 350 //\r
f9bbb8d9 351 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
37abfb7e 352 NewMaxTableNumber * sizeof (UINT64);\r
da935a5c 353\r
f9bbb8d9
AB
354 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
355 TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
356 NewMaxTableNumber * sizeof (UINT32) +\r
357 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
358 NewMaxTableNumber * sizeof (UINT32);\r
359 }\r
360\r
da935a5c 361 //\r
362 // Allocate memory in the lower 32 bit of address range for\r
363 // compatibility with ACPI 1.0 OS.\r
364 //\r
365 // This is done because ACPI 1.0 pointers are 32 bit values.\r
366 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
367 // There is no architectural reason these should be below 4GB, it is purely\r
368 // for convenience of implementation that we force memory below 4GB.\r
369 //\r
370 PageAddress = 0xFFFFFFFF;\r
371 Status = gBS->AllocatePages (\r
f9bbb8d9 372 mAcpiTableAllocType,\r
da935a5c 373 EfiACPIReclaimMemory,\r
374 EFI_SIZE_TO_PAGES (TotalSize),\r
375 &PageAddress\r
376 );\r
377\r
378 if (EFI_ERROR (Status)) {\r
379 return EFI_OUT_OF_RESOURCES;\r
380 }\r
381\r
382 Pointer = (UINT8 *) (UINTN) PageAddress;\r
383 ZeroMem (Pointer, TotalSize);\r
384 \r
da935a5c 385 AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
f9bbb8d9
AB
386 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
387 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
388 AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
389 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + NewMaxTableNumber * sizeof (UINT32));\r
390 }\r
da935a5c 391 AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
5f55c700 392\r
da935a5c 393 //\r
37abfb7e 394 // Update RSDP to point to the new Rsdt and Xsdt address.\r
da935a5c 395 //\r
f9bbb8d9
AB
396 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
397 AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt1;\r
398 AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt3;\r
399 }\r
da935a5c 400 CurrentData = (UINT64) (UINTN) AcpiTableInstance->Xsdt;\r
401 CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
402\r
403 //\r
404 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer \r
405 //\r
f9bbb8d9
AB
406 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
407 CopyMem (AcpiTableInstance->Rsdt1, TempPrivateData.Rsdt1, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32))); \r
408 CopyMem (AcpiTableInstance->Rsdt3, TempPrivateData.Rsdt3, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT32))); \r
409 }\r
da935a5c 410 CopyMem (AcpiTableInstance->Xsdt, TempPrivateData.Xsdt, (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + mEfiAcpiMaxNumTables * sizeof (UINT64)));\r
411 \r
412 //\r
413 // Calculate orignal ACPI table buffer size\r
414 //\r
f9bbb8d9 415 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
37abfb7e 416 mEfiAcpiMaxNumTables * sizeof (UINT64);\r
f9bbb8d9
AB
417\r
418 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
419 TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
420 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
421 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
422 mEfiAcpiMaxNumTables * sizeof (UINT32);\r
423 }\r
424\r
37abfb7e 425 gBS->FreePages ((EFI_PHYSICAL_ADDRESS)(UINTN)TempPrivateData.Rsdt1, EFI_SIZE_TO_PAGES (TotalSize));\r
da935a5c 426 \r
427 //\r
428 // Update the Max ACPI table number\r
429 // \r
430 mEfiAcpiMaxNumTables = NewMaxTableNumber;\r
431 return EFI_SUCCESS;\r
432}\r
198a46d7
LE
433\r
434/**\r
435 Determine whether the FADT table passed in as parameter requires mutual\r
436 exclusion between the DSDT and X_DSDT fields. (That is, whether there exists\r
437 an explicit requirement that at most one of those fields is permitted to be\r
438 nonzero.)\r
439\r
440 @param[in] Fadt The EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE object to\r
441 check.\r
442\r
443 @retval TRUE Fadt requires mutual exclusion between DSDT and X_DSDT.\r
444 @retval FALSE Otherwise.\r
445**/\r
446BOOLEAN\r
447RequireDsdtXDsdtExclusion (\r
448 IN EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *Fadt\r
449 )\r
450{\r
451 //\r
452 // Mantis ticket #1393 was addressed in ACPI 5.1 Errata B. Unfortunately, we\r
453 // can't tell apart 5.1 Errata A and 5.1 Errata B just from looking at the\r
454 // FADT table. Therefore let's require exclusion for table versions >= 5.1.\r
455 //\r
456 // While this needlessly covers 5.1 and 5.1A too, it is safer to require\r
457 // DSDT<->X_DSDT exclusion for lax (5.1, 5.1A) versions of the spec than to\r
458 // permit DSDT<->X_DSDT duplication for strict (5.1B) versions of the spec.\r
459 //\r
460 // The same applies to 6.0 vs. 6.0A. While 6.0 does not require the\r
461 // exclusion, 6.0A and 6.1 do. Since we cannot distinguish 6.0 from 6.0A\r
462 // based on just the FADT, we lump 6.0 in with the rest of >= 5.1.\r
463 //\r
464 if ((Fadt->Header.Revision < 5) ||\r
465 ((Fadt->Header.Revision == 5) &&\r
466 (((EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE *)Fadt)->MinorVersion == 0))) {\r
467 //\r
468 // version <= 5.0\r
469 //\r
470 return FALSE;\r
471 }\r
472 //\r
473 // version >= 5.1\r
474 //\r
475 return TRUE;\r
476}\r
477\r
5f55c700 478/**\r
479 This function adds an ACPI table to the table list. It will detect FACS and\r
480 allocate the correct type of memory and properly align the table.\r
481\r
482 @param AcpiTableInstance Instance of the protocol.\r
483 @param Table Table to add.\r
484 @param Checksum Does the table require checksumming.\r
485 @param Version The version of the list to add the table to.\r
486 @param Handle Pointer for returning the handle.\r
487\r
488 @return EFI_SUCCESS The function completed successfully.\r
489 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.\r
5966402e
SZ
490 @retval EFI_ACCESS_DENIED The table signature matches a table already\r
491 present in the system and platform policy\r
492 does not allow duplicate tables of this type.\r
5f55c700 493\r
494**/\r
495EFI_STATUS\r
496AddTableToList (\r
497 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
498 IN VOID *Table,\r
499 IN BOOLEAN Checksum,\r
500 IN EFI_ACPI_TABLE_VERSION Version,\r
501 OUT UINTN *Handle\r
502 )\r
503{\r
504 EFI_STATUS Status;\r
505 EFI_ACPI_TABLE_LIST *CurrentTableList;\r
506 UINT32 CurrentTableSignature;\r
507 UINT32 CurrentTableSize;\r
508 UINT32 *CurrentRsdtEntry;\r
509 VOID *CurrentXsdtEntry;\r
510 UINT64 Buffer64;\r
511 BOOLEAN AddToRsdt;\r
512\r
513 //\r
514 // Check for invalid input parameters\r
515 //\r
516 ASSERT (AcpiTableInstance);\r
517 ASSERT (Table);\r
518 ASSERT (Handle);\r
519\r
520 //\r
521 // Init locals\r
522 //\r
523 AddToRsdt = TRUE;\r
524\r
525 //\r
526 // Create a new list entry\r
527 //\r
528 CurrentTableList = AllocatePool (sizeof (EFI_ACPI_TABLE_LIST));\r
529 ASSERT (CurrentTableList);\r
530\r
531 //\r
532 // Determine table type and size\r
533 //\r
534 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table)->Signature;\r
535 CurrentTableSize = ((EFI_ACPI_COMMON_HEADER *) Table)->Length;\r
536\r
537 //\r
538 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space\r
539 // for backwards compatibility with ACPI 1.0 OS.\r
540 //\r
541 // This is done because ACPI 1.0 pointers are 32 bit values.\r
542 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
543 // There is no architectural reason these should be below 4GB, it is purely\r
544 // for convenience of implementation that we force memory below 4GB.\r
545 //\r
546 CurrentTableList->PageAddress = 0xFFFFFFFF;\r
547 CurrentTableList->NumberOfPages = EFI_SIZE_TO_PAGES (CurrentTableSize);\r
548\r
549 //\r
550 // Allocation memory type depends on the type of the table\r
551 //\r
36d58153
JY
552 if ((CurrentTableSignature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) || \r
553 (CurrentTableSignature == EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE)) {\r
5f55c700 554 //\r
555 // Allocate memory for the FACS. This structure must be aligned\r
556 // on a 64 byte boundary and must be ACPI NVS memory.\r
557 // Using AllocatePages should ensure that it is always aligned.\r
36d58153
JY
558 // Do not change signature for new ACPI version because they are same.\r
559 //\r
560 // UEFI table also need to be in ACPI NVS memory, because some data field\r
561 // could be updated by OS present agent. For example, BufferPtrAddress in\r
562 // SMM communication ACPI table.\r
5f55c700 563 //\r
564 ASSERT ((EFI_PAGE_SIZE % 64) == 0);\r
565 Status = gBS->AllocatePages (\r
566 AllocateMaxAddress,\r
567 EfiACPIMemoryNVS,\r
568 CurrentTableList->NumberOfPages,\r
569 &CurrentTableList->PageAddress\r
570 );\r
571 } else {\r
572 //\r
573 // All other tables are ACPI reclaim memory, no alignment requirements.\r
574 //\r
575 Status = gBS->AllocatePages (\r
f9bbb8d9 576 mAcpiTableAllocType,\r
5f55c700 577 EfiACPIReclaimMemory,\r
578 CurrentTableList->NumberOfPages,\r
579 &CurrentTableList->PageAddress\r
580 );\r
581 }\r
582 //\r
583 // Check return value from memory alloc.\r
584 //\r
585 if (EFI_ERROR (Status)) {\r
586 gBS->FreePool (CurrentTableList);\r
587 return EFI_OUT_OF_RESOURCES;\r
588 }\r
589 //\r
590 // Update the table pointer with the allocated memory start\r
591 //\r
592 CurrentTableList->Table = (EFI_ACPI_COMMON_HEADER *) (UINTN) CurrentTableList->PageAddress;\r
593\r
594 //\r
595 // Initialize the table contents\r
596 //\r
597 CurrentTableList->Signature = EFI_ACPI_TABLE_LIST_SIGNATURE;\r
598 CopyMem (CurrentTableList->Table, Table, CurrentTableSize);\r
599 CurrentTableList->Handle = AcpiTableInstance->CurrentHandle++;\r
600 *Handle = CurrentTableList->Handle;\r
601 CurrentTableList->Version = Version;\r
602\r
603 //\r
604 // Update internal pointers if this is a required table. If it is a required\r
605 // table and a table of that type already exists, return an error.\r
606 //\r
607 // Calculate the checksum if the table is not FACS.\r
608 //\r
609 switch (CurrentTableSignature) {\r
610\r
611 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
612 //\r
613 // We don't add the FADT in the standard way because some\r
614 // OS expect the FADT to be early in the table list.\r
615 // So we always add it as the first element in the list.\r
616 //\r
617 AddToRsdt = FALSE;\r
618\r
619 //\r
620 // Check that the table has not been previously added.\r
621 //\r
622 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Fadt1 != NULL) ||\r
f0071740 623 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Fadt3 != NULL)\r
5f55c700 624 ) {\r
625 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
626 gBS->FreePool (CurrentTableList);\r
5966402e 627 return EFI_ACCESS_DENIED;\r
5f55c700 628 }\r
629 //\r
630 // Add the table to the appropriate table version\r
631 //\r
632 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
633 //\r
634 // Save a pointer to the table\r
635 //\r
636 AcpiTableInstance->Fadt1 = (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
637\r
638 //\r
639 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
640 //\r
641 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
642 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
643\r
644 //\r
645 // RSDP OEM information is updated to match the FADT OEM information\r
646 //\r
647 CopyMem (\r
648 &AcpiTableInstance->Rsdp1->OemId,\r
649 &AcpiTableInstance->Fadt1->Header.OemId,\r
650 6\r
651 );\r
652\r
653 //\r
654 // RSDT OEM information is updated to match the FADT OEM information.\r
655 //\r
656 CopyMem (\r
657 &AcpiTableInstance->Rsdt1->OemId,\r
658 &AcpiTableInstance->Fadt1->Header.OemId,\r
659 6\r
660 );\r
661\r
662 CopyMem (\r
663 &AcpiTableInstance->Rsdt1->OemTableId,\r
664 &AcpiTableInstance->Fadt1->Header.OemTableId,\r
665 sizeof (UINT64)\r
666 );\r
667 AcpiTableInstance->Rsdt1->OemRevision = AcpiTableInstance->Fadt1->Header.OemRevision;\r
668 }\r
669\r
f0071740 670 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 671 //\r
672 // Save a pointer to the table\r
673 //\r
674 AcpiTableInstance->Fadt3 = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
675\r
676 //\r
677 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
c93776c2
JY
678 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and \r
679 // vice-versa.\r
5f55c700 680 //\r
10342a64 681 if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
c93776c2 682 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
f798e8bf 683 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
c93776c2
JY
684 } else {\r
685 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
686 CopyMem (\r
687 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
688 &Buffer64,\r
689 sizeof (UINT64)\r
690 );\r
f798e8bf 691 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
c93776c2 692 }\r
f9bbb8d9 693 if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
9886ebfe 694 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
198a46d7
LE
695 if (RequireDsdtXDsdtExclusion (AcpiTableInstance->Fadt3)) {\r
696 Buffer64 = 0;\r
697 } else {\r
698 Buffer64 = AcpiTableInstance->Fadt3->Dsdt;\r
699 }\r
f9bbb8d9 700 } else {\r
f9bbb8d9 701 AcpiTableInstance->Fadt3->Dsdt = 0;\r
9886ebfe 702 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
f9bbb8d9 703 }\r
198a46d7 704 CopyMem (&AcpiTableInstance->Fadt3->XDsdt, &Buffer64, sizeof (UINT64));\r
5f55c700 705\r
f0c855b2 706 //\r
707 // RSDP OEM information is updated to match the FADT OEM information\r
708 //\r
709 CopyMem (\r
710 &AcpiTableInstance->Rsdp3->OemId,\r
711 &AcpiTableInstance->Fadt3->Header.OemId,\r
712 6\r
713 );\r
714 \r
f9bbb8d9
AB
715 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
716 //\r
717 // RSDT OEM information is updated to match FADT OEM information.\r
718 //\r
719 CopyMem (\r
720 &AcpiTableInstance->Rsdt3->OemId,\r
721 &AcpiTableInstance->Fadt3->Header.OemId,\r
722 6\r
723 );\r
724 CopyMem (\r
725 &AcpiTableInstance->Rsdt3->OemTableId,\r
726 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
727 sizeof (UINT64)\r
728 );\r
729 AcpiTableInstance->Rsdt3->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
730 }\r
731\r
f0c855b2 732 //\r
733 // XSDT OEM information is updated to match FADT OEM information.\r
734 //\r
735 CopyMem (\r
736 &AcpiTableInstance->Xsdt->OemId,\r
737 &AcpiTableInstance->Fadt3->Header.OemId,\r
738 6\r
739 );\r
740 CopyMem (\r
741 &AcpiTableInstance->Xsdt->OemTableId,\r
742 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
743 sizeof (UINT64)\r
744 );\r
745 AcpiTableInstance->Xsdt->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
5f55c700 746 } \r
747 //\r
748 // Checksum the table\r
749 //\r
750 if (Checksum) {\r
751 AcpiPlatformChecksum (\r
752 CurrentTableList->Table,\r
753 CurrentTableList->Table->Length,\r
754 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
755 Checksum)\r
756 );\r
757 }\r
758 break;\r
759\r
760 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
761 //\r
762 // Check that the table has not been previously added.\r
763 //\r
764 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Facs1 != NULL) ||\r
f0071740 765 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Facs3 != NULL)\r
5f55c700 766 ) {\r
767 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
768 gBS->FreePool (CurrentTableList);\r
5966402e 769 return EFI_ACCESS_DENIED;\r
5f55c700 770 }\r
771 //\r
772 // FACS is referenced by FADT and is not part of RSDT\r
773 //\r
774 AddToRsdt = FALSE;\r
775\r
776 //\r
777 // Add the table to the appropriate table version\r
778 //\r
779 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
780 //\r
781 // Save a pointer to the table\r
782 //\r
783 AcpiTableInstance->Facs1 = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
784\r
785 //\r
786 // If FADT already exists, update table pointers.\r
787 //\r
788 if (AcpiTableInstance->Fadt1 != NULL) {\r
789 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
790\r
791 //\r
792 // Checksum FADT table\r
793 //\r
794 AcpiPlatformChecksum (\r
795 AcpiTableInstance->Fadt1,\r
796 AcpiTableInstance->Fadt1->Header.Length,\r
797 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
798 Checksum)\r
799 );\r
800 }\r
801 }\r
802\r
f0071740 803 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 804 //\r
805 // Save a pointer to the table\r
806 //\r
807 AcpiTableInstance->Facs3 = (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
808\r
809 //\r
810 // If FADT already exists, update table pointers.\r
811 //\r
812 if (AcpiTableInstance->Fadt3 != NULL) {\r
c93776c2
JY
813 //\r
814 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and \r
815 // vice-versa.\r
816 //\r
10342a64 817 if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
c93776c2 818 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
f798e8bf 819 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
c93776c2
JY
820 } else {\r
821 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
822 CopyMem (\r
823 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
824 &Buffer64,\r
825 sizeof (UINT64)\r
826 );\r
f798e8bf 827 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
c93776c2 828 }\r
5f55c700 829\r
830 //\r
831 // Checksum FADT table\r
832 //\r
833 AcpiPlatformChecksum (\r
834 AcpiTableInstance->Fadt3,\r
835 AcpiTableInstance->Fadt3->Header.Length,\r
836 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
837 Checksum)\r
838 );\r
839 }\r
840 }\r
841\r
842 break;\r
843\r
844 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
845 //\r
846 // Check that the table has not been previously added.\r
847 //\r
848 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Dsdt1 != NULL) ||\r
f0071740 849 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Dsdt3 != NULL)\r
5f55c700 850 ) {\r
851 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
852 gBS->FreePool (CurrentTableList);\r
5966402e 853 return EFI_ACCESS_DENIED;\r
5f55c700 854 }\r
855 //\r
856 // DSDT is referenced by FADT and is not part of RSDT\r
857 //\r
858 AddToRsdt = FALSE;\r
859\r
860 //\r
861 // Add the table to the appropriate table version\r
862 //\r
863 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
864 //\r
865 // Save a pointer to the table\r
866 //\r
867 AcpiTableInstance->Dsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
868\r
869 //\r
870 // If FADT already exists, update table pointers.\r
871 //\r
872 if (AcpiTableInstance->Fadt1 != NULL) {\r
873 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
874\r
875 //\r
876 // Checksum FADT table\r
877 //\r
878 AcpiPlatformChecksum (\r
879 AcpiTableInstance->Fadt1,\r
880 AcpiTableInstance->Fadt1->Header.Length,\r
881 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
882 Checksum)\r
883 );\r
884 }\r
885 }\r
886 \r
f0071740 887 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 888 //\r
889 // Save a pointer to the table\r
890 //\r
891 AcpiTableInstance->Dsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
892\r
893 //\r
894 // If FADT already exists, update table pointers.\r
895 //\r
896 if (AcpiTableInstance->Fadt3 != NULL) {\r
f9bbb8d9 897 if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
9886ebfe 898 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
198a46d7
LE
899 if (RequireDsdtXDsdtExclusion (AcpiTableInstance->Fadt3)) {\r
900 Buffer64 = 0;\r
901 } else {\r
902 Buffer64 = AcpiTableInstance->Fadt3->Dsdt;\r
903 }\r
904 } else {\r
905 AcpiTableInstance->Fadt3->Dsdt = 0;\r
906 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
f9bbb8d9 907 }\r
9886ebfe 908 CopyMem (&AcpiTableInstance->Fadt3->XDsdt, &Buffer64, sizeof (UINT64));\r
5f55c700 909\r
910 //\r
911 // Checksum FADT table\r
912 //\r
913 AcpiPlatformChecksum (\r
914 AcpiTableInstance->Fadt3,\r
915 AcpiTableInstance->Fadt3->Header.Length,\r
916 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
917 Checksum)\r
918 );\r
919 }\r
920 } \r
921 //\r
922 // Checksum the table\r
923 //\r
924 if (Checksum) {\r
925 AcpiPlatformChecksum (\r
926 CurrentTableList->Table,\r
927 CurrentTableList->Table->Length,\r
928 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
929 Checksum)\r
930 );\r
931 }\r
932 break;\r
933\r
934 default:\r
935 //\r
936 // Checksum the table\r
937 //\r
938 if (Checksum) {\r
939 AcpiPlatformChecksum (\r
940 CurrentTableList->Table,\r
941 CurrentTableList->Table->Length,\r
942 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
943 Checksum)\r
944 );\r
945 }\r
946 break;\r
947 }\r
948 //\r
949 // Add the table to the current list of tables\r
950 //\r
951 InsertTailList (&AcpiTableInstance->TableList, &CurrentTableList->Link);\r
952\r
953 //\r
954 // Add the table to RSDT and/or XSDT table entry lists.\r
955 //\r
956 //\r
957 // Add to ACPI 1.0b table tree\r
958 //\r
959 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
5f55c700 960 if (AddToRsdt) {\r
961 //\r
da935a5c 962 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
5f55c700 963 //\r
da935a5c 964 if (AcpiTableInstance->NumberOfTableEntries1 >= mEfiAcpiMaxNumTables) {\r
965 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
966 ASSERT_EFI_ERROR (Status);\r
967 }\r
5f55c700 968 CurrentRsdtEntry = (UINT32 *)\r
969 (\r
da935a5c 970 (UINT8 *) AcpiTableInstance->Rsdt1 +\r
5f55c700 971 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
da935a5c 972 AcpiTableInstance->NumberOfTableEntries1 *\r
5f55c700 973 sizeof (UINT32)\r
974 );\r
975\r
976 //\r
da935a5c 977 // Add entry to the RSDT unless its the FACS or DSDT\r
5f55c700 978 //\r
979 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
980\r
981 //\r
982 // Update RSDT length\r
983 //\r
da935a5c 984 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof (UINT32);\r
5f55c700 985\r
da935a5c 986 AcpiTableInstance->NumberOfTableEntries1++;\r
987 }\r
988 }\r
989 //\r
990 // Add to ACPI 2.0/3.0 table tree\r
991 //\r
f0071740 992 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
f9bbb8d9
AB
993 if (AddToRsdt) {\r
994 //\r
995 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
996 //\r
997 if (AcpiTableInstance->NumberOfTableEntries3 >= mEfiAcpiMaxNumTables) {\r
998 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
999 ASSERT_EFI_ERROR (Status);\r
1000 }\r
1001\r
1002 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1003 //\r
1004 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
1005 // If it becomes necessary to maintain separate table lists, changes will be required.\r
1006 //\r
1007 CurrentRsdtEntry = (UINT32 *)\r
da935a5c 1008 (\r
1009 (UINT8 *) AcpiTableInstance->Rsdt3 +\r
1010 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
1011 AcpiTableInstance->NumberOfTableEntries3 *\r
1012 sizeof (UINT32)\r
1013 );\r
3a61de23
AB
1014\r
1015 //\r
1016 // Add entry to the RSDT\r
1017 //\r
1018 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
1019\r
1020 //\r
1021 // Update RSDT length\r
1022 //\r
1023 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof (UINT32);\r
f9bbb8d9 1024 }\r
da935a5c 1025\r
f9bbb8d9
AB
1026 //\r
1027 // This pointer must not be directly dereferenced as the XSDT entries may not\r
1028 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
1029 //\r
1030 CurrentXsdtEntry = (VOID *)\r
1031 (\r
1032 (UINT8 *) AcpiTableInstance->Xsdt +\r
1033 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
1034 AcpiTableInstance->NumberOfTableEntries3 *\r
1035 sizeof (UINT64)\r
1036 );\r
da935a5c 1037\r
f9bbb8d9
AB
1038 //\r
1039 // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
1040 // the table pointers in XSDT are not aligned on 8 byte boundary.\r
1041 //\r
1042 Buffer64 = (UINT64) (UINTN) CurrentTableList->Table;\r
1043 CopyMem (\r
1044 CurrentXsdtEntry,\r
1045 &Buffer64,\r
1046 sizeof (UINT64)\r
1047 );\r
da935a5c 1048\r
f9bbb8d9
AB
1049 //\r
1050 // Update length\r
1051 //\r
1052 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof (UINT64);\r
1053\r
1054 AcpiTableInstance->NumberOfTableEntries3++;\r
5f55c700 1055 }\r
5f55c700 1056 }\r
1057\r
1058 ChecksumCommonTables (AcpiTableInstance);\r
1059 return EFI_SUCCESS;\r
1060}\r
1061\r
1062\r
1063/**\r
1064 This function finds the table specified by the handle and returns a pointer to it.\r
1065 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are\r
1066 undefined.\r
1067\r
1068 @param Handle Table to find.\r
1069 @param TableList Table list to search\r
1070 @param Table Pointer to table found. \r
1071\r
1072 @return EFI_SUCCESS The function completed successfully.\r
1073 @return EFI_NOT_FOUND No table found matching the handle specified.\r
1074\r
1075**/\r
1076EFI_STATUS\r
1077FindTableByHandle (\r
1078 IN UINTN Handle,\r
1079 IN LIST_ENTRY *TableList,\r
1080 OUT EFI_ACPI_TABLE_LIST **Table\r
1081 )\r
1082{\r
1083 LIST_ENTRY *CurrentLink;\r
1084 EFI_ACPI_TABLE_LIST *CurrentTable;\r
1085\r
1086 //\r
1087 // Check for invalid input parameters\r
1088 //\r
1089 ASSERT (Table);\r
1090\r
1091 //\r
1092 // Find the table\r
1093 //\r
1094 CurrentLink = TableList->ForwardLink;\r
1095\r
1096 while (CurrentLink != TableList) {\r
1097 CurrentTable = EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink);\r
1098 if (CurrentTable->Handle == Handle) {\r
1099 //\r
1100 // Found handle, so return this table.\r
1101 //\r
1102 *Table = CurrentTable;\r
1103 return EFI_SUCCESS;\r
1104 }\r
1105\r
1106 CurrentLink = CurrentLink->ForwardLink;\r
1107 }\r
1108 //\r
1109 // Table not found\r
1110 //\r
1111 return EFI_NOT_FOUND;\r
1112}\r
1113\r
1114\r
1115/**\r
1116 This function removes a basic table from the RSDT and/or XSDT.\r
1117 For Acpi 1.0 tables, pass in the Rsdt.\r
1118 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.\r
1119\r
1120 @param Table Pointer to table found. \r
1121 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT\r
1122 @param Rsdt Pointer to the RSDT to remove from\r
1123 @param Xsdt Pointer to the Xsdt to remove from\r
1124\r
1125 @return EFI_SUCCESS The function completed successfully.\r
1126 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.\r
1127\r
1128**/\r
1129EFI_STATUS\r
1130RemoveTableFromRsdt (\r
1131 IN OUT EFI_ACPI_TABLE_LIST * Table,\r
1132 IN OUT UINTN *NumberOfTableEntries,\r
f9bbb8d9 1133 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Rsdt OPTIONAL,\r
5f55c700 1134 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Xsdt OPTIONAL\r
1135 )\r
1136{\r
1137 UINT32 *CurrentRsdtEntry;\r
1138 VOID *CurrentXsdtEntry;\r
1139 UINT64 CurrentTablePointer64;\r
1140 UINTN Index;\r
1141\r
1142 //\r
1143 // Check for invalid input parameters\r
1144 //\r
1145 ASSERT (Table);\r
1146 ASSERT (NumberOfTableEntries);\r
f9bbb8d9 1147 ASSERT (Rsdt || Xsdt);\r
5f55c700 1148\r
1149 //\r
1150 // Find the table entry in the RSDT and XSDT\r
1151 //\r
1152 for (Index = 0; Index < *NumberOfTableEntries; Index++) {\r
1153 //\r
1154 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
1155 // If it becomes necessary to maintain separate table lists, changes will be required.\r
1156 //\r
f9bbb8d9
AB
1157 if (Rsdt != NULL) {\r
1158 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) Rsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT32));\r
1159 } else {\r
1160 CurrentRsdtEntry = NULL;\r
1161 }\r
5f55c700 1162 if (Xsdt != NULL) {\r
1163 //\r
1164 // This pointer must not be directly dereferenced as the XSDT entries may not\r
1165 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
1166 //\r
1167 CurrentXsdtEntry = (VOID *) ((UINT8 *) Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT64));\r
1168\r
1169 //\r
1170 // Read the entry value out of the XSDT\r
1171 //\r
1172 CopyMem (&CurrentTablePointer64, CurrentXsdtEntry, sizeof (UINT64));\r
1173 } else {\r
1174 //\r
1175 // Initialize to NULL\r
1176 //\r
1177 CurrentXsdtEntry = 0;\r
1178 CurrentTablePointer64 = 0;\r
1179 }\r
1180 //\r
1181 // Check if we have found the corresponding entry in both RSDT and XSDT\r
1182 //\r
efef6ad6 1183 if (((Rsdt == NULL) || *CurrentRsdtEntry == (UINT32) (UINTN) Table->Table) &&\r
5f55c700 1184 ((Xsdt == NULL) || CurrentTablePointer64 == (UINT64) (UINTN) Table->Table)\r
1185 ) {\r
1186 //\r
1187 // Found entry, so copy all following entries and shrink table\r
1188 // We actually copy all + 1 to copy the initialized value of memory over\r
1189 // the last entry.\r
1190 //\r
f9bbb8d9
AB
1191 if (Rsdt != NULL) {\r
1192 CopyMem (CurrentRsdtEntry, CurrentRsdtEntry + 1, (*NumberOfTableEntries - Index) * sizeof (UINT32));\r
1193 Rsdt->Length = Rsdt->Length - sizeof (UINT32);\r
1194 }\r
5f55c700 1195 if (Xsdt != NULL) {\r
1196 CopyMem (CurrentXsdtEntry, ((UINT64 *) CurrentXsdtEntry) + 1, (*NumberOfTableEntries - Index) * sizeof (UINT64));\r
1197 Xsdt->Length = Xsdt->Length - sizeof (UINT64);\r
1198 }\r
1199 break;\r
1200 } else if (Index + 1 == *NumberOfTableEntries) {\r
1201 //\r
1202 // At the last entry, and table not found\r
1203 //\r
1204 return EFI_INVALID_PARAMETER;\r
1205 }\r
1206 }\r
1207 //\r
1208 // Checksum the tables\r
1209 //\r
f9bbb8d9
AB
1210 if (Rsdt != NULL) {\r
1211 AcpiPlatformChecksum (\r
1212 Rsdt,\r
1213 Rsdt->Length,\r
1214 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1215 Checksum)\r
1216 );\r
1217 }\r
5f55c700 1218\r
1219 if (Xsdt != NULL) {\r
1220 AcpiPlatformChecksum (\r
1221 Xsdt,\r
1222 Xsdt->Length,\r
1223 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1224 Checksum)\r
1225 );\r
1226 }\r
1227 //\r
1228 // Decrement the number of tables\r
1229 //\r
1230 (*NumberOfTableEntries)--;\r
1231\r
1232 return EFI_SUCCESS;\r
1233}\r
1234\r
1235\r
1236/**\r
1237 This function removes a table and frees any associated memory.\r
1238\r
1239 @param AcpiTableInstance Instance of the protocol.\r
1240 @param Version Version(s) to delete.\r
1241 @param Table Pointer to table found.\r
1242\r
1243 @return EFI_SUCCESS The function completed successfully.\r
1244\r
1245**/\r
1246EFI_STATUS\r
1247DeleteTable (\r
1248 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1249 IN EFI_ACPI_TABLE_VERSION Version,\r
1250 IN OUT EFI_ACPI_TABLE_LIST *Table\r
1251 )\r
1252{\r
1253 UINT32 CurrentTableSignature;\r
1254 BOOLEAN RemoveFromRsdt;\r
1255\r
1256 //\r
1257 // Check for invalid input parameters\r
1258 //\r
1259 ASSERT (AcpiTableInstance);\r
1260 ASSERT (Table);\r
1261\r
1262 //\r
1263 // Init locals\r
1264 //\r
1265 RemoveFromRsdt = TRUE;\r
6198c346 1266 //\r
1267 // Check for Table->Table\r
1268 //\r
1269 ASSERT (Table->Table != NULL);\r
5f55c700 1270 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table->Table)->Signature;\r
1271\r
1272 //\r
1273 // Basic tasks to accomplish delete are:\r
1274 // Determine removal requirements (in RSDT/XSDT or not)\r
1275 // Remove entry from RSDT/XSDT\r
1276 // Remove any table references to the table\r
1277 // If no one is using the table\r
1278 // Free the table (removing pointers from private data and tables)\r
1279 // Remove from list\r
1280 // Free list structure\r
1281 //\r
1282 //\r
1283 // Determine if this table is in the RSDT or XSDT\r
1284 //\r
1285 if ((CurrentTableSignature == EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
1286 (CurrentTableSignature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) ||\r
1287 (CurrentTableSignature == EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE)\r
1288 ) {\r
1289 RemoveFromRsdt = FALSE;\r
1290 }\r
1291 //\r
1292 // We don't remove the FADT in the standard way because some\r
1293 // OS expect the FADT to be early in the table list.\r
1294 // So we always put it as the first element in the list.\r
1295 //\r
1296 if (CurrentTableSignature == EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {\r
1297 RemoveFromRsdt = FALSE;\r
1298 }\r
1299\r
1300 //\r
1301 // Remove the table from RSDT and XSDT\r
1302 //\r
1303 if (Table->Table != NULL) {\r
1304 //\r
1305 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt\r
1306 //\r
1307 if (Version & EFI_ACPI_TABLE_VERSION_NONE & Table->Version) {\r
1308 //\r
1309 // Remove this version from the table\r
1310 //\r
1311 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_NONE;\r
1312 }\r
1313\r
1314 if (Version & EFI_ACPI_TABLE_VERSION_1_0B & Table->Version) {\r
1315 //\r
1316 // Remove this version from the table\r
1317 //\r
1318 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_1_0B;\r
1319\r
1320 //\r
1321 // Remove from Rsdt. We don't care about the return value because it is\r
1322 // acceptable for the table to not exist in Rsdt.\r
1323 // We didn't add some tables so we don't remove them.\r
1324 //\r
1325 if (RemoveFromRsdt) {\r
1326 RemoveTableFromRsdt (\r
1327 Table,\r
1328 &AcpiTableInstance->NumberOfTableEntries1,\r
1329 AcpiTableInstance->Rsdt1,\r
1330 NULL\r
1331 );\r
1332 }\r
1333 }\r
1334\r
f0071740 1335 if (Version & ACPI_TABLE_VERSION_GTE_2_0 & Table->Version) {\r
5f55c700 1336 //\r
1337 // Remove this version from the table\r
1338 //\r
f0071740 1339 Table->Version = Table->Version &~(Version & ACPI_TABLE_VERSION_GTE_2_0);\r
5f55c700 1340 \r
1341 //\r
1342 // Remove from Rsdt and Xsdt. We don't care about the return value\r
1343 // because it is acceptable for the table to not exist in Rsdt/Xsdt.\r
1344 // We didn't add some tables so we don't remove them.\r
1345 //\r
1346 if (RemoveFromRsdt) {\r
1347 RemoveTableFromRsdt (\r
1348 Table,\r
1349 &AcpiTableInstance->NumberOfTableEntries3,\r
1350 AcpiTableInstance->Rsdt3,\r
1351 AcpiTableInstance->Xsdt\r
1352 );\r
1353 }\r
1354 } \r
1355 //\r
1356 // Free the table, clean up any dependent tables and our private data pointers.\r
1357 //\r
1358 switch (Table->Table->Signature) {\r
1359\r
1360 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
1361 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1362 AcpiTableInstance->Fadt1 = NULL;\r
1363 }\r
1364\r
f0071740 1365 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1366 AcpiTableInstance->Fadt3 = NULL;\r
1367 }\r
1368 break;\r
1369\r
1370 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
1371 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1372 AcpiTableInstance->Facs1 = NULL;\r
1373\r
1374 //\r
1375 // Update FADT table pointers\r
1376 //\r
1377 if (AcpiTableInstance->Fadt1 != NULL) {\r
1378 AcpiTableInstance->Fadt1->FirmwareCtrl = 0;\r
1379\r
1380 //\r
1381 // Checksum table\r
1382 //\r
1383 AcpiPlatformChecksum (\r
1384 AcpiTableInstance->Fadt1,\r
1385 AcpiTableInstance->Fadt1->Header.Length,\r
1386 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1387 Checksum)\r
1388 );\r
1389 }\r
1390 }\r
1391\r
f0071740 1392 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1393 AcpiTableInstance->Facs3 = NULL;\r
1394\r
1395 //\r
1396 // Update FADT table pointers\r
1397 //\r
1398 if (AcpiTableInstance->Fadt3 != NULL) {\r
1399 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
1400 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
1401\r
1402 //\r
1403 // Checksum table\r
1404 //\r
1405 AcpiPlatformChecksum (\r
1406 AcpiTableInstance->Fadt3,\r
1407 AcpiTableInstance->Fadt3->Header.Length,\r
1408 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1409 Checksum)\r
1410 );\r
1411 }\r
1412 } \r
1413 break;\r
1414\r
1415 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
1416 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1417 AcpiTableInstance->Dsdt1 = NULL;\r
1418\r
1419 //\r
1420 // Update FADT table pointers\r
1421 //\r
1422 if (AcpiTableInstance->Fadt1 != NULL) {\r
1423 AcpiTableInstance->Fadt1->Dsdt = 0;\r
1424\r
1425 //\r
1426 // Checksum table\r
1427 //\r
1428 AcpiPlatformChecksum (\r
1429 AcpiTableInstance->Fadt1,\r
1430 AcpiTableInstance->Fadt1->Header.Length,\r
1431 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1432 Checksum)\r
1433 );\r
1434 }\r
1435 }\r
1436\r
1437 \r
f0071740 1438 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1439 AcpiTableInstance->Dsdt3 = NULL;\r
1440\r
1441 //\r
1442 // Update FADT table pointers\r
1443 //\r
1444 if (AcpiTableInstance->Fadt3 != NULL) {\r
1445 AcpiTableInstance->Fadt3->Dsdt = 0;\r
1446 ZeroMem (&AcpiTableInstance->Fadt3->XDsdt, sizeof (UINT64));\r
1447\r
1448 //\r
1449 // Checksum table\r
1450 //\r
1451 AcpiPlatformChecksum (\r
1452 AcpiTableInstance->Fadt3,\r
1453 AcpiTableInstance->Fadt3->Header.Length,\r
1454 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1455 Checksum)\r
1456 );\r
1457 }\r
1458 }\r
1459 break;\r
1460\r
1461 default:\r
1462 //\r
1463 // Do nothing\r
1464 //\r
1465 break;\r
1466 }\r
1467 }\r
1468 //\r
1469 // If no version is using this table anymore, remove and free list entry.\r
1470 //\r
1471 if (Table->Version == 0) {\r
1472 //\r
1473 // Free the Table\r
1474 //\r
1475 gBS->FreePages (Table->PageAddress, Table->NumberOfPages);\r
1476 RemoveEntryList (&(Table->Link));\r
1477 gBS->FreePool (Table);\r
1478 }\r
1479 //\r
1480 // Done\r
1481 //\r
1482 return EFI_SUCCESS;\r
1483}\r
1484\r
1485\r
1486/**\r
1487 This function finds and removes the table specified by the handle.\r
1488\r
1489 @param AcpiTableInstance Instance of the protocol.\r
1490 @param Version Bitmask of which versions to remove.\r
1491 @param Handle Table to remove.\r
1492\r
1493 @return EFI_SUCCESS The function completed successfully.\r
1494 @return EFI_ABORTED An error occurred.\r
1495 @return EFI_NOT_FOUND Handle not found in table list.\r
1496\r
1497**/\r
1498EFI_STATUS\r
1499RemoveTableFromList (\r
1500 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1501 IN EFI_ACPI_TABLE_VERSION Version,\r
1502 IN UINTN Handle\r
1503 )\r
1504{\r
1505 EFI_ACPI_TABLE_LIST *Table;\r
1506 EFI_STATUS Status;\r
1507\r
b474ed49 1508 Table = (EFI_ACPI_TABLE_LIST*) NULL;\r
1509\r
5f55c700 1510 //\r
1511 // Check for invalid input parameters\r
1512 //\r
1513 ASSERT (AcpiTableInstance);\r
1514\r
1515 //\r
1516 // Find the table\r
1517 //\r
1518 Status = FindTableByHandle (\r
1519 Handle,\r
1520 &AcpiTableInstance->TableList,\r
1521 &Table\r
1522 );\r
1523 if (EFI_ERROR (Status)) {\r
1524 return EFI_NOT_FOUND;\r
1525 }\r
1526 //\r
1527 // Remove the table\r
1528 //\r
1529 Status = DeleteTable (AcpiTableInstance, Version, Table);\r
1530 if (EFI_ERROR (Status)) {\r
1531 return EFI_ABORTED;\r
1532 }\r
1533 //\r
1534 // Completed successfully\r
1535 //\r
1536 return EFI_SUCCESS;\r
1537}\r
1538\r
1539\r
1540/**\r
1541 This function calculates and updates an UINT8 checksum.\r
1542\r
1543 @param Buffer Pointer to buffer to checksum\r
1544 @param Size Number of bytes to checksum\r
1545 @param ChecksumOffset Offset to place the checksum result in\r
1546\r
1547 @return EFI_SUCCESS The function completed successfully.\r
1548\r
1549**/\r
1550EFI_STATUS\r
1551AcpiPlatformChecksum (\r
1552 IN VOID *Buffer,\r
1553 IN UINTN Size,\r
1554 IN UINTN ChecksumOffset\r
1555 )\r
1556{\r
1557 UINT8 Sum;\r
1558 UINT8 *Ptr;\r
1559\r
1560 Sum = 0;\r
1561 //\r
1562 // Initialize pointer\r
1563 //\r
1564 Ptr = Buffer;\r
1565\r
1566 //\r
1567 // set checksum to 0 first\r
1568 //\r
1569 Ptr[ChecksumOffset] = 0;\r
1570\r
1571 //\r
1572 // add all content of buffer\r
1573 //\r
1574 while ((Size--) != 0) {\r
1575 Sum = (UINT8) (Sum + (*Ptr++));\r
1576 }\r
1577 //\r
1578 // set checksum\r
1579 //\r
1580 Ptr = Buffer;\r
1581 Ptr[ChecksumOffset] = (UINT8) (0xff - Sum + 1);\r
1582\r
1583 return EFI_SUCCESS;\r
1584}\r
1585\r
1586\r
1587/**\r
1588 Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
1589\r
1590 @param AcpiTableInstance Protocol instance private data.\r
1591\r
1592 @return EFI_SUCCESS The function completed successfully.\r
1593\r
1594**/\r
1595EFI_STATUS\r
1596ChecksumCommonTables (\r
1597 IN OUT EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1598 )\r
1599{\r
1600 //\r
1601 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure\r
1602 //\r
f9bbb8d9
AB
1603 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1604 AcpiPlatformChecksum (\r
1605 AcpiTableInstance->Rsdp1,\r
1606 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1607 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1608 Checksum)\r
1609 );\r
1610 }\r
5f55c700 1611\r
1612 //\r
1613 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure\r
1614 //\r
1615 AcpiPlatformChecksum (\r
1616 AcpiTableInstance->Rsdp3,\r
1617 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1618 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1619 Checksum)\r
1620 );\r
1621\r
1622 //\r
1623 // RSDP ACPI 2.0/3.0 checksum, this is the entire table\r
1624 //\r
1625 AcpiPlatformChecksum (\r
1626 AcpiTableInstance->Rsdp3,\r
1627 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1628 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1629 ExtendedChecksum)\r
1630 );\r
1631\r
f9bbb8d9
AB
1632 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1633 //\r
1634 // RSDT checksums\r
1635 //\r
1636 AcpiPlatformChecksum (\r
1637 AcpiTableInstance->Rsdt1,\r
1638 AcpiTableInstance->Rsdt1->Length,\r
1639 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1640 Checksum)\r
1641 );\r
5f55c700 1642\r
f9bbb8d9
AB
1643 AcpiPlatformChecksum (\r
1644 AcpiTableInstance->Rsdt3,\r
1645 AcpiTableInstance->Rsdt3->Length,\r
1646 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1647 Checksum)\r
1648 );\r
1649 }\r
5f55c700 1650\r
1651 //\r
1652 // XSDT checksum\r
1653 //\r
1654 AcpiPlatformChecksum (\r
1655 AcpiTableInstance->Xsdt,\r
1656 AcpiTableInstance->Xsdt->Length,\r
1657 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1658 Checksum)\r
1659 );\r
1660 \r
1661 return EFI_SUCCESS;\r
1662}\r
1663\r
1664\r
1665/**\r
1666 Constructor for the ACPI table protocol. Initializes instance\r
1667 data.\r
1668\r
1669 @param AcpiTableInstance Instance to construct\r
1670\r
1671 @return EFI_SUCCESS Instance initialized.\r
1672 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.\r
1673\r
1674**/\r
1675EFI_STATUS\r
1676AcpiTableAcpiTableConstructor (\r
1677 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1678 )\r
1679{\r
1680 EFI_STATUS Status;\r
1681 UINT64 CurrentData;\r
1682 UINTN TotalSize;\r
37abfb7e 1683 UINTN RsdpTableSize;\r
5f55c700 1684 UINT8 *Pointer;\r
1685 EFI_PHYSICAL_ADDRESS PageAddress;\r
1686\r
1687 //\r
1688 // Check for invalid input parameters\r
1689 //\r
1690 ASSERT (AcpiTableInstance);\r
1691\r
f9bbb8d9
AB
1692 //\r
1693 // If ACPI v1.0b is among the ACPI versions we aim to support, we have to\r
1694 // ensure that all memory allocations are below 4 GB.\r
1695 //\r
1696 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1697 mAcpiTableAllocType = AllocateMaxAddress;\r
1698 } else {\r
1699 mAcpiTableAllocType = AllocateAnyPages;\r
1700 }\r
1701\r
5f55c700 1702 InitializeListHead (&AcpiTableInstance->TableList);\r
1703 AcpiTableInstance->CurrentHandle = 1;\r
1704\r
1705 AcpiTableInstance->AcpiTableProtocol.InstallAcpiTable = InstallAcpiTable;\r
1706 AcpiTableInstance->AcpiTableProtocol.UninstallAcpiTable = UninstallAcpiTable;\r
3dc8585e
JY
1707\r
1708 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
1709 SdtAcpiTableAcpiSdtConstructor (AcpiTableInstance);\r
1710 }\r
1711\r
5f55c700 1712 //\r
37abfb7e
LG
1713 // Create RSDP table\r
1714 //\r
f9bbb8d9
AB
1715 RsdpTableSize = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1716 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1717 RsdpTableSize += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1718 }\r
37abfb7e
LG
1719\r
1720 PageAddress = 0xFFFFFFFF;\r
1721 Status = gBS->AllocatePages (\r
f9bbb8d9 1722 mAcpiTableAllocType,\r
37abfb7e
LG
1723 EfiACPIReclaimMemory,\r
1724 EFI_SIZE_TO_PAGES (RsdpTableSize),\r
1725 &PageAddress\r
1726 );\r
1727\r
1728 if (EFI_ERROR (Status)) {\r
1729 return EFI_OUT_OF_RESOURCES;\r
1730 }\r
1731\r
1732 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1733 ZeroMem (Pointer, RsdpTableSize);\r
1734\r
1735 AcpiTableInstance->Rsdp1 = (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
f9bbb8d9
AB
1736 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1737 Pointer += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1738 }\r
37abfb7e
LG
1739 AcpiTableInstance->Rsdp3 = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
1740\r
1741 //\r
1742 // Create RSDT, XSDT structures\r
5f55c700 1743 //\r
f9bbb8d9 1744 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
37abfb7e 1745 mEfiAcpiMaxNumTables * sizeof (UINT64);\r
5f55c700 1746\r
f9bbb8d9
AB
1747 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1748 TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
1749 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
1750 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
1751 mEfiAcpiMaxNumTables * sizeof (UINT32);\r
1752 }\r
1753\r
5f55c700 1754 //\r
1755 // Allocate memory in the lower 32 bit of address range for\r
1756 // compatibility with ACPI 1.0 OS.\r
1757 //\r
1758 // This is done because ACPI 1.0 pointers are 32 bit values.\r
1759 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
1760 // There is no architectural reason these should be below 4GB, it is purely\r
1761 // for convenience of implementation that we force memory below 4GB.\r
1762 //\r
1763 PageAddress = 0xFFFFFFFF;\r
1764 Status = gBS->AllocatePages (\r
f9bbb8d9 1765 mAcpiTableAllocType,\r
5f55c700 1766 EfiACPIReclaimMemory,\r
1767 EFI_SIZE_TO_PAGES (TotalSize),\r
1768 &PageAddress\r
1769 );\r
1770\r
1771 if (EFI_ERROR (Status)) {\r
37abfb7e 1772 gBS->FreePages ((EFI_PHYSICAL_ADDRESS)(UINTN)AcpiTableInstance->Rsdp1, EFI_SIZE_TO_PAGES (RsdpTableSize));\r
5f55c700 1773 return EFI_OUT_OF_RESOURCES;\r
1774 }\r
1775\r
1776 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1777 ZeroMem (Pointer, TotalSize);\r
1778\r
5f55c700 1779 AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
f9bbb8d9
AB
1780 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1781 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
1782 AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1783 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
1784 }\r
5f55c700 1785 AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1786\r
1787 //\r
1788 // Initialize RSDP\r
1789 //\r
f9bbb8d9
AB
1790 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1791 CurrentData = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1792 CopyMem (&AcpiTableInstance->Rsdp1->Signature, &CurrentData, sizeof (UINT64));\r
1793 CopyMem (AcpiTableInstance->Rsdp1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp1->OemId));\r
1794 AcpiTableInstance->Rsdp1->Reserved = EFI_ACPI_RESERVED_BYTE;\r
1795 AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt1;\r
1796 }\r
5f55c700 1797\r
1798 CurrentData = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1799 CopyMem (&AcpiTableInstance->Rsdp3->Signature, &CurrentData, sizeof (UINT64));\r
e84f07b5 1800 CopyMem (AcpiTableInstance->Rsdp3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp3->OemId));\r
5f55c700 1801 AcpiTableInstance->Rsdp3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION;\r
5f55c700 1802 AcpiTableInstance->Rsdp3->Length = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
f9bbb8d9
AB
1803 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1804 AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt3;\r
1805 }\r
5f55c700 1806 CurrentData = (UINT64) (UINTN) AcpiTableInstance->Xsdt;\r
1807 CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
1808 SetMem (AcpiTableInstance->Rsdp3->Reserved, 3, EFI_ACPI_RESERVED_BYTE);\r
1809\r
f9bbb8d9
AB
1810 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1811 //\r
1812 // Initialize Rsdt\r
1813 //\r
1814 // Note that we "reserve" one entry for the FADT so it can always be\r
1815 // at the beginning of the list of tables. Some OS don't seem\r
1816 // to find it correctly if it is too far down the list.\r
1817 //\r
1818 AcpiTableInstance->Rsdt1->Signature = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1819 AcpiTableInstance->Rsdt1->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1820 AcpiTableInstance->Rsdt1->Revision = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1821 CopyMem (AcpiTableInstance->Rsdt1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt1->OemId));\r
1822 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
1823 CopyMem (&AcpiTableInstance->Rsdt1->OemTableId, &CurrentData, sizeof (UINT64));\r
1824 AcpiTableInstance->Rsdt1->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1825 AcpiTableInstance->Rsdt1->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1826 AcpiTableInstance->Rsdt1->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
1827 //\r
1828 // We always reserve first one for FADT\r
1829 //\r
1830 AcpiTableInstance->NumberOfTableEntries1 = 1;\r
1831 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof(UINT32);\r
1832\r
1833 AcpiTableInstance->Rsdt3->Signature = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1834 AcpiTableInstance->Rsdt3->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1835 AcpiTableInstance->Rsdt3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1836 CopyMem (AcpiTableInstance->Rsdt3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt3->OemId));\r
1837 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
1838 CopyMem (&AcpiTableInstance->Rsdt3->OemTableId, &CurrentData, sizeof (UINT64));\r
1839 AcpiTableInstance->Rsdt3->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1840 AcpiTableInstance->Rsdt3->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1841 AcpiTableInstance->Rsdt3->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
1842 //\r
1843 // We always reserve first one for FADT\r
1844 //\r
1845 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof(UINT32);\r
1846 }\r
5f55c700 1847 AcpiTableInstance->NumberOfTableEntries3 = 1;\r
5f55c700 1848\r
1849 //\r
1850 // Initialize Xsdt\r
1851 //\r
1852 AcpiTableInstance->Xsdt->Signature = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1853 AcpiTableInstance->Xsdt->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1854 AcpiTableInstance->Xsdt->Revision = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
e84f07b5
SZ
1855 CopyMem (AcpiTableInstance->Xsdt->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Xsdt->OemId));\r
1856 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
5f55c700 1857 CopyMem (&AcpiTableInstance->Xsdt->OemTableId, &CurrentData, sizeof (UINT64));\r
e84f07b5
SZ
1858 AcpiTableInstance->Xsdt->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1859 AcpiTableInstance->Xsdt->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1860 AcpiTableInstance->Xsdt->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
5f55c700 1861 //\r
1862 // We always reserve first one for FADT\r
1863 //\r
1864 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof(UINT64);\r
1865\r
1866 ChecksumCommonTables (AcpiTableInstance);\r
1867\r
1868 //\r
1869 // Completed successfully\r
1870 //\r
1871 return EFI_SUCCESS;\r
1872}\r
1873\r