2 ACPI Table Protocol Driver
4 Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #define _ACPI_TABLE_H_
14 #include <Protocol/AcpiTable.h>
15 #include <Guid/Acpi.h>
16 #include <Protocol/AcpiSystemDescriptionTable.h>
18 #include <Library/BaseLib.h>
19 #include <Library/DebugLib.h>
20 #include <Library/UefiLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/UefiDriverEntryPoint.h>
23 #include <Library/MemoryAllocationLib.h>
24 #include <Library/UefiBootServicesTableLib.h>
25 #include <Library/PcdLib.h>
26 #include <Library/HobLib.h>
27 #include <UniversalPayload/AcpiTable.h>
30 // Statements that include other files
32 #include <IndustryStandard/Acpi.h>
37 // Great than or equal to 2.0.
39 #define ACPI_TABLE_VERSION_GTE_2_0 (EFI_ACPI_TABLE_VERSION_2_0 |\
40 EFI_ACPI_TABLE_VERSION_3_0 | \
41 EFI_ACPI_TABLE_VERSION_4_0 | \
42 EFI_ACPI_TABLE_VERSION_5_0)
45 // Private Driver Data
48 // ACPI Table Linked List Signature.
50 #define EFI_ACPI_TABLE_LIST_SIGNATURE SIGNATURE_32 ('E', 'A', 'T', 'L')
53 // ACPI Table Linked List Entry definition.
55 // Signature must be set to EFI_ACPI_TABLE_LIST_SIGNATURE
56 // Link is the linked list data.
57 // Version is the versions of the ACPI tables that this table belongs in.
58 // Table is a pointer to the table.
59 // TableSize is the size of the table
60 // Handle is used to identify a particular table.
61 // PoolAllocation carries the allocation type:
62 // FALSE: Table points to EFI_SIZE_TO_PAGES(TableSize) pages allocated using
63 // gBS->AllocatePages ()
64 // TRUE: Table points to TableSize bytes allocated using gBS->AllocatePool ()
69 EFI_ACPI_TABLE_VERSION Version
;
70 EFI_ACPI_COMMON_HEADER
*Table
;
73 BOOLEAN PoolAllocation
;
74 } EFI_ACPI_TABLE_LIST
;
77 // Containment record for ACPI Table linked list.
79 #define EFI_ACPI_TABLE_LIST_FROM_LINK(_link) CR (_link, EFI_ACPI_TABLE_LIST, Link, EFI_ACPI_TABLE_LIST_SIGNATURE)
82 // The maximum number of tables this driver supports
84 #define EFI_ACPI_MAX_NUM_TABLES 20
87 // Protocol private structure definition
90 // ACPI support protocol instance signature definition.
92 #define EFI_ACPI_TABLE_SIGNATURE SIGNATURE_32 ('S', 'T', 'A', 'E')
95 // ACPI support protocol instance data structure
99 EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*Rsdp1
; // Pointer to RSD_PTR structure
100 EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER
*Rsdp3
; // Pointer to RSD_PTR structure
101 EFI_ACPI_DESCRIPTION_HEADER
*Rsdt1
; // Pointer to RSDT table header
102 EFI_ACPI_DESCRIPTION_HEADER
*Rsdt3
; // Pointer to RSDT table header
103 EFI_ACPI_DESCRIPTION_HEADER
*Xsdt
; // Pointer to XSDT table header
104 EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt1
; // Pointer to FADT table header
105 EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE
*Fadt3
; // Pointer to FADT table header
106 EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs1
; // Pointer to FACS table header
107 EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs3
; // Pointer to FACS table header
108 EFI_ACPI_DESCRIPTION_HEADER
*Dsdt1
; // Pointer to DSDT table header
109 EFI_ACPI_DESCRIPTION_HEADER
*Dsdt3
; // Pointer to DSDT table header
110 LIST_ENTRY TableList
;
111 UINTN NumberOfTableEntries1
; // Number of ACPI 1.0 tables
112 UINTN NumberOfTableEntries3
; // Number of ACPI 3.0 tables
114 EFI_ACPI_TABLE_PROTOCOL AcpiTableProtocol
;
115 EFI_ACPI_SDT_PROTOCOL AcpiSdtProtocol
;
116 LIST_ENTRY NotifyList
;
117 } EFI_ACPI_TABLE_INSTANCE
;
120 // ACPI table protocol instance containing record macro
122 #define EFI_ACPI_TABLE_INSTANCE_FROM_THIS(a) \
124 EFI_ACPI_TABLE_INSTANCE, \
126 EFI_ACPI_TABLE_SIGNATURE \
130 // Protocol Constructor functions
134 Constructor for the ACPI support protocol. Initializes instance
137 @param AcpiTableInstance Instance to construct
139 @return EFI_SUCCESS Instance initialized.
140 @return EFI_OUT_OF_RESOURCES Unable to allocate required resources.
144 AcpiTableAcpiTableConstructor (
145 EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
149 Entry point of the ACPI table driver.
150 Creates and initializes an instance of the ACPI Table
151 Protocol and installs it on a new handle.
153 @param ImageHandle A handle for the image that is initializing this driver
154 @param SystemTable A pointer to the EFI system table
156 @return EFI_SUCCESS Driver initialized successfully
157 @return EFI_LOAD_ERROR Failed to Initialize or has been loaded
158 @return EFI_OUT_OF_RESOURCES Could not allocate needed resources
163 InitializeAcpiTableDxe (
164 IN EFI_HANDLE ImageHandle
,
165 IN EFI_SYSTEM_TABLE
*SystemTable
170 This function finds the table specified by the handle and returns a pointer to it.
171 If the handle is not found, EFI_NOT_FOUND is returned and the contents of Table are
174 @param[in] Handle Table to find.
175 @param[in] TableList Table list to search
176 @param[out] Table Pointer to table found.
178 @retval EFI_SUCCESS The function completed successfully.
179 @retval EFI_NOT_FOUND No table found matching the handle specified.
185 IN LIST_ENTRY
*TableList
,
186 OUT EFI_ACPI_TABLE_LIST
**Table
191 This function calculates and updates an UINT8 checksum.
193 @param[in] Buffer Pointer to buffer to checksum
194 @param[in] Size Number of bytes to checksum
195 @param[in] ChecksumOffset Offset to place the checksum result in
197 @retval EFI_SUCCESS The function completed successfully.
201 AcpiPlatformChecksum (
204 IN UINTN ChecksumOffset
208 This function invokes ACPI notification.
210 @param[in] AcpiTableInstance Instance to AcpiTable
211 @param[in] Version Version(s) to set.
212 @param[in] Handle Handle of the table.
216 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
217 IN EFI_ACPI_TABLE_VERSION Version
,
222 This function initializes AcpiSdt protocol in ACPI table instance.
224 @param[in] AcpiTableInstance Instance to construct
227 SdtAcpiTableAcpiSdtConstructor (
228 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
232 Returns a requested ACPI table.
234 The following structures are not considered elements in the list of
236 - Root System Description Pointer (RSD_PTR)
237 - Root System Description Table (RSDT)
238 - Extended System Description Table (XSDT)
239 Version is updated with a bit map containing all the versions of ACPI of which the table is a
240 member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface,
241 the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion.
243 @param[in] AcpiTableInstance ACPI table Instance.
244 @param[in] Index The zero-based index of the table to retrieve.
245 @param[out] Table Pointer for returning the table buffer.
246 @param[out] Version On return, updated with the ACPI versions to which this table belongs. Type
247 EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the
248 EFI_ACPI_SDT_PROTOCOL.
249 @param[out] TableKey On return, points to the table key for the specified ACPI system definition table.
250 This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL.
251 The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable()
252 to uninstall the table.
253 @retval EFI_SUCCESS The function completed successfully.
254 @retval EFI_NOT_FOUND The requested index is too large and a table was not found.
258 IN EFI_ACPI_TABLE_INSTANCE
*AcpiTableInstance
,
260 OUT EFI_ACPI_SDT_HEADER
**Table
,
261 OUT EFI_ACPI_TABLE_VERSION
*Version
,
266 // export PrivateData symbol, because we need that in AcpiSdtProtol implementation
268 extern EFI_HANDLE mHandle
;
269 extern EFI_ACPI_TABLE_INSTANCE
*mPrivateData
;