title: nvme_fdp_ruha(2)

summary: Reclaim Unit Handle Attributes

text:
# nvme_fdp_ruha(2)

## NAME
enum nvme_fdp_ruha - Reclaim Unit Handle Attributes

## SYNOPSIS
enum nvme_fdp_ruha {

NVME_FDP_RUHA_HOST_SHIFT ,

NVME_FDP_RUHA_HOST_MASK ,

NVME_FDP_RUHA_CTRL_SHIFT ,

NVME_FDP_RUHA_CTRL_MASK

};

## Constants
NVME_FDP_RUHA_HOST_SHIFT

Host Specified Reclaim Unit Handle Shift

NVME_FDP_RUHA_HOST_MASK

Host Specified Reclaim Unit Handle Mask

NVME_FDP_RUHA_CTRL_SHIFT

Controller Specified Reclaim Unit Handle Shift

NVME_FDP_RUHA_CTRL_MASK

Controller Specified Reclaim Unit Handle Mask


package: libnvme-devel

title: nvme_fdp_ruhu_desc(2)

summary: Reclaim Unit Handle Usage Descriptor

text:
# nvme_fdp_ruhu_desc(2)

## NAME
struct nvme_fdp_ruhu_desc - Reclaim Unit Handle Usage Descriptor

## SYNOPSIS
struct nvme_fdp_ruhu_desc {

__u8 ruha;

__u8 rsvd1[7];

};

## Members
ruha

Reclaim Unit Handle Attributes (enum nvme_fdp_ruha)

rsvd1

Reserved


title: nvme_fdp_ruhu_log(2)

summary: Reclaim Unit Handle Usage Log Page

text:
# nvme_fdp_ruhu_log(2)

## NAME
struct nvme_fdp_ruhu_log - Reclaim Unit Handle Usage Log Page

## SYNOPSIS
struct nvme_fdp_ruhu_log {

__le16 nruh;

__u8 rsvd2[6];

struct nvme_fdp_ruhu_desc ruhus[];

};

## Members
nruh

Number of Reclaim Unit Handles

rsvd2

Reserved

ruhus

Reclaim Unit Handle Usage descriptors


title: nvme_fdp_stats_log(2)

summary: FDP Statistics Log Page

text:
# nvme_fdp_stats_log(2)

## NAME
struct nvme_fdp_stats_log - FDP Statistics Log Page

## SYNOPSIS
struct nvme_fdp_stats_log {

__u8 hbmw[16];

__u8 mbmw[16];

__u8 mbe[16];

__u8 rsvd48[16];

};

## Members
hbmw

Host Bytes with Metadata Written

mbmw

Media Bytes with Metadata Written

mbe

Media Bytes Erased

rsvd48

Reserved


title: nvme_fdp_supported_event_attributes(2)

summary: Supported FDP Event Attributes

text:
# nvme_fdp_supported_event_attributes(2)

## NAME
enum nvme_fdp_supported_event_attributes - Supported FDP Event Attributes

## SYNOPSIS
enum nvme_fdp_supported_event_attributes {

NVME_FDP_SUPP_EVENT_ENABLED_SHIFT ,

NVME_FDP_SUPP_EVENT_ENABLED_MASK

};

## Constants
NVME_FDP_SUPP_EVENT_ENABLED_SHIFT

FDP Event Enable Shift

NVME_FDP_SUPP_EVENT_ENABLED_MASK

FDP Event Enable Mask


title: nvme_fdp_supported_event_desc(2)

summary: Supported FDP Event Descriptor

text:
# nvme_fdp_supported_event_desc(2)

## NAME
struct nvme_fdp_supported_event_desc - Supported FDP Event Descriptor

## SYNOPSIS
struct nvme_fdp_supported_event_desc {

__u8 evt;

__u8 evta;

};

## Members
evt

FDP Event Type

evta

FDP Event Type Attributes (enum nvme_fdp_supported_event_attributes)


title: nvme_feat(2)

summary: Features Access Shifts/Masks values

text:
# nvme_feat(2)

## NAME
enum nvme_feat - Features Access Shifts/Masks values

## SYNOPSIS
enum nvme_feat {

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_TT_TMPTHH_SHIFT ,

NVME_FEAT_TT_TMPTHH_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_AE_NNSSHDN_SHIFT ,

NVME_FEAT_AE_NNSSHDN_MASK ,

NVME_FEAT_AE_TTHRY_SHIFT ,

NVME_FEAT_AE_TTHRY_MASK ,

NVME_FEAT_AE_RASSN_SHIFT ,

NVME_FEAT_AE_RASSN_MASK ,

NVME_FEAT_AE_RGRP0_SHIFT ,

NVME_FEAT_AE_RGRP0_MASK ,

NVME_FEAT_AE_ANSAN_SHIFT ,

NVME_FEAT_AE_ANSAN_MASK ,

NVME_FEAT_AE_ZDCN_SHIFT ,

NVME_FEAT_AE_ZDCN_MASK ,

NVME_FEAT_AE_PMDRLPCN_SHIFT ,

NVME_FEAT_AE_PMDRLPCN_MASK ,

NVME_FEAT_AE_ADLPCN_SHIFT ,

NVME_FEAT_AE_ADLPCN_MASK ,

NVME_FEAT_AE_HDLPCN_SHIFT ,

NVME_FEAT_AE_HDLPCN_MASK ,

NVME_FEAT_AE_DLPCN_SHIFT ,

NVME_FEAT_AE_DLPCN_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_FDPE_PHNDL_SHIFT ,

NVME_FEAT_FDPE_PHNDL_MASK ,

NVME_FEAT_FDPE_NOET_SHIFT ,

NVME_FEAT_FDPE_NOET_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_SPINUP_CONTROL_SHIFT ,

NVME_FEAT_SPINUP_CONTROL_MASK ,

NVME_FEAT_PLS_MODE_SHIFT ,

NVME_FEAT_PLS_MODE_MASK ,

NVME_FEAT_PERFC_ATTRI_SHIFT ,

NVME_FEAT_PERFC_ATTRI_MASK ,

NVME_FEAT_PERFC_RVSPA_SHIFT ,

NVME_FEAT_PERFC_RVSPA_MASK ,

NVME_FEAT_PERFC_ATTRTYP_SHIFT ,

NVME_FEAT_PERFC_ATTRTYP_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 ,

NVME_FEAT_BPWPC_BP0WPS_SHIFT ,

NVME_FEAT_BPWPC_BP0WPS_MASK ,

NVME_FEAT_BPWPC_BP1WPS_SHIFT ,

NVME_FEAT_BPWPC_BP1WPS_MASK

};

## 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_TT_TMPTHH_SHIFT

NVME_FEAT_TT_TMPTHH_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_AE_NNSSHDN_SHIFT

NVME_FEAT_AE_NNSSHDN_MASK

NVME_FEAT_AE_TTHRY_SHIFT

NVME_FEAT_AE_TTHRY_MASK

NVME_FEAT_AE_RASSN_SHIFT

NVME_FEAT_AE_RASSN_MASK

NVME_FEAT_AE_RGRP0_SHIFT

NVME_FEAT_AE_RGRP0_MASK

NVME_FEAT_AE_ANSAN_SHIFT

NVME_FEAT_AE_ANSAN_MASK

NVME_FEAT_AE_ZDCN_SHIFT

NVME_FEAT_AE_ZDCN_MASK

NVME_FEAT_AE_PMDRLPCN_SHIFT

NVME_FEAT_AE_PMDRLPCN_MASK

NVME_FEAT_AE_ADLPCN_SHIFT

NVME_FEAT_AE_ADLPCN_MASK

NVME_FEAT_AE_HDLPCN_SHIFT

NVME_FEAT_AE_HDLPCN_MASK

NVME_FEAT_AE_DLPCN_SHIFT

NVME_FEAT_AE_DLPCN_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_FDPE_PHNDL_SHIFT

NVME_FEAT_FDPE_PHNDL_MASK

NVME_FEAT_FDPE_NOET_SHIFT

NVME_FEAT_FDPE_NOET_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_SPINUP_CONTROL_SHIFT

NVME_FEAT_SPINUP_CONTROL_MASK

NVME_FEAT_PLS_MODE_SHIFT

NVME_FEAT_PLS_MODE_MASK

NVME_FEAT_PERFC_ATTRI_SHIFT

NVME_FEAT_PERFC_ATTRI_MASK

NVME_FEAT_PERFC_RVSPA_SHIFT

NVME_FEAT_PERFC_RVSPA_MASK

NVME_FEAT_PERFC_ATTRTYP_SHIFT

NVME_FEAT_PERFC_ATTRTYP_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

NVME_FEAT_BPWPC_BP0WPS_SHIFT

NVME_FEAT_BPWPC_BP0WPS_MASK

NVME_FEAT_BPWPC_BP1WPS_SHIFT

NVME_FEAT_BPWPC_BP1WPS_MASK


title: nvme_feat_auto_pst(2)

summary: Autonomous Power State Transition

text:
# nvme_feat_auto_pst(2)

## NAME
struct nvme_feat_auto_pst - Autonomous Power State Transition

## SYNOPSIS
struct nvme_feat_auto_pst {

__le64 apst_entry[32];

};

## Members
apst_entry

See enum nvme_apst_entry


title: nvme_feat_bpwp_state(2)

summary: Boot Partition Write Protection State

text:
# nvme_feat_bpwp_state(2)

## NAME
enum nvme_feat_bpwp_state - Boot Partition Write Protection State

## SYNOPSIS
enum nvme_feat_bpwp_state {

NVME_FEAT_BPWPS_CHANGE_NOT_REQUESTED ,

NVME_FEAT_BPWPS_WRITE_UNLOCKED ,

NVME_FEAT_BPWPS_WRITE_LOCKED ,

NVME_FEAT_BPWPS_WRITE_LOCKED_PWR_CYCLE ,

NVME_FEAT_BPWPS_WRITE_PROTECTION_RPMB

};

## Constants
NVME_FEAT_BPWPS_CHANGE_NOT_REQUESTED

Change in state not requested

NVME_FEAT_BPWPS_WRITE_UNLOCKED

Write Unlocked

NVME_FEAT_BPWPS_WRITE_LOCKED

Write Locked

NVME_FEAT_BPWPS_WRITE_LOCKED_PWR_CYCLE

Write Locked Until Power Cycle

NVME_FEAT_BPWPS_WRITE_PROTECTION_RPMB

Write Protection controlled by RPMB


title: nvme_feat_fdp_events_cdw11(2)

text:
# nvme_feat_fdp_events_cdw11(2)

## NAME
struct nvme_feat_fdp_events_cdw11 - FDP Events Feature Command Dword 11 Deprecated: doesn't support this struct. Use NVME_FEAT_FDPE_*** definitions instead.

## SYNOPSIS
struct nvme_feat_fdp_events_cdw11 {

__le16 phndl;

__u8 noet;

__u8 rsvd24;

};

## Members
phndl

Placement Handle

noet

Number of FDP Event Types

rsvd24

Reserved


title: nvme_feat_host_behavior(2)

summary: Host Behavior Support - Data Structure

text:
# nvme_feat_host_behavior(2)

## NAME
struct nvme_feat_host_behavior - Host Behavior Support - Data Structure

## SYNOPSIS
struct nvme_feat_host_behavior {

__u8 acre;

__u8 etdas;

__u8 lbafee;

__u8 hdisns;

__le16 cdfe;

__u8 rsvd6[506];

};

## Members
acre

Advanced Command Retry Enable

etdas

Extended Telemetry Data Area 4 Supported

lbafee

LBA Format Extension Enable

hdisns

Host Dispersed Namespace Support

cdfe

Copy Descriptor Formats Enable

rsvd6

Reserved


title: nvme_feat_nswpcfg_state(2)

text:
# nvme_feat_nswpcfg_state(2)

## NAME
enum nvme_feat_nswpcfg_state - Write Protection - Write Protection State

## SYNOPSIS
enum nvme_feat_nswpcfg_state {

NVME_FEAT_NS_NO_WRITE_PROTECT ,

NVME_FEAT_NS_WRITE_PROTECT ,

NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLE ,

NVME_FEAT_NS_WRITE_PROTECT_PERMANENT

};

## Constants
NVME_FEAT_NS_NO_WRITE_PROTECT

No Write Protect

NVME_FEAT_NS_WRITE_PROTECT

Write Protect

NVME_FEAT_NS_WRITE_PROTECT_PWR_CYCLE

Write Protect Until Power Cycle

NVME_FEAT_NS_WRITE_PROTECT_PERMANENT

Permanent Write Protect


title: nvme_feat_perfc_attri(2)

text:
# nvme_feat_perfc_attri(2)

## NAME
enum nvme_feat_perfc_attri - performance characteristics attribute index

## SYNOPSIS
enum nvme_feat_perfc_attri {

NVME_FEAT_PERFC_ATTRI_STD ,

NVME_FEAT_PERFC_ATTRI_ID_LIST ,

NVME_FEAT_PERFC_ATTRI_VS_MIN ,

NVME_FEAT_PERFC_ATTRI_VS_MAX

};

## Constants
NVME_FEAT_PERFC_ATTRI_STD

standard performance attribute

NVME_FEAT_PERFC_ATTRI_ID_LIST

performance attribute identifier list

NVME_FEAT_PERFC_ATTRI_VS_MIN

vendor specific performance attribute minimum index

NVME_FEAT_PERFC_ATTRI_VS_MAX

vendor specific performance attribute maximum index


title: nvme_feat_perfc_r4karl(2)

text:
# nvme_feat_perfc_r4karl(2)

## NAME
enum nvme_feat_perfc_r4karl - standard performance attribute random 4 kib average latency

## SYNOPSIS
enum nvme_feat_perfc_r4karl {

NVME_FEAT_PERFC_R4KARL_NO_REPORT ,

NVME_FEAT_PERFC_R4KARL_GE_100_SEC ,

NVME_FEAT_PERFC_R4KARL_GE_50_SEC ,

NVME_FEAT_PERFC_R4KARL_GE_10_SEC ,

NVME_FEAT_PERFC_R4KARL_GE_5_SEC ,

NVME_FEAT_PERFC_R4KARL_GE_1_SEC ,

NVME_FEAT_PERFC_R4KARL_GE_500_MS ,

NVME_FEAT_PERFC_R4KARL_GE_100_MS ,

NVME_FEAT_PERFC_R4KARL_GE_50_MS ,

NVME_FEAT_PERFC_R4KARL_GE_10_MS ,

NVME_FEAT_PERFC_R4KARL_GE_5_MS ,

NVME_FEAT_PERFC_R4KARL_GE_1_MS ,

NVME_FEAT_PERFC_R4KARL_GE_500_US ,

NVME_FEAT_PERFC_R4KARL_GE_100_US ,

NVME_FEAT_PERFC_R4KARL_GE_50_US ,

NVME_FEAT_PERFC_R4KARL_GE_10_US ,

NVME_FEAT_PERFC_R4KARL_GE_5_US ,

NVME_FEAT_PERFC_R4KARL_GE_1_US ,

NVME_FEAT_PERFC_R4KARL_GE_500_NS ,

NVME_FEAT_PERFC_R4KARL_GE_100_NS ,

NVME_FEAT_PERFC_R4KARL_GE_50_NS ,

NVME_FEAT_PERFC_R4KARL_GE_10_NS ,

NVME_FEAT_PERFC_R4KARL_GE_5_NS ,

NVME_FEAT_PERFC_R4KARL_GE_1_NS

};

## Constants
NVME_FEAT_PERFC_R4KARL_NO_REPORT

not reported

NVME_FEAT_PERFC_R4KARL_GE_100_SEC

greater than or equal to 100 secs

NVME_FEAT_PERFC_R4KARL_GE_50_SEC

greater than or equal to 50 secs and less than 100 secs

NVME_FEAT_PERFC_R4KARL_GE_10_SEC

greater than or equal to 10 secs and less than 50 secs

NVME_FEAT_PERFC_R4KARL_GE_5_SEC

greater than or equal to 5 secs and less than 10 secs

NVME_FEAT_PERFC_R4KARL_GE_1_SEC

greater than or equal to 1 sec and less than 5 secs

NVME_FEAT_PERFC_R4KARL_GE_500_MS

greater than or equal to 500 msecs and less than 1 sec

NVME_FEAT_PERFC_R4KARL_GE_100_MS

greater than or equal to 100 msecs and less than 500 msecs

NVME_FEAT_PERFC_R4KARL_GE_50_MS

greater than or equal to 50 msecs and less than 100 msecs

NVME_FEAT_PERFC_R4KARL_GE_10_MS

greater than or equal to 10 msecs and less than 50 msecs

NVME_FEAT_PERFC_R4KARL_GE_5_MS

greater than or equal to 5 msecs and less than 10 msecs

NVME_FEAT_PERFC_R4KARL_GE_1_MS

greater than or equal to 1 msec and less than 5 msecs

NVME_FEAT_PERFC_R4KARL_GE_500_US

greater than or equal to 500 usecs and less than 1 msec

NVME_FEAT_PERFC_R4KARL_GE_100_US

greater than or equal to 100 usecs and less than 500 usecs

NVME_FEAT_PERFC_R4KARL_GE_50_US

greater than or equal to 50 usecs and less than 100 usecs

NVME_FEAT_PERFC_R4KARL_GE_10_US

greater than or equal to 10 usecs and less than 50 usecs

NVME_FEAT_PERFC_R4KARL_GE_5_US

greater than or equal to 5 usecs and less than 10 usecs

NVME_FEAT_PERFC_R4KARL_GE_1_US

greater than or equal to 1 usec and less than 5 usecs

NVME_FEAT_PERFC_R4KARL_GE_500_NS

greater than or equal to 500 nsecs and less than 1 usec

NVME_FEAT_PERFC_R4KARL_GE_100_NS

greater than or equal to 100 nsecs and less than 500 nsecs

NVME_FEAT_PERFC_R4KARL_GE_50_NS

greater than or equal to 50 nsecs and less than 100 nsecs

NVME_FEAT_PERFC_R4KARL_GE_10_NS

greater than or equal to 10 nsecs and less than 50 nsecs

NVME_FEAT_PERFC_R4KARL_GE_5_NS

greater than or equal to 5 nsecs and less than 10 nsecs

NVME_FEAT_PERFC_R4KARL_GE_1_NS

greater than or equal to 1 nsec and less than 5 nsecs


title: nvme_feat_plm_window_select(2)

summary: Predictable Latency Per NVM Set Log

text:
# nvme_feat_plm_window_select(2)

## NAME
enum nvme_feat_plm_window_select - Predictable Latency Per NVM Set Log

## SYNOPSIS
enum nvme_feat_plm_window_select {

NVME_FEATURE_PLM_DTWIN ,

NVME_FEATURE_PLM_NDWIN

};

## Constants
NVME_FEATURE_PLM_DTWIN

Deterministic Window select

NVME_FEATURE_PLM_NDWIN

Non-Deterministic Window select


title: nvme_feat_resv_notify_flags(2)

summary: Reservation Notification Configuration

text:
# nvme_feat_resv_notify_flags(2)

## NAME
enum nvme_feat_resv_notify_flags - Reservation Notification Configuration

## SYNOPSIS
enum nvme_feat_resv_notify_flags {

NVME_FEAT_RESV_NOTIFY_REGPRE ,

NVME_FEAT_RESV_NOTIFY_RESREL ,

NVME_FEAT_RESV_NOTIFY_RESPRE

};

## Constants
NVME_FEAT_RESV_NOTIFY_REGPRE

Mask Registration Preempted Notification

NVME_FEAT_RESV_NOTIFY_RESREL

Mask Reservation Released Notification

NVME_FEAT_RESV_NOTIFY_RESPRE

Mask Reservation Preempted Notification


title: nvme_feat_tmpthresh_thsel(2)

text:
# nvme_feat_tmpthresh_thsel(2)

## NAME
enum nvme_feat_tmpthresh_thsel - Temperature Threshold - Threshold Type Select

## SYNOPSIS
enum nvme_feat_tmpthresh_thsel {

NVME_FEATURE_TEMPTHRESH_THSEL_OVER ,

NVME_FEATURE_TEMPTHRESH_THSEL_UNDER

};

## Constants
NVME_FEATURE_TEMPTHRESH_THSEL_OVER

Over temperature threshold select

NVME_FEATURE_TEMPTHRESH_THSEL_UNDER

Under temperature threshold select


text:
# nvme_features_async_event_config_flags(2)

## NAME
enum nvme_features_async_event_config_flags - Asynchronous Event Configuration configuration flags

## SYNOPSIS
enum nvme_features_async_event_config_flags {

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

};

## 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


title: nvme_features_id(2)

summary: Features - Feature Identifiers

text:
# nvme_features_id(2)

## NAME
enum nvme_features_id - Features - Feature Identifiers

## SYNOPSIS
enum nvme_features_id {

NVME_FEAT_FID_ARBITRATION ,

NVME_FEAT_FID_POWER_MGMT ,

NVME_FEAT_FID_LBA_RANGE ,

NVME_FEAT_FID_TEMP_THRESH ,

NVME_FEAT_FID_ERR_RECOVERY ,

NVME_FEAT_FID_VOLATILE_WC ,

NVME_FEAT_FID_NUM_QUEUES ,

NVME_FEAT_FID_IRQ_COALESCE ,

NVME_FEAT_FID_IRQ_CONFIG ,

NVME_FEAT_FID_WRITE_ATOMIC ,

NVME_FEAT_FID_ASYNC_EVENT ,

NVME_FEAT_FID_AUTO_PST ,

NVME_FEAT_FID_HOST_MEM_BUF ,

NVME_FEAT_FID_TIMESTAMP ,

NVME_FEAT_FID_KATO ,

NVME_FEAT_FID_HCTM ,

NVME_FEAT_FID_NOPSC ,

NVME_FEAT_FID_RRL ,

NVME_FEAT_FID_PLM_CONFIG ,

NVME_FEAT_FID_PLM_WINDOW ,

NVME_FEAT_FID_LBA_STS_INTERVAL ,

NVME_FEAT_FID_HOST_BEHAVIOR ,

NVME_FEAT_FID_SANITIZE ,

NVME_FEAT_FID_ENDURANCE_EVT_CFG ,

NVME_FEAT_FID_IOCS_PROFILE ,

NVME_FEAT_FID_SPINUP_CONTROL ,

NVME_FEAT_FID_POWER_LOSS_SIGNAL ,

NVME_FEAT_FID_PERF_CHARACTERISTICS ,

NVME_FEAT_FID_FDP ,

NVME_FEAT_FID_FDP_EVENTS ,

NVME_FEAT_FID_NS_ADMIN_LABEL ,

NVME_FEAT_FID_KEY_VALUE ,

NVME_FEAT_FID_CTRL_DATA_QUEUE ,

NVME_FEAT_FID_EMB_MGMT_CTRL_ADDR ,

NVME_FEAT_FID_HOST_MGMT_AGENT_ADDR ,

NVME_FEAT_FID_ENH_CTRL_METADATA ,

NVME_FEAT_FID_CTRL_METADATA ,

NVME_FEAT_FID_NS_METADATA ,

NVME_FEAT_FID_SW_PROGRESS ,

NVME_FEAT_FID_HOST_ID ,

NVME_FEAT_FID_RESV_MASK ,

NVME_FEAT_FID_RESV_PERSIST ,

NVME_FEAT_FID_WRITE_PROTECT ,

NVME_FEAT_FID_BP_WRITE_PROTECT

};

## Constants
NVME_FEAT_FID_ARBITRATION

Arbitration

NVME_FEAT_FID_POWER_MGMT

Power Management

NVME_FEAT_FID_LBA_RANGE

LBA Range Type

NVME_FEAT_FID_TEMP_THRESH

Temperature Threshold

NVME_FEAT_FID_ERR_RECOVERY

Error Recovery

NVME_FEAT_FID_VOLATILE_WC

Volatile Write Cache

NVME_FEAT_FID_NUM_QUEUES

Number of Queues

NVME_FEAT_FID_IRQ_COALESCE

Interrupt Coalescing

NVME_FEAT_FID_IRQ_CONFIG

Interrupt Vector Configuration

NVME_FEAT_FID_WRITE_ATOMIC

Write Atomicity Normal

NVME_FEAT_FID_ASYNC_EVENT

Asynchronous Event Configuration

NVME_FEAT_FID_AUTO_PST

Autonomous Power State Transition

NVME_FEAT_FID_HOST_MEM_BUF

Host Memory Buffer

NVME_FEAT_FID_TIMESTAMP

Timestamp

NVME_FEAT_FID_KATO

Keep Alive Timer

NVME_FEAT_FID_HCTM

Host Controlled Thermal Management

NVME_FEAT_FID_NOPSC

Non-Operational Power State Config

NVME_FEAT_FID_RRL

Read Recovery Level Config

NVME_FEAT_FID_PLM_CONFIG

Predictable Latency Mode Config

NVME_FEAT_FID_PLM_WINDOW

Predictable Latency Mode Window

NVME_FEAT_FID_LBA_STS_INTERVAL

LBA Status Information Report Interval

NVME_FEAT_FID_HOST_BEHAVIOR

Host Behavior Support

NVME_FEAT_FID_SANITIZE

Sanitize Config

NVME_FEAT_FID_ENDURANCE_EVT_CFG

Endurance Group Event Configuration

NVME_FEAT_FID_IOCS_PROFILE

I/O Command Set Profile

NVME_FEAT_FID_SPINUP_CONTROL

Spinup Control

NVME_FEAT_FID_POWER_LOSS_SIGNAL

Power Loss Signaling Config

NVME_FEAT_FID_PERF_CHARACTERISTICS

Performance Characteristics

NVME_FEAT_FID_FDP

Flexible Data Placement

NVME_FEAT_FID_FDP_EVENTS

FDP Events

NVME_FEAT_FID_NS_ADMIN_LABEL

Namespace Admin Label

NVME_FEAT_FID_KEY_VALUE

Key Value Configuration

NVME_FEAT_FID_CTRL_DATA_QUEUE

Controller Data Queue

NVME_FEAT_FID_EMB_MGMT_CTRL_ADDR

Embedded Management Controller Address

NVME_FEAT_FID_HOST_MGMT_AGENT_ADDR

Host Management Agent Address

NVME_FEAT_FID_ENH_CTRL_METADATA

Enhanced Controller Metadata

NVME_FEAT_FID_CTRL_METADATA

Controller Metadata

NVME_FEAT_FID_NS_METADATA

Namespace Metadata

NVME_FEAT_FID_SW_PROGRESS

Software Progress Marker

NVME_FEAT_FID_HOST_ID

Host Identifier

NVME_FEAT_FID_RESV_MASK

Reservation Notification Mask

NVME_FEAT_FID_RESV_PERSIST

Reservation Persistence

NVME_FEAT_FID_WRITE_PROTECT

Namespace Write Protection Config

NVME_FEAT_FID_BP_WRITE_PROTECT

Boot Partition Write Protection Config


title: nvme_fid_supported_effects(2)

text:
# nvme_fid_supported_effects(2)

## NAME
enum nvme_fid_supported_effects - FID Supported and Effects Data Structure definitions

## SYNOPSIS
enum nvme_fid_supported_effects {

NVME_FID_SUPPORTED_EFFECTS_FSUPP ,

NVME_FID_SUPPORTED_EFFECTS_UDCC ,

NVME_FID_SUPPORTED_EFFECTS_NCC ,

NVME_FID_SUPPORTED_EFFECTS_NIC ,

NVME_FID_SUPPORTED_EFFECTS_CCC ,

NVME_FID_SUPPORTED_EFFECTS_UUID_SEL ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN ,

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS ,

NVME_FID_SUPPORTED_EFFECTS_CDQSCP

};

## Constants
NVME_FID_SUPPORTED_EFFECTS_FSUPP

FID Supported

NVME_FID_SUPPORTED_EFFECTS_UDCC

User Data Content Change

NVME_FID_SUPPORTED_EFFECTS_NCC

Namespace Capability Change

NVME_FID_SUPPORTED_EFFECTS_NIC

Namespace Inventory Change

NVME_FID_SUPPORTED_EFFECTS_CCC

Controller Capability Change

NVME_FID_SUPPORTED_EFFECTS_UUID_SEL

UUID Selection Supported

NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT

FID Scope Shift

NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK

FID Scope Mask

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS

Namespace Scope

NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL

Controller Scope

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET

NVM Set Scope

NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP

Endurance Group Scope

NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN

Domain Scope

NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS

NVM Subsystem Scope

NVME_FID_SUPPORTED_EFFECTS_CDQSCP

Controller Data Queue


title: nvme_fid_supported_effects_log(2)

text:
# nvme_fid_supported_effects_log(2)

## NAME
struct nvme_fid_supported_effects_log - Feature Identifiers Supported and Effects

## SYNOPSIS
struct nvme_fid_supported_effects_log {

__le32 fid_support[NVME_LOG_FID_SUPPORTED_EFFECTS_MAX];

};

## Members
fid_support

Feature Identifier Supported


title: nvme_firmware_slot(2)

summary: Firmware Slot Information Log

text:
# nvme_firmware_slot(2)

## NAME
struct nvme_firmware_slot - Firmware Slot Information Log

## SYNOPSIS
struct nvme_firmware_slot {

__u8 afi;

__u8 rsvd1[7];

char frs[7][8];

__u8 rsvd2[448];

};

## Members
afi

Active Firmware Info

rsvd1

Reserved

frs

Firmware Revision for Slot

rsvd2

Reserved


title: nvme_first_host(2)

summary: Start host iterator

text:
# nvme_first_host(2)

## NAME
nvme_first_host - Start host iterator

## SYNOPSIS
nvme_host_t nvme_first_host (nvme_root_t r );

## ARGUMENTS
r

nvme_root_t object

## RETURN
First nvme_host_t object in an iterator


title: nvme_first_subsystem(2)

summary: Start subsystem iterator

text:
# nvme_first_subsystem(2)

## NAME
nvme_first_subsystem - Start subsystem iterator

## SYNOPSIS
nvme_subsystem_t nvme_first_subsystem (nvme_host_t h );

## ARGUMENTS
h

nvme_host_t object

## RETURN
first nvme_subsystem_t object in an iterator


title: nvme_flbas(2)

text:
# nvme_flbas(2)

## NAME
enum nvme_flbas - This field indicates the formatted LBA size

## SYNOPSIS
enum nvme_flbas {

NVME_FLBAS_LOWER_SHIFT ,

NVME_FLBAS_META_EXT_SHIFT ,

NVME_FLBAS_HIGHER_SHIFT ,

NVME_FLBAS_LOWER_MASK ,

NVME_FLBAS_META_EXT_MASK ,

NVME_FLBAS_HIGHER_MASK

};

## Constants
NVME_FLBAS_LOWER_SHIFT

Shift amount to get the format index least significant 4 bits

NVME_FLBAS_META_EXT_SHIFT

Shift amount to get the metadata transferred

NVME_FLBAS_HIGHER_SHIFT

Shift amount to get the format index most significant 2 bits

NVME_FLBAS_LOWER_MASK

Mask to get the format index least significant 4 bits

NVME_FLBAS_META_EXT_MASK

Mask to get the metadata transferred

NVME_FLBAS_HIGHER_MASK

Mask to get the format index most significant 2 bits


title: nvme_flush(2)

summary: Send an nvme flush command

text:
# nvme_flush(2)

## NAME
nvme_flush - Send an nvme flush command

## SYNOPSIS
int nvme_flush (int fd , __u32 nsid );

## ARGUMENTS
fd

File descriptor of nvme device

nsid

Namespace identifier

## DESCRIPTION
The Flush command requests that the contents of volatile write cache be made non-volatile.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_for_each_host(2)

summary: Traverse host list

text:
# nvme_for_each_host(2)

## NAME
nvme_for_each_host - Traverse host list

## SYNOPSIS
nvme_for_each_host (r , h );

## ARGUMENTS
r

nvme_root_t object

h

nvme_host_t object


title: nvme_for_each_host_safe(2)

summary: Traverse host list

text:
# nvme_for_each_host_safe(2)

## NAME
nvme_for_each_host_safe - Traverse host list

## SYNOPSIS
nvme_for_each_host_safe (r , h , _h );

## ARGUMENTS
r

nvme_root_t object

h

nvme_host_t object

_h

Temporary nvme_host_t object


title: nvme_for_each_subsystem(2)

summary: Traverse subsystems

text:
# nvme_for_each_subsystem(2)

## NAME
nvme_for_each_subsystem - Traverse subsystems

## SYNOPSIS
nvme_for_each_subsystem (h , s );

## ARGUMENTS
h

nvme_host_t object

s

nvme_subsystem_t object


title: nvme_for_each_subsystem_safe(2)

summary: Traverse subsystems

text:
# nvme_for_each_subsystem_safe(2)

## NAME
nvme_for_each_subsystem_safe - Traverse subsystems

## SYNOPSIS
nvme_for_each_subsystem_safe (h , s , _s );

## ARGUMENTS
h

nvme_host_t object

s

nvme_subsystem_t object

_s

Temporary nvme_subsystem_t object


title: nvme_format_nvm(2)

summary: Format nvme namespace(s)

text:
# nvme_format_nvm(2)

## NAME
nvme_format_nvm - Format nvme namespace(s)

## SYNOPSIS
int nvme_format_nvm (struct nvme_format_nvm_args *args );

## ARGUMENTS
args

struct nvme_format_nvme_args argument structure

## DESCRIPTION
The Format NVM command low level formats the NVM media. This command is used by the host to change the LBA data size and/or metadata size. A low level format may destroy all data and metadata associated with all namespaces or only the specific namespace associated with the command

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_format_nvm_compln_event(2)

summary: Format NVM Completion Event Data

text:
# nvme_format_nvm_compln_event(2)

## NAME
struct nvme_format_nvm_compln_event - Format NVM Completion Event Data

## SYNOPSIS
struct nvme_format_nvm_compln_event {

__le32 nsid;

__u8 smallest_fpi;

__u8 format_nvm_status;

__le16 compln_info;

__le32 status_field;

};

## Members
nsid

Namespace Identifier

smallest_fpi

Smallest Format Progress Indicator

format_nvm_status

Format NVM Status

compln_info

Completion Information

status_field

Status Field


title: nvme_format_nvm_start_event(2)

summary: Format NVM Start Event Data

text:
# nvme_format_nvm_start_event(2)

## NAME
struct nvme_format_nvm_start_event - Format NVM Start Event Data

## SYNOPSIS
struct nvme_format_nvm_start_event {

__le32 nsid;

__u8 fna;

__u8 rsvd5[3];

__le32 format_nvm_cdw10;

};

## Members
nsid

Namespace Identifier

fna

Format NVM Attributes

rsvd5

Reserved

format_nvm_cdw10

Format NVM CDW10


title: nvme_free_ctrl(2)

summary: Free controller

text:
# nvme_free_ctrl(2)

## NAME
nvme_free_ctrl - Free controller

## SYNOPSIS
void nvme_free_ctrl (struct nvme_ctrl *c );

## ARGUMENTS
c

Controller instance


title: nvme_free_host(2)

summary: Free nvme_host_t object

text:
# nvme_free_host(2)

## NAME
nvme_free_host - Free nvme_host_t object

## SYNOPSIS
void nvme_free_host (nvme_host_t h );

## ARGUMENTS
h

nvme_host_t object


title: nvme_free_ns(2)

summary: Free a namespace object

text:
# nvme_free_ns(2)

## NAME
nvme_free_ns - Free a namespace object

## SYNOPSIS
void nvme_free_ns (struct nvme_ns *n );

## ARGUMENTS
n

Namespace instance


title: nvme_free_subsystem(2)

summary: Free a subsystem

text:
# nvme_free_subsystem(2)

## NAME
nvme_free_subsystem - Free a subsystem

## SYNOPSIS
void nvme_free_subsystem (struct nvme_subsystem *s );

## ARGUMENTS
s

subsystem

## DESCRIPTION
Frees s and all related objects.


title: nvme_free_tree(2)

summary: Free root object

text:
# nvme_free_tree(2)

## NAME
nvme_free_tree - Free root object

## SYNOPSIS
void nvme_free_tree (nvme_root_t r );

## ARGUMENTS
r

nvme_root_t object

## DESCRIPTION
Free an nvme_root_t object and all attached objects


title: nvme_free_uri(2)

summary: Free the URI structure

text:
# nvme_free_uri(2)

## NAME
nvme_free_uri - Free the URI structure

## SYNOPSIS
void nvme_free_uri (struct nvme_fabrics_uri *uri );

## ARGUMENTS
uri

nvme_fabrics_uri structure

## DESCRIPTION
Free an nvme_fabrics_uri structure.


title: nvme_fw_commit(2)

text:
# nvme_fw_commit(2)

## NAME
nvme_fw_commit - Commit firmware using the specified action

## SYNOPSIS
int nvme_fw_commit (struct nvme_fw_commit_args *args );

## ARGUMENTS
args

struct nvme_fw_commit_args argument structure

## DESCRIPTION
The Firmware Commit command modifies the firmware image or Boot Partitions.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise. The command status response may specify additional reset actions required to complete the commit process.


title: nvme_fw_commit_ca(2)

summary: Firmware Commit - Commit Action

text:
# nvme_fw_commit_ca(2)

## NAME
enum nvme_fw_commit_ca - Firmware Commit - Commit Action

## SYNOPSIS
enum nvme_fw_commit_ca {

NVME_FW_COMMIT_CA_REPLACE ,

NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE ,

NVME_FW_COMMIT_CA_SET_ACTIVE ,

NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATE ,

NVME_FW_COMMIT_CA_REPLACE_BOOT_PARTITION ,

NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION

};

## Constants
NVME_FW_COMMIT_CA_REPLACE

Downloaded 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_ACTIVATE

Downloaded 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_ACTIVE

The existing image in the specified Firmware Slot is activated at the next Controller Level Reset.

NVME_FW_COMMIT_CA_REPLACE_AND_ACTIVATE_IMMEDIATE

Downloaded 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_PARTITION

Downloaded image replaces the Boot Partition specified by the Boot Partition ID field.

NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION

Mark the Boot Partition specified in the BPID field as active and update BPINFO.ABPID.


title: nvme_fw_commit_event(2)

summary: Firmware Commit Event Data

text:
# nvme_fw_commit_event(2)

## NAME
struct nvme_fw_commit_event - Firmware Commit Event Data

## SYNOPSIS
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_rev

Old Firmware Revision

new_fw_rev

New Firmware Revision

fw_commit_action

Firmware Commit Action

fw_slot

Firmware Slot

sct_fw

Status Code Type for Firmware Commit Command

sc_fw

Status Returned for Firmware Commit Command

vndr_assign_fw_commit_rc

Vendor Assigned Firmware Commit Result Code


title: nvme_fw_download(2)

text:
# nvme_fw_download(2)

## NAME
nvme_fw_download - Download part or all of a firmware image to the controller

## SYNOPSIS
int nvme_fw_download (struct nvme_fw_download_args *args );

## ARGUMENTS
args

struct nvme_fw_download_args argument structure

## DESCRIPTION
The Firmware Image Download command downloads all or a portion of an image for a future update to the controller. The Firmware Image Download command downloads a new image (in whole or in part) to the controller.

The image may be constructed of multiple pieces that are individually downloaded with separate Firmware Image Download commands. Each Firmware Image Download command includes a Dword Offset and Number of Dwords that specify a dword range.

The new firmware image is not activated as part of the Firmware Image Download command. Use the nvme_fw_commit to activate a newly downloaded image.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_fw_download_seq(2)

summary: Firmware download sequence

text:
# nvme_fw_download_seq(2)

## NAME
nvme_fw_download_seq - Firmware download sequence

## SYNOPSIS
int nvme_fw_download_seq (int fd , __u32 size , __u32 xfer , __u32 offset , void *buf );

## ARGUMENTS
fd

File descriptor of nvme device

size

Total size of the firmware image to transfer

xfer

Maximum size to send with each partial transfer

offset

Starting offset to send with this firmware download

buf

Address of buffer containing all or part of the firmware image.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_gen_dhchap_key(2)

summary: DH-HMAC-CHAP key generation

text:
# nvme_gen_dhchap_key(2)

## NAME
nvme_gen_dhchap_key - DH-HMAC-CHAP key generation

## SYNOPSIS
int nvme_gen_dhchap_key (char *hostnqn , enum nvme_hmac_alg hmac , unsigned int key_len , unsigned char *secret , unsigned char *key );

## ARGUMENTS
hostnqn

Host NVMe Qualified Name

hmac

HMAC algorithm

key_len

Output key length

secret

Secret to used for digest

key

Generated DH-HMAC-CHAP key

## RETURN
If key generation was successful the function returns 0 or -1 with errno set otherwise.


title: nvme_generate_tls_key_identity(2)

summary: Generate the TLS key identity

text:
# nvme_generate_tls_key_identity(2)

## NAME
nvme_generate_tls_key_identity - Generate the TLS key identity

## SYNOPSIS
char * nvme_generate_tls_key_identity (const char *hostnqn , const char *subsysnqn , int version , int hmac , unsigned char *configured_key , int key_len );

## ARGUMENTS
hostnqn

Host NVMe Qualified Name

subsysnqn

Subsystem NVMe Qualified Name

version

Key version to use

hmac

HMAC algorithm

configured_key

Configured key data to derive the key from

key_len

Length of configured_key

## DESCRIPTION
Derives a 'retained' TLS key as specified in NVMe TCP and generate the corresponding TLs identity.

## RETURN
The string containing the TLS identity. It is the responsibility of the caller to free the returned string.


title: nvme_get_ana_log_atomic(2)

text:
# nvme_get_ana_log_atomic(2)

## NAME
nvme_get_ana_log_atomic - Retrieve Asymmetric Namespace Access log page atomically

## SYNOPSIS
int nvme_get_ana_log_atomic (int fd , bool rgo , bool rae , unsigned int retries , struct nvme_ana_log *log , __u32 *len );

## ARGUMENTS
fd

File descriptor of nvme device

rgo

Whether to retrieve ANA groups only (no NSIDs)

rae

Whether to retain asynchronous events

retries

The maximum number of times to retry on log page changes

log

Pointer to a buffer to receive the ANA log page

len

Input: the length of the log page buffer. Output: the actual length of the ANA log page.

## DESCRIPTION
See struct nvme_ana_log for the definition of the returned structure.

## RETURN
If successful, returns 0 and sets *len to the actual log page length. If unsuccessful, returns the nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise. Sets errno = EINVAL if retries == 0. Sets errno = EAGAIN if unable to read the log page atomically because chgcnt changed during each of the retries attempts. Sets errno = ENOSPC if the full log page does not fit in the provided buffer.


title: nvme_get_ana_log_len(2)

summary: Retrieve size of the current ANA log

text:
# nvme_get_ana_log_len(2)

## NAME
nvme_get_ana_log_len - Retrieve size of the current ANA log

## SYNOPSIS
int nvme_get_ana_log_len (int fd , size_t *analen );

## ARGUMENTS
fd

File descriptor of nvme device

analen

Pointer to where the length will be set on success

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_ana_log_len_from_id_ctrl(2)

summary: Retrieve maximum possible ANA log size

text:
# nvme_get_ana_log_len_from_id_ctrl(2)

## NAME
nvme_get_ana_log_len_from_id_ctrl - Retrieve maximum possible ANA log size

## SYNOPSIS
size_t nvme_get_ana_log_len_from_id_ctrl (const struct nvme_id_ctrl *id_ctrl , bool rgo );

## ARGUMENTS
id_ctrl

Controller identify data

rgo

If true, return maximum log page size without NSIDs

## RETURN
A byte limit on the size of the controller's ANA log page


title: nvme_get_attr(2)

summary: Read sysfs attribute

text:
# nvme_get_attr(2)

## NAME
nvme_get_attr - Read sysfs attribute

## SYNOPSIS
char * nvme_get_attr (const char *d , const char *attr );

## ARGUMENTS
d

sysfs directory

attr

sysfs attribute name

## RETURN
String with the contents of attr or NULL in case of an empty value or in case of an error (indicated by non-zero errno code).


title: nvme_get_ctrl_attr(2)

summary: Read controller sysfs attribute

text:
# nvme_get_ctrl_attr(2)

## NAME
nvme_get_ctrl_attr - Read controller sysfs attribute

## SYNOPSIS
char * nvme_get_ctrl_attr (nvme_ctrl_t c , const char *attr );

## ARGUMENTS
c

Controller instance

attr

sysfs attribute name

## RETURN
String with the contents of attr or NULL in case of an empty value or in case of an error (indicated by non-zero errno code).


title: nvme_get_ctrl_telemetry(2)

summary: Get controller telemetry log

text:
# nvme_get_ctrl_telemetry(2)

## NAME
nvme_get_ctrl_telemetry - Get controller telemetry log

## SYNOPSIS
int nvme_get_ctrl_telemetry (int fd , bool rae , struct nvme_telemetry_log **log , enum nvme_telemetry_da da , size_t *size );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

On success, set to the value of the allocated and retrieved log.

da

Log page data area, valid values: enum nvme_telemetry_da

size

Ptr to the telemetry log size, so it can be returned

## DESCRIPTION
The total size allocated can be calculated as: (nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_directive_receive_length(2)

summary: Get directive receive length

text:
# nvme_get_directive_receive_length(2)

## NAME
nvme_get_directive_receive_length - Get directive receive length

## SYNOPSIS
int nvme_get_directive_receive_length (enum nvme_directive_dtype dtype , enum nvme_directive_receive_doper doper , __u32 *len );

## ARGUMENTS
dtype

Directive type, see enum nvme_directive_dtype

doper

Directive receive operation, see enum nvme_directive_receive_doper

len

On success, set to this directives payload length in bytes.

## RETURN
0 on success, -1 with errno set to EINVAL if the function did not recognize dtype or doper.


title: nvme_get_discovery_args(2)

text:
# nvme_get_discovery_args(2)

## NAME
struct nvme_get_discovery_args - Arguments for nvmf_get_discovery_wargs()

## SYNOPSIS
struct nvme_get_discovery_args {

nvme_ctrl_t c;

int args_size;

int max_retries;

__u32 *result;

__u32 timeout;

__u8 lsp;

};

## Members
c

Discovery controller

args_size

Length of the structure

max_retries

Number of retries in case of failure

result

The command completion result from CQE dword0

timeout

Timeout in ms (default: NVME_DEFAULT_IOCTL_TIMEOUT)

lsp

Log specific field (See enum nvmf_log_discovery_lsp)


title: nvme_get_feature_length(2)

text:
# nvme_get_feature_length(2)

## NAME
nvme_get_feature_length - Retreive the command payload length for a specific feature identifier

## SYNOPSIS
int nvme_get_feature_length (int fid , __u32 cdw11 , __u32 *len );

## ARGUMENTS
fid

Feature identifier, see enum nvme_features_id.

cdw11

The cdw11 value may affect the transfer (only known fid is NVME_FEAT_FID_HOST_ID)

len

On success, set to this features payload length in bytes.

## RETURN
0 on success, -1 with errno set to EINVAL if the function did not recognize fid.


title: nvme_get_feature_length2(2)

text:
# nvme_get_feature_length2(2)

## NAME
nvme_get_feature_length2 - Retreive the command payload length for a specific feature identifier

## SYNOPSIS
int nvme_get_feature_length2 (int fid , __u32 cdw11 , enum nvme_data_tfr dir , __u32 *len );

## ARGUMENTS
fid

Feature identifier, see enum nvme_features_id.

cdw11

The cdw11 value may affect the transfer (only known fid is NVME_FEAT_FID_HOST_ID)

dir

Data transfer direction: false - host to controller, true - controller to host may affect the transfer (only known fid is NVME_FEAT_FID_HOST_MEM_BUF).

len

On success, set to this features payload length in bytes.

## RETURN
0 on success, -1 with errno set to EINVAL if the function did not recognize fid.


title: nvme_get_features(2)

summary: Retrieve a feature attribute

text:
# nvme_get_features(2)

## NAME
nvme_get_features - Retrieve a feature attribute

## SYNOPSIS
int nvme_get_features (struct nvme_get_features_args *args );

## ARGUMENTS
args

struct nvme_get_features_args argument structure

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_arbitration(2)

summary: Get arbitration feature

text:
# nvme_get_features_arbitration(2)

## NAME
nvme_get_features_arbitration - Get arbitration feature

## SYNOPSIS
int nvme_get_features_arbitration (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_async_event(2)

summary: Get asynchronous event feature

text:
# nvme_get_features_async_event(2)

## NAME
nvme_get_features_async_event - Get asynchronous event feature

## SYNOPSIS
int nvme_get_features_async_event (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_auto_pst(2)

summary: Get autonomous power state feature

text:
# nvme_get_features_auto_pst(2)

## NAME
nvme_get_features_auto_pst - Get autonomous power state feature

## SYNOPSIS
int nvme_get_features_auto_pst (int fd , enum nvme_get_features_sel sel , struct nvme_feat_auto_pst *apst , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

apst

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_data(2)

text:
# nvme_get_features_data(2)

## NAME
nvme_get_features_data - Helper function for @nvme_get_features()

## SYNOPSIS
int nvme_get_features_data (int fd , enum nvme_features_id fid , __u32 nsid , __u32 data_len , void *data , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

fid

Feature identifier

nsid

Namespace ID, if applicable

data_len

Length of feature data, if applicable, in bytes

data

User address of feature data, if applicable

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


summary: Get endurance event config feature

text:
# nvme_get_features_endurance_event_cfg(2)

## NAME
nvme_get_features_endurance_event_cfg - Get endurance event config feature

## SYNOPSIS
int nvme_get_features_endurance_event_cfg (int fd , enum nvme_get_features_sel sel , __u16 endgid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

endgid

Endurance Group Identifier

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_err_recovery(2)

summary: Get error recovery feature

text:
# nvme_get_features_err_recovery(2)

## NAME
nvme_get_features_err_recovery - Get error recovery feature

## SYNOPSIS
int nvme_get_features_err_recovery (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## DESCRIPTION
Deprecated: doesn't support specifying a NSID. Use nvme_get_features_err_recovery2 instead.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_err_recovery2(2)

summary: Get error recovery feature

text:
# nvme_get_features_err_recovery2(2)

## NAME
nvme_get_features_err_recovery2 - Get error recovery feature

## SYNOPSIS
int nvme_get_features_err_recovery2 (int fd , enum nvme_get_features_sel sel , __u32 nsid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nsid

Namespace ID

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_hctm(2)

summary: Get thermal management feature

text:
# nvme_get_features_hctm(2)

## NAME
nvme_get_features_hctm - Get thermal management feature

## SYNOPSIS
int nvme_get_features_hctm (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_host_behavior(2)

summary: Get host behavior feature

text:
# nvme_get_features_host_behavior(2)

## NAME
nvme_get_features_host_behavior - Get host behavior feature

## SYNOPSIS
int nvme_get_features_host_behavior (int fd , enum nvme_get_features_sel sel , struct nvme_feat_host_behavior *data , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

data

Pointer to structure nvme_feat_host_behavior

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_host_id(2)

summary: Get host id feature

text:
# nvme_get_features_host_id(2)

## NAME
nvme_get_features_host_id - Get host id feature

## SYNOPSIS
int nvme_get_features_host_id (int fd , enum nvme_get_features_sel sel , bool exhid , __u32 len , __u8 *hostid );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

exhid

Enable Extended Host Identifier

len

Length of hostid

hostid

Buffer for returned host ID

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_host_mem_buf(2)

summary: Get host memory buffer feature

text:
# nvme_get_features_host_mem_buf(2)

## NAME
nvme_get_features_host_mem_buf - Get host memory buffer feature

## SYNOPSIS
int nvme_get_features_host_mem_buf (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## DESCRIPTION
Deprecated: doesn't fetch the Host Memory Buffer Attributes data structure. Use nvme_get_features_host_mem_buf2 instead.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_host_mem_buf2(2)

summary: Get host memory buffer feature

text:
# nvme_get_features_host_mem_buf2(2)

## NAME
nvme_get_features_host_mem_buf2 - Get host memory buffer feature

## SYNOPSIS
int nvme_get_features_host_mem_buf2 (int fd , enum nvme_get_features_sel sel , struct nvme_host_mem_buf_attrs *attrs , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

attrs

Buffer for returned Host Memory Buffer Attributes

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_iocs_profile(2)

summary: Get IOCS profile feature

text:
# nvme_get_features_iocs_profile(2)

## NAME
nvme_get_features_iocs_profile - Get IOCS profile feature

## SYNOPSIS
int nvme_get_features_iocs_profile (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_irq_coalesce(2)

summary: Get IRQ coalesce feature

text:
# nvme_get_features_irq_coalesce(2)

## NAME
nvme_get_features_irq_coalesce - Get IRQ coalesce feature

## SYNOPSIS
int nvme_get_features_irq_coalesce (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_irq_config(2)

summary: Get IRQ config feature

text:
# nvme_get_features_irq_config(2)

## NAME
nvme_get_features_irq_config - Get IRQ config feature

## SYNOPSIS
int nvme_get_features_irq_config (int fd , enum nvme_get_features_sel sel , __u16 iv , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

iv

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_kato(2)

summary: Get keep alive timeout feature

text:
# nvme_get_features_kato(2)

## NAME
nvme_get_features_kato - Get keep alive timeout feature

## SYNOPSIS
int nvme_get_features_kato (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_lba_range(2)

summary: Get LBA range feature

text:
# nvme_get_features_lba_range(2)

## NAME
nvme_get_features_lba_range - Get LBA range feature

## SYNOPSIS
int nvme_get_features_lba_range (int fd , enum nvme_get_features_sel sel , struct nvme_lba_range_type *data , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

data

User address of feature data, if applicable

result

The command completion result from CQE dword0

## DESCRIPTION
Deprecated: doesn't support specifying a NSID. Use nvme_get_features_lba_range2 instead.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_lba_range2(2)

summary: Get LBA range feature

text:
# nvme_get_features_lba_range2(2)

## NAME
nvme_get_features_lba_range2 - Get LBA range feature

## SYNOPSIS
int nvme_get_features_lba_range2 (int fd , enum nvme_get_features_sel sel , __u32 nsid , struct nvme_lba_range_type *data , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nsid

Namespace ID

data

Buffer to receive LBA Range Type data structure

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_lba_sts_interval(2)

summary: Get LBA status information feature

text:
# nvme_get_features_lba_sts_interval(2)

## NAME
nvme_get_features_lba_sts_interval - Get LBA status information feature

## SYNOPSIS
int nvme_get_features_lba_sts_interval (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_nopsc(2)

summary: Get non-operational power state feature

text:
# nvme_get_features_nopsc(2)

## NAME
nvme_get_features_nopsc - Get non-operational power state feature

## SYNOPSIS
int nvme_get_features_nopsc (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_num_queues(2)

summary: Get number of queues feature

text:
# nvme_get_features_num_queues(2)

## NAME
nvme_get_features_num_queues - Get number of queues feature

## SYNOPSIS
int nvme_get_features_num_queues (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_plm_config(2)

summary: Get predictable latency feature

text:
# nvme_get_features_plm_config(2)

## NAME
nvme_get_features_plm_config - Get predictable latency feature

## SYNOPSIS
int nvme_get_features_plm_config (int fd , enum nvme_get_features_sel sel , __u16 nvmsetid , struct nvme_plm_config *data , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nvmsetid

NVM set id

data

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_plm_window(2)

summary: Get window select feature

text:
# nvme_get_features_plm_window(2)

## NAME
nvme_get_features_plm_window - Get window select feature

## SYNOPSIS
int nvme_get_features_plm_window (int fd , enum nvme_get_features_sel sel , __u16 nvmsetid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nvmsetid

NVM set id

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_power_mgmt(2)

summary: Get power management feature

text:
# nvme_get_features_power_mgmt(2)

## NAME
nvme_get_features_power_mgmt - Get power management feature

## SYNOPSIS
int nvme_get_features_power_mgmt (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_resv_mask(2)

summary: Get reservation mask feature

text:
# nvme_get_features_resv_mask(2)

## NAME
nvme_get_features_resv_mask - Get reservation mask feature

## SYNOPSIS
int nvme_get_features_resv_mask (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## DESCRIPTION
Deprecated: doesn't support specifying a NSID. Use nvme_get_features_resv_mask2 instead.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_resv_mask2(2)

summary: Get reservation mask feature

text:
# nvme_get_features_resv_mask2(2)

## NAME
nvme_get_features_resv_mask2 - Get reservation mask feature

## SYNOPSIS
int nvme_get_features_resv_mask2 (int fd , enum nvme_get_features_sel sel , __u32 nsid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nsid

Namespace ID

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_resv_persist(2)

summary: Get reservation persist feature

text:
# nvme_get_features_resv_persist(2)

## NAME
nvme_get_features_resv_persist - Get reservation persist feature

## SYNOPSIS
int nvme_get_features_resv_persist (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## DESCRIPTION
Deprecated: doesn't support specifying a NSID. Use nvme_get_features_resv_persist2 instead.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_resv_persist2(2)

summary: Get reservation persist feature

text:
# nvme_get_features_resv_persist2(2)

## NAME
nvme_get_features_resv_persist2 - Get reservation persist feature

## SYNOPSIS
int nvme_get_features_resv_persist2 (int fd , enum nvme_get_features_sel sel , __u32 nsid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

nsid

Namespace ID

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_rrl(2)

summary: Get read recovery level feature

text:
# nvme_get_features_rrl(2)

## NAME
nvme_get_features_rrl - Get read recovery level feature

## SYNOPSIS
int nvme_get_features_rrl (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_sanitize(2)

summary: Get sanitize feature

text:
# nvme_get_features_sanitize(2)

## NAME
nvme_get_features_sanitize - Get sanitize feature

## SYNOPSIS
int nvme_get_features_sanitize (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_sel(2)

summary: Get Features - Select

text:
# nvme_get_features_sel(2)

## NAME
enum nvme_get_features_sel - Get Features - Select

## SYNOPSIS
enum nvme_get_features_sel {

NVME_GET_FEATURES_SEL_CURRENT ,

NVME_GET_FEATURES_SEL_DEFAULT ,

NVME_GET_FEATURES_SEL_SAVED ,

NVME_GET_FEATURES_SEL_SUPPORTED

};

## Constants
NVME_GET_FEATURES_SEL_CURRENT

Current value

NVME_GET_FEATURES_SEL_DEFAULT

Default value

NVME_GET_FEATURES_SEL_SAVED

Saved value

NVME_GET_FEATURES_SEL_SUPPORTED

Supported capabilities


title: nvme_get_features_simple(2)

text:
# nvme_get_features_simple(2)

## NAME
nvme_get_features_simple - Helper function for @nvme_get_features()

## SYNOPSIS
int nvme_get_features_simple (int fd , enum nvme_features_id fid , __u32 nsid , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

fid

Feature identifier

nsid

Namespace ID, if applicable

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_sw_progress(2)

summary: Get software progress feature

text:
# nvme_get_features_sw_progress(2)

## NAME
nvme_get_features_sw_progress - Get software progress feature

## SYNOPSIS
int nvme_get_features_sw_progress (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_temp_thresh(2)

summary: Get temperature threshold feature

text:
# nvme_get_features_temp_thresh(2)

## NAME
nvme_get_features_temp_thresh - Get temperature threshold feature

## SYNOPSIS
int nvme_get_features_temp_thresh (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_temp_thresh2(2)

summary: Get temperature threshold feature

text:
# nvme_get_features_temp_thresh2(2)

## NAME
nvme_get_features_temp_thresh2 - Get temperature threshold feature

## SYNOPSIS
int nvme_get_features_temp_thresh2 (int fd , enum nvme_get_features_sel sel , __u8 tmpsel , enum nvme_feat_tmpthresh_thsel thsel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

tmpsel

Threshold Temperature Select

thsel

Threshold Type Select

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_timestamp(2)

summary: Get timestamp feature

text:
# nvme_get_features_timestamp(2)

## NAME
nvme_get_features_timestamp - Get timestamp feature

## SYNOPSIS
int nvme_get_features_timestamp (int fd , enum nvme_get_features_sel sel , struct nvme_timestamp *ts );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

ts

Current timestamp

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_volatile_wc(2)

summary: Get volatile write cache feature

text:
# nvme_get_features_volatile_wc(2)

## NAME
nvme_get_features_volatile_wc - Get volatile write cache feature

## SYNOPSIS
int nvme_get_features_volatile_wc (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_write_atomic(2)

summary: Get write atomic feature

text:
# nvme_get_features_write_atomic(2)

## NAME
nvme_get_features_write_atomic - Get write atomic feature

## SYNOPSIS
int nvme_get_features_write_atomic (int fd , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_features_write_protect(2)

summary: Get write protect feature

text:
# nvme_get_features_write_protect(2)

## NAME
nvme_get_features_write_protect - Get write protect feature

## SYNOPSIS
int nvme_get_features_write_protect (int fd , __u32 nsid , enum nvme_get_features_sel sel , __u32 *result );

## ARGUMENTS
fd

File descriptor of nvme device

nsid

Namespace ID

sel

Select which type of attribute to return, see enum nvme_get_features_sel

result

The command completion result from CQE dword0

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_host_telemetry(2)

summary: Get host telemetry log

text:
# nvme_get_host_telemetry(2)

## NAME
nvme_get_host_telemetry - Get host telemetry log

## SYNOPSIS
int nvme_get_host_telemetry (int fd , struct nvme_telemetry_log **log , enum nvme_telemetry_da da , size_t *size );

## ARGUMENTS
fd

File descriptor of nvme device

log

On success, set to the value of the allocated and retrieved log.

da

Log page data area, valid values: enum nvme_telemetry_da

size

Ptr to the telemetry log size, so it can be returned

## DESCRIPTION
The total size allocated can be calculated as: (nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_lba_status(2)

text:
# nvme_get_lba_status(2)

## NAME
nvme_get_lba_status - Retrieve information on possibly unrecoverable LBAs

## SYNOPSIS
int nvme_get_lba_status (struct nvme_get_lba_status_args *args );

## ARGUMENTS
args

struct nvme_get_lba_status_args argument structure

## DESCRIPTION
The Get LBA Status command requests information about Potentially Unrecoverable LBAs. Refer to the specification for action type descriptions.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_lba_status_log(2)

summary: Retrieve the LBA Status log page

text:
# nvme_get_lba_status_log(2)

## NAME
nvme_get_lba_status_log - Retrieve the LBA Status log page

## SYNOPSIS
int nvme_get_lba_status_log (int fd , bool rae , struct nvme_lba_status_log **log );

## ARGUMENTS
fd

File descriptor of the nvme device

rae

Retain asynchronous events

log

On success, set to the value of the allocated and retrieved log.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log(2)

summary: NVMe Admin Get Log command

text:
# nvme_get_log(2)

## NAME
nvme_get_log - NVMe Admin Get Log command

## SYNOPSIS
int nvme_get_log (struct nvme_get_log_args *args );

## ARGUMENTS
args

struct nvme_get_log_args argument structure

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_ana(2)

text:
# nvme_get_log_ana(2)

## NAME
nvme_get_log_ana - Retrieve Asymmetric Namespace Access log page

## SYNOPSIS
int nvme_get_log_ana (int fd , enum nvme_log_ana_lsp lsp , bool rae , __u64 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

lsp

Log specific, see enum nvme_get_log_ana_lsp

rae

Retain asynchronous events

offset

Offset to the start of the log page

len

The allocated length of the log page

log

User address to store the ana log

## DESCRIPTION
This log consists of a header describing the log and descriptors containing the asymmetric namespace access information for ANA Groups that contain namespaces that are attached to the controller processing the command.

See struct nvme_ana_log for the definition of the returned structure.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_ana_groups(2)

text:
# nvme_get_log_ana_groups(2)

## NAME
nvme_get_log_ana_groups - Retrieve Asymmetric Namespace Access groups only log page

## SYNOPSIS
int nvme_get_log_ana_groups (int fd , bool rae , __u32 len , struct nvme_ana_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the ana group log

## DESCRIPTION
See struct nvme_ana_log for the definition of the returned structure.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_ave_discover(2)

summary: Retrieve AVE Discovery Log

text:
# nvme_get_log_ave_discover(2)

## NAME
nvme_get_log_ave_discover - Retrieve AVE Discovery Log

## SYNOPSIS
int nvme_get_log_ave_discover (int fd , bool rae , __u32 len , struct nvme_ave_discover_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_boot_partition(2)

summary: Retrieve Boot Partition

text:
# nvme_get_log_boot_partition(2)

## NAME
nvme_get_log_boot_partition - Retrieve Boot Partition

## SYNOPSIS
int nvme_get_log_boot_partition (int fd , bool rae , __u8 lsp , __u32 len , struct nvme_boot_partition *part );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

lsp

The log specified field of LID

len

The allocated size, minimum struct nvme_boot_partition

part

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_changed_alloc_ns_list(2)

text:
# nvme_get_log_changed_alloc_ns_list(2)

## NAME
nvme_get_log_changed_alloc_ns_list - Retrieve Changed Allocated Namespace List Log

## SYNOPSIS
int nvme_get_log_changed_alloc_ns_list (int fd , bool rae , __u32 len , struct nvme_ns_list *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_changed_ns_list(2)

summary: Retrieve namespace changed list

text:
# nvme_get_log_changed_ns_list(2)

## NAME
nvme_get_log_changed_ns_list - Retrieve namespace changed list

## SYNOPSIS
int nvme_get_log_changed_ns_list (int fd , bool rae , struct nvme_ns_list *ns_log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

ns_log

User address to store the log page

## DESCRIPTION
This log page describes namespaces attached to this controller that have changed since the last time the namespace was identified, been added, or deleted.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_cmd_effects(2)

summary: Retrieve nvme command effects log

text:
# nvme_get_log_cmd_effects(2)

## NAME
nvme_get_log_cmd_effects - Retrieve nvme command effects log

## SYNOPSIS
int nvme_get_log_cmd_effects (int fd , enum nvme_csi csi , struct nvme_cmd_effects_log *effects_log );

## ARGUMENTS
fd

File descriptor of nvme device

csi

Command Set Identifier

effects_log

User address to store the effects log

## DESCRIPTION
This log page describes the commands that the controller supports and the effects of those commands on the state of the NVM subsystem.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_create_telemetry_host(2)

summary: Create host telemetry log

text:
# nvme_get_log_create_telemetry_host(2)

## NAME
nvme_get_log_create_telemetry_host - Create host telemetry log

## SYNOPSIS
int nvme_get_log_create_telemetry_host (int fd , struct nvme_telemetry_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

log

Userspace address of the log payload

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


summary: Create host telemetry log

text:
# nvme_get_log_create_telemetry_host_mcda(2)

## NAME
nvme_get_log_create_telemetry_host_mcda - Create host telemetry log

## SYNOPSIS
int nvme_get_log_create_telemetry_host_mcda (int fd , enum nvme_telemetry_da mcda , struct nvme_telemetry_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

mcda

Maximum Created Data Area

log

Userspace address of the log payload

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_device_self_test(2)

summary: Retrieve the device self test log

text:
# nvme_get_log_device_self_test(2)

## NAME
nvme_get_log_device_self_test - Retrieve the device self test log

## SYNOPSIS
int nvme_get_log_device_self_test (int fd , struct nvme_self_test_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

log

Userspace address of the log payload

## DESCRIPTION
The log page indicates the status of an in progress self test and the percent complete of that operation, and the results of the previous 20 self-test operations.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_discovery(2)

summary: Retrieve Discovery log page

text:
# nvme_get_log_discovery(2)

## NAME
nvme_get_log_discovery - Retrieve Discovery log page

## SYNOPSIS
int nvme_get_log_discovery (int fd , bool rae , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

offset

Offset of this log to retrieve

len

The allocated size for this portion of the log

log

User address to store the discovery log

## DESCRIPTION
Supported only by fabrics discovery controllers, returning discovery records.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


text:
# nvme_get_log_dispersed_ns_participating_nss(2)

## NAME
nvme_get_log_dispersed_ns_participating_nss - Retrieve Dispersed Namespace Participating NVM Subsystems Log

## SYNOPSIS
int nvme_get_log_dispersed_ns_participating_nss (int fd , __u32 nsid , __u32 len , struct nvme_dispersed_ns_participating_nss_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

nsid

Namespace Identifier

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_endurance_group(2)

summary: Get Endurance Group log

text:
# nvme_get_log_endurance_group(2)

## NAME
nvme_get_log_endurance_group - Get Endurance Group log

## SYNOPSIS
int nvme_get_log_endurance_group (int fd , __u16 endgid , struct nvme_endurance_group_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

endgid

Starting group identifier to return in the list

log

User address to store the endurance log

## DESCRIPTION
This log page indicates if an Endurance Group Event has occurred for a particular Endurance Group. If an Endurance Group Event has occurred, the details of the particular event are included in the Endurance Group Information log page for that Endurance Group. An asynchronous event is generated when an entry for an Endurance Group is newly added to this log page.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_endurance_grp_evt(2)

text:
# nvme_get_log_endurance_grp_evt(2)

## NAME
nvme_get_log_endurance_grp_evt - Retrieve Endurance Group Event Aggregate

## SYNOPSIS
int nvme_get_log_endurance_grp_evt (int fd , bool rae , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

offset

Offset to the start of the log page

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_error(2)

summary: Retrieve nvme error log

text:
# nvme_get_log_error(2)

## NAME
nvme_get_log_error - Retrieve nvme error log

## SYNOPSIS
int nvme_get_log_error (int fd , unsigned int nr_entries , bool rae , struct nvme_error_log_page *err_log );

## ARGUMENTS
fd

File descriptor of nvme device

nr_entries

Number of error log entries allocated

rae

Retain asynchronous events

err_log

Array of error logs of size 'entries'

## DESCRIPTION
This log page describes extended error information for a command that completed with error, or may report an error that is not specific to a particular command.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_fdp_configurations(2)

text:
# nvme_get_log_fdp_configurations(2)

## NAME
nvme_get_log_fdp_configurations - Get list of Flexible Data Placement configurations

## SYNOPSIS
int nvme_get_log_fdp_configurations (int fd , __u16 egid , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

egid

Endurance group identifier

offset

Offset into log page

len

Length (in bytes) of provided user buffer to hold the log data

log

Log page data buffer


title: nvme_get_log_fdp_events(2)

summary: Get Flexible Data Placement events

text:
# nvme_get_log_fdp_events(2)

## NAME
nvme_get_log_fdp_events - Get Flexible Data Placement events

## SYNOPSIS
int nvme_get_log_fdp_events (int fd , __u16 egid , bool host_events , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

egid

Endurance group identifier

host_events

Whether to report host or controller events

offset

Offset into log page

len

Length (in bytes) of provided user buffer to hold the log data

log

Log page data buffer


title: nvme_get_log_fdp_stats(2)

summary: Get Flexible Data Placement statistics

text:
# nvme_get_log_fdp_stats(2)

## NAME
nvme_get_log_fdp_stats - Get Flexible Data Placement statistics

## SYNOPSIS
int nvme_get_log_fdp_stats (int fd , __u16 egid , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

egid

Endurance group identifier

offset

Offset into log page

len

Length (in bytes) of provided user buffer to hold the log data

log

Log page data buffer


title: nvme_get_log_fid_supported_effects(2)

text:
# nvme_get_log_fid_supported_effects(2)

## NAME
nvme_get_log_fid_supported_effects - Retrieve Feature Identifiers Supported and Effects

## SYNOPSIS
int nvme_get_log_fid_supported_effects (int fd , bool rae , struct nvme_fid_supported_effects_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

FID Supported and Effects data structure

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_fw_slot(2)

summary: Retrieves the controller firmware log

text:
# nvme_get_log_fw_slot(2)

## NAME
nvme_get_log_fw_slot - Retrieves the controller firmware log

## SYNOPSIS
int nvme_get_log_fw_slot (int fd , bool rae , struct nvme_firmware_slot *fw_log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

fw_log

User address to store the log page

## DESCRIPTION
This log page describes the firmware revision stored in each firmware slot supported. The firmware revision is indicated as an ASCII string. The log page also indicates the active slot number.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_host_discover(2)

summary: Retrieve Host Discovery Log

text:
# nvme_get_log_host_discover(2)

## NAME
nvme_get_log_host_discover - Retrieve Host Discovery Log

## SYNOPSIS
int nvme_get_log_host_discover (int fd , bool allhoste , bool rae , __u32 len , struct nvme_host_discover_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

allhoste

All host entries

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_lba_status(2)

summary: Retrieve LBA Status

text:
# nvme_get_log_lba_status(2)

## NAME
nvme_get_log_lba_status - Retrieve LBA Status

## SYNOPSIS
int nvme_get_log_lba_status (int fd , bool rae , __u64 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

offset

Offset to the start of the log page

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_lockdown(2)

summary: Retrieve lockdown Log

text:
# nvme_get_log_lockdown(2)

## NAME
nvme_get_log_lockdown - Retrieve lockdown Log

## SYNOPSIS
int nvme_get_log_lockdown (int fd , __u8 cnscp , struct nvme_lockdown_log *lockdown_log );

## ARGUMENTS
fd

File descriptor of nvme device

cnscp

Contents and Scope of Command and Feature Identifier Lists

lockdown_log

Buffer to store the lockdown log

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_media_unit_stat(2)

summary: Retrieve Media Unit Status

text:
# nvme_get_log_media_unit_stat(2)

## NAME
nvme_get_log_media_unit_stat - Retrieve Media Unit Status

## SYNOPSIS
int nvme_get_log_media_unit_stat (int fd , __u16 domid , struct nvme_media_unit_stat_log *mus );

## ARGUMENTS
fd

File descriptor of nvme device

domid

Domain Identifier selection, if supported

mus

User address to store the Media Unit statistics log

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_mgmt_addr_list(2)

summary: Retrieve Management Address List Log

text:
# nvme_get_log_mgmt_addr_list(2)

## NAME
nvme_get_log_mgmt_addr_list - Retrieve Management Address List Log

## SYNOPSIS
int nvme_get_log_mgmt_addr_list (int fd , __u32 len , struct nvme_mgmt_addr_list_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


text:
# nvme_get_log_mi_cmd_supported_effects(2)

## NAME
nvme_get_log_mi_cmd_supported_effects - displays the MI Commands Supported by the controller

## SYNOPSIS
int nvme_get_log_mi_cmd_supported_effects (int fd , bool rae , struct nvme_mi_cmd_supported_effects_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

MI Command Supported and Effects data structure

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_page(2)

summary: Get log page data

text:
# nvme_get_log_page(2)

## NAME
nvme_get_log_page - Get log page data

## SYNOPSIS
int nvme_get_log_page (int fd , __u32 xfer_len , struct nvme_get_log_args *args );

## ARGUMENTS
fd

File descriptor of nvme device

xfer_len

Max log transfer size per request to split the total.

args

struct nvme_get_log_args argument structure

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_persistent_event(2)

summary: Retrieve Persistent Event Log

text:
# nvme_get_log_persistent_event(2)

## NAME
nvme_get_log_persistent_event - Retrieve Persistent Event Log

## SYNOPSIS
int nvme_get_log_persistent_event (int fd , enum nvme_pevent_log_action action , __u32 size , void *pevent_log );

## ARGUMENTS
fd

File descriptor of nvme device

action

Action the controller should take during processing this command

size

Size of pevent_log

pevent_log

User address to store the persistent event log

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_phy_rx_eom(2)

text:
# nvme_get_log_phy_rx_eom(2)

## NAME
nvme_get_log_phy_rx_eom - Retrieve Physical Interface Receiver Eye Opening Measurement Log

## SYNOPSIS
int nvme_get_log_phy_rx_eom (int fd , __u8 lsp , __u16 controller , __u32 len , struct nvme_phy_rx_eom_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

lsp

Log specific, controls action and measurement quality

controller

Target controller ID

len

The allocated size, minimum struct nvme_phy_rx_eom_log

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_predictable_lat_event(2)

text:
# nvme_get_log_predictable_lat_event(2)

## NAME
nvme_get_log_predictable_lat_event - Retrieve Predictable Latency Event Aggregate Log Page

## SYNOPSIS
int nvme_get_log_predictable_lat_event (int fd , bool rae , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

offset

Offset into the predictable latency event

len

Length of provided user buffer to hold the log data in bytes

log

User address for log page data

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_predictable_lat_nvmset(2)

summary: Predictable Latency Per NVM Set

text:
# nvme_get_log_predictable_lat_nvmset(2)

## NAME
nvme_get_log_predictable_lat_nvmset - Predictable Latency Per NVM Set

## SYNOPSIS
int nvme_get_log_predictable_lat_nvmset (int fd , __u16 nvmsetid , struct nvme_nvmset_predictable_lat_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

nvmsetid

NVM set id

log

User address to store the predictable latency log

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_pull_model_ddc_req(2)

summary: Retrieve Pull Model DDC Request Log

text:
# nvme_get_log_pull_model_ddc_req(2)

## NAME
nvme_get_log_pull_model_ddc_req - Retrieve Pull Model DDC Request Log

## SYNOPSIS
int nvme_get_log_pull_model_ddc_req (int fd , bool rae , __u32 len , struct nvme_pull_model_ddc_req_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


summary: Retrieve Reachability Associations Log

text:
# nvme_get_log_reachability_associations(2)

## NAME
nvme_get_log_reachability_associations - Retrieve Reachability Associations Log

## SYNOPSIS
int nvme_get_log_reachability_associations (int fd , bool rao , bool rae , __u32 len , struct nvme_reachability_associations_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rao

Return associations only

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_reachability_groups(2)

summary: Retrieve Reachability Groups Log

text:
# nvme_get_log_reachability_groups(2)

## NAME
nvme_get_log_reachability_groups - Retrieve Reachability Groups Log

## SYNOPSIS
int nvme_get_log_reachability_groups (int fd , bool rgo , bool rae , __u32 len , struct nvme_reachability_groups_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rgo

Return groups only

rae

Retain asynchronous events

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


summary: Get reclaim unit handle usage

text:
# nvme_get_log_reclaim_unit_handle_usage(2)

## NAME
nvme_get_log_reclaim_unit_handle_usage - Get reclaim unit handle usage

## SYNOPSIS
int nvme_get_log_reclaim_unit_handle_usage (int fd , __u16 egid , __u32 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

egid

Endurance group identifier

offset

Offset into log page

len

Length (in bytes) of provided user buffer to hold the log data

log

Log page data buffer


title: nvme_get_log_reservation(2)

summary: Retrieve Reservation Notification

text:
# nvme_get_log_reservation(2)

## NAME
nvme_get_log_reservation - Retrieve Reservation Notification

## SYNOPSIS
int nvme_get_log_reservation (int fd , bool rae , struct nvme_resv_notification_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

User address to store the reservation log

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_rotational_media_info(2)

text:
# nvme_get_log_rotational_media_info(2)

## NAME
nvme_get_log_rotational_media_info - Retrieve Rotational Media Information Log

## SYNOPSIS
int nvme_get_log_rotational_media_info (int fd , __u16 endgid , __u32 len , struct nvme_rotational_media_info_log *log );

## ARGUMENTS
fd

File descriptor of nvme device

endgid

Endurance Group Identifier

len

The allocated length of the log page

log

User address to store the log page

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_sanitize(2)

summary: Retrieve Sanitize Status

text:
# nvme_get_log_sanitize(2)

## NAME
nvme_get_log_sanitize - Retrieve Sanitize Status

## SYNOPSIS
int nvme_get_log_sanitize (int fd , bool rae , struct nvme_sanitize_log_page *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

User address to store the sanitize log

## DESCRIPTION
The Sanitize Status log page reports sanitize operation time estimates and information about the most recent sanitize operation.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_smart(2)

summary: Retrieve nvme smart log

text:
# nvme_get_log_smart(2)

## NAME
nvme_get_log_smart - Retrieve nvme smart log

## SYNOPSIS
int nvme_get_log_smart (int fd , __u32 nsid , bool rae , struct nvme_smart_log *smart_log );

## ARGUMENTS
fd

File descriptor of nvme device

nsid

Optional namespace identifier

rae

Retain asynchronous events

smart_log

User address to store the smart log

## DESCRIPTION
This log page provides SMART and general health information. The information provided is over the life of the controller and is retained across power cycles. To request the controller log page, the namespace identifier specified is FFFFFFFFh. The controller may also support requesting the log page on a per namespace basis, as indicated by bit 0 of the LPA field in the Identify Controller data structure.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_support_cap_config_list(2)

text:
# nvme_get_log_support_cap_config_list(2)

## NAME
nvme_get_log_support_cap_config_list - Retrieve Supported Capacity Configuration List

## SYNOPSIS
int nvme_get_log_support_cap_config_list (int fd , __u16 domid , struct nvme_supported_cap_config_list_log *cap );

## ARGUMENTS
fd

File descriptor of nvme device

domid

Domain Identifier selection, if supported

cap

User address to store supported capabilities config list

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise


title: nvme_get_log_supported_log_pages(2)

summary: Retrieve nmve supported log pages

text:
# nvme_get_log_supported_log_pages(2)

## NAME
nvme_get_log_supported_log_pages - Retrieve nmve supported log pages

## SYNOPSIS
int nvme_get_log_supported_log_pages (int fd , bool rae , struct nvme_supported_log_pages *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

log

Array of LID supported and Effects data structures

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.


title: nvme_get_log_telemetry_ctrl(2)

text:
# nvme_get_log_telemetry_ctrl(2)

## NAME
nvme_get_log_telemetry_ctrl - Get Telemetry Controller-Initiated log page

## SYNOPSIS
int nvme_get_log_telemetry_ctrl (int fd , bool rae , __u64 offset , __u32 len , void *log );

## ARGUMENTS
fd

File descriptor of nvme device

rae

Retain asynchronous events

offset

Offset into the telemetry data

len

Length of provided user buffer to hold the log data in bytes

log

User address for log page data

## DESCRIPTION
Retrieves the Telemetry Controller-Initiated log page at the requested offset using the previously existing capture.

## RETURN
The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.