2 ACPI Support Protocol implementation
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions
8 of the BSD License which accompanies this distribution. The
9 full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #include "AcpiSupport.h"
22 // The maximum number of tables that pre-allocated.
24 UINTN mEfiAcpiMaxNumTables
= EFI_ACPI_MAX_NUM_TABLES
;
26 This function adds an ACPI table to the table list. It will detect FACS and
27 allocate the correct type of memory and properly align the table.
29 @param AcpiSupportInstance Instance of the protocol.
30 @param Table Table to add.
31 @param Checksum Does the table require checksumming.
32 @param Version The version of the list to add the table to.
33 @param Handle Pointer for returning the handle.
35 @return EFI_SUCCESS The function completed successfully.
36 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
37 @return EFI_ABORTED The table is a duplicate of a table that is required
42 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
45 IN EFI_ACPI_TABLE_VERSION Version
,
49 This function finds and removes the table specified by the handle.
51 @param AcpiSupportInstance Instance of the protocol.
52 @param Version Bitmask of which versions to remove.
53 @param Handle Table to remove.
55 @return EFI_SUCCESS The function completed successfully.
56 @return EFI_ABORTED An error occurred.
57 @return EFI_NOT_FOUND Handle not found in table list.
61 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
62 IN EFI_ACPI_TABLE_VERSION Version
,
66 This function calculates and updates an UINT8 checksum.
68 @param Buffer Pointer to buffer to checksum
69 @param Size Number of bytes to checksum
70 @param ChecksumOffset Offset to place the checksum result in
72 @return EFI_SUCCESS The function completed successfully.
75 AcpiPlatformChecksum (
78 IN UINTN ChecksumOffset
81 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
83 @param AcpiSupportInstance Protocol instance private data.
85 @return EFI_SUCCESS The function completed successfully.
89 ChecksumCommonTables (
90 IN OUT EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
94 This function returns a table specified by an index if it exists.
96 The function returns a buffer containing the table that the caller must free.
97 The function also returns a handle used to identify the table for update or
98 deletion using the SetAcpiTable function.
100 @param This Instance of the protocol.
101 @param Index Zero-based index of the table to retrieve.
102 @param Table Returned pointer to the table.
103 @param Version Versions that the table is currently used in.
104 @param Handle Handle of the table, used in updating tables.
106 @retval EFI_SUCCESS The function completed successfully.
107 @retval EFI_NOT_FOUND The requested table does not exist.
113 IN EFI_ACPI_SUPPORT_PROTOCOL
*This
,
116 OUT EFI_ACPI_TABLE_VERSION
*Version
,
121 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
123 LIST_ENTRY
*CurrentLink
;
124 LIST_ENTRY
*StartLink
;
125 EFI_ACPI_TABLE_LIST
*CurrentTable
;
128 // Check for invalid input parameters
135 // Get the instance of the protocol
137 AcpiSupportInstance
= EFI_ACPI_SUPPORT_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
142 CurrentLink
= AcpiSupportInstance
->TableList
.ForwardLink
;
143 StartLink
= &AcpiSupportInstance
->TableList
;
144 for (TempIndex
= 0; (TempIndex
< Index
) && (CurrentLink
!= StartLink
) && (CurrentLink
!= NULL
); TempIndex
++) {
145 CurrentLink
= CurrentLink
->ForwardLink
;
148 if (TempIndex
!= Index
|| CurrentLink
== StartLink
) {
149 return EFI_NOT_FOUND
;
152 // Get handle and version
154 CurrentTable
= EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink
);
155 *Handle
= CurrentTable
->Handle
;
156 *Version
= CurrentTable
->Version
;
161 *Table
= AllocateCopyPool (CurrentTable
->Table
->Length
, CurrentTable
->Table
);
167 This function adds, removes, or updates ACPI tables. If the address is not
168 null and the handle value is null, the table is added. If both the address and
169 handle are not null, the table at handle is updated with the table at address.
170 If the address is null and the handle is not, the table at handle is deleted.
172 @param This Pointer of the protocol.
173 @param Table Pointer to a table.
174 @param Checksum Boolean indicating if the checksum should be calculated.
175 @param Version Version(s) to set.
176 @param Handle Handle of the table.
178 @return EFI_SUCCESS The function completed successfully.
179 @return EFI_INVALID_PARAMETER Both the Table and *Handle were NULL.
180 @return EFI_ABORTED Could not complete the desired request.
186 IN EFI_ACPI_SUPPORT_PROTOCOL
*This
,
187 IN VOID
*Table OPTIONAL
,
189 IN EFI_ACPI_TABLE_VERSION Version
,
193 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
198 // Check for invalid input parameters
201 ASSERT (Handle
!= NULL
);
204 // Get the instance of the protocol
206 AcpiSupportInstance
= EFI_ACPI_SUPPORT_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
212 // Determine desired action
217 // Invalid parameter combination
219 return EFI_INVALID_PARAMETER
;
224 Status
= AddTableToList (AcpiSupportInstance
, Table
, Checksum
, Version
, Handle
);
232 // Delete the table list entry
234 Status
= RemoveTableFromList (AcpiSupportInstance
, Version
, *Handle
);
235 if (EFI_ERROR (Status
)) {
237 // Should not get an error here ever, but abort if we do.
242 // Set the handle to replace the table at the same handle
244 SavedHandle
= AcpiSupportInstance
->CurrentHandle
;
245 AcpiSupportInstance
->CurrentHandle
= *Handle
;
250 Status
= AddTableToList (AcpiSupportInstance
, Table
, Checksum
, Version
, Handle
);
253 // Restore the saved current handle
255 AcpiSupportInstance
->CurrentHandle
= SavedHandle
;
260 Status
= RemoveTableFromList (AcpiSupportInstance
, Version
, *Handle
);
264 if (EFI_ERROR (Status
)) {
266 // Should not get an error here ever, but abort if we do.
276 This function publishes the specified versions of the ACPI tables by
277 installing EFI configuration table entries for them. Any combination of
278 table versions can be published.
280 @param This Pointer of the protocol.
281 @param Version Version(s) to publish.
283 @return EFI_SUCCESS The function completed successfully.
284 @return EFI_ABORTED The function could not complete successfully.
290 IN EFI_ACPI_SUPPORT_PROTOCOL
*This
,
291 IN EFI_ACPI_TABLE_VERSION Version
294 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
296 UINT32
*CurrentRsdtEntry
;
297 VOID
*CurrentXsdtEntry
;
301 // Get the instance of the protocol
303 AcpiSupportInstance
= EFI_ACPI_SUPPORT_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
306 // Reorder tables as some operating systems don't seem to find the
307 // FADT correctly if it is not in the first few entries
311 // Add FADT as the first entry
313 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
314 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiSupportInstance
->Rsdt1
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
315 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiSupportInstance
->Fadt1
;
317 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 || (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
318 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiSupportInstance
->Rsdt3
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
319 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiSupportInstance
->Fadt3
;
320 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) AcpiSupportInstance
->Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
322 // Add entry to XSDT, XSDT expects 64 bit pointers, but
323 // the table pointers in XSDT are not aligned on 8 byte boundary.
325 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Fadt3
;
334 // Do checksum again because Dsdt/Xsdt is updated.
336 ChecksumCommonTables (AcpiSupportInstance
);
339 // Add the RSD_PTR to the system table and store that we have installed the
342 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && !AcpiSupportInstance
->TablesInstalled1
) {
343 Status
= gBS
->InstallConfigurationTable (&gEfiAcpi10TableGuid
, AcpiSupportInstance
->Rsdp1
);
344 if (EFI_ERROR (Status
)) {
348 AcpiSupportInstance
->TablesInstalled1
= TRUE
;
351 if (((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 || (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) &&
352 !AcpiSupportInstance
->TablesInstalled3
) {
353 Status
= gBS
->InstallConfigurationTable (&gEfiAcpiTableGuid
, AcpiSupportInstance
->Rsdp3
);
354 if (EFI_ERROR (Status
)) {
358 AcpiSupportInstance
->TablesInstalled3
= TRUE
;
364 Installs an ACPI table into the RSDT/XSDT.
365 Note that the ACPI table should be checksumed before installing it.
366 Otherwise it will assert.
368 @param This Protocol instance pointer.
369 @param AcpiTableBuffer A pointer to a buffer containing the ACPI table to be installed.
370 @param AcpiTableBufferSize Specifies the size, in bytes, of the AcpiTableBuffer buffer.
371 @param TableKey Reurns a key to refer to the ACPI table.
373 @return EFI_SUCCESS The table was successfully inserted.
374 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize
375 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer
377 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.
383 IN EFI_ACPI_TABLE_PROTOCOL
*This
,
384 IN VOID
*AcpiTableBuffer
,
385 IN UINTN AcpiTableBufferSize
,
389 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
390 EFI_ACPI_SUPPORT_PROTOCOL
*AcpiSupport
;
392 VOID
*AcpiTableBufferConst
;
397 // Check for invalid input parameters
399 if ((AcpiTableBuffer
== NULL
) || (TableKey
== NULL
)
400 || (((EFI_ACPI_DESCRIPTION_HEADER
*) AcpiTableBuffer
)->Length
!= AcpiTableBufferSize
)) {
401 return EFI_INVALID_PARAMETER
;
404 Length
= ((EFI_ACPI_COMMON_HEADER
*) AcpiTableBuffer
)->Length
;
405 Checksum
= CalculateCheckSum8 ((UINT8
*)AcpiTableBuffer
, Length
);
407 AcpiPlatformChecksum (
408 (VOID
*)AcpiTableBuffer
,
410 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
, Checksum
)
415 // Get the instance of the ACPI support protocol
417 AcpiSupportInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
418 AcpiSupport
= &AcpiSupportInstance
->AcpiSupport
;
421 // Install the ACPI table by using ACPI support protocol
423 AcpiTableBufferConst
= AllocateCopyPool (AcpiTableBufferSize
, AcpiTableBuffer
);
425 Status
= AcpiSupport
->SetAcpiTable (
427 AcpiTableBufferConst
,
429 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
432 if (!EFI_ERROR (Status
)) {
433 Status
= AcpiSupport
->PublishTables (
435 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
438 FreePool (AcpiTableBufferConst
);
443 Removes an ACPI table from the RSDT/XSDT.
445 @param This Protocol instance pointer.
446 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().
448 @return EFI_SUCCESS The table was successfully uninstalled.
449 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.
455 IN EFI_ACPI_TABLE_PROTOCOL
*This
,
459 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
460 EFI_ACPI_SUPPORT_PROTOCOL
*AcpiSupport
;
464 // Get the instance of the ACPI support protocol
466 AcpiSupportInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
467 AcpiSupport
= &AcpiSupportInstance
->AcpiSupport
;
470 // Uninstall the ACPI table by using ACPI support protocol
472 Status
= AcpiSupport
->SetAcpiTable (
476 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
479 if (!EFI_ERROR (Status
)) {
480 Status
= AcpiSupport
->PublishTables (
482 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
486 if (EFI_ERROR (Status
)) {
487 return EFI_NOT_FOUND
;
493 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.
495 @param AcpiSupportInstance ACPI support protocol instance data structure
497 @return EFI_SUCCESS reallocate the table beffer successfully.
498 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
502 ReallocateAcpiTableBuffer (
503 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
506 UINTN NewMaxTableNumber
;
509 EFI_PHYSICAL_ADDRESS PageAddress
;
510 EFI_ACPI_SUPPORT_INSTANCE TempPrivateData
;
514 CopyMem (&TempPrivateData
, AcpiSupportInstance
, sizeof (EFI_ACPI_SUPPORT_INSTANCE
));
516 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES
518 NewMaxTableNumber
= mEfiAcpiMaxNumTables
+ EFI_ACPI_MAX_NUM_TABLES
;
520 // Create RSDT, XSDT structures and allocate buffers.
522 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
523 NewMaxTableNumber
* sizeof (UINT32
) +
524 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
525 NewMaxTableNumber
* sizeof (UINT32
) +
526 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
527 NewMaxTableNumber
* sizeof (UINT64
);
530 // Allocate memory in the lower 32 bit of address range for
531 // compatibility with ACPI 1.0 OS.
533 // This is done because ACPI 1.0 pointers are 32 bit values.
534 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
535 // There is no architectural reason these should be below 4GB, it is purely
536 // for convenience of implementation that we force memory below 4GB.
538 PageAddress
= 0xFFFFFFFF;
539 Status
= gBS
->AllocatePages (
541 EfiACPIReclaimMemory
,
542 EFI_SIZE_TO_PAGES (TotalSize
),
546 if (EFI_ERROR (Status
)) {
547 return EFI_OUT_OF_RESOURCES
;
550 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
551 ZeroMem (Pointer
, TotalSize
);
553 AcpiSupportInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
554 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
555 AcpiSupportInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
556 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
557 AcpiSupportInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
560 // Update RSDP to point to the new Rsdt and Xsdt address.
562 AcpiSupportInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt1
;
563 AcpiSupportInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt3
;
564 CurrentData
= (UINT64
) (UINTN
) AcpiSupportInstance
->Xsdt
;
565 CopyMem (&AcpiSupportInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
568 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer
570 CopyMem (AcpiSupportInstance
->Rsdt1
, TempPrivateData
.Rsdt1
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
571 CopyMem (AcpiSupportInstance
->Rsdt3
, TempPrivateData
.Rsdt3
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
572 CopyMem (AcpiSupportInstance
->Xsdt
, TempPrivateData
.Xsdt
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT64
)));
575 // Calculate orignal ACPI table buffer size
577 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
578 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
579 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
580 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
581 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
582 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
583 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)(UINTN
)TempPrivateData
.Rsdt1
, EFI_SIZE_TO_PAGES (TotalSize
));
586 // Update the Max ACPI table number
588 mEfiAcpiMaxNumTables
= NewMaxTableNumber
;
592 This function adds an ACPI table to the table list. It will detect FACS and
593 allocate the correct type of memory and properly align the table.
595 @param AcpiSupportInstance Instance of the protocol.
596 @param Table Table to add.
597 @param Checksum Does the table require checksumming.
598 @param Version The version of the list to add the table to.
599 @param Handle Pointer for returning the handle.
601 @return EFI_SUCCESS The function completed successfully.
602 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
603 @return EFI_ABORTED The table is a duplicate of a table that is required
608 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
611 IN EFI_ACPI_TABLE_VERSION Version
,
616 EFI_ACPI_TABLE_LIST
*CurrentTableList
;
617 UINT32 CurrentTableSignature
;
618 UINT32 CurrentTableSize
;
619 UINT32
*CurrentRsdtEntry
;
620 VOID
*CurrentXsdtEntry
;
625 // Check for invalid input parameters
627 ASSERT (AcpiSupportInstance
);
637 // Create a new list entry
639 CurrentTableList
= AllocatePool (sizeof (EFI_ACPI_TABLE_LIST
));
640 ASSERT (CurrentTableList
);
643 // Determine table type and size
645 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Signature
;
646 CurrentTableSize
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Length
;
649 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space
650 // for backwards compatibility with ACPI 1.0 OS.
652 // This is done because ACPI 1.0 pointers are 32 bit values.
653 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
654 // There is no architectural reason these should be below 4GB, it is purely
655 // for convenience of implementation that we force memory below 4GB.
657 CurrentTableList
->PageAddress
= 0xFFFFFFFF;
658 CurrentTableList
->NumberOfPages
= EFI_SIZE_TO_PAGES (CurrentTableSize
);
661 // Allocation memory type depends on the type of the table
663 if ((CurrentTableSignature
== EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
664 (CurrentTableSignature
== EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE
)) {
666 // Allocate memory for the FACS. This structure must be aligned
667 // on a 64 byte boundary and must be ACPI NVS memory.
668 // Using AllocatePages should ensure that it is always aligned.
669 // Do not change signature for new ACPI version because they are same.
671 // UEFI table also need to be in ACPI NVS memory, because some data field
672 // could be updated by OS present agent. For example, BufferPtrAddress in
673 // SMM communication ACPI table.
675 ASSERT ((EFI_PAGE_SIZE
% 64) == 0);
676 Status
= gBS
->AllocatePages (
679 CurrentTableList
->NumberOfPages
,
680 &CurrentTableList
->PageAddress
684 // All other tables are ACPI reclaim memory, no alignment requirements.
686 Status
= gBS
->AllocatePages (
688 EfiACPIReclaimMemory
,
689 CurrentTableList
->NumberOfPages
,
690 &CurrentTableList
->PageAddress
694 // Check return value from memory alloc.
696 if (EFI_ERROR (Status
)) {
697 gBS
->FreePool (CurrentTableList
);
698 return EFI_OUT_OF_RESOURCES
;
701 // Update the table pointer with the allocated memory start
703 CurrentTableList
->Table
= (EFI_ACPI_COMMON_HEADER
*) (UINTN
) CurrentTableList
->PageAddress
;
706 // Initialize the table contents
708 CurrentTableList
->Signature
= EFI_ACPI_TABLE_LIST_SIGNATURE
;
709 CopyMem (CurrentTableList
->Table
, Table
, CurrentTableSize
);
710 CurrentTableList
->Handle
= AcpiSupportInstance
->CurrentHandle
++;
711 *Handle
= CurrentTableList
->Handle
;
712 CurrentTableList
->Version
= Version
;
715 // Update internal pointers if this is a required table. If it is a required
716 // table and a table of that type already exists, return an error.
718 // Calculate the checksum if the table is not FACS.
720 switch (CurrentTableSignature
) {
722 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
724 // We don't add the FADT in the standard way because some
725 // OS expect the FADT to be early in the table list.
726 // So we always add it as the first element in the list.
731 // Check that the table has not been previously added.
733 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Fadt1
!= NULL
) ||
734 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Fadt3
!= NULL
) ||
735 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Fadt3
!= NULL
)
737 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
738 gBS
->FreePool (CurrentTableList
);
742 // Add the table to the appropriate table version
744 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
746 // Save a pointer to the table
748 AcpiSupportInstance
->Fadt1
= (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
751 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
753 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs1
;
754 AcpiSupportInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt1
;
757 // RSDP OEM information is updated to match the FADT OEM information
760 &AcpiSupportInstance
->Rsdp1
->OemId
,
761 &AcpiSupportInstance
->Fadt1
->Header
.OemId
,
766 // RSDT OEM information is updated to match the FADT OEM information.
769 &AcpiSupportInstance
->Rsdt1
->OemId
,
770 &AcpiSupportInstance
->Fadt1
->Header
.OemId
,
775 &AcpiSupportInstance
->Rsdt1
->OemTableId
,
776 &AcpiSupportInstance
->Fadt1
->Header
.OemTableId
,
779 AcpiSupportInstance
->Rsdt1
->OemRevision
= AcpiSupportInstance
->Fadt1
->Header
.OemRevision
;
782 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
783 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
785 // Save a pointer to the table
787 AcpiSupportInstance
->Fadt3
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
790 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
792 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs3
;
793 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Facs3
;
795 &AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
,
799 AcpiSupportInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
800 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
802 &AcpiSupportInstance
->Fadt3
->XDsdt
,
808 // RSDP OEM information is updated to match the FADT OEM information
811 &AcpiSupportInstance
->Rsdp3
->OemId
,
812 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
817 // RSDT OEM information is updated to match FADT OEM information.
820 &AcpiSupportInstance
->Rsdt3
->OemId
,
821 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
825 &AcpiSupportInstance
->Rsdt3
->OemTableId
,
826 &AcpiSupportInstance
->Fadt3
->Header
.OemTableId
,
829 AcpiSupportInstance
->Rsdt3
->OemRevision
= AcpiSupportInstance
->Fadt3
->Header
.OemRevision
;
832 // XSDT OEM information is updated to match FADT OEM information.
835 &AcpiSupportInstance
->Xsdt
->OemId
,
836 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
840 &AcpiSupportInstance
->Xsdt
->OemTableId
,
841 &AcpiSupportInstance
->Fadt3
->Header
.OemTableId
,
844 AcpiSupportInstance
->Xsdt
->OemRevision
= AcpiSupportInstance
->Fadt3
->Header
.OemRevision
;
848 // Checksum the table
851 AcpiPlatformChecksum (
852 CurrentTableList
->Table
,
853 CurrentTableList
->Table
->Length
,
854 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
860 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
862 // Check that the table has not been previously added.
864 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Facs1
!= NULL
) ||
865 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Facs3
!= NULL
) ||
866 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Facs3
!= NULL
)
868 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
869 gBS
->FreePool (CurrentTableList
);
873 // FACS is referenced by FADT and is not part of RSDT
878 // Add the table to the appropriate table version
880 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
882 // Save a pointer to the table
884 AcpiSupportInstance
->Facs1
= (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
887 // If FADT already exists, update table pointers.
889 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
890 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs1
;
893 // Checksum FADT table
895 AcpiPlatformChecksum (
896 AcpiSupportInstance
->Fadt1
,
897 AcpiSupportInstance
->Fadt1
->Header
.Length
,
898 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
904 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
905 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
907 // Save a pointer to the table
909 AcpiSupportInstance
->Facs3
= (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
912 // If FADT already exists, update table pointers.
914 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
915 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs3
;
916 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Facs3
;
918 &AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
,
924 // Checksum FADT table
926 AcpiPlatformChecksum (
927 AcpiSupportInstance
->Fadt3
,
928 AcpiSupportInstance
->Fadt3
->Header
.Length
,
929 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
937 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
939 // Check that the table has not been previously added.
941 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Dsdt1
!= NULL
) ||
942 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Dsdt3
!= NULL
) ||
943 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Dsdt3
!= NULL
)
945 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
946 gBS
->FreePool (CurrentTableList
);
950 // DSDT is referenced by FADT and is not part of RSDT
955 // Add the table to the appropriate table version
957 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
959 // Save a pointer to the table
961 AcpiSupportInstance
->Dsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
964 // If FADT already exists, update table pointers.
966 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
967 AcpiSupportInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt1
;
970 // Checksum FADT table
972 AcpiPlatformChecksum (
973 AcpiSupportInstance
->Fadt1
,
974 AcpiSupportInstance
->Fadt1
->Header
.Length
,
975 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
981 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
982 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
984 // Save a pointer to the table
986 AcpiSupportInstance
->Dsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
989 // If FADT already exists, update table pointers.
991 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
992 AcpiSupportInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
993 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
995 &AcpiSupportInstance
->Fadt3
->XDsdt
,
1001 // Checksum FADT table
1003 AcpiPlatformChecksum (
1004 AcpiSupportInstance
->Fadt3
,
1005 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1006 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1012 // Checksum the table
1015 AcpiPlatformChecksum (
1016 CurrentTableList
->Table
,
1017 CurrentTableList
->Table
->Length
,
1018 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1026 // Checksum the table
1029 AcpiPlatformChecksum (
1030 CurrentTableList
->Table
,
1031 CurrentTableList
->Table
->Length
,
1032 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1039 // Add the table to the current list of tables
1041 InsertTailList (&AcpiSupportInstance
->TableList
, &CurrentTableList
->Link
);
1044 // Add the table to RSDT and/or XSDT table entry lists.
1047 // Add to ACPI 1.0b table tree
1049 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1052 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1054 if (AcpiSupportInstance
->NumberOfTableEntries1
>= mEfiAcpiMaxNumTables
) {
1055 Status
= ReallocateAcpiTableBuffer (AcpiSupportInstance
);
1056 ASSERT_EFI_ERROR (Status
);
1058 CurrentRsdtEntry
= (UINT32
*)
1060 (UINT8
*) AcpiSupportInstance
->Rsdt1
+
1061 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1062 AcpiSupportInstance
->NumberOfTableEntries1
*
1067 // Add entry to the RSDT unless its the FACS or DSDT
1069 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1072 // Update RSDT length
1074 AcpiSupportInstance
->Rsdt1
->Length
= AcpiSupportInstance
->Rsdt1
->Length
+ sizeof (UINT32
);
1076 AcpiSupportInstance
->NumberOfTableEntries1
++;
1080 // Add to ACPI 2.0/3.0 table tree
1082 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 || (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1085 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1087 if (AcpiSupportInstance
->NumberOfTableEntries3
>= mEfiAcpiMaxNumTables
) {
1088 Status
= ReallocateAcpiTableBuffer (AcpiSupportInstance
);
1089 ASSERT_EFI_ERROR (Status
);
1092 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1093 // If it becomes necessary to maintain separate table lists, changes will be required.
1095 CurrentRsdtEntry
= (UINT32
*)
1097 (UINT8
*) AcpiSupportInstance
->Rsdt3
+
1098 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1099 AcpiSupportInstance
->NumberOfTableEntries3
*
1104 // This pointer must not be directly dereferenced as the XSDT entries may not
1105 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1107 CurrentXsdtEntry
= (VOID
*)
1109 (UINT8
*) AcpiSupportInstance
->Xsdt
+
1110 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1111 AcpiSupportInstance
->NumberOfTableEntries3
*
1116 // Add entry to the RSDT
1118 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1121 // Update RSDT length
1123 AcpiSupportInstance
->Rsdt3
->Length
= AcpiSupportInstance
->Rsdt3
->Length
+ sizeof (UINT32
);
1126 // Add entry to XSDT, XSDT expects 64 bit pointers, but
1127 // the table pointers in XSDT are not aligned on 8 byte boundary.
1129 Buffer64
= (UINT64
) (UINTN
) CurrentTableList
->Table
;
1139 AcpiSupportInstance
->Xsdt
->Length
= AcpiSupportInstance
->Xsdt
->Length
+ sizeof (UINT64
);
1141 AcpiSupportInstance
->NumberOfTableEntries3
++;
1145 ChecksumCommonTables (AcpiSupportInstance
);
1149 This function finds the table specified by the handle and returns a pointer to it.
1150 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
1153 @param Handle Table to find.
1154 @param TableList Table list to search
1155 @param Table Pointer to table found.
1157 @return EFI_SUCCESS The function completed successfully.
1158 @return EFI_NOT_FOUND No table found matching the handle specified.
1164 IN LIST_ENTRY
*TableList
,
1165 OUT EFI_ACPI_TABLE_LIST
**Table
1168 LIST_ENTRY
*CurrentLink
;
1169 EFI_ACPI_TABLE_LIST
*CurrentTable
;
1172 // Check for invalid input parameters
1179 CurrentLink
= TableList
->ForwardLink
;
1181 while (CurrentLink
!= TableList
) {
1182 CurrentTable
= EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink
);
1183 if (CurrentTable
->Handle
== Handle
) {
1185 // Found handle, so return this table.
1187 *Table
= CurrentTable
;
1191 CurrentLink
= CurrentLink
->ForwardLink
;
1196 return EFI_NOT_FOUND
;
1199 This function removes a basic table from the RSDT and/or XSDT.
1200 For Acpi 1.0 tables, pass in the Rsdt.
1201 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.
1203 @param Table Pointer to table found.
1204 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT
1205 @param Rsdt Pointer to the RSDT to remove from
1206 @param Xsdt Pointer to the Xsdt to remove from
1208 @return EFI_SUCCESS The function completed successfully.
1209 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.
1213 RemoveTableFromRsdt (
1214 IN OUT EFI_ACPI_TABLE_LIST
* Table
,
1215 IN OUT UINTN
*NumberOfTableEntries
,
1216 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Rsdt
,
1217 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Xsdt OPTIONAL
1220 UINT32
*CurrentRsdtEntry
;
1221 VOID
*CurrentXsdtEntry
;
1222 UINT64 CurrentTablePointer64
;
1226 // Check for invalid input parameters
1229 ASSERT (NumberOfTableEntries
);
1233 // Find the table entry in the RSDT and XSDT
1235 for (TempIndex
= 0; TempIndex
< *NumberOfTableEntries
; TempIndex
++) {
1237 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1238 // If it becomes necessary to maintain separate table lists, changes will be required.
1240 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) Rsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + TempIndex
* sizeof (UINT32
));
1243 // This pointer must not be directly dereferenced as the XSDT entries may not
1244 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1246 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + TempIndex
* sizeof (UINT64
));
1249 // Read the entry value out of the XSDT
1251 CopyMem (&CurrentTablePointer64
, CurrentXsdtEntry
, sizeof (UINT64
));
1254 // Initialize to NULL
1256 CurrentXsdtEntry
= 0;
1257 CurrentTablePointer64
= 0;
1260 // Check if we have found the corresponding entry in both RSDT and XSDT
1262 if (*CurrentRsdtEntry
== (UINT32
) (UINTN
) Table
->Table
&&
1263 ((Xsdt
== NULL
) || CurrentTablePointer64
== (UINT64
) (UINTN
) Table
->Table
)
1266 // Found entry, so copy all following entries and shrink table
1267 // We actually copy all + 1 to copy the initialized value of memory over
1270 CopyMem (CurrentRsdtEntry
, CurrentRsdtEntry
+ 1, (*NumberOfTableEntries
- TempIndex
) * sizeof (UINT32
));
1271 Rsdt
->Length
= Rsdt
->Length
- sizeof (UINT32
);
1273 CopyMem (CurrentXsdtEntry
, ((UINT64
*) CurrentXsdtEntry
) + 1, (*NumberOfTableEntries
- TempIndex
) * sizeof (UINT64
));
1274 Xsdt
->Length
= Xsdt
->Length
- sizeof (UINT64
);
1277 } else if (TempIndex
+ 1 == *NumberOfTableEntries
) {
1279 // At the last entry, and table not found
1281 return EFI_INVALID_PARAMETER
;
1285 // Checksum the tables
1287 AcpiPlatformChecksum (
1290 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1295 AcpiPlatformChecksum (
1298 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1303 // Decrement the number of tables
1305 (*NumberOfTableEntries
)--;
1310 This function removes a table and frees any associated memory.
1312 @param AcpiSupportInstance Instance of the protocol.
1313 @param Version Version(s) to delete.
1314 @param Table Pointer to table found.
1316 @return EFI_SUCCESS The function completed successfully.
1321 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
1322 IN EFI_ACPI_TABLE_VERSION Version
,
1323 IN OUT EFI_ACPI_TABLE_LIST
*Table
1326 UINT32 CurrentTableSignature
;
1327 BOOLEAN RemoveFromRsdt
;
1330 // Check for invalid input parameters
1332 ASSERT (AcpiSupportInstance
);
1338 RemoveFromRsdt
= TRUE
;
1340 if (Table
->Table
!= NULL
) {
1341 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
->Table
)->Signature
;
1344 // Basic tasks to accomplish delete are:
1345 // Determine removal requirements (in RSDT/XSDT or not)
1346 // Remove entry from RSDT/XSDT
1347 // Remove any table references to the table
1348 // If no one is using the table
1349 // Free the table (removing pointers from private data and tables)
1351 // Free list structure
1354 // Determine if this table is in the RSDT or XSDT
1356 if ((CurrentTableSignature
== EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
1357 (CurrentTableSignature
== EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
) ||
1358 (CurrentTableSignature
== EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
)
1360 RemoveFromRsdt
= FALSE
;
1363 // We don't remove the FADT in the standard way because some
1364 // OS expect the FADT to be early in the table list.
1365 // So we always put it as the first element in the list.
1367 if (CurrentTableSignature
== EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
1368 RemoveFromRsdt
= FALSE
;
1372 // Remove the table from RSDT and XSDT
1376 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt
1378 if (Version
& EFI_ACPI_TABLE_VERSION_NONE
& Table
->Version
) {
1380 // Remove this version from the table
1382 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_NONE
;
1385 if (Version
& EFI_ACPI_TABLE_VERSION_1_0B
& Table
->Version
) {
1387 // Remove this version from the table
1389 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_1_0B
;
1392 // Remove from Rsdt. We don't care about the return value because it is
1393 // acceptable for the table to not exist in Rsdt.
1394 // We didn't add some tables so we don't remove them.
1396 if (RemoveFromRsdt
) {
1397 RemoveTableFromRsdt (
1399 &AcpiSupportInstance
->NumberOfTableEntries1
,
1400 AcpiSupportInstance
->Rsdt1
,
1406 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) ||
1407 (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
)) {
1409 // Remove this version from the table
1411 if (Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) {
1412 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_2_0
;
1414 if (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
) {
1415 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_3_0
;
1419 // Remove from Rsdt and Xsdt. We don't care about the return value
1420 // because it is acceptable for the table to not exist in Rsdt/Xsdt.
1421 // We didn't add some tables so we don't remove them.
1423 if (RemoveFromRsdt
) {
1424 RemoveTableFromRsdt (
1426 &AcpiSupportInstance
->NumberOfTableEntries3
,
1427 AcpiSupportInstance
->Rsdt3
,
1428 AcpiSupportInstance
->Xsdt
1433 // Free the table, clean up any dependent tables and our private data pointers.
1435 switch (Table
->Table
->Signature
) {
1437 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
1438 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1439 AcpiSupportInstance
->Fadt1
= NULL
;
1442 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1443 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1444 AcpiSupportInstance
->Fadt3
= NULL
;
1448 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
1449 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1450 AcpiSupportInstance
->Facs1
= NULL
;
1453 // Update FADT table pointers
1455 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
1456 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= 0;
1461 AcpiPlatformChecksum (
1462 AcpiSupportInstance
->Fadt1
,
1463 AcpiSupportInstance
->Fadt1
->Header
.Length
,
1464 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1470 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1471 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1472 AcpiSupportInstance
->Facs3
= NULL
;
1475 // Update FADT table pointers
1477 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
1478 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= 0;
1479 ZeroMem (&AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
, sizeof (UINT64
));
1484 AcpiPlatformChecksum (
1485 AcpiSupportInstance
->Fadt3
,
1486 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1487 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1494 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
1495 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1496 AcpiSupportInstance
->Dsdt1
= NULL
;
1499 // Update FADT table pointers
1501 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
1502 AcpiSupportInstance
->Fadt1
->Dsdt
= 0;
1507 AcpiPlatformChecksum (
1508 AcpiSupportInstance
->Fadt1
,
1509 AcpiSupportInstance
->Fadt1
->Header
.Length
,
1510 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1517 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1518 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1519 AcpiSupportInstance
->Dsdt3
= NULL
;
1522 // Update FADT table pointers
1524 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
1525 AcpiSupportInstance
->Fadt3
->Dsdt
= 0;
1526 ZeroMem (&AcpiSupportInstance
->Fadt3
->XDsdt
, sizeof (UINT64
));
1531 AcpiPlatformChecksum (
1532 AcpiSupportInstance
->Fadt3
,
1533 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1534 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1549 // If no version is using this table anymore, remove and free list entry.
1551 if (Table
->Version
== 0) {
1555 gBS
->FreePages (Table
->PageAddress
, Table
->NumberOfPages
);
1556 RemoveEntryList (&(Table
->Link
));
1557 gBS
->FreePool (Table
);
1565 This function finds and removes the table specified by the handle.
1567 @param AcpiSupportInstance Instance of the protocol.
1568 @param Version Bitmask of which versions to remove.
1569 @param Handle Table to remove.
1571 @return EFI_SUCCESS The function completed successfully.
1572 @return EFI_ABORTED An error occurred.
1573 @return EFI_NOT_FOUND Handle not found in table list.
1576 RemoveTableFromList (
1577 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
1578 IN EFI_ACPI_TABLE_VERSION Version
,
1582 EFI_ACPI_TABLE_LIST
*Table
;
1588 // Check for invalid input parameters
1590 ASSERT (AcpiSupportInstance
);
1595 Status
= FindTableByHandle (
1597 &AcpiSupportInstance
->TableList
,
1600 if (EFI_ERROR (Status
)) {
1601 return EFI_NOT_FOUND
;
1606 Status
= DeleteTable (AcpiSupportInstance
, Version
, Table
);
1607 if (EFI_ERROR (Status
)) {
1611 // Completed successfully
1616 This function calculates and updates an UINT8 checksum.
1618 @param Buffer Pointer to buffer to checksum
1619 @param Size Number of bytes to checksum
1620 @param ChecksumOffset Offset to place the checksum result in
1622 @return EFI_SUCCESS The function completed successfully.
1626 AcpiPlatformChecksum (
1629 IN UINTN ChecksumOffset
1637 // Initialize pointer
1642 // set checksum to 0 first
1644 Ptr
[ChecksumOffset
] = 0;
1647 // add all content of buffer
1649 while ((Size
--) != 0) {
1650 Sum
= (UINT8
) (Sum
+ (*Ptr
++));
1656 Ptr
[ChecksumOffset
] = (UINT8
) (0xff - Sum
+ 1);
1661 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
1663 @param AcpiSupportInstance Protocol instance private data.
1665 @return EFI_SUCCESS The function completed successfully.
1669 ChecksumCommonTables (
1670 IN OUT EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
1674 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure
1676 AcpiPlatformChecksum (
1677 AcpiSupportInstance
->Rsdp1
,
1678 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1679 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1684 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure
1686 AcpiPlatformChecksum (
1687 AcpiSupportInstance
->Rsdp3
,
1688 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1689 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1694 // RSDP ACPI 2.0/3.0 checksum, this is the entire table
1696 AcpiPlatformChecksum (
1697 AcpiSupportInstance
->Rsdp3
,
1698 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1699 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1706 AcpiPlatformChecksum (
1707 AcpiSupportInstance
->Rsdt1
,
1708 AcpiSupportInstance
->Rsdt1
->Length
,
1709 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1713 AcpiPlatformChecksum (
1714 AcpiSupportInstance
->Rsdt3
,
1715 AcpiSupportInstance
->Rsdt3
->Length
,
1716 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1723 AcpiPlatformChecksum (
1724 AcpiSupportInstance
->Xsdt
,
1725 AcpiSupportInstance
->Xsdt
->Length
,
1726 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1733 Constructor for the ACPI support protocol to initializes instance data.
1735 @param AcpiSupportInstance Instance to construct
1737 @retval EFI_SUCCESS Instance initialized.
1738 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
1741 AcpiSupportAcpiSupportConstructor (
1742 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
1748 UINTN RsdpTableSize
;
1750 EFI_PHYSICAL_ADDRESS PageAddress
;
1753 // Check for invalid input parameters
1755 ASSERT (AcpiSupportInstance
);
1757 InitializeListHead (&AcpiSupportInstance
->TableList
);
1758 AcpiSupportInstance
->CurrentHandle
= 1;
1759 AcpiSupportInstance
->AcpiSupport
.GetAcpiTable
= GetAcpiTable
;
1760 AcpiSupportInstance
->AcpiSupport
.SetAcpiTable
= SetAcpiTable
;
1761 AcpiSupportInstance
->AcpiSupport
.PublishTables
= PublishTables
;
1763 AcpiSupportInstance
->AcpiTableProtocol
.InstallAcpiTable
= InstallAcpiTable
;
1764 AcpiSupportInstance
->AcpiTableProtocol
.UninstallAcpiTable
= UninstallAcpiTable
;
1767 // Create RSDP table
1769 RsdpTableSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1770 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1772 PageAddress
= 0xFFFFFFFF;
1773 Status
= gBS
->AllocatePages (
1775 EfiACPIReclaimMemory
,
1776 EFI_SIZE_TO_PAGES (RsdpTableSize
),
1780 if (EFI_ERROR (Status
)) {
1781 return EFI_OUT_OF_RESOURCES
;
1784 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1785 ZeroMem (Pointer
, RsdpTableSize
);
1787 AcpiSupportInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1788 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1789 AcpiSupportInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1792 // Create RSDT, XSDT structures
1794 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
1795 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1796 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
1797 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1798 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
1799 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
1802 // Allocate memory in the lower 32 bit of address range for
1803 // compatibility with ACPI 1.0 OS.
1805 // This is done because ACPI 1.0 pointers are 32 bit values.
1806 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
1807 // There is no architectural reason these should be below 4GB, it is purely
1808 // for convenience of implementation that we force memory below 4GB.
1810 PageAddress
= 0xFFFFFFFF;
1811 Status
= gBS
->AllocatePages (
1813 EfiACPIReclaimMemory
,
1814 EFI_SIZE_TO_PAGES (TotalSize
),
1818 if (EFI_ERROR (Status
)) {
1819 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiSupportInstance
->Rsdp1
, EFI_SIZE_TO_PAGES (RsdpTableSize
));
1820 return EFI_OUT_OF_RESOURCES
;
1823 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1824 ZeroMem (Pointer
, TotalSize
);
1826 AcpiSupportInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1827 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1828 AcpiSupportInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1829 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1830 AcpiSupportInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1835 CurrentData
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1836 CopyMem (&AcpiSupportInstance
->Rsdp1
->Signature
, &CurrentData
, sizeof (UINT64
));
1837 CopyMem (AcpiSupportInstance
->Rsdp1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1838 AcpiSupportInstance
->Rsdp1
->Reserved
= EFI_ACPI_RESERVED_BYTE
;
1839 AcpiSupportInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt1
;
1841 CurrentData
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1842 CopyMem (&AcpiSupportInstance
->Rsdp3
->Signature
, &CurrentData
, sizeof (UINT64
));
1843 CopyMem (AcpiSupportInstance
->Rsdp3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1844 AcpiSupportInstance
->Rsdp3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION
;
1845 AcpiSupportInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt3
;
1846 AcpiSupportInstance
->Rsdp3
->Length
= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1847 CurrentData
= (UINT64
) (UINTN
) AcpiSupportInstance
->Xsdt
;
1848 CopyMem (&AcpiSupportInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
1849 SetMem (AcpiSupportInstance
->Rsdp3
->Reserved
, 3, EFI_ACPI_RESERVED_BYTE
);
1854 // Note that we "reserve" one entry for the FADT so it can always be
1855 // at the beginning of the list of tables. Some OS don't seem
1856 // to find it correctly if it is too far down the list.
1858 AcpiSupportInstance
->Rsdt1
->Signature
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1859 AcpiSupportInstance
->Rsdt1
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1860 AcpiSupportInstance
->Rsdt1
->Revision
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1861 CopyMem (AcpiSupportInstance
->Rsdt1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1862 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1863 CopyMem (&AcpiSupportInstance
->Rsdt1
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1864 AcpiSupportInstance
->Rsdt1
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1865 AcpiSupportInstance
->Rsdt1
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1866 AcpiSupportInstance
->Rsdt1
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1868 // We always reserve first one for FADT
1870 AcpiSupportInstance
->NumberOfTableEntries1
= 1;
1871 AcpiSupportInstance
->Rsdt1
->Length
= AcpiSupportInstance
->Rsdt1
->Length
+ sizeof(UINT32
);
1873 AcpiSupportInstance
->Rsdt3
->Signature
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1874 AcpiSupportInstance
->Rsdt3
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1875 AcpiSupportInstance
->Rsdt3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1876 CopyMem (AcpiSupportInstance
->Rsdt3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1877 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1878 CopyMem (&AcpiSupportInstance
->Rsdt3
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1879 AcpiSupportInstance
->Rsdt3
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1880 AcpiSupportInstance
->Rsdt3
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1881 AcpiSupportInstance
->Rsdt3
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1883 // We always reserve first one for FADT
1885 AcpiSupportInstance
->NumberOfTableEntries3
= 1;
1886 AcpiSupportInstance
->Rsdt3
->Length
= AcpiSupportInstance
->Rsdt3
->Length
+ sizeof(UINT32
);
1891 AcpiSupportInstance
->Xsdt
->Signature
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1892 AcpiSupportInstance
->Xsdt
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1893 AcpiSupportInstance
->Xsdt
->Revision
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1894 CopyMem (AcpiSupportInstance
->Xsdt
->OemId
, EFI_ACPI_OEM_ID
, 6);
1895 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1896 CopyMem (&AcpiSupportInstance
->Xsdt
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1897 AcpiSupportInstance
->Xsdt
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1898 AcpiSupportInstance
->Xsdt
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1899 AcpiSupportInstance
->Xsdt
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1901 // We always reserve first one for FADT
1903 AcpiSupportInstance
->Xsdt
->Length
= AcpiSupportInstance
->Xsdt
->Length
+ sizeof(UINT64
);
1905 ChecksumCommonTables (AcpiSupportInstance
);
1908 // Completed successfully