2 ACPI Table Protocol Implementation
4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include "AcpiTable.h"
20 // The maximum number of tables that pre-allocated.
22 UINTN mEfiAcpiMaxNumTables
= EFI_ACPI_MAX_NUM_TABLES
;
25 This function adds an ACPI table to the table list. It will detect FACS and
26 allocate the correct type of memory and properly align the table.
28 @param AcpiTableInstance Instance of the protocol.
29 @param Table Table to add.
30 @param Checksum Does the table require checksumming.
31 @param Version The version of the list to add the table to.
32 @param Handle Pointer for returning the handle.
34 @return EFI_SUCCESS The function completed successfully.
35 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
36 @return EFI_ABORTED The table is a duplicate of a table that is required
42 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
45 IN EFI_ACPI_TABLE_VERSION Version
,
50 This function finds and removes the table specified by the handle.
52 @param AcpiTableInstance Instance of the protocol.
53 @param Version Bitmask of which versions to remove.
54 @param Handle Table to remove.
56 @return EFI_SUCCESS The function completed successfully.
57 @return EFI_ABORTED An error occurred.
58 @return EFI_NOT_FOUND Handle not found in table list.
63 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
64 IN EFI_ACPI_TABLE_VERSION Version
,
69 This function calculates and updates an UINT8 checksum.
71 @param Buffer Pointer to buffer to checksum
72 @param Size Number of bytes to checksum
73 @param ChecksumOffset Offset to place the checksum result in
75 @return EFI_SUCCESS The function completed successfully.
78 AcpiPlatformChecksum (
81 IN UINTN ChecksumOffset
85 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
87 @param AcpiTableInstance Protocol instance private data.
89 @return EFI_SUCCESS The function completed successfully.
93 ChecksumCommonTables (
94 IN OUT EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
98 // Protocol function implementations.
102 This function adds, removes, or updates ACPI tables. If the address is not
103 null and the handle value is null, the table is added. If both the address and
104 handle are not null, the table at handle is updated with the table at address.
105 If the address is null and the handle is not, the table at handle is deleted.
107 @param AcpiTableInstance Instance of the protocol.
108 @param Table Pointer to a table.
109 @param Checksum Boolean indicating if the checksum should be calculated.
110 @param Version Version(s) to set.
111 @param Handle Handle of the table.
113 @return EFI_SUCCESS The function completed successfully.
114 @return EFI_INVALID_PARAMETER Both the Table and *Handle were NULL.
115 @return EFI_ABORTED Could not complete the desired request.
121 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
122 IN VOID
*Table OPTIONAL
,
124 IN EFI_ACPI_TABLE_VERSION Version
,
132 // Check for invalid input parameters
140 // Determine desired action
145 // Invalid parameter combination
147 return EFI_INVALID_PARAMETER
;
152 Status
= AddTableToList (AcpiTableInstance
, Table
, Checksum
, Version
, Handle
);
160 // Delete the table list entry
162 Status
= RemoveTableFromList (AcpiTableInstance
, Version
, *Handle
);
163 if (EFI_ERROR (Status
)) {
165 // Should not get an error here ever, but abort if we do.
170 // Set the handle to replace the table at the same handle
172 SavedHandle
= AcpiTableInstance
->CurrentHandle
;
173 AcpiTableInstance
->CurrentHandle
= *Handle
;
178 Status
= AddTableToList (AcpiTableInstance
, Table
, Checksum
, Version
, Handle
);
181 // Restore the saved current handle
183 AcpiTableInstance
->CurrentHandle
= SavedHandle
;
188 Status
= RemoveTableFromList (AcpiTableInstance
, Version
, *Handle
);
192 if (EFI_ERROR (Status
)) {
194 // Should not get an error here ever, but abort if we do.
205 This function publishes the specified versions of the ACPI tables by
206 installing EFI configuration table entries for them. Any combination of
207 table versions can be published.
209 @param AcpiTableInstance Instance of the protocol.
210 @param Version Version(s) to publish.
212 @return EFI_SUCCESS The function completed successfully.
213 @return EFI_ABORTED The function could not complete successfully.
219 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
220 IN EFI_ACPI_TABLE_VERSION Version
224 UINT32
*CurrentRsdtEntry
;
225 VOID
*CurrentXsdtEntry
;
229 // Reorder tables as some operating systems don't seem to find the
230 // FADT correctly if it is not in the first few entries
234 // Add FADT as the first entry
236 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
237 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiTableInstance
->Rsdt1
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
238 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiTableInstance
->Fadt1
;
240 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
241 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
242 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiTableInstance
->Rsdt3
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
243 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiTableInstance
->Fadt3
;
244 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) AcpiTableInstance
->Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
246 // Add entry to XSDT, XSDT expects 64 bit pointers, but
247 // the table pointers in XSDT are not aligned on 8 byte boundary.
249 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Fadt3
;
258 // Do checksum again because Dsdt/Xsdt is updated.
260 ChecksumCommonTables (AcpiTableInstance
);
263 // Add the RSD_PTR to the system table and store that we have installed the
266 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) &&
267 !AcpiTableInstance
->TablesInstalled1
) {
268 Status
= gBS
->InstallConfigurationTable (&gEfiAcpi10TableGuid
, AcpiTableInstance
->Rsdp1
);
269 if (EFI_ERROR (Status
)) {
273 AcpiTableInstance
->TablesInstalled1
= TRUE
;
276 if (((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
277 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) &&
278 !AcpiTableInstance
->TablesInstalled3
) {
279 Status
= gBS
->InstallConfigurationTable (&gEfiAcpiTableGuid
, AcpiTableInstance
->Rsdp3
);
280 if (EFI_ERROR (Status
)) {
284 AcpiTableInstance
->TablesInstalled3
= TRUE
;
292 Installs an ACPI table into the RSDT/XSDT.
293 Note that the ACPI table should be checksumed before installing it.
294 Otherwise it will assert.
296 @param This Protocol instance pointer.
297 @param AcpiTableBuffer A pointer to a buffer containing the ACPI table to be installed.
298 @param AcpiTableBufferSize Specifies the size, in bytes, of the AcpiTableBuffer buffer.
299 @param TableKey Reurns a key to refer to the ACPI table.
301 @return EFI_SUCCESS The table was successfully inserted.
302 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize
303 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer
305 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.
311 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
312 IN CONST VOID
*AcpiTableBuffer
,
313 IN UINTN AcpiTableBufferSize
,
317 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
;
319 VOID
*AcpiTableBufferConst
;
324 // Check for invalid input parameters
326 if ((AcpiTableBuffer
== NULL
) || (TableKey
== NULL
)
327 || (((EFI_ACPI_DESCRIPTION_HEADER
*) AcpiTableBuffer
)->Length
!= AcpiTableBufferSize
)) {
328 return EFI_INVALID_PARAMETER
;
331 Length
= ((EFI_ACPI_COMMON_HEADER
*) AcpiTableBuffer
)->Length
;
332 Checksum
= CalculateCheckSum8 ((UINT8
*)AcpiTableBuffer
, Length
);
333 ASSERT (Checksum
== 0);
336 // Get the instance of the ACPI table protocol
338 AcpiTableInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This
);
341 // Install the ACPI table
343 AcpiTableBufferConst
= AllocateCopyPool (AcpiTableBufferSize
,AcpiTableBuffer
);
345 Status
= SetAcpiTable (
347 AcpiTableBufferConst
,
349 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
352 if (!EFI_ERROR (Status
)) {
353 Status
= PublishTables (
355 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
358 FreePool (AcpiTableBufferConst
);
365 Removes an ACPI table from the RSDT/XSDT.
367 @param This Protocol instance pointer.
368 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().
370 @return EFI_SUCCESS The table was successfully uninstalled.
371 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.
377 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
381 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
;
385 // Get the instance of the ACPI table protocol
387 AcpiTableInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This
);
390 // Uninstall the ACPI table
392 Status
= SetAcpiTable (
396 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
399 if (!EFI_ERROR (Status
)) {
400 Status
= PublishTables (
402 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
406 if (EFI_ERROR (Status
)) {
407 return EFI_NOT_FOUND
;
414 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.
416 @param AcpiTableInstance ACPI table protocol instance data structure.
418 @return EFI_SUCCESS reallocate the table beffer successfully.
419 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
423 ReallocateAcpiTableBuffer (
424 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
427 UINTN NewMaxTableNumber
;
430 EFI_PHYSICAL_ADDRESS PageAddress
;
431 EFI_ACPI_TABLE_INSTANCE TempPrivateData
;
435 CopyMem (&TempPrivateData
, AcpiTableInstance
, sizeof (EFI_ACPI_TABLE_INSTANCE
));
437 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES
439 NewMaxTableNumber
= mEfiAcpiMaxNumTables
+ EFI_ACPI_MAX_NUM_TABLES
;
441 // Create RSDP, RSDT, XSDT structures and allocate all buffers
443 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
444 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
445 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
446 NewMaxTableNumber
* sizeof (UINT32
) +
447 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
448 NewMaxTableNumber
* sizeof (UINT32
) +
449 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
450 NewMaxTableNumber
* sizeof (UINT64
);
453 // Allocate memory in the lower 32 bit of address range for
454 // compatibility with ACPI 1.0 OS.
456 // This is done because ACPI 1.0 pointers are 32 bit values.
457 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
458 // There is no architectural reason these should be below 4GB, it is purely
459 // for convenience of implementation that we force memory below 4GB.
461 PageAddress
= 0xFFFFFFFF;
462 Status
= gBS
->AllocatePages (
464 EfiACPIReclaimMemory
,
465 EFI_SIZE_TO_PAGES (TotalSize
),
469 if (EFI_ERROR (Status
)) {
470 return EFI_OUT_OF_RESOURCES
;
473 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
474 ZeroMem (Pointer
, TotalSize
);
476 AcpiTableInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
477 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
478 AcpiTableInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
479 Pointer
+= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
481 AcpiTableInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
482 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
483 AcpiTableInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
484 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
486 AcpiTableInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
491 CopyMem (AcpiTableInstance
->Rsdp1
, TempPrivateData
.Rsdp1
, sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
));
492 AcpiTableInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt1
;
494 CopyMem (AcpiTableInstance
->Rsdp3
, TempPrivateData
.Rsdp3
, sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
));
495 AcpiTableInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt3
;
496 CurrentData
= (UINT64
) (UINTN
) AcpiTableInstance
->Xsdt
;
497 CopyMem (&AcpiTableInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
500 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer
502 CopyMem (AcpiTableInstance
->Rsdt1
, TempPrivateData
.Rsdt1
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
503 CopyMem (AcpiTableInstance
->Rsdt3
, TempPrivateData
.Rsdt3
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
504 CopyMem (AcpiTableInstance
->Xsdt
, TempPrivateData
.Xsdt
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT64
)));
507 // Calculate orignal ACPI table buffer size
509 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
510 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
511 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
512 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
513 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
514 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
515 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
516 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
517 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)TempPrivateData
.Rsdp1
, EFI_SIZE_TO_PAGES (TotalSize
));
520 // Update the Max ACPI table number
522 mEfiAcpiMaxNumTables
= NewMaxTableNumber
;
526 This function adds an ACPI table to the table list. It will detect FACS and
527 allocate the correct type of memory and properly align the table.
529 @param AcpiTableInstance Instance of the protocol.
530 @param Table Table to add.
531 @param Checksum Does the table require checksumming.
532 @param Version The version of the list to add the table to.
533 @param Handle Pointer for returning the handle.
535 @return EFI_SUCCESS The function completed successfully.
536 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
537 @return EFI_ABORTED The table is a duplicate of a table that is required
543 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
546 IN EFI_ACPI_TABLE_VERSION Version
,
551 EFI_ACPI_TABLE_LIST
*CurrentTableList
;
552 UINT32 CurrentTableSignature
;
553 UINT32 CurrentTableSize
;
554 UINT32
*CurrentRsdtEntry
;
555 VOID
*CurrentXsdtEntry
;
560 // Check for invalid input parameters
562 ASSERT (AcpiTableInstance
);
572 // Create a new list entry
574 CurrentTableList
= AllocatePool (sizeof (EFI_ACPI_TABLE_LIST
));
575 ASSERT (CurrentTableList
);
578 // Determine table type and size
580 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Signature
;
581 CurrentTableSize
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Length
;
584 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space
585 // for backwards compatibility with ACPI 1.0 OS.
587 // This is done because ACPI 1.0 pointers are 32 bit values.
588 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
589 // There is no architectural reason these should be below 4GB, it is purely
590 // for convenience of implementation that we force memory below 4GB.
592 CurrentTableList
->PageAddress
= 0xFFFFFFFF;
593 CurrentTableList
->NumberOfPages
= EFI_SIZE_TO_PAGES (CurrentTableSize
);
596 // Allocation memory type depends on the type of the table
598 if (CurrentTableSignature
== EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
||
599 CurrentTableSignature
== EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) {
601 // Allocate memory for the FACS. This structure must be aligned
602 // on a 64 byte boundary and must be ACPI NVS memory.
603 // Using AllocatePages should ensure that it is always aligned.
605 ASSERT ((EFI_PAGE_SIZE
% 64) == 0);
606 Status
= gBS
->AllocatePages (
609 CurrentTableList
->NumberOfPages
,
610 &CurrentTableList
->PageAddress
614 // All other tables are ACPI reclaim memory, no alignment requirements.
616 Status
= gBS
->AllocatePages (
618 EfiACPIReclaimMemory
,
619 CurrentTableList
->NumberOfPages
,
620 &CurrentTableList
->PageAddress
624 // Check return value from memory alloc.
626 if (EFI_ERROR (Status
)) {
627 gBS
->FreePool (CurrentTableList
);
628 return EFI_OUT_OF_RESOURCES
;
631 // Update the table pointer with the allocated memory start
633 CurrentTableList
->Table
= (EFI_ACPI_COMMON_HEADER
*) (UINTN
) CurrentTableList
->PageAddress
;
636 // Initialize the table contents
638 CurrentTableList
->Signature
= EFI_ACPI_TABLE_LIST_SIGNATURE
;
639 CopyMem (CurrentTableList
->Table
, Table
, CurrentTableSize
);
640 CurrentTableList
->Handle
= AcpiTableInstance
->CurrentHandle
++;
641 *Handle
= CurrentTableList
->Handle
;
642 CurrentTableList
->Version
= Version
;
645 // Update internal pointers if this is a required table. If it is a required
646 // table and a table of that type already exists, return an error.
648 // Calculate the checksum if the table is not FACS.
650 switch (CurrentTableSignature
) {
652 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
654 // We don't add the FADT in the standard way because some
655 // OS expect the FADT to be early in the table list.
656 // So we always add it as the first element in the list.
661 // Check that the table has not been previously added.
663 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Fadt1
!= NULL
) ||
664 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Fadt3
!= NULL
) ||
665 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Fadt3
!= NULL
)
667 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
668 gBS
->FreePool (CurrentTableList
);
672 // Add the table to the appropriate table version
674 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
676 // Save a pointer to the table
678 AcpiTableInstance
->Fadt1
= (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
681 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
683 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs1
;
684 AcpiTableInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt1
;
687 // RSDP OEM information is updated to match the FADT OEM information
690 &AcpiTableInstance
->Rsdp1
->OemId
,
691 &AcpiTableInstance
->Fadt1
->Header
.OemId
,
696 // RSDT OEM information is updated to match the FADT OEM information.
699 &AcpiTableInstance
->Rsdt1
->OemId
,
700 &AcpiTableInstance
->Fadt1
->Header
.OemId
,
705 &AcpiTableInstance
->Rsdt1
->OemTableId
,
706 &AcpiTableInstance
->Fadt1
->Header
.OemTableId
,
709 AcpiTableInstance
->Rsdt1
->OemRevision
= AcpiTableInstance
->Fadt1
->Header
.OemRevision
;
712 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
713 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
715 // Save a pointer to the table
717 AcpiTableInstance
->Fadt3
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
720 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
722 if (AcpiTableInstance
->Fadt3
!= NULL
) {
723 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs3
;
724 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Facs3
;
726 &AcpiTableInstance
->Fadt3
->XFirmwareCtrl
,
730 AcpiTableInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt3
;
731 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Dsdt3
;
733 &AcpiTableInstance
->Fadt3
->XDsdt
,
739 // RSDP OEM information is updated to match the FADT OEM information
742 &AcpiTableInstance
->Rsdp3
->OemId
,
743 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
748 // RSDT OEM information is updated to match FADT OEM information.
751 &AcpiTableInstance
->Rsdt3
->OemId
,
752 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
756 &AcpiTableInstance
->Rsdt3
->OemTableId
,
757 &AcpiTableInstance
->Fadt3
->Header
.OemTableId
,
760 AcpiTableInstance
->Rsdt3
->OemRevision
= AcpiTableInstance
->Fadt3
->Header
.OemRevision
;
763 // XSDT OEM information is updated to match FADT OEM information.
766 &AcpiTableInstance
->Xsdt
->OemId
,
767 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
771 &AcpiTableInstance
->Xsdt
->OemTableId
,
772 &AcpiTableInstance
->Fadt3
->Header
.OemTableId
,
775 AcpiTableInstance
->Xsdt
->OemRevision
= AcpiTableInstance
->Fadt3
->Header
.OemRevision
;
779 // Checksum the table
782 AcpiPlatformChecksum (
783 CurrentTableList
->Table
,
784 CurrentTableList
->Table
->Length
,
785 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
791 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
793 // Check that the table has not been previously added.
795 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Facs1
!= NULL
) ||
796 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Facs3
!= NULL
) ||
797 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Facs3
!= NULL
)
799 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
800 gBS
->FreePool (CurrentTableList
);
804 // FACS is referenced by FADT and is not part of RSDT
809 // Add the table to the appropriate table version
811 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
813 // Save a pointer to the table
815 AcpiTableInstance
->Facs1
= (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
818 // If FADT already exists, update table pointers.
820 if (AcpiTableInstance
->Fadt1
!= NULL
) {
821 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs1
;
824 // Checksum FADT table
826 AcpiPlatformChecksum (
827 AcpiTableInstance
->Fadt1
,
828 AcpiTableInstance
->Fadt1
->Header
.Length
,
829 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
835 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
836 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
838 // Save a pointer to the table
840 AcpiTableInstance
->Facs3
= (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
843 // If FADT already exists, update table pointers.
845 if (AcpiTableInstance
->Fadt3
!= NULL
) {
846 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs3
;
847 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Facs3
;
849 &AcpiTableInstance
->Fadt3
->XFirmwareCtrl
,
855 // Checksum FADT table
857 AcpiPlatformChecksum (
858 AcpiTableInstance
->Fadt3
,
859 AcpiTableInstance
->Fadt3
->Header
.Length
,
860 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
868 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
870 // Check that the table has not been previously added.
872 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Dsdt1
!= NULL
) ||
873 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Dsdt3
!= NULL
) ||
874 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Dsdt3
!= NULL
)
876 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
877 gBS
->FreePool (CurrentTableList
);
881 // DSDT is referenced by FADT and is not part of RSDT
886 // Add the table to the appropriate table version
888 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
890 // Save a pointer to the table
892 AcpiTableInstance
->Dsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
895 // If FADT already exists, update table pointers.
897 if (AcpiTableInstance
->Fadt1
!= NULL
) {
898 AcpiTableInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt1
;
901 // Checksum FADT table
903 AcpiPlatformChecksum (
904 AcpiTableInstance
->Fadt1
,
905 AcpiTableInstance
->Fadt1
->Header
.Length
,
906 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
912 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
913 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
915 // Save a pointer to the table
917 AcpiTableInstance
->Dsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
920 // If FADT already exists, update table pointers.
922 if (AcpiTableInstance
->Fadt3
!= NULL
) {
923 AcpiTableInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt3
;
924 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Dsdt3
;
926 &AcpiTableInstance
->Fadt3
->XDsdt
,
932 // Checksum FADT table
934 AcpiPlatformChecksum (
935 AcpiTableInstance
->Fadt3
,
936 AcpiTableInstance
->Fadt3
->Header
.Length
,
937 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
943 // Checksum the table
946 AcpiPlatformChecksum (
947 CurrentTableList
->Table
,
948 CurrentTableList
->Table
->Length
,
949 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
957 // Checksum the table
960 AcpiPlatformChecksum (
961 CurrentTableList
->Table
,
962 CurrentTableList
->Table
->Length
,
963 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
970 // Add the table to the current list of tables
972 InsertTailList (&AcpiTableInstance
->TableList
, &CurrentTableList
->Link
);
975 // Add the table to RSDT and/or XSDT table entry lists.
978 // Add to ACPI 1.0b table tree
980 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
983 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
985 if (AcpiTableInstance
->NumberOfTableEntries1
>= mEfiAcpiMaxNumTables
) {
986 Status
= ReallocateAcpiTableBuffer (AcpiTableInstance
);
987 ASSERT_EFI_ERROR (Status
);
989 CurrentRsdtEntry
= (UINT32
*)
991 (UINT8
*) AcpiTableInstance
->Rsdt1
+
992 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
993 AcpiTableInstance
->NumberOfTableEntries1
*
998 // Add entry to the RSDT unless its the FACS or DSDT
1000 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1003 // Update RSDT length
1005 AcpiTableInstance
->Rsdt1
->Length
= AcpiTableInstance
->Rsdt1
->Length
+ sizeof (UINT32
);
1007 AcpiTableInstance
->NumberOfTableEntries1
++;
1011 // Add to ACPI 2.0/3.0 table tree
1013 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1014 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1017 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1019 if (AcpiTableInstance
->NumberOfTableEntries3
>= mEfiAcpiMaxNumTables
) {
1020 Status
= ReallocateAcpiTableBuffer (AcpiTableInstance
);
1021 ASSERT_EFI_ERROR (Status
);
1024 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1025 // If it becomes necessary to maintain separate table lists, changes will be required.
1027 CurrentRsdtEntry
= (UINT32
*)
1029 (UINT8
*) AcpiTableInstance
->Rsdt3
+
1030 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1031 AcpiTableInstance
->NumberOfTableEntries3
*
1036 // This pointer must not be directly dereferenced as the XSDT entries may not
1037 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1039 CurrentXsdtEntry
= (VOID
*)
1041 (UINT8
*) AcpiTableInstance
->Xsdt
+
1042 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1043 AcpiTableInstance
->NumberOfTableEntries3
*
1048 // Add entry to the RSDT
1050 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1053 // Update RSDT length
1055 AcpiTableInstance
->Rsdt3
->Length
= AcpiTableInstance
->Rsdt3
->Length
+ sizeof (UINT32
);
1058 // Add entry to XSDT, XSDT expects 64 bit pointers, but
1059 // the table pointers in XSDT are not aligned on 8 byte boundary.
1061 Buffer64
= (UINT64
) (UINTN
) CurrentTableList
->Table
;
1071 AcpiTableInstance
->Xsdt
->Length
= AcpiTableInstance
->Xsdt
->Length
+ sizeof (UINT64
);
1073 AcpiTableInstance
->NumberOfTableEntries3
++;
1077 ChecksumCommonTables (AcpiTableInstance
);
1083 This function finds the table specified by the handle and returns a pointer to it.
1084 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
1087 @param Handle Table to find.
1088 @param TableList Table list to search
1089 @param Table Pointer to table found.
1091 @return EFI_SUCCESS The function completed successfully.
1092 @return EFI_NOT_FOUND No table found matching the handle specified.
1098 IN LIST_ENTRY
*TableList
,
1099 OUT EFI_ACPI_TABLE_LIST
**Table
1102 LIST_ENTRY
*CurrentLink
;
1103 EFI_ACPI_TABLE_LIST
*CurrentTable
;
1106 // Check for invalid input parameters
1113 CurrentLink
= TableList
->ForwardLink
;
1115 while (CurrentLink
!= TableList
) {
1116 CurrentTable
= EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink
);
1117 if (CurrentTable
->Handle
== Handle
) {
1119 // Found handle, so return this table.
1121 *Table
= CurrentTable
;
1125 CurrentLink
= CurrentLink
->ForwardLink
;
1130 return EFI_NOT_FOUND
;
1135 This function removes a basic table from the RSDT and/or XSDT.
1136 For Acpi 1.0 tables, pass in the Rsdt.
1137 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.
1139 @param Table Pointer to table found.
1140 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT
1141 @param Rsdt Pointer to the RSDT to remove from
1142 @param Xsdt Pointer to the Xsdt to remove from
1144 @return EFI_SUCCESS The function completed successfully.
1145 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.
1149 RemoveTableFromRsdt (
1150 IN OUT EFI_ACPI_TABLE_LIST
* Table
,
1151 IN OUT UINTN
*NumberOfTableEntries
,
1152 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Rsdt
,
1153 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Xsdt OPTIONAL
1156 UINT32
*CurrentRsdtEntry
;
1157 VOID
*CurrentXsdtEntry
;
1158 UINT64 CurrentTablePointer64
;
1162 // Check for invalid input parameters
1165 ASSERT (NumberOfTableEntries
);
1169 // Find the table entry in the RSDT and XSDT
1171 for (Index
= 0; Index
< *NumberOfTableEntries
; Index
++) {
1173 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1174 // If it becomes necessary to maintain separate table lists, changes will be required.
1176 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) Rsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + Index
* sizeof (UINT32
));
1179 // This pointer must not be directly dereferenced as the XSDT entries may not
1180 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1182 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + Index
* sizeof (UINT64
));
1185 // Read the entry value out of the XSDT
1187 CopyMem (&CurrentTablePointer64
, CurrentXsdtEntry
, sizeof (UINT64
));
1190 // Initialize to NULL
1192 CurrentXsdtEntry
= 0;
1193 CurrentTablePointer64
= 0;
1196 // Check if we have found the corresponding entry in both RSDT and XSDT
1198 if (*CurrentRsdtEntry
== (UINT32
) (UINTN
) Table
->Table
&&
1199 ((Xsdt
== NULL
) || CurrentTablePointer64
== (UINT64
) (UINTN
) Table
->Table
)
1202 // Found entry, so copy all following entries and shrink table
1203 // We actually copy all + 1 to copy the initialized value of memory over
1206 CopyMem (CurrentRsdtEntry
, CurrentRsdtEntry
+ 1, (*NumberOfTableEntries
- Index
) * sizeof (UINT32
));
1207 Rsdt
->Length
= Rsdt
->Length
- sizeof (UINT32
);
1209 CopyMem (CurrentXsdtEntry
, ((UINT64
*) CurrentXsdtEntry
) + 1, (*NumberOfTableEntries
- Index
) * sizeof (UINT64
));
1210 Xsdt
->Length
= Xsdt
->Length
- sizeof (UINT64
);
1213 } else if (Index
+ 1 == *NumberOfTableEntries
) {
1215 // At the last entry, and table not found
1217 return EFI_INVALID_PARAMETER
;
1221 // Checksum the tables
1223 AcpiPlatformChecksum (
1226 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1231 AcpiPlatformChecksum (
1234 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1239 // Decrement the number of tables
1241 (*NumberOfTableEntries
)--;
1248 This function removes a table and frees any associated memory.
1250 @param AcpiTableInstance Instance of the protocol.
1251 @param Version Version(s) to delete.
1252 @param Table Pointer to table found.
1254 @return EFI_SUCCESS The function completed successfully.
1259 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
1260 IN EFI_ACPI_TABLE_VERSION Version
,
1261 IN OUT EFI_ACPI_TABLE_LIST
*Table
1264 UINT32 CurrentTableSignature
;
1265 BOOLEAN RemoveFromRsdt
;
1268 // Check for invalid input parameters
1270 ASSERT (AcpiTableInstance
);
1276 RemoveFromRsdt
= TRUE
;
1278 // Check for Table->Table
1280 ASSERT (Table
->Table
!= NULL
);
1281 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
->Table
)->Signature
;
1284 // Basic tasks to accomplish delete are:
1285 // Determine removal requirements (in RSDT/XSDT or not)
1286 // Remove entry from RSDT/XSDT
1287 // Remove any table references to the table
1288 // If no one is using the table
1289 // Free the table (removing pointers from private data and tables)
1291 // Free list structure
1294 // Determine if this table is in the RSDT or XSDT
1296 if ((CurrentTableSignature
== EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
1297 (CurrentTableSignature
== EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
) ||
1298 (CurrentTableSignature
== EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
)
1300 RemoveFromRsdt
= FALSE
;
1303 // We don't remove the FADT in the standard way because some
1304 // OS expect the FADT to be early in the table list.
1305 // So we always put it as the first element in the list.
1307 if (CurrentTableSignature
== EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
1308 RemoveFromRsdt
= FALSE
;
1312 // Remove the table from RSDT and XSDT
1314 if (Table
->Table
!= NULL
) {
1316 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt
1318 if (Version
& EFI_ACPI_TABLE_VERSION_NONE
& Table
->Version
) {
1320 // Remove this version from the table
1322 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_NONE
;
1325 if (Version
& EFI_ACPI_TABLE_VERSION_1_0B
& Table
->Version
) {
1327 // Remove this version from the table
1329 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_1_0B
;
1332 // Remove from Rsdt. We don't care about the return value because it is
1333 // acceptable for the table to not exist in Rsdt.
1334 // We didn't add some tables so we don't remove them.
1336 if (RemoveFromRsdt
) {
1337 RemoveTableFromRsdt (
1339 &AcpiTableInstance
->NumberOfTableEntries1
,
1340 AcpiTableInstance
->Rsdt1
,
1346 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) ||
1347 (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
)) {
1349 // Remove this version from the table
1351 if (Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) {
1352 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_2_0
;
1354 if (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
) {
1355 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_3_0
;
1359 // Remove from Rsdt and Xsdt. We don't care about the return value
1360 // because it is acceptable for the table to not exist in Rsdt/Xsdt.
1361 // We didn't add some tables so we don't remove them.
1363 if (RemoveFromRsdt
) {
1364 RemoveTableFromRsdt (
1366 &AcpiTableInstance
->NumberOfTableEntries3
,
1367 AcpiTableInstance
->Rsdt3
,
1368 AcpiTableInstance
->Xsdt
1373 // Free the table, clean up any dependent tables and our private data pointers.
1375 switch (Table
->Table
->Signature
) {
1377 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
1378 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1379 AcpiTableInstance
->Fadt1
= NULL
;
1382 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1383 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1384 AcpiTableInstance
->Fadt3
= NULL
;
1388 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
1389 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1390 AcpiTableInstance
->Facs1
= NULL
;
1393 // Update FADT table pointers
1395 if (AcpiTableInstance
->Fadt1
!= NULL
) {
1396 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= 0;
1401 AcpiPlatformChecksum (
1402 AcpiTableInstance
->Fadt1
,
1403 AcpiTableInstance
->Fadt1
->Header
.Length
,
1404 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1410 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1411 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1412 AcpiTableInstance
->Facs3
= NULL
;
1415 // Update FADT table pointers
1417 if (AcpiTableInstance
->Fadt3
!= NULL
) {
1418 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= 0;
1419 ZeroMem (&AcpiTableInstance
->Fadt3
->XFirmwareCtrl
, sizeof (UINT64
));
1424 AcpiPlatformChecksum (
1425 AcpiTableInstance
->Fadt3
,
1426 AcpiTableInstance
->Fadt3
->Header
.Length
,
1427 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1434 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
1435 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1436 AcpiTableInstance
->Dsdt1
= NULL
;
1439 // Update FADT table pointers
1441 if (AcpiTableInstance
->Fadt1
!= NULL
) {
1442 AcpiTableInstance
->Fadt1
->Dsdt
= 0;
1447 AcpiPlatformChecksum (
1448 AcpiTableInstance
->Fadt1
,
1449 AcpiTableInstance
->Fadt1
->Header
.Length
,
1450 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1457 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1458 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1459 AcpiTableInstance
->Dsdt3
= NULL
;
1462 // Update FADT table pointers
1464 if (AcpiTableInstance
->Fadt3
!= NULL
) {
1465 AcpiTableInstance
->Fadt3
->Dsdt
= 0;
1466 ZeroMem (&AcpiTableInstance
->Fadt3
->XDsdt
, sizeof (UINT64
));
1471 AcpiPlatformChecksum (
1472 AcpiTableInstance
->Fadt3
,
1473 AcpiTableInstance
->Fadt3
->Header
.Length
,
1474 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1489 // If no version is using this table anymore, remove and free list entry.
1491 if (Table
->Version
== 0) {
1495 gBS
->FreePages (Table
->PageAddress
, Table
->NumberOfPages
);
1496 RemoveEntryList (&(Table
->Link
));
1497 gBS
->FreePool (Table
);
1507 This function finds and removes the table specified by the handle.
1509 @param AcpiTableInstance Instance of the protocol.
1510 @param Version Bitmask of which versions to remove.
1511 @param Handle Table to remove.
1513 @return EFI_SUCCESS The function completed successfully.
1514 @return EFI_ABORTED An error occurred.
1515 @return EFI_NOT_FOUND Handle not found in table list.
1519 RemoveTableFromList (
1520 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
1521 IN EFI_ACPI_TABLE_VERSION Version
,
1525 EFI_ACPI_TABLE_LIST
*Table
;
1528 Table
= (EFI_ACPI_TABLE_LIST
*) NULL
;
1531 // Check for invalid input parameters
1533 ASSERT (AcpiTableInstance
);
1538 Status
= FindTableByHandle (
1540 &AcpiTableInstance
->TableList
,
1543 if (EFI_ERROR (Status
)) {
1544 return EFI_NOT_FOUND
;
1549 Status
= DeleteTable (AcpiTableInstance
, Version
, Table
);
1550 if (EFI_ERROR (Status
)) {
1554 // Completed successfully
1561 This function calculates and updates an UINT8 checksum.
1563 @param Buffer Pointer to buffer to checksum
1564 @param Size Number of bytes to checksum
1565 @param ChecksumOffset Offset to place the checksum result in
1567 @return EFI_SUCCESS The function completed successfully.
1571 AcpiPlatformChecksum (
1574 IN UINTN ChecksumOffset
1582 // Initialize pointer
1587 // set checksum to 0 first
1589 Ptr
[ChecksumOffset
] = 0;
1592 // add all content of buffer
1594 while ((Size
--) != 0) {
1595 Sum
= (UINT8
) (Sum
+ (*Ptr
++));
1601 Ptr
[ChecksumOffset
] = (UINT8
) (0xff - Sum
+ 1);
1608 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
1610 @param AcpiTableInstance Protocol instance private data.
1612 @return EFI_SUCCESS The function completed successfully.
1616 ChecksumCommonTables (
1617 IN OUT EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
1621 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure
1623 AcpiPlatformChecksum (
1624 AcpiTableInstance
->Rsdp1
,
1625 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1626 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1631 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure
1633 AcpiPlatformChecksum (
1634 AcpiTableInstance
->Rsdp3
,
1635 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1636 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1641 // RSDP ACPI 2.0/3.0 checksum, this is the entire table
1643 AcpiPlatformChecksum (
1644 AcpiTableInstance
->Rsdp3
,
1645 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1646 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1653 AcpiPlatformChecksum (
1654 AcpiTableInstance
->Rsdt1
,
1655 AcpiTableInstance
->Rsdt1
->Length
,
1656 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1660 AcpiPlatformChecksum (
1661 AcpiTableInstance
->Rsdt3
,
1662 AcpiTableInstance
->Rsdt3
->Length
,
1663 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1670 AcpiPlatformChecksum (
1671 AcpiTableInstance
->Xsdt
,
1672 AcpiTableInstance
->Xsdt
->Length
,
1673 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1682 Constructor for the ACPI table protocol. Initializes instance
1685 @param AcpiTableInstance Instance to construct
1687 @return EFI_SUCCESS Instance initialized.
1688 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
1692 AcpiTableAcpiTableConstructor (
1693 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
1700 EFI_PHYSICAL_ADDRESS PageAddress
;
1703 // Check for invalid input parameters
1705 ASSERT (AcpiTableInstance
);
1707 InitializeListHead (&AcpiTableInstance
->TableList
);
1708 AcpiTableInstance
->CurrentHandle
= 1;
1710 AcpiTableInstance
->AcpiTableProtocol
.InstallAcpiTable
= InstallAcpiTable
;
1711 AcpiTableInstance
->AcpiTableProtocol
.UninstallAcpiTable
= UninstallAcpiTable
;
1713 // Create RSDP, RSDT, XSDT structures
1714 // Allocate all buffers
1716 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1717 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1718 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
1719 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1720 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
1721 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1722 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
1723 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
1726 // Allocate memory in the lower 32 bit of address range for
1727 // compatibility with ACPI 1.0 OS.
1729 // This is done because ACPI 1.0 pointers are 32 bit values.
1730 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
1731 // There is no architectural reason these should be below 4GB, it is purely
1732 // for convenience of implementation that we force memory below 4GB.
1734 PageAddress
= 0xFFFFFFFF;
1735 Status
= gBS
->AllocatePages (
1737 EfiACPIReclaimMemory
,
1738 EFI_SIZE_TO_PAGES (TotalSize
),
1742 if (EFI_ERROR (Status
)) {
1743 return EFI_OUT_OF_RESOURCES
;
1746 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1747 ZeroMem (Pointer
, TotalSize
);
1749 AcpiTableInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1750 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1751 AcpiTableInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1752 Pointer
+= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1754 AcpiTableInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1755 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1756 AcpiTableInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1757 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1759 AcpiTableInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1764 CurrentData
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1765 CopyMem (&AcpiTableInstance
->Rsdp1
->Signature
, &CurrentData
, sizeof (UINT64
));
1766 CopyMem (AcpiTableInstance
->Rsdp1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1767 AcpiTableInstance
->Rsdp1
->Reserved
= EFI_ACPI_RESERVED_BYTE
;
1768 AcpiTableInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt1
;
1770 CurrentData
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1771 CopyMem (&AcpiTableInstance
->Rsdp3
->Signature
, &CurrentData
, sizeof (UINT64
));
1772 CopyMem (AcpiTableInstance
->Rsdp3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1773 AcpiTableInstance
->Rsdp3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION
;
1774 AcpiTableInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt3
;
1775 AcpiTableInstance
->Rsdp3
->Length
= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1776 CurrentData
= (UINT64
) (UINTN
) AcpiTableInstance
->Xsdt
;
1777 CopyMem (&AcpiTableInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
1778 SetMem (AcpiTableInstance
->Rsdp3
->Reserved
, 3, EFI_ACPI_RESERVED_BYTE
);
1783 // Note that we "reserve" one entry for the FADT so it can always be
1784 // at the beginning of the list of tables. Some OS don't seem
1785 // to find it correctly if it is too far down the list.
1787 AcpiTableInstance
->Rsdt1
->Signature
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1788 AcpiTableInstance
->Rsdt1
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1789 AcpiTableInstance
->Rsdt1
->Revision
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1790 CopyMem (AcpiTableInstance
->Rsdt1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1791 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1792 CopyMem (&AcpiTableInstance
->Rsdt1
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1793 AcpiTableInstance
->Rsdt1
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1794 AcpiTableInstance
->Rsdt1
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1795 AcpiTableInstance
->Rsdt1
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1797 // We always reserve first one for FADT
1799 AcpiTableInstance
->NumberOfTableEntries1
= 1;
1800 AcpiTableInstance
->Rsdt1
->Length
= AcpiTableInstance
->Rsdt1
->Length
+ sizeof(UINT32
);
1802 AcpiTableInstance
->Rsdt3
->Signature
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1803 AcpiTableInstance
->Rsdt3
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1804 AcpiTableInstance
->Rsdt3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1805 CopyMem (AcpiTableInstance
->Rsdt3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1806 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1807 CopyMem (&AcpiTableInstance
->Rsdt3
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1808 AcpiTableInstance
->Rsdt3
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1809 AcpiTableInstance
->Rsdt3
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1810 AcpiTableInstance
->Rsdt3
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1812 // We always reserve first one for FADT
1814 AcpiTableInstance
->NumberOfTableEntries3
= 1;
1815 AcpiTableInstance
->Rsdt3
->Length
= AcpiTableInstance
->Rsdt3
->Length
+ sizeof(UINT32
);
1820 AcpiTableInstance
->Xsdt
->Signature
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1821 AcpiTableInstance
->Xsdt
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1822 AcpiTableInstance
->Xsdt
->Revision
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1823 CopyMem (AcpiTableInstance
->Xsdt
->OemId
, EFI_ACPI_OEM_ID
, 6);
1824 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1825 CopyMem (&AcpiTableInstance
->Xsdt
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1826 AcpiTableInstance
->Xsdt
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1827 AcpiTableInstance
->Xsdt
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1828 AcpiTableInstance
->Xsdt
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1830 // We always reserve first one for FADT
1832 AcpiTableInstance
->Xsdt
->Length
= AcpiTableInstance
->Xsdt
->Length
+ sizeof(UINT64
);
1834 ChecksumCommonTables (AcpiTableInstance
);
1837 // Completed successfully