]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableProtocol.c
MdeModulePkg/PciHostBridge: Don't assume resources are fully NonExistent
[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiTableProtocol.c
CommitLineData
5f55c700 1/** @file\r
2 ACPI Table Protocol Implementation\r
3\r
f0071740 4 Copyright (c) 2006 - 2015, 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
5f55c700 433/**\r
434 This function adds an ACPI table to the table list. It will detect FACS and\r
435 allocate the correct type of memory and properly align the table.\r
436\r
437 @param AcpiTableInstance Instance of the protocol.\r
438 @param Table Table to add.\r
439 @param Checksum Does the table require checksumming.\r
440 @param Version The version of the list to add the table to.\r
441 @param Handle Pointer for returning the handle.\r
442\r
443 @return EFI_SUCCESS The function completed successfully.\r
444 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.\r
5966402e
SZ
445 @retval EFI_ACCESS_DENIED The table signature matches a table already\r
446 present in the system and platform policy\r
447 does not allow duplicate tables of this type.\r
5f55c700 448\r
449**/\r
450EFI_STATUS\r
451AddTableToList (\r
452 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
453 IN VOID *Table,\r
454 IN BOOLEAN Checksum,\r
455 IN EFI_ACPI_TABLE_VERSION Version,\r
456 OUT UINTN *Handle\r
457 )\r
458{\r
459 EFI_STATUS Status;\r
460 EFI_ACPI_TABLE_LIST *CurrentTableList;\r
461 UINT32 CurrentTableSignature;\r
462 UINT32 CurrentTableSize;\r
463 UINT32 *CurrentRsdtEntry;\r
464 VOID *CurrentXsdtEntry;\r
465 UINT64 Buffer64;\r
466 BOOLEAN AddToRsdt;\r
467\r
468 //\r
469 // Check for invalid input parameters\r
470 //\r
471 ASSERT (AcpiTableInstance);\r
472 ASSERT (Table);\r
473 ASSERT (Handle);\r
474\r
475 //\r
476 // Init locals\r
477 //\r
478 AddToRsdt = TRUE;\r
479\r
480 //\r
481 // Create a new list entry\r
482 //\r
483 CurrentTableList = AllocatePool (sizeof (EFI_ACPI_TABLE_LIST));\r
484 ASSERT (CurrentTableList);\r
485\r
486 //\r
487 // Determine table type and size\r
488 //\r
489 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table)->Signature;\r
490 CurrentTableSize = ((EFI_ACPI_COMMON_HEADER *) Table)->Length;\r
491\r
492 //\r
493 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space\r
494 // for backwards compatibility with ACPI 1.0 OS.\r
495 //\r
496 // This is done because ACPI 1.0 pointers are 32 bit values.\r
497 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
498 // There is no architectural reason these should be below 4GB, it is purely\r
499 // for convenience of implementation that we force memory below 4GB.\r
500 //\r
501 CurrentTableList->PageAddress = 0xFFFFFFFF;\r
502 CurrentTableList->NumberOfPages = EFI_SIZE_TO_PAGES (CurrentTableSize);\r
503\r
504 //\r
505 // Allocation memory type depends on the type of the table\r
506 //\r
36d58153
JY
507 if ((CurrentTableSignature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) || \r
508 (CurrentTableSignature == EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE)) {\r
5f55c700 509 //\r
510 // Allocate memory for the FACS. This structure must be aligned\r
511 // on a 64 byte boundary and must be ACPI NVS memory.\r
512 // Using AllocatePages should ensure that it is always aligned.\r
36d58153
JY
513 // Do not change signature for new ACPI version because they are same.\r
514 //\r
515 // UEFI table also need to be in ACPI NVS memory, because some data field\r
516 // could be updated by OS present agent. For example, BufferPtrAddress in\r
517 // SMM communication ACPI table.\r
5f55c700 518 //\r
519 ASSERT ((EFI_PAGE_SIZE % 64) == 0);\r
520 Status = gBS->AllocatePages (\r
521 AllocateMaxAddress,\r
522 EfiACPIMemoryNVS,\r
523 CurrentTableList->NumberOfPages,\r
524 &CurrentTableList->PageAddress\r
525 );\r
526 } else {\r
527 //\r
528 // All other tables are ACPI reclaim memory, no alignment requirements.\r
529 //\r
530 Status = gBS->AllocatePages (\r
f9bbb8d9 531 mAcpiTableAllocType,\r
5f55c700 532 EfiACPIReclaimMemory,\r
533 CurrentTableList->NumberOfPages,\r
534 &CurrentTableList->PageAddress\r
535 );\r
536 }\r
537 //\r
538 // Check return value from memory alloc.\r
539 //\r
540 if (EFI_ERROR (Status)) {\r
541 gBS->FreePool (CurrentTableList);\r
542 return EFI_OUT_OF_RESOURCES;\r
543 }\r
544 //\r
545 // Update the table pointer with the allocated memory start\r
546 //\r
547 CurrentTableList->Table = (EFI_ACPI_COMMON_HEADER *) (UINTN) CurrentTableList->PageAddress;\r
548\r
549 //\r
550 // Initialize the table contents\r
551 //\r
552 CurrentTableList->Signature = EFI_ACPI_TABLE_LIST_SIGNATURE;\r
553 CopyMem (CurrentTableList->Table, Table, CurrentTableSize);\r
554 CurrentTableList->Handle = AcpiTableInstance->CurrentHandle++;\r
555 *Handle = CurrentTableList->Handle;\r
556 CurrentTableList->Version = Version;\r
557\r
558 //\r
559 // Update internal pointers if this is a required table. If it is a required\r
560 // table and a table of that type already exists, return an error.\r
561 //\r
562 // Calculate the checksum if the table is not FACS.\r
563 //\r
564 switch (CurrentTableSignature) {\r
565\r
566 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
567 //\r
568 // We don't add the FADT in the standard way because some\r
569 // OS expect the FADT to be early in the table list.\r
570 // So we always add it as the first element in the list.\r
571 //\r
572 AddToRsdt = FALSE;\r
573\r
574 //\r
575 // Check that the table has not been previously added.\r
576 //\r
577 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Fadt1 != NULL) ||\r
f0071740 578 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Fadt3 != NULL)\r
5f55c700 579 ) {\r
580 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
581 gBS->FreePool (CurrentTableList);\r
5966402e 582 return EFI_ACCESS_DENIED;\r
5f55c700 583 }\r
584 //\r
585 // Add the table to the appropriate table version\r
586 //\r
587 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
588 //\r
589 // Save a pointer to the table\r
590 //\r
591 AcpiTableInstance->Fadt1 = (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
592\r
593 //\r
594 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
595 //\r
596 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
597 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
598\r
599 //\r
600 // RSDP OEM information is updated to match the FADT OEM information\r
601 //\r
602 CopyMem (\r
603 &AcpiTableInstance->Rsdp1->OemId,\r
604 &AcpiTableInstance->Fadt1->Header.OemId,\r
605 6\r
606 );\r
607\r
608 //\r
609 // RSDT OEM information is updated to match the FADT OEM information.\r
610 //\r
611 CopyMem (\r
612 &AcpiTableInstance->Rsdt1->OemId,\r
613 &AcpiTableInstance->Fadt1->Header.OemId,\r
614 6\r
615 );\r
616\r
617 CopyMem (\r
618 &AcpiTableInstance->Rsdt1->OemTableId,\r
619 &AcpiTableInstance->Fadt1->Header.OemTableId,\r
620 sizeof (UINT64)\r
621 );\r
622 AcpiTableInstance->Rsdt1->OemRevision = AcpiTableInstance->Fadt1->Header.OemRevision;\r
623 }\r
624\r
f0071740 625 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 626 //\r
627 // Save a pointer to the table\r
628 //\r
629 AcpiTableInstance->Fadt3 = (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *) CurrentTableList->Table;\r
630\r
631 //\r
632 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.\r
c93776c2
JY
633 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and \r
634 // vice-versa.\r
5f55c700 635 //\r
10342a64 636 if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
c93776c2 637 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
f798e8bf 638 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
c93776c2
JY
639 } else {\r
640 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
641 CopyMem (\r
642 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
643 &Buffer64,\r
644 sizeof (UINT64)\r
645 );\r
f798e8bf 646 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
c93776c2 647 }\r
f9bbb8d9
AB
648 if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
649 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
650 ZeroMem (&AcpiTableInstance->Fadt3->XDsdt, sizeof (UINT64));\r
651 } else {\r
652 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
653 CopyMem (\r
654 &AcpiTableInstance->Fadt3->XDsdt,\r
655 &Buffer64,\r
656 sizeof (UINT64)\r
657 );\r
658 AcpiTableInstance->Fadt3->Dsdt = 0;\r
659 }\r
5f55c700 660\r
f0c855b2 661 //\r
662 // RSDP OEM information is updated to match the FADT OEM information\r
663 //\r
664 CopyMem (\r
665 &AcpiTableInstance->Rsdp3->OemId,\r
666 &AcpiTableInstance->Fadt3->Header.OemId,\r
667 6\r
668 );\r
669 \r
f9bbb8d9
AB
670 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
671 //\r
672 // RSDT OEM information is updated to match FADT OEM information.\r
673 //\r
674 CopyMem (\r
675 &AcpiTableInstance->Rsdt3->OemId,\r
676 &AcpiTableInstance->Fadt3->Header.OemId,\r
677 6\r
678 );\r
679 CopyMem (\r
680 &AcpiTableInstance->Rsdt3->OemTableId,\r
681 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
682 sizeof (UINT64)\r
683 );\r
684 AcpiTableInstance->Rsdt3->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
685 }\r
686\r
f0c855b2 687 //\r
688 // XSDT OEM information is updated to match FADT OEM information.\r
689 //\r
690 CopyMem (\r
691 &AcpiTableInstance->Xsdt->OemId,\r
692 &AcpiTableInstance->Fadt3->Header.OemId,\r
693 6\r
694 );\r
695 CopyMem (\r
696 &AcpiTableInstance->Xsdt->OemTableId,\r
697 &AcpiTableInstance->Fadt3->Header.OemTableId,\r
698 sizeof (UINT64)\r
699 );\r
700 AcpiTableInstance->Xsdt->OemRevision = AcpiTableInstance->Fadt3->Header.OemRevision;\r
5f55c700 701 } \r
702 //\r
703 // Checksum the table\r
704 //\r
705 if (Checksum) {\r
706 AcpiPlatformChecksum (\r
707 CurrentTableList->Table,\r
708 CurrentTableList->Table->Length,\r
709 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
710 Checksum)\r
711 );\r
712 }\r
713 break;\r
714\r
715 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
716 //\r
717 // Check that the table has not been previously added.\r
718 //\r
719 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Facs1 != NULL) ||\r
f0071740 720 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Facs3 != NULL)\r
5f55c700 721 ) {\r
722 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
723 gBS->FreePool (CurrentTableList);\r
5966402e 724 return EFI_ACCESS_DENIED;\r
5f55c700 725 }\r
726 //\r
727 // FACS is referenced by FADT and is not part of RSDT\r
728 //\r
729 AddToRsdt = FALSE;\r
730\r
731 //\r
732 // Add the table to the appropriate table version\r
733 //\r
734 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
735 //\r
736 // Save a pointer to the table\r
737 //\r
738 AcpiTableInstance->Facs1 = (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
739\r
740 //\r
741 // If FADT already exists, update table pointers.\r
742 //\r
743 if (AcpiTableInstance->Fadt1 != NULL) {\r
744 AcpiTableInstance->Fadt1->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs1;\r
745\r
746 //\r
747 // Checksum FADT table\r
748 //\r
749 AcpiPlatformChecksum (\r
750 AcpiTableInstance->Fadt1,\r
751 AcpiTableInstance->Fadt1->Header.Length,\r
752 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
753 Checksum)\r
754 );\r
755 }\r
756 }\r
757\r
f0071740 758 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 759 //\r
760 // Save a pointer to the table\r
761 //\r
762 AcpiTableInstance->Facs3 = (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) CurrentTableList->Table;\r
763\r
764 //\r
765 // If FADT already exists, update table pointers.\r
766 //\r
767 if (AcpiTableInstance->Fadt3 != NULL) {\r
c93776c2
JY
768 //\r
769 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and \r
770 // vice-versa.\r
771 //\r
10342a64 772 if ((UINT64)(UINTN)AcpiTableInstance->Facs3 < BASE_4GB) {\r
c93776c2 773 AcpiTableInstance->Fadt3->FirmwareCtrl = (UINT32) (UINTN) AcpiTableInstance->Facs3;\r
f798e8bf 774 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
c93776c2
JY
775 } else {\r
776 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Facs3;\r
777 CopyMem (\r
778 &AcpiTableInstance->Fadt3->XFirmwareCtrl,\r
779 &Buffer64,\r
780 sizeof (UINT64)\r
781 );\r
f798e8bf 782 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
c93776c2 783 }\r
5f55c700 784\r
785 //\r
786 // Checksum FADT table\r
787 //\r
788 AcpiPlatformChecksum (\r
789 AcpiTableInstance->Fadt3,\r
790 AcpiTableInstance->Fadt3->Header.Length,\r
791 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
792 Checksum)\r
793 );\r
794 }\r
795 }\r
796\r
797 break;\r
798\r
799 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
800 //\r
801 // Check that the table has not been previously added.\r
802 //\r
803 if (((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0 && AcpiTableInstance->Dsdt1 != NULL) ||\r
f0071740 804 ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0 && AcpiTableInstance->Dsdt3 != NULL)\r
5f55c700 805 ) {\r
806 gBS->FreePages (CurrentTableList->PageAddress, CurrentTableList->NumberOfPages);\r
807 gBS->FreePool (CurrentTableList);\r
5966402e 808 return EFI_ACCESS_DENIED;\r
5f55c700 809 }\r
810 //\r
811 // DSDT is referenced by FADT and is not part of RSDT\r
812 //\r
813 AddToRsdt = FALSE;\r
814\r
815 //\r
816 // Add the table to the appropriate table version\r
817 //\r
818 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
819 //\r
820 // Save a pointer to the table\r
821 //\r
822 AcpiTableInstance->Dsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
823\r
824 //\r
825 // If FADT already exists, update table pointers.\r
826 //\r
827 if (AcpiTableInstance->Fadt1 != NULL) {\r
828 AcpiTableInstance->Fadt1->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt1;\r
829\r
830 //\r
831 // Checksum FADT table\r
832 //\r
833 AcpiPlatformChecksum (\r
834 AcpiTableInstance->Fadt1,\r
835 AcpiTableInstance->Fadt1->Header.Length,\r
836 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
837 Checksum)\r
838 );\r
839 }\r
840 }\r
841 \r
f0071740 842 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 843 //\r
844 // Save a pointer to the table\r
845 //\r
846 AcpiTableInstance->Dsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) CurrentTableList->Table;\r
847\r
848 //\r
849 // If FADT already exists, update table pointers.\r
850 //\r
851 if (AcpiTableInstance->Fadt3 != NULL) {\r
f9bbb8d9
AB
852 if ((UINT64)(UINTN)AcpiTableInstance->Dsdt3 < BASE_4GB) {\r
853 AcpiTableInstance->Fadt3->Dsdt = (UINT32) (UINTN) AcpiTableInstance->Dsdt3;\r
854 }\r
5f55c700 855 Buffer64 = (UINT64) (UINTN) AcpiTableInstance->Dsdt3;\r
856 CopyMem (\r
857 &AcpiTableInstance->Fadt3->XDsdt,\r
858 &Buffer64,\r
859 sizeof (UINT64)\r
860 );\r
861\r
862 //\r
863 // Checksum FADT table\r
864 //\r
865 AcpiPlatformChecksum (\r
866 AcpiTableInstance->Fadt3,\r
867 AcpiTableInstance->Fadt3->Header.Length,\r
868 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
869 Checksum)\r
870 );\r
871 }\r
872 } \r
873 //\r
874 // Checksum the table\r
875 //\r
876 if (Checksum) {\r
877 AcpiPlatformChecksum (\r
878 CurrentTableList->Table,\r
879 CurrentTableList->Table->Length,\r
880 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
881 Checksum)\r
882 );\r
883 }\r
884 break;\r
885\r
886 default:\r
887 //\r
888 // Checksum the table\r
889 //\r
890 if (Checksum) {\r
891 AcpiPlatformChecksum (\r
892 CurrentTableList->Table,\r
893 CurrentTableList->Table->Length,\r
894 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
895 Checksum)\r
896 );\r
897 }\r
898 break;\r
899 }\r
900 //\r
901 // Add the table to the current list of tables\r
902 //\r
903 InsertTailList (&AcpiTableInstance->TableList, &CurrentTableList->Link);\r
904\r
905 //\r
906 // Add the table to RSDT and/or XSDT table entry lists.\r
907 //\r
908 //\r
909 // Add to ACPI 1.0b table tree\r
910 //\r
911 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
5f55c700 912 if (AddToRsdt) {\r
913 //\r
da935a5c 914 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
5f55c700 915 //\r
da935a5c 916 if (AcpiTableInstance->NumberOfTableEntries1 >= mEfiAcpiMaxNumTables) {\r
917 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
918 ASSERT_EFI_ERROR (Status);\r
919 }\r
5f55c700 920 CurrentRsdtEntry = (UINT32 *)\r
921 (\r
da935a5c 922 (UINT8 *) AcpiTableInstance->Rsdt1 +\r
5f55c700 923 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
da935a5c 924 AcpiTableInstance->NumberOfTableEntries1 *\r
5f55c700 925 sizeof (UINT32)\r
926 );\r
927\r
928 //\r
da935a5c 929 // Add entry to the RSDT unless its the FACS or DSDT\r
5f55c700 930 //\r
931 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
932\r
933 //\r
934 // Update RSDT length\r
935 //\r
da935a5c 936 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof (UINT32);\r
5f55c700 937\r
da935a5c 938 AcpiTableInstance->NumberOfTableEntries1++;\r
939 }\r
940 }\r
941 //\r
942 // Add to ACPI 2.0/3.0 table tree\r
943 //\r
f0071740 944 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
f9bbb8d9
AB
945 if (AddToRsdt) {\r
946 //\r
947 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer\r
948 //\r
949 if (AcpiTableInstance->NumberOfTableEntries3 >= mEfiAcpiMaxNumTables) {\r
950 Status = ReallocateAcpiTableBuffer (AcpiTableInstance);\r
951 ASSERT_EFI_ERROR (Status);\r
952 }\r
953\r
954 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
955 //\r
956 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
957 // If it becomes necessary to maintain separate table lists, changes will be required.\r
958 //\r
959 CurrentRsdtEntry = (UINT32 *)\r
da935a5c 960 (\r
961 (UINT8 *) AcpiTableInstance->Rsdt3 +\r
962 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
963 AcpiTableInstance->NumberOfTableEntries3 *\r
964 sizeof (UINT32)\r
965 );\r
f9bbb8d9 966 }\r
da935a5c 967\r
f9bbb8d9
AB
968 //\r
969 // This pointer must not be directly dereferenced as the XSDT entries may not\r
970 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
971 //\r
972 CurrentXsdtEntry = (VOID *)\r
973 (\r
974 (UINT8 *) AcpiTableInstance->Xsdt +\r
975 sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
976 AcpiTableInstance->NumberOfTableEntries3 *\r
977 sizeof (UINT64)\r
978 );\r
da935a5c 979\r
f9bbb8d9
AB
980 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
981 //\r
982 // Add entry to the RSDT\r
983 //\r
984 *CurrentRsdtEntry = (UINT32) (UINTN) CurrentTableList->Table;\r
985\r
986 //\r
987 // Update RSDT length\r
988 //\r
989 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof (UINT32);\r
990 }\r
da935a5c 991\r
f9bbb8d9
AB
992 //\r
993 // Add entry to XSDT, XSDT expects 64 bit pointers, but\r
994 // the table pointers in XSDT are not aligned on 8 byte boundary.\r
995 //\r
996 Buffer64 = (UINT64) (UINTN) CurrentTableList->Table;\r
997 CopyMem (\r
998 CurrentXsdtEntry,\r
999 &Buffer64,\r
1000 sizeof (UINT64)\r
1001 );\r
da935a5c 1002\r
f9bbb8d9
AB
1003 //\r
1004 // Update length\r
1005 //\r
1006 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof (UINT64);\r
1007\r
1008 AcpiTableInstance->NumberOfTableEntries3++;\r
5f55c700 1009 }\r
5f55c700 1010 }\r
1011\r
1012 ChecksumCommonTables (AcpiTableInstance);\r
1013 return EFI_SUCCESS;\r
1014}\r
1015\r
1016\r
1017/**\r
1018 This function finds the table specified by the handle and returns a pointer to it.\r
1019 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are\r
1020 undefined.\r
1021\r
1022 @param Handle Table to find.\r
1023 @param TableList Table list to search\r
1024 @param Table Pointer to table found. \r
1025\r
1026 @return EFI_SUCCESS The function completed successfully.\r
1027 @return EFI_NOT_FOUND No table found matching the handle specified.\r
1028\r
1029**/\r
1030EFI_STATUS\r
1031FindTableByHandle (\r
1032 IN UINTN Handle,\r
1033 IN LIST_ENTRY *TableList,\r
1034 OUT EFI_ACPI_TABLE_LIST **Table\r
1035 )\r
1036{\r
1037 LIST_ENTRY *CurrentLink;\r
1038 EFI_ACPI_TABLE_LIST *CurrentTable;\r
1039\r
1040 //\r
1041 // Check for invalid input parameters\r
1042 //\r
1043 ASSERT (Table);\r
1044\r
1045 //\r
1046 // Find the table\r
1047 //\r
1048 CurrentLink = TableList->ForwardLink;\r
1049\r
1050 while (CurrentLink != TableList) {\r
1051 CurrentTable = EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink);\r
1052 if (CurrentTable->Handle == Handle) {\r
1053 //\r
1054 // Found handle, so return this table.\r
1055 //\r
1056 *Table = CurrentTable;\r
1057 return EFI_SUCCESS;\r
1058 }\r
1059\r
1060 CurrentLink = CurrentLink->ForwardLink;\r
1061 }\r
1062 //\r
1063 // Table not found\r
1064 //\r
1065 return EFI_NOT_FOUND;\r
1066}\r
1067\r
1068\r
1069/**\r
1070 This function removes a basic table from the RSDT and/or XSDT.\r
1071 For Acpi 1.0 tables, pass in the Rsdt.\r
1072 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.\r
1073\r
1074 @param Table Pointer to table found. \r
1075 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT\r
1076 @param Rsdt Pointer to the RSDT to remove from\r
1077 @param Xsdt Pointer to the Xsdt to remove from\r
1078\r
1079 @return EFI_SUCCESS The function completed successfully.\r
1080 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.\r
1081\r
1082**/\r
1083EFI_STATUS\r
1084RemoveTableFromRsdt (\r
1085 IN OUT EFI_ACPI_TABLE_LIST * Table,\r
1086 IN OUT UINTN *NumberOfTableEntries,\r
f9bbb8d9 1087 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Rsdt OPTIONAL,\r
5f55c700 1088 IN OUT EFI_ACPI_DESCRIPTION_HEADER * Xsdt OPTIONAL\r
1089 )\r
1090{\r
1091 UINT32 *CurrentRsdtEntry;\r
1092 VOID *CurrentXsdtEntry;\r
1093 UINT64 CurrentTablePointer64;\r
1094 UINTN Index;\r
1095\r
1096 //\r
1097 // Check for invalid input parameters\r
1098 //\r
1099 ASSERT (Table);\r
1100 ASSERT (NumberOfTableEntries);\r
f9bbb8d9 1101 ASSERT (Rsdt || Xsdt);\r
5f55c700 1102\r
1103 //\r
1104 // Find the table entry in the RSDT and XSDT\r
1105 //\r
1106 for (Index = 0; Index < *NumberOfTableEntries; Index++) {\r
1107 //\r
1108 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.\r
1109 // If it becomes necessary to maintain separate table lists, changes will be required.\r
1110 //\r
f9bbb8d9
AB
1111 if (Rsdt != NULL) {\r
1112 CurrentRsdtEntry = (UINT32 *) ((UINT8 *) Rsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT32));\r
1113 } else {\r
1114 CurrentRsdtEntry = NULL;\r
1115 }\r
5f55c700 1116 if (Xsdt != NULL) {\r
1117 //\r
1118 // This pointer must not be directly dereferenced as the XSDT entries may not\r
1119 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.\r
1120 //\r
1121 CurrentXsdtEntry = (VOID *) ((UINT8 *) Xsdt + sizeof (EFI_ACPI_DESCRIPTION_HEADER) + Index * sizeof (UINT64));\r
1122\r
1123 //\r
1124 // Read the entry value out of the XSDT\r
1125 //\r
1126 CopyMem (&CurrentTablePointer64, CurrentXsdtEntry, sizeof (UINT64));\r
1127 } else {\r
1128 //\r
1129 // Initialize to NULL\r
1130 //\r
1131 CurrentXsdtEntry = 0;\r
1132 CurrentTablePointer64 = 0;\r
1133 }\r
1134 //\r
1135 // Check if we have found the corresponding entry in both RSDT and XSDT\r
1136 //\r
f9bbb8d9 1137 if ((CurrentRsdtEntry == NULL || *CurrentRsdtEntry == (UINT32) (UINTN) Table->Table) &&\r
5f55c700 1138 ((Xsdt == NULL) || CurrentTablePointer64 == (UINT64) (UINTN) Table->Table)\r
1139 ) {\r
1140 //\r
1141 // Found entry, so copy all following entries and shrink table\r
1142 // We actually copy all + 1 to copy the initialized value of memory over\r
1143 // the last entry.\r
1144 //\r
f9bbb8d9
AB
1145 if (Rsdt != NULL) {\r
1146 CopyMem (CurrentRsdtEntry, CurrentRsdtEntry + 1, (*NumberOfTableEntries - Index) * sizeof (UINT32));\r
1147 Rsdt->Length = Rsdt->Length - sizeof (UINT32);\r
1148 }\r
5f55c700 1149 if (Xsdt != NULL) {\r
1150 CopyMem (CurrentXsdtEntry, ((UINT64 *) CurrentXsdtEntry) + 1, (*NumberOfTableEntries - Index) * sizeof (UINT64));\r
1151 Xsdt->Length = Xsdt->Length - sizeof (UINT64);\r
1152 }\r
1153 break;\r
1154 } else if (Index + 1 == *NumberOfTableEntries) {\r
1155 //\r
1156 // At the last entry, and table not found\r
1157 //\r
1158 return EFI_INVALID_PARAMETER;\r
1159 }\r
1160 }\r
1161 //\r
1162 // Checksum the tables\r
1163 //\r
f9bbb8d9
AB
1164 if (Rsdt != NULL) {\r
1165 AcpiPlatformChecksum (\r
1166 Rsdt,\r
1167 Rsdt->Length,\r
1168 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1169 Checksum)\r
1170 );\r
1171 }\r
5f55c700 1172\r
1173 if (Xsdt != NULL) {\r
1174 AcpiPlatformChecksum (\r
1175 Xsdt,\r
1176 Xsdt->Length,\r
1177 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1178 Checksum)\r
1179 );\r
1180 }\r
1181 //\r
1182 // Decrement the number of tables\r
1183 //\r
1184 (*NumberOfTableEntries)--;\r
1185\r
1186 return EFI_SUCCESS;\r
1187}\r
1188\r
1189\r
1190/**\r
1191 This function removes a table and frees any associated memory.\r
1192\r
1193 @param AcpiTableInstance Instance of the protocol.\r
1194 @param Version Version(s) to delete.\r
1195 @param Table Pointer to table found.\r
1196\r
1197 @return EFI_SUCCESS The function completed successfully.\r
1198\r
1199**/\r
1200EFI_STATUS\r
1201DeleteTable (\r
1202 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1203 IN EFI_ACPI_TABLE_VERSION Version,\r
1204 IN OUT EFI_ACPI_TABLE_LIST *Table\r
1205 )\r
1206{\r
1207 UINT32 CurrentTableSignature;\r
1208 BOOLEAN RemoveFromRsdt;\r
1209\r
1210 //\r
1211 // Check for invalid input parameters\r
1212 //\r
1213 ASSERT (AcpiTableInstance);\r
1214 ASSERT (Table);\r
1215\r
1216 //\r
1217 // Init locals\r
1218 //\r
1219 RemoveFromRsdt = TRUE;\r
6198c346 1220 //\r
1221 // Check for Table->Table\r
1222 //\r
1223 ASSERT (Table->Table != NULL);\r
5f55c700 1224 CurrentTableSignature = ((EFI_ACPI_COMMON_HEADER *) Table->Table)->Signature;\r
1225\r
1226 //\r
1227 // Basic tasks to accomplish delete are:\r
1228 // Determine removal requirements (in RSDT/XSDT or not)\r
1229 // Remove entry from RSDT/XSDT\r
1230 // Remove any table references to the table\r
1231 // If no one is using the table\r
1232 // Free the table (removing pointers from private data and tables)\r
1233 // Remove from list\r
1234 // Free list structure\r
1235 //\r
1236 //\r
1237 // Determine if this table is in the RSDT or XSDT\r
1238 //\r
1239 if ((CurrentTableSignature == EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
1240 (CurrentTableSignature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) ||\r
1241 (CurrentTableSignature == EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE)\r
1242 ) {\r
1243 RemoveFromRsdt = FALSE;\r
1244 }\r
1245 //\r
1246 // We don't remove the FADT in the standard way because some\r
1247 // OS expect the FADT to be early in the table list.\r
1248 // So we always put it as the first element in the list.\r
1249 //\r
1250 if (CurrentTableSignature == EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) {\r
1251 RemoveFromRsdt = FALSE;\r
1252 }\r
1253\r
1254 //\r
1255 // Remove the table from RSDT and XSDT\r
1256 //\r
1257 if (Table->Table != NULL) {\r
1258 //\r
1259 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt\r
1260 //\r
1261 if (Version & EFI_ACPI_TABLE_VERSION_NONE & Table->Version) {\r
1262 //\r
1263 // Remove this version from the table\r
1264 //\r
1265 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_NONE;\r
1266 }\r
1267\r
1268 if (Version & EFI_ACPI_TABLE_VERSION_1_0B & Table->Version) {\r
1269 //\r
1270 // Remove this version from the table\r
1271 //\r
1272 Table->Version = Table->Version &~EFI_ACPI_TABLE_VERSION_1_0B;\r
1273\r
1274 //\r
1275 // Remove from Rsdt. We don't care about the return value because it is\r
1276 // acceptable for the table to not exist in Rsdt.\r
1277 // We didn't add some tables so we don't remove them.\r
1278 //\r
1279 if (RemoveFromRsdt) {\r
1280 RemoveTableFromRsdt (\r
1281 Table,\r
1282 &AcpiTableInstance->NumberOfTableEntries1,\r
1283 AcpiTableInstance->Rsdt1,\r
1284 NULL\r
1285 );\r
1286 }\r
1287 }\r
1288\r
f0071740 1289 if (Version & ACPI_TABLE_VERSION_GTE_2_0 & Table->Version) {\r
5f55c700 1290 //\r
1291 // Remove this version from the table\r
1292 //\r
f0071740 1293 Table->Version = Table->Version &~(Version & ACPI_TABLE_VERSION_GTE_2_0);\r
5f55c700 1294 \r
1295 //\r
1296 // Remove from Rsdt and Xsdt. We don't care about the return value\r
1297 // because it is acceptable for the table to not exist in Rsdt/Xsdt.\r
1298 // We didn't add some tables so we don't remove them.\r
1299 //\r
1300 if (RemoveFromRsdt) {\r
1301 RemoveTableFromRsdt (\r
1302 Table,\r
1303 &AcpiTableInstance->NumberOfTableEntries3,\r
1304 AcpiTableInstance->Rsdt3,\r
1305 AcpiTableInstance->Xsdt\r
1306 );\r
1307 }\r
1308 } \r
1309 //\r
1310 // Free the table, clean up any dependent tables and our private data pointers.\r
1311 //\r
1312 switch (Table->Table->Signature) {\r
1313\r
1314 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE:\r
1315 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1316 AcpiTableInstance->Fadt1 = NULL;\r
1317 }\r
1318\r
f0071740 1319 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1320 AcpiTableInstance->Fadt3 = NULL;\r
1321 }\r
1322 break;\r
1323\r
1324 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE:\r
1325 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1326 AcpiTableInstance->Facs1 = NULL;\r
1327\r
1328 //\r
1329 // Update FADT table pointers\r
1330 //\r
1331 if (AcpiTableInstance->Fadt1 != NULL) {\r
1332 AcpiTableInstance->Fadt1->FirmwareCtrl = 0;\r
1333\r
1334 //\r
1335 // Checksum table\r
1336 //\r
1337 AcpiPlatformChecksum (\r
1338 AcpiTableInstance->Fadt1,\r
1339 AcpiTableInstance->Fadt1->Header.Length,\r
1340 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1341 Checksum)\r
1342 );\r
1343 }\r
1344 }\r
1345\r
f0071740 1346 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1347 AcpiTableInstance->Facs3 = NULL;\r
1348\r
1349 //\r
1350 // Update FADT table pointers\r
1351 //\r
1352 if (AcpiTableInstance->Fadt3 != NULL) {\r
1353 AcpiTableInstance->Fadt3->FirmwareCtrl = 0;\r
1354 ZeroMem (&AcpiTableInstance->Fadt3->XFirmwareCtrl, sizeof (UINT64));\r
1355\r
1356 //\r
1357 // Checksum table\r
1358 //\r
1359 AcpiPlatformChecksum (\r
1360 AcpiTableInstance->Fadt3,\r
1361 AcpiTableInstance->Fadt3->Header.Length,\r
1362 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1363 Checksum)\r
1364 );\r
1365 }\r
1366 } \r
1367 break;\r
1368\r
1369 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
1370 if ((Version & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1371 AcpiTableInstance->Dsdt1 = NULL;\r
1372\r
1373 //\r
1374 // Update FADT table pointers\r
1375 //\r
1376 if (AcpiTableInstance->Fadt1 != NULL) {\r
1377 AcpiTableInstance->Fadt1->Dsdt = 0;\r
1378\r
1379 //\r
1380 // Checksum table\r
1381 //\r
1382 AcpiPlatformChecksum (\r
1383 AcpiTableInstance->Fadt1,\r
1384 AcpiTableInstance->Fadt1->Header.Length,\r
1385 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1386 Checksum)\r
1387 );\r
1388 }\r
1389 }\r
1390\r
1391 \r
f0071740 1392 if ((Version & ACPI_TABLE_VERSION_GTE_2_0) != 0) {\r
5f55c700 1393 AcpiTableInstance->Dsdt3 = NULL;\r
1394\r
1395 //\r
1396 // Update FADT table pointers\r
1397 //\r
1398 if (AcpiTableInstance->Fadt3 != NULL) {\r
1399 AcpiTableInstance->Fadt3->Dsdt = 0;\r
1400 ZeroMem (&AcpiTableInstance->Fadt3->XDsdt, 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 default:\r
1416 //\r
1417 // Do nothing\r
1418 //\r
1419 break;\r
1420 }\r
1421 }\r
1422 //\r
1423 // If no version is using this table anymore, remove and free list entry.\r
1424 //\r
1425 if (Table->Version == 0) {\r
1426 //\r
1427 // Free the Table\r
1428 //\r
1429 gBS->FreePages (Table->PageAddress, Table->NumberOfPages);\r
1430 RemoveEntryList (&(Table->Link));\r
1431 gBS->FreePool (Table);\r
1432 }\r
1433 //\r
1434 // Done\r
1435 //\r
1436 return EFI_SUCCESS;\r
1437}\r
1438\r
1439\r
1440/**\r
1441 This function finds and removes the table specified by the handle.\r
1442\r
1443 @param AcpiTableInstance Instance of the protocol.\r
1444 @param Version Bitmask of which versions to remove.\r
1445 @param Handle Table to remove.\r
1446\r
1447 @return EFI_SUCCESS The function completed successfully.\r
1448 @return EFI_ABORTED An error occurred.\r
1449 @return EFI_NOT_FOUND Handle not found in table list.\r
1450\r
1451**/\r
1452EFI_STATUS\r
1453RemoveTableFromList (\r
1454 IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,\r
1455 IN EFI_ACPI_TABLE_VERSION Version,\r
1456 IN UINTN Handle\r
1457 )\r
1458{\r
1459 EFI_ACPI_TABLE_LIST *Table;\r
1460 EFI_STATUS Status;\r
1461\r
b474ed49 1462 Table = (EFI_ACPI_TABLE_LIST*) NULL;\r
1463\r
5f55c700 1464 //\r
1465 // Check for invalid input parameters\r
1466 //\r
1467 ASSERT (AcpiTableInstance);\r
1468\r
1469 //\r
1470 // Find the table\r
1471 //\r
1472 Status = FindTableByHandle (\r
1473 Handle,\r
1474 &AcpiTableInstance->TableList,\r
1475 &Table\r
1476 );\r
1477 if (EFI_ERROR (Status)) {\r
1478 return EFI_NOT_FOUND;\r
1479 }\r
1480 //\r
1481 // Remove the table\r
1482 //\r
1483 Status = DeleteTable (AcpiTableInstance, Version, Table);\r
1484 if (EFI_ERROR (Status)) {\r
1485 return EFI_ABORTED;\r
1486 }\r
1487 //\r
1488 // Completed successfully\r
1489 //\r
1490 return EFI_SUCCESS;\r
1491}\r
1492\r
1493\r
1494/**\r
1495 This function calculates and updates an UINT8 checksum.\r
1496\r
1497 @param Buffer Pointer to buffer to checksum\r
1498 @param Size Number of bytes to checksum\r
1499 @param ChecksumOffset Offset to place the checksum result in\r
1500\r
1501 @return EFI_SUCCESS The function completed successfully.\r
1502\r
1503**/\r
1504EFI_STATUS\r
1505AcpiPlatformChecksum (\r
1506 IN VOID *Buffer,\r
1507 IN UINTN Size,\r
1508 IN UINTN ChecksumOffset\r
1509 )\r
1510{\r
1511 UINT8 Sum;\r
1512 UINT8 *Ptr;\r
1513\r
1514 Sum = 0;\r
1515 //\r
1516 // Initialize pointer\r
1517 //\r
1518 Ptr = Buffer;\r
1519\r
1520 //\r
1521 // set checksum to 0 first\r
1522 //\r
1523 Ptr[ChecksumOffset] = 0;\r
1524\r
1525 //\r
1526 // add all content of buffer\r
1527 //\r
1528 while ((Size--) != 0) {\r
1529 Sum = (UINT8) (Sum + (*Ptr++));\r
1530 }\r
1531 //\r
1532 // set checksum\r
1533 //\r
1534 Ptr = Buffer;\r
1535 Ptr[ChecksumOffset] = (UINT8) (0xff - Sum + 1);\r
1536\r
1537 return EFI_SUCCESS;\r
1538}\r
1539\r
1540\r
1541/**\r
1542 Checksum all versions of the common tables, RSDP, RSDT, XSDT.\r
1543\r
1544 @param AcpiTableInstance Protocol instance private data.\r
1545\r
1546 @return EFI_SUCCESS The function completed successfully.\r
1547\r
1548**/\r
1549EFI_STATUS\r
1550ChecksumCommonTables (\r
1551 IN OUT EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1552 )\r
1553{\r
1554 //\r
1555 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure\r
1556 //\r
f9bbb8d9
AB
1557 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1558 AcpiPlatformChecksum (\r
1559 AcpiTableInstance->Rsdp1,\r
1560 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1561 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1562 Checksum)\r
1563 );\r
1564 }\r
5f55c700 1565\r
1566 //\r
1567 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure\r
1568 //\r
1569 AcpiPlatformChecksum (\r
1570 AcpiTableInstance->Rsdp3,\r
1571 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1572 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1573 Checksum)\r
1574 );\r
1575\r
1576 //\r
1577 // RSDP ACPI 2.0/3.0 checksum, this is the entire table\r
1578 //\r
1579 AcpiPlatformChecksum (\r
1580 AcpiTableInstance->Rsdp3,\r
1581 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER),\r
1582 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER,\r
1583 ExtendedChecksum)\r
1584 );\r
1585\r
f9bbb8d9
AB
1586 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1587 //\r
1588 // RSDT checksums\r
1589 //\r
1590 AcpiPlatformChecksum (\r
1591 AcpiTableInstance->Rsdt1,\r
1592 AcpiTableInstance->Rsdt1->Length,\r
1593 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1594 Checksum)\r
1595 );\r
5f55c700 1596\r
f9bbb8d9
AB
1597 AcpiPlatformChecksum (\r
1598 AcpiTableInstance->Rsdt3,\r
1599 AcpiTableInstance->Rsdt3->Length,\r
1600 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1601 Checksum)\r
1602 );\r
1603 }\r
5f55c700 1604\r
1605 //\r
1606 // XSDT checksum\r
1607 //\r
1608 AcpiPlatformChecksum (\r
1609 AcpiTableInstance->Xsdt,\r
1610 AcpiTableInstance->Xsdt->Length,\r
1611 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER,\r
1612 Checksum)\r
1613 );\r
1614 \r
1615 return EFI_SUCCESS;\r
1616}\r
1617\r
1618\r
1619/**\r
1620 Constructor for the ACPI table protocol. Initializes instance\r
1621 data.\r
1622\r
1623 @param AcpiTableInstance Instance to construct\r
1624\r
1625 @return EFI_SUCCESS Instance initialized.\r
1626 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.\r
1627\r
1628**/\r
1629EFI_STATUS\r
1630AcpiTableAcpiTableConstructor (\r
1631 EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance\r
1632 )\r
1633{\r
1634 EFI_STATUS Status;\r
1635 UINT64 CurrentData;\r
1636 UINTN TotalSize;\r
37abfb7e 1637 UINTN RsdpTableSize;\r
5f55c700 1638 UINT8 *Pointer;\r
1639 EFI_PHYSICAL_ADDRESS PageAddress;\r
1640\r
1641 //\r
1642 // Check for invalid input parameters\r
1643 //\r
1644 ASSERT (AcpiTableInstance);\r
1645\r
f9bbb8d9
AB
1646 //\r
1647 // If ACPI v1.0b is among the ACPI versions we aim to support, we have to\r
1648 // ensure that all memory allocations are below 4 GB.\r
1649 //\r
1650 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1651 mAcpiTableAllocType = AllocateMaxAddress;\r
1652 } else {\r
1653 mAcpiTableAllocType = AllocateAnyPages;\r
1654 }\r
1655\r
5f55c700 1656 InitializeListHead (&AcpiTableInstance->TableList);\r
1657 AcpiTableInstance->CurrentHandle = 1;\r
1658\r
1659 AcpiTableInstance->AcpiTableProtocol.InstallAcpiTable = InstallAcpiTable;\r
1660 AcpiTableInstance->AcpiTableProtocol.UninstallAcpiTable = UninstallAcpiTable;\r
3dc8585e
JY
1661\r
1662 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol)) {\r
1663 SdtAcpiTableAcpiSdtConstructor (AcpiTableInstance);\r
1664 }\r
1665\r
5f55c700 1666 //\r
37abfb7e
LG
1667 // Create RSDP table\r
1668 //\r
f9bbb8d9
AB
1669 RsdpTableSize = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1670 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1671 RsdpTableSize += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1672 }\r
37abfb7e
LG
1673\r
1674 PageAddress = 0xFFFFFFFF;\r
1675 Status = gBS->AllocatePages (\r
f9bbb8d9 1676 mAcpiTableAllocType,\r
37abfb7e
LG
1677 EfiACPIReclaimMemory,\r
1678 EFI_SIZE_TO_PAGES (RsdpTableSize),\r
1679 &PageAddress\r
1680 );\r
1681\r
1682 if (EFI_ERROR (Status)) {\r
1683 return EFI_OUT_OF_RESOURCES;\r
1684 }\r
1685\r
1686 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1687 ZeroMem (Pointer, RsdpTableSize);\r
1688\r
1689 AcpiTableInstance->Rsdp1 = (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
f9bbb8d9
AB
1690 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1691 Pointer += sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
1692 }\r
37abfb7e
LG
1693 AcpiTableInstance->Rsdp3 = (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *) Pointer;\r
1694\r
1695 //\r
1696 // Create RSDT, XSDT structures\r
5f55c700 1697 //\r
f9bbb8d9 1698 TotalSize = sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 XSDT\r
37abfb7e 1699 mEfiAcpiMaxNumTables * sizeof (UINT64);\r
5f55c700 1700\r
f9bbb8d9
AB
1701 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1702 TotalSize += sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 1.0 RSDT\r
1703 mEfiAcpiMaxNumTables * sizeof (UINT32) +\r
1704 sizeof (EFI_ACPI_DESCRIPTION_HEADER) + // for ACPI 2.0/3.0 RSDT\r
1705 mEfiAcpiMaxNumTables * sizeof (UINT32);\r
1706 }\r
1707\r
5f55c700 1708 //\r
1709 // Allocate memory in the lower 32 bit of address range for\r
1710 // compatibility with ACPI 1.0 OS.\r
1711 //\r
1712 // This is done because ACPI 1.0 pointers are 32 bit values.\r
1713 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.\r
1714 // There is no architectural reason these should be below 4GB, it is purely\r
1715 // for convenience of implementation that we force memory below 4GB.\r
1716 //\r
1717 PageAddress = 0xFFFFFFFF;\r
1718 Status = gBS->AllocatePages (\r
f9bbb8d9 1719 mAcpiTableAllocType,\r
5f55c700 1720 EfiACPIReclaimMemory,\r
1721 EFI_SIZE_TO_PAGES (TotalSize),\r
1722 &PageAddress\r
1723 );\r
1724\r
1725 if (EFI_ERROR (Status)) {\r
37abfb7e 1726 gBS->FreePages ((EFI_PHYSICAL_ADDRESS)(UINTN)AcpiTableInstance->Rsdp1, EFI_SIZE_TO_PAGES (RsdpTableSize));\r
5f55c700 1727 return EFI_OUT_OF_RESOURCES;\r
1728 }\r
1729\r
1730 Pointer = (UINT8 *) (UINTN) PageAddress;\r
1731 ZeroMem (Pointer, TotalSize);\r
1732\r
5f55c700 1733 AcpiTableInstance->Rsdt1 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
f9bbb8d9
AB
1734 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1735 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
1736 AcpiTableInstance->Rsdt3 = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1737 Pointer += (sizeof (EFI_ACPI_DESCRIPTION_HEADER) + EFI_ACPI_MAX_NUM_TABLES * sizeof (UINT32));\r
1738 }\r
5f55c700 1739 AcpiTableInstance->Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *) Pointer;\r
1740\r
1741 //\r
1742 // Initialize RSDP\r
1743 //\r
f9bbb8d9
AB
1744 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1745 CurrentData = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1746 CopyMem (&AcpiTableInstance->Rsdp1->Signature, &CurrentData, sizeof (UINT64));\r
1747 CopyMem (AcpiTableInstance->Rsdp1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp1->OemId));\r
1748 AcpiTableInstance->Rsdp1->Reserved = EFI_ACPI_RESERVED_BYTE;\r
1749 AcpiTableInstance->Rsdp1->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt1;\r
1750 }\r
5f55c700 1751\r
1752 CurrentData = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE;\r
1753 CopyMem (&AcpiTableInstance->Rsdp3->Signature, &CurrentData, sizeof (UINT64));\r
e84f07b5 1754 CopyMem (AcpiTableInstance->Rsdp3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdp3->OemId));\r
5f55c700 1755 AcpiTableInstance->Rsdp3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION;\r
5f55c700 1756 AcpiTableInstance->Rsdp3->Length = sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER);\r
f9bbb8d9
AB
1757 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1758 AcpiTableInstance->Rsdp3->RsdtAddress = (UINT32) (UINTN) AcpiTableInstance->Rsdt3;\r
1759 }\r
5f55c700 1760 CurrentData = (UINT64) (UINTN) AcpiTableInstance->Xsdt;\r
1761 CopyMem (&AcpiTableInstance->Rsdp3->XsdtAddress, &CurrentData, sizeof (UINT64));\r
1762 SetMem (AcpiTableInstance->Rsdp3->Reserved, 3, EFI_ACPI_RESERVED_BYTE);\r
1763\r
f9bbb8d9
AB
1764 if ((PcdGet32 (PcdAcpiExposedTableVersions) & EFI_ACPI_TABLE_VERSION_1_0B) != 0) {\r
1765 //\r
1766 // Initialize Rsdt\r
1767 //\r
1768 // Note that we "reserve" one entry for the FADT so it can always be\r
1769 // at the beginning of the list of tables. Some OS don't seem\r
1770 // to find it correctly if it is too far down the list.\r
1771 //\r
1772 AcpiTableInstance->Rsdt1->Signature = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1773 AcpiTableInstance->Rsdt1->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1774 AcpiTableInstance->Rsdt1->Revision = EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1775 CopyMem (AcpiTableInstance->Rsdt1->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt1->OemId));\r
1776 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
1777 CopyMem (&AcpiTableInstance->Rsdt1->OemTableId, &CurrentData, sizeof (UINT64));\r
1778 AcpiTableInstance->Rsdt1->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1779 AcpiTableInstance->Rsdt1->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1780 AcpiTableInstance->Rsdt1->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
1781 //\r
1782 // We always reserve first one for FADT\r
1783 //\r
1784 AcpiTableInstance->NumberOfTableEntries1 = 1;\r
1785 AcpiTableInstance->Rsdt1->Length = AcpiTableInstance->Rsdt1->Length + sizeof(UINT32);\r
1786\r
1787 AcpiTableInstance->Rsdt3->Signature = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1788 AcpiTableInstance->Rsdt3->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1789 AcpiTableInstance->Rsdt3->Revision = EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
1790 CopyMem (AcpiTableInstance->Rsdt3->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Rsdt3->OemId));\r
1791 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
1792 CopyMem (&AcpiTableInstance->Rsdt3->OemTableId, &CurrentData, sizeof (UINT64));\r
1793 AcpiTableInstance->Rsdt3->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1794 AcpiTableInstance->Rsdt3->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1795 AcpiTableInstance->Rsdt3->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
1796 //\r
1797 // We always reserve first one for FADT\r
1798 //\r
1799 AcpiTableInstance->Rsdt3->Length = AcpiTableInstance->Rsdt3->Length + sizeof(UINT32);\r
1800 }\r
5f55c700 1801 AcpiTableInstance->NumberOfTableEntries3 = 1;\r
5f55c700 1802\r
1803 //\r
1804 // Initialize Xsdt\r
1805 //\r
1806 AcpiTableInstance->Xsdt->Signature = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE;\r
1807 AcpiTableInstance->Xsdt->Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
1808 AcpiTableInstance->Xsdt->Revision = EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION;\r
e84f07b5
SZ
1809 CopyMem (AcpiTableInstance->Xsdt->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (AcpiTableInstance->Xsdt->OemId));\r
1810 CurrentData = PcdGet64 (PcdAcpiDefaultOemTableId);\r
5f55c700 1811 CopyMem (&AcpiTableInstance->Xsdt->OemTableId, &CurrentData, sizeof (UINT64));\r
e84f07b5
SZ
1812 AcpiTableInstance->Xsdt->OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r
1813 AcpiTableInstance->Xsdt->CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r
1814 AcpiTableInstance->Xsdt->CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r
5f55c700 1815 //\r
1816 // We always reserve first one for FADT\r
1817 //\r
1818 AcpiTableInstance->Xsdt->Length = AcpiTableInstance->Xsdt->Length + sizeof(UINT64);\r
1819\r
1820 ChecksumCommonTables (AcpiTableInstance);\r
1821\r
1822 //\r
1823 // Completed successfully\r
1824 //\r
1825 return EFI_SUCCESS;\r
1826}\r
1827\r