DynamicTablesPkg/Include/AcpiTableGenerator.h

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