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