AppleRamDisk.h

Go to the documentation of this file.

 
#ifndef APPLE_RAM_DISK_PROTOCOL_H
#define APPLE_RAM_DISK_PROTOCOL_H
 
#include <Protocol/BlockIo.h>
#include <Protocol/DevicePath.h>
 
#define APPLE_RAM_DISK_PROTOCOL_GUID \
  { 0x957932CC, 0x7E8E, 0x433B,      \
    { 0x8F, 0x41, 0xD3, 0x91, 0xEA, 0x3C, 0x10, 0xF8 } }
 
#define APPLE_DMG_BOOT_PROTOCOL_REVISION  3
 
#define APPLE_RAM_DISK_EXTENT_SIGNATURE  0x544E5458444D4152ULL
 
#define APPLE_RAM_DISK_EXTENT_VERSION  0x10000U
 
#define APPLE_RAM_DISK_MAX_EXTENTS  0xFE
 
#pragma pack(push, 1)
 
typedef PACKED struct {
  UINT64    Start;
  UINT64    Length;
} APPLE_RAM_DISK_EXTENT;
 
typedef PACKED struct {
  UINT64                   Signature;
  UINT32                   Version;
  UINT32                   ExtentCount;
  APPLE_RAM_DISK_EXTENT    Extents[APPLE_RAM_DISK_MAX_EXTENTS];
  UINT64                   Reserved;
  UINT64                   Signature2;
} APPLE_RAM_DISK_EXTENT_TABLE;
 
typedef PACKED struct {
  UINT64                         ExtentCount;
  UINT64                         Reserved1;
  UINT64                         DiskSize;
  APPLE_RAM_DISK_EXTENT          Extents[APPLE_RAM_DISK_MAX_EXTENTS];
  UINT64                         Reserved2;
  APPLE_RAM_DISK_EXTENT_TABLE    ExtentTable;
} APPLE_RAM_DISK_CONTEXT;
 
typedef PACKED struct {
  VENDOR_DEVICE_PATH    Vendor;
  UINT32                Counter;
} APPLE_RAM_DISK_DP_VENDOR;
 
typedef PACKED struct {
  APPLE_RAM_DISK_DP_VENDOR    Vendor;
  MEMMAP_DEVICE_PATH          MemMap;
} APPLE_RAM_DISK_DP_HEADER;
 
typedef PACKED struct {
  APPLE_RAM_DISK_DP_VENDOR    Vendor;
  MEMMAP_DEVICE_PATH          MemMap;
  EFI_DEVICE_PATH_PROTOCOL    End;
} APPLE_RAM_DISK_DP;
 
#pragma pack(pop)
 
typedef
EFI_STATUS
(EFIAPI *APPLE_RAM_DISK_CREATE)(
  IN  UINT64       BlockCount     OPTIONAL,
  IN  UINT32       BlockSize      OPTIONAL,
  IN  BOOLEAN      AllocateMemory,
  IN  BOOLEAN      ReserveMemory,
  OUT EFI_HANDLE   *Handle
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_RAM_DISK_DESTROY)(
  IN  EFI_HANDLE   Handle
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_RAM_DISK_GET_CONTEXT)(
  IN  EFI_HANDLE              Handle,
  OUT APPLE_RAM_DISK_CONTEXT  *Context
  );
 
typedef struct {
  UINT64                        Revision;
  APPLE_RAM_DISK_CREATE         CreateRamDisk;
  APPLE_RAM_DISK_DESTROY        DestroyRamDisk;
  APPLE_RAM_DISK_GET_CONTEXT    GetRamDiskContext;
} APPLE_RAM_DISK_PROTOCOL;
 
STATIC_ASSERT (sizeof (APPLE_RAM_DISK_DP_VENDOR) == 24, "Invalid APPLE_RAM_DISK_DP_VENDOR size");
STATIC_ASSERT (sizeof (APPLE_RAM_DISK_DP) == 52, "Invalid APPLE_RAM_DISK_DP size");
STATIC_ASSERT (sizeof (APPLE_RAM_DISK_EXTENT) == 16, "Invalid APPLE_RAM_DISK_EXTENT size");
STATIC_ASSERT (sizeof (APPLE_RAM_DISK_EXTENT_TABLE) == 4096, "Invalid APPLE_RAM_DISK_EXTENT_TABLE size");
STATIC_ASSERT (sizeof (APPLE_RAM_DISK_CONTEXT) == 8192, "Invalid APPLE_RAM_DISK_CONTEXT size");
 
extern EFI_GUID  gAppleRamDiskProtocolGuid;
 
#define APPLE_RAM_DISK_INSTANCE_SIGNATURE  0x444D4152U
 
#define APPLE_RAM_DISK_DEFAULT_SIZE  0xA00000U
 
typedef struct {
  UINT64                   AllocatedExtents;
  UINT64                   PageCount;
  UINT64                   TotalSize;
  APPLE_RAM_DISK_EXTENT    Extents[APPLE_RAM_DISK_MAX_EXTENTS];
  UINT64                   Reserved;
  UINT8                    OwnExtentData[];
} APPLE_RAM_DISK;
 
typedef struct {
  UINT32                         Magic;
  EFI_HANDLE                     Handle;
  EFI_DEVICE_PATH_PROTOCOL       *DevicePath;
  EFI_BLOCK_IO_PROTOCOL          BlockIo;
  APPLE_RAM_DISK                 *RamDisk;
  APPLE_RAM_DISK_CONTEXT         *Context;
  APPLE_RAM_DISK_EXTENT_TABLE    *Extents;
  INT64                          DiskSize;
} APPLE_RAM_DISK_INSTANCE;
 
#endif // APPLE_RAM_DISK_PROTOCOL_H