types.h
NVMe standard definitions
-
NVME_GET
NVME_GET (value, name)
extract field from complex value
Parameters
valueThe original value of a complex field
nameThe name of the sub-field within an nvme value
Description
By convention, this library defines _SHIFT and _MASK such that mask can be applied after the shift to isolate a specific set of bits that decode to a sub-field.
Return
The ‘name’ field from ‘value’
-
NVME_SET
NVME_SET (value, name)
set field into complex value
Parameters
valueThe value to be set in its completed position
nameThe name of the sub-field within an nvme value
Return
The ‘name’ field from ‘value’
-
enum
nvme_constants A place to stash various constant nvme values
Constants
NVME_NSID_ALLA broadcast value that is used to specify all namespaces
NVME_NSID_NONEThe invalid namespace id, for when the nsid parameter is not used in a command
NVME_UUID_NONEUse to omit a uuid command parameter
NVME_CNTLID_NONEUse to omit a cntlid command parameter
NVME_CNSSPECID_NONEUse to omit a cns_specific_id command parameter
NVME_LOG_LSP_NONEUse to omit a log lsp command parameter
NVME_LOG_LSI_NONEUse to omit a log lsi command parameter
NVME_LOG_LPO_NONEUse to omit a log lpo command parameter
NVME_IDENTIFY_DATA_SIZEThe transfer size for nvme identify commands
NVME_LOG_SUPPORTED_LOG_PAGES_MAXThe largest possible index in the supported log pages log.
NVME_ID_NVMSET_LIST_MAXThe largest possible nvmset index in identify nvmeset
NVME_ID_UUID_LIST_MAXThe largest possible uuid index in identify uuid list
NVME_ID_CTRL_LIST_MAXThe largest possible controller index in identify controller list
NVME_ID_NS_LIST_MAXThe largest possible namespace index in identify namespace list
NVME_ID_SECONDARY_CTRL_MAXThe largest possible secondary controller index in identify secondary controller
NVME_ID_DOMAIN_LIST_MAXThe largest possible domain index in the in domain list
NVME_ID_ENDURANCE_GROUP_LIST_MAXThe largest possible endurance group index in the endurance group list
NVME_ID_ND_DESCRIPTOR_MAXThe largest possible namespace granularity index in the namespace granularity descriptor list
NVME_FEAT_LBA_RANGE_MAXThe largest possible LBA range index in feature lba range type
NVME_LOG_ST_MAX_RESULTSThe largest possible self test result index in the device self test log
NVME_LOG_TELEM_BLOCK_SIZESpecification defined size of Telemetry Data Blocks
NVME_LOG_FID_SUPPORTED_EFFECTS_MAXThe largest possible FID index in the feature identifiers effects log.
NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAXThe largest possible MI Command index in the MI Command effects log.
NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVEDThe reserved space in the MI Command effects log.
NVME_DSM_MAX_RANGESThe largest possible range index in a data-set management command
NVME_NQN_LENGTHMax length for NVMe Qualified Name
NVMF_TRADDR_SIZEMax Transport Address size
NVMF_TSAS_SIZEMax Transport Specific Address Subtype size
NVME_ZNS_CHANGED_ZONES_MAXMax number of zones in the changed zones log page
-
enum
nvme_csi Defined command set indicators
Constants
NVME_CSI_NVMNVM Command Set Indicator
NVME_CSI_KVKey Value Command Set
NVME_CSI_ZNSZoned Namespace Command Set
-
enum
nvme_register_offsets controller registers for all transports. This is the layout of BAR0/1 for PCIe, and properties for fabrics.
Constants
NVME_REG_CAPController Capabilities
NVME_REG_VSVersion
NVME_REG_INTMSInterrupt Mask Set
NVME_REG_INTMCInterrupt Mask Clear
NVME_REG_CCController Configuration
NVME_REG_CSTSController Status
NVME_REG_NSSRNVM Subsystem Reset
NVME_REG_AQAAdmin Queue Attributes
NVME_REG_ASQAdmin SQ Base Address
NVME_REG_ACQAdmin CQ Base Address
NVME_REG_CMBLOCController Memory Buffer Location
NVME_REG_CMBSZController Memory Buffer Size
NVME_REG_BPINFOBoot Partition Information
NVME_REG_BPRSELBoot Partition Read Select
NVME_REG_BPMBLBoot Partition Memory Buffer Location
NVME_REG_CMBMSCController Memory Buffer Memory Space Control
NVME_REG_CMBSTSController Memory Buffer Status
NVME_REG_CRTOController Ready Timeouts
NVME_REG_PMRCAPPersistent Memory Capabilities
NVME_REG_PMRCTLPersistent Memory Region Control
NVME_REG_PMRSTSPersistent Memory Region Status
NVME_REG_PMREBSPersistent Memory Region Elasticity Buffer Size
NVME_REG_PMRSWTPMemory Region Sustained Write Throughput
NVME_REG_PMRMSCLPersistent Memory Region Controller Memory Space Control Lower
NVME_REG_PMRMSCUPersistent Memory Region Controller Memory Space Control Upper
-
bool
nvme_is_64bit_reg(__u32 offset) Checks if offset of the controller register is a know 64bit value.
Parameters
__u32 offsetOffset of controller register field in bytes
Description
This function does not care about transport so that the offset is not going to be checked inside of this function for the unsupported fields in a specific transport. For example, BPMBL(Boot Partition Memory Buffer Location) register is not supported by fabrics, but it can be checked here.
Return
true if given offset is 64bit register, otherwise it returns false.
-
__u64
nvme_cmb_size(__u32 cmbsz) Calculate size of the controller memory buffer
Parameters
__u32 cmbszValue from controller register
NVME_REG_CMBSZ
Return
size of controller memory buffer in bytes
-
__u64
nvme_pmr_size(__u32 pmrebs) Calculate size of persistent memory region elasticity buffer
Parameters
__u32 pmrebsValue from controller register
NVME_REG_PMREBS
Return
size of controller persistent memory buffer in bytes
-
__u64
nvme_pmr_throughput(__u32 pmrswtp) Calculate throughput of persistent memory buffer
Parameters
__u32 pmrswtpValue from controller register
NVME_REG_PMRSWTP
Return
throughput of controller persistent memory buffer in bytes/second
-
enum
nvme_psd_flags Possible flag values in nvme power state descriptor
Constants
NVME_PSD_FLAGS_MXPSIndicates the scale for the Maximum Power field. If this bit is cleared, then the scale of the Maximum Power field is in 0.01 Watts. If this bit is set, then the scale of the Maximum Power field is in 0.0001 Watts.
NVME_PSD_FLAGS_NOPSIndicates whether the controller processes I/O commands in this power state. If this bit is cleared, then the controller processes I/O commands in this power state. If this bit is set, then the controller does not process I/O commands in this power state.
-
enum
nvme_psd_ps Known values for
struct nvme_psdipsandaps. Use with nvme_psd_power_scale() to extract the power scale field to match this enum.
Constants
NVME_PSD_PS_NOT_REPORTEDNot reported
NVME_PSD_PS_100_MICRO_WATT0.0001 watt scale
NVME_PSD_PS_10_MILLI_WATT0.01 watt scale
-
unsigned int
nvme_psd_power_scale(__u8 ps) power scale occupies the upper 3 bits
Parameters
__u8 pspower scale value
Return
power scale value
-
enum
nvme_psd_workload Specifies a workload hint in the Power Management Feature (see
struct nvme_psd.apw) to inform the NVM subsystem or indicate the conditions for the active power level.
Constants
NVME_PSD_WORKLOAD_NPThe workload is unknown or not provided.
NVME_PSD_WORKLOAD_1Extended Idle Period with a Burst of Random Write consists of five minutes of idle followed by thirty-two random write commands of size 1 MiB submitted to a single controller while all other controllers in the NVM subsystem are idle, and then thirty (30) seconds of idle.
NVME_PSD_WORKLOAD_2Heavy Sequential Writes consists of 80,000 sequential write commands of size 128 KiB submitted to a single controller while all other controllers in the NVM subsystem are idle. The submission queue(s) should be sufficiently large allowing the host to ensure there are multiple commands pending at all times during the workload.
-
struct
nvme_id_psd Power Management data structure
Definition
struct nvme_id_psd {
__le16 mp;
__u8 rsvd2;
__u8 flags;
__le32 enlat;
__le32 exlat;
__u8 rrt;
__u8 rrl;
__u8 rwt;
__u8 rwl;
__le16 idlp;
__u8 ips;
__u8 rsvd19;
__le16 actp;
__u8 apws;
__u8 rsvd23[9];
};
Members
mpMaximum Power indicates the sustained maximum power consumed by the NVM subsystem in this power state. The power in Watts is equal to the value in this field multiplied by the scale specified in the Max Power Scale bit (see
enum nvme_psd_flags). A value of 0 indicates Maximum Power is not reported.rsvd2Reserved
flagsAdditional decoding flags, see
enum nvme_psd_flags.enlatEntry Latency indicates the maximum latency in microseconds associated with entering this power state. A value of 0 indicates Entry Latency is not reported.
exlatExit Latency indicates the maximum latency in microseconds associated with exiting this power state. A value of 0 indicates Exit Latency is not reported.
rrtRelative Read Throughput indicates the read throughput rank associated with this power state relative to others. The value in this is less than the number of supported power states.
rrlRelative Read Latency indicates the read latency rank associated with this power state relative to others. The value in this field is less than the number of supported power states.
rwtRelative Write Throughput indicates write throughput rank associated with this power state relative to others. The value in this field is less than the number of supported power states
rwlRelative Write Latency indicates the write latency rank associated with this power state relative to others. The value in this field is less than the number of supported power states
idlpIdle Power indicates the typical power consumed by the NVM subsystem over 30 seconds in this power state when idle.
ipsIdle Power Scale indicates the scale for
struct nvme_id_psd.idlp, seeenum nvme_psd_psfor decoding this field.rsvd19Reserved
actpActive Power indicates the largest average power consumed by the NVM subsystem over a 10 second period in this power state with the workload indicated in the Active Power Workload field.
apwsBits 7-6: Active Power Scale(APS) indicates the scale for the
struct nvme_id_psd.actp, seeenum nvme_psd_psfor decoding this value. Bits 2-0: Active Power Workload(APW) indicates the workload used to calculate maximum power for this power state. Seeenum nvme_psd_workloadfor decoding this field.rsvd23Reserved
-
struct
nvme_id_ctrl Identify Controller data structure
Definition
struct nvme_id_ctrl {
__le16 vid;
__le16 ssvid;
char sn[20];
char mn[40];
char fr[8];
__u8 rab;
__u8 ieee[3];
__u8 cmic;
__u8 mdts;
__le16 cntlid;
__le32 ver;
__le32 rtd3r;
__le32 rtd3e;
__le32 oaes;
__le32 ctratt;
__le16 rrls;
__u8 rsvd102[9];
__u8 cntrltype;
__u8 fguid[16];
__le16 crdt1;
__le16 crdt2;
__le16 crdt3;
__u8 rsvd134[119];
__u8 nvmsr;
__u8 vwci;
__u8 mec;
__le16 oacs;
__u8 acl;
__u8 aerl;
__u8 frmw;
__u8 lpa;
__u8 elpe;
__u8 npss;
__u8 avscc;
__u8 apsta;
__le16 wctemp;
__le16 cctemp;
__le16 mtfa;
__le32 hmpre;
__le32 hmmin;
__u8 tnvmcap[16];
__u8 unvmcap[16];
__le32 rpmbs;
__le16 edstt;
__u8 dsto;
__u8 fwug;
__le16 kas;
__le16 hctma;
__le16 mntmt;
__le16 mxtmt;
__le32 sanicap;
__le32 hmminds;
__le16 hmmaxd;
__le16 nsetidmax;
__le16 endgidmax;
__u8 anatt;
__u8 anacap;
__le32 anagrpmax;
__le32 nanagrpid;
__le32 pels;
__le16 domainid;
__u8 rsvd358[10];
__u8 megcap[16];
__u8 rsvd384[128];
__u8 sqes;
__u8 cqes;
__le16 maxcmd;
__le32 nn;
__le16 oncs;
__le16 fuses;
__u8 fna;
__u8 vwc;
__le16 awun;
__le16 awupf;
__u8 icsvscc;
__u8 nwpc;
__le16 acwu;
__le16 ocfs;
__le32 sgls;
__le32 mnan;
__u8 maxdna[16];
__le32 maxcna;
__le32 oaqd;
__u8 rsvd568[200];
char subnqn[NVME_NQN_LENGTH];
__u8 rsvd1024[768];
__le32 ioccsz;
__le32 iorcsz;
__le16 icdoff;
__u8 fcatt;
__u8 msdbd;
__le16 ofcs;
__u8 dctype;
__u8 rsvd1807[241];
struct nvme_id_psd psd[32];
__u8 vs[1024];
};
Members
vidPCI Vendor ID, the company vendor identifier that is assigned by the PCI SIG.
ssvidPCI Subsystem Vendor ID, the company vendor identifier that is assigned by the PCI SIG for the subsystem.
snSerial Number in ASCII
mnModel Number in ASCII
frFirmware Revision in ASCII, the currently active firmware revision for the NVM subsystem
rabRecommended Arbitration Burst, reported as a power of two
ieeeIEEE assigned Organization Unique Identifier
cmicController Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem. See
enum nvme_id_ctrl_cmic.mdtsMax Data Transfer Size is the largest data transfer size. The host should not submit a command that exceeds this maximum data transfer size. The value is in units of the minimum memory page size (CAP.MPSMIN) and is reported as a power of two
cntlidController ID, the NVM subsystem unique controller identifier associated with the controller.
verVersion, this field contains the value reported in the Version register, or property (see
enum nvme_registersNVME_REG_VS).rtd3rRTD3 Resume Latency, the expected latency in microseconds to resume from Runtime D3
rtd3eRTD3 Exit Latency, the typical latency in microseconds to enter Runtime D3.
oaesOptional Async Events Supported, see enum nvme_id_ctrl_oaes.
ctrattController Attributes, see enum nvme_id_ctrl_ctratt.
rrlsRead Recovery Levels. If a bit is set, then the corresponding Read Recovery Level is supported. If a bit is cleared, then the corresponding Read Recovery Level is not supported.
rsvd102Reserved
cntrltypeController Type, see
enum nvme_id_ctrl_cntrltypefguidFRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit
crdt1Controller Retry Delay time in 100 millisecond units if CQE CRD field is 1
crdt2Controller Retry Delay time in 100 millisecond units if CQE CRD field is 2
crdt3Controller Retry Delay time in 100 millisecond units if CQE CRD field is 3
rsvd134Reserved
nvmsrNVM Subsystem Report, see
enum nvme_id_ctrl_nvmsrvwciVPD Write Cycle Information, see
enum nvme_id_ctrl_vwcimecManagement Endpoint Capabilities, see
enum nvme_id_ctrl_mecoacsOptional Admin Command Support,the optional Admin commands and features supported by the controller, see
enum nvme_id_ctrl_oacs.aclAbort Command Limit, the maximum number of concurrently executing Abort commands supported by the controller. This is a 0’s based value.
aerlAsync Event Request Limit, the maximum number of concurrently outstanding Asynchronous Event Request commands supported by the controller This is a 0’s based value.
frmwFirmware Updates indicates capabilities regarding firmware updates. See
enum nvme_id_ctrl_frmw.lpaLog Page Attributes, see
enum nvme_id_ctrl_lpa.elpeError Log Page Entries, the maximum number of Error Information log entries that are stored by the controller. This field is a 0’s based value.
npssNumber of Power States Supported, the number of NVM Express power states supported by the controller, indicating the number of valid entries in
struct nvme_id_ctrl.psd. This is a 0’s based value.avsccAdmin Vendor Specific Command Configuration, see
enum nvme_id_ctrl_avscc.apstaAutonomous Power State Transition Attributes, see
enum nvme_id_ctrl_apsta.wctempWarning Composite Temperature Threshold indicates the minimum Composite Temperature field value (see
struct nvme_smart_log.critical_comp_time) that indicates an overheating condition during which controller operation continues.cctempCritical Composite Temperature Threshold, field indicates the minimum Composite Temperature field value (see
struct nvme_smart_log.critical_comp_time) that indicates a critical overheating condition.mtfaMaximum Time for Firmware Activation indicates the maximum time the controller temporarily stops processing commands to activate the firmware image, specified in 100 millisecond units. This field is always valid if the controller supports firmware activation without a reset.
hmpreHost Memory Buffer Preferred Size indicates the preferred size that the host is requested to allocate for the Host Memory Buffer feature in 4 KiB units.
hmminHost Memory Buffer Minimum Size indicates the minimum size that the host is requested to allocate for the Host Memory Buffer feature in 4 KiB units.
tnvmcapTotal NVM Capacity, the total NVM capacity in the NVM subsystem. The value is in bytes.
unvmcapUnallocated NVM Capacity, the unallocated NVM capacity in the NVM subsystem. The value is in bytes.
rpmbsReplay Protected Memory Block Support, see
enum nvme_id_ctrl_rpmbs.edsttExtended Device Self-test Time, if Device Self-test command is supported (see
struct nvme_id_ctrl.oacs,NVME_CTRL_OACS_SELF_TEST), then this field indicates the nominal amount of time in one minute units that the controller takes to complete an extended device self-test operation when in power state 0.dstoDevice Self-test Options, see
enum nvme_id_ctrl_dsto.fwugFirmware Update Granularity indicates the granularity and alignment requirement of the firmware image being updated by the Firmware Image Download command. The value is reported in 4 KiB units. A value of 0h indicates no information on granularity is provided. A value of FFh indicates no restriction
kasKeep Alive Support indicates the granularity of the Keep Alive Timer in 100 millisecond units.
hctmaHost Controlled Thermal Management Attributes, see
enum nvme_id_ctrl_hctm.mntmtMinimum Thermal Management Temperature indicates the minimum temperature, in degrees Kelvin, that the host may request in the Thermal Management Temperature 1 field and Thermal Management Temperature 2 field of a Set Features command with the Feature Identifier field set to
NVME_FEAT_FID_HCTM.mxtmtMaximum Thermal Management Temperature indicates the maximum temperature, in degrees Kelvin, that the host may request in the Thermal Management Temperature 1 field and Thermal Management Temperature 2 field of the Set Features command with the Feature Identifier set to
NVME_FEAT_FID_HCTM.sanicapSanitize Capabilities, see
enum nvme_id_ctrl_sanicaphmmindsHost Memory Buffer Minimum Descriptor Entry Size indicates the minimum usable size of a Host Memory Buffer Descriptor Entry in 4 KiB units.
hmmaxdHost Memory Maximum Descriptors Entries indicates the number of usable Host Memory Buffer Descriptor Entries.
nsetidmaxNVM Set Identifier Maximum, defines the maximum value of a valid NVM Set Identifier for any controller in the NVM subsystem.
endgidmaxEndurance Group Identifier Maximum, defines the maximum value of a valid Endurance Group Identifier for any controller in the NVM subsystem.
anattANA Transition Time indicates the maximum amount of time, in seconds, for a transition between ANA states or the maximum amount of time, in seconds, that the controller reports the ANA change state.
anacapAsymmetric Namespace Access Capabilities, see
enum nvme_id_ctrl_anacap.anagrpmaxANA Group Identifier Maximum indicates the maximum value of a valid ANA Group Identifier for any controller in the NVM subsystem.
nanagrpidNumber of ANA Group Identifiers indicates the number of ANA groups supported by this controller.
pelsPersistent Event Log Size indicates the maximum reportable size for the Persistent Event Log.
domainidDomain Identifier indicates the identifier of the domain that contains this controller.
rsvd358Reserved
megcapMax Endurance Group Capacity indicates the maximum capacity of a single Endurance Group.
rsvd384Reserved
sqesSubmission Queue Entry Size, see
enum nvme_id_ctrl_sqes.cqesCompletion Queue Entry Size, see
enum nvme_id_ctrl_cqes.maxcmdMaximum Outstanding Commands indicates the maximum number of commands that the controller processes at one time for a particular queue.
nnNumber of Namespaces indicates the maximum value of a valid nsid for the NVM subsystem. If the MNAN (
struct nvme_id_ctrl.mnan field is cleared to 0h, then this field also indicates the maximum number of namespaces supported by the NVM subsystem.oncsOptional NVM Command Support, see
enum nvme_id_ctrl_oncs.fusesFused Operation Support, see
enum nvme_id_ctrl_fuses.fnaFormat NVM Attributes, see
enum nvme_id_ctrl_fna.vwcVolatile Write Cache, see
enum nvme_id_ctrl_vwc.awunAtomic Write Unit Normal indicates the size of the write operation guaranteed to be written atomically to the NVM across all namespaces with any supported namespace format during normal operation. This field is specified in logical blocks and is a 0’s based value.
awupfAtomic Write Unit Power Fail indicates the size of the write operation guaranteed to be written atomically to the NVM across all namespaces with any supported namespace format during a power fail or error condition. This field is specified in logical blocks and is a 0’s based value.
icsvsccNVM Vendor Specific Command Configuration, see
enum nvme_id_ctrl_nvscc.nwpcNamespace Write Protection Capabilities, see
enum nvme_id_ctrl_nwpc.acwuAtomic Compare & Write Unit indicates the size of the write operation guaranteed to be written atomically to the NVM across all namespaces with any supported namespace format for a Compare and Write fused operation. This field is specified in logical blocks and is a 0’s based value.
ocfsOptional Copy Formats Supported, each bit n means controller supports Copy Format n.
sglsSGL Support, see
enum nvme_id_ctrl_sglsmnanMaximum Number of Allowed Namespaces indicates the maximum number of namespaces supported by the NVM subsystem.
maxdnaMaximum Domain Namespace Attachments indicates the maximum of the sum of the number of namespaces attached to each I/O controller in the Domain.
maxcnaMaximum I/O Controller Namespace Attachments indicates the maximum number of namespaces that are allowed to be attached to this I/O controller.
oaqdOptimal Aggregated Queue Depth indicates the recommended maximum total number of outstanding I/O commands across all I/O queues on the controller for optimal operation.
rsvd568Reserved
subnqnNVM Subsystem NVMe Qualified Name, UTF-8 null terminated string
rsvd1024Reserved
ioccszI/O Queue Command Capsule Supported Size, defines the maximum I/O command capsule size in 16 byte units.
iorcszI/O Queue Response Capsule Supported Size, defines the maximum I/O response capsule size in 16 byte units.
icdoffIn Capsule Data Offset, defines the offset where data starts within a capsule. This value is applicable to I/O Queues only.
fcattFabrics Controller Attributes, see
enum nvme_id_ctrl_fcatt.msdbdMaximum SGL Data Block Descriptors indicates the maximum number of SGL Data Block or Keyed SGL Data Block descriptors that a host is allowed to place in a capsule. A value of 0h indicates no limit.
ofcsOptional Fabric Commands Support, see
enum nvme_id_ctrl_ofcs.dctypeDiscovery Controller Type (DCTYPE). This field indicates what type of Discovery controller the controller is (see enum nvme_id_ctrl_dctype)
rsvd1807Reserved
psdPower State Descriptors, see
struct nvme_id_psd.vsVendor Specific
-
enum
nvme_id_ctrl_cmic Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem.
Constants
NVME_CTRL_CMIC_MULTI_PORTIf set, then the NVM subsystem may contain more than one NVM subsystem port, otherwise the NVM subsystem contains only a single NVM subsystem port.
NVME_CTRL_CMIC_MULTI_CTRLIf set, then the NVM subsystem may contain two or more controllers, otherwise the NVM subsystem contains only a single controller. An NVM subsystem that contains multiple controllers may be used by multiple hosts, or may provide multiple paths for a single host.
NVME_CTRL_CMIC_MULTI_SRIOVIf set, then the controller is associated with an SR-IOV Virtual Function, otherwise it is associated with a PCI Function or a Fabrics connection.
NVME_CTRL_CMIC_MULTI_ANA_REPORTINGIf set, then the NVM subsystem supports Asymmetric Namespace Access Reporting.
-
enum
nvme_id_ctrl_oaes Optional Asynchronous Events Supported
Constants
NVME_CTRL_OAES_NANamespace Attribute Notices event supported
NVME_CTRL_OAES_FAFirmware Activation Notices event supported
NVME_CTRL_OAES_ANAANA Change Notices supported
NVME_CTRL_OAES_PLEAPredictable Latency Event Aggregate Log Change Notices event supported
NVME_CTRL_OAES_LBASLBA Status Information Notices event supported
NVME_CTRL_OAES_EGEEndurance Group Events Aggregate Log Change Notices event supported
NVME_CTRL_OAES_NSNormal NVM Subsystem Shutdown event supported
NVME_CTRL_OAES_ZDZone Descriptor Change Notifications supported
NVME_CTRL_OAES_DLDiscover Log Page Change Notifications supported
-
enum
nvme_id_ctrl_ctratt Controller attributes
Constants
NVME_CTRL_CTRATT_128_ID128-bit Host Identifier supported
NVME_CTRL_CTRATT_NON_OP_PSPNon-Operational Poser State Permissive Mode supported
NVME_CTRL_CTRATT_NVM_SETSNVM Sets supported
NVME_CTRL_CTRATT_READ_RECV_LVLSRead Recovery Levels supported
NVME_CTRL_CTRATT_ENDURANCE_GROUPSEndurance Groups supported
NVME_CTRL_CTRATT_PREDICTABLE_LATPredictable Latency Mode supported
NVME_CTRL_CTRATT_TBKASTraffic Based Keep Alive Support
NVME_CTRL_CTRATT_NAMESPACE_GRANULARITYNamespace Granularity reporting supported
NVME_CTRL_CTRATT_SQ_ASSOCIATIONSSQ Associations supported
NVME_CTRL_CTRATT_UUID_LISTUUID List reporting supported
NVME_CTRL_CTRATT_MDSMulti-Domain Subsystem supported
NVME_CTRL_CTRATT_FIXED_CAPFixed Capacity Management supported
NVME_CTRL_CTRATT_VARIABLE_CAPVariable Capacity Management supported
NVME_CTRL_CTRATT_DEL_ENDURANCE_GROUPSDelete Endurance Groups supported
NVME_CTRL_CTRATT_DEL_NVM_SETSDelete NVM Sets supported
NVME_CTRL_CTRATT_ELBASExtended LBA Formats supported
NVME_CTRL_CTRATT_FDPSFlexible Data Placement supported
-
enum
nvme_id_ctrl_cntrltype Controller types
Constants
NVME_CTRL_CNTRLTYPE_IONVM I/O controller
NVME_CTRL_CNTRLTYPE_DISCOVERYDiscovery controller
NVME_CTRL_CNTRLTYPE_ADMINAdmin controller
-
enum
nvme_id_ctrl_dctype Discovery Controller types
Constants
NVME_CTRL_DCTYPE_NOT_REPORTEDNot reported (I/O, Admin, and pre-TP8010)
NVME_CTRL_DCTYPE_DDCDirect Discovery controller
NVME_CTRL_DCTYPE_CDCCentral Discovery controller
-
enum
nvme_id_ctrl_nvmsr This field reports information associated with the NVM Subsystem, see
struct nvme_id_ctrl.nvmsr.
Constants
NVME_CTRL_NVMSR_NVMESDIf set, then the NVM Subsystem is part of an NVMe Storage Device; if cleared, then the NVM Subsystem is not part of an NVMe Storage Device.
NVME_CTRL_NVMSR_NVMEEIf set’, then the NVM Subsystem is part of an NVMe Enclosure; if cleared, then the NVM Subsystem is not part of an NVMe Enclosure.
-
enum
nvme_id_ctrl_vwci This field indicates information about remaining number of times that VPD contents are able to be updated using the VPD Write command, see
struct nvme_id_ctrl.vwci.
Constants
NVME_CTRL_VWCI_VWCRMask to get value of VPD Write Cycles Remaining. If the VPD Write Cycle Remaining Valid bit is set, then this field contains a value indicating the remaining number of times that VPD contents are able to be updated using the VPD Write command. If this field is set to 7Fh, then the remaining number of times that VPD contents are able to be updated using the VPD Write command is greater than or equal to 7Fh.
NVME_CTRL_VWCI_VWCRVVPD Write Cycle Remaining Valid. If this bit is set, then the VPD Write Cycle Remaining field is valid. If this bit is cleared, then the VPD Write Cycles Remaining field is invalid and cleared to 0h.
-
enum
nvme_id_ctrl_mec Flags indicating the capabilities of the Management Endpoint in the Controller,
struct nvme_id_ctrl.mec.
Constants
NVME_CTRL_MEC_SMBUSMEIf set, then the NVM Subsystem contains a Management Endpoint on an SMBus/I2C port.
NVME_CTRL_MEC_PCIEMEIf set, then the NVM Subsystem contains a Management Endpoint on a PCIe port.
-
enum
nvme_id_ctrl_oacs Flags indicating the optional Admin commands and features supported by the controller, see
struct nvme_id_ctrl.oacs.
Constants
NVME_CTRL_OACS_SECURITYIf set, then the controller supports the Security Send and Security Receive commands.
NVME_CTRL_OACS_FORMATIf set then the controller supports the Format NVM command.
NVME_CTRL_OACS_FWIf set, then the controller supports the Firmware Commit and Firmware Image Download commands.
NVME_CTRL_OACS_NS_MGMTIf set, then the controller supports the Namespace Management capability
NVME_CTRL_OACS_SELF_TESTIf set, then the controller supports the Device Self-test command.
NVME_CTRL_OACS_DIRECTIVESIf set, then the controller supports Directives and the Directive Send and Directive Receive commands.
NVME_CTRL_OACS_NVME_MIIf set, then the controller supports the NVMe-MI Send and NVMe-MI Receive commands.
NVME_CTRL_OACS_VIRT_MGMTIf set, then the controller supports the Virtualization Management command.
NVME_CTRL_OACS_DBBUF_CFGIf set, then the controller supports the Doorbell Buffer Config command.
NVME_CTRL_OACS_LBA_STATUSIf set, then the controller supports the Get LBA Status capability.
NVME_CTRL_OACS_CMD_FEAT_LDIf set, then the controller supports the command and feature lockdown capability.
-
enum
nvme_id_ctrl_frmw Flags and values indicates capabilities regarding firmware updates from
struct nvme_id_ctrl.frmw.
Constants
NVME_CTRL_FRMW_1ST_ROIf set, the first firmware slot is readonly
NVME_CTRL_FRMW_NR_SLOTSMask to get the value of the number of firmware slots that the controller supports.
NVME_CTRL_FRMW_FW_ACT_NO_RESETIf set, the controller supports firmware activation without a reset.
NVME_CTRL_FRMW_MP_UP_DETECTIONIf set, the controller is able to detect overlapping firmware/boot partition image update.
-
enum
nvme_id_ctrl_lpa Flags indicating optional attributes for log pages that are accessed via the Get Log Page command.
Constants
NVME_CTRL_LPA_SMART_PER_NSIf set, controller supports SMART/Health log page on a per namespace basis.
NVME_CTRL_LPA_CMD_EFFECTSIf Set, the controller supports the commands supported and effects log page.
NVME_CTRL_LPA_EXTENDEDIf set, the controller supports extended data for log page command including extended number of dwords and log page offset fields.
NVME_CTRL_LPA_TELEMETRYIf set, the controller supports the telemetry host-initiated and telemetry controller-initiated log pages and sending telemetry log notices.
NVME_CTRL_LPA_PERSETENT_EVENTIf set, the controller supports persistent event log.
NVME_CTRL_LPA_LI0_LI5_LI12_LI13If set, the controller supports - log pages log page. - returning scope of each command in
commands supported and effects log page.
feature identifiers supported and effects log page.
NVMe-MI commands supported and effects log page.
NVME_CTRL_LPA_DA4_TELEMETRYIf set, the controller supports data area 4 for telemetry host-initiated and telemetry.
-
enum
nvme_id_ctrl_avscc Flags indicating the configuration settings for Admin Vendor Specific command handling.
Constants
NVME_CTRL_AVSCC_AVSIf set, all Admin Vendor Specific Commands use the optional vendor specific command format with NDT and NDM fields.
-
enum
nvme_id_ctrl_apsta Flags indicating the attributes of the autonomous power state transition feature.
Constants
NVME_CTRL_APSTA_APSTIf set, then the controller supports autonomous power state transitions.
-
enum
nvme_id_ctrl_rpmbs This field indicates if the controller supports one or more Replay Protected Memory Blocks, from
struct nvme_id_ctrl.rpmbs.
Constants
NVME_CTRL_RPMBS_NR_UNITSMask to get the value of the Number of RPMB Units
NVME_CTRL_RPMBS_AUTH_METHODMask to get the value of the Authentication Method
NVME_CTRL_RPMBS_TOTAL_SIZEMask to get the value of Total Size
NVME_CTRL_RPMBS_ACCESS_SIZEMask to get the value of Access Size
-
enum
nvme_id_ctrl_dsto Flags indicating the optional Device Self-test command or operation behaviors supported by the controller or NVM subsystem.
Constants
NVME_CTRL_DSTO_ONE_DSTIf set, then the NVM subsystem supports only one device self-test operation in progress at a time.
-
enum
nvme_id_ctrl_hctm Flags indicate the attributes of the host controlled thermal management feature
Constants
NVME_CTRL_HCTMA_HCTMthen the controller supports host controlled thermal management, and the Set Features command and Get Features command with the Feature Identifier field set to
NVME_FEAT_FID_HCTM.
-
enum
nvme_id_ctrl_sanicap Indicates attributes for sanitize operations.
Constants
NVME_CTRL_SANICAP_CESCrypto Erase Support. If set, then the controller supports the Crypto Erase sanitize operation.
NVME_CTRL_SANICAP_BESBlock Erase Support. If set, then the controller supports the Block Erase sanitize operation.
NVME_CTRL_SANICAP_OWSOverwrite Support. If set, then the controller supports the Overwrite sanitize operation.
NVME_CTRL_SANICAP_NDINo-Deallocate Inhibited. If set and the No- Deallocate Response Mode bit is set, then the controller deallocates after the sanitize operation even if the No-Deallocate After Sanitize bit is set in a Sanitize command.
NVME_CTRL_SANICAP_NODMMASNo-Deallocate Modifies Media After Sanitize, mask to extract value.
-
enum
nvme_id_ctrl_anacap This field indicates the capabilities associated with Asymmetric Namespace Access Reporting.
Constants
NVME_CTRL_ANACAP_OPTIf set, then the controller is able to report ANA Optimized state.
NVME_CTRL_ANACAP_NON_OPTIf set, then the controller is able to report ANA Non-Optimized state.
NVME_CTRL_ANACAP_INACCESSIBLEIf set, then the controller is able to report ANA Inaccessible state.
NVME_CTRL_ANACAP_PERSISTENT_LOSSIf set, then the controller is able to report ANA Persistent Loss state.
NVME_CTRL_ANACAP_CHANGEIf set, then the controller is able to report ANA Change state.
NVME_CTRL_ANACAP_GRPID_NO_CHGIf set, then the ANAGRPID field in the Identify Namespace data structure (
struct nvme_id_ns.anagrpid), does not change while the namespace is attached to any controller.NVME_CTRL_ANACAP_GRPID_MGMTIf set, then the controller supports a non-zero value in the ANAGRPID field of the Namespace Management command.
-
enum
nvme_id_ctrl_sqes Defines the required and maximum Submission Queue entry size when using the NVM Command Set.
Constants
NVME_CTRL_SQES_MINMask to get the value of the required Submission Queue Entry size when using the NVM Command Set.
NVME_CTRL_SQES_MAXMask to get the value of the maximum Submission Queue entry size when using the NVM Command Set.
-
enum
nvme_id_ctrl_cqes Defines the required and maximum Completion Queue entry size when using the NVM Command Set.
Constants
NVME_CTRL_CQES_MINMask to get the value of the required Completion Queue Entry size when using the NVM Command Set.
NVME_CTRL_CQES_MAXMask to get the value of the maximum Completion Queue entry size when using the NVM Command Set.
-
enum
nvme_id_ctrl_oncs This field indicates the optional NVM commands and features supported by the controller.
Constants
NVME_CTRL_ONCS_COMPAREIf set, then the controller supports the Compare command.
NVME_CTRL_ONCS_WRITE_UNCORRECTABLEIf set, then the controller supports the Write Uncorrectable command.
NVME_CTRL_ONCS_DSMIf set, then the controller supports the Dataset Management command.
NVME_CTRL_ONCS_WRITE_ZEROESIf set, then the controller supports the Write Zeroes command.
NVME_CTRL_ONCS_SAVE_FEATURESIf set, then the controller supports the Save field set to a non-zero value in the Set Features command and the Select field set to a non-zero value in the Get Features command.
NVME_CTRL_ONCS_RESERVATIONSIf set, then the controller supports reservations.
NVME_CTRL_ONCS_TIMESTAMPIf set, then the controller supports the Timestamp feature.
NVME_CTRL_ONCS_VERIFYIf set, then the controller supports the Verify command.
NVME_CTRL_ONCS_COPYIf set, then the controller supports the copy command.
-
enum
nvme_id_ctrl_fuses This field indicates the fused operations that the controller supports.
Constants
NVME_CTRL_FUSES_COMPARE_AND_WRITEIf set, then the controller supports the Compare and Write fused operation.
-
enum
nvme_id_ctrl_fna This field indicates attributes for the Format NVM command.
Constants
NVME_CTRL_FNA_FMT_ALL_NAMESPACESIf set, then all namespaces in an NVM subsystem shall be configured with the same attributes and a format (excluding secure erase) of any namespace results in a format of all namespaces in an NVM subsystem. If cleared, then the controller supports format on a per namespace basis.
NVME_CTRL_FNA_SEC_ALL_NAMESPACESIf set, then any secure erase performed as part of a format operation results in a secure erase of all namespaces in the NVM subsystem. If cleared, then any secure erase performed as part of a format results in a secure erase of the particular namespace specified.
NVME_CTRL_FNA_CRYPTO_ERASEIf set, then cryptographic erase is supported. If cleared, then cryptographic erase is not supported.
NVME_CTRL_FNA_NSID_FFFFFFFFIf set, then format does not support nsid value set to FFFFFFFFh. If cleared, format supports nsid value set to FFFFFFFFh.
-
enum
nvme_id_ctrl_vwc Volatile write cache
Constants
NVME_CTRL_VWC_PRESENTIf set, indicates a volatile write cache is present. If a volatile write cache is present, then the host controls whether the volatile write cache is enabled with a Set Features command specifying the value
NVME_FEAT_FID_VOLATILE_WC.NVME_CTRL_VWC_FLUSHMask to get the value of the flush command behavior.
-
enum
nvme_id_ctrl_nvscc This field indicates the configuration settings for NVM Vendor Specific command handling.
Constants
NVME_CTRL_NVSCC_FMTIf set, all NVM Vendor Specific Commands use the format with NDT and NDM fields.
-
enum
nvme_id_ctrl_nwpc This field indicates the optional namespace write protection capabilities supported by the controller.
Constants
NVME_CTRL_NWPC_WRITE_PROTECTIf set, then the controller shall support the No Write Protect and Write Protect namespace write protection states and may support the Write Protect Until Power Cycle state and Permanent Write Protect namespace write protection states.
NVME_CTRL_NWPC_WRITE_PROTECT_POWER_CYCLEIf set, then the controller supports the Write Protect Until Power Cycle state.
NVME_CTRL_NWPC_WRITE_PROTECT_PERMANENTIf set, then the controller supports the Permanent Write Protect state.
-
enum
nvme_id_ctrl_sgls This field indicates if SGLs are supported for the NVM Command Set and the particular SGL types supported.
Constants
NVME_CTRL_SGLS_SUPPORTED
NVME_CTRL_SGLS_KEYED
NVME_CTRL_SGLS_BIT_BUCKET
NVME_CTRL_SGLS_MPTR_BYTE_ALIGNED
NVME_CTRL_SGLS_OVERSIZE
NVME_CTRL_SGLS_MPTR_SGL
NVME_CTRL_SGLS_OFFSET
NVME_CTRL_SGLS_TPORT
-
enum
nvme_id_ctrl_fcatt This field indicates attributes of the controller that are specific to NVMe over Fabrics.
Constants
NVME_CTRL_FCATT_DYNAMICIf cleared, then the NVM subsystem uses a dynamic controller model. If set, then the NVM subsystem uses a static controller model.
-
enum
nvme_id_ctrl_ofcs Indicate whether the controller supports optional fabric commands.
Constants
NVME_CTRL_OFCS_DISCONNECTIf set, then the controller supports the Disconnect command and deletion of individual I/O Queues.
-
struct
nvme_lbaf LBA Format Data Structure
Definition
struct nvme_lbaf {
__le16 ms;
__u8 ds;
__u8 rp;
};
Members
msMetadata Size indicates the number of metadata bytes provided per LBA based on the LBA Data Size indicated.
dsLBA Data Size indicates the LBA data size supported, reported as a power of two.
rpRelative Performance, see
enum nvme_lbaf_rp.
-
enum
nvme_lbaf_rp This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller.
Constants
NVME_LBAF_RP_BESTBest performance
NVME_LBAF_RP_BETTERBetter performance
NVME_LBAF_RP_GOODGood performance
NVME_LBAF_RP_DEGRADEDDegraded performance
NVME_LBAF_RP_MASKMask to get the relative performance value from the field
-
struct
nvme_id_ns Identify Namespace data structure
Definition
struct nvme_id_ns {
__le64 nsze;
__le64 ncap;
__le64 nuse;
__u8 nsfeat;
__u8 nlbaf;
__u8 flbas;
__u8 mc;
__u8 dpc;
__u8 dps;
__u8 nmic;
__u8 rescap;
__u8 fpi;
__u8 dlfeat;
__le16 nawun;
__le16 nawupf;
__le16 nacwu;
__le16 nabsn;
__le16 nabo;
__le16 nabspf;
__le16 noiob;
__u8 nvmcap[16];
__le16 npwg;
__le16 npwa;
__le16 npdg;
__le16 npda;
__le16 nows;
__le16 mssrl;
__le32 mcl;
__u8 msrc;
__u8 rsvd81;
__u8 nulbaf;
__u8 rsvd83[9];
__le32 anagrpid;
__u8 rsvd96[3];
__u8 nsattr;
__le16 nvmsetid;
__le16 endgid;
__u8 nguid[16];
__u8 eui64[8];
struct nvme_lbaf lbaf[64];
__le64 lbstm;
__u8 vs[3704];
};
Members
nszeNamespace Size indicates the total size of the namespace in logical blocks. The number of logical blocks is based on the formatted LBA size.
ncapNamespace Capacity indicates the maximum number of logical blocks that may be allocated in the namespace at any point in time. The number of logical blocks is based on the formatted LBA size.
nuseNamespace Utilization indicates the current number of logical blocks allocated in the namespace. This field is smaller than or equal to the Namespace Capacity. The number of logical blocks is based on the formatted LBA size.
nsfeatNamespace Features, see
enum nvme_id_nsfeat.nlbafNumber of LBA Formats defines the number of supported LBA data size and metadata size combinations supported by the namespace and the highest possible index to
struct nvme_id_ns.lbaf.flbasFormatted LBA Size, see
enum nvme_id_ns_flbas.mcMetadata Capabilities, see
enum nvme_id_ns_mc.dpcEnd-to-end Data Protection Capabilities, see
enum nvme_id_ns_dpc.dpsEnd-to-end Data Protection Type Settings, see
enum nvme_id_ns_dps.nmicNamespace Multi-path I/O and Namespace Sharing Capabilities, see
enum nvme_id_ns_nmic.rescapReservation Capabilities, see
enum nvme_id_ns_rescap.fpiFormat Progress Indicator, see
enum nvme_nd_ns_fpi.dlfeatDeallocate Logical Block Features, see
enum nvme_id_ns_dlfeat.nawunNamespace Atomic Write Unit Normal indicates the namespace specific size of the write operation guaranteed to be written atomically to the NVM during normal operation.
nawupfNamespace Atomic Write Unit Power Fail indicates the namespace specific size of the write operation guaranteed to be written atomically to the NVM during a power fail or error condition.
nacwuNamespace Atomic Compare & Write Unit indicates the namespace specific size of the write operation guaranteed to be written atomically to the NVM for a Compare and Write fused command.
nabsnNamespace Atomic Boundary Size Normal indicates the atomic boundary size for this namespace for the NAWUN value. This field is specified in logical blocks.
naboNamespace Atomic Boundary Offset indicates the LBA on this namespace where the first atomic boundary starts.
nabspfNamespace Atomic Boundary Size Power Fail indicates the atomic boundary size for this namespace specific to the Namespace Atomic Write Unit Power Fail value. This field is specified in logical blocks.
noiobNamespace Optimal I/O Boundary indicates the optimal I/O boundary for this namespace. This field is specified in logical blocks. The host should construct Read and Write commands that do not cross the I/O boundary to achieve optimal performance.
nvmcapNVM Capacity indicates the total size of the NVM allocated to this namespace. The value is in bytes.
npwgNamespace Preferred Write Granularity indicates the smallest recommended write granularity in logical blocks for this namespace. This is a 0’s based value.
npwaNamespace Preferred Write Alignment indicates the recommended write alignment in logical blocks for this namespace. This is a 0’s based value.
npdgNamespace Preferred Deallocate Granularity indicates the recommended granularity in logical blocks for the Dataset Management command with the Attribute - Deallocate bit.
npdaNamespace Preferred Deallocate Alignment indicates the recommended alignment in logical blocks for the Dataset Management command with the Attribute - Deallocate bit
nowsNamespace Optimal Write Size indicates the size in logical blocks for optimal write performance for this namespace. This is a 0’s based value.
mssrlMaximum Single Source Range Length indicates the maximum number of logical blocks that may be specified in each valid Source Range field of a Copy command.
mclMaximum Copy Length indicates the maximum number of logical blocks that may be specified in a Copy command.
msrcMaximum Source Range Count indicates the maximum number of Source Range entries that may be used to specify source data in a Copy command. This is a 0’s based value.
rsvd81Reserved
nulbafNumber of Unique Capability LBA Formats defines the number of supported user data size and metadata size combinations supported by the namespace that may not share the same capabilities. LBA formats shall be allocated in order and packed sequentially.
rsvd83Reserved
anagrpidANA Group Identifier indicates the ANA Group Identifier of the ANA group of which the namespace is a member.
rsvd96Reserved
nsattrNamespace Attributes, see
enum nvme_id_ns_attr.nvmsetidNVM Set Identifier indicates the NVM Set with which this namespace is associated.
endgidEndurance Group Identifier indicates the Endurance Group with which this namespace is associated.
nguidNamespace Globally Unique Identifier contains a 128-bit value that is globally unique and assigned to the namespace when the namespace is created. This field remains fixed throughout the life of the namespace and is preserved across namespace and controller operations
eui64IEEE Extended Unique Identifier contains a 64-bit IEEE Extended Unique Identifier (EUI-64) that is globally unique and assigned to the namespace when the namespace is created. This field remains fixed throughout the life of the namespace and is preserved across namespace and controller operations
lbafLBA Format, see
struct nvme_lbaf.lbstmLogical Block Storage Tag Mask for end-to-end protection
vsVendor Specific
-
enum
nvme_id_nsfeat This field defines features of the namespace.
Constants
NVME_NS_FEAT_THINIf set, indicates that the namespace supports thin provisioning. Specifically, the Namespace Capacity reported may be less than the Namespace Size.
NVME_NS_FEAT_NATOMICIf set, indicates that the fields NAWUN, NAWUPF, and NACWU are defined for this namespace and should be used by the host for this namespace instead of the AWUN, AWUPF, and ACWU fields in the Identify Controller data structure.
NVME_NS_FEAT_DULBEIf set, indicates that the controller supports the Deallocated or Unwritten Logical Block error for this namespace.
NVME_NS_FEAT_ID_REUSEIf set, indicates that the value in the NGUID field for this namespace, if non- zero, is never reused by the controller and that the value in the EUI64 field for this namespace, if non-zero, is never reused by the controller.
NVME_NS_FEAT_IO_OPTIf set, indicates that the fields NPWG, NPWA, NPDG, NPDA, and NOWS are defined for this namespace and should be used by the host for I/O optimization
-
enum
nvme_id_ns_flbas This field indicates the LBA data size & metadata size combination that the namespace has been formatted with
Constants
NVME_NS_FLBAS_LOWER_MASKMask to get the index of one of the supported LBA Formats’s least significant 4bits indicated in
struct nvme_id_ns.lbaf.NVME_NS_FLBAS_META_EXTApplicable only if format contains metadata. If this bit is set, indicates that the metadata is transferred at the end of the data LBA, creating an extended data LBA. If cleared, indicates that all of the metadata for a command is transferred as a separate contiguous buffer of data.
NVME_NS_FLBAS_HIGHER_MASKMask to get the index of one of the supported LBA Formats’s most significant 2bits indicated in
struct nvme_id_ns.lbaf.
-
enum
nvme_nvm_id_ns_elbaf This field indicates the extended LBA format
Constants
NVME_NVM_ELBAF_STS_MASKMask to get the storage tag size used to determine the variable-sized storage tag/reference tag fields
NVME_NVM_ELBAF_PIF_MASKMask to get the protection information format for the extended LBA format.
-
enum
nvme_id_ns_mc This field indicates the capabilities for metadata.
Constants
NVME_NS_MC_EXTENDEDIf set, indicates the namespace supports the metadata being transferred as part of a separate buffer that is specified in the Metadata Pointer.
NVME_NS_MC_SEPARATEIf set, indicates that the namespace supports the metadata being transferred as part of an extended data LBA.
-
enum
nvme_id_ns_dpc This field indicates the capabilities for the end-to-end data protection feature.
Constants
NVME_NS_DPC_PI_TYPE1If set, indicates that the namespace supports Protection Information Type 1.
NVME_NS_DPC_PI_TYPE2If set, indicates that the namespace supports Protection Information Type 2.
NVME_NS_DPC_PI_TYPE3If set, indicates that the namespace supports Protection Information Type 3.
NVME_NS_DPC_PI_FIRSTIf set, indicates that the namespace supports protection information transferred as the first eight bytes of metadata.
NVME_NS_DPC_PI_LASTIf set, indicates that the namespace supports protection information transferred as the last eight bytes of metadata.
-
enum
nvme_id_ns_dps This field indicates the Type settings for the end-to-end data protection feature.
Constants
NVME_NS_DPS_PI_NONEProtection information is not enabled
NVME_NS_DPS_PI_TYPE1Protection information is enabled, Type 1
NVME_NS_DPS_PI_TYPE2Protection information is enabled, Type 2
NVME_NS_DPS_PI_TYPE3Protection information is enabled, Type 3
NVME_NS_DPS_PI_MASKMask to get the value of the PI type
NVME_NS_DPS_PI_FIRSTIf set, indicates that the protection information, if enabled, is transferred as the first eight bytes of metadata.
-
enum
nvme_id_ns_nmic This field specifies multi-path I/O and namespace sharing capabilities of the namespace.
Constants
NVME_NS_NMIC_SHAREDIf set, then the namespace may be attached to two or more controllers in the NVM subsystem concurrently
-
enum
nvme_id_ns_rescap This field indicates the reservation capabilities of the namespace.
Constants
NVME_NS_RESCAP_PTPLIf set, indicates that the namespace supports the Persist Through Power Loss capability.
NVME_NS_RESCAP_WEIf set, indicates that the namespace supports the Write Exclusive reservation type.
NVME_NS_RESCAP_EAIf set, indicates that the namespace supports the Exclusive Access reservation type.
NVME_NS_RESCAP_WEROIf set, indicates that the namespace supports the Write Exclusive - Registrants Only reservation type.
NVME_NS_RESCAP_EAROIf set, indicates that the namespace supports the Exclusive Access - Registrants Only reservation type.
NVME_NS_RESCAP_WEARIf set, indicates that the namespace supports the Write Exclusive - All Registrants reservation type.
NVME_NS_RESCAP_EAARIf set, indicates that the namespace supports the Exclusive Access - All Registrants reservation type.
NVME_NS_RESCAP_IEK_13If set, indicates that Ignore Existing Key is used as defined in revision 1.3 or later of this specification.
-
enum
nvme_nd_ns_fpi If a format operation is in progress, this field indicates the percentage of the namespace that remains to be formatted.
Constants
NVME_NS_FPI_REMAININGMask to get the format percent remaining value
NVME_NS_FPI_SUPPORTEDIf set, indicates that the namespace supports the Format Progress Indicator defined for the field.
-
enum
nvme_id_ns_dlfeat This field indicates information about features that affect deallocating logical blocks for this namespace.
Constants
NVME_NS_DLFEAT_RBMask to get the value of the read behavior
NVME_NS_DLFEAT_RB_NRRead behvaior is not reported
NVME_NS_DLFEAT_RB_ALL_0SA deallocated logical block returns all bytes cleared to 0h.
NVME_NS_DLFEAT_RB_ALL_FSA deallocated logical block returns all bytes set to FFh.
NVME_NS_DLFEAT_WRITE_ZEROESIf set, indicates that the controller supports the Deallocate bit in the Write Zeroes command for this namespace.
NVME_NS_DLFEAT_CRC_GUARDIf set, indicates that the Guard field for deallocated logical blocks that contain protection information is set to the CRC for the value read from the deallocated logical block and its metadata
-
enum
nvme_id_ns_attr Specifies attributes of the namespace.
Constants
NVME_NS_NSATTR_WRITE_PROTECTEDIf set, then the namespace is currently write protected and all write access to the namespace shall fail.
-
struct
nvme_ns_id_desc Namespace identifier type descriptor
Definition
struct nvme_ns_id_desc {
__u8 nidt;
__u8 nidl;
__le16 rsvd;
__u8 nid[];
};
Members
nidtNamespace Identifier Type, see
enum nvme_ns_id_desc_nidtnidlNamespace Identifier Length contains the length in bytes of the
struct nvme_id_ns.nid.rsvdReserved
nidNamespace Identifier contains a value that is globally unique and assigned to the namespace when the namespace is created. The length is defined in
struct nvme_id_ns.nidl.
-
enum
nvme_ns_id_desc_nidt Known namespace identifier types
Constants
NVME_NIDT_EUI64IEEE Extended Unique Identifier, the NID field contains a copy of the EUI64 field in the struct nvme_id_ns.eui64.
NVME_NIDT_NGUIDNamespace Globally Unique Identifier, the NID field contains a copy of the NGUID field in struct nvme_id_ns.nguid.
NVME_NIDT_UUIDThe NID field contains a 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122.
NVME_NIDT_CSIThe NID field contains the command set identifier.
-
struct
nvme_nvmset_attr NVM Set Attributes Entry
Definition
struct nvme_nvmset_attr {
__le16 nvmsetid;
__le16 endgid;
__u8 rsvd4[4];
__le32 rr4kt;
__le32 ows;
__u8 tnvmsetcap[16];
__u8 unvmsetcap[16];
__u8 rsvd48[80];
};
Members
nvmsetidNVM Set Identifier
endgidEndurance Group Identifier
rsvd4Reserved
rr4ktRandom 4 KiB Read Typical indicates the typical time to complete a 4 KiB random read in 100 nanosecond units when the NVM Set is in a Predictable Latency Mode Deterministic Window and there is 1 outstanding command per NVM Set.
owsOptimal Write Size
tnvmsetcapTotal NVM Set Capacity
unvmsetcapUnallocated NVM Set Capacity
rsvd48Reserved
-
struct
nvme_id_nvmset_list NVM set list
Definition
struct nvme_id_nvmset_list {
__u8 nid;
__u8 rsvd1[127];
struct nvme_nvmset_attr ent[NVME_ID_NVMSET_LIST_MAX];
};
Members
nidNvmset id
rsvd1Reserved
entnvmset id list
-
struct
nvme_id_independent_id_ns Identify - I/O Command Set Independent Identify Namespace Data Structure
Definition
struct nvme_id_independent_id_ns {
__u8 nsfeat;
__u8 nmic;
__u8 rescap;
__u8 fpi;
__le32 anagrpid;
__u8 nsattr;
__u8 rsvd9;
__le16 nvmsetid;
__le16 endgid;
__u8 nstat;
__u8 rsvd15[4081];
};
Members
nsfeatcommon namespace features
nmicNamespace Multi-path I/O and Namespace Sharing Capabilities
rescapReservation Capabilities
fpiFormat Progress Indicator
anagrpidANA Group Identifier
nsattrNamespace Attributes
rsvd9reserved
nvmsetidNVM Set Identifier
endgidEndurance Group Identifier
nstatNamespace Status
rsvd15reserved
-
struct
nvme_id_ns_granularity_desc Namespace Granularity Descriptor
Definition
struct nvme_id_ns_granularity_desc {
__le64 nszegran;
__le64 ncapgran;
};
Members
nszegranNamespace Size Granularity
ncapgranNamespace Capacity Granularity
-
struct
nvme_id_ns_granularity_list Namespace Granularity List
Definition
struct nvme_id_ns_granularity_list {
__le32 attributes;
__u8 num_descriptors;
__u8 rsvd5[27];
struct nvme_id_ns_granularity_desc entry[NVME_ID_ND_DESCRIPTOR_MAX];
__u8 rsvd288[3808];
};
Members
attributesNamespace Granularity Attributes
num_descriptorsNumber of Descriptors
rsvd5reserved
entryNamespace Granularity Descriptor
rsvd288reserved
-
struct
nvme_id_uuid_list_entry UUID List Entry
Definition
struct nvme_id_uuid_list_entry {
__u8 header;
__u8 rsvd1[15];
__u8 uuid[16];
};
Members
headerUUID Lists Entry Header
rsvd1reserved
uuid128-bit Universally Unique Identifier
-
enum
nvme_id_uuid Identifier Association
Constants
NVME_ID_UUID_HDR_ASSOCIATION_MASK
NVME_ID_UUID_ASSOCIATION_NONE
NVME_ID_UUID_ASSOCIATION_VENDOR
NVME_ID_UUID_ASSOCIATION_SUBSYSTEM_VENDOR
-
struct
nvme_id_uuid_list UUID list
Definition
struct nvme_id_uuid_list {
__u8 rsvd0[32];
struct nvme_id_uuid_list_entry entry[NVME_ID_UUID_LIST_MAX];
};
Members
rsvd0reserved
entryUUID list entry
-
struct
nvme_ctrl_list Controller List
Definition
struct nvme_ctrl_list {
__le16 num;
__le16 identifier[NVME_ID_CTRL_LIST_MAX];
};
Members
numNumber of Identifiers
identifierNVM subsystem unique controller identifier
-
struct
nvme_ns_list Namespace List
Definition
struct nvme_ns_list {
__le32 ns[NVME_ID_NS_LIST_MAX];
};
Members
nsNamespace Identifier
-
struct
nvme_id_ctrl_nvm I/O Command Set Specific Identify Controller data structure
Definition
struct nvme_id_ctrl_nvm {
__u8 vsl;
__u8 wzsl;
__u8 wusl;
__u8 dmrl;
__le32 dmrsl;
__le64 dmsl;
__u8 rsvd16[4080];
};
Members
vslVerify Size Limit
wzslWrite Zeroes Size Limit
wuslWrite Uncorrectable Size Limit
dmrlDataset Management Ranges Limit
dmrslDataset Management Range Size Limit
dmslDataset Management Size Limit
rsvd16reserved
-
struct
nvme_nvm_id_ns NVME Command Set I/O Command Set Specific Identify Namespace Data Structure
Definition
struct nvme_nvm_id_ns {
__le64 lbstm;
__u8 pic;
__u8 rsvd9[3];
__le32 elbaf[64];
__u8 rsvd268[3828];
};
Members
lbstmLogical Block Storage Tag Mask
picProtection Information Capabilities
rsvd9Reserved
elbafList of Extended LBA Format Support
rsvd268Reserved
-
struct
nvme_zns_lbafe LBA Format Extension Data Structure
Definition
struct nvme_zns_lbafe {
__le64 zsze;
__u8 zdes;
__u8 rsvd9[7];
};
Members
zszeZone Size
zdesZone Descriptor Extension Size
rsvd9reserved
-
struct
nvme_zns_id_ns Zoned Namespace Command Set Specific Identify Namespace Data Structure
Definition
struct nvme_zns_id_ns {
__le16 zoc;
__le16 ozcs;
__le32 mar;
__le32 mor;
__le32 rrl;
__le32 frl;
__le32 rrl1;
__le32 rrl2;
__le32 rrl3;
__le32 frl1;
__le32 frl2;
__le32 frl3;
__le32 numzrwa;
__le16 zrwafg;
__le16 zrwasz;
__u8 zrwacap;
__u8 rsvd53[2763];
struct nvme_zns_lbafe lbafe[64];
__u8 vs[256];
};
Members
zocZone Operation Characteristics
ozcsOptional Zoned Command Support
marMaximum Active Resources
morMaximum Open Resources
rrlReset Recommended Limit
frlFinish Recommended Limit
rrl1Reset Recommended Limit 1
rrl2Reset Recommended Limit 2
rrl3Reset Recommended Limit 3
frl1Finish Recommended Limit 1
frl2Finish Recommended Limit 2
frl3Finish Recommended Limit 3
numzrwaNumber of ZRWA Resources
zrwafgZRWA Flush Granularity
zrwaszZRWA Size
zrwacapZRWA Capability
rsvd53Reserved
lbafeLBA Format Extension
vsVendor Specific
-
struct
nvme_zns_id_ctrl I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set
Definition
struct nvme_zns_id_ctrl {
__u8 zasl;
__u8 rsvd1[4095];
};
Members
zaslZone Append Size Limit
rsvd1Reserved
-
struct
nvme_primary_ctrl_cap Identify - Controller Capabilities Structure
Definition
struct nvme_primary_ctrl_cap {
__le16 cntlid;
__le16 portid;
__u8 crt;
__u8 rsvd5[27];
__le32 vqfrt;
__le32 vqrfa;
__le16 vqrfap;
__le16 vqprt;
__le16 vqfrsm;
__le16 vqgran;
__u8 rsvd48[16];
__le32 vifrt;
__le32 virfa;
__le16 virfap;
__le16 viprt;
__le16 vifrsm;
__le16 vigran;
__u8 rsvd80[4016];
};
Members
cntlidController Identifier
portidPort Identifier
crtController Resource Types
rsvd5reserved
vqfrtVQ Resources Flexible Total
vqrfaVQ Resources Flexible Assigned
vqrfapVQ Resources Flexible Allocated to Primary
vqprtVQ Resources Private Total
vqfrsmVQ Resources Flexible Secondary Maximum
vqgranVQ Flexible Resource Preferred Granularity
rsvd48reserved
vifrtVI Resources Flexible Total
virfaVI Resources Flexible Assigned
virfapVI Resources Flexible Allocated to Primary
viprtVI Resources Private Total
vifrsmVI Resources Flexible Secondary Maximum
vigranVI Flexible Resource Preferred Granularity
rsvd80reserved
-
struct
nvme_secondary_ctrl Secondary Controller Entry
Definition
struct nvme_secondary_ctrl {
__le16 scid;
__le16 pcid;
__u8 scs;
__u8 rsvd5[3];
__le16 vfn;
__le16 nvq;
__le16 nvi;
__u8 rsvd14[18];
};
Members
scidSecondary Controller Identifier
pcidPrimary Controller Identifier
scsSecondary Controller State
rsvd5Reserved
vfnVirtual Function Number
nvqNumber of VQ Flexible Resources Assigned
nviNumber of VI Flexible Resources Assigned
rsvd14Reserved
-
struct
nvme_secondary_ctrl_list Secondary Controller List
Definition
struct nvme_secondary_ctrl_list {
__u8 num;
__u8 rsvd[31];
struct nvme_secondary_ctrl sc_entry[NVME_ID_SECONDARY_CTRL_MAX];
};
Members
numNumber of Identifiers
rsvdReserved
sc_entrySecondary Controller Entry
-
struct
nvme_id_iocs NVMe Identify IO Command Set data structure
Definition
struct nvme_id_iocs {
__le64 iocsc[512];
};
Members
iocscList of supported IO Command Set Combination vectors
-
struct
nvme_id_domain_attr Domain Attributes Entry
Definition
struct nvme_id_domain_attr {
__le16 dom_id;
__u8 rsvd2[14];
__u8 dom_cap[16];
__u8 unalloc_dom_cap[16];
__u8 max_egrp_dom_cap[16];
__u8 rsvd64[64];
};
Members
dom_idDomain Identifier
rsvd2Reserved
dom_capTotal Domain Capacity
unalloc_dom_capUnallocated Domain Capacity
max_egrp_dom_capMax Endurance Group Domain Capacity
rsvd64Reserved
-
struct
nvme_id_domain_list Domain List
Definition
struct nvme_id_domain_list {
__u8 num;
__u8 rsvd[127];
struct nvme_id_domain_attr domain_attr[NVME_ID_DOMAIN_LIST_MAX];
};
Members
numNumber of domain attributes
rsvdReserved
domain_attrList of domain attributes
-
struct
nvme_id_endurance_group_list Endurance Group List
Definition
struct nvme_id_endurance_group_list {
__le16 num;
__le16 identifier[NVME_ID_ENDURANCE_GROUP_LIST_MAX];
};
Members
numNumber of Identifiers
identifierEndurance Group Identifier
-
struct
nvme_supported_log_pages Supported Log Pages - Log
Definition
struct nvme_supported_log_pages {
__le32 lid_support[NVME_LOG_SUPPORTED_LOG_PAGES_MAX];
};
Members
lid_supportLog Page Identifier Supported
Description
Supported Log Pages (Log Identifier 00h)
-
struct
nvme_error_log_page Error Information Log Entry (Log Identifier 01h)
Definition
struct nvme_error_log_page {
__le64 error_count;
__le16 sqid;
__le16 cmdid;
__le16 status_field;
__le16 parm_error_location;
__le64 lba;
__le32 nsid;
__u8 vs;
__u8 trtype;
__u8 csi;
__u8 opcode;
__le64 cs;
__le16 trtype_spec_info;
__u8 rsvd[21];
__u8 log_page_version;
};
Members
error_countError Count: a 64-bit incrementing error count, indicating a unique identifier for this error. The error count starts at
1h, is incremented for each unique error log entry, and is retained across power off conditions. A value of0hindicates an invalid entry; this value is used when there are lost entries or when there are fewer errors than the maximum number of entries the controller supports. If the value of this field isFFFFFFFFh, then the field shall be set to 1h when incremented (i.e., rolls over to1h). Prior to NVMe 1.4, processing of incrementing beyondFFFFFFFFhis unspecified.sqidSubmission Queue ID: indicates the Submission Queue Identifier of the command that the error information is associated with. If the error is not specific to a particular command, then this field shall be set to
FFFFh.cmdidCommand ID: indicates the Command Identifier of the command that the error is associated with. If the error is not specific to a particular command, then this field shall be set to
FFFFh.status_fieldBits 15-1: Status Field: indicates the Status Field for the command that completed. If the error is not specific to a particular command, then this field reports the most applicable status value. Bit 0: Phase Tag: may indicate the Phase Tag posted for the command.
parm_error_locationParameter Error Location: indicates the byte and bit of the command parameter that the error is associated with, if applicable. If the parameter spans multiple bytes or bits, then the location indicates the first byte and bit of the parameter. Bits 10-8: Bit in command that contained the error. Valid values are 0 to 7. Bits 7-0: Byte in command that contained the error. Valid values are 0 to 63.
lbaLBA: This field indicates the first LBA that experienced the error condition, if applicable.
nsidNamespace: This field indicates the NSID of the namespace that the error is associated with, if applicable.
vsVendor Specific Information Available: If there is additional vendor specific error information available, this field provides the log page identifier associated with that page. A value of
0hindicates that no additional information is available. Valid values are in the range of80htoFFh.trtypeTransport Type (TRTYPE): indicates the Transport Type of the transport associated with the error. The values in this field are the same as the TRTYPE values in the Discovery Log Page Entry. If the error is not transport related, this field shall be cleared to
0h. If the error is transport related, this field shall be set to the type of the transport - seeenum nvme_trtype.csiCommand Set Indicator: This field contains command set indicator for the command that the error is associated with.
opcodeOpcode: This field contains opcode for the command that the error is associated with.
csCommand Specific Information: This field contains command specific information. If used, the command definition specifies the information returned.
trtype_spec_infoTransport Type Specific Information
rsvdReserved: [62:42]
log_page_versionThis field shall be set to 1h. If set, csi and opcode will have valid values.
-
struct
nvme_smart_log SMART / Health Information Log (Log Identifier 02h)
Definition
struct nvme_smart_log {
__u8 critical_warning;
__u8 temperature[2];
__u8 avail_spare;
__u8 spare_thresh;
__u8 percent_used;
__u8 endu_grp_crit_warn_sumry;
__u8 rsvd7[25];
__u8 data_units_read[16];
__u8 data_units_written[16];
__u8 host_reads[16];
__u8 host_writes[16];
__u8 ctrl_busy_time[16];
__u8 power_cycles[16];
__u8 power_on_hours[16];
__u8 unsafe_shutdowns[16];
__u8 media_errors[16];
__u8 num_err_log_entries[16];
__le32 warning_temp_time;
__le32 critical_comp_time;
__le16 temp_sensor[8];
__le32 thm_temp1_trans_count;
__le32 thm_temp2_trans_count;
__le32 thm_temp1_total_time;
__le32 thm_temp2_total_time;
__u8 rsvd232[280];
};
Members
critical_warningThis field indicates critical warnings for the state of the controller. Critical warnings may result in an asynchronous event notification to the host. Bits in this field represent the current associated state and are not persistent (see
enum nvme_smart_crit).temperatureComposite Temperature: Contains a value corresponding to a temperature in Kelvins that represents the current composite temperature of the controller and namespace(s) associated with that controller. The manner in which this value is computed is implementation specific and may not represent the actual temperature of any physical point in the NVM subsystem. Warning and critical overheating composite temperature threshold values are reported by the WCTEMP and CCTEMP fields in the Identify Controller data structure.
avail_spareAvailable Spare: Contains a normalized percentage (0% to 100%) of the remaining spare capacity available.
spare_threshAvailable Spare Threshold: When the Available Spare falls below the threshold indicated in this field, an asynchronous event completion may occur. The value is indicated as a normalized percentage (0% to 100%). The values 101 to 255 are reserved.
percent_usedPercentage Used: Contains a vendor specific estimate of the percentage of NVM subsystem life used based on the actual usage and the manufacturer’s prediction of NVM life. A value of 100 indicates that the estimated endurance of the NVM in the NVM subsystem has been consumed, but may not indicate an NVM subsystem failure. The value is allowed to exceed 100. Percentages greater than 254 shall be represented as 255. This value shall be updated once per power-on hour (when the controller is not in a sleep state).
endu_grp_crit_warn_sumryEndurance Group Critical Warning Summary: This field indicates critical warnings for the state of Endurance Groups. Bits in this field represent the current associated state and are not persistent (see
enum nvme_smart_egcw).rsvd7Reserved
data_units_readData Units Read: Contains the number of 512 byte data units the host has read from the controller; this value does not include metadata. This value is reported in thousands (i.e., a value of 1 corresponds to 1000 units of 512 bytes read) and is rounded up (e.g., one indicates the that number of 512 byte data units read is from 1 to 1000, three indicates that the number of 512 byte data units read is from 2001 to 3000). When the LBA size is a value other than 512 bytes, the controller shall convert the amount of data read to 512 byte units. For the NVM command set, logical blocks read as part of Compare, Read, and Verify operations shall be included in this value. A value of
0hin this field indicates that the number of Data Units Read is not reported.data_units_writtenData Units Written: Contains the number of 512 byte data units the host has written to the controller; this value does not include metadata. This value is reported in thousands (i.e., a value of 1 corresponds to 1000 units of 512 bytes written) and is rounded up (e.g., one indicates that the number of 512 byte data units written is from 1 to 1,000, three indicates that the number of 512 byte data units written is from 2001 to 3000). When the LBA size is a value other than 512 bytes, the controller shall convert the amount of data written to 512 byte units. For the NVM command set, logical blocks written as part of Write operations shall be included in this value. Write Uncorrectable commands and Write Zeroes commands shall not impact this value. A value of
0hin this field indicates that the number of Data Units Written is not reported.host_readsHost Read Commands: Contains the number of read commands completed by the controller. For the NVM command set, this value is the sum of the number of Compare commands and the number of Read commands.
host_writesHost Write Commands: Contains the number of write commands completed by the controller. For the NVM command set, this is the number of Write commands.
ctrl_busy_timeController Busy Time: Contains the amount of time the controller is busy with I/O commands. The controller is busy when there is a command outstanding to an I/O Queue (specifically, a command was issued via an I/O Submission Queue Tail doorbell write and the corresponding completion queue entry has not been posted yet to the associated I/O Completion Queue). This value is reported in minutes.
power_cyclesPower Cycles: Contains the number of power cycles.
power_on_hoursPower On Hours: Contains the number of power-on hours. This may not include time that the controller was powered and in a non-operational power state.
unsafe_shutdownsUnsafe Shutdowns: Contains the number of unsafe shutdowns. This count is incremented when a Shutdown Notification (CC.SHN) is not received prior to loss of power.
media_errorsMedia and Data Integrity Errors: Contains the number of occurrences where the controller detected an unrecovered data integrity error. Errors such as uncorrectable ECC, CRC checksum failure, or LBA tag mismatch are included in this field. Errors introduced as a result of a Write Uncorrectable command may or may not be included in this field.
num_err_log_entriesNumber of Error Information Log Entries: Contains the number of Error Information log entries over the life of the controller.
warning_temp_timeWarning Composite Temperature Time: Contains the amount of time in minutes that the controller is operational and the Composite Temperature is greater than or equal to the Warning Composite Temperature Threshold (WCTEMP) field and less than the Critical Composite Temperature Threshold (CCTEMP) field in the Identify Controller data structure. If the value of the WCTEMP or CCTEMP field is
0h, then this field is always cleared to0hregardless of the Composite Temperature value.critical_comp_timeCritical Composite Temperature Time: Contains the amount of time in minutes that the controller is operational and the Composite Temperature is greater than or equal to the Critical Composite Temperature Threshold (CCTEMP) field in the Identify Controller data structure. If the value of the CCTEMP field is
0h, then this field is always cleared to 0h regardless of the Composite Temperature value.temp_sensorTemperature Sensor 1-8: Contains the current temperature in degrees Kelvin reported by temperature sensors 1-8. The physical point in the NVM subsystem whose temperature is reported by the temperature sensor and the temperature accuracy is implementation specific. An implementation that does not implement the temperature sensor reports a value of
0h.thm_temp1_trans_countThermal Management Temperature 1 Transition Count: Contains the number of times the controller transitioned to lower power active power states or performed vendor specific thermal management actions while minimizing the impact on performance in order to attempt to reduce the Composite Temperature because of the host controlled thermal management feature (i.e., the Composite Temperature rose above the Thermal Management Temperature 1). This counter shall not wrap once the value
FFFFFFFFhis reached. A value of0h, indicates that this transition has never occurred or this field is not implemented.thm_temp2_trans_countThermal Management Temperature 2 Transition Count
thm_temp1_total_timeTotal Time For Thermal Management Temperature 1: Contains the number of seconds that the controller had transitioned to lower power active power states or performed vendor specific thermal management actions while minimizing the impact on performance in order to attempt to reduce the Composite Temperature because of the host controlled thermal management feature. This counter shall not wrap once the value
FFFFFFFFhis reached. A value of0h, indicates that this transition has never occurred or this field is not implemented.thm_temp2_total_timeTotal Time For Thermal Management Temperature 2
rsvd232Reserved
-
enum
nvme_smart_crit Critical Warning
Constants
NVME_SMART_CRIT_SPAREIf set, then the available spare capacity has fallen below the threshold.
NVME_SMART_CRIT_TEMPERATUREIf set, then a temperature is either greater than or equal to an over temperature threshold; or less than or equal to an under temperature threshold.
NVME_SMART_CRIT_DEGRADEDIf set, then the NVM subsystem reliability has been degraded due to significant media related errors or any internal error that degrades NVM subsystem reliability.
NVME_SMART_CRIT_MEDIAIf set, then all of the media has been placed in read only mode. The controller shall not set this bit if the read-only condition on the media is a result of a change in the write protection state of a namespace.
NVME_SMART_CRIT_VOLATILE_MEMORYIf set, then the volatile memory backup device has failed. This field is only valid if the controller has a volatile memory backup solution.
NVME_SMART_CRIT_PMR_ROIf set, then the Persistent Memory Region has become read-only or unreliable.
-
enum
nvme_smart_egcw Endurance Group Critical Warning Summary
Constants
NVME_SMART_EGCW_SPAREIf set, then the available spare capacity of one or more Endurance Groups has fallen below the threshold.
NVME_SMART_EGCW_DEGRADEDIf set, then the reliability of one or more Endurance Groups has been degraded due to significant media related errors or any internal error that degrades NVM subsystem reliability.
NVME_SMART_EGCW_ROIf set, then the namespaces in one or more Endurance Groups have been placed in read only mode not as a result of a change in the write protection state of a namespace.
-
struct
nvme_firmware_slot Firmware Slot Information Log
Definition
struct nvme_firmware_slot {
__u8 afi;
__u8 rsvd1[7];
char frs[7][8];
__u8 rsvd2[448];
};
Members
afiActive Firmware Info
rsvd1Reserved
frsFirmware Revision for Slot
rsvd2Reserved
-
struct
nvme_cmd_effects_log Commands Supported and Effects Log
Definition
struct nvme_cmd_effects_log {
__le32 acs[256];
__le32 iocs[256];
__u8 rsvd[2048];
};
Members
acsAdmin Command Supported
iocsI/O Command Supported
rsvdReserved
-
enum
nvme_cmd_effects Commands Supported and Effects
Constants
NVME_CMD_EFFECTS_CSUPPCommand Supported
NVME_CMD_EFFECTS_LBCCLogical Block Content Change
NVME_CMD_EFFECTS_NCCNamespace Capability Change
NVME_CMD_EFFECTS_NICNamespace Inventory Change
NVME_CMD_EFFECTS_CCCController Capability Change
NVME_CMD_EFFECTS_CSE_MASKCommand Submission and Execution
NVME_CMD_EFFECTS_UUID_SELUUID Selection Supported
-
struct
nvme_st_result Self-test Result
Definition
struct nvme_st_result {
__u8 dsts;
__u8 seg;
__u8 vdi;
__u8 rsvd;
__le64 poh;
__le32 nsid;
__le64 flba;
__u8 sct;
__u8 sc;
__u8 vs[2];
};
Members
dstsDevice Self-test Status: Indicates the device self-test code and the status of the operation (see
enum nvme_status_resultandenum nvme_st_code).segSegment Number: Iindicates the segment number where the first self-test failure occurred. If Device Self-test Status (dsts) is not set to #NVME_ST_RESULT_KNOWN_SEG_FAIL, then this field should be ignored.
vdiValid Diagnostic Information: Indicates the diagnostic failure information that is reported. See
enum nvme_st_valid_diag_info.rsvdReserved
pohPower On Hours (POH): Indicates the number of power-on hours at the time the device self-test operation was completed or aborted. This does not include time that the controller was powered and in a low power state condition.
nsidNamespace Identifier (NSID): Indicates the namespace that the Failing LBA occurred on. Valid only when the NSID Valid bit (#NVME_ST_VALID_DIAG_INFO_NSID) is set in the Valid Diagnostic Information (vdi) field.
flbaFailing LBA: indicates the LBA of the logical block that caused the test to fail. If the device encountered more than one failed logical block during the test, then this field only indicates one of those failed logical blocks. Valid only when the NSID Valid bit (#NVME_ST_VALID_DIAG_INFO_FLBA) is set in the Valid Diagnostic Information (vdi) field.
sctStatus Code Type: This field may contain additional information related to errors or conditions. Bits 2:0 may contain additional information relating to errors or conditions that occurred during the device self-test operation represented in the same format used in the Status Code Type field of the completion queue entry (refer to
enum nvme_status_field). Valid only when the NSID Valid bit (#NVME_ST_VALID_DIAG_INFO_SCT) is set in the Valid Diagnostic Information (vdi) field.scStatus Code: This field may contain additional information relating to errors or conditions that occurred during the device self-test operation represented in the same format used in the Status Code field of the completion queue entry. Valid only when the SCT Valid bit (#NVME_ST_VALID_DIAG_INFO_SC) is set in the Valid Diagnostic Information (vdi) field.
vsVendor Specific.
-
enum
nvme_status_result Result of the device self-test operation
Constants
NVME_ST_RESULT_NO_ERROperation completed without error.
NVME_ST_RESULT_ABORTEDOperation was aborted by a Device Self-test command.
NVME_ST_RESULT_CLROperation was aborted by a Controller Level Reset.
NVME_ST_RESULT_NS_REMOVEDOperation was aborted due to a removal of a namespace from the namespace inventory.
NVME_ST_RESULT_ABORTED_FORMATOperation was aborted due to the processing of a Format NVM command.
NVME_ST_RESULT_FATAL_ERRA fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete.
NVME_ST_RESULT_UNKNOWN_SEG_FAILOperation completed with a segment that failed and the segment that failed is not known.
NVME_ST_RESULT_KNOWN_SEG_FAILOperation completed with one or more failed segments and the first segment that failed is indicated in the Segment Number field.
NVME_ST_RESULT_ABORTED_UNKNOWNOperation was aborted for unknown reason.
NVME_ST_RESULT_ABORTED_SANITIZEOperation was aborted due to a sanitize operation.
NVME_ST_RESULT_NOT_USEDEntry not used (does not contain a test result).
NVME_ST_RESULT_MASKMask to get the status result value from the
struct nvme_st_result.dsts field.
-
enum
nvme_st_code Self-test Code value
Constants
NVME_ST_CODE_RESERVEDReserved.
NVME_ST_CODE_SHORTShort device self-test operation.
NVME_ST_CODE_EXTENDEDExtended device self-test operation.
NVME_ST_CODE_VSVendor specific.
NVME_ST_CODE_ABORTAbort device self-test operation.
NVME_ST_CODE_SHIFTShift amount to get the code value from the
struct nvme_st_result.dsts field.
-
enum
nvme_st_curr_op Current Device Self-Test Operation
Constants
NVME_ST_CURR_OP_NOT_RUNNINGNo device self-test operation in progress.
NVME_ST_CURR_OP_SHORTShort device self-test operation in progress.
NVME_ST_CURR_OP_EXTENDEDExtended device self-test operation in progress.
NVME_ST_CURR_OP_VSVendor specific.
NVME_ST_CURR_OP_RESERVEDReserved.
NVME_ST_CURR_OP_MASKMask to get the current operation value from the
struct nvme_self_test_log.current_operation field.NVME_ST_CURR_OP_CMPL_MASKMask to get the current operation completion value from the
struct nvme_self_test_log.completion field.
-
enum
nvme_st_valid_diag_info Valid Diagnostic Information
Constants
NVME_ST_VALID_DIAG_INFO_NSIDNSID Valid: if set, then the contents of the Namespace Identifier field are valid.
NVME_ST_VALID_DIAG_INFO_FLBAFLBA Valid: if set, then the contents of the Failing LBA field are valid.
NVME_ST_VALID_DIAG_INFO_SCTSCT Valid: if set, then the contents of the Status Code Type field are valid.
NVME_ST_VALID_DIAG_INFO_SCSC Valid: if set, then the contents of the Status Code field are valid.
-
struct
nvme_self_test_log Device Self-test (Log Identifier 06h)
Definition
struct nvme_self_test_log {
__u8 current_operation;
__u8 completion;
__u8 rsvd[2];
struct nvme_st_result result[NVME_LOG_ST_MAX_RESULTS];
};
Members
current_operationCurrent Device Self-Test Operation: indicates the status of the current device self-test operation. If a device self-test operation is in process (i.e., this field is set to #NVME_ST_CURR_OP_SHORT or #NVME_ST_CURR_OP_EXTENDED), then the controller shall not set this field to #NVME_ST_CURR_OP_NOT_RUNNING until a new Self-test Result Data Structure is created (i.e., if a device self-test operation completes or is aborted, then the controller shall create a Self-test Result Data Structure prior to setting this field to #NVME_ST_CURR_OP_NOT_RUNNING). See
enum nvme_st_curr_op.completionCurrent Device Self-Test Completion: indicates the percentage of the device self-test operation that is complete (e.g., a value of 25 indicates that 25% of the device self-test operation is complete and 75% remains to be tested). If the current_operation field is cleared to #NVME_ST_CURR_OP_NOT_RUNNING (indicating there is no device self-test operation in progress), then this field is ignored.
rsvdReserved
resultSelf-test Result Data Structures, see
struct nvme_st_result.
-
enum
nvme_cmd_get_log_telemetry_host_lsp Telemetry Host-Initiated log specific field
Constants
NVME_LOG_TELEM_HOST_LSP_RETAINGet Telemetry Data Blocks
NVME_LOG_TELEM_HOST_LSP_CREATECreate Telemetry Data Blocks
-
struct
nvme_telemetry_log Retrieve internal data specific to the manufacturer.
Definition
struct nvme_telemetry_log {
__u8 lpi;
__u8 rsvd1[4];
__u8 ieee[3];
__le16 dalb1;
__le16 dalb2;
__le16 dalb3;
__u8 rsvd14[2];
__le32 dalb4;
__u8 rsvd20[361];
__u8 hostdgn;
__u8 ctrlavail;
__u8 ctrldgn;
__u8 rsnident[128];
__u8 data_area[];
};
Members
lpiLog Identifier, either
NVME_LOG_LID_TELEMETRY_HOSTorNVME_LOG_LID_TELEMETRY_CTRLrsvd1Reserved
ieeeIEEE OUI Identifier is the Organization Unique Identifier (OUI) for the controller vendor that is able to interpret the data.
dalb1Telemetry Controller-Initiated Data Area 1 Last Block is the value of the last block in this area.
dalb2Telemetry Controller-Initiated Data Area 1 Last Block is the value of the last block in this area.
dalb3Telemetry Controller-Initiated Data Area 1 Last Block is the value of the last block in this area.
rsvd14Reserved
dalb4Telemetry Controller-Initiated Data Area 4 Last Block is the value of the last block in this area.
rsvd20Reserved
hostdgnTelemetry Host-Initiated Data Generation Number is a value that is incremented each time the host initiates a capture of its internal controller state in the controller .
ctrlavailTelemetry Controller-Initiated Data Available, if cleared, then the controller telemetry log does not contain saved internal controller state. If this field is set to 1h, the controller log contains saved internal controller state. If this field is set to 1h, the data will be latched until the host releases it by reading the log with RAE cleared.
ctrldgnTelemetry Controller-Initiated Data Generation Number is a value that is incremented each time the controller initiates a capture of its internal controller state in the controller .
rsnidentReason Identifiers a vendor specific identifier that describes the operating conditions of the controller at the time of capture.
data_areaTelemetry data blocks, vendor specific information data.
Description
This log consists of a header describing the log and zero or more Telemetry
Data Blocks. All Telemetry Data Blocks are NVME_LOG_TELEM_BLOCK_SIZE, 512
bytes, in size. This log captures the controller’s internal state.
-
struct
nvme_endurance_group_log Endurance Group Information Log
Definition
struct nvme_endurance_group_log {
__u8 critical_warning;
__u8 endurance_group_features;
__u8 rsvd2;
__u8 avl_spare;
__u8 avl_spare_threshold;
__u8 percent_used;
__le16 domain_identifier;
__u8 rsvd8[24];
__u8 endurance_estimate[16];
__u8 data_units_read[16];
__u8 data_units_written[16];
__u8 media_units_written[16];
__u8 host_read_cmds[16];
__u8 host_write_cmds[16];
__u8 media_data_integrity_err[16];
__u8 num_err_info_log_entries[16];
__u8 total_end_grp_cap[16];
__u8 unalloc_end_grp_cap[16];
__u8 rsvd192[320];
};
Members
critical_warningCritical Warning
endurance_group_featuresEndurance Group Features
rsvd2Reserved
avl_spareAvailable Spare
avl_spare_thresholdAvailable Spare Threshold
percent_usedPercentage Used
domain_identifierDomain Identifier
rsvd8Reserved
endurance_estimateEndurance Estimate
data_units_readData Units Read
data_units_writtenData Units Written
media_units_writtenMedia Units Written
host_read_cmdsHost Read Commands
host_write_cmdsHost Write Commands
media_data_integrity_errMedia and Data Integrity Errors
num_err_info_log_entriesNumber of Error Information Log Entries
total_end_grp_capTotal Endurance Group Capacity
unalloc_end_grp_capUnallocated Endurance Group Capacity
rsvd192Reserved
-
enum
nvme_eg_critical_warning_flags Endurance Group Information Log - Critical Warning
Constants
NVME_EG_CRITICAL_WARNING_SPAREAvailable spare capacity of the Endurance Group has fallen below the threshold
NVME_EG_CRITICAL_WARNING_DEGRADEDEndurance Group reliability has been degraded
NVME_EG_CRITICAL_WARNING_READ_ONLYEndurance Group have been placed in read only mode
-
struct
nvme_aggregate_endurance_group_event Endurance Group Event Aggregate
Definition
struct nvme_aggregate_endurance_group_event {
__le64 num_entries;
__le16 entries[];
};
Members
num_entriesNumber or entries
entriesList of entries
-
struct
nvme_nvmset_predictable_lat_log Predictable Latency Mode - Deterministic Threshold Configuration Data
Definition
struct nvme_nvmset_predictable_lat_log {
__u8 status;
__u8 rsvd1;
__le16 event_type;
__u8 rsvd4[28];
__le64 dtwin_rt;
__le64 dtwin_wt;
__le64 dtwin_tmax;
__le64 ndwin_tmin_hi;
__le64 ndwin_tmin_lo;
__u8 rsvd72[56];
__le64 dtwin_re;
__le64 dtwin_we;
__le64 dtwin_te;
__u8 rsvd152[360];
};
Members
statusStatus
rsvd1Reserved
event_typeEvent Type
rsvd4Reserved
dtwin_rtDTWIN Reads Typical
dtwin_wtDTWIN Writes Typical
dtwin_tmaxDTWIN Time Maximum
ndwin_tmin_hiNDWIN Time Minimum High
ndwin_tmin_loNDWIN Time Minimum Low
rsvd72Reserved
dtwin_reDTWIN Reads Estimate
dtwin_weDTWIN Writes Estimate
dtwin_teDTWIN Time Estimate
rsvd152Reserved
-
enum
nvme_nvmeset_pl_status Predictable Latency Per NVM Set Log - Status
Constants
NVME_NVMSET_PL_STATUS_DISABLEDNot used (Predictable Latency Mode not enabled)
NVME_NVMSET_PL_STATUS_DTWINDeterministic Window (DTWIN)
NVME_NVMSET_PL_STATUS_NDWINNon-Deterministic Window (NDWIN)
-
enum
nvme_nvmset_pl_events Predictable Latency Per NVM Set Log - Event Type
Constants
NVME_NVMSET_PL_EVENT_DTWIN_READ_WARNDTWIN Reads Warning
NVME_NVMSET_PL_EVENT_DTWIN_WRITE_WARNDTWIN Writes Warning
NVME_NVMSET_PL_EVENT_DTWIN_TIME_WARNDTWIN Time Warning
NVME_NVMSET_PL_EVENT_DTWIN_EXCEEDEDAutonomous transition from DTWIN to NDWIN due to typical or maximum value exceeded
NVME_NVMSET_PL_EVENT_DTWIN_EXCURSIONAutonomous transition from DTWIN to NDWIN due to Deterministic Excursion
-
struct
nvme_aggregate_predictable_lat_event Predictable Latency Event Aggregate Log Page
Definition
struct nvme_aggregate_predictable_lat_event {
__le64 num_entries;
__le16 entries[];
};
Members
num_entriesNumber of entries
entriesEntry list
-
struct
nvme_ana_group_desc ANA Group Descriptor
Definition
struct nvme_ana_group_desc {
__le32 grpid;
__le32 nnsids;
__le64 chgcnt;
__u8 state;
__u8 rsvd17[15];
__le32 nsids[];
};
Members
grpidANA group id
nnsidsNumber of namespaces in nsids
chgcntChange counter
stateANA state
rsvd17Reserved
nsidsList of namespaces
-
enum
nvme_ana_state ANA Group Descriptor - Asymmetric Namespace Access State
Constants
NVME_ANA_STATE_OPTIMIZEDANA Optimized state
NVME_ANA_STATE_NONOPTIMIZEDANA Non-Optimized state
NVME_ANA_STATE_INACCESSIBLEANA Inaccessible state
NVME_ANA_STATE_PERSISTENT_LOSSANA Persistent Loss state
NVME_ANA_STATE_CHANGEANA Change state
-
struct
nvme_ana_log Asymmetric Namespace Access Log
Definition
struct nvme_ana_log {
__le64 chgcnt;
__le16 ngrps;
__u8 rsvd10[6];
struct nvme_ana_group_desc descs[];
};
Members
chgcntChange Count
ngrpsNumber of ANA Group Descriptors
rsvd10Reserved
descsANA Group Descriptor
-
struct
nvme_persistent_event_log Persistent Event Log
Definition
struct nvme_persistent_event_log {
__u8 lid;
__u8 rsvd1[3];
__le32 tnev;
__le64 tll;
__u8 rv;
__u8 rsvd17;
__le16 lhl;
__le64 ts;
__u8 poh[16];
__le64 pcc;
__le16 vid;
__le16 ssvid;
char sn[20];
char mn[40];
char subnqn[NVME_NQN_LENGTH];
__le16 gen_number;
__le32 rci;
__u8 rsvd378[102];
__u8 seb[32];
};
Members
lidLog Identifier
rsvd1Reserved
tnevTotal Number of Events
tllTotal Log Length
rvLog Revision
rsvd17Reserved
lhlLog Header Length
tsTimestamp
pohPower on Hours
pccPower Cycle Count
vidPCI Vendor ID
ssvidPCI Subsystem Vendor ID
snSerial Number
mnModel Number
subnqnNVM Subsystem NVMe Qualified Name
gen_numberGeneration Number
rciReporting Context Information
rsvd378Reserved
sebSupported Events Bitmap
-
struct
nvme_persistent_event_entry Persistent Event
Definition
struct nvme_persistent_event_entry {
__u8 etype;
__u8 etype_rev;
__u8 ehl;
__u8 ehai;
__le16 cntlid;
__le64 ets;
__le16 pelpid;
__u8 rsvd16[4];
__le16 vsil;
__le16 el;
};
Members
etypeEvent Type
etype_revEvent Type Revision
ehlEvent Header Length
ehaiEvent Header Additional Info
cntlidController Identifier
etsEvent Timestamp
pelpidPort Identifier
rsvd16Reserved
vsilVendor Specific Information Length
elEvent Length
-
enum
nvme_persistent_event_types Persistent event log events
Constants
NVME_PEL_SMART_HEALTH_EVENTSMART / Health Log Snapshot Event
NVME_PEL_FW_COMMIT_EVENTFirmware Commit Event
NVME_PEL_TIMESTAMP_EVENTTimestamp Change Event
NVME_PEL_POWER_ON_RESET_EVENTPower-on or Reset Event
NVME_PEL_NSS_HW_ERROR_EVENTNVM Subsystem Hardware Error Event
NVME_PEL_CHANGE_NS_EVENTChange Namespace Event
NVME_PEL_FORMAT_START_EVENTFormat NVM Start Event
NVME_PEL_FORMAT_COMPLETION_EVENTFormat NVM Completion Event
NVME_PEL_SANITIZE_START_EVENTSanitize Start Event
NVME_PEL_SANITIZE_COMPLETION_EVENTSanitize Completion Event
NVME_PEL_SET_FEATURE_EVENTSet Feature Event
NVME_PEL_TELEMETRY_CRTTelemetry Log Create Event
NVME_PEL_THERMAL_EXCURSION_EVENTThermal Excursion Event
-
struct
nvme_fw_commit_event Firmware Commit Event Data
Definition
struct nvme_fw_commit_event {
__le64 old_fw_rev;
__le64 new_fw_rev;
__u8 fw_commit_action;
__u8 fw_slot;
__u8 sct_fw;
__u8 sc_fw;
__le16 vndr_assign_fw_commit_rc;
};
Members
old_fw_revOld Firmware Revision
new_fw_revNew Firmware Revision
fw_commit_actionFirmware Commit Action
fw_slotFirmware Slot
sct_fwStatus Code Type for Firmware Commit Command
sc_fwStatus Returned for Firmware Commit Command
vndr_assign_fw_commit_rcVendor Assigned Firmware Commit Result Code
-
struct
nvme_timestamp Timestamp - Data Structure for Get Features
Definition
struct nvme_timestamp {
__u8 timestamp[6];
__u8 attr;
__u8 rsvd;
};
Members
timestampTimestamp value based on origin and synch field
attrAttribute
rsvdReserved
-
struct
nvme_time_stamp_change_event Timestamp Change Event
Definition
struct nvme_time_stamp_change_event {
__le64 previous_timestamp;
__le64 ml_secs_since_reset;
};
Members
previous_timestampPrevious Timestamp
ml_secs_since_resetMilliseconds Since Reset
-
struct
nvme_power_on_reset_info_list Controller Reset Information
Definition
struct nvme_power_on_reset_info_list {
__le16 cid;
__u8 fw_act;
__u8 op_in_prog;
__u8 rsvd4[12];
__le32 ctrl_power_cycle;
__le64 power_on_ml_seconds;
__le64 ctrl_time_stamp;
};
Members
cidController ID
fw_actFirmware Activation
op_in_progOperation in Progress
rsvd4Reserved
ctrl_power_cycleController Power Cycle
power_on_ml_secondsPower on milliseconds
ctrl_time_stampController Timestamp
-
struct
nvme_nss_hw_err_event NVM Subsystem Hardware Error Event
Definition
struct nvme_nss_hw_err_event {
__le16 nss_hw_err_event_code;
__u8 rsvd2[2];
__u8 *add_hw_err_info;
};
Members
nss_hw_err_event_codeNVM Subsystem Hardware Error Event Code
rsvd2Reserved
add_hw_err_infoAdditional Hardware Error Information
-
struct
nvme_change_ns_event Change Namespace Event Data
Definition
struct nvme_change_ns_event {
__le32 nsmgt_cdw10;
__u8 rsvd4[4];
__le64 nsze;
__u8 rsvd16[8];
__le64 nscap;
__u8 flbas;
__u8 dps;
__u8 nmic;
__u8 rsvd35;
__le32 ana_grp_id;
__le16 nvmset_id;
__le16 rsvd42;
__le32 nsid;
};
Members
nsmgt_cdw10Namespace Management CDW10
rsvd4Reserved
nszeNamespace Size
rsvd16Reserved
nscapNamespace Capacity
flbasFormatted LBA Size
dpsEnd-to-end Data Protection Type Settings
nmicNamespace Multi-path I/O and Namespace Sharing Capabilities
rsvd35Reserved
ana_grp_idANA Group Identifier
nvmset_idNVM Set Identifier
rsvd42Reserved
nsidNamespace ID
-
struct
nvme_format_nvm_start_event Format NVM Start Event Data
Definition
struct nvme_format_nvm_start_event {
__le32 nsid;
__u8 fna;
__u8 rsvd5[3];
__le32 format_nvm_cdw10;
};
Members
nsidNamespace Identifier
fnaFormat NVM Attributes
rsvd5Reserved
format_nvm_cdw10Format NVM CDW10
-
struct
nvme_format_nvm_compln_event Format NVM Completion Event Data
Definition
struct nvme_format_nvm_compln_event {
__le32 nsid;
__u8 smallest_fpi;
__u8 format_nvm_status;
__le16 compln_info;
__le32 status_field;
};
Members
nsidNamespace Identifier
smallest_fpiSmallest Format Progress Indicator
format_nvm_statusFormat NVM Status
compln_infoCompletion Information
status_fieldStatus Field
-
struct
nvme_sanitize_start_event Sanitize Start Event Data
Definition
struct nvme_sanitize_start_event {
__le32 sani_cap;
__le32 sani_cdw10;
__le32 sani_cdw11;
};
Members
sani_capSANICAP
sani_cdw10Sanitize CDW10
sani_cdw11Sanitize CDW11
-
struct
nvme_sanitize_compln_event Sanitize Completion Event Data
Definition
struct nvme_sanitize_compln_event {
__le16 sani_prog;
__le16 sani_status;
__le16 cmpln_info;
__u8 rsvd6[2];
};
Members
sani_progSanitize Progress
sani_statusSanitize Status
cmpln_infoCompletion Information
rsvd6Reserved
-
struct
nvme_set_feature_event Set Feature Event Data
Definition
struct nvme_set_feature_event {
__le32 layout;
__le32 cdw_mem[0];
};
Members
layoutSet Feature Event Layout
cdw_memCommand Dwords Memory buffer
-
struct
nvme_thermal_exc_event Thermal Excursion Event Data
Definition
struct nvme_thermal_exc_event {
__u8 over_temp;
__u8 threshold;
};
Members
over_tempOver Temperature
thresholdtemperature threshold
-
struct
nvme_lba_rd LBA Range Descriptor
Definition
struct nvme_lba_rd {
__le64 rslba;
__le32 rnlb;
__u8 rsvd12[4];
};
Members
rslbaRange Starting LBA
rnlbRange Number of Logical Blocks
rsvd12Reserved
-
struct
nvme_lbas_ns_element LBA Status Log Namespace Element
Definition
struct nvme_lbas_ns_element {
__le32 neid;
__le32 nlrd;
__u8 ratype;
__u8 rsvd8[7];
struct nvme_lba_rd lba_rd[];
};
Members
neidNamespace Element Identifier
nlrdNumber of LBA Range Descriptors
ratypeRecommended Action Type. see enum nvme_lba_status_atype
rsvd8Reserved
lba_rdLBA Range Descriptor
-
enum
nvme_lba_status_atype Potentially Unrecoverable LBAs
Constants
NVME_LBA_STATUS_ATYPE_SCAN_UNTRACKEDPotentially Unrecoverable LBAs
NVME_LBA_STATUS_ATYPE_SCAN_TRACKEDPotentially Unrecoverable LBAs associated with physical storage
-
struct
nvme_lba_status_log LBA Status Information Log
Definition
struct nvme_lba_status_log {
__le32 lslplen;
__le32 nlslne;
__le32 estulb;
__u8 rsvd12[2];
__le16 lsgc;
struct nvme_lbas_ns_element elements[];
};
Members
lslplenLBA Status Log Page Length
nlslneNumber of LBA Status Log Namespace Elements
estulbEstimate of Unrecoverable Logical Blocks
rsvd12Reserved
lsgcLBA Status Generation Counter
elementsLBA Status Log Namespace Element List
-
struct
nvme_eg_event_aggregate_log Endurance Group Event Aggregate
Definition
struct nvme_eg_event_aggregate_log {
__le64 nr_entries;
__le16 egids[];
};
Members
nr_entriesNumber of Entries
egidsEndurance Group Identifier
-
enum
nvme_fid_supported_effects FID Supported and Effects Data Structure definitions
Constants
NVME_FID_SUPPORTED_EFFECTS_FSUPPFID Supported
NVME_FID_SUPPORTED_EFFECTS_UDCCUser Data Content Change
NVME_FID_SUPPORTED_EFFECTS_NCCNamespace Capability Change
NVME_FID_SUPPORTED_EFFECTS_NICNamespace Inventory Change
NVME_FID_SUPPORTED_EFFECTS_CCCController Capability Change
NVME_FID_SUPPORTED_EFFECTS_UUID_SELUUID Selection Supported
NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFTFID Scope Shift
NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASKFID Scope Mask
NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSNamespace Scope
NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRLController Scope
NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SETNVM Set Scope
NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRPEndurance Group Scope
NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAINDomain Scope
NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSSNVM Subsystem Scope
-
struct
nvme_fid_supported_effects_log Feature Identifiers Supported and Effects
Definition
struct nvme_fid_supported_effects_log {
__le32 fid_support[NVME_LOG_FID_SUPPORTED_EFFECTS_MAX];
};
Members
fid_supportFeature Identifier Supported
-
enum
nvme_mi_cmd_supported_effects MI Command Supported and Effects Data Structure
Constants
NVME_MI_CMD_SUPPORTED_EFFECTS_CSUPPCommand Supported
NVME_MI_CMD_SUPPORTED_EFFECTS_UDCCUser Data Content Change
NVME_MI_CMD_SUPPORTED_EFFECTS_NCCNamespace Capability Change
NVME_MI_CMD_SUPPORTED_EFFECTS_NICNamespace Inventory Change
NVME_MI_CMD_SUPPORTED_EFFECTS_CCCController Capability Change
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_SHIFT20 bit shift
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_MASK12 bit mask - 0xfff
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSNamespace Scope
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_CTRLController Scope
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NVM_SETNVM Set Scope
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_ENDGRPEndurance Group Scope
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_DOMAINDomain Scope
NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSSNVM Subsystem Scope
-
struct
nvme_mi_cmd_supported_effects_log NVMe-MI Commands Supported and Effects Log
Definition
struct nvme_mi_cmd_supported_effects_log {
__le32 mi_cmd_support[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX];
__le32 reserved1[NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_RESERVED];
};
Members
mi_cmd_supportNVMe-MI Commands Supported
reserved1Reserved
-
struct
nvme_boot_partition Boot Partition Log
Definition
struct nvme_boot_partition {
__u8 lid;
__u8 rsvd1[3];
__le32 bpinfo;
__u8 rsvd8[8];
__u8 boot_partition_data[];
};
Members
lidBoot Partition Identifier
rsvd1Reserved
bpinfoBoot Partition Information
rsvd8Reserved
boot_partition_dataContains the contents of the specified Boot Partition
-
struct
nvme_eom_lane_desc EOM Lane Descriptor
Definition
struct nvme_eom_lane_desc {
__u8 rsvd0;
__u8 mstatus;
__u8 lane;
__u8 eye;
__le16 top;
__le16 bottom;
__le16 left;
__le16 right;
__le16 nrows;
__le16 ncols;
__le16 edlen;
__u8 rsvd18[14];
__u8 eye_desc[];
};
Members
rsvd0Reserved
mstatusMeasurement Status
laneLane number
eyeEye number
topAbsolute number of rows from center to top edge of eye
bottomAbsolute number of rows from center to bottom edge of eye
leftAbsolute number of rows from center to left edge of eye
rightAbsolute number of rows from center to right edge of eye
nrowsNumber of Rows
ncolsNumber of Columns
edlenEye Data Length
rsvd18Reserved
eye_descPrintable Eye, Eye Data, and any Padding
-
struct
nvme_phy_rx_eom_log Physical Interface Receiver Eye Opening Measurement Log
Definition
struct nvme_phy_rx_eom_log {
__u8 lid;
__u8 eomip;
__le16 hsize;
__le32 rsize;
__u8 eomdgn;
__u8 lr;
__u8 odp;
__u8 lanes;
__u8 epl;
__u8 lspfc;
__u8 li;
__u8 rsvd15[3];
__le16 lsic;
__le32 dsize;
__le16 nd;
__le16 maxtb;
__le16 maxlr;
__le16 etgood;
__le16 etbetter;
__le16 etbest;
__u8 rsvd36[28];
struct nvme_eom_lane_desc descs[];
};
Members
lidLog Identifier
eomipEOM In Progress
hsizeHeader Size
rsizeResult Size
eomdgnEOM Data Generation Number
lrLog Revision
odpOptional Data Present
lanesNumber of lanes configured for this port
eplEyes Per Lane
lspfcLog Specific Parameter Field Copy
liLink Information
rsvd15Reserved
lsicLog Specific Identifier Copy
dsizeDescriptor Size
ndNumber of Descriptors
maxtbMaximum Top Bottom
maxlrMaximum Left Right
etgoodEstimated Time for Good Quality
etbetterEstimated Time for Better Quality
etbestEstimated Time for Best Quality
rsvd36Reserved
descsEOM Lane Descriptors
-
enum
nvme_eom_optional_data EOM Optional Data Present Fields
Constants
NVME_EOM_EYE_DATA_PRESENTEye Data Present
NVME_EOM_PRINTABLE_EYE_PRESENTPrintable Eye Present
-
enum
nvme_phy_rx_eom_progress EOM In Progress Values
Constants
NVME_PHY_RX_EOM_NOT_STARTEDEOM Not Started
NVME_PHY_RX_EOM_IN_PROGRESSEOM In Progress
NVME_PHY_RX_EOM_COMPLETEDEOM Completed
-
struct
nvme_media_unit_stat_desc Media Unit Status Descriptor
Definition
struct nvme_media_unit_stat_desc {
__le16 muid;
__le16 domainid;
__le16 endgid;
__le16 nvmsetid;
__le16 cap_adj_fctr;
__u8 avl_spare;
__u8 percent_used;
__u8 mucs;
__u8 cio;
};
Members
muidMedia Unit Identifier
domainidDomain Identifier
endgidEndurance Group Identifier
nvmsetidNVM Set Identifier
cap_adj_fctrCapacity Adjustment Factor
avl_spareAvailable Spare
percent_usedPercentage Used
mucsNumber of Channels attached to media units
cioChannel Identifiers Offset
-
struct
nvme_media_unit_stat_log Media Unit Status
Definition
struct nvme_media_unit_stat_log {
__le16 nmu;
__le16 cchans;
__le16 sel_config;
__u8 rsvd6[10];
struct nvme_media_unit_stat_desc mus_desc[];
};
Members
nmuNumber unit status descriptor
cchansNumber of Channels
sel_configSelected Configuration
rsvd6Reserved
mus_descMedia unit statistic descriptors
-
struct
nvme_media_unit_config_desc Media Unit Configuration Descriptor
Definition
struct nvme_media_unit_config_desc {
__le16 muid;
__u8 rsvd2[4];
__le16 mudl;
};
Members
muidMedia Unit Identifier
rsvd2Reserved
mudlMedia Unit Descriptor Length
-
struct
nvme_channel_config_desc Channel Configuration Descriptor
Definition
struct nvme_channel_config_desc {
__le16 chanid;
__le16 chmus;
struct nvme_media_unit_config_desc mu_config_desc[];
};
Members
chanidChannel Identifier
chmusNumber Channel Media Units
mu_config_descChannel Unit config descriptors. See struct nvme_media_unit_config_desc
-
struct
nvme_end_grp_chan_desc Endurance Group Channel Configuration Descriptor
Definition
struct nvme_end_grp_chan_desc {
__le16 egchans;
struct nvme_channel_config_desc chan_config_desc[];
};
Members
egchansNumber of Channels
chan_config_descChannel config descriptors. See struct nvme_channel_config_desc
-
struct
nvme_end_grp_config_desc Endurance Group Configuration Descriptor
Definition
struct nvme_end_grp_config_desc {
__le16 endgid;
__le16 cap_adj_factor;
__u8 rsvd4[12];
__u8 tegcap[16];
__u8 segcap[16];
__u8 end_est[16];
__u8 rsvd64[16];
__le16 egsets;
__le16 nvmsetid[];
};
Members
endgidEndurance Group Identifier
cap_adj_factorCapacity Adjustment Factor
rsvd4Reserved
tegcapTotal Endurance Group Capacity
segcapSpare Endurance Group Capacity
end_estEndurance Estimate
rsvd64Reserved
egsetsNumber of NVM Sets
nvmsetidNVM Set Identifier
-
struct
nvme_capacity_config_desc Capacity Configuration structure definitions
Definition
struct nvme_capacity_config_desc {
__le16 cap_config_id;
__le16 domainid;
__le16 egcn;
__u8 rsvd6[26];
struct nvme_end_grp_config_desc egcd[];
};
Members
cap_config_idCapacity Configuration Identifier
domainidDomain Identifier
egcnNumber Endurance Group Configuration Descriptors
rsvd6Reserved
egcdEndurance Group Config descriptors. See struct nvme_end_grp_config_desc
-
struct
nvme_supported_cap_config_list_log Supported Capacity Configuration list log page
Definition
struct nvme_supported_cap_config_list_log {
__u8 sccn;
__u8 rsvd1[15];
struct nvme_capacity_config_desc cap_config_desc[];
};
Members
sccnNumber of capacity configuration
rsvd1Reserved
cap_config_descCapacity configuration descriptor. See struct nvme_capacity_config_desc
-
struct
nvme_resv_notification_log Reservation Notification Log
Definition
struct nvme_resv_notification_log {
__le64 lpc;
__u8 rnlpt;
__u8 nalp;
__u8 rsvd9[2];
__le32 nsid;
__u8 rsvd16[48];
};
Members
lpcLog Page Count
rnlptnalpNumber of Available Log Pages
rsvd9Reserved
nsidNamespace ID
rsvd16Reserved
-
enum
nvme_resv_notify_rnlpt Reservation Notification Log - Reservation Notification Log Page Type
Constants
NVME_RESV_NOTIFY_RNLPT_EMPTYEmpty Log Page
NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTEDRegistration Preempted
NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASEDReservation Released
NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTEDReservation Preempted
-
struct
nvme_sanitize_log_page Sanitize Status (Log Identifier 81h)
Definition
struct nvme_sanitize_log_page {
__le16 sprog;
__le16 sstat;
__le32 scdw10;
__le32 eto;
__le32 etbe;
__le32 etce;
__le32 etond;
__le32 etbend;
__le32 etcend;
__u8 rsvd32[480];
};
Members
sprogSanitize Progress (SPROG): indicates the fraction complete of the sanitize operation. The value is a numerator of the fraction complete that has 65,536 (10000h) as its denominator. This value shall be set to FFFFh if the sstat field is not set to
NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS.sstatSanitize Status (SSTAT): indicates the status associated with the most recent sanitize operation. See
enum nvme_sanitize_sstat.scdw10Sanitize Command Dword 10 Information (SCDW10): contains the value of the Command Dword 10 field of the Sanitize command that started the sanitize operation.
etoEstimated Time For Overwrite: indicates the number of seconds required to complete an Overwrite sanitize operation with 16 passes in the background when the No-Deallocate Modifies Media After Sanitize field is not set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
etbeEstimated Time For Block Erase: indicates the number of seconds required to complete a Block Erase sanitize operation in the background when the No-Deallocate Modifies Media After Sanitize field is not set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
etceEstimated Time For Crypto Erase: indicates the number of seconds required to complete a Crypto Erase sanitize operation in the background when the No-Deallocate Modifies Media After Sanitize field is not set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
etondEstimated Time For Overwrite With No-Deallocate Media Modification: indicates the number of seconds required to complete an Overwrite sanitize operation and the associated additional media modification after the Overwrite sanitize operation in the background when the No-Deallocate After Sanitize bit was set to 1 in the Sanitize command that requested the Overwrite sanitize operation; and the No-Deallocate Modifies Media After Sanitize field is set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
etbendEstimated Time For Block Erase With No-Deallocate Media Modification: indicates the number of seconds required to complete a Block Erase sanitize operation and the associated additional media modification after the Block Erase sanitize operation in the background when the No-Deallocate After Sanitize bit was set to 1 in the Sanitize command that requested the Overwrite sanitize operation; and the No-Deallocate Modifies Media After Sanitize field is set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
etcendEstimated Time For Crypto Erase With No-Deallocate Media Modification: indicates the number of seconds required to complete a Crypto Erase sanitize operation and the associated additional media modification after the Crypto Erase sanitize operation in the background when the No-Deallocate After Sanitize bit was set to 1 in the Sanitize command that requested the Overwrite sanitize operation; and the No-Deallocate Modifies Media After Sanitize field is set to 10b. A value of 0h indicates that the sanitize operation is expected to be completed in the background when the Sanitize command that started that operation is completed. A value of FFFFFFFFh indicates that no time period is reported.
rsvd32Reserved
-
enum
nvme_sanitize_sstat Sanitize Status (SSTAT)
Constants
NVME_SANITIZE_SSTAT_STATUS_SHIFTShift amount to get the status value of the most recent sanitize operation from the
struct nvme_sanitize_log_page.sstat field.NVME_SANITIZE_SSTAT_STATUS_MASKMask to get the status value of the most recent sanitize operation.
NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZEDThe NVM subsystem has never been sanitized.
NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESSThe most recent sanitize operation completed successfully including any additional media modification.
NVME_SANITIZE_SSTAT_STATUS_IN_PROGESSA sanitize operation is currently in progress.
NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILEDThe most recent sanitize operation failed.
NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESSThe most recent sanitize operation for which No-Deallocate After Sanitize was requested has completed successfully with deallocation of all user data.
NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFTShift amount to get the number of completed passes if the most recent sanitize operation was an Overwrite. This value shall be cleared to 0h if the most recent sanitize operation was not an Overwrite.
NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASKMask to get the number of completed passes.
NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFTShift amount to get the Global Data Erased value from the
struct nvme_sanitize_log_page.sstat field.NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASKMask to get the Global Data Erased value.
NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASEDGlobal Data Erased: if set, then no namespace user data in the NVM subsystem has been written to and no Persistent Memory Region in the NVM subsystem has been enabled since being manufactured and the NVM subsystem has never been sanitized; or since the most recent successful sanitize operation.
-
struct
nvme_zns_changed_zone_log ZNS Changed Zone List log
Definition
struct nvme_zns_changed_zone_log {
__le16 nrzid;
__u8 rsvd2[6];
__le64 zid[NVME_ZNS_CHANGED_ZONES_MAX];
};
Members
nrzidNumber of Zone Identifiers
rsvd2Reserved
zidZone Identifier
-
enum
nvme_zns_zt Zone Descriptor Data Structure - Zone Type
Constants
NVME_ZONE_TYPE_SEQWRITE_REQSequential Write Required
-
enum
nvme_zns_za Zone Descriptor Data Structure
Constants
NVME_ZNS_ZA_ZFCZone Finished by Controller
NVME_ZNS_ZA_FZRFinish Zone Recommended
NVME_ZNS_ZA_RZRReset Zone Recommended
NVME_ZNS_ZA_ZRWAV
NVME_ZNS_ZA_ZDEVZone Descriptor Extension Valid
-
enum
nvme_zns_zs Zone Descriptor Data Structure - Zone State
Constants
NVME_ZNS_ZS_EMPTYEmpty state
NVME_ZNS_ZS_IMPL_OPENImplicitly open state
NVME_ZNS_ZS_EXPL_OPENExplicitly open state
NVME_ZNS_ZS_CLOSEDClosed state
NVME_ZNS_ZS_READ_ONLYRead only state
NVME_ZNS_ZS_FULLFull state
NVME_ZNS_ZS_OFFLINEOffline state
-
struct
nvme_zns_desc Zone Descriptor Data Structure
Definition
struct nvme_zns_desc {
__u8 zt;
__u8 zs;
__u8 za;
__u8 zai;
__u8 rsvd4[4];
__le64 zcap;
__le64 zslba;
__le64 wp;
__u8 rsvd32[32];
};
Members
ztZone Type
zsZone State
zaZone Attributes
zaiZone Attributes Information
rsvd4Reserved
zcapZone Capacity
zslbaZone Start Logical Block Address
wpWrite Pointer
rsvd32Reserved
-
struct
nvme_zone_report Report Zones Data Structure
Definition
struct nvme_zone_report {
__le64 nr_zones;
__u8 rsvd8[56];
struct nvme_zns_desc entries[];
};
Members
nr_zonesNumber of descriptors in entries
rsvd8Reserved
entriesZoned namespace descriptors
-
enum
nvme_fdp_ruh_type Reclaim Unit Handle Type
Constants
NVME_FDP_RUHT_INITIALLY_ISOLATEDInitially Isolated
NVME_FDP_RUHT_PERSISTENTLY_ISOLATEDPersistently Isolated
-
struct
nvme_fdp_ruh_desc Reclaim Unit Handle Descriptor
Definition
struct nvme_fdp_ruh_desc {
__u8 ruht;
__u8 rsvd1[3];
};
Members
ruhtReclaim Unit Handle Type
rsvd1Reserved
-
enum
nvme_fdp_config_fdpa FDP Attributes
Constants
NVME_FDP_CONFIG_FDPA_RGIF_SHIFTReclaim Group Identifier Format Shift
NVME_FDP_CONFIG_FDPA_RGIF_MASKReclaim Group Identifier Format Mask
NVME_FDP_CONFIG_FDPA_FDPVWC_SHIFTFDP Volatile Write Cache Shift
NVME_FDP_CONFIG_FDPA_FDPVWC_MASKFDP Volatile Write Cache Mask
NVME_FDP_CONFIG_FDPA_VALID_SHIFTFDP Configuration Valid Shift
NVME_FDP_CONFIG_FDPA_VALID_MASKFDP Configuration Valid Mask
-
struct
nvme_fdp_config_desc FDP Configuration Descriptor
Definition
struct nvme_fdp_config_desc {
__le16 size;
__u8 fdpa;
__u8 vss;
__le32 nrg;
__le16 nruh;
__le16 maxpids;
__le32 nnss;
__le64 runs;
__le32 erutl;
__u8 rsvd28[36];
struct nvme_fdp_ruh_desc ruhs[];
};
Members
sizeDescriptor size
fdpaFDP Attributes (
enum nvme_fdp_config_fdpa)vssVendor Specific Size
nrgNumber of Reclaim Groups
nruhNumber of Reclaim Unit Handles
maxpidsMax Placement Identifiers
nnssNumber of Namespaces Supported
runsReclaim Unit Nominal Size
erutlEstimated Reclaim Unit Time Limit
rsvd28Reserved
ruhsReclaim Unit Handle descriptors (
struct nvme_fdp_ruh_desc)
-
struct
nvme_fdp_config_log FDP Configurations Log Page
Definition
struct nvme_fdp_config_log {
__le16 n;
__u8 version;
__u8 rsvd3;
__le32 size;
__u8 rsvd8[8];
struct nvme_fdp_config_desc configs[];
};
Members
nNumber of FDP Configurations
versionLog page version
rsvd3Reserved
sizeLog page size in bytes
rsvd8Reserved
configsFDP Configuration descriptors (
struct nvme_fdp_config_desc)
-
enum
nvme_fdp_ruha Reclaim Unit Handle Attributes
Constants
NVME_FDP_RUHA_HOST_SHIFTHost Specified Reclaim Unit Handle Shift
NVME_FDP_RUHA_HOST_MASKHost Specified Reclaim Unit Handle Mask
NVME_FDP_RUHA_CTRL_SHIFTController Specified Reclaim Unit Handle Shift
NVME_FDP_RUHA_CTRL_MASKController Specified Reclaim Unit Handle Mask
-
struct
nvme_fdp_ruhu_desc Reclaim Unit Handle Usage Descriptor
Definition
struct nvme_fdp_ruhu_desc {
__u8 ruha;
__u8 rsvd1[7];
};
Members
ruhaReclaim Unit Handle Attributes (
enum nvme_fdp_ruha)rsvd1Reserved
-
struct
nvme_fdp_ruhu_log Reclaim Unit Handle Usage Log Page
Definition
struct nvme_fdp_ruhu_log {
__le16 nruh;
__u8 rsvd2[6];
struct nvme_fdp_ruhu_desc ruhus[];
};
Members
nruhNumber of Reclaim Unit Handles
rsvd2Reserved
ruhusReclaim Unit Handle Usage descriptors
-
struct
nvme_fdp_stats_log FDP Statistics Log Page
Definition
struct nvme_fdp_stats_log {
__u8 hbmw[16];
__u8 mbmw[16];
__u8 mbe[16];
__u8 rsvd48[16];
};
Members
hbmwHost Bytes with Metadata Written
mbmwMedia Bytes with Metadata Written
mbeMedia Bytes Erased
rsvd48Reserved
-
enum
nvme_fdp_event_type FDP Event Types
Constants
NVME_FDP_EVENT_RUNFWReclaim Unit Not Fully Written
NVME_FDP_EVENT_RUTLEReclaim Unit Time Limit Exceeded
NVME_FDP_EVENT_RESETController Level Reset Modified Reclaim Unit Handles
NVME_FDP_EVENT_PIDInvalid Placement Identifier
NVME_FDP_EVENT_REALLOCMedia Reallocated
NVME_FDP_EVENT_MODIFYImplicitly Modified Reclaim Unit Handle
-
enum
nvme_fdp_event_realloc_flags Media Reallocated Event Type Specific Flags
Constants
NVME_FDP_EVENT_REALLOC_F_LBAVLBA Valid
-
struct
nvme_fdp_event_realloc Media Reallocated Event Type Specific Information
Definition
struct nvme_fdp_event_realloc {
__u8 flags;
__u8 rsvd1;
__le16 nlbam;
__le64 lba;
__u8 rsvd12[4];
};
Members
flagsEvent Type Specific flags (
enum nvme_fdp_event_realloc_flags)rsvd1Reserved
nlbamNumber of LBAs Moved
lbaLogical Block Address
rsvd12Reserved
-
enum
nvme_fdp_event_flags FDP Event Flags
Constants
NVME_FDP_EVENT_F_PIVPlacement Identifier Valid
NVME_FDP_EVENT_F_NSIDVNamespace Identifier Valid
NVME_FDP_EVENT_F_LVLocation Valid
-
struct
nvme_fdp_event FDP Event
Definition
struct nvme_fdp_event {
__u8 type;
__u8 flags;
__le16 pid;
struct nvme_timestamp ts;
__le32 nsid;
__u8 type_specific[16];
__le16 rgid;
__u8 ruhid;
__u8 rsvd35[5];
__u8 vs[24];
};
Members
typeEvent Type (
enum nvme_fdp_event_type)flagsEvent Flags (
enum nvme_fdp_event_flags)pidPlacement Identifier
tsTimestamp
nsidNamespace Identifier
type_specificEvent Type Specific Information
rgidReclaim Group Identifier
ruhidReclaim Unit Handle Identifier
rsvd35Reserved
vsVendor Specific
-
struct
nvme_fdp_events_log FDP Events Log Page
Definition
struct nvme_fdp_events_log {
__le32 n;
__u8 rsvd4[60];
struct nvme_fdp_event events[63];
};
Members
nNumber of FDP Events
rsvd4Reserved
eventsFDP Events (
struct nvme_fdp_event)
-
struct
nvme_feat_fdp_events_cdw11 FDP Events Feature Command Dword 11
Definition
struct nvme_feat_fdp_events_cdw11 {
__le16 phndl;
__u8 noet;
__u8 rsvd24;
};
Members
phndlPlacement Handle
noetNumber of FDP Event Types
rsvd24Reserved
-
enum
nvme_fdp_supported_event_attributes Supported FDP Event Attributes
Constants
NVME_FDP_SUPP_EVENT_ENABLED_SHIFTFDP Event Enable Shift
NVME_FDP_SUPP_EVENT_ENABLED_MASKFDP Event Enable Mask
-
struct
nvme_fdp_supported_event_desc Supported FDP Event Descriptor
Definition
struct nvme_fdp_supported_event_desc {
__u8 evt;
__u8 evta;
};
Members
evtFDP Event Type
evtaFDP Event Type Attributes (
enum nvme_fdp_supported_event_attributes)
-
struct
nvme_fdp_ruh_status_desc Reclaim Unit Handle Status Descriptor
Definition
struct nvme_fdp_ruh_status_desc {
__le16 pid;
__le16 ruhid;
__le32 earutr;
__le64 ruamw;
__u8 rsvd16[16];
};
Members
pidPlacement Identifier
ruhidReclaim Unit Handle Identifier
earutrEstimated Active Reclaim Unit Time Remaining
ruamwReclaim Unit Available Media Writes
rsvd16Reserved
-
struct
nvme_fdp_ruh_status Reclaim Unit Handle Status
Definition
struct nvme_fdp_ruh_status {
__u8 rsvd0[14];
__le16 nruhsd;
struct nvme_fdp_ruh_status_desc ruhss[];
};
Members
rsvd0Reserved
nruhsdNumber of Reclaim Unit Handle Status Descriptors
ruhssReclaim Unit Handle Status descriptors
-
struct
nvme_lba_status_desc LBA Status Descriptor Entry
Definition
struct nvme_lba_status_desc {
__le64 dslba;
__le32 nlb;
__u8 rsvd12;
__u8 status;
__u8 rsvd14[2];
};
Members
dslbaDescriptor Starting LBA
nlbNumber of Logical Blocks
rsvd12Reserved
statusAdditional status about this LBA range
rsvd14Reserved
-
struct
nvme_lba_status LBA Status Descriptor List
Definition
struct nvme_lba_status {
__le32 nlsd;
__u8 cmpc;
__u8 rsvd5[3];
struct nvme_lba_status_desc descs[];
};
Members
nlsdNumber of LBA Status Descriptors
cmpcCompletion Condition
rsvd5Reserved
descsLBA status descriptor Entry
-
struct
nvme_feat_auto_pst Autonomous Power State Transition
Definition
struct nvme_feat_auto_pst {
__le64 apst_entry[32];
};
Members
apst_entry
-
enum
nvme_apst_entry Autonomous Power State Transition
Constants
NVME_APST_ENTRY_ITPS_SHIFTIdle Transition Power State Shift
NVME_APST_ENTRY_ITPT_SHIFTIdle Time Prior to Transition Shift
NVME_APST_ENTRY_ITPS_MASKIdle Transition Power State Mask
NVME_APST_ENTRY_ITPT_MASKIdle Time Prior to Transition Mask
-
struct
nvme_metadata_element_desc Metadata Element Descriptor
Definition
struct nvme_metadata_element_desc {
__u8 type;
__u8 rev;
__le16 len;
__u8 val[0];
};
Members
typeElement Type (ET)
revElement Revision (ER)
lenElement Length (ELEN)
valElement Value (EVAL), UTF-8 string
-
struct
nvme_host_metadata Host Metadata Data Structure
Definition
struct nvme_host_metadata {
__u8 ndesc;
__u8 rsvd1;
union {
struct nvme_metadata_element_desc descs[0];
__u8 descs_buf[4094];
};
};
Members
ndescNumber of metadata element descriptors
rsvd1Reserved
{unnamed_union}anonymous
descsMetadata element descriptors
descs_bufMetadata element descriptor buffer
-
enum
nvme_ctrl_metadata_type Controller Metadata Element Types
Constants
NVME_CTRL_METADATA_OS_CTRL_NAMEName of the controller in the operating system.
NVME_CTRL_METADATA_OS_DRIVER_NAMEName of the driver in the operating system.
NVME_CTRL_METADATA_OS_DRIVER_VERVersion of the driver in the operating system.
NVME_CTRL_METADATA_PRE_BOOT_CTRL_NAMEName of the controller in the pre-boot environment.
NVME_CTRL_METADATA_PRE_BOOT_DRIVER_NAMEName of the driver in the pre-boot environment.
NVME_CTRL_METADATA_PRE_BOOT_DRIVER_VERVersion of the driver in the pre-boot environment.
NVME_CTRL_METADATA_SYS_PROC_MODELModel of the processor.
NVME_CTRL_METADATA_CHIPSET_DRV_NAMEChipset driver name.
NVME_CTRL_METADATA_CHIPSET_DRV_VERSIONChipset driver version.
NVME_CTRL_METADATA_OS_NAME_AND_BUILDOperating system name and build.
NVME_CTRL_METADATA_SYS_PROD_NAMESystem product name.
NVME_CTRL_METADATA_FIRMWARE_VERSIONHost firmware (e.g UEFI) version.
NVME_CTRL_METADATA_OS_DRIVER_FILENAMEOperating system driver filename.
NVME_CTRL_METADATA_DISPLAY_DRV_NAMEDisplay driver name.
NVME_CTRL_METADATA_DISPLAY_DRV_VERSIONDisplay driver version.
NVME_CTRL_METADATA_HOST_DET_FAIL_RECFailure record.
-
enum
nvme_ns_metadata_type Namespace Metadata Element Types
Constants
NVME_NS_METADATA_OS_NS_NAMEName of the namespace in the operating system
NVME_NS_METADATA_PRE_BOOT_NS_NAMEName of the namespace in the pre-boot environment.
NVME_NS_METADATA_OS_NS_QUAL_1First qualifier of the Operating System Namespace Name.
NVME_NS_METADATA_OS_NS_QUAL_2Second qualifier of the Operating System Namespace Name.
-
struct
nvme_lba_range_type_entry LBA Range Type - Data Structure Entry
Definition
struct nvme_lba_range_type_entry {
__u8 type;
__u8 attributes;
__u8 rsvd2[14];
__le64 slba;
__le64 nlb;
__u8 guid[16];
__u8 rsvd48[16];
};
Members
typeSpecifies the Type of the LBA range
attributesSpecifies attributes of the LBA range
rsvd2Reserved
slbaStarting LBA
nlbNumber of Logical Blocks
guidUnique Identifier
rsvd48Reserved
-
enum
nvme_lbart LBA Range Type - Data Structure Entry
Constants
NVME_LBART_TYPE_GPGeneral Purpose
NVME_LBART_TYPE_FSFilesystem
NVME_LBART_TYPE_RAIDRAID
NVME_LBART_TYPE_CACHECache
NVME_LBART_TYPE_SWAPPage / swap file
NVME_LBART_ATTRIB_TEMPTemp
NVME_LBART_ATTRIB_HIDEHidden
-
struct
nvme_lba_range_type LBA Range Type
Definition
struct nvme_lba_range_type {
struct nvme_lba_range_type_entry entry[NVME_FEAT_LBA_RANGE_MAX];
};
Members
entryLBA range type entry. See struct nvme_lba_range_type_entry
-
struct
nvme_plm_config Predictable Latency Mode - Deterministic Threshold Configuration Data Structure
Definition
struct nvme_plm_config {
__le16 ee;
__u8 rsvd2[30];
__le64 dtwinrt;
__le64 dtwinwt;
__le64 dtwintt;
__u8 rsvd56[456];
};
Members
eeEnable Event
rsvd2Reserved
dtwinrtDTWIN Reads Threshold
dtwinwtDTWIN Writes Threshold
dtwinttDTWIN Time Threshold
rsvd56Reserved
-
struct
nvme_feat_host_behavior Host Behavior Support - Data Structure
Definition
struct nvme_feat_host_behavior {
__u8 acre;
__u8 rsvd1[511];
};
Members
acreAdvanced Command Retry Enable
rsvd1Reserved
-
enum
nvme_host_behavior_support Enable Advanced Command
Constants
NVME_ENABLE_ACREEnable Advanced Command Retry Enable
-
struct
nvme_dsm_range Dataset Management - Range Definition
Definition
struct nvme_dsm_range {
__le32 cattr;
__le32 nlb;
__le64 slba;
};
Members
cattrContext Attributes
nlbLength in logical blocks
slbaStarting LBA
-
struct
nvme_copy_range Copy - Source Range Entries Descriptor Format
Definition
struct nvme_copy_range {
__u8 rsvd0[8];
__le64 slba;
__le16 nlb;
__u8 rsvd18[6];
__le32 eilbrt;
__le16 elbat;
__le16 elbatm;
};
Members
rsvd0Reserved
slbaStarting LBA
nlbNumber of Logical Blocks
rsvd18Reserved
eilbrtExpected Initial Logical Block Reference Tag / Expected Logical Block Storage Tag
elbatExpected Logical Block Application Tag
elbatmExpected Logical Block Application Tag Mask
-
struct
nvme_copy_range_f1 Copy - Source Range Entries Descriptor Format 1h
Definition
struct nvme_copy_range_f1 {
__u8 rsvd0[8];
__le64 slba;
__le16 nlb;
__u8 rsvd18[8];
__u8 elbt[10];
__le16 elbat;
__le16 elbatm;
};
Members
rsvd0Reserved
slbaStarting LBA
nlbNumber of Logical Blocks
rsvd18Reserved
elbtExpected Initial Logical Block Reference Tag / Expected Logical Block Storage Tag
elbatExpected Logical Block Application Tag
elbatmExpected Logical Block Application Tag Mask
-
struct
nvme_registered_ctrl Registered Controller Data Structure
Definition
struct nvme_registered_ctrl {
__le16 cntlid;
__u8 rcsts;
__u8 rsvd3[5];
__le64 hostid;
__le64 rkey;
};
Members
cntlidController ID
rcstsReservation Status
rsvd3Reserved
hostidHost Identifier
rkeyReservation Key
-
struct
nvme_registered_ctrl_ext Registered Controller Extended Data Structure
Definition
struct nvme_registered_ctrl_ext {
__le16 cntlid;
__u8 rcsts;
__u8 rsvd3[5];
__le64 rkey;
__u8 hostid[16];
__u8 rsvd32[32];
};
Members
cntlidController ID
rcstsReservation Status
rsvd3Reserved
rkeyReservation Key
hostidHost Identifier
rsvd32Reserved
-
struct
nvme_resv_status Reservation Status Data Structure
Definition
struct nvme_resv_status {
__le32 gen;
__u8 rtype;
__u8 regctl[2];
__u8 rsvd7[2];
__u8 ptpls;
__u8 rsvd10[14];
union {
struct {
__u8 rsvd24[40];
struct nvme_registered_ctrl_ext regctl_eds[0];
};
struct nvme_registered_ctrl regctl_ds[0];
};
};
Members
genGeneration
rtypeReservation Type
regctlNumber of Registered Controllers
rsvd7Reserved
ptplsPersist Through Power Loss State
rsvd10Reserved
{unnamed_union}anonymous
{unnamed_struct}anonymous
rsvd24Reserved
regctl_edsRegistered Controller Extended Data Structure
regctl_dsRegistered Controller Data Structure
-
struct
nvme_streams_directive_params Streams Directive - Return Parameters Data Structure
Definition
struct nvme_streams_directive_params {
__le16 msl;
__le16 nssa;
__le16 nsso;
__u8 nssc;
__u8 rsvd[9];
__le32 sws;
__le16 sgs;
__le16 nsa;
__le16 nso;
__u8 rsvd2[6];
};
Members
mslMax Streams Limit
nssaNVM Subsystem Streams Available
nssoNVM Subsystem Streams Open
nsscNVM Subsystem Stream Capability
rsvdReserved
swsStream Write Size
sgsStream Granularity Size
nsaNamespace Streams Allocated
nsoNamespace Streams Open
rsvd2Reserved
-
struct
nvme_streams_directive_status Streams Directive - Get Status Data Structure
Definition
struct nvme_streams_directive_status {
__le16 osc;
__le16 sid[];
};
Members
oscOpen Stream Count
sidStream Identifier
-
struct
nvme_id_directives Identify Directive - Return Parameters Data Structure
Definition
struct nvme_id_directives {
__u8 supported[32];
__u8 enabled[32];
__u8 rsvd64[4032];
};
Members
supportedIdentify directive is supported
enabledIdentify directive is Enabled
rsvd64Reserved
-
enum
nvme_directive_types Directives Supported or Enabled
Constants
NVME_ID_DIR_ID_BITIdentify directive is supported
NVME_ID_DIR_SD_BITStreams directive is supported
NVME_ID_DIR_DP_BITDirect Placement directive is supported
-
struct
nvme_host_mem_buf_attrs Host Memory Buffer - Attributes Data Structure
Definition
struct nvme_host_mem_buf_attrs {
__le32 hsize;
__le32 hmdlal;
__le32 hmdlau;
__le32 hmdlec;
__u8 rsvd16[4080];
};
Members
hsizeHost Memory Buffer Size
hmdlalHost Memory Descriptor List Lower Address
hmdlauHost Memory Descriptor List Upper Address
hmdlecHost Memory Descriptor List Entry Count
rsvd16Reserved
-
enum
nvme_ae_type Asynchronous Event Type
Constants
NVME_AER_ERRORError event
NVME_AER_SMARTSMART / Health Status event
NVME_AER_NOTICENotice event
NVME_AER_CSSNVM Command Set Specific events
NVME_AER_VSVendor Specific event
-
enum
nvme_ae_info_error Asynchronous Event Information - Error Status
Constants
NVME_AER_ERROR_INVALID_DB_REGWrite to Invalid Doorbell Register
NVME_AER_ERROR_INVALID_DB_VALInvalid Doorbell Write Value
NVME_AER_ERROR_DIAG_FAILUREDiagnostic Failure
NVME_AER_ERROR_PERSISTENT_INTERNAL_ERRORPersistent Internal Error
NVME_AER_ERROR_TRANSIENT_INTERNAL_ERRORTransient Internal Error
NVME_AER_ERROR_FW_IMAGE_LOAD_ERRORFirmware Image Load Error
-
enum
nvme_ae_info_smart Asynchronous Event Information - SMART / Health Status
Constants
NVME_AER_SMART_SUBSYSTEM_RELIABILITYNVM subsystem Reliability
NVME_AER_SMART_TEMPERATURE_THRESHOLDTemperature Threshold
NVME_AER_SMART_SPARE_THRESHOLDSpare Below Threshold
-
enum
nvme_ae_info_css_nvm Asynchronous Event Information - I/O Command Specific Status
Constants
NVME_AER_CSS_NVM_RESERVATIONReservation Log Page Available
NVME_AER_CSS_NVM_SANITIZE_COMPLETEDSanitize Operation Completed
NVME_AER_CSS_NVM_UNEXPECTED_SANITIZE_DEALLOCSanitize Operation Completed With Unexpected Deallocation
-
enum
nvme_ae_info_notice Asynchronous Event Information - Notice
Constants
NVME_AER_NOTICE_NS_CHANGEDNamespace Attribute Changed
NVME_AER_NOTICE_FW_ACT_STARTINGFirmware Activation Starting
NVME_AER_NOTICE_TELEMETRYTelemetry Log Changed
NVME_AER_NOTICE_ANAAsymmetric Namespace Access Change
NVME_AER_NOTICE_PL_EVENTPredictable Latency Event Aggregate Log Change
NVME_AER_NOTICE_LBA_STATUS_ALERTLBA Status Information Alert
NVME_AER_NOTICE_EG_EVENTEndurance Group Event Aggregate Log Page Change
NVME_AER_NOTICE_DISC_CHANGEDDiscovery Log Page Change
-
enum
nvme_subsys_type Type of the NVM subsystem.
Constants
NVME_NQN_DISCDiscovery type target subsystem. Describes a referral to another Discovery Service composed of Discovery controllers that provide additional discovery records. Multiple Referral entries may be reported for each Discovery Service (if that Discovery Service has multiple NVM subsystem ports or supports multiple protocols).
NVME_NQN_NVMENVME type target subsystem. Describes an NVM subsystem whose controllers may have attached namespaces (an NVM subsystem that is not composed of Discovery controllers). Multiple NVM Subsystem entries may be reported for each NVM subsystem if that NVM subsystem has multiple NVM subsystem ports.
NVME_NQN_CURRCurrent Discovery type target subsystem. Describes this Discovery subsystem (the Discovery Service that contains the controller processing the Get Log Page command). Multiple Current Discovery Subsystem entries may be reported for this Discovery subsystem if the current Discovery subsystem has multiple NVM subsystem ports.
-
enum
nvmf_disc_eflags Discovery Log Page entry flags.
Constants
NVMF_DISC_EFLAGS_NONEIndicates that none of the DUPRETINFO or EPCSD features are supported.
NVMF_DISC_EFLAGS_DUPRETINFODuplicate Returned Information (DUPRETINFO): Indicates that using the content of this entry to access this Discovery Service returns the same information that is returned by using the content of other entries in this log page that also have this flag set.
NVMF_DISC_EFLAGS_EPCSDExplicit Persistent Connection Support for Discovery (EPCSD): Indicates that Explicit Persistent Connections are supported for the Discovery controller.
NVMF_DISC_EFLAGS_NCCNo CDC Connectivity (NCC): If set to ‘1’, then no DDC that describes this entry is currently connected to the CDC. If cleared to ‘0’, then at least one DDC that describes this entry is currently connected to the CDC. If the Discovery controller returning this log page is not a CDC, then this bit shall be cleared to ‘0’ and should be ignored by the host.
-
union
nvmf_tsas Transport Specific Address Subtype
Definition
union nvmf_tsas {
char common[NVMF_TSAS_SIZE];
struct rdma {
__u8 qptype;
__u8 prtype;
__u8 cms;
__u8 rsvd3[5];
__le16 pkey;
__u8 rsvd10[246];
} rdma;
struct tcp {
__u8 sectype;
} tcp;
};
Members
commonCommon transport specific attributes
rdmaRDMA transport specific attribute settings
tcpTCP transport specific attribute settings
-
struct
nvmf_disc_log_entry Discovery Log Page entry
Definition
struct nvmf_disc_log_entry {
__u8 trtype;
__u8 adrfam;
__u8 subtype;
__u8 treq;
__le16 portid;
__le16 cntlid;
__le16 asqsz;
__le16 eflags;
__u8 rsvd12[20];
char trsvcid[NVMF_TRSVCID_SIZE];
__u8 rsvd64[192];
char subnqn[NVME_NQN_LENGTH];
char traddr[NVMF_TRADDR_SIZE];
union nvmf_tsas tsas;
};
Members
trtypeTransport Type (TRTYPE): Specifies the NVMe Transport type. See
enum nvmf_trtype.adrfamAddress Family (ADRFAM): Specifies the address family. See
enum nvmf_addr_family.subtypeSubsystem Type (SUBTYPE): Specifies the type of the NVM subsystem that is indicated in this entry. See
enum nvme_subsys_type.treqTransport Requirements (TREQ): Indicates requirements for the NVMe Transport. See
enum nvmf_treq.portidPort ID (PORTID): Specifies a particular NVM subsystem port. Different NVMe Transports or address families may utilize the same Port ID value (e.g. a Port ID may support both iWARP and RoCE).
cntlidController ID (CNTLID): Specifies the controller ID. If the NVM subsystem uses a dynamic controller model, then this field shall be set to FFFFh. If the NVM subsystem uses a static controller model, then this field may be set to a specific controller ID (values 0h to FFEFh are valid). If the NVM subsystem uses a static controller model and the value indicated is FFFEh, then the host should remember the Controller ID returned as part of the Fabrics Connect command in order to re-establish an association in the future with the same controller.
asqszAdmin Max SQ Size (ASQSZ): Specifies the maximum size of an Admin Submission Queue. This applies to all controllers in the NVM subsystem. The value shall be a minimum of 32 entries.
eflagsEntry Flags (EFLAGS): Indicates additional information related to the current entry. See
enum nvmf_disc_eflags.rsvd12Reserved
trsvcidTransport Service Identifier (TRSVCID): Specifies the NVMe Transport service identifier as an ASCII string. The NVMe Transport service identifier is specified by the associated NVMe Transport binding specification.
rsvd64Reserved
subnqnNVM Subsystem Qualified Name (SUBNQN): NVMe Qualified Name (NQN) that uniquely identifies the NVM subsystem. For a subsystem, if that Discovery subsystem has a unique NQN (i.e., the NVM Subsystem NVMe Qualified Name (SUBNQN) field in that Discovery subsystem’s Identify Controller data structure contains a unique NQN value), then the value returned shall be that unique NQN. If the Discovery subsystem does not have a unique NQN, then the value returned shall be the well-known Discovery Service NQN (nqn.2014-08.org.nvmexpress.discovery).
traddrTransport Address (TRADDR): Specifies the address of the NVM subsystem that may be used for a Connect command as an ASCII string. The Address Family field describes the reference for parsing this field.
tsasTransport specific attribute settings
-
enum
nvmf_trtype Transport Type codes for Discovery Log Page entry TRTYPE field
Constants
NVMF_TRTYPE_UNSPECIFIEDNot indicated
NVMF_TRTYPE_RDMARDMA
NVMF_TRTYPE_FCFibre Channel
NVMF_TRTYPE_TCPTCP
NVMF_TRTYPE_LOOPIntra-host Transport (i.e., loopback), reserved for host usage.
NVMF_TRTYPE_MAXMaximum value for
enum nvmf_trtype
-
enum
nvmf_addr_family Address Family codes for Discovery Log Page entry ADRFAM field
Constants
NVMF_ADDR_FAMILY_PCIPCIe
NVMF_ADDR_FAMILY_IP4AF_INET: IPv4 address family.
NVMF_ADDR_FAMILY_IP6AF_INET6: IPv6 address family.
NVMF_ADDR_FAMILY_IBAF_IB: InfiniBand address family.
NVMF_ADDR_FAMILY_FCFibre Channel address family.
NVMF_ADDR_FAMILY_LOOPIntra-host Transport (i.e., loopback), reserved for host usage.
-
enum
nvmf_treq Transport Requirements codes for Discovery Log Page entry TREQ field
Constants
NVMF_TREQ_NOT_SPECIFIEDNot specified
NVMF_TREQ_REQUIREDRequired
NVMF_TREQ_NOT_REQUIREDNot Required
NVMF_TREQ_DISABLE_SQFLOWSQ flow control disable supported
-
enum
nvmf_rdma_qptype RDMA QP Service Type codes for Discovery Log Page entry TSAS RDMA_QPTYPE field
Constants
NVMF_RDMA_QPTYPE_CONNECTEDReliable Connected
NVMF_RDMA_QPTYPE_DATAGRAMReliable Datagram
-
enum
nvmf_rdma_prtype RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field
Constants
NVMF_RDMA_PRTYPE_NOT_SPECIFIEDNo Provider Specified
NVMF_RDMA_PRTYPE_IBInfiniBand
NVMF_RDMA_PRTYPE_ROCEInfiniBand RoCE
NVMF_RDMA_PRTYPE_ROCEV2InfiniBand RoCEV2
NVMF_RDMA_PRTYPE_IWARPiWARP
-
enum
nvmf_rdma_cms RDMA Connection Management Service Type codes for Discovery Log Page entry TSAS RDMA_CMS field
Constants
NVMF_RDMA_CMS_RDMA_CMSockets based endpoint addressing
-
enum
nvmf_tcp_sectype Transport Specific Address Subtype Definition for NVMe/TCP Transport
Constants
NVMF_TCP_SECTYPE_NONENo Security
NVMF_TCP_SECTYPE_TLSTransport Layer Security version 1.2
NVMF_TCP_SECTYPE_TLS13Transport Layer Security version 1.3 or a subsequent version. The TLS protocol negotiates the version and cipher suite for each TCP connection.
-
enum
nvmf_log_discovery_lid_support Discovery log specific support
Constants
NVMF_LOG_DISC_LID_NONENone
NVMF_LOG_DISC_LID_EXTDLPESExtended Discovery Log Page Entries Supported
NVMF_LOG_DISC_LID_PLEOSPort Local Entries Only Supported
NVMF_LOG_DISC_LID_ALLSUBESAll NVM Subsystem Entries Supported
-
enum
nvmf_log_discovery_lsp Discovery log specific field
Constants
NVMF_LOG_DISC_LSP_NONENone
NVMF_LOG_DISC_LSP_EXTDLPEExtended Discovery Log Page Entries
NVMF_LOG_DISC_LSP_PLEOPort Local Entries Only
NVMF_LOG_DISC_LSP_ALLSUBEAll NVM Subsystem Entries
-
struct
nvmf_discovery_log Discovery Log Page (Log Identifier 70h)
Definition
struct nvmf_discovery_log {
__le64 genctr;
__le64 numrec;
__le16 recfmt;
__u8 rsvd14[1006];
struct nvmf_disc_log_entry entries[];
};
Members
genctrGeneration Counter (GENCTR): Indicates the version of the discovery information, starting at a value of 0h. For each change in the Discovery Log Page, this counter is incremented by one. If the value of this field is FFFFFFFF_FFFFFFFFh, then the field shall be cleared to 0h when incremented (i.e., rolls over to 0h).
numrecNumber of Records (NUMREC): Indicates the number of records contained in the log.
recfmtRecord Format (RECFMT): Specifies the format of the Discovery Log Page. If a new format is defined, this value is incremented by one. The format of the record specified in this definition shall be 0h.
rsvd14Reserved
entriesDiscovery Log Page Entries - see
struct nvmf_disc_log_entry.
-
enum
nvmf_dim_tas Discovery Information Management Task
Constants
NVMF_DIM_TAS_REGISTERRegister
NVMF_DIM_TAS_DEREGISTERDeregister
NVMF_DIM_TAS_UPDATEUpdate
-
enum
nvmf_dim_entfmt Discovery Information Management Entry Format
Constants
NVMF_DIM_ENTFMT_BASICBasic discovery information entry
NVMF_DIM_ENTFMT_EXTENDEDExtended discovery information entry
-
enum
nvmf_dim_etype Discovery Information Management Entity Type
Constants
NVMF_DIM_ETYPE_HOSTHost
NVMF_DIM_ETYPE_DDCDirect Discovery controller
NVMF_DIM_ETYPE_CDCCentralized Discovery controller
-
enum
nvmf_exattype Extended Attribute Type
Constants
NVMF_EXATTYPE_HOSTIDHost Identifier
NVMF_EXATTYPE_SYMNAMESymblic Name
-
struct
nvmf_ext_attr Extended Attribute (EXAT)
Definition
struct nvmf_ext_attr {
__le16 exattype;
__le16 exatlen;
__u8 exatval[];
};
Members
exattypeExtended Attribute Type (EXATTYPE) - see enum nvmf_exattype
exatlenExtended Attribute Length (EXATLEN)
exatvalExtended Attribute Value (EXATVAL) - size allocated for array must be a multiple of 4 bytes
-
struct
nvmf_ext_die Extended Discovery Information Entry (DIE)
Definition
struct nvmf_ext_die {
__u8 trtype;
__u8 adrfam;
__u8 subtype;
__u8 treq;
__le16 portid;
__le16 cntlid;
__le16 asqsz;
__u8 rsvd10[22];
char trsvcid[NVMF_TRSVCID_SIZE];
__u8 resv64[192];
char nqn[NVME_NQN_LENGTH];
char traddr[NVMF_TRADDR_SIZE];
union nvmf_tsas tsas;
__le32 tel;
__le16 numexat;
__u8 resv1030[2];
struct nvmf_ext_attr exat[];
};
Members
trtypeTransport Type (
enum nvmf_trtype)adrfamAddress Family (
enum nvmf_addr_family)subtypeSubsystem Type (
enum nvme_subsys_type)treqTransport Requirements (
enum nvmf_treq)portidPort ID
cntlidController ID
asqszAdmin Max SQ Size
rsvd10Reserved
trsvcidTransport Service Identifier
resv64Reserved
nqnNVM Qualified Name
traddrTransport Address
tsasTransport Specific Address Subtype (
union nvmf_tsas)telTotal Entry Length
numexatNumber of Extended Attributes
resv1030Reserved
exatExtended Attributes 0 (
struct nvmf_ext_attr)
-
union
nvmf_die Discovery Information Entry (DIE)
Definition
union nvmf_die {
struct nvmf_disc_log_entry basic[0];
struct nvmf_ext_die extended;
};
Members
basicBasic format (
struct nvmf_disc_log_entry)extendedExtended format (
struct nvmf_ext_die)
Description
Depending on the ENTFMT specified in the DIM, DIEs can be entered with the Basic or Extended formats. For Basic format, each entry has a fixed length. Therefore, the “basic” field defined below can be accessed as a C array. For the Extended format, however, each entry is of variable length (TEL). Therefore, the “extended” field defined below cannot be accessed as a C array. Instead, the “extended” field is akin to a linked-list, where one can “walk” through the list. To move to the next entry, one simply adds the current entry’s length (TEL) to the “walk” pointer. The number of entries in the list is specified by NUMENT. Although extended entries are of a variable lengths (TEL), TEL is always a multiple of 4 bytes.
-
struct
nvmf_dim_data Discovery Information Management (DIM) - Data
Definition
struct nvmf_dim_data {
__le32 tdl;
__u8 rsvd4[4];
__le64 nument;
__le16 entfmt;
__le16 etype;
__u8 portlcl;
__u8 rsvd21;
__le16 ektype;
char eid[NVME_NQN_LENGTH];
char ename[NVMF_ENAME_LEN];
char ever[NVMF_EVER_LEN];
__u8 rsvd600[424];
union nvmf_die die[];
};
Members
tdlTotal Data Length
rsvd4Reserved
numentNumber of entries
entfmtEntry Format (
enum nvmf_dim_entfmt)etypeEntity Type (
enum nvmf_dim_etype)portlclPort Local
rsvd21Reserved
ektypeEntry Key Type
eidEntity Identifier (e.g. Host NQN)
enameEntity Name (e.g. hostname)
everEntity Version (e.g. OS Name/Version)
rsvd600Reserved
dieDiscovery Information Entry (see nument above)
-
struct
nvmf_connect_data Data payload for the ‘connect’ command
Definition
struct nvmf_connect_data {
__u8 hostid[16];
__le16 cntlid;
char rsvd4[238];
char subsysnqn[NVME_NQN_LENGTH];
char hostnqn[NVME_NQN_LENGTH];
char rsvd5[256];
};
Members
hostidHost ID of the connecting host
cntlidRequested controller ID
rsvd4Reserved
subsysnqnSubsystem NQN to connect to
hostnqnHost NQN of the connecting host
rsvd5Reserved
-
struct
nvme_mi_read_nvm_ss_info NVM Subsystem Information Data Structure
Definition
struct nvme_mi_read_nvm_ss_info {
__u8 nump;
__u8 mjr;
__u8 mnr;
__u8 rsvd3[29];
};
Members
numpNumber of Ports
mjrNVMe-MI Major Version Number
mnrNVMe-MI Minor Version Number
rsvd3Reserved
-
struct
nvme_mi_port_pcie PCIe Port Specific Data
Definition
struct nvme_mi_port_pcie {
__u8 mps;
__u8 sls;
__u8 cls;
__u8 mlw;
__u8 nlw;
__u8 pn;
__u8 rsvd14[18];
};
Members
mpsPCIe Maximum Payload Size
slsPCIe Supported Link Speeds Vector
clsPCIe Current Link Speed
mlwPCIe Maximum Link Width
nlwPCIe Negotiated Link Width
pnPCIe Port Number
rsvd14Reserved
-
struct
nvme_mi_port_smb SMBus Port Specific Data
Definition
struct nvme_mi_port_smb {
__u8 vpd_addr;
__u8 mvpd_freq;
__u8 mme_addr;
__u8 mme_freq;
__u8 nvmebm;
__u8 rsvd13[19];
};
Members
vpd_addrCurrent VPD SMBus/I2C Address
mvpd_freqMaximum VPD Access SMBus/I2C Frequency
mme_addrCurrent Management Endpoint SMBus/I2C Address
mme_freqMaximum Management Endpoint SMBus/I2C Frequency
nvmebmNVMe Basic Management
rsvd13Reserved
-
struct
nvme_mi_read_port_info Port Information Data Structure
Definition
struct nvme_mi_read_port_info {
__u8 portt;
__u8 rsvd1;
__le16 mmctptus;
__le32 meb;
union {
struct nvme_mi_port_pcie pcie;
struct nvme_mi_port_smb smb;
};
};
Members
porttPort Type
rsvd1Reserved
mmctptusMaximum MCTP Transmission Unit Size
mebManagement Endpoint Buffer Size
{unnamed_union}anonymous
pciePCIe Port Specific Data
smbSMBus Port Specific Data
-
struct
nvme_mi_read_ctrl_info Controller Information Data Structure
Definition
struct nvme_mi_read_ctrl_info {
__u8 portid;
__u8 rsvd1[4];
__u8 prii;
__le16 pri;
__le16 vid;
__le16 did;
__le16 ssvid;
__le16 ssid;
__u8 rsvd16[16];
};
Members
portidPort Identifier
rsvd1Reserved
priiPCIe Routing ID Information
priPCIe Routing ID
vidPCI Vendor ID
didPCI Device ID
ssvidPCI Subsystem Vendor ID
ssidPCI Subsystem Device ID
rsvd16Reserved
-
struct
nvme_mi_osc Optionally Supported Command Data Structure
Definition
struct nvme_mi_osc {
__u8 type;
__u8 opc;
};
Members
typeCommand Type
opcOpcode
-
struct
nvme_mi_read_sc_list Management Endpoint Buffer Supported Command List Data Structure
Definition
struct nvme_mi_read_sc_list {
__le16 numcmd;
struct nvme_mi_osc cmds[];
};
Members
numcmdNumber of Commands
cmdsMEB supported Command Data Structure. See struct nvme_mi_osc
-
struct
nvme_mi_nvm_ss_health_status Subsystem Management Data Structure
Definition
struct nvme_mi_nvm_ss_health_status {
__u8 nss;
__u8 sw;
__u8 ctemp;
__u8 pdlu;
__le16 ccs;
__u8 rsvd8[2];
};
Members
nssNVM Subsystem Status
swSmart Warnings
ctempComposite Temperature
pdluPercentage Drive Life Used
ccsComposite Controller Status
rsvd8Reserved
-
enum
nvme_mi_ccs Get State Control Primitive Success Response Fields - Control Primitive Specific Response
Constants
NVME_MI_CCS_RDYReady
NVME_MI_CCS_CFSController Fatal Status
NVME_MI_CCS_SHSTShutdown Status
NVME_MI_CCS_NSSRONVM Subsystem Reset Occurred
NVME_MI_CCS_CECOController Enable Change Occurred
NVME_MI_CCS_NACNamespace Attribute Changed
NVME_MI_CCS_FAFirmware Activated
NVME_MI_CCS_CSTSController Status Change
NVME_MI_CCS_CTEMPComposite Temperature Change
NVME_MI_CCS_PDLUPercentage Used
NVME_MI_CCS_SPAREAvailable Spare
NVME_MI_CCS_CCWARNCritical Warning
-
struct
nvme_mi_ctrl_health_status Controller Health Data Structure (CHDS)
Definition
struct nvme_mi_ctrl_health_status {
__le16 ctlid;
__le16 csts;
__le16 ctemp;
__u8 pdlu;
__u8 spare;
__u8 cwarn;
__u8 rsvd9[7];
};
Members
ctlidController Identifier
cstsController Status
ctempComposite Temperature
pdluPercentage Used
spareAvailable Spare
cwarnCritical Warning
rsvd9Reserved
-
enum
nvme_mi_csts Controller Health Data Structure (CHDS) - Controller Status (CSTS)
Constants
NVME_MI_CSTS_RDYReady
NVME_MI_CSTS_CFSController Fatal Status
NVME_MI_CSTS_SHSTShutdown Status
NVME_MI_CSTS_NSSRONVM Subsystem Reset Occurred
NVME_MI_CSTS_CECOController Enable Change Occurred
NVME_MI_CSTS_NACNamespace Attribute Changed
NVME_MI_CSTS_FAFirmware Activated
-
enum
nvme_mi_cwarn Controller Health Data Structure (CHDS) - Critical Warning (CWARN)
Constants
NVME_MI_CWARN_STSpare Threshold
NVME_MI_CWARN_TAUTTemperature Above or Under Threshold
NVME_MI_CWARN_RDReliability Degraded
NVME_MI_CWARN_RORead Only
NVME_MI_CWARN_VMBFVolatile Memory Backup Failed
-
struct
nvme_mi_vpd_mra NVMe MultiRecord Area
Definition
struct nvme_mi_vpd_mra {
__u8 nmravn;
__u8 ff;
__u8 rsvd7[6];
__u8 i18vpwr;
__u8 m18vpwr;
__u8 i33vpwr;
__u8 m33vpwr;
__u8 rsvd17;
__u8 m33vapsr;
__u8 i5vapsr;
__u8 m5vapsr;
__u8 i12vapsr;
__u8 m12vapsr;
__u8 mtl;
__u8 tnvmcap[16];
__u8 rsvd37[27];
};
Members
nmravnNVMe MultiRecord Area Version Number
ffForm Factor
rsvd7Reserved
i18vpwrInitial 1.8 V Power Supply Requirements
m18vpwrMaximum 1.8 V Power Supply Requirements
i33vpwrInitial 3.3 V Power Supply Requirements
m33vpwrMaximum 3.3 V Power Supply Requirements
rsvd17Reserved
m33vapsrMaximum 3.3 Vi aux Power Supply Requirements
i5vapsrInitial 5 V Power Supply Requirements
m5vapsrMaximum 5 V Power Supply Requirements
i12vapsrInitial 12 V Power Supply Requirements
m12vapsrMaximum 12 V Power Supply Requirements
mtlMaximum Thermal Load
tnvmcapTotal NVM Capacity
rsvd37Reserved
-
struct
nvme_mi_vpd_ppmra NVMe PCIe Port MultiRecord Area
Definition
struct nvme_mi_vpd_ppmra {
__u8 nppmravn;
__u8 pn;
__u8 ppi;
__u8 ls;
__u8 mlw;
__u8 mctp;
__u8 refccap;
__u8 pi;
__u8 rsvd13[3];
};
Members
nppmravnNVMe PCIe Port MultiRecord Area Version Number
pnPCIe Port Number
ppiPort Information
lsPCIe Link Speed
mlwPCIe Maximum Link Width
mctpMCTP Support
refccapRef Clk Capability
piPort Identifier
rsvd13Reserved
-
struct
nvme_mi_vpd_telem Vital Product Data Element Descriptor
Definition
struct nvme_mi_vpd_telem {
__u8 type;
__u8 rev;
__u8 len;
__u8 data[0];
};
Members
typeType of the Element Descriptor
revRevision of the Element Descriptor
lenNumber of bytes in the Element Descriptor
dataType-specific information associated with the Element Descriptor
-
enum
nvme_mi_elem Element Descriptor Types
Constants
NVME_MI_ELEM_EEDExtended Element Descriptor
NVME_MI_ELEM_USCEUpstream Connector Element Descriptor
NVME_MI_ELEM_ECEDExpansion Connector Element Descriptor
NVME_MI_ELEM_LEDLabel Element Descriptor
NVME_MI_ELEM_SMBMEDSMBus/I2C Mux Element Descriptor
NVME_MI_ELEM_PCIESEDPCIe Switch Element Descriptor
NVME_MI_ELEM_NVMEDNVM Subsystem Element Descriptor
-
struct
nvme_mi_vpd_tra Vital Product Data Topology MultiRecord
Definition
struct nvme_mi_vpd_tra {
__u8 vn;
__u8 rsvd6;
__u8 ec;
struct nvme_mi_vpd_telem elems[0];
};
Members
vnVersion Number
rsvd6Reserved
ecElement Count
elemsElement Descriptor
-
struct
nvme_mi_vpd_mr_common NVMe MultiRecord Area
Definition
struct nvme_mi_vpd_mr_common {
__u8 type;
__u8 rf;
__u8 rlen;
__u8 rchksum;
__u8 hchksum;
union {
struct nvme_mi_vpd_mra nmra;
struct nvme_mi_vpd_ppmra ppmra;
struct nvme_mi_vpd_tra tmra;
};
};
Members
typeNVMe Record Type ID
rfRecord Format
rlenRecord Length
rchksumRecord Checksum
hchksumHeader Checksum
{unnamed_union}anonymous
nmraNVMe MultiRecord Area
ppmraNVMe PCIe Port MultiRecord Area
tmraTopology MultiRecord Area
-
struct
nvme_mi_vpd_hdr Vital Product Data Common Header
Definition
struct nvme_mi_vpd_hdr {
__u8 ipmiver;
__u8 iuaoff;
__u8 ciaoff;
__u8 biaoff;
__u8 piaoff;
__u8 mrioff;
__u8 rsvd6;
__u8 chchk;
__u8 vpd[];
};
Members
ipmiverIPMI Format Version Number
iuaoffInternal Use Area Starting Offset
ciaoffChassis Info Area Starting Offset
biaoffBoard Info Area Starting Offset
piaoffProduct Info Area Starting Offset
mrioffMultiRecord Info Area Starting Offset
rsvd6Reserved
chchkCommon Header Checksum
vpdVital Product Data
-
enum
nvme_status_field Defines all parts of the nvme status field: status code, status code type, and additional flags.
Constants
NVME_SCT_GENERICGeneric errors applicable to multiple opcodes
NVME_SCT_CMD_SPECIFICErrors associated to a specific opcode
NVME_SCT_MEDIAErrors associated with media and data integrity
NVME_SCT_PATHErrors associated with the paths connection
NVME_SCT_VSVendor specific errors
NVME_SCT_MASKMask to get the value of the Status Code Type
NVME_SCT_SHIFTShift value to get the value of the Status Code Type
NVME_SC_MASKMask to get the value of the status code.
NVME_SC_SHIFTShift value to get the value of the status code.
NVME_SC_SUCCESSSuccessful Completion: The command completed without error.
NVME_SC_INVALID_OPCODEInvalid Command Opcode: A reserved coded value or an unsupported value in the command opcode field.
NVME_SC_INVALID_FIELDInvalid Field in Command: A reserved coded value or an unsupported value in a defined field.
NVME_SC_CMDID_CONFLICTCommand ID Conflict: The command identifier is already in use.
NVME_SC_DATA_XFER_ERRORData Transfer Error: Transferring the data or metadata associated with a command experienced an error.
NVME_SC_POWER_LOSSCommands Aborted due to Power Loss Notification: Indicates that the command was aborted due to a power loss notification.
NVME_SC_INTERNALInternal Error: The command was not completed successfully due to an internal error.
NVME_SC_ABORT_REQCommand Abort Requested: The command was aborted due to an Abort command being received that specified the Submission Queue Identifier and Command Identifier of this command.
NVME_SC_ABORT_QUEUECommand Aborted due to SQ Deletion: The command was aborted due to a Delete I/O Submission Queue request received for the Submission Queue to which the command was submitted.
NVME_SC_FUSED_FAILCommand Aborted due to Failed Fused Command: The command was aborted due to the other command in a fused operation failing.
NVME_SC_FUSED_MISSINGAborted due to Missing Fused Command: The fused command was aborted due to the adjacent submission queue entry not containing a fused command that is the other command.
NVME_SC_INVALID_NSInvalid Namespace or Format: The namespace or the format of that namespace is invalid.
NVME_SC_CMD_SEQ_ERRORCommand Sequence Error: The command was aborted due to a protocol violation in a multi-command sequence.
NVME_SC_SGL_INVALID_LASTInvalid SGL Segment Descriptor: The command includes an invalid SGL Last Segment or SGL Segment descriptor.
NVME_SC_SGL_INVALID_COUNTInvalid Number of SGL Descriptors: There is an SGL Last Segment descriptor or an SGL Segment descriptor in a location other than the last descriptor of a segment based on the length indicated.
NVME_SC_SGL_INVALID_DATAData SGL Length Invalid: This may occur if the length of a Data SGL is too short. This may occur if the length of a Data SGL is too long and the controller does not support SGL transfers longer than the amount of data to be transferred as indicated in the SGL Support field of the Identify Controller data structure.
NVME_SC_SGL_INVALID_METADATAMetadata SGL Length Invalid: This may occur if the length of a Metadata SGL is too short. This may occur if the length of a Metadata SGL is too long and the controller does not support SGL transfers longer than the amount of data to be transferred as indicated in the SGL Support field of the Identify Controller data structure.
NVME_SC_SGL_INVALID_TYPESGL Descriptor Type Invalid: The type of an SGL Descriptor is a type that is not supported by the controller.
NVME_SC_CMB_INVALID_USEInvalid Use of Controller Memory Buffer: The attempted use of the Controller Memory Buffer is not supported by the controller.
NVME_SC_PRP_INVALID_OFFSETPRP Offset Invalid: The Offset field for a PRP entry is invalid.
NVME_SC_AWU_EXCEEDEDAtomic Write Unit Exceeded: The length specified exceeds the atomic write unit size.
NVME_SC_OP_DENIEDOperation Denied: The command was denied due to lack of access rights. Refer to the appropriate security specification.
NVME_SC_SGL_INVALID_OFFSETSGL Offset Invalid: The offset specified in a descriptor is invalid. This may occur when using capsules for data transfers in NVMe over Fabrics implementations and an invalid offset in the capsule is specified.
NVME_SC_HOSTID_FORMATHost Identifier Inconsistent Format: The NVM subsystem detected the simultaneous use of 64- bit and 128-bit Host Identifier values on different controllers.
NVME_SC_KAT_EXPIREDKeep Alive Timer Expired: The Keep Alive Timer expired.
NVME_SC_KAT_INVALIDKeep Alive Timeout Invalid: The Keep Alive Timeout value specified is invalid.
NVME_SC_CMD_ABORTED_PREMEPTCommand Aborted due to Preempt and Abort: The command was aborted due to a Reservation Acquire command.
NVME_SC_SANITIZE_FAILEDSanitize Failed: The most recent sanitize operation failed and no recovery action has been successfully completed.
NVME_SC_SANITIZE_IN_PROGRESSSanitize In Progress: The requested function (e.g., command) is prohibited while a sanitize operation is in progress.
NVME_SC_SGL_INVALID_GRANULARITYSGL Data Block Granularity Invalid: The Address alignment or Length granularity for an SGL Data Block descriptor is invalid.
NVME_SC_CMD_IN_CMBQ_NOT_SUPPCommand Not Supported for Queue in CMB: The implementation does not support submission of the command to a Submission Queue in the Controller Memory Buffer or command completion to a Completion Queue in the Controller Memory Buffer.
NVME_SC_NS_WRITE_PROTECTEDNamespace is Write Protected: The command is prohibited while the namespace is write protected as a result of a change in the namespace write protection state as defined by the Namespace Write Protection State Machine.
NVME_SC_CMD_INTERRUPTEDCommand Interrupted: Command processing was interrupted and the controller is unable to successfully complete the command. The host should retry the command.
NVME_SC_TRAN_TPORT_ERRORTransient Transport Error: A transient transport error was detected. If the command is retried on the same controller, the command is likely to succeed. A command that fails with a transient transport error four or more times should be treated as a persistent transport error that is not likely to succeed if retried on the same controller.
NVME_SC_PROHIBITED_BY_CMD_AND_FEATCommand Prohibited by Command and Feature Lockdown: The command was aborted due to command execution being prohibited by the Command and Feature Lockdown.
NVME_SC_ADMIN_CMD_MEDIA_NOT_READYAdmin Command Media Not Ready: The Admin command requires access to media and the media is not ready.
NVME_SC_FDP_DISABLEDCommand is not allowed when Flexible Data Placement is disabled.
NVME_SC_INVALID_PLACEMENT_HANDLE_LISTThe Placement Handle List is invalid due to invalid Reclaim Unit Handle Identifier or valid Reclaim Unit Handle Identifier but restricted or the Placement Handle List number of entries exceeded the maximum number allowed.
NVME_SC_LBA_RANGELBA Out of Range: The command references an LBA that exceeds the size of the namespace.
NVME_SC_CAP_EXCEEDEDCapacity Exceeded: Execution of the command has caused the capacity of the namespace to be exceeded.
NVME_SC_NS_NOT_READYNamespace Not Ready: The namespace is not ready to be accessed as a result of a condition other than a condition that is reported as an Asymmetric Namespace Access condition.
NVME_SC_RESERVATION_CONFLICTReservation Conflict: The command was aborted due to a conflict with a reservation held on the accessed namespace.
NVME_SC_FORMAT_IN_PROGRESSFormat In Progress: A Format NVM command is in progress on the namespace.
NVME_SC_CQ_INVALIDCompletion Queue Invalid: The Completion Queue identifier specified in the command does not exist.
NVME_SC_QID_INVALIDInvalid Queue Identifier: The creation of the I/O Completion Queue failed due to an invalid queue identifier specified as part of the command. An invalid queue identifier is one that is currently in use or one that is outside the range supported by the controller.
NVME_SC_QUEUE_SIZEInvalid Queue Size: The host attempted to create an I/O Completion Queue with an invalid number of entries.
NVME_SC_ABORT_LIMITAbort Command Limit Exceeded: The number of concurrently outstanding Abort commands has exceeded the limit indicated in the Identify Controller data structure.
NVME_SC_ABORT_MISSINGAbort Command is missing: The abort command is missing.
NVME_SC_ASYNC_LIMITAsynchronous Event Request Limit Exceeded: The number of concurrently outstanding Asynchronous Event Request commands has been exceeded.
NVME_SC_FIRMWARE_SLOTInvalid Firmware Slot: The firmware slot indicated is invalid or read only. This error is indicated if the firmware slot exceeds the number supported.
NVME_SC_FIRMWARE_IMAGEInvalid Firmware Image: The firmware image specified for activation is invalid and not loaded by the controller.
NVME_SC_INVALID_VECTORInvalid Interrupt Vector: The creation of the I/O Completion Queue failed due to an invalid interrupt vector specified as part of the command.
NVME_SC_INVALID_LOG_PAGEInvalid Log Page: The log page indicated is invalid. This error condition is also returned if a reserved log page is requested.
NVME_SC_INVALID_FORMATInvalid Format: The LBA Format specified is not supported.
NVME_SC_FW_NEEDS_CONV_RESETFirmware Activation Requires Conventional Reset: The firmware commit was successful, however, activation of the firmware image requires a conventional reset.
NVME_SC_INVALID_QUEUEInvalid Queue Deletion: Invalid I/O Completion Queue specified to delete.
NVME_SC_FEATURE_NOT_SAVEABLEFeature Identifier Not Saveable: The Feature Identifier specified does not support a saveable value.
NVME_SC_FEATURE_NOT_CHANGEABLEFeature Not Changeable: The Feature Identifier is not able to be changed.
NVME_SC_FEATURE_NOT_PER_NSFeature Not Namespace Specific: The Feature Identifier specified is not namespace specific. The Feature Identifier settings apply across all namespaces.
NVME_SC_FW_NEEDS_SUBSYS_RESETFirmware Activation Requires NVM Subsystem Reset: The firmware commit was successful, however, activation of the firmware image requires an NVM Subsystem.
NVME_SC_FW_NEEDS_RESETFirmware Activation Requires Controller Level Reset: The firmware commit was successful; however, the image specified does not support being activated without a reset.
NVME_SC_FW_NEEDS_MAX_TIMEFirmware Activation Requires Maximum Time Violation: The image specified if activated immediately would exceed the Maximum Time for Firmware Activation (MTFA) value reported in Identify Controller.
NVME_SC_FW_ACTIVATE_PROHIBITEDFirmware Activation Prohibited: The image specified is being prohibited from activation by the controller for vendor specific reasons.
NVME_SC_OVERLAPPING_RANGEOverlapping Range: The downloaded firmware image has overlapping ranges.
NVME_SC_NS_INSUFFICIENT_CAPNamespace Insufficient Capacity: Creating the namespace requires more free space than is currently available.
NVME_SC_NS_ID_UNAVAILABLENamespace Identifier Unavailable: The number of namespaces supported has been exceeded.
NVME_SC_NS_ALREADY_ATTACHEDNamespace Already Attached: The controller is already attached to the namespace specified.
NVME_SC_NS_IS_PRIVATENamespace Is Private: The namespace is private and is already attached to one controller.
NVME_SC_NS_NOT_ATTACHEDNamespace Not Attached: The request to detach the controller could not be completed because the controller is not attached to the namespace.
NVME_SC_THIN_PROV_NOT_SUPPThin Provisioning Not Supported: Thin provisioning is not supported by the controller.
NVME_SC_CTRL_LIST_INVALIDController List Invalid: The controller list provided contains invalid controller ids.
NVME_SC_SELF_TEST_IN_PROGRESSDevice Self-test In Progress: The controller or NVM subsystem already has a device self-test operation in process.
NVME_SC_BP_WRITE_PROHIBITEDBoot Partition Write Prohibited: The command is trying to modify a locked Boot Partition.
NVME_SC_INVALID_CTRL_IDInvalid Controller Identifier:
NVME_SC_INVALID_SEC_CTRL_STATEInvalid Secondary Controller State
NVME_SC_INVALID_CTRL_RESOURCESInvalid Number of Controller Resources
NVME_SC_INVALID_RESOURCE_IDInvalid Resource Identifier
NVME_SC_PMR_SAN_PROHIBITEDSanitize Prohibited While Persistent Memory Region is Enabled
NVME_SC_ANA_GROUP_ID_INVALIDANA Group Identifier Invalid: The specified ANA Group Identifier (ANAGRPID) is not supported in the submitted command.
NVME_SC_ANA_ATTACH_FAILEDANA Attach Failed: The controller is not attached to the namespace as a result of an ANA condition.
NVME_SC_INSUFFICIENT_CAPInsufficient Capacity: Requested operation requires more free space than is currently available.
NVME_SC_NS_ATTACHMENT_LIMIT_EXCEEDEDNamespace Attachment Limit Exceeded: Attaching the ns to a controller causes max number of ns attachments allowed to be exceeded.
NVME_SC_PROHIBIT_CMD_EXEC_NOT_SUPPORTEDProhibition of Command Execution Not Supported
NVME_SC_IOCS_NOT_SUPPORTEDI/O Command Set Not Supported
NVME_SC_IOCS_NOT_ENABLEDI/O Command Set Not Enabled
NVME_SC_IOCS_COMBINATION_REJECTEDI/O Command Set Combination Rejected
NVME_SC_INVALID_IOCSInvalid I/O Command Set
NVME_SC_ID_UNAVAILABLEIdentifier Unavailable
NVME_SC_INVALID_DISCOVERY_INFOThe discovery information provided in one or more extended discovery information entries is not applicable for the type of entity selected in the Entity Type (ETYPE) field of the Discovery Information Management command data portion’s header.
NVME_SC_ZONING_DATA_STRUCT_LOCKEDThe requested Zoning data structure is locked on the CDC.
NVME_SC_ZONING_DATA_STRUCT_NOTFNDThe requested Zoning data structure does not exist on the CDC.
NVME_SC_INSUFFICIENT_DISC_RESThe number of discover information entries provided in the data portion of the Discovery Information Management command for a registration task (i.e., TAS field cleared to 0h) exceeds the available capacity for new discovery information entries on the CDC or DDC. This may be a transient condition.
NVME_SC_REQSTD_FUNCTION_DISABLEDFabric Zoning is not enabled on the CDC
NVME_SC_ZONEGRP_ORIGINATOR_INVLDThe NQN contained in the ZoneGroup Originator field does not match the Host NQN used by the DDC to connect to the CDC.
NVME_SC_BAD_ATTRIBUTESConflicting Dataset Management Attributes
NVME_SC_INVALID_PIInvalid Protection Information
NVME_SC_READ_ONLYAttempted Write to Read Only Range
NVME_SC_CMD_SIZE_LIMIT_EXCEEDEDCommand Size Limit Exceeded
NVME_SC_CONNECT_FORMATIncompatible Format: The NVM subsystem does not support the record format specified by the host.
NVME_SC_CONNECT_CTRL_BUSYController Busy: The controller is already associated with a host.
NVME_SC_CONNECT_INVALID_PARAMConnect Invalid Parameters: One or more of the command parameters.
NVME_SC_CONNECT_RESTART_DISCConnect Restart Discovery: The NVM subsystem requested is not available.
NVME_SC_CONNECT_INVALID_HOSTConnect Invalid Host: The host is either not allowed to establish an association to any controller in the NVM subsystem or the host is not allowed to establish an association to the specified controller
NVME_SC_DISCONNECT_INVALID_QTYPEInvalid Queue Type: The command was sent on the wrong queue type.
NVME_SC_DISCOVERY_RESTARTDiscover Restart: The snapshot of the records is now invalid or out of date.
NVME_SC_AUTH_REQUIREDAuthentication Required: NVMe in-band authentication is required and the queue has not yet been authenticated.
NVME_SC_ZNS_INVALID_OP_REQUESTInvalid Zone Operation Request: The operation requested is invalid. This may be due to various conditions, including: attempting to allocate a ZRWA when a zone is not in the ZSE:Empty state; or invalid Flush Explicit ZRWA Range Send Zone Action operation.
NVME_SC_ZNS_ZRWA_RESOURCES_UNAVAILABLEZRWA Resources Unavailable: No ZRWAs are available.
NVME_SC_ZNS_BOUNDARY_ERRORZone Boundary Error: The command specifies logical blocks in more than one zone.
NVME_SC_ZNS_FULLZone Is Full: The accessed zone is in the ZSF:Full state.
NVME_SC_ZNS_READ_ONLYZone Is Read Only: The accessed zone is in the ZSRO:Read Only state.
NVME_SC_ZNS_OFFLINEZone Is Offline: The accessed zone is in the ZSO:Offline state.
NVME_SC_ZNS_INVALID_WRITEZone Invalid Write: The write to a zone was not at the write pointer.
NVME_SC_ZNS_TOO_MANY_ACTIVEToo Many Active Zones: The controller does not allow additional active zones.
NVME_SC_ZNS_TOO_MANY_OPENSToo Many Open Zones: The controller does not allow additional open zones.
NVME_SC_ZNS_INVAL_TRANSITIONInvalid Zone State Transition: The request is not a valid zone state transition.
NVME_SC_WRITE_FAULTWrite Fault: The write data could not be committed to the media.
NVME_SC_READ_ERRORUnrecovered Read Error: The read data could not be recovered from the media.
NVME_SC_GUARD_CHECKEnd-to-end Guard Check Error: The command was aborted due to an end-to-end guard check failure.
NVME_SC_APPTAG_CHECKEnd-to-end Application Tag Check Error: The command was aborted due to an end-to-end application tag check failure.
NVME_SC_REFTAG_CHECKEnd-to-end Reference Tag Check Error: The command was aborted due to an end-to-end reference tag check failure.
NVME_SC_COMPARE_FAILEDCompare Failure: The command failed due to a miscompare during a Compare command.
NVME_SC_ACCESS_DENIEDAccess Denied: Access to the namespace and/or LBA range is denied due to lack of access rights.
NVME_SC_UNWRITTEN_BLOCKDeallocated or Unwritten Logical Block: The command failed due to an attempt to read from or verify an LBA range containing a deallocated or unwritten logical block.
NVME_SC_STORAGE_TAG_CHECKEnd-to-End Storage Tag Check Error: The command was aborted due to an end-to-end storage tag check failure.
NVME_SC_ANA_INTERNAL_PATH_ERRORInternal Path Error: The command was not completed as the result of a controller internal error that is specific to the controller processing the command.
NVME_SC_ANA_PERSISTENT_LOSSAsymmetric Access Persistent Loss: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace being in the ANA Persistent Loss state.
NVME_SC_ANA_INACCESSIBLEAsymmetric Access Inaccessible: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace being in the ANA Inaccessible state.
NVME_SC_ANA_TRANSITIONAsymmetric Access Transition: The requested function (e.g., command) is not able to be performed as a result of the relationship between the controller and the namespace transitioning between Asymmetric Namespace Access states.
NVME_SC_CTRL_PATH_ERRORController Pathing Error: A pathing error was detected by the controller.
NVME_SC_HOST_PATH_ERRORHost Pathing Error: A pathing error was detected by the host.
NVME_SC_CMD_ABORTED_BY_HOSTCommand Aborted By Host: The command was aborted as a result of host action.
NVME_SC_CRDMask to get value of Command Retry Delay index
NVME_SC_MOREMore bit. If set, more status information for this command as part of the Error Information log that may be retrieved with the Get Log Page command.
NVME_SC_DNRDo Not Retry bit. If set, if the same command is re-submitted to any controller in the NVM subsystem, then that re-submitted command is expected to fail.
-
__u16
nvme_status_code_type(__u16 status_field) Returns the NVMe Status Code Type
Parameters
__u16 status_fieldThe NVMe Completion Queue Entry’s Status Field See
enum nvme_status_field
Return
status code type
-
__u16
nvme_status_code(__u16 status_field) Returns the NVMe Status Code
Parameters
__u16 status_fieldThe NVMe Completion Queue Entry’s Status Field See
enum nvme_status_field
Return
status code
-
enum
nvme_status_type type encoding for NVMe return values, when represented as an int.
Constants
NVME_STATUS_TYPE_SHIFTshift value for status bits
NVME_STATUS_TYPE_MASKmask value for status bits
NVME_STATUS_TYPE_NVMENVMe command status value, typically from CDW3
NVME_STATUS_TYPE_MINVMe-MI header status
Description
The nvme_* api returns an int, with negative values indicating an internal or syscall error, zero signifying success, positive values representing the NVMe status.
That latter case (the NVMe status) may represent status values from different parts of the transport/controller/etc, and are at most 16 bits of data. So, we use the most-significant 3 bits of the signed int to indicate which type of status this is.
-
__u32
nvme_status_get_type(int status) extract the type from a nvme_* return value
Parameters
int statusthe (non-negative) return value from the NVMe API
Return
the type component of the status.
-
__u32
nvme_status_get_value(int status) extract the status value from a nvme_* return value
Parameters
int statusthe (non-negative) return value from the NVMe API
Return
the value component of the status; the set of values will depend on the status type.
-
__u32
nvme_status_equals(int status, enum nvme_status_type type, unsigned int value) helper to check a status against a type and value
Parameters
int statusthe (non-negative) return value from the NVMe API
enum nvme_status_type typethe status type
unsigned int valuethe status value
Return
true if status is of the specified type and value
-
enum
nvme_admin_opcode Known NVMe admin opcodes
Constants
nvme_admin_delete_sqDelete I/O Submission Queue
nvme_admin_create_sqCreate I/O Submission Queue
nvme_admin_get_log_pageGet Log Page
nvme_admin_delete_cqDelete I/O Completion Queue
nvme_admin_create_cqCreate I/O Completion Queue
nvme_admin_identifyIdentify
nvme_admin_abort_cmdAbort
nvme_admin_set_featuresSet Features
nvme_admin_get_featuresGet Features
nvme_admin_async_eventAsynchronous Event Request
nvme_admin_ns_mgmtNamespace Management
nvme_admin_fw_commitFirmware Commit
nvme_admin_fw_activateFirmware Commit
nvme_admin_fw_downloadFirmware Image Download
nvme_admin_dev_self_testDevice Self-test
nvme_admin_ns_attachNamespace Attachment
nvme_admin_keep_aliveKeep Alive
nvme_admin_directive_sendDirective Send
nvme_admin_directive_recvDirective Receive
nvme_admin_virtual_mgmtVirtualization Management
nvme_admin_nvme_mi_sendNVMe-MI Send
nvme_admin_nvme_mi_recvNVMe-MI Receive
nvme_admin_capacity_mgmtCapacity Management
nvme_admin_discovery_info_mgmtDiscovery Information Management (DIM)
nvme_admin_fabric_zoning_recvFabric Zoning Receive
nvme_admin_lockdownLockdown
nvme_admin_fabric_zoning_lookupFabric Zoning Lookup
nvme_admin_fabric_zoning_sendFabric Zoning Send
nvme_admin_dbbufDoorbell Buffer Config
nvme_admin_fabricsFabrics Commands
nvme_admin_format_nvmFormat NVM
nvme_admin_security_sendSecurity Send
nvme_admin_security_recvSecurity Receive
nvme_admin_sanitize_nvmSanitize
nvme_admin_get_lba_statusGet LBA Status
-
enum
nvme_identify_cns Identify - CNS Values
Constants
NVME_IDENTIFY_CNS_NSIdentify Namespace data structure
NVME_IDENTIFY_CNS_CTRLIdentify Controller data structure
NVME_IDENTIFY_CNS_NS_ACTIVE_LISTActive Namespace ID list
NVME_IDENTIFY_CNS_NS_DESC_LISTNamespace Identification Descriptor list
NVME_IDENTIFY_CNS_NVMSET_LISTNVM Set List
NVME_IDENTIFY_CNS_CSI_NSI/O Command Set specific Identify Namespace data structure
NVME_IDENTIFY_CNS_CSI_CTRLI/O Command Set specific Identify Controller data structure
NVME_IDENTIFY_CNS_CSI_NS_ACTIVE_LISTActive Namespace ID list associated with the specified I/O Command Set
NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NSI/O Command Set Independent Identify
NVME_IDENTIFY_CNS_NS_USER_DATA_FORMATNamespace user data format
NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMATI/O Command Set specific user data format Namespace data structure
NVME_IDENTIFY_CNS_ALLOCATED_NS_LISTAllocated Namespace ID list
NVME_IDENTIFY_CNS_ALLOCATED_NSIdentify Namespace data structure for the specified allocated NSID
NVME_IDENTIFY_CNS_NS_CTRL_LISTController List of controllers attached to the specified NSID
NVME_IDENTIFY_CNS_CTRL_LISTController List of controllers that exist in the NVM subsystem
NVME_IDENTIFY_CNS_PRIMARY_CTRL_CAPPrimary Controller Capabilities data structure for the specified primary controller
NVME_IDENTIFY_CNS_SECONDARY_CTRL_LISTSecondary Controller list of controllers associated with the primary controller processing the command
NVME_IDENTIFY_CNS_NS_GRANULARITYA Namespace Granularity List
NVME_IDENTIFY_CNS_UUID_LISTA UUID List
NVME_IDENTIFY_CNS_DOMAIN_LISTDomain List
NVME_IDENTIFY_CNS_ENDURANCE_GROUP_IDEndurance Group List
NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LISTI/O Command Set specific Allocated Namespace ID list
NVME_IDENTIFY_CNS_CSI_ID_NS_DATA_STRUCTUREI/O Command Set specific ID Namespace Data Structure for Allocated Namespace ID
NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTUREBase Specification 2.0a section 5.17.2.21
-
enum
nvme_cmd_get_log_lid Get Log Page -Log Page Identifiers
Constants
NVME_LOG_LID_SUPPORTED_LOG_PAGESSupported Log Pages
NVME_LOG_LID_ERRORError Information
NVME_LOG_LID_SMARTSMART / Health Information
NVME_LOG_LID_FW_SLOTFirmware Slot Information
NVME_LOG_LID_CHANGED_NSChanged Namespace List
NVME_LOG_LID_CMD_EFFECTSCommands Supported and Effects
NVME_LOG_LID_DEVICE_SELF_TESTDevice Self-test
NVME_LOG_LID_TELEMETRY_HOSTTelemetry Host-Initiated
NVME_LOG_LID_TELEMETRY_CTRLTelemetry Controller-Initiated
NVME_LOG_LID_ENDURANCE_GROUPEndurance Group Information
NVME_LOG_LID_PREDICTABLE_LAT_NVMSETPredictable Latency Per NVM Set
NVME_LOG_LID_PREDICTABLE_LAT_AGGPredictable Latency Event Aggregate
NVME_LOG_LID_ANAAsymmetric Namespace Access
NVME_LOG_LID_PERSISTENT_EVENTPersistent Event Log
NVME_LOG_LID_LBA_STATUSLBA Status Information
NVME_LOG_LID_ENDURANCE_GRP_EVTEndurance Group Event Aggregate
NVME_LOG_LID_MEDIA_UNIT_STATUSMedia Unit Status
NVME_LOG_LID_SUPPORTED_CAP_CONFIG_LISTSupported Capacity Configuration Lis
NVME_LOG_LID_FID_SUPPORTED_EFFECTSFeature Identifiers Supported and Effects
NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTSNVMe-MI Commands Supported and Effects
NVME_LOG_LID_BOOT_PARTITIONBoot Partition
NVME_LOG_LID_PHY_RX_EOMPhysical Interface Receiver Eye Opening Measurement
NVME_LOG_LID_FDP_CONFIGSFDP Configurations
NVME_LOG_LID_FDP_RUH_USAGEReclaim Unit Handle Usage
NVME_LOG_LID_FDP_STATSFDP Statistics
NVME_LOG_LID_FDP_EVENTSFDP Events
NVME_LOG_LID_DISCOVERDiscovery
NVME_LOG_LID_RESERVATIONReservation Notification
NVME_LOG_LID_SANITIZESanitize Status
NVME_LOG_LID_ZNS_CHANGED_ZONESChanged Zone List
-
enum
nvme_features_id Features - Feature Identifiers
Constants
NVME_FEAT_FID_ARBITRATIONArbitration
NVME_FEAT_FID_POWER_MGMTPower Management
NVME_FEAT_FID_LBA_RANGELBA Range Type
NVME_FEAT_FID_TEMP_THRESHTemperature Threshold
NVME_FEAT_FID_ERR_RECOVERYError Recovery
NVME_FEAT_FID_VOLATILE_WCVolatile Write Cache
NVME_FEAT_FID_NUM_QUEUESNumber of Queues
NVME_FEAT_FID_IRQ_COALESCEInterrupt Coalescing
NVME_FEAT_FID_IRQ_CONFIGInterrupt Vector Configuration
NVME_FEAT_FID_WRITE_ATOMICWrite Atomicity Normal
NVME_FEAT_FID_ASYNC_EVENTAsynchronous Event Configuration
NVME_FEAT_FID_AUTO_PSTAutonomous Power State Transition
NVME_FEAT_FID_HOST_MEM_BUFHost Memory Buffer
NVME_FEAT_FID_TIMESTAMPTimestamp
NVME_FEAT_FID_KATOKeep Alive Timer
NVME_FEAT_FID_HCTMHost Controlled Thermal Management
NVME_FEAT_FID_NOPSCNon-Operational Power State Config
NVME_FEAT_FID_RRLRead Recovery Level Config
NVME_FEAT_FID_PLM_CONFIGPredictable Latency Mode Config
NVME_FEAT_FID_PLM_WINDOWPredictable Latency Mode Window
NVME_FEAT_FID_LBA_STS_INTERVALLBA Status Information Report Interval
NVME_FEAT_FID_HOST_BEHAVIORHost Behavior Support
NVME_FEAT_FID_SANITIZEEndurance Group Event Configuration
NVME_FEAT_FID_ENDURANCE_EVT_CFGEndurance Group Event Configuration
NVME_FEAT_FID_IOCS_PROFILEI/O Command Set Profile
NVME_FEAT_FID_SPINUP_CONTROLSpinup Control
NVME_FEAT_FID_FDPFlexible Data Placement
NVME_FEAT_FID_FDP_EVENTSFDP Events
NVME_FEAT_FID_ENH_CTRL_METADATAEnhanced Controller Metadata
NVME_FEAT_FID_CTRL_METADATAController Metadata
NVME_FEAT_FID_NS_METADATANamespace Metadata
NVME_FEAT_FID_SW_PROGRESSSoftware Progress Marker
NVME_FEAT_FID_HOST_IDHost Identifier
NVME_FEAT_FID_RESV_MASKReservation Notification Mask
NVME_FEAT_FID_RESV_PERSISTReservation Persistence
NVME_FEAT_FID_WRITE_PROTECTNamespace Write Protection Config
-
enum
nvme_feat Features Access Shifts/Masks values
Constants
NVME_FEAT_ARBITRATION_BURST_SHIFT
NVME_FEAT_ARBITRATION_BURST_MASK
NVME_FEAT_ARBITRATION_LPW_SHIFT
NVME_FEAT_ARBITRATION_LPW_MASK
NVME_FEAT_ARBITRATION_MPW_SHIFT
NVME_FEAT_ARBITRATION_MPW_MASK
NVME_FEAT_ARBITRATION_HPW_SHIFT
NVME_FEAT_ARBITRATION_HPW_MASK
NVME_FEAT_PWRMGMT_PS_SHIFT
NVME_FEAT_PWRMGMT_PS_MASK
NVME_FEAT_PWRMGMT_WH_SHIFT
NVME_FEAT_PWRMGMT_WH_MASK
NVME_FEAT_LBAR_NR_SHIFT
NVME_FEAT_LBAR_NR_MASK
NVME_FEAT_TT_TMPTH_SHIFT
NVME_FEAT_TT_TMPTH_MASK
NVME_FEAT_TT_TMPSEL_SHIFT
NVME_FEAT_TT_TMPSEL_MASK
NVME_FEAT_TT_THSEL_SHIFT
NVME_FEAT_TT_THSEL_MASK
NVME_FEAT_ERROR_RECOVERY_TLER_SHIFT
NVME_FEAT_ERROR_RECOVERY_TLER_MASK
NVME_FEAT_ERROR_RECOVERY_DULBE_SHIFT
NVME_FEAT_ERROR_RECOVERY_DULBE_MASK
NVME_FEAT_VWC_WCE_SHIFT
NVME_FEAT_VWC_WCE_MASK
NVME_FEAT_NRQS_NSQR_SHIFT
NVME_FEAT_NRQS_NSQR_MASK
NVME_FEAT_NRQS_NCQR_SHIFT
NVME_FEAT_NRQS_NCQR_MASK
NVME_FEAT_IRQC_THR_SHIFT
NVME_FEAT_IRQC_THR_MASK
NVME_FEAT_IRQC_TIME_SHIFT
NVME_FEAT_IRQC_TIME_MASK
NVME_FEAT_ICFG_IV_SHIFT
NVME_FEAT_ICFG_IV_MASK
NVME_FEAT_ICFG_CD_SHIFT
NVME_FEAT_ICFG_CD_MASK
NVME_FEAT_WA_DN_SHIFT
NVME_FEAT_WA_DN_MASK
NVME_FEAT_AE_SMART_SHIFT
NVME_FEAT_AE_SMART_MASK
NVME_FEAT_AE_NAN_SHIFT
NVME_FEAT_AE_NAN_MASK
NVME_FEAT_AE_FW_SHIFT
NVME_FEAT_AE_FW_MASK
NVME_FEAT_AE_TELEM_SHIFT
NVME_FEAT_AE_TELEM_MASK
NVME_FEAT_AE_ANA_SHIFT
NVME_FEAT_AE_ANA_MASK
NVME_FEAT_AE_PLA_SHIFT
NVME_FEAT_AE_PLA_MASK
NVME_FEAT_AE_LBAS_SHIFT
NVME_FEAT_AE_LBAS_MASK
NVME_FEAT_AE_EGA_SHIFT
NVME_FEAT_AE_EGA_MASK
NVME_FEAT_APST_APSTE_SHIFT
NVME_FEAT_APST_APSTE_MASK
NVME_FEAT_HMEM_EHM_SHIFT
NVME_FEAT_HMEM_EHM_MASK
NVME_FEAT_HCTM_TMT2_SHIFT
NVME_FEAT_HCTM_TMT2_MASK
NVME_FEAT_HCTM_TMT1_SHIFT
NVME_FEAT_HCTM_TMT1_MASK
NVME_FEAT_NOPS_NOPPME_SHIFT
NVME_FEAT_NOPS_NOPPME_MASK
NVME_FEAT_RRL_RRL_SHIFT
NVME_FEAT_RRL_RRL_MASK
NVME_FEAT_PLM_PLME_SHIFT
NVME_FEAT_PLM_PLME_MASK
NVME_FEAT_PLMW_WS_SHIFT
NVME_FEAT_PLMW_WS_MASK
NVME_FEAT_LBAS_LSIRI_SHIFT
NVME_FEAT_LBAS_LSIRI_MASK
NVME_FEAT_LBAS_LSIPI_SHIFT
NVME_FEAT_LBAS_LSIPI_MASK
NVME_FEAT_SC_NODRM_SHIFT
NVME_FEAT_SC_NODRM_MASK
NVME_FEAT_EG_ENDGID_SHIFT
NVME_FEAT_EG_ENDGID_MASK
NVME_FEAT_EG_EGCW_SHIFT
NVME_FEAT_EG_EGCW_MASK
NVME_FEAT_SPM_PBSLC_SHIFT
NVME_FEAT_SPM_PBSLC_MASK
NVME_FEAT_HOSTID_EXHID_SHIFT
NVME_FEAT_HOSTID_EXHID_MASK
NVME_FEAT_RM_REGPRE_SHIFT
NVME_FEAT_RM_REGPRE_MASK
NVME_FEAT_RM_RESREL_SHIFT
NVME_FEAT_RM_RESREL_MASK
NVME_FEAT_RM_RESPRE_SHIFT
NVME_FEAT_RM_RESPRE_MASK
NVME_FEAT_RP_PTPL_SHIFT
NVME_FEAT_RP_PTPL_MASK
NVME_FEAT_WP_WPS_SHIFT
NVME_FEAT_WP_WPS_MASK
NVME_FEAT_IOCSP_IOCSCI_SHIFT
NVME_FEAT_IOCSP_IOCSCI_MASK
NVME_FEAT_FDP_ENABLED_SHIFT
NVME_FEAT_FDP_ENABLED_MASK
NVME_FEAT_FDP_INDEX_SHIFT
NVME_FEAT_FDP_INDEX_MASK
NVME_FEAT_FDP_EVENTS_ENABLE_SHIFT
NVME_FEAT_FDP_EVENTS_ENABLE_MASK
-
enum
nvme_get_features_sel Get Features - Select
Constants
NVME_GET_FEATURES_SEL_CURRENTCurrent value
NVME_GET_FEATURES_SEL_DEFAULTDefault value
NVME_GET_FEATURES_SEL_SAVEDSaved value
NVME_GET_FEATURES_SEL_SUPPORTEDSupported capabilities
-
enum
nvme_cmd_format_mset Format NVM - Metadata Settings
Constants
NVME_FORMAT_MSET_SEPARATEindicates that the metadata is transferred as part of a separate buffer.
NVME_FORMAT_MSET_EXTENDEDindicates that the metadata is transferred as part of an extended data LBA.
-
enum
nvme_cmd_format_pi Format NVM - Protection Information
Constants
NVME_FORMAT_PI_DISABLEProtection information is not enabled.
NVME_FORMAT_PI_TYPE1Protection information is enabled, Type 1.
NVME_FORMAT_PI_TYPE2Protection information is enabled, Type 2.
NVME_FORMAT_PI_TYPE3Protection information is enabled, Type 3.
-
enum
nvme_cmd_format_pil Format NVM - Protection Information Location
Constants
NVME_FORMAT_PIL_LASTProtection information is transferred as the last bytes of metadata.
NVME_FORMAT_PIL_FIRSTProtection information is transferred as the first bytes of metadata.
-
enum
nvme_cmd_format_ses Format NVM - Secure Erase Settings
Constants
NVME_FORMAT_SES_NONENo secure erase operation requested.
NVME_FORMAT_SES_USER_DATA_ERASEUser Data Erase: All user data shall be erased, contents of the user data after the erase is indeterminate (e.g. the user data may be zero filled, one filled, etc.). If a User Data Erase is requested and all affected user data is encrypted, then the controller is allowed to use a cryptographic erase to perform the requested User Data Erase.
NVME_FORMAT_SES_CRYPTO_ERASECryptographic Erase: All user data shall be erased cryptographically. This is accomplished by deleting the encryption key.
-
enum
nvme_ns_mgmt_sel Namespace Management - Select
Constants
NVME_NS_MGMT_SEL_CREATENamespace Create selection
NVME_NS_MGMT_SEL_DELETENamespace Delete selection
-
enum
nvme_ns_attach_sel Namespace Attachment - Select
Constants
NVME_NS_ATTACH_SEL_CTRL_ATTACHNamespace attach selection
NVME_NS_ATTACH_SEL_CTRL_DEATTACHNamespace detach selection
-
enum
nvme_fw_commit_ca Firmware Commit - Commit Action
Constants
NVME_FW_COMMIT_CA_REPLACEDownloaded image replaces the existing image, if any, in the specified Firmware Slot. The newly placed image is not activated.
NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATEDownloaded image replaces the existing image, if any, in the specified Firmware Slot. The newly placed image is activated at the next Controller Level Reset.
NVME_FW_COMMIT_CA_SET_ACTIVEThe existing image in the specified Firmware Slot is activated at the next Controller Level Reset.
NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATEDownloaded image replaces the existing image, if any, in the specified Firmware Slot and is then activated immediately. If there is not a newly downloaded image, then the existing image in the specified firmware slot is activated immediately.
NVME_FW_COMMIT_CA_REPLACE_BOOT_PARTITIONDownloaded image replaces the Boot Partition specified by the Boot Partition ID field.
NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITIONMark the Boot Partition specified in the BPID field as active and update BPINFO.ABPID.
-
enum
nvme_directive_dtype Directive Types
Constants
NVME_DIRECTIVE_DTYPE_IDENTIFYIdentify directive type
NVME_DIRECTIVE_DTYPE_STREAMSStreams directive type
-
enum
nvme_directive_receive_doper Directive Receive Directive Operation
Constants
NVME_DIRECTIVE_RECEIVE_IDENTIFY_DOPER_PARAM
NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_PARAM
NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_STATUS
NVME_DIRECTIVE_RECEIVE_STREAMS_DOPER_RESOURCE
-
enum
nvme_directive_send_doper Directive Send Directive Operation
Constants
NVME_DIRECTIVE_SEND_IDENTIFY_DOPER_ENDIR
NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_IDENTIFIER
NVME_DIRECTIVE_SEND_STREAMS_DOPER_RELEASE_RESOURCE
-
enum
nvme_directive_send_identify_endir Enable Directive
Constants
NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_DISABLE
NVME_DIRECTIVE_SEND_IDENTIFY_ENDIR_ENABLE
-
enum
nvme_sanitize_sanact Sanitize Action
Constants
NVME_SANITIZE_SANACT_EXIT_FAILUREExit Failure Mode.
NVME_SANITIZE_SANACT_START_BLOCK_ERASEStart a Block Erase sanitize operation.
NVME_SANITIZE_SANACT_START_OVERWRITEStart an Overwrite sanitize operation.
NVME_SANITIZE_SANACT_START_CRYPTO_ERASEStart a Crypto Erase sanitize operation.
-
enum
nvme_dst_stc Action taken by the Device Self-test command
Constants
NVME_DST_STC_SHORTStart a short device self-test operation
NVME_DST_STC_LONGStart an extended device self-test operation
NVME_DST_STC_VSStart a vendor specific device self-test operation
NVME_DST_STC_ABORTAbort device self-test operation
-
enum
nvme_virt_mgmt_act Virtualization Management - Action
Constants
NVME_VIRT_MGMT_ACT_PRIM_CTRL_FLEX_ALLOCPrimary Controller Flexible Allocation
NVME_VIRT_MGMT_ACT_OFFLINE_SEC_CTRLSecondary Controller Offline
NVME_VIRT_MGMT_ACT_ASSIGN_SEC_CTRLSecondary Controller Assign
NVME_VIRT_MGMT_ACT_ONLINE_SEC_CTRLSecondary Controller Online
-
enum
nvme_virt_mgmt_rt Virtualization Management - Resource Type
Constants
NVME_VIRT_MGMT_RT_VQ_RESOURCEVQ Resources
NVME_VIRT_MGMT_RT_VI_RESOURCEVI Resources
-
enum
nvme_ns_write_protect_cfg Write Protection - Write Protection State
Constants
NVME_NS_WP_CFG_NONENo Write Protect
NVME_NS_WP_CFG_PROTECTWrite Protect
NVME_NS_WP_CFG_PROTECT_POWER_CYCLEWrite Protect Until Power Cycle
NVME_NS_WP_CFG_PROTECT_PERMANENTPermanent Write Protect
-
enum
nvme_log_ana_lsp Asymmetric Namespace Access - Return Groups Only
Constants
NVME_LOG_ANA_LSP_RGO_NAMESPACES
NVME_LOG_ANA_LSP_RGO_GROUPS_ONLY
-
enum
nvme_log_phy_rx_eom_action Physical Interface Receiver Eye Opening Measurement Action
Constants
NVME_LOG_PHY_RX_EOM_READRead Log Data
NVME_LOG_PHY_RX_EOM_START_READStart Measurement and Read Log Data
NVME_LOG_PHY_RX_EOM_ABORT_CLEARAbort Measurement and Clear Log Data
-
enum
nvme_log_phy_rx_eom_quality Physical Interface Receiver Eye Opening Measurement Quality
Constants
NVME_LOG_PHY_RX_EOM_GOOD<= Better Quality
NVME_LOG_PHY_RX_EOM_BETTER<= Best Quality, >= Good Quality
NVME_LOG_PHY_RX_EOM_BEST>= Better Quality
-
enum
nvme_pevent_log_action Persistent Event Log - Action
Constants
NVME_PEVENT_LOG_READRead Log Data
NVME_PEVENT_LOG_EST_CTX_AND_READEstablish Context and Read Log Data
NVME_PEVENT_LOG_RELEASE_CTXRelease Context
-
enum
nvme_feat_tmpthresh_thsel Temperature Threshold - Threshold Type Select
Constants
NVME_FEATURE_TEMPTHRESH_THSEL_OVEROver temperature threshold select
NVME_FEATURE_TEMPTHRESH_THSEL_UNDERUnder temperature threshold select
-
enum
nvme_features_async_event_config_flags Asynchronous Event Configuration configuration flags
Constants
NVME_FEATURE_AENCFG_SMART_CRIT_SPARE
NVME_FEATURE_AENCFG_SMART_CRIT_TEMPERATURE
NVME_FEATURE_AENCFG_SMART_CRIT_DEGRADED
NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY
NVME_FEATURE_AENCFG_SMART_CRIT_VOLATILE_BACKUP
NVME_FEATURE_AENCFG_SMART_CRIT_READ_ONLY_PMR
NVME_FEATURE_AENCFG_NOTICE_NAMESPACE_ATTRIBUTES
NVME_FEATURE_AENCFG_NOTICE_FIRMWARE_ACTIVATION
NVME_FEATURE_AENCFG_NOTICE_TELEMETRY_LOG
NVME_FEATURE_AENCFG_NOTICE_ANA_CHANGE
NVME_FEATURE_AENCFG_NOTICE_PL_EVENT
NVME_FEATURE_AENCFG_NOTICE_LBA_STATUS
NVME_FEATURE_AENCFG_NOTICE_EG_EVENT
NVME_FEATURE_AENCFG_NOTICE_DISCOVERY_CHANGE
-
enum
nvme_feat_plm_window_select Predictable Latency Per NVM Set Log
Constants
NVME_FEATURE_PLM_DTWINDeterministic Window select
NVME_FEATURE_PLM_NDWINNon-Deterministic Window select
-
enum
nvme_feat_resv_notify_flags Reservation Notification Configuration
Constants
NVME_FEAT_RESV_NOTIFY_REGPREMask Registration Preempted Notification
NVME_FEAT_RESV_NOTIFY_RESRELMask Reservation Released Notification
NVME_FEAT_RESV_NOTIFY_RESPREMask Reservation Preempted Notification
-
enum
nvme_feat_nswpcfg_state Write Protection - Write Protection State
Constants
NVME_FEAT_NS_NO_WRITE_PROTECTNo Write Protect
NVME_FEAT_NS_WRITE_PROTECTWrite Protect
NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLEWrite Protect Until Power Cycle
NVME_FEAT_NS_WRITE_PROTECT_PERMANENTPermanent Write Protect
-
enum
nvme_fctype Fabrics Command Types
Constants
nvme_fabrics_type_property_setProperty set
nvme_fabrics_type_connectConnect
nvme_fabrics_type_property_getProperty Get
nvme_fabrics_type_auth_sendAuthentication Send
nvme_fabrics_type_auth_receiveAuthentication Receive
nvme_fabrics_type_disconnectDisconnect
-
enum
nvme_data_tfr Data transfer direction of the command
Constants
NVME_DATA_TFR_NO_DATA_TFRNo data transfer
NVME_DATA_TFR_HOST_TO_CTRLHost to controller
NVME_DATA_TFR_CTRL_TO_HOSTController to host
NVME_DATA_TFR_BIDIRECTIONALBidirectional
-
enum
nvme_io_opcode Opcodes for I/O Commands
Constants
nvme_cmd_flushFlush
nvme_cmd_writeWrite
nvme_cmd_readRead
nvme_cmd_write_uncorWrite Uncorrectable
nvme_cmd_compareCompare
nvme_cmd_write_zeroeswrite Zeros
nvme_cmd_dsmDataset Management
nvme_cmd_verifyVerify
nvme_cmd_resv_registerReservation Register
nvme_cmd_resv_reportReservation Report
nvme_cmd_resv_acquireReservation Acquire
nvme_cmd_io_mgmt_recvI/O Management Receive
nvme_cmd_resv_releaseReservation Release
nvme_cmd_copyCopy
nvme_cmd_io_mgmt_sendI/O Management Send
nvme_zns_cmd_mgmt_sendZone Management Send
nvme_zns_cmd_mgmt_recvZone Management Receive
nvme_zns_cmd_appendZone Append
-
enum
nvme_io_control_flags I/O control flags
Constants
NVME_IO_DTYPE_STREAMSDirective Type Streams
NVME_IO_STCStorage Tag Check
NVME_IO_DEACDeallocate
NVME_IO_ZNS_APPEND_PIREMAPProtection Information Remap
NVME_IO_PRINFO_PRCHK_REFProtection Information Check Reference Tag
NVME_IO_PRINFO_PRCHK_APPProtection Information Check Application Tag
NVME_IO_PRINFO_PRCHK_GUARDProtection Information Check Guard field
NVME_IO_PRINFO_PRACTProtection Information Action
NVME_IO_FUAForce Unit Access
NVME_IO_LRLimited Retry
-
enum
nvme_io_dsm_flags Dataset Management flags
Constants
NVME_IO_DSM_FREQ_UNSPECNo frequency information provided
NVME_IO_DSM_FREQ_TYPICALTypical number of reads and writes expected for this LBA range
NVME_IO_DSM_FREQ_RAREInfrequent writes and infrequent reads to the LBA range indicated
NVME_IO_DSM_FREQ_READSInfrequent writes and frequent reads to the LBA range indicated
NVME_IO_DSM_FREQ_WRITESFrequent writes and infrequent reads to the LBA range indicated
NVME_IO_DSM_FREQ_RWFrequent writes and frequent reads to the LBA range indicated
NVME_IO_DSM_FREQ_ONCE
NVME_IO_DSM_FREQ_PREFETCH
NVME_IO_DSM_FREQ_TEMP
NVME_IO_DSM_LATENCY_NONENo latency information provided
NVME_IO_DSM_LATENCY_IDLELonger latency acceptable
NVME_IO_DSM_LATENCY_NORMTypical latency
NVME_IO_DSM_LATENCY_LOWSmallest possible latency
NVME_IO_DSM_SEQ_REQ
NVME_IO_DSM_COMPRESSED
-
enum
nvme_dsm_attributes Dataset Management attributes
Constants
NVME_DSMGMT_IDRAttribute -Integral Dataset for Read
NVME_DSMGMT_IDWAttribute - Integral Dataset for Write
NVME_DSMGMT_ADAttribute - Deallocate
-
enum
nvme_resv_rtype Reservation Type Encoding
Constants
NVME_RESERVATION_RTYPE_WEWrite Exclusive Reservation
NVME_RESERVATION_RTYPE_EAExclusive Access Reservation
NVME_RESERVATION_RTYPE_WEROWrite Exclusive - Registrants Only Reservation
NVME_RESERVATION_RTYPE_EAROExclusive Access - Registrants Only Reservation
NVME_RESERVATION_RTYPE_WEARWrite Exclusive - All Registrants Reservation
NVME_RESERVATION_RTYPE_EAARExclusive Access - All Registrants Reservation
-
enum
nvme_resv_racqa Reservation Acquire - Reservation Acquire Action
Constants
NVME_RESERVATION_RACQA_ACQUIREAcquire
NVME_RESERVATION_RACQA_PREEMPTPreempt
NVME_RESERVATION_RACQA_PREEMPT_AND_ABORTPreempt and Abort
-
enum
nvme_resv_rrega Reservation Register - Reservation Register Action
Constants
NVME_RESERVATION_RREGA_REGISTER_KEYRegister Reservation Key
NVME_RESERVATION_RREGA_UNREGISTER_KEYUnregister Reservation Key
NVME_RESERVATION_RREGA_REPLACE_KEYReplace Reservation Key
-
enum
nvme_resv_cptpl Reservation Register - Change Persist Through Power Loss State
Constants
NVME_RESERVATION_CPTPL_NO_CHANGENo change to PTPL state
NVME_RESERVATION_CPTPL_CLEARReservations are released and registrants are cleared on a power on
NVME_RESERVATION_CPTPL_PERSISTReservations and registrants persist across a power loss
-
enum
nvme_resv_rrela Reservation Release - Reservation Release Action
Constants
NVME_RESERVATION_RRELA_RELEASERelease
NVME_RESERVATION_RRELA_CLEARClear
-
enum
nvme_zns_send_action Zone Management Send - Zone Send Action
Constants
NVME_ZNS_ZSA_CLOSEClose Zone
NVME_ZNS_ZSA_FINISHFinish Zone
NVME_ZNS_ZSA_OPENOpen Zone
NVME_ZNS_ZSA_RESETReset Zone
NVME_ZNS_ZSA_OFFLINEOffline Zone
NVME_ZNS_ZSA_SET_DESC_EXTSet Zone Descriptor Extension
NVME_ZNS_ZSA_ZRWA_FLUSHFlush
-
enum
nvme_zns_recv_action Zone Management Receive - Zone Receive Action Specific Features
Constants
NVME_ZNS_ZRA_REPORT_ZONESReport Zones
NVME_ZNS_ZRA_EXTENDED_REPORT_ZONESExtended Report Zones
-
enum
nvme_zns_report_options Zone Management Receive - Zone Receive Action Specific Field
Constants
NVME_ZNS_ZRAS_REPORT_ALLList all zones
NVME_ZNS_ZRAS_REPORT_EMPTYList the zones in the ZSE:Empty state
NVME_ZNS_ZRAS_REPORT_IMPL_OPENEDList the zones in the ZSIO:Implicitly Opened state
NVME_ZNS_ZRAS_REPORT_EXPL_OPENEDList the zones in the ZSEO:Explicitly Opened state
NVME_ZNS_ZRAS_REPORT_CLOSEDList the zones in the ZSC:Closed state
NVME_ZNS_ZRAS_REPORT_FULLList the zones in the ZSF:Full state
NVME_ZNS_ZRAS_REPORT_READ_ONLYList the zones in the ZSRO:Read Only state
NVME_ZNS_ZRAS_REPORT_OFFLINEList the zones in the ZSO:Offline state
-
enum
nvme_io_mgmt_recv_mo I/O Management Receive - Management Operation
Constants
NVME_IO_MGMT_RECV_RUH_STATUSReclaim Unit Handle Status
-
enum
nvme_io_mgmt_send_mo I/O Management Send - Management Operation
Constants
NVME_IO_MGMT_SEND_RUH_UPDATEReclaim Unit Handle Update
-
struct
nvme_ns_mgmt_host_sw_specified Namespace management Host Software Specified Fields.
Definition
struct nvme_ns_mgmt_host_sw_specified {
__le64 nsze;
__le64 ncap;
__u8 rsvd16[10];
__u8 flbas;
__u8 rsvd27[2];
__u8 dps;
__u8 nmic;
__u8 rsvd31[61];
__le32 anagrpid;
__u8 rsvd96[4];
__le16 nvmsetid;
__le16 endgid;
__u8 rsvd104[280];
__le64 lbstm;
__le16 nphndls;
__u8 rsvd394[105];
union {
__u8 rsvd499[13];
struct {
__u8 znsco;
__le32 rar;
__le32 ror;
__le32 rnumzrwa;
} zns;
};
__le16 phndl[128];
__u8 rsvd768[3328];
};
Members
nszeNamespace Size indicates the total size of the namespace in logical blocks. The number of logical blocks is based on the formatted LBA size.
ncapNamespace Capacity indicates the maximum number of logical blocks that may be allocated in the namespace at any point in time. The number of logical blocks is based on the formatted LBA size.
rsvd16Reserved
flbasFormatted LBA Size, see
enum nvme_id_ns_flbas.rsvd27Reserved
dpsEnd-to-end Data Protection Type Settings, see
enum nvme_id_ns_dps.nmicNamespace Multi-path I/O and Namespace Sharing Capabilities, see
enum nvme_id_ns_nmic.rsvd31Reserved
anagrpidANA Group Identifier indicates the ANA Group Identifier of the ANA group of which the namespace is a member.
rsvd96Reserved
nvmsetidNVM Set Identifier indicates the NVM Set with which this namespace is associated.
endgidEndurance Group Identifier indicates the Endurance Group with which this namespace is associated.
rsvd104Reserved
lbstmLogical Block Storage Tag Mask Identifies the mask for the Storage Tag field for the protection information
nphndlsNumber of Placement Handles specifies the number of Placement Handles included in the Placement Handle List
rsvd394Reserved
{unnamed_union}anonymous
rsvd499Reserved for I/O Command Sets that extend this specification.
znsrsvd499( Zoned Namespace Command Set specific field )
phndlPlacement Handle Associated RUH : This field specifies the Reclaim Unit Handle Identifier to be associated with the Placement Handle value. If the Flexible Data Placement capability is not supported or not enabled in specified Endurance Group, then the controller shall ignore this field.
rsvd768Reserved