[mirror_edk2.git] / DynamicTablesPkg / Include / AcpiTableGenerator.h

/** @file\r
\r
  Copyright (c) 2017 - 2022, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\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
  - PPTT  : The PPTT generator collates the processor topology information from\r
            the Configuration Manager and builds the PPTT table.\r
  - SRAT  : The SRAT generator collates the system resource affinity information\r
            from the Configuration Manager and builds the SRAT table.\r
  - SSDT Serial-Port:\r
            The SSDT Serial generator collates the Serial port information\r
            from the Configuration Manager and patches the SSDT Serial Port\r
            template to build the SSDT Serial port table.\r
  - SSDT CMN-600:\r
            The SSDT CMN-600 generator collates the CMN-600 information\r
            from the Configuration Manager and patches the SSDT CMN-600\r
            template to build the SSDT CMN-600 table.\r
  - SSDT Cpu-Topology:\r
            The SSDT Cpu-Topology generator collates the cpu and LPI\r
            information from the Configuration Manager and generates a\r
            SSDT table describing the CPU hierarchy.\r
  - SSDT Pci-Express:\r
            The SSDT Pci Express generator collates the Pci Express\r
            information from the Configuration Manager and generates a\r
            SSDT table describing a Pci Express bus.\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
  EStdAcpiTableIdPptt,                          ///< PPTT Generator\r
  EStdAcpiTableIdSrat,                          ///< SRAT Generator\r
  EStdAcpiTableIdSsdtSerialPort,                ///< SSDT Serial-Port Generator\r
  EStdAcpiTableIdSsdtCmn600,                    ///< SSDT Cmn-600 Generator\r
  EStdAcpiTableIdSsdtCpuTopology,               ///< SSDT Cpu Topology\r
  EStdAcpiTableIdSsdtPciExpress,                ///< SSDT Pci Express Generator\r
  EStdAcpiTableIdPcct,                          ///< PCCT 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
  UINT8                                 AcpiTableRevision;\r
\r
  /// The minimum supported ACPI table revision.\r
  UINT8                                 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
Commit	Line	Data
	1	/** @file\r
	2	\r
	3	Copyright (c) 2017 - 2022, Arm Limited. All rights reserved.<BR>\r
	4	\r
	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	6	\r
	7	@par Glossary:\r
	8	- Cm or CM - Configuration Manager\r
	9	- Obj or OBJ - Object\r
	10	- Std or STD - Standard\r
	11	**/\r
	12	\r
	13	#ifndef ACPI_TABLE_GENERATOR_H_\r
	14	#define ACPI_TABLE_GENERATOR_H_\r
	15	\r
	16	#include <IndustryStandard/Acpi.h>\r
	17	\r
	18	// Module specific include files.\r
	19	#include <TableGenerator.h>\r
	20	\r
	21	#pragma pack(1)\r
	22	\r
	23	/**\r
	24	The Dynamic Tables Framework provisions two classes of ACPI table\r
	25	generators.\r
	26	- Standard generators: The ACPI table generators implemented by the\r
	27	Dynamic Tables Framework.\r
	28	- OEM generators: The ACPI table generators customized by the OEM.\r
	29	\r
	30	The Dynamic Tables Framework implements the following ACPI table generators:\r
	31	- RAW : This is the simplest ACPI table generator. It simply installs\r
	32	the ACPI table provided in the AcpiTableData member of the\r
	33	CM_STD_OBJ_ACPI_TABLE_INFO. The ACPI table data is provided by\r
	34	the Configuration Manager and is generated using an implementation\r
	35	defined mechanism.\r
	36	- DSDT : The DSDT generator is a clone of the RAW generator. The difference\r
	37	is in the way the ACPI Table Data is generated from an AML file.\r
	38	- SSDT : The SSDT generator is a clone of the RAW generator. The difference\r
	39	is in the way the ACPI Table Data is generated from an AML file.\r
	40	- FADT : The FADT generator collates the required platform information from\r
	41	the Configuration Manager and builds the FADT table.\r
	42	- MADT : The MADT generator collates the GIC information from the\r
	43	Configuration Manager and builds the MADT table.\r
	44	- GTDT : The GTDT generator collates the Timer information from the\r
	45	Configuration Manager and builds the GTDT table.\r
	46	- DBG2 : The DBG2 generator collates the debug serial port information from\r
	47	the Configuration Manager and builds the DBG2 table.\r
	48	- SPCR : The SPCR generator collates the serial port information from the\r
	49	Configuration Manager and builds the SPCR table.\r
	50	- MCFG : The MCFG generator collates the PCI configuration space information\r
	51	from the Configuration Manager and builds the MCFG table.\r
	52	- IORT : The IORT generator collates the IO Topology information from the\r
	53	Configuration Manager and builds the IORT table.\r
	54	- PPTT : The PPTT generator collates the processor topology information from\r
	55	the Configuration Manager and builds the PPTT table.\r
	56	- SRAT : The SRAT generator collates the system resource affinity information\r
	57	from the Configuration Manager and builds the SRAT table.\r
	58	- SSDT Serial-Port:\r
	59	The SSDT Serial generator collates the Serial port information\r
	60	from the Configuration Manager and patches the SSDT Serial Port\r
	61	template to build the SSDT Serial port table.\r
	62	- SSDT CMN-600:\r
	63	The SSDT CMN-600 generator collates the CMN-600 information\r
	64	from the Configuration Manager and patches the SSDT CMN-600\r
	65	template to build the SSDT CMN-600 table.\r
	66	- SSDT Cpu-Topology:\r
	67	The SSDT Cpu-Topology generator collates the cpu and LPI\r
	68	information from the Configuration Manager and generates a\r
	69	SSDT table describing the CPU hierarchy.\r
	70	- SSDT Pci-Express:\r
	71	The SSDT Pci Express generator collates the Pci Express\r
	72	information from the Configuration Manager and generates a\r
	73	SSDT table describing a Pci Express bus.\r
	74	*/\r
	75	\r
	76	/** The ACPI_TABLE_GENERATOR_ID type describes ACPI table generator ID.\r
	77	*/\r
	78	typedef TABLE_GENERATOR_ID ACPI_TABLE_GENERATOR_ID;\r
	79	\r
	80	/** The ESTD_ACPI_TABLE_ID enum describes the ACPI table IDs reserved for\r
	81	the standard generators.\r
	82	*/\r
	83	typedef enum StdAcpiTableId {\r
	84	EStdAcpiTableIdReserved = 0x0000, ///< Reserved\r
	85	EStdAcpiTableIdRaw, ///< RAW Generator\r
	86	EStdAcpiTableIdDsdt = EStdAcpiTableIdRaw, ///< DSDT Generator\r
	87	EStdAcpiTableIdSsdt = EStdAcpiTableIdRaw, ///< SSDT Generator\r
	88	EStdAcpiTableIdFadt, ///< FADT Generator\r
	89	EStdAcpiTableIdMadt, ///< MADT Generator\r
	90	EStdAcpiTableIdGtdt, ///< GTDT Generator\r
	91	EStdAcpiTableIdDbg2, ///< DBG2 Generator\r
	92	EStdAcpiTableIdSpcr, ///< SPCR Generator\r
	93	EStdAcpiTableIdMcfg, ///< MCFG Generator\r
	94	EStdAcpiTableIdIort, ///< IORT Generator\r
	95	EStdAcpiTableIdPptt, ///< PPTT Generator\r
	96	EStdAcpiTableIdSrat, ///< SRAT Generator\r
	97	EStdAcpiTableIdSsdtSerialPort, ///< SSDT Serial-Port Generator\r
	98	EStdAcpiTableIdSsdtCmn600, ///< SSDT Cmn-600 Generator\r
	99	EStdAcpiTableIdSsdtCpuTopology, ///< SSDT Cpu Topology\r
	100	EStdAcpiTableIdSsdtPciExpress, ///< SSDT Pci Express Generator\r
	101	EStdAcpiTableIdPcct, ///< PCCT Generator\r
	102	EStdAcpiTableIdMax\r
	103	} ESTD_ACPI_TABLE_ID;\r
	104	\r
	105	/** This macro checks if the Table Generator ID is for an ACPI Table Generator.\r
	106	\r
	107	@param [in] TableGeneratorId The table generator ID.\r
	108	\r
	109	@return TRUE if the table generator ID is for an ACPI Table\r
	110	Generator.\r
	111	**/\r
	112	#define IS_GENERATOR_TYPE_ACPI(TableGeneratorId) \\r
	113	(GET_TABLE_TYPE (TableGeneratorId) == ETableGeneratorTypeAcpi)\r
	114	\r
	115	/** This macro checks if the Table Generator ID is for a standard ACPI\r
	116	Table Generator.\r
	117	\r
	118	@param [in] TableGeneratorId The table generator ID.\r
	119	\r
	120	@return TRUE if the table generator ID is for a standard ACPI\r
	121	Table Generator.\r
	122	**/\r
	123	#define IS_VALID_STD_ACPI_GENERATOR_ID(TableGeneratorId) \\r
	124	( \\r
	125	IS_GENERATOR_NAMESPACE_STD (TableGeneratorId) && \\r
	126	IS_GENERATOR_TYPE_ACPI (TableGeneratorId) && \\r
	127	((GET_TABLE_ID (GeneratorId) >= EStdAcpiTableIdRaw) && \\r
	128	(GET_TABLE_ID (GeneratorId) < EStdAcpiTableIdMax)) \\r
	129	)\r
	130	\r
	131	/** This macro creates a standard ACPI Table Generator ID.\r
	132	\r
	133	@param [in] TableId The table generator ID.\r
	134	\r
	135	@return a standard ACPI table generator ID.\r
	136	**/\r
	137	#define CREATE_STD_ACPI_TABLE_GEN_ID(TableId) \\r
	138	CREATE_TABLE_GEN_ID ( \\r
	139	ETableGeneratorTypeAcpi, \\r
	140	ETableGeneratorNameSpaceStd, \\r
	141	TableId \\r
	142	)\r
	143	\r
	144	/** This macro creates an OEM ACPI Table Generator ID.\r
	145	\r
	146	@param [in] TableId The table generator ID.\r
	147	\r
	148	@return an OEM ACPI table generator ID.\r
	149	**/\r
	150	#define CREATE_OEM_ACPI_TABLE_GEN_ID(TableId) \\r
	151	CREATE_TABLE_GEN_ID ( \\r
	152	ETableGeneratorTypeAcpi, \\r
	153	ETableGeneratorNameSpaceOem, \\r
	154	TableId \\r
	155	)\r
	156	\r
	157	/** The Creator ID for the ACPI tables generated using\r
	158	the standard ACPI table generators.\r
	159	*/\r
	160	#define TABLE_GENERATOR_CREATOR_ID_ARM SIGNATURE_32('A', 'R', 'M', 'H')\r
	161	\r
	162	/** A macro to initialise the common header part of EFI ACPI tables as\r
	163	defined by the EFI_ACPI_DESCRIPTION_HEADER structure.\r
	164	\r
	165	@param [in] Signature The ACPI table signature.\r
	166	@param [in] Type The ACPI table structure.\r
	167	@param [in] Revision The ACPI table revision.\r
	168	**/\r
	169	#define ACPI_HEADER(Signature, Type, Revision) { \\r
	170	Signature, /* UINT32 Signature */ \\r
	171	sizeof (Type), /* UINT32 Length */ \\r
	172	Revision, /* UINT8 Revision */ \\r
	173	0, /* UINT8 Checksum */ \\r
	174	{ 0, 0, 0, 0, 0, 0 }, /* UINT8 OemId[6] */ \\r
	175	0, /* UINT64 OemTableId */ \\r
	176	0, /* UINT32 OemRevision */ \\r
	177	0, /* UINT32 CreatorId */ \\r
	178	0 /* UINT32 CreatorRevision */ \\r
	179	}\r
	180	\r
	181	/** A macro to dump the common header part of EFI ACPI tables as\r
	182	defined by the EFI_ACPI_DESCRIPTION_HEADER structure.\r
	183	\r
	184	@param [in] AcpiHeader The pointer to the ACPI table header.\r
	185	**/\r
	186	#define DUMP_ACPI_TABLE_HEADER(AcpiHeader) \\r
	187	DEBUG (( \\r
	188	DEBUG_INFO, \\r
	189	"ACPI TABLE %c%c%c%c : Rev 0x%x : Length : 0x%x\n", \\r
	190	(AcpiHeader->Signature & 0xFF), \\r
	191	((AcpiHeader->Signature >> 8) & 0xFF), \\r
	192	((AcpiHeader->Signature >> 16) & 0xFF), \\r
	193	((AcpiHeader->Signature >> 24) & 0xFF), \\r
	194	AcpiHeader->Revision, \\r
	195	AcpiHeader->Length \\r
	196	));\r
	197	\r
	198	/** Forward declarations.\r
	199	*/\r
	200	typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;\r
	201	typedef struct CmAStdObjAcpiTableInfo CM_STD_OBJ_ACPI_TABLE_INFO;\r
	202	typedef struct AcpiTableGenerator ACPI_TABLE_GENERATOR;\r
	203	\r
	204	/** This function pointer describes the interface to ACPI table build\r
	205	functions provided by the ACPI table generator and called by the\r
	206	Table Manager to build an ACPI table.\r
	207	\r
	208	@param [in] This Pointer to the ACPI table generator.\r
	209	@param [in] AcpiTableInfo Pointer to the ACPI table information.\r
	210	@param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
	211	Protocol interface.\r
	212	@param [out] Table Pointer to the generated ACPI table.\r
	213	\r
	214	@return EFI_SUCCESS If the table is generated successfully or other\r
	215	failure codes as returned by the generator.\r
	216	**/\r
	217	typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLE) (\r
	218	IN CONST ACPI_TABLE_GENERATOR *This,\r
	219	IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,\r
	220	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,\r
	221	OUT EFI_ACPI_DESCRIPTION_HEADER **Table\r
	222	);\r
	223	\r
	224	/** This function pointer describes the interface used by the\r
	225	Table Manager to give the generator an opportunity to free\r
	226	any resources allocated for building the ACPI table.\r
	227	\r
	228	@param [in] This Pointer to the ACPI table generator.\r
	229	@param [in] AcpiTableInfo Pointer to the ACPI Table Info.\r
	230	@param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
	231	Protocol Interface.\r
	232	@param [in, out] Table Pointer to the ACPI Table.\r
	233	\r
	234	@return EFI_SUCCESS If freed successfully or other failure codes\r
	235	as returned by the generator.\r
	236	**/\r
	237	typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLE) (\r
	238	IN CONST ACPI_TABLE_GENERATOR *CONST This,\r
	239	IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,\r
	240	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,\r
	241	IN OUT EFI_ACPI_DESCRIPTION_HEADER **CONST Table\r
	242	);\r
	243	\r
	244	/** This function pointer describes an extended interface to build\r
	245	ACPI Tables. The ACPI table generator can generate multiple\r
	246	ACPI Tables and return a pointer to the list of ACPI tables.\r
	247	The FreeTableResourcesEx() must be called to free any resources\r
	248	that may have been allocated using this interface.\r
	249	\r
	250	@param [in] This Pointer to the ACPI table generator.\r
	251	@param [in] AcpiTableInfo Pointer to the ACPI table information.\r
	252	@param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
	253	Protocol interface.\r
	254	@param [out] Table Pointer to a list of generated ACPI table(s).\r
	255	@param [out] TableCount Number of generated ACPI table(s).\r
	256	\r
	257	@return EFI_SUCCESS If the table is generated successfully or other\r
	258	failure codes as returned by the generator.\r
	259	**/\r
	260	typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_BUILD_TABLEEX) (\r
	261	IN CONST ACPI_TABLE_GENERATOR *This,\r
	262	IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,\r
	263	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,\r
	264	OUT EFI_ACPI_DESCRIPTION_HEADER ***Table,\r
	265	OUT UINTN *CONST TableCount\r
	266	);\r
	267	\r
	268	/** This function pointer describes an extended interface used by the\r
	269	Table Manager to give the generator an opportunity to free\r
	270	any resources allocated for building the ACPI table. This interface\r
	271	must be used in conjunction with the BuildAcpiTableEx interface.\r
	272	\r
	273	@param [in] This Pointer to the ACPI table generator.\r
	274	@param [in] AcpiTableInfo Pointer to the ACPI Table Info.\r
	275	@param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
	276	Protocol Interface.\r
	277	@param [in, out] Table Pointer to the list of ACPI Table(s).\r
	278	@param [in] TableCount Number of ACPI table(s).\r
	279	\r
	280	@return EFI_SUCCESS If freed successfully or other failure codes\r
	281	as returned by the generator.\r
	282	**/\r
	283	typedef EFI_STATUS (*ACPI_TABLE_GENERATOR_FREE_TABLEEX) (\r
	284	IN CONST ACPI_TABLE_GENERATOR *CONST This,\r
	285	IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo,\r
	286	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol,\r
	287	IN OUT EFI_ACPI_DESCRIPTION_HEADER ***CONST Table,\r
	288	IN CONST UINTN TableCount\r
	289	);\r
	290	\r
	291	/** The ACPI_TABLE_GENERATOR structure provides an interface that the\r
	292	Table Manager can use to invoke the functions to build ACPI tables.\r
	293	\r
	294	Note: Although the Generator is required to implement at least\r
	295	one pair of interfaces (BuildAcpiTable & FreeTableResources or\r
	296	BuildAcpiTableEx & FreeTableResourcesEx) for generating the ACPI\r
	297	table(s), if both pair of interfaces are implemented the extended\r
	298	version will take precedence.\r
	299	**/\r
	300	typedef struct AcpiTableGenerator {\r
	301	/// The ACPI table generator ID.\r
	302	ACPI_TABLE_GENERATOR_ID GeneratorID;\r
	303	\r
	304	/// String describing the ACPI table generator.\r
	305	CONST CHAR16 *Description;\r
	306	\r
	307	/// The ACPI table signature.\r
	308	UINT32 AcpiTableSignature;\r
	309	\r
	310	/// The ACPI table revision.\r
	311	UINT8 AcpiTableRevision;\r
	312	\r
	313	/// The minimum supported ACPI table revision.\r
	314	UINT8 MinAcpiTableRevision;\r
	315	\r
	316	/// The ACPI table creator ID.\r
	317	UINT32 CreatorId;\r
	318	\r
	319	/// The ACPI table creator revision.\r
	320	UINT32 CreatorRevision;\r
	321	\r
	322	/// ACPI table build function pointer.\r
	323	ACPI_TABLE_GENERATOR_BUILD_TABLE BuildAcpiTable;\r
	324	\r
	325	/** The function to free any resources\r
	326	allocated for building the ACPI table.\r
	327	*/\r
	328	ACPI_TABLE_GENERATOR_FREE_TABLE FreeTableResources;\r
	329	\r
	330	/// ACPI table extended build function pointer.\r
	331	ACPI_TABLE_GENERATOR_BUILD_TABLEEX BuildAcpiTableEx;\r
	332	\r
	333	/** The function to free any resources\r
	334	allocated for building the ACPI table\r
	335	using the extended interface.\r
	336	*/\r
	337	ACPI_TABLE_GENERATOR_FREE_TABLEEX FreeTableResourcesEx;\r
	338	} ACPI_TABLE_GENERATOR;\r
	339	\r
	340	/** Register ACPI table factory generator.\r
	341	\r
	342	The ACPI table factory maintains a list of the Standard and OEM ACPI\r
	343	table generators.\r
	344	\r
	345	@param [in] Generator Pointer to the ACPI table generator.\r
	346	\r
	347	@retval EFI_SUCCESS The Generator was registered\r
	348	successfully.\r
	349	@retval EFI_INVALID_PARAMETER The Generator ID is invalid or\r
	350	the Generator pointer is NULL.\r
	351	@retval EFI_ALREADY_STARTED The Generator for the Table ID is\r
	352	already registered.\r
	353	**/\r
	354	EFI_STATUS\r
	355	EFIAPI\r
	356	RegisterAcpiTableGenerator (\r
	357	IN CONST ACPI_TABLE_GENERATOR *CONST Generator\r
	358	);\r
	359	\r
	360	/** Deregister ACPI generator.\r
	361	\r
	362	This function is called by the ACPI table generator to deregister itself\r
	363	from the ACPI table factory.\r
	364	\r
	365	@param [in] Generator Pointer to the ACPI table generator.\r
	366	\r
	367	@retval EFI_SUCCESS Success.\r
	368	@retval EFI_INVALID_PARAMETER The generator is invalid.\r
	369	@retval EFI_NOT_FOUND The requested generator is not found\r
	370	in the list of registered generators.\r
	371	**/\r
	372	EFI_STATUS\r
	373	EFIAPI\r
	374	DeregisterAcpiTableGenerator (\r
	375	IN CONST ACPI_TABLE_GENERATOR *CONST Generator\r
	376	);\r
	377	\r
	378	#pragma pack()\r
	379	\r
	380	#endif // ACPI_TABLE_GENERATOR_H_\r