PrmContextBuffer.h

Go to the documentation of this file.

 
#ifndef PRM_CONTEXT_BUFFER_H_
#define PRM_CONTEXT_BUFFER_H_
 
#include <PrmDataBuffer.h>
#include <PrmMmio.h>
#include <Uefi.h>
 
#define PRM_CONTEXT_BUFFER_SIGNATURE          SIGNATURE_32('P','R','M','C')
#define PRM_CONTEXT_BUFFER_INTERFACE_VERSION  1
 
#pragma pack(push, 1)
 
//
// Associates an ACPI parameter buffer with a particular PRM handler in
// a PRM module.
//
// If either the GUID or address are zero then neither value is used to
// copy the ACPI parameter buffer address to the PRMT ACPI table.
//
typedef struct {
  EFI_GUID    HandlerGuid;
  UINT64      AcpiParameterBufferAddress;
} ACPI_PARAMETER_BUFFER_DESCRIPTOR;
 
//
// This is the context buffer structure that is passed to a PRM handler.
//
// At OS runtime, the OS will allocate and populate this structure and
// place virtual addresses in the pointer fields.
//
// It is also reused internally in FW (in the PRM_MODULE_CONTEXT_BUFFERS structure)
// to track context buffers within a given PRM module. In that internal usage,
// the addresses will be physical addresses.
//
typedef struct {
  UINT32      Signature;
 
  UINT16      Version;
 
  UINT16      Reserved;
 
  EFI_GUID    HandlerGuid;
 
  PRM_DATA_BUFFER    *StaticDataBuffer;
 
  PRM_RUNTIME_MMIO_RANGES    *RuntimeMmioRanges;
} PRM_CONTEXT_BUFFER;
 
//
// A firmware internal data structure used to track context buffer and
// runtime MMIO range usage across a PRM module.
//
typedef struct {
  EFI_GUID              ModuleGuid;
 
  UINTN                 BufferCount;
 
  PRM_CONTEXT_BUFFER    *Buffer;
 
 
  PRM_RUNTIME_MMIO_RANGES    *RuntimeMmioRanges;
 
  UINTN                      AcpiParameterBufferDescriptorCount;
 
  ACPI_PARAMETER_BUFFER_DESCRIPTOR    *AcpiParameterBufferDescriptors;
} PRM_MODULE_CONTEXT_BUFFERS;
 
#pragma pack(pop)
 
#endif