--- /dev/null
+/** @file\r
+\r
+ Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r
+\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+ @par Glossary:\r
+ - Cm or CM - Configuration Manager\r
+ - Obj or OBJ - Object\r
+ - Std or STD - Standard\r
+**/\r
+\r
+#ifndef ACPI_TABLE_GENERATOR_H_\r
+#define ACPI_TABLE_GENERATOR_H_\r
+\r
+#include <IndustryStandard/Acpi.h>\r
+\r
+// Module specific include files.\r
+#include <TableGenerator.h>\r
+\r
+#pragma pack(1)\r
+\r
+/**\r
+The Dynamic Tables Framework provisions two classes of ACPI table\r
+generators.\r
+ - Standard generators: The ACPI table generators implemented by the\r
+ Dynamic Tables Framework.\r
+ - OEM generators: The ACPI table generators customized by the OEM.\r
+\r
+The Dynamic Tables Framework implements the following ACPI table generators:\r
+ - RAW : This is the simplest ACPI table generator. It simply installs\r
+ the ACPI table provided in the AcpiTableData member of the\r
+ CM_STD_OBJ_ACPI_TABLE_INFO. The ACPI table data is provided by\r
+ the Configuration Manager and is generated using an implementation\r
+ defined mechanism.\r
+ - DSDT : The DSDT generator is a clone of the RAW generator. The difference\r
+ is in the way the ACPI Table Data is generated from an AML file.\r
+ - SSDT : The SSDT generator is a clone of the RAW generator. The difference\r
+ is in the way the ACPI Table Data is generated from an AML file.\r
+ - FADT : The FADT generator collates the required platform information from\r
+ the Configuration Manager and builds the FADT table.\r
+ - MADT : The MADT generator collates the GIC information from the\r
+ Configuration Manager and builds the MADT table.\r
+ - GTDT : The GTDT generator collates the Timer information from the\r
+ Configuration Manager and builds the GTDT table.\r
+ - DBG2 : The DBG2 generator collates the debug serial port information from\r
+ the Configuration Manager and builds the DBG2 table.\r
+ - SPCR : The SPCR generator collates the serial port information from the\r
+ Configuration Manager and builds the SPCR table.\r
+ - MCFG : The MCFG generator collates the PCI configuration space information\r
+ from the Configuration Manager and builds the MCFG table.\r
+ - IORT : The IORT generator collates the IO Topology information from the\r
+ Configuration Manager and builds the IORT table.\r
+*/\r
+\r
+/** The ACPI_TABLE_GENERATOR_ID type describes ACPI table generator ID.\r
+*/\r
+typedef TABLE_GENERATOR_ID ACPI_TABLE_GENERATOR_ID;\r
+\r
+/** The ESTD_ACPI_TABLE_ID enum describes the ACPI table IDs reserved for\r
+ the standard generators.\r
+*/\r
+typedef enum StdAcpiTableId {\r
+ EStdAcpiTableIdReserved = 0x0000, ///< Reserved\r
+ EStdAcpiTableIdRaw, ///< RAW Generator\r
+ EStdAcpiTableIdDsdt = EStdAcpiTableIdRaw, ///< DSDT Generator\r
+ EStdAcpiTableIdSsdt = EStdAcpiTableIdRaw, ///< SSDT Generator\r
+ EStdAcpiTableIdFadt, ///< FADT Generator\r
+ EStdAcpiTableIdMadt, ///< MADT Generator\r
+ EStdAcpiTableIdGtdt, ///< GTDT Generator\r
+ EStdAcpiTableIdDbg2, ///< DBG2 Generator\r
+ EStdAcpiTableIdSpcr, ///< SPCR Generator\r
+ EStdAcpiTableIdMcfg, ///< MCFG Generator\r
+ EStdAcpiTableIdIort, ///< IORT Generator\r
+ EStdAcpiTableIdMax\r
+} ESTD_ACPI_TABLE_ID;\r
+\r
+/** This macro checks if the Table Generator ID is for an ACPI Table Generator.\r
+\r
+ @param [in] TableGeneratorId The table generator ID.\r
+\r
+ @return TRUE if the table generator ID is for an ACPI Table\r
+ Generator.\r
+**/\r
+#define IS_GENERATOR_TYPE_ACPI(TableGeneratorId) \\r
+ (GET_TABLE_TYPE (TableGeneratorId) == ETableGeneratorTypeAcpi)\r
+\r
+/** This macro checks if the Table Generator ID is for a standard ACPI\r
+ Table Generator.\r
+\r
+ @param [in] TableGeneratorId The table generator ID.\r
+\r
+ @return TRUE if the table generator ID is for a standard ACPI\r
+ Table Generator.\r
+**/\r
+#define IS_VALID_STD_ACPI_GENERATOR_ID(TableGeneratorId) \\r
+ ( \\r
+ IS_GENERATOR_NAMESPACE_STD (TableGeneratorId) && \\r
+ IS_GENERATOR_TYPE_ACPI (TableGeneratorId) && \\r
+ ((GET_TABLE_ID (GeneratorId) >= EStdAcpiTableIdRaw) && \\r
+ (GET_TABLE_ID (GeneratorId) < EStdAcpiTableIdMax)) \\r
+ )\r
+\r
+/** This macro creates a standard ACPI Table Generator ID.\r
+\r
+ @param [in] TableId The table generator ID.\r
+\r
+ @return a standard ACPI table generator ID.\r
+**/\r
+#define CREATE_STD_ACPI_TABLE_GEN_ID(TableId) \\r
+ CREATE_TABLE_GEN_ID ( \\r
+ ETableGeneratorTypeAcpi, \\r
+ ETableGeneratorNameSpaceStd, \\r
+ TableId \\r
+ )\r
+\r
+/** This macro creates an OEM ACPI Table Generator ID.\r
+\r
+ @param [in] TableId The table generator ID.\r
+\r
+ @return an OEM ACPI table generator ID.\r
+**/\r
+#define CREATE_OEM_ACPI_TABLE_GEN_ID(TableId) \\r
+ CREATE_TABLE_GEN_ID ( \\r
+ ETableGeneratorTypeAcpi, \\r
+ ETableGeneratorNameSpaceOem, \\r
+ TableId \\r
+ )\r
+\r
+/** The Creator ID for the ACPI tables generated using\r
+ the standard ACPI table generators.\r
+*/\r
+#define TABLE_GENERATOR_CREATOR_ID_ARM SIGNATURE_32('A', 'R', 'M', 'H')\r
+\r
+/** A macro to initialise the common header part of EFI ACPI tables as\r
+ defined by the EFI_ACPI_DESCRIPTION_HEADER structure.\r
+\r
+ @param [in] Signature The ACPI table signature.\r
+ @param [in] Type The ACPI table structure.\r
+ @param [in] Revision The ACPI table revision.\r
+**/\r
+#define ACPI_HEADER(Signature, Type, Revision) { \\r
+ Signature, /* UINT32 Signature */ \\r
+ sizeof (Type), /* UINT32 Length */ \\r
+ Revision, /* UINT8 Revision */ \\r
+ 0, /* UINT8 Checksum */ \\r
+ { 0, 0, 0, 0, 0, 0 }, /* UINT8 OemId[6] */ \\r
+ 0, /* UINT64 OemTableId */ \\r
+ 0, /* UINT32 OemRevision */ \\r
+ 0, /* UINT32 CreatorId */ \\r
+ 0 /* UINT32 CreatorRevision */\\r
+ }\r
+\r
+/** A macro to dump the common header part of EFI ACPI tables as\r
+ defined by the EFI_ACPI_DESCRIPTION_HEADER structure.\r
+\r
+ @param [in] AcpiHeader The pointer to the ACPI table header.\r
+**/\r
+#define DUMP_ACPI_TABLE_HEADER(AcpiHeader) \\r
+ DEBUG (( \\r
+ DEBUG_INFO, \\r
+ "ACPI TABLE %c%c%c%c : Rev 0x%x : Length : 0x%x\n", \\r
+ (AcpiHeader->Signature & 0xFF), \\r
+ ((AcpiHeader->Signature >> 8) & 0xFF), \\r
+ ((AcpiHeader->Signature >> 16) & 0xFF), \\r
+ ((AcpiHeader->Signature >> 24) & 0xFF), \\r
+ AcpiHeader->Revision, \\r
+ AcpiHeader->Length \\r
+ ));\r
+\r
+/** Forward declarations.\r
+*/\r
+typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;\r
+typedef struct CmAStdObjAcpiTableInfo CM_STD_OBJ_ACPI_TABLE_INFO;\r
+typedef struct AcpiTableGenerator ACPI_TABLE_GENERATOR;\r
+\r
+/** This function pointer describes the interface to ACPI table build\r
+ functions provided by the ACPI table generator and called by the\r
+ Table Manager to build an ACPI table.\r
+\r
+ @param [in] This Pointer to the ACPI table generator.\r
+ @param [in] AcpiTableInfo Pointer to the ACPI table information.\r
+ @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
+ Protocol interface.\r
+ @param [out] Table Pointer to the generated ACPI table.\r
+\r
+ @return EFI_SUCCESS If the table is generated successfully or other\r
+ failure codes as returned by the generator.\r
+**/\r
+typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLE) (\r
+ IN CONST ACPI_TABLE_GENERATOR * This,\r
+ IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r
+ IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
+ OUT EFI_ACPI_DESCRIPTION_HEADER ** Table\r
+ );\r
+\r
+/** This function pointer describes the interface used by the\r
+ Table Manager to give the generator an opportunity to free\r
+ any resources allocated for building the ACPI table.\r
+\r
+ @param [in] This Pointer to the ACPI table generator.\r
+ @param [in] AcpiTableInfo Pointer to the ACPI Table Info.\r
+ @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
+ Protocol Interface.\r
+ @param [in, out] Table Pointer to the ACPI Table.\r
+\r
+ @return EFI_SUCCESS If freed successfully or other failure codes\r
+ as returned by the generator.\r
+**/\r
+typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLE) (\r
+ IN CONST ACPI_TABLE_GENERATOR * CONST This,\r
+ IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r
+ IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
+ IN OUT EFI_ACPI_DESCRIPTION_HEADER ** CONST Table\r
+ );\r
+\r
+/** This function pointer describes an extended interface to build\r
+ ACPI Tables. The ACPI table generator can generate multiple\r
+ ACPI Tables and return a pointer to the list of ACPI tables.\r
+ The FreeTableResourcesEx() must be called to free any resources\r
+ that may have been allocated using this interface.\r
+\r
+ @param [in] This Pointer to the ACPI table generator.\r
+ @param [in] AcpiTableInfo Pointer to the ACPI table information.\r
+ @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
+ Protocol interface.\r
+ @param [out] Table Pointer to a list of generated ACPI table(s).\r
+ @param [out] TableCount Number of generated ACPI table(s).\r
+\r
+ @return EFI_SUCCESS If the table is generated successfully or other\r
+ failure codes as returned by the generator.\r
+**/\r
+typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLEEX) (\r
+ IN CONST ACPI_TABLE_GENERATOR * This,\r
+ IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r
+ IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
+ OUT EFI_ACPI_DESCRIPTION_HEADER *** Table,\r
+ OUT UINTN * CONST TableCount\r
+ );\r
+\r
+/** This function pointer describes an extended interface used by the\r
+ Table Manager to give the generator an opportunity to free\r
+ any resources allocated for building the ACPI table. This interface\r
+ must be used in conjunction with the BuildAcpiTableEx interface.\r
+\r
+ @param [in] This Pointer to the ACPI table generator.\r
+ @param [in] AcpiTableInfo Pointer to the ACPI Table Info.\r
+ @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
+ Protocol Interface.\r
+ @param [in, out] Table Pointer to the list of ACPI Table(s).\r
+ @param [in] TableCount Number of ACPI table(s).\r
+\r
+ @return EFI_SUCCESS If freed successfully or other failure codes\r
+ as returned by the generator.\r
+**/\r
+typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLEEX) (\r
+ IN CONST ACPI_TABLE_GENERATOR * CONST This,\r
+ IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r
+ IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
+ IN OUT EFI_ACPI_DESCRIPTION_HEADER *** CONST Table,\r
+ IN CONST UINTN TableCount\r
+ );\r
+\r
+/** The ACPI_TABLE_GENERATOR structure provides an interface that the\r
+ Table Manager can use to invoke the functions to build ACPI tables.\r
+\r
+ Note: Although the Generator is required to implement at least\r
+ one pair of interfaces (BuildAcpiTable & FreeTableResources or\r
+ BuildAcpiTableEx & FreeTableResourcesEx) for generating the ACPI\r
+ table(s), if both pair of interfaces are implemented the extended\r
+ version will take precedence.\r
+**/\r
+typedef struct AcpiTableGenerator {\r
+ /// The ACPI table generator ID.\r
+ ACPI_TABLE_GENERATOR_ID GeneratorID;\r
+\r
+ /// String describing the ACPI table generator.\r
+ CONST CHAR16 * Description;\r
+\r
+ /// The ACPI table signature.\r
+ UINT32 AcpiTableSignature;\r
+\r
+ /// The ACPI table revision.\r
+ UINT32 AcpiTableRevision;\r
+\r
+ /// The minimum supported ACPI table revision.\r
+ UINT32 MinAcpiTableRevision;\r
+\r
+ /// The ACPI table creator ID.\r
+ UINT32 CreatorId;\r
+\r
+ /// The ACPI table creator revision.\r
+ UINT32 CreatorRevision;\r
+\r
+ /// ACPI table build function pointer.\r
+ ACPI_TABLE_GENERATOR_BUILD_TABLE BuildAcpiTable;\r
+\r
+ /** The function to free any resources\r
+ allocated for building the ACPI table.\r
+ */\r
+ ACPI_TABLE_GENERATOR_FREE_TABLE FreeTableResources;\r
+\r
+ /// ACPI table extended build function pointer.\r
+ ACPI_TABLE_GENERATOR_BUILD_TABLEEX BuildAcpiTableEx;\r
+\r
+ /** The function to free any resources\r
+ allocated for building the ACPI table\r
+ using the extended interface.\r
+ */\r
+ ACPI_TABLE_GENERATOR_FREE_TABLEEX FreeTableResourcesEx;\r
+} ACPI_TABLE_GENERATOR;\r
+\r
+/** Register ACPI table factory generator.\r
+\r
+ The ACPI table factory maintains a list of the Standard and OEM ACPI\r
+ table generators.\r
+\r
+ @param [in] Generator Pointer to the ACPI table generator.\r
+\r
+ @retval EFI_SUCCESS The Generator was registered\r
+ successfully.\r
+ @retval EFI_INVALID_PARAMETER The Generator ID is invalid or\r
+ the Generator pointer is NULL.\r
+ @retval EFI_ALREADY_STARTED The Generator for the Table ID is\r
+ already registered.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RegisterAcpiTableGenerator (\r
+ IN CONST ACPI_TABLE_GENERATOR * CONST Generator\r
+ );\r
+\r
+/** Deregister ACPI generator.\r
+\r
+ This function is called by the ACPI table generator to deregister itself\r
+ from the ACPI table factory.\r
+\r
+ @param [in] Generator Pointer to the ACPI table generator.\r
+\r
+ @retval EFI_SUCCESS Success.\r
+ @retval EFI_INVALID_PARAMETER The generator is invalid.\r
+ @retval EFI_NOT_FOUND The requested generator is not found\r
+ in the list of registered generators.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DeregisterAcpiTableGenerator (\r
+ IN CONST ACPI_TABLE_GENERATOR * CONST Generator\r
+ );\r
+\r
+#pragma pack()\r
+\r
+#endif // ACPI_TABLE_GENERATOR_H_\r
+\r
projects / mirror_edk2.git / commitdiff