2 ACPI Table Protocol Implementation
4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include "AcpiTable.h"
20 // The maximum number of tables that pre-allocated.
22 UINTN mEfiAcpiMaxNumTables
= EFI_ACPI_MAX_NUM_TABLES
;
25 This function adds an ACPI table to the table list. It will detect FACS and
26 allocate the correct type of memory and properly align the table.
28 @param AcpiTableInstance Instance of the protocol.
29 @param Table Table to add.
30 @param Checksum Does the table require checksumming.
31 @param Version The version of the list to add the table to.
32 @param Handle Pointer for returning the handle.
34 @return EFI_SUCCESS The function completed successfully.
35 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
36 @return EFI_ABORTED The table is a duplicate of a table that is required
42 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
45 IN EFI_ACPI_TABLE_VERSION Version
,
50 This function finds and removes the table specified by the handle.
52 @param AcpiTableInstance Instance of the protocol.
53 @param Version Bitmask of which versions to remove.
54 @param Handle Table to remove.
56 @return EFI_SUCCESS The function completed successfully.
57 @return EFI_ABORTED An error occurred.
58 @return EFI_NOT_FOUND Handle not found in table list.
63 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
64 IN EFI_ACPI_TABLE_VERSION Version
,
69 This function calculates and updates an UINT8 checksum.
71 @param Buffer Pointer to buffer to checksum
72 @param Size Number of bytes to checksum
73 @param ChecksumOffset Offset to place the checksum result in
75 @return EFI_SUCCESS The function completed successfully.
78 AcpiPlatformChecksum (
81 IN UINTN ChecksumOffset
85 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
87 @param AcpiTableInstance Protocol instance private data.
89 @return EFI_SUCCESS The function completed successfully.
93 ChecksumCommonTables (
94 IN OUT EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
98 // Protocol function implementations.
102 This function adds, removes, or updates ACPI tables. If the address is not
103 null and the handle value is null, the table is added. If both the address and
104 handle are not null, the table at handle is updated with the table at address.
105 If the address is null and the handle is not, the table at handle is deleted.
107 @param AcpiTableInstance Instance of the protocol.
108 @param Table Pointer to a table.
109 @param Checksum Boolean indicating if the checksum should be calculated.
110 @param Version Version(s) to set.
111 @param Handle Handle of the table.
113 @return EFI_SUCCESS The function completed successfully.
114 @return EFI_INVALID_PARAMETER Both the Table and *Handle were NULL.
115 @return EFI_ABORTED Could not complete the desired request.
121 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
122 IN VOID
*Table OPTIONAL
,
124 IN EFI_ACPI_TABLE_VERSION Version
,
132 // Check for invalid input parameters
140 // Determine desired action
145 // Invalid parameter combination
147 return EFI_INVALID_PARAMETER
;
152 Status
= AddTableToList (AcpiTableInstance
, Table
, Checksum
, Version
, Handle
);
160 // Delete the table list entry
162 Status
= RemoveTableFromList (AcpiTableInstance
, Version
, *Handle
);
163 if (EFI_ERROR (Status
)) {
165 // Should not get an error here ever, but abort if we do.
170 // Set the handle to replace the table at the same handle
172 SavedHandle
= AcpiTableInstance
->CurrentHandle
;
173 AcpiTableInstance
->CurrentHandle
= *Handle
;
178 Status
= AddTableToList (AcpiTableInstance
, Table
, Checksum
, Version
, Handle
);
181 // Restore the saved current handle
183 AcpiTableInstance
->CurrentHandle
= SavedHandle
;
188 Status
= RemoveTableFromList (AcpiTableInstance
, Version
, *Handle
);
192 if (EFI_ERROR (Status
)) {
194 // Should not get an error here ever, but abort if we do.
205 This function publishes the specified versions of the ACPI tables by
206 installing EFI configuration table entries for them. Any combination of
207 table versions can be published.
209 @param AcpiTableInstance Instance of the protocol.
210 @param Version Version(s) to publish.
212 @return EFI_SUCCESS The function completed successfully.
213 @return EFI_ABORTED The function could not complete successfully.
219 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
220 IN EFI_ACPI_TABLE_VERSION Version
224 UINT32
*CurrentRsdtEntry
;
225 VOID
*CurrentXsdtEntry
;
229 // Reorder tables as some operating systems don't seem to find the
230 // FADT correctly if it is not in the first few entries
234 // Add FADT as the first entry
236 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
237 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiTableInstance
->Rsdt1
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
238 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiTableInstance
->Fadt1
;
240 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
241 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
242 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) AcpiTableInstance
->Rsdt3
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
243 *CurrentRsdtEntry
= (UINT32
) (UINTN
) AcpiTableInstance
->Fadt3
;
244 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) AcpiTableInstance
->Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
));
246 // Add entry to XSDT, XSDT expects 64 bit pointers, but
247 // the table pointers in XSDT are not aligned on 8 byte boundary.
249 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Fadt3
;
258 // Do checksum again because Dsdt/Xsdt is updated.
260 ChecksumCommonTables (AcpiTableInstance
);
263 // Add the RSD_PTR to the system table and store that we have installed the
266 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) &&
267 !AcpiTableInstance
->TablesInstalled1
) {
268 Status
= gBS
->InstallConfigurationTable (&gEfiAcpi10TableGuid
, AcpiTableInstance
->Rsdp1
);
269 if (EFI_ERROR (Status
)) {
273 AcpiTableInstance
->TablesInstalled1
= TRUE
;
276 if (((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
277 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) &&
278 !AcpiTableInstance
->TablesInstalled3
) {
279 Status
= gBS
->InstallConfigurationTable (&gEfiAcpiTableGuid
, AcpiTableInstance
->Rsdp3
);
280 if (EFI_ERROR (Status
)) {
284 AcpiTableInstance
->TablesInstalled3
= TRUE
;
292 Installs an ACPI table into the RSDT/XSDT.
293 Note that the ACPI table should be checksumed before installing it.
294 Otherwise it will assert.
296 @param This Protocol instance pointer.
297 @param AcpiTableBuffer A pointer to a buffer containing the ACPI table to be installed.
298 @param AcpiTableBufferSize Specifies the size, in bytes, of the AcpiTableBuffer buffer.
299 @param TableKey Reurns a key to refer to the ACPI table.
301 @return EFI_SUCCESS The table was successfully inserted.
302 @return EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize
303 and the size field embedded in the ACPI table pointed to by AcpiTableBuffer
305 @return EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request.
311 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
312 IN CONST VOID
*AcpiTableBuffer
,
313 IN UINTN AcpiTableBufferSize
,
317 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
;
319 VOID
*AcpiTableBufferConst
;
324 // Check for invalid input parameters
326 if ((AcpiTableBuffer
== NULL
) || (TableKey
== NULL
)
327 || (((EFI_ACPI_DESCRIPTION_HEADER
*) AcpiTableBuffer
)->Length
!= AcpiTableBufferSize
)) {
328 return EFI_INVALID_PARAMETER
;
331 Length
= ((EFI_ACPI_COMMON_HEADER
*) AcpiTableBuffer
)->Length
;
332 Checksum
= CalculateCheckSum8 ((UINT8
*)AcpiTableBuffer
, Length
);
333 ASSERT (Checksum
== 0);
336 // Get the instance of the ACPI table protocol
338 AcpiTableInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This
);
341 // Install the ACPI table
343 AcpiTableBufferConst
= AllocateCopyPool (AcpiTableBufferSize
,AcpiTableBuffer
);
345 Status
= SetAcpiTable (
347 AcpiTableBufferConst
,
349 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
352 if (!EFI_ERROR (Status
)) {
353 Status
= PublishTables (
355 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
358 FreePool (AcpiTableBufferConst
);
361 // Add a new table successfully, notify registed callback
363 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol
)) {
364 if (!EFI_ERROR (Status
)) {
367 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
378 Removes an ACPI table from the RSDT/XSDT.
380 @param This Protocol instance pointer.
381 @param TableKey Specifies the table to uninstall. The key was returned from InstallAcpiTable().
383 @return EFI_SUCCESS The table was successfully uninstalled.
384 @return EFI_NOT_FOUND TableKey does not refer to a valid key for a table entry.
390 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
394 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
;
398 // Get the instance of the ACPI table protocol
400 AcpiTableInstance
= EFI_ACPI_TABLE_INSTANCE_FROM_THIS (This
);
403 // Uninstall the ACPI table
405 Status
= SetAcpiTable (
409 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
,
412 if (!EFI_ERROR (Status
)) {
413 Status
= PublishTables (
415 EFI_ACPI_TABLE_VERSION_1_0B
| EFI_ACPI_TABLE_VERSION_2_0
| EFI_ACPI_TABLE_VERSION_3_0
419 if (EFI_ERROR (Status
)) {
420 return EFI_NOT_FOUND
;
427 If the number of APCI tables exceeds the preallocated max table number, enlarge the table buffer.
429 @param AcpiTableInstance ACPI table protocol instance data structure.
431 @return EFI_SUCCESS reallocate the table beffer successfully.
432 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
436 ReallocateAcpiTableBuffer (
437 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
440 UINTN NewMaxTableNumber
;
443 EFI_PHYSICAL_ADDRESS PageAddress
;
444 EFI_ACPI_TABLE_INSTANCE TempPrivateData
;
448 CopyMem (&TempPrivateData
, AcpiTableInstance
, sizeof (EFI_ACPI_TABLE_INSTANCE
));
450 // Enlarge the max table number from mEfiAcpiMaxNumTables to mEfiAcpiMaxNumTables + EFI_ACPI_MAX_NUM_TABLES
452 NewMaxTableNumber
= mEfiAcpiMaxNumTables
+ EFI_ACPI_MAX_NUM_TABLES
;
454 // Create RSDP, RSDT, XSDT structures and allocate all buffers
456 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
457 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
458 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
459 NewMaxTableNumber
* sizeof (UINT32
) +
460 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
461 NewMaxTableNumber
* sizeof (UINT32
) +
462 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
463 NewMaxTableNumber
* sizeof (UINT64
);
466 // Allocate memory in the lower 32 bit of address range for
467 // compatibility with ACPI 1.0 OS.
469 // This is done because ACPI 1.0 pointers are 32 bit values.
470 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
471 // There is no architectural reason these should be below 4GB, it is purely
472 // for convenience of implementation that we force memory below 4GB.
474 PageAddress
= 0xFFFFFFFF;
475 Status
= gBS
->AllocatePages (
477 EfiACPIReclaimMemory
,
478 EFI_SIZE_TO_PAGES (TotalSize
),
482 if (EFI_ERROR (Status
)) {
483 return EFI_OUT_OF_RESOURCES
;
486 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
487 ZeroMem (Pointer
, TotalSize
);
489 AcpiTableInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
490 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
491 AcpiTableInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
492 Pointer
+= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
494 AcpiTableInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
495 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
496 AcpiTableInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
497 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + NewMaxTableNumber
* sizeof (UINT32
));
499 AcpiTableInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
504 CopyMem (AcpiTableInstance
->Rsdp1
, TempPrivateData
.Rsdp1
, sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
));
505 AcpiTableInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt1
;
507 CopyMem (AcpiTableInstance
->Rsdp3
, TempPrivateData
.Rsdp3
, sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
));
508 AcpiTableInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt3
;
509 CurrentData
= (UINT64
) (UINTN
) AcpiTableInstance
->Xsdt
;
510 CopyMem (&AcpiTableInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
513 // copy the original Rsdt1, Rsdt3 and Xsdt structure to new buffer
515 CopyMem (AcpiTableInstance
->Rsdt1
, TempPrivateData
.Rsdt1
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
516 CopyMem (AcpiTableInstance
->Rsdt3
, TempPrivateData
.Rsdt3
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT32
)));
517 CopyMem (AcpiTableInstance
->Xsdt
, TempPrivateData
.Xsdt
, (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + mEfiAcpiMaxNumTables
* sizeof (UINT64
)));
520 // Calculate orignal ACPI table buffer size
522 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
523 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
524 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
525 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
526 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
527 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
528 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
529 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
530 gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
)(UINTN
)TempPrivateData
.Rsdp1
, EFI_SIZE_TO_PAGES (TotalSize
));
533 // Update the Max ACPI table number
535 mEfiAcpiMaxNumTables
= NewMaxTableNumber
;
539 This function adds an ACPI table to the table list. It will detect FACS and
540 allocate the correct type of memory and properly align the table.
542 @param AcpiTableInstance Instance of the protocol.
543 @param Table Table to add.
544 @param Checksum Does the table require checksumming.
545 @param Version The version of the list to add the table to.
546 @param Handle Pointer for returning the handle.
548 @return EFI_SUCCESS The function completed successfully.
549 @return EFI_OUT_OF_RESOURCES Could not allocate a required resource.
550 @return EFI_ABORTED The table is a duplicate of a table that is required
556 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
559 IN EFI_ACPI_TABLE_VERSION Version
,
564 EFI_ACPI_TABLE_LIST
*CurrentTableList
;
565 UINT32 CurrentTableSignature
;
566 UINT32 CurrentTableSize
;
567 UINT32
*CurrentRsdtEntry
;
568 VOID
*CurrentXsdtEntry
;
573 // Check for invalid input parameters
575 ASSERT (AcpiTableInstance
);
585 // Create a new list entry
587 CurrentTableList
= AllocatePool (sizeof (EFI_ACPI_TABLE_LIST
));
588 ASSERT (CurrentTableList
);
591 // Determine table type and size
593 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Signature
;
594 CurrentTableSize
= ((EFI_ACPI_COMMON_HEADER
*) Table
)->Length
;
597 // Allocate a buffer for the table. All tables are allocated in the lower 32 bits of address space
598 // for backwards compatibility with ACPI 1.0 OS.
600 // This is done because ACPI 1.0 pointers are 32 bit values.
601 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
602 // There is no architectural reason these should be below 4GB, it is purely
603 // for convenience of implementation that we force memory below 4GB.
605 CurrentTableList
->PageAddress
= 0xFFFFFFFF;
606 CurrentTableList
->NumberOfPages
= EFI_SIZE_TO_PAGES (CurrentTableSize
);
609 // Allocation memory type depends on the type of the table
611 if (CurrentTableSignature
== EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
||
612 CurrentTableSignature
== EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) {
614 // Allocate memory for the FACS. This structure must be aligned
615 // on a 64 byte boundary and must be ACPI NVS memory.
616 // Using AllocatePages should ensure that it is always aligned.
618 ASSERT ((EFI_PAGE_SIZE
% 64) == 0);
619 Status
= gBS
->AllocatePages (
622 CurrentTableList
->NumberOfPages
,
623 &CurrentTableList
->PageAddress
627 // All other tables are ACPI reclaim memory, no alignment requirements.
629 Status
= gBS
->AllocatePages (
631 EfiACPIReclaimMemory
,
632 CurrentTableList
->NumberOfPages
,
633 &CurrentTableList
->PageAddress
637 // Check return value from memory alloc.
639 if (EFI_ERROR (Status
)) {
640 gBS
->FreePool (CurrentTableList
);
641 return EFI_OUT_OF_RESOURCES
;
644 // Update the table pointer with the allocated memory start
646 CurrentTableList
->Table
= (EFI_ACPI_COMMON_HEADER
*) (UINTN
) CurrentTableList
->PageAddress
;
649 // Initialize the table contents
651 CurrentTableList
->Signature
= EFI_ACPI_TABLE_LIST_SIGNATURE
;
652 CopyMem (CurrentTableList
->Table
, Table
, CurrentTableSize
);
653 CurrentTableList
->Handle
= AcpiTableInstance
->CurrentHandle
++;
654 *Handle
= CurrentTableList
->Handle
;
655 CurrentTableList
->Version
= Version
;
658 // Update internal pointers if this is a required table. If it is a required
659 // table and a table of that type already exists, return an error.
661 // Calculate the checksum if the table is not FACS.
663 switch (CurrentTableSignature
) {
665 case EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
667 // We don't add the FADT in the standard way because some
668 // OS expect the FADT to be early in the table list.
669 // So we always add it as the first element in the list.
674 // Check that the table has not been previously added.
676 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Fadt1
!= NULL
) ||
677 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Fadt3
!= NULL
) ||
678 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Fadt3
!= NULL
)
680 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
681 gBS
->FreePool (CurrentTableList
);
685 // Add the table to the appropriate table version
687 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
689 // Save a pointer to the table
691 AcpiTableInstance
->Fadt1
= (EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
694 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
696 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs1
;
697 AcpiTableInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt1
;
700 // RSDP OEM information is updated to match the FADT OEM information
703 &AcpiTableInstance
->Rsdp1
->OemId
,
704 &AcpiTableInstance
->Fadt1
->Header
.OemId
,
709 // RSDT OEM information is updated to match the FADT OEM information.
712 &AcpiTableInstance
->Rsdt1
->OemId
,
713 &AcpiTableInstance
->Fadt1
->Header
.OemId
,
718 &AcpiTableInstance
->Rsdt1
->OemTableId
,
719 &AcpiTableInstance
->Fadt1
->Header
.OemTableId
,
722 AcpiTableInstance
->Rsdt1
->OemRevision
= AcpiTableInstance
->Fadt1
->Header
.OemRevision
;
725 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
726 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
728 // Save a pointer to the table
730 AcpiTableInstance
->Fadt3
= (EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*) CurrentTableList
->Table
;
733 // Update pointers in FADT. If tables don't exist this will put NULL pointers there.
735 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs3
;
736 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Facs3
;
738 &AcpiTableInstance
->Fadt3
->XFirmwareCtrl
,
742 AcpiTableInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt3
;
743 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Dsdt3
;
745 &AcpiTableInstance
->Fadt3
->XDsdt
,
751 // RSDP OEM information is updated to match the FADT OEM information
754 &AcpiTableInstance
->Rsdp3
->OemId
,
755 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
760 // RSDT OEM information is updated to match FADT OEM information.
763 &AcpiTableInstance
->Rsdt3
->OemId
,
764 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
768 &AcpiTableInstance
->Rsdt3
->OemTableId
,
769 &AcpiTableInstance
->Fadt3
->Header
.OemTableId
,
772 AcpiTableInstance
->Rsdt3
->OemRevision
= AcpiTableInstance
->Fadt3
->Header
.OemRevision
;
775 // XSDT OEM information is updated to match FADT OEM information.
778 &AcpiTableInstance
->Xsdt
->OemId
,
779 &AcpiTableInstance
->Fadt3
->Header
.OemId
,
783 &AcpiTableInstance
->Xsdt
->OemTableId
,
784 &AcpiTableInstance
->Fadt3
->Header
.OemTableId
,
787 AcpiTableInstance
->Xsdt
->OemRevision
= AcpiTableInstance
->Fadt3
->Header
.OemRevision
;
790 // Checksum the table
793 AcpiPlatformChecksum (
794 CurrentTableList
->Table
,
795 CurrentTableList
->Table
->Length
,
796 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
802 case EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
804 // Check that the table has not been previously added.
806 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Facs1
!= NULL
) ||
807 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Facs3
!= NULL
) ||
808 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Facs3
!= NULL
)
810 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
811 gBS
->FreePool (CurrentTableList
);
815 // FACS is referenced by FADT and is not part of RSDT
820 // Add the table to the appropriate table version
822 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
824 // Save a pointer to the table
826 AcpiTableInstance
->Facs1
= (EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
829 // If FADT already exists, update table pointers.
831 if (AcpiTableInstance
->Fadt1
!= NULL
) {
832 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs1
;
835 // Checksum FADT table
837 AcpiPlatformChecksum (
838 AcpiTableInstance
->Fadt1
,
839 AcpiTableInstance
->Fadt1
->Header
.Length
,
840 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
846 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
847 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
849 // Save a pointer to the table
851 AcpiTableInstance
->Facs3
= (EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) CurrentTableList
->Table
;
854 // If FADT already exists, update table pointers.
856 if (AcpiTableInstance
->Fadt3
!= NULL
) {
857 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= (UINT32
) (UINTN
) AcpiTableInstance
->Facs3
;
858 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Facs3
;
860 &AcpiTableInstance
->Fadt3
->XFirmwareCtrl
,
866 // Checksum FADT table
868 AcpiPlatformChecksum (
869 AcpiTableInstance
->Fadt3
,
870 AcpiTableInstance
->Fadt3
->Header
.Length
,
871 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
879 case EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
881 // Check that the table has not been previously added.
883 if (((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0 && AcpiTableInstance
->Dsdt1
!= NULL
) ||
884 ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 && AcpiTableInstance
->Dsdt3
!= NULL
) ||
885 ((Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0 && AcpiTableInstance
->Dsdt3
!= NULL
)
887 gBS
->FreePages (CurrentTableList
->PageAddress
, CurrentTableList
->NumberOfPages
);
888 gBS
->FreePool (CurrentTableList
);
892 // DSDT is referenced by FADT and is not part of RSDT
897 // Add the table to the appropriate table version
899 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
901 // Save a pointer to the table
903 AcpiTableInstance
->Dsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
906 // If FADT already exists, update table pointers.
908 if (AcpiTableInstance
->Fadt1
!= NULL
) {
909 AcpiTableInstance
->Fadt1
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt1
;
912 // Checksum FADT table
914 AcpiPlatformChecksum (
915 AcpiTableInstance
->Fadt1
,
916 AcpiTableInstance
->Fadt1
->Header
.Length
,
917 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
923 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
924 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
926 // Save a pointer to the table
928 AcpiTableInstance
->Dsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) CurrentTableList
->Table
;
931 // If FADT already exists, update table pointers.
933 if (AcpiTableInstance
->Fadt3
!= NULL
) {
934 AcpiTableInstance
->Fadt3
->Dsdt
= (UINT32
) (UINTN
) AcpiTableInstance
->Dsdt3
;
935 Buffer64
= (UINT64
) (UINTN
) AcpiTableInstance
->Dsdt3
;
937 &AcpiTableInstance
->Fadt3
->XDsdt
,
943 // Checksum FADT table
945 AcpiPlatformChecksum (
946 AcpiTableInstance
->Fadt3
,
947 AcpiTableInstance
->Fadt3
->Header
.Length
,
948 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
954 // Checksum the table
957 AcpiPlatformChecksum (
958 CurrentTableList
->Table
,
959 CurrentTableList
->Table
->Length
,
960 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
968 // Checksum the table
971 AcpiPlatformChecksum (
972 CurrentTableList
->Table
,
973 CurrentTableList
->Table
->Length
,
974 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
981 // Add the table to the current list of tables
983 InsertTailList (&AcpiTableInstance
->TableList
, &CurrentTableList
->Link
);
986 // Add the table to RSDT and/or XSDT table entry lists.
989 // Add to ACPI 1.0b table tree
991 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
994 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
996 if (AcpiTableInstance
->NumberOfTableEntries1
>= mEfiAcpiMaxNumTables
) {
997 Status
= ReallocateAcpiTableBuffer (AcpiTableInstance
);
998 ASSERT_EFI_ERROR (Status
);
1000 CurrentRsdtEntry
= (UINT32
*)
1002 (UINT8
*) AcpiTableInstance
->Rsdt1
+
1003 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1004 AcpiTableInstance
->NumberOfTableEntries1
*
1009 // Add entry to the RSDT unless its the FACS or DSDT
1011 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1014 // Update RSDT length
1016 AcpiTableInstance
->Rsdt1
->Length
= AcpiTableInstance
->Rsdt1
->Length
+ sizeof (UINT32
);
1018 AcpiTableInstance
->NumberOfTableEntries1
++;
1022 // Add to ACPI 2.0/3.0 table tree
1024 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1025 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1028 // If the table number exceed the gEfiAcpiMaxNumTables, enlarge the table buffer
1030 if (AcpiTableInstance
->NumberOfTableEntries3
>= mEfiAcpiMaxNumTables
) {
1031 Status
= ReallocateAcpiTableBuffer (AcpiTableInstance
);
1032 ASSERT_EFI_ERROR (Status
);
1035 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1036 // If it becomes necessary to maintain separate table lists, changes will be required.
1038 CurrentRsdtEntry
= (UINT32
*)
1040 (UINT8
*) AcpiTableInstance
->Rsdt3
+
1041 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1042 AcpiTableInstance
->NumberOfTableEntries3
*
1047 // This pointer must not be directly dereferenced as the XSDT entries may not
1048 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1050 CurrentXsdtEntry
= (VOID
*)
1052 (UINT8
*) AcpiTableInstance
->Xsdt
+
1053 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) +
1054 AcpiTableInstance
->NumberOfTableEntries3
*
1059 // Add entry to the RSDT
1061 *CurrentRsdtEntry
= (UINT32
) (UINTN
) CurrentTableList
->Table
;
1064 // Update RSDT length
1066 AcpiTableInstance
->Rsdt3
->Length
= AcpiTableInstance
->Rsdt3
->Length
+ sizeof (UINT32
);
1069 // Add entry to XSDT, XSDT expects 64 bit pointers, but
1070 // the table pointers in XSDT are not aligned on 8 byte boundary.
1072 Buffer64
= (UINT64
) (UINTN
) CurrentTableList
->Table
;
1082 AcpiTableInstance
->Xsdt
->Length
= AcpiTableInstance
->Xsdt
->Length
+ sizeof (UINT64
);
1084 AcpiTableInstance
->NumberOfTableEntries3
++;
1088 ChecksumCommonTables (AcpiTableInstance
);
1094 This function finds the table specified by the handle and returns a pointer to it.
1095 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
1098 @param Handle Table to find.
1099 @param TableList Table list to search
1100 @param Table Pointer to table found.
1102 @return EFI_SUCCESS The function completed successfully.
1103 @return EFI_NOT_FOUND No table found matching the handle specified.
1109 IN LIST_ENTRY
*TableList
,
1110 OUT EFI_ACPI_TABLE_LIST
**Table
1113 LIST_ENTRY
*CurrentLink
;
1114 EFI_ACPI_TABLE_LIST
*CurrentTable
;
1117 // Check for invalid input parameters
1124 CurrentLink
= TableList
->ForwardLink
;
1126 while (CurrentLink
!= TableList
) {
1127 CurrentTable
= EFI_ACPI_TABLE_LIST_FROM_LINK (CurrentLink
);
1128 if (CurrentTable
->Handle
== Handle
) {
1130 // Found handle, so return this table.
1132 *Table
= CurrentTable
;
1136 CurrentLink
= CurrentLink
->ForwardLink
;
1141 return EFI_NOT_FOUND
;
1146 This function removes a basic table from the RSDT and/or XSDT.
1147 For Acpi 1.0 tables, pass in the Rsdt.
1148 For Acpi 2.0 tables, pass in both Rsdt and Xsdt.
1150 @param Table Pointer to table found.
1151 @param NumberOfTableEntries Current number of table entries in the RSDT/XSDT
1152 @param Rsdt Pointer to the RSDT to remove from
1153 @param Xsdt Pointer to the Xsdt to remove from
1155 @return EFI_SUCCESS The function completed successfully.
1156 @return EFI_INVALID_PARAMETER The table was not found in both Rsdt and Xsdt.
1160 RemoveTableFromRsdt (
1161 IN OUT EFI_ACPI_TABLE_LIST
* Table
,
1162 IN OUT UINTN
*NumberOfTableEntries
,
1163 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Rsdt
,
1164 IN OUT EFI_ACPI_DESCRIPTION_HEADER
* Xsdt OPTIONAL
1167 UINT32
*CurrentRsdtEntry
;
1168 VOID
*CurrentXsdtEntry
;
1169 UINT64 CurrentTablePointer64
;
1173 // Check for invalid input parameters
1176 ASSERT (NumberOfTableEntries
);
1180 // Find the table entry in the RSDT and XSDT
1182 for (Index
= 0; Index
< *NumberOfTableEntries
; Index
++) {
1184 // At this time, it is assumed that RSDT and XSDT maintain parallel lists of tables.
1185 // If it becomes necessary to maintain separate table lists, changes will be required.
1187 CurrentRsdtEntry
= (UINT32
*) ((UINT8
*) Rsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + Index
* sizeof (UINT32
));
1190 // This pointer must not be directly dereferenced as the XSDT entries may not
1191 // be 64 bit aligned resulting in a possible fault. Use CopyMem to update.
1193 CurrentXsdtEntry
= (VOID
*) ((UINT8
*) Xsdt
+ sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + Index
* sizeof (UINT64
));
1196 // Read the entry value out of the XSDT
1198 CopyMem (&CurrentTablePointer64
, CurrentXsdtEntry
, sizeof (UINT64
));
1201 // Initialize to NULL
1203 CurrentXsdtEntry
= 0;
1204 CurrentTablePointer64
= 0;
1207 // Check if we have found the corresponding entry in both RSDT and XSDT
1209 if (*CurrentRsdtEntry
== (UINT32
) (UINTN
) Table
->Table
&&
1210 ((Xsdt
== NULL
) || CurrentTablePointer64
== (UINT64
) (UINTN
) Table
->Table
)
1213 // Found entry, so copy all following entries and shrink table
1214 // We actually copy all + 1 to copy the initialized value of memory over
1217 CopyMem (CurrentRsdtEntry
, CurrentRsdtEntry
+ 1, (*NumberOfTableEntries
- Index
) * sizeof (UINT32
));
1218 Rsdt
->Length
= Rsdt
->Length
- sizeof (UINT32
);
1220 CopyMem (CurrentXsdtEntry
, ((UINT64
*) CurrentXsdtEntry
) + 1, (*NumberOfTableEntries
- Index
) * sizeof (UINT64
));
1221 Xsdt
->Length
= Xsdt
->Length
- sizeof (UINT64
);
1224 } else if (Index
+ 1 == *NumberOfTableEntries
) {
1226 // At the last entry, and table not found
1228 return EFI_INVALID_PARAMETER
;
1232 // Checksum the tables
1234 AcpiPlatformChecksum (
1237 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1242 AcpiPlatformChecksum (
1245 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1250 // Decrement the number of tables
1252 (*NumberOfTableEntries
)--;
1259 This function removes a table and frees any associated memory.
1261 @param AcpiTableInstance Instance of the protocol.
1262 @param Version Version(s) to delete.
1263 @param Table Pointer to table found.
1265 @return EFI_SUCCESS The function completed successfully.
1270 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
1271 IN EFI_ACPI_TABLE_VERSION Version
,
1272 IN OUT EFI_ACPI_TABLE_LIST
*Table
1275 UINT32 CurrentTableSignature
;
1276 BOOLEAN RemoveFromRsdt
;
1279 // Check for invalid input parameters
1281 ASSERT (AcpiTableInstance
);
1287 RemoveFromRsdt
= TRUE
;
1289 // Check for Table->Table
1291 ASSERT (Table
->Table
!= NULL
);
1292 CurrentTableSignature
= ((EFI_ACPI_COMMON_HEADER
*) Table
->Table
)->Signature
;
1295 // Basic tasks to accomplish delete are:
1296 // Determine removal requirements (in RSDT/XSDT or not)
1297 // Remove entry from RSDT/XSDT
1298 // Remove any table references to the table
1299 // If no one is using the table
1300 // Free the table (removing pointers from private data and tables)
1302 // Free list structure
1305 // Determine if this table is in the RSDT or XSDT
1307 if ((CurrentTableSignature
== EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
1308 (CurrentTableSignature
== EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
) ||
1309 (CurrentTableSignature
== EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
)
1311 RemoveFromRsdt
= FALSE
;
1314 // We don't remove the FADT in the standard way because some
1315 // OS expect the FADT to be early in the table list.
1316 // So we always put it as the first element in the list.
1318 if (CurrentTableSignature
== EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
) {
1319 RemoveFromRsdt
= FALSE
;
1323 // Remove the table from RSDT and XSDT
1325 if (Table
->Table
!= NULL
) {
1327 // This is a basic table, remove it from any lists and the Rsdt and/or Xsdt
1329 if (Version
& EFI_ACPI_TABLE_VERSION_NONE
& Table
->Version
) {
1331 // Remove this version from the table
1333 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_NONE
;
1336 if (Version
& EFI_ACPI_TABLE_VERSION_1_0B
& Table
->Version
) {
1338 // Remove this version from the table
1340 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_1_0B
;
1343 // Remove from Rsdt. We don't care about the return value because it is
1344 // acceptable for the table to not exist in Rsdt.
1345 // We didn't add some tables so we don't remove them.
1347 if (RemoveFromRsdt
) {
1348 RemoveTableFromRsdt (
1350 &AcpiTableInstance
->NumberOfTableEntries1
,
1351 AcpiTableInstance
->Rsdt1
,
1357 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) ||
1358 (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
)) {
1360 // Remove this version from the table
1362 if (Version
& EFI_ACPI_TABLE_VERSION_2_0
& Table
->Version
) {
1363 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_2_0
;
1365 if (Version
& EFI_ACPI_TABLE_VERSION_3_0
& Table
->Version
) {
1366 Table
->Version
= Table
->Version
&~EFI_ACPI_TABLE_VERSION_3_0
;
1370 // Remove from Rsdt and Xsdt. We don't care about the return value
1371 // because it is acceptable for the table to not exist in Rsdt/Xsdt.
1372 // We didn't add some tables so we don't remove them.
1374 if (RemoveFromRsdt
) {
1375 RemoveTableFromRsdt (
1377 &AcpiTableInstance
->NumberOfTableEntries3
,
1378 AcpiTableInstance
->Rsdt3
,
1379 AcpiTableInstance
->Xsdt
1384 // Free the table, clean up any dependent tables and our private data pointers.
1386 switch (Table
->Table
->Signature
) {
1388 case EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE
:
1389 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1390 AcpiTableInstance
->Fadt1
= NULL
;
1393 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1394 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1395 AcpiTableInstance
->Fadt3
= NULL
;
1399 case EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
:
1400 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1401 AcpiTableInstance
->Facs1
= NULL
;
1404 // Update FADT table pointers
1406 if (AcpiTableInstance
->Fadt1
!= NULL
) {
1407 AcpiTableInstance
->Fadt1
->FirmwareCtrl
= 0;
1412 AcpiPlatformChecksum (
1413 AcpiTableInstance
->Fadt1
,
1414 AcpiTableInstance
->Fadt1
->Header
.Length
,
1415 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1421 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1422 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1423 AcpiTableInstance
->Facs3
= NULL
;
1426 // Update FADT table pointers
1428 if (AcpiTableInstance
->Fadt3
!= NULL
) {
1429 AcpiTableInstance
->Fadt3
->FirmwareCtrl
= 0;
1430 ZeroMem (&AcpiTableInstance
->Fadt3
->XFirmwareCtrl
, sizeof (UINT64
));
1435 AcpiPlatformChecksum (
1436 AcpiTableInstance
->Fadt3
,
1437 AcpiTableInstance
->Fadt3
->Header
.Length
,
1438 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1445 case EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
:
1446 if ((Version
& EFI_ACPI_TABLE_VERSION_1_0B
) != 0) {
1447 AcpiTableInstance
->Dsdt1
= NULL
;
1450 // Update FADT table pointers
1452 if (AcpiTableInstance
->Fadt1
!= NULL
) {
1453 AcpiTableInstance
->Fadt1
->Dsdt
= 0;
1458 AcpiPlatformChecksum (
1459 AcpiTableInstance
->Fadt1
,
1460 AcpiTableInstance
->Fadt1
->Header
.Length
,
1461 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1468 if ((Version
& EFI_ACPI_TABLE_VERSION_2_0
) != 0 ||
1469 (Version
& EFI_ACPI_TABLE_VERSION_3_0
) != 0) {
1470 AcpiTableInstance
->Dsdt3
= NULL
;
1473 // Update FADT table pointers
1475 if (AcpiTableInstance
->Fadt3
!= NULL
) {
1476 AcpiTableInstance
->Fadt3
->Dsdt
= 0;
1477 ZeroMem (&AcpiTableInstance
->Fadt3
->XDsdt
, sizeof (UINT64
));
1482 AcpiPlatformChecksum (
1483 AcpiTableInstance
->Fadt3
,
1484 AcpiTableInstance
->Fadt3
->Header
.Length
,
1485 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1500 // If no version is using this table anymore, remove and free list entry.
1502 if (Table
->Version
== 0) {
1506 gBS
->FreePages (Table
->PageAddress
, Table
->NumberOfPages
);
1507 RemoveEntryList (&(Table
->Link
));
1508 gBS
->FreePool (Table
);
1518 This function finds and removes the table specified by the handle.
1520 @param AcpiTableInstance Instance of the protocol.
1521 @param Version Bitmask of which versions to remove.
1522 @param Handle Table to remove.
1524 @return EFI_SUCCESS The function completed successfully.
1525 @return EFI_ABORTED An error occurred.
1526 @return EFI_NOT_FOUND Handle not found in table list.
1530 RemoveTableFromList (
1531 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
1532 IN EFI_ACPI_TABLE_VERSION Version
,
1536 EFI_ACPI_TABLE_LIST
*Table
;
1539 Table
= (EFI_ACPI_TABLE_LIST
*) NULL
;
1542 // Check for invalid input parameters
1544 ASSERT (AcpiTableInstance
);
1549 Status
= FindTableByHandle (
1551 &AcpiTableInstance
->TableList
,
1554 if (EFI_ERROR (Status
)) {
1555 return EFI_NOT_FOUND
;
1560 Status
= DeleteTable (AcpiTableInstance
, Version
, Table
);
1561 if (EFI_ERROR (Status
)) {
1565 // Completed successfully
1572 This function calculates and updates an UINT8 checksum.
1574 @param Buffer Pointer to buffer to checksum
1575 @param Size Number of bytes to checksum
1576 @param ChecksumOffset Offset to place the checksum result in
1578 @return EFI_SUCCESS The function completed successfully.
1582 AcpiPlatformChecksum (
1585 IN UINTN ChecksumOffset
1593 // Initialize pointer
1598 // set checksum to 0 first
1600 Ptr
[ChecksumOffset
] = 0;
1603 // add all content of buffer
1605 while ((Size
--) != 0) {
1606 Sum
= (UINT8
) (Sum
+ (*Ptr
++));
1612 Ptr
[ChecksumOffset
] = (UINT8
) (0xff - Sum
+ 1);
1619 Checksum all versions of the common tables, RSDP, RSDT, XSDT.
1621 @param AcpiTableInstance Protocol instance private data.
1623 @return EFI_SUCCESS The function completed successfully.
1627 ChecksumCommonTables (
1628 IN OUT EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
1632 // RSDP ACPI 1.0 checksum for 1.0 table. This is only the first 20 bytes of the structure
1634 AcpiPlatformChecksum (
1635 AcpiTableInstance
->Rsdp1
,
1636 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1637 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1642 // RSDP ACPI 1.0 checksum for 2.0/3.0 table. This is only the first 20 bytes of the structure
1644 AcpiPlatformChecksum (
1645 AcpiTableInstance
->Rsdp3
,
1646 sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1647 OFFSET_OF (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1652 // RSDP ACPI 2.0/3.0 checksum, this is the entire table
1654 AcpiPlatformChecksum (
1655 AcpiTableInstance
->Rsdp3
,
1656 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
),
1657 OFFSET_OF (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
,
1664 AcpiPlatformChecksum (
1665 AcpiTableInstance
->Rsdt1
,
1666 AcpiTableInstance
->Rsdt1
->Length
,
1667 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1671 AcpiPlatformChecksum (
1672 AcpiTableInstance
->Rsdt3
,
1673 AcpiTableInstance
->Rsdt3
->Length
,
1674 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1681 AcpiPlatformChecksum (
1682 AcpiTableInstance
->Xsdt
,
1683 AcpiTableInstance
->Xsdt
->Length
,
1684 OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER
,
1693 Constructor for the ACPI table protocol. Initializes instance
1696 @param AcpiTableInstance Instance to construct
1698 @return EFI_SUCCESS Instance initialized.
1699 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
1703 AcpiTableAcpiTableConstructor (
1704 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
1711 EFI_PHYSICAL_ADDRESS PageAddress
;
1714 // Check for invalid input parameters
1716 ASSERT (AcpiTableInstance
);
1718 InitializeListHead (&AcpiTableInstance
->TableList
);
1719 AcpiTableInstance
->CurrentHandle
= 1;
1721 AcpiTableInstance
->AcpiTableProtocol
.InstallAcpiTable
= InstallAcpiTable
;
1722 AcpiTableInstance
->AcpiTableProtocol
.UninstallAcpiTable
= UninstallAcpiTable
;
1724 if (FeaturePcdGet (PcdInstallAcpiSdtProtocol
)) {
1725 SdtAcpiTableAcpiSdtConstructor (AcpiTableInstance
);
1729 // Create RSDP, RSDT, XSDT structures
1730 // Allocate all buffers
1732 TotalSize
= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1733 sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
) +
1734 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 1.0 RSDT
1735 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1736 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 RSDT
1737 mEfiAcpiMaxNumTables
* sizeof (UINT32
) +
1738 sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + // for ACPI 2.0/3.0 XSDT
1739 mEfiAcpiMaxNumTables
* sizeof (UINT64
);
1742 // Allocate memory in the lower 32 bit of address range for
1743 // compatibility with ACPI 1.0 OS.
1745 // This is done because ACPI 1.0 pointers are 32 bit values.
1746 // ACPI 2.0 OS and all 64 bit OS must use the 64 bit ACPI table addresses.
1747 // There is no architectural reason these should be below 4GB, it is purely
1748 // for convenience of implementation that we force memory below 4GB.
1750 PageAddress
= 0xFFFFFFFF;
1751 Status
= gBS
->AllocatePages (
1753 EfiACPIReclaimMemory
,
1754 EFI_SIZE_TO_PAGES (TotalSize
),
1758 if (EFI_ERROR (Status
)) {
1759 return EFI_OUT_OF_RESOURCES
;
1762 Pointer
= (UINT8
*) (UINTN
) PageAddress
;
1763 ZeroMem (Pointer
, TotalSize
);
1765 AcpiTableInstance
->Rsdp1
= (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1766 Pointer
+= sizeof (EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1767 AcpiTableInstance
->Rsdp3
= (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*) Pointer
;
1768 Pointer
+= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1770 AcpiTableInstance
->Rsdt1
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1771 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1772 AcpiTableInstance
->Rsdt3
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1773 Pointer
+= (sizeof (EFI_ACPI_DESCRIPTION_HEADER
) + EFI_ACPI_MAX_NUM_TABLES
* sizeof (UINT32
));
1775 AcpiTableInstance
->Xsdt
= (EFI_ACPI_DESCRIPTION_HEADER
*) Pointer
;
1780 CurrentData
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1781 CopyMem (&AcpiTableInstance
->Rsdp1
->Signature
, &CurrentData
, sizeof (UINT64
));
1782 CopyMem (AcpiTableInstance
->Rsdp1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1783 AcpiTableInstance
->Rsdp1
->Reserved
= EFI_ACPI_RESERVED_BYTE
;
1784 AcpiTableInstance
->Rsdp1
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt1
;
1786 CurrentData
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE
;
1787 CopyMem (&AcpiTableInstance
->Rsdp3
->Signature
, &CurrentData
, sizeof (UINT64
));
1788 CopyMem (AcpiTableInstance
->Rsdp3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1789 AcpiTableInstance
->Rsdp3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION
;
1790 AcpiTableInstance
->Rsdp3
->RsdtAddress
= (UINT32
) (UINTN
) AcpiTableInstance
->Rsdt3
;
1791 AcpiTableInstance
->Rsdp3
->Length
= sizeof (EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
);
1792 CurrentData
= (UINT64
) (UINTN
) AcpiTableInstance
->Xsdt
;
1793 CopyMem (&AcpiTableInstance
->Rsdp3
->XsdtAddress
, &CurrentData
, sizeof (UINT64
));
1794 SetMem (AcpiTableInstance
->Rsdp3
->Reserved
, 3, EFI_ACPI_RESERVED_BYTE
);
1799 // Note that we "reserve" one entry for the FADT so it can always be
1800 // at the beginning of the list of tables. Some OS don't seem
1801 // to find it correctly if it is too far down the list.
1803 AcpiTableInstance
->Rsdt1
->Signature
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1804 AcpiTableInstance
->Rsdt1
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1805 AcpiTableInstance
->Rsdt1
->Revision
= EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1806 CopyMem (AcpiTableInstance
->Rsdt1
->OemId
, EFI_ACPI_OEM_ID
, 6);
1807 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1808 CopyMem (&AcpiTableInstance
->Rsdt1
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1809 AcpiTableInstance
->Rsdt1
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1810 AcpiTableInstance
->Rsdt1
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1811 AcpiTableInstance
->Rsdt1
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1813 // We always reserve first one for FADT
1815 AcpiTableInstance
->NumberOfTableEntries1
= 1;
1816 AcpiTableInstance
->Rsdt1
->Length
= AcpiTableInstance
->Rsdt1
->Length
+ sizeof(UINT32
);
1818 AcpiTableInstance
->Rsdt3
->Signature
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1819 AcpiTableInstance
->Rsdt3
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1820 AcpiTableInstance
->Rsdt3
->Revision
= EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1821 CopyMem (AcpiTableInstance
->Rsdt3
->OemId
, EFI_ACPI_OEM_ID
, 6);
1822 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1823 CopyMem (&AcpiTableInstance
->Rsdt3
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1824 AcpiTableInstance
->Rsdt3
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1825 AcpiTableInstance
->Rsdt3
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1826 AcpiTableInstance
->Rsdt3
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1828 // We always reserve first one for FADT
1830 AcpiTableInstance
->NumberOfTableEntries3
= 1;
1831 AcpiTableInstance
->Rsdt3
->Length
= AcpiTableInstance
->Rsdt3
->Length
+ sizeof(UINT32
);
1836 AcpiTableInstance
->Xsdt
->Signature
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE
;
1837 AcpiTableInstance
->Xsdt
->Length
= sizeof (EFI_ACPI_DESCRIPTION_HEADER
);
1838 AcpiTableInstance
->Xsdt
->Revision
= EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION
;
1839 CopyMem (AcpiTableInstance
->Xsdt
->OemId
, EFI_ACPI_OEM_ID
, 6);
1840 CurrentData
= EFI_ACPI_OEM_TABLE_ID
;
1841 CopyMem (&AcpiTableInstance
->Xsdt
->OemTableId
, &CurrentData
, sizeof (UINT64
));
1842 AcpiTableInstance
->Xsdt
->OemRevision
= EFI_ACPI_OEM_REVISION
;
1843 AcpiTableInstance
->Xsdt
->CreatorId
= EFI_ACPI_CREATOR_ID
;
1844 AcpiTableInstance
->Xsdt
->CreatorRevision
= EFI_ACPI_CREATOR_REVISION
;
1846 // We always reserve first one for FADT
1848 AcpiTableInstance
->Xsdt
->Length
= AcpiTableInstance
->Xsdt
->Length
+ sizeof(UINT64
);
1850 ChecksumCommonTables (AcpiTableInstance
);
1853 // Completed successfully