NvdimmLabel.h

Go to the documentation of this file.

 
#ifndef __EFI_NVDIMM_LABEL_PROTOCOL_H__
#define __EFI_NVDIMM_LABEL_PROTOCOL_H__
 
#define EFI_NVDIMM_LABEL_PROTOCOL_GUID \
  { \
    0xd40b6b80, 0x97d5, 0x4282, {0xbb, 0x1d, 0x22, 0x3a, 0x16, 0x91, 0x80, 0x58 } \
  }
 
typedef struct _EFI_NVDIMM_LABEL_PROTOCOL EFI_NVDIMM_LABEL_PROTOCOL;
 
#define EFI_NVDIMM_LABEL_INDEX_SIG_LEN  16
#define EFI_NVDIMM_LABEL_INDEX_ALIGN    256
typedef struct {
  CHAR8     Sig[EFI_NVDIMM_LABEL_INDEX_SIG_LEN];
 
  UINT8     Flags[3];
 
  UINT8     LabelSize;
 
  UINT32    Seq;
 
  UINT64    MyOff;
 
  UINT64    MySize;
 
  UINT64    OtherOff;
 
  UINT64    LabelOff;
 
  UINT32    NSlot;
 
  UINT16    Major;
 
  UINT16    Minor;
 
  UINT64    Checksum;
 
  UINT8    Free[];
} EFI_NVDIMM_LABEL_INDEX_BLOCK;
 
#define EFI_NVDIMM_LABEL_NAME_LEN  64
 
#define EFI_NVDIMM_LABEL_FLAGS_ROLABEL  0x00000001
 
#define EFI_NVDIMM_LABEL_FLAGS_LOCAL  0x00000002
 
//
#define EFI_NVDIMM_LABEL_FLAGS_RESERVED  0x00000004
 
#define EFI_NVDIMM_LABEL_FLAGS_UPDATING  0x00000008
 
#define EFI_NVDIMM_LABEL_FLAGS_SPACOOKIE_BOUND  0x00000010
 
typedef struct {
  EFI_GUID    Uuid;
 
  CHAR8       Name[EFI_NVDIMM_LABEL_NAME_LEN];
 
  UINT32      Flags;
 
  UINT16      NLabel;
 
  UINT16      Position;
 
  UINT64      SetCookie;
 
  UINT64      LbaSize;
 
  UINT64      Dpa;
 
  UINT64      RawSize;
 
  UINT32      Slot;
 
  UINT8       Alignment;
 
  UINT8       Reserved[3];
 
  EFI_GUID    TypeGuid;
 
  EFI_GUID    AddressAbstractionGuid;
 
  UINT64      SPALocationCookie;
 
  UINT8       Reserved1[80];
 
  UINT64      Checksum;
} EFI_NVDIMM_LABEL;
 
typedef struct  {
  UINT64    RegionOffset;
 
  UINT32    SerialNumber;
 
  UINT16    VendorId;
 
  UINT16    ManufacturingDate;
 
  UINT8     ManufacturingLocation;
 
  UINT8     Reserved[31];
} EFI_NVDIMM_LABEL_SET_COOKIE_MAP;
 
typedef struct {
  EFI_NVDIMM_LABEL_SET_COOKIE_MAP    Mapping[0];
} EFI_NVDIMM_LABEL_SET_COOKIE_INFO;
 
typedef
EFI_STATUS
(EFIAPI *EFI_NVDIMM_LABEL_STORAGE_INFORMATION)(
  IN  EFI_NVDIMM_LABEL_PROTOCOL *This,
  OUT UINT32                    *SizeOfLabelStorageArea,
  OUT UINT32                    *MaxTransferLength
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_NVDIMM_LABEL_STORAGE_READ)(
  IN CONST EFI_NVDIMM_LABEL_PROTOCOL *This,
  IN UINT32                          Offset,
  IN UINT32                          TransferLength,
  OUT UINT8                          *LabelData
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_NVDIMM_LABEL_STORAGE_WRITE)(
  IN CONST EFI_NVDIMM_LABEL_PROTOCOL *This,
  IN UINT32                          Offset,
  IN UINT32                          TransferLength,
  IN UINT8                           *LabelData
  );
 
struct _EFI_NVDIMM_LABEL_PROTOCOL {
  EFI_NVDIMM_LABEL_STORAGE_INFORMATION    LabelStorageInformation;
  EFI_NVDIMM_LABEL_STORAGE_READ           LabelStorageRead;
  EFI_NVDIMM_LABEL_STORAGE_WRITE          LabelStorageWrite;
};
 
extern EFI_GUID  gEfiNvdimmLabelProtocolGuid;
 
#endif