2 ACPI Support Protocol implementation
4 Copyright (c) 2006 - 2013, 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
;
395 // Check for invalid input parameters
397 if ((AcpiTableBuffer
== NULL
) || (TableKey
== NULL
)
398 || (((EFI_ACPI_DESCRIPTION_HEADER
*) AcpiTableBuffer
)->Length
!= AcpiTableBufferSize
)) {
399 return EFI_INVALID_PARAMETER
;
403 // Get the instance of the ACPI support protocol
405 AcpiSupportInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
406 AcpiSupport
= &AcpiSupportInstance
->AcpiSupport
;
409 // Install the ACPI table by using ACPI support protocol
411 AcpiTableBufferConst
= AllocateCopyPool (AcpiTableBufferSize
, AcpiTableBuffer
);
413 Status
= AcpiSupport
->SetAcpiTable (
415 AcpiTableBufferConst
,
417 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
420 if (!EFI_ERROR (Status
)) {
421 Status
= AcpiSupport
->PublishTables (
423 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
426 FreePool (AcpiTableBufferConst
);
431 Removes an ACPI table from the RSDT/XSDT.
433 @param This Protocol instance pointer.
434 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().
436 @return EFI_SUCCESS The table was successfully uninstalled.
437 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.
443 IN EFI_ACPI_TABLE_PROTOCOL
*This
,
447 EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
;
448 EFI_ACPI_SUPPORT_PROTOCOL
*AcpiSupport
;
452 // Get the instance of the ACPI support protocol
454 AcpiSupportInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_ACPI_SUPPORT_THIS (This
);
455 AcpiSupport
= &AcpiSupportInstance
->AcpiSupport
;
458 // Uninstall the ACPI table by using ACPI support protocol
460 Status
= AcpiSupport
->SetAcpiTable (
464 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
467 if (!EFI_ERROR (Status
)) {
468 Status
= AcpiSupport
->PublishTables (
470 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
474 if (EFI_ERROR (Status
)) {
475 return EFI_NOT_FOUND
;
481 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.
483 @param AcpiSupportInstance ACPI support protocol instance data structure
485 @return EFI_SUCCESS reallocate the table beffer successfully.
486 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
490 ReallocateAcpiTableBuffer (
491 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
494 UINTN NewMaxTableNumber
;
497 EFI_PHYSICAL_ADDRESS PageAddress
;
498 EFI_ACPI_SUPPORT_INSTANCE TempPrivateData
;
502 CopyMem (&TempPrivateData
, AcpiSupportInstance
, sizeof (EFI_ACPI_SUPPORT_INSTANCE
));
504 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES
506 NewMaxTableNumber
= mEfiAcpiMaxNumTables
+ EFI_ACPI_MAX_NUM_TABLES
;
508 // Create RSDT, XSDT structures and allocate buffers.
510 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
511 NewMaxTableNumber
* sizeof (UINT32
) +
512 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
513 NewMaxTableNumber
* sizeof (UINT32
) +
514 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
515 NewMaxTableNumber
* sizeof (UINT64
);
518 // Allocate memory in the lower 32 bit of address range for
519 // compatibility with ACPI 1.0 OS.
521 // This is done because ACPI 1.0 pointers are 32 bit values.
522 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
523 // There is no architectural reason these should be below 4GB, it is purely
524 // for convenience of implementation that we force memory below 4GB.
526 PageAddress
= 0xFFFFFFFF;
527 Status
= gBS
->AllocatePages (
529 EfiACPIReclaimMemory
,
530 EFI_SIZE_TO_PAGES (TotalSize
),
534 if (EFI_ERROR (Status
)) {
535 return EFI_OUT_OF_RESOURCES
;
538 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
539 ZeroMem (Pointer
, TotalSize
);
541 AcpiSupportInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
542 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
543 AcpiSupportInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
544 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
545 AcpiSupportInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
548 // Update RSDP to point to the new Rsdt and Xsdt address.
550 AcpiSupportInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt1
;
551 AcpiSupportInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt3
;
552 CurrentData
= (UINT64
) (UINTN
) AcpiSupportInstance
->Xsdt
;
553 CopyMem (&AcpiSupportInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
556 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer
558 CopyMem (AcpiSupportInstance
->Rsdt1
, TempPrivateData
.Rsdt1
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
559 CopyMem (AcpiSupportInstance
->Rsdt3
, TempPrivateData
.Rsdt3
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
560 CopyMem (AcpiSupportInstance
->Xsdt
, TempPrivateData
.Xsdt
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT64
)));
563 // Calculate orignal ACPI table buffer size
565 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
566 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
567 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
568 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
569 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
570 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
571 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)(UINTN
)TempPrivateData
.Rsdt1
, EFI_SIZE_TO_PAGES (TotalSize
));
574 // Update the Max ACPI table number
576 mEfiAcpiMaxNumTables
= NewMaxTableNumber
;
580 This function adds an ACPI table to the table list. It will detect FACS and
581 allocate the correct type of memory and properly align the table.
583 @param AcpiSupportInstance Instance of the protocol.
584 @param Table Table to add.
585 @param Checksum Does the table require checksumming.
586 @param Version The version of the list to add the table to.
587 @param Handle Pointer for returning the handle.
589 @return EFI_SUCCESS The function completed successfully.
590 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
591 @return EFI_ABORTED The table is a duplicate of a table that is required
596 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
599 IN EFI_ACPI_TABLE_VERSION Version
,
604 EFI_ACPI_TABLE_LIST
*CurrentTableList
;
605 UINT32 CurrentTableSignature
;
606 UINT32 CurrentTableSize
;
607 UINT32
*CurrentRsdtEntry
;
608 VOID
*CurrentXsdtEntry
;
613 // Check for invalid input parameters
615 ASSERT (AcpiSupportInstance
);
625 // Create a new list entry
627 CurrentTableList
= AllocatePool (sizeof (EFI_ACPI_TABLE_LIST
));
628 ASSERT (CurrentTableList
);
631 // Determine table type and size
633 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Signature
;
634 CurrentTableSize
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Length
;
637 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space
638 // for backwards compatibility with ACPI 1.0 OS.
640 // This is done because ACPI 1.0 pointers are 32 bit values.
641 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
642 // There is no architectural reason these should be below 4GB, it is purely
643 // for convenience of implementation that we force memory below 4GB.
645 CurrentTableList
->PageAddress
= 0xFFFFFFFF;
646 CurrentTableList
->NumberOfPages
= EFI_SIZE_TO_PAGES (CurrentTableSize
);
649 // Allocation memory type depends on the type of the table
651 if ((CurrentTableSignature
== EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
652 (CurrentTableSignature
== EFI_ACPI_4_0_UEFI_ACPI_DATA_TABLE_SIGNATURE
)) {
654 // Allocate memory for the FACS. This structure must be aligned
655 // on a 64 byte boundary and must be ACPI NVS memory.
656 // Using AllocatePages should ensure that it is always aligned.
657 // Do not change signature for new ACPI version because they are same.
659 // UEFI table also need to be in ACPI NVS memory, because some data field
660 // could be updated by OS present agent. For example, BufferPtrAddress in
661 // SMM communication ACPI table.
663 ASSERT ((EFI_PAGE_SIZE
% 64) == 0);
664 Status
= gBS
->AllocatePages (
667 CurrentTableList
->NumberOfPages
,
668 &CurrentTableList
->PageAddress
672 // All other tables are ACPI reclaim memory, no alignment requirements.
674 Status
= gBS
->AllocatePages (
676 EfiACPIReclaimMemory
,
677 CurrentTableList
->NumberOfPages
,
678 &CurrentTableList
->PageAddress
682 // Check return value from memory alloc.
684 if (EFI_ERROR (Status
)) {
685 gBS
->FreePool (CurrentTableList
);
686 return EFI_OUT_OF_RESOURCES
;
689 // Update the table pointer with the allocated memory start
691 CurrentTableList
->Table
= (EFI_ACPI_COMMON_HEADER
*) (UINTN
) CurrentTableList
->PageAddress
;
694 // Initialize the table contents
696 CurrentTableList
->Signature
= EFI_ACPI_TABLE_LIST_SIGNATURE
;
697 CopyMem (CurrentTableList
->Table
, Table
, CurrentTableSize
);
698 CurrentTableList
->Handle
= AcpiSupportInstance
->CurrentHandle
++;
699 *Handle
= CurrentTableList
->Handle
;
700 CurrentTableList
->Version
= Version
;
703 // Update internal pointers if this is a required table. If it is a required
704 // table and a table of that type already exists, return an error.
706 // Calculate the checksum if the table is not FACS.
708 switch (CurrentTableSignature
) {
710 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
712 // We don't add the FADT in the standard way because some
713 // OS expect the FADT to be early in the table list.
714 // So we always add it as the first element in the list.
719 // Check that the table has not been previously added.
721 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Fadt1
!= NULL
) ||
722 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Fadt3
!= NULL
) ||
723 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Fadt3
!= NULL
)
725 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
726 gBS
->FreePool (CurrentTableList
);
730 // Add the table to the appropriate table version
732 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
734 // Save a pointer to the table
736 AcpiSupportInstance
->Fadt1
= (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
739 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
741 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs1
;
742 AcpiSupportInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt1
;
745 // RSDP OEM information is updated to match the FADT OEM information
748 &AcpiSupportInstance
->Rsdp1
->OemId
,
749 &AcpiSupportInstance
->Fadt1
->Header
.OemId
,
754 // RSDT OEM information is updated to match the FADT OEM information.
757 &AcpiSupportInstance
->Rsdt1
->OemId
,
758 &AcpiSupportInstance
->Fadt1
->Header
.OemId
,
763 &AcpiSupportInstance
->Rsdt1
->OemTableId
,
764 &AcpiSupportInstance
->Fadt1
->Header
.OemTableId
,
767 AcpiSupportInstance
->Rsdt1
->OemRevision
= AcpiSupportInstance
->Fadt1
->Header
.OemRevision
;
770 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
771 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
773 // Save a pointer to the table
775 AcpiSupportInstance
->Fadt3
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
778 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
779 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and
782 if ((UINT64
)(UINTN
)AcpiSupportInstance
->Facs3
< BASE_4GB
) {
783 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs3
;
785 &AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
,
789 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= 0;
790 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Facs3
;
792 &AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
,
797 AcpiSupportInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
798 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
800 &AcpiSupportInstance
->Fadt3
->XDsdt
,
806 // RSDP OEM information is updated to match the FADT OEM information
809 &AcpiSupportInstance
->Rsdp3
->OemId
,
810 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
815 // RSDT OEM information is updated to match FADT OEM information.
818 &AcpiSupportInstance
->Rsdt3
->OemId
,
819 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
823 &AcpiSupportInstance
->Rsdt3
->OemTableId
,
824 &AcpiSupportInstance
->Fadt3
->Header
.OemTableId
,
827 AcpiSupportInstance
->Rsdt3
->OemRevision
= AcpiSupportInstance
->Fadt3
->Header
.OemRevision
;
830 // XSDT OEM information is updated to match FADT OEM information.
833 &AcpiSupportInstance
->Xsdt
->OemId
,
834 &AcpiSupportInstance
->Fadt3
->Header
.OemId
,
838 &AcpiSupportInstance
->Xsdt
->OemTableId
,
839 &AcpiSupportInstance
->Fadt3
->Header
.OemTableId
,
842 AcpiSupportInstance
->Xsdt
->OemRevision
= AcpiSupportInstance
->Fadt3
->Header
.OemRevision
;
846 // Checksum the table
849 AcpiPlatformChecksum (
850 CurrentTableList
->Table
,
851 CurrentTableList
->Table
->Length
,
852 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
858 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
860 // Check that the table has not been previously added.
862 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Facs1
!= NULL
) ||
863 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Facs3
!= NULL
) ||
864 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Facs3
!= NULL
)
866 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
867 gBS
->FreePool (CurrentTableList
);
871 // FACS is referenced by FADT and is not part of RSDT
876 // Add the table to the appropriate table version
878 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
880 // Save a pointer to the table
882 AcpiSupportInstance
->Facs1
= (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
885 // If FADT already exists, update table pointers.
887 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
888 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs1
;
891 // Checksum FADT table
893 AcpiPlatformChecksum (
894 AcpiSupportInstance
->Fadt1
,
895 AcpiSupportInstance
->Fadt1
->Header
.Length
,
896 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
902 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
903 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
905 // Save a pointer to the table
907 AcpiSupportInstance
->Facs3
= (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
910 // If FADT already exists, update table pointers.
912 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
914 // Note: If the FIRMWARE_CTRL is non-zero, then X_FIRMWARE_CTRL must be zero, and
917 if ((UINT64
)(UINTN
)AcpiSupportInstance
->Facs3
< BASE_4GB
) {
918 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiSupportInstance
->Facs3
;
920 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Facs3
;
922 &AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
,
929 // Checksum FADT table
931 AcpiPlatformChecksum (
932 AcpiSupportInstance
->Fadt3
,
933 AcpiSupportInstance
->Fadt3
->Header
.Length
,
934 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
942 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
944 // Check that the table has not been previously added.
946 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiSupportInstance
->Dsdt1
!= NULL
) ||
947 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiSupportInstance
->Dsdt3
!= NULL
) ||
948 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiSupportInstance
->Dsdt3
!= NULL
)
950 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
951 gBS
->FreePool (CurrentTableList
);
955 // DSDT is referenced by FADT and is not part of RSDT
960 // Add the table to the appropriate table version
962 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
964 // Save a pointer to the table
966 AcpiSupportInstance
->Dsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
969 // If FADT already exists, update table pointers.
971 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
972 AcpiSupportInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt1
;
975 // Checksum FADT table
977 AcpiPlatformChecksum (
978 AcpiSupportInstance
->Fadt1
,
979 AcpiSupportInstance
->Fadt1
->Header
.Length
,
980 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
986 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
987 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
989 // Save a pointer to the table
991 AcpiSupportInstance
->Dsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
994 // If FADT already exists, update table pointers.
996 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
997 AcpiSupportInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
998 Buffer64
= (UINT64
) (UINTN
) AcpiSupportInstance
->Dsdt3
;
1000 &AcpiSupportInstance
->Fadt3
->XDsdt
,
1006 // Checksum FADT table
1008 AcpiPlatformChecksum (
1009 AcpiSupportInstance
->Fadt3
,
1010 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1011 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1017 // Checksum the table
1020 AcpiPlatformChecksum (
1021 CurrentTableList
->Table
,
1022 CurrentTableList
->Table
->Length
,
1023 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1031 // Checksum the table
1034 AcpiPlatformChecksum (
1035 CurrentTableList
->Table
,
1036 CurrentTableList
->Table
->Length
,
1037 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1044 // Add the table to the current list of tables
1046 InsertTailList (&AcpiSupportInstance
->TableList
, &CurrentTableList
->Link
);
1049 // Add the table to RSDT and/or XSDT table entry lists.
1052 // Add to ACPI 1.0b table tree
1054 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1057 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1059 if (AcpiSupportInstance
->NumberOfTableEntries1
>= mEfiAcpiMaxNumTables
) {
1060 Status
= ReallocateAcpiTableBuffer (AcpiSupportInstance
);
1061 ASSERT_EFI_ERROR (Status
);
1063 CurrentRsdtEntry
= (UINT32
*)
1065 (UINT8
*) AcpiSupportInstance
->Rsdt1
+
1066 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1067 AcpiSupportInstance
->NumberOfTableEntries1
*
1072 // Add entry to the RSDT unless its the FACS or DSDT
1074 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1077 // Update RSDT length
1079 AcpiSupportInstance
->Rsdt1
->Length
= AcpiSupportInstance
->Rsdt1
->Length
+ sizeof (UINT32
);
1081 AcpiSupportInstance
->NumberOfTableEntries1
++;
1085 // Add to ACPI 2.0/3.0 table tree
1087 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 || (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1090 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1092 if (AcpiSupportInstance
->NumberOfTableEntries3
>= mEfiAcpiMaxNumTables
) {
1093 Status
= ReallocateAcpiTableBuffer (AcpiSupportInstance
);
1094 ASSERT_EFI_ERROR (Status
);
1097 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1098 // If it becomes necessary to maintain separate table lists, changes will be required.
1100 CurrentRsdtEntry
= (UINT32
*)
1102 (UINT8
*) AcpiSupportInstance
->Rsdt3
+
1103 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1104 AcpiSupportInstance
->NumberOfTableEntries3
*
1109 // This pointer must not be directly dereferenced as the XSDT entries may not
1110 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1112 CurrentXsdtEntry
= (VOID
*)
1114 (UINT8
*) AcpiSupportInstance
->Xsdt
+
1115 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1116 AcpiSupportInstance
->NumberOfTableEntries3
*
1121 // Add entry to the RSDT
1123 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1126 // Update RSDT length
1128 AcpiSupportInstance
->Rsdt3
->Length
= AcpiSupportInstance
->Rsdt3
->Length
+ sizeof (UINT32
);
1131 // Add entry to XSDT, XSDT expects 64 bit pointers, but
1132 // the table pointers in XSDT are not aligned on 8 byte boundary.
1134 Buffer64
= (UINT64
) (UINTN
) CurrentTableList
->Table
;
1144 AcpiSupportInstance
->Xsdt
->Length
= AcpiSupportInstance
->Xsdt
->Length
+ sizeof (UINT64
);
1146 AcpiSupportInstance
->NumberOfTableEntries3
++;
1150 ChecksumCommonTables (AcpiSupportInstance
);
1154 This function finds the table specified by the handle and returns a pointer to it.
1155 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
1158 @param Handle Table to find.
1159 @param TableList Table list to search
1160 @param Table Pointer to table found.
1162 @return EFI_SUCCESS The function completed successfully.
1163 @return EFI_NOT_FOUND No table found matching the handle specified.
1169 IN LIST_ENTRY
*TableList
,
1170 OUT EFI_ACPI_TABLE_LIST
**Table
1173 LIST_ENTRY
*CurrentLink
;
1174 EFI_ACPI_TABLE_LIST
*CurrentTable
;
1177 // Check for invalid input parameters
1184 CurrentLink
= TableList
->ForwardLink
;
1186 while (CurrentLink
!= TableList
) {
1187 CurrentTable
= EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink
);
1188 if (CurrentTable
->Handle
== Handle
) {
1190 // Found handle, so return this table.
1192 *Table
= CurrentTable
;
1196 CurrentLink
= CurrentLink
->ForwardLink
;
1201 return EFI_NOT_FOUND
;
1204 This function removes a basic table from the RSDT and/or XSDT.
1205 For Acpi 1.0 tables, pass in the Rsdt.
1206 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.
1208 @param Table Pointer to table found.
1209 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT
1210 @param Rsdt Pointer to the RSDT to remove from
1211 @param Xsdt Pointer to the Xsdt to remove from
1213 @return EFI_SUCCESS The function completed successfully.
1214 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.
1218 RemoveTableFromRsdt (
1219 IN OUT EFI_ACPI_TABLE_LIST
* Table
,
1220 IN OUT UINTN
*NumberOfTableEntries
,
1221 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Rsdt
,
1222 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Xsdt OPTIONAL
1225 UINT32
*CurrentRsdtEntry
;
1226 VOID
*CurrentXsdtEntry
;
1227 UINT64 CurrentTablePointer64
;
1231 // Check for invalid input parameters
1234 ASSERT (NumberOfTableEntries
);
1238 // Find the table entry in the RSDT and XSDT
1240 for (TempIndex
= 0; TempIndex
< *NumberOfTableEntries
; TempIndex
++) {
1242 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1243 // If it becomes necessary to maintain separate table lists, changes will be required.
1245 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) Rsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + TempIndex
* sizeof (UINT32
));
1248 // This pointer must not be directly dereferenced as the XSDT entries may not
1249 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1251 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + TempIndex
* sizeof (UINT64
));
1254 // Read the entry value out of the XSDT
1256 CopyMem (&CurrentTablePointer64
, CurrentXsdtEntry
, sizeof (UINT64
));
1259 // Initialize to NULL
1261 CurrentXsdtEntry
= 0;
1262 CurrentTablePointer64
= 0;
1265 // Check if we have found the corresponding entry in both RSDT and XSDT
1267 if (*CurrentRsdtEntry
== (UINT32
) (UINTN
) Table
->Table
&&
1268 ((Xsdt
== NULL
) || CurrentTablePointer64
== (UINT64
) (UINTN
) Table
->Table
)
1271 // Found entry, so copy all following entries and shrink table
1272 // We actually copy all + 1 to copy the initialized value of memory over
1275 CopyMem (CurrentRsdtEntry
, CurrentRsdtEntry
+ 1, (*NumberOfTableEntries
- TempIndex
) * sizeof (UINT32
));
1276 Rsdt
->Length
= Rsdt
->Length
- sizeof (UINT32
);
1278 CopyMem (CurrentXsdtEntry
, ((UINT64
*) CurrentXsdtEntry
) + 1, (*NumberOfTableEntries
- TempIndex
) * sizeof (UINT64
));
1279 Xsdt
->Length
= Xsdt
->Length
- sizeof (UINT64
);
1282 } else if (TempIndex
+ 1 == *NumberOfTableEntries
) {
1284 // At the last entry, and table not found
1286 return EFI_INVALID_PARAMETER
;
1290 // Checksum the tables
1292 AcpiPlatformChecksum (
1295 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1300 AcpiPlatformChecksum (
1303 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1308 // Decrement the number of tables
1310 (*NumberOfTableEntries
)--;
1315 This function removes a table and frees any associated memory.
1317 @param AcpiSupportInstance Instance of the protocol.
1318 @param Version Version(s) to delete.
1319 @param Table Pointer to table found.
1321 @return EFI_SUCCESS The function completed successfully.
1326 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
1327 IN EFI_ACPI_TABLE_VERSION Version
,
1328 IN OUT EFI_ACPI_TABLE_LIST
*Table
1331 UINT32 CurrentTableSignature
;
1332 BOOLEAN RemoveFromRsdt
;
1335 // Check for invalid input parameters
1337 ASSERT (AcpiSupportInstance
);
1343 RemoveFromRsdt
= TRUE
;
1345 if (Table
->Table
!= NULL
) {
1346 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
->Table
)->Signature
;
1349 // Basic tasks to accomplish delete are:
1350 // Determine removal requirements (in RSDT/XSDT or not)
1351 // Remove entry from RSDT/XSDT
1352 // Remove any table references to the table
1353 // If no one is using the table
1354 // Free the table (removing pointers from private data and tables)
1356 // Free list structure
1359 // Determine if this table is in the RSDT or XSDT
1361 if ((CurrentTableSignature
== EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
1362 (CurrentTableSignature
== EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
) ||
1363 (CurrentTableSignature
== EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
)
1365 RemoveFromRsdt
= FALSE
;
1368 // We don't remove the FADT in the standard way because some
1369 // OS expect the FADT to be early in the table list.
1370 // So we always put it as the first element in the list.
1372 if (CurrentTableSignature
== EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
1373 RemoveFromRsdt
= FALSE
;
1377 // Remove the table from RSDT and XSDT
1381 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt
1383 if (Version
& EFI_ACPI_TABLE_VERSION_NONE
& Table
->Version
) {
1385 // Remove this version from the table
1387 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_NONE
;
1390 if (Version
& EFI_ACPI_TABLE_VERSION_1_0B
& Table
->Version
) {
1392 // Remove this version from the table
1394 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_1_0B
;
1397 // Remove from Rsdt. We don't care about the return value because it is
1398 // acceptable for the table to not exist in Rsdt.
1399 // We didn't add some tables so we don't remove them.
1401 if (RemoveFromRsdt
) {
1402 RemoveTableFromRsdt (
1404 &AcpiSupportInstance
->NumberOfTableEntries1
,
1405 AcpiSupportInstance
->Rsdt1
,
1411 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) ||
1412 (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
)) {
1414 // Remove this version from the table
1416 if (Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) {
1417 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_2_0
;
1419 if (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
) {
1420 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_3_0
;
1424 // Remove from Rsdt and Xsdt. We don't care about the return value
1425 // because it is acceptable for the table to not exist in Rsdt/Xsdt.
1426 // We didn't add some tables so we don't remove them.
1428 if (RemoveFromRsdt
) {
1429 RemoveTableFromRsdt (
1431 &AcpiSupportInstance
->NumberOfTableEntries3
,
1432 AcpiSupportInstance
->Rsdt3
,
1433 AcpiSupportInstance
->Xsdt
1438 // Free the table, clean up any dependent tables and our private data pointers.
1440 switch (Table
->Table
->Signature
) {
1442 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
1443 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1444 AcpiSupportInstance
->Fadt1
= NULL
;
1447 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1448 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1449 AcpiSupportInstance
->Fadt3
= NULL
;
1453 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
1454 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1455 AcpiSupportInstance
->Facs1
= NULL
;
1458 // Update FADT table pointers
1460 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
1461 AcpiSupportInstance
->Fadt1
->FirmwareCtrl
= 0;
1466 AcpiPlatformChecksum (
1467 AcpiSupportInstance
->Fadt1
,
1468 AcpiSupportInstance
->Fadt1
->Header
.Length
,
1469 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1475 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1476 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1477 AcpiSupportInstance
->Facs3
= NULL
;
1480 // Update FADT table pointers
1482 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
1483 AcpiSupportInstance
->Fadt3
->FirmwareCtrl
= 0;
1484 ZeroMem (&AcpiSupportInstance
->Fadt3
->XFirmwareCtrl
, sizeof (UINT64
));
1489 AcpiPlatformChecksum (
1490 AcpiSupportInstance
->Fadt3
,
1491 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1492 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1499 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
1500 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1501 AcpiSupportInstance
->Dsdt1
= NULL
;
1504 // Update FADT table pointers
1506 if (AcpiSupportInstance
->Fadt1
!= NULL
) {
1507 AcpiSupportInstance
->Fadt1
->Dsdt
= 0;
1512 AcpiPlatformChecksum (
1513 AcpiSupportInstance
->Fadt1
,
1514 AcpiSupportInstance
->Fadt1
->Header
.Length
,
1515 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1522 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1523 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1524 AcpiSupportInstance
->Dsdt3
= NULL
;
1527 // Update FADT table pointers
1529 if (AcpiSupportInstance
->Fadt3
!= NULL
) {
1530 AcpiSupportInstance
->Fadt3
->Dsdt
= 0;
1531 ZeroMem (&AcpiSupportInstance
->Fadt3
->XDsdt
, sizeof (UINT64
));
1536 AcpiPlatformChecksum (
1537 AcpiSupportInstance
->Fadt3
,
1538 AcpiSupportInstance
->Fadt3
->Header
.Length
,
1539 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1554 // If no version is using this table anymore, remove and free list entry.
1556 if (Table
->Version
== 0) {
1560 gBS
->FreePages (Table
->PageAddress
, Table
->NumberOfPages
);
1561 RemoveEntryList (&(Table
->Link
));
1562 gBS
->FreePool (Table
);
1570 This function finds and removes the table specified by the handle.
1572 @param AcpiSupportInstance Instance of the protocol.
1573 @param Version Bitmask of which versions to remove.
1574 @param Handle Table to remove.
1576 @return EFI_SUCCESS The function completed successfully.
1577 @return EFI_ABORTED An error occurred.
1578 @return EFI_NOT_FOUND Handle not found in table list.
1581 RemoveTableFromList (
1582 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
,
1583 IN EFI_ACPI_TABLE_VERSION Version
,
1587 EFI_ACPI_TABLE_LIST
*Table
;
1593 // Check for invalid input parameters
1595 ASSERT (AcpiSupportInstance
);
1600 Status
= FindTableByHandle (
1602 &AcpiSupportInstance
->TableList
,
1605 if (EFI_ERROR (Status
)) {
1606 return EFI_NOT_FOUND
;
1611 Status
= DeleteTable (AcpiSupportInstance
, Version
, Table
);
1612 if (EFI_ERROR (Status
)) {
1616 // Completed successfully
1621 This function calculates and updates an UINT8 checksum.
1623 @param Buffer Pointer to buffer to checksum
1624 @param Size Number of bytes to checksum
1625 @param ChecksumOffset Offset to place the checksum result in
1627 @return EFI_SUCCESS The function completed successfully.
1631 AcpiPlatformChecksum (
1634 IN UINTN ChecksumOffset
1642 // Initialize pointer
1647 // set checksum to 0 first
1649 Ptr
[ChecksumOffset
] = 0;
1652 // add all content of buffer
1654 while ((Size
--) != 0) {
1655 Sum
= (UINT8
) (Sum
+ (*Ptr
++));
1661 Ptr
[ChecksumOffset
] = (UINT8
) (0xff - Sum
+ 1);
1666 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
1668 @param AcpiSupportInstance Protocol instance private data.
1670 @return EFI_SUCCESS The function completed successfully.
1674 ChecksumCommonTables (
1675 IN OUT EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
1679 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure
1681 AcpiPlatformChecksum (
1682 AcpiSupportInstance
->Rsdp1
,
1683 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1684 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1689 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure
1691 AcpiPlatformChecksum (
1692 AcpiSupportInstance
->Rsdp3
,
1693 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1694 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1699 // RSDP ACPI 2.0/3.0 checksum, this is the entire table
1701 AcpiPlatformChecksum (
1702 AcpiSupportInstance
->Rsdp3
,
1703 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1704 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1711 AcpiPlatformChecksum (
1712 AcpiSupportInstance
->Rsdt1
,
1713 AcpiSupportInstance
->Rsdt1
->Length
,
1714 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1718 AcpiPlatformChecksum (
1719 AcpiSupportInstance
->Rsdt3
,
1720 AcpiSupportInstance
->Rsdt3
->Length
,
1721 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1728 AcpiPlatformChecksum (
1729 AcpiSupportInstance
->Xsdt
,
1730 AcpiSupportInstance
->Xsdt
->Length
,
1731 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1738 Constructor for the ACPI support protocol to initializes instance data.
1740 @param AcpiSupportInstance Instance to construct
1742 @retval EFI_SUCCESS Instance initialized.
1743 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
1746 AcpiSupportAcpiSupportConstructor (
1747 IN EFI_ACPI_SUPPORT_INSTANCE
*AcpiSupportInstance
1753 UINTN RsdpTableSize
;
1755 EFI_PHYSICAL_ADDRESS PageAddress
;
1758 // Check for invalid input parameters
1760 ASSERT (AcpiSupportInstance
);
1762 InitializeListHead (&AcpiSupportInstance
->TableList
);
1763 AcpiSupportInstance
->CurrentHandle
= 1;
1764 AcpiSupportInstance
->AcpiSupport
.GetAcpiTable
= GetAcpiTable
;
1765 AcpiSupportInstance
->AcpiSupport
.SetAcpiTable
= SetAcpiTable
;
1766 AcpiSupportInstance
->AcpiSupport
.PublishTables
= PublishTables
;
1768 AcpiSupportInstance
->AcpiTableProtocol
.InstallAcpiTable
= InstallAcpiTable
;
1769 AcpiSupportInstance
->AcpiTableProtocol
.UninstallAcpiTable
= UninstallAcpiTable
;
1772 // Create RSDP table
1774 RsdpTableSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1775 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1777 PageAddress
= 0xFFFFFFFF;
1778 Status
= gBS
->AllocatePages (
1780 EfiACPIReclaimMemory
,
1781 EFI_SIZE_TO_PAGES (RsdpTableSize
),
1785 if (EFI_ERROR (Status
)) {
1786 return EFI_OUT_OF_RESOURCES
;
1789 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1790 ZeroMem (Pointer
, RsdpTableSize
);
1792 AcpiSupportInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1793 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1794 AcpiSupportInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1797 // Create RSDT, XSDT structures
1799 TotalSize
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
1800 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1801 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
1802 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1803 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
1804 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
1807 // Allocate memory in the lower 32 bit of address range for
1808 // compatibility with ACPI 1.0 OS.
1810 // This is done because ACPI 1.0 pointers are 32 bit values.
1811 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
1812 // There is no architectural reason these should be below 4GB, it is purely
1813 // for convenience of implementation that we force memory below 4GB.
1815 PageAddress
= 0xFFFFFFFF;
1816 Status
= gBS
->AllocatePages (
1818 EfiACPIReclaimMemory
,
1819 EFI_SIZE_TO_PAGES (TotalSize
),
1823 if (EFI_ERROR (Status
)) {
1824 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiSupportInstance
->Rsdp1
, EFI_SIZE_TO_PAGES (RsdpTableSize
));
1825 return EFI_OUT_OF_RESOURCES
;
1828 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1829 ZeroMem (Pointer
, TotalSize
);
1831 AcpiSupportInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1832 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1833 AcpiSupportInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1834 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1835 AcpiSupportInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1840 CurrentData
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1841 CopyMem (&AcpiSupportInstance
->Rsdp1
->Signature
, &CurrentData
, sizeof (UINT64
));
1842 CopyMem (AcpiSupportInstance
->Rsdp1
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (AcpiSupportInstance
->Rsdp1
->OemId
));
1843 AcpiSupportInstance
->Rsdp1
->Reserved
= EFI_ACPI_RESERVED_BYTE
;
1844 AcpiSupportInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt1
;
1846 CurrentData
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1847 CopyMem (&AcpiSupportInstance
->Rsdp3
->Signature
, &CurrentData
, sizeof (UINT64
));
1848 CopyMem (AcpiSupportInstance
->Rsdp3
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (AcpiSupportInstance
->Rsdp3
->OemId
));
1849 AcpiSupportInstance
->Rsdp3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION
;
1850 AcpiSupportInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiSupportInstance
->Rsdt3
;
1851 AcpiSupportInstance
->Rsdp3
->Length
= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1852 CurrentData
= (UINT64
) (UINTN
) AcpiSupportInstance
->Xsdt
;
1853 CopyMem (&AcpiSupportInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
1854 SetMem (AcpiSupportInstance
->Rsdp3
->Reserved
, 3, EFI_ACPI_RESERVED_BYTE
);
1859 // Note that we "reserve" one entry for the FADT so it can always be
1860 // at the beginning of the list of tables. Some OS don't seem
1861 // to find it correctly if it is too far down the list.
1863 AcpiSupportInstance
->Rsdt1
->Signature
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1864 AcpiSupportInstance
->Rsdt1
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1865 AcpiSupportInstance
->Rsdt1
->Revision
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1866 CopyMem (AcpiSupportInstance
->Rsdt1
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (AcpiSupportInstance
->Rsdt1
->OemId
));
1867 CurrentData
= PcdGet64 (PcdAcpiDefaultOemTableId
);
1868 CopyMem (&AcpiSupportInstance
->Rsdt1
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1869 AcpiSupportInstance
->Rsdt1
->OemRevision
= PcdGet32 (PcdAcpiDefaultOemRevision
);
1870 AcpiSupportInstance
->Rsdt1
->CreatorId
= PcdGet32 (PcdAcpiDefaultCreatorId
);
1871 AcpiSupportInstance
->Rsdt1
->CreatorRevision
= PcdGet32 (PcdAcpiDefaultCreatorRevision
);
1873 // We always reserve first one for FADT
1875 AcpiSupportInstance
->NumberOfTableEntries1
= 1;
1876 AcpiSupportInstance
->Rsdt1
->Length
= AcpiSupportInstance
->Rsdt1
->Length
+ sizeof(UINT32
);
1878 AcpiSupportInstance
->Rsdt3
->Signature
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1879 AcpiSupportInstance
->Rsdt3
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1880 AcpiSupportInstance
->Rsdt3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1881 CopyMem (AcpiSupportInstance
->Rsdt3
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (AcpiSupportInstance
->Rsdt3
->OemId
));
1882 CurrentData
= PcdGet64 (PcdAcpiDefaultOemTableId
);
1883 CopyMem (&AcpiSupportInstance
->Rsdt3
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1884 AcpiSupportInstance
->Rsdt3
->OemRevision
= PcdGet32 (PcdAcpiDefaultOemRevision
);
1885 AcpiSupportInstance
->Rsdt3
->CreatorId
= PcdGet32 (PcdAcpiDefaultCreatorId
);
1886 AcpiSupportInstance
->Rsdt3
->CreatorRevision
= PcdGet32 (PcdAcpiDefaultCreatorRevision
);
1888 // We always reserve first one for FADT
1890 AcpiSupportInstance
->NumberOfTableEntries3
= 1;
1891 AcpiSupportInstance
->Rsdt3
->Length
= AcpiSupportInstance
->Rsdt3
->Length
+ sizeof(UINT32
);
1896 AcpiSupportInstance
->Xsdt
->Signature
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1897 AcpiSupportInstance
->Xsdt
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1898 AcpiSupportInstance
->Xsdt
->Revision
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1899 CopyMem (AcpiSupportInstance
->Xsdt
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (AcpiSupportInstance
->Xsdt
->OemId
));
1900 CurrentData
= PcdGet64 (PcdAcpiDefaultOemTableId
);
1901 CopyMem (&AcpiSupportInstance
->Xsdt
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1902 AcpiSupportInstance
->Xsdt
->OemRevision
= PcdGet32 (PcdAcpiDefaultOemRevision
);
1903 AcpiSupportInstance
->Xsdt
->CreatorId
= PcdGet32 (PcdAcpiDefaultCreatorId
);
1904 AcpiSupportInstance
->Xsdt
->CreatorRevision
= PcdGet32 (PcdAcpiDefaultCreatorRevision
);
1906 // We always reserve first one for FADT
1908 AcpiSupportInstance
->Xsdt
->Length
= AcpiSupportInstance
->Xsdt
->Length
+ sizeof(UINT64
);
1910 ChecksumCommonTables (AcpiSupportInstance
);
1913 // Completed successfully