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

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