AcpiTableGenerator.h

Go to the documentation of this file.

 
#ifndef ACPI_TABLE_GENERATOR_H_
#define ACPI_TABLE_GENERATOR_H_
 
#include <IndustryStandard/Acpi.h>
 
// Module specific include files.
#include <TableGenerator.h>
 
#pragma pack(1)
 
typedef TABLE_GENERATOR_ID ACPI_TABLE_GENERATOR_ID;
 
typedef enum StdAcpiTableId {
  EStdAcpiTableIdReserved = 0x0000,             
  EStdAcpiTableIdRaw,                           
  EStdAcpiTableIdDsdt = EStdAcpiTableIdRaw,     
  EStdAcpiTableIdSsdt = EStdAcpiTableIdRaw,     
  EStdAcpiTableIdFadt,                          
  EStdAcpiTableIdMadt,                          
  EStdAcpiTableIdGtdt,                          
  EStdAcpiTableIdDbg2,                          
  EStdAcpiTableIdSpcr,                          
  EStdAcpiTableIdMcfg,                          
  EStdAcpiTableIdIort,                          
  EStdAcpiTableIdPptt,                          
  EStdAcpiTableIdSrat,                          
  EStdAcpiTableIdSsdtSerialPort,                
  EStdAcpiTableIdSsdtCmn600,                    
  EStdAcpiTableIdSsdtCpuTopology,               
  EStdAcpiTableIdSsdtPciExpress,                
  EStdAcpiTableIdPcct,                          
  EStdAcpiTableIdTpm2,                          
  EStdAcpiTableIdWsmt,                          
  EStdAcpiTableIdHpet,                          
  EStdAcpiTableIdSsdtHpet,                      
  EStdAcpiTableIdSpmi,                          
  EStdAcpiTableIdMax
} ESTD_ACPI_TABLE_ID;
 
#define IS_GENERATOR_TYPE_ACPI(TableGeneratorId) \
          (GET_TABLE_TYPE (TableGeneratorId) == ETableGeneratorTypeAcpi)
 
#define IS_VALID_STD_ACPI_GENERATOR_ID(TableGeneratorId)           \
          (                                                        \
          IS_GENERATOR_NAMESPACE_STD (TableGeneratorId) &&         \
          IS_GENERATOR_TYPE_ACPI (TableGeneratorId)     &&         \
          ((GET_TABLE_ID (GeneratorId) >= EStdAcpiTableIdRaw) &&   \
           (GET_TABLE_ID (GeneratorId) < EStdAcpiTableIdMax))      \
          )
 
#define CREATE_STD_ACPI_TABLE_GEN_ID(TableId) \
          CREATE_TABLE_GEN_ID (               \
            ETableGeneratorTypeAcpi,          \
            ETableGeneratorNameSpaceStd,      \
            TableId                           \
            )
 
#define CREATE_OEM_ACPI_TABLE_GEN_ID(TableId) \
          CREATE_TABLE_GEN_ID (               \
            ETableGeneratorTypeAcpi,          \
            ETableGeneratorNameSpaceOem,      \
            TableId                           \
            )
 
#define TABLE_GENERATOR_CREATOR_ID  SIGNATURE_32('D', 'Y', 'N', 'T')
 
#define TABLE_GENERATOR_CREATOR_ID_ARM  SIGNATURE_32('A', 'R', 'M', 'H')
 
#define ACPI_HEADER(Signature, Type, Revision)  {             \
          Signature,             /* UINT32  Signature */      \
          sizeof (Type),         /* UINT32  Length */         \
          Revision,              /* UINT8   Revision */       \
          0,                     /* UINT8   Checksum */       \
          { 0, 0, 0, 0, 0, 0 },  /* UINT8   OemId[6] */       \
          0,                     /* UINT64  OemTableId */     \
          0,                     /* UINT32  OemRevision */    \
          0,                     /* UINT32  CreatorId */      \
          0                      /* UINT32  CreatorRevision */ \
          }
 
#define DUMP_ACPI_TABLE_HEADER(AcpiHeader)                        \
          DEBUG ((                                                \
            DEBUG_INFO,                                           \
            "ACPI TABLE %c%c%c%c : Rev 0x%x : Length : 0x%x\n",   \
            (AcpiHeader->Signature & 0xFF),                       \
            ((AcpiHeader->Signature >> 8) & 0xFF),                \
            ((AcpiHeader->Signature >> 16) & 0xFF),               \
            ((AcpiHeader->Signature >> 24) & 0xFF),               \
            AcpiHeader->Revision,                                 \
            AcpiHeader->Length                                    \
            ));
 
typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;
typedef struct CmAStdObjAcpiTableInfo       CM_STD_OBJ_ACPI_TABLE_INFO;
typedef struct AcpiTableGenerator           ACPI_TABLE_GENERATOR;
 
typedef EFI_STATUS (EFIAPI *ACPI_TABLE_GENERATOR_BUILD_TABLE)(
  IN  CONST ACPI_TABLE_GENERATOR                           *This,
  IN  CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,
  OUT       EFI_ACPI_DESCRIPTION_HEADER                    **Table
  );
 
typedef EFI_STATUS (EFIAPI *ACPI_TABLE_GENERATOR_FREE_TABLE)(
  IN      CONST ACPI_TABLE_GENERATOR                   *CONST  This,
  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,
  IN OUT        EFI_ACPI_DESCRIPTION_HEADER           **CONST  Table
  );
 
typedef EFI_STATUS (EFIAPI *ACPI_TABLE_GENERATOR_BUILD_TABLEEX)(
  IN  CONST ACPI_TABLE_GENERATOR                           *This,
  IN  CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,
  OUT       EFI_ACPI_DESCRIPTION_HEADER                    ***Table,
  OUT       UINTN                                  *CONST  TableCount
  );
 
typedef EFI_STATUS (EFIAPI *ACPI_TABLE_GENERATOR_FREE_TABLEEX)(
  IN      CONST ACPI_TABLE_GENERATOR                   *CONST  This,
  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO             *CONST  AcpiTableInfo,
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL   *CONST  CfgMgrProtocol,
  IN OUT        EFI_ACPI_DESCRIPTION_HEADER          ***CONST  Table,
  IN      CONST UINTN                                          TableCount
  );
 
typedef struct AcpiTableGenerator {
  ACPI_TABLE_GENERATOR_ID               GeneratorID;
 
  CONST CHAR16                          *Description;
 
  UINT32                                AcpiTableSignature;
 
  UINT8                                 AcpiTableRevision;
 
  UINT8                                 MinAcpiTableRevision;
 
  UINT32                                CreatorId;
 
  UINT32                                CreatorRevision;
 
  ACPI_TABLE_GENERATOR_BUILD_TABLE      BuildAcpiTable;
 
  ACPI_TABLE_GENERATOR_FREE_TABLE       FreeTableResources;
 
  ACPI_TABLE_GENERATOR_BUILD_TABLEEX    BuildAcpiTableEx;
 
  ACPI_TABLE_GENERATOR_FREE_TABLEEX     FreeTableResourcesEx;
} ACPI_TABLE_GENERATOR;
 
EFI_STATUS
EFIAPI
RegisterAcpiTableGenerator (
  IN CONST ACPI_TABLE_GENERATOR                 *CONST  Generator
  );
 
EFI_STATUS
EFIAPI
DeregisterAcpiTableGenerator (
  IN CONST ACPI_TABLE_GENERATOR                 *CONST  Generator
  );
 
#pragma pack()
 
#endif // ACPI_TABLE_GENERATOR_H_