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