EFI_NVDIMM_LABEL Struct Reference

Data Fields
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

Detailed Description

Definition at line 133 of file NvdimmLabel.h.

Field Documentation

AddressAbstractionGuid

EFI_GUID EFI_NVDIMM_LABEL::AddressAbstractionGuid

Identifies the address abstraction mechanism for this namespace. A value of 0 indicates no mechanism used.

Definition at line 205 of file NvdimmLabel.h.

Alignment

UINT8 EFI_NVDIMM_LABEL::Alignment

Alignment hint used to advertise the preferred alignment of the data from within the namespace defined by this label.

Definition at line 190 of file NvdimmLabel.h.

Checksum

UINT64 EFI_NVDIMM_LABEL::Checksum

64-bit Fletcher64 checksum of all fields in this Label. This field is considered zero when the checksum is computed.

Definition at line 224 of file NvdimmLabel.h.

Dpa

UINT64 EFI_NVDIMM_LABEL::Dpa

The DPA is the DIMM Physical address where the NVM contributing to this namespace begins on this NVDIMM.

Definition at line 175 of file NvdimmLabel.h.

Flags

UINT32 EFI_NVDIMM_LABEL::Flags

Attributes of this namespace.

Definition at line 147 of file NvdimmLabel.h.

LbaSize

UINT64 EFI_NVDIMM_LABEL::LbaSize

This is the default logical block size in bytes and may be superseded by a block size that is specified in the AbstractionGuid.

Definition at line 170 of file NvdimmLabel.h.

Name

CHAR8 EFI_NVDIMM_LABEL::Name[EFI_NVDIMM_LABEL_NAME_LEN]

NULL-terminated string using UTF-8 character formatting.

Definition at line 142 of file NvdimmLabel.h.

NLabel

UINT16 EFI_NVDIMM_LABEL::NLabel

Total number of labels describing this namespace.

Definition at line 152 of file NvdimmLabel.h.

Position

UINT16 EFI_NVDIMM_LABEL::Position

Position of this label in list of labels for this namespace.

Definition at line 157 of file NvdimmLabel.h.

RawSize

UINT64 EFI_NVDIMM_LABEL::RawSize

The extent of the DPA contributed by this label.

Definition at line 180 of file NvdimmLabel.h.

Reserved

UINT8 EFI_NVDIMM_LABEL::Reserved[3]

Shall be 0.

Definition at line 195 of file NvdimmLabel.h.

Reserved1

UINT8 EFI_NVDIMM_LABEL::Reserved1[80]

Shall be 0.

Definition at line 218 of file NvdimmLabel.h.

SetCookie

UINT64 EFI_NVDIMM_LABEL::SetCookie

The SetCookie is utilized by SW to perform consistency checks on the Interleave Set to verify the current physical device configuration matches the original physical configuration when the labels were created for the set.The label is considered invalid if the actual label set cookie doesn't match the cookie stored here.

Definition at line 164 of file NvdimmLabel.h.

Slot

UINT32 EFI_NVDIMM_LABEL::Slot

Current slot in the Label Storage Area where this label is stored.

Definition at line 185 of file NvdimmLabel.h.

SPALocationCookie

UINT64 EFI_NVDIMM_LABEL::SPALocationCookie

When creating the label, this value is set to the value from the NFIT SPA Range Structure if the SPALocationCookie flag (bit 2) is set. If EFI_NVDIMM_LABEL_FLAGS_SPACOOKIE_BOUND is set, the SPALocationCookie value stored in the namespace label should match the current value in the NFIT SPA Range Structure. Otherwise, the data may not be read correctly.

Definition at line 213 of file NvdimmLabel.h.

TypeGuid

EFI_GUID EFI_NVDIMM_LABEL::TypeGuid

Range Type GUID that describes the access mechanism for the specified DPA range.

Definition at line 200 of file NvdimmLabel.h.

Uuid

EFI_GUID EFI_NVDIMM_LABEL::Uuid

Unique Label Identifier UUID per RFC 4122.

Definition at line 137 of file NvdimmLabel.h.

---

The documentation for this struct was generated from the following file:

• MdePkg/Include/Protocol/NvdimmLabel.h