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