PrmAcpiTable.h

Go to the documentation of this file.

 
#ifndef PRMT_ACPI_TABLE_H_
#define PRMT_ACPI_TABLE_H_
 
#include <Base.h>
#include <IndustryStandard/Acpi10.h>
 
#define PRM_TABLE_SIGNATURE  SIGNATURE_32 ('P', 'R', 'M', 'T')
 
#define PRM_TABLE_REVISION                       0x0
#define PRM_MODULE_INFORMATION_STRUCT_REVISION   0x00
#define PRM_HANDLER_INFORMATION_STRUCT_REVISION  0x00
 
#pragma pack(push, 1)
 
//
// Platform Runtime Mechanism (PRM) ACPI Table (PRMT) structures
//
typedef struct {
  UINT16    StructureRevision;                                    
  UINT16    StructureLength;                                      
  GUID      Identifier;                                           
  UINT64    PhysicalAddress;                                      
  UINT64    StaticDataBuffer;                                     
  UINT64    AcpiParameterBuffer;                                  
} PRM_HANDLER_INFORMATION_STRUCT;
 
typedef struct {
  UINT16                            StructureRevision;            
  UINT16                            StructureLength;              
  GUID                              Identifier;                   
  UINT16                            MajorRevision;                
  UINT16                            MinorRevision;                
  UINT16                            HandlerCount;                 
  UINT32                            HandlerInfoOffset;            
  UINT64                            RuntimeMmioRanges;            
  PRM_HANDLER_INFORMATION_STRUCT    HandlerInfoStructure[1];
} PRM_MODULE_INFORMATION_STRUCT;
 
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER      Header;                        
  GUID                             PrmPlatformGuid;               
  UINT32                           PrmModuleInfoOffset;           
  UINT32                           PrmModuleInfoCount;            
  PRM_MODULE_INFORMATION_STRUCT    PrmModuleInfoStructure[1];
} PRM_ACPI_DESCRIPTION_TABLE;
 
#pragma pack(pop)
 
//
// Helper macros to build PRM Information structures
//
// Todo: Revisit whether to use; currently both macros are not used
//
#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid, ModuleRevision, HandlerCount, PrmHanderInfoStructureArray)  {                      \
    {                                                                                                                                   \
      PRM_MODULE_INFORMATION_STRUCT_REVISION,                                                                                      /* UINT16    StructureRevision;   */                         \
      (OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoStructure) + (HandlerCount * sizeof (PRM_HANDLER_INFORMATION_STRUCT))) /* UINT16    StructureLength;     */ \
      ModuleGuid,                                                                                                                  /* GUID      ModuleGuid;          */                         \
      ModuleRevision,                                                                                                              /* UINT16    ModuleRevision       */                         \
      HandlerCount,                                                                                                                /* UINT16    HandlerCount         */                         \
      OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoOffset),                                                                /* UINT32    HandlerInfoOffset    */                         \
      PrmHanderInfoStructureArray                                                                                                  /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */    \
    } \
  }
 
#define PRM_HANDLER_INFORMATION_STRUCTURE(HandlerGuid, PhysicalAddress)  {                                                  \
    {                                                                                                                              \
      PRM_HANDLER_INFORMATION_STRUCT_REVISION,                             /* UINT16                  StructureRevision;      */   \
      sizeof (PRM_HANDLER_INFORMATION_STRUCT),                             /* UINT16                  StructureLength;        */   \
      HandlerGuid,                                                         /* GUID                    HandlerGuid;            */   \
      PhysicalAddress,                                                     /* UINT64                  PhysicalAddress         */   \
    } \
  }
 
#endif // _PRMT_ACPI_TABLE_H_