mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-09 23:04:24 +02:00
03ad59e631
REF : https://bugzilla.tianocore.org/show_bug.cgi?id=4787 If ACPI Silicon Hob has been found from entry of AcpiTableDxe driver, that means SOC related ACPI tables been pass to the DXE phase by HOB. Each SOC related ACPI tables will be install. Signed-off-by: George Liao <george.liao@intel.com>
278 lines
9.6 KiB
C
278 lines
9.6 KiB
C
/** @file
|
|
ACPI Table Protocol Driver
|
|
|
|
Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef _ACPI_TABLE_H_
|
|
#define _ACPI_TABLE_H_
|
|
|
|
#include <PiDxe.h>
|
|
|
|
#include <Protocol/AcpiTable.h>
|
|
#include <Guid/Acpi.h>
|
|
#include <Protocol/AcpiSystemDescriptionTable.h>
|
|
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/UefiDriverEntryPoint.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/HobLib.h>
|
|
#include <UniversalPayload/AcpiTable.h>
|
|
|
|
//
|
|
// Statements that include other files
|
|
//
|
|
#include <IndustryStandard/Acpi.h>
|
|
|
|
#include "AcpiSdt.h"
|
|
|
|
//
|
|
// Great than or equal to 2.0.
|
|
//
|
|
#define ACPI_TABLE_VERSION_GTE_2_0 (EFI_ACPI_TABLE_VERSION_2_0 |\
|
|
EFI_ACPI_TABLE_VERSION_3_0 | \
|
|
EFI_ACPI_TABLE_VERSION_4_0 | \
|
|
EFI_ACPI_TABLE_VERSION_5_0)
|
|
|
|
//
|
|
// Private Driver Data
|
|
//
|
|
//
|
|
// ACPI Table Linked List Signature.
|
|
//
|
|
#define EFI_ACPI_TABLE_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'T', 'L')
|
|
|
|
//
|
|
// ACPI Table Linked List Entry definition.
|
|
//
|
|
// Signature must be set to EFI_ACPI_TABLE_LIST_SIGNATURE
|
|
// Link is the linked list data.
|
|
// Version is the versions of the ACPI tables that this table belongs in.
|
|
// Table is a pointer to the table.
|
|
// TableSize is the size of the table
|
|
// Handle is used to identify a particular table.
|
|
// PoolAllocation carries the allocation type:
|
|
// FALSE: Table points to EFI_SIZE_TO_PAGES(TableSize) pages allocated using
|
|
// gBS->AllocatePages ()
|
|
// TRUE: Table points to TableSize bytes allocated using gBS->AllocatePool ()
|
|
//
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
LIST_ENTRY Link;
|
|
EFI_ACPI_TABLE_VERSION Version;
|
|
EFI_ACPI_COMMON_HEADER *Table;
|
|
UINTN TableSize;
|
|
UINTN Handle;
|
|
BOOLEAN PoolAllocation;
|
|
} EFI_ACPI_TABLE_LIST;
|
|
|
|
//
|
|
// Containment record for ACPI Table linked list.
|
|
//
|
|
#define EFI_ACPI_TABLE_LIST_FROM_LINK(_link) CR (_link, EFI_ACPI_TABLE_LIST, Link, EFI_ACPI_TABLE_LIST_SIGNATURE)
|
|
|
|
//
|
|
// The maximum number of tables this driver supports
|
|
//
|
|
#define EFI_ACPI_MAX_NUM_TABLES 20
|
|
|
|
//
|
|
// Protocol private structure definition
|
|
//
|
|
//
|
|
// ACPI support protocol instance signature definition.
|
|
//
|
|
#define EFI_ACPI_TABLE_SIGNATURE SIGNATURE_32 ('S', 'T', 'A', 'E')
|
|
|
|
//
|
|
// ACPI support protocol instance data structure
|
|
//
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER *Rsdp1; // Pointer to RSD_PTR structure
|
|
EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER *Rsdp3; // Pointer to RSD_PTR structure
|
|
EFI_ACPI_DESCRIPTION_HEADER *Rsdt1; // Pointer to RSDT table header
|
|
EFI_ACPI_DESCRIPTION_HEADER *Rsdt3; // Pointer to RSDT table header
|
|
EFI_ACPI_DESCRIPTION_HEADER *Xsdt; // Pointer to XSDT table header
|
|
EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE *Fadt1; // Pointer to FADT table header
|
|
EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE *Fadt3; // Pointer to FADT table header
|
|
EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs1; // Pointer to FACS table header
|
|
EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs3; // Pointer to FACS table header
|
|
EFI_ACPI_DESCRIPTION_HEADER *Dsdt1; // Pointer to DSDT table header
|
|
EFI_ACPI_DESCRIPTION_HEADER *Dsdt3; // Pointer to DSDT table header
|
|
LIST_ENTRY TableList;
|
|
UINTN NumberOfTableEntries1; // Number of ACPI 1.0 tables
|
|
UINTN NumberOfTableEntries3; // Number of ACPI 3.0 tables
|
|
UINTN CurrentHandle;
|
|
EFI_ACPI_TABLE_PROTOCOL AcpiTableProtocol;
|
|
EFI_ACPI_SDT_PROTOCOL AcpiSdtProtocol;
|
|
LIST_ENTRY NotifyList;
|
|
} EFI_ACPI_TABLE_INSTANCE;
|
|
|
|
//
|
|
// ACPI table protocol instance containing record macro
|
|
//
|
|
#define EFI_ACPI_TABLE_INSTANCE_FROM_THIS(a) \
|
|
CR (a, \
|
|
EFI_ACPI_TABLE_INSTANCE, \
|
|
AcpiTableProtocol, \
|
|
EFI_ACPI_TABLE_SIGNATURE \
|
|
)
|
|
|
|
//
|
|
// ACPI HOB produced by silicon initialization code will provide the RSDP structure.
|
|
//
|
|
typedef struct {
|
|
EFI_PHYSICAL_ADDRESS Rsdp;
|
|
} ACPI_SILICON_HOB;
|
|
//
|
|
// Protocol Constructor functions
|
|
//
|
|
|
|
/**
|
|
Constructor for the ACPI support protocol. Initializes instance
|
|
data.
|
|
|
|
@param AcpiTableInstance Instance to construct
|
|
|
|
@return EFI_SUCCESS Instance initialized.
|
|
@return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
AcpiTableAcpiTableConstructor (
|
|
EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance
|
|
);
|
|
|
|
/**
|
|
Entry point of the ACPI table driver.
|
|
Creates and initializes an instance of the ACPI Table
|
|
Protocol and installs it on a new handle.
|
|
|
|
@param ImageHandle A handle for the image that is initializing this driver
|
|
@param SystemTable A pointer to the EFI system table
|
|
|
|
@return EFI_SUCCESS Driver initialized successfully
|
|
@return EFI_LOAD_ERROR Failed to Initialize or has been loaded
|
|
@return EFI_OUT_OF_RESOURCES Could not allocate needed resources
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
InitializeAcpiTableDxe (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
);
|
|
|
|
/**
|
|
|
|
This function finds the table specified by the handle and returns a pointer to it.
|
|
If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
|
|
undefined.
|
|
|
|
@param[in] Handle Table to find.
|
|
@param[in] TableList Table list to search
|
|
@param[out] Table Pointer to table found.
|
|
|
|
@retval EFI_SUCCESS The function completed successfully.
|
|
@retval EFI_NOT_FOUND No table found matching the handle specified.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
FindTableByHandle (
|
|
IN UINTN Handle,
|
|
IN LIST_ENTRY *TableList,
|
|
OUT EFI_ACPI_TABLE_LIST **Table
|
|
);
|
|
|
|
/**
|
|
|
|
This function calculates and updates an UINT8 checksum.
|
|
|
|
@param[in] Buffer Pointer to buffer to checksum
|
|
@param[in] Size Number of bytes to checksum
|
|
@param[in] ChecksumOffset Offset to place the checksum result in
|
|
|
|
@retval EFI_SUCCESS The function completed successfully.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
AcpiPlatformChecksum (
|
|
IN VOID *Buffer,
|
|
IN UINTN Size,
|
|
IN UINTN ChecksumOffset
|
|
);
|
|
|
|
/**
|
|
This function invokes ACPI notification.
|
|
|
|
@param[in] AcpiTableInstance Instance to AcpiTable
|
|
@param[in] Version Version(s) to set.
|
|
@param[in] Handle Handle of the table.
|
|
**/
|
|
VOID
|
|
SdtNotifyAcpiList (
|
|
IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,
|
|
IN EFI_ACPI_TABLE_VERSION Version,
|
|
IN UINTN Handle
|
|
);
|
|
|
|
/**
|
|
This function initializes AcpiSdt protocol in ACPI table instance.
|
|
|
|
@param[in] AcpiTableInstance Instance to construct
|
|
**/
|
|
VOID
|
|
SdtAcpiTableAcpiSdtConstructor (
|
|
IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance
|
|
);
|
|
|
|
/**
|
|
Returns a requested ACPI table.
|
|
|
|
The following structures are not considered elements in the list of
|
|
ACPI tables:
|
|
- Root System Description Pointer (RSD_PTR)
|
|
- Root System Description Table (RSDT)
|
|
- Extended System Description Table (XSDT)
|
|
Version is updated with a bit map containing all the versions of ACPI of which the table is a
|
|
member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface,
|
|
the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion.
|
|
|
|
@param[in] AcpiTableInstance ACPI table Instance.
|
|
@param[in] Index The zero-based index of the table to retrieve.
|
|
@param[out] Table Pointer for returning the table buffer.
|
|
@param[out] Version On return, updated with the ACPI versions to which this table belongs. Type
|
|
EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the
|
|
EFI_ACPI_SDT_PROTOCOL.
|
|
@param[out] TableKey On return, points to the table key for the specified ACPI system definition table.
|
|
This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL.
|
|
The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable()
|
|
to uninstall the table.
|
|
@retval EFI_SUCCESS The function completed successfully.
|
|
@retval EFI_NOT_FOUND The requested index is too large and a table was not found.
|
|
**/
|
|
EFI_STATUS
|
|
SdtGetAcpiTable (
|
|
IN EFI_ACPI_TABLE_INSTANCE *AcpiTableInstance,
|
|
IN UINTN Index,
|
|
OUT EFI_ACPI_SDT_HEADER **Table,
|
|
OUT EFI_ACPI_TABLE_VERSION *Version,
|
|
OUT UINTN *TableKey
|
|
);
|
|
|
|
//
|
|
// export PrivateData symbol, because we need that in AcpiSdtProtol implementation
|
|
//
|
|
extern EFI_HANDLE mHandle;
|
|
extern EFI_ACPI_TABLE_INSTANCE *mPrivateData;
|
|
|
|
#endif
|