3 Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
5 SPDX-License-Identifier: BSD-2-Clause-Patent
8 - Cm or CM - Configuration Manager
10 - Std or STD - Standard
13 #ifndef ACPI_TABLE_GENERATOR_H_
14 #define ACPI_TABLE_GENERATOR_H_
16 #include <IndustryStandard/Acpi.h>
18 // Module specific include files.
19 #include <TableGenerator.h>
24 The Dynamic Tables Framework provisions two classes of ACPI table
26 - Standard generators: The ACPI table generators implemented by the
27 Dynamic Tables Framework.
28 - OEM generators: The ACPI table generators customized by the OEM.
30 The Dynamic Tables Framework implements the following ACPI table generators:
31 - RAW : This is the simplest ACPI table generator. It simply installs
32 the ACPI table provided in the AcpiTableData member of the
33 CM_STD_OBJ_ACPI_TABLE_INFO. The ACPI table data is provided by
34 the Configuration Manager and is generated using an implementation
36 - DSDT : The DSDT generator is a clone of the RAW generator. The difference
37 is in the way the ACPI Table Data is generated from an AML file.
38 - SSDT : The SSDT generator is a clone of the RAW generator. The difference
39 is in the way the ACPI Table Data is generated from an AML file.
40 - FADT : The FADT generator collates the required platform information from
41 the Configuration Manager and builds the FADT table.
42 - MADT : The MADT generator collates the GIC information from the
43 Configuration Manager and builds the MADT table.
44 - GTDT : The GTDT generator collates the Timer information from the
45 Configuration Manager and builds the GTDT table.
46 - DBG2 : The DBG2 generator collates the debug serial port information from
47 the Configuration Manager and builds the DBG2 table.
48 - SPCR : The SPCR generator collates the serial port information from the
49 Configuration Manager and builds the SPCR table.
50 - MCFG : The MCFG generator collates the PCI configuration space information
51 from the Configuration Manager and builds the MCFG table.
52 - IORT : The IORT generator collates the IO Topology information from the
53 Configuration Manager and builds the IORT table.
54 - PPTT : The PPTT generator collates the processor topology information from
55 the Configuration Manager and builds the PPTT table.
58 /** The ACPI_TABLE_GENERATOR_ID type describes ACPI table generator ID.
60 typedef TABLE_GENERATOR_ID ACPI_TABLE_GENERATOR_ID
;
62 /** The ESTD_ACPI_TABLE_ID enum describes the ACPI table IDs reserved for
63 the standard generators.
65 typedef enum StdAcpiTableId
{
66 EStdAcpiTableIdReserved
= 0x0000, ///< Reserved
67 EStdAcpiTableIdRaw
, ///< RAW Generator
68 EStdAcpiTableIdDsdt
= EStdAcpiTableIdRaw
, ///< DSDT Generator
69 EStdAcpiTableIdSsdt
= EStdAcpiTableIdRaw
, ///< SSDT Generator
70 EStdAcpiTableIdFadt
, ///< FADT Generator
71 EStdAcpiTableIdMadt
, ///< MADT Generator
72 EStdAcpiTableIdGtdt
, ///< GTDT Generator
73 EStdAcpiTableIdDbg2
, ///< DBG2 Generator
74 EStdAcpiTableIdSpcr
, ///< SPCR Generator
75 EStdAcpiTableIdMcfg
, ///< MCFG Generator
76 EStdAcpiTableIdIort
, ///< IORT Generator
77 EStdAcpiTableIdPptt
, ///< PPTT Generator
81 /** This macro checks if the Table Generator ID is for an ACPI Table Generator.
83 @param [in] TableGeneratorId The table generator ID.
85 @return TRUE if the table generator ID is for an ACPI Table
88 #define IS_GENERATOR_TYPE_ACPI(TableGeneratorId) \
89 (GET_TABLE_TYPE (TableGeneratorId) == ETableGeneratorTypeAcpi)
91 /** This macro checks if the Table Generator ID is for a standard ACPI
94 @param [in] TableGeneratorId The table generator ID.
96 @return TRUE if the table generator ID is for a standard ACPI
99 #define IS_VALID_STD_ACPI_GENERATOR_ID(TableGeneratorId) \
101 IS_GENERATOR_NAMESPACE_STD (TableGeneratorId) && \
102 IS_GENERATOR_TYPE_ACPI (TableGeneratorId) && \
103 ((GET_TABLE_ID (GeneratorId) >= EStdAcpiTableIdRaw) && \
104 (GET_TABLE_ID (GeneratorId) < EStdAcpiTableIdMax)) \
107 /** This macro creates a standard ACPI Table Generator ID.
109 @param [in] TableId The table generator ID.
111 @return a standard ACPI table generator ID.
113 #define CREATE_STD_ACPI_TABLE_GEN_ID(TableId) \
114 CREATE_TABLE_GEN_ID ( \
115 ETableGeneratorTypeAcpi, \
116 ETableGeneratorNameSpaceStd, \
120 /** This macro creates an OEM ACPI Table Generator ID.
122 @param [in] TableId The table generator ID.
124 @return an OEM ACPI table generator ID.
126 #define CREATE_OEM_ACPI_TABLE_GEN_ID(TableId) \
127 CREATE_TABLE_GEN_ID ( \
128 ETableGeneratorTypeAcpi, \
129 ETableGeneratorNameSpaceOem, \
133 /** The Creator ID for the ACPI tables generated using
134 the standard ACPI table generators.
136 #define TABLE_GENERATOR_CREATOR_ID_ARM SIGNATURE_32('A', 'R', 'M', 'H')
138 /** A macro to initialise the common header part of EFI ACPI tables as
139 defined by the EFI_ACPI_DESCRIPTION_HEADER structure.
141 @param [in] Signature The ACPI table signature.
142 @param [in] Type The ACPI table structure.
143 @param [in] Revision The ACPI table revision.
145 #define ACPI_HEADER(Signature, Type, Revision) { \
146 Signature, /* UINT32 Signature */ \
147 sizeof (Type), /* UINT32 Length */ \
148 Revision, /* UINT8 Revision */ \
149 0, /* UINT8 Checksum */ \
150 { 0, 0, 0, 0, 0, 0 }, /* UINT8 OemId[6] */ \
151 0, /* UINT64 OemTableId */ \
152 0, /* UINT32 OemRevision */ \
153 0, /* UINT32 CreatorId */ \
154 0 /* UINT32 CreatorRevision */\
157 /** A macro to dump the common header part of EFI ACPI tables as
158 defined by the EFI_ACPI_DESCRIPTION_HEADER structure.
160 @param [in] AcpiHeader The pointer to the ACPI table header.
162 #define DUMP_ACPI_TABLE_HEADER(AcpiHeader) \
165 "ACPI TABLE %c%c%c%c : Rev 0x%x : Length : 0x%x\n", \
166 (AcpiHeader->Signature & 0xFF), \
167 ((AcpiHeader->Signature >> 8) & 0xFF), \
168 ((AcpiHeader->Signature >> 16) & 0xFF), \
169 ((AcpiHeader->Signature >> 24) & 0xFF), \
170 AcpiHeader->Revision, \
174 /** Forward declarations.
176 typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL
;
177 typedef struct CmAStdObjAcpiTableInfo CM_STD_OBJ_ACPI_TABLE_INFO
;
178 typedef struct AcpiTableGenerator ACPI_TABLE_GENERATOR
;
180 /** This function pointer describes the interface to ACPI table build
181 functions provided by the ACPI table generator and called by the
182 Table Manager to build an ACPI table.
184 @param [in] This Pointer to the ACPI table generator.
185 @param [in] AcpiTableInfo Pointer to the ACPI table information.
186 @param [in] CfgMgrProtocol Pointer to the Configuration Manager
188 @param [out] Table Pointer to the generated ACPI table.
190 @return EFI_SUCCESS If the table is generated successfully or other
191 failure codes as returned by the generator.
193 typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLE
) (
194 IN CONST ACPI_TABLE_GENERATOR
* This
,
195 IN CONST CM_STD_OBJ_ACPI_TABLE_INFO
* CONST AcpiTableInfo
,
196 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL
* CONST CfgMgrProtocol
,
197 OUT EFI_ACPI_DESCRIPTION_HEADER
** Table
200 /** This function pointer describes the interface used by the
201 Table Manager to give the generator an opportunity to free
202 any resources allocated for building the ACPI table.
204 @param [in] This Pointer to the ACPI table generator.
205 @param [in] AcpiTableInfo Pointer to the ACPI Table Info.
206 @param [in] CfgMgrProtocol Pointer to the Configuration Manager
208 @param [in, out] Table Pointer to the ACPI Table.
210 @return EFI_SUCCESS If freed successfully or other failure codes
211 as returned by the generator.
213 typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLE
) (
214 IN CONST ACPI_TABLE_GENERATOR
* CONST This
,
215 IN CONST CM_STD_OBJ_ACPI_TABLE_INFO
* CONST AcpiTableInfo
,
216 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL
* CONST CfgMgrProtocol
,
217 IN OUT EFI_ACPI_DESCRIPTION_HEADER
** CONST Table
220 /** This function pointer describes an extended interface to build
221 ACPI Tables. The ACPI table generator can generate multiple
222 ACPI Tables and return a pointer to the list of ACPI tables.
223 The FreeTableResourcesEx() must be called to free any resources
224 that may have been allocated using this interface.
226 @param [in] This Pointer to the ACPI table generator.
227 @param [in] AcpiTableInfo Pointer to the ACPI table information.
228 @param [in] CfgMgrProtocol Pointer to the Configuration Manager
230 @param [out] Table Pointer to a list of generated ACPI table(s).
231 @param [out] TableCount Number of generated ACPI table(s).
233 @return EFI_SUCCESS If the table is generated successfully or other
234 failure codes as returned by the generator.
236 typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLEEX
) (
237 IN CONST ACPI_TABLE_GENERATOR
* This
,
238 IN CONST CM_STD_OBJ_ACPI_TABLE_INFO
* CONST AcpiTableInfo
,
239 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL
* CONST CfgMgrProtocol
,
240 OUT EFI_ACPI_DESCRIPTION_HEADER
*** Table
,
241 OUT UINTN
* CONST TableCount
244 /** This function pointer describes an extended interface used by the
245 Table Manager to give the generator an opportunity to free
246 any resources allocated for building the ACPI table. This interface
247 must be used in conjunction with the BuildAcpiTableEx interface.
249 @param [in] This Pointer to the ACPI table generator.
250 @param [in] AcpiTableInfo Pointer to the ACPI Table Info.
251 @param [in] CfgMgrProtocol Pointer to the Configuration Manager
253 @param [in, out] Table Pointer to the list of ACPI Table(s).
254 @param [in] TableCount Number of ACPI table(s).
256 @return EFI_SUCCESS If freed successfully or other failure codes
257 as returned by the generator.
259 typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLEEX
) (
260 IN CONST ACPI_TABLE_GENERATOR
* CONST This
,
261 IN CONST CM_STD_OBJ_ACPI_TABLE_INFO
* CONST AcpiTableInfo
,
262 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL
* CONST CfgMgrProtocol
,
263 IN OUT EFI_ACPI_DESCRIPTION_HEADER
*** CONST Table
,
264 IN CONST UINTN TableCount
267 /** The ACPI_TABLE_GENERATOR structure provides an interface that the
268 Table Manager can use to invoke the functions to build ACPI tables.
270 Note: Although the Generator is required to implement at least
271 one pair of interfaces (BuildAcpiTable & FreeTableResources or
272 BuildAcpiTableEx & FreeTableResourcesEx) for generating the ACPI
273 table(s), if both pair of interfaces are implemented the extended
274 version will take precedence.
276 typedef struct AcpiTableGenerator
{
277 /// The ACPI table generator ID.
278 ACPI_TABLE_GENERATOR_ID GeneratorID
;
280 /// String describing the ACPI table generator.
281 CONST CHAR16
* Description
;
283 /// The ACPI table signature.
284 UINT32 AcpiTableSignature
;
286 /// The ACPI table revision.
287 UINT32 AcpiTableRevision
;
289 /// The minimum supported ACPI table revision.
290 UINT32 MinAcpiTableRevision
;
292 /// The ACPI table creator ID.
295 /// The ACPI table creator revision.
296 UINT32 CreatorRevision
;
298 /// ACPI table build function pointer.
299 ACPI_TABLE_GENERATOR_BUILD_TABLE BuildAcpiTable
;
301 /** The function to free any resources
302 allocated for building the ACPI table.
304 ACPI_TABLE_GENERATOR_FREE_TABLE FreeTableResources
;
306 /// ACPI table extended build function pointer.
307 ACPI_TABLE_GENERATOR_BUILD_TABLEEX BuildAcpiTableEx
;
309 /** The function to free any resources
310 allocated for building the ACPI table
311 using the extended interface.
313 ACPI_TABLE_GENERATOR_FREE_TABLEEX FreeTableResourcesEx
;
314 } ACPI_TABLE_GENERATOR
;
316 /** Register ACPI table factory generator.
318 The ACPI table factory maintains a list of the Standard and OEM ACPI
321 @param [in] Generator Pointer to the ACPI table generator.
323 @retval EFI_SUCCESS The Generator was registered
325 @retval EFI_INVALID_PARAMETER The Generator ID is invalid or
326 the Generator pointer is NULL.
327 @retval EFI_ALREADY_STARTED The Generator for the Table ID is
332 RegisterAcpiTableGenerator (
333 IN CONST ACPI_TABLE_GENERATOR
* CONST Generator
336 /** Deregister ACPI generator.
338 This function is called by the ACPI table generator to deregister itself
339 from the ACPI table factory.
341 @param [in] Generator Pointer to the ACPI table generator.
343 @retval EFI_SUCCESS Success.
344 @retval EFI_INVALID_PARAMETER The generator is invalid.
345 @retval EFI_NOT_FOUND The requested generator is not found
346 in the list of registered generators.
350 DeregisterAcpiTableGenerator (
351 IN CONST ACPI_TABLE_GENERATOR
* CONST Generator
356 #endif // ACPI_TABLE_GENERATOR_H_