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