DeviceTreeTableGenerator.h

Go to the documentation of this file.

 
#ifndef DEVICETREE_TABLE_GENERATOR_H_
#define DEVICETREE_TABLE_GENERATOR_H_
 
#include <TableGenerator.h>
 
#pragma pack(1)
 
typedef TABLE_GENERATOR_ID DT_TABLE_GENERATOR_ID;
 
typedef enum StdDtTableId {
  EStdDtTableIdReserved = 0x0000,             
  EStdDtTableIdRaw,                           
  EStdDtTableIdMax
} ESTD_DT_TABLE_ID;
 
#define IS_GENERATOR_TYPE_DT(TableGeneratorId) \
          (GET_TABLE_TYPE(TableGeneratorId) == ETableGeneratorTypeDt)
 
#define IS_VALID_STD_DT_GENERATOR_ID(TableGeneratorId)           \
          (                                                      \
          IS_GENERATOR_NAMESPACE_STD(TableGeneratorId) &&        \
          IS_GENERATOR_TYPE_DT(TableGeneratorId)       &&        \
          ((GET_TABLE_ID(GeneratorId) >= EStdDtTableIdRaw) &&    \
           (GET_TABLE_ID(GeneratorId) < EStdDtTableIdMax))       \
          )
 
#define CREATE_STD_DT_TABLE_GEN_ID(TableId) \
          CREATE_TABLE_GEN_ID (             \
            ETableGeneratorTypeDt,          \
            ETableGeneratorNameSpaceStd,    \
            TableId                         \
            )
 
typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;
typedef struct CmAStdObjDtTableInfo         CM_STD_OBJ_DT_TABLE_INFO;
typedef struct DtTableGenerator             DT_TABLE_GENERATOR;
 
typedef EFI_STATUS (*DT_TABLE_GENERATOR_BUILD_TABLE) (
  IN  CONST DT_TABLE_GENERATOR                            *Generator,
  IN  CONST CM_STD_OBJ_DT_TABLE_INFO              *CONST  DtTableInfo,
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,
  OUT       VOID                                          **Table
  );
 
typedef EFI_STATUS (*DT_TABLE_GENERATOR_FREE_TABLE) (
  IN  CONST DT_TABLE_GENERATOR                            *Generator,
  IN  CONST CM_STD_OBJ_DT_TABLE_INFO              *CONST  DtTableInfo,
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,
  IN        VOID                                          **Table
  );
 
typedef struct DtTableGenerator {
  DT_TABLE_GENERATOR_ID             GeneratorID;
 
  CONST CHAR16                      *Description;
 
  DT_TABLE_GENERATOR_BUILD_TABLE    BuildDtTable;
 
  DT_TABLE_GENERATOR_FREE_TABLE     FreeTableResources;
} DT_TABLE_GENERATOR;
 
EFI_STATUS
EFIAPI
RegisterDtTableGenerator (
  IN CONST DT_TABLE_GENERATOR                   *CONST  Generator
  );
 
EFI_STATUS
EFIAPI
DeregisterDtTableGenerator (
  IN CONST DT_TABLE_GENERATOR                   *CONST  Generator
  );
 
#pragma pack()
 
#endif // DEVICETREE_TABLE_GENERATOR_H_